Annotation of loncom/interface/lonnavmaps.pm, revision 1.53
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.51 bowersj2 4: # $Id: lonnavmaps.pm,v 1.50 2002/09/09 17:20:14 www Exp $
1.20 albertel 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: #
1.2 www 28: # (Page Handler
1.1 www 29: #
1.2 www 30: # (TeX Content Handler
1.1 www 31: #
1.2 www 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)
1.1 www 35: #
1.17 www 36: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
1.21 www 37: # YEAR=2002
38: # 1/1 Gerd Kortemeyer
39: #
1.2 www 40:
1.1 www 41: package Apache::lonnavmaps;
42:
43: use strict;
1.2 www 44: use Apache::Constants qw(:common :http);
45: use Apache::lonnet();
1.18 albertel 46: use Apache::loncommon();
1.2 www 47: use HTML::TokeParser;
48: use GDBM_File;
49:
50: # -------------------------------------------------------------- Module Globals
51: my %hash;
52: my @rows;
53:
1.10 www 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:
1.47 bowersj2 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:
1.2 www 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) {
1.51 bowersj2 81: $a=$b; $b=$r;
1.2 www 82: $r=$a%$b;
83: }
84: return $b;
85: }
86:
1.10 www 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
1.24 albertel 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) {
1.51 bowersj2 128: if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }
129: if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }
130: if ($useropt{$courselevel}) { return $useropt{$courselevel}; }
1.24 albertel 131: }
1.10 www 132:
1.24 albertel 133: # ------------------------------------------------------- second, check course
134: if ($csec) {
1.51 bowersj2 135: if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }
1.25 albertel 136: if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }
1.10 www 137: if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }
1.24 albertel 138: }
1.10 www 139:
1.24 albertel 140: if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }
141: if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }
142: if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }
1.10 www 143:
1.24 albertel 144: # ----------------------------------------------------- third, check map parms
1.10 www 145:
1.24 albertel 146: my $thisparm=$parmhash{$symbparm};
147: if ($thisparm) { return $thisparm; }
1.10 www 148:
1.24 albertel 149: # ----------------------------------------------------- fourth , check default
1.10 www 150:
1.25 albertel 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') {
1.51 bowersj2 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: }
1.25 albertel 167: }
168: return '';
1.10 www 169: }
170:
171:
172:
1.9 www 173: # ------------------------------------------------------------- Find out status
1.25 albertel 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
1.29 albertel 185: # 4: partially correct (one or more parts correct)
186: # "excused" needs to be supported, but is not yet.
1.9 www 187: sub astatus {
188: my $rid=shift;
1.29 albertel 189: my $code=0;
1.9 www 190: my $ctext='';
191: $rid=~/(\d+)\.(\d+)/;
1.10 www 192: my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
1.51 bowersj2 193: &Apache::lonnet::declutter($hash{'src_'.$rid});
1.15 www 194: my %duedate=();
195: my %opendate=();
196: my %answerdate=();
1.25 albertel 197: # need to always check part 0's open/due/answer status
1.51 bowersj2 198: foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) {
1.15 www 199: if ($_=~/^parameter\_(.*)\_opendate$/) {
1.51 bowersj2 200: my $part=$1;
1.15 www 201: $duedate{$part}=&parmval($part.'.duedate',$symb);
202: $opendate{$part}=&parmval($part.'.opendate',$symb);
203: $answerdate{$part}=&parmval($part.'.answerdate',$symb);
1.49 www 204: if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') {
1.51 bowersj2 205: $opendate{$part}=$duedate{$part}-$opendate{$part};
1.49 www 206: }
1.50 www 207: if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') {
1.49 www 208: $answerdate{$part}=$duedate{$part}+$answerdate{$part};
209: }
1.15 www 210: }
1.25 albertel 211: }
1.11 www 212: my $now=time;
213: my $tcode=0;
1.16 www 214:
215: my %returnhash=&Apache::lonnet::restore($symb);
216:
1.25 albertel 217: foreach (sort(keys(%opendate))) {
1.51 bowersj2 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: }
1.25 albertel 276: }
1.16 www 277:
1.11 www 278: return 'p'.$code.$tcode.'"'.$ctext.'"';
1.9 www 279: }
280:
1.2 www 281:
1.31 albertel 282: sub addresource {
1.32 albertel 283: my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;
1.31 albertel 284: if ($showtypes eq 'problems') {
1.51 bowersj2 285: if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {
286: return;
287: }
1.31 albertel 288: }
289: my $brepriv=&Apache::lonnet::allowed('bre',$resource);
290: if ($hash{'src_'.$rid}) {
1.51 bowersj2 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: }
1.31 albertel 305: }
306: }
307:
308: sub followlinks () {
1.32 albertel 309: my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_;
1.31 albertel 310: my $mincond=1;
311: my $next='';
312: foreach (split(/\,/,$hash{'to_'.$rid})) {
1.51 bowersj2 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: }
1.31 albertel 323: }
1.32 albertel 324: my $col=0;
325: &Apache::lonxml::debug("following links -$next-");
1.31 albertel 326: foreach (split(/\,/,$next)) {
1.51 bowersj2 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++;
1.31 albertel 343: }
344: return $further;
345: }
346: # ------------------------------------------------------------ Build page table
347:
348: sub tracetable {
1.32 albertel 349: my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_;
350: my $newshowtypes=$showtypes;
1.31 albertel 351: my $further=$sofar;
1.44 www 352: # $Apache::lonxml::debug=1;
1.32 albertel 353: &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid});
354: if ($beenhere=~/\&$rid\&/) { return $further; }
355: $beenhere.=$rid.'&';
1.31 albertel 356:
357: if (defined($hash{'is_map_'.$rid})) {
1.51 bowersj2 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: }
1.31 albertel 387: } else {
1.51 bowersj2 388: &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,
389: $indent,$linkid);
1.31 albertel 390: }
391:
392: if (defined($hash{'to_'.$rid})) {
1.51 bowersj2 393: $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,
394: $indent,$linkid);
1.2 www 395: }
1.31 albertel 396:
1.2 www 397: return $further;
398: }
399:
400: # ================================================================ Main Handler
1.1 www 401:
402: sub handler {
1.28 albertel 403: my $r=shift;
1.2 www 404:
1.51 bowersj2 405: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
406:
407: if ($ENV{'form.jtest'} ne "1")
408: {
409: return new_handle($r);
410: }
1.2 www 411:
412: # ------------------------------------------- Set document type for header only
413:
1.28 albertel 414: if ($r->header_only) {
1.51 bowersj2 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;
1.28 albertel 422: }
423: my $requrl=$r->uri;
424: my $hashtied;
1.2 www 425: # ----------------------------------------------------------------- Tie db file
1.28 albertel 426: my $fn;
427: if ($ENV{'request.course.fn'}) {
1.51 bowersj2 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: }
1.28 albertel 437: }
438: if (!$hashtied) {
1.51 bowersj2 439: $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
440: return HTTP_NOT_ACCEPTABLE;
1.28 albertel 441: }
442:
1.2 www 443: # ------------------------------------------------------------------- Hash tied
1.28 albertel 444:
445: if ($ENV{'browser.mathml'}) {
1.51 bowersj2 446: $r->content_type('text/xml');
1.28 albertel 447: } else {
1.51 bowersj2 448: $r->content_type('text/html');
1.28 albertel 449: }
450: &Apache::loncommon::no_cache($r);
451: $r->send_http_header;
452:
1.42 www 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'})};
1.28 albertel 457: if (!(($firstres) && ($lastres))) {
1.51 bowersj2 458: $r->print('<html><body>Coursemap undefined.</body></html>');
1.28 albertel 459: } else {
460:
1.2 www 461: # ----------------------------------------------------------------- Render page
1.10 www 462: # -------------------------------------------------------------- Set parameters
463:
464:
465: # ---------------------------- initialize coursedata and userdata for this user
1.51 bowersj2 466: undef %courseopt;
467: undef %useropt;
1.10 www 468:
1.51 bowersj2 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') {
1.48 bowersj2 479: # ------------------------------------------------- Get coursedata (if present)
1.51 bowersj2 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: }
1.10 www 498: # --------------------------------------------------- Get userdata (if present)
1.51 bowersj2 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: }
1.28 albertel 512:
1.51 bowersj2 513: @rows=();
1.28 albertel 514:
1.51 bowersj2 515: &tracetable(0,$firstres,'&','',0);
1.2 www 516:
517: # ------------------------------------------------------------------ Page parms
518:
1.51 bowersj2 519: my $j;
520: my $i;
521: my $lcm=1;
522: my $contents=0;
1.2 www 523:
524: # ---------------------------------------------- Go through table to get layout
525:
1.51 bowersj2 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: }
1.5 www 534:
1.2 www 535:
1.51 bowersj2 536: unless ($contents) {
537: $r->print('<html><body>Empty Map.</body></html>');
538: } else {
1.10 www 539:
1.2 www 540: # ------------------------------------------------------------------ Build page
541:
1.51 bowersj2 542: my $currenturl=$ENV{'form.postdata'};
543: $currenturl=~s/^http\:\/\///;
544: $currenturl=~s/^[^\/]+//;
1.13 www 545:
1.2 www 546: # ---------------------------------------------------------------- Send headers
547:
1.51 bowersj2 548: my $date=localtime;
549: my $now=time;
1.21 www 550: # ----------------------------------------- Get email status and discussiontime
551:
1.51 bowersj2 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: }
1.22 www 586: # ----------------------------------------------------------- Start Page Output
1.43 www 587: my $bodytagadd='';
1.51 bowersj2 588: $r->print(
1.43 www 589: '<html><head><title>Navigate Course Map</title></head>');
1.51 bowersj2 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','',
1.43 www 595: $bodytagadd));
1.51 bowersj2 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: }
1.13 www 617: # ----------------------------------------------------- The little content list
1.51 bowersj2 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: }
1.2 www 633: # ----------------------------------------------------------------- Start table
1.51 bowersj2 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];
1.36 www 646: $rid=~/(\d+)\.(\d+)$/;
1.51 bowersj2 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>';
1.36 www 661: if (($ENV{'user.adv'}) &&
1.51 bowersj2 662: ($parmhash{$symb.'.0.parameter_randompick'})) {
1.36 www 663: $adde=' (randomly select '.
1.51 bowersj2 664: $parmhash{$symb.'.0.parameter_randompick'}.
1.36 www 665: ')</th>';
666: }
1.51 bowersj2 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; }
1.38 www 765: if ($hash{'randomout_'.$rid}) {
766: $adde=' <i>(hidden)</i>'.$adde;
767: }
1.51 bowersj2 768: $r->print($add.$indentstr);
769: if ($rid) {
770: $r->print('<a href="'.$hash{'src_'.$linkid}.
1.39 www 771: (($hash{'src_'.$linkid}=~/\?/)?'&':'?').
772: 'symb='.&Apache::lonnet::escape($symb)
1.35 www 773: .'">'.
1.51 bowersj2 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>');
1.2 www 783: # -------------------------------------------------------------------- End page
1.51 bowersj2 784: }
1.2 www 785: # ------------------------------------------------------------- End render page
1.28 albertel 786: }
1.2 www 787: # ------------------------------------------------------------------ Untie hash
1.28 albertel 788: unless (untie(%hash)) {
1.51 bowersj2 789: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
790: "Could not untie coursemap $fn (browse).</font>");
1.28 albertel 791: }
792: unless (untie(%parmhash)) {
1.51 bowersj2 793: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
794: "Could not untie parmhash (browse).</font>");
1.28 albertel 795: }
796: return OK;
1.2 www 797: }
1.1 www 798:
1.51 bowersj2 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: # Grab a resource object so we have access to the constants; this
831: # is technically not proper, but should be harmless
832: my $res = $navmap->firstResource();
833:
834: # Defines a status->color mapping, null string means don't color
835: my %colormap =
836: ( $res->NETWORK_FAILURE => '',
837: $res->CORRECT => '#BBFFBB',
838: $res->EXCUSED => '#BBBBFF',
839: $res->PAST_DUE => '#FFAA00',
840: $res->ANSWER_OPEN => '#FF00AA',
841: $res->OPEN_LATER => '',
842: $res->TRIES_LEFT => '#FFFF00',
843: $res->INCORRECT => '#FFAA00',
1.53 ! bowersj2 844: $res->OPEN => '#FFFF88',
! 845: $res->NOTHING_SET => '' );
1.51 bowersj2 846:
847: if (!defined($navmap)) {
848: my $requrl = $r->uri;
849: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
850: return HTTP_NOT_ACCEPTABLE;
851: }
852:
853: my %filterHash;
854: # Figure out what we're not displaying
855: foreach (split(/\,/, $ENV{"form.filter"})) {
856: if ($_) {
857: $filterHash{$_} = "1";
858: }
859: }
860:
861: # Begin the HTML table
862: # two columns: the title/icon on the left, the info on the right
863: $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
864:
865: my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);
866: my $curRes = $mapIterator->next();
1.53 ! bowersj2 867: undef $res; # so we don't accidentally use it later
1.51 bowersj2 868: my $indentLevel = -1;
869: my $indentString = " ";
870:
871: my $isNewBranch = 0;
872:
873: while ($curRes != $mapIterator->END_NAV_MAP) {
874: if ($curRes == $mapIterator->BEGIN_MAP() ||
1.52 bowersj2 875: $curRes == $mapIterator->BEGIN_BRANCH()) {
1.51 bowersj2 876: $indentLevel++;
877: }
878: if ($curRes == $mapIterator->END_MAP() ||
1.52 bowersj2 879: $curRes == $mapIterator->END_BRANCH()) {
1.51 bowersj2 880: $indentLevel--;
881: }
1.52 bowersj2 882: if ($curRes == $mapIterator->BEGIN_BRANCH()) {
883: $isNewBranch = 1;
1.51 bowersj2 884: }
885:
886: if (ref($curRes) && $curRes->src()) {
887:
888: my @parts;
889: if ($curRes->is_problem()) {
890: @parts = @{$curRes->parts()};
891: if (scalar(@parts) > 1) { shift(@parts); }
892: } else {
893: @parts[0] = "0"; # this is to get past foreach loop below
894: # you can consider a non-problem resource as a resource
895: # with only one part without loss
896: }
897:
898: foreach my $part (@parts) {
899:
900: # For each thing we're displaying...
901:
902: my $stack = $mapIterator->getStack();
903: my $src = getLinkForResource($stack);
904:
905: my $srcHasQuestion = $src =~ /\?/;
906: my $link = $src.
907: ($srcHasQuestion?'&':'?') .
908: 'symb='.&Apache::lonnet::escape($curRes->symb()).
909: '"';
910: my $title = $curRes->title();
911: my $partLabel = "";
1.52 bowersj2 912: my $newBranchText = "";
913:
914: # If this is a new branch, label it so
915: # (temporary, this should be an icon w/ alt text)
916: if ($isNewBranch) {
917: $newBranchText = "NB -> ";
918: $isNewBranch = 0;
919: }
1.51 bowersj2 920:
921: # links to open and close the folders
922: my $linkopen = "<a href=\"$link\">";
923: my $linkclose = "</a>";
924:
925: my $icon = "html.gif";
926: if ($curRes->is_problem()) {
927: $icon = "problem.gif";
928: }
929:
930: # Display the correct icon, link to open or shut map
931: if ($curRes->is_map()) {
932: my $mapId = $curRes->map_pc();
933: my $nowOpen = !defined($filterHash{$mapId});
934: $icon = $nowOpen ?
935: "folder_opened.gif" : "folder_closed.gif";
1.52 bowersj2 936: $linkopen = "<a href=\"/adm/navmaps?filter=";
1.51 bowersj2 937: $linkopen .= $nowOpen ?
938: addToFilter(\%filterHash, $mapId) :
939: removeFromFilter(\%filterHash, $mapId);
940: $linkopen .= "\">";
941: $linkclose = "</a>";
942:
943: }
944:
945: my $colorizer = "";
946: if ($curRes->is_problem()) {
947: my $status = $curRes->status($part);
948: my $color = $colormap{$status};
949: if ($color ne "") {
950: $colorizer = "bgcolor=\"$color\"";
951: }
952: }
953:
954: $r->print(" <tr><td align=\"left\" valign=\"top\">\n");
955:
956: # print indentation
957: for (my $i = 0; $i < $indentLevel; $i++) {
958: $r->print($indentString);
959: }
960:
1.52 bowersj2 961: $r->print(" ${newBranchText}${linkopen}<img border=\"0\" src=\"" .
1.51 bowersj2 962: "/adm/lonIcons/$icon\" alt=\"\">${linkclose}\n");
963:
964: if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }
965:
966: $r->print(" <a href=\"$link\">$title$partLabel</a></td>".
967: "<td $colorizer align=\"right\">\n");
968:
969: if ($curRes->kind() eq "res" and
970: $curRes->is_problem() ) {
1.53 ! bowersj2 971: $r->print (getDescription($curRes, $part));
1.51 bowersj2 972: }
973: }
974: }
975: $curRes = $mapIterator->next();
976: }
977:
978: $r->print("</table></body></html>");
979:
980: return OK;
981: }
982:
983: # Convenience functions: Returns a string that adds or subtracts
984: # the second argument from the first hash, appropriate for the
985: # query string that determines which folders to recurse on
986: sub addToFilter {
987: my $hashIn = shift;
988: my $addition = shift;
989: my %hash = %$hashIn;
990: $hash{$addition} = 1;
991:
992: return join (",", keys(%hash));
993: }
994:
995: sub removeFromFilter {
996: my $hashIn = shift;
997: my $subtraction = shift;
998: my %hash = %$hashIn;
999:
1000: delete $hash{$subtraction};
1001: return join(",", keys(%hash));
1002: }
1003:
1004: # Convenience function: Given a stack returned from getStack on the iterator,
1005: # return the correct src() value.
1006: # Later, this should add an anchor when we start putting anchors in pages.
1007: sub getLinkForResource {
1008: my $stack = shift;
1009: my $res;
1010:
1011: # Check to see if there are any pages in the stack
1012: foreach $res (@$stack) {
1013: if (defined($res) && $res->is_page()) {
1014: return $res->src();
1015: }
1016: }
1017:
1018: # Failing that, return the src of the last resource that is defined
1019: # (when we first recurse on a map, it puts an undefined resource
1020: # on the bottom because $self->{HERE} isn't defined yet, and we
1021: # want the src for the map anyhow)
1022: foreach (@$stack) {
1023: if (defined($_)) { $res = $_; }
1024: }
1025:
1026: return $res->src();
1027: }
1028:
1.53 ! bowersj2 1029: # Convenience function: This seperates the logic of how to create
! 1030: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
! 1031: # etc.) into a seperate function. It takes a resource object as the
! 1032: # first parameter, and the part number of the resource as the second.
! 1033: # It's basically a big switch statement on the status of the resource.
! 1034:
! 1035: sub getDescription {
! 1036: my $res = shift;
! 1037: my $part = shift;
! 1038: my $status = $res->getDateStatus();
! 1039:
! 1040: if ($status == $res->NETWORK_FAILURE) { return ""; }
! 1041: if ($status == $res->NOTHING_SET) {
! 1042: return "Not currently assigned.";
! 1043: }
! 1044: if ($status == $res->OPEN_LATER) {
! 1045: return "Opens: " . timeToHumanString($res->opendate($part));
! 1046: }
! 1047: if ($status == $res->OPEN) {
! 1048: return "Due: " . timeToHumanString($res->duedate($part));
! 1049: }
! 1050: if ($status == $res->PAST_DUE) {
! 1051: return "Answer: " . timeToHumanString($res->duedate($part));
! 1052: }
! 1053: if ($status == $res->ANSWER_OPEN) {
! 1054: return "Answer available";
! 1055: }
! 1056:
! 1057: }
! 1058:
! 1059: # I want to change this into something more human-friendly. For
! 1060: # now, this is a simple call to localtime. The final function
! 1061: # probably belongs in loncommon.
! 1062: sub timeToHumanString {
! 1063: return localtime(shift);
! 1064: }
! 1065:
1.51 bowersj2 1066: 1;
1067:
1068: package Apache::lonnavmaps::navmap;
1069:
1070: # LEFT:
1071: # * Actual handler code (multi-part)
1072: # * Branches (aieee!) (and conditionals)
1073:
1074: =pod
1075:
1076: 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.
1077:
1078: =head1 navmap object: Encapsulating the compiled nav map
1079:
1080: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
1081:
1082: 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.
1083:
1084: You must obtain resource objects through the navmap object.
1085:
1086: =head2 Methods
1087:
1088: =over 4
1089:
1090: =item * B<new>(filename, parmHashFile, genCourseAndUserOptions): 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. 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.
1091:
1092: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
1093:
1094: =cut
1095:
1096: use strict;
1097: use GDBM_File;
1098:
1099: sub new {
1100: # magic invocation to create a class instance
1101: my $proto = shift;
1102: my $class = ref($proto) || $proto;
1103: my $self = {};
1104:
1105: $self->{NAV_HASH_FILE} = shift;
1106: $self->{PARM_HASH_FILE} = shift;
1107: $self->{GENERATE_COURSE_USER_OPT} = shift;
1108:
1109: # Resource cache stores navmapresource's as we reference them. We generate
1110: # them on-demand so we don't pay for creating resources unless we use them.
1111: $self->{RESOURCE_CACHE} = {};
1112:
1113: # Network failure flag, if we accessed the course or user opt and
1114: # failed
1115: $self->{NETWORK_FAILURE} = 0;
1116:
1117: # tie the nav hash
1118: my %navmaphash;
1119: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
1120: &GDBM_READER(), 0640))) {
1121: return undef;
1122: }
1123: $self->{NAV_HASH} = \%navmaphash;
1124:
1125: my %parmhash;
1126: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
1127: &GDBM_READER(), 0640)))
1128: {
1129: return undef;
1130: }
1131: $self->{PARM_HASH} = \%parmhash;
1132: $self->{HASH_TIED} = 1;
1133:
1134: # If the course opt hash and the user opt hash should be generated,
1135: # generate them
1136: if ($self->{GENERATE_COURSE_USER_OPT}) {
1137: my $uname=$ENV{'user.name'};
1138: my $udom=$ENV{'user.domain'};
1139: my $uhome=$ENV{'user.home'};
1140: my $cid=$ENV{'request.course.id'};
1141: my $chome=$ENV{'course.'.$cid.'.home'};
1142: my ($cdom,$cnum)=split(/\_/,$cid);
1143:
1144: my $userprefix=$uname.'_'.$udom.'_';
1145:
1146: my %courserdatas; my %useropt; my %courseopt;
1147: unless ($uhome eq 'no_host') {
1148: # ------------------------------------------------- Get coursedata (if present)
1149: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1150: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1151: ':resourcedata',$chome);
1152: if ($reply!~/^error\:/) {
1153: $courserdatas{$cid}=$reply;
1154: $courserdatas{$cid.'.last_cache'}=time;
1155: }
1156: # check to see if network failed
1157: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1158: {
1159: $self->{NETWORK_FAILURE} = 1;
1160: }
1161: }
1162: foreach (split(/\&/,$courserdatas{$cid})) {
1163: my ($name,$value)=split(/\=/,$_);
1164: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1165: &Apache::lonnet::unescape($value);
1166: }
1167: # --------------------------------------------------- Get userdata (if present)
1168: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1169: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1170: if ($reply!~/^error\:/) {
1171: $userrdatas{$uname.'___'.$udom}=$reply;
1172: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1173: }
1174: # check to see if network failed
1175: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1176: {
1177: $self->{NETWORK_FAILURE} = 1;
1178: }
1179: }
1180: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1181: my ($name,$value)=split(/\=/,$_);
1182: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1183: &Apache::lonnet::unescape($value);
1184: }
1185: $self->{COURSE_OPT} = \%courseopt;
1186: $self->{USER_OPT} = \%useropt;
1187: }
1188: }
1189:
1190: bless($self);
1191:
1192: return $self;
1193: }
1194:
1195: sub getIterator {
1196: my $self = shift;
1197: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1198: shift, shift);
1199: return $iterator;
1200: }
1201:
1202: # unties the hash when done
1203: sub untieHashes {
1204: my $self = shift;
1205: untie $self->{NAV_HASH} if ($self->{HASH_TIED});
1206: untie $self->{PARM_HASH} if ($self->{HASH_TIED});
1207: $self->{HASH_TIED} = 0;
1208: }
1209:
1210: # when the object is destroyed, be sure to untie all the hashes we tied.
1211: sub DESTROY {
1212: my $self = shift;
1213: $self->untieHashes();
1214: }
1215:
1216: =pod
1217:
1218: =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.
1219:
1220: =cut
1221:
1222: # The strategy here is to cache the resource objects, and only construct them
1223: # as we use them. The real point is to prevent reading any more from the tied
1224: # hash then we have to, which should hopefully alleviate speed problems.
1225: # Caching is just an incidental detail I throw in because it makes sense.
1226:
1227: sub getById {
1228: my $self = shift;
1229: my $id = shift;
1230:
1231: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1232: {
1233: return $self->{RESOURCE_CACHE}->{$id};
1234: }
1235:
1236: # resource handles inserting itself into cache.
1237: return Apache::lonnavmaps::resource->new($self, $id);
1238: }
1239:
1240: =pod
1241:
1242: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1243:
1244: =cut
1245:
1246: sub firstResource {
1247: my $self = shift;
1248: my $firstResource = $self->{NAV_HASH}->{'map_start_' .
1249: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1250: return $self->getById($firstResource);
1251: }
1252:
1253: =pod
1254:
1255: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1256:
1257: =cut
1258:
1259: sub finishResource {
1260: my $self = shift;
1261: my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
1262: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1263: return $self->getById($firstResource);
1264: }
1265:
1266: # -------------------------------------------- Figure out a cascading parameter
1267: #
1268: # For this function to work
1269: #
1270: # * parmhash needs to be tied
1271: # * courseopt and useropt need to be initialized for this user and course
1272: #
1273:
1274: sub parmval {
1275: my $self = shift;
1276: my ($what,$symb)=@_;
1277: my $cid=$ENV{'request.course.id'};
1278: my $csec=$ENV{'request.course.sec'};
1279: my $uname=$ENV{'user.name'};
1280: my $udom=$ENV{'user.domain'};
1281:
1282: unless ($symb) { return ''; }
1283: my $result='';
1284:
1285: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1286:
1287: # ----------------------------------------------------- Cascading lookup scheme
1288: my $rwhat=$what;
1289: $what=~s/^parameter\_//;
1290: $what=~s/\_/\./;
1291:
1292: my $symbparm=$symb.'.'.$what;
1293: my $mapparm=$mapname.'___(all).'.$what;
1294: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1295:
1296: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1297: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1298: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1299:
1300: my $courselevel= $usercourseprefix.'.'.$what;
1301: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1302: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1303:
1304: my $useropt = $self->{USER_OPT};
1305: my $courseopt = $self->{COURSE_OPT};
1306: my $parmhash = $self->{PARM_HASH};
1307:
1308: # ---------------------------------------------------------- first, check user
1309: if ($uname and defined($useropt)) {
1310: if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; }
1311: if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; }
1312: if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; }
1313: }
1314:
1315: # ------------------------------------------------------- second, check course
1316: if ($csec and defined($courseopt)) {
1317: if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; }
1318: if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; }
1319: if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; }
1320: }
1321:
1322: if (defined($courseopt)) {
1323: if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; }
1324: if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; }
1325: if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; }
1326: }
1327:
1328: # ----------------------------------------------------- third, check map parms
1329:
1330: my $thisparm=$$parmhash{$symbparm};
1331: if ($thisparm) { return $thisparm; }
1332:
1333: # ----------------------------------------------------- fourth , check default
1334:
1335: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1336: if ($default) { return $default}
1337:
1338: # --------------------------------------------------- fifth , cascade up parts
1339:
1340: my ($space,@qualifier)=split(/\./,$rwhat);
1341: my $qualifier=join('.',@qualifier);
1342: unless ($space eq '0') {
1343: my ($part,$id)=split(/\_/,$space);
1344: if ($id) {
1345: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1346: if ($partgeneral) { return $partgeneral; }
1347: } else {
1348: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1349: if ($resourcegeneral) { return $resourcegeneral; }
1350: }
1351: }
1352: return '';
1353: }
1354:
1355:
1356: 1;
1357:
1358: package Apache::lonnavmaps::iterator;
1359:
1360: # This package must precede "navmap" because "navmap" uses it. In
1361: # order to keep the documentation order straight, the iterator is documented
1362: # after the navmap object.
1363:
1364: =pod
1365:
1366: =back
1367:
1368: =head1 navmap Iterator
1369:
1370: 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.
1371:
1372: 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:
1373:
1374: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1375:
1376: To get the next thing from the iterator, call B<next>:
1377:
1378: C<my $nextThing = $resourceIterator-E<gt>next()>
1379:
1380: getIterator behaves as follows:
1381:
1382: =over 4
1383:
1384: =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.
1385:
1386: 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.
1387:
1388: 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:
1389:
1390: =over 4
1391:
1392: =item * some list of tokens here
1393:
1394: =back
1395:
1396: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
1397:
1398: =cut
1399:
1400: # Here are the tokens for the iterator:
1401:
1402: sub END_NAV_MAP { return 0; } # Represents end of entire nav map
1403: sub BEGIN_MAP { return 1; } # begining of a new map
1404: sub END_MAP { return 2; } # end of the map
1405: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1406: sub END_BRANCH { return 4; } # end of a branch
1407:
1408: # Params: nav map, start resource, end resource, filter, condition,
1409: # already seen hash ref
1410:
1411: sub new {
1412: # magic invocation to create a class instance
1413: my $proto = shift;
1414: my $class = ref($proto) || $proto;
1415: my $self = {};
1416:
1417: $self->{NAV_MAP} = shift;
1418: return undef unless ($self->{NAV_MAP});
1419:
1420: # Handle the parameters
1421: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1422: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1423:
1424: # If the given resources are just the ID of the resource, get the
1425: # objects
1426: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1427: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1428: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1429: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1430:
1431: $self->{FILTER} = shift;
1432:
1433: # A hash, used as a set, of resource already seen
1434: $self->{ALREADY_SEEN} = shift;
1435: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1436:
1437: # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
1438: $self->{STARTED} = 0;
1439:
1440: # Should we continue calling the recursive iterator, if any?
1441: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1442: # The recursive iterator, if any
1443: $self->{RECURSIVE_ITERATOR} = undef;
1444: # Are we recursing on a map, or a branch?
1445: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
1446: # And the count of how deep it is, so that this iterator can keep track of
1447: # when to pick back up again.
1448: $self->{RECURSIVE_DEPTH} = 0;
1449:
1450: # For keeping track of our branches, we maintain our own stack
1451: $self->{BRANCH_STACK} = [];
1452: # If the size shrinks, we exhausted a branch
1453: $self->{BRANCH_STACK_SIZE} = 0;
1454: $self->{BRANCH_DEPTH} = 0;
1455:
1456: # For returning two things in a forced sequence
1457: $self->{FORCE_NEXT} = undef;
1458:
1459: # Start with the first resource
1460: push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
1461: $self->{BRANCH_STACK_SIZE} = 1;
1462:
1463: bless($self);
1464: return $self;
1465: }
1466:
1467: # Note... this function is *touchy*. I strongly recommend tracing
1468: # through it with the debugger a few times on a non-trivial map before
1469: # modifying it. Order is *everything*.
1470: sub next {
1471: my $self = shift;
1472:
1473: # Iterator logic goes here
1474:
1475: # Is this return value pre-determined?
1476: if (defined($self->{FORCE_NEXT})) {
1477: my $tmp = $self->{FORCE_NEXT};
1478: $self->{FORCE_NEXT} = undef;
1479: return $tmp;
1480: }
1481:
1482: # Are we using a recursive iterator? If so, pull from that and
1483: # watch the depth; we want to resume our level at the correct time.
1484: if ($self->{RECURSIVE_ITERATOR_FLAG})
1485: {
1486: # grab the next from the recursive iterator
1487: my $next = $self->{RECURSIVE_ITERATOR}->next();
1488:
1489: # is it a begin or end map? Update depth if so
1490: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1491: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1492:
1493: # Are we back at depth 0? If so, stop recursing.
1494: if ($self->{RECURSIVE_DEPTH} == 0) {
1495: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1496: }
1497:
1498: return $next;
1499: }
1500:
1501: # Is there a current resource to grab? If not, then return
1502: # END_BRANCH and END_MAP in succession.
1503: if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
1504: if ($self->{BRANCH_DEPTH} > 0) {
1505: $self->{FORCE_NEXT} = $self->END_MAP();
1.52 bowersj2 1506: $self->{BRANCH_DEPTH}--;
1.51 bowersj2 1507: return $self->END_BRANCH();
1508: } else {
1509: return $self->END_MAP();
1510: }
1511: }
1512:
1513: # Have we not yet begun? If not, return BEGIN_MAP and
1514: # remember that we've started.
1515: if ( !$self->{STARTED} ) {
1516: $self->{STARTED} = 1;
1517: return $self->BEGIN_MAP;
1518: }
1519:
1520: # Did the branch stack shrink since last run? If so,
1521: # we exhausted a branch last time, therefore, we're about
1522: # to start a new one. (We know because we already checked to see
1523: # if the stack was empty.)
1524: if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
1.52 bowersj2 1525: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1526: $self->{BRANCH_DEPTH}++;
1527: return $self->BEGIN_BRANCH();
1.51 bowersj2 1528: }
1529:
1.52 bowersj2 1530: # Remember the size for comparision next time.
1531: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1532:
1533: # If the next resource we mean to return is going to need
1534: # a lower branch level, terminate branches until we get
1535: # there.
1536:
1.51 bowersj2 1537: # Get the next resource in the branch
1538: $self->{HERE} = pop @{$self->{BRANCH_STACK}};
1.52 bowersj2 1539:
1540: # Are we at the right depth? If not, close a branch and return
1541: # the current resource onto the branch stack
1542: if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH})
1543: && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} <
1544: $self->{BRANCH_DEPTH} ) {
1545: $self->{BRANCH_DEPTH}--;
1546: # return it so we can pick it up eventually
1547: push @{$self->{BRANCH_STACK}}, $self->{HERE};
1548: return $self->END_BRANCH();
1549: }
1550:
1.51 bowersj2 1551: # We always return it after this point and never before
1552: # (proof: look at just the return statements), so we
1553: # remember that we've seen this.
1554: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
1555:
1556: # Are we at the utter end? If so, return the END_NAV_MAP marker.
1557: if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
1.52 bowersj2 1558: $self->{FORCE_NEXT} = $self->END_NAV_MAP;
1.51 bowersj2 1559: return $self->{HERE};
1560: }
1561:
1562: # Get the next possible resources
1563: my $nextUnfiltered = $self->{HERE}->getNext();
1564: my $next = [];
1565:
1566: # filter the next possibilities to remove things we've
1.52 bowersj2 1567: # already seen. Also, remember what branch depth they should
1568: # be displayed at, since there's no other reliable way to tell.
1.51 bowersj2 1569: foreach (@$nextUnfiltered) {
1.52 bowersj2 1570: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1571: push @$next, $_;
1572: $_->{DATA}->{ITERATOR_DEPTH} =
1573: $self->{BRANCH_DEPTH} + 1;
1574: }
1.51 bowersj2 1575: }
1576:
1577: # Handle branch cases:
1578: # Nothing is available next: BRANCH_END
1579: # 1 thing next: standard non-branch
1580: # 2+ things next: have some branches
1581: my $nextCount = scalar(@$next);
1582: if ($nextCount == 0) {
1.52 bowersj2 1583: # Return this and on the next run, close the branch up if we're
1584: # in a branch
1585: if ($self->{BRANCH_DEPTH} > 0 ) {
1586: $self->{FORCE_NEXT} = $self->END_BRANCH();
1587: $self->{BRANCH_DEPTH}--;
1588: }
1.51 bowersj2 1589: return $self->{HERE};
1590: }
1591:
1592: while (@$next) {
1593: # copy the next possibilities over to the branch stack
1594: # in the right order
1.52 bowersj2 1595: push @{$self->{BRANCH_STACK}}, shift @$next;
1.51 bowersj2 1596: }
1597:
1598: if ($nextCount >= 2) {
1.52 bowersj2 1599: $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
1600: $self->{BRANCH_DEPTH}++;
1.51 bowersj2 1601: return $self->{HERE};
1602: }
1603:
1604: # If this is a map and we want to recurse down it... (not filtered out)
1605: if ($self->{HERE}->is_map() &&
1606: !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) {
1607: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
1608: my $firstResource = $self->{HERE}->map_start();
1609: my $finishResource = $self->{HERE}->map_finish();
1610:
1611: # Odd perl syntax here; $self->new allows one to create a new iterator
1612: # can't figure out how to ref this package directly correctly
1613: # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
1614: $self->{RECURSIVE_ITERATOR} =
1615: Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
1616: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN});
1.52 bowersj2 1617: # prime the new iterator with the first resource
1618: #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource;
1.51 bowersj2 1619: }
1620:
1621: return $self->{HERE};
1622: }
1623:
1624: =pod
1625:
1626: 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).
1627:
1628: =cut
1629:
1630: sub getStack {
1631: my $self=shift;
1632:
1633: my @stack;
1634:
1635: $self->populateStack(\@stack);
1636:
1637: return \@stack;
1638: }
1639:
1640: # Private method: Calls the iterators recursively to populate the stack.
1641: sub populateStack {
1642: my $self=shift;
1643: my $stack = shift;
1644:
1645: push @$stack, $self->{HERE};
1646:
1647: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1648: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
1649: }
1650: }
1651:
1.1 www 1652: 1;
1.2 www 1653:
1.51 bowersj2 1654: package Apache::lonnavmaps::resource;
1655:
1656: use Apache::lonnet;
1657:
1658: =pod
1659:
1660: =head1 Object: resource
1661:
1662: 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.
1663:
1664: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
1665:
1666: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
1667:
1668: =head2 Public Members
1669:
1670: 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.
1671:
1672: =head2 Methods
1673:
1674: =over 4
1675:
1676: =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.
1677:
1678: =cut
1679:
1680: sub new {
1681: # magic invocation to create a class instance
1682: my $proto = shift;
1683: my $class = ref($proto) || $proto;
1684: my $self = {};
1685:
1686: $self->{NAV_MAP} = shift;
1687: $self->{ID} = shift;
1688:
1689: # Store this new resource in the parent nav map's cache.
1690: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1691:
1692: # A hash that can be used by two-pass algorithms to store data
1693: # about this resource in. Not used by the resource object
1694: # directly.
1695: $self->{DATA} = {};
1696:
1697: bless($self);
1698:
1699: return $self;
1700: }
1701:
1702: =pod
1703:
1704: =item * B<is_map>: Returns true if this is a map, false otherwise.
1705:
1706: =item * B<title>: Returns title.
1707:
1708: =item * B<type>: Returns the type of the resource, "start", "normal", or "finish".
1709:
1710: =item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
1711:
1712: =back
1713:
1714: =cut
1715:
1716: # private function: simplify the NAV_HASH lookups we keep doing
1717: # pass the name, and to automatically append my ID, pass a true val on the
1718: # second param
1719: sub navHash {
1720: my $self = shift;
1721: my $param = shift;
1722: my $id = shift;
1723: return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
1724: }
1725:
1726: # These info functions can be used directly, as they don't return
1727: # resource information.
1728: sub title { my $self=shift; return $self->navHash("title_", 1); }
1729: sub type { my $self=shift; return $self->navHash("type_", 1); }
1730: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
1731: # "to" can return a comma seperated list for branches
1732: sub to { my $self=shift; return $self->navHash("to_", 1); }
1733: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1734: sub src {
1735: my $self=shift;
1736: return $self->navHash("src_", 1);
1737: }
1738: sub symb {
1739: my $self=shift;
1740: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
1741: my $symbSrc = &Apache::lonnet::declutter($self->src());
1742: return &Apache::lonnet::declutter(
1743: $self->navHash('map_id_'.$first))
1744: . '___' . $second . '___' . $symbSrc;
1745: }
1746: sub is_problem {
1747: my $self=shift;
1748: my $src = $self->src();
1749: return ($src =~ /problem$/);
1750: }
1751: sub is_html {
1752: my $self=shift;
1753: my $src = $self->src();
1754: return ($src =~ /html$/);
1755: }
1756: sub is_sequence {
1757: my $self=shift;
1758: my $src = $self->src();
1759: return ($src =~ /sequence$/);
1760: }
1761: sub is_page {
1762: my $self=shift;
1763: my $src = $self->src();
1764: return ($src =~ /page$/);
1765: }
1766:
1767:
1768:
1769:
1770: # Move this into POD: In order to use these correctly, courseopt
1771: # and useropt need to be generated
1772: sub parmval {
1773: my $self = shift;
1774: my $what = shift;
1775: my $part = shift || "0";
1776: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
1777: }
1778:
1779: #####
1780: # Map Queries
1781: #####
1782:
1783: # These methods relate to whether or not the resource is a map, and the
1784: # attributes of that map.
1785:
1786: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
1787: sub map_finish {
1788: my $self = shift;
1789: my $src = $self->src();
1790: my $res = $self->navHash("map_finish_$src", 0);
1791: $res = $self->{NAV_MAP}->getById($res);
1792: return $res;
1793: }
1794: sub map_start {
1795: my $self = shift;
1796: my $src = $self->src();
1797: my $res = $self->navHash("map_start_$src", 0);
1798: $res = $self->{NAV_MAP}->getById($res);
1799: return $res;
1800: }
1801: sub map_pc {
1802: my $self = shift;
1803: my $src = $self->src();
1804: return $self->navHash("map_pc_$src", 0);
1805: }
1806: sub map_type {
1807: my $self = shift;
1808: my $pc = $self->map_pc();
1809: return $self->navHash("map_type_$pc", 0);
1810: }
1811:
1812:
1813:
1814: #####
1815: # Property queries
1816: #####
1817:
1818: # These functions will be responsible for returning the CORRECT
1819: # VALUE for the parameter, no matter what. So while they may look
1820: # like direct calls to parmval, they can be more then that.
1821: # So, for instance, the duedate function should use the "duedatetype"
1822: # information, rather then the resource object user.
1823:
1824: =pod
1825:
1826: =head2 Resource Parameters
1827:
1828: 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.
1829:
1830: 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.)
1831:
1832: =over 4
1833:
1834: =item * B<acc>: Get the Client IP/Name Access Control information.
1835:
1836: =item * B<answerdate>: Get the answer-reveal date for the problem.
1837:
1838: =item * B<duedate>: Get the due date for the problem.
1839:
1840: =item * B<tries>: Get the number of tries the student has used on the problem.
1841:
1842: =item * B<maxtries>: Get the number of max tries allowed.
1843:
1844: =item * B<opendate>: Get the open date for the problem.
1845:
1846: =item * B<sig>: Get the significant figures setting.
1847:
1848: =item * B<tol>: Get the tolerance for the problem.
1849:
1850: =item * B<type>: Get the question type for the problem.
1851:
1852: =item * B<weight>: Get the weight for the problem.
1853:
1854: =back
1855:
1856: =cut
1857:
1858: sub acc {
1859: (my $self, my $part) = @_;
1860: return $self->parmval("acc", $part);
1861: }
1862: sub answerdate {
1863: (my $self, my $part) = @_;
1864: # Handle intervals
1865: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
1866: return $self->duedate($part) +
1867: $self->parmval("answerdate", $part);
1868: }
1869: return $self->parmval("answerdate", $part);
1870: }
1871: sub duedate {
1872: (my $self, my $part) = @_;
1873: return $self->parmval("duedate", $part);
1874: }
1875: sub maxtries {
1876: (my $self, my $part) = @_;
1877: return $self->parmval("maxtries", $part);
1878: }
1879: sub opendate {
1880: (my $self, my $part) = @_;
1881: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
1882: return $self->duedate($part) -
1883: $self->parmval("opendate", $part);
1884: }
1885: return $self->parmval("opendate");
1886: }
1887: sub sig {
1888: (my $self, my $part) = @_;
1889: return $self->parmval("sig", $part);
1890: }
1891: sub tol {
1892: (my $self, my $part) = @_;
1893: return $self->parmval("tol", $part);
1894: }
1895: sub type {
1896: (my $self, my $part) = @_;
1897: return $self->parmval("type", $part);
1898: }
1899: sub weight {
1900: (my $self, my $part) = @_;
1901: return $self->parmval("weight", $part);
1902: }
1903: sub tries {
1904: my $self = shift;
1905: my $part = shift;
1906: $part = '0' if (!defined($part));
1907:
1908: # Make sure return hash is loaded, should error check
1909: $self->getReturnHash();
1910:
1911: my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
1912: if (!defined($tries)) {return '0';}
1913: return $tries;
1914: }
1915:
1916: # Multiple things need this
1917: sub getReturnHash {
1918: my $self = shift;
1919:
1920: if (!defined($self->{RETURN_HASH})) {
1921: my %tmpHash = &Apache::lonnet::restore($self->symb());
1922: $self->{RETURN_HASH} = \%tmpHash;
1923: }
1924: }
1925:
1926: ######
1927: # Status queries
1928: ######
1929:
1930: # These methods query the status of problems.
1931:
1932: # If we need to count parts, this function determines the number of
1933: # parts from the metadata. When called, it returns a reference to a list
1934: # of strings corresponding to the parts. (Thus, using it in a scalar context
1935: # tells you how many parts you have in the problem:
1936: # $partcount = scalar($resource->countParts());
1937: # Don't use $self->{PARTS} directly because you don't know if it's been
1938: # computed yet.
1939:
1940: =pod
1941:
1942: =head2 Resource misc
1943:
1944: Misc. functions for the resource.
1945:
1946: =over 4
1947:
1948: =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.)
1949:
1950: =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.
1951:
1952: =back
1953:
1954: =cut
1955:
1956: sub parts {
1957: my $self = shift;
1958:
1959: $self->extractParts();
1960: return $self->{PARTS};
1961: }
1962:
1963: sub countParts {
1964: my $self = shift;
1965:
1966: my $parts = $self->parts();
1967:
1968: if (scalar(@{$parts}) == 1) { return 1;}
1969:
1970: return scalar(@{$parts}) - 1;
1971: }
1972:
1973: # Private function: Extracts the parts information and saves it
1974: sub extractParts {
1975: my $self = shift;
1976:
1977: return if ($self->{PARTS});
1978:
1979: $self->{PARTS} = [];
1980:
1981: # Retrieve part count
1982: foreach (split(/\,/,&Apache::lonnet::metadata($self->src(),
1983: 'allpossiblekeys'))) {
1984: if ($_ =~ /^parameter\_(.*)\_opendate$/) {
1985: push @{$self->{PARTS}}, $1;
1986: }
1987: }
1988:
1989: # Is this possible to do in one line? - Jeremy
1990: my @sortedParts = sort @{$self->{PARTS}};
1991: $self->{PARTS} = \@sortedParts;
1992:
1993: return;
1994: }
1995:
1996: =pod
1997:
1998: =head2 Resource Status
1999:
2000: 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.
2001:
2002: There are two aspects to the status: the date-related information and the completion information.
2003:
2004: Idiomatic usage of these two methods would probably look something like
2005:
2006: foreach ($resource->parts()) {
2007: my $dateStatus = $resource->getDateStatus($_);
2008: my $completionStatus = $resource->getCompletionStatus($_);
2009:
2010: ... use it here ...
2011: }
2012:
2013: =over 4
2014:
2015: =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:
2016:
2017: =back
2018:
2019: B<Date Codes>
2020:
2021: =over 4
2022:
2023: =item * B<OPEN_LATER>: The problem will be opened later.
2024:
2025: =item * B<OPEN>: Open and not yet due.
2026:
2027: =item * B<PAST_DUE>: The due date has passed, but the answer date has not yet arrived.
2028:
2029: =item * B<ANSWER_OPEN>: The answer date is here.
2030:
2031: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2032:
2033: =back
2034:
2035: =cut
2036:
2037: # Apparently the compiler optimizes these into constants automatically
2038: sub OPEN_LATER { return 0; }
2039: sub OPEN { return 1; }
2040: sub PAST_DUE { return 2; }
2041: sub ANSWER_OPEN { return 3; }
1.53 ! bowersj2 2042: sub NOTHING_SET { return 4; }
1.51 bowersj2 2043: sub NETWORK_FAILURE { return 100; }
2044:
2045: sub getDateStatus {
2046: my $self = shift;
2047: my $part = shift;
2048: $part = "0" if (!defined($part));
2049: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2050:
2051: my $now = time();
2052:
1.53 ! bowersj2 2053: my $open = $self->opendate($part);
! 2054: my $due = $self->duedate($part);
! 2055: my $answer = $self->answerdate($part);
! 2056:
! 2057: if ($open && $now < $open) {return $self->OPEN_LATER};
! 2058: if ($due && $now < $due) {return $self->OPEN};
! 2059: if ($answer && $now < $answer) {return $self->PAST_DUE};
! 2060: if (!$open && !$due && !$answer) {
! 2061: # no data on the problem at all
! 2062: # should this be the same as "open later"? think multipart.
! 2063: return $self->NOTHING_SET;
! 2064: }
1.51 bowersj2 2065: return $self->ANSWER_OPEN;
2066: }
2067:
2068: =pod
2069:
2070: B<>
2071:
2072: =over 4
2073:
2074: =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:
2075:
2076: =back
2077:
2078: B<Completion Codes>
2079:
2080: =over 4
2081:
2082: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2083:
2084: =item * B<INCORRECT>: Attempted, but wrong by student.
2085:
2086: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2087:
2088: =item * B<CORRECT>: Correct or correct by instructor.
2089:
2090: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2091:
2092: =item * B<EXCUSED>: Excused. Not yet implemented.
2093:
2094: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2095:
2096: =back
2097:
2098: =cut
2099:
1.53 ! bowersj2 2100: sub NOT_ATTEMPTED { return 10; }
! 2101: sub INCORRECT { return 11; }
! 2102: sub INCORRECT_BY_OVERRIDE { return 12; }
! 2103: sub CORRECT { return 13; }
! 2104: sub CORRECT_BY_OVERRIDE { return 14; }
! 2105: sub EXCUSED { return 15; }
1.51 bowersj2 2106:
2107: sub getCompletionStatus {
2108: my $self = shift;
2109: my $part = shift;
2110: $part = "0" if (!defined($part));
2111: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2112:
2113: # Make sure return hash exists
2114: $self->getReturnHash();
2115:
2116: my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
2117:
2118: # Left as seperate if statements in case we ever do more with this
2119: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2120: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2121: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2122: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2123: if ($status eq 'excused') {return $self->EXCUSED; }
2124: return $self->NOT_ATTEMPTED;
2125: }
2126:
2127: =pod
2128:
2129: B<Composite Status>
2130:
2131: 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()):
2132:
2133: =over 4
2134:
2135: =item * NETWORK_FAILURE: The network has failed and the information is not available.
2136:
1.53 ! bowersj2 2137: =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.)
! 2138:
1.51 bowersj2 2139: =item * CORRECT: For any reason at all, the part is considered correct.
2140:
2141: =item * EXCUSED: For any reason at all, the problem is excused.
2142:
2143: =item * PAST_DUE: The problem is past due, and not considered correct.
2144:
2145: =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.
2146:
2147: =item * OPEN_LATER: The problem is not yet open.
2148:
2149: =item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.
2150:
2151: =item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.
2152:
2153: =item * OPEN: The item is open and not yet tried.
2154:
2155: =back
2156:
2157: =cut
2158:
2159: sub TRIES_LEFT { return 10; }
2160:
2161: sub status {
2162: my $self = shift;
2163: my $part = shift;
2164: if (!defined($part)) { $part = "0"; }
2165: my $completionStatus = $self->getCompletionStatus($part);
2166: my $dateStatus = $self->getDateStatus($part);
2167:
2168: # What we have is a two-dimensional matrix with 4 entries on one
2169: # dimension and 5 entries on the other, which we want to colorize,
1.53 ! bowersj2 2170: # plus network failure and "no date data".
1.51 bowersj2 2171:
1.53 ! bowersj2 2172: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 2173:
2174: # There are a few whole rows we can dispose of:
1.53 ! bowersj2 2175: if ($completionStatus == CORRECT ||
! 2176: $completionStatus == CORRECT_BY_OVERRIDE ) {
! 2177: return CORRECT();
! 2178: }
! 2179:
! 2180: # If it's EXCUSED, then return that no matter what
! 2181: if ($completionStatus == EXCUSED) {
! 2182: return EXCUSED;
1.51 bowersj2 2183: }
2184:
1.53 ! bowersj2 2185: if ($dateStatus == NOTHING_SET) {
! 2186: return NOTHING_SET;
1.51 bowersj2 2187: }
2188:
2189: # Now we're down to a 3 (incorrect, incorrect_override, not_attempted)
2190: # by 4 matrix (date status).
2191:
1.53 ! bowersj2 2192: if ($dateStatus == PAST_DUE) {
! 2193: return PAST_DUE;
1.51 bowersj2 2194: }
2195:
1.53 ! bowersj2 2196: if ($dateStatus == ANSWER_OPEN) {
! 2197: return ANSWER_OPEN;
1.51 bowersj2 2198: }
2199:
2200: # Now: (incorrect, incorrect_override, not_attempted) x
2201: # (open_later), (open)
2202:
1.53 ! bowersj2 2203: if ($dateStatus == OPEN_LATER) {
! 2204: return OPEN_LATER;
1.51 bowersj2 2205: }
2206:
2207: # If it's WRONG...
1.53 ! bowersj2 2208: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 2209: # and there are TRIES LEFT:
2210: if ($self->tries() < $self->maxtries()) {
1.53 ! bowersj2 2211: return TRIES_LEFT;
1.51 bowersj2 2212: }
1.53 ! bowersj2 2213: return INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 2214: }
2215:
2216: # Otherwise, it's untried and open
1.53 ! bowersj2 2217: return OPEN;
1.51 bowersj2 2218: }
2219:
2220: =pod
2221:
2222: =head2 Resource/Nav Map Navigation
2223:
2224: =over 4
2225:
2226: =item * B<getNext>(): Gets the next resource in the navmap after this one.
2227:
2228: =cut
2229:
2230: # For the simple single-link case, to get from a resource to the next
2231: # resource, you need to look up the "to_" link in the nav hash, then
2232: # follow that with the "goesto_" link.
2233:
2234: sub getNext {
2235: my $self = shift;
2236: my $alreadySeenHash = shift;
2237: my @branches;
2238: my $to = $self->to();
2239: foreach my $branch ( split(/\,/, $to) ) {
2240: my $choice = $self->{NAV_MAP}->getById($branch);
2241: my $next = $choice->goesto();
2242: $next = $self->{NAV_MAP}->getById($next);
2243:
2244: # Don't remember it if we've already seen it
2245: if (!defined($alreadySeenHash) ||
2246: !defined($alreadySeenHash->{$next->{ID}})) {
2247: push @branches, $next;
2248: }
2249: }
2250: return \@branches;
2251: }
2252:
2253: =pod
1.2 www 2254:
1.51 bowersj2 2255: =back
1.2 www 2256:
1.51 bowersj2 2257: =cut
1.2 www 2258:
1.51 bowersj2 2259: 1;
1.2 www 2260:
1.51 bowersj2 2261: __END__
1.2 www 2262:
2263:
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