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.216 and 1.234

version 1.216, 2003/07/17 18:40:49	version 1.234, 2003/09/24 15:58:06
Line 46 use strict;	Line 46 use strict;
use Apache::Constants qw(:common :http);	use Apache::Constants qw(:common :http);
use Apache::loncommon();	use Apache::loncommon();
use Apache::lonmenu();	use Apache::lonmenu();
	use Apache::lonlocal;
use POSIX qw (floor strftime);	use POSIX qw (floor strftime);
use Data::Dumper; # for debugging, not always used	use Data::Dumper; # for debugging, not always used

Line 61 my $resObj = "Apache::lonnavmaps::resour	Line 62 my $resObj = "Apache::lonnavmaps::resour
# Keep these mappings in sync with lonquickgrades, which uses the colors	# Keep these mappings in sync with lonquickgrades, which uses the colors
# instead of the icons.	# instead of the icons.
my %statusIconMap =	my %statusIconMap =
( $resObj->NETWORK_FAILURE => '',	(
$resObj->NOTHING_SET => '',	$resObj->CLOSED => '',
$resObj->CORRECT => 'navmap.correct.gif',	$resObj->OPEN => 'navmap.open.gif',
$resObj->EXCUSED => 'navmap.correct.gif',	$resObj->CORRECT => 'navmap.correct.gif',
$resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',	$resObj->INCORRECT => 'navmap.wrong.gif',
$resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',	$resObj->ATTEMPTED => 'navmap.ellipsis.gif',
$resObj->ANSWER_OPEN => 'navmap.wrong.gif',	$resObj->ERROR => ''
$resObj->OPEN_LATER => '',	);
$resObj->TRIES_LEFT => 'navmap.open.gif',
$resObj->INCORRECT => 'navmap.wrong.gif',
$resObj->OPEN => 'navmap.open.gif',
$resObj->ATTEMPTED => 'navmap.ellipsis.gif',
$resObj->ANSWER_SUBMITTED => 'navmap.ellipsis.gif' );

my %iconAltTags =	my %iconAltTags =
( 'navmap.correct.gif' => 'Correct',	( 'navmap.correct.gif' => 'Correct',
Line 111 sub real_handler {	Line 107 sub real_handler {
# Handle header-only request	# Handle header-only request
if ($r->header_only) {	if ($r->header_only) {
if ($ENV{'browser.mathml'}) {	if ($ENV{'browser.mathml'}) {
$r->content_type('text/xml');	&Apache::loncommon::content_type($r,'text/xml');
} else {	} else {
$r->content_type('text/html');	&Apache::loncommon::content_type($r,'text/html');
}	}
$r->send_http_header;	$r->send_http_header;
return OK;	return OK;
Line 121 sub real_handler {	Line 117 sub real_handler {

# Send header, don't cache this page	# Send header, don't cache this page
if ($ENV{'browser.mathml'}) {	if ($ENV{'browser.mathml'}) {
$r->content_type('text/xml');	&Apache::loncommon::content_type($r,'text/xml');
} else {	} else {
$r->content_type('text/html');	&Apache::loncommon::content_type($r,'text/html');
}	}
&Apache::loncommon::no_cache($r);	&Apache::loncommon::no_cache($r);
$r->send_http_header;	$r->send_http_header;

# Create 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"}."_parms.db", 1, 1);


if (!defined($navmap)) {	if (!defined($navmap)) {
Line 141 sub real_handler {	Line 135 sub real_handler {
}	}

$r->print("<html><head>\n");	$r->print("<html><head>\n");
$r->print("<title>Navigate Course Contents</title>");	$r->print("<title>".&mt('Navigate Course Contents')."</title>");
# ------------------------------------------------------------ Get query string	# ------------------------------------------------------------ Get query string
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);	&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);

Line 161 sub real_handler {	Line 155 sub real_handler {

$r->rflush();	$r->rflush();

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

$r->rflush();

# 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 175 sub real_handler {	Line 164 sub real_handler {

# See if there's only one map in the top-level, if we don't	# See if there's only one map in the top-level, if we don't
# already have a filter... if so, automatically display it	# already have a filter... if so, automatically display it
	# (older code; should use retrieveResources)
if ($ENV{QUERY_STRING} !~ /filter/) {	if ($ENV{QUERY_STRING} !~ /filter/) {
my $iterator = $navmap->getIterator(undef, undef, undef, 0);	my $iterator = $navmap->getIterator(undef, undef, undef, 0);
my $depth = 1;	my $curRes;
$iterator->next();
my $curRes = $iterator->next();
my $sequenceCount = 0;	my $sequenceCount = 0;
my $sequenceId;	my $sequenceId;
while ($depth > 0) {	while ($curRes = $iterator->next()) {
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $iterator->END_MAP()) { $depth--; }

if (ref($curRes) && $curRes->is_sequence()) {	if (ref($curRes) && $curRes->is_sequence()) {
$sequenceCount++;	$sequenceCount++;
$sequenceId = $curRes->map_pc();	$sequenceId = $curRes->map_pc();
}	}

$curRes = $iterator->next();
}	}

if ($sequenceCount == 1) {	if ($sequenceCount == 1) {
Line 209 sub real_handler {	Line 192 sub real_handler {
$jumpToFirstHomework = 1;	$jumpToFirstHomework = 1;
# Find the next homework problem that they can do.	# Find the next homework problem that they can do.
my $iterator = $navmap->getIterator(undef, undef, undef, 1);	my $iterator = $navmap->getIterator(undef, undef, undef, 1);
my $depth = 1;	my $curRes;
$iterator->next();
my $curRes = $iterator->next();
my $foundDoableProblem = 0;	my $foundDoableProblem = 0;
my $problemRes;	my $problemRes;

while ($depth > 0 && !$foundDoableProblem) {	while (($curRes = $iterator->next()) && !$foundDoableProblem) {
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $iterator->END_MAP()) { $depth--; }

if (ref($curRes) && $curRes->is_problem()) {	if (ref($curRes) && $curRes->is_problem()) {
my $status = $curRes->status();	my $status = $curRes->status();
if ($curRes->completable()) {	if ($curRes->completable()) {
Line 236 sub real_handler {	Line 214 sub real_handler {
$ENV{'form.postsymb'} = $curRes->symb();	$ENV{'form.postsymb'} = $curRes->symb();
}	}
}	}
} continue {
$curRes = $iterator->next();
}	}

# If we found no problems, print a note to that effect.	# If we found no problems, print a note to that effect.
Line 246 sub real_handler {	Line 222 sub real_handler {
}	}
} else {	} else {
$r->print("<a href='navmaps?jumpToFirstHomework'>" .	$r->print("<a href='navmaps?jumpToFirstHomework'>" .
"Go To My First Homework Problem</a>    ");	&mt("Go To My First Homework Problem")."</a>    ");
}	}

my $suppressEmptySequences = 0;	my $suppressEmptySequences = 0;
Line 261 sub real_handler {	Line 237 sub real_handler {
$filterFunc = sub { my $res = shift;	$filterFunc = sub { my $res = shift;
return $res->completable() \|\| $res->is_map();	return $res->completable() \|\| $res->is_map();
};	};
$r->print("<p><font size='+2'>Uncompleted Homework</font></p>");	$r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");
$ENV{'form.filter'} = '';	$ENV{'form.filter'} = '';
$ENV{'form.condition'} = 1;	$ENV{'form.condition'} = 1;
$resource_no_folder_link = 1;	$resource_no_folder_link = 1;
} else {	} else {
$r->print("<a href='navmaps?showOnlyHomework'>" .	$r->print("<a href='navmaps?showOnlyHomework'>" .
"Show Only Uncompleted Homework</a>    ");	&mt("Show Only Uncompleted Homework")."</a>    ");
}	}

# renderer call	# renderer call
Line 286 sub real_handler {	Line 262 sub real_handler {
# user knows there was no error.	# user knows there was no error.
if ($renderArgs->{'counter'} == 0) {	if ($renderArgs->{'counter'} == 0) {
if ($showOnlyHomework) {	if ($showOnlyHomework) {
$r->print("<p><font size='+1'>All homework is currently completed.</font></p>");	$r->print("<p><font size='+1'>".&mt("All homework is currently completed").".</font></p>");
} else { # both jumpToFirstHomework and normal use the same: course must be empty	} else { # both jumpToFirstHomework and normal use the same: course must be empty
$r->print("<p><font size='+1'>This course is empty.</font></p>");	$r->print("<p><font size='+1'>This course is empty.</font></p>");
}	}
Line 356 sub getDescription {	Line 332 sub getDescription {
my $status = $res->status($part);	my $status = $res->status($part);

if ($status == $res->NETWORK_FAILURE) {	if ($status == $res->NETWORK_FAILURE) {
return "Having technical difficulties; please check status later";	return &mt("Having technical difficulties; please check status later");
}	}
if ($status == $res->NOTHING_SET) {	if ($status == $res->NOTHING_SET) {
return "Not currently assigned.";	return &mt("Not currently assigned.");
}	}
if ($status == $res->OPEN_LATER) {	if ($status == $res->OPEN_LATER) {
return "Open " . timeToHumanString($res->opendate($part));	return "Open " . timeToHumanString($res->opendate($part));
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
if ($res->duedate($part)) {	if ($res->duedate($part)) {
return "Due " . timeToHumanString($res->duedate($part));	return &mt("Due")." " .timeToHumanString($res->duedate($part));
} else {	} else {
return "Open, no due date";	return &mt("Open, no due date");
}	}
}	}
if ($status == $res->PAST_DUE_ANSWER_LATER) {	if ($status == $res->PAST_DUE_ANSWER_LATER) {
return "Answer open " . timeToHumanString($res->answerdate($part));	return &mt("Answer open")." " . timeToHumanString($res->answerdate($part));
}	}
if ($status == $res->PAST_DUE_NO_ANSWER) {	if ($status == $res->PAST_DUE_NO_ANSWER) {
return "Was due " . timeToHumanString($res->duedate($part));	return &mt("Was due")." " . timeToHumanString($res->duedate($part));
}	}
if ($status == $res->ANSWER_OPEN) {	if ($status == $res->ANSWER_OPEN) {
return "Answer available";	return &mt("Answer available");
}	}
if ($status == $res->EXCUSED) {	if ($status == $res->EXCUSED) {
return "Excused by instructor";	return &mt("Excused by instructor");
}	}
if ($status == $res->ATTEMPTED) {	if ($status == $res->ATTEMPTED) {
return "Answer submitted, not yet graded.";	return &mt("Answer submitted, not yet graded");
}	}
if ($status == $res->TRIES_LEFT) {	if ($status == $res->TRIES_LEFT) {
my $tries = $res->tries($part);	my $tries = $res->tries($part);
Line 397 sub getDescription {	Line 373 sub getDescription {
}	}
}	}
if ($res->duedate()) {	if ($res->duedate()) {
return "Due " . timeToHumanString($res->duedate($part)) .	return &mt("Due")." " . timeToHumanString($res->duedate($part)) .
" $triesString";	" $triesString";
} else {	} else {
return "No due date $triesString";	return &mt("No due date")." $triesString";
}	}
}	}
if ($status == $res->ANSWER_SUBMITTED) {	if ($status == $res->ANSWER_SUBMITTED) {
return 'Answer submitted';	return &mt('Answer submitted');
}	}
}	}

Line 454 sub timeToHumanString {	Line 430 sub timeToHumanString {
my ($time) = @_;	my ($time) = @_;
# zero, '0' and blank are bad times	# zero, '0' and blank are bad times
if (!$time) {	if (!$time) {
return 'never';	return &mt('never');
}	}
	unless (&Apache::lonlocal::current_language()=~/^en/) {
	return localtime($time);
	}
my $now = time();	my $now = time();

my @time = localtime($time);	my @time = localtime($time);
Line 552 sub timeToHumanString {	Line 530 sub timeToHumanString {

=head1 NAME	=head1 NAME

Apache::lonnavmap - Subroutines to handle and render the navigation maps	Apache::lonnavmap - Subroutines to handle and render the navigation
	maps

=head1 SYNOPSIS	=head1 SYNOPSIS

Line 562 other modules.	Line 541 other modules.

=head1 OVERVIEW	=head1 OVERVIEW

When a user enters a course, LON-CAPA examines the course structure	X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
and caches it in what is often referred to as the "big hash". You	course structure and caches it in what is often referred to as the
can see it if you are logged into LON-CAPA, in a course, by going	"big hash" X<big hash>. You can see it if you are logged into
to /adm/test. (You may need to tweak the /home/httpd/lonTabs/htpasswd	LON-CAPA, in a course, by going to /adm/test. (You may need to
file to view it.) The content of the hash will be under the heading	tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
"Big Hash".	content of the hash will be under the heading "Big Hash".

Big Hash contains, among other things, how resources are related	Big Hash contains, among other things, how resources are related
to each other (next/previous), what resources are maps, which	to each other (next/previous), what resources are maps, which
Line 679 can't close or open folders when this is	Line 658 can't close or open folders when this is

=back	=back

=item B<Apache::lonnavmaps::communication_status>:	=item * B<Apache::lonnavmaps::communication_status>:

Whether there is discussion on the resource, email for the user, or	Whether there is discussion on the resource, email for the user, or
(lumped in here) perl errors in the execution of the problem. This is	(lumped in here) perl errors in the execution of the problem. This is
the second column in the main nav map.	the second column in the main nav map.

=item B<Apache::lonnavmaps::quick_status>:	=item * B<Apache::lonnavmaps::quick_status>:

An icon for the status of a problem, with five possible states:	An icon for the status of a problem, with five possible states:
Correct, incorrect, open, awaiting grading (for a problem where the	Correct, incorrect, open, awaiting grading (for a problem where the
Line 693 computer's grade is suppressed, or the c	Line 672 computer's grade is suppressed, or the c
essay problem), or none (not open yet, not a problem). The	essay problem), or none (not open yet, not a problem). The
third column of the standard navmap.	third column of the standard navmap.

=item B<Apache::lonnavmaps::long_status>:	=item * B<Apache::lonnavmaps::long_status>:

A text readout of the details of the current status of the problem,	A text readout of the details of the current status of the problem,
such as "Due in 22 hours". The fourth column of the standard navmap.	such as "Due in 22 hours". The fourth column of the standard navmap.

	=item * B<Apache::lonnavmaps::part_status_summary>:

	A text readout summarizing the status of the problem. If it is a
	single part problem, will display "Correct", "Incorrect",
	"Not yet open", "Open", "Attempted", or "Error". If there are
	multiple parts, this will output a string that in HTML will show a
	status of how many parts are in each status, in color coding, trying
	to match the colors of the icons within reason.

	Note this only makes sense if you are I<not> showing parts. If
	C<showParts> is true (see below), this column will not output
	anything.

=back	=back

If you add any others please be sure to document them here.	If you add any others please be sure to document them here.
Line 716 to override vertical and horizontal alig	Line 708 to override vertical and horizontal alig

=head2 Parameters	=head2 Parameters

Most of these parameters are only useful if you are not using the	Minimally, you should be
folder interface (i.e., the default first column), which is probably
the common case. If you are using this interface, then you should be
able to get away with just using 'cols' (to specify the columns	able to get away with just using 'cols' (to specify the columns
shown), 'url' (necessary for the folders to link to the current screen	shown), 'url' (necessary for the folders to link to the current screen
correctly), and possibly 'queryString' if your app calls for it. In	correctly), and possibly 'queryString' if your app calls for it. In
Line 867 sub resource { return 0; }	Line 857 sub resource { return 0; }
sub communication_status { return 1; }	sub communication_status { return 1; }
sub quick_status { return 2; }	sub quick_status { return 2; }
sub long_status { return 3; }	sub long_status { return 3; }
	sub part_status_summary { return 4; }
# Data for render_resource

sub render_resource {	sub render_resource {
my ($resource, $part, $params) = @_;	my ($resource, $part, $params) = @_;
Line 1057 sub render_quick_status {	Line 1046 sub render_quick_status {

if ($resource->is_problem() &&	if ($resource->is_problem() &&
!$firstDisplayed) {	!$firstDisplayed) {
my $icon = $statusIconMap{$resource->status($part)};
	my $icon = $statusIconMap{$resource->simpleStatus($part)};
my $alt = $iconAltTags{$icon};	my $alt = $iconAltTags{$icon};
if ($icon) {	if ($icon) {
$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n";	$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n";
Line 1106 sub render_long_status {	Line 1096 sub render_long_status {
return $result;	return $result;
}	}

	# Colors obtained by taking the icons, matching the colors, and
	# possibly reducing the Value (HSV) of the color, if it's too bright
	# for text, generally by one third or so.
	my %statusColors =
	(
	$resObj->CLOSED => '#000000',
	$resObj->OPEN => '#998b13',
	$resObj->CORRECT => '#26933f',
	$resObj->INCORRECT => '#c48207',
	$resObj->ATTEMPTED => '#a87510',
	$resObj->ERROR => '#000000'
	);
	my %statusStrings =
	(
	$resObj->CLOSED => 'Not yet open',
	$resObj->OPEN => 'Open',
	$resObj->CORRECT => 'Correct',
	$resObj->INCORRECT => 'Incorrect',
	$resObj->ATTEMPTED => 'Attempted',
	$resObj->ERROR => 'Network Error'
	);
	my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);

	use Data::Dumper;
	sub render_parts_summary_status {
	my ($resource, $part, $params) = @_;
	if (!$resource->is_problem()) { return '<td></td>'; }
	if ($params->{showParts}) {
	return '<td></td>';
	}

	my $td = "<td align='right'>\n";
	my $endtd = "</td>\n";

	# If there is a single part, just show the simple status
	if ($resource->singlepart()) {
	my $status = $resource->simpleStatus('0');
	return $td . "<font color='" . $statusColors{$status} . "'>"
	. $statusStrings{$status} . "</font>" . $endtd;
	}

	# Now we can be sure the $part doesn't really matter.
	my $statusCount = $resource->simpleStatusCount();
	my @counts;
	foreach my $status(@statuses) {
	# decouple display order from the simpleStatusCount order
	my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
	if ($statusCount->[$slot]) {
	push @counts, "<font color='" . $statusColors{$status} .
	"'>" . $statusCount->[$slot] . ' '
	. $statusStrings{$status} . "</font>";
	}
	}

	return $td . $resource->countParts() . ' parts: ' . join (', ', @counts) . $endtd;
	}

my @preparedColumns = (\&render_resource, \&render_communication_status,	my @preparedColumns = (\&render_resource, \&render_communication_status,
\&render_quick_status, \&render_long_status);	\&render_quick_status, \&render_long_status,
	\&render_parts_summary_status);

sub setDefault {	sub setDefault {
my ($val, $default) = @_;	my ($val, $default) = @_;
Line 1173 sub render {	Line 1221 sub render {
if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {	if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
# Step 1: Check to see if we have a navmap	# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {	if (!defined($navmap)) {
$navmap = Apache::lonnavmaps::navmap->new(	$navmap = Apache::lonnavmaps::navmap->new();
$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 1, 1);
$mustCloseNavMap = 1;	$mustCloseNavMap = 1;
}	}
$navmap->init();

# Step two: Locate what kind of here marker is necessary	# Step two: Locate what kind of here marker is necessary
# Determine where the "here" marker is and where the screen jumps to.	# Determine where the "here" marker is and where the screen jumps to.
Line 1196 sub render {	Line 1241 sub render {

# Step three: Ensure the folders are open	# Step three: Ensure the folders are open
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);	my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
my $depth = 1;	my $curRes;
$mapIterator->next(); # discard the first BEGIN_MAP
my $curRes = $mapIterator->next();
my $found = 0;	my $found = 0;

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

if (ref($curRes) && $curRes->symb() eq $here) {	if (ref($curRes) && $curRes->symb() eq $here) {
my $mapStack = $mapIterator->getStack();	my $mapStack = $mapIterator->getStack();

Line 1221 sub render {	Line 1261 sub render {
}	}
$found = 1;	$found = 1;
}	}

$curRes = $mapIterator->next();
}	}
}	}

Line 1239 sub render {	Line 1277 sub render {

# Step 1: Check to see if we have a navmap	# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {	if (!defined($navmap)) {
$navmap = Apache::lonnavmaps::navmap->new($r,	$navmap = Apache::lonnavmaps::navmap->new();
$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 1, 1);
$mustCloseNavMap = 1;	$mustCloseNavMap = 1;
}	}
# Paranoia: Make sure it's ready
$navmap->init();

# See if we're being passed a specific map	# See if we're being passed a specific map
if ($args->{'iterator_map'}) {	if ($args->{'iterator_map'}) {
Line 1264 sub render {	Line 1298 sub render {
# Note this does not take filtering or hidden into account... need	# Note this does not take filtering or hidden into account... need
# to be fixed?	# to be fixed?
my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);	my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
my $depth = 1;	my $curRes;
$mapIterator->next();
my $curRes = $mapIterator->next();
my $foundJump = 0;	my $foundJump = 0;
my $counter = 0;	my $counter = 0;

while ($depth > 0 && !$foundJump) {	while (($curRes = $mapIterator->next()) && !$foundJump) {
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $mapIterator->END_MAP()) { $depth--; }
if (ref($curRes)) { $counter++; }	if (ref($curRes)) { $counter++; }

if (ref($curRes) && $jump eq $curRes->symb()) {	if (ref($curRes) && $jump eq $curRes->symb()) {
Line 1283 sub render {	Line 1313 sub render {
$args->{'currentJumpIndex'} = $counter;	$args->{'currentJumpIndex'} = $counter;
$foundJump = 1;	$foundJump = 1;
}	}

$curRes = $mapIterator->next();
}	}

my $showParts = setDefault($args->{'showParts'}, 1);	my $showParts = setDefault($args->{'showParts'}, 1);
Line 1303 sub render {	Line 1331 sub render {
$result.='<tr><td align="right" valign="bottom">Key:  </td>';	$result.='<tr><td align="right" valign="bottom">Key:  </td>';
if ($navmap->{LAST_CHECK}) {	if ($navmap->{LAST_CHECK}) {
$result .=	$result .=
'<img src="/adm/lonMisc/chat.gif"> New discussion since '.	'<img src="/adm/lonMisc/chat.gif"> '.&mt('New discussion since').' '.
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).	strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
'</td><td align="center" valign="bottom">  '.	'</td><td align="center" valign="bottom">  '.
'<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'.	'<img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
'</td>';	'</td>';
} else {	} else {
$result .= '<td align="center" valign="bottom">  '.	$result .= '<td align="center" valign="bottom">  '.
'<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'.	'<img src="/adm/lonMisc/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
'  <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'.	'  <img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').
'</td>';	'</td>';
}	}

Line 1322 sub render {	Line 1350 sub render {
if ($condition) {	if ($condition) {
$result.="<a href=\"navmaps?condition=0&filter=&$queryString" .	$result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
"&here=" . Apache::lonnet::escape($here) .	"&here=" . Apache::lonnet::escape($here) .
"\">Close All Folders</a>";	"\">".&mt('Close All Folders')."</a>";
} else {	} else {
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .	$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
"&here=" . Apache::lonnet::escape($here) .	"&here=" . Apache::lonnet::escape($here) .
"\">Open All Folders</a>";	"\">".&mt('Open All Folders')."</a>";
}	}
$result .= "<br /><br />\n";	$result .= "<br /><br />\n";
}	}
Line 1362 sub render {	Line 1390 sub render {
$it->{FIRST_RESOURCE},	$it->{FIRST_RESOURCE},
$it->{FINISH_RESOURCE},	$it->{FINISH_RESOURCE},
{}, undef, 1);	{}, undef, 1);
$depth = 0;	my $depth = 0;
$dfsit->next();	$dfsit->next();
my $curRes = $dfsit->next();	my $curRes = $dfsit->next();
while ($depth > -1) {	while ($depth > -1) {
Line 1394 sub render {	Line 1422 sub render {

my $displayedJumpMarker = 0;	my $displayedJumpMarker = 0;
# Set up iteration.	# Set up iteration.
$depth = 1;
$it->next(); # discard initial BEGIN_MAP
$curRes = $it->next();
my $now = time();	my $now = time();
my $in24Hours = $now + 24 * 60 * 60;	my $in24Hours = $now + 24 * 60 * 60;
my $rownum = 0;	my $rownum = 0;
Line 1404 sub render {	Line 1429 sub render {
# export "here" marker information	# export "here" marker information
$args->{'here'} = $here;	$args->{'here'} = $here;

while ($depth > 0) {	$args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
if ($curRes == $it->BEGIN_MAP()) { $depth++; }	while ($curRes = $it->next()) {
if ($curRes == $it->END_MAP()) { $depth--; }

# Maintain indentation level.	# Maintain indentation level.
if ($curRes == $it->BEGIN_MAP() \|\|	if ($curRes == $it->BEGIN_MAP() \|\|
$curRes == $it->BEGIN_BRANCH() ) {	$curRes == $it->BEGIN_BRANCH() ) {
Line 1560 sub render {	Line 1583 sub render {
$r->rflush();	$r->rflush();
}	}
} continue {	} continue {
$curRes = $it->next();

if ($r) {	if ($r) {
# If we have the connection, make sure the user is still connected	# If we have the connection, make sure the user is still connected
my $c = $r->connection;	my $c = $r->connection;
Line 1605 package Apache::lonnavmaps::navmap;	Line 1626 package Apache::lonnavmaps::navmap;

=head1 Object: Apache::lonnavmaps::navmap	=head1 Object: Apache::lonnavmaps::navmap

You must obtain resource objects through the navmap object.	=head2 Overview

	The navmap object's job is to provide access to the resources
	in the course as Apache::lonnavmaps::resource objects, and to
	query and manage the relationship between those resource objects.

	Generally, you'll use the navmap object in one of three basic ways.
	In order of increasing complexity and power:

	=over 4

	=item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
	various ways to obtain resource objects, based on various identifiers.
	Use this when you want to request information about one object or
	a handful of resources you already know the identities of, from some
	other source. For more about Ids, Symbs, and MapPcs, see the
	Resource documentation. Note that Url should be a B<last resort>,
	not your first choice; it only works when there is only one
	instance of the resource in the course, which only applies to
	maps, and even that may change in the future.

	=item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
	retrieves resources matching some criterion and returns them
	in a flat array, with no structure information. Use this when
	you are manipulating a series of resources, based on what map
	the are in, but do not care about branching, or exactly how
	the maps and resources are related. This is the most common case.

	=item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
	the course's navmap in various ways without writing the traversal
	code yourself. See iterator documentation below. Use this when
	you need to know absolutely everything about the course, including
	branches and the precise relationship between maps and resources.

	=back

	=head2 Creation And Destruction

=head2 Creation	To create a navmap object, use the following function:

=over 4	=over 4

=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions,	=item * B<Apache::lonnavmaps::navmap-E<gt>new>():
genMailDiscussStatus, getUserData):

Binds a new navmap object to the compiled nav map hash and parm hash	Creates a new navmap object. Returns the navmap object if this is
given as filenames. genCourseAndUserOptions is a flag saying whether	successful, or B<undef> if not.
the course options and user options hash should be generated. This is
for when you are using the parameters of the resources that require
them; see documentation in resource object
documentation. genMailDiscussStatus causes the nav map to retreive
information about the email and discussion status of
resources. Returns the navmap object if this is successful, or
B<undef> if not. You must check for undef; errors will occur when you
try to use the other methods otherwise. getUserData, if true, will
retreive the user's performance data for various problems.

=back	=back

	When you are done with the $navmap object, you I<must> call
	$navmap->untieHashes(), or you'll prevent the current user from using that
	course until the web server is restarted. (!)

=head2 Methods	=head2 Methods

=over 4	=over 4
Line 1647 sub new {	Line 1698 sub new {
my $class = ref($proto) \|\| $proto;	my $class = ref($proto) \|\| $proto;
my $self = {};	my $self = {};

$self->{NAV_HASH_FILE} = shift;
$self->{PARM_HASH_FILE} = shift;
$self->{GENERATE_COURSE_USER_OPT} = shift;
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
$self->{GET_USER_DATA} = shift;

# Resource cache stores navmap resources 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 1665 sub new {	Line 1710 sub new {

my %navmaphash;	my %navmaphash;
my %parmhash;	my %parmhash;
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},	my $courseFn = $ENV{"request.course.fn"};
	if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
&GDBM_READER(), 0640))) {	&GDBM_READER(), 0640))) {
return undef;	return undef;
}	}

if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},	if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
&GDBM_READER(), 0640)))	&GDBM_READER(), 0640)))
{	{
untie %{$self->{PARM_HASH}};	untie %{$self->{PARM_HASH}};
Line 1679 sub new {	Line 1725 sub new {

$self->{NAV_HASH} = \%navmaphash;	$self->{NAV_HASH} = \%navmaphash;
$self->{PARM_HASH} = \%parmhash;	$self->{PARM_HASH} = \%parmhash;
$self->{INITED} = 0;	$self->{PARM_CACHE} = {};

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

return $self;	return $self;
}	}

sub init {	sub generate_course_user_opt {
my $self = shift;	my $self = shift;
if ($self->{INITED}) { return; }	if ($self->{COURSE_USER_OPT_GENERATED}) { return; }

# If the course opt hash and the user opt hash should be generated,	my $uname=$ENV{'user.name'};
# generate them	my $udom=$ENV{'user.domain'};
if ($self->{GENERATE_COURSE_USER_OPT}) {	my $uhome=$ENV{'user.home'};
my $uname=$ENV{'user.name'};	my $cid=$ENV{'request.course.id'};
my $udom=$ENV{'user.domain'};	my $chome=$ENV{'course.'.$cid.'.home'};
my $uhome=$ENV{'user.home'};	my ($cdom,$cnum)=split(/\_/,$cid);
my $cid=$ENV{'request.course.id'};
my $chome=$ENV{'course.'.$cid.'.home'};	my $userprefix=$uname.'_'.$udom.'_';
my ($cdom,$cnum)=split(/\_/,$cid);
	my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
my $userprefix=$uname.'_'.$udom.'_';	unless ($uhome eq 'no_host') {

my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
unless ($uhome eq 'no_host') {
# ------------------------------------------------- Get coursedata (if present)	# ------------------------------------------------- Get coursedata (if present)
unless ((time-$courserdatas{$cid.'.last_cache'})<240) {	unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.	my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
':resourcedata',$chome);	':resourcedata',$chome);
# Check for network failure	# Check for network failure
if ( $reply =~ /no.such.host/i \|\| $reply =~ /con_lost/i) {	if ( $reply =~ /no.such.host/i \|\| $reply =~ /con_lost/i) {
$self->{NETWORK_FAILURE} = 1;	$self->{NETWORK_FAILURE} = 1;
} elsif ($reply!~/^error\:/) {	} elsif ($reply!~/^error\:/) {
$courserdatas{$cid}=$reply;	$courserdatas{$cid}=$reply;
$courserdatas{$cid.'.last_cache'}=time;	$courserdatas{$cid.'.last_cache'}=time;
}	}
}	}
foreach (split(/\&/,$courserdatas{$cid})) {	foreach (split(/\&/,$courserdatas{$cid})) {
my ($name,$value)=split(/\=/,$_);	my ($name,$value)=split(/\=/,$_);
$courseopt{$userprefix.&Apache::lonnet::unescape($name)}=	$courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
&Apache::lonnet::unescape($value);	&Apache::lonnet::unescape($value);
}	}
# --------------------------------------------------- Get userdata (if present)	# --------------------------------------------------- Get userdata (if present)
unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {	unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);	my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
if ($reply!~/^error\:/) {	if ($reply!~/^error\:/) {
$userrdatas{$uname.'___'.$udom}=$reply;	$userrdatas{$uname.'___'.$udom}=$reply;
$userrdatas{$uname.'___'.$udom.'.last_cache'}=time;	$userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
}	}
# check to see if network failed	# check to see if network failed
elsif ( $reply=~/no.such.host/i \|\| $reply=~/con.*lost/i )	elsif ( $reply=~/no.such.host/i \|\| $reply=~/con.*lost/i )
{	{
$self->{NETWORK_FAILURE} = 1;	$self->{NETWORK_FAILURE} = 1;
}	}
}	}
foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {	foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
my ($name,$value)=split(/\=/,$_);	my ($name,$value)=split(/\=/,$_);
$useropt{$userprefix.&Apache::lonnet::unescape($name)}=	$useropt{$userprefix.&Apache::lonnet::unescape($name)}=
&Apache::lonnet::unescape($value);	&Apache::lonnet::unescape($value);
}	}
$self->{COURSE_OPT} = \%courseopt;	$self->{COURSE_OPT} = \%courseopt;
$self->{USER_OPT} = \%useropt;	$self->{USER_OPT} = \%useropt;
}
}

if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
my $cid=$ENV{'request.course.id'};
my ($cdom,$cnum)=split(/\_/,$cid);

my %emailstatus = &Apache::lonnet::dump('email_status');
my $logoutTime = $emailstatus{'logout'};
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
$courseLeaveTime : $logoutTime);
my %discussiontime = &Apache::lonnet::dump('discussiontimes',
$cdom, $cnum);
my %feedback=();
my %error=();
my $keys = &Apache::lonnet::reply('keys:'.
$ENV{'user.domain'}.':'.
$ENV{'user.name'}.':nohist_email',
$ENV{'user.home'});

foreach my $msgid (split(/\&/, $keys)) {
$msgid=&Apache::lonnet::unescape($msgid);
my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
if ($plain=~/(Error\|Feedback) \[([^\]]+)\]/) {
my ($what,$url)=($1,$2);
my %status=
&Apache::lonnet::get('email_status',[$msgid]);
if ($status{$msgid}=~/^error\:/) {
$status{$msgid}='';
}

if (($status{$msgid} eq 'new') \|\|
(!$status{$msgid})) {
if ($what eq 'Error') {
$error{$url}.=','.$msgid;
} else {
$feedback{$url}.=','.$msgid;
}
}
}
}

$self->{FEEDBACK} = \%feedback;
$self->{ERROR_MSG} = \%error; # what is this? JB
$self->{DISCUSSION_TIME} = \%discussiontime;
$self->{EMAIL_STATUS} = \%emailstatus;

}	}

if ($self->{GET_USER_DATA}) {	$self->{COURSE_USER_OPT_GENERATED} = 1;
# Retreive performance data on problems
my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},	return;
$ENV{'user.domain'},	}
$ENV{'user.name'});
$self->{STUDENT_DATA} = \%student_data;	sub generate_email_discuss_status {
	my $self = shift;
	if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }

	my $cid=$ENV{'request.course.id'};
	my ($cdom,$cnum)=split(/\_/,$cid);

	my %emailstatus = &Apache::lonnet::dump('email_status');
	my $logoutTime = $emailstatus{'logout'};
	my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
	$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
	$courseLeaveTime : $logoutTime);
	my %discussiontime = &Apache::lonnet::dump('discussiontimes',
	$cdom, $cnum);
	my %feedback=();
	my %error=();
	my $keys = &Apache::lonnet::reply('keys:'.
	$ENV{'user.domain'}.':'.
	$ENV{'user.name'}.':nohist_email',
	$ENV{'user.home'});

	foreach my $msgid (split(/\&/, $keys)) {
	$msgid=&Apache::lonnet::unescape($msgid);
	my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
	if ($plain=~/(Error\|Feedback) \[([^\]]+)\]/) {
	my ($what,$url)=($1,$2);
	my %status=
	&Apache::lonnet::get('email_status',[$msgid]);
	if ($status{$msgid}=~/^error\:/) {
	$status{$msgid}='';
	}

	if (($status{$msgid} eq 'new') \|\|
	(!$status{$msgid})) {
	if ($what eq 'Error') {
	$error{$url}.=','.$msgid;
	} else {
	$feedback{$url}.=','.$msgid;
	}
	}
	}
}	}

	$self->{FEEDBACK} = \%feedback;
	$self->{ERROR_MSG} = \%error; # what is this? JB
	$self->{DISCUSSION_TIME} = \%discussiontime;
	$self->{EMAIL_STATUS} = \%emailstatus;

	$self->{EMAIL_DISCUSS_GENERATED} = 1;
	}

$self->{PARM_CACHE} = {};	sub get_user_data {
$self->{INITED} = 1;	my $self = shift;
	if ($self->{RETRIEVED_USER_DATA}) { return; }

	# Retrieve performance data on problems
	my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},
	$ENV{'user.domain'},
	$ENV{'user.name'});
	$self->{STUDENT_DATA} = \%student_data;

	$self->{RETRIEVED_USER_DATA} = 1;
}	}

# Internal function: Takes a key to look up in the nav hash and implements internal	# Internal function: Takes a key to look up in the nav hash and implements internal
Line 1810 sub navhash {	Line 1862 sub navhash {
return $self->{NAV_HASH}->{$key};	return $self->{NAV_HASH}->{$key};
}	}

	=pod

	=item * B<courseMapDefined>(): Returns true if the course map is defined,
	false otherwise. Undefined course maps indicate an error somewhere in
	LON-CAPA, and you will not be able to proceed with using the navmap.
	See the B<NAV> screen for an example of using this.

	=cut

# 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;
Line 1839 sub untieHashes {	Line 1900 sub untieHashes {
sub hasDiscussion {	sub hasDiscussion {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;

	$self->generate_email_discuss_status();

if (!defined($self->{DISCUSSION_TIME})) { return 0; }	if (!defined($self->{DISCUSSION_TIME})) { return 0; }

#return defined($self->{DISCUSSION_TIME}->{$symb});	#return defined($self->{DISCUSSION_TIME}->{$symb});
Line 1853 sub getFeedback {	Line 1917 sub getFeedback {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;

	$self->generate_email_discuss_status();

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

return $self->{FEEDBACK}->{$symb};	return $self->{FEEDBACK}->{$symb};
Line 1862 sub getFeedback {	Line 1928 sub getFeedback {
sub getErrors {	sub getErrors {
my $self = shift;	my $self = shift;
my $src = shift;	my $src = shift;

	$self->generate_email_discuss_status();

if (!defined($self->{ERROR_MSG})) { return ""; }	if (!defined($self->{ERROR_MSG})) { return ""; }
return $self->{ERROR_MSG}->{$src};	return $self->{ERROR_MSG}->{$src};
}	}
Line 1891 the given map. This is one of the proper	Line 1959 the given map. This is one of the proper
# The strategy here is to cache the resource objects, and only construct them	# The strategy here is to cache the resource objects, and only construct them
# as we use them. The real point is to prevent reading any more from the tied	# as we use them. The real point is to prevent reading any more from the tied
# hash then we have to, which should hopefully alleviate speed problems.	# hash then we have to, which should hopefully alleviate speed problems.
# Caching is just an incidental detail I throw in because it makes sense.

sub getById {	sub getById {
my $self = shift;	my $self = shift;
Line 1911 sub getById {	Line 1978 sub getById {
sub getBySymb {	sub getBySymb {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;
my ($mapUrl, $id, $filename) = split (/___/, $symb);	my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
my $map = $self->getResourceByUrl($mapUrl);	my $map = $self->getResourceByUrl($mapUrl);
return $self->getById($map->map_pc() . '.' . $id);	return $self->getById($map->map_pc() . '.' . $id);
}	}
Line 1974 sub parmval {	Line 2041 sub parmval {

sub parmval_real {	sub parmval_real {
my $self = shift;	my $self = shift;
my ($what,$symb) = @_;	my ($what,$symb,$recurse) = @_;

	# Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
	$self->generate_course_user_opt();

my $cid=$ENV{'request.course.id'};	my $cid=$ENV{'request.course.id'};
my $csec=$ENV{'request.course.sec'};	my $csec=$ENV{'request.course.sec'};
Line 1984 sub parmval_real {	Line 2054 sub parmval_real {
unless ($symb) { return ''; }	unless ($symb) { return ''; }
my $result='';	my $result='';

my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);	my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);

# ----------------------------------------------------- Cascading lookup scheme	# ----------------------------------------------------- Cascading lookup scheme
my $rwhat=$what;	my $rwhat=$what;
Line 2046 sub parmval_real {	Line 2116 sub parmval_real {
my $id=pop(@parts);	my $id=pop(@parts);
my $part=join('_',@parts);	my $part=join('_',@parts);
if ($part eq '') { $part='0'; }	if ($part eq '') { $part='0'; }
my $partgeneral=$self->parmval($part.".$qualifier",$symb);	my $partgeneral=$self->parmval($part.".$qualifier",$symb,1);
if (defined($partgeneral)) { return $partgeneral; }	if (defined($partgeneral)) { return $partgeneral; }
}	}
	if ($recurse) { return undef; }
	my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
	if (defined($pack_def)) { return $pack_def; }
return '';	return '';
}	}

Line 2147 sub retrieveResources {	Line 2220 sub retrieveResources {
my @resources = ();	my @resources = ();

# Run down the iterator and collect the resources.	# Run down the iterator and collect the resources.
my $depth = 1;	my $curRes;
$it->next();
my $curRes = $it->next();	while ($curRes = $it->next()) {

while ($depth > 0) {
if ($curRes == $it->BEGIN_MAP()) {
$depth++;
}
if ($curRes == $it->END_MAP()) {
$depth--;
}

if (ref($curRes)) {	if (ref($curRes)) {
if (!&$filterFunc($curRes)) {	if (!&$filterFunc($curRes)) {
next;	next;
Line 2171 sub retrieveResources {	Line 2235 sub retrieveResources {
}	}
}	}

} continue {
$curRes = $it->next();
}	}

return @resources;	return @resources;
Line 2248 new branch. The possible tokens are:	Line 2310 new branch. The possible tokens are:

=over 4	=over 4

=item * BEGIN_MAP:	=item * B<END_ITERATOR>:

	The iterator has returned all that it's going to. Further calls to the
	iterator will just produce more of these. This is a "false" value, and
	is the only false value the iterator which will be returned, so it can
	be used as a loop sentinel.

	=item * B<BEGIN_MAP>:

A new map is being recursed into. This is returned I<after> the map	A new map is being recursed into. This is returned I<after> the map
resource itself is returned.	resource itself is returned.

=item * END_MAP:	=item * B<END_MAP>:

The map is now done.	The map is now done.

=item * BEGIN_BRANCH:	=item * B<BEGIN_BRANCH>:

A branch is now starting. The next resource returned will be the first	A branch is now starting. The next resource returned will be the first
in that branch.	in that branch.

=item * END_BRANCH:	=item * B<END_BRANCH>:

The branch is now done.	The branch is now done.

Line 2278 consisting entirely of empty resources e	Line 2347 consisting entirely of empty resources e
ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,	ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
but only one resource will be returned.	but only one resource will be returned.

	=head2 Normal Usage

	Normal usage of the iterator object is to do the following:

	my $it = $navmap->getIterator([your params here]);
	my $curRes;
	while ($curRes = $it->next()) {
	[your logic here]
	}

	Note that inside of the loop, it's frequently useful to check if
	"$curRes" is a reference or not with the reference function; only
	resource objects will be references, and any non-references will
	be the tokens described above.

	Also note there is some old code floating around that trys to track
	the depth of the iterator to see when it's done; do not copy that
	code. It is difficult to get right and harder to understand then
	this. They should be migrated to this new style.

=back	=back

=cut	=cut

# Here are the tokens for the iterator:	# Here are the tokens for the iterator:

	sub END_ITERATOR { return 0; }
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 BEGIN_BRANCH { return 3; } # beginning of a branch	sub BEGIN_BRANCH { return 3; } # beginning of a branch
Line 2369 sub new {	Line 2459 sub new {

# prime the recursion	# prime the recursion
$self->{$firstResourceName}->{DATA}->{$valName} = 0;	$self->{$firstResourceName}->{DATA}->{$valName} = 0;
my $depth = 0;	$iterator->next();
$iterator->next();
my $curRes = $iterator->next();	my $curRes = $iterator->next();
while ($depth > -1) {	my $depth = 1;
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }	while ($depth > 0) {
if ($curRes == $iterator->END_MAP()) { $depth--; }	if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
	if ($curRes == $iterator->END_MAP()) { $depth--; }

if (ref($curRes)) {	if (ref($curRes)) {
# If there's only one resource, this will save it	# If there's only one resource, this will save it
# we have to filter empty resources from consideration here,	# we have to filter empty resources from consideration here,
Line 2409 sub new {	Line 2499 sub new {
$curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;	$curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}	if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
}	}
} continue {
$curRes = $iterator->next();	$curRes = $iterator->next();
}	}
}	}

Line 2431 sub new {	Line 2521 sub new {
$self->{MAX_DEPTH} = $maxDepth;	$self->{MAX_DEPTH} = $maxDepth;
$self->{STACK} = [];	$self->{STACK} = [];
$self->{RECURSIVE_ITERATOR_FLAG} = 0;	$self->{RECURSIVE_ITERATOR_FLAG} = 0;
	$self->{FINISHED} = 0; # When true, the iterator has finished

for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {	for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
push @{$self->{STACK}}, [];	push @{$self->{STACK}}, [];
Line 2448 sub new {	Line 2539 sub new {
sub next {	sub next {
my $self = shift;	my $self = shift;

	if ($self->{FINISHED}) {
	return END_ITERATOR();
	}

# If we want to return the top-level map object, and haven't yet,	# If we want to return the top-level map object, and haven't yet,
# do so.	# do so.
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {	if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
Line 2507 sub next {	Line 2602 sub next {
$self->{CURRENT_DEPTH}--;	$self->{CURRENT_DEPTH}--;
return END_BRANCH();	return END_BRANCH();
} else {	} else {
	$self->{FINISHED} = 1;
return END_MAP();	return END_MAP();
}	}
}	}
Line 2819 use Apache::lonnet;	Line 2915 use Apache::lonnet;

=pod	=pod

=head1 Object: resource	=head1 Object: resource

	X<resource, navmap object>
A resource object encapsulates a resource in a resource map, allowing	A resource object encapsulates a resource in a resource map, allowing
easy manipulation of the resource, querying the properties of the	easy manipulation of the resource, querying the properties of the
resource (including user properties), and represents a reference that	resource (including user properties), and represents a reference that
Line 2840 writing, there is no way to override thi	Line 2937 writing, there is no way to override thi
parts will never be returned, nor will their response types or ids be	parts will never be returned, nor will their response types or ids be
stored.	stored.

=head2 Public Members	=head2 Overview

resource objects have a hash called DATA ($resourceRef->{DATA}) that
you can store whatever you want in. This allows you to easily do
two-pass algorithms without worrying about managing your own
resource->data hash.

=head2 Methods

=over 4

=item * B<new>($navmapRef, $idString):	A B<Resource> is the most granular type of object in LON-CAPA that can
	be included in a course. It can either be a particular resource, like
The first arg is a reference to the parent navmap object. The second	an HTML page, external resource, problem, etc., or it can be a
is the idString of the resource itself. Very rarely, if ever, called	container sequence, such as a "page" or a "map".
directly. Use the nav map->getByID() method.
	To see a sequence from the user's point of view, please see the
=back	B<Creating a Course: Maps and Sequences> chapter of the Author's
	Manual.

	A Resource Object, once obtained from a navmap object via a B<getBy*>
	method of the navmap, or from an iterator, allows you to query
	information about that resource.

	Generally, you do not ever want to create a resource object yourself,
	so creation has been left undocumented. Always retrieve resources
	from navmap objects.

	=head3 Identifying Resources

	X<big hash>Every resource is identified by a Resource ID in the big hash that is
	unique to that resource for a given course. X<resource ID, in big hash>
	The Resource ID has the form #.#, where the first number is the same
	for every resource in a map, and the second is unique. For instance,
	for a course laid out like this:

	* Problem 1
	* Map
	* Resource 2
	* Resource 3

	C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
	C<Resource 3> will share a first number. The second number may end up
	re-used between the two groups.

	The resource ID is only used in the big hash, but can be used in the
	context of a course to identify a resource easily. (For instance, the
	printing system uses it to record which resources from a sequence you
	wish to print.)

	X<symb> X<resource, symb>
	All resources also have B<symb>s, which uniquely identify a resource
	in a course. Many internal LON-CAPA functions expect a symb. A symb
	carries along with it the URL of the resource, and the map it appears
	in. Symbs are much larger then resource IDs.

=cut	=cut

Line 2896 sub navHash {	Line 3021 sub navHash {

=pod	=pod

B<Metadata Retreival>	=head2 Methods

	Once you have a resource object, here's what you can do with it:

These are methods that help you retrieve metadata about the resource:	=head3 Attribute Retrieval
Method names are based on the fields in the compiled course
representation.	Every resource has certain attributes that can be retrieved and used:

=over 4	=over 4

	=item * B<ID>: Every resource has an ID that is unique for that
	resource in the course it is in. The ID is actually in the hash
	representing the resource, so for a resource object $res, obtain
	it via C<$res->{ID}).

=item * B<compTitle>:	=item * B<compTitle>:

Returns a "composite title", that is equal to $res->title() if the	Returns a "composite title", that is equal to $res->title() if the
Line 2914 resource has a title, and is otherwise t	Line 3046 resource has a title, and is otherwise t

Returns true if the resource is external.	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<kind>:	=item * B<kind>:

Returns the kind of the resource from the compiled nav map.	Returns the kind of the resource from the compiled nav map.
Line 2946 Returns the symb for the resource.	Line 3073 Returns the symb for the resource.

Returns the title of the resource.	Returns the title of the resource.

=item * B<to>:

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

=back	=back

=cut	=cut
Line 2960 want to use B<getNext> instead.)	Line 3082 want to use B<getNext> instead.)
sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }	sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }	sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
sub from { my $self=shift; return $self->navHash("from_", 1); }	sub from { my $self=shift; return $self->navHash("from_", 1); }
	# considered private and undocumented
sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }	sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
sub kind { my $self=shift; return $self->navHash("kind_", 1); }	sub kind { my $self=shift; return $self->navHash("kind_", 1); }
sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }	sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
Line 2976 sub symb {	Line 3099 sub symb {
my $self=shift;	my $self=shift;
(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;	(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
my $symbSrc = &Apache::lonnet::declutter($self->src());	my $symbSrc = &Apache::lonnet::declutter($self->src());
return &Apache::lonnet::declutter(	my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
$self->navHash('map_id_'.$first))
. '___' . $second . '___' . $symbSrc;	. '___' . $second . '___' . $symbSrc;
	return &Apache::lonnet::symbclean($symb);
}	}
sub title {	sub title {
my $self=shift;	my $self=shift;
Line 2988 sub title {	Line 3111 sub title {
return $ENV{'course.'.$ENV{'request.course.id'}.'.description'};	return $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
}	}
return $self->navHash("title_", 1); }	return $self->navHash("title_", 1); }
	# considered private and undocumented
sub to { my $self=shift; return $self->navHash("to_", 1); }	sub to { my $self=shift; return $self->navHash("to_", 1); }
sub compTitle {	sub compTitle {
my $self = shift;	my $self = shift;
Line 3223 sub answerdate {	Line 3347 sub answerdate {
}	}
sub awarded {	sub awarded {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
	$self->{NAV_MAP}->get_user_data();
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};	return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
}	}
Line 3412 sub multipart {	Line 3537 sub multipart {
return $self->countParts() > 1;	return $self->countParts() > 1;
}	}

	sub singlepart {
	my $self = shift;
	return $self->countParts() == 1;
	}

sub responseType {	sub responseType {
my $self = shift;	my $self = shift;
my $part = shift;	my $part = shift;

$self->extractParts();	$self->extractParts();
return $self->{RESPONSE_TYPES}->{$part};	return @{$self->{RESPONSE_TYPES}->{$part}};
}	}

sub responseIds {	sub responseIds {
Line 3425 sub responseIds {	Line 3555 sub responseIds {
my $part = shift;	my $part = shift;

$self->extractParts();	$self->extractParts();
return $self->{RESPONSE_IDS}->{$part};	return @{$self->{RESPONSE_IDS}->{$part}};
}	}

# Private function: Extracts the parts information, both part names and	# Private function: Extracts the parts information, both part names and
Line 3499 sub extractParts {	Line 3629 sub extractParts {
my @otherChunks = @partChunks[$i+1..$#partChunks];	my @otherChunks = @partChunks[$i+1..$#partChunks];
my $responseId = join('_', @otherChunks);	my $responseId = join('_', @otherChunks);
push @{$responseIdHash{$partIdSoFar}}, $responseId;	push @{$responseIdHash{$partIdSoFar}}, $responseId;
$responseTypeHash{$partIdSoFar} = $responseType;	push @{$responseTypeHash{$partIdSoFar}}, $responseType;
last;
}	}
}	}
}	}
Line 3815 sub status {	Line 3944 sub status {
# dimension and 5 entries on the other, which we want to colorize,	# dimension and 5 entries on the other, which we want to colorize,
# plus network failure and "no date data at all".	# plus network failure and "no date data at all".

	#if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }	if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }

my $suppressFeedback = lc($self->parmval("problemstatus", $part)) eq 'no';	my $suppressFeedback = lc($self->parmval("problemstatus", $part)) eq 'no';
Line 3861 sub status {	Line 3991 sub status {
if ($completionStatus == INCORRECT \|\| $completionStatus == INCORRECT_BY_OVERRIDE) {	if ($completionStatus == INCORRECT \|\| $completionStatus == INCORRECT_BY_OVERRIDE) {
# and there are TRIES LEFT:	# and there are TRIES LEFT:
if ($self->tries($part) < $self->maxtries($part) \|\| !$self->maxtries($part)) {	if ($self->tries($part) < $self->maxtries($part) \|\| !$self->maxtries($part)) {
return TRIES_LEFT;	return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
}	}
return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this	return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
}	}
Line 3870 sub status {	Line 4000 sub status {
return OPEN;	return OPEN;
}	}

	sub CLOSED { return 23; }
	sub ERROR { return 24; }

	=pod

	B<Simple Status>

	Convenience method B<simpleStatus> provides a "simple status" for the resource.
	"Simple status" corresponds to "which icon is shown on the
	Navmaps". There are six "simple" statuses:

	=over 4

	=item * B<CLOSED>: The problem is currently closed. (No icon shown.)

	=item * B<OPEN>: The problem is open and unattempted.

	=item * B<CORRECT>: The problem is correct for any reason.

	=item * B<INCORRECT>: The problem is incorrect and can still be
	completed successfully.

	=item * B<ATTEMPTED>: The problem has been attempted, but the student
	does not know if they are correct. (The ellipsis icon.)

	=item * B<ERROR>: There is an error retrieving information about this
	problem.

	=back

	=cut

	# This hash maps the composite status to this simple status, and
	# can be used directly, if you like
	my %compositeToSimple =
	(
	NETWORK_FAILURE() => ERROR,
	NOTHING_SET() => CLOSED,
	CORRECT() => CORRECT,
	EXCUSED() => CORRECT,
	PAST_DUE_NO_ANSWER() => INCORRECT,
	PAST_DUE_ANSWER_LATER() => INCORRECT,
	ANSWER_OPEN() => INCORRECT,
	OPEN_LATER() => CLOSED,
	TRIES_LEFT() => OPEN,
	INCORRECT() => INCORRECT,
	OPEN() => OPEN,
	ATTEMPTED() => ATTEMPTED,
	ANSWER_SUBMITTED() => ATTEMPTED
	);

	sub simpleStatus {
	my $self = shift;
	my $part = shift;
	my $status = $self->status($part);
	return $compositeToSimple{$status};
	}

	=pod

	B<simpleStatusCount> will return an array reference containing, in
	this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
	and ERROR parts the given problem has.

	=cut

	# This maps the status to the slot we want to increment
	my %statusToSlotMap =
	(
	OPEN() => 0,
	CLOSED() => 1,
	CORRECT() => 2,
	INCORRECT() => 3,
	ATTEMPTED() => 4,
	ERROR() => 5
	);

	sub statusToSlot { return $statusToSlotMap{shift()}; }

	sub simpleStatusCount {
	my $self = shift;

	my @counts = (0, 0, 0, 0, 0, 0, 0);
	foreach my $part (@{$self->parts()}) {
	$counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
	}

	return \@counts;
	}

=pod	=pod

B<Completable>	B<Completable>

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

Removed from v.1.216
changed lines
	Added in v.1.234