loncom/interface/lonnavmaps.pm - view

File: [LON-CAPA] / loncom / interface / lonnavmaps.pm
Revision 1.88: download - view: text, annotated - select for diffs
Mon Oct 28 19:10:35 2002 UTC (21 years, 7 months ago) by bowersj2
Branches: MAIN
CVS tags: HEAD

* Fixes urgency case where all but one try was used up, but it's past the
  due date so who cares?
* Inlines maps on the top-level for course docs. Lightly tested. Ensures
  these inlined maps can't be accidentally suppressed, potentially making
  the whole course disappear.
* Gerd observes it's hard to follow the rows across and tell what corresponds
  to what. This will alternate white and ultra-light-grey rows, so the
  eye can follow the grey or white across easily. This should be accessible
  to everyone who can see, unless they're still using 256 color displays.

1: 2: # The LearningOnline Network with CAPA 3: # Navigate Maps Handler 4: # 5: # $Id: lonnavmaps.pm,v 1.88 2002/10/28 19:10:35 bowersj2 Exp $ 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: # 29: # (Page Handler 30: # 31: # (TeX Content Handler 32: # 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) 36: # 37: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer 38: # YEAR=2002 39: # 1/1 Gerd Kortemeyer 40: # 41: 42: package Apache::lonnavmaps; 43: 44: use strict; 45: use Apache::Constants qw(:common :http); 46: use Apache::lonnet(); 47: use Apache::loncommon(); 48: use GDBM_File; 49: use POSIX qw (floor strftime); 50: 51: # -------------------------------------------------------------- Module Globals 52: my %hash; 53: my @rows; 54: 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: 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: 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) { 82: $a=$b; $b=$r; 83: $r=$a%$b; 84: } 85: return $b; 86: } 87: 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 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 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}; } 132: } 133: 134: # ------------------------------------------------------- second, check course 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}; } 139: } 140: 141: if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; } 142: if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; } 143: if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; } 144: 145: # ----------------------------------------------------- third, check map parms 146: 147: my $thisparm=$parmhash{$symbparm}; 148: if (defined($thisparm)) { return $thisparm; } 149: 150: # ----------------------------------------------------- fourth , check default 151: 152: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); 153: if (defined($default)) { return $default} 154: 155: # --------------------------------------------------- fifth , cascade up parts 156: 157: my ($space,@qualifier)=split(/\./,$rwhat); 158: my $qualifier=join('.',@qualifier); 159: unless ($space eq '0') { 160: my ($part,$id)=split(/\_/,$space); 161: if ($id) { 162: my $partgeneral=&parmval($part.".$qualifier",$symb); 163: if (defined($partgeneral)) { return $partgeneral; } 164: } else { 165: my $resourcegeneral=&parmval("0.$qualifier",$symb); 166: if (defined($resourcegeneral)) { return $resourcegeneral; } 167: } 168: } 169: return ''; 170: } 171: 172: 173: 174: # ------------------------------------------------------------- Find out status 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 186: # 4: partially correct (one or more parts correct) 187: # "excused" needs to be supported, but is not yet. 188: sub astatus { 189: my $rid=shift; 190: my $code=0; 191: my $ctext=''; 192: $rid=~/(\d+)\.(\d+)/; 193: my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'. 194: &Apache::lonnet::declutter($hash{'src_'.$rid}); 195: my %duedate=(); 196: my %opendate=(); 197: my %answerdate=(); 198: # need to always check part 0's open/due/answer status 199: foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) { 200: if ($_=~/^parameter\_(.*)\_opendate$/) { 201: my $part=$1; 202: $duedate{$part}=&parmval($part.'.duedate',$symb); 203: $opendate{$part}=&parmval($part.'.opendate',$symb); 204: $answerdate{$part}=&parmval($part.'.answerdate',$symb); 205: if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') { 206: $opendate{$part}=$duedate{$part}-$opendate{$part}; 207: } 208: if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') { 209: $answerdate{$part}=$duedate{$part}+$answerdate{$part}; 210: } 211: } 212: } 213: my $now=time; 214: my $tcode=0; 215: 216: my %returnhash=&Apache::lonnet::restore($symb); 217: 218: foreach (sort(keys(%opendate))) { 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: } 277: } 278: 279: return 'p'.$code.$tcode.'"'.$ctext.'"'; 280: } 281: 282: 283: sub addresource { 284: my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_; 285: if ($showtypes eq 'problems') { 286: if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) { 287: return; 288: } 289: } 290: my $brepriv=&Apache::lonnet::allowed('bre',$resource); 291: if ($hash{'src_'.$rid}) { 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: } 306: } 307: } 308: 309: sub followlinks () { 310: my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_; 311: my $mincond=1; 312: my $next=''; 313: foreach (split(/\,/,$hash{'to_'.$rid})) { 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: } 324: } 325: my $col=0; 326: &Apache::lonxml::debug("following links -$next-"); 327: foreach (split(/\,/,$next)) { 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++; 344: } 345: return $further; 346: } 347: # ------------------------------------------------------------ Build page table 348: 349: sub tracetable { 350: my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_; 351: my $newshowtypes=$showtypes; 352: my $further=$sofar; 353: # $Apache::lonxml::debug=1; 354: &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid}); 355: if ($beenhere=~/\&$rid\&/) { return $further; } 356: $beenhere.=$rid.'&'; 357: 358: if (defined($hash{'is_map_'.$rid})) { 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: } 388: } else { 389: &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes, 390: $indent,$linkid); 391: } 392: 393: if (defined($hash{'to_'.$rid})) { 394: $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes, 395: $indent,$linkid); 396: } 397: 398: return $further; 399: } 400: 401: # ================================================================ Main Handler 402: 403: sub handler { 404: my $r=shift; 405: 406: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); 407: 408: if ($ENV{'form.jtest'} ne "1") 409: { 410: return new_handle($r); 411: } 412: 413: # ------------------------------------------- Set document type for header only 414: 415: if ($r->header_only) { 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; 423: } 424: my $requrl=$r->uri; 425: my $hashtied; 426: # ----------------------------------------------------------------- Tie db file 427: my $fn; 428: if ($ENV{'request.course.fn'}) { 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: } 438: } 439: if (!$hashtied) { 440: $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; 441: return HTTP_NOT_ACCEPTABLE; 442: } 443: 444: # ------------------------------------------------------------------- Hash tied 445: 446: if ($ENV{'browser.mathml'}) { 447: $r->content_type('text/xml'); 448: } else { 449: $r->content_type('text/html'); 450: } 451: &Apache::loncommon::no_cache($r); 452: $r->send_http_header; 453: 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'})}; 458: if (!(($firstres) && ($lastres))) { 459: $r->print('<html><body>Coursemap undefined.</body></html>'); 460: } else { 461: 462: # ----------------------------------------------------------------- Render page 463: # -------------------------------------------------------------- Set parameters 464: 465: 466: # ---------------------------- initialize coursedata and userdata for this user 467: undef %courseopt; 468: undef %useropt; 469: 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') { 480: # ------------------------------------------------- Get coursedata (if present) 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: } 499: # --------------------------------------------------- Get userdata (if present) 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: } 513: 514: @rows=(); 515: 516: &tracetable(0,$firstres,'&','',0); 517: 518: # ------------------------------------------------------------------ Page parms 519: 520: my $j; 521: my $i; 522: my $lcm=1; 523: my $contents=0; 524: 525: # ---------------------------------------------- Go through table to get layout 526: 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: } 535: 536: 537: unless ($contents) { 538: $r->print('<html><body>Empty Map.</body></html>'); 539: } else { 540: 541: # ------------------------------------------------------------------ Build page 542: 543: my $currenturl=$ENV{'form.postdata'}; 544: $currenturl=~s/^http\:\/\///; 545: $currenturl=~s/^[^\/]+//; 546: 547: # ---------------------------------------------------------------- Send headers 548: 549: my $date=localtime; 550: my $now=time; 551: # ----------------------------------------- Get email status and discussiontime 552: 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: } 587: # ----------------------------------------------------------- Start Page Output 588: my $bodytagadd=''; 589: $r->print( 590: '<html><head><title>Navigate Course Map</title></head>'); 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','', 596: $bodytagadd)); 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: } 618: # ----------------------------------------------------- The little content list 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: } 634: # ----------------------------------------------------------------- Start table 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]; 647: $rid=~/(\d+)\.(\d+)$/; 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>'; 662: if (($ENV{'user.adv'}) && 663: ($parmhash{$symb.'.0.parameter_randompick'})) { 664: $adde=' (randomly select '. 665: $parmhash{$symb.'.0.parameter_randompick'}. 666: ')</th>'; 667: } 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; } 766: if ($hash{'randomout_'.$rid}) { 767: $adde=' <i>(hidden)</i>'.$adde; 768: } 769: $r->print($add.$indentstr); 770: if ($rid) { 771: $r->print('<a href="'.$hash{'src_'.$linkid}. 772: (($hash{'src_'.$linkid}=~/\?/)?'&':'?'). 773: 'symb='.&Apache::lonnet::escape($symb) 774: .'">'. 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>'); 784: # -------------------------------------------------------------------- End page 785: } 786: # ------------------------------------------------------------- End render page 787: } 788: # ------------------------------------------------------------------ Untie hash 789: unless (untie(%hash)) { 790: &Apache::lonnet::logthis("<font color=blue>WARNING: ". 791: "Could not untie coursemap $fn (browse).</font>"); 792: } 793: unless (untie(%parmhash)) { 794: &Apache::lonnet::logthis("<font color=blue>WARNING: ". 795: "Could not untie parmhash (browse).</font>"); 796: } 797: return OK; 798: } 799: 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, 1); 827: 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: } 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(); 844: if ($navmap->{LAST_CHECK}) { 845: $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '. 846: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). 847: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 848: } else { 849: $r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'. 850: '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 851: } 852: 853: # Check that it's defined 854: if (!($navmap->courseMapDefined())) { 855: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' . 856: '</body></html>'); 857: return OK; 858: } 859: 860: # Grab a resource object so we have access to the constants; this 861: # is technically not proper, but should be harmless 862: my $res = $navmap->firstResource(); 863: 864: # Defines a status->color mapping, null string means don't color 865: my %colormap = 866: ( $res->NETWORK_FAILURE => '', 867: $res->CORRECT => '', 868: $res->EXCUSED => '#BBBBFF', 869: $res->PAST_DUE_ANSWER_LATER => '', 870: $res->PAST_DUE_NO_ANSWER => '', 871: $res->ANSWER_OPEN => '#CCFFCC', 872: $res->OPEN_LATER => '', 873: $res->TRIES_LEFT => '', 874: $res->INCORRECT => '', 875: $res->OPEN => '', 876: $res->NOTHING_SET => '' ); 877: # And a special case in the nav map; what to do when the assignment 878: # is not yet done and due in less then 24 hours 879: my $hurryUpColor = "#FF0000"; 880: 881: my %statusIconMap = 882: ( $res->NETWORK_FAILURE => '', 883: $res->NOTHING_SET => '', 884: $res->CORRECT => 'navmap.correct.gif', 885: $res->EXCUSED => 'navmap.correct.gif', 886: $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', 887: $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', 888: $res->ANSWER_OPEN => 'navmap.wrong.gif', 889: $res->OPEN_LATER => '', 890: $res->TRIES_LEFT => 'navmap.open.gif', 891: $res->INCORRECT => 'navmap.wrong.gif', 892: $res->OPEN => 'navmap.open.gif', 893: $res->ATTEMPTED => 'navmap.open.gif' ); 894: 895: my %iconAltTags = 896: ( 'navmap.correct.gif' => 'Correct', 897: 'navmap.wrong.gif' => 'Incorrect', 898: 'navmap.open.gif' => 'Open' ); 899: 900: my %condenseStatuses = 901: ( $res->NETWORK_FAILURE => 1, 902: $res->NOTHING_SET => 1, 903: $res->CORRECT => 1 ); 904: 905: my %filterHash; 906: # Figure out what we're not displaying 907: foreach (split(/\,/, $ENV{"form.filter"})) { 908: if ($_) { 909: $filterHash{$_} = "1"; 910: } 911: } 912: 913: # Is this a new-style course? If so, we want to suppress showing the top-level 914: # maps in their own folders, in favor of "inlining" them. 915: my $topResource = $navmap->getById("0.0"); 916: my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|; 917: 918: my $currenturl = $ENV{'form.postdata'}; 919: $currenturl=~s/^http\:\/\///; 920: $currenturl=~s/^[^\/]+//; 921: # alreadyHere allows us to only open the maps necessary to view 922: # the current location once, while at the same time remembering 923: # the current location. Without that check, the user would never 924: # be able to close those maps; the user would close it, and the 925: # currenturl scan would re-open it. 926: my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) . 927: "&alreadyHere=1"; 928: 929: $r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />'); 930: 931: # Begin the HTML table 932: # four cols: resource + indent, chat+feedback, icon, text string 933: $r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"); 934: 935: my $condition = 0; 936: if ($ENV{'form.condition'}) { 937: $condition = 1; 938: } 939: 940: # This needs to be updated to use symbs from the remote, 941: # instead of uris. The changes to this and the main rendering 942: # loop should be obvious. 943: # Here's a simple example of the iterator. 944: # Preprocess the map: Look for current URL, force inlined maps to display 945: 946: my $mapIterator = $navmap->getIterator(undef, undef, {}, 1); 947: my $found = 0; 948: my $depth = 1; 949: $mapIterator->next(); # discard the first BEGIN_MAP 950: my $curRes = $mapIterator->next(); 951: 952: while ($depth > 0) { 953: if ($curRes == $mapIterator->BEGIN_MAP()) { 954: $depth++; 955: } 956: if ($curRes == $mapIterator->END_MAP()) { 957: $depth--; 958: } 959: 960: my $mapStack = $mapIterator->getStack(); 961: if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) && 962: $curRes->src() eq $currenturl) { 963: # If this is the correct resource, be sure to 964: # show it by making sure the containing maps 965: # are open. 966: 967: for my $map (@{$mapStack}) { 968: if ($condition) { 969: undef $filterHash{$map->map_pc()}; 970: } else { 971: $filterHash{$map->map_pc()} = 1; 972: } 973: } 974: $ENV{'form.alreadyHere'} = 1; 975: } 976: 977: # Preprocessing: If we're inlining nav maps into the top-level display, 978: # make sure we show this map! 979: if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map && 980: scalar(@{$mapStack}) == 1) { 981: if ($condition) { 982: undef $filterHash{$curRes->map_pc()}; 983: } else { 984: $filterHash{$curRes->map_pc()} = 1; 985: } 986: } 987: 988: $curRes = $mapIterator->next(); 989: } 990: 991: undef $res; # so we don't accidentally use it later 992: my $indentLevel = 0; 993: my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />"; 994: 995: my $isNewBranch = 0; 996: my $now = time(); 997: my $in24Hours = $now + 24 * 60 * 60; 998: my $depth = 1; 999: my $displayedHereMarker = 0; 1000: 1001: # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" 1002: # code in iterator->next), so ignore the first one 1003: my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 1004: $condition); 1005: $mapIterator->next(); 1006: my $curRes = $mapIterator->next(); 1007: my $deltadepth = 0; 1008: 1009: my @backgroundColors = ("#FFFFFF", "#F6F6F6"); 1010: my $rowNum = 0; 1011: 1012: while ($depth > 0) { 1013: # If we're in a new style course, and this is a BEGIN_MAP, END_MAP, or 1014: # map resource and the stack depth is only one, just plain ignore this resource 1015: # entirely. (This has the effect of inlining the resources in that map 1016: # in the nav map.) 1017: if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 && 1018: ref($curRes) && $curRes->is_map()) { 1019: # We let the normal depth stuff occur, but we need to shift everything 1020: # over by one to the left to make it look right. 1021: $deltadepth = -1; 1022: $curRes = $mapIterator->next(); 1023: next; 1024: } 1025: 1026: if ($curRes == $mapIterator->BEGIN_MAP() || 1027: $curRes == $mapIterator->BEGIN_BRANCH()) { 1028: $indentLevel++; 1029: } 1030: if ($curRes == $mapIterator->END_MAP() || 1031: $curRes == $mapIterator->END_BRANCH()) { 1032: $indentLevel--; 1033: } 1034: if ($curRes == $mapIterator->BEGIN_BRANCH()) { 1035: $isNewBranch = 1; 1036: } 1037: if ($curRes == $mapIterator->BEGIN_MAP()) { 1038: $depth++; 1039: } 1040: if ($curRes == $mapIterator->END_MAP()) { 1041: $depth--; 1042: } 1043: 1044: if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're 1045: # out of the inlined map 1046: 1047: # Is this resource being blotted out? 1048: if (ref($curRes) && !advancedUser() && $curRes->randomout()) { 1049: $curRes = $mapIterator->next(); 1050: next; # and totally ignore this resource 1051: } 1052: 1053: if (ref($curRes) && $curRes->src()) { 1054: 1055: # Step one: Decide which parts to show 1056: my @parts = @{$curRes->parts()}; 1057: my $multipart = scalar(@parts) > 1; 1058: my $condensed = 0; 1059: 1060: if ($curRes->is_problem()) { 1061: # Is it multipart? 1062: 1063: if ($multipart) { 1064: # If it's multipart, see if part 0 is "open" 1065: # if it is, display all parts, if it isn't, 1066: # just display first 1067: if (!$curRes->opendate("0")) { 1068: @parts = ("0"); # just display the zero-th part 1069: $condensed = 1; 1070: } else { 1071: # Otherwise, only display part 0 if we want to 1072: # attach feedback or email information to it 1073: if ($curRes->hasDiscussion() || $curRes->getFeedback()) { 1074: shift @parts; 1075: } else { 1076: # If there's discussion or feedback, that counts 1077: # as a difference, so display the parts. 1078: 1079: # Now, we decide whether to condense the 1080: # parts due to similarity 1081: my $status = $curRes->status($parts[1]); 1082: my $due = $curRes->duedate($parts[1]); 1083: my $open = $curRes->opendate($parts[1]); 1084: my $statusAllSame = 1; 1085: my $dueAllSame = 1; 1086: my $openAllSame = 1; 1087: for (my $i = 2; $i < scalar(@parts); $i++) { 1088: if ($curRes->status($parts[$i]) != $status){ 1089: $statusAllSame = 0; 1090: } 1091: if ($curRes->duedate($parts[$i]) != $due ) { 1092: $dueAllSame = 0; 1093: } 1094: if ($curRes->opendate($parts[$i]) != $open) { 1095: $openAllSame = 0; 1096: } 1097: } 1098: 1099: # $allSame is true if all the statuses were 1100: # the same. Now, if they are all the same and 1101: # match one of the statuses to condense, or they 1102: # are all open with the same due date, or they are 1103: # all OPEN_LATER with the same open date, display the 1104: # status of the first non-zero part (to get the 'correct' 1105: # status right, since 0 is never 'correct' or 'open'). 1106: if (($statusAllSame && defined($condenseStatuses{$status})) || 1107: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| 1108: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ 1109: @parts = ($parts[1]); 1110: $condensed = 1; 1111: } 1112: } 1113: } 1114: } 1115: 1116: } else { 1117: $parts[0] = "0"; # this is to get past foreach loop below 1118: # you can consider a non-problem resource as a resource 1119: # with only one part without loss 1120: } 1121: 1122: # Is it a multipart problem with a single part, now in 1123: # @parts with "0" filtered out? If so, forget it's a multi-part 1124: # problem and treat it like a single-part problem. 1125: if ( scalar(@parts) == 1 ) { 1126: $multipart = 0; 1127: } 1128: 1129: # Display one part, in event of network error. 1130: # If this is a single part, we can at least show the correct 1131: # status, but if it's multipart, we're lost. 1132: if ($curRes->{RESOURCE_ERROR}) { 1133: @parts = ("0"); 1134: } 1135: 1136: # Step two: Show the parts 1137: foreach my $part (@parts) { 1138: 1139: my $deltalevel = 0; # for inserting the branch icon 1140: my $nonLinkedText = ""; # unlinked stuff after title 1141: 1142: # For each thing we're displaying... 1143: 1144: my $stack = $mapIterator->getStack(); 1145: my $src = getLinkForResource($stack); 1146: 1147: my $srcHasQuestion = $src =~ /\?/; 1148: my $link = $src. 1149: ($srcHasQuestion?'&':'?') . 1150: 'symb='.&Apache::lonnet::escape($curRes->symb()). 1151: '"'; 1152: my $title = $curRes->title(); 1153: if (!$title) { 1154: $title = $curRes->src(); 1155: $title = substr ($title, rindex($title, "/") + 1); 1156: } 1157: my $partLabel = ""; 1158: my $newBranchText = ""; 1159: 1160: # If this is a new branch, label it so 1161: # (temporary, this should be an icon w/ alt text) 1162: if ($isNewBranch) { 1163: $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">"; 1164: $isNewBranch = 0; 1165: $deltalevel = 1; 1166: } 1167: 1168: # links to open and close the folders 1169: my $linkopen = "<a href=\"$link\">"; 1170: my $linkclose = "</a>"; 1171: 1172: my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />"; 1173: if ($curRes->is_problem()) { 1174: if ($part eq "0" || $condensed) { 1175: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; 1176: } else { 1177: $icon = $indentString; 1178: } 1179: } 1180: 1181: # Display the correct icon, link to open or shut map 1182: if ($curRes->is_map()) { 1183: my $mapId = $curRes->map_pc(); 1184: my $nowOpen = (!defined($filterHash{$mapId})); 1185: if ($condition) {$nowOpen = !$nowOpen;} 1186: $icon = $nowOpen ? 1187: "navmap.folder.closed.gif" : "navmap.folder.open.gif"; 1188: $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />"; 1189: $linkopen = "<a href=\"/adm/navmaps?filter="; 1190: $linkopen .= ($nowOpen xor $condition) ? 1191: addToFilter(\%filterHash, $mapId) : 1192: removeFromFilter(\%filterHash, $mapId); 1193: $linkopen .= "&condition=$condition&$queryAdd\">"; 1194: $linkclose = "</a>"; 1195: 1196: } 1197: 1198: my $colorizer = ""; 1199: my $color; 1200: if ($curRes->is_problem()) { 1201: my $status = $curRes->status($part); 1202: $color = $colormap{$status}; 1203: 1204: # Special case in the navmaps: If in less then 1205: # 24 hours, give it a bit of urgency 1206: if (($status == $curRes->OPEN() || $status == $curRes->ATTEMPTED() || 1207: $status == $curRes->TRIES_LEFT()) 1208: && $curRes->duedate() && 1209: $curRes->duedate() < time()+(24*60*60) && 1210: $curRes->duedate() > time()) { 1211: $color = $hurryUpColor; 1212: } 1213: # Special case: If this is the last try, and there is 1214: # more then one available, and it's not due yet, give a bit of urgency 1215: my $tries = $curRes->tries($part); 1216: my $maxtries = $curRes->maxtries($part); 1217: if ($tries && $maxtries && $maxtries > 1 && 1218: $maxtries - $tries == 1 && $curRes->duedate() && 1219: $curRes->duedate() > time()) { 1220: $color = $hurryUpColor; 1221: } 1222: if ($color ne "") { 1223: $colorizer = "bgcolor=\"$color\""; 1224: } 1225: } 1226: 1227: if ($curRes->randomout()) { 1228: $nonLinkedText .= ' <i>(hidden)</i> '; 1229: } 1230: 1231: $rowNum++; 1232: my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; 1233: 1234: # FIRST COL: The resource indentation, branch icon, and name 1235: $r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\" width=\"60%\">\n"); 1236: 1237: # print indentation 1238: for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) { 1239: $r->print($indentString); 1240: } 1241: 1242: $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); 1243: 1244: my $curMarkerBegin = ""; 1245: my $curMarkerEnd = ""; 1246: 1247: # Is this the current resource? 1248: if ($curRes->src() eq $currenturl && !$displayedHereMarker) { 1249: $curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>'; 1250: $curMarkerEnd = '<font color="red" size="+2"> <</font>'; 1251: $displayedHereMarker = 1; 1252: } 1253: 1254: if ($curRes->is_problem() && $part ne "0" && !$condensed) { 1255: $partLabel = " (Part $part)"; 1256: $title = ""; 1257: } 1258: if ($multipart && $condensed) { 1259: $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)'; 1260: } 1261: 1262: $r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText"); 1263: 1264: if ($curRes->{RESOURCE_ERROR}) { 1265: $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", 1266: '<font size="-1">Host down</font>')); 1267: } 1268: 1269: my $discussionHTML = ""; my $feedbackHTML = ""; 1270: 1271: # SECOND COL: Is there text, feedback, errors?? 1272: if ($curRes->hasDiscussion()) { 1273: $discussionHTML = $linkopen . 1274: '<img border="0" src="/adm/lonMisc/chat.gif" />' . 1275: $linkclose; 1276: } 1277: 1278: if ($curRes->getFeedback()) { 1279: my $feedback = $curRes->getFeedback(); 1280: foreach (split(/\,/, $feedback)) { 1281: if ($_) { 1282: $feedbackHTML .= ' <a href="/adm/email?display=' 1283: . &Apache::lonnet::escape($_) . '">' 1284: . '<img src="/adm/lonMisc/feedback.gif" ' 1285: . 'border="0" /></a>'; 1286: } 1287: } 1288: } 1289: 1290: $r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>"); 1291: 1292: # Is this the first displayed part of a multi-part problem 1293: # that has not been condensed, so we should suppress these two 1294: # columns? 1295: my $firstDisplayed = !$condensed && $multipart && $part eq "0"; 1296: 1297: # THIRD COL: Problem status icon 1298: if ($curRes->is_problem() && 1299: !$firstDisplayed) { 1300: my $icon = $statusIconMap{$curRes->status($part)}; 1301: my $alt = $iconAltTags{$icon}; 1302: if ($icon) { 1303: $r->print("<td width=\"30\" valign=\"center\" width=\"50\" align=\"right\">$linkopen<img width=\"25\" height=\"25\" src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n"); 1304: } else { 1305: $r->print("<td width=\"30\"> </td>\n"); 1306: } 1307: } else { # not problem, no icon 1308: $r->print("<td width=\"30\"> </td>\n"); 1309: } 1310: 1311: # FOURTH COL: Text description 1312: #$r->print("<td $colorizer align=\"right\" valign=\"center\">\n"); 1313: $r->print("<td align=\"right\" valign=\"center\">\n"); 1314: 1315: if ($curRes->kind() eq "res" && 1316: $curRes->is_problem() && 1317: !$firstDisplayed) { 1318: $r->print ("<font color=\"$color\"><b>") if ($color); 1319: $r->print (getDescription($curRes, $part)); 1320: $r->print ("</b></font>") if ($color); 1321: } 1322: if ($curRes->is_map() && advancedUser() && $curRes->randompick()) { 1323: $r->print('(randomly select ' . $curRes->randompick() .')'); 1324: } 1325: 1326: $r->print(" </td></tr>\n"); 1327: } 1328: } 1329: $curRes = $mapIterator->next(); 1330: } 1331: 1332: $r->print("</table></body></html>"); 1333: 1334: $navmap->untieHashes(); 1335: 1336: return OK; 1337: } 1338: 1339: # Convenience functions: Returns a string that adds or subtracts 1340: # the second argument from the first hash, appropriate for the 1341: # query string that determines which folders to recurse on 1342: sub addToFilter { 1343: my $hashIn = shift; 1344: my $addition = shift; 1345: my %hash = %$hashIn; 1346: $hash{$addition} = 1; 1347: 1348: return join (",", keys(%hash)); 1349: } 1350: 1351: sub removeFromFilter { 1352: my $hashIn = shift; 1353: my $subtraction = shift; 1354: my %hash = %$hashIn; 1355: 1356: delete $hash{$subtraction}; 1357: return join(",", keys(%hash)); 1358: } 1359: 1360: # Convenience function: Given a stack returned from getStack on the iterator, 1361: # return the correct src() value. 1362: # Later, this should add an anchor when we start putting anchors in pages. 1363: sub getLinkForResource { 1364: my $stack = shift; 1365: my $res; 1366: 1367: # Check to see if there are any pages in the stack 1368: foreach $res (@$stack) { 1369: if (defined($res) && $res->is_page()) { 1370: return $res->src(); 1371: } 1372: } 1373: 1374: # Failing that, return the src of the last resource that is defined 1375: # (when we first recurse on a map, it puts an undefined resource 1376: # on the bottom because $self->{HERE} isn't defined yet, and we 1377: # want the src for the map anyhow) 1378: foreach (@$stack) { 1379: if (defined($_)) { $res = $_; } 1380: } 1381: 1382: return $res->src(); 1383: } 1384: 1385: # Convenience function: This seperates the logic of how to create 1386: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned", 1387: # etc.) into a seperate function. It takes a resource object as the 1388: # first parameter, and the part number of the resource as the second. 1389: # It's basically a big switch statement on the status of the resource. 1390: 1391: sub getDescription { 1392: my $res = shift; 1393: my $part = shift; 1394: my $status = $res->status($part); 1395: 1396: if ($status == $res->NETWORK_FAILURE) { return ""; } 1397: if ($status == $res->NOTHING_SET) { 1398: return "Not currently assigned."; 1399: } 1400: if ($status == $res->OPEN_LATER) { 1401: return "Open " . timeToHumanString($res->opendate($part)); 1402: } 1403: if ($status == $res->OPEN) { 1404: if ($res->duedate($part)) { 1405: return "Due " . timeToHumanString($res->duedate($part)); 1406: } else { 1407: return "Open, no due date"; 1408: } 1409: } 1410: if ($status == $res->PAST_DUE_ANSWER_LATER) { 1411: return "Answer open " . timeToHumanString($res->answerdate($part)); 1412: } 1413: if ($status == $res->PAST_DUE_NO_ANSWER) { 1414: return "Was due " . timeToHumanString($res->duedate($part)); 1415: } 1416: if ($status == $res->ANSWER_OPEN) { 1417: return "Answer available"; 1418: } 1419: if ($status == $res->EXCUSED) { 1420: return "Excused by instructor"; 1421: } 1422: if ($status == $res->ATTEMPTED) { 1423: return "Not yet graded."; 1424: } 1425: if ($status == $res->TRIES_LEFT) { 1426: my $tries = $res->tries($part); 1427: my $maxtries = $res->maxtries($part); 1428: my $triesString = ""; 1429: if ($tries && $maxtries) { 1430: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>"; 1431: if ($maxtries > 1 && $maxtries - $tries == 1) { 1432: $triesString = "<b>$triesString</b>"; 1433: } 1434: } 1435: if ($res->duedate()) { 1436: return "Due " . timeToHumanString($res->duedate($part)) . 1437: " $triesString"; 1438: } else { 1439: return "No due date $triesString"; 1440: } 1441: } 1442: } 1443: 1444: sub advancedUser { 1445: return $ENV{'user.adv'}; 1446: } 1447: 1448: 1449: # timeToHumanString takes a time number and converts it to a 1450: # human-readable representation, meant to be used in the following 1451: # manner: 1452: # print "Due $timestring" 1453: # print "Open $timestring" 1454: # print "Answer available $timestring" 1455: # Very, very, very, VERY English-only... goodness help a localizer on 1456: # this func... 1457: sub timeToHumanString { 1458: my ($time) = @_; 1459: # zero, '0' and blank are bad times 1460: if (!$time) { 1461: return 'never'; 1462: } 1463: 1464: my $now = time(); 1465: 1466: my @time = localtime($time); 1467: my @now = localtime($now); 1468: 1469: # Positive = future 1470: my $delta = $time - $now; 1471: 1472: my $minute = 60; 1473: my $hour = 60 * $minute; 1474: my $day = 24 * $hour; 1475: my $week = 7 * $day; 1476: my $inPast = 0; 1477: 1478: # Logic in comments: 1479: # Is it now? (extremely unlikely) 1480: if ( $delta == 0 ) { 1481: return "this instant"; 1482: } 1483: 1484: if ($delta < 0) { 1485: $inPast = 1; 1486: $delta = -$delta; 1487: } 1488: 1489: # Is it in the future? 1490: if ( $delta > 0 ) { 1491: # Is it less then a minute away? 1492: my $tense = $inPast ? " ago" : ""; 1493: my $prefix = $inPast ? "" : "in "; 1494: if ( $delta < $minute ) { 1495: if ($delta == 1) { return "${prefix}1 second$tense"; } 1496: return "$prefix$delta seconds$tense"; 1497: } 1498: 1499: # Is it less then an hour away? 1500: if ( $delta < $hour ) { 1501: # If so, use minutes 1502: my $minutes = floor($delta / 60); 1503: if ($minutes == 1) { return "${prefix}1 minute$tense"; } 1504: return "$prefix$minutes minutes$tense"; 1505: } 1506: 1507: # Is it less then 24 hours away? If so, 1508: # display hours + minutes 1509: if ( $delta < $hour * 24) { 1510: my $hours = floor($delta / $hour); 1511: my $minutes = floor(($delta % $hour) / $minute); 1512: my $hourString = "$hours hours"; 1513: my $minuteString = ", $minutes minutes"; 1514: if ($hours == 1) { 1515: $hourString = "1 hour"; 1516: } 1517: if ($minutes == 1) { 1518: $minuteString = ", 1 minute"; 1519: } 1520: if ($minutes == 0) { 1521: $minuteString = ""; 1522: } 1523: return "$prefix$hourString$minuteString$tense"; 1524: } 1525: 1526: # Less then 5 days away, display day of the week and 1527: # HH:MM 1528: if ( $delta < $day * 5 ) { 1529: my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time)); 1530: $timeStr =~ s/12:00 am/midnight/; 1531: $timeStr =~ s/12:00 pm/noon/; 1532: return ($inPast ? "last " : "next ") . 1533: $timeStr; 1534: } 1535: 1536: # Is it this year? 1537: if ( $time[5] == $now[5]) { 1538: # Return on Month Day, HH:MM meridian 1539: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time)); 1540: $timeStr =~ s/12:00 am/midnight/; 1541: $timeStr =~ s/12:00 pm/noon/; 1542: return $timeStr; 1543: } 1544: 1545: # Not this year, so show the year 1546: my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time)); 1547: $timeStr =~ s/12:00 am/midnight/; 1548: $timeStr =~ s/12:00 pm/noon/; 1549: return $timeStr; 1550: } 1551: } 1552: 1553: 1; 1554: 1555: package Apache::lonnavmaps::navmap; 1556: 1557: =pod 1558: 1559: 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. 1560: 1561: =head1 navmap object: Encapsulating the compiled nav map 1562: 1563: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it. 1564: 1565: 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. 1566: 1567: You must obtain resource objects through the navmap object. 1568: 1569: =head2 Methods 1570: 1571: =over 4 1572: 1573: =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. 1574: 1575: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below. 1576: 1577: =cut 1578: 1579: use strict; 1580: use GDBM_File; 1581: 1582: sub new { 1583: # magic invocation to create a class instance 1584: my $proto = shift; 1585: my $class = ref($proto) || $proto; 1586: my $self = {}; 1587: 1588: $self->{NAV_HASH_FILE} = shift; 1589: $self->{PARM_HASH_FILE} = shift; 1590: $self->{GENERATE_COURSE_USER_OPT} = shift; 1591: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift; 1592: 1593: # Resource cache stores navmapresource's as we reference them. We generate 1594: # them on-demand so we don't pay for creating resources unless we use them. 1595: $self->{RESOURCE_CACHE} = {}; 1596: 1597: # Network failure flag, if we accessed the course or user opt and 1598: # failed 1599: $self->{NETWORK_FAILURE} = 0; 1600: 1601: # tie the nav hash 1602: my %navmaphash; 1603: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, 1604: &GDBM_READER(), 0640))) { 1605: return undef; 1606: } 1607: $self->{NAV_HASH} = \%navmaphash; 1608: 1609: my %parmhash; 1610: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, 1611: &GDBM_READER(), 0640))) 1612: { 1613: untie $self->{PARM_HASH}; 1614: return undef; 1615: } 1616: $self->{PARM_HASH} = \%parmhash; 1617: $self->{HASH_TIED} = 1; 1618: 1619: # If the course opt hash and the user opt hash should be generated, 1620: # generate them 1621: if ($self->{GENERATE_COURSE_USER_OPT}) { 1622: my $uname=$ENV{'user.name'}; 1623: my $udom=$ENV{'user.domain'}; 1624: my $uhome=$ENV{'user.home'}; 1625: my $cid=$ENV{'request.course.id'}; 1626: my $chome=$ENV{'course.'.$cid.'.home'}; 1627: my ($cdom,$cnum)=split(/\_/,$cid); 1628: 1629: my $userprefix=$uname.'_'.$udom.'_'; 1630: 1631: my %courserdatas; my %useropt; my %courseopt; 1632: unless ($uhome eq 'no_host') { 1633: # ------------------------------------------------- Get coursedata (if present) 1634: unless ((time-$courserdatas{$cid.'.last_cache'})<240) { 1635: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum. 1636: ':resourcedata',$chome); 1637: if ($reply!~/^error\:/) { 1638: $courserdatas{$cid}=$reply; 1639: $courserdatas{$cid.'.last_cache'}=time; 1640: } 1641: # check to see if network failed 1642: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) 1643: { 1644: $self->{NETWORK_FAILURE} = 1; 1645: } 1646: } 1647: foreach (split(/\&/,$courserdatas{$cid})) { 1648: my ($name,$value)=split(/\=/,$_); 1649: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}= 1650: &Apache::lonnet::unescape($value); 1651: } 1652: # --------------------------------------------------- Get userdata (if present) 1653: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) { 1654: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); 1655: if ($reply!~/^error\:/) { 1656: $userrdatas{$uname.'___'.$udom}=$reply; 1657: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time; 1658: } 1659: # check to see if network failed 1660: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) 1661: { 1662: $self->{NETWORK_FAILURE} = 1; 1663: } 1664: } 1665: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) { 1666: my ($name,$value)=split(/\=/,$_); 1667: $useropt{$userprefix.&Apache::lonnet::unescape($name)}= 1668: &Apache::lonnet::unescape($value); 1669: } 1670: $self->{COURSE_OPT} = \%courseopt; 1671: $self->{USER_OPT} = \%useropt; 1672: } 1673: } 1674: 1675: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) { 1676: my $cid=$ENV{'request.course.id'}; 1677: my ($cdom,$cnum)=split(/\_/,$cid); 1678: 1679: my %emailstatus = &Apache::lonnet::dump('email_status'); 1680: my $logoutTime = $emailstatus{'logout'}; 1681: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; 1682: $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? 1683: $courseLeaveTime : $logoutTime); 1684: my %discussiontime = &Apache::lonnet::dump('discussiontimes', 1685: $cdom, $cnum); 1686: my %feedback=(); 1687: my %error=(); 1688: my $keys = &Apache::lonnet::reply('keys:'. 1689: $ENV{'user.domain'}.':'. 1690: $ENV{'user.name'}.':nohist_email', 1691: $ENV{'user.home'}); 1692: 1693: foreach my $msgid (split(/\&/, $keys)) { 1694: $msgid=&Apache::lonnet::unescape($msgid); 1695: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid)); 1696: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) { 1697: my ($what,$url)=($1,$2); 1698: my %status= 1699: &Apache::lonnet::get('email_status',[$msgid]); 1700: if ($status{$msgid}=~/^error\:/) { 1701: $status{$msgid}=''; 1702: } 1703: 1704: if (($status{$msgid} eq 'new') || 1705: (!$status{$msgid})) { 1706: if ($what eq 'Error') { 1707: $error{$url}.=','.$msgid; 1708: } else { 1709: $feedback{$url}.=','.$msgid; 1710: } 1711: } 1712: } 1713: } 1714: 1715: $self->{FEEDBACK} = \%feedback; 1716: $self->{ERROR_MSG} = \%error; # what is this? JB 1717: $self->{DISCUSSION_TIME} = \%discussiontime; 1718: $self->{EMAIL_STATUS} = \%emailstatus; 1719: 1720: } 1721: 1722: $self->{PARM_CACHE} = {}; 1723: 1724: bless($self); 1725: 1726: return $self; 1727: } 1728: 1729: # Checks to see if coursemap is defined, matching test in old lonnavmaps 1730: sub courseMapDefined { 1731: my $self = shift; 1732: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); 1733: 1734: my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; 1735: my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; 1736: return $firstres && $lastres; 1737: } 1738: 1739: sub getIterator { 1740: my $self = shift; 1741: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, 1742: shift, undef, shift); 1743: return $iterator; 1744: } 1745: 1746: # unties the hash when done 1747: sub untieHashes { 1748: my $self = shift; 1749: untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED}); 1750: untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED}); 1751: $self->{HASH_TIED} = 0; 1752: } 1753: 1754: # when the object is destroyed, be sure to untie all the hashes we tied. 1755: sub DESTROY { 1756: my $self = shift; 1757: $self->untieHashes(); 1758: } 1759: 1760: # Private function: Does the given resource (as a symb string) have 1761: # current discussion? Returns 0 if chat/mail data not extracted. 1762: sub hasDiscussion { 1763: my $self = shift; 1764: my $symb = shift; 1765: if (!defined($self->{DISCUSSION_TIME})) { return 0; } 1766: 1767: return $self->{DISCUSSION_TIME}->{$symb} > 1768: $self->{LAST_CHECK}; 1769: } 1770: 1771: # Private function: Does the given resource (as a symb string) have 1772: # current feedback? Returns the string in the feedback hash, which 1773: # will be false if it does not exist. 1774: sub getFeedback { 1775: my $self = shift; 1776: my $symb = shift; 1777: 1778: if (!defined($self->{FEEDBACK})) { return ""; } 1779: 1780: return $self->{FEEDBACK}->{$symb}; 1781: } 1782: 1783: =pod 1784: 1785: =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. 1786: 1787: =cut 1788: 1789: # The strategy here is to cache the resource objects, and only construct them 1790: # as we use them. The real point is to prevent reading any more from the tied 1791: # hash then we have to, which should hopefully alleviate speed problems. 1792: # Caching is just an incidental detail I throw in because it makes sense. 1793: 1794: sub getById { 1795: my $self = shift; 1796: my $id = shift; 1797: 1798: if (defined ($self->{RESOURCE_CACHE}->{$id})) 1799: { 1800: return $self->{RESOURCE_CACHE}->{$id}; 1801: } 1802: 1803: # resource handles inserting itself into cache. 1804: return Apache::lonnavmaps::resource->new($self, $id); 1805: } 1806: 1807: =pod 1808: 1809: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap. 1810: 1811: =cut 1812: 1813: sub firstResource { 1814: my $self = shift; 1815: my $firstResource = $self->{NAV_HASH}->{'map_start_' . 1816: &Apache::lonnet::clutter($ENV{'request.course.uri'})}; 1817: return $self->getById($firstResource); 1818: } 1819: 1820: =pod 1821: 1822: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap. 1823: 1824: =cut 1825: 1826: sub finishResource { 1827: my $self = shift; 1828: my $firstResource = $self->{NAV_HASH}->{'map_finish_' . 1829: &Apache::lonnet::clutter($ENV{'request.course.uri'})}; 1830: return $self->getById($firstResource); 1831: } 1832: 1833: # -------------------------------------------- Figure out a cascading parameter 1834: # 1835: # For this function to work 1836: # 1837: # * parmhash needs to be tied 1838: # * courseopt and useropt need to be initialized for this user and course 1839: # 1840: 1841: sub parmval { 1842: my $self = shift; 1843: my ($what,$symb)=@_; 1844: my $hashkey = $what."|||".$symb; 1845: 1846: if (defined($self->{PARM_CACHE}->{$hashkey})) { 1847: return $self->{PARM_CACHE}->{$hashkey}; 1848: } 1849: 1850: my $result = $self->parmval_real($what, $symb); 1851: $self->{PARM_CACHE}->{$hashkey} = $result; 1852: return $result; 1853: } 1854: 1855: sub parmval_real { 1856: my $self = shift; 1857: my ($what,$symb) = @_; 1858: 1859: my $cid=$ENV{'request.course.id'}; 1860: my $csec=$ENV{'request.course.sec'}; 1861: my $uname=$ENV{'user.name'}; 1862: my $udom=$ENV{'user.domain'}; 1863: 1864: unless ($symb) { return ''; } 1865: my $result=''; 1866: 1867: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb); 1868: 1869: # ----------------------------------------------------- Cascading lookup scheme 1870: my $rwhat=$what; 1871: $what=~s/^parameter\_//; 1872: $what=~s/\_/\./; 1873: 1874: my $symbparm=$symb.'.'.$what; 1875: my $mapparm=$mapname.'___(all).'.$what; 1876: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid; 1877: 1878: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what; 1879: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm; 1880: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm; 1881: 1882: my $courselevel= $usercourseprefix.'.'.$what; 1883: my $courselevelr=$usercourseprefix.'.'.$symbparm; 1884: my $courselevelm=$usercourseprefix.'.'.$mapparm; 1885: 1886: my $useropt = $self->{USER_OPT}; 1887: my $courseopt = $self->{COURSE_OPT}; 1888: my $parmhash = $self->{PARM_HASH}; 1889: 1890: # ---------------------------------------------------------- first, check user 1891: if ($uname and defined($useropt)) { 1892: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; } 1893: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; } 1894: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; } 1895: } 1896: 1897: # ------------------------------------------------------- second, check course 1898: if ($csec and defined($courseopt)) { 1899: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; } 1900: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; } 1901: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; } 1902: } 1903: 1904: if (defined($courseopt)) { 1905: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; } 1906: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; } 1907: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; } 1908: } 1909: 1910: # ----------------------------------------------------- third, check map parms 1911: 1912: my $thisparm=$$parmhash{$symbparm}; 1913: if (defined($thisparm)) { return $thisparm; } 1914: 1915: # ----------------------------------------------------- fourth , check default 1916: 1917: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); 1918: if (defined($default)) { return $default} 1919: 1920: # --------------------------------------------------- fifth , cascade up parts 1921: 1922: my ($space,@qualifier)=split(/\./,$rwhat); 1923: my $qualifier=join('.',@qualifier); 1924: unless ($space eq '0') { 1925: my ($part,$id)=split(/\_/,$space); 1926: if ($id) { 1927: my $partgeneral=$self->parmval($part.".$qualifier",$symb); 1928: if (defined($partgeneral)) { return $partgeneral; } 1929: } else { 1930: my $resourcegeneral=$self->parmval("0.$qualifier",$symb); 1931: if (defined($resourcegeneral)) { return $resourcegeneral; } 1932: } 1933: } 1934: return ''; 1935: } 1936: 1937: 1938: 1; 1939: 1940: package Apache::lonnavmaps::iterator; 1941: 1942: # This package must precede "navmap" because "navmap" uses it. In 1943: # order to keep the documentation order straight, the iterator is documented 1944: # after the navmap object. 1945: 1946: =pod 1947: 1948: =back 1949: 1950: =head1 navmap Iterator 1951: 1952: 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. 1953: 1954: 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: 1955: 1956: C<my $resourceIterator = $navmap-E<gt>getIterator();> 1957: 1958: To get the next thing from the iterator, call B<next>: 1959: 1960: C<my $nextThing = $resourceIterator-E<gt>next()> 1961: 1962: getIterator behaves as follows: 1963: 1964: =over 4 1965: 1966: =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. 1967: 1968: 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. 1969: 1970: 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: 1971: 1972: =over 4 1973: 1974: =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned. 1975: 1976: =item * END_MAP: The map is now done. 1977: 1978: =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch. 1979: 1980: =item * END_BRANCH: The branch is now done. 1981: 1982: =back 1983: 1984: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. 1985: 1986: =back 1987: 1988: =cut 1989: 1990: # Here are the tokens for the iterator: 1991: 1992: sub BEGIN_MAP { return 1; } # begining of a new map 1993: sub END_MAP { return 2; } # end of the map 1994: sub BEGIN_BRANCH { return 3; } # beginning of a branch 1995: sub END_BRANCH { return 4; } # end of a branch 1996: 1997: # Params: nav map, start resource, end resource, filter, condition, 1998: # already seen hash ref 1999: 2000: sub new { 2001: # magic invocation to create a class instance 2002: my $proto = shift; 2003: my $class = ref($proto) || $proto; 2004: my $self = {}; 2005: 2006: $self->{NAV_MAP} = shift; 2007: return undef unless ($self->{NAV_MAP}); 2008: 2009: # Handle the parameters 2010: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); 2011: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); 2012: 2013: # If the given resources are just the ID of the resource, get the 2014: # objects 2015: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} = 2016: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); } 2017: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} = 2018: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); } 2019: 2020: $self->{FILTER} = shift; 2021: 2022: # A hash, used as a set, of resource already seen 2023: $self->{ALREADY_SEEN} = shift; 2024: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; 2025: $self->{CONDITION} = shift; 2026: 2027: # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP. 2028: $self->{STARTED} = 0; 2029: 2030: # Should we continue calling the recursive iterator, if any? 2031: $self->{RECURSIVE_ITERATOR_FLAG} = 0; 2032: # The recursive iterator, if any 2033: $self->{RECURSIVE_ITERATOR} = undef; 2034: # Are we recursing on a map, or a branch? 2035: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches 2036: # And the count of how deep it is, so that this iterator can keep track of 2037: # when to pick back up again. 2038: $self->{RECURSIVE_DEPTH} = 0; 2039: 2040: # For keeping track of our branches, we maintain our own stack 2041: $self->{BRANCH_STACK} = []; 2042: # If the size shrinks, we exhausted a branch 2043: $self->{BRANCH_STACK_SIZE} = 0; 2044: $self->{BRANCH_DEPTH} = 0; 2045: 2046: # For returning two things in a forced sequence 2047: $self->{FORCE_NEXT} = undef; 2048: 2049: # Start with the first resource 2050: push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE}; 2051: $self->{BRANCH_STACK_SIZE} = 1; 2052: 2053: bless($self); 2054: return $self; 2055: } 2056: 2057: # Note... this function is *touchy*. I strongly recommend tracing 2058: # through it with the debugger a few times on a non-trivial map before 2059: # modifying it. Order is *everything*. 2060: sub next { 2061: my $self = shift; 2062: 2063: # Iterator logic goes here 2064: 2065: # Are we using a recursive iterator? If so, pull from that and 2066: # watch the depth; we want to resume our level at the correct time. 2067: if ($self->{RECURSIVE_ITERATOR_FLAG}) 2068: { 2069: # grab the next from the recursive iterator 2070: my $next = $self->{RECURSIVE_ITERATOR}->next(); 2071: 2072: # is it a begin or end map? Update depth if so 2073: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; } 2074: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; } 2075: 2076: # Are we back at depth 0? If so, stop recursing. 2077: if ($self->{RECURSIVE_DEPTH} == 0) { 2078: $self->{RECURSIVE_ITERATOR_FLAG} = 0; 2079: } 2080: 2081: return $next; 2082: } 2083: 2084: # Is this return value pre-determined? 2085: if (defined($self->{FORCE_NEXT})) { 2086: my $tmp = $self->{FORCE_NEXT}; 2087: $self->{FORCE_NEXT} = undef; 2088: return $tmp; 2089: } 2090: 2091: # Is there a current resource to grab? If not, then return 2092: # END_BRANCH and END_MAP in succession. 2093: if (scalar(@{$self->{BRANCH_STACK}}) == 0) { 2094: if ($self->{BRANCH_DEPTH} > 0) { 2095: $self->{FORCE_NEXT} = $self->END_MAP(); 2096: $self->{BRANCH_DEPTH}--; 2097: return $self->END_BRANCH(); 2098: } else { 2099: return $self->END_MAP(); 2100: } 2101: } 2102: 2103: # Have we not yet begun? If not, return BEGIN_MAP and 2104: # remember that we've started. 2105: if ( !$self->{STARTED} ) { 2106: $self->{STARTED} = 1; 2107: return $self->BEGIN_MAP; 2108: } 2109: 2110: # Did the branch stack shrink since last run? If so, 2111: # we exhausted a branch last time, therefore, we're about 2112: # to start a new one. (We know because we already checked to see 2113: # if the stack was empty.) 2114: if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) { 2115: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}}); 2116: $self->{BRANCH_DEPTH}++; 2117: return $self->BEGIN_BRANCH(); 2118: } 2119: 2120: # Remember the size for comparision next time. 2121: $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}}); 2122: 2123: # If the next resource we mean to return is going to need 2124: # a lower branch level, terminate branches until we get 2125: # there. 2126: 2127: # Get the next resource in the branch 2128: $self->{HERE} = pop @{$self->{BRANCH_STACK}}; 2129: 2130: # Are we at the right depth? If not, close a branch and return 2131: # the current resource onto the branch stack 2132: if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH}) 2133: && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} < 2134: $self->{BRANCH_DEPTH} ) { 2135: $self->{BRANCH_DEPTH}--; 2136: # return it so we can pick it up eventually 2137: push @{$self->{BRANCH_STACK}}, $self->{HERE}; 2138: return $self->END_BRANCH(); 2139: } 2140: 2141: # We always return it after this point and never before 2142: # (proof: look at just the return statements), so we 2143: # remember that we've seen this. 2144: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1; 2145: 2146: # Get the next possible resources 2147: my $nextUnfiltered = $self->{HERE}->getNext(); 2148: my $next = []; 2149: 2150: # filter the next possibilities to remove things we've 2151: # already seen. Also, remember what branch depth they should 2152: # be displayed at, since there's no other reliable way to tell. 2153: foreach (@$nextUnfiltered) { 2154: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { 2155: push @$next, $_; 2156: $_->{DATA}->{ITERATOR_DEPTH} = 2157: $self->{BRANCH_DEPTH} + 1; 2158: } 2159: } 2160: 2161: # Handle branch cases: 2162: # Nothing is available next: BRANCH_END 2163: # 1 thing next: standard non-branch 2164: # 2+ things next: have some branches 2165: my $nextCount = scalar(@$next); 2166: if ($nextCount == 0) { 2167: # Return this and on the next run, close the branch up if we're 2168: # in a branch 2169: if ($self->{BRANCH_DEPTH} > 0 ) { 2170: $self->{FORCE_NEXT} = $self->END_BRANCH(); 2171: $self->{BRANCH_DEPTH}--; 2172: } 2173: } 2174: 2175: while (@$next) { 2176: # copy the next possibilities over to the branch stack 2177: # in the right order 2178: push @{$self->{BRANCH_STACK}}, shift @$next; 2179: } 2180: 2181: if ($nextCount >= 2) { 2182: $self->{FORCE_NEXT} = $self->BEGIN_BRANCH(); 2183: $self->{BRANCH_DEPTH}++; 2184: return $self->{HERE}; 2185: } 2186: 2187: # If this is a map and we want to recurse down it... (not filtered out) 2188: if ($self->{HERE}->is_map() && 2189: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { 2190: $self->{RECURSIVE_ITERATOR_FLAG} = 1; 2191: my $firstResource = $self->{HERE}->map_start(); 2192: my $finishResource = $self->{HERE}->map_finish(); 2193: 2194: $self->{RECURSIVE_ITERATOR} = 2195: Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, 2196: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN}, 2197: $self->{CONDITION}); 2198: } 2199: 2200: return $self->{HERE}; 2201: } 2202: 2203: =pod 2204: 2205: 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). 2206: 2207: =cut 2208: 2209: sub getStack { 2210: my $self=shift; 2211: 2212: my @stack; 2213: 2214: $self->populateStack(\@stack); 2215: 2216: return \@stack; 2217: } 2218: 2219: # Private method: Calls the iterators recursively to populate the stack. 2220: sub populateStack { 2221: my $self=shift; 2222: my $stack = shift; 2223: 2224: push @$stack, $self->{HERE} if ($self->{HERE}); 2225: 2226: if ($self->{RECURSIVE_ITERATOR_FLAG}) { 2227: $self->{RECURSIVE_ITERATOR}->populateStack($stack); 2228: } 2229: } 2230: 2231: 1; 2232: 2233: package Apache::lonnavmaps::resource; 2234: 2235: use Apache::lonnet; 2236: 2237: =pod 2238: 2239: =head1 Object: resource 2240: 2241: 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. 2242: 2243: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. 2244: 2245: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource. 2246: 2247: =head2 Public Members 2248: 2249: 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. 2250: 2251: =head2 Methods 2252: 2253: =over 4 2254: 2255: =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. 2256: 2257: =back 2258: 2259: =cut 2260: 2261: sub new { 2262: # magic invocation to create a class instance 2263: my $proto = shift; 2264: my $class = ref($proto) || $proto; 2265: my $self = {}; 2266: 2267: $self->{NAV_MAP} = shift; 2268: $self->{ID} = shift; 2269: 2270: # Store this new resource in the parent nav map's cache. 2271: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; 2272: $self->{RESOURCE_ERROR} = 0; 2273: 2274: # A hash that can be used by two-pass algorithms to store data 2275: # about this resource in. Not used by the resource object 2276: # directly. 2277: $self->{DATA} = {}; 2278: 2279: bless($self); 2280: 2281: return $self; 2282: } 2283: 2284: # private function: simplify the NAV_HASH lookups we keep doing 2285: # pass the name, and to automatically append my ID, pass a true val on the 2286: # second param 2287: sub navHash { 2288: my $self = shift; 2289: my $param = shift; 2290: my $id = shift; 2291: return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; 2292: } 2293: 2294: =pod 2295: 2296: B<Metadata Retreival> 2297: 2298: These are methods that help you retrieve metadata about the resource: 2299: 2300: =over 4 2301: 2302: =item * B<ext>: Returns true if the resource is external. 2303: 2304: =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) 2305: 2306: =item * B<kind>: Returns the kind of the resource from the compiled nav map. 2307: 2308: =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. 2309: 2310: =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?) 2311: 2312: =item * B<src>: Returns the source for the resource. 2313: 2314: =item * B<symb>: Returns the symb for the resource. 2315: 2316: =item * B<title>: Returns the title of the resource. 2317: 2318: =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) 2319: 2320: =back 2321: 2322: =cut 2323: 2324: # These info functions can be used directly, as they don't return 2325: # resource information. 2326: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); } 2327: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; } 2328: sub from { my $self=shift; return $self->navHash("from_", 1); } 2329: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); } 2330: sub kind { my $self=shift; return $self->navHash("kind_", 1); } 2331: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); } 2332: sub randompick { 2333: my $self = shift; 2334: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb . 2335: '.0.parameter_randompick'}; 2336: } 2337: sub src { 2338: my $self=shift; 2339: return $self->navHash("src_", 1); 2340: } 2341: sub symb { 2342: my $self=shift; 2343: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/; 2344: my $symbSrc = &Apache::lonnet::declutter($self->src()); 2345: return &Apache::lonnet::declutter( 2346: $self->navHash('map_id_'.$first)) 2347: . '___' . $second . '___' . $symbSrc; 2348: } 2349: sub title { my $self=shift; return $self->navHash("title_", 1); } 2350: sub to { my $self=shift; return $self->navHash("to_", 1); } 2351: 2352: =pod 2353: 2354: B<Predicate Testing the Resource> 2355: 2356: These methods are shortcuts to deciding if a given resource has a given property. 2357: 2358: =over 4 2359: 2360: =item * B<is_map>: Returns true if the resource is a map type. 2361: 2362: =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.) 2363: 2364: =item * B<is_page>: Returns true if the resource is a page. 2365: 2366: =item * B<is_problem>: Returns true if the resource is a problem. 2367: 2368: =item * B<is_sequence>: Returns true if the resource sequence. 2369: 2370: =back 2371: 2372: =cut 2373: 2374: 2375: sub is_html { 2376: my $self=shift; 2377: my $src = $self->src(); 2378: return ($src =~ /html$/); 2379: } 2380: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); } 2381: sub is_page { 2382: my $self=shift; 2383: my $src = $self->src(); 2384: return ($src =~ /page$/); 2385: } 2386: sub is_problem { 2387: my $self=shift; 2388: my $src = $self->src(); 2389: return ($src =~ /problem$/); 2390: } 2391: sub is_sequence { 2392: my $self=shift; 2393: my $src = $self->src(); 2394: return ($src =~ /sequence$/); 2395: } 2396: 2397: 2398: 2399: 2400: 2401: # Move this into POD: In order to use these correctly, courseopt 2402: # and useropt need to be generated 2403: sub parmval { 2404: my $self = shift; 2405: my $what = shift; 2406: my $part = shift || "0"; 2407: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb()); 2408: } 2409: 2410: =pod 2411: 2412: B<Map Methods> 2413: 2414: These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>). 2415: 2416: =over 4 2417: 2418: =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map. 2419: 2420: =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. 2421: 2422: =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map. 2423: 2424: =item * B<map_type>: Returns a string with the type of the map in it. 2425: 2426: =back 2427: 2428: =cut 2429: 2430: sub map_finish { 2431: my $self = shift; 2432: my $src = $self->src(); 2433: my $res = $self->navHash("map_finish_$src", 0); 2434: $res = $self->{NAV_MAP}->getById($res); 2435: return $res; 2436: } 2437: sub map_pc { 2438: my $self = shift; 2439: my $src = $self->src(); 2440: return $self->navHash("map_pc_$src", 0); 2441: } 2442: sub map_start { 2443: my $self = shift; 2444: my $src = $self->src(); 2445: my $res = $self->navHash("map_start_$src", 0); 2446: $res = $self->{NAV_MAP}->getById($res); 2447: return $res; 2448: } 2449: sub map_type { 2450: my $self = shift; 2451: my $pc = $self->map_pc(); 2452: return $self->navHash("map_type_$pc", 0); 2453: } 2454: 2455: 2456: 2457: ##### 2458: # Property queries 2459: ##### 2460: 2461: # These functions will be responsible for returning the CORRECT 2462: # VALUE for the parameter, no matter what. So while they may look 2463: # like direct calls to parmval, they can be more then that. 2464: # So, for instance, the duedate function should use the "duedatetype" 2465: # information, rather then the resource object user. 2466: 2467: =pod 2468: 2469: =head2 Resource Parameters 2470: 2471: 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. 2472: 2473: 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.) 2474: 2475: =over 4 2476: 2477: =item * B<acc>: Get the Client IP/Name Access Control information. 2478: 2479: =item * B<answerdate>: Get the answer-reveal date for the problem. 2480: 2481: =item * B<duedate>: Get the due date for the problem. 2482: 2483: =item * B<tries>: Get the number of tries the student has used on the problem. 2484: 2485: =item * B<maxtries>: Get the number of max tries allowed. 2486: 2487: =item * B<opendate>: Get the open date for the problem. 2488: 2489: =item * B<sig>: Get the significant figures setting. 2490: 2491: =item * B<tol>: Get the tolerance for the problem. 2492: 2493: =item * B<tries>: Get the number of tries the user has already used on the problem. 2494: 2495: =item * B<type>: Get the question type for the problem. 2496: 2497: =item * B<weight>: Get the weight for the problem. 2498: 2499: =back 2500: 2501: =cut 2502: 2503: sub acc { 2504: (my $self, my $part) = @_; 2505: return $self->parmval("acc", $part); 2506: } 2507: sub answerdate { 2508: (my $self, my $part) = @_; 2509: # Handle intervals 2510: if ($self->parmval("answerdate.type", $part) eq 'date_interval') { 2511: return $self->duedate($part) + 2512: $self->parmval("answerdate", $part); 2513: } 2514: return $self->parmval("answerdate", $part); 2515: } 2516: sub duedate { 2517: (my $self, my $part) = @_; 2518: return $self->parmval("duedate", $part); 2519: } 2520: sub maxtries { 2521: (my $self, my $part) = @_; 2522: return $self->parmval("maxtries", $part); 2523: } 2524: sub opendate { 2525: (my $self, my $part) = @_; 2526: if ($self->parmval("opendate.type", $part) eq 'date_interval') { 2527: return $self->duedate($part) - 2528: $self->parmval("opendate", $part); 2529: } 2530: return $self->parmval("opendate"); 2531: } 2532: sub sig { 2533: (my $self, my $part) = @_; 2534: return $self->parmval("sig", $part); 2535: } 2536: sub tol { 2537: (my $self, my $part) = @_; 2538: return $self->parmval("tol", $part); 2539: } 2540: sub tries { 2541: my $self = shift; 2542: my $part = shift; 2543: $part = '0' if (!defined($part)); 2544: 2545: # Make sure return hash is loaded, should error check 2546: $self->getReturnHash(); 2547: 2548: my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'}; 2549: if (!defined($tries)) {return '0';} 2550: return $tries; 2551: } 2552: sub type { 2553: (my $self, my $part) = @_; 2554: return $self->parmval("type", $part); 2555: } 2556: sub weight { 2557: (my $self, my $part) = @_; 2558: return $self->parmval("weight", $part); 2559: } 2560: 2561: # Multiple things need this 2562: sub getReturnHash { 2563: my $self = shift; 2564: 2565: if (!defined($self->{RETURN_HASH})) { 2566: my %tmpHash = &Apache::lonnet::restore($self->symb()); 2567: $self->{RETURN_HASH} = \%tmpHash; 2568: } 2569: } 2570: 2571: ###### 2572: # Status queries 2573: ###### 2574: 2575: # These methods query the status of problems. 2576: 2577: # If we need to count parts, this function determines the number of 2578: # parts from the metadata. When called, it returns a reference to a list 2579: # of strings corresponding to the parts. (Thus, using it in a scalar context 2580: # tells you how many parts you have in the problem: 2581: # $partcount = scalar($resource->countParts()); 2582: # Don't use $self->{PARTS} directly because you don't know if it's been 2583: # computed yet. 2584: 2585: =pod 2586: 2587: =head2 Resource misc 2588: 2589: Misc. functions for the resource. 2590: 2591: =over 4 2592: 2593: =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. 2594: 2595: =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: 2596: 2597: for (split(/\,/, $res->getFeedback())) { 2598: my $link = &Apache::lonnet::escape($_); 2599: ... 2600: 2601: and use the link as appropriate. 2602: 2603: =cut 2604: 2605: sub hasDiscussion { 2606: my $self = shift; 2607: return $self->{NAV_MAP}->hasDiscussion($self->symb()); 2608: } 2609: 2610: sub getFeedback { 2611: my $self = shift; 2612: return $self->{NAV_MAP}->getFeedback($self->src()); 2613: } 2614: 2615: =pod 2616: 2617: =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.) 2618: 2619: =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. 2620: 2621: =back 2622: 2623: =cut 2624: 2625: sub parts { 2626: my $self = shift; 2627: 2628: if ($self->ext) { return ['0']; } 2629: 2630: $self->extractParts(); 2631: return $self->{PARTS}; 2632: } 2633: 2634: sub countParts { 2635: my $self = shift; 2636: 2637: my $parts = $self->parts(); 2638: 2639: if ($self->{RESOURCE_ERROR}) { 2640: return 0; 2641: } 2642: 2643: if (scalar(@{$parts}) < 2) { return 1;} 2644: 2645: return scalar(@{$parts}) - 1; 2646: } 2647: 2648: # Private function: Extracts the parts information and saves it 2649: sub extractParts { 2650: my $self = shift; 2651: 2652: return if ($self->{PARTS}); 2653: return if ($self->ext); 2654: 2655: $self->{PARTS} = []; 2656: 2657: # Retrieve part count, if this is a problem 2658: if ($self->is_problem()) { 2659: my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys'); 2660: if (!$metadata) { 2661: $self->{RESOURCE_ERROR} = 1; 2662: $self->{PARTS} = []; 2663: return; 2664: } 2665: 2666: foreach (split(/\,/,$metadata)) { 2667: if ($_ =~ /^parameter\_(.*)\_opendate$/) { 2668: push @{$self->{PARTS}}, $1; 2669: } 2670: } 2671: 2672: 2673: # Is this possible to do in one line? - Jeremy 2674: my @sortedParts = sort @{$self->{PARTS}}; 2675: $self->{PARTS} = \@sortedParts; 2676: } 2677: 2678: return; 2679: } 2680: 2681: =pod 2682: 2683: =head2 Resource Status 2684: 2685: 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. 2686: 2687: There are two aspects to the status: the date-related information and the completion information. 2688: 2689: Idiomatic usage of these two methods would probably look something like 2690: 2691: foreach ($resource->parts()) { 2692: my $dateStatus = $resource->getDateStatus($_); 2693: my $completionStatus = $resource->getCompletionStatus($_); 2694: 2695: or 2696: 2697: my $status = $resource->status($_); 2698: 2699: ... use it here ... 2700: } 2701: 2702: =over 4 2703: 2704: =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: 2705: 2706: =back 2707: 2708: B<Date Codes> 2709: 2710: =over 4 2711: 2712: =item * B<OPEN_LATER>: The problem will be opened later. 2713: 2714: =item * B<OPEN>: Open and not yet due. 2715: 2716: 2717: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived. 2718: 2719: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set. 2720: 2721: =item * B<ANSWER_OPEN>: The answer date is here. 2722: 2723: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure. 2724: 2725: =back 2726: 2727: =cut 2728: 2729: # Apparently the compiler optimizes these into constants automatically 2730: sub OPEN_LATER { return 0; } 2731: sub OPEN { return 1; } 2732: sub PAST_DUE_NO_ANSWER { return 2; } 2733: sub PAST_DUE_ANSWER_LATER { return 3; } 2734: sub ANSWER_OPEN { return 4; } 2735: sub NOTHING_SET { return 5; } 2736: sub NETWORK_FAILURE { return 100; } 2737: 2738: # getDateStatus gets the date status for a given problem part. 2739: # Because answer date, due date, and open date are fully independent 2740: # (i.e., it is perfectly possible to *only* have an answer date), 2741: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x 2742: # (past, future, none given). This function handles this with a decision 2743: # tree. Read the comments to follow the decision tree. 2744: 2745: sub getDateStatus { 2746: my $self = shift; 2747: my $part = shift; 2748: $part = "0" if (!defined($part)); 2749: 2750: # Always return network failure if there was one. 2751: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); 2752: 2753: my $now = time(); 2754: 2755: my $open = $self->opendate($part); 2756: my $due = $self->duedate($part); 2757: my $answer = $self->answerdate($part); 2758: 2759: if (!$open && !$due && !$answer) { 2760: # no data on the problem at all 2761: # should this be the same as "open later"? think multipart. 2762: return $self->NOTHING_SET; 2763: } 2764: if (!$open || $now < $open) {return $self->OPEN_LATER} 2765: if (!$due || $now < $due) {return $self->OPEN} 2766: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER} 2767: if ($answer) { return $self->ANSWER_OPEN; } 2768: return PAST_DUE_NO_ANSWER; 2769: } 2770: 2771: =pod 2772: 2773: B<> 2774: 2775: =over 4 2776: 2777: =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: 2778: 2779: =back 2780: 2781: B<Completion Codes> 2782: 2783: =over 4 2784: 2785: =item * B<NOT_ATTEMPTED>: Has not been attempted at all. 2786: 2787: =item * B<INCORRECT>: Attempted, but wrong by student. 2788: 2789: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override. 2790: 2791: =item * B<CORRECT>: Correct or correct by instructor. 2792: 2793: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override. 2794: 2795: =item * B<EXCUSED>: Excused. Not yet implemented. 2796: 2797: =item * B<NETWORK_FAILURE>: Information not available due to network failure. 2798: 2799: =item * B<ATTEMPTED>: Attempted, and not yet graded. 2800: 2801: =back 2802: 2803: =cut 2804: 2805: sub NOT_ATTEMPTED { return 10; } 2806: sub INCORRECT { return 11; } 2807: sub INCORRECT_BY_OVERRIDE { return 12; } 2808: sub CORRECT { return 13; } 2809: sub CORRECT_BY_OVERRIDE { return 14; } 2810: sub EXCUSED { return 15; } 2811: sub ATTEMPTED { return 16; } 2812: 2813: sub getCompletionStatus { 2814: my $self = shift; 2815: my $part = shift; 2816: $part = "0" if (!defined($part)); 2817: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); 2818: 2819: # Make sure return hash exists 2820: $self->getReturnHash(); 2821: 2822: my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'}; 2823: 2824: # Left as seperate if statements in case we ever do more with this 2825: if ($status eq 'correct_by_student') {return $self->CORRECT;} 2826: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; } 2827: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } 2828: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } 2829: if ($status eq 'excused') {return $self->EXCUSED; } 2830: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; } 2831: return $self->NOT_ATTEMPTED; 2832: } 2833: 2834: =pod 2835: 2836: B<Composite Status> 2837: 2838: 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()): 2839: 2840: =over 4 2841: 2842: =item * B<NETWORK_FAILURE>: The network has failed and the information is not available. 2843: 2844: =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".) 2845: 2846: =item * B<CORRECT>: For any reason at all, the part is considered correct. 2847: 2848: =item * B<EXCUSED>: For any reason at all, the problem is excused. 2849: 2850: =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set. 2851: 2852: =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set. 2853: 2854: =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available. 2855: 2856: =item * B<OPEN_LATER>: The problem is not yet open. 2857: 2858: =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left. 2859: 2860: =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer. 2861: 2862: =item * B<OPEN>: The item is open and not yet tried. 2863: 2864: =item * B<ATTEMPTED>: The problem has been attempted. 2865: 2866: =back 2867: 2868: =cut 2869: 2870: sub TRIES_LEFT { return 10; } 2871: 2872: sub status { 2873: my $self = shift; 2874: my $part = shift; 2875: if (!defined($part)) { $part = "0"; } 2876: my $completionStatus = $self->getCompletionStatus($part); 2877: my $dateStatus = $self->getDateStatus($part); 2878: 2879: # What we have is a two-dimensional matrix with 4 entries on one 2880: # dimension and 5 entries on the other, which we want to colorize, 2881: # plus network failure and "no date data at all". 2882: 2883: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } 2884: 2885: # There are a few whole rows we can dispose of: 2886: if ($completionStatus == CORRECT || 2887: $completionStatus == CORRECT_BY_OVERRIDE ) { 2888: return CORRECT; 2889: } 2890: 2891: if ($completionStatus == ATTEMPTED) { 2892: return ATTEMPTED; 2893: } 2894: 2895: # If it's EXCUSED, then return that no matter what 2896: if ($completionStatus == EXCUSED) { 2897: return EXCUSED; 2898: } 2899: 2900: if ($dateStatus == NOTHING_SET) { 2901: return NOTHING_SET; 2902: } 2903: 2904: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted) 2905: # by 4 matrix (date statuses). 2906: 2907: if ($dateStatus == PAST_DUE_ANSWER_LATER || 2908: $dateStatus == PAST_DUE_NO_ANSWER ) { 2909: return $dateStatus; 2910: } 2911: 2912: if ($dateStatus == ANSWER_OPEN) { 2913: return ANSWER_OPEN; 2914: } 2915: 2916: # Now: (incorrect, incorrect_override, not_attempted) x 2917: # (open_later), (open) 2918: 2919: if ($dateStatus == OPEN_LATER) { 2920: return OPEN_LATER; 2921: } 2922: 2923: # If it's WRONG... 2924: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) { 2925: # and there are TRIES LEFT: 2926: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) { 2927: return TRIES_LEFT; 2928: } 2929: return INCORRECT; # otherwise, return orange; student can't fix this 2930: } 2931: 2932: # Otherwise, it's untried and open 2933: return OPEN; 2934: } 2935: 2936: =pod 2937: 2938: =head2 Resource/Nav Map Navigation 2939: 2940: =over 4 2941: 2942: =item * B<getNext>($alreadySeenHashRef): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. The "alreadySeenHashRef" is an optional parameter that can be passed in to the method. If $$alreadySeenHashRef{$res->id()} is true in that hash, getNext will not return it in the list. In other words, you can use it to suppress resources you've already seen in the getNext method directly. 2943: 2944: =item * B<getPrevious>($alreadySeenHashRef): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. $alreadySeenHashRef is the same as in getNext. 2945: 2946: =cut 2947: 2948: sub getNext { 2949: my $self = shift; 2950: my $alreadySeenHash = shift; 2951: my @branches; 2952: my $to = $self->to(); 2953: foreach my $branch ( split(/,/, $to) ) { 2954: my $choice = $self->{NAV_MAP}->getById($branch); 2955: my $next = $choice->goesto(); 2956: $next = $self->{NAV_MAP}->getById($next); 2957: 2958: # Don't remember it if we've already seen it or if 2959: # the student doesn't have browse priviledges 2960: my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); 2961: if (!defined($alreadySeenHash) || 2962: !defined($alreadySeenHash->{$next->{ID}}) || 2963: ($browsePriv ne '2' && $browsePriv ne 'F')) { 2964: push @branches, $next; 2965: } 2966: } 2967: return \@branches; 2968: } 2969: 2970: sub getPrevious { 2971: my $self = shift; 2972: my $alreadySeenHash = shift; 2973: my @branches; 2974: my $from = $self->from(); 2975: foreach my $branch ( split /,/, $from) { 2976: my $choice = $self->{NAV_MAP}->getById($branch); 2977: my $prev = $choice->comesfrom(); 2978: $prev = $self->{NAV_MAP}->getById($prev); 2979: 2980: # Skip it if we've already seen it or the user doesn't have 2981: # browse privs 2982: my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); 2983: if (!defined($alreadySeenHash) || 2984: !defined($alreadySeenHash->{$prev->{ID}}) || 2985: ($browsePriv ne '2' && $browsePriv ne 'F')) { 2986: push @branches, $prev; 2987: } 2988: } 2989: return \@branches; 2990: } 2991: 2992: =pod 2993: 2994: =back 2995: 2996: =cut 2997: 2998: 1; 2999: 3000: __END__ 3001: 3002: