--- loncom/interface/lonnavmaps.pm 2002/11/08 19:10:58 1.100 +++ loncom/interface/lonnavmaps.pm 2002/12/02 14:19:38 1.119 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.100 2002/11/08 19:10:58 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.119 2002/12/02 14:19:38 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,19 +37,22 @@ # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer # YEAR=2002 # 1/1 Gerd Kortemeyer -# +# Oct-Nov Jeremy Bowers package Apache::lonnavmaps; use strict; use Apache::Constants qw(:common :http); -use Apache::lonnet(); use Apache::loncommon(); -use GDBM_File; use POSIX qw (floor strftime); sub handler { my $r = shift; + real_handler($r); +} + +sub real_handler { + my $r = shift; &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); @@ -73,7 +76,7 @@ sub handler { &Apache::loncommon::no_cache($r); $r->send_http_header; - # Create the nav map the nav map + # Create the nav map my $navmap = Apache::lonnavmaps::navmap->new( $ENV{"request.course.fn"}.".db", $ENV{"request.course.fn"}."_parms.db", 1, 1); @@ -85,14 +88,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(''); - my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $r->print(''); my $date=localtime; $r->print(''); + + # Print discussions and feedback header if ($navmap->{LAST_CHECK}) { $r->print(''); } $r->print('
Key:    '. ' New discussion since '. @@ -107,15 +115,64 @@ sub handler { '
'); + my $condition = 0; if ($ENV{'form.condition'}) { $condition = 1; } + # Determine where the "here" marker is and where the screen jumps to. + my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants + 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('
 '); @@ -135,14 +192,17 @@ sub handler { # is technically not proper, but should be harmless my $res = $navmap->firstResource(); + # These are some data tables, which make it easy to change some of + # of the specific visualization parameters if desired. + # Defines a status->color mapping, null string means don't color 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 => '', @@ -152,6 +212,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 => '', @@ -187,18 +249,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 @@ -210,35 +260,35 @@ sub handler { # Here's a simple example of the iterator. # Preprocess the map: Look for current URL, force inlined maps to display - # This currently does very little... - #my $mapEventualIterator = Apache::lonnavmaps::iterator->new($navmap, undef, undef, {}, - #undef, $condition); - - my $mapIterator = $navmap->getIterator(undef, undef, {}, 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 $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) { - if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } - if ($curRes == $mapIterator->END_MAP()) { $depth--; } - - if (ref($curRes)) { $counter++; } + my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one + my $looped = 0; - 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. + $r->print($hereType); - $currentUrlIndex = $counter; + # 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--; } + $r->print($curRes . ' '); + 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}) { if ($condition) { undef $filterHash{$map->map_pc()}; @@ -248,16 +298,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(); @@ -271,6 +338,7 @@ sub handler { 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 @@ -278,7 +346,6 @@ sub handler { $condition); $mapIterator->next(); $curRes = $mapIterator->next(); - my $deltadepth = 0; $depth = 1; my @backgroundColors = ("#FFFFFF", "#F6F6F6"); @@ -287,19 +354,6 @@ sub handler { $counter = 0; while ($depth > 0) { - # If we're in a new style course, and this is a BEGIN_MAP, END_MAP, or - # map resource and the stack depth is only one, just plain ignore this resource - # entirely. (This has the effect of inlining the resources in that map - # in the nav map.) - if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 && - ref($curRes) && $curRes->is_map()) { - # We let the normal depth stuff occur, but we need to shift everything - # over by one to the left to make it look right. - $deltadepth = -1; - $curRes = $mapIterator->next(); - next; - } - if ($curRes == $mapIterator->BEGIN_MAP() || $curRes == $mapIterator->BEGIN_BRANCH()) { $indentLevel++; @@ -316,16 +370,24 @@ 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 blotted out? + # 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; # and totally ignore this resource + 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()}; @@ -333,14 +395,15 @@ sub handler { my $condensed = 0; if ($curRes->is_problem()) { - # Is it multipart? + # Is it multipart? if ($multipart) { # If it's multipart, see if part 0 is "open" # if it is, display all parts, if it isn't, # just display first if (!$curRes->opendate("0")) { - @parts = ("0"); # just display the zero-th part + # no parts are open, display as one part + @parts = ("0"); $condensed = 1; } else { # Otherwise, only display part 0 if we want to @@ -348,9 +411,6 @@ sub handler { if ($curRes->hasDiscussion() || $curRes->getFeedback()) { shift @parts; } else { - # If there's discussion or feedback, that counts - # as a difference, so display the parts. - # Now, we decide whether to condense the # parts due to similarity my $status = $curRes->status($parts[1]); @@ -391,11 +451,11 @@ sub handler { } else { $parts[0] = "0"; # this is to get past foreach loop below # you can consider a non-problem resource as a resource - # with only one part without loss + # with only one part without loss, and it simplifies the looping } # Is it a multipart problem with a single part, now in - # @parts with "0" filtered out? If so, forget it's a multi-part + # @parts with "0" filtered out? If so, 'forget' it's a multi-part # problem and treat it like a single-part problem. if ( scalar(@parts) == 1 ) { $multipart = 0; @@ -403,41 +463,38 @@ sub handler { # Display one part, in event of network error. # If this is a single part, we can at least show the correct - # status, but if it's multipart, we're lost. + # 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"); } - # Step two: Show the parts + # Step Two: Print the actual data. + + # 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 - # For each thing we're displaying... - my $stack = $mapIterator->getStack(); my $src = getLinkForResource($stack); + # Pass the correct symb on the querystring, so the + # remote will figure out where we are if we click a link my $srcHasQuestion = $src =~ /\?/; my $link = $src. ($srcHasQuestion?'&':'?') . 'symb='.&Apache::lonnet::escape($curRes->symb()). '"'; - my $title = $curRes->title(); - if (!$title) { - $title = $curRes->src(); - $title = substr ($title, rindex($title, "/") + 1); - } + + my $title = $curRes->compTitle(); my $partLabel = ""; my $newBranchText = ""; # If this is a new branch, label it so - # (temporary, this should be an icon w/ alt text) if ($isNewBranch) { $newBranchText = ""; $isNewBranch = 0; - $deltalevel = 1; } # links to open and close the folders @@ -465,7 +522,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 = ""; } @@ -473,27 +533,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\""; } @@ -507,18 +553,16 @@ sub handler { my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; # FIRST COL: The resource indentation, branch icon, name, and anchor - $r->print(" \n"); + $r->print(" \n"); - # anchor for current resource... - 5 is deliberate: If it's that - # high on the screen, don't bother focusing on it. Also this will - # print multiple anchors if this is an expanded multi-part problem... - # who cares? - if ($counter == $currentUrlIndex - 5) { - $r->print(''); + # Print the anchor if necessary + 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); } @@ -528,8 +572,10 @@ sub handler { 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; } @@ -543,18 +589,17 @@ sub handler { } $r->print(" $curMarkerBegin$title$partLabel $curMarkerEnd $nonLinkedText"); - #$r->print(" TDV:" . $curRes->{DATA}->{TOP_DOWN_VAL}); # temp - #$r->print(" BUV:" . $curRes->{DATA}->{BOT_UP_VAL}); # temp - #$r->print(" DD:" . $curRes->{DATA}->{DISPLAY_DEPTH}); # temp - - if ($curRes->{RESOURCE_ERROR}) { - $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", - 'Host down')); - } - my $discussionHTML = ""; my $feedbackHTML = ""; + #if ($curRes->{RESOURCE_ERROR}) { + # $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", + # 'Host down')); + # } + + $r->print("\n"); # SECOND COL: Is there text, feedback, errors?? + my $discussionHTML = ""; my $feedbackHTML = ""; + if ($curRes->hasDiscussion()) { $discussionHTML = $linkopen . '' . @@ -577,7 +622,8 @@ sub handler { # Is this the first displayed part of a multi-part problem # that has not been condensed, so we should suppress these two - # columns? + # columns so we don't display useless status info about part + # "0"? my $firstDisplayed = !$condensed && $multipart && $part eq "0"; # THIRD COL: Problem status icon @@ -595,7 +641,6 @@ sub handler { } # FOURTH COL: Text description - #$r->print("\n"); $r->print("\n"); if ($curRes->kind() eq "res" && @@ -610,12 +655,22 @@ sub handler { } $r->print(" \n"); + + if (!($counter % 20)) { $r->rflush(); } + if ($counter == 2) { $r->rflush(); } } } $curRes = $mapIterator->next(); } - $r->print(""); + $r->print(""); + + # Print out the part that jumps to #curloc if it exists + if ($displayedJumpMarker) { + $r->print(''); + } + + $r->print(""); $navmap->untieHashes(); @@ -727,6 +782,34 @@ 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'}; } @@ -772,17 +855,18 @@ sub timeToHumanString { $delta = -$delta; } - # Is it in the future? if ( $delta > 0 ) { - # Is it less then a minute away? + my $tense = $inPast ? " ago" : ""; my $prefix = $inPast ? "" : "in "; + + # Less then a minute if ( $delta < $minute ) { if ($delta == 1) { return "${prefix}1 second$tense"; } return "$prefix$delta seconds$tense"; } - # Is it less then an hour away? + # Less then an hour if ( $delta < $hour ) { # If so, use minutes my $minutes = floor($delta / 60); @@ -876,7 +960,7 @@ sub new { $self->{GENERATE_COURSE_USER_OPT} = shift; $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift; - # Resource cache stores navmapresource's as we reference them. We generate + # Resource cache stores navmap resources as we reference them. We generate # them on-demand so we don't pay for creating resources unless we use them. $self->{RESOURCE_CACHE} = {}; @@ -890,7 +974,6 @@ sub new { &GDBM_READER(), 0640))) { return undef; } - $self->{NAV_HASH} = \%navmaphash; my %parmhash; if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, @@ -899,10 +982,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; } @@ -1016,21 +1105,27 @@ 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; } sub getIterator { my $self = shift; my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, - shift, undef, shift, - $ENV{'form.direction'}); + shift, undef, shift); return $iterator; } @@ -1103,8 +1198,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); } @@ -1116,19 +1211,13 @@ 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); } -# -------------------------------------------- Figure out a cascading parameter -# -# For this function to work -# -# * parmhash needs to be tied -# * courseopt and useropt need to be initialized for this user and course -# - +# Parmval reads the parm hash and cascades the lookups. parmval_real does +# the actual lookup; parmval caches the results. sub parmval { my $self = shift; my ($what,$symb)=@_; @@ -1230,10 +1319,6 @@ sub parmval_real { package Apache::lonnavmaps::iterator; -# This package must precede "navmap" because "navmap" uses it. In -# order to keep the documentation order straight, the iterator is documented -# after the navmap object. - =pod =back @@ -1254,9 +1339,9 @@ getIterator behaves as follows: =over 4 -=item B(firstResource, finishResource, filterHash, condition, direction): 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, which is to say, do not recurse unless explicitly asked to. Direction specifies which direction to recurse, either FORWARD or BACKWARD, with FORWARD being default. +=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, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown. +Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples. The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are: @@ -1274,6 +1359,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 @@ -1292,6 +1379,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; @@ -1319,6 +1411,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. @@ -1334,6 +1429,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]; @@ -1355,16 +1457,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}); - - if ($resourceCount == 1) { + my $nextCount = scalar(@{$nextResources}); + + 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); @@ -1372,7 +1481,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}); @@ -1384,6 +1493,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; @@ -1394,7 +1515,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; @@ -1443,8 +1564,8 @@ sub next { my $newDepth; my $here; while ( $i >= 0 && !$found ) { - if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { - $here = $self->{HERE} = shift @{$self->{STACK}->[$i]}; + if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6** + $here = pop @{$self->{STACK}->[$i]}; # **7** $found = 1; $newDepth = $i; } @@ -1462,6 +1583,18 @@ sub next { } } + # If this is not a resource, it must be an END_BRANCH marker we want + # to return directly. + if (!ref($here)) { # **8** + if ($here == END_BRANCH()) { # paranoia, in case of later extension + $self->{CURRENT_DEPTH}--; + return $here; + } + } + + # Otherwise, it is a resource and it's safe to store in $self->{HERE} + $self->{HERE} = $here; + # Get to the right level if ( $self->{CURRENT_DEPTH} > $newDepth ) { push @{$self->{STACK}->[$newDepth]}, $here; @@ -1481,14 +1614,32 @@ sub next { # So we need to look at all the resources we can get to from here, # categorize them if we haven't seen them, remember if we have a new my $nextUnfiltered = $here->getNext(); - + my $maxDepthAdded = -1; + for (@$nextUnfiltered) { if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { - push @{$self->{STACK}->[$_->{DATA}->{DISPLAY_DEPTH}]}, $_; + my $depth = $_->{DATA}->{DISPLAY_DEPTH}; + push @{$self->{STACK}->[$depth]}, $_; $self->{ALREADY_SEEN}->{$_->{ID}} = 1; + if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; } } } - + + # Is this the end of a branch? If so, all of the resources examined above + # led to lower levels then the one we are currently at, so we push a END_BRANCH + # marker onto the stack so we don't forget. + # Example: For the usual A(BC)(DE)F case, when the iterator goes down the + # 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 && $here != $self->{FINISH_RESOURCE}) { # **9** + push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); + } + # That ends the main iterator logic. Now, do we want to recurse # down this map (if this resource is a map)? if ($self->{HERE}->is_map() && @@ -1503,6 +1654,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()) { + return $self->next(); + } + return $self->{HERE}; } @@ -1549,6 +1707,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 @@ -1749,24 +1910,26 @@ 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 B -These are methods that help you retrieve metadata about the resource: +These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation. =over 4 +=item * B: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem"). + =item * B: Returns true if the resource is external. =item * B: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B instead.) =item * B: Returns the kind of the resource from the compiled nav map. -=item * B: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. +=item * B: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false. =item * B: Returns true for a map if the randompick feature is being used on the map. (?) @@ -1809,7 +1972,15 @@ sub symb { } sub title { my $self=shift; return $self->navHash("title_", 1); } sub to { my $self=shift; return $self->navHash("to_", 1); } - +sub compTitle { + my $self = shift; + my $title = $self->title(); + if (!$title) { + $title = $self->src(); + $title = substr($title, rindex($title, '/') + 1); + } + return $title; +} =pod B @@ -1826,7 +1997,7 @@ These methods are shortcuts to deciding =item * B: Returns true if the resource is a problem. -=item * B: Returns true if the resource sequence. +=item * B: Returns true if the resource is a sequence. =back @@ -1855,12 +2026,7 @@ sub is_sequence { return ($src =~ /sequence$/); } - - - - -# Move this into POD: In order to use these correctly, courseopt -# and useropt need to be generated +# Private method: Shells out to the parmval in the nav map, handler parts. sub parmval { my $self = shift; my $what = shift; @@ -1974,6 +2140,7 @@ sub answerdate { } return $self->parmval("answerdate", $part); } +sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); } sub duedate { (my $self, my $part) = @_; return $self->parmval("duedate", $part); @@ -1998,24 +2165,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); } @@ -2143,7 +2304,7 @@ sub extractParts { =head2 Resource Status -Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status. +Problem resources have status information, reflecting their various dates and completion statuses. There are two aspects to the status: the date-related information and the completion information. @@ -2160,6 +2321,10 @@ Idiomatic usage of these two methods wou ... use it here ... } +Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere. + +The symbolic constants shown below can be accessed through the resource object: $res->OPEN. + =over 4 =item * B($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are: @@ -2273,14 +2438,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;} @@ -2292,11 +2452,23 @@ 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 -Along with directly returning the date or completion status, the resource object includes a convenience function B() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()): +Along with directly returning the date or completion status, the resource object includes a convenience function B() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE): =over 4 @@ -2400,15 +2572,14 @@ sub status { =over 4 -=item * B($alreadySeenHashRef): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. The "alreadySeenHashRef" is an optional parameter that can be passed in to the method. If $$alreadySeenHashRef{$res->id()} is true in that hash, getNext will not return it in the list. In other words, you can use it to suppress resources you've already seen in the getNext method directly. +=item * B(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. -=item * B($alreadySeenHashRef): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. $alreadySeenHashRef is the same as in getNext. +=item * B(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. =cut sub getNext { my $self = shift; - my $alreadySeenHash = shift; my @branches; my $to = $self->to(); foreach my $branch ( split(/,/, $to) ) { @@ -2416,21 +2587,22 @@ sub getNext { my $next = $choice->goesto(); $next = $self->{NAV_MAP}->getById($next); - # Don't remember it if we've already seen it or if - # the student doesn't have browse priviledges - my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); - if (!defined($alreadySeenHash) || - !defined($alreadySeenHash->{$next->{ID}}) || - ($browsePriv ne '2' && $browsePriv ne 'F')) { - push @branches, $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 = $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; + } } return \@branches; } sub getPrevious { my $self = shift; - my $alreadySeenHash = shift; my @branches; my $from = $self->from(); foreach my $branch ( split /,/, $from) { @@ -2438,12 +2610,14 @@ sub getPrevious { my $prev = $choice->comesfrom(); $prev = $self->{NAV_MAP}->getById($prev); - # Skip it if we've already seen it or the user doesn't have - # browse privs - my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); - if (!defined($alreadySeenHash) || - !defined($alreadySeenHash->{$prev->{ID}}) || - ($browsePriv ne '2' && $browsePriv ne 'F')) { + # 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 = $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; } }