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