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.437 and 1.517

version 1.437, 2009/10/26 10:16:56	version 1.517, 2016/03/17 13:20:35
Line 2	Line 2
# Navigate Maps Handler	# Navigate Maps Handler
#	#
# $Id$	# $Id$

#	#
# Copyright Michigan State University Board of Trustees	# Copyright Michigan State University Board of Trustees
#	#
Line 49 described at http://www.lon-capa.org.	Line 48 described at http://www.lon-capa.org.

=head1 OVERVIEW	=head1 OVERVIEW

X<lonnavmaps, overview When a user enters a course, LON-CAPA examines the	X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
course structure and caches it in what is often referred to as the	course structure and caches it in what is often referred to as the
"big hash" X<big hash>. You can see it if you are logged into	"big hash" X<big hash>. You can see it if you are logged into
LON-CAPA, in a course, by going to /adm/test. (You may need to	LON-CAPA, in a course, by going to /adm/test. (You may need to
Line 164 If true, the resource's folder will not	Line 163 If true, the resource's folder will not
it. Default is false. True implies printCloseAll is false, since you	it. Default is false. True implies printCloseAll is false, since you
can't close or open folders when this is on anyhow.	can't close or open folders when this is on anyhow.

	=item * B<map_no_edit_link>:

	If true, the title of the folder or page will not be followed by an
	icon/link to direct editing of a folder or composite page, originally
	added via the Course Editor.

=back	=back

=item * B<Apache::lonnavmaps::communication_status>:	=item * B<Apache::lonnavmaps::communication_status>:
Line 464 returns 4	Line 469 returns 4

=item add_linkitem()	=item add_linkitem()

=item show_linkitems()	=item show_linkitems_toolbar()

=back	=back

Line 478 use Apache::loncommon();	Line 483 use Apache::loncommon();
use Apache::lonenc();	use Apache::lonenc();
use Apache::lonlocal;	use Apache::lonlocal;
use Apache::lonnet;	use Apache::lonnet;
	use Apache::lonmap;

use POSIX qw (floor strftime);	use POSIX qw (floor strftime);
use Time::HiRes qw( gettimeofday tv_interval );	use Time::HiRes qw( gettimeofday tv_interval );
use LONCAPA;	use LONCAPA;
use DateTime();	use DateTime();
	use HTML::Entities;

	# For debugging

	#use Data::Dumper;


# symbolic constants	# symbolic constants
sub SYMB { return 1; }	sub SYMB { return 1; }
Line 492 sub NOTHING { return 3; }	Line 505 sub NOTHING { return 3; }

my $resObj = "Apache::lonnavmaps::resource";	my $resObj = "Apache::lonnavmaps::resource";

# Keep these mappings in sync with lonquickgrades, which uses the colors	# Keep these mappings in sync with lonquickgrades, which usesthe colors
# instead of the icons.	# instead of the icons.
my %statusIconMap =	my %statusIconMap =
(	(
Line 505 my %statusIconMap =	Line 518 my %statusIconMap =
$resObj->ERROR => ''	$resObj->ERROR => ''
);	);

my %iconAltTags =	my %iconAltTags = #texthash does not work here
( 'navmap.correct.gif' => 'Correct',	( 'navmap.correct.gif' => 'Correct',
'navmap.wrong.gif' => 'Incorrect',	'navmap.wrong.gif' => 'Incorrect',
'navmap.open.gif' => 'Open' );	'navmap.open.gif' => 'Is Open',
	'navmap.partial.gif' => 'Partially Correct',
	'navmap.ellipsis.gif' => 'Attempted',
	);

# 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 =
Line 524 my %colormap =	Line 540 my %colormap =
$resObj->OPEN => '',	$resObj->OPEN => '',
$resObj->NOTHING_SET => '',	$resObj->NOTHING_SET => '',
$resObj->ATTEMPTED => '',	$resObj->ATTEMPTED => '',
	$resObj->CREDIT_ATTEMPTED => '',
$resObj->ANSWER_SUBMITTED => '',	$resObj->ANSWER_SUBMITTED => '',
$resObj->PARTIALLY_CORRECT => '#006600'	$resObj->PARTIALLY_CORRECT => '#006600'
);	);
Line 531 my %colormap =	Line 548 my %colormap =
# is not yet done and due in less than 24 hours	# is not yet done and due in less than 24 hours
my $hurryUpColor = "#FF0000";	my $hurryUpColor = "#FF0000";

my $future_slots_checked = 0;
my $future_slots = 0;

sub close {
if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
return(<<ENDCLOSE);
<script type="text/javascript">
window.status='Accessing Nav Control';
menu=window.open("/adm/rat/empty.html","loncapanav",
"height=600,width=400,scrollbars=1");
window.status='Closing Nav Control';
menu.close();
window.status='Done.';
</script>
ENDCLOSE
}

sub update {
if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
if (!$env{'request.course.id'}) { return ''; }
if ($ENV{'REQUEST_URI'}=~m\|^/adm/navmaps\|) { return ''; }
return(<<ENDUPDATE);
<form name="navform"></form>
<script type="text/javascript">
this.document.navform.action='/adm/navmaps#curloc';
this.document.navform.target='loncapanav';
this.document.navform.submit();
</script>
ENDUPDATE
}


sub addToFilter {	sub addToFilter {
my $hashIn = shift;	my $hashIn = shift;
my $addition = shift;	my $addition = shift;
Line 633 sub getDescription {	Line 618 sub getDescription {
return &mt("Having technical difficulties; please check status later");	return &mt("Having technical difficulties; please check status later");
}	}
if ($status == $res->NOTHING_SET) {	if ($status == $res->NOTHING_SET) {
return &mt("Not currently assigned.");	return &Apache::lonhtmlcommon::direct_parm_link(&mt('Not currently assigned'),$res->symb(),'opendate',$part);
}	}
if ($status == $res->OPEN_LATER) {	if ($status == $res->OPEN_LATER) {
return &mt("Open ") .timeToHumanString($open,'start');	return &mt("Open [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($open,'start'),$res->symb(),'opendate',$part));
}	}
	my $slotinfo;
if ($res->simpleStatus($part) == $res->OPEN) {	if ($res->simpleStatus($part) == $res->OPEN) {
unless (&Apache::lonnet::allowed('mgr',$env{'request.course.id'})) {	unless (&Apache::lonnet::allowed('mgr',$env{'request.course.id'})) {
my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);	my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
	my $slotmsg;
if ($slot_status == $res->UNKNOWN) {	if ($slot_status == $res->UNKNOWN) {
return &mt('Reservation status unknown');	$slotmsg = &mt('Reservation status unknown');
} elsif ($slot_status == $res->RESERVED) {	} elsif ($slot_status == $res->RESERVED) {
return &mt('Reserved - ends [_1]',	$slotmsg = &mt('Reserved - ends [_1]',
timeToHumanString($slot_time,'end'));	timeToHumanString($slot_time,'end'));
} elsif ($slot_status == $res->RESERVED_LOCATION) {	} elsif ($slot_status == $res->RESERVED_LOCATION) {
return &mt('Reserved - specific location(s) - ends [_1]',	$slotmsg = &mt('Reserved - specific location(s) - ends [_1]',
timeToHumanString($slot_time,'end'));	timeToHumanString($slot_time,'end'));
} elsif ($slot_status == $res->RESERVED_LATER) {	} elsif ($slot_status == $res->RESERVED_LATER) {
return &mt('Reserved - next open [_1]',	$slotmsg = &mt('Reserved - next open [_1]',
timeToHumanString($slot_time,'start'));	timeToHumanString($slot_time,'start'));
} elsif ($slot_status == $res->RESERVABLE) {	} elsif ($slot_status == $res->RESERVABLE) {
return &mt('Reservable ending [_1]',	$slotmsg = &mt('Reservable, reservations close [_1]',
timeToHumanString($slot_time,'end'));	timeToHumanString($slot_time,'end'));
} elsif ($slot_status == $res->RESERVABLE_LATER) {	} elsif ($slot_status == $res->RESERVABLE_LATER) {
return &mt('Reservable starting [_1]',	$slotmsg = &mt('Reservable, reservations open [_1]',
timeToHumanString($slot_time,'start'));	timeToHumanString($slot_time,'start'));
} elsif ($slot_status == $res->NOT_IN_A_SLOT) {	} elsif ($slot_status == $res->NOT_IN_A_SLOT) {
return &mt('Reserve a time/place to work');	$slotmsg = &mt('Reserve a time/place to work');
} elsif ($slot_status == $res->NOTRESERVABLE) {	} elsif ($slot_status == $res->NOTRESERVABLE) {
return &mt('Reservation not available');	$slotmsg = &mt('Reservation not available');
} elsif ($slot_status == $res->WAITING_FOR_GRADE) {	} elsif ($slot_status == $res->WAITING_FOR_GRADE) {
return &mt('Submission in grading queue');	$slotmsg = &mt('Submission in grading queue');
	}
	if ($slotmsg) {
	if ($res->is_task() \|\| !$due) {
	return $slotmsg;
	}
	$slotinfo = (' ' x 2).'('.$slotmsg.')';
}	}
}	}
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
if ($due) {	if ($due) {
if ($res->is_practice()) {	if ($res->is_practice()) {
return &mt("Closes ")." " .timeToHumanString($due,'start');	return &mt("Closes [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'start'),$res->symb(),'duedate',$part)).$slotinfo;
} else {	} else {
return &mt("Due")." " .timeToHumanString($due,'end');	return &mt("Due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'duedate',$part)).$slotinfo;
}	}
} else {	} else {
return &mt("Open, no due date");	return &Apache::lonhtmlcommon::direct_parm_link(&mt("Open, no due date"),$res->symb(),'duedate',$part).$slotinfo;
}	}
}	}
if ($status == $res->PAST_DUE_ANSWER_LATER) {	if ($status == $res->PAST_DUE_ANSWER_LATER) {
return &mt("Answer open")." " .timeToHumanString($answer,'start');	return &mt("Answer open [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($answer,'start'),$res->symb(),'answerdate',$part));
}	}
if ($status == $res->PAST_DUE_NO_ANSWER) {	if ($status == $res->PAST_DUE_NO_ANSWER) {
if ($res->is_practice()) {	if ($res->is_practice()) {
return &mt("Closed")." " . timeToHumanString($due,'start');	return &mt("Closed [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'start'),$res->symb(),'answerdate,duedate',$part));
} else {	} else {
return &mt("Was due")." " . timeToHumanString($due,'end');	return &mt("Was due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'answerdate,duedate',$part));
}	}
}	}
if (($status == $res->ANSWER_OPEN \|\| $status == $res->PARTIALLY_CORRECT)	if (($status == $res->ANSWER_OPEN \|\| $status == $res->PARTIALLY_CORRECT)
&& $res->handgrade($part) ne 'yes') {	&& $res->handgrade($part) ne 'yes') {
return &mt("Answer available");	return &Apache::lonhtmlcommon::direct_parm_link(&mt("Answer available"),$res->symb(),'answerdate,duedate',$part);
}	}
if ($status == $res->EXCUSED) {	if ($status == $res->EXCUSED) {
return &mt("Excused by instructor");	return &mt("Excused by instructor");
}	}
if ($status == $res->ATTEMPTED) {	if ($status == $res->ATTEMPTED) {
return &mt("Answer submitted, not yet graded");	if ($res->is_anonsurvey($part) \|\| $res->is_survey($part)) {
	return &mt("Survey submission recorded");
	} else {
	return &mt("Answer submitted, not yet graded");
	}
	}
	if ($status == $res->CREDIT_ATTEMPTED) {
	if ($res->is_anonsurvey($part) \|\| $res->is_survey($part)) {
	return &mt("Credit for survey submission");
	}
}	}
if ($status == $res->TRIES_LEFT) {	if ($status == $res->TRIES_LEFT) {
my $tries = $res->tries($part);	my $tries = $res->tries($part);
my $maxtries = $res->maxtries($part);	my $maxtries = $res->maxtries($part);
my $triesString = "";	my $triesString = "";
if ($tries && $maxtries) {	if ($tries && $maxtries) {
$triesString = '<font size="-1"><i>('.&mt('[_1] of [quant,_2,try,tries] used',$tries,$maxtries).')</i></font>';	$triesString = '<span class="LC_fontsize_medium"><i>('.&mt('[_1] of [quant,_2,try,tries] used',$tries,$maxtries).')</i></span>';
if ($maxtries > 1 && $maxtries - $tries == 1) {	if ($maxtries > 1 && $maxtries - $tries == 1) {
$triesString = "<b>$triesString</b>";	$triesString = "<b>$triesString</b>";
}	}
}	}
if ($due) {	if ($due) {
return &mt("Due")." " . timeToHumanString($due,'end') .	return &mt("Due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'duedate',$part)) .
" $triesString";	" $triesString";
} else {	} else {
return &mt("No due date")." $triesString";	return &Apache::lonhtmlcommon::direct_parm_link(&mt("No due date"),$res->symb(),'duedate',$part)." $triesString";
}	}
}	}
if ($status == $res->ANSWER_SUBMITTED) {	if ($status == $res->ANSWER_SUBMITTED) {
Line 794 sub timeToHumanString {	Line 796 sub timeToHumanString {

# Less than an hour	# Less than an hour
if ( $delta < $hour ) {	if ( $delta < $hour ) {
# If so, use minutes	# If so, use minutes; or minutes, seconds (if format requires)
my $minutes = floor($delta / 60);	my $minutes = floor($delta / 60);
	if (($format ne '') && ($format =~ /\%(T\|S)/)) {
	my $display;
	if ($minutes == 1) {
	$display = "${prefix}1 minute";
	} else {
	$display = "$prefix$minutes minutes";
	}
	my $seconds = $delta % $minute;
	if ($seconds == 0) {
	$display .= $tense;
	} elsif ($seconds == 1) {
	$display .= ", 1 second$tense";
	} else {
	$display .= ", $seconds seconds$tense";
	}
	return $display;
	}
if ($minutes == 1) { return "${prefix}1 minute$tense"; }	if ($minutes == 1) { return "${prefix}1 minute$tense"; }
return "$prefix$minutes minutes$tense";	return "$prefix$minutes minutes$tense";
}	}

# Is it less than 24 hours away? If so,	# Is it less than 24 hours away? If so,
# display hours + minutes	# display hours + minutes, (and + seconds, if format specified it)
if ( $delta < $hour * 24) {	if ( $delta < $hour * 24) {
my $hours = floor($delta / $hour);	my $hours = floor($delta / $hour);
my $minutes = floor(($delta % $hour) / $minute);	my $minutes = floor(($delta % $hour) / $minute);
Line 816 sub timeToHumanString {	Line 835 sub timeToHumanString {
if ($minutes == 0) {	if ($minutes == 0) {
$minuteString = "";	$minuteString = "";
}	}
	if (($format ne '') && ($format =~ /\%(T\|S)/)) {
	my $display = "$prefix$hourString$minuteString";
	my $seconds = $delta-(($hours * $hour)+($minutes * $minute));
	if ($seconds == 0) {
	$display .= $tense;
	} elsif ($seconds == 1) {
	$display .= ", 1 second$tense";
	} else {
	$display .= ", $seconds seconds$tense";
	}
	return $display;
	}
return "$prefix$hourString$minuteString$tense";	return "$prefix$hourString$minuteString$tense";
}	}

	# Date/time is more than 24 hours away

my $dt = DateTime->from_epoch(epoch => $time)	my $dt = DateTime->from_epoch(epoch => $time)
->set_time_zone(&Apache::lonlocal::gettimezone());	->set_time_zone(&Apache::lonlocal::gettimezone());

# If there's a caller supplied format, use it.	# If there's a caller supplied format, use it, unless it only displays
	# H:M:S or H:M.

if ($format ne '') {	if (($format ne '') && ($format ne '%T') && ($format ne '%R')) {
my $timeStr = $dt->strftime($format);	my $timeStr = $dt->strftime($format);
return $timeStr.' ('.$dt->time_zone_short_name().')';	return $timeStr.' ('.$dt->time_zone_short_name().')';
}	}
Line 876 sub part_status_summary { return 4; }	Line 910 sub part_status_summary { return 4; }
sub render_resource {	sub render_resource {
my ($resource, $part, $params) = @_;	my ($resource, $part, $params) = @_;

	my $editmapLink;
my $nonLinkedText = ''; # stuff after resource title not in link	my $nonLinkedText = ''; # stuff after resource title not in link

my $link = $params->{"resourceLink"};	my $link = $params->{"resourceLink"};
	if ($resource->ext()) {
	$link =~ s/\#.+(\?)/$1/g;
	}

# The URL part is not escaped at this point, but the symb is...	# The URL part is not escaped at this point, but the symb is...

Line 957 sub render_resource {	Line 995 sub render_resource {
$linkopen = "";	$linkopen = "";
$linkclose = "";	$linkclose = "";
}	}
	if ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
	($resource->symb=~/\_\_\_[^\_]+\_\_\_uploaded/)) {
	if (!$params->{'map_no_edit_link'}) {
	my $icon = &Apache::loncommon::lonhttpdurl('/res/adm/pages').'/editmap.png';
	$editmapLink=' '.
	'<a href="/adm/coursedocs?command=directnav&symb='.&escape($resource->symb()).'">'.
	'<img src="'.$icon.'" alt="'.&mt('Edit Content').'" title="'.&mt('Edit Content').'" />'.
	'</a>';
	}
	}
}	}

if ($resource->randomout()) {	if ($resource->randomout()) {
$nonLinkedText .= ' <i>('.&mt('hidden').')</i> ';	$nonLinkedText .= ' <span class="LC_warning">('.&mt('hidden').')</span> ';
}	}
if (!$resource->condval()) {	if (!$resource->condval()) {
$nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> ';	$nonLinkedText .= ' <span class="LC_info">('.&mt('conditionally hidden').')</span> ';
}	}
if (($resource->is_practice()) && ($resource->is_raw_problem())) {	if (($resource->is_practice()) && ($resource->is_raw_problem())) {
$nonLinkedText .=' <font color="green"><b>'.&mt('not graded').'</b></font>';	$nonLinkedText .=' <span class="LC_info"><b>'.&mt('not graded').'</b></span>';
}	}

# We're done preparing and finally ready to start the rendering	# We're done preparing and finally ready to start the rendering
Line 990 sub render_resource {	Line 1038 sub render_resource {
# Is this the current resource?	# Is this the current resource?
if (!$params->{'displayedHereMarker'} &&	if (!$params->{'displayedHereMarker'} &&
$resource->symb() eq $params->{'here'} ) {	$resource->symb() eq $params->{'here'} ) {
$curMarkerBegin = '<em>';	unless ($resource->is_map()) {
$curMarkerEnd = '</em>';	$curMarkerBegin = '<span class="LC_current_nav_location">';
	$curMarkerEnd = '</span>';
	}
$params->{'displayedHereMarker'} = 1;	$params->{'displayedHereMarker'} = 1;
}	}

Line 1007 sub render_resource {	Line 1057 sub render_resource {
$nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')';	$nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')';
}	}

my $target;
if ($env{'environment.remotenavmap'} eq 'on') {
$target=' target="loncapaclient" ';
}
if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {	if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
$result .= "$curMarkerBegin<a $target href=\"$link\">$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";	$result .= "$curMarkerBegin<a href=\"$link\">$title$partLabel</a>$curMarkerEnd$editmapLink$nonLinkedText</td>";
} else {	} else {
$result .= "$curMarkerBegin$linkopen$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";	$result .= "$curMarkerBegin$linkopen$title$partLabel</a>$curMarkerEnd$editmapLink$nonLinkedText</td>";
}	}

return $result;	return $result;
Line 1025 sub render_communication_status {	Line 1071 sub render_communication_status {
my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";	my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";

my $link = $params->{"resourceLink"};	my $link = $params->{"resourceLink"};
my $target;	my $linkopen = "<a href=\"$link\">";
if ($env{'environment.remotenavmap'} eq 'on') {
$target=' target="loncapaclient" ';
}
my $linkopen = "<a $target href=\"$link\">";
my $linkclose = "</a>";	my $linkclose = "</a>";
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");	my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");

if ($resource->hasDiscussion()) {	if ($resource->hasDiscussion()) {
$discussionHTML = $linkopen .	$discussionHTML = $linkopen .
'<img alt="'.&mt('New Discussion').'" src="'.$location.'/chat.gif" />' .	'<img alt="'.&mt('New Discussion').'" src="'.$location.'/chat.gif" title="'.&mt('New Discussion').'"/>' .
$linkclose;	$linkclose;
}	}

Line 1042 sub render_communication_status {	Line 1085 sub render_communication_status {
my $feedback = $resource->getFeedback();	my $feedback = $resource->getFeedback();
foreach my $msgid (split(/\,/, $feedback)) {	foreach my $msgid (split(/\,/, $feedback)) {
if ($msgid) {	if ($msgid) {
$feedbackHTML .= ' <a '.$target.' href="/adm/email?display='	$feedbackHTML .= ' <a href="/adm/email?display='
. &escape($msgid) . '">'	. &escape($msgid) . '">'
. '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" /></a>';	. '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" title="'.&mt('New E-mail').'"/></a>';
}	}
}	}
}	}
Line 1056 sub render_communication_status {	Line 1099 sub render_communication_status {
last if ($errorcount>=10); # Only output 10 bombs maximum	last if ($errorcount>=10); # Only output 10 bombs maximum
if ($msgid) {	if ($msgid) {
$errorcount++;	$errorcount++;
$errorHTML .= ' <a '.$target.' href="/adm/email?display='	$errorHTML .= ' <a href="/adm/email?display='
. &escape($msgid) . '">'	. &escape($msgid) . '">'
. '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" /></a>';	. '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" title="'.&mt('New Error').'"/></a>';
}	}
}	}
}	}
Line 1076 sub render_quick_status {	Line 1119 sub render_quick_status {
$params->{'multipart'} && $part eq "0";	$params->{'multipart'} && $part eq "0";

my $link = $params->{"resourceLink"};	my $link = $params->{"resourceLink"};
my $target;	my $linkopen = "<a href=\"$link\">";
if ($env{'environment.remotenavmap'} eq 'on') {
$target=' target="loncapaclient" ';
}
my $linkopen = "<a $target href=\"$link\">";
my $linkclose = "</a>";	my $linkclose = "</a>";

$result .= '<td class="LC_middle">';	$result .= '<td class="LC_middle">';
Line 1091 sub render_quick_status {	Line 1130 sub render_quick_status {
if ($icon) {	if ($icon) {
my $location=	my $location=
&Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");	&Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
$result .= "$linkopen<img src='$location' alt='$alt' />$linkclose";	$result .= $linkopen.'<img src="'.$location.'" alt="'.&mt($alt).'" title="'.&mt($alt).'" />'.$linkclose;
} else {	} else {
$result .= " ";	$result .= " ";
}	}
Line 1108 sub render_long_status {	Line 1147 sub render_long_status {
$params->{'multipart'} && $part eq "0";	$params->{'multipart'} && $part eq "0";

my $color;	my $color;
	my $info = '';
if ($resource->is_problem() \|\| $resource->is_practice()) {	if ($resource->is_problem() \|\| $resource->is_practice()) {
$color = $colormap{$resource->status};	$color = $colormap{$resource->status};

if (dueInLessThan24Hours($resource, $part) \|\|	if (dueInLessThan24Hours($resource, $part)) {
lastTry($resource, $part)) {
$color = $hurryUpColor;	$color = $hurryUpColor;
}	$info = ' title="'.&mt('Due in less than 24 hours!').'"';
	} elsif (lastTry($resource, $part)) {
	unless (($resource->problemstatus($part) eq 'no') \|\|
	($resource->problemstatus($part) eq 'no_feedback_ever')) {
	$color = $hurryUpColor;
	$info = ' title="'.&mt('One try remaining!').'"';
	}
	}
}	}

if ($resource->kind() eq "res" &&	if ($resource->kind() eq "res" &&
($resource->is_problem() \|\| $resource->is_practice()) &&	$resource->is_raw_problem() &&
!$firstDisplayed) {	!$firstDisplayed) {
if ($color) {$result .= "<font color=\"$color\"><b>"; }	if ($color) {$result .= '<span style="color:'.$color.'"'.$info.'><b>'; }
$result .= getDescription($resource, $part);	$result .= getDescription($resource, $part);
if ($color) {$result .= "</b></font>"; }	if ($color) {$result .= "</b></span>"; }
}	}
if ($resource->is_map() && &advancedUser() && $resource->randompick()) {	if ($resource->is_map() && &advancedUser() && $resource->randompick()) {
$result .= &mt('(randomly select [_1])', $resource->randompick());	$result .= &mt('(randomly select [_1])', $resource->randompick());
Line 1204 sub render_parts_summary_status {	Line 1250 sub render_parts_summary_status {
}	}
$return.= $td . $totalParts . ' parts: ';	$return.= $td . $totalParts . ' parts: ';
foreach my $status (@statuses) {	foreach my $status (@statuses) {
if ($overallstatus{$status}) {	if ($overallstatus{$status}) {
$return.="<font color='" . $statusColors{$status} .	$return.='<span style="color:' . $statusColors{$status}
"'>" . $overallstatus{$status} . ' '	. '">' . $overallstatus{$status} . ' '
. $statusStrings{$status} . "</font>";	. $statusStrings{$status} . '</span>';
}	}
}	}
$return.= $endtd;	$return.= $endtd;
return $return;	return $return;
Line 1433 sub render {	Line 1479 sub render {
if ($printCloseAll && !$args->{'resource_no_folder_link'}) {	if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
my ($link,$text);	my ($link,$text);
if ($condition) {	if ($condition) {
$link='"navmaps?condition=0&filter=&'.$queryString.	$link='navmaps?condition=0&filter=&'.$queryString.
'&here='.&escape($here).'"';	'&here='.&escape($here);
$text='Close all folders';	$text='Close all folders';
} else {	} else {
$link='"navmaps?condition=1&filter=&'.$queryString.	$link='navmaps?condition=1&filter=&'.$queryString.
'&here='.&escape($here).'"';	'&here='.&escape($here);
$text='Open all folders';	$text='Open all folders';
}	}
	if ($env{'form.register'}) {
	$link .= '&register='.$env{'form.register'};
	}
if ($args->{'caller'} eq 'navmapsdisplay') {	if ($args->{'caller'} eq 'navmapsdisplay') {
&add_linkitem($args->{'linkitems'},'changefolder',	unless ($args->{'notools'}) {
'location.href='.$link,$text);	&add_linkitem($args->{'linkitems'},'changefolder',
	"location.href='$link'",$text);
	}
} else {	} else {
$result.='<a href='.$link.'>'.&mt($text).'</a>';	$result.= '<a href="'.$link.'">'.&mt($text).'</a>';
}	}
$result .= "\n";	$result .= "\n";
}	}

# Check for any unread discussions in all resources.	# Check for any unread discussions in all resources.
if ($args->{'caller'} eq 'navmapsdisplay') {	if (($args->{'caller'} eq 'navmapsdisplay') && (!$args->{'notools'})) {
&add_linkitem($args->{'linkitems'},'clearbubbles',	&add_linkitem($args->{'linkitems'},'clearbubbles',
'document.clearbubbles.submit()',	'document.clearbubbles.submit()',
'Mark all posts read');	'Mark all posts read');
my $time=time;	my $time=time;
	my $querystr = &HTML::Entities::encode($ENV{'QUERY_STRING'},'<>&"');
$result .= (<<END);	$result .= (<<END);
<form name="clearbubbles" method="post" action="/adm/feedback">	<form name="clearbubbles" method="post" action="/adm/feedback">
<input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />	<input type="hidden" name="navurl" value="$querystr" />
<input type="hidden" name="navtime" value="$time" />	<input type="hidden" name="navtime" value="$time" />
END	END
	if ($env{'form.register'}) {
	$result .= '<input type="hidden" name="register" value="'.$env{'form.register'}.'" />';
	}
if ($args->{'sort'} eq 'discussion') {	if ($args->{'sort'} eq 'discussion') {
my $totdisc = 0;	my $totdisc = 0;
my $haveDisc = '';	my $haveDisc = '';
Line 1481 END	Line 1536 END
}	}
$result.='</form>';	$result.='</form>';
}	}
	if (($args->{'caller'} eq 'navmapsdisplay') &&
	(&Apache::lonnet::allowed('mdc',$env{'request.course.id'}))) {
	my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
	my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
	if ($env{'course.'.$env{'request.course.id'}.'.url'} eq
	"uploaded/$cdom/$cnum/default.sequence") {
	&add_linkitem($args->{'linkitems'},'edittoplevel',
	"javascript:gocmd('/adm/coursedocs','editdocs');",
	'Content Editor');
	}
	}


if ($args->{'caller'} eq 'navmapsdisplay') {	if ($args->{'caller'} eq 'navmapsdisplay') {
$result .= '<table><tr><td>'.	$result .= &show_linkitems_toolbar($args,$condition);
&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT').'</td>';
if ($env{'environment.remotenavmap'} ne 'on') {
$result .= '<td> </td>';
} else {
$result .= '</tr><tr>';
}
$result.="<td class=\"LC_middle\">".mt('Tools:')."</td>";
$result.=&show_linkitems_toolbar($args->{'linkitems'});
if ($args->{'sort_html'}) {
if ($env{'environment.remotenavmap'} ne 'on') {
$result.='<td> </td><td> </td><td> </td>'.
'<td align="right">'.$args->{'sort_html'}.'</td></tr>';
} else {
$result.='</tr><tr><td align="left"><br />'.
$args->{'sort_html'}.'</td></tr>';
}
}
$result .= '</table>';
} elsif ($args->{'sort_html'}) {	} elsif ($args->{'sort_html'}) {
$result.=$args->{'sort_html'};	$result.=$args->{'sort_html'};
}	}
Line 1525 END	Line 1572 END
( $res->NETWORK_FAILURE => 1,	( $res->NETWORK_FAILURE => 1,
$res->NOTHING_SET => 1,	$res->NOTHING_SET => 1,
$res->CORRECT => 1 );	$res->CORRECT => 1 );
my @backgroundColors = ("LC_trEven", "LC_trOdd");

# Shared variables	# Shared variables
$args->{'counter'} = 0; # counts the rows	$args->{'counter'} = 0; # counts the rows
Line 1753 END	Line 1799 END
if (defined($anchor)) { $anchor='#'.$anchor; }	if (defined($anchor)) { $anchor='#'.$anchor; }
my $srcHasQuestion = $src =~ /\?/;	my $srcHasQuestion = $src =~ /\?/;
$args->{"resourceLink"} = $src.	$args->{"resourceLink"} = $src.
($srcHasQuestion?'&':'?') .	($srcHasQuestion?'&':'?') .
'symb=' . &escape($symb).$anchor;	'symb=' . &escape($symb).$anchor;
}	}
# Now, we've decided what parts to show. Loop through them and	# Now, we've decided what parts to show. Loop through them and
# show them.	# show them.
foreach my $part (@parts) {	foreach my $part (@parts) {
$rownum ++;	$rownum ++;
my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];

$result .= &Apache::loncommon::start_data_table_row();	$result .= &Apache::loncommon::start_data_table_row();

Line 1807 END	Line 1852 END
}	}
}	}
}	}

	$result.=&Apache::loncommon::end_data_table();

# Print out the part that jumps to #curloc if it exists	# Print out the part that jumps to #curloc if it exists
# delay needed because the browser is processing the jump before	# delay needed because the browser is processing the jump before
Line 1816 END	Line 1863 END
# it's quite likely this might fix other browsers, too, and	# it's quite likely this might fix other browsers, too, and
# certainly won't hurt anything.	# certainly won't hurt anything.
if ($displayedJumpMarker) {	if ($displayedJumpMarker) {
$result .= "	$result .= &Apache::lonhtmlcommon::scripttag("
<script>
if (location.href.indexOf('#curloc')==-1) {	if (location.href.indexOf('#curloc')==-1) {
setTimeout(\"location += '#curloc';\", 0)	setTimeout(\"location += '#curloc';\", 0)
}	}
</script>";	");
}	}

$result.=&Apache::loncommon::end_data_table();

if ($r) {	if ($r) {
$r->print($result);	$r->print($result);
$result = "";	$result = "";
Line 1841 sub add_linkitem {	Line 1885 sub add_linkitem {
$$linkitems{$name}{'text'}=&mt($text);	$$linkitems{$name}{'text'}=&mt($text);
}	}

sub show_linkitems {
my ($linkitems)=@_;
my @linkorder = ("blank","launchnav","closenav","firsthomework",
"everything","uncompleted","changefolder","clearbubbles");

my $result .= (<<ENDBLOCK);
<td align="left">
<script type="text/javascript">
function changeNavDisplay () {
var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
ENDBLOCK
foreach my $link (@linkorder) {
$result.= "if (navchoice == '$link') {".
$linkitems->{$link}{'cmd'}."}\n";
}
$result.='}
</script>
<form name="linkitems" method="post">
<span class="LC_nobreak"><select name="toplink">'."\n";
foreach my $link (@linkorder) {
if (defined($linkitems->{$link})) {
if ($linkitems->{$link}{'text'} ne '') {
$result .= ' <option value="'.$link.'">'.
$linkitems->{$link}{'text'}."</option>\n";
}
}
}
$result .= '</select> <input type="button" name="chgnav"
value="Go" onClick="javascript:changeNavDisplay()" />
</span></form></td>'."\n";

return $result;
}

sub show_linkitems_toolbar {	sub show_linkitems_toolbar {
my ($linkitems,$condition)=@_;	my ($args,$condition) = @_;
my @linkorder = ("blank","launchnav","closenav","firsthomework",	my $result;
"everything","uncompleted","changefolder","clearbubbles");	if (ref($args) eq 'HASH') {
	if (ref($args->{'linkitems'}) eq 'HASH') {
my $result .='	my $numlinks = scalar(keys(%{$args->{'linkitems'}}));
<td align="left">	if ($numlinks > 1) {
<span class="LC_nobreak">'."\n<ul id=\"LC_toolbar\">";	$result = '<td>'.
foreach my $link (@linkorder) {	&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',
my $link_id = "LC_content_toolbar_".$link;	undef,'RAT').
if (defined($linkitems->{$link})) {	'</td>'.
if ($linkitems->{$link}{'text'} ne '') {	'<td> </td>'.
$linkitems->{$link}{'cmd'}=~s/"/'/g;	'<td class="LC_middle">'.&mt('Tools:').'</td>';
if($linkitems->{$link}{'cmd'}){	}
if($link eq 'changefolder'){	$result .= '<td align="left">'."\n".
if($condition){$link_id='LC_content_toolbar_changefolder_toggled'}	'<ul id="LC_toolbar">';
else{$link_id='LC_content_toolbar_changefolder'}	my @linkorder = ('firsthomework','everything','uncompleted',
}	'changefolder','clearbubbles','edittoplevel');
$result .= ' <li><a href="#"'.	foreach my $link (@linkorder) {
' onClick="'.$linkitems->{$link}{'cmd'}.'"'.	if (ref($args->{'linkitems'}{$link}) eq 'HASH') {
' id="'.$link_id.'"'.	if ($args->{'linkitems'}{$link}{'text'} ne '') {
' class="LC_toolbarItem"'.	$args->{'linkitems'}{$link}{'cmd'}=~s/"/'/g;
' title="'.$linkitems->{$link}{'text'}.'"></a></li>'."\n";	if ($args->{'linkitems'}{$link}{'cmd'}) {
}	my $link_id = 'LC_content_toolbar_'.$link;
	if ($link eq 'changefolder') {
}	if ($condition) {
}	$link_id='LC_content_toolbar_changefolder_toggled';
	} else {
	$link_id='LC_content_toolbar_changefolder';
	}
	}
	$result .= '<li><a href="#" '.
	'onclick="'.$args->{'linkitems'}{$link}{'cmd'}.'" '.
	'id="'.$link_id.'" '.
	'class="LC_toolbarItem" '.
	'title="'.$args->{'linkitems'}{$link}{'text'}.'">'.
	'</a></li>'."\n";
	}
	}
	}
	}
	$result .= '</ul>'.
	'</td>';
	if (($numlinks==1) && (exists($args->{'linkitems'}{'edittoplevel'}))) {
	$result .= '<td><a href="'.$args->{'linkitems'}{'edittoplevel'}{'cmd'}.'">'.
	&mt('Content Editor').'</a></td>';
	}
	}
	if ($args->{'sort_html'}) {
	$result .= '<td> </td><td> </td><td> </td>'.
	'<td align="right">'.$args->{'sort_html'}.'</td>';
	}
	}
	if ($result) {
	$result = "<table><tr>$result</tr></table>";
}	}
$result .= '</ul>';
$result .= ' </span></td>'."\n";

return $result;	return $result;
}	}


1;	1;


Line 1996 sub new {	Line 2030 sub new {
my $proto = shift;	my $proto = shift;
my $class = ref($proto) \|\| $proto;	my $class = ref($proto) \|\| $proto;
my $self = {};	my $self = {};
	bless($self); # So we can call change_user if necessary

	$self->{USERNAME} = shift \|\| $env{'user.name'};
	$self->{DOMAIN} = shift \|\| $env{'user.domain'};
	$self->{CODE} = shift;
	$self->{NOHIDE} = shift;



# Resource cache stores navmap resources as we reference them. We generate	# Resource cache stores navmap resources as we reference them. We generate
# them on-demand so we don't pay for creating resources unless we use them.	# them on-demand so we don't pay for creating resources unless we use them.
Line 2005 sub new {	Line 2047 sub new {
# failed	# failed
$self->{NETWORK_FAILURE} = 0;	$self->{NETWORK_FAILURE} = 0;

# tie the nav hash	# We can only tie the nav hash as done below if the username/domain
	# match the env one. Otherwise change_user does everything we need...since we can't
	# assume there are course hashes for the specific requested user:domain
	# Note: change_user is also called if we need the nav hash when printing CODEd
	# assignments or printing an exam, in which the enclosing folder for the items in
	# the exam has hidden set.
	#

my %navmaphash;	if (($self->{USERNAME} eq $env{'user.name'}) && ($self->{DOMAIN} eq $env{'user.domain'}) &&
my %parmhash;	!$self->{CODE} && !$self->{NOHIDE}) {
my $courseFn = $env{"request.course.fn"};
if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",	# tie the nav hash
&GDBM_READER(), 0640))) {
return undef;	my %navmaphash;
	my %parmhash;
	my $courseFn = $env{"request.course.fn"};
	if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
	&GDBM_READER(), 0640))) {
	return undef;
	}

	if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
	&GDBM_READER(), 0640)))
	{
	untie %{$self->{PARM_HASH}};
	return undef;
	}

	$self->{NAV_HASH} = \%navmaphash;
	$self->{PARM_HASH} = \%parmhash;
	$self->{PARM_CACHE} = {};
	} else {
	$self->change_user($self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE});
}	}

	return $self;
	}

	#
	# In some instances it is useful to be able to dynamically change the
	# username/domain associated with a navmap (e.g. to navigate for someone
	# else besides the current user...if sufficiently privileged.
	# Parameters:
	# user - New user.
	# domain- Domain the user belongs to.
	# code - Anonymous CODE in use.
	# Implicit inputs:
	#
	sub change_user {
	my $self = shift;
	$self->{USERNAME} = shift;
	$self->{DOMAIN} = shift;
	$self->{CODE} = shift;
	$self->{NOHIDE} = shift;

	# If the hashes are already tied make sure to break that bond:

	untie %{$self->{NAV_HASH}};
	untie %{$self->{PARM_HASH}};

	# The assumption is that we have to
	# use lonmap here to re-read the hash and from it reconstruct
	# new big and parameter hashes. An implicit assumption at this time
	# is that the course file is probably not created locally yet
	# an that we will therefore just read without tying.

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

	my %big_hash;
	&Apache::lonmap::loadmap($cnum, $cdom, $self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE}, \%big_hash);
	$self->{NAV_HASH} = \%big_hash;



	# Now clear the parm cache and reconstruct the parm hash from the big_hash
	# param.xxxx keys.

	$self->{PARM_CACHE} = {};

if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",	my %parm_hash = {};
&GDBM_READER(), 0640)))	foreach my $key (keys(%big_hash)) {
{	if ($key =~ /^param\./) {
untie %{$self->{PARM_HASH}};	my $param_key = $key;
return undef;	$param_key =~ s/^param\.//;
	$parm_hash{$param_key} = $big_hash{$key};
	}
}	}

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

bless($self);

return $self;
}	}

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

my $uname=$env{'user.name'};	my $uname=$self->{USERNAME};
my $udom=$env{'user.domain'};	my $udom=$self->{DOMAIN};

my $cid=$env{'request.course.id'};	my $cid=$env{'request.course.id'};
my $cdom=$env{'course.'.$cid.'.domain'};	my $cdom=$env{'course.'.$cid.'.domain'};
my $cnum=$env{'course.'.$cid.'.num'};	my $cnum=$env{'course.'.$cid.'.num'};
Line 2070 sub generate_course_user_opt {	Line 2179 sub generate_course_user_opt {
return;	return;
}	}



sub generate_email_discuss_status {	sub generate_email_discuss_status {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;
Line 2079 sub generate_email_discuss_status {	Line 2190 sub generate_email_discuss_status {
my $cdom=$env{'course.'.$cid.'.domain'};	my $cdom=$env{'course.'.$cid.'.domain'};
my $cnum=$env{'course.'.$cid.'.num'};	my $cnum=$env{'course.'.$cid.'.num'};

my %emailstatus = &Apache::lonnet::dump('email_status');	my %emailstatus = &Apache::lonnet::dump('email_status',$self->{DOMAIN},$self->{USERNAME});
my $logoutTime = $emailstatus{'logout'};	my $logoutTime = $emailstatus{'logout'};
my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};	my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?	$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
Line 2087 sub generate_email_discuss_status {	Line 2198 sub generate_email_discuss_status {
my %discussiontime = &Apache::lonnet::dump('discussiontimes',	my %discussiontime = &Apache::lonnet::dump('discussiontimes',
$cdom, $cnum);	$cdom, $cnum);
my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',	my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
$env{'user.domain'},$env{'user.name'},'lastread');	$self->{DOMAIN},$self->{USERNAME},'lastread');
my %lastreadtime = ();	my %lastreadtime = ();
foreach my $key (keys %lastread) {	foreach my $key (keys(%lastread)) {
my $shortkey = $key;	my $shortkey = $key;
$shortkey =~ s/_lastread$//;	$shortkey =~ s/_lastread$//;
$lastreadtime{$shortkey} = $lastread{$key};	$lastreadtime{$shortkey} = $lastread{$key};
Line 2097 sub generate_email_discuss_status {	Line 2208 sub generate_email_discuss_status {

my %feedback=();	my %feedback=();
my %error=();	my %error=();
my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},	my @keys = &Apache::lonnet::getkeys('nohist_email',$self->{DOMAIN},
$env{'user.name'});	$self->{USERNAME});

foreach my $msgid (@keys) {	foreach my $msgid (@keys) {
if ((!$emailstatus{$msgid}) \|\| ($emailstatus{$msgid} eq 'new')) {	if ((!$emailstatus{$msgid}) \|\| ($emailstatus{$msgid} eq 'new')) {
Line 2146 sub get_user_data {	Line 2257 sub get_user_data {

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

$self->{RETRIEVED_USER_DATA} = 1;	$self->{RETRIEVED_USER_DATA} = 1;
Line 2376 resource object.	Line 2487 resource object.
Based on the symb of the resource, get a resource object for that	Based on the symb of the resource, get a resource object for that
resource. This is one of the proper ways to get a resource object.	resource. This is one of the proper ways to get a resource object.

=item * B<getMapByMapPc>(map_pc):	=item * B<getByMapPc>(map_pc):

Based on the map_pc of the resource, get a resource object for	Based on the map_pc of the resource, get a resource object for
the given map. This is one of the proper ways to get a resource object.	the given map. This is one of the proper ways to get a resource object.
Line 2461 sub parmval {	Line 2572 sub parmval {
my $self = shift;	my $self = shift;
my ($what,$symb,$recurse)=@_;	my ($what,$symb,$recurse)=@_;
my $hashkey = $what."\|\|\|".$symb;	my $hashkey = $what."\|\|\|".$symb;
	my $cache = $self->{PARM_CACHE};
if (defined($self->{PARM_CACHE}->{$hashkey})) {	if (defined($self->{PARM_CACHE}->{$hashkey})) {
if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') {	if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') {
if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) {	if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) {
Line 2475 sub parmval {	Line 2586 sub parmval {
return $self->{PARM_CACHE}->{$hashkey};	return $self->{PARM_CACHE}->{$hashkey};
}	}
}	}

my $result = $self->parmval_real($what, $symb, $recurse);	my $result = $self->parmval_real($what, $symb, $recurse);
$self->{PARM_CACHE}->{$hashkey} = $result;	$self->{PARM_CACHE}->{$hashkey} = $result;
if (wantarray) {	if (wantarray) {
Line 2483 sub parmval {	Line 2595 sub parmval {
return $result->[0];	return $result->[0];
}	}


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


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

Line 2498 sub parmval_real {	Line 2612 sub parmval_real {
@cgrps = sort(@cgrps);	@cgrps = sort(@cgrps);
$cgroup = $cgrps[0];	$cgroup = $cgrps[0];
}	}
my $uname=$env{'user.name'};	my $uname=$self->{USERNAME};
my $udom=$env{'user.domain'};	my $udom=$self->{DOMAIN};

unless ($symb) { return ['']; }	unless ($symb) { return ['']; }
my $result='';	my $result='';

my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);	my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
$mapname = &Apache::lonnet::deversion($mapname);	$mapname = &Apache::lonnet::deversion($mapname);
	my ($recursed,@recurseup);

# ----------------------------------------------------- Cascading lookup scheme	# ----------------------------------------------------- Cascading lookup scheme
my $rwhat=$what;	my $rwhat=$what;
$what=~s/^parameter\_//;	$what=~s/^parameter\_//;
$what=~s/\_/\./;	$what=~s/\_/\./;

my $symbparm=$symb.'.'.$what;	my $symbparm=$symb.'.'.$what;
	my $recurseparm=$mapname.'___(rec).'.$what;
my $mapparm=$mapname.'___(all).'.$what;	my $mapparm=$mapname.'___(all).'.$what;
my $usercourseprefix=$cid;	my $usercourseprefix=$cid;



my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;	my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;	my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
	my $grpleveli=$usercourseprefix.'.['.$cgroup.'].'.$recurseparm;
my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;	my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;


my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;	my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;	my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
	my $secleveli=$usercourseprefix.'.['.$csec.'].'.$recurseparm;
my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;	my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;


my $courselevel= $usercourseprefix.'.'.$what;	my $courselevel= $usercourseprefix.'.'.$what;
my $courselevelr=$usercourseprefix.'.'.$symbparm;	my $courselevelr=$usercourseprefix.'.'.$symbparm;
	my $courseleveli=$usercourseprefix.'.'.$recurseparm;
my $courselevelm=$usercourseprefix.'.'.$mapparm;	my $courselevelm=$usercourseprefix.'.'.$mapparm;


my $useropt = $self->{USER_OPT};	my $useropt = $self->{USER_OPT};
my $courseopt = $self->{COURSE_OPT};	my $courseopt = $self->{COURSE_OPT};
my $parmhash = $self->{PARM_HASH};	my $parmhash = $self->{PARM_HASH};
Line 2535 sub parmval_real {	Line 2660 sub parmval_real {
if ($uname and defined($useropt)) {	if ($uname and defined($useropt)) {
if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }	if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }
if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }	if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }
	if (defined($$useropt{$courseleveli})) { return [$$useropt{$courseleveli},'map']; }
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
	last if (defined($$useropt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
	if (defined($$useropt{$recursechk})) { return [$$useropt{$recursechk},'map']; }
	}
if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }	if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }
}	}

Line 2542 sub parmval_real {	Line 2678 sub parmval_real {
if ($cgroup ne '' and defined($courseopt)) {	if ($cgroup ne '' and defined($courseopt)) {
if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }	if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }
if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }	if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }
	if (defined($$courseopt{$grpleveli})) { return [$$courseopt{$grpleveli},'map']; }
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }
	}
if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }	if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }
}	}

if ($csec and defined($courseopt)) {	if ($csec ne '' and defined($courseopt)) {
if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }	if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }
if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }	if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }
	if (defined($$courseopt{$secleveli})) { return [$$courseopt{$secleveli},'map']; }
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }
	}
if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }	if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }
}	}

Line 2571 sub parmval_real {	Line 2729 sub parmval_real {
# --------------------------------------------------- fifth, check more course	# --------------------------------------------------- fifth, check more course
if (defined($courseopt)) {	if (defined($courseopt)) {
if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }	if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }
	if (defined($$courseopt{$courseleveli})) { return [$$courseopt{$courseleveli},'map']; }
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) {
	return [$$courseopt{$recursechk},'map'];
	}
	}
if (defined($$courseopt{$courselevel})) {	if (defined($$courseopt{$courselevel})) {
my $ret = [$$courseopt{$courselevel},'course'];	my $ret = [$$courseopt{$courselevel},'course'];
return $ret;	return $ret;
Line 2594 sub parmval_real {	Line 2765 sub parmval_real {
return [''];	return [''];
}	}

	sub recurseup_maps {
	my ($self,$mapname) = @_;
	my @recurseup;
	if ($mapname) {
	my @pcs = split(/,/,$self->getResourceByUrl(&Apache::lonnet::clutter($mapname))->map_hierarchy());
	shift(@pcs);
	pop(@pcs);
	if (@pcs) {
	@recurseup = map { &Apache::lonnet::declutter($self->getByMapPc($_)->src()); } reverse(@pcs);
	}
	}
	return @recurseup;
	}

	#
	# Determines the open/close dates for printing a map that
	# encloses a resource.
	#
	sub map_printdates {
	my ($self, $res, $part) = @_;





	my $opendate = $self->get_mapparam($res->symb(), "$part.printstartdate");
	my $closedate= $self->get_mapparam($res->symb(), "$part.printenddate");


	return ($opendate, $closedate);
	}

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

	# Ensure the course option hash is populated:

	$self->generate_course_user_opt();

	# Get the course id and section if there is one.

	my $cid=$env{'request.course.id'};
	my $csec=$env{'request.course.sec'};
	my $cgroup='';
	my @cgrps=split(/:/,$env{'request.course.groups'});
	if (@cgrps > 0) {
	@cgrps = sort(@cgrps);
	$cgroup = $cgrps[0];
	}
	my $uname=$self->{USERNAME};
	my $udom=$self->{DOMAIN};

	unless ($symb) { return ['']; }
	my $result='';
	my ($recursed,@recurseup);


	# Figure out which map we are in.

	my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
	$mapname = &Apache::lonnet::deversion($mapname);


	my $rwhat=$what;
	$what=~s/^parameter\_//;
	$what=~s/\_/\./;

	# Build the hash keys for the lookup:

	my $symbparm=$symb.'.'.$what;
	my $mapparm=$mapname.'___(all).'.$what;
	my $recurseparm=$mapname.'___(rec).'.$what;
	my $usercourseprefix=$cid;


	my $grplevelm = "$usercourseprefix.[$cgroup].$mapparm";
	my $seclevelm = "$usercourseprefix.[$csec].$mapparm";
	my $courselevelm = "$usercourseprefix.$mapparm";

	my $grpleveli = "$usercourseprefix.[$cgroup].$recurseparm";
	my $secleveli = "$usercourseprefix.[$csec].$recurseparm";
	my $courseleveli = "$usercourseprefix.$recurseparm";

	# Get handy references to the hashes we need in $self:

	my $useropt = $self->{USER_OPT};
	my $courseopt = $self->{COURSE_OPT};
	my $parmhash = $self->{PARM_HASH};

	# Check per user



	if ($uname and defined($useropt)) {
	if (defined($$useropt{$courselevelm})) {
	return $$useropt{$courselevelm};
	}
	if (defined($$useropt{$courseleveli})) {
	return $$useropt{$courseleveli};
	}
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
	last if (defined($$useropt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
	if (defined($$useropt{$recursechk})) {
	return $$useropt{$recursechk};
	}
	}
	}

	# Check course -- group



	if ($cgroup ne '' and defined ($courseopt)) {
	if (defined($$courseopt{$grplevelm})) {
	return $$courseopt{$grplevelm};
	}
	if (defined($$courseopt{$grpleveli})) {
	return $$courseopt{$grpleveli};
	}
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) {
	return $$courseopt{$recursechk};
	}
	}
	}

	# Check course -- section


	if ($csec ne '' and defined($courseopt)) {
	if (defined($$courseopt{$seclevelm})) {
	return $$courseopt{$seclevelm};
	}
	if (defined($$courseopt{$secleveli})) {
	return $$courseopt{$secleveli};
	}
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) {
	return $$courseopt{$recursechk};
	}
	}
	}
	# Check the map parameters themselves:

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


	# Additional course parameters:

	if (defined($courseopt)) {
	if (defined($$courseopt{$courselevelm})) {
	return $$courseopt{$courselevelm};
	}
	unless ($recursed) {
	@recurseup = $self->recurseup_maps($mapname);
	$recursed = 1;
	}
	if (@recurseup) {
	foreach my $item (@recurseup) {
	my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
	last if (defined($$courseopt{$norecursechk}));
	my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
	if (defined($$courseopt{$recursechk})) {
	return $$courseopt{$recursechk};
	}
	}
	}
	}
	return undef; # Undefined if we got here.
	}

	sub course_printdates {
	my ($self, $symb, $part) = @_;


	my $opendate = $self->getcourseparam($symb, $part . '.printstartdate');
	my $closedate = $self->getcourseparam($symb, $part . '.printenddate');
	return ($opendate, $closedate);

	}

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

	$self->generate_course_user_opt(); # If necessary populate the hashes.

	my $uname = $self->{USERNAME};
	my $udom = $self->{DOMAIN};

	# Course, section, group ids come from the env:

	my $cid = $env{'request.course.id'};
	my $csec = $env{'request.course.sec'};
	my $cgroup = ''; # Assume no group

	my @cgroups = split(/:/, $env{'request.course.groups'});
	if(@cgroups > 0) {
	@cgroups = sort(@cgroups);
	$cgroup = $cgroups[0]; # There is a course group.
	}
	my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
	$mapname = &Apache::lonnet::deversion($mapname);

	#
	# Make the various lookup keys:
	#

	$what=~s/^parameter\_//;
	$what=~s/\_/\./;

	# Local refs to the hashes we're going to look at:

	my $useropt = $self->{USER_OPT};
	my $courseopt = $self->{COURSE_OPT};

	#
	# We want the course level stuff from the way
	# parmval_real operates
	# TODO: Factor some of this stuff out of
	# both parmval_real and here
	#
	my $courselevel = $cid . '.' . $what;
	my $grplevel = $cid . '.[' . $cgroup . ']' . $what;
	my $seclevel = $cid . '.[' . $csec . ']' . $what;


	# Try for the user's course level option:

	if ($uname and defined($useropt)) {
	if (defined($$useropt{$courselevel})) {
	return $$useropt{$courselevel};
	}
	}
	# Try for the group's course level option:

	if ($cgroup ne '' and defined($courseopt)) {
	if (defined($$courseopt{$grplevel})) {
	return $$courseopt{$grplevel};
	}
	}

	# Try for section level parameters:

	if ($csec ne '' and defined($courseopt)) {
	if (defined($$courseopt{$seclevel})) {
	return $$courseopt{$seclevel};
	}
	}
	# Try for 'additional' course parameters:

	if (defined($courseopt)) {
	if (defined($$courseopt{$courselevel})) {
	return $$courseopt{$courselevel};
	}
	}
	return undef;

	}


=pod	=pod

=item * B<getResourceByUrl>(url,multiple):	=item * B<getResourceByUrl>(url,multiple):
Line 2608 resource appears multiple times in the c	Line 3062 resource appears multiple times in the c
will be returned (useful for maps), unless the multiple parameter has	will be returned (useful for maps), unless the multiple parameter has
been included, in which case all instances are returned in an array.	been included, in which case all instances are returned in an array.

=item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):	=item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall, noblockcheck):

The map is a specification of a map to retreive the resources from,	The map is a specification of a map to retreive the resources from,
either as a url or as an object. The filterFunc is a reference to a	either as a url or as an object. The filterFunc is a reference to a
Line 2617 true if the resource should be included,	Line 3071 true if the resource should be included,
be. If recursive is true, the map will be recursively examined,	be. If recursive is true, the map will be recursively examined,
otherwise it will not be. If bailout is true, the function will return	otherwise it will not be. If bailout is true, the function will return
as soon as it finds a resource, if false it will finish. If showall is	as soon as it finds a resource, if false it will finish. If showall is
true it will not hide maps that contain nothing but one other map. By	true it will not hide maps that contain nothing but one other map. The
default, the map is the top-level map of the course, filterFunc is a	noblockcheck arg is propagated to become the sixth arg in the call to
function that always returns 1, recursive is true, bailout is false,	lonnet::allowed when checking a resource's availability during collection
showall is false. The resources will be returned in a list containing	of resources using the iterator. noblockcheck needs to be true if
the resource objects for the corresponding resources, with B<no	retrieveResources() was called by a routine that itself was called by
structure information> in the list; regardless of branching,	lonnet::allowed, in order to avoid recursion. By default the map
recursion, etc., it will be a flat list.	is the top-level map of the course, filterFunc is a function that
	always returns 1, recursive is true, bailout is false, showall is
	false. The resources will be returned in a list containing the
	resource objects for the corresponding resources, with B<no structure
	information> in the list; regardless of branching, recursion, etc.,
	it will be a flat list.

Thus, this is suitable for cases where you don't want the structure,	Thus, this is suitable for cases where you don't want the structure,
just a list of all resources. It is also suitable for finding out how	just a list of all resources. It is also suitable for finding out how
Line 2646 in the filter function.	Line 3105 in the filter function.
Retrieves version infomation for a url. Returns the version (a number, or	Retrieves version infomation for a url. Returns the version (a number, or
the string "mostrecent") for resources which have version information in	the string "mostrecent") for resources which have version information in
the big hash.	the big hash.

=cut	=cut


Line 2690 sub retrieveResources {	Line 3149 sub retrieveResources {
my $bailout = shift;	my $bailout = shift;
if (!defined($bailout)) { $bailout = 0; }	if (!defined($bailout)) { $bailout = 0; }
my $showall = shift;	my $showall = shift;
	my $noblockcheck = shift;
# Create the necessary iterator.	# Create the necessary iterator.
if (!ref($map)) { # assume it's a url of a map.	if (!ref($map)) { # assume it's a url of a map.
$map = $self->getResourceByUrl($map);	$map = $self->getResourceByUrl($map);
Line 2719 sub retrieveResources {	Line 3179 sub retrieveResources {
# Run down the iterator and collect the resources.	# Run down the iterator and collect the resources.
my $curRes;	my $curRes;

while ($curRes = $it->next()) {	while ($curRes = $it->next(undef,$noblockcheck)) {
if (ref($curRes)) {	if (ref($curRes)) {
if (!&$filterFunc($curRes)) {	if (!&$filterFunc($curRes)) {
next;	next;
Line 2870 Note that inside of the loop, it's frequ	Line 3330 Note that inside of the loop, it's frequ
resource objects will be references, and any non-references will	resource objects will be references, and any non-references will
be the tokens described above.	be the tokens described above.

Also note there is some old code floating around that trys to track	The next() routine can take two (optional) arguments:
	closeAllPages - if true will not recurse down a .page
	noblockcheck - passed to browsePriv() for passing as sixth arg to
	call to lonnet::allowed. This needs to be set if retrieveResources
	was already called from another routine called within lonnet::allowed,
	so as to prevent recursion.

	Also note there is some old code floating around that tries to track
the depth of the iterator to see when it's done; do not copy that	the depth of the iterator to see when it's done; do not copy that
code. It is difficult to get right and harder to understand than	code. It is difficult to get right and harder to understand than
this. They should be migrated to this new style.	this. They should be migrated to this new style.
Line 2901 sub new {	Line 3368 sub new {
weaken($self->{NAV_MAP} = shift);	weaken($self->{NAV_MAP} = shift);
return undef unless ($self->{NAV_MAP});	return undef unless ($self->{NAV_MAP});

	$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
	$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};

# Handle the parameters	# Handle the parameters
$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();	$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();
$self->{FINISH_RESOURCE} = shift \|\| $self->{NAV_MAP}->finishResource();	$self->{FINISH_RESOURCE} = shift \|\| $self->{NAV_MAP}->finishResource();
Line 3014 sub new {	Line 3484 sub new {
if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {	if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
my $firstResource = $resource->map_start();	my $firstResource = $resource->map_start();
my $finishResource = $resource->map_finish();	my $finishResource = $resource->map_finish();
return	return Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,	$finishResource, $self->{FILTER},
$finishResource, $self->{FILTER},	$self->{ALREADY_SEEN},
$self->{ALREADY_SEEN},	$self->{CONDITION},
$self->{CONDITION},	$self->{FORCE_TOP});
$self->{FORCE_TOP});

}	}

# Set up some bookkeeping information.	# Set up some bookkeeping information.
Line 3039 sub new {	Line 3507 sub new {
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;	$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;

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

return $self;	return $self;
}	}

sub next {	sub next {
my $self = shift;	my $self = shift;
my $closeAllPages=shift;	my $closeAllPages=shift;
	my $noblockcheck = shift;
if ($self->{FINISHED}) {	if ($self->{FINISHED}) {
return END_ITERATOR();	return END_ITERATOR();
}	}
Line 3054 sub next {	Line 3522 sub next {
# do so.	# do so.
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {	if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
$self->{HAVE_RETURNED_0} = 1;	$self->{HAVE_RETURNED_0} = 1;
	my $nextTopLevel = $self->{NAV_MAP}->getById('0.0');
return $self->{NAV_MAP}->getById('0.0');	return $self->{NAV_MAP}->getById('0.0');
}	}
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {	if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {
Line 3073 sub next {	Line 3542 sub next {
if ($self->{RECURSIVE_DEPTH} == 0) {	if ($self->{RECURSIVE_DEPTH} == 0) {
$self->{RECURSIVE_ITERATOR_FLAG} = 0;	$self->{RECURSIVE_ITERATOR_FLAG} = 0;
}	}

return $next;	return $next;
}	}

Line 3149 sub next {	Line 3617 sub next {
# So we need to look at all the resources we can get to from here,	# So we need to look at all the resources we can get to from here,
# categorize them if we haven't seen them, remember if we have a new	# categorize them if we haven't seen them, remember if we have a new
my $nextUnfiltered = $here->getNext();	my $nextUnfiltered = $here->getNext();


my $maxDepthAdded = -1;	my $maxDepthAdded = -1;

for (@$nextUnfiltered) {	for (@$nextUnfiltered) {
Line 3182 sub next {	Line 3652 sub next {
$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();

$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},	$finishResource, $self->{FILTER},
Line 3194 sub next {	Line 3663 sub next {
# If this is a blank resource, don't actually return it.	# If this is a blank resource, don't actually return it.
# Should you ever find you need it, make sure to add an option to the code	# Should you ever find you need it, make sure to add an option to the code
# that you can use; other things depend on this behavior.	# that you can use; other things depend on this behavior.
my $browsePriv = $self->{HERE}->browsePriv();	my $browsePriv = $self->{HERE}->browsePriv($noblockcheck);
if (!$self->{HERE}->src() \|\|	if (!$self->{HERE}->src() \|\|
(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {	(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
return $self->next($closeAllPages);	return $self->next($closeAllPages);
Line 3274 sub new {	Line 3743 sub new {
weaken($self->{NAV_MAP} = shift);	weaken($self->{NAV_MAP} = shift);
return undef unless ($self->{NAV_MAP});	return undef unless ($self->{NAV_MAP});

	$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
	$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};

$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();	$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();
$self->{FINISH_RESOURCE} = shift \|\| $self->{NAV_MAP}->finishResource();	$self->{FINISH_RESOURCE} = shift \|\| $self->{NAV_MAP}->finishResource();

Line 3510 sub new {	Line 3982 sub new {
weaken($self->{NAV_MAP} = shift);	weaken($self->{NAV_MAP} = shift);
$self->{ID} = shift;	$self->{ID} = shift;

	$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
	$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};

# 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;	$self->{RESOURCE_ERROR} = 0;

	$self->{DUEDATE_CACHE} = undef;

# 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
# directly.	# directly.
$self->{DATA} = {};	$self->{DATA} = {};

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

	# This is a speed optimization, to avoid calling symb() too often.
	$self->{SYMB} = $self->symb();

return $self;	return $self;
}	}

Line 3531 sub navHash {	Line 4011 sub navHash {
my $self = shift;	my $self = shift;
my $param = shift;	my $param = shift;
my $id = shift;	my $id = shift;
return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));	my $arg = $param . ($id?$self->{ID}:"");
	if (ref($self) && ref($self->{NAV_MAP}) && defined($arg)) {
	return $self->{NAV_MAP}->navhash($arg);
	}
	return;
}	}

=pod	=pod
Line 3628 sub src {	Line 4112 sub src {
}	}
sub shown_symb {	sub shown_symb {
my $self=shift;	my $self=shift;
if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}	if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->{SYMB});}
return $self->symb();	return $self->{SYMB};
}	}
sub id {	sub id {
my $self=shift;	my $self=shift;
Line 3650 sub symb {	Line 4134 sub symb {
}	}
sub wrap_symb {	sub wrap_symb {
my $self = shift;	my $self = shift;
return $self->{NAV_MAP}->wrap_symb($self->symb());	return $self->{NAV_MAP}->wrap_symb($self->{SYMB});
}	}
sub title {	sub title {
my $self=shift;	my $self=shift;
Line 3769 sub is_practice {	Line 4253 sub is_practice {
sub is_problem {	sub is_problem {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
if ($src =~ /\.(problem\|exam\|quiz\|assess\|survey\|form\|library\|task)$/) {	if ($src =~ /$LONCAPA::assess_re/) {
return !($self->is_practice());	return !($self->is_practice());
}	}
return 0;	return 0;
}	}
	#
	# The has below is the set of status that are considered 'incomplete'
	#
	my %incomplete_hash =
	(
	TRIES_LEFT() => 1,
	OPEN() => 1,
	ATTEMPTED() => 1

	);
	#
	# Return tru if a problem is incomplete... for now incomplete means that
	# any part of the problem is incomplete.
	# Note that if the resources is not a problem, 0 is returned.
	#
	sub is_incomplete {
	my $self = shift;
	if ($self->is_problem()) {
	foreach my $part (@{$self->parts()}) {
	if (exists($incomplete_hash{$self->status($part)})) {
	return 1;
	}
	}
	}
	return 0;

	}
sub is_raw_problem {	sub is_raw_problem {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
if ($src =~ /\.(problem\|exam\|quiz\|assess\|survey\|form\|library\|task)$/) {	if ($src =~ /$LONCAPA::assess_re/) {
return 1;	return 1;
}	}
return 0;	return 0;
Line 3809 sub is_survey {	Line 4320 sub is_survey {
my $self = shift();	my $self = shift();
my $part = shift();	my $part = shift();
my $type = $self->parmval('type',$part);	my $type = $self->parmval('type',$part);
if ($type eq 'survey') {	if (($type eq 'survey') \|\| ($type eq 'surveycred')) {
return 1;	return 1;
}	}
if ($self->src() =~ /\.(survey)$/) {	if ($self->src() =~ /\.(survey)$/) {
Line 3817 sub is_survey {	Line 4328 sub is_survey {
}	}
return 0;	return 0;
}	}
	sub is_anonsurvey {
	my $self = shift();
	my $part = shift();
	my $type = $self->parmval('type',$part);
	if (($type eq 'anonsurvey') \|\| ($type eq 'anonsurveycred')) {
	return 1;
	}
	return 0;
	}
sub is_task {	sub is_task {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
Line 3837 sub parmval {	Line 4357 sub parmval {
if (!defined($part)) {	if (!defined($part)) {
$part = '0';	$part = '0';
}	}
return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());	return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->{SYMB});
}	}

=pod	=pod
Line 3870 resource of the map.	Line 4390 resource of the map.

Returns a string with the type of the map in it.	Returns a string with the type of the map in it.

	=item * B<map_hierarchy>:

	Returns a string with a comma-separated ordered list of map_pc IDs
	for the hierarchy of maps containing a map, with the top level
	map first, then descending to deeper levels, with the enclosing map last.

=back	=back

=cut	=cut
Line 3900 sub map_type {	Line 4426 sub map_type {
my $pc = $self->map_pc();	my $pc = $self->map_pc();
return $self->navHash("map_type_$pc", 0);	return $self->navHash("map_type_$pc", 0);
}	}
	sub map_hierarchy {
	my $self = shift;
	my $pc = $self->map_pc();
	return $self->navHash("map_hierarchy_$pc", 0);
	}

#####	#####
# Property queries	# Property queries
Line 3930 their code.)	Line 4461 their code.)

=over 4	=over 4

=item * B<acc>:
	=item * B<printable>

	returns true if the current date is such that the
	specified resource part is printable.


	=item * B<resprintable>

	Returns true if all parts in the resource are printable making the
	entire resource printable.

	=item * B<acc>

Get the Client IP/Name Access Control information.	Get the Client IP/Name Access Control information.

Line 3983 Get the weight for the problem.	Line 4526 Get the weight for the problem.

=cut	=cut




	sub printable {

	my ($self, $part) = @_;

	# The following cases apply:
	# - If a start date is not set, it is replaced by the open date.
	# - Ditto for start/open replaced by content open.
	# - If neither start nor printdates are set the part is printable.
	# - Start date set but no end date: Printable if now >= start date.
	# - End date set but no start date: Printable if now <= end date.
	# - both defined: printable if start <= now <= end
	#

	# Get the print open/close dates for the resource.

	my $start = $self->parmval("printstartdate", $part);
	my $end = $self->parmval("printenddate", $part);

	if (!$start) {
	$start = $self->parmval("opendate", $part);
	}
	if (!$start) {
	$start = $self->parmval("contentopen", $part);
	}


	my $now = time();


	my $startok = 1;
	my $endok = 1;

	if ((defined $start) && ($start ne '')) {
	$startok = $start <= $now;
	}
	if ((defined $end) && ($end != '')) {
	$endok = $end >= $now;
	}
	return $startok && $endok;
	}

	sub resprintable {
	my $self = shift;

	# get parts...or realize there are no parts.

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

	if (!@parts) {
	return $self->printable(0);
	} else {
	foreach my $part (@parts) {
	if (!$self->printable($part)) {
	return 0;
	}
	}
	return 1;
	}
	}

sub acc {	sub acc {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
my $acc = $self->parmval("acc", $part);	my $acc = $self->parmval("acc", $part);
Line 4003 sub awarded {	Line 4610 sub awarded {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
$self->{NAV_MAP}->get_user_data();	$self->{NAV_MAP}->get_user_data();
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};	return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.awarded'};
}	}
sub taskversion {	sub taskversion {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
$self->{NAV_MAP}->get_user_data();	$self->{NAV_MAP}->get_user_data();
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.version'};	return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.version'};
}	}
sub taskstatus {	sub taskstatus {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
$self->{NAV_MAP}->get_user_data();	$self->{NAV_MAP}->get_user_data();
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$self->taskversion($part).'.'.$part.'.status'};	return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$self->taskversion($part).'.'.$part.'.status'};
}	}
sub solved {	sub solved {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
$self->{NAV_MAP}->get_user_data();	$self->{NAV_MAP}->get_user_data();
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.solved'};	return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.solved'};
}	}
sub checkedin {	sub checkedin {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
Line 4029 sub checkedin {	Line 4636 sub checkedin {
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
if ($self->is_task()) {	if ($self->is_task()) {
my $version = $self->taskversion($part);	my $version = $self->taskversion($part);
return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin.slot'});	return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$version .'.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$version .'.'.$part.'.checkedin.slot'});
} else {	} else {
return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin.slot'});	return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.checkedin.slot'});
}	}
}	}
# this should work exactly like the copy in lonhomework.pm	# this should work exactly like the copy in lonhomework.pm
	# Why is there a copy in lonhomework? Why not centralized?
	#
	# TODO: Centralize duedate.
	#

sub duedate {	sub duedate {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
	if (defined ($self->{DUEDATE_CACHE}->{$part})) {
	return $self->{DUEDATE_CACHE}->{$part};
	}
my $date;	my $date;
my @interval=$self->parmval("interval", $part);	my @interval=$self->parmval("interval", $part);
my $due_date=$self->parmval("duedate", $part);	my $due_date=$self->parmval("duedate", $part);
if ($interval[0] =~ /\d+/) {	if ($interval[0] =~ /\d+/) {
my $first_access=&Apache::lonnet::get_first_access($interval[1],	my $first_access=&Apache::lonnet::get_first_access($interval[1],
$self->symb);	$self->{SYMB});
if (defined($first_access)) {	if (defined($first_access)) {
my $interval = $first_access+$interval[0];	my $interval = $first_access+$interval[0];
$date = (!$due_date \|\| $interval < $due_date) ? $interval	$date = (!$due_date \|\| $interval < $due_date) ? $interval
Line 4053 sub duedate {	Line 4668 sub duedate {
} else {	} else {
$date = $due_date;	$date = $due_date;
}	}
	$self->{DUEDATE_CACHE}->{$part} = $date;
return $date;	return $date;
}	}
sub handgrade {	sub handgrade {
Line 4114 sub weight {	Line 4730 sub weight {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',	my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
$self->symb(), $env{'user.domain'},	$self->{SYMB}, $self->{DOMAIN},
$env{'user.name'},	$self->{USERNAME},
$env{'request.course.sec'});	$env{'request.course.sec'});
return $weight;	return $weight;
}	}
Line 4123 sub part_display {	Line 4739 sub part_display {
my $self= shift(); my $partID = shift();	my $self= shift(); my $partID = shift();
if (! defined($partID)) { $partID = '0'; }	if (! defined($partID)) { $partID = '0'; }
my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',	my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
$self->symb);	$self->{SYMB});
if (! defined($display) \|\| $display eq '') {	if (! defined($display) \|\| $display eq '') {
$display = $partID;	$display = $partID;
}	}
Line 4143 sub getReturnHash {	Line 4759 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},undef,$self->{DOMAIN},$self->{USERNAME});
$self->{RETURN_HASH} = \%tmpHash;	$self->{RETURN_HASH} = \%tmpHash;
}	}
}	}
Line 4208 and use the link as appropriate.	Line 4824 and use the link as appropriate.

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

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

sub discussion_info {	sub discussion_info {
my ($self,$filter) = @_;	my ($self,$filter) = @_;
return $self->{NAV_MAP}->discussion_info($self->symb(),$filter);	return $self->{NAV_MAP}->discussion_info($self->{SYMB},$filter);
}	}

sub getFeedback {	sub getFeedback {
my $self = shift;	my $self = shift;
my $source = $self->src();	my $source = $self->src();
my $symb = $self->symb();	my $symb = $self->{SYMB};
if ($source =~ /^\/res\//) { $source = substr $source, 5; }	if ($source =~ /^\/res\//) { $source = substr $source, 5; }
return $self->{NAV_MAP}->getFeedback($symb,$source);	return $self->{NAV_MAP}->getFeedback($symb,$source);
}	}
Line 4232 sub getFeedback {	Line 4848 sub getFeedback {
sub getErrors {	sub getErrors {
my $self = shift;	my $self = shift;
my $source = $self->src();	my $source = $self->src();
my $symb = $self->symb();	my $symb = $self->{SYMB};
if ($source =~ /^\/res\//) { $source = substr $source, 5; }	if ($source =~ /^\/res\//) { $source = substr $source, 5; }
return $self->{NAV_MAP}->getErrors($symb,$source);	return $self->{NAV_MAP}->getErrors($symb,$source);
}	}
Line 4382 sub extractParts {	Line 4998 sub extractParts {
if ($partorder) {	if ($partorder) {
my @parts;	my @parts;
for my $part (split (/,/,$partorder)) {	for my $part (split (/,/,$partorder)) {
if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {	if (!Apache::loncommon::check_if_partid_hidden($part, $self->{SYMB})) {
push @parts, $part;	push @parts, $part;
$parts{$part} = 1;	$parts{$part} = 1;
}	}
Line 4400 sub extractParts {	Line 5016 sub extractParts {
my $part = $1;	my $part = $1;
# This floods the logs if it blows up	# This floods the logs if it blows up
if (defined($parts{$part})) {	if (defined($parts{$part})) {
&Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());	&Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->{SYMB});
}	}

# check to see if part is turned off.	# check to see if part is turned off.

if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {	if (!Apache::loncommon::check_if_partid_hidden($part, $self->{SYMB})) {
$parts{$part} = 1;	$parts{$part} = 1;
}	}
}	}
}	}
my @sortedParts = sort keys %parts;	my @sortedParts = sort(keys(%parts));
$self->{PARTS} = \@sortedParts;	$self->{PARTS} = \@sortedParts;
}	}

Line 4431 sub extractParts {	Line 5047 sub extractParts {
# So we have to use our knowlege of part names to figure out	# So we have to use our knowlege of part names to figure out
# where the part names begin and end, and even then, it is possible	# where the part names begin and end, and even then, it is possible
# to construct ambiguous situations.	# to construct ambiguous situations.
foreach my $data (split /,/, $metadata) {	foreach my $data (split(/,/, $metadata)) {
if ($data =~ /^([a-zA-Z]+)response_(.*)/	if ($data =~ /^([a-zA-Z]+)response_(.*)/
\|\| $data =~ /^(Task)_(.*)/) {	\|\| $data =~ /^(Task)_(.*)/) {
my $responseType = $1;	my $responseType = $1;
my $partStuff = $2;	my $partStuff = $2;
my $partIdSoFar = '';	my $partIdSoFar = '';
my @partChunks = split /_/, $partStuff;	my @partChunks = split(/_/, $partStuff);
my $i = 0;	my $i = 0;
for ($i = 0; $i < scalar(@partChunks); $i++) {	for ($i = 0; $i < scalar(@partChunks); $i++) {
if ($partIdSoFar) { $partIdSoFar .= '_'; }	if ($partIdSoFar) { $partIdSoFar .= '_'; }
Line 4655 Information not available due to network	Line 5271 Information not available due to network

Attempted, and not yet graded.	Attempted, and not yet graded.

	=item * B<CREDIT_ATTEMPTED>:

	Attempted, and credit received for attempt (survey and anonymous survey only).

=back	=back

=cut	=cut
Line 4666 sub CORRECT { return 13; }	Line 5286 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 ATTEMPTED { return 16; }
	sub CREDIT_ATTEMPTED { return 17; }

sub getCompletionStatus {	sub getCompletionStatus {
my $self = shift;	my $self = shift;
Line 4684 sub getCompletionStatus {	Line 5305 sub getCompletionStatus {
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; }	if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
	if ($status eq 'credit_attempted') {
	if ($self->is_anonsurvey($part) \|\| $self->is_survey($part)) {
	return $self->CREDIT_ATTEMPTED;
	} else {
	return $self->ATTEMPTED;
	}
	}
return $self->NOT_ATTEMPTED;	return $self->NOT_ATTEMPTED;
}	}

Line 4773 The item is open and not yet tried.	Line 5401 The item is open and not yet tried.

The problem has been attempted.	The problem has been attempted.

	=item * B<CREDIT_ATTEMPTED>:

	The problem has been attempted, and credit given for the attempt (survey and anonymous survey only).

=item * B<ANSWER_SUBMITTED>:	=item * B<ANSWER_SUBMITTED>:

An answer has been submitted, but the student should not see it.	An answer has been submitted, but the student should not see it.
Line 4846 sub status {	Line 5478 sub status {
return ATTEMPTED;	return ATTEMPTED;
}	}

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

# If it's EXCUSED, then return that no matter what	# If it's EXCUSED, then return that no matter what
if ($completionStatus == EXCUSED) {	if ($completionStatus == EXCUSED) {
return EXCUSED;	return EXCUSED;
Line 4884 sub status {	Line 5520 sub status {
}	}

# Otherwise, it's untried and open	# Otherwise, it's untried and open
return OPEN;	return OPEN;
}	}

sub check_for_slot {	sub check_for_slot {
my $self = shift;	my $self = shift;
my $part = shift;	my $part = shift;
	my $symb = $self->{SYMB};
my ($use_slots,$available,$availablestudent) = $self->slot_control($part);	my ($use_slots,$available,$availablestudent) = $self->slot_control($part);
if (($use_slots ne '') && ($use_slots !~ /^\sno\s$/i)) {	if (($use_slots ne '') && ($use_slots !~ /^\sno\s$/i)) {
my @slots = (split(/:/,$availablestudent),split(/:/,$available));	my @slots = (split(/:/,$availablestudent),split(/:/,$available));
Line 4897 sub check_for_slot {	Line 5534 sub check_for_slot {
my $cdom=$env{'course.'.$cid.'.domain'};	my $cdom=$env{'course.'.$cid.'.domain'};
my $cnum=$env{'course.'.$cid.'.num'};	my $cnum=$env{'course.'.$cid.'.num'};
my $now = time;	my $now = time;
	my $num_usable_slots = 0;
if (@slots > 0) {	if (@slots > 0) {
my %slots=&Apache::lonnet::get('slots',[@slots],$cdom,$cnum);	my %slots=&Apache::lonnet::get('slots',[@slots],$cdom,$cnum);
if (&Apache::lonnet::error(%slots)) {	if (&Apache::lonnet::error(%slots)) {
return (UNKNOWN);	return (UNKNOWN);
}	}
my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots);	my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots,'starttime');
my ($checkedin,$checkedinslot);	my ($checkedin,$checkedinslot);
foreach my $slot_name (@sorted_slots) {	foreach my $slot_name (@sorted_slots) {
next if (!defined($slots{$slot_name}) \|\|	next if (!defined($slots{$slot_name}) \|\| !ref($slots{$slot_name}));
!ref($slots{$slot_name}));
my $end = $slots{$slot_name}->{'endtime'};	my $end = $slots{$slot_name}->{'endtime'};
my $start = $slots{$slot_name}->{'starttime'};	my $start = $slots{$slot_name}->{'starttime'};
my $ip = $slots{$slot_name}->{'ip'};	my $ip = $slots{$slot_name}->{'ip'};
if ($self->simpleStatus() == OPEN) {	if ($self->simpleStatus() == OPEN) {
my $startreserve = $slots{$slot_name}->{'startreserve'};
my @proctors;
if ($slots{$slot_name}->{'proctor'} ne '') {
@proctors = split(',',$slots{$slot_name}->{'proctor'});
}
if ($end > $now) {	if ($end > $now) {
($checkedin,$checkedinslot) = $self->checkedin();	if ($start > $now) {
if ($startreserve < $now) {	return (RESERVED_LATER,$start,$slot_name);
if ($start > $now) {	} else {
return (RESERVED_LATER,$start,$slot_name);	if ($ip ne '') {
} else {	if (!&Apache::loncommon::check_ip_acc($ip)) {
if ($ip ne '') {	return (RESERVED_LOCATION,$end,$slot_name);
if (!&Apache::loncommon::check_ip_acc($ip)) {
return (RESERVED_LOCATION,$ip,$slot_name);
}
}
if (@proctors > 0) {
unless ((grep(/^\Q$checkedin\E/,@proctors)) &&
($checkedinslot eq $slot_name)) {
return (NEEDS_CHECKIN,undef,$slot_name);
}
}	}
return (RESERVED,$end,$slot_name);
}	}
} else {	my @proctors;
if ($start > $now) {	if ($slots{$slot_name}->{'proctor'} ne '') {
return (RESERVABLE,$startreserve,$slot_name);	@proctors = split(',',$slots{$slot_name}->{'proctor'});
}	}
	if (@proctors > 0) {
	($checkedin,$checkedinslot) = $self->checkedin();
	unless ((grep(/^\Q$checkedin\E/,@proctors)) &&
	($checkedinslot eq $slot_name)) {
	return (NEEDS_CHECKIN,undef,$slot_name);
	}
	}
	return (RESERVED,$end,$slot_name);
}	}
}	}
	} elsif ($end > $now) {
	$num_usable_slots ++;
}	}
}	}
my ($is_correct,$got_grade);	my ($is_correct,$got_grade);
Line 4948 sub check_for_slot {	Line 5580 sub check_for_slot {
my $taskstatus = $self->taskstatus();	my $taskstatus = $self->taskstatus();
$is_correct = (($taskstatus eq 'pass') \|\|	$is_correct = (($taskstatus eq 'pass') \|\|
($self->solved() =~ /^correct_/));	($self->solved() =~ /^correct_/));
$got_grade = ($self->solved() =~ /^(?:pass\|fail)$/);	$got_grade = ($taskstatus =~ /^(?:pass\|fail)$/);
} else {	} else {
$got_grade = 1;	$got_grade = 1;
$is_correct = ($self->solved() =~ /^correct_/);	$is_correct = ($self->solved() =~ /^correct_/);
Line 4961 sub check_for_slot {	Line 5593 sub check_for_slot {
return (CORRECT);	return (CORRECT);
}	}
}	}
return(NOT_IN_A_SLOT);	if ($num_usable_slots) {
} else {
if (!$future_slots_checked) {
$future_slots = &get_future_slots($cdom,$cnum,$now);
$future_slots_checked = 1;
}
if ($future_slots) {
return(NOT_IN_A_SLOT);	return(NOT_IN_A_SLOT);
}	}
return(NOTRESERVABLE);
}	}
}	my $reservable = &Apache::lonnet::get_reservable_slots($cnum,$cdom,$env{'user.name'},
return;	$env{'user.domain'});
}	if (ref($reservable) eq 'HASH') {
	my ($map) = &Apache::lonnet::decode_symb($symb);
sub get_future_slots {	if ((ref($reservable->{'now_order'}) eq 'ARRAY') && (ref($reservable->{'now'}) eq 'HASH')) {
my ($cdom,$cnum,$now) = @_;	foreach my $slot (reverse (@{$reservable->{'now_order'}})) {
my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);	my $canuse;
my $future_slots = 0;	if ($reservable->{'now'}{$slot}{'symb'} eq '') {
foreach my $slot (keys(%slots)) {	$canuse = 1;
if (($slots{$slot}->{'starttime'} > $now) &&	} else {
($slots{$slot}->{'endtime'} > $now)) {	my %oksymbs;
$future_slots ++;	my @slotsymbs = split(/\s,\s/,$reservable->{'now'}{$slot}{'symb'});
	map { $oksymbs{$_} = 1; } @slotsymbs;
	if ($oksymbs{$symb}) {
	$canuse = 1;
	} else {
	foreach my $item (@slotsymbs) {
	if ($item =~ /\.(page\|sequence)$/) {
	(undef,undef, my $sloturl) = &Apache::lonnet::decode_symb($item);
	if (($map ne '') && ($map eq $sloturl)) {
	$canuse = 1;
	last;
	}
	}
	}
	}
	}
	if ($canuse) {
	return(RESERVABLE,$reservable->{'now'}{$slot}{'endreserve'});
	}
	}
	}
	if ((ref($reservable->{'future_order'}) eq 'ARRAY') && (ref($reservable->{'future'}) eq 'HASH')) {
	foreach my $slot (@{$reservable->{'future_order'}}) {
	my $canuse;
	if ($reservable->{'future'}{$slot}{'symb'} eq '') {
	$canuse = 1;
	} elsif ($reservable->{'future'}{$slot}{'symb'} =~ /,/) {
	my %oksymbs;
	my @slotsymbs = split(/\s,\s/,$reservable->{'future'}{$slot}{'symb'});
	map { $oksymbs{$_} = 1; } @slotsymbs;
	if ($oksymbs{$symb}) {
	$canuse = 1;
	} else {
	foreach my $item (@slotsymbs) {
	if ($item =~ /\.(page\|sequence)$/) {
	(undef,undef, my $sloturl) = &Apache::lonnet::decode_symb($item);
	if (($map ne '') && ($map eq $sloturl)) {
	$canuse = 1;
	last;
	}
	}
	}
	}
	} elsif ($reservable->{'future'}{$slot}{'symb'} eq $symb) {
	$canuse = 1;
	}
	if ($canuse) {
	return(RESERVABLE_LATER,$reservable->{'future'}{$slot}{'startreserve'});
	}
	}
	}
}	}
	return(NOTRESERVABLE);
}	}
return $future_slots;	return;
}	}

sub CLOSED { return 23; }	sub CLOSED { return 23; }
Line 5038 my %compositeToSimple =	Line 5714 my %compositeToSimple =
INCORRECT() => INCORRECT,	INCORRECT() => INCORRECT,
OPEN() => OPEN,	OPEN() => OPEN,
ATTEMPTED() => ATTEMPTED,	ATTEMPTED() => ATTEMPTED,
	CREDIT_ATTEMPTED() => CORRECT,
ANSWER_SUBMITTED() => ATTEMPTED	ANSWER_SUBMITTED() => ATTEMPTED
);	);

Line 5112 sub completable {	Line 5789 sub completable {
# and it is not "attempted" (manually graded problem), it is	# and it is not "attempted" (manually graded problem), it is
# not "complete"	# not "complete"
if ($self->getCompletionStatus($part) == ATTEMPTED() \|\|	if ($self->getCompletionStatus($part) == ATTEMPTED() \|\|
	$self->getCompletionStatus($part) == CREDIT_ATTEMPTED() \|\|
$status == ANSWER_SUBMITTED() ) {	$status == ANSWER_SUBMITTED() ) {
# did this part already, as well as we can	# did this part already, as well as we can
next;	next;
Line 5127 sub completable {	Line 5805 sub completable {

=pod	=pod

	B<Answerable>

	The answerable method differs from the completable method in its handling of problem parts
	for which feedback on correctness is suppressed, but the student still has tries left, and
	the problem part is not past due, (i.e., the student could submit a different answer if
	he/she so chose). For that case completable will return 0, whereas answerable will return 1.

	=cut

	sub answerable {
	my $self = shift;
	if (!$self->is_problem()) { return 0; }
	my $partCount = $self->countParts();
	foreach my $part (@{$self->parts()}) {
	if ($part eq '0' && $partCount != 1) { next; }
	my $status = $self->status($part);
	if ($self->getCompletionStatus($part) == ATTEMPTED() \|\|
	$self->getCompletionStatus($part) == CREDIT_ATTEMPTED() \|\|
	$status == ANSWER_SUBMITTED() ) {
	if ($self->tries($part) < $self->maxtries($part) \|\| !$self->maxtries($part)) {
	return 1;
	}
	}
	if ($status == OPEN() \|\| $status == TRIES_LEFT() \|\| $status == NETWORK_FAILURE()) {
	return 1;
	}
	}
	# None of the parts were answerable, so neither is this problem.
	return 0;
	}

	=pod

=head2 Resource/Nav Map Navigation	=head2 Resource/Nav Map Navigation

=over 4	=over 4
Line 5162 sub getPrevious {	Line 5873 sub getPrevious {
my $self = shift;	my $self = shift;
my @branches;	my @branches;
my $from = $self->from();	my $from = $self->from();
foreach my $branch ( split /,/, $from) {	foreach my $branch ( split(/,/, $from)) {
my $choice = $self->{NAV_MAP}->getById($branch);	my $choice = $self->{NAV_MAP}->getById($branch);
my $prev = $choice->comesfrom();	my $prev = $choice->comesfrom();
$prev = $self->{NAV_MAP}->getById($prev);	$prev = $self->{NAV_MAP}->getById($prev);
Line 5174 sub getPrevious {	Line 5885 sub getPrevious {

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

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

=pod	=pod

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

Removed from v.1.437
changed lines
	Added in v.1.517