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