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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.116 and 1.145

version 1.116, 2002/11/26 16:25:36 version 1.145, 2003/02/21 20:05:00
Line 46  use Apache::Constants qw(:common :http); Line 46  use Apache::Constants qw(:common :http);
 use Apache::loncommon();  use Apache::loncommon();
 use POSIX qw (floor strftime);  use POSIX qw (floor strftime);
   
   my %navmaphash;
   my %parmhash;
   
   # symbolic constants
   sub SYMB { return 1; }
   sub URL { return 2; }
   sub NOTHING { return 3; }
   
   # Some data
   
   my $resObj = "Apache::lonnavmaps::resource";
   
   # Keep these mappings in sync with lonquickgrades, which uses the colors
   # instead of the icons.
   my %statusIconMap = 
       ( $resObj->NETWORK_FAILURE    => '',
         $resObj->NOTHING_SET        => '',
         $resObj->CORRECT            => 'navmap.correct.gif',
         $resObj->EXCUSED            => 'navmap.correct.gif',
         $resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
         $resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
         $resObj->ANSWER_OPEN        => 'navmap.wrong.gif',
         $resObj->OPEN_LATER         => '',
         $resObj->TRIES_LEFT         => 'navmap.open.gif',
         $resObj->INCORRECT          => 'navmap.wrong.gif',
         $resObj->OPEN               => 'navmap.open.gif',
         $resObj->ATTEMPTED          => 'navmap.open.gif' );
   
   my %iconAltTags = 
       ( 'navmap.correct.gif' => 'Correct',
         'navmap.wrong.gif'   => 'Incorrect',
         'navmap.open.gif'    => 'Open' );
   
   # 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 cleanup {
       if (tied(%navmaphash)){
    &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
           unless (untie(%navmaphash)) {
       &Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash');
           }
       }
       if (tied(%parmhash)){
    &Apache::lonnet::logthis('Cleanup navmaps: parmhash');
           unless (untie(%parmhash)) {
       &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');
           }
       }
   }
   
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
       real_handler($r);
   }
   
     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});  sub real_handler {
       my $r = shift;
   
     # Handle header-only request      # Handle header-only request
     if ($r->header_only) {      if ($r->header_only) {
Line 84  sub handler { Line 152  sub handler {
     }      }
   
     $r->print("<html><head>\n");      $r->print("<html><head>\n");
     $r->print("<title>Navigate Course Contents</title>");      $r->print("<title>Navigate Course Contents</title></head>");
   
     # Header      # Header
     $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',      $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',
                                           ''));                                            ''));
     $r->print('<script>window.focus();</script>');      $r->print('<script>window.focus();</script>');
   
     $r->print('<table border="0" cellpadding="2" cellspacing="0">');      $r->rflush();
     my $date=localtime;  
     $r->print('<tr><td align="right" valign="bottom">Key:&nbsp;&nbsp;</td>');  
   
     # Print discussions and feedback header  
     if ($navmap->{LAST_CHECK}) {  
         $r->print('<td align="center" valign="bottom">&nbsp;&nbsp;'.  
                   '<img src="/adm/lonMisc/chat.gif"> New discussion since '.  
                   strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).  
                   '</td><td align="center" valign="bottom">&nbsp;&nbsp;'.  
                   '<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'.  
                   '</td>');   
     } else {  
         $r->print('<td align="center" valign="bottom">&nbsp;&nbsp;'.  
                   '<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'.  
                   '&nbsp;&nbsp;<img src="/adm/lonMisc/feedback.gif"> New message (click to open)'.  
                   '</td>');   
     }  
     $r->print('</tr></table>');  
   
     my $condition = 0;  
     if ($ENV{'form.condition'}) {  
         $condition = 1;  
     }  
   
     my $currenturl = $ENV{'form.postdata'};      # Now that we've displayed some stuff to the user, init the navmap
     $currenturl=~s/^http\:\/\///;      $navmap->init();
     $currenturl=~s/^[^\/]+//;  
   
     # alreadyHere allows us to only open the maps necessary to view  
     # the current location once, while at the same time remembering  
     # the current location. Without that check, the user would never  
     # be able to close those maps; the user would close it, and the  
     # currenturl scan would re-open it.  
     my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .  
         "&alreadyHere=1";  
   
     if ($condition) {  
         $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd\">Close All Folders</a>");  
     } else {  
         $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd\">Open All Folders</a>");  
     }  
   
     $r->print('<br>&nbsp;');      $r->print('<br>&nbsp;');
     $r->rflush();      $r->rflush();
   
     # Now that we've displayed some stuff to the user, init the navmap  
     $navmap->init();  
   
     # Check that it's defined      # Check that it's defined
     if (!($navmap->courseMapDefined())) {      if (!($navmap->courseMapDefined())) {
         $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .          $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
Line 147  sub handler { Line 175  sub handler {
         return OK;          return OK;
     }      }
   
     # Grab a resource object so we have access to the constants; this      # renderer call
     # is technically not proper, but should be harmless      my $render = render({ 'cols' => [0,1,2,3],
     my $res = $navmap->firstResource();                            'url' => '/adm/navmaps',
                             'printKey' => 1,
     # These are some data tables, which make it easy to change some of                            'r' => $r});
     # of the specific visualization parameters if desired.  
   
     # Defines a status->color mapping, null string means don't color  
     my %colormap =   
     ( $res->NETWORK_FAILURE        => '',  
       $res->CORRECT                => '',  
       $res->EXCUSED                => '#3333FF',  
       $res->PAST_DUE_ANSWER_LATER  => '',  
       $res->PAST_DUE_NO_ANSWER     => '',  
       $res->ANSWER_OPEN            => '#006600',  
       $res->OPEN_LATER             => '',  
       $res->TRIES_LEFT             => '',  
       $res->INCORRECT              => '',  
       $res->OPEN                   => '',  
       $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 = "#FF0000";  
   
     # Keep these mappings in sync with lonquickgrades, which uses the colors  
     # instead of the icons.  
     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',  
           $res->ATTEMPTED          => 'navmap.open.gif' );  
   
     my %iconAltTags =   
         ( 'navmap.correct.gif' => 'Correct',  
           'navmap.wrong.gif'   => 'Incorrect',  
           'navmap.open.gif'    => 'Open' );  
   
     my %condenseStatuses =  
         ( $res->NETWORK_FAILURE    => 1,  
           $res->NOTHING_SET        => 1,  
           $res->CORRECT            => 1 );  
   
     my %filterHash;  
     # Figure out what we're not displaying  
     foreach (split(/\,/, $ENV{"form.filter"})) {  
         if ($_) {  
             $filterHash{$_} = "1";  
         }  
     }  
   
     # Is this a new-style course? If so, we want to suppress showing the top-level  
     # maps in their own folders, in favor of "inlining" them.  
     my $topResource = $navmap->getById("0.0");  
   
     # Begin the HTML table  
     # four cols: resource + indent, chat+feedback, icon, text string  
     $r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n");  
   
     # This needs to be updated to use symbs from the remote,   
     # instead of uris. The changes to this and the main rendering  
     # loop should be obvious.  
     # Here's a simple example of the iterator.  
     # Preprocess the map: Look for current URL, force inlined maps to display  
   
     my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 1);  
     my $found = 0;  
     my $depth = 1;  
     my $currentUrlIndex = 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 $currentUrlDelta = 5; # change this to change how many resources are displayed  
                              # before the current resource when using #current  
     $mapIterator->next(); # discard the first BEGIN_MAP  
     my $curRes = $mapIterator->next();  
     my $counter = 0;  
   
     # We only need to do this if we need to open the maps to show the  
     # current position  
     while ($depth > 0 && !$ENV{'form.alreadyHere'}) {  
         if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }  
         if ($curRes == $mapIterator->END_MAP()) { $depth--; }  
   
         if (ref($curRes)) { $counter++; }  
   
         my $mapStack = $mapIterator->getStack();  
         if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) &&   
             $curRes->src() eq $currenturl) {  
             # If this is the correct resource, be sure to   
             # show it by making sure the containing maps  
             # are open.  
   
             # This is why we have to use the main iterator instead of the  
             # potentially faster DFS: The count has to be the same, so  
             # the order has to be the same, which DFS won't give us.  
             $currentUrlIndex = $counter;  
               
             # Ensure the parent maps are open  
             for my $map (@{$mapStack}) {  
                 if ($condition) {  
                     undef $filterHash{$map->map_pc()};  
                 } else {  
                     $filterHash{$map->map_pc()} = 1;  
                 }  
             }  
             $ENV{'form.alreadyHere'} = 1;  
         }  
               
         $curRes = $mapIterator->next();  
     }  
       
     undef $res; # so we don't accidentally use it later  
     my $indentLevel = 0;  
     my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";  
   
     my $isNewBranch = 0;  
     my $now = time();  
     my $in24Hours = $now + 24 * 60 * 60;  
     my $displayedHereMarker = 0;  
       
     # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"  
     # code in iterator->next), so ignore the first one  
     $mapIterator = $navmap->getIterator(undef, undef, \%filterHash,  
                                            $condition);  
     $mapIterator->next();  
     $curRes = $mapIterator->next();  
     $depth = 1;  
   
     my @backgroundColors = ("#FFFFFF", "#F6F6F6");  
     my $rowNum = 0;  
   
     $counter = 0;  
   
     # Print the 'current' anchor here if it would fall off the top  
     if ($currentUrlIndex - $currentUrlDelta < 0) {  
         $r->print('<a name="current" />');  
     }  
   
     while ($depth > 0) {  
         if ($curRes == $mapIterator->BEGIN_MAP() ||  
             $curRes == $mapIterator->BEGIN_BRANCH()) {  
             $indentLevel++;  
         }  
         if ($curRes == $mapIterator->END_MAP() ||  
             $curRes == $mapIterator->END_BRANCH()) {  
             $indentLevel--;  
         }  
         if ($curRes == $mapIterator->BEGIN_BRANCH()) {  
             $isNewBranch = 1;  
         }  
         if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }  
         if ($curRes == $mapIterator->END_MAP()) { $depth--; }  
   
         if (ref($curRes)) { $counter++; }  
   
         # Is this resource being ignored because it is in a random-out  
         # map and it was not selected?  
         if (ref($curRes) && !advancedUser() && $curRes->randomout()) {  
             $curRes = $mapIterator->next();  
             next; # if yes, then just ignore this resource  
         }  
   
         if (ref($curRes)) {  
   
             my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon  
   
             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 = $mapIterator->next();  
                 next;  
             }  
   
             # Step one: Decide which parts to show  
             my @parts = @{$curRes->parts()};  
             my $multipart = scalar(@parts) > 1;  
             my $condensed = 0;  
                   
             if ($curRes->is_problem()) {  
   
                 # Is it multipart?  
                 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")) {  
                         # no parts are open, display as one part  
                         @parts = ("0");  
                         $condensed = 1;  
                     } 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 {  
                             # Now, we decide whether to condense the  
                             # parts due to 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 {  
                 $parts[0] = "0"; # this is to get past foreach loop below  
                  # you can consider a non-problem resource as a resource  
                   # with only one part without loss, and it simplifies the looping  
             }  
   
             # Is it a multipart problem with a single part, now in   
             # @parts with "0" filtered out? If so, 'forget' it's a multi-part  
             # problem and treat it like a single-part problem.  
             if ( scalar(@parts) == 1 ) {  
                 $multipart = 0;  
             }  
   
             # 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, since we can't  
             # retreive the metadata to count the parts  
             if ($curRes->{RESOURCE_ERROR}) {  
                 @parts = ("0");  
             }  
   
             # Step Two: Print the actual data.  
   
             # For each part we intend to display...  
             foreach my $part (@parts) {  
   
                 my $nonLinkedText = ""; # unlinked stuff after title  
                   
                 my $stack = $mapIterator->getStack();  
                 my $src = getLinkForResource($stack);  
   
                 # Pass the correct symb on the querystring, so the  
                 # remote will figure out where we are if we click a link  
                 my $srcHasQuestion = $src =~ /\?/;  
                 my $link = $src.  
                     ($srcHasQuestion?'&':'?') .  
                     'symb='.&Apache::lonnet::escape($curRes->symb()).  
                     '"';  
   
                 my $title = $curRes->compTitle();  
                 my $partLabel = "";  
                 my $newBranchText = "";  
   
                 # If this is a new branch, label it so  
                 if ($isNewBranch) {  
                     $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";  
                     $isNewBranch = 0;  
                 }  
   
                 # links to open and close the folders  
                 my $linkopen = "<a href=\"$link\">";  
                 my $linkclose = "</a>";  
   
                 my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";  
                 if ($curRes->is_problem()) {   
                     if ($part eq "0" || $condensed) {  
                         $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';   
                     } else {  
                         $icon = $indentString;  
                     }  
                 }  
   
                 # Display the correct icon, link to open or shut map  
                 if ($curRes->is_map()) {   
                     my $mapId = $curRes->map_pc();  
                     my $nowOpen = (!defined($filterHash{$mapId}));  
                     if ($condition) {$nowOpen = !$nowOpen;}  
                     $icon = $nowOpen ?  
                         "navmap.folder.closed.gif" : "navmap.folder.open.gif";  
                     $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";  
                     $linkopen = "<a href=\"/adm/navmaps?filter=";  
                     $linkopen .= ($nowOpen xor $condition) ?   
                         addToFilter(\%filterHash, $mapId) :  
                         removeFromFilter(\%filterHash, $mapId);  
                     $linkopen .= "&condition=$condition&$queryAdd\">";  
                     $linkclose = "</a>";  
   
                 }  
                   
                 my $colorizer = "";  
                 my $color;  
                 if ($curRes->is_problem()) {  
                     $color = $colormap{$curRes->status};  
   
                     if (dueInLessThen24Hours($curRes, $part) ||  
                         lastTry($curRes, $part)) {  
                         $color = $hurryUpColor;  
                     }  
   
                     if ($color ne "") {  
                         $colorizer = "bgcolor=\"$color\"";  
                     }  
                 }  
   
                 if ($curRes->randomout()) {  
                     $nonLinkedText .= ' <i>(hidden)</i> ';  
                 }  
   
                 $rowNum++;  
                 my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];  
   
                 # FIRST COL: The resource indentation, branch icon, name, and anchor  
                 $r->print("  <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\">\n");  
   
                 # Print the anchor if necessary  
                 if ($counter == $currentUrlIndex - $currentUrlDelta) {  
                     $r->print('<a name="current" />');  
                 }  
   
                 # print indentation  
                 for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {  
                     $r->print($indentString);  
                 }  
   
                 $r->print("  ${newBranchText}${linkopen}$icon${linkclose}\n");  
   
                 my $curMarkerBegin = "";  
                 my $curMarkerEnd = "";  
   
                 # Is this the current resource?  
                 if ($curRes->src() eq $currenturl && !$displayedHereMarker) {  
                     $curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">&gt; </font>';  
                     $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';  
                     $displayedHereMarker = 1;  
                 }  
   
                 if ($curRes->is_problem() && $part ne "0" && !$condensed) {   
                     $partLabel = " (Part $part)";   
                     $title = "";  
                 }  
                 if ($multipart && $condensed) {  
                     $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';  
                 }  
   
                 $r->print("  $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");  
   
                 if ($curRes->{RESOURCE_ERROR}) {  
                     $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",  
                                               '<font size="-1">Host down</font>'));  
                     }  
   
                 $r->print("</td>\n");  
   
                 # SECOND COL: Is there text, feedback, errors??  
                 my $discussionHTML = ""; my $feedbackHTML = "";  
   
                 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 width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML&nbsp;</td>");  
   
                 # Is this the first displayed part of a multi-part problem  
                 # that has not been condensed, so we should suppress these two  
                 # columns so we don't display useless status info about part  
                 # "0"?  
                 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 width=\"30\" valign=\"center\" width=\"50\" align=\"right\">$linkopen<img width=\"25\" height=\"25\" src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n");  
                     } else {  
                         $r->print("<td width=\"30\">&nbsp;</td>\n");  
                     }  
                 } else { # not problem, no icon  
                     $r->print("<td width=\"30\">&nbsp;</td>\n");  
                 }  
   
                 # FOURTH COL: Text description  
                 $r->print("<td align=\"right\" valign=\"center\">\n");  
                   
                 if ($curRes->kind() eq "res" &&  
                     $curRes->is_problem() &&  
                     !$firstDisplayed) {  
                     $r->print ("<font color=\"$color\"><b>") if ($color);  
                     $r->print (getDescription($curRes, $part));  
                     $r->print ("</b></font>") if ($color);  
                 }  
                 if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {  
                     $r->print('(randomly select ' . $curRes->randompick() .')');  
                 }  
   
                 $r->print("&nbsp;</td></tr>\n");  
   
                 if (!($counter % 20)) { $r->rflush(); }  
                 if ($counter == 2) { $r->rflush(); }  
             }  
         }  
         $curRes = $mapIterator->next();  
     }  
   
     $r->print("</table></body></html>");  
   
     $navmap->untieHashes();      $navmap->untieHashes();
   
       $r->print("</body></html>");
       $r->rflush();
   
     return OK;      return OK;
 }  }
   
Line 846  sub timeToHumanString { Line 432  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.
   
   =item * B<resource_no_folder_link>: If true, the resource's folder will not be clickable to open or close it. Default is false.
   
   =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
   
   Most of these parameters are only useful if you are *not* using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically.
   
   =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. If one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information, plus the 'iterator_map' parameter if any.
   
   =item * B<iterator_map>: If you are letting the renderer do the iterator handling, you can instruct the renderer to render only a particular map by passing it the source of the map you want to process, like '/res/103/jerf/navmap.course.sequence'.
   
   =item * B<navmap>: A reference to a navmap, used only if an iterator is not passed in. If this is necessary to make an iterator but it is not passed in, a new one will be constructed based on ENV info. This is useful to do basic error checking before passing it off to render.
   
   =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. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information.
   
   =item * B<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info.
   
   =item * B<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL.
   
   =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.
   
   =item * B<currentJumpIndex>: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}.
   
   =item * B<r>: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself.
   
   =item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.
   
   =item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.
   
   =item * B<filterFunc>: A function that takes the resource object as its only parameter and returns a true or false value. If true, the resource is displayed. If false, it is simply skipped in the display. By default, all resources are showne.
   
   =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:
   
   If you want to know how many rows were printed, the 'counter' element of the hash passed into the render function will contain the count. You may want to check whether any resources were printed at all.
   
   =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
   
   sub render_resource {
       my ($resource, $part, $params) = @_;
   
       my $nonLinkedText = ''; # stuff after resource title not in link
   
       my $link = $params->{"resourceLink"};
       my $src = $resource->src();
       my $it = $params->{"iterator"};
       my $filter = $it->{FILTER};
   
       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' />";
       }
   
       # 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;
           }
   
           if (!$params->{'resource_no_folder_link'}) {
               $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($resource->symb()) . 
                   "&folderManip=1'>";
           } else {
               # Don't allow users to manipulate folder
               $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') .
                   '.nomanip.gif';
               $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
   
               $linkopen = "";
               $linkclose = "";
           }
       }
   
       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'>";
   
       my $indentLevel = $params->{'indentLevel'};
       if ($newBranchText) { $indentLevel--; }
   
       # print indentation
       for (my $i = 0; $i < $indentLevel; $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)';
       }
   
       if (!$params->{'resource_nolink'}) {
           $result .= "  $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
       } else {
           $result .= "  $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
       }
   
       return $result;
   }
   
   sub render_communication_status {
       my ($resource, $part, $params) = @_;
       my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
   
       my $link = $params->{"resourceLink"};
       my $linkopen = "<a href='$link'>";
       my $linkclose = "</a>";
   
       if ($resource->hasDiscussion()) {
           $discussionHTML = $linkopen .
               '<img border="0" src="/adm/lonMisc/chat.gif" />' .
               $linkclose;
       }
       
       if ($resource->getFeedback()) {
           my $feedback = $resource->getFeedback();
           foreach (split(/\,/, $feedback)) {
               if ($_) {
                   $feedbackHTML .= '&nbsp;<a href="/adm/email?display='
                       . &Apache::lonnet::escape($_) . '">'
                       . '<img src="/adm/lonMisc/feedback.gif" '
                       . 'border="0" /></a>';
               }
           }
       }
       
       if ($resource->getErrors()) {
           my $errors = $resource->getErrors();
           foreach (split(/,/, $errors)) {
               if ($_) {
                   $errorHTML .= '&nbsp;<a href="/adm/email?display='
                       . &Apache::lonnet::escape($_) . '">'
                       . '<img src="/adm/lonMisc/bomb.gif" '
                       . 'border="0" /></a>';
               }
           }
       }
   
       return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML&nbsp;</td>";
   
   }
   sub render_quick_status {
       my ($resource, $part, $params) = @_;
       my $result = "";
       my $firstDisplayed = !$params->{'condensed'} && 
           $params->{'multipart'} && $part eq "0";
   
       my $link = $params->{"resourceLink"};
       my $linkopen = "<a href='$link'>";
       my $linkclose = "</a>";
   
       if ($resource->is_problem() &&
           !$firstDisplayed) {
           my $icon = $statusIconMap{$resource->status($part)};
           my $alt = $iconAltTags{$icon};
           if ($icon) {
               $result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n";
           } else {
               $result .= "<td width='30'>&nbsp;</td>\n";
           }
       } else { # not problem, no icon
           $result .= "<td width='30'>&nbsp;</td>\n";
       }
   
       return $result;
   }
   sub render_long_status {
       my ($resource, $part, $params) = @_;
       my $result = "<td align='right' valign='center'>\n";
       my $firstDisplayed = !$params->{'condensed'} && 
           $params->{'multipart'} && $part eq "0";
                   
       my $color;
       if ($resource->is_problem()) {
           $color = $colormap{$resource->status};
           
           if (dueInLessThen24Hours($resource, $part) ||
               lastTry($resource, $part)) {
               $color = $hurryUpColor;
           }
       }
       
       if ($resource->kind() eq "res" &&
           $resource->is_problem() &&
           !$firstDisplayed) {
           if ($color) {$result .= "<font color=\"$color\"><b>"; }
           $result .= getDescription($resource, $part);
           if ($color) {$result .= "</b></font>"; }
       }
       if ($resource->is_map() && advancedUser() && $resource->randompick()) {
           $result .= '(randomly select ' . $resource->randompick() .')';
       }
       
       $result .= "&nbsp;</td>\n";
       
       return $result;
   }
   
   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;
       &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
       my $result = '';
   
       # Configure the renderer.
       my $cols = $args->{'cols'};
       if (!defined($cols)) {
           # no columns, no nav maps.
           return '';
       }
       my $mustCloseNavMap = 0;
       my $navmap;
       if (defined($args->{'navmap'})) {
           $navmap = $args->{'navmap'};
       }
   
       my $queryString = $args->{'queryString'};
       my $jumpToURL = $args->{'jumpToURL'};
       my $jumpToSymb = $args->{'jumpToSymb'};
       my $jumpType;
       my $hereURL = $args->{'hereURL'};
       my $hereSymb = $args->{'hereSymb'};
       my $hereType;
       my $here;
       my $jump;
       my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0);    
       my $currentJumpDelta = 2; # change this to change how many resources are displayed
                                # before the current resource when using #current
   
       # If we were passed 'here' information, we are not rendering
       # after a folder manipulation, and we were not passed an
       # iterator, make sure we open the folders to show the "here"
       # marker
       my $filterHash = {};
       # Figure out what we're not displaying
       foreach (split(/\,/, $ENV{"form.filter"})) {
           if ($_) {
               $filterHash->{$_} = "1";
           }
       }
   
       my $condition = 0;
       if ($ENV{'form.condition'}) {
           $condition = 1;
       }
   
       if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
           # Step 1: Check to see if we have a navmap
           if (!defined($navmap)) {
               $navmap = Apache::lonnavmaps::navmap->new(
                           $ENV{"request.course.fn"}.".db",
                           $ENV{"request.course.fn"}."_parms.db", 1, 1);
               $mustCloseNavMap = 1;
           }
           $navmap->init();
   
           # Step two: Locate what kind of here marker is necessary
           # Determine where the "here" marker is and where the screen jumps to.
   
           # We're coming from the remote. We have either a url, a symb, or nothing,
           # and we need to figure out what.
           # Preference: Symb
           
           if ($ENV{'form.symb'}) {
               $hereType = $jumpType = SYMB();
               $here = $jump = $ENV{'form.symb'};
           } elsif ($ENV{'form.postdata'}) {
               # couldn't find a symb, is there a URL?
               my $currenturl = $ENV{'form.postdata'};
               $currenturl=~s/^http\:\/\///;
               $currenturl=~s/^[^\/]+//;
               
               $hereType = $jumpType = URL;
               $here = $jump = $currenturl;
           } else {
               # Nothing
               $hereType = $jumpType = NOTHING();
           }
           # Step three: Ensure the folders are open
           my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
           my $depth = 1;
           $mapIterator->next(); # discard the first BEGIN_MAP
           my $curRes = $mapIterator->next();
           my $counter = 0;
           my $found = 0;
           
           # We only need to do this if we need to open the maps to show the
           # current position. This will change the counter so we can't count
           # for the jump marker with this loop.
           while ($depth > 0 && !$found) {
               if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
               if ($curRes == $mapIterator->END_MAP()) { $depth--; }
               
               if (ref($curRes) && 
                   ($hereType == SYMB() && $curRes->symb() eq $here) ||
                   (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {
                   my $mapStack = $mapIterator->getStack();
                   
                   # Ensure the parent maps are open
                   for my $map (@{$mapStack}) {
                       if ($condition) {
                           undef $filterHash->{$map->map_pc()};
                       } else {
                           $filterHash->{$map->map_pc()} = 1;
                       }
                   }
                   $found = 1;
               }
               
               $curRes = $mapIterator->next();
           }            
   
           # Since we changed the folders, (re-)locate the jump point, if any
           $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
           $depth = 1;
           $mapIterator->next();
           $curRes = $mapIterator->next();
           my $foundJump = 0;
           
           while ($depth > 0 && !$foundJump) {
               if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
               if ($curRes == $mapIterator->END_MAP()) { $depth--; }
               if (ref($curRes)) { $counter++; }
               
               if (ref($curRes) && 
                   (($jumpType == SYMB() && $curRes->symb() eq $jump) ||
                    ($jumpType == URL() && $curRes->src() eq $jump))) {
                   
                   # This is why we have to use the main iterator instead of the
                   # potentially faster DFS: The count has to be the same, so
                   # the order has to be the same, which DFS won't give us.
                   $currentJumpIndex = $counter;
                   $foundJump = 1;
               }
               
               $curRes = $mapIterator->next();
           }
       
       }        
       if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
           # If this is a click on a folder or something, we want to preserve the "here"
           # from the querystring, and get the new "jump" marker
           $hereType = $ENV{'form.hereType'};
           $here = $ENV{'form.here'};
           $jumpType = $ENV{'form.jumpType'} || NOTHING();
           $jump = $ENV{'form.jump'};
       } 
       
       my $it = $args->{'iterator'};
       if (!defined($it)) {
           # Construct a default iterator based on $ENV{'form.'} information
           
           # Step 1: Check to see if we have a navmap
           if (!defined($navmap)) {
               $navmap = Apache::lonnavmaps::navmap->new(
                           $ENV{"request.course.fn"}.".db",
                           $ENV{"request.course.fn"}."_parms.db", 1, 1);
               $mustCloseNavMap = 1;
           }
           # Paranoia: Make sure it's ready
           $navmap->init();
   
           # See if we're being passed a specific map
           if ($args->{'iterator_map'}) {
               my $map = $args->{'iterator_map'};
               $map = $navmap->getResourceByUrl($map);
               my $firstResource = $map->map_start();
               my $finishResource = $map->map_finish();
   
               $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
           } else {
               $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
           }
       }
       
       my $showParts = setDefault($args->{'showParts'}, 1);
       my $condenseParts = setDefault($args->{'condenseParts'}, 1);
       # 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 $r = $args->{'r'};
       my $printKey = $args->{'printKey'};
       my $printCloseAll = $args->{'printCloseAll'};
       if (!defined($printCloseAll)) { $printCloseAll = 1; }
       my $filterFunc = setDefault($args->{'filterFunc'},
                                   sub {return 1;});
       
       # Print key?
       if ($printKey) {
           $result .= '<table border="0" cellpadding="2" cellspacing="0">';
           my $date=localtime;
           $result.='<tr><td align="right" valign="bottom">Key:&nbsp;&nbsp;</td>';
           if ($navmap->{LAST_CHECK}) {
               $result .= 
                   '<img src="/adm/lonMisc/chat.gif"> New discussion since '.
                   strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
                   '</td><td align="center" valign="bottom">&nbsp;&nbsp;'.
                   '<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'.
                   '</td>'; 
           } else {
               $result .= '<td align="center" valign="bottom">&nbsp;&nbsp;'.
                   '<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'.
                   '&nbsp;&nbsp;<img src="/adm/lonMisc/feedback.gif"> New message (click to open)'.
                   '</td>'; 
           }
   
           $result .= '</tr></table>';
       }
   
       if ($printCloseAll) {
           if ($condition) {
               $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
                   "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
                   "\">Close All Folders</a>";
           } else {
               $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
                   "&hereType=$hereType&here=" . Apache::lonnet::escape($here) . 
                   "\">Open All Folders</a>";
           }
           $result .= "<br /><br />\n";
       }    
   
       if ($r) {
           $r->print($result);
           $r->rflush();
           $result = "";
       }
       # End parameter setting
               
       # Data
       $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");
   
       # 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;
   
       # export "here" marker information
       $args->{'here'} = $here;
       $args->{'hereType'} = $hereType;
   
       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'}++;
   
           # If this has been filtered out, continue on
           if (!(&$filterFunc($curRes))) {
               $curRes = $it->next();
               $args->{'isNewBranch'} = 0; # Don't falsely remember this
               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";
   
               # Set up some data about the parts that the cols might want
               my $filter = $it->{FILTER};
               my $stack = $it->getStack();
               my $src = getLinkForResource($stack);
               
               my $srcHasQuestion = $src =~ /\?/;
               $args->{"resourceLink"} = $src.
                   ($srcHasQuestion?'&':'?') .
                   'symb=' . &Apache::lonnet::escape($curRes->symb());
               
               # Now, display each column.
               foreach my $col (@$cols) {
                   my $colHTML = '';
                   if (ref($col)) {
                       $colHTML .= &$col($curRes, $part, $args);
                   } else {
                       $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
                   }
   
                   # If this is the first column and it's time to print
                   # the anchor, do so
                   if ($col == $cols->[0] && 
                       $args->{'counter'} == $args->{'currentJumpIndex'} - 
                       $currentJumpDelta) {
                       # Jam the anchor after the <td> tag;
                       # necessary for valid HTML (which Mozilla requires)
                       $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
                       $displayedJumpMarker = 1;
                   }
                   $result .= $colHTML . "\n";
               }
               $result .= "    </tr>\n";
               $args->{'isNewBranch'} = 0;
           }
           
           if ($r && $rownum % 20 == 0) {
               $r->print($result);
               $result = "";
               $r->rflush();
           }
           
           $curRes = $it->next();
       }
       
       # Print out the part that jumps to #curloc if it exists
       if ($displayedJumpMarker) {
           $result .= "<script>location += \"#curloc\";</script>\n";
       }
   
       $result .= "</table>";
       
       if ($r) {
           $r->print($result);
           $result = "";
           $r->rflush();
       }
           
       if ($mustCloseNavMap) { $navmap->untieHashes(); } 
   
       return $result;
   }
   
 1;  1;
   
 package Apache::lonnavmaps::navmap;  package Apache::lonnavmaps::navmap;
   
 =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, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere.
   
 =head1 navmap object: Encapsulating the compiled nav map  =head1 navmap object: Encapsulating the compiled nav map
   
Line 895  sub new { Line 1258  sub new {
     $self->{NETWORK_FAILURE} = 0;      $self->{NETWORK_FAILURE} = 0;
   
     # tie the nav hash      # tie the nav hash
     my %navmaphash;  
     if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},      if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
               &GDBM_READER(), 0640))) {                &GDBM_READER(), 0640))) {
         return undef;          return undef;
     }      }
           
     my %parmhash;  
     if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},      if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
               &GDBM_READER(), 0640)))                &GDBM_READER(), 0640)))
     {      {
Line 909  sub new { Line 1271  sub new {
         return undef;          return undef;
     }      }
   
     # Now copy the hashes for speed (?)      $self->{HASH_TIED} = 1;
     my %realnav; my %realparm;      $self->{NAV_HASH} = \%navmaphash;
     foreach (%navmaphash) { $realnav{$_} = $navmaphash{$_}; }      $self->{PARM_HASH} = \%parmhash;
     foreach (%parmhash) { $realparm{$_} = $navmaphash{$_}; }      $self->{INITED} = 0;
     $self->{NAV_HASH} = \%realnav;  
     $self->{PARM_HASH} = \%realparm;  
   
     bless($self);      bless($self);
     $self->untieHashes();  
                   
     return $self;      return $self;
 }  }
   
 sub init {  sub init {
     my $self = shift;      my $self = shift;
       if ($self->{INITED}) { return; }
   
     # If the course opt hash and the user opt hash should be generated,      # If the course opt hash and the user opt hash should be generated,
     # generate them      # generate them
Line 988  sub init { Line 1348  sub init {
         my %emailstatus = &Apache::lonnet::dump('email_status');          my %emailstatus = &Apache::lonnet::dump('email_status');
         my $logoutTime = $emailstatus{'logout'};          my $logoutTime = $emailstatus{'logout'};
         my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};          my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
         $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?          $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ?
                                $courseLeaveTime : $logoutTime);                                 $courseLeaveTime : $logoutTime);
         my %discussiontime = &Apache::lonnet::dump('discussiontimes',           my %discussiontime = &Apache::lonnet::dump('discussiontimes', 
                                                    $cdom, $cnum);                                                     $cdom, $cnum);
Line 1029  sub init { Line 1389  sub init {
     }          }    
   
     $self->{PARM_CACHE} = {};      $self->{PARM_CACHE} = {};
       $self->{INITED} = 1;
 }  }
   
 # Internal function: Takes a key to look up in the nav hash and implements internal  # Internal function: Takes a key to look up in the nav hash and implements internal
Line 1069  sub DESTROY { Line 1430  sub DESTROY {
     $self->untieHashes();      $self->untieHashes();
 }  }
   
 # Private function: Does the given resource (as a symb string) have  # Private method: Does the given resource (as a symb string) have
 # current discussion? Returns 0 if chat/mail data not extracted.  # current discussion? Returns 0 if chat/mail data not extracted.
 sub hasDiscussion {  sub hasDiscussion {
     my $self = shift;      my $self = shift;
     my $symb = shift;      my $symb = shift;
     if (!defined($self->{DISCUSSION_TIME})) { return 0; }      if (!defined($self->{DISCUSSION_TIME})) { return 0; }
   
       #return defined($self->{DISCUSSION_TIME}->{$symb});
     return $self->{DISCUSSION_TIME}->{$symb} >      return $self->{DISCUSSION_TIME}->{$symb} >
            $self->{LAST_CHECK};             $self->{LAST_CHECK};
 }  }
   
 # Private function: Does the given resource (as a symb string) have  # Private method: Does the given resource (as a symb string) have
 # current feedback? Returns the string in the feedback hash, which  # current feedback? Returns the string in the feedback hash, which
 # will be false if it does not exist.  # will be false if it does not exist.
 sub getFeedback {   sub getFeedback { 
Line 1092  sub getFeedback { Line 1454  sub getFeedback {
     return $self->{FEEDBACK}->{$symb};      return $self->{FEEDBACK}->{$symb};
 }  }
   
   # Private method: Get the errors for that resource (by source).
   sub getErrors { 
       my $self = shift;
       my $src = shift;
       
       if (!defined($self->{ERROR_MSG})) { return ""; }
       return $self->{ERROR_MSG}->{$src};
   }
   
 =pod  =pod
   
 =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.  =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
Line 1113  sub getById { Line 1484  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 1240  sub parmval_real { Line 1613  sub parmval_real {
     return '';      return '';
 }  }
   
   =pod 
   
   =item * B<getResourceByUrl>(url): Retrieves a resource object by URL of the resource. If passed a resource object, it will simply return it, so it is safe to use this method in code like "$res = $navmap->getResourceByUrl($res)", if you're not sure if $res is already an object, or just a URL. If the resource appears multiple times in the course, only the first instance will be returned. As a result, this is probably useful only for maps.
   
   =item * B<retrieveResources>(map, filterFunc, recursive, bailout): The map is a specification of a map to retreive the resources from, either as a url or as an object. The filterFunc is a reference to a function that takes a resource object as its one argument and returns true if the resource should be included, or false if it should not be. If recursive is true, the map will be recursively examined, otherwise it will not be. If bailout is true, the function will return as soon as it finds a resource, if false it will finish. By default, the map is the top-level map of the course, filterFunc is a function that always returns 1, recursive is true, bailout is false. The resources will be returned in a list reference containing the resource objects for the corresponding resources, with B<no structure information> in the list; regardless of branching, recursion, etc., it will be a flat list. 
   
   Thus, this is suitable for cases where you don't want the structure, just a list of all resources. It is also suitable for finding out how many resources match a given description; for this use, if all you want to know is if I<any> resources match the description, the bailout parameter will allow you to avoid potentially expensive enumeration of all matching resources.
   
   =cut
   
   sub getResourceByUrl {
       my $self = shift;
       my $resUrl = shift;
   
       if (ref($resUrl)) { return $resUrl; }
   
       $resUrl = &Apache::lonnet::clutter($resUrl);
       my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
       if ($resId =~ /,/) {
           $resId = (split (/,/, $resId))[0];
       }
       if (!$resId) { return ''; }
       return $self->getById($resId);
   }
   
   sub retrieveResources {
       my $self = shift;
       my $map = shift;
       my $filterFunc = shift;
       if (!defined ($filterFunc)) {
           $filterFunc = sub {return 1;};
       }
       my $recursive = shift;
       if (!defined($recursive)) { $recursive = 1; }
       my $bailout = shift;
       if (!defined($bailout)) { $bailout = 0; }
   
       # Create the necessary iterator.
       if (!ref($map)) { # assume it's a url of a map.
           $map = $self->getMapByUrl($map);
       }
   
       # Check the map's validity.
       if (!$map || !$map->is_map()) {
           # Oh, to throw an exception.... how I'd love that!
           return ();
       }
   
       # UNFINISHED... I was checking in getResourceByUrl
   }
   
 1;  1;
   
Line 1384  sub new { Line 1807  sub new {
                   
             if (ref($curRes)) {              if (ref($curRes)) {
                 # If there's only one resource, this will save it                  # If there's only one resource, this will save it
                 if($direction == FORWARD) { $resource = $curRes; $resourceCount++; }                  # we have to filter empty resources from consideration here,
                   # or even "empty", redirecting maps have two (start & finish)
                   # or three (start, finish, plus redirector)
                   if($direction == FORWARD && $curRes->src()) { 
                       $resource = $curRes; $resourceCount++; 
                   }
                 my $resultingVal = $curRes->{DATA}->{$valName};                  my $resultingVal = $curRes->{DATA}->{$valName};
                 my $nextResources = $curRes->$nextResourceMethod();                  my $nextResources = $curRes->$nextResourceMethod();
                 my $nextCount = scalar(@{$nextResources});                  my $nextCount = scalar(@{$nextResources});
Line 1576  sub next { Line 2004  sub next {
     }      }
   
     # If this is a blank resource, don't actually return it.      # If this is a blank resource, don't actually return it.
     if (!$self->{HERE}->src()) {      # Should you ever find you need it, make sure to add an option to the code
       #  that you can use; other things depend on this behavior.
       my $browsePriv = $self->{HERE}->browsePriv();
       if (!$self->{HERE}->src() || 
           (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
         return $self->next();          return $self->next();
     }      }
   
Line 1626  package Apache::lonnavmaps::DFSiterator; Line 2058  package Apache::lonnavmaps::DFSiterator;
 #  but this might as well be left seperate, since it is possible some other  #  but this might as well be left seperate, since it is possible some other
 #  use might be found for it. - Jeremy  #  use might be found for it. - Jeremy
   
   # Unlike the main iterator, this DOES return all resources, even blank ones.
   #  The main iterator needs them to correctly preprocess the map.
   
 sub BEGIN_MAP { return 1; }    # begining of a new map  sub BEGIN_MAP { return 1; }    # begining of a new map
 sub END_MAP { return 2; }      # end of the map  sub END_MAP { return 2; }      # end of the map
 sub FORWARD { return 1; }      # go forward  sub FORWARD { return 1; }      # go forward
Line 1657  sub new { Line 2092  sub new {
   
     # A hash, used as a set, of resource already seen      # A hash, used as a set, of resource already seen
     $self->{ALREADY_SEEN} = shift;      $self->{ALREADY_SEEN} = shift;
     if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };       if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
     $self->{CONDITION} = shift;      $self->{CONDITION} = shift;
     $self->{DIRECTION} = shift || FORWARD();      $self->{DIRECTION} = shift || FORWARD();
   
Line 1763  sub next { Line 2198  sub next {
                                              $self->{CONDITION}, $self->{DIRECTION});                                               $self->{CONDITION}, $self->{DIRECTION});
     }      }
   
     # If this is a blank resource, ignore it.  
     if (!$self->{HERE}->src()) {  
         return $self->next();  
     }  
       
     return $self->{HERE};      return $self->{HERE};
 }  }
   
Line 1785  A resource object encapsulates a resourc Line 2215  A resource object encapsulates a resourc
   
 A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.  A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
   
 You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.  You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource.
   
 =head2 Public Members  =head2 Public Members
   
Line 1916  These methods are shortcuts to deciding Line 2346  These methods are shortcuts to deciding
   
 =item * B<is_page>: Returns true if the resource is a page.  =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 is a sequence.  =item * B<is_sequence>: Returns true if the resource is a sequence.
   
 =back  =back
Line 1978  These methods are useful for getting inf Line 2406  These methods are useful for getting inf
 sub map_finish {  sub map_finish {
     my $self = shift;      my $self = shift;
     my $src = $self->src();      my $src = $self->src();
       $src = Apache::lonnet::clutter($src);
     my $res = $self->navHash("map_finish_$src", 0);      my $res = $self->navHash("map_finish_$src", 0);
     $res = $self->{NAV_MAP}->getById($res);      $res = $self->{NAV_MAP}->getById($res);
     return $res;      return $res;
Line 1990  sub map_pc { Line 2419  sub map_pc {
 sub map_start {  sub map_start {
     my $self = shift;      my $self = shift;
     my $src = $self->src();      my $src = $self->src();
       $src = Apache::lonnet::clutter($src);
     my $res = $self->navHash("map_start_$src", 0);      my $res = $self->navHash("map_start_$src", 0);
     $res = $self->{NAV_MAP}->getById($res);      $res = $self->{NAV_MAP}->getById($res);
     return $res;      return $res;
Line 2152  sub hasDiscussion { Line 2582  sub hasDiscussion {
   
 sub getFeedback {  sub getFeedback {
     my $self = shift;      my $self = shift;
     return $self->{NAV_MAP}->getFeedback($self->src());      my $source = $self->src();
       if ($source =~ /^\/res\//) { $source = substr $source, 5; }
       return $self->{NAV_MAP}->getFeedback($source);
   }
   
   sub getErrors {
       my $self = shift;
       my $source = $self->src();
       if ($source =~ /^\/res\//) { $source = substr $source, 5; }
       return $self->{NAV_MAP}->getErrors($source);
 }  }
   
 =pod  =pod
   
 =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<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 than 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. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.  =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.
   
Line 2508  sub getNext { Line 2947  sub getNext {
         my $next = $choice->goesto();          my $next = $choice->goesto();
         $next = $self->{NAV_MAP}->getById($next);          $next = $self->{NAV_MAP}->getById($next);
   
         # Don't remember it if the student doesn't have browse priviledges          push @branches, $next;
         # future note: this may properly belong in the client of the resource  
         my $browsePriv = $self->{BROWSE_PRIV};  
         if (!defined($browsePriv)) {  
             $browsePriv = &Apache::lonnet::allowed('bre', $self->src);  
             $self->{BROWSE_PRIV} = $browsePriv;  
         }  
         if (!($browsePriv ne '2' && $browsePriv ne 'F')) {  
             push @branches, $next;  
         }  
     }      }
     return \@branches;      return \@branches;
 }  }
Line 2531  sub getPrevious { Line 2961  sub getPrevious {
         my $prev = $choice->comesfrom();          my $prev = $choice->comesfrom();
         $prev = $self->{NAV_MAP}->getById($prev);          $prev = $self->{NAV_MAP}->getById($prev);
   
         # Don't remember it if the student doesn't have browse priviledges          push @branches, $prev;
         # future note: this may properly belong in the client of the resource  
         my $browsePriv = $self->{BROWSE_PRIV};  
         if (!defined($browsePriv)) {  
             $browsePriv = &Apache::lonnet::allowed('bre', $self->src);  
             $self->{BROWSE_PRIV} = $browsePriv;  
         }  
         if (!($browsePriv ne '2' && $browsePriv ne 'F')) {  
             push @branches, $prev;  
         }  
     }      }
     return \@branches;      return \@branches;
 }  }
   
   sub browsePriv {
       my $self = shift;
       if (defined($self->{BROWSE_PRIV})) {
           return $self->{BROWSE_PRIV};
       }
   
       $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src());
   }
   
 =pod  =pod
   
 =back  =back
Removed from v.1.116  
changed lines
  Added in v.1.145

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