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