--- loncom/interface/lonnavmaps.pm 2002/10/07 19:00:38 1.67
+++ loncom/interface/lonnavmaps.pm 2002/11/01 18:24:45 1.94
@@ -1,7 +1,8 @@
+
# The LearningOnline Network with CAPA
# Navigate Maps Handler
#
-# $Id: lonnavmaps.pm,v 1.67 2002/10/07 19:00:38 bowersj2 Exp $
+# $Id: lonnavmaps.pm,v 1.94 2002/11/01 18:24:45 bowersj2 Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -44,8 +45,8 @@ use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet();
use Apache::loncommon();
-use HTML::TokeParser;
use GDBM_File;
+use POSIX qw (floor strftime);
# -------------------------------------------------------------- Module Globals
my %hash;
@@ -819,10 +820,10 @@ sub new_handle {
&Apache::loncommon::no_cache($r);
$r->send_http_header;
- # Initialize the nav map
+ # Create the nav map the nav map
my $navmap = Apache::lonnavmaps::navmap->new(
$ENV{"request.course.fn"}.".db",
- $ENV{"request.course.fn"}."_parms.db", 1);
+ $ENV{"request.course.fn"}."_parms.db", 1, 1);
if (!defined($navmap)) {
@@ -842,16 +843,15 @@ sub new_handle {
$r->rflush();
if ($navmap->{LAST_CHECK}) {
$r->print(' New discussion since '.
- timeToHumanString($navmap->{LAST_CHECK}).
+ strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
'
New message (click to open)
');
} else {
$r->print(' Discussions'.
'
New message (click to open)
');
}
- #if (($currenturl=~/^\/res/) &&
- # ($currenturl!~/^\/res\/adm/)) {
- # $r->print('Current Location
');
- #}
+
+ # Now that we've displayed some stuff to the user, init the navmap
+ $navmap->init();
# Check that it's defined
if (!($navmap->courseMapDefined())) {
@@ -879,7 +879,7 @@ sub new_handle {
$res->NOTHING_SET => '' );
# And a special case in the nav map; what to do when the assignment
# is not yet done and due in less then 24 hours
- my $hurryUpColor = "#FFCCCC";
+ my $hurryUpColor = "#FF0000";
my %statusIconMap =
( $res->NETWORK_FAILURE => '',
@@ -892,7 +892,13 @@ sub new_handle {
$res->OPEN_LATER => '',
$res->TRIES_LEFT => 'navmap.open.gif',
$res->INCORRECT => 'navmap.wrong.gif',
- $res->OPEN => 'navmap.open.gif' );
+ $res->OPEN => 'navmap.open.gif',
+ $res->ATTEMPTED => 'navmap.open.gif' );
+
+ my %iconAltTags =
+ ( 'navmap.correct.gif' => 'Correct',
+ 'navmap.wrong.gif' => 'Incorrect',
+ 'navmap.open.gif' => 'Open' );
my %condenseStatuses =
( $res->NETWORK_FAILURE => 1,
@@ -907,33 +913,133 @@ sub new_handle {
}
}
+ # Is this a new-style course? If so, we want to suppress showing the top-level
+ # maps in their own folders, in favor of "inlining" them.
+ my $topResource = $navmap->getById("0.0");
+ my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|;
+
my $currenturl = $ENV{'form.postdata'};
$currenturl=~s/^http\:\/\///;
$currenturl=~s/^[^\/]+//;
- my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);
-
- $r->print('Show All Resources
');
-
- # Begin the HTML table
- # four cols: resource + indent, chat+feedback, icon, text string
- $r->print('
' ."\n");
+ # alreadyHere allows us to only open the maps necessary to view
+ # the current location once, while at the same time remembering
+ # the current location. Without that check, the user would never
+ # be able to close those maps; the user would close it, and the
+ # currenturl scan would re-open it.
+ my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .
+ "&alreadyHere=1";
my $condition = 0;
if ($ENV{'form.condition'}) {
- $condition = 1;
+ $condition = 1;
}
- my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);
+ if ($condition) {
+ $r->print('Close All Folders
');
+ } else {
+ $r->print('Open All Folders
');
+ }
+
+ # Begin the HTML table
+ # four cols: resource + indent, chat+feedback, icon, text string
+ $r->print('' ."\n");
+
+ # This needs to be updated to use symbs from the remote,
+ # instead of uris. The changes to this and the main rendering
+ # loop should be obvious.
+ # Here's a simple example of the iterator.
+ # Preprocess the map: Look for current URL, force inlined maps to display
+
+ my $mapIterator = $navmap->getIterator(undef, undef, {}, 1);
+ my $found = 0;
+ my $depth = 1;
+ my $currentUrlIndex = 0; # keeps track of when the current resource is found,
+ # so we can back up a few and put the anchor above the
+ # current resource
+ $mapIterator->next(); # discard the first BEGIN_MAP
my $curRes = $mapIterator->next();
+ my $counter = 0;
+
+ while ($depth > 0) {
+ if ($curRes == $mapIterator->BEGIN_MAP()) {
+ $depth++;
+ }
+ if ($curRes == $mapIterator->END_MAP()) {
+ $depth--;
+ }
+
+ if (ref($curRes)) { $counter++; }
+
+ my $mapStack = $mapIterator->getStack();
+ if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) &&
+ $curRes->src() eq $currenturl) {
+ # If this is the correct resource, be sure to
+ # show it by making sure the containing maps
+ # are open.
+
+ $currentUrlIndex = $counter;
+
+ for my $map (@{$mapStack}) {
+ if ($condition) {
+ undef $filterHash{$map->map_pc()};
+ } else {
+ $filterHash{$map->map_pc()} = 1;
+ }
+ }
+ $ENV{'form.alreadyHere'} = 1;
+ }
+
+ # Preprocessing: If we're inlining nav maps into the top-level display,
+ # make sure we show this map!
+ if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map &&
+ scalar(@{$mapStack}) == 1) {
+ if ($condition) {
+ undef $filterHash{$curRes->map_pc()};
+ } else {
+ $filterHash{$curRes->map_pc()} = 1;
+ }
+ }
+
+ $curRes = $mapIterator->next();
+ }
+
undef $res; # so we don't accidentally use it later
- my $indentLevel = -1;
+ my $indentLevel = 0;
my $indentString = "";
my $isNewBranch = 0;
my $now = time();
my $in24Hours = $now + 24 * 60 * 60;
+ my $displayedHereMarker = 0;
+
+ # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
+ # code in iterator->next), so ignore the first one
+ $mapIterator = $navmap->getIterator(undef, undef, \%filterHash,
+ $condition);
+ $mapIterator->next();
+ $curRes = $mapIterator->next();
+ my $deltadepth = 0;
+ $depth = 1;
+
+ my @backgroundColors = ("#FFFFFF", "#F6F6F6");
+ my $rowNum = 0;
+
+ $counter = 0;
+
+ while ($depth > 0) {
+ # If we're in a new style course, and this is a BEGIN_MAP, END_MAP, or
+ # map resource and the stack depth is only one, just plain ignore this resource
+ # entirely. (This has the effect of inlining the resources in that map
+ # in the nav map.)
+ if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 &&
+ ref($curRes) && $curRes->is_map()) {
+ # We let the normal depth stuff occur, but we need to shift everything
+ # over by one to the left to make it look right.
+ $deltadepth = -1;
+ $curRes = $mapIterator->next();
+ next;
+ }
- while ($curRes != $mapIterator->END_NAV_MAP) {
if ($curRes == $mapIterator->BEGIN_MAP() ||
$curRes == $mapIterator->BEGIN_BRANCH()) {
$indentLevel++;
@@ -945,6 +1051,23 @@ sub new_handle {
if ($curRes == $mapIterator->BEGIN_BRANCH()) {
$isNewBranch = 1;
}
+ if ($curRes == $mapIterator->BEGIN_MAP()) {
+ $depth++;
+ }
+ if ($curRes == $mapIterator->END_MAP()) {
+ $depth--;
+ }
+
+ if (ref($curRes)) { $counter++; }
+
+ if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're
+ # out of the inlined map
+
+ # Is this resource being blotted out?
+ if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
+ $curRes = $mapIterator->next();
+ next; # and totally ignore this resource
+ }
if (ref($curRes) && $curRes->src()) {
@@ -962,7 +1085,7 @@ sub new_handle {
# just display first
if (!$curRes->opendate("0")) {
@parts = ("0"); # just display the zero-th part
- $condensed = 1;
+ $condensed = 1;
} else {
# Otherwise, only display part 0 if we want to
# attach feedback or email information to it
@@ -1010,9 +1133,16 @@ sub new_handle {
}
} else {
- @parts[0] = "0"; # this is to get past foreach loop below
+ $parts[0] = "0"; # this is to get past foreach loop below
# you can consider a non-problem resource as a resource
- # with only one part without loss
+ # with only one part without loss
+ }
+
+ # Is it a multipart problem with a single part, now in
+ # @parts with "0" filtered out? If so, forget it's a multi-part
+ # problem and treat it like a single-part problem.
+ if ( scalar(@parts) == 1 ) {
+ $multipart = 0;
}
# Display one part, in event of network error.
@@ -1026,6 +1156,7 @@ sub new_handle {
foreach my $part (@parts) {
my $deltalevel = 0; # for inserting the branch icon
+ my $nonLinkedText = ""; # unlinked stuff after title
# For each thing we're displaying...
@@ -1038,6 +1169,10 @@ sub new_handle {
'symb='.&Apache::lonnet::escape($curRes->symb()).
'"';
my $title = $curRes->title();
+ if (!$title) {
+ $title = $curRes->src();
+ $title = substr ($title, rindex($title, "/") + 1);
+ }
my $partLabel = "";
my $newBranchText = "";
@@ -1065,9 +1200,10 @@ sub new_handle {
# Display the correct icon, link to open or shut map
if ($curRes->is_map()) {
my $mapId = $curRes->map_pc();
- my $nowOpen = !defined($filterHash{$mapId});
+ my $nowOpen = (!defined($filterHash{$mapId}));
+ if ($condition) {$nowOpen = !$nowOpen;}
$icon = $nowOpen ?
- "folder_closed.gif" : "folder_opened.gif";
+ "navmap.folder.closed.gif" : "navmap.folder.open.gif";
$icon = "";
$linkopen = "";
$linkclose = "";
-
+
}
my $colorizer = "";
+ my $color;
if ($curRes->is_problem()) {
my $status = $curRes->status($part);
- my $color = $colormap{$status};
+ $color = $colormap{$status};
+
+ # Special case in the navmaps: If in less then
+ # 24 hours, give it a bit of urgency
+ if (($status == $curRes->OPEN() || $status == $curRes->ATTEMPTED() ||
+ $status == $curRes->TRIES_LEFT())
+ && $curRes->duedate() &&
+ $curRes->duedate() < time()+(24*60*60) &&
+ $curRes->duedate() > time()) {
+ $color = $hurryUpColor;
+ }
+ # Special case: If this is the last try, and there is
+ # more then one available, and it's not due yet, give a bit of urgency
+ my $tries = $curRes->tries($part);
+ my $maxtries = $curRes->maxtries($part);
+ if ($tries && $maxtries && $maxtries > 1 &&
+ $maxtries - $tries == 1 && $curRes->duedate() &&
+ $curRes->duedate() > time()) {
+ $color = $hurryUpColor;
+ }
if ($color ne "") {
$colorizer = "bgcolor=\"$color\"";
}
}
- # FIRST COL: The resource indentation, branch icon, and name
- $r->print(" \n");
+ if ($curRes->randomout()) {
+ $nonLinkedText .= ' (hidden) ';
+ }
+
+ $rowNum++;
+ my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];
+
+ # FIRST COL: The resource indentation, branch icon, name, and anchor
+ $r->print(" |
\n");
+
+ # anchor for current resource... - 5 is deliberate: If it's that
+ # high on the screen, don't bother focusing on it. Also this will
+ # print multiple anchors if this is an expanded multi-part problem...
+ # who cares?
+ if ($counter == $currentUrlIndex - 5) {
+ $r->print('');
+ }
# print indentation
- for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
+ for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) {
$r->print($indentString);
}
$r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");
- my $nonLinkedText = "";
-
- if ($curRes->is_problem() && $part != "0" && !$condensed) {
+ my $curMarkerBegin = "";
+ my $curMarkerEnd = "";
+
+ # Is this the current resource?
+ if ($curRes->src() eq $currenturl && !$displayedHereMarker) {
+ $curMarkerBegin = '> ';
+ $curMarkerEnd = ' <';
+ $displayedHereMarker = 1;
+ }
+
+ if ($curRes->is_problem() && $part ne "0" && !$condensed) {
$partLabel = " (Part $part)";
$title = "";
}
if ($multipart && $condensed) {
- $nonLinkedText = ' (' . $curRes->countParts() . ' parts)';
+ $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
}
- $r->print(" $title$partLabel $nonLinkedText");
+ $r->print(" $curMarkerBegin$title$partLabel $curMarkerEnd $nonLinkedText");
if ($curRes->{RESOURCE_ERROR}) {
$r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
- 'Host down'));
+ 'Host down'));
}
my $discussionHTML = ""; my $feedbackHTML = "";
- # SECOND COL: Is there text or feedback?
+ # SECOND COL: Is there text, feedback, errors??
if ($curRes->hasDiscussion()) {
$discussionHTML = $linkopen .
'' .
@@ -1135,36 +1314,43 @@ sub new_handle {
}
}
- $r->print(" | $discussionHTML$feedbackHTML | ");
+ $r->print("$discussionHTML$feedbackHTML | ");
# Is this the first displayed part of a multi-part problem
# that has not been condensed, so we should suppress these two
# columns?
my $firstDisplayed = !$condensed && $multipart && $part eq "0";
- # THIRD ROW: Problem status icon
+ # THIRD COL: Problem status icon
if ($curRes->is_problem() &&
!$firstDisplayed) {
my $icon = $statusIconMap{$curRes->status($part)};
+ my $alt = $iconAltTags{$icon};
if ($icon) {
- $r->print("$linkopen$linkclose | \n");
+ $r->print("$linkopen$linkclose | \n");
} else {
- $r->print(" | \n");
+ $r->print(" | \n");
}
} else { # not problem, no icon
- $r->print(" | \n");
+ $r->print(" | \n");
}
- # FOURTH ROW: Text description
- $r->print("\n");
+ # FOURTH COL: Text description
+ #$r->print(" | \n");
+ $r->print(" | \n");
if ($curRes->kind() eq "res" &&
$curRes->is_problem() &&
!$firstDisplayed) {
+ $r->print ("") if ($color);
$r->print (getDescription($curRes, $part));
+ $r->print ("") if ($color);
+ }
+ if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
+ $r->print('(randomly select ' . $curRes->randompick() .')');
}
- $r->print(" |
\n");
+ $r->print(" \n");
}
}
$curRes = $mapIterator->next();
@@ -1232,27 +1418,27 @@ sub getLinkForResource {
sub getDescription {
my $res = shift;
my $part = shift;
- my $status = $res->getDateStatus();
+ my $status = $res->status($part);
if ($status == $res->NETWORK_FAILURE) { return ""; }
if ($status == $res->NOTHING_SET) {
return "Not currently assigned.";
}
if ($status == $res->OPEN_LATER) {
- return "Opens: " . timeToHumanString($res->opendate($part));
+ return "Open " . timeToHumanString($res->opendate($part));
}
if ($status == $res->OPEN) {
- if ($res->duedate()) {
- return "Due: $status " . timeToHumanString($res->duedate($part));
+ if ($res->duedate($part)) {
+ return "Due " . timeToHumanString($res->duedate($part));
} else {
return "Open, no due date";
}
}
if ($status == $res->PAST_DUE_ANSWER_LATER) {
- return "Answer opens: " . timeToHumanString($res->answerdate($part));
+ return "Answer open " . timeToHumanString($res->answerdate($part));
}
if ($status == $res->PAST_DUE_NO_ANSWER) {
- return "Was Due: " . timeToHumanString($res->duedate($part));
+ return "Was due " . timeToHumanString($res->duedate($part));
}
if ($status == $res->ANSWER_OPEN) {
return "Answer available";
@@ -1260,12 +1446,21 @@ sub getDescription {
if ($status == $res->EXCUSED) {
return "Excused by instructor";
}
+ if ($status == $res->ATTEMPTED) {
+ return "Not yet graded.";
+ }
if ($status == $res->TRIES_LEFT) {
- my $tries = $res->tries();
- my $maxtries = $res->maxtries();
- my $triesString = "($tries of $maxtries tries used)";
+ my $tries = $res->tries($part);
+ my $maxtries = $res->maxtries($part);
+ my $triesString = "";
+ if ($tries && $maxtries) {
+ $triesString = "($tries of $maxtries tries used)";
+ if ($maxtries > 1 && $maxtries - $tries == 1) {
+ $triesString = "$triesString";
+ }
+ }
if ($res->duedate()) {
- return "Due: $status " . timeToHumanString($res->duedate($part)) .
+ return "Due " . timeToHumanString($res->duedate($part)) .
" $triesString";
} else {
return "No due date $triesString";
@@ -1273,16 +1468,112 @@ sub getDescription {
}
}
-# I want to change this into something more human-friendly. For
-# now, this is a simple call to localtime. The final function
-# probably belongs in loncommon.
+sub advancedUser {
+ return $ENV{'user.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) = @_;
# zero, '0' and blank are bad times
- if ($time) {
- return localtime($time);
- } else {
- return 'Never';
+ if (!$time) {
+ return 'never';
+ }
+
+ my $now = time();
+
+ my @time = localtime($time);
+ my @now = localtime($now);
+
+ # Positive = future
+ my $delta = $time - $now;
+
+ my $minute = 60;
+ my $hour = 60 * $minute;
+ my $day = 24 * $hour;
+ my $week = 7 * $day;
+ my $inPast = 0;
+
+ # Logic in comments:
+ # Is it now? (extremely unlikely)
+ if ( $delta == 0 ) {
+ return "this instant";
+ }
+
+ if ($delta < 0) {
+ $inPast = 1;
+ $delta = -$delta;
+ }
+
+ # Is it in the future?
+ if ( $delta > 0 ) {
+ # Is it less then a minute away?
+ my $tense = $inPast ? " ago" : "";
+ my $prefix = $inPast ? "" : "in ";
+ if ( $delta < $minute ) {
+ if ($delta == 1) { return "${prefix}1 second$tense"; }
+ return "$prefix$delta seconds$tense";
+ }
+
+ # Is it less then an hour away?
+ if ( $delta < $hour ) {
+ # If so, use minutes
+ my $minutes = floor($delta / 60);
+ if ($minutes == 1) { return "${prefix}1 minute$tense"; }
+ return "$prefix$minutes minutes$tense";
+ }
+
+ # Is it less then 24 hours away? If so,
+ # display hours + minutes
+ if ( $delta < $hour * 24) {
+ my $hours = floor($delta / $hour);
+ my $minutes = floor(($delta % $hour) / $minute);
+ my $hourString = "$hours hours";
+ my $minuteString = ", $minutes minutes";
+ if ($hours == 1) {
+ $hourString = "1 hour";
+ }
+ if ($minutes == 1) {
+ $minuteString = ", 1 minute";
+ }
+ if ($minutes == 0) {
+ $minuteString = "";
+ }
+ return "$prefix$hourString$minuteString$tense";
+ }
+
+ # Less then 5 days away, display day of the week and
+ # HH:MM
+ if ( $delta < $day * 5 ) {
+ my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
+ $timeStr =~ s/12:00 am/midnight/;
+ $timeStr =~ s/12:00 pm/noon/;
+ return ($inPast ? "last " : "next ") .
+ $timeStr;
+ }
+
+ # Is it this year?
+ if ( $time[5] == $now[5]) {
+ # Return on Month Day, HH:MM meridian
+ my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
+ $timeStr =~ s/12:00 am/midnight/;
+ $timeStr =~ s/12:00 pm/noon/;
+ return $timeStr;
+ }
+
+ # Not this year, so show the year
+ my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
+ $timeStr =~ s/12:00 am/midnight/;
+ $timeStr =~ s/12:00 pm/noon/;
+ return $timeStr;
}
}
@@ -1290,10 +1581,6 @@ sub timeToHumanString {
package Apache::lonnavmaps::navmap;
-# LEFT:
-# * Actual handler code (multi-part)
-# * Branches (aieee!) (and conditionals)
-
=pod
lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
@@ -1310,7 +1597,7 @@ You must obtain resource objects through
=over 4
-=item * B(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. 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 if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
+=item * B(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 if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
=item * B(first, finish, filter, condition): See iterator documentation below.
@@ -1356,6 +1643,14 @@ sub new {
$self->{PARM_HASH} = \%parmhash;
$self->{HASH_TIED} = 1;
+ bless($self);
+
+ return $self;
+}
+
+sub init {
+ my $self = shift;
+
# If the course opt hash and the user opt hash should be generated,
# generate them
if ($self->{GENERATE_COURSE_USER_OPT}) {
@@ -1458,10 +1753,8 @@ sub new {
$self->{EMAIL_STATUS} = \%emailstatus;
}
-
- bless($self);
-
- return $self;
+
+ $self->{PARM_CACHE} = {};
}
# Checks to see if coursemap is defined, matching test in old lonnavmaps
@@ -1476,8 +1769,9 @@ sub courseMapDefined {
sub getIterator {
my $self = shift;
- my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
- shift, undef, shift);
+ my $iterator = Apache::lonnavmaps::DFSiterator->new($self, shift, shift,
+ shift, undef, shift,
+ $ENV{'form.direction'});
return $iterator;
}
@@ -1579,6 +1873,21 @@ sub finishResource {
sub parmval {
my $self = shift;
my ($what,$symb)=@_;
+ my $hashkey = $what."|||".$symb;
+
+ if (defined($self->{PARM_CACHE}->{$hashkey})) {
+ return $self->{PARM_CACHE}->{$hashkey};
+ }
+
+ my $result = $self->parmval_real($what, $symb);
+ $self->{PARM_CACHE}->{$hashkey} = $result;
+ return $result;
+}
+
+sub parmval_real {
+ my $self = shift;
+ my ($what,$symb) = @_;
+
my $cid=$ENV{'request.course.id'};
my $csec=$ENV{'request.course.sec'};
my $uname=$ENV{'user.name'};
@@ -1686,29 +1995,91 @@ getIterator behaves as follows:
=over 4
-=item B(nav_map, firstResource, finishResource, filterHash, condition): 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(). It is your responsibility to ensure that the iterator will actually get there. 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, which is to say, do not recurse unless explicitly asked to.
+=item B(firstResource, finishResource, filterHash, condition, direction): 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, which is to say, do not recurse unless explicitly asked to. Direction specifies which direction to recurse, either FORWARD or BACKWARD, with FORWARD being default.
-Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.
+Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.
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 * some list of tokens here
+=item * BEGIN_MAP: A new map is being recursed into. This is returned I the map resource itself is returned.
+
+=item * END_MAP: The map is now done.
+
+=item * BEGIN_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.
=back
-The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
+The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
+
+=back
=cut
# Here are the tokens for the iterator:
-sub END_NAV_MAP { return 0; } # Represents end of entire nav map
sub BEGIN_MAP { return 1; } # begining of a new map
sub END_MAP { return 2; } # end of the map
sub BEGIN_BRANCH { return 3; } # beginning of a branch
sub END_BRANCH { return 4; } # end of a branch
+sub FORWARD { return 1; } # go forward
+sub BACKWARD { return 2; }
+
+sub new {
+ # magic invocation to create a class instance
+ my $proto = shift;
+ my $class = ref($proto) || $proto;
+ my $self = {};
+
+ $self->{NAV_MAP} = shift;
+ return undef unless ($self->{NAV_MAP});
+
+ # Handle the parameters
+ $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
+ $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
+
+ # If the given resources are just the ID of the resource, get the
+ # objects
+ if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
+ $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
+ if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
+ $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
+
+ $self->{FILTER} = shift;
+
+ # A hash, used as a set, of resource already seen
+ $self->{ALREADY_SEEN} = shift;
+ if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
+ $self->{CONDITION} = shift;
+
+ # 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.
+
+ # Now we're ready to start iterating.
+}
+
+1;
+
+package Apache::lonnavmaps::DFSiterator;
+
+# UNDOCUMENTED: This is a private library, it should not generally be used
+# by the outside world. What it does is walk through the nav map in a
+# depth-first fashion. This is not appropriate for most uses, but it is
+# used by the main iterator for pre-processing. It also is able to isolate
+# much of the complexity of the main iterator, so the main iterator is much
+# simpler.
+
+# Here are the tokens for the iterator, replicated from iterator for convenience:
+
+sub BEGIN_MAP { return 1; } # begining of a new map
+sub END_MAP { return 2; } # end of the map
+sub BEGIN_BRANCH { return 3; } # beginning of a branch
+sub END_BRANCH { return 4; } # end of a branch
+sub FORWARD { return 1; } # go forward
+sub BACKWARD { return 2; }
# Params: nav map, start resource, end resource, filter, condition,
# already seen hash ref
@@ -1739,6 +2110,7 @@ sub new {
$self->{ALREADY_SEEN} = shift;
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
$self->{CONDITION} = shift;
+ $self->{DIRECTION} = shift || FORWARD();
# Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
$self->{STARTED} = 0;
@@ -1763,7 +2135,11 @@ sub new {
$self->{FORCE_NEXT} = undef;
# Start with the first resource
- push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
+ if ($self->{DIRECTION} == FORWARD) {
+ push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
+ } else {
+ push @{$self->{BRANCH_STACK}}, $self->{FINISH_RESOURCE};
+ }
$self->{BRANCH_STACK_SIZE} = 1;
bless($self);
@@ -1778,13 +2154,6 @@ sub next {
# Iterator logic goes here
- # Is this return value pre-determined?
- if (defined($self->{FORCE_NEXT})) {
- my $tmp = $self->{FORCE_NEXT};
- $self->{FORCE_NEXT} = undef;
- return $tmp;
- }
-
# Are we using a recursive iterator? If so, pull from that and
# watch the depth; we want to resume our level at the correct time.
if ($self->{RECURSIVE_ITERATOR_FLAG})
@@ -1804,6 +2173,13 @@ sub next {
return $next;
}
+ # Is this return value pre-determined?
+ if (defined($self->{FORCE_NEXT})) {
+ my $tmp = $self->{FORCE_NEXT};
+ $self->{FORCE_NEXT} = undef;
+ return $tmp;
+ }
+
# Is there a current resource to grab? If not, then return
# END_BRANCH and END_MAP in succession.
if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
@@ -1859,14 +2235,13 @@ sub next {
# remember that we've seen this.
$self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
- # Are we at the utter end? If so, return the END_NAV_MAP marker.
- if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
- $self->{FORCE_NEXT} = $self->END_NAV_MAP;
- return $self->{HERE};
- }
-
# Get the next possible resources
- my $nextUnfiltered = $self->{HERE}->getNext();
+ my $nextUnfiltered;
+ if ($self->{DIRECTION} == FORWARD()) {
+ $nextUnfiltered = $self->{HERE}->getNext();
+ } else {
+ $nextUnfiltered = $self->{HERE}->getPrevious();
+ }
my $next = [];
# filter the next possibilities to remove things we've
@@ -1892,7 +2267,6 @@ sub next {
$self->{FORCE_NEXT} = $self->END_BRANCH();
$self->{BRANCH_DEPTH}--;
}
- return $self->{HERE};
}
while (@$next) {
@@ -1914,13 +2288,10 @@ sub next {
my $firstResource = $self->{HERE}->map_start();
my $finishResource = $self->{HERE}->map_finish();
- # Odd perl syntax here; $self->new allows one to create a new iterator
- # can't figure out how to ref this package directly correctly
- # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
$self->{RECURSIVE_ITERATOR} =
- Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
+ Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
$finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
- $self->{CONDITION});
+ $self->{CONDITION}, $self->{DIRECTION});
}
return $self->{HERE};
@@ -1947,7 +2318,7 @@ sub populateStack {
my $self=shift;
my $stack = shift;
- push @$stack, $self->{HERE};
+ push @$stack, $self->{HERE} if ($self->{HERE});
if ($self->{RECURSIVE_ITERATOR_FLAG}) {
$self->{RECURSIVE_ITERATOR}->populateStack($stack);
@@ -1978,7 +2349,9 @@ resource objects have a hash called DATA
=over 4
-=item * B($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself.
+=item * B($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.
+
+=back
=cut
@@ -2005,20 +2378,6 @@ sub new {
return $self;
}
-=pod
-
-=item * B: Returns true if this is a map, false otherwise.
-
-=item * B: Returns title.
-
-=item * B: Returns the type of the resource, "start", "normal", or "finish".
-
-=item * B: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
-
-=back
-
-=cut
-
# private function: simplify the NAV_HASH lookups we keep doing
# pass the name, and to automatically append my ID, pass a true val on the
# second param
@@ -2029,15 +2388,49 @@ sub navHash {
return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
}
+=pod
+
+B
+
+These are methods that help you retrieve metadata about the resource:
+
+=over 4
+
+=item * B: Returns true if the resource is external.
+
+=item * B: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B instead.)
+
+=item * B: Returns the kind of the resource from the compiled nav map.
+
+=item * B: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.
+
+=item * B: Returns true for a map if the randompick feature is being used on the map. (?)
+
+=item * B: Returns the source for the resource.
+
+=item * B: Returns the symb for the resource.
+
+=item * B: Returns the title of the resource.
+
+=item * B: Returns the "to" value from the compiled nav map. (It is likely you want to use B instead.)
+
+=back
+
+=cut
+
# These info functions can be used directly, as they don't return
# resource information.
-sub title { my $self=shift; return $self->navHash("title_", 1); }
-sub type { my $self=shift; return $self->navHash("type_", 1); }
+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); }
sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
-# "to" can return a comma seperated list for branches
-sub to { my $self=shift; return $self->navHash("to_", 1); }
sub kind { my $self=shift; return $self->navHash("kind_", 1); }
-sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
+sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
+sub randompick {
+ my $self = shift;
+ return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
+ '.0.parameter_randompick'};
+}
sub src {
my $self=shift;
return $self->navHash("src_", 1);
@@ -2050,30 +2443,58 @@ sub symb {
$self->navHash('map_id_'.$first))
. '___' . $second . '___' . $symbSrc;
}
-sub is_problem {
+sub title { my $self=shift; return $self->navHash("title_", 1); }
+sub to { my $self=shift; return $self->navHash("to_", 1); }
+
+=pod
+
+B
+
+These methods are shortcuts to deciding if a given resource has a given property.
+
+=over 4
+
+=item * B: Returns true if the resource is a map type.
+
+=item * B: 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: Returns true if the resource is a page.
+
+=item * B: Returns true if the resource is a problem.
+
+=item * B: Returns true if the resource sequence.
+
+=back
+
+=cut
+
+
+sub is_html {
my $self=shift;
my $src = $self->src();
- return ($src =~ /problem$/);
+ return ($src =~ /html$/);
}
-sub is_html {
+sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
+sub is_page {
my $self=shift;
my $src = $self->src();
- return ($src =~ /html$/);
+ return ($src =~ /page$/);
}
-sub is_sequence {
+sub is_problem {
my $self=shift;
my $src = $self->src();
- return ($src =~ /sequence$/);
+ return ($src =~ /problem$/);
}
-sub is_page {
+sub is_sequence {
my $self=shift;
my $src = $self->src();
- return ($src =~ /page$/);
+ return ($src =~ /sequence$/);
}
+
# Move this into POD: In order to use these correctly, courseopt
# and useropt need to be generated
sub parmval {
@@ -2083,14 +2504,26 @@ sub parmval {
return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
}
-#####
-# Map Queries
-#####
+=pod
-# These methods relate to whether or not the resource is a map, and the
-# attributes of that map.
+B