File:
[LON-CAPA] /
loncom /
interface /
lonnavmaps.pm
Revision
1.393:
download - view:
text,
annotated -
select for diffs
Wed Dec 20 23:02:33 2006 UTC (17 years, 5 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
Renaming unread_discussion() as discussion_info() and making the funtion more universally useful. Can now be used to retrieve counts for all postings, or just unread postings (if 'unread') is included as an argumnet in the call (e.g., $resource->discussion_info('unread');). Also if
called in array context, returns ($count,%info), where %info is a hash of a hash. Outer hash keys are count number, inner hash keys are: subject, id, timestamp.
1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
4: # $Id: lonnavmaps.pm,v 1.393 2006/12/20 23:02:33 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonnavmaps;
31:
32: use strict;
33: use GDBM_File;
34: use Apache::loncommon();
35: use Apache::lonenc();
36: use Apache::lonlocal;
37: use Apache::lonnet;
38: use POSIX qw (floor strftime);
39: use 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 discussion_info {
2038: my $self = shift;
2039: my $symb = shift;
2040: my $filter = shift;
2041:
2042: $self->get_discussion_data();
2043:
2044: my $ressymb = $self->wrap_symb($symb);
2045: # keys used to store bulletinboard postings use 'unwrapped' symb.
2046: my $discsymb = $self->unwrap_symb($ressymb);
2047: my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
2048: if (!$version) { return; }
2049:
2050: my $prevread = $self->{LAST_READ}{$ressymb};
2051:
2052: my $count = 0;
2053: my $hiddenflag = 0;
2054: my $deletedflag = 0;
2055: my ($hidden,$deleted,%info);
2056:
2057: for (my $id=$version; $id>0; $id--) {
2058: my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
2059: my @keys=split(/:/,$vkeys);
2060: if (grep(/^hidden$/ ,@keys)) {
2061: if (!$hiddenflag) {
2062: $hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
2063: $hiddenflag = 1;
2064: }
2065: } elsif (grep(/^deleted$/,@keys)) {
2066: if (!$deletedflag) {
2067: $deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
2068: $deletedflag = 1;
2069: }
2070: } else {
2071: if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
2072: if ($filter eq 'unread') {
2073: if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
2074: next;
2075: }
2076: }
2077: $count++;
2078: $info{$count}{'subject'} =
2079: $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
2080: $info{$count}{'id'} = $id;
2081: $info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'};
2082: }
2083: }
2084: }
2085: if (wantarray) {
2086: return ($count,%info);
2087: }
2088: return $count;
2089: }
2090:
2091: sub wrap_symb {
2092: my $self = shift;
2093: my $symb = shift;
2094: if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
2095: unless ($symb =~ m|adm/wrapper/adm|) {
2096: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
2097: }
2098: }
2099: return $symb;
2100: }
2101:
2102: sub unwrap_symb {
2103: my $self = shift;
2104: my $ressymb = shift;
2105: my $discsymb = $ressymb;
2106: if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
2107: $discsymb = $1.$2;
2108: }
2109: return $discsymb;
2110: }
2111:
2112: # Private method: Does the given resource (as a symb string) have
2113: # current feedback? Returns the string in the feedback hash, which
2114: # will be false if it does not exist.
2115:
2116: sub getFeedback {
2117: my $self = shift;
2118: my $symb = shift;
2119:
2120: $self->generate_email_discuss_status();
2121:
2122: if (!defined($self->{FEEDBACK})) { return ""; }
2123:
2124: return $self->{FEEDBACK}->{$symb};
2125: }
2126:
2127: # Private method: Get the errors for that resource (by source).
2128: sub getErrors {
2129: my $self = shift;
2130: my $src = shift;
2131:
2132: $self->generate_email_discuss_status();
2133:
2134: if (!defined($self->{ERROR_MSG})) { return ""; }
2135: return $self->{ERROR_MSG}->{$src};
2136: }
2137:
2138: =pod
2139:
2140: =item * B<getById>(id):
2141:
2142: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2143: object for that resource. This method, or other methods that use it
2144: (as in the resource object) is the only proper way to obtain a
2145: resource object.
2146:
2147: =item * B<getBySymb>(symb):
2148:
2149: Based on the symb of the resource, get a resource object for that
2150: resource. This is one of the proper ways to get a resource object.
2151:
2152: =item * B<getMapByMapPc>(map_pc):
2153:
2154: Based on the map_pc of the resource, get a resource object for
2155: the given map. This is one of the proper ways to get a resource object.
2156:
2157: =cut
2158:
2159: # The strategy here is to cache the resource objects, and only construct them
2160: # as we use them. The real point is to prevent reading any more from the tied
2161: # hash then we have to, which should hopefully alleviate speed problems.
2162:
2163: sub getById {
2164: my $self = shift;
2165: my $id = shift;
2166:
2167: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2168: {
2169: return $self->{RESOURCE_CACHE}->{$id};
2170: }
2171:
2172: # resource handles inserting itself into cache.
2173: # Not clear why the quotes are necessary, but as of this
2174: # writing it doesn't work without them.
2175: return "Apache::lonnavmaps::resource"->new($self, $id);
2176: }
2177:
2178: sub getBySymb {
2179: my $self = shift;
2180: my $symb = shift;
2181:
2182: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
2183: my $map = $self->getResourceByUrl($mapUrl);
2184: my $returnvalue = undef;
2185: if (ref($map)) {
2186: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2187: }
2188: return $returnvalue;
2189: }
2190:
2191: sub getByMapPc {
2192: my $self = shift;
2193: my $map_pc = shift;
2194: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2195: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2196: return $self->getById($map_id);
2197: }
2198:
2199: =pod
2200:
2201: =item * B<firstResource>():
2202:
2203: Returns a resource object reference corresponding to the first
2204: resource in the navmap.
2205:
2206: =cut
2207:
2208: sub firstResource {
2209: my $self = shift;
2210: my $firstResource = $self->navhash('map_start_' .
2211: &Apache::lonnet::clutter($env{'request.course.uri'}));
2212: return $self->getById($firstResource);
2213: }
2214:
2215: =pod
2216:
2217: =item * B<finishResource>():
2218:
2219: Returns a resource object reference corresponding to the last resource
2220: in the navmap.
2221:
2222: =cut
2223:
2224: sub finishResource {
2225: my $self = shift;
2226: my $firstResource = $self->navhash('map_finish_' .
2227: &Apache::lonnet::clutter($env{'request.course.uri'}));
2228: return $self->getById($firstResource);
2229: }
2230:
2231: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2232: # the actual lookup; parmval caches the results.
2233: sub parmval {
2234: my $self = shift;
2235: my ($what,$symb)=@_;
2236: my $hashkey = $what."|||".$symb;
2237:
2238: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2239: return $self->{PARM_CACHE}->{$hashkey};
2240: }
2241:
2242: my $result = $self->parmval_real($what, $symb);
2243: $self->{PARM_CACHE}->{$hashkey} = $result;
2244: return $result;
2245: }
2246:
2247: sub parmval_real {
2248: my $self = shift;
2249: my ($what,$symb,$recurse) = @_;
2250:
2251: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2252: $self->generate_course_user_opt();
2253:
2254: my $cid=$env{'request.course.id'};
2255: my $csec=$env{'request.course.sec'};
2256: my $cgroup='';
2257: my @cgrps=split(/:/,$env{'request.course.groups'});
2258: if (@cgrps > 0) {
2259: @cgrps = sort(@cgrps);
2260: $cgroup = $cgrps[0];
2261: }
2262: my $uname=$env{'user.name'};
2263: my $udom=$env{'user.domain'};
2264:
2265: unless ($symb) { return ''; }
2266: my $result='';
2267:
2268: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
2269: $mapname = &Apache::lonnet::deversion($mapname);
2270: # ----------------------------------------------------- Cascading lookup scheme
2271: my $rwhat=$what;
2272: $what=~s/^parameter\_//;
2273: $what=~s/\_/\./;
2274:
2275: my $symbparm=$symb.'.'.$what;
2276: my $mapparm=$mapname.'___(all).'.$what;
2277: my $usercourseprefix=$cid;
2278:
2279: my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
2280: my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
2281: my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;
2282:
2283: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2284: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2285: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2286:
2287: my $courselevel= $usercourseprefix.'.'.$what;
2288: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2289: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2290:
2291: my $useropt = $self->{USER_OPT};
2292: my $courseopt = $self->{COURSE_OPT};
2293: my $parmhash = $self->{PARM_HASH};
2294:
2295: # ---------------------------------------------------------- first, check user
2296: if ($uname and defined($useropt)) {
2297: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
2298: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
2299: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
2300: }
2301:
2302: # ------------------------------------------------------- second, check course
2303: if ($cgroup ne '' and defined($courseopt)) {
2304: if (defined($$courseopt{$grplevelr})) { return $$courseopt{$grplevelr}; }
2305: if (defined($$courseopt{$grplevelm})) { return $$courseopt{$grplevelm}; }
2306: if (defined($$courseopt{$grplevel})) { return $$courseopt{$grplevel}; }
2307: }
2308:
2309: if ($csec and defined($courseopt)) {
2310: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
2311: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
2312: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
2313: }
2314:
2315: if (defined($courseopt)) {
2316: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
2317: }
2318:
2319: # ----------------------------------------------------- third, check map parms
2320:
2321: my $thisparm=$$parmhash{$symbparm};
2322: if (defined($thisparm)) { return $thisparm; }
2323:
2324: # ----------------------------------------------------- fourth , check default
2325:
2326: my $meta_rwhat=$rwhat;
2327: $meta_rwhat=~s/\./_/g;
2328: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
2329: if (defined($default)) { return $default}
2330: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
2331: if (defined($default)) { return $default}
2332:
2333: # --------------------------------------------------- fifth, check more course
2334: if (defined($courseopt)) {
2335: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
2336: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
2337: }
2338:
2339: # --------------------------------------------------- sixth , cascade up parts
2340:
2341: my ($space,@qualifier)=split(/\./,$rwhat);
2342: my $qualifier=join('.',@qualifier);
2343: unless ($space eq '0') {
2344: my @parts=split(/_/,$space);
2345: my $id=pop(@parts);
2346: my $part=join('_',@parts);
2347: if ($part eq '') { $part='0'; }
2348: my $partgeneral=$self->parmval($part.".$qualifier",$symb,1);
2349: if (defined($partgeneral)) { return $partgeneral; }
2350: }
2351: if ($recurse) { return undef; }
2352: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
2353: if (defined($pack_def)) { return $pack_def; }
2354: return '';
2355: }
2356:
2357: =pod
2358:
2359: =item * B<getResourceByUrl>(url,multiple):
2360:
2361: Retrieves a resource object by URL of the resource, unless the optional
2362: multiple parameter is included in wahich caes an array of resource
2363: objects is returned. If passed a resource object, it will simply return
2364: it, so it is safe to use this method in code like
2365: "$res = $navmap->getResourceByUrl($res)"
2366: if you're not sure if $res is already an object, or just a URL. If the
2367: resource appears multiple times in the course, only the first instance
2368: will be returned (useful for maps), unless the multiple parameter has
2369: been included, in which case all instances are returned in an array.
2370:
2371: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
2372:
2373: The map is a specification of a map to retreive the resources from,
2374: either as a url or as an object. The filterFunc is a reference to a
2375: function that takes a resource object as its one argument and returns
2376: true if the resource should be included, or false if it should not
2377: be. If recursive is true, the map will be recursively examined,
2378: otherwise it will not be. If bailout is true, the function will return
2379: as soon as it finds a resource, if false it will finish. If showall is
2380: true it will not hide maps that contain nothing but one other map. By
2381: default, the map is the top-level map of the course, filterFunc is a
2382: function that always returns 1, recursive is true, bailout is false,
2383: showall is false. The resources will be returned in a list containing
2384: the resource objects for the corresponding resources, with B<no
2385: structure information> in the list; regardless of branching,
2386: recursion, etc., it will be a flat list.
2387:
2388: Thus, this is suitable for cases where you don't want the structure,
2389: just a list of all resources. It is also suitable for finding out how
2390: many resources match a given description; for this use, if all you
2391: want to know is if I<any> resources match the description, the bailout
2392: parameter will allow you to avoid potentially expensive enumeration of
2393: all matching resources.
2394:
2395: =item * B<hasResource>(map, filterFunc, recursive, showall):
2396:
2397: Convience method for
2398:
2399: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
2400:
2401: which will tell whether the map has resources matching the description
2402: in the filter function.
2403:
2404: =item * B<usedVersion>(url):
2405:
2406: Retrieves version infomation for a url. Returns the version (a number, or
2407: the string "mostrecent") for resources which have version information in
2408: the big hash.
2409:
2410: =cut
2411:
2412:
2413: sub getResourceByUrl {
2414: my $self = shift;
2415: my $resUrl = shift;
2416: my $multiple = shift;
2417:
2418: if (ref($resUrl)) { return $resUrl; }
2419:
2420: $resUrl = &Apache::lonnet::clutter($resUrl);
2421: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2422: if (!$resId) { return ''; }
2423: if ($multiple) {
2424: my @resources = ();
2425: my @resIds = split (/,/, $resId);
2426: foreach my $id (@resIds) {
2427: my $resourceId = $self->getById($id);
2428: if ($resourceId) {
2429: push(@resources,$resourceId);
2430: }
2431: }
2432: return @resources;
2433: } else {
2434: if ($resId =~ /,/) {
2435: $resId = (split (/,/, $resId))[0];
2436: }
2437: return $self->getById($resId);
2438: }
2439: }
2440:
2441: sub retrieveResources {
2442: my $self = shift;
2443: my $map = shift;
2444: my $filterFunc = shift;
2445: if (!defined ($filterFunc)) {
2446: $filterFunc = sub {return 1;};
2447: }
2448: my $recursive = shift;
2449: if (!defined($recursive)) { $recursive = 1; }
2450: my $bailout = shift;
2451: if (!defined($bailout)) { $bailout = 0; }
2452: my $showall = shift;
2453: # Create the necessary iterator.
2454: if (!ref($map)) { # assume it's a url of a map.
2455: $map = $self->getResourceByUrl($map);
2456: }
2457:
2458: # If nothing was passed, assume top-level map
2459: if (!$map) {
2460: $map = $self->getById('0.0');
2461: }
2462:
2463: # Check the map's validity.
2464: if (!$map->is_map()) {
2465: # Oh, to throw an exception.... how I'd love that!
2466: return ();
2467: }
2468:
2469: # Get an iterator.
2470: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
2471: undef, $recursive, $showall);
2472:
2473: my @resources = ();
2474:
2475: # Run down the iterator and collect the resources.
2476: my $curRes;
2477:
2478: while ($curRes = $it->next()) {
2479: if (ref($curRes)) {
2480: if (!&$filterFunc($curRes)) {
2481: next;
2482: }
2483:
2484: push @resources, $curRes;
2485:
2486: if ($bailout) {
2487: return @resources;
2488: }
2489: }
2490:
2491: }
2492:
2493: return @resources;
2494: }
2495:
2496: sub hasResource {
2497: my $self = shift;
2498: my $map = shift;
2499: my $filterFunc = shift;
2500: my $recursive = shift;
2501: my $showall = shift;
2502:
2503: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
2504: }
2505:
2506: sub usedVersion {
2507: my $self = shift;
2508: my $linkurl = shift;
2509: return $self->navhash("version_$linkurl");
2510: }
2511:
2512: 1;
2513:
2514: package Apache::lonnavmaps::iterator;
2515: use Scalar::Util qw(weaken);
2516: use Apache::lonnet;
2517:
2518: =pod
2519:
2520: =back
2521:
2522: =head1 Object: navmap Iterator
2523:
2524: An I<iterator> encapsulates the logic required to traverse a data
2525: structure. navmap uses an iterator to traverse the course map
2526: according to the criteria you wish to use.
2527:
2528: To obtain an iterator, call the B<getIterator>() function of a
2529: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2530: directly.) This will return a reference to the iterator:
2531:
2532: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2533:
2534: To get the next thing from the iterator, call B<next>:
2535:
2536: C<my $nextThing = $resourceIterator-E<gt>next()>
2537:
2538: getIterator behaves as follows:
2539:
2540: =over 4
2541:
2542: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2543:
2544: All parameters are optional. firstResource is a resource reference
2545: corresponding to where the iterator should start. It defaults to
2546: navmap->firstResource() for the corresponding nav map. finishResource
2547: corresponds to where you want the iterator to end, defaulting to
2548: navmap->finishResource(). filterHash is a hash used as a set
2549: containing strings representing the resource IDs, defaulting to
2550: empty. Condition is a 1 or 0 that sets what to do with the filter
2551: hash: If a 0, then only resources that exist IN the filterHash will be
2552: recursed on. If it is a 1, only resources NOT in the filterHash will
2553: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2554: false (default), the iterator will only return the first level of map
2555: that is not just a single, 'redirecting' map. If true, the iterator
2556: will return all information, starting with the top-level map,
2557: regardless of content. returnTopMap, if true (default false), will
2558: cause the iterator to return the top-level map object (resource 0.0)
2559: before anything else.
2560:
2561: Thus, by default, only top-level resources will be shown. Change the
2562: condition to a 1 without changing the hash, and all resources will be
2563: shown. Changing the condition to 1 and including some values in the
2564: hash will allow you to selectively suppress parts of the navmap, while
2565: leaving it on 0 and adding things to the hash will allow you to
2566: selectively add parts of the nav map. See the handler code for
2567: examples.
2568:
2569: The iterator will return either a reference to a resource object, or a
2570: token representing something in the map, such as the beginning of a
2571: new branch. The possible tokens are:
2572:
2573: =over 4
2574:
2575: =item * B<END_ITERATOR>:
2576:
2577: The iterator has returned all that it's going to. Further calls to the
2578: iterator will just produce more of these. This is a "false" value, and
2579: is the only false value the iterator which will be returned, so it can
2580: be used as a loop sentinel.
2581:
2582: =item * B<BEGIN_MAP>:
2583:
2584: A new map is being recursed into. This is returned I<after> the map
2585: resource itself is returned.
2586:
2587: =item * B<END_MAP>:
2588:
2589: The map is now done.
2590:
2591: =item * B<BEGIN_BRANCH>:
2592:
2593: A branch is now starting. The next resource returned will be the first
2594: in that branch.
2595:
2596: =item * B<END_BRANCH>:
2597:
2598: The branch is now done.
2599:
2600: =back
2601:
2602: The tokens are retreivable via methods on the iterator object, i.e.,
2603: $iterator->END_MAP.
2604:
2605: Maps can contain empty resources. The iterator will automatically skip
2606: over such resources, but will still treat the structure
2607: correctly. Thus, a complicated map with several branches, but
2608: consisting entirely of empty resources except for one beginning or
2609: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2610: but only one resource will be returned.
2611:
2612: =back
2613:
2614: =head2 Normal Usage
2615:
2616: Normal usage of the iterator object is to do the following:
2617:
2618: my $it = $navmap->getIterator([your params here]);
2619: my $curRes;
2620: while ($curRes = $it->next()) {
2621: [your logic here]
2622: }
2623:
2624: Note that inside of the loop, it's frequently useful to check if
2625: "$curRes" is a reference or not with the reference function; only
2626: resource objects will be references, and any non-references will
2627: be the tokens described above.
2628:
2629: Also note there is some old code floating around that trys to track
2630: the depth of the iterator to see when it's done; do not copy that
2631: code. It is difficult to get right and harder to understand then
2632: this. They should be migrated to this new style.
2633:
2634: =cut
2635:
2636: # Here are the tokens for the iterator:
2637:
2638: sub END_ITERATOR { return 0; }
2639: sub BEGIN_MAP { return 1; } # begining of a new map
2640: sub END_MAP { return 2; } # end of the map
2641: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2642: sub END_BRANCH { return 4; } # end of a branch
2643: sub FORWARD { return 1; } # go forward
2644: sub BACKWARD { return 2; }
2645:
2646: sub min {
2647: (my $a, my $b) = @_;
2648: if ($a < $b) { return $a; } else { return $b; }
2649: }
2650:
2651: sub new {
2652: # magic invocation to create a class instance
2653: my $proto = shift;
2654: my $class = ref($proto) || $proto;
2655: my $self = {};
2656:
2657: weaken($self->{NAV_MAP} = shift);
2658: return undef unless ($self->{NAV_MAP});
2659:
2660: # Handle the parameters
2661: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2662: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2663:
2664: # If the given resources are just the ID of the resource, get the
2665: # objects
2666: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2667: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2668: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2669: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2670:
2671: $self->{FILTER} = shift;
2672:
2673: # A hash, used as a set, of resource already seen
2674: $self->{ALREADY_SEEN} = shift;
2675: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2676: $self->{CONDITION} = shift;
2677:
2678: # Do we want to automatically follow "redirection" maps?
2679: $self->{FORCE_TOP} = shift;
2680:
2681: # Do we want to return the top-level map object (resource 0.0)?
2682: $self->{RETURN_0} = shift;
2683: # have we done that yet?
2684: $self->{HAVE_RETURNED_0} = 0;
2685:
2686: # Now, we need to pre-process the map, by walking forward and backward
2687: # over the parts of the map we're going to look at.
2688:
2689: # The processing steps are exactly the same, except for a few small
2690: # changes, so I bundle those up in the following list of two elements:
2691: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2692: # first_resource).
2693: # This prevents writing nearly-identical code twice.
2694: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2695: 'FIRST_RESOURCE'],
2696: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2697: 'FINISH_RESOURCE'] );
2698:
2699: my $maxDepth = 0; # tracks max depth
2700:
2701: # If there is only one resource in this map, and it's a map, we
2702: # want to remember that, so the user can ask for the first map
2703: # that isn't just a redirector.
2704: my $resource; my $resourceCount = 0;
2705:
2706: # Documentation on this algorithm can be found in the CVS repository at
2707: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2708: # in that file.
2709: # **1**
2710:
2711: foreach my $pass (@iterations) {
2712: my $direction = $pass->[0];
2713: my $valName = $pass->[1];
2714: my $nextResourceMethod = $pass->[2];
2715: my $firstResourceName = $pass->[3];
2716:
2717: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2718: $self->{FIRST_RESOURCE},
2719: $self->{FINISH_RESOURCE},
2720: {}, undef, 0, $direction);
2721:
2722: # prime the recursion
2723: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
2724: $iterator->next();
2725: my $curRes = $iterator->next();
2726: my $depth = 1;
2727: while ($depth > 0) {
2728: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2729: if ($curRes == $iterator->END_MAP()) { $depth--; }
2730:
2731: if (ref($curRes)) {
2732: # If there's only one resource, this will save it
2733: # we have to filter empty resources from consideration here,
2734: # or even "empty", redirecting maps have two (start & finish)
2735: # or three (start, finish, plus redirector)
2736: if($direction == FORWARD && $curRes->src()) {
2737: $resource = $curRes; $resourceCount++;
2738: }
2739: my $resultingVal = $curRes->{DATA}->{$valName};
2740: my $nextResources = $curRes->$nextResourceMethod();
2741: my $nextCount = scalar(@{$nextResources});
2742:
2743: if ($nextCount == 1) { # **3**
2744: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2745: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2746: }
2747:
2748: if ($nextCount > 1) { # **4**
2749: foreach my $res (@{$nextResources}) {
2750: my $current = $res->{DATA}->{$valName} || 999999999;
2751: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2752: }
2753: }
2754: }
2755:
2756: # Assign the final val (**2**)
2757: if (ref($curRes) && $direction == BACKWARD()) {
2758: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2759: $curRes->{DATA}->{BOT_UP_VAL});
2760:
2761: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2762: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
2763: }
2764:
2765: $curRes = $iterator->next();
2766: }
2767: }
2768:
2769: # Check: Was this only one resource, a map?
2770: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
2771: my $firstResource = $resource->map_start();
2772: my $finishResource = $resource->map_finish();
2773: return
2774: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2775: $finishResource, $self->{FILTER},
2776: $self->{ALREADY_SEEN},
2777: $self->{CONDITION},
2778: $self->{FORCE_TOP});
2779:
2780: }
2781:
2782: # Set up some bookkeeping information.
2783: $self->{CURRENT_DEPTH} = 0;
2784: $self->{MAX_DEPTH} = $maxDepth;
2785: $self->{STACK} = [];
2786: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2787: $self->{FINISHED} = 0; # When true, the iterator has finished
2788:
2789: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2790: push @{$self->{STACK}}, [];
2791: }
2792:
2793: # Prime the recursion w/ the first resource **5**
2794: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2795: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2796:
2797: bless ($self);
2798:
2799: return $self;
2800: }
2801:
2802: sub next {
2803: my $self = shift;
2804: my $closeAllPages=shift;
2805: if ($self->{FINISHED}) {
2806: return END_ITERATOR();
2807: }
2808:
2809: # If we want to return the top-level map object, and haven't yet,
2810: # do so.
2811: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2812: $self->{HAVE_RETURNED_0} = 1;
2813: return $self->{NAV_MAP}->getById('0.0');
2814: }
2815:
2816: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2817: # grab the next from the recursive iterator
2818: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
2819:
2820: # is it a begin or end map? If so, update the depth
2821: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2822: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2823:
2824: # Are we back at depth 0? If so, stop recursing
2825: if ($self->{RECURSIVE_DEPTH} == 0) {
2826: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2827: }
2828:
2829: return $next;
2830: }
2831:
2832: if (defined($self->{FORCE_NEXT})) {
2833: my $tmp = $self->{FORCE_NEXT};
2834: $self->{FORCE_NEXT} = undef;
2835: return $tmp;
2836: }
2837:
2838: # Have we not yet begun? If not, return BEGIN_MAP and
2839: # remember we've started.
2840: if ( !$self->{STARTED} ) {
2841: $self->{STARTED} = 1;
2842: return $self->BEGIN_MAP();
2843: }
2844:
2845: # Here's the guts of the iterator.
2846:
2847: # Find the next resource, if any.
2848: my $found = 0;
2849: my $i = $self->{MAX_DEPTH};
2850: my $newDepth;
2851: my $here;
2852: while ( $i >= 0 && !$found ) {
2853: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
2854: $here = pop @{$self->{STACK}->[$i]}; # **7**
2855: $found = 1;
2856: $newDepth = $i;
2857: }
2858: $i--;
2859: }
2860:
2861: # If we still didn't find anything, we're done.
2862: if ( !$found ) {
2863: # We need to get back down to the correct branch depth
2864: if ( $self->{CURRENT_DEPTH} > 0 ) {
2865: $self->{CURRENT_DEPTH}--;
2866: return END_BRANCH();
2867: } else {
2868: $self->{FINISHED} = 1;
2869: return END_MAP();
2870: }
2871: }
2872:
2873: # If this is not a resource, it must be an END_BRANCH marker we want
2874: # to return directly.
2875: if (!ref($here)) { # **8**
2876: if ($here == END_BRANCH()) { # paranoia, in case of later extension
2877: $self->{CURRENT_DEPTH}--;
2878: return $here;
2879: }
2880: }
2881:
2882: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
2883: $self->{HERE} = $here;
2884:
2885: # Get to the right level
2886: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
2887: push @{$self->{STACK}->[$newDepth]}, $here;
2888: $self->{CURRENT_DEPTH}--;
2889: return END_BRANCH();
2890: }
2891: if ( $self->{CURRENT_DEPTH} < $newDepth) {
2892: push @{$self->{STACK}->[$newDepth]}, $here;
2893: $self->{CURRENT_DEPTH}++;
2894: return BEGIN_BRANCH();
2895: }
2896:
2897: # If we made it here, we have the next resource, and we're at the
2898: # right branch level. So let's examine the resource for where
2899: # we can get to from here.
2900:
2901: # So we need to look at all the resources we can get to from here,
2902: # categorize them if we haven't seen them, remember if we have a new
2903: my $nextUnfiltered = $here->getNext();
2904: my $maxDepthAdded = -1;
2905:
2906: for (@$nextUnfiltered) {
2907: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
2908: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
2909: push @{$self->{STACK}->[$depth]}, $_;
2910: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
2911: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
2912: }
2913: }
2914:
2915: # Is this the end of a branch? If so, all of the resources examined above
2916: # led to lower levels then the one we are currently at, so we push a END_BRANCH
2917: # marker onto the stack so we don't forget.
2918: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
2919: # BC branch and gets to C, it will see F as the only next resource, but it's
2920: # one level lower. Thus, this is the end of the branch, since there are no
2921: # more resources added to this level or above.
2922: # We don't do this if the examined resource is the finish resource,
2923: # because the condition given above is true, but the "END_MAP" will
2924: # take care of things and we should already be at depth 0.
2925: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
2926: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
2927: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
2928: }
2929:
2930: # That ends the main iterator logic. Now, do we want to recurse
2931: # down this map (if this resource is a map)?
2932: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
2933: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
2934: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2935: my $firstResource = $self->{HERE}->map_start();
2936: my $finishResource = $self->{HERE}->map_finish();
2937:
2938: $self->{RECURSIVE_ITERATOR} =
2939: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2940: $finishResource, $self->{FILTER},
2941: $self->{ALREADY_SEEN},
2942: $self->{CONDITION},
2943: $self->{FORCE_TOP});
2944: }
2945:
2946: # If this is a blank resource, don't actually return it.
2947: # Should you ever find you need it, make sure to add an option to the code
2948: # that you can use; other things depend on this behavior.
2949: my $browsePriv = $self->{HERE}->browsePriv();
2950: if (!$self->{HERE}->src() ||
2951: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
2952: return $self->next($closeAllPages);
2953: }
2954:
2955: return $self->{HERE};
2956:
2957: }
2958:
2959: =pod
2960:
2961: The other method available on the iterator is B<getStack>, which
2962: returns an array populated with the current 'stack' of maps, as
2963: references to the resource objects. Example: This is useful when
2964: making the navigation map, as we need to check whether we are under a
2965: page map to see if we need to link directly to the resource, or to the
2966: page. The first elements in the array will correspond to the top of
2967: the stack (most inclusive map).
2968:
2969: =cut
2970:
2971: sub getStack {
2972: my $self=shift;
2973:
2974: my @stack;
2975:
2976: $self->populateStack(\@stack);
2977:
2978: return \@stack;
2979: }
2980:
2981: # Private method: Calls the iterators recursively to populate the stack.
2982: sub populateStack {
2983: my $self=shift;
2984: my $stack = shift;
2985:
2986: push @$stack, $self->{HERE} if ($self->{HERE});
2987:
2988: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2989: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
2990: }
2991: }
2992:
2993: 1;
2994:
2995: package Apache::lonnavmaps::DFSiterator;
2996: use Scalar::Util qw(weaken);
2997: use Apache::lonnet;
2998:
2999: # Not documented in the perldoc: This is a simple iterator that just walks
3000: # through the nav map and presents the resources in a depth-first search
3001: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3002: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3003: # useful for pre-processing of some kind, and is in fact used by the main
3004: # iterator that way, but that's about it.
3005: # One could imagine merging this into the init routine of the main iterator,
3006: # but this might as well be left separate, since it is possible some other
3007: # use might be found for it. - Jeremy
3008:
3009: # Unlike the main iterator, this DOES return all resources, even blank ones.
3010: # The main iterator needs them to correctly preprocess the map.
3011:
3012: sub BEGIN_MAP { return 1; } # begining of a new map
3013: sub END_MAP { return 2; } # end of the map
3014: sub FORWARD { return 1; } # go forward
3015: sub BACKWARD { return 2; }
3016:
3017: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3018: # filter hash ref (or undef), already seen hash or undef, condition
3019: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
3020: sub new {
3021: # magic invocation to create a class instance
3022: my $proto = shift;
3023: my $class = ref($proto) || $proto;
3024: my $self = {};
3025:
3026: weaken($self->{NAV_MAP} = shift);
3027: return undef unless ($self->{NAV_MAP});
3028:
3029: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3030: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3031:
3032: # If the given resources are just the ID of the resource, get the
3033: # objects
3034: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3035: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3036: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3037: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3038:
3039: $self->{FILTER} = shift;
3040:
3041: # A hash, used as a set, of resource already seen
3042: $self->{ALREADY_SEEN} = shift;
3043: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
3044: $self->{CONDITION} = shift;
3045: $self->{DIRECTION} = shift || FORWARD();
3046:
3047: # Flag: Have we started yet?
3048: $self->{STARTED} = 0;
3049:
3050: # Should we continue calling the recursive iterator, if any?
3051: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3052: # The recursive iterator, if any
3053: $self->{RECURSIVE_ITERATOR} = undef;
3054: # Are we recursing on a map, or a branch?
3055: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3056: # And the count of how deep it is, so that this iterator can keep track of
3057: # when to pick back up again.
3058: $self->{RECURSIVE_DEPTH} = 0;
3059:
3060: # For keeping track of our branches, we maintain our own stack
3061: $self->{STACK} = [];
3062:
3063: # Start with the first resource
3064: if ($self->{DIRECTION} == FORWARD) {
3065: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
3066: } else {
3067: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
3068: }
3069:
3070: bless($self);
3071: return $self;
3072: }
3073:
3074: sub next {
3075: my $self = shift;
3076:
3077: # Are we using a recursive iterator? If so, pull from that and
3078: # watch the depth; we want to resume our level at the correct time.
3079: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3080: # grab the next from the recursive iterator
3081: my $next = $self->{RECURSIVE_ITERATOR}->next();
3082:
3083: # is it a begin or end map? Update depth if so
3084: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3085: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3086:
3087: # Are we back at depth 0? If so, stop recursing.
3088: if ($self->{RECURSIVE_DEPTH} == 0) {
3089: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3090: }
3091:
3092: return $next;
3093: }
3094:
3095: # Is there a current resource to grab? If not, then return
3096: # END_MAP, which will end the iterator.
3097: if (scalar(@{$self->{STACK}}) == 0) {
3098: return $self->END_MAP();
3099: }
3100:
3101: # Have we not yet begun? If not, return BEGIN_MAP and
3102: # remember that we've started.
3103: if ( !$self->{STARTED} ) {
3104: $self->{STARTED} = 1;
3105: return $self->BEGIN_MAP;
3106: }
3107:
3108: # Get the next resource in the branch
3109: $self->{HERE} = pop @{$self->{STACK}};
3110:
3111: # remember that we've seen this, so we don't return it again later
3112: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3113:
3114: # Get the next possible resources
3115: my $nextUnfiltered;
3116: if ($self->{DIRECTION} == FORWARD()) {
3117: $nextUnfiltered = $self->{HERE}->getNext();
3118: } else {
3119: $nextUnfiltered = $self->{HERE}->getPrevious();
3120: }
3121: my $next = [];
3122:
3123: # filter the next possibilities to remove things we've
3124: # already seen.
3125: foreach (@$nextUnfiltered) {
3126: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
3127: push @$next, $_;
3128: }
3129: }
3130:
3131: while (@$next) {
3132: # copy the next possibilities over to the stack
3133: push @{$self->{STACK}}, shift @$next;
3134: }
3135:
3136: # If this is a map and we want to recurse down it... (not filtered out)
3137: if ($self->{HERE}->is_map() &&
3138: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3139: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3140: my $firstResource = $self->{HERE}->map_start();
3141: my $finishResource = $self->{HERE}->map_finish();
3142:
3143: $self->{RECURSIVE_ITERATOR} =
3144: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
3145: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
3146: $self->{CONDITION}, $self->{DIRECTION});
3147: }
3148:
3149: return $self->{HERE};
3150: }
3151:
3152: # Identical to the full iterator methods of the same name. Hate to copy/paste
3153: # but I also hate to "inherit" either iterator from the other.
3154:
3155: sub getStack {
3156: my $self=shift;
3157:
3158: my @stack;
3159:
3160: $self->populateStack(\@stack);
3161:
3162: return \@stack;
3163: }
3164:
3165: # Private method: Calls the iterators recursively to populate the stack.
3166: sub populateStack {
3167: my $self=shift;
3168: my $stack = shift;
3169:
3170: push @$stack, $self->{HERE} if ($self->{HERE});
3171:
3172: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3173: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3174: }
3175: }
3176:
3177: 1;
3178:
3179: package Apache::lonnavmaps::resource;
3180: use Scalar::Util qw(weaken);
3181: use Apache::lonnet;
3182:
3183: =pod
3184:
3185: =head1 Object: resource
3186:
3187: X<resource, navmap object>
3188: A resource object encapsulates a resource in a resource map, allowing
3189: easy manipulation of the resource, querying the properties of the
3190: resource (including user properties), and represents a reference that
3191: can be used as the canonical representation of the resource by
3192: lonnavmap clients like renderers.
3193:
3194: A resource only makes sense in the context of a navmap, as some of the
3195: data is stored in the navmap object.
3196:
3197: You will probably never need to instantiate this object directly. Use
3198: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3199: starting resource.
3200:
3201: Resource objects respect the parameter_hiddenparts, which suppresses
3202: various parts according to the wishes of the map author. As of this
3203: writing, there is no way to override this parameter, and suppressed
3204: parts will never be returned, nor will their response types or ids be
3205: stored.
3206:
3207: =head2 Overview
3208:
3209: A B<Resource> is the most granular type of object in LON-CAPA that can
3210: be included in a course. It can either be a particular resource, like
3211: an HTML page, external resource, problem, etc., or it can be a
3212: container sequence, such as a "page" or a "map".
3213:
3214: To see a sequence from the user's point of view, please see the
3215: B<Creating a Course: Maps and Sequences> chapter of the Author's
3216: Manual.
3217:
3218: A Resource Object, once obtained from a navmap object via a B<getBy*>
3219: method of the navmap, or from an iterator, allows you to query
3220: information about that resource.
3221:
3222: Generally, you do not ever want to create a resource object yourself,
3223: so creation has been left undocumented. Always retrieve resources
3224: from navmap objects.
3225:
3226: =head3 Identifying Resources
3227:
3228: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3229: unique to that resource for a given course. X<resource ID, in big hash>
3230: The Resource ID has the form #.#, where the first number is the same
3231: for every resource in a map, and the second is unique. For instance,
3232: for a course laid out like this:
3233:
3234: * Problem 1
3235: * Map
3236: * Resource 2
3237: * Resource 3
3238:
3239: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3240: C<Resource 3> will share a first number. The second number may end up
3241: re-used between the two groups.
3242:
3243: The resource ID is only used in the big hash, but can be used in the
3244: context of a course to identify a resource easily. (For instance, the
3245: printing system uses it to record which resources from a sequence you
3246: wish to print.)
3247:
3248: X<symb> X<resource, symb>
3249: All resources also have B<symb>s, which uniquely identify a resource
3250: in a course. Many internal LON-CAPA functions expect a symb. A symb
3251: carries along with it the URL of the resource, and the map it appears
3252: in. Symbs are much larger then resource IDs.
3253:
3254: =cut
3255:
3256: sub new {
3257: # magic invocation to create a class instance
3258: my $proto = shift;
3259: my $class = ref($proto) || $proto;
3260: my $self = {};
3261:
3262: weaken($self->{NAV_MAP} = shift);
3263: $self->{ID} = shift;
3264:
3265: # Store this new resource in the parent nav map's cache.
3266: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
3267: $self->{RESOURCE_ERROR} = 0;
3268:
3269: # A hash that can be used by two-pass algorithms to store data
3270: # about this resource in. Not used by the resource object
3271: # directly.
3272: $self->{DATA} = {};
3273:
3274: bless($self);
3275:
3276: return $self;
3277: }
3278:
3279: # private function: simplify the NAV_HASH lookups we keep doing
3280: # pass the name, and to automatically append my ID, pass a true val on the
3281: # second param
3282: sub navHash {
3283: my $self = shift;
3284: my $param = shift;
3285: my $id = shift;
3286: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
3287: }
3288:
3289: =pod
3290:
3291: =head2 Methods
3292:
3293: Once you have a resource object, here's what you can do with it:
3294:
3295: =head3 Attribute Retrieval
3296:
3297: Every resource has certain attributes that can be retrieved and used:
3298:
3299: =over 4
3300:
3301: =item * B<ID>: Every resource has an ID that is unique for that
3302: resource in the course it is in. The ID is actually in the hash
3303: representing the resource, so for a resource object $res, obtain
3304: it via C<$res->{ID}).
3305:
3306: =item * B<compTitle>:
3307:
3308: Returns a "composite title", that is equal to $res->title() if the
3309: resource has a title, and is otherwise the last part of the URL (e.g.,
3310: "problem.problem").
3311:
3312: =item * B<ext>:
3313:
3314: Returns true if the resource is external.
3315:
3316: =item * B<kind>:
3317:
3318: Returns the kind of the resource from the compiled nav map.
3319:
3320: =item * B<randomout>:
3321:
3322: Returns true if this resource was chosen to NOT be shown to the user
3323: by the random map selection feature. In other words, this is usually
3324: false.
3325:
3326: =item * B<randompick>:
3327:
3328: Returns true for a map if the randompick feature is being used on the
3329: map. (?)
3330:
3331: =item * B<src>:
3332:
3333: Returns the source for the resource.
3334:
3335: =item * B<symb>:
3336:
3337: Returns the symb for the resource.
3338:
3339: =item * B<title>:
3340:
3341: Returns the title of the resource.
3342:
3343: =back
3344:
3345: =cut
3346:
3347: # These info functions can be used directly, as they don't return
3348: # resource information.
3349: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
3350: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
3351: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
3352: sub from { my $self=shift; return $self->navHash("from_", 1); }
3353: # considered private and undocumented
3354: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3355: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
3356: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3357: sub randompick {
3358: my $self = shift;
3359: return $self->parmval('randompick');
3360: }
3361: sub link {
3362: my $self=shift;
3363: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3364: return $self->src;
3365: }
3366: sub src {
3367: my $self=shift;
3368: return $self->navHash("src_", 1);
3369: }
3370: sub shown_symb {
3371: my $self=shift;
3372: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3373: return $self->symb();
3374: }
3375: sub id {
3376: my $self=shift;
3377: return $self->{ID};
3378: }
3379: sub enclosing_map_src {
3380: my $self=shift;
3381: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3382: return $self->navHash('map_id_'.$first);
3383: }
3384: sub symb {
3385: my $self=shift;
3386: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3387: my $symbSrc = &Apache::lonnet::declutter($self->src());
3388: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
3389: . '___' . $second . '___' . $symbSrc;
3390: return &Apache::lonnet::symbclean($symb);
3391: }
3392: sub wrap_symb {
3393: my $self = shift;
3394: return $self->{NAV_MAP}->wrap_symb($self->symb());
3395: }
3396: sub title {
3397: my $self=shift;
3398: if ($self->{ID} eq '0.0') {
3399: # If this is the top-level map, return the title of the course
3400: # since this map can not be titled otherwise.
3401: return $env{'course.'.$env{'request.course.id'}.'.description'};
3402: }
3403: return $self->navHash("title_", 1); }
3404: # considered private and undocumented
3405: sub to { my $self=shift; return $self->navHash("to_", 1); }
3406: sub condition {
3407: my $self=shift;
3408: my $undercond=$self->navHash("undercond_", 1);
3409: if (!defined($undercond)) { return 1; };
3410: my $condid=$self->navHash("condid_$undercond");
3411: if (!defined($condid)) { return 1; };
3412: my $condition=&Apache::lonnet::directcondval($condid);
3413: return $condition;
3414: }
3415: sub condval {
3416: my $self=shift;
3417: my ($pathname,$filename) =
3418: &Apache::lonnet::split_uri_for_cond($self->src());
3419:
3420: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3421: /\&\Q$filename\E\:([\d\|]+)\&/);
3422: if ($match) {
3423: return &Apache::lonnet::condval($1);
3424: }
3425: return 0;
3426: }
3427: sub compTitle {
3428: my $self = shift;
3429: my $title = $self->title();
3430: $title=~s/\&colon\;/\:/gs;
3431: if (!$title) {
3432: $title = $self->src();
3433: $title = substr($title, rindex($title, '/') + 1);
3434: }
3435: return $title;
3436: }
3437: =pod
3438:
3439: B<Predicate Testing the Resource>
3440:
3441: These methods are shortcuts to deciding if a given resource has a given property.
3442:
3443: =over 4
3444:
3445: =item * B<is_map>:
3446:
3447: Returns true if the resource is a map type.
3448:
3449: =item * B<is_problem>:
3450:
3451: Returns true if the resource is a problem type, false
3452: otherwise. (Looks at the extension on the src field; might need more
3453: to work correctly.)
3454:
3455: =item * B<is_page>:
3456:
3457: Returns true if the resource is a page.
3458:
3459: =item * B<is_sequence>:
3460:
3461: Returns true if the resource is a sequence.
3462:
3463: =back
3464:
3465: =cut
3466:
3467: sub hasResource {
3468: my $self = shift;
3469: return $self->{NAV_MAP}->hasResource(@_);
3470: }
3471:
3472: sub retrieveResources {
3473: my $self = shift;
3474: return $self->{NAV_MAP}->retrieveResources(@_);
3475: }
3476:
3477: sub is_exam {
3478: my ($self,$part) = @_;
3479: if ($self->parmval('type',$part) eq 'exam') {
3480: return 1;
3481: }
3482: if ($self->src() =~ /\.(exam)$/) {
3483: return 1;
3484: }
3485: return 0;
3486: }
3487: sub is_html {
3488: my $self=shift;
3489: my $src = $self->src();
3490: return ($src =~ /html$/);
3491: }
3492: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3493: sub is_page {
3494: my $self=shift;
3495: my $src = $self->src();
3496: return $self->navHash("is_map_", 1) &&
3497: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
3498: }
3499: sub is_practice {
3500: my $self=shift;
3501: my ($part) = @_;
3502: if ($self->parmval('type',$part) eq 'practice') {
3503: return 1;
3504: }
3505: return 0;
3506: }
3507: sub is_problem {
3508: my $self=shift;
3509: my $src = $self->src();
3510: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3511: return !($self->is_practice());
3512: }
3513: return 0;
3514: }
3515: sub contains_problem {
3516: my $self=shift;
3517: if ($self->is_page()) {
3518: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3519: return $hasProblem;
3520: }
3521: return 0;
3522: }
3523: sub is_sequence {
3524: my $self=shift;
3525: return $self->navHash("is_map_", 1) &&
3526: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
3527: }
3528: sub is_survey {
3529: my $self = shift();
3530: my $part = shift();
3531: if ($self->parmval('type',$part) eq 'survey') {
3532: return 1;
3533: }
3534: if ($self->src() =~ /\.(survey)$/) {
3535: return 1;
3536: }
3537: return 0;
3538: }
3539: sub is_task {
3540: my $self=shift;
3541: my $src = $self->src();
3542: return ($src =~ /\.(task)$/)
3543: }
3544:
3545: sub is_empty_sequence {
3546: my $self=shift;
3547: my $src = $self->src();
3548: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3549: }
3550:
3551: # Private method: Shells out to the parmval in the nav map, handler parts.
3552: sub parmval {
3553: my $self = shift;
3554: my $what = shift;
3555: my $part = shift;
3556: if (!defined($part)) {
3557: $part = '0';
3558: }
3559: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3560: }
3561:
3562: =pod
3563:
3564: B<Map Methods>
3565:
3566: These methods are useful for getting information about the map
3567: properties of the resource, if the resource is a map (B<is_map>).
3568:
3569: =over 4
3570:
3571: =item * B<map_finish>:
3572:
3573: Returns a reference to a resource object corresponding to the finish
3574: resource of the map.
3575:
3576: =item * B<map_pc>:
3577:
3578: Returns the pc value of the map, which is the first number that
3579: appears in the resource ID of the resources in the map, and is the
3580: number that appears around the middle of the symbs of the resources in
3581: that map.
3582:
3583: =item * B<map_start>:
3584:
3585: Returns a reference to a resource object corresponding to the start
3586: resource of the map.
3587:
3588: =item * B<map_type>:
3589:
3590: Returns a string with the type of the map in it.
3591:
3592: =back
3593:
3594: =cut
3595:
3596: sub map_finish {
3597: my $self = shift;
3598: my $src = $self->src();
3599: $src = &Apache::lonnet::clutter($src);
3600: my $res = $self->navHash("map_finish_$src", 0);
3601: $res = $self->{NAV_MAP}->getById($res);
3602: return $res;
3603: }
3604: sub map_pc {
3605: my $self = shift;
3606: my $src = $self->src();
3607: return $self->navHash("map_pc_$src", 0);
3608: }
3609: sub map_start {
3610: my $self = shift;
3611: my $src = $self->src();
3612: $src = &Apache::lonnet::clutter($src);
3613: my $res = $self->navHash("map_start_$src", 0);
3614: $res = $self->{NAV_MAP}->getById($res);
3615: return $res;
3616: }
3617: sub map_type {
3618: my $self = shift;
3619: my $pc = $self->map_pc();
3620: return $self->navHash("map_type_$pc", 0);
3621: }
3622:
3623: #####
3624: # Property queries
3625: #####
3626:
3627: # These functions will be responsible for returning the CORRECT
3628: # VALUE for the parameter, no matter what. So while they may look
3629: # like direct calls to parmval, they can be more then that.
3630: # So, for instance, the duedate function should use the "duedatetype"
3631: # information, rather then the resource object user.
3632:
3633: =pod
3634:
3635: =head2 Resource Parameters
3636:
3637: In order to use the resource parameters correctly, the nav map must
3638: have been instantiated with genCourseAndUserOptions set to true, so
3639: the courseopt and useropt is read correctly. Then, you can call these
3640: functions to get the relevant parameters for the resource. Each
3641: function defaults to part "0", but can be directed to another part by
3642: passing the part as the parameter.
3643:
3644: These methods are responsible for getting the parameter correct, not
3645: merely reflecting the contents of the GDBM hashes. As we move towards
3646: dates relative to other dates, these methods should be updated to
3647: reflect that. (Then, anybody using these methods will not have to update
3648: their code.)
3649:
3650: =over 4
3651:
3652: =item * B<acc>:
3653:
3654: Get the Client IP/Name Access Control information.
3655:
3656: =item * B<answerdate>:
3657:
3658: Get the answer-reveal date for the problem.
3659:
3660: =item * B<awarded>:
3661:
3662: Gets the awarded value for the problem part. Requires genUserData set to
3663: true when the navmap object was created.
3664:
3665: =item * B<duedate>:
3666:
3667: Get the due date for the problem.
3668:
3669: =item * B<tries>:
3670:
3671: Get the number of tries the student has used on the problem.
3672:
3673: =item * B<maxtries>:
3674:
3675: Get the number of max tries allowed.
3676:
3677: =item * B<opendate>:
3678:
3679: Get the open date for the problem.
3680:
3681: =item * B<sig>:
3682:
3683: Get the significant figures setting.
3684:
3685: =item * B<tol>:
3686:
3687: Get the tolerance for the problem.
3688:
3689: =item * B<tries>:
3690:
3691: Get the number of tries the user has already used on the problem.
3692:
3693: =item * B<type>:
3694:
3695: Get the question type for the problem.
3696:
3697: =item * B<weight>:
3698:
3699: Get the weight for the problem.
3700:
3701: =back
3702:
3703: =cut
3704:
3705: sub acc {
3706: (my $self, my $part) = @_;
3707: return $self->parmval("acc", $part);
3708: }
3709: sub answerdate {
3710: (my $self, my $part) = @_;
3711: # Handle intervals
3712: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
3713: return $self->duedate($part) +
3714: $self->parmval("answerdate", $part);
3715: }
3716: return $self->parmval("answerdate", $part);
3717: }
3718: sub awarded {
3719: my $self = shift; my $part = shift;
3720: $self->{NAV_MAP}->get_user_data();
3721: if (!defined($part)) { $part = '0'; }
3722: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3723: }
3724: # this should work exactly like the copy in lonhomework.pm
3725: sub duedate {
3726: (my $self, my $part) = @_;
3727: my $date;
3728: my $interval=$self->parmval("interval", $part);
3729: my $due_date=$self->parmval("duedate", $part);
3730: if ($interval =~ /\d+/) {
3731: my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);
3732: if (defined($first_access)) {
3733: $interval = $first_access+$interval;
3734: $date = ($interval < $due_date)? $interval : $due_date;
3735: } else {
3736: $date = $due_date;
3737: }
3738: } else {
3739: $date = $due_date;
3740: }
3741: return $date;
3742: }
3743: sub handgrade {
3744: (my $self, my $part) = @_;
3745: return $self->parmval("handgrade", $part);
3746: }
3747: sub maxtries {
3748: (my $self, my $part) = @_;
3749: return $self->parmval("maxtries", $part);
3750: }
3751: sub opendate {
3752: (my $self, my $part) = @_;
3753: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
3754: return $self->duedate($part) -
3755: $self->parmval("opendate", $part);
3756: }
3757: return $self->parmval("opendate");
3758: }
3759: sub problemstatus {
3760: (my $self, my $part) = @_;
3761: return lc $self->parmval("problemstatus", $part);
3762: }
3763: sub sig {
3764: (my $self, my $part) = @_;
3765: return $self->parmval("sig", $part);
3766: }
3767: sub tol {
3768: (my $self, my $part) = @_;
3769: return $self->parmval("tol", $part);
3770: }
3771: sub tries {
3772: my $self = shift;
3773: my $tries = $self->queryRestoreHash('tries', shift);
3774: if (!defined($tries)) { return '0';}
3775: return $tries;
3776: }
3777: sub type {
3778: (my $self, my $part) = @_;
3779: return $self->parmval("type", $part);
3780: }
3781: sub weight {
3782: my $self = shift; my $part = shift;
3783: if (!defined($part)) { $part = '0'; }
3784: return &Apache::lonnet::EXT('resource.'.$part.'.weight',
3785: $self->symb(), $env{'user.domain'},
3786: $env{'user.name'},
3787: $env{'request.course.sec'});
3788: }
3789: sub part_display {
3790: my $self= shift(); my $partID = shift();
3791: if (! defined($partID)) { $partID = '0'; }
3792: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
3793: $self->symb);
3794: if (! defined($display) || $display eq '') {
3795: $display = $partID;
3796: }
3797: return $display;
3798: }
3799:
3800: # Multiple things need this
3801: sub getReturnHash {
3802: my $self = shift;
3803:
3804: if (!defined($self->{RETURN_HASH})) {
3805: my %tmpHash = &Apache::lonnet::restore($self->symb());
3806: $self->{RETURN_HASH} = \%tmpHash;
3807: }
3808: }
3809:
3810: ######
3811: # Status queries
3812: ######
3813:
3814: # These methods query the status of problems.
3815:
3816: # If we need to count parts, this function determines the number of
3817: # parts from the metadata. When called, it returns a reference to a list
3818: # of strings corresponding to the parts. (Thus, using it in a scalar context
3819: # tells you how many parts you have in the problem:
3820: # $partcount = scalar($resource->countParts());
3821: # Don't use $self->{PARTS} directly because you don't know if it's been
3822: # computed yet.
3823:
3824: =pod
3825:
3826: =head2 Resource misc
3827:
3828: Misc. functions for the resource.
3829:
3830: =over 4
3831:
3832: =item * B<hasDiscussion>:
3833:
3834: Returns a false value if there has been discussion since the user last
3835: logged in, true if there has. Always returns false if the discussion
3836: data was not extracted when the nav map was constructed.
3837:
3838: =item * B<last_post_time>:
3839:
3840: Returns a false value if there hasn't been discussion otherwise returns
3841: unix timestamp of last time a discussion posting (or edit) was made.
3842:
3843: =item * B<discussion_info>:
3844:
3845: optional argument is a filter (currently can be 'unread');
3846: returns in scalar context the count of the number of discussion postings.
3847:
3848: returns in list context both the count of postings and a hash ref
3849: containing information about the postings (subject, id, timestamp) in a hash.
3850:
3851: Default is to return counts for all postings. However if called with a second argument set to 'unread', will return information about only unread postings.
3852:
3853: =item * B<getFeedback>:
3854:
3855: Gets the feedback for the resource and returns the raw feedback string
3856: for the resource, or the null string if there is no feedback or the
3857: email data was not extracted when the nav map was constructed. Usually
3858: used like this:
3859:
3860: for (split(/\,/, $res->getFeedback())) {
3861: my $link = &escape($_);
3862: ...
3863:
3864: and use the link as appropriate.
3865:
3866: =cut
3867:
3868: sub hasDiscussion {
3869: my $self = shift;
3870: return $self->{NAV_MAP}->hasDiscussion($self->symb());
3871: }
3872:
3873: sub last_post_time {
3874: my $self = shift;
3875: return $self->{NAV_MAP}->last_post_time($self->symb());
3876: }
3877:
3878: sub discussion_info {
3879: my ($self,$filter) = @_;
3880: return $self->{NAV_MAP}->discussion_info($self->symb(),$filter);
3881: }
3882:
3883: sub getFeedback {
3884: my $self = shift;
3885: my $source = $self->src();
3886: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3887: return $self->{NAV_MAP}->getFeedback($source);
3888: }
3889:
3890: sub getErrors {
3891: my $self = shift;
3892: my $source = $self->src();
3893: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3894: return $self->{NAV_MAP}->getErrors($source);
3895: }
3896:
3897: =pod
3898:
3899: =item * B<parts>():
3900:
3901: Returns a list reference containing sorted strings corresponding to
3902: each part of the problem. Single part problems have only a part '0'.
3903: Multipart problems do not return their part '0', since they typically
3904: do not really matter.
3905:
3906: =item * B<countParts>():
3907:
3908: Returns the number of parts of the problem a student can answer. Thus,
3909: for single part problems, returns 1. For multipart, it returns the
3910: number of parts in the problem, not including psuedo-part 0.
3911:
3912: =item * B<countResponses>():
3913:
3914: Returns the total number of responses in the problem a student can answer.
3915:
3916: =item * B<responseTypes>():
3917:
3918: Returns a hash whose keys are the response types. The values are the number
3919: of times each response type is used. This is for the I<entire> problem, not
3920: just a single part.
3921:
3922: =item * B<multipart>():
3923:
3924: Returns true if the problem is multipart, false otherwise. Use this instead
3925: of countParts if all you want is multipart/not multipart.
3926:
3927: =item * B<responseType>($part):
3928:
3929: Returns the response type of the part, without the word "response" on the
3930: end. Example return values: 'string', 'essay', 'numeric', etc.
3931:
3932: =item * B<responseIds>($part):
3933:
3934: Retreives the response IDs for the given part as an array reference containing
3935: strings naming the response IDs. This may be empty.
3936:
3937: =back
3938:
3939: =cut
3940:
3941: sub parts {
3942: my $self = shift;
3943:
3944: if ($self->ext) { return []; }
3945:
3946: $self->extractParts();
3947: return $self->{PARTS};
3948: }
3949:
3950: sub countParts {
3951: my $self = shift;
3952:
3953: my $parts = $self->parts();
3954:
3955: # If I left this here, then it's not necessary.
3956: #my $delta = 0;
3957: #for my $part (@$parts) {
3958: # if ($part eq '0') { $delta--; }
3959: #}
3960:
3961: if ($self->{RESOURCE_ERROR}) {
3962: return 0;
3963: }
3964:
3965: return scalar(@{$parts}); # + $delta;
3966: }
3967:
3968: sub countResponses {
3969: my $self = shift;
3970: my $count;
3971: foreach my $part (@{$self->parts()}) {
3972: $count+= scalar($self->responseIds($part));
3973: }
3974: return $count;
3975: }
3976:
3977: sub responseTypes {
3978: my $self = shift;
3979: my %responses;
3980: foreach my $part (@{$self->parts()}) {
3981: foreach my $responsetype ($self->responseType($part)) {
3982: $responses{$responsetype}++ if (defined($responsetype));
3983: }
3984: }
3985: return %responses;
3986: }
3987:
3988: sub multipart {
3989: my $self = shift;
3990: return $self->countParts() > 1;
3991: }
3992:
3993: sub singlepart {
3994: my $self = shift;
3995: return $self->countParts() == 1;
3996: }
3997:
3998: sub responseType {
3999: my $self = shift;
4000: my $part = shift;
4001:
4002: $self->extractParts();
4003: if (defined($self->{RESPONSE_TYPES}->{$part})) {
4004: return @{$self->{RESPONSE_TYPES}->{$part}};
4005: } else {
4006: return undef;
4007: }
4008: }
4009:
4010: sub responseIds {
4011: my $self = shift;
4012: my $part = shift;
4013:
4014: $self->extractParts();
4015: if (defined($self->{RESPONSE_IDS}->{$part})) {
4016: return @{$self->{RESPONSE_IDS}->{$part}};
4017: } else {
4018: return undef;
4019: }
4020: }
4021:
4022: # Private function: Extracts the parts information, both part names and
4023: # part types, and saves it.
4024: sub extractParts {
4025: my $self = shift;
4026:
4027: return if (defined($self->{PARTS}));
4028: return if ($self->ext);
4029:
4030: $self->{PARTS} = [];
4031:
4032: my %parts;
4033:
4034: # Retrieve part count, if this is a problem
4035: if ($self->is_problem()) {
4036: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
4037: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
4038:
4039: if ($partorder) {
4040: my @parts;
4041: for my $part (split (/,/,$partorder)) {
4042: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4043: push @parts, $part;
4044: $parts{$part} = 1;
4045: }
4046: }
4047: $self->{PARTS} = \@parts;
4048: } else {
4049: if (!$metadata) {
4050: $self->{RESOURCE_ERROR} = 1;
4051: $self->{PARTS} = [];
4052: $self->{PART_TYPE} = {};
4053: return;
4054: }
4055: foreach (split(/\,/,$metadata)) {
4056: if ($_ =~ /^(?:part|Task)_(.*)$/) {
4057: my $part = $1;
4058: # This floods the logs if it blows up
4059: if (defined($parts{$part})) {
4060: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
4061: }
4062:
4063: # check to see if part is turned off.
4064:
4065: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4066: $parts{$part} = 1;
4067: }
4068: }
4069: }
4070: my @sortedParts = sort keys %parts;
4071: $self->{PARTS} = \@sortedParts;
4072: }
4073:
4074:
4075: # These hashes probably do not need names that end with "Hash"....
4076: my %responseIdHash;
4077: my %responseTypeHash;
4078:
4079:
4080: # Init the responseIdHash
4081: foreach (@{$self->{PARTS}}) {
4082: $responseIdHash{$_} = [];
4083: }
4084:
4085: # Now, the unfortunate thing about this is that parts, part name, and
4086: # response id are delimited by underscores, but both the part
4087: # name and response id can themselves have underscores in them.
4088: # So we have to use our knowlege of part names to figure out
4089: # where the part names begin and end, and even then, it is possible
4090: # to construct ambiguous situations.
4091: foreach my $data (split /,/, $metadata) {
4092: if ($data =~ /^([a-zA-Z]+)response_(.*)/
4093: || $data =~ /^(Task)_(.*)/) {
4094: my $responseType = $1;
4095: my $partStuff = $2;
4096: my $partIdSoFar = '';
4097: my @partChunks = split /_/, $partStuff;
4098: my $i = 0;
4099: for ($i = 0; $i < scalar(@partChunks); $i++) {
4100: if ($partIdSoFar) { $partIdSoFar .= '_'; }
4101: $partIdSoFar .= $partChunks[$i];
4102: if ($parts{$partIdSoFar}) {
4103: my @otherChunks = @partChunks[$i+1..$#partChunks];
4104: my $responseId = join('_', @otherChunks);
4105: if ($self->is_task()) {
4106: push(@{$responseIdHash{$partIdSoFar}},
4107: $partIdSoFar);
4108: } else {
4109: push(@{$responseIdHash{$partIdSoFar}},
4110: $responseId);
4111: }
4112: push(@{$responseTypeHash{$partIdSoFar}},
4113: $responseType);
4114: }
4115: }
4116: }
4117: }
4118: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
4119: #
4120: # Reorder the arrays in the %responseIdHash and %responseTypeHash
4121: if ($resorder) {
4122: my @resorder=split(/,/,$resorder);
4123: foreach my $part (keys(%responseIdHash)) {
4124: my $i=0;
4125: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
4126: my @neworder;
4127: foreach my $possibleid (@resorder) {
4128: if (exists($resids{$possibleid})) {
4129: push(@neworder,$resids{$possibleid});
4130: }
4131: }
4132: my @ids;
4133: my @type;
4134: foreach my $element (@neworder) {
4135: push (@ids,$responseIdHash{$part}->[$element]);
4136: push (@type,$responseTypeHash{$part}->[$element]);
4137: }
4138: $responseIdHash{$part}=\@ids;
4139: $responseTypeHash{$part}=\@type;
4140: }
4141: }
4142: $self->{RESPONSE_IDS} = \%responseIdHash;
4143: $self->{RESPONSE_TYPES} = \%responseTypeHash;
4144: }
4145:
4146: return;
4147: }
4148:
4149: =pod
4150:
4151: =head2 Resource Status
4152:
4153: Problem resources have status information, reflecting their various
4154: dates and completion statuses.
4155:
4156: There are two aspects to the status: the date-related information and
4157: the completion information.
4158:
4159: Idiomatic usage of these two methods would probably look something
4160: like
4161:
4162: foreach ($resource->parts()) {
4163: my $dateStatus = $resource->getDateStatus($_);
4164: my $completionStatus = $resource->getCompletionStatus($_);
4165:
4166: or
4167:
4168: my $status = $resource->status($_);
4169:
4170: ... use it here ...
4171: }
4172:
4173: Which you use depends on exactly what you are looking for. The
4174: status() function has been optimized for the nav maps display and may
4175: not precisely match what you need elsewhere.
4176:
4177: The symbolic constants shown below can be accessed through the
4178: resource object: C<$res->OPEN>.
4179:
4180: =over 4
4181:
4182: =item * B<getDateStatus>($part):
4183:
4184: ($part defaults to 0). A convenience function that returns a symbolic
4185: constant telling you about the date status of the part. The possible
4186: return values are:
4187:
4188: =back
4189:
4190: B<Date Codes>
4191:
4192: =over 4
4193:
4194: =item * B<OPEN_LATER>:
4195:
4196: The problem will be opened later.
4197:
4198: =item * B<OPEN>:
4199:
4200: Open and not yet due.
4201:
4202:
4203: =item * B<PAST_DUE_ANSWER_LATER>:
4204:
4205: The due date has passed, but the answer date has not yet arrived.
4206:
4207: =item * B<PAST_DUE_NO_ANSWER>:
4208:
4209: The due date has passed and there is no answer opening date set.
4210:
4211: =item * B<ANSWER_OPEN>:
4212:
4213: The answer date is here.
4214:
4215: =item * B<NETWORK_FAILURE>:
4216:
4217: The information is unknown due to network failure.
4218:
4219: =back
4220:
4221: =cut
4222:
4223: # Apparently the compiler optimizes these into constants automatically
4224: sub OPEN_LATER { return 0; }
4225: sub OPEN { return 1; }
4226: sub PAST_DUE_NO_ANSWER { return 2; }
4227: sub PAST_DUE_ANSWER_LATER { return 3; }
4228: sub ANSWER_OPEN { return 4; }
4229: sub NOTHING_SET { return 5; }
4230: sub NETWORK_FAILURE { return 100; }
4231:
4232: # getDateStatus gets the date status for a given problem part.
4233: # Because answer date, due date, and open date are fully independent
4234: # (i.e., it is perfectly possible to *only* have an answer date),
4235: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
4236: # (past, future, none given). This function handles this with a decision
4237: # tree. Read the comments to follow the decision tree.
4238:
4239: sub getDateStatus {
4240: my $self = shift;
4241: my $part = shift;
4242: $part = "0" if (!defined($part));
4243:
4244: # Always return network failure if there was one.
4245: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4246:
4247: my $now = time();
4248:
4249: my $open = $self->opendate($part);
4250: my $due = $self->duedate($part);
4251: my $answer = $self->answerdate($part);
4252:
4253: if (!$open && !$due && !$answer) {
4254: # no data on the problem at all
4255: # should this be the same as "open later"? think multipart.
4256: return $self->NOTHING_SET;
4257: }
4258: if (!$open || $now < $open) {return $self->OPEN_LATER}
4259: if (!$due || $now < $due) {return $self->OPEN}
4260: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
4261: if ($answer) { return $self->ANSWER_OPEN; }
4262: return PAST_DUE_NO_ANSWER;
4263: }
4264:
4265: =pod
4266:
4267: B<>
4268:
4269: =over 4
4270:
4271: =item * B<getCompletionStatus>($part):
4272:
4273: ($part defaults to 0.) A convenience function that returns a symbolic
4274: constant telling you about the completion status of the part, with the
4275: following possible results:
4276:
4277: =back
4278:
4279: B<Completion Codes>
4280:
4281: =over 4
4282:
4283: =item * B<NOT_ATTEMPTED>:
4284:
4285: Has not been attempted at all.
4286:
4287: =item * B<INCORRECT>:
4288:
4289: Attempted, but wrong by student.
4290:
4291: =item * B<INCORRECT_BY_OVERRIDE>:
4292:
4293: Attempted, but wrong by instructor override.
4294:
4295: =item * B<CORRECT>:
4296:
4297: Correct or correct by instructor.
4298:
4299: =item * B<CORRECT_BY_OVERRIDE>:
4300:
4301: Correct by instructor override.
4302:
4303: =item * B<EXCUSED>:
4304:
4305: Excused. Not yet implemented.
4306:
4307: =item * B<NETWORK_FAILURE>:
4308:
4309: Information not available due to network failure.
4310:
4311: =item * B<ATTEMPTED>:
4312:
4313: Attempted, and not yet graded.
4314:
4315: =back
4316:
4317: =cut
4318:
4319: sub NOT_ATTEMPTED { return 10; }
4320: sub INCORRECT { return 11; }
4321: sub INCORRECT_BY_OVERRIDE { return 12; }
4322: sub CORRECT { return 13; }
4323: sub CORRECT_BY_OVERRIDE { return 14; }
4324: sub EXCUSED { return 15; }
4325: sub ATTEMPTED { return 16; }
4326:
4327: sub getCompletionStatus {
4328: my $self = shift;
4329: my $part = shift;
4330: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4331:
4332: my $status = $self->queryRestoreHash('solved', $part);
4333:
4334: # Left as separate if statements in case we ever do more with this
4335: if ($status eq 'correct_by_student') {return $self->CORRECT;}
4336: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
4337: if ($status eq 'correct_by_override') {
4338: return $self->CORRECT_BY_OVERRIDE;
4339: }
4340: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
4341: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
4342: if ($status eq 'excused') {return $self->EXCUSED; }
4343: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
4344: return $self->NOT_ATTEMPTED;
4345: }
4346:
4347: sub queryRestoreHash {
4348: my $self = shift;
4349: my $hashentry = shift;
4350: my $part = shift;
4351: $part = "0" if (!defined($part) || $part eq '');
4352: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4353:
4354: $self->getReturnHash();
4355:
4356: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
4357: }
4358:
4359: =pod
4360:
4361: B<Composite Status>
4362:
4363: Along with directly returning the date or completion status, the
4364: resource object includes a convenience function B<status>() that will
4365: combine the two status tidbits into one composite status that can
4366: represent the status of the resource as a whole. This method represents
4367: the concept of the thing we want to display to the user on the nav maps
4368: screen, which is a combination of completion and open status. The precise logic is
4369: documented in the comments of the status method. The following results
4370: may be returned, all available as methods on the resource object
4371: ($res->NETWORK_FAILURE): In addition to the return values that match
4372: the date or completion status, this function can return "ANSWER_SUBMITTED"
4373: if that problemstatus parameter value is set to No, suppressing the
4374: incorrect/correct feedback.
4375:
4376: =over 4
4377:
4378: =item * B<NETWORK_FAILURE>:
4379:
4380: The network has failed and the information is not available.
4381:
4382: =item * B<NOTHING_SET>:
4383:
4384: No dates have been set for this problem (part) at all. (Because only
4385: certain parts of a multi-part problem may be assigned, this can not be
4386: collapsed into "open later", as we do not know a given part will EVER
4387: be opened. For single part, this is the same as "OPEN_LATER".)
4388:
4389: =item * B<CORRECT>:
4390:
4391: For any reason at all, the part is considered correct.
4392:
4393: =item * B<EXCUSED>:
4394:
4395: For any reason at all, the problem is excused.
4396:
4397: =item * B<PAST_DUE_NO_ANSWER>:
4398:
4399: The problem is past due, not considered correct, and no answer date is
4400: set.
4401:
4402: =item * B<PAST_DUE_ANSWER_LATER>:
4403:
4404: The problem is past due, not considered correct, and an answer date in
4405: the future is set.
4406:
4407: =item * B<ANSWER_OPEN>:
4408:
4409: The problem is past due, not correct, and the answer is now available.
4410:
4411: =item * B<OPEN_LATER>:
4412:
4413: The problem is not yet open.
4414:
4415: =item * B<TRIES_LEFT>:
4416:
4417: The problem is open, has been tried, is not correct, but there are
4418: tries left.
4419:
4420: =item * B<INCORRECT>:
4421:
4422: The problem is open, and all tries have been used without getting the
4423: correct answer.
4424:
4425: =item * B<OPEN>:
4426:
4427: The item is open and not yet tried.
4428:
4429: =item * B<ATTEMPTED>:
4430:
4431: The problem has been attempted.
4432:
4433: =item * B<ANSWER_SUBMITTED>:
4434:
4435: An answer has been submitted, but the student should not see it.
4436:
4437: =back
4438:
4439: =cut
4440:
4441: sub TRIES_LEFT { return 20; }
4442: sub ANSWER_SUBMITTED { return 21; }
4443: sub PARTIALLY_CORRECT{ return 22; }
4444:
4445: sub status {
4446: my $self = shift;
4447: my $part = shift;
4448: if (!defined($part)) { $part = "0"; }
4449: my $completionStatus = $self->getCompletionStatus($part);
4450: my $dateStatus = $self->getDateStatus($part);
4451:
4452: # What we have is a two-dimensional matrix with 4 entries on one
4453: # dimension and 5 entries on the other, which we want to colorize,
4454: # plus network failure and "no date data at all".
4455:
4456: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
4457: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
4458:
4459: my $suppressFeedback = $self->problemstatus($part) eq 'no';
4460: # If there's an answer date and we're past it, don't
4461: # suppress the feedback; student should know
4462: if ($self->duedate($part) && $self->duedate($part) < time() &&
4463: $self->answerdate($part) && $self->answerdate($part) < time()) {
4464: $suppressFeedback = 0;
4465: }
4466:
4467: # There are a few whole rows we can dispose of:
4468: if ($completionStatus == CORRECT ||
4469: $completionStatus == CORRECT_BY_OVERRIDE ) {
4470: if ( $suppressFeedback ) { return ANSWER_SUBMITTED }
4471: my $awarded=$self->awarded($part);
4472: if ($awarded < 1 && $awarded > 0) {
4473: return PARTIALLY_CORRECT;
4474: } elsif ($awarded<1) {
4475: return INCORRECT;
4476: }
4477: return CORRECT;
4478: }
4479:
4480: # If it's WRONG... and not open
4481: if ( ($completionStatus == INCORRECT ||
4482: $completionStatus == INCORRECT_BY_OVERRIDE)
4483: && (!$self->opendate($part) || $self->opendate($part) > time()) ) {
4484: return INCORRECT;
4485: }
4486:
4487: if ($completionStatus == ATTEMPTED) {
4488: return ATTEMPTED;
4489: }
4490:
4491: # If it's EXCUSED, then return that no matter what
4492: if ($completionStatus == EXCUSED) {
4493: return EXCUSED;
4494: }
4495:
4496: if ($dateStatus == NOTHING_SET) {
4497: return NOTHING_SET;
4498: }
4499:
4500: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
4501: # by 4 matrix (date statuses).
4502:
4503: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
4504: $dateStatus == PAST_DUE_NO_ANSWER ) {
4505: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
4506: }
4507:
4508: if ($dateStatus == ANSWER_OPEN) {
4509: return ANSWER_OPEN;
4510: }
4511:
4512: # Now: (incorrect, incorrect_override, not_attempted) x
4513: # (open_later), (open)
4514:
4515: if ($dateStatus == OPEN_LATER) {
4516: return OPEN_LATER;
4517: }
4518:
4519: # If it's WRONG...
4520: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
4521: # and there are TRIES LEFT:
4522: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
4523: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
4524: }
4525: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
4526: }
4527:
4528: # Otherwise, it's untried and open
4529: return OPEN;
4530: }
4531:
4532: sub CLOSED { return 23; }
4533: sub ERROR { return 24; }
4534:
4535: =pod
4536:
4537: B<Simple Status>
4538:
4539: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4540: "Simple status" corresponds to "which icon is shown on the
4541: Navmaps". There are six "simple" statuses:
4542:
4543: =over 4
4544:
4545: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4546:
4547: =item * B<OPEN>: The problem is open and unattempted.
4548:
4549: =item * B<CORRECT>: The problem is correct for any reason.
4550:
4551: =item * B<INCORRECT>: The problem is incorrect and can still be
4552: completed successfully.
4553:
4554: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4555: does not know if they are correct. (The ellipsis icon.)
4556:
4557: =item * B<ERROR>: There is an error retrieving information about this
4558: problem.
4559:
4560: =back
4561:
4562: =cut
4563:
4564: # This hash maps the composite status to this simple status, and
4565: # can be used directly, if you like
4566: my %compositeToSimple =
4567: (
4568: NETWORK_FAILURE() => ERROR,
4569: NOTHING_SET() => CLOSED,
4570: CORRECT() => CORRECT,
4571: PARTIALLY_CORRECT() => PARTIALLY_CORRECT,
4572: EXCUSED() => CORRECT,
4573: PAST_DUE_NO_ANSWER() => INCORRECT,
4574: PAST_DUE_ANSWER_LATER() => INCORRECT,
4575: ANSWER_OPEN() => INCORRECT,
4576: OPEN_LATER() => CLOSED,
4577: TRIES_LEFT() => OPEN,
4578: INCORRECT() => INCORRECT,
4579: OPEN() => OPEN,
4580: ATTEMPTED() => ATTEMPTED,
4581: ANSWER_SUBMITTED() => ATTEMPTED
4582: );
4583:
4584: sub simpleStatus {
4585: my $self = shift;
4586: my $part = shift;
4587: my $status = $self->status($part);
4588: return $compositeToSimple{$status};
4589: }
4590:
4591: =pod
4592:
4593: B<simpleStatusCount> will return an array reference containing, in
4594: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4595: and ERROR parts the given problem has.
4596:
4597: =cut
4598:
4599: # This maps the status to the slot we want to increment
4600: my %statusToSlotMap =
4601: (
4602: OPEN() => 0,
4603: CLOSED() => 1,
4604: CORRECT() => 2,
4605: INCORRECT() => 3,
4606: ATTEMPTED() => 4,
4607: ERROR() => 5
4608: );
4609:
4610: sub statusToSlot { return $statusToSlotMap{shift()}; }
4611:
4612: sub simpleStatusCount {
4613: my $self = shift;
4614:
4615: my @counts = (0, 0, 0, 0, 0, 0, 0);
4616: foreach my $part (@{$self->parts()}) {
4617: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4618: }
4619:
4620: return \@counts;
4621: }
4622:
4623: =pod
4624:
4625: B<Completable>
4626:
4627: The completable method represents the concept of I<whether the student can
4628: currently do the problem>. If the student can do the problem, which means
4629: that it is open, there are tries left, and if the problem is manually graded
4630: or the grade is suppressed via problemstatus, the student has not tried it
4631: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4632: either the student has tried it and there is no feedback, or that for
4633: some reason it is no longer completable (not open yet, successfully completed,
4634: out of tries, etc.). As an example, this is used as the filter for the
4635: "Uncompleted Homework" option for the nav maps.
4636:
4637: If this does not quite meet your needs, do not fiddle with it (unless you are
4638: fixing it to better match the student's conception of "completable" because
4639: it's broken somehow)... make a new method.
4640:
4641: =cut
4642:
4643: sub completable {
4644: my $self = shift;
4645: if (!$self->is_problem()) { return 0; }
4646: my $partCount = $self->countParts();
4647:
4648: foreach my $part (@{$self->parts()}) {
4649: if ($part eq '0' && $partCount != 1) { next; }
4650: my $status = $self->status($part);
4651: # "If any of the parts are open, or have tries left (implies open),
4652: # and it is not "attempted" (manually graded problem), it is
4653: # not "complete"
4654: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4655: $status == ANSWER_SUBMITTED() ) {
4656: # did this part already, as well as we can
4657: next;
4658: }
4659: if ($status == OPEN() || $status == TRIES_LEFT()) {
4660: return 1;
4661: }
4662: }
4663:
4664: # If all the parts were complete, so was this problem.
4665: return 0;
4666: }
4667:
4668: =pod
4669:
4670: =head2 Resource/Nav Map Navigation
4671:
4672: =over 4
4673:
4674: =item * B<getNext>():
4675:
4676: Retreive an array of the possible next resources after this
4677: one. Always returns an array, even in the one- or zero-element case.
4678:
4679: =item * B<getPrevious>():
4680:
4681: Retreive an array of the possible previous resources from this
4682: one. Always returns an array, even in the one- or zero-element case.
4683:
4684: =cut
4685:
4686: sub getNext {
4687: my $self = shift;
4688: my @branches;
4689: my $to = $self->to();
4690: foreach my $branch ( split(/,/, $to) ) {
4691: my $choice = $self->{NAV_MAP}->getById($branch);
4692: #if (!$choice->condition()) { next; }
4693: my $next = $choice->goesto();
4694: $next = $self->{NAV_MAP}->getById($next);
4695:
4696: push @branches, $next;
4697: }
4698: return \@branches;
4699: }
4700:
4701: sub getPrevious {
4702: my $self = shift;
4703: my @branches;
4704: my $from = $self->from();
4705: foreach my $branch ( split /,/, $from) {
4706: my $choice = $self->{NAV_MAP}->getById($branch);
4707: my $prev = $choice->comesfrom();
4708: $prev = $self->{NAV_MAP}->getById($prev);
4709:
4710: push @branches, $prev;
4711: }
4712: return \@branches;
4713: }
4714:
4715: sub browsePriv {
4716: my $self = shift;
4717: if (defined($self->{BROWSE_PRIV})) {
4718: return $self->{BROWSE_PRIV};
4719: }
4720:
4721: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
4722: $self->symb());
4723: }
4724:
4725: =pod
4726:
4727: =back
4728:
4729: =cut
4730:
4731: 1;
4732:
4733: __END__
4734:
4735:
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