|
version 1.141, 2003/02/07 22:16:53
|
version 1.164, 2003/03/20 20:40:18
|
|
Line 38
|
Line 38
|
| # 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; |
| |
|
| use strict; |
use strict; |
| use Apache::Constants qw(:common :http); |
use Apache::Constants qw(:common :http); |
| use Apache::loncommon(); |
use Apache::loncommon(); |
| |
use Apache::lonmenu(); |
| use POSIX qw (floor strftime); |
use POSIX qw (floor strftime); |
| |
|
| my %navmaphash; |
my %navmaphash; |
| my %parmhash; |
my %parmhash; |
| |
my @refsToUntie; |
| |
|
| # symbolic constants |
# symbolic constants |
| sub SYMB { return 1; } |
sub SYMB { return 1; } |
|
Line 95 my %colormap =
|
Line 99 my %colormap =
|
| # And a special case in the nav map; what to do when the assignment |
# And a special case in the nav map; what to do when the assignment |
| # is not yet done and due in less then 24 hours |
# is not yet done and due in less then 24 hours |
| my $hurryUpColor = "#FF0000"; |
my $hurryUpColor = "#FF0000"; |
| |
my $test = 'abc'; |
| sub cleanup { |
sub cleanup { |
| |
&Apache::lonnet::logthis("Cleanup called."); |
| |
&Apache::lonnet::logthis(scalar(@refsToUntie)); |
| |
&Apache::lonnet::logthis($test); |
| |
$test = '467'; |
| if (tied(%navmaphash)){ |
if (tied(%navmaphash)){ |
| &Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); |
&Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); |
| unless (untie(%navmaphash)) { |
unless (untie(%navmaphash)) { |
|
Line 109 sub cleanup {
|
Line 117 sub cleanup {
|
| &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); |
&Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); |
| } |
} |
| } |
} |
| |
# Apparently, if you take a reference to a tied hash, both the |
| |
# original hash and the tied hash must be untied. Bleh. |
| |
for my $ref (@refsToUntie) { |
| |
&Apache::lonnet::logthis('Cleanup navmaps: reference'); |
| |
unless (untie($ref)) { |
| |
&Apache::lonnet::logthis('Failed cleanup navmaps: reference'); |
| |
} |
| |
} |
| } |
} |
| |
|
| sub handler { |
sub handler { |
|
Line 140 sub real_handler {
|
Line 156 sub real_handler {
|
| $r->send_http_header; |
$r->send_http_header; |
| |
|
| # Create the nav map |
# Create the nav map |
| my $navmap = Apache::lonnavmaps::navmap->new( |
my $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); |
| |
|
|
Line 152 sub real_handler {
|
Line 168 sub real_handler {
|
| } |
} |
| |
|
| $r->print("<html><head>\n"); |
$r->print("<html><head>\n"); |
| $r->print("<title>Navigate Course Contents</title></head>"); |
$r->print("<title>Navigate Course Contents</title>"); |
| |
# ------------------------------------------------------------ Get query string |
| |
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); |
| |
|
| |
# ----------------------------------------------------- Force menu registration |
| |
my $addentries=''; |
| |
if ($ENV{'form.register'}) { |
| |
$addentries=' onLoad="'.&Apache::lonmenu::loadevents(). |
| |
'" onUnload="'.&Apache::lonmenu::unloadevents().'"'; |
| |
$r->print(&Apache::lonmenu::registerurl(1)); |
| |
} |
| |
|
| # Header |
# Header |
| $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','', |
$r->print('</head>'. |
| '')); |
&Apache::loncommon::bodytag('Navigate Course Contents','', |
| |
$addentries,'','',$ENV{'form.register'})); |
| $r->print('<script>window.focus();</script>'); |
$r->print('<script>window.focus();</script>'); |
| |
|
| $r->rflush(); |
$r->rflush(); |
|
Line 164 sub real_handler {
|
Line 191 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 175 sub real_handler {
|
Line 201 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, |
'suppressNavmap' => 1, |
| 'r' => $r}); |
'r' => $r}); |
| |
|
| $navmap->untieHashes(); |
#$navmap->untieHashes(); |
| |
|
| |
if (tied(%navmaphash)) { |
| |
$r->print("Dang it."); |
| |
} else { |
| |
$r->print("It's out."); |
| |
} |
| |
|
| |
if (tied(%parmhash)) { |
| |
$r->print("Dang it."); |
| |
} else { |
| |
$r->print("It's out."); |
| |
} |
| |
|
| $r->print("</body></html>"); |
$r->print("</body></html>"); |
| $r->rflush(); |
$r->rflush(); |
|
Line 322 sub lastTry {
|
Line 386 sub lastTry {
|
| } |
} |
| |
|
| # This puts a human-readable name on the ENV variable. |
# This puts a human-readable name on the ENV variable. |
| |
# FIXME: This needs better logic: Who gets the advanced view of navmaps? |
| |
# As of 3-13-03, it's an open question. Guy doesn't want to check |
| |
# roles directly because it should be a check of capabilities for future |
| |
# role compatibity. There is no capability that matches this one for |
| |
# now, so this is done. (A hack for 1.0 might be to simply check roles |
| |
# anyhow.) |
| sub advancedUser { |
sub advancedUser { |
| return $ENV{'user.adv'}; |
return $ENV{'user.adv'}; |
| } |
} |
|
Line 463 The pre-packaged column names are refere
|
Line 533 The pre-packaged column names are refere
|
| |
|
| =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>: 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. |
| |
|
| =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. |
|
Line 491 Most of these parameters are only useful
|
Line 563 Most of these parameters are only useful
|
| |
|
| =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. |
=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<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<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<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<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' and 'jumpType' information. |
=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<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info. |
=item * B<here>: A Symb identifying where to place the 'here' marker. Default empty, which means no marker. |
| |
|
| =item * B<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL. |
|
| |
|
| =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<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. |
| |
|
|
Line 515 Most of these parameters are only useful
|
Line 589 Most of these parameters are only useful
|
| |
|
| =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.*'}. |
=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.*'}. |
| |
|
| =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<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false. |
=item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false. |
| |
|
| =item * B<printCloseAll>: 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>: 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 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 |
| |
|
| =back |
=back |
|
Line 571 sub render_resource {
|
Line 649 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 585 sub render_resource {
|
Line 663 sub render_resource {
|
| if ($it->{CONDITION}) { |
if ($it->{CONDITION}) { |
| $nowOpen = !$nowOpen; |
$nowOpen = !$nowOpen; |
| } |
} |
| $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; |
|
| $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
if (!$params->{'resource_no_folder_link'}) { |
| |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; |
| $linkopen = "<a href='" . $params->{'url'} . '?' . |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
| $params->{'queryString'} . '&filter='; |
|
| $linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
$linkopen = "<a href='" . $params->{'url'} . '?' . |
| addToFilter($filter, $mapId) : |
$params->{'queryString'} . '&filter='; |
| removeFromFilter($filter, $mapId); |
$linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
| $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
addToFilter($filter, $mapId) : |
| . $params->{'hereType'} . '&here=' . |
removeFromFilter($filter, $mapId); |
| &Apache::lonnet::escape($params->{'here'}) . |
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
| '&jumpType=' . SYMB() . '&jump=' . |
. $params->{'hereType'} . '&here=' . |
| &Apache::lonnet::escape($resource->symb()) . |
&Apache::lonnet::escape($params->{'here'}) . |
| "&folderManip=1'>"; |
'&jump=' . |
| |
&Apache::lonnet::escape($resource->symb()) . |
| |
"&folderManip=1'>"; |
| |
} else { |
| |
# Don't allow users to manipulate folder |
| |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . |
| |
'.nomanip.gif'; |
| |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
| |
|
| |
$linkopen = ""; |
| |
$linkclose = ""; |
| |
} |
| } |
} |
| |
|
| if ($resource->randomout()) { |
if ($resource->randomout()) { |
|
Line 623 sub render_resource {
|
Line 712 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)'; |
| } |
} |
| |
|
| $result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>"; |
if (!$params->{'resource_nolink'}) { |
| |
$result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>"; |
| |
} else { |
| |
$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>"; |
| |
} |
| |
|
| return $result; |
return $result; |
| } |
} |
|
Line 771 sub render {
|
Line 862 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 804 sub render {
|
Line 890 sub render {
|
| 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($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 814 sub render {
|
Line 900 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, |
|
| # and we need to figure out what. |
|
| # Preference: Symb |
|
| |
|
| if ($ENV{'form.symb'}) { |
if ($ENV{'form.symb'}) { |
| $hereType = $jumpType = SYMB(); |
|
| $here = $jump = $ENV{'form.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 848 sub render {
|
Line 925 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 866 sub render {
|
Line 941 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 909 sub render {
|
Line 956 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 917 sub render {
|
Line 964 sub render {
|
| # Paranoia: Make sure it's ready |
# Paranoia: Make sure it's ready |
| $navmap->init(); |
$navmap->init(); |
| |
|
| $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition); |
# See if we're being passed a specific map |
| |
if ($args->{'iterator_map'}) { |
| |
my $map = $args->{'iterator_map'}; |
| |
$map = $navmap->getResourceByUrl($map); |
| |
my $firstResource = $map->map_start(); |
| |
my $finishResource = $map->map_finish(); |
| |
|
| |
$args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition); |
| |
} else { |
| |
$args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition); |
| |
} |
| } |
} |
| |
|
| |
# (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; } |
| |
my $filterFunc = setDefault($args->{'filterFunc'}, |
| |
sub {return 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">'; |
|
Line 955 sub render {
|
Line 1038 sub render {
|
| if ($printCloseAll) { |
if ($printCloseAll) { |
| 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"; |
| } |
} |
| |
|
| if ($r) { |
if ($r) { |
|
Line 990 sub render {
|
Line 1074 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 1021 sub render {
|
Line 1104 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; |
| } |
} |
| |
|
| $args->{'counter'}++; |
$args->{'counter'}++; |
| |
|
| |
# If this has been filtered out, continue on |
| |
if (!(&$filterFunc($curRes))) { |
| |
$args->{'isNewBranch'} = 0; # Don't falsely remember this |
| |
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 1039 sub render {
|
Line 1132 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 1071 sub render {
|
Line 1164 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 1138 sub render {
|
Line 1222 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 1161 sub render {
|
Line 1251 sub render {
|
| $r->rflush(); |
$r->rflush(); |
| } |
} |
| |
|
| if ($mustCloseNavMap) { $navmap->untieHashes(); } |
#if ($mustCloseNavMap) { $navmap->untieHashes(); } |
| |
|
| return $result; |
return $result; |
| } |
} |
|
Line 1186 You must obtain resource objects through
|
Line 1276 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>(responseObject, navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. responseObject is the Apache response object (typically $r). 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): See iterator documentation below. |
=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below. |
| |
|
|
Line 1201 sub new {
|
Line 1291 sub new {
|
| my $class = ref($proto) || $proto; |
my $class = ref($proto) || $proto; |
| my $self = {}; |
my $self = {}; |
| |
|
| |
$self->{RESPONSE} = shift; |
| $self->{NAV_HASH_FILE} = shift; |
$self->{NAV_HASH_FILE} = shift; |
| $self->{PARM_HASH_FILE} = shift; |
$self->{PARM_HASH_FILE} = shift; |
| $self->{GENERATE_COURSE_USER_OPT} = shift; |
$self->{GENERATE_COURSE_USER_OPT} = shift; |
|
Line 1216 sub new {
|
Line 1307 sub new {
|
| |
|
| # tie the nav hash |
# tie the nav hash |
| |
|
| if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
if (!(tie(%Apache::lonnavmaps::navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
| &GDBM_READER(), 0640))) { |
&GDBM_READER(), 0640))) { |
| return undef; |
return undef; |
| } |
} |
| |
|
| if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
if (!(tie(%Apache::lonnavmaps::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} = \%Apache::lonnavmaps::navmaphash; |
| $self->{NAV_HASH} = \%navmaphash; |
$self->{PARM_HASH} = \%Apache::lonnavmaps::parmhash; |
| $self->{PARM_HASH} = \%parmhash; |
push @Apache::lonnavmaps::refsToCleanup, $self->{NAV_HASH}; |
| |
push @Apache::lonnavmaps::refsToCleanup, $self->{PARM_HASH}; |
| |
Apache::lonnet::logthis(scalar(@Apache::lonnavmaps::refsToCleanup)); |
| |
$Apache::lonnavmaps::test = '123'; |
| |
Apache::lonnet::logthis($Apache::lonnavmaps::test); |
| $self->{INITED} = 0; |
$self->{INITED} = 0; |
| |
|
| |
$self->{RESPONSE}->register_cleanup(\&Apache::lonnavmaps::cleanup); |
| |
Apache::lonnet::logthis("Pushed cleanup."); |
| |
|
| bless($self); |
bless($self); |
| |
|
| return $self; |
return $self; |
|
Line 1375 sub getIterator {
|
Line 1473 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; |
# &Apache::lonnavmaps::cleanup(); |
| } |
} |
| |
|
| # when the object is destroyed, be sure to untie all the hashes we tied. |
# when the object is destroyed, be sure to untie all the hashes we tied. |
| sub DESTROY { |
#sub DESTROY { |
| my $self = shift; |
# my $self = shift; |
| $self->untieHashes(); |
# $self->untieHashes(); |
| } |
#} |
| |
|
| # 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. |
|
Line 1558 sub parmval_real {
|
Line 1656 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 |
| |
|
| |
=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<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. |
| |
|
| |
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): Convience method for |
| |
|
| |
scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0 |
| |
|
| |
which will tell whether the map has resources matching the description in the filter function. |
| |
|
| |
=cut |
| |
|
| |
sub getResourceByUrl { |
| |
my $self = shift; |
| |
my $resUrl = shift; |
| |
|
| |
if (ref($resUrl)) { return $resUrl; } |
| |
|
| |
$resUrl = &Apache::lonnet::clutter($resUrl); |
| |
my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl}; |
| |
if ($resId =~ /,/) { |
| |
$resId = (split (/,/, $resId))[0]; |
| |
} |
| |
if (!$resId) { return ''; } |
| |
return $self->getById($resId); |
| |
} |
| |
|
| |
sub retrieveResources { |
| |
my $self = shift; |
| |
my $map = shift; |
| |
my $filterFunc = shift; |
| |
if (!defined ($filterFunc)) { |
| |
$filterFunc = sub {return 1;}; |
| |
} |
| |
my $recursive = shift; |
| |
if (!defined($recursive)) { $recursive = 1; } |
| |
my $bailout = shift; |
| |
if (!defined($bailout)) { $bailout = 0; } |
| |
|
| |
# Create the necessary iterator. |
| |
if (!ref($map)) { # assume it's a url of a map. |
| |
$map = $self->getMapByUrl($map); |
| |
} |
| |
|
| |
# Check the map's validity. |
| |
if (!$map || !$map->is_map()) { |
| |
# Oh, to throw an exception.... how I'd love that! |
| |
return (); |
| |
} |
| |
|
| |
# Get an iterator. |
| |
my $it = $self->getIterator($map->map_start(), $map->map_finish(), |
| |
!$recursive); |
| |
|
| |
my @resources = (); |
| |
|
| |
# Run down the iterator and collect the resources. |
| |
my $depth = 1; |
| |
$it->next(); |
| |
my $curRes = $it->next(); |
| |
|
| |
while ($depth > 0) { |
| |
if ($curRes == $it->BEGIN_MAP()) { |
| |
$depth++; |
| |
} |
| |
if ($curRes == $it->END_MAP()) { |
| |
$depth--; |
| |
} |
| |
|
| |
if (ref($curRes)) { |
| |
if (!&$filterFunc($curRes)) { |
| |
next; |
| |
} |
| |
|
| |
push @resources, $curRes; |
| |
|
| |
if ($bailout) { |
| |
return @resources; |
| |
} |
| |
} |
| |
|
| |
$curRes = $it->next(); |
| |
} |
| |
|
| |
return @resources; |
| |
} |
| |
|
| |
sub hasResource { |
| |
my $self = shift; |
| |
my $map = shift; |
| |
my $filterFunc = shift; |
| |
my $recursive = shift; |
| |
|
| |
return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0; |
| |
} |
| |
|
| 1; |
1; |
| |
|
| package Apache::lonnavmaps::iterator; |
package Apache::lonnavmaps::iterator; |
|
Line 1594 getIterator behaves as follows:
|
Line 1790 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): 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. |
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. |
| |
|
|
Line 1669 sub new {
|
Line 1865 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 1782 sub new {
|
Line 1983 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 2312 These methods are useful for getting inf
|
Line 2520 These methods are useful for getting inf
|
| sub map_finish { |
sub map_finish { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| |
$src = Apache::lonnet::clutter($src); |
| my $res = $self->navHash("map_finish_$src", 0); |
my $res = $self->navHash("map_finish_$src", 0); |
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
|
Line 2324 sub map_pc {
|
Line 2533 sub map_pc {
|
| sub map_start { |
sub map_start { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| |
$src = Apache::lonnet::clutter($src); |
| my $res = $self->navHash("map_start_$src", 0); |
my $res = $self->navHash("map_start_$src", 0); |
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
|
Line 2500 sub getErrors {
|
Line 2710 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 then 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>(): 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. |
=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. |
| |
|
|
Line 2521 sub countParts {
|
Line 2731 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_(.*)$/) { |
| push @{$self->{PARTS}}, $1; |
my $part = $1; |
| |
# check to see if part is turned off. |
| |
if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { |
| |
push @{$self->{PARTS}}, $1; |
| |
} |
| } |
} |
| } |
} |
| |
|
| |
|
| # Is this possible to do in one line? - Jeremy |
|
| my @sortedParts = sort @{$self->{PARTS}}; |
my @sortedParts = sort @{$self->{PARTS}}; |
| $self->{PARTS} = \@sortedParts; |
$self->{PARTS} = \@sortedParts; |
| } |
} |
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavmaps.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface