--- loncom/interface/lonnavmaps.pm 2003/03/20 17:19:29 1.161 +++ loncom/interface/lonnavmaps.pm 2003/03/28 18:14:59 1.168 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.161 2003/03/20 17:19:29 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.168 2003/03/28 18:14:59 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -49,9 +49,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; } @@ -99,21 +96,6 @@ my %colormap = # is not yet done and due in less then 24 hours my $hurryUpColor = "#FF0000"; -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); @@ -544,6 +526,8 @@ 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. @@ -562,8 +546,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. @@ -700,7 +682,7 @@ sub render_resource { $title = ""; } - if ($params->{'multipart'} && $params->{'condensed'}) { + if ($params->{'condensed'} && $resource->countParts() > 1) { $nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; } @@ -865,7 +847,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; @@ -931,7 +913,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; @@ -1107,7 +1089,7 @@ sub render { if ($condenseParts) { # do the condensation if (!$curRes->opendate("0")) { - @parts = ("0"); + @parts = (); $args->{'condensed'} = 1; } if (!$args->{'condensed'}) { @@ -1226,7 +1208,7 @@ sub render { $r->rflush(); } - if ($mustCloseNavMap) { $navmap->untieHashes(); } + #if ($mustCloseNavMap) { $navmap->untieHashes(); } return $result; } @@ -1251,7 +1233,16 @@ 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(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(first, finish, filter, condition): See iterator documentation below. @@ -1281,6 +1272,8 @@ sub new { # tie the nav hash + my %navmaphash; + my %parmhash; if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, &GDBM_READER(), 0640))) { return undef; @@ -1293,7 +1286,6 @@ sub new { return undef; } - $self->{HASH_TIED} = 1; $self->{NAV_HASH} = \%navmaphash; $self->{PARM_HASH} = \%parmhash; $self->{INITED} = 0; @@ -1441,15 +1433,8 @@ 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; -} - -# when the object is destroyed, be sure to untie all the hashes we tied. -sub DESTROY { - my $self = shift; - $self->untieHashes(); + untie $self->{NAV_HASH}; + untie $self->{PARM_HASH}; } # Private method: Does the given resource (as a symb string) have @@ -1757,7 +1742,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. @@ -1832,6 +1817,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. @@ -1945,6 +1935,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(); @@ -2686,14 +2683,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