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