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.56 and 1.72

version 1.56, 2002/09/30 16:45:01	version 1.72, 2002/10/11 14:56:43
Line 1	Line 1

# The LearningOnline Network with CAPA	# The LearningOnline Network with CAPA
# Navigate Maps Handler	# Navigate Maps Handler
#	#
Line 124 sub parmval {	Line 125 sub parmval {
my $courselevelm=$usercourseprefix.'.'.$mapparm;	my $courselevelm=$usercourseprefix.'.'.$mapparm;

# ---------------------------------------------------------- first, check user	# ---------------------------------------------------------- first, check user
if ($uname) {	if (defined($uname)) {
if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }	if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }	if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
if ($useropt{$courselevel}) { return $useropt{$courselevel}; }	if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
}	}

# ------------------------------------------------------- second, check course	# ------------------------------------------------------- second, check course
if ($csec) {	if (defined($csec)) {
if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }	if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }	if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }	if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
}	}

if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }	if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }	if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }	if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; }

# ----------------------------------------------------- third, check map parms	# ----------------------------------------------------- third, check map parms

my $thisparm=$parmhash{$symbparm};	my $thisparm=$parmhash{$symbparm};
if ($thisparm) { return $thisparm; }	if (defined($thisparm)) { return $thisparm; }

# ----------------------------------------------------- fourth , check default	# ----------------------------------------------------- fourth , check default

my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');	my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
if ($default) { return $default}	if (defined($default)) { return $default}

# --------------------------------------------------- fifth , cascade up parts	# --------------------------------------------------- fifth , cascade up parts

Line 159 sub parmval {	Line 160 sub parmval {
my ($part,$id)=split(/\_/,$space);	my ($part,$id)=split(/\_/,$space);
if ($id) {	if ($id) {
my $partgeneral=&parmval($part.".$qualifier",$symb);	my $partgeneral=&parmval($part.".$qualifier",$symb);
if ($partgeneral) { return $partgeneral; }	if (defined($partgeneral)) { return $partgeneral; }
} else {	} else {
my $resourcegeneral=&parmval("0.$qualifier",$symb);	my $resourcegeneral=&parmval("0.$qualifier",$symb);
if ($resourcegeneral) { return $resourcegeneral; }	if (defined($resourcegeneral)) { return $resourcegeneral; }
}	}
}	}
return '';	return '';
Line 819 sub new_handle {	Line 820 sub new_handle {
&Apache::loncommon::no_cache($r);	&Apache::loncommon::no_cache($r);
$r->send_http_header;	$r->send_http_header;

# Header
$r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
''));
# 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",
Line 834 sub new_handle {	Line 832 sub new_handle {
return HTTP_NOT_ACCEPTABLE;	return HTTP_NOT_ACCEPTABLE;
}	}

	# Header
	$r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
	''));
	$r->print('<script>window.focus();</script>');
	my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
	if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
	my $date=localtime;
	$r->print("<h3>$date</h3>\n");
	$r->rflush();
	if ($navmap->{LAST_CHECK}) {
	$r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
	timeToHumanString($navmap->{LAST_CHECK}).
	'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
	} else {
	$r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
	'<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())) {
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .	$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
Line 848 sub new_handle {	Line 868 sub new_handle {
# Defines a status->color mapping, null string means don't color	# Defines a status->color mapping, null string means don't color
my %colormap =	my %colormap =
( $res->NETWORK_FAILURE => '',	( $res->NETWORK_FAILURE => '',
$res->CORRECT => '#BBFFBB',	$res->CORRECT => '',
$res->EXCUSED => '#BBBBFF',	$res->EXCUSED => '#BBBBFF',
$res->PAST_DUE_ANSWER_LATER => '#FFAA00',	$res->PAST_DUE_ANSWER_LATER => '',
$res->PAST_DUE_NO_ANSWER => '#FFAA00',	$res->PAST_DUE_NO_ANSWER => '',
$res->ANSWER_OPEN => '#FF00AA',	$res->ANSWER_OPEN => '#CCFFCC',
$res->OPEN_LATER => '',	$res->OPEN_LATER => '',
$res->TRIES_LEFT => '#FFFF00',	$res->TRIES_LEFT => '',
$res->INCORRECT => '#FFAA00',	$res->INCORRECT => '',
$res->OPEN => '#FFFF88',	$res->OPEN => '',
$res->NOTHING_SET => '' );	$res->NOTHING_SET => '' );
	# 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
	my $hurryUpColor = "#FFCCCC";

	my %statusIconMap =
	( $res->NETWORK_FAILURE => '',
	$res->NOTHING_SET => '',
	$res->CORRECT => 'navmap.correct.gif',
	$res->EXCUSED => 'navmap.correct.gif',
	$res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
	$res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
	$res->ANSWER_OPEN => 'navmap.wrong.gif',
	$res->OPEN_LATER => '',
	$res->TRIES_LEFT => 'navmap.open.gif',
	$res->INCORRECT => 'navmap.wrong.gif',
	$res->OPEN => 'navmap.open.gif',
	$res->ATTEMPTED => '' );

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

	my %condenseStatuses =
	( $res->NETWORK_FAILURE => 1,
	$res->NOTHING_SET => 1,
	$res->CORRECT => 1 );

my %filterHash;	my %filterHash;
# Figure out what we're not displaying	# Figure out what we're not displaying
Line 867 sub new_handle {	Line 914 sub new_handle {
}	}
}	}

	my $currenturl = $ENV{'form.postdata'};
	$currenturl=~s/^http\:\/\///;
	$currenturl=~s/^[^\/]+//;
	my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);

	$r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');

# Begin the HTML table	# Begin the HTML table
# two columns: the title/icon on the left, the info on the right	# four cols: resource + indent, chat+feedback, icon, text string
$r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");	$r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");

my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);	my $condition = 0;
my $curRes = $mapIterator->next();	if ($ENV{'form.condition'}) {
	$condition = 1;
	}

	my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);
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 = "        ";	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 $in24Hours = $now + 24 * 60 * 60;
	my $depth = 1;

while ($curRes != $mapIterator->END_NAV_MAP) {	# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
	# code in iterator->next), so ignore the first one
	$mapIterator->next();
	my $curRes = $mapIterator->next();

	while ($depth > 0) {
if ($curRes == $mapIterator->BEGIN_MAP() \|\|	if ($curRes == $mapIterator->BEGIN_MAP() \|\|
$curRes == $mapIterator->BEGIN_BRANCH()) {	$curRes == $mapIterator->BEGIN_BRANCH()) {
$indentLevel++;	$indentLevel++;
Line 891 sub new_handle {	Line 957 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--;
	}

	# 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()) {

my @parts;	# Step one: Decide which parts to show
	my @parts = @{$curRes->parts()};
	my $multipart = scalar(@parts) > 1;
	my $condensed = 0;

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

	# Now, we decide whether to condense the
	# parts due to similarity
	my $status = $curRes->status($parts[1]);
	my $due = $curRes->duedate($parts[1]);
	my $open = $curRes->opendate($parts[1]);
	my $statusAllSame = 1;
	my $dueAllSame = 1;
	my $openAllSame = 1;
	for (my $i = 2; $i < scalar(@parts); $i++) {
	if ($curRes->status($parts[$i]) != $status){
	$statusAllSame = 0;
	}
	if ($curRes->duedate($parts[$i]) != $due ) {
	$dueAllSame = 0;
	}
	if ($curRes->opendate($parts[$i]) != $open) {
	$openAllSame = 0;
	}
	}

	# $allSame is true if all the statuses were
	# the same. Now, if they are all the same and
	# match one of the statuses to condense, or they
	# are all open with the same due date, or they are
	# all OPEN_LATER with the same open date, display the
	# status of the first non-zero part (to get the 'correct'
	# status right, since 0 is never 'correct' or 'open').
	if (($statusAllSame && defined($condenseStatuses{$status})) \|\|
	($dueAllSame && $status == $curRes->OPEN && $statusAllSame)\|\|
	($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
	@parts = ($parts[1]);
	$condensed = 1;
	}
	}
	}
	}

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

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

	# Step two: Show the parts
foreach my $part (@parts) {	foreach my $part (@parts) {

	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 923 sub new_handle {	Line 1069 sub new_handle {
# If this is a new branch, label it so	# If this is a new branch, label it so
# (temporary, this should be an icon w/ alt text)	# (temporary, this should be an icon w/ alt text)
if ($isNewBranch) {	if ($isNewBranch) {
$newBranchText = "NB -> ";	$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
$isNewBranch = 0;	$isNewBranch = 0;
	$deltalevel = 1;
}	}

# links to open and close the folders	# links to open and close the folders
my $linkopen = "<a href=\"$link\">";	my $linkopen = "<a href=\"$link\">";
my $linkclose = "</a>";	my $linkclose = "</a>";

my $icon = "html.gif";	my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
$icon = "problem.gif";	if ($part eq "0" \|\| $condensed) {
	$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';
	} else {
	$icon = $indentString;
	}
}	}

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

}	}

my $colorizer = "";	my $colorizer = "";
Line 960 sub new_handle {	Line 1112 sub new_handle {
}	}
}	}

$r->print(" <tr><td align=\"left\" valign=\"top\">\n");	if ($curRes->randomout()) {
	$nonLinkedText .= ' <i>(hidden)</i> ';
	}

	# FIRST COL: The resource indentation, branch icon, and name
	$r->print(" <tr><td align=\"left\" valign=\"bottom\">\n");

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

$r->print(" ${newBranchText}${linkopen}<img border=\"0\" src=\"" .	$r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");
"/adm/lonIcons/$icon\" alt=\"\">${linkclose}\n");
	if ($curRes->is_problem() && $part ne "0" && !$condensed) {
	$partLabel = " (Part $part)";
	$title = "";
	}
	if ($multipart && $condensed) {
	$nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
	}

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

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

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

	# SECOND COL: Is there text or feedback?
	if ($curRes->hasDiscussion()) {
	$discussionHTML = $linkopen .
	'<img border="0" src="/adm/lonMisc/chat.gif" />' .
	$linkclose;
	}

	if ($curRes->getFeedback()) {
	my $feedback = $curRes->getFeedback();
	foreach (split(/\,/, $feedback)) {
	if ($_) {
	$feedbackHTML .= ' <a href="/adm/email?display='
	. &Apache::lonnet::escape($_) . '">'
	. '<img src="/adm/lonMisc/feedback.gif" '
	. 'border="0" /></a>';
	}
	}
	}

	$r->print("<td align=\"left\" valign=\"bottom\">$discussionHTML$feedbackHTML</td>");

if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }	# Is this the first displayed part of a multi-part problem
	# that has not been condensed, so we should suppress these two
	# columns?
	my $firstDisplayed = !$condensed && $multipart && $part eq "0";

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

$r->print(" <a href=\"$link\">$title$partLabel</a></td>".	# FOURTH COL: Text description
"<td $colorizer align=\"right\">\n");	$r->print("<td $colorizer align=\"right\" valign=\"bottom\">\n");

if ($curRes->kind() eq "res" and	if ($curRes->kind() eq "res" &&
$curRes->is_problem() ) {	$curRes->is_problem() &&
	!$firstDisplayed) {
$r->print (getDescription($curRes, $part));	$r->print (getDescription($curRes, $part));
}	}
	if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
	$r->print('(randomly select ' . $curRes->randompick() .')');
	}

	$r->print("</td></tr>\n");
}	}
}	}
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
Line 986 sub new_handle {	Line 1203 sub new_handle {

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

	$navmap->untieHashes();

return OK;	return OK;
}	}

Line 1044 sub getLinkForResource {	Line 1263 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) {
Line 1054 sub getDescription {	Line 1273 sub getDescription {
return "Opens: " . timeToHumanString($res->opendate($part));	return "Opens: " . timeToHumanString($res->opendate($part));
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
return "Due: $status " . timeToHumanString($res->duedate($part));	if ($res->duedate()) {
	return "Due: $status " . timeToHumanString($res->duedate($part));
	} else {
	return "Open, no due date";
	}
}	}
if ($status == $res->PAST_DUE_ANSWER_LATER) {	if ($status == $res->PAST_DUE_ANSWER_LATER) {
return "Answer: " . timeToHumanString($res->answerdate($part));	return "Answer opens: " . 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));
Line 1065 sub getDescription {	Line 1288 sub getDescription {
if ($status == $res->ANSWER_OPEN) {	if ($status == $res->ANSWER_OPEN) {
return "Answer available";	return "Answer available";
}	}
	if ($status == $res->EXCUSED) {
	return "Excused by instructor";
	}
	if ($status == $res->ATTEMPTED) {
	return "Not yet graded.";
	}
	if ($status == $res->TRIES_LEFT) {
	my $tries = $res->tries();
	my $maxtries = $res->maxtries();
	my $triesString = "($tries of $maxtries tries used)";
	if ($res->duedate()) {
	return "Due: $status " . timeToHumanString($res->duedate($part)) .
	" $triesString";
	} else {
	return "No due date $triesString";
	}
	}
	}

	sub advancedUser {
	return $ENV{'user.adv'};
}	}

# I want to change this into something more human-friendly. For	# I want to change this into something more human-friendly. For
# now, this is a simple call to localtime. The final function	# now, this is a simple call to localtime. The final function
# probably belongs in loncommon.	# probably belongs in loncommon.
sub timeToHumanString {	sub timeToHumanString {
return localtime(shift);	my ($time) = @_;
	# zero, '0' and blank are bad times
	if ($time) {
	return localtime($time);
	} else {
	return 'Never';
	}
}	}

1;	1;

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 1098 You must obtain resource objects through	Line 1344 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 1138 sub new {	Line 1384 sub new {
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},	if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
&GDBM_READER(), 0640)))	&GDBM_READER(), 0640)))
{	{
	untie $self->{PARM_HASH};
return undef;	return undef;
}	}
$self->{PARM_HASH} = \%parmhash;	$self->{PARM_HASH} = \%parmhash;
Line 1264 sub courseMapDefined {	Line 1511 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, shift);	shift, undef, shift);
return $iterator;	return $iterator;
}	}

# unties the hash when done	# unties the hash when done
sub untieHashes {	sub untieHashes {
my $self = shift;	my $self = shift;
untie $self->{NAV_HASH} if ($self->{HASH_TIED});	untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
untie $self->{PARM_HASH} if ($self->{HASH_TIED});	untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
$self->{HASH_TIED} = 0;	$self->{HASH_TIED} = 0;
}	}

Line 1282 sub DESTROY {	Line 1529 sub DESTROY {
$self->untieHashes();	$self->untieHashes();
}	}

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

	return $self->{DISCUSSION_TIME}->{$symb} >
	$self->{LAST_CHECK};
	}

	# Private function: Does the given resource (as a symb string) have
	# current feedback? Returns the string in the feedback hash, which
	# will be false if it does not exist.
	sub getFeedback {
	my $self = shift;
	my $symb = shift;

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

	return $self->{FEEDBACK}->{$symb};
	}

=pod	=pod

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

# ---------------------------------------------------------- first, check user	# ---------------------------------------------------------- first, check user
if ($uname and defined($useropt)) {	if ($uname and defined($useropt)) {
if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; }	if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; }	if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; }	if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
}	}

# ------------------------------------------------------- second, check course	# ------------------------------------------------------- second, check course
if ($csec and defined($courseopt)) {	if ($csec and defined($courseopt)) {
if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; }	if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; }	if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; }	if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
}	}

if (defined($courseopt)) {	if (defined($courseopt)) {
if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; }	if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; }	if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; }	if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
}	}

# ----------------------------------------------------- third, check map parms	# ----------------------------------------------------- third, check map parms

my $thisparm=$$parmhash{$symbparm};	my $thisparm=$$parmhash{$symbparm};
if ($thisparm) { return $thisparm; }	if (defined($thisparm)) { return $thisparm; }

# ----------------------------------------------------- fourth , check default	# ----------------------------------------------------- fourth , check default

my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');	my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
if ($default) { return $default}	if (defined($default)) { return $default}

# --------------------------------------------------- fifth , cascade up parts	# --------------------------------------------------- fifth , cascade up parts

Line 1412 sub parmval {	Line 1682 sub parmval {
my ($part,$id)=split(/\_/,$space);	my ($part,$id)=split(/\_/,$space);
if ($id) {	if ($id) {
my $partgeneral=$self->parmval($part.".$qualifier",$symb);	my $partgeneral=$self->parmval($part.".$qualifier",$symb);
if ($partgeneral) { return $partgeneral; }	if (defined($partgeneral)) { return $partgeneral; }
} else {	} else {
my $resourcegeneral=$self->parmval("0.$qualifier",$symb);	my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
if ($resourcegeneral) { return $resourcegeneral; }	if (defined($resourcegeneral)) { return $resourcegeneral; }
}	}
}	}
return '';	return '';
Line 1450 getIterator behaves as follows:	Line 1720 getIterator behaves as follows:

=over 4	=over 4

=item B<getIterator>(nav_map, firstResource, finishResource, filterHash): 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 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0.	=item B<getIterator>(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(). 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.

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
Line 1502 sub new {	Line 1779 sub new {
# A hash, used as a set, of resource already seen	# A hash, used as a set, of resource already seen
$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;

# 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 1541 sub next {	Line 1819 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 1567 sub next {	Line 1838 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 1622 sub next {	Line 1900 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 = $self->{HERE}->getNext();
my $next = [];	my $next = [];
Line 1655 sub next {	Line 1927 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 1672 sub next {	Line 1943 sub next {

# If this is a map and we want to recurse down it... (not filtered out)	# If this is a map and we want to recurse down it... (not filtered out)
if ($self->{HERE}->is_map() &&	if ($self->{HERE}->is_map() &&
!defined($self->{FILTER}->{$self->{HERE}->map_pc()})) {	(defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
$self->{RECURSIVE_ITERATOR_FLAG} = 1;	$self->{RECURSIVE_ITERATOR_FLAG} = 1;
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},
# prime the new iterator with the first resource	$self->{CONDITION});
#push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource;
}	}

return $self->{HERE};	return $self->{HERE};
Line 1742 resource objects have a hash called DATA	Line 2009 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 1757 sub new {	Line 2026 sub new {

# Store this new resource in the parent nav map's cache.	# Store this new resource in the parent nav map's cache.
$self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;	$self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
	$self->{RESOURCE_ERROR} = 0;

# A hash that can be used by two-pass algorithms to store data	# A hash that can be used by two-pass algorithms to store data
# about this resource in. Not used by the resource object	# about this resource in. Not used by the resource object
Line 1768 sub new {	Line 2038 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 1792 sub navHash {	Line 2048 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.)

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

	=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 ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
sub type { my $self=shift; return $self->navHash("type_", 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 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 1812 sub symb {	Line 2103 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); }
	sub type { my $self=shift; return $self->navHash("type_", 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 1845 sub parmval {	Line 2165 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 1860 sub map_finish {	Line 2192 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 1867 sub map_start {	Line 2204 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 1894 sub map_type {	Line 2226 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 1916 These methods are responsible for gettin	Line 2248 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 1961 sub tol {	Line 2295 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 1981 sub tries {	Line 2307 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 {
Line 2014 Misc. functions for the resource.	Line 2348 Misc. functions for the resource.

=over 4	=over 4

=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<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.

	=item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:

	for (split(/\,/, $res->getFeedback())) {
	my $link = &Apache::lonnet::escape($_);
	...

	and use the link as appropriate.

	=cut

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

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

	=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. 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 2025 Misc. functions for the resource.	Line 2383 Misc. functions for the resource.
sub parts {	sub parts {
my $self = shift;	my $self = shift;

	if ($self->ext) { return ['0']; }

$self->extractParts();	$self->extractParts();
return $self->{PARTS};	return $self->{PARTS};
}	}
Line 2033 sub countParts {	Line 2393 sub countParts {
my $self = shift;	my $self = shift;

my $parts = $self->parts();	my $parts = $self->parts();

if (scalar(@{$parts}) == 1) { return 1;}	if ($self->{RESOURCE_ERROR}) {
	return 0;
	}

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

return scalar(@{$parts}) - 1;	return scalar(@{$parts}) - 1;
}	}
Line 2044 sub extractParts {	Line 2408 sub extractParts {
my $self = shift;	my $self = shift;

return if ($self->{PARTS});	return if ($self->{PARTS});
	return if ($self->ext);

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

# Retrieve part count	# Retrieve part count
foreach (split(/\,/,&Apache::lonnet::metadata($self->src(),	my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
'allpossiblekeys'))) {	if (!$metadata) {
	$self->{RESOURCE_ERROR} = 1;
	$self->{PARTS} = [];
	return;
	}

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


# Is this possible to do in one line? - Jeremy	# Is this possible to do in one line? - Jeremy
my @sortedParts = sort @{$self->{PARTS}};	my @sortedParts = sort @{$self->{PARTS}};
Line 2076 Idiomatic usage of these two methods wou	Line 2448 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, with the following possible results:	=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 2093 B<Date Codes>	Line 2469 B<Date Codes>

=item * B<OPEN>: Open and not yet due.	=item * B<OPEN>: Open and not yet due.


=item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.	=item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.

=item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.	=item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
Line 2140 sub getDateStatus {	Line 2517 sub getDateStatus {
# should this be the same as "open later"? think multipart.	# should this be the same as "open later"? think multipart.
return $self->NOTHING_SET;	return $self->NOTHING_SET;
}	}
if (!$open \|\| $now < $open) {return $self->OPEN_LATER};	if (!$open \|\| $now < $open) {return $self->OPEN_LATER}
if (!$due \|\| $now < $due) {return $self->OPEN};	if (!$due \|\| $now < $due) {return $self->OPEN}
if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER};	if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
if ($answer) { return $self->ANSWER_OPEN; };	if ($answer) { return $self->ANSWER_OPEN; }
return PAST_DUE_NO_ANSWER;	return PAST_DUE_NO_ANSWER;
}	}

Line 2175 B<Completion Codes>	Line 2552 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 2185 sub INCORRECT_BY_OVERRIDE { return 12; }	Line 2564 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 2203 sub getCompletionStatus {	Line 2583 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 2214 Along with directly returning the date o	Line 2595 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 * 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.)	=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 * CORRECT: For any reason at all, the part is considered correct.	=item * B<CORRECT>: For any reason at all, the part is considered correct.

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

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

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

=item * OPEN_LATER: The problem is not yet open.	=item * B<OPEN_LATER>: The problem is not yet open.

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

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

=item * OPEN: The item is open and not yet tried.	=item * B<OPEN>: The item is open and not yet tried.

	=item * B<ATTEMPTED>: The problem has been attempted.

=back	=back

Line 2258 sub status {	Line 2641 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 2270 sub status {	Line 2657 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 ) {
return $dateStatus;	return $dateStatus;
}	}

Line 2326 sub getNext {	Line 2713 sub getNext {
my $next = $choice->goesto();	my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);	$next = $self->{NAV_MAP}->getById($next);

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

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

Removed from v.1.56
changed lines
	Added in v.1.72