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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.132 and 1.133

version 1.132, 2003/01/30 21:36:57 version 1.133, 2003/01/31 22:46:50
Line 49  use POSIX qw (floor strftime); Line 49  use POSIX qw (floor strftime);
 my %navmaphash;  my %navmaphash;
 my %parmhash;  my %parmhash;
   
   # symbolic constants
   sub SYMB { return 1; }
   sub URL { return 2; }
   sub NOTHING { return 3; }
   
   # Some data
   
   
 sub cleanup {  sub cleanup {
     if (tied(%navmaphash)){      if (tied(%navmaphash)){
  &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');   &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
Line 145  sub real_handler { Line 153  sub real_handler {
     }      }
   
     # Determine where the "here" marker is and where the screen jumps to.      # Determine where the "here" marker is and where the screen jumps to.
     my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants      my $hereType; # the type of marker, SYMB, URL, or NOTHING
     my $hereType; # the type of marker, $SYMB, $URL, or $NOTHING  
     my $here; # the actual URL or SYMB for the here marker      my $here; # the actual URL or SYMB for the here marker
     my $jumpType; # The type of the thing we have a jump for, $SYMB or $URL      my $jumpType; # The type of the thing we have a jump for, SYMB or URL
     my $jump; # the SYMB/URL of the resource we need to jump to      my $jump; # the SYMB/URL of the resource we need to jump to
   
     if ( $ENV{'form.alreadyHere'} ) { # we came from a user's manipulation of the nav page      if ( $ENV{'form.alreadyHere'} ) { # we came from a user's manipulation of the nav page
Line 156  sub real_handler { Line 163  sub real_handler {
         # from the querystring, and get the new "jump" marker          # from the querystring, and get the new "jump" marker
         $hereType = $ENV{'form.hereType'};          $hereType = $ENV{'form.hereType'};
         $here = $ENV{'form.here'};          $here = $ENV{'form.here'};
         $jumpType = $ENV{'form.jumpType'} || $NOTHING;          $jumpType = $ENV{'form.jumpType'} || NOTHING();
         $jump = $ENV{'form.jump'};          $jump = $ENV{'form.jump'};
     } else { # the user is visiting the nav map from the remote      } else { # the user is visiting the nav map from the remote
         # We're coming from the remote. We have either a url, a symb, or nothing,          # We're coming from the remote. We have either a url, a symb, or nothing,
Line 164  sub real_handler { Line 171  sub real_handler {
         # Preference: Symb          # Preference: Symb
                   
         if ($ENV{'form.symb'}) {          if ($ENV{'form.symb'}) {
             $hereType = $jumpType = $SYMB;              $hereType = $jumpType = SYMB();
             $here = $jump = $ENV{'form.symb'};              $here = $jump = $ENV{'form.symb'};
         } elsif ($ENV{'form.postdata'}) {          } elsif ($ENV{'form.postdata'}) {
             # couldn't find a symb, is there a URL?              # couldn't find a symb, is there a URL?
Line 172  sub real_handler { Line 179  sub real_handler {
             $currenturl=~s/^http\:\/\///;              $currenturl=~s/^http\:\/\///;
             $currenturl=~s/^[^\/]+//;              $currenturl=~s/^[^\/]+//;
   
             $hereType = $jumpType = $URL;              $hereType = $jumpType = URL;
             $here = $jump = $currenturl;              $here = $jump = $currenturl;
         } else {          } else {
             # Nothing              # Nothing
             $hereType = $jumpType = $NOTHING;              $hereType = $jumpType = NOTHING();
         }          }
     }      }
   
Line 291  sub real_handler { Line 298  sub real_handler {
     $mapIterator->next(); # discard the first BEGIN_MAP      $mapIterator->next(); # discard the first BEGIN_MAP
     my $curRes = $mapIterator->next();      my $curRes = $mapIterator->next();
     my $counter = 0;      my $counter = 0;
     my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one      my $foundJump = ($jumpType == NOTHING()); # look for jump point if we have one
     my $looped = 0;       my $looped = 0; 
   
     # We only need to do this if we need to open the maps to show the      # We only need to do this if we need to open the maps to show the
Line 302  sub real_handler { Line 309  sub real_handler {
         if ($curRes == $mapIterator->END_MAP()) { $depth--; }          if ($curRes == $mapIterator->END_MAP()) { $depth--; }
   
         if (ref($curRes) && !$ENV{'form.alreadyHere'} &&           if (ref($curRes) && !$ENV{'form.alreadyHere'} && 
             ($hereType == $SYMB && $curRes->symb() eq $here) ||              ($hereType == SYMB() && $curRes->symb() eq $here) ||
             (ref($curRes) && $hereType == $URL && $curRes->src() eq $here)) {              (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {
             my $mapStack = $mapIterator->getStack();              my $mapStack = $mapIterator->getStack();
                           
             # Ensure the parent maps are open              # Ensure the parent maps are open
Line 332  sub real_handler { Line 339  sub real_handler {
         if (ref($curRes)) { $counter++; }          if (ref($curRes)) { $counter++; }
   
         if (ref($curRes) &&           if (ref($curRes) && 
             (($jumpType == $SYMB && $curRes->symb() eq $jump) ||              (($jumpType == SYMB() && $curRes->symb() eq $jump) ||
             ($jumpType == $URL && $curRes->src() eq $jump))) {              ($jumpType == URL() && $curRes->src() eq $jump))) {
             # If this is the correct resource, be sure to               # If this is the correct resource, be sure to 
             # show it by making sure the containing maps              # show it by making sure the containing maps
             # are open.              # are open.
Line 542  sub real_handler { Line 549  sub real_handler {
                         removeFromFilter(\%filterHash, $mapId);                          removeFromFilter(\%filterHash, $mapId);
                     $linkopen .= "&condition=$condition&$queryAdd" .                       $linkopen .= "&condition=$condition&$queryAdd" . 
                         "&hereType=$hereType&here=" .                           "&hereType=$hereType&here=" . 
                         Apache::lonnet::escape($here) . "&jumpType=$SYMB&" .                          Apache::lonnet::escape($here) . "&jumpType=".SYMB()."&" .
                         "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">";                          "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">";
                     $linkclose = "</a>";                      $linkclose = "</a>";
   
Line 591  sub real_handler { Line 598  sub real_handler {
   
                 # Is this the current resource?                  # Is this the current resource?
                 if (!$displayedHereMarker &&                   if (!$displayedHereMarker && 
                     (($hereType == $SYMB && $curRes->symb eq $here) ||                      (($hereType == SYMB() && $curRes->symb eq $here) ||
                     ($hereType == $URL && $curRes->src eq $here))) {                      ($hereType == URL() && $curRes->src eq $here))) {
                     $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';                      $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';
                     $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';                      $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';
                     $displayedHereMarker = 1;                      $displayedHereMarker = 1;
Line 700  sub real_handler { Line 707  sub real_handler {
         $r->print('<script>location += "#curloc";</script>');          $r->print('<script>location += "#curloc";</script>');
     }      }
   
       # renderer call
       $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0);
       my $render = render({ 'cols' => [0,1,2,3], 'iterator' => $mapIterator,
                             'url' => '/adm/navmaps', 
                             'queryString' => 'alreadyHere=1' });
       $r->print('|' . $render . '|');
   
     $navmap->untieHashes();      $navmap->untieHashes();
   
     $r->print("</body></html>");      $r->print("</body></html>");
Line 950  sub timeToHumanString { Line 964  sub timeToHumanString {
     }      }
 }  }
   
   
   =pod
   
   =head1 navmap renderer
   
   The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this. 
   
   Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors.
   
   The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}).
   
   =head2 Overview of Columns
   
   The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table.
   
   Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer.
   
   At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it.
   
   The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist:
   
   =over 4
   
   =item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash:
   
   =over 4
   
   =item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links.
   
   =item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count.
   
   =back
   
   =item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map.
   
   =item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap.
   
   =item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap.
   
   =back
   
   If you add any others please be sure to document them here.
   
   An example of a column renderer that will show the ID number of a resource, along with the part name if any:
   
    sub { 
     my ($resource, $part, $params) = @_;   
     if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
     return '<td>' . $resource->{ID} . '</td>';
    }
   
   Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc.
   
   =head2 Parameters
   
   =over 4
   
   =item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like.
   
   =item * B<cols>: An array reference
   
   =item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed.
   
   =item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored.
   
   =item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL.
   
   =item * B<hereURL>: A URL identifying where to place the 'here' marker.
   
   =item * B<hereSymb>: A Symb identifying where to place the 'here' marker.
   
   =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.
   
   =item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed.
   
   =item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown.
   
   =back
   
   =head2 Additional Info
   
   In addition to the parameters you can pass to the renderer, which will be passed through unchange to the column renderers, the renderer will generate the following information which your renderer may find useful:
   
   =over 4
   
   =back
   
   =cut
   
   sub resource { return 0; }
   sub communication_status { return 1; }
   sub quick_status { return 2; }
   sub long_status { return 3; }
   
   # Data for render_resource
   
   my $resObj = 'Apache::lonnavmaps::resource';
   # Defines a status->color mapping, null string means don't color
   my %colormap = 
       ( $resObj->NETWORK_FAILURE        => '',
         $resObj->CORRECT                => '',
         $resObj->EXCUSED                => '#3333FF',
         $resObj->PAST_DUE_ANSWER_LATER  => '',
         $resObj->PAST_DUE_NO_ANSWER     => '',
         $resObj->ANSWER_OPEN            => '#006600',
         $resObj->OPEN_LATER             => '',
         $resObj->TRIES_LEFT             => '',
         $resObj->INCORRECT              => '',
         $resObj->OPEN                   => '',
         $resObj->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 = "#FF0000";
   
   sub render_resource {
       my ($resource, $part, $params) = @_;
   
       my $nonLinkedText = ''; # stuff after resource title not in link
   
       my $it = $params->{'iterator'};
       my $filter = $it->{FILTER};
       my $stack = $it->getStack();
       my $src = getLinkForResource($stack);
   
       my $srcHasQuestion = $src =~ /\?/;
       my $link = $src.
           ($srcHasQuestion?'&':'?') .
           'symb=' . &Apache::lonnet::escape($resource->symb()).
           '"';
   
       my $title = $resource->compTitle();
       if ($src =~ /^\/uploaded\//) {
           $nonLinkedText=$title;
           $title = '';
       }
       my $partLabel = "";
       my $newBranchText = "";
       
       # If this is a new branch, label it so
       if ($params->{'isNewBranch'}) {
           $newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />";
           $params->{'isNewBranch'} = 0;
       }
   
       # links to open and close the folder
       my $linkopen = "<a href='$link'>";
       my $linkclose = "</a>";
   
       # Default icon: HTML page
       my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";
       
       if ($resource->is_problem()) {
           if ($part eq "0" || $params->{'condensed'}) {
               $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
           } else {
               $icon = $params->{'indentString'};
           }
       }
   
       # Display the correct map icon to open or shut map
       if ($resource->is_map()) {
           my $mapId = $resource->map_pc();
           my $nowOpen = !defined($filter->{$mapId});
           if ($it->{CONDITION}) {
               $nowOpen = !$nowOpen;
           }
           $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif';
           $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
           
           $linkopen = "<a href='" . $params->{'url'} . '?' . 
               $params->{'queryString'} . '&filter=';
           $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
               addToFilter($filter, $mapId) :
               removeFromFilter($filter, $mapId);
           $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
               . $params->{'hereType'} . '&here=' .
               &Apache::lonnet::escape($params->{'here'}) . 
               '&jumpType=' . SYMB() . '&jump=' .
               &Apache::lonnet::escape($params->{$resource->symb()}) . "'>";
       }
   
       if ($resource->randomout()) {
           $nonLinkedText .= ' <i>(hidden)</i> ';
       }
       
       # We're done preparing and finally ready to start the rendering
       my $result = "<td align='left' valign='center'>";
       
       # print indentation
       for (my $i = 0; $i < $params->{'indentLevel'} - 
                            $params->{'deltaLevel'}; $i++) {
           $result .= $params->{'indentString'};
       }
   
       # Decide what to display
       $result .= "$newBranchText$linkopen$icon$linkclose";
       
       my $curMarkerBegin = '';
       my $curMarkerEnd = '';
   
       # Is this the current resource?
       if (!$params->{'displayedHereMarker'} &&
           (($params->{'hereType'} == SYMB() && 
             $resource->symb() eq $params->{'here'}) ||
            ($params->{'hereType'} == URL() &&
             $resource->src() eq $params->{'here'}))) {
           $curMarkerBegin = '<font color="red" size="+2">&gt; </font>';
           $curMarkerEnd = '<font color="red" size="+2">&lt;</font>';
       }
   
       if ($resource->is_problem() && $part ne "0" && 
           !$params->{'condensed'}) {
           $partLabel = " (Part $part)";
           $title = "";
       }
   
       if ($params->{'multipart'} && $params->{'condensed'}) {
           $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
       }
   
       $result .= "  $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText";
   
       return $result;
   }
   
   sub render_communication_status {
       my ($resource, $part, $params) = @_;
       return "<td align='center'>comm_status</td>";
   }
   sub render_quick_status {
       my ($resource, $part, $params) = @_;
       return "<td align='center'>quick_status</td>";
   }
   sub render_long_status {
       my ($resource, $part, $params) = @_;
       return "<td align='center'>long_status</td>";
   }
   
   my @preparedColumns = (\&render_resource, \&render_communication_status,
                          \&render_quick_status, \&render_long_status);
   
   sub setDefault {
       my ($val, $default) = @_;
       if (!defined($val)) { return $default; }
       return $val;
   }
   
   sub render {
       my $args = shift;
       
       # Configure the renderer.
       my $cols = $args->{'cols'};
       if (!defined($cols)) {
           # no columns, no nav maps.
           return '';
       }
       my $it = $args->{'iterator'};
       if (!defined($it)) {
           # no iterator, no nav map.
           return '';
       }
       
       my $showParts = setDefault($args->{'showParts'}, 1);
       my $condenseParts = setDefault($args->{'condenseParts'}, 1);
       my $jumpToURL = $args->{'jumpToURL'};
       my $jumpToSymb = $args->{'jumpToSymb'};
       my $hereURL = $args->{'hereURL'};
       my $hereSymb = $args->{'hereSymb'};
       
       #if (defined($jumpToURL)) {
       #    $args->{'jumpType'} = 
               
       # End parameter setting
               
       # Data
       my $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
       my $res = "Apache::lonnavmaps::resource";
       my %condenseStatuses =
           ( $res->NETWORK_FAILURE    => 1,
             $res->NOTHING_SET        => 1,
             $res->CORRECT            => 1 );
       my @backgroundColors = ("#FFFFFF", "#F6F6F6");
       my $currentJumpIndex = 0; # keeps track of when the current resource is found,
                                # so we can back up a few and put the anchor above the
                                # current resource
       my $currentJumpDelta = 2; # change this to change how many resources are displayed
                                # before the current resource when using #current
   
       # Shared variables
       $args->{'counter'} = 0; # counts the rows
       $args->{'indentLevel'} = 0;
       $args->{'isNewBranch'} = 0;
       $args->{'condensed'} = 0;    
       $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");
       $args->{'displayedHereMarker'} = 0;
   
       my $displayedJumpMarker = 0;
       # Set up iteration.
       my $depth = 1;
       $it->next(); # discard initial BEGIN_MAP
       my $curRes = $it->next();
       my $now = time();
       my $in24Hours = $now + 24 * 60 * 60;
       my $rownum = 0;
   
       while ($depth > 0) {
           if ($curRes == $it->BEGIN_MAP()) { $depth++; }
           if ($curRes == $it->END_MAP()) { $depth--; }
   
           # Maintain indentation level.
           if ($curRes == $it->BEGIN_MAP() ||
               $curRes == $it->BEGIN_BRANCH() ) {
               $args->{'indentLevel'}++;
           }
           if ($curRes == $it->END_MAP() ||
               $curRes == $it->END_BRANCH() ) {
               $args->{'indentLevel'}--;
           }
           # Notice new branches
           if ($curRes == $it->BEGIN_BRANCH()) {
               $args->{'isNewBranch'} = 1;
           }
   
           # If this isn't an actual resource, continue on
           if (!ref($curRes)) {
               $curRes = $it->next();
               next;
           }
   
           $args->{'counter'}++;
           # reserve space for branch symbol
           $args->{'deltalevel'} = $args->{'isNewBranch'}? 1 : 0; 
           if ($args->{'indentLevel'} - $args->{'deltalevel'} < 0) {
               # If this would be at a negative depth (top-level maps in
               # new-style courses, we want to suppress their title display)
               # then ignore it.
               $curRes = $it->next();
               next;
           }
   
           # Does it have multiple parts?
           $args->{'multipart'} = 0;
           $args->{'condensed'} = 0;
           my @parts;
               
           # Decide what parts to show.
           if ($curRes->is_problem() && $showParts) {
               @parts = @{$curRes->parts()};
               $args->{'multipart'} = scalar(@parts) > 1;
               
               if ($condenseParts) { # do the condensation
                   if (!$curRes->opendate("0")) {
                       @parts = ("0");
                       $args->{'condensed'} = 1;
                   }
                   if (!$args->{'condensed'}) {
                       # Decide whether to condense based on similarity
                       my $status = $curRes->status($parts[1]);
                       my $due = $curRes->duedate($parts[1]);
                       my $open = $curRes->opendate($parts[1]);
                       my $statusAllSame = 1;
                       my $dueAllSame = 1;
                       my $openAllSame = 1;
                       for (my $i = 2; $i < scalar(@parts); $i++) {
                           if ($curRes->status($parts[$i]) != $status){
                               $statusAllSame = 0;
                           }
                           if ($curRes->duedate($parts[$i]) != $due ) {
                               $dueAllSame = 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
                       # match one of the statuses to condense, or they
                       # are all open with the same due date, or they are
                       # all OPEN_LATER with the same open date, display the
                       # status of the first non-zero part (to get the 'correct'
                       # status right, since 0 is never 'correct' or 'open').
                       if (($statusAllSame && defined($condenseStatuses{$status})) ||
                           ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
                           ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
                           @parts = ($parts[1]);
                           $args->{'condensed'} = 1;
                       }
                       
                   }
               }
               
           } else {
               # Not showing parts
               @parts = ("0"); # show main part only
           }
   
           # If the multipart problem was condensed, "forget" it was multipart
           if (scalar(@parts) == 1) {
               $args->{'multipart'} = 0;
           }
   
           # In the event of a network error, display one part.
           # If this is a single part, we can at least show the correct
           # status, but if it's multipart, we're lost, since we can't
           # retreive the metadata to count the parts
           if ($curRes->{RESOURCE_ERROR}) {
               @parts = ("0");
           }
   
           # Now, we've decided what parts to show. Loop through them and
           # show them.
           foreach my $part (@parts) {
               $rownum ++;
               my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
               
               $result .= "  <tr bgcolor='$backgroundColor'>\n";
               
               # Now, display each column.
               foreach my $col (@$cols) {
                   $result .= "    <td>";
   
                   # If this is the first column and it's time to print
                   # the anchor, do so
                   if ($col == $cols->[0] && 
                       $args->{'counter'} == $args->{'currentJumpIndex'} - 
                       $args->{'currentJumpDelta'}) {
                       $result .= '<a name="curloc" />';
                       $displayedJumpMarker = 1;
                   }
   
   
                   if (ref($col)) {
                       $result .= &$col($curRes, $part, $args);
                   } else {
                       $result .= &{$preparedColumns[$col]}($curRes, $part, $args);
                   }
   
                   $result .= "</td>\n";
               }
   
               $result .= "  </tr>\n";
           }
           
   
           $curRes = $it->next();
       }
       
       $result .= "</table>";
   
       return $result;
   }
   
 1;  1;
   
 package Apache::lonnavmaps::navmap;  package Apache::lonnavmaps::navmap;
Line 1222  sub getById { Line 1688  sub getById {
     }      }
   
     # resource handles inserting itself into cache.      # resource handles inserting itself into cache.
     return Apache::lonnavmaps::resource->new($self, $id);      # Not clear why the quotes are necessary, but as of this
       # writing it doesn't work without them.
       return "Apache::lonnavmaps::resource"->new($self, $id);
 }  }
   
 =pod  =pod
Line 1349  sub parmval_real { Line 1817  sub parmval_real {
     return '';      return '';
 }  }
   
   
 1;  
   
 package Apache::lonnavmaps::renderer;  
   
 =pod  
   
 =head1 navmap renderer  
   
 The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this.   
   
 Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors.  
   
 The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}).  
   
 =head2 Overview of Columns  
   
 The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table.  
   
 Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer.  
   
 At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it.  
   
 The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist:  
   
 =over 4  
   
 =item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash:  
   
 =over 4  
   
 =item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links.  
   
 =item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count.  
   
 =back  
   
 =item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map.  
   
 =item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap.  
   
 =item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap.  
   
 =back  
   
 If you add any others please be sure to document them here.  
   
 An example of a column renderer that will show the ID number of a resource, along with the part name if any:  
   
  sub {   
   my ($resource, $part, $params) = @_;     
   if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }  
   return '<td>' . $resource->{ID} . '</td>';  
  }  
   
 Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc.  
   
 =head2 Parameters  
   
 =over 4  
   
 =item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like.  
   
 =item * B<cols>: An array reference  
   
 =item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed.  
   
 =item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored.  
   
 =item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL.  
   
 =item * B<hereURL>: A URL identifying where to place the 'here' marker.  
   
 =item * B<hereSymb>: A Symb identifying where to place the 'here' marker.  
   
 =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.  
   
 =back  
   
 =cut  
   
 sub resource { return 0; }  
 sub communication_status { return 1; }  
 sub quick_status { return 2; }  
 sub long_status { return 3; }  
   
 sub setDefault {  
     my ($val, $default) = @_;  
     if (!defined($val)) { return $default; }  
     return $val;  
 }  
   
 sub render {  
     my $args = shift;  
       
     # Configure the renderer.  
     my $cols = $args->{'cols'};  
     if (!defined($cols)) {  
         # no columns, no nav maps.  
         return '';  
     }  
     my $it = $args->{'iterator'};  
     if (!defined($it)) {  
         # no iterator, no nav map.  
         return '';  
     }  
       
     my $showParts = setDefault($args->{'showParts'}, 1);  
     my $condenseParts = setDefault($args->{'condenseParts'}, 1);  
     my $jumpToURL = $args->{'jumpToURL'};  
     my $jumpToSymb = $args->{'jumpToSymb'};  
     my $indentString = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");  
   
     # End parameter setting  
   
     # Data  
     my $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";  
     my $res = "Apache::lonnavmaps::resource";  
     my %condenseStatuses =  
         ( $res->NETWORK_FAILURE    => 1,  
           $res->NOTHING_SET        => 1,  
           $res->CORRECT            => 1 );  
     my @backgroundColors = ("#FFFFFF", "#F6F6F6");  
   
     # Set up iteration.  
     my $depth = 1;  
     $it->next(); # discard initial BEGIN_MAP  
     my $curRes = $it->next();  
     my $indentLevel = 0;  
     my $isNewBranch = 0;  
     my $now = time();  
     my $in24Hours = $now + 24 * 60 * 60;  
     my $displayedHereMarker = 0;  
     my $displayedJumpMarker = 0;  
     my $rownum = 0;  
   
     while ($depth > 0) {  
         if ($curRes == $it->BEGIN_MAP()) { $depth++; }  
         if ($curRes == $it->END_MAP()) { $depth--; }  
   
         # Maintain indentation level.  
         if ($curRes == $it->BEGIN_MAP() ||  
             $curRes == $it->BEGIN_BRANCH() ) {  
             indentLevel++;  
         }  
         if ($curRes == $it->END_MAP() ||  
             $curRes == $it->END_BRANCH() ) {  
             $indentLevel--;  
         }  
         # Notice new branches  
         if ($curRes == $it->BEGIN_BRANCH()) {  
             $isNewBranch = 1;  
         }  
           
         my $deltalevel = $isNewBranch? 1 : 0; # reserve space for branch symbol  
         if ($indentLevel - $deltalevel < 0) {  
             # If this would be at a negative depth (top-level maps in  
             # new-style courses, we want to suppress their title display)  
             # then ignore it.  
             $curRes = $it->next();  
             next;  
         }  
   
         # Does it have multiple parts?  
         my $multipart = 0;  
         my $condensed = 0;  
         my @parts;  
               
         # Decide what parts to show.  
         if ($showParts) {  
             @parts = @{$curRes->parts()};  
             $multipart = scalar(@parts) > 1;  
               
             if ($condenseParts) { # do the condensation  
                 if (!$curRes->opendate("0")) {  
                     @parts = ("0");  
                     $condensed = 1;  
                 }  
                 if (!$condensed) {  
                     # Decide whether to condense based on similarity  
                     my $status = $curRes->status($parts[1]);  
                     my $due = $curRes->duedate($parts[1]);  
                     my $open = $curRes->opendate($parts[1]);  
                     my $statusAllSame = 1;  
                     my $dueAllSame = 1;  
                     my $openAllSame = 1;  
                     for (my $i = 2; $i < scalar(@parts); $i++) {  
                         if ($curRes->status($parts[$i]) != $status){  
                             $statusAllSame = 0;  
                         }  
                         if ($curRes->duedate($parts[$i]) != $due ) {  
                             $dueAllSame = 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  
                     # match one of the statuses to condense, or they  
                     # are all open with the same due date, or they are  
                     # all OPEN_LATER with the same open date, display the  
                     # status of the first non-zero part (to get the 'correct'  
                     # status right, since 0 is never 'correct' or 'open').  
                     if (($statusAllSame && defined($condenseStatuses{$status})) ||  
                         ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||  
                         ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){  
                         @parts = ($parts[1]);  
                         $condensed = 1;  
                     }  
                       
                 }  
             }  
               
         } else {  
             # Not showing parts  
             @parts = ("0"); # show main part only  
         }  
   
         # If the multipart problem was condensed, "forget" it was multipart  
         if (scalar(@parts) == 1) {  
             $multipart = 0;  
         }  
   
         # In the event of a network error, display one part.  
         # If this is a single part, we can at least show the correct  
         # status, but if it's multipart, we're lost, since we can't  
         # retreive the metadata to count the parts  
         if ($curRes->{RESOURCE_ERROR}) {  
             @parts = ("0");  
         }  
   
         # Now, we've decided what parts to show. Loop through them and  
         # show them.  
         foreach my $part (@parts) {  
             $rownum ++;  
             my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];  
               
             $result .= "  <tr bgcolor='$backgroundColor'>\n";  
               
             # Now, display each column.  
             foreach my $col (@$cols) {  
                 $result .= "    <td>";  
   
                 # Decide what to display  
                   
   
                 $result .= "</td>\n";  
             }  
   
             $result .= "  </tr>\n";  
         }  
           
   
         $curRes = $it->next();  
     }  
       
     $result .= "</table>";  
   
     return $result;  
 }  
   
 sub render_resource {  
     my ($resource, $part, $params) = @_;  
     return "<td align='center'>resource</td>";  
 }  
 sub render_communication_status {  
     my ($resource, $part, $params) = @_;  
     return "<td align='center'>comm_status</td>";  
 }  
 sub render_quick_status {  
     my ($resource, $part, $params) = @_;  
     return "<td align='center'>quick_status</td>";  
 }  
 sub render_long_status {  
     my ($resource, $part, $params) = @_;  
     return "<td align='center'>long_status</td>";  
 }  
   
 my @preparedColumns = (\&render_resource, \&render_communication_status,  
                        \&render_quick_status, \&render_long_status);  
   
 1;  1;
   
 package Apache::lonnavmaps::iterator;  package Apache::lonnavmaps::iterator;
Removed from v.1.132  
changed lines
  Added in v.1.133

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