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.279 and 1.325

version 1.279, 2004/08/24 22:07:51	version 1.325, 2005/04/15 21:28:54
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 84 my %colormap =	Line 88 my %colormap =
my $hurryUpColor = "#FF0000";	my $hurryUpColor = "#FF0000";

sub launch_win {	sub launch_win {
my ($mode,$script)=@_;	my ($mode,$script,$toplinkitems)=@_;
my $result;	my $result;
if ($script ne 'no') {	if ($script ne 'no') {
$result.='<script type="text/javascript">';	$result.='<script type="text/javascript">';
Line 99 sub launch_win {	Line 103 sub launch_win {
$result.='</script>';	$result.='</script>';
}	}
if ($mode eq 'link') {	if ($mode eq 'link') {
$result.='<a href="javascript:launch_navmapwin();void(0);">'	&add_linkitem($toplinkitems,'launchnav','launch_navmapwin()',
.&mt("Launch navigation window")."</a>    ";	"Launch navigation window");
}	}
return $result;	return $result;
}	}

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 119 window.status='Done.';	Line 123 window.status='Done.';
ENDCLOSE	ENDCLOSE
}	}

sub nav_control_js {
my $nav=($ENV{'environment.remotenavmap'} eq 'on');
return (<<NAVCONTROL);
var w_loncapanav_flag="$nav";


function gonav(url) {
if (w_loncapanav_flag != 1) {
go(url);
} else {
navwindow=window.open(url,
"loncapanav","height=600,width=400,scrollbars=1");
}
}
NAVCONTROL
}

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 157 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'}) {
&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 170 sub real_handler {	Line 157 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');
Line 178 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') {	if ($ENV{QUERY_STRING} eq 'collapseExternal') {
&Apache::lonnet::put('environment',{'remotenavmap' => 'off'});	&Apache::lonnet::put('environment',{'remotenavmap' => 'off'});
&Apache::lonnet::appenv('environment.remotenavmap' => 'off');	&Apache::lonnet::appenv('environment.remotenavmap' => 'off');
Line 189 sub real_handler {	Line 178 sub real_handler {
swmenu.clearTimeout(swmenu.menucltim);	swmenu.clearTimeout(swmenu.menucltim);
$navstatus	$navstatus
MENU	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");	$r->print(<<"ENDSUBM");
<html>	$html
<head>	<head>
<script type="text/javascript">	<script type="text/javascript">
function submitthis() {	function submitthis() {
Line 216 ENDSUBM	Line 213 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;
}	}
	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','sort','showOnlyHomework']);	&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 $more_unload;
my $body_only='';	my $body_only='';
if ($ENV{'environment.remotenavmap'} eq 'on') {	if ($env{'environment.remotenavmap'} eq 'on') {
$r->print('<script type="text/javascript">	$r->print('<script type="text/javascript">
function collapse() {	function collapse() {
this.document.location="/adm/navmaps?collapseExternal";	this.document.location="/adm/navmaps?collapseExternal";
Line 239 ENDSUBM	Line 236 ENDSUBM
# $more_unload="collapse()"	# $more_unload="collapse()"
$body_only=1;	$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().';'.
$more_unload.'"';	$more_unload.'"';
Line 252 ENDSUBM	Line 249 ENDSUBM
$r->print('</head>'.	$r->print('</head>'.
&Apache::loncommon::bodytag('Navigate Course Contents','',	&Apache::loncommon::bodytag('Navigate Course Contents','',
$addentries,$body_only,'',	$addentries,$body_only,'',
$ENV{'form.register'}));	$env{'form.register'}));
$r->print('<script>window.focus();</script>'.	$r->print('<script>window.focus();</script>');
&Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT'));

$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 283 ENDSUBM	Line 280 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";
}	}
}	}

Line 300 ENDSUBM	Line 297 ENDSUBM
</script>');	</script>');
}	}

if ($ENV{'environment.remotenavmap'} ne 'on') {	if ($env{'environment.remotenavmap'} ne 'on') {
$r->print(&launch_win('link','yes'));	$r->print(&launch_win('link','yes',\%toplinkitems));
}	}
if ($ENV{'environment.remotenavmap'} eq 'on') {	if ($env{'environment.remotenavmap'} eq 'on') {
# $r->print("<a href='navmaps?collapseExternal'>" .	&add_linkitem(\%toplinkitems,'closenav','collapse()',
$r->print("<a href='javascript:collapse();void(0);'>" .	"Close navigation window");
&mt("Close navigation window").
"</a>    ");
}	}

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 332 ENDSUBM	Line 327 ENDSUBM
pop @$stack; # last resource in the stack is the problem	pop @$stack; # last resource in the stack is the problem
# itself, which we don't need in the map stack	# itself, which we don't need in the map stack
my @mapPcs = map {$_->map_pc()} @$stack;	my @mapPcs = map {$_->map_pc()} @$stack;
$ENV{'form.filter'} = join(',', @mapPcs);	$env{'form.filter'} = join(',', @mapPcs);

# Mark as both "here" and "jump"	# Mark as both "here" and "jump"
$ENV{'form.postsymb'} = $curRes->symb();	$env{'form.postsymb'} = $curRes->symb();
}	}
}	}
}	}
Line 345 ENDSUBM	Line 340 ENDSUBM
$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 355 ENDSUBM	Line 351 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();
};	};
$r->print("<a href='navmaps?sort=$ENV{'form.sort'}'>" .	&add_linkitem(\%toplinkitems,'everything',
&mt("Show Everything")."</a>    ");	'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?sort=$ENV{'form.sort'}&showOnlyHomework=1'>" .	&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 %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>
<option value=\"title\" $selected{'title'} >".&mt('Title')."</option>	<option value=\"title\" $selected{'title'} >".&mt('Title')."</option>
<option value=\"duedate\" $selected{'duedate'}>".&mt('Duedate')."</option>	<option value=\"duedate\" $selected{'duedate'}>".&mt('Duedate')."</option>
	<option value=\"discussion\" $selected{'discussion'}>".&mt('Has New Discussion')."</option>
</select>	</select>
</nobr>	</nobr>
</form>");	</form>");
# renderer call	# renderer call
my $renderArgs = { 'cols' => [0,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 394 ENDSUBM	Line 394 ENDSUBM
'filterFunc' => $filterFunc,	'filterFunc' => $filterFunc,
'resource_no_folder_link' => $resource_no_folder_link,	'resource_no_folder_link' => $resource_no_folder_link,
'sort_html'=> $sort_html,	'sort_html'=> $sort_html,
'r' => $r};	'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 407 ENDSUBM	Line 408 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("</body></html>");
$r->rflush();	$r->rflush();
Line 437 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 445 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 465 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 559 sub lastTry {	Line 565 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 865 automatically.	Line 871 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 881 instruct the renderer to render only a p	Line 887 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 911 then only one line will be displayed for	Line 917 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 944 are allowing the user to open and close	Line 950 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 1013 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 1021 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::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 1057 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 1070 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 1097 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 1114 sub render_resource {	Line 1134 sub render_resource {
!$params->{'condensed'}) {	!$params->{'condensed'}) {
my $displaypart=$resource->part_display($part);	my $displaypart=$resource->part_display($part);
$partLabel = " (Part: $displaypart)";	$partLabel = " (Part: $displaypart)";
$link.='#'.&Apache::lonnet::escape($part);	if ($link!~/\#/) { $link.='#'.&Apache::lonnet::escape($part); }
$title = "";	$title = "";
}	}

Line 1123 sub render_resource {	Line 1143 sub render_resource {
}	}

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) {
Line 1142 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 1155 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 1170 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 1199 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 1330 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 1362 sub render {	Line 1390 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 1382 sub render {	Line 1410 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();
Line 1396 sub render {	Line 1424 sub render {
# 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'}) {
$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'};
#$currenturl=~s/^http\:\/\///;	#$currenturl=~s/^http\:\/\///;
#$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 1415 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 1432 sub render {	Line 1468 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)) {
Line 1491 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 1515 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 {	} else {
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .	$link='"navmaps?condition=1&filter=&'.$queryString.
"&here=" . Apache::lonnet::escape($here) .	'&here='.&Apache::lonnet::escape($here).'"';
"\">".&mt('Open All Folders')."</a>";	$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";	$result .= "\n";
}	}

# Check for any unread discussions in all resources.	# Check for any unread discussions in all resources.
if (!$args->{'resource_no_folder_link'}) {	if ($args->{'caller'} eq 'navmapsdisplay') {
my $totdisc = 0;	&add_linkitem($args->{'linkitems'},'clearbubbles',
my $haveDisc = '';	'document.clearbubbles.submit()',
my @allres=$navmap->retrieveResources();	'Mark all posts read');
foreach my $resource (@allres) {	my $time=time;
if ($resource->hasDiscussion()) {	$result .= (<<END);
my $ressymb;	<form name="clearbubbles" method="post" action="/adm/feedback">
if ($resource->symb() =~ m-(___adm/\w+/\w+)/(\d+)/bulletinboard$-) {	<input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
$ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';	<input type="hidden" name="navtime" value="$time" />
} else {	END
$ressymb = $resource->symb();	if ($args->{'sort'} eq 'discussion') {
	my $totdisc = 0;
	my $haveDisc = '';
	my @allres=$navmap->retrieveResources();
	foreach my $resource (@allres) {
	if ($resource->hasDiscussion()) {
	$haveDisc .= $resource->wrap_symb().':';
	$totdisc ++;
}	}
$haveDisc .= $ressymb.':';
$totdisc ++;
}	}
}	if ($totdisc > 0) {
if ($totdisc > 0) {	$haveDisc =~ s/:$//;
$haveDisc =~ s/:$//;	$result .= (<<END);
my %lt = &Apache::lonlocal::texthash(	<input type="hidden" name="navmaps" value="$haveDisc" />
'mapr' => 'Mark all posts read',	</form>
);
$result .= (<<END);
<a href="javascript:document.clearbubbles.submit()">$lt{'mapr'}</a> <a href="javascript:void(open('/adm/help/NavMaps_MarkPosts_Read.hlp', 'Help_for_NavMaps_MarkPosts', 'menubar=0,toolbar=1,scrollbars=1,width=350,height=400,resizable=yes'))" title="Online Help"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: NavMaps_MarkPostsLink)" /></a>
<form name="clearbubbles" method="post" action="/adm/feedback">
<input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
<input type="hidden" name="navmaps" value="$haveDisc" />
</form>
END	END
} else {	}
$result .= '<br />';
}	}
	$result.='</form>';
}	}

if ($args->{'sort_html'}) { $result.=$args->{'sort_html'}; }	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 {
	$result .= '</tr><tr>';
	}
	$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";	$result .= "<br />\n";
if ($r) {	if ($r) {
Line 1585 END	Line 1648 END
$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 1646 END	Line 1711 END
return &$oldFilterFunc($res);	return &$oldFilterFunc($res);
};	};
@resources=$navmap->retrieveResources(undef,$filterFunc);	@resources=$navmap->retrieveResources(undef,$filterFunc);
@resources= sort {lc($a->compTitle) cmp lc($b->compTitle)} @resources;	@resources= sort { &cmp_title($a,$b) } @resources;
} elsif ($args->{'sort'} eq 'duedate') {	} elsif ($args->{'sort'} eq 'duedate') {
@resources=$navmap->retrieveResources(undef,	my $oldFilterFunc = $filterFunc;
sub { shift->is_problem(); });	my $filterFunc=
@resources= sort	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) {	if ($a->duedate ne $b->duedate) {
return $a->duedate cmp $b->duedate;	return $a->duedate cmp $b->duedate;
} else {
lc($a->compTitle) cmp lc($b->compTitle)
}	}
	my $value=&cmp_title($a,$b);
	return $value;
} @resources;	} @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 {	} else {
#unknow sort mechanism or default	#unknow sort mechanism or default
undef($args->{'sort'});	undef($args->{'sort'});
Line 1774 END	Line 1856 END
# 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 1785 END	Line 1886 END

# 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 $src;
if ($args->{'sort'}) {
$src = $curRes->src(); # FIXME this is wrong for .pages
} else {
my $stack = $it->getStack();
$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) {
Line 1867 if (location.href.indexOf('#curloc')==-1	Line 1952 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 1929 successful, or B<undef> if not.	Line 2052 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 1945 See iterator documentation below.	Line 2064 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 1964 sub new {	Line 2084 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 1990 sub generate_course_user_opt {	Line 2110 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 $uhome=$env{'user.home'};
my $cid=$ENV{'request.course.id'};	my $cid=$env{'request.course.id'};
my $chome=$ENV{'course.'.$cid.'.home'};
my ($cdom,$cnum)=split(/\_/,$cid);	my ($cdom,$cnum)=split(/\_/,$cid);

my $userprefix=$uname.'_'.$udom.'_';	my %useropt; my %courseopt;

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

# --------------------------------------------------- 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);	%useropt=&Apache::lonnet::dump('resourcedata',$udom,$uname);
if ($reply!~/^error\:/) {	($tmp)=keys(%courseopt);
$userrdatas{$uname.'___'.$udom}=$reply;	if ($tmp=~/^error\:/) {
$userrdatas{$uname.'___'.$udom.'.last_cache'}=time;	undef(%useropt);
}	} elsif ( $tmp=~/no.such.host/i \|\| $tmp=~/con.lost/i ) {
# check to see if network failed	# check to see if network failed
elsif ( $reply=~/no.such.host/i \|\| $reply=~/con.*lost/i )	$self->{NETWORK_FAILURE} = 1;
{	undef(%useropt);
$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;	$self->{COURSE_OPT} = \%courseopt;
$self->{USER_OPT} = \%useropt;	$self->{USER_OPT} = \%useropt;
Line 2050 sub generate_email_discuss_status {	Line 2155 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,$cnum)=split(/\_/,$cid);

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 2071 sub generate_email_discuss_status {	Line 2176 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')) {
my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));	my $plain=
if ($plain=~/(Error\|Feedback) \[([^\]]+)\]/) {	&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
my ($what,$url)=($1,$2);	if ($plain=~/(Error\|Feedback) \[([^\]]+)\]/) {
my %status=	my ($what,$url)=($1,$2);
&Apache::lonnet::get('email_status',[$msgid]);
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 2098 sub generate_email_discuss_status {	Line 2194 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 2112 sub get_user_data {	Line 2210 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;
Line 2139 sub navhash {	Line 2237 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 2149 sub courseMapDefined {	Line 2247 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 {
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 2188 sub hasDiscussion {	Line 2273 sub hasDiscussion {
}	}
}	}

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

# 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 2286 resource in the navmap.	Line 2383 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 2302 in the navmap.	Line 2399 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 2329 sub parmval_real {	Line 2426 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 $uname=$env{'user.name'};
my $udom=$ENV{'user.domain'};	my $udom=$env{'user.domain'};

unless ($symb) { return ''; }	unless ($symb) { return ''; }
my $result='';	my $result='';
Line 2346 sub parmval_real {	Line 2443 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 $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;	my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;	my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
Line 2376 sub parmval_real {	Line 2473 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 2394 sub parmval_real {	Line 2489 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 2423 you're not sure if $res is already an ob	Line 2524 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 2431 function that takes a resource object as	Line 2532 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 2446 want to know is if I<any> resources matc	Line 2548 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.
Line 2484 sub retrieveResources {	Line 2586 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 2503 sub retrieveResources {	Line 2605 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 2533 sub hasResource {	Line 2635 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;
	use Apache::lonnet;

=pod	=pod

Line 2680 sub new {	Line 2785 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 2800 sub new {	Line 2905 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 2963 sub next {	Line 3069 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 3016 sub populateStack {	Line 3124 sub populateStack {
1;	1;

package Apache::lonnavmaps::DFSiterator;	package Apache::lonnavmaps::DFSiterator;
	use WeakRef;
	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
Line 3044 sub new {	Line 3154 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 3198 sub populateStack {	Line 3308 sub populateStack {
1;	1;

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

=pod	=pod
Line 3280 sub new {	Line 3390 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 3368 Returns the title of the resource.	Line 3478 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 3379 sub randompick {	Line 3490 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 3391 sub symb {	Line 3512 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
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 3720 sub weight {	Line 3855 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 3822 Returns the number of parts of the probl	Line 3957 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 3868 sub countParts {	Line 4013 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 3955 sub extractParts {	Line 4120 sub extractParts {
}	}


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

Line 3990 sub extractParts {	Line 4156 sub extractParts {
}	}
}	}
my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');	my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
	#
	# Reorder the arrays in the %responseIdHash and %responseTypeHash
if ($resorder) {	if ($resorder) {
my @resorder=split(/,/,$resorder);	my @resorder=split(/,/,$resorder);
foreach my $part (keys(%responseIdHash)) {	foreach my $part (keys(%responseIdHash)) {
my %resids = map { ($_,1) } @{ $responseIdHash{$part} };	my $i=0;
	my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
my @neworder;	my @neworder;
foreach my $possibleid (@resorder) {	foreach my $possibleid (@resorder) {
if (exists($resids{$possibleid})) {	if (exists($resids{$possibleid})) {
push(@neworder,$possibleid);	push(@neworder,$resids{$possibleid});
}	}
}	}
$responseIdHash{$part}=\@neworder;	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;
Line 4196 sub getCompletionStatus {	Line 4372 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 4532 sub getNext {	Line 4709 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 4560 sub browsePriv {	Line 4738 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.279
changed lines
	Added in v.1.325