--- loncom/interface/lonnavmaps.pm 2003/03/13 17:10:25 1.157 +++ loncom/interface/lonnavmaps.pm 2003/03/23 07:12:41 1.166 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.157 2003/03/13 17:10:25 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.166 2003/03/23 07:12:41 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -42,6 +42,7 @@ # Jeremy Bowers ... lots of days package Apache::lonnavmaps; +use vars qw($test @refsToUntie %navmaphash %parmhash); use strict; use Apache::Constants qw(:common :http); @@ -49,9 +50,6 @@ use Apache::loncommon(); use Apache::lonmenu(); use POSIX qw (floor strftime); -my %navmaphash; -my %parmhash; - # symbolic constants sub SYMB { return 1; } sub URL { return 2; } @@ -98,8 +96,12 @@ my %colormap = # 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"; - +$test = 'abc'; sub cleanup { + &Apache::lonnet::logthis("Cleanup called."); + &Apache::lonnet::logthis("refs size".scalar(@refsToUntie)); + &Apache::lonnet::logthis("test is ".$test); + $test = '467'; if (tied(%navmaphash)){ &Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); unless (untie(%navmaphash)) { @@ -112,6 +114,15 @@ sub cleanup { &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); } } + # Apparently, if you take a reference to a tied hash, both the + # original hash and the tied hash must be untied. Bleh. + for my $ref (@refsToUntie) { + &Apache::lonnet::logthis('Cleanup navmaps: reference'); + unless (untie($ref)) { + &Apache::lonnet::logthis('Failed cleanup navmaps: reference'); + } + } + @refsToUntie = (); } sub handler { @@ -143,7 +154,7 @@ sub real_handler { $r->send_http_header; # Create the nav map - my $navmap = Apache::lonnavmaps::navmap->new( + my $navmap = Apache::lonnavmaps::navmap->new($r, $ENV{"request.course.fn"}.".db", $ENV{"request.course.fn"}."_parms.db", 1, 1); @@ -158,6 +169,7 @@ sub real_handler { $r->print("Navigate Course Contents"); # ------------------------------------------------------------ Get query string &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); + # ----------------------------------------------------- Force menu registration my $addentries=''; if ($ENV{'form.register'}) { @@ -177,7 +189,6 @@ sub real_handler { # Now that we've displayed some stuff to the user, init the navmap $navmap->init(); - $r->print('
 '); $r->rflush(); @@ -220,7 +231,19 @@ sub real_handler { 'suppressNavmap' => 1, 'r' => $r}); - $navmap->untieHashes(); + #$navmap->untieHashes(); + + if (tied(%navmaphash)) { + $r->print("Dang it."); + } else { + $r->print("It's out."); + } + + if (tied(%parmhash)) { + $r->print("Dang it."); + } else { + $r->print("It's out."); + } $r->print(""); $r->rflush(); @@ -361,6 +384,12 @@ sub lastTry { } # This puts a human-readable name on the ENV variable. +# FIXME: This needs better logic: Who gets the advanced view of navmaps? +# As of 3-13-03, it's an open question. Guy doesn't want to check +# roles directly because it should be a check of capabilities for future +# role compatibity. There is no capability that matches this one for +# now, so this is done. (A hack for 1.0 might be to simply check roles +# anyhow.) sub advancedUser { return $ENV{'user.adv'}; } @@ -538,17 +567,17 @@ Most of these parameters are only useful =item * B: A reference to a navmap, used only if an iterator is not passed in. If this is necessary to make an iterator but it is not passed in, a new one will be constructed based on ENV info. This is useful to do basic error checking before passing it off to render. +=item * B: The standard Apache response object. This must be passed to the renderer or the course hash will be locked. + =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. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information. - -=item * B: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info. +=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. By default, determined through the use of the ENV{} 'jump' information, and should normally "just work" correctly. -=item * B: A Symb identifying where to place the 'here' marker. Default same as hereURL. +=item * B: A Symb identifying where to place the 'here' marker. Default empty, which means no marker. =item * B: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. @@ -558,8 +587,6 @@ Most of these parameters are only useful =item * B: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}. -=item * B: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself. - =item * B: If true, print the key that appears on the top of the standard navmaps. Default is false. =item * B: If true, print the "Close all folders" or "open all folders" links. Default is true. @@ -647,7 +674,7 @@ sub render_resource { $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' . $params->{'hereType'} . '&here=' . &Apache::lonnet::escape($params->{'here'}) . - '&jumpType=' . SYMB() . '&jump=' . + '&jump=' . &Apache::lonnet::escape($resource->symb()) . "&folderManip=1'>"; } else { @@ -683,13 +710,11 @@ sub render_resource { 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'}))) { + if (!$params->{'displayedHereMarker'} && + $resource->symb() eq $params->{'here'} ) { $curMarkerBegin = '> '; $curMarkerEnd = '<'; + $params->{'displayedHereMarker'} = 1; } if ($resource->is_problem() && $part ne "" && @@ -698,7 +723,7 @@ sub render_resource { $title = ""; } - if ($params->{'multipart'} && $params->{'condensed'}) { + if ($params->{'condensed'} && $resource->countParts() > 1) { $nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; } @@ -835,16 +860,10 @@ sub render { $navmap = $args->{'navmap'}; } + my $r = $args->{'r'}; my $queryString = $args->{'queryString'}; - my $jumpToURL = $args->{'jumpToURL'}; - my $jumpToSymb = $args->{'jumpToSymb'}; - my $jumpType; - my $hereURL = $args->{'hereURL'}; - my $hereSymb = $args->{'hereSymb'}; - my $hereType; - my $here; - my $jump; - my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0); + my $jump = $args->{'jump'}; + my $here = $args->{'here'}; my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0); my $currentJumpDelta = 2; # change this to change how many resources are displayed # before the current resource when using #current @@ -869,7 +888,7 @@ sub render { if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) { # Step 1: Check to see if we have a navmap if (!defined($navmap)) { - $navmap = Apache::lonnavmaps::navmap->new( + $navmap = Apache::lonnavmaps::navmap->new($r, $ENV{"request.course.fn"}.".db", $ENV{"request.course.fn"}."_parms.db", 1, 1); $mustCloseNavMap = 1; @@ -879,31 +898,22 @@ sub render { # Step two: Locate what kind of here marker is necessary # Determine where the "here" marker is and where the screen jumps to. - # We're coming from the remote. We have either a url, a symb, or nothing, - # and we need to figure out what. - # Preference: Symb - if ($ENV{'form.symb'}) { - $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/^[^\/]+//; + #$currenturl=~s/^http\:\/\///; + #$currenturl=~s/^[^\/]+//; - $hereType = $jumpType = URL; - $here = $jump = $currenturl; - } else { - # Nothing - $hereType = $jumpType = NOTHING(); + $here = $jump = &Apache::lonnet::symbread($currenturl); } + # Step three: Ensure the folders are open my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); my $depth = 1; $mapIterator->next(); # discard the first BEGIN_MAP my $curRes = $mapIterator->next(); - my $counter = 0; my $found = 0; # We only need to do this if we need to open the maps to show the @@ -913,9 +923,7 @@ sub render { if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } if ($curRes == $mapIterator->END_MAP()) { $depth--; } - if (ref($curRes) && - ($hereType == SYMB() && $curRes->symb() eq $here) || - (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) { + if (ref($curRes) && $curRes->symb() eq $here) { my $mapStack = $mapIterator->getStack(); # Ensure the parent maps are open @@ -931,40 +939,12 @@ sub render { $curRes = $mapIterator->next(); } - - # Since we changed the folders, (re-)locate the jump point, if any - $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); - $depth = 1; - $mapIterator->next(); - $curRes = $mapIterator->next(); - my $foundJump = 0; - - while ($depth > 0 && !$foundJump) { - if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } - if ($curRes == $mapIterator->END_MAP()) { $depth--; } - if (ref($curRes)) { $counter++; } - - if (ref($curRes) && - (($jumpType == SYMB() && $curRes->symb() eq $jump) || - ($jumpType == URL() && $curRes->src() eq $jump))) { - - # This is why we have to use the main iterator instead of the - # potentially faster DFS: The count has to be the same, so - # the order has to be the same, which DFS won't give us. - $currentJumpIndex = $counter; - $foundJump = 1; - } - - $curRes = $mapIterator->next(); - } - } + if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page # If 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'}; } @@ -974,7 +954,7 @@ sub render { # Step 1: Check to see if we have a navmap if (!defined($navmap)) { - $navmap = Apache::lonnavmaps::navmap->new( + $navmap = Apache::lonnavmaps::navmap->new($r, $ENV{"request.course.fn"}.".db", $ENV{"request.course.fn"}."_parms.db", 1, 1); $mustCloseNavMap = 1; @@ -995,12 +975,36 @@ sub render { } } + # (re-)Locate the jump point, if any + my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); + my $depth = 1; + $mapIterator->next(); + my $curRes = $mapIterator->next(); + my $foundJump = 0; + my $counter = 0; + + while ($depth > 0 && !$foundJump) { + if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } + if ($curRes == $mapIterator->END_MAP()) { $depth--; } + if (ref($curRes)) { $counter++; } + + if (ref($curRes) && $jump eq $curRes->symb()) { + + # This is why we have to use the main iterator instead of the + # potentially faster DFS: The count has to be the same, so + # the order has to be the same, which DFS won't give us. + $args->{'currentJumpIndex'} = $counter; + $foundJump = 1; + } + + $curRes = $mapIterator->next(); + } + my $showParts = setDefault($args->{'showParts'}, 1); my $condenseParts = setDefault($args->{'condenseParts'}, 1); # 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 $r = $args->{'r'}; my $printKey = $args->{'printKey'}; my $printCloseAll = $args->{'printCloseAll'}; if (!defined($printCloseAll)) { $printCloseAll = 1; } @@ -1032,11 +1036,11 @@ sub render { if ($printCloseAll) { if ($condition) { $result.="Close All Folders"; } else { $result.="Open All Folders"; } $result .= "

\n"; @@ -1068,16 +1072,15 @@ sub render { my $displayedJumpMarker = 0; # Set up iteration. - my $depth = 1; + $depth = 1; $it->next(); # discard initial BEGIN_MAP - my $curRes = $it->next(); + $curRes = $it->next(); my $now = time(); my $in24Hours = $now + 24 * 60 * 60; my $rownum = 0; # export "here" marker information $args->{'here'} = $here; - $args->{'hereType'} = $hereType; while ($depth > 0) { if ($curRes == $it->BEGIN_MAP()) { $depth++; } @@ -1127,7 +1130,7 @@ sub render { if ($condenseParts) { # do the condensation if (!$curRes->opendate("0")) { - @parts = ("0"); + @parts = (); $args->{'condensed'} = 1; } if (!$args->{'condensed'}) { @@ -1159,7 +1162,7 @@ sub render { if (($statusAllSame && defined($condenseStatuses{$status})) || ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ - @parts = ($parts[1]); + @parts = (); $args->{'condensed'} = 1; } @@ -1228,8 +1231,14 @@ sub render { } # Print out the part that jumps to #curloc if it exists + # delay needed because the browser is processing the jump before + # it finishes rendering, so it goes to the wrong place! + # onload might be better, but this routine has no access to that. + # On mozilla, the 0-millisecond timeout seems to prevent this; + # it's quite likely this might fix other browsers, too, and + # certainly won't hurt anything. if ($displayedJumpMarker) { - $result .= "\n"; + $result .= "\n"; } $result .= ""; @@ -1240,7 +1249,7 @@ sub render { $r->rflush(); } - if ($mustCloseNavMap) { $navmap->untieHashes(); } + #if ($mustCloseNavMap) { $navmap->untieHashes(); } return $result; } @@ -1265,7 +1274,7 @@ You must obtain resource objects through =over 4 -=item * B(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B if not. You must check for undef; errors will occur when you try to use the other methods otherwise. +=item * B(responseObject, navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. responseObject is the Apache response object (typically $r). genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B if not. You must check for undef; errors will occur when you try to use the other methods otherwise. =item * B(first, finish, filter, condition): See iterator documentation below. @@ -1280,6 +1289,7 @@ sub new { my $class = ref($proto) || $proto; my $self = {}; + $self->{RESPONSE} = shift; $self->{NAV_HASH_FILE} = shift; $self->{PARM_HASH_FILE} = shift; $self->{GENERATE_COURSE_USER_OPT} = shift; @@ -1295,23 +1305,31 @@ sub new { # tie the nav hash - if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, + if (!(tie(%Apache::lonnavmaps::navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, &GDBM_READER(), 0640))) { return undef; } - if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, + if (!(tie(%Apache::lonnavmaps::parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, &GDBM_READER(), 0640))) { untie $self->{PARM_HASH}; return undef; } - $self->{HASH_TIED} = 1; - $self->{NAV_HASH} = \%navmaphash; - $self->{PARM_HASH} = \%parmhash; + $self->{NAV_HASH} = \%Apache::lonnavmaps::navmaphash; + $self->{PARM_HASH} = \%Apache::lonnavmaps::parmhash; + push @Apache::lonnavmaps::refsToUntie, $self->{NAV_HASH}; + push @Apache::lonnavmaps::refsToUntie, $self->{PARM_HASH}; + &Apache::lonnet::logthis("refstountie ".scalar(@Apache::lonnavmaps::refsToUntie)); + &Apache::lonnet::logthis("navmaps test".$Apache::lonnavmaps::test); + $Apache::lonnavmaps::test = '123'; + &Apache::lonnet::logthis("navmaps test".$Apache::lonnavmaps::test); $self->{INITED} = 0; + $self->{RESPONSE}->register_cleanup(\&Apache::lonnavmaps::cleanup); + Apache::lonnet::logthis("Pushed cleanup."); + bless($self); return $self; @@ -1454,17 +1472,17 @@ sub getIterator { # unties the hash when done sub untieHashes { - my $self = shift; - untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED}); - untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED}); - $self->{HASH_TIED} = 0; +# my $self = shift; +# untie $self->{NAV_HASH}; +# untie $self->{PARM_HASH}; +# &Apache::lonnavmaps::cleanup(); } # when the object is destroyed, be sure to untie all the hashes we tied. -sub DESTROY { - my $self = shift; - $self->untieHashes(); -} +#sub DESTROY { +# my $self = shift; +# $self->untieHashes(); +#} # Private method: Does the given resource (as a symb string) have # current discussion? Returns 0 if chat/mail data not extracted. @@ -1637,14 +1655,12 @@ sub parmval_real { my ($space,@qualifier)=split(/\./,$rwhat); my $qualifier=join('.',@qualifier); unless ($space eq '0') { - my ($part,$id)=split(/\_/,$space); - if ($id) { - my $partgeneral=$self->parmval($part.".$qualifier",$symb); - if (defined($partgeneral)) { return $partgeneral; } - } else { - my $resourcegeneral=$self->parmval("0.$qualifier",$symb); - if (defined($resourcegeneral)) { return $resourcegeneral; } - } + my @parts=split(/_/,$space); + my $id=pop(@parts); + my $part=join('_',@parts); + if ($part eq '') { $part='0'; } + my $partgeneral=$self->parmval($part.".$qualifier",$symb); + if (defined($partgeneral)) { return $partgeneral; } } return ''; } @@ -1773,7 +1789,7 @@ getIterator behaves as follows: =over 4 -=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. +=item * B(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content. returnTopMap, if true (default false), will cause the iterator to return the top-level map object (resource 0.0) before anything else. Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples. @@ -1848,6 +1864,11 @@ sub new { # Do we want to automatically follow "redirection" maps? $self->{FORCE_TOP} = shift; + # Do we want to return the top-level map object (resource 0.0)? + $self->{RETURN_0} = shift; + # have we done that yet? + $self->{HAVE_RETURNED_0} = 0; + # Now, we need to pre-process the map, by walking forward and backward # over the parts of the map we're going to look at. @@ -1961,6 +1982,13 @@ sub new { sub next { my $self = shift; + # If we want to return the top-level map object, and haven't yet, + # do so. + if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) { + $self->{HAVE_RETURNED_0} = 1; + return $self->{NAV_MAP}->getById('0.0'); + } + if ($self->{RECURSIVE_ITERATOR_FLAG}) { # grab the next from the recursive iterator my $next = $self->{RECURSIVE_ITERATOR}->next(); @@ -2702,14 +2730,16 @@ sub countParts { my $self = shift; my $parts = $self->parts(); + my $delta = 0; + for my $part (@$parts) { + if ($part eq '0') { $delta--; } + } if ($self->{RESOURCE_ERROR}) { return 0; } - if (scalar(@{$parts}) < 2) { return 1;} - - return scalar(@{$parts}) - 1; + return scalar(@{$parts}) + $delta; } # Private function: Extracts the parts information and saves it