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