--- loncom/interface/lonnavmaps.pm 2002/11/26 16:25:36 1.116 +++ loncom/interface/lonnavmaps.pm 2003/01/14 18:47:50 1.130 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.116 2002/11/26 16:25:36 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.130 2003/01/14 18:47:50 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -46,8 +46,31 @@ use Apache::Constants qw(:common :http); use Apache::loncommon(); use POSIX qw (floor strftime); +my %navmaphash; +my %parmhash; + +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}); @@ -84,13 +107,18 @@ sub handler { } $r->print("\n"); - $r->print("Navigate Course Contents"); + $r->print("Navigate Course Contents"); # Header $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(''); @@ -116,30 +144,63 @@ sub handler { $condition = 1; } - my $currenturl = $ENV{'form.postdata'}; - $currenturl=~s/^http\:\/\///; - $currenturl=~s/^[^\/]+//; + # 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 = "postdata=" . &Apache::lonnet::escape($currenturl) . - "&alreadyHere=1"; + 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.' . @@ -219,37 +280,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; + 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 + # 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}) { @@ -261,7 +316,35 @@ sub handler { } $ENV{'form.alreadyHere'} = 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(); } @@ -273,6 +356,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 @@ -287,11 +371,6 @@ 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 ($curRes == $mapIterator->BEGIN_MAP() || $curRes == $mapIterator->BEGIN_BRANCH()) { @@ -427,6 +506,10 @@ sub handler { '"'; my $title = $curRes->compTitle(); + if ($src=~/^\/uploaded\//) { + $nonLinkedText=$title; + $title=''; + } my $partLabel = ""; my $newBranchText = ""; @@ -461,7 +544,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 = ""; } @@ -492,8 +578,9 @@ sub handler { $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 . @@ -551,7 +640,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 @@ -596,10 +697,17 @@ sub handler { $curRes = $mapIterator->next(); } - $r->print("
Key:  
\n"); # Print the anchor if necessary - if ($counter == $currentUrlIndex - $currentUrlDelta) { - $r->print(''); + if ($counter == $currentJumpIndex - $currentJumpDelta ) { + $r->print(''); + $displayedJumpMarker = 1; } # print indentation @@ -507,8 +594,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; } @@ -523,15 +612,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(''); + } $navmap->untieHashes(); + $r->print(""); + return OK; } @@ -895,13 +1003,12 @@ 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; } - my %parmhash; if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, &GDBM_READER(), 0640))) { @@ -909,15 +1016,11 @@ sub new { return undef; } - # 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; + $self->{HASH_TIED} = 1; + $self->{NAV_HASH} = \%navmaphash; + $self->{PARM_HASH} = \%parmhash; bless($self); - $self->untieHashes(); return $self; } @@ -988,7 +1091,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); @@ -1069,18 +1172,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 { @@ -1092,6 +1196,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. @@ -1384,7 +1497,12 @@ sub new { if (ref($curRes)) { # If there's only one resource, this will save it - if($direction == FORWARD) { $resource = $curRes; $resourceCount++; } + # 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 $nextCount = scalar(@{$nextResources}); @@ -1576,6 +1694,8 @@ sub next { } # 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(); } @@ -1626,6 +1746,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 @@ -1763,11 +1886,6 @@ sub next { $self->{CONDITION}, $self->{DIRECTION}); } - # If this is a blank resource, ignore it. - if (!$self->{HERE}->src()) { - return $self->next(); - } - return $self->{HERE}; } @@ -2152,7 +2270,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