Diff for /loncom/interface/lonnavmaps.pm between versions 1.114 and 1.130

version 1.114, 2002/11/18 21:12:39 version 1.130, 2003/01/14 18:47:50
Line 46  use Apache::Constants qw(:common :http); Line 46  use Apache::Constants qw(:common :http);
 use Apache::loncommon();  use Apache::loncommon();
 use POSIX qw (floor strftime);  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 {  sub handler {
     my $r = shift;      my $r = shift;
       real_handler($r);
   }
   
   sub real_handler {
       my $r = shift;
   
     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});      &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
   
Line 84  sub handler { Line 107  sub handler {
     }      }
   
     $r->print("<html><head>\n");      $r->print("<html><head>\n");
     $r->print("<title>Navigate Course Contents</title>");      $r->print("<title>Navigate Course Contents</title></head>");
   
     # Header      # Header
     $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',      $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',
                                           ''));                                            ''));
     $r->print('<script>window.focus();</script>');      $r->print('<script>window.focus();</script>');
   
       $r->rflush();
   
       # Now that we've displayed some stuff to the user, init the navmap
       $navmap->init();
   
     $r->print('<table border="0" cellpadding="2" cellspacing="0">');      $r->print('<table border="0" cellpadding="2" cellspacing="0">');
     my $date=localtime;      my $date=localtime;
     $r->print('<tr><td align="right" valign="bottom">Key:&nbsp;&nbsp;</td>');      $r->print('<tr><td align="right" valign="bottom">Key:&nbsp;&nbsp;</td>');
Line 116  sub handler { Line 144  sub handler {
         $condition = 1;          $condition = 1;
     }      }
   
     my $currenturl = $ENV{'form.postdata'};      # Determine where the "here" marker is and where the screen jumps to.
     $currenturl=~s/^http\:\/\///;      my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants
     $currenturl=~s/^[^\/]+//;      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      # alreadyHere allows us to only open the maps necessary to view
     # the current location once, while at the same time remembering      # the current location once, while at the same time remembering
     # the current location. Without that check, the user would never      # the current location. Without that check, the user would never
     # be able to close those maps; the user would close it, and the      # be able to close those maps; the user would close it, and the
     # currenturl scan would re-open it.      # currenturl scan would re-open it.
     my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .      my $queryAdd = "&alreadyHere=1";
         "&alreadyHere=1";  
   
     if ($condition) {      if ($condition) {
         $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd\">Close All Folders</a>");          $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" .
                     "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
                     "\">Close All Folders</a>");
     } else {      } else {
         $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd\">Open All Folders</a>");          $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" .
                     "&hereType=$hereType&here=" . Apache::lonnet::escape($here) . 
                     "\">Open All Folders</a>");
     }      }
   
     $r->print('<br>&nbsp;');      $r->print('<br>&nbsp;');
     $r->rflush();      $r->rflush();
   
     # Now that we've displayed some stuff to the user, init the navmap  
     $navmap->init();  
   
     # Check that it's defined      # Check that it's defined
     if (!($navmap->courseMapDefined())) {      if (!($navmap->courseMapDefined())) {
         $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .          $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
Line 171  sub handler { Line 232  sub handler {
     # 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";
   
       # Keep these mappings in sync with lonquickgrades, which uses the colors
       # instead of the icons.
     my %statusIconMap =       my %statusIconMap = 
         ( $res->NETWORK_FAILURE    => '',          ( $res->NETWORK_FAILURE    => '',
           $res->NOTHING_SET        => '',            $res->NOTHING_SET        => '',
Line 206  sub handler { Line 269  sub handler {
     # Is this a new-style course? If so, we want to suppress showing the top-level      # 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.      # maps in their own folders, in favor of "inlining" them.
     my $topResource = $navmap->getById("0.0");      my $topResource = $navmap->getById("0.0");
     my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|;  
     my $inlinedelta = $inlineTopLevelMaps? -1 : 0;  
   
     # Begin the HTML table      # Begin the HTML table
     # four cols: resource + indent, chat+feedback, icon, text string      # four cols: resource + indent, chat+feedback, icon, text string
Line 219  sub handler { Line 280  sub handler {
     # Here's a simple example of the iterator.      # Here's a simple example of the iterator.
     # Preprocess the map: Look for current URL, force inlined maps to display      # 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 $found = 0;
     my $depth = 1;      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                               # so we can back up a few and put the anchor above the
                              # current resource                               # 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                               # before the current resource when using #current
     $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 $counter = 0;
           my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one
     while ($depth > 0) {      my $looped = 0; 
   
       # 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->BEGIN_MAP()) { $depth++; }
         if ($curRes == $mapIterator->END_MAP()) { $depth--; }          if ($curRes == $mapIterator->END_MAP()) { $depth--; }
   
         if (ref($curRes)) { $counter++; }          if (ref($curRes) && !$ENV{'form.alreadyHere'} && 
               ($hereType == $SYMB && $curRes->symb() eq $here) ||
         my $mapStack = $mapIterator->getStack();              (ref($curRes) && $hereType == $URL && $curRes->src() eq $here)) {
         if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) &&               my $mapStack = $mapIterator->getStack();
             $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;  
                           
             # Ensure the parent maps are open              # Ensure the parent maps are open
             for my $map (@{$mapStack}) {              for my $map (@{$mapStack}) {
Line 259  sub handler { Line 316  sub handler {
             }              }
             $ENV{'form.alreadyHere'} = 1;              $ENV{'form.alreadyHere'} = 1;
         }          }
                       $looped = 1;
         # Preprocessing: If we're inlining nav maps into the top-level display,  
         # make sure we show this map!          $curRes = $mapIterator->next();
         if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map &&       }            
             scalar(@{$mapStack}) == 1) {      
             if ($condition) {      $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0);
                 undef $filterHash{$curRes->map_pc()};      $depth = 1;
             } else {      $mapIterator->next();
                 $filterHash{$curRes->map_pc()} = 1;      $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();          $curRes = $mapIterator->next();
Line 282  sub handler { Line 356  sub handler {
     my $now = time();      my $now = time();
     my $in24Hours = $now + 24 * 60 * 60;      my $in24Hours = $now + 24 * 60 * 60;
     my $displayedHereMarker = 0;      my $displayedHereMarker = 0;
       my $displayedJumpMarker = 0;
           
     # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"      # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
     # code in iterator->next), so ignore the first one      # code in iterator->next), so ignore the first one
Line 296  sub handler { Line 371  sub handler {
   
     $counter = 0;      $counter = 0;
   
     # Print the 'current' anchor here if it would fall off the top  
     if ($currentUrlIndex - $currentUrlDelta < 0) {  
         $r->print('<a name="current" />');  
     }  
   
     while ($depth > 0) {      while ($depth > 0) {
         if ($curRes == $mapIterator->BEGIN_MAP() ||          if ($curRes == $mapIterator->BEGIN_MAP() ||
             $curRes == $mapIterator->BEGIN_BRANCH()) {              $curRes == $mapIterator->BEGIN_BRANCH()) {
Line 325  sub handler { Line 395  sub handler {
             next; # if yes, then just 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              my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon
   
             if ($indentLevel - $deltalevel + $inlinedelta < 0) {              if ($indentLevel - $deltalevel < 0) {
                 # If this would be at a negative depth (top-level maps in                  # If this would be at a negative depth (top-level maps in
                 # new-style courses, we want to suppress their title display)                  # new-style courses, we want to suppress their title display)
                 # then ignore it.                  # then ignore it.
Line 436  sub handler { Line 506  sub handler {
                     '"';                      '"';
   
                 my $title = $curRes->compTitle();                  my $title = $curRes->compTitle();
                   if ($src=~/^\/uploaded\//) {
       $nonLinkedText=$title;
                       $title='';
                   }
                 my $partLabel = "";                  my $partLabel = "";
                 my $newBranchText = "";                  my $newBranchText = "";
   
Line 470  sub handler { Line 544  sub handler {
                     $linkopen .= ($nowOpen xor $condition) ?                       $linkopen .= ($nowOpen xor $condition) ? 
                         addToFilter(\%filterHash, $mapId) :                          addToFilter(\%filterHash, $mapId) :
                         removeFromFilter(\%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 = "</a>";                      $linkclose = "</a>";
   
                 }                  }
Line 478  sub handler { Line 555  sub handler {
                 my $colorizer = "";                  my $colorizer = "";
                 my $color;                  my $color;
                 if ($curRes->is_problem()) {                  if ($curRes->is_problem()) {
                     my $status = $curRes->status($part);                      $color = $colormap{$curRes->status};
                     $color = $colormap{$status};  
   
                     # Special case in the navmaps: If in less then                      if (dueInLessThen24Hours($curRes, $part) ||
                     # 24 hours, give it a bit of urgency                          lastTry($curRes, $part)) {
                     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()) {  
                         $color = $hurryUpColor;                          $color = $hurryUpColor;
                     }                      }
   
                     if ($color ne "") {                      if ($color ne "") {
                         $colorizer = "bgcolor=\"$color\"";                          $colorizer = "bgcolor=\"$color\"";
                     }                      }
Line 512  sub handler { Line 575  sub handler {
                 my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];                  my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];
   
                 # FIRST COL: The resource indentation, branch icon, name, and anchor                  # FIRST COL: The resource indentation, branch icon, name, and anchor
                 $r->print("  <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\" width=\"60%\">\n");                  $r->print("  <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\">\n");
   
                 # Print the anchor if necessary                  # Print the anchor if necessary
                 if ($counter == $currentUrlIndex - $currentUrlDelta) {                  if ($counter == $currentJumpIndex - $currentJumpDelta ) {
                     $r->print('<a name="current" />');                      $r->print('<a name="curloc" />');
                       $displayedJumpMarker = 1;
                 }                  }
   
                 # print indentation                  # print indentation
                 for (my $i = 0; $i < $indentLevel - $deltalevel + $inlinedelta; $i++) {                  for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
                     $r->print($indentString);                      $r->print($indentString);
                 }                  }
   
Line 530  sub handler { Line 594  sub handler {
                 my $curMarkerEnd = "";                  my $curMarkerEnd = "";
   
                 # Is this the current resource?                  # Is this the current resource?
                 if ($curRes->src() eq $currenturl && !$displayedHereMarker) {                  if (!$displayedHereMarker && 
                     $curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">&gt; </font>';                      (($hereType == $SYMB && $curRes->symb eq $here) ||
                       ($hereType == $URL && $curRes->src eq $here))) {
                       $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';
                     $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';                      $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';
                     $displayedHereMarker = 1;                      $displayedHereMarker = 1;
                 }                  }
Line 546  sub handler { Line 612  sub handler {
   
                 $r->print("  $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");                  $r->print("  $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");
   
                 if ($curRes->{RESOURCE_ERROR}) {                  #if ($curRes->{RESOURCE_ERROR}) {
                     $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",                  #    $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
                                               '<font size="-1">Host down</font>'));                  #                              '<font size="-1">Host down</font>'));
                     }                  #    }
   
                 $r->print("</td>\n");                  $r->print("</td>\n");
   
                 # SECOND COL: Is there text, feedback, errors??                  # SECOND COL: Is there text, feedback, errors??
                 my $discussionHTML = ""; my $feedbackHTML = "";                  my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
   
                 if ($curRes->hasDiscussion()) {                  if ($curRes->hasDiscussion()) {
                     $discussionHTML = $linkopen .                      $discussionHTML = $linkopen .
Line 574  sub handler { Line 640  sub handler {
                     }                      }
                 }                  }
   
                 $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML&nbsp;</td>");                  if ($curRes->getErrors()) {
                       my $errors = $curRes->getErrors();
                       foreach (split(/,/, $errors)) {
                           if ($_) {
                               $errorHTML .= '&nbsp;<a href="/adm/email?display='
                                   . &Apache::lonnet::escape($_) . '">'
                                   . '<img src="/adm/lonMisc/bomb.gif" '
                                   . 'border="0" /></a>';
                           }
                       }
                   }
   
                   $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML&nbsp;</td>");
   
                 # Is this the first displayed part of a multi-part problem                  # Is this the first displayed part of a multi-part problem
                 # that has not been condensed, so we should suppress these two                  # that has not been condensed, so we should suppress these two
Line 619  sub handler { Line 697  sub handler {
         $curRes = $mapIterator->next();          $curRes = $mapIterator->next();
     }      }
   
     $r->print("</table></body></html>");      $r->print("</table>");
   
       # Print out the part that jumps to #curloc if it exists
       if ($displayedJumpMarker) {
           $r->print('<script>location += "#curloc";</script>');
       }
   
     $navmap->untieHashes();      $navmap->untieHashes();
   
       $r->print("</body></html>");
   
     return OK;      return OK;
 }  }
   
Line 731  sub getDescription { Line 816  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.  # This puts a human-readable name on the ENV variable.
 sub advancedUser {  sub advancedUser {
     return $ENV{'user.adv'};      return $ENV{'user.adv'};
Line 891  sub new { Line 1003  sub new {
     $self->{NETWORK_FAILURE} = 0;      $self->{NETWORK_FAILURE} = 0;
   
     # tie the nav hash      # tie the nav hash
     my %navmaphash;  
     if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},      if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
               &GDBM_READER(), 0640))) {                &GDBM_READER(), 0640))) {
         return undef;          return undef;
     }      }
     $self->{NAV_HASH} = \%navmaphash;  
           
     my %parmhash;  
     if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},      if (!(tie(%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->{PARM_HASH} = \%parmhash;  
     $self->{HASH_TIED} = 1;      $self->{HASH_TIED} = 1;
       $self->{NAV_HASH} = \%navmaphash;
       $self->{PARM_HASH} = \%parmhash;
   
     bless($self);      bless($self);
                   
Line 979  sub init { Line 1091  sub init {
         my %emailstatus = &Apache::lonnet::dump('email_status');          my %emailstatus = &Apache::lonnet::dump('email_status');
         my $logoutTime = $emailstatus{'logout'};          my $logoutTime = $emailstatus{'logout'};
         my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};          my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
         $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?          $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ?
                                $courseLeaveTime : $logoutTime);                                 $courseLeaveTime : $logoutTime);
         my %discussiontime = &Apache::lonnet::dump('discussiontimes',           my %discussiontime = &Apache::lonnet::dump('discussiontimes', 
                                                    $cdom, $cnum);                                                     $cdom, $cnum);
Line 1022  sub init { Line 1134  sub init {
     $self->{PARM_CACHE} = {};      $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  # Checks to see if coursemap is defined, matching test in old lonnavmaps
 sub courseMapDefined {  sub courseMapDefined {
     my $self = shift;      my $self = shift;
     my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});      my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
   
     my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};      my $firstres = $self->navhash("map_start_$uri");
     my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};      my $lastres = $self->navhash("map_finish_$uri");
     return $firstres && $lastres;      return $firstres && $lastres;
 }  }
   
Line 1053  sub DESTROY { Line 1172  sub DESTROY {
     $self->untieHashes();      $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.  # current discussion? Returns 0 if chat/mail data not extracted.
 sub hasDiscussion {  sub hasDiscussion {
     my $self = shift;      my $self = shift;
     my $symb = shift;      my $symb = shift;
     if (!defined($self->{DISCUSSION_TIME})) { return 0; }      if (!defined($self->{DISCUSSION_TIME})) { return 0; }
   
       #return defined($self->{DISCUSSION_TIME}->{$symb});
     return $self->{DISCUSSION_TIME}->{$symb} >      return $self->{DISCUSSION_TIME}->{$symb} >
            $self->{LAST_CHECK};             $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  # current feedback? Returns the string in the feedback hash, which
 # will be false if it does not exist.  # will be false if it does not exist.
 sub getFeedback {   sub getFeedback { 
Line 1076  sub getFeedback { Line 1196  sub getFeedback {
     return $self->{FEEDBACK}->{$symb};      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  =pod
   
 =item * B<getById>(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.  =item * B<getById>(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.
Line 1108  sub getById { Line 1237  sub getById {
   
 sub firstResource {  sub firstResource {
     my $self = shift;      my $self = shift;
     my $firstResource = $self->{NAV_HASH}->{'map_start_' .      my $firstResource = $self->navhash('map_start_' .
                      &Apache::lonnet::clutter($ENV{'request.course.uri'})};                       &Apache::lonnet::clutter($ENV{'request.course.uri'}));
     return $self->getById($firstResource);      return $self->getById($firstResource);
 }  }
   
Line 1121  sub firstResource { Line 1250  sub firstResource {
   
 sub finishResource {  sub finishResource {
     my $self = shift;      my $self = shift;
     my $firstResource = $self->{NAV_HASH}->{'map_finish_' .      my $firstResource = $self->navhash('map_finish_' .
                      &Apache::lonnet::clutter($ENV{'request.course.uri'})};                       &Apache::lonnet::clutter($ENV{'request.course.uri'}));
     return $self->getById($firstResource);      return $self->getById($firstResource);
 }  }
   
Line 1249  getIterator behaves as follows: Line 1378  getIterator behaves as follows:
   
 =over 4  =over 4
   
 =item * B<getIterator>(firstResource, finishResource, filterHash, condition): 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.  =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.
   
 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 1269  The iterator will return either a refere Line 1398  The iterator will return either a refere
   
 The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.  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  =back
   
 =cut  =cut
Line 1319  sub new { Line 1450  sub new {
     if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };      if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
     $self->{CONDITION} = shift;      $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      # 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 1334  sub new { Line 1468  sub new {
   
     my $maxDepth = 0; # tracks max depth      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**      # **1**
   
     foreach my $pass (@iterations) {      foreach my $pass (@iterations) {
Line 1357  sub new { Line 1496  sub new {
             if ($curRes == $iterator->END_MAP()) { $depth--; }              if ($curRes == $iterator->END_MAP()) { $depth--; }
                   
             if (ref($curRes)) {              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 $resultingVal = $curRes->{DATA}->{$valName};
                 my $nextResources = $curRes->$nextResourceMethod();                  my $nextResources = $curRes->$nextResourceMethod();
                 my $resourceCount = scalar(@{$nextResources});                  my $nextCount = scalar(@{$nextResources});
   
                 if ($resourceCount == 1) { # **3**                  if ($nextCount == 1) { # **3**
                     my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;                      my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
                     $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);                      $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
                 }                  }
                                   
                 if ($resourceCount > 1) { # **4**                  if ($nextCount > 1) { # **4**
                     foreach my $res (@{$nextResources}) {                      foreach my $res (@{$nextResources}) {
                         my $current = $res->{DATA}->{$valName} || 999999999;                          my $current = $res->{DATA}->{$valName} || 999999999;
                         $res->{DATA}->{$valName} = min($current, $resultingVal + 1);                          $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
Line 1386  sub new { Line 1532  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.      # Set up some bookkeeping information.
     $self->{CURRENT_DEPTH} = 0;      $self->{CURRENT_DEPTH} = 0;
     $self->{MAX_DEPTH} = $maxDepth;      $self->{MAX_DEPTH} = $maxDepth;
Line 1535  sub next { Line 1693  sub next {
                                               $self->{ALREADY_SEEN}, $self->{CONDITION});                                                $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};      return $self->{HERE};
   
 }  }
Line 1581  package Apache::lonnavmaps::DFSiterator; Line 1746  package Apache::lonnavmaps::DFSiterator;
 #  but this might as well be left seperate, since it is possible some other  #  but this might as well be left seperate, since it is possible some other
 #  use might be found for it. - Jeremy  #  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 BEGIN_MAP { return 1; }    # begining of a new map
 sub END_MAP { return 2; }      # end of the map  sub END_MAP { return 2; }      # end of the map
 sub FORWARD { return 1; }      # go forward  sub FORWARD { return 1; }      # go forward
Line 1781  sub navHash { Line 1949  sub navHash {
     my $self = shift;      my $self = shift;
     my $param = shift;      my $param = shift;
     my $id = shift;      my $id = shift;
     return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};      return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
 }  }
   
 =pod  =pod
Line 2102  sub hasDiscussion { Line 2270  sub hasDiscussion {
   
 sub getFeedback {  sub getFeedback {
     my $self = shift;      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  =pod

Removed from v.1.114  
changed lines
  Added in v.1.130


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