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.313 and 1.388

version 1.313, 2005/01/26 22:52:25	version 1.388, 2006/06/26 22:31:56
Line 30	Line 30
package Apache::lonnavmaps;	package Apache::lonnavmaps;

use strict;	use strict;
	use GDBM_File;
use Apache::Constants qw(:common :http);	use Apache::Constants qw(:common :http);
use Apache::loncommon();	use Apache::loncommon();
use Apache::lonmenu();	use Apache::lonmenu();
Line 38 use Apache::lonlocal;	Line 39 use Apache::lonlocal;
use Apache::lonnet;	use Apache::lonnet;
use POSIX qw (floor strftime);	use POSIX qw (floor strftime);
use Data::Dumper; # for debugging, not always	use Data::Dumper; # for debugging, not always
	use Time::HiRes qw( gettimeofday tv_interval );
	use lib '/home/httpd/lib/perl/';
	use LONCAPA;

# symbolic constants	# symbolic constants
sub SYMB { return 1; }	sub SYMB { return 1; }
Line 55 my %statusIconMap =	Line 59 my %statusIconMap =
$resObj->CLOSED => '',	$resObj->CLOSED => '',
$resObj->OPEN => 'navmap.open.gif',	$resObj->OPEN => 'navmap.open.gif',
$resObj->CORRECT => 'navmap.correct.gif',	$resObj->CORRECT => 'navmap.correct.gif',
	$resObj->PARTIALLY_CORRECT => 'navmap.partial.gif',
$resObj->INCORRECT => 'navmap.wrong.gif',	$resObj->INCORRECT => 'navmap.wrong.gif',
$resObj->ATTEMPTED => 'navmap.ellipsis.gif',	$resObj->ATTEMPTED => 'navmap.ellipsis.gif',
$resObj->ERROR => ''	$resObj->ERROR => ''
Line 79 my %colormap =	Line 84 my %colormap =
$resObj->OPEN => '',	$resObj->OPEN => '',
$resObj->NOTHING_SET => '',	$resObj->NOTHING_SET => '',
$resObj->ATTEMPTED => '',	$resObj->ATTEMPTED => '',
$resObj->ANSWER_SUBMITTED => ''	$resObj->ANSWER_SUBMITTED => '',
	$resObj->PARTIALLY_CORRECT => '#006600'
);	);
# And a special case in the nav map; what to do when the assignment	# And a special case in the nav map; what to do when the assignment
# is not yet done and due in less then 24 hours	# is not yet done and due in less then 24 hours
my $hurryUpColor = "#FF0000";	my $hurryUpColor = "#FF0000";

sub launch_win {	sub launch_win {
my ($mode,$script,$toplinkitems)=@_;	my ($mode,$script,$toplinkitems,$firsttime)=@_;
my $result;	my $result;
if ($script ne 'no') {	if ($script ne 'no') {
$result.='<script type="text/javascript">';	$result.='<script type="text/javascript">';
}	}
$result.='function launch_navmapwin() {	if ($firsttime) {
	$result.='function launch_navmapwin() {
	newWindow=open(\'/adm/navmaps?launchExternalRoles\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
	}';
	} else {
	$result.='function launch_navmapwin() {
newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');	newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
}';	}';
	}
if ($mode eq 'now') {	if ($mode eq 'now') {
$result.="\nlaunch_navmapwin();\n";	$result.="\nlaunch_navmapwin();\n";
}	}
Line 108 sub launch_win {	Line 120 sub launch_win {
}	}

sub close {	sub close {
if ($ENV{'environment.remotenavmap'} ne 'on') { return ''; }	if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
return(<<ENDCLOSE);	return(<<ENDCLOSE);
<script type="text/javascript">	<script type="text/javascript">
window.status='Accessing Nav Control';	window.status='Accessing Nav Control';
Line 122 ENDCLOSE	Line 134 ENDCLOSE
}	}

sub update {	sub update {
if ($ENV{'environment.remotenavmap'} ne 'on') { return ''; }	if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
if (!$ENV{'request.course.id'}) { return ''; }	if (!$env{'request.course.id'}) { return ''; }
if ($ENV{'REQUEST_URI'}=~m\|^/adm/navmaps\|) { return ''; }	if ($ENV{'REQUEST_URI'}=~m\|^/adm/navmaps\|) { return ''; }
return(<<ENDUPDATE);	return(<<ENDUPDATE);
<form name="navform"></form>	<form name="navform"></form>
Line 142 sub handler {	Line 154 sub handler {

sub real_handler {	sub real_handler {
my $r = shift;	my $r = shift;
	#my $t0=[&gettimeofday()];
# Handle header-only request	# Handle header-only request
if ($r->header_only) {	if ($r->header_only) {
if ($ENV{'browser.mathml'}) {	if ($env{'browser.mathml'}) {
&Apache::loncommon::content_type($r,'text/xml');	&Apache::loncommon::content_type($r,'text/xml');
} else {	} else {
&Apache::loncommon::content_type($r,'text/html');	&Apache::loncommon::content_type($r,'text/html');
Line 155 sub real_handler {	Line 167 sub real_handler {
}	}

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

my %toplinkitems=();	my %toplinkitems=();
&add_linkitem(\%toplinkitems,'blank','',"Select Action");	&add_linkitem(\%toplinkitems,'blank','',"Select Action");
Line 184 MENU	Line 195 MENU
$navstatus	$navstatus
MENU	MENU
}	}
$r->print(<<"ENDSUBM");	$r->send_http_header;
<html>	my $js =<<"ENDSUBM";
<head>
<script type="text/javascript">	<script type="text/javascript">
function submitthis() {	function submitthis() {
$menu	$menu
Line 194 MENU	Line 204 MENU
}	}

</script>	</script>
</head>
<body bgcolor="#FFFFFF" onLoad="submitthis()"></body>
</html>
ENDSUBM	ENDSUBM
return;	$r->print(&Apache::loncommon::start_page(undef,$js,
	{'only_body' => 1,
	'bgcolor' => '#FFFFFF',
	'add_entries' =>
	{'onload' =>
	"submitthis()"}}).
	&Apache::loncommon::end_page());

	return OK;
}	}
if ($ENV{QUERY_STRING} eq 'launchExternal') {	if ($ENV{QUERY_STRING} =~ /^launchExternal/) {
&Apache::lonnet::put('environment',{'remotenavmap' => 'on'});	&Apache::lonnet::put('environment',{'remotenavmap' => 'on'});
&Apache::lonnet::appenv('environment.remotenavmap' => 'on');	&Apache::lonnet::appenv('environment.remotenavmap' => 'on');
	my $menu=&Apache::lonmenu::reopenmenu();
	my $navstatus=&Apache::lonmenu::get_nav_status();
	if ($menu) {
	$r->print(<<MENU);
	<script type="text/javascript">
	swmenu=$menu
	swmenu.clearTimeout(swmenu.menucltim);
	$navstatus
	</script>
	MENU
	}
	}
	if ($ENV{QUERY_STRING} eq 'turningOffExternal') {
	$env{'environment.remotenavmap'}='off';
}	}

# Create the nav map	# Create the nav map
Line 210 ENDSUBM	Line 239 ENDSUBM

if (!defined($navmap)) {	if (!defined($navmap)) {
my $requrl = $r->uri;	my $requrl = $r->uri;
$ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";	$env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
return HTTP_NOT_ACCEPTABLE;	return HTTP_NOT_ACCEPTABLE;
}	}
	$r->send_http_header;

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

# ----------------------------------------------------- Force menu registration	# ----------------------------------------------------- Force menu registration
my $addentries='';
my $more_unload;
my $body_only='';	my $body_only='';
if ($ENV{'environment.remotenavmap'} eq 'on') {	my $js;
$r->print('<script type="text/javascript">	if ($env{'environment.remotenavmap'} eq 'on') {
function collapse() {	$js='<script type="text/javascript">
this.document.location="/adm/navmaps?collapseExternal";	function collapse() {
}	this.document.location="/adm/navmaps?collapseExternal";
</script>');	}
# FIXME need to be smarter to only catch window close events	</script>';
# $more_unload="collapse()"
$body_only=1;	$body_only=1;
}	}
if ($ENV{'form.register'}) {
$addentries=' onLoad="'.&Apache::lonmenu::loadevents().
'" onUnload="'.&Apache::lonmenu::unloadevents().';'.
$more_unload.'"';
$r->print(&Apache::lonmenu::registerurl(1));
} else {
$addentries=' onUnload="'.$more_unload.'"';
}

# Header	# Header
$r->print('</head>'.	my $course_type = &Apache::loncommon::course_type();
&Apache::loncommon::bodytag('Navigate Course Contents','',	$r->print(&Apache::loncommon::start_page('Navigate '.$course_type.
$addentries,$body_only,'',	' Contents',
$ENV{'form.register'}));	$js,
$r->print('<script>window.focus();</script>');	{'only_body' => $body_only,
	'force_register' =>
	$env{'form.register'},}));
	$r->print('<script type="text/javascript">window.focus();</script>');

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

# Check that it's defined	# Check that it's defined
if (!($navmap->courseMapDefined())) {	if (!($navmap->courseMapDefined())) {
$r->print(&Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT'));	$r->print(&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT'));
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .	$r->print('<span class="LC_error">'.&mt('Coursemap undefined.').
'</body></html>');	'</span>' .
	&Apache::loncommon::end_page());
return OK;	return OK;
}	}

Line 277 ENDSUBM	Line 298 ENDSUBM
if ($sequenceCount == 1) {	if ($sequenceCount == 1) {
# The automatic iterator creation in the render call	# The automatic iterator creation in the render call
# will pick this up. We know the condition because	# will pick this up. We know the condition because
# the defined($ENV{'form.filter'}) also ensures this	# the defined($env{'form.filter'}) also ensures this
# is a fresh call.	# is a fresh call.
$ENV{'form.filter'} = "$sequenceId";	$env{'form.filter'} = "$sequenceId";
}	}
}	}

if ($ENV{QUERY_STRING} eq 'launchExternal') {	if ($ENV{QUERY_STRING} eq 'launchExternal') {
$r->print('	$r->print('
<form name="returnwin" action="/adm/flip?postdata=return%3a"	<form name="returnwin" action="/adm/flip?postdata=navlaunch%3a"
method="post" target="loncapaclient">	method="post" target="loncapaclient">
</form>');	</form>');
$r->print('	$r->print('
Line 294 ENDSUBM	Line 315 ENDSUBM
</script>');	</script>');
}	}

if ($ENV{'environment.remotenavmap'} ne 'on') {	if ($env{'environment.remotenavmap'} ne 'on') {
$r->print(&launch_win('link','yes',\%toplinkitems));	$r->print(&launch_win('link','yes',\%toplinkitems));
}	}
if ($ENV{'environment.remotenavmap'} eq 'on') {	if ($env{'environment.remotenavmap'} eq 'on') {
&add_linkitem(\%toplinkitems,'closenav','collapse()',	&add_linkitem(\%toplinkitems,'closenav','collapse()',
"Close navigation window");	"Close navigation window");
}	}

my $jumpToFirstHomework = 0;
# Check to see if the student is jumping to next open, do-able problem	# Check to see if the student is jumping to next open, do-able problem
if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {	if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
$jumpToFirstHomework = 1;
# Find the next homework problem that they can do.	# Find the next homework problem that they can do.
my $iterator = $navmap->getIterator(undef, undef, undef, 1);	my $iterator = $navmap->getIterator(undef, undef, undef, 1);
my $curRes;	my $curRes;
my $foundDoableProblem = 0;	my $foundDoableProblem = 0;
my $problemRes;	my $minimumduedate;

while (($curRes = $iterator->next()) && !$foundDoableProblem) {	while ($curRes = $iterator->next()) {
if (ref($curRes) && $curRes->is_problem()) {	if (ref($curRes) && $curRes->is_problem()) {
my $status = $curRes->status();	my $status = $curRes->status();
if ($curRes->completable()) {	if ($curRes->completable()) {
$problemRes = $curRes;	my $thisduedate=$curRes->duedate();
	unless ($foundDoableProblem) {
	$minimumduedate=$thisduedate;
	}

$foundDoableProblem = 1;	$foundDoableProblem = 1;

# Pop open all previous maps	if ($thisduedate<=$minimumduedate) {
my $stack = $iterator->getStack();	# Pop open all previous maps
pop @$stack; # last resource in the stack is the problem	my $stack = $iterator->getStack();
# itself, which we don't need in the map stack	pop @$stack; # last resource in the stack is the problem
my @mapPcs = map {$_->map_pc()} @$stack;	# itself, which we don't need in the map stack
$ENV{'form.filter'} = join(',', @mapPcs);	my @mapPcs = map {$_->map_pc()} @$stack;
	$env{'form.filter'} = join(',', @mapPcs);
# Mark as both "here" and "jump"
$ENV{'form.postsymb'} = $curRes->symb();	# Mark as both "here" and "jump"
	$env{'form.postsymb'} = $curRes->symb();
	$minimumduedate=$thisduedate;
	}
}	}
}	}
}	}
Line 339 ENDSUBM	Line 366 ENDSUBM
} else {	} else {
&add_linkitem(\%toplinkitems,'firsthomework',	&add_linkitem(\%toplinkitems,'firsthomework',
'location.href="navmaps?jumpToFirstHomework"',	'location.href="navmaps?jumpToFirstHomework"',
"Show Me My First Homework Problem");	"Show my first due problem");
}	}

my $suppressEmptySequences = 0;	my $suppressEmptySequences = 0;
Line 348 ENDSUBM	Line 375 ENDSUBM

# Display only due homework.	# Display only due homework.
my $showOnlyHomework = 0;	my $showOnlyHomework = 0;
if ($ENV{'form.showOnlyHomework'} eq "1") {	if ($env{'form.showOnlyHomework'} eq "1") {
$showOnlyHomework = 1;	$showOnlyHomework = 1;
$suppressEmptySequences = 1;	$suppressEmptySequences = 1;
$filterFunc = sub { my $res = shift;	$filterFunc = sub { my $res = shift;
return $res->completable() \|\| $res->is_map();	return $res->completable() \|\| $res->is_map();
};	};
&add_linkitem(\%toplinkitems,'everything',	&add_linkitem(\%toplinkitems,'everything',
'location.href="navmaps?sort='.$ENV{'form.sort'}.'"',	'location.href="navmaps?sort='.$env{'form.sort'}.'"',
"Show Everything");	"Show everything");
$r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");	$r->print("<p><font size='+2'>".&mt("Uncompleted Problems")."</font></p>");
$ENV{'form.filter'} = '';	$env{'form.filter'} = '';
$ENV{'form.condition'} = 1;	$env{'form.condition'} = 1;
$resource_no_folder_link = 1;	$resource_no_folder_link = 1;
} else {	} else {
&add_linkitem(\%toplinkitems,'uncompleted',	&add_linkitem(\%toplinkitems,'uncompleted',
'location.href="navmaps?sort='.$ENV{'form.sort'}.	'location.href="navmaps?sort='.$env{'form.sort'}.
'&showOnlyHomework=1"',	'&showOnlyHomework=1"',
"Show Only Uncompleted Homework");	"Show only uncompleted problems");
}	}

my %selected=($ENV{'form.sort'} => 'selected=on');	my %selected=($env{'form.sort'} => 'selected=on');
my $sort_html=("<form>	my $sort_html=("<form>
<nobr>	<nobr>
<input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$ENV{'form.showOnlyHomework'}."\" />	<input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$env{'form.showOnlyHomework'}."\" />
<input type=\"submit\" value=\"".&mt('Sort by:')."\" />	<input type=\"submit\" value=\"".&mt('Sort by:')."\" />
<select name=\"sort\">	<select name=\"sort\">
<option value=\"default\" $selected{'default'}>".&mt('Default')."</option>	<option value=\"default\" $selected{'default'}>".&mt('Default')."</option>
Line 383 ENDSUBM	Line 410 ENDSUBM
</form>");	</form>");
# renderer call	# renderer call
my $renderArgs = { 'cols' => [0,1,2,3],	my $renderArgs = { 'cols' => [0,1,2,3],
'sort' => $ENV{'form.sort'},	'sort' => $env{'form.sort'},
'url' => '/adm/navmaps',	'url' => '/adm/navmaps',
'navmap' => $navmap,	'navmap' => $navmap,
'suppressNavmap' => 1,	'suppressNavmap' => 1,
Line 405 ENDSUBM	Line 432 ENDSUBM
$r->print("<p><font size='+1'>This course is empty.</font></p>");	$r->print("<p><font size='+1'>This course is empty.</font></p>");
}	}
}	}
	#my $td=&tv_interval($t0);
	#$r->print("<br />$td");

$r->print("</body></html>");	$r->print(&Apache::loncommon::end_page());
$r->rflush();	$r->rflush();

return OK;	return OK;
Line 445 sub getLinkForResource {	Line 474 sub getLinkForResource {
my $anchor;	my $anchor;
if ($res->is_page()) {	if ($res->is_page()) {
foreach (@$stack) { if (defined($_)) { $anchor = $_; } }	foreach (@$stack) { if (defined($_)) { $anchor = $_; } }
$anchor=&Apache::lonnet::escape($anchor->shown_symb());	$anchor=&escape($anchor->shown_symb());
return ($res->link(),$res->shown_symb(),$anchor);	return ($res->link(),$res->shown_symb(),$anchor);
}	}
# in case folder was skipped over as "only sequence"	# in case folder was skipped over as "only sequence"
my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());	my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
if ($map=~/\.page$/) {	if ($map=~/\.page$/) {
my $url=&Apache::lonnet::clutter($map);	my $url=&Apache::lonnet::clutter($map);
$anchor=&Apache::lonnet::escape($src->shown_symb());	$anchor=&escape($src->shown_symb());
return ($url,$res->shown_symb(),$anchor);	return ($url,$res->shown_symb(),$anchor);
}	}
}	}
Line 487 sub getDescription {	Line 516 sub getDescription {
return &mt("Not currently assigned.");	return &mt("Not currently assigned.");
}	}
if ($status == $res->OPEN_LATER) {	if ($status == $res->OPEN_LATER) {
return "Open " . timeToHumanString($res->opendate($part));	return "Open " . timeToHumanString($res->opendate($part),'start');
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
if ($res->duedate($part)) {	if ($res->duedate($part)) {
return &mt("Due")." " .timeToHumanString($res->duedate($part));	return &mt("Due")." " .timeToHumanString($res->duedate($part),'end');
} else {	} else {
return &mt("Open, no due date");	return &mt("Open, no due date");
}	}
}	}
if ($status == $res->PAST_DUE_ANSWER_LATER) {	if ($status == $res->PAST_DUE_ANSWER_LATER) {
return &mt("Answer open")." " . timeToHumanString($res->answerdate($part));	return &mt("Answer open")." " . timeToHumanString($res->answerdate($part),'start');
}	}
if ($status == $res->PAST_DUE_NO_ANSWER) {	if ($status == $res->PAST_DUE_NO_ANSWER) {
return &mt("Was due")." " . timeToHumanString($res->duedate($part));	return &mt("Was due")." " . timeToHumanString($res->duedate($part),'end');
}	}
if ($status == $res->ANSWER_OPEN) {	if (($status == $res->ANSWER_OPEN \|\| $status == $res->PARTIALLY_CORRECT)
	&& $res->handgrade($part) ne 'yes') {
return &mt("Answer available");	return &mt("Answer available");
}	}
if ($status == $res->EXCUSED) {	if ($status == $res->EXCUSED) {
Line 522 sub getDescription {	Line 552 sub getDescription {
}	}
}	}
if ($res->duedate($part)) {	if ($res->duedate($part)) {
return &mt("Due")." " . timeToHumanString($res->duedate($part)) .	return &mt("Due")." " . timeToHumanString($res->duedate($part),'end') .
" $triesString";	" $triesString";
} else {	} else {
return &mt("No due date")." $triesString";	return &mt("No due date")." $triesString";
Line 560 sub lastTry {	Line 590 sub lastTry {
$res->duedate($part) > time();	$res->duedate($part) > time();
}	}

# This puts a human-readable name on the ENV variable.	# This puts a human-readable name on the env variable.

sub advancedUser {	sub advancedUser {
return $ENV{'request.role.adv'};	return $env{'request.role.adv'};
}	}


Line 575 sub advancedUser {	Line 605 sub advancedUser {
# print "Answer available $timestring"	# print "Answer available $timestring"
# Very, very, very, VERY English-only... goodness help a localizer on	# Very, very, very, VERY English-only... goodness help a localizer on
# this func...	# this func...


sub timeToHumanString {	sub timeToHumanString {
my ($time) = @_;	my ($time,$type,$format) = @_;

# zero, '0' and blank are bad times	# zero, '0' and blank are bad times
if (!$time) {	if (!$time) {
return &mt('never');	return &mt('never');
Line 647 sub timeToHumanString {	Line 680 sub timeToHumanString {
return "$prefix$hourString$minuteString$tense";	return "$prefix$hourString$minuteString$tense";
}	}

	# If there's a caller supplied format, use it.

	if($format ne '') {
	my $timeStr = strftime($format, localtime($time));
	return $timeStr.&Apache::lonlocal::gettimezone($time);
	}

# Less then 5 days away, display day of the week and	# Less then 5 days away, display day of the week and
# HH:MM	# HH:MM

if ( $delta < $day * 5 ) {	if ( $delta < $day * 5 ) {
my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));	my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
$timeStr =~ s/12:00 am/00:00/;	$timeStr =~ s/12:00 am/00:00/;
$timeStr =~ s/12:00 pm/noon/;	$timeStr =~ s/12:00 pm/noon/;
return ($inPast ? "last " : "next ") .	return ($inPast ? "last " : "this ") .
$timeStr;	$timeStr.&Apache::lonlocal::gettimezone($time);
}	}

	my $conjunction='on';
	if ($type eq 'start') {
	$conjunction='at';
	} elsif ($type eq 'end') {
	$conjunction='by';
	}
# Is it this year?	# Is it this year?
if ( $time[5] == $now[5]) {	if ( $time[5] == $now[5]) {
# Return on Month Day, HH:MM meridian	# Return on Month Day, HH:MM meridian
my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));	my $timeStr = strftime("$conjunction %A, %b %e at %I:%M %P", localtime($time));
$timeStr =~ s/12:00 am/00:00/;	$timeStr =~ s/12:00 am/00:00/;
$timeStr =~ s/12:00 pm/noon/;	$timeStr =~ s/12:00 pm/noon/;
return $timeStr;	return $timeStr.&Apache::lonlocal::gettimezone($time);
}	}

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

Line 866 automatically.	Line 913 automatically.

=over 4	=over 4

=item * B<iterator>: default: constructs one from %ENV	=item * B<iterator>: default: constructs one from %env

A reference to a fresh ::iterator to use from the navmaps. The	A reference to a fresh ::iterator to use from the navmaps. The
rendering will reflect the options passed to the iterator, so you can	rendering will reflect the options passed to the iterator, so you can
use that to just render a certain part of the course, if you like. If	use that to just render a certain part of the course, if you like. If
one is not passed, the renderer will attempt to construct one from	one is not passed, the renderer will attempt to construct one from
ENV{'form.filter'} and ENV{'form.condition'} information, plus the	env{'form.filter'} and env{'form.condition'} information, plus the
'iterator_map' parameter if any.	'iterator_map' parameter if any.

=item * B<iterator_map>: default: not used	=item * B<iterator_map>: default: not used
Line 882 instruct the renderer to render only a p	Line 929 instruct the renderer to render only a p
the source of the map you want to process, like	the source of the map you want to process, like
'/res/103/jerf/navmap.course.sequence'.	'/res/103/jerf/navmap.course.sequence'.

=item * B<navmap>: default: constructs one from %ENV	=item * B<navmap>: default: constructs one from %env

A reference to a navmap, used only if an iterator is not passed in. If	A reference to a navmap, used only if an iterator is not passed in. If
this is necessary to make an iterator but it is not passed in, a new	this is necessary to make an iterator but it is not passed in, a new
one will be constructed based on ENV info. This is useful to do basic	one will be constructed based on env info. This is useful to do basic
error checking before passing it off to render.	error checking before passing it off to render.

=item * B<r>: default: must be passed in	=item * B<r>: default: must be passed in
Line 912 then only one line will be displayed for	Line 959 then only one line will be displayed for
all parts will always be displayed. If showParts is 0, this is	all parts will always be displayed. If showParts is 0, this is
ignored.	ignored.

=item * B<jumpCount>: default: determined from %ENV	=item * B<jumpCount>: default: determined from %env

A string identifying the URL to place the anchor 'curloc' at.	A string identifying the URL to place the anchor 'curloc' at.
It is the responsibility of the renderer user to	It is the responsibility of the renderer user to
ensure that the #curloc is in the URL. By default, determined through	ensure that the #curloc is in the URL. By default, determined through
the use of the ENV{} 'jump' information, and should normally "just	the use of the env{} 'jump' information, and should normally "just
work" correctly.	work" correctly.

=item * B<here>: default: empty string	=item * B<here>: default: empty string
Line 945 are allowing the user to open and close	Line 992 are allowing the user to open and close

Describes the currently-open row number to cause the browser to jump	Describes the currently-open row number to cause the browser to jump
to, because the user just opened that folder. By default, pulled from	to, because the user just opened that folder. By default, pulled from
the Jump information in the ENV{'form.*'}.	the Jump information in the env{'form.*'}.

=item * B<printKey>: default: false	=item * B<printKey>: default: false

Line 1020 sub render_resource {	Line 1067 sub render_resource {
# it will be quoted with ' in the href.	# it will be quoted with ' in the href.

my ($left,$right) = split(/\?/, $link);	my ($left,$right) = split(/\?/, $link);
$left =~ s/'/\\'/g;
$link = $left.'?'.$right;	$link = $left.'?'.$right;

my $src = $resource->src();	my $src = $resource->src();
Line 1034 sub render_resource {	Line 1080 sub render_resource {
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");	my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");
# If this is a new branch, label it so	# If this is a new branch, label it so
if ($params->{'isNewBranch'}) {	if ($params->{'isNewBranch'}) {
$newBranchText = "<img src='$location/branch.gif' border='0' />";	$newBranchText = "<img src='$location/branch.gif' border='0' alt='Branch' />";
}	}

# links to open and close the folder	# links to open and close the folder


my $linkopen = "<a href='$link'>";	my $linkopen = "<a href=\"$link\">";


my $linkclose = "</a>";	my $linkclose = "</a>";

# Default icon: unknown page	# Default icon: unknown page
my $icon = "<img src='$location/unknown.gif' alt='' border='0' />";	my $icon = "<img src='$location/unknown.gif' alt='' border='0' alt='  ' ' />";

if ($resource->is_problem()) {	if ($resource->is_problem()) {
if ($part eq '0' \|\| $params->{'condensed'}) {	if ($part eq '0' \|\| $params->{'condensed'}) {
$icon ='<img src="'.$location.'/problem.gif" alt="" border="0" />';	$icon ='<img src="'.$location.'/problem.gif" alt="'.&mt('Problem').'" border="0" />';
} else {	} else {
$icon = $params->{'indentString'};	$icon = $params->{'indentString'};
}	}
} else {	} else {
$icon = "<img src='".&Apache::loncommon::lonhttpdurl(&Apache::loncommon::icon($resource->src))."' alt='' border='0' />";	$icon = "<img src='".&Apache::loncommon::icon($resource->src)."' alt='  ' border='0' />";
}	}

# Display the correct map icon to open or shut map	# Display the correct map icon to open or shut map
Line 1067 sub render_resource {	Line 1113 sub render_resource {
}	}

my $folderType = $resource->is_sequence() ? 'folder' : 'page';	my $folderType = $resource->is_sequence() ? 'folder' : 'page';
	my $title=$resource->title;
	$title=~s/\"/\"/g;
if (!$params->{'resource_no_folder_link'}) {	if (!$params->{'resource_no_folder_link'}) {
$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';	$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
$icon = "<img src='$location/$icon' alt='' border='0' />";	$icon = "<img src='$location/$icon' alt=\"".
	($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";

$linkopen = "<a href='" . $params->{'url'} . '?' .	$linkopen = "<a href=\"" . $params->{'url'} . '?' .
$params->{'queryString'} . '&filter=';	$params->{'queryString'} . '&filter=';
$linkopen .= ($nowOpen xor $it->{CONDITION}) ?	$linkopen .= ($nowOpen xor $it->{CONDITION}) ?
addToFilter($filter, $mapId) :	addToFilter($filter, $mapId) :
removeFromFilter($filter, $mapId);	removeFromFilter($filter, $mapId);
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='	$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
. $params->{'hereType'} . '&here=' .	. $params->{'hereType'} . '&here=' .
&Apache::lonnet::escape($params->{'here'}) .	&escape($params->{'here'}) .
'&jump=' .	'&jump=' .
&Apache::lonnet::escape($resource->symb()) .	&escape($resource->symb()) .
"&folderManip=1'>";	"&folderManip=1\">";

} else {	} else {
# Don't allow users to manipulate folder	# Don't allow users to manipulate folder
$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .	$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
'.nomanip.gif';	'.nomanip.gif';
$icon = "<img src='$location/$icon' alt='' border='0' />";	$icon = "<img src='$location/$icon' alt=\"".
	($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";

$linkopen = "";	$linkopen = "";
$linkclose = "";	$linkclose = "";
Line 1096 sub render_resource {	Line 1145 sub render_resource {
}	}

if ($resource->randomout()) {	if ($resource->randomout()) {
$nonLinkedText .= ' <i>(hidden)</i> ';	$nonLinkedText .= ' <i>('.&mt('hidden').')</i> ';
	}
	if (!$resource->condval()) {
	$nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> ';
}	}

# We're done preparing and finally ready to start the rendering	# We're done preparing and finally ready to start the rendering
Line 1120 sub render_resource {	Line 1172 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 = '<font color="red" size="+2">> </font>';	$curMarkerBegin = '<font color="red" size="+2">></font>';
$curMarkerEnd = '<font color="red" size="+2"><</font>';	$curMarkerEnd = '<font color="red" size="+2"><</font>';
$params->{'displayedHereMarker'} = 1;	$params->{'displayedHereMarker'} = 1;
}	}
Line 1128 sub render_resource {	Line 1180 sub render_resource {
if ($resource->is_problem() && $part ne '0' &&	if ($resource->is_problem() && $part ne '0' &&
!$params->{'condensed'}) {	!$params->{'condensed'}) {
my $displaypart=$resource->part_display($part);	my $displaypart=$resource->part_display($part);
$partLabel = " (Part: $displaypart)";	$partLabel = " (".&mt('Part: [_1]', $displaypart).")";
if ($link!~/\#/) { $link.='#'.&Apache::lonnet::escape($part); }	if ($link!~/\#/) { $link.='#'.&escape($part); }
$title = "";	$title = "";
}	}

if ($params->{'condensed'} && $resource->countParts() > 1) {	if ($params->{'condensed'} && $resource->countParts() > 1) {
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';	$nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')';
}	}

my $target;	my $target;
if ($ENV{'environment.remotenavmap'} eq 'on') {	if ($env{'environment.remotenavmap'} eq 'on') {
$target=' target="loncapaclient" ';	$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 $target href=\"$link\">$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
} else {	} else {
$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";	$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
}	}
Line 1155 sub render_communication_status {	Line 1207 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 $linkopen = "<a href='$link'>";	my $target;
	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()) {
Line 1168 sub render_communication_status {	Line 1224 sub render_communication_status {
my $feedback = $resource->getFeedback();	my $feedback = $resource->getFeedback();
foreach (split(/\,/, $feedback)) {	foreach (split(/\,/, $feedback)) {
if ($_) {	if ($_) {
$feedbackHTML .= ' <a href="/adm/email?display='	$feedbackHTML .= ' <a '.$target.' href="/adm/email?display='
. &Apache::lonnet::escape($_) . '">'	. &escape($_) . '">'
. '<img src="'.$location.'/feedback.gif" '	. '<img src="'.$location.'/feedback.gif" '
. 'border="0" /></a>';	. 'border="0" /></a>';
}	}
Line 1183 sub render_communication_status {	Line 1239 sub render_communication_status {
last if ($errorcount>=10); # Only output 10 bombs maximum	last if ($errorcount>=10); # Only output 10 bombs maximum
if ($_) {	if ($_) {
$errorcount++;	$errorcount++;
$errorHTML .= ' <a href="/adm/email?display='	$errorHTML .= ' <a '.$target.' href="/adm/email?display='
. &Apache::lonnet::escape($_) . '">'	. &escape($_) . '">'
. '<img src="'.$location.'/bomb.gif" '	. '<img src="'.$location.'/bomb.gif" '
. 'border="0" /></a>';	. 'border="0" /></a>';
}	}
Line 1205 sub render_quick_status {	Line 1261 sub render_quick_status {
$params->{'multipart'} && $part eq "0";	$params->{'multipart'} && $part eq "0";

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

if ($resource->is_problem() &&	if ($resource->is_problem() &&
Line 1364 sub render {	Line 1424 sub render {
# no columns, no nav maps.	# no columns, no nav maps.
return '';	return '';
}	}
my $mustCloseNavMap = 0;
my $navmap;	my $navmap;
if (defined($args->{'navmap'})) {	if (defined($args->{'navmap'})) {
$navmap = $args->{'navmap'};	$navmap = $args->{'navmap'};
Line 1385 sub render {	Line 1444 sub render {
# marker	# marker
my $filterHash = {};	my $filterHash = {};
# Figure out what we're not displaying	# Figure out what we're not displaying
foreach (split(/\,/, $ENV{"form.filter"})) {	foreach (split(/\,/, $env{"form.filter"})) {
if ($_) {	if ($_) {
$filterHash->{$_} = "1";	$filterHash->{$_} = "1";
}	}
Line 1405 sub render {	Line 1464 sub render {
}	}

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

if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {	if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
# Step 1: Check to see if we have a navmap	# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {	if (!defined($navmap)) {
$navmap = Apache::lonnavmaps::navmap->new();	$navmap = Apache::lonnavmaps::navmap->new();
$mustCloseNavMap = 1;	if (!defined($navmap)) {
}	# no londer in course
	return '<span class="LC_error">'.&mt('No course selected').'</span><br />
	<a href="/adm/roles">'.&mt('Select a course').'</a><br />';
	}
	}

# Step two: Locate what kind of here marker is necessary	# Step two: Locate what kind of here marker is necessary
# Determine where the "here" marker is and where the screen jumps to.	# Determine where the "here" marker is and where the screen jumps to.

if ($ENV{'form.postsymb'}) {	if ($env{'form.postsymb'} ne '') {
$here = $jump = &Apache::lonnet::symbclean($ENV{'form.postsymb'});	$here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'});
} elsif ($ENV{'form.postdata'}) {	} elsif ($env{'form.postdata'} ne '') {
# couldn't find a symb, is there a URL?	# couldn't find a symb, is there a URL?
my $currenturl = $ENV{'form.postdata'};	my $currenturl = $env{'form.postdata'};
#$currenturl=~s/^http\:\/\///;	#$currenturl=~s/^http\:\/\///;
#$currenturl=~s/^[^\/]+//;	#$currenturl=~s/^[^\/]+//;

$here = $jump = &Apache::lonnet::symbread($currenturl);	$here = $jump = &Apache::lonnet::symbread($currenturl);
}	}
	if ($here eq '') {
	my $last;
	if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
	&GDBM_READER(),0640)) {
	$last=$hash{'last_known'};
	untie(%hash);
	}
	if ($last) { $here = $jump = $last; }
	}

# Step three: Ensure the folders are open	# Step three: Ensure the folders are open
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);	my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
Line 1455 sub render {	Line 1527 sub render {
}	}
}	}

if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page	if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
# If this is a click on a folder or something, we want to preserve the "here"	# If this is a click on a folder or something, we want to preserve the "here"
# from the querystring, and get the new "jump" marker	# from the querystring, and get the new "jump" marker
$here = $ENV{'form.here'};	$here = $env{'form.here'};
$jump = $ENV{'form.jump'};	$jump = $env{'form.jump'};
}	}

my $it = $args->{'iterator'};	my $it = $args->{'iterator'};
if (!defined($it)) {	if (!defined($it)) {
# Construct a default iterator based on $ENV{'form.'} information	# Construct a default iterator based on $env{'form.'} information

# Step 1: Check to see if we have a navmap	# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {	if (!defined($navmap)) {
$navmap = Apache::lonnavmaps::navmap->new();	$navmap = Apache::lonnavmaps::navmap->new();
$mustCloseNavMap = 1;
}	}

# See if we're being passed a specific map	# See if we're being passed a specific map
Line 1542 sub render {	Line 1613 sub render {
my ($link,$text);	my ($link,$text);
if ($condition) {	if ($condition) {
$link='"navmaps?condition=0&filter=&'.$queryString.	$link='"navmaps?condition=0&filter=&'.$queryString.
'&here='.&Apache::lonnet::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='.&Apache::lonnet::escape($here).'"';	'&here='.&escape($here).'"';
$text='Open All Folders';	$text='Open all folders';
}	}
if ($args->{'caller'} eq 'navmapsdisplay') {	if ($args->{'caller'} eq 'navmapsdisplay') {
&add_linkitem($args->{'linkitems'},'changefolder',	&add_linkitem($args->{'linkitems'},'changefolder',
Line 1575 END	Line 1646 END
my @allres=$navmap->retrieveResources();	my @allres=$navmap->retrieveResources();
foreach my $resource (@allres) {	foreach my $resource (@allres) {
if ($resource->hasDiscussion()) {	if ($resource->hasDiscussion()) {
my $ressymb;	$haveDisc .= $resource->wrap_symb().':';
if ($resource->symb() =~ m-(___adm/\w+/\w+)/(\d+)/bulletinboard$-) {
$ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
} else {
$ressymb = $resource->symb();
}
$haveDisc .= $ressymb.':';
$totdisc ++;	$totdisc ++;
}	}
}	}
Line 1598 END	Line 1663 END

if ($args->{'caller'} eq 'navmapsdisplay') {	if ($args->{'caller'} eq 'navmapsdisplay') {
$result .= '<table><tr><td>'.	$result .= '<table><tr><td>'.
&Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT').'</td>';	&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT').'</td>';
if ($ENV{'environment.remotenavmap'} ne 'on') {	if ($env{'environment.remotenavmap'} ne 'on') {
$result .= '<td> </td>';	$result .= '<td> </td>';
} else {	} else {
$result .= '</tr><tr>';	$result .= '</tr><tr>';
}	}
$result.=&show_linkitems($args->{'linkitems'});	$result.=&show_linkitems($args->{'linkitems'});
if ($args->{'sort_html'}) {	if ($args->{'sort_html'}) {
if ($ENV{'environment.remotenavmap'} ne 'on') {	if ($env{'environment.remotenavmap'} ne 'on') {
$result.='<td> </td><td> </td><td> </td>'.	$result.='<td> </td><td> </td><td> </td>'.
'<td align="right">'.$args->{'sort_html'}.'</td></tr>';	'<td align="right">'.$args->{'sort_html'}.'</td></tr>';
} else {	} else {
Line 1643 END	Line 1708 END
$args->{'condensed'} = 0;	$args->{'condensed'} = 0;
my $location=	my $location=
&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");	&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt='' border='0' />");	$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt='  ' border='0' />");
$args->{'displayedHereMarker'} = 0;	$args->{'displayedHereMarker'} = 0;

# If we're suppressing empty sequences, look for them here. Use DFS for speed,	# If we're suppressing empty sequences, look for them here. Use DFS for speed,
Line 1796 END	Line 1861 END
$args->{'multipart'} = $curRes->multipart();	$args->{'multipart'} = $curRes->multipart();

if ($condenseParts) { # do the condensation	if ($condenseParts) { # do the condensation
if (!$curRes->opendate("0")) {
@parts = ();
$args->{'condensed'} = 1;
}
if (!$args->{'condensed'}) {	if (!$args->{'condensed'}) {
# Decide whether to condense based on similarity	# Decide whether to condense based on similarity
my $status = $curRes->status($parts[0]);	my $status = $curRes->status($parts[0]);
Line 1867 END	Line 1928 END
my $srcHasQuestion = $src =~ /\?/;	my $srcHasQuestion = $src =~ /\?/;
$args->{"resourceLink"} = $src.	$args->{"resourceLink"} = $src.
($srcHasQuestion?'&':'?') .	($srcHasQuestion?'&':'?') .
'symb=' . &Apache::lonnet::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.
Line 2007 In order of increasing complexity and po	Line 2068 In order of increasing complexity and po

=over 4	=over 4

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

=item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This	=item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
retrieves resources matching some criterion and returns them	retrieves resources matching some criterion and returns them
Line 2057 See iterator documentation below.	Line 2119 See iterator documentation below.

use strict;	use strict;
use GDBM_File;	use GDBM_File;
	use Apache::lonnet;

sub new {	sub new {
# magic invocation to create a class instance	# magic invocation to create a class instance
Line 2076 sub new {	Line 2139 sub new {

my %navmaphash;	my %navmaphash;
my %parmhash;	my %parmhash;
my $courseFn = $ENV{"request.course.fn"};	my $courseFn = $env{"request.course.fn"};
if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",	if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
&GDBM_READER(), 0640))) {	&GDBM_READER(), 0640))) {
return undef;	return undef;
Line 2102 sub generate_course_user_opt {	Line 2165 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=$env{'user.name'};
my $udom=$ENV{'user.domain'};	my $udom=$env{'user.domain'};
my $uhome=$ENV{'user.home'};	my $cid=$env{'request.course.id'};
my $cid=$ENV{'request.course.id'};	my $cdom=$env{'course.'.$cid.'.domain'};
my $chome=$ENV{'course.'.$cid.'.home'};	my $cnum=$env{'course.'.$cid.'.num'};
my ($cdom,$cnum)=split(/\_/,$cid);

my $userprefix=$uname.'_'.$udom.'_';

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

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

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

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

return;	return;
Line 2162 sub generate_email_discuss_status {	Line 2205 sub generate_email_discuss_status {
my $symb = shift;	my $symb = shift;
if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }	if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }

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

my %emailstatus = &Apache::lonnet::dump('email_status');	my %emailstatus = &Apache::lonnet::dump('email_status');
my $logoutTime = $emailstatus{'logout'};	my $logoutTime = $emailstatus{'logout'};
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};	my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?	$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
$courseLeaveTime : $logoutTime);	$courseLeaveTime : $logoutTime);
my %discussiontime = &Apache::lonnet::dump('discussiontimes',	my %discussiontime = &Apache::lonnet::dump('discussiontimes',
$cdom, $cnum);	$cdom, $cnum);
my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',	my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
$ENV{'user.domain'},$ENV{'user.name'},'lastread');	$env{'user.domain'},$env{'user.name'},'lastread');
my %lastreadtime = ();	my %lastreadtime = ();
foreach (keys %lastread) {	foreach (keys %lastread) {
my $key = $_;	my $key = $_;
Line 2183 sub generate_email_discuss_status {	Line 2227 sub generate_email_discuss_status {

my %feedback=();	my %feedback=();
my %error=();	my %error=();
my $keys = &Apache::lonnet::reply('keys:'.	my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},
$ENV{'user.domain'}.':'.	$env{'user.name'});
$ENV{'user.name'}.':nohist_email',
$ENV{'user.home'});

foreach my $msgid (split(/\&/, $keys)) {	foreach my $msgid (@keys) {
$msgid=&Apache::lonnet::unescape($msgid);
if ((!$emailstatus{$msgid}) \|\| ($emailstatus{$msgid} eq 'new')) {	if ((!$emailstatus{$msgid}) \|\| ($emailstatus{$msgid} eq 'new')) {
my $plain=	my $plain=
&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));	&LONCAPA::unescape(&LONCAPA::unescape($msgid));
if ($plain=~/(Error\|Feedback) \[([^\]]+)\]/) {	if ($plain=~/ \[([^\]]+)\]\:/) {
my ($what,$url)=($1,$2);	my $url=$1;
if ($what eq 'Error') {	if ($plain=~/\:Error \[/) {
$error{$url}.=','.$msgid;	$error{$url}.=','.$msgid;
} else {	} else {
$feedback{$url}.=','.$msgid;	$feedback{$url}.=','.$msgid;
Line 2220 sub get_user_data {	Line 2261 sub get_user_data {
if ($self->{RETRIEVED_USER_DATA}) { return; }	if ($self->{RETRIEVED_USER_DATA}) { return; }

# 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'},	$env{'user.domain'},
$ENV{'user.name'});	$env{'user.name'});
$self->{STUDENT_DATA} = \%student_data;	$self->{STUDENT_DATA} = \%student_data;

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

	sub get_discussion_data {
	my $self = shift;
	if ($self->{RETRIEVED_DISCUSSION_DATA}) {
	return $self->{DISCUSSION_DATA};
	}

	$self->generate_email_discuss_status();

	my $cid=$env{'request.course.id'};
	my $cdom=$env{'course.'.$cid.'.domain'};
	my $cnum=$env{'course.'.$cid.'.num'};
	# Retrieve discussion data for resources in course
	my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum);


	$self->{DISCUSSION_DATA} = \%discussion_data;
	$self->{RETRIEVED_DISCUSSION_DATA} = 1;
	return $self->{DISCUSSION_DATA};
	}


# Internal function: Takes a key to look up in the nav hash and implements internal	# Internal function: Takes a key to look up in the nav hash and implements internal
# memory caching of that key.	# memory caching of that key.
sub navhash {	sub navhash {
Line 2247 sub navhash {	Line 2309 sub navhash {
# Checks to see if coursemap is defined, matching test in old lonnavmaps	# Checks to see if coursemap is defined, matching test in old lonnavmaps
sub courseMapDefined {	sub courseMapDefined {
my $self = shift;	my $self = shift;
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});	my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});

my $firstres = $self->navhash("map_start_$uri");	my $firstres = $self->navhash("map_start_$uri");
my $lastres = $self->navhash("map_finish_$uri");	my $lastres = $self->navhash("map_finish_$uri");
Line 2257 sub courseMapDefined {	Line 2319 sub courseMapDefined {
sub getIterator {	sub getIterator {
my $self = shift;	my $self = shift;
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,	my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
shift, undef, shift);	shift, undef, shift,
	shift, shift);
return $iterator;	return $iterator;
}	}

Line 2266 sub getIterator {	Line 2329 sub getIterator {
sub hasDiscussion {	sub hasDiscussion {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;

$self->generate_email_discuss_status();	$self->generate_email_discuss_status();

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

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

# backward compatibility (bulletin boards used to be 'wrapped')	# backward compatibility (bulletin boards used to be 'wrapped')
my $ressymb = $symb;	my $ressymb = $self->wrap_symb($symb);
if ($ressymb =~ m\|adm/(\w+)/(\w+)/(\d+)/bulletinboard$\|) {
unless ($ressymb =~ m\|adm/wrapper/adm\|) {
$ressymb = 'bulletin___'.$3.'___adm/wrapper/adm/'.$1.'/'.$2.'/'.$3.'/bulletinboard';
}
}

if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {	if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};	return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
} else {	} else {
Line 2289 sub hasDiscussion {	Line 2345 sub hasDiscussion {
}	}
}	}

	sub last_post_time {
	my $self = shift;
	my $symb = shift;
	my $ressymb = $self->wrap_symb($symb);
	return $self->{DISCUSSION_TIME}->{$ressymb};
	}

	sub unread_discussion {
	my $self = shift;
	my $symb = shift;

	$self->get_discussion_data();

	my $ressymb = $self->wrap_symb($symb);
	# keys used to store bulletinboard postings use 'unwrapped' symb.
	my $discsymb = $self->unwrap_symb($ressymb);
	my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
	if (!$version) { return; }

	my $prevread = $self->{LAST_READ}{$ressymb};

	my $unreadcount = 0;
	my $hiddenflag = 0;
	my $deletedflag = 0;
	my ($hidden,$deleted);

	my %subjects;

	for (my $id=$version; $id>0; $id--) {
	my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
	my @keys=split(/:/,$vkeys);
	if (grep(/^hidden$/ ,@keys)) {
	if (!$hiddenflag) {
	$hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
	$hiddenflag = 1;
	}
	} elsif (grep(/^deleted$/,@keys)) {
	if (!$deletedflag) {
	$deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
	$deletedflag = 1;
	}
	} else {
	if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)
	&& $prevread < $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
	$unreadcount++;
	$subjects{$unreadcount}=
	$id.': '.$self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
	}
	}
	}
	if (wantarray) {
	return ($unreadcount,\%subjects);
	}
	return $unreadcount
	}

	sub wrap_symb {
	my $self = shift;
	my $symb = shift;
	if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
	unless ($symb =~ m\|adm/wrapper/adm\|) {
	$symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
	}
	}
	return $symb;
	}

	sub unwrap_symb {
	my $self = shift;
	my $ressymb = shift;
	my $discsymb = $ressymb;
	if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
	$discsymb = $1.$2;
	}
	return $discsymb;
	}

# Private method: Does the given resource (as a symb string) have	# Private method: Does the given resource (as a symb string) have
# current feedback? Returns the string in the feedback hash, which	# current feedback? Returns the string in the feedback hash, which
# will be false if it does not exist.	# will be false if it does not exist.

sub getFeedback {	sub getFeedback {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;
Line 2387 resource in the navmap.	Line 2521 resource in the navmap.
sub firstResource {	sub firstResource {
my $self = shift;	my $self = shift;
my $firstResource = $self->navhash('map_start_' .	my $firstResource = $self->navhash('map_start_' .
&Apache::lonnet::clutter($ENV{'request.course.uri'}));	&Apache::lonnet::clutter($env{'request.course.uri'}));
return $self->getById($firstResource);	return $self->getById($firstResource);
}	}

Line 2403 in the navmap.	Line 2537 in the navmap.
sub finishResource {	sub finishResource {
my $self = shift;	my $self = shift;
my $firstResource = $self->navhash('map_finish_' .	my $firstResource = $self->navhash('map_finish_' .
&Apache::lonnet::clutter($ENV{'request.course.uri'}));	&Apache::lonnet::clutter($env{'request.course.uri'}));
return $self->getById($firstResource);	return $self->getById($firstResource);
}	}

Line 2430 sub parmval_real {	Line 2564 sub parmval_real {
# 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();

my $cid=$ENV{'request.course.id'};	my $cid=$env{'request.course.id'};
my $csec=$ENV{'request.course.sec'};	my $csec=$env{'request.course.sec'};
my $uname=$ENV{'user.name'};	my $cgroup='';
my $udom=$ENV{'user.domain'};	my @cgrps=split(/:/,$env{'request.course.groups'});
	if (@cgrps > 0) {
	@cgrps = sort(@cgrps);
	$cgroup = $cgrps[0];
	}
	my $uname=$env{'user.name'};
	my $udom=$env{'user.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);
# ----------------------------------------------------- Cascading lookup scheme	# ----------------------------------------------------- Cascading lookup scheme
my $rwhat=$what;	my $rwhat=$what;
$what=~s/^parameter\_//;	$what=~s/^parameter\_//;
Line 2447 sub parmval_real {	Line 2587 sub parmval_real {

my $symbparm=$symb.'.'.$what;	my $symbparm=$symb.'.'.$what;
my $mapparm=$mapname.'___(all).'.$what;	my $mapparm=$mapname.'___(all).'.$what;
my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;	my $usercourseprefix=$cid;

	my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
	my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
	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;
Line 2469 sub parmval_real {	Line 2613 sub parmval_real {
}	}

# ------------------------------------------------------- second, check course	# ------------------------------------------------------- second, check course
	if ($cgroup ne '' and defined($courseopt)) {
	if (defined($$courseopt{$grplevelr})) { return $$courseopt{$grplevelr}; }
	if (defined($$courseopt{$grplevelm})) { return $$courseopt{$grplevelm}; }
	if (defined($$courseopt{$grplevel})) { return $$courseopt{$grplevel}; }
	}

if ($csec and defined($courseopt)) {	if ($csec and defined($courseopt)) {
if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }	if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }	if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
Line 2477 sub parmval_real {	Line 2627 sub parmval_real {

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

# ----------------------------------------------------- third, check map parms	# ----------------------------------------------------- third, check map parms
Line 2495 sub parmval_real {	Line 2643 sub parmval_real {
$default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);	$default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
if (defined($default)) { return $default}	if (defined($default)) { return $default}

# --------------------------------------------------- fifth , cascade up parts	# --------------------------------------------------- fifth, check more course
	if (defined($courseopt)) {
	if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
	if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
	}

	# --------------------------------------------------- sixth , cascade up parts

my ($space,@qualifier)=split(/\./,$rwhat);	my ($space,@qualifier)=split(/\./,$rwhat);
my $qualifier=join('.',@qualifier);	my $qualifier=join('.',@qualifier);
Line 2515 sub parmval_real {	Line 2669 sub parmval_real {

=pod	=pod

=item * B<getResourceByUrl>(url):	=item * B<getResourceByUrl>(url,multiple):

Retrieves a resource object by URL of the resource. If passed a	Retrieves a resource object by URL of the resource, unless the optional
resource object, it will simply return it, so it is safe to use this	multiple parameter is included in wahich caes an array of resource
method in code like "$res = $navmap->getResourceByUrl($res)", if	objects is returned. If passed a resource object, it will simply return
you're not sure if $res is already an object, or just a URL. If the	it, so it is safe to use this method in code like
resource appears multiple times in the course, only the first instance	"$res = $navmap->getResourceByUrl($res)"
will be returned. As a result, this is probably useful only for maps.	if you're not sure if $res is already an object, or just a URL. If the
	resource appears multiple times in the course, only the first instance
	will be returned (useful for maps), unless the multiple parameter has
	been included, in which case all instances are returned in an array.

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

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 2532 function that takes a resource object as	Line 2689 function that takes a resource object as
true if the resource should be included, or false if it should not	true if the resource should be included, or false if it should not
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. By default,	as soon as it finds a resource, if false it will finish. If showall is
the map is the top-level map of the course, filterFunc is a function	true it will not hide maps that contain nothing but one other map. By
that always returns 1, recursive is true, bailout is false. The	default, the map is the top-level map of the course, filterFunc is a
resources will be returned in a list containing the resource objects	function that always returns 1, recursive is true, bailout is false,
for the corresponding resources, with B<no structure information> in	showall is false. The resources will be returned in a list containing
the list; regardless of branching, recursion, etc., it will be a flat	the resource objects for the corresponding resources, with B<no
list.	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 2547 want to know is if I<any> resources matc	Line 2705 want to know is if I<any> resources matc
parameter will allow you to avoid potentially expensive enumeration of	parameter will allow you to avoid potentially expensive enumeration of
all matching resources.	all matching resources.

=item * B<hasResource>(map, filterFunc, recursive):	=item * B<hasResource>(map, filterFunc, recursive, showall):

Convience method for	Convience method for

scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0	scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0

which will tell whether the map has resources matching the description	which will tell whether the map has resources matching the description
in the filter function.	in the filter function.

	=item * B<usedVersion>(url):

	Retrieves version infomation for a url. Returns the version (a number, or
	the string "mostrecent") for resources which have version information in
	the big hash.

=cut	=cut


sub getResourceByUrl {	sub getResourceByUrl {
my $self = shift;	my $self = shift;
my $resUrl = shift;	my $resUrl = shift;
	my $multiple = shift;

if (ref($resUrl)) { return $resUrl; }	if (ref($resUrl)) { return $resUrl; }

$resUrl = &Apache::lonnet::clutter($resUrl);	$resUrl = &Apache::lonnet::clutter($resUrl);
my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};	my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
if ($resId =~ /,/) {
$resId = (split (/,/, $resId))[0];
}
if (!$resId) { return ''; }	if (!$resId) { return ''; }
return $self->getById($resId);	if ($multiple) {
	my @resources = ();
	my @resIds = split (/,/, $resId);
	foreach my $id (@resIds) {
	my $resourceId = $self->getById($id);
	if ($resourceId) {
	push(@resources,$resourceId);
	}
	}
	return @resources;
	} else {
	if ($resId =~ /,/) {
	$resId = (split (/,/, $resId))[0];
	}
	return $self->getById($resId);
	}
}	}

sub retrieveResources {	sub retrieveResources {
Line 2585 sub retrieveResources {	Line 2762 sub retrieveResources {
if (!defined($recursive)) { $recursive = 1; }	if (!defined($recursive)) { $recursive = 1; }
my $bailout = shift;	my $bailout = shift;
if (!defined($bailout)) { $bailout = 0; }	if (!defined($bailout)) { $bailout = 0; }
	my $showall = 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 2604 sub retrieveResources {	Line 2781 sub retrieveResources {

# Get an iterator.	# Get an iterator.
my $it = $self->getIterator($map->map_start(), $map->map_finish(),	my $it = $self->getIterator($map->map_start(), $map->map_finish(),
undef, $recursive);	undef, $recursive, $showall);

my @resources = ();	my @resources = ();

Line 2634 sub hasResource {	Line 2811 sub hasResource {
my $map = shift;	my $map = shift;
my $filterFunc = shift;	my $filterFunc = shift;
my $recursive = shift;	my $recursive = shift;
	my $showall = shift;

return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0;	return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
	}

	sub usedVersion {
	my $self = shift;
	my $linkurl = shift;
	return $self->navhash("version_$linkurl");
}	}

1;	1;

package Apache::lonnavmaps::iterator;	package Apache::lonnavmaps::iterator;
use WeakRef;	use Scalar::Util qw(weaken);
	use Apache::lonnet;

=pod	=pod

=back	=back
Line 2901 sub new {	Line 3087 sub new {
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}, 0);	$self->{CONDITION},
	$self->{FORCE_TOP});

}	}

Line 3064 sub next {	Line 3251 sub next {
$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},
$self->{ALREADY_SEEN}, $self->{CONDITION});	$self->{ALREADY_SEEN},
	$self->{CONDITION},
	$self->{FORCE_TOP});
}	}

# If this is a blank resource, don't actually return it.	# If this is a blank resource, don't actually return it.
Line 3117 sub populateStack {	Line 3306 sub populateStack {
1;	1;

package Apache::lonnavmaps::DFSiterator;	package Apache::lonnavmaps::DFSiterator;
use WeakRef;	use Scalar::Util qw(weaken);
	use Apache::lonnet;

# Not documented in the perldoc: This is a simple iterator that just walks	# Not documented in the perldoc: This is a simple iterator that just walks
# through the nav map and presents the resources in a depth-first search	# through the nav map and presents the resources in a depth-first search
# fashion, ignorant of conditionals, randomized resources, etc. It presents	# fashion, ignorant of conditionals, randomized resources, etc. It presents
Line 3299 sub populateStack {	Line 3490 sub populateStack {
1;	1;

package Apache::lonnavmaps::resource;	package Apache::lonnavmaps::resource;
use WeakRef;	use Scalar::Util qw(weaken);
use Apache::lonnet;	use Apache::lonnet;

=pod	=pod
Line 3478 sub kind { my $self=shift; return $self-	Line 3669 sub kind { my $self=shift; return $self-
sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }	sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
sub randompick {	sub randompick {
my $self = shift;	my $self = shift;
return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .	return $self->parmval('randompick');
'.0.parameter_randompick'};
}	}
sub link {	sub link {
my $self=shift;	my $self=shift;
Line 3495 sub shown_symb {	Line 3685 sub shown_symb {
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 {
	my $self=shift;
	return $self->{ID};
	}
	sub enclosing_map_src {
	my $self=shift;
	(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
	return $self->navHash('map_id_'.$first);
	}
sub symb {	sub symb {
my $self=shift;	my $self=shift;
(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;	(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
Line 3503 sub symb {	Line 3702 sub symb {
. '___' . $second . '___' . $symbSrc;	. '___' . $second . '___' . $symbSrc;
return &Apache::lonnet::symbclean($symb);	return &Apache::lonnet::symbclean($symb);
}	}
	sub wrap_symb {
	my $self = shift;
	return $self->{NAV_MAP}->wrap_symb($self->symb());
	}
sub title {	sub title {
my $self=shift;	my $self=shift;
if ($self->{ID} eq '0.0') {	if ($self->{ID} eq '0.0') {
# If this is the top-level map, return the title of the course	# If this is the top-level map, return the title of the course
# since this map can not be titled otherwise.	# since this map can not be titled otherwise.
return $ENV{'course.'.$ENV{'request.course.id'}.'.description'};	return $env{'course.'.$env{'request.course.id'}.'.description'};
}	}
return $self->navHash("title_", 1); }	return $self->navHash("title_", 1); }
# considered private and undocumented	# considered private and undocumented
Line 3522 sub condition {	Line 3725 sub condition {
my $condition=&Apache::lonnet::directcondval($condid);	my $condition=&Apache::lonnet::directcondval($condid);
return $condition;	return $condition;
}	}
	sub condval {
	my $self=shift;
	my ($pathname,$filename) =
	&Apache::lonnet::split_uri_for_cond($self->src());

	my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
	/\&\Q$filename\E\:([\d\\|]+)\&/);
	if ($match) {
	return &Apache::lonnet::condval($1);
	}
	return 0;
	}
sub compTitle {	sub compTitle {
my $self = shift;	my $self = shift;
my $title = $self->title();	my $title = $self->title();
Line 3573 sub retrieveResources {	Line 3787 sub retrieveResources {
return $self->{NAV_MAP}->retrieveResources(@_);	return $self->{NAV_MAP}->retrieveResources(@_);
}	}

	sub is_exam {
	my ($self,$part) = @_;
	if ($self->parmval('type',$part) eq 'exam') {
	return 1;
	}
	if ($self->src() =~ /\.(exam)$/) {
	return 1;
	}
	return 0;
	}
sub is_html {	sub is_html {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
Line 3585 sub is_page {	Line 3809 sub is_page {
return $self->navHash("is_map_", 1) &&	return $self->navHash("is_map_", 1) &&
$self->navHash("map_type_" . $self->map_pc()) eq 'page';	$self->navHash("map_type_" . $self->map_pc()) eq 'page';
}	}
	sub is_practice {
	my $self=shift;
	my ($part) = @_;
	if ($self->parmval('type',$part) eq 'practice') {
	return 1;
	}
	return 0;
	}
sub is_problem {	sub is_problem {
my $self=shift;	my $self=shift;
my $src = $self->src();	my $src = $self->src();
return ($src =~ /\.(problem\|exam\|quiz\|assess\|survey\|form\|library)$/)	if ($src =~ /\.(problem\|exam\|quiz\|assess\|survey\|form\|library\|task)$/) {
	return !($self->is_practice());
	}
	return 0;
}	}
sub contains_problem {	sub contains_problem {
my $self=shift;	my $self=shift;
Line 3600 sub contains_problem {	Line 3835 sub contains_problem {
}	}
sub is_sequence {	sub is_sequence {
my $self=shift;	my $self=shift;
my $src = $self->src();
return $self->navHash("is_map_", 1) &&	return $self->navHash("is_map_", 1) &&
$self->navHash("map_type_" . $self->map_pc()) eq 'sequence';	$self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
}	}
Line 3615 sub is_survey {	Line 3849 sub is_survey {
}	}
return 0;	return 0;
}	}
	sub is_task {
	my $self=shift;
	my $src = $self->src();
	return ($src =~ /\.(task)$/)
	}

sub is_empty_sequence {	sub is_empty_sequence {
my $self=shift;	my $self=shift;
Line 3670 Returns a string with the type of the ma	Line 3909 Returns a string with the type of the ma
sub map_finish {	sub map_finish {
my $self = shift;	my $self = shift;
my $src = $self->src();	my $src = $self->src();
$src = Apache::lonnet::clutter($src);	$src = &Apache::lonnet::clutter($src);
my $res = $self->navHash("map_finish_$src", 0);	my $res = $self->navHash("map_finish_$src", 0);
$res = $self->{NAV_MAP}->getById($res);	$res = $self->{NAV_MAP}->getById($res);
return $res;	return $res;
Line 3683 sub map_pc {	Line 3922 sub map_pc {
sub map_start {	sub map_start {
my $self = shift;	my $self = shift;
my $src = $self->src();	my $src = $self->src();
$src = Apache::lonnet::clutter($src);	$src = &Apache::lonnet::clutter($src);
my $res = $self->navHash("map_start_$src", 0);	my $res = $self->navHash("map_start_$src", 0);
$res = $self->{NAV_MAP}->getById($res);	$res = $self->{NAV_MAP}->getById($res);
return $res;	return $res;
Line 3795 sub awarded {	Line 4034 sub awarded {
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'};
}	}
	# this should work exactly like the copy in lonhomework.pm
sub duedate {	sub duedate {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
	my $date;
my $interval=$self->parmval("interval", $part);	my $interval=$self->parmval("interval", $part);
if ($interval) {	my $due_date=$self->parmval("duedate", $part);
	if (defined($interval)) {
my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);	my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);
if ($first_access) { return ($first_access+$interval); }	if (defined($first_access)) {
	$interval = $first_access+$interval;
	$date = ($interval < $due_date)? $interval : $due_date;
	} else {
	$date = $due_date;
	}
	} else {
	$date = $due_date;
}	}
return $self->parmval("duedate", $part);	return $date;
	}
	sub handgrade {
	(my $self, my $part) = @_;
	return $self->parmval("handgrade", $part);
}	}
sub maxtries {	sub maxtries {
(my $self, my $part) = @_;	(my $self, my $part) = @_;
Line 3842 sub weight {	Line 4095 sub weight {
my $self = shift; my $part = shift;	my $self = shift; my $part = shift;
if (!defined($part)) { $part = '0'; }	if (!defined($part)) { $part = '0'; }
return &Apache::lonnet::EXT('resource.'.$part.'.weight',	return &Apache::lonnet::EXT('resource.'.$part.'.weight',
$self->symb(), $ENV{'user.domain'},	$self->symb(), $env{'user.domain'},
$ENV{'user.name'},	$env{'user.name'},
$ENV{'request.course.sec'});	$env{'request.course.sec'});
}	}
sub part_display {	sub part_display {
my $self= shift(); my $partID = shift();	my $self= shift(); my $partID = shift();
Line 3895 Returns a false value if there has been	Line 4148 Returns a false value if there has been
logged in, true if there has. Always returns false if the discussion	logged in, true if there has. Always returns false if the discussion
data was not extracted when the nav map was constructed.	data was not extracted when the nav map was constructed.

	=item * B<last_post_time>:

	Returns a false value if there hasn't been discussion otherwise returns
	unix timestamp of last time a discussion posting (or edit) was made.

	=item * B<unread_discussion>:

	returns in scalar context the count of the number of unread discussion
	postings

	returns in list context both the count of postings and a hash ref
	containing the subjects of all unread postings

=item * B<getFeedback>:	=item * B<getFeedback>:

Gets the feedback for the resource and returns the raw feedback string	Gets the feedback for the resource and returns the raw feedback string
Line 3903 email data was not extracted when the na	Line 4169 email data was not extracted when the na
used like this:	used like this:

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

and use the link as appropriate.	and use the link as appropriate.
Line 3915 sub hasDiscussion {	Line 4181 sub hasDiscussion {
return $self->{NAV_MAP}->hasDiscussion($self->symb());	return $self->{NAV_MAP}->hasDiscussion($self->symb());
}	}

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

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

sub getFeedback {	sub getFeedback {
my $self = shift;	my $self = shift;
my $source = $self->src();	my $source = $self->src();
Line 4012 sub countResponses {	Line 4288 sub countResponses {
sub responseTypes {	sub responseTypes {
my $self = shift;	my $self = shift;
my %responses;	my %responses;
foreach my $part ($self->parts()) {	foreach my $part (@{$self->parts()}) {
foreach my $responsetype ($self->responseType($part)) {	foreach my $responsetype ($self->responseType($part)) {
$responses{$responsetype}++ if (defined($responsetype));	$responses{$responsetype}++ if (defined($responsetype));
}	}
Line 4088 sub extractParts {	Line 4364 sub extractParts {
return;	return;
}	}
foreach (split(/\,/,$metadata)) {	foreach (split(/\,/,$metadata)) {
if ($_ =~ /^part_(.*)$/) {	if ($_ =~ /^(?:part\|Task)_(.*)$/) {
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})) {
Line 4123 sub extractParts {	Line 4399 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 (split /,/, $metadata) {	foreach my $data (split /,/, $metadata) {
if ($_ =~ /^([a-zA-Z]+)response_(.*)/) {	if ($data =~ /^([a-zA-Z]+)response_(.*)/
	\|\| $data =~ /^(Task)_(.*)/) {
my $responseType = $1;	my $responseType = $1;
my $partStuff = $2;	my $partStuff = $2;
my $partIdSoFar = '';	my $partIdSoFar = '';
Line 4136 sub extractParts {	Line 4413 sub extractParts {
if ($parts{$partIdSoFar}) {	if ($parts{$partIdSoFar}) {
my @otherChunks = @partChunks[$i+1..$#partChunks];	my @otherChunks = @partChunks[$i+1..$#partChunks];
my $responseId = join('_', @otherChunks);	my $responseId = join('_', @otherChunks);
push @{$responseIdHash{$partIdSoFar}}, $responseId;	if ($self->is_task()) {
push @{$responseTypeHash{$partIdSoFar}}, $responseType;	push(@{$responseIdHash{$partIdSoFar}},
	$partIdSoFar);
	} else {
	push(@{$responseIdHash{$partIdSoFar}},
	$responseId);
	}
	push(@{$responseTypeHash{$partIdSoFar}},
	$responseType);
}	}
}	}
}	}
Line 4353 sub ATTEMPTED { return 16; }	Line 4637 sub ATTEMPTED { return 16; }

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

my $status = $self->queryRestoreHash('solved', shift);	my $status = $self->queryRestoreHash('solved', $part);

# Left as separate if statements in case we ever do more with this	# Left as separate if statements in case we ever do more with this
if ($status eq 'correct_by_student') {return $self->CORRECT;}	if ($status eq 'correct_by_student') {return $self->CORRECT;}
if ($status eq 'correct_by_scantron') {return $self->CORRECT;}	if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }	if ($status eq 'correct_by_override') {
	return $self->CORRECT_BY_OVERRIDE;
	}
if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }	if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }	if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
if ($status eq 'excused') {return $self->EXCUSED; }	if ($status eq 'excused') {return $self->EXCUSED; }
Line 4464 An answer has been submitted, but the st	Line 4751 An answer has been submitted, but the st

sub TRIES_LEFT { return 20; }	sub TRIES_LEFT { return 20; }
sub ANSWER_SUBMITTED { return 21; }	sub ANSWER_SUBMITTED { return 21; }
	sub PARTIALLY_CORRECT{ return 22; }

sub status {	sub status {
my $self = shift;	my $self = shift;
Line 4482 sub status {	Line 4770 sub status {
my $suppressFeedback = $self->problemstatus($part) eq 'no';	my $suppressFeedback = $self->problemstatus($part) eq 'no';
# If there's an answer date and we're past it, don't	# If there's an answer date and we're past it, don't
# suppress the feedback; student should know	# suppress the feedback; student should know
if ($self->answerdate($part) && $self->answerdate($part) < time()) {	if ($self->duedate($part) && $self->duedate($part) < time() &&
	$self->answerdate($part) && $self->answerdate($part) < time()) {
$suppressFeedback = 0;	$suppressFeedback = 0;
}	}

# There are a few whole rows we can dispose of:	# There are a few whole rows we can dispose of:
if ($completionStatus == CORRECT \|\|	if ($completionStatus == CORRECT \|\|
$completionStatus == CORRECT_BY_OVERRIDE ) {	$completionStatus == CORRECT_BY_OVERRIDE ) {
return $suppressFeedback? ANSWER_SUBMITTED : CORRECT;	if ( $suppressFeedback ) { return ANSWER_SUBMITTED }
	my $awarded=$self->awarded($part);
	if ($awarded < 1 && $awarded > 0) {
	return PARTIALLY_CORRECT;
	} elsif ($awarded<1) {
	return INCORRECT;
	}
	return CORRECT;
	}

	# If it's WRONG... and not open
	if ( ($completionStatus == INCORRECT \|\|
	$completionStatus == INCORRECT_BY_OVERRIDE)
	&& (!$self->opendate($part) \|\| $self->opendate($part) > time()) ) {
	return INCORRECT;
}	}

if ($completionStatus == ATTEMPTED) {	if ($completionStatus == ATTEMPTED) {
Line 4576 my %compositeToSimple =	Line 4879 my %compositeToSimple =
NETWORK_FAILURE() => ERROR,	NETWORK_FAILURE() => ERROR,
NOTHING_SET() => CLOSED,	NOTHING_SET() => CLOSED,
CORRECT() => CORRECT,	CORRECT() => CORRECT,
	PARTIALLY_CORRECT() => PARTIALLY_CORRECT,
EXCUSED() => CORRECT,	EXCUSED() => CORRECT,
PAST_DUE_NO_ANSWER() => INCORRECT,	PAST_DUE_NO_ANSWER() => INCORRECT,
PAST_DUE_ANSWER_LATER() => INCORRECT,	PAST_DUE_ANSWER_LATER() => INCORRECT,
Line 4696 sub getNext {	Line 5000 sub getNext {
my $to = $self->to();	my $to = $self->to();
foreach my $branch ( split(/,/, $to) ) {	foreach my $branch ( split(/,/, $to) ) {
my $choice = $self->{NAV_MAP}->getById($branch);	my $choice = $self->{NAV_MAP}->getById($branch);
if (!$choice->condition()) { next; }	#if (!$choice->condition()) { next; }
my $next = $choice->goesto();	my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);	$next = $self->{NAV_MAP}->getById($next);

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

Removed from v.1.313
changed lines
	Added in v.1.388