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