--- loncom/interface/lonnavmaps.pm 2002/11/15 18:10:22 1.108 +++ loncom/interface/lonnavmaps.pm 2002/11/26 16:25:36 1.116 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.108 2002/11/15 18:10:22 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.116 2002/11/26 16:25:36 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -83,8 +83,11 @@ 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(''); @@ -113,10 +116,22 @@ sub handler { $condition = 1; } + 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"; + 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('
 '); @@ -143,10 +158,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,6 +171,8 @@ sub handler { # is not yet done and due in less then 24 hours my $hurryUpColor = "#FF0000"; + # Keep these mappings in sync with lonquickgrades, which uses the colors + # instead of the icons. my %statusIconMap = ( $res->NETWORK_FAILURE => '', $res->NOTHING_SET => '', @@ -191,19 +208,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 @@ -226,8 +230,10 @@ sub handler { $mapIterator->next(); # discard the first BEGIN_MAP my $curRes = $mapIterator->next(); my $counter = 0; - - while ($depth > 0) { + + # We only need to do this if we need to open the maps to show the + # current position + while ($depth > 0 && !$ENV{'form.alreadyHere'}) { if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } if ($curRes == $mapIterator->END_MAP()) { $depth--; } @@ -256,17 +262,6 @@ 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; - } - } - $curRes = $mapIterator->next(); } @@ -285,7 +280,6 @@ sub handler { $condition); $mapIterator->next(); $curRes = $mapIterator->next(); - my $deltadepth = 0; $depth = 1; my @backgroundColors = ("#FFFFFF", "#F6F6F6"); @@ -299,15 +293,6 @@ sub handler { } 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,9 +309,6 @@ sub handler { if (ref($curRes)) { $counter++; } - if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're - # out of the inlined map - # Is this resource being ignored because it is in a random-out # map and it was not selected? if (ref($curRes) && !advancedUser() && $curRes->randomout()) { @@ -334,7 +316,17 @@ sub handler { next; # if yes, then just ignore this resource } - if (ref($curRes) && $curRes->src()) { + if (ref($curRes)) { + + my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon + + 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()}; @@ -421,7 +413,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(); @@ -443,7 +434,6 @@ sub handler { if ($isNewBranch) { $newBranchText = ""; $isNewBranch = 0; - $deltalevel = 1; # reserves space for the branch icon } # links to open and close the folders @@ -479,27 +469,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,7 +489,7 @@ sub handler { my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; # FIRST COL: The resource indentation, branch icon, name, and anchor - $r->print(" \n"); + $r->print(" \n"); # Print the anchor if necessary if ($counter == $currentUrlIndex - $currentUrlDelta) { @@ -521,12 +497,11 @@ sub handler { } # 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 = ""; @@ -553,6 +528,8 @@ sub handler { 'Host down')); } + $r->print("\n"); + # SECOND COL: Is there text, feedback, errors?? my $discussionHTML = ""; my $feedbackHTML = ""; @@ -611,6 +588,9 @@ sub handler { } $r->print(" \n"); + + if (!($counter % 20)) { $r->rflush(); } + if ($counter == 2) { $r->rflush(); } } } $curRes = $mapIterator->next(); @@ -728,6 +708,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'}; @@ -893,7 +900,6 @@ sub new { &GDBM_READER(), 0640))) { return undef; } - $self->{NAV_HASH} = \%navmaphash; my %parmhash; if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, @@ -902,10 +908,16 @@ sub new { untie $self->{PARM_HASH}; return undef; } - $self->{PARM_HASH} = \%parmhash; - $self->{HASH_TIED} = 1; + + # Now copy the hashes for speed (?) + my %realnav; my %realparm; + foreach (%navmaphash) { $realnav{$_} = $navmaphash{$_}; } + foreach (%parmhash) { $realparm{$_} = $navmaphash{$_}; } + $self->{NAV_HASH} = \%realnav; + $self->{PARM_HASH} = \%realparm; bless($self); + $self->untieHashes(); return $self; } @@ -1019,13 +1031,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; } @@ -1105,8 +1124,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 +1137,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); } @@ -1246,7 +1265,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 +1285,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 @@ -1316,6 +1337,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. @@ -1331,6 +1355,11 @@ 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) { @@ -1354,16 +1383,18 @@ sub new { if ($curRes == $iterator->END_MAP()) { $depth--; } if (ref($curRes)) { + # If there's only one resource, this will save it + if($direction == FORWARD) { $resource = $curRes; $resourceCount++; } my $resultingVal = $curRes->{DATA}->{$valName}; my $nextResources = $curRes->$nextResourceMethod(); - my $resourceCount = scalar(@{$nextResources}); + my $nextCount = scalar(@{$nextResources}); - if ($resourceCount == 1) { # **3** + if ($nextCount == 1) { # **3** my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); } - if ($resourceCount > 1) { # **4** + if ($nextCount > 1) { # **4** foreach my $res (@{$nextResources}) { my $current = $res->{DATA}->{$valName} || 999999999; $res->{DATA}->{$valName} = min($current, $resultingVal + 1); @@ -1383,6 +1414,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; @@ -1510,8 +1553,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) { # **9** + if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9** push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); } @@ -1529,6 +1575,11 @@ sub next { $self->{ALREADY_SEEN}, $self->{CONDITION}); } + # If this is a blank resource, don't actually return it. + if (!$self->{HERE}->src()) { + return $self->next(); + } + return $self->{HERE}; } @@ -1712,6 +1763,11 @@ sub next { $self->{CONDITION}, $self->{DIRECTION}); } + # If this is a blank resource, ignore it. + if (!$self->{HERE}->src()) { + return $self->next(); + } + return $self->{HERE}; } @@ -1775,7 +1831,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 @@ -2040,8 +2096,8 @@ 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); } @@ -2454,7 +2510,11 @@ sub getNext { # 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); + my $browsePriv = $self->{BROWSE_PRIV}; + if (!defined($browsePriv)) { + $browsePriv = &Apache::lonnet::allowed('bre', $self->src); + $self->{BROWSE_PRIV} = $browsePriv; + } if (!($browsePriv ne '2' && $browsePriv ne 'F')) { push @branches, $next; } @@ -2473,7 +2533,11 @@ sub getPrevious { # 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); + my $browsePriv = $self->{BROWSE_PRIV}; + if (!defined($browsePriv)) { + $browsePriv = &Apache::lonnet::allowed('bre', $self->src); + $self->{BROWSE_PRIV} = $browsePriv; + } if (!($browsePriv ne '2' && $browsePriv ne 'F')) { push @branches, $prev; }