[BACK]Return to lonnavmaps.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.156 and 1.167

version 1.156, 2003/03/13 17:05:36 version 1.167, 2003/03/25 22:35:58
Line 42 Line 42
 # Jeremy Bowers ... lots of days  # Jeremy Bowers ... lots of days
   
 package Apache::lonnavmaps;  package Apache::lonnavmaps;
   use vars qw($test @refsToUntie %navmaphash %parmhash);
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
Line 49  use Apache::loncommon(); Line 50  use Apache::loncommon();
 use Apache::lonmenu();  use Apache::lonmenu();
 use POSIX qw (floor strftime);  use POSIX qw (floor strftime);
   
 my %navmaphash;  
 my %parmhash;  
   
 # symbolic constants  # symbolic constants
 sub SYMB { return 1; }  sub SYMB { return 1; }
 sub URL { return 2; }  sub URL { return 2; }
Line 98  my %colormap = Line 96  my %colormap =
 # And a special case in the nav map; what to do when the assignment  # 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  # is not yet done and due in less then 24 hours
 my $hurryUpColor = "#FF0000";  my $hurryUpColor = "#FF0000";
   $test = 'abc';
 sub cleanup {  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)){      if (tied(%navmaphash)){
  &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');   &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
         unless (untie(%navmaphash)) {          unless (untie(%navmaphash)) {
Line 112  sub cleanup { Line 114  sub cleanup {
     &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');      &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 {  sub handler {
Line 143  sub real_handler { Line 154  sub real_handler {
     $r->send_http_header;      $r->send_http_header;
   
     # Create the nav map      # 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"}.".db",
                         $ENV{"request.course.fn"}."_parms.db", 1, 1);                          $ENV{"request.course.fn"}."_parms.db", 1, 1);
   
Line 158  sub real_handler { Line 169  sub real_handler {
     $r->print("<title>Navigate Course Contents</title>");      $r->print("<title>Navigate Course Contents</title>");
 # ------------------------------------------------------------ Get query string  # ------------------------------------------------------------ Get query string
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);
       
 # ----------------------------------------------------- Force menu registration  # ----------------------------------------------------- Force menu registration
     my $addentries='';      my $addentries='';
     if ($ENV{'form.register'}) {      if ($ENV{'form.register'}) {
Line 177  sub real_handler { Line 189  sub real_handler {
     # Now that we've displayed some stuff to the user, init the navmap      # Now that we've displayed some stuff to the user, init the navmap
     $navmap->init();      $navmap->init();
   
   
     $r->print('<br>&nbsp;');      $r->print('<br>&nbsp;');
     $r->rflush();      $r->rflush();
   
Line 220  sub real_handler { Line 231  sub real_handler {
                           'suppressNavmap' => 1,                            'suppressNavmap' => 1,
                           'r' => $r});                            '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("</body></html>");      $r->print("</body></html>");
     $r->rflush();      $r->rflush();
Line 361  sub lastTry { Line 384  sub lastTry {
 }  }
   
 # This puts a human-readable name on the ENV variable.  # 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 {  sub advancedUser {
     return $ENV{'user.adv'};      return $ENV{'user.adv'};
 }  }
Line 538  Most of these parameters are only useful Line 567  Most of these parameters are only useful
   
 =item * B<navmap>: 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<navmap>: 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<r>: The standard Apache response object. This must be passed to the renderer or the course hash will be locked.
   
 =item * B<cols>: An array reference  =item * B<cols>: An array reference
   
 =item * B<showParts>: 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<showParts>: 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<condenseParts>: 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<condenseParts>: 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<jumpCount>: 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<jumpCount>: 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<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info.  
   
 =item * B<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL.  =item * B<here>: A Symb identifying where to place the 'here' marker. Default empty, which means no marker.
   
 =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.  =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.
   
Line 558  Most of these parameters are only useful Line 587  Most of these parameters are only useful
   
 =item * B<currentJumpIndex>: 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<currentJumpIndex>: 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<r>: 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<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.  =item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.
   
 =item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.  =item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.
Line 647  sub render_resource { Line 674  sub render_resource {
             $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='              $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
                 . $params->{'hereType'} . '&here=' .                  . $params->{'hereType'} . '&here=' .
                 &Apache::lonnet::escape($params->{'here'}) .                   &Apache::lonnet::escape($params->{'here'}) . 
                 '&jumpType=' . SYMB() . '&jump=' .                  '&jump=' .
                 &Apache::lonnet::escape($resource->symb()) .                   &Apache::lonnet::escape($resource->symb()) . 
                 "&folderManip=1'>";                  "&folderManip=1'>";
         } else {          } else {
Line 683  sub render_resource { Line 710  sub render_resource {
     my $curMarkerEnd = '';      my $curMarkerEnd = '';
   
     # Is this the current resource?      # Is this the current resource?
     if (!$params->{'displayedHereMarker'} &&      if (!$params->{'displayedHereMarker'} && 
         (($params->{'hereType'} == SYMB() &&           $resource->symb() eq $params->{'here'} ) {
           $resource->symb() eq $params->{'here'}) ||  
          ($params->{'hereType'} == URL() &&  
           $resource->src() eq $params->{'here'}))) {  
         $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';          $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';
         $curMarkerEnd = '<font color="red" size="+2">&lt;</font>';          $curMarkerEnd = '<font color="red" size="+2">&lt;</font>';
           $params->{'displayedHereMarker'} = 1;
     }      }
   
     if ($resource->is_problem() && $part ne "" &&       if ($resource->is_problem() && $part ne "" && 
Line 698  sub render_resource { Line 723  sub render_resource {
         $title = "";          $title = "";
     }      }
   
     if ($params->{'multipart'} && $params->{'condensed'}) {      if ($params->{'condensed'} && $resource->countParts() > 1) {
         $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';          $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
     }      }
   
Line 835  sub render { Line 860  sub render {
         $navmap = $args->{'navmap'};          $navmap = $args->{'navmap'};
     }      }
   
       my $r = $args->{'r'};
     my $queryString = $args->{'queryString'};      my $queryString = $args->{'queryString'};
     my $jumpToURL = $args->{'jumpToURL'};      my $jump = $args->{'jump'};
     my $jumpToSymb = $args->{'jumpToSymb'};      my $here = $args->{'here'};
     my $jumpType;  
     my $hereURL = $args->{'hereURL'};  
     my $hereSymb = $args->{'hereSymb'};  
     my $hereType;  
     my $here;  
     my $jump;  
     my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0);      
     my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);      my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
     my $currentJumpDelta = 2; # 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                               # before the current resource when using #current
Line 869  sub render { Line 888  sub render {
     if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {      if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
         # Step 1: Check to see if we have a navmap          # Step 1: Check to see if we have a navmap
         if (!defined($navmap)) {          if (!defined($navmap)) {
             $navmap = Apache::lonnavmaps::navmap->new(              $navmap = Apache::lonnavmaps::navmap->new($r, 
                         $ENV{"request.course.fn"}.".db",                          $ENV{"request.course.fn"}.".db",
                         $ENV{"request.course.fn"}."_parms.db", 1, 1);                          $ENV{"request.course.fn"}."_parms.db", 1, 1);
             $mustCloseNavMap = 1;              $mustCloseNavMap = 1;
Line 879  sub render { Line 898  sub render {
         # Step two: Locate what kind of here marker is necessary          # Step two: Locate what kind of here marker is necessary
         # Determine where the "here" marker is and where the screen jumps to.          # 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'}) {          if ($ENV{'form.symb'}) {
             $hereType = $jumpType = SYMB();  
             $here = $jump = $ENV{'form.symb'};              $here = $jump = $ENV{'form.symb'};
         } elsif ($ENV{'form.postdata'}) {          } elsif ($ENV{'form.postdata'}) {
             # couldn't find a symb, is there a URL?              # couldn't find a symb, is there a URL?
             my $currenturl = $ENV{'form.postdata'};              my $currenturl = $ENV{'form.postdata'};
             $currenturl=~s/^http\:\/\///;              #$currenturl=~s/^http\:\/\///;
             $currenturl=~s/^[^\/]+//;              #$currenturl=~s/^[^\/]+//;
                           
             $hereType = $jumpType = URL;              $here = $jump = &Apache::lonnet::symbread($currenturl);
             $here = $jump = $currenturl;  
         } else {  
             # Nothing  
             $hereType = $jumpType = NOTHING();  
         }          }
   
         # Step three: Ensure the folders are open          # Step three: Ensure the folders are open
         my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);          my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
         my $depth = 1;          my $depth = 1;
         $mapIterator->next(); # discard the first BEGIN_MAP          $mapIterator->next(); # discard the first BEGIN_MAP
         my $curRes = $mapIterator->next();          my $curRes = $mapIterator->next();
         my $counter = 0;  
         my $found = 0;          my $found = 0;
                   
         # We only need to do this if we need to open the maps to show the          # We only need to do this if we need to open the maps to show the
Line 913  sub render { Line 923  sub render {
             if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }              if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
             if ($curRes == $mapIterator->END_MAP()) { $depth--; }              if ($curRes == $mapIterator->END_MAP()) { $depth--; }
                           
             if (ref($curRes) &&               if (ref($curRes) && $curRes->symb() eq $here) {
                 ($hereType == SYMB() && $curRes->symb() eq $here) ||  
                 (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {  
                 my $mapStack = $mapIterator->getStack();                  my $mapStack = $mapIterator->getStack();
                                   
                 # Ensure the parent maps are open                  # Ensure the parent maps are open
Line 931  sub render { Line 939  sub render {
                           
             $curRes = $mapIterator->next();              $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 ( !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"          # 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          # from the querystring, and get the new "jump" marker
         $hereType = $ENV{'form.hereType'};  
         $here = $ENV{'form.here'};          $here = $ENV{'form.here'};
         $jumpType = $ENV{'form.jumpType'} || NOTHING();  
         $jump = $ENV{'form.jump'};          $jump = $ENV{'form.jump'};
     }       } 
           
Line 974  sub render { Line 954  sub render {
                   
         # Step 1: Check to see if we have a navmap          # Step 1: Check to see if we have a navmap
         if (!defined($navmap)) {          if (!defined($navmap)) {
             $navmap = Apache::lonnavmaps::navmap->new(              $navmap = Apache::lonnavmaps::navmap->new($r, 
                         $ENV{"request.course.fn"}.".db",                          $ENV{"request.course.fn"}.".db",
                         $ENV{"request.course.fn"}."_parms.db", 1, 1);                          $ENV{"request.course.fn"}."_parms.db", 1, 1);
             $mustCloseNavMap = 1;              $mustCloseNavMap = 1;
Line 995  sub render { Line 975  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 $showParts = setDefault($args->{'showParts'}, 1);
     my $condenseParts = setDefault($args->{'condenseParts'}, 1);      my $condenseParts = setDefault($args->{'condenseParts'}, 1);
     # keeps track of when the current resource is found,      # keeps track of when the current resource is found,
     # so we can back up a few and put the anchor above the      # so we can back up a few and put the anchor above the
     # current resource      # current resource
     my $r = $args->{'r'};  
     my $printKey = $args->{'printKey'};      my $printKey = $args->{'printKey'};
     my $printCloseAll = $args->{'printCloseAll'};      my $printCloseAll = $args->{'printCloseAll'};
     if (!defined($printCloseAll)) { $printCloseAll = 1; }      if (!defined($printCloseAll)) { $printCloseAll = 1; }
Line 1032  sub render { Line 1036  sub render {
     if ($printCloseAll) {      if ($printCloseAll) {
         if ($condition) {          if ($condition) {
             $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .              $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
                 "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .                  "&here=" . Apache::lonnet::escape($here) .
                 "\">Close All Folders</a>";                  "\">Close All Folders</a>";
         } else {          } else {
             $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .              $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
                 "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .                   "&here=" . Apache::lonnet::escape($here) . 
                 "\">Open All Folders</a>";                  "\">Open All Folders</a>";
         }          }
         $result .= "<br /><br />\n";          $result .= "<br /><br />\n";
Line 1068  sub render { Line 1072  sub render {
   
     my $displayedJumpMarker = 0;      my $displayedJumpMarker = 0;
     # Set up iteration.      # Set up iteration.
     my $depth = 1;      $depth = 1;
     $it->next(); # discard initial BEGIN_MAP      $it->next(); # discard initial BEGIN_MAP
     my $curRes = $it->next();      $curRes = $it->next();
     my $now = time();      my $now = time();
     my $in24Hours = $now + 24 * 60 * 60;      my $in24Hours = $now + 24 * 60 * 60;
     my $rownum = 0;      my $rownum = 0;
   
     # export "here" marker information      # export "here" marker information
     $args->{'here'} = $here;      $args->{'here'} = $here;
     $args->{'hereType'} = $hereType;  
   
     while ($depth > 0) {      while ($depth > 0) {
         if ($curRes == $it->BEGIN_MAP()) { $depth++; }          if ($curRes == $it->BEGIN_MAP()) { $depth++; }
Line 1099  sub render { Line 1102  sub render {
   
         # If this isn't an actual resource, continue on          # If this isn't an actual resource, continue on
         if (!ref($curRes)) {          if (!ref($curRes)) {
             $curRes = $it->next();  
             next;              next;
         }          }
   
Line 1128  sub render { Line 1130  sub render {
                           
             if ($condenseParts) { # do the condensation              if ($condenseParts) { # do the condensation
                 if (!$curRes->opendate("0")) {                  if (!$curRes->opendate("0")) {
                     @parts = ("0");                      @parts = ();
                     $args->{'condensed'} = 1;                      $args->{'condensed'} = 1;
                 }                  }
                 if (!$args->{'condensed'}) {                  if (!$args->{'condensed'}) {
Line 1160  sub render { Line 1162  sub render {
                     if (($statusAllSame && defined($condenseStatuses{$status})) ||                      if (($statusAllSame && defined($condenseStatuses{$status})) ||
                         ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||                          ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
                         ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){                          ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
                         @parts = ($parts[1]);                          @parts = ();
                         $args->{'condensed'} = 1;                          $args->{'condensed'} = 1;
                     }                      }
                                           
                 }                  }
             }              }
         }          } 
                           
         # If the multipart problem was condensed, "forget" it was multipart          # If the multipart problem was condensed, "forget" it was multipart
         if (scalar(@parts) == 1) {          if (scalar(@parts) == 1) {
Line 1229  sub render { Line 1231  sub render {
     }      }
           
     # Print out the part that jumps to #curloc if it exists      # 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) {      if ($displayedJumpMarker) {
         $result .= "<script>location += \"#curloc\";</script>\n";          $result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n";
     }      }
   
     $result .= "</table>";      $result .= "</table>";
Line 1241  sub render { Line 1249  sub render {
         $r->rflush();          $r->rflush();
     }      }
                   
     if ($mustCloseNavMap) { $navmap->untieHashes(); }       #if ($mustCloseNavMap) { $navmap->untieHashes(); } 
   
     return $result;      return $result;
 }  }
Line 1266  You must obtain resource objects through Line 1274  You must obtain resource objects through
   
 =over 4  =over 4
   
 =item * B<new>(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<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.  =item * B<new>(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<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
   
 =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.  =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
   
Line 1281  sub new { Line 1289  sub new {
     my $class = ref($proto) || $proto;      my $class = ref($proto) || $proto;
     my $self = {};      my $self = {};
   
       $self->{RESPONSE} = shift;
     $self->{NAV_HASH_FILE} = shift;      $self->{NAV_HASH_FILE} = shift;
     $self->{PARM_HASH_FILE} = shift;      $self->{PARM_HASH_FILE} = shift;
     $self->{GENERATE_COURSE_USER_OPT} = shift;      $self->{GENERATE_COURSE_USER_OPT} = shift;
Line 1296  sub new { Line 1305  sub new {
   
     # tie the nav hash      # 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))) {                &GDBM_READER(), 0640))) {
         return undef;          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)))                &GDBM_READER(), 0640)))
     {      {
         untie $self->{PARM_HASH};          untie $self->{PARM_HASH};
         return undef;          return undef;
     }      }
   
     $self->{HASH_TIED} = 1;      $self->{NAV_HASH} = \%Apache::lonnavmaps::navmaphash;
     $self->{NAV_HASH} = \%navmaphash;      $self->{PARM_HASH} = \%Apache::lonnavmaps::parmhash;
     $self->{PARM_HASH} = \%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->{INITED} = 0;
   
       $self->{RESPONSE}->register_cleanup(\&Apache::lonnavmaps::cleanup);
       Apache::lonnet::logthis("Pushed cleanup.");
   
     bless($self);      bless($self);
                   
     return $self;      return $self;
Line 1455  sub getIterator { Line 1472  sub getIterator {
   
 # unties the hash when done  # unties the hash when done
 sub untieHashes {  sub untieHashes {
     my $self = shift;  #    my $self = shift;
     untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});  #    untie $self->{NAV_HASH};
     untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});  #    untie $self->{PARM_HASH};
     $self->{HASH_TIED} = 0;  #    &Apache::lonnavmaps::cleanup();
 }  }
   
 # when the object is destroyed, be sure to untie all the hashes we tied.  # when the object is destroyed, be sure to untie all the hashes we tied.
 sub DESTROY {  #sub DESTROY {
     my $self = shift;  #    my $self = shift;
     $self->untieHashes();  #    $self->untieHashes();
 }  #}
   
 # Private method: 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.  # current discussion? Returns 0 if chat/mail data not extracted.
Line 1638  sub parmval_real { Line 1655  sub parmval_real {
     my ($space,@qualifier)=split(/\./,$rwhat);      my ($space,@qualifier)=split(/\./,$rwhat);
     my $qualifier=join('.',@qualifier);      my $qualifier=join('.',@qualifier);
     unless ($space eq '0') {      unless ($space eq '0') {
         my ($part,$id)=split(/\_/,$space);   my @parts=split(/_/,$space);
         if ($id) {   my $id=pop(@parts);
             my $partgeneral=$self->parmval($part.".$qualifier",$symb);   my $part=join('_',@parts);
             if (defined($partgeneral)) { return $partgeneral; }   if ($part eq '') { $part='0'; }
         } else {   my $partgeneral=$self->parmval($part.".$qualifier",$symb);
             my $resourcegeneral=$self->parmval("0.$qualifier",$symb);   if (defined($partgeneral)) { return $partgeneral; }
             if (defined($resourcegeneral)) { return $resourcegeneral; }  
         }  
     }      }
     return '';      return '';
 }  }
Line 1774  getIterator behaves as follows: Line 1789  getIterator behaves as follows:
   
 =over 4  =over 4
   
 =item * B<getIterator>(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<getIterator>(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.  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.
   
Line 1849  sub new { Line 1864  sub new {
     # Do we want to automatically follow "redirection" maps?      # Do we want to automatically follow "redirection" maps?
     $self->{FORCE_TOP} = shift;      $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      # 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.      # over the parts of the map we're going to look at.
   
Line 1962  sub new { Line 1982  sub new {
 sub next {  sub next {
     my $self = shift;      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}) {      if ($self->{RECURSIVE_ITERATOR_FLAG}) {
         # grab the next from the recursive iterator           # grab the next from the recursive iterator 
         my $next = $self->{RECURSIVE_ITERATOR}->next();          my $next = $self->{RECURSIVE_ITERATOR}->next();
Line 2703  sub countParts { Line 2730  sub countParts {
     my $self = shift;      my $self = shift;
           
     my $parts = $self->parts();      my $parts = $self->parts();
       my $delta = 0;
       for my $part (@$parts) {
           if ($part eq '0') { $delta--; }
       }
   
     if ($self->{RESOURCE_ERROR}) {      if ($self->{RESOURCE_ERROR}) {
         return 0;          return 0;
     }      }
   
     if (scalar(@{$parts}) < 2) { return 1;}      return scalar(@{$parts}) + $delta;
   
     return scalar(@{$parts}) - 1;  
 }  }
   
 # Private function: Extracts the parts information and saves it  # Private function: Extracts the parts information and saves it
Removed from v.1.156  
changed lines
  Added in v.1.167

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>