--- loncom/interface/lonnavmaps.pm 2002/03/26 23:14:39 1.35 +++ loncom/interface/lonnavmaps.pm 2002/09/24 01:18:50 1.51 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.35 2002/03/26 23:14:39 www Exp $ +# $Id: lonnavmaps.pm,v 1.51 2002/09/24 01:18:50 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -67,6 +67,10 @@ my %courseopt; my %useropt; my %parmhash; +# This parameter keeps track of whether obtaining the user's information +# failed, which the colorizer in astatus can use +my $networkFailedFlag = 0; + # ------------------------------------------------------------------ Euclid gcd sub euclid { @@ -74,7 +78,7 @@ sub euclid { my $a; my $b; my $r; if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; } while ($r!=0) { - $a=$b; $b=$r; + $a=$b; $b=$r; $r=$a%$b; } return $b; @@ -121,14 +125,14 @@ sub parmval { # ---------------------------------------------------------- first, check user if ($uname) { - if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; } - if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; } - if ($useropt{$courselevel}) { return $useropt{$courselevel}; } + if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; } + if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; } + if ($useropt{$courselevel}) { return $useropt{$courselevel}; } } # ------------------------------------------------------- second, check course if ($csec) { - if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; } + if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; } if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; } if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; } } @@ -152,14 +156,14 @@ sub parmval { my ($space,@qualifier)=split(/\./,$rwhat); my $qualifier=join('.',@qualifier); unless ($space eq '0') { - my ($part,$id)=split(/\_/,$space); - if ($id) { - my $partgeneral=&parmval($part.".$qualifier",$symb); - if ($partgeneral) { return $partgeneral; } - } else { - my $resourcegeneral=&parmval("0.$qualifier",$symb); - if ($resourcegeneral) { return $resourcegeneral; } - } + my ($part,$id)=split(/\_/,$space); + if ($id) { + my $partgeneral=&parmval($part.".$qualifier",$symb); + if ($partgeneral) { return $partgeneral; } + } else { + my $resourcegeneral=&parmval("0.$qualifier",$symb); + if ($resourcegeneral) { return $resourcegeneral; } + } } return ''; } @@ -186,17 +190,23 @@ sub astatus { my $ctext=''; $rid=~/(\d+)\.(\d+)/; my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'. - &Apache::lonnet::declutter($hash{'src_'.$rid}); + &Apache::lonnet::declutter($hash{'src_'.$rid}); my %duedate=(); my %opendate=(); my %answerdate=(); # need to always check part 0's open/due/answer status - foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'keys')))) { + foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) { if ($_=~/^parameter\_(.*)\_opendate$/) { - my $part=$1; + my $part=$1; $duedate{$part}=&parmval($part.'.duedate',$symb); $opendate{$part}=&parmval($part.'.opendate',$symb); $answerdate{$part}=&parmval($part.'.answerdate',$symb); + if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') { + $opendate{$part}=$duedate{$part}-$opendate{$part}; + } + if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') { + $answerdate{$part}=$duedate{$part}+$answerdate{$part}; + } } } my $now=time; @@ -205,64 +215,64 @@ sub astatus { my %returnhash=&Apache::lonnet::restore($symb); foreach (sort(keys(%opendate))) { - my $duedate=$duedate{$_}; - my $opendate=$opendate{$_}; - my $answerdate=$answerdate{$_}; - my $preface=''; - unless ($_ eq '0') { $preface=' Part: '.$_.' '; } - if ($opendate) { - if ($now<$duedate || (!$duedate)) { - unless ($tcode==4) { $tcode=2; } - if ($duedate) { - $ctext.=$preface.'Due: '.localtime($duedate); - } else { - $ctext.=$preface.'No Due Date'; - } - if ($now<$opendate) { - unless ($tcode) { $tcode=1; } - $ctext.=$preface.'Open: '.localtime($opendate); - } - if ($duedate && $duedate-$now<86400) { - $tcode=4; - $ctext.=$preface.'Due: '.localtime($duedate); - } - } else { - unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; } - if ($now<$answerdate) { - $ctext.='Answer: '.localtime($duedate); - } - } - } else { - unless (($tcode==2) || ($tcode==4)) { $tcode=1; } - } - - my $status=$returnhash{'resource.'.$_.'.solved'}; - - if ($status eq 'correct_by_student') { - if ($code==0||$code==3) { $code=3; } else { $code=4; } - $ctext.=' solved'; - } elsif ($status eq 'correct_by_override') { - if ($code==0||$code==3) { $code=3; } else { $code=4; } - $ctext.=' override'; - } elsif ($status eq 'incorrect_attempted') { - if ($code!=4 && $code!=3) { $code=2; } - if ($code==3) { $code=4; } - $ctext.=' ('. - ($returnhash{'resource.'.$_.'.tries'}? - $returnhash{'resource.'.$_.'.tries'}:'0'); - my $numtries = &parmval($_.'.maxtries',$symb); - if ($numtries) { $ctext.='/'.$numtries.' tries'; } - $ctext.=')'; - } elsif ($status eq 'incorrect_by_override') { - if ($code!=4 && $code!=3) { $code=2; } - if ($code==3) { $code=4; } - $ctext.=' override'; - } elsif ($status eq 'excused') { - if ($code==0||$code==3) { $code=3; } else { $code=4; } - $ctext.=' excused'; - } else { - if ($code==0) { $code=1; } - } + my $duedate=$duedate{$_}; + my $opendate=$opendate{$_}; + my $answerdate=$answerdate{$_}; + my $preface=''; + unless ($_ eq '0') { $preface=' Part: '.$_.' '; } + if ($opendate) { + if ($now<$duedate || (!$duedate)) { + unless ($tcode==4) { $tcode=2; } + if ($duedate) { + $ctext.=$preface.'Due: '.localtime($duedate); + } else { + $ctext.=$preface.'No Due Date'; + } + if ($now<$opendate) { + unless ($tcode) { $tcode=1; } + $ctext.=$preface.'Open: '.localtime($opendate); + } + if ($duedate && $duedate-$now<86400) { + $tcode=4; + $ctext.=$preface.'Due: '.localtime($duedate); + } + } else { + unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; } + if ($now<$answerdate) { + $ctext.='Answer: '.localtime($duedate); + } + } + } else { + unless (($tcode==2) || ($tcode==4)) { $tcode=1; } + } + + my $status=$returnhash{'resource.'.$_.'.solved'}; + + if ($status eq 'correct_by_student') { + if ($code==0||$code==3) { $code=3; } else { $code=4; } + $ctext.=' solved'; + } elsif ($status eq 'correct_by_override') { + if ($code==0||$code==3) { $code=3; } else { $code=4; } + $ctext.=' override'; + } elsif ($status eq 'incorrect_attempted') { + if ($code!=4 && $code!=3) { $code=2; } + if ($code==3) { $code=4; } + $ctext.=' ('. + ($returnhash{'resource.'.$_.'.tries'}? + $returnhash{'resource.'.$_.'.tries'}:'0'); + my $numtries = &parmval($_.'.maxtries',$symb); + if ($numtries) { $ctext.='/'.$numtries.' tries'; } + $ctext.=')'; + } elsif ($status eq 'incorrect_by_override') { + if ($code!=4 && $code!=3) { $code=2; } + if ($code==3) { $code=4; } + $ctext.=' override'; + } elsif ($status eq 'excused') { + if ($code==0||$code==3) { $code=3; } else { $code=4; } + $ctext.=' excused'; + } else { + if ($code==0) { $code=1; } + } } return 'p'.$code.$tcode.'"'.$ctext.'"'; @@ -272,26 +282,26 @@ sub astatus { sub addresource { my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_; if ($showtypes eq 'problems') { - if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) { - return; - } + if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) { + return; + } } my $brepriv=&Apache::lonnet::allowed('bre',$resource); if ($hash{'src_'.$rid}) { - if (($brepriv eq '2') || ($brepriv eq 'F')) { - my $pprefix=''; - if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) { - $pprefix=&astatus($rid); - } - $$sofar++; - if ($indent) { $pprefix='i'.$indent.','.$pprefix; } - if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; } - if (defined($rows[$$sofar])) { - $rows[$$sofar].='&'.$pprefix.$rid; - } else { - $rows[$$sofar]=$pprefix.$rid; - } - } + if (($brepriv eq '2') || ($brepriv eq 'F')) { + my $pprefix=''; + if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) { + $pprefix=&astatus($rid); + } + $$sofar++; + if ($indent) { $pprefix='i'.$indent.','.$pprefix; } + if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; } + if (defined($rows[$$sofar])) { + $rows[$$sofar].='&'.$pprefix.$rid; + } else { + $rows[$$sofar]=$pprefix.$rid; + } + } } } @@ -300,36 +310,36 @@ sub followlinks () { my $mincond=1; my $next=''; foreach (split(/\,/,$hash{'to_'.$rid})) { - my $thiscond= - &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}}); - if ($thiscond>=$mincond) { - if ($next) { - $next.=','.$_.':'.$thiscond; - } else { - $next=$_.':'.$thiscond; - } - if ($thiscond>$mincond) { $mincond=$thiscond; } - } + my $thiscond= + &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}}); + if ($thiscond>=$mincond) { + if ($next) { + $next.=','.$_.':'.$thiscond; + } else { + $next=$_.':'.$thiscond; + } + if ($thiscond>$mincond) { $mincond=$thiscond; } + } } my $col=0; &Apache::lonxml::debug("following links -$next-"); foreach (split(/\,/,$next)) { - my ($nextlinkid,$condval)=split(/\:/,$_); - if ($condval>=$mincond) { - my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid}, - $beenhere,$showtypes,$indent,$linkid); - if ($now>$further) { - if ($col>0) { - my $string; - for(my $i=0;$i<$col;$i++) { $string.='&'; } - for(my $i=$further+1;$now-1>$i;$i++) { - $rows[$i]=$string.$rows[$i]; - } - } - $further=$now; - } - } - $col++; + my ($nextlinkid,$condval)=split(/\:/,$_); + if ($condval>=$mincond) { + my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid}, + $beenhere,$showtypes,$indent,$linkid); + if ($now>$further) { + if ($col>0) { + my $string; + for(my $i=0;$i<$col;$i++) { $string.='&'; } + for(my $i=$further+1;$now-1>$i;$i++) { + $rows[$i]=$string.$rows[$i]; + } + } + $further=$now; + } + } + $col++; } return $further; } @@ -339,49 +349,49 @@ sub tracetable { my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_; my $newshowtypes=$showtypes; my $further=$sofar; - #$Apache::lonxml::debug=1; +# $Apache::lonxml::debug=1; &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid}); if ($beenhere=~/\&$rid\&/) { return $further; } $beenhere.=$rid.'&'; if (defined($hash{'is_map_'.$rid})) { - $sofar++; - my $tprefix=''; - if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} - eq 'sequence') { - $tprefix='h'; - } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} - eq 'page') { - $tprefix='j'; - if ($indent) { $tprefix='i'.$indent.','.$tprefix; } - if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; } - $newshowtypes='problems'; - $indent++; - #if in a .page continue to link the encompising .page - if (!$linkid) { $linkid=$rid; } - } - if (defined($rows[$sofar])) { - $rows[$sofar].='&'.$tprefix.$rid; - } else { - $rows[$sofar]=$tprefix.$rid; - } - if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) && - (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) { - my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}}; - $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}}, - '&'.$frid.'&',$newshowtypes,$indent,$linkid); - &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes, - $indent,$linkid); - if ($tprefix =~ /j$/) { $indent--; $linkid=''; } - } + $sofar++; + my $tprefix=''; + if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} + eq 'sequence') { + $tprefix='h'; + } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} + eq 'page') { + $tprefix='j'; + if ($indent) { $tprefix='i'.$indent.','.$tprefix; } + if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; } + $newshowtypes='problems'; + $indent++; + #if in a .page continue to link the encompising .page + if (!$linkid) { $linkid=$rid; } + } + if (defined($rows[$sofar])) { + $rows[$sofar].='&'.$tprefix.$rid; + } else { + $rows[$sofar]=$tprefix.$rid; + } + if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) && + (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) { + my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}}; + $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}}, + '&'.$frid.'&',$newshowtypes,$indent,$linkid); + &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes, + $indent,$linkid); + if ($tprefix =~ /j$/) { $indent--; $linkid=''; } + } } else { - &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes, - $indent,$linkid); + &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes, + $indent,$linkid); } if (defined($hash{'to_'.$rid})) { - $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes, - $indent,$linkid); + $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes, + $indent,$linkid); } return $further; @@ -392,52 +402,60 @@ sub tracetable { sub handler { my $r=shift; + &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); + + if ($ENV{'form.jtest'} ne "1") + { + return new_handle($r); + } # ------------------------------------------- Set document type for header only if ($r->header_only) { - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); - } - $r->send_http_header; - return OK; + if ($ENV{'browser.mathml'}) { + $r->content_type('text/xml'); + } else { + $r->content_type('text/html'); + } + $r->send_http_header; + return OK; } my $requrl=$r->uri; my $hashtied; # ----------------------------------------------------------------- Tie db file my $fn; if ($ENV{'request.course.fn'}) { - $fn=$ENV{'request.course.fn'}; - if (-e "$fn.db") { - if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER,0640)) && - (tie(%parmhash,'GDBM_File', - $ENV{'request.course.fn'}.'_parms.db', - &GDBM_READER,0640))) { - $hashtied=1; - } - } + $fn=$ENV{'request.course.fn'}; + if (-e "$fn.db") { + if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) && + (tie(%parmhash,'GDBM_File', + $ENV{'request.course.fn'}.'_parms.db', + &GDBM_READER(),0640))) { + $hashtied=1; + } + } } if (!$hashtied) { - $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; - return HTTP_NOT_ACCEPTABLE; + $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; + return HTTP_NOT_ACCEPTABLE; } # ------------------------------------------------------------------- Hash tied if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); + $r->content_type('text/xml'); } else { - $r->content_type('text/html'); + $r->content_type('text/html'); } &Apache::loncommon::no_cache($r); $r->send_http_header; - my $firstres=$hash{'map_start_/res/'.$ENV{'request.course.uri'}}; - my $lastres=$hash{'map_finish_/res/'.$ENV{'request.course.uri'}}; + my $firstres=$hash{'map_start_'. + &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + my $lastres=$hash{'map_finish_'. + &Apache::lonnet::clutter($ENV{'request.course.uri'})}; if (!(($firstres) && ($lastres))) { - $r->print('Coursemap undefined.'); + $r->print('Coursemap undefined.'); } else { # ----------------------------------------------------------------- Render page @@ -445,301 +463,1733 @@ sub handler { # ---------------------------- initialize coursedata and userdata for this user - undef %courseopt; - undef %useropt; + undef %courseopt; + undef %useropt; - my $uname=$ENV{'user.name'}; - my $udom=$ENV{'user.domain'}; - my $uhome=$ENV{'user.home'}; - my $cid=$ENV{'request.course.id'}; - my $chome=$ENV{'course.'.$cid.'.home'}; - my ($cdom,$cnum)=split(/\_/,$cid); - - my $userprefix=$uname.'_'.$udom.'_'; - - unless ($uhome eq 'no_host') { -# -------------------------------------------------------------- Get coursedata - unless ((time-$courserdatas{$cid.'.last_cache'})<240) { - my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum. - ':resourcedata',$chome); - if ($reply!~/^error\:/) { - $courserdatas{$cid}=$reply; - $courserdatas{$cid.'.last_cache'}=time; - } - } - foreach (split(/\&/,$courserdatas{$cid})) { - my ($name,$value)=split(/\=/,$_); - $courseopt{$userprefix.&Apache::lonnet::unescape($name)}= - &Apache::lonnet::unescape($value); - } + my $uname=$ENV{'user.name'}; + my $udom=$ENV{'user.domain'}; + my $uhome=$ENV{'user.home'}; + my $cid=$ENV{'request.course.id'}; + my $chome=$ENV{'course.'.$cid.'.home'}; + my ($cdom,$cnum)=split(/\_/,$cid); + + my $userprefix=$uname.'_'.$udom.'_'; + + unless ($uhome eq 'no_host') { +# ------------------------------------------------- Get coursedata (if present) + unless ((time-$courserdatas{$cid.'.last_cache'})<240) { + my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum. + ':resourcedata',$chome); + if ($reply!~/^error\:/) { + $courserdatas{$cid}=$reply; + $courserdatas{$cid.'.last_cache'}=time; + } + # check to see if network failed + elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) + { + $networkFailedFlag = 1; + } + } + foreach (split(/\&/,$courserdatas{$cid})) { + my ($name,$value)=split(/\=/,$_); + $courseopt{$userprefix.&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } # --------------------------------------------------- Get userdata (if present) - unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) { - my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); - if ($reply!~/^error\:/) { - $userrdatas{$uname.'___'.$udom}=$reply; - $userrdatas{$uname.'___'.$udom.'.last_cache'}=time; - } - } - foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) { - my ($name,$value)=split(/\=/,$_); - $useropt{$userprefix.&Apache::lonnet::unescape($name)}= - &Apache::lonnet::unescape($value); - } - } + unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) { + my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); + if ($reply!~/^error\:/) { + $userrdatas{$uname.'___'.$udom}=$reply; + $userrdatas{$uname.'___'.$udom.'.last_cache'}=time; + } + } + foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) { + my ($name,$value)=split(/\=/,$_); + $useropt{$userprefix.&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } + } - @rows=(); + @rows=(); - &tracetable(0,$firstres,'&'.$lastres.'&','',0); - if ($hash{'src_'.$lastres}) { - my $brepriv=&Apache::lonnet::allowed('bre',$hash{'src_'.$lastres}); - if (($brepriv eq '2') || ($brepriv eq 'F')) { - $rows[$#rows+1]=''.$lastres; - } - } + &tracetable(0,$firstres,'&','',0); # ------------------------------------------------------------------ Page parms - my $j; - my $i; - my $lcm=1; - my $contents=0; + my $j; + my $i; + my $lcm=1; + my $contents=0; # ---------------------------------------------- Go through table to get layout - for ($i=0;$i<=$#rows;$i++) { - if ($rows[$i]) { - &Apache::lonxml::debug("Row $i is:".$rows[$i]); - $contents++; - my @colcont=split(/\&/,$rows[$i]); - $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1)); - } - } + for ($i=0;$i<=$#rows;$i++) { + if ($rows[$i]) { + &Apache::lonxml::debug("Row $i is:".$rows[$i]); + $contents++; + my @colcont=split(/\&/,$rows[$i]); + $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1)); + } + } - unless ($contents) { - $r->print('Empty Map.'); - } else { + unless ($contents) { + $r->print('Empty Map.'); + } else { # ------------------------------------------------------------------ Build page - my $currenturl=$ENV{'form.postdata'}; - $currenturl=~s/^http\:\/\///; - $currenturl=~s/^[^\/]+//; + my $currenturl=$ENV{'form.postdata'}; + $currenturl=~s/^http\:\/\///; + $currenturl=~s/^[^\/]+//; # ---------------------------------------------------------------- Send headers - my $date=localtime; - my $now=time; + my $date=localtime; + my $now=time; # ----------------------------------------- Get email status and discussiontime - my %emailstatus=&Apache::lonnet::dump('email_status'); - my $logouttime=$emailstatus{'logout'}; - my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}}; - my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime); - - my %discussiontimes=&Apache::lonnet::dump('discussiontimes', - $cdom,$cnum); - - my %feedback=(); - my %error=(); - foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'. - $ENV{'user.domain'}.':'. - $ENV{'user.name'}.':nohist_email', - $ENV{'user.home'}))) { - $msgid=&Apache::lonnet::unescape($msgid); - my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid)); - if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) { - my ($what,$url)=($1,$2); - my %status= - &Apache::lonnet::get('email_status',[$msgid]); - if ($status{$msgid}=~/^error\:/) { - $status{$msgid}=''; - } - - if (($status{$msgid} eq 'new') || - (!$status{$msgid})) { - if ($what eq 'Error') { - $error{$url}.=','.$msgid; - } else { - $feedback{$url}.=','.$msgid; - } - } - } - } + my %emailstatus=&Apache::lonnet::dump('email_status'); + my $logouttime=$emailstatus{'logout'}; + my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}}; + my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime); + + my %discussiontimes=&Apache::lonnet::dump('discussiontimes', + $cdom,$cnum); + + my %feedback=(); + my %error=(); + foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'. + $ENV{'user.domain'}.':'. + $ENV{'user.name'}.':nohist_email', + $ENV{'user.home'}))) { + $msgid=&Apache::lonnet::unescape($msgid); + my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid)); + if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) { + my ($what,$url)=($1,$2); + my %status= + &Apache::lonnet::get('email_status',[$msgid]); + if ($status{$msgid}=~/^error\:/) { + $status{$msgid}=''; + } + + if (($status{$msgid} eq 'new') || + (!$status{$msgid})) { + if ($what eq 'Error') { + $error{$url}.=','.$msgid; + } else { + $feedback{$url}.=','.$msgid; + } + } + } + } # ----------------------------------------------------------- Start Page Output - $r->print('Navigate LON-CAPA Maps'); - $r->print('print(' onLoad="window.location.hash='."'curloc'".'"'); - } - $r->print('>'. - ''. - '

Navigate Course Map

'. - "

$date

"); - $r->rflush(); - $r->print(' New discussion since '. - localtime($lastcheck). - '
New message (click to open)

'); - if (($currenturl=~/^\/res/) && - ($currenturl!~/^\/res\/adm/)) { - $r->print('Current Location

'); - } + my $bodytagadd=''; + $r->print( + 'Navigate Course Map'); + if (($currenturl=~/^\/res/) && + ($currenturl!~/^\/res\/adm/)) { + $bodytagadd='onLoad="window.location.hash='."'curloc'".'"'; + } + $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', + $bodytagadd)); + $r->print(''); + my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + if (defined($desc)) { $r->print("

$desc

\n"); } + $r->print("

$date

\n"); + $r->rflush(); + $r->print(' New discussion since '. + localtime($lastcheck). + '
New message (click to open)

'); + if (($currenturl=~/^\/res/) && + ($currenturl!~/^\/res\/adm/)) { + $r->print('Current Location

'); + } + + # Handle a network error + + if ($networkFailedFlag) + { + $r->print('

LON-CAPA network failure.

'."\n"); + $r->print("

LON-CAPA's network is having difficulties, some problem" . + " information, such as due dates, will not be available."); + } # ----------------------------------------------------- The little content list - for ($i=0;$i<=$#rows;$i++) { - if ($rows[$i]) { - my @colcont=split(/\&/,$rows[$i]); - my $avespan=$lcm/($#colcont+1); - for ($j=0;$j<=$#colcont;$j++) { - my $rid=$colcont[$j]; - if ($rid=~/^h(.+)/) { - $rid=$1; - $r->print('   '.$hash{'title_'.$rid}. - '
'); - } - } - } - } + for ($i=0;$i<=$#rows;$i++) { + if ($rows[$i]) { + my @colcont=split(/\&/,$rows[$i]); + my $avespan=$lcm/($#colcont+1); + for ($j=0;$j<=$#colcont;$j++) { + my $rid=$colcont[$j]; + if ($rid=~/^h(.+)/) { + $rid=$1; + $r->print('   '.$hash{'title_'.$rid}. + '
'); + } + } + } + } # ----------------------------------------------------------------- Start table - $r->print('

'); - for ($i=0;$i<=$#rows;$i++) { - if ($rows[$i]) { - $r->print("\n"); - my @colcont=split(/\&/,$rows[$i]); - my $avespan=$lcm/($#colcont+1); - for ($j=0;$j<=$#colcont;$j++) { - my $indent;my $indentstr; - my $linkid; - my $rid=$colcont[$j]; - my $add=''; - my $hwk=''; - my $hwke=''; - if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; } - if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; } - if ($rid=~/^h(.+)/) { - $rid=$1; - $add=''; - } - if ($rid=~/^j(.+)/) { $rid=$1; } - if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) { - # sub astatus describes what code/tcode mean - my $code=$1; - my $tcode=$2; - my $ctext=$3; - $rid=$4; - if ($tcode eq '1') { - $add=''; - } - } - $hwk=''; - $hwke=''; - if ($code eq '1') { - $hwke=' ('.$ctext.')'; - } - if ($code eq '2' || $code eq '4') { - $hwk=''; - $hwke=' ('.$ctext.')'; - } - if ($code eq '3') { - $hwk=''; - $hwke=' ('.$ctext.')'; - } - } - if ($rid && $hash{'src_'.$rid} eq $currenturl) { - $add=$add.''. - '> '; - $adde= - ' <'.$adde; - } - my $src= - &Apache::lonnet::declutter($hash{'src_'.$rid}); - $rid=~/^(\d+)\.(\d+)$/; - my $symb= - &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src; - if ($discussiontimes{$symb}>$lastcheck) { - $adde= - ''. - $adde; - } - if ($error{$src}) { - foreach (split(/\,/,$error{$src})) { - if ($_) { - $adde= - ' ' - .$adde; - } - } - } - if ($feedback{$src}) { - foreach (split(/\,/,$feedback{$src})) { - if ($_) { - $adde= - ' ' - .$adde; - } - } - } - if ($indent) { - my $is="  "; - for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; } - } - if (!$linkid) { $linkid=$rid; } - $r->print($add.$indentstr); - if ($rid) { - $r->print(''); + for ($i=0;$i<=$#rows;$i++) { + if ($rows[$i]) { + $r->print("\n"); + my @colcont=split(/\&/,$rows[$i]); + my $avespan=$lcm/($#colcont+1); + + # for each item I wish to print on this row... + for ($j=0;$j<=$#colcont;$j++) { + my $indent;my $indentstr; + my $linkid; + my $rid=$colcont[$j]; + $rid=~/(\d+)\.(\d+)$/; + my $src= + &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2}); + my $symb= + &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src; + my $add=''; + my $hwk=''; + my $hwke=''; + if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; } + if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; } + if ($rid=~/^h(.+)/) { + $rid=$1; + $add=''; + if (($ENV{'user.adv'}) && + ($parmhash{$symb.'.0.parameter_randompick'})) { + $adde=' (randomly select '. + $parmhash{$symb.'.0.parameter_randompick'}. + ')'; + } + } + if ($rid=~/^j(.+)/) { $rid=$1; } + if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) { + # sub astatus describes what code/tcode mean + my $code=$1; + my $tcode=$2; + my $ctext=$3; + $rid=$4; + + # will open later + if ($tcode eq '1') { + $add=''; + } + } + $hwk=''; + $hwke=''; + if ($code eq '1') { + $hwke=' ('.$ctext.')'; + } + if ($code eq '2' || $code eq '4') { + $hwk=''; + $hwke=' ('.$ctext.')'; + } + if ($code eq '3') { + $hwk=''; + $hwke=' ('.$ctext.')'; + } + if ($networkFailedFlag) + { + $hwke=' (status unavailable)'; + } + } + if ($rid && $hash{'src_'.$rid} eq $currenturl) { + $add=$add.''. + '> '; + $adde= + ' <'.$adde; + } + if ($discussiontimes{$symb}>$lastcheck) { + $adde= + ''. + $adde; + } + if ($error{$src}) { + foreach (split(/\,/,$error{$src})) { + if ($_) { + $adde= + ' ' + .$adde; + } + } + } + if ($feedback{$src}) { + foreach (split(/\,/,$feedback{$src})) { + if ($_) { + $adde= + ' ' + .$adde; + } + } + } + if ($indent) { + my $is="  "; + for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; } + } + if (!$linkid) { $linkid=$rid; } + if ($hash{'randomout_'.$rid}) { + $adde=' (hidden)'.$adde; + } + $r->print($add.$indentstr); + if ($rid) { + $r->print(''. - $hwk.$hash{'title_'.$rid}.$hwke.''); - } - $r->print($adde); - } - $r->print(''); - } - } - $r->print("\n
'; - my $adde=''; - $adde=''; - } - if ($code eq '3') { - $add=''; - } elsif ($code eq '4') { - $add=''; - } else { - $add=''; - if ($tcode eq '2') { - $add=''; - } - if ($tcode eq '4') { - $add=''; - $adde='
'; + my $adde=''; + $adde=''; + } + + # solved/correct + if ($code eq '3') { + $add=''; + } elsif ($code eq '4') { # partially correct + $add=''; + } else { + # not attempted + + # we end up here on network failure, so pick a neutral + # color if the network failed instead of bright red. + if ( $networkFailedFlag ) + { + $add = ''; + } + else + { + $add=''; + } + + if ($tcode eq '2') { # open, not past due + $add=''; + } + + if ($tcode eq '4') { # due in next 24 hours + $add=''; + $adde='
"); - $r->print(''); + $hwk.$hash{'title_'.$rid}.$hwke.''); + } + $r->print($adde); + } + $r->print(''); + } + } + $r->print("\n"); + $r->print(''); # -------------------------------------------------------------------- End page - } + } # ------------------------------------------------------------- End render page } # ------------------------------------------------------------------ Untie hash unless (untie(%hash)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie coursemap $fn (browse)."); + &Apache::lonnet::logthis("WARNING: ". + "Could not untie coursemap $fn (browse)."); } unless (untie(%parmhash)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie parmhash (browse)."); + &Apache::lonnet::logthis("WARNING: ". + "Could not untie parmhash (browse)."); + } + return OK; +} + +sub new_handle { + my $r = shift; + + # Handle header-only request + if ($r->header_only) { + if ($ENV{'browser.mathml'}) { + $r->content_type('text/xml'); + } else { + $r->content_type('text/html'); + } + $r->send_http_header; + return OK; + } + + # Send header, don't cache this page + if ($ENV{'browser.mathml'}) { + $r->content_type('text/xml'); + } else { + $r->content_type('text/html'); + } + &Apache::loncommon::no_cache($r); + $r->send_http_header; + + # Header + $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', + '')); + # Initialize the nav map + my $navmap = Apache::lonnavmaps::navmap->new( + $ENV{"request.course.fn"}.".db", + $ENV{"request.course.fn"}."_parms.db", 1); + + # Grab a resource object so we have access to the constants; this + # is technically not proper, but should be harmless + my $res = $navmap->firstResource(); + + # Defines a status->color mapping, null string means don't color + my %colormap = + ( $res->NETWORK_FAILURE => '', + $res->CORRECT => '#BBFFBB', + $res->EXCUSED => '#BBBBFF', + $res->PAST_DUE => '#FFAA00', + $res->ANSWER_OPEN => '#FF00AA', + $res->OPEN_LATER => '', + $res->TRIES_LEFT => '#FFFF00', + $res->INCORRECT => '#FFAA00', + $res->OPEN => '#FFFF88' ); + + if (!defined($navmap)) { + my $requrl = $r->uri; + $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; + return HTTP_NOT_ACCEPTABLE; + } + + my %filterHash; + # Figure out what we're not displaying + foreach (split(/\,/, $ENV{"form.filter"})) { + if ($_) { + $filterHash{$_} = "1"; + } + } + + # Begin the HTML table + # two columns: the title/icon on the left, the info on the right + $r->print('' ."\n"); + + my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash); + my $curRes = $mapIterator->next(); + my $indentLevel = -1; + my $indentString = "        "; + + my $isNewBranch = 0; + + while ($curRes != $mapIterator->END_NAV_MAP) { + if ($curRes == $mapIterator->BEGIN_MAP() || + $curRes == $mapIterator->BEGIN_BRANCH()) { + $indentLevel++; + } + if ($curRes == $mapIterator->END_MAP() || + $curRes == $mapIterator->END_BRANCH()) { + $indentLevel--; + } + + if ($curRes == $mapIterator->BEGIN_BRANCH()) { + $r->print("Begin branch
"); + } + if ($curRes == $mapIterator->END_BRANCH()) { + $r->print("End branch
"); + } + + if (ref($curRes) && $curRes->src()) { + + my @parts; + if ($curRes->is_problem()) { + @parts = @{$curRes->parts()}; + if (scalar(@parts) > 1) { shift(@parts); } + } else { + @parts[0] = "0"; # this is to get past foreach loop below + # you can consider a non-problem resource as a resource + # with only one part without loss + } + + foreach my $part (@parts) { + + # For each thing we're displaying... + + my $stack = $mapIterator->getStack(); + my $src = getLinkForResource($stack); + + my $srcHasQuestion = $src =~ /\?/; + my $link = $src. + ($srcHasQuestion?'&':'?') . + 'symb='.&Apache::lonnet::escape($curRes->symb()). + '"'; + my $title = $curRes->title(); + my $partLabel = ""; + + # links to open and close the folders + my $linkopen = ""; + my $linkclose = ""; + + my $icon = "html.gif"; + if ($curRes->is_problem()) { + $icon = "problem.gif"; + } + + # Display the correct icon, link to open or shut map + if ($curRes->is_map()) { + my $mapId = $curRes->map_pc(); + my $nowOpen = !defined($filterHash{$mapId}); + $icon = $nowOpen ? + "folder_opened.gif" : "folder_closed.gif"; + $linkopen = ""; + $linkclose = ""; + + } + + my $colorizer = ""; + if ($curRes->is_problem()) { + my $status = $curRes->status($part); + my $color = $colormap{$status}; + if ($color ne "") { + $colorizer = "bgcolor=\"$color\""; + } + } + + $r->print(" ". + "
\n"); + + # print indentation + for (my $i = 0; $i < $indentLevel; $i++) { + $r->print($indentString); + } + + $r->print(" ${linkopen}\"\"${linkclose}\n"); + + if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; } + + $r->print(" $title$partLabel\n"); + + if ($curRes->kind() eq "res" and + $curRes->is_problem() ) { + $r->print (" Due: " . localtime($curRes->duedate())); + } + } + } + $curRes = $mapIterator->next(); } + + $r->print("
"); + return OK; } +# Convenience functions: Returns a string that adds or subtracts +# the second argument from the first hash, appropriate for the +# query string that determines which folders to recurse on +sub addToFilter { + my $hashIn = shift; + my $addition = shift; + my %hash = %$hashIn; + $hash{$addition} = 1; + + return join (",", keys(%hash)); +} + +sub removeFromFilter { + my $hashIn = shift; + my $subtraction = shift; + my %hash = %$hashIn; + + delete $hash{$subtraction}; + return join(",", keys(%hash)); +} + +# Convenience function: Given a stack returned from getStack on the iterator, +# return the correct src() value. +# Later, this should add an anchor when we start putting anchors in pages. +sub getLinkForResource { + my $stack = shift; + my $res; + + # Check to see if there are any pages in the stack + foreach $res (@$stack) { + if (defined($res) && $res->is_page()) { + return $res->src(); + } + } + + # Failing that, return the src of the last resource that is defined + # (when we first recurse on a map, it puts an undefined resource + # on the bottom because $self->{HERE} isn't defined yet, and we + # want the src for the map anyhow) + foreach (@$stack) { + if (defined($_)) { $res = $_; } + } + + return $res->src(); +} + 1; -__END__ +package Apache::lonnavmaps::navmap; + +# LEFT: +# * Actual handler code (multi-part) +# * Branches (aieee!) (and conditionals) + +=pod + +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. + +=head1 navmap object: Encapsulating the compiled nav map + +navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it. + +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. + +You must obtain resource objects through the navmap object. + +=head2 Methods + +=over 4 + +=item * B(filename, parmHashFile, genCourseAndUserOptions): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. Returns the navmap object if this is successful, or B if not. You must check for undef; errors will occur when you try to use the other methods otherwise. + +=item * B(first, finish, filter, condition): See iterator documentation below. + +=cut + +use strict; +use GDBM_File; + +sub new { + # magic invocation to create a class instance + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + + $self->{NAV_HASH_FILE} = shift; + $self->{PARM_HASH_FILE} = shift; + $self->{GENERATE_COURSE_USER_OPT} = shift; + + # Resource cache stores navmapresource's as we reference them. We generate + # them on-demand so we don't pay for creating resources unless we use them. + $self->{RESOURCE_CACHE} = {}; + + # Network failure flag, if we accessed the course or user opt and + # failed + $self->{NETWORK_FAILURE} = 0; + + # tie the nav hash + my %navmaphash; + if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, + &GDBM_READER(), 0640))) { + return undef; + } + $self->{NAV_HASH} = \%navmaphash; + + my %parmhash; + if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, + &GDBM_READER(), 0640))) + { + return undef; + } + $self->{PARM_HASH} = \%parmhash; + $self->{HASH_TIED} = 1; + + # If the course opt hash and the user opt hash should be generated, + # generate them + if ($self->{GENERATE_COURSE_USER_OPT}) { + my $uname=$ENV{'user.name'}; + my $udom=$ENV{'user.domain'}; + my $uhome=$ENV{'user.home'}; + my $cid=$ENV{'request.course.id'}; + my $chome=$ENV{'course.'.$cid.'.home'}; + my ($cdom,$cnum)=split(/\_/,$cid); + + my $userprefix=$uname.'_'.$udom.'_'; + + my %courserdatas; my %useropt; my %courseopt; + unless ($uhome eq 'no_host') { +# ------------------------------------------------- Get coursedata (if present) + unless ((time-$courserdatas{$cid.'.last_cache'})<240) { + my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum. + ':resourcedata',$chome); + if ($reply!~/^error\:/) { + $courserdatas{$cid}=$reply; + $courserdatas{$cid.'.last_cache'}=time; + } + # check to see if network failed + elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) + { + $self->{NETWORK_FAILURE} = 1; + } + } + foreach (split(/\&/,$courserdatas{$cid})) { + my ($name,$value)=split(/\=/,$_); + $courseopt{$userprefix.&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } +# --------------------------------------------------- Get userdata (if present) + unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) { + my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); + if ($reply!~/^error\:/) { + $userrdatas{$uname.'___'.$udom}=$reply; + $userrdatas{$uname.'___'.$udom.'.last_cache'}=time; + } + # check to see if network failed + elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) + { + $self->{NETWORK_FAILURE} = 1; + } + } + foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) { + my ($name,$value)=split(/\=/,$_); + $useropt{$userprefix.&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } + $self->{COURSE_OPT} = \%courseopt; + $self->{USER_OPT} = \%useropt; + } + } + + bless($self); + + return $self; +} + +sub getIterator { + my $self = shift; + my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, + shift, shift); + return $iterator; +} + +# unties the hash when done +sub untieHashes { + my $self = shift; + untie $self->{NAV_HASH} if ($self->{HASH_TIED}); + untie $self->{PARM_HASH} if ($self->{HASH_TIED}); + $self->{HASH_TIED} = 0; +} + +# when the object is destroyed, be sure to untie all the hashes we tied. +sub DESTROY { + my $self = shift; + $self->untieHashes(); +} + +=pod + +=item * B(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. + +=cut + +# The strategy here is to cache the resource objects, and only construct them +# as we use them. The real point is to prevent reading any more from the tied +# hash then we have to, which should hopefully alleviate speed problems. +# Caching is just an incidental detail I throw in because it makes sense. + +sub getById { + my $self = shift; + my $id = shift; + + if (defined ($self->{RESOURCE_CACHE}->{$id})) + { + return $self->{RESOURCE_CACHE}->{$id}; + } + + # resource handles inserting itself into cache. + return Apache::lonnavmaps::resource->new($self, $id); +} + +=pod + +=item * B(): Returns a resource object reference corresponding to the first resource in the navmap. + +=cut + +sub firstResource { + my $self = shift; + my $firstResource = $self->{NAV_HASH}->{'map_start_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + return $self->getById($firstResource); +} + +=pod + +=item * B(): Returns a resource object reference corresponding to the last resource in the navmap. + +=cut + +sub finishResource { + my $self = shift; + my $firstResource = $self->{NAV_HASH}->{'map_finish_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + return $self->getById($firstResource); +} + +# -------------------------------------------- Figure out a cascading parameter +# +# For this function to work +# +# * parmhash needs to be tied +# * courseopt and useropt need to be initialized for this user and course +# + +sub parmval { + my $self = shift; + my ($what,$symb)=@_; + my $cid=$ENV{'request.course.id'}; + my $csec=$ENV{'request.course.sec'}; + my $uname=$ENV{'user.name'}; + my $udom=$ENV{'user.domain'}; + + unless ($symb) { return ''; } + my $result=''; + + my ($mapname,$id,$fn)=split(/\_\_\_/,$symb); + +# ----------------------------------------------------- Cascading lookup scheme + my $rwhat=$what; + $what=~s/^parameter\_//; + $what=~s/\_/\./; + + my $symbparm=$symb.'.'.$what; + my $mapparm=$mapname.'___(all).'.$what; + my $usercourseprefix=$uname.'_'.$udom.'_'.$cid; + + my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what; + my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm; + my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm; + + my $courselevel= $usercourseprefix.'.'.$what; + my $courselevelr=$usercourseprefix.'.'.$symbparm; + my $courselevelm=$usercourseprefix.'.'.$mapparm; + + my $useropt = $self->{USER_OPT}; + my $courseopt = $self->{COURSE_OPT}; + my $parmhash = $self->{PARM_HASH}; + +# ---------------------------------------------------------- first, check user + if ($uname and defined($useropt)) { + if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; } + if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; } + if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; } + } + +# ------------------------------------------------------- second, check course + if ($csec and defined($courseopt)) { + if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; } + if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; } + if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; } + } + + if (defined($courseopt)) { + if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; } + if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; } + if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; } + } + +# ----------------------------------------------------- third, check map parms + + my $thisparm=$$parmhash{$symbparm}; + if ($thisparm) { return $thisparm; } + +# ----------------------------------------------------- fourth , check default + + my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); + if ($default) { return $default} + +# --------------------------------------------------- fifth , cascade up parts + + my ($space,@qualifier)=split(/\./,$rwhat); + my $qualifier=join('.',@qualifier); + unless ($space eq '0') { + my ($part,$id)=split(/\_/,$space); + if ($id) { + my $partgeneral=$self->parmval($part.".$qualifier",$symb); + if ($partgeneral) { return $partgeneral; } + } else { + my $resourcegeneral=$self->parmval("0.$qualifier",$symb); + if ($resourcegeneral) { return $resourcegeneral; } + } + } + return ''; +} + + +1; + +package Apache::lonnavmaps::iterator; + +# This package must precede "navmap" because "navmap" uses it. In +# order to keep the documentation order straight, the iterator is documented +# after the navmap object. + +=pod + +=back + +=head1 navmap Iterator + +An I 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. + +To obtain an iterator, call the B() function of a B object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator: + +CgetIterator();> + +To get the next thing from the iterator, call B: + +Cnext()> + +getIterator behaves as follows: + +=over 4 + +=item B(nav_map, firstResource, finishResource, filterHash): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). It is your responsibility to ensure that the iterator will actually get there. filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0. + +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. + +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: + +=over 4 + +=item * some list of tokens here + +=back + +The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants. + +=cut + +# Here are the tokens for the iterator: + +sub END_NAV_MAP { return 0; } # Represents end of entire nav map +sub BEGIN_MAP { return 1; } # begining of a new map +sub END_MAP { return 2; } # end of the map +sub BEGIN_BRANCH { return 3; } # beginning of a branch +sub END_BRANCH { return 4; } # end of a branch + +# Params: nav map, start resource, end resource, filter, condition, +# already seen hash ref + +sub new { + # magic invocation to create a class instance + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + + $self->{NAV_MAP} = shift; + return undef unless ($self->{NAV_MAP}); + + # Handle the parameters + $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); + $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); + + # If the given resources are just the ID of the resource, get the + # objects + if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} = + $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); } + if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} = + $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); } + + $self->{FILTER} = shift; + + # A hash, used as a set, of resource already seen + $self->{ALREADY_SEEN} = shift; + if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; + + # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP. + $self->{STARTED} = 0; + + # Should we continue calling the recursive iterator, if any? + $self->{RECURSIVE_ITERATOR_FLAG} = 0; + # The recursive iterator, if any + $self->{RECURSIVE_ITERATOR} = undef; + # Are we recursing on a map, or a branch? + $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches + # And the count of how deep it is, so that this iterator can keep track of + # when to pick back up again. + $self->{RECURSIVE_DEPTH} = 0; + + # For keeping track of our branches, we maintain our own stack + $self->{BRANCH_STACK} = []; + # If the size shrinks, we exhausted a branch + $self->{BRANCH_STACK_SIZE} = 0; + $self->{BRANCH_DEPTH} = 0; + + # For returning two things in a forced sequence + $self->{FORCE_NEXT} = undef; + + # Start with the first resource + push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE}; + $self->{BRANCH_STACK_SIZE} = 1; + + bless($self); + return $self; +} + +# Note... this function is *touchy*. I strongly recommend tracing +# through it with the debugger a few times on a non-trivial map before +# modifying it. Order is *everything*. +sub next { + my $self = shift; + + # Iterator logic goes here + + # Is this return value pre-determined? + if (defined($self->{FORCE_NEXT})) { + my $tmp = $self->{FORCE_NEXT}; + $self->{FORCE_NEXT} = undef; + return $tmp; + } + + # Are we using a recursive iterator? If so, pull from that and + # watch the depth; we want to resume our level at the correct time. + if ($self->{RECURSIVE_ITERATOR_FLAG}) + { + # grab the next from the recursive iterator + my $next = $self->{RECURSIVE_ITERATOR}->next(); + + # is it a begin or end map? Update depth if so + if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; } + if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; } + + # Are we back at depth 0? If so, stop recursing. + if ($self->{RECURSIVE_DEPTH} == 0) { + $self->{RECURSIVE_ITERATOR_FLAG} = 0; + } + + return $next; + } + + # Is there a current resource to grab? If not, then return + # END_BRANCH and END_MAP in succession. + if (scalar(@{$self->{BRANCH_STACK}}) == 0) { + if ($self->{BRANCH_DEPTH} > 0) { + $self->{FORCE_NEXT} = $self->END_MAP(); + $self->{BRANCH_DEPTH}--; + return $self->END_BRANCH(); + } else { + return $self->END_MAP(); + } + } + + # Have we not yet begun? If not, return BEGIN_MAP and + # remember that we've started. + if ( !$self->{STARTED} ) { + $self->{STARTED} = 1; + return $self->BEGIN_MAP; + } + + # Did the branch stack shrink since last run? If so, + # we exhausted a branch last time, therefore, we're about + # to start a new one. (We know because we already checked to see + # if the stack was empty.) + if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) { + $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}}); + $self->{BRANCH_DEPTH}++; + return $self->BEGIN_BRANCH(); + } + + # Get the next resource in the branch + $self->{HERE} = pop @{$self->{BRANCH_STACK}}; + # We always return it after this point and never before + # (proof: look at just the return statements), so we + # remember that we've seen this. + $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1; + + # Are we at the utter end? If so, return the END_NAV_MAP marker. + if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) { + $self->{FORCE_NEXT} = $self->END_NAV_MAP; + return $self->{HERE}; + } + + # Remember the size for comparision next time. + $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}}); + + # Get the next possible resources + my $nextUnfiltered = $self->{HERE}->getNext(); + my $next = []; + + # filter the next possibilities to remove things we've + # already seen + foreach (@$nextUnfiltered) { + if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { + push @$next, $_; + } + } + + # Handle branch cases: + # Nothing is available next: BRANCH_END + # 1 thing next: standard non-branch + # 2+ things next: have some branches + my $nextCount = scalar(@$next); + if ($nextCount == 0) { + # Return this and on the next run, close the branch up if we're + # in a branch + if ($self->{BRANCH_DEPTH} > 0 ) { + $self->{FORCE_NEXT} = $self->END_BRANCH(); + $self->{BRANCH_DEPTH}--; + } + return $self->{HERE}; + } + + while (@$next) { + # copy the next possibilities over to the branch stack + # in the right order + push @{$self->{BRANCH_STACK}}, shift @$next; + } + + if ($nextCount >= 2) { + $self->{FORCE_NEXT} = $self->BEGIN_BRANCH(); + $self->{BRANCH_DEPTH}++; + return $self->{HERE}; + } + + # If this is a map and we want to recurse down it... (not filtered out) + if ($self->{HERE}->is_map() && + !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) { + $self->{RECURSIVE_ITERATOR_FLAG} = 1; + my $firstResource = $self->{HERE}->map_start(); + my $finishResource = $self->{HERE}->map_finish(); + + # Odd perl syntax here; $self->new allows one to create a new iterator + # can't figure out how to ref this package directly correctly + # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new + $self->{RECURSIVE_ITERATOR} = + Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, + $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN}); + # prime the new iterator with the first resource + #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource; + } + + return $self->{HERE}; +} + +=pod + +The other method available on the iterator is B, 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). + +=cut + +sub getStack { + my $self=shift; + + my @stack; + + $self->populateStack(\@stack); + + return \@stack; +} + +# Private method: Calls the iterators recursively to populate the stack. +sub populateStack { + my $self=shift; + my $stack = shift; + + push @$stack, $self->{HERE}; + + if ($self->{RECURSIVE_ITERATOR_FLAG}) { + $self->{RECURSIVE_ITERATOR}->populateStack($stack); + } +} + +1; + +package Apache::lonnavmaps::resource; + +use Apache::lonnet; + +=pod + +=head1 Object: resource + +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. + +A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. + +You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource. + +=head2 Public Members + +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. + +=head2 Methods + +=over 4 + +=item * B($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. + +=cut + +sub new { + # magic invocation to create a class instance + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + + $self->{NAV_MAP} = shift; + $self->{ID} = shift; + + # Store this new resource in the parent nav map's cache. + $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; + + # A hash that can be used by two-pass algorithms to store data + # about this resource in. Not used by the resource object + # directly. + $self->{DATA} = {}; + + bless($self); + + return $self; +} + +=pod + +=item * B: Returns true if this is a map, false otherwise. + +=item * B: Returns title. + +=item * B<type>: Returns the type of the resource, "start", "normal", or "finish". + +=item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.) + +=back + +=cut + +# private function: simplify the NAV_HASH lookups we keep doing +# pass the name, and to automatically append my ID, pass a true val on the +# second param +sub navHash { + my $self = shift; + my $param = shift; + my $id = shift; + return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; +} + +# These info functions can be used directly, as they don't return +# resource information. +sub title { my $self=shift; return $self->navHash("title_", 1); } +sub type { my $self=shift; return $self->navHash("type_", 1); } +sub goesto { my $self=shift; return $self->navHash("goesto_", 1); } +# "to" can return a comma seperated list for branches +sub to { my $self=shift; return $self->navHash("to_", 1); } +sub kind { my $self=shift; return $self->navHash("kind_", 1); } +sub src { + my $self=shift; + return $self->navHash("src_", 1); +} +sub symb { + my $self=shift; + (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/; + my $symbSrc = &Apache::lonnet::declutter($self->src()); + return &Apache::lonnet::declutter( + $self->navHash('map_id_'.$first)) + . '___' . $second . '___' . $symbSrc; +} +sub is_problem { + my $self=shift; + my $src = $self->src(); + return ($src =~ /problem$/); +} +sub is_html { + my $self=shift; + my $src = $self->src(); + return ($src =~ /html$/); +} +sub is_sequence { + my $self=shift; + my $src = $self->src(); + return ($src =~ /sequence$/); +} +sub is_page { + my $self=shift; + my $src = $self->src(); + return ($src =~ /page$/); +} + + + + +# Move this into POD: In order to use these correctly, courseopt +# and useropt need to be generated +sub parmval { + my $self = shift; + my $what = shift; + my $part = shift || "0"; + return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb()); +} + +##### +# Map Queries +##### + +# These methods relate to whether or not the resource is a map, and the +# attributes of that map. + +sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); } +sub map_finish { + my $self = shift; + my $src = $self->src(); + my $res = $self->navHash("map_finish_$src", 0); + $res = $self->{NAV_MAP}->getById($res); + return $res; +} +sub map_start { + my $self = shift; + my $src = $self->src(); + my $res = $self->navHash("map_start_$src", 0); + $res = $self->{NAV_MAP}->getById($res); + return $res; +} +sub map_pc { + my $self = shift; + my $src = $self->src(); + return $self->navHash("map_pc_$src", 0); +} +sub map_type { + my $self = shift; + my $pc = $self->map_pc(); + return $self->navHash("map_type_$pc", 0); +} + + + +##### +# Property queries +##### + +# These functions will be responsible for returning the CORRECT +# VALUE for the parameter, no matter what. So while they may look +# like direct calls to parmval, they can be more then that. +# So, for instance, the duedate function should use the "duedatetype" +# information, rather then the resource object user. + +=pod + +=head2 Resource Parameters + +In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter. + +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.) + +=over 4 + +=item * B<acc>: Get the Client IP/Name Access Control information. + +=item * B<answerdate>: Get the answer-reveal date for the problem. + +=item * B<duedate>: Get the due date for the problem. + +=item * B<tries>: Get the number of tries the student has used on the problem. + +=item * B<maxtries>: Get the number of max tries allowed. + +=item * B<opendate>: Get the open date for the problem. + +=item * B<sig>: Get the significant figures setting. + +=item * B<tol>: Get the tolerance for the problem. + +=item * B<type>: Get the question type for the problem. + +=item * B<weight>: Get the weight for the problem. + +=back + +=cut + +sub acc { + (my $self, my $part) = @_; + return $self->parmval("acc", $part); +} +sub answerdate { + (my $self, my $part) = @_; + # Handle intervals + if ($self->parmval("answerdate.type", $part) eq 'date_interval') { + return $self->duedate($part) + + $self->parmval("answerdate", $part); + } + return $self->parmval("answerdate", $part); +} +sub duedate { + (my $self, my $part) = @_; + return $self->parmval("duedate", $part); +} +sub maxtries { + (my $self, my $part) = @_; + return $self->parmval("maxtries", $part); +} +sub opendate { + (my $self, my $part) = @_; + if ($self->parmval("opendate.type", $part) eq 'date_interval') { + return $self->duedate($part) - + $self->parmval("opendate", $part); + } + return $self->parmval("opendate"); +} +sub sig { + (my $self, my $part) = @_; + return $self->parmval("sig", $part); +} +sub tol { + (my $self, my $part) = @_; + return $self->parmval("tol", $part); +} +sub type { + (my $self, my $part) = @_; + return $self->parmval("type", $part); +} +sub weight { + (my $self, my $part) = @_; + return $self->parmval("weight", $part); +} +sub tries { + my $self = shift; + my $part = shift; + $part = '0' if (!defined($part)); + + # Make sure return hash is loaded, should error check + $self->getReturnHash(); + + my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'}; + if (!defined($tries)) {return '0';} + return $tries; +} + +# Multiple things need this +sub getReturnHash { + my $self = shift; + + if (!defined($self->{RETURN_HASH})) { + my %tmpHash = &Apache::lonnet::restore($self->symb()); + $self->{RETURN_HASH} = \%tmpHash; + } +} + +###### +# Status queries +###### + +# These methods query the status of problems. + +# If we need to count parts, this function determines the number of +# parts from the metadata. When called, it returns a reference to a list +# of strings corresponding to the parts. (Thus, using it in a scalar context +# tells you how many parts you have in the problem: +# $partcount = scalar($resource->countParts()); +# Don't use $self->{PARTS} directly because you don't know if it's been +# computed yet. + +=pod + +=head2 Resource misc + +Misc. functions for the resource. + +=over 4 + +=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.) + +=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. + +=back + +=cut + +sub parts { + my $self = shift; + + $self->extractParts(); + return $self->{PARTS}; +} + +sub countParts { + my $self = shift; + + my $parts = $self->parts(); + + if (scalar(@{$parts}) == 1) { return 1;} + + return scalar(@{$parts}) - 1; +} + +# Private function: Extracts the parts information and saves it +sub extractParts { + my $self = shift; + + return if ($self->{PARTS}); + + $self->{PARTS} = []; + + # Retrieve part count + foreach (split(/\,/,&Apache::lonnet::metadata($self->src(), + 'allpossiblekeys'))) { + if ($_ =~ /^parameter\_(.*)\_opendate$/) { + push @{$self->{PARTS}}, $1; + } + } + + # Is this possible to do in one line? - Jeremy + my @sortedParts = sort @{$self->{PARTS}}; + $self->{PARTS} = \@sortedParts; + + return; +} + +=pod + +=head2 Resource Status + +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. + +There are two aspects to the status: the date-related information and the completion information. + +Idiomatic usage of these two methods would probably look something like + + foreach ($resource->parts()) { + my $dateStatus = $resource->getDateStatus($_); + my $completionStatus = $resource->getCompletionStatus($_); + + ... use it here ... + } + +=over 4 + +=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part, with the following possible results: + +=back + +B<Date Codes> + +=over 4 + +=item * B<OPEN_LATER>: The problem will be opened later. + +=item * B<OPEN>: Open and not yet due. + +=item * B<PAST_DUE>: The due date has passed, but the answer date has not yet arrived. + +=item * B<ANSWER_OPEN>: The answer date is here. + +=item * B<NETWORK_FAILURE>: The information is unknown due to network failure. + +=back + +=cut + +# Apparently the compiler optimizes these into constants automatically +sub OPEN_LATER { return 0; } +sub OPEN { return 1; } +sub PAST_DUE { return 2; } +sub ANSWER_OPEN { return 3; } +sub NETWORK_FAILURE { return 100; } + +sub getDateStatus { + my $self = shift; + my $part = shift; + $part = "0" if (!defined($part)); + return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); + + my $now = time(); + + my $o = $now - $self->opendate($part); + my $d = $now - $self->duedate($part); + my $a = $now - $self->answerdate($part); + + if ($o < 0) {return $self->OPEN_LATER}; + if ($d < 0) {return $self->OPEN}; + if ($a < 0) {return $self->PAST_DUE}; + return $self->ANSWER_OPEN; +} + +=pod + +B<> + +=over 4 + +=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: + +=back + +B<Completion Codes> + +=over 4 + +=item * B<NOT_ATTEMPTED>: Has not been attempted at all. +=item * B<INCORRECT>: Attempted, but wrong by student. +=item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override. +=item * B<CORRECT>: Correct or correct by instructor. +=item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override. + +=item * B<EXCUSED>: Excused. Not yet implemented. + +=item * B<NETWORK_FAILURE>: Information not available due to network failure. + +=back + +=cut + +sub NOT_ATTEMPTED { return 0; } +sub INCORRECT { return 1; } +sub INCORRECT_BY_OVERRIDE { return 2; } +sub CORRECT { return 3; } +sub CORRECT_BY_OVERRIDE { return 4; } +sub EXCUSED { return 5; } + +sub getCompletionStatus { + my $self = shift; + my $part = shift; + $part = "0" if (!defined($part)); + return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); + + # Make sure return hash exists + $self->getReturnHash(); + + my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'}; + + # Left as seperate if statements in case we ever do more with this + if ($status eq 'correct_by_student') {return $self->CORRECT;} + if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; } + if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } + if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } + if ($status eq 'excused') {return $self->EXCUSED; } + return $self->NOT_ATTEMPTED; +} + +=pod + +B<Composite Status> + +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()): + +=over 4 + +=item * NETWORK_FAILURE: The network has failed and the information is not available. + +=item * CORRECT: For any reason at all, the part is considered correct. + +=item * EXCUSED: For any reason at all, the problem is excused. + +=item * PAST_DUE: The problem is past due, and not considered correct. + +=item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available. + +=item * OPEN_LATER: The problem is not yet open. + +=item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left. + +=item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer. + +=item * OPEN: The item is open and not yet tried. + +=back + +=cut + +sub TRIES_LEFT { return 10; } + +sub status { + my $self = shift; + my $part = shift; + if (!defined($part)) { $part = "0"; } + my $completionStatus = $self->getCompletionStatus($part); + my $dateStatus = $self->getDateStatus($part); + + # What we have is a two-dimensional matrix with 4 entries on one + # dimension and 5 entries on the other, which we want to colorize, + # plus network failure. + + # Don't colorize on network failure. + if ($completionStatus == NETWORK_FAILURE()) { return $self->NETWORK_FAILURE(); } + + # There are a few whole rows we can dispose of: + # If the problem is CORRECT, color it green no matter what + if ($completionStatus == CORRECT() || + $completionStatus == CORRECT_BY_OVERRIDE() ) { + return $self->CORRECT(); # Return a nice green. + } + + # If it's EXCUSED, then return something no matter what + if ($completionStatus == EXCUSED()) { + return $self->EXCUSED(); # return a nice blue + } + + # Now we're down to a 3 (incorrect, incorrect_override, not_attempted) + # by 4 matrix (date status). + + # If it's Past Due and we didn't bail earlier because it's correct, + # color it orange. (Red is sort inappropriate; too drastic a color + # for something the student can't fix. + if ($dateStatus == PAST_DUE()) { + return $self->PAST_DUE(); # return orange + } + + if ($dateStatus == ANSWER_OPEN()) { + return $self->ANSWER_OPEN(); + } + + # Now: (incorrect, incorrect_override, not_attempted) x + # (open_later), (open) + + # If it's open later, then don't colorize + if ($dateStatus == OPEN_LATER()) { + return $self->OPEN_LATER(); + } + + # If it's WRONG... + if ($completionStatus == INCORRECT() || $completionStatus == INCORRECT_BY_OVERRIDE()) { + # and there are TRIES LEFT: + if ($self->tries() < $self->maxtries()) { + return $self->TRIES_LEFT(); # return red: The student can fix this + } + return $self->INCORRECT(); # otherwise, return orange; student can't fix this + } + + # Otherwise, it's untried and open + return $self->OPEN(); # Light yellow +} + +=pod + +=head2 Resource/Nav Map Navigation + +=over 4 + +=item * B<getNext>(): Gets the next resource in the navmap after this one. + +=cut + +# For the simple single-link case, to get from a resource to the next +# resource, you need to look up the "to_" link in the nav hash, then +# follow that with the "goesto_" link. + +sub getNext { + my $self = shift; + my $alreadySeenHash = shift; + my @branches; + my $to = $self->to(); + foreach my $branch ( split(/\,/, $to) ) { + my $choice = $self->{NAV_MAP}->getById($branch); + my $next = $choice->goesto(); + $next = $self->{NAV_MAP}->getById($next); + + # Don't remember it if we've already seen it + if (!defined($alreadySeenHash) || + !defined($alreadySeenHash->{$next->{ID}})) { + push @branches, $next; + } + } + return \@branches; +} + +=pod + +=back + +=cut + +1; + +__END__