|
version 1.110, 2002/11/15 20:12:11
|
version 1.163, 2003/03/20 18:38:01
|
|
Line 38
|
Line 38
|
| # YEAR=2002 |
# YEAR=2002 |
| # 1/1 Gerd Kortemeyer |
# 1/1 Gerd Kortemeyer |
| # Oct-Nov Jeremy Bowers |
# Oct-Nov Jeremy Bowers |
| |
# YEAR=2003 |
| |
# Jeremy Bowers ... lots of days |
| |
|
| package Apache::lonnavmaps; |
package Apache::lonnavmaps; |
| |
|
| use strict; |
use strict; |
| use Apache::Constants qw(:common :http); |
use Apache::Constants qw(:common :http); |
| use Apache::loncommon(); |
use Apache::loncommon(); |
| |
use Apache::lonmenu(); |
| use POSIX qw (floor strftime); |
use POSIX qw (floor strftime); |
| |
|
| |
my %navmaphash; |
| |
my %parmhash; |
| |
|
| |
# symbolic constants |
| |
sub SYMB { return 1; } |
| |
sub URL { return 2; } |
| |
sub NOTHING { return 3; } |
| |
|
| |
# Some data |
| |
|
| |
my $resObj = "Apache::lonnavmaps::resource"; |
| |
|
| |
# Keep these mappings in sync with lonquickgrades, which uses the colors |
| |
# instead of the icons. |
| |
my %statusIconMap = |
| |
( $resObj->NETWORK_FAILURE => '', |
| |
$resObj->NOTHING_SET => '', |
| |
$resObj->CORRECT => 'navmap.correct.gif', |
| |
$resObj->EXCUSED => 'navmap.correct.gif', |
| |
$resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', |
| |
$resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', |
| |
$resObj->ANSWER_OPEN => 'navmap.wrong.gif', |
| |
$resObj->OPEN_LATER => '', |
| |
$resObj->TRIES_LEFT => 'navmap.open.gif', |
| |
$resObj->INCORRECT => 'navmap.wrong.gif', |
| |
$resObj->OPEN => 'navmap.open.gif', |
| |
$resObj->ATTEMPTED => 'navmap.open.gif' ); |
| |
|
| |
my %iconAltTags = |
| |
( 'navmap.correct.gif' => 'Correct', |
| |
'navmap.wrong.gif' => 'Incorrect', |
| |
'navmap.open.gif' => 'Open' ); |
| |
|
| |
# Defines a status->color mapping, null string means don't color |
| |
my %colormap = |
| |
( $resObj->NETWORK_FAILURE => '', |
| |
$resObj->CORRECT => '', |
| |
$resObj->EXCUSED => '#3333FF', |
| |
$resObj->PAST_DUE_ANSWER_LATER => '', |
| |
$resObj->PAST_DUE_NO_ANSWER => '', |
| |
$resObj->ANSWER_OPEN => '#006600', |
| |
$resObj->OPEN_LATER => '', |
| |
$resObj->TRIES_LEFT => '', |
| |
$resObj->INCORRECT => '', |
| |
$resObj->OPEN => '', |
| |
$resObj->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 = "#FF0000"; |
| |
|
| |
sub cleanup { |
| |
if (tied(%navmaphash)){ |
| |
&Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); |
| |
unless (untie(%navmaphash)) { |
| |
&Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash'); |
| |
} |
| |
} |
| |
if (tied(%parmhash)){ |
| |
&Apache::lonnet::logthis('Cleanup navmaps: parmhash'); |
| |
unless (untie(%parmhash)) { |
| |
&Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); |
| |
} |
| |
} |
| |
} |
| |
|
| sub handler { |
sub handler { |
| my $r = shift; |
my $r = shift; |
| |
real_handler($r); |
| |
} |
| |
|
| &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
sub real_handler { |
| |
my $r = shift; |
| |
|
| # Handle header-only request |
# Handle header-only request |
| if ($r->header_only) { |
if ($r->header_only) { |
|
Line 83 sub handler {
|
Line 154 sub handler {
|
| return HTTP_NOT_ACCEPTABLE; |
return HTTP_NOT_ACCEPTABLE; |
| } |
} |
| |
|
| # Header |
$r->print("<html><head>\n"); |
| $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', |
$r->print("<title>Navigate Course Contents</title>"); |
| '')); |
# ------------------------------------------------------------ Get query string |
| $r->print('<script>window.focus();</script>'); |
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); |
| |
|
| $r->print('<table border="0" cellpadding="2" cellspacing="0">'); |
# ----------------------------------------------------- Force menu registration |
| my $date=localtime; |
my $addentries=''; |
| $r->print('<tr><td align="right" valign="bottom">Key: </td>'); |
if ($ENV{'form.register'}) { |
| |
$addentries=' onLoad="'.&Apache::lonmenu::loadevents(). |
| # Print discussions and feedback header |
'" onUnload="'.&Apache::lonmenu::unloadevents().'"'; |
| if ($navmap->{LAST_CHECK}) { |
$r->print(&Apache::lonmenu::registerurl(1)); |
| $r->print('<td align="center" valign="bottom"> '. |
|
| '<img src="/adm/lonMisc/chat.gif"> New discussion since '. |
|
| strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
|
| '</td><td align="center" valign="bottom"> '. |
|
| '<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'. |
|
| '</td>'); |
|
| } else { |
|
| $r->print('<td align="center" valign="bottom"> '. |
|
| '<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'. |
|
| ' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'. |
|
| '</td>'); |
|
| } |
|
| $r->print('</tr></table>'); |
|
| |
|
| my $condition = 0; |
|
| if ($ENV{'form.condition'}) { |
|
| $condition = 1; |
|
| } |
} |
| |
|
| my $currenturl = $ENV{'form.postdata'}; |
# Header |
| $currenturl=~s/^http\:\/\///; |
$r->print('</head>'. |
| $currenturl=~s/^[^\/]+//; |
&Apache::loncommon::bodytag('Navigate Course Contents','', |
| |
$addentries,'','',$ENV{'form.register'})); |
| # alreadyHere allows us to only open the maps necessary to view |
$r->print('<script>window.focus();</script>'); |
| # 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"; |
|
| |
|
| if ($condition) { |
|
| $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd\">Close All Folders</a>"); |
|
| } else { |
|
| $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd\">Open All Folders</a>"); |
|
| } |
|
| |
|
| $r->print('<br> '); |
|
| $r->rflush(); |
$r->rflush(); |
| |
|
| # Now that we've displayed some stuff to the user, init the navmap |
# Now that we've displayed some stuff to the user, init the navmap |
| $navmap->init(); |
$navmap->init(); |
| |
|
| |
$r->print('<br> '); |
| |
$r->rflush(); |
| |
|
| # Check that it's defined |
# Check that it's defined |
| if (!($navmap->courseMapDefined())) { |
if (!($navmap->courseMapDefined())) { |
| $r->print('<font size="+2" color="red">Coursemap undefined.</font>' . |
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' . |
|
Line 144 sub handler {
|
Line 188 sub handler {
|
| return OK; |
return OK; |
| } |
} |
| |
|
| # Grab a resource object so we have access to the constants; this |
# See if there's only one map in the top-level... if so, |
| # is technically not proper, but should be harmless |
# automatically display it |
| my $res = $navmap->firstResource(); |
my $iterator = $navmap->getIterator(undef, undef, undef, 0); |
| |
|
| # These are some data tables, which make it easy to change some of |
|
| # of the specific visualization parameters if desired. |
|
| |
|
| # Defines a status->color mapping, null string means don't color |
|
| my %colormap = |
|
| ( $res->NETWORK_FAILURE => '', |
|
| $res->CORRECT => '', |
|
| $res->EXCUSED => '#BBBBFF', |
|
| $res->PAST_DUE_ANSWER_LATER => '', |
|
| $res->PAST_DUE_NO_ANSWER => '', |
|
| $res->ANSWER_OPEN => '#CCFFCC', |
|
| $res->OPEN_LATER => '', |
|
| $res->TRIES_LEFT => '', |
|
| $res->INCORRECT => '', |
|
| $res->OPEN => '', |
|
| $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 = "#FF0000"; |
|
| |
|
| my %statusIconMap = |
|
| ( $res->NETWORK_FAILURE => '', |
|
| $res->NOTHING_SET => '', |
|
| $res->CORRECT => 'navmap.correct.gif', |
|
| $res->EXCUSED => 'navmap.correct.gif', |
|
| $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', |
|
| $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', |
|
| $res->ANSWER_OPEN => 'navmap.wrong.gif', |
|
| $res->OPEN_LATER => '', |
|
| $res->TRIES_LEFT => 'navmap.open.gif', |
|
| $res->INCORRECT => 'navmap.wrong.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, |
|
| $res->NOTHING_SET => 1, |
|
| $res->CORRECT => 1 ); |
|
| |
|
| my %filterHash; |
|
| # Figure out what we're not displaying |
|
| foreach (split(/\,/, $ENV{"form.filter"})) { |
|
| if ($_) { |
|
| $filterHash{$_} = "1"; |
|
| } |
|
| } |
|
| |
|
| # 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$|; |
|
| |
|
| # Begin the HTML table |
|
| # four cols: resource + indent, chat+feedback, icon, text string |
|
| $r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\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, \%filterHash, 1); |
|
| my $found = 0; |
|
| my $depth = 1; |
my $depth = 1; |
| my $currentUrlIndex = 0; # keeps track of when the current resource is found, |
$iterator->next(); |
| # so we can back up a few and put the anchor above the |
my $curRes = $iterator->next(); |
| # current resource |
my $sequenceCount = 0; |
| my $currentUrlDelta = 5; # change this to change how many resources are displayed |
my $sequenceId; |
| # before the current resource when using #current |
|
| $mapIterator->next(); # discard the first BEGIN_MAP |
|
| my $curRes = $mapIterator->next(); |
|
| my $counter = 0; |
|
| |
|
| while ($depth > 0) { |
while ($depth > 0) { |
| if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
| if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
if ($curRes == $iterator->END_MAP()) { $depth--; } |
| |
|
| if (ref($curRes)) { $counter++; } |
|
| |
|
| my $mapStack = $mapIterator->getStack(); |
if (ref($curRes) && $curRes->is_sequence()) { |
| if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) && |
$sequenceCount++; |
| $curRes->src() eq $currenturl) { |
$sequenceId = $curRes->map_pc(); |
| # If this is the correct resource, be sure to |
|
| # show it by making sure the containing maps |
|
| # are open. |
|
| |
|
| # This is why we have to use the main iterator instead of the |
|
| # potentially faster DFS: The count has to be the same, so |
|
| # the order has to be the same, which DFS won't give us. |
|
| $currentUrlIndex = $counter; |
|
| |
|
| # Ensure the parent maps are open |
|
| 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(); |
$curRes = $iterator->next(); |
| } |
} |
| |
|
| undef $res; # so we don't accidentally use it later |
|
| my $indentLevel = 0; |
|
| my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />"; |
|
| |
|
| 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; |
|
| |
|
| # Print the 'current' anchor here if it would fall off the top |
|
| if ($currentUrlIndex - $currentUrlDelta < 0) { |
|
| $r->print('<a name="current" />'); |
|
| } |
|
| |
|
| while ($depth > 0) { |
|
| # If this is an inlined map, cancel the shift to the right, |
|
| # which has the effect of making the map look inlined |
|
| if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 && |
|
| ref($curRes) && $curRes->is_map()) { |
|
| $deltadepth = -1; |
|
| $curRes = $mapIterator->next(); |
|
| next; |
|
| } |
|
| |
|
| if ($curRes == $mapIterator->BEGIN_MAP() || |
|
| $curRes == $mapIterator->BEGIN_BRANCH()) { |
|
| $indentLevel++; |
|
| } |
|
| if ($curRes == $mapIterator->END_MAP() || |
|
| $curRes == $mapIterator->END_BRANCH()) { |
|
| $indentLevel--; |
|
| } |
|
| 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 ignored because it is in a random-out |
|
| # map and it was not selected? |
|
| if (ref($curRes) && !advancedUser() && $curRes->randomout()) { |
|
| $curRes = $mapIterator->next(); |
|
| next; # if yes, then just ignore this resource |
|
| } |
|
| |
|
| if (ref($curRes) && $curRes->src()) { |
|
| |
|
| # Step one: Decide which parts to show |
|
| my @parts = @{$curRes->parts()}; |
|
| my $multipart = scalar(@parts) > 1; |
|
| my $condensed = 0; |
|
| |
|
| if ($curRes->is_problem()) { |
|
| |
|
| # Is it multipart? |
|
| if ($multipart) { |
|
| # If it's multipart, see if part 0 is "open" |
|
| # if it is, display all parts, if it isn't, |
|
| # just display first |
|
| if (!$curRes->opendate("0")) { |
|
| # no parts are open, display as one part |
|
| @parts = ("0"); |
|
| $condensed = 1; |
|
| } else { |
|
| # Otherwise, only display part 0 if we want to |
|
| # attach feedback or email information to it |
|
| if ($curRes->hasDiscussion() || $curRes->getFeedback()) { |
|
| shift @parts; |
|
| } else { |
|
| # Now, we decide whether to condense the |
|
| # parts due to similarity |
|
| my $status = $curRes->status($parts[1]); |
|
| my $due = $curRes->duedate($parts[1]); |
|
| my $open = $curRes->opendate($parts[1]); |
|
| my $statusAllSame = 1; |
|
| my $dueAllSame = 1; |
|
| my $openAllSame = 1; |
|
| for (my $i = 2; $i < scalar(@parts); $i++) { |
|
| if ($curRes->status($parts[$i]) != $status){ |
|
| $statusAllSame = 0; |
|
| } |
|
| if ($curRes->duedate($parts[$i]) != $due ) { |
|
| $dueAllSame = 0; |
|
| } |
|
| if ($curRes->opendate($parts[$i]) != $open) { |
|
| $openAllSame = 0; |
|
| } |
|
| } |
|
| |
|
| # $allSame is true if all the statuses were |
|
| # the same. Now, if they are all the same and |
|
| # match one of the statuses to condense, or they |
|
| # are all open with the same due date, or they are |
|
| # all OPEN_LATER with the same open date, display the |
|
| # status of the first non-zero part (to get the 'correct' |
|
| # status right, since 0 is never 'correct' or 'open'). |
|
| if (($statusAllSame && defined($condenseStatuses{$status})) || |
|
| ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| |
|
| ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ |
|
| @parts = ($parts[1]); |
|
| $condensed = 1; |
|
| } |
|
| } |
|
| } |
|
| } |
|
| |
|
| } else { |
|
| $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, and it simplifies the looping |
|
| } |
|
| |
|
| # 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. |
|
| # If this is a single part, we can at least show the correct |
|
| # status, but if it's multipart, we're lost, since we can't |
|
| # retreive the metadata to count the parts |
|
| if ($curRes->{RESOURCE_ERROR}) { |
|
| @parts = ("0"); |
|
| } |
|
| |
|
| # Step Two: Print the actual data. |
|
| |
|
| # For each part we intend to display... |
|
| foreach my $part (@parts) { |
|
| |
|
| my $deltalevel = 0; # for inserting the branch icon |
|
| my $nonLinkedText = ""; # unlinked stuff after title |
|
| |
|
| my $stack = $mapIterator->getStack(); |
|
| my $src = getLinkForResource($stack); |
|
| |
|
| # Pass the correct symb on the querystring, so the |
|
| # remote will figure out where we are if we click a link |
|
| my $srcHasQuestion = $src =~ /\?/; |
|
| my $link = $src. |
|
| ($srcHasQuestion?'&':'?') . |
|
| 'symb='.&Apache::lonnet::escape($curRes->symb()). |
|
| '"'; |
|
| |
|
| my $title = $curRes->compTitle(); |
|
| my $partLabel = ""; |
|
| my $newBranchText = ""; |
|
| |
|
| # If this is a new branch, label it so |
|
| if ($isNewBranch) { |
|
| $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">"; |
|
| $isNewBranch = 0; |
|
| $deltalevel = 1; # reserves space for the branch icon |
|
| } |
|
| |
|
| # links to open and close the folders |
|
| my $linkopen = "<a href=\"$link\">"; |
|
| my $linkclose = "</a>"; |
|
| |
|
| my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />"; |
|
| if ($curRes->is_problem()) { |
|
| if ($part eq "0" || $condensed) { |
|
| $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; |
|
| } else { |
|
| $icon = $indentString; |
|
| } |
|
| } |
|
| |
|
| # Display the correct icon, link to open or shut map |
|
| if ($curRes->is_map()) { |
|
| my $mapId = $curRes->map_pc(); |
|
| my $nowOpen = (!defined($filterHash{$mapId})); |
|
| if ($condition) {$nowOpen = !$nowOpen;} |
|
| $icon = $nowOpen ? |
|
| "navmap.folder.closed.gif" : "navmap.folder.open.gif"; |
|
| $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />"; |
|
| $linkopen = "<a href=\"/adm/navmaps?filter="; |
|
| $linkopen .= ($nowOpen xor $condition) ? |
|
| addToFilter(\%filterHash, $mapId) : |
|
| removeFromFilter(\%filterHash, $mapId); |
|
| $linkopen .= "&condition=$condition&$queryAdd\">"; |
|
| $linkclose = "</a>"; |
|
| |
|
| } |
|
| |
|
| my $colorizer = ""; |
|
| my $color; |
|
| if ($curRes->is_problem()) { |
|
| my $status = $curRes->status($part); |
|
| $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\""; |
|
| } |
|
| } |
|
| |
|
| if ($curRes->randomout()) { |
|
| $nonLinkedText .= ' <i>(hidden)</i> '; |
|
| } |
|
| |
|
| $rowNum++; |
|
| my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; |
|
| |
|
| # FIRST COL: The resource indentation, branch icon, name, and anchor |
|
| $r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\" width=\"60%\">\n"); |
|
| |
|
| # Print the anchor if necessary |
|
| if ($counter == $currentUrlIndex - $currentUrlDelta) { |
|
| $r->print('<a name="current" />'); |
|
| } |
|
| |
|
| # print indentation |
|
| for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) { |
|
| $r->print($indentString); |
|
| } |
|
| |
|
| $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); |
|
| |
|
| my $curMarkerBegin = ""; |
|
| my $curMarkerEnd = ""; |
|
| |
|
| # Is this the current resource? |
if ($sequenceCount == 1) { |
| if ($curRes->src() eq $currenturl && !$displayedHereMarker) { |
# The automatic iterator creation in the render call |
| $curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>'; |
# will pick this up. |
| $curMarkerEnd = '<font color="red" size="+2"> <</font>'; |
$ENV{'form.filter'} = "$sequenceId"; |
| $displayedHereMarker = 1; |
|
| } |
|
| |
|
| if ($curRes->is_problem() && $part ne "0" && !$condensed) { |
|
| $partLabel = " (Part $part)"; |
|
| $title = ""; |
|
| } |
|
| if ($multipart && $condensed) { |
|
| $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)'; |
|
| } |
|
| |
|
| $r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText"); |
|
| |
|
| if ($curRes->{RESOURCE_ERROR}) { |
|
| $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", |
|
| '<font size="-1">Host down</font>')); |
|
| } |
|
| |
|
| # SECOND COL: Is there text, feedback, errors?? |
|
| my $discussionHTML = ""; my $feedbackHTML = ""; |
|
| |
|
| if ($curRes->hasDiscussion()) { |
|
| $discussionHTML = $linkopen . |
|
| '<img border="0" src="/adm/lonMisc/chat.gif" />' . |
|
| $linkclose; |
|
| } |
|
| |
|
| if ($curRes->getFeedback()) { |
|
| my $feedback = $curRes->getFeedback(); |
|
| foreach (split(/\,/, $feedback)) { |
|
| if ($_) { |
|
| $feedbackHTML .= ' <a href="/adm/email?display=' |
|
| . &Apache::lonnet::escape($_) . '">' |
|
| . '<img src="/adm/lonMisc/feedback.gif" ' |
|
| . 'border="0" /></a>'; |
|
| } |
|
| } |
|
| } |
|
| |
|
| $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>"); |
|
| |
|
| # Is this the first displayed part of a multi-part problem |
|
| # that has not been condensed, so we should suppress these two |
|
| # columns so we don't display useless status info about part |
|
| # "0"? |
|
| my $firstDisplayed = !$condensed && $multipart && $part eq "0"; |
|
| |
|
| # THIRD COL: Problem status icon |
|
| if ($curRes->is_problem() && |
|
| !$firstDisplayed) { |
|
| my $icon = $statusIconMap{$curRes->status($part)}; |
|
| my $alt = $iconAltTags{$icon}; |
|
| if ($icon) { |
|
| $r->print("<td width=\"30\" valign=\"center\" width=\"50\" align=\"right\">$linkopen<img width=\"25\" height=\"25\" src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n"); |
|
| } else { |
|
| $r->print("<td width=\"30\"> </td>\n"); |
|
| } |
|
| } else { # not problem, no icon |
|
| $r->print("<td width=\"30\"> </td>\n"); |
|
| } |
|
| |
|
| # FOURTH COL: Text description |
|
| $r->print("<td align=\"right\" valign=\"center\">\n"); |
|
| |
|
| if ($curRes->kind() eq "res" && |
|
| $curRes->is_problem() && |
|
| !$firstDisplayed) { |
|
| $r->print ("<font color=\"$color\"><b>") if ($color); |
|
| $r->print (getDescription($curRes, $part)); |
|
| $r->print ("</b></font>") if ($color); |
|
| } |
|
| if ($curRes->is_map() && advancedUser() && $curRes->randompick()) { |
|
| $r->print('(randomly select ' . $curRes->randompick() .')'); |
|
| } |
|
| |
|
| $r->print(" </td></tr>\n"); |
|
| } |
|
| } |
|
| $curRes = $mapIterator->next(); |
|
| } |
} |
| |
|
| $r->print("</table></body></html>"); |
# renderer call |
| |
my $render = render({ 'cols' => [0,1,2,3], |
| |
'url' => '/adm/navmaps', |
| |
'suppressNavmap' => 1, |
| |
'r' => $r}); |
| |
|
| $navmap->untieHashes(); |
$navmap->untieHashes(); |
| |
|
| |
$r->print("</body></html>"); |
| |
$r->rflush(); |
| |
|
| return OK; |
return OK; |
| } |
} |
| |
|
|
Line 727 sub getDescription {
|
Line 333 sub getDescription {
|
| } |
} |
| } |
} |
| |
|
| |
# Convenience function, so others can use it: Is the problem due in less then |
| |
# 24 hours, and still can be done? |
| |
|
| |
sub dueInLessThen24Hours { |
| |
my $res = shift; |
| |
my $part = shift; |
| |
my $status = $res->status($part); |
| |
|
| |
return ($status == $res->OPEN() || $status == $res->ATTEMPTED() || |
| |
$status == $res->TRIES_LEFT()) && |
| |
$res->duedate() && $res->duedate() < time()+(24*60*60) && |
| |
$res->duedate() > time(); |
| |
} |
| |
|
| |
# Convenience function, so others can use it: Is there only one try remaining for the |
| |
# part, with more then one try to begin with, not due yet and still can be done? |
| |
sub lastTry { |
| |
my $res = shift; |
| |
my $part = shift; |
| |
|
| |
my $tries = $res->tries($part); |
| |
my $maxtries = $res->maxtries($part); |
| |
return $tries && $maxtries && $maxtries > 1 && |
| |
$maxtries - $tries == 1 && $res->duedate() && |
| |
$res->duedate() > time(); |
| |
} |
| |
|
| # This puts a human-readable name on the ENV variable. |
# This puts a human-readable name on the ENV variable. |
| |
# FIXME: This needs better logic: Who gets the advanced view of navmaps? |
| |
# As of 3-13-03, it's an open question. Guy doesn't want to check |
| |
# roles directly because it should be a check of capabilities for future |
| |
# role compatibity. There is no capability that matches this one for |
| |
# now, so this is done. (A hack for 1.0 might be to simply check roles |
| |
# anyhow.) |
| sub advancedUser { |
sub advancedUser { |
| return $ENV{'user.adv'}; |
return $ENV{'user.adv'}; |
| } |
} |
|
Line 838 sub timeToHumanString {
|
Line 477 sub timeToHumanString {
|
| } |
} |
| } |
} |
| |
|
| |
|
| |
=pod |
| |
|
| |
=head1 navmap renderer |
| |
|
| |
The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this. |
| |
|
| |
Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors. |
| |
|
| |
The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}). |
| |
|
| |
=head2 Overview of Columns |
| |
|
| |
The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table. |
| |
|
| |
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. |
| |
|
| |
The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist: |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash: |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links. |
| |
|
| |
=item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count. |
| |
|
| |
=item * B<resource_no_folder_link>: If true, the resource's folder will not be clickable to open or close it. Default is false. |
| |
|
| |
=back |
| |
|
| |
=item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map. |
| |
|
| |
=item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap. |
| |
|
| |
=item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap. |
| |
|
| |
=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 |
| |
|
| |
Most of these parameters are only useful if you are *not* using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically. |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like. If one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information, plus the 'iterator_map' parameter if any. |
| |
|
| |
=item * B<iterator_map>: If you are letting the renderer do the iterator handling, you can instruct the renderer to render only a particular map by passing it the source of the map you want to process, like '/res/103/jerf/navmap.course.sequence'. |
| |
|
| |
=item * B<navmap>: 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<cols>: An array reference |
| |
|
| |
=item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed. |
| |
|
| |
=item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored. |
| |
|
| |
=item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL. By default, determined through the use of the ENV{} 'jump' information, and should normally "just work" correctly. |
| |
|
| |
=item * B<here>: A Symb identifying where to place the 'here' marker. Default empty, which means no marker. |
| |
|
| |
=item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. |
| |
|
| |
=item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed. |
| |
|
| |
=item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown. |
| |
|
| |
=item * B<currentJumpIndex>: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}. |
| |
|
| |
=item * B<r>: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself. |
| |
|
| |
=item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false. |
| |
|
| |
=item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true. |
| |
|
| |
=item * B<filterFunc>: 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. By default, all resources are shown. |
| |
|
| |
=item * B<suppressNavmaps>: If true, will not display Navigate Content resources. Default to false. |
| |
|
| |
=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: |
| |
|
| |
If you want to know how many rows were printed, the 'counter' element of the hash passed into the render function will contain the count. You may want to check whether any resources were printed at all. |
| |
|
| |
=over 4 |
| |
|
| |
=back |
| |
|
| |
=cut |
| |
|
| |
sub resource { return 0; } |
| |
sub communication_status { return 1; } |
| |
sub quick_status { return 2; } |
| |
sub long_status { return 3; } |
| |
|
| |
# Data for render_resource |
| |
|
| |
sub render_resource { |
| |
my ($resource, $part, $params) = @_; |
| |
|
| |
my $nonLinkedText = ''; # stuff after resource title not in link |
| |
|
| |
my $link = $params->{"resourceLink"}; |
| |
my $src = $resource->src(); |
| |
my $it = $params->{"iterator"}; |
| |
my $filter = $it->{FILTER}; |
| |
|
| |
my $title = $resource->compTitle(); |
| |
if ($src =~ /^\/uploaded\//) { |
| |
$nonLinkedText=$title; |
| |
$title = ''; |
| |
} |
| |
my $partLabel = ""; |
| |
my $newBranchText = ""; |
| |
|
| |
# If this is a new branch, label it so |
| |
if ($params->{'isNewBranch'}) { |
| |
$newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />"; |
| |
} |
| |
|
| |
# links to open and close the folder |
| |
my $linkopen = "<a href='$link'>"; |
| |
my $linkclose = "</a>"; |
| |
|
| |
# Default icon: HTML page |
| |
my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />"; |
| |
|
| |
if ($resource->is_problem()) { |
| |
if ($part eq "" || $params->{'condensed'}) { |
| |
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />'; |
| |
} else { |
| |
$icon = $params->{'indentString'}; |
| |
} |
| |
} |
| |
|
| |
# Display the correct map icon to open or shut map |
| |
if ($resource->is_map()) { |
| |
my $mapId = $resource->map_pc(); |
| |
my $nowOpen = !defined($filter->{$mapId}); |
| |
if ($it->{CONDITION}) { |
| |
$nowOpen = !$nowOpen; |
| |
} |
| |
|
| |
if (!$params->{'resource_no_folder_link'}) { |
| |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; |
| |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
| |
|
| |
$linkopen = "<a href='" . $params->{'url'} . '?' . |
| |
$params->{'queryString'} . '&filter='; |
| |
$linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
| |
addToFilter($filter, $mapId) : |
| |
removeFromFilter($filter, $mapId); |
| |
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
| |
. $params->{'hereType'} . '&here=' . |
| |
&Apache::lonnet::escape($params->{'here'}) . |
| |
'&jump=' . |
| |
&Apache::lonnet::escape($resource->symb()) . |
| |
"&folderManip=1'>"; |
| |
} else { |
| |
# Don't allow users to manipulate folder |
| |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . |
| |
'.nomanip.gif'; |
| |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
| |
|
| |
$linkopen = ""; |
| |
$linkclose = ""; |
| |
} |
| |
} |
| |
|
| |
if ($resource->randomout()) { |
| |
$nonLinkedText .= ' <i>(hidden)</i> '; |
| |
} |
| |
|
| |
# We're done preparing and finally ready to start the rendering |
| |
my $result = "<td align='left' valign='center'>"; |
| |
|
| |
my $indentLevel = $params->{'indentLevel'}; |
| |
if ($newBranchText) { $indentLevel--; } |
| |
|
| |
# print indentation |
| |
for (my $i = 0; $i < $indentLevel; $i++) { |
| |
$result .= $params->{'indentString'}; |
| |
} |
| |
|
| |
# Decide what to display |
| |
$result .= "$newBranchText$linkopen$icon$linkclose"; |
| |
|
| |
my $curMarkerBegin = ''; |
| |
my $curMarkerEnd = ''; |
| |
|
| |
# Is this the current resource? |
| |
if (!$params->{'displayedHereMarker'} && |
| |
$resource->symb() eq $params->{'here'} ) { |
| |
$curMarkerBegin = '<font color="red" size="+2">> </font>'; |
| |
$curMarkerEnd = '<font color="red" size="+2"><</font>'; |
| |
$params->{'displayedHereMarker'} = 1; |
| |
} |
| |
|
| |
if ($resource->is_problem() && $part ne "" && |
| |
!$params->{'condensed'}) { |
| |
$partLabel = " (Part $part)"; |
| |
$title = ""; |
| |
} |
| |
|
| |
if ($params->{'condensed'} && $resource->countParts() > 1) { |
| |
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; |
| |
} |
| |
|
| |
if (!$params->{'resource_nolink'}) { |
| |
$result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>"; |
| |
} else { |
| |
$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>"; |
| |
} |
| |
|
| |
return $result; |
| |
} |
| |
|
| |
sub render_communication_status { |
| |
my ($resource, $part, $params) = @_; |
| |
my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; |
| |
|
| |
my $link = $params->{"resourceLink"}; |
| |
my $linkopen = "<a href='$link'>"; |
| |
my $linkclose = "</a>"; |
| |
|
| |
if ($resource->hasDiscussion()) { |
| |
$discussionHTML = $linkopen . |
| |
'<img border="0" src="/adm/lonMisc/chat.gif" />' . |
| |
$linkclose; |
| |
} |
| |
|
| |
if ($resource->getFeedback()) { |
| |
my $feedback = $resource->getFeedback(); |
| |
foreach (split(/\,/, $feedback)) { |
| |
if ($_) { |
| |
$feedbackHTML .= ' <a href="/adm/email?display=' |
| |
. &Apache::lonnet::escape($_) . '">' |
| |
. '<img src="/adm/lonMisc/feedback.gif" ' |
| |
. 'border="0" /></a>'; |
| |
} |
| |
} |
| |
} |
| |
|
| |
if ($resource->getErrors()) { |
| |
my $errors = $resource->getErrors(); |
| |
foreach (split(/,/, $errors)) { |
| |
if ($_) { |
| |
$errorHTML .= ' <a href="/adm/email?display=' |
| |
. &Apache::lonnet::escape($_) . '">' |
| |
. '<img src="/adm/lonMisc/bomb.gif" ' |
| |
. 'border="0" /></a>'; |
| |
} |
| |
} |
| |
} |
| |
|
| |
return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>"; |
| |
|
| |
} |
| |
sub render_quick_status { |
| |
my ($resource, $part, $params) = @_; |
| |
my $result = ""; |
| |
my $firstDisplayed = !$params->{'condensed'} && |
| |
$params->{'multipart'} && $part eq "0"; |
| |
|
| |
my $link = $params->{"resourceLink"}; |
| |
my $linkopen = "<a href='$link'>"; |
| |
my $linkclose = "</a>"; |
| |
|
| |
if ($resource->is_problem() && |
| |
!$firstDisplayed) { |
| |
my $icon = $statusIconMap{$resource->status($part)}; |
| |
my $alt = $iconAltTags{$icon}; |
| |
if ($icon) { |
| |
$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n"; |
| |
} else { |
| |
$result .= "<td width='30'> </td>\n"; |
| |
} |
| |
} else { # not problem, no icon |
| |
$result .= "<td width='30'> </td>\n"; |
| |
} |
| |
|
| |
return $result; |
| |
} |
| |
sub render_long_status { |
| |
my ($resource, $part, $params) = @_; |
| |
my $result = "<td align='right' valign='center'>\n"; |
| |
my $firstDisplayed = !$params->{'condensed'} && |
| |
$params->{'multipart'} && $part eq "0"; |
| |
|
| |
my $color; |
| |
if ($resource->is_problem()) { |
| |
$color = $colormap{$resource->status}; |
| |
|
| |
if (dueInLessThen24Hours($resource, $part) || |
| |
lastTry($resource, $part)) { |
| |
$color = $hurryUpColor; |
| |
} |
| |
} |
| |
|
| |
if ($resource->kind() eq "res" && |
| |
$resource->is_problem() && |
| |
!$firstDisplayed) { |
| |
if ($color) {$result .= "<font color=\"$color\"><b>"; } |
| |
$result .= getDescription($resource, $part); |
| |
if ($color) {$result .= "</b></font>"; } |
| |
} |
| |
if ($resource->is_map() && advancedUser() && $resource->randompick()) { |
| |
$result .= '(randomly select ' . $resource->randompick() .')'; |
| |
} |
| |
|
| |
$result .= " </td>\n"; |
| |
|
| |
return $result; |
| |
} |
| |
|
| |
my @preparedColumns = (\&render_resource, \&render_communication_status, |
| |
\&render_quick_status, \&render_long_status); |
| |
|
| |
sub setDefault { |
| |
my ($val, $default) = @_; |
| |
if (!defined($val)) { return $default; } |
| |
return $val; |
| |
} |
| |
|
| |
sub render { |
| |
my $args = shift; |
| |
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
| |
my $result = ''; |
| |
|
| |
# Configure the renderer. |
| |
my $cols = $args->{'cols'}; |
| |
if (!defined($cols)) { |
| |
# no columns, no nav maps. |
| |
return ''; |
| |
} |
| |
my $mustCloseNavMap = 0; |
| |
my $navmap; |
| |
if (defined($args->{'navmap'})) { |
| |
$navmap = $args->{'navmap'}; |
| |
} |
| |
|
| |
my $r = $args->{'r'}; |
| |
my $queryString = $args->{'queryString'}; |
| |
my $jump = $args->{'jump'}; |
| |
my $here = $args->{'here'}; |
| |
my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0); |
| |
my $currentJumpDelta = 2; # change this to change how many resources are displayed |
| |
# before the current resource when using #current |
| |
|
| |
# If we were passed 'here' information, we are not rendering |
| |
# after a folder manipulation, and we were not passed an |
| |
# iterator, make sure we open the folders to show the "here" |
| |
# marker |
| |
my $filterHash = {}; |
| |
# Figure out what we're not displaying |
| |
foreach (split(/\,/, $ENV{"form.filter"})) { |
| |
if ($_) { |
| |
$filterHash->{$_} = "1"; |
| |
} |
| |
} |
| |
|
| |
my $condition = 0; |
| |
if ($ENV{'form.condition'}) { |
| |
$condition = 1; |
| |
} |
| |
|
| |
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); |
| |
$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. |
| |
|
| |
if ($ENV{'form.symb'}) { |
| |
$here = $jump = $ENV{'form.symb'}; |
| |
} elsif ($ENV{'form.postdata'}) { |
| |
# couldn't find a symb, is there a URL? |
| |
my $currenturl = $ENV{'form.postdata'}; |
| |
#$currenturl=~s/^http\:\/\///; |
| |
#$currenturl=~s/^[^\/]+//; |
| |
|
| |
$here = $jump = &Apache::lonnet::symbread($currenturl); |
| |
} |
| |
|
| |
# 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 $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--; } |
| |
|
| |
if (ref($curRes) && $curRes->symb() eq $here) { |
| |
my $mapStack = $mapIterator->getStack(); |
| |
|
| |
# Ensure the parent maps are open |
| |
for my $map (@{$mapStack}) { |
| |
if ($condition) { |
| |
undef $filterHash->{$map->map_pc()}; |
| |
} else { |
| |
$filterHash->{$map->map_pc()} = 1; |
| |
} |
| |
} |
| |
$found = 1; |
| |
} |
| |
|
| |
$curRes = $mapIterator->next(); |
| |
} |
| |
} |
| |
|
| |
if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page |
| |
# If this is a click on a folder or something, we want to preserve the "here" |
| |
# from the querystring, and get the new "jump" marker |
| |
$here = $ENV{'form.here'}; |
| |
$jump = $ENV{'form.jump'}; |
| |
} |
| |
|
| |
my $it = $args->{'iterator'}; |
| |
if (!defined($it)) { |
| |
# Construct a default iterator based on $ENV{'form.'} information |
| |
|
| |
# 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); |
| |
$mustCloseNavMap = 1; |
| |
} |
| |
# Paranoia: Make sure it's ready |
| |
$navmap->init(); |
| |
|
| |
# See if we're being passed a specific map |
| |
if ($args->{'iterator_map'}) { |
| |
my $map = $args->{'iterator_map'}; |
| |
$map = $navmap->getResourceByUrl($map); |
| |
my $firstResource = $map->map_start(); |
| |
my $finishResource = $map->map_finish(); |
| |
|
| |
$args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition); |
| |
} else { |
| |
$args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition); |
| |
} |
| |
} |
| |
|
| |
# (re-)Locate the jump point, if any |
| |
my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); |
| |
my $depth = 1; |
| |
$mapIterator->next(); |
| |
my $curRes = $mapIterator->next(); |
| |
my $foundJump = 0; |
| |
my $counter = 0; |
| |
|
| |
while ($depth > 0 && !$foundJump) { |
| |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
| |
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
| |
if (ref($curRes)) { $counter++; } |
| |
|
| |
if (ref($curRes) && $jump eq $curRes->symb()) { |
| |
|
| |
# This is why we have to use the main iterator instead of the |
| |
# potentially faster DFS: The count has to be the same, so |
| |
# the order has to be the same, which DFS won't give us. |
| |
$args->{'currentJumpIndex'} = $counter; |
| |
$foundJump = 1; |
| |
} |
| |
|
| |
$curRes = $mapIterator->next(); |
| |
} |
| |
|
| |
my $showParts = setDefault($args->{'showParts'}, 1); |
| |
my $condenseParts = setDefault($args->{'condenseParts'}, 1); |
| |
# keeps track of when the current resource is found, |
| |
# so we can back up a few and put the anchor above the |
| |
# current resource |
| |
my $printKey = $args->{'printKey'}; |
| |
my $printCloseAll = $args->{'printCloseAll'}; |
| |
if (!defined($printCloseAll)) { $printCloseAll = 1; } |
| |
my $filterFunc = setDefault($args->{'filterFunc'}, |
| |
sub {return 1;}); |
| |
|
| |
# Print key? |
| |
if ($printKey) { |
| |
$result .= '<table border="0" cellpadding="2" cellspacing="0">'; |
| |
my $date=localtime; |
| |
$result.='<tr><td align="right" valign="bottom">Key: </td>'; |
| |
if ($navmap->{LAST_CHECK}) { |
| |
$result .= |
| |
'<img src="/adm/lonMisc/chat.gif"> New discussion since '. |
| |
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
| |
'</td><td align="center" valign="bottom"> '. |
| |
'<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'. |
| |
'</td>'; |
| |
} else { |
| |
$result .= '<td align="center" valign="bottom"> '. |
| |
'<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'. |
| |
' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'. |
| |
'</td>'; |
| |
} |
| |
|
| |
$result .= '</tr></table>'; |
| |
} |
| |
|
| |
if ($printCloseAll) { |
| |
if ($condition) { |
| |
$result.="<a href=\"navmaps?condition=0&filter=&$queryString" . |
| |
"&here=" . Apache::lonnet::escape($here) . |
| |
"\">Close All Folders</a>"; |
| |
} else { |
| |
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" . |
| |
"&here=" . Apache::lonnet::escape($here) . |
| |
"\">Open All Folders</a>"; |
| |
} |
| |
$result .= "<br /><br />\n"; |
| |
} |
| |
|
| |
if ($r) { |
| |
$r->print($result); |
| |
$r->rflush(); |
| |
$result = ""; |
| |
} |
| |
# End parameter setting |
| |
|
| |
# Data |
| |
$result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"; |
| |
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; |
| |
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />"); |
| |
$args->{'displayedHereMarker'} = 0; |
| |
|
| |
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; |
| |
|
| |
# export "here" marker information |
| |
$args->{'here'} = $here; |
| |
|
| |
while ($depth > 0) { |
| |
if ($curRes == $it->BEGIN_MAP()) { $depth++; } |
| |
if ($curRes == $it->END_MAP()) { $depth--; } |
| |
|
| |
# Maintain indentation level. |
| |
if ($curRes == $it->BEGIN_MAP() || |
| |
$curRes == $it->BEGIN_BRANCH() ) { |
| |
$args->{'indentLevel'}++; |
| |
} |
| |
if ($curRes == $it->END_MAP() || |
| |
$curRes == $it->END_BRANCH() ) { |
| |
$args->{'indentLevel'}--; |
| |
} |
| |
# Notice new branches |
| |
if ($curRes == $it->BEGIN_BRANCH()) { |
| |
$args->{'isNewBranch'} = 1; |
| |
} |
| |
|
| |
# If this isn't an actual resource, continue on |
| |
if (!ref($curRes)) { |
| |
next; |
| |
} |
| |
|
| |
$args->{'counter'}++; |
| |
|
| |
# If this has been filtered out, continue on |
| |
if (!(&$filterFunc($curRes))) { |
| |
$args->{'isNewBranch'} = 0; # Don't falsely remember this |
| |
next; |
| |
} |
| |
|
| |
# If we're suppressing navmaps and this is a navmap, continue on |
| |
if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) { |
| |
next; |
| |
} |
| |
|
| |
# Does it have multiple parts? |
| |
$args->{'multipart'} = 0; |
| |
$args->{'condensed'} = 0; |
| |
my @parts; |
| |
|
| |
# Decide what parts to show. |
| |
if ($curRes->is_problem() && $showParts) { |
| |
@parts = @{$curRes->parts()}; |
| |
$args->{'multipart'} = scalar(@parts) > 1; |
| |
|
| |
if ($condenseParts) { # do the condensation |
| |
if (!$curRes->opendate("0")) { |
| |
@parts = (); |
| |
$args->{'condensed'} = 1; |
| |
} |
| |
if (!$args->{'condensed'}) { |
| |
# Decide whether to condense based on similarity |
| |
my $status = $curRes->status($parts[1]); |
| |
my $due = $curRes->duedate($parts[1]); |
| |
my $open = $curRes->opendate($parts[1]); |
| |
my $statusAllSame = 1; |
| |
my $dueAllSame = 1; |
| |
my $openAllSame = 1; |
| |
for (my $i = 2; $i < scalar(@parts); $i++) { |
| |
if ($curRes->status($parts[$i]) != $status){ |
| |
$statusAllSame = 0; |
| |
} |
| |
if ($curRes->duedate($parts[$i]) != $due ) { |
| |
$dueAllSame = 0; |
| |
} |
| |
if ($curRes->opendate($parts[$i]) != $open) { |
| |
$openAllSame = 0; |
| |
} |
| |
} |
| |
# $*allSame is true if all the statuses were |
| |
# the same. Now, if they are all the same and |
| |
# match one of the statuses to condense, or they |
| |
# are all open with the same due date, or they are |
| |
# all OPEN_LATER with the same open date, display the |
| |
# status of the first non-zero part (to get the 'correct' |
| |
# status right, since 0 is never 'correct' or 'open'). |
| |
if (($statusAllSame && defined($condenseStatuses{$status})) || |
| |
($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| |
| |
($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ |
| |
@parts = (); |
| |
$args->{'condensed'} = 1; |
| |
} |
| |
|
| |
} |
| |
} |
| |
} |
| |
|
| |
# If the multipart problem was condensed, "forget" it was multipart |
| |
if (scalar(@parts) == 1) { |
| |
$args->{'multipart'} = 0; |
| |
} |
| |
|
| |
# Now, we've decided what parts to show. Loop through them and |
| |
# show them. |
| |
foreach my $part ('', @parts) { |
| |
if ($part eq '0') { |
| |
next; |
| |
} |
| |
$rownum ++; |
| |
my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)]; |
| |
|
| |
$result .= " <tr bgcolor='$backgroundColor'>\n"; |
| |
|
| |
# 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 $srcHasQuestion = $src =~ /\?/; |
| |
$args->{"resourceLink"} = $src. |
| |
($srcHasQuestion?'&':'?') . |
| |
'symb=' . &Apache::lonnet::escape($curRes->symb()); |
| |
|
| |
# Now, display each column. |
| |
foreach my $col (@$cols) { |
| |
my $colHTML = ''; |
| |
if (ref($col)) { |
| |
$colHTML .= &$col($curRes, $part, $args); |
| |
} else { |
| |
$colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args); |
| |
} |
| |
|
| |
# If this is the first column and it's time to print |
| |
# the anchor, do so |
| |
if ($col == $cols->[0] && |
| |
$args->{'counter'} == $args->{'currentJumpIndex'} - |
| |
$currentJumpDelta) { |
| |
# Jam the anchor after the <td> tag; |
| |
# necessary for valid HTML (which Mozilla requires) |
| |
$colHTML =~ s/\>/\>\<a name="curloc" \/\>/; |
| |
$displayedJumpMarker = 1; |
| |
} |
| |
$result .= $colHTML . "\n"; |
| |
} |
| |
$result .= " </tr>\n"; |
| |
$args->{'isNewBranch'} = 0; |
| |
} |
| |
|
| |
if ($r && $rownum % 20 == 0) { |
| |
$r->print($result); |
| |
$result = ""; |
| |
$r->rflush(); |
| |
} |
| |
} continue { |
| |
$curRes = $it->next(); |
| |
} |
| |
|
| |
# Print out the part that jumps to #curloc if it exists |
| |
# delay needed because the browser is processing the jump before |
| |
# it finishes rendering, so it goes to the wrong place! |
| |
# onload might be better, but this routine has no access to that. |
| |
# On mozilla, the 0-millisecond timeout seems to prevent this; |
| |
# it's quite likely this might fix other browsers, too, and |
| |
# certainly won't hurt anything. |
| |
if ($displayedJumpMarker) { |
| |
$result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n"; |
| |
} |
| |
|
| |
$result .= "</table>"; |
| |
|
| |
if ($r) { |
| |
$r->print($result); |
| |
$result = ""; |
| |
$r->rflush(); |
| |
} |
| |
|
| |
if ($mustCloseNavMap) { $navmap->untieHashes(); } |
| |
|
| |
return $result; |
| |
} |
| |
|
| 1; |
1; |
| |
|
| package Apache::lonnavmaps::navmap; |
package Apache::lonnavmaps::navmap; |
| |
|
| =pod |
=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. |
lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere. |
| |
|
| =head1 navmap object: Encapsulating the compiled nav map |
=head1 navmap object: Encapsulating the compiled nav map |
| |
|
|
Line 887 sub new {
|
Line 1280 sub new {
|
| $self->{NETWORK_FAILURE} = 0; |
$self->{NETWORK_FAILURE} = 0; |
| |
|
| # tie the nav hash |
# tie the nav hash |
| my %navmaphash; |
|
| if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
| &GDBM_READER(), 0640))) { |
&GDBM_READER(), 0640))) { |
| return undef; |
return undef; |
| } |
} |
| $self->{NAV_HASH} = \%navmaphash; |
|
| |
|
| my %parmhash; |
|
| if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
| &GDBM_READER(), 0640))) |
&GDBM_READER(), 0640))) |
| { |
{ |
| untie $self->{PARM_HASH}; |
untie $self->{PARM_HASH}; |
| return undef; |
return undef; |
| } |
} |
| $self->{PARM_HASH} = \%parmhash; |
|
| $self->{HASH_TIED} = 1; |
$self->{HASH_TIED} = 1; |
| |
$self->{NAV_HASH} = \%navmaphash; |
| |
$self->{PARM_HASH} = \%parmhash; |
| |
$self->{INITED} = 0; |
| |
|
| bless($self); |
bless($self); |
| |
|
|
Line 911 sub new {
|
Line 1305 sub new {
|
| |
|
| sub init { |
sub init { |
| my $self = shift; |
my $self = shift; |
| |
if ($self->{INITED}) { return; } |
| |
|
| # If the course opt hash and the user opt hash should be generated, |
# If the course opt hash and the user opt hash should be generated, |
| # generate them |
# generate them |
|
Line 975 sub init {
|
Line 1370 sub init {
|
| my %emailstatus = &Apache::lonnet::dump('email_status'); |
my %emailstatus = &Apache::lonnet::dump('email_status'); |
| my $logoutTime = $emailstatus{'logout'}; |
my $logoutTime = $emailstatus{'logout'}; |
| my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
| $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? |
$self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ? |
| $courseLeaveTime : $logoutTime); |
$courseLeaveTime : $logoutTime); |
| my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
| $cdom, $cnum); |
$cdom, $cnum); |
|
Line 1016 sub init {
|
Line 1411 sub init {
|
| } |
} |
| |
|
| $self->{PARM_CACHE} = {}; |
$self->{PARM_CACHE} = {}; |
| |
$self->{INITED} = 1; |
| |
} |
| |
|
| |
# Internal function: Takes a key to look up in the nav hash and implements internal |
| |
# memory caching of that key. |
| |
sub navhash { |
| |
my $self = shift; my $key = shift; |
| |
return $self->{NAV_HASH}->{$key}; |
| } |
} |
| |
|
| # Checks to see if coursemap is defined, matching test in old lonnavmaps |
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
|
Line 1023 sub courseMapDefined {
|
Line 1426 sub courseMapDefined {
|
| my $self = shift; |
my $self = shift; |
| my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
| |
|
| my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; |
my $firstres = $self->navhash("map_start_$uri"); |
| my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; |
my $lastres = $self->navhash("map_finish_$uri"); |
| return $firstres && $lastres; |
return $firstres && $lastres; |
| } |
} |
| |
|
|
Line 1049 sub DESTROY {
|
Line 1452 sub DESTROY {
|
| $self->untieHashes(); |
$self->untieHashes(); |
| } |
} |
| |
|
| # Private function: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
| # current discussion? Returns 0 if chat/mail data not extracted. |
# current discussion? Returns 0 if chat/mail data not extracted. |
| sub hasDiscussion { |
sub hasDiscussion { |
| my $self = shift; |
my $self = shift; |
| my $symb = shift; |
my $symb = shift; |
| if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
| |
|
| |
#return defined($self->{DISCUSSION_TIME}->{$symb}); |
| return $self->{DISCUSSION_TIME}->{$symb} > |
return $self->{DISCUSSION_TIME}->{$symb} > |
| $self->{LAST_CHECK}; |
$self->{LAST_CHECK}; |
| } |
} |
| |
|
| # Private function: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
| # current feedback? Returns the string in the feedback hash, which |
# current feedback? Returns the string in the feedback hash, which |
| # will be false if it does not exist. |
# will be false if it does not exist. |
| sub getFeedback { |
sub getFeedback { |
|
Line 1072 sub getFeedback {
|
Line 1476 sub getFeedback {
|
| return $self->{FEEDBACK}->{$symb}; |
return $self->{FEEDBACK}->{$symb}; |
| } |
} |
| |
|
| |
# Private method: Get the errors for that resource (by source). |
| |
sub getErrors { |
| |
my $self = shift; |
| |
my $src = shift; |
| |
|
| |
if (!defined($self->{ERROR_MSG})) { return ""; } |
| |
return $self->{ERROR_MSG}->{$src}; |
| |
} |
| |
|
| =pod |
=pod |
| |
|
| =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object. |
=item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object. |
|
Line 1093 sub getById {
|
Line 1506 sub getById {
|
| } |
} |
| |
|
| # resource handles inserting itself into cache. |
# resource handles inserting itself into cache. |
| return Apache::lonnavmaps::resource->new($self, $id); |
# Not clear why the quotes are necessary, but as of this |
| |
# writing it doesn't work without them. |
| |
return "Apache::lonnavmaps::resource"->new($self, $id); |
| } |
} |
| |
|
| =pod |
=pod |
|
Line 1104 sub getById {
|
Line 1519 sub getById {
|
| |
|
| sub firstResource { |
sub firstResource { |
| my $self = shift; |
my $self = shift; |
| my $firstResource = $self->{NAV_HASH}->{'map_start_' . |
my $firstResource = $self->navhash('map_start_' . |
| &Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
| return $self->getById($firstResource); |
return $self->getById($firstResource); |
| } |
} |
| |
|
|
Line 1117 sub firstResource {
|
Line 1532 sub firstResource {
|
| |
|
| sub finishResource { |
sub finishResource { |
| my $self = shift; |
my $self = shift; |
| my $firstResource = $self->{NAV_HASH}->{'map_finish_' . |
my $firstResource = $self->navhash('map_finish_' . |
| &Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
| return $self->getById($firstResource); |
return $self->getById($firstResource); |
| } |
} |
| |
|
|
Line 1208 sub parmval_real {
|
Line 1623 sub parmval_real {
|
| my ($space,@qualifier)=split(/\./,$rwhat); |
my ($space,@qualifier)=split(/\./,$rwhat); |
| my $qualifier=join('.',@qualifier); |
my $qualifier=join('.',@qualifier); |
| unless ($space eq '0') { |
unless ($space eq '0') { |
| my ($part,$id)=split(/\_/,$space); |
my @parts=split(/_/,$space); |
| if ($id) { |
my $id=pop(@parts); |
| my $partgeneral=$self->parmval($part.".$qualifier",$symb); |
my $part=join('_',@parts); |
| if (defined($partgeneral)) { return $partgeneral; } |
if ($part eq '') { $part='0'; } |
| } else { |
my $partgeneral=$self->parmval($part.".$qualifier",$symb); |
| my $resourcegeneral=$self->parmval("0.$qualifier",$symb); |
if (defined($partgeneral)) { return $partgeneral; } |
| if (defined($resourcegeneral)) { return $resourcegeneral; } |
|
| } |
|
| } |
} |
| return ''; |
return ''; |
| } |
} |
| |
|
| |
=pod |
| |
|
| |
=item * B<getResourceByUrl>(url): Retrieves a resource object by URL of the resource. If passed a resource object, it will simply return it, so it is safe to use this method in code like "$res = $navmap->getResourceByUrl($res)", if you're not sure if $res is already an object, or just a URL. If the resource appears multiple times in the course, only the first instance will be returned. As a result, this is probably useful only for maps. |
| |
|
| |
=item * B<retrieveResources>(map, filterFunc, recursive, bailout): The map is a specification of a map to retreive the resources from, either as a url or as an object. The filterFunc is a reference to a function that takes a resource object as its one argument and returns true if the resource should be included, or false if it should not be. If recursive is true, the map will be recursively examined, otherwise it will not be. If bailout is true, the function will return as soon as it finds a resource, if false it will finish. By default, the map is the top-level map of the course, filterFunc is a function that always returns 1, recursive is true, bailout is false. The resources will be returned in a list reference containing the resource objects for the corresponding resources, with B<no structure information> in the list; regardless of branching, recursion, etc., it will be a flat list. |
| |
|
| |
Thus, this is suitable for cases where you don't want the structure, just a list of all resources. It is also suitable for finding out how many resources match a given description; for this use, if all you want to know is if I<any> resources match the description, the bailout parameter will allow you to avoid potentially expensive enumeration of all matching resources. |
| |
|
| |
=item * B<hasResources>(map, filterFunc, recursive): Convience method for |
| |
|
| |
scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0 |
| |
|
| |
which will tell whether the map has resources matching the description in the filter function. |
| |
|
| |
=cut |
| |
|
| |
sub getResourceByUrl { |
| |
my $self = shift; |
| |
my $resUrl = shift; |
| |
|
| |
if (ref($resUrl)) { return $resUrl; } |
| |
|
| |
$resUrl = &Apache::lonnet::clutter($resUrl); |
| |
my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl}; |
| |
if ($resId =~ /,/) { |
| |
$resId = (split (/,/, $resId))[0]; |
| |
} |
| |
if (!$resId) { return ''; } |
| |
return $self->getById($resId); |
| |
} |
| |
|
| |
sub retrieveResources { |
| |
my $self = shift; |
| |
my $map = shift; |
| |
my $filterFunc = shift; |
| |
if (!defined ($filterFunc)) { |
| |
$filterFunc = sub {return 1;}; |
| |
} |
| |
my $recursive = shift; |
| |
if (!defined($recursive)) { $recursive = 1; } |
| |
my $bailout = shift; |
| |
if (!defined($bailout)) { $bailout = 0; } |
| |
|
| |
# Create the necessary iterator. |
| |
if (!ref($map)) { # assume it's a url of a map. |
| |
$map = $self->getMapByUrl($map); |
| |
} |
| |
|
| |
# Check the map's validity. |
| |
if (!$map || !$map->is_map()) { |
| |
# Oh, to throw an exception.... how I'd love that! |
| |
return (); |
| |
} |
| |
|
| |
# Get an iterator. |
| |
my $it = $self->getIterator($map->map_start(), $map->map_finish(), |
| |
!$recursive); |
| |
|
| |
my @resources = (); |
| |
|
| |
# Run down the iterator and collect the resources. |
| |
my $depth = 1; |
| |
$it->next(); |
| |
my $curRes = $it->next(); |
| |
|
| |
while ($depth > 0) { |
| |
if ($curRes == $it->BEGIN_MAP()) { |
| |
$depth++; |
| |
} |
| |
if ($curRes == $it->END_MAP()) { |
| |
$depth--; |
| |
} |
| |
|
| |
if (ref($curRes)) { |
| |
if (!&$filterFunc($curRes)) { |
| |
next; |
| |
} |
| |
|
| |
push @resources, $curRes; |
| |
|
| |
if ($bailout) { |
| |
return @resources; |
| |
} |
| |
} |
| |
|
| |
$curRes = $it->next(); |
| |
} |
| |
|
| |
return @resources; |
| |
} |
| |
|
| |
sub hasResource { |
| |
my $self = shift; |
| |
my $map = shift; |
| |
my $filterFunc = shift; |
| |
my $recursive = shift; |
| |
|
| |
return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0; |
| |
} |
| |
|
| 1; |
1; |
| |
|
|
Line 1245 getIterator behaves as follows:
|
Line 1757 getIterator behaves as follows:
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getIterator>(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. |
=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content. returnTopMap, if true (default false), will cause the iterator to return the top-level map object (resource 0.0) before anything else. |
| |
|
| Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples. |
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. |
| |
|
|
Line 1265 The iterator will return either a refere
|
Line 1777 The iterator will return either a refere
|
| |
|
| The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. |
The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. |
| |
|
| |
Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned. |
| |
|
| =back |
=back |
| |
|
| =cut |
=cut |
|
Line 1315 sub new {
|
Line 1829 sub new {
|
| if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
| $self->{CONDITION} = shift; |
$self->{CONDITION} = shift; |
| |
|
| |
# Do we want to automatically follow "redirection" maps? |
| |
$self->{FORCE_TOP} = shift; |
| |
|
| |
# Do we want to return the top-level map object (resource 0.0)? |
| |
$self->{RETURN_0} = shift; |
| |
# have we done that yet? |
| |
$self->{HAVE_RETURNED_0} = 0; |
| |
|
| # Now, we need to pre-process the map, by walking forward and backward |
# 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. |
# over the parts of the map we're going to look at. |
| |
|
|
Line 1330 sub new {
|
Line 1852 sub new {
|
| |
|
| my $maxDepth = 0; # tracks max depth |
my $maxDepth = 0; # tracks max depth |
| |
|
| |
# If there is only one resource in this map, and it's a map, we |
| |
# want to remember that, so the user can ask for the first map |
| |
# that isn't just a redirector. |
| |
my $resource; my $resourceCount = 0; |
| |
|
| # **1** |
# **1** |
| |
|
| foreach my $pass (@iterations) { |
foreach my $pass (@iterations) { |
|
Line 1353 sub new {
|
Line 1880 sub new {
|
| if ($curRes == $iterator->END_MAP()) { $depth--; } |
if ($curRes == $iterator->END_MAP()) { $depth--; } |
| |
|
| if (ref($curRes)) { |
if (ref($curRes)) { |
| |
# If there's only one resource, this will save it |
| |
# we have to filter empty resources from consideration here, |
| |
# or even "empty", redirecting maps have two (start & finish) |
| |
# or three (start, finish, plus redirector) |
| |
if($direction == FORWARD && $curRes->src()) { |
| |
$resource = $curRes; $resourceCount++; |
| |
} |
| my $resultingVal = $curRes->{DATA}->{$valName}; |
my $resultingVal = $curRes->{DATA}->{$valName}; |
| my $nextResources = $curRes->$nextResourceMethod(); |
my $nextResources = $curRes->$nextResourceMethod(); |
| my $resourceCount = scalar(@{$nextResources}); |
my $nextCount = scalar(@{$nextResources}); |
| |
|
| if ($resourceCount == 1) { # **3** |
if ($nextCount == 1) { # **3** |
| my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; |
my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; |
| $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); |
$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); |
| } |
} |
| |
|
| if ($resourceCount > 1) { # **4** |
if ($nextCount > 1) { # **4** |
| foreach my $res (@{$nextResources}) { |
foreach my $res (@{$nextResources}) { |
| my $current = $res->{DATA}->{$valName} || 999999999; |
my $current = $res->{DATA}->{$valName} || 999999999; |
| $res->{DATA}->{$valName} = min($current, $resultingVal + 1); |
$res->{DATA}->{$valName} = min($current, $resultingVal + 1); |
|
Line 1382 sub new {
|
Line 1916 sub new {
|
| } |
} |
| } |
} |
| |
|
| |
# Check: Was this only one resource, a map? |
| |
if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) { |
| |
my $firstResource = $resource->map_start(); |
| |
my $finishResource = $resource->map_finish(); |
| |
return |
| |
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
| |
$finishResource, $self->{FILTER}, |
| |
$self->{ALREADY_SEEN}, |
| |
$self->{CONDITION}, 0); |
| |
|
| |
} |
| |
|
| # Set up some bookkeeping information. |
# Set up some bookkeeping information. |
| $self->{CURRENT_DEPTH} = 0; |
$self->{CURRENT_DEPTH} = 0; |
| $self->{MAX_DEPTH} = $maxDepth; |
$self->{MAX_DEPTH} = $maxDepth; |
|
Line 1404 sub new {
|
Line 1950 sub new {
|
| sub next { |
sub next { |
| my $self = shift; |
my $self = shift; |
| |
|
| |
# If we want to return the top-level map object, and haven't yet, |
| |
# do so. |
| |
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) { |
| |
$self->{HAVE_RETURNED_0} = 1; |
| |
return $self->{NAV_MAP}->getById('0.0'); |
| |
} |
| |
|
| if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
| # grab the next from the recursive iterator |
# grab the next from the recursive iterator |
| my $next = $self->{RECURSIVE_ITERATOR}->next(); |
my $next = $self->{RECURSIVE_ITERATOR}->next(); |
|
Line 1509 sub next {
|
Line 2062 sub next {
|
| # BC branch and gets to C, it will see F as the only next resource, but it's |
# 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 |
# one level lower. Thus, this is the end of the branch, since there are no |
| # more resources added to this level or above. |
# 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}; |
my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH}; |
| if ($isEndOfBranch) { # **9** |
if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9** |
| push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); |
push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); |
| } |
} |
| |
|
|
Line 1528 sub next {
|
Line 2084 sub next {
|
| $self->{ALREADY_SEEN}, $self->{CONDITION}); |
$self->{ALREADY_SEEN}, $self->{CONDITION}); |
| } |
} |
| |
|
| |
# If this is a blank resource, don't actually return it. |
| |
# Should you ever find you need it, make sure to add an option to the code |
| |
# that you can use; other things depend on this behavior. |
| |
my $browsePriv = $self->{HERE}->browsePriv(); |
| |
if (!$self->{HERE}->src() || |
| |
(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) { |
| |
return $self->next(); |
| |
} |
| |
|
| return $self->{HERE}; |
return $self->{HERE}; |
| |
|
| } |
} |
|
Line 1574 package Apache::lonnavmaps::DFSiterator;
|
Line 2139 package Apache::lonnavmaps::DFSiterator;
|
| # but this might as well be left seperate, since it is possible some other |
# but this might as well be left seperate, since it is possible some other |
| # use might be found for it. - Jeremy |
# use might be found for it. - Jeremy |
| |
|
| |
# Unlike the main iterator, this DOES return all resources, even blank ones. |
| |
# The main iterator needs them to correctly preprocess the map. |
| |
|
| sub BEGIN_MAP { return 1; } # begining of a new map |
sub BEGIN_MAP { return 1; } # begining of a new map |
| sub END_MAP { return 2; } # end of the map |
sub END_MAP { return 2; } # end of the map |
| sub FORWARD { return 1; } # go forward |
sub FORWARD { return 1; } # go forward |
|
Line 1605 sub new {
|
Line 2173 sub new {
|
| |
|
| # A hash, used as a set, of resource already seen |
# A hash, used as a set, of resource already seen |
| $self->{ALREADY_SEEN} = shift; |
$self->{ALREADY_SEEN} = shift; |
| if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
| $self->{CONDITION} = shift; |
$self->{CONDITION} = shift; |
| $self->{DIRECTION} = shift || FORWARD(); |
$self->{DIRECTION} = shift || FORWARD(); |
| |
|
|
Line 1728 A resource object encapsulates a resourc
|
Line 2296 A resource object encapsulates a resourc
|
| |
|
| A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. |
A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. |
| |
|
| You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource. |
You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource. |
| |
|
| =head2 Public Members |
=head2 Public Members |
| |
|
|
Line 1774 sub navHash {
|
Line 2342 sub navHash {
|
| my $self = shift; |
my $self = shift; |
| my $param = shift; |
my $param = shift; |
| my $id = shift; |
my $id = shift; |
| return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; |
return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:"")); |
| } |
} |
| |
|
| =pod |
=pod |
|
Line 1859 These methods are shortcuts to deciding
|
Line 2427 These methods are shortcuts to deciding
|
| |
|
| =item * B<is_page>: Returns true if the resource is a page. |
=item * B<is_page>: Returns true if the resource is a page. |
| |
|
| =item * B<is_problem>: Returns true if the resource is a problem. |
|
| |
|
| =item * B<is_sequence>: Returns true if the resource is a sequence. |
=item * B<is_sequence>: Returns true if the resource is a sequence. |
| |
|
| =back |
=back |
|
Line 1921 These methods are useful for getting inf
|
Line 2487 These methods are useful for getting inf
|
| sub map_finish { |
sub map_finish { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| |
$src = Apache::lonnet::clutter($src); |
| my $res = $self->navHash("map_finish_$src", 0); |
my $res = $self->navHash("map_finish_$src", 0); |
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
|
Line 1933 sub map_pc {
|
Line 2500 sub map_pc {
|
| sub map_start { |
sub map_start { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| |
$src = Apache::lonnet::clutter($src); |
| my $res = $self->navHash("map_start_$src", 0); |
my $res = $self->navHash("map_start_$src", 0); |
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
|
Line 2095 sub hasDiscussion {
|
Line 2663 sub hasDiscussion {
|
| |
|
| sub getFeedback { |
sub getFeedback { |
| my $self = shift; |
my $self = shift; |
| return $self->{NAV_MAP}->getFeedback($self->src()); |
my $source = $self->src(); |
| |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
| |
return $self->{NAV_MAP}->getFeedback($source); |
| |
} |
| |
|
| |
sub getErrors { |
| |
my $self = shift; |
| |
my $source = $self->src(); |
| |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
| |
return $self->{NAV_MAP}->getErrors($source); |
| } |
} |
| |
|
| =pod |
=pod |
| |
|
| =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.) |
=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater than two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.) |
| |
|
| =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe. |
=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe. |
| |
|
|
Line 2121 sub countParts {
|
Line 2698 sub countParts {
|
| my $self = shift; |
my $self = shift; |
| |
|
| my $parts = $self->parts(); |
my $parts = $self->parts(); |
| |
my $delta = 0; |
| |
for my $part (@$parts) { |
| |
if ($part eq '0') { $delta--; } |
| |
} |
| |
|
| if ($self->{RESOURCE_ERROR}) { |
if ($self->{RESOURCE_ERROR}) { |
| return 0; |
return 0; |
| } |
} |
| |
|
| if (scalar(@{$parts}) < 2) { return 1;} |
return scalar(@{$parts}) + $delta; |
| |
|
| return scalar(@{$parts}) - 1; |
|
| } |
} |
| |
|
| # Private function: Extracts the parts information and saves it |
# Private function: Extracts the parts information and saves it |
| sub extractParts { |
sub extractParts { |
| my $self = shift; |
my $self = shift; |
| |
|
| return if ($self->{PARTS}); |
return if (defined($self->{PARTS})); |
| return if ($self->ext); |
return if ($self->ext); |
| |
|
| $self->{PARTS} = []; |
$self->{PARTS} = []; |
| |
|
| # Retrieve part count, if this is a problem |
# Retrieve part count, if this is a problem |
| if ($self->is_problem()) { |
if ($self->is_problem()) { |
| my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys'); |
my $metadata = &Apache::lonnet::metadata($self->src(), 'packages'); |
| if (!$metadata) { |
if (!$metadata) { |
| $self->{RESOURCE_ERROR} = 1; |
$self->{RESOURCE_ERROR} = 1; |
| $self->{PARTS} = []; |
$self->{PARTS} = []; |
| return; |
return; |
| } |
} |
| |
|
| foreach (split(/\,/,$metadata)) { |
foreach (split(/\,/,$metadata)) { |
| if ($_ =~ /^parameter\_(.*)\_opendate$/) { |
if ($_ =~ /^part_(.*)$/) { |
| push @{$self->{PARTS}}, $1; |
my $part = $1; |
| |
# check to see if part is turned off. |
| |
if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { |
| |
push @{$self->{PARTS}}, $1; |
| |
} |
| } |
} |
| } |
} |
| |
|
| |
|
| # Is this possible to do in one line? - Jeremy |
|
| my @sortedParts = sort @{$self->{PARTS}}; |
my @sortedParts = sort @{$self->{PARTS}}; |
| $self->{PARTS} = \@sortedParts; |
$self->{PARTS} = \@sortedParts; |
| } |
} |
|
Line 2451 sub getNext {
|
Line 3032 sub getNext {
|
| my $next = $choice->goesto(); |
my $next = $choice->goesto(); |
| $next = $self->{NAV_MAP}->getById($next); |
$next = $self->{NAV_MAP}->getById($next); |
| |
|
| # Don't remember it if the student doesn't have browse priviledges |
push @branches, $next; |
| # future note: this may properly belong in the client of the resource |
|
| my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
| if (!($browsePriv ne '2' && $browsePriv ne 'F')) { |
|
| push @branches, $next; |
|
| } |
|
| } |
} |
| return \@branches; |
return \@branches; |
| } |
} |
|
Line 2470 sub getPrevious {
|
Line 3046 sub getPrevious {
|
| my $prev = $choice->comesfrom(); |
my $prev = $choice->comesfrom(); |
| $prev = $self->{NAV_MAP}->getById($prev); |
$prev = $self->{NAV_MAP}->getById($prev); |
| |
|
| # Don't remember it if the student doesn't have browse priviledges |
push @branches, $prev; |
| # future note: this may properly belong in the client of the resource |
|
| my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
| if (!($browsePriv ne '2' && $browsePriv ne 'F')) { |
|
| push @branches, $prev; |
|
| } |
|
| } |
} |
| return \@branches; |
return \@branches; |
| } |
} |
| |
|
| |
sub browsePriv { |
| |
my $self = shift; |
| |
if (defined($self->{BROWSE_PRIV})) { |
| |
return $self->{BROWSE_PRIV}; |
| |
} |
| |
|
| |
$self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src()); |
| |
} |
| |
|
| =pod |
=pod |
| |
|
| =back |
=back |
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavmaps.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface