loncom/interface/lonnavmaps.pm - diff

Return to lonnavmaps.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.142 and 1.220

-version 1.142, 2003/02/07 22:17:51
+version 1.220, 2003/08/07 14:29:43
  Line 1
  # The LearningOnline Network with CAPA
  # Navigate Maps Handler
  #
- Line 38
+ Line 37
  # YEAR=2002
  # 1/1 Gerd Kortemeyer
  # Oct-Nov Jeremy Bowers
+ # YEAR=2003
+ # Jeremy Bowers ... lots of days
  package Apache::lonnavmaps;
  use strict;
  use Apache::Constants qw(:common :http);
  use Apache::loncommon();
+ use Apache::lonmenu();
  use POSIX qw (floor strftime);
+ use Data::Dumper; # for debugging, not always used
- my %navmaphash;
- my %parmhash;
  # symbolic constants
  sub SYMB { return 1; }
  Line 72  my %statusIconMap =
        $resObj->TRIES_LEFT         => 'navmap.open.gif',
        $resObj->INCORRECT          => 'navmap.wrong.gif',
        $resObj->OPEN               => 'navmap.open.gif',
-       $resObj->ATTEMPTED          => 'navmap.open.gif' );
+       $resObj->ATTEMPTED          => 'navmap.ellipsis.gif',
+       $resObj->ANSWER_SUBMITTED   => 'navmap.ellipsis.gif' );
  my %iconAltTags =
      ( 'navmap.correct.gif' => 'Correct',
- Line 91  my %colormap =
+ Line 92  my %colormap =
        $resObj->TRIES_LEFT             => '',
        $resObj->INCORRECT              => '',
        $resObj->OPEN                   => '',
-       $resObj->NOTHING_SET            => '' );
+       $resObj->NOTHING_SET            => '',
+       $resObj->ATTEMPTED              => '',
+       $resObj->ANSWER_SUBMITTED       => ''
+       );
  # And a special case in the nav map; what to do when the assignment
  # is not yet done and due in less then 24 hours
  my $hurryUpColor = "#FF0000";
- sub cleanup {
-     if (tied(%navmaphash)){
- 	&Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
-         unless (untie(%navmaphash)) {
- 	    &Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash');
-         }
-     }
-     if (tied(%parmhash)){
- 	&Apache::lonnet::logthis('Cleanup navmaps: parmhash');
-         unless (untie(%parmhash)) {
- 	    &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');
-         }
-     }
- }
  sub handler {
      my $r = shift;
      real_handler($r);
- Line 140  sub real_handler {
+ Line 129  sub real_handler {
      $r->send_http_header;
      # Create the nav map
-     my $navmap = Apache::lonnavmaps::navmap->new(
+     my $navmap = Apache::lonnavmaps::navmap->new(1, 1);
-                         $ENV{"request.course.fn"}.".db",
-                         $ENV{"request.course.fn"}."_parms.db", 1, 1);
      if (!defined($navmap)) {
- Line 152  sub real_handler {
+ Line 139  sub real_handler {
      }
      $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
-     $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->rflush();
- Line 164  sub real_handler {
+ Line 162  sub real_handler {
      # Now that we've displayed some stuff to the user, init the navmap
      $navmap->init();
-     $r->print('<br>&nbsp;');
      $r->rflush();
      # Check that it's defined
- Line 175  sub real_handler {
+ Line 171  sub real_handler {
          return OK;
      }
-     # renderer call
+     # See if there's only one map in the top-level, if we don't
-     my $render = render({ 'cols' => [0,1,2,3],
+     # already have a filter... if so, automatically display it
-                           'url' => '/adm/navmaps',
+     if ($ENV{QUERY_STRING} !~ /filter/) {
-                           'printKey' => 1,
+         my $iterator = $navmap->getIterator(undef, undef, undef, 0);
-                           'r' => $r});
+         my $depth = 1;
+         $iterator->next();
+         my $curRes = $iterator->next();
+         my $sequenceCount = 0;
+         my $sequenceId;
+         while ($depth > 0) {
+             if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
+             if ($curRes == $iterator->END_MAP()) { $depth--; }
+             if (ref($curRes) && $curRes->is_sequence()) {
+                 $sequenceCount++;
+                 $sequenceId = $curRes->map_pc();
+             }
+             $curRes = $iterator->next();
+         }
+         if ($sequenceCount == 1) {
+             # The automatic iterator creation in the render call
+             # will pick this up. We know the condition because
+             # the defined($ENV{'form.filter'}) also ensures this
+             # is a fresh call.
+             $ENV{'form.filter'} = "$sequenceId";
+         }
+     }
+     my $jumpToFirstHomework = 0;
+     # Check to see if the student is jumping to next open, do-able problem
+     if ($ENV{QUERY_STRING} eq 'jumpToFirstHomework') {
+         $jumpToFirstHomework = 1;
+         # Find the next homework problem that they can do.
+         my $iterator = $navmap->getIterator(undef, undef, undef, 1);
+         my $depth = 1;
+         $iterator->next();
+         my $curRes = $iterator->next();
+         my $foundDoableProblem = 0;
+         my $problemRes;
+         while ($depth > 0 && !$foundDoableProblem) {
+             if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
+             if ($curRes == $iterator->END_MAP()) { $depth--; }
+             if (ref($curRes) && $curRes->is_problem()) {
+                 my $status = $curRes->status();
+                 if ($curRes->completable()) {
+                     $problemRes = $curRes;
+                     $foundDoableProblem = 1;
+                     # Pop open all previous maps
+                     my $stack = $iterator->getStack();
+                     pop @$stack; # last resource in the stack is the problem
+                                  # itself, which we don't need in the map stack
+                     my @mapPcs = map {$_->map_pc()} @$stack;
+                     $ENV{'form.filter'} = join(',', @mapPcs);
+                     # Mark as both "here" and "jump"
+                     $ENV{'form.postsymb'} = $curRes->symb();
+                 }
+             }
+         } continue {
+             $curRes = $iterator->next();
+         }
+         # If we found no problems, print a note to that effect.
+         if (!$foundDoableProblem) {
+             $r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />");
+         }
+     } else {
+         $r->print("<a href='navmaps?jumpToFirstHomework'>" .
+                   "Go To My First Homework Problem</a>&nbsp;&nbsp;&nbsp;&nbsp;");
+     }
+     my $suppressEmptySequences = 0;
+     my $filterFunc = undef;
+     my $resource_no_folder_link = 0;
+     # Display only due homework.
+     my $showOnlyHomework = 0;
+     if ($ENV{QUERY_STRING} eq 'showOnlyHomework') {
+         $showOnlyHomework = 1;
+         $suppressEmptySequences = 1;
+         $filterFunc = sub { my $res = shift;
+                             return $res->completable() || $res->is_map();
+                         };
+         $r->print("<p><font size='+2'>Uncompleted Homework</font></p>");
+         $ENV{'form.filter'} = '';
+         $ENV{'form.condition'} = 1;
+ 	$resource_no_folder_link = 1;
+     } else {
+         $r->print("<a href='navmaps?showOnlyHomework'>" .
+                   "Show Only Uncompleted Homework</a>&nbsp;&nbsp;&nbsp;&nbsp;");
+     }
+     # renderer call
+     my $renderArgs = { 'cols' => [0,1,2,3],
+                        'url' => '/adm/navmaps',
+                        'navmap' => $navmap,
+                        'suppressNavmap' => 1,
+                        'suppressEmptySequences' => $suppressEmptySequences,
+                        'filterFunc' => $filterFunc,
+ 		       'resource_no_folder_link' => $resource_no_folder_link,
+                        'r' => $r};
+     my $render = render($renderArgs);
      $navmap->untieHashes();
+     # If no resources were printed, print a reassuring message so the
+     # user knows there was no error.
+     if ($renderArgs->{'counter'} == 0) {
+         if ($showOnlyHomework) {
+             $r->print("<p><font size='+1'>All homework is currently completed.</font></p>");
+         } else { # both jumpToFirstHomework and normal use the same: course must be empty
+             $r->print("<p><font size='+1'>This course is empty.</font></p>");
+         }
+     }
      $r->print("</body></html>");
      $r->rflush();
- Line 246  sub getDescription {
+ Line 353  sub getDescription {
      my $part = shift;
      my $status = $res->status($part);
-     if ($status == $res->NETWORK_FAILURE) { return ""; }
+     if ($status == $res->NETWORK_FAILURE) {
+         return "Having technical difficulties; please check status later";
+     }
      if ($status == $res->NOTHING_SET) {
          return "Not currently assigned.";
      }
- Line 273  sub getDescription {
+ Line 382  sub getDescription {
          return "Excused by instructor";
      }
      if ($status == $res->ATTEMPTED) {
-         return "Not yet graded.";
+         return "Answer submitted, not yet graded.";
      }
      if ($status == $res->TRIES_LEFT) {
          my $tries = $res->tries($part);
- Line 292  sub getDescription {
+ Line 401  sub getDescription {
              return "No due date $triesString";
          }
      }
+     if ($status == $res->ANSWER_SUBMITTED) {
+         return 'Answer submitted';
+     }
  }
  # Convenience function, so others can use it: Is the problem due in less then
- Line 302  sub dueInLessThen24Hours {
+ Line 414  sub dueInLessThen24Hours {
      my $part = shift;
      my $status = $res->status($part);
-     return ($status == $res->OPEN() || $status == $res->ATTEMPTED() ||
+     return ($status == $res->OPEN() ||
              $status == $res->TRIES_LEFT()) &&
             $res->duedate() && $res->duedate() < time()+(24*60*60) &&
             $res->duedate() > time();
- Line 322  sub lastTry {
+ Line 434  sub lastTry {
  }
  # This puts a human-readable name on the ENV variable.
  sub advancedUser {
-     return $ENV{'user.adv'};
+     return $ENV{'request.role.adv'};
  }
- Line 435  sub timeToHumanString {
+ Line 548  sub timeToHumanString {
  =pod
- =head1 navmap renderer
+ =head1 NAME
- The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this.
+ Apache::lonnavmap - Subroutines to handle and render the navigation
+     maps
- Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors.
+ =head1 SYNOPSIS
- The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}).
+ The main handler generates the navigational listing for the course,
+ the other objects export this information in a usable fashion for
+ other modules.
+ =head1 OVERVIEW
+ X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
+ course structure and caches it in what is often referred to as the
+ "big hash" X<big hash>. You can see it if you are logged into
+ LON-CAPA, in a course, by going to /adm/test. (You may need to
+ tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
+ content of the hash will be under the heading "Big Hash".
+ Big Hash contains, among other things, how resources are related
+ to each other (next/previous), what resources are maps, which
+ resources are being chosen to not show to the student (for random
+ selection), and a lot of other things that can take a lot of time
+ to compute due to the amount of data that needs to be collected and
+ processed.
+ Apache::lonnavmaps provides an object model for manipulating this
+ information in a higher-level fashion then directly manipulating
+ the hash. It also provides access to several auxilary functions
+ that aren't necessarily stored in the Big Hash, but are a per-
+ resource sort of value, like whether there is any feedback on
+ a given resource.
+ Apache::lonnavmaps also abstracts away branching, and someday,
+ conditions, for the times where you don't really care about those
+ things.
+ Apache::lonnavmaps also provides fairly powerful routines for
+ rendering navmaps, and last but not least, provides the navmaps
+ view for when the user clicks the NAV button.
+ B<Note>: Apache::lonnavmaps I<only> works for the "currently
+ logged in user"; if you want things like "due dates for another
+ student" lonnavmaps can not directly retrieve information like
+ that. You need the EXT function. This module can still help,
+ because many things, such as the course structure, are constant
+ between users, and Apache::lonnavmaps can help by providing
+ symbs for the EXT call.
+ The rest of this file will cover the provided rendering routines,
+ which can often be used without fiddling with the navmap object at
+ all, then documents the Apache::lonnavmaps::navmap object, which
+ is the key to accessing the Big Hash information, covers the use
+ of the Iterator (which provides the logic for traversing the
+ somewhat-complicated Big Hash data structure), documents the
+ Apache::lonnavmaps::Resource objects that are returned by
+ =head1 Subroutine: render
+ The navmap renderer package provides a sophisticated rendering of the
+ standard navigation maps interface into HTML. The provided nav map
+ handler is actually just a glorified call to this.
+ Because of the large number of parameters this function accepts,
+ instead of passing it arguments as is normal, pass it in an anonymous
+ hash with the desired options.
- =head2 Overview of Columns
+ The package provides a function called 'render', called as
+ Apache::lonnavmaps::render({}).
- The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table.
+ =head2 Overview of Columns
- Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer.
+ The renderer will build an HTML table for the navmap and return
+ it. The table is consists of several columns, and a row for each
+ resource (or possibly each part). You tell the renderer how many
+ columns to create and what to place in each column, optionally using
+ one or more of the prepared columns, and the renderer will assemble
+ the table.
+ Any additional generally useful column types should be placed in the
+ renderer code here, so anybody can use it anywhere else. Any code
+ specific to the current application (such as the addition of <input>
+ elements in a column) should be placed in the code of the thing using
+ the renderer.
+ At the core of the renderer is the array reference COLS (see Example
+ section below for how to pass this correctly). The COLS array will
+ consist of entries of one of two types of things: Either an integer
+ representing one of the pre-packaged column types, or a sub reference
+ that takes a resource reference, a part number, and a reference to the
+ argument hash passed to the renderer, and returns a string that will
+ be inserted into the HTML representation as it.
- At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it.
+ All other parameters are ways of either changing how the columns
+ are printing, or which rows are shown.
- The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist:
+ The pre-packaged column names are refered to by constants in the
+ Apache::lonnavmaps namespace. The following currently exist:
  =over 4
- =item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash:
+ =item * B<Apache::lonnavmaps::resource>:
+ The general info about the resource: Link, icon for the type, etc. The
+ first column in the standard nav map display. This column provides the
+ indentation effect seen in the B<NAV> screen. This column also accepts
+ the following parameters in the renderer hash:
  =over 4
- =item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links.
+ =item * B<resource_nolink>: default false
+ If true, the resource will not be linked. By default, all non-folder
+ resources are linked.
+ =item * B<resource_part_count>: default true
+ If true, the resource will show a part count B<if> the full
+ part list is not displayed. (See "condense_parts" later.) 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. True implies printCloseAll is false, since you
+ can't close or open folders when this is on anyhow.
  =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<Apache::lonnavmaps::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<Apache::lonnavmaps::quick_status>:
- =item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap.
+ An icon for the status of a problem, with five possible states:
+ Correct, incorrect, open, awaiting grading (for a problem where the
+ computer's grade is suppressed, or the computer can't grade, like
+ essay problem), or none (not open yet, not a problem). The
+ third column of the standard navmap.
- =item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap.
+ =item B<Apache::lonnavmaps::long_status>:
+ A text readout of the details of the current status of the problem,
+ such as "Due in 22 hours". The fourth column of the standard navmap.
  =back
  If you add any others please be sure to document them here.
- An example of a column renderer that will show the ID number of a resource, along with the part name if any:
+ An example of a column renderer that will show the ID number of a
+ resource, along with the part name if any:
   sub {
    my ($resource, $part, $params) = @_;
- Line 483  An example of a column renderer that wil
+ Line 710  An example of a column renderer that wil
    return '<td>' . $resource->{ID} . '</td>';
   }
- Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc.
+ Note these functions are responsible for the TD tags, which allow them
+ to override vertical and horizontal alignment, etc.
  =head2 Parameters
- Most of these parameters are only useful if you are *not* using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically.
+ Minimally, you should be
+ able to get away with just using 'cols' (to specify the columns
+ shown), 'url' (necessary for the folders to link to the current screen
+ correctly), and possibly 'queryString' if your app calls for it. In
+ that case, maintaining the state of the folders will be done
+ automatically.
  =over 4
- =item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like. If one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information.
+ =item * B<iterator>: default: constructs one from %ENV
+ 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>: default: not used
+ 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>: default: constructs one from %ENV
+ 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>: default: must be passed in
+ The standard Apache response object. This must be passed to the
+ renderer or the course hash will be locked.
+ =item * B<cols>: default: empty (useless)
+ An array reference
+ =item * B<showParts>:default true
+ A flag. If true, a line for the resource itself, and a line
+ for each part will be displayed. If not, only one line for each
+ resource will be displayed.
+ =item * B<condenseParts>: default true
+ A flag. If true, 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>: default: determined from %ENV
+ A string identifying the URL to place the anchor 'curloc' at.
+ 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<here>: default: empty string
+ A Symb identifying where to place the 'here' marker. The empty
+ string means no marker.
+ =item * B<indentString>: default: 25 pixel whitespace image
+ A string identifying the indentation string to use.
- =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<queryString>: default: empty
- =item * B<cols>: An array reference
+ A string which will be prepended to the query string used when the
+ folders are opened or closed. You can use this to pass
+ application-specific values.
- =item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed.
+ =item * B<url>: default: none
- =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.
+ The url the folders will link to, which should be the current
+ page. Required if the resource info column is shown, and you
+ are allowing the user to open and close folders.
- =item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information.
+ =item * B<currentJumpIndex>: default: no jumping
- =item * B<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info.
+ 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<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL.
+ =item * B<printKey>: default: false
- =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.
+ If true, print the key that appears on the top of the standard
+ navmaps.
- =item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed.
+ =item * B<printCloseAll>: default: true
- =item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown.
+ If true, print the "Close all folders" or "open all folders"
+ links.
- =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<filterFunc>: default: sub {return 1;} (accept everything)
- =item * B<r>: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself.
+ 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.
- =item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.
+ =item * B<suppressEmptySequences>: default: false
- =item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.
+ If you're using a filter function, and displaying sequences to orient
+ the user, then frequently some sequences will be empty. Setting this to
+ true will cause those sequences not to display, so as not to confuse the
+ user into thinking that if the sequence is there there should be things
+ under it; for example, see the "Show Uncompleted Homework" view on the
+ B<NAV> screen.
+ =item * B<suppressNavmaps>: default: false
+ If true, will not display Navigate Content resources.
  =back
  =head2 Additional Info
- In addition to the parameters you can pass to the renderer, which will be passed through unchange to the column renderers, the renderer will generate the following information which your renderer may find useful:
+ In addition to the parameters you can pass to the renderer, which will
+ be passed through unchange to the column renderers, the renderer will
+ generate the following information which your renderer may find
+ useful:
  =over 4
+ =item * B<counter>:
+ Contains the number of rows printed. Useful after calling the render
+ function, as you can detect whether anything was printed at all.
+ =item * B<isNewBranch>:
+ Useful for renderers: If this resource is currently the first resource
+ of a new branch, this will be true. The Resource column (leftmost in the
+ navmaps screen) uses this to display the "new branch" icon
  =back
  =cut
- Line 567  sub render_resource {
+ Line 894  sub render_resource {
      my $linkopen = "<a href='$link'>";
      my $linkclose = "</a>";
-     # Default icon: HTML page
+     # Default icon: unknown page
-     my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";
+     my $icon = "<img src='/adm/lonIcons/unknown.gif' alt='' border='0' />";
      if ($resource->is_problem()) {
-         if ($part eq "0" || $params->{'condensed'}) {
+         if ($part eq '0' || $params->{'condensed'}) {
              $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
          } else {
              $icon = $params->{'indentString'};
          }
+     } else {
+ 	my $curfext= (split (/\./,$resource->src))[-1];
+ 	my $embstyle = &Apache::loncommon::fileembstyle($curfext);
+ 	# The unless conditional that follows is a bit of overkill
+ 	if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
+ 	    $icon = "<img src='/adm/lonIcons/$curfext.gif' alt='' border='0' />";
+ 	}
      }
      # Display the correct map icon to open or shut map
- Line 585  sub render_resource {
+ Line 919  sub render_resource {
          if ($it->{CONDITION}) {
              $nowOpen = !$nowOpen;
          }
-         $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif';
-         $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
+ 	my $folderType = $resource->is_sequence() ? 'folder' : 'page';
-         $linkopen = "<a href='" . $params->{'url'} . '?' .
+         if (!$params->{'resource_no_folder_link'}) {
-             $params->{'queryString'} . '&filter=';
+             $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
-         $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
+             $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
-             addToFilter($filter, $mapId) :
-             removeFromFilter($filter, $mapId);
+             $linkopen = "<a href='" . $params->{'url'} . '?' .
-         $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
+                 $params->{'queryString'} . '&filter=';
-             . $params->{'hereType'} . '&here=' .
+             $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
-             &Apache::lonnet::escape($params->{'here'}) .
+                 addToFilter($filter, $mapId) :
-             '&jumpType=' . SYMB() . '&jump=' .
+                 removeFromFilter($filter, $mapId);
-             &Apache::lonnet::escape($resource->symb()) .
+             $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
-             "&folderManip=1'>";
+                 . $params->{'hereType'} . '&here=' .
+                 &Apache::lonnet::escape($params->{'here'}) .
+                 '&jump=' .
+                 &Apache::lonnet::escape($resource->symb()) .
+                 "&folderManip=1'>";
+         } else {
+             # Don't allow users to manipulate folder
+             $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
+                 '.nomanip.gif';
+             $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
+             $linkopen = "";
+             $linkclose = "";
+         }
      }
      if ($resource->randomout()) {
- Line 623  sub render_resource {
+ Line 970  sub render_resource {
      my $curMarkerEnd = '';
      # Is this the current resource?
      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>';
          $curMarkerEnd = '<font color="red" size="+2">&lt;</font>';
+         $params->{'displayedHereMarker'} = 1;
      }
-     if ($resource->is_problem() && $part ne "0" &&
+     if ($resource->is_problem() && $part ne '0' &&
          !$params->{'condensed'}) {
          $partLabel = " (Part $part)";
          $title = "";
      }
-     if ($params->{'multipart'} && $params->{'condensed'}) {
+     if ($params->{'condensed'} && $resource->countParts() > 1) {
          $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
      }
-     $result .= "  $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
+     if (!$params->{'resource_nolink'} && $src !~ /^\/uploaded\// &&
+ 	!$resource->is_sequence()) {
+         $result .= "  $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
+     } else {
+         $result .= "  $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
+     }
      return $result;
  }
- Line 685  sub render_communication_status {
+ Line 1035  sub render_communication_status {
          }
      }
+     if ($params->{'multipart'} && $part != '0') {
+ 	$discussionHTML = $feedbackHTML = $errorHTML = '';
+     }
      return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML&nbsp;</td>";
  }
- Line 739  sub render_long_status {
+ Line 1093  sub render_long_status {
      if ($resource->is_map() && advancedUser() && $resource->randompick()) {
          $result .= '(randomly select ' . $resource->randompick() .')';
      }
-     $result .= "&nbsp;</td>\n";
+     # Debugging code
+     #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
+     #	' - Part: ' . $part;
+     $result .= "</td>\n";
      return $result;
  }
- Line 771  sub render {
+ Line 1129  sub render {
          $navmap = $args->{'navmap'};
      }
+     my $r = $args->{'r'};
      my $queryString = $args->{'queryString'};
-     my $jumpToURL = $args->{'jumpToURL'};
+     my $jump = $args->{'jump'};
-     my $jumpToSymb = $args->{'jumpToSymb'};
+     my $here = $args->{'here'};
-     my $jumpType;
+     my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
-     my $hereURL = $args->{'hereURL'};
-     my $hereSymb = $args->{'hereSymb'};
-     my $hereType;
-     my $here;
-     my $jump;
-     my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0);
      my $currentJumpDelta = 2; # change this to change how many resources are displayed
                               # before the current resource when using #current
- Line 796  sub render {
+ Line 1149  sub render {
          }
      }
+     # Filter: Remember filter function and add our own filter: Refuse
+     # to show hidden resources unless the user can see them.
+     my $userCanSeeHidden = advancedUser();
+     my $filterFunc = setDefault($args->{'filterFunc'},
+                                 sub {return 1;});
+     if (!$userCanSeeHidden) {
+         # Without renaming the filterfunc, the server seems to go into
+         # an infinite loop
+         my $oldFilterFunc = $filterFunc;
+         $filterFunc = sub { my $res = shift; return !$res->randomout() &&
+                                 &$oldFilterFunc($res);};
+     }
      my $condition = 0;
      if ($ENV{'form.condition'}) {
          $condition = 1;
- Line 804  sub render {
+ Line 1170  sub render {
      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(
+             $navmap = Apache::lonnavmaps::navmap->new(1, 1);
-                         $ENV{"request.course.fn"}.".db",
-                         $ENV{"request.course.fn"}."_parms.db", 1, 1);
              $mustCloseNavMap = 1;
          }
          $navmap->init();
- Line 814  sub render {
+ Line 1178  sub render {
          # Step two: Locate what kind of here marker is necessary
          # Determine where the "here" marker is and where the screen jumps to.
-         # We're coming from the remote. We have either a url, a symb, or nothing,
+         if ($ENV{'form.postsymb'}) {
-         # and we need to figure out what.
+             $here = $jump = $ENV{'form.postsymb'};
-         # 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/^http\:\/\///;
-             $currenturl=~s/^[^\/]+//;
+             #$currenturl=~s/^[^\/]+//;
-             $hereType = $jumpType = URL;
+             $here = $jump = &Apache::lonnet::symbread($currenturl);
-             $here = $jump = $currenturl;
-         } else {
-             # Nothing
-             $hereType = $jumpType = NOTHING();
          }
          # Step three: Ensure the folders are open
          my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
          my $depth = 1;
          $mapIterator->next(); # discard the first BEGIN_MAP
          my $curRes = $mapIterator->next();
-         my $counter = 0;
          my $found = 0;
          # We only need to do this if we need to open the maps to show the
- Line 848  sub render {
+ Line 1203  sub render {
              if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
              if ($curRes == $mapIterator->END_MAP()) { $depth--; }
-             if (ref($curRes) &&
+             if (ref($curRes) && $curRes->symb() eq $here) {
-                 ($hereType == SYMB() && $curRes->symb() eq $here) ||
-                 (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {
                  my $mapStack = $mapIterator->getStack();
                  # Ensure the parent maps are open
- Line 866  sub render {
+ Line 1219  sub render {
              $curRes = $mapIterator->next();
          }
-         # Since we changed the folders, (re-)locate the jump point, if any
-         $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
-         $depth = 1;
-         $mapIterator->next();
-         $curRes = $mapIterator->next();
-         my $foundJump = 0;
-         while ($depth > 0 && !$foundJump) {
-             if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
-             if ($curRes == $mapIterator->END_MAP()) { $depth--; }
-             if (ref($curRes)) { $counter++; }
-             if (ref($curRes) &&
-                 (($jumpType == SYMB() && $curRes->symb() eq $jump) ||
-                  ($jumpType == URL() && $curRes->src() eq $jump))) {
-                 # This is why we have to use the main iterator instead of the
-                 # potentially faster DFS: The count has to be the same, so
-                 # the order has to be the same, which DFS won't give us.
-                 $currentJumpIndex = $counter;
-                 $foundJump = 1;
-             }
-             $curRes = $mapIterator->next();
-         }
      }
      if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
          # If this is a click on a folder or something, we want to preserve the "here"
          # from the querystring, and get the new "jump" marker
-         $hereType = $ENV{'form.hereType'};
          $here = $ENV{'form.here'};
-         $jumpType = $ENV{'form.jumpType'} || NOTHING();
          $jump = $ENV{'form.jump'};
      }
- Line 909  sub render {
+ Line 1234  sub render {
          # Step 1: Check to see if we have a navmap
          if (!defined($navmap)) {
-             $navmap = Apache::lonnavmaps::navmap->new(
+             $navmap = Apache::lonnavmaps::navmap->new(1, 1);
-                         $ENV{"request.course.fn"}.".db",
-                         $ENV{"request.course.fn"}."_parms.db", 1, 1);
              $mustCloseNavMap = 1;
          }
          # Paranoia: Make sure it's ready
          $navmap->init();
-         $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
+         # 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);
+         }
      }
+     # (re-)Locate the jump point, if any
+     # Note this does not take filtering or hidden into account... need
+     # to be fixed?
+     my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
+     my $depth = 1;
+     $mapIterator->next();
+     my $curRes = $mapIterator->next();
+     my $foundJump = 0;
+     my $counter = 0;
+     while ($depth > 0 && !$foundJump) {
+         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 $r = $args->{'r'};
      my $printKey = $args->{'printKey'};
      my $printCloseAll = $args->{'printCloseAll'};
      if (!defined($printCloseAll)) { $printCloseAll = 1; }
      # Print key?
      if ($printKey) {
          $result .= '<table border="0" cellpadding="2" cellspacing="0">';
- Line 952  sub render {
+ Line 1311  sub render {
          $result .= '</tr></table>';
      }
-     if ($printCloseAll) {
+     if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
          if ($condition) {
              $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
-                 "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
+                 "&here=" . Apache::lonnet::escape($here) .
                  "\">Close All Folders</a>";
          } else {
              $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
-                 "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
+                 "&here=" . Apache::lonnet::escape($here) .
                  "\">Open All Folders</a>";
          }
+         $result .= "<br /><br />\n";
      }
      if ($r) {
- Line 988  sub render {
+ Line 1348  sub render {
      $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");
      $args->{'displayedHereMarker'} = 0;
+     # If we're suppressing empty sequences, look for them here. Use DFS for speed,
+     # since structure actually doesn't matter, except what map has what resources.
+     if ($args->{'suppressEmptySequences'}) {
+         my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
+                                                          $it->{FIRST_RESOURCE},
+                                                          $it->{FINISH_RESOURCE},
+                                                          {}, undef, 1);
+         $depth = 0;
+         $dfsit->next();
+         my $curRes = $dfsit->next();
+         while ($depth > -1) {
+             if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
+             if ($curRes == $dfsit->END_MAP()) { $depth--; }
+             if (ref($curRes)) {
+                 # Parallel pre-processing: Do sequences have non-filtered-out children?
+                 if ($curRes->is_map()) {
+                     $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
+                     # Sequences themselves do not count as visible children,
+                     # unless those sequences also have visible children.
+                     # This means if a sequence appears, there's a "promise"
+                     # that there's something under it if you open it, somewhere.
+                 } else {
+                     # Not a sequence: if it's filtered, ignore it, otherwise
+                     # rise up the stack and mark the sequences as having children
+                     if (&$filterFunc($curRes)) {
+                         for my $sequence (@{$dfsit->getStack()}) {
+                             $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
+                         }
+                     }
+                 }
+             }
+         } continue {
+             $curRes = $dfsit->next();
+         }
+     }
      my $displayedJumpMarker = 0;
      # Set up iteration.
-     my $depth = 1;
+     $depth = 1;
      $it->next(); # discard initial BEGIN_MAP
-     my $curRes = $it->next();
+     $curRes = $it->next();
      my $now = time();
      my $in24Hours = $now + 24 * 60 * 60;
      my $rownum = 0;
      # export "here" marker information
      $args->{'here'} = $here;
-     $args->{'hereType'} = $hereType;
      while ($depth > 0) {
          if ($curRes == $it->BEGIN_MAP()) { $depth++; }
- Line 1021  sub render {
+ Line 1417  sub render {
          # If this isn't an actual resource, continue on
          if (!ref($curRes)) {
-             $curRes = $it->next();
+             next;
+         }
+         # If this has been filtered out, continue on
+         if (!(&$filterFunc($curRes))) {
+             $args->{'isNewBranch'} = 0; # Don't falsely remember this
+             next;
+         }
+         # If this is an empty sequence and we're filtering them, continue on
+         if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
+             !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
+             next;
+         }
+         # If we're suppressing navmaps and this is a navmap, continue on
+         if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
              next;
          }
- Line 1035  sub render {
+ Line 1447  sub render {
          # Decide what parts to show.
          if ($curRes->is_problem() && $showParts) {
              @parts = @{$curRes->parts()};
-             $args->{'multipart'} = scalar(@parts) > 1;
+             $args->{'multipart'} = $curRes->multipart();
              if ($condenseParts) { # do the condensation
                  if (!$curRes->opendate("0")) {
-                     @parts = ("0");
+                     @parts = ();
                      $args->{'condensed'} = 1;
                  }
                  if (!$args->{'condensed'}) {
                      # Decide whether to condense based on similarity
-                     my $status = $curRes->status($parts[1]);
+                     my $status = $curRes->status($parts[0]);
-                     my $due = $curRes->duedate($parts[1]);
+                     my $due = $curRes->duedate($parts[0]);
-                     my $open = $curRes->opendate($parts[1]);
+                     my $open = $curRes->opendate($parts[0]);
                      my $statusAllSame = 1;
                      my $dueAllSame = 1;
                      my $openAllSame = 1;
-                     for (my $i = 2; $i < scalar(@parts); $i++) {
+                     for (my $i = 1; $i < scalar(@parts); $i++) {
                          if ($curRes->status($parts[$i]) != $status){
                              $statusAllSame = 0;
                          }
- Line 1071  sub render {
+ Line 1483  sub render {
                      if (($statusAllSame && defined($condenseStatuses{$status})) ||
                          ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
                          ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
-                         @parts = ($parts[1]);
+                         @parts = ($parts[0]);
                          $args->{'condensed'} = 1;
                      }
                  }
+ 		# Multipart problem with one part: always "condense" (happens
+ 		#  to match the desirable behavior)
+ 		if ($curRes->countParts() == 1) {
+ 		    @parts = ($parts[0]);
+ 		    $args->{'condensed'} = 1;
+ 		}
              }
+         }
-         } else {
-             # Not showing parts
-             @parts = ("0"); # show main part only
-         }
          # If the multipart problem was condensed, "forget" it was multipart
          if (scalar(@parts) == 1) {
              $args->{'multipart'} = 0;
-         }
+         } else {
+             # Add part 0 so we display it correctly.
-         # In the event of a network error, display one part.
+             unshift @parts, '0';
-         # 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
- Line 1138  sub render {
+ Line 1546  sub render {
              $result .= "    </tr>\n";
              $args->{'isNewBranch'} = 0;
          }
          if ($r && $rownum % 20 == 0) {
              $r->print($result);
              $result = "";
              $r->rflush();
          }
+     } continue {
          $curRes = $it->next();
+ 	if ($r) {
+ 	    # If we have the connection, make sure the user is still connected
+ 	    my $c = $r->connection;
+ 	    if ($c->aborted()) {
+ 		Apache::lonnet::logthis("navmaps aborted");
+ 		# Who cares what we do, nobody will see it anyhow.
+ 		return '';
+ 	    }
+ 	}
      }
      # Print out the part that jumps to #curloc if it exists
+     # delay needed because the browser is processing the jump before
+     # 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>location += \"#curloc\";</script>\n";
+         $result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n";
      }
      $result .= "</table>";
- Line 1172  package Apache::lonnavmaps::navmap;
+ Line 1596  package Apache::lonnavmaps::navmap;
  =pod
- lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere.
+ =head1 Object: Apache::lonnavmaps::navmap
+ =head2 Overview
+ The navmap object's job is to provide access to the resources
+ in the course as Apache::lonnavmaps::resource objects, and to
+ query and manage the relationship between those resource objects.
+ Generally, you'll use the navmap object in one of three basic ways.
+ In order of increasing complexity and power:
+ =over 4
+ =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
+     various ways to obtain resource objects, based on various identifiers.
+     Use this when you want to request information about one object or
+     a handful of resources you already know the identities of, from some
+     other source. For more about Ids, Symbs, and MapPcs, see the
+     Resource documentation. Note that Url should be a B<last resort>,
+     not your first choice; it only works when there is only one
+     instance of the resource in the course, which only applies to
+     maps, and even that may change in the future.
+ =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
+     retrieves resources matching some criterion and returns them
+     in a flat array, with no structure information. Use this when
+     you are manipulating a series of resources, based on what map
+     the are in, but do not care about branching, or exactly how
+     the maps and resources are related. This is the most common case.
+ =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
+     the course's navmap in various ways without writing the traversal
+     code yourself. See iterator documentation below. Use this when
+     you need to know absolutely everything about the course, including
+     branches and the precise relationship between maps and resources.
+ =back
+ =head2 Creation And Destruction
- =head1 navmap object: Encapsulating the compiled nav map
+ To create a navmap object, use the following function:
- navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
+ =over 4
+ =item * B<Apache::lonnavmaps::navmap-E<gt>new>(
+   genCourseAndUserOptions, genMailDiscussStatus, getUserData):
- Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.
+ Creates a new navmap object. 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. getUserData, if true, will
+ retreive the user's performance data for various problems.
+ =back
- You must obtain resource objects through the navmap object.
+ Once you have the $navmap object, call ->init() on it when you are ready
+ to use it. This allows you to check if the course map is defined (see
+ B<courseMapDefined> below) before engaging in potentially expensive
+ initialization routines for the genCourseAndUserOptions and
+ genMailDiscussStatus option.
+ When you are done with the $navmap object, you I<must> call
+ $navmap->untieHashes(), or you'll prevent the current user from using that
+ course until the web server is restarted. (!)
  =head2 Methods
  =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<getIterator>(first, finish, filter, condition):
- =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
+ See iterator documentation below.
  =cut
- Line 1201  sub new {
+ Line 1685  sub new {
      my $class = ref($proto) || $proto;
      my $self = {};
-     $self->{NAV_HASH_FILE} = shift;
-     $self->{PARM_HASH_FILE} = shift;
      $self->{GENERATE_COURSE_USER_OPT} = shift;
      $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
+     $self->{GET_USER_DATA} = shift;
      # Resource cache stores navmap resources as we reference them. We generate
      # them on-demand so we don't pay for creating resources unless we use them.
- Line 1216  sub new {
+ Line 1699  sub new {
      # tie the nav hash
-     if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
+     my %navmaphash;
+     my %parmhash;
+     my $courseFn = $ENV{"request.course.fn"};
+     if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
                &GDBM_READER(), 0640))) {
          return undef;
      }
-     if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
+     if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
                &GDBM_READER(), 0640)))
      {
-         untie $self->{PARM_HASH};
+         untie %{$self->{PARM_HASH}};
          return undef;
      }
-     $self->{HASH_TIED} = 1;
      $self->{NAV_HASH} = \%navmaphash;
      $self->{PARM_HASH} = \%parmhash;
      $self->{INITED} = 0;
- Line 1260  sub init {
+ Line 1745  sub init {
              unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
                  my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
                                                   ':resourcedata',$chome);
-                 if ($reply!~/^error\:/) {
+                 # Check for network failure
+                 if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) {
+                     $self->{NETWORK_FAILURE} = 1;
+                 } elsif ($reply!~/^error\:/) {
                      $courserdatas{$cid}=$reply;
                      $courserdatas{$cid.'.last_cache'}=time;
                  }
-                 # check to see if network failed
-                 elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
-                 {
-                     $self->{NETWORK_FAILURE} = 1;
-                 }
              }
              foreach (split(/\&/,$courserdatas{$cid})) {
                  my ($name,$value)=split(/\=/,$_);
- Line 1305  sub init {
+ Line 1788  sub init {
          my %emailstatus = &Apache::lonnet::dump('email_status');
          my $logoutTime = $emailstatus{'logout'};
          my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
-         $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ?
+         $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
                                 $courseLeaveTime : $logoutTime);
          my %discussiontime = &Apache::lonnet::dump('discussiontimes',
                                                     $cdom, $cnum);
- Line 1343  sub init {
+ Line 1826  sub init {
          $self->{DISCUSSION_TIME} = \%discussiontime;
          $self->{EMAIL_STATUS} = \%emailstatus;
      }
+     if ($self->{GET_USER_DATA}) {
+ 	# Retreive performance data on problems
+ 	my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},
+ 						       $ENV{'user.domain'},
+ 						       $ENV{'user.name'});
+ 	$self->{STUDENT_DATA} = \%student_data;
+     }
      $self->{PARM_CACHE} = {};
      $self->{INITED} = 1;
- Line 1356  sub navhash {
+ Line 1847  sub navhash {
      return $self->{NAV_HASH}->{$key};
  }
+ =pod
+ =item * B<courseMapDefined>(): Returns true if the course map is defined,
+     false otherwise. Undefined course maps indicate an error somewhere in
+     LON-CAPA, and you will not be able to proceed with using the navmap.
+     See the B<NAV> screen for an example of using this.
+ =cut
  # Checks to see if coursemap is defined, matching test in old lonnavmaps
  sub courseMapDefined {
      my $self = shift;
- Line 1376  sub getIterator {
+ Line 1876  sub getIterator {
  # unties the hash when done
  sub untieHashes {
      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;
- }
- # when the object is destroyed, be sure to untie all the hashes we tied.
- sub DESTROY {
-     my $self = shift;
-     $self->untieHashes();
  }
  # Private method: Does the given resource (as a symb string) have
- Line 1422  sub getErrors {
+ Line 1915  sub getErrors {
  =pod
- =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
+ =item * B<getById>(id):
+ Based on the ID of the resource (1.1, 3.2, etc.), get a resource
+ object for that resource. This method, or other methods that use it
+ (as in the resource object) is the only proper way to obtain a
+ resource object.
+ =item * B<getBySymb>(symb):
+ Based on the symb of the resource, get a resource object for that
+ resource. This is one of the proper ways to get a resource object.
+ =item * B<getMapByMapPc>(map_pc):
+ Based on the map_pc of the resource, get a resource object for
+ the given map. This is one of the proper ways to get a resource object.
  =cut
  # The strategy here is to cache the resource objects, and only construct them
  # as we use them. The real point is to prevent reading any more from the tied
  # hash then we have to, which should hopefully alleviate speed problems.
- # Caching is just an incidental detail I throw in because it makes sense.
  sub getById {
      my $self = shift;
- Line 1446  sub getById {
+ Line 1953  sub getById {
      return "Apache::lonnavmaps::resource"->new($self, $id);
  }
+ sub getBySymb {
+     my $self = shift;
+     my $symb = shift;
+     my ($mapUrl, $id, $filename) = split (/___/, $symb);
+     my $map = $self->getResourceByUrl($mapUrl);
+     return $self->getById($map->map_pc() . '.' . $id);
+ }
+ sub getByMapPc {
+     my $self = shift;
+     my $map_pc = shift;
+     my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
+     $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
+     return $self->getById($map_id);
+ }
  =pod
- =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
+ =item * B<firstResource>():
+ Returns a resource object reference corresponding to the first
+ resource in the navmap.
  =cut
- Line 1461  sub firstResource {
+ Line 1987  sub firstResource {
  =pod
- =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
+ =item * B<finishResource>():
+ Returns a resource object reference corresponding to the last resource
+ in the navmap.
  =cut
- Line 1490  sub parmval {
+ Line 2019  sub parmval {
  sub parmval_real {
      my $self = shift;
-     my ($what,$symb) = @_;
+     my ($what,$symb,$recurse) = @_;
      my $cid=$ENV{'request.course.id'};
      my $csec=$ENV{'request.course.sec'};
- Line 1558  sub parmval_real {
+ Line 2087  sub parmval_real {
      my ($space,@qualifier)=split(/\./,$rwhat);
      my $qualifier=join('.',@qualifier);
      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,1);
-             my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
+ 	if (defined($partgeneral)) { return $partgeneral; }
-             if (defined($resourcegeneral)) { return $resourcegeneral; }
+     }
+     if ($recurse) { return undef; }
+     my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
+     if (defined($pack_def)) { return $pack_def; }
+     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 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->getResourceByUrl($map);
+     }
+     # If nothing was passed, assume top-level map
+     if (!$map) {
+ 	$map = $self->getById('0.0');
+     }
+     # Check the map's validity.
+     if (!$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(),
+                                 undef, $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;
+             }
          }
+     } continue {
+         $curRes = $it->next();
      }
-     return '';
+     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;
  }
 ;
- Line 1578  package Apache::lonnavmaps::iterator;
+ Line 2243  package Apache::lonnavmaps::iterator;
  =back
- =head1 navmap Iterator
+ =head1 Object: navmap Iterator
- An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.
- To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:
+ An I<iterator> encapsulates the logic required to traverse a data
+ structure. navmap uses an iterator to traverse the course map
+ according to the criteria you wish to use.
+ To obtain an iterator, call the B<getIterator>() function of a
+ B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
+ directly.) This will return a reference to the iterator:
  C<my $resourceIterator = $navmap-E<gt>getIterator();>
- Line 1594  getIterator behaves as follows:
+ Line 2263  getIterator behaves as follows:
  =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):
- 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.
- The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
+ 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 resources 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.
+ The iterator will return either a reference to a resource object, or a
+ token representing something in the map, such as the beginning of a
+ new branch. The possible tokens are:
  =over 4
- =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
+ =item * B<BEGIN_MAP>:
+ A new map is being recursed into. This is returned I<after> the map
+ resource itself is returned.
+ =item * B<END_MAP>:
+ The map is now done.
- =item * END_MAP: The map is now done.
+ =item * B<BEGIN_BRANCH>:
- =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
+ A branch is now starting. The next resource returned will be the first
+ in that branch.
- =item * END_BRANCH: The branch is now done.
+ =item * B<END_BRANCH>:
+ The branch is now done.
  =back
- The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
+ The tokens are retreivable via methods on the iterator object, i.e.,
+ $iterator->END_MAP.
- Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned.
+ Maps can contain empty resources. The iterator will automatically skip
+ over such resources, but will still treat the structure
+ correctly. Thus, a complicated map with several branches, but
+ consisting entirely of empty resources except for one beginning or
+ ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
+ but only one resource will be returned.
  =back
- Line 1634  sub min {
+ Line 2344  sub min {
      if ($a < $b) { return $a; } else { return $b; }
  }
- # In the CVS repository, documentation of this algorithm is included
- # in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1**
- # will reference the same location in the text as the part of the
- # algorithm is running through.
  sub new {
      # magic invocation to create a class instance
      my $proto = shift;
- Line 1669  sub new {
+ Line 2374  sub new {
      # Do we want to automatically follow "redirection" maps?
      $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
      # over the parts of the map we're going to look at.
- Line 1689  sub new {
+ Line 2399  sub new {
      # that isn't just a redirector.
      my $resource; my $resourceCount = 0;
+     # Documentation on this algorithm can be found in the CVS repository at
+     # /docs/lonnavdocs; these "**#**" markers correspond to documentation
+     # in that file.
      # **1**
      foreach my $pass (@iterations) {
- Line 1743  sub new {
+ Line 2456  sub new {
                  $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
                  if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
-                 }
+             }
+         } continue {
              $curRes = $iterator->next();
          }
      }
- Line 1782  sub new {
+ Line 2496  sub new {
  sub next {
      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}) {
          # grab the next from the recursive iterator
          my $next = $self->{RECURSIVE_ITERATOR}->next();
- Line 1924  sub next {
+ Line 2645  sub next {
  =pod
- The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).
+ The other method available on the iterator is B<getStack>, which
+ returns an array populated with the current 'stack' of maps, as
+ references to the resource objects. Example: This is useful when
+ making the navigation map, as we need to check whether we are under a
+ page map to see if we need to link directly to the resource, or to the
+ page. The first elements in the array will correspond to the top of
+ the stack (most inclusive map).
  =cut
- Line 2107  sub next {
+ Line 2834  sub next {
      return $self->{HERE};
  }
-;
+ # Identical to the full iterator methods of the same name. Hate to copy/paste
+ # but I also hate to "inherit" either iterator from the other.
- package Apache::lonnavmaps::resource;
+ sub getStack {
+     my $self=shift;
- use Apache::lonnet;
+     my @stack;
- =pod
+     $self->populateStack(\@stack);
- =head1 Object: resource
+     return \@stack;
+ }
- A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.
+ # Private method: Calls the iterators recursively to populate the stack.
+ sub populateStack {
+     my $self=shift;
+     my $stack = shift;
- A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
+     push @$stack, $self->{HERE} if ($self->{HERE});
- You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource.
+     if ($self->{RECURSIVE_ITERATOR_FLAG}) {
+         $self->{RECURSIVE_ITERATOR}->populateStack($stack);
+     }
+ }
- =head2 Public Members
+;
- resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.
+ package Apache::lonnavmaps::resource;
- =head2 Methods
+ use Apache::lonnet;
- =over 4
+ =pod
- =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.
+ =head1 Object: resource
- =back
+ X<resource, navmap object>
+ A resource object encapsulates a resource in a resource map, allowing
+ easy manipulation of the resource, querying the properties of the
+ resource (including user properties), and represents a reference that
+ can be used as the canonical representation of the resource by
+ lonnavmap clients like renderers.
+ 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::lonnavmaps::navmap, and use the "start" method to obtain the
+ starting resource.
+ Resource objects respect the parameter_hiddenparts, which suppresses
+ various parts according to the wishes of the map author. As of this
+ writing, there is no way to override this parameter, and suppressed
+ parts will never be returned, nor will their response types or ids be
+ stored.
+ =head2 Overview
+ A B<Resource> is the most granular type of object in LON-CAPA that can
+ be included in a course. It can either be a particular resource, like
+ an HTML page, external resource, problem, etc., or it can be a
+ container sequence, such as a "page" or a "map".
+ To see a sequence from the user's point of view, please see the
+ B<Creating a Course: Maps and Sequences> chapter of the Author's
+ Manual.
+ A Resource Object, once obtained from a navmap object via a B<getBy*>
+ method of the navmap, or from an iterator, allows you to query
+ information about that resource.
+ Generally, you do not ever want to create a resource object yourself,
+ so creation has been left undocumented. Always retrieve resources
+ from navmap objects.
+ =head3 Identifying Resources
+ X<big hash>Every resource is identified by a Resource ID in the big hash that is
+ unique to that resource for a given course. X<resource ID, in big hash>
+ The Resource ID has the form #.#, where the first number is the same
+ for every resource in a map, and the second is unique. For instance,
+ for a course laid out like this:
+  * Problem 1
+  * Map
+    * Resource 2
+    * Resource 3
+ C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
+ C<Resource 3> will share a first number. The second number may end up
+ re-used between the two groups.
+ The resource ID is only used in the big hash, but can be used in the
+ context of a course to identify a resource easily. (For instance, the
+ printing system uses it to record which resources from a sequence you
+ wish to print.)
+ X<symb> X<resource, symb>
+ All resources also have B<symb>s, which uniquely identify a resource
+ in a course. Many internal LON-CAPA functions expect a symb. A symb
+ carries along with it the URL of the resource, and the map it appears
+ in. Symbs are much larger then resource IDs.
  =cut
- Line 2172  sub navHash {
+ Line 2973  sub navHash {
  =pod
- B<Metadata Retreival>
+ =head2 Methods
- These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.
+ Once you have a resource object, here's what you can do with it:
+ =head3 Attribute Retrieval
+ Every resource has certain attributes that can be retrieved and used:
  =over 4
- =item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem").
+ =item * B<ID>: Every resource has an ID that is unique for that
+     resource in the course it is in. The ID is actually in the hash
+     representing the resource, so for a resource object $res, obtain
+     it via C<$res->{ID}).
+ =item * B<compTitle>:
+ Returns a "composite title", that is equal to $res->title() if the
+ resource has a title, and is otherwise the last part of the URL (e.g.,
+ "problem.problem").
+ =item * B<ext>:
+ Returns true if the resource is external.
- =item * B<ext>: Returns true if the resource is external.
+ =item * B<kind>:
- =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
+ Returns the kind of the resource from the compiled nav map.
- =item * B<kind>: Returns the kind of the resource from the compiled nav map.
+ =item * B<randomout>:
- =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false.
+ Returns true if this resource was chosen to NOT be shown to the user
+ by the random map selection feature. In other words, this is usually
+ false.
- =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
+ =item * B<randompick>:
- =item * B<src>: Returns the source for the resource.
+ Returns true for a map if the randompick feature is being used on the
+ map. (?)
- =item * B<symb>: Returns the symb for the resource.
+ =item * B<src>:
- =item * B<title>: Returns the title of the resource.
+ Returns the source for the resource.
- =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
+ =item * B<symb>:
+ Returns the symb for the resource.
+ =item * B<title>:
+ Returns the title of the resource.
  =back
- Line 2207  These are methods that help you retrieve
+ Line 3034  These are methods that help you retrieve
  sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
  sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
  sub from { my $self=shift; return $self->navHash("from_", 1); }
+ # considered private and undocumented
  sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
  sub kind { my $self=shift; return $self->navHash("kind_", 1); }
  sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
- Line 2227  sub symb {
+ Line 3055  sub symb {
           $self->navHash('map_id_'.$first))
          . '___' . $second . '___' . $symbSrc;
  }
- sub title { my $self=shift; return $self->navHash("title_", 1); }
+ sub title {
+     my $self=shift;
+     if ($self->{ID} eq '0.0') {
+ 	# If this is the top-level map, return the title of the course
+ 	# since this map can not be titled otherwise.
+ 	return $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+     }
+     return $self->navHash("title_", 1); }
+ # considered private and undocumented
  sub to { my $self=shift; return $self->navHash("to_", 1); }
  sub compTitle {
      my $self = shift;
      my $title = $self->title();
+     $title=~s/\&colon\;/\:/gs;
      if (!$title) {
          $title = $self->src();
          $title = substr($title, rindex($title, '/') + 1);
- Line 2246  These methods are shortcuts to deciding
+ Line 3083  These methods are shortcuts to deciding
  =over 4
- =item * B<is_map>: Returns true if the resource is a map type.
+ =item * B<is_map>:
+ Returns true if the resource is a map type.
+ =item * B<is_problem>:
+ Returns true if the resource is a problem type, false
+ otherwise. (Looks at the extension on the src field; might need more
+ to work correctly.)
- =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
+ =item * B<is_page>:
- =item * B<is_page>: Returns true if the resource is a page.
+ Returns true if the resource is a page.
- =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
- Line 2268  sub is_map { my $self=shift; return defi
+ Line 3115  sub is_map { my $self=shift; return defi
  sub is_page {
      my $self=shift;
      my $src = $self->src();
-     return ($src =~ /page$/);
+     return $self->navHash("is_map_", 1) &&
+ 	$self->navHash("map_type_" . $self->map_pc()) eq 'page';
  }
  sub is_problem {
      my $self=shift;
- Line 2278  sub is_problem {
+ Line 3126  sub is_problem {
  sub is_sequence {
      my $self=shift;
      my $src = $self->src();
-     return ($src =~ /sequence$/);
+     return $self->navHash("is_map_", 1) &&
+ 	$self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
  }
  # Private method: Shells out to the parmval in the nav map, handler parts.
  sub parmval {
      my $self = shift;
      my $what = shift;
-     my $part = shift || "0";
+     my $part = shift;
+     if (!defined($part)) {
+         $part = '0';
+     }
      return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
  }
- Line 2293  sub parmval {
+ Line 3145  sub parmval {
  B<Map Methods>
- These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
+ These methods are useful for getting information about the map
+ properties of the resource, if the resource is a map (B<is_map>).
  =over 4
- =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
+ =item * B<map_finish>:
+ Returns a reference to a resource object corresponding to the finish
+ resource of the map.
+ =item * B<map_pc>:
+ Returns the pc value of the map, which is the first number that
+ appears in the resource ID of the resources in the map, and is the
+ number that appears around the middle of the symbs of the resources in
+ that map.
- =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
+ =item * B<map_start>:
- =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
+ Returns a reference to a resource object corresponding to the start
+ resource of the map.
- =item * B<map_type>: Returns a string with the type of the map in it.
+ =item * B<map_type>:
+ Returns a string with the type of the map in it.
  =back
- Line 2312  These methods are useful for getting inf
+ Line 3178  These methods are useful for getting inf
  sub map_finish {
      my $self = shift;
      my $src = $self->src();
+     $src = Apache::lonnet::clutter($src);
      my $res = $self->navHash("map_finish_$src", 0);
      $res = $self->{NAV_MAP}->getById($res);
      return $res;
- Line 2324  sub map_pc {
+ Line 3191  sub map_pc {
  sub map_start {
      my $self = shift;
      my $src = $self->src();
+     $src = Apache::lonnet::clutter($src);
      my $res = $self->navHash("map_start_$src", 0);
      $res = $self->{NAV_MAP}->getById($res);
      return $res;
- Line 2334  sub map_type {
+ Line 3202  sub map_type {
      return $self->navHash("map_type_$pc", 0);
  }
  #####
  # Property queries
  #####
- Line 2350  sub map_type {
+ Line 3216  sub map_type {
  =head2 Resource Parameters
- In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.
+ In order to use the resource parameters correctly, the nav map must
+ have been instantiated with genCourseAndUserOptions set to true, so
- These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
+ the courseopt and useropt is read correctly. Then, you can call these
+ functions to get the relevant parameters for the resource. Each
+ function defaults to part "0", but can be directed to another part by
+ passing the part as the parameter.
+ These methods are responsible for getting the parameter correct, not
+ merely reflecting the contents of the GDBM hashes. As we move towards
+ dates relative to other dates, these methods should be updated to
+ reflect that. (Then, anybody using these methods will not have to update
+ their code.)
  =over 4
- =item * B<acc>: Get the Client IP/Name Access Control information.
+ =item * B<acc>:
+ Get the Client IP/Name Access Control information.
+ =item * B<answerdate>:
+ Get the answer-reveal date for the problem.
+ =item * B<awarded>:
+ Gets the awarded value for the problem part. Requires genUserData set to
+ true when the navmap object was created.
+ =item * B<duedate>:
+ Get the due date for the problem.
+ =item * B<tries>:
+ Get the number of tries the student has used on the problem.
+ =item * B<maxtries>:
- =item * B<answerdate>: Get the answer-reveal date for the problem.
+ Get the number of max tries allowed.
- =item * B<duedate>: Get the due date for the problem.
+ =item * B<opendate>:
- =item * B<tries>: Get the number of tries the student has used on the problem.
+ Get the open date for the problem.
- =item * B<maxtries>: Get the number of max tries allowed.
+ =item * B<sig>:
- =item * B<opendate>: Get the open date for the problem.
+ Get the significant figures setting.
- =item * B<sig>: Get the significant figures setting.
+ =item * B<tol>:
- =item * B<tol>: Get the tolerance for the problem.
+ Get the tolerance for the problem.
- =item * B<tries>: Get the number of tries the user has already used on the problem.
+ =item * B<tries>:
- =item * B<type>: Get the question type for the problem.
+ Get the number of tries the user has already used on the problem.
- =item * B<weight>: Get the weight for the problem.
+ =item * B<type>:
+ Get the question type for the problem.
+ =item * B<weight>:
+ Get the weight for the problem.
  =back
- Line 2395  sub answerdate {
+ Line 3297  sub answerdate {
      }
      return $self->parmval("answerdate", $part);
  }
- sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); }
+ sub awarded {
+     my $self = shift; my $part = shift;
+     if (!defined($part)) { $part = '0'; }
+     return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
+ }
  sub duedate {
      (my $self, my $part) = @_;
      return $self->parmval("duedate", $part);
- Line 2412  sub opendate {
+ Line 3318  sub opendate {
      }
      return $self->parmval("opendate");
  }
+ sub problemstatus {
+     (my $self, my $part) = @_;
+     return $self->parmval("problemstatus", $part);
+ }
  sub sig {
      (my $self, my $part) = @_;
      return $self->parmval("sig", $part);
- Line 2432  sub type {
+ Line 3342  sub type {
  }
  sub weight {
      my $self = shift; my $part = shift;
-     return $self->parmval("weight", $part);
+     if (!defined($part)) { $part = '0'; }
+     return &Apache::lonnet::EXT('resource.'.$part.'.weight',
+ 				$self->symb(), $ENV{'user.domain'},
+ 				$ENV{'user.name'},
+ 				$ENV{'request.course.sec'});
  }
  # Multiple things need this
- Line 2467  Misc. functions for the resource.
+ Line 3382  Misc. functions for the resource.
  =over 4
- =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
+ =item * B<hasDiscussion>:
- =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
+ Returns a false value if there has been discussion since the user last
+ logged in, true if there has. Always returns false if the discussion
+ data was not extracted when the nav map was constructed.
+ =item * B<getFeedback>:
+ Gets the feedback for the resource and returns the raw feedback string
+ for the resource, or the null string if there is no feedback or the
+ email data was not extracted when the nav map was constructed. Usually
+ used like this:
   for (split(/\,/, $res->getFeedback())) {
      my $link = &Apache::lonnet::escape($_);
- Line 2500  sub getErrors {
+ Line 3424  sub getErrors {
  =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 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<parts>():
+ Returns a list reference containing sorted strings corresponding to
+ each part of the problem. Single part problems have only a part '0'.
+ Multipart problems do not return their part '0', since they typically
+ do not really matter.
+ =item * B<countParts>():
+ Returns the number of parts of the problem a student can answer. Thus,
+ for single part problems, returns 1. For multipart, it returns the
+ number of parts in the problem, not including psuedo-part 0.
+ =item * B<multipart>():
+ Returns true if the problem is multipart, false otherwise. Use this instead
+ of countParts if all you want is multipart/not multipart.
- =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<responseType>($part):
+ Returns the response type of the part, without the word "response" on the
+ end. Example return values: 'string', 'essay', 'numeric', etc.
+ =item * B<responseIds>($part):
+ Retreives the response IDs for the given part as an array reference containing
+ strings naming the response IDs. This may be empty.
  =back
- Line 2511  sub getErrors {
+ Line 3459  sub getErrors {
  sub parts {
      my $self = shift;
-     if ($self->ext) { return ['0']; }
+     if ($self->ext) { return []; }
      $self->extractParts();
      return $self->{PARTS};
- Line 2522  sub countParts {
+ Line 3470  sub countParts {
      my $parts = $self->parts();
+     # If I left this here, then it's not necessary.
+     #my $delta = 0;
+     #for my $part (@$parts) {
+     #    if ($part eq '0') { $delta--; }
+     #}
      if ($self->{RESOURCE_ERROR}) {
          return 0;
      }
-     if (scalar(@{$parts}) < 2) { return 1;}
+     return scalar(@{$parts}); # + $delta;
+ }
+ sub multipart {
+     my $self = shift;
+     return $self->countParts() > 1;
+ }
+ sub responseType {
+     my $self = shift;
+     my $part = shift;
+     $self->extractParts();
+     return $self->{RESPONSE_TYPES}->{$part};
+ }
+ sub responseIds {
+     my $self = shift;
+     my $part = shift;
-     return scalar(@{$parts}) - 1;
+     $self->extractParts();
+     return $self->{RESPONSE_IDS}->{$part};
  }
- # Private function: Extracts the parts information and saves it
+ # Private function: Extracts the parts information, both part names and
+ # part types, and saves it.
  sub extractParts {
      my $self = shift;
-     return if ($self->{PARTS});
+     return if (defined($self->{PARTS}));
      return if ($self->ext);
      $self->{PARTS} = [];
+     my %parts;
      # Retrieve part count, if this is a problem
      if ($self->is_problem()) {
-         my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
+         my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
          if (!$metadata) {
              $self->{RESOURCE_ERROR} = 1;
              $self->{PARTS} = [];
+             $self->{PART_TYPE} = {};
              return;
          }
          foreach (split(/\,/,$metadata)) {
-             if ($_ =~ /^parameter\_(.*)\_opendate$/) {
+             if ($_ =~ /^part_(.*)$/) {
-                 push @{$self->{PARTS}}, $1;
+                 my $part = $1;
+                 # This floods the logs if it blows up
+                 if (defined($parts{$part})) {
+                     Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
+                   }
+                 # check to see if part is turned off.
+                 if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
+                     $parts{$part} = 1;
+                 }
              }
          }
-         # Is this possible to do in one line? - Jeremy
+         my @sortedParts = sort keys %parts;
-         my @sortedParts = sort @{$self->{PARTS}};
          $self->{PARTS} = \@sortedParts;
+         my %responseIdHash;
+         my %responseTypeHash;
+         # Init the responseIdHash
+         foreach (@{$self->{PARTS}}) {
+             $responseIdHash{$_} = [];
+         }
+         # Now, the unfortunate thing about this is that parts, part name, and
+         # response if are delimited by underscores, but both the part
+         # name and response id can themselves have underscores in them.
+         # So we have to use our knowlege of part names to figure out
+         # where the part names begin and end, and even then, it is possible
+         # to construct ambiguous situations.
+         foreach (split /,/, $metadata) {
+             if ($_ =~ /^([a-zA-Z]+)response_(.*)/) {
+                 my $responseType = $1;
+                 my $partStuff = $2;
+                 my $partIdSoFar = '';
+                 my @partChunks = split /_/, $partStuff;
+                 my $i = 0;
+                 for ($i = 0; $i < scalar(@partChunks); $i++) {
+                     if ($partIdSoFar) { $partIdSoFar .= '_'; }
+                     $partIdSoFar .= $partChunks[$i];
+                     if ($parts{$partIdSoFar}) {
+                         my @otherChunks = @partChunks[$i+1..$#partChunks];
+                         my $responseId = join('_', @otherChunks);
+                         push @{$responseIdHash{$partIdSoFar}}, $responseId;
+                         $responseTypeHash{$partIdSoFar} = $responseType;
+                         last;
+                     }
+                 }
+             }
+         }
+         $self->{RESPONSE_IDS} = \%responseIdHash;
+         $self->{RESPONSE_TYPES} = \%responseTypeHash;
      }
      return;
- Line 2568  sub extractParts {
+ Line 3593  sub extractParts {
  =head2 Resource Status
- Problem resources have status information, reflecting their various dates and completion statuses.
+ Problem resources have status information, reflecting their various
+ dates and completion statuses.
- There are two aspects to the status: the date-related information and the completion information.
+ There are two aspects to the status: the date-related information and
+ the completion information.
- Idiomatic usage of these two methods would probably look something like
+ Idiomatic usage of these two methods would probably look something
+ like
   foreach ($resource->parts()) {
      my $dateStatus = $resource->getDateStatus($_);
- Line 2585  Idiomatic usage of these two methods wou
+ Line 3613  Idiomatic usage of these two methods wou
      ... use it here ...
   }
- Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere.
+ Which you use depends on exactly what you are looking for. The
+ status() function has been optimized for the nav maps display and may
+ not precisely match what you need elsewhere.
- The symbolic constants shown below can be accessed through the resource object: $res->OPEN.
+ The symbolic constants shown below can be accessed through the
+ resource object: C<$res->OPEN>.
  =over 4
- =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
+ =item * B<getDateStatus>($part):
+ ($part defaults to 0). A convenience function that returns a symbolic
+ constant telling you about the date status of the part. The possible
+ return values are:
  =back
- Line 2599  B<Date Codes>
+ Line 3634  B<Date Codes>
  =over 4
- =item * B<OPEN_LATER>: The problem will be opened later.
+ =item * B<OPEN_LATER>:
+ The problem will be opened later.
- =item * B<OPEN>: Open and not yet due.
+ =item * B<OPEN>:
+ Open and not yet due.
- =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
- =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
+ =item * B<PAST_DUE_ANSWER_LATER>:
- =item * B<ANSWER_OPEN>: The answer date is here.
+ The due date has passed, but the answer date has not yet arrived.
- =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
+ =item * B<PAST_DUE_NO_ANSWER>:
+ The due date has passed and there is no answer opening date set.
+ =item * B<ANSWER_OPEN>:
+ The answer date is here.
+ =item * B<NETWORK_FAILURE>:
+ The information is unknown due to network failure.
  =back
- Line 2664  B<>
+ Line 3711  B<>
  =over 4
- =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:
+ =item * B<getCompletionStatus>($part):
+ ($part defaults to 0.) A convenience function that returns a symbolic
+ constant telling you about the completion status of the part, with the
+ following possible results:
  =back
  B<Completion Codes>
  =over 4
- =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
+ =item * B<NOT_ATTEMPTED>:
+ Has not been attempted at all.
+ =item * B<INCORRECT>:
+ Attempted, but wrong by student.
+ =item * B<INCORRECT_BY_OVERRIDE>:
+ Attempted, but wrong by instructor override.
+ =item * B<CORRECT>:
- =item * B<INCORRECT>: Attempted, but wrong by student.
+ Correct or correct by instructor.
- =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
+ =item * B<CORRECT_BY_OVERRIDE>:
- =item * B<CORRECT>: Correct or correct by instructor.
+ Correct by instructor override.
- =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
+ =item * B<EXCUSED>:
- =item * B<EXCUSED>: Excused. Not yet implemented.
+ Excused. Not yet implemented.
- =item * B<NETWORK_FAILURE>: Information not available due to network failure.
+ =item * B<NETWORK_FAILURE>:
- =item * B<ATTEMPTED>: Attempted, and not yet graded.
+ Information not available due to network failure.
+ =item * B<ATTEMPTED>:
+ Attempted, and not yet graded.
  =back
- Line 2720  sub queryRestoreHash {
+ Line 3787  sub queryRestoreHash {
      my $self = shift;
      my $hashentry = shift;
      my $part = shift;
-     $part = "0" if (!defined($part));
+     $part = "0" if (!defined($part) || $part eq '');
      return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
      $self->getReturnHash();
- Line 2732  sub queryRestoreHash {
+ Line 3799  sub queryRestoreHash {
  B<Composite Status>
- Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE):
+ Along with directly returning the date or completion status, the
+ resource object includes a convenience function B<status>() that will
+ combine the two status tidbits into one composite status that can
+ represent the status of the resource as a whole. This method represents
+ the concept of the thing we want to display to the user on the nav maps
+ screen, which is a combination of completion and open status. The precise logic is
+ documented in the comments of the status method. The following results
+ may be returned, all available as methods on the resource object
+ ($res->NETWORK_FAILURE): In addition to the return values that match
+ the date or completion status, this function can return "ANSWER_SUBMITTED"
+ if that problemstatus parameter value is set to No, suppressing the
+ incorrect/correct feedback.
  =over 4
- =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
+ =item * B<NETWORK_FAILURE>:
+ The network has failed and the information is not available.
+ =item * B<NOTHING_SET>:
+ No dates have been set for this problem (part) at all. (Because only
+ certain parts of a multi-part problem may be assigned, this can not be
+ collapsed into "open later", as we do not know a given part will EVER
+ be opened. For single part, this is the same as "OPEN_LATER".)
- =item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
+ =item * B<CORRECT>:
- =item * B<CORRECT>: For any reason at all, the part is considered correct.
+ For any reason at all, the part is considered correct.
- =item * B<EXCUSED>: For any reason at all, the problem is excused.
+ =item * B<EXCUSED>:
- =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
+ For any reason at all, the problem is excused.
- =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
+ =item * B<PAST_DUE_NO_ANSWER>:
- =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
+ The problem is past due, not considered correct, and no answer date is
+ set.
- =item * B<OPEN_LATER>: The problem is not yet open.
+ =item * B<PAST_DUE_ANSWER_LATER>:
- =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
+ The problem is past due, not considered correct, and an answer date in
+ the future is set.
- =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
+ =item * B<ANSWER_OPEN>:
- =item * B<OPEN>: The item is open and not yet tried.
+ The problem is past due, not correct, and the answer is now available.
- =item * B<ATTEMPTED>: The problem has been attempted.
+ =item * B<OPEN_LATER>:
+ The problem is not yet open.
+ =item * B<TRIES_LEFT>:
+ The problem is open, has been tried, is not correct, but there are
+ tries left.
+ =item * B<INCORRECT>:
+ The problem is open, and all tries have been used without getting the
+ correct answer.
+ =item * B<OPEN>:
+ The item is open and not yet tried.
+ =item * B<ATTEMPTED>:
+ The problem has been attempted.
+ =item * B<ANSWER_SUBMITTED>:
+ An answer has been submitted, but the student should not see it.
  =back
  =cut
- sub TRIES_LEFT { return 10; }
+ sub TRIES_LEFT       { return 20; }
+ sub ANSWER_SUBMITTED { return 21; }
  sub status {
      my $self = shift;
- Line 2779  sub status {
+ Line 3893  sub status {
      if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
+     my $suppressFeedback = lc($self->parmval("problemstatus", $part)) eq 'no';
      # There are a few whole rows we can dispose of:
      if ($completionStatus == CORRECT ||
          $completionStatus == CORRECT_BY_OVERRIDE ) {
-         return CORRECT;
+         return $suppressFeedback? ANSWER_SUBMITTED : CORRECT;
      }
      if ($completionStatus == ATTEMPTED) {
- Line 2823  sub status {
+ Line 3939  sub status {
          if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
              return TRIES_LEFT;
          }
-         return INCORRECT; # otherwise, return orange; student can't fix this
+         return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
      }
      # Otherwise, it's untried and open
- Line 2832  sub status {
+ Line 3948  sub status {
  =pod
+ B<Completable>
+ The completable method represents the concept of I<whether the student can
+ currently do the problem>. If the student can do the problem, which means
+ that it is open, there are tries left, and if the problem is manually graded
+ or the grade is suppressed via problemstatus, the student has not tried it
+ yet, then the method returns 1. Otherwise, it returns 0, to indicate that
+ either the student has tried it and there is no feedback, or that for
+ some reason it is no longer completable (not open yet, successfully completed,
+ out of tries, etc.). As an example, this is used as the filter for the
+ "Uncompleted Homework" option for the nav maps.
+ If this does not quite meet your needs, do not fiddle with it (unless you are
+ fixing it to better match the student's conception of "completable" because
+ it's broken somehow)... make a new method.
+ =cut
+ sub completable {
+     my $self = shift;
+     if (!$self->is_problem()) { return 0; }
+     my $partCount = $self->countParts();
+     foreach my $part (@{$self->parts()}) {
+         if ($part eq '0' && $partCount != 1) { next; }
+         my $status = $self->status($part);
+         # "If any of the parts are open, or have tries left (implies open),
+         # and it is not "attempted" (manually graded problem), it is
+         # not "complete"
+ 	if ($self->getCompletionStatus($part) == ATTEMPTED() ||
+ 	    $status == ANSWER_SUBMITTED() ) {
+ 	    # did this part already, as well as we can
+ 	    next;
+ 	}
+ 	if ($status == OPEN() || $status == TRIES_LEFT()) {
+ 	    return 1;
+ 	}
+     }
+     # If all the parts were complete, so was this problem.
+     return 0;
+ }
+ =pod
  =head2 Resource/Nav Map Navigation
  =over 4
- =item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case.
+ =item * B<getNext>():
+ Retreive an array of the possible next resources after this
+ one. Always returns an array, even in the one- or zero-element case.
+ =item * B<getPrevious>():
- =item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case.
+ Retreive an array of the possible previous resources from this
+ one. Always returns an array, even in the one- or zero-element case.
  =cut

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

Removed from v.1.142
changed lines
	Added in v.1.220