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