\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) {
+ # Print the anchor if necessary
+ if ($counter == $currentUrlIndex - $currentUrlDelta) {
$r->print('');
}
@@ -543,18 +549,15 @@ sub handler {
}
$r->print(" $curMarkerBegin$title$partLabel $curMarkerEnd $nonLinkedText");
- #$r->print(" TDV:" . $curRes->{DATA}->{TOP_DOWN_VAL}); # temp
- #$r->print(" BUV:" . $curRes->{DATA}->{BOT_UP_VAL}); # temp
- #$r->print(" DD:" . $curRes->{DATA}->{DISPLAY_DEPTH}); # temp
if ($curRes->{RESOURCE_ERROR}) {
$r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
'Host down'));
}
+ # SECOND COL: Is there text, feedback, errors??
my $discussionHTML = ""; my $feedbackHTML = "";
- # SECOND COL: Is there text, feedback, errors??
if ($curRes->hasDiscussion()) {
$discussionHTML = $linkopen .
' ' .
@@ -577,7 +580,8 @@ sub handler {
# Is this the first displayed part of a multi-part problem
# that has not been condensed, so we should suppress these two
- # columns?
+ # columns so we don't display useless status info about part
+ # "0"?
my $firstDisplayed = !$condensed && $multipart && $part eq "0";
# THIRD COL: Problem status icon
@@ -595,7 +599,6 @@ sub handler {
}
# FOURTH COL: Text description
- #$r->print(" | \n");
$r->print(" | \n");
if ($curRes->kind() eq "res" &&
@@ -727,6 +730,7 @@ sub getDescription {
}
}
+# This puts a human-readable name on the ENV variable.
sub advancedUser {
return $ENV{'user.adv'};
}
@@ -772,17 +776,18 @@ sub timeToHumanString {
$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 ";
+
+ # Less then a minute
if ( $delta < $minute ) {
if ($delta == 1) { return "${prefix}1 second$tense"; }
return "$prefix$delta seconds$tense";
}
- # Is it less then an hour away?
+ # Less then an hour
if ( $delta < $hour ) {
# If so, use minutes
my $minutes = floor($delta / 60);
@@ -876,7 +881,7 @@ sub new {
$self->{GENERATE_COURSE_USER_OPT} = shift;
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
- # Resource cache stores navmapresource's as we reference them. We generate
+ # Resource cache stores navmap resources as we reference them. We generate
# them on-demand so we don't pay for creating resources unless we use them.
$self->{RESOURCE_CACHE} = {};
@@ -1029,8 +1034,7 @@ sub courseMapDefined {
sub getIterator {
my $self = shift;
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
- shift, undef, shift,
- $ENV{'form.direction'});
+ shift, undef, shift);
return $iterator;
}
@@ -1121,14 +1125,8 @@ sub finishResource {
return $self->getById($firstResource);
}
-# -------------------------------------------- Figure out a cascading parameter
-#
-# For this function to work
-#
-# * parmhash needs to be tied
-# * courseopt and useropt need to be initialized for this user and course
-#
-
+# Parmval reads the parm hash and cascades the lookups. parmval_real does
+# the actual lookup; parmval caches the results.
sub parmval {
my $self = shift;
my ($what,$symb)=@_;
@@ -1230,10 +1228,6 @@ sub parmval_real {
package Apache::lonnavmaps::iterator;
-# This package must precede "navmap" because "navmap" uses it. In
-# order to keep the documentation order straight, the iterator is documented
-# after the navmap object.
-
=pod
=back
@@ -1254,9 +1248,9 @@ getIterator behaves as follows:
=over 4
-=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.
+=item * B(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(). 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.
-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.
+Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.
The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
@@ -1292,6 +1286,11 @@ sub min {
if ($a < $b) { return $a; } else { return $b; }
}
+# In the CVS repository, documentation of this algorithm is included
+# in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1**
+# will reference the same location in the text as the part of the
+# algorithm is running through.
+
sub new {
# magic invocation to create a class instance
my $proto = shift;
@@ -1334,6 +1333,8 @@ sub new {
my $maxDepth = 0; # tracks max depth
+ # **1**
+
foreach my $pass (@iterations) {
my $direction = $pass->[0];
my $valName = $pass->[1];
@@ -1358,13 +1359,13 @@ sub new {
my $resultingVal = $curRes->{DATA}->{$valName};
my $nextResources = $curRes->$nextResourceMethod();
my $resourceCount = scalar(@{$nextResources});
-
- if ($resourceCount == 1) {
+
+ if ($resourceCount == 1) { # **3**
my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
}
- if ($resourceCount > 1) {
+ if ($resourceCount > 1) { # **4**
foreach my $res (@{$nextResources}) {
my $current = $res->{DATA}->{$valName} || 999999999;
$res->{DATA}->{$valName} = min($current, $resultingVal + 1);
@@ -1372,7 +1373,7 @@ sub new {
}
}
- # Assign the final val
+ # Assign the final val (**2**)
if (ref($curRes) && $direction == BACKWARD()) {
my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
$curRes->{DATA}->{BOT_UP_VAL});
@@ -1394,7 +1395,7 @@ sub new {
push @{$self->{STACK}}, [];
}
- # Prime the recursion w/ the first resource
+ # Prime the recursion w/ the first resource **5**
push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
@@ -1443,8 +1444,8 @@ sub next {
my $newDepth;
my $here;
while ( $i >= 0 && !$found ) {
- if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) {
- $here = $self->{HERE} = shift @{$self->{STACK}->[$i]};
+ if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
+ $here = pop @{$self->{STACK}->[$i]}; # **7**
$found = 1;
$newDepth = $i;
}
@@ -1462,6 +1463,18 @@ sub next {
}
}
+ # If this is not a resource, it must be an END_BRANCH marker we want
+ # to return directly.
+ if (!ref($here)) { # **8**
+ if ($here == END_BRANCH()) { # paranoia, in case of later extension
+ $self->{CURRENT_DEPTH}--;
+ return $here;
+ }
+ }
+
+ # Otherwise, it is a resource and it's safe to store in $self->{HERE}
+ $self->{HERE} = $here;
+
# Get to the right level
if ( $self->{CURRENT_DEPTH} > $newDepth ) {
push @{$self->{STACK}->[$newDepth]}, $here;
@@ -1481,14 +1494,32 @@ sub next {
# So we need to look at all the resources we can get to from here,
# categorize them if we haven't seen them, remember if we have a new
my $nextUnfiltered = $here->getNext();
-
+ my $maxDepthAdded = -1;
+
for (@$nextUnfiltered) {
if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
- push @{$self->{STACK}->[$_->{DATA}->{DISPLAY_DEPTH}]}, $_;
+ my $depth = $_->{DATA}->{DISPLAY_DEPTH};
+ push @{$self->{STACK}->[$depth]}, $_;
$self->{ALREADY_SEEN}->{$_->{ID}} = 1;
+ if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
}
}
-
+
+ # Is this the end of a branch? If so, all of the resources examined above
+ # led to lower levels then the one we are currently at, so we push a END_BRANCH
+ # marker onto the stack so we don't forget.
+ # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
+ # BC branch and gets to C, it will see F as the only next resource, but it's
+ # one level lower. Thus, this is the end of the branch, since there are no
+ # more resources added to this level or above.
+ # We don't do this if the examined resource is the finish resource,
+ # because the condition given above is true, but the "END_MAP" will
+ # take care of things and we should already be at depth 0.
+ my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
+ if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
+ push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
+ }
+
# That ends the main iterator logic. Now, do we want to recurse
# down this map (if this resource is a map)?
if ($self->{HERE}->is_map() &&
@@ -1756,17 +1787,19 @@ sub navHash {
B
-These are methods that help you retrieve metadata about the resource:
+These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.
=over 4
+=item * B: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem").
+
=item * B: 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 if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false.
=item * B: Returns true for a map if the randompick feature is being used on the map. (?)
@@ -1809,7 +1842,15 @@ sub symb {
}
sub title { my $self=shift; return $self->navHash("title_", 1); }
sub to { my $self=shift; return $self->navHash("to_", 1); }
-
+sub compTitle {
+ my $self = shift;
+ my $title = $self->title();
+ if (!$title) {
+ $title = $self->src();
+ $title = substr($title, rindex($title, '/') + 1);
+ }
+ return $title;
+}
=pod
B
@@ -1826,7 +1867,7 @@ These methods are shortcuts to deciding
=item * B: Returns true if the resource is a problem.
-=item * B: Returns true if the resource sequence.
+=item * B: Returns true if the resource is a sequence.
=back
@@ -1855,12 +1896,7 @@ sub is_sequence {
return ($src =~ /sequence$/);
}
-
-
-
-
-# Move this into POD: In order to use these correctly, courseopt
-# and useropt need to be generated
+# Private method: Shells out to the parmval in the nav map, handler parts.
sub parmval {
my $self = shift;
my $what = shift;
@@ -1974,6 +2010,7 @@ sub answerdate {
}
return $self->parmval("answerdate", $part);
}
+sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); }
sub duedate {
(my $self, my $part) = @_;
return $self->parmval("duedate", $part);
@@ -1998,24 +2035,18 @@ sub tol {
(my $self, my $part) = @_;
return $self->parmval("tol", $part);
}
-sub tries {
- my $self = shift;
- my $part = shift;
- $part = '0' if (!defined($part));
-
- # Make sure return hash is loaded, should error check
- $self->getReturnHash();
-
- my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
- if (!defined($tries)) {return '0';}
+sub tries {
+ my $self = shift;
+ my $tries = $self->queryRestoreHash('tries', shift);
+ if (!defined($tries)) { return '0';}
return $tries;
}
sub type {
(my $self, my $part) = @_;
return $self->parmval("type", $part);
}
-sub weight {
- (my $self, my $part) = @_;
+sub weight {
+ my $self = shift; my $part = shift;
return $self->parmval("weight", $part);
}
@@ -2143,7 +2174,7 @@ sub extractParts {
=head2 Resource Status
-Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status.
+Problem resources have status information, reflecting their various dates and completion statuses.
There are two aspects to the status: the date-related information and the completion information.
@@ -2160,6 +2191,10 @@ Idiomatic usage of these two methods wou
... use it here ...
}
+Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere.
+
+The symbolic constants shown below can be accessed through the resource object: $res->OPEN.
+
=over 4
=item * B($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
@@ -2273,14 +2308,9 @@ sub ATTEMPTED { return 16; }
sub getCompletionStatus {
my $self = shift;
- my $part = shift;
- $part = "0" if (!defined($part));
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
- # Make sure return hash exists
- $self->getReturnHash();
-
- my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
+ my $status = $self->queryRestoreHash('solved', shift);
# Left as seperate if statements in case we ever do more with this
if ($status eq 'correct_by_student') {return $self->CORRECT;}
@@ -2292,11 +2322,23 @@ sub getCompletionStatus {
return $self->NOT_ATTEMPTED;
}
+sub queryRestoreHash {
+ my $self = shift;
+ my $hashentry = shift;
+ my $part = shift;
+ $part = "0" if (!defined($part));
+ return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
+
+ $self->getReturnHash();
+
+ return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
+}
+
=pod
B
-Along with directly returning the date or completion status, the resource object includes a convenience function B() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()):
+Along with directly returning the date or completion status, the resource object includes a convenience function B() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE):
=over 4
@@ -2400,15 +2442,14 @@ sub status {
=over 4
-=item * B($alreadySeenHashRef): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. The "alreadySeenHashRef" is an optional parameter that can be passed in to the method. If $$alreadySeenHashRef{$res->id()} is true in that hash, getNext will not return it in the list. In other words, you can use it to suppress resources you've already seen in the getNext method directly.
+=item * B(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case.
-=item * B($alreadySeenHashRef): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. $alreadySeenHashRef is the same as in getNext.
+=item * B(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case.
=cut
sub getNext {
my $self = shift;
- my $alreadySeenHash = shift;
my @branches;
my $to = $self->to();
foreach my $branch ( split(/,/, $to) ) {
@@ -2416,21 +2457,18 @@ sub getNext {
my $next = $choice->goesto();
$next = $self->{NAV_MAP}->getById($next);
- # Don't remember it if we've already seen it or if
- # the student doesn't have browse priviledges
+ # Don't remember it if the student doesn't have browse priviledges
+ # future note: this may properly belong in the client of the resource
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
- if (!defined($alreadySeenHash) ||
- !defined($alreadySeenHash->{$next->{ID}}) ||
- ($browsePriv ne '2' && $browsePriv ne 'F')) {
- push @branches, $next;
- }
+ if (!($browsePriv ne '2' && $browsePriv ne 'F')) {
+ push @branches, $next;
+ }
}
return \@branches;
}
sub getPrevious {
my $self = shift;
- my $alreadySeenHash = shift;
my @branches;
my $from = $self->from();
foreach my $branch ( split /,/, $from) {
@@ -2438,12 +2476,10 @@ sub getPrevious {
my $prev = $choice->comesfrom();
$prev = $self->{NAV_MAP}->getById($prev);
- # Skip it if we've already seen it or the user doesn't have
- # browse privs
+ # Don't remember it if the student doesn't have browse priviledges
+ # future note: this may properly belong in the client of the resource
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
- if (!defined($alreadySeenHash) ||
- !defined($alreadySeenHash->{$prev->{ID}}) ||
- ($browsePriv ne '2' && $browsePriv ne 'F')) {
+ if (!($browsePriv ne '2' && $browsePriv ne 'F')) {
push @branches, $prev;
}
}
|
![](\"/adm/lonIcons/branch.gif\")
";
$isNewBranch = 0;
- $deltalevel = 1;
+ $deltalevel = 1; # reserves space for the branch icon
}
# links to open and close the folders
@@ -509,11 +518,8 @@ sub handler {
# FIRST COL: The resource indentation, branch icon, name, and anchor
$r->print("