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