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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.63 and 1.70

version 1.63, 2002/10/03 19:40:33 version 1.70, 2002/10/08 19:50: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',
             $res->ATTEMPTED          => '' );
   
       my %iconAltTags = 
           ( 'navmap.correct.gif' => 'Correct',
             'navmap.wrong.gif'   => 'Incorrect',
             'navmap.open.gif'    => 'Open' );
   
     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 893  sub new_handle { Line 918  sub new_handle {
     $currenturl=~s/^[^\/]+//;      $currenturl=~s/^[^\/]+//;
     my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);      my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);
   
     $r->print("$currenturl<br/>");      $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, 0);      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 923  sub new_handle { Line 952  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 991  sub new_handle { Line 1027  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 1015  sub new_handle { Line 1059  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 1024  sub new_handle { Line 1068  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 1037  sub new_handle { Line 1081  sub new_handle {
                     my $nowOpen = !defined($filterHash{$mapId});                      my $nowOpen = !defined($filterHash{$mapId});
                     $icon = $nowOpen ?                      $icon = $nowOpen ?
                         "folder_closed.gif" : "folder_opened.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 .= "&$queryAdd\">";                      $linkopen .= "&condition=$condition&$queryAdd\">";
                     $linkclose = "</a>";                      $linkclose = "</a>";
                       
                 }                  }
                                   
                 my $colorizer = "";                  my $colorizer = "";
Line 1056  sub new_handle { Line 1100  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 1066  sub new_handle { Line 1114  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 ne "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;                      }
  }  
                   my $discussionHTML = ""; my $feedbackHTML = "";
  if ($curRes->getFeedback()) {  
     my $feedback = $curRes->getFeedback();                  # SECOND COL: Is there text or feedback?
     foreach (split(/\,/, $feedback)) {                  if ($curRes->hasDiscussion()) {
  if ($_) {                      $discussionHTML = $linkopen .
     $feedbackHTML .= '&nbsp;<a href="/adm/email?display='                          '<img border="0" src="/adm/lonMisc/chat.gif" />' .
  . &Apache::lonnet::escape($_) . '">'                          $linkclose;
  . '<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                  if ($curRes->getFeedback()) {
  $r->print("<td $colorizer align=\"right\">\n");                      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 COL: Problem status icon
                   if ($curRes->is_problem() &&
                       !$firstDisplayed) {
                       my $icon = $statusIconMap{$curRes->status($part)};
                       my $alt = $iconAltTags{$icon};
                       if ($icon) {
                           $r->print("<td valign=\"bottom\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n");
                       } else {
                           $r->print("<td></td>\n");
                       }
                   } else { # not problem, no icon
                       $r->print("<td></td>\n");
                   }
   
                   # FOURTH COL: 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 1191  sub getLinkForResource { Line 1251  sub getLinkForResource {
 sub getDescription {  sub getDescription {
     my $res = shift;      my $res = shift;
     my $part = shift;      my $part = shift;
     my $status = $res->getDateStatus();      my $status = $res->status($part);
   
     if ($status == $res->NETWORK_FAILURE) { return ""; }      if ($status == $res->NETWORK_FAILURE) { return ""; }
     if ($status == $res->NOTHING_SET) {      if ($status == $res->NOTHING_SET) {
Line 1201  sub getDescription { Line 1261  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 1217  sub getDescription { Line 1277  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->ATTEMPTED) {
           return "Not yet graded.";
     }      }
     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 1239  sub timeToHumanString { Line 1306  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 1249  sub timeToHumanString { Line 1316  sub timeToHumanString {
   
 package Apache::lonnavmaps::navmap;  package Apache::lonnavmaps::navmap;
   
 # LEFT:  
 # * Actual handler code (multi-part)  
 # * Branches (aieee!) (and conditionals)  
   
 =pod  =pod
   
 lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.  lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
Line 1269  You must obtain resource objects through Line 1332  You must obtain resource objects through
   
 =over 4  =over 4
   
 =item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. 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>(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<getIterator>(first, finish, filter, condition): See iterator documentation below.  =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
   
Line 1309  sub new { Line 1372  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 1462  sub hasDiscussion { Line 1525  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 1645  getIterator behaves as follows: Line 1708  getIterator behaves as follows:
   
 =over 4  =over 4
   
 =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.  =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, 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: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.
   
 The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:  The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
   
 =over 4  =over 4
   
 =item * some list of tokens here  =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
   
   =item * END_MAP: The map is now done.
   
   =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
   
   =item * END_BRANCH: The branch is now done.
   
 =back  =back
   
 The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.  The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
   
   =back
   
 =cut  =cut
   
 # Here are the tokens for the iterator:  # Here are the tokens for the iterator:
   
 sub END_NAV_MAP { return 0; }  # Represents end of entire nav 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 BEGIN_BRANCH { return 3; } # beginning of a branch  sub BEGIN_BRANCH { return 3; } # beginning of a branch
Line 1737  sub next { Line 1807  sub next {
           
     # 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 1763  sub next { Line 1826  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 1818  sub next { Line 1888  sub next {
     # remember that we've seen this.      # remember that we've seen this.
     $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;      $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
           
     # Are we at the utter end? If so, return the END_NAV_MAP marker.  
     if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {  
         $self->{FORCE_NEXT} = $self->END_NAV_MAP;  
         return $self->{HERE};  
     }  
       
     # Get the next possible resources      # Get the next possible resources
     my $nextUnfiltered = $self->{HERE}->getNext();      my $nextUnfiltered = $self->{HERE}->getNext();
     my $next = [];      my $next = [];
Line 1851  sub next { Line 1915  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 1873  sub next { Line 1936  sub next {
         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},
      $self->{CONDITION});                                               $self->{CONDITION});
     }      }
   
     return $self->{HERE};      return $self->{HERE};
Line 1937  resource objects have a hash called DATA Line 1997  resource objects have a hash called DATA
   
 =over 4  =over 4
   
 =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself.   =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.
   
   =back
   
 =cut  =cut
   
Line 1952  sub new { Line 2014  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 1963  sub new { Line 2026  sub new {
     return $self;      return $self;
 }  }
   
 =pod  
   
 =item * B<is_map>: Returns true if this is a map, false otherwise.  
   
 =item * B<title>: Returns title.  
   
 =item * B<type>: Returns the type of the resource, "start", "normal", or "finish".   
   
 =item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)  
   
 =back  
   
 =cut  
   
 # private function: simplify the NAV_HASH lookups we keep doing  # private function: simplify the NAV_HASH lookups we keep doing
 # pass the name, and to automatically append my ID, pass a true val on the  # pass the name, and to automatically append my ID, pass a true val on the
 # second param  # second param
Line 1987  sub navHash { Line 2036  sub navHash {
     return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};      return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
 }  }
   
   =pod
   
   B<Metadata Retreival>
   
   These are methods that help you retrieve metadata about the resource:
   
   =over 4
   
   =item * B<ext>: Returns true if the resource is external.
   
   =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
   
   =item * B<kind>: Returns the kind of the resource from the compiled nav map.
   
   =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.
   
   =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
   
   =item * B<src>: Returns the source for the resource.
   
   =item * B<symb>: Returns the symb for the resource.
   
   =item * B<title>: Returns the title of the resource.
   
   =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
   
   =item * B<type>: Returns the type of the resource, "start", "normal", or "finish". 
   
   =back
   
   =cut
   
 # These info functions can be used directly, as they don't return  # These info functions can be used directly, as they don't return
 # resource information.  # resource information.
 sub title { my $self=shift; return $self->navHash("title_", 1); }  sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
 sub type { my $self=shift; return $self->navHash("type_", 1); }  
 sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }  sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
 # "to" can return a comma seperated list for branches  
 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 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 2007  sub symb { Line 2091  sub symb {
          $self->navHash('map_id_'.$first))            $self->navHash('map_id_'.$first)) 
         . '___' . $second . '___' . $symbSrc;          . '___' . $second . '___' . $symbSrc;
 }  }
 sub is_problem {  sub title { my $self=shift; return $self->navHash("title_", 1); }
   sub to { my $self=shift; return $self->navHash("to_", 1); }
   sub type { my $self=shift; return $self->navHash("type_", 1); }
   
   =pod
   
   B<Predicate Testing the Resource>
   
   These methods are shortcuts to deciding if a given resource has a given property.
   
   =over 4
   
   =item * B<is_map>: Returns true if the resource is a map type.
   
   =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
   
   =item * B<is_page>: Returns true if the resource is a page.
   
   =item * B<is_problem>: Returns true if the resource is a problem.
   
   =item * B<is_sequence>: Returns true if the resource sequence.
   
   =back
   
   =cut
   
   
   sub is_html {
     my $self=shift;      my $self=shift;
     my $src = $self->src();      my $src = $self->src();
     return ($src =~ /problem$/);      return ($src =~ /html$/);
 }  }
 sub is_html {  sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
   sub is_page {
     my $self=shift;      my $self=shift;
     my $src = $self->src();      my $src = $self->src();
     return ($src =~ /html$/);      return ($src =~ /page$/);
 }  }
 sub is_sequence {  sub is_problem {
     my $self=shift;      my $self=shift;
     my $src = $self->src();      my $src = $self->src();
     return ($src =~ /sequence$/);      return ($src =~ /problem$/);
 }  }
 sub is_page {  sub is_sequence {
     my $self=shift;      my $self=shift;
     my $src = $self->src();      my $src = $self->src();
     return ($src =~ /page$/);      return ($src =~ /sequence$/);
 }  }
   
   
   
   
   
 # Move this into POD: In order to use these correctly, courseopt  # Move this into POD: In order to use these correctly, courseopt
 # and useropt need to be generated  # and useropt need to be generated
 sub parmval {  sub parmval {
Line 2040  sub parmval { Line 2153  sub parmval {
     return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());      return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
 }  }
   
 #####  =pod
 # Map Queries  
 #####  
   
 # These methods relate to whether or not the resource is a map, and the   B<Map Methods>
 # attributes of that map.  
   These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
   
   =over 4
   
   =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
   
   =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
   
   =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
   
   =item * B<map_type>: Returns a string with the type of the map in it.
   
   =back
   
   =cut
   
 sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }  
 sub map_finish {  sub map_finish {
     my $self = shift;      my $self = shift;
     my $src = $self->src();      my $src = $self->src();
Line 2055  sub map_finish { Line 2180  sub map_finish {
     $res = $self->{NAV_MAP}->getById($res);      $res = $self->{NAV_MAP}->getById($res);
     return $res;      return $res;
 }  }
   sub map_pc {
       my $self = shift;
       my $src = $self->src();
       return $self->navHash("map_pc_$src", 0);
   }
 sub map_start {  sub map_start {
     my $self = shift;      my $self = shift;
     my $src = $self->src();      my $src = $self->src();
Line 2062  sub map_start { Line 2192  sub map_start {
     $res = $self->{NAV_MAP}->getById($res);      $res = $self->{NAV_MAP}->getById($res);
     return $res;      return $res;
 }  }
 sub map_pc {  
     my $self = shift;  
     my $src = $self->src();  
     return $self->navHash("map_pc_$src", 0);  
 }  
 sub map_type {  sub map_type {
     my $self = shift;      my $self = shift;
     my $pc = $self->map_pc();      my $pc = $self->map_pc();
Line 2089  sub map_type { Line 2214  sub map_type {
   
 =head2 Resource Parameters  =head2 Resource Parameters
   
 In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter.  In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.
   
 These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)  These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
   
Line 2111  These methods are responsible for gettin Line 2236  These methods are responsible for gettin
   
 =item * B<tol>: Get the tolerance for the problem.  =item * B<tol>: Get the tolerance for the problem.
   
   =item * B<tries>: Get the number of tries the user has already used on the problem.
   
 =item * B<type>: Get the question type for the problem.  =item * B<type>: Get the question type for the problem.
   
 =item * B<weight>: Get the weight for the problem.  =item * B<weight>: Get the weight for the problem.
Line 2156  sub tol { Line 2283  sub tol {
     (my $self, my $part) = @_;      (my $self, my $part) = @_;
     return $self->parmval("tol", $part);      return $self->parmval("tol", $part);
 }  }
 sub type {  
     (my $self, my $part) = @_;  
     return $self->parmval("type", $part);  
 }  
 sub weight {  
     (my $self, my $part) = @_;  
     return $self->parmval("weight", $part);  
 }  
 sub tries {  sub tries {
     my $self = shift;      my $self = shift;
     my $part = shift;      my $part = shift;
Line 2176  sub tries { Line 2295  sub tries {
     if (!defined($tries)) {return '0';}      if (!defined($tries)) {return '0';}
     return $tries;      return $tries;
 }  }
   sub type {
       (my $self, my $part) = @_;
       return $self->parmval("type", $part);
   }
   sub weight {
       (my $self, my $part) = @_;
       return $self->parmval("weight", $part);
   }
   
 # Multiple things need this  # Multiple things need this
 sub getReturnHash {  sub getReturnHash {
Line 2233  sub getFeedback { Line 2360  sub getFeedback {
   
 =pod  =pod
   
 =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)  =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)
   
 =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.  =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.
   
 =back  =back
   
Line 2244  sub getFeedback { Line 2371  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 2252  sub countParts { Line 2381  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 2263  sub extractParts { Line 2396  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 2295  Idiomatic usage of these two methods wou Line 2436  Idiomatic usage of these two methods wou
     my $dateStatus = $resource->getDateStatus($_);      my $dateStatus = $resource->getDateStatus($_);
     my $completionStatus = $resource->getCompletionStatus($_);      my $completionStatus = $resource->getCompletionStatus($_);
   
       or
   
       my $status = $resource->status($_);
   
     ... use it here ...      ... use it here ...
  }   }
   
 =over 4  =over 4
   
 =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. You should still check to see if there is a due date at all, if you care about that. The possible return values are:  =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
   
 =back  =back
   
Line 2395  B<Completion Codes> Line 2540  B<Completion Codes>
   
 =item * B<NETWORK_FAILURE>: Information not available due to network failure.  =item * B<NETWORK_FAILURE>: Information not available due to network failure.
   
   =item * B<ATTEMPTED>: Attempted, and not yet graded.
   
 =back  =back
   
 =cut  =cut
Line 2405  sub INCORRECT_BY_OVERRIDE { return 12; } Line 2552  sub INCORRECT_BY_OVERRIDE { return 12; }
 sub CORRECT               { return 13; }  sub CORRECT               { return 13; }
 sub CORRECT_BY_OVERRIDE   { return 14; }  sub CORRECT_BY_OVERRIDE   { return 14; }
 sub EXCUSED               { return 15; }  sub EXCUSED               { return 15; }
   sub ATTEMPTED             { return 16; }
   
 sub getCompletionStatus {  sub getCompletionStatus {
     my $self = shift;      my $self = shift;
Line 2423  sub getCompletionStatus { Line 2571  sub getCompletionStatus {
     if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }      if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
     if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }      if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
     if ($status eq 'excused') {return $self->EXCUSED; }      if ($status eq 'excused') {return $self->EXCUSED; }
       if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
     return $self->NOT_ATTEMPTED;      return $self->NOT_ATTEMPTED;
 }  }
   
Line 2434  Along with directly returning the date o Line 2583  Along with directly returning the date o
   
 =over 4  =over 4
   
 =item * NETWORK_FAILURE: The network has failed and the information is not available.  =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
   
 =item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)  =item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
   
 =item * CORRECT: For any reason at all, the part is considered correct.  =item * B<CORRECT>: For any reason at all, the part is considered correct.
   
 =item * EXCUSED: For any reason at all, the problem is excused.  =item * B<EXCUSED>: For any reason at all, the problem is excused.
   
 =item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.  =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
   
 =item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.  =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
   
 =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.  =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
   
 =item * OPEN_LATER: The problem is not yet open.  =item * B<OPEN_LATER>: The problem is not yet open.
   
 =item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.  =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
   
 =item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.  =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
   
 =item * OPEN: The item is open and not yet tried.  =item * B<OPEN>: The item is open and not yet tried.
   
   =item * B<ATTEMPTED>: The problem has been attempted.
   
 =back  =back
   
Line 2478  sub status { Line 2629  sub status {
     # There are a few whole rows we can dispose of:      # There are a few whole rows we can dispose of:
     if ($completionStatus == CORRECT ||      if ($completionStatus == CORRECT ||
         $completionStatus == CORRECT_BY_OVERRIDE ) {          $completionStatus == CORRECT_BY_OVERRIDE ) {
         return CORRECT();           return CORRECT; 
       }
   
       if ($completionStatus == ATTEMPTED) {
           return ATTEMPTED;
     }      }
   
     # If it's EXCUSED, then return that no matter what      # If it's EXCUSED, then return that no matter what
Line 2490  sub status { Line 2645  sub status {
         return NOTHING_SET;          return NOTHING_SET;
     }      }
   
     # Now we're down to a 3 (incorrect, incorrect_override, not_attempted)      # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
     # by 4 matrix (date status).      # by 4 matrix (date statuses).
   
     if ($dateStatus == PAST_DUE_ANSWER_LATER ||      if ($dateStatus == PAST_DUE_ANSWER_LATER ||
         $dateStatus == PAST_DUE_NO_ANSWER ) {          $dateStatus == PAST_DUE_NO_ANSWER ) {
Line 2547  sub getNext { Line 2702  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.63  
changed lines
  Added in v.1.70

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