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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.134 and 1.164

version 1.134, 2003/02/04 16:14:27 version 1.164, 2003/03/20 20:40:18
Line 38 Line 38
 # YEAR=2002  # YEAR=2002
 # 1/1 Gerd Kortemeyer  # 1/1 Gerd Kortemeyer
 # Oct-Nov Jeremy Bowers  # Oct-Nov Jeremy Bowers
   # YEAR=2003
   # Jeremy Bowers ... lots of days
   
 package Apache::lonnavmaps;  package Apache::lonnavmaps;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::lonmenu();
 use POSIX qw (floor strftime);  use POSIX qw (floor strftime);
   
 my %navmaphash;  my %navmaphash;
 my %parmhash;  my %parmhash;
   my @refsToUntie;
   
 # symbolic constants  # symbolic constants
 sub SYMB { return 1; }  sub SYMB { return 1; }
Line 56  sub NOTHING { return 3; } Line 60  sub NOTHING { return 3; }
   
 # Some data  # 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";
   my $test = 'abc';
 sub cleanup {  sub cleanup {
       &Apache::lonnet::logthis("Cleanup called.");
       &Apache::lonnet::logthis(scalar(@refsToUntie));
       &Apache::lonnet::logthis($test);
       $test = '467';
     if (tied(%navmaphash)){      if (tied(%navmaphash)){
  &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');   &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
         unless (untie(%navmaphash)) {          unless (untie(%navmaphash)) {
Line 70  sub cleanup { Line 117  sub cleanup {
     &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');      &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');
         }          }
     }      }
       # Apparently, if you take a reference to a tied hash, both the 
       # original hash and the tied hash must be untied. Bleh.
       for my $ref (@refsToUntie) {
           &Apache::lonnet::logthis('Cleanup navmaps: reference');
           unless (untie($ref)) {
               &Apache::lonnet::logthis('Failed cleanup navmaps: reference');
           }
       }
 }  }
   
 sub handler {  sub handler {
Line 80  sub handler { Line 135  sub handler {
 sub real_handler {  sub real_handler {
     my $r = shift;      my $r = shift;
   
     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});  
   
     # Handle header-only request      # Handle header-only request
     if ($r->header_only) {      if ($r->header_only) {
         if ($ENV{'browser.mathml'}) {          if ($ENV{'browser.mathml'}) {
Line 103  sub real_handler { Line 156  sub real_handler {
     $r->send_http_header;      $r->send_http_header;
   
     # Create the nav map      # Create the nav map
     my $navmap = Apache::lonnavmaps::navmap->new(      my $navmap = Apache::lonnavmaps::navmap->new($r, 
                         $ENV{"request.course.fn"}.".db",                          $ENV{"request.course.fn"}.".db",
                         $ENV{"request.course.fn"}."_parms.db", 1, 1);                          $ENV{"request.course.fn"}."_parms.db", 1, 1);
   
Line 115  sub real_handler { Line 168  sub real_handler {
     }      }
   
     $r->print("<html><head>\n");      $r->print("<html><head>\n");
     $r->print("<title>Navigate Course Contents</title></head>");      $r->print("<title>Navigate Course Contents</title>");
   # ------------------------------------------------------------ Get query string
       &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);
       
   # ----------------------------------------------------- Force menu registration
       my $addentries='';
       if ($ENV{'form.register'}) {
          $addentries=' onLoad="'.&Apache::lonmenu::loadevents().
      '" onUnload="'.&Apache::lonmenu::unloadevents().'"';
          $r->print(&Apache::lonmenu::registerurl(1));
       }
   
     # Header      # Header
     $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',      $r->print('</head>'.
                                           ''));                &Apache::loncommon::bodytag('Navigate Course Contents','',
                                       $addentries,'','',$ENV{'form.register'}));
     $r->print('<script>window.focus();</script>');      $r->print('<script>window.focus();</script>');
   
     $r->rflush();      $r->rflush();
Line 127  sub real_handler { Line 191  sub real_handler {
     # Now that we've displayed some stuff to the user, init the navmap      # Now that we've displayed some stuff to the user, init the navmap
     $navmap->init();      $navmap->init();
   
     $r->print('<table border="0" cellpadding="2" cellspacing="0">');  
     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;  
     }  
   
     # Determine where the "here" marker is and where the screen jumps to.  
     my $hereType; # the type of marker, SYMB, URL, or NOTHING  
     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 $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 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'};  
     } 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,  
         # 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();  
         }  
     }  
   
       
     # 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 = "&alreadyHere=1";  
   
     if ($condition) {  
         $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" .  
                   "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .  
                   "\">Close All Folders</a>");  
     } else {  
         $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" .  
                   "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .   
                   "\">Open All Folders</a>");  
     }  
   
     $r->print('<br>&nbsp;');      $r->print('<br>&nbsp;');
     $r->rflush();      $r->rflush();
   
Line 215  sub real_handler { Line 201  sub real_handler {
         return OK;          return OK;
     }      }
   
     # Grab a resource object so we have access to the constants; this      # See if there's only one map in the top-level... if so,
     # is technically not proper, but should be harmless      # automatically display it
     my $res = $navmap->firstResource();      my $iterator = $navmap->getIterator(undef, undef, undef, 0);
   
     # These are some data tables, which make it easy to change some of  
     # 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, undef, 1);  
     my $found = 0;  
     my $depth = 1;      my $depth = 1;
     my $currentJumpIndex = 0; # keeps track of when the current resource is found,      $iterator->next();
                              # so we can back up a few and put the anchor above the      my $curRes = $iterator->next();
                              # current resource      my $sequenceCount = 0;
     my $currentJumpDelta = 2; # change this to change how many resources are displayed      my $sequenceId;
                              # before the current resource when using #current      while ($depth > 0) {
     $mapIterator->next(); # discard the first BEGIN_MAP          if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
     my $curRes = $mapIterator->next();          if ($curRes == $iterator->END_MAP()) { $depth--; }
     my $counter = 0;  
     my $foundJump = ($jumpType == NOTHING()); # look for jump point if we have one  
     my $looped = 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 && !$ENV{'form.alreadyHere'}) {  
         if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }  
         if ($curRes == $mapIterator->END_MAP()) { $depth--; }  
   
         if (ref($curRes) && !$ENV{'form.alreadyHere'} &&   
             ($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;  
                 }  
             }  
             $ENV{'form.alreadyHere'} = 1;  
         }  
         $looped = 1;  
   
         $curRes = $mapIterator->next();  
     }              
       
     $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0);  
     $depth = 1;  
     $mapIterator->next();  
     $curRes = $mapIterator->next();  
   
     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))) {  
             # 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          if (ref($curRes) && $curRes->is_sequence()) {
             # potentially faster DFS: The count has to be the same, so              $sequenceCount++;
             # the order has to be the same, which DFS won't give us.              $sequenceId = $curRes->map_pc();
             $currentJumpIndex = $counter;  
             $foundJump = 1;  
         }          }
   
         $curRes = $mapIterator->next();          $curRes = $iterator->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;      if ($sequenceCount == 1) {
     my $now = time();          # The automatic iterator creation in the render call 
     my $in24Hours = $now + 24 * 60 * 60;          # will pick this up.
     my $displayedHereMarker = 0;          $ENV{'form.filter'} = "$sequenceId";
     my $displayedJumpMarker = 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;  
   
     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++; }  
   
         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()) {  
                             # Is this right? I think this will toss it  
                             # if it DOES have discussion, not if it doesn't?  
                             # - Jeremy (yes, commenting on his own code)  
                             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();  
                 if ($src=~/^\/uploaded\//) {  
     $nonLinkedText=$title;  
                     $title='';  
                 }  
                 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" .   
                         "&hereType=$hereType&here=" .   
                         Apache::lonnet::escape($here) . "&jumpType=".SYMB()."&" .  
                         "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">";  
                     $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 == $currentJumpIndex - $currentJumpDelta ) {  
                     $r->print('<a name="curloc" />');  
                     $displayedJumpMarker = 1;  
                 }  
   
                 # 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 (!$displayedHereMarker &&   
                     (($hereType == SYMB() && $curRes->symb eq $here) ||  
                     ($hereType == URL() && $curRes->src eq $here))) {  
                     $curMarkerBegin = '<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 = ""; my $errorHTML = "";  
   
                 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>';  
                         }  
                     }  
                 }  
   
                 if ($curRes->getErrors()) {  
                     my $errors = $curRes->getErrors();  
                     foreach (split(/,/, $errors)) {  
                         if ($_) {  
                             $errorHTML .= '&nbsp;<a href="/adm/email?display='  
                                 . &Apache::lonnet::escape($_) . '">'  
                                 . '<img src="/adm/lonMisc/bomb.gif" '  
                                 . 'border="0" /></a>';  
                         }  
                     }  
                 }  
   
                 $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML&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      # renderer call
                 $r->print("<td align=\"right\" valign=\"center\">\n");      my $render = render({ 'cols' => [0,1,2,3],
                                             'url' => '/adm/navmaps',
                 if ($curRes->kind() eq "res" &&                            'suppressNavmap' => 1,
                     $curRes->is_problem() &&                            'r' => $r});
                     !$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");      #$navmap->untieHashes();
   
                 if (!($counter % 20)) { $r->rflush(); }      if (tied(%navmaphash)) { 
                 if ($counter == 2) { $r->rflush(); }          $r->print("Dang it.");
             }      } else {
         }          $r->print("It's out.");
         $curRes = $mapIterator->next();  
     }      }
   
     $r->print("</table>");      if (tied(%parmhash)) { 
           $r->print("Dang it.");
     # Print out the part that jumps to #curloc if it exists      } else {
     if ($displayedJumpMarker) {          $r->print("It's out.");
         $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();  
   
     $r->print("</body></html>");      $r->print("</body></html>");
     $r->rflush();      $r->rflush();
   
Line 855  sub lastTry { Line 386  sub lastTry {
 }  }
   
 # This puts a human-readable name on the ENV variable.  # This puts a human-readable name on the ENV variable.
   # FIXME: This needs better logic: Who gets the advanced view of navmaps?
   #   As of 3-13-03, it's an open question. Guy doesn't want to check
   #   roles directly because it should be a check of capabilities for future
   #   role compatibity. There is no capability that matches this one for
   #   now, so this is done. (A hack for 1.0 might be to simply check roles
   #   anyhow.)
 sub advancedUser {  sub advancedUser {
     return $ENV{'user.adv'};      return $ENV{'user.adv'};
 }  }
Line 996  The pre-packaged column names are refere Line 533  The pre-packaged column names are refere
   
 =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_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  =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<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.
Line 1020  Note these functions are responsible for Line 559  Note these functions are responsible for
   
 =head2 Parameters  =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  =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<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<r>: The standard Apache response object. This must be passed to the renderer or the course hash will be locked.
   
 =item * B<cols>: An array reference  =item * B<cols>: An array reference
   
Line 1030  Note these functions are responsible for Line 577  Note these functions are responsible for
   
 =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<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<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' information, and should normally "just work" correctly.
   
 =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<here>: A Symb identifying where to place the 'here' marker. Default empty, which means no 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<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.
   
Line 1042  Note these functions are responsible for Line 587  Note these functions are responsible for
   
 =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<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<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 shown.
   
   =item * B<suppressNavmaps>: If true, will not display Navigate Content resources. Default to false.
   
 =back  =back
   
 =head2 Additional Info  =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:  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  =over 4
   
 =back  =back
Line 1061  sub long_status { return 3; } Line 618  sub long_status { return 3; }
   
 # Data for render_resource  # 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 {  sub render_resource {
     my ($resource, $part, $params) = @_;      my ($resource, $part, $params) = @_;
   
Line 1100  sub render_resource { Line 639  sub render_resource {
     # If this is a new branch, label it so      # If this is a new branch, label it so
     if ($params->{'isNewBranch'}) {      if ($params->{'isNewBranch'}) {
         $newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />";          $newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />";
         $params->{'isNewBranch'} = 0;  
     }      }
   
     # links to open and close the folder      # links to open and close the folder
Line 1111  sub render_resource { Line 649  sub render_resource {
     my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";      my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";
           
     if ($resource->is_problem()) {      if ($resource->is_problem()) {
         if ($part eq "0" || $params->{'condensed'}) {          if ($part eq "" || $params->{'condensed'}) {
             $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';              $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
         } else {          } else {
             $icon = $params->{'indentString'};              $icon = $params->{'indentString'};
Line 1125  sub render_resource { Line 663  sub render_resource {
         if ($it->{CONDITION}) {          if ($it->{CONDITION}) {
             $nowOpen = !$nowOpen;              $nowOpen = !$nowOpen;
         }          }
         $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif';  
         $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";          if (!$params->{'resource_no_folder_link'}) {
                       $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif';
         $linkopen = "<a href='" . $params->{'url'} . '?' .               $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
             $params->{'queryString'} . '&filter=';  
         $linkopen .= ($nowOpen xor $it->{CONDITION}) ?              $linkopen = "<a href='" . $params->{'url'} . '?' . 
             addToFilter($filter, $mapId) :                  $params->{'queryString'} . '&filter=';
             removeFromFilter($filter, $mapId);              $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
         $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='                  addToFilter($filter, $mapId) :
             . $params->{'hereType'} . '&here=' .                  removeFromFilter($filter, $mapId);
             &Apache::lonnet::escape($params->{'here'}) .               $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
             '&jumpType=' . SYMB() . '&jump=' .                  . $params->{'hereType'} . '&here=' .
             &Apache::lonnet::escape($params->{$resource->symb()}) . "'>";                  &Apache::lonnet::escape($params->{'here'}) . 
                   '&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()) {      if ($resource->randomout()) {
Line 1146  sub render_resource { Line 696  sub render_resource {
           
     # We're done preparing and finally ready to start the rendering      # We're done preparing and finally ready to start the rendering
     my $result = "<td align='left' valign='center'>";      my $result = "<td align='left' valign='center'>";
       
       my $indentLevel = $params->{'indentLevel'};
       if ($newBranchText) { $indentLevel--; }
   
     # print indentation      # print indentation
     for (my $i = 0; $i < $params->{'indentLevel'} -       for (my $i = 0; $i < $indentLevel; $i++) {
                          $params->{'deltaLevel'}; $i++) {  
         $result .= $params->{'indentString'};          $result .= $params->{'indentString'};
     }      }
   
Line 1160  sub render_resource { Line 712  sub render_resource {
     my $curMarkerEnd = '';      my $curMarkerEnd = '';
   
     # Is this the current resource?      # Is this the current resource?
     if (!$params->{'displayedHereMarker'} &&      if (!$params->{'displayedHereMarker'} && 
         (($params->{'hereType'} == SYMB() &&           $resource->symb() eq $params->{'here'} ) {
           $resource->symb() eq $params->{'here'}) ||  
          ($params->{'hereType'} == URL() &&  
           $resource->src() eq $params->{'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>';
           $params->{'displayedHereMarker'} = 1;
     }      }
   
     if ($resource->is_problem() && $part ne "0" &&       if ($resource->is_problem() && $part ne "" && 
         !$params->{'condensed'}) {          !$params->{'condensed'}) {
         $partLabel = " (Part $part)";          $partLabel = " (Part $part)";
         $title = "";          $title = "";
     }      }
   
     if ($params->{'multipart'} && $params->{'condensed'}) {      if ($params->{'condensed'} && $resource->countParts() > 1) {
         $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';          $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
     }      }
   
     $result .= "  $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";      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;      return $result;
 }  }
Line 1227  sub render_communication_status { Line 781  sub render_communication_status {
 }  }
 sub render_quick_status {  sub render_quick_status {
     my ($resource, $part, $params) = @_;      my ($resource, $part, $params) = @_;
     return "<td align='center'>quick_status</td>";      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 {  sub render_long_status {
     my ($resource, $part, $params) = @_;      my ($resource, $part, $params) = @_;
     return "<td align='center'>long_status</td>";      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,  my @preparedColumns = (\&render_resource, \&render_communication_status,
Line 1245  sub setDefault { Line 847  sub setDefault {
   
 sub render {  sub render {
     my $args = shift;      my $args = shift;
           &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
       my $result = '';
   
     # Configure the renderer.      # Configure the renderer.
     my $cols = $args->{'cols'};      my $cols = $args->{'cols'};
     if (!defined($cols)) {      if (!defined($cols)) {
         # no columns, no nav maps.          # no columns, no nav maps.
         return '';          return '';
     }      }
       my $mustCloseNavMap = 0;
       my $navmap;
       if (defined($args->{'navmap'})) {
           $navmap = $args->{'navmap'};
       }
   
       my $r = $args->{'r'};
       my $queryString = $args->{'queryString'};
       my $jump = $args->{'jump'};
       my $here = $args->{'here'};
       my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 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($r, 
                           $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.
   
           if ($ENV{'form.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/^[^\/]+//;
               
               $here = $jump = &Apache::lonnet::symbread($currenturl);
           }
   
           # 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 $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) && $curRes->symb() 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();
           }            
       }        
   
       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
           $here = $ENV{'form.here'};
           $jump = $ENV{'form.jump'};
       } 
       
     my $it = $args->{'iterator'};      my $it = $args->{'iterator'};
     if (!defined($it)) {      if (!defined($it)) {
         # no iterator, no nav map.          # Construct a default iterator based on $ENV{'form.'} information
         return '';          
           # Step 1: Check to see if we have a navmap
           if (!defined($navmap)) {
               $navmap = Apache::lonnavmaps::navmap->new($r, 
                           $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);      # (re-)Locate the jump point, if any
     my $condenseParts = setDefault($args->{'condenseParts'}, 1);      my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
     my $jumpToURL = $args->{'jumpToURL'};      my $depth = 1;
     my $jumpToSymb = $args->{'jumpToSymb'};      $mapIterator->next();
     my $hereURL = $args->{'hereURL'};      my $curRes = $mapIterator->next();
     my $hereSymb = $args->{'hereSymb'};      my $foundJump = 0;
       my $counter = 0;
           
     #if (defined($jumpToURL)) {      while ($depth > 0 && !$foundJump) {
     #    $args->{'jumpType'} =           if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
           if ($curRes == $mapIterator->END_MAP()) { $depth--; }
           if (ref($curRes)) { $counter++; }
           
           if (ref($curRes) && $jump eq $curRes->symb()) {
                           
               # 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.
               $args->{'currentJumpIndex'} = $counter;
               $foundJump = 1;
           }
           
           $curRes = $mapIterator->next();
       }
   
       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 $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" .
                   "&here=" . Apache::lonnet::escape($here) .
                   "\">Close All Folders</a>";
           } else {
               $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
                   "&here=" . Apache::lonnet::escape($here) . 
                   "\">Open All Folders</a>";
           }
           $result .= "<br /><br />\n";
       }    
   
       if ($r) {
           $r->print($result);
           $r->rflush();
           $result = "";
       }
     # End parameter setting      # End parameter setting
                           
     # Data      # Data
     my $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";      $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
     my $res = "Apache::lonnavmaps::resource";      my $res = "Apache::lonnavmaps::resource";
     my %condenseStatuses =      my %condenseStatuses =
         ( $res->NETWORK_FAILURE    => 1,          ( $res->NETWORK_FAILURE    => 1,
           $res->NOTHING_SET        => 1,            $res->NOTHING_SET        => 1,
           $res->CORRECT            => 1 );            $res->CORRECT            => 1 );
     my @backgroundColors = ("#FFFFFF", "#F6F6F6");      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      # Shared variables
     $args->{'counter'} = 0; # counts the rows      $args->{'counter'} = 0; # counts the rows
Line 1294  sub render { Line 1074  sub render {
   
     my $displayedJumpMarker = 0;      my $displayedJumpMarker = 0;
     # Set up iteration.      # Set up iteration.
     my $depth = 1;      $depth = 1;
     $it->next(); # discard initial BEGIN_MAP      $it->next(); # discard initial BEGIN_MAP
     my $curRes = $it->next();      $curRes = $it->next();
     my $now = time();      my $now = time();
     my $in24Hours = $now + 24 * 60 * 60;      my $in24Hours = $now + 24 * 60 * 60;
     my $rownum = 0;      my $rownum = 0;
   
       # export "here" marker information
       $args->{'here'} = $here;
   
     while ($depth > 0) {      while ($depth > 0) {
         if ($curRes == $it->BEGIN_MAP()) { $depth++; }          if ($curRes == $it->BEGIN_MAP()) { $depth++; }
         if ($curRes == $it->END_MAP()) { $depth--; }          if ($curRes == $it->END_MAP()) { $depth--; }
Line 1321  sub render { Line 1104  sub render {
   
         # If this isn't an actual resource, continue on          # If this isn't an actual resource, continue on
         if (!ref($curRes)) {          if (!ref($curRes)) {
             $curRes = $it->next();  
             next;              next;
         }          }
   
         $args->{'counter'}++;          $args->{'counter'}++;
         # reserve space for branch symbol  
         $args->{'deltalevel'} = $args->{'isNewBranch'}? 1 : 0;           # If this has been filtered out, continue on
         if ($args->{'indentLevel'} - $args->{'deltalevel'} < 0) {          if (!(&$filterFunc($curRes))) {
             # If this would be at a negative depth (top-level maps in              $args->{'isNewBranch'} = 0; # Don't falsely remember this
             # new-style courses, we want to suppress their title display)              next;
             # then ignore it.          } 
             $curRes = $it->next();  
           # If we're suppressing navmaps and this is a navmap, continue on
           if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
             next;              next;
         }          }
   
Line 1348  sub render { Line 1132  sub render {
                           
             if ($condenseParts) { # do the condensation              if ($condenseParts) { # do the condensation
                 if (!$curRes->opendate("0")) {                  if (!$curRes->opendate("0")) {
                     @parts = ("0");                      @parts = ();
                     $args->{'condensed'} = 1;                      $args->{'condensed'} = 1;
                 }                  }
                 if (!$args->{'condensed'}) {                  if (!$args->{'condensed'}) {
Line 1380  sub render { Line 1164  sub render {
                     if (($statusAllSame && defined($condenseStatuses{$status})) ||                      if (($statusAllSame && defined($condenseStatuses{$status})) ||
                         ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||                          ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
                         ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){                          ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
                         @parts = ($parts[1]);                          @parts = ();
                         $args->{'condensed'} = 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 the multipart problem was condensed, "forget" it was multipart
         if (scalar(@parts) == 1) {          if (scalar(@parts) == 1) {
             $args->{'multipart'} = 0;              $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          # Now, we've decided what parts to show. Loop through them and
         # show them.          # show them.
         foreach my $part (@parts) {          foreach my $part ('', @parts) {
               if ($part eq '0') {
                   next;
               }
             $rownum ++;              $rownum ++;
             my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];              my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
                           
Line 1421  sub render { Line 1196  sub render {
             my $srcHasQuestion = $src =~ /\?/;              my $srcHasQuestion = $src =~ /\?/;
             $args->{"resourceLink"} = $src.              $args->{"resourceLink"} = $src.
                 ($srcHasQuestion?'&':'?') .                  ($srcHasQuestion?'&':'?') .
                 'symb=' . &Apache::lonnet::escape($curRes->symb()).                  'symb=' . &Apache::lonnet::escape($curRes->symb());
                 '"';  
                           
             # Now, display each column.              # Now, display each column.
             foreach my $col (@$cols) {              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                  # If this is the first column and it's time to print
                 # the anchor, do so                  # the anchor, do so
                 if ($col == $cols->[0] &&                   if ($col == $cols->[0] && 
                     $args->{'counter'} == $args->{'currentJumpIndex'} -                       $args->{'counter'} == $args->{'currentJumpIndex'} - 
                     $args->{'currentJumpDelta'}) {                      $currentJumpDelta) {
                     $result .= '<a name="curloc" />';                      # Jam the anchor after the <td> tag;
                       # necessary for valid HTML (which Mozilla requires)
                       $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
                     $displayedJumpMarker = 1;                      $displayedJumpMarker = 1;
                 }                  }
                   $result .= $colHTML . "\n";
   
                 if (ref($col)) {  
                     $result .= &$col($curRes, $part, $args);  
                 } else {  
                     $result .= &{$preparedColumns[$col]}($curRes, $part, $args);  
                 }  
   
             }              }
               $result .= "    </tr>\n";
             $result .= "  </tr>\n";              $args->{'isNewBranch'} = 0;
         }          }
           
   
           if ($r && $rownum % 20 == 0) {
               $r->print($result);
               $result = "";
               $r->rflush();
           }
       } continue {
         $curRes = $it->next();          $curRes = $it->next();
     }      }
           
     # Print out the part that jumps to #curloc if it exists      # Print out the part that jumps to #curloc if it exists
     if ($args->{"displayedJumpMarker"}) {      # delay needed because the browser is processing the jump before
         $result .= "<script>location += "#curloc";</script>\n";      # it finishes rendering, so it goes to the wrong place!
       # onload might be better, but this routine has no access to that.
       # On mozilla, the 0-millisecond timeout seems to prevent this;
       # it's quite likely this might fix other browsers, too, and 
       # certainly won't hurt anything.
       if ($displayedJumpMarker) {
           $result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n";
     }      }
   
     $result .= "</table>";      $result .= "</table>";
       
       if ($r) {
           $r->print($result);
           $result = "";
           $r->rflush();
       }
           
       #if ($mustCloseNavMap) { $navmap->untieHashes(); } 
   
     return $result;      return $result;
 }  }
Line 1482  You must obtain resource objects through Line 1276  You must obtain resource objects through
   
 =over 4  =over 4
   
 =item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.  =item * B<new>(responseObject, navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. responseObject is the Apache response object (typically $r). genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
   
 =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.  =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
   
Line 1497  sub new { Line 1291  sub new {
     my $class = ref($proto) || $proto;      my $class = ref($proto) || $proto;
     my $self = {};      my $self = {};
   
       $self->{RESPONSE} = shift;
     $self->{NAV_HASH_FILE} = shift;      $self->{NAV_HASH_FILE} = shift;
     $self->{PARM_HASH_FILE} = shift;      $self->{PARM_HASH_FILE} = shift;
     $self->{GENERATE_COURSE_USER_OPT} = shift;      $self->{GENERATE_COURSE_USER_OPT} = shift;
Line 1512  sub new { Line 1307  sub new {
   
     # tie the nav hash      # tie the nav hash
   
     if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},      if (!(tie(%Apache::lonnavmaps::navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
               &GDBM_READER(), 0640))) {                &GDBM_READER(), 0640))) {
         return undef;          return undef;
     }      }
           
     if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},      if (!(tie(%Apache::lonnavmaps::parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
               &GDBM_READER(), 0640)))                &GDBM_READER(), 0640)))
     {      {
         untie $self->{PARM_HASH};          untie $self->{PARM_HASH};
         return undef;          return undef;
     }      }
   
     $self->{HASH_TIED} = 1;      $self->{NAV_HASH} = \%Apache::lonnavmaps::navmaphash;
     $self->{NAV_HASH} = \%navmaphash;      $self->{PARM_HASH} = \%Apache::lonnavmaps::parmhash;
     $self->{PARM_HASH} = \%parmhash;      push @Apache::lonnavmaps::refsToCleanup, $self->{NAV_HASH};
       push @Apache::lonnavmaps::refsToCleanup, $self->{PARM_HASH};
       Apache::lonnet::logthis(scalar(@Apache::lonnavmaps::refsToCleanup));
       $Apache::lonnavmaps::test = '123';
       Apache::lonnet::logthis($Apache::lonnavmaps::test);
       $self->{INITED} = 0;
   
       $self->{RESPONSE}->register_cleanup(\&Apache::lonnavmaps::cleanup);
       Apache::lonnet::logthis("Pushed cleanup.");
   
     bless($self);      bless($self);
                   
Line 1535  sub new { Line 1338  sub new {
   
 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 1640  sub init { Line 1444  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 1668  sub getIterator { Line 1473  sub getIterator {
   
 # unties the hash when done  # unties the hash when done
 sub untieHashes {  sub untieHashes {
     my $self = shift;  #    my $self = shift;
     untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});  #    untie $self->{NAV_HASH};
     untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});  #    untie $self->{PARM_HASH};
     $self->{HASH_TIED} = 0;  #    &Apache::lonnavmaps::cleanup();
 }  }
   
 # when the object is destroyed, be sure to untie all the hashes we tied.  # when the object is destroyed, be sure to untie all the hashes we tied.
 sub DESTROY {  #sub DESTROY {
     my $self = shift;  #    my $self = shift;
     $self->untieHashes();  #    $self->untieHashes();
 }  #}
   
 # Private method: 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.
Line 1851  sub parmval_real { Line 1656  sub parmval_real {
     my ($space,@qualifier)=split(/\./,$rwhat);      my ($space,@qualifier)=split(/\./,$rwhat);
     my $qualifier=join('.',@qualifier);      my $qualifier=join('.',@qualifier);
     unless ($space eq '0') {      unless ($space eq '0') {
         my ($part,$id)=split(/\_/,$space);   my @parts=split(/_/,$space);
         if ($id) {   my $id=pop(@parts);
             my $partgeneral=$self->parmval($part.".$qualifier",$symb);   my $part=join('_',@parts);
             if (defined($partgeneral)) { return $partgeneral; }   if ($part eq '') { $part='0'; }
         } else {   my $partgeneral=$self->parmval($part.".$qualifier",$symb);
             my $resourcegeneral=$self->parmval("0.$qualifier",$symb);   if (defined($partgeneral)) { return $partgeneral; }
             if (defined($resourcegeneral)) { return $resourcegeneral; }  
         }  
     }      }
     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.
   
   =item * B<hasResources>(map, filterFunc, recursive): Convience method for 
   
    scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0
   
   which will tell whether the map has resources matching the description in the filter function.
   
   =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 ();
       }
   
       # Get an iterator.
       my $it = $self->getIterator($map->map_start(), $map->map_finish(),
                                   !$recursive);
   
       my @resources = ();
   
       # Run down the iterator and collect the resources.
       my $depth = 1;
       $it->next();
       my $curRes = $it->next();
   
       while ($depth > 0) {
           if ($curRes == $it->BEGIN_MAP()) {
               $depth++;
           }
           if ($curRes == $it->END_MAP()) {
               $depth--;
           }
           
           if (ref($curRes)) {
               if (!&$filterFunc($curRes)) {
                   next;
               }
   
               push @resources, $curRes;
   
               if ($bailout) {
                   return @resources;
               }
           }
   
           $curRes = $it->next();
       }
   
       return @resources;
   }
   
   sub hasResource {
       my $self = shift;
       my $map = shift;
       my $filterFunc = shift;
       my $recursive = shift;
       
       return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0;
   }
   
 1;  1;
   
 package Apache::lonnavmaps::iterator;  package Apache::lonnavmaps::iterator;
Line 1887  getIterator behaves as follows: Line 1790  getIterator behaves as follows:
   
 =over 4  =over 4
   
 =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content.  =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content. returnTopMap, if true (default false), will cause the iterator to return the top-level map object (resource 0.0) before anything else.
   
 Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.  Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.
   
Line 1962  sub new { Line 1865  sub new {
     # Do we want to automatically follow "redirection" maps?      # Do we want to automatically follow "redirection" maps?
     $self->{FORCE_TOP} = shift;      $self->{FORCE_TOP} = shift;
   
       # Do we want to return the top-level map object (resource 0.0)?
       $self->{RETURN_0} = shift;
       # have we done that yet?
       $self->{HAVE_RETURNED_0} = 0;
   
     # Now, we need to pre-process the map, by walking forward and backward      # Now, we need to pre-process the map, by walking forward and backward
     # over the parts of the map we're going to look at.      # over the parts of the map we're going to look at.
   
Line 2075  sub new { Line 1983  sub new {
 sub next {  sub next {
     my $self = shift;      my $self = shift;
   
       # If we want to return the top-level map object, and haven't yet,
       # do so.
       if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
           $self->{HAVE_RETURNED_0} = 1;
           return $self->{NAV_MAP}->getById('0.0');
       }
   
     if ($self->{RECURSIVE_ITERATOR_FLAG}) {      if ($self->{RECURSIVE_ITERATOR_FLAG}) {
         # grab the next from the recursive iterator           # grab the next from the recursive iterator 
         my $next = $self->{RECURSIVE_ITERATOR}->next();          my $next = $self->{RECURSIVE_ITERATOR}->next();
Line 2205  sub next { Line 2120  sub next {
     # If this is a blank resource, don't actually return it.      # If this is a blank resource, don't actually return it.
     # Should you ever find you need it, make sure to add an option to the code      # 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.      #  that you can use; other things depend on this behavior.
     if (!$self->{HERE}->src() || !$self->{HERE}->browsePriv()) {      my $browsePriv = $self->{HERE}->browsePriv();
       if (!$self->{HERE}->src() || 
           (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
         return $self->next();          return $self->next();
     }      }
   
Line 2289  sub new { Line 2206  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 2412  A resource object encapsulates a resourc Line 2329  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 2543  These methods are shortcuts to deciding Line 2460  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 2605  These methods are useful for getting inf Line 2520  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 2617  sub map_pc { Line 2533  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 2793  sub getErrors { Line 2710  sub getErrors {
   
 =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 2814  sub countParts { Line 2731  sub countParts {
     my $self = shift;      my $self = shift;
           
     my $parts = $self->parts();      my $parts = $self->parts();
       my $delta = 0;
       for my $part (@$parts) {
           if ($part eq '0') { $delta--; }
       }
   
     if ($self->{RESOURCE_ERROR}) {      if ($self->{RESOURCE_ERROR}) {
         return 0;          return 0;
     }      }
   
     if (scalar(@{$parts}) < 2) { return 1;}      return scalar(@{$parts}) + $delta;
   
     return scalar(@{$parts}) - 1;  
 }  }
   
 # Private function: Extracts the parts information and saves it  # Private function: Extracts the parts information and saves it
 sub extractParts {   sub extractParts { 
     my $self = shift;      my $self = shift;
           
     return if ($self->{PARTS});      return if (defined($self->{PARTS}));
     return if ($self->ext);      return if ($self->ext);
   
     $self->{PARTS} = [];      $self->{PARTS} = [];
   
     # Retrieve part count, if this is a problem      # Retrieve part count, if this is a problem
     if ($self->is_problem()) {      if ($self->is_problem()) {
         my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');          my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
         if (!$metadata) {          if (!$metadata) {
             $self->{RESOURCE_ERROR} = 1;              $self->{RESOURCE_ERROR} = 1;
             $self->{PARTS} = [];              $self->{PARTS} = [];
             return;              return;
         }          }
           
         foreach (split(/\,/,$metadata)) {          foreach (split(/\,/,$metadata)) {
             if ($_ =~ /^parameter\_(.*)\_opendate$/) {              if ($_ =~ /^part_(.*)$/) {
                 push @{$self->{PARTS}}, $1;                  my $part = $1;
                   # check to see if part is turned off.
                   if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
                       push @{$self->{PARTS}}, $1;
                   }
             }              }
         }          }
                   
                   
         # Is this possible to do in one line? - Jeremy  
         my @sortedParts = sort @{$self->{PARTS}};          my @sortedParts = sort @{$self->{PARTS}};
         $self->{PARTS} = \@sortedParts;          $self->{PARTS} = \@sortedParts;
     }      }
Removed from v.1.134  
changed lines
  Added in v.1.164

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