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