--- loncom/interface/lonnavmaps.pm 2002/11/14 21:36:23 1.106 +++ loncom/interface/lonnavmaps.pm 2003/02/04 16:28:50 1.135 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.106 2002/11/14 21:36:23 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.135 2003/02/04 16:28:50 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -46,8 +46,59 @@ use Apache::Constants qw(:common :http); use Apache::loncommon(); use POSIX qw (floor strftime); +my %navmaphash; +my %parmhash; + +# symbolic constants +sub SYMB { return 1; } +sub URL { return 2; } +sub NOTHING { return 3; } + +# Some data + +# Keep these mappings in sync with lonquickgrades, which uses the colors +# instead of the icons. +my %statusIconMap = + ( Apache::lonnavmaps::resource->NETWORK_FAILURE => '', + Apache::lonnavmaps::resource->NOTHING_SET => '', + Apache::lonnavmaps::resource->CORRECT => 'navmap.correct.gif', + Apache::lonnavmaps::resource->EXCUSED => 'navmap.correct.gif', + Apache::lonnavmaps::resource->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', + Apache::lonnavmaps::resource->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', + Apache::lonnavmaps::resource->ANSWER_OPEN => 'navmap.wrong.gif', + Apache::lonnavmaps::resource->OPEN_LATER => '', + Apache::lonnavmaps::resource->TRIES_LEFT => 'navmap.open.gif', + Apache::lonnavmaps::resource->INCORRECT => 'navmap.wrong.gif', + Apache::lonnavmaps::resource->OPEN => 'navmap.open.gif', + Apache::lonnavmaps::resource->ATTEMPTED => 'navmap.open.gif' ); + +my %iconAltTags = + ( 'navmap.correct.gif' => 'Correct', + 'navmap.wrong.gif' => 'Incorrect', + 'navmap.open.gif' => 'Open' ); + +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 { my $r = shift; + real_handler($r); +} + +sub real_handler { + my $r = shift; &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); @@ -83,11 +134,19 @@ sub handler { return HTTP_NOT_ACCEPTABLE; } + $r->print("\n"); + $r->print("Navigate Course Contents"); + # Header - $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', + $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','', '')); $r->print(''); + $r->rflush(); + + # Now that we've displayed some stuff to the user, init the navmap + $navmap->init(); + $r->print(''); my $date=localtime; $r->print(''); @@ -113,18 +172,62 @@ sub handler { $condition = 1; } + # Determine where the "here" marker is and where the screen jumps to. + my $hereType; # the type of marker, SYMB, URL, or NOTHING + my $here; # the actual URL or SYMB for the here marker + my $jumpType; # The type of the thing we have a jump for, SYMB or URL + my $jump; # the SYMB/URL of the resource we need to jump to + + if ( $ENV{'form.alreadyHere'} ) { # 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" + # from the querystring, and get the new "jump" marker + $hereType = $ENV{'form.hereType'}; + $here = $ENV{'form.here'}; + $jumpType = $ENV{'form.jumpType'} || NOTHING(); + $jump = $ENV{'form.jump'}; + } else { # the user is visiting the nav map from the remote + # 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'}) { + $hereType = $jumpType = SYMB(); + $here = $jump = $ENV{'form.symb'}; + } elsif ($ENV{'form.postdata'}) { + # couldn't find a symb, is there a URL? + my $currenturl = $ENV{'form.postdata'}; + $currenturl=~s/^http\:\/\///; + $currenturl=~s/^[^\/]+//; + + $hereType = $jumpType = URL; + $here = $jump = $currenturl; + } else { + # Nothing + $hereType = $jumpType = NOTHING(); + } + } + + + # alreadyHere allows us to only open the maps necessary to view + # the current location once, while at the same time remembering + # the current location. Without that check, the user would never + # be able to close those maps; the user would close it, and the + # currenturl scan would re-open it. + my $queryAdd = "&alreadyHere=1"; + if ($condition) { - $r->print('Close All Folders'); + $r->print("Close All Folders"); } else { - $r->print('Open All Folders'); + $r->print("Open All Folders"); } $r->print('
 '); $r->rflush(); - # Now that we've displayed some stuff to the user, init the navmap - $navmap->init(); - # Check that it's defined if (!($navmap->courseMapDefined())) { $r->print('Coursemap undefined.' . @@ -143,10 +246,10 @@ sub handler { my %colormap = ( $res->NETWORK_FAILURE => '', $res->CORRECT => '', - $res->EXCUSED => '#BBBBFF', + $res->EXCUSED => '#3333FF', $res->PAST_DUE_ANSWER_LATER => '', $res->PAST_DUE_NO_ANSWER => '', - $res->ANSWER_OPEN => '#CCFFCC', + $res->ANSWER_OPEN => '#006600', $res->OPEN_LATER => '', $res->TRIES_LEFT => '', $res->INCORRECT => '', @@ -156,25 +259,6 @@ sub handler { # is not yet done and due in less then 24 hours my $hurryUpColor = "#FF0000"; - my %statusIconMap = - ( $res->NETWORK_FAILURE => '', - $res->NOTHING_SET => '', - $res->CORRECT => 'navmap.correct.gif', - $res->EXCUSED => 'navmap.correct.gif', - $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', - $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', - $res->ANSWER_OPEN => 'navmap.wrong.gif', - $res->OPEN_LATER => '', - $res->TRIES_LEFT => 'navmap.open.gif', - $res->INCORRECT => 'navmap.wrong.gif', - $res->OPEN => 'navmap.open.gif', - $res->ATTEMPTED => 'navmap.open.gif' ); - - my %iconAltTags = - ( 'navmap.correct.gif' => 'Correct', - 'navmap.wrong.gif' => 'Incorrect', - 'navmap.open.gif' => 'Open' ); - my %condenseStatuses = ( $res->NETWORK_FAILURE => 1, $res->NOTHING_SET => 1, @@ -191,19 +275,6 @@ sub handler { # Is this a new-style course? If so, we want to suppress showing the top-level # maps in their own folders, in favor of "inlining" them. my $topResource = $navmap->getById("0.0"); - my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|; - - my $currenturl = $ENV{'form.postdata'}; - $currenturl=~s/^http\:\/\///; - $currenturl=~s/^[^\/]+//; - - # alreadyHere allows us to only open the maps necessary to view - # the current location once, while at the same time remembering - # the current location. Without that check, the user would never - # be able to close those maps; the user would close it, and the - # currenturl scan would re-open it. - my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) . - "&alreadyHere=1"; # Begin the HTML table # four cols: resource + indent, chat+feedback, icon, text string @@ -215,35 +286,31 @@ sub handler { # Here's a simple example of the iterator. # Preprocess the map: Look for current URL, force inlined maps to display - my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 1); + my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); my $found = 0; my $depth = 1; - my $currentUrlIndex = 0; # keeps track of when the current resource is found, + my $currentJumpIndex = 0; # keeps track of when the current resource is found, # so we can back up a few and put the anchor above the # current resource - my $currentUrlDelta = 5; # 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 $mapIterator->next(); # discard the first BEGIN_MAP my $curRes = $mapIterator->next(); my $counter = 0; - - while ($depth > 0) { + my $foundJump = ($jumpType == NOTHING()); # look for jump point if we have one + my $looped = 0; + + # We only need to do this if we need to open the maps to show the + # current position. This will change the counter so we can't count + # for the jump marker with this loop. + while ($depth > 0 && !$ENV{'form.alreadyHere'}) { if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } if ($curRes == $mapIterator->END_MAP()) { $depth--; } - if (ref($curRes)) { $counter++; } - - my $mapStack = $mapIterator->getStack(); - if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) && - $curRes->src() eq $currenturl) { - # If this is the correct resource, be sure to - # show it by making sure the containing maps - # are open. - - # 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. - $currentUrlIndex = $counter; + if (ref($curRes) && !$ENV{'form.alreadyHere'} && + ($hereType == SYMB() && $curRes->symb() eq $here) || + (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) { + my $mapStack = $mapIterator->getStack(); # Ensure the parent maps are open for my $map (@{$mapStack}) { @@ -255,16 +322,33 @@ sub handler { } $ENV{'form.alreadyHere'} = 1; } - - # Preprocessing: If we're inlining nav maps into the top-level display, - # make sure we show this map! - if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map && - scalar(@{$mapStack}) == 1) { - if ($condition) { - undef $filterHash{$curRes->map_pc()}; - } else { - $filterHash{$curRes->map_pc()} = 1; - } + $looped = 1; + + $curRes = $mapIterator->next(); + } + + $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0); + $depth = 1; + $mapIterator->next(); + $curRes = $mapIterator->next(); + + 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))) { + # If this is the correct resource, be sure to + # show it by making sure the containing maps + # are open. + + # 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(); @@ -272,12 +356,13 @@ sub handler { undef $res; # so we don't accidentally use it later my $indentLevel = 0; - my $indentString = "\"\""; + my $indentString = ""; my $isNewBranch = 0; my $now = time(); my $in24Hours = $now + 24 * 60 * 60; my $displayedHereMarker = 0; + my $displayedJumpMarker = 0; # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" # code in iterator->next), so ignore the first one @@ -285,7 +370,6 @@ sub handler { $condition); $mapIterator->next(); $curRes = $mapIterator->next(); - my $deltadepth = 0; $depth = 1; my @backgroundColors = ("#FFFFFF", "#F6F6F6"); @@ -293,21 +377,7 @@ sub handler { $counter = 0; - # Print the 'current' anchor here if it would fall off the top - if ($currentUrlIndex - $currentUrlDelta < 0) { - $r->print(''); - } - while ($depth > 0) { - # If this is an inlined map, cancel the shift to the right, - # which has the effect of making the map look inlined - if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 && - ref($curRes) && $curRes->is_map()) { - $deltadepth = -1; - $curRes = $mapIterator->next(); - next; - } - if ($curRes == $mapIterator->BEGIN_MAP() || $curRes == $mapIterator->BEGIN_BRANCH()) { $indentLevel++; @@ -324,17 +394,17 @@ sub handler { if (ref($curRes)) { $counter++; } - if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're - # out of the inlined map + if (ref($curRes)) { - # Is this resource being ignored because it is in a random-out - # map and it was not selected? - if (ref($curRes) && !advancedUser() && $curRes->randomout()) { - $curRes = $mapIterator->next(); - next; # if yes, then just ignore this resource - } + my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon - if (ref($curRes) && $curRes->src()) { + if ($indentLevel - $deltalevel < 0) { + # If this would be at a negative depth (top-level maps in + # new-style courses, we want to suppress their title display) + # then ignore it. + $curRes = $mapIterator->next(); + next; + } # Step one: Decide which parts to show my @parts = @{$curRes->parts()}; @@ -356,6 +426,9 @@ sub handler { # Otherwise, only display part 0 if we want to # attach feedback or email information to it if ($curRes->hasDiscussion() || $curRes->getFeedback()) { + # Is this right? I think this will toss it + # if it DOES have discussion, not if it doesn't? + # - Jeremy (yes, commenting on his own code) shift @parts; } else { # Now, we decide whether to condense the @@ -378,7 +451,7 @@ sub handler { } } - # $allSame is true if all the statuses were + # $*allSame is true if all the statuses were # the same. Now, if they are all the same and # match one of the statuses to condense, or they # are all open with the same due date, or they are @@ -421,7 +494,6 @@ sub handler { # For each part we intend to display... foreach my $part (@parts) { - my $deltalevel = 0; # for inserting the branch icon my $nonLinkedText = ""; # unlinked stuff after title my $stack = $mapIterator->getStack(); @@ -436,6 +508,10 @@ sub handler { '"'; my $title = $curRes->compTitle(); + if ($src=~/^\/uploaded\//) { + $nonLinkedText=$title; + $title=''; + } my $partLabel = ""; my $newBranchText = ""; @@ -443,7 +519,6 @@ sub handler { if ($isNewBranch) { $newBranchText = ""; $isNewBranch = 0; - $deltalevel = 1; # reserves space for the branch icon } # links to open and close the folders @@ -471,7 +546,10 @@ sub handler { $linkopen .= ($nowOpen xor $condition) ? addToFilter(\%filterHash, $mapId) : removeFromFilter(\%filterHash, $mapId); - $linkopen .= "&condition=$condition&$queryAdd\">"; + $linkopen .= "&condition=$condition&$queryAdd" . + "&hereType=$hereType&here=" . + Apache::lonnet::escape($here) . "&jumpType=".SYMB()."&" . + "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">"; $linkclose = ""; } @@ -479,27 +557,13 @@ sub handler { my $colorizer = ""; my $color; if ($curRes->is_problem()) { - my $status = $curRes->status($part); - $color = $colormap{$status}; + $color = $colormap{$curRes->status}; - # Special case in the navmaps: If in less then - # 24 hours, give it a bit of urgency - if (($status == $curRes->OPEN() || $status == $curRes->ATTEMPTED() || - $status == $curRes->TRIES_LEFT()) - && $curRes->duedate() && - $curRes->duedate() < time()+(24*60*60) && - $curRes->duedate() > time()) { - $color = $hurryUpColor; - } - # Special case: If this is the last try, and there is - # more then one available, and it's not due yet, give a bit of urgency - my $tries = $curRes->tries($part); - my $maxtries = $curRes->maxtries($part); - if ($tries && $maxtries && $maxtries > 1 && - $maxtries - $tries == 1 && $curRes->duedate() && - $curRes->duedate() > time()) { + if (dueInLessThen24Hours($curRes, $part) || + lastTry($curRes, $part)) { $color = $hurryUpColor; } + if ($color ne "") { $colorizer = "bgcolor=\"$color\""; } @@ -513,27 +577,29 @@ sub handler { my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; # FIRST COL: The resource indentation, branch icon, name, and anchor - $r->print(" \n"); # SECOND COL: Is there text, feedback, errors?? - my $discussionHTML = ""; my $feedbackHTML = ""; + my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; if ($curRes->hasDiscussion()) { $discussionHTML = $linkopen . @@ -574,7 +642,19 @@ sub handler { } } - $r->print(""); + if ($curRes->getErrors()) { + my $errors = $curRes->getErrors(); + foreach (split(/,/, $errors)) { + if ($_) { + $errorHTML .= ' ' + . ''; + } + } + } + + $r->print(""); # Is this the first displayed part of a multi-part problem # that has not been condensed, so we should suppress these two @@ -611,15 +691,33 @@ sub handler { } $r->print(" \n"); + + if (!($counter % 20)) { $r->rflush(); } + if ($counter == 2) { $r->rflush(); } } } $curRes = $mapIterator->next(); } - $r->print("
Key:  
\n"); + $r->print("
\n"); # Print the anchor if necessary - if ($counter == $currentUrlIndex - $currentUrlDelta) { - $r->print(''); + if ($counter == $currentJumpIndex - $currentJumpDelta ) { + $r->print(''); + $displayedJumpMarker = 1; } # print indentation - for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) { + for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) { $r->print($indentString); } $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); - #$r->print($curRes->awarded($part)); my $curMarkerBegin = ""; my $curMarkerEnd = ""; # Is this the current resource? - if ($curRes->src() eq $currenturl && !$displayedHereMarker) { - $curMarkerBegin = '> '; + if (!$displayedHereMarker && + (($hereType == SYMB() && $curRes->symb eq $here) || + ($hereType == URL() && $curRes->src eq $here))) { + $curMarkerBegin = '> '; $curMarkerEnd = ' <'; $displayedHereMarker = 1; } @@ -548,13 +614,15 @@ sub handler { $r->print(" $curMarkerBegin$title$partLabel $curMarkerEnd $nonLinkedText"); - if ($curRes->{RESOURCE_ERROR}) { - $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", - 'Host down')); - } + #if ($curRes->{RESOURCE_ERROR}) { + # $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", + # 'Host down')); + # } + + $r->print("$discussionHTML$feedbackHTML $discussionHTML$feedbackHTML$errorHTML 
"); + $r->print(""); + + # Print out the part that jumps to #curloc if it exists + if ($displayedJumpMarker) { + $r->print(''); + } + + # renderer call + $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0); + my $render = render({ 'cols' => [0,1,2,3], 'iterator' => $mapIterator, + 'url' => '/adm/navmaps', + 'queryString' => 'alreadyHere=1' }); + $r->print('|' . $render . '|'); $navmap->untieHashes(); + $r->print(""); + $r->rflush(); + return OK; } @@ -728,6 +826,33 @@ sub getDescription { } } +# Convenience function, so others can use it: Is the problem due in less then +# 24 hours, and still can be done? + +sub dueInLessThen24Hours { + my $res = shift; + my $part = shift; + my $status = $res->status($part); + + return ($status == $res->OPEN() || $status == $res->ATTEMPTED() || + $status == $res->TRIES_LEFT()) && + $res->duedate() && $res->duedate() < time()+(24*60*60) && + $res->duedate() > time(); +} + +# Convenience function, so others can use it: Is there only one try remaining for the +# part, with more then one try to begin with, not due yet and still can be done? +sub lastTry { + my $res = shift; + my $part = shift; + + my $tries = $res->tries($part); + my $maxtries = $res->maxtries($part); + return $tries && $maxtries && $maxtries > 1 && + $maxtries - $tries == 1 && $res->duedate() && + $res->duedate() > time(); +} + # This puts a human-readable name on the ENV variable. sub advancedUser { return $ENV{'user.adv'}; @@ -839,13 +964,531 @@ sub timeToHumanString { } } + +=pod + +=head1 navmap renderer + +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. + +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 package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}). + +=head2 Overview of Columns + +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 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: + +=over 4 + +=item * B: 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 + +=item * B: If true, the resource will not be linked. Default: false, resource will have links. + +=item * B: 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. + +=back + +=item B: 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: 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: 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 + +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: + + sub { + my ($resource, $part, $params) = @_; + if ($part) { return '' . $resource->{ID} . ' ' . $part . ''; } + return '' . $resource->{ID} . ''; + } + +Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc. + +=head2 Parameters + +=over 4 + +=item * B: 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. + +=item * B: An array reference + +=item * B: 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: 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: 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. + +=item * B: A URL identifying where to place the 'here' marker. + +=item * B: A Symb identifying where to place the 'here' marker. + +=item * B: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. + +=item * B: A string which will be prepended to the query string used when the folders are opened or closed. + +=item * B: The url the folders will link to, which should be the current page. Required if the resource info column is shown. + +=back + +=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: + +=over 4 + +=back + +=cut + +sub resource { return 0; } +sub communication_status { return 1; } +sub quick_status { return 2; } +sub long_status { return 3; } + +# Data for render_resource + +my $resObj = 'Apache::lonnavmaps::resource'; +# Defines a status->color mapping, null string means don't color +my %colormap = + ( $resObj->NETWORK_FAILURE => '', + $resObj->CORRECT => '', + $resObj->EXCUSED => '#3333FF', + $resObj->PAST_DUE_ANSWER_LATER => '', + $resObj->PAST_DUE_NO_ANSWER => '', + $resObj->ANSWER_OPEN => '#006600', + $resObj->OPEN_LATER => '', + $resObj->TRIES_LEFT => '', + $resObj->INCORRECT => '', + $resObj->OPEN => '', + $resObj->NOTHING_SET => '' ); +# 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 +my $hurryUpColor = "#FF0000"; + +sub render_resource { + my ($resource, $part, $params) = @_; + + my $nonLinkedText = ''; # stuff after resource title not in link + + my $link = $params->{"resourceLink"}; + my $src = $resource->src(); + my $it = $params->{"iterator"}; + my $filter = $it->{FILTER}; + + my $title = $resource->compTitle(); + if ($src =~ /^\/uploaded\//) { + $nonLinkedText=$title; + $title = ''; + } + my $partLabel = ""; + my $newBranchText = ""; + + # If this is a new branch, label it so + if ($params->{'isNewBranch'}) { + $newBranchText = ""; + $params->{'isNewBranch'} = 0; + } + + # links to open and close the folder + my $linkopen = ""; + my $linkclose = ""; + + # Default icon: HTML page + my $icon = ""; + + if ($resource->is_problem()) { + if ($part eq "0" || $params->{'condensed'}) { + $icon = ''; + } else { + $icon = $params->{'indentString'}; + } + } + + # Display the correct map icon to open or shut map + if ($resource->is_map()) { + my $mapId = $resource->map_pc(); + my $nowOpen = !defined($filter->{$mapId}); + if ($it->{CONDITION}) { + $nowOpen = !$nowOpen; + } + $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; + $icon = ""; + + $linkopen = "{'queryString'} . '&filter='; + $linkopen .= ($nowOpen xor $it->{CONDITION}) ? + addToFilter($filter, $mapId) : + removeFromFilter($filter, $mapId); + $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' + . $params->{'hereType'} . '&here=' . + &Apache::lonnet::escape($params->{'here'}) . + '&jumpType=' . SYMB() . '&jump=' . + &Apache::lonnet::escape($params->{$resource->symb()}) . "'>"; + } + + if ($resource->randomout()) { + $nonLinkedText .= ' (hidden) '; + } + + # We're done preparing and finally ready to start the rendering + my $result = ""; + + # print indentation + for (my $i = 0; $i < $params->{'indentLevel'} - + $params->{'deltaLevel'}; $i++) { + $result .= $params->{'indentString'}; + } + + # Decide what to display + $result .= "$newBranchText$linkopen$icon$linkclose"; + + my $curMarkerBegin = ''; + my $curMarkerEnd = ''; + + # Is this the current resource? + if (!$params->{'displayedHereMarker'} && + (($params->{'hereType'} == SYMB() && + $resource->symb() eq $params->{'here'}) || + ($params->{'hereType'} == URL() && + $resource->src() eq $params->{'here'}))) { + $curMarkerBegin = '> '; + $curMarkerEnd = '<'; + } + + if ($resource->is_problem() && $part ne "0" && + !$params->{'condensed'}) { + $partLabel = " (Part $part)"; + $title = ""; + } + + if ($params->{'multipart'} && $params->{'condensed'}) { + $nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; + } + + $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText"; + + return $result; +} + +sub render_communication_status { + my ($resource, $part, $params) = @_; + my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; + + my $link = $params->{"resourceLink"}; + my $linkopen = ""; + my $linkclose = ""; + + if ($resource->hasDiscussion()) { + $discussionHTML = $linkopen . + '' . + $linkclose; + } + + if ($resource->getFeedback()) { + my $feedback = $resource->getFeedback(); + foreach (split(/\,/, $feedback)) { + if ($_) { + $feedbackHTML .= ' ' + . ''; + } + } + } + + if ($resource->getErrors()) { + my $errors = $resource->getErrors(); + foreach (split(/,/, $errors)) { + if ($_) { + $errorHTML .= ' ' + . ''; + } + } + } + + return "$discussionHTML$feedbackHTML$errorHTML "; + +} +sub render_quick_status { + my ($resource, $part, $params) = @_; + my $result = ""; + my $firstDisplayed = !$params->{'condensed'} && + $params->{'multipart'} && $part eq "0"; + + my $link = $params->{"resourceLink"}; + my $linkopen = ""; + my $linkclose = ""; + + if ($resource->is_problem() && + !$firstDisplayed) { + my $icon = $statusIconMap{$resource->status($part)}; + my $alt = $iconAltTags{$icon}; + if ($icon) { + $result .= "$linkopen$alt$linkclose\n"; + } else { + $result .= " \n"; + } + } else { # not problem, no icon + $result .= " \n"; + } + + return $result; +} +sub render_long_status { + my ($resource, $part, $params) = @_; + return "long_status"; +} + +my @preparedColumns = (\&render_resource, \&render_communication_status, + \&render_quick_status, \&render_long_status); + +sub setDefault { + my ($val, $default) = @_; + if (!defined($val)) { return $default; } + return $val; +} + +sub render { + my $args = shift; + + # Configure the renderer. + my $cols = $args->{'cols'}; + if (!defined($cols)) { + # no columns, no nav maps. + return ''; + } + my $it = $args->{'iterator'}; + if (!defined($it)) { + # no iterator, no nav map. + return ''; + } + + my $showParts = setDefault($args->{'showParts'}, 1); + my $condenseParts = setDefault($args->{'condenseParts'}, 1); + my $jumpToURL = $args->{'jumpToURL'}; + my $jumpToSymb = $args->{'jumpToSymb'}; + my $hereURL = $args->{'hereURL'}; + my $hereSymb = $args->{'hereSymb'}; + + #if (defined($jumpToURL)) { + # $args->{'jumpType'} = + + # End parameter setting + + # Data + my $result .= '' ."\n"; + my $res = "Apache::lonnavmaps::resource"; + my %condenseStatuses = + ( $res->NETWORK_FAILURE => 1, + $res->NOTHING_SET => 1, + $res->CORRECT => 1 ); + my @backgroundColors = ("#FFFFFF", "#F6F6F6"); + my $currentJumpIndex = 0; # keeps track of when the current resource is found, + # so we can back up a few and put the anchor above the + # current resource + my $currentJumpDelta = 2; # change this to change how many resources are displayed + # before the current resource when using #current + + # Shared variables + $args->{'counter'} = 0; # counts the rows + $args->{'indentLevel'} = 0; + $args->{'isNewBranch'} = 0; + $args->{'condensed'} = 0; + $args->{'indentString'} = setDefault($args->{'indentString'}, ""); + $args->{'displayedHereMarker'} = 0; + + my $displayedJumpMarker = 0; + # Set up iteration. + my $depth = 1; + $it->next(); # discard initial BEGIN_MAP + my $curRes = $it->next(); + my $now = time(); + my $in24Hours = $now + 24 * 60 * 60; + my $rownum = 0; + + while ($depth > 0) { + if ($curRes == $it->BEGIN_MAP()) { $depth++; } + if ($curRes == $it->END_MAP()) { $depth--; } + + # Maintain indentation level. + if ($curRes == $it->BEGIN_MAP() || + $curRes == $it->BEGIN_BRANCH() ) { + $args->{'indentLevel'}++; + } + if ($curRes == $it->END_MAP() || + $curRes == $it->END_BRANCH() ) { + $args->{'indentLevel'}--; + } + # Notice new branches + if ($curRes == $it->BEGIN_BRANCH()) { + $args->{'isNewBranch'} = 1; + } + + # If this isn't an actual resource, continue on + if (!ref($curRes)) { + $curRes = $it->next(); + next; + } + + $args->{'counter'}++; + # reserve space for branch symbol + $args->{'deltalevel'} = $args->{'isNewBranch'}? 1 : 0; + if ($args->{'indentLevel'} - $args->{'deltalevel'} < 0) { + # If this would be at a negative depth (top-level maps in + # new-style courses, we want to suppress their title display) + # then ignore it. + $curRes = $it->next(); + next; + } + + # Does it have multiple parts? + $args->{'multipart'} = 0; + $args->{'condensed'} = 0; + my @parts; + + # Decide what parts to show. + if ($curRes->is_problem() && $showParts) { + @parts = @{$curRes->parts()}; + $args->{'multipart'} = scalar(@parts) > 1; + + if ($condenseParts) { # do the condensation + if (!$curRes->opendate("0")) { + @parts = ("0"); + $args->{'condensed'} = 1; + } + if (!$args->{'condensed'}) { + # Decide whether to condense based on similarity + my $status = $curRes->status($parts[1]); + my $due = $curRes->duedate($parts[1]); + my $open = $curRes->opendate($parts[1]); + my $statusAllSame = 1; + my $dueAllSame = 1; + my $openAllSame = 1; + for (my $i = 2; $i < scalar(@parts); $i++) { + if ($curRes->status($parts[$i]) != $status){ + $statusAllSame = 0; + } + if ($curRes->duedate($parts[$i]) != $due ) { + $dueAllSame = 0; + } + if ($curRes->opendate($parts[$i]) != $open) { + $openAllSame = 0; + } + } + # $*allSame is true if all the statuses were + # the same. Now, if they are all the same and + # match one of the statuses to condense, or they + # are all open with the same due date, or they are + # all OPEN_LATER with the same open date, display the + # status of the first non-zero part (to get the 'correct' + # status right, since 0 is never 'correct' or 'open'). + if (($statusAllSame && defined($condenseStatuses{$status})) || + ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| + ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ + @parts = ($parts[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 (scalar(@parts) == 1) { + $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 + # show them. + foreach my $part (@parts) { + $rownum ++; + my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)]; + + $result .= " \n"; + + # Set up some data about the parts that the cols might want + my $filter = $it->{FILTER}; + my $stack = $it->getStack(); + my $src = getLinkForResource($stack); + + my $srcHasQuestion = $src =~ /\?/; + $args->{"resourceLink"} = $src. + ($srcHasQuestion?'&':'?') . + 'symb=' . &Apache::lonnet::escape($curRes->symb()). + '"'; + + # Now, display each column. + foreach my $col (@$cols) { + + # If this is the first column and it's time to print + # the anchor, do so + if ($col == $cols->[0] && + $args->{'counter'} == $args->{'currentJumpIndex'} - + $args->{'currentJumpDelta'}) { + $result .= ''; + $displayedJumpMarker = 1; + } + + + if (ref($col)) { + $result .= &$col($curRes, $part, $args); + } else { + $result .= &{$preparedColumns[$col]}($curRes, $part, $args); + } + + } + + $result .= " \n"; + } + + + $curRes = $it->next(); + } + + # Print out the part that jumps to #curloc if it exists + if ($args->{"displayedJumpMarker"}) { + $result .= "\n"; + } + + $result .= "
"; + + return $result; +} + 1; package Apache::lonnavmaps::navmap; =pod -lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button. +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 @@ -888,22 +1531,22 @@ sub new { $self->{NETWORK_FAILURE} = 0; # tie the nav hash - my %navmaphash; + if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, &GDBM_READER(), 0640))) { return undef; } - $self->{NAV_HASH} = \%navmaphash; - my %parmhash; if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, &GDBM_READER(), 0640))) { untie $self->{PARM_HASH}; return undef; } - $self->{PARM_HASH} = \%parmhash; + $self->{HASH_TIED} = 1; + $self->{NAV_HASH} = \%navmaphash; + $self->{PARM_HASH} = \%parmhash; bless($self); @@ -976,7 +1619,7 @@ sub init { my %emailstatus = &Apache::lonnet::dump('email_status'); my $logoutTime = $emailstatus{'logout'}; my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; - $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? + $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ? $courseLeaveTime : $logoutTime); my %discussiontime = &Apache::lonnet::dump('discussiontimes', $cdom, $cnum); @@ -1019,13 +1662,20 @@ sub init { $self->{PARM_CACHE} = {}; } +# Internal function: Takes a key to look up in the nav hash and implements internal +# memory caching of that key. +sub navhash { + my $self = shift; my $key = shift; + return $self->{NAV_HASH}->{$key}; +} + # Checks to see if coursemap is defined, matching test in old lonnavmaps sub courseMapDefined { my $self = shift; my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); - my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; - my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; + my $firstres = $self->navhash("map_start_$uri"); + my $lastres = $self->navhash("map_finish_$uri"); return $firstres && $lastres; } @@ -1050,18 +1700,19 @@ sub DESTROY { $self->untieHashes(); } -# Private function: 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. sub hasDiscussion { my $self = shift; my $symb = shift; if (!defined($self->{DISCUSSION_TIME})) { return 0; } + #return defined($self->{DISCUSSION_TIME}->{$symb}); return $self->{DISCUSSION_TIME}->{$symb} > $self->{LAST_CHECK}; } -# Private function: Does the given resource (as a symb string) have +# Private method: Does the given resource (as a symb string) have # current feedback? Returns the string in the feedback hash, which # will be false if it does not exist. sub getFeedback { @@ -1073,6 +1724,15 @@ sub getFeedback { return $self->{FEEDBACK}->{$symb}; } +# Private method: Get the errors for that resource (by source). +sub getErrors { + my $self = shift; + my $src = shift; + + if (!defined($self->{ERROR_MSG})) { return ""; } + return $self->{ERROR_MSG}->{$src}; +} + =pod =item * B(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. @@ -1094,7 +1754,9 @@ sub getById { } # resource handles inserting itself into cache. - return Apache::lonnavmaps::resource->new($self, $id); + # Not clear why the quotes are necessary, but as of this + # writing it doesn't work without them. + return "Apache::lonnavmaps::resource"->new($self, $id); } =pod @@ -1105,8 +1767,8 @@ sub getById { sub firstResource { my $self = shift; - my $firstResource = $self->{NAV_HASH}->{'map_start_' . - &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + my $firstResource = $self->navhash('map_start_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})); return $self->getById($firstResource); } @@ -1118,8 +1780,8 @@ sub firstResource { sub finishResource { my $self = shift; - my $firstResource = $self->{NAV_HASH}->{'map_finish_' . - &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + my $firstResource = $self->navhash('map_finish_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})); return $self->getById($firstResource); } @@ -1221,7 +1883,6 @@ sub parmval_real { return ''; } - 1; package Apache::lonnavmaps::iterator; @@ -1246,7 +1907,7 @@ getIterator behaves as follows: =over 4 -=item * B(firstResource, finishResource, filterHash, condition): 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. +=item * B(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. 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. @@ -1266,6 +1927,8 @@ The iterator will return either a refere 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. + =back =cut @@ -1284,6 +1947,11 @@ sub min { if ($a < $b) { return $a; } else { return $b; } } +# In the CVS repository, documentation of this algorithm is included +# in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1** +# will reference the same location in the text as the part of the +# algorithm is running through. + sub new { # magic invocation to create a class instance my $proto = shift; @@ -1311,6 +1979,9 @@ sub new { if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; $self->{CONDITION} = shift; + # Do we want to automatically follow "redirection" maps? + $self->{FORCE_TOP} = shift; + # 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. @@ -1326,6 +1997,13 @@ sub new { my $maxDepth = 0; # tracks max depth + # If there is only one resource in this map, and it's a map, we + # want to remember that, so the user can ask for the first map + # that isn't just a redirector. + my $resource; my $resourceCount = 0; + + # **1** + foreach my $pass (@iterations) { my $direction = $pass->[0]; my $valName = $pass->[1]; @@ -1347,16 +2025,23 @@ sub new { if ($curRes == $iterator->END_MAP()) { $depth--; } if (ref($curRes)) { + # If there's only one resource, this will save it + # we have to filter empty resources from consideration here, + # or even "empty", redirecting maps have two (start & finish) + # or three (start, finish, plus redirector) + if($direction == FORWARD && $curRes->src()) { + $resource = $curRes; $resourceCount++; + } my $resultingVal = $curRes->{DATA}->{$valName}; my $nextResources = $curRes->$nextResourceMethod(); - my $resourceCount = scalar(@{$nextResources}); + my $nextCount = scalar(@{$nextResources}); - if ($resourceCount == 1) { + if ($nextCount == 1) { # **3** my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); } - if ($resourceCount > 1) { + if ($nextCount > 1) { # **4** foreach my $res (@{$nextResources}) { my $current = $res->{DATA}->{$valName} || 999999999; $res->{DATA}->{$valName} = min($current, $resultingVal + 1); @@ -1364,7 +2049,7 @@ sub new { } } - # Assign the final val + # Assign the final val (**2**) if (ref($curRes) && $direction == BACKWARD()) { my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL}, $curRes->{DATA}->{BOT_UP_VAL}); @@ -1376,6 +2061,18 @@ sub new { } } + # Check: Was this only one resource, a map? + if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) { + my $firstResource = $resource->map_start(); + my $finishResource = $resource->map_finish(); + return + Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, + $finishResource, $self->{FILTER}, + $self->{ALREADY_SEEN}, + $self->{CONDITION}, 0); + + } + # Set up some bookkeeping information. $self->{CURRENT_DEPTH} = 0; $self->{MAX_DEPTH} = $maxDepth; @@ -1386,7 +2083,7 @@ sub new { push @{$self->{STACK}}, []; } - # Prime the recursion w/ the first resource + # Prime the recursion w/ the first resource **5** push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE}; $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1; @@ -1435,8 +2132,8 @@ sub next { my $newDepth; my $here; while ( $i >= 0 && !$found ) { - if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { - $here = pop @{$self->{STACK}->[$i]}; + if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6** + $here = pop @{$self->{STACK}->[$i]}; # **7** $found = 1; $newDepth = $i; } @@ -1456,7 +2153,7 @@ sub next { # If this is not a resource, it must be an END_BRANCH marker we want # to return directly. - if (!ref($here)) { + if (!ref($here)) { # **8** if ($here == END_BRANCH()) { # paranoia, in case of later extension $self->{CURRENT_DEPTH}--; return $here; @@ -1503,8 +2200,11 @@ sub next { # BC branch and gets to C, it will see F as the only next resource, but it's # one level lower. Thus, this is the end of the branch, since there are no # more resources added to this level or above. + # We don't do this if the examined resource is the finish resource, + # because the condition given above is true, but the "END_MAP" will + # take care of things and we should already be at depth 0. my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH}; - if ($isEndOfBranch) { + if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9** push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); } @@ -1522,6 +2222,13 @@ sub next { $self->{ALREADY_SEEN}, $self->{CONDITION}); } + # If this is a blank resource, don't actually return it. + # Should you ever find you need it, make sure to add an option to the code + # that you can use; other things depend on this behavior. + if (!$self->{HERE}->src() || !$self->{HERE}->browsePriv()) { + return $self->next(); + } + return $self->{HERE}; } @@ -1568,6 +2275,9 @@ package Apache::lonnavmaps::DFSiterator; # but this might as well be left seperate, since it is possible some other # use might be found for it. - Jeremy +# Unlike the main iterator, this DOES return all resources, even blank ones. +# The main iterator needs them to correctly preprocess the map. + sub BEGIN_MAP { return 1; } # begining of a new map sub END_MAP { return 2; } # end of the map sub FORWARD { return 1; } # go forward @@ -1768,7 +2478,7 @@ sub navHash { my $self = shift; my $param = shift; my $id = shift; - return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; + return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:"")); } =pod @@ -1998,10 +2708,7 @@ sub answerdate { } return $self->parmval("answerdate", $part); } -sub awarded { - (my $self, my $part) = @_; - return $self->parmval("awarded", $part); -} +sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); } sub duedate { (my $self, my $part) = @_; return $self->parmval("duedate", $part); @@ -2026,24 +2733,18 @@ sub tol { (my $self, my $part) = @_; return $self->parmval("tol", $part); } -sub tries { - my $self = shift; - my $part = shift; - $part = '0' if (!defined($part)); - - # Make sure return hash is loaded, should error check - $self->getReturnHash(); - - my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'}; - if (!defined($tries)) {return '0';} +sub tries { + my $self = shift; + my $tries = $self->queryRestoreHash('tries', shift); + if (!defined($tries)) { return '0';} return $tries; } sub type { (my $self, my $part) = @_; return $self->parmval("type", $part); } -sub weight { - (my $self, my $part) = @_; +sub weight { + my $self = shift; my $part = shift; return $self->parmval("weight", $part); } @@ -2098,7 +2799,16 @@ sub hasDiscussion { sub getFeedback { my $self = shift; - return $self->{NAV_MAP}->getFeedback($self->src()); + my $source = $self->src(); + if ($source =~ /^\/res\//) { $source = substr $source, 5; } + return $self->{NAV_MAP}->getFeedback($source); +} + +sub getErrors { + my $self = shift; + my $source = $self->src(); + if ($source =~ /^\/res\//) { $source = substr $source, 5; } + return $self->{NAV_MAP}->getErrors($source); } =pod @@ -2305,14 +3015,9 @@ sub ATTEMPTED { return 16; } sub getCompletionStatus { my $self = shift; - my $part = shift; - $part = "0" if (!defined($part)); return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); - # Make sure return hash exists - $self->getReturnHash(); - - my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'}; + my $status = $self->queryRestoreHash('solved', shift); # Left as seperate if statements in case we ever do more with this if ($status eq 'correct_by_student') {return $self->CORRECT;} @@ -2324,6 +3029,18 @@ sub getCompletionStatus { return $self->NOT_ATTEMPTED; } +sub queryRestoreHash { + my $self = shift; + my $hashentry = shift; + my $part = shift; + $part = "0" if (!defined($part)); + return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); + + $self->getReturnHash(); + + return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry}; +} + =pod B @@ -2447,12 +3164,7 @@ sub getNext { my $next = $choice->goesto(); $next = $self->{NAV_MAP}->getById($next); - # Don't remember it if the student doesn't have browse priviledges - # future note: this may properly belong in the client of the resource - my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); - if (!($browsePriv ne '2' && $browsePriv ne 'F')) { - push @branches, $next; - } + push @branches, $next; } return \@branches; } @@ -2466,16 +3178,20 @@ sub getPrevious { my $prev = $choice->comesfrom(); $prev = $self->{NAV_MAP}->getById($prev); - # Don't remember it if the student doesn't have browse priviledges - # future note: this may properly belong in the client of the resource - my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); - if (!($browsePriv ne '2' && $browsePriv ne 'F')) { - push @branches, $prev; - } + push @branches, $prev; } return \@branches; } +sub browsePriv { + my $self = shift; + if (defined($self->{BROWSE_PRIV})) { + return $self->{BROWSE_PRIV}; + } + + $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src()); +} + =pod =back