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