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