Annotation of loncom/interface/lonnavmaps.pm, revision 1.66
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.66 ! bowersj2 4: # $Id: lonnavmaps.pm,v 1.65 2002/10/04 15:38:22 bowersj2 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
1.57 albertel 127: if (defined($uname)) {
128: if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
129: if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
130: if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
1.24 albertel 131: }
1.10 www 132:
1.24 albertel 133: # ------------------------------------------------------- second, check course
1.57 albertel 134: if (defined($csec)) {
135: if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
136: if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
137: if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
1.24 albertel 138: }
1.10 www 139:
1.57 albertel 140: if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
141: if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
142: if (defined($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};
1.57 albertel 147: if (defined($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');
1.57 albertel 152: if (defined($default)) { return $default}
1.25 albertel 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);
1.57 albertel 162: if (defined($partgeneral)) { return $partgeneral; }
1.51 bowersj2 163: } else {
164: my $resourcegeneral=&parmval("0.$qualifier",$symb);
1.57 albertel 165: if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51 bowersj2 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: # Initialize the nav map
823: my $navmap = Apache::lonnavmaps::navmap->new(
824: $ENV{"request.course.fn"}.".db",
825: $ENV{"request.course.fn"}."_parms.db", 1);
826:
1.55 bowersj2 827:
828: if (!defined($navmap)) {
829: my $requrl = $r->uri;
830: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
831: return HTTP_NOT_ACCEPTABLE;
832: }
1.64 bowersj2 833:
834: # Header
835: $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
836: ''));
837: $r->print('<script>window.focus();</script>');
838: my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
839: if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
840: my $date=localtime;
841: $r->print("<h3>$date</h3>\n");
842: $r->rflush();
1.65 bowersj2 843: if ($navmap->{LAST_CHECK}) {
1.66 ! bowersj2 844: $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
! 845: timeToHumanString($navmap->{LAST_CHECK}).
! 846: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
1.65 bowersj2 847: } else {
1.66 ! bowersj2 848: $r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
! 849: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
1.65 bowersj2 850: }
1.64 bowersj2 851: #if (($currenturl=~/^\/res/) &&
852: # ($currenturl!~/^\/res\/adm/)) {
853: # $r->print('<a href="#curloc">Current Location</a><p>');
854: #}
1.55 bowersj2 855:
856: # Check that it's defined
857: if (!($navmap->courseMapDefined())) {
858: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
859: '</body></html>');
860: return OK;
861: }
862:
1.51 bowersj2 863: # Grab a resource object so we have access to the constants; this
864: # is technically not proper, but should be harmless
865: my $res = $navmap->firstResource();
866:
867: # Defines a status->color mapping, null string means don't color
868: my %colormap =
1.54 bowersj2 869: ( $res->NETWORK_FAILURE => '',
1.59 bowersj2 870: $res->CORRECT => '',
1.54 bowersj2 871: $res->EXCUSED => '#BBBBFF',
1.59 bowersj2 872: $res->PAST_DUE_ANSWER_LATER => '',
873: $res->PAST_DUE_NO_ANSWER => '',
874: $res->ANSWER_OPEN => '#CCFFCC',
1.54 bowersj2 875: $res->OPEN_LATER => '',
1.59 bowersj2 876: $res->TRIES_LEFT => '',
877: $res->INCORRECT => '',
878: $res->OPEN => '',
1.54 bowersj2 879: $res->NOTHING_SET => '' );
1.59 bowersj2 880: # And a special case in the nav map; what to do when the assignment
881: # is not yet done and due in less then 24 hours
882: my $hurryUpColor = "#FFCCCC";
883:
884: my %statusIconMap =
1.66 ! bowersj2 885: ( $res->NETWORK_FAILURE => '',
! 886: $res->NOTHING_SET => '',
! 887: $res->CORRECT => 'navmap.correct.gif',
! 888: $res->EXCUSED => 'navmap.correct.gif',
! 889: $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
! 890: $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
! 891: $res->ANSWER_OPEN => 'navmap.wrong.gif',
! 892: $res->OPEN_LATER => '',
! 893: $res->TRIES_LEFT => 'navmap.open.gif',
! 894: $res->INCORRECT => 'navmap.wrong.gif',
! 895: $res->OPEN => 'navmap.open.gif' );
1.59 bowersj2 896:
897: my %condenseStatuses =
1.66 ! bowersj2 898: ( $res->NETWORK_FAILURE => 1,
! 899: $res->NOTHING_SET => 1,
! 900: $res->CORRECT => 1 );
1.51 bowersj2 901:
902: my %filterHash;
903: # Figure out what we're not displaying
904: foreach (split(/\,/, $ENV{"form.filter"})) {
905: if ($_) {
906: $filterHash{$_} = "1";
907: }
908: }
909:
1.63 bowersj2 910: my $currenturl = $ENV{'form.postdata'};
911: $currenturl=~s/^http\:\/\///;
912: $currenturl=~s/^[^\/]+//;
913: my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);
914:
1.66 ! bowersj2 915: $r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');
1.63 bowersj2 916:
1.51 bowersj2 917: # Begin the HTML table
1.59 bowersj2 918: # four cols: resource + indent, chat+feedback, icon, text string
1.51 bowersj2 919: $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
920:
1.66 ! bowersj2 921: my $condition = 0;
! 922: if ($ENV{'form.condition'}) {
! 923: $condition = 1;
! 924: }
! 925:
! 926: my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);
1.51 bowersj2 927: my $curRes = $mapIterator->next();
1.53 bowersj2 928: undef $res; # so we don't accidentally use it later
1.51 bowersj2 929: my $indentLevel = -1;
1.61 bowersj2 930: my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";
1.51 bowersj2 931:
932: my $isNewBranch = 0;
1.59 bowersj2 933: my $now = time();
934: my $in24Hours = $now + 24 * 60 * 60;
1.51 bowersj2 935:
936: while ($curRes != $mapIterator->END_NAV_MAP) {
937: if ($curRes == $mapIterator->BEGIN_MAP() ||
1.52 bowersj2 938: $curRes == $mapIterator->BEGIN_BRANCH()) {
1.51 bowersj2 939: $indentLevel++;
940: }
941: if ($curRes == $mapIterator->END_MAP() ||
1.52 bowersj2 942: $curRes == $mapIterator->END_BRANCH()) {
1.51 bowersj2 943: $indentLevel--;
944: }
1.52 bowersj2 945: if ($curRes == $mapIterator->BEGIN_BRANCH()) {
946: $isNewBranch = 1;
1.51 bowersj2 947: }
948:
949: if (ref($curRes) && $curRes->src()) {
950:
1.66 ! bowersj2 951: # Step one: Decide which parts to show
! 952: my @parts = @{$curRes->parts()};
! 953: my $multipart = scalar(@parts) > 1;
! 954: my $condensed = 0;
! 955:
1.51 bowersj2 956: if ($curRes->is_problem()) {
1.66 ! bowersj2 957: # Is it multipart?
1.59 bowersj2 958:
1.66 ! bowersj2 959: if ($multipart) {
! 960: # If it's multipart, see if part 0 is "open"
! 961: # if it is, display all parts, if it isn't,
! 962: # just display first
! 963: if (!$curRes->opendate("0")) {
! 964: @parts = ("0"); # just display the zero-th part
! 965: $condensed = 1;
! 966: } else {
! 967: # Otherwise, only display part 0 if we want to
! 968: # attach feedback or email information to it
! 969: if ($curRes->hasDiscussion() || $curRes->getFeedback()) {
! 970: shift @parts;
! 971: } else {
! 972: # If there's discussion or feedback, that counts
! 973: # as a difference, so display the parts.
! 974:
! 975: # Now, we decide whether to condense the
! 976: # parts due to similarity
! 977: my $status = $curRes->status($parts[1]);
! 978: my $due = $curRes->duedate($parts[1]);
! 979: my $open = $curRes->opendate($parts[1]);
! 980: my $statusAllSame = 1;
! 981: my $dueAllSame = 1;
! 982: my $openAllSame = 1;
! 983: for (my $i = 2; $i < scalar(@parts); $i++) {
! 984: if ($curRes->status($parts[$i]) != $status){
! 985: $statusAllSame = 0;
! 986: }
! 987: if ($curRes->duedate($parts[$i]) != $due ) {
! 988: $dueAllSame = 0;
! 989: }
! 990: if ($curRes->opendate($parts[$i]) != $open) {
! 991: $openAllSame = 0;
! 992: }
! 993: }
! 994:
! 995: # $allSame is true if all the statuses were
! 996: # the same. Now, if they are all the same and
! 997: # match one of the statuses to condense, or they
! 998: # are all open with the same due date, or they are
! 999: # all OPEN_LATER with the same open date, display the
! 1000: # status of the first non-zero part (to get the 'correct'
! 1001: # status right, since 0 is never 'correct' or 'open').
! 1002: if (($statusAllSame && defined($condenseStatuses{$status})) ||
! 1003: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
! 1004: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
! 1005: @parts = ($parts[1]);
! 1006: $condensed = 1;
! 1007: }
! 1008: }
! 1009: }
! 1010: }
1.59 bowersj2 1011:
1.51 bowersj2 1012: } else {
1013: @parts[0] = "0"; # this is to get past foreach loop below
1014: # you can consider a non-problem resource as a resource
1015: # with only one part without loss
1016: }
1017:
1.66 ! bowersj2 1018: # Display one part, in event of network error.
! 1019: # If this is a single part, we can at least show the correct
! 1020: # status, but if it's multipart, we're lost.
! 1021: if ($curRes->{RESOURCE_ERROR}) {
! 1022: @parts = ("0");
! 1023: }
! 1024:
! 1025: # Step two: Show the parts
1.51 bowersj2 1026: foreach my $part (@parts) {
1.59 bowersj2 1027:
1.66 ! bowersj2 1028: my $deltalevel = 0; # for inserting the branch icon
1.51 bowersj2 1029:
1030: # For each thing we're displaying...
1031:
1032: my $stack = $mapIterator->getStack();
1033: my $src = getLinkForResource($stack);
1034:
1035: my $srcHasQuestion = $src =~ /\?/;
1036: my $link = $src.
1037: ($srcHasQuestion?'&':'?') .
1038: 'symb='.&Apache::lonnet::escape($curRes->symb()).
1039: '"';
1040: my $title = $curRes->title();
1041: my $partLabel = "";
1.52 bowersj2 1042: my $newBranchText = "";
1043:
1044: # If this is a new branch, label it so
1045: # (temporary, this should be an icon w/ alt text)
1046: if ($isNewBranch) {
1.59 bowersj2 1047: $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
1.52 bowersj2 1048: $isNewBranch = 0;
1.66 ! bowersj2 1049: $deltalevel = 1;
1.52 bowersj2 1050: }
1.51 bowersj2 1051:
1052: # links to open and close the folders
1053: my $linkopen = "<a href=\"$link\">";
1054: my $linkclose = "</a>";
1055:
1.61 bowersj2 1056: my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
1.51 bowersj2 1057: if ($curRes->is_problem()) {
1.66 ! bowersj2 1058: if ($part eq "0" || $condensed) {
! 1059: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';
! 1060: } else {
! 1061: $icon = $indentString;
! 1062: }
1.51 bowersj2 1063: }
1064:
1065: # Display the correct icon, link to open or shut map
1066: if ($curRes->is_map()) {
1067: my $mapId = $curRes->map_pc();
1068: my $nowOpen = !defined($filterHash{$mapId});
1069: $icon = $nowOpen ?
1.63 bowersj2 1070: "folder_closed.gif" : "folder_opened.gif";
1.66 ! bowersj2 1071: $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
1.52 bowersj2 1072: $linkopen = "<a href=\"/adm/navmaps?filter=";
1.66 ! bowersj2 1073: $linkopen .= ($nowOpen xor $condition) ?
1.51 bowersj2 1074: addToFilter(\%filterHash, $mapId) :
1075: removeFromFilter(\%filterHash, $mapId);
1.66 ! bowersj2 1076: $linkopen .= "&condition=$condition&$queryAdd\">";
1.51 bowersj2 1077: $linkclose = "</a>";
1078:
1079: }
1080:
1081: my $colorizer = "";
1082: if ($curRes->is_problem()) {
1083: my $status = $curRes->status($part);
1084: my $color = $colormap{$status};
1085: if ($color ne "") {
1086: $colorizer = "bgcolor=\"$color\"";
1087: }
1088: }
1089:
1.66 ! bowersj2 1090: # FIRST COL: The resource indentation, branch icon, and name
! 1091: $r->print(" <tr><td align=\"left\" valign=\"bottom\">\n");
1.51 bowersj2 1092:
1093: # print indentation
1.59 bowersj2 1094: for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
1.51 bowersj2 1095: $r->print($indentString);
1096: }
1097:
1.61 bowersj2 1098: $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");
1.51 bowersj2 1099:
1.66 ! bowersj2 1100: my $nonLinkedText = "";
! 1101:
1.61 bowersj2 1102: if ($curRes->is_problem() && $part != "0" && !$condensed) {
1.66 ! bowersj2 1103: $partLabel = " (Part $part)";
! 1104: $title = "";
! 1105: }
! 1106: if ($multipart && $condensed) {
! 1107: $nonLinkedText = ' (' . $curRes->countParts() . ' parts)';
! 1108: }
1.59 bowersj2 1109:
1.66 ! bowersj2 1110: $r->print(" <a href=\"$link\">$title$partLabel</a> $nonLinkedText");
! 1111:
! 1112: if ($curRes->{RESOURCE_ERROR}) {
! 1113: $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
! 1114: '<font size="-1">Host down</font>'));
! 1115: }
! 1116:
! 1117: my $discussionHTML = ""; my $feedbackHTML = "";
! 1118:
! 1119: # SECOND COL: Is there text or feedback?
! 1120: if ($curRes->hasDiscussion()) {
! 1121: $discussionHTML = $linkopen .
! 1122: '<img border="0" src="/adm/lonMisc/chat.gif" />' .
! 1123: $linkclose;
! 1124: }
! 1125:
! 1126: if ($curRes->getFeedback()) {
! 1127: my $feedback = $curRes->getFeedback();
! 1128: foreach (split(/\,/, $feedback)) {
! 1129: if ($_) {
! 1130: $feedbackHTML .= ' <a href="/adm/email?display='
! 1131: . &Apache::lonnet::escape($_) . '">'
! 1132: . '<img src="/adm/lonMisc/feedback.gif" '
! 1133: . 'border="0" /></a>';
! 1134: }
! 1135: }
! 1136: }
! 1137:
! 1138: $r->print("<td align=\"left\" valign=\"bottom\">$discussionHTML$feedbackHTML</td>");
! 1139:
! 1140: # Is this the first displayed part of a multi-part problem
! 1141: # that has not been condensed, so we should suppress these two
! 1142: # columns?
! 1143: my $firstDisplayed = !$condensed && $multipart && $part eq "0";
! 1144:
! 1145: # THIRD ROW: Problem status icon
! 1146: if ($curRes->is_problem() &&
! 1147: !$firstDisplayed) {
! 1148: my $icon = $statusIconMap{$curRes->status($part)};
! 1149: if ($icon) {
! 1150: $r->print("<td valign=\"bottom\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");
! 1151: } else {
! 1152: $r->print("<td></td>\n");
! 1153: }
! 1154: } else { # not problem, no icon
! 1155: $r->print("<td></td>\n");
! 1156: }
! 1157:
! 1158: # FOURTH ROW: Text description
! 1159: $r->print("<td $colorizer align=\"right\" valign=\"bottom\">\n");
1.51 bowersj2 1160:
1.61 bowersj2 1161: if ($curRes->kind() eq "res" &&
1162: $curRes->is_problem() &&
1.66 ! bowersj2 1163: !$firstDisplayed) {
1.53 bowersj2 1164: $r->print (getDescription($curRes, $part));
1.51 bowersj2 1165: }
1.59 bowersj2 1166:
1.66 ! bowersj2 1167: $r->print("</td></tr>\n");
1.51 bowersj2 1168: }
1169: }
1170: $curRes = $mapIterator->next();
1171: }
1172:
1173: $r->print("</table></body></html>");
1174:
1.59 bowersj2 1175: $navmap->untieHashes();
1176:
1.51 bowersj2 1177: return OK;
1178: }
1179:
1180: # Convenience functions: Returns a string that adds or subtracts
1181: # the second argument from the first hash, appropriate for the
1182: # query string that determines which folders to recurse on
1183: sub addToFilter {
1184: my $hashIn = shift;
1185: my $addition = shift;
1186: my %hash = %$hashIn;
1187: $hash{$addition} = 1;
1188:
1189: return join (",", keys(%hash));
1190: }
1191:
1192: sub removeFromFilter {
1193: my $hashIn = shift;
1194: my $subtraction = shift;
1195: my %hash = %$hashIn;
1196:
1197: delete $hash{$subtraction};
1198: return join(",", keys(%hash));
1199: }
1200:
1201: # Convenience function: Given a stack returned from getStack on the iterator,
1202: # return the correct src() value.
1203: # Later, this should add an anchor when we start putting anchors in pages.
1204: sub getLinkForResource {
1205: my $stack = shift;
1206: my $res;
1207:
1208: # Check to see if there are any pages in the stack
1209: foreach $res (@$stack) {
1210: if (defined($res) && $res->is_page()) {
1211: return $res->src();
1212: }
1213: }
1214:
1215: # Failing that, return the src of the last resource that is defined
1216: # (when we first recurse on a map, it puts an undefined resource
1217: # on the bottom because $self->{HERE} isn't defined yet, and we
1218: # want the src for the map anyhow)
1219: foreach (@$stack) {
1220: if (defined($_)) { $res = $_; }
1221: }
1222:
1223: return $res->src();
1224: }
1225:
1.53 bowersj2 1226: # Convenience function: This seperates the logic of how to create
1227: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
1228: # etc.) into a seperate function. It takes a resource object as the
1229: # first parameter, and the part number of the resource as the second.
1230: # It's basically a big switch statement on the status of the resource.
1231:
1232: sub getDescription {
1233: my $res = shift;
1234: my $part = shift;
1235: my $status = $res->getDateStatus();
1236:
1237: if ($status == $res->NETWORK_FAILURE) { return ""; }
1238: if ($status == $res->NOTHING_SET) {
1239: return "Not currently assigned.";
1240: }
1241: if ($status == $res->OPEN_LATER) {
1242: return "Opens: " . timeToHumanString($res->opendate($part));
1243: }
1244: if ($status == $res->OPEN) {
1.66 ! bowersj2 1245: if ($res->duedate()) {
! 1246: return "Due: $status " . timeToHumanString($res->duedate($part));
! 1247: } else {
! 1248: return "Open, no due date";
! 1249: }
1.53 bowersj2 1250: }
1.54 bowersj2 1251: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.59 bowersj2 1252: return "Answer opens: " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 1253: }
1254: if ($status == $res->PAST_DUE_NO_ANSWER) {
1255: return "Was Due: " . timeToHumanString($res->duedate($part));
1.53 bowersj2 1256: }
1257: if ($status == $res->ANSWER_OPEN) {
1258: return "Answer available";
1259: }
1.59 bowersj2 1260: if ($status == $res->EXCUSED) {
1.66 ! bowersj2 1261: return "Excused by instructor";
1.59 bowersj2 1262: }
1263: if ($status == $res->TRIES_LEFT) {
1.66 ! bowersj2 1264: my $tries = $res->tries();
! 1265: my $maxtries = $res->maxtries();
! 1266: my $triesString = "($tries of $maxtries tries used)";
! 1267: if ($res->duedate()) {
! 1268: return "Due: $status " . timeToHumanString($res->duedate($part)) .
! 1269: " $triesString";
! 1270: } else {
! 1271: return "No due date $triesString";
! 1272: }
1.59 bowersj2 1273: }
1.53 bowersj2 1274: }
1275:
1276: # I want to change this into something more human-friendly. For
1277: # now, this is a simple call to localtime. The final function
1278: # probably belongs in loncommon.
1279: sub timeToHumanString {
1.58 albertel 1280: my ($time) = @_;
1281: # zero, '0' and blank are bad times
1282: if ($time) {
1.66 ! bowersj2 1283: return localtime($time);
1.58 albertel 1284: } else {
1.66 ! bowersj2 1285: return 'Never';
1.58 albertel 1286: }
1.53 bowersj2 1287: }
1288:
1.51 bowersj2 1289: 1;
1290:
1291: package Apache::lonnavmaps::navmap;
1292:
1293: # LEFT:
1294: # * Actual handler code (multi-part)
1295: # * Branches (aieee!) (and conditionals)
1296:
1297: =pod
1298:
1299: 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.
1300:
1301: =head1 navmap object: Encapsulating the compiled nav map
1302:
1303: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
1304:
1305: 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.
1306:
1307: You must obtain resource objects through the navmap object.
1308:
1309: =head2 Methods
1310:
1311: =over 4
1312:
1.55 bowersj2 1313: =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.
1.51 bowersj2 1314:
1315: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
1316:
1317: =cut
1318:
1319: use strict;
1320: use GDBM_File;
1321:
1322: sub new {
1323: # magic invocation to create a class instance
1324: my $proto = shift;
1325: my $class = ref($proto) || $proto;
1326: my $self = {};
1327:
1328: $self->{NAV_HASH_FILE} = shift;
1329: $self->{PARM_HASH_FILE} = shift;
1330: $self->{GENERATE_COURSE_USER_OPT} = shift;
1.55 bowersj2 1331: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1.51 bowersj2 1332:
1333: # Resource cache stores navmapresource's as we reference them. We generate
1334: # them on-demand so we don't pay for creating resources unless we use them.
1335: $self->{RESOURCE_CACHE} = {};
1336:
1337: # Network failure flag, if we accessed the course or user opt and
1338: # failed
1339: $self->{NETWORK_FAILURE} = 0;
1340:
1341: # tie the nav hash
1342: my %navmaphash;
1343: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
1344: &GDBM_READER(), 0640))) {
1345: return undef;
1346: }
1347: $self->{NAV_HASH} = \%navmaphash;
1348:
1349: my %parmhash;
1350: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
1351: &GDBM_READER(), 0640)))
1352: {
1.66 ! bowersj2 1353: untie $self->{PARM_HASH};
1.51 bowersj2 1354: return undef;
1355: }
1356: $self->{PARM_HASH} = \%parmhash;
1357: $self->{HASH_TIED} = 1;
1358:
1359: # If the course opt hash and the user opt hash should be generated,
1360: # generate them
1361: if ($self->{GENERATE_COURSE_USER_OPT}) {
1362: my $uname=$ENV{'user.name'};
1363: my $udom=$ENV{'user.domain'};
1364: my $uhome=$ENV{'user.home'};
1365: my $cid=$ENV{'request.course.id'};
1366: my $chome=$ENV{'course.'.$cid.'.home'};
1367: my ($cdom,$cnum)=split(/\_/,$cid);
1368:
1369: my $userprefix=$uname.'_'.$udom.'_';
1370:
1371: my %courserdatas; my %useropt; my %courseopt;
1372: unless ($uhome eq 'no_host') {
1373: # ------------------------------------------------- Get coursedata (if present)
1374: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1375: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1376: ':resourcedata',$chome);
1377: if ($reply!~/^error\:/) {
1378: $courserdatas{$cid}=$reply;
1379: $courserdatas{$cid.'.last_cache'}=time;
1380: }
1381: # check to see if network failed
1382: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1383: {
1384: $self->{NETWORK_FAILURE} = 1;
1385: }
1386: }
1387: foreach (split(/\&/,$courserdatas{$cid})) {
1388: my ($name,$value)=split(/\=/,$_);
1389: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1390: &Apache::lonnet::unescape($value);
1391: }
1392: # --------------------------------------------------- Get userdata (if present)
1393: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1394: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1395: if ($reply!~/^error\:/) {
1396: $userrdatas{$uname.'___'.$udom}=$reply;
1397: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1398: }
1399: # check to see if network failed
1400: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1401: {
1402: $self->{NETWORK_FAILURE} = 1;
1403: }
1404: }
1405: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1406: my ($name,$value)=split(/\=/,$_);
1407: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1408: &Apache::lonnet::unescape($value);
1409: }
1.55 bowersj2 1410: $self->{COURSE_OPT} = \%courseopt;
1411: $self->{USER_OPT} = \%useropt;
1.51 bowersj2 1412: }
1413: }
1414:
1.55 bowersj2 1415: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
1416: my $cid=$ENV{'request.course.id'};
1417: my ($cdom,$cnum)=split(/\_/,$cid);
1418:
1419: my %emailstatus = &Apache::lonnet::dump('email_status');
1.56 bowersj2 1420: my $logoutTime = $emailstatus{'logout'};
1421: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1.55 bowersj2 1422: $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
1423: $courseLeaveTime : $logoutTime);
1.56 bowersj2 1424: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1.55 bowersj2 1425: $cdom, $cnum);
1426: my %feedback=();
1427: my %error=();
1428: my $keys = &Apache::lonnet::reply('keys:'.
1429: $ENV{'user.domain'}.':'.
1430: $ENV{'user.name'}.':nohist_email',
1431: $ENV{'user.home'});
1432:
1433: foreach my $msgid (split(/\&/, $keys)) {
1434: $msgid=&Apache::lonnet::unescape($msgid);
1435: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1436: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1437: my ($what,$url)=($1,$2);
1438: my %status=
1439: &Apache::lonnet::get('email_status',[$msgid]);
1440: if ($status{$msgid}=~/^error\:/) {
1441: $status{$msgid}='';
1442: }
1443:
1444: if (($status{$msgid} eq 'new') ||
1445: (!$status{$msgid})) {
1446: if ($what eq 'Error') {
1447: $error{$url}.=','.$msgid;
1448: } else {
1449: $feedback{$url}.=','.$msgid;
1450: }
1451: }
1452: }
1453: }
1454:
1455: $self->{FEEDBACK} = \%feedback;
1456: $self->{ERROR_MSG} = \%error; # what is this? JB
1457: $self->{DISCUSSION_TIME} = \%discussiontime;
1458: $self->{EMAIL_STATUS} = \%emailstatus;
1459:
1460: }
1461:
1.51 bowersj2 1462: bless($self);
1.55 bowersj2 1463:
1464: return $self;
1465: }
1.51 bowersj2 1466:
1.55 bowersj2 1467: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1468: sub courseMapDefined {
1469: my $self = shift;
1470: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1471:
1.56 bowersj2 1472: my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
1473: my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
1.55 bowersj2 1474: return $firstres && $lastres;
1.51 bowersj2 1475: }
1476:
1477: sub getIterator {
1478: my $self = shift;
1479: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.63 bowersj2 1480: shift, undef, shift);
1.51 bowersj2 1481: return $iterator;
1482: }
1483:
1484: # unties the hash when done
1485: sub untieHashes {
1486: my $self = shift;
1.60 bowersj2 1487: untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
1488: untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
1.51 bowersj2 1489: $self->{HASH_TIED} = 0;
1490: }
1491:
1492: # when the object is destroyed, be sure to untie all the hashes we tied.
1493: sub DESTROY {
1494: my $self = shift;
1495: $self->untieHashes();
1496: }
1497:
1.59 bowersj2 1498: # Private function: Does the given resource (as a symb string) have
1499: # current discussion? Returns 0 if chat/mail data not extracted.
1500: sub hasDiscussion {
1501: my $self = shift;
1502: my $symb = shift;
1503: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
1504:
1505: return $self->{DISCUSSION_TIME}->{$symb} >
1.66 ! bowersj2 1506: $self->{LAST_CHECK};
1.59 bowersj2 1507: }
1508:
1509: # Private function: Does the given resource (as a symb string) have
1510: # current feedback? Returns the string in the feedback hash, which
1511: # will be false if it does not exist.
1512: sub getFeedback {
1513: my $self = shift;
1514: my $symb = shift;
1515:
1516: if (!defined($self->{FEEDBACK})) { return ""; }
1517:
1518: return $self->{FEEDBACK}->{$symb};
1519: }
1520:
1.51 bowersj2 1521: =pod
1522:
1523: =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.
1524:
1525: =cut
1526:
1527: # The strategy here is to cache the resource objects, and only construct them
1528: # as we use them. The real point is to prevent reading any more from the tied
1529: # hash then we have to, which should hopefully alleviate speed problems.
1530: # Caching is just an incidental detail I throw in because it makes sense.
1531:
1532: sub getById {
1533: my $self = shift;
1534: my $id = shift;
1535:
1536: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1537: {
1538: return $self->{RESOURCE_CACHE}->{$id};
1539: }
1540:
1541: # resource handles inserting itself into cache.
1542: return Apache::lonnavmaps::resource->new($self, $id);
1543: }
1544:
1545: =pod
1546:
1547: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1548:
1549: =cut
1550:
1551: sub firstResource {
1552: my $self = shift;
1553: my $firstResource = $self->{NAV_HASH}->{'map_start_' .
1554: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1555: return $self->getById($firstResource);
1556: }
1557:
1558: =pod
1559:
1560: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1561:
1562: =cut
1563:
1564: sub finishResource {
1565: my $self = shift;
1566: my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
1567: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1568: return $self->getById($firstResource);
1569: }
1570:
1571: # -------------------------------------------- Figure out a cascading parameter
1572: #
1573: # For this function to work
1574: #
1575: # * parmhash needs to be tied
1576: # * courseopt and useropt need to be initialized for this user and course
1577: #
1578:
1579: sub parmval {
1580: my $self = shift;
1581: my ($what,$symb)=@_;
1582: my $cid=$ENV{'request.course.id'};
1583: my $csec=$ENV{'request.course.sec'};
1584: my $uname=$ENV{'user.name'};
1585: my $udom=$ENV{'user.domain'};
1586:
1587: unless ($symb) { return ''; }
1588: my $result='';
1589:
1590: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1591:
1592: # ----------------------------------------------------- Cascading lookup scheme
1593: my $rwhat=$what;
1594: $what=~s/^parameter\_//;
1595: $what=~s/\_/\./;
1596:
1597: my $symbparm=$symb.'.'.$what;
1598: my $mapparm=$mapname.'___(all).'.$what;
1599: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1600:
1601: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1602: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1603: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1604:
1605: my $courselevel= $usercourseprefix.'.'.$what;
1606: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1607: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1608:
1609: my $useropt = $self->{USER_OPT};
1610: my $courseopt = $self->{COURSE_OPT};
1611: my $parmhash = $self->{PARM_HASH};
1612:
1613: # ---------------------------------------------------------- first, check user
1614: if ($uname and defined($useropt)) {
1.57 albertel 1615: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
1616: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
1617: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
1.51 bowersj2 1618: }
1619:
1620: # ------------------------------------------------------- second, check course
1621: if ($csec and defined($courseopt)) {
1.57 albertel 1622: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
1623: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
1624: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
1.51 bowersj2 1625: }
1626:
1627: if (defined($courseopt)) {
1.57 albertel 1628: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
1629: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
1630: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
1.51 bowersj2 1631: }
1632:
1633: # ----------------------------------------------------- third, check map parms
1634:
1635: my $thisparm=$$parmhash{$symbparm};
1.57 albertel 1636: if (defined($thisparm)) { return $thisparm; }
1.51 bowersj2 1637:
1638: # ----------------------------------------------------- fourth , check default
1639:
1640: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57 albertel 1641: if (defined($default)) { return $default}
1.51 bowersj2 1642:
1643: # --------------------------------------------------- fifth , cascade up parts
1644:
1645: my ($space,@qualifier)=split(/\./,$rwhat);
1646: my $qualifier=join('.',@qualifier);
1647: unless ($space eq '0') {
1648: my ($part,$id)=split(/\_/,$space);
1649: if ($id) {
1650: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1.57 albertel 1651: if (defined($partgeneral)) { return $partgeneral; }
1.51 bowersj2 1652: } else {
1653: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1.57 albertel 1654: if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51 bowersj2 1655: }
1656: }
1657: return '';
1658: }
1659:
1660:
1661: 1;
1662:
1663: package Apache::lonnavmaps::iterator;
1664:
1665: # This package must precede "navmap" because "navmap" uses it. In
1666: # order to keep the documentation order straight, the iterator is documented
1667: # after the navmap object.
1668:
1669: =pod
1670:
1671: =back
1672:
1673: =head1 navmap Iterator
1674:
1675: 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.
1676:
1677: 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:
1678:
1679: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1680:
1681: To get the next thing from the iterator, call B<next>:
1682:
1683: C<my $nextThing = $resourceIterator-E<gt>next()>
1684:
1685: getIterator behaves as follows:
1686:
1687: =over 4
1688:
1.63 bowersj2 1689: =item B<getIterator>(nav_map, firstResource, finishResource, filterHash, condition): 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 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to.
1.51 bowersj2 1690:
1691: 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.
1692:
1693: 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:
1694:
1695: =over 4
1696:
1697: =item * some list of tokens here
1698:
1699: =back
1700:
1701: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
1702:
1703: =cut
1704:
1705: # Here are the tokens for the iterator:
1706:
1707: sub END_NAV_MAP { return 0; } # Represents end of entire nav map
1708: sub BEGIN_MAP { return 1; } # begining of a new map
1709: sub END_MAP { return 2; } # end of the map
1710: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1711: sub END_BRANCH { return 4; } # end of a branch
1712:
1713: # Params: nav map, start resource, end resource, filter, condition,
1714: # already seen hash ref
1715:
1716: sub new {
1717: # magic invocation to create a class instance
1718: my $proto = shift;
1719: my $class = ref($proto) || $proto;
1720: my $self = {};
1721:
1722: $self->{NAV_MAP} = shift;
1723: return undef unless ($self->{NAV_MAP});
1724:
1725: # Handle the parameters
1726: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1727: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1728:
1729: # If the given resources are just the ID of the resource, get the
1730: # objects
1731: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1732: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1733: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1734: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1735:
1736: $self->{FILTER} = shift;
1737:
1738: # A hash, used as a set, of resource already seen
1739: $self->{ALREADY_SEEN} = shift;
1740: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 1741: $self->{CONDITION} = shift;
1.51 bowersj2 1742:
1743: # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
1744: $self->{STARTED} = 0;
1745:
1746: # Should we continue calling the recursive iterator, if any?
1747: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1748: # The recursive iterator, if any
1749: $self->{RECURSIVE_ITERATOR} = undef;
1750: # Are we recursing on a map, or a branch?
1751: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
1752: # And the count of how deep it is, so that this iterator can keep track of
1753: # when to pick back up again.
1754: $self->{RECURSIVE_DEPTH} = 0;
1755:
1756: # For keeping track of our branches, we maintain our own stack
1757: $self->{BRANCH_STACK} = [];
1758: # If the size shrinks, we exhausted a branch
1759: $self->{BRANCH_STACK_SIZE} = 0;
1760: $self->{BRANCH_DEPTH} = 0;
1761:
1762: # For returning two things in a forced sequence
1763: $self->{FORCE_NEXT} = undef;
1764:
1765: # Start with the first resource
1766: push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
1767: $self->{BRANCH_STACK_SIZE} = 1;
1768:
1769: bless($self);
1770: return $self;
1771: }
1772:
1773: # Note... this function is *touchy*. I strongly recommend tracing
1774: # through it with the debugger a few times on a non-trivial map before
1775: # modifying it. Order is *everything*.
1776: sub next {
1777: my $self = shift;
1778:
1779: # Iterator logic goes here
1780:
1781: # Is this return value pre-determined?
1782: if (defined($self->{FORCE_NEXT})) {
1783: my $tmp = $self->{FORCE_NEXT};
1784: $self->{FORCE_NEXT} = undef;
1785: return $tmp;
1786: }
1787:
1788: # Are we using a recursive iterator? If so, pull from that and
1789: # watch the depth; we want to resume our level at the correct time.
1790: if ($self->{RECURSIVE_ITERATOR_FLAG})
1791: {
1792: # grab the next from the recursive iterator
1793: my $next = $self->{RECURSIVE_ITERATOR}->next();
1794:
1795: # is it a begin or end map? Update depth if so
1796: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1797: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1798:
1799: # Are we back at depth 0? If so, stop recursing.
1800: if ($self->{RECURSIVE_DEPTH} == 0) {
1801: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1802: }
1803:
1804: return $next;
1805: }
1806:
1807: # Is there a current resource to grab? If not, then return
1808: # END_BRANCH and END_MAP in succession.
1809: if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
1810: if ($self->{BRANCH_DEPTH} > 0) {
1811: $self->{FORCE_NEXT} = $self->END_MAP();
1.52 bowersj2 1812: $self->{BRANCH_DEPTH}--;
1.51 bowersj2 1813: return $self->END_BRANCH();
1814: } else {
1815: return $self->END_MAP();
1816: }
1817: }
1818:
1819: # Have we not yet begun? If not, return BEGIN_MAP and
1820: # remember that we've started.
1821: if ( !$self->{STARTED} ) {
1822: $self->{STARTED} = 1;
1823: return $self->BEGIN_MAP;
1824: }
1825:
1826: # Did the branch stack shrink since last run? If so,
1827: # we exhausted a branch last time, therefore, we're about
1828: # to start a new one. (We know because we already checked to see
1829: # if the stack was empty.)
1830: if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
1.52 bowersj2 1831: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1832: $self->{BRANCH_DEPTH}++;
1833: return $self->BEGIN_BRANCH();
1.51 bowersj2 1834: }
1835:
1.52 bowersj2 1836: # Remember the size for comparision next time.
1837: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1838:
1839: # If the next resource we mean to return is going to need
1840: # a lower branch level, terminate branches until we get
1841: # there.
1842:
1.51 bowersj2 1843: # Get the next resource in the branch
1844: $self->{HERE} = pop @{$self->{BRANCH_STACK}};
1.52 bowersj2 1845:
1846: # Are we at the right depth? If not, close a branch and return
1847: # the current resource onto the branch stack
1848: if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH})
1849: && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} <
1850: $self->{BRANCH_DEPTH} ) {
1851: $self->{BRANCH_DEPTH}--;
1852: # return it so we can pick it up eventually
1853: push @{$self->{BRANCH_STACK}}, $self->{HERE};
1854: return $self->END_BRANCH();
1855: }
1856:
1.51 bowersj2 1857: # We always return it after this point and never before
1858: # (proof: look at just the return statements), so we
1859: # remember that we've seen this.
1860: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
1861:
1862: # Are we at the utter end? If so, return the END_NAV_MAP marker.
1863: if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
1.52 bowersj2 1864: $self->{FORCE_NEXT} = $self->END_NAV_MAP;
1.51 bowersj2 1865: return $self->{HERE};
1866: }
1867:
1868: # Get the next possible resources
1869: my $nextUnfiltered = $self->{HERE}->getNext();
1870: my $next = [];
1871:
1872: # filter the next possibilities to remove things we've
1.52 bowersj2 1873: # already seen. Also, remember what branch depth they should
1874: # be displayed at, since there's no other reliable way to tell.
1.51 bowersj2 1875: foreach (@$nextUnfiltered) {
1.52 bowersj2 1876: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1877: push @$next, $_;
1878: $_->{DATA}->{ITERATOR_DEPTH} =
1879: $self->{BRANCH_DEPTH} + 1;
1880: }
1.51 bowersj2 1881: }
1882:
1883: # Handle branch cases:
1884: # Nothing is available next: BRANCH_END
1885: # 1 thing next: standard non-branch
1886: # 2+ things next: have some branches
1887: my $nextCount = scalar(@$next);
1888: if ($nextCount == 0) {
1.52 bowersj2 1889: # Return this and on the next run, close the branch up if we're
1890: # in a branch
1891: if ($self->{BRANCH_DEPTH} > 0 ) {
1892: $self->{FORCE_NEXT} = $self->END_BRANCH();
1893: $self->{BRANCH_DEPTH}--;
1894: }
1.51 bowersj2 1895: return $self->{HERE};
1896: }
1897:
1898: while (@$next) {
1899: # copy the next possibilities over to the branch stack
1900: # in the right order
1.52 bowersj2 1901: push @{$self->{BRANCH_STACK}}, shift @$next;
1.51 bowersj2 1902: }
1903:
1904: if ($nextCount >= 2) {
1.52 bowersj2 1905: $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
1906: $self->{BRANCH_DEPTH}++;
1.51 bowersj2 1907: return $self->{HERE};
1908: }
1909:
1910: # If this is a map and we want to recurse down it... (not filtered out)
1911: if ($self->{HERE}->is_map() &&
1.63 bowersj2 1912: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 1913: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
1914: my $firstResource = $self->{HERE}->map_start();
1915: my $finishResource = $self->{HERE}->map_finish();
1916:
1917: # Odd perl syntax here; $self->new allows one to create a new iterator
1918: # can't figure out how to ref this package directly correctly
1919: # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
1920: $self->{RECURSIVE_ITERATOR} =
1921: Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 1922: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.66 ! bowersj2 1923: $self->{CONDITION});
1.51 bowersj2 1924: }
1925:
1926: return $self->{HERE};
1927: }
1928:
1929: =pod
1930:
1931: 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).
1932:
1933: =cut
1934:
1935: sub getStack {
1936: my $self=shift;
1937:
1938: my @stack;
1939:
1940: $self->populateStack(\@stack);
1941:
1942: return \@stack;
1943: }
1944:
1945: # Private method: Calls the iterators recursively to populate the stack.
1946: sub populateStack {
1947: my $self=shift;
1948: my $stack = shift;
1949:
1950: push @$stack, $self->{HERE};
1951:
1952: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1953: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
1954: }
1955: }
1956:
1.1 www 1957: 1;
1.2 www 1958:
1.51 bowersj2 1959: package Apache::lonnavmaps::resource;
1960:
1961: use Apache::lonnet;
1962:
1963: =pod
1964:
1965: =head1 Object: resource
1966:
1967: 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.
1968:
1969: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
1970:
1971: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
1972:
1973: =head2 Public Members
1974:
1975: 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.
1976:
1977: =head2 Methods
1978:
1979: =over 4
1980:
1981: =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.
1982:
1983: =cut
1984:
1985: sub new {
1986: # magic invocation to create a class instance
1987: my $proto = shift;
1988: my $class = ref($proto) || $proto;
1989: my $self = {};
1990:
1991: $self->{NAV_MAP} = shift;
1992: $self->{ID} = shift;
1993:
1994: # Store this new resource in the parent nav map's cache.
1995: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 ! bowersj2 1996: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 1997:
1998: # A hash that can be used by two-pass algorithms to store data
1999: # about this resource in. Not used by the resource object
2000: # directly.
2001: $self->{DATA} = {};
2002:
2003: bless($self);
2004:
2005: return $self;
2006: }
2007:
2008: =pod
2009:
2010: =item * B<is_map>: Returns true if this is a map, false otherwise.
2011:
2012: =item * B<title>: Returns title.
2013:
2014: =item * B<type>: Returns the type of the resource, "start", "normal", or "finish".
2015:
2016: =item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
2017:
2018: =back
2019:
2020: =cut
2021:
2022: # private function: simplify the NAV_HASH lookups we keep doing
2023: # pass the name, and to automatically append my ID, pass a true val on the
2024: # second param
2025: sub navHash {
2026: my $self = shift;
2027: my $param = shift;
2028: my $id = shift;
2029: return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
2030: }
2031:
2032: # These info functions can be used directly, as they don't return
2033: # resource information.
2034: sub title { my $self=shift; return $self->navHash("title_", 1); }
2035: sub type { my $self=shift; return $self->navHash("type_", 1); }
2036: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
2037: # "to" can return a comma seperated list for branches
2038: sub to { my $self=shift; return $self->navHash("to_", 1); }
2039: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
2040: sub src {
2041: my $self=shift;
2042: return $self->navHash("src_", 1);
2043: }
2044: sub symb {
2045: my $self=shift;
2046: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
2047: my $symbSrc = &Apache::lonnet::declutter($self->src());
2048: return &Apache::lonnet::declutter(
2049: $self->navHash('map_id_'.$first))
2050: . '___' . $second . '___' . $symbSrc;
2051: }
2052: sub is_problem {
2053: my $self=shift;
2054: my $src = $self->src();
2055: return ($src =~ /problem$/);
2056: }
2057: sub is_html {
2058: my $self=shift;
2059: my $src = $self->src();
2060: return ($src =~ /html$/);
2061: }
2062: sub is_sequence {
2063: my $self=shift;
2064: my $src = $self->src();
2065: return ($src =~ /sequence$/);
2066: }
2067: sub is_page {
2068: my $self=shift;
2069: my $src = $self->src();
2070: return ($src =~ /page$/);
2071: }
2072:
2073:
2074:
2075:
2076: # Move this into POD: In order to use these correctly, courseopt
2077: # and useropt need to be generated
2078: sub parmval {
2079: my $self = shift;
2080: my $what = shift;
2081: my $part = shift || "0";
2082: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
2083: }
2084:
2085: #####
2086: # Map Queries
2087: #####
2088:
2089: # These methods relate to whether or not the resource is a map, and the
2090: # attributes of that map.
2091:
2092: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
2093: sub map_finish {
2094: my $self = shift;
2095: my $src = $self->src();
2096: my $res = $self->navHash("map_finish_$src", 0);
2097: $res = $self->{NAV_MAP}->getById($res);
2098: return $res;
2099: }
2100: sub map_start {
2101: my $self = shift;
2102: my $src = $self->src();
2103: my $res = $self->navHash("map_start_$src", 0);
2104: $res = $self->{NAV_MAP}->getById($res);
2105: return $res;
2106: }
2107: sub map_pc {
2108: my $self = shift;
2109: my $src = $self->src();
2110: return $self->navHash("map_pc_$src", 0);
2111: }
2112: sub map_type {
2113: my $self = shift;
2114: my $pc = $self->map_pc();
2115: return $self->navHash("map_type_$pc", 0);
2116: }
2117:
2118:
2119:
2120: #####
2121: # Property queries
2122: #####
2123:
2124: # These functions will be responsible for returning the CORRECT
2125: # VALUE for the parameter, no matter what. So while they may look
2126: # like direct calls to parmval, they can be more then that.
2127: # So, for instance, the duedate function should use the "duedatetype"
2128: # information, rather then the resource object user.
2129:
2130: =pod
2131:
2132: =head2 Resource Parameters
2133:
2134: 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.
2135:
2136: 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.)
2137:
2138: =over 4
2139:
2140: =item * B<acc>: Get the Client IP/Name Access Control information.
2141:
2142: =item * B<answerdate>: Get the answer-reveal date for the problem.
2143:
2144: =item * B<duedate>: Get the due date for the problem.
2145:
2146: =item * B<tries>: Get the number of tries the student has used on the problem.
2147:
2148: =item * B<maxtries>: Get the number of max tries allowed.
2149:
2150: =item * B<opendate>: Get the open date for the problem.
2151:
2152: =item * B<sig>: Get the significant figures setting.
2153:
2154: =item * B<tol>: Get the tolerance for the problem.
2155:
2156: =item * B<type>: Get the question type for the problem.
2157:
2158: =item * B<weight>: Get the weight for the problem.
2159:
2160: =back
2161:
2162: =cut
2163:
2164: sub acc {
2165: (my $self, my $part) = @_;
2166: return $self->parmval("acc", $part);
2167: }
2168: sub answerdate {
2169: (my $self, my $part) = @_;
2170: # Handle intervals
2171: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
2172: return $self->duedate($part) +
2173: $self->parmval("answerdate", $part);
2174: }
2175: return $self->parmval("answerdate", $part);
2176: }
2177: sub duedate {
2178: (my $self, my $part) = @_;
2179: return $self->parmval("duedate", $part);
2180: }
2181: sub maxtries {
2182: (my $self, my $part) = @_;
2183: return $self->parmval("maxtries", $part);
2184: }
2185: sub opendate {
2186: (my $self, my $part) = @_;
2187: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
2188: return $self->duedate($part) -
2189: $self->parmval("opendate", $part);
2190: }
2191: return $self->parmval("opendate");
2192: }
2193: sub sig {
2194: (my $self, my $part) = @_;
2195: return $self->parmval("sig", $part);
2196: }
2197: sub tol {
2198: (my $self, my $part) = @_;
2199: return $self->parmval("tol", $part);
2200: }
2201: sub type {
2202: (my $self, my $part) = @_;
2203: return $self->parmval("type", $part);
2204: }
2205: sub weight {
2206: (my $self, my $part) = @_;
2207: return $self->parmval("weight", $part);
2208: }
2209: sub tries {
2210: my $self = shift;
2211: my $part = shift;
2212: $part = '0' if (!defined($part));
2213:
2214: # Make sure return hash is loaded, should error check
2215: $self->getReturnHash();
2216:
2217: my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
2218: if (!defined($tries)) {return '0';}
2219: return $tries;
2220: }
2221:
2222: # Multiple things need this
2223: sub getReturnHash {
2224: my $self = shift;
2225:
2226: if (!defined($self->{RETURN_HASH})) {
2227: my %tmpHash = &Apache::lonnet::restore($self->symb());
2228: $self->{RETURN_HASH} = \%tmpHash;
2229: }
2230: }
2231:
2232: ######
2233: # Status queries
2234: ######
2235:
2236: # These methods query the status of problems.
2237:
2238: # If we need to count parts, this function determines the number of
2239: # parts from the metadata. When called, it returns a reference to a list
2240: # of strings corresponding to the parts. (Thus, using it in a scalar context
2241: # tells you how many parts you have in the problem:
2242: # $partcount = scalar($resource->countParts());
2243: # Don't use $self->{PARTS} directly because you don't know if it's been
2244: # computed yet.
2245:
2246: =pod
2247:
2248: =head2 Resource misc
2249:
2250: Misc. functions for the resource.
2251:
2252: =over 4
2253:
1.59 bowersj2 2254: =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
2255:
2256: =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
2257:
2258: for (split(/\,/, $res->getFeedback())) {
2259: my $link = &Apache::lonnet::escape($_);
2260: ...
2261:
2262: and use the link as appropriate.
2263:
2264: =cut
2265:
2266: sub hasDiscussion {
2267: my $self = shift;
2268: return $self->{NAV_MAP}->hasDiscussion($self->symb());
2269: }
2270:
2271: sub getFeedback {
2272: my $self = shift;
2273: return $self->{NAV_MAP}->getFeedback($self->symb());
2274: }
2275:
2276: =pod
2277:
1.51 bowersj2 2278: =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.)
2279:
2280: =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.
2281:
2282: =back
2283:
2284: =cut
2285:
2286: sub parts {
2287: my $self = shift;
2288:
2289: $self->extractParts();
2290: return $self->{PARTS};
2291: }
2292:
2293: sub countParts {
2294: my $self = shift;
2295:
2296: my $parts = $self->parts();
1.66 ! bowersj2 2297:
! 2298: if ($self->{RESOURCE_ERROR}) {
! 2299: return 0;
! 2300: }
! 2301:
! 2302: if (scalar(@{$parts}) < 2) { return 1;}
1.51 bowersj2 2303:
2304: return scalar(@{$parts}) - 1;
2305: }
2306:
2307: # Private function: Extracts the parts information and saves it
2308: sub extractParts {
2309: my $self = shift;
2310:
2311: return if ($self->{PARTS});
2312:
2313: $self->{PARTS} = [];
2314:
2315: # Retrieve part count
1.66 ! bowersj2 2316: my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
! 2317: if (!$metadata) {
! 2318: $self->{RESOURCE_ERROR} = 1;
! 2319: $self->{PARTS} = [];
! 2320: return;
! 2321: }
! 2322:
! 2323: foreach (split(/\,/,$metadata)) {
1.51 bowersj2 2324: if ($_ =~ /^parameter\_(.*)\_opendate$/) {
2325: push @{$self->{PARTS}}, $1;
2326: }
2327: }
1.66 ! bowersj2 2328:
1.51 bowersj2 2329:
2330: # Is this possible to do in one line? - Jeremy
2331: my @sortedParts = sort @{$self->{PARTS}};
2332: $self->{PARTS} = \@sortedParts;
2333:
2334: return;
2335: }
2336:
2337: =pod
2338:
2339: =head2 Resource Status
2340:
2341: 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.
2342:
2343: There are two aspects to the status: the date-related information and the completion information.
2344:
2345: Idiomatic usage of these two methods would probably look something like
2346:
2347: foreach ($resource->parts()) {
2348: my $dateStatus = $resource->getDateStatus($_);
2349: my $completionStatus = $resource->getCompletionStatus($_);
2350:
2351: ... use it here ...
2352: }
2353:
2354: =over 4
2355:
1.59 bowersj2 2356: =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. You should still check to see if there is a due date at all, if you care about that. The possible return values are:
1.51 bowersj2 2357:
2358: =back
2359:
2360: B<Date Codes>
2361:
2362: =over 4
2363:
2364: =item * B<OPEN_LATER>: The problem will be opened later.
2365:
2366: =item * B<OPEN>: Open and not yet due.
2367:
1.59 bowersj2 2368:
1.54 bowersj2 2369: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
2370:
2371: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
1.51 bowersj2 2372:
2373: =item * B<ANSWER_OPEN>: The answer date is here.
2374:
2375: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2376:
2377: =back
2378:
2379: =cut
2380:
2381: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 2382: sub OPEN_LATER { return 0; }
2383: sub OPEN { return 1; }
2384: sub PAST_DUE_NO_ANSWER { return 2; }
2385: sub PAST_DUE_ANSWER_LATER { return 3; }
2386: sub ANSWER_OPEN { return 4; }
2387: sub NOTHING_SET { return 5; }
2388: sub NETWORK_FAILURE { return 100; }
2389:
2390: # getDateStatus gets the date status for a given problem part.
2391: # Because answer date, due date, and open date are fully independent
2392: # (i.e., it is perfectly possible to *only* have an answer date),
2393: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
2394: # (past, future, none given). This function handles this with a decision
2395: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 2396:
2397: sub getDateStatus {
2398: my $self = shift;
2399: my $part = shift;
2400: $part = "0" if (!defined($part));
1.54 bowersj2 2401:
2402: # Always return network failure if there was one.
1.51 bowersj2 2403: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2404:
2405: my $now = time();
2406:
1.53 bowersj2 2407: my $open = $self->opendate($part);
2408: my $due = $self->duedate($part);
2409: my $answer = $self->answerdate($part);
2410:
2411: if (!$open && !$due && !$answer) {
2412: # no data on the problem at all
2413: # should this be the same as "open later"? think multipart.
2414: return $self->NOTHING_SET;
2415: }
1.59 bowersj2 2416: if (!$open || $now < $open) {return $self->OPEN_LATER}
2417: if (!$due || $now < $due) {return $self->OPEN}
2418: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
2419: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 2420: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 2421: }
2422:
2423: =pod
2424:
2425: B<>
2426:
2427: =over 4
2428:
2429: =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:
2430:
2431: =back
2432:
2433: B<Completion Codes>
2434:
2435: =over 4
2436:
2437: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2438:
2439: =item * B<INCORRECT>: Attempted, but wrong by student.
2440:
2441: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2442:
2443: =item * B<CORRECT>: Correct or correct by instructor.
2444:
2445: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2446:
2447: =item * B<EXCUSED>: Excused. Not yet implemented.
2448:
2449: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2450:
2451: =back
2452:
2453: =cut
2454:
1.53 bowersj2 2455: sub NOT_ATTEMPTED { return 10; }
2456: sub INCORRECT { return 11; }
2457: sub INCORRECT_BY_OVERRIDE { return 12; }
2458: sub CORRECT { return 13; }
2459: sub CORRECT_BY_OVERRIDE { return 14; }
2460: sub EXCUSED { return 15; }
1.51 bowersj2 2461:
2462: sub getCompletionStatus {
2463: my $self = shift;
2464: my $part = shift;
2465: $part = "0" if (!defined($part));
2466: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2467:
2468: # Make sure return hash exists
2469: $self->getReturnHash();
2470:
2471: my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
2472:
2473: # Left as seperate if statements in case we ever do more with this
2474: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2475: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2476: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2477: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2478: if ($status eq 'excused') {return $self->EXCUSED; }
2479: return $self->NOT_ATTEMPTED;
2480: }
2481:
2482: =pod
2483:
2484: B<Composite Status>
2485:
2486: 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()):
2487:
2488: =over 4
2489:
2490: =item * NETWORK_FAILURE: The network has failed and the information is not available.
2491:
1.59 bowersj2 2492: =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. For single part, this is the same as "OPEN_LATER".)
1.53 bowersj2 2493:
1.51 bowersj2 2494: =item * CORRECT: For any reason at all, the part is considered correct.
2495:
2496: =item * EXCUSED: For any reason at all, the problem is excused.
2497:
1.54 bowersj2 2498: =item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.
2499:
2500: =item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.
1.51 bowersj2 2501:
2502: =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.
2503:
2504: =item * OPEN_LATER: The problem is not yet open.
2505:
2506: =item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.
2507:
2508: =item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.
2509:
2510: =item * OPEN: The item is open and not yet tried.
2511:
2512: =back
2513:
2514: =cut
2515:
2516: sub TRIES_LEFT { return 10; }
2517:
2518: sub status {
2519: my $self = shift;
2520: my $part = shift;
2521: if (!defined($part)) { $part = "0"; }
2522: my $completionStatus = $self->getCompletionStatus($part);
2523: my $dateStatus = $self->getDateStatus($part);
2524:
2525: # What we have is a two-dimensional matrix with 4 entries on one
2526: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 2527: # plus network failure and "no date data at all".
1.51 bowersj2 2528:
1.53 bowersj2 2529: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 2530:
2531: # There are a few whole rows we can dispose of:
1.53 bowersj2 2532: if ($completionStatus == CORRECT ||
2533: $completionStatus == CORRECT_BY_OVERRIDE ) {
2534: return CORRECT();
2535: }
2536:
2537: # If it's EXCUSED, then return that no matter what
2538: if ($completionStatus == EXCUSED) {
2539: return EXCUSED;
1.51 bowersj2 2540: }
2541:
1.53 bowersj2 2542: if ($dateStatus == NOTHING_SET) {
2543: return NOTHING_SET;
1.51 bowersj2 2544: }
2545:
2546: # Now we're down to a 3 (incorrect, incorrect_override, not_attempted)
2547: # by 4 matrix (date status).
2548:
1.54 bowersj2 2549: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 2550: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54 bowersj2 2551: return $dateStatus;
1.51 bowersj2 2552: }
2553:
1.53 bowersj2 2554: if ($dateStatus == ANSWER_OPEN) {
2555: return ANSWER_OPEN;
1.51 bowersj2 2556: }
2557:
2558: # Now: (incorrect, incorrect_override, not_attempted) x
2559: # (open_later), (open)
2560:
1.53 bowersj2 2561: if ($dateStatus == OPEN_LATER) {
2562: return OPEN_LATER;
1.51 bowersj2 2563: }
2564:
2565: # If it's WRONG...
1.53 bowersj2 2566: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 2567: # and there are TRIES LEFT:
2568: if ($self->tries() < $self->maxtries()) {
1.53 bowersj2 2569: return TRIES_LEFT;
1.51 bowersj2 2570: }
1.53 bowersj2 2571: return INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 2572: }
2573:
2574: # Otherwise, it's untried and open
1.53 bowersj2 2575: return OPEN;
1.51 bowersj2 2576: }
2577:
2578: =pod
2579:
2580: =head2 Resource/Nav Map Navigation
2581:
2582: =over 4
2583:
2584: =item * B<getNext>(): Gets the next resource in the navmap after this one.
2585:
2586: =cut
2587:
2588: # For the simple single-link case, to get from a resource to the next
2589: # resource, you need to look up the "to_" link in the nav hash, then
2590: # follow that with the "goesto_" link.
2591:
2592: sub getNext {
2593: my $self = shift;
2594: my $alreadySeenHash = shift;
2595: my @branches;
2596: my $to = $self->to();
2597: foreach my $branch ( split(/\,/, $to) ) {
2598: my $choice = $self->{NAV_MAP}->getById($branch);
2599: my $next = $choice->goesto();
2600: $next = $self->{NAV_MAP}->getById($next);
2601:
1.61 bowersj2 2602: # Don't remember it if we've already seen it or if
1.66 ! bowersj2 2603: # the student doesn't have browse priviledges
! 2604: my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
1.51 bowersj2 2605: if (!defined($alreadySeenHash) ||
1.61 bowersj2 2606: !defined($alreadySeenHash->{$next->{ID}}) ||
1.66 ! bowersj2 2607: ($browsePriv ne '2' && $browsePriv ne 'F')) {
1.51 bowersj2 2608: push @branches, $next;
2609: }
2610: }
2611: return \@branches;
2612: }
2613:
2614: =pod
1.2 www 2615:
1.51 bowersj2 2616: =back
1.2 www 2617:
1.51 bowersj2 2618: =cut
1.2 www 2619:
1.51 bowersj2 2620: 1;
1.2 www 2621:
1.51 bowersj2 2622: __END__
1.2 www 2623:
2624:
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