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.261 and 1.318

version 1.261, 2004/06/15 14:12:56	version 1.318, 2005/03/15 17:07:10
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();
	use Apache::lonenc();
use Apache::lonlocal;	use Apache::lonlocal;
	use Apache::lonnet;
use POSIX qw (floor strftime);	use POSIX qw (floor strftime);
use Data::Dumper; # for debugging, not always used	use Data::Dumper; # for debugging, not always
	use Time::HiRes qw( gettimeofday tv_interval );

# symbolic constants	# symbolic constants
sub SYMB { return 1; }	sub SYMB { return 1; }
Line 83 my %colormap =	Line 87 my %colormap =
# 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 {
	my ($mode,$script,$toplinkitems)=@_;
	my $result;
	if ($script ne 'no') {
	$result.='<script type="text/javascript">';
	}
	$result.='function launch_navmapwin() {
	newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
	}';
	if ($mode eq 'now') {
	$result.="\nlaunch_navmapwin();\n";
	}
	if ($script ne 'no') {
	$result.='</script>';
	}
	if ($mode eq 'link') {
	&add_linkitem($toplinkitems,'launchnav','launch_navmapwin()',
	"Launch navigation window");
	}
	return $result;
	}

	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 handler {	sub handler {
my $r = shift;	my $r = shift;
real_handler($r);	real_handler($r);
Line 90 sub handler {	Line 144 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'}) {
Line 111 sub real_handler {	Line 165 sub real_handler {
&Apache::loncommon::no_cache($r);	&Apache::loncommon::no_cache($r);
$r->send_http_header;	$r->send_http_header;

	my %toplinkitems=();
	&add_linkitem(\%toplinkitems,'blank','',"Select Action");
	if ($ENV{QUERY_STRING} eq 'collapseExternal') {
	&Apache::lonnet::put('environment',{'remotenavmap' => 'off'});
	&Apache::lonnet::appenv('environment.remotenavmap' => 'off');
	my $menu=&Apache::lonmenu::reopenmenu();
	my $navstatus=&Apache::lonmenu::get_nav_status();
	if ($menu) {
	$menu=(<<MENU)
	swmenu=$menu
	swmenu.clearTimeout(swmenu.menucltim);
	$navstatus
	MENU
	} else {
	my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
	my $mainwindow='window.open('.$nothing.',"loncapaclient","",false);';
	$menu=(<<MENU)
	swmenu=$mainwindow
	$navstatus
	MENU
	}
	my $html=&Apache::lonxml::xmlbegin();
	$r->print(<<"ENDSUBM");
	$html
	<head>
	<script type="text/javascript">
	function submitthis() {
	$menu
	self.close();
	}

	</script>
	</head>
	<body bgcolor="#FFFFFF" onLoad="submitthis()"></body>
	</html>
	ENDSUBM
	return;
	}
	if ($ENV{QUERY_STRING} eq 'launchExternal') {
	&Apache::lonnet::put('environment',{'remotenavmap' => 'on'});
	&Apache::lonnet::appenv('environment.remotenavmap' => 'on');
	}

# Create the nav map	# Create the nav map
my $navmap = Apache::lonnavmaps::navmap->new();	my $navmap = Apache::lonnavmaps::navmap->new();

Line 119 sub real_handler {	Line 216 sub real_handler {
$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;
}	}
	my $html=&Apache::lonxml::xmlbegin();
$r->print("<html><head>\n");	$r->print("$html<head>\n");
$r->print("<title>".&mt('Navigate Course Contents')."</title>");	$r->print("<title>".&mt('Navigate Course Contents')."</title>");
# ------------------------------------------------------------ Get query string	# ------------------------------------------------------------ Get query string
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);	&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register','sort','showOnlyHomework','postsymb']);

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

# Header	# Header
$r->print('</head>'.	$r->print('</head>'.
&Apache::loncommon::bodytag('Navigate Course Contents','',	&Apache::loncommon::bodytag('Navigate Course Contents','',
$addentries,'','',$ENV{'form.register'}));	$addentries,$body_only,'',
	$ENV{'form.register'}));
$r->print('<script>window.focus();</script>');	$r->print('<script>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('<font size="+2" color="red">Coursemap undefined.</font>' .	$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
'</body></html>');	'</body></html>');
return OK;	return OK;
Line 172 sub real_handler {	Line 286 sub real_handler {
}	}
}	}

	if ($ENV{QUERY_STRING} eq 'launchExternal') {
	$r->print('
	<form name="returnwin" action="/adm/flip?postdata=return%3a"
	method="post" target="loncapaclient">
	</form>');
	$r->print('
	<script type="text/javascript">
	this.document.returnwin.submit();
	</script>');
	}

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

my $jumpToFirstHomework = 0;	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} eq 'jumpToFirstHomework') {	if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
$jumpToFirstHomework = 1;	$jumpToFirstHomework = 1;
# Find the next homework problem that they can do.	# Find the next homework problem that they can do.
my $iterator = $navmap->getIterator(undef, undef, undef, 1);	my $iterator = $navmap->getIterator(undef, undef, undef, 1);
Line 207 sub real_handler {	Line 340 sub real_handler {
$r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />");	$r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />");
}	}
} else {	} else {
$r->print("<a href='navmaps?jumpToFirstHomework'>" .	&add_linkitem(\%toplinkitems,'firsthomework',
&mt("Go To My First Homework Problem")."</a>    ");	'location.href="navmaps?jumpToFirstHomework"',
	"Show Me My First Homework Problem");
}	}

my $suppressEmptySequences = 0;	my $suppressEmptySequences = 0;
Line 217 sub real_handler {	Line 351 sub real_handler {

# Display only due homework.	# Display only due homework.
my $showOnlyHomework = 0;	my $showOnlyHomework = 0;
if ($ENV{QUERY_STRING} eq 'showOnlyHomework') {	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',
	'location.href="navmaps?sort='.$ENV{'form.sort'}.'"',
	"Show Everything");
$r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");	$r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");
$ENV{'form.filter'} = '';	$ENV{'form.filter'} = '';
$ENV{'form.condition'} = 1;	$ENV{'form.condition'} = 1;
$resource_no_folder_link = 1;	$resource_no_folder_link = 1;
} else {	} else {
$r->print("<a href='navmaps?showOnlyHomework'>" .	&add_linkitem(\%toplinkitems,'uncompleted',
&mt("Show Only Uncompleted Homework")."</a>    ");	'location.href="navmaps?sort='.$ENV{'form.sort'}.
}	'&showOnlyHomework=1"',
	"Show Only Uncompleted Homework");
	}

	my %selected=($ENV{'form.sort'} => 'selected=on');
	my $sort_html=("<form>
	<nobr>
	<input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$ENV{'form.showOnlyHomework'}."\" />
	<input type=\"submit\" value=\"".&mt('Sort by:')."\" />
	<select name=\"sort\">
	<option value=\"default\" $selected{'default'}>".&mt('Default')."</option>
	<option value=\"title\" $selected{'title'} >".&mt('Title')."</option>
	<option value=\"duedate\" $selected{'duedate'}>".&mt('Duedate')."</option>
	<option value=\"discussion\" $selected{'discussion'}>".&mt('Has New Discussion')."</option>
	</select>
	</nobr>
	</form>");
# renderer call	# renderer call
my $renderArgs = { 'cols' => [0,1,2,3],	my $renderArgs = { 'cols' => [0,1,2,3],
	'sort' => $ENV{'form.sort'},
'url' => '/adm/navmaps',	'url' => '/adm/navmaps',
'navmap' => $navmap,	'navmap' => $navmap,
'suppressNavmap' => 1,	'suppressNavmap' => 1,
'suppressEmptySequences' => $suppressEmptySequences,	'suppressEmptySequences' => $suppressEmptySequences,
'filterFunc' => $filterFunc,	'filterFunc' => $filterFunc,
'resource_no_folder_link' => $resource_no_folder_link,	'resource_no_folder_link' => $resource_no_folder_link,
'r' => $r};	'sort_html'=> $sort_html,
	'r' => $r,
	'caller' => 'navmapsdisplay',
	'linkitems' => \%toplinkitems};
my $render = render($renderArgs);	my $render = render($renderArgs);
$navmap->untieHashes();

# If no resources were printed, print a reassuring message so the	# If no resources were printed, print a reassuring message so the
# user knows there was no error.	# user knows there was no error.
Line 253 sub real_handler {	Line 408 sub real_handler {
$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("</body></html>");
$r->rflush();	$r->rflush();
Line 283 sub removeFromFilter {	Line 440 sub removeFromFilter {

# Convenience function: Given a stack returned from getStack on the iterator,	# Convenience function: Given a stack returned from getStack on the iterator,
# return the correct src() value.	# return the correct src() value.
# Later, this should add an anchor when we start putting anchors in pages.
sub getLinkForResource {	sub getLinkForResource {
my $stack = shift;	my $stack = shift;
my $res;	my $res;
Line 291 sub getLinkForResource {	Line 447 sub getLinkForResource {
# Check to see if there are any pages in the stack	# Check to see if there are any pages in the stack
foreach $res (@$stack) {	foreach $res (@$stack) {
if (defined($res)) {	if (defined($res)) {
	my $anchor;
if ($res->is_page()) {	if ($res->is_page()) {
return $res->src();	foreach (@$stack) { if (defined($_)) { $anchor = $_; } }
	$anchor=&Apache::lonnet::escape($anchor->shown_symb());
	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$/) {
return &Apache::lonnet::clutter($map).'#'.	my $url=&Apache::lonnet::clutter($map);
&Apache::lonnet::escape(&Apache::lonnet::declutter($src));	$anchor=&Apache::lonnet::escape($src->shown_symb());
	return ($url,$res->shown_symb(),$anchor);
}	}
}	}
}	}
Line 311 sub getLinkForResource {	Line 471 sub getLinkForResource {
if (defined($_)) { $res = $_; }	if (defined($_)) { $res = $_; }
}	}

return $res->src();	return ($res->link(),$res->shown_symb());
}	}

# Convenience function: This separates the logic of how to create	# Convenience function: This separates the logic of how to create
Line 512 sub timeToHumanString {	Line 672 sub timeToHumanString {
}	}

# Not this year, so show the year	# Not this year, so show the year
my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));	my $timeStr = strftime("on %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;
Line 859 sub render_resource {	Line 1019 sub render_resource {
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"};

	# The URL part is not escaped at this point, but the symb is...
	# The stuff to the left of the ? must have ' replaced by \' since
	# it will be quoted with ' in the href.

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

my $src = $resource->src();	my $src = $resource->src();
my $it = $params->{"iterator"};	my $it = $params->{"iterator"};
my $filter = $it->{FILTER};	my $filter = $it->{FILTER};
Line 867 sub render_resource {	Line 1036 sub render_resource {

my $partLabel = "";	my $partLabel = "";
my $newBranchText = "";	my $newBranchText = "";
	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='/adm/lonIcons/branch.gif' border='0' />";	$newBranchText = "<img src='$location/branch.gif' border='0' />";
}	}

# 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='/adm/lonIcons/unknown.gif' alt='' border='0' />";	my $icon = "<img src='$location/unknown.gif' alt='' border='0' />";

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

# Display the correct map icon to open or shut map	# Display the correct map icon to open or shut map
Line 903 sub render_resource {	Line 1075 sub render_resource {

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='/adm/lonIcons/$icon' alt='' border='0' />";	$icon = "<img src='$location/$icon' alt='' border='0' />";

$linkopen = "<a href='" . $params->{'url'} . '?' .	$linkopen = "<a href='" . $params->{'url'} . '?' .
$params->{'queryString'} . '&filter=';	$params->{'queryString'} . '&filter=';
Line 916 sub render_resource {	Line 1088 sub render_resource {
'&jump=' .	'&jump=' .
&Apache::lonnet::escape($resource->symb()) .	&Apache::lonnet::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='/adm/lonIcons/$icon' alt='' border='0' />";	$icon = "<img src='$location/$icon' alt='' border='0' />";

$linkopen = "";	$linkopen = "";
$linkclose = "";	$linkclose = "";
Line 943 sub render_resource {	Line 1116 sub render_resource {
}	}

# Decide what to display	# Decide what to display

$result .= "$newBranchText$linkopen$icon$linkclose";	$result .= "$newBranchText$linkopen$icon$linkclose";

my $curMarkerBegin = '';	my $curMarkerBegin = '';
Line 958 sub render_resource {	Line 1132 sub render_resource {

if ($resource->is_problem() && $part ne '0' &&	if ($resource->is_problem() && $part ne '0' &&
!$params->{'condensed'}) {	!$params->{'condensed'}) {
my $displaypart=&Apache::lonnet::EXT('resource.'.$part.'.display',	my $displaypart=$resource->part_display($part);
$resource->symb());
unless ($displaypart) { $displaypart=$part; }
$partLabel = " (Part: $displaypart)";	$partLabel = " (Part: $displaypart)";
$link.='#'.&Apache::lonnet::escape($part);	if ($link!~/\#/) { $link.='#'.&Apache::lonnet::escape($part); }
$title = "";	$title = "";
}	}

Line 970 sub render_resource {	Line 1142 sub render_resource {
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';	$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
}	}

if (!$params->{'resource_nolink'} && !$resource->is_sequence()) {	my $target;
$result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";	if ($ENV{'environment.remotenavmap'} eq 'on') {
	$target=' target="loncapaclient" ';
	}
	if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
	$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 986 sub render_communication_status {	Line 1162 sub render_communication_status {
my $link = $params->{"resourceLink"};	my $link = $params->{"resourceLink"};
my $linkopen = "<a href='$link'>";	my $linkopen = "<a href='$link'>";
my $linkclose = "</a>";	my $linkclose = "</a>";
	my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
if ($resource->hasDiscussion()) {	if ($resource->hasDiscussion()) {
$discussionHTML = $linkopen .	$discussionHTML = $linkopen .
'<img border="0" src="/adm/lonMisc/chat.gif" />' .	'<img border="0" src="'.$location.'/chat.gif" />' .
$linkclose;	$linkclose;
}	}

Line 999 sub render_communication_status {	Line 1175 sub render_communication_status {
if ($_) {	if ($_) {
$feedbackHTML .= ' <a href="/adm/email?display='	$feedbackHTML .= ' <a href="/adm/email?display='
. &Apache::lonnet::escape($_) . '">'	. &Apache::lonnet::escape($_) . '">'
. '<img src="/adm/lonMisc/feedback.gif" '	. '<img src="'.$location.'/feedback.gif" '
. 'border="0" /></a>';	. 'border="0" /></a>';
}	}
}	}
Line 1014 sub render_communication_status {	Line 1190 sub render_communication_status {
$errorcount++;	$errorcount++;
$errorHTML .= ' <a href="/adm/email?display='	$errorHTML .= ' <a href="/adm/email?display='
. &Apache::lonnet::escape($_) . '">'	. &Apache::lonnet::escape($_) . '">'
. '<img src="/adm/lonMisc/bomb.gif" '	. '<img src="'.$location.'/bomb.gif" '
. 'border="0" /></a>';	. 'border="0" /></a>';
}	}
}	}
Line 1043 sub render_quick_status {	Line 1219 sub render_quick_status {
my $icon = $statusIconMap{$resource->simpleStatus($part)};	my $icon = $statusIconMap{$resource->simpleStatus($part)};
my $alt = $iconAltTags{$icon};	my $alt = $iconAltTags{$icon};
if ($icon) {	if ($icon) {
$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n";	my $location=
	&Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
	$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='$location' border='0' alt='$alt' />$linkclose</td>\n";
} else {	} else {
$result .= "<td width='30'> </td>\n";	$result .= "<td width='30'> </td>\n";
}	}
Line 1174 sub setDefault {	Line 1352 sub setDefault {
return $val;	return $val;
}	}

	sub cmp_title {
	my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle));
	$atitle=~s/^\s*//;
	$btitle=~s/^\s*//;
	return $atitle cmp $btitle;
	}

sub render {	sub render {
my $args = shift;	my $args = shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});	&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
my $result = '';	my $result = '';

# Configure the renderer.	# Configure the renderer.
my $cols = $args->{'cols'};	my $cols = $args->{'cols'};
if (!defined($cols)) {	if (!defined($cols)) {
Line 1241 sub render {	Line 1425 sub render {
# 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'}) {
$here = $jump = $ENV{'form.postsymb'};	$here = $jump = &Apache::lonnet::symbclean($ENV{'form.postsymb'});
} elsif ($ENV{'form.postdata'}) {	} elsif ($ENV{'form.postdata'}) {
# 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'};
Line 1249 sub render {	Line 1433 sub render {
#$currenturl=~s/^[^\/]+//;	#$currenturl=~s/^[^\/]+//;

$here = $jump = &Apache::lonnet::symbread($currenturl);	$here = $jump = &Apache::lonnet::symbread($currenturl);
}	} else {
	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 1259 sub render {	Line 1451 sub render {
# We only need to do this if we need to open the maps to show the	# We only need to do this if we need to open the maps to show the
# current position. This will change the counter so we can't count	# current position. This will change the counter so we can't count
# for the jump marker with this loop.	# for the jump marker with this loop.
while (($curRes = $mapIterator->next()) && !$found) {	while ($here && ($curRes = $mapIterator->next()) && !$found) {
if (ref($curRes) && $curRes->symb() eq $here) {	if (ref($curRes) && $curRes->symb() eq $here) {
my $mapStack = $mapIterator->getStack();	my $mapStack = $mapIterator->getStack();

Line 1335 sub render {	Line 1527 sub render {
my $printKey = $args->{'printKey'};	my $printKey = $args->{'printKey'};
my $printCloseAll = $args->{'printCloseAll'};	my $printCloseAll = $args->{'printCloseAll'};
if (!defined($printCloseAll)) { $printCloseAll = 1; }	if (!defined($printCloseAll)) { $printCloseAll = 1; }

# Print key?	# Print key?
if ($printKey) {	if ($printKey) {
$result .= '<table border="0" cellpadding="2" cellspacing="0">';	$result .= '<table border="0" cellpadding="2" cellspacing="0">';
my $date=localtime;	my $date=localtime;
$result.='<tr><td align="right" valign="bottom">Key:  </td>';	$result.='<tr><td align="right" valign="bottom">Key:  </td>';
	my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
if ($navmap->{LAST_CHECK}) {	if ($navmap->{LAST_CHECK}) {
$result .=	$result .=
'<img src="/adm/lonMisc/chat.gif"> '.&mt('New discussion since').' '.	'<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '.
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).	strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
'</td><td align="center" valign="bottom">  '.	'</td><td align="center" valign="bottom">  '.
'<img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').'<p>'.	'<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
'</td>';	'</td>';
} else {	} else {
$result .= '<td align="center" valign="bottom">  '.	$result .= '<td align="center" valign="bottom">  '.
'<img src="/adm/lonMisc/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.	'<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
'  <img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').	'  <img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').
'</td>';	'</td>';
}	}

Line 1359 sub render {	Line 1552 sub render {
}	}

if ($printCloseAll && !$args->{'resource_no_folder_link'}) {	if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
	my ($link,$text);
if ($condition) {	if ($condition) {
$result.="<a href=\"navmaps?condition=0&filter=&$queryString" .	$link='"navmaps?condition=0&filter=&'.$queryString.
"&here=" . Apache::lonnet::escape($here) .	'&here='.&Apache::lonnet::escape($here).'"';
"\">".&mt('Close All Folders')."</a>";	$text='Close All Folders';
	} else {
	$link='"navmaps?condition=1&filter=&'.$queryString.
	'&here='.&Apache::lonnet::escape($here).'"';
	$text='Open All Folders';
	}
	if ($args->{'caller'} eq 'navmapsdisplay') {
	&add_linkitem($args->{'linkitems'},'changefolder',
	'location.href='.$link,$text);
	} else {
	$result.='<a href='.$link.'>'.&mt($text).'</a>';
	}
	$result .= "\n";
	}

	# Check for any unread discussions in all resources.
	if ($args->{'caller'} eq 'navmapsdisplay') {
	&add_linkitem($args->{'linkitems'},'clearbubbles',
	'document.clearbubbles.submit()',
	'Mark all posts read');
	my $time=time;
	$result .= (<<END);
	<form name="clearbubbles" method="post" action="/adm/feedback">
	<input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
	<input type="hidden" name="navtime" value="$time" />
	END
	if ($args->{'sort'} eq 'discussion') {
	my $totdisc = 0;
	my $haveDisc = '';
	my @allres=$navmap->retrieveResources();
	foreach my $resource (@allres) {
	if ($resource->hasDiscussion()) {
	my $ressymb;
	if ($resource->symb() =~ m-(___adm/\w+/\w+)/(\d+)/bulletinboard$-) {
	$ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
	} else {
	$ressymb = $resource->symb();
	}
	$haveDisc .= $ressymb.':';
	$totdisc ++;
	}
	}
	if ($totdisc > 0) {
	$haveDisc =~ s/:$//;
	$result .= (<<END);
	<input type="hidden" name="navmaps" value="$haveDisc" />
	</form>
	END
	}
	}
	$result.='</form>';
	}

	if ($args->{'caller'} eq 'navmapsdisplay') {
	$result .= '<table><tr><td>'.
	&Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT').'</td>';
	if ($ENV{'environment.remotenavmap'} ne 'on') {
	$result .= '<td> </td>';
} else {	} else {
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .	$result .= '</tr><tr>';
"&here=" . Apache::lonnet::escape($here) .
"\">".&mt('Open All Folders')."</a>";
}	}
$result .= "<br /><br />\n";	$result.=&show_linkitems($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'}) {
	$result.=$args->{'sort_html'};
	}

	$result .= "<br />\n";
if ($r) {	if ($r) {
$r->print($result);	$r->print($result);
$r->rflush();	$r->rflush();
Line 1392 sub render {	Line 1654 sub render {
$args->{'indentLevel'} = 0;	$args->{'indentLevel'} = 0;
$args->{'isNewBranch'} = 0;	$args->{'isNewBranch'} = 0;
$args->{'condensed'} = 0;	$args->{'condensed'} = 0;
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");	my $location=
	&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
	$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 1442 sub render {	Line 1706 sub render {
$args->{'here'} = $here;	$args->{'here'} = $here;

$args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0	$args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
while ($curRes = $it->next($closeAllPages)) {	my @resources;
	my $code='';# sub { !(shift->is_map();) };
	if ($args->{'sort'} eq 'title') {
	my $oldFilterFunc = $filterFunc;
	my $filterFunc=
	sub {
	my ($res)=@_;
	if ($res->is_map()) { return 0;}
	return &$oldFilterFunc($res);
	};
	@resources=$navmap->retrieveResources(undef,$filterFunc);
	@resources= sort { &cmp_title($a,$b) } @resources;
	} elsif ($args->{'sort'} eq 'duedate') {
	my $oldFilterFunc = $filterFunc;
	my $filterFunc=
	sub {
	my ($res)=@_;
	if (!$res->is_problem()) { return 0;}
	return &$oldFilterFunc($res);
	};
	@resources=$navmap->retrieveResources(undef,$filterFunc);
	@resources= sort {
	if ($a->duedate ne $b->duedate) {
	return $a->duedate cmp $b->duedate;
	}
	my $value=&cmp_title($a,$b);
	return $value;
	} @resources;
	} elsif ($args->{'sort'} eq 'discussion') {
	my $oldFilterFunc = $filterFunc;
	my $filterFunc=
	sub {
	my ($res)=@_;
	if (!$res->hasDiscussion() &&
	!$res->getFeedback() &&
	!$res->getErrors()) { return 0;}
	return &$oldFilterFunc($res);
	};
	@resources=$navmap->retrieveResources(undef,$filterFunc);
	@resources= sort { &cmp_title($a,$b) } @resources;
	} else {
	#unknow sort mechanism or default
	undef($args->{'sort'});
	}


	while (1) {
	if ($args->{'sort'}) {
	$curRes = shift(@resources);
	} else {
	$curRes = $it->next($closeAllPages);
	}
	if (!$curRes) { last; }

# Maintain indentation level.	# Maintain indentation level.
if ($curRes == $it->BEGIN_MAP() \|\|	if ($curRes == $it->BEGIN_MAP() \|\|
$curRes == $it->BEGIN_BRANCH() ) {	$curRes == $it->BEGIN_BRANCH() ) {
Line 1545 sub render {	Line 1862 sub render {
# Add part 0 so we display it correctly.	# Add part 0 so we display it correctly.
unshift @parts, '0';	unshift @parts, '0';
}	}

	{
	my ($src,$symb,$anchor,$stack);
	if ($args->{'sort'}) {
	my $it = $navmap->getIterator(undef, undef, undef, 1);
	while ( my $res=$it->next()) {
	if (ref($res) &&
	$res->symb() eq $curRes->symb()) { last; }
	}
	$stack=$it->getStack();
	} else {
	$stack=$it->getStack();
	}
	($src,$symb,$anchor)=getLinkForResource($stack);
	if (defined($anchor)) { $anchor='#'.$anchor; }
	my $srcHasQuestion = $src =~ /\?/;
	$args->{"resourceLink"} = $src.
	($srcHasQuestion?'&':'?') .
	'symb=' . &Apache::lonnet::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) {
Line 1556 sub render {	Line 1892 sub render {

# Set up some data about the parts that the cols might want	# Set up some data about the parts that the cols might want
my $filter = $it->{FILTER};	my $filter = $it->{FILTER};
my $stack = $it->getStack();
my $src = getLinkForResource($stack);
my $anchor='';
if ($src=~s/(\#.*$)//) {
$anchor=$1;
}
my $srcHasQuestion = $src =~ /\?/;
$args->{"resourceLink"} = $src.
($srcHasQuestion?'&':'?') .
'symb=' . &Apache::lonnet::escape($curRes->symb()).
$anchor;

# Now, display each column.	# Now, display each column.
foreach my $col (@$cols) {	foreach my $col (@$cols) {
my $colHTML = '';	my $colHTML = '';
Line 1633 if (location.href.indexOf('#curloc')==-1	Line 1958 if (location.href.indexOf('#curloc')==-1
$r->rflush();	$r->rflush();
}	}

if ($mustCloseNavMap) { $navmap->untieHashes(); }	return $result;
	}

	sub add_linkitem {
	my ($linkitems,$name,$cmd,$text)=@_;
	$$linkitems{$name}{'cmd'}=$cmd;
	$$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">
	<nobr><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()" />
	</nobr></form></td>'."\n";

return $result;	return $result;
}	}

Line 1695 successful, or B<undef> if not.	Line 2058 successful, or B<undef> if not.

=back	=back

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

=head2 Methods	=head2 Methods

=over 4	=over 4
Line 1844 sub generate_email_discuss_status {	Line 2203 sub generate_email_discuss_status {

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

if (($status{$msgid} eq 'new') \|\|
(!$status{$msgid})) {
if ($what eq 'Error') {	if ($what eq 'Error') {
$error{$url}.=','.$msgid;	$error{$url}.=','.$msgid;
} else {	} else {
Line 1864 sub generate_email_discuss_status {	Line 2217 sub generate_email_discuss_status {
}	}
}	}

	#url's of resources that have feedbacks
$self->{FEEDBACK} = \%feedback;	$self->{FEEDBACK} = \%feedback;
$self->{ERROR_MSG} = \%error; # what is this? JB	#or errors
	$self->{ERROR_MSG} = \%error;
$self->{DISCUSSION_TIME} = \%discussiontime;	$self->{DISCUSSION_TIME} = \%discussiontime;
$self->{EMAIL_STATUS} = \%emailstatus;	$self->{EMAIL_STATUS} = \%emailstatus;
$self->{LAST_READ} = \%lastreadtime;	$self->{LAST_READ} = \%lastreadtime;
Line 1915 sub courseMapDefined {	Line 2270 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;
}	}

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

# Private method: Does the given resource (as a symb string) have	# Private method: Does the given resource (as a symb string) have
# current discussion? Returns 0 if chat/mail data not extracted.	# current discussion? Returns 0 if chat/mail data not extracted.
sub hasDiscussion {	sub hasDiscussion {
Line 1941 sub hasDiscussion {	Line 2290 sub hasDiscussion {
# backward compatibility (bulletin boards used to be 'wrapped')	# backward compatibility (bulletin boards used to be 'wrapped')
my $ressymb = $symb;	my $ressymb = $symb;
if ($ressymb =~ m\|adm/(\w+)/(\w+)/(\d+)/bulletinboard$\|) {	if ($ressymb =~ m\|adm/(\w+)/(\w+)/(\d+)/bulletinboard$\|) {
unless ($ressymb =~ m\|bulletin___\d+___adm/wrapper\|) {	unless ($ressymb =~ m\|adm/wrapper/adm\|) {
$ressymb = 'bulletin___'.$3.'___adm/wrapper/adm/'.$1.'/'.$2.'/'.$3.'/bulletinboard';	$ressymb = 'bulletin___'.$3.'___adm/wrapper/adm/'.$1.'/'.$2.'/'.$3.'/bulletinboard';
}	}
}	}
Line 1949 sub hasDiscussion {	Line 2298 sub hasDiscussion {
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 {
return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK};	# return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
	return $self->{DISCUSSION_TIME}->{$ressymb} > 0; # in 1.2 will display speech bubble icons for all items with posts until marked as read (even if read in v 1.1).
}	}
}	}

Line 2021 sub getById {	Line 2371 sub getById {
sub getBySymb {	sub getBySymb {
my $self = shift;	my $self = shift;
my $symb = shift;	my $symb = shift;

my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);	my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
my $map = $self->getResourceByUrl($mapUrl);	my $map = $self->getResourceByUrl($mapUrl);
return $self->getById($map->map_pc() . '.' . $id);	my $returnvalue = undef;
	if (ref($map)) {
	$returnvalue = $self->getById($map->map_pc() .'.'.$id);
	}
	return $returnvalue;
}	}

sub getByMapPc {	sub getByMapPc {
Line 2136 sub parmval_real {	Line 2491 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 2154 sub parmval_real {	Line 2507 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 2183 you're not sure if $res is already an ob	Line 2542 you're not sure if $res is already an ob
resource appears multiple times in the course, only the first instance	resource appears multiple times in the course, only the first instance
will be returned. As a result, this is probably useful only for maps.	will be returned. As a result, this is probably useful only for maps.

=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 2191 function that takes a resource object as	Line 2550 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 2206 want to know is if I<any> resources matc	Line 2566 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.

=cut	=cut


sub getResourceByUrl {	sub getResourceByUrl {
my $self = shift;	my $self = shift;
my $resUrl = shift;	my $resUrl = shift;
Line 2243 sub retrieveResources {	Line 2604 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 2262 sub retrieveResources {	Line 2623 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 2292 sub hasResource {	Line 2653 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;
}	}

1;	1;

package Apache::lonnavmaps::iterator;	package Apache::lonnavmaps::iterator;
	use WeakRef;
=pod	=pod

=back	=back
Line 2439 sub new {	Line 2801 sub new {
my $class = ref($proto) \|\| $proto;	my $class = ref($proto) \|\| $proto;
my $self = {};	my $self = {};

$self->{NAV_MAP} = shift;	weaken($self->{NAV_MAP} = shift);
return undef unless ($self->{NAV_MAP});	return undef unless ($self->{NAV_MAP});

# Handle the parameters	# Handle the parameters
Line 2559 sub new {	Line 2921 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 2722 sub next {	Line 3085 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 2775 sub populateStack {	Line 3140 sub populateStack {
1;	1;

package Apache::lonnavmaps::DFSiterator;	package Apache::lonnavmaps::DFSiterator;
	use WeakRef;
# 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 2803 sub new {	Line 3168 sub new {
my $class = ref($proto) \|\| $proto;	my $class = ref($proto) \|\| $proto;
my $self = {};	my $self = {};

$self->{NAV_MAP} = shift;	weaken($self->{NAV_MAP} = shift);
return undef unless ($self->{NAV_MAP});	return undef unless ($self->{NAV_MAP});

$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();	$self->{FIRST_RESOURCE} = shift \|\| $self->{NAV_MAP}->firstResource();
Line 2957 sub populateStack {	Line 3322 sub populateStack {
1;	1;

package Apache::lonnavmaps::resource;	package Apache::lonnavmaps::resource;
	use WeakRef;
use Apache::lonnet;	use Apache::lonnet;

=pod	=pod
Line 3039 sub new {	Line 3404 sub new {
my $class = ref($proto) \|\| $proto;	my $class = ref($proto) \|\| $proto;
my $self = {};	my $self = {};

$self->{NAV_MAP} = shift;	weaken($self->{NAV_MAP} = shift);
$self->{ID} = shift;	$self->{ID} = shift;

# Store this new resource in the parent nav map's cache.	# Store this new resource in the parent nav map's cache.
Line 3127 Returns the title of the resource.	Line 3492 Returns the title of the resource.
# These info functions can be used directly, as they don't return	# These info functions can be used directly, as they don't return
# resource information.	# resource information.
sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }	sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
	sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }	sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
sub from { my $self=shift; return $self->navHash("from_", 1); }	sub from { my $self=shift; return $self->navHash("from_", 1); }
# considered private and undocumented	# considered private and undocumented
Line 3138 sub randompick {	Line 3504 sub randompick {
return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .	return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
'.0.parameter_randompick'};	'.0.parameter_randompick'};
}	}
	sub link {
	my $self=shift;
	if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
	return $self->src;
	}
sub src {	sub src {
my $self=shift;	my $self=shift;
return $self->navHash("src_", 1);	return $self->navHash("src_", 1);
}	}
	sub shown_symb {
	my $self=shift;
	if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
	return $self->symb();
	}
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 3160 sub title {	Line 3536 sub title {
return $self->navHash("title_", 1); }	return $self->navHash("title_", 1); }
# considered private and undocumented	# considered private and undocumented
sub to { my $self=shift; return $self->navHash("to_", 1); }	sub to { my $self=shift; return $self->navHash("to_", 1); }
	sub condition {
	my $self=shift;
	my $undercond=$self->navHash("undercond_", 1);
	if (!defined($undercond)) { return 1; };
	my $condid=$self->navHash("condid_$undercond");
	if (!defined($condid)) { return 1; };
	my $condition=&Apache::lonnet::directcondval($condid);
	return $condition;
	}

sub compTitle {	sub compTitle {
my $self = shift;	my $self = shift;
my $title = $self->title();	my $title = $self->title();
Line 3244 sub is_sequence {	Line 3630 sub is_sequence {
sub is_survey {	sub is_survey {
my $self = shift();	my $self = shift();
my $part = shift();	my $part = shift();
if ($self->src() =~ /\.(survey)$/) {	if ($self->parmval('type',$part) eq 'survey') {
return 1;	return 1;
}	}
if ($self->parmval('type',$part) eq 'survey') {	if ($self->src() =~ /\.(survey)$/) {
return 1;	return 1;
}	}
return 0;	return 0;
}	}

	sub is_empty_sequence {
	my $self=shift;
	my $src = $self->src();
	return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
	}

# Private method: Shells out to the parmval in the nav map, handler parts.	# Private method: Shells out to the parmval in the nav map, handler parts.
sub parmval {	sub parmval {
my $self = shift;	my $self = shift;
Line 3476 sub weight {	Line 3868 sub 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 {
	my $self= shift(); my $partID = shift();
	if (! defined($partID)) { $partID = '0'; }
	my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
	$self->symb);
	if (! defined($display) \|\| $display eq '') {
	$display = $partID;
	}
	return $display;
}	}

# Multiple things need this	# Multiple things need this
Line 3566 Returns the number of parts of the probl	Line 3967 Returns the number of parts of the probl
for single part problems, returns 1. For multipart, it returns the	for single part problems, returns 1. For multipart, it returns the
number of parts in the problem, not including psuedo-part 0.	number of parts in the problem, not including psuedo-part 0.

	=item * B<countResponses>():

	Returns the total number of responses in the problem a student can answer.

	=item * B<responseTypes>():

	Returns a hash whose keys are the response types. The values are the number
	of times each response type is used. This is for the I<entire> problem, not
	just a single part.

=item * B<multipart>():	=item * B<multipart>():

Returns true if the problem is multipart, false otherwise. Use this instead	Returns true if the problem is multipart, false otherwise. Use this instead
Line 3612 sub countParts {	Line 4023 sub countParts {
return scalar(@{$parts}); # + $delta;	return scalar(@{$parts}); # + $delta;
}	}

	sub countResponses {
	my $self = shift;
	my $count;
	foreach my $part (@{$self->parts()}) {
	$count+= scalar($self->responseIds($part));
	}
	return $count;
	}

	sub responseTypes {
	my $self = shift;
	my %responses;
	foreach my $part ($self->parts()) {
	foreach my $responsetype ($self->responseType($part)) {
	$responses{$responsetype}++ if (defined($responsetype));
	}
	}
	return %responses;
	}

sub multipart {	sub multipart {
my $self = shift;	my $self = shift;
return $self->countParts() > 1;	return $self->countParts() > 1;
Line 3699 sub extractParts {	Line 4130 sub extractParts {
}	}


	# These hashes probably do not need names that end with "Hash"....
my %responseIdHash;	my %responseIdHash;
my %responseTypeHash;	my %responseTypeHash;

Line 3733 sub extractParts {	Line 4165 sub extractParts {
}	}
}	}
}	}
	my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
	#
	# Reorder the arrays in the %responseIdHash and %responseTypeHash
	if ($resorder) {
	my @resorder=split(/,/,$resorder);
	foreach my $part (keys(%responseIdHash)) {
	my $i=0;
	my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
	my @neworder;
	foreach my $possibleid (@resorder) {
	if (exists($resids{$possibleid})) {
	push(@neworder,$resids{$possibleid});
	}
	}
	my @ids;
	my @type;
	foreach my $element (@neworder) {
	push (@ids,$responseIdHash{$part}->[$element]);
	push (@type,$responseTypeHash{$part}->[$element]);
	}
	$responseIdHash{$part}=\@ids;
	$responseTypeHash{$part}=\@type;
	}
	}
$self->{RESPONSE_IDS} = \%responseIdHash;	$self->{RESPONSE_IDS} = \%responseIdHash;
$self->{RESPONSE_TYPES} = \%responseTypeHash;	$self->{RESPONSE_TYPES} = \%responseTypeHash;
}	}
Line 3926 sub getCompletionStatus {	Line 4382 sub getCompletionStatus {

# 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_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; }
Line 4076 sub status {	Line 4533 sub status {

if ($dateStatus == PAST_DUE_ANSWER_LATER \|\|	if ($dateStatus == PAST_DUE_ANSWER_LATER \|\|
$dateStatus == PAST_DUE_NO_ANSWER ) {	$dateStatus == PAST_DUE_NO_ANSWER ) {
return $dateStatus;	return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
}	}

if ($dateStatus == ANSWER_OPEN) {	if ($dateStatus == ANSWER_OPEN) {
Line 4262 sub getNext {	Line 4719 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; }
my $next = $choice->goesto();	my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);	$next = $self->{NAV_MAP}->getById($next);

Line 4290 sub browsePriv {	Line 4748 sub browsePriv {
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());
}	}

=pod	=pod

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

Removed from v.1.261
changed lines
	Added in v.1.318