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