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.415.2.2 and 1.444.2.2

-version 1.415.2.2, 2008/12/12 22:27:20
+version 1.444.2.2, 2010/08/15 00:03:25
  Line 2
  # Navigate Maps Handler
  #
  # $Id$
  #
  # Copyright Michigan State University Board of Trustees
  #
- Line 27
+ Line 28
  #
  ###
+ =pod
+ =head1 NAME
+ Apache::lonnavmaps - Subroutines to handle and render the navigation
+ =head1 SYNOPSIS
+ Handles navigational maps.
+ The main handler generates the navigational listing for the course,
+ the other objects export this information in a usable fashion for
+ other modules.
+ This is part of the LearningOnline Network with CAPA project
+ described at http://www.lon-capa.org.
+ =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 than 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.
+ The package provides a function called 'render', called as
+ Apache::lonnavmaps::render({}).
+ =head2 Overview of Columns
+ The renderer will build an HTML table for the navmap and return
+ it. The table 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.
+ 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 namespace. The following currently exist:
+ =over 4
+ =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>: 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_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<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>:
+ 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<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.
+ =item * B<Apache::lonnavmaps::part_status_summary>:
+ A text readout summarizing the status of the problem. If it is a
+ single part problem, will display "Correct", "Incorrect",
+ "Not yet open", "Open", "Attempted", or "Error". If there are
+ multiple parts, this will output a string that in HTML will show a
+ status of how many parts are in each status, in color coding, trying
+ to match the colors of the icons within reason.
+ Note this only makes sense if you are I<not> showing parts. If
+ C<showParts> is true (see below), this column will not output
+ anything.
+ =back
+ If you add any others please be sure to document them here.
+ An example of a column renderer that will show the ID number of a
+ resource, along with the part name if any:
+  sub {
+   my ($resource, $part, $params) = @_;
+   if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
+   return '<td>' . $resource->{ID} . '</td>';
+  }
+ Note these functions are responsible for the TD tags, which allow them
+ to override vertical and horizontal alignment, etc.
+ =head2 Parameters
+ 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>: 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<include_top_level_map>: default: false
+ If you need to include the top level map (meaning the course) in the
+ rendered output set this to true
+ =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<queryString>: default: empty
+ 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<url>: default: none
+ 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<currentJumpIndex>: default: no jumping
+ Describes the currently-open row number to cause the browser to jump
+ to, because the user just opened that folder. By default, pulled from
+ the Jump information in the env{'form.*'}.
+ =item * B<printKey>: default: false
+ If true, print the key that appears on the top of the standard
+ navmaps.
+ =item * B<printCloseAll>: default: true
+ If true, print the "Close all folders" or "open all folders"
+ links.
+ =item * B<filterFunc>: default: sub {return 1;} (accept everything)
+ 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<suppressEmptySequences>: default: false
+ 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:
+ =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
+ =head1 SUBROUTINES
+ =over
+ =item update()
+ =item addToFilter()
+ Convenience functions: Returns a string that adds or subtracts
+ the second argument from the first hash, appropriate for the
+ query string that determines which folders to recurse on
+ =item removeFromFilter()
+ =item getLinkForResource()
+ Convenience function: Given a stack returned from getStack on the iterator,
+ return the correct src() value.
+ =item getDescription()
+ Convenience function: This separates the logic of how to create
+ the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
+ etc.) into a separate function. It takes a resource object as the
+ first parameter, and the part number of the resource as the second.
+ It's basically a big switch statement on the status of the resource.
+ =item dueInLessThan24Hours()
+ Convenience function, so others can use it: Is the problem due in less than 24 hours, and still can be done?
+ =item lastTry()
+ Convenience function, so others can use it: Is there only one try remaining for the
+ part, with more than one try to begin with, not due yet and still can be done?
+ =item advancedUser()
+ This puts a human-readable name on the env variable.
+ =item timeToHumanString()
+ timeToHumanString takes a time number and converts it to a
+ human-readable representation, meant to be used in the following
+ manner:
+ =over 4
+ =item * print "Due $timestring"
+ =item * print "Open $timestring"
+ =item * print "Answer available $timestring"
+ =back
+ Very, very, very, VERY English-only... goodness help a localizer on
+ this func...
+ =item resource()
+ returns 0
+ =item communication_status()
+ returns 1
+ =item quick_status()
+ returns 2
+ =item long_status()
+ returns 3
+ =item part_status_summary()
+ returns 4
+ =item render_resource()
+ =item render_communication_status()
+ =item render_quick_status()
+ =item render_long_status()
+ =item render_parts_summary_status()
+ =item setDefault()
+ =item cmp_title()
+ =item render()
+ =item add_linkitem()
+ =item show_linkitems()
+ =back
+ =cut
  package Apache::lonnavmaps;
  use strict;
- Line 35  use Apache::loncommon();
+ Line 478  use Apache::loncommon();
  use Apache::lonenc();
  use Apache::lonlocal;
  use Apache::lonnet;
  use POSIX qw (floor strftime);
  use Time::HiRes qw( gettimeofday tv_interval );
  use LONCAPA;
- Line 49  sub NOTHING { return 3; }
+ Line 493  sub NOTHING { return 3; }
  my $resObj = "Apache::lonnavmaps::resource";
- # Keep these mappings in sync with lonquickgrades, which uses the colors
+ # Keep these mappings in sync with lonquickgrades, which usesthe colors
  # instead of the icons.
  my %statusIconMap =
      (
- Line 62  my %statusIconMap =
+ Line 506  my %statusIconMap =
       $resObj->ERROR        => ''
       );
- my %iconAltTags =
+ my %iconAltTags =   #texthash does not work here
-     ( 'navmap.correct.gif' => 'Correct',
+     ( 'navmap.correct.gif'  => 'Correct',
-       'navmap.wrong.gif'   => 'Incorrect',
+       'navmap.wrong.gif'    => 'Incorrect',
-       'navmap.open.gif'    => 'Open' );
+       'navmap.open.gif'     => 'Open',
+       'navmap.partial.gif'  => 'Partially Correct',
+       'navmap.ellipsis.gif' => 'Attempted',
+      );
  # Defines a status->color mapping, null string means don't color
  my %colormap =
- Line 80  my %colormap =
+ Line 527  my %colormap =
        $resObj->INCORRECT              => '',
        $resObj->OPEN                   => '',
        $resObj->NOTHING_SET            => '',
+       $resObj->CREDIT_ATTEMPTED       => '',
        $resObj->ATTEMPTED              => '',
        $resObj->ANSWER_SUBMITTED       => '',
        $resObj->PARTIALLY_CORRECT      => '#006600'
- Line 88  my %colormap =
+ Line 536  my %colormap =
  # is not yet done and due in less than 24 hours
  my $hurryUpColor = "#FF0000";
+ my $future_slots_checked = 0;
+ my $future_slots = 0;
  sub close {
      if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
      return(<<ENDCLOSE);
- Line 116  this.document.navform.submit();
+ Line 567  this.document.navform.submit();
  ENDUPDATE
  }
- # Convenience functions: Returns a string that adds or subtracts
- # the second argument from the first hash, appropriate for the
- # query string that determines which folders to recurse on
  sub addToFilter {
      my $hashIn = shift;
      my $addition = shift;
- Line 137  sub removeFromFilter {
+ Line 586  sub removeFromFilter {
      return join(",", keys(%hash));
  }
- # Convenience function: Given a stack returned from getStack on the iterator,
- # return the correct src() value.
  sub getLinkForResource {
      my $stack = shift;
      my $res;
- Line 156  sub getLinkForResource {
+ Line 603  sub getLinkForResource {
  	    my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
  	    if ($map=~/\.page$/) {
  		my $url=&Apache::lonnet::clutter($map);
- 		$anchor=&escape($src->shown_symb());
+ 		$anchor=&escape($res->shown_symb());
  		return ($url,$res->shown_symb(),$anchor);
  	    }
          }
- Line 176  sub getLinkForResource {
+ Line 623  sub getLinkForResource {
      return;
  }
- # Convenience function: This separates the logic of how to create
- # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
- # etc.) into a separate function. It takes a resource object as the
- # first parameter, and the part number of the resource as the second.
- # It's basically a big switch statement on the status of the resource.
  sub getDescription {
      my $res = shift;
- Line 200  sub getDescription {
+ Line 643  sub getDescription {
      if ($status == $res->OPEN_LATER) {
          return &mt("Open ") .timeToHumanString($open,'start');
      }
+     if ($res->simpleStatus($part) == $res->OPEN) {
+         unless (&Apache::lonnet::allowed('mgr',$env{'request.course.id'})) {
+             my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
+             if ($slot_status == $res->UNKNOWN) {
+                 return &mt('Reservation status unknown');
+             } elsif ($slot_status == $res->RESERVED) {
+                 return &mt('Reserved - ends [_1]',
+                            timeToHumanString($slot_time,'end'));
+             } elsif ($slot_status == $res->RESERVED_LOCATION) {
+                 return &mt('Reserved - specific location(s) - ends [_1]',
+                            timeToHumanString($slot_time,'end'));
+             } elsif ($slot_status == $res->RESERVED_LATER) {
+                 return &mt('Reserved - next open [_1]',
+                            timeToHumanString($slot_time,'start'));
+             } elsif ($slot_status == $res->RESERVABLE) {
+                 return &mt('Reservable ending [_1]',
+                            timeToHumanString($slot_time,'end'));
+             } elsif ($slot_status == $res->RESERVABLE_LATER) {
+                 return &mt('Reservable starting [_1]',
+                            timeToHumanString($slot_time,'start'));
+             } elsif ($slot_status == $res->NOT_IN_A_SLOT) {
+                 return &mt('Reserve a time/place to work');
+             } elsif ($slot_status == $res->NOTRESERVABLE) {
+                 return &mt('Reservation not available');
+             } elsif ($slot_status == $res->WAITING_FOR_GRADE) {
+                 return &mt('Submission in grading queue');
+             }
+         }
+     }
      if ($status == $res->OPEN) {
          if ($due) {
  	    if ($res->is_practice()) {
- Line 229  sub getDescription {
+ Line 701  sub getDescription {
          return &mt("Excused by instructor");
      }
      if ($status == $res->ATTEMPTED) {
-         return &mt("Answer submitted, not yet graded");
+         if ($res->is_anonsurvey($part) || $res->is_survey($part)) {
+             return &mt("Survey submission recorded");
+         } else {
+             return &mt("Answer submitted, not yet graded");
+         }
+     }
+     if ($status == $res->CREDIT_ATTEMPTED) {
+         if ($res->is_anonsurvey($part) || $res->is_survey($part)) {
+             return &mt("Credit for survey submission");
+         }
      }
      if ($status == $res->TRIES_LEFT) {
          my $tries = $res->tries($part);
- Line 253  sub getDescription {
+ Line 734  sub getDescription {
      }
  }
- # Convenience function, so others can use it: Is the problem due in less than
- # 24 hours, and still can be done?
  sub dueInLessThan24Hours {
      my $res = shift;
- Line 267  sub dueInLessThan24Hours {
+ Line 746  sub dueInLessThan24Hours {
  	    $res->duedate($part) > time();
  }
- # Convenience function, so others can use it: Is there only one try remaining for the
- # part, with more than one try to begin with, not due yet and still can be done?
  sub lastTry {
      my $res = shift;
      my $part = shift;
- Line 280  sub lastTry {
+ Line 758  sub lastTry {
          $res->duedate($part) > time();
  }
- # This puts a human-readable name on the env variable.
  sub advancedUser {
      return $env{'request.role.adv'};
  }
- # timeToHumanString takes a time number and converts it to a
- # human-readable representation, meant to be used in the following
- # manner:
- # print "Due $timestring"
- # print "Open $timestring"
- # print "Answer available $timestring"
- # Very, very, very, VERY English-only... goodness help a localizer on
- # this func...
  sub timeToHumanString {
      my ($time,$type,$format) = @_;
- Line 415  sub timeToHumanString {
+ Line 881  sub timeToHumanString {
  }
- =pod
- =head1 NAME
- Apache::lonnavmap - Subroutines to handle and render the navigation
-     maps
- =head1 SYNOPSIS
- 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 than 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.
- The package provides a function called 'render', called as
- Apache::lonnavmaps::render({}).
- =head2 Overview of Columns
- The renderer will build an HTML table for the navmap and return
- it. The table 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.
- 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 namespace. The following currently exist:
- =over 4
- =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>: 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_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<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>:
- 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<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.
- =item * B<Apache::lonnavmaps::part_status_summary>:
- A text readout summarizing the status of the problem. If it is a
- single part problem, will display "Correct", "Incorrect",
- "Not yet open", "Open", "Attempted", or "Error". If there are
- multiple parts, this will output a string that in HTML will show a
- status of how many parts are in each status, in color coding, trying
- to match the colors of the icons within reason.
- Note this only makes sense if you are I<not> showing parts. If
- C<showParts> is true (see below), this column will not output
- anything.
- =back
- If you add any others please be sure to document them here.
- An example of a column renderer that will show the ID number of a
- resource, along with the part name if any:
-  sub {
-   my ($resource, $part, $params) = @_;
-   if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
-   return '<td>' . $resource->{ID} . '</td>';
-  }
- Note these functions are responsible for the TD tags, which allow them
- to override vertical and horizontal alignment, etc.
- =head2 Parameters
- 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>: 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<include_top_level_map>: default: false
- If you need to include the top level map (meaning the course) in the
- rendered output set this to true
- =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<queryString>: default: empty
- 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<url>: default: none
- 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<currentJumpIndex>: default: no jumping
- Describes the currently-open row number to cause the browser to jump
- to, because the user just opened that folder. By default, pulled from
- the Jump information in the env{'form.*'}.
- =item * B<printKey>: default: false
- If true, print the key that appears on the top of the standard
- navmaps.
- =item * B<printCloseAll>: default: true
- If true, print the "Close all folders" or "open all folders"
- links.
- =item * B<filterFunc>: default: sub {return 1;} (accept everything)
- 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<suppressEmptySequences>: default: false
- 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:
- =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
  sub resource { return 0; }
  sub communication_status { return 1; }
  sub quick_status { return 2; }
- Line 761  sub render_resource {
+ Line 895  sub render_resource {
      my $link = $params->{"resourceLink"};
      #  The URL part is not escaped at this point, but the symb is...
-     #  The stuff to the left of the ? must have ' replaced by \' since
-     #  it will be quoted with ' in the href.
-     my ($left,$right) = split(/\?/, $link);
-     $link = $left.'?'.$right;
      my $src = $resource->src();
      my $it = $params->{"iterator"};
- Line 778  sub render_resource {
+ Line 907  sub render_resource {
      my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");
      # If this is a new branch, label it so
      if ($params->{'isNewBranch'}) {
-         $newBranchText = "<img src='$location/branch.gif' border='0' alt='Branch' />";
+         $newBranchText = "<img src='$location/branch.gif' alt=".mt('Branch')." />";
      }
      # links to open and close the folder
+     my $whitespace = $location.'/whitespace_21.gif';
-     my $linkopen = "<a href=\"$link\">";
+     my $linkopen = "<img src='$whitespace' alt='' />"."<a href=\"$link\">";
      my $linkclose = "</a>";
      # Default icon: unknown page
-     my $icon = "<img src='$location/unknown.gif' alt='' border='0' alt='&nbsp;&nbsp;' ' />";
+     my $icon = "<img class=\"LC_contentImage\" src='$location/unknown.gif' alt='' />";
      if ($resource->is_problem()) {
          if ($part eq '0' || $params->{'condensed'}) {
- 	    $icon = '<img src="'.$location.'/';
+ 	    $icon = '<img class="LC_contentImage" src="'.$location.'/';
  	    if ($resource->is_task()) {
  		$icon .= 'task.gif" alt="'.&mt('Task');
  	    } else {
  		$icon .= 'problem.gif" alt="'.&mt('Problem');
  	    }
- 	    $icon .='" border="0" />';
+ 	    $icon .='" />';
          } else {
              $icon = $params->{'indentString'};
          }
      } else {
- 	$icon = "<img src='".&Apache::loncommon::icon($resource->src)."' alt='&nbsp;&nbsp;' border='0' />";
+ 	$icon = "<img class=\"LC_contentImage\" src='".&Apache::loncommon::icon($resource->src)."' alt='' />";
      }
      # Display the correct map icon to open or shut map
- Line 815  sub render_resource {
+ Line 942  sub render_resource {
          if ($it->{CONDITION}) {
              $nowOpen = !$nowOpen;
          }
  	my $folderType = $resource->is_sequence() ? 'folder' : 'page';
          my $title=$resource->title;
-         $title=~s/\"/\&quot;/g;
+ 		$title=~s/\"/\&qout;/g;
          if (!$params->{'resource_no_folder_link'}) {
              $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
- 	    $icon = "<img src='$location/$icon' alt=\"".
+             $icon = "<img src='$location/arrow." . ($nowOpen ? 'closed' : 'open') . ".gif' alt='' />"
- 		($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";
+                     ."<img class=\"LC_contentImage\" src='$location/$icon' alt=\""
+                     .($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";
              $linkopen = "<a href=\"" . $params->{'url'} . '?' .
                  $params->{'queryString'} . '&amp;filter=';
              $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
- Line 838  sub render_resource {
+ Line 965  sub render_resource {
          } else {
              # Don't allow users to manipulate folder
-             $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
+             $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
-                 '.nomanip.gif';
+             $icon = "<img class=\"LC_space\" src='$whitespace' alt='' />"."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"".($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";
-             $icon = "<img src='$location/$icon' alt=\"".
- 		($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";
              $linkopen = "";
              $linkclose = "";
- Line 857  sub render_resource {
+ Line 982  sub render_resource {
      if (($resource->is_practice()) && ($resource->is_raw_problem())) {
          $nonLinkedText .=' <font color="green"><b>'.&mt('not graded').'</b></font>';
      }
-     # We're done preparing and finally ready to start the rendering
-     my $result = "<td align='left' valign='middle'>";
+     # We're done preparing and finally ready to start the rendering
+     my $result = '<td class="LC_middle">';
+     my $newfolderType = $resource->is_sequence() ? 'folder' : 'page';
      my $indentLevel = $params->{'indentLevel'};
      if ($newBranchText) { $indentLevel--; }
- Line 870  sub render_resource {
+ Line 996  sub render_resource {
      }
      # Decide what to display
      $result .= "$newBranchText$linkopen$icon$linkclose";
      my $curMarkerBegin = '';
- Line 879  sub render_resource {
+ Line 1004  sub render_resource {
      # Is this the current resource?
      if (!$params->{'displayedHereMarker'} &&
          $resource->symb() eq $params->{'here'} ) {
-         $curMarkerBegin = '<font color="red" size="+2">&gt;</font>';
+         $curMarkerBegin = '<em>';
-         $curMarkerEnd = '<font color="red" size="+2">&lt;</font>';
+         $curMarkerEnd = '</em>';
-         $params->{'displayedHereMarker'} = 1;
+ 	$params->{'displayedHereMarker'} = 1;
      }
      if ($resource->is_problem() && $part ne '0' &&
- Line 901  sub render_resource {
+ Line 1026  sub render_resource {
  	$target=' target="loncapaclient" ';
      }
      if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
-         $result .= "  $curMarkerBegin<a $target href=\"$link\">$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
+         $result .= "$curMarkerBegin<a $target href=\"$link\">$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";
      } else {
-         $result .= "  $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
+         $result .= "$curMarkerBegin$linkopen$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";
      }
      return $result;
- Line 923  sub render_communication_status {
+ Line 1048  sub render_communication_status {
      my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
      if ($resource->hasDiscussion()) {
          $discussionHTML = $linkopen .
-             '<img alt="'.&mt('New Discussion').'" border="0" src="'.$location.'/chat.gif" />' .
+             '<img alt="'.&mt('New Discussion').'" src="'.$location.'/chat.gif" title="'.&mt('New Discussion').'"/>' .
              $linkclose;
      }
- Line 933  sub render_communication_status {
+ Line 1058  sub render_communication_status {
              if ($msgid) {
                  $feedbackHTML .= '&nbsp;<a '.$target.' href="/adm/email?display='
                      . &escape($msgid) . '">'
-                     . '<img alt="'.&mt('New Email').'" src="'.$location.'/feedback.gif" '
+                     . '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" title="'.&mt('New E-mail').'"/></a>';
-                     . 'border="0" /></a>';
              }
          }
      }
- Line 948  sub render_communication_status {
+ Line 1072  sub render_communication_status {
                  $errorcount++;
                  $errorHTML .= '&nbsp;<a '.$target.' href="/adm/email?display='
                      . &escape($msgid) . '">'
-                     . '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" '
+                     . '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" title="'.&mt('New Error').'"/></a>';
-                     . 'border="0" /></a>';
              }
          }
      }
- Line 957  sub render_communication_status {
+ Line 1080  sub render_communication_status {
      if ($params->{'multipart'} && $part != '0') {
  	$discussionHTML = $feedbackHTML = $errorHTML = '';
      }
+     return "<td class=\"LC_middle\">$discussionHTML$feedbackHTML$errorHTML&nbsp;</td>";
-     return "<td width=\"75\" align=\"left\" valign=\"middle\">$discussionHTML$feedbackHTML$errorHTML&nbsp;</td>";
  }
  sub render_quick_status {
- Line 974  sub render_quick_status {
+ Line 1096  sub render_quick_status {
      }
      my $linkopen = "<a $target href=\"$link\">";
      my $linkclose = "</a>";
+ 	$result .= '<td class="LC_middle">';
      if ($resource->is_problem() &&
          !$firstDisplayed) {
          my $icon = $statusIconMap{$resource->simpleStatus($part)};
          my $alt = $iconAltTags{$icon};
          if ($icon) {
  	    my $location=
  		&Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
-             $result .= "<td valign='middle' width='50' align='right'>$linkopen<img width='25' height='25' src='$location' border='0' alt='$alt' />$linkclose</td>\n";
+ 		$result .= $linkopen.'<img src="'.$location.'" alt="'.&mt($alt).'" title="'.&mt($alt).'" />'.$linkclose;
          } else {
-             $result .= "<td width='30'>&nbsp;</td>\n";
+             $result .= "&nbsp;";
          }
      } else { # not problem, no icon
-         $result .= "<td width='30'>&nbsp;</td>\n";
+         $result .= "&nbsp;";
      }
+ 	$result .= "</td>\n";
      return $result;
  }
  sub render_long_status {
      my ($resource, $part, $params) = @_;
-     my $result = "<td align='right' valign='middle'>\n";
+     my $result = '<td class="LC_middle LC_right">';
      my $firstDisplayed = !$params->{'condensed'} &&
          $params->{'multipart'} && $part eq "0";
- Line 1182  sub render {
+ Line 1304  sub render {
          if (!defined($navmap)) {
              $navmap = Apache::lonnavmaps::navmap->new();
  	    if (!defined($navmap)) {
- 		# no londer in course
+ 		# no longer in course
  		return '<span class="LC_error">'.&mt('No course selected').'</span><br />
                          <a href="/adm/roles">'.&mt('Select a course').'</a><br />';
  	    }
- Line 1250  sub render {
+ Line 1372  sub render {
          # Step 1: Check to see if we have a navmap
          if (!defined($navmap)) {
              $navmap = Apache::lonnavmaps::navmap->new();
+             if (!defined($navmap)) {
+                 # no longer in course
+                 return '<span class="LC_error">'.&mt('No course selected').'</span><br />
+                         <a href="/adm/roles">'.&mt('Select a course').'</a><br />';
+             }
          }
          # See if we're being passed a specific map
- Line 1294  sub render {
+ Line 1421  sub render {
      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 1302  sub render {
+ Line 1429  sub render {
  	my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
          if ($navmap->{LAST_CHECK}) {
              $result .=
-                 '<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '.
+                 '<img src="'.$location.'/chat.gif" alt="" /> '.&mt('New discussion since').' '.
                  strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
                  '</td><td align="center" valign="bottom">&nbsp;&nbsp;'.
-                 '<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
+                 '<img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)').'<p>'.
                  '</td>';
          } else {
              $result .= '<td align="center" valign="bottom">&nbsp;&nbsp;'.
-                 '<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
+                 '<img src="'.$location.'/chat.gif" alt="" /> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
-                 '&nbsp;&nbsp;<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').
+                 '&nbsp;&nbsp;<img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)').
                  '</td>';
          }
- Line 1320  sub render {
+ Line 1447  sub render {
      if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
  	my ($link,$text);
          if ($condition) {
- 	    $link='"navmaps?condition=0&amp;filter=&amp;'.$queryString.
+ 	    $link='navmaps?condition=0&amp;filter=&amp;'.$queryString.
- 		'&here='.&escape($here).'"';
+ 		'&amp;here='.&escape($here);
  	    $text='Close all folders';
          } else {
- 	    $link='"navmaps?condition=1&amp;filter=&amp;'.$queryString.
+ 	    $link='navmaps?condition=1&amp;filter=&amp;'.$queryString.
- 		'&here='.&escape($here).'"';
+ 		'&amp;here='.&escape($here);
  	    $text='Open all folders';
          }
+         if ($env{'form.register'}) {
+             $link .= '&amp;register='.$env{'form.register'};
+         }
  	if ($args->{'caller'} eq 'navmapsdisplay') {
  	    &add_linkitem($args->{'linkitems'},'changefolder',
- 			  'location.href='.$link,$text);
+                           "location.href='$link'",$text);
  	} else {
- 	    $result.='<a href='.$link.'>'.&mt($text).'</a>';
+             $result.= '<a href="'.$link.'">'.&mt($text).'</a>';
  	}
          $result .= "\n";
      }
- Line 1348  sub render {
+ Line 1478  sub render {
  	<input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
  	<input type="hidden" name="navtime" value="$time" />
  END
+         if ($env{'form.register'}) {
+             $result .= '<input type="hidden" name="register" value="'.$env{'form.register'}.'" />';
+         }
          if ($args->{'sort'} eq 'discussion') {
  	    my $totdisc = 0;
  	    my $haveDisc = '';
- Line 1377  END
+ Line 1510  END
          } else {
  	    $result .= '</tr><tr>';
          }
- 	$result.=&show_linkitems($args->{'linkitems'});
+         $result.='<td class="LC_middle">'.&mt('Tools:').'</td>';
+ 	$result.=&show_linkitems_toolbar($args->{'linkitems'});
          if ($args->{'sort_html'}) {
  	    if ($env{'environment.remotenavmap'} ne 'on') {
  		$result.='<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>'.
- Line 1392  END
+ Line 1526  END
          $result.=$args->{'sort_html'};
      }
-     $result .= "<br />\n";
+     #$result .= "<br />\n";
      if ($r) {
          $r->print($result);
          $r->rflush();
          $result = "";
      }
      # End parameter setting
+     $result .= "<br />\n";
      # Data
-     $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
+     $result.=&Apache::loncommon::start_data_table("LC_tableOfContent");
      my $res = "Apache::lonnavmaps::resource";
      my %condenseStatuses =
          ( $res->NETWORK_FAILURE    => 1,
            $res->NOTHING_SET        => 1,
            $res->CORRECT            => 1 );
-     my @backgroundColors = ("#FFFFFF", "#F6F6F6");
      # Shared variables
      $args->{'counter'} = 0; # counts the rows
      $args->{'indentLevel'} = 0;
      $args->{'isNewBranch'} = 0;
      $args->{'condensed'} = 0;
-     my $location=
- 	&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
+     my $location = &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif");
-     $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt='&nbsp;&nbsp;' border='0' />");
+     $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' alt='' />");
      $args->{'displayedHereMarker'} = 0;
      # If we're suppressing empty sequences, look for them here. Use DFS for speed,
- Line 1635  END
+ Line 1771  END
  	    if (defined($anchor)) { $anchor='#'.$anchor; }
  	    my $srcHasQuestion = $src =~ /\?/;
  	    $args->{"resourceLink"} = $src.
- 		($srcHasQuestion?'&':'?') .
+ 		($srcHasQuestion?'&amp;':'?') .
  		'symb=' . &escape($symb).$anchor;
  	}
          # Now, we've decided what parts to show. Loop through them and
          # show them.
          foreach my $part (@parts) {
              $rownum ++;
-             my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
-             $result .= "  <tr bgcolor='$backgroundColor'>\n";
+             $result .= &Apache::loncommon::start_data_table_row();
              # Set up some data about the parts that the cols might want
              my $filter = $it->{FILTER};
- Line 1670  END
+ Line 1805  END
                  }
                  $result .= $colHTML . "\n";
              }
-             $result .= "    </tr>\n";
+             $result .= &Apache::loncommon::end_data_table_row();
              $args->{'isNewBranch'} = 0;
          }
- Line 1698  END
+ Line 1833  END
      # it's quite likely this might fix other browsers, too, and
      # certainly won't hurt anything.
      if ($displayedJumpMarker) {
-         $result .= "
+         $result .= &Apache::lonhtmlcommon::scripttag("
- <script>
  if (location.href.indexOf('#curloc')==-1) {
      setTimeout(\"location += '#curloc';\", 0)
  }
- </script>";
+ ");
      }
-     $result .= "</table>";
+     $result.=&Apache::loncommon::end_data_table();
      if ($r) {
          $r->print($result);
          $result = "";
- Line 1723  sub add_linkitem {
+ Line 1857  sub add_linkitem {
      $$linkitems{$name}{'text'}=&mt($text);
  }
- sub show_linkitems {
+ sub show_linkitems_toolbar {
-     my ($linkitems)=@_;
+     my ($linkitems,$condition)=@_;
-     my @linkorder = ("blank","launchnav","closenav","firsthomework",
+     my @linkorder = ("launchnav","closenav","firsthomework",
  		     "everything","uncompleted","changefolder","clearbubbles");
+     my $result .='<td align="left">'."\n".
-     my $result .= (<<ENDBLOCK);
+                  '<span class="LC_nobreak">'."\n".
-               <td align="left">
+                  '<ul id="LC_toolbar">';
- <script type="text/javascript">
-     function changeNavDisplay () {
- 	var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
- ENDBLOCK
-     foreach my $link (@linkorder) {
- 	$result.= "if (navchoice == '$link') {".
- 	    $linkitems->{$link}{'cmd'}."}\n";
-     }
-     $result.='}
-               </script>
-                    <form name="linkitems" method="post">
-                        <span class="LC_nobreak"><select name="toplink">'."\n";
      foreach my $link (@linkorder) {
- 	if (defined($linkitems->{$link})) {
+         my $link_id = 'LC_content_toolbar_'.$link;
- 	    if ($linkitems->{$link}{'text'} ne '') {
+         if (defined($linkitems->{$link})) {
- 		$result .= ' <option value="'.$link.'">'.
+             if ($linkitems->{$link}{'text'} ne '') {
- 		    $linkitems->{$link}{'text'}."</option>\n";
+                 $linkitems->{$link}{'cmd'}=~s/"/'/g;
- 	    }
+                 if ($linkitems->{$link}{'cmd'}) {
- 	}
+                     if ($link eq 'changefolder') {
+                         if ($condition) {
+                             $link_id='LC_content_toolbar_changefolder_toggled';
+                         } else {
+                             $link_id='LC_content_toolbar_changefolder';
+                         }
+                     }
+                     $result .= '<li><a href="#" '.
+                                'onclick="'.$linkitems->{$link}{'cmd'}.'" '.
+                                'id="'.$link_id.'" '.
+                                'class="LC_toolbarItem" '.
+                                'title="'.$linkitems->{$link}{'text'}.'">'.
+                                '</a></li>'."\n";
+                 }
+             }
+         }
      }
-     $result .= '</select>&nbsp;<input type="button" name="chgnav"
+     $result .= '</ul>'.
-                    value="Go" onClick="javascript:changeNavDisplay()" />
+                '</span></td>'."\n";
-                 </span></form></td>'."\n";
      return $result;
  }
 ;
  package Apache::lonnavmaps::navmap;
  =pod
- Line 2215  resource object.
+ Line 2359  resource object.
  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):
+ =item * B<getByMapPc>(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.
- Line 3370  sub navHash {
+ Line 3514  sub navHash {
      my $self = shift;
      my $param = shift;
      my $id = shift;
-     return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
+     my $arg = $param . ($id?$self->{ID}:"");
+     if (defined($arg)) {
+         return $self->{NAV_MAP}->navhash($arg);
+     }
+     return;
  }
  =pod
- Line 3613  sub is_problem {
+ Line 3761  sub is_problem {
      }
      return 0;
  }
+ #
+ #  The has below is the set of status that are considered 'incomplete'
+ #
+ my %incomplete_hash =
+ (
+  TRIES_LEFT()     => 1,
+  OPEN()           => 1,
+  ATTEMPTED()      => 1
+  );
+ #
+ #  Return tru if a problem is incomplete... for now incomplete means that
+ #  any part of the problem is incomplete.
+ #  Note that if the resources is not a problem, 0 is returned.
+ #
+ sub is_incomplete {
+     my $self = shift;
+     if ($self->is_problem()) {
+ 	&Apache::lonnet::logthis('is problem');
+ 	foreach my $part (@{$self->parts()}) {
+ 	    &Apache::lonnet::logthis("$part status ".$self->status($part));
+ 	    if (exists($incomplete_hash{$self->status($part)})) {
+ 		return 1;
+ 	    }
+ 	}
+     }
+     return 0;
+ }
  sub is_raw_problem {
      my $self=shift;
      my $src = $self->src();
- Line 3642  sub map_contains_problem {
+ Line 3819  sub map_contains_problem {
  sub is_sequence {
      my $self=shift;
      return $self->navHash("is_map_", 1) &&
- 	$self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
+     $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
  }
  sub is_survey {
      my $self = shift();
      my $part = shift();
      my $type = $self->parmval('type',$part);
-     if ($type eq 'survey') {
+     if (($type eq 'survey') || ($type eq 'surveycred')) {
          return 1;
      }
      if ($self->src() =~ /\.(survey)$/) {
- Line 3656  sub is_survey {
+ Line 3833  sub is_survey {
      }
      return 0;
  }
+ sub is_anonsurvey {
+     my $self = shift();
+     my $part = shift();
+     my $type = $self->parmval('type',$part);
+     if (($type eq 'anonsurvey') || ($type eq 'anonsurveycred')) {
+         return 1;
+     }
+     return 0;
+ }
  sub is_task {
      my $self=shift;
      my $src = $self->src();
- Line 3709  resource of the map.
+ Line 3895  resource of the map.
  Returns a string with the type of the map in it.
+ =item *B<map_hierarchy>:
+ Returns a string with a comma-separated ordered list of map_pc IDs
+ for the hierarchy of maps containing a map, with the top level
+ map first, then descending to deeper levels, with the enclosing map last.
  =back
  =cut
- Line 3739  sub map_type {
+ Line 3931  sub map_type {
      my $pc = $self->map_pc();
      return $self->navHash("map_type_$pc", 0);
  }
+ sub map_hierarchy {
+     my $self = shift;
+     my $pc = $self->map_pc();
+     return $self->navHash("map_hierarchy_$pc", 0);
+ }
  #####
  # Property queries
- Line 3844  sub awarded {
+ Line 4042  sub awarded {
      if (!defined($part)) { $part = '0'; }
      return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
  }
+ sub taskversion {
+     my $self = shift; my $part = shift;
+     $self->{NAV_MAP}->get_user_data();
+     if (!defined($part)) { $part = '0'; }
+     return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.version'};
+ }
+ sub taskstatus {
+     my $self = shift; my $part = shift;
+     $self->{NAV_MAP}->get_user_data();
+     if (!defined($part)) { $part = '0'; }
+     return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$self->taskversion($part).'.'.$part.'.status'};
+ }
+ sub solved {
+     my $self = shift; my $part = shift;
+     $self->{NAV_MAP}->get_user_data();
+     if (!defined($part)) { $part = '0'; }
+     return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.solved'};
+ }
+ sub checkedin {
+     my $self = shift; my $part = shift;
+     $self->{NAV_MAP}->get_user_data();
+     if (!defined($part)) { $part = '0'; }
+     if ($self->is_task()) {
+         my $version = $self->taskversion($part);
+         return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin.slot'});
+     } else {
+         return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin.slot'});
+     }
+ }
  # this should work exactly like the copy in lonhomework.pm
  sub duedate {
      (my $self, my $part) = @_;
- Line 3939  sub part_display {
+ Line 4166  sub part_display {
      }
      return $display;
  }
+ sub slot_control {
+     my $self=shift(); my $part = shift();
+     if (!defined($part)) { $part = '0'; }
+     my $useslots = $self->parmval("useslots", $part);
+     my $availablestudent = $self->parmval("availablestudent", $part);
+     my $available = $self->parmval("available", $part);
+     return ($useslots,$availablestudent,$available);
+ }
  # Multiple things need this
  sub getReturnHash {
- Line 4371  sub OPEN                   { return 1; }
+ Line 4606  sub OPEN                   { return 1; }
  sub PAST_DUE_NO_ANSWER     { return 2; }
  sub PAST_DUE_ANSWER_LATER  { return 3; }
  sub ANSWER_OPEN            { return 4; }
  sub NOTHING_SET            { return 5; }
  sub NETWORK_FAILURE        { return 100; }
  # getDateStatus gets the date status for a given problem part.
- Line 4457  Information not available due to network
+ Line 4692  Information not available due to network
  Attempted, and not yet graded.
+ =item * B<CREDIT_ATTEMPTED>:
+ Attempted, and credit received for attempt (survey and anonymous survey only).
  =back
  =cut
- Line 4468  sub CORRECT               { return 13; }
+ Line 4707  sub CORRECT               { return 13; }
  sub CORRECT_BY_OVERRIDE   { return 14; }
  sub EXCUSED               { return 15; }
  sub ATTEMPTED             { return 16; }
+ sub CREDIT_ATTEMPTED      { return 17; }
  sub getCompletionStatus {
      my $self = shift;
- Line 4486  sub getCompletionStatus {
+ Line 4726  sub getCompletionStatus {
      if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
      if ($status eq 'excused') {return $self->EXCUSED; }
      if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
+     if ($status eq 'credit_attempted') {
+         if ($self->is_anonsurvey($part) || $self->is_survey($part)) {
+             return $self->CREDIT_ATTEMPTED;
+         } else {
+             return $self->ATTEMPTED;
+         }
+     }
      return $self->NOT_ATTEMPTED;
  }
- Line 4575  The item is open and not yet tried.
+ Line 4822  The item is open and not yet tried.
  The problem has been attempted.
+ =item * B<CREDIT_ATTEMPTED>:
+ The problem has been attempted, and credit given for the attempt (survey and anonymous survey only).
  =item * B<ANSWER_SUBMITTED>:
  An answer has been submitted, but the student should not see it.
- Line 4583  An answer has been submitted, but the st
+ Line 4834  An answer has been submitted, but the st
  =cut
- sub TRIES_LEFT       { return 20; }
+ sub TRIES_LEFT        { return 20; }
- sub ANSWER_SUBMITTED { return 21; }
+ sub ANSWER_SUBMITTED  { return 21; }
- sub PARTIALLY_CORRECT{ return 22; }
+ sub PARTIALLY_CORRECT { return 22; }
+ sub RESERVED_LATER    { return 30; }
+ sub RESERVED          { return 31; }
+ sub RESERVED_LOCATION { return 32; }
+ sub RESERVABLE        { return 33; }
+ sub RESERVABLE_LATER  { return 34; }
+ sub NOTRESERVABLE     { return 35; }
+ sub NOT_IN_A_SLOT     { return 36; }
+ sub NEEDS_CHECKIN     { return 37; }
+ sub WAITING_FOR_GRADE { return 38; }
+ sub UNKNOWN           { return 39; }
  sub status {
      my $self = shift;
- Line 4637  sub status {
+ Line 4899  sub status {
          return ATTEMPTED;
      }
+     if ($completionStatus == CREDIT_ATTEMPTED) {
+         return CREDIT_ATTEMPTED;
+     }
      # If it's EXCUSED, then return that no matter what
      if ($completionStatus == EXCUSED) {
          return EXCUSED;
- Line 4678  sub status {
+ Line 4944  sub status {
      return OPEN;
  }
+ sub check_for_slot {
+     my $self = shift;
+     my $part = shift;
+     my ($use_slots,$available,$availablestudent) = $self->slot_control($part);
+     if (($use_slots ne '') && ($use_slots !~ /^\s*no\s*$/i)) {
+         my @slots = (split(/:/,$availablestudent),split(/:/,$available));
+         my $cid=$env{'request.course.id'};
+         my $cdom=$env{'course.'.$cid.'.domain'};
+         my $cnum=$env{'course.'.$cid.'.num'};
+         my $now = time;
+         if (@slots > 0) {
+             my %slots=&Apache::lonnet::get('slots',[@slots],$cdom,$cnum);
+             if (&Apache::lonnet::error(%slots)) {
+                 return (UNKNOWN);
+             }
+             my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots);
+             my ($checkedin,$checkedinslot);
+             foreach my $slot_name (@sorted_slots) {
+                 next if (!defined($slots{$slot_name}) ||
+                          !ref($slots{$slot_name}));
+                 my $end = $slots{$slot_name}->{'endtime'};
+                 my $start = $slots{$slot_name}->{'starttime'};
+                 my $ip = $slots{$slot_name}->{'ip'};
+                 if ($self->simpleStatus() == OPEN) {
+                     my $startreserve = $slots{$slot_name}->{'startreserve'};
+                     my @proctors;
+                     if ($slots{$slot_name}->{'proctor'} ne '') {
+                         @proctors = split(',',$slots{$slot_name}->{'proctor'});
+                     }
+                     if ($end > $now) {
+                         ($checkedin,$checkedinslot) = $self->checkedin();
+                         if ($startreserve < $now) {
+                             if ($start > $now) {
+                                 return (RESERVED_LATER,$start,$slot_name);
+                             } else {
+                                 if ($ip ne '') {
+                                     if (!&Apache::loncommon::check_ip_acc($ip)) {
+                                         return (RESERVED_LOCATION,$ip,$slot_name);
+                                     }
+                                 }
+                                 if (@proctors > 0) {
+                                     unless ((grep(/^\Q$checkedin\E/,@proctors)) &&
+                                         ($checkedinslot eq $slot_name)) {
+                                         return (NEEDS_CHECKIN,undef,$slot_name);
+                                     }
+                                 }
+                                 return (RESERVED,$end,$slot_name);
+                             }
+                         } else {
+                             if ($start > $now) {
+                                 return (RESERVABLE,$startreserve,$slot_name);
+                             }
+                         }
+                     }
+                 }
+             }
+             my ($is_correct,$got_grade);
+             if ($self->is_task()) {
+                 my $taskstatus = $self->taskstatus();
+                 $is_correct = (($taskstatus eq 'pass') ||
+                                ($self->solved() =~ /^correct_/));
+                 $got_grade = ($self->solved() =~ /^(?:pass|fail)$/);
+             } else {
+                 $got_grade = 1;
+                 $is_correct = ($self->solved() =~ /^correct_/);
+             }
+             ($checkedin,$checkedinslot) = $self->checkedin();
+             if ($checkedin) {
+                 if (!$got_grade) {
+                     return (WAITING_FOR_GRADE);
+                 } elsif ($is_correct) {
+                     return (CORRECT);
+                 }
+             }
+             return(NOT_IN_A_SLOT);
+         } else {
+             if (!$future_slots_checked) {
+                 $future_slots = &get_future_slots($cdom,$cnum,$now);
+                 $future_slots_checked = 1;
+             }
+             if ($future_slots) {
+                 return(NOT_IN_A_SLOT);
+             }
+             return(NOTRESERVABLE);
+         }
+     }
+     return;
+ }
+ sub get_future_slots {
+     my ($cdom,$cnum,$now) = @_;
+     my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
+     my $future_slots = 0;
+     foreach my $slot (keys(%slots)) {
+         if (($slots{$slot}->{'starttime'} > $now) &&
+             ($slots{$slot}->{'endtime'} > $now)) {
+             $future_slots ++;
+         }
+     }
+     return $future_slots;
+ }
  sub CLOSED { return 23; }
  sub ERROR { return 24; }
- Line 4727  my %compositeToSimple =
+ Line 5095  my %compositeToSimple =
        INCORRECT()             => INCORRECT,
        OPEN()                  => OPEN,
        ATTEMPTED()             => ATTEMPTED,
+       CREDIT_ATTEMPTED()      => CORRECT,
        ANSWER_SUBMITTED()      => ATTEMPTED
       );
- Line 4800  sub completable {
+ Line 5169  sub completable {
          # "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() ||
+         if ($self->getCompletionStatus($part) == ATTEMPTED() ||
- 	    $status == ANSWER_SUBMITTED() ) {
+             $self->getCompletionStatus($part) == CREDIT_ATTEMPTED() ||
+             $status == ANSWER_SUBMITTED() ) {
  	    # did this part already, as well as we can
  	    next;
  	}

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

Removed from v.1.415.2.2
changed lines
	Added in v.1.444.2.2