Diff for /loncom/interface/lonnavmaps.pm between versions 1.62 and 1.68

version 1.62, 2002/10/03 19:10:28 version 1.68, 2002/10/07 21:07:47
Line 819  sub new_handle { Line 819  sub new_handle {
     &Apache::loncommon::no_cache($r);      &Apache::loncommon::no_cache($r);
     $r->send_http_header;      $r->send_http_header;
   
     # Header  
     $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',  
                                           ''));  
     # Initialize the nav map      # Initialize the nav map
     my $navmap = Apache::lonnavmaps::navmap->new(      my $navmap = Apache::lonnavmaps::navmap->new(
                         $ENV{"request.course.fn"}.".db",                          $ENV{"request.course.fn"}.".db",
Line 834  sub new_handle { Line 831  sub new_handle {
         return HTTP_NOT_ACCEPTABLE;          return HTTP_NOT_ACCEPTABLE;
     }      }
   
       # Header
       $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
                                             ''));
       $r->print('<script>window.focus();</script>');
       my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
       my $date=localtime;
       $r->print("<h3>$date</h3>\n");
       $r->rflush();
       if ($navmap->{LAST_CHECK}) {
           $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
                     timeToHumanString($navmap->{LAST_CHECK}).
                     '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
       } else {
           $r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
                     '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
       }
       #if (($currenturl=~/^\/res/) &&
       #    ($currenturl!~/^\/res\/adm/)) {
       #    $r->print('<a href="#curloc">Current Location</a><p>');
       #}
   
     # 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 863  sub new_handle { Line 882  sub new_handle {
     my $hurryUpColor = "#FFCCCC";      my $hurryUpColor = "#FFCCCC";
   
     my %statusIconMap =       my %statusIconMap = 
  ( $res->NETWORK_FAILURE    => '',          ( $res->NETWORK_FAILURE    => '',
   $res->NOTHING_SET        => '',            $res->NOTHING_SET        => '',
   $res->CORRECT            => 'navmap.correct.gif',            $res->CORRECT            => 'navmap.correct.gif',
   $res->EXCUSED            => 'navmap.correct.gif',            $res->EXCUSED            => 'navmap.correct.gif',
   $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',            $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
   $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',            $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
   $res->ANSWER_OPEN        => 'navmap.wrong.gif',            $res->ANSWER_OPEN        => 'navmap.wrong.gif',
   $res->OPEN_LATER         => '',            $res->OPEN_LATER         => '',
   $res->TRIES_LEFT         => 'navmap.open.gif',            $res->TRIES_LEFT         => 'navmap.open.gif',
   $res->INCORRECT          => 'navmap.wrong.gif',            $res->INCORRECT          => 'navmap.wrong.gif',
   $res->OPEN               => 'navmap.open.gif' );            $res->OPEN               => 'navmap.open.gif' );
   
     my %condenseStatuses =      my %condenseStatuses =
  ( $res->NETWORK_FAILURE    => 1,          ( $res->NETWORK_FAILURE    => 1,
   $res->NOTHING_SET        => 1,            $res->NOTHING_SET        => 1,
   $res->CORRECT            => 1 );            $res->CORRECT            => 1 );
   
     my %filterHash;      my %filterHash;
     # Figure out what we're not displaying      # Figure out what we're not displaying
Line 888  sub new_handle { Line 907  sub new_handle {
         }          }
     }      }
   
       my $currenturl = $ENV{'form.postdata'};
       $currenturl=~s/^http\:\/\///;
       $currenturl=~s/^[^\/]+//;
       my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);
   
       $r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');
   
     # 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
     $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");      $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
   
     my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);      my $condition = 0;
       if ($ENV{'form.condition'}) {
           $condition = 1;
       }
   
       my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);
     my $curRes = $mapIterator->next();      my $curRes = $mapIterator->next();
     undef $res; # so we don't accidentally use it later      undef $res; # so we don't accidentally use it later
     my $indentLevel = -1;      my $indentLevel = -1;
Line 915  sub new_handle { Line 946  sub new_handle {
             $isNewBranch = 1;              $isNewBranch = 1;
         }          }
   
           # Is this resource being blotted out?
           if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
               $curRes = $mapIterator->next();
               next; # and totally ignore this resource
           }
   
         if (ref($curRes) && $curRes->src()) {          if (ref($curRes) && $curRes->src()) {
   
     # Step one: Decide which parts to show              # Step one: Decide which parts to show
     my @parts = @{$curRes->parts()};              my @parts = @{$curRes->parts()};
     my $multipart = scalar(@parts) > 1;              my $multipart = scalar(@parts) > 1;
     my $condensed = 0;              my $condensed = 0;
                   
             if ($curRes->is_problem()) {              if ($curRes->is_problem()) {
  # Is it multipart?                  # Is it multipart?
   
  if ($multipart) {                  if ($multipart) {
     # If it's multipart, see if part 0 is "open"                      # If it's multipart, see if part 0 is "open"
     # if it is, display all parts, if it isn't,                      # if it is, display all parts, if it isn't,
     # just display first                      # just display first
     if (!$curRes->opendate("0")) {                      if (!$curRes->opendate("0")) {
  @parts = ("0"); # just display the zero-th part                          @parts = ("0"); # just display the zero-th part
     } else {                          $condensed = 1;
  # Otherwise, only display part 0 if we want to                       } else {
  # attach feedback or email information to it                          # Otherwise, only display part 0 if we want to 
  if ($curRes->hasDiscussion() || $curRes->getFeedback()) {                          # attach feedback or email information to it
     shift @parts;                          if ($curRes->hasDiscussion() || $curRes->getFeedback()) {
  } else {                              shift @parts;
     # If there's discussion or feedback, that counts                          } else {
     # as a difference, so display the parts.                              # If there's discussion or feedback, that counts
                                   # as a difference, so display the parts.
     # Now, we decide whether to condense the                              
     # parts due to similarity                              # Now, we decide whether to condense the
     my $status = $curRes->status($parts[1]);                              # parts due to similarity
     my $due = $curRes->duedate($parts[1]);                              my $status = $curRes->status($parts[1]);
     my $open = $curRes->opendate($parts[1]);                              my $due = $curRes->duedate($parts[1]);
     my $statusAllSame = 1;                              my $open = $curRes->opendate($parts[1]);
     my $dueAllSame = 1;                              my $statusAllSame = 1;
     my $openAllSame = 1;                              my $dueAllSame = 1;
     for (my $i = 2; $i < scalar(@parts); $i++) {                              my $openAllSame = 1;
  if ($curRes->status($parts[$i]) != $status){                              for (my $i = 2; $i < scalar(@parts); $i++) {
     $statusAllSame = 0;                                  if ($curRes->status($parts[$i]) != $status){
  }                                      $statusAllSame = 0;
  if ($curRes->duedate($parts[$i]) != $due ) {                                  }
     $dueAllSame = 0;                                  if ($curRes->duedate($parts[$i]) != $due ) {
  }                                      $dueAllSame = 0;
  if ($curRes->opendate($parts[$i]) != $open) {                                  }
     $openAllSame = 0;                                  if ($curRes->opendate($parts[$i]) != $open) {
  }                                      $openAllSame = 0;
     }                                  }
                                   }
     # $allSame is true if all the statuses were                              
     # the same. Now, if they are all the same and                              # $allSame is true if all the statuses were
     # match one of the statuses to condense, or they                              # the same. Now, if they are all the same and
     # are all open with the same due date, or they are                              # match one of the statuses to condense, or they
     # all OPEN_LATER with the same open date, display the                              # are all open with the same due date, or they are
     # status of the first non-zero part (to get the 'correct'                              # all OPEN_LATER with the same open date, display the
     # status right, since 0 is never 'correct' or 'open').                              # status of the first non-zero part (to get the 'correct'
     if (($statusAllSame && defined($condenseStatuses{$status})) ||                              # status right, since 0 is never 'correct' or 'open').
  ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||                              if (($statusAllSame && defined($condenseStatuses{$status})) ||
  ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){                                  ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
  @parts = ($parts[1]);                                  ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
  $condensed = 1;                                  @parts = ($parts[1]);
     }                                  $condensed = 1;
  }                              }
     }                          }
  }                      }
                   }
   
             } else {              } else {
                 @parts[0] = "0"; # this is to get past foreach loop below                  @parts[0] = "0"; # this is to get past foreach loop below
Line 983  sub new_handle { Line 1021  sub new_handle {
                  # with only one part without loss                   # with only one part without loss
             }              }
   
     # Step two: Show the parts              # Display one part, in event of network error.
               # If this is a single part, we can at least show the correct
               # status, but if it's multipart, we're lost.
               if ($curRes->{RESOURCE_ERROR}) {
                   @parts = ("0");
               }
   
               # Step two: Show the parts
             foreach my $part (@parts) {              foreach my $part (@parts) {
   
  my $deltalevel = 0; # for inserting the branch icon                  my $deltalevel = 0; # for inserting the branch icon
                   my $nonLinkedText = ""; # unlinked stuff after title
                                   
                 # For each thing we're displaying...                  # For each thing we're displaying...
   
Line 1007  sub new_handle { Line 1053  sub new_handle {
                 if ($isNewBranch) {                  if ($isNewBranch) {
                     $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";                      $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
                     $isNewBranch = 0;                      $isNewBranch = 0;
     $deltalevel = 1;                      $deltalevel = 1;
                 }                  }
   
                 # links to open and close the folders                  # links to open and close the folders
Line 1016  sub new_handle { Line 1062  sub new_handle {
   
                 my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";                  my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
                 if ($curRes->is_problem()) {                   if ($curRes->is_problem()) { 
     if ($part eq "0" || $condensed) {                      if ($part eq "0" || $condensed) {
  $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';                           $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; 
     } else {                      } else {
  $icon = $indentString;                          $icon = $indentString;
     }                      }
                 }                  }
   
                 # Display the correct icon, link to open or shut map                  # Display the correct icon, link to open or shut map
Line 1028  sub new_handle { Line 1074  sub new_handle {
                     my $mapId = $curRes->map_pc();                      my $mapId = $curRes->map_pc();
                     my $nowOpen = !defined($filterHash{$mapId});                      my $nowOpen = !defined($filterHash{$mapId});
                     $icon = $nowOpen ?                      $icon = $nowOpen ?
                         "folder_opened.gif" : "folder_closed.gif";                          "folder_closed.gif" : "folder_opened.gif";
     $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";                      $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
                     $linkopen = "<a href=\"/adm/navmaps?filter=";                      $linkopen = "<a href=\"/adm/navmaps?filter=";
                     $linkopen .= $nowOpen ?                       $linkopen .= ($nowOpen xor $condition) ? 
                         addToFilter(\%filterHash, $mapId) :                          addToFilter(\%filterHash, $mapId) :
                         removeFromFilter(\%filterHash, $mapId);                          removeFromFilter(\%filterHash, $mapId);
                     $linkopen .= "\">";                      $linkopen .= "&condition=$condition&$queryAdd\">";
                     $linkclose = "</a>";                      $linkclose = "</a>";
                       
                 }                  }
                                   
                 my $colorizer = "";                  my $colorizer = "";
Line 1048  sub new_handle { Line 1094  sub new_handle {
                     }                      }
                 }                  }
   
  # FIRST ROW: The resource indentation, branch icon, and name                  if ($curRes->randomout()) {
                 $r->print("  <tr><td align=\"left\" valign=\"top\">\n");                      $nonLinkedText .= ' <i>(hidden)</i> ';
                   }
   
                   # FIRST COL: The resource indentation, branch icon, and name
                   $r->print("  <tr><td align=\"left\" valign=\"bottom\">\n");
   
                 # print indentation                  # print indentation
                 for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {                  for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
Line 1059  sub new_handle { Line 1109  sub new_handle {
                 $r->print("  ${newBranchText}${linkopen}$icon${linkclose}\n");                  $r->print("  ${newBranchText}${linkopen}$icon${linkclose}\n");
   
                 if ($curRes->is_problem() && $part != "0" && !$condensed) {                   if ($curRes->is_problem() && $part != "0" && !$condensed) { 
     $partLabel = " (Part $part)";                       $partLabel = " (Part $part)"; 
     $title = "";                      $title = "";
  }                  }
                   if ($multipart && $condensed) {
                 $r->print("  <a href=\"$link\">$title$partLabel</a></td>");                      $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
                   }
  my $discussionHTML = ""; my $feedbackHTML = "";  
                   $r->print("  <a href=\"$link\">$title$partLabel</a> $nonLinkedText");
  # SECOND ROW: Is there text or feedback?  
  if ($curRes->hasDiscussion()) {                  if ($curRes->{RESOURCE_ERROR}) {
     $discussionHTML = $linkopen .                      $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
  '<img border="0" src="/adm/lonMisc/chat.gif" />' .                                                    '<font size="-1">Host down</font>'));
  $linkclose;                      }
  }  
   
  if ($curRes->getFeedback()) {  
     my $feedback = $curRes->getFeedback();  
     foreach (split(/\,/, $feedback)) {  
  if ($_) {  
     $feedbackHTML .= '&nbsp;<a href="/adm/email?display='  
  . &Apache::lonnet::escape($_) . '">'  
  . '<img src="/adm/lonMisc/feedback.gif" '  
  . 'border="0" /></a>';  
  }  
     }  
  }  
   
  $r->print("<td align=\"left\">$discussionHTML$feedbackHTML</td>");  
   
  # Is this the first displayed part of a multi-part problem  
  # that has not been condensed, so we should suppress these two  
  # columns?  
  my $firstDisplayed = !$condensed && $multipart && $part eq "0";  
   
  # THIRD ROW: Problem status icon  
  if ($curRes->is_problem() &&  
     !$firstDisplayed) {  
     my $icon = $statusIconMap{$curRes->status($part)};  
     if ($icon) {  
  $r->print("<td width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");  
     } else {  
  $r->print("<td></td>\n");  
     }  
  } else { # not problem, no icon  
     $r->print("<td></td>\n");  
  }  
   
   # FOURTH ROW: Text description                  my $discussionHTML = ""; my $feedbackHTML = "";
  $r->print("<td $colorizer align=\"right\">\n");  
                   # SECOND COL: Is there text or feedback?
                   if ($curRes->hasDiscussion()) {
                       $discussionHTML = $linkopen .
                           '<img border="0" src="/adm/lonMisc/chat.gif" />' .
                           $linkclose;
                   }
   
                   if ($curRes->getFeedback()) {
                       my $feedback = $curRes->getFeedback();
                       foreach (split(/\,/, $feedback)) {
                           if ($_) {
                               $feedbackHTML .= '&nbsp;<a href="/adm/email?display='
                                   . &Apache::lonnet::escape($_) . '">'
                                   . '<img src="/adm/lonMisc/feedback.gif" '
                                   . 'border="0" /></a>';
                           }
                       }
                   }
   
                   $r->print("<td align=\"left\" valign=\"bottom\">$discussionHTML$feedbackHTML</td>");
   
                   # Is this the first displayed part of a multi-part problem
                   # that has not been condensed, so we should suppress these two
                   # columns?
                   my $firstDisplayed = !$condensed && $multipart && $part eq "0";
   
                   # THIRD ROW: Problem status icon
                   if ($curRes->is_problem() &&
                       !$firstDisplayed) {
                       my $icon = $statusIconMap{$curRes->status($part)};
                       if ($icon) {
                           $r->print("<td valign=\"bottom\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");
                       } else {
                           $r->print("<td></td>\n");
                       }
                   } else { # not problem, no icon
                       $r->print("<td></td>\n");
                   }
   
                   # FOURTH ROW: Text description
                   $r->print("<td $colorizer align=\"right\" valign=\"bottom\">\n");
                                   
                 if ($curRes->kind() eq "res" &&                  if ($curRes->kind() eq "res" &&
                     $curRes->is_problem() &&                      $curRes->is_problem() &&
     !$firstDisplayed) {                      !$firstDisplayed) {
                     $r->print (getDescription($curRes, $part));                      $r->print (getDescription($curRes, $part));
                 }                  }
                   if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
                       $r->print('(randomly select ' . $curRes->randompick() .')');
                   }
   
  $r->print("</td></tr>\n");                  $r->print("</td></tr>\n");
             }              }
         }          }
         $curRes = $mapIterator->next();          $curRes = $mapIterator->next();
Line 1193  sub getDescription { Line 1254  sub getDescription {
         return "Opens: " . timeToHumanString($res->opendate($part));          return "Opens: " . timeToHumanString($res->opendate($part));
     }      }
     if ($status == $res->OPEN) {      if ($status == $res->OPEN) {
  if ($res->duedate()) {          if ($res->duedate()) {
     return "Due: $status " . timeToHumanString($res->duedate($part));              return "Due: $status " . timeToHumanString($res->duedate($part));
  } else {          } else {
     return "Open, no due date";              return "Open, no due date";
  }          }
     }      }
     if ($status == $res->PAST_DUE_ANSWER_LATER) {      if ($status == $res->PAST_DUE_ANSWER_LATER) {
         return "Answer opens: " . timeToHumanString($res->answerdate($part));          return "Answer opens: " . timeToHumanString($res->answerdate($part));
Line 1209  sub getDescription { Line 1270  sub getDescription {
         return "Answer available";          return "Answer available";
     }      }
     if ($status == $res->EXCUSED) {      if ($status == $res->EXCUSED) {
  return "Excused by instructor";          return "Excused by instructor";
     }      }
     if ($status == $res->TRIES_LEFT) {      if ($status == $res->TRIES_LEFT) {
  my $tries = $res->tries();          my $tries = $res->tries();
  my $maxtries = $res->maxtries();          my $maxtries = $res->maxtries();
  my $triesString = "($tries of $maxtries tries used)";          my $triesString = "($tries of $maxtries tries used)";
  if ($res->duedate()) {          if ($res->duedate()) {
     return "Due: $status " . timeToHumanString($res->duedate($part)) .              return "Due: $status " . timeToHumanString($res->duedate($part)) .
  " $triesString";                  " $triesString";
  } else {          } else {
     return "No due date $triesString";              return "No due date $triesString";
  }          }
     }      }
 }  }
   
   sub advancedUser {
       return $ENV{'user.adv'};
   }
   
 # I want to change this into something more human-friendly. For  # I want to change this into something more human-friendly. For
 # now, this is a simple call to localtime. The final function  # now, this is a simple call to localtime. The final function
 # probably belongs in loncommon.  # probably belongs in loncommon.
Line 1231  sub timeToHumanString { Line 1296  sub timeToHumanString {
     my ($time) = @_;      my ($time) = @_;
     # zero, '0' and blank are bad times      # zero, '0' and blank are bad times
     if ($time) {      if ($time) {
  return localtime($time);          return localtime($time);
     } else {      } else {
  return 'Never';          return 'Never';
     }      }
 }  }
   
Line 1301  sub new { Line 1366  sub new {
     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->{PARM_HASH} = \%parmhash;
Line 1428  sub courseMapDefined { Line 1493  sub courseMapDefined {
 sub getIterator {  sub getIterator {
     my $self = shift;      my $self = shift;
     my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,      my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
                                                      shift, shift);                                                       shift, undef, shift);
     return $iterator;      return $iterator;
 }  }
   
Line 1454  sub hasDiscussion { Line 1519  sub hasDiscussion {
     if (!defined($self->{DISCUSSION_TIME})) { return 0; }      if (!defined($self->{DISCUSSION_TIME})) { return 0; }
   
     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 function: Does the given resource (as a symb string) have
Line 1637  getIterator behaves as follows: Line 1702  getIterator behaves as follows:
   
 =over 4  =over 4
   
 =item B<getIterator>(nav_map, firstResource, finishResource, filterHash): 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(). It is your responsibility to ensure that the iterator will actually get there. 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 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0.  =item B<getIterator>(nav_map, 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(). It is your responsibility to ensure that the iterator will actually get there. 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, which is to say, do not recurse unless explicitly asked to.
   
 Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.  Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.
   
Line 1689  sub new { Line 1754  sub new {
     # A hash, used as a set, of resource already seen      # A hash, used as a set, of resource already seen
     $self->{ALREADY_SEEN} = shift;      $self->{ALREADY_SEEN} = shift;
     if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };      if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
       $self->{CONDITION} = shift;
   
     # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.      # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
     $self->{STARTED} = 0;      $self->{STARTED} = 0;
Line 1720  sub new { Line 1786  sub new {
     return $self;      return $self;
 }  }
   
   # FIXME: Document this.
   sub cancelTopRecursion {
       my $self = shift;
       
       if (!$self->{RECURSIVE_ITERATOR_FLAG}) {return;}
   
       # is this the iterator we want to kill?
       if ($self->{RECURSIVE_ITERATOR_FLAG} && 
           !$self->{RECURSIVE_ITERATOR}->{RECURSIVE_ITERATOR_FLAG}) {
           $self->{RECURSIVE_ITERATOR_FLAG} = 0;
           undef $self->{RECURSIVE_ITERATOR};
           return;
       }
       
       $self->{RECURSIVE_ITERATOR}->cancelTopRecursion();
   }
   
 # Note... this function is *touchy*. I strongly recommend tracing  # Note... this function is *touchy*. I strongly recommend tracing
 # through it with the debugger a few times on a non-trivial map before  # through it with the debugger a few times on a non-trivial map before
 # modifying it. Order is *everything*.  # modifying it. Order is *everything*.
   # FIXME: Doc that skipMap will prevent the recursion, if any.
 sub next {  sub next {
     my $self = shift;      my $self = shift;
       my $skipMap = shift;
           
     # Iterator logic goes here      # Iterator logic goes here
   
     # Is this return value pre-determined?  
     if (defined($self->{FORCE_NEXT})) {  
         my $tmp = $self->{FORCE_NEXT};  
         $self->{FORCE_NEXT} = undef;  
         return $tmp;  
     }  
   
     # Are we using a recursive iterator? If so, pull from that and      # Are we using a recursive iterator? If so, pull from that and
     # watch the depth; we want to resume our level at the correct time.      # watch the depth; we want to resume our level at the correct time.
     if ($self->{RECURSIVE_ITERATOR_FLAG})      if ($self->{RECURSIVE_ITERATOR_FLAG})
Line 1754  sub next { Line 1832  sub next {
         return $next;          return $next;
     }      }
   
       # Is this return value pre-determined?
       if (defined($self->{FORCE_NEXT})) {
           my $tmp = $self->{FORCE_NEXT};
           $self->{FORCE_NEXT} = undef;
           return $tmp;
       }
   
     # Is there a current resource to grab? If not, then return      # Is there a current resource to grab? If not, then return
     # END_BRANCH and END_MAP in succession.      # END_BRANCH and END_MAP in succession.
     if (scalar(@{$self->{BRANCH_STACK}}) == 0) {      if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
Line 1842  sub next { Line 1927  sub next {
             $self->{FORCE_NEXT} = $self->END_BRANCH();              $self->{FORCE_NEXT} = $self->END_BRANCH();
             $self->{BRANCH_DEPTH}--;              $self->{BRANCH_DEPTH}--;
         }          }
         return $self->{HERE};  
     }      }
           
     while (@$next) {      while (@$next) {
Line 1858  sub next { Line 1942  sub next {
     }      }
   
     # If this is a map and we want to recurse down it... (not filtered out)      # If this is a map and we want to recurse down it... (not filtered out)
     if ($self->{HERE}->is_map() &&       if ($self->{HERE}->is_map() && !$skipMap && 
          !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) {            (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { 
         $self->{RECURSIVE_ITERATOR_FLAG} = 1;          $self->{RECURSIVE_ITERATOR_FLAG} = 1;
         my $firstResource = $self->{HERE}->map_start();          my $firstResource = $self->{HERE}->map_start();
         my $finishResource = $self->{HERE}->map_finish();          my $finishResource = $self->{HERE}->map_finish();
   
         # Odd perl syntax here; $self->new allows one to create a new iterator  
         # can't figure out how to ref this package directly correctly  
         # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new  
         $self->{RECURSIVE_ITERATOR} =          $self->{RECURSIVE_ITERATOR} =
           Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,             Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, 
                      $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN});                       $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
         # prime the new iterator with the first resource                                               $self->{CONDITION});
         #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource;  
     }      }
   
     return $self->{HERE};      return $self->{HERE};
Line 1944  sub new { Line 2024  sub new {
   
     # Store this new resource in the parent nav map's cache.      # Store this new resource in the parent nav map's cache.
     $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;      $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
       $self->{RESOURCE_ERROR} = 0;
   
     # A hash that can be used by two-pass algorithms to store data      # A hash that can be used by two-pass algorithms to store data
     # about this resource in. Not used by the resource object      # about this resource in. Not used by the resource object
Line 1987  sub goesto { my $self=shift; return $sel Line 2068  sub goesto { my $self=shift; return $sel
 # "to" can return a comma seperated list for branches  # "to" can return a comma seperated list for branches
 sub to { my $self=shift; return $self->navHash("to_", 1); }  sub to { my $self=shift; return $self->navHash("to_", 1); }
 sub kind { my $self=shift; return $self->navHash("kind_", 1); }  sub kind { my $self=shift; return $self->navHash("kind_", 1); }
   sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
   sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
   sub randompick { 
       my $self = shift;
       return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
                                                  '.0.parameter_randompick'};
   }
 sub src {   sub src { 
     my $self=shift;      my $self=shift;
     return $self->navHash("src_", 1);      return $self->navHash("src_", 1);
Line 2236  sub getFeedback { Line 2324  sub getFeedback {
 sub parts {  sub parts {
     my $self = shift;      my $self = shift;
   
       if ($self->ext) { return ['0']; }
   
     $self->extractParts();      $self->extractParts();
     return $self->{PARTS};      return $self->{PARTS};
 }  }
Line 2244  sub countParts { Line 2334  sub countParts {
     my $self = shift;      my $self = shift;
           
     my $parts = $self->parts();      my $parts = $self->parts();
       
     if (scalar(@{$parts}) == 1) { return 1;}      if ($self->{RESOURCE_ERROR}) {
           return 0;
       }
   
       if (scalar(@{$parts}) < 2) { return 1;}
   
     return scalar(@{$parts}) - 1;      return scalar(@{$parts}) - 1;
 }  }
Line 2255  sub extractParts { Line 2349  sub extractParts {
     my $self = shift;      my $self = shift;
           
     return if ($self->{PARTS});      return if ($self->{PARTS});
       return if ($self->ext);
   
     $self->{PARTS} = [];      $self->{PARTS} = [];
   
     # Retrieve part count      # Retrieve part count
     foreach (split(/\,/,&Apache::lonnet::metadata($self->src(),       my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
                                                   'allpossiblekeys'))) {      if (!$metadata) {
           $self->{RESOURCE_ERROR} = 1;
           $self->{PARTS} = [];
           return;
       }
   
       foreach (split(/\,/,$metadata)) {
         if ($_ =~ /^parameter\_(.*)\_opendate$/) {          if ($_ =~ /^parameter\_(.*)\_opendate$/) {
             push @{$self->{PARTS}}, $1;              push @{$self->{PARTS}}, $1;
         }          }
     }      }
   
           
     # Is this possible to do in one line? - Jeremy      # Is this possible to do in one line? - Jeremy
     my @sortedParts = sort @{$self->{PARTS}};      my @sortedParts = sort @{$self->{PARTS}};
Line 2539  sub getNext { Line 2641  sub getNext {
         $next = $self->{NAV_MAP}->getById($next);          $next = $self->{NAV_MAP}->getById($next);
   
         # Don't remember it if we've already seen it or if          # Don't remember it if we've already seen it or if
  # the student doesn't have browse priviledges          # the student doesn't have browse priviledges
  my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);          my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
         if (!defined($alreadySeenHash) ||          if (!defined($alreadySeenHash) ||
             !defined($alreadySeenHash->{$next->{ID}}) ||              !defined($alreadySeenHash->{$next->{ID}}) ||
     ($browsePriv ne '2' && $browsePriv ne 'F')) {              ($browsePriv ne '2' && $browsePriv ne 'F')) {
                 push @branches, $next;                  push @branches, $next;
             }              }
     }      }

Removed from v.1.62  
changed lines
  Added in v.1.68


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