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.67 and 1.91

version 1.67, 2002/10/07 19:00:38	version 1.91, 2002/10/29 20:17:39
Line 1	Line 1

# The LearningOnline Network with CAPA	# The LearningOnline Network with CAPA
# Navigate Maps Handler	# Navigate Maps Handler
#	#
Line 44 use strict;	Line 45 use strict;
use Apache::Constants qw(:common :http);	use Apache::Constants qw(:common :http);
use Apache::lonnet();	use Apache::lonnet();
use Apache::loncommon();	use Apache::loncommon();
use HTML::TokeParser;
use GDBM_File;	use GDBM_File;
	use POSIX qw (floor strftime);

# -------------------------------------------------------------- Module Globals	# -------------------------------------------------------------- Module Globals
my %hash;	my %hash;
Line 822 sub new_handle {	Line 823 sub new_handle {
# Initialize the nav map	# Initialize 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);	$ENV{"request.course.fn"}."_parms.db", 1, 1);


if (!defined($navmap)) {	if (!defined($navmap)) {
Line 842 sub new_handle {	Line 843 sub new_handle {
$r->rflush();	$r->rflush();
if ($navmap->{LAST_CHECK}) {	if ($navmap->{LAST_CHECK}) {
$r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.	$r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
timeToHumanString($navmap->{LAST_CHECK}).	strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');	'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
} else {	} else {
$r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.	$r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');	'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
}	}
#if (($currenturl=~/^\/res/) &&
# ($currenturl!~/^\/res\/adm/)) {
# $r->print('<a href="#curloc">Current Location</a><p>');
#}

# Check that it's defined	# Check that it's defined
if (!($navmap->courseMapDefined())) {	if (!($navmap->courseMapDefined())) {
Line 879 sub new_handle {	Line 876 sub new_handle {
$res->NOTHING_SET => '' );	$res->NOTHING_SET => '' );
# And a special case in the nav map; what to do when the assignment	# And a special case in the nav map; what to do when the assignment
# is not yet done and due in less then 24 hours	# is not yet done and due in less then 24 hours
my $hurryUpColor = "#FFCCCC";	my $hurryUpColor = "#FF0000";

my %statusIconMap =	my %statusIconMap =
( $res->NETWORK_FAILURE => '',	( $res->NETWORK_FAILURE => '',
Line 892 sub new_handle {	Line 889 sub new_handle {
$res->OPEN_LATER => '',	$res->OPEN_LATER => '',
$res->TRIES_LEFT => 'navmap.open.gif',	$res->TRIES_LEFT => 'navmap.open.gif',
$res->INCORRECT => 'navmap.wrong.gif',	$res->INCORRECT => 'navmap.wrong.gif',
$res->OPEN => 'navmap.open.gif' );	$res->OPEN => 'navmap.open.gif',
	$res->ATTEMPTED => 'navmap.open.gif' );

	my %iconAltTags =
	( 'navmap.correct.gif' => 'Correct',
	'navmap.wrong.gif' => 'Incorrect',
	'navmap.open.gif' => 'Open' );

my %condenseStatuses =	my %condenseStatuses =
( $res->NETWORK_FAILURE => 1,	( $res->NETWORK_FAILURE => 1,
Line 907 sub new_handle {	Line 910 sub new_handle {
}	}
}	}

	# 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.
	my $topResource = $navmap->getById("0.0");
	my $inlineTopLevelMaps = $topResource->src() =~ m\|^/uploaded/.*default\.sequence$\|;

my $currenturl = $ENV{'form.postdata'};	my $currenturl = $ENV{'form.postdata'};
$currenturl=~s/^http\:\/\///;	$currenturl=~s/^http\:\/\///;
$currenturl=~s/^[^\/]+//;	$currenturl=~s/^[^\/]+//;
my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);	# alreadyHere allows us to only open the maps necessary to view
	# the current location once, while at the same time remembering
$r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');	# the current location. Without that check, the user would never
	# be able to close those maps; the user would close it, and the
# Begin the HTML table	# currenturl scan would re-open it.
# four cols: resource + indent, chat+feedback, icon, text string	my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .
$r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");	"&alreadyHere=1";

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

	if ($condition) {
	$r->print('<a href="navmaps?condition=0&filter=">Close All Folders</a><br /><br />');
	} else {
	$r->print('<a href="navmaps?condition=1&filter=">Open All Folders</a><br /><br />');
}	}

my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);	# Begin the HTML table
	# four cols: resource + indent, chat+feedback, icon, text string
	$r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n");

	# This needs to be updated to use symbs from the remote,
	# instead of uris. The changes to this and the main rendering
	# loop should be obvious.
	# Here's a simple example of the iterator.
	# Preprocess the map: Look for current URL, force inlined maps to display

	my $mapIterator = $navmap->getIterator(undef, undef, {}, 1);
	my $found = 0;
	my $depth = 1;
	my $currentUrlIndex = 0; # keeps track of when the current resource is found,
	# so we can back up a few and put the anchor above the
	# current resource
	$mapIterator->next(); # discard the first BEGIN_MAP
my $curRes = $mapIterator->next();	my $curRes = $mapIterator->next();
	my $counter = 0;

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

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

	my $mapStack = $mapIterator->getStack();
	if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) &&
	$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;

	for my $map (@{$mapStack}) {
	if ($condition) {
	undef $filterHash{$map->map_pc()};
	} else {
	$filterHash{$map->map_pc()} = 1;
	}
	}
	$ENV{'form.alreadyHere'} = 1;
	}

	# Preprocessing: If we're inlining nav maps into the top-level display,
	# make sure we show this map!
	if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map &&
	scalar(@{$mapStack}) == 1) {
	if ($condition) {
	undef $filterHash{$curRes->map_pc()};
	} else {
	$filterHash{$curRes->map_pc()} = 1;
	}
	}

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

undef $res; # so we don't accidentally use it later	undef $res; # so we don't accidentally use it later
my $indentLevel = -1;	my $indentLevel = 0;
my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";	my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";

my $isNewBranch = 0;	my $isNewBranch = 0;
my $now = time();	my $now = time();
my $in24Hours = $now + 24 * 60 * 60;	my $in24Hours = $now + 24 * 60 * 60;
	my $displayedHereMarker = 0;

	# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
	# code in iterator->next), so ignore the first one
	$mapIterator = $navmap->getIterator(undef, undef, \%filterHash,
	$condition);
	$mapIterator->next();
	$curRes = $mapIterator->next();
	my $deltadepth = 0;
	$depth = 1;

	my @backgroundColors = ("#FFFFFF", "#F6F6F6");
	my $rowNum = 0;

	$counter = 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;
	}

while ($curRes != $mapIterator->END_NAV_MAP) {
if ($curRes == $mapIterator->BEGIN_MAP() \|\|	if ($curRes == $mapIterator->BEGIN_MAP() \|\|
$curRes == $mapIterator->BEGIN_BRANCH()) {	$curRes == $mapIterator->BEGIN_BRANCH()) {
$indentLevel++;	$indentLevel++;
Line 945 sub new_handle {	Line 1048 sub new_handle {
if ($curRes == $mapIterator->BEGIN_BRANCH()) {	if ($curRes == $mapIterator->BEGIN_BRANCH()) {
$isNewBranch = 1;	$isNewBranch = 1;
}	}
	if ($curRes == $mapIterator->BEGIN_MAP()) {
	$depth++;
	}
	if ($curRes == $mapIterator->END_MAP()) {
	$depth--;
	}

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

	if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're
	# out of the inlined map

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

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

Line 962 sub new_handle {	Line 1082 sub new_handle {
# just display first	# just display first
if (!$curRes->opendate("0")) {	if (!$curRes->opendate("0")) {
@parts = ("0"); # just display the zero-th part	@parts = ("0"); # just display the zero-th part
$condensed = 1;	$condensed = 1;
} else {	} else {
# Otherwise, only display part 0 if we want to	# Otherwise, only display part 0 if we want to
# attach feedback or email information to it	# attach feedback or email information to it
Line 1010 sub new_handle {	Line 1130 sub new_handle {
}	}

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

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

# Display one part, in event of network error.	# Display one part, in event of network error.
Line 1026 sub new_handle {	Line 1153 sub new_handle {
foreach my $part (@parts) {	foreach my $part (@parts) {

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

# For each thing we're displaying...	# For each thing we're displaying...

Line 1038 sub new_handle {	Line 1166 sub new_handle {
'symb='.&Apache::lonnet::escape($curRes->symb()).	'symb='.&Apache::lonnet::escape($curRes->symb()).
'"';	'"';
my $title = $curRes->title();	my $title = $curRes->title();
	if (!$title) {
	$title = $curRes->src();
	$title = substr ($title, rindex($title, "/") + 1);
	}
my $partLabel = "";	my $partLabel = "";
my $newBranchText = "";	my $newBranchText = "";

Line 1065 sub new_handle {	Line 1197 sub new_handle {
# Display the correct icon, link to open or shut map	# Display the correct icon, link to open or shut map
if ($curRes->is_map()) {	if ($curRes->is_map()) {
my $mapId = $curRes->map_pc();	my $mapId = $curRes->map_pc();
my $nowOpen = !defined($filterHash{$mapId});	my $nowOpen = (!defined($filterHash{$mapId}));
	if ($condition) {$nowOpen = !$nowOpen;}
$icon = $nowOpen ?	$icon = $nowOpen ?
"folder_closed.gif" : "folder_opened.gif";	"navmap.folder.closed.gif" : "navmap.folder.open.gif";
$icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";	$icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
$linkopen = "<a href=\"/adm/navmaps?filter=";	$linkopen = "<a href=\"/adm/navmaps?filter=";
$linkopen .= ($nowOpen xor $condition) ?	$linkopen .= ($nowOpen xor $condition) ?
Line 1075 sub new_handle {	Line 1208 sub new_handle {
removeFromFilter(\%filterHash, $mapId);	removeFromFilter(\%filterHash, $mapId);
$linkopen .= "&condition=$condition&$queryAdd\">";	$linkopen .= "&condition=$condition&$queryAdd\">";
$linkclose = "</a>";	$linkclose = "</a>";

}	}

my $colorizer = "";	my $colorizer = "";
	my $color;
if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
my $status = $curRes->status($part);	my $status = $curRes->status($part);
my $color = $colormap{$status};	$color = $colormap{$status};

	# Special case in the navmaps: If in less then
	# 24 hours, give it a bit of urgency
	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;
	}
if ($color ne "") {	if ($color ne "") {
$colorizer = "bgcolor=\"$color\"";	$colorizer = "bgcolor=\"$color\"";
}	}
}	}

# FIRST COL: The resource indentation, branch icon, and name	if ($curRes->randomout()) {
$r->print(" <tr><td align=\"left\" valign=\"bottom\">\n");	$nonLinkedText .= ' <i>(hidden)</i> ';
	}

	$rowNum++;
	my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];

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

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

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

$r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");	$r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");

my $nonLinkedText = "";	my $curMarkerBegin = "";
	my $curMarkerEnd = "";
if ($curRes->is_problem() && $part != "0" && !$condensed) {
	# Is this the current resource?
	if ($curRes->src() eq $currenturl && !$displayedHereMarker) {
	$curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>';
	$curMarkerEnd = '<font color="red" size="+2"> <</font>';
	$displayedHereMarker = 1;
	}

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

$r->print(" <a href=\"$link\">$title$partLabel</a> $nonLinkedText");	$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");

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

my $discussionHTML = ""; my $feedbackHTML = "";	my $discussionHTML = ""; my $feedbackHTML = "";

# SECOND COL: Is there text or feedback?	# SECOND COL: Is there text, feedback, errors??
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 1135 sub new_handle {	Line 1311 sub new_handle {
}	}
}	}

$r->print("<td align=\"left\" valign=\"bottom\">$discussionHTML$feedbackHTML</td>");	$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </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?
my $firstDisplayed = !$condensed && $multipart && $part eq "0";	my $firstDisplayed = !$condensed && $multipart && $part eq "0";

# THIRD ROW: Problem status icon	# THIRD COL: Problem status icon
if ($curRes->is_problem() &&	if ($curRes->is_problem() &&
!$firstDisplayed) {	!$firstDisplayed) {
my $icon = $statusIconMap{$curRes->status($part)};	my $icon = $statusIconMap{$curRes->status($part)};
	my $alt = $iconAltTags{$icon};
if ($icon) {	if ($icon) {
$r->print("<td valign=\"bottom\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");	$r->print("<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");
} else {	} else {
$r->print("<td></td>\n");	$r->print("<td width=\"30\"> </td>\n");
}	}
} else { # not problem, no icon	} else { # not problem, no icon
$r->print("<td></td>\n");	$r->print("<td width=\"30\"> </td>\n");
}	}

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

if ($curRes->kind() eq "res" &&	if ($curRes->kind() eq "res" &&
$curRes->is_problem() &&	$curRes->is_problem() &&
!$firstDisplayed) {	!$firstDisplayed) {
	$r->print ("<font color=\"$color\"><b>") if ($color);
$r->print (getDescription($curRes, $part));	$r->print (getDescription($curRes, $part));
	$r->print ("</b></font>") if ($color);
	}
	if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
	$r->print('(randomly select ' . $curRes->randompick() .')');
}	}

$r->print("</td></tr>\n");	$r->print(" </td></tr>\n");
}	}
}	}
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
Line 1232 sub getLinkForResource {	Line 1415 sub getLinkForResource {
sub getDescription {	sub getDescription {
my $res = shift;	my $res = shift;
my $part = shift;	my $part = shift;
my $status = $res->getDateStatus();	my $status = $res->status($part);

if ($status == $res->NETWORK_FAILURE) { return ""; }	if ($status == $res->NETWORK_FAILURE) { return ""; }
if ($status == $res->NOTHING_SET) {	if ($status == $res->NOTHING_SET) {
return "Not currently assigned.";	return "Not currently assigned.";
}	}
if ($status == $res->OPEN_LATER) {	if ($status == $res->OPEN_LATER) {
return "Opens: " . timeToHumanString($res->opendate($part));	return "Open " . timeToHumanString($res->opendate($part));
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
if ($res->duedate()) {	if ($res->duedate($part)) {
return "Due: $status " . timeToHumanString($res->duedate($part));	return "Due " . timeToHumanString($res->duedate($part));
} else {	} else {
return "Open, no due date";	return "Open, no due date";
}	}
}	}
if ($status == $res->PAST_DUE_ANSWER_LATER) {	if ($status == $res->PAST_DUE_ANSWER_LATER) {
return "Answer opens: " . timeToHumanString($res->answerdate($part));	return "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 "Was due " . timeToHumanString($res->duedate($part));
}	}
if ($status == $res->ANSWER_OPEN) {	if ($status == $res->ANSWER_OPEN) {
return "Answer available";	return "Answer available";
Line 1260 sub getDescription {	Line 1443 sub getDescription {
if ($status == $res->EXCUSED) {	if ($status == $res->EXCUSED) {
return "Excused by instructor";	return "Excused by instructor";
}	}
	if ($status == $res->ATTEMPTED) {
	return "Not yet graded.";
	}
if ($status == $res->TRIES_LEFT) {	if ($status == $res->TRIES_LEFT) {
my $tries = $res->tries();	my $tries = $res->tries($part);
my $maxtries = $res->maxtries();	my $maxtries = $res->maxtries($part);
my $triesString = "($tries of $maxtries tries used)";	my $triesString = "";
	if ($tries && $maxtries) {
	$triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
	if ($maxtries > 1 && $maxtries - $tries == 1) {
	$triesString = "<b>$triesString</b>";
	}
	}
if ($res->duedate()) {	if ($res->duedate()) {
return "Due: $status " . timeToHumanString($res->duedate($part)) .	return "Due " . timeToHumanString($res->duedate($part)) .
" $triesString";	" $triesString";
} else {	} else {
return "No due date $triesString";	return "No due date $triesString";
Line 1273 sub getDescription {	Line 1465 sub getDescription {
}	}
}	}

# I want to change this into something more human-friendly. For	sub advancedUser {
# now, this is a simple call to localtime. The final function	return $ENV{'user.adv'};
# probably belongs in loncommon.	}


	# timeToHumanString takes a time number and converts it to a
	# human-readable representation, meant to be used in the following
	# manner:
	# print "Due $timestring"
	# print "Open $timestring"
	# print "Answer available $timestring"
	# Very, very, very, VERY English-only... goodness help a localizer on
	# this func...
sub timeToHumanString {	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 localtime($time);	return 'never';
} else {	}
return 'Never';
	my $now = time();

	my @time = localtime($time);
	my @now = localtime($now);

	# Positive = future
	my $delta = $time - $now;

	my $minute = 60;
	my $hour = 60 * $minute;
	my $day = 24 * $hour;
	my $week = 7 * $day;
	my $inPast = 0;

	# Logic in comments:
	# Is it now? (extremely unlikely)
	if ( $delta == 0 ) {
	return "this instant";
	}

	if ($delta < 0) {
	$inPast = 1;
	$delta = -$delta;
	}

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

	# Is it less then an hour away?
	if ( $delta < $hour ) {
	# If so, use minutes
	my $minutes = floor($delta / 60);
	if ($minutes == 1) { return "${prefix}1 minute$tense"; }
	return "$prefix$minutes minutes$tense";
	}

	# Is it less then 24 hours away? If so,
	# display hours + minutes
	if ( $delta < $hour * 24) {
	my $hours = floor($delta / $hour);
	my $minutes = floor(($delta % $hour) / $minute);
	my $hourString = "$hours hours";
	my $minuteString = ", $minutes minutes";
	if ($hours == 1) {
	$hourString = "1 hour";
	}
	if ($minutes == 1) {
	$minuteString = ", 1 minute";
	}
	if ($minutes == 0) {
	$minuteString = "";
	}
	return "$prefix$hourString$minuteString$tense";
	}

	# Less then 5 days away, display day of the week and
	# HH:MM
	if ( $delta < $day * 5 ) {
	my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
	$timeStr =~ s/12:00 am/midnight/;
	$timeStr =~ s/12:00 pm/noon/;
	return ($inPast ? "last " : "next ") .
	$timeStr;
	}

	# Is it this year?
	if ( $time[5] == $now[5]) {
	# Return on Month Day, HH:MM meridian
	my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
	$timeStr =~ s/12:00 am/midnight/;
	$timeStr =~ s/12:00 pm/noon/;
	return $timeStr;
	}

	# Not this year, so show the year
	my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
	$timeStr =~ s/12:00 am/midnight/;
	$timeStr =~ s/12:00 pm/noon/;
	return $timeStr;
}	}
}	}

Line 1290 sub timeToHumanString {	Line 1578 sub timeToHumanString {

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

# LEFT:
# * Actual handler code (multi-part)
# * Branches (aieee!) (and conditionals)

=pod	=pod

lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.	lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
Line 1310 You must obtain resource objects through	Line 1594 You must obtain resource objects through

=over 4	=over 4

=item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether 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.	=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether 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.

=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.	=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.

Line 1458 sub new {	Line 1742 sub new {
$self->{EMAIL_STATUS} = \%emailstatus;	$self->{EMAIL_STATUS} = \%emailstatus;

}	}

	$self->{PARM_CACHE} = {};

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

Line 1477 sub courseMapDefined {	Line 1763 sub courseMapDefined {
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 1579 sub finishResource {	Line 1866 sub finishResource {
sub parmval {	sub parmval {
my $self = shift;	my $self = shift;
my ($what,$symb)=@_;	my ($what,$symb)=@_;
	my $hashkey = $what."\|\|\|".$symb;

	if (defined($self->{PARM_CACHE}->{$hashkey})) {
	return $self->{PARM_CACHE}->{$hashkey};
	}

	my $result = $self->parmval_real($what, $symb);
	$self->{PARM_CACHE}->{$hashkey} = $result;
	return $result;
	}

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

my $cid=$ENV{'request.course.id'};	my $cid=$ENV{'request.course.id'};
my $csec=$ENV{'request.course.sec'};	my $csec=$ENV{'request.course.sec'};
my $uname=$ENV{'user.name'};	my $uname=$ENV{'user.name'};
Line 1686 getIterator behaves as follows:	Line 1988 getIterator behaves as follows:

=over 4	=over 4

=item B<getIterator>(nav_map, firstResource, finishResource, filterHash, condition): 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(). It is your responsibility to ensure that the iterator will actually get there. 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.	=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.

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.	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.

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:

=over 4	=over 4

=item * some list of tokens here	=item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.

	=item * END_MAP: The map is now done.

	=item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.

	=item * END_BRANCH: The branch is now done.

=back	=back

The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.	The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.

	=back

=cut	=cut

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

sub END_NAV_MAP { return 0; } # Represents end of entire nav 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 BEGIN_BRANCH { return 3; } # beginning of a branch	sub BEGIN_BRANCH { return 3; } # beginning of a branch
sub END_BRANCH { return 4; } # end of a branch	sub END_BRANCH { return 4; } # end of a branch
	sub FORWARD { return 1; } # go forward
	sub BACKWARD { return 2; }

# Params: nav map, start resource, end resource, filter, condition,	# Params: nav map, start resource, end resource, filter, condition,
# already seen hash ref	# already seen hash ref
Line 1739 sub new {	Line 2050 sub new {
$self->{ALREADY_SEEN} = shift;	$self->{ALREADY_SEEN} = shift;
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };	if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
$self->{CONDITION} = shift;	$self->{CONDITION} = shift;
	$self->{DIRECTION} = shift \|\| FORWARD();

# Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.	# Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
$self->{STARTED} = 0;	$self->{STARTED} = 0;
Line 1763 sub new {	Line 2075 sub new {
$self->{FORCE_NEXT} = undef;	$self->{FORCE_NEXT} = undef;

# Start with the first resource	# Start with the first resource
push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};	if ($self->{DIRECTION} == FORWARD) {
	push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
	} else {
	push @{$self->{BRANCH_STACK}}, $self->{FINISH_RESOURCE};
	}
$self->{BRANCH_STACK_SIZE} = 1;	$self->{BRANCH_STACK_SIZE} = 1;

bless($self);	bless($self);
Line 1778 sub next {	Line 2094 sub next {

# Iterator logic goes here	# Iterator logic goes here

# Is this return value pre-determined?
if (defined($self->{FORCE_NEXT})) {
my $tmp = $self->{FORCE_NEXT};
$self->{FORCE_NEXT} = undef;
return $tmp;
}

# Are we using a recursive iterator? If so, pull from that and	# Are we using a recursive iterator? If so, pull from that and
# watch the depth; we want to resume our level at the correct time.	# watch the depth; we want to resume our level at the correct time.
if ($self->{RECURSIVE_ITERATOR_FLAG})	if ($self->{RECURSIVE_ITERATOR_FLAG})
Line 1804 sub next {	Line 2113 sub next {
return $next;	return $next;
}	}

	# Is this return value pre-determined?
	if (defined($self->{FORCE_NEXT})) {
	my $tmp = $self->{FORCE_NEXT};
	$self->{FORCE_NEXT} = undef;
	return $tmp;
	}

# Is there a current resource to grab? If not, then return	# Is there a current resource to grab? If not, then return
# END_BRANCH and END_MAP in succession.	# END_BRANCH and END_MAP in succession.
if (scalar(@{$self->{BRANCH_STACK}}) == 0) {	if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
Line 1859 sub next {	Line 2175 sub next {
# remember that we've seen this.	# remember that we've seen this.
$self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;	$self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;

# Are we at the utter end? If so, return the END_NAV_MAP marker.
if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
$self->{FORCE_NEXT} = $self->END_NAV_MAP;
return $self->{HERE};
}

# Get the next possible resources	# Get the next possible resources
my $nextUnfiltered = $self->{HERE}->getNext();	my $nextUnfiltered;
	if ($self->{DIRECTION} == FORWARD()) {
	$nextUnfiltered = $self->{HERE}->getNext();
	} else {
	$nextUnfiltered = $self->{HERE}->getPrevious();
	}
my $next = [];	my $next = [];

# filter the next possibilities to remove things we've	# filter the next possibilities to remove things we've
Line 1892 sub next {	Line 2207 sub next {
$self->{FORCE_NEXT} = $self->END_BRANCH();	$self->{FORCE_NEXT} = $self->END_BRANCH();
$self->{BRANCH_DEPTH}--;	$self->{BRANCH_DEPTH}--;
}	}
return $self->{HERE};
}	}

while (@$next) {	while (@$next) {
Line 1914 sub next {	Line 2228 sub next {
my $firstResource = $self->{HERE}->map_start();	my $firstResource = $self->{HERE}->map_start();
my $finishResource = $self->{HERE}->map_finish();	my $finishResource = $self->{HERE}->map_finish();

# Odd perl syntax here; $self->new allows one to create a new iterator
# can't figure out how to ref this package directly correctly
# isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
$self->{RECURSIVE_ITERATOR} =	$self->{RECURSIVE_ITERATOR} =
Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,	Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
$finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},	$finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
$self->{CONDITION});	$self->{CONDITION}, $self->{DIRECTION});
}	}

return $self->{HERE};	return $self->{HERE};
Line 1947 sub populateStack {	Line 2258 sub populateStack {
my $self=shift;	my $self=shift;
my $stack = shift;	my $stack = shift;

push @$stack, $self->{HERE};	push @$stack, $self->{HERE} if ($self->{HERE});

if ($self->{RECURSIVE_ITERATOR_FLAG}) {	if ($self->{RECURSIVE_ITERATOR_FLAG}) {
$self->{RECURSIVE_ITERATOR}->populateStack($stack);	$self->{RECURSIVE_ITERATOR}->populateStack($stack);
Line 1978 resource objects have a hash called DATA	Line 2289 resource objects have a hash called DATA

=over 4	=over 4

=item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself.	=item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.

	=back

=cut	=cut

Line 2005 sub new {	Line 2318 sub new {
return $self;	return $self;
}	}

=pod

=item * B<is_map>: Returns true if this is a map, false otherwise.

=item * B<title>: Returns title.

=item * B<type>: Returns the type of the resource, "start", "normal", or "finish".

=item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)

=back

=cut

# private function: simplify the NAV_HASH lookups we keep doing	# private function: simplify the NAV_HASH lookups we keep doing
# pass the name, and to automatically append my ID, pass a true val on the	# pass the name, and to automatically append my ID, pass a true val on the
# second param	# second param
Line 2029 sub navHash {	Line 2328 sub navHash {
return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};	return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
}	}

	=pod

	B<Metadata Retreival>

	These are methods that help you retrieve metadata about the resource:

	=over 4

	=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<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<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)

	=item * B<src>: Returns the source for the resource.

	=item * B<symb>: Returns the symb for the resource.

	=item * B<title>: 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

	=cut

# These info functions can be used directly, as they don't return	# These info functions can be used directly, as they don't return
# resource information.	# resource information.
sub title { my $self=shift; return $self->navHash("title_", 1); }	sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
sub type { my $self=shift; return $self->navHash("type_", 1); }	sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
	sub from { my $self=shift; return $self->navHash("from_", 1); }
sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }	sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
# "to" can return a comma seperated list for branches
sub to { my $self=shift; return $self->navHash("to_", 1); }
sub kind { my $self=shift; return $self->navHash("kind_", 1); }	sub kind { my $self=shift; return $self->navHash("kind_", 1); }
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }	sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
	sub randompick {
	my $self = shift;
	return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
	'.0.parameter_randompick'};
	}
sub src {	sub src {
my $self=shift;	my $self=shift;
return $self->navHash("src_", 1);	return $self->navHash("src_", 1);
Line 2050 sub symb {	Line 2383 sub symb {
$self->navHash('map_id_'.$first))	$self->navHash('map_id_'.$first))
. '___' . $second . '___' . $symbSrc;	. '___' . $second . '___' . $symbSrc;
}	}
sub is_problem {	sub title { my $self=shift; return $self->navHash("title_", 1); }
	sub to { my $self=shift; return $self->navHash("to_", 1); }

	=pod

	B<Predicate Testing the Resource>

	These methods are shortcuts to deciding if a given resource has a given property.

	=over 4

	=item * B<is_map>: Returns true if the resource is a map type.

	=item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)

	=item * B<is_page>: Returns true if the resource is a page.

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

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

	=back

	=cut


	sub is_html {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
return ($src =~ /problem$/);	return ($src =~ /html$/);
}	}
sub is_html {	sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
	sub is_page {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
return ($src =~ /html$/);	return ($src =~ /page$/);
}	}
sub is_sequence {	sub is_problem {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
return ($src =~ /sequence$/);	return ($src =~ /problem$/);
}	}
sub is_page {	sub is_sequence {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
return ($src =~ /page$/);	return ($src =~ /sequence$/);
}	}





# Move this into POD: In order to use these correctly, courseopt	# Move this into POD: In order to use these correctly, courseopt
# and useropt need to be generated	# and useropt need to be generated
sub parmval {	sub parmval {
Line 2083 sub parmval {	Line 2444 sub parmval {
return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());	return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
}	}

#####	=pod
# Map Queries
#####

# These methods relate to whether or not the resource is a map, and the	B<Map Methods>
# attributes of that map.
	These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).

	=over 4

	=item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.

	=item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.

	=item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.

	=item * B<map_type>: Returns a string with the type of the map in it.

	=back

	=cut

sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
sub map_finish {	sub map_finish {
my $self = shift;	my $self = shift;
my $src = $self->src();	my $src = $self->src();
Line 2098 sub map_finish {	Line 2471 sub map_finish {
$res = $self->{NAV_MAP}->getById($res);	$res = $self->{NAV_MAP}->getById($res);
return $res;	return $res;
}	}
	sub map_pc {
	my $self = shift;
	my $src = $self->src();
	return $self->navHash("map_pc_$src", 0);
	}
sub map_start {	sub map_start {
my $self = shift;	my $self = shift;
my $src = $self->src();	my $src = $self->src();
Line 2105 sub map_start {	Line 2483 sub map_start {
$res = $self->{NAV_MAP}->getById($res);	$res = $self->{NAV_MAP}->getById($res);
return $res;	return $res;
}	}
sub map_pc {
my $self = shift;
my $src = $self->src();
return $self->navHash("map_pc_$src", 0);
}
sub map_type {	sub map_type {
my $self = shift;	my $self = shift;
my $pc = $self->map_pc();	my $pc = $self->map_pc();
Line 2132 sub map_type {	Line 2505 sub map_type {

=head2 Resource Parameters	=head2 Resource Parameters

In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter.	In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.

These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)	These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)

Line 2154 These methods are responsible for gettin	Line 2527 These methods are responsible for gettin

=item * B<tol>: Get the tolerance for the problem.	=item * B<tol>: Get the tolerance for the problem.

	=item * B<tries>: Get the number of tries the user has already used on the problem.

=item * B<type>: Get the question type for the problem.	=item * B<type>: Get the question type for the problem.

=item * B<weight>: Get the weight for the problem.	=item * B<weight>: Get the weight for the problem.
Line 2199 sub tol {	Line 2574 sub tol {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
return $self->parmval("tol", $part);	return $self->parmval("tol", $part);
}	}
sub type {
(my $self, my $part) = @_;
return $self->parmval("type", $part);
}
sub weight {
(my $self, my $part) = @_;
return $self->parmval("weight", $part);
}
sub tries {	sub tries {
my $self = shift;	my $self = shift;
my $part = shift;	my $part = shift;
Line 2219 sub tries {	Line 2586 sub tries {
if (!defined($tries)) {return '0';}	if (!defined($tries)) {return '0';}
return $tries;	return $tries;
}	}
	sub type {
	(my $self, my $part) = @_;
	return $self->parmval("type", $part);
	}
	sub weight {
	(my $self, my $part) = @_;
	return $self->parmval("weight", $part);
	}

# Multiple things need this	# Multiple things need this
sub getReturnHash {	sub getReturnHash {
my $self = shift;	my $self = shift;

if (!defined($self->{RETURN_HASH})) {	if (!defined($self->{RETURN_HASH})) {
my %tmpHash = &Apache::lonnet::restore($self->symb());	my %tmpHash = &Apache::lonnet::restore($self->symb());
$self->{RETURN_HASH} = \%tmpHash;	$self->{RETURN_HASH} = \%tmpHash;
}	}
}	}
Line 2271 sub hasDiscussion {	Line 2646 sub hasDiscussion {

sub getFeedback {	sub getFeedback {
my $self = shift;	my $self = shift;
return $self->{NAV_MAP}->getFeedback($self->symb());	return $self->{NAV_MAP}->getFeedback($self->src());
}	}

=pod	=pod

=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)	=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)

=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.	=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.

=back	=back

Line 2316 sub extractParts {	Line 2691 sub extractParts {

$self->{PARTS} = [];	$self->{PARTS} = [];

# Retrieve part count	# Retrieve part count, if this is a problem
my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');	if ($self->is_problem()) {
if (!$metadata) {	my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
$self->{RESOURCE_ERROR} = 1;	if (!$metadata) {
$self->{PARTS} = [];	$self->{RESOURCE_ERROR} = 1;
return;	$self->{PARTS} = [];
}	return;
	}
foreach (split(/\,/,$metadata)) {
if ($_ =~ /^parameter\_(.*)\_opendate$/) {	foreach (split(/\,/,$metadata)) {
push @{$self->{PARTS}}, $1;	if ($_ =~ /^parameter\_(.*)\_opendate$/) {
	push @{$self->{PARTS}}, $1;
	}
}	}


	# Is this possible to do in one line? - Jeremy
	my @sortedParts = sort @{$self->{PARTS}};
	$self->{PARTS} = \@sortedParts;
}	}


# Is this possible to do in one line? - Jeremy
my @sortedParts = sort @{$self->{PARTS}};
$self->{PARTS} = \@sortedParts;

return;	return;
}	}

Line 2352 Idiomatic usage of these two methods wou	Line 2729 Idiomatic usage of these two methods wou
my $dateStatus = $resource->getDateStatus($_);	my $dateStatus = $resource->getDateStatus($_);
my $completionStatus = $resource->getCompletionStatus($_);	my $completionStatus = $resource->getCompletionStatus($_);

	or

	my $status = $resource->status($_);

... use it here ...	... use it here ...
}	}

=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. You should still check to see if there is a due date at all, if you care about that. 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:

=back	=back

Line 2452 B<Completion Codes>	Line 2833 B<Completion Codes>

=item * B<NETWORK_FAILURE>: Information not available due to network failure.	=item * B<NETWORK_FAILURE>: Information not available due to network failure.

	=item * B<ATTEMPTED>: Attempted, and not yet graded.

=back	=back

=cut	=cut
Line 2462 sub INCORRECT_BY_OVERRIDE { return 12; }	Line 2845 sub INCORRECT_BY_OVERRIDE { return 12; }
sub CORRECT { return 13; }	sub CORRECT { return 13; }
sub CORRECT_BY_OVERRIDE { return 14; }	sub CORRECT_BY_OVERRIDE { return 14; }
sub EXCUSED { return 15; }	sub EXCUSED { return 15; }
	sub ATTEMPTED { return 16; }

sub getCompletionStatus {	sub getCompletionStatus {
my $self = shift;	my $self = shift;
Line 2480 sub getCompletionStatus {	Line 2864 sub getCompletionStatus {
if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }	if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }	if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
if ($status eq 'excused') {return $self->EXCUSED; }	if ($status eq 'excused') {return $self->EXCUSED; }
	if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
return $self->NOT_ATTEMPTED;	return $self->NOT_ATTEMPTED;
}	}

Line 2491 Along with directly returning the date o	Line 2876 Along with directly returning the date o

=over 4	=over 4

=item * NETWORK_FAILURE: The network has failed and the information is not available.	=item * B<NETWORK_FAILURE>: The network has failed and the information is not available.

	=item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)

=item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)	=item * B<CORRECT>: For any reason at all, the part is considered correct.

=item * CORRECT: For any reason at all, the part is considered correct.	=item * B<EXCUSED>: For any reason at all, the problem is excused.

=item * EXCUSED: For any reason at all, the problem is excused.	=item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.

=item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.	=item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.

=item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.	=item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.

=item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.	=item * B<OPEN_LATER>: The problem is not yet open.

=item * OPEN_LATER: The problem is not yet open.	=item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.

=item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.	=item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.

=item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.	=item * B<OPEN>: The item is open and not yet tried.

=item * OPEN: The item is open and not yet tried.	=item * B<ATTEMPTED>: The problem has been attempted.

=back	=back

Line 2535 sub status {	Line 2922 sub status {
# There are a few whole rows we can dispose of:	# There are a few whole rows we can dispose of:
if ($completionStatus == CORRECT \|\|	if ($completionStatus == CORRECT \|\|
$completionStatus == CORRECT_BY_OVERRIDE ) {	$completionStatus == CORRECT_BY_OVERRIDE ) {
return CORRECT();	return CORRECT;
	}

	if ($completionStatus == ATTEMPTED) {
	return ATTEMPTED;
}	}

# If it's EXCUSED, then return that no matter what	# If it's EXCUSED, then return that no matter what
Line 2547 sub status {	Line 2938 sub status {
return NOTHING_SET;	return NOTHING_SET;
}	}

# Now we're down to a 3 (incorrect, incorrect_override, not_attempted)	# Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
# by 4 matrix (date status).	# by 4 matrix (date statuses).

if ($dateStatus == PAST_DUE_ANSWER_LATER \|\|	if ($dateStatus == PAST_DUE_ANSWER_LATER \|\|
$dateStatus == PAST_DUE_NO_ANSWER ) {	$dateStatus == PAST_DUE_NO_ANSWER ) {
Line 2569 sub status {	Line 2960 sub status {
# If it's WRONG...	# If it's WRONG...
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() < $self->maxtries()) {	if ($self->tries($part) < $self->maxtries($part) \|\| !$self->maxtries($part)) {
return TRIES_LEFT;	return TRIES_LEFT;
}	}
return INCORRECT; # otherwise, return orange; student can't fix this	return INCORRECT; # otherwise, return orange; student can't fix this
Line 2585 sub status {	Line 2976 sub status {

=over 4	=over 4

=item * B<getNext>(): Gets the next resource in the navmap after this one.	=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.

=cut	=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.

# For the simple single-link case, to get from a resource to the next	=cut
# resource, you need to look up the "to_" link in the nav hash, then
# follow that with the "goesto_" link.

sub getNext {	sub getNext {
my $self = shift;	my $self = shift;
my $alreadySeenHash = 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) ) {
my $choice = $self->{NAV_MAP}->getById($branch);	my $choice = $self->{NAV_MAP}->getById($branch);
my $next = $choice->goesto();	my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);	$next = $self->{NAV_MAP}->getById($next);
Line 2614 sub getNext {	Line 3003 sub getNext {
}	}
return \@branches;	return \@branches;
}	}

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

	# Skip it if we've already seen it or the user doesn't have
	# 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;
	}

=pod	=pod

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

Removed from v.1.67
changed lines
	Added in v.1.91