loncom/interface/lonnavmaps.pm - diff

Return to lonnavmaps.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.100 and 1.129.2.2

version 1.100, 2002/11/08 19:10:58	version 1.129.2.2, 2003/03/20 20:40:42
Line 37	Line 37
# 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer	# 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
# YEAR=2002	# YEAR=2002
# 1/1 Gerd Kortemeyer	# 1/1 Gerd Kortemeyer
#	# Oct-Nov Jeremy Bowers

package Apache::lonnavmaps;	package Apache::lonnavmaps;

use strict;	use strict;
use Apache::Constants qw(:common :http);	use Apache::Constants qw(:common :http);
use Apache::lonnet();
use Apache::loncommon();	use Apache::loncommon();
use GDBM_File;
use POSIX qw (floor strftime);	use POSIX qw (floor strftime);

sub handler {	sub handler {
my $r = shift;	my $r = shift;
	real_handler($r);
	}

	sub real_handler {
	my $r = shift;

&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});	&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});

Line 73 sub handler {	Line 76 sub handler {
&Apache::loncommon::no_cache($r);	&Apache::loncommon::no_cache($r);
$r->send_http_header;	$r->send_http_header;

# Create the nav map the nav map	# Create the nav map
my $navmap = Apache::lonnavmaps::navmap->new(	my $navmap = Apache::lonnavmaps::navmap->new(
$ENV{"request.course.fn"}.".db",	$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 1, 1);	$ENV{"request.course.fn"}."_parms.db", 1, 1);
Line 85 sub handler {	Line 88 sub handler {
return HTTP_NOT_ACCEPTABLE;	return HTTP_NOT_ACCEPTABLE;
}	}

	$r->print("<html><head>\n");
	$r->print("<title>Navigate Course Contents</title></head>");

# Header	# Header
$r->print(&Apache::loncommon::bodytag('Navigate Course Map','',	$r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',
''));	''));
$r->print('<script>window.focus();</script>');	$r->print('<script>window.focus();</script>');
my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
	$r->rflush();

	# Now that we've displayed some stuff to the user, init the navmap
	$navmap->init();

$r->print('<table border="0" cellpadding="2" cellspacing="0">');	$r->print('<table border="0" cellpadding="2" cellspacing="0">');
my $date=localtime;	my $date=localtime;
$r->print('<tr><td align="right" valign="bottom">Key:  </td>');	$r->print('<tr><td align="right" valign="bottom">Key:  </td>');

	# Print discussions and feedback header
if ($navmap->{LAST_CHECK}) {	if ($navmap->{LAST_CHECK}) {
$r->print('<td align="center" valign="bottom">  '.	$r->print('<td align="center" valign="bottom">  '.
'<img src="/adm/lonMisc/chat.gif"> New discussion since '.	'<img src="/adm/lonMisc/chat.gif"> New discussion since '.
Line 107 sub handler {	Line 120 sub handler {
'</td>');	'</td>');
}	}
$r->print('</tr></table>');	$r->print('</tr></table>');

my $condition = 0;	my $condition = 0;
if ($ENV{'form.condition'}) {	if ($ENV{'form.condition'}) {
$condition = 1;	$condition = 1;
}	}

	# Determine where the "here" marker is and where the screen jumps to.
	my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants
	my $hereType; # the type of marker, $SYMB, $URL, or $NOTHING
	my $here; # the actual URL or SYMB for the here marker
	my $jumpType; # The type of the thing we have a jump for, $SYMB or $URL
	my $jump; # the SYMB/URL of the resource we need to jump to

	if ( $ENV{'form.alreadyHere'} ) { # we came from a user's manipulation of the nav page
	# If this is a click on a folder or something, we want to preserve the "here"
	# from the querystring, and get the new "jump" marker
	$hereType = $ENV{'form.hereType'};
	$here = $ENV{'form.here'};
	$jumpType = $ENV{'form.jumpType'} \|\| $NOTHING;
	$jump = $ENV{'form.jump'};
	} else { # the user is visiting the nav map from the remote
	# We're coming from the remote. We have either a url, a symb, or nothing,
	# and we need to figure out what.
	# Preference: Symb

	if ($ENV{'form.symb'}) {
	$hereType = $jumpType = $SYMB;
	$here = $jump = $ENV{'form.symb'};
	} elsif ($ENV{'form.postdata'}) {
	# couldn't find a symb, is there a URL?
	my $currenturl = $ENV{'form.postdata'};
	$currenturl=~s/^http\:\/\///;
	$currenturl=~s/^[^\/]+//;

	$hereType = $jumpType = $URL;
	$here = $jump = $currenturl;
	} else {
	# Nothing
	$hereType = $jumpType = $NOTHING;
	}
	}


	# alreadyHere allows us to only open the maps necessary to view
	# the current location once, while at the same time remembering
	# the current location. Without that check, the user would never
	# be able to close those maps; the user would close it, and the
	# currenturl scan would re-open it.
	my $queryAdd = "&alreadyHere=1";

if ($condition) {	if ($condition) {
$r->print('<a href="navmaps?condition=0&filter=">Close All Folders</a>');	$r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" .
	"&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
	"\">Close All Folders</a>");
} else {	} else {
$r->print('<a href="navmaps?condition=1&filter=">Open All Folders</a>');	$r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" .
	"&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
	"\">Open All Folders</a>");
}	}

$r->print('<br> ');	$r->print('<br> ');
$r->rflush();	$r->rflush();

# Now that we've displayed some stuff to the user, init the navmap
$navmap->init();

# Check that it's defined	# Check that it's defined
if (!($navmap->courseMapDefined())) {	if (!($navmap->courseMapDefined())) {
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .	$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
Line 135 sub handler {	Line 194 sub handler {
# is technically not proper, but should be harmless	# is technically not proper, but should be harmless
my $res = $navmap->firstResource();	my $res = $navmap->firstResource();

	# These are some data tables, which make it easy to change some of
	# of the specific visualization parameters if desired.

# Defines a status->color mapping, null string means don't color	# Defines a status->color mapping, null string means don't color
my %colormap =	my %colormap =
( $res->NETWORK_FAILURE => '',	( $res->NETWORK_FAILURE => '',
$res->CORRECT => '',	$res->CORRECT => '',
$res->EXCUSED => '#BBBBFF',	$res->EXCUSED => '#3333FF',
$res->PAST_DUE_ANSWER_LATER => '',	$res->PAST_DUE_ANSWER_LATER => '',
$res->PAST_DUE_NO_ANSWER => '',	$res->PAST_DUE_NO_ANSWER => '',
$res->ANSWER_OPEN => '#CCFFCC',	$res->ANSWER_OPEN => '#006600',
$res->OPEN_LATER => '',	$res->OPEN_LATER => '',
$res->TRIES_LEFT => '',	$res->TRIES_LEFT => '',
$res->INCORRECT => '',	$res->INCORRECT => '',
Line 152 sub handler {	Line 214 sub handler {
# is not yet done and due in less then 24 hours	# is not yet done and due in less then 24 hours
my $hurryUpColor = "#FF0000";	my $hurryUpColor = "#FF0000";

	# Keep these mappings in sync with lonquickgrades, which uses the colors
	# instead of the icons.
my %statusIconMap =	my %statusIconMap =
( $res->NETWORK_FAILURE => '',	( $res->NETWORK_FAILURE => '',
$res->NOTHING_SET => '',	$res->NOTHING_SET => '',
Line 187 sub handler {	Line 251 sub handler {
# Is this a new-style course? If so, we want to suppress showing the top-level	# Is this a new-style course? If so, we want to suppress showing the top-level
# maps in their own folders, in favor of "inlining" them.	# maps in their own folders, in favor of "inlining" them.
my $topResource = $navmap->getById("0.0");	my $topResource = $navmap->getById("0.0");
my $inlineTopLevelMaps = $topResource->src() =~ m\|^/uploaded/.*default\.sequence$\|;

my $currenturl = $ENV{'form.postdata'};
$currenturl=~s/^http\:\/\///;
$currenturl=~s/^[^\/]+//;
# alreadyHere allows us to only open the maps necessary to view
# the current location once, while at the same time remembering
# the current location. Without that check, the user would never
# be able to close those maps; the user would close it, and the
# currenturl scan would re-open it.
my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .
"&alreadyHere=1";

# Begin the HTML table	# Begin the HTML table
# four cols: resource + indent, chat+feedback, icon, text string	# four cols: resource + indent, chat+feedback, icon, text string
Line 210 sub handler {	Line 262 sub handler {
# Here's a simple example of the iterator.	# Here's a simple example of the iterator.
# Preprocess the map: Look for current URL, force inlined maps to display	# Preprocess the map: Look for current URL, force inlined maps to display

# This currently does very little...	my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
#my $mapEventualIterator = Apache::lonnavmaps::iterator->new($navmap, undef, undef, {},
#undef, $condition);

my $mapIterator = $navmap->getIterator(undef, undef, {}, 1);
my $found = 0;	my $found = 0;
my $depth = 1;	my $depth = 1;
my $currentUrlIndex = 0; # keeps track of when the current resource is found,	my $currentJumpIndex = 0; # keeps track of when the current resource is found,
# so we can back up a few and put the anchor above the	# so we can back up a few and put the anchor above the
# current resource	# current resource
	my $currentJumpDelta = 2; # change this to change how many resources are displayed
	# before the current resource when using #current
$mapIterator->next(); # discard the first BEGIN_MAP	$mapIterator->next(); # discard the first BEGIN_MAP
my $curRes = $mapIterator->next();	my $curRes = $mapIterator->next();
my $counter = 0;	my $counter = 0;
	my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one
while ($depth > 0) {	my $looped = 0;

	# We only need to do this if we need to open the maps to show the
	# current position. This will change the counter so we can't count
	# for the jump marker with this loop.
	while ($depth > 0 && !$ENV{'form.alreadyHere'}) {
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }	if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $mapIterator->END_MAP()) { $depth--; }	if ($curRes == $mapIterator->END_MAP()) { $depth--; }

if (ref($curRes)) { $counter++; }	if (ref($curRes) && !$ENV{'form.alreadyHere'} &&
	($hereType == $SYMB && $curRes->symb() eq $here) \|\|
my $mapStack = $mapIterator->getStack();	(ref($curRes) && $hereType == $URL && $curRes->src() eq $here)) {
if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) &&	my $mapStack = $mapIterator->getStack();
$curRes->src() eq $currenturl) {
# If this is the correct resource, be sure to
# show it by making sure the containing maps
# are open.

$currentUrlIndex = $counter;

	# Ensure the parent maps are open
for my $map (@{$mapStack}) {	for my $map (@{$mapStack}) {
if ($condition) {	if ($condition) {
undef $filterHash{$map->map_pc()};	undef $filterHash{$map->map_pc()};
Line 248 sub handler {	Line 298 sub handler {
}	}
$ENV{'form.alreadyHere'} = 1;	$ENV{'form.alreadyHere'} = 1;
}	}
	$looped = 1;
# Preprocessing: If we're inlining nav maps into the top-level display,
# make sure we show this map!	$curRes = $mapIterator->next();
if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map &&	}
scalar(@{$mapStack}) == 1) {
if ($condition) {	$mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0);
undef $filterHash{$curRes->map_pc()};	$depth = 1;
} else {	$mapIterator->next();
$filterHash{$curRes->map_pc()} = 1;	$curRes = $mapIterator->next();
}
	while ($depth > 0 && !$foundJump) {
	if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
	if ($curRes == $mapIterator->END_MAP()) { $depth--; }
	if (ref($curRes)) { $counter++; }

	if (ref($curRes) &&
	(($jumpType == $SYMB && $curRes->symb() eq $jump) \|\|
	($jumpType == $URL && $curRes->src() eq $jump))) {
	# If this is the correct resource, be sure to
	# show it by making sure the containing maps
	# are open.

	# This is why we have to use the main iterator instead of the
	# potentially faster DFS: The count has to be the same, so
	# the order has to be the same, which DFS won't give us.
	$currentJumpIndex = $counter;
	$foundJump = 1;
}	}

$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
Line 271 sub handler {	Line 338 sub handler {
my $now = time();	my $now = time();
my $in24Hours = $now + 24 * 60 * 60;	my $in24Hours = $now + 24 * 60 * 60;
my $displayedHereMarker = 0;	my $displayedHereMarker = 0;
	my $displayedJumpMarker = 0;

# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"	# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
# code in iterator->next), so ignore the first one	# code in iterator->next), so ignore the first one
Line 278 sub handler {	Line 346 sub handler {
$condition);	$condition);
$mapIterator->next();	$mapIterator->next();
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
my $deltadepth = 0;
$depth = 1;	$depth = 1;

my @backgroundColors = ("#FFFFFF", "#F6F6F6");	my @backgroundColors = ("#FFFFFF", "#F6F6F6");
Line 287 sub handler {	Line 354 sub handler {
$counter = 0;	$counter = 0;

while ($depth > 0) {	while ($depth > 0) {
# If we're in a new style course, and this is a BEGIN_MAP, END_MAP, or
# map resource and the stack depth is only one, just plain ignore this resource
# entirely. (This has the effect of inlining the resources in that map
# in the nav map.)
if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 &&
ref($curRes) && $curRes->is_map()) {
# We let the normal depth stuff occur, but we need to shift everything
# over by one to the left to make it look right.
$deltadepth = -1;
$curRes = $mapIterator->next();
next;
}

if ($curRes == $mapIterator->BEGIN_MAP() \|\|	if ($curRes == $mapIterator->BEGIN_MAP() \|\|
$curRes == $mapIterator->BEGIN_BRANCH()) {	$curRes == $mapIterator->BEGIN_BRANCH()) {
$indentLevel++;	$indentLevel++;
Line 316 sub handler {	Line 370 sub handler {

if (ref($curRes)) { $counter++; }	if (ref($curRes)) { $counter++; }

if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're	# Is this resource being ignored because it is in a random-out
# out of the inlined map	# map and it was not selected?

# Is this resource being blotted out?
if (ref($curRes) && !advancedUser() && $curRes->randomout()) {	if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
next; # and totally ignore this resource	next; # if yes, then just ignore this resource
}	}

if (ref($curRes) && $curRes->src()) {	if (ref($curRes)) {

	my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon

	if ($indentLevel - $deltalevel < 0) {
	# If this would be at a negative depth (top-level maps in
	# new-style courses, we want to suppress their title display)
	# then ignore it.
	$curRes = $mapIterator->next();
	next;
	}

# Step one: Decide which parts to show	# Step one: Decide which parts to show
my @parts = @{$curRes->parts()};	my @parts = @{$curRes->parts()};
Line 333 sub handler {	Line 395 sub handler {
my $condensed = 0;	my $condensed = 0;

if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
# Is it multipart?

	# Is it multipart?
if ($multipart) {	if ($multipart) {
# If it's multipart, see if part 0 is "open"	# If it's multipart, see if part 0 is "open"
# if it is, display all parts, if it isn't,	# if it is, display all parts, if it isn't,
# just display first	# just display first
if (!$curRes->opendate("0")) {	if (!$curRes->opendate("0")) {
@parts = ("0"); # just display the zero-th part	# no parts are open, display as one part
	@parts = ();
$condensed = 1;	$condensed = 1;
} else {	} else {
# Otherwise, only display part 0 if we want to	# Otherwise, only display part 0 if we want to
Line 348 sub handler {	Line 411 sub handler {
if ($curRes->hasDiscussion() \|\| $curRes->getFeedback()) {	if ($curRes->hasDiscussion() \|\| $curRes->getFeedback()) {
shift @parts;	shift @parts;
} else {	} else {
# If there's discussion or feedback, that counts
# as a difference, so display the parts.

# Now, we decide whether to condense the	# Now, we decide whether to condense the
# parts due to similarity	# parts due to similarity
my $status = $curRes->status($parts[1]);	my $status = $curRes->status($parts[1]);
Line 381 sub handler {	Line 441 sub handler {
if (($statusAllSame && defined($condenseStatuses{$status})) \|\|	if (($statusAllSame && defined($condenseStatuses{$status})) \|\|
($dueAllSame && $status == $curRes->OPEN && $statusAllSame)\|\|	($dueAllSame && $status == $curRes->OPEN && $statusAllSame)\|\|
($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){	($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
@parts = ($parts[1]);	@parts = ();
$condensed = 1;	$condensed = 1;
}	}
}	}
}	}
}	}

} else {
$parts[0] = "0"; # this is to get past foreach loop below
# you can consider a non-problem resource as a resource
# with only one part without loss
}	}

# Is it a multipart problem with a single part, now in	# Is it a multipart problem with a single part, now in
# @parts with "0" filtered out? If so, forget it's a multi-part	# @parts with "0" filtered out? If so, 'forget' it's a multi-part
# problem and treat it like a single-part problem.	# problem and treat it like a single-part problem.
if ( scalar(@parts) == 1 ) {	if ( scalar(@parts) == 0 ) {
$multipart = 0;	$multipart = 0;
}	}

# Display one part, in event of network error.	# Display one part, in event of network error.
# If this is a single part, we can at least show the correct	# If this is a single part, we can at least show the correct
# status, but if it's multipart, we're lost.	# status, but if it's multipart, we're lost, since we can't
	# retreive the metadata to count the parts
if ($curRes->{RESOURCE_ERROR}) {	if ($curRes->{RESOURCE_ERROR}) {
@parts = ("0");	@parts = ();
}	}

# Step two: Show the parts	# Step Two: Print the actual data.
foreach my $part (@parts) {
	# For each part we intend to display...
	foreach my $part ('', @parts) {
	if ($part eq '0') {
	next;
	}

my $deltalevel = 0; # for inserting the branch icon
my $nonLinkedText = ""; # unlinked stuff after title	my $nonLinkedText = ""; # unlinked stuff after title

# For each thing we're displaying...

my $stack = $mapIterator->getStack();	my $stack = $mapIterator->getStack();
my $src = getLinkForResource($stack);	my $src = getLinkForResource($stack);

	# Pass the correct symb on the querystring, so the
	# remote will figure out where we are if we click a link
my $srcHasQuestion = $src =~ /\?/;	my $srcHasQuestion = $src =~ /\?/;
my $link = $src.	my $link = $src.
($srcHasQuestion?'&':'?') .	($srcHasQuestion?'&':'?') .
'symb='.&Apache::lonnet::escape($curRes->symb()).	'symb='.&Apache::lonnet::escape($curRes->symb()).
'"';	'"';
my $title = $curRes->title();
if (!$title) {	my $title = $curRes->compTitle();
$title = $curRes->src();	if ($src=~/^\/uploaded\//) {
$title = substr ($title, rindex($title, "/") + 1);	$nonLinkedText=$title;
	$title='';
}	}
my $partLabel = "";	my $partLabel = "";
my $newBranchText = "";	my $newBranchText = "";

# If this is a new branch, label it so	# If this is a new branch, label it so
# (temporary, this should be an icon w/ alt text)
if ($isNewBranch) {	if ($isNewBranch) {
$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";	$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
$isNewBranch = 0;	$isNewBranch = 0;
$deltalevel = 1;
}	}

# links to open and close the folders	# links to open and close the folders
Line 446 sub handler {	Line 506 sub handler {

my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";	my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
if ($part eq "0" \|\| $condensed) {	if ($part eq "" \|\| $condensed) {
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';	$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';
} else {	} else {
$icon = $indentString;	$icon = $indentString;
Line 465 sub handler {	Line 525 sub handler {
$linkopen .= ($nowOpen xor $condition) ?	$linkopen .= ($nowOpen xor $condition) ?
addToFilter(\%filterHash, $mapId) :	addToFilter(\%filterHash, $mapId) :
removeFromFilter(\%filterHash, $mapId);	removeFromFilter(\%filterHash, $mapId);
$linkopen .= "&condition=$condition&$queryAdd\">";	$linkopen .= "&condition=$condition&$queryAdd" .
	"&hereType=$hereType&here=" .
	Apache::lonnet::escape($here) . "&jumpType=$SYMB&" .
	"jump=" . Apache::lonnet::escape($curRes->symb()) ."\">";
$linkclose = "</a>";	$linkclose = "</a>";

}	}
Line 473 sub handler {	Line 536 sub handler {
my $colorizer = "";	my $colorizer = "";
my $color;	my $color;
if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
my $status = $curRes->status($part);	$color = $colormap{$curRes->status};
$color = $colormap{$status};

# Special case in the navmaps: If in less then	if (dueInLessThen24Hours($curRes, $part) \|\|
# 24 hours, give it a bit of urgency	lastTry($curRes, $part)) {
if (($status == $curRes->OPEN() \|\| $status == $curRes->ATTEMPTED() \|\|
$status == $curRes->TRIES_LEFT())
&& $curRes->duedate() &&
$curRes->duedate() < time()+(246060) &&
$curRes->duedate() > time()) {
$color = $hurryUpColor;
}
# Special case: If this is the last try, and there is
# more then one available, and it's not due yet, give a bit of urgency
my $tries = $curRes->tries($part);
my $maxtries = $curRes->maxtries($part);
if ($tries && $maxtries && $maxtries > 1 &&
$maxtries - $tries == 1 && $curRes->duedate() &&
$curRes->duedate() > time()) {
$color = $hurryUpColor;	$color = $hurryUpColor;
}	}

if ($color ne "") {	if ($color ne "") {
$colorizer = "bgcolor=\"$color\"";	$colorizer = "bgcolor=\"$color\"";
}	}
Line 507 sub handler {	Line 556 sub handler {
my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];	my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];

# FIRST COL: The resource indentation, branch icon, name, and anchor	# FIRST COL: The resource indentation, branch icon, name, and anchor
$r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\" width=\"60%\">\n");	$r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\">\n");

# anchor for current resource... - 5 is deliberate: If it's that	# Print the anchor if necessary
# high on the screen, don't bother focusing on it. Also this will	if ($counter == $currentJumpIndex - $currentJumpDelta ) {
# print multiple anchors if this is an expanded multi-part problem...	$r->print('<a name="curloc" />');
# who cares?	$displayedJumpMarker = 1;
if ($counter == $currentUrlIndex - 5) {
$r->print('<a name="current" />');
}	}

# print indentation	# print indentation
for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) {	for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
$r->print($indentString);	$r->print($indentString);
}	}

Line 528 sub handler {	Line 575 sub handler {
my $curMarkerEnd = "";	my $curMarkerEnd = "";

# Is this the current resource?	# Is this the current resource?
if ($curRes->src() eq $currenturl && !$displayedHereMarker) {	if (!$displayedHereMarker &&
$curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>';	(($hereType == $SYMB && $curRes->symb eq $here) \|\|
	($hereType == $URL && $curRes->src eq $here))) {
	$curMarkerBegin = '<font color="red" size="+2">> </font>';
$curMarkerEnd = '<font color="red" size="+2"> <</font>';	$curMarkerEnd = '<font color="red" size="+2"> <</font>';
$displayedHereMarker = 1;	$displayedHereMarker = 1;
}	}

if ($curRes->is_problem() && $part ne "0" && !$condensed) {	if ($curRes->is_problem() && $part ne "" && !$condensed) {
$partLabel = " (Part $part)";	$partLabel = " (Part $part)";
$title = "";	$title = "";
}	}
if ($multipart && $condensed) {	if ($condensed && $curRes->countParts() > 1) {
$nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';	$nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
}	}

$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");	$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");
#$r->print(" TDV:" . $curRes->{DATA}->{TOP_DOWN_VAL}); # temp
#$r->print(" BUV:" . $curRes->{DATA}->{BOT_UP_VAL}); # temp
#$r->print(" DD:" . $curRes->{DATA}->{DISPLAY_DEPTH}); # temp

if ($curRes->{RESOURCE_ERROR}) {
$r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
'<font size="-1">Host down</font>'));
}

my $discussionHTML = ""; my $feedbackHTML = "";	#if ($curRes->{RESOURCE_ERROR}) {
	# $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
	# '<font size="-1">Host down</font>'));
	# }

	$r->print("</td>\n");

# SECOND COL: Is there text, feedback, errors??	# SECOND COL: Is there text, feedback, errors??
	my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";

if ($curRes->hasDiscussion()) {	if ($curRes->hasDiscussion()) {
$discussionHTML = $linkopen .	$discussionHTML = $linkopen .
'<img border="0" src="/adm/lonMisc/chat.gif" />' .	'<img border="0" src="/adm/lonMisc/chat.gif" />' .
Line 573 sub handler {	Line 621 sub handler {
}	}
}	}

$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>");	if ($curRes->getErrors()) {
	my $errors = $curRes->getErrors();
	foreach (split(/,/, $errors)) {
	if ($_) {
	$errorHTML .= ' <a href="/adm/email?display='
	. &Apache::lonnet::escape($_) . '">'
	. '<img src="/adm/lonMisc/bomb.gif" '
	. 'border="0" /></a>';
	}
	}
	}

	$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>");

# Is this the first displayed part of a multi-part problem	# Is this the first displayed part of a multi-part problem
# that has not been condensed, so we should suppress these two	# that has not been condensed, so we should suppress these two
# columns?	# columns so we don't display useless status info about part
	# "0"?
my $firstDisplayed = !$condensed && $multipart && $part eq "0";	my $firstDisplayed = !$condensed && $multipart && $part eq "0";

# THIRD COL: Problem status icon	# THIRD COL: Problem status icon
Line 595 sub handler {	Line 656 sub handler {
}	}

# FOURTH COL: Text description	# FOURTH COL: Text description
#$r->print("<td $colorizer align=\"right\" valign=\"center\">\n");
$r->print("<td align=\"right\" valign=\"center\">\n");	$r->print("<td align=\"right\" valign=\"center\">\n");

if ($curRes->kind() eq "res" &&	if ($curRes->kind() eq "res" &&
Line 610 sub handler {	Line 670 sub handler {
}	}

$r->print(" </td></tr>\n");	$r->print(" </td></tr>\n");

	if (!($counter % 20)) { $r->rflush(); }
	if ($counter == 2) { $r->rflush(); }
}	}
}	}
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
}	}

$r->print("</table></body></html>");	$r->print("</table>");

	# Print out the part that jumps to #curloc if it exists
	if ($displayedJumpMarker) {
	$r->print('<script>location += "#curloc";</script>');
	}

$navmap->untieHashes();	$navmap->untieHashes();

	$r->print("</body></html>");

return OK;	return OK;
}	}

Line 727 sub getDescription {	Line 797 sub getDescription {
}	}
}	}

	# Convenience function, so others can use it: Is the problem due in less then
	# 24 hours, and still can be done?

	sub dueInLessThen24Hours {
	my $res = shift;
	my $part = shift;
	my $status = $res->status($part);

	return ($status == $res->OPEN() \|\| $status == $res->ATTEMPTED() \|\|
	$status == $res->TRIES_LEFT()) &&
	$res->duedate() && $res->duedate() < time()+(246060) &&
	$res->duedate() > time();
	}

	# Convenience function, so others can use it: Is there only one try remaining for the
	# part, with more then one try to begin with, not due yet and still can be done?
	sub lastTry {
	my $res = shift;
	my $part = shift;

	my $tries = $res->tries($part);
	my $maxtries = $res->maxtries($part);
	return $tries && $maxtries && $maxtries > 1 &&
	$maxtries - $tries == 1 && $res->duedate() &&
	$res->duedate() > time();
	}

	# This puts a human-readable name on the ENV variable.
sub advancedUser {	sub advancedUser {
return $ENV{'user.adv'};	return $ENV{'user.adv'};
}	}
Line 772 sub timeToHumanString {	Line 870 sub timeToHumanString {
$delta = -$delta;	$delta = -$delta;
}	}

# Is it in the future?
if ( $delta > 0 ) {	if ( $delta > 0 ) {
# Is it less then a minute away?
my $tense = $inPast ? " ago" : "";	my $tense = $inPast ? " ago" : "";
my $prefix = $inPast ? "" : "in ";	my $prefix = $inPast ? "" : "in ";

	# Less then a minute
if ( $delta < $minute ) {	if ( $delta < $minute ) {
if ($delta == 1) { return "${prefix}1 second$tense"; }	if ($delta == 1) { return "${prefix}1 second$tense"; }
return "$prefix$delta seconds$tense";	return "$prefix$delta seconds$tense";
}	}

# Is it less then an hour away?	# Less then an hour
if ( $delta < $hour ) {	if ( $delta < $hour ) {
# If so, use minutes	# If so, use minutes
my $minutes = floor($delta / 60);	my $minutes = floor($delta / 60);
Line 876 sub new {	Line 975 sub new {
$self->{GENERATE_COURSE_USER_OPT} = shift;	$self->{GENERATE_COURSE_USER_OPT} = shift;
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;	$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;

# Resource cache stores navmapresource's as we reference them. We generate	# Resource cache stores navmap resources as we reference them. We generate
# them on-demand so we don't pay for creating resources unless we use them.	# them on-demand so we don't pay for creating resources unless we use them.
$self->{RESOURCE_CACHE} = {};	$self->{RESOURCE_CACHE} = {};

Line 890 sub new {	Line 989 sub new {
&GDBM_READER(), 0640))) {	&GDBM_READER(), 0640))) {
return undef;	return undef;
}	}
$self->{NAV_HASH} = \%navmaphash;

my %parmhash;	my %parmhash;
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},	if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
Line 899 sub new {	Line 997 sub new {
untie $self->{PARM_HASH};	untie $self->{PARM_HASH};
return undef;	return undef;
}	}
$self->{PARM_HASH} = \%parmhash;
$self->{HASH_TIED} = 1;	$self->{HASH_TIED} = 1;
	$self->{NAV_HASH} = \%navmaphash;
	$self->{PARM_HASH} = \%parmhash;

bless($self);	bless($self);

Line 973 sub init {	Line 1073 sub init {
my %emailstatus = &Apache::lonnet::dump('email_status');	my %emailstatus = &Apache::lonnet::dump('email_status');
my $logoutTime = $emailstatus{'logout'};	my $logoutTime = $emailstatus{'logout'};
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};	my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
$self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?	$self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ?
$courseLeaveTime : $logoutTime);	$courseLeaveTime : $logoutTime);
my %discussiontime = &Apache::lonnet::dump('discussiontimes',	my %discussiontime = &Apache::lonnet::dump('discussiontimes',
$cdom, $cnum);	$cdom, $cnum);
Line 1016 sub init {	Line 1116 sub init {
$self->{PARM_CACHE} = {};	$self->{PARM_CACHE} = {};
}	}

	# Internal function: Takes a key to look up in the nav hash and implements internal
	# memory caching of that key.
	sub navhash {
	my $self = shift; my $key = shift;
	return $self->{NAV_HASH}->{$key};
	}

# Checks to see if coursemap is defined, matching test in old lonnavmaps	# Checks to see if coursemap is defined, matching test in old lonnavmaps
sub courseMapDefined {	sub courseMapDefined {
my $self = shift;	my $self = shift;
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});	my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});

my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};	my $firstres = $self->navhash("map_start_$uri");
my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};	my $lastres = $self->navhash("map_finish_$uri");
return $firstres && $lastres;	return $firstres && $lastres;
}	}

sub getIterator {	sub getIterator {
my $self = shift;	my $self = shift;
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,	my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
shift, undef, shift,	shift, undef, shift);
$ENV{'form.direction'});
return $iterator;	return $iterator;
}	}

Line 1048 sub DESTROY {	Line 1154 sub DESTROY {
$self->untieHashes();	$self->untieHashes();
}	}

# Private function: Does the given resource (as a symb string) have	# Private method: Does the given resource (as a symb string) have
# current discussion? Returns 0 if chat/mail data not extracted.	# current discussion? Returns 0 if chat/mail data not extracted.
sub hasDiscussion {	sub hasDiscussion {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;
if (!defined($self->{DISCUSSION_TIME})) { return 0; }	if (!defined($self->{DISCUSSION_TIME})) { return 0; }

	#return defined($self->{DISCUSSION_TIME}->{$symb});
return $self->{DISCUSSION_TIME}->{$symb} >	return $self->{DISCUSSION_TIME}->{$symb} >
$self->{LAST_CHECK};	$self->{LAST_CHECK};
}	}

# Private function: Does the given resource (as a symb string) have	# Private method: Does the given resource (as a symb string) have
# current feedback? Returns the string in the feedback hash, which	# current feedback? Returns the string in the feedback hash, which
# will be false if it does not exist.	# will be false if it does not exist.
sub getFeedback {	sub getFeedback {
Line 1071 sub getFeedback {	Line 1178 sub getFeedback {
return $self->{FEEDBACK}->{$symb};	return $self->{FEEDBACK}->{$symb};
}	}

	# Private method: Get the errors for that resource (by source).
	sub getErrors {
	my $self = shift;
	my $src = shift;

	if (!defined($self->{ERROR_MSG})) { return ""; }
	return $self->{ERROR_MSG}->{$src};
	}

=pod	=pod

=item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.	=item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
Line 1103 sub getById {	Line 1219 sub getById {

sub firstResource {	sub firstResource {
my $self = shift;	my $self = shift;
my $firstResource = $self->{NAV_HASH}->{'map_start_' .	my $firstResource = $self->navhash('map_start_' .
&Apache::lonnet::clutter($ENV{'request.course.uri'})};	&Apache::lonnet::clutter($ENV{'request.course.uri'}));
return $self->getById($firstResource);	return $self->getById($firstResource);
}	}

Line 1116 sub firstResource {	Line 1232 sub firstResource {

sub finishResource {	sub finishResource {
my $self = shift;	my $self = shift;
my $firstResource = $self->{NAV_HASH}->{'map_finish_' .	my $firstResource = $self->navhash('map_finish_' .
&Apache::lonnet::clutter($ENV{'request.course.uri'})};	&Apache::lonnet::clutter($ENV{'request.course.uri'}));
return $self->getById($firstResource);	return $self->getById($firstResource);
}	}

# -------------------------------------------- Figure out a cascading parameter	# Parmval reads the parm hash and cascades the lookups. parmval_real does
#	# the actual lookup; parmval caches the results.
# For this function to work
#
# * parmhash needs to be tied
# * courseopt and useropt need to be initialized for this user and course
#

sub parmval {	sub parmval {
my $self = shift;	my $self = shift;
my ($what,$symb)=@_;	my ($what,$symb)=@_;
Line 1230 sub parmval_real {	Line 1340 sub parmval_real {

package Apache::lonnavmaps::iterator;	package Apache::lonnavmaps::iterator;

# This package must precede "navmap" because "navmap" uses it. In
# order to keep the documentation order straight, the iterator is documented
# after the navmap object.

=pod	=pod

=back	=back
Line 1254 getIterator behaves as follows:	Line 1360 getIterator behaves as follows:

=over 4	=over 4

=item B<getIterator>(firstResource, finishResource, filterHash, condition, direction): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to. Direction specifies which direction to recurse, either FORWARD or BACKWARD, with FORWARD being default.	=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content.

Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.	Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.

The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:	The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:

Line 1274 The iterator will return either a refere	Line 1380 The iterator will return either a refere

The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.	The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.

	Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned.

=back	=back

=cut	=cut
Line 1292 sub min {	Line 1400 sub min {
if ($a < $b) { return $a; } else { return $b; }	if ($a < $b) { return $a; } else { return $b; }
}	}

	# In the CVS repository, documentation of this algorithm is included
	# in /doc/lonnavdocs, as a PDF and .tex source. Markers like 1
	# will reference the same location in the text as the part of the
	# algorithm is running through.

sub new {	sub new {
# magic invocation to create a class instance	# magic invocation to create a class instance
my $proto = shift;	my $proto = shift;
Line 1319 sub new {	Line 1432 sub new {
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };	if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
$self->{CONDITION} = shift;	$self->{CONDITION} = shift;

	# Do we want to automatically follow "redirection" maps?
	$self->{FORCE_TOP} = shift;

# Now, we need to pre-process the map, by walking forward and backward	# Now, we need to pre-process the map, by walking forward and backward
# over the parts of the map we're going to look at.	# over the parts of the map we're going to look at.

Line 1334 sub new {	Line 1450 sub new {

my $maxDepth = 0; # tracks max depth	my $maxDepth = 0; # tracks max depth

	# If there is only one resource in this map, and it's a map, we
	# want to remember that, so the user can ask for the first map
	# that isn't just a redirector.
	my $resource; my $resourceCount = 0;

	# 1

foreach my $pass (@iterations) {	foreach my $pass (@iterations) {
my $direction = $pass->[0];	my $direction = $pass->[0];
my $valName = $pass->[1];	my $valName = $pass->[1];
Line 1355 sub new {	Line 1478 sub new {
if ($curRes == $iterator->END_MAP()) { $depth--; }	if ($curRes == $iterator->END_MAP()) { $depth--; }

if (ref($curRes)) {	if (ref($curRes)) {
	# If there's only one resource, this will save it
	# we have to filter empty resources from consideration here,
	# or even "empty", redirecting maps have two (start & finish)
	# or three (start, finish, plus redirector)
	if($direction == FORWARD && $curRes->src()) {
	$resource = $curRes; $resourceCount++;
	}
my $resultingVal = $curRes->{DATA}->{$valName};	my $resultingVal = $curRes->{DATA}->{$valName};
my $nextResources = $curRes->$nextResourceMethod();	my $nextResources = $curRes->$nextResourceMethod();
my $resourceCount = scalar(@{$nextResources});	my $nextCount = scalar(@{$nextResources});

if ($resourceCount == 1) {	if ($nextCount == 1) { # 3
my $current = $nextResources->[0]->{DATA}->{$valName} \|\| 999999999;	my $current = $nextResources->[0]->{DATA}->{$valName} \|\| 999999999;
$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);	$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
}	}

if ($resourceCount > 1) {	if ($nextCount > 1) { # 4
foreach my $res (@{$nextResources}) {	foreach my $res (@{$nextResources}) {
my $current = $res->{DATA}->{$valName} \|\| 999999999;	my $current = $res->{DATA}->{$valName} \|\| 999999999;
$res->{DATA}->{$valName} = min($current, $resultingVal + 1);	$res->{DATA}->{$valName} = min($current, $resultingVal + 1);
Line 1372 sub new {	Line 1502 sub new {
}	}
}	}

# Assign the final val	# Assign the final val (2)
if (ref($curRes) && $direction == BACKWARD()) {	if (ref($curRes) && $direction == BACKWARD()) {
my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},	my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
$curRes->{DATA}->{BOT_UP_VAL});	$curRes->{DATA}->{BOT_UP_VAL});
Line 1384 sub new {	Line 1514 sub new {
}	}
}	}

	# Check: Was this only one resource, a map?
	if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) {
	my $firstResource = $resource->map_start();
	my $finishResource = $resource->map_finish();
	return
	Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
	$finishResource, $self->{FILTER},
	$self->{ALREADY_SEEN},
	$self->{CONDITION}, 0);

	}

# Set up some bookkeeping information.	# Set up some bookkeeping information.
$self->{CURRENT_DEPTH} = 0;	$self->{CURRENT_DEPTH} = 0;
$self->{MAX_DEPTH} = $maxDepth;	$self->{MAX_DEPTH} = $maxDepth;
Line 1394 sub new {	Line 1536 sub new {
push @{$self->{STACK}}, [];	push @{$self->{STACK}}, [];
}	}

# Prime the recursion w/ the first resource	# Prime the recursion w/ the first resource 5
push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};	push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;	$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;

Line 1443 sub next {	Line 1585 sub next {
my $newDepth;	my $newDepth;
my $here;	my $here;
while ( $i >= 0 && !$found ) {	while ( $i >= 0 && !$found ) {
if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) {	if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # 6
$here = $self->{HERE} = shift @{$self->{STACK}->[$i]};	$here = pop @{$self->{STACK}->[$i]}; # 7
$found = 1;	$found = 1;
$newDepth = $i;	$newDepth = $i;
}	}
Line 1462 sub next {	Line 1604 sub next {
}	}
}	}

	# If this is not a resource, it must be an END_BRANCH marker we want
	# to return directly.
	if (!ref($here)) { # 8
	if ($here == END_BRANCH()) { # paranoia, in case of later extension
	$self->{CURRENT_DEPTH}--;
	return $here;
	}
	}

	# Otherwise, it is a resource and it's safe to store in $self->{HERE}
	$self->{HERE} = $here;

# Get to the right level	# Get to the right level
if ( $self->{CURRENT_DEPTH} > $newDepth ) {	if ( $self->{CURRENT_DEPTH} > $newDepth ) {
push @{$self->{STACK}->[$newDepth]}, $here;	push @{$self->{STACK}->[$newDepth]}, $here;
Line 1481 sub next {	Line 1635 sub next {
# So we need to look at all the resources we can get to from here,	# So we need to look at all the resources we can get to from here,
# categorize them if we haven't seen them, remember if we have a new	# categorize them if we haven't seen them, remember if we have a new
my $nextUnfiltered = $here->getNext();	my $nextUnfiltered = $here->getNext();
	my $maxDepthAdded = -1;

for (@$nextUnfiltered) {	for (@$nextUnfiltered) {
if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {	if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
push @{$self->{STACK}->[$_->{DATA}->{DISPLAY_DEPTH}]}, $_;	my $depth = $_->{DATA}->{DISPLAY_DEPTH};
	push @{$self->{STACK}->[$depth]}, $_;
$self->{ALREADY_SEEN}->{$_->{ID}} = 1;	$self->{ALREADY_SEEN}->{$_->{ID}} = 1;
	if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
}	}
}	}

	# Is this the end of a branch? If so, all of the resources examined above
	# led to lower levels then the one we are currently at, so we push a END_BRANCH
	# marker onto the stack so we don't forget.
	# Example: For the usual A(BC)(DE)F case, when the iterator goes down the
	# BC branch and gets to C, it will see F as the only next resource, but it's
	# one level lower. Thus, this is the end of the branch, since there are no
	# more resources added to this level or above.
	# We don't do this if the examined resource is the finish resource,
	# because the condition given above is true, but the "END_MAP" will
	# take care of things and we should already be at depth 0.
	my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
	if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # 9
	push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
	}

# That ends the main iterator logic. Now, do we want to recurse	# That ends the main iterator logic. Now, do we want to recurse
# down this map (if this resource is a map)?	# down this map (if this resource is a map)?
if ($self->{HERE}->is_map() &&	if ($self->{HERE}->is_map() &&
Line 1503 sub next {	Line 1675 sub next {
$self->{ALREADY_SEEN}, $self->{CONDITION});	$self->{ALREADY_SEEN}, $self->{CONDITION});
}	}

	# If this is a blank resource, don't actually return it.
	# Should you ever find you need it, make sure to add an option to the code
	# that you can use; other things depend on this behavior.
	if (!$self->{HERE}->src() \|\| !$self->{HERE}->browsePriv()) {
	return $self->next();
	}

return $self->{HERE};	return $self->{HERE};

}	}
Line 1549 package Apache::lonnavmaps::DFSiterator;	Line 1728 package Apache::lonnavmaps::DFSiterator;
# but this might as well be left seperate, since it is possible some other	# but this might as well be left seperate, since it is possible some other
# use might be found for it. - Jeremy	# use might be found for it. - Jeremy

	# Unlike the main iterator, this DOES return all resources, even blank ones.
	# The main iterator needs them to correctly preprocess the map.

sub BEGIN_MAP { return 1; } # begining of a new map	sub BEGIN_MAP { return 1; } # begining of a new map
sub END_MAP { return 2; } # end of the map	sub END_MAP { return 2; } # end of the map
sub FORWARD { return 1; } # go forward	sub FORWARD { return 1; } # go forward
Line 1749 sub navHash {	Line 1931 sub navHash {
my $self = shift;	my $self = shift;
my $param = shift;	my $param = shift;
my $id = shift;	my $id = shift;
return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};	return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
}	}

=pod	=pod

B<Metadata Retreival>	B<Metadata Retreival>

These are methods that help you retrieve metadata about the resource:	These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.

=over 4	=over 4

	=item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem").

=item * B<ext>: Returns true if the resource is external.	=item * B<ext>: Returns true if the resource is external.

=item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)	=item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)

=item * B<kind>: Returns the kind of the resource from the compiled nav map.	=item * B<kind>: Returns the kind of the resource from the compiled nav map.

=item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.	=item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false.

=item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)	=item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)

Line 1809 sub symb {	Line 1993 sub symb {
}	}
sub title { my $self=shift; return $self->navHash("title_", 1); }	sub title { my $self=shift; return $self->navHash("title_", 1); }
sub to { my $self=shift; return $self->navHash("to_", 1); }	sub to { my $self=shift; return $self->navHash("to_", 1); }
	sub compTitle {
	my $self = shift;
	my $title = $self->title();
	if (!$title) {
	$title = $self->src();
	$title = substr($title, rindex($title, '/') + 1);
	}
	return $title;
	}
=pod	=pod

B<Predicate Testing the Resource>	B<Predicate Testing the Resource>
Line 1826 These methods are shortcuts to deciding	Line 2018 These methods are shortcuts to deciding

=item * B<is_problem>: Returns true if the resource is a problem.	=item * B<is_problem>: Returns true if the resource is a problem.

=item * B<is_sequence>: Returns true if the resource sequence.	=item * B<is_sequence>: Returns true if the resource is a sequence.

=back	=back

Line 1855 sub is_sequence {	Line 2047 sub is_sequence {
return ($src =~ /sequence$/);	return ($src =~ /sequence$/);
}	}

	# Private method: Shells out to the parmval in the nav map, handler parts.



# Move this into POD: In order to use these correctly, courseopt
# and useropt need to be generated
sub parmval {	sub parmval {
my $self = shift;	my $self = shift;
my $what = shift;	my $what = shift;
Line 1974 sub answerdate {	Line 2161 sub answerdate {
}	}
return $self->parmval("answerdate", $part);	return $self->parmval("answerdate", $part);
}	}
	sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); }
sub duedate {	sub duedate {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
return $self->parmval("duedate", $part);	return $self->parmval("duedate", $part);
Line 1998 sub tol {	Line 2186 sub tol {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
return $self->parmval("tol", $part);	return $self->parmval("tol", $part);
}	}
sub tries {	sub tries {
my $self = shift;	my $self = shift;
my $part = shift;	my $tries = $self->queryRestoreHash('tries', shift);
$part = '0' if (!defined($part));	if (!defined($tries)) { return '0';}

# Make sure return hash is loaded, should error check
$self->getReturnHash();

my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
if (!defined($tries)) {return '0';}
return $tries;	return $tries;
}	}
sub type {	sub type {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
return $self->parmval("type", $part);	return $self->parmval("type", $part);
}	}
sub weight {	sub weight {
(my $self, my $part) = @_;	my $self = shift; my $part = shift;
return $self->parmval("weight", $part);	return $self->parmval("weight", $part);
}	}

Line 2070 sub hasDiscussion {	Line 2252 sub hasDiscussion {

sub getFeedback {	sub getFeedback {
my $self = shift;	my $self = shift;
return $self->{NAV_MAP}->getFeedback($self->src());	my $source = $self->src();
	if ($source =~ /^\/res\//) { $source = substr $source, 5; }
	return $self->{NAV_MAP}->getFeedback($source);
	}

	sub getErrors {
	my $self = shift;
	my $source = $self->src();
	if ($source =~ /^\/res\//) { $source = substr $source, 5; }
	return $self->{NAV_MAP}->getErrors($source);
}	}

=pod	=pod
Line 2096 sub countParts {	Line 2287 sub countParts {
my $self = shift;	my $self = shift;

my $parts = $self->parts();	my $parts = $self->parts();
	my $delta = 0;
	for my $part (@$parts) {
	if ($part eq '0') { $delta--; }
	}

if ($self->{RESOURCE_ERROR}) {	if ($self->{RESOURCE_ERROR}) {
return 0;	return 0;
}	}

if (scalar(@{$parts}) < 2) { return 1;}	return scalar(@{$parts}) + $delta;

return scalar(@{$parts}) - 1;
}	}

# Private function: Extracts the parts information and saves it	# Private function: Extracts the parts information and saves it
Line 2117 sub extractParts {	Line 2310 sub extractParts {

# Retrieve part count, if this is a problem	# Retrieve part count, if this is a problem
if ($self->is_problem()) {	if ($self->is_problem()) {
my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');	my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
if (!$metadata) {	if (!$metadata) {
$self->{RESOURCE_ERROR} = 1;	$self->{RESOURCE_ERROR} = 1;
$self->{PARTS} = [];	$self->{PARTS} = [];
Line 2125 sub extractParts {	Line 2318 sub extractParts {
}	}

foreach (split(/\,/,$metadata)) {	foreach (split(/\,/,$metadata)) {
if ($_ =~ /^parameter\_(.*)\_opendate$/) {	if ($_ =~ /^part_(.*)$/) {
push @{$self->{PARTS}}, $1;	push @{$self->{PARTS}}, $1;
}	}
}	}
Line 2143 sub extractParts {	Line 2336 sub extractParts {

=head2 Resource Status	=head2 Resource Status

Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status.	Problem resources have status information, reflecting their various dates and completion statuses.

There are two aspects to the status: the date-related information and the completion information.	There are two aspects to the status: the date-related information and the completion information.

Line 2160 Idiomatic usage of these two methods wou	Line 2353 Idiomatic usage of these two methods wou
... use it here ...	... use it here ...
}	}

	Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere.

	The symbolic constants shown below can be accessed through the resource object: $res->OPEN.

=over 4	=over 4

=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:	=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
Line 2273 sub ATTEMPTED { return 16; }	Line 2470 sub ATTEMPTED { return 16; }

sub getCompletionStatus {	sub getCompletionStatus {
my $self = shift;	my $self = shift;
my $part = shift;
$part = "0" if (!defined($part));
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});	return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});

# Make sure return hash exists	my $status = $self->queryRestoreHash('solved', shift);
$self->getReturnHash();

my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};

# Left as seperate if statements in case we ever do more with this	# Left as seperate if statements in case we ever do more with this
if ($status eq 'correct_by_student') {return $self->CORRECT;}	if ($status eq 'correct_by_student') {return $self->CORRECT;}
Line 2292 sub getCompletionStatus {	Line 2484 sub getCompletionStatus {
return $self->NOT_ATTEMPTED;	return $self->NOT_ATTEMPTED;
}	}

	sub queryRestoreHash {
	my $self = shift;
	my $hashentry = shift;
	my $part = shift;
	$part = "0" if (!defined($part));
	return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});

	$self->getReturnHash();

	return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
	}

=pod	=pod

B<Composite Status>	B<Composite Status>

Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()):	Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE):

=over 4	=over 4

Line 2400 sub status {	Line 2604 sub status {

=over 4	=over 4

=item * B<getNext>($alreadySeenHashRef): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. The "alreadySeenHashRef" is an optional parameter that can be passed in to the method. If $$alreadySeenHashRef{$res->id()} is true in that hash, getNext will not return it in the list. In other words, you can use it to suppress resources you've already seen in the getNext method directly.	=item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case.

=item * B<getPrevious>($alreadySeenHashRef): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. $alreadySeenHashRef is the same as in getNext.	=item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case.

=cut	=cut

sub getNext {	sub getNext {
my $self = shift;	my $self = shift;
my $alreadySeenHash = shift;
my @branches;	my @branches;
my $to = $self->to();	my $to = $self->to();
foreach my $branch ( split(/,/, $to) ) {	foreach my $branch ( split(/,/, $to) ) {
Line 2416 sub getNext {	Line 2619 sub getNext {
my $next = $choice->goesto();	my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);	$next = $self->{NAV_MAP}->getById($next);

# Don't remember it if we've already seen it or if	push @branches, $next;
# the student doesn't have browse priviledges
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
if (!defined($alreadySeenHash) \|\|
!defined($alreadySeenHash->{$next->{ID}}) \|\|
($browsePriv ne '2' && $browsePriv ne 'F')) {
push @branches, $next;
}
}	}
return \@branches;	return \@branches;
}	}

sub getPrevious {	sub getPrevious {
my $self = shift;	my $self = shift;
my $alreadySeenHash = shift;
my @branches;	my @branches;
my $from = $self->from();	my $from = $self->from();
foreach my $branch ( split /,/, $from) {	foreach my $branch ( split /,/, $from) {
Line 2438 sub getPrevious {	Line 2633 sub getPrevious {
my $prev = $choice->comesfrom();	my $prev = $choice->comesfrom();
$prev = $self->{NAV_MAP}->getById($prev);	$prev = $self->{NAV_MAP}->getById($prev);

# Skip it if we've already seen it or the user doesn't have	push @branches, $prev;
# browse privs
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
if (!defined($alreadySeenHash) \|\|
!defined($alreadySeenHash->{$prev->{ID}}) \|\|
($browsePriv ne '2' && $browsePriv ne 'F')) {
push @branches, $prev;
}
}	}
return \@branches;	return \@branches;
}	}

	sub browsePriv {
	my $self = shift;
	if (defined($self->{BROWSE_PRIV})) {
	return $self->{BROWSE_PRIV};
	}

	$self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src());
	}

=pod	=pod

=back	=back

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.100
changed lines
	Added in v.1.129.2.2