|
version 1.125, 2003/01/10 19:03:06
|
version 1.178, 2003/04/22 17:54:27
|
|
Line 1
|
Line 1
|
| |
|
| # The LearningOnline Network with CAPA |
# The LearningOnline Network with CAPA |
| # Navigate Maps Handler |
# Navigate Maps Handler |
| # |
# |
|
Line 38
|
Line 37
|
| # 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); |
| |
|
| |
# 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 handler { |
sub handler { |
| my $r = shift; |
my $r = shift; |
| real_handler($r); |
real_handler($r); |
|
Line 54 sub handler {
|
Line 103 sub handler {
|
| sub real_handler { |
sub real_handler { |
| my $r = shift; |
my $r = shift; |
| |
|
| &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
|
| |
|
| # Handle header-only request |
# Handle header-only request |
| if ($r->header_only) { |
if ($r->header_only) { |
| if ($ENV{'browser.mathml'}) { |
if ($ENV{'browser.mathml'}) { |
|
Line 89 sub real_handler {
|
Line 136 sub real_handler {
|
| } |
} |
| |
|
| $r->print("<html><head>\n"); |
$r->print("<html><head>\n"); |
| $r->print("<title>Navigate Course Contents</title></head>"); |
$r->print("<title>Navigate Course Contents</title>"); |
| |
# ------------------------------------------------------------ Get query string |
| |
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); |
| |
|
| |
# ----------------------------------------------------- Force menu registration |
| |
my $addentries=''; |
| |
if ($ENV{'form.register'}) { |
| |
$addentries=' onLoad="'.&Apache::lonmenu::loadevents(). |
| |
'" onUnload="'.&Apache::lonmenu::unloadevents().'"'; |
| |
$r->print(&Apache::lonmenu::registerurl(1)); |
| |
} |
| |
|
| # Header |
# Header |
| $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','', |
$r->print('</head>'. |
| '')); |
&Apache::loncommon::bodytag('Navigate Course Contents','', |
| |
$addentries,'','',$ENV{'form.register'})); |
| $r->print('<script>window.focus();</script>'); |
$r->print('<script>window.focus();</script>'); |
| |
|
| $r->rflush(); |
$r->rflush(); |
|
Line 101 sub real_handler {
|
Line 159 sub real_handler {
|
| # 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('<table border="0" cellpadding="2" cellspacing="0">'); |
|
| my $date=localtime; |
|
| $r->print('<tr><td align="right" valign="bottom">Key: </td>'); |
|
| |
|
| # Print discussions and feedback header |
|
| if ($navmap->{LAST_CHECK}) { |
|
| $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; |
|
| } |
|
| |
|
| # Determine where the "here" marker is and where the screen jumps to. |
|
| my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants |
|
| my $hereType; # the type of marker, $SYMB, $URL, or $NOTHING |
|
| my $here; # the actual URL or SYMB for the here marker |
|
| my $jumpType; # The type of the thing we have a jump for, $SYMB or $URL |
|
| my $jump; # the SYMB/URL of the resource we need to jump to |
|
| |
|
| if ( $ENV{'form.alreadyHere'} ) { # 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 |
|
| $hereType = $ENV{'form.hereType'}; |
|
| $here = $ENV{'form.here'}; |
|
| $jumpType = $ENV{'form.jumpType'} || $NOTHING; |
|
| $jump = $ENV{'form.jump'}; |
|
| } else { # the user is visiting the nav map from the remote |
|
| # We're coming from the remote. We have either a url, a symb, or nothing, |
|
| # and we need to figure out what. |
|
| # Preference: Symb |
|
| |
|
| if ($ENV{'form.symb'}) { |
|
| $hereType = $jumpType = $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/^[^\/]+//; |
|
| |
|
| $hereType = $jumpType = $URL; |
|
| $here = $jump = $currenturl; |
|
| } else { |
|
| # Nothing |
|
| $hereType = $jumpType = $NOTHING; |
|
| } |
|
| } |
|
| |
|
| |
|
| # alreadyHere allows us to only open the maps necessary to view |
|
| # the current location once, while at the same time remembering |
|
| # the current location. Without that check, the user would never |
|
| # be able to close those maps; the user would close it, and the |
|
| # currenturl scan would re-open it. |
|
| my $queryAdd = "&alreadyHere=1"; |
|
| |
|
| if ($condition) { |
|
| $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" . |
|
| "&hereType=$hereType&here=" . Apache::lonnet::escape($here) . |
|
| "\">Close All Folders</a>"); |
|
| } else { |
|
| $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" . |
|
| "&hereType=$hereType&here=" . Apache::lonnet::escape($here) . |
|
| "\">Open All Folders</a>"); |
|
| } |
|
| |
|
| $r->print('<br> '); |
$r->print('<br> '); |
| $r->rflush(); |
$r->rflush(); |
| |
|
|
Line 190 sub real_handler {
|
Line 169 sub real_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 we don't |
| # is technically not proper, but should be harmless |
# already have a filter... if so, automatically display it |
| my $res = $navmap->firstResource(); |
if (!defined($ENV{'form.filter'})) { |
| |
my $iterator = $navmap->getIterator(undef, undef, undef, 0); |
| # These are some data tables, which make it easy to change some of |
my $depth = 1; |
| # of the specific visualization parameters if desired. |
$iterator->next(); |
| |
my $curRes = $iterator->next(); |
| # Defines a status->color mapping, null string means don't color |
my $sequenceCount = 0; |
| my %colormap = |
my $sequenceId; |
| ( $res->NETWORK_FAILURE => '', |
while ($depth > 0) { |
| $res->CORRECT => '', |
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
| $res->EXCUSED => '#3333FF', |
if ($curRes == $iterator->END_MAP()) { $depth--; } |
| $res->PAST_DUE_ANSWER_LATER => '', |
|
| $res->PAST_DUE_NO_ANSWER => '', |
|
| $res->ANSWER_OPEN => '#006600', |
|
| $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"; |
|
| |
|
| # Keep these mappings in sync with lonquickgrades, which uses the colors |
|
| # instead of the icons. |
|
| 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"); |
|
| |
|
| # 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, undef, 1); |
|
| my $found = 0; |
|
| my $depth = 1; |
|
| my $currentJumpIndex = 0; # keeps track of when the current resource is found, |
|
| # so we can back up a few and put the anchor above the |
|
| # current resource |
|
| my $currentJumpDelta = 2; # change this to change how many resources are displayed |
|
| # before the current resource when using #current |
|
| $mapIterator->next(); # discard the first BEGIN_MAP |
|
| my $curRes = $mapIterator->next(); |
|
| my $counter = 0; |
|
| my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one |
|
| my $looped = 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 && !$ENV{'form.alreadyHere'}) { |
|
| if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
|
| if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
| |
|
| if (ref($curRes) && !$ENV{'form.alreadyHere'} && |
|
| ($hereType == $SYMB && $curRes->symb() eq $here) || |
|
| (ref($curRes) && $hereType == $URL && $curRes->src() eq $here)) { |
|
| my $mapStack = $mapIterator->getStack(); |
|
| |
|
| # Ensure the parent maps are open |
if (ref($curRes) && $curRes->is_sequence()) { |
| for my $map (@{$mapStack}) { |
$sequenceCount++; |
| if ($condition) { |
$sequenceId = $curRes->map_pc(); |
| undef $filterHash{$map->map_pc()}; |
|
| } else { |
|
| $filterHash{$map->map_pc()} = 1; |
|
| } |
|
| } |
|
| $ENV{'form.alreadyHere'} = 1; |
|
| } |
|
| $looped = 1; |
|
| |
|
| $curRes = $mapIterator->next(); |
|
| } |
|
| |
|
| $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0); |
|
| $depth = 1; |
|
| $mapIterator->next(); |
|
| $curRes = $mapIterator->next(); |
|
| |
|
| while ($depth > 0 && !$foundJump) { |
|
| if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
|
| if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
| if (ref($curRes)) { $counter++; } |
|
| |
|
| if (ref($curRes) && |
|
| (($jumpType == $SYMB && $curRes->symb() eq $jump) || |
|
| ($jumpType == $URL && $curRes->src() eq $jump))) { |
|
| # 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. |
|
| $currentJumpIndex = $counter; |
|
| $foundJump = 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; |
|
| my $displayedJumpMarker = 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(); |
|
| $depth = 1; |
|
| |
|
| my @backgroundColors = ("#FFFFFF", "#F6F6F6"); |
|
| my $rowNum = 0; |
|
| |
|
| $counter = 0; |
|
| |
|
| while ($depth > 0) { |
|
| 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++; } |
|
| |
|
| # 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)) { |
if ($sequenceCount == 1) { |
| |
# The automatic iterator creation in the render call |
| my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon |
# will pick this up. We know the condition because |
| |
# the defined($ENV{'form.filter'}) also ensures this |
| if ($indentLevel - $deltalevel < 0) { |
# is a fresh call. |
| # If this would be at a negative depth (top-level maps in |
$ENV{'form.filter'} = "$sequenceId"; |
| # new-style courses, we want to suppress their title display) |
|
| # then ignore it. |
|
| $curRes = $mapIterator->next(); |
|
| next; |
|
| } |
|
| |
|
| # 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 $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(); |
|
| if ($src=~/^\/uploaded\//) { |
|
| $nonLinkedText=$title; |
|
| $title=''; |
|
| } |
|
| 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; |
|
| } |
|
| |
|
| # 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" . |
|
| "&hereType=$hereType&here=" . |
|
| Apache::lonnet::escape($here) . "&jumpType=$SYMB&" . |
|
| "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">"; |
|
| $linkclose = "</a>"; |
|
| |
|
| } |
|
| |
|
| my $colorizer = ""; |
|
| my $color; |
|
| if ($curRes->is_problem()) { |
|
| $color = $colormap{$curRes->status}; |
|
| |
|
| if (dueInLessThen24Hours($curRes, $part) || |
|
| lastTry($curRes, $part)) { |
|
| $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\">\n"); |
|
| |
|
| # Print the anchor if necessary |
|
| if ($counter == $currentJumpIndex - $currentJumpDelta ) { |
|
| $r->print('<a name="curloc" />'); |
|
| $displayedJumpMarker = 1; |
|
| } |
|
| |
|
| # print indentation |
|
| for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) { |
|
| $r->print($indentString); |
|
| } |
|
| |
|
| $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); |
|
| |
|
| my $curMarkerBegin = ""; |
|
| my $curMarkerEnd = ""; |
|
| |
|
| # Is this the current resource? |
|
| if (!$displayedHereMarker && |
|
| (($hereType == $SYMB && $curRes->symb eq $here) || |
|
| ($hereType == $URL && $curRes->src eq $here))) { |
|
| $curMarkerBegin = '<font color="red" size="+2">> </font>'; |
|
| $curMarkerEnd = '<font color="red" size="+2"> <</font>'; |
|
| $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>')); |
|
| # } |
|
| |
|
| $r->print("</td>\n"); |
|
| |
|
| # SECOND COL: Is there text, feedback, errors?? |
|
| my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; |
|
| |
|
| 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>'; |
|
| } |
|
| } |
|
| } |
|
| |
|
| if ($curRes->getErrors()) { |
|
| my $errors = $curRes->getErrors(); |
|
| foreach (split(/,/, $errors)) { |
|
| if ($_) { |
|
| $errorHTML .= ' <a href="/adm/email?display=' |
|
| . &Apache::lonnet::escape($_) . '">' |
|
| . '<img src="/adm/lonMisc/bomb.gif" ' |
|
| . 'border="0" /></a>'; |
|
| } |
|
| } |
|
| } |
|
| |
|
| $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </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"); |
|
| |
|
| if (!($counter % 20)) { $r->rflush(); } |
|
| if ($counter == 2) { $r->rflush(); } |
|
| } |
|
| } |
} |
| $curRes = $mapIterator->next(); |
|
| } |
} |
| |
|
| $r->print("</table>"); |
# renderer call |
| |
my $render = render({ 'cols' => [0,1,2,3], |
| |
'url' => '/adm/navmaps', |
| |
'navmap' => $navmap, |
| |
'suppressNavmap' => 1, |
| |
'r' => $r}); |
| |
|
| # Print out the part that jumps to #curloc if it exists |
$navmap->untieHashes(); |
| if ($displayedJumpMarker) { |
|
| $r->print('<script>location += "#curloc";</script>'); |
|
| } |
|
| |
|
| $r->print("</body></html>"); |
$r->print("</body></html>"); |
| |
$r->rflush(); |
| $navmap->untieHashes(); |
|
| |
|
| return OK; |
return OK; |
| } |
} |
|
Line 826 sub lastTry {
|
Line 347 sub lastTry {
|
| } |
} |
| |
|
| # This puts a human-readable name on the ENV variable. |
# This puts a human-readable name on the ENV variable. |
| |
|
| sub advancedUser { |
sub advancedUser { |
| return $ENV{'user.adv'}; |
return $ENV{'request.role.adv'}; |
| } |
} |
| |
|
| |
|
|
Line 936 sub timeToHumanString {
|
Line 458 sub timeToHumanString {
|
| } |
} |
| } |
} |
| |
|
| |
|
| |
=pod |
| |
|
| |
=head1 NAME |
| |
|
| |
Apache::lonnavmap - Subroutines to handle and render the navigation maps |
| |
|
| |
=head1 SYNOPSIS |
| |
|
| |
The main handler generates the navigational listing for the course, |
| |
the other objects export this information in a usable fashion for |
| |
other modules |
| |
|
| |
=head1 Object: render |
| |
|
| |
The navmap renderer package provides a sophisticated rendering of the |
| |
standard navigation maps interface into HTML. The provided nav map |
| |
handler is actually just a glorified call to this. |
| |
|
| |
Because of the large number of parameters this function 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. True implies printCloseAll is false, since you |
| |
can't close or open folders when this is on anyhow. |
| |
|
| |
=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<r>: |
| |
|
| |
The standard Apache response object. This must be passed to the |
| |
renderer or the course hash will be locked. |
| |
|
| |
=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<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.postsymb'}) { |
| |
$here = $jump = $ENV{'form.postsymb'}; |
| |
} 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($r, |
| |
$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 && !$args->{'resource_no_folder_link'}) { |
| |
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 Object: navmap |
| |
|
| navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it. |
Encapsulating the compiled nav map |
| |
|
| Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps. |
navmap is an object that encapsulates a compiled course map and |
| |
provides a reasonable interface to it. |
| |
|
| |
Most notably it provides a way to navigate the map sensibly and a |
| |
flexible iterator that makes it easy to write various renderers based |
| |
on nav maps. |
| |
|
| You must obtain resource objects through the navmap object. |
You must obtain resource objects through the navmap object. |
| |
|
|
Line 956 You must obtain resource objects through
|
Line 1383 You must obtain resource objects through
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise. |
=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, |
| |
genMailDiscussStatus): |
| |
|
| |
Binds a new navmap object to the compiled nav map hash and parm hash |
| |
given as filenames. genCourseAndUserOptions is a flag saying whether |
| |
the course options and user options hash should be generated. This is |
| |
for when you are using the parameters of the resources that require |
| |
them; see documentation in resource object |
| |
documentation. genMailDiscussStatus causes the nav map to retreive |
| |
information about the email and discussion status of |
| |
resources. Returns the navmap object if this is successful, or |
| |
B<undef> if not. You must check for undef; errors will occur when you |
| |
try to use the other methods otherwise. |
| |
|
| |
=item * B<getIterator>(first, finish, filter, condition): |
| |
|
| =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below. |
See iterator documentation below. |
| |
|
| =cut |
=cut |
| |
|
|
Line 985 sub new {
|
Line 1426 sub new {
|
| $self->{NETWORK_FAILURE} = 0; |
$self->{NETWORK_FAILURE} = 0; |
| |
|
| # tie the nav hash |
# tie the nav hash |
| |
|
| my %navmaphash; |
my %navmaphash; |
| |
my %parmhash; |
| 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; |
| } |
} |
| |
|
| 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->{NAV_HASH} = \%navmaphash; |
$self->{NAV_HASH} = \%navmaphash; |
| $self->{PARM_HASH} = \%parmhash; |
$self->{PARM_HASH} = \%parmhash; |
| |
$self->{INITED} = 0; |
| |
|
| bless($self); |
bless($self); |
| $self->untieHashes(); |
|
| |
|
| return $self; |
return $self; |
| } |
} |
| |
|
| 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 1115 sub init {
|
Line 1558 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 |
# Internal function: Takes a key to look up in the nav hash and implements internal |
|
Line 1144 sub getIterator {
|
Line 1588 sub getIterator {
|
| # unties the hash when done |
# unties the hash when done |
| sub untieHashes { |
sub untieHashes { |
| my $self = shift; |
my $self = shift; |
| untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED}); |
untie %{$self->{NAV_HASH}}; |
| untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED}); |
untie %{$self->{PARM_HASH}}; |
| $self->{HASH_TIED} = 0; |
|
| } |
|
| |
|
| # when the object is destroyed, be sure to untie all the hashes we tied. |
|
| sub DESTROY { |
|
| my $self = shift; |
|
| $self->untieHashes(); |
|
| } |
} |
| |
|
| # Private method: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
|
Line 1190 sub getErrors {
|
Line 1627 sub getErrors {
|
| |
|
| =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. |
| |
|
| =cut |
=cut |
| |
|
|
Line 1209 sub getById {
|
Line 1651 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); |
| |
} |
| |
|
| |
sub getBySymb { |
| |
my $self = shift; |
| |
my $symb = shift; |
| |
my ($mapUrl, $id, $filename) = split (/___/, $symb); |
| |
my $map = $self->getResourceByUrl($mapUrl); |
| |
return $self->getById($map->map_pc() . '.' . $id); |
| } |
} |
| |
|
| =pod |
=pod |
| |
|
| =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap. |
=item * B<firstResource>(): |
| |
|
| |
Returns a resource object reference corresponding to the first |
| |
resource in the navmap. |
| |
|
| =cut |
=cut |
| |
|
|
Line 1227 sub firstResource {
|
Line 1682 sub firstResource {
|
| |
|
| =pod |
=pod |
| |
|
| =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap. |
=item * B<finishResource>(): |
| |
|
| |
Returns a resource object reference corresponding to the last resource |
| |
in the navmap. |
| |
|
| =cut |
=cut |
| |
|
|
Line 1324 sub parmval_real {
|
Line 1782 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 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->getResourceByUrl($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 1345 package Apache::lonnavmaps::iterator;
|
Line 1929 package Apache::lonnavmaps::iterator;
|
| |
|
| =back |
=back |
| |
|
| =head1 navmap Iterator |
=head1 Object: navmap Iterator |
| |
|
| An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use. |
|
| |
|
| To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator: |
An I<iterator> encapsulates the logic required to traverse a data |
| |
structure. navmap uses an iterator to traverse the course map |
| |
according to the criteria you wish to use. |
| |
|
| |
To obtain an iterator, call the B<getIterator>() function of a |
| |
B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator |
| |
directly.) This will return a reference to the iterator: |
| |
|
| C<my $resourceIterator = $navmap-E<gt>getIterator();> |
C<my $resourceIterator = $navmap-E<gt>getIterator();> |
| |
|
|
Line 1361 getIterator behaves as follows:
|
Line 1949 getIterator behaves as follows:
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): 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. |
=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap): |
| |
|
| 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. |
All parameters are optional. firstResource is a resource reference |
| |
corresponding to where the iterator should start. It defaults to |
| The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are: |
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. |
| |
|
| |
The iterator will return either a reference to a resource object, or a |
| |
token representing something in the map, such as the beginning of a |
| |
new branch. The possible tokens are: |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned. |
=item * BEGIN_MAP: |
| |
|
| |
A new map is being recursed into. This is returned I<after> the map |
| |
resource itself is returned. |
| |
|
| |
=item * END_MAP: |
| |
|
| |
The map is now done. |
| |
|
| |
=item * BEGIN_BRANCH: |
| |
|
| =item * END_MAP: The map is now done. |
A branch is now starting. The next resource returned will be the first |
| |
in that branch. |
| |
|
| =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch. |
=item * END_BRANCH: |
| |
|
| =item * END_BRANCH: The branch is now done. |
The branch is now done. |
| |
|
| =back |
=back |
| |
|
| 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. |
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 |
| |
|
|
Line 1436 sub new {
|
Line 2065 sub new {
|
| # Do we want to automatically follow "redirection" maps? |
# Do we want to automatically follow "redirection" maps? |
| $self->{FORCE_TOP} = shift; |
$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 1549 sub new {
|
Line 2183 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 1679 sub next {
|
Line 2320 sub next {
|
| # If this is a blank resource, don't actually return it. |
# 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 |
# 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. |
# that you can use; other things depend on this behavior. |
| if (!$self->{HERE}->src()) { |
my $browsePriv = $self->{HERE}->browsePriv(); |
| |
if (!$self->{HERE}->src() || |
| |
(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) { |
| return $self->next(); |
return $self->next(); |
| } |
} |
| |
|
|
Line 1689 sub next {
|
Line 2332 sub next {
|
| |
|
| =pod |
=pod |
| |
|
| The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map). |
The other method available on the iterator is B<getStack>, which |
| |
returns an array populated with the current 'stack' of maps, as |
| |
references to the resource objects. Example: This is useful when |
| |
making the navigation map, as we need to check whether we are under a |
| |
page map to see if we need to link directly to the resource, or to the |
| |
page. The first elements in the array will correspond to the top of |
| |
the stack (most inclusive map). |
| |
|
| =cut |
=cut |
| |
|
|
Line 1763 sub new {
|
Line 2412 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 1882 use Apache::lonnet;
|
Line 2531 use Apache::lonnet;
|
| |
|
| =head1 Object: resource |
=head1 Object: resource |
| |
|
| A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers. |
A resource object encapsulates a resource in a resource map, allowing |
| |
easy manipulation of the resource, querying the properties of the |
| A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. |
resource (including user properties), and represents a reference that |
| |
can be used as the canonical representation of the resource by |
| You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource. |
lonnavmap clients like renderers. |
| |
|
| |
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::lonnavmaps::navmap, and use the "start" method to obtain the |
| |
starting resource. |
| |
|
| =head2 Public Members |
=head2 Public Members |
| |
|
| resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash. |
resource objects have a hash called DATA ($resourceRef->{DATA}) that |
| |
you can store whatever you want in. This allows you to easily do |
| |
two-pass algorithms without worrying about managing your own |
| |
resource->data hash. |
| |
|
| =head2 Methods |
=head2 Methods |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method. |
=item * B<new>($navmapRef, $idString): |
| |
|
| |
The first arg is a reference to the parent navmap object. The second |
| |
is the idString of the resource itself. Very rarely, if ever, called |
| |
directly. Use the nav map->getByID() method. |
| |
|
| =back |
=back |
| |
|
|
Line 1939 sub navHash {
|
Line 2602 sub navHash {
|
| |
|
| B<Metadata Retreival> |
B<Metadata Retreival> |
| |
|
| These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation. |
These are methods that help you retrieve metadata about the resource: |
| |
Method names are based on the fields in the compiled course |
| |
representation. |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem"). |
=item * B<compTitle>: |
| |
|
| |
Returns a "composite title", that is equal to $res->title() if the |
| |
resource has a title, and is otherwise the last part of the URL (e.g., |
| |
"problem.problem"). |
| |
|
| |
=item * B<ext>: |
| |
|
| |
Returns true if the resource is external. |
| |
|
| =item * B<ext>: Returns true if the resource is external. |
=item * B<goesto>: |
| |
|
| =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) |
Returns the "goesto" value from the compiled nav map. (It is likely |
| |
you want to use B<getNext> instead.) |
| |
|
| =item * B<kind>: Returns the kind of the resource from the compiled nav map. |
=item * B<kind>: |
| |
|
| =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false. |
Returns the kind of the resource from the compiled nav map. |
| |
|
| =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?) |
=item * B<randomout>: |
| |
|
| =item * B<src>: Returns the source for the resource. |
Returns true if this resource was chosen to NOT be shown to the user |
| |
by the random map selection feature. In other words, this is usually |
| |
false. |
| |
|
| =item * B<symb>: Returns the symb for the resource. |
=item * B<randompick>: |
| |
|
| =item * B<title>: Returns the title of the resource. |
Returns true for a map if the randompick feature is being used on the |
| |
map. (?) |
| |
|
| =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) |
=item * B<src>: |
| |
|
| |
Returns the source for the resource. |
| |
|
| |
=item * B<symb>: |
| |
|
| |
Returns the symb for the resource. |
| |
|
| |
=item * B<title>: |
| |
|
| |
Returns the title of the resource. |
| |
|
| |
=item * B<to>: |
| |
|
| |
Returns the "to" value from the compiled nav map. (It is likely you |
| |
want to use B<getNext> instead.) |
| |
|
| =back |
=back |
| |
|
|
Line 1997 sub to { my $self=shift; return $self->n
|
Line 2689 sub to { my $self=shift; return $self->n
|
| sub compTitle { |
sub compTitle { |
| my $self = shift; |
my $self = shift; |
| my $title = $self->title(); |
my $title = $self->title(); |
| |
$title=~s/\&colon\;/\:/gs; |
| if (!$title) { |
if (!$title) { |
| $title = $self->src(); |
$title = $self->src(); |
| $title = substr($title, rindex($title, '/') + 1); |
$title = substr($title, rindex($title, '/') + 1); |
|
Line 2011 These methods are shortcuts to deciding
|
Line 2704 These methods are shortcuts to deciding
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<is_map>: Returns true if the resource is a map type. |
=item * B<is_map>: |
| |
|
| |
Returns true if the resource is a map type. |
| |
|
| |
=item * B<is_problem>: |
| |
|
| |
Returns true if the resource is a problem type, false |
| |
otherwise. (Looks at the extension on the src field; might need more |
| |
to work correctly.) |
| |
|
| =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.) |
=item * B<is_page>: |
| |
|
| =item * B<is_page>: Returns true if the resource is a 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>: |
| |
|
| =item * B<is_sequence>: Returns true if the resource is a sequence. |
Returns true if the resource is a sequence. |
| |
|
| =back |
=back |
| |
|
|
Line 2060 sub parmval {
|
Line 2761 sub parmval {
|
| |
|
| B<Map Methods> |
B<Map Methods> |
| |
|
| These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>). |
These methods are useful for getting information about the map |
| |
properties of the resource, if the resource is a map (B<is_map>). |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map. |
=item * B<map_finish>: |
| |
|
| =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map. |
Returns a reference to a resource object corresponding to the finish |
| |
resource of the map. |
| |
|
| =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map. |
=item * B<map_pc>: |
| |
|
| =item * B<map_type>: Returns a string with the type of the map in it. |
Returns the pc value of the map, which is the first number that |
| |
appears in the resource ID of the resources in the map, and is the |
| |
number that appears around the middle of the symbs of the resources in |
| |
that map. |
| |
|
| |
=item * B<map_start>: |
| |
|
| |
Returns a reference to a resource object corresponding to the start |
| |
resource of the map. |
| |
|
| |
=item * B<map_type>: |
| |
|
| |
Returns a string with the type of the map in it. |
| |
|
| =back |
=back |
| |
|
|
Line 2079 These methods are useful for getting inf
|
Line 2794 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 2091 sub map_pc {
|
Line 2807 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 2117 sub map_type {
|
Line 2834 sub map_type {
|
| |
|
| =head2 Resource Parameters |
=head2 Resource Parameters |
| |
|
| In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter. |
In order to use the resource parameters correctly, the nav map must |
| |
have been instantiated with genCourseAndUserOptions set to true, so |
| These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.) |
the courseopt and useropt is read correctly. Then, you can call these |
| |
functions to get the relevant parameters for the resource. Each |
| |
function defaults to part "0", but can be directed to another part by |
| |
passing the part as the parameter. |
| |
|
| |
These methods are responsible for getting the parameter correct, not |
| |
merely reflecting the contents of the GDBM hashes. As we move towards |
| |
dates relative to other dates, these methods should be updated to |
| |
reflect that. (Then, anybody using these methods will not have to update |
| |
their code.) |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<acc>: Get the Client IP/Name Access Control information. |
=item * B<acc>: |
| |
|
| |
Get the Client IP/Name Access Control information. |
| |
|
| |
=item * B<answerdate>: |
| |
|
| |
Get the answer-reveal date for the problem. |
| |
|
| |
=item * B<duedate>: |
| |
|
| |
Get the due date for the problem. |
| |
|
| =item * B<answerdate>: Get the answer-reveal date for the problem. |
=item * B<tries>: |
| |
|
| =item * B<duedate>: Get the due date for the problem. |
Get the number of tries the student has used on the problem. |
| |
|
| =item * B<tries>: Get the number of tries the student has used on the problem. |
=item * B<maxtries>: |
| |
|
| =item * B<maxtries>: Get the number of max tries allowed. |
Get the number of max tries allowed. |
| |
|
| =item * B<opendate>: Get the open date for the problem. |
=item * B<opendate>: |
| |
|
| =item * B<sig>: Get the significant figures setting. |
Get the open date for the problem. |
| |
|
| =item * B<tol>: Get the tolerance for the problem. |
=item * B<sig>: |
| |
|
| =item * B<tries>: Get the number of tries the user has already used on the problem. |
Get the significant figures setting. |
| |
|
| =item * B<type>: Get the question type for the problem. |
=item * B<tol>: |
| |
|
| =item * B<weight>: Get the weight for the problem. |
Get the tolerance for the problem. |
| |
|
| |
=item * B<tries>: |
| |
|
| |
Get the number of tries the user has already used on the problem. |
| |
|
| |
=item * B<type>: |
| |
|
| |
Get the question type for the problem. |
| |
|
| |
=item * B<weight>: |
| |
|
| |
Get the weight for the problem. |
| |
|
| =back |
=back |
| |
|
|
Line 2234 Misc. functions for the resource.
|
Line 2982 Misc. functions for the resource.
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed. |
=item * B<hasDiscussion>: |
| |
|
| =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this: |
Returns a false value if there has been discussion since the user last |
| |
logged in, true if there has. Always returns false if the discussion |
| |
data was not extracted when the nav map was constructed. |
| |
|
| |
=item * B<getFeedback>: |
| |
|
| |
Gets the feedback for the resource and returns the raw feedback string |
| |
for the resource, or the null string if there is no feedback or the |
| |
email data was not extracted when the nav map was constructed. Usually |
| |
used like this: |
| |
|
| for (split(/\,/, $res->getFeedback())) { |
for (split(/\,/, $res->getFeedback())) { |
| my $link = &Apache::lonnet::escape($_); |
my $link = &Apache::lonnet::escape($_); |
|
Line 2267 sub getErrors {
|
Line 3024 sub getErrors {
|
| |
|
| =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>(): |
| |
|
| =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. |
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. |
| |
|
| =back |
=back |
| |
|
|
Line 2288 sub countParts {
|
Line 3057 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 2335 sub extractParts {
|
Line 3108 sub extractParts {
|
| |
|
| =head2 Resource Status |
=head2 Resource Status |
| |
|
| Problem resources have status information, reflecting their various dates and completion statuses. |
Problem resources have status information, reflecting their various |
| |
dates and completion statuses. |
| |
|
| There are two aspects to the status: the date-related information and the completion information. |
There are two aspects to the status: the date-related information and |
| |
the completion information. |
| |
|
| Idiomatic usage of these two methods would probably look something like |
Idiomatic usage of these two methods would probably look something |
| |
like |
| |
|
| foreach ($resource->parts()) { |
foreach ($resource->parts()) { |
| my $dateStatus = $resource->getDateStatus($_); |
my $dateStatus = $resource->getDateStatus($_); |
|
Line 2352 Idiomatic usage of these two methods wou
|
Line 3128 Idiomatic usage of these two methods wou
|
| ... use it here ... |
... use it here ... |
| } |
} |
| |
|
| Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere. |
Which you use depends on exactly what you are looking for. The |
| |
status() function has been optimized for the nav maps display and may |
| |
not precisely match what you need elsewhere. |
| |
|
| The symbolic constants shown below can be accessed through the resource object: $res->OPEN. |
The symbolic constants shown below can be accessed through the |
| |
resource object: C<$res->OPEN>. |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are: |
=item * B<getDateStatus>($part): |
| |
|
| |
($part defaults to 0). A convenience function that returns a symbolic |
| |
constant telling you about the date status of the part. The possible |
| |
return values are: |
| |
|
| =back |
=back |
| |
|
|
Line 2366 B<Date Codes>
|
Line 3149 B<Date Codes>
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<OPEN_LATER>: The problem will be opened later. |
=item * B<OPEN_LATER>: |
| |
|
| |
The problem will be opened later. |
| |
|
| |
=item * B<OPEN>: |
| |
|
| |
Open and not yet due. |
| |
|
| |
|
| =item * B<OPEN>: Open and not yet due. |
=item * B<PAST_DUE_ANSWER_LATER>: |
| |
|
| |
The due date has passed, but the answer date has not yet arrived. |
| |
|
| =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived. |
=item * B<PAST_DUE_NO_ANSWER>: |
| |
|
| =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set. |
The due date has passed and there is no answer opening date set. |
| |
|
| =item * B<ANSWER_OPEN>: The answer date is here. |
=item * B<ANSWER_OPEN>: |
| |
|
| =item * B<NETWORK_FAILURE>: The information is unknown due to network failure. |
The answer date is here. |
| |
|
| |
=item * B<NETWORK_FAILURE>: |
| |
|
| |
The information is unknown due to network failure. |
| |
|
| =back |
=back |
| |
|
|
Line 2431 B<>
|
Line 3226 B<>
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results: |
=item * B<getCompletionStatus>($part): |
| |
|
| =back |
($part defaults to 0.) A convenience function that returns a symbolic |
| |
constant telling you about the completion status of the part, with the |
| |
following possible results: |
| |
|
| |
=back |
| |
|
| B<Completion Codes> |
B<Completion Codes> |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<NOT_ATTEMPTED>: Has not been attempted at all. |
=item * B<NOT_ATTEMPTED>: |
| |
|
| |
Has not been attempted at all. |
| |
|
| =item * B<INCORRECT>: Attempted, but wrong by student. |
=item * B<INCORRECT>: |
| |
|
| =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override. |
Attempted, but wrong by student. |
| |
|
| =item * B<CORRECT>: Correct or correct by instructor. |
=item * B<INCORRECT_BY_OVERRIDE>: |
| |
|
| =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override. |
Attempted, but wrong by instructor override. |
| |
|
| =item * B<EXCUSED>: Excused. Not yet implemented. |
=item * B<CORRECT>: |
| |
|
| =item * B<NETWORK_FAILURE>: Information not available due to network failure. |
Correct or correct by instructor. |
| |
|
| =item * B<ATTEMPTED>: Attempted, and not yet graded. |
=item * B<CORRECT_BY_OVERRIDE>: |
| |
|
| |
Correct by instructor override. |
| |
|
| |
=item * B<EXCUSED>: |
| |
|
| |
Excused. Not yet implemented. |
| |
|
| |
=item * B<NETWORK_FAILURE>: |
| |
|
| |
Information not available due to network failure. |
| |
|
| |
=item * B<ATTEMPTED>: |
| |
|
| |
Attempted, and not yet graded. |
| |
|
| =back |
=back |
| |
|
|
Line 2499 sub queryRestoreHash {
|
Line 3314 sub queryRestoreHash {
|
| |
|
| B<Composite Status> |
B<Composite Status> |
| |
|
| Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE): |
Along with directly returning the date or completion status, the |
| |
resource object includes a convenience function B<status>() that will |
| |
combine the two status tidbits into one composite status that can |
| |
represent the status of the resource as a whole. The precise logic is |
| |
documented in the comments of the status method. The following results |
| |
may be returned, all available as methods on the resource object |
| |
($res->NETWORK_FAILURE): |
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<NETWORK_FAILURE>: The network has failed and the information is not available. |
=item * B<NETWORK_FAILURE>: |
| |
|
| |
The network has failed and the information is not available. |
| |
|
| |
=item * B<NOTHING_SET>: |
| |
|
| |
No dates have been set for this problem (part) at all. (Because only |
| |
certain parts of a multi-part problem may be assigned, this can not be |
| |
collapsed into "open later", as we do not know a given part will EVER |
| |
be opened. For single part, this is the same as "OPEN_LATER".) |
| |
|
| =item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".) |
=item * B<CORRECT>: |
| |
|
| =item * B<CORRECT>: For any reason at all, the part is considered correct. |
For any reason at all, the part is considered correct. |
| |
|
| =item * B<EXCUSED>: For any reason at all, the problem is excused. |
=item * B<EXCUSED>: |
| |
|
| =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set. |
For any reason at all, the problem is excused. |
| |
|
| =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set. |
=item * B<PAST_DUE_NO_ANSWER>: |
| |
|
| =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available. |
The problem is past due, not considered correct, and no answer date is |
| |
set. |
| |
|
| =item * B<OPEN_LATER>: The problem is not yet open. |
=item * B<PAST_DUE_ANSWER_LATER>: |
| |
|
| =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left. |
The problem is past due, not considered correct, and an answer date in |
| |
the future is set. |
| |
|
| =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer. |
=item * B<ANSWER_OPEN>: |
| |
|
| =item * B<OPEN>: The item is open and not yet tried. |
The problem is past due, not correct, and the answer is now available. |
| |
|
| =item * B<ATTEMPTED>: The problem has been attempted. |
=item * B<OPEN_LATER>: |
| |
|
| |
The problem is not yet open. |
| |
|
| |
=item * B<TRIES_LEFT>: |
| |
|
| |
The problem is open, has been tried, is not correct, but there are |
| |
tries left. |
| |
|
| |
=item * B<INCORRECT>: |
| |
|
| |
The problem is open, and all tries have been used without getting the |
| |
correct answer. |
| |
|
| |
=item * B<OPEN>: |
| |
|
| |
The item is open and not yet tried. |
| |
|
| |
=item * B<ATTEMPTED>: |
| |
|
| |
The problem has been attempted. |
| |
|
| =back |
=back |
| |
|
|
Line 2603 sub status {
|
Line 3455 sub status {
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. |
=item * B<getNext>(): |
| |
|
| |
Retreive an array of the possible next resources after this |
| |
one. Always returns an array, even in the one- or zero-element case. |
| |
|
| =item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. |
=item * B<getPrevious>(): |
| |
|
| |
Retreive an array of the possible previous resources from this |
| |
one. Always returns an array, even in the one- or zero-element case. |
| |
|
| =cut |
=cut |
| |
|
|
Line 2618 sub getNext {
|
Line 3476 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 = $self->{BROWSE_PRIV}; |
|
| if (!defined($browsePriv)) { |
|
| $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
| $self->{BROWSE_PRIV} = $browsePriv; |
|
| } |
|
| if (!($browsePriv ne '2' && $browsePriv ne 'F')) { |
|
| push @branches, $next; |
|
| } |
|
| } |
} |
| return \@branches; |
return \@branches; |
| } |
} |
|
Line 2641 sub getPrevious {
|
Line 3490 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 = $self->{BROWSE_PRIV}; |
|
| if (!defined($browsePriv)) { |
|
| $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
| $self->{BROWSE_PRIV} = $browsePriv; |
|
| } |
|
| 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