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