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