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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.57 and 1.60

version 1.57, 2002/10/01 07:09:05 version 1.60, 2002/10/01 19:39:11
Line 848  sub new_handle { Line 848  sub new_handle {
     # Defines a status->color mapping, null string means don't color      # Defines a status->color mapping, null string means don't color
     my %colormap =       my %colormap = 
     ( $res->NETWORK_FAILURE        => '',      ( $res->NETWORK_FAILURE        => '',
       $res->CORRECT                => '#BBFFBB',        $res->CORRECT                => '',
       $res->EXCUSED                => '#BBBBFF',        $res->EXCUSED                => '#BBBBFF',
       $res->PAST_DUE_ANSWER_LATER  => '#FFAA00',        $res->PAST_DUE_ANSWER_LATER  => '',
       $res->PAST_DUE_NO_ANSWER     => '#FFAA00',        $res->PAST_DUE_NO_ANSWER     => '',
       $res->ANSWER_OPEN            => '#FF00AA',        $res->ANSWER_OPEN            => '#CCFFCC',
       $res->OPEN_LATER             => '',        $res->OPEN_LATER             => '',
       $res->TRIES_LEFT             => '#FFFF00',        $res->TRIES_LEFT             => '',
       $res->INCORRECT              => '#FFAA00',        $res->INCORRECT              => '',
       $res->OPEN                   => '#FFFF88',        $res->OPEN                   => '',
       $res->NOTHING_SET            => ''        );        $res->NOTHING_SET            => ''        );
       # And a special case in the nav map; what to do when the assignment
       # is not yet done and due in less then 24 hours
       my $hurryUpColor = "#FFCCCC";
   
       my %statusIconMap = 
    ( $res->NETWORK_FAILURE    => '',
     $res->NOTHING_SET        => '',
     $res->CORRECT            => 'navmap.correct.gif',
     $res->EXCUSED            => 'navmap.correct.gif',
     $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
     $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
     $res->ANSWER_OPEN        => 'navmap.wrong.gif',
     $res->OPEN_LATER         => '',
     $res->TRIES_LEFT         => 'navmap.open.gif',
     $res->INCORRECT          => 'navmap.wrong.gif',
     $res->OPEN               => 'navmap.open.gif' );
   
       my %condenseStatuses =
    ( $res->NETWORK_FAILURE    => 1,
     $res->NOTHING_SET        => 1,
     $res->CORRECT            => 1,
     $res->OPEN               => 1 );
   
     my %filterHash;      my %filterHash;
     # Figure out what we're not displaying      # Figure out what we're not displaying
Line 868  sub new_handle { Line 890  sub new_handle {
     }      }
   
     # Begin the HTML table      # Begin the HTML table
     # two columns: the title/icon on the left, the info on the right      # 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 $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);
     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;
     my $indentString = "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;";      my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\"/>";
   
     my $isNewBranch = 0;      my $isNewBranch = 0;
       my $now = time();
       my $in24Hours = $now + 24 * 60 * 60;
   
     while ($curRes != $mapIterator->END_NAV_MAP) {      while ($curRes != $mapIterator->END_NAV_MAP) {
         if ($curRes == $mapIterator->BEGIN_MAP() ||          if ($curRes == $mapIterator->BEGIN_MAP() ||
Line 894  sub new_handle { Line 918  sub new_handle {
   
         if (ref($curRes) && $curRes->src()) {          if (ref($curRes) && $curRes->src()) {
   
       # Step one: Decide which parts to show
             my @parts;              my @parts;
             if ($curRes->is_problem()) {              if ($curRes->is_problem()) {
    # Is it multipart?
                 @parts = @{$curRes->parts()};                  @parts = @{$curRes->parts()};
                 if (scalar(@parts) > 1) { shift(@parts); }  
    my $multipart = scalar(@parts) > 1;
   
    if ($multipart) {
       # If it's multipart, see if part 0 is "open"
       # if it is, display all parts, if it isn't,
       # just display first
       if (!$curRes->opendate("0")) {
    @parts = ("0"); # just display the zero-th part
       } else {
    # Otherwise, only display part 0 if we want to 
    # attach feedback or email information to it
    if (!$curRes->hasDiscussion() && !$curRes->getFeedback()) {
       shift @parts;
    } else {
       # 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
       my $status = $curRes->status($parts[0]);
       my $allSame = 1;
       for (my $i = 1; $i < scalar(@parts); $i++) {
    if ($curRes->status($parts[$i]) != $status){
       $allSame = 0;
    }
       }
       
       # $allSame is true if all the statuses were
       # the same. Now, if they are all the same and
       # match one of the statuses to condense, then
       # only display part 0.
       if ($allSame && defined($condenseStatuses{$status})){
    @parts = ("0");
       }
    }
       }
    }
   
             } else {              } else {
                 @parts[0] = "0"; # this is to get past foreach loop below                  @parts[0] = "0"; # this is to get past foreach loop below
                  # you can consider a non-problem resource as a resource                   # you can consider a non-problem resource as a resource
                  # with only one part without loss                   # with only one part without loss
             }              }
   
       # Step two: Show the parts
             foreach my $part (@parts) {              foreach my $part (@parts) {
   
    my $deltalevel = 0; # for inserting the branch icon
                                   
                 # For each thing we're displaying...                  # For each thing we're displaying...
   
Line 923  sub new_handle { Line 990  sub new_handle {
                 # If this is a new branch, label it so                  # If this is a new branch, label it so
                 # (temporary, this should be an icon w/ alt text)                  # (temporary, this should be an icon w/ alt text)
                 if ($isNewBranch) {                  if ($isNewBranch) {
                     $newBranchText = "NB -> ";                      $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
                     $isNewBranch = 0;                      $isNewBranch = 0;
       $deltalevel = 1;
                 }                  }
   
                 # links to open and close the folders                  # links to open and close the folders
Line 960  sub new_handle { Line 1028  sub new_handle {
                     }                      }
                 }                  }
   
    # FIRST ROW: The resource indentation, branch icon, and name
                 $r->print("  <tr><td align=\"left\" valign=\"top\">\n");                  $r->print("  <tr><td align=\"left\" valign=\"top\">\n");
   
                 # print indentation                  # print indentation
                 for (my $i = 0; $i < $indentLevel; $i++) {                  for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
                     $r->print($indentString);                      $r->print($indentString);
                 }                  }
   
Line 972  sub new_handle { Line 1041  sub new_handle {
   
                 if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }                  if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }
   
                 $r->print("  <a href=\"$link\">$title$partLabel</a></td>".                  $r->print("  <a href=\"$link\">$title$partLabel</a></td>");
                           "<td $colorizer align=\"right\">\n");  
    my $discussionHTML = ""; my $feedbackHTML = "";
   
    # SECOND ROW: 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\">$discussionHTML$feedbackHTML</td>");
   
    # THIRD ROW: Problem status icon
    if ($curRes->is_problem()) {
       my $icon = $statusIconMap{$curRes->status()};
       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
    $r->print("<td $colorizer align=\"right\">\n");
                                   
                 if ($curRes->kind() eq "res" and                   if ($curRes->kind() eq "res" and 
                     $curRes->is_problem() ) {                      $curRes->is_problem() ) {
                     $r->print (getDescription($curRes, $part));                      $r->print (getDescription($curRes, $part));
                 }                  }
   
    $r->print("</td></tr>\n");
             }              }
         }          }
         $curRes = $mapIterator->next();          $curRes = $mapIterator->next();
Line 986  sub new_handle { Line 1094  sub new_handle {
   
     $r->print("</table></body></html>");      $r->print("</table></body></html>");
   
       $navmap->untieHashes();
   
     return OK;      return OK;
 }  }
   
Line 1054  sub getDescription { Line 1164  sub getDescription {
         return "Opens: " . timeToHumanString($res->opendate($part));          return "Opens: " . timeToHumanString($res->opendate($part));
     }      }
     if ($status == $res->OPEN) {      if ($status == $res->OPEN) {
         return "Due: $status " . timeToHumanString($res->duedate($part));   if ($res->duedate()) {
       return "Due: $status " . timeToHumanString($res->duedate($part));
    } else {
       return "Open, no due date";
    }
     }      }
     if ($status == $res->PAST_DUE_ANSWER_LATER) {      if ($status == $res->PAST_DUE_ANSWER_LATER) {
         return "Answer: " . timeToHumanString($res->answerdate($part));          return "Answer opens: " . timeToHumanString($res->answerdate($part));
     }      }
     if ($status == $res->PAST_DUE_NO_ANSWER) {      if ($status == $res->PAST_DUE_NO_ANSWER) {
         return "Was Due: " . timeToHumanString($res->duedate($part));          return "Was Due: " . timeToHumanString($res->duedate($part));
Line 1065  sub getDescription { Line 1179  sub getDescription {
     if ($status == $res->ANSWER_OPEN) {      if ($status == $res->ANSWER_OPEN) {
         return "Answer available";          return "Answer available";
     }      }
       if ($status == $res->EXCUSED) {
    return "Excused by instructor";
       }
       if ($status == $res->TRIES_LEFT) {
    my $tries = $res->tries();
    my $maxtries = $res->maxtries();
    my $triesString = "($tries of $maxtries tries used)";
    if ($res->duedate()) {
       return "Due: $status " . timeToHumanString($res->duedate($part)) .
    " $triesString";
    } else {
       return "No due date $triesString";
    }
       }
 }  }
   
 # 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.
 sub timeToHumanString {  sub timeToHumanString {
     return localtime(shift);      my ($time) = @_;
       # zero, '0' and blank are bad times
       if ($time) {
    return localtime($time);
       } else {
    return 'Never';
       }
 }  }
   
 1;  1;
Line 1138  sub new { Line 1272  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};
         return undef;          return undef;
     }      }
     $self->{PARM_HASH} = \%parmhash;      $self->{PARM_HASH} = \%parmhash;
Line 1271  sub getIterator { Line 1406  sub getIterator {
 # unties the hash when done  # unties the hash when done
 sub untieHashes {  sub untieHashes {
     my $self = shift;      my $self = shift;
     untie $self->{NAV_HASH} if ($self->{HASH_TIED});      untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
     untie $self->{PARM_HASH} if ($self->{HASH_TIED});      untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
     $self->{HASH_TIED} = 0;      $self->{HASH_TIED} = 0;
 }  }
   
Line 1282  sub DESTROY { Line 1417  sub DESTROY {
     $self->untieHashes();      $self->untieHashes();
 }  }
   
   # Private function: Does the given resource (as a symb string) have
   # current discussion? Returns 0 if chat/mail data not extracted.
   sub hasDiscussion {
       my $self = shift;
       my $symb = shift;
       if (!defined($self->{DISCUSSION_TIME})) { return 0; }
   
       return $self->{DISCUSSION_TIME}->{$symb} >
      $self->{LAST_CHECK};
   }
   
   # Private function: Does the given resource (as a symb string) have
   # current feedback? Returns the string in the feedback hash, which
   # will be false if it does not exist.
   sub getFeedback { 
       my $self = shift;
       my $symb = shift;
   
       if (!defined($self->{FEEDBACK})) { return ""; }
       
       return $self->{FEEDBACK}->{$symb};
   }
   
 =pod  =pod
   
 =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.  =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
Line 2014  Misc. functions for the resource. Line 2172  Misc. functions for the resource.
   
 =over 4  =over 4
   
   =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
   
   =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
   
    for (split(/\,/, $res->getFeedback())) {
       my $link = &Apache::lonnet::escape($_);
       ...
   
   and use the link as appropriate.
   
   =cut
   
   sub hasDiscussion {
       my $self = shift;
       return $self->{NAV_MAP}->hasDiscussion($self->symb());
   }
   
   sub getFeedback {
       my $self = shift;
       return $self->{NAV_MAP}->getFeedback($self->symb());
   }
   
   =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. You may or may not wish to filter out 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.  =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.
Line 2081  Idiomatic usage of these two methods wou Line 2263  Idiomatic usage of these two methods wou
   
 =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, with the following possible results:  =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:
   
 =back  =back
   
Line 2093  B<Date Codes> Line 2275  B<Date Codes>
   
 =item * B<OPEN>: Open and not yet due.  =item * B<OPEN>: Open and not yet due.
   
   
 =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.  =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
   
 =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.  =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
Line 2140  sub getDateStatus { Line 2323  sub getDateStatus {
         # should this be the same as "open later"? think multipart.          # should this be the same as "open later"? think multipart.
         return $self->NOTHING_SET;          return $self->NOTHING_SET;
     }      }
     if (!$open || $now < $open) {return $self->OPEN_LATER};      if (!$open || $now < $open) {return $self->OPEN_LATER}
     if (!$due || $now < $due) {return $self->OPEN};      if (!$due || $now < $due) {return $self->OPEN}
     if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER};      if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
     if ($answer) { return $self->ANSWER_OPEN; };      if ($answer) { return $self->ANSWER_OPEN; }
     return PAST_DUE_NO_ANSWER;      return PAST_DUE_NO_ANSWER;
 }  }
   
Line 2216  Along with directly returning the date o Line 2399  Along with directly returning the date o
   
 =item * NETWORK_FAILURE: The network has failed and the information is not available.  =item * 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.)  =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 * CORRECT: For any reason at all, the part is considered correct.  =item * CORRECT: For any reason at all, the part is considered correct.
   
Line 2274  sub status { Line 2457  sub status {
     # by 4 matrix (date status).      # by 4 matrix (date status).
   
     if ($dateStatus == PAST_DUE_ANSWER_LATER ||      if ($dateStatus == PAST_DUE_ANSWER_LATER ||
         $dateStatus == PAST_DUE_NO_ANSWER) {          $dateStatus == PAST_DUE_NO_ANSWER ) {
         return $dateStatus;           return $dateStatus; 
     }      }
   
Removed from v.1.57  
changed lines
  Added in v.1.60

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