1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
4: # $Id: lonnavmaps.pm,v 1.405 2007/11/20 00:26:17 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonnavmaps;
31:
32: use strict;
33: use GDBM_File;
34: use Apache::loncommon();
35: use Apache::lonenc();
36: use Apache::lonlocal;
37: use Apache::lonnet;
38: use POSIX qw (floor strftime);
39: use Time::HiRes qw( gettimeofday tv_interval );
40: use LONCAPA;
41: use DateTime();
42:
43: # symbolic constants
44: sub SYMB { return 1; }
45: sub URL { return 2; }
46: sub NOTHING { return 3; }
47:
48: # Some data
49:
50: my $resObj = "Apache::lonnavmaps::resource";
51:
52: # Keep these mappings in sync with lonquickgrades, which uses the colors
53: # instead of the icons.
54: my %statusIconMap =
55: (
56: $resObj->CLOSED => '',
57: $resObj->OPEN => 'navmap.open.gif',
58: $resObj->CORRECT => 'navmap.correct.gif',
59: $resObj->PARTIALLY_CORRECT => 'navmap.partial.gif',
60: $resObj->INCORRECT => 'navmap.wrong.gif',
61: $resObj->ATTEMPTED => 'navmap.ellipsis.gif',
62: $resObj->ERROR => ''
63: );
64:
65: my %iconAltTags =
66: ( 'navmap.correct.gif' => 'Correct',
67: 'navmap.wrong.gif' => 'Incorrect',
68: 'navmap.open.gif' => 'Open' );
69:
70: # Defines a status->color mapping, null string means don't color
71: my %colormap =
72: ( $resObj->NETWORK_FAILURE => '',
73: $resObj->CORRECT => '',
74: $resObj->EXCUSED => '#3333FF',
75: $resObj->PAST_DUE_ANSWER_LATER => '',
76: $resObj->PAST_DUE_NO_ANSWER => '',
77: $resObj->ANSWER_OPEN => '#006600',
78: $resObj->OPEN_LATER => '',
79: $resObj->TRIES_LEFT => '',
80: $resObj->INCORRECT => '',
81: $resObj->OPEN => '',
82: $resObj->NOTHING_SET => '',
83: $resObj->ATTEMPTED => '',
84: $resObj->ANSWER_SUBMITTED => '',
85: $resObj->PARTIALLY_CORRECT => '#006600'
86: );
87: # And a special case in the nav map; what to do when the assignment
88: # is not yet done and due in less than 24 hours
89: my $hurryUpColor = "#FF0000";
90:
91: sub close {
92: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
93: return(<<ENDCLOSE);
94: <script type="text/javascript">
95: window.status='Accessing Nav Control';
96: menu=window.open("/adm/rat/empty.html","loncapanav",
97: "height=600,width=400,scrollbars=1");
98: window.status='Closing Nav Control';
99: menu.close();
100: window.status='Done.';
101: </script>
102: ENDCLOSE
103: }
104:
105: sub update {
106: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
107: if (!$env{'request.course.id'}) { return ''; }
108: if ($ENV{'REQUEST_URI'}=~m|^/adm/navmaps|) { return ''; }
109: return(<<ENDUPDATE);
110: <form name="navform"></form>
111: <script type="text/javascript">
112: this.document.navform.action='/adm/navmaps#curloc';
113: this.document.navform.target='loncapanav';
114: this.document.navform.submit();
115: </script>
116: ENDUPDATE
117: }
118:
119: # Convenience functions: Returns a string that adds or subtracts
120: # the second argument from the first hash, appropriate for the
121: # query string that determines which folders to recurse on
122: sub addToFilter {
123: my $hashIn = shift;
124: my $addition = shift;
125: my %hash = %$hashIn;
126: $hash{$addition} = 1;
127:
128: return join (",", keys(%hash));
129: }
130:
131: sub removeFromFilter {
132: my $hashIn = shift;
133: my $subtraction = shift;
134: my %hash = %$hashIn;
135:
136: delete $hash{$subtraction};
137: return join(",", keys(%hash));
138: }
139:
140: # Convenience function: Given a stack returned from getStack on the iterator,
141: # return the correct src() value.
142: sub getLinkForResource {
143: my $stack = shift;
144: my $res;
145:
146: # Check to see if there are any pages in the stack
147: foreach $res (@$stack) {
148: if (defined($res)) {
149: my $anchor;
150: if ($res->is_page()) {
151: foreach my $item (@$stack) { if (defined($item)) { $anchor = $item; } }
152: $anchor=&escape($anchor->shown_symb());
153: return ($res->link(),$res->shown_symb(),$anchor);
154: }
155: # in case folder was skipped over as "only sequence"
156: my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
157: if ($map=~/\.page$/) {
158: my $url=&Apache::lonnet::clutter($map);
159: $anchor=&escape($src->shown_symb());
160: return ($url,$res->shown_symb(),$anchor);
161: }
162: }
163: }
164:
165: # Failing that, return the src of the last resource that is defined
166: # (when we first recurse on a map, it puts an undefined resource
167: # on the bottom because $self->{HERE} isn't defined yet, and we
168: # want the src for the map anyhow)
169: foreach my $item (@$stack) {
170: if (defined($item)) { $res = $item; }
171: }
172:
173: if ($res) {
174: return ($res->link(),$res->shown_symb());
175: }
176: return;
177: }
178:
179: # Convenience function: This separates the logic of how to create
180: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
181: # etc.) into a separate function. It takes a resource object as the
182: # first parameter, and the part number of the resource as the second.
183: # It's basically a big switch statement on the status of the resource.
184:
185: sub getDescription {
186: my $res = shift;
187: my $part = shift;
188: my $status = $res->status($part);
189:
190: if ($status == $res->NETWORK_FAILURE) {
191: return &mt("Having technical difficulties; please check status later");
192: }
193: if ($status == $res->NOTHING_SET) {
194: return &mt("Not currently assigned.");
195: }
196: if ($status == $res->OPEN_LATER) {
197: return "Open " . timeToHumanString($res->opendate($part),'start');
198: }
199: if ($status == $res->OPEN) {
200: if ($res->duedate($part)) {
201: if ($res->is_practice()) {
202: return &mt("Closes ")." " .timeToHumanString($res->duedate($part),'start');
203: } else {
204: return &mt("Due")." " .timeToHumanString($res->duedate($part),'end');
205: }
206: } else {
207: return &mt("Open, no due date");
208: }
209: }
210: if ($status == $res->PAST_DUE_ANSWER_LATER) {
211: return &mt("Answer open")." " . timeToHumanString($res->answerdate($part),'start');
212: }
213: if ($status == $res->PAST_DUE_NO_ANSWER) {
214: if ($res->is_practice()) {
215: return &mt("Closed")." " . timeToHumanString($res->duedate($part),'start');
216: } else {
217: return &mt("Was due")." " . timeToHumanString($res->duedate($part),'end');
218: }
219: }
220: if (($status == $res->ANSWER_OPEN || $status == $res->PARTIALLY_CORRECT)
221: && $res->handgrade($part) ne 'yes') {
222: return &mt("Answer available");
223: }
224: if ($status == $res->EXCUSED) {
225: return &mt("Excused by instructor");
226: }
227: if ($status == $res->ATTEMPTED) {
228: return &mt("Answer submitted, not yet graded");
229: }
230: if ($status == $res->TRIES_LEFT) {
231: my $tries = $res->tries($part);
232: my $maxtries = $res->maxtries($part);
233: my $triesString = "";
234: if ($tries && $maxtries) {
235: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
236: if ($maxtries > 1 && $maxtries - $tries == 1) {
237: $triesString = "<b>$triesString</b>";
238: }
239: }
240: if ($res->duedate($part)) {
241: return &mt("Due")." " . timeToHumanString($res->duedate($part),'end') .
242: " $triesString";
243: } else {
244: return &mt("No due date")." $triesString";
245: }
246: }
247: if ($status == $res->ANSWER_SUBMITTED) {
248: return &mt('Answer submitted');
249: }
250: }
251:
252: # Convenience function, so others can use it: Is the problem due in less than
253: # 24 hours, and still can be done?
254:
255: sub dueInLessThan24Hours {
256: my $res = shift;
257: my $part = shift;
258: my $status = $res->status($part);
259:
260: return ($status == $res->OPEN() ||
261: $status == $res->TRIES_LEFT()) &&
262: $res->duedate($part) && $res->duedate($part) < time()+(24*60*60) &&
263: $res->duedate($part) > time();
264: }
265:
266: # Convenience function, so others can use it: Is there only one try remaining for the
267: # part, with more than one try to begin with, not due yet and still can be done?
268: sub lastTry {
269: my $res = shift;
270: my $part = shift;
271:
272: my $tries = $res->tries($part);
273: my $maxtries = $res->maxtries($part);
274: return $tries && $maxtries && $maxtries > 1 &&
275: $maxtries - $tries == 1 && $res->duedate($part) &&
276: $res->duedate($part) > time();
277: }
278:
279: # This puts a human-readable name on the env variable.
280:
281: sub advancedUser {
282: return $env{'request.role.adv'};
283: }
284:
285:
286: # timeToHumanString takes a time number and converts it to a
287: # human-readable representation, meant to be used in the following
288: # manner:
289: # print "Due $timestring"
290: # print "Open $timestring"
291: # print "Answer available $timestring"
292: # Very, very, very, VERY English-only... goodness help a localizer on
293: # this func...
294:
295:
296: sub timeToHumanString {
297: my ($time,$type,$format) = @_;
298:
299: # zero, '0' and blank are bad times
300: if (!$time) {
301: return &mt('never');
302: }
303: unless (&Apache::lonlocal::current_language()=~/^en/) {
304: return &Apache::lonlocal::locallocaltime($time);
305: }
306: my $now = time();
307:
308: # Positive = future
309: my $delta = $time - $now;
310:
311: my $minute = 60;
312: my $hour = 60 * $minute;
313: my $day = 24 * $hour;
314: my $week = 7 * $day;
315: my $inPast = 0;
316:
317: # Logic in comments:
318: # Is it now? (extremely unlikely)
319: if ( $delta == 0 ) {
320: return "this instant";
321: }
322:
323: if ($delta < 0) {
324: $inPast = 1;
325: $delta = -$delta;
326: }
327:
328: if ( $delta > 0 ) {
329:
330: my $tense = $inPast ? " ago" : "";
331: my $prefix = $inPast ? "" : "in ";
332:
333: # Less than a minute
334: if ( $delta < $minute ) {
335: if ($delta == 1) { return "${prefix}1 second$tense"; }
336: return "$prefix$delta seconds$tense";
337: }
338:
339: # Less than an hour
340: if ( $delta < $hour ) {
341: # If so, use minutes
342: my $minutes = floor($delta / 60);
343: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
344: return "$prefix$minutes minutes$tense";
345: }
346:
347: # Is it less than 24 hours away? If so,
348: # display hours + minutes
349: if ( $delta < $hour * 24) {
350: my $hours = floor($delta / $hour);
351: my $minutes = floor(($delta % $hour) / $minute);
352: my $hourString = "$hours hours";
353: my $minuteString = ", $minutes minutes";
354: if ($hours == 1) {
355: $hourString = "1 hour";
356: }
357: if ($minutes == 1) {
358: $minuteString = ", 1 minute";
359: }
360: if ($minutes == 0) {
361: $minuteString = "";
362: }
363: return "$prefix$hourString$minuteString$tense";
364: }
365:
366: my $dt = DateTime->from_epoch(epoch => $time)
367: ->set_time_zone(&Apache::lonlocal::gettimezone());
368:
369: # If there's a caller supplied format, use it.
370:
371: if ($format ne '') {
372: my $timeStr = $dt->strftime($format);
373: return $timeStr.' ('.$dt->time_zone_short_name().')';
374: }
375:
376: # Less than 5 days away, display day of the week and
377: # HH:MM
378:
379: if ( $delta < $day * 5 ) {
380: my $timeStr = $dt->strftime("%A, %b %e at %I:%M %P (%Z)");
381: $timeStr =~ s/12:00 am/00:00/;
382: $timeStr =~ s/12:00 pm/noon/;
383: return ($inPast ? "last " : "this ") .
384: $timeStr;
385: }
386:
387: my $conjunction='on';
388: if ($type eq 'start') {
389: $conjunction='at';
390: } elsif ($type eq 'end') {
391: $conjunction='by';
392: }
393: # Is it this year?
394: my $dt_now = DateTime->from_epoch(epoch => $now)
395: ->set_time_zone(&Apache::lonlocal::gettimezone());
396: if ( $dt->year() == $dt_now->year()) {
397: # Return on Month Day, HH:MM meridian
398: my $timeStr = $dt->strftime("$conjunction %A, %b %e at %I:%M %P (%Z)");
399: $timeStr =~ s/12:00 am/00:00/;
400: $timeStr =~ s/12:00 pm/noon/;
401: return $timeStr;
402: }
403:
404: # Not this year, so show the year
405: my $timeStr =
406: $dt->strftime("$conjunction %A, %b %e %Y at %I:%M %P (%Z)");
407: $timeStr =~ s/12:00 am/00:00/;
408: $timeStr =~ s/12:00 pm/noon/;
409: return $timeStr;
410: }
411: }
412:
413:
414: =pod
415:
416: =head1 NAME
417:
418: Apache::lonnavmap - Subroutines to handle and render the navigation
419: maps
420:
421: =head1 SYNOPSIS
422:
423: The main handler generates the navigational listing for the course,
424: the other objects export this information in a usable fashion for
425: other modules.
426:
427: =head1 OVERVIEW
428:
429: X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
430: course structure and caches it in what is often referred to as the
431: "big hash" X<big hash>. You can see it if you are logged into
432: LON-CAPA, in a course, by going to /adm/test. (You may need to
433: tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
434: content of the hash will be under the heading "Big Hash".
435:
436: Big Hash contains, among other things, how resources are related
437: to each other (next/previous), what resources are maps, which
438: resources are being chosen to not show to the student (for random
439: selection), and a lot of other things that can take a lot of time
440: to compute due to the amount of data that needs to be collected and
441: processed.
442:
443: Apache::lonnavmaps provides an object model for manipulating this
444: information in a higher-level fashion than directly manipulating
445: the hash. It also provides access to several auxilary functions
446: that aren't necessarily stored in the Big Hash, but are a per-
447: resource sort of value, like whether there is any feedback on
448: a given resource.
449:
450: Apache::lonnavmaps also abstracts away branching, and someday,
451: conditions, for the times where you don't really care about those
452: things.
453:
454: Apache::lonnavmaps also provides fairly powerful routines for
455: rendering navmaps, and last but not least, provides the navmaps
456: view for when the user clicks the NAV button.
457:
458: B<Note>: Apache::lonnavmaps I<only> works for the "currently
459: logged in user"; if you want things like "due dates for another
460: student" lonnavmaps can not directly retrieve information like
461: that. You need the EXT function. This module can still help,
462: because many things, such as the course structure, are constant
463: between users, and Apache::lonnavmaps can help by providing
464: symbs for the EXT call.
465:
466: The rest of this file will cover the provided rendering routines,
467: which can often be used without fiddling with the navmap object at
468: all, then documents the Apache::lonnavmaps::navmap object, which
469: is the key to accessing the Big Hash information, covers the use
470: of the Iterator (which provides the logic for traversing the
471: somewhat-complicated Big Hash data structure), documents the
472: Apache::lonnavmaps::Resource objects that are returned by
473:
474: =head1 Subroutine: render
475:
476: The navmap renderer package provides a sophisticated rendering of the
477: standard navigation maps interface into HTML. The provided nav map
478: handler is actually just a glorified call to this.
479:
480: Because of the large number of parameters this function accepts,
481: instead of passing it arguments as is normal, pass it in an anonymous
482: hash with the desired options.
483:
484: The package provides a function called 'render', called as
485: Apache::lonnavmaps::render({}).
486:
487: =head2 Overview of Columns
488:
489: The renderer will build an HTML table for the navmap and return
490: it. The table consists of several columns, and a row for each
491: resource (or possibly each part). You tell the renderer how many
492: columns to create and what to place in each column, optionally using
493: one or more of the prepared columns, and the renderer will assemble
494: the table.
495:
496: Any additional generally useful column types should be placed in the
497: renderer code here, so anybody can use it anywhere else. Any code
498: specific to the current application (such as the addition of <input>
499: elements in a column) should be placed in the code of the thing using
500: the renderer.
501:
502: At the core of the renderer is the array reference COLS (see Example
503: section below for how to pass this correctly). The COLS array will
504: consist of entries of one of two types of things: Either an integer
505: representing one of the pre-packaged column types, or a sub reference
506: that takes a resource reference, a part number, and a reference to the
507: argument hash passed to the renderer, and returns a string that will
508: be inserted into the HTML representation as it.
509:
510: All other parameters are ways of either changing how the columns
511: are printing, or which rows are shown.
512:
513: The pre-packaged column names are refered to by constants in the
514: Apache::lonnavmaps namespace. The following currently exist:
515:
516: =over 4
517:
518: =item * B<Apache::lonnavmaps::resource>:
519:
520: The general info about the resource: Link, icon for the type, etc. The
521: first column in the standard nav map display. This column provides the
522: indentation effect seen in the B<NAV> screen. This column also accepts
523: the following parameters in the renderer hash:
524:
525: =over 4
526:
527: =item * B<resource_nolink>: default false
528:
529: If true, the resource will not be linked. By default, all non-folder
530: resources are linked.
531:
532: =item * B<resource_part_count>: default true
533:
534: If true, the resource will show a part count B<if> the full
535: part list is not displayed. (See "condense_parts" later.) If false,
536: the resource will never show a part count.
537:
538: =item * B<resource_no_folder_link>:
539:
540: If true, the resource's folder will not be clickable to open or close
541: it. Default is false. True implies printCloseAll is false, since you
542: can't close or open folders when this is on anyhow.
543:
544: =back
545:
546: =item * B<Apache::lonnavmaps::communication_status>:
547:
548: Whether there is discussion on the resource, email for the user, or
549: (lumped in here) perl errors in the execution of the problem. This is
550: the second column in the main nav map.
551:
552: =item * B<Apache::lonnavmaps::quick_status>:
553:
554: An icon for the status of a problem, with five possible states:
555: Correct, incorrect, open, awaiting grading (for a problem where the
556: computer's grade is suppressed, or the computer can't grade, like
557: essay problem), or none (not open yet, not a problem). The
558: third column of the standard navmap.
559:
560: =item * B<Apache::lonnavmaps::long_status>:
561:
562: A text readout of the details of the current status of the problem,
563: such as "Due in 22 hours". The fourth column of the standard navmap.
564:
565: =item * B<Apache::lonnavmaps::part_status_summary>:
566:
567: A text readout summarizing the status of the problem. If it is a
568: single part problem, will display "Correct", "Incorrect",
569: "Not yet open", "Open", "Attempted", or "Error". If there are
570: multiple parts, this will output a string that in HTML will show a
571: status of how many parts are in each status, in color coding, trying
572: to match the colors of the icons within reason.
573:
574: Note this only makes sense if you are I<not> showing parts. If
575: C<showParts> is true (see below), this column will not output
576: anything.
577:
578: =back
579:
580: If you add any others please be sure to document them here.
581:
582: An example of a column renderer that will show the ID number of a
583: resource, along with the part name if any:
584:
585: sub {
586: my ($resource, $part, $params) = @_;
587: if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
588: return '<td>' . $resource->{ID} . '</td>';
589: }
590:
591: Note these functions are responsible for the TD tags, which allow them
592: to override vertical and horizontal alignment, etc.
593:
594: =head2 Parameters
595:
596: Minimally, you should be
597: able to get away with just using 'cols' (to specify the columns
598: shown), 'url' (necessary for the folders to link to the current screen
599: correctly), and possibly 'queryString' if your app calls for it. In
600: that case, maintaining the state of the folders will be done
601: automatically.
602:
603: =over 4
604:
605: =item * B<iterator>: default: constructs one from %env
606:
607: A reference to a fresh ::iterator to use from the navmaps. The
608: rendering will reflect the options passed to the iterator, so you can
609: use that to just render a certain part of the course, if you like. If
610: one is not passed, the renderer will attempt to construct one from
611: env{'form.filter'} and env{'form.condition'} information, plus the
612: 'iterator_map' parameter if any.
613:
614: =item * B<iterator_map>: default: not used
615:
616: If you are letting the renderer do the iterator handling, you can
617: instruct the renderer to render only a particular map by passing it
618: the source of the map you want to process, like
619: '/res/103/jerf/navmap.course.sequence'.
620:
621: =item * B<include_top_level_map>: default: false
622:
623: If you need to include the top level map (meaning the course) in the
624: rendered output set this to true
625:
626: =item * B<navmap>: default: constructs one from %env
627:
628: A reference to a navmap, used only if an iterator is not passed in. If
629: this is necessary to make an iterator but it is not passed in, a new
630: one will be constructed based on env info. This is useful to do basic
631: error checking before passing it off to render.
632:
633: =item * B<r>: default: must be passed in
634:
635: The standard Apache response object. This must be passed to the
636: renderer or the course hash will be locked.
637:
638: =item * B<cols>: default: empty (useless)
639:
640: An array reference
641:
642: =item * B<showParts>:default true
643:
644: A flag. If true, a line for the resource itself, and a line
645: for each part will be displayed. If not, only one line for each
646: resource will be displayed.
647:
648: =item * B<condenseParts>: default true
649:
650: A flag. If true, if all parts of the problem have the same
651: status and that status is Nothing Set, Correct, or Network Failure,
652: then only one line will be displayed for that resource anyhow. If no,
653: all parts will always be displayed. If showParts is 0, this is
654: ignored.
655:
656: =item * B<jumpCount>: default: determined from %env
657:
658: A string identifying the URL to place the anchor 'curloc' at.
659: It is the responsibility of the renderer user to
660: ensure that the #curloc is in the URL. By default, determined through
661: the use of the env{} 'jump' information, and should normally "just
662: work" correctly.
663:
664: =item * B<here>: default: empty string
665:
666: A Symb identifying where to place the 'here' marker. The empty
667: string means no marker.
668:
669: =item * B<indentString>: default: 25 pixel whitespace image
670:
671: A string identifying the indentation string to use.
672:
673: =item * B<queryString>: default: empty
674:
675: A string which will be prepended to the query string used when the
676: folders are opened or closed. You can use this to pass
677: application-specific values.
678:
679: =item * B<url>: default: none
680:
681: The url the folders will link to, which should be the current
682: page. Required if the resource info column is shown, and you
683: are allowing the user to open and close folders.
684:
685: =item * B<currentJumpIndex>: default: no jumping
686:
687: Describes the currently-open row number to cause the browser to jump
688: to, because the user just opened that folder. By default, pulled from
689: the Jump information in the env{'form.*'}.
690:
691: =item * B<printKey>: default: false
692:
693: If true, print the key that appears on the top of the standard
694: navmaps.
695:
696: =item * B<printCloseAll>: default: true
697:
698: If true, print the "Close all folders" or "open all folders"
699: links.
700:
701: =item * B<filterFunc>: default: sub {return 1;} (accept everything)
702:
703: A function that takes the resource object as its only parameter and
704: returns a true or false value. If true, the resource is displayed. If
705: false, it is simply skipped in the display.
706:
707: =item * B<suppressEmptySequences>: default: false
708:
709: If you're using a filter function, and displaying sequences to orient
710: the user, then frequently some sequences will be empty. Setting this to
711: true will cause those sequences not to display, so as not to confuse the
712: user into thinking that if the sequence is there there should be things
713: under it; for example, see the "Show Uncompleted Homework" view on the
714: B<NAV> screen.
715:
716: =item * B<suppressNavmaps>: default: false
717:
718: If true, will not display Navigate Content resources.
719:
720: =back
721:
722: =head2 Additional Info
723:
724: In addition to the parameters you can pass to the renderer, which will
725: be passed through unchange to the column renderers, the renderer will
726: generate the following information which your renderer may find
727: useful:
728:
729: =over 4
730:
731: =item * B<counter>:
732:
733: Contains the number of rows printed. Useful after calling the render
734: function, as you can detect whether anything was printed at all.
735:
736: =item * B<isNewBranch>:
737:
738: Useful for renderers: If this resource is currently the first resource
739: of a new branch, this will be true. The Resource column (leftmost in the
740: navmaps screen) uses this to display the "new branch" icon
741:
742: =back
743:
744: =cut
745:
746: sub resource { return 0; }
747: sub communication_status { return 1; }
748: sub quick_status { return 2; }
749: sub long_status { return 3; }
750: sub part_status_summary { return 4; }
751:
752: sub render_resource {
753: my ($resource, $part, $params) = @_;
754:
755: my $nonLinkedText = ''; # stuff after resource title not in link
756:
757: my $link = $params->{"resourceLink"};
758:
759: # The URL part is not escaped at this point, but the symb is...
760: # The stuff to the left of the ? must have ' replaced by \' since
761: # it will be quoted with ' in the href.
762:
763: my ($left,$right) = split(/\?/, $link);
764: $link = $left.'?'.$right;
765:
766: my $src = $resource->src();
767: my $it = $params->{"iterator"};
768: my $filter = $it->{FILTER};
769:
770: my $title = $resource->compTitle();
771:
772: my $partLabel = "";
773: my $newBranchText = "";
774: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");
775: # If this is a new branch, label it so
776: if ($params->{'isNewBranch'}) {
777: $newBranchText = "<img src='$location/branch.gif' border='0' alt='Branch' />";
778: }
779:
780: # links to open and close the folder
781:
782:
783: my $linkopen = "<a href=\"$link\">";
784:
785:
786: my $linkclose = "</a>";
787:
788: # Default icon: unknown page
789: my $icon = "<img src='$location/unknown.gif' alt='' border='0' alt=' ' ' />";
790:
791: if ($resource->is_problem()) {
792: if ($part eq '0' || $params->{'condensed'}) {
793: $icon = '<img src="'.$location.'/';
794: if ($resource->is_task()) {
795: $icon .= 'task.gif" alt="'.&mt('Task');
796: } else {
797: $icon .= 'problem.gif" alt="'.&mt('Problem');
798: }
799: $icon .='" border="0" />';
800: } else {
801: $icon = $params->{'indentString'};
802: }
803: } else {
804: $icon = "<img src='".&Apache::loncommon::icon($resource->src)."' alt=' ' border='0' />";
805: }
806:
807: # Display the correct map icon to open or shut map
808: if ($resource->is_map()) {
809: my $mapId = $resource->map_pc();
810: my $nowOpen = !defined($filter->{$mapId});
811: if ($it->{CONDITION}) {
812: $nowOpen = !$nowOpen;
813: }
814:
815: my $folderType = $resource->is_sequence() ? 'folder' : 'page';
816: my $title=$resource->title;
817: $title=~s/\"/\"/g;
818: if (!$params->{'resource_no_folder_link'}) {
819: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
820: $icon = "<img src='$location/$icon' alt=\"".
821: ($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";
822:
823: $linkopen = "<a href=\"" . $params->{'url'} . '?' .
824: $params->{'queryString'} . '&filter=';
825: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
826: addToFilter($filter, $mapId) :
827: removeFromFilter($filter, $mapId);
828: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
829: . $params->{'hereType'} . '&here=' .
830: &escape($params->{'here'}) .
831: '&jump=' .
832: &escape($resource->symb()) .
833: "&folderManip=1\">";
834:
835: } else {
836: # Don't allow users to manipulate folder
837: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
838: '.nomanip.gif';
839: $icon = "<img src='$location/$icon' alt=\"".
840: ($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" border='0' />";
841:
842: $linkopen = "";
843: $linkclose = "";
844: }
845: }
846:
847: if ($resource->randomout()) {
848: $nonLinkedText .= ' <i>('.&mt('hidden').')</i> ';
849: }
850: if (!$resource->condval()) {
851: $nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> ';
852: }
853:
854: # We're done preparing and finally ready to start the rendering
855: my $result = "<td align='left' valign='middle'>";
856:
857: my $indentLevel = $params->{'indentLevel'};
858: if ($newBranchText) { $indentLevel--; }
859:
860: # print indentation
861: for (my $i = 0; $i < $indentLevel; $i++) {
862: $result .= $params->{'indentString'};
863: }
864:
865: # Decide what to display
866:
867: $result .= "$newBranchText$linkopen$icon$linkclose";
868:
869: my $curMarkerBegin = '';
870: my $curMarkerEnd = '';
871:
872: # Is this the current resource?
873: if (!$params->{'displayedHereMarker'} &&
874: $resource->symb() eq $params->{'here'} ) {
875: $curMarkerBegin = '<font color="red" size="+2">></font>';
876: $curMarkerEnd = '<font color="red" size="+2"><</font>';
877: $params->{'displayedHereMarker'} = 1;
878: }
879:
880: if ($resource->is_problem() && $part ne '0' &&
881: !$params->{'condensed'}) {
882: my $displaypart=$resource->part_display($part);
883: $partLabel = " (".&mt('Part: [_1]', $displaypart).")";
884: if ($link!~/\#/) { $link.='#'.&escape($part); }
885: $title = "";
886: }
887:
888: if ($params->{'condensed'} && $resource->countParts() > 1) {
889: $nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')';
890: }
891:
892: my $target;
893: if ($env{'environment.remotenavmap'} eq 'on') {
894: $target=' target="loncapaclient" ';
895: }
896: if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
897: $result .= " $curMarkerBegin<a $target href=\"$link\">$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
898: } else {
899: $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
900: }
901:
902: return $result;
903: }
904:
905: sub render_communication_status {
906: my ($resource, $part, $params) = @_;
907: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
908:
909: my $link = $params->{"resourceLink"};
910: my $target;
911: if ($env{'environment.remotenavmap'} eq 'on') {
912: $target=' target="loncapaclient" ';
913: }
914: my $linkopen = "<a $target href=\"$link\">";
915: my $linkclose = "</a>";
916: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
917: if ($resource->hasDiscussion()) {
918: $discussionHTML = $linkopen .
919: '<img alt="'.&mt('New Discussion').'" border="0" src="'.$location.'/chat.gif" />' .
920: $linkclose;
921: }
922:
923: if ($resource->getFeedback()) {
924: my $feedback = $resource->getFeedback();
925: foreach my $msgid (split(/\,/, $feedback)) {
926: if ($msgid) {
927: $feedbackHTML .= ' <a '.$target.' href="/adm/email?display='
928: . &escape($msgid) . '">'
929: . '<img alt="'.&mt('New Email').'" src="'.$location.'/feedback.gif" '
930: . 'border="0" /></a>';
931: }
932: }
933: }
934:
935: if ($resource->getErrors()) {
936: my $errors = $resource->getErrors();
937: my $errorcount = 0;
938: foreach my $msgid (split(/,/, $errors)) {
939: last if ($errorcount>=10); # Only output 10 bombs maximum
940: if ($msgid) {
941: $errorcount++;
942: $errorHTML .= ' <a '.$target.' href="/adm/email?display='
943: . &escape($msgid) . '">'
944: . '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" '
945: . 'border="0" /></a>';
946: }
947: }
948: }
949:
950: if ($params->{'multipart'} && $part != '0') {
951: $discussionHTML = $feedbackHTML = $errorHTML = '';
952: }
953:
954: return "<td width=\"75\" align=\"left\" valign=\"middle\">$discussionHTML$feedbackHTML$errorHTML </td>";
955:
956: }
957: sub render_quick_status {
958: my ($resource, $part, $params) = @_;
959: my $result = "";
960: my $firstDisplayed = !$params->{'condensed'} &&
961: $params->{'multipart'} && $part eq "0";
962:
963: my $link = $params->{"resourceLink"};
964: my $target;
965: if ($env{'environment.remotenavmap'} eq 'on') {
966: $target=' target="loncapaclient" ';
967: }
968: my $linkopen = "<a $target href=\"$link\">";
969: my $linkclose = "</a>";
970:
971: if ($resource->is_problem() &&
972: !$firstDisplayed) {
973:
974: my $icon = $statusIconMap{$resource->simpleStatus($part)};
975: my $alt = $iconAltTags{$icon};
976: if ($icon) {
977: my $location=
978: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
979: $result .= "<td valign='middle' width='50' align='right'>$linkopen<img width='25' height='25' src='$location' border='0' alt='$alt' />$linkclose</td>\n";
980: } else {
981: $result .= "<td width='30'> </td>\n";
982: }
983: } else { # not problem, no icon
984: $result .= "<td width='30'> </td>\n";
985: }
986:
987: return $result;
988: }
989: sub render_long_status {
990: my ($resource, $part, $params) = @_;
991: my $result = "<td align='right' valign='middle'>\n";
992: my $firstDisplayed = !$params->{'condensed'} &&
993: $params->{'multipart'} && $part eq "0";
994:
995: my $color;
996: if ($resource->is_problem() || $resource->is_practice()) {
997: $color = $colormap{$resource->status};
998:
999: if (dueInLessThan24Hours($resource, $part) ||
1000: lastTry($resource, $part)) {
1001: $color = $hurryUpColor;
1002: }
1003: }
1004:
1005: if ($resource->kind() eq "res" &&
1006: ($resource->is_problem() || $resource->is_practice()) &&
1007: !$firstDisplayed) {
1008: if ($color) {$result .= "<font color=\"$color\"><b>"; }
1009: $result .= getDescription($resource, $part);
1010: if ($color) {$result .= "</b></font>"; }
1011: }
1012: if ($resource->is_map() && &advancedUser() && $resource->randompick()) {
1013: $result .= &mt('(randomly select [_1])', $resource->randompick());
1014: }
1015: if ($resource->is_map() && &advancedUser() && $resource->randomorder()) {
1016: $result .= &mt('(randomly ordered)');
1017: }
1018:
1019: # Debugging code
1020: #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
1021: # ' - Part: ' . $part;
1022:
1023: $result .= "</td>\n";
1024:
1025: return $result;
1026: }
1027:
1028: # Colors obtained by taking the icons, matching the colors, and
1029: # possibly reducing the Value (HSV) of the color, if it's too bright
1030: # for text, generally by one third or so.
1031: my %statusColors =
1032: (
1033: $resObj->CLOSED => '#000000',
1034: $resObj->OPEN => '#998b13',
1035: $resObj->CORRECT => '#26933f',
1036: $resObj->INCORRECT => '#c48207',
1037: $resObj->ATTEMPTED => '#a87510',
1038: $resObj->ERROR => '#000000'
1039: );
1040: my %statusStrings =
1041: (
1042: $resObj->CLOSED => 'Not yet open',
1043: $resObj->OPEN => 'Open',
1044: $resObj->CORRECT => 'Correct',
1045: $resObj->INCORRECT => 'Incorrect',
1046: $resObj->ATTEMPTED => 'Attempted',
1047: $resObj->ERROR => 'Network Error'
1048: );
1049: my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
1050:
1051: sub render_parts_summary_status {
1052: my ($resource, $part, $params) = @_;
1053: if (!$resource->is_problem() && !$resource->contains_problem) { return '<td></td>'; }
1054: if ($params->{showParts}) {
1055: return '<td></td>';
1056: }
1057:
1058: my $td = "<td align='right'>\n";
1059: my $endtd = "</td>\n";
1060: my @probs;
1061:
1062: if ($resource->contains_problem) {
1063: @probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0);
1064: } else {
1065: @probs=($resource);
1066: }
1067: my $return;
1068: my %overallstatus;
1069: my $totalParts;
1070: foreach my $resource (@probs) {
1071: # If there is a single part, just show the simple status
1072: if ($resource->singlepart()) {
1073: my $status = $resource->simpleStatus(${$resource->parts}[0]);
1074: $overallstatus{$status}++;
1075: $totalParts++;
1076: next;
1077: }
1078: # Now we can be sure the $part doesn't really matter.
1079: my $statusCount = $resource->simpleStatusCount();
1080: my @counts;
1081: foreach my $status (@statuses) {
1082: # decouple display order from the simpleStatusCount order
1083: my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
1084: if ($statusCount->[$slot]) {
1085: $overallstatus{$status}+=$statusCount->[$slot];
1086: $totalParts+=$statusCount->[$slot];
1087: }
1088: }
1089: }
1090: $return.= $td . $totalParts . ' parts: ';
1091: foreach my $status (@statuses) {
1092: if ($overallstatus{$status}) {
1093: $return.="<font color='" . $statusColors{$status} .
1094: "'>" . $overallstatus{$status} . ' '
1095: . $statusStrings{$status} . "</font>";
1096: }
1097: }
1098: $return.= $endtd;
1099: return $return;
1100: }
1101:
1102: my @preparedColumns = (\&render_resource, \&render_communication_status,
1103: \&render_quick_status, \&render_long_status,
1104: \&render_parts_summary_status);
1105:
1106: sub setDefault {
1107: my ($val, $default) = @_;
1108: if (!defined($val)) { return $default; }
1109: return $val;
1110: }
1111:
1112: sub cmp_title {
1113: my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle));
1114: $atitle=~s/^\s*//;
1115: $btitle=~s/^\s*//;
1116: return $atitle cmp $btitle;
1117: }
1118:
1119: sub render {
1120: my $args = shift;
1121: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
1122: my $result = '';
1123: # Configure the renderer.
1124: my $cols = $args->{'cols'};
1125: if (!defined($cols)) {
1126: # no columns, no nav maps.
1127: return '';
1128: }
1129: my $navmap;
1130: if (defined($args->{'navmap'})) {
1131: $navmap = $args->{'navmap'};
1132: }
1133:
1134: my $r = $args->{'r'};
1135: my $queryString = $args->{'queryString'};
1136: my $jump = $args->{'jump'};
1137: my $here = $args->{'here'};
1138: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1139: my $closeAllPages = setDefault($args->{'closeAllPages'}, 0);
1140: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1141: # before the current resource when using #current
1142:
1143: # If we were passed 'here' information, we are not rendering
1144: # after a folder manipulation, and we were not passed an
1145: # iterator, make sure we open the folders to show the "here"
1146: # marker
1147: my $filterHash = {};
1148: # Figure out what we're not displaying
1149: foreach my $item (split(/\,/, $env{"form.filter"})) {
1150: if ($item) {
1151: $filterHash->{$item} = "1";
1152: }
1153: }
1154:
1155: # Filter: Remember filter function and add our own filter: Refuse
1156: # to show hidden resources unless the user can see them.
1157: my $userCanSeeHidden = advancedUser();
1158: my $filterFunc = setDefault($args->{'filterFunc'},
1159: sub {return 1;});
1160: if (!$userCanSeeHidden) {
1161: # Without renaming the filterfunc, the server seems to go into
1162: # an infinite loop
1163: my $oldFilterFunc = $filterFunc;
1164: $filterFunc = sub { my $res = shift; return !$res->randomout() &&
1165: &$oldFilterFunc($res);};
1166: }
1167:
1168: my $condition = 0;
1169: if ($env{'form.condition'}) {
1170: $condition = 1;
1171: }
1172:
1173: if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
1174: # Step 1: Check to see if we have a navmap
1175: if (!defined($navmap)) {
1176: $navmap = Apache::lonnavmaps::navmap->new();
1177: if (!defined($navmap)) {
1178: # no londer in course
1179: return '<span class="LC_error">'.&mt('No course selected').'</span><br />
1180: <a href="/adm/roles">'.&mt('Select a course').'</a><br />';
1181: }
1182: }
1183:
1184: # Step two: Locate what kind of here marker is necessary
1185: # Determine where the "here" marker is and where the screen jumps to.
1186:
1187: if ($env{'form.postsymb'} ne '') {
1188: $here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'});
1189: } elsif ($env{'form.postdata'} ne '') {
1190: # couldn't find a symb, is there a URL?
1191: my $currenturl = $env{'form.postdata'};
1192: #$currenturl=~s/^http\:\/\///;
1193: #$currenturl=~s/^[^\/]+//;
1194:
1195: $here = $jump = &Apache::lonnet::symbread($currenturl);
1196: }
1197: if ($here eq '') {
1198: my $last;
1199: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1200: &GDBM_READER(),0640)) {
1201: $last=$hash{'last_known'};
1202: untie(%hash);
1203: }
1204: if ($last) { $here = $jump = $last; }
1205: }
1206:
1207: # Step three: Ensure the folders are open
1208: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1209: my $curRes;
1210: my $found = 0;
1211:
1212: # We only need to do this if we need to open the maps to show the
1213: # current position. This will change the counter so we can't count
1214: # for the jump marker with this loop.
1215: while ($here && ($curRes = $mapIterator->next()) && !$found) {
1216: if (ref($curRes) && $curRes->symb() eq $here) {
1217: my $mapStack = $mapIterator->getStack();
1218:
1219: # Ensure the parent maps are open
1220: for my $map (@{$mapStack}) {
1221: if ($condition) {
1222: undef $filterHash->{$map->map_pc()};
1223: } else {
1224: $filterHash->{$map->map_pc()} = 1;
1225: }
1226: }
1227: $found = 1;
1228: }
1229: }
1230: }
1231:
1232: if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
1233: # If this is a click on a folder or something, we want to preserve the "here"
1234: # from the querystring, and get the new "jump" marker
1235: $here = $env{'form.here'};
1236: $jump = $env{'form.jump'};
1237: }
1238:
1239: my $it = $args->{'iterator'};
1240: if (!defined($it)) {
1241: # Construct a default iterator based on $env{'form.'} information
1242:
1243: # Step 1: Check to see if we have a navmap
1244: if (!defined($navmap)) {
1245: $navmap = Apache::lonnavmaps::navmap->new();
1246: }
1247:
1248: # See if we're being passed a specific map
1249: if ($args->{'iterator_map'}) {
1250: my $map = $args->{'iterator_map'};
1251: $map = $navmap->getResourceByUrl($map);
1252: my $firstResource = $map->map_start();
1253: my $finishResource = $map->map_finish();
1254:
1255: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
1256: } else {
1257: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition,undef,$args->{'include_top_level_map'});
1258: }
1259: }
1260:
1261: # (re-)Locate the jump point, if any
1262: # Note this does not take filtering or hidden into account... need
1263: # to be fixed?
1264: my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
1265: my $curRes;
1266: my $foundJump = 0;
1267: my $counter = 0;
1268:
1269: while (($curRes = $mapIterator->next()) && !$foundJump) {
1270: if (ref($curRes)) { $counter++; }
1271:
1272: if (ref($curRes) && $jump eq $curRes->symb()) {
1273:
1274: # This is why we have to use the main iterator instead of the
1275: # potentially faster DFS: The count has to be the same, so
1276: # the order has to be the same, which DFS won't give us.
1277: $args->{'currentJumpIndex'} = $counter;
1278: $foundJump = 1;
1279: }
1280: }
1281:
1282: my $showParts = setDefault($args->{'showParts'}, 1);
1283: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1284: # keeps track of when the current resource is found,
1285: # so we can back up a few and put the anchor above the
1286: # current resource
1287: my $printKey = $args->{'printKey'};
1288: my $printCloseAll = $args->{'printCloseAll'};
1289: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1290:
1291: # Print key?
1292: if ($printKey) {
1293: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1294: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1295: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1296: if ($navmap->{LAST_CHECK}) {
1297: $result .=
1298: '<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '.
1299: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1300: '</td><td align="center" valign="bottom"> '.
1301: '<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
1302: '</td>';
1303: } else {
1304: $result .= '<td align="center" valign="bottom"> '.
1305: '<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
1306: ' <img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').
1307: '</td>';
1308: }
1309:
1310: $result .= '</tr></table>';
1311: }
1312:
1313: if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
1314: my ($link,$text);
1315: if ($condition) {
1316: $link='"navmaps?condition=0&filter=&'.$queryString.
1317: '&here='.&escape($here).'"';
1318: $text='Close all folders';
1319: } else {
1320: $link='"navmaps?condition=1&filter=&'.$queryString.
1321: '&here='.&escape($here).'"';
1322: $text='Open all folders';
1323: }
1324: if ($args->{'caller'} eq 'navmapsdisplay') {
1325: &add_linkitem($args->{'linkitems'},'changefolder',
1326: 'location.href='.$link,$text);
1327: } else {
1328: $result.='<a href='.$link.'>'.&mt($text).'</a>';
1329: }
1330: $result .= "\n";
1331: }
1332:
1333: # Check for any unread discussions in all resources.
1334: if ($args->{'caller'} eq 'navmapsdisplay') {
1335: &add_linkitem($args->{'linkitems'},'clearbubbles',
1336: 'document.clearbubbles.submit()',
1337: 'Mark all posts read');
1338: my $time=time;
1339: $result .= (<<END);
1340: <form name="clearbubbles" method="post" action="/adm/feedback">
1341: <input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
1342: <input type="hidden" name="navtime" value="$time" />
1343: END
1344: if ($args->{'sort'} eq 'discussion') {
1345: my $totdisc = 0;
1346: my $haveDisc = '';
1347: my @allres=$navmap->retrieveResources();
1348: foreach my $resource (@allres) {
1349: if ($resource->hasDiscussion()) {
1350: $haveDisc .= $resource->wrap_symb().':';
1351: $totdisc ++;
1352: }
1353: }
1354: if ($totdisc > 0) {
1355: $haveDisc =~ s/:$//;
1356: $result .= (<<END);
1357: <input type="hidden" name="navmaps" value="$haveDisc" />
1358: </form>
1359: END
1360: }
1361: }
1362: $result.='</form>';
1363: }
1364:
1365: if ($args->{'caller'} eq 'navmapsdisplay') {
1366: $result .= '<table><tr><td>'.
1367: &Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT').'</td>';
1368: if ($env{'environment.remotenavmap'} ne 'on') {
1369: $result .= '<td> </td>';
1370: } else {
1371: $result .= '</tr><tr>';
1372: }
1373: $result.=&show_linkitems($args->{'linkitems'});
1374: if ($args->{'sort_html'}) {
1375: if ($env{'environment.remotenavmap'} ne 'on') {
1376: $result.='<td> </td><td> </td><td> </td>'.
1377: '<td align="right">'.$args->{'sort_html'}.'</td></tr>';
1378: } else {
1379: $result.='</tr><tr><td align="left"><br />'.
1380: $args->{'sort_html'}.'</td></tr>';
1381: }
1382: }
1383: $result .= '</table>';
1384: } elsif ($args->{'sort_html'}) {
1385: $result.=$args->{'sort_html'};
1386: }
1387:
1388: $result .= "<br />\n";
1389: if ($r) {
1390: $r->print($result);
1391: $r->rflush();
1392: $result = "";
1393: }
1394: # End parameter setting
1395:
1396: # Data
1397: $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
1398: my $res = "Apache::lonnavmaps::resource";
1399: my %condenseStatuses =
1400: ( $res->NETWORK_FAILURE => 1,
1401: $res->NOTHING_SET => 1,
1402: $res->CORRECT => 1 );
1403: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
1404:
1405: # Shared variables
1406: $args->{'counter'} = 0; # counts the rows
1407: $args->{'indentLevel'} = 0;
1408: $args->{'isNewBranch'} = 0;
1409: $args->{'condensed'} = 0;
1410: my $location=
1411: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
1412: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt=' ' border='0' />");
1413: $args->{'displayedHereMarker'} = 0;
1414:
1415: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1416: # since structure actually doesn't matter, except what map has what resources.
1417: if ($args->{'suppressEmptySequences'}) {
1418: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1419: $it->{FIRST_RESOURCE},
1420: $it->{FINISH_RESOURCE},
1421: {}, undef, 1);
1422: my $depth = 0;
1423: $dfsit->next();
1424: my $curRes = $dfsit->next();
1425: while ($depth > -1) {
1426: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1427: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1428:
1429: if (ref($curRes)) {
1430: # Parallel pre-processing: Do sequences have non-filtered-out children?
1431: if ($curRes->is_map()) {
1432: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1433: # Sequences themselves do not count as visible children,
1434: # unless those sequences also have visible children.
1435: # This means if a sequence appears, there's a "promise"
1436: # that there's something under it if you open it, somewhere.
1437: } else {
1438: # Not a sequence: if it's filtered, ignore it, otherwise
1439: # rise up the stack and mark the sequences as having children
1440: if (&$filterFunc($curRes)) {
1441: for my $sequence (@{$dfsit->getStack()}) {
1442: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1443: }
1444: }
1445: }
1446: }
1447: } continue {
1448: $curRes = $dfsit->next();
1449: }
1450: }
1451:
1452: my $displayedJumpMarker = 0;
1453: # Set up iteration.
1454: my $now = time();
1455: my $in24Hours = $now + 24 * 60 * 60;
1456: my $rownum = 0;
1457:
1458: # export "here" marker information
1459: $args->{'here'} = $here;
1460:
1461: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1462: my @resources;
1463: my $code='';# sub { !(shift->is_map();) };
1464: if ($args->{'sort'} eq 'title') {
1465: my $oldFilterFunc = $filterFunc;
1466: my $filterFunc=
1467: sub {
1468: my ($res)=@_;
1469: if ($res->is_map()) { return 0;}
1470: return &$oldFilterFunc($res);
1471: };
1472: @resources=$navmap->retrieveResources(undef,$filterFunc);
1473: @resources= sort { &cmp_title($a,$b) } @resources;
1474: } elsif ($args->{'sort'} eq 'duedate') {
1475: my $oldFilterFunc = $filterFunc;
1476: my $filterFunc=
1477: sub {
1478: my ($res)=@_;
1479: if (!$res->is_problem()) { return 0;}
1480: return &$oldFilterFunc($res);
1481: };
1482: @resources=$navmap->retrieveResources(undef,$filterFunc);
1483: @resources= sort {
1484: if ($a->duedate ne $b->duedate) {
1485: return $a->duedate cmp $b->duedate;
1486: }
1487: my $value=&cmp_title($a,$b);
1488: return $value;
1489: } @resources;
1490: } elsif ($args->{'sort'} eq 'discussion') {
1491: my $oldFilterFunc = $filterFunc;
1492: my $filterFunc=
1493: sub {
1494: my ($res)=@_;
1495: if (!$res->hasDiscussion() &&
1496: !$res->getFeedback() &&
1497: !$res->getErrors()) { return 0;}
1498: return &$oldFilterFunc($res);
1499: };
1500: @resources=$navmap->retrieveResources(undef,$filterFunc);
1501: @resources= sort { &cmp_title($a,$b) } @resources;
1502: } else {
1503: #unknow sort mechanism or default
1504: undef($args->{'sort'});
1505: }
1506:
1507:
1508: while (1) {
1509: if ($args->{'sort'}) {
1510: $curRes = shift(@resources);
1511: } else {
1512: $curRes = $it->next($closeAllPages);
1513: }
1514: if (!$curRes) { last; }
1515:
1516: # Maintain indentation level.
1517: if ($curRes == $it->BEGIN_MAP() ||
1518: $curRes == $it->BEGIN_BRANCH() ) {
1519: $args->{'indentLevel'}++;
1520: }
1521: if ($curRes == $it->END_MAP() ||
1522: $curRes == $it->END_BRANCH() ) {
1523: $args->{'indentLevel'}--;
1524: }
1525: # Notice new branches
1526: if ($curRes == $it->BEGIN_BRANCH()) {
1527: $args->{'isNewBranch'} = 1;
1528: }
1529:
1530: # If this isn't an actual resource, continue on
1531: if (!ref($curRes)) {
1532: next;
1533: }
1534:
1535: # If this has been filtered out, continue on
1536: if (!(&$filterFunc($curRes))) {
1537: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1538: next;
1539: }
1540:
1541: # If this is an empty sequence and we're filtering them, continue on
1542: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1543: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1544: next;
1545: }
1546:
1547: # If we're suppressing navmaps and this is a navmap, continue on
1548: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1549: next;
1550: }
1551:
1552: $args->{'counter'}++;
1553:
1554: # Does it have multiple parts?
1555: $args->{'multipart'} = 0;
1556: $args->{'condensed'} = 0;
1557: my @parts;
1558:
1559: # Decide what parts to show.
1560: if ($curRes->is_problem() && $showParts) {
1561: @parts = @{$curRes->parts()};
1562: $args->{'multipart'} = $curRes->multipart();
1563:
1564: if ($condenseParts) { # do the condensation
1565: if (!$args->{'condensed'}) {
1566: # Decide whether to condense based on similarity
1567: my $status = $curRes->status($parts[0]);
1568: my $due = $curRes->duedate($parts[0]);
1569: my $open = $curRes->opendate($parts[0]);
1570: my $statusAllSame = 1;
1571: my $dueAllSame = 1;
1572: my $openAllSame = 1;
1573: for (my $i = 1; $i < scalar(@parts); $i++) {
1574: if ($curRes->status($parts[$i]) != $status){
1575: $statusAllSame = 0;
1576: }
1577: if ($curRes->duedate($parts[$i]) != $due ) {
1578: $dueAllSame = 0;
1579: }
1580: if ($curRes->opendate($parts[$i]) != $open) {
1581: $openAllSame = 0;
1582: }
1583: }
1584: # $*allSame is true if all the statuses were
1585: # the same. Now, if they are all the same and
1586: # match one of the statuses to condense, or they
1587: # are all open with the same due date, or they are
1588: # all OPEN_LATER with the same open date, display the
1589: # status of the first non-zero part (to get the 'correct'
1590: # status right, since 0 is never 'correct' or 'open').
1591: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1592: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1593: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1594: @parts = ($parts[0]);
1595: $args->{'condensed'} = 1;
1596: }
1597: }
1598: # Multipart problem with one part: always "condense" (happens
1599: # to match the desirable behavior)
1600: if ($curRes->countParts() == 1) {
1601: @parts = ($parts[0]);
1602: $args->{'condensed'} = 1;
1603: }
1604: }
1605: }
1606:
1607: # If the multipart problem was condensed, "forget" it was multipart
1608: if (scalar(@parts) == 1) {
1609: $args->{'multipart'} = 0;
1610: } else {
1611: # Add part 0 so we display it correctly.
1612: unshift @parts, '0';
1613: }
1614:
1615: {
1616: my ($src,$symb,$anchor,$stack);
1617: if ($args->{'sort'}) {
1618: my $it = $navmap->getIterator(undef, undef, undef, 1);
1619: while ( my $res=$it->next()) {
1620: if (ref($res) &&
1621: $res->symb() eq $curRes->symb()) { last; }
1622: }
1623: $stack=$it->getStack();
1624: } else {
1625: $stack=$it->getStack();
1626: }
1627: ($src,$symb,$anchor)=getLinkForResource($stack);
1628: if (defined($anchor)) { $anchor='#'.$anchor; }
1629: my $srcHasQuestion = $src =~ /\?/;
1630: $args->{"resourceLink"} = $src.
1631: ($srcHasQuestion?'&':'?') .
1632: 'symb=' . &escape($symb).$anchor;
1633: }
1634: # Now, we've decided what parts to show. Loop through them and
1635: # show them.
1636: foreach my $part (@parts) {
1637: $rownum ++;
1638: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1639:
1640: $result .= " <tr bgcolor='$backgroundColor'>\n";
1641:
1642: # Set up some data about the parts that the cols might want
1643: my $filter = $it->{FILTER};
1644:
1645: # Now, display each column.
1646: foreach my $col (@$cols) {
1647: my $colHTML = '';
1648: if (ref($col)) {
1649: $colHTML .= &$col($curRes, $part, $args);
1650: } else {
1651: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1652: }
1653:
1654: # If this is the first column and it's time to print
1655: # the anchor, do so
1656: if ($col == $cols->[0] &&
1657: $args->{'counter'} == $args->{'currentJumpIndex'} -
1658: $currentJumpDelta) {
1659: # Jam the anchor after the <td> tag;
1660: # necessary for valid HTML (which Mozilla requires)
1661: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1662: $displayedJumpMarker = 1;
1663: }
1664: $result .= $colHTML . "\n";
1665: }
1666: $result .= " </tr>\n";
1667: $args->{'isNewBranch'} = 0;
1668: }
1669:
1670: if ($r && $rownum % 20 == 0) {
1671: $r->print($result);
1672: $result = "";
1673: $r->rflush();
1674: }
1675: } continue {
1676: if ($r) {
1677: # If we have the connection, make sure the user is still connected
1678: my $c = $r->connection;
1679: if ($c->aborted()) {
1680: # Who cares what we do, nobody will see it anyhow.
1681: return '';
1682: }
1683: }
1684: }
1685:
1686: # Print out the part that jumps to #curloc if it exists
1687: # delay needed because the browser is processing the jump before
1688: # it finishes rendering, so it goes to the wrong place!
1689: # onload might be better, but this routine has no access to that.
1690: # On mozilla, the 0-millisecond timeout seems to prevent this;
1691: # it's quite likely this might fix other browsers, too, and
1692: # certainly won't hurt anything.
1693: if ($displayedJumpMarker) {
1694: $result .= "
1695: <script>
1696: if (location.href.indexOf('#curloc')==-1) {
1697: setTimeout(\"location += '#curloc';\", 0)
1698: }
1699: </script>";
1700: }
1701:
1702: $result .= "</table>";
1703:
1704: if ($r) {
1705: $r->print($result);
1706: $result = "";
1707: $r->rflush();
1708: }
1709:
1710: return $result;
1711: }
1712:
1713: sub add_linkitem {
1714: my ($linkitems,$name,$cmd,$text)=@_;
1715: $$linkitems{$name}{'cmd'}=$cmd;
1716: $$linkitems{$name}{'text'}=&mt($text);
1717: }
1718:
1719: sub show_linkitems {
1720: my ($linkitems)=@_;
1721: my @linkorder = ("blank","launchnav","closenav","firsthomework",
1722: "everything","uncompleted","changefolder","clearbubbles");
1723:
1724: my $result .= (<<ENDBLOCK);
1725: <td align="left">
1726: <script type="text/javascript">
1727: function changeNavDisplay () {
1728: var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
1729: ENDBLOCK
1730: foreach my $link (@linkorder) {
1731: $result.= "if (navchoice == '$link') {".
1732: $linkitems->{$link}{'cmd'}."}\n";
1733: }
1734: $result.='}
1735: </script>
1736: <form name="linkitems" method="post">
1737: <nobr><select name="toplink">'."\n";
1738: foreach my $link (@linkorder) {
1739: if (defined($linkitems->{$link})) {
1740: if ($linkitems->{$link}{'text'} ne '') {
1741: $result .= ' <option value="'.$link.'">'.
1742: $linkitems->{$link}{'text'}."</option>\n";
1743: }
1744: }
1745: }
1746: $result .= '</select> <input type="button" name="chgnav"
1747: value="Go" onClick="javascript:changeNavDisplay()" />
1748: </nobr></form></td>'."\n";
1749:
1750: return $result;
1751: }
1752:
1753: 1;
1754:
1755: package Apache::lonnavmaps::navmap;
1756:
1757: =pod
1758:
1759: =head1 Object: Apache::lonnavmaps::navmap
1760:
1761: =head2 Overview
1762:
1763: The navmap object's job is to provide access to the resources
1764: in the course as Apache::lonnavmaps::resource objects, and to
1765: query and manage the relationship between those resource objects.
1766:
1767: Generally, you'll use the navmap object in one of three basic ways.
1768: In order of increasing complexity and power:
1769:
1770: =over 4
1771:
1772: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides
1773: various ways to obtain resource objects, based on various identifiers.
1774: Use this when you want to request information about one object or
1775: a handful of resources you already know the identities of, from some
1776: other source. For more about Ids, Symbs, and MapPcs, see the
1777: Resource documentation. Note that Url should be a B<last resort>,
1778: not your first choice; it only really works when there is only one
1779: instance of the resource in the course, which only applies to
1780: maps, and even that may change in the future (see the B<getResourceByUrl>
1781: documentation for more details.)
1782:
1783: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
1784: retrieves resources matching some criterion and returns them
1785: in a flat array, with no structure information. Use this when
1786: you are manipulating a series of resources, based on what map
1787: the are in, but do not care about branching, or exactly how
1788: the maps and resources are related. This is the most common case.
1789:
1790: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
1791: the course's navmap in various ways without writing the traversal
1792: code yourself. See iterator documentation below. Use this when
1793: you need to know absolutely everything about the course, including
1794: branches and the precise relationship between maps and resources.
1795:
1796: =back
1797:
1798: =head2 Creation And Destruction
1799:
1800: To create a navmap object, use the following function:
1801:
1802: =over 4
1803:
1804: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1805:
1806: Creates a new navmap object. Returns the navmap object if this is
1807: successful, or B<undef> if not.
1808:
1809: =back
1810:
1811: =head2 Methods
1812:
1813: =over 4
1814:
1815: =item * B<getIterator>(first, finish, filter, condition):
1816:
1817: See iterator documentation below.
1818:
1819: =cut
1820:
1821: use strict;
1822: use GDBM_File;
1823: use Apache::lonnet;
1824: use LONCAPA;
1825:
1826: sub new {
1827: # magic invocation to create a class instance
1828: my $proto = shift;
1829: my $class = ref($proto) || $proto;
1830: my $self = {};
1831:
1832: # Resource cache stores navmap resources as we reference them. We generate
1833: # them on-demand so we don't pay for creating resources unless we use them.
1834: $self->{RESOURCE_CACHE} = {};
1835:
1836: # Network failure flag, if we accessed the course or user opt and
1837: # failed
1838: $self->{NETWORK_FAILURE} = 0;
1839:
1840: # tie the nav hash
1841:
1842: my %navmaphash;
1843: my %parmhash;
1844: my $courseFn = $env{"request.course.fn"};
1845: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1846: &GDBM_READER(), 0640))) {
1847: return undef;
1848: }
1849:
1850: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1851: &GDBM_READER(), 0640)))
1852: {
1853: untie %{$self->{PARM_HASH}};
1854: return undef;
1855: }
1856:
1857: $self->{NAV_HASH} = \%navmaphash;
1858: $self->{PARM_HASH} = \%parmhash;
1859: $self->{PARM_CACHE} = {};
1860:
1861: bless($self);
1862:
1863: return $self;
1864: }
1865:
1866: sub generate_course_user_opt {
1867: my $self = shift;
1868: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1869:
1870: my $uname=$env{'user.name'};
1871: my $udom=$env{'user.domain'};
1872: my $cid=$env{'request.course.id'};
1873: my $cdom=$env{'course.'.$cid.'.domain'};
1874: my $cnum=$env{'course.'.$cid.'.num'};
1875:
1876: # ------------------------------------------------- Get coursedata (if present)
1877: my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
1878: # Check for network failure
1879: if (!ref($courseopt)) {
1880: if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) {
1881: $self->{NETWORK_FAILURE} = 1;
1882: }
1883: undef($courseopt);
1884: }
1885:
1886: # --------------------------------------------------- Get userdata (if present)
1887:
1888: my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
1889: # Check for network failure
1890: if (!ref($useropt)) {
1891: if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) {
1892: $self->{NETWORK_FAILURE} = 1;
1893: }
1894: undef($useropt);
1895: }
1896:
1897: $self->{COURSE_OPT} = $courseopt;
1898: $self->{USER_OPT} = $useropt;
1899:
1900: $self->{COURSE_USER_OPT_GENERATED} = 1;
1901:
1902: return;
1903: }
1904:
1905: sub generate_email_discuss_status {
1906: my $self = shift;
1907: my $symb = shift;
1908: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1909:
1910: my $cid=$env{'request.course.id'};
1911: my $cdom=$env{'course.'.$cid.'.domain'};
1912: my $cnum=$env{'course.'.$cid.'.num'};
1913:
1914: my %emailstatus = &Apache::lonnet::dump('email_status');
1915: my $logoutTime = $emailstatus{'logout'};
1916: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
1917: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
1918: $courseLeaveTime : $logoutTime);
1919: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1920: $cdom, $cnum);
1921: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
1922: $env{'user.domain'},$env{'user.name'},'lastread');
1923: my %lastreadtime = ();
1924: foreach my $key (keys %lastread) {
1925: my $shortkey = $key;
1926: $shortkey =~ s/_lastread$//;
1927: $lastreadtime{$shortkey} = $lastread{$key};
1928: }
1929:
1930: my %feedback=();
1931: my %error=();
1932: my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},
1933: $env{'user.name'});
1934:
1935: foreach my $msgid (@keys) {
1936: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
1937: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
1938: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
1939: &Apache::lonenc::check_decrypt(\$symb);
1940: if (($fromcid ne '') && ($fromcid ne $cid)) {
1941: next;
1942: }
1943: if (defined($symb)) {
1944: if (defined($error) && $error == 1) {
1945: $error{$symb}.=','.$msgid;
1946: } else {
1947: $feedback{$symb}.=','.$msgid;
1948: }
1949: } else {
1950: my $plain=
1951: &LONCAPA::unescape(&LONCAPA::unescape($msgid));
1952: if ($plain=~/ \[([^\]]+)\]\:/) {
1953: my $url=$1;
1954: if ($plain=~/\:Error \[/) {
1955: $error{$url}.=','.$msgid;
1956: } else {
1957: $feedback{$url}.=','.$msgid;
1958: }
1959: }
1960: }
1961: }
1962: }
1963:
1964: #symbs of resources that have feedbacks (will be urls pre-2.3)
1965: $self->{FEEDBACK} = \%feedback;
1966: #or errors (will be urls pre 2.3)
1967: $self->{ERROR_MSG} = \%error;
1968: $self->{DISCUSSION_TIME} = \%discussiontime;
1969: $self->{EMAIL_STATUS} = \%emailstatus;
1970: $self->{LAST_READ} = \%lastreadtime;
1971:
1972: $self->{EMAIL_DISCUSS_GENERATED} = 1;
1973: }
1974:
1975: sub get_user_data {
1976: my $self = shift;
1977: if ($self->{RETRIEVED_USER_DATA}) { return; }
1978:
1979: # Retrieve performance data on problems
1980: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
1981: $env{'user.domain'},
1982: $env{'user.name'});
1983: $self->{STUDENT_DATA} = \%student_data;
1984:
1985: $self->{RETRIEVED_USER_DATA} = 1;
1986: }
1987:
1988: sub get_discussion_data {
1989: my $self = shift;
1990: if ($self->{RETRIEVED_DISCUSSION_DATA}) {
1991: return $self->{DISCUSSION_DATA};
1992: }
1993:
1994: $self->generate_email_discuss_status();
1995:
1996: my $cid=$env{'request.course.id'};
1997: my $cdom=$env{'course.'.$cid.'.domain'};
1998: my $cnum=$env{'course.'.$cid.'.num'};
1999: # Retrieve discussion data for resources in course
2000: my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum);
2001:
2002:
2003: $self->{DISCUSSION_DATA} = \%discussion_data;
2004: $self->{RETRIEVED_DISCUSSION_DATA} = 1;
2005: return $self->{DISCUSSION_DATA};
2006: }
2007:
2008:
2009: # Internal function: Takes a key to look up in the nav hash and implements internal
2010: # memory caching of that key.
2011: sub navhash {
2012: my $self = shift; my $key = shift;
2013: return $self->{NAV_HASH}->{$key};
2014: }
2015:
2016: =pod
2017:
2018: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2019: false otherwise. Undefined course maps indicate an error somewhere in
2020: LON-CAPA, and you will not be able to proceed with using the navmap.
2021: See the B<NAV> screen for an example of using this.
2022:
2023: =cut
2024:
2025: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2026: sub courseMapDefined {
2027: my $self = shift;
2028: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
2029:
2030: my $firstres = $self->navhash("map_start_$uri");
2031: my $lastres = $self->navhash("map_finish_$uri");
2032: return $firstres && $lastres;
2033: }
2034:
2035: sub getIterator {
2036: my $self = shift;
2037: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
2038: shift, undef, shift,
2039: shift, shift);
2040: return $iterator;
2041: }
2042:
2043: # Private method: Does the given resource (as a symb string) have
2044: # current discussion? Returns 0 if chat/mail data not extracted.
2045: sub hasDiscussion {
2046: my $self = shift;
2047: my $symb = shift;
2048: $self->generate_email_discuss_status();
2049:
2050: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2051:
2052: #return defined($self->{DISCUSSION_TIME}->{$symb});
2053:
2054: # backward compatibility (bulletin boards used to be 'wrapped')
2055: my $ressymb = $self->wrap_symb($symb);
2056: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2057: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2058: } else {
2059: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2060: return $self->{DISCUSSION_TIME}->{$ressymb} > 0; # in 1.2 will display speech bubble icons for all items with posts until marked as read (even if read in v 1.1).
2061: }
2062: }
2063:
2064: sub last_post_time {
2065: my $self = shift;
2066: my $symb = shift;
2067: my $ressymb = $self->wrap_symb($symb);
2068: return $self->{DISCUSSION_TIME}->{$ressymb};
2069: }
2070:
2071: sub discussion_info {
2072: my $self = shift;
2073: my $symb = shift;
2074: my $filter = shift;
2075:
2076: $self->get_discussion_data();
2077:
2078: my $ressymb = $self->wrap_symb($symb);
2079: # keys used to store bulletinboard postings use 'unwrapped' symb.
2080: my $discsymb = &escape($self->unwrap_symb($ressymb));
2081: my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
2082: if (!$version) { return; }
2083:
2084: my $prevread = $self->{LAST_READ}{$ressymb};
2085:
2086: my $count = 0;
2087: my $hiddenflag = 0;
2088: my $deletedflag = 0;
2089: my ($hidden,$deleted,%info);
2090:
2091: for (my $id=$version; $id>0; $id--) {
2092: my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
2093: my @keys=split(/:/,$vkeys);
2094: if (grep(/^hidden$/ ,@keys)) {
2095: if (!$hiddenflag) {
2096: $hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
2097: $hiddenflag = 1;
2098: }
2099: } elsif (grep(/^deleted$/,@keys)) {
2100: if (!$deletedflag) {
2101: $deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
2102: $deletedflag = 1;
2103: }
2104: } else {
2105: if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
2106: if ($filter eq 'unread') {
2107: if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
2108: next;
2109: }
2110: }
2111: $count++;
2112: $info{$count}{'subject'} =
2113: $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
2114: $info{$count}{'id'} = $id;
2115: $info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'};
2116: }
2117: }
2118: }
2119: if (wantarray) {
2120: return ($count,%info);
2121: }
2122: return $count;
2123: }
2124:
2125: sub wrap_symb {
2126: my $self = shift;
2127: my $symb = shift;
2128: if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
2129: unless ($symb =~ m|adm/wrapper/adm|) {
2130: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
2131: }
2132: }
2133: return $symb;
2134: }
2135:
2136: sub unwrap_symb {
2137: my $self = shift;
2138: my $ressymb = shift;
2139: my $discsymb = $ressymb;
2140: if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
2141: $discsymb = $1.$2;
2142: }
2143: return $discsymb;
2144: }
2145:
2146: # Private method: Does the given resource (as a symb string) have
2147: # current feedback? Returns the string in the feedback hash, which
2148: # will be false if it does not exist.
2149:
2150: sub getFeedback {
2151: my $self = shift;
2152: my $symb = shift;
2153: my $source = shift;
2154:
2155: $self->generate_email_discuss_status();
2156:
2157: if (!defined($self->{FEEDBACK})) { return ""; }
2158:
2159: my $feedback;
2160: if ($self->{FEEDBACK}->{$symb}) {
2161: $feedback = $self->{FEEDBACK}->{$symb};
2162: if ($self->{FEEDBACK}->{$source}) {
2163: $feedback .= ','.$self->{FEEDBACK}->{$source};
2164: }
2165: } else {
2166: if ($self->{FEEDBACK}->{$source}) {
2167: $feedback = $self->{FEEDBACK}->{$source};
2168: }
2169: }
2170: return $feedback;
2171: }
2172:
2173: # Private method: Get the errors for that resource (by source).
2174: sub getErrors {
2175: my $self = shift;
2176: my $symb = shift;
2177: my $src = shift;
2178:
2179: $self->generate_email_discuss_status();
2180:
2181: if (!defined($self->{ERROR_MSG})) { return ""; }
2182:
2183: my $errors;
2184: if ($self->{ERROR_MSG}->{$symb}) {
2185: $errors = $self->{ERROR_MSG}->{$symb};
2186: if ($self->{ERROR_MSG}->{$src}) {
2187: $errors .= ','.$self->{ERROR_MSG}->{$src};
2188: }
2189: } else {
2190: if ($self->{ERROR_MSG}->{$src}) {
2191: $errors = $self->{ERROR_MSG}->{$src};
2192: }
2193: }
2194: return $errors;
2195: }
2196:
2197: =pod
2198:
2199: =item * B<getById>(id):
2200:
2201: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2202: object for that resource. This method, or other methods that use it
2203: (as in the resource object) is the only proper way to obtain a
2204: resource object.
2205:
2206: =item * B<getBySymb>(symb):
2207:
2208: Based on the symb of the resource, get a resource object for that
2209: resource. This is one of the proper ways to get a resource object.
2210:
2211: =item * B<getMapByMapPc>(map_pc):
2212:
2213: Based on the map_pc of the resource, get a resource object for
2214: the given map. This is one of the proper ways to get a resource object.
2215:
2216: =cut
2217:
2218: # The strategy here is to cache the resource objects, and only construct them
2219: # as we use them. The real point is to prevent reading any more from the tied
2220: # hash than we have to, which should hopefully alleviate speed problems.
2221:
2222: sub getById {
2223: my $self = shift;
2224: my $id = shift;
2225:
2226: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2227: {
2228: return $self->{RESOURCE_CACHE}->{$id};
2229: }
2230:
2231: # resource handles inserting itself into cache.
2232: # Not clear why the quotes are necessary, but as of this
2233: # writing it doesn't work without them.
2234: return "Apache::lonnavmaps::resource"->new($self, $id);
2235: }
2236:
2237: sub getBySymb {
2238: my $self = shift;
2239: my $symb = shift;
2240:
2241: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
2242: my $map = $self->getResourceByUrl($mapUrl);
2243: my $returnvalue = undef;
2244: if (ref($map)) {
2245: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2246: }
2247: return $returnvalue;
2248: }
2249:
2250: sub getByMapPc {
2251: my $self = shift;
2252: my $map_pc = shift;
2253: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2254: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2255: return $self->getById($map_id);
2256: }
2257:
2258: =pod
2259:
2260: =item * B<firstResource>():
2261:
2262: Returns a resource object reference corresponding to the first
2263: resource in the navmap.
2264:
2265: =cut
2266:
2267: sub firstResource {
2268: my $self = shift;
2269: my $firstResource = $self->navhash('map_start_' .
2270: &Apache::lonnet::clutter($env{'request.course.uri'}));
2271: return $self->getById($firstResource);
2272: }
2273:
2274: =pod
2275:
2276: =item * B<finishResource>():
2277:
2278: Returns a resource object reference corresponding to the last resource
2279: in the navmap.
2280:
2281: =cut
2282:
2283: sub finishResource {
2284: my $self = shift;
2285: my $firstResource = $self->navhash('map_finish_' .
2286: &Apache::lonnet::clutter($env{'request.course.uri'}));
2287: return $self->getById($firstResource);
2288: }
2289:
2290: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2291: # the actual lookup; parmval caches the results.
2292: sub parmval {
2293: my $self = shift;
2294: my ($what,$symb,$recurse)=@_;
2295: my $hashkey = $what."|||".$symb;
2296:
2297: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2298: if (wantarray) {
2299: return @{$self->{PARM_CACHE}->{$hashkey}};
2300: } else {
2301: return $self->{PARM_CACHE}->{$hashkey}->[0];
2302: }
2303: }
2304:
2305: my $result = $self->parmval_real($what, $symb, $recurse);
2306: $self->{PARM_CACHE}->{$hashkey} = $result;
2307: if (wantarray) {
2308: return @{$result};
2309: }
2310: return $result->[0];
2311: }
2312:
2313: sub parmval_real {
2314: my $self = shift;
2315: my ($what,$symb,$recurse) = @_;
2316:
2317: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2318: $self->generate_course_user_opt();
2319:
2320: my $cid=$env{'request.course.id'};
2321: my $csec=$env{'request.course.sec'};
2322: my $cgroup='';
2323: my @cgrps=split(/:/,$env{'request.course.groups'});
2324: if (@cgrps > 0) {
2325: @cgrps = sort(@cgrps);
2326: $cgroup = $cgrps[0];
2327: }
2328: my $uname=$env{'user.name'};
2329: my $udom=$env{'user.domain'};
2330:
2331: unless ($symb) { return ['']; }
2332: my $result='';
2333:
2334: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
2335: $mapname = &Apache::lonnet::deversion($mapname);
2336: # ----------------------------------------------------- Cascading lookup scheme
2337: my $rwhat=$what;
2338: $what=~s/^parameter\_//;
2339: $what=~s/\_/\./;
2340:
2341: my $symbparm=$symb.'.'.$what;
2342: my $mapparm=$mapname.'___(all).'.$what;
2343: my $usercourseprefix=$cid;
2344:
2345: my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
2346: my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
2347: my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;
2348:
2349: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2350: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2351: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2352:
2353: my $courselevel= $usercourseprefix.'.'.$what;
2354: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2355: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2356:
2357: my $useropt = $self->{USER_OPT};
2358: my $courseopt = $self->{COURSE_OPT};
2359: my $parmhash = $self->{PARM_HASH};
2360:
2361: # ---------------------------------------------------------- first, check user
2362: if ($uname and defined($useropt)) {
2363: if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }
2364: if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }
2365: if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }
2366: }
2367:
2368: # ------------------------------------------------------- second, check course
2369: if ($cgroup ne '' and defined($courseopt)) {
2370: if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }
2371: if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }
2372: if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }
2373: }
2374:
2375: if ($csec and defined($courseopt)) {
2376: if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }
2377: if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }
2378: if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }
2379: }
2380:
2381: if (defined($courseopt)) {
2382: if (defined($$courseopt{$courselevelr})) { return [$$courseopt{$courselevelr},'resource']; }
2383: }
2384:
2385: # ----------------------------------------------------- third, check map parms
2386:
2387: my $thisparm=$$parmhash{$symbparm};
2388: if (defined($thisparm)) { return [$thisparm,'map']; }
2389:
2390: # ----------------------------------------------------- fourth , check default
2391:
2392: my $meta_rwhat=$rwhat;
2393: $meta_rwhat=~s/\./_/g;
2394: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
2395: if (defined($default)) { return [$default,'resource']}
2396: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
2397: if (defined($default)) { return [$default,'resource']}
2398: # --------------------------------------------------- fifth, check more course
2399: if (defined($courseopt)) {
2400: if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }
2401: if (defined($$courseopt{$courselevel})) {
2402: my $ret = [$$courseopt{$courselevel},'course'];
2403: return $ret;
2404: }
2405: }
2406: # --------------------------------------------------- sixth , cascade up parts
2407:
2408: my ($space,@qualifier)=split(/\./,$rwhat);
2409: my $qualifier=join('.',@qualifier);
2410: unless ($space eq '0') {
2411: my @parts=split(/_/,$space);
2412: my $id=pop(@parts);
2413: my $part=join('_',@parts);
2414: if ($part eq '') { $part='0'; }
2415: my @partgeneral=$self->parmval($part.".$qualifier",$symb,1);
2416: if (defined($partgeneral[0])) { return \@partgeneral; }
2417: }
2418: if ($recurse) { return []; }
2419: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat);
2420: if (defined($pack_def)) { return [$pack_def,'resource']; }
2421: return [''];
2422: }
2423:
2424: =pod
2425:
2426: =item * B<getResourceByUrl>(url,multiple):
2427:
2428: Retrieves a resource object by URL of the resource, unless the optional
2429: multiple parameter is included in which case an array of resource
2430: objects is returned. If passed a resource object, it will simply return
2431: it, so it is safe to use this method in code like
2432: "$res = $navmap->getResourceByUrl($res)"
2433: if you're not sure if $res is already an object, or just a URL. If the
2434: resource appears multiple times in the course, only the first instance
2435: will be returned (useful for maps), unless the multiple parameter has
2436: been included, in which case all instances are returned in an array.
2437:
2438: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
2439:
2440: The map is a specification of a map to retreive the resources from,
2441: either as a url or as an object. The filterFunc is a reference to a
2442: function that takes a resource object as its one argument and returns
2443: true if the resource should be included, or false if it should not
2444: be. If recursive is true, the map will be recursively examined,
2445: otherwise it will not be. If bailout is true, the function will return
2446: as soon as it finds a resource, if false it will finish. If showall is
2447: true it will not hide maps that contain nothing but one other map. By
2448: default, the map is the top-level map of the course, filterFunc is a
2449: function that always returns 1, recursive is true, bailout is false,
2450: showall is false. The resources will be returned in a list containing
2451: the resource objects for the corresponding resources, with B<no
2452: structure information> in the list; regardless of branching,
2453: recursion, etc., it will be a flat list.
2454:
2455: Thus, this is suitable for cases where you don't want the structure,
2456: just a list of all resources. It is also suitable for finding out how
2457: many resources match a given description; for this use, if all you
2458: want to know is if I<any> resources match the description, the bailout
2459: parameter will allow you to avoid potentially expensive enumeration of
2460: all matching resources.
2461:
2462: =item * B<hasResource>(map, filterFunc, recursive, showall):
2463:
2464: Convenience method for
2465:
2466: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
2467:
2468: which will tell whether the map has resources matching the description
2469: in the filter function.
2470:
2471: =item * B<usedVersion>(url):
2472:
2473: Retrieves version infomation for a url. Returns the version (a number, or
2474: the string "mostrecent") for resources which have version information in
2475: the big hash.
2476:
2477: =cut
2478:
2479:
2480: sub getResourceByUrl {
2481: my $self = shift;
2482: my $resUrl = shift;
2483: my $multiple = shift;
2484:
2485: if (ref($resUrl)) { return $resUrl; }
2486:
2487: $resUrl = &Apache::lonnet::clutter($resUrl);
2488: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2489: if (!$resId) { return ''; }
2490: if ($multiple) {
2491: my @resources = ();
2492: my @resIds = split (/,/, $resId);
2493: foreach my $id (@resIds) {
2494: my $resourceId = $self->getById($id);
2495: if ($resourceId) {
2496: push(@resources,$resourceId);
2497: }
2498: }
2499: return @resources;
2500: } else {
2501: if ($resId =~ /,/) {
2502: $resId = (split (/,/, $resId))[0];
2503: }
2504: return $self->getById($resId);
2505: }
2506: }
2507:
2508: sub retrieveResources {
2509: my $self = shift;
2510: my $map = shift;
2511: my $filterFunc = shift;
2512: if (!defined ($filterFunc)) {
2513: $filterFunc = sub {return 1;};
2514: }
2515: my $recursive = shift;
2516: if (!defined($recursive)) { $recursive = 1; }
2517: my $bailout = shift;
2518: if (!defined($bailout)) { $bailout = 0; }
2519: my $showall = shift;
2520: # Create the necessary iterator.
2521: if (!ref($map)) { # assume it's a url of a map.
2522: $map = $self->getResourceByUrl($map);
2523: }
2524:
2525: # If nothing was passed, assume top-level map
2526: if (!$map) {
2527: $map = $self->getById('0.0');
2528: }
2529:
2530: # Check the map's validity.
2531: if (!$map->is_map()) {
2532: # Oh, to throw an exception.... how I'd love that!
2533: return ();
2534: }
2535:
2536: # Get an iterator.
2537: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
2538: undef, $recursive, $showall);
2539:
2540: my @resources = ();
2541:
2542: if (&$filterFunc($map)) {
2543: push(@resources, $map);
2544: }
2545:
2546: # Run down the iterator and collect the resources.
2547: my $curRes;
2548:
2549: while ($curRes = $it->next()) {
2550: if (ref($curRes)) {
2551: if (!&$filterFunc($curRes)) {
2552: next;
2553: }
2554:
2555: push(@resources, $curRes);
2556:
2557: if ($bailout) {
2558: return @resources;
2559: }
2560: }
2561:
2562: }
2563:
2564: return @resources;
2565: }
2566:
2567: sub hasResource {
2568: my $self = shift;
2569: my $map = shift;
2570: my $filterFunc = shift;
2571: my $recursive = shift;
2572: my $showall = shift;
2573:
2574: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
2575: }
2576:
2577: sub usedVersion {
2578: my $self = shift;
2579: my $linkurl = shift;
2580: return $self->navhash("version_$linkurl");
2581: }
2582:
2583: 1;
2584:
2585: package Apache::lonnavmaps::iterator;
2586: use Scalar::Util qw(weaken);
2587: use Apache::lonnet;
2588:
2589: =pod
2590:
2591: =back
2592:
2593: =head1 Object: navmap Iterator
2594:
2595: An I<iterator> encapsulates the logic required to traverse a data
2596: structure. navmap uses an iterator to traverse the course map
2597: according to the criteria you wish to use.
2598:
2599: To obtain an iterator, call the B<getIterator>() function of a
2600: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2601: directly.) This will return a reference to the iterator:
2602:
2603: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2604:
2605: To get the next thing from the iterator, call B<next>:
2606:
2607: C<my $nextThing = $resourceIterator-E<gt>next()>
2608:
2609: getIterator behaves as follows:
2610:
2611: =over 4
2612:
2613: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2614:
2615: All parameters are optional. firstResource is a resource reference
2616: corresponding to where the iterator should start. It defaults to
2617: navmap->firstResource() for the corresponding nav map. finishResource
2618: corresponds to where you want the iterator to end, defaulting to
2619: navmap->finishResource(). filterHash is a hash used as a set
2620: containing strings representing the resource IDs, defaulting to
2621: empty. Condition is a 1 or 0 that sets what to do with the filter
2622: hash: If a 0, then only resources that exist IN the filterHash will be
2623: recursed on. If it is a 1, only resources NOT in the filterHash will
2624: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2625: false (default), the iterator will only return the first level of map
2626: that is not just a single, 'redirecting' map. If true, the iterator
2627: will return all information, starting with the top-level map,
2628: regardless of content. returnTopMap, if true (default false), will
2629: cause the iterator to return the top-level map object (resource 0.0)
2630: before anything else.
2631:
2632: Thus, by default, only top-level resources will be shown. Change the
2633: condition to a 1 without changing the hash, and all resources will be
2634: shown. Changing the condition to 1 and including some values in the
2635: hash will allow you to selectively suppress parts of the navmap, while
2636: leaving it on 0 and adding things to the hash will allow you to
2637: selectively add parts of the nav map. See the handler code for
2638: examples.
2639:
2640: The iterator will return either a reference to a resource object, or a
2641: token representing something in the map, such as the beginning of a
2642: new branch. The possible tokens are:
2643:
2644: =over 4
2645:
2646: =item * B<END_ITERATOR>:
2647:
2648: The iterator has returned all that it's going to. Further calls to the
2649: iterator will just produce more of these. This is a "false" value, and
2650: is the only false value the iterator which will be returned, so it can
2651: be used as a loop sentinel.
2652:
2653: =item * B<BEGIN_MAP>:
2654:
2655: A new map is being recursed into. This is returned I<after> the map
2656: resource itself is returned.
2657:
2658: =item * B<END_MAP>:
2659:
2660: The map is now done.
2661:
2662: =item * B<BEGIN_BRANCH>:
2663:
2664: A branch is now starting. The next resource returned will be the first
2665: in that branch.
2666:
2667: =item * B<END_BRANCH>:
2668:
2669: The branch is now done.
2670:
2671: =back
2672:
2673: The tokens are retreivable via methods on the iterator object, i.e.,
2674: $iterator->END_MAP.
2675:
2676: Maps can contain empty resources. The iterator will automatically skip
2677: over such resources, but will still treat the structure
2678: correctly. Thus, a complicated map with several branches, but
2679: consisting entirely of empty resources except for one beginning or
2680: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2681: but only one resource will be returned.
2682:
2683: =back
2684:
2685: =head2 Normal Usage
2686:
2687: Normal usage of the iterator object is to do the following:
2688:
2689: my $it = $navmap->getIterator([your params here]);
2690: my $curRes;
2691: while ($curRes = $it->next()) {
2692: [your logic here]
2693: }
2694:
2695: Note that inside of the loop, it's frequently useful to check if
2696: "$curRes" is a reference or not with the reference function; only
2697: resource objects will be references, and any non-references will
2698: be the tokens described above.
2699:
2700: Also note there is some old code floating around that trys to track
2701: the depth of the iterator to see when it's done; do not copy that
2702: code. It is difficult to get right and harder to understand than
2703: this. They should be migrated to this new style.
2704:
2705: =cut
2706:
2707: # Here are the tokens for the iterator:
2708:
2709: sub END_ITERATOR { return 0; }
2710: sub BEGIN_MAP { return 1; } # begining of a new map
2711: sub END_MAP { return 2; } # end of the map
2712: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2713: sub END_BRANCH { return 4; } # end of a branch
2714: sub FORWARD { return 1; } # go forward
2715: sub BACKWARD { return 2; }
2716:
2717: sub min {
2718: (my $a, my $b) = @_;
2719: if ($a < $b) { return $a; } else { return $b; }
2720: }
2721:
2722: sub new {
2723: # magic invocation to create a class instance
2724: my $proto = shift;
2725: my $class = ref($proto) || $proto;
2726: my $self = {};
2727:
2728: weaken($self->{NAV_MAP} = shift);
2729: return undef unless ($self->{NAV_MAP});
2730:
2731: # Handle the parameters
2732: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2733: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2734:
2735: # If the given resources are just the ID of the resource, get the
2736: # objects
2737: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2738: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2739: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2740: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2741:
2742: $self->{FILTER} = shift;
2743:
2744: # A hash, used as a set, of resource already seen
2745: $self->{ALREADY_SEEN} = shift;
2746: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2747: $self->{CONDITION} = shift;
2748:
2749: # Do we want to automatically follow "redirection" maps?
2750: $self->{FORCE_TOP} = shift;
2751:
2752: # Do we want to return the top-level map object (resource 0.0)?
2753: $self->{RETURN_0} = shift;
2754: # have we done that yet?
2755: $self->{HAVE_RETURNED_0} = 0;
2756:
2757: # Now, we need to pre-process the map, by walking forward and backward
2758: # over the parts of the map we're going to look at.
2759:
2760: # The processing steps are exactly the same, except for a few small
2761: # changes, so I bundle those up in the following list of two elements:
2762: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2763: # first_resource).
2764: # This prevents writing nearly-identical code twice.
2765: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2766: 'FIRST_RESOURCE'],
2767: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2768: 'FINISH_RESOURCE'] );
2769:
2770: my $maxDepth = 0; # tracks max depth
2771:
2772: # If there is only one resource in this map, and it's a map, we
2773: # want to remember that, so the user can ask for the first map
2774: # that isn't just a redirector.
2775: my $resource; my $resourceCount = 0;
2776:
2777: # Documentation on this algorithm can be found in the CVS repository at
2778: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2779: # in that file.
2780: # **1**
2781:
2782: foreach my $pass (@iterations) {
2783: my $direction = $pass->[0];
2784: my $valName = $pass->[1];
2785: my $nextResourceMethod = $pass->[2];
2786: my $firstResourceName = $pass->[3];
2787:
2788: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2789: $self->{FIRST_RESOURCE},
2790: $self->{FINISH_RESOURCE},
2791: {}, undef, 0, $direction);
2792:
2793: # prime the recursion
2794: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
2795: $iterator->next();
2796: my $curRes = $iterator->next();
2797: my $depth = 1;
2798: while ($depth > 0) {
2799: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2800: if ($curRes == $iterator->END_MAP()) { $depth--; }
2801:
2802: if (ref($curRes)) {
2803: # If there's only one resource, this will save it
2804: # we have to filter empty resources from consideration here,
2805: # or even "empty", redirecting maps have two (start & finish)
2806: # or three (start, finish, plus redirector)
2807: if($direction == FORWARD && $curRes->src()) {
2808: $resource = $curRes; $resourceCount++;
2809: }
2810: my $resultingVal = $curRes->{DATA}->{$valName};
2811: my $nextResources = $curRes->$nextResourceMethod();
2812: my $nextCount = scalar(@{$nextResources});
2813:
2814: if ($nextCount == 1) { # **3**
2815: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2816: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2817: }
2818:
2819: if ($nextCount > 1) { # **4**
2820: foreach my $res (@{$nextResources}) {
2821: my $current = $res->{DATA}->{$valName} || 999999999;
2822: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2823: }
2824: }
2825: }
2826:
2827: # Assign the final val (**2**)
2828: if (ref($curRes) && $direction == BACKWARD()) {
2829: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2830: $curRes->{DATA}->{BOT_UP_VAL});
2831:
2832: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2833: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
2834: }
2835:
2836: $curRes = $iterator->next();
2837: }
2838: }
2839:
2840: # Check: Was this only one resource, a map?
2841: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
2842: my $firstResource = $resource->map_start();
2843: my $finishResource = $resource->map_finish();
2844: return
2845: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2846: $finishResource, $self->{FILTER},
2847: $self->{ALREADY_SEEN},
2848: $self->{CONDITION},
2849: $self->{FORCE_TOP});
2850:
2851: }
2852:
2853: # Set up some bookkeeping information.
2854: $self->{CURRENT_DEPTH} = 0;
2855: $self->{MAX_DEPTH} = $maxDepth;
2856: $self->{STACK} = [];
2857: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2858: $self->{FINISHED} = 0; # When true, the iterator has finished
2859:
2860: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2861: push @{$self->{STACK}}, [];
2862: }
2863:
2864: # Prime the recursion w/ the first resource **5**
2865: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2866: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2867:
2868: bless ($self);
2869:
2870: return $self;
2871: }
2872:
2873: sub next {
2874: my $self = shift;
2875: my $closeAllPages=shift;
2876: if ($self->{FINISHED}) {
2877: return END_ITERATOR();
2878: }
2879:
2880: # If we want to return the top-level map object, and haven't yet,
2881: # do so.
2882: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2883: $self->{HAVE_RETURNED_0} = 1;
2884: return $self->{NAV_MAP}->getById('0.0');
2885: }
2886: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {
2887: $self->{HAVE_RETURNED_0_BEGIN_MAP} = 1;
2888: return $self->BEGIN_MAP();
2889: }
2890:
2891: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2892: # grab the next from the recursive iterator
2893: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
2894:
2895: # is it a begin or end map? If so, update the depth
2896: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2897: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2898:
2899: # Are we back at depth 0? If so, stop recursing
2900: if ($self->{RECURSIVE_DEPTH} == 0) {
2901: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2902: }
2903:
2904: return $next;
2905: }
2906:
2907: if (defined($self->{FORCE_NEXT})) {
2908: my $tmp = $self->{FORCE_NEXT};
2909: $self->{FORCE_NEXT} = undef;
2910: return $tmp;
2911: }
2912:
2913: # Have we not yet begun? If not, return BEGIN_MAP and
2914: # remember we've started.
2915: if ( !$self->{STARTED} ) {
2916: $self->{STARTED} = 1;
2917: return $self->BEGIN_MAP();
2918: }
2919:
2920: # Here's the guts of the iterator.
2921:
2922: # Find the next resource, if any.
2923: my $found = 0;
2924: my $i = $self->{MAX_DEPTH};
2925: my $newDepth;
2926: my $here;
2927: while ( $i >= 0 && !$found ) {
2928: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
2929: $here = pop @{$self->{STACK}->[$i]}; # **7**
2930: $found = 1;
2931: $newDepth = $i;
2932: }
2933: $i--;
2934: }
2935:
2936: # If we still didn't find anything, we're done.
2937: if ( !$found ) {
2938: # We need to get back down to the correct branch depth
2939: if ( $self->{CURRENT_DEPTH} > 0 ) {
2940: $self->{CURRENT_DEPTH}--;
2941: return END_BRANCH();
2942: } else {
2943: $self->{FINISHED} = 1;
2944: return END_MAP();
2945: }
2946: }
2947:
2948: # If this is not a resource, it must be an END_BRANCH marker we want
2949: # to return directly.
2950: if (!ref($here)) { # **8**
2951: if ($here == END_BRANCH()) { # paranoia, in case of later extension
2952: $self->{CURRENT_DEPTH}--;
2953: return $here;
2954: }
2955: }
2956:
2957: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
2958: $self->{HERE} = $here;
2959:
2960: # Get to the right level
2961: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
2962: push @{$self->{STACK}->[$newDepth]}, $here;
2963: $self->{CURRENT_DEPTH}--;
2964: return END_BRANCH();
2965: }
2966: if ( $self->{CURRENT_DEPTH} < $newDepth) {
2967: push @{$self->{STACK}->[$newDepth]}, $here;
2968: $self->{CURRENT_DEPTH}++;
2969: return BEGIN_BRANCH();
2970: }
2971:
2972: # If we made it here, we have the next resource, and we're at the
2973: # right branch level. So let's examine the resource for where
2974: # we can get to from here.
2975:
2976: # So we need to look at all the resources we can get to from here,
2977: # categorize them if we haven't seen them, remember if we have a new
2978: my $nextUnfiltered = $here->getNext();
2979: my $maxDepthAdded = -1;
2980:
2981: for (@$nextUnfiltered) {
2982: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
2983: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
2984: push @{$self->{STACK}->[$depth]}, $_;
2985: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
2986: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
2987: }
2988: }
2989:
2990: # Is this the end of a branch? If so, all of the resources examined above
2991: # led to lower levels than the one we are currently at, so we push a END_BRANCH
2992: # marker onto the stack so we don't forget.
2993: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
2994: # BC branch and gets to C, it will see F as the only next resource, but it's
2995: # one level lower. Thus, this is the end of the branch, since there are no
2996: # more resources added to this level or above.
2997: # We don't do this if the examined resource is the finish resource,
2998: # because the condition given above is true, but the "END_MAP" will
2999: # take care of things and we should already be at depth 0.
3000: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
3001: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
3002: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3003: }
3004:
3005: # That ends the main iterator logic. Now, do we want to recurse
3006: # down this map (if this resource is a map)?
3007: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
3008: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3009: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3010: my $firstResource = $self->{HERE}->map_start();
3011: my $finishResource = $self->{HERE}->map_finish();
3012:
3013: $self->{RECURSIVE_ITERATOR} =
3014: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3015: $finishResource, $self->{FILTER},
3016: $self->{ALREADY_SEEN},
3017: $self->{CONDITION},
3018: $self->{FORCE_TOP});
3019: }
3020:
3021: # If this is a blank resource, don't actually return it.
3022: # Should you ever find you need it, make sure to add an option to the code
3023: # that you can use; other things depend on this behavior.
3024: my $browsePriv = $self->{HERE}->browsePriv();
3025: if (!$self->{HERE}->src() ||
3026: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
3027: return $self->next($closeAllPages);
3028: }
3029:
3030: return $self->{HERE};
3031:
3032: }
3033:
3034: =pod
3035:
3036: The other method available on the iterator is B<getStack>, which
3037: returns an array populated with the current 'stack' of maps, as
3038: references to the resource objects. Example: This is useful when
3039: making the navigation map, as we need to check whether we are under a
3040: page map to see if we need to link directly to the resource, or to the
3041: page. The first elements in the array will correspond to the top of
3042: the stack (most inclusive map).
3043:
3044: =cut
3045:
3046: sub getStack {
3047: my $self=shift;
3048:
3049: my @stack;
3050:
3051: $self->populateStack(\@stack);
3052:
3053: return \@stack;
3054: }
3055:
3056: # Private method: Calls the iterators recursively to populate the stack.
3057: sub populateStack {
3058: my $self=shift;
3059: my $stack = shift;
3060:
3061: push @$stack, $self->{HERE} if ($self->{HERE});
3062:
3063: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3064: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3065: }
3066: }
3067:
3068: 1;
3069:
3070: package Apache::lonnavmaps::DFSiterator;
3071: use Scalar::Util qw(weaken);
3072: use Apache::lonnet;
3073:
3074: # Not documented in the perldoc: This is a simple iterator that just walks
3075: # through the nav map and presents the resources in a depth-first search
3076: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3077: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3078: # useful for pre-processing of some kind, and is in fact used by the main
3079: # iterator that way, but that's about it.
3080: # One could imagine merging this into the init routine of the main iterator,
3081: # but this might as well be left separate, since it is possible some other
3082: # use might be found for it. - Jeremy
3083:
3084: # Unlike the main iterator, this DOES return all resources, even blank ones.
3085: # The main iterator needs them to correctly preprocess the map.
3086:
3087: sub BEGIN_MAP { return 1; } # begining of a new map
3088: sub END_MAP { return 2; } # end of the map
3089: sub FORWARD { return 1; } # go forward
3090: sub BACKWARD { return 2; }
3091:
3092: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3093: # filter hash ref (or undef), already seen hash or undef, condition
3094: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
3095: sub new {
3096: # magic invocation to create a class instance
3097: my $proto = shift;
3098: my $class = ref($proto) || $proto;
3099: my $self = {};
3100:
3101: weaken($self->{NAV_MAP} = shift);
3102: return undef unless ($self->{NAV_MAP});
3103:
3104: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3105: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3106:
3107: # If the given resources are just the ID of the resource, get the
3108: # objects
3109: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3110: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3111: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3112: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3113:
3114: $self->{FILTER} = shift;
3115:
3116: # A hash, used as a set, of resource already seen
3117: $self->{ALREADY_SEEN} = shift;
3118: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
3119: $self->{CONDITION} = shift;
3120: $self->{DIRECTION} = shift || FORWARD();
3121:
3122: # Flag: Have we started yet?
3123: $self->{STARTED} = 0;
3124:
3125: # Should we continue calling the recursive iterator, if any?
3126: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3127: # The recursive iterator, if any
3128: $self->{RECURSIVE_ITERATOR} = undef;
3129: # Are we recursing on a map, or a branch?
3130: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3131: # And the count of how deep it is, so that this iterator can keep track of
3132: # when to pick back up again.
3133: $self->{RECURSIVE_DEPTH} = 0;
3134:
3135: # For keeping track of our branches, we maintain our own stack
3136: $self->{STACK} = [];
3137:
3138: # Start with the first resource
3139: if ($self->{DIRECTION} == FORWARD) {
3140: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
3141: } else {
3142: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
3143: }
3144:
3145: bless($self);
3146: return $self;
3147: }
3148:
3149: sub next {
3150: my $self = shift;
3151:
3152: # Are we using a recursive iterator? If so, pull from that and
3153: # watch the depth; we want to resume our level at the correct time.
3154: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3155: # grab the next from the recursive iterator
3156: my $next = $self->{RECURSIVE_ITERATOR}->next();
3157:
3158: # is it a begin or end map? Update depth if so
3159: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3160: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3161:
3162: # Are we back at depth 0? If so, stop recursing.
3163: if ($self->{RECURSIVE_DEPTH} == 0) {
3164: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3165: }
3166:
3167: return $next;
3168: }
3169:
3170: # Is there a current resource to grab? If not, then return
3171: # END_MAP, which will end the iterator.
3172: if (scalar(@{$self->{STACK}}) == 0) {
3173: return $self->END_MAP();
3174: }
3175:
3176: # Have we not yet begun? If not, return BEGIN_MAP and
3177: # remember that we've started.
3178: if ( !$self->{STARTED} ) {
3179: $self->{STARTED} = 1;
3180: return $self->BEGIN_MAP;
3181: }
3182:
3183: # Get the next resource in the branch
3184: $self->{HERE} = pop @{$self->{STACK}};
3185:
3186: # remember that we've seen this, so we don't return it again later
3187: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3188:
3189: # Get the next possible resources
3190: my $nextUnfiltered;
3191: if ($self->{DIRECTION} == FORWARD()) {
3192: $nextUnfiltered = $self->{HERE}->getNext();
3193: } else {
3194: $nextUnfiltered = $self->{HERE}->getPrevious();
3195: }
3196: my $next = [];
3197:
3198: # filter the next possibilities to remove things we've
3199: # already seen.
3200: foreach my $item (@$nextUnfiltered) {
3201: if (!defined($self->{ALREADY_SEEN}->{$item->{ID}})) {
3202: push @$next, $item;
3203: }
3204: }
3205:
3206: while (@$next) {
3207: # copy the next possibilities over to the stack
3208: push @{$self->{STACK}}, shift @$next;
3209: }
3210:
3211: # If this is a map and we want to recurse down it... (not filtered out)
3212: if ($self->{HERE}->is_map() &&
3213: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3214: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3215: my $firstResource = $self->{HERE}->map_start();
3216: my $finishResource = $self->{HERE}->map_finish();
3217:
3218: $self->{RECURSIVE_ITERATOR} =
3219: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
3220: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
3221: $self->{CONDITION}, $self->{DIRECTION});
3222: }
3223:
3224: return $self->{HERE};
3225: }
3226:
3227: # Identical to the full iterator methods of the same name. Hate to copy/paste
3228: # but I also hate to "inherit" either iterator from the other.
3229:
3230: sub getStack {
3231: my $self=shift;
3232:
3233: my @stack;
3234:
3235: $self->populateStack(\@stack);
3236:
3237: return \@stack;
3238: }
3239:
3240: # Private method: Calls the iterators recursively to populate the stack.
3241: sub populateStack {
3242: my $self=shift;
3243: my $stack = shift;
3244:
3245: push @$stack, $self->{HERE} if ($self->{HERE});
3246:
3247: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3248: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3249: }
3250: }
3251:
3252: 1;
3253:
3254: package Apache::lonnavmaps::resource;
3255: use Scalar::Util qw(weaken);
3256: use Apache::lonnet;
3257:
3258: =pod
3259:
3260: =head1 Object: resource
3261:
3262: X<resource, navmap object>
3263: A resource object encapsulates a resource in a resource map, allowing
3264: easy manipulation of the resource, querying the properties of the
3265: resource (including user properties), and represents a reference that
3266: can be used as the canonical representation of the resource by
3267: lonnavmap clients like renderers.
3268:
3269: A resource only makes sense in the context of a navmap, as some of the
3270: data is stored in the navmap object.
3271:
3272: You will probably never need to instantiate this object directly. Use
3273: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3274: starting resource.
3275:
3276: Resource objects respect the parameter_hiddenparts, which suppresses
3277: various parts according to the wishes of the map author. As of this
3278: writing, there is no way to override this parameter, and suppressed
3279: parts will never be returned, nor will their response types or ids be
3280: stored.
3281:
3282: =head2 Overview
3283:
3284: A B<Resource> is the most granular type of object in LON-CAPA that can
3285: be included in a course. It can either be a particular resource, like
3286: an HTML page, external resource, problem, etc., or it can be a
3287: container sequence, such as a "page" or a "map".
3288:
3289: To see a sequence from the user's point of view, please see the
3290: B<Creating a Course: Maps and Sequences> chapter of the Author's
3291: Manual.
3292:
3293: A Resource Object, once obtained from a navmap object via a B<getBy*>
3294: method of the navmap, or from an iterator, allows you to query
3295: information about that resource.
3296:
3297: Generally, you do not ever want to create a resource object yourself,
3298: so creation has been left undocumented. Always retrieve resources
3299: from navmap objects.
3300:
3301: =head3 Identifying Resources
3302:
3303: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3304: unique to that resource for a given course. X<resource ID, in big hash>
3305: The Resource ID has the form #.#, where the first number is the same
3306: for every resource in a map, and the second is unique. For instance,
3307: for a course laid out like this:
3308:
3309: * Problem 1
3310: * Map
3311: * Resource 2
3312: * Resource 3
3313:
3314: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3315: C<Resource 3> will share a first number. The second number may end up
3316: re-used between the two groups.
3317:
3318: The resource ID is only used in the big hash, but can be used in the
3319: context of a course to identify a resource easily. (For instance, the
3320: printing system uses it to record which resources from a sequence you
3321: wish to print.)
3322:
3323: X<symb> X<resource, symb>
3324: All resources also have B<symb>s, which uniquely identify a resource
3325: in a course. Many internal LON-CAPA functions expect a symb. A symb
3326: carries along with it the URL of the resource, and the map it appears
3327: in. Symbs are much larger than resource IDs.
3328:
3329: =cut
3330:
3331: sub new {
3332: # magic invocation to create a class instance
3333: my $proto = shift;
3334: my $class = ref($proto) || $proto;
3335: my $self = {};
3336:
3337: weaken($self->{NAV_MAP} = shift);
3338: $self->{ID} = shift;
3339:
3340: # Store this new resource in the parent nav map's cache.
3341: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
3342: $self->{RESOURCE_ERROR} = 0;
3343:
3344: # A hash that can be used by two-pass algorithms to store data
3345: # about this resource in. Not used by the resource object
3346: # directly.
3347: $self->{DATA} = {};
3348:
3349: bless($self);
3350:
3351: return $self;
3352: }
3353:
3354: # private function: simplify the NAV_HASH lookups we keep doing
3355: # pass the name, and to automatically append my ID, pass a true val on the
3356: # second param
3357: sub navHash {
3358: my $self = shift;
3359: my $param = shift;
3360: my $id = shift;
3361: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
3362: }
3363:
3364: =pod
3365:
3366: =head2 Methods
3367:
3368: Once you have a resource object, here's what you can do with it:
3369:
3370: =head3 Attribute Retrieval
3371:
3372: Every resource has certain attributes that can be retrieved and used:
3373:
3374: =over 4
3375:
3376: =item * B<ID>: Every resource has an ID that is unique for that
3377: resource in the course it is in. The ID is actually in the hash
3378: representing the resource, so for a resource object $res, obtain
3379: it via C<$res->{ID}).
3380:
3381: =item * B<compTitle>:
3382:
3383: Returns a "composite title", that is equal to $res->title() if the
3384: resource has a title, and is otherwise the last part of the URL (e.g.,
3385: "problem.problem").
3386:
3387: =item * B<ext>:
3388:
3389: Returns true if the resource is external.
3390:
3391: =item * B<kind>:
3392:
3393: Returns the kind of the resource from the compiled nav map.
3394:
3395: =item * B<randomout>:
3396:
3397: Returns true if this resource was chosen to NOT be shown to the user
3398: by the random map selection feature. In other words, this is usually
3399: false.
3400:
3401: =item * B<randompick>:
3402:
3403: Returns the number of randomly picked items for a map if the randompick
3404: feature is being used on the map.
3405:
3406: =item * B<randomorder>:
3407:
3408: Returns true for a map if the randomorder feature is being used on the
3409: map.
3410:
3411: =item * B<src>:
3412:
3413: Returns the source for the resource.
3414:
3415: =item * B<symb>:
3416:
3417: Returns the symb for the resource.
3418:
3419: =item * B<title>:
3420:
3421: Returns the title of the resource.
3422:
3423: =back
3424:
3425: =cut
3426:
3427: # These info functions can be used directly, as they don't return
3428: # resource information.
3429: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
3430: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
3431: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
3432: sub from { my $self=shift; return $self->navHash("from_", 1); }
3433: # considered private and undocumented
3434: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3435: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
3436: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3437: sub randompick {
3438: my $self = shift;
3439: return $self->parmval('randompick');
3440: }
3441: sub randomorder {
3442: my $self = shift;
3443: return ($self->parmval('randomorder') =~ /^yes$/i);
3444: }
3445: sub link {
3446: my $self=shift;
3447: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3448: return $self->src;
3449: }
3450: sub src {
3451: my $self=shift;
3452: return $self->navHash("src_", 1);
3453: }
3454: sub shown_symb {
3455: my $self=shift;
3456: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3457: return $self->symb();
3458: }
3459: sub id {
3460: my $self=shift;
3461: return $self->{ID};
3462: }
3463: sub enclosing_map_src {
3464: my $self=shift;
3465: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3466: return $self->navHash('map_id_'.$first);
3467: }
3468: sub symb {
3469: my $self=shift;
3470: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3471: my $symbSrc = &Apache::lonnet::declutter($self->src());
3472: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
3473: . '___' . $second . '___' . $symbSrc;
3474: return &Apache::lonnet::symbclean($symb);
3475: }
3476: sub wrap_symb {
3477: my $self = shift;
3478: return $self->{NAV_MAP}->wrap_symb($self->symb());
3479: }
3480: sub title {
3481: my $self=shift;
3482: if ($self->{ID} eq '0.0') {
3483: # If this is the top-level map, return the title of the course
3484: # since this map can not be titled otherwise.
3485: return $env{'course.'.$env{'request.course.id'}.'.description'};
3486: }
3487: return $self->navHash("title_", 1); }
3488: # considered private and undocumented
3489: sub to { my $self=shift; return $self->navHash("to_", 1); }
3490: sub condition {
3491: my $self=shift;
3492: my $undercond=$self->navHash("undercond_", 1);
3493: if (!defined($undercond)) { return 1; };
3494: my $condid=$self->navHash("condid_$undercond");
3495: if (!defined($condid)) { return 1; };
3496: my $condition=&Apache::lonnet::directcondval($condid);
3497: return $condition;
3498: }
3499: sub condval {
3500: my $self=shift;
3501: my ($pathname,$filename) =
3502: &Apache::lonnet::split_uri_for_cond($self->src());
3503:
3504: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3505: /\&\Q$filename\E\:([\d\|]+)\&/);
3506: if ($match) {
3507: return &Apache::lonnet::condval($1);
3508: }
3509: return 0;
3510: }
3511: sub compTitle {
3512: my $self = shift;
3513: my $title = $self->title();
3514: $title=~s/\&colon\;/\:/gs;
3515: if (!$title) {
3516: $title = $self->src();
3517: $title = substr($title, rindex($title, '/') + 1);
3518: }
3519: return $title;
3520: }
3521:
3522: =pod
3523:
3524: B<Predicate Testing the Resource>
3525:
3526: These methods are shortcuts to deciding if a given resource has a given property.
3527:
3528: =over 4
3529:
3530: =item * B<is_map>:
3531:
3532: Returns true if the resource is a map type.
3533:
3534: =item * B<is_problem>:
3535:
3536: Returns true if the resource is a problem type, false
3537: otherwise. (Looks at the extension on the src field; might need more
3538: to work correctly.)
3539:
3540: =item * B<is_page>:
3541:
3542: Returns true if the resource is a page.
3543:
3544: =item * B<is_sequence>:
3545:
3546: Returns true if the resource is a sequence.
3547:
3548: =back
3549:
3550: =cut
3551:
3552: sub hasResource {
3553: my $self = shift;
3554: return $self->{NAV_MAP}->hasResource(@_);
3555: }
3556:
3557: sub retrieveResources {
3558: my $self = shift;
3559: return $self->{NAV_MAP}->retrieveResources(@_);
3560: }
3561:
3562: sub is_exam {
3563: my ($self,$part) = @_;
3564: if ($self->parmval('type',$part) eq 'exam') {
3565: return 1;
3566: }
3567: if ($self->src() =~ /\.(exam)$/) {
3568: return 1;
3569: }
3570: return 0;
3571: }
3572: sub is_html {
3573: my $self=shift;
3574: my $src = $self->src();
3575: return ($src =~ /html$/);
3576: }
3577: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3578: sub is_page {
3579: my $self=shift;
3580: my $src = $self->src();
3581: return $self->navHash("is_map_", 1) &&
3582: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
3583: }
3584: sub is_practice {
3585: my $self=shift;
3586: my ($part) = @_;
3587: if ($self->parmval('type',$part) eq 'practice') {
3588: return 1;
3589: }
3590: return 0;
3591: }
3592: sub is_problem {
3593: my $self=shift;
3594: my $src = $self->src();
3595: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3596: return !($self->is_practice());
3597: }
3598: return 0;
3599: }
3600: sub contains_problem {
3601: my $self=shift;
3602: if ($self->is_page()) {
3603: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3604: return $hasProblem;
3605: }
3606: return 0;
3607: }
3608: sub map_contains_problem {
3609: my $self=shift;
3610: if ($self->is_map()) {
3611: my $has_problem=
3612: $self->hasResource($self,sub { $_[0]->is_problem() },1);
3613: return $has_problem;
3614: }
3615: return 0;
3616: }
3617: sub is_sequence {
3618: my $self=shift;
3619: return $self->navHash("is_map_", 1) &&
3620: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
3621: }
3622: sub is_survey {
3623: my $self = shift();
3624: my $part = shift();
3625: if ($self->parmval('type',$part) eq 'survey') {
3626: return 1;
3627: }
3628: if ($self->src() =~ /\.(survey)$/) {
3629: return 1;
3630: }
3631: return 0;
3632: }
3633: sub is_task {
3634: my $self=shift;
3635: my $src = $self->src();
3636: return ($src =~ /\.(task)$/)
3637: }
3638:
3639: sub is_empty_sequence {
3640: my $self=shift;
3641: my $src = $self->src();
3642: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3643: }
3644:
3645: # Private method: Shells out to the parmval in the nav map, handler parts.
3646: sub parmval {
3647: my $self = shift;
3648: my $what = shift;
3649: my $part = shift;
3650: if (!defined($part)) {
3651: $part = '0';
3652: }
3653: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3654: }
3655:
3656: =pod
3657:
3658: B<Map Methods>
3659:
3660: These methods are useful for getting information about the map
3661: properties of the resource, if the resource is a map (B<is_map>).
3662:
3663: =over 4
3664:
3665: =item * B<map_finish>:
3666:
3667: Returns a reference to a resource object corresponding to the finish
3668: resource of the map.
3669:
3670: =item * B<map_pc>:
3671:
3672: Returns the pc value of the map, which is the first number that
3673: appears in the resource ID of the resources in the map, and is the
3674: number that appears around the middle of the symbs of the resources in
3675: that map.
3676:
3677: =item * B<map_start>:
3678:
3679: Returns a reference to a resource object corresponding to the start
3680: resource of the map.
3681:
3682: =item * B<map_type>:
3683:
3684: Returns a string with the type of the map in it.
3685:
3686: =back
3687:
3688: =cut
3689:
3690: sub map_finish {
3691: my $self = shift;
3692: my $src = $self->src();
3693: $src = &Apache::lonnet::clutter($src);
3694: my $res = $self->navHash("map_finish_$src", 0);
3695: $res = $self->{NAV_MAP}->getById($res);
3696: return $res;
3697: }
3698: sub map_pc {
3699: my $self = shift;
3700: my $src = $self->src();
3701: return $self->navHash("map_pc_$src", 0);
3702: }
3703: sub map_start {
3704: my $self = shift;
3705: my $src = $self->src();
3706: $src = &Apache::lonnet::clutter($src);
3707: my $res = $self->navHash("map_start_$src", 0);
3708: $res = $self->{NAV_MAP}->getById($res);
3709: return $res;
3710: }
3711: sub map_type {
3712: my $self = shift;
3713: my $pc = $self->map_pc();
3714: return $self->navHash("map_type_$pc", 0);
3715: }
3716:
3717: #####
3718: # Property queries
3719: #####
3720:
3721: # These functions will be responsible for returning the CORRECT
3722: # VALUE for the parameter, no matter what. So while they may look
3723: # like direct calls to parmval, they can be more than that.
3724: # So, for instance, the duedate function should use the "duedatetype"
3725: # information, rather than the resource object user.
3726:
3727: =pod
3728:
3729: =head2 Resource Parameters
3730:
3731: In order to use the resource parameters correctly, the nav map must
3732: have been instantiated with genCourseAndUserOptions set to true, so
3733: the courseopt and useropt is read correctly. Then, you can call these
3734: functions to get the relevant parameters for the resource. Each
3735: function defaults to part "0", but can be directed to another part by
3736: passing the part as the parameter.
3737:
3738: These methods are responsible for getting the parameter correct, not
3739: merely reflecting the contents of the GDBM hashes. As we move towards
3740: dates relative to other dates, these methods should be updated to
3741: reflect that. (Then, anybody using these methods will not have to update
3742: their code.)
3743:
3744: =over 4
3745:
3746: =item * B<acc>:
3747:
3748: Get the Client IP/Name Access Control information.
3749:
3750: =item * B<answerdate>:
3751:
3752: Get the answer-reveal date for the problem.
3753:
3754: =item * B<awarded>:
3755:
3756: Gets the awarded value for the problem part. Requires genUserData set to
3757: true when the navmap object was created.
3758:
3759: =item * B<duedate>:
3760:
3761: Get the due date for the problem.
3762:
3763: =item * B<tries>:
3764:
3765: Get the number of tries the student has used on the problem.
3766:
3767: =item * B<maxtries>:
3768:
3769: Get the number of max tries allowed.
3770:
3771: =item * B<opendate>:
3772:
3773: Get the open date for the problem.
3774:
3775: =item * B<sig>:
3776:
3777: Get the significant figures setting.
3778:
3779: =item * B<tol>:
3780:
3781: Get the tolerance for the problem.
3782:
3783: =item * B<tries>:
3784:
3785: Get the number of tries the user has already used on the problem.
3786:
3787: =item * B<type>:
3788:
3789: Get the question type for the problem.
3790:
3791: =item * B<weight>:
3792:
3793: Get the weight for the problem.
3794:
3795: =back
3796:
3797: =cut
3798:
3799: sub acc {
3800: (my $self, my $part) = @_;
3801: return $self->parmval("acc", $part);
3802: }
3803: sub answerdate {
3804: (my $self, my $part) = @_;
3805: # Handle intervals
3806: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
3807: return $self->duedate($part) +
3808: $self->parmval("answerdate", $part);
3809: }
3810: return $self->parmval("answerdate", $part);
3811: }
3812: sub awarded {
3813: my $self = shift; my $part = shift;
3814: $self->{NAV_MAP}->get_user_data();
3815: if (!defined($part)) { $part = '0'; }
3816: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3817: }
3818: # this should work exactly like the copy in lonhomework.pm
3819: sub duedate {
3820: (my $self, my $part) = @_;
3821: my $date;
3822: my $interval=$self->parmval("interval", $part);
3823: my $due_date=$self->parmval("duedate", $part);
3824: if ($interval =~ /\d+/) {
3825: my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);
3826: if (defined($first_access)) {
3827: $interval = $first_access+$interval;
3828: $date = (!$due_date || $interval < $due_date) ? $interval
3829: : $due_date;
3830: } else {
3831: $date = $due_date;
3832: }
3833: } else {
3834: $date = $due_date;
3835: }
3836: return $date;
3837: }
3838: sub handgrade {
3839: (my $self, my $part) = @_;
3840: my @response_ids = $self->responseIds($part);
3841: if (@response_ids) {
3842: foreach my $response_id (@response_ids) {
3843: if (lc($self->parmval("handgrade",$part.'_'.$response_id))
3844: eq 'yes') {
3845: return 'yes';
3846: }
3847: }
3848: }
3849: return $self->parmval("handgrade", $part);
3850: }
3851: sub maxtries {
3852: (my $self, my $part) = @_;
3853: return $self->parmval("maxtries", $part);
3854: }
3855: sub opendate {
3856: (my $self, my $part) = @_;
3857: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
3858: return $self->duedate($part) -
3859: $self->parmval("opendate", $part);
3860: }
3861: return $self->parmval("opendate");
3862: }
3863: sub problemstatus {
3864: (my $self, my $part) = @_;
3865: return lc $self->parmval("problemstatus", $part);
3866: }
3867: sub sig {
3868: (my $self, my $part) = @_;
3869: return $self->parmval("sig", $part);
3870: }
3871: sub tol {
3872: (my $self, my $part) = @_;
3873: return $self->parmval("tol", $part);
3874: }
3875: sub tries {
3876: my $self = shift;
3877: my $tries = $self->queryRestoreHash('tries', shift);
3878: if (!defined($tries)) { return '0';}
3879: return $tries;
3880: }
3881: sub type {
3882: (my $self, my $part) = @_;
3883: return $self->parmval("type", $part);
3884: }
3885: sub weight {
3886: my $self = shift; my $part = shift;
3887: if (!defined($part)) { $part = '0'; }
3888: return &Apache::lonnet::EXT('resource.'.$part.'.weight',
3889: $self->symb(), $env{'user.domain'},
3890: $env{'user.name'},
3891: $env{'request.course.sec'});
3892: }
3893: sub part_display {
3894: my $self= shift(); my $partID = shift();
3895: if (! defined($partID)) { $partID = '0'; }
3896: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
3897: $self->symb);
3898: if (! defined($display) || $display eq '') {
3899: $display = $partID;
3900: }
3901: return $display;
3902: }
3903:
3904: # Multiple things need this
3905: sub getReturnHash {
3906: my $self = shift;
3907:
3908: if (!defined($self->{RETURN_HASH})) {
3909: my %tmpHash = &Apache::lonnet::restore($self->symb());
3910: $self->{RETURN_HASH} = \%tmpHash;
3911: }
3912: }
3913:
3914: ######
3915: # Status queries
3916: ######
3917:
3918: # These methods query the status of problems.
3919:
3920: # If we need to count parts, this function determines the number of
3921: # parts from the metadata. When called, it returns a reference to a list
3922: # of strings corresponding to the parts. (Thus, using it in a scalar context
3923: # tells you how many parts you have in the problem:
3924: # $partcount = scalar($resource->countParts());
3925: # Don't use $self->{PARTS} directly because you don't know if it's been
3926: # computed yet.
3927:
3928: =pod
3929:
3930: =head2 Resource misc
3931:
3932: Misc. functions for the resource.
3933:
3934: =over 4
3935:
3936: =item * B<hasDiscussion>:
3937:
3938: Returns a false value if there has been discussion since the user last
3939: logged in, true if there has. Always returns false if the discussion
3940: data was not extracted when the nav map was constructed.
3941:
3942: =item * B<last_post_time>:
3943:
3944: Returns a false value if there hasn't been discussion otherwise returns
3945: unix timestamp of last time a discussion posting (or edit) was made.
3946:
3947: =item * B<discussion_info>:
3948:
3949: optional argument is a filter (currently can be 'unread');
3950: returns in scalar context the count of the number of discussion postings.
3951:
3952: returns in list context both the count of postings and a hash ref
3953: containing information about the postings (subject, id, timestamp) in a hash.
3954:
3955: Default is to return counts for all postings. However if called with a second argument set to 'unread', will return information about only unread postings.
3956:
3957: =item * B<getFeedback>:
3958:
3959: Gets the feedback for the resource and returns the raw feedback string
3960: for the resource, or the null string if there is no feedback or the
3961: email data was not extracted when the nav map was constructed. Usually
3962: used like this:
3963:
3964: for my $url (split(/\,/, $res->getFeedback())) {
3965: my $link = &escape($url);
3966: ...
3967:
3968: and use the link as appropriate.
3969:
3970: =cut
3971:
3972: sub hasDiscussion {
3973: my $self = shift;
3974: return $self->{NAV_MAP}->hasDiscussion($self->symb());
3975: }
3976:
3977: sub last_post_time {
3978: my $self = shift;
3979: return $self->{NAV_MAP}->last_post_time($self->symb());
3980: }
3981:
3982: sub discussion_info {
3983: my ($self,$filter) = @_;
3984: return $self->{NAV_MAP}->discussion_info($self->symb(),$filter);
3985: }
3986:
3987: sub getFeedback {
3988: my $self = shift;
3989: my $source = $self->src();
3990: my $symb = $self->symb();
3991: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3992: return $self->{NAV_MAP}->getFeedback($symb,$source);
3993: }
3994:
3995: sub getErrors {
3996: my $self = shift;
3997: my $source = $self->src();
3998: my $symb = $self->symb();
3999: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
4000: return $self->{NAV_MAP}->getErrors($symb,$source);
4001: }
4002:
4003: =pod
4004:
4005: =item * B<parts>():
4006:
4007: Returns a list reference containing sorted strings corresponding to
4008: each part of the problem. Single part problems have only a part '0'.
4009: Multipart problems do not return their part '0', since they typically
4010: do not really matter.
4011:
4012: =item * B<countParts>():
4013:
4014: Returns the number of parts of the problem a student can answer. Thus,
4015: for single part problems, returns 1. For multipart, it returns the
4016: number of parts in the problem, not including psuedo-part 0.
4017:
4018: =item * B<countResponses>():
4019:
4020: Returns the total number of responses in the problem a student can answer.
4021:
4022: =item * B<responseTypes>():
4023:
4024: Returns a hash whose keys are the response types. The values are the number
4025: of times each response type is used. This is for the I<entire> problem, not
4026: just a single part.
4027:
4028: =item * B<multipart>():
4029:
4030: Returns true if the problem is multipart, false otherwise. Use this instead
4031: of countParts if all you want is multipart/not multipart.
4032:
4033: =item * B<responseType>($part):
4034:
4035: Returns the response type of the part, without the word "response" on the
4036: end. Example return values: 'string', 'essay', 'numeric', etc.
4037:
4038: =item * B<responseIds>($part):
4039:
4040: Retreives the response IDs for the given part as an array reference containing
4041: strings naming the response IDs. This may be empty.
4042:
4043: =back
4044:
4045: =cut
4046:
4047: sub parts {
4048: my $self = shift;
4049:
4050: if ($self->ext) { return []; }
4051:
4052: $self->extractParts();
4053: return $self->{PARTS};
4054: }
4055:
4056: sub countParts {
4057: my $self = shift;
4058:
4059: my $parts = $self->parts();
4060:
4061: # If I left this here, then it's not necessary.
4062: #my $delta = 0;
4063: #for my $part (@$parts) {
4064: # if ($part eq '0') { $delta--; }
4065: #}
4066:
4067: if ($self->{RESOURCE_ERROR}) {
4068: return 0;
4069: }
4070:
4071: return scalar(@{$parts}); # + $delta;
4072: }
4073:
4074: sub countResponses {
4075: my $self = shift;
4076: my $count;
4077: foreach my $part (@{$self->parts()}) {
4078: $count+= scalar($self->responseIds($part));
4079: }
4080: return $count;
4081: }
4082:
4083: sub responseTypes {
4084: my $self = shift;
4085: my %responses;
4086: foreach my $part (@{$self->parts()}) {
4087: foreach my $responsetype ($self->responseType($part)) {
4088: $responses{$responsetype}++ if (defined($responsetype));
4089: }
4090: }
4091: return %responses;
4092: }
4093:
4094: sub multipart {
4095: my $self = shift;
4096: return $self->countParts() > 1;
4097: }
4098:
4099: sub singlepart {
4100: my $self = shift;
4101: return $self->countParts() == 1;
4102: }
4103:
4104: sub responseType {
4105: my $self = shift;
4106: my $part = shift;
4107:
4108: $self->extractParts();
4109: if (defined($self->{RESPONSE_TYPES}->{$part})) {
4110: return @{$self->{RESPONSE_TYPES}->{$part}};
4111: } else {
4112: return undef;
4113: }
4114: }
4115:
4116: sub responseIds {
4117: my $self = shift;
4118: my $part = shift;
4119:
4120: $self->extractParts();
4121: if (defined($self->{RESPONSE_IDS}->{$part})) {
4122: return @{$self->{RESPONSE_IDS}->{$part}};
4123: } else {
4124: return undef;
4125: }
4126: }
4127:
4128: # Private function: Extracts the parts information, both part names and
4129: # part types, and saves it.
4130: sub extractParts {
4131: my $self = shift;
4132:
4133: return if (defined($self->{PARTS}));
4134: return if ($self->ext);
4135:
4136: $self->{PARTS} = [];
4137:
4138: my %parts;
4139:
4140: # Retrieve part count, if this is a problem
4141: if ($self->is_problem()) {
4142: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
4143: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
4144:
4145: if ($partorder) {
4146: my @parts;
4147: for my $part (split (/,/,$partorder)) {
4148: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4149: push @parts, $part;
4150: $parts{$part} = 1;
4151: }
4152: }
4153: $self->{PARTS} = \@parts;
4154: } else {
4155: if (!$metadata) {
4156: $self->{RESOURCE_ERROR} = 1;
4157: $self->{PARTS} = [];
4158: $self->{PART_TYPE} = {};
4159: return;
4160: }
4161: foreach my $entry (split(/\,/,$metadata)) {
4162: if ($entry =~ /^(?:part|Task)_(.*)$/) {
4163: my $part = $1;
4164: # This floods the logs if it blows up
4165: if (defined($parts{$part})) {
4166: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
4167: }
4168:
4169: # check to see if part is turned off.
4170:
4171: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4172: $parts{$part} = 1;
4173: }
4174: }
4175: }
4176: my @sortedParts = sort keys %parts;
4177: $self->{PARTS} = \@sortedParts;
4178: }
4179:
4180:
4181: # These hashes probably do not need names that end with "Hash"....
4182: my %responseIdHash;
4183: my %responseTypeHash;
4184:
4185:
4186: # Init the responseIdHash
4187: foreach my $part (@{$self->{PARTS}}) {
4188: $responseIdHash{$part} = [];
4189: }
4190:
4191: # Now, the unfortunate thing about this is that parts, part name, and
4192: # response id are delimited by underscores, but both the part
4193: # name and response id can themselves have underscores in them.
4194: # So we have to use our knowlege of part names to figure out
4195: # where the part names begin and end, and even then, it is possible
4196: # to construct ambiguous situations.
4197: foreach my $data (split /,/, $metadata) {
4198: if ($data =~ /^([a-zA-Z]+)response_(.*)/
4199: || $data =~ /^(Task)_(.*)/) {
4200: my $responseType = $1;
4201: my $partStuff = $2;
4202: my $partIdSoFar = '';
4203: my @partChunks = split /_/, $partStuff;
4204: my $i = 0;
4205: for ($i = 0; $i < scalar(@partChunks); $i++) {
4206: if ($partIdSoFar) { $partIdSoFar .= '_'; }
4207: $partIdSoFar .= $partChunks[$i];
4208: if ($parts{$partIdSoFar}) {
4209: my @otherChunks = @partChunks[$i+1..$#partChunks];
4210: my $responseId = join('_', @otherChunks);
4211: if ($self->is_task()) {
4212: push(@{$responseIdHash{$partIdSoFar}},
4213: $partIdSoFar);
4214: } else {
4215: push(@{$responseIdHash{$partIdSoFar}},
4216: $responseId);
4217: }
4218: push(@{$responseTypeHash{$partIdSoFar}},
4219: $responseType);
4220: }
4221: }
4222: }
4223: }
4224: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
4225: #
4226: # Reorder the arrays in the %responseIdHash and %responseTypeHash
4227: if ($resorder) {
4228: my @resorder=split(/,/,$resorder);
4229: foreach my $part (keys(%responseIdHash)) {
4230: my $i=0;
4231: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
4232: my @neworder;
4233: foreach my $possibleid (@resorder) {
4234: if (exists($resids{$possibleid})) {
4235: push(@neworder,$resids{$possibleid});
4236: }
4237: }
4238: my @ids;
4239: my @type;
4240: foreach my $element (@neworder) {
4241: push (@ids,$responseIdHash{$part}->[$element]);
4242: push (@type,$responseTypeHash{$part}->[$element]);
4243: }
4244: $responseIdHash{$part}=\@ids;
4245: $responseTypeHash{$part}=\@type;
4246: }
4247: }
4248: $self->{RESPONSE_IDS} = \%responseIdHash;
4249: $self->{RESPONSE_TYPES} = \%responseTypeHash;
4250: }
4251:
4252: return;
4253: }
4254:
4255: =pod
4256:
4257: =head2 Resource Status
4258:
4259: Problem resources have status information, reflecting their various
4260: dates and completion statuses.
4261:
4262: There are two aspects to the status: the date-related information and
4263: the completion information.
4264:
4265: Idiomatic usage of these two methods would probably look something
4266: like
4267:
4268: foreach my $part ($resource->parts()) {
4269: my $dateStatus = $resource->getDateStatus($part);
4270: my $completionStatus = $resource->getCompletionStatus($part);
4271:
4272: or
4273:
4274: my $status = $resource->status($part);
4275:
4276: ... use it here ...
4277: }
4278:
4279: Which you use depends on exactly what you are looking for. The
4280: status() function has been optimized for the nav maps display and may
4281: not precisely match what you need elsewhere.
4282:
4283: The symbolic constants shown below can be accessed through the
4284: resource object: C<$res->OPEN>.
4285:
4286: =over 4
4287:
4288: =item * B<getDateStatus>($part):
4289:
4290: ($part defaults to 0). A convenience function that returns a symbolic
4291: constant telling you about the date status of the part. The possible
4292: return values are:
4293:
4294: =back
4295:
4296: B<Date Codes>
4297:
4298: =over 4
4299:
4300: =item * B<OPEN_LATER>:
4301:
4302: The problem will be opened later.
4303:
4304: =item * B<OPEN>:
4305:
4306: Open and not yet due.
4307:
4308:
4309: =item * B<PAST_DUE_ANSWER_LATER>:
4310:
4311: The due date has passed, but the answer date has not yet arrived.
4312:
4313: =item * B<PAST_DUE_NO_ANSWER>:
4314:
4315: The due date has passed and there is no answer opening date set.
4316:
4317: =item * B<ANSWER_OPEN>:
4318:
4319: The answer date is here.
4320:
4321: =item * B<NETWORK_FAILURE>:
4322:
4323: The information is unknown due to network failure.
4324:
4325: =back
4326:
4327: =cut
4328:
4329: # Apparently the compiler optimizes these into constants automatically
4330: sub OPEN_LATER { return 0; }
4331: sub OPEN { return 1; }
4332: sub PAST_DUE_NO_ANSWER { return 2; }
4333: sub PAST_DUE_ANSWER_LATER { return 3; }
4334: sub ANSWER_OPEN { return 4; }
4335: sub NOTHING_SET { return 5; }
4336: sub NETWORK_FAILURE { return 100; }
4337:
4338: # getDateStatus gets the date status for a given problem part.
4339: # Because answer date, due date, and open date are fully independent
4340: # (i.e., it is perfectly possible to *only* have an answer date),
4341: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
4342: # (past, future, none given). This function handles this with a decision
4343: # tree. Read the comments to follow the decision tree.
4344:
4345: sub getDateStatus {
4346: my $self = shift;
4347: my $part = shift;
4348: $part = "0" if (!defined($part));
4349:
4350: # Always return network failure if there was one.
4351: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4352:
4353: my $now = time();
4354:
4355: my $open = $self->opendate($part);
4356: my $due = $self->duedate($part);
4357: my $answer = $self->answerdate($part);
4358:
4359: if (!$open && !$due && !$answer) {
4360: # no data on the problem at all
4361: # should this be the same as "open later"? think multipart.
4362: return $self->NOTHING_SET;
4363: }
4364: if (!$open || $now < $open) {return $self->OPEN_LATER}
4365: if (!$due || $now < $due) {return $self->OPEN}
4366: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
4367: if ($answer) { return $self->ANSWER_OPEN; }
4368: return PAST_DUE_NO_ANSWER;
4369: }
4370:
4371: =pod
4372:
4373: B<>
4374:
4375: =over 4
4376:
4377: =item * B<getCompletionStatus>($part):
4378:
4379: ($part defaults to 0.) A convenience function that returns a symbolic
4380: constant telling you about the completion status of the part, with the
4381: following possible results:
4382:
4383: =back
4384:
4385: B<Completion Codes>
4386:
4387: =over 4
4388:
4389: =item * B<NOT_ATTEMPTED>:
4390:
4391: Has not been attempted at all.
4392:
4393: =item * B<INCORRECT>:
4394:
4395: Attempted, but wrong by student.
4396:
4397: =item * B<INCORRECT_BY_OVERRIDE>:
4398:
4399: Attempted, but wrong by instructor override.
4400:
4401: =item * B<CORRECT>:
4402:
4403: Correct or correct by instructor.
4404:
4405: =item * B<CORRECT_BY_OVERRIDE>:
4406:
4407: Correct by instructor override.
4408:
4409: =item * B<EXCUSED>:
4410:
4411: Excused. Not yet implemented.
4412:
4413: =item * B<NETWORK_FAILURE>:
4414:
4415: Information not available due to network failure.
4416:
4417: =item * B<ATTEMPTED>:
4418:
4419: Attempted, and not yet graded.
4420:
4421: =back
4422:
4423: =cut
4424:
4425: sub NOT_ATTEMPTED { return 10; }
4426: sub INCORRECT { return 11; }
4427: sub INCORRECT_BY_OVERRIDE { return 12; }
4428: sub CORRECT { return 13; }
4429: sub CORRECT_BY_OVERRIDE { return 14; }
4430: sub EXCUSED { return 15; }
4431: sub ATTEMPTED { return 16; }
4432:
4433: sub getCompletionStatus {
4434: my $self = shift;
4435: my $part = shift;
4436: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4437:
4438: my $status = $self->queryRestoreHash('solved', $part);
4439:
4440: # Left as separate if statements in case we ever do more with this
4441: if ($status eq 'correct_by_student') {return $self->CORRECT;}
4442: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
4443: if ($status eq 'correct_by_override') {
4444: return $self->CORRECT_BY_OVERRIDE;
4445: }
4446: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
4447: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
4448: if ($status eq 'excused') {return $self->EXCUSED; }
4449: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
4450: return $self->NOT_ATTEMPTED;
4451: }
4452:
4453: sub queryRestoreHash {
4454: my $self = shift;
4455: my $hashentry = shift;
4456: my $part = shift;
4457: $part = "0" if (!defined($part) || $part eq '');
4458: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4459:
4460: $self->getReturnHash();
4461:
4462: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
4463: }
4464:
4465: =pod
4466:
4467: B<Composite Status>
4468:
4469: Along with directly returning the date or completion status, the
4470: resource object includes a convenience function B<status>() that will
4471: combine the two status tidbits into one composite status that can
4472: represent the status of the resource as a whole. This method represents
4473: the concept of the thing we want to display to the user on the nav maps
4474: screen, which is a combination of completion and open status. The precise logic is
4475: documented in the comments of the status method. The following results
4476: may be returned, all available as methods on the resource object
4477: ($res->NETWORK_FAILURE): In addition to the return values that match
4478: the date or completion status, this function can return "ANSWER_SUBMITTED"
4479: if that problemstatus parameter value is set to No, suppressing the
4480: incorrect/correct feedback.
4481:
4482: =over 4
4483:
4484: =item * B<NETWORK_FAILURE>:
4485:
4486: The network has failed and the information is not available.
4487:
4488: =item * B<NOTHING_SET>:
4489:
4490: No dates have been set for this problem (part) at all. (Because only
4491: certain parts of a multi-part problem may be assigned, this can not be
4492: collapsed into "open later", as we do not know a given part will EVER
4493: be opened. For single part, this is the same as "OPEN_LATER".)
4494:
4495: =item * B<CORRECT>:
4496:
4497: For any reason at all, the part is considered correct.
4498:
4499: =item * B<EXCUSED>:
4500:
4501: For any reason at all, the problem is excused.
4502:
4503: =item * B<PAST_DUE_NO_ANSWER>:
4504:
4505: The problem is past due, not considered correct, and no answer date is
4506: set.
4507:
4508: =item * B<PAST_DUE_ANSWER_LATER>:
4509:
4510: The problem is past due, not considered correct, and an answer date in
4511: the future is set.
4512:
4513: =item * B<ANSWER_OPEN>:
4514:
4515: The problem is past due, not correct, and the answer is now available.
4516:
4517: =item * B<OPEN_LATER>:
4518:
4519: The problem is not yet open.
4520:
4521: =item * B<TRIES_LEFT>:
4522:
4523: The problem is open, has been tried, is not correct, but there are
4524: tries left.
4525:
4526: =item * B<INCORRECT>:
4527:
4528: The problem is open, and all tries have been used without getting the
4529: correct answer.
4530:
4531: =item * B<OPEN>:
4532:
4533: The item is open and not yet tried.
4534:
4535: =item * B<ATTEMPTED>:
4536:
4537: The problem has been attempted.
4538:
4539: =item * B<ANSWER_SUBMITTED>:
4540:
4541: An answer has been submitted, but the student should not see it.
4542:
4543: =back
4544:
4545: =cut
4546:
4547: sub TRIES_LEFT { return 20; }
4548: sub ANSWER_SUBMITTED { return 21; }
4549: sub PARTIALLY_CORRECT{ return 22; }
4550:
4551: sub status {
4552: my $self = shift;
4553: my $part = shift;
4554: if (!defined($part)) { $part = "0"; }
4555: my $completionStatus = $self->getCompletionStatus($part);
4556: my $dateStatus = $self->getDateStatus($part);
4557:
4558: # What we have is a two-dimensional matrix with 4 entries on one
4559: # dimension and 5 entries on the other, which we want to colorize,
4560: # plus network failure and "no date data at all".
4561:
4562: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
4563: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
4564:
4565: my $suppressFeedback = $self->problemstatus($part) eq 'no';
4566: # If there's an answer date and we're past it, don't
4567: # suppress the feedback; student should know
4568: if ($self->duedate($part) && $self->duedate($part) < time() &&
4569: $self->answerdate($part) && $self->answerdate($part) < time()) {
4570: $suppressFeedback = 0;
4571: }
4572:
4573: # There are a few whole rows we can dispose of:
4574: if ($completionStatus == CORRECT ||
4575: $completionStatus == CORRECT_BY_OVERRIDE ) {
4576: if ( $suppressFeedback ) { return ANSWER_SUBMITTED }
4577: my $awarded=$self->awarded($part);
4578: if ($awarded < 1 && $awarded > 0) {
4579: return PARTIALLY_CORRECT;
4580: } elsif ($awarded<1) {
4581: return INCORRECT;
4582: }
4583: return CORRECT;
4584: }
4585:
4586: # If it's WRONG... and not open
4587: if ( ($completionStatus == INCORRECT ||
4588: $completionStatus == INCORRECT_BY_OVERRIDE)
4589: && (!$self->opendate($part) || $self->opendate($part) > time()) ) {
4590: return INCORRECT;
4591: }
4592:
4593: if ($completionStatus == ATTEMPTED) {
4594: return ATTEMPTED;
4595: }
4596:
4597: # If it's EXCUSED, then return that no matter what
4598: if ($completionStatus == EXCUSED) {
4599: return EXCUSED;
4600: }
4601:
4602: if ($dateStatus == NOTHING_SET) {
4603: return NOTHING_SET;
4604: }
4605:
4606: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
4607: # by 4 matrix (date statuses).
4608:
4609: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
4610: $dateStatus == PAST_DUE_NO_ANSWER ) {
4611: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
4612: }
4613:
4614: if ($dateStatus == ANSWER_OPEN) {
4615: return ANSWER_OPEN;
4616: }
4617:
4618: # Now: (incorrect, incorrect_override, not_attempted) x
4619: # (open_later), (open)
4620:
4621: if ($dateStatus == OPEN_LATER) {
4622: return OPEN_LATER;
4623: }
4624:
4625: # If it's WRONG...
4626: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
4627: # and there are TRIES LEFT:
4628: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
4629: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
4630: }
4631: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
4632: }
4633:
4634: # Otherwise, it's untried and open
4635: return OPEN;
4636: }
4637:
4638: sub CLOSED { return 23; }
4639: sub ERROR { return 24; }
4640:
4641: =pod
4642:
4643: B<Simple Status>
4644:
4645: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4646: "Simple status" corresponds to "which icon is shown on the
4647: Navmaps". There are six "simple" statuses:
4648:
4649: =over 4
4650:
4651: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4652:
4653: =item * B<OPEN>: The problem is open and unattempted.
4654:
4655: =item * B<CORRECT>: The problem is correct for any reason.
4656:
4657: =item * B<INCORRECT>: The problem is incorrect and can still be
4658: completed successfully.
4659:
4660: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4661: does not know if they are correct. (The ellipsis icon.)
4662:
4663: =item * B<ERROR>: There is an error retrieving information about this
4664: problem.
4665:
4666: =back
4667:
4668: =cut
4669:
4670: # This hash maps the composite status to this simple status, and
4671: # can be used directly, if you like
4672: my %compositeToSimple =
4673: (
4674: NETWORK_FAILURE() => ERROR,
4675: NOTHING_SET() => CLOSED,
4676: CORRECT() => CORRECT,
4677: PARTIALLY_CORRECT() => PARTIALLY_CORRECT,
4678: EXCUSED() => CORRECT,
4679: PAST_DUE_NO_ANSWER() => INCORRECT,
4680: PAST_DUE_ANSWER_LATER() => INCORRECT,
4681: ANSWER_OPEN() => INCORRECT,
4682: OPEN_LATER() => CLOSED,
4683: TRIES_LEFT() => OPEN,
4684: INCORRECT() => INCORRECT,
4685: OPEN() => OPEN,
4686: ATTEMPTED() => ATTEMPTED,
4687: ANSWER_SUBMITTED() => ATTEMPTED
4688: );
4689:
4690: sub simpleStatus {
4691: my $self = shift;
4692: my $part = shift;
4693: my $status = $self->status($part);
4694: return $compositeToSimple{$status};
4695: }
4696:
4697: =pod
4698:
4699: B<simpleStatusCount> will return an array reference containing, in
4700: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4701: and ERROR parts the given problem has.
4702:
4703: =cut
4704:
4705: # This maps the status to the slot we want to increment
4706: my %statusToSlotMap =
4707: (
4708: OPEN() => 0,
4709: CLOSED() => 1,
4710: CORRECT() => 2,
4711: INCORRECT() => 3,
4712: ATTEMPTED() => 4,
4713: ERROR() => 5
4714: );
4715:
4716: sub statusToSlot { return $statusToSlotMap{shift()}; }
4717:
4718: sub simpleStatusCount {
4719: my $self = shift;
4720:
4721: my @counts = (0, 0, 0, 0, 0, 0, 0);
4722: foreach my $part (@{$self->parts()}) {
4723: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4724: }
4725:
4726: return \@counts;
4727: }
4728:
4729: =pod
4730:
4731: B<Completable>
4732:
4733: The completable method represents the concept of I<whether the student can
4734: currently do the problem>. If the student can do the problem, which means
4735: that it is open, there are tries left, and if the problem is manually graded
4736: or the grade is suppressed via problemstatus, the student has not tried it
4737: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4738: either the student has tried it and there is no feedback, or that for
4739: some reason it is no longer completable (not open yet, successfully completed,
4740: out of tries, etc.). As an example, this is used as the filter for the
4741: "Uncompleted Homework" option for the nav maps.
4742:
4743: If this does not quite meet your needs, do not fiddle with it (unless you are
4744: fixing it to better match the student's conception of "completable" because
4745: it's broken somehow)... make a new method.
4746:
4747: =cut
4748:
4749: sub completable {
4750: my $self = shift;
4751: if (!$self->is_problem()) { return 0; }
4752: my $partCount = $self->countParts();
4753:
4754: foreach my $part (@{$self->parts()}) {
4755: if ($part eq '0' && $partCount != 1) { next; }
4756: my $status = $self->status($part);
4757: # "If any of the parts are open, or have tries left (implies open),
4758: # and it is not "attempted" (manually graded problem), it is
4759: # not "complete"
4760: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4761: $status == ANSWER_SUBMITTED() ) {
4762: # did this part already, as well as we can
4763: next;
4764: }
4765: if ($status == OPEN() || $status == TRIES_LEFT()) {
4766: return 1;
4767: }
4768: }
4769:
4770: # If all the parts were complete, so was this problem.
4771: return 0;
4772: }
4773:
4774: =pod
4775:
4776: =head2 Resource/Nav Map Navigation
4777:
4778: =over 4
4779:
4780: =item * B<getNext>():
4781:
4782: Retreive an array of the possible next resources after this
4783: one. Always returns an array, even in the one- or zero-element case.
4784:
4785: =item * B<getPrevious>():
4786:
4787: Retreive an array of the possible previous resources from this
4788: one. Always returns an array, even in the one- or zero-element case.
4789:
4790: =cut
4791:
4792: sub getNext {
4793: my $self = shift;
4794: my @branches;
4795: my $to = $self->to();
4796: foreach my $branch ( split(/,/, $to) ) {
4797: my $choice = $self->{NAV_MAP}->getById($branch);
4798: #if (!$choice->condition()) { next; }
4799: my $next = $choice->goesto();
4800: $next = $self->{NAV_MAP}->getById($next);
4801:
4802: push @branches, $next;
4803: }
4804: return \@branches;
4805: }
4806:
4807: sub getPrevious {
4808: my $self = shift;
4809: my @branches;
4810: my $from = $self->from();
4811: foreach my $branch ( split /,/, $from) {
4812: my $choice = $self->{NAV_MAP}->getById($branch);
4813: my $prev = $choice->comesfrom();
4814: $prev = $self->{NAV_MAP}->getById($prev);
4815:
4816: push @branches, $prev;
4817: }
4818: return \@branches;
4819: }
4820:
4821: sub browsePriv {
4822: my $self = shift;
4823: if (defined($self->{BROWSE_PRIV})) {
4824: return $self->{BROWSE_PRIV};
4825: }
4826:
4827: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
4828: $self->symb());
4829: }
4830:
4831: =pod
4832:
4833: =back
4834:
4835: =cut
4836:
4837: 1;
4838:
4839: __END__
4840:
4841:
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