Annotation of loncom/interface/lonnavmaps.pm, revision 1.119
1.72 bowersj2 1:
1.2 www 2: # The LearningOnline Network with CAPA
3: # Navigate Maps Handler
1.1 www 4: #
1.118 bowersj2 5: # $Id: lonnavmaps.pm,v 1.117 2002/11/26 17:01:29 bowersj2 Exp $
1.20 albertel 6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
1.2 www 29: # (Page Handler
1.1 www 30: #
1.2 www 31: # (TeX Content Handler
1.1 www 32: #
1.2 www 33: # 05/29/00,05/30 Gerd Kortemeyer)
34: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
35: # 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
1.1 www 36: #
1.17 www 37: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
1.21 www 38: # YEAR=2002
39: # 1/1 Gerd Kortemeyer
1.105 bowersj2 40: # Oct-Nov Jeremy Bowers
1.2 www 41:
1.1 www 42: package Apache::lonnavmaps;
43:
44: use strict;
1.2 www 45: use Apache::Constants qw(:common :http);
1.18 albertel 46: use Apache::loncommon();
1.73 bowersj2 47: use POSIX qw (floor strftime);
1.2 www 48:
1.1 www 49: sub handler {
1.99 bowersj2 50: my $r = shift;
1.118 bowersj2 51: real_handler($r);
52: }
53:
54: sub real_handler {
55: my $r = shift;
1.2 www 56:
1.51 bowersj2 57: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
58:
59: # Handle header-only request
60: if ($r->header_only) {
61: if ($ENV{'browser.mathml'}) {
62: $r->content_type('text/xml');
63: } else {
64: $r->content_type('text/html');
65: }
66: $r->send_http_header;
67: return OK;
68: }
69:
70: # Send header, don't cache this page
71: if ($ENV{'browser.mathml'}) {
72: $r->content_type('text/xml');
73: } else {
74: $r->content_type('text/html');
75: }
76: &Apache::loncommon::no_cache($r);
77: $r->send_http_header;
78:
1.106 bowersj2 79: # Create the nav map
1.51 bowersj2 80: my $navmap = Apache::lonnavmaps::navmap->new(
81: $ENV{"request.course.fn"}.".db",
1.80 bowersj2 82: $ENV{"request.course.fn"}."_parms.db", 1, 1);
1.51 bowersj2 83:
1.55 bowersj2 84:
85: if (!defined($navmap)) {
86: my $requrl = $r->uri;
87: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
88: return HTTP_NOT_ACCEPTABLE;
89: }
1.64 bowersj2 90:
1.111 bowersj2 91: $r->print("<html><head>\n");
1.118 bowersj2 92: $r->print("<title>Navigate Course Contents</title></head>");
1.111 bowersj2 93:
1.64 bowersj2 94: # Header
1.111 bowersj2 95: $r->print(&Apache::loncommon::bodytag('Navigate Course Contents','',
1.64 bowersj2 96: ''));
97: $r->print('<script>window.focus();</script>');
1.101 bowersj2 98:
1.95 bowersj2 99: $r->print('<table border="0" cellpadding="2" cellspacing="0">');
1.64 bowersj2 100: my $date=localtime;
1.95 bowersj2 101: $r->print('<tr><td align="right" valign="bottom">Key: </td>');
1.101 bowersj2 102:
103: # Print discussions and feedback header
1.65 bowersj2 104: if ($navmap->{LAST_CHECK}) {
1.95 bowersj2 105: $r->print('<td align="center" valign="bottom"> '.
106: '<img src="/adm/lonMisc/chat.gif"> New discussion since '.
1.73 bowersj2 107: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1.95 bowersj2 108: '</td><td align="center" valign="bottom"> '.
109: '<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'.
110: '</td>');
111: } else {
112: $r->print('<td align="center" valign="bottom"> '.
113: '<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'.
114: ' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'.
115: '</td>');
116: }
117: $r->print('</tr></table>');
1.101 bowersj2 118:
1.95 bowersj2 119: my $condition = 0;
120: if ($ENV{'form.condition'}) {
121: $condition = 1;
122: }
123:
1.118 bowersj2 124: # Determine where the "here" marker is and where the screen jumps to.
125: my $SYMB = 1; my $URL = 2; my $NOTHING = 3; # symbolic constants
126: my $hereType; # the type of marker, $SYMB, $URL, or $NOTHING
127: my $here; # the actual URL or SYMB for the here marker
128: my $jumpType; # The type of the thing we have a jump for, $SYMB or $URL
129: my $jump; # the SYMB/URL of the resource we need to jump to
130:
131: if ( $ENV{'form.alreadyHere'} ) { # we came from a user's manipulation of the nav page
132: # If this is a click on a folder or something, we want to preserve the "here"
133: # from the querystring, and get the new "jump" marker
134: $hereType = $ENV{'form.hereType'};
135: $here = $ENV{'form.here'};
136: $jumpType = $ENV{'form.jumpType'} || $NOTHING;
137: $jump = $ENV{'form.jump'};
138: } else { # the user is visiting the nav map from the remote
139: # We're coming from the remote. We have either a url, a symb, or nothing,
140: # and we need to figure out what.
141: # Preference: Symb
142:
143: if ($ENV{'form.symb'}) {
144: $hereType = $jumpType = $SYMB;
145: $here = $jump = $ENV{'form.symb'};
146: } elsif ($ENV{'form.postdata'}) {
147: # couldn't find a symb, is there a URL?
148: my $currenturl = $ENV{'form.postdata'};
149: $currenturl=~s/^http\:\/\///;
150: $currenturl=~s/^[^\/]+//;
151:
152: $hereType = $jumpType = $URL;
153: $here = $jump = $currenturl;
154: } else {
155: # Nothing
156: $hereType = $jumpType = $NOTHING;
157: }
158: }
1.110 bowersj2 159:
1.118 bowersj2 160:
1.110 bowersj2 161: # alreadyHere allows us to only open the maps necessary to view
162: # the current location once, while at the same time remembering
163: # the current location. Without that check, the user would never
164: # be able to close those maps; the user would close it, and the
165: # currenturl scan would re-open it.
1.118 bowersj2 166: my $queryAdd = "&alreadyHere=1";
1.110 bowersj2 167:
1.95 bowersj2 168: if ($condition) {
1.118 bowersj2 169: $r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" .
170: "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
171: "\">Close All Folders</a>");
1.65 bowersj2 172: } else {
1.118 bowersj2 173: $r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" .
174: "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
175: "\">Open All Folders</a>");
1.65 bowersj2 176: }
1.55 bowersj2 177:
1.95 bowersj2 178: $r->print('<br> ');
179: $r->rflush();
180:
1.92 bowersj2 181: # Now that we've displayed some stuff to the user, init the navmap
182: $navmap->init();
183:
1.55 bowersj2 184: # Check that it's defined
185: if (!($navmap->courseMapDefined())) {
186: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
187: '</body></html>');
188: return OK;
189: }
190:
1.51 bowersj2 191: # Grab a resource object so we have access to the constants; this
192: # is technically not proper, but should be harmless
193: my $res = $navmap->firstResource();
194:
1.101 bowersj2 195: # These are some data tables, which make it easy to change some of
196: # of the specific visualization parameters if desired.
197:
1.51 bowersj2 198: # Defines a status->color mapping, null string means don't color
199: my %colormap =
1.54 bowersj2 200: ( $res->NETWORK_FAILURE => '',
1.59 bowersj2 201: $res->CORRECT => '',
1.112 bowersj2 202: $res->EXCUSED => '#3333FF',
1.59 bowersj2 203: $res->PAST_DUE_ANSWER_LATER => '',
204: $res->PAST_DUE_NO_ANSWER => '',
1.112 bowersj2 205: $res->ANSWER_OPEN => '#006600',
1.54 bowersj2 206: $res->OPEN_LATER => '',
1.59 bowersj2 207: $res->TRIES_LEFT => '',
208: $res->INCORRECT => '',
209: $res->OPEN => '',
1.54 bowersj2 210: $res->NOTHING_SET => '' );
1.59 bowersj2 211: # And a special case in the nav map; what to do when the assignment
212: # is not yet done and due in less then 24 hours
1.86 bowersj2 213: my $hurryUpColor = "#FF0000";
1.59 bowersj2 214:
1.115 bowersj2 215: # Keep these mappings in sync with lonquickgrades, which uses the colors
216: # instead of the icons.
1.59 bowersj2 217: my %statusIconMap =
1.66 bowersj2 218: ( $res->NETWORK_FAILURE => '',
219: $res->NOTHING_SET => '',
220: $res->CORRECT => 'navmap.correct.gif',
221: $res->EXCUSED => 'navmap.correct.gif',
222: $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
223: $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
224: $res->ANSWER_OPEN => 'navmap.wrong.gif',
225: $res->OPEN_LATER => '',
226: $res->TRIES_LEFT => 'navmap.open.gif',
227: $res->INCORRECT => 'navmap.wrong.gif',
1.69 bowersj2 228: $res->OPEN => 'navmap.open.gif',
1.85 bowersj2 229: $res->ATTEMPTED => 'navmap.open.gif' );
1.69 bowersj2 230:
231: my %iconAltTags =
232: ( 'navmap.correct.gif' => 'Correct',
233: 'navmap.wrong.gif' => 'Incorrect',
234: 'navmap.open.gif' => 'Open' );
1.59 bowersj2 235:
236: my %condenseStatuses =
1.66 bowersj2 237: ( $res->NETWORK_FAILURE => 1,
238: $res->NOTHING_SET => 1,
239: $res->CORRECT => 1 );
1.51 bowersj2 240:
241: my %filterHash;
242: # Figure out what we're not displaying
243: foreach (split(/\,/, $ENV{"form.filter"})) {
244: if ($_) {
245: $filterHash{$_} = "1";
246: }
247: }
248:
1.88 bowersj2 249: # Is this a new-style course? If so, we want to suppress showing the top-level
250: # maps in their own folders, in favor of "inlining" them.
251: my $topResource = $navmap->getById("0.0");
1.63 bowersj2 252:
1.51 bowersj2 253: # Begin the HTML table
1.59 bowersj2 254: # four cols: resource + indent, chat+feedback, icon, text string
1.85 bowersj2 255: $r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n");
1.51 bowersj2 256:
1.74 bowersj2 257: # This needs to be updated to use symbs from the remote,
258: # instead of uris. The changes to this and the main rendering
259: # loop should be obvious.
260: # Here's a simple example of the iterator.
1.88 bowersj2 261: # Preprocess the map: Look for current URL, force inlined maps to display
262:
1.118 bowersj2 263: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1.88 bowersj2 264: my $found = 0;
265: my $depth = 1;
1.118 bowersj2 266: my $currentJumpIndex = 0; # keeps track of when the current resource is found,
1.91 bowersj2 267: # so we can back up a few and put the anchor above the
268: # current resource
1.118 bowersj2 269: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1.101 bowersj2 270: # before the current resource when using #current
1.88 bowersj2 271: $mapIterator->next(); # discard the first BEGIN_MAP
272: my $curRes = $mapIterator->next();
1.91 bowersj2 273: my $counter = 0;
1.118 bowersj2 274: my $foundJump = ($jumpType == $NOTHING); # look for jump point if we have one
275: my $looped = 0;
1.116 bowersj2 276:
1.119 ! bowersj2 277: $r->print($hereType);
! 278:
1.116 bowersj2 279: # We only need to do this if we need to open the maps to show the
1.118 bowersj2 280: # current position. This will change the counter so we can't count
281: # for the jump marker with this loop.
1.116 bowersj2 282: while ($depth > 0 && !$ENV{'form.alreadyHere'}) {
1.96 bowersj2 283: if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
284: if ($curRes == $mapIterator->END_MAP()) { $depth--; }
1.119 ! bowersj2 285: $r->print($curRes . ' ');
1.118 bowersj2 286: if (ref($curRes) && !$ENV{'form.alreadyHere'} &&
287: ($hereType == $SYMB && $curRes->symb() eq $here) ||
1.119 ! bowersj2 288: (ref($curRes) && $hereType == $URL && $curRes->src() eq $here)) {
1.118 bowersj2 289: my $mapStack = $mapIterator->getStack();
290:
291: # Ensure the parent maps are open
292: for my $map (@{$mapStack}) {
293: if ($condition) {
294: undef $filterHash{$map->map_pc()};
295: } else {
296: $filterHash{$map->map_pc()} = 1;
297: }
298: }
299: $ENV{'form.alreadyHere'} = 1;
300: }
301: $looped = 1;
302:
303: $curRes = $mapIterator->next();
304: }
305:
306: $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0);
307: $depth = 1;
308: $mapIterator->next();
309: $curRes = $mapIterator->next();
1.88 bowersj2 310:
1.118 bowersj2 311: while ($depth > 0 && !$foundJump) {
312: if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
313: if ($curRes == $mapIterator->END_MAP()) { $depth--; }
1.91 bowersj2 314: if (ref($curRes)) { $counter++; }
315:
1.118 bowersj2 316: if (ref($curRes) &&
317: (($jumpType == $SYMB && $curRes->symb() eq $jump) ||
318: ($jumpType == $URL && $curRes->src() eq $jump))) {
1.88 bowersj2 319: # If this is the correct resource, be sure to
320: # show it by making sure the containing maps
321: # are open.
1.91 bowersj2 322:
1.101 bowersj2 323: # This is why we have to use the main iterator instead of the
324: # potentially faster DFS: The count has to be the same, so
325: # the order has to be the same, which DFS won't give us.
1.118 bowersj2 326: $currentJumpIndex = $counter;
327: $foundJump = 1;
1.88 bowersj2 328: }
1.118 bowersj2 329:
1.88 bowersj2 330: $curRes = $mapIterator->next();
1.74 bowersj2 331: }
1.88 bowersj2 332:
1.53 bowersj2 333: undef $res; # so we don't accidentally use it later
1.72 bowersj2 334: my $indentLevel = 0;
1.61 bowersj2 335: my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";
1.51 bowersj2 336:
337: my $isNewBranch = 0;
1.59 bowersj2 338: my $now = time();
339: my $in24Hours = $now + 24 * 60 * 60;
1.78 bowersj2 340: my $displayedHereMarker = 0;
1.118 bowersj2 341: my $displayedJumpMarker = 0;
1.88 bowersj2 342:
1.72 bowersj2 343: # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
344: # code in iterator->next), so ignore the first one
1.89 bowersj2 345: $mapIterator = $navmap->getIterator(undef, undef, \%filterHash,
1.74 bowersj2 346: $condition);
1.72 bowersj2 347: $mapIterator->next();
1.89 bowersj2 348: $curRes = $mapIterator->next();
1.90 bowersj2 349: $depth = 1;
1.88 bowersj2 350:
351: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
352: my $rowNum = 0;
1.51 bowersj2 353:
1.91 bowersj2 354: $counter = 0;
355:
1.72 bowersj2 356: while ($depth > 0) {
1.51 bowersj2 357: if ($curRes == $mapIterator->BEGIN_MAP() ||
1.52 bowersj2 358: $curRes == $mapIterator->BEGIN_BRANCH()) {
1.51 bowersj2 359: $indentLevel++;
360: }
361: if ($curRes == $mapIterator->END_MAP() ||
1.52 bowersj2 362: $curRes == $mapIterator->END_BRANCH()) {
1.51 bowersj2 363: $indentLevel--;
364: }
1.52 bowersj2 365: if ($curRes == $mapIterator->BEGIN_BRANCH()) {
366: $isNewBranch = 1;
1.72 bowersj2 367: }
1.96 bowersj2 368: if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
369: if ($curRes == $mapIterator->END_MAP()) { $depth--; }
1.51 bowersj2 370:
1.91 bowersj2 371: if (ref($curRes)) { $counter++; }
372:
1.101 bowersj2 373: # Is this resource being ignored because it is in a random-out
374: # map and it was not selected?
1.68 bowersj2 375: if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
376: $curRes = $mapIterator->next();
1.101 bowersj2 377: next; # if yes, then just ignore this resource
1.68 bowersj2 378: }
379:
1.116 bowersj2 380: if (ref($curRes)) {
1.51 bowersj2 381:
1.113 bowersj2 382: my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon
383:
1.116 bowersj2 384: if ($indentLevel - $deltalevel < 0) {
1.113 bowersj2 385: # If this would be at a negative depth (top-level maps in
386: # new-style courses, we want to suppress their title display)
387: # then ignore it.
388: $curRes = $mapIterator->next();
389: next;
390: }
391:
1.66 bowersj2 392: # Step one: Decide which parts to show
393: my @parts = @{$curRes->parts()};
394: my $multipart = scalar(@parts) > 1;
395: my $condensed = 0;
396:
1.51 bowersj2 397: if ($curRes->is_problem()) {
1.101 bowersj2 398:
1.66 bowersj2 399: # Is it multipart?
400: if ($multipart) {
401: # If it's multipart, see if part 0 is "open"
402: # if it is, display all parts, if it isn't,
403: # just display first
404: if (!$curRes->opendate("0")) {
1.101 bowersj2 405: # no parts are open, display as one part
406: @parts = ("0");
1.68 bowersj2 407: $condensed = 1;
1.66 bowersj2 408: } else {
409: # Otherwise, only display part 0 if we want to
410: # attach feedback or email information to it
411: if ($curRes->hasDiscussion() || $curRes->getFeedback()) {
412: shift @parts;
413: } else {
414: # Now, we decide whether to condense the
415: # parts due to similarity
416: my $status = $curRes->status($parts[1]);
417: my $due = $curRes->duedate($parts[1]);
418: my $open = $curRes->opendate($parts[1]);
419: my $statusAllSame = 1;
420: my $dueAllSame = 1;
421: my $openAllSame = 1;
422: for (my $i = 2; $i < scalar(@parts); $i++) {
423: if ($curRes->status($parts[$i]) != $status){
424: $statusAllSame = 0;
425: }
426: if ($curRes->duedate($parts[$i]) != $due ) {
427: $dueAllSame = 0;
428: }
429: if ($curRes->opendate($parts[$i]) != $open) {
430: $openAllSame = 0;
431: }
432: }
433:
434: # $allSame is true if all the statuses were
435: # the same. Now, if they are all the same and
436: # match one of the statuses to condense, or they
437: # are all open with the same due date, or they are
438: # all OPEN_LATER with the same open date, display the
439: # status of the first non-zero part (to get the 'correct'
440: # status right, since 0 is never 'correct' or 'open').
441: if (($statusAllSame && defined($condenseStatuses{$status})) ||
442: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
443: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
444: @parts = ($parts[1]);
445: $condensed = 1;
446: }
447: }
448: }
449: }
1.59 bowersj2 450:
1.51 bowersj2 451: } else {
1.84 bowersj2 452: $parts[0] = "0"; # this is to get past foreach loop below
1.51 bowersj2 453: # you can consider a non-problem resource as a resource
1.101 bowersj2 454: # with only one part without loss, and it simplifies the looping
1.51 bowersj2 455: }
456:
1.83 bowersj2 457: # Is it a multipart problem with a single part, now in
1.101 bowersj2 458: # @parts with "0" filtered out? If so, 'forget' it's a multi-part
1.83 bowersj2 459: # problem and treat it like a single-part problem.
460: if ( scalar(@parts) == 1 ) {
461: $multipart = 0;
462: }
463:
1.66 bowersj2 464: # Display one part, in event of network error.
465: # If this is a single part, we can at least show the correct
1.101 bowersj2 466: # status, but if it's multipart, we're lost, since we can't
467: # retreive the metadata to count the parts
1.66 bowersj2 468: if ($curRes->{RESOURCE_ERROR}) {
469: @parts = ("0");
470: }
471:
1.101 bowersj2 472: # Step Two: Print the actual data.
473:
474: # For each part we intend to display...
1.51 bowersj2 475: foreach my $part (@parts) {
1.59 bowersj2 476:
1.68 bowersj2 477: my $nonLinkedText = ""; # unlinked stuff after title
1.51 bowersj2 478:
479: my $stack = $mapIterator->getStack();
480: my $src = getLinkForResource($stack);
481:
1.101 bowersj2 482: # Pass the correct symb on the querystring, so the
483: # remote will figure out where we are if we click a link
1.51 bowersj2 484: my $srcHasQuestion = $src =~ /\?/;
485: my $link = $src.
486: ($srcHasQuestion?'&':'?') .
487: 'symb='.&Apache::lonnet::escape($curRes->symb()).
488: '"';
1.101 bowersj2 489:
1.106 bowersj2 490: my $title = $curRes->compTitle();
1.51 bowersj2 491: my $partLabel = "";
1.52 bowersj2 492: my $newBranchText = "";
493:
494: # If this is a new branch, label it so
495: if ($isNewBranch) {
1.59 bowersj2 496: $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
1.52 bowersj2 497: $isNewBranch = 0;
498: }
1.51 bowersj2 499:
500: # links to open and close the folders
501: my $linkopen = "<a href=\"$link\">";
502: my $linkclose = "</a>";
503:
1.61 bowersj2 504: my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
1.51 bowersj2 505: if ($curRes->is_problem()) {
1.66 bowersj2 506: if ($part eq "0" || $condensed) {
507: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';
508: } else {
509: $icon = $indentString;
510: }
1.51 bowersj2 511: }
512:
513: # Display the correct icon, link to open or shut map
514: if ($curRes->is_map()) {
515: my $mapId = $curRes->map_pc();
1.82 bowersj2 516: my $nowOpen = (!defined($filterHash{$mapId}));
517: if ($condition) {$nowOpen = !$nowOpen;}
1.51 bowersj2 518: $icon = $nowOpen ?
1.77 bowersj2 519: "navmap.folder.closed.gif" : "navmap.folder.open.gif";
1.66 bowersj2 520: $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
1.52 bowersj2 521: $linkopen = "<a href=\"/adm/navmaps?filter=";
1.66 bowersj2 522: $linkopen .= ($nowOpen xor $condition) ?
1.51 bowersj2 523: addToFilter(\%filterHash, $mapId) :
524: removeFromFilter(\%filterHash, $mapId);
1.118 bowersj2 525: $linkopen .= "&condition=$condition&$queryAdd" .
526: "&hereType=$hereType&here=" .
527: Apache::lonnet::escape($here) . "&jumpType=$SYMB&" .
528: "jump=" . Apache::lonnet::escape($curRes->symb()) ."\">";
1.51 bowersj2 529: $linkclose = "</a>";
1.68 bowersj2 530:
1.51 bowersj2 531: }
532:
533: my $colorizer = "";
1.86 bowersj2 534: my $color;
1.51 bowersj2 535: if ($curRes->is_problem()) {
1.115 bowersj2 536: $color = $colormap{$curRes->status};
1.74 bowersj2 537:
1.115 bowersj2 538: if (dueInLessThen24Hours($curRes, $part) ||
539: lastTry($curRes, $part)) {
1.79 bowersj2 540: $color = $hurryUpColor;
541: }
1.115 bowersj2 542:
1.51 bowersj2 543: if ($color ne "") {
544: $colorizer = "bgcolor=\"$color\"";
545: }
546: }
547:
1.68 bowersj2 548: if ($curRes->randomout()) {
549: $nonLinkedText .= ' <i>(hidden)</i> ';
550: }
551:
1.88 bowersj2 552: $rowNum++;
553: my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)];
554:
1.91 bowersj2 555: # FIRST COL: The resource indentation, branch icon, name, and anchor
1.116 bowersj2 556: $r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\">\n");
1.51 bowersj2 557:
1.101 bowersj2 558: # Print the anchor if necessary
1.118 bowersj2 559: if ($counter == $currentJumpIndex - $currentJumpDelta ) {
560: $r->print('<a name="curloc" />');
561: $displayedJumpMarker = 1;
1.91 bowersj2 562: }
563:
1.51 bowersj2 564: # print indentation
1.116 bowersj2 565: for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
1.51 bowersj2 566: $r->print($indentString);
567: }
568:
1.61 bowersj2 569: $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");
1.51 bowersj2 570:
1.74 bowersj2 571: my $curMarkerBegin = "";
572: my $curMarkerEnd = "";
573:
574: # Is this the current resource?
1.118 bowersj2 575: if (!$displayedHereMarker &&
576: (($hereType == $SYMB && $curRes->symb eq $here) ||
577: ($hereType == $URL && $curRes->src eq $here))) {
578: $curMarkerBegin = '<font color="red" size="+2">> </font>';
1.74 bowersj2 579: $curMarkerEnd = '<font color="red" size="+2"> <</font>';
1.78 bowersj2 580: $displayedHereMarker = 1;
1.74 bowersj2 581: }
582:
1.69 bowersj2 583: if ($curRes->is_problem() && $part ne "0" && !$condensed) {
1.66 bowersj2 584: $partLabel = " (Part $part)";
585: $title = "";
586: }
1.83 bowersj2 587: if ($multipart && $condensed) {
1.68 bowersj2 588: $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
1.66 bowersj2 589: }
1.59 bowersj2 590:
1.74 bowersj2 591: $r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");
1.66 bowersj2 592:
1.118 bowersj2 593: #if ($curRes->{RESOURCE_ERROR}) {
594: # $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
595: # '<font size="-1">Host down</font>'));
596: # }
1.66 bowersj2 597:
1.113 bowersj2 598: $r->print("</td>\n");
599:
1.101 bowersj2 600: # SECOND COL: Is there text, feedback, errors??
1.66 bowersj2 601: my $discussionHTML = ""; my $feedbackHTML = "";
602:
603: if ($curRes->hasDiscussion()) {
604: $discussionHTML = $linkopen .
605: '<img border="0" src="/adm/lonMisc/chat.gif" />' .
606: $linkclose;
607: }
608:
609: if ($curRes->getFeedback()) {
610: my $feedback = $curRes->getFeedback();
611: foreach (split(/\,/, $feedback)) {
612: if ($_) {
613: $feedbackHTML .= ' <a href="/adm/email?display='
614: . &Apache::lonnet::escape($_) . '">'
615: . '<img src="/adm/lonMisc/feedback.gif" '
616: . 'border="0" /></a>';
617: }
618: }
619: }
620:
1.84 bowersj2 621: $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>");
1.66 bowersj2 622:
623: # Is this the first displayed part of a multi-part problem
624: # that has not been condensed, so we should suppress these two
1.101 bowersj2 625: # columns so we don't display useless status info about part
626: # "0"?
1.66 bowersj2 627: my $firstDisplayed = !$condensed && $multipart && $part eq "0";
628:
1.69 bowersj2 629: # THIRD COL: Problem status icon
1.66 bowersj2 630: if ($curRes->is_problem() &&
631: !$firstDisplayed) {
632: my $icon = $statusIconMap{$curRes->status($part)};
1.69 bowersj2 633: my $alt = $iconAltTags{$icon};
1.66 bowersj2 634: if ($icon) {
1.84 bowersj2 635: $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");
1.66 bowersj2 636: } else {
1.84 bowersj2 637: $r->print("<td width=\"30\"> </td>\n");
1.66 bowersj2 638: }
639: } else { # not problem, no icon
1.84 bowersj2 640: $r->print("<td width=\"30\"> </td>\n");
1.66 bowersj2 641: }
642:
1.69 bowersj2 643: # FOURTH COL: Text description
1.86 bowersj2 644: $r->print("<td align=\"right\" valign=\"center\">\n");
1.51 bowersj2 645:
1.61 bowersj2 646: if ($curRes->kind() eq "res" &&
647: $curRes->is_problem() &&
1.66 bowersj2 648: !$firstDisplayed) {
1.86 bowersj2 649: $r->print ("<font color=\"$color\"><b>") if ($color);
1.53 bowersj2 650: $r->print (getDescription($curRes, $part));
1.86 bowersj2 651: $r->print ("</b></font>") if ($color);
1.51 bowersj2 652: }
1.68 bowersj2 653: if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
654: $r->print('(randomly select ' . $curRes->randompick() .')');
655: }
1.59 bowersj2 656:
1.84 bowersj2 657: $r->print(" </td></tr>\n");
1.113 bowersj2 658:
659: if (!($counter % 20)) { $r->rflush(); }
660: if ($counter == 2) { $r->rflush(); }
1.51 bowersj2 661: }
662: }
663: $curRes = $mapIterator->next();
664: }
665:
1.118 bowersj2 666: $r->print("</table>");
667:
668: # Print out the part that jumps to #curloc if it exists
669: if ($displayedJumpMarker) {
670: $r->print('<script>location += "#curloc";</script>');
671: }
672:
673: $r->print("</body></html>");
1.51 bowersj2 674:
1.59 bowersj2 675: $navmap->untieHashes();
676:
1.51 bowersj2 677: return OK;
678: }
679:
680: # Convenience functions: Returns a string that adds or subtracts
681: # the second argument from the first hash, appropriate for the
682: # query string that determines which folders to recurse on
683: sub addToFilter {
684: my $hashIn = shift;
685: my $addition = shift;
686: my %hash = %$hashIn;
687: $hash{$addition} = 1;
688:
689: return join (",", keys(%hash));
690: }
691:
692: sub removeFromFilter {
693: my $hashIn = shift;
694: my $subtraction = shift;
695: my %hash = %$hashIn;
696:
697: delete $hash{$subtraction};
698: return join(",", keys(%hash));
699: }
700:
701: # Convenience function: Given a stack returned from getStack on the iterator,
702: # return the correct src() value.
703: # Later, this should add an anchor when we start putting anchors in pages.
704: sub getLinkForResource {
705: my $stack = shift;
706: my $res;
707:
708: # Check to see if there are any pages in the stack
709: foreach $res (@$stack) {
710: if (defined($res) && $res->is_page()) {
711: return $res->src();
712: }
713: }
714:
715: # Failing that, return the src of the last resource that is defined
716: # (when we first recurse on a map, it puts an undefined resource
717: # on the bottom because $self->{HERE} isn't defined yet, and we
718: # want the src for the map anyhow)
719: foreach (@$stack) {
720: if (defined($_)) { $res = $_; }
721: }
722:
723: return $res->src();
724: }
725:
1.53 bowersj2 726: # Convenience function: This seperates the logic of how to create
727: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
728: # etc.) into a seperate function. It takes a resource object as the
729: # first parameter, and the part number of the resource as the second.
730: # It's basically a big switch statement on the status of the resource.
731:
732: sub getDescription {
733: my $res = shift;
734: my $part = shift;
1.69 bowersj2 735: my $status = $res->status($part);
1.53 bowersj2 736:
737: if ($status == $res->NETWORK_FAILURE) { return ""; }
738: if ($status == $res->NOTHING_SET) {
739: return "Not currently assigned.";
740: }
741: if ($status == $res->OPEN_LATER) {
1.73 bowersj2 742: return "Open " . timeToHumanString($res->opendate($part));
1.53 bowersj2 743: }
744: if ($status == $res->OPEN) {
1.79 bowersj2 745: if ($res->duedate($part)) {
1.73 bowersj2 746: return "Due " . timeToHumanString($res->duedate($part));
1.66 bowersj2 747: } else {
748: return "Open, no due date";
749: }
1.53 bowersj2 750: }
1.54 bowersj2 751: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.73 bowersj2 752: return "Answer open " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 753: }
754: if ($status == $res->PAST_DUE_NO_ANSWER) {
1.73 bowersj2 755: return "Was due " . timeToHumanString($res->duedate($part));
1.53 bowersj2 756: }
757: if ($status == $res->ANSWER_OPEN) {
758: return "Answer available";
759: }
1.59 bowersj2 760: if ($status == $res->EXCUSED) {
1.66 bowersj2 761: return "Excused by instructor";
1.59 bowersj2 762: }
1.69 bowersj2 763: if ($status == $res->ATTEMPTED) {
764: return "Not yet graded.";
765: }
1.59 bowersj2 766: if ($status == $res->TRIES_LEFT) {
1.79 bowersj2 767: my $tries = $res->tries($part);
768: my $maxtries = $res->maxtries($part);
769: my $triesString = "";
770: if ($tries && $maxtries) {
771: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
772: if ($maxtries > 1 && $maxtries - $tries == 1) {
773: $triesString = "<b>$triesString</b>";
774: }
775: }
1.66 bowersj2 776: if ($res->duedate()) {
1.73 bowersj2 777: return "Due " . timeToHumanString($res->duedate($part)) .
1.66 bowersj2 778: " $triesString";
779: } else {
780: return "No due date $triesString";
781: }
1.59 bowersj2 782: }
1.53 bowersj2 783: }
784:
1.115 bowersj2 785: # Convenience function, so others can use it: Is the problem due in less then
786: # 24 hours, and still can be done?
787:
788: sub dueInLessThen24Hours {
789: my $res = shift;
790: my $part = shift;
791: my $status = $res->status($part);
792:
793: return ($status == $res->OPEN() || $status == $res->ATTEMPTED() ||
794: $status == $res->TRIES_LEFT()) &&
795: $res->duedate() && $res->duedate() < time()+(24*60*60) &&
796: $res->duedate() > time();
797: }
798:
799: # Convenience function, so others can use it: Is there only one try remaining for the
800: # part, with more then one try to begin with, not due yet and still can be done?
801: sub lastTry {
802: my $res = shift;
803: my $part = shift;
804:
805: my $tries = $res->tries($part);
806: my $maxtries = $res->maxtries($part);
807: return $tries && $maxtries && $maxtries > 1 &&
808: $maxtries - $tries == 1 && $res->duedate() &&
809: $res->duedate() > time();
810: }
811:
1.101 bowersj2 812: # This puts a human-readable name on the ENV variable.
1.68 bowersj2 813: sub advancedUser {
814: return $ENV{'user.adv'};
815: }
816:
1.73 bowersj2 817:
818: # timeToHumanString takes a time number and converts it to a
819: # human-readable representation, meant to be used in the following
820: # manner:
821: # print "Due $timestring"
822: # print "Open $timestring"
823: # print "Answer available $timestring"
824: # Very, very, very, VERY English-only... goodness help a localizer on
825: # this func...
1.53 bowersj2 826: sub timeToHumanString {
1.58 albertel 827: my ($time) = @_;
828: # zero, '0' and blank are bad times
1.73 bowersj2 829: if (!$time) {
830: return 'never';
831: }
832:
833: my $now = time();
834:
835: my @time = localtime($time);
836: my @now = localtime($now);
837:
838: # Positive = future
839: my $delta = $time - $now;
840:
841: my $minute = 60;
842: my $hour = 60 * $minute;
843: my $day = 24 * $hour;
844: my $week = 7 * $day;
845: my $inPast = 0;
846:
847: # Logic in comments:
848: # Is it now? (extremely unlikely)
849: if ( $delta == 0 ) {
850: return "this instant";
851: }
852:
853: if ($delta < 0) {
854: $inPast = 1;
855: $delta = -$delta;
856: }
857:
858: if ( $delta > 0 ) {
1.101 bowersj2 859:
1.73 bowersj2 860: my $tense = $inPast ? " ago" : "";
861: my $prefix = $inPast ? "" : "in ";
1.101 bowersj2 862:
863: # Less then a minute
1.73 bowersj2 864: if ( $delta < $minute ) {
865: if ($delta == 1) { return "${prefix}1 second$tense"; }
866: return "$prefix$delta seconds$tense";
867: }
868:
1.101 bowersj2 869: # Less then an hour
1.73 bowersj2 870: if ( $delta < $hour ) {
871: # If so, use minutes
872: my $minutes = floor($delta / 60);
873: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
874: return "$prefix$minutes minutes$tense";
875: }
876:
877: # Is it less then 24 hours away? If so,
878: # display hours + minutes
879: if ( $delta < $hour * 24) {
880: my $hours = floor($delta / $hour);
881: my $minutes = floor(($delta % $hour) / $minute);
882: my $hourString = "$hours hours";
883: my $minuteString = ", $minutes minutes";
884: if ($hours == 1) {
885: $hourString = "1 hour";
886: }
887: if ($minutes == 1) {
888: $minuteString = ", 1 minute";
889: }
890: if ($minutes == 0) {
891: $minuteString = "";
892: }
893: return "$prefix$hourString$minuteString$tense";
894: }
895:
896: # Less then 5 days away, display day of the week and
897: # HH:MM
898: if ( $delta < $day * 5 ) {
1.85 bowersj2 899: my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
1.73 bowersj2 900: $timeStr =~ s/12:00 am/midnight/;
901: $timeStr =~ s/12:00 pm/noon/;
902: return ($inPast ? "last " : "next ") .
903: $timeStr;
904: }
905:
906: # Is it this year?
907: if ( $time[5] == $now[5]) {
908: # Return on Month Day, HH:MM meridian
909: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
910: $timeStr =~ s/12:00 am/midnight/;
911: $timeStr =~ s/12:00 pm/noon/;
912: return $timeStr;
913: }
914:
915: # Not this year, so show the year
916: my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
917: $timeStr =~ s/12:00 am/midnight/;
918: $timeStr =~ s/12:00 pm/noon/;
919: return $timeStr;
1.58 albertel 920: }
1.53 bowersj2 921: }
922:
1.51 bowersj2 923: 1;
924:
925: package Apache::lonnavmaps::navmap;
926:
927: =pod
928:
929: 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.
930:
931: =head1 navmap object: Encapsulating the compiled nav map
932:
933: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
934:
935: 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.
936:
937: You must obtain resource objects through the navmap object.
938:
939: =head2 Methods
940:
941: =over 4
942:
1.70 bowersj2 943: =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.
1.51 bowersj2 944:
945: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
946:
947: =cut
948:
949: use strict;
950: use GDBM_File;
951:
952: sub new {
953: # magic invocation to create a class instance
954: my $proto = shift;
955: my $class = ref($proto) || $proto;
956: my $self = {};
957:
958: $self->{NAV_HASH_FILE} = shift;
959: $self->{PARM_HASH_FILE} = shift;
960: $self->{GENERATE_COURSE_USER_OPT} = shift;
1.55 bowersj2 961: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1.51 bowersj2 962:
1.101 bowersj2 963: # Resource cache stores navmap resources as we reference them. We generate
1.51 bowersj2 964: # them on-demand so we don't pay for creating resources unless we use them.
965: $self->{RESOURCE_CACHE} = {};
966:
967: # Network failure flag, if we accessed the course or user opt and
968: # failed
969: $self->{NETWORK_FAILURE} = 0;
970:
971: # tie the nav hash
972: my %navmaphash;
973: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
974: &GDBM_READER(), 0640))) {
975: return undef;
976: }
977:
978: my %parmhash;
979: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
980: &GDBM_READER(), 0640)))
981: {
1.66 bowersj2 982: untie $self->{PARM_HASH};
1.51 bowersj2 983: return undef;
984: }
1.115 bowersj2 985:
986: # Now copy the hashes for speed (?)
987: my %realnav; my %realparm;
988: foreach (%navmaphash) { $realnav{$_} = $navmaphash{$_}; }
989: foreach (%parmhash) { $realparm{$_} = $navmaphash{$_}; }
990: $self->{NAV_HASH} = \%realnav;
991: $self->{PARM_HASH} = \%realparm;
1.51 bowersj2 992:
1.92 bowersj2 993: bless($self);
1.115 bowersj2 994: $self->untieHashes();
1.92 bowersj2 995:
996: return $self;
997: }
998:
999: sub init {
1.93 bowersj2 1000: my $self = shift;
1.92 bowersj2 1001:
1.51 bowersj2 1002: # If the course opt hash and the user opt hash should be generated,
1003: # generate them
1004: if ($self->{GENERATE_COURSE_USER_OPT}) {
1005: my $uname=$ENV{'user.name'};
1006: my $udom=$ENV{'user.domain'};
1007: my $uhome=$ENV{'user.home'};
1008: my $cid=$ENV{'request.course.id'};
1009: my $chome=$ENV{'course.'.$cid.'.home'};
1010: my ($cdom,$cnum)=split(/\_/,$cid);
1011:
1012: my $userprefix=$uname.'_'.$udom.'_';
1013:
1.99 bowersj2 1014: my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
1.51 bowersj2 1015: unless ($uhome eq 'no_host') {
1016: # ------------------------------------------------- Get coursedata (if present)
1017: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1018: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1019: ':resourcedata',$chome);
1020: if ($reply!~/^error\:/) {
1021: $courserdatas{$cid}=$reply;
1022: $courserdatas{$cid.'.last_cache'}=time;
1023: }
1024: # check to see if network failed
1025: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1026: {
1027: $self->{NETWORK_FAILURE} = 1;
1028: }
1029: }
1030: foreach (split(/\&/,$courserdatas{$cid})) {
1031: my ($name,$value)=split(/\=/,$_);
1032: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1033: &Apache::lonnet::unescape($value);
1034: }
1035: # --------------------------------------------------- Get userdata (if present)
1036: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1037: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1038: if ($reply!~/^error\:/) {
1039: $userrdatas{$uname.'___'.$udom}=$reply;
1040: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1041: }
1042: # check to see if network failed
1043: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1044: {
1045: $self->{NETWORK_FAILURE} = 1;
1046: }
1047: }
1048: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1049: my ($name,$value)=split(/\=/,$_);
1050: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1051: &Apache::lonnet::unescape($value);
1052: }
1.55 bowersj2 1053: $self->{COURSE_OPT} = \%courseopt;
1054: $self->{USER_OPT} = \%useropt;
1.51 bowersj2 1055: }
1056: }
1057:
1.55 bowersj2 1058: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
1059: my $cid=$ENV{'request.course.id'};
1060: my ($cdom,$cnum)=split(/\_/,$cid);
1061:
1062: my %emailstatus = &Apache::lonnet::dump('email_status');
1.56 bowersj2 1063: my $logoutTime = $emailstatus{'logout'};
1064: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1.55 bowersj2 1065: $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
1066: $courseLeaveTime : $logoutTime);
1.56 bowersj2 1067: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1.55 bowersj2 1068: $cdom, $cnum);
1069: my %feedback=();
1070: my %error=();
1071: my $keys = &Apache::lonnet::reply('keys:'.
1072: $ENV{'user.domain'}.':'.
1073: $ENV{'user.name'}.':nohist_email',
1074: $ENV{'user.home'});
1075:
1076: foreach my $msgid (split(/\&/, $keys)) {
1077: $msgid=&Apache::lonnet::unescape($msgid);
1078: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1079: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1080: my ($what,$url)=($1,$2);
1081: my %status=
1082: &Apache::lonnet::get('email_status',[$msgid]);
1083: if ($status{$msgid}=~/^error\:/) {
1084: $status{$msgid}='';
1085: }
1086:
1087: if (($status{$msgid} eq 'new') ||
1088: (!$status{$msgid})) {
1089: if ($what eq 'Error') {
1090: $error{$url}.=','.$msgid;
1091: } else {
1092: $feedback{$url}.=','.$msgid;
1093: }
1094: }
1095: }
1096: }
1097:
1098: $self->{FEEDBACK} = \%feedback;
1099: $self->{ERROR_MSG} = \%error; # what is this? JB
1100: $self->{DISCUSSION_TIME} = \%discussiontime;
1101: $self->{EMAIL_STATUS} = \%emailstatus;
1102:
1103: }
1.84 bowersj2 1104:
1105: $self->{PARM_CACHE} = {};
1.55 bowersj2 1106: }
1.51 bowersj2 1107:
1.115 bowersj2 1108: # Internal function: Takes a key to look up in the nav hash and implements internal
1109: # memory caching of that key.
1110: sub navhash {
1111: my $self = shift; my $key = shift;
1112: return $self->{NAV_HASH}->{$key};
1113: }
1114:
1.55 bowersj2 1115: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1116: sub courseMapDefined {
1117: my $self = shift;
1118: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1119:
1.115 bowersj2 1120: my $firstres = $self->navhash("map_start_$uri");
1121: my $lastres = $self->navhash("map_finish_$uri");
1.55 bowersj2 1122: return $firstres && $lastres;
1.51 bowersj2 1123: }
1124:
1125: sub getIterator {
1126: my $self = shift;
1.98 bowersj2 1127: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.101 bowersj2 1128: shift, undef, shift);
1.51 bowersj2 1129: return $iterator;
1130: }
1131:
1132: # unties the hash when done
1133: sub untieHashes {
1134: my $self = shift;
1.60 bowersj2 1135: untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
1136: untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
1.51 bowersj2 1137: $self->{HASH_TIED} = 0;
1138: }
1139:
1140: # when the object is destroyed, be sure to untie all the hashes we tied.
1141: sub DESTROY {
1142: my $self = shift;
1143: $self->untieHashes();
1144: }
1145:
1.59 bowersj2 1146: # Private function: Does the given resource (as a symb string) have
1147: # current discussion? Returns 0 if chat/mail data not extracted.
1148: sub hasDiscussion {
1149: my $self = shift;
1150: my $symb = shift;
1151: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
1152:
1153: return $self->{DISCUSSION_TIME}->{$symb} >
1.66 bowersj2 1154: $self->{LAST_CHECK};
1.59 bowersj2 1155: }
1156:
1157: # Private function: Does the given resource (as a symb string) have
1158: # current feedback? Returns the string in the feedback hash, which
1159: # will be false if it does not exist.
1160: sub getFeedback {
1161: my $self = shift;
1162: my $symb = shift;
1163:
1164: if (!defined($self->{FEEDBACK})) { return ""; }
1165:
1166: return $self->{FEEDBACK}->{$symb};
1167: }
1168:
1.51 bowersj2 1169: =pod
1170:
1171: =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.
1172:
1173: =cut
1174:
1175: # The strategy here is to cache the resource objects, and only construct them
1176: # as we use them. The real point is to prevent reading any more from the tied
1177: # hash then we have to, which should hopefully alleviate speed problems.
1178: # Caching is just an incidental detail I throw in because it makes sense.
1179:
1180: sub getById {
1181: my $self = shift;
1182: my $id = shift;
1183:
1184: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1185: {
1186: return $self->{RESOURCE_CACHE}->{$id};
1187: }
1188:
1189: # resource handles inserting itself into cache.
1190: return Apache::lonnavmaps::resource->new($self, $id);
1191: }
1192:
1193: =pod
1194:
1195: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1196:
1197: =cut
1198:
1199: sub firstResource {
1200: my $self = shift;
1.115 bowersj2 1201: my $firstResource = $self->navhash('map_start_' .
1202: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
1.51 bowersj2 1203: return $self->getById($firstResource);
1204: }
1205:
1206: =pod
1207:
1208: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1209:
1210: =cut
1211:
1212: sub finishResource {
1213: my $self = shift;
1.115 bowersj2 1214: my $firstResource = $self->navhash('map_finish_' .
1215: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
1.51 bowersj2 1216: return $self->getById($firstResource);
1217: }
1218:
1.101 bowersj2 1219: # Parmval reads the parm hash and cascades the lookups. parmval_real does
1220: # the actual lookup; parmval caches the results.
1.51 bowersj2 1221: sub parmval {
1222: my $self = shift;
1223: my ($what,$symb)=@_;
1.84 bowersj2 1224: my $hashkey = $what."|||".$symb;
1225:
1226: if (defined($self->{PARM_CACHE}->{$hashkey})) {
1227: return $self->{PARM_CACHE}->{$hashkey};
1228: }
1229:
1230: my $result = $self->parmval_real($what, $symb);
1231: $self->{PARM_CACHE}->{$hashkey} = $result;
1232: return $result;
1233: }
1234:
1235: sub parmval_real {
1236: my $self = shift;
1237: my ($what,$symb) = @_;
1238:
1.51 bowersj2 1239: my $cid=$ENV{'request.course.id'};
1240: my $csec=$ENV{'request.course.sec'};
1241: my $uname=$ENV{'user.name'};
1242: my $udom=$ENV{'user.domain'};
1243:
1244: unless ($symb) { return ''; }
1245: my $result='';
1246:
1247: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1248:
1249: # ----------------------------------------------------- Cascading lookup scheme
1250: my $rwhat=$what;
1251: $what=~s/^parameter\_//;
1252: $what=~s/\_/\./;
1253:
1254: my $symbparm=$symb.'.'.$what;
1255: my $mapparm=$mapname.'___(all).'.$what;
1256: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1257:
1258: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1259: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1260: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1261:
1262: my $courselevel= $usercourseprefix.'.'.$what;
1263: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1264: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1265:
1266: my $useropt = $self->{USER_OPT};
1267: my $courseopt = $self->{COURSE_OPT};
1268: my $parmhash = $self->{PARM_HASH};
1269:
1270: # ---------------------------------------------------------- first, check user
1271: if ($uname and defined($useropt)) {
1.57 albertel 1272: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
1273: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
1274: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
1.51 bowersj2 1275: }
1276:
1277: # ------------------------------------------------------- second, check course
1278: if ($csec and defined($courseopt)) {
1.57 albertel 1279: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
1280: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
1281: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
1.51 bowersj2 1282: }
1283:
1284: if (defined($courseopt)) {
1.57 albertel 1285: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
1286: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
1287: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
1.51 bowersj2 1288: }
1289:
1290: # ----------------------------------------------------- third, check map parms
1291:
1292: my $thisparm=$$parmhash{$symbparm};
1.57 albertel 1293: if (defined($thisparm)) { return $thisparm; }
1.51 bowersj2 1294:
1295: # ----------------------------------------------------- fourth , check default
1296:
1297: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57 albertel 1298: if (defined($default)) { return $default}
1.51 bowersj2 1299:
1300: # --------------------------------------------------- fifth , cascade up parts
1301:
1302: my ($space,@qualifier)=split(/\./,$rwhat);
1303: my $qualifier=join('.',@qualifier);
1304: unless ($space eq '0') {
1305: my ($part,$id)=split(/\_/,$space);
1306: if ($id) {
1307: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1.57 albertel 1308: if (defined($partgeneral)) { return $partgeneral; }
1.51 bowersj2 1309: } else {
1310: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1.57 albertel 1311: if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51 bowersj2 1312: }
1313: }
1314: return '';
1315: }
1316:
1317:
1318: 1;
1319:
1320: package Apache::lonnavmaps::iterator;
1321:
1322: =pod
1323:
1324: =back
1325:
1326: =head1 navmap Iterator
1327:
1328: 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.
1329:
1330: 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:
1331:
1332: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1333:
1334: To get the next thing from the iterator, call B<next>:
1335:
1336: C<my $nextThing = $resourceIterator-E<gt>next()>
1337:
1338: getIterator behaves as follows:
1339:
1340: =over 4
1341:
1.116 bowersj2 1342: =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.
1.51 bowersj2 1343:
1.101 bowersj2 1344: 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.
1.51 bowersj2 1345:
1346: 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:
1347:
1348: =over 4
1349:
1.70 bowersj2 1350: =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
1351:
1352: =item * END_MAP: The map is now done.
1353:
1354: =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
1355:
1356: =item * END_BRANCH: The branch is now done.
1.51 bowersj2 1357:
1358: =back
1359:
1.70 bowersj2 1360: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
1361:
1.116 bowersj2 1362: 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.
1363:
1.70 bowersj2 1364: =back
1.51 bowersj2 1365:
1366: =cut
1367:
1368: # Here are the tokens for the iterator:
1369:
1370: sub BEGIN_MAP { return 1; } # begining of a new map
1371: sub END_MAP { return 2; } # end of the map
1372: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1373: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 1374: sub FORWARD { return 1; } # go forward
1375: sub BACKWARD { return 2; }
1.51 bowersj2 1376:
1.96 bowersj2 1377: sub min {
1378: (my $a, my $b) = @_;
1379: if ($a < $b) { return $a; } else { return $b; }
1380: }
1381:
1.107 bowersj2 1382: # In the CVS repository, documentation of this algorithm is included
1383: # in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1**
1384: # will reference the same location in the text as the part of the
1385: # algorithm is running through.
1386:
1.94 bowersj2 1387: sub new {
1388: # magic invocation to create a class instance
1389: my $proto = shift;
1390: my $class = ref($proto) || $proto;
1391: my $self = {};
1392:
1393: $self->{NAV_MAP} = shift;
1394: return undef unless ($self->{NAV_MAP});
1395:
1396: # Handle the parameters
1397: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1398: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1399:
1400: # If the given resources are just the ID of the resource, get the
1401: # objects
1402: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1403: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1404: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1405: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1406:
1407: $self->{FILTER} = shift;
1408:
1409: # A hash, used as a set, of resource already seen
1410: $self->{ALREADY_SEEN} = shift;
1411: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1412: $self->{CONDITION} = shift;
1413:
1.116 bowersj2 1414: # Do we want to automatically follow "redirection" maps?
1415: $self->{FORCE_TOP} = shift;
1416:
1.94 bowersj2 1417: # Now, we need to pre-process the map, by walking forward and backward
1418: # over the parts of the map we're going to look at.
1.96 bowersj2 1419:
1.97 bowersj2 1420: # The processing steps are exactly the same, except for a few small
1421: # changes, so I bundle those up in the following list of two elements:
1422: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
1423: # first_resource).
1424: # This prevents writing nearly-identical code twice.
1425: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
1426: 'FIRST_RESOURCE'],
1427: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
1428: 'FINISH_RESOURCE'] );
1429:
1.98 bowersj2 1430: my $maxDepth = 0; # tracks max depth
1431:
1.116 bowersj2 1432: # If there is only one resource in this map, and it's a map, we
1433: # want to remember that, so the user can ask for the first map
1434: # that isn't just a redirector.
1435: my $resource; my $resourceCount = 0;
1436:
1.107 bowersj2 1437: # **1**
1438:
1.97 bowersj2 1439: foreach my $pass (@iterations) {
1440: my $direction = $pass->[0];
1441: my $valName = $pass->[1];
1442: my $nextResourceMethod = $pass->[2];
1443: my $firstResourceName = $pass->[3];
1444:
1445: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
1446: $self->{FIRST_RESOURCE},
1447: $self->{FINISH_RESOURCE},
1448: {}, undef, 0, $direction);
1.96 bowersj2 1449:
1.97 bowersj2 1450: # prime the recursion
1451: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.98 bowersj2 1452: my $depth = 0;
1.97 bowersj2 1453: $iterator->next();
1454: my $curRes = $iterator->next();
1.98 bowersj2 1455: while ($depth > -1) {
1.97 bowersj2 1456: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
1457: if ($curRes == $iterator->END_MAP()) { $depth--; }
1.96 bowersj2 1458:
1.97 bowersj2 1459: if (ref($curRes)) {
1.116 bowersj2 1460: # If there's only one resource, this will save it
1.117 bowersj2 1461: # we have to filter empty resources from consideration here,
1462: # or even "empty", redirecting maps have two (start & finish)
1463: # or three (start, finish, plus redirector)
1464: if($direction == FORWARD && $curRes->src()) {
1465: $resource = $curRes; $resourceCount++;
1466: }
1.97 bowersj2 1467: my $resultingVal = $curRes->{DATA}->{$valName};
1468: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 1469: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 1470:
1.116 bowersj2 1471: if ($nextCount == 1) { # **3**
1.97 bowersj2 1472: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
1473: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
1474: }
1475:
1.116 bowersj2 1476: if ($nextCount > 1) { # **4**
1.97 bowersj2 1477: foreach my $res (@{$nextResources}) {
1478: my $current = $res->{DATA}->{$valName} || 999999999;
1479: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
1480: }
1481: }
1482: }
1.96 bowersj2 1483:
1.107 bowersj2 1484: # Assign the final val (**2**)
1.97 bowersj2 1485: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 1486: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
1487: $curRes->{DATA}->{BOT_UP_VAL});
1488:
1489: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
1490: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1491: }
1.97 bowersj2 1492: $curRes = $iterator->next();
1.96 bowersj2 1493: }
1494: }
1.94 bowersj2 1495:
1.116 bowersj2 1496: # Check: Was this only one resource, a map?
1497: if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) {
1498: my $firstResource = $resource->map_start();
1499: my $finishResource = $resource->map_finish();
1500: return
1501: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
1502: $finishResource, $self->{FILTER},
1503: $self->{ALREADY_SEEN},
1504: $self->{CONDITION}, 0);
1505:
1506: }
1507:
1.98 bowersj2 1508: # Set up some bookkeeping information.
1509: $self->{CURRENT_DEPTH} = 0;
1510: $self->{MAX_DEPTH} = $maxDepth;
1511: $self->{STACK} = [];
1512: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1513:
1514: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
1515: push @{$self->{STACK}}, [];
1516: }
1517:
1.107 bowersj2 1518: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 1519: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
1520: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
1521:
1522: bless ($self);
1523:
1524: return $self;
1525: }
1526:
1527: sub next {
1528: my $self = shift;
1529:
1530: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1531: # grab the next from the recursive iterator
1532: my $next = $self->{RECURSIVE_ITERATOR}->next();
1533:
1534: # is it a begin or end map? If so, update the depth
1535: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1536: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1537:
1538: # Are we back at depth 0? If so, stop recursing
1539: if ($self->{RECURSIVE_DEPTH} == 0) {
1540: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1541: }
1542:
1543: return $next;
1544: }
1545:
1546: if (defined($self->{FORCE_NEXT})) {
1547: my $tmp = $self->{FORCE_NEXT};
1548: $self->{FORCE_NEXT} = undef;
1549: return $tmp;
1550: }
1551:
1552: # Have we not yet begun? If not, return BEGIN_MAP and
1553: # remember we've started.
1554: if ( !$self->{STARTED} ) {
1555: $self->{STARTED} = 1;
1556: return $self->BEGIN_MAP();
1557: }
1558:
1559: # Here's the guts of the iterator.
1560:
1561: # Find the next resource, if any.
1562: my $found = 0;
1563: my $i = $self->{MAX_DEPTH};
1564: my $newDepth;
1565: my $here;
1566: while ( $i >= 0 && !$found ) {
1.107 bowersj2 1567: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
1568: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 1569: $found = 1;
1570: $newDepth = $i;
1571: }
1572: $i--;
1573: }
1574:
1575: # If we still didn't find anything, we're done.
1576: if ( !$found ) {
1577: # We need to get back down to the correct branch depth
1578: if ( $self->{CURRENT_DEPTH} > 0 ) {
1579: $self->{CURRENT_DEPTH}--;
1580: return END_BRANCH();
1581: } else {
1582: return END_MAP();
1583: }
1584: }
1585:
1.104 bowersj2 1586: # If this is not a resource, it must be an END_BRANCH marker we want
1587: # to return directly.
1.107 bowersj2 1588: if (!ref($here)) { # **8**
1.104 bowersj2 1589: if ($here == END_BRANCH()) { # paranoia, in case of later extension
1590: $self->{CURRENT_DEPTH}--;
1591: return $here;
1592: }
1593: }
1594:
1595: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
1596: $self->{HERE} = $here;
1597:
1.98 bowersj2 1598: # Get to the right level
1599: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
1600: push @{$self->{STACK}->[$newDepth]}, $here;
1601: $self->{CURRENT_DEPTH}--;
1602: return END_BRANCH();
1603: }
1604: if ( $self->{CURRENT_DEPTH} < $newDepth) {
1605: push @{$self->{STACK}->[$newDepth]}, $here;
1606: $self->{CURRENT_DEPTH}++;
1607: return BEGIN_BRANCH();
1608: }
1609:
1610: # If we made it here, we have the next resource, and we're at the
1611: # right branch level. So let's examine the resource for where
1612: # we can get to from here.
1613:
1614: # So we need to look at all the resources we can get to from here,
1615: # categorize them if we haven't seen them, remember if we have a new
1616: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 1617: my $maxDepthAdded = -1;
1618:
1.98 bowersj2 1619: for (@$nextUnfiltered) {
1620: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 1621: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
1622: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 1623: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 1624: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 1625: }
1626: }
1.104 bowersj2 1627:
1628: # Is this the end of a branch? If so, all of the resources examined above
1629: # led to lower levels then the one we are currently at, so we push a END_BRANCH
1630: # marker onto the stack so we don't forget.
1631: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
1632: # BC branch and gets to C, it will see F as the only next resource, but it's
1633: # one level lower. Thus, this is the end of the branch, since there are no
1634: # more resources added to this level or above.
1.111 bowersj2 1635: # We don't do this if the examined resource is the finish resource,
1636: # because the condition given above is true, but the "END_MAP" will
1637: # take care of things and we should already be at depth 0.
1.104 bowersj2 1638: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 1639: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 1640: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
1641: }
1642:
1.98 bowersj2 1643: # That ends the main iterator logic. Now, do we want to recurse
1644: # down this map (if this resource is a map)?
1645: if ($self->{HERE}->is_map() &&
1646: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1647: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
1648: my $firstResource = $self->{HERE}->map_start();
1649: my $finishResource = $self->{HERE}->map_finish();
1650:
1651: $self->{RECURSIVE_ITERATOR} =
1652: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
1653: $finishResource, $self->{FILTER},
1654: $self->{ALREADY_SEEN}, $self->{CONDITION});
1655: }
1656:
1.116 bowersj2 1657: # If this is a blank resource, don't actually return it.
1.117 bowersj2 1658: # Should you ever find you need it, make sure to add an option to the code
1659: # that you can use; other things depend on this behavior.
1.116 bowersj2 1660: if (!$self->{HERE}->src()) {
1661: return $self->next();
1662: }
1663:
1.98 bowersj2 1664: return $self->{HERE};
1665:
1666: }
1667:
1668: =pod
1669:
1670: 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).
1671:
1672: =cut
1673:
1674: sub getStack {
1675: my $self=shift;
1676:
1677: my @stack;
1678:
1679: $self->populateStack(\@stack);
1680:
1681: return \@stack;
1682: }
1683:
1684: # Private method: Calls the iterators recursively to populate the stack.
1685: sub populateStack {
1686: my $self=shift;
1687: my $stack = shift;
1688:
1689: push @$stack, $self->{HERE} if ($self->{HERE});
1690:
1691: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1692: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
1693: }
1.94 bowersj2 1694: }
1695:
1696: 1;
1697:
1698: package Apache::lonnavmaps::DFSiterator;
1699:
1.100 bowersj2 1700: # Not documented in the perldoc: This is a simple iterator that just walks
1701: # through the nav map and presents the resources in a depth-first search
1702: # fashion, ignorant of conditionals, randomized resources, etc. It presents
1703: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
1704: # useful for pre-processing of some kind, and is in fact used by the main
1705: # iterator that way, but that's about it.
1706: # One could imagine merging this into the init routine of the main iterator,
1707: # but this might as well be left seperate, since it is possible some other
1708: # use might be found for it. - Jeremy
1.94 bowersj2 1709:
1.117 bowersj2 1710: # Unlike the main iterator, this DOES return all resources, even blank ones.
1711: # The main iterator needs them to correctly preprocess the map.
1712:
1.94 bowersj2 1713: sub BEGIN_MAP { return 1; } # begining of a new map
1714: sub END_MAP { return 2; } # end of the map
1715: sub FORWARD { return 1; } # go forward
1716: sub BACKWARD { return 2; }
1717:
1.100 bowersj2 1718: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
1719: # filter hash ref (or undef), already seen hash or undef, condition
1720: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 1721: sub new {
1722: # magic invocation to create a class instance
1723: my $proto = shift;
1724: my $class = ref($proto) || $proto;
1725: my $self = {};
1726:
1727: $self->{NAV_MAP} = shift;
1728: return undef unless ($self->{NAV_MAP});
1729:
1730: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1731: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1732:
1733: # If the given resources are just the ID of the resource, get the
1734: # objects
1735: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1736: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1737: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1738: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1739:
1740: $self->{FILTER} = shift;
1741:
1742: # A hash, used as a set, of resource already seen
1743: $self->{ALREADY_SEEN} = shift;
1744: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 1745: $self->{CONDITION} = shift;
1.89 bowersj2 1746: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 1747:
1.100 bowersj2 1748: # Flag: Have we started yet?
1.51 bowersj2 1749: $self->{STARTED} = 0;
1750:
1751: # Should we continue calling the recursive iterator, if any?
1752: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1753: # The recursive iterator, if any
1754: $self->{RECURSIVE_ITERATOR} = undef;
1755: # Are we recursing on a map, or a branch?
1756: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
1757: # And the count of how deep it is, so that this iterator can keep track of
1758: # when to pick back up again.
1759: $self->{RECURSIVE_DEPTH} = 0;
1760:
1761: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 1762: $self->{STACK} = [];
1.51 bowersj2 1763:
1764: # Start with the first resource
1.89 bowersj2 1765: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 1766: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 1767: } else {
1.100 bowersj2 1768: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 1769: }
1.51 bowersj2 1770:
1771: bless($self);
1772: return $self;
1773: }
1774:
1775: sub next {
1776: my $self = shift;
1777:
1778: # Are we using a recursive iterator? If so, pull from that and
1779: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 1780: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 1781: # grab the next from the recursive iterator
1782: my $next = $self->{RECURSIVE_ITERATOR}->next();
1783:
1784: # is it a begin or end map? Update depth if so
1785: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1786: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1787:
1788: # Are we back at depth 0? If so, stop recursing.
1789: if ($self->{RECURSIVE_DEPTH} == 0) {
1790: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1791: }
1792:
1793: return $next;
1794: }
1795:
1796: # Is there a current resource to grab? If not, then return
1.100 bowersj2 1797: # END_MAP, which will end the iterator.
1798: if (scalar(@{$self->{STACK}}) == 0) {
1799: return $self->END_MAP();
1.51 bowersj2 1800: }
1801:
1802: # Have we not yet begun? If not, return BEGIN_MAP and
1803: # remember that we've started.
1804: if ( !$self->{STARTED} ) {
1805: $self->{STARTED} = 1;
1806: return $self->BEGIN_MAP;
1807: }
1808:
1809: # Get the next resource in the branch
1.100 bowersj2 1810: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 1811:
1.100 bowersj2 1812: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 1813: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
1814:
1815: # Get the next possible resources
1.90 bowersj2 1816: my $nextUnfiltered;
1.89 bowersj2 1817: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 1818: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 1819: } else {
1.90 bowersj2 1820: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 1821: }
1.51 bowersj2 1822: my $next = [];
1823:
1824: # filter the next possibilities to remove things we've
1.100 bowersj2 1825: # already seen.
1.51 bowersj2 1826: foreach (@$nextUnfiltered) {
1.52 bowersj2 1827: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1828: push @$next, $_;
1829: }
1.51 bowersj2 1830: }
1831:
1832: while (@$next) {
1.100 bowersj2 1833: # copy the next possibilities over to the stack
1834: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 1835: }
1836:
1837: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 1838: if ($self->{HERE}->is_map() &&
1.63 bowersj2 1839: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 1840: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
1841: my $firstResource = $self->{HERE}->map_start();
1842: my $finishResource = $self->{HERE}->map_finish();
1843:
1844: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 1845: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 1846: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 1847: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 1848: }
1849:
1850: return $self->{HERE};
1851: }
1852:
1.1 www 1853: 1;
1.2 www 1854:
1.51 bowersj2 1855: package Apache::lonnavmaps::resource;
1856:
1857: use Apache::lonnet;
1858:
1859: =pod
1860:
1861: =head1 Object: resource
1862:
1863: 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.
1864:
1865: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
1866:
1867: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
1868:
1869: =head2 Public Members
1870:
1871: 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.
1872:
1873: =head2 Methods
1874:
1875: =over 4
1876:
1.70 bowersj2 1877: =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.
1878:
1879: =back
1.51 bowersj2 1880:
1881: =cut
1882:
1883: sub new {
1884: # magic invocation to create a class instance
1885: my $proto = shift;
1886: my $class = ref($proto) || $proto;
1887: my $self = {};
1888:
1889: $self->{NAV_MAP} = shift;
1890: $self->{ID} = shift;
1891:
1892: # Store this new resource in the parent nav map's cache.
1893: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 1894: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 1895:
1896: # A hash that can be used by two-pass algorithms to store data
1897: # about this resource in. Not used by the resource object
1898: # directly.
1899: $self->{DATA} = {};
1900:
1901: bless($self);
1902:
1903: return $self;
1904: }
1905:
1.70 bowersj2 1906: # private function: simplify the NAV_HASH lookups we keep doing
1907: # pass the name, and to automatically append my ID, pass a true val on the
1908: # second param
1909: sub navHash {
1910: my $self = shift;
1911: my $param = shift;
1912: my $id = shift;
1.115 bowersj2 1913: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 1914: }
1915:
1.51 bowersj2 1916: =pod
1917:
1.70 bowersj2 1918: B<Metadata Retreival>
1919:
1.101 bowersj2 1920: These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.
1.70 bowersj2 1921:
1922: =over 4
1923:
1.106 bowersj2 1924: =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").
1925:
1.70 bowersj2 1926: =item * B<ext>: Returns true if the resource is external.
1927:
1928: =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
1929:
1930: =item * B<kind>: Returns the kind of the resource from the compiled nav map.
1931:
1.101 bowersj2 1932: =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.
1.51 bowersj2 1933:
1.70 bowersj2 1934: =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
1935:
1936: =item * B<src>: Returns the source for the resource.
1937:
1938: =item * B<symb>: Returns the symb for the resource.
1939:
1940: =item * B<title>: Returns the title of the resource.
1941:
1942: =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
1.51 bowersj2 1943:
1944: =back
1945:
1946: =cut
1947:
1948: # These info functions can be used directly, as they don't return
1949: # resource information.
1.85 bowersj2 1950: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.70 bowersj2 1951: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 1952: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.51 bowersj2 1953: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
1954: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 1955: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
1956: sub randompick {
1957: my $self = shift;
1958: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
1959: '.0.parameter_randompick'};
1960: }
1.51 bowersj2 1961: sub src {
1962: my $self=shift;
1963: return $self->navHash("src_", 1);
1964: }
1965: sub symb {
1966: my $self=shift;
1967: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
1968: my $symbSrc = &Apache::lonnet::declutter($self->src());
1969: return &Apache::lonnet::declutter(
1970: $self->navHash('map_id_'.$first))
1971: . '___' . $second . '___' . $symbSrc;
1972: }
1.70 bowersj2 1973: sub title { my $self=shift; return $self->navHash("title_", 1); }
1974: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.106 bowersj2 1975: sub compTitle {
1976: my $self = shift;
1977: my $title = $self->title();
1978: if (!$title) {
1979: $title = $self->src();
1980: $title = substr($title, rindex($title, '/') + 1);
1981: }
1982: return $title;
1983: }
1.70 bowersj2 1984: =pod
1985:
1986: B<Predicate Testing the Resource>
1987:
1988: These methods are shortcuts to deciding if a given resource has a given property.
1989:
1990: =over 4
1991:
1992: =item * B<is_map>: Returns true if the resource is a map type.
1993:
1994: =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.)
1995:
1996: =item * B<is_page>: Returns true if the resource is a page.
1997:
1998: =item * B<is_problem>: Returns true if the resource is a problem.
1999:
1.101 bowersj2 2000: =item * B<is_sequence>: Returns true if the resource is a sequence.
1.70 bowersj2 2001:
2002: =back
2003:
2004: =cut
2005:
2006:
2007: sub is_html {
1.51 bowersj2 2008: my $self=shift;
2009: my $src = $self->src();
1.70 bowersj2 2010: return ($src =~ /html$/);
1.51 bowersj2 2011: }
1.70 bowersj2 2012: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
2013: sub is_page {
1.51 bowersj2 2014: my $self=shift;
2015: my $src = $self->src();
1.70 bowersj2 2016: return ($src =~ /page$/);
1.51 bowersj2 2017: }
1.70 bowersj2 2018: sub is_problem {
1.51 bowersj2 2019: my $self=shift;
2020: my $src = $self->src();
1.70 bowersj2 2021: return ($src =~ /problem$/);
1.51 bowersj2 2022: }
1.70 bowersj2 2023: sub is_sequence {
1.51 bowersj2 2024: my $self=shift;
2025: my $src = $self->src();
1.70 bowersj2 2026: return ($src =~ /sequence$/);
1.51 bowersj2 2027: }
2028:
1.101 bowersj2 2029: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 2030: sub parmval {
2031: my $self = shift;
2032: my $what = shift;
2033: my $part = shift || "0";
2034: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
2035: }
2036:
1.70 bowersj2 2037: =pod
2038:
2039: B<Map Methods>
2040:
2041: These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
2042:
2043: =over 4
2044:
2045: =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
2046:
2047: =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.
2048:
2049: =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
2050:
2051: =item * B<map_type>: Returns a string with the type of the map in it.
2052:
2053: =back
1.51 bowersj2 2054:
1.70 bowersj2 2055: =cut
1.51 bowersj2 2056:
2057: sub map_finish {
2058: my $self = shift;
2059: my $src = $self->src();
2060: my $res = $self->navHash("map_finish_$src", 0);
2061: $res = $self->{NAV_MAP}->getById($res);
2062: return $res;
2063: }
1.70 bowersj2 2064: sub map_pc {
2065: my $self = shift;
2066: my $src = $self->src();
2067: return $self->navHash("map_pc_$src", 0);
2068: }
1.51 bowersj2 2069: sub map_start {
2070: my $self = shift;
2071: my $src = $self->src();
2072: my $res = $self->navHash("map_start_$src", 0);
2073: $res = $self->{NAV_MAP}->getById($res);
2074: return $res;
2075: }
2076: sub map_type {
2077: my $self = shift;
2078: my $pc = $self->map_pc();
2079: return $self->navHash("map_type_$pc", 0);
2080: }
2081:
2082:
2083:
2084: #####
2085: # Property queries
2086: #####
2087:
2088: # These functions will be responsible for returning the CORRECT
2089: # VALUE for the parameter, no matter what. So while they may look
2090: # like direct calls to parmval, they can be more then that.
2091: # So, for instance, the duedate function should use the "duedatetype"
2092: # information, rather then the resource object user.
2093:
2094: =pod
2095:
2096: =head2 Resource Parameters
2097:
1.70 bowersj2 2098: 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.
1.51 bowersj2 2099:
2100: 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.)
2101:
2102: =over 4
2103:
2104: =item * B<acc>: Get the Client IP/Name Access Control information.
2105:
2106: =item * B<answerdate>: Get the answer-reveal date for the problem.
2107:
2108: =item * B<duedate>: Get the due date for the problem.
2109:
2110: =item * B<tries>: Get the number of tries the student has used on the problem.
2111:
2112: =item * B<maxtries>: Get the number of max tries allowed.
2113:
2114: =item * B<opendate>: Get the open date for the problem.
2115:
2116: =item * B<sig>: Get the significant figures setting.
2117:
2118: =item * B<tol>: Get the tolerance for the problem.
2119:
1.70 bowersj2 2120: =item * B<tries>: Get the number of tries the user has already used on the problem.
2121:
1.51 bowersj2 2122: =item * B<type>: Get the question type for the problem.
2123:
2124: =item * B<weight>: Get the weight for the problem.
2125:
2126: =back
2127:
2128: =cut
2129:
2130: sub acc {
2131: (my $self, my $part) = @_;
2132: return $self->parmval("acc", $part);
2133: }
2134: sub answerdate {
2135: (my $self, my $part) = @_;
2136: # Handle intervals
2137: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
2138: return $self->duedate($part) +
2139: $self->parmval("answerdate", $part);
2140: }
2141: return $self->parmval("answerdate", $part);
1.106 bowersj2 2142: }
1.108 bowersj2 2143: sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); }
1.51 bowersj2 2144: sub duedate {
2145: (my $self, my $part) = @_;
2146: return $self->parmval("duedate", $part);
2147: }
2148: sub maxtries {
2149: (my $self, my $part) = @_;
2150: return $self->parmval("maxtries", $part);
2151: }
2152: sub opendate {
2153: (my $self, my $part) = @_;
2154: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
2155: return $self->duedate($part) -
2156: $self->parmval("opendate", $part);
2157: }
2158: return $self->parmval("opendate");
2159: }
2160: sub sig {
2161: (my $self, my $part) = @_;
2162: return $self->parmval("sig", $part);
2163: }
2164: sub tol {
2165: (my $self, my $part) = @_;
2166: return $self->parmval("tol", $part);
2167: }
1.108 bowersj2 2168: sub tries {
2169: my $self = shift;
2170: my $tries = $self->queryRestoreHash('tries', shift);
2171: if (!defined($tries)) { return '0';}
1.51 bowersj2 2172: return $tries;
2173: }
1.70 bowersj2 2174: sub type {
2175: (my $self, my $part) = @_;
2176: return $self->parmval("type", $part);
2177: }
1.109 bowersj2 2178: sub weight {
2179: my $self = shift; my $part = shift;
1.70 bowersj2 2180: return $self->parmval("weight", $part);
2181: }
1.51 bowersj2 2182:
2183: # Multiple things need this
2184: sub getReturnHash {
2185: my $self = shift;
2186:
2187: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 2188: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 2189: $self->{RETURN_HASH} = \%tmpHash;
2190: }
2191: }
2192:
2193: ######
2194: # Status queries
2195: ######
2196:
2197: # These methods query the status of problems.
2198:
2199: # If we need to count parts, this function determines the number of
2200: # parts from the metadata. When called, it returns a reference to a list
2201: # of strings corresponding to the parts. (Thus, using it in a scalar context
2202: # tells you how many parts you have in the problem:
2203: # $partcount = scalar($resource->countParts());
2204: # Don't use $self->{PARTS} directly because you don't know if it's been
2205: # computed yet.
2206:
2207: =pod
2208:
2209: =head2 Resource misc
2210:
2211: Misc. functions for the resource.
2212:
2213: =over 4
2214:
1.59 bowersj2 2215: =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.
2216:
2217: =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:
2218:
2219: for (split(/\,/, $res->getFeedback())) {
2220: my $link = &Apache::lonnet::escape($_);
2221: ...
2222:
2223: and use the link as appropriate.
2224:
2225: =cut
2226:
2227: sub hasDiscussion {
2228: my $self = shift;
2229: return $self->{NAV_MAP}->hasDiscussion($self->symb());
2230: }
2231:
2232: sub getFeedback {
2233: my $self = shift;
1.85 bowersj2 2234: return $self->{NAV_MAP}->getFeedback($self->src());
1.59 bowersj2 2235: }
2236:
2237: =pod
2238:
1.70 bowersj2 2239: =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.)
1.51 bowersj2 2240:
1.70 bowersj2 2241: =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.
1.51 bowersj2 2242:
2243: =back
2244:
2245: =cut
2246:
2247: sub parts {
2248: my $self = shift;
2249:
1.67 bowersj2 2250: if ($self->ext) { return ['0']; }
2251:
1.51 bowersj2 2252: $self->extractParts();
2253: return $self->{PARTS};
2254: }
2255:
2256: sub countParts {
2257: my $self = shift;
2258:
2259: my $parts = $self->parts();
1.66 bowersj2 2260:
2261: if ($self->{RESOURCE_ERROR}) {
2262: return 0;
2263: }
2264:
2265: if (scalar(@{$parts}) < 2) { return 1;}
1.51 bowersj2 2266:
2267: return scalar(@{$parts}) - 1;
2268: }
2269:
2270: # Private function: Extracts the parts information and saves it
2271: sub extractParts {
2272: my $self = shift;
2273:
2274: return if ($self->{PARTS});
1.67 bowersj2 2275: return if ($self->ext);
1.51 bowersj2 2276:
2277: $self->{PARTS} = [];
2278:
1.82 bowersj2 2279: # Retrieve part count, if this is a problem
2280: if ($self->is_problem()) {
2281: my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
2282: if (!$metadata) {
2283: $self->{RESOURCE_ERROR} = 1;
2284: $self->{PARTS} = [];
2285: return;
2286: }
2287:
2288: foreach (split(/\,/,$metadata)) {
2289: if ($_ =~ /^parameter\_(.*)\_opendate$/) {
2290: push @{$self->{PARTS}}, $1;
2291: }
1.51 bowersj2 2292: }
1.82 bowersj2 2293:
2294:
2295: # Is this possible to do in one line? - Jeremy
2296: my @sortedParts = sort @{$self->{PARTS}};
2297: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 2298: }
2299:
2300: return;
2301: }
2302:
2303: =pod
2304:
2305: =head2 Resource Status
2306:
1.101 bowersj2 2307: Problem resources have status information, reflecting their various dates and completion statuses.
1.51 bowersj2 2308:
2309: There are two aspects to the status: the date-related information and the completion information.
2310:
2311: Idiomatic usage of these two methods would probably look something like
2312:
2313: foreach ($resource->parts()) {
2314: my $dateStatus = $resource->getDateStatus($_);
2315: my $completionStatus = $resource->getCompletionStatus($_);
2316:
1.70 bowersj2 2317: or
2318:
2319: my $status = $resource->status($_);
2320:
1.51 bowersj2 2321: ... use it here ...
2322: }
2323:
1.101 bowersj2 2324: 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.
2325:
2326: The symbolic constants shown below can be accessed through the resource object: $res->OPEN.
2327:
1.51 bowersj2 2328: =over 4
2329:
1.70 bowersj2 2330: =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:
1.51 bowersj2 2331:
2332: =back
2333:
2334: B<Date Codes>
2335:
2336: =over 4
2337:
2338: =item * B<OPEN_LATER>: The problem will be opened later.
2339:
2340: =item * B<OPEN>: Open and not yet due.
2341:
1.59 bowersj2 2342:
1.54 bowersj2 2343: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
2344:
2345: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
1.51 bowersj2 2346:
2347: =item * B<ANSWER_OPEN>: The answer date is here.
2348:
2349: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2350:
2351: =back
2352:
2353: =cut
2354:
2355: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 2356: sub OPEN_LATER { return 0; }
2357: sub OPEN { return 1; }
2358: sub PAST_DUE_NO_ANSWER { return 2; }
2359: sub PAST_DUE_ANSWER_LATER { return 3; }
2360: sub ANSWER_OPEN { return 4; }
2361: sub NOTHING_SET { return 5; }
2362: sub NETWORK_FAILURE { return 100; }
2363:
2364: # getDateStatus gets the date status for a given problem part.
2365: # Because answer date, due date, and open date are fully independent
2366: # (i.e., it is perfectly possible to *only* have an answer date),
2367: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
2368: # (past, future, none given). This function handles this with a decision
2369: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 2370:
2371: sub getDateStatus {
2372: my $self = shift;
2373: my $part = shift;
2374: $part = "0" if (!defined($part));
1.54 bowersj2 2375:
2376: # Always return network failure if there was one.
1.51 bowersj2 2377: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2378:
2379: my $now = time();
2380:
1.53 bowersj2 2381: my $open = $self->opendate($part);
2382: my $due = $self->duedate($part);
2383: my $answer = $self->answerdate($part);
2384:
2385: if (!$open && !$due && !$answer) {
2386: # no data on the problem at all
2387: # should this be the same as "open later"? think multipart.
2388: return $self->NOTHING_SET;
2389: }
1.59 bowersj2 2390: if (!$open || $now < $open) {return $self->OPEN_LATER}
2391: if (!$due || $now < $due) {return $self->OPEN}
2392: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
2393: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 2394: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 2395: }
2396:
2397: =pod
2398:
2399: B<>
2400:
2401: =over 4
2402:
2403: =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:
2404:
2405: =back
2406:
2407: B<Completion Codes>
2408:
2409: =over 4
2410:
2411: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2412:
2413: =item * B<INCORRECT>: Attempted, but wrong by student.
2414:
2415: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2416:
2417: =item * B<CORRECT>: Correct or correct by instructor.
2418:
2419: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2420:
2421: =item * B<EXCUSED>: Excused. Not yet implemented.
2422:
2423: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2424:
1.69 bowersj2 2425: =item * B<ATTEMPTED>: Attempted, and not yet graded.
2426:
1.51 bowersj2 2427: =back
2428:
2429: =cut
2430:
1.53 bowersj2 2431: sub NOT_ATTEMPTED { return 10; }
2432: sub INCORRECT { return 11; }
2433: sub INCORRECT_BY_OVERRIDE { return 12; }
2434: sub CORRECT { return 13; }
2435: sub CORRECT_BY_OVERRIDE { return 14; }
2436: sub EXCUSED { return 15; }
1.69 bowersj2 2437: sub ATTEMPTED { return 16; }
1.51 bowersj2 2438:
2439: sub getCompletionStatus {
2440: my $self = shift;
2441: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2442:
1.108 bowersj2 2443: my $status = $self->queryRestoreHash('solved', shift);
1.51 bowersj2 2444:
2445: # Left as seperate if statements in case we ever do more with this
2446: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2447: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2448: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2449: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2450: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 2451: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 2452: return $self->NOT_ATTEMPTED;
1.108 bowersj2 2453: }
2454:
2455: sub queryRestoreHash {
2456: my $self = shift;
2457: my $hashentry = shift;
2458: my $part = shift;
2459: $part = "0" if (!defined($part));
2460: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2461:
2462: $self->getReturnHash();
2463:
2464: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 2465: }
2466:
2467: =pod
2468:
2469: B<Composite Status>
2470:
1.101 bowersj2 2471: 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):
1.51 bowersj2 2472:
2473: =over 4
2474:
1.70 bowersj2 2475: =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
1.51 bowersj2 2476:
1.70 bowersj2 2477: =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".)
1.53 bowersj2 2478:
1.70 bowersj2 2479: =item * B<CORRECT>: For any reason at all, the part is considered correct.
1.51 bowersj2 2480:
1.70 bowersj2 2481: =item * B<EXCUSED>: For any reason at all, the problem is excused.
1.51 bowersj2 2482:
1.70 bowersj2 2483: =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
1.54 bowersj2 2484:
1.70 bowersj2 2485: =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
1.51 bowersj2 2486:
1.70 bowersj2 2487: =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
1.51 bowersj2 2488:
1.70 bowersj2 2489: =item * B<OPEN_LATER>: The problem is not yet open.
1.51 bowersj2 2490:
1.70 bowersj2 2491: =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
1.51 bowersj2 2492:
1.70 bowersj2 2493: =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
1.51 bowersj2 2494:
1.70 bowersj2 2495: =item * B<OPEN>: The item is open and not yet tried.
1.51 bowersj2 2496:
1.70 bowersj2 2497: =item * B<ATTEMPTED>: The problem has been attempted.
1.69 bowersj2 2498:
1.51 bowersj2 2499: =back
2500:
2501: =cut
2502:
2503: sub TRIES_LEFT { return 10; }
2504:
2505: sub status {
2506: my $self = shift;
2507: my $part = shift;
2508: if (!defined($part)) { $part = "0"; }
2509: my $completionStatus = $self->getCompletionStatus($part);
2510: my $dateStatus = $self->getDateStatus($part);
2511:
2512: # What we have is a two-dimensional matrix with 4 entries on one
2513: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 2514: # plus network failure and "no date data at all".
1.51 bowersj2 2515:
1.53 bowersj2 2516: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 2517:
2518: # There are a few whole rows we can dispose of:
1.53 bowersj2 2519: if ($completionStatus == CORRECT ||
2520: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.69 bowersj2 2521: return CORRECT;
2522: }
2523:
2524: if ($completionStatus == ATTEMPTED) {
2525: return ATTEMPTED;
1.53 bowersj2 2526: }
2527:
2528: # If it's EXCUSED, then return that no matter what
2529: if ($completionStatus == EXCUSED) {
2530: return EXCUSED;
1.51 bowersj2 2531: }
2532:
1.53 bowersj2 2533: if ($dateStatus == NOTHING_SET) {
2534: return NOTHING_SET;
1.51 bowersj2 2535: }
2536:
1.69 bowersj2 2537: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
2538: # by 4 matrix (date statuses).
1.51 bowersj2 2539:
1.54 bowersj2 2540: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 2541: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54 bowersj2 2542: return $dateStatus;
1.51 bowersj2 2543: }
2544:
1.53 bowersj2 2545: if ($dateStatus == ANSWER_OPEN) {
2546: return ANSWER_OPEN;
1.51 bowersj2 2547: }
2548:
2549: # Now: (incorrect, incorrect_override, not_attempted) x
2550: # (open_later), (open)
2551:
1.53 bowersj2 2552: if ($dateStatus == OPEN_LATER) {
2553: return OPEN_LATER;
1.51 bowersj2 2554: }
2555:
2556: # If it's WRONG...
1.53 bowersj2 2557: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 2558: # and there are TRIES LEFT:
1.79 bowersj2 2559: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.53 bowersj2 2560: return TRIES_LEFT;
1.51 bowersj2 2561: }
1.53 bowersj2 2562: return INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 2563: }
2564:
2565: # Otherwise, it's untried and open
1.53 bowersj2 2566: return OPEN;
1.51 bowersj2 2567: }
2568:
2569: =pod
2570:
2571: =head2 Resource/Nav Map Navigation
2572:
2573: =over 4
2574:
1.101 bowersj2 2575: =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.
1.85 bowersj2 2576:
1.101 bowersj2 2577: =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.
1.51 bowersj2 2578:
2579: =cut
2580:
2581: sub getNext {
2582: my $self = shift;
2583: my @branches;
2584: my $to = $self->to();
1.85 bowersj2 2585: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 2586: my $choice = $self->{NAV_MAP}->getById($branch);
2587: my $next = $choice->goesto();
2588: $next = $self->{NAV_MAP}->getById($next);
2589:
1.101 bowersj2 2590: # Don't remember it if the student doesn't have browse priviledges
2591: # future note: this may properly belong in the client of the resource
1.114 bowersj2 2592: my $browsePriv = $self->{BROWSE_PRIV};
2593: if (!defined($browsePriv)) {
2594: $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
2595: $self->{BROWSE_PRIV} = $browsePriv;
2596: }
1.102 bowersj2 2597: if (!($browsePriv ne '2' && $browsePriv ne 'F')) {
1.101 bowersj2 2598: push @branches, $next;
2599: }
1.85 bowersj2 2600: }
2601: return \@branches;
2602: }
2603:
2604: sub getPrevious {
2605: my $self = shift;
2606: my @branches;
2607: my $from = $self->from();
2608: foreach my $branch ( split /,/, $from) {
2609: my $choice = $self->{NAV_MAP}->getById($branch);
2610: my $prev = $choice->comesfrom();
2611: $prev = $self->{NAV_MAP}->getById($prev);
2612:
1.101 bowersj2 2613: # Don't remember it if the student doesn't have browse priviledges
2614: # future note: this may properly belong in the client of the resource
1.114 bowersj2 2615: my $browsePriv = $self->{BROWSE_PRIV};
2616: if (!defined($browsePriv)) {
2617: $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
2618: $self->{BROWSE_PRIV} = $browsePriv;
2619: }
1.103 bowersj2 2620: if (!($browsePriv ne '2' && $browsePriv ne 'F')) {
1.87 www 2621: push @branches, $prev;
1.85 bowersj2 2622: }
1.51 bowersj2 2623: }
2624: return \@branches;
2625: }
2626:
2627: =pod
1.2 www 2628:
1.51 bowersj2 2629: =back
1.2 www 2630:
1.51 bowersj2 2631: =cut
1.2 www 2632:
1.51 bowersj2 2633: 1;
1.2 www 2634:
1.51 bowersj2 2635: __END__
1.2 www 2636:
2637:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[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