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