");
$ENV{'form.filter'} = '';
$ENV{'form.condition'} = 1;
$resource_no_folder_link = 1;
} else {
- $r->print("" .
- "Show Only Uncompleted Homework ");
+ $r->print("" .
+ &mt("Show Only Uncompleted Homework")." ");
}
+ my %selected=($ENV{'form.sort'} => 'selected=on');
+ my $sort_html=("");
# renderer call
- my $renderArgs = { 'cols' => [0,1,2,3],
+ my $renderArgs = { 'cols' => [0,2,3],
+ 'sort' => $ENV{'form.sort'},
'url' => '/adm/navmaps',
'navmap' => $navmap,
'suppressNavmap' => 1,
'suppressEmptySequences' => $suppressEmptySequences,
'filterFunc' => $filterFunc,
'resource_no_folder_link' => $resource_no_folder_link,
+ 'sort_html'=> $sort_html,
'r' => $r};
my $render = render($renderArgs);
$navmap->untieHashes();
@@ -286,7 +382,7 @@ sub real_handler {
# user knows there was no error.
if ($renderArgs->{'counter'} == 0) {
if ($showOnlyHomework) {
- $r->print("
All homework is currently completed.
");
+ $r->print("
".&mt("All homework is currently completed").".
");
} else { # both jumpToFirstHomework and normal use the same: course must be empty
$r->print("
This course is empty.
");
}
@@ -328,8 +424,16 @@ sub getLinkForResource {
# Check to see if there are any pages in the stack
foreach $res (@$stack) {
- if (defined($res) && $res->is_page()) {
- return $res->src();
+ if (defined($res)) {
+ if ($res->is_page()) {
+ return $res->src();
+ }
+ # in case folder was skipped over as "only sequence"
+ my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
+ if ($map=~/\.page$/) {
+ return &Apache::lonnet::clutter($map).'#'.
+ &Apache::lonnet::escape(&Apache::lonnet::declutter($src));
+ }
}
}
@@ -344,9 +448,9 @@ sub getLinkForResource {
return $res->src();
}
-# Convenience function: This seperates the logic of how to create
+# Convenience function: This separates the logic of how to create
# the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
-# etc.) into a seperate function. It takes a resource object as the
+# 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.
@@ -356,35 +460,35 @@ sub getDescription {
my $status = $res->status($part);
if ($status == $res->NETWORK_FAILURE) {
- return "Having technical difficulties; please check status later";
+ return &mt("Having technical difficulties; please check status later");
}
if ($status == $res->NOTHING_SET) {
- return "Not currently assigned.";
+ return &mt("Not currently assigned.");
}
if ($status == $res->OPEN_LATER) {
return "Open " . timeToHumanString($res->opendate($part));
}
if ($status == $res->OPEN) {
if ($res->duedate($part)) {
- return "Due " . timeToHumanString($res->duedate($part));
+ return &mt("Due")." " .timeToHumanString($res->duedate($part));
} else {
- return "Open, no due date";
+ return &mt("Open, no due date");
}
}
if ($status == $res->PAST_DUE_ANSWER_LATER) {
- return "Answer open " . timeToHumanString($res->answerdate($part));
+ return &mt("Answer open")." " . timeToHumanString($res->answerdate($part));
}
if ($status == $res->PAST_DUE_NO_ANSWER) {
- return "Was due " . timeToHumanString($res->duedate($part));
+ return &mt("Was due")." " . timeToHumanString($res->duedate($part));
}
if ($status == $res->ANSWER_OPEN) {
- return "Answer available";
+ return &mt("Answer available");
}
if ($status == $res->EXCUSED) {
- return "Excused by instructor";
+ return &mt("Excused by instructor");
}
if ($status == $res->ATTEMPTED) {
- return "Answer submitted, not yet graded.";
+ return &mt("Answer submitted, not yet graded");
}
if ($status == $res->TRIES_LEFT) {
my $tries = $res->tries($part);
@@ -396,30 +500,30 @@ sub getDescription {
$triesString = "$triesString";
}
}
- if ($res->duedate()) {
- return "Due " . timeToHumanString($res->duedate($part)) .
+ if ($res->duedate($part)) {
+ return &mt("Due")." " . timeToHumanString($res->duedate($part)) .
" $triesString";
} else {
- return "No due date $triesString";
+ return &mt("No due date")." $triesString";
}
}
if ($status == $res->ANSWER_SUBMITTED) {
- return 'Answer submitted';
+ return &mt('Answer submitted');
}
}
# Convenience function, so others can use it: Is the problem due in less then
# 24 hours, and still can be done?
-sub dueInLessThen24Hours {
+sub dueInLessThan24Hours {
my $res = shift;
my $part = shift;
my $status = $res->status($part);
return ($status == $res->OPEN() ||
$status == $res->TRIES_LEFT()) &&
- $res->duedate() && $res->duedate() < time()+(24*60*60) &&
- $res->duedate() > time();
+ $res->duedate($part) && $res->duedate($part) < time()+(24*60*60) &&
+ $res->duedate($part) > time();
}
# Convenience function, so others can use it: Is there only one try remaining for the
@@ -431,8 +535,8 @@ sub lastTry {
my $tries = $res->tries($part);
my $maxtries = $res->maxtries($part);
return $tries && $maxtries && $maxtries > 1 &&
- $maxtries - $tries == 1 && $res->duedate() &&
- $res->duedate() > time();
+ $maxtries - $tries == 1 && $res->duedate($part) &&
+ $res->duedate($part) > time();
}
# This puts a human-readable name on the ENV variable.
@@ -454,9 +558,11 @@ sub timeToHumanString {
my ($time) = @_;
# zero, '0' and blank are bad times
if (!$time) {
- return 'never';
+ return &mt('never');
}
-
+ unless (&Apache::lonlocal::current_language()=~/^en/) {
+ return &Apache::lonlocal::locallocaltime($time);
+ }
my $now = time();
my @time = localtime($time);
@@ -524,7 +630,7 @@ sub timeToHumanString {
# 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 am/00:00/;
$timeStr =~ s/12:00 pm/noon/;
return ($inPast ? "last " : "next ") .
$timeStr;
@@ -534,14 +640,14 @@ sub timeToHumanString {
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 am/00:00/;
$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 am/00:00/;
$timeStr =~ s/12:00 pm/noon/;
return $timeStr;
}
@@ -552,7 +658,8 @@ sub timeToHumanString {
=head1 NAME
-Apache::lonnavmap - Subroutines to handle and render the navigation maps
+Apache::lonnavmap - Subroutines to handle and render the navigation
+ maps
=head1 SYNOPSIS
@@ -562,12 +669,12 @@ other modules.
=head1 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". 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".
+X 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. 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
@@ -679,13 +786,13 @@ can't close or open folders when this is
=back
-=item B:
+=item * B:
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:
+=item * B:
An icon for the status of a problem, with five possible states:
Correct, incorrect, open, awaiting grading (for a problem where the
@@ -693,11 +800,24 @@ computer's grade is suppressed, or the c
essay problem), or none (not open yet, not a problem). The
third column of the standard navmap.
-=item B:
+=item * B:
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:
+
+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 showing parts. If
+C is true (see below), this column will not output
+anything.
+
=back
If you add any others please be sure to document them here.
@@ -716,9 +836,7 @@ to override vertical and horizontal alig
=head2 Parameters
-Most of these parameters are only useful if you are *not* using the
-folder interface (i.e., the default first column), which is probably
-the common case. If you are using this interface, then you should be
+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
@@ -867,8 +985,7 @@ sub resource { return 0; }
sub communication_status { return 1; }
sub quick_status { return 2; }
sub long_status { return 3; }
-
-# Data for render_resource
+sub part_status_summary { return 4; }
sub render_resource {
my ($resource, $part, $params) = @_;
@@ -881,10 +998,7 @@ sub render_resource {
my $filter = $it->{FILTER};
my $title = $resource->compTitle();
- if ($src =~ /^\/uploaded\//) {
- $nonLinkedText=$title;
- $title = '';
- }
+
my $partLabel = "";
my $newBranchText = "";
@@ -907,12 +1021,8 @@ sub render_resource {
$icon = $params->{'indentString'};
}
} else {
- my $curfext= (split (/\./,$resource->src))[-1];
- my $embstyle = &Apache::loncommon::fileembstyle($curfext);
- # The unless conditional that follows is a bit of overkill
- if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
- $icon = "";
- }
+ $icon = "";
}
# Display the correct map icon to open or shut map
@@ -982,7 +1092,9 @@ sub render_resource {
if ($resource->is_problem() && $part ne '0' &&
!$params->{'condensed'}) {
- $partLabel = " (Part $part)";
+ my $displaypart=$resource->part_display($part);
+ $partLabel = " (Part: $displaypart)";
+ $link.='#'.&Apache::lonnet::escape($part);
$title = "";
}
@@ -990,9 +1102,12 @@ sub render_resource {
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
}
- if (!$params->{'resource_nolink'} && $src !~ /^\/uploaded\// &&
- !$resource->is_sequence()) {
- $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText";
+ my $target;
+ if ($ENV{'environment.remotenavmap'} eq 'on') {
+ $target=' target="loncapaclient" ';
+ }
+ if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
+ $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText";
} else {
$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText";
}
@@ -1028,8 +1143,11 @@ sub render_communication_status {
if ($resource->getErrors()) {
my $errors = $resource->getErrors();
+ my $errorcount = 0;
foreach (split(/,/, $errors)) {
+ last if ($errorcount>=10); # Only output 10 bombs maximum
if ($_) {
+ $errorcount++;
$errorHTML .= ' '
. 'is_problem() &&
!$firstDisplayed) {
- my $icon = $statusIconMap{$resource->status($part)};
+
+ my $icon = $statusIconMap{$resource->simpleStatus($part)};
my $alt = $iconAltTags{$icon};
if ($icon) {
$result .= "
$linkopen$linkclose
\n";
@@ -1080,7 +1199,7 @@ sub render_long_status {
if ($resource->is_problem()) {
$color = $colormap{$resource->status};
- if (dueInLessThen24Hours($resource, $part) ||
+ if (dueInLessThan24Hours($resource, $part) ||
lastTry($resource, $part)) {
$color = $hurryUpColor;
}
@@ -1106,8 +1225,84 @@ sub render_long_status {
return $result;
}
+# Colors obtained by taking the icons, matching the colors, and
+# possibly reducing the Value (HSV) of the color, if it's too bright
+# for text, generally by one third or so.
+my %statusColors =
+ (
+ $resObj->CLOSED => '#000000',
+ $resObj->OPEN => '#998b13',
+ $resObj->CORRECT => '#26933f',
+ $resObj->INCORRECT => '#c48207',
+ $resObj->ATTEMPTED => '#a87510',
+ $resObj->ERROR => '#000000'
+ );
+my %statusStrings =
+ (
+ $resObj->CLOSED => 'Not yet open',
+ $resObj->OPEN => 'Open',
+ $resObj->CORRECT => 'Correct',
+ $resObj->INCORRECT => 'Incorrect',
+ $resObj->ATTEMPTED => 'Attempted',
+ $resObj->ERROR => 'Network Error'
+ );
+my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
+
+use Data::Dumper;
+sub render_parts_summary_status {
+ my ($resource, $part, $params) = @_;
+ if (!$resource->is_problem() && !$resource->contains_problem) { return '
'; }
+ if ($params->{showParts}) {
+ return '
';
+ }
+
+ my $td = "
\n";
+ my $endtd = "
\n";
+ my @probs;
+
+ if ($resource->contains_problem) {
+ @probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0);
+ } else {
+ @probs=($resource);
+ }
+ my $return;
+ my %overallstatus;
+ my $totalParts;
+ foreach my $resource (@probs) {
+ # If there is a single part, just show the simple status
+ if ($resource->singlepart()) {
+ my $status = $resource->simpleStatus(${$resource->parts}[0]);
+ $overallstatus{$status}++;
+ $totalParts++;
+ next;
+ }
+ # Now we can be sure the $part doesn't really matter.
+ my $statusCount = $resource->simpleStatusCount();
+ my @counts;
+ foreach my $status (@statuses) {
+ # decouple display order from the simpleStatusCount order
+ my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
+ if ($statusCount->[$slot]) {
+ $overallstatus{$status}+=$statusCount->[$slot];
+ $totalParts+=$statusCount->[$slot];
+ }
+ }
+ }
+ $return.= $td . $totalParts . ' parts: ';
+ foreach my $status (@statuses) {
+ if ($overallstatus{$status}) {
+ $return.="" . $overallstatus{$status} . ' '
+ . $statusStrings{$status} . "";
+ }
+ }
+ $return.= $endtd;
+ return $return;
+}
+
my @preparedColumns = (\&render_resource, \&render_communication_status,
- \&render_quick_status, \&render_long_status);
+ \&render_quick_status, \&render_long_status,
+ \&render_parts_summary_status);
sub setDefault {
my ($val, $default) = @_;
@@ -1137,6 +1332,7 @@ sub render {
my $jump = $args->{'jump'};
my $here = $args->{'here'};
my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
+ my $closeAllPages = setDefault($args->{'closeAllPages'}, 0);
my $currentJumpDelta = 2; # change this to change how many resources are displayed
# before the current resource when using #current
@@ -1173,12 +1369,9 @@ sub render {
if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {
- $navmap = Apache::lonnavmaps::navmap->new(
- $ENV{"request.course.fn"}.".db",
- $ENV{"request.course.fn"}."_parms.db", 1, 1);
+ $navmap = Apache::lonnavmaps::navmap->new();
$mustCloseNavMap = 1;
}
- $navmap->init();
# Step two: Locate what kind of here marker is necessary
# Determine where the "here" marker is and where the screen jumps to.
@@ -1196,18 +1389,13 @@ sub render {
# Step three: Ensure the folders are open
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
- my $depth = 1;
- $mapIterator->next(); # discard the first BEGIN_MAP
- my $curRes = $mapIterator->next();
+ my $curRes;
my $found = 0;
# We only need to do this if we need to open the maps to show the
# current position. This will change the counter so we can't count
# for the jump marker with this loop.
- while ($depth > 0 && !$found) {
- if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
- if ($curRes == $mapIterator->END_MAP()) { $depth--; }
-
+ while (($curRes = $mapIterator->next()) && !$found) {
if (ref($curRes) && $curRes->symb() eq $here) {
my $mapStack = $mapIterator->getStack();
@@ -1221,8 +1409,6 @@ sub render {
}
$found = 1;
}
-
- $curRes = $mapIterator->next();
}
}
@@ -1239,13 +1425,9 @@ sub render {
# Step 1: Check to see if we have a navmap
if (!defined($navmap)) {
- $navmap = Apache::lonnavmaps::navmap->new($r,
- $ENV{"request.course.fn"}.".db",
- $ENV{"request.course.fn"}."_parms.db", 1, 1);
+ $navmap = Apache::lonnavmaps::navmap->new();
$mustCloseNavMap = 1;
}
- # Paranoia: Make sure it's ready
- $navmap->init();
# See if we're being passed a specific map
if ($args->{'iterator_map'}) {
@@ -1259,20 +1441,16 @@ sub render {
$args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
}
}
-
+
# (re-)Locate the jump point, if any
# Note this does not take filtering or hidden into account... need
# to be fixed?
my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
- my $depth = 1;
- $mapIterator->next();
- my $curRes = $mapIterator->next();
+ my $curRes;
my $foundJump = 0;
my $counter = 0;
- while ($depth > 0 && !$foundJump) {
- if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
- if ($curRes == $mapIterator->END_MAP()) { $depth--; }
+ while (($curRes = $mapIterator->next()) && !$foundJump) {
if (ref($curRes)) { $counter++; }
if (ref($curRes) && $jump eq $curRes->symb()) {
@@ -1283,8 +1461,6 @@ sub render {
$args->{'currentJumpIndex'} = $counter;
$foundJump = 1;
}
-
- $curRes = $mapIterator->next();
}
my $showParts = setDefault($args->{'showParts'}, 1);
@@ -1303,15 +1479,15 @@ sub render {
$result.='
Key:
';
if ($navmap->{LAST_CHECK}) {
$result .=
- ' New discussion since '.
+ ' '.&mt('New discussion since').' '.
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
'
'.
- ' New message (click to open)
'.
+ ' '.&mt('New message (click to open)').'
'.
'
';
} else {
$result .= '
'.
- ' Discussions
'.
- ' New message (click to open)'.
+ ' '.&mt('Discussions').'
'.
+ ' '.&mt('New message (click to open)').
'
';
}
@@ -1322,15 +1498,52 @@ sub render {
if ($condition) {
$result.="Close All Folders";
+ "\">".&mt('Close All Folders')."";
} else {
$result.="Open All Folders";
+ "\">".&mt('Open All Folders')."";
}
- $result .= "
\n";
- }
+ $result .= "\n";
+ }
+
+ # Check for any unread discussions in all resources.
+ if (!$args->{'resource_no_folder_link'}) {
+ my $totdisc = 0;
+ my $haveDisc = '';
+ my @allres=$navmap->retrieveResources();
+ foreach my $resource (@allres) {
+ if ($resource->hasDiscussion()) {
+ my $ressymb;
+ if ($resource->symb() =~ m-(___adm/\w+/\w+)/(\d+)/bulletinboard$-) {
+ $ressymb = 'bulletin___'.$2.$1.'/'.$2.'/bulletinboard';
+ } else {
+ $ressymb = $resource->symb();
+ }
+ $haveDisc .= $ressymb.':';
+ $totdisc ++;
+ }
+ }
+ if ($totdisc > 0) {
+ $haveDisc =~ s/:$//;
+ my %lt = &Apache::lonlocal::texthash(
+ 'mapr' => 'Mark all posts read',
+ );
+ $result .= (<$lt{'mapr'}
+
+END
+ } else {
+ $result .= ' ';
+ }
+ }
+ if ($args->{'sort_html'}) { $result.=$args->{'sort_html'}; }
+
+ $result .= " \n";
if ($r) {
$r->print($result);
$r->rflush();
@@ -1362,7 +1575,7 @@ sub render {
$it->{FIRST_RESOURCE},
$it->{FINISH_RESOURCE},
{}, undef, 1);
- $depth = 0;
+ my $depth = 0;
$dfsit->next();
my $curRes = $dfsit->next();
while ($depth > -1) {
@@ -1394,9 +1607,6 @@ sub render {
my $displayedJumpMarker = 0;
# Set up iteration.
- $depth = 1;
- $it->next(); # discard initial BEGIN_MAP
- $curRes = $it->next();
my $now = time();
my $in24Hours = $now + 24 * 60 * 60;
my $rownum = 0;
@@ -1404,9 +1614,43 @@ sub render {
# export "here" marker information
$args->{'here'} = $here;
- while ($depth > 0) {
- if ($curRes == $it->BEGIN_MAP()) { $depth++; }
- if ($curRes == $it->END_MAP()) { $depth--; }
+ $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
+ my @resources;
+ my $code='';# sub { !(shift->is_map();) };
+ if ($args->{'sort'} eq 'title') {
+ my $oldFilterFunc = $filterFunc;
+ my $filterFunc=
+ sub {
+ my ($res)=@_;
+ if ($res->is_map()) { return 0;}
+ return &$oldFilterFunc($res);
+ };
+ @resources=$navmap->retrieveResources(undef,$filterFunc);
+ @resources= sort {lc($a->compTitle) cmp lc($b->compTitle)} @resources;
+ } elsif ($args->{'sort'} eq 'duedate') {
+ @resources=$navmap->retrieveResources(undef,
+ sub { shift->is_problem(); });
+ @resources= sort
+ {
+ if ($a->duedate ne $b->duedate) {
+ return $a->duedate cmp $b->duedate;
+ } else {
+ lc($a->compTitle) cmp lc($b->compTitle)
+ }
+ } @resources;
+ } else {
+ #unknow sort mechanism or default
+ undef($args->{'sort'});
+ }
+
+
+ while (1) {
+ if ($args->{'sort'}) {
+ $curRes = shift(@resources);
+ } else {
+ $curRes = $it->next($closeAllPages);
+ }
+ if (!$curRes) { last; }
# Maintain indentation level.
if ($curRes == $it->BEGIN_MAP() ||
@@ -1521,14 +1765,23 @@ sub render {
# Set up some data about the parts that the cols might want
my $filter = $it->{FILTER};
- my $stack = $it->getStack();
- my $src = getLinkForResource($stack);
-
+ my $src;
+ if ($args->{'sort'}) {
+ $src = $curRes->src(); # FIXME this is wrong for .pages
+ } else {
+ my $stack = $it->getStack();
+ $src=getLinkForResource($stack);
+ }
+ my $anchor='';
+ if ($src=~s/(\#.*)$//) {
+ $anchor=$1;
+ }
my $srcHasQuestion = $src =~ /\?/;
$args->{"resourceLink"} = $src.
($srcHasQuestion?'&':'?') .
- 'symb=' . &Apache::lonnet::escape($curRes->symb());
-
+ 'symb=' . &Apache::lonnet::escape($curRes->symb()).
+ $anchor;
+
# Now, display each column.
foreach my $col (@$cols) {
my $colHTML = '';
@@ -1560,13 +1813,10 @@ sub render {
$r->rflush();
}
} continue {
- $curRes = $it->next();
-
if ($r) {
# If we have the connection, make sure the user is still connected
my $c = $r->connection;
if ($c->aborted()) {
- Apache::lonnet::logthis("navmaps aborted");
# Who cares what we do, nobody will see it anyhow.
return '';
}
@@ -1581,7 +1831,12 @@ sub render {
# it's quite likely this might fix other browsers, too, and
# certainly won't hurt anything.
if ($displayedJumpMarker) {
- $result .= "\n";
+ $result .= "
+";
}
$result .= "";
@@ -1605,29 +1860,59 @@ package Apache::lonnavmaps::navmap;
=head1 Object: Apache::lonnavmaps::navmap
-You must obtain resource objects through the navmap object.
+=head2 Overview
+
+The navmap object's job is to provide access to the resources
+in the course as Apache::lonnavmaps::resource objects, and to
+query and manage the relationship between those resource objects.
+
+Generally, you'll use the navmap object in one of three basic ways.
+In order of increasing complexity and power:
-=head2 Creation
+=over 4
+
+=item * C<$navmap-EgetByX>, where X is B, B, B or B. This provides
+ various ways to obtain resource objects, based on various identifiers.
+ Use this when you want to request information about one object or
+ a handful of resources you already know the identities of, from some
+ other source. For more about Ids, Symbs, and MapPcs, see the
+ Resource documentation. Note that Url should be a B,
+ not your first choice; it only works when there is only one
+ instance of the resource in the course, which only applies to
+ maps, and even that may change in the future.
+
+=item * CretrieveResources(args)>. This
+ retrieves resources matching some criterion and returns them
+ in a flat array, with no structure information. Use this when
+ you are manipulating a series of resources, based on what map
+ the are in, but do not care about branching, or exactly how
+ the maps and resources are related. This is the most common case.
+
+=item * C<$it = $navmap-EgetIterator(args)>. This allows you traverse
+ the course's navmap in various ways without writing the traversal
+ code yourself. See iterator documentation below. Use this when
+ you need to know absolutely everything about the course, including
+ branches and the precise relationship between maps and resources.
+
+=back
+
+=head2 Creation And Destruction
+
+To create a navmap object, use the following function:
=over 4
-=item * B(navHashFile, parmHashFile, genCourseAndUserOptions,
- genMailDiscussStatus, getUserData):
+=item * Bnew>():
-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. getUserData, if true, will
-retreive the user's performance data for various problems.
+Creates a new navmap object. Returns the navmap object if this is
+successful, or B if not.
=back
+When you are done with the $navmap object, you I call
+$navmap->untieHashes(), or you'll prevent the current user from using that
+course until the web server is restarted. (!)
+
=head2 Methods
=over 4
@@ -1647,12 +1932,6 @@ sub new {
my $class = ref($proto) || $proto;
my $self = {};
- $self->{NAV_HASH_FILE} = shift;
- $self->{PARM_HASH_FILE} = shift;
- $self->{GENERATE_COURSE_USER_OPT} = shift;
- $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
- $self->{GET_USER_DATA} = shift;
-
# Resource cache stores navmap resources as we reference them. We generate
# them on-demand so we don't pay for creating resources unless we use them.
$self->{RESOURCE_CACHE} = {};
@@ -1665,12 +1944,13 @@ sub new {
my %navmaphash;
my %parmhash;
- if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
+ my $courseFn = $ENV{"request.course.fn"};
+ if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
&GDBM_READER(), 0640))) {
return undef;
}
- if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
+ if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
&GDBM_READER(), 0640)))
{
untie %{$self->{PARM_HASH}};
@@ -1679,128 +1959,145 @@ sub new {
$self->{NAV_HASH} = \%navmaphash;
$self->{PARM_HASH} = \%parmhash;
- $self->{INITED} = 0;
+ $self->{PARM_CACHE} = {};
bless($self);
return $self;
}
-sub init {
+sub generate_course_user_opt {
my $self = shift;
- if ($self->{INITED}) { return; }
+ if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
- # If the course opt hash and the user opt hash should be generated,
- # generate them
- if ($self->{GENERATE_COURSE_USER_OPT}) {
- my $uname=$ENV{'user.name'};
- my $udom=$ENV{'user.domain'};
- my $uhome=$ENV{'user.home'};
- my $cid=$ENV{'request.course.id'};
- my $chome=$ENV{'course.'.$cid.'.home'};
- my ($cdom,$cnum)=split(/\_/,$cid);
-
- my $userprefix=$uname.'_'.$udom.'_';
-
- my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
- unless ($uhome eq 'no_host') {
+ my $uname=$ENV{'user.name'};
+ my $udom=$ENV{'user.domain'};
+ my $uhome=$ENV{'user.home'};
+ my $cid=$ENV{'request.course.id'};
+ my $chome=$ENV{'course.'.$cid.'.home'};
+ my ($cdom,$cnum)=split(/\_/,$cid);
+
+ my $userprefix=$uname.'_'.$udom.'_';
+
+ my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
+ unless ($uhome eq 'no_host') {
# ------------------------------------------------- Get coursedata (if present)
- unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
- my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
- ':resourcedata',$chome);
- # Check for network failure
- if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) {
- $self->{NETWORK_FAILURE} = 1;
- } elsif ($reply!~/^error\:/) {
- $courserdatas{$cid}=$reply;
- $courserdatas{$cid.'.last_cache'}=time;
- }
- }
- foreach (split(/\&/,$courserdatas{$cid})) {
- my ($name,$value)=split(/\=/,$_);
- $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
- &Apache::lonnet::unescape($value);
- }
+ unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
+ my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
+ ':resourcedata',$chome);
+ # Check for network failure
+ if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) {
+ $self->{NETWORK_FAILURE} = 1;
+ } elsif ($reply!~/^error\:/) {
+ $courserdatas{$cid}=$reply;
+ $courserdatas{$cid.'.last_cache'}=time;
+ }
+ }
+ foreach (split(/\&/,$courserdatas{$cid})) {
+ my ($name,$value)=split(/\=/,$_);
+ $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
+ &Apache::lonnet::unescape($value);
+ }
# --------------------------------------------------- Get userdata (if present)
- unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
- my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
- if ($reply!~/^error\:/) {
- $userrdatas{$uname.'___'.$udom}=$reply;
- $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
- }
- # check to see if network failed
- elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
- {
- $self->{NETWORK_FAILURE} = 1;
- }
- }
- foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
- my ($name,$value)=split(/\=/,$_);
- $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
- &Apache::lonnet::unescape($value);
- }
- $self->{COURSE_OPT} = \%courseopt;
- $self->{USER_OPT} = \%useropt;
- }
- }
-
- if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
- my $cid=$ENV{'request.course.id'};
- my ($cdom,$cnum)=split(/\_/,$cid);
-
- my %emailstatus = &Apache::lonnet::dump('email_status');
- my $logoutTime = $emailstatus{'logout'};
- my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
- $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
- $courseLeaveTime : $logoutTime);
- my %discussiontime = &Apache::lonnet::dump('discussiontimes',
- $cdom, $cnum);
- my %feedback=();
- my %error=();
- my $keys = &Apache::lonnet::reply('keys:'.
- $ENV{'user.domain'}.':'.
- $ENV{'user.name'}.':nohist_email',
- $ENV{'user.home'});
-
- foreach my $msgid (split(/\&/, $keys)) {
- $msgid=&Apache::lonnet::unescape($msgid);
- my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
- if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
- my ($what,$url)=($1,$2);
- my %status=
- &Apache::lonnet::get('email_status',[$msgid]);
- if ($status{$msgid}=~/^error\:/) {
- $status{$msgid}='';
- }
-
- if (($status{$msgid} eq 'new') ||
- (!$status{$msgid})) {
- if ($what eq 'Error') {
- $error{$url}.=','.$msgid;
- } else {
- $feedback{$url}.=','.$msgid;
- }
- }
- }
- }
-
- $self->{FEEDBACK} = \%feedback;
- $self->{ERROR_MSG} = \%error; # what is this? JB
- $self->{DISCUSSION_TIME} = \%discussiontime;
- $self->{EMAIL_STATUS} = \%emailstatus;
-
+ unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
+ my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
+ if ($reply!~/^error\:/) {
+ $userrdatas{$uname.'___'.$udom}=$reply;
+ $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
+ }
+ # check to see if network failed
+ elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
+ {
+ $self->{NETWORK_FAILURE} = 1;
+ }
+ }
+ foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
+ my ($name,$value)=split(/\=/,$_);
+ $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
+ &Apache::lonnet::unescape($value);
+ }
+ $self->{COURSE_OPT} = \%courseopt;
+ $self->{USER_OPT} = \%useropt;
}
- if ($self->{GET_USER_DATA}) {
- # Retreive performance data on problems
- my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},
- $ENV{'user.domain'},
- $ENV{'user.name'});
- $self->{STUDENT_DATA} = \%student_data;
+ $self->{COURSE_USER_OPT_GENERATED} = 1;
+
+ return;
+}
+
+sub generate_email_discuss_status {
+ my $self = shift;
+ my $symb = shift;
+ if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
+
+ my $cid=$ENV{'request.course.id'};
+ my ($cdom,$cnum)=split(/\_/,$cid);
+
+ my %emailstatus = &Apache::lonnet::dump('email_status');
+ my $logoutTime = $emailstatus{'logout'};
+ my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
+ $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
+ $courseLeaveTime : $logoutTime);
+ my %discussiontime = &Apache::lonnet::dump('discussiontimes',
+ $cdom, $cnum);
+ my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
+ $ENV{'user.domain'},$ENV{'user.name'},'lastread');
+ my %lastreadtime = ();
+ foreach (keys %lastread) {
+ my $key = $_;
+ $key =~ s/_lastread$//;
+ $lastreadtime{$key} = $lastread{$_};
+ }
+
+ my %feedback=();
+ my %error=();
+ my $keys = &Apache::lonnet::reply('keys:'.
+ $ENV{'user.domain'}.':'.
+ $ENV{'user.name'}.':nohist_email',
+ $ENV{'user.home'});
+
+ foreach my $msgid (split(/\&/, $keys)) {
+ $msgid=&Apache::lonnet::unescape($msgid);
+ my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
+ if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
+ my ($what,$url)=($1,$2);
+ my %status=
+ &Apache::lonnet::get('email_status',[$msgid]);
+ if ($status{$msgid}=~/^error\:/) {
+ $status{$msgid}='';
+ }
+
+ if (($status{$msgid} eq 'new') ||
+ (!$status{$msgid})) {
+ if ($what eq 'Error') {
+ $error{$url}.=','.$msgid;
+ } else {
+ $feedback{$url}.=','.$msgid;
+ }
+ }
+ }
}
+
+ $self->{FEEDBACK} = \%feedback;
+ $self->{ERROR_MSG} = \%error; # what is this? JB
+ $self->{DISCUSSION_TIME} = \%discussiontime;
+ $self->{EMAIL_STATUS} = \%emailstatus;
+ $self->{LAST_READ} = \%lastreadtime;
+
+ $self->{EMAIL_DISCUSS_GENERATED} = 1;
+}
- $self->{PARM_CACHE} = {};
- $self->{INITED} = 1;
+sub get_user_data {
+ my $self = shift;
+ if ($self->{RETRIEVED_USER_DATA}) { return; }
+
+ # Retrieve performance data on problems
+ my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},
+ $ENV{'user.domain'},
+ $ENV{'user.name'});
+ $self->{STUDENT_DATA} = \%student_data;
+
+ $self->{RETRIEVED_USER_DATA} = 1;
}
# Internal function: Takes a key to look up in the nav hash and implements internal
@@ -1810,6 +2107,15 @@ sub navhash {
return $self->{NAV_HASH}->{$key};
}
+=pod
+
+=item * B(): Returns true if the course map is defined,
+ false otherwise. Undefined course maps indicate an error somewhere in
+ LON-CAPA, and you will not be able to proceed with using the navmap.
+ See the B
";
- }
+ $icon = "
is_problem() &&
!$firstDisplayed) {
- my $icon = $statusIconMap{$resource->status($part)};
+
+ my $icon = $statusIconMap{$resource->simpleStatus($part)};
my $alt = $iconAltTags{$icon};
if ($icon) {
$result .= "
New discussion since '.
+ '
New message (click to open)