Annotation of loncom/interface/lonnavmaps.pm, revision 1.73
1.72 bowersj2 1:
1.2 www 2: # The LearningOnline Network with CAPA
3: # Navigate Maps Handler
1.1 www 4: #
1.72 bowersj2 5: # $Id: lonnavmaps.pm,v 1.71 2002/10/08 20:39:43 www Exp $
1.20 albertel 6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
1.2 www 29: # (Page Handler
1.1 www 30: #
1.2 www 31: # (TeX Content Handler
1.1 www 32: #
1.2 www 33: # 05/29/00,05/30 Gerd Kortemeyer)
34: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
35: # 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 36: #
1.17 www 37: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
1.21 www 38: # YEAR=2002
39: # 1/1 Gerd Kortemeyer
40: #
1.2 www 41:
1.1 www 42: package Apache::lonnavmaps;
43:
44: use strict;
1.2 www 45: use Apache::Constants qw(:common :http);
46: use Apache::lonnet();
1.18 albertel 47: use Apache::loncommon();
1.2 www 48: use GDBM_File;
1.73 ! bowersj2 49: use POSIX qw (floor strftime);
1.2 www 50:
51: # -------------------------------------------------------------- Module Globals
52: my %hash;
53: my @rows;
54:
1.10 www 55: #
56: # These cache hashes need to be independent of user, resource and course
57: # (user and course can/should be in the keys)
58: #
59:
60: my %courserdatas;
61: my %userrdatas;
62:
63: #
64: # These global hashes are dependent on user, course and resource,
65: # and need to be initialized every time when a sheet is calculated
66: #
67: my %courseopt;
68: my %useropt;
69: my %parmhash;
70:
1.47 bowersj2 71: # This parameter keeps track of whether obtaining the user's information
72: # failed, which the colorizer in astatus can use
73: my $networkFailedFlag = 0;
74:
1.2 www 75: # ------------------------------------------------------------------ Euclid gcd
76:
77: sub euclid {
78: my ($e,$f)=@_;
79: my $a; my $b; my $r;
80: if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
81: while ($r!=0) {
1.51 bowersj2 82: $a=$b; $b=$r;
1.2 www 83: $r=$a%$b;
84: }
85: return $b;
86: }
87:
1.10 www 88: # --------------------------------------------------------------------- Parmval
89:
90: # -------------------------------------------- Figure out a cascading parameter
91: #
92: # For this function to work
93: #
94: # * parmhash needs to be tied
95: # * courseopt and useropt need to be initialized for this user and course
96: #
97:
98: sub parmval {
99: my ($what,$symb)=@_;
100: my $cid=$ENV{'request.course.id'};
101: my $csec=$ENV{'request.course.sec'};
102: my $uname=$ENV{'user.name'};
103: my $udom=$ENV{'user.domain'};
104:
105: unless ($symb) { return ''; }
106: my $result='';
107:
108: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
109:
110: # ----------------------------------------------------- Cascading lookup scheme
1.24 albertel 111: my $rwhat=$what;
112: $what=~s/^parameter\_//;
113: $what=~s/\_/\./;
114:
115: my $symbparm=$symb.'.'.$what;
116: my $mapparm=$mapname.'___(all).'.$what;
117: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
118:
119: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
120: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
121: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
122:
123: my $courselevel= $usercourseprefix.'.'.$what;
124: my $courselevelr=$usercourseprefix.'.'.$symbparm;
125: my $courselevelm=$usercourseprefix.'.'.$mapparm;
126:
127: # ---------------------------------------------------------- first, check user
1.57 albertel 128: if (defined($uname)) {
129: if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
130: if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
131: if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
1.24 albertel 132: }
1.10 www 133:
1.24 albertel 134: # ------------------------------------------------------- second, check course
1.57 albertel 135: if (defined($csec)) {
136: if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
137: if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
138: if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
1.24 albertel 139: }
1.10 www 140:
1.57 albertel 141: if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
142: if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
143: if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; }
1.10 www 144:
1.24 albertel 145: # ----------------------------------------------------- third, check map parms
1.10 www 146:
1.24 albertel 147: my $thisparm=$parmhash{$symbparm};
1.57 albertel 148: if (defined($thisparm)) { return $thisparm; }
1.10 www 149:
1.24 albertel 150: # ----------------------------------------------------- fourth , check default
1.10 www 151:
1.25 albertel 152: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57 albertel 153: if (defined($default)) { return $default}
1.25 albertel 154:
155: # --------------------------------------------------- fifth , cascade up parts
156:
157: my ($space,@qualifier)=split(/\./,$rwhat);
158: my $qualifier=join('.',@qualifier);
159: unless ($space eq '0') {
1.51 bowersj2 160: my ($part,$id)=split(/\_/,$space);
161: if ($id) {
162: my $partgeneral=&parmval($part.".$qualifier",$symb);
1.57 albertel 163: if (defined($partgeneral)) { return $partgeneral; }
1.51 bowersj2 164: } else {
165: my $resourcegeneral=&parmval("0.$qualifier",$symb);
1.57 albertel 166: if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51 bowersj2 167: }
1.25 albertel 168: }
169: return '';
1.10 www 170: }
171:
172:
173:
1.9 www 174: # ------------------------------------------------------------- Find out status
1.25 albertel 175: # return codes
176: # tcode (timecode)
177: # 1: will open later
178: # 2: is open and not past due yet
179: # 3: is past due date
180: # 4: due in the next 24 hours
181: #
182: # code (curent solved status)
183: # 1: not attempted
184: # 2: attempted but wrong, or incorrect by instructor
185: # 3: solved or correct by instructor
1.29 albertel 186: # 4: partially correct (one or more parts correct)
187: # "excused" needs to be supported, but is not yet.
1.9 www 188: sub astatus {
189: my $rid=shift;
1.29 albertel 190: my $code=0;
1.9 www 191: my $ctext='';
192: $rid=~/(\d+)\.(\d+)/;
1.10 www 193: my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
1.51 bowersj2 194: &Apache::lonnet::declutter($hash{'src_'.$rid});
1.15 www 195: my %duedate=();
196: my %opendate=();
197: my %answerdate=();
1.25 albertel 198: # need to always check part 0's open/due/answer status
1.51 bowersj2 199: foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) {
1.15 www 200: if ($_=~/^parameter\_(.*)\_opendate$/) {
1.51 bowersj2 201: my $part=$1;
1.15 www 202: $duedate{$part}=&parmval($part.'.duedate',$symb);
203: $opendate{$part}=&parmval($part.'.opendate',$symb);
204: $answerdate{$part}=&parmval($part.'.answerdate',$symb);
1.49 www 205: if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') {
1.51 bowersj2 206: $opendate{$part}=$duedate{$part}-$opendate{$part};
1.49 www 207: }
1.50 www 208: if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') {
1.49 www 209: $answerdate{$part}=$duedate{$part}+$answerdate{$part};
210: }
1.15 www 211: }
1.25 albertel 212: }
1.11 www 213: my $now=time;
214: my $tcode=0;
1.16 www 215:
216: my %returnhash=&Apache::lonnet::restore($symb);
217:
1.25 albertel 218: foreach (sort(keys(%opendate))) {
1.51 bowersj2 219: my $duedate=$duedate{$_};
220: my $opendate=$opendate{$_};
221: my $answerdate=$answerdate{$_};
222: my $preface='';
223: unless ($_ eq '0') { $preface=' Part: '.$_.' '; }
224: if ($opendate) {
225: if ($now<$duedate || (!$duedate)) {
226: unless ($tcode==4) { $tcode=2; }
227: if ($duedate) {
228: $ctext.=$preface.'Due: '.localtime($duedate);
229: } else {
230: $ctext.=$preface.'No Due Date';
231: }
232: if ($now<$opendate) {
233: unless ($tcode) { $tcode=1; }
234: $ctext.=$preface.'Open: '.localtime($opendate);
235: }
236: if ($duedate && $duedate-$now<86400) {
237: $tcode=4;
238: $ctext.=$preface.'Due: '.localtime($duedate);
239: }
240: } else {
241: unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; }
242: if ($now<$answerdate) {
243: $ctext.='Answer: '.localtime($duedate);
244: }
245: }
246: } else {
247: unless (($tcode==2) || ($tcode==4)) { $tcode=1; }
248: }
249:
250: my $status=$returnhash{'resource.'.$_.'.solved'};
251:
252: if ($status eq 'correct_by_student') {
253: if ($code==0||$code==3) { $code=3; } else { $code=4; }
254: $ctext.=' solved';
255: } elsif ($status eq 'correct_by_override') {
256: if ($code==0||$code==3) { $code=3; } else { $code=4; }
257: $ctext.=' override';
258: } elsif ($status eq 'incorrect_attempted') {
259: if ($code!=4 && $code!=3) { $code=2; }
260: if ($code==3) { $code=4; }
261: $ctext.=' ('.
262: ($returnhash{'resource.'.$_.'.tries'}?
263: $returnhash{'resource.'.$_.'.tries'}:'0');
264: my $numtries = &parmval($_.'.maxtries',$symb);
265: if ($numtries) { $ctext.='/'.$numtries.' tries'; }
266: $ctext.=')';
267: } elsif ($status eq 'incorrect_by_override') {
268: if ($code!=4 && $code!=3) { $code=2; }
269: if ($code==3) { $code=4; }
270: $ctext.=' override';
271: } elsif ($status eq 'excused') {
272: if ($code==0||$code==3) { $code=3; } else { $code=4; }
273: $ctext.=' excused';
274: } else {
275: if ($code==0) { $code=1; }
276: }
1.25 albertel 277: }
1.16 www 278:
1.11 www 279: return 'p'.$code.$tcode.'"'.$ctext.'"';
1.9 www 280: }
281:
1.2 www 282:
1.31 albertel 283: sub addresource {
1.32 albertel 284: my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;
1.31 albertel 285: if ($showtypes eq 'problems') {
1.51 bowersj2 286: if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {
287: return;
288: }
1.31 albertel 289: }
290: my $brepriv=&Apache::lonnet::allowed('bre',$resource);
291: if ($hash{'src_'.$rid}) {
1.51 bowersj2 292: if (($brepriv eq '2') || ($brepriv eq 'F')) {
293: my $pprefix='';
294: if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) {
295: $pprefix=&astatus($rid);
296: }
297: $$sofar++;
298: if ($indent) { $pprefix='i'.$indent.','.$pprefix; }
299: if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; }
300: if (defined($rows[$$sofar])) {
301: $rows[$$sofar].='&'.$pprefix.$rid;
302: } else {
303: $rows[$$sofar]=$pprefix.$rid;
304: }
305: }
1.31 albertel 306: }
307: }
308:
309: sub followlinks () {
1.32 albertel 310: my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_;
1.31 albertel 311: my $mincond=1;
312: my $next='';
313: foreach (split(/\,/,$hash{'to_'.$rid})) {
1.51 bowersj2 314: my $thiscond=
315: &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
316: if ($thiscond>=$mincond) {
317: if ($next) {
318: $next.=','.$_.':'.$thiscond;
319: } else {
320: $next=$_.':'.$thiscond;
321: }
322: if ($thiscond>$mincond) { $mincond=$thiscond; }
323: }
1.31 albertel 324: }
1.32 albertel 325: my $col=0;
326: &Apache::lonxml::debug("following links -$next-");
1.31 albertel 327: foreach (split(/\,/,$next)) {
1.51 bowersj2 328: my ($nextlinkid,$condval)=split(/\:/,$_);
329: if ($condval>=$mincond) {
330: my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid},
331: $beenhere,$showtypes,$indent,$linkid);
332: if ($now>$further) {
333: if ($col>0) {
334: my $string;
335: for(my $i=0;$i<$col;$i++) { $string.='&'; }
336: for(my $i=$further+1;$now-1>$i;$i++) {
337: $rows[$i]=$string.$rows[$i];
338: }
339: }
340: $further=$now;
341: }
342: }
343: $col++;
1.31 albertel 344: }
345: return $further;
346: }
347: # ------------------------------------------------------------ Build page table
348:
349: sub tracetable {
1.32 albertel 350: my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_;
351: my $newshowtypes=$showtypes;
1.31 albertel 352: my $further=$sofar;
1.44 www 353: # $Apache::lonxml::debug=1;
1.32 albertel 354: &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid});
355: if ($beenhere=~/\&$rid\&/) { return $further; }
356: $beenhere.=$rid.'&';
1.31 albertel 357:
358: if (defined($hash{'is_map_'.$rid})) {
1.51 bowersj2 359: $sofar++;
360: my $tprefix='';
361: if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
362: eq 'sequence') {
363: $tprefix='h';
364: } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
365: eq 'page') {
366: $tprefix='j';
367: if ($indent) { $tprefix='i'.$indent.','.$tprefix; }
368: if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; }
369: $newshowtypes='problems';
370: $indent++;
371: #if in a .page continue to link the encompising .page
372: if (!$linkid) { $linkid=$rid; }
373: }
374: if (defined($rows[$sofar])) {
375: $rows[$sofar].='&'.$tprefix.$rid;
376: } else {
377: $rows[$sofar]=$tprefix.$rid;
378: }
379: if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
380: (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
381: my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
382: $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
383: '&'.$frid.'&',$newshowtypes,$indent,$linkid);
384: &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes,
385: $indent,$linkid);
386: if ($tprefix =~ /j$/) { $indent--; $linkid=''; }
387: }
1.31 albertel 388: } else {
1.51 bowersj2 389: &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,
390: $indent,$linkid);
1.31 albertel 391: }
392:
393: if (defined($hash{'to_'.$rid})) {
1.51 bowersj2 394: $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,
395: $indent,$linkid);
1.2 www 396: }
1.31 albertel 397:
1.2 www 398: return $further;
399: }
400:
401: # ================================================================ Main Handler
1.1 www 402:
403: sub handler {
1.28 albertel 404: my $r=shift;
1.2 www 405:
1.51 bowersj2 406: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
407:
408: if ($ENV{'form.jtest'} ne "1")
409: {
410: return new_handle($r);
411: }
1.2 www 412:
413: # ------------------------------------------- Set document type for header only
414:
1.28 albertel 415: if ($r->header_only) {
1.51 bowersj2 416: if ($ENV{'browser.mathml'}) {
417: $r->content_type('text/xml');
418: } else {
419: $r->content_type('text/html');
420: }
421: $r->send_http_header;
422: return OK;
1.28 albertel 423: }
424: my $requrl=$r->uri;
425: my $hashtied;
1.2 www 426: # ----------------------------------------------------------------- Tie db file
1.28 albertel 427: my $fn;
428: if ($ENV{'request.course.fn'}) {
1.51 bowersj2 429: $fn=$ENV{'request.course.fn'};
430: if (-e "$fn.db") {
431: if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) &&
432: (tie(%parmhash,'GDBM_File',
433: $ENV{'request.course.fn'}.'_parms.db',
434: &GDBM_READER(),0640))) {
435: $hashtied=1;
436: }
437: }
1.28 albertel 438: }
439: if (!$hashtied) {
1.51 bowersj2 440: $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
441: return HTTP_NOT_ACCEPTABLE;
1.28 albertel 442: }
443:
1.2 www 444: # ------------------------------------------------------------------- Hash tied
1.28 albertel 445:
446: if ($ENV{'browser.mathml'}) {
1.51 bowersj2 447: $r->content_type('text/xml');
1.28 albertel 448: } else {
1.51 bowersj2 449: $r->content_type('text/html');
1.28 albertel 450: }
451: &Apache::loncommon::no_cache($r);
452: $r->send_http_header;
453:
1.42 www 454: my $firstres=$hash{'map_start_'.
455: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
456: my $lastres=$hash{'map_finish_'.
457: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1.28 albertel 458: if (!(($firstres) && ($lastres))) {
1.51 bowersj2 459: $r->print('<html><body>Coursemap undefined.</body></html>');
1.28 albertel 460: } else {
461:
1.2 www 462: # ----------------------------------------------------------------- Render page
1.10 www 463: # -------------------------------------------------------------- Set parameters
464:
465:
466: # ---------------------------- initialize coursedata and userdata for this user
1.51 bowersj2 467: undef %courseopt;
468: undef %useropt;
1.10 www 469:
1.51 bowersj2 470: my $uname=$ENV{'user.name'};
471: my $udom=$ENV{'user.domain'};
472: my $uhome=$ENV{'user.home'};
473: my $cid=$ENV{'request.course.id'};
474: my $chome=$ENV{'course.'.$cid.'.home'};
475: my ($cdom,$cnum)=split(/\_/,$cid);
476:
477: my $userprefix=$uname.'_'.$udom.'_';
478:
479: unless ($uhome eq 'no_host') {
1.48 bowersj2 480: # ------------------------------------------------- Get coursedata (if present)
1.51 bowersj2 481: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
482: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
483: ':resourcedata',$chome);
484: if ($reply!~/^error\:/) {
485: $courserdatas{$cid}=$reply;
486: $courserdatas{$cid.'.last_cache'}=time;
487: }
488: # check to see if network failed
489: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
490: {
491: $networkFailedFlag = 1;
492: }
493: }
494: foreach (split(/\&/,$courserdatas{$cid})) {
495: my ($name,$value)=split(/\=/,$_);
496: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
497: &Apache::lonnet::unescape($value);
498: }
1.10 www 499: # --------------------------------------------------- Get userdata (if present)
1.51 bowersj2 500: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
501: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
502: if ($reply!~/^error\:/) {
503: $userrdatas{$uname.'___'.$udom}=$reply;
504: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
505: }
506: }
507: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
508: my ($name,$value)=split(/\=/,$_);
509: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
510: &Apache::lonnet::unescape($value);
511: }
512: }
1.28 albertel 513:
1.51 bowersj2 514: @rows=();
1.28 albertel 515:
1.51 bowersj2 516: &tracetable(0,$firstres,'&','',0);
1.2 www 517:
518: # ------------------------------------------------------------------ Page parms
519:
1.51 bowersj2 520: my $j;
521: my $i;
522: my $lcm=1;
523: my $contents=0;
1.2 www 524:
525: # ---------------------------------------------- Go through table to get layout
526:
1.51 bowersj2 527: for ($i=0;$i<=$#rows;$i++) {
528: if ($rows[$i]) {
529: &Apache::lonxml::debug("Row $i is:".$rows[$i]);
530: $contents++;
531: my @colcont=split(/\&/,$rows[$i]);
532: $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
533: }
534: }
1.5 www 535:
1.2 www 536:
1.51 bowersj2 537: unless ($contents) {
538: $r->print('<html><body>Empty Map.</body></html>');
539: } else {
1.10 www 540:
1.2 www 541: # ------------------------------------------------------------------ Build page
542:
1.51 bowersj2 543: my $currenturl=$ENV{'form.postdata'};
544: $currenturl=~s/^http\:\/\///;
545: $currenturl=~s/^[^\/]+//;
1.13 www 546:
1.2 www 547: # ---------------------------------------------------------------- Send headers
548:
1.51 bowersj2 549: my $date=localtime;
550: my $now=time;
1.21 www 551: # ----------------------------------------- Get email status and discussiontime
552:
1.51 bowersj2 553: my %emailstatus=&Apache::lonnet::dump('email_status');
554: my $logouttime=$emailstatus{'logout'};
555: my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}};
556: my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime);
557:
558: my %discussiontimes=&Apache::lonnet::dump('discussiontimes',
559: $cdom,$cnum);
560:
561: my %feedback=();
562: my %error=();
563: foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'.
564: $ENV{'user.domain'}.':'.
565: $ENV{'user.name'}.':nohist_email',
566: $ENV{'user.home'}))) {
567: $msgid=&Apache::lonnet::unescape($msgid);
568: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
569: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
570: my ($what,$url)=($1,$2);
571: my %status=
572: &Apache::lonnet::get('email_status',[$msgid]);
573: if ($status{$msgid}=~/^error\:/) {
574: $status{$msgid}='';
575: }
576:
577: if (($status{$msgid} eq 'new') ||
578: (!$status{$msgid})) {
579: if ($what eq 'Error') {
580: $error{$url}.=','.$msgid;
581: } else {
582: $feedback{$url}.=','.$msgid;
583: }
584: }
585: }
586: }
1.22 www 587: # ----------------------------------------------------------- Start Page Output
1.43 www 588: my $bodytagadd='';
1.51 bowersj2 589: $r->print(
1.43 www 590: '<html><head><title>Navigate Course Map</title></head>');
1.51 bowersj2 591: if (($currenturl=~/^\/res/) &&
592: ($currenturl!~/^\/res\/adm/)) {
593: $bodytagadd='onLoad="window.location.hash='."'curloc'".'"';
594: }
595: $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
1.43 www 596: $bodytagadd));
1.51 bowersj2 597: $r->print('<script>window.focus();</script>');
598: my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
599: if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
600: $r->print("<h3>$date</h3>\n");
601: $r->rflush();
602: $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
603: localtime($lastcheck).
604: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
605: if (($currenturl=~/^\/res/) &&
606: ($currenturl!~/^\/res\/adm/)) {
607: $r->print('<a href="#curloc">Current Location</a><p>');
608: }
609:
610: # Handle a network error
611:
612: if ($networkFailedFlag)
613: {
614: $r->print('<H2>LON-CAPA network failure.</H2>'."\n");
615: $r->print("<p>LON-CAPA's network is having difficulties, some problem" .
616: " information, such as due dates, will not be available.");
617: }
1.13 www 618: # ----------------------------------------------------- The little content list
1.51 bowersj2 619: for ($i=0;$i<=$#rows;$i++) {
620: if ($rows[$i]) {
621: my @colcont=split(/\&/,$rows[$i]);
622: my $avespan=$lcm/($#colcont+1);
623: for ($j=0;$j<=$#colcont;$j++) {
624: my $rid=$colcont[$j];
625: if ($rid=~/^h(.+)/) {
626: $rid=$1;
627: $r->print(' <a href="#'.
628: $rid.'">'.$hash{'title_'.$rid}.
629: '</a><br>');
630: }
631: }
632: }
633: }
1.2 www 634: # ----------------------------------------------------------------- Start table
1.51 bowersj2 635: $r->print('<hr><table cols="'.$lcm.'" border="0">');
636: for ($i=0;$i<=$#rows;$i++) {
637: if ($rows[$i]) {
638: $r->print("\n<tr>");
639: my @colcont=split(/\&/,$rows[$i]);
640: my $avespan=$lcm/($#colcont+1);
641:
642: # for each item I wish to print on this row...
643: for ($j=0;$j<=$#colcont;$j++) {
644: my $indent;my $indentstr;
645: my $linkid;
646: my $rid=$colcont[$j];
1.36 www 647: $rid=~/(\d+)\.(\d+)$/;
1.51 bowersj2 648: my $src=
649: &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
650: my $symb=
651: &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src;
652: my $add='<td>';
653: my $adde='</td>';
654: my $hwk='<font color="#223322">';
655: my $hwke='</font>';
656: if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; }
657: if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; }
658: if ($rid=~/^h(.+)/) {
659: $rid=$1;
660: $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">';
661: $adde='</th>';
1.36 www 662: if (($ENV{'user.adv'}) &&
1.51 bowersj2 663: ($parmhash{$symb.'.0.parameter_randompick'})) {
1.36 www 664: $adde=' (randomly select '.
1.51 bowersj2 665: $parmhash{$symb.'.0.parameter_randompick'}.
1.36 www 666: ')</th>';
667: }
1.51 bowersj2 668: }
669: if ($rid=~/^j(.+)/) { $rid=$1; }
670: if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {
671: # sub astatus describes what code/tcode mean
672: my $code=$1;
673: my $tcode=$2;
674: my $ctext=$3;
675: $rid=$4;
676:
677: # will open later
678: if ($tcode eq '1') {
679: $add='<td bgcolor="#AAAAAA">';
680: }
681:
682: # solved/correct
683: if ($code eq '3') {
684: $add='<td bgcolor="#AAFFAA">';
685: } elsif ($code eq '4') { # partially correct
686: $add='<td bgcolor="#E0FFAA">';
687: } else {
688: # not attempted
689:
690: # we end up here on network failure, so pick a neutral
691: # color if the network failed instead of bright red.
692: if ( $networkFailedFlag )
693: {
694: $add = '<td bgcolor="#AAAAAA">';
695: }
696: else
697: {
698: $add='<td bgcolor="#FFAAAA">';
699: }
700:
701: if ($tcode eq '2') { # open, not past due
702: $add='<td bgcolor="#FFFFAA">';
703: }
704:
705: if ($tcode eq '4') { # due in next 24 hours
706: $add='<td bgcolor="#FFFF33">';
707: $adde='</td>';
708: }
709: }
710: $hwk='<font color="#888811"><b>';
711: $hwke='</b></font>';
712: if ($code eq '1') {
713: $hwke='</b> ('.$ctext.')</font>';
714: }
715: if ($code eq '2' || $code eq '4') {
716: $hwk='<font color="#992222"><b>';
717: $hwke='</b> ('.$ctext.')</font>';
718: }
719: if ($code eq '3') {
720: $hwk='<font color="#229922"><b>';
721: $hwke='</b> ('.$ctext.')</font>';
722: }
723: if ($networkFailedFlag)
724: {
725: $hwke='</b> (status unavailable)</font>';
726: }
727: }
728: if ($rid && $hash{'src_'.$rid} eq $currenturl) {
729: $add=$add.'<a name="curloc"></a>'.
730: '<font color=red size=+2><b>> </b></font>';
731: $adde=
732: '<font color=red size=+2><b> <</b></font>'.$adde;
733: }
734: if ($discussiontimes{$symb}>$lastcheck) {
735: $adde=
736: '<img border=0 src="/adm/lonMisc/chat.gif">'.
737: $adde;
738: }
739: if ($error{$src}) {
740: foreach (split(/\,/,$error{$src})) {
741: if ($_) {
742: $adde=
743: ' <a href="/adm/email?display='.
744: &Apache::lonnet::escape($_).
745: '"><img src="/adm/lonMisc/bomb.gif" border=0></a>'
746: .$adde;
747: }
748: }
749: }
750: if ($feedback{$src}) {
751: foreach (split(/\,/,$feedback{$src})) {
752: if ($_) {
753: $adde=
754: ' <a href="/adm/email?display='.
755: &Apache::lonnet::escape($_).
756: '"><img src="/adm/lonMisc/feedback.gif" border=0></a>'
757: .$adde;
758: }
759: }
760: }
761: if ($indent) {
762: my $is=" ";
763: for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; }
764: }
765: if (!$linkid) { $linkid=$rid; }
1.38 www 766: if ($hash{'randomout_'.$rid}) {
767: $adde=' <i>(hidden)</i>'.$adde;
768: }
1.51 bowersj2 769: $r->print($add.$indentstr);
770: if ($rid) {
771: $r->print('<a href="'.$hash{'src_'.$linkid}.
1.39 www 772: (($hash{'src_'.$linkid}=~/\?/)?'&':'?').
773: 'symb='.&Apache::lonnet::escape($symb)
1.35 www 774: .'">'.
1.51 bowersj2 775: $hwk.$hash{'title_'.$rid}.$hwke.'</a>');
776: }
777: $r->print($adde);
778: }
779: $r->print('</tr>');
780: }
781: }
782: $r->print("\n</table>");
783: $r->print('</body></html>');
1.2 www 784: # -------------------------------------------------------------------- End page
1.51 bowersj2 785: }
1.2 www 786: # ------------------------------------------------------------- End render page
1.28 albertel 787: }
1.2 www 788: # ------------------------------------------------------------------ Untie hash
1.28 albertel 789: unless (untie(%hash)) {
1.51 bowersj2 790: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
791: "Could not untie coursemap $fn (browse).</font>");
1.28 albertel 792: }
793: unless (untie(%parmhash)) {
1.51 bowersj2 794: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
795: "Could not untie parmhash (browse).</font>");
1.28 albertel 796: }
797: return OK;
1.2 www 798: }
1.1 www 799:
1.51 bowersj2 800: sub new_handle {
801: my $r = shift;
802:
803: # Handle header-only request
804: if ($r->header_only) {
805: if ($ENV{'browser.mathml'}) {
806: $r->content_type('text/xml');
807: } else {
808: $r->content_type('text/html');
809: }
810: $r->send_http_header;
811: return OK;
812: }
813:
814: # Send header, don't cache this page
815: if ($ENV{'browser.mathml'}) {
816: $r->content_type('text/xml');
817: } else {
818: $r->content_type('text/html');
819: }
820: &Apache::loncommon::no_cache($r);
821: $r->send_http_header;
822:
823: # Initialize the nav map
824: my $navmap = Apache::lonnavmaps::navmap->new(
825: $ENV{"request.course.fn"}.".db",
826: $ENV{"request.course.fn"}."_parms.db", 1);
827:
1.55 bowersj2 828:
829: if (!defined($navmap)) {
830: my $requrl = $r->uri;
831: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
832: return HTTP_NOT_ACCEPTABLE;
833: }
1.64 bowersj2 834:
835: # Header
836: $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
837: ''));
838: $r->print('<script>window.focus();</script>');
839: my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
840: if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
841: my $date=localtime;
842: $r->print("<h3>$date</h3>\n");
843: $r->rflush();
1.65 bowersj2 844: if ($navmap->{LAST_CHECK}) {
1.66 bowersj2 845: $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
1.73 ! bowersj2 846: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1.66 bowersj2 847: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
1.65 bowersj2 848: } else {
1.66 bowersj2 849: $r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
850: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');
1.65 bowersj2 851: }
1.64 bowersj2 852: #if (($currenturl=~/^\/res/) &&
853: # ($currenturl!~/^\/res\/adm/)) {
854: # $r->print('<a href="#curloc">Current Location</a><p>');
855: #}
1.55 bowersj2 856:
857: # Check that it's defined
858: if (!($navmap->courseMapDefined())) {
859: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
860: '</body></html>');
861: return OK;
862: }
863:
1.51 bowersj2 864: # Grab a resource object so we have access to the constants; this
865: # is technically not proper, but should be harmless
866: my $res = $navmap->firstResource();
867:
868: # Defines a status->color mapping, null string means don't color
869: my %colormap =
1.54 bowersj2 870: ( $res->NETWORK_FAILURE => '',
1.59 bowersj2 871: $res->CORRECT => '',
1.54 bowersj2 872: $res->EXCUSED => '#BBBBFF',
1.59 bowersj2 873: $res->PAST_DUE_ANSWER_LATER => '',
874: $res->PAST_DUE_NO_ANSWER => '',
875: $res->ANSWER_OPEN => '#CCFFCC',
1.54 bowersj2 876: $res->OPEN_LATER => '',
1.59 bowersj2 877: $res->TRIES_LEFT => '',
878: $res->INCORRECT => '',
879: $res->OPEN => '',
1.54 bowersj2 880: $res->NOTHING_SET => '' );
1.59 bowersj2 881: # And a special case in the nav map; what to do when the assignment
882: # is not yet done and due in less then 24 hours
883: my $hurryUpColor = "#FFCCCC";
884:
885: my %statusIconMap =
1.66 bowersj2 886: ( $res->NETWORK_FAILURE => '',
887: $res->NOTHING_SET => '',
888: $res->CORRECT => 'navmap.correct.gif',
889: $res->EXCUSED => 'navmap.correct.gif',
890: $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
891: $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
892: $res->ANSWER_OPEN => 'navmap.wrong.gif',
893: $res->OPEN_LATER => '',
894: $res->TRIES_LEFT => 'navmap.open.gif',
895: $res->INCORRECT => 'navmap.wrong.gif',
1.69 bowersj2 896: $res->OPEN => 'navmap.open.gif',
897: $res->ATTEMPTED => '' );
898:
899: my %iconAltTags =
900: ( 'navmap.correct.gif' => 'Correct',
901: 'navmap.wrong.gif' => 'Incorrect',
902: 'navmap.open.gif' => 'Open' );
1.59 bowersj2 903:
904: my %condenseStatuses =
1.66 bowersj2 905: ( $res->NETWORK_FAILURE => 1,
906: $res->NOTHING_SET => 1,
907: $res->CORRECT => 1 );
1.51 bowersj2 908:
909: my %filterHash;
910: # Figure out what we're not displaying
911: foreach (split(/\,/, $ENV{"form.filter"})) {
912: if ($_) {
913: $filterHash{$_} = "1";
914: }
915: }
916:
1.63 bowersj2 917: my $currenturl = $ENV{'form.postdata'};
918: $currenturl=~s/^http\:\/\///;
919: $currenturl=~s/^[^\/]+//;
920: my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl);
921:
1.66 bowersj2 922: $r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');
1.63 bowersj2 923:
1.51 bowersj2 924: # Begin the HTML table
1.59 bowersj2 925: # four cols: resource + indent, chat+feedback, icon, text string
1.51 bowersj2 926: $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
927:
1.66 bowersj2 928: my $condition = 0;
929: if ($ENV{'form.condition'}) {
1.68 bowersj2 930: $condition = 1;
1.66 bowersj2 931: }
932:
933: my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, $condition);
1.53 bowersj2 934: undef $res; # so we don't accidentally use it later
1.72 bowersj2 935: my $indentLevel = 0;
1.61 bowersj2 936: my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";
1.51 bowersj2 937:
938: my $isNewBranch = 0;
1.59 bowersj2 939: my $now = time();
940: my $in24Hours = $now + 24 * 60 * 60;
1.72 bowersj2 941: my $depth = 1;
942:
943: # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
944: # code in iterator->next), so ignore the first one
945: $mapIterator->next();
946: my $curRes = $mapIterator->next();
1.51 bowersj2 947:
1.72 bowersj2 948: while ($depth > 0) {
1.51 bowersj2 949: if ($curRes == $mapIterator->BEGIN_MAP() ||
1.52 bowersj2 950: $curRes == $mapIterator->BEGIN_BRANCH()) {
1.51 bowersj2 951: $indentLevel++;
952: }
953: if ($curRes == $mapIterator->END_MAP() ||
1.52 bowersj2 954: $curRes == $mapIterator->END_BRANCH()) {
1.51 bowersj2 955: $indentLevel--;
956: }
1.52 bowersj2 957: if ($curRes == $mapIterator->BEGIN_BRANCH()) {
958: $isNewBranch = 1;
1.72 bowersj2 959: }
960: if ($curRes == $mapIterator->BEGIN_MAP()) {
961: $depth++;
962: }
963: if ($curRes == $mapIterator->END_MAP()) {
964: $depth--;
1.51 bowersj2 965: }
966:
1.68 bowersj2 967: # Is this resource being blotted out?
968: if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
969: $curRes = $mapIterator->next();
970: next; # and totally ignore this resource
971: }
972:
1.51 bowersj2 973: if (ref($curRes) && $curRes->src()) {
974:
1.66 bowersj2 975: # Step one: Decide which parts to show
976: my @parts = @{$curRes->parts()};
977: my $multipart = scalar(@parts) > 1;
978: my $condensed = 0;
979:
1.51 bowersj2 980: if ($curRes->is_problem()) {
1.66 bowersj2 981: # Is it multipart?
1.59 bowersj2 982:
1.66 bowersj2 983: if ($multipart) {
984: # If it's multipart, see if part 0 is "open"
985: # if it is, display all parts, if it isn't,
986: # just display first
987: if (!$curRes->opendate("0")) {
988: @parts = ("0"); # just display the zero-th part
1.68 bowersj2 989: $condensed = 1;
1.66 bowersj2 990: } else {
991: # Otherwise, only display part 0 if we want to
992: # attach feedback or email information to it
993: if ($curRes->hasDiscussion() || $curRes->getFeedback()) {
994: shift @parts;
995: } else {
996: # If there's discussion or feedback, that counts
997: # as a difference, so display the parts.
998:
999: # Now, we decide whether to condense the
1000: # parts due to similarity
1001: my $status = $curRes->status($parts[1]);
1002: my $due = $curRes->duedate($parts[1]);
1003: my $open = $curRes->opendate($parts[1]);
1004: my $statusAllSame = 1;
1005: my $dueAllSame = 1;
1006: my $openAllSame = 1;
1007: for (my $i = 2; $i < scalar(@parts); $i++) {
1008: if ($curRes->status($parts[$i]) != $status){
1009: $statusAllSame = 0;
1010: }
1011: if ($curRes->duedate($parts[$i]) != $due ) {
1012: $dueAllSame = 0;
1013: }
1014: if ($curRes->opendate($parts[$i]) != $open) {
1015: $openAllSame = 0;
1016: }
1017: }
1018:
1019: # $allSame is true if all the statuses were
1020: # the same. Now, if they are all the same and
1021: # match one of the statuses to condense, or they
1022: # are all open with the same due date, or they are
1023: # all OPEN_LATER with the same open date, display the
1024: # status of the first non-zero part (to get the 'correct'
1025: # status right, since 0 is never 'correct' or 'open').
1026: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1027: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1028: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1029: @parts = ($parts[1]);
1030: $condensed = 1;
1031: }
1032: }
1033: }
1034: }
1.59 bowersj2 1035:
1.51 bowersj2 1036: } else {
1037: @parts[0] = "0"; # this is to get past foreach loop below
1038: # you can consider a non-problem resource as a resource
1039: # with only one part without loss
1040: }
1041:
1.66 bowersj2 1042: # Display one part, in event of network error.
1043: # If this is a single part, we can at least show the correct
1044: # status, but if it's multipart, we're lost.
1045: if ($curRes->{RESOURCE_ERROR}) {
1046: @parts = ("0");
1047: }
1048:
1049: # Step two: Show the parts
1.51 bowersj2 1050: foreach my $part (@parts) {
1.59 bowersj2 1051:
1.66 bowersj2 1052: my $deltalevel = 0; # for inserting the branch icon
1.68 bowersj2 1053: my $nonLinkedText = ""; # unlinked stuff after title
1.51 bowersj2 1054:
1055: # For each thing we're displaying...
1056:
1057: my $stack = $mapIterator->getStack();
1058: my $src = getLinkForResource($stack);
1059:
1060: my $srcHasQuestion = $src =~ /\?/;
1061: my $link = $src.
1062: ($srcHasQuestion?'&':'?') .
1063: 'symb='.&Apache::lonnet::escape($curRes->symb()).
1064: '"';
1065: my $title = $curRes->title();
1066: my $partLabel = "";
1.52 bowersj2 1067: my $newBranchText = "";
1068:
1069: # If this is a new branch, label it so
1070: # (temporary, this should be an icon w/ alt text)
1071: if ($isNewBranch) {
1.59 bowersj2 1072: $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
1.52 bowersj2 1073: $isNewBranch = 0;
1.66 bowersj2 1074: $deltalevel = 1;
1.52 bowersj2 1075: }
1.51 bowersj2 1076:
1077: # links to open and close the folders
1078: my $linkopen = "<a href=\"$link\">";
1079: my $linkclose = "</a>";
1080:
1.61 bowersj2 1081: my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
1.51 bowersj2 1082: if ($curRes->is_problem()) {
1.66 bowersj2 1083: if ($part eq "0" || $condensed) {
1084: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />';
1085: } else {
1086: $icon = $indentString;
1087: }
1.51 bowersj2 1088: }
1089:
1090: # Display the correct icon, link to open or shut map
1091: if ($curRes->is_map()) {
1092: my $mapId = $curRes->map_pc();
1093: my $nowOpen = !defined($filterHash{$mapId});
1094: $icon = $nowOpen ?
1.63 bowersj2 1095: "folder_closed.gif" : "folder_opened.gif";
1.66 bowersj2 1096: $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
1.52 bowersj2 1097: $linkopen = "<a href=\"/adm/navmaps?filter=";
1.66 bowersj2 1098: $linkopen .= ($nowOpen xor $condition) ?
1.51 bowersj2 1099: addToFilter(\%filterHash, $mapId) :
1100: removeFromFilter(\%filterHash, $mapId);
1.66 bowersj2 1101: $linkopen .= "&condition=$condition&$queryAdd\">";
1.51 bowersj2 1102: $linkclose = "</a>";
1.68 bowersj2 1103:
1.51 bowersj2 1104: }
1105:
1106: my $colorizer = "";
1107: if ($curRes->is_problem()) {
1108: my $status = $curRes->status($part);
1109: my $color = $colormap{$status};
1110: if ($color ne "") {
1111: $colorizer = "bgcolor=\"$color\"";
1112: }
1113: }
1114:
1.68 bowersj2 1115: if ($curRes->randomout()) {
1116: $nonLinkedText .= ' <i>(hidden)</i> ';
1117: }
1118:
1.66 bowersj2 1119: # FIRST COL: The resource indentation, branch icon, and name
1120: $r->print(" <tr><td align=\"left\" valign=\"bottom\">\n");
1.51 bowersj2 1121:
1122: # print indentation
1.59 bowersj2 1123: for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
1.51 bowersj2 1124: $r->print($indentString);
1125: }
1126:
1.61 bowersj2 1127: $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n");
1.51 bowersj2 1128:
1.69 bowersj2 1129: if ($curRes->is_problem() && $part ne "0" && !$condensed) {
1.66 bowersj2 1130: $partLabel = " (Part $part)";
1131: $title = "";
1132: }
1133: if ($multipart && $condensed) {
1.68 bowersj2 1134: $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
1.66 bowersj2 1135: }
1.59 bowersj2 1136:
1.66 bowersj2 1137: $r->print(" <a href=\"$link\">$title$partLabel</a> $nonLinkedText");
1138:
1139: if ($curRes->{RESOURCE_ERROR}) {
1140: $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
1141: '<font size="-1">Host down</font>'));
1142: }
1143:
1144: my $discussionHTML = ""; my $feedbackHTML = "";
1145:
1146: # SECOND COL: Is there text or feedback?
1147: if ($curRes->hasDiscussion()) {
1148: $discussionHTML = $linkopen .
1149: '<img border="0" src="/adm/lonMisc/chat.gif" />' .
1150: $linkclose;
1151: }
1152:
1153: if ($curRes->getFeedback()) {
1154: my $feedback = $curRes->getFeedback();
1155: foreach (split(/\,/, $feedback)) {
1156: if ($_) {
1157: $feedbackHTML .= ' <a href="/adm/email?display='
1158: . &Apache::lonnet::escape($_) . '">'
1159: . '<img src="/adm/lonMisc/feedback.gif" '
1160: . 'border="0" /></a>';
1161: }
1162: }
1163: }
1164:
1165: $r->print("<td align=\"left\" valign=\"bottom\">$discussionHTML$feedbackHTML</td>");
1166:
1167: # Is this the first displayed part of a multi-part problem
1168: # that has not been condensed, so we should suppress these two
1169: # columns?
1170: my $firstDisplayed = !$condensed && $multipart && $part eq "0";
1171:
1.69 bowersj2 1172: # THIRD COL: Problem status icon
1.66 bowersj2 1173: if ($curRes->is_problem() &&
1174: !$firstDisplayed) {
1175: my $icon = $statusIconMap{$curRes->status($part)};
1.69 bowersj2 1176: my $alt = $iconAltTags{$icon};
1.66 bowersj2 1177: if ($icon) {
1.69 bowersj2 1178: $r->print("<td valign=\"bottom\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n");
1.66 bowersj2 1179: } else {
1180: $r->print("<td></td>\n");
1181: }
1182: } else { # not problem, no icon
1183: $r->print("<td></td>\n");
1184: }
1185:
1.69 bowersj2 1186: # FOURTH COL: Text description
1.66 bowersj2 1187: $r->print("<td $colorizer align=\"right\" valign=\"bottom\">\n");
1.51 bowersj2 1188:
1.61 bowersj2 1189: if ($curRes->kind() eq "res" &&
1190: $curRes->is_problem() &&
1.66 bowersj2 1191: !$firstDisplayed) {
1.53 bowersj2 1192: $r->print (getDescription($curRes, $part));
1.51 bowersj2 1193: }
1.68 bowersj2 1194: if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
1195: $r->print('(randomly select ' . $curRes->randompick() .')');
1196: }
1.59 bowersj2 1197:
1.66 bowersj2 1198: $r->print("</td></tr>\n");
1.51 bowersj2 1199: }
1200: }
1201: $curRes = $mapIterator->next();
1202: }
1203:
1204: $r->print("</table></body></html>");
1205:
1.59 bowersj2 1206: $navmap->untieHashes();
1207:
1.51 bowersj2 1208: return OK;
1209: }
1210:
1211: # Convenience functions: Returns a string that adds or subtracts
1212: # the second argument from the first hash, appropriate for the
1213: # query string that determines which folders to recurse on
1214: sub addToFilter {
1215: my $hashIn = shift;
1216: my $addition = shift;
1217: my %hash = %$hashIn;
1218: $hash{$addition} = 1;
1219:
1220: return join (",", keys(%hash));
1221: }
1222:
1223: sub removeFromFilter {
1224: my $hashIn = shift;
1225: my $subtraction = shift;
1226: my %hash = %$hashIn;
1227:
1228: delete $hash{$subtraction};
1229: return join(",", keys(%hash));
1230: }
1231:
1232: # Convenience function: Given a stack returned from getStack on the iterator,
1233: # return the correct src() value.
1234: # Later, this should add an anchor when we start putting anchors in pages.
1235: sub getLinkForResource {
1236: my $stack = shift;
1237: my $res;
1238:
1239: # Check to see if there are any pages in the stack
1240: foreach $res (@$stack) {
1241: if (defined($res) && $res->is_page()) {
1242: return $res->src();
1243: }
1244: }
1245:
1246: # Failing that, return the src of the last resource that is defined
1247: # (when we first recurse on a map, it puts an undefined resource
1248: # on the bottom because $self->{HERE} isn't defined yet, and we
1249: # want the src for the map anyhow)
1250: foreach (@$stack) {
1251: if (defined($_)) { $res = $_; }
1252: }
1253:
1254: return $res->src();
1255: }
1256:
1.53 bowersj2 1257: # Convenience function: This seperates the logic of how to create
1258: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
1259: # etc.) into a seperate function. It takes a resource object as the
1260: # first parameter, and the part number of the resource as the second.
1261: # It's basically a big switch statement on the status of the resource.
1262:
1263: sub getDescription {
1264: my $res = shift;
1265: my $part = shift;
1.69 bowersj2 1266: my $status = $res->status($part);
1.53 bowersj2 1267:
1268: if ($status == $res->NETWORK_FAILURE) { return ""; }
1269: if ($status == $res->NOTHING_SET) {
1270: return "Not currently assigned.";
1271: }
1272: if ($status == $res->OPEN_LATER) {
1.73 ! bowersj2 1273: return "Open " . timeToHumanString($res->opendate($part));
1.53 bowersj2 1274: }
1275: if ($status == $res->OPEN) {
1.66 bowersj2 1276: if ($res->duedate()) {
1.73 ! bowersj2 1277: return "Due " . timeToHumanString($res->duedate($part));
1.66 bowersj2 1278: } else {
1279: return "Open, no due date";
1280: }
1.53 bowersj2 1281: }
1.54 bowersj2 1282: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.73 ! bowersj2 1283: return "Answer open " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 1284: }
1285: if ($status == $res->PAST_DUE_NO_ANSWER) {
1.73 ! bowersj2 1286: return "Was due " . timeToHumanString($res->duedate($part));
1.53 bowersj2 1287: }
1288: if ($status == $res->ANSWER_OPEN) {
1289: return "Answer available";
1290: }
1.59 bowersj2 1291: if ($status == $res->EXCUSED) {
1.66 bowersj2 1292: return "Excused by instructor";
1.59 bowersj2 1293: }
1.69 bowersj2 1294: if ($status == $res->ATTEMPTED) {
1295: return "Not yet graded.";
1296: }
1.59 bowersj2 1297: if ($status == $res->TRIES_LEFT) {
1.66 bowersj2 1298: my $tries = $res->tries();
1299: my $maxtries = $res->maxtries();
1300: my $triesString = "($tries of $maxtries tries used)";
1301: if ($res->duedate()) {
1.73 ! bowersj2 1302: return "Due " . timeToHumanString($res->duedate($part)) .
1.66 bowersj2 1303: " $triesString";
1304: } else {
1305: return "No due date $triesString";
1306: }
1.59 bowersj2 1307: }
1.53 bowersj2 1308: }
1309:
1.68 bowersj2 1310: sub advancedUser {
1311: return $ENV{'user.adv'};
1312: }
1313:
1.73 ! bowersj2 1314:
! 1315: # timeToHumanString takes a time number and converts it to a
! 1316: # human-readable representation, meant to be used in the following
! 1317: # manner:
! 1318: # print "Due $timestring"
! 1319: # print "Open $timestring"
! 1320: # print "Answer available $timestring"
! 1321: # Very, very, very, VERY English-only... goodness help a localizer on
! 1322: # this func...
1.53 bowersj2 1323: sub timeToHumanString {
1.58 albertel 1324: my ($time) = @_;
1325: # zero, '0' and blank are bad times
1.73 ! bowersj2 1326: if (!$time) {
! 1327: return 'never';
! 1328: }
! 1329:
! 1330: my $now = time();
! 1331:
! 1332: my @time = localtime($time);
! 1333: my @now = localtime($now);
! 1334:
! 1335: # Positive = future
! 1336: my $delta = $time - $now;
! 1337:
! 1338: my $minute = 60;
! 1339: my $hour = 60 * $minute;
! 1340: my $day = 24 * $hour;
! 1341: my $week = 7 * $day;
! 1342: my $inPast = 0;
! 1343:
! 1344: # Logic in comments:
! 1345: # Is it now? (extremely unlikely)
! 1346: if ( $delta == 0 ) {
! 1347: return "this instant";
! 1348: }
! 1349:
! 1350: if ($delta < 0) {
! 1351: $inPast = 1;
! 1352: $delta = -$delta;
! 1353: }
! 1354:
! 1355: # Is it in the future?
! 1356: if ( $delta > 0 ) {
! 1357: # Is it less then a minute away?
! 1358: my $tense = $inPast ? " ago" : "";
! 1359: my $prefix = $inPast ? "" : "in ";
! 1360: if ( $delta < $minute ) {
! 1361: if ($delta == 1) { return "${prefix}1 second$tense"; }
! 1362: return "$prefix$delta seconds$tense";
! 1363: }
! 1364:
! 1365: # Is it less then an hour away?
! 1366: if ( $delta < $hour ) {
! 1367: # If so, use minutes
! 1368: my $minutes = floor($delta / 60);
! 1369: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
! 1370: return "$prefix$minutes minutes$tense";
! 1371: }
! 1372:
! 1373: # Is it less then 24 hours away? If so,
! 1374: # display hours + minutes
! 1375: if ( $delta < $hour * 24) {
! 1376: my $hours = floor($delta / $hour);
! 1377: my $minutes = floor(($delta % $hour) / $minute);
! 1378: my $hourString = "$hours hours";
! 1379: my $minuteString = ", $minutes minutes";
! 1380: if ($hours == 1) {
! 1381: $hourString = "1 hour";
! 1382: }
! 1383: if ($minutes == 1) {
! 1384: $minuteString = ", 1 minute";
! 1385: }
! 1386: if ($minutes == 0) {
! 1387: $minuteString = "";
! 1388: }
! 1389: return "$prefix$hourString$minuteString$tense";
! 1390: }
! 1391:
! 1392: # Less then 5 days away, display day of the week and
! 1393: # HH:MM
! 1394: if ( $delta < $day * 5 ) {
! 1395: my $timeStr = strftime("%A at %I:%M %P", localtime($time));
! 1396: $timeStr =~ s/12:00 am/midnight/;
! 1397: $timeStr =~ s/12:00 pm/noon/;
! 1398: return ($inPast ? "last " : "next ") .
! 1399: $timeStr;
! 1400: }
! 1401:
! 1402: # Is it this year?
! 1403: if ( $time[5] == $now[5]) {
! 1404: # Return on Month Day, HH:MM meridian
! 1405: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
! 1406: $timeStr =~ s/12:00 am/midnight/;
! 1407: $timeStr =~ s/12:00 pm/noon/;
! 1408: return $timeStr;
! 1409: }
! 1410:
! 1411: # Not this year, so show the year
! 1412: my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
! 1413: $timeStr =~ s/12:00 am/midnight/;
! 1414: $timeStr =~ s/12:00 pm/noon/;
! 1415: return $timeStr;
1.58 albertel 1416: }
1.53 bowersj2 1417: }
1418:
1.51 bowersj2 1419: 1;
1420:
1421: package Apache::lonnavmaps::navmap;
1422:
1423: =pod
1424:
1425: 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.
1426:
1427: =head1 navmap object: Encapsulating the compiled nav map
1428:
1429: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
1430:
1431: 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.
1432:
1433: You must obtain resource objects through the navmap object.
1434:
1435: =head2 Methods
1436:
1437: =over 4
1438:
1.70 bowersj2 1439: =item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. 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 1440:
1441: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
1442:
1443: =cut
1444:
1445: use strict;
1446: use GDBM_File;
1447:
1448: sub new {
1449: # magic invocation to create a class instance
1450: my $proto = shift;
1451: my $class = ref($proto) || $proto;
1452: my $self = {};
1453:
1454: $self->{NAV_HASH_FILE} = shift;
1455: $self->{PARM_HASH_FILE} = shift;
1456: $self->{GENERATE_COURSE_USER_OPT} = shift;
1.55 bowersj2 1457: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1.51 bowersj2 1458:
1459: # Resource cache stores navmapresource's as we reference them. We generate
1460: # them on-demand so we don't pay for creating resources unless we use them.
1461: $self->{RESOURCE_CACHE} = {};
1462:
1463: # Network failure flag, if we accessed the course or user opt and
1464: # failed
1465: $self->{NETWORK_FAILURE} = 0;
1466:
1467: # tie the nav hash
1468: my %navmaphash;
1469: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
1470: &GDBM_READER(), 0640))) {
1471: return undef;
1472: }
1473: $self->{NAV_HASH} = \%navmaphash;
1474:
1475: my %parmhash;
1476: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
1477: &GDBM_READER(), 0640)))
1478: {
1.66 bowersj2 1479: untie $self->{PARM_HASH};
1.51 bowersj2 1480: return undef;
1481: }
1482: $self->{PARM_HASH} = \%parmhash;
1483: $self->{HASH_TIED} = 1;
1484:
1485: # If the course opt hash and the user opt hash should be generated,
1486: # generate them
1487: if ($self->{GENERATE_COURSE_USER_OPT}) {
1488: my $uname=$ENV{'user.name'};
1489: my $udom=$ENV{'user.domain'};
1490: my $uhome=$ENV{'user.home'};
1491: my $cid=$ENV{'request.course.id'};
1492: my $chome=$ENV{'course.'.$cid.'.home'};
1493: my ($cdom,$cnum)=split(/\_/,$cid);
1494:
1495: my $userprefix=$uname.'_'.$udom.'_';
1496:
1497: my %courserdatas; my %useropt; my %courseopt;
1498: unless ($uhome eq 'no_host') {
1499: # ------------------------------------------------- Get coursedata (if present)
1500: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1501: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1502: ':resourcedata',$chome);
1503: if ($reply!~/^error\:/) {
1504: $courserdatas{$cid}=$reply;
1505: $courserdatas{$cid.'.last_cache'}=time;
1506: }
1507: # check to see if network failed
1508: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1509: {
1510: $self->{NETWORK_FAILURE} = 1;
1511: }
1512: }
1513: foreach (split(/\&/,$courserdatas{$cid})) {
1514: my ($name,$value)=split(/\=/,$_);
1515: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1516: &Apache::lonnet::unescape($value);
1517: }
1518: # --------------------------------------------------- Get userdata (if present)
1519: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1520: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1521: if ($reply!~/^error\:/) {
1522: $userrdatas{$uname.'___'.$udom}=$reply;
1523: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1524: }
1525: # check to see if network failed
1526: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1527: {
1528: $self->{NETWORK_FAILURE} = 1;
1529: }
1530: }
1531: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1532: my ($name,$value)=split(/\=/,$_);
1533: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1534: &Apache::lonnet::unescape($value);
1535: }
1.55 bowersj2 1536: $self->{COURSE_OPT} = \%courseopt;
1537: $self->{USER_OPT} = \%useropt;
1.51 bowersj2 1538: }
1539: }
1540:
1.55 bowersj2 1541: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
1542: my $cid=$ENV{'request.course.id'};
1543: my ($cdom,$cnum)=split(/\_/,$cid);
1544:
1545: my %emailstatus = &Apache::lonnet::dump('email_status');
1.56 bowersj2 1546: my $logoutTime = $emailstatus{'logout'};
1547: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1.55 bowersj2 1548: $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
1549: $courseLeaveTime : $logoutTime);
1.56 bowersj2 1550: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1.55 bowersj2 1551: $cdom, $cnum);
1552: my %feedback=();
1553: my %error=();
1554: my $keys = &Apache::lonnet::reply('keys:'.
1555: $ENV{'user.domain'}.':'.
1556: $ENV{'user.name'}.':nohist_email',
1557: $ENV{'user.home'});
1558:
1559: foreach my $msgid (split(/\&/, $keys)) {
1560: $msgid=&Apache::lonnet::unescape($msgid);
1561: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1562: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1563: my ($what,$url)=($1,$2);
1564: my %status=
1565: &Apache::lonnet::get('email_status',[$msgid]);
1566: if ($status{$msgid}=~/^error\:/) {
1567: $status{$msgid}='';
1568: }
1569:
1570: if (($status{$msgid} eq 'new') ||
1571: (!$status{$msgid})) {
1572: if ($what eq 'Error') {
1573: $error{$url}.=','.$msgid;
1574: } else {
1575: $feedback{$url}.=','.$msgid;
1576: }
1577: }
1578: }
1579: }
1580:
1581: $self->{FEEDBACK} = \%feedback;
1582: $self->{ERROR_MSG} = \%error; # what is this? JB
1583: $self->{DISCUSSION_TIME} = \%discussiontime;
1584: $self->{EMAIL_STATUS} = \%emailstatus;
1585:
1586: }
1587:
1.51 bowersj2 1588: bless($self);
1.55 bowersj2 1589:
1590: return $self;
1591: }
1.51 bowersj2 1592:
1.55 bowersj2 1593: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1594: sub courseMapDefined {
1595: my $self = shift;
1596: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1597:
1.56 bowersj2 1598: my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
1599: my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
1.55 bowersj2 1600: return $firstres && $lastres;
1.51 bowersj2 1601: }
1602:
1603: sub getIterator {
1604: my $self = shift;
1605: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.63 bowersj2 1606: shift, undef, shift);
1.51 bowersj2 1607: return $iterator;
1608: }
1609:
1610: # unties the hash when done
1611: sub untieHashes {
1612: my $self = shift;
1.60 bowersj2 1613: untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
1614: untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
1.51 bowersj2 1615: $self->{HASH_TIED} = 0;
1616: }
1617:
1618: # when the object is destroyed, be sure to untie all the hashes we tied.
1619: sub DESTROY {
1620: my $self = shift;
1621: $self->untieHashes();
1622: }
1623:
1.59 bowersj2 1624: # Private function: Does the given resource (as a symb string) have
1625: # current discussion? Returns 0 if chat/mail data not extracted.
1626: sub hasDiscussion {
1627: my $self = shift;
1628: my $symb = shift;
1629: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
1630:
1631: return $self->{DISCUSSION_TIME}->{$symb} >
1.66 bowersj2 1632: $self->{LAST_CHECK};
1.59 bowersj2 1633: }
1634:
1635: # Private function: Does the given resource (as a symb string) have
1636: # current feedback? Returns the string in the feedback hash, which
1637: # will be false if it does not exist.
1638: sub getFeedback {
1639: my $self = shift;
1640: my $symb = shift;
1641:
1642: if (!defined($self->{FEEDBACK})) { return ""; }
1643:
1644: return $self->{FEEDBACK}->{$symb};
1645: }
1646:
1.51 bowersj2 1647: =pod
1648:
1649: =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.
1650:
1651: =cut
1652:
1653: # The strategy here is to cache the resource objects, and only construct them
1654: # as we use them. The real point is to prevent reading any more from the tied
1655: # hash then we have to, which should hopefully alleviate speed problems.
1656: # Caching is just an incidental detail I throw in because it makes sense.
1657:
1658: sub getById {
1659: my $self = shift;
1660: my $id = shift;
1661:
1662: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1663: {
1664: return $self->{RESOURCE_CACHE}->{$id};
1665: }
1666:
1667: # resource handles inserting itself into cache.
1668: return Apache::lonnavmaps::resource->new($self, $id);
1669: }
1670:
1671: =pod
1672:
1673: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1674:
1675: =cut
1676:
1677: sub firstResource {
1678: my $self = shift;
1679: my $firstResource = $self->{NAV_HASH}->{'map_start_' .
1680: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1681: return $self->getById($firstResource);
1682: }
1683:
1684: =pod
1685:
1686: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1687:
1688: =cut
1689:
1690: sub finishResource {
1691: my $self = shift;
1692: my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
1693: &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1694: return $self->getById($firstResource);
1695: }
1696:
1697: # -------------------------------------------- Figure out a cascading parameter
1698: #
1699: # For this function to work
1700: #
1701: # * parmhash needs to be tied
1702: # * courseopt and useropt need to be initialized for this user and course
1703: #
1704:
1705: sub parmval {
1706: my $self = shift;
1707: my ($what,$symb)=@_;
1708: my $cid=$ENV{'request.course.id'};
1709: my $csec=$ENV{'request.course.sec'};
1710: my $uname=$ENV{'user.name'};
1711: my $udom=$ENV{'user.domain'};
1712:
1713: unless ($symb) { return ''; }
1714: my $result='';
1715:
1716: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1717:
1718: # ----------------------------------------------------- Cascading lookup scheme
1719: my $rwhat=$what;
1720: $what=~s/^parameter\_//;
1721: $what=~s/\_/\./;
1722:
1723: my $symbparm=$symb.'.'.$what;
1724: my $mapparm=$mapname.'___(all).'.$what;
1725: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1726:
1727: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1728: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1729: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1730:
1731: my $courselevel= $usercourseprefix.'.'.$what;
1732: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1733: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1734:
1735: my $useropt = $self->{USER_OPT};
1736: my $courseopt = $self->{COURSE_OPT};
1737: my $parmhash = $self->{PARM_HASH};
1738:
1739: # ---------------------------------------------------------- first, check user
1740: if ($uname and defined($useropt)) {
1.57 albertel 1741: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
1742: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
1743: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
1.51 bowersj2 1744: }
1745:
1746: # ------------------------------------------------------- second, check course
1747: if ($csec and defined($courseopt)) {
1.57 albertel 1748: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
1749: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
1750: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
1.51 bowersj2 1751: }
1752:
1753: if (defined($courseopt)) {
1.57 albertel 1754: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
1755: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
1756: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
1.51 bowersj2 1757: }
1758:
1759: # ----------------------------------------------------- third, check map parms
1760:
1761: my $thisparm=$$parmhash{$symbparm};
1.57 albertel 1762: if (defined($thisparm)) { return $thisparm; }
1.51 bowersj2 1763:
1764: # ----------------------------------------------------- fourth , check default
1765:
1766: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57 albertel 1767: if (defined($default)) { return $default}
1.51 bowersj2 1768:
1769: # --------------------------------------------------- fifth , cascade up parts
1770:
1771: my ($space,@qualifier)=split(/\./,$rwhat);
1772: my $qualifier=join('.',@qualifier);
1773: unless ($space eq '0') {
1774: my ($part,$id)=split(/\_/,$space);
1775: if ($id) {
1776: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1.57 albertel 1777: if (defined($partgeneral)) { return $partgeneral; }
1.51 bowersj2 1778: } else {
1779: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1.57 albertel 1780: if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51 bowersj2 1781: }
1782: }
1783: return '';
1784: }
1785:
1786:
1787: 1;
1788:
1789: package Apache::lonnavmaps::iterator;
1790:
1791: # This package must precede "navmap" because "navmap" uses it. In
1792: # order to keep the documentation order straight, the iterator is documented
1793: # after the navmap object.
1794:
1795: =pod
1796:
1797: =back
1798:
1799: =head1 navmap Iterator
1800:
1801: 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.
1802:
1803: 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:
1804:
1805: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1806:
1807: To get the next thing from the iterator, call B<next>:
1808:
1809: C<my $nextThing = $resourceIterator-E<gt>next()>
1810:
1811: getIterator behaves as follows:
1812:
1813: =over 4
1814:
1.70 bowersj2 1815: =item B<getIterator>(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(). 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 1816:
1.70 bowersj2 1817: 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: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.
1.51 bowersj2 1818:
1819: 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:
1820:
1821: =over 4
1822:
1.70 bowersj2 1823: =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
1824:
1825: =item * END_MAP: The map is now done.
1826:
1827: =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
1828:
1829: =item * END_BRANCH: The branch is now done.
1.51 bowersj2 1830:
1831: =back
1832:
1.70 bowersj2 1833: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
1834:
1835: =back
1.51 bowersj2 1836:
1837: =cut
1838:
1839: # Here are the tokens for the iterator:
1840:
1841: sub BEGIN_MAP { return 1; } # begining of a new map
1842: sub END_MAP { return 2; } # end of the map
1843: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1844: sub END_BRANCH { return 4; } # end of a branch
1845:
1846: # Params: nav map, start resource, end resource, filter, condition,
1847: # already seen hash ref
1848:
1849: sub new {
1850: # magic invocation to create a class instance
1851: my $proto = shift;
1852: my $class = ref($proto) || $proto;
1853: my $self = {};
1854:
1855: $self->{NAV_MAP} = shift;
1856: return undef unless ($self->{NAV_MAP});
1857:
1858: # Handle the parameters
1859: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1860: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1861:
1862: # If the given resources are just the ID of the resource, get the
1863: # objects
1864: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1865: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1866: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1867: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1868:
1869: $self->{FILTER} = shift;
1870:
1871: # A hash, used as a set, of resource already seen
1872: $self->{ALREADY_SEEN} = shift;
1873: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 1874: $self->{CONDITION} = shift;
1.51 bowersj2 1875:
1876: # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
1877: $self->{STARTED} = 0;
1878:
1879: # Should we continue calling the recursive iterator, if any?
1880: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1881: # The recursive iterator, if any
1882: $self->{RECURSIVE_ITERATOR} = undef;
1883: # Are we recursing on a map, or a branch?
1884: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
1885: # And the count of how deep it is, so that this iterator can keep track of
1886: # when to pick back up again.
1887: $self->{RECURSIVE_DEPTH} = 0;
1888:
1889: # For keeping track of our branches, we maintain our own stack
1890: $self->{BRANCH_STACK} = [];
1891: # If the size shrinks, we exhausted a branch
1892: $self->{BRANCH_STACK_SIZE} = 0;
1893: $self->{BRANCH_DEPTH} = 0;
1894:
1895: # For returning two things in a forced sequence
1896: $self->{FORCE_NEXT} = undef;
1897:
1898: # Start with the first resource
1899: push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
1900: $self->{BRANCH_STACK_SIZE} = 1;
1901:
1902: bless($self);
1903: return $self;
1904: }
1905:
1906: # Note... this function is *touchy*. I strongly recommend tracing
1907: # through it with the debugger a few times on a non-trivial map before
1908: # modifying it. Order is *everything*.
1909: sub next {
1910: my $self = shift;
1911:
1912: # Iterator logic goes here
1913:
1914: # Are we using a recursive iterator? If so, pull from that and
1915: # watch the depth; we want to resume our level at the correct time.
1916: if ($self->{RECURSIVE_ITERATOR_FLAG})
1917: {
1918: # grab the next from the recursive iterator
1919: my $next = $self->{RECURSIVE_ITERATOR}->next();
1920:
1921: # is it a begin or end map? Update depth if so
1922: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1923: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1924:
1925: # Are we back at depth 0? If so, stop recursing.
1926: if ($self->{RECURSIVE_DEPTH} == 0) {
1927: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1928: }
1929:
1930: return $next;
1931: }
1932:
1.68 bowersj2 1933: # Is this return value pre-determined?
1934: if (defined($self->{FORCE_NEXT})) {
1935: my $tmp = $self->{FORCE_NEXT};
1936: $self->{FORCE_NEXT} = undef;
1937: return $tmp;
1938: }
1939:
1.51 bowersj2 1940: # Is there a current resource to grab? If not, then return
1941: # END_BRANCH and END_MAP in succession.
1942: if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
1943: if ($self->{BRANCH_DEPTH} > 0) {
1944: $self->{FORCE_NEXT} = $self->END_MAP();
1.52 bowersj2 1945: $self->{BRANCH_DEPTH}--;
1.51 bowersj2 1946: return $self->END_BRANCH();
1947: } else {
1948: return $self->END_MAP();
1949: }
1950: }
1951:
1952: # Have we not yet begun? If not, return BEGIN_MAP and
1953: # remember that we've started.
1954: if ( !$self->{STARTED} ) {
1955: $self->{STARTED} = 1;
1956: return $self->BEGIN_MAP;
1957: }
1958:
1959: # Did the branch stack shrink since last run? If so,
1960: # we exhausted a branch last time, therefore, we're about
1961: # to start a new one. (We know because we already checked to see
1962: # if the stack was empty.)
1963: if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
1.52 bowersj2 1964: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1965: $self->{BRANCH_DEPTH}++;
1966: return $self->BEGIN_BRANCH();
1.51 bowersj2 1967: }
1968:
1.52 bowersj2 1969: # Remember the size for comparision next time.
1970: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
1971:
1972: # If the next resource we mean to return is going to need
1973: # a lower branch level, terminate branches until we get
1974: # there.
1975:
1.51 bowersj2 1976: # Get the next resource in the branch
1977: $self->{HERE} = pop @{$self->{BRANCH_STACK}};
1.52 bowersj2 1978:
1979: # Are we at the right depth? If not, close a branch and return
1980: # the current resource onto the branch stack
1981: if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH})
1982: && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} <
1983: $self->{BRANCH_DEPTH} ) {
1984: $self->{BRANCH_DEPTH}--;
1985: # return it so we can pick it up eventually
1986: push @{$self->{BRANCH_STACK}}, $self->{HERE};
1987: return $self->END_BRANCH();
1988: }
1989:
1.51 bowersj2 1990: # We always return it after this point and never before
1991: # (proof: look at just the return statements), so we
1992: # remember that we've seen this.
1993: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
1994:
1995: # Get the next possible resources
1996: my $nextUnfiltered = $self->{HERE}->getNext();
1997: my $next = [];
1998:
1999: # filter the next possibilities to remove things we've
1.52 bowersj2 2000: # already seen. Also, remember what branch depth they should
2001: # be displayed at, since there's no other reliable way to tell.
1.51 bowersj2 2002: foreach (@$nextUnfiltered) {
1.52 bowersj2 2003: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
2004: push @$next, $_;
2005: $_->{DATA}->{ITERATOR_DEPTH} =
2006: $self->{BRANCH_DEPTH} + 1;
2007: }
1.51 bowersj2 2008: }
2009:
2010: # Handle branch cases:
2011: # Nothing is available next: BRANCH_END
2012: # 1 thing next: standard non-branch
2013: # 2+ things next: have some branches
2014: my $nextCount = scalar(@$next);
2015: if ($nextCount == 0) {
1.52 bowersj2 2016: # Return this and on the next run, close the branch up if we're
2017: # in a branch
2018: if ($self->{BRANCH_DEPTH} > 0 ) {
2019: $self->{FORCE_NEXT} = $self->END_BRANCH();
2020: $self->{BRANCH_DEPTH}--;
2021: }
1.51 bowersj2 2022: }
2023:
2024: while (@$next) {
2025: # copy the next possibilities over to the branch stack
2026: # in the right order
1.52 bowersj2 2027: push @{$self->{BRANCH_STACK}}, shift @$next;
1.51 bowersj2 2028: }
2029:
2030: if ($nextCount >= 2) {
1.52 bowersj2 2031: $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
2032: $self->{BRANCH_DEPTH}++;
1.51 bowersj2 2033: return $self->{HERE};
2034: }
2035:
2036: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 2037: if ($self->{HERE}->is_map() &&
1.63 bowersj2 2038: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 2039: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2040: my $firstResource = $self->{HERE}->map_start();
2041: my $finishResource = $self->{HERE}->map_finish();
2042:
2043: $self->{RECURSIVE_ITERATOR} =
2044: Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 2045: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.66 bowersj2 2046: $self->{CONDITION});
1.51 bowersj2 2047: }
2048:
2049: return $self->{HERE};
2050: }
2051:
2052: =pod
2053:
2054: 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).
2055:
2056: =cut
2057:
2058: sub getStack {
2059: my $self=shift;
2060:
2061: my @stack;
2062:
2063: $self->populateStack(\@stack);
2064:
2065: return \@stack;
2066: }
2067:
2068: # Private method: Calls the iterators recursively to populate the stack.
2069: sub populateStack {
2070: my $self=shift;
2071: my $stack = shift;
2072:
2073: push @$stack, $self->{HERE};
2074:
2075: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2076: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
2077: }
2078: }
2079:
1.1 www 2080: 1;
1.2 www 2081:
1.51 bowersj2 2082: package Apache::lonnavmaps::resource;
2083:
2084: use Apache::lonnet;
2085:
2086: =pod
2087:
2088: =head1 Object: resource
2089:
2090: 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.
2091:
2092: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
2093:
2094: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
2095:
2096: =head2 Public Members
2097:
2098: 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.
2099:
2100: =head2 Methods
2101:
2102: =over 4
2103:
1.70 bowersj2 2104: =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. Very rarely, if ever, called directly. Use the nav map->getByID() method.
2105:
2106: =back
1.51 bowersj2 2107:
2108: =cut
2109:
2110: sub new {
2111: # magic invocation to create a class instance
2112: my $proto = shift;
2113: my $class = ref($proto) || $proto;
2114: my $self = {};
2115:
2116: $self->{NAV_MAP} = shift;
2117: $self->{ID} = shift;
2118:
2119: # Store this new resource in the parent nav map's cache.
2120: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 2121: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 2122:
2123: # A hash that can be used by two-pass algorithms to store data
2124: # about this resource in. Not used by the resource object
2125: # directly.
2126: $self->{DATA} = {};
2127:
2128: bless($self);
2129:
2130: return $self;
2131: }
2132:
1.70 bowersj2 2133: # private function: simplify the NAV_HASH lookups we keep doing
2134: # pass the name, and to automatically append my ID, pass a true val on the
2135: # second param
2136: sub navHash {
2137: my $self = shift;
2138: my $param = shift;
2139: my $id = shift;
2140: return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
2141: }
2142:
1.51 bowersj2 2143: =pod
2144:
1.70 bowersj2 2145: B<Metadata Retreival>
2146:
2147: These are methods that help you retrieve metadata about the resource:
2148:
2149: =over 4
2150:
2151: =item * B<ext>: Returns true if the resource is external.
2152:
2153: =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
2154:
2155: =item * B<kind>: Returns the kind of the resource from the compiled nav map.
2156:
2157: =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.
1.51 bowersj2 2158:
1.70 bowersj2 2159: =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
2160:
2161: =item * B<src>: Returns the source for the resource.
2162:
2163: =item * B<symb>: Returns the symb for the resource.
2164:
2165: =item * B<title>: Returns the title of the resource.
2166:
2167: =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
1.51 bowersj2 2168:
2169: =item * B<type>: Returns the type of the resource, "start", "normal", or "finish".
2170:
2171: =back
2172:
2173: =cut
2174:
2175: # These info functions can be used directly, as they don't return
2176: # resource information.
1.70 bowersj2 2177: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.51 bowersj2 2178: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
2179: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 2180: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
2181: sub randompick {
2182: my $self = shift;
2183: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
2184: '.0.parameter_randompick'};
2185: }
1.51 bowersj2 2186: sub src {
2187: my $self=shift;
2188: return $self->navHash("src_", 1);
2189: }
2190: sub symb {
2191: my $self=shift;
2192: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
2193: my $symbSrc = &Apache::lonnet::declutter($self->src());
2194: return &Apache::lonnet::declutter(
2195: $self->navHash('map_id_'.$first))
2196: . '___' . $second . '___' . $symbSrc;
2197: }
1.70 bowersj2 2198: sub title { my $self=shift; return $self->navHash("title_", 1); }
2199: sub to { my $self=shift; return $self->navHash("to_", 1); }
2200: sub type { my $self=shift; return $self->navHash("type_", 1); }
2201:
2202: =pod
2203:
2204: B<Predicate Testing the Resource>
2205:
2206: These methods are shortcuts to deciding if a given resource has a given property.
2207:
2208: =over 4
2209:
2210: =item * B<is_map>: Returns true if the resource is a map type.
2211:
2212: =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
2213:
2214: =item * B<is_page>: Returns true if the resource is a page.
2215:
2216: =item * B<is_problem>: Returns true if the resource is a problem.
2217:
2218: =item * B<is_sequence>: Returns true if the resource sequence.
2219:
2220: =back
2221:
2222: =cut
2223:
2224:
2225: sub is_html {
1.51 bowersj2 2226: my $self=shift;
2227: my $src = $self->src();
1.70 bowersj2 2228: return ($src =~ /html$/);
1.51 bowersj2 2229: }
1.70 bowersj2 2230: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
2231: sub is_page {
1.51 bowersj2 2232: my $self=shift;
2233: my $src = $self->src();
1.70 bowersj2 2234: return ($src =~ /page$/);
1.51 bowersj2 2235: }
1.70 bowersj2 2236: sub is_problem {
1.51 bowersj2 2237: my $self=shift;
2238: my $src = $self->src();
1.70 bowersj2 2239: return ($src =~ /problem$/);
1.51 bowersj2 2240: }
1.70 bowersj2 2241: sub is_sequence {
1.51 bowersj2 2242: my $self=shift;
2243: my $src = $self->src();
1.70 bowersj2 2244: return ($src =~ /sequence$/);
1.51 bowersj2 2245: }
2246:
2247:
2248:
2249:
1.70 bowersj2 2250:
1.51 bowersj2 2251: # Move this into POD: In order to use these correctly, courseopt
2252: # and useropt need to be generated
2253: sub parmval {
2254: my $self = shift;
2255: my $what = shift;
2256: my $part = shift || "0";
2257: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
2258: }
2259:
1.70 bowersj2 2260: =pod
2261:
2262: B<Map Methods>
2263:
2264: These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
2265:
2266: =over 4
2267:
2268: =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
2269:
2270: =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
2271:
2272: =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
2273:
2274: =item * B<map_type>: Returns a string with the type of the map in it.
2275:
2276: =back
1.51 bowersj2 2277:
1.70 bowersj2 2278: =cut
1.51 bowersj2 2279:
2280: sub map_finish {
2281: my $self = shift;
2282: my $src = $self->src();
2283: my $res = $self->navHash("map_finish_$src", 0);
2284: $res = $self->{NAV_MAP}->getById($res);
2285: return $res;
2286: }
1.70 bowersj2 2287: sub map_pc {
2288: my $self = shift;
2289: my $src = $self->src();
2290: return $self->navHash("map_pc_$src", 0);
2291: }
1.51 bowersj2 2292: sub map_start {
2293: my $self = shift;
2294: my $src = $self->src();
2295: my $res = $self->navHash("map_start_$src", 0);
2296: $res = $self->{NAV_MAP}->getById($res);
2297: return $res;
2298: }
2299: sub map_type {
2300: my $self = shift;
2301: my $pc = $self->map_pc();
2302: return $self->navHash("map_type_$pc", 0);
2303: }
2304:
2305:
2306:
2307: #####
2308: # Property queries
2309: #####
2310:
2311: # These functions will be responsible for returning the CORRECT
2312: # VALUE for the parameter, no matter what. So while they may look
2313: # like direct calls to parmval, they can be more then that.
2314: # So, for instance, the duedate function should use the "duedatetype"
2315: # information, rather then the resource object user.
2316:
2317: =pod
2318:
2319: =head2 Resource Parameters
2320:
1.70 bowersj2 2321: 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 parameter.
1.51 bowersj2 2322:
2323: 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.)
2324:
2325: =over 4
2326:
2327: =item * B<acc>: Get the Client IP/Name Access Control information.
2328:
2329: =item * B<answerdate>: Get the answer-reveal date for the problem.
2330:
2331: =item * B<duedate>: Get the due date for the problem.
2332:
2333: =item * B<tries>: Get the number of tries the student has used on the problem.
2334:
2335: =item * B<maxtries>: Get the number of max tries allowed.
2336:
2337: =item * B<opendate>: Get the open date for the problem.
2338:
2339: =item * B<sig>: Get the significant figures setting.
2340:
2341: =item * B<tol>: Get the tolerance for the problem.
2342:
1.70 bowersj2 2343: =item * B<tries>: Get the number of tries the user has already used on the problem.
2344:
1.51 bowersj2 2345: =item * B<type>: Get the question type for the problem.
2346:
2347: =item * B<weight>: Get the weight for the problem.
2348:
2349: =back
2350:
2351: =cut
2352:
2353: sub acc {
2354: (my $self, my $part) = @_;
2355: return $self->parmval("acc", $part);
2356: }
2357: sub answerdate {
2358: (my $self, my $part) = @_;
2359: # Handle intervals
2360: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
2361: return $self->duedate($part) +
2362: $self->parmval("answerdate", $part);
2363: }
2364: return $self->parmval("answerdate", $part);
2365: }
2366: sub duedate {
2367: (my $self, my $part) = @_;
2368: return $self->parmval("duedate", $part);
2369: }
2370: sub maxtries {
2371: (my $self, my $part) = @_;
2372: return $self->parmval("maxtries", $part);
2373: }
2374: sub opendate {
2375: (my $self, my $part) = @_;
2376: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
2377: return $self->duedate($part) -
2378: $self->parmval("opendate", $part);
2379: }
2380: return $self->parmval("opendate");
2381: }
2382: sub sig {
2383: (my $self, my $part) = @_;
2384: return $self->parmval("sig", $part);
2385: }
2386: sub tol {
2387: (my $self, my $part) = @_;
2388: return $self->parmval("tol", $part);
2389: }
2390: sub tries {
2391: my $self = shift;
2392: my $part = shift;
2393: $part = '0' if (!defined($part));
2394:
2395: # Make sure return hash is loaded, should error check
2396: $self->getReturnHash();
2397:
2398: my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
2399: if (!defined($tries)) {return '0';}
2400: return $tries;
2401: }
1.70 bowersj2 2402: sub type {
2403: (my $self, my $part) = @_;
2404: return $self->parmval("type", $part);
2405: }
2406: sub weight {
2407: (my $self, my $part) = @_;
2408: return $self->parmval("weight", $part);
2409: }
1.51 bowersj2 2410:
2411: # Multiple things need this
2412: sub getReturnHash {
2413: my $self = shift;
2414:
2415: if (!defined($self->{RETURN_HASH})) {
2416: my %tmpHash = &Apache::lonnet::restore($self->symb());
2417: $self->{RETURN_HASH} = \%tmpHash;
2418: }
2419: }
2420:
2421: ######
2422: # Status queries
2423: ######
2424:
2425: # These methods query the status of problems.
2426:
2427: # If we need to count parts, this function determines the number of
2428: # parts from the metadata. When called, it returns a reference to a list
2429: # of strings corresponding to the parts. (Thus, using it in a scalar context
2430: # tells you how many parts you have in the problem:
2431: # $partcount = scalar($resource->countParts());
2432: # Don't use $self->{PARTS} directly because you don't know if it's been
2433: # computed yet.
2434:
2435: =pod
2436:
2437: =head2 Resource misc
2438:
2439: Misc. functions for the resource.
2440:
2441: =over 4
2442:
1.59 bowersj2 2443: =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.
2444:
2445: =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:
2446:
2447: for (split(/\,/, $res->getFeedback())) {
2448: my $link = &Apache::lonnet::escape($_);
2449: ...
2450:
2451: and use the link as appropriate.
2452:
2453: =cut
2454:
2455: sub hasDiscussion {
2456: my $self = shift;
2457: return $self->{NAV_MAP}->hasDiscussion($self->symb());
2458: }
2459:
2460: sub getFeedback {
2461: my $self = shift;
2462: return $self->{NAV_MAP}->getFeedback($self->symb());
2463: }
2464:
2465: =pod
2466:
1.70 bowersj2 2467: =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. Filtering part 0 if you want it is up to you.)
1.51 bowersj2 2468:
1.70 bowersj2 2469: =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. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.
1.51 bowersj2 2470:
2471: =back
2472:
2473: =cut
2474:
2475: sub parts {
2476: my $self = shift;
2477:
1.67 bowersj2 2478: if ($self->ext) { return ['0']; }
2479:
1.51 bowersj2 2480: $self->extractParts();
2481: return $self->{PARTS};
2482: }
2483:
2484: sub countParts {
2485: my $self = shift;
2486:
2487: my $parts = $self->parts();
1.66 bowersj2 2488:
2489: if ($self->{RESOURCE_ERROR}) {
2490: return 0;
2491: }
2492:
2493: if (scalar(@{$parts}) < 2) { return 1;}
1.51 bowersj2 2494:
2495: return scalar(@{$parts}) - 1;
2496: }
2497:
2498: # Private function: Extracts the parts information and saves it
2499: sub extractParts {
2500: my $self = shift;
2501:
2502: return if ($self->{PARTS});
1.67 bowersj2 2503: return if ($self->ext);
1.51 bowersj2 2504:
2505: $self->{PARTS} = [];
2506:
2507: # Retrieve part count
1.66 bowersj2 2508: my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
2509: if (!$metadata) {
2510: $self->{RESOURCE_ERROR} = 1;
2511: $self->{PARTS} = [];
2512: return;
2513: }
2514:
2515: foreach (split(/\,/,$metadata)) {
1.51 bowersj2 2516: if ($_ =~ /^parameter\_(.*)\_opendate$/) {
2517: push @{$self->{PARTS}}, $1;
2518: }
2519: }
1.66 bowersj2 2520:
1.51 bowersj2 2521:
2522: # Is this possible to do in one line? - Jeremy
2523: my @sortedParts = sort @{$self->{PARTS}};
2524: $self->{PARTS} = \@sortedParts;
2525:
2526: return;
2527: }
2528:
2529: =pod
2530:
2531: =head2 Resource Status
2532:
2533: 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.
2534:
2535: There are two aspects to the status: the date-related information and the completion information.
2536:
2537: Idiomatic usage of these two methods would probably look something like
2538:
2539: foreach ($resource->parts()) {
2540: my $dateStatus = $resource->getDateStatus($_);
2541: my $completionStatus = $resource->getCompletionStatus($_);
2542:
1.70 bowersj2 2543: or
2544:
2545: my $status = $resource->status($_);
2546:
1.51 bowersj2 2547: ... use it here ...
2548: }
2549:
2550: =over 4
2551:
1.70 bowersj2 2552: =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. The possible return values are:
1.51 bowersj2 2553:
2554: =back
2555:
2556: B<Date Codes>
2557:
2558: =over 4
2559:
2560: =item * B<OPEN_LATER>: The problem will be opened later.
2561:
2562: =item * B<OPEN>: Open and not yet due.
2563:
1.59 bowersj2 2564:
1.54 bowersj2 2565: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
2566:
2567: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
1.51 bowersj2 2568:
2569: =item * B<ANSWER_OPEN>: The answer date is here.
2570:
2571: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2572:
2573: =back
2574:
2575: =cut
2576:
2577: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 2578: sub OPEN_LATER { return 0; }
2579: sub OPEN { return 1; }
2580: sub PAST_DUE_NO_ANSWER { return 2; }
2581: sub PAST_DUE_ANSWER_LATER { return 3; }
2582: sub ANSWER_OPEN { return 4; }
2583: sub NOTHING_SET { return 5; }
2584: sub NETWORK_FAILURE { return 100; }
2585:
2586: # getDateStatus gets the date status for a given problem part.
2587: # Because answer date, due date, and open date are fully independent
2588: # (i.e., it is perfectly possible to *only* have an answer date),
2589: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
2590: # (past, future, none given). This function handles this with a decision
2591: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 2592:
2593: sub getDateStatus {
2594: my $self = shift;
2595: my $part = shift;
2596: $part = "0" if (!defined($part));
1.54 bowersj2 2597:
2598: # Always return network failure if there was one.
1.51 bowersj2 2599: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2600:
2601: my $now = time();
2602:
1.53 bowersj2 2603: my $open = $self->opendate($part);
2604: my $due = $self->duedate($part);
2605: my $answer = $self->answerdate($part);
2606:
2607: if (!$open && !$due && !$answer) {
2608: # no data on the problem at all
2609: # should this be the same as "open later"? think multipart.
2610: return $self->NOTHING_SET;
2611: }
1.59 bowersj2 2612: if (!$open || $now < $open) {return $self->OPEN_LATER}
2613: if (!$due || $now < $due) {return $self->OPEN}
2614: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
2615: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 2616: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 2617: }
2618:
2619: =pod
2620:
2621: B<>
2622:
2623: =over 4
2624:
2625: =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:
2626:
2627: =back
2628:
2629: B<Completion Codes>
2630:
2631: =over 4
2632:
2633: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2634:
2635: =item * B<INCORRECT>: Attempted, but wrong by student.
2636:
2637: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2638:
2639: =item * B<CORRECT>: Correct or correct by instructor.
2640:
2641: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2642:
2643: =item * B<EXCUSED>: Excused. Not yet implemented.
2644:
2645: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2646:
1.69 bowersj2 2647: =item * B<ATTEMPTED>: Attempted, and not yet graded.
2648:
1.51 bowersj2 2649: =back
2650:
2651: =cut
2652:
1.53 bowersj2 2653: sub NOT_ATTEMPTED { return 10; }
2654: sub INCORRECT { return 11; }
2655: sub INCORRECT_BY_OVERRIDE { return 12; }
2656: sub CORRECT { return 13; }
2657: sub CORRECT_BY_OVERRIDE { return 14; }
2658: sub EXCUSED { return 15; }
1.69 bowersj2 2659: sub ATTEMPTED { return 16; }
1.51 bowersj2 2660:
2661: sub getCompletionStatus {
2662: my $self = shift;
2663: my $part = shift;
2664: $part = "0" if (!defined($part));
2665: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2666:
2667: # Make sure return hash exists
2668: $self->getReturnHash();
2669:
2670: my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
2671:
2672: # Left as seperate if statements in case we ever do more with this
2673: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2674: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2675: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2676: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2677: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 2678: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 2679: return $self->NOT_ATTEMPTED;
2680: }
2681:
2682: =pod
2683:
2684: B<Composite Status>
2685:
2686: 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()):
2687:
2688: =over 4
2689:
1.70 bowersj2 2690: =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
1.51 bowersj2 2691:
1.70 bowersj2 2692: =item * B<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 2693:
1.70 bowersj2 2694: =item * B<CORRECT>: For any reason at all, the part is considered correct.
1.51 bowersj2 2695:
1.70 bowersj2 2696: =item * B<EXCUSED>: For any reason at all, the problem is excused.
1.51 bowersj2 2697:
1.70 bowersj2 2698: =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
1.54 bowersj2 2699:
1.70 bowersj2 2700: =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
1.51 bowersj2 2701:
1.70 bowersj2 2702: =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
1.51 bowersj2 2703:
1.70 bowersj2 2704: =item * B<OPEN_LATER>: The problem is not yet open.
1.51 bowersj2 2705:
1.70 bowersj2 2706: =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
1.51 bowersj2 2707:
1.70 bowersj2 2708: =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
1.51 bowersj2 2709:
1.70 bowersj2 2710: =item * B<OPEN>: The item is open and not yet tried.
1.51 bowersj2 2711:
1.70 bowersj2 2712: =item * B<ATTEMPTED>: The problem has been attempted.
1.69 bowersj2 2713:
1.51 bowersj2 2714: =back
2715:
2716: =cut
2717:
2718: sub TRIES_LEFT { return 10; }
2719:
2720: sub status {
2721: my $self = shift;
2722: my $part = shift;
2723: if (!defined($part)) { $part = "0"; }
2724: my $completionStatus = $self->getCompletionStatus($part);
2725: my $dateStatus = $self->getDateStatus($part);
2726:
2727: # What we have is a two-dimensional matrix with 4 entries on one
2728: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 2729: # plus network failure and "no date data at all".
1.51 bowersj2 2730:
1.53 bowersj2 2731: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 2732:
2733: # There are a few whole rows we can dispose of:
1.53 bowersj2 2734: if ($completionStatus == CORRECT ||
2735: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.69 bowersj2 2736: return CORRECT;
2737: }
2738:
2739: if ($completionStatus == ATTEMPTED) {
2740: return ATTEMPTED;
1.53 bowersj2 2741: }
2742:
2743: # If it's EXCUSED, then return that no matter what
2744: if ($completionStatus == EXCUSED) {
2745: return EXCUSED;
1.51 bowersj2 2746: }
2747:
1.53 bowersj2 2748: if ($dateStatus == NOTHING_SET) {
2749: return NOTHING_SET;
1.51 bowersj2 2750: }
2751:
1.69 bowersj2 2752: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
2753: # by 4 matrix (date statuses).
1.51 bowersj2 2754:
1.54 bowersj2 2755: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 2756: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54 bowersj2 2757: return $dateStatus;
1.51 bowersj2 2758: }
2759:
1.53 bowersj2 2760: if ($dateStatus == ANSWER_OPEN) {
2761: return ANSWER_OPEN;
1.51 bowersj2 2762: }
2763:
2764: # Now: (incorrect, incorrect_override, not_attempted) x
2765: # (open_later), (open)
2766:
1.53 bowersj2 2767: if ($dateStatus == OPEN_LATER) {
2768: return OPEN_LATER;
1.51 bowersj2 2769: }
2770:
2771: # If it's WRONG...
1.53 bowersj2 2772: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 2773: # and there are TRIES LEFT:
2774: if ($self->tries() < $self->maxtries()) {
1.53 bowersj2 2775: return TRIES_LEFT;
1.51 bowersj2 2776: }
1.53 bowersj2 2777: return INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 2778: }
2779:
2780: # Otherwise, it's untried and open
1.53 bowersj2 2781: return OPEN;
1.51 bowersj2 2782: }
2783:
2784: =pod
2785:
2786: =head2 Resource/Nav Map Navigation
2787:
2788: =over 4
2789:
2790: =item * B<getNext>(): Gets the next resource in the navmap after this one.
2791:
2792: =cut
2793:
2794: # For the simple single-link case, to get from a resource to the next
2795: # resource, you need to look up the "to_" link in the nav hash, then
2796: # follow that with the "goesto_" link.
2797:
2798: sub getNext {
2799: my $self = shift;
2800: my $alreadySeenHash = shift;
2801: my @branches;
2802: my $to = $self->to();
2803: foreach my $branch ( split(/\,/, $to) ) {
2804: my $choice = $self->{NAV_MAP}->getById($branch);
2805: my $next = $choice->goesto();
2806: $next = $self->{NAV_MAP}->getById($next);
2807:
1.61 bowersj2 2808: # Don't remember it if we've already seen it or if
1.66 bowersj2 2809: # the student doesn't have browse priviledges
2810: my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
1.51 bowersj2 2811: if (!defined($alreadySeenHash) ||
1.61 bowersj2 2812: !defined($alreadySeenHash->{$next->{ID}}) ||
1.66 bowersj2 2813: ($browsePriv ne '2' && $browsePriv ne 'F')) {
1.51 bowersj2 2814: push @branches, $next;
2815: }
2816: }
2817: return \@branches;
2818: }
2819:
2820: =pod
1.2 www 2821:
1.51 bowersj2 2822: =back
1.2 www 2823:
1.51 bowersj2 2824: =cut
1.2 www 2825:
1.51 bowersj2 2826: 1;
1.2 www 2827:
1.51 bowersj2 2828: __END__
1.2 www 2829:
2830:
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