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