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