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.151 and 1.177

version 1.151, 2003/03/03 13:03:58	version 1.177, 2003/04/19 20:47:41
Line 1	Line 1

# The LearningOnline Network with CAPA	# The LearningOnline Network with CAPA
# Navigate Maps Handler	# Navigate Maps Handler
#	#
Line 38	Line 37
# YEAR=2002	# YEAR=2002
# 1/1 Gerd Kortemeyer	# 1/1 Gerd Kortemeyer
# Oct-Nov Jeremy Bowers	# Oct-Nov Jeremy Bowers
	# YEAR=2003
	# Jeremy Bowers ... lots of days

package Apache::lonnavmaps;	package Apache::lonnavmaps;

Line 47 use Apache::loncommon();	Line 48 use Apache::loncommon();
use Apache::lonmenu();	use Apache::lonmenu();
use POSIX qw (floor strftime);	use POSIX qw (floor strftime);

my %navmaphash;
my %parmhash;

# symbolic constants	# symbolic constants
sub SYMB { return 1; }	sub SYMB { return 1; }
sub URL { return 2; }	sub URL { return 2; }
Line 97 my %colormap =	Line 95 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 cleanup {
if (tied(%navmaphash)){
&Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
unless (untie(%navmaphash)) {
&Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash');
}
}
if (tied(%parmhash)){
&Apache::lonnet::logthis('Cleanup navmaps: parmhash');
unless (untie(%parmhash)) {
&Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');
}
}
}

sub handler {	sub handler {
my $r = shift;	my $r = shift;
real_handler($r);	real_handler($r);
Line 156 sub real_handler {	Line 139 sub real_handler {
$r->print("<title>Navigate Course Contents</title>");	$r->print("<title>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']);

# ----------------------------------------------------- Force menu registration	# ----------------------------------------------------- Force menu registration
my $addentries='';	my $addentries='';
if ($ENV{'form.register'}) {	if ($ENV{'form.register'}) {
Line 175 sub real_handler {	Line 159 sub real_handler {
# Now that we've displayed some stuff to the user, init the navmap	# Now that we've displayed some stuff to the user, init the navmap
$navmap->init();	$navmap->init();


$r->print('<br> ');	$r->print('<br> ');
$r->rflush();	$r->rflush();

Line 186 sub real_handler {	Line 169 sub real_handler {
return OK;	return OK;
}	}

	# See if there's only one map in the top-level... if so,
	# automatically display it
	my $iterator = $navmap->getIterator(undef, undef, undef, 0);
	my $depth = 1;
	$iterator->next();
	my $curRes = $iterator->next();
	my $sequenceCount = 0;
	my $sequenceId;
	while ($depth > 0) {
	if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
	if ($curRes == $iterator->END_MAP()) { $depth--; }

	if (ref($curRes) && $curRes->is_sequence()) {
	$sequenceCount++;
	$sequenceId = $curRes->map_pc();
	}

	$curRes = $iterator->next();
	}

	if ($sequenceCount == 1) {
	# The automatic iterator creation in the render call
	# will pick this up.
	$ENV{'form.filter'} = "$sequenceId";
	}

# renderer call	# renderer call
my $render = render({ 'cols' => [0,1,2,3],	my $render = render({ 'cols' => [0,1,2,3],
'url' => '/adm/navmaps',	'url' => '/adm/navmaps',
#'printKey' => 1,	'navmap' => $navmap,
	'suppressNavmap' => 1,
'r' => $r});	'r' => $r});

$navmap->untieHashes();	$navmap->untieHashes();
Line 333 sub lastTry {	Line 343 sub lastTry {
}	}

# 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{'user.adv'};	return $ENV{'request.role.adv'};
}	}


Line 446 sub timeToHumanString {	Line 457 sub timeToHumanString {

=pod	=pod

=head1 navmap renderer	=head1 NAME

The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this.	Apache::lonnavmap - Subroutines to handle and render the navigation maps

Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors.	=head1 SYNOPSIS

The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}).	The main handler generates the navigational listing for the course,
	the other objects export this information in a usable fashion for
	other modules

=head2 Overview of Columns	=head1 Object: render

	The navmap renderer package provides a sophisticated rendering of the
	standard navigation maps interface into HTML. The provided nav map
	handler is actually just a glorified call to this.

	Because of the large number of parameters this function presents,
	instead of passing it arguments as is normal, pass it in an anonymous
	hash with the given options. This is because there is no obvious order
	you may wish to override these in and a hash is easier to read and
	understand then "undef, undef, undef, 1, undef, undef, renderButton,
	undef, 0" when you mostly want default behaviors.

The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table.	The package provides a function called 'render', called as
	Apache::lonnavmaps::renderer->render({}).

Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer.	=head2 Overview of Columns

At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it.	The renderer will build an HTML table for the navmap and return
	it. The table is consists of several columns, and a row for each
	resource (or possibly each part). You tell the renderer how many
	columns to create and what to place in each column, optionally using
	one or more of the preparent columns, and the renderer will assemble
	the table.

	Any additional generally useful column types should be placed in the
	renderer code here, so anybody can use it anywhere else. Any code
	specific to the current application (such as the addition of <input>
	elements in a column) should be placed in the code of the thing using
	the renderer.

	At the core of the renderer is the array reference COLS (see Example
	section below for how to pass this correctly). The COLS array will
	consist of entries of one of two types of things: Either an integer
	representing one of the pre-packaged column types, or a sub reference
	that takes a resource reference, a part number, and a reference to the
	argument hash passed to the renderer, and returns a string that will
	be inserted into the HTML representation as it.

The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist:	The pre-packaged column names are refered to by constants in the
	Apache::lonnavmaps::renderer namespace. The following currently exist:

=over 4	=over 4

=item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash:	=item * B<resource>:

	The general info about the resource: Link, icon for the type, etc. The
	first column in the standard nav map display. This column also accepts
	the following parameter in the renderer hash:

=over 4	=over 4

=item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links.	=item * B<resource_nolink>:

	If true, the resource will not be linked. Default: false, resource
	will have links.

=item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count.	=item * B<resource_part_count>:

=item * B<resource_no_folder_link>: If true, the resource's folder will not be clickable to open or close it. Default is false.	If true (default), the resource will show a part count if the full
	part list is not displayed. If false, the resource will never show a
	part count.

	=item * B<resource_no_folder_link>:

	If true, the resource's folder will not be clickable to open or close
	it. Default is false. True implies printCloseAll is false, since you
	can't close or open folders when this is on anyhow.

=back	=back

=item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map.	=item B<communication_status>:

	Whether there is discussion on the resource, email for the user, or
	(lumped in here) perl errors in the execution of the problem. This is
	the second column in the main nav map.

=item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap.	=item B<quick_status>:

=item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap.	An icon for the status of a problem, with four possible states:
	Correct, incorrect, open, or none (not open yet, not a problem). The
	third column of the standard navmap.

	=item B<long_status>:

	A text readout of the details of the current status of the problem,
	such as "Due in 22 hours". The fourth column of the standard navmap.

=back	=back

If you add any others please be sure to document them here.	If you add any others please be sure to document them here.

An example of a column renderer that will show the ID number of a resource, along with the part name if any:	An example of a column renderer that will show the ID number of a
	resource, along with the part name if any:

sub {	sub {
my ($resource, $part, $params) = @_;	my ($resource, $part, $params) = @_;
Line 496 An example of a column renderer that wil	Line 568 An example of a column renderer that wil
return '<td>' . $resource->{ID} . '</td>';	return '<td>' . $resource->{ID} . '</td>';
}	}

Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc.	Note these functions are responsible for the TD tags, which allow them
	to override vertical and horizontal alignment, etc.

=head2 Parameters	=head2 Parameters

Most of these parameters are only useful if you are not using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically.	Most of these parameters are only useful if you are not using the
	folder interface (i.e., the default first column), which is probably
	the common case. If you are using this interface, then you should be
	able to get away with just using 'cols' (to specify the columns
	shown), 'url' (necessary for the folders to link to the current screen
	correctly), and possibly 'queryString' if your app calls for it. In
	that case, maintaining the state of the folders will be done
	automatically.

=over 4	=over 4

=item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The 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 one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information, plus the 'iterator_map' parameter if any.	=item * B<iterator>:

	A reference to a fresh ::iterator to use from the navmaps. The
	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
	one is not passed, the renderer will attempt to construct one from
	ENV{'form.filter'} and ENV{'form.condition'} information, plus the
	'iterator_map' parameter if any.

	=item * B<iterator_map>:

	If you are letting the renderer do the iterator handling, you can
	instruct the renderer to render only a particular map by passing it
	the source of the map you want to process, like
	'/res/103/jerf/navmap.course.sequence'.

	=item * B<navmap>:

	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
	one will be constructed based on ENV info. This is useful to do basic
	error checking before passing it off to render.

	=item * B<r>:

	The standard Apache response object. This must be passed to the
	renderer or the course hash will be locked.

	=item * B<cols>:

	An array reference

	=item * B<showParts>:

	A flag. If yes (default), a line for the resource itself, and a line
	for each part will be displayed. If not, only one line for each
	resource will be displayed.

	=item * B<condenseParts>:

	A flag. If yes (default), if all parts of the problem have the same
	status and that status is Nothing Set, Correct, or Network Failure,
	then only one line will be displayed for that resource anyhow. If no,
	all parts will always be displayed. If showParts is 0, this is
	ignored.

	=item * B<jumpCount>:

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

=item * B<iterator_map>: If you are letting the renderer do the iterator handling, you can instruct the renderer to render only a particular map by passing it the source of the map you want to process, like '/res/103/jerf/navmap.course.sequence'.	=item * B<here>:

=item * B<navmap>: 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 one will be constructed based on ENV info. This is useful to do basic error checking before passing it off to render.	A Symb identifying where to place the 'here' marker. Default empty,
	which means no marker.

=item * B<cols>: An array reference	=item * B<indentString>:

=item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed.	A string identifying the indentation string to use. By default, this
	is a 25 pixel whitespace image with no alt text.

=item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored.	=item * B<queryString>:

=item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information.	A string which will be prepended to the query string used when the
	folders are opened or closed.

=item * B<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info.	=item * B<url>:

=item * B<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL.	The url the folders will link to, which should be the current
	page. Required if the resource info column is shown.

=item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.	=item * B<currentJumpIndex>:

=item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed.	Describes the currently-open row number to cause the browser to jump
	to, because the user just opened that folder. By default, pulled from
	the Jump information in the ENV{'form.*'}.

=item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown.	=item * B<printKey>:

=item * B<currentJumpIndex>: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}.	If true, print the key that appears on the top of the standard
	navmaps. Default is false.

=item * B<r>: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself.	=item * B<printCloseAll>:

=item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.	If true, print the "Close all folders" or "open all folders"
	links. Default is true.

=item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.	=item * B<filterFunc>:

=item * B<filterFunc>: A function that takes the resource object as its only parameter and returns a true or false value. If true, the resource is displayed. If false, it is simply skipped in the display. By default, all resources are showne.	A function that takes the resource object as its only parameter and
	returns a true or false value. If true, the resource is displayed. If
	false, it is simply skipped in the display. By default, all resources
	are shown.

	=item * B<suppressNavmaps>:

	If true, will not display Navigate Content resources. Default to
	false.

=back	=back

=head2 Additional Info	=head2 Additional Info

In addition to the parameters you can pass to the renderer, which will be passed through unchange to the column renderers, the renderer will generate the following information which your renderer may find useful:	In addition to the parameters you can pass to the renderer, which will
	be passed through unchange to the column renderers, the renderer will
If you want to know how many rows were printed, the 'counter' element of the hash passed into the render function will contain the count. You may want to check whether any resources were printed at all.	generate the following information which your renderer may find
	useful:

	If you want to know how many rows were printed, the 'counter' element
	of the hash passed into the render function will contain the
	count. You may want to check whether any resources were printed at
	all.

=over 4	=over 4

Line 590 sub render_resource {	Line 744 sub render_resource {
my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";	my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";

if ($resource->is_problem()) {	if ($resource->is_problem()) {
if ($part eq "0" \|\| $params->{'condensed'}) {	if ($part eq "" \|\| $params->{'condensed'}) {
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';	$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
} else {	} else {
$icon = $params->{'indentString'};	$icon = $params->{'indentString'};
Line 617 sub render_resource {	Line 771 sub render_resource {
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='	$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
. $params->{'hereType'} . '&here=' .	. $params->{'hereType'} . '&here=' .
&Apache::lonnet::escape($params->{'here'}) .	&Apache::lonnet::escape($params->{'here'}) .
'&jumpType=' . SYMB() . '&jump=' .	'&jump=' .
&Apache::lonnet::escape($resource->symb()) .	&Apache::lonnet::escape($resource->symb()) .
"&folderManip=1'>";	"&folderManip=1'>";
} else {	} else {
Line 653 sub render_resource {	Line 807 sub render_resource {
my $curMarkerEnd = '';	my $curMarkerEnd = '';

# Is this the current resource?	# Is this the current resource?
if (!$params->{'displayedHereMarker'} &&	if (!$params->{'displayedHereMarker'} &&
(($params->{'hereType'} == SYMB() &&	$resource->symb() eq $params->{'here'} ) {
$resource->symb() eq $params->{'here'}) \|\|
($params->{'hereType'} == URL() &&
$resource->src() eq $params->{'here'}))) {
$curMarkerBegin = '<font color="red" size="+2">> </font>';	$curMarkerBegin = '<font color="red" size="+2">> </font>';
$curMarkerEnd = '<font color="red" size="+2"><</font>';	$curMarkerEnd = '<font color="red" size="+2"><</font>';
	$params->{'displayedHereMarker'} = 1;
}	}

if ($resource->is_problem() && $part ne "0" &&	if ($resource->is_problem() && $part ne "" &&
!$params->{'condensed'}) {	!$params->{'condensed'}) {
$partLabel = " (Part $part)";	$partLabel = " (Part $part)";
$title = "";	$title = "";
}	}

if ($params->{'multipart'} && $params->{'condensed'}) {	if ($params->{'condensed'} && $resource->countParts() > 1) {
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';	$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
}	}

Line 805 sub render {	Line 957 sub render {
$navmap = $args->{'navmap'};	$navmap = $args->{'navmap'};
}	}

	my $r = $args->{'r'};
my $queryString = $args->{'queryString'};	my $queryString = $args->{'queryString'};
my $jumpToURL = $args->{'jumpToURL'};	my $jump = $args->{'jump'};
my $jumpToSymb = $args->{'jumpToSymb'};	my $here = $args->{'here'};
my $jumpType;	my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
my $hereURL = $args->{'hereURL'};
my $hereSymb = $args->{'hereSymb'};
my $hereType;
my $here;
my $jump;
my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0);
my $currentJumpDelta = 2; # change this to change how many resources are displayed	my $currentJumpDelta = 2; # change this to change how many resources are displayed
# before the current resource when using #current	# before the current resource when using #current

Line 848 sub render {	Line 995 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.

# We're coming from the remote. We have either a url, a symb, or nothing,	if ($ENV{'form.postsymb'}) {
# and we need to figure out what.	$here = $jump = $ENV{'form.postsymb'};
# Preference: Symb

if ($ENV{'form.symb'}) {
$hereType = $jumpType = SYMB();
$here = $jump = $ENV{'form.symb'};
} 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/^[^\/]+//;

$hereType = $jumpType = URL;	$here = $jump = &Apache::lonnet::symbread($currenturl);
$here = $jump = $currenturl;
} else {
# Nothing
$hereType = $jumpType = NOTHING();
}	}

# 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);
my $depth = 1;	my $depth = 1;
$mapIterator->next(); # discard the first BEGIN_MAP	$mapIterator->next(); # discard the first BEGIN_MAP
my $curRes = $mapIterator->next();	my $curRes = $mapIterator->next();
my $counter = 0;
my $found = 0;	my $found = 0;

# 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
Line 882 sub render {	Line 1020 sub render {
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }	if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $mapIterator->END_MAP()) { $depth--; }	if ($curRes == $mapIterator->END_MAP()) { $depth--; }

if (ref($curRes) &&	if (ref($curRes) && $curRes->symb() eq $here) {
($hereType == SYMB() && $curRes->symb() eq $here) \|\|
(ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {
my $mapStack = $mapIterator->getStack();	my $mapStack = $mapIterator->getStack();

# Ensure the parent maps are open	# Ensure the parent maps are open
Line 900 sub render {	Line 1036 sub render {

$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
}	}

# Since we changed the folders, (re-)locate the jump point, if any
$mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
$depth = 1;
$mapIterator->next();
$curRes = $mapIterator->next();
my $foundJump = 0;

while ($depth > 0 && !$foundJump) {
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
if ($curRes == $mapIterator->END_MAP()) { $depth--; }
if (ref($curRes)) { $counter++; }

if (ref($curRes) &&
(($jumpType == SYMB() && $curRes->symb() eq $jump) \|\|
($jumpType == URL() && $curRes->src() eq $jump))) {

# This is why we have to use the main iterator instead of the
# potentially faster DFS: The count has to be the same, so
# the order has to be the same, which DFS won't give us.
$currentJumpIndex = $counter;
$foundJump = 1;
}

$curRes = $mapIterator->next();
}

}	}

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
$hereType = $ENV{'form.hereType'};
$here = $ENV{'form.here'};	$here = $ENV{'form.here'};
$jumpType = $ENV{'form.jumpType'} \|\| NOTHING();
$jump = $ENV{'form.jump'};	$jump = $ENV{'form.jump'};
}	}

Line 943 sub render {	Line 1051 sub render {

# 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($r,
$ENV{"request.course.fn"}.".db",	$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 1, 1);	$ENV{"request.course.fn"}."_parms.db", 1, 1);
$mustCloseNavMap = 1;	$mustCloseNavMap = 1;
Line 964 sub render {	Line 1072 sub render {
}	}
}	}

	# (re-)Locate the jump point, if any
	my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
	my $depth = 1;
	$mapIterator->next();
	my $curRes = $mapIterator->next();
	my $foundJump = 0;
	my $counter = 0;

	while ($depth > 0 && !$foundJump) {
	if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
	if ($curRes == $mapIterator->END_MAP()) { $depth--; }
	if (ref($curRes)) { $counter++; }

	if (ref($curRes) && $jump eq $curRes->symb()) {

	# This is why we have to use the main iterator instead of the
	# potentially faster DFS: The count has to be the same, so
	# the order has to be the same, which DFS won't give us.
	$args->{'currentJumpIndex'} = $counter;
	$foundJump = 1;
	}

	$curRes = $mapIterator->next();
	}

my $showParts = setDefault($args->{'showParts'}, 1);	my $showParts = setDefault($args->{'showParts'}, 1);
my $condenseParts = setDefault($args->{'condenseParts'}, 1);	my $condenseParts = setDefault($args->{'condenseParts'}, 1);
# keeps track of when the current resource is found,	# keeps track of when the current resource is found,
# so we can back up a few and put the anchor above the	# so we can back up a few and put the anchor above the
# current resource	# current resource
my $r = $args->{'r'};
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; }
Line 998 sub render {	Line 1130 sub render {
$result .= '</tr></table>';	$result .= '</tr></table>';
}	}

if ($printCloseAll) {	if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
if ($condition) {	if ($condition) {
$result.="<a href=\"navmaps?condition=0&filter=&$queryString" .	$result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
"&hereType=$hereType&here=" . Apache::lonnet::escape($here) .	"&here=" . Apache::lonnet::escape($here) .
"\">Close All Folders</a>";	"\">Close All Folders</a>";
} else {	} else {
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .	$result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
"&hereType=$hereType&here=" . Apache::lonnet::escape($here) .	"&here=" . Apache::lonnet::escape($here) .
"\">Open All Folders</a>";	"\">Open All Folders</a>";
}	}
$result .= "<br /><br />\n";	$result .= "<br /><br />\n";
Line 1037 sub render {	Line 1169 sub render {

my $displayedJumpMarker = 0;	my $displayedJumpMarker = 0;
# Set up iteration.	# Set up iteration.
my $depth = 1;	$depth = 1;
$it->next(); # discard initial BEGIN_MAP	$it->next(); # discard initial BEGIN_MAP
my $curRes = $it->next();	$curRes = $it->next();
my $now = time();	my $now = time();
my $in24Hours = $now + 24 * 60 * 60;	my $in24Hours = $now + 24 * 60 * 60;
my $rownum = 0;	my $rownum = 0;

# export "here" marker information	# export "here" marker information
$args->{'here'} = $here;	$args->{'here'} = $here;
$args->{'hereType'} = $hereType;

while ($depth > 0) {	while ($depth > 0) {
if ($curRes == $it->BEGIN_MAP()) { $depth++; }	if ($curRes == $it->BEGIN_MAP()) { $depth++; }
Line 1068 sub render {	Line 1199 sub render {

# If this isn't an actual resource, continue on	# If this isn't an actual resource, continue on
if (!ref($curRes)) {	if (!ref($curRes)) {
$curRes = $it->next();
next;	next;
}	}

Line 1076 sub render {	Line 1206 sub render {

# If this has been filtered out, continue on	# If this has been filtered out, continue on
if (!(&$filterFunc($curRes))) {	if (!(&$filterFunc($curRes))) {
$curRes = $it->next();
$args->{'isNewBranch'} = 0; # Don't falsely remember this	$args->{'isNewBranch'} = 0; # Don't falsely remember this
next;	next;
}	}

	# If we're suppressing navmaps and this is a navmap, continue on
	if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
	next;
	}

# Does it have multiple parts?	# Does it have multiple parts?
$args->{'multipart'} = 0;	$args->{'multipart'} = 0;
$args->{'condensed'} = 0;	$args->{'condensed'} = 0;
Line 1093 sub render {	Line 1227 sub render {

if ($condenseParts) { # do the condensation	if ($condenseParts) { # do the condensation
if (!$curRes->opendate("0")) {	if (!$curRes->opendate("0")) {
@parts = ("0");	@parts = ();
$args->{'condensed'} = 1;	$args->{'condensed'} = 1;
}	}
if (!$args->{'condensed'}) {	if (!$args->{'condensed'}) {
Line 1125 sub render {	Line 1259 sub render {
if (($statusAllSame && defined($condenseStatuses{$status})) \|\|	if (($statusAllSame && defined($condenseStatuses{$status})) \|\|
($dueAllSame && $status == $curRes->OPEN && $statusAllSame)\|\|	($dueAllSame && $status == $curRes->OPEN && $statusAllSame)\|\|
($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){	($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
@parts = ($parts[1]);	@parts = ();
$args->{'condensed'} = 1;	$args->{'condensed'} = 1;
}	}

}	}
}	}
	}

} else {
# Not showing parts
@parts = ("0"); # show main part only
}

# If the multipart problem was condensed, "forget" it was multipart	# If the multipart problem was condensed, "forget" it was multipart
if (scalar(@parts) == 1) {	if (scalar(@parts) == 1) {
$args->{'multipart'} = 0;	$args->{'multipart'} = 0;
}	}

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

# 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) {
	if ($part eq '0') {
	next;
	}
$rownum ++;	$rownum ++;
my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];	my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];

Line 1192 sub render {	Line 1317 sub render {
$result .= " </tr>\n";	$result .= " </tr>\n";
$args->{'isNewBranch'} = 0;	$args->{'isNewBranch'} = 0;
}	}

if ($r && $rownum % 20 == 0) {	if ($r && $rownum % 20 == 0) {
$r->print($result);	$r->print($result);
$result = "";	$result = "";
$r->rflush();	$r->rflush();
}	}
	} continue {
$curRes = $it->next();	$curRes = $it->next();
}	}

# Print out the part that jumps to #curloc if it exists	# Print out the part that jumps to #curloc if it exists
	# delay needed because the browser is processing the jump before
	# it finishes rendering, so it goes to the wrong place!
	# onload might be better, but this routine has no access to that.
	# On mozilla, the 0-millisecond timeout seems to prevent this;
	# it's quite likely this might fix other browsers, too, and
	# certainly won't hurt anything.
if ($displayedJumpMarker) {	if ($displayedJumpMarker) {
$result .= "<script>location += \"#curloc\";</script>\n";	$result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n";
}	}

$result .= "</table>";	$result .= "</table>";
Line 1226 package Apache::lonnavmaps::navmap;	Line 1357 package Apache::lonnavmaps::navmap;

=pod	=pod

lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere.	lonnavmaps provides functions and objects for dealing with the
	compiled course hashes generated when a user enters the course, the
	Apache handler for the "Navigation Map" button, and a flexible
	prepared renderer for navigation maps that are easy to use anywhere.

=head1 navmap object: Encapsulating the compiled nav map	=head1 Object: navmap

navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.	Encapsulating the compiled nav map

Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.	navmap is an object that encapsulates a compiled course map and
	provides a reasonable interface to it.

	Most notably it provides a way to navigate the map sensibly and a
	flexible iterator that makes it easy to write various renderers based
	on nav maps.

You must obtain resource objects through the navmap object.	You must obtain resource objects through the navmap object.

Line 1240 You must obtain resource objects through	Line 1379 You must obtain resource objects through

=over 4	=over 4

=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.	=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions,
	genMailDiscussStatus):

	Binds a new navmap object to the compiled nav map hash and parm hash
	given as filenames. genCourseAndUserOptions is a flag saying whether
	the course options and user options hash should be generated. This is
	for when you are using the parameters of the resources that require
	them; see documentation in resource object
	documentation. genMailDiscussStatus causes the nav map to retreive
	information about the email and discussion status of
	resources. Returns the navmap object if this is successful, or
	B<undef> if not. You must check for undef; errors will occur when you
	try to use the other methods otherwise.

	=item * B<getIterator>(first, finish, filter, condition):

=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.	See iterator documentation below.

=cut	=cut

Line 1270 sub new {	Line 1423 sub new {

# tie the nav hash	# tie the nav hash

	my %navmaphash;
	my %parmhash;
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},	if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
&GDBM_READER(), 0640))) {	&GDBM_READER(), 0640))) {
return undef;	return undef;
Line 1278 sub new {	Line 1433 sub new {
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},	if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
&GDBM_READER(), 0640)))	&GDBM_READER(), 0640)))
{	{
untie $self->{PARM_HASH};	untie %{$self->{PARM_HASH}};
return undef;	return undef;
}	}

$self->{HASH_TIED} = 1;
$self->{NAV_HASH} = \%navmaphash;	$self->{NAV_HASH} = \%navmaphash;
$self->{PARM_HASH} = \%parmhash;	$self->{PARM_HASH} = \%parmhash;
$self->{INITED} = 0;	$self->{INITED} = 0;
Line 1430 sub getIterator {	Line 1584 sub getIterator {
# unties the hash when done	# unties the hash when done
sub untieHashes {	sub untieHashes {
my $self = shift;	my $self = shift;
untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});	untie %{$self->{NAV_HASH}};
untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});	untie %{$self->{PARM_HASH}};
$self->{HASH_TIED} = 0;
}

# when the object is destroyed, be sure to untie all the hashes we tied.
sub DESTROY {
my $self = shift;
$self->untieHashes();
}	}

# Private method: Does the given resource (as a symb string) have	# Private method: Does the given resource (as a symb string) have
Line 1476 sub getErrors {	Line 1623 sub getErrors {

=pod	=pod

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

	Based on the ID of the resource (1.1, 3.2, etc.), get a resource
	object for that resource. This method, or other methods that use it
	(as in the resource object) is the only proper way to obtain a
	resource object.

=cut	=cut

Line 1500 sub getById {	Line 1652 sub getById {
return "Apache::lonnavmaps::resource"->new($self, $id);	return "Apache::lonnavmaps::resource"->new($self, $id);
}	}

	sub getBySymb {
	my $self = shift;
	my $symb = shift;
	my ($mapUrl, $id, $filename) = split (/___/, $symb);
	my $map = $self->getResourceByUrl($mapUrl);
	return $self->getById($map->map_pc() . '.' . $id);
	}

=pod	=pod

=item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.	=item * B<firstResource>():

	Returns a resource object reference corresponding to the first
	resource in the navmap.

=cut	=cut

Line 1515 sub firstResource {	Line 1678 sub firstResource {

=pod	=pod

=item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.	=item * B<finishResource>():

	Returns a resource object reference corresponding to the last resource
	in the navmap.

=cut	=cut

Line 1612 sub parmval_real {	Line 1778 sub parmval_real {
my ($space,@qualifier)=split(/\./,$rwhat);	my ($space,@qualifier)=split(/\./,$rwhat);
my $qualifier=join('.',@qualifier);	my $qualifier=join('.',@qualifier);
unless ($space eq '0') {	unless ($space eq '0') {
my ($part,$id)=split(/\_/,$space);	my @parts=split(/_/,$space);
if ($id) {	my $id=pop(@parts);
my $partgeneral=$self->parmval($part.".$qualifier",$symb);	my $part=join('_',@parts);
if (defined($partgeneral)) { return $partgeneral; }	if ($part eq '') { $part='0'; }
} else {	my $partgeneral=$self->parmval($part.".$qualifier",$symb);
my $resourcegeneral=$self->parmval("0.$qualifier",$symb);	if (defined($partgeneral)) { return $partgeneral; }
if (defined($resourcegeneral)) { return $resourcegeneral; }
}
}	}
return '';	return '';
}	}

=pod	=pod

=item * B<getResourceByUrl>(url): Retrieves a resource object by URL of the resource. If passed a resource object, it will simply return it, so it is safe to use this method in code like "$res = $navmap->getResourceByUrl($res)", if you're not sure if $res is already an object, or just a URL. If the resource appears multiple times in the course, only the first instance will be returned. As a result, this is probably useful only for maps.	=item * B<getResourceByUrl>(url):

=item * B<retrieveResources>(map, filterFunc, recursive, bailout): 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 function that takes a resource object as its one argument and returns true if the resource should be included, or false if it should not be. If recursive is true, the map will be recursively examined, 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, the map is the top-level map of the course, filterFunc is a function that always returns 1, recursive is true, bailout is false. The resources will be returned in a list reference containing the resource objects for the corresponding resources, with B<no structure information> in the list; regardless of branching, recursion, etc., it will be a flat list.	Retrieves a resource object by URL of the resource. If passed a
	resource object, it will simply return it, so it is safe to use this
	method in code like "$res = $navmap->getResourceByUrl($res)", if
	you're not sure if $res is already an object, or just a URL. If the
	resource appears multiple times in the course, only the first instance
	will be returned. As a result, this is probably useful only for maps.

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

	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
	function that takes a resource object as its one argument and returns
	true if the resource should be included, or false if it should not
	be. If recursive is true, the map will be recursively examined,
	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,
	the map is the top-level map of the course, filterFunc is a function
	that always returns 1, recursive is true, bailout is false. The
	resources will be returned in a list containing the resource objects
	for the corresponding resources, with B<no structure information> in
	the list; regardless of branching, recursion, etc., it will be a flat
	list.

	Thus, this is suitable for cases where you don't want the structure,
	just a list of all resources. It is also suitable for finding out how
	many resources match a given description; for this use, if all you
	want to know is if I<any> resources match the description, the bailout
	parameter will allow you to avoid potentially expensive enumeration of
	all matching resources.

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 many resources match a given description; for this use, if all you want to know is if I<any> resources match the description, the bailout parameter will allow you to avoid potentially expensive enumeration of all matching resources.	=item * B<hasResources>(map, filterFunc, recursive):

=item * B<hasResources>(map, filterFunc, recursive): Convience method for	Convience method for

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

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

=cut	=cut

Line 1669 sub retrieveResources {	Line 1862 sub retrieveResources {

# 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->getMapByUrl($map);	$map = $self->getResourceByUrl($map);
}	}

# Check the map's validity.	# Check the map's validity.
Line 1732 package Apache::lonnavmaps::iterator;	Line 1925 package Apache::lonnavmaps::iterator;

=back	=back

=head1 navmap Iterator	=head1 Object: navmap Iterator

An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.

To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:	An I<iterator> encapsulates the logic required to traverse a data
	structure. navmap uses an iterator to traverse the course map
	according to the criteria you wish to use.

	To obtain an iterator, call the B<getIterator>() function of a
	B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
	directly.) This will return a reference to the iterator:

C<my $resourceIterator = $navmap-E<gt>getIterator();>	C<my $resourceIterator = $navmap-E<gt>getIterator();>

Line 1748 getIterator behaves as follows:	Line 1945 getIterator behaves as follows:

=over 4	=over 4

=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content.	=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):

Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.

The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:	All parameters are optional. firstResource is a resource reference
	corresponding to where the iterator should start. It defaults to
	navmap->firstResource() for the corresponding nav map. finishResource
	corresponds to where you want the iterator to end, defaulting to
	navmap->finishResource(). filterHash is a hash used as a set
	containing strings representing the resource IDs, defaulting to
	empty. Condition is a 1 or 0 that sets what to do with the filter
	hash: If a 0, then only resource that exist IN the filterHash will be
	recursed on. If it is a 1, only resources NOT in the filterHash will
	be recursed on. Defaults to 0. forceTop is a boolean value. If it is
	false (default), the iterator will only return the first level of map
	that is not just a single, 'redirecting' map. If true, the iterator
	will return all information, starting with the top-level map,
	regardless of content. returnTopMap, if true (default false), will
	cause the iterator to return the top-level map object (resource 0.0)
	before anything else.

	Thus, by default, only top-level resources will be shown. Change the
	condition to a 1 without changing the hash, and all resources will be
	shown. Changing the condition to 1 and including some values in the
	hash will allow you to selectively suppress parts of the navmap, while
	leaving it on 0 and adding things to the hash will allow you to
	selectively add parts of the nav map. See the handler code for
	examples.

	The iterator will return either a reference to a resource object, or a
	token representing something in the map, such as the beginning of a
	new branch. The possible tokens are:

=over 4	=over 4

=item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.	=item * BEGIN_MAP:

=item * END_MAP: The map is now done.	A new map is being recursed into. This is returned I<after> the map
	resource itself is returned.

=item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.	=item * END_MAP:

=item * END_BRANCH: The branch is now done.	The map is now done.

	=item * BEGIN_BRANCH:

	A branch is now starting. The next resource returned will be the first
	in that branch.

	=item * END_BRANCH:

	The branch is now done.

=back	=back

The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.	The tokens are retreivable via methods on the iterator object, i.e.,
	$iterator->END_MAP.

Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned.	Maps can contain empty resources. The iterator will automatically skip
	over such resources, but will still treat the structure
	correctly. Thus, a complicated map with several branches, but
	consisting entirely of empty resources except for one beginning or
	ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
	but only one resource will be returned.

=back	=back

Line 1823 sub new {	Line 2061 sub new {
# Do we want to automatically follow "redirection" maps?	# Do we want to automatically follow "redirection" maps?
$self->{FORCE_TOP} = shift;	$self->{FORCE_TOP} = shift;

	# Do we want to return the top-level map object (resource 0.0)?
	$self->{RETURN_0} = shift;
	# have we done that yet?
	$self->{HAVE_RETURNED_0} = 0;

# Now, we need to pre-process the map, by walking forward and backward	# Now, we need to pre-process the map, by walking forward and backward
# over the parts of the map we're going to look at.	# over the parts of the map we're going to look at.

Line 1936 sub new {	Line 2179 sub new {
sub next {	sub next {
my $self = shift;	my $self = shift;

	# If we want to return the top-level map object, and haven't yet,
	# do so.
	if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
	$self->{HAVE_RETURNED_0} = 1;
	return $self->{NAV_MAP}->getById('0.0');
	}

if ($self->{RECURSIVE_ITERATOR_FLAG}) {	if ($self->{RECURSIVE_ITERATOR_FLAG}) {
# grab the next from the recursive iterator	# grab the next from the recursive iterator
my $next = $self->{RECURSIVE_ITERATOR}->next();	my $next = $self->{RECURSIVE_ITERATOR}->next();
Line 2078 sub next {	Line 2328 sub next {

=pod	=pod

The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).	The other method available on the iterator is B<getStack>, which
	returns an array populated with the current 'stack' of maps, as
	references to the resource objects. Example: This is useful when
	making the navigation map, as we need to check whether we are under a
	page map to see if we need to link directly to the resource, or to the
	page. The first elements in the array will correspond to the top of
	the stack (most inclusive map).

=cut	=cut

Line 2271 use Apache::lonnet;	Line 2527 use Apache::lonnet;

=head1 Object: resource	=head1 Object: resource

A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.	A resource object encapsulates a resource in a resource map, allowing
	easy manipulation of the resource, querying the properties of the
A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.	resource (including user properties), and represents a reference that
	can be used as the canonical representation of the resource by
You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource.	lonnavmap clients like renderers.

	A resource only makes sense in the context of a navmap, as some of the
	data is stored in the navmap object.

	You will probably never need to instantiate this object directly. Use
	Apache::lonnavmaps::navmap, and use the "start" method to obtain the
	starting resource.

=head2 Public Members	=head2 Public Members

resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.	resource objects have a hash called DATA ($resourceRef->{DATA}) that
	you can store whatever you want in. This allows you to easily do
	two-pass algorithms without worrying about managing your own
	resource->data hash.

=head2 Methods	=head2 Methods

=over 4	=over 4

=item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.	=item * B<new>($navmapRef, $idString):

	The first arg is a reference to the parent navmap object. The second
	is the idString of the resource itself. Very rarely, if ever, called
	directly. Use the nav map->getByID() method.

=back	=back

Line 2328 sub navHash {	Line 2598 sub navHash {

B<Metadata Retreival>	B<Metadata Retreival>

These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.	These are methods that help you retrieve metadata about the resource:
	Method names are based on the fields in the compiled course
	representation.

=over 4	=over 4

=item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem").	=item * B<compTitle>:

	Returns a "composite title", that is equal to $res->title() if the
	resource has a title, and is otherwise the last part of the URL (e.g.,
	"problem.problem").

	=item * B<ext>:

	Returns true if the resource is external.

	=item * B<goesto>:

	Returns the "goesto" value from the compiled nav map. (It is likely
	you want to use B<getNext> instead.)

	=item * B<kind>:

	Returns the kind of the resource from the compiled nav map.

=item * B<ext>: Returns true if the resource is external.	=item * B<randomout>:

=item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)	Returns true if this resource was chosen to NOT be shown to the user
	by the random map selection feature. In other words, this is usually
	false.

=item * B<kind>: Returns the kind of the resource from the compiled nav map.	=item * B<randompick>:

=item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false.	Returns true for a map if the randompick feature is being used on the
	map. (?)

=item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)	=item * B<src>:

=item * B<src>: Returns the source for the resource.	Returns the source for the resource.

=item * B<symb>: Returns the symb for the resource.	=item * B<symb>:

=item * B<title>: Returns the title of the resource.	Returns the symb for the resource.

=item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)	=item * B<title>:

	Returns the title of the resource.

	=item * B<to>:

	Returns the "to" value from the compiled nav map. (It is likely you
	want to use B<getNext> instead.)

=back	=back

Line 2386 sub to { my $self=shift; return $self->n	Line 2685 sub to { my $self=shift; return $self->n
sub compTitle {	sub compTitle {
my $self = shift;	my $self = shift;
my $title = $self->title();	my $title = $self->title();
	$title=~s/\&colon\;/\:/gs;
if (!$title) {	if (!$title) {
$title = $self->src();	$title = $self->src();
$title = substr($title, rindex($title, '/') + 1);	$title = substr($title, rindex($title, '/') + 1);
Line 2400 These methods are shortcuts to deciding	Line 2700 These methods are shortcuts to deciding

=over 4	=over 4

=item * B<is_map>: Returns true if the resource is a map type.	=item * B<is_map>:

	Returns true if the resource is a map type.

	=item * B<is_problem>:

	Returns true if the resource is a problem type, false
	otherwise. (Looks at the extension on the src field; might need more
	to work correctly.)

=item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)	=item * B<is_page>:

=item * B<is_page>: Returns true if the resource is a page.	Returns true if the resource is a page.

=item * B<is_sequence>: Returns true if the resource is a sequence.	=item * B<is_sequence>:

	Returns true if the resource is a sequence.

=back	=back

Line 2447 sub parmval {	Line 2757 sub parmval {

B<Map Methods>	B<Map Methods>

These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).	These methods are useful for getting information about the map
	properties of the resource, if the resource is a map (B<is_map>).

=over 4	=over 4

=item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.	=item * B<map_finish>:

	Returns a reference to a resource object corresponding to the finish
	resource of the map.

	=item * B<map_pc>:

	Returns the pc value of the map, which is the first number that
	appears in the resource ID of the resources in the map, and is the
	number that appears around the middle of the symbs of the resources in
	that map.

	=item * B<map_start>:

=item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.	Returns a reference to a resource object corresponding to the start
	resource of the map.

=item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.	=item * B<map_type>:

=item * B<map_type>: Returns a string with the type of the map in it.	Returns a string with the type of the map in it.

=back	=back

Line 2506 sub map_type {	Line 2830 sub map_type {

=head2 Resource Parameters	=head2 Resource Parameters

In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.	In order to use the resource parameters correctly, the nav map must
	have been instantiated with genCourseAndUserOptions set to true, so
These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)	the courseopt and useropt is read correctly. Then, you can call these
	functions to get the relevant parameters for the resource. Each
	function defaults to part "0", but can be directed to another part by
	passing the part as the parameter.

	These methods are responsible for getting the parameter correct, not
	merely reflecting the contents of the GDBM hashes. As we move towards
	dates relative to other dates, these methods should be updated to
	reflect that. (Then, anybody using these methods will not have to update
	their code.)

=over 4	=over 4

=item * B<acc>: Get the Client IP/Name Access Control information.	=item * B<acc>:

	Get the Client IP/Name Access Control information.

	=item * B<answerdate>:

	Get the answer-reveal date for the problem.

	=item * B<duedate>:

	Get the due date for the problem.

	=item * B<tries>:

	Get the number of tries the student has used on the problem.

	=item * B<maxtries>:

	Get the number of max tries allowed.

	=item * B<opendate>:

	Get the open date for the problem.

=item * B<answerdate>: Get the answer-reveal date for the problem.	=item * B<sig>:

=item * B<duedate>: Get the due date for the problem.	Get the significant figures setting.

=item * B<tries>: Get the number of tries the student has used on the problem.	=item * B<tol>:

=item * B<maxtries>: Get the number of max tries allowed.	Get the tolerance for the problem.

=item * B<opendate>: Get the open date for the problem.	=item * B<tries>:

=item * B<sig>: Get the significant figures setting.	Get the number of tries the user has already used on the problem.

=item * B<tol>: Get the tolerance for the problem.	=item * B<type>:

=item * B<tries>: Get the number of tries the user has already used on the problem.	Get the question type for the problem.

=item * B<type>: Get the question type for the problem.	=item * B<weight>:

=item * B<weight>: Get the weight for the problem.	Get the weight for the problem.

=back	=back

Line 2623 Misc. functions for the resource.	Line 2978 Misc. functions for the resource.

=over 4	=over 4

=item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.	=item * B<hasDiscussion>:

=item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:	Returns a false value if there has been discussion since the user last
	logged in, true if there has. Always returns false if the discussion
	data was not extracted when the nav map was constructed.

	=item * B<getFeedback>:

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

for (split(/\,/, $res->getFeedback())) {	for (split(/\,/, $res->getFeedback())) {
my $link = &Apache::lonnet::escape($_);	my $link = &Apache::lonnet::escape($_);
Line 2656 sub getErrors {	Line 3020 sub getErrors {

=pod	=pod

=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater than two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)	=item * B<parts>():

=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.	Returns a list reference containing sorted strings corresponding to
	each part of the problem. To count the number of parts, use the list
	in a scalar context, and subtract one if greater than two. (One part
	problems have a part 0. Multi-parts have a part 0, plus a part for
	each part. Filtering part 0 if you want it is up to you.)

	=item * B<countParts>():

	Returns the number of parts of the problem a student can answer. Thus,
	for single part problems, returns 1. For multipart, it returns the
	number of parts in the problem, not including psuedo-part 0. Thus,
	B<parts> may return an array with fewer parts in it then countParts
	might lead you to believe.

=back	=back

Line 2677 sub countParts {	Line 3053 sub countParts {
my $self = shift;	my $self = shift;

my $parts = $self->parts();	my $parts = $self->parts();
	my $delta = 0;
	for my $part (@$parts) {
	if ($part eq '0') { $delta--; }
	}

if ($self->{RESOURCE_ERROR}) {	if ($self->{RESOURCE_ERROR}) {
return 0;	return 0;
}	}

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

return scalar(@{$parts}) - 1;
}	}

# Private function: Extracts the parts information and saves it	# Private function: Extracts the parts information and saves it
sub extractParts {	sub extractParts {
my $self = shift;	my $self = shift;

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

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

# Retrieve part count, if this is a problem	# Retrieve part count, if this is a problem
if ($self->is_problem()) {	if ($self->is_problem()) {
my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');	my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
if (!$metadata) {	if (!$metadata) {
$self->{RESOURCE_ERROR} = 1;	$self->{RESOURCE_ERROR} = 1;
$self->{PARTS} = [];	$self->{PARTS} = [];
return;	return;
}	}

foreach (split(/\,/,$metadata)) {	foreach (split(/\,/,$metadata)) {
if ($_ =~ /^parameter\_(.*)\_opendate$/) {	if ($_ =~ /^part_(.*)$/) {
my $part = $1;	my $part = $1;
# check to see if part is turned off.	# check to see if part is turned off.
if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {	if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
Line 2727 sub extractParts {	Line 3104 sub extractParts {

=head2 Resource Status	=head2 Resource Status

Problem resources have status information, reflecting their various dates and completion statuses.	Problem resources have status information, reflecting their various
	dates and completion statuses.

There are two aspects to the status: the date-related information and the completion information.	There are two aspects to the status: the date-related information and
	the completion information.

Idiomatic usage of these two methods would probably look something like	Idiomatic usage of these two methods would probably look something
	like

foreach ($resource->parts()) {	foreach ($resource->parts()) {
my $dateStatus = $resource->getDateStatus($_);	my $dateStatus = $resource->getDateStatus($_);
Line 2744 Idiomatic usage of these two methods wou	Line 3124 Idiomatic usage of these two methods wou
... use it here ...	... use it here ...
}	}

Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere.	Which you use depends on exactly what you are looking for. The
	status() function has been optimized for the nav maps display and may
	not precisely match what you need elsewhere.

The symbolic constants shown below can be accessed through the resource object: $res->OPEN.	The symbolic constants shown below can be accessed through the
	resource object: C<$res->OPEN>.

=over 4	=over 4

=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:	=item * B<getDateStatus>($part):

	($part defaults to 0). A convenience function that returns a symbolic
	constant telling you about the date status of the part. The possible
	return values are:

=back	=back

Line 2758 B<Date Codes>	Line 3145 B<Date Codes>

=over 4	=over 4

=item * B<OPEN_LATER>: The problem will be opened later.	=item * B<OPEN_LATER>:

	The problem will be opened later.

	=item * B<OPEN>:

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


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

=item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.	The due date has passed, but the answer date has not yet arrived.

=item * B<ANSWER_OPEN>: The answer date is here.	=item * B<PAST_DUE_NO_ANSWER>:

=item * B<NETWORK_FAILURE>: The information is unknown due to network failure.	The due date has passed and there is no answer opening date set.

	=item * B<ANSWER_OPEN>:

	The answer date is here.

	=item * B<NETWORK_FAILURE>:

	The information is unknown due to network failure.

=back	=back

Line 2823 B<>	Line 3222 B<>

=over 4	=over 4

=item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:	=item * B<getCompletionStatus>($part):

	($part defaults to 0.) A convenience function that returns a symbolic
	constant telling you about the completion status of the part, with the
	following possible results:

=back	=back

B<Completion Codes>	B<Completion Codes>

=over 4	=over 4

=item * B<NOT_ATTEMPTED>: Has not been attempted at all.	=item * B<NOT_ATTEMPTED>:

	Has not been attempted at all.

	=item * B<INCORRECT>:

	Attempted, but wrong by student.

	=item * B<INCORRECT_BY_OVERRIDE>:

	Attempted, but wrong by instructor override.

=item * B<INCORRECT>: Attempted, but wrong by student.	=item * B<CORRECT>:

=item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.	Correct or correct by instructor.

=item * B<CORRECT>: Correct or correct by instructor.	=item * B<CORRECT_BY_OVERRIDE>:

=item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.	Correct by instructor override.

=item * B<EXCUSED>: Excused. Not yet implemented.	=item * B<EXCUSED>:

=item * B<NETWORK_FAILURE>: Information not available due to network failure.	Excused. Not yet implemented.

=item * B<ATTEMPTED>: Attempted, and not yet graded.	=item * B<NETWORK_FAILURE>:

	Information not available due to network failure.

	=item * B<ATTEMPTED>:

	Attempted, and not yet graded.

=back	=back

Line 2891 sub queryRestoreHash {	Line 3310 sub queryRestoreHash {

B<Composite Status>	B<Composite Status>

Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE):	Along with directly returning the date or completion status, the
	resource object includes a convenience function B<status>() that will
	combine the two status tidbits into one composite status that can
	represent the status of the resource as a whole. The precise logic is
	documented in the comments of the status method. The following results
	may be returned, all available as methods on the resource object
	($res->NETWORK_FAILURE):

=over 4	=over 4

=item * B<NETWORK_FAILURE>: The network has failed and the information is not available.	=item * B<NETWORK_FAILURE>:

	The network has failed and the information is not available.

	=item * B<NOTHING_SET>:

	No dates have been set for this problem (part) at all. (Because only
	certain parts of a multi-part problem may be assigned, this can not be
	collapsed into "open later", as we do not know a given part will EVER
	be opened. For single part, this is the same as "OPEN_LATER".)

=item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)	=item * B<CORRECT>:

=item * B<CORRECT>: For any reason at all, the part is considered correct.	For any reason at all, the part is considered correct.

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

=item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.	For any reason at all, the problem is excused.

=item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.	=item * B<PAST_DUE_NO_ANSWER>:

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

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

=item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.	The problem is past due, not considered correct, and an answer date in
	the future is set.

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

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

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

	The problem is not yet open.

	=item * B<TRIES_LEFT>:

	The problem is open, has been tried, is not correct, but there are
	tries left.

	=item * B<INCORRECT>:

	The problem is open, and all tries have been used without getting the
	correct answer.

	=item * B<OPEN>:

	The item is open and not yet tried.

	=item * B<ATTEMPTED>:

	The problem has been attempted.

=back	=back

Line 2995 sub status {	Line 3451 sub status {

=over 4	=over 4

=item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case.	=item * B<getNext>():

	Retreive an array of the possible next resources after this
	one. Always returns an array, even in the one- or zero-element case.

	=item * B<getPrevious>():

=item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case.	Retreive an array of the possible previous resources from this
	one. Always returns an array, even in the one- or zero-element case.

=cut	=cut

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

Removed from v.1.151
changed lines
	Added in v.1.177