1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
4: # $Id: lonnavmaps.pm,v 1.56 2002/09/30 16:45:01 bowersj2 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: # (Page Handler
29: #
30: # (TeX Content Handler
31: #
32: # 05/29/00,05/30 Gerd Kortemeyer)
33: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
34: # 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
35: #
36: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
37: # YEAR=2002
38: # 1/1 Gerd Kortemeyer
39: #
40:
41: package Apache::lonnavmaps;
42:
43: use strict;
44: use Apache::Constants qw(:common :http);
45: use Apache::lonnet();
46: use Apache::loncommon();
47: use HTML::TokeParser;
48: use GDBM_File;
49:
50: # -------------------------------------------------------------- Module Globals
51: my %hash;
52: my @rows;
53:
54: #
55: # These cache hashes need to be independent of user, resource and course
56: # (user and course can/should be in the keys)
57: #
58:
59: my %courserdatas;
60: my %userrdatas;
61:
62: #
63: # These global hashes are dependent on user, course and resource,
64: # and need to be initialized every time when a sheet is calculated
65: #
66: my %courseopt;
67: my %useropt;
68: my %parmhash;
69:
70: # This parameter keeps track of whether obtaining the user's information
71: # failed, which the colorizer in astatus can use
72: my $networkFailedFlag = 0;
73:
74: # ------------------------------------------------------------------ Euclid gcd
75:
76: sub euclid {
77: my ($e,$f)=@_;
78: my $a; my $b; my $r;
79: if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
80: while ($r!=0) {
81: $a=$b; $b=$r;
82: $r=$a%$b;
83: }
84: return $b;
85: }
86:
87: # --------------------------------------------------------------------- Parmval
88:
89: # -------------------------------------------- Figure out a cascading parameter
90: #
91: # For this function to work
92: #
93: # * parmhash needs to be tied
94: # * courseopt and useropt need to be initialized for this user and course
95: #
96:
97: sub parmval {
98: my ($what,$symb)=@_;
99: my $cid=$ENV{'request.course.id'};
100: my $csec=$ENV{'request.course.sec'};
101: my $uname=$ENV{'user.name'};
102: my $udom=$ENV{'user.domain'};
103:
104: unless ($symb) { return ''; }
105: my $result='';
106:
107: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
108:
109: # ----------------------------------------------------- Cascading lookup scheme
110: my $rwhat=$what;
111: $what=~s/^parameter\_//;
112: $what=~s/\_/\./;
113:
114: my $symbparm=$symb.'.'.$what;
115: my $mapparm=$mapname.'___(all).'.$what;
116: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
117:
118: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
119: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
120: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
121:
122: my $courselevel= $usercourseprefix.'.'.$what;
123: my $courselevelr=$usercourseprefix.'.'.$symbparm;
124: my $courselevelm=$usercourseprefix.'.'.$mapparm;
125:
126: # ---------------------------------------------------------- first, check user
127: if ($uname) {
128: if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }
129: if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }
130: if ($useropt{$courselevel}) { return $useropt{$courselevel}; }
131: }
132:
133: # ------------------------------------------------------- second, check course
134: if ($csec) {
135: if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }
136: if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }
137: if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }
138: }
139:
140: if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }
141: if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }
142: if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }
143:
144: # ----------------------------------------------------- third, check map parms
145:
146: my $thisparm=$parmhash{$symbparm};
147: if ($thisparm) { return $thisparm; }
148:
149: # ----------------------------------------------------- fourth , check default
150:
151: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
152: if ($default) { return $default}
153:
154: # --------------------------------------------------- fifth , cascade up parts
155:
156: my ($space,@qualifier)=split(/\./,$rwhat);
157: my $qualifier=join('.',@qualifier);
158: unless ($space eq '0') {
159: my ($part,$id)=split(/\_/,$space);
160: if ($id) {
161: my $partgeneral=&parmval($part.".$qualifier",$symb);
162: if ($partgeneral) { return $partgeneral; }
163: } else {
164: my $resourcegeneral=&parmval("0.$qualifier",$symb);
165: if ($resourcegeneral) { return $resourcegeneral; }
166: }
167: }
168: return '';
169: }
170:
171:
172:
173: # ------------------------------------------------------------- Find out status
174: # return codes
175: # tcode (timecode)
176: # 1: will open later
177: # 2: is open and not past due yet
178: # 3: is past due date
179: # 4: due in the next 24 hours
180: #
181: # code (curent solved status)
182: # 1: not attempted
183: # 2: attempted but wrong, or incorrect by instructor
184: # 3: solved or correct by instructor
185: # 4: partially correct (one or more parts correct)
186: # "excused" needs to be supported, but is not yet.
187: sub astatus {
188: my $rid=shift;
189: my $code=0;
190: my $ctext='';
191: $rid=~/(\d+)\.(\d+)/;
192: my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
193: &Apache::lonnet::declutter($hash{'src_'.$rid});
194: my %duedate=();
195: my %opendate=();
196: my %answerdate=();
197: # need to always check part 0's open/due/answer status
198: foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) {
199: if ($_=~/^parameter\_(.*)\_opendate$/) {
200: my $part=$1;
201: $duedate{$part}=&parmval($part.'.duedate',$symb);
202: $opendate{$part}=&parmval($part.'.opendate',$symb);
203: $answerdate{$part}=&parmval($part.'.answerdate',$symb);
204: if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') {
205: $opendate{$part}=$duedate{$part}-$opendate{$part};
206: }
207: if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') {
208: $answerdate{$part}=$duedate{$part}+$answerdate{$part};
209: }
210: }
211: }
212: my $now=time;
213: my $tcode=0;
214:
215: my %returnhash=&Apache::lonnet::restore($symb);
216:
217: foreach (sort(keys(%opendate))) {
218: my $duedate=$duedate{$_};
219: my $opendate=$opendate{$_};
220: my $answerdate=$answerdate{$_};
221: my $preface='';
222: unless ($_ eq '0') { $preface=' Part: '.$_.' '; }
223: if ($opendate) {
224: if ($now<$duedate || (!$duedate)) {
225: unless ($tcode==4) { $tcode=2; }
226: if ($duedate) {
227: $ctext.=$preface.'Due: '.localtime($duedate);
228: } else {
229: $ctext.=$preface.'No Due Date';
230: }
231: if ($now<$opendate) {
232: unless ($tcode) { $tcode=1; }
233: $ctext.=$preface.'Open: '.localtime($opendate);
234: }
235: if ($duedate && $duedate-$now<86400) {
236: $tcode=4;
237: $ctext.=$preface.'Due: '.localtime($duedate);
238: }
239: } else {
240: unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; }
241: if ($now<$answerdate) {
242: $ctext.='Answer: '.localtime($duedate);
243: }
244: }
245: } else {
246: unless (($tcode==2) || ($tcode==4)) { $tcode=1; }
247: }
248:
249: my $status=$returnhash{'resource.'.$_.'.solved'};
250:
251: if ($status eq 'correct_by_student') {
252: if ($code==0||$code==3) { $code=3; } else { $code=4; }
253: $ctext.=' solved';
254: } elsif ($status eq 'correct_by_override') {
255: if ($code==0||$code==3) { $code=3; } else { $code=4; }
256: $ctext.=' override';
257: } elsif ($status eq 'incorrect_attempted') {
258: if ($code!=4 && $code!=3) { $code=2; }
259: if ($code==3) { $code=4; }
260: $ctext.=' ('.
261: ($returnhash{'resource.'.$_.'.tries'}?
262: $returnhash{'resource.'.$_.'.tries'}:'0');
263: my $numtries = &parmval($_.'.maxtries',$symb);
264: if ($numtries) { $ctext.='/'.$numtries.' tries'; }
265: $ctext.=')';
266: } elsif ($status eq 'incorrect_by_override') {
267: if ($code!=4 && $code!=3) { $code=2; }
268: if ($code==3) { $code=4; }
269: $ctext.=' override';
270: } elsif ($status eq 'excused') {
271: if ($code==0||$code==3) { $code=3; } else { $code=4; }
272: $ctext.=' excused';
273: } else {
274: if ($code==0) { $code=1; }
275: }
276: }
277:
278: return 'p'.$code.$tcode.'"'.$ctext.'"';
279: }
280:
281:
282: sub addresource {
283: my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;
284: if ($showtypes eq 'problems') {
285: if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {
286: return;
287: }
288: }
289: my $brepriv=&Apache::lonnet::allowed('bre',$resource);
290: if ($hash{'src_'.$rid}) {
291: if (($brepriv eq '2') || ($brepriv eq 'F')) {
292: my $pprefix='';
293: if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) {
294: $pprefix=&astatus($rid);
295: }
296: $$sofar++;
297: if ($indent) { $pprefix='i'.$indent.','.$pprefix; }
298: if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; }
299: if (defined($rows[$$sofar])) {
300: $rows[$$sofar].='&'.$pprefix.$rid;
301: } else {
302: $rows[$$sofar]=$pprefix.$rid;
303: }
304: }
305: }
306: }
307:
308: sub followlinks () {
309: my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_;
310: my $mincond=1;
311: my $next='';
312: foreach (split(/\,/,$hash{'to_'.$rid})) {
313: my $thiscond=
314: &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
315: if ($thiscond>=$mincond) {
316: if ($next) {
317: $next.=','.$_.':'.$thiscond;
318: } else {
319: $next=$_.':'.$thiscond;
320: }
321: if ($thiscond>$mincond) { $mincond=$thiscond; }
322: }
323: }
324: my $col=0;
325: &Apache::lonxml::debug("following links -$next-");
326: foreach (split(/\,/,$next)) {
327: my ($nextlinkid,$condval)=split(/\:/,$_);
328: if ($condval>=$mincond) {
329: my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid},
330: $beenhere,$showtypes,$indent,$linkid);
331: if ($now>$further) {
332: if ($col>0) {
333: my $string;
334: for(my $i=0;$i<$col;$i++) { $string.='&'; }
335: for(my $i=$further+1;$now-1>$i;$i++) {
336: $rows[$i]=$string.$rows[$i];
337: }
338: }
339: $further=$now;
340: }
341: }
342: $col++;
343: }
344: return $further;
345: }
346: # ------------------------------------------------------------ Build page table
347:
348: sub tracetable {
349: my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_;
350: my $newshowtypes=$showtypes;
351: my $further=$sofar;
352: # $Apache::lonxml::debug=1;
353: &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid});
354: if ($beenhere=~/\&$rid\&/) { return $further; }
355: $beenhere.=$rid.'&';
356:
357: if (defined($hash{'is_map_'.$rid})) {
358: $sofar++;
359: my $tprefix='';
360: if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
361: eq 'sequence') {
362: $tprefix='h';
363: } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
364: eq 'page') {
365: $tprefix='j';
366: if ($indent) { $tprefix='i'.$indent.','.$tprefix; }
367: if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; }
368: $newshowtypes='problems';
369: $indent++;
370: #if in a .page continue to link the encompising .page
371: if (!$linkid) { $linkid=$rid; }
372: }
373: if (defined($rows[$sofar])) {
374: $rows[$sofar].='&'.$tprefix.$rid;
375: } else {
376: $rows[$sofar]=$tprefix.$rid;
377: }
378: if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
379: (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
380: my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
381: $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
382: '&'.$frid.'&',$newshowtypes,$indent,$linkid);
383: &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes,
384: $indent,$linkid);
385: if ($tprefix =~ /j$/) { $indent--; $linkid=''; }
386: }
387: } else {
388: &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,
389: $indent,$linkid);
390: }
391:
392: if (defined($hash{'to_'.$rid})) {
393: $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,
394: $indent,$linkid);
395: }
396:
397: return $further;
398: }
399:
400: # ================================================================ Main Handler
401:
402: sub handler {
403: my $r=shift;
404:
405: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
406:
407: if ($ENV{'form.jtest'} ne "1")
408: {
409: return new_handle($r);
410: }
411:
412: # ------------------------------------------- Set document type for header only
413:
414: if ($r->header_only) {
415: if ($ENV{'browser.mathml'}) {
416: $r->content_type('text/xml');
417: } else {
418: $r->content_type('text/html');
419: }
420: $r->send_http_header;
421: return OK;
422: }
423: my $requrl=$r->uri;
424: my $hashtied;
425: # ----------------------------------------------------------------- Tie db file
426: my $fn;
427: if ($ENV{'request.course.fn'}) {
428: $fn=$ENV{'request.course.fn'};
429: if (-e "$fn.db") {
430: if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) &&
431: (tie(%parmhash,'GDBM_File',
432: $ENV{'request.course.fn'}.'_parms.db',
433: &GDBM_READER(),0640))) {
434: $hashtied=1;
435: }
436: }
437: }
438: if (!$hashtied) {
439: $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
440: return HTTP_NOT_ACCEPTABLE;
441: }
442:
443: # ------------------------------------------------------------------- Hash tied
444:
445: if ($ENV{'browser.mathml'}) {
446: $r->content_type('text/xml');
447: } else {
448: $r->content_type('text/html');
449: }
450: &Apache::loncommon::no_cache($r);
451: $r->send_http_header;
452:
453: my $firstres=$hash{'map_start_'.
454: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
455: my $lastres=$hash{'map_finish_'.
456: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
457: if (!(($firstres) && ($lastres))) {
458: $r->print('<html><body>Coursemap undefined.</body></html>');
459: } else {
460:
461: # ----------------------------------------------------------------- Render page
462: # -------------------------------------------------------------- Set parameters
463:
464:
465: # ---------------------------- initialize coursedata and userdata for this user
466: undef %courseopt;
467: undef %useropt;
468:
469: my $uname=$ENV{'user.name'};
470: my $udom=$ENV{'user.domain'};
471: my $uhome=$ENV{'user.home'};
472: my $cid=$ENV{'request.course.id'};
473: my $chome=$ENV{'course.'.$cid.'.home'};
474: my ($cdom,$cnum)=split(/\_/,$cid);
475:
476: my $userprefix=$uname.'_'.$udom.'_';
477:
478: unless ($uhome eq 'no_host') {
479: # ------------------------------------------------- Get coursedata (if present)
480: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
481: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
482: ':resourcedata',$chome);
483: if ($reply!~/^error\:/) {
484: $courserdatas{$cid}=$reply;
485: $courserdatas{$cid.'.last_cache'}=time;
486: }
487: # check to see if network failed
488: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
489: {
490: $networkFailedFlag = 1;
491: }
492: }
493: foreach (split(/\&/,$courserdatas{$cid})) {
494: my ($name,$value)=split(/\=/,$_);
495: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
496: &Apache::lonnet::unescape($value);
497: }
498: # --------------------------------------------------- Get userdata (if present)
499: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
500: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
501: if ($reply!~/^error\:/) {
502: $userrdatas{$uname.'___'.$udom}=$reply;
503: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
504: }
505: }
506: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
507: my ($name,$value)=split(/\=/,$_);
508: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
509: &Apache::lonnet::unescape($value);
510: }
511: }
512:
513: @rows=();
514:
515: &tracetable(0,$firstres,'&','',0);
516:
517: # ------------------------------------------------------------------ Page parms
518:
519: my $j;
520: my $i;
521: my $lcm=1;
522: my $contents=0;
523:
524: # ---------------------------------------------- Go through table to get layout
525:
526: for ($i=0;$i<=$#rows;$i++) {
527: if ($rows[$i]) {
528: &Apache::lonxml::debug("Row $i is:".$rows[$i]);
529: $contents++;
530: my @colcont=split(/\&/,$rows[$i]);
531: $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
532: }
533: }
534:
535:
536: unless ($contents) {
537: $r->print('<html><body>Empty Map.</body></html>');
538: } else {
539:
540: # ------------------------------------------------------------------ Build page
541:
542: my $currenturl=$ENV{'form.postdata'};
543: $currenturl=~s/^http\:\/\///;
544: $currenturl=~s/^[^\/]+//;
545:
546: # ---------------------------------------------------------------- Send headers
547:
548: my $date=localtime;
549: my $now=time;
550: # ----------------------------------------- Get email status and discussiontime
551:
552: my %emailstatus=&Apache::lonnet::dump('email_status');
553: my $logouttime=$emailstatus{'logout'};
554: my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}};
555: my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime);
556:
557: my %discussiontimes=&Apache::lonnet::dump('discussiontimes',
558: $cdom,$cnum);
559:
560: my %feedback=();
561: my %error=();
562: foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'.
563: $ENV{'user.domain'}.':'.
564: $ENV{'user.name'}.':nohist_email',
565: $ENV{'user.home'}))) {
566: $msgid=&Apache::lonnet::unescape($msgid);
567: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
568: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
569: my ($what,$url)=($1,$2);
570: my %status=
571: &Apache::lonnet::get('email_status',[$msgid]);
572: if ($status{$msgid}=~/^error\:/) {
573: $status{$msgid}='';
574: }
575:
576: if (($status{$msgid} eq 'new') ||
577: (!$status{$msgid})) {
578: if ($what eq 'Error') {
579: $error{$url}.=','.$msgid;
580: } else {
581: $feedback{$url}.=','.$msgid;
582: }
583: }
584: }
585: }
586: # ----------------------------------------------------------- Start Page Output
587: my $bodytagadd='';
588: $r->print(
589: '<html><head><title>Navigate Course Map</title></head>');
590: if (($currenturl=~/^\/res/) &&
591: ($currenturl!~/^\/res\/adm/)) {
592: $bodytagadd='onLoad="window.location.hash='."'curloc'".'"';
593: }
594: $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
595: $bodytagadd));
596: $r->print('<script>window.focus();</script>');
597: my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
598: if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
599: $r->print("<h3>$date</h3>\n");
600: $r->rflush();
601: $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
602: localtime($lastcheck).
603: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
604: if (($currenturl=~/^\/res/) &&
605: ($currenturl!~/^\/res\/adm/)) {
606: $r->print('<a href="#curloc">Current Location</a><p>');
607: }
608:
609: # Handle a network error
610:
611: if ($networkFailedFlag)
612: {
613: $r->print('<H2>LON-CAPA network failure.</H2>'."\n");
614: $r->print("<p>LON-CAPA's network is having difficulties, some problem" .
615: " information, such as due dates, will not be available.");
616: }
617: # ----------------------------------------------------- The little content list
618: for ($i=0;$i<=$#rows;$i++) {
619: if ($rows[$i]) {
620: my @colcont=split(/\&/,$rows[$i]);
621: my $avespan=$lcm/($#colcont+1);
622: for ($j=0;$j<=$#colcont;$j++) {
623: my $rid=$colcont[$j];
624: if ($rid=~/^h(.+)/) {
625: $rid=$1;
626: $r->print(' <a href="#'.
627: $rid.'">'.$hash{'title_'.$rid}.
628: '</a><br>');
629: }
630: }
631: }
632: }
633: # ----------------------------------------------------------------- Start table
634: $r->print('<hr><table cols="'.$lcm.'" border="0">');
635: for ($i=0;$i<=$#rows;$i++) {
636: if ($rows[$i]) {
637: $r->print("\n<tr>");
638: my @colcont=split(/\&/,$rows[$i]);
639: my $avespan=$lcm/($#colcont+1);
640:
641: # for each item I wish to print on this row...
642: for ($j=0;$j<=$#colcont;$j++) {
643: my $indent;my $indentstr;
644: my $linkid;
645: my $rid=$colcont[$j];
646: $rid=~/(\d+)\.(\d+)$/;
647: my $src=
648: &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
649: my $symb=
650: &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src;
651: my $add='<td>';
652: my $adde='</td>';
653: my $hwk='<font color="#223322">';
654: my $hwke='</font>';
655: if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; }
656: if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; }
657: if ($rid=~/^h(.+)/) {
658: $rid=$1;
659: $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">';
660: $adde='</th>';
661: if (($ENV{'user.adv'}) &&
662: ($parmhash{$symb.'.0.parameter_randompick'})) {
663: $adde=' (randomly select '.
664: $parmhash{$symb.'.0.parameter_randompick'}.
665: ')</th>';
666: }
667: }
668: if ($rid=~/^j(.+)/) { $rid=$1; }
669: if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {
670: # sub astatus describes what code/tcode mean
671: my $code=$1;
672: my $tcode=$2;
673: my $ctext=$3;
674: $rid=$4;
675:
676: # will open later
677: if ($tcode eq '1') {
678: $add='<td bgcolor="#AAAAAA">';
679: }
680:
681: # solved/correct
682: if ($code eq '3') {
683: $add='<td bgcolor="#AAFFAA">';
684: } elsif ($code eq '4') { # partially correct
685: $add='<td bgcolor="#E0FFAA">';
686: } else {
687: # not attempted
688:
689: # we end up here on network failure, so pick a neutral
690: # color if the network failed instead of bright red.
691: if ( $networkFailedFlag )
692: {
693: $add = '<td bgcolor="#AAAAAA">';
694: }
695: else
696: {
697: $add='<td bgcolor="#FFAAAA">';
698: }
699:
700: if ($tcode eq '2') { # open, not past due
701: $add='<td bgcolor="#FFFFAA">';
702: }
703:
704: if ($tcode eq '4') { # due in next 24 hours
705: $add='<td bgcolor="#FFFF33">';
706: $adde='</td>';
707: }
708: }
709: $hwk='<font color="#888811"><b>';
710: $hwke='</b></font>';
711: if ($code eq '1') {
712: $hwke='</b> ('.$ctext.')</font>';
713: }
714: if ($code eq '2' || $code eq '4') {
715: $hwk='<font color="#992222"><b>';
716: $hwke='</b> ('.$ctext.')</font>';
717: }
718: if ($code eq '3') {
719: $hwk='<font color="#229922"><b>';
720: $hwke='</b> ('.$ctext.')</font>';
721: }
722: if ($networkFailedFlag)
723: {
724: $hwke='</b> (status unavailable)</font>';
725: }
726: }
727: if ($rid && $hash{'src_'.$rid} eq $currenturl) {
728: $add=$add.'<a name="curloc"></a>'.
729: '<font color=red size=+2><b>> </b></font>';
730: $adde=
731: '<font color=red size=+2><b> <</b></font>'.$adde;
732: }
733: if ($discussiontimes{$symb}>$lastcheck) {
734: $adde=
735: '<img border=0 src="/adm/lonMisc/chat.gif">'.
736: $adde;
737: }
738: if ($error{$src}) {
739: foreach (split(/\,/,$error{$src})) {
740: if ($_) {
741: $adde=
742: ' <a href="/adm/email?display='.
743: &Apache::lonnet::escape($_).
744: '"><img src="/adm/lonMisc/bomb.gif" border=0></a>'
745: .$adde;
746: }
747: }
748: }
749: if ($feedback{$src}) {
750: foreach (split(/\,/,$feedback{$src})) {
751: if ($_) {
752: $adde=
753: ' <a href="/adm/email?display='.
754: &Apache::lonnet::escape($_).
755: '"><img src="/adm/lonMisc/feedback.gif" border=0></a>'
756: .$adde;
757: }
758: }
759: }
760: if ($indent) {
761: my $is=" ";
762: for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; }
763: }
764: if (!$linkid) { $linkid=$rid; }
765: if ($hash{'randomout_'.$rid}) {
766: $adde=' <i>(hidden)</i>'.$adde;
767: }
768: $r->print($add.$indentstr);
769: if ($rid) {
770: $r->print('<a href="'.$hash{'src_'.$linkid}.
771: (($hash{'src_'.$linkid}=~/\?/)?'&':'?').
772: 'symb='.&Apache::lonnet::escape($symb)
773: .'">'.
774: $hwk.$hash{'title_'.$rid}.$hwke.'</a>');
775: }
776: $r->print($adde);
777: }
778: $r->print('</tr>');
779: }
780: }
781: $r->print("\n</table>");
782: $r->print('</body></html>');
783: # -------------------------------------------------------------------- End page
784: }
785: # ------------------------------------------------------------- End render page
786: }
787: # ------------------------------------------------------------------ Untie hash
788: unless (untie(%hash)) {
789: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
790: "Could not untie coursemap $fn (browse).</font>");
791: }
792: unless (untie(%parmhash)) {
793: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
794: "Could not untie parmhash (browse).</font>");
795: }
796: return OK;
797: }
798:
799: sub new_handle {
800: my $r = shift;
801:
802: # Handle header-only request
803: if ($r->header_only) {
804: if ($ENV{'browser.mathml'}) {
805: $r->content_type('text/xml');
806: } else {
807: $r->content_type('text/html');
808: }
809: $r->send_http_header;
810: return OK;
811: }
812:
813: # Send header, don't cache this page
814: if ($ENV{'browser.mathml'}) {
815: $r->content_type('text/xml');
816: } else {
817: $r->content_type('text/html');
818: }
819: &Apache::loncommon::no_cache($r);
820: $r->send_http_header;
821:
822: # Header
823: $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
824: ''));
825: # Initialize the nav map
826: my $navmap = Apache::lonnavmaps::navmap->new(
827: $ENV{"request.course.fn"}.".db",
828: $ENV{"request.course.fn"}."_parms.db", 1);
829:
830:
831: if (!defined($navmap)) {
832: my $requrl = $r->uri;
833: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
834: return HTTP_NOT_ACCEPTABLE;
835: }
836:
837: # Check that it's defined
838: if (!($navmap->courseMapDefined())) {
839: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
840: '</body></html>');
841: return OK;
842: }
843:
844: # Grab a resource object so we have access to the constants; this
845: # is technically not proper, but should be harmless
846: my $res = $navmap->firstResource();
847:
848: # Defines a status->color mapping, null string means don't color
849: my %colormap =
850: ( $res->NETWORK_FAILURE => '',
851: $res->CORRECT => '#BBFFBB',
852: $res->EXCUSED => '#BBBBFF',
853: $res->PAST_DUE_ANSWER_LATER => '#FFAA00',
854: $res->PAST_DUE_NO_ANSWER => '#FFAA00',
855: $res->ANSWER_OPEN => '#FF00AA',
856: $res->OPEN_LATER => '',
857: $res->TRIES_LEFT => '#FFFF00',
858: $res->INCORRECT => '#FFAA00',
859: $res->OPEN => '#FFFF88',
860: $res->NOTHING_SET => '' );
861:
862: my %filterHash;
863: # Figure out what we're not displaying
864: foreach (split(/\,/, $ENV{"form.filter"})) {
865: if ($_) {
866: $filterHash{$_} = "1";
867: }
868: }
869:
870: # Begin the HTML table
871: # two columns: the title/icon on the left, the info on the right
872: $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
873:
874: my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);
875: my $curRes = $mapIterator->next();
876: undef $res; # so we don't accidentally use it later
877: my $indentLevel = -1;
878: my $indentString = " ";
879:
880: my $isNewBranch = 0;
881:
882: while ($curRes != $mapIterator->END_NAV_MAP) {
883: if ($curRes == $mapIterator->BEGIN_MAP() ||
884: $curRes == $mapIterator->BEGIN_BRANCH()) {
885: $indentLevel++;
886: }
887: if ($curRes == $mapIterator->END_MAP() ||
888: $curRes == $mapIterator->END_BRANCH()) {
889: $indentLevel--;
890: }
891: if ($curRes == $mapIterator->BEGIN_BRANCH()) {
892: $isNewBranch = 1;
893: }
894:
895: if (ref($curRes) && $curRes->src()) {
896:
897: my @parts;
898: if ($curRes->is_problem()) {
899: @parts = @{$curRes->parts()};
900: if (scalar(@parts) > 1) { shift(@parts); }
901: } else {
902: @parts[0] = "0"; # this is to get past foreach loop below
903: # you can consider a non-problem resource as a resource
904: # with only one part without loss
905: }
906:
907: foreach my $part (@parts) {
908:
909: # For each thing we're displaying...
910:
911: my $stack = $mapIterator->getStack();
912: my $src = getLinkForResource($stack);
913:
914: my $srcHasQuestion = $src =~ /\?/;
915: my $link = $src.
916: ($srcHasQuestion?'&':'?') .
917: 'symb='.&Apache::lonnet::escape($curRes->symb()).
918: '"';
919: my $title = $curRes->title();
920: my $partLabel = "";
921: my $newBranchText = "";
922:
923: # If this is a new branch, label it so
924: # (temporary, this should be an icon w/ alt text)
925: if ($isNewBranch) {
926: $newBranchText = "NB -> ";
927: $isNewBranch = 0;
928: }
929:
930: # links to open and close the folders
931: my $linkopen = "<a href=\"$link\">";
932: my $linkclose = "</a>";
933:
934: my $icon = "html.gif";
935: if ($curRes->is_problem()) {
936: $icon = "problem.gif";
937: }
938:
939: # Display the correct icon, link to open or shut map
940: if ($curRes->is_map()) {
941: my $mapId = $curRes->map_pc();
942: my $nowOpen = !defined($filterHash{$mapId});
943: $icon = $nowOpen ?
944: "folder_opened.gif" : "folder_closed.gif";
945: $linkopen = "<a href=\"/adm/navmaps?filter=";
946: $linkopen .= $nowOpen ?
947: addToFilter(\%filterHash, $mapId) :
948: removeFromFilter(\%filterHash, $mapId);
949: $linkopen .= "\">";
950: $linkclose = "</a>";
951:
952: }
953:
954: my $colorizer = "";
955: if ($curRes->is_problem()) {
956: my $status = $curRes->status($part);
957: my $color = $colormap{$status};
958: if ($color ne "") {
959: $colorizer = "bgcolor=\"$color\"";
960: }
961: }
962:
963: $r->print(" <tr><td align=\"left\" valign=\"top\">\n");
964:
965: # print indentation
966: for (my $i = 0; $i < $indentLevel; $i++) {
967: $r->print($indentString);
968: }
969:
970: $r->print(" ${newBranchText}${linkopen}<img border=\"0\" src=\"" .
971: "/adm/lonIcons/$icon\" alt=\"\">${linkclose}\n");
972:
973: if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }
974:
975: $r->print(" <a href=\"$link\">$title$partLabel</a></td>".
976: "<td $colorizer align=\"right\">\n");
977:
978: if ($curRes->kind() eq "res" and
979: $curRes->is_problem() ) {
980: $r->print (getDescription($curRes, $part));
981: }
982: }
983: }
984: $curRes = $mapIterator->next();
985: }
986:
987: $r->print("</table></body></html>");
988:
989: return OK;
990: }
991:
992: # Convenience functions: Returns a string that adds or subtracts
993: # the second argument from the first hash, appropriate for the
994: # query string that determines which folders to recurse on
995: sub addToFilter {
996: my $hashIn = shift;
997: my $addition = shift;
998: my %hash = %$hashIn;
999: $hash{$addition} = 1;
1000:
1001: return join (",", keys(%hash));
1002: }
1003:
1004: sub removeFromFilter {
1005: my $hashIn = shift;
1006: my $subtraction = shift;
1007: my %hash = %$hashIn;
1008:
1009: delete $hash{$subtraction};
1010: return join(",", keys(%hash));
1011: }
1012:
1013: # Convenience function: Given a stack returned from getStack on the iterator,
1014: # return the correct src() value.
1015: # Later, this should add an anchor when we start putting anchors in pages.
1016: sub getLinkForResource {
1017: my $stack = shift;
1018: my $res;
1019:
1020: # Check to see if there are any pages in the stack
1021: foreach $res (@$stack) {
1022: if (defined($res) && $res->is_page()) {
1023: return $res->src();
1024: }
1025: }
1026:
1027: # Failing that, return the src of the last resource that is defined
1028: # (when we first recurse on a map, it puts an undefined resource
1029: # on the bottom because $self->{HERE} isn't defined yet, and we
1030: # want the src for the map anyhow)
1031: foreach (@$stack) {
1032: if (defined($_)) { $res = $_; }
1033: }
1034:
1035: return $res->src();
1036: }
1037:
1038: # Convenience function: This seperates the logic of how to create
1039: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
1040: # etc.) into a seperate function. It takes a resource object as the
1041: # first parameter, and the part number of the resource as the second.
1042: # It's basically a big switch statement on the status of the resource.
1043:
1044: sub getDescription {
1045: my $res = shift;
1046: my $part = shift;
1047: my $status = $res->getDateStatus();
1048:
1049: if ($status == $res->NETWORK_FAILURE) { return ""; }
1050: if ($status == $res->NOTHING_SET) {
1051: return "Not currently assigned.";
1052: }
1053: if ($status == $res->OPEN_LATER) {
1054: return "Opens: " . timeToHumanString($res->opendate($part));
1055: }
1056: if ($status == $res->OPEN) {
1057: return "Due: $status " . timeToHumanString($res->duedate($part));
1058: }
1059: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1060: return "Answer: " . timeToHumanString($res->answerdate($part));
1061: }
1062: if ($status == $res->PAST_DUE_NO_ANSWER) {
1063: return "Was Due: " . timeToHumanString($res->duedate($part));
1064: }
1065: if ($status == $res->ANSWER_OPEN) {
1066: return "Answer available";
1067: }
1068: }
1069:
1070: # I want to change this into something more human-friendly. For
1071: # now, this is a simple call to localtime. The final function
1072: # probably belongs in loncommon.
1073: sub timeToHumanString {
1074: return localtime(shift);
1075: }
1076:
1077: 1;
1078:
1079: package Apache::lonnavmaps::navmap;
1080:
1081: # LEFT:
1082: # * Actual handler code (multi-part)
1083: # * Branches (aieee!) (and conditionals)
1084:
1085: =pod
1086:
1087: lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
1088:
1089: =head1 navmap object: Encapsulating the compiled nav map
1090:
1091: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
1092:
1093: Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.
1094:
1095: You must obtain resource objects through the navmap object.
1096:
1097: =head2 Methods
1098:
1099: =over 4
1100:
1101: =item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
1102:
1103: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
1104:
1105: =cut
1106:
1107: use strict;
1108: use GDBM_File;
1109:
1110: sub new {
1111: # magic invocation to create a class instance
1112: my $proto = shift;
1113: my $class = ref($proto) || $proto;
1114: my $self = {};
1115:
1116: $self->{NAV_HASH_FILE} = shift;
1117: $self->{PARM_HASH_FILE} = shift;
1118: $self->{GENERATE_COURSE_USER_OPT} = shift;
1119: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1120:
1121: # Resource cache stores navmapresource's as we reference them. We generate
1122: # them on-demand so we don't pay for creating resources unless we use them.
1123: $self->{RESOURCE_CACHE} = {};
1124:
1125: # Network failure flag, if we accessed the course or user opt and
1126: # failed
1127: $self->{NETWORK_FAILURE} = 0;
1128:
1129: # tie the nav hash
1130: my %navmaphash;
1131: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
1132: &GDBM_READER(), 0640))) {
1133: return undef;
1134: }
1135: $self->{NAV_HASH} = \%navmaphash;
1136:
1137: my %parmhash;
1138: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
1139: &GDBM_READER(), 0640)))
1140: {
1141: return undef;
1142: }
1143: $self->{PARM_HASH} = \%parmhash;
1144: $self->{HASH_TIED} = 1;
1145:
1146: # If the course opt hash and the user opt hash should be generated,
1147: # generate them
1148: if ($self->{GENERATE_COURSE_USER_OPT}) {
1149: my $uname=$ENV{'user.name'};
1150: my $udom=$ENV{'user.domain'};
1151: my $uhome=$ENV{'user.home'};
1152: my $cid=$ENV{'request.course.id'};
1153: my $chome=$ENV{'course.'.$cid.'.home'};
1154: my ($cdom,$cnum)=split(/\_/,$cid);
1155:
1156: my $userprefix=$uname.'_'.$udom.'_';
1157:
1158: my %courserdatas; my %useropt; my %courseopt;
1159: unless ($uhome eq 'no_host') {
1160: # ------------------------------------------------- Get coursedata (if present)
1161: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1162: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1163: ':resourcedata',$chome);
1164: if ($reply!~/^error\:/) {
1165: $courserdatas{$cid}=$reply;
1166: $courserdatas{$cid.'.last_cache'}=time;
1167: }
1168: # check to see if network failed
1169: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1170: {
1171: $self->{NETWORK_FAILURE} = 1;
1172: }
1173: }
1174: foreach (split(/\&/,$courserdatas{$cid})) {
1175: my ($name,$value)=split(/\=/,$_);
1176: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1177: &Apache::lonnet::unescape($value);
1178: }
1179: # --------------------------------------------------- Get userdata (if present)
1180: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1181: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1182: if ($reply!~/^error\:/) {
1183: $userrdatas{$uname.'___'.$udom}=$reply;
1184: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1185: }
1186: # check to see if network failed
1187: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1188: {
1189: $self->{NETWORK_FAILURE} = 1;
1190: }
1191: }
1192: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1193: my ($name,$value)=split(/\=/,$_);
1194: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1195: &Apache::lonnet::unescape($value);
1196: }
1197: $self->{COURSE_OPT} = \%courseopt;
1198: $self->{USER_OPT} = \%useropt;
1199: }
1200: }
1201:
1202: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
1203: my $cid=$ENV{'request.course.id'};
1204: my ($cdom,$cnum)=split(/\_/,$cid);
1205:
1206: my %emailstatus = &Apache::lonnet::dump('email_status');
1207: my $logoutTime = $emailstatus{'logout'};
1208: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1209: $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
1210: $courseLeaveTime : $logoutTime);
1211: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1212: $cdom, $cnum);
1213: my %feedback=();
1214: my %error=();
1215: my $keys = &Apache::lonnet::reply('keys:'.
1216: $ENV{'user.domain'}.':'.
1217: $ENV{'user.name'}.':nohist_email',
1218: $ENV{'user.home'});
1219:
1220: foreach my $msgid (split(/\&/, $keys)) {
1221: $msgid=&Apache::lonnet::unescape($msgid);
1222: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1223: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1224: my ($what,$url)=($1,$2);
1225: my %status=
1226: &Apache::lonnet::get('email_status',[$msgid]);
1227: if ($status{$msgid}=~/^error\:/) {
1228: $status{$msgid}='';
1229: }
1230:
1231: if (($status{$msgid} eq 'new') ||
1232: (!$status{$msgid})) {
1233: if ($what eq 'Error') {
1234: $error{$url}.=','.$msgid;
1235: } else {
1236: $feedback{$url}.=','.$msgid;
1237: }
1238: }
1239: }
1240: }
1241:
1242: $self->{FEEDBACK} = \%feedback;
1243: $self->{ERROR_MSG} = \%error; # what is this? JB
1244: $self->{DISCUSSION_TIME} = \%discussiontime;
1245: $self->{EMAIL_STATUS} = \%emailstatus;
1246:
1247: }
1248:
1249: bless($self);
1250:
1251: return $self;
1252: }
1253:
1254: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1255: sub courseMapDefined {
1256: my $self = shift;
1257: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1258:
1259: my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
1260: my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
1261: return $firstres && $lastres;
1262: }
1263:
1264: sub getIterator {
1265: my $self = shift;
1266: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1267: shift, shift);
1268: return $iterator;
1269: }
1270:
1271: # unties the hash when done
1272: sub untieHashes {
1273: my $self = shift;
1274: untie $self->{NAV_HASH} if ($self->{HASH_TIED});
1275: untie $self->{PARM_HASH} if ($self->{HASH_TIED});
1276: $self->{HASH_TIED} = 0;
1277: }
1278:
1279: # when the object is destroyed, be sure to untie all the hashes we tied.
1280: sub DESTROY {
1281: my $self = shift;
1282: $self->untieHashes();
1283: }
1284:
1285: =pod
1286:
1287: =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
1288:
1289: =cut
1290:
1291: # The strategy here is to cache the resource objects, and only construct them
1292: # as we use them. The real point is to prevent reading any more from the tied
1293: # hash then we have to, which should hopefully alleviate speed problems.
1294: # Caching is just an incidental detail I throw in because it makes sense.
1295:
1296: sub getById {
1297: my $self = shift;
1298: my $id = shift;
1299:
1300: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1301: {
1302: return $self->{RESOURCE_CACHE}->{$id};
1303: }
1304:
1305: # resource handles inserting itself into cache.
1306: return Apache::lonnavmaps::resource->new($self, $id);
1307: }
1308:
1309: =pod
1310:
1311: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1312:
1313: =cut
1314:
1315: sub firstResource {
1316: my $self = shift;
1317: my $firstResource = $self->{NAV_HASH}->{'map_start_' .
1318: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1319: return $self->getById($firstResource);
1320: }
1321:
1322: =pod
1323:
1324: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1325:
1326: =cut
1327:
1328: sub finishResource {
1329: my $self = shift;
1330: my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
1331: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1332: return $self->getById($firstResource);
1333: }
1334:
1335: # -------------------------------------------- Figure out a cascading parameter
1336: #
1337: # For this function to work
1338: #
1339: # * parmhash needs to be tied
1340: # * courseopt and useropt need to be initialized for this user and course
1341: #
1342:
1343: sub parmval {
1344: my $self = shift;
1345: my ($what,$symb)=@_;
1346: my $cid=$ENV{'request.course.id'};
1347: my $csec=$ENV{'request.course.sec'};
1348: my $uname=$ENV{'user.name'};
1349: my $udom=$ENV{'user.domain'};
1350:
1351: unless ($symb) { return ''; }
1352: my $result='';
1353:
1354: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1355:
1356: # ----------------------------------------------------- Cascading lookup scheme
1357: my $rwhat=$what;
1358: $what=~s/^parameter\_//;
1359: $what=~s/\_/\./;
1360:
1361: my $symbparm=$symb.'.'.$what;
1362: my $mapparm=$mapname.'___(all).'.$what;
1363: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1364:
1365: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1366: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1367: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1368:
1369: my $courselevel= $usercourseprefix.'.'.$what;
1370: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1371: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1372:
1373: my $useropt = $self->{USER_OPT};
1374: my $courseopt = $self->{COURSE_OPT};
1375: my $parmhash = $self->{PARM_HASH};
1376:
1377: # ---------------------------------------------------------- first, check user
1378: if ($uname and defined($useropt)) {
1379: if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; }
1380: if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; }
1381: if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; }
1382: }
1383:
1384: # ------------------------------------------------------- second, check course
1385: if ($csec and defined($courseopt)) {
1386: if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; }
1387: if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; }
1388: if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; }
1389: }
1390:
1391: if (defined($courseopt)) {
1392: if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; }
1393: if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; }
1394: if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; }
1395: }
1396:
1397: # ----------------------------------------------------- third, check map parms
1398:
1399: my $thisparm=$$parmhash{$symbparm};
1400: if ($thisparm) { return $thisparm; }
1401:
1402: # ----------------------------------------------------- fourth , check default
1403:
1404: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1405: if ($default) { return $default}
1406:
1407: # --------------------------------------------------- fifth , cascade up parts
1408:
1409: my ($space,@qualifier)=split(/\./,$rwhat);
1410: my $qualifier=join('.',@qualifier);
1411: unless ($space eq '0') {
1412: my ($part,$id)=split(/\_/,$space);
1413: if ($id) {
1414: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1415: if ($partgeneral) { return $partgeneral; }
1416: } else {
1417: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1418: if ($resourcegeneral) { return $resourcegeneral; }
1419: }
1420: }
1421: return '';
1422: }
1423:
1424:
1425: 1;
1426:
1427: package Apache::lonnavmaps::iterator;
1428:
1429: # This package must precede "navmap" because "navmap" uses it. In
1430: # order to keep the documentation order straight, the iterator is documented
1431: # after the navmap object.
1432:
1433: =pod
1434:
1435: =back
1436:
1437: =head1 navmap Iterator
1438:
1439: An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.
1440:
1441: To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:
1442:
1443: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1444:
1445: To get the next thing from the iterator, call B<next>:
1446:
1447: C<my $nextThing = $resourceIterator-E<gt>next()>
1448:
1449: getIterator behaves as follows:
1450:
1451: =over 4
1452:
1453: =item B<getIterator>(nav_map, firstResource, finishResource, filterHash): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). It is your responsibility to ensure that the iterator will actually get there. filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0.
1454:
1455: Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.
1456:
1457: The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
1458:
1459: =over 4
1460:
1461: =item * some list of tokens here
1462:
1463: =back
1464:
1465: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
1466:
1467: =cut
1468:
1469: # Here are the tokens for the iterator:
1470:
1471: sub END_NAV_MAP { return 0; } # Represents end of entire nav map
1472: sub BEGIN_MAP { return 1; } # begining of a new map
1473: sub END_MAP { return 2; } # end of the map
1474: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1475: sub END_BRANCH { return 4; } # end of a branch
1476:
1477: # Params: nav map, start resource, end resource, filter, condition,
1478: # already seen hash ref
1479:
1480: sub new {
1481: # magic invocation to create a class instance
1482: my $proto = shift;
1483: my $class = ref($proto) || $proto;
1484: my $self = {};
1485:
1486: $self->{NAV_MAP} = shift;
1487: return undef unless ($self->{NAV_MAP});
1488:
1489: # Handle the parameters
1490: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1491: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1492:
1493: # If the given resources are just the ID of the resource, get the
1494: # objects
1495: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1496: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1497: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1498: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1499:
1500: $self->{FILTER} = shift;
1501:
1502: # A hash, used as a set, of resource already seen
1503: $self->{ALREADY_SEEN} = shift;
1504: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1505:
1506: # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
1507: $self->{STARTED} = 0;
1508:
1509: # Should we continue calling the recursive iterator, if any?
1510: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1511: # The recursive iterator, if any
1512: $self->{RECURSIVE_ITERATOR} = undef;
1513: # Are we recursing on a map, or a branch?
1514: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
1515: # And the count of how deep it is, so that this iterator can keep track of
1516: # when to pick back up again.
1517: $self->{RECURSIVE_DEPTH} = 0;
1518:
1519: # For keeping track of our branches, we maintain our own stack
1520: $self->{BRANCH_STACK} = [];
1521: # If the size shrinks, we exhausted a branch
1522: $self->{BRANCH_STACK_SIZE} = 0;
1523: $self->{BRANCH_DEPTH} = 0;
1524:
1525: # For returning two things in a forced sequence
1526: $self->{FORCE_NEXT} = undef;
1527:
1528: # Start with the first resource
1529: push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
1530: $self->{BRANCH_STACK_SIZE} = 1;
1531:
1532: bless($self);
1533: return $self;
1534: }
1535:
1536: # Note... this function is *touchy*. I strongly recommend tracing
1537: # through it with the debugger a few times on a non-trivial map before
1538: # modifying it. Order is *everything*.
1539: sub next {
1540: my $self = shift;
1541:
1542: # Iterator logic goes here
1543:
1544: # Is this return value pre-determined?
1545: if (defined($self->{FORCE_NEXT})) {
1546: my $tmp = $self->{FORCE_NEXT};
1547: $self->{FORCE_NEXT} = undef;
1548: return $tmp;
1549: }
1550:
1551: # Are we using a recursive iterator? If so, pull from that and
1552: # watch the depth; we want to resume our level at the correct time.
1553: if ($self->{RECURSIVE_ITERATOR_FLAG})
1554: {
1555: # grab the next from the recursive iterator
1556: my $next = $self->{RECURSIVE_ITERATOR}->next();
1557:
1558: # is it a begin or end map? Update depth if so
1559: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1560: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1561:
1562: # Are we back at depth 0? If so, stop recursing.
1563: if ($self->{RECURSIVE_DEPTH} == 0) {
1564: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1565: }
1566:
1567: return $next;
1568: }
1569:
1570: # Is there a current resource to grab? If not, then return
1571: # END_BRANCH and END_MAP in succession.
1572: if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
1573: if ($self->{BRANCH_DEPTH} > 0) {
1574: $self->{FORCE_NEXT} = $self->END_MAP();
1575: $self->{BRANCH_DEPTH}--;
1576: return $self->END_BRANCH();
1577: } else {
1578: return $self->END_MAP();
1579: }
1580: }
1581:
1582: # Have we not yet begun? If not, return BEGIN_MAP and
1583: # remember that we've started.
1584: if ( !$self->{STARTED} ) {
1585: $self->{STARTED} = 1;
1586: return $self->BEGIN_MAP;
1587: }
1588:
1589: # Did the branch stack shrink since last run? If so,
1590: # we exhausted a branch last time, therefore, we're about
1591: # to start a new one. (We know because we already checked to see
1592: # if the stack was empty.)
1593: if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
1594: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1595: $self->{BRANCH_DEPTH}++;
1596: return $self->BEGIN_BRANCH();
1597: }
1598:
1599: # Remember the size for comparision next time.
1600: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1601:
1602: # If the next resource we mean to return is going to need
1603: # a lower branch level, terminate branches until we get
1604: # there.
1605:
1606: # Get the next resource in the branch
1607: $self->{HERE} = pop @{$self->{BRANCH_STACK}};
1608:
1609: # Are we at the right depth? If not, close a branch and return
1610: # the current resource onto the branch stack
1611: if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH})
1612: && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} <
1613: $self->{BRANCH_DEPTH} ) {
1614: $self->{BRANCH_DEPTH}--;
1615: # return it so we can pick it up eventually
1616: push @{$self->{BRANCH_STACK}}, $self->{HERE};
1617: return $self->END_BRANCH();
1618: }
1619:
1620: # We always return it after this point and never before
1621: # (proof: look at just the return statements), so we
1622: # remember that we've seen this.
1623: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
1624:
1625: # Are we at the utter end? If so, return the END_NAV_MAP marker.
1626: if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
1627: $self->{FORCE_NEXT} = $self->END_NAV_MAP;
1628: return $self->{HERE};
1629: }
1630:
1631: # Get the next possible resources
1632: my $nextUnfiltered = $self->{HERE}->getNext();
1633: my $next = [];
1634:
1635: # filter the next possibilities to remove things we've
1636: # already seen. Also, remember what branch depth they should
1637: # be displayed at, since there's no other reliable way to tell.
1638: foreach (@$nextUnfiltered) {
1639: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1640: push @$next, $_;
1641: $_->{DATA}->{ITERATOR_DEPTH} =
1642: $self->{BRANCH_DEPTH} + 1;
1643: }
1644: }
1645:
1646: # Handle branch cases:
1647: # Nothing is available next: BRANCH_END
1648: # 1 thing next: standard non-branch
1649: # 2+ things next: have some branches
1650: my $nextCount = scalar(@$next);
1651: if ($nextCount == 0) {
1652: # Return this and on the next run, close the branch up if we're
1653: # in a branch
1654: if ($self->{BRANCH_DEPTH} > 0 ) {
1655: $self->{FORCE_NEXT} = $self->END_BRANCH();
1656: $self->{BRANCH_DEPTH}--;
1657: }
1658: return $self->{HERE};
1659: }
1660:
1661: while (@$next) {
1662: # copy the next possibilities over to the branch stack
1663: # in the right order
1664: push @{$self->{BRANCH_STACK}}, shift @$next;
1665: }
1666:
1667: if ($nextCount >= 2) {
1668: $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
1669: $self->{BRANCH_DEPTH}++;
1670: return $self->{HERE};
1671: }
1672:
1673: # If this is a map and we want to recurse down it... (not filtered out)
1674: if ($self->{HERE}->is_map() &&
1675: !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) {
1676: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
1677: my $firstResource = $self->{HERE}->map_start();
1678: my $finishResource = $self->{HERE}->map_finish();
1679:
1680: # Odd perl syntax here; $self->new allows one to create a new iterator
1681: # can't figure out how to ref this package directly correctly
1682: # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
1683: $self->{RECURSIVE_ITERATOR} =
1684: Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
1685: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN});
1686: # prime the new iterator with the first resource
1687: #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource;
1688: }
1689:
1690: return $self->{HERE};
1691: }
1692:
1693: =pod
1694:
1695: The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).
1696:
1697: =cut
1698:
1699: sub getStack {
1700: my $self=shift;
1701:
1702: my @stack;
1703:
1704: $self->populateStack(\@stack);
1705:
1706: return \@stack;
1707: }
1708:
1709: # Private method: Calls the iterators recursively to populate the stack.
1710: sub populateStack {
1711: my $self=shift;
1712: my $stack = shift;
1713:
1714: push @$stack, $self->{HERE};
1715:
1716: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1717: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
1718: }
1719: }
1720:
1721: 1;
1722:
1723: package Apache::lonnavmaps::resource;
1724:
1725: use Apache::lonnet;
1726:
1727: =pod
1728:
1729: =head1 Object: resource
1730:
1731: A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.
1732:
1733: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
1734:
1735: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
1736:
1737: =head2 Public Members
1738:
1739: resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.
1740:
1741: =head2 Methods
1742:
1743: =over 4
1744:
1745: =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself.
1746:
1747: =cut
1748:
1749: sub new {
1750: # magic invocation to create a class instance
1751: my $proto = shift;
1752: my $class = ref($proto) || $proto;
1753: my $self = {};
1754:
1755: $self->{NAV_MAP} = shift;
1756: $self->{ID} = shift;
1757:
1758: # Store this new resource in the parent nav map's cache.
1759: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1760:
1761: # A hash that can be used by two-pass algorithms to store data
1762: # about this resource in. Not used by the resource object
1763: # directly.
1764: $self->{DATA} = {};
1765:
1766: bless($self);
1767:
1768: return $self;
1769: }
1770:
1771: =pod
1772:
1773: =item * B<is_map>: Returns true if this is a map, false otherwise.
1774:
1775: =item * B<title>: Returns title.
1776:
1777: =item * B<type>: Returns the type of the resource, "start", "normal", or "finish".
1778:
1779: =item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
1780:
1781: =back
1782:
1783: =cut
1784:
1785: # private function: simplify the NAV_HASH lookups we keep doing
1786: # pass the name, and to automatically append my ID, pass a true val on the
1787: # second param
1788: sub navHash {
1789: my $self = shift;
1790: my $param = shift;
1791: my $id = shift;
1792: return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
1793: }
1794:
1795: # These info functions can be used directly, as they don't return
1796: # resource information.
1797: sub title { my $self=shift; return $self->navHash("title_", 1); }
1798: sub type { my $self=shift; return $self->navHash("type_", 1); }
1799: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
1800: # "to" can return a comma seperated list for branches
1801: sub to { my $self=shift; return $self->navHash("to_", 1); }
1802: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1803: sub src {
1804: my $self=shift;
1805: return $self->navHash("src_", 1);
1806: }
1807: sub symb {
1808: my $self=shift;
1809: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
1810: my $symbSrc = &Apache::lonnet::declutter($self->src());
1811: return &Apache::lonnet::declutter(
1812: $self->navHash('map_id_'.$first))
1813: . '___' . $second . '___' . $symbSrc;
1814: }
1815: sub is_problem {
1816: my $self=shift;
1817: my $src = $self->src();
1818: return ($src =~ /problem$/);
1819: }
1820: sub is_html {
1821: my $self=shift;
1822: my $src = $self->src();
1823: return ($src =~ /html$/);
1824: }
1825: sub is_sequence {
1826: my $self=shift;
1827: my $src = $self->src();
1828: return ($src =~ /sequence$/);
1829: }
1830: sub is_page {
1831: my $self=shift;
1832: my $src = $self->src();
1833: return ($src =~ /page$/);
1834: }
1835:
1836:
1837:
1838:
1839: # Move this into POD: In order to use these correctly, courseopt
1840: # and useropt need to be generated
1841: sub parmval {
1842: my $self = shift;
1843: my $what = shift;
1844: my $part = shift || "0";
1845: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
1846: }
1847:
1848: #####
1849: # Map Queries
1850: #####
1851:
1852: # These methods relate to whether or not the resource is a map, and the
1853: # attributes of that map.
1854:
1855: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
1856: sub map_finish {
1857: my $self = shift;
1858: my $src = $self->src();
1859: my $res = $self->navHash("map_finish_$src", 0);
1860: $res = $self->{NAV_MAP}->getById($res);
1861: return $res;
1862: }
1863: sub map_start {
1864: my $self = shift;
1865: my $src = $self->src();
1866: my $res = $self->navHash("map_start_$src", 0);
1867: $res = $self->{NAV_MAP}->getById($res);
1868: return $res;
1869: }
1870: sub map_pc {
1871: my $self = shift;
1872: my $src = $self->src();
1873: return $self->navHash("map_pc_$src", 0);
1874: }
1875: sub map_type {
1876: my $self = shift;
1877: my $pc = $self->map_pc();
1878: return $self->navHash("map_type_$pc", 0);
1879: }
1880:
1881:
1882:
1883: #####
1884: # Property queries
1885: #####
1886:
1887: # These functions will be responsible for returning the CORRECT
1888: # VALUE for the parameter, no matter what. So while they may look
1889: # like direct calls to parmval, they can be more then that.
1890: # So, for instance, the duedate function should use the "duedatetype"
1891: # information, rather then the resource object user.
1892:
1893: =pod
1894:
1895: =head2 Resource Parameters
1896:
1897: In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter.
1898:
1899: These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
1900:
1901: =over 4
1902:
1903: =item * B<acc>: Get the Client IP/Name Access Control information.
1904:
1905: =item * B<answerdate>: Get the answer-reveal date for the problem.
1906:
1907: =item * B<duedate>: Get the due date for the problem.
1908:
1909: =item * B<tries>: Get the number of tries the student has used on the problem.
1910:
1911: =item * B<maxtries>: Get the number of max tries allowed.
1912:
1913: =item * B<opendate>: Get the open date for the problem.
1914:
1915: =item * B<sig>: Get the significant figures setting.
1916:
1917: =item * B<tol>: Get the tolerance for the problem.
1918:
1919: =item * B<type>: Get the question type for the problem.
1920:
1921: =item * B<weight>: Get the weight for the problem.
1922:
1923: =back
1924:
1925: =cut
1926:
1927: sub acc {
1928: (my $self, my $part) = @_;
1929: return $self->parmval("acc", $part);
1930: }
1931: sub answerdate {
1932: (my $self, my $part) = @_;
1933: # Handle intervals
1934: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
1935: return $self->duedate($part) +
1936: $self->parmval("answerdate", $part);
1937: }
1938: return $self->parmval("answerdate", $part);
1939: }
1940: sub duedate {
1941: (my $self, my $part) = @_;
1942: return $self->parmval("duedate", $part);
1943: }
1944: sub maxtries {
1945: (my $self, my $part) = @_;
1946: return $self->parmval("maxtries", $part);
1947: }
1948: sub opendate {
1949: (my $self, my $part) = @_;
1950: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
1951: return $self->duedate($part) -
1952: $self->parmval("opendate", $part);
1953: }
1954: return $self->parmval("opendate");
1955: }
1956: sub sig {
1957: (my $self, my $part) = @_;
1958: return $self->parmval("sig", $part);
1959: }
1960: sub tol {
1961: (my $self, my $part) = @_;
1962: return $self->parmval("tol", $part);
1963: }
1964: sub type {
1965: (my $self, my $part) = @_;
1966: return $self->parmval("type", $part);
1967: }
1968: sub weight {
1969: (my $self, my $part) = @_;
1970: return $self->parmval("weight", $part);
1971: }
1972: sub tries {
1973: my $self = shift;
1974: my $part = shift;
1975: $part = '0' if (!defined($part));
1976:
1977: # Make sure return hash is loaded, should error check
1978: $self->getReturnHash();
1979:
1980: my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
1981: if (!defined($tries)) {return '0';}
1982: return $tries;
1983: }
1984:
1985: # Multiple things need this
1986: sub getReturnHash {
1987: my $self = shift;
1988:
1989: if (!defined($self->{RETURN_HASH})) {
1990: my %tmpHash = &Apache::lonnet::restore($self->symb());
1991: $self->{RETURN_HASH} = \%tmpHash;
1992: }
1993: }
1994:
1995: ######
1996: # Status queries
1997: ######
1998:
1999: # These methods query the status of problems.
2000:
2001: # If we need to count parts, this function determines the number of
2002: # parts from the metadata. When called, it returns a reference to a list
2003: # of strings corresponding to the parts. (Thus, using it in a scalar context
2004: # tells you how many parts you have in the problem:
2005: # $partcount = scalar($resource->countParts());
2006: # Don't use $self->{PARTS} directly because you don't know if it's been
2007: # computed yet.
2008:
2009: =pod
2010:
2011: =head2 Resource misc
2012:
2013: Misc. functions for the resource.
2014:
2015: =over 4
2016:
2017: =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)
2018:
2019: =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.
2020:
2021: =back
2022:
2023: =cut
2024:
2025: sub parts {
2026: my $self = shift;
2027:
2028: $self->extractParts();
2029: return $self->{PARTS};
2030: }
2031:
2032: sub countParts {
2033: my $self = shift;
2034:
2035: my $parts = $self->parts();
2036:
2037: if (scalar(@{$parts}) == 1) { return 1;}
2038:
2039: return scalar(@{$parts}) - 1;
2040: }
2041:
2042: # Private function: Extracts the parts information and saves it
2043: sub extractParts {
2044: my $self = shift;
2045:
2046: return if ($self->{PARTS});
2047:
2048: $self->{PARTS} = [];
2049:
2050: # Retrieve part count
2051: foreach (split(/\,/,&Apache::lonnet::metadata($self->src(),
2052: 'allpossiblekeys'))) {
2053: if ($_ =~ /^parameter\_(.*)\_opendate$/) {
2054: push @{$self->{PARTS}}, $1;
2055: }
2056: }
2057:
2058: # Is this possible to do in one line? - Jeremy
2059: my @sortedParts = sort @{$self->{PARTS}};
2060: $self->{PARTS} = \@sortedParts;
2061:
2062: return;
2063: }
2064:
2065: =pod
2066:
2067: =head2 Resource Status
2068:
2069: Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status.
2070:
2071: There are two aspects to the status: the date-related information and the completion information.
2072:
2073: Idiomatic usage of these two methods would probably look something like
2074:
2075: foreach ($resource->parts()) {
2076: my $dateStatus = $resource->getDateStatus($_);
2077: my $completionStatus = $resource->getCompletionStatus($_);
2078:
2079: ... use it here ...
2080: }
2081:
2082: =over 4
2083:
2084: =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part, with the following possible results:
2085:
2086: =back
2087:
2088: B<Date Codes>
2089:
2090: =over 4
2091:
2092: =item * B<OPEN_LATER>: The problem will be opened later.
2093:
2094: =item * B<OPEN>: Open and not yet due.
2095:
2096: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
2097:
2098: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
2099:
2100: =item * B<ANSWER_OPEN>: The answer date is here.
2101:
2102: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2103:
2104: =back
2105:
2106: =cut
2107:
2108: # Apparently the compiler optimizes these into constants automatically
2109: sub OPEN_LATER { return 0; }
2110: sub OPEN { return 1; }
2111: sub PAST_DUE_NO_ANSWER { return 2; }
2112: sub PAST_DUE_ANSWER_LATER { return 3; }
2113: sub ANSWER_OPEN { return 4; }
2114: sub NOTHING_SET { return 5; }
2115: sub NETWORK_FAILURE { return 100; }
2116:
2117: # getDateStatus gets the date status for a given problem part.
2118: # Because answer date, due date, and open date are fully independent
2119: # (i.e., it is perfectly possible to *only* have an answer date),
2120: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
2121: # (past, future, none given). This function handles this with a decision
2122: # tree. Read the comments to follow the decision tree.
2123:
2124: sub getDateStatus {
2125: my $self = shift;
2126: my $part = shift;
2127: $part = "0" if (!defined($part));
2128:
2129: # Always return network failure if there was one.
2130: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2131:
2132: my $now = time();
2133:
2134: my $open = $self->opendate($part);
2135: my $due = $self->duedate($part);
2136: my $answer = $self->answerdate($part);
2137:
2138: if (!$open && !$due && !$answer) {
2139: # no data on the problem at all
2140: # should this be the same as "open later"? think multipart.
2141: return $self->NOTHING_SET;
2142: }
2143: if (!$open || $now < $open) {return $self->OPEN_LATER};
2144: if (!$due || $now < $due) {return $self->OPEN};
2145: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER};
2146: if ($answer) { return $self->ANSWER_OPEN; };
2147: return PAST_DUE_NO_ANSWER;
2148: }
2149:
2150: =pod
2151:
2152: B<>
2153:
2154: =over 4
2155:
2156: =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:
2157:
2158: =back
2159:
2160: B<Completion Codes>
2161:
2162: =over 4
2163:
2164: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2165:
2166: =item * B<INCORRECT>: Attempted, but wrong by student.
2167:
2168: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2169:
2170: =item * B<CORRECT>: Correct or correct by instructor.
2171:
2172: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2173:
2174: =item * B<EXCUSED>: Excused. Not yet implemented.
2175:
2176: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2177:
2178: =back
2179:
2180: =cut
2181:
2182: sub NOT_ATTEMPTED { return 10; }
2183: sub INCORRECT { return 11; }
2184: sub INCORRECT_BY_OVERRIDE { return 12; }
2185: sub CORRECT { return 13; }
2186: sub CORRECT_BY_OVERRIDE { return 14; }
2187: sub EXCUSED { return 15; }
2188:
2189: sub getCompletionStatus {
2190: my $self = shift;
2191: my $part = shift;
2192: $part = "0" if (!defined($part));
2193: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2194:
2195: # Make sure return hash exists
2196: $self->getReturnHash();
2197:
2198: my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
2199:
2200: # Left as seperate if statements in case we ever do more with this
2201: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2202: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2203: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2204: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2205: if ($status eq 'excused') {return $self->EXCUSED; }
2206: return $self->NOT_ATTEMPTED;
2207: }
2208:
2209: =pod
2210:
2211: B<Composite Status>
2212:
2213: Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()):
2214:
2215: =over 4
2216:
2217: =item * NETWORK_FAILURE: The network has failed and the information is not available.
2218:
2219: =item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened.)
2220:
2221: =item * CORRECT: For any reason at all, the part is considered correct.
2222:
2223: =item * EXCUSED: For any reason at all, the problem is excused.
2224:
2225: =item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.
2226:
2227: =item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.
2228:
2229: =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.
2230:
2231: =item * OPEN_LATER: The problem is not yet open.
2232:
2233: =item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.
2234:
2235: =item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.
2236:
2237: =item * OPEN: The item is open and not yet tried.
2238:
2239: =back
2240:
2241: =cut
2242:
2243: sub TRIES_LEFT { return 10; }
2244:
2245: sub status {
2246: my $self = shift;
2247: my $part = shift;
2248: if (!defined($part)) { $part = "0"; }
2249: my $completionStatus = $self->getCompletionStatus($part);
2250: my $dateStatus = $self->getDateStatus($part);
2251:
2252: # What we have is a two-dimensional matrix with 4 entries on one
2253: # dimension and 5 entries on the other, which we want to colorize,
2254: # plus network failure and "no date data at all".
2255:
2256: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
2257:
2258: # There are a few whole rows we can dispose of:
2259: if ($completionStatus == CORRECT ||
2260: $completionStatus == CORRECT_BY_OVERRIDE ) {
2261: return CORRECT();
2262: }
2263:
2264: # If it's EXCUSED, then return that no matter what
2265: if ($completionStatus == EXCUSED) {
2266: return EXCUSED;
2267: }
2268:
2269: if ($dateStatus == NOTHING_SET) {
2270: return NOTHING_SET;
2271: }
2272:
2273: # Now we're down to a 3 (incorrect, incorrect_override, not_attempted)
2274: # by 4 matrix (date status).
2275:
2276: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
2277: $dateStatus == PAST_DUE_NO_ANSWER) {
2278: return $dateStatus;
2279: }
2280:
2281: if ($dateStatus == ANSWER_OPEN) {
2282: return ANSWER_OPEN;
2283: }
2284:
2285: # Now: (incorrect, incorrect_override, not_attempted) x
2286: # (open_later), (open)
2287:
2288: if ($dateStatus == OPEN_LATER) {
2289: return OPEN_LATER;
2290: }
2291:
2292: # If it's WRONG...
2293: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
2294: # and there are TRIES LEFT:
2295: if ($self->tries() < $self->maxtries()) {
2296: return TRIES_LEFT;
2297: }
2298: return INCORRECT; # otherwise, return orange; student can't fix this
2299: }
2300:
2301: # Otherwise, it's untried and open
2302: return OPEN;
2303: }
2304:
2305: =pod
2306:
2307: =head2 Resource/Nav Map Navigation
2308:
2309: =over 4
2310:
2311: =item * B<getNext>(): Gets the next resource in the navmap after this one.
2312:
2313: =cut
2314:
2315: # For the simple single-link case, to get from a resource to the next
2316: # resource, you need to look up the "to_" link in the nav hash, then
2317: # follow that with the "goesto_" link.
2318:
2319: sub getNext {
2320: my $self = shift;
2321: my $alreadySeenHash = shift;
2322: my @branches;
2323: my $to = $self->to();
2324: foreach my $branch ( split(/\,/, $to) ) {
2325: my $choice = $self->{NAV_MAP}->getById($branch);
2326: my $next = $choice->goesto();
2327: $next = $self->{NAV_MAP}->getById($next);
2328:
2329: # Don't remember it if we've already seen it
2330: if (!defined($alreadySeenHash) ||
2331: !defined($alreadySeenHash->{$next->{ID}})) {
2332: push @branches, $next;
2333: }
2334: }
2335: return \@branches;
2336: }
2337:
2338: =pod
2339:
2340: =back
2341:
2342: =cut
2343:
2344: 1;
2345:
2346: __END__
2347:
2348:
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