|
version 1.53, 2002/09/24 03:48:18
|
version 1.114, 2002/11/18 21:12:39
|
|
Line 1
|
Line 1
|
| |
|
| # The LearningOnline Network with CAPA |
# The LearningOnline Network with CAPA |
| # Navigate Maps Handler |
# Navigate Maps Handler |
| # |
# |
|
Line 36
|
Line 37
|
| # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer |
# 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer |
| # YEAR=2002 |
# YEAR=2002 |
| # 1/1 Gerd Kortemeyer |
# 1/1 Gerd Kortemeyer |
| # |
# Oct-Nov Jeremy Bowers |
| |
|
| package Apache::lonnavmaps; |
package Apache::lonnavmaps; |
| |
|
| use strict; |
use strict; |
| use Apache::Constants qw(:common :http); |
use Apache::Constants qw(:common :http); |
| use Apache::lonnet(); |
|
| use Apache::loncommon(); |
use Apache::loncommon(); |
| use HTML::TokeParser; |
use POSIX qw (floor strftime); |
| use GDBM_File; |
|
| |
|
| # -------------------------------------------------------------- Module Globals |
|
| my %hash; |
|
| my @rows; |
|
| |
|
| # |
|
| # These cache hashes need to be independent of user, resource and course |
|
| # (user and course can/should be in the keys) |
|
| # |
|
| |
|
| my %courserdatas; |
|
| my %userrdatas; |
|
| |
|
| # |
|
| # These global hashes are dependent on user, course and resource, |
|
| # and need to be initialized every time when a sheet is calculated |
|
| # |
|
| 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 { |
|
| my ($e,$f)=@_; |
|
| 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; |
|
| $r=$a%$b; |
|
| } |
|
| return $b; |
|
| } |
|
| |
|
| # --------------------------------------------------------------------- Parmval |
|
| |
|
| # -------------------------------------------- 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 ($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; |
|
| |
|
| # ---------------------------------------------------------- first, check user |
|
| if ($uname) { |
|
| 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{$seclevelm}) { return $courseopt{$seclevelm}; } |
|
| if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; } |
|
| } |
|
| |
|
| 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=&parmval($part.".$qualifier",$symb); |
|
| if ($partgeneral) { return $partgeneral; } |
|
| } else { |
|
| my $resourcegeneral=&parmval("0.$qualifier",$symb); |
|
| if ($resourcegeneral) { return $resourcegeneral; } |
|
| } |
|
| } |
|
| return ''; |
|
| } |
|
| |
|
| |
|
| |
|
| # ------------------------------------------------------------- Find out status |
|
| # return codes |
|
| # tcode (timecode) |
|
| # 1: will open later |
|
| # 2: is open and not past due yet |
|
| # 3: is past due date |
|
| # 4: due in the next 24 hours |
|
| # |
|
| # code (curent solved status) |
|
| # 1: not attempted |
|
| # 2: attempted but wrong, or incorrect by instructor |
|
| # 3: solved or correct by instructor |
|
| # 4: partially correct (one or more parts correct) |
|
| # "excused" needs to be supported, but is not yet. |
|
| sub astatus { |
|
| my $rid=shift; |
|
| my $code=0; |
|
| my $ctext=''; |
|
| $rid=~/(\d+)\.(\d+)/; |
|
| my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'. |
|
| &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},'allpo\ssiblekeys')))) { |
|
| if ($_=~/^parameter\_(.*)\_opendate$/) { |
|
| 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; |
|
| my $tcode=0; |
|
| |
|
| 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; } |
|
| } |
|
| } |
|
| |
|
| return 'p'.$code.$tcode.'"'.$ctext.'"'; |
|
| } |
|
| |
|
| |
|
| sub addresource { |
|
| my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_; |
|
| if ($showtypes eq 'problems') { |
|
| 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; |
|
| } |
|
| } |
|
| } |
|
| } |
|
| |
|
| sub followlinks () { |
|
| my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_; |
|
| 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 $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++; |
|
| } |
|
| return $further; |
|
| } |
|
| # ------------------------------------------------------------ Build page table |
|
| |
|
| sub tracetable { |
|
| my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_; |
|
| my $newshowtypes=$showtypes; |
|
| my $further=$sofar; |
|
| # $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=''; } |
|
| } |
|
| } else { |
|
| &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes, |
|
| $indent,$linkid); |
|
| } |
|
| |
|
| if (defined($hash{'to_'.$rid})) { |
|
| $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes, |
|
| $indent,$linkid); |
|
| } |
|
| |
|
| return $further; |
|
| } |
|
| |
|
| # ================================================================ Main Handler |
|
| |
|
| sub handler { |
sub handler { |
| my $r=shift; |
my $r = shift; |
| |
|
| &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
| |
|
| if ($ENV{'form.jtest'} ne "1") |
# Handle header-only request |
| { |
|
| return new_handle($r); |
|
| } |
|
| |
|
| # ------------------------------------------- Set document type for header only |
|
| |
|
| if ($r->header_only) { |
if ($r->header_only) { |
| if ($ENV{'browser.mathml'}) { |
if ($ENV{'browser.mathml'}) { |
| $r->content_type('text/xml'); |
$r->content_type('text/xml'); |
|
Line 420 sub handler {
|
Line 61 sub handler {
|
| $r->send_http_header; |
$r->send_http_header; |
| return OK; |
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; |
|
| } |
|
| } |
|
| } |
|
| if (!$hashtied) { |
|
| $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; |
|
| return HTTP_NOT_ACCEPTABLE; |
|
| } |
|
| |
|
| # ------------------------------------------------------------------- Hash tied |
|
| |
|
| |
# Send header, don't cache this page |
| if ($ENV{'browser.mathml'}) { |
if ($ENV{'browser.mathml'}) { |
| $r->content_type('text/xml'); |
$r->content_type('text/xml'); |
| } else { |
} else { |
|
Line 450 sub handler {
|
Line 71 sub handler {
|
| &Apache::loncommon::no_cache($r); |
&Apache::loncommon::no_cache($r); |
| $r->send_http_header; |
$r->send_http_header; |
| |
|
| my $firstres=$hash{'map_start_'. |
# Create the nav map |
| &Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
my $navmap = Apache::lonnavmaps::navmap->new( |
| my $lastres=$hash{'map_finish_'. |
$ENV{"request.course.fn"}.".db", |
| &Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
| if (!(($firstres) && ($lastres))) { |
|
| $r->print('<html><body>Coursemap undefined.</body></html>'); |
|
| } else { |
|
| |
|
| # ----------------------------------------------------------------- Render page |
|
| # -------------------------------------------------------------- Set parameters |
|
| |
|
| |
|
| # ---------------------------- initialize coursedata and userdata for this user |
|
| 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 (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); |
|
| } |
|
| } |
|
| |
|
| @rows=(); |
|
| |
|
| &tracetable(0,$firstres,'&','',0); |
|
| |
|
| # ------------------------------------------------------------------ Page parms |
|
| |
|
| 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)); |
|
| } |
|
| } |
|
| |
|
| |
|
| unless ($contents) { |
|
| $r->print('<html><body>Empty Map.</body></html>'); |
|
| } else { |
|
| |
|
| # ------------------------------------------------------------------ Build page |
|
| |
|
| my $currenturl=$ENV{'form.postdata'}; |
if (!defined($navmap)) { |
| $currenturl=~s/^http\:\/\///; |
my $requrl = $r->uri; |
| $currenturl=~s/^[^\/]+//; |
$ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; |
| |
return HTTP_NOT_ACCEPTABLE; |
| # ---------------------------------------------------------------- Send headers |
} |
| |
|
| 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; |
|
| } |
|
| } |
|
| } |
|
| } |
|
| # ----------------------------------------------------------- Start Page Output |
|
| my $bodytagadd=''; |
|
| $r->print( |
|
| '<html><head><title>Navigate Course Map</title></head>'); |
|
| if (($currenturl=~/^\/res/) && |
|
| ($currenturl!~/^\/res\/adm/)) { |
|
| $bodytagadd='onLoad="window.location.hash='."'curloc'".'"'; |
|
| } |
|
| $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', |
|
| $bodytagadd)); |
|
| $r->print('<script>window.focus();</script>'); |
|
| my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; |
|
| if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); } |
|
| $r->print("<h3>$date</h3>\n"); |
|
| $r->rflush(); |
|
| $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '. |
|
| localtime($lastcheck). |
|
| '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); |
|
| if (($currenturl=~/^\/res/) && |
|
| ($currenturl!~/^\/res\/adm/)) { |
|
| $r->print('<a href="#curloc">Current Location</a><p>'); |
|
| } |
|
| |
|
| # Handle a network error |
|
| |
|
| if ($networkFailedFlag) |
$r->print("<html><head>\n"); |
| { |
$r->print("<title>Navigate Course Contents</title>"); |
| $r->print('<H2>LON-CAPA network failure.</H2>'."\n"); |
|
| $r->print("<p>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(' <a href="#'. |
|
| $rid.'">'.$hash{'title_'.$rid}. |
|
| '</a><br>'); |
|
| } |
|
| } |
|
| } |
|
| } |
|
| # ----------------------------------------------------------------- Start table |
|
| $r->print('<hr><table cols="'.$lcm.'" border="0">'); |
|
| for ($i=0;$i<=$#rows;$i++) { |
|
| if ($rows[$i]) { |
|
| $r->print("\n<tr>"); |
|
| 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='<td>'; |
|
| my $adde='</td>'; |
|
| my $hwk='<font color="#223322">'; |
|
| my $hwke='</font>'; |
|
| if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; } |
|
| if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; } |
|
| if ($rid=~/^h(.+)/) { |
|
| $rid=$1; |
|
| $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">'; |
|
| $adde='</th>'; |
|
| if (($ENV{'user.adv'}) && |
|
| ($parmhash{$symb.'.0.parameter_randompick'})) { |
|
| $adde=' (randomly select '. |
|
| $parmhash{$symb.'.0.parameter_randompick'}. |
|
| ')</th>'; |
|
| } |
|
| } |
|
| 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='<td bgcolor="#AAAAAA">'; |
|
| } |
|
| |
|
| # solved/correct |
# Header |
| if ($code eq '3') { |
$r->print(&Apache::loncommon::bodytag('Navigate Course Contents','', |
| $add='<td bgcolor="#AAFFAA">'; |
'')); |
| } elsif ($code eq '4') { # partially correct |
$r->print('<script>window.focus();</script>'); |
| $add='<td bgcolor="#E0FFAA">'; |
|
| } 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 = '<td bgcolor="#AAAAAA">'; |
|
| } |
|
| else |
|
| { |
|
| $add='<td bgcolor="#FFAAAA">'; |
|
| } |
|
| |
|
| if ($tcode eq '2') { # open, not past due |
$r->print('<table border="0" cellpadding="2" cellspacing="0">'); |
| $add='<td bgcolor="#FFFFAA">'; |
my $date=localtime; |
| } |
$r->print('<tr><td align="right" valign="bottom">Key: </td>'); |
| |
|
| |
# Print discussions and feedback header |
| |
if ($navmap->{LAST_CHECK}) { |
| |
$r->print('<td align="center" valign="bottom"> '. |
| |
'<img src="/adm/lonMisc/chat.gif"> New discussion since '. |
| |
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
| |
'</td><td align="center" valign="bottom"> '. |
| |
'<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'. |
| |
'</td>'); |
| |
} else { |
| |
$r->print('<td align="center" valign="bottom"> '. |
| |
'<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'. |
| |
' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'. |
| |
'</td>'); |
| |
} |
| |
$r->print('</tr></table>'); |
| |
|
| |
my $condition = 0; |
| |
if ($ENV{'form.condition'}) { |
| |
$condition = 1; |
| |
} |
| |
|
| |
my $currenturl = $ENV{'form.postdata'}; |
| |
$currenturl=~s/^http\:\/\///; |
| |
$currenturl=~s/^[^\/]+//; |
| |
|
| |
# alreadyHere allows us to only open the maps necessary to view |
| |
# the current location once, while at the same time remembering |
| |
# the current location. Without that check, the user would never |
| |
# be able to close those maps; the user would close it, and the |
| |
# currenturl scan would re-open it. |
| |
my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) . |
| |
"&alreadyHere=1"; |
| |
|
| if ($tcode eq '4') { # due in next 24 hours |
if ($condition) { |
| $add='<td bgcolor="#FFFF33">'; |
$r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd\">Close All Folders</a>"); |
| $adde='</td>'; |
} else { |
| } |
$r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd\">Open All Folders</a>"); |
| } |
|
| $hwk='<font color="#888811"><b>'; |
|
| $hwke='</b></font>'; |
|
| if ($code eq '1') { |
|
| $hwke='</b> ('.$ctext.')</font>'; |
|
| } |
|
| if ($code eq '2' || $code eq '4') { |
|
| $hwk='<font color="#992222"><b>'; |
|
| $hwke='</b> ('.$ctext.')</font>'; |
|
| } |
|
| if ($code eq '3') { |
|
| $hwk='<font color="#229922"><b>'; |
|
| $hwke='</b> ('.$ctext.')</font>'; |
|
| } |
|
| if ($networkFailedFlag) |
|
| { |
|
| $hwke='</b> (status unavailable)</font>'; |
|
| } |
|
| } |
|
| if ($rid && $hash{'src_'.$rid} eq $currenturl) { |
|
| $add=$add.'<a name="curloc"></a>'. |
|
| '<font color=red size=+2><b>> </b></font>'; |
|
| $adde= |
|
| '<font color=red size=+2><b> <</b></font>'.$adde; |
|
| } |
|
| if ($discussiontimes{$symb}>$lastcheck) { |
|
| $adde= |
|
| '<img border=0 src="/adm/lonMisc/chat.gif">'. |
|
| $adde; |
|
| } |
|
| if ($error{$src}) { |
|
| foreach (split(/\,/,$error{$src})) { |
|
| if ($_) { |
|
| $adde= |
|
| ' <a href="/adm/email?display='. |
|
| &Apache::lonnet::escape($_). |
|
| '"><img src="/adm/lonMisc/bomb.gif" border=0></a>' |
|
| .$adde; |
|
| } |
|
| } |
|
| } |
|
| if ($feedback{$src}) { |
|
| foreach (split(/\,/,$feedback{$src})) { |
|
| if ($_) { |
|
| $adde= |
|
| ' <a href="/adm/email?display='. |
|
| &Apache::lonnet::escape($_). |
|
| '"><img src="/adm/lonMisc/feedback.gif" border=0></a>' |
|
| .$adde; |
|
| } |
|
| } |
|
| } |
|
| if ($indent) { |
|
| my $is=" "; |
|
| for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; } |
|
| } |
|
| if (!$linkid) { $linkid=$rid; } |
|
| if ($hash{'randomout_'.$rid}) { |
|
| $adde=' <i>(hidden)</i>'.$adde; |
|
| } |
|
| $r->print($add.$indentstr); |
|
| if ($rid) { |
|
| $r->print('<a href="'.$hash{'src_'.$linkid}. |
|
| (($hash{'src_'.$linkid}=~/\?/)?'&':'?'). |
|
| 'symb='.&Apache::lonnet::escape($symb) |
|
| .'">'. |
|
| $hwk.$hash{'title_'.$rid}.$hwke.'</a>'); |
|
| } |
|
| $r->print($adde); |
|
| } |
|
| $r->print('</tr>'); |
|
| } |
|
| } |
|
| $r->print("\n</table>"); |
|
| $r->print('</body></html>'); |
|
| # -------------------------------------------------------------------- End page |
|
| } |
|
| # ------------------------------------------------------------- End render page |
|
| } |
|
| # ------------------------------------------------------------------ Untie hash |
|
| unless (untie(%hash)) { |
|
| &Apache::lonnet::logthis("<font color=blue>WARNING: ". |
|
| "Could not untie coursemap $fn (browse).</font>"); |
|
| } |
|
| unless (untie(%parmhash)) { |
|
| &Apache::lonnet::logthis("<font color=blue>WARNING: ". |
|
| "Could not untie parmhash (browse).</font>"); |
|
| } |
} |
| return OK; |
|
| } |
|
| |
|
| sub new_handle { |
$r->print('<br> '); |
| my $r = shift; |
$r->rflush(); |
| |
|
| # Handle header-only request |
# Now that we've displayed some stuff to the user, init the navmap |
| if ($r->header_only) { |
$navmap->init(); |
| 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 |
# Check that it's defined |
| if ($ENV{'browser.mathml'}) { |
if (!($navmap->courseMapDefined())) { |
| $r->content_type('text/xml'); |
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' . |
| } else { |
'</body></html>'); |
| $r->content_type('text/html'); |
return OK; |
| } |
} |
| &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 |
# Grab a resource object so we have access to the constants; this |
| # is technically not proper, but should be harmless |
# is technically not proper, but should be harmless |
| my $res = $navmap->firstResource(); |
my $res = $navmap->firstResource(); |
| |
|
| |
# These are some data tables, which make it easy to change some of |
| |
# of the specific visualization parameters if desired. |
| |
|
| # Defines a status->color mapping, null string means don't color |
# Defines a status->color mapping, null string means don't color |
| my %colormap = |
my %colormap = |
| ( $res->NETWORK_FAILURE => '', |
( $res->NETWORK_FAILURE => '', |
| $res->CORRECT => '#BBFFBB', |
$res->CORRECT => '', |
| $res->EXCUSED => '#BBBBFF', |
$res->EXCUSED => '#3333FF', |
| $res->PAST_DUE => '#FFAA00', |
$res->PAST_DUE_ANSWER_LATER => '', |
| $res->ANSWER_OPEN => '#FF00AA', |
$res->PAST_DUE_NO_ANSWER => '', |
| $res->OPEN_LATER => '', |
$res->ANSWER_OPEN => '#006600', |
| $res->TRIES_LEFT => '#FFFF00', |
$res->OPEN_LATER => '', |
| $res->INCORRECT => '#FFAA00', |
$res->TRIES_LEFT => '', |
| $res->OPEN => '#FFFF88', |
$res->INCORRECT => '', |
| $res->NOTHING_SET => '' ); |
$res->OPEN => '', |
| |
$res->NOTHING_SET => '' ); |
| if (!defined($navmap)) { |
# And a special case in the nav map; what to do when the assignment |
| my $requrl = $r->uri; |
# is not yet done and due in less then 24 hours |
| $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; |
my $hurryUpColor = "#FF0000"; |
| return HTTP_NOT_ACCEPTABLE; |
|
| } |
my %statusIconMap = |
| |
( $res->NETWORK_FAILURE => '', |
| |
$res->NOTHING_SET => '', |
| |
$res->CORRECT => 'navmap.correct.gif', |
| |
$res->EXCUSED => 'navmap.correct.gif', |
| |
$res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', |
| |
$res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', |
| |
$res->ANSWER_OPEN => 'navmap.wrong.gif', |
| |
$res->OPEN_LATER => '', |
| |
$res->TRIES_LEFT => 'navmap.open.gif', |
| |
$res->INCORRECT => 'navmap.wrong.gif', |
| |
$res->OPEN => 'navmap.open.gif', |
| |
$res->ATTEMPTED => 'navmap.open.gif' ); |
| |
|
| |
my %iconAltTags = |
| |
( 'navmap.correct.gif' => 'Correct', |
| |
'navmap.wrong.gif' => 'Incorrect', |
| |
'navmap.open.gif' => 'Open' ); |
| |
|
| |
my %condenseStatuses = |
| |
( $res->NETWORK_FAILURE => 1, |
| |
$res->NOTHING_SET => 1, |
| |
$res->CORRECT => 1 ); |
| |
|
| my %filterHash; |
my %filterHash; |
| # Figure out what we're not displaying |
# Figure out what we're not displaying |
|
Line 858 sub new_handle {
|
Line 203 sub new_handle {
|
| } |
} |
| } |
} |
| |
|
| |
# Is this a new-style course? If so, we want to suppress showing the top-level |
| |
# maps in their own folders, in favor of "inlining" them. |
| |
my $topResource = $navmap->getById("0.0"); |
| |
my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|; |
| |
my $inlinedelta = $inlineTopLevelMaps? -1 : 0; |
| |
|
| # Begin the HTML table |
# Begin the HTML table |
| # two columns: the title/icon on the left, the info on the right |
# four cols: resource + indent, chat+feedback, icon, text string |
| $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n"); |
$r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"); |
| |
|
| my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash); |
# This needs to be updated to use symbs from the remote, |
| |
# instead of uris. The changes to this and the main rendering |
| |
# loop should be obvious. |
| |
# Here's a simple example of the iterator. |
| |
# Preprocess the map: Look for current URL, force inlined maps to display |
| |
|
| |
my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 1); |
| |
my $found = 0; |
| |
my $depth = 1; |
| |
my $currentUrlIndex = 0; # keeps track of when the current resource is found, |
| |
# so we can back up a few and put the anchor above the |
| |
# current resource |
| |
my $currentUrlDelta = 5; # change this to change how many resources are displayed |
| |
# before the current resource when using #current |
| |
$mapIterator->next(); # discard the first BEGIN_MAP |
| my $curRes = $mapIterator->next(); |
my $curRes = $mapIterator->next(); |
| |
my $counter = 0; |
| |
|
| |
while ($depth > 0) { |
| |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
| |
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
| |
|
| |
if (ref($curRes)) { $counter++; } |
| |
|
| |
my $mapStack = $mapIterator->getStack(); |
| |
if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) && |
| |
$curRes->src() eq $currenturl) { |
| |
# If this is the correct resource, be sure to |
| |
# show it by making sure the containing maps |
| |
# are open. |
| |
|
| |
# This is why we have to use the main iterator instead of the |
| |
# potentially faster DFS: The count has to be the same, so |
| |
# the order has to be the same, which DFS won't give us. |
| |
$currentUrlIndex = $counter; |
| |
|
| |
# Ensure the parent maps are open |
| |
for my $map (@{$mapStack}) { |
| |
if ($condition) { |
| |
undef $filterHash{$map->map_pc()}; |
| |
} else { |
| |
$filterHash{$map->map_pc()} = 1; |
| |
} |
| |
} |
| |
$ENV{'form.alreadyHere'} = 1; |
| |
} |
| |
|
| |
# Preprocessing: If we're inlining nav maps into the top-level display, |
| |
# make sure we show this map! |
| |
if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map && |
| |
scalar(@{$mapStack}) == 1) { |
| |
if ($condition) { |
| |
undef $filterHash{$curRes->map_pc()}; |
| |
} else { |
| |
$filterHash{$curRes->map_pc()} = 1; |
| |
} |
| |
} |
| |
|
| |
$curRes = $mapIterator->next(); |
| |
} |
| |
|
| undef $res; # so we don't accidentally use it later |
undef $res; # so we don't accidentally use it later |
| my $indentLevel = -1; |
my $indentLevel = 0; |
| my $indentString = " "; |
my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />"; |
| |
|
| my $isNewBranch = 0; |
my $isNewBranch = 0; |
| |
my $now = time(); |
| |
my $in24Hours = $now + 24 * 60 * 60; |
| |
my $displayedHereMarker = 0; |
| |
|
| |
# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" |
| |
# code in iterator->next), so ignore the first one |
| |
$mapIterator = $navmap->getIterator(undef, undef, \%filterHash, |
| |
$condition); |
| |
$mapIterator->next(); |
| |
$curRes = $mapIterator->next(); |
| |
$depth = 1; |
| |
|
| |
my @backgroundColors = ("#FFFFFF", "#F6F6F6"); |
| |
my $rowNum = 0; |
| |
|
| while ($curRes != $mapIterator->END_NAV_MAP) { |
$counter = 0; |
| |
|
| |
# Print the 'current' anchor here if it would fall off the top |
| |
if ($currentUrlIndex - $currentUrlDelta < 0) { |
| |
$r->print('<a name="current" />'); |
| |
} |
| |
|
| |
while ($depth > 0) { |
| if ($curRes == $mapIterator->BEGIN_MAP() || |
if ($curRes == $mapIterator->BEGIN_MAP() || |
| $curRes == $mapIterator->BEGIN_BRANCH()) { |
$curRes == $mapIterator->BEGIN_BRANCH()) { |
| $indentLevel++; |
$indentLevel++; |
|
Line 882 sub new_handle {
|
Line 313 sub new_handle {
|
| if ($curRes == $mapIterator->BEGIN_BRANCH()) { |
if ($curRes == $mapIterator->BEGIN_BRANCH()) { |
| $isNewBranch = 1; |
$isNewBranch = 1; |
| } |
} |
| |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
| |
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
| |
|
| |
if (ref($curRes)) { $counter++; } |
| |
|
| |
# Is this resource being ignored because it is in a random-out |
| |
# map and it was not selected? |
| |
if (ref($curRes) && !advancedUser() && $curRes->randomout()) { |
| |
$curRes = $mapIterator->next(); |
| |
next; # if yes, then just ignore this resource |
| |
} |
| |
|
| if (ref($curRes) && $curRes->src()) { |
if (ref($curRes) && $curRes->src()) { |
| |
|
| my @parts; |
my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon |
| |
|
| |
if ($indentLevel - $deltalevel + $inlinedelta < 0) { |
| |
# If this would be at a negative depth (top-level maps in |
| |
# new-style courses, we want to suppress their title display) |
| |
# then ignore it. |
| |
$curRes = $mapIterator->next(); |
| |
next; |
| |
} |
| |
|
| |
# Step one: Decide which parts to show |
| |
my @parts = @{$curRes->parts()}; |
| |
my $multipart = scalar(@parts) > 1; |
| |
my $condensed = 0; |
| |
|
| if ($curRes->is_problem()) { |
if ($curRes->is_problem()) { |
| @parts = @{$curRes->parts()}; |
|
| if (scalar(@parts) > 1) { shift(@parts); } |
# Is it multipart? |
| |
if ($multipart) { |
| |
# If it's multipart, see if part 0 is "open" |
| |
# if it is, display all parts, if it isn't, |
| |
# just display first |
| |
if (!$curRes->opendate("0")) { |
| |
# no parts are open, display as one part |
| |
@parts = ("0"); |
| |
$condensed = 1; |
| |
} else { |
| |
# Otherwise, only display part 0 if we want to |
| |
# attach feedback or email information to it |
| |
if ($curRes->hasDiscussion() || $curRes->getFeedback()) { |
| |
shift @parts; |
| |
} else { |
| |
# Now, we decide whether to condense the |
| |
# parts due to similarity |
| |
my $status = $curRes->status($parts[1]); |
| |
my $due = $curRes->duedate($parts[1]); |
| |
my $open = $curRes->opendate($parts[1]); |
| |
my $statusAllSame = 1; |
| |
my $dueAllSame = 1; |
| |
my $openAllSame = 1; |
| |
for (my $i = 2; $i < scalar(@parts); $i++) { |
| |
if ($curRes->status($parts[$i]) != $status){ |
| |
$statusAllSame = 0; |
| |
} |
| |
if ($curRes->duedate($parts[$i]) != $due ) { |
| |
$dueAllSame = 0; |
| |
} |
| |
if ($curRes->opendate($parts[$i]) != $open) { |
| |
$openAllSame = 0; |
| |
} |
| |
} |
| |
|
| |
# $allSame is true if all the statuses were |
| |
# the same. Now, if they are all the same and |
| |
# match one of the statuses to condense, or they |
| |
# are all open with the same due date, or they are |
| |
# all OPEN_LATER with the same open date, display the |
| |
# status of the first non-zero part (to get the 'correct' |
| |
# status right, since 0 is never 'correct' or 'open'). |
| |
if (($statusAllSame && defined($condenseStatuses{$status})) || |
| |
($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| |
| |
($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ |
| |
@parts = ($parts[1]); |
| |
$condensed = 1; |
| |
} |
| |
} |
| |
} |
| |
} |
| |
|
| } else { |
} else { |
| @parts[0] = "0"; # this is to get past foreach loop below |
$parts[0] = "0"; # this is to get past foreach loop below |
| # you can consider a non-problem resource as a resource |
# you can consider a non-problem resource as a resource |
| # with only one part without loss |
# with only one part without loss, and it simplifies the looping |
| |
} |
| |
|
| |
# Is it a multipart problem with a single part, now in |
| |
# @parts with "0" filtered out? If so, 'forget' it's a multi-part |
| |
# problem and treat it like a single-part problem. |
| |
if ( scalar(@parts) == 1 ) { |
| |
$multipart = 0; |
| |
} |
| |
|
| |
# Display one part, in event of network error. |
| |
# If this is a single part, we can at least show the correct |
| |
# status, but if it's multipart, we're lost, since we can't |
| |
# retreive the metadata to count the parts |
| |
if ($curRes->{RESOURCE_ERROR}) { |
| |
@parts = ("0"); |
| } |
} |
| |
|
| |
# Step Two: Print the actual data. |
| |
|
| |
# For each part we intend to display... |
| foreach my $part (@parts) { |
foreach my $part (@parts) { |
| |
|
| # For each thing we're displaying... |
|
| |
|
| |
my $nonLinkedText = ""; # unlinked stuff after title |
| |
|
| my $stack = $mapIterator->getStack(); |
my $stack = $mapIterator->getStack(); |
| my $src = getLinkForResource($stack); |
my $src = getLinkForResource($stack); |
| |
|
| |
# Pass the correct symb on the querystring, so the |
| |
# remote will figure out where we are if we click a link |
| my $srcHasQuestion = $src =~ /\?/; |
my $srcHasQuestion = $src =~ /\?/; |
| my $link = $src. |
my $link = $src. |
| ($srcHasQuestion?'&':'?') . |
($srcHasQuestion?'&':'?') . |
| 'symb='.&Apache::lonnet::escape($curRes->symb()). |
'symb='.&Apache::lonnet::escape($curRes->symb()). |
| '"'; |
'"'; |
| my $title = $curRes->title(); |
|
| |
my $title = $curRes->compTitle(); |
| my $partLabel = ""; |
my $partLabel = ""; |
| my $newBranchText = ""; |
my $newBranchText = ""; |
| |
|
| # If this is a new branch, label it so |
# If this is a new branch, label it so |
| # (temporary, this should be an icon w/ alt text) |
|
| if ($isNewBranch) { |
if ($isNewBranch) { |
| $newBranchText = "NB -> "; |
$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">"; |
| $isNewBranch = 0; |
$isNewBranch = 0; |
| } |
} |
| |
|
|
Line 922 sub new_handle {
|
Line 449 sub new_handle {
|
| my $linkopen = "<a href=\"$link\">"; |
my $linkopen = "<a href=\"$link\">"; |
| my $linkclose = "</a>"; |
my $linkclose = "</a>"; |
| |
|
| my $icon = "html.gif"; |
my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />"; |
| if ($curRes->is_problem()) { |
if ($curRes->is_problem()) { |
| $icon = "problem.gif"; |
if ($part eq "0" || $condensed) { |
| |
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; |
| |
} else { |
| |
$icon = $indentString; |
| |
} |
| } |
} |
| |
|
| # Display the correct icon, link to open or shut map |
# Display the correct icon, link to open or shut map |
| if ($curRes->is_map()) { |
if ($curRes->is_map()) { |
| my $mapId = $curRes->map_pc(); |
my $mapId = $curRes->map_pc(); |
| my $nowOpen = !defined($filterHash{$mapId}); |
my $nowOpen = (!defined($filterHash{$mapId})); |
| |
if ($condition) {$nowOpen = !$nowOpen;} |
| $icon = $nowOpen ? |
$icon = $nowOpen ? |
| "folder_opened.gif" : "folder_closed.gif"; |
"navmap.folder.closed.gif" : "navmap.folder.open.gif"; |
| |
$icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />"; |
| $linkopen = "<a href=\"/adm/navmaps?filter="; |
$linkopen = "<a href=\"/adm/navmaps?filter="; |
| $linkopen .= $nowOpen ? |
$linkopen .= ($nowOpen xor $condition) ? |
| addToFilter(\%filterHash, $mapId) : |
addToFilter(\%filterHash, $mapId) : |
| removeFromFilter(\%filterHash, $mapId); |
removeFromFilter(\%filterHash, $mapId); |
| $linkopen .= "\">"; |
$linkopen .= "&condition=$condition&$queryAdd\">"; |
| $linkclose = "</a>"; |
$linkclose = "</a>"; |
| |
|
| } |
} |
| |
|
| my $colorizer = ""; |
my $colorizer = ""; |
| |
my $color; |
| if ($curRes->is_problem()) { |
if ($curRes->is_problem()) { |
| my $status = $curRes->status($part); |
my $status = $curRes->status($part); |
| my $color = $colormap{$status}; |
$color = $colormap{$status}; |
| |
|
| |
# Special case in the navmaps: If in less then |
| |
# 24 hours, give it a bit of urgency |
| |
if (($status == $curRes->OPEN() || $status == $curRes->ATTEMPTED() || |
| |
$status == $curRes->TRIES_LEFT()) |
| |
&& $curRes->duedate() && |
| |
$curRes->duedate() < time()+(24*60*60) && |
| |
$curRes->duedate() > time()) { |
| |
$color = $hurryUpColor; |
| |
} |
| |
# Special case: If this is the last try, and there is |
| |
# more then one available, and it's not due yet, give a bit of urgency |
| |
my $tries = $curRes->tries($part); |
| |
my $maxtries = $curRes->maxtries($part); |
| |
if ($tries && $maxtries && $maxtries > 1 && |
| |
$maxtries - $tries == 1 && $curRes->duedate() && |
| |
$curRes->duedate() > time()) { |
| |
$color = $hurryUpColor; |
| |
} |
| if ($color ne "") { |
if ($color ne "") { |
| $colorizer = "bgcolor=\"$color\""; |
$colorizer = "bgcolor=\"$color\""; |
| } |
} |
| } |
} |
| |
|
| $r->print(" <tr><td align=\"left\" valign=\"top\">\n"); |
if ($curRes->randomout()) { |
| |
$nonLinkedText .= ' <i>(hidden)</i> '; |
| |
} |
| |
|
| |
$rowNum++; |
| |
my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; |
| |
|
| |
# FIRST COL: The resource indentation, branch icon, name, and anchor |
| |
$r->print(" <tr bgcolor=\"$backgroundColor\"><td align=\"left\" valign=\"center\" width=\"60%\">\n"); |
| |
|
| |
# Print the anchor if necessary |
| |
if ($counter == $currentUrlIndex - $currentUrlDelta) { |
| |
$r->print('<a name="current" />'); |
| |
} |
| |
|
| # print indentation |
# print indentation |
| for (my $i = 0; $i < $indentLevel; $i++) { |
for (my $i = 0; $i < $indentLevel - $deltalevel + $inlinedelta; $i++) { |
| $r->print($indentString); |
$r->print($indentString); |
| } |
} |
| |
|
| $r->print(" ${newBranchText}${linkopen}<img border=\"0\" src=\"" . |
$r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); |
| "/adm/lonIcons/$icon\" alt=\"\">${linkclose}\n"); |
|
| |
my $curMarkerBegin = ""; |
| |
my $curMarkerEnd = ""; |
| |
|
| |
# Is this the current resource? |
| |
if ($curRes->src() eq $currenturl && !$displayedHereMarker) { |
| |
$curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>'; |
| |
$curMarkerEnd = '<font color="red" size="+2"> <</font>'; |
| |
$displayedHereMarker = 1; |
| |
} |
| |
|
| |
if ($curRes->is_problem() && $part ne "0" && !$condensed) { |
| |
$partLabel = " (Part $part)"; |
| |
$title = ""; |
| |
} |
| |
if ($multipart && $condensed) { |
| |
$nonLinkedText .= ' (' . $curRes->countParts() . ' parts)'; |
| |
} |
| |
|
| |
$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText"); |
| |
|
| |
if ($curRes->{RESOURCE_ERROR}) { |
| |
$r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", |
| |
'<font size="-1">Host down</font>')); |
| |
} |
| |
|
| |
$r->print("</td>\n"); |
| |
|
| |
# SECOND COL: Is there text, feedback, errors?? |
| |
my $discussionHTML = ""; my $feedbackHTML = ""; |
| |
|
| |
if ($curRes->hasDiscussion()) { |
| |
$discussionHTML = $linkopen . |
| |
'<img border="0" src="/adm/lonMisc/chat.gif" />' . |
| |
$linkclose; |
| |
} |
| |
|
| |
if ($curRes->getFeedback()) { |
| |
my $feedback = $curRes->getFeedback(); |
| |
foreach (split(/\,/, $feedback)) { |
| |
if ($_) { |
| |
$feedbackHTML .= ' <a href="/adm/email?display=' |
| |
. &Apache::lonnet::escape($_) . '">' |
| |
. '<img src="/adm/lonMisc/feedback.gif" ' |
| |
. 'border="0" /></a>'; |
| |
} |
| |
} |
| |
} |
| |
|
| |
$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>"); |
| |
|
| if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; } |
# Is this the first displayed part of a multi-part problem |
| |
# that has not been condensed, so we should suppress these two |
| |
# columns so we don't display useless status info about part |
| |
# "0"? |
| |
my $firstDisplayed = !$condensed && $multipart && $part eq "0"; |
| |
|
| |
# THIRD COL: Problem status icon |
| |
if ($curRes->is_problem() && |
| |
!$firstDisplayed) { |
| |
my $icon = $statusIconMap{$curRes->status($part)}; |
| |
my $alt = $iconAltTags{$icon}; |
| |
if ($icon) { |
| |
$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"); |
| |
} else { |
| |
$r->print("<td width=\"30\"> </td>\n"); |
| |
} |
| |
} else { # not problem, no icon |
| |
$r->print("<td width=\"30\"> </td>\n"); |
| |
} |
| |
|
| $r->print(" <a href=\"$link\">$title$partLabel</a></td>". |
# FOURTH COL: Text description |
| "<td $colorizer align=\"right\">\n"); |
$r->print("<td align=\"right\" valign=\"center\">\n"); |
| |
|
| if ($curRes->kind() eq "res" and |
if ($curRes->kind() eq "res" && |
| $curRes->is_problem() ) { |
$curRes->is_problem() && |
| |
!$firstDisplayed) { |
| |
$r->print ("<font color=\"$color\"><b>") if ($color); |
| $r->print (getDescription($curRes, $part)); |
$r->print (getDescription($curRes, $part)); |
| |
$r->print ("</b></font>") if ($color); |
| } |
} |
| |
if ($curRes->is_map() && advancedUser() && $curRes->randompick()) { |
| |
$r->print('(randomly select ' . $curRes->randompick() .')'); |
| |
} |
| |
|
| |
$r->print(" </td></tr>\n"); |
| |
|
| |
if (!($counter % 20)) { $r->rflush(); } |
| |
if ($counter == 2) { $r->rflush(); } |
| } |
} |
| } |
} |
| $curRes = $mapIterator->next(); |
$curRes = $mapIterator->next(); |
|
Line 977 sub new_handle {
|
Line 621 sub new_handle {
|
| |
|
| $r->print("</table></body></html>"); |
$r->print("</table></body></html>"); |
| |
|
| |
$navmap->untieHashes(); |
| |
|
| return OK; |
return OK; |
| } |
} |
| |
|
|
Line 1035 sub getLinkForResource {
|
Line 681 sub getLinkForResource {
|
| sub getDescription { |
sub getDescription { |
| my $res = shift; |
my $res = shift; |
| my $part = shift; |
my $part = shift; |
| my $status = $res->getDateStatus(); |
my $status = $res->status($part); |
| |
|
| if ($status == $res->NETWORK_FAILURE) { return ""; } |
if ($status == $res->NETWORK_FAILURE) { return ""; } |
| if ($status == $res->NOTHING_SET) { |
if ($status == $res->NOTHING_SET) { |
| return "Not currently assigned."; |
return "Not currently assigned."; |
| } |
} |
| if ($status == $res->OPEN_LATER) { |
if ($status == $res->OPEN_LATER) { |
| return "Opens: " . timeToHumanString($res->opendate($part)); |
return "Open " . timeToHumanString($res->opendate($part)); |
| } |
} |
| if ($status == $res->OPEN) { |
if ($status == $res->OPEN) { |
| return "Due: " . timeToHumanString($res->duedate($part)); |
if ($res->duedate($part)) { |
| |
return "Due " . timeToHumanString($res->duedate($part)); |
| |
} else { |
| |
return "Open, no due date"; |
| |
} |
| } |
} |
| if ($status == $res->PAST_DUE) { |
if ($status == $res->PAST_DUE_ANSWER_LATER) { |
| return "Answer: " . timeToHumanString($res->duedate($part)); |
return "Answer open " . timeToHumanString($res->answerdate($part)); |
| |
} |
| |
if ($status == $res->PAST_DUE_NO_ANSWER) { |
| |
return "Was due " . timeToHumanString($res->duedate($part)); |
| } |
} |
| if ($status == $res->ANSWER_OPEN) { |
if ($status == $res->ANSWER_OPEN) { |
| return "Answer available"; |
return "Answer available"; |
| } |
} |
| |
if ($status == $res->EXCUSED) { |
| |
return "Excused by instructor"; |
| |
} |
| |
if ($status == $res->ATTEMPTED) { |
| |
return "Not yet graded."; |
| |
} |
| |
if ($status == $res->TRIES_LEFT) { |
| |
my $tries = $res->tries($part); |
| |
my $maxtries = $res->maxtries($part); |
| |
my $triesString = ""; |
| |
if ($tries && $maxtries) { |
| |
$triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>"; |
| |
if ($maxtries > 1 && $maxtries - $tries == 1) { |
| |
$triesString = "<b>$triesString</b>"; |
| |
} |
| |
} |
| |
if ($res->duedate()) { |
| |
return "Due " . timeToHumanString($res->duedate($part)) . |
| |
" $triesString"; |
| |
} else { |
| |
return "No due date $triesString"; |
| |
} |
| |
} |
| |
} |
| |
|
| |
# This puts a human-readable name on the ENV variable. |
| |
sub advancedUser { |
| |
return $ENV{'user.adv'}; |
| } |
} |
| |
|
| # I want to change this into something more human-friendly. For |
|
| # now, this is a simple call to localtime. The final function |
# timeToHumanString takes a time number and converts it to a |
| # probably belongs in loncommon. |
# human-readable representation, meant to be used in the following |
| |
# manner: |
| |
# print "Due $timestring" |
| |
# print "Open $timestring" |
| |
# print "Answer available $timestring" |
| |
# Very, very, very, VERY English-only... goodness help a localizer on |
| |
# this func... |
| sub timeToHumanString { |
sub timeToHumanString { |
| return localtime(shift); |
my ($time) = @_; |
| |
# zero, '0' and blank are bad times |
| |
if (!$time) { |
| |
return 'never'; |
| |
} |
| |
|
| |
my $now = time(); |
| |
|
| |
my @time = localtime($time); |
| |
my @now = localtime($now); |
| |
|
| |
# Positive = future |
| |
my $delta = $time - $now; |
| |
|
| |
my $minute = 60; |
| |
my $hour = 60 * $minute; |
| |
my $day = 24 * $hour; |
| |
my $week = 7 * $day; |
| |
my $inPast = 0; |
| |
|
| |
# Logic in comments: |
| |
# Is it now? (extremely unlikely) |
| |
if ( $delta == 0 ) { |
| |
return "this instant"; |
| |
} |
| |
|
| |
if ($delta < 0) { |
| |
$inPast = 1; |
| |
$delta = -$delta; |
| |
} |
| |
|
| |
if ( $delta > 0 ) { |
| |
|
| |
my $tense = $inPast ? " ago" : ""; |
| |
my $prefix = $inPast ? "" : "in "; |
| |
|
| |
# Less then a minute |
| |
if ( $delta < $minute ) { |
| |
if ($delta == 1) { return "${prefix}1 second$tense"; } |
| |
return "$prefix$delta seconds$tense"; |
| |
} |
| |
|
| |
# Less then an hour |
| |
if ( $delta < $hour ) { |
| |
# If so, use minutes |
| |
my $minutes = floor($delta / 60); |
| |
if ($minutes == 1) { return "${prefix}1 minute$tense"; } |
| |
return "$prefix$minutes minutes$tense"; |
| |
} |
| |
|
| |
# Is it less then 24 hours away? If so, |
| |
# display hours + minutes |
| |
if ( $delta < $hour * 24) { |
| |
my $hours = floor($delta / $hour); |
| |
my $minutes = floor(($delta % $hour) / $minute); |
| |
my $hourString = "$hours hours"; |
| |
my $minuteString = ", $minutes minutes"; |
| |
if ($hours == 1) { |
| |
$hourString = "1 hour"; |
| |
} |
| |
if ($minutes == 1) { |
| |
$minuteString = ", 1 minute"; |
| |
} |
| |
if ($minutes == 0) { |
| |
$minuteString = ""; |
| |
} |
| |
return "$prefix$hourString$minuteString$tense"; |
| |
} |
| |
|
| |
# Less then 5 days away, display day of the week and |
| |
# HH:MM |
| |
if ( $delta < $day * 5 ) { |
| |
my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time)); |
| |
$timeStr =~ s/12:00 am/midnight/; |
| |
$timeStr =~ s/12:00 pm/noon/; |
| |
return ($inPast ? "last " : "next ") . |
| |
$timeStr; |
| |
} |
| |
|
| |
# Is it this year? |
| |
if ( $time[5] == $now[5]) { |
| |
# Return on Month Day, HH:MM meridian |
| |
my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time)); |
| |
$timeStr =~ s/12:00 am/midnight/; |
| |
$timeStr =~ s/12:00 pm/noon/; |
| |
return $timeStr; |
| |
} |
| |
|
| |
# Not this year, so show the year |
| |
my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time)); |
| |
$timeStr =~ s/12:00 am/midnight/; |
| |
$timeStr =~ s/12:00 pm/noon/; |
| |
return $timeStr; |
| |
} |
| } |
} |
| |
|
| 1; |
1; |
| |
|
| package Apache::lonnavmaps::navmap; |
package Apache::lonnavmaps::navmap; |
| |
|
| # LEFT: |
|
| # * Actual handler code (multi-part) |
|
| # * Branches (aieee!) (and conditionals) |
|
| |
|
| =pod |
=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. |
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. |
|
Line 1087 You must obtain resource objects through
|
Line 862 You must obtain resource objects through
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<new>(filename, parmHashFile, genCourseAndUserOptions): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise. |
=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. |
| |
|
| =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below. |
=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below. |
| |
|
|
Line 1105 sub new {
|
Line 880 sub new {
|
| $self->{NAV_HASH_FILE} = shift; |
$self->{NAV_HASH_FILE} = shift; |
| $self->{PARM_HASH_FILE} = shift; |
$self->{PARM_HASH_FILE} = shift; |
| $self->{GENERATE_COURSE_USER_OPT} = shift; |
$self->{GENERATE_COURSE_USER_OPT} = shift; |
| |
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift; |
| |
|
| # Resource cache stores navmapresource's as we reference them. We generate |
# Resource cache stores navmap resources as we reference them. We generate |
| # them on-demand so we don't pay for creating resources unless we use them. |
# them on-demand so we don't pay for creating resources unless we use them. |
| $self->{RESOURCE_CACHE} = {}; |
$self->{RESOURCE_CACHE} = {}; |
| |
|
|
Line 1126 sub new {
|
Line 902 sub new {
|
| if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
| &GDBM_READER(), 0640))) |
&GDBM_READER(), 0640))) |
| { |
{ |
| |
untie $self->{PARM_HASH}; |
| return undef; |
return undef; |
| } |
} |
| $self->{PARM_HASH} = \%parmhash; |
$self->{PARM_HASH} = \%parmhash; |
| $self->{HASH_TIED} = 1; |
$self->{HASH_TIED} = 1; |
| |
|
| |
bless($self); |
| |
|
| |
return $self; |
| |
} |
| |
|
| |
sub init { |
| |
my $self = shift; |
| |
|
| # If the course opt hash and the user opt hash should be generated, |
# If the course opt hash and the user opt hash should be generated, |
| # generate them |
# generate them |
| if ($self->{GENERATE_COURSE_USER_OPT}) { |
if ($self->{GENERATE_COURSE_USER_OPT}) { |
|
Line 1143 sub new {
|
Line 928 sub new {
|
| |
|
| my $userprefix=$uname.'_'.$udom.'_'; |
my $userprefix=$uname.'_'.$udom.'_'; |
| |
|
| my %courserdatas; my %useropt; my %courseopt; |
my %courserdatas; my %useropt; my %courseopt; my %userrdatas; |
| unless ($uhome eq 'no_host') { |
unless ($uhome eq 'no_host') { |
| # ------------------------------------------------- Get coursedata (if present) |
# ------------------------------------------------- Get coursedata (if present) |
| unless ((time-$courserdatas{$cid.'.last_cache'})<240) { |
unless ((time-$courserdatas{$cid.'.last_cache'})<240) { |
|
Line 1182 sub new {
|
Line 967 sub new {
|
| $useropt{$userprefix.&Apache::lonnet::unescape($name)}= |
$useropt{$userprefix.&Apache::lonnet::unescape($name)}= |
| &Apache::lonnet::unescape($value); |
&Apache::lonnet::unescape($value); |
| } |
} |
| $self->{COURSE_OPT} = \%courseopt; |
$self->{COURSE_OPT} = \%courseopt; |
| $self->{USER_OPT} = \%useropt; |
$self->{USER_OPT} = \%useropt; |
| } |
} |
| } |
} |
| |
|
| bless($self); |
if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) { |
| |
my $cid=$ENV{'request.course.id'}; |
| |
my ($cdom,$cnum)=split(/\_/,$cid); |
| |
|
| |
my %emailstatus = &Apache::lonnet::dump('email_status'); |
| |
my $logoutTime = $emailstatus{'logout'}; |
| |
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
| |
$self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? |
| |
$courseLeaveTime : $logoutTime); |
| |
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
| |
$cdom, $cnum); |
| |
my %feedback=(); |
| |
my %error=(); |
| |
my $keys = &Apache::lonnet::reply('keys:'. |
| |
$ENV{'user.domain'}.':'. |
| |
$ENV{'user.name'}.':nohist_email', |
| |
$ENV{'user.home'}); |
| |
|
| |
foreach my $msgid (split(/\&/, $keys)) { |
| |
$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; |
| |
} |
| |
} |
| |
} |
| |
} |
| |
|
| |
$self->{FEEDBACK} = \%feedback; |
| |
$self->{ERROR_MSG} = \%error; # what is this? JB |
| |
$self->{DISCUSSION_TIME} = \%discussiontime; |
| |
$self->{EMAIL_STATUS} = \%emailstatus; |
| |
|
| |
} |
| |
|
| return $self; |
$self->{PARM_CACHE} = {}; |
| |
} |
| |
|
| |
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
| |
sub courseMapDefined { |
| |
my $self = shift; |
| |
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
| |
|
| |
my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; |
| |
my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; |
| |
return $firstres && $lastres; |
| } |
} |
| |
|
| sub getIterator { |
sub getIterator { |
| my $self = shift; |
my $self = shift; |
| my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, |
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, |
| shift, shift); |
shift, undef, shift); |
| return $iterator; |
return $iterator; |
| } |
} |
| |
|
| # unties the hash when done |
# unties the hash when done |
| sub untieHashes { |
sub untieHashes { |
| my $self = shift; |
my $self = shift; |
| untie $self->{NAV_HASH} if ($self->{HASH_TIED}); |
untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED}); |
| untie $self->{PARM_HASH} if ($self->{HASH_TIED}); |
untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED}); |
| $self->{HASH_TIED} = 0; |
$self->{HASH_TIED} = 0; |
| } |
} |
| |
|
|
Line 1213 sub DESTROY {
|
Line 1053 sub DESTROY {
|
| $self->untieHashes(); |
$self->untieHashes(); |
| } |
} |
| |
|
| |
# Private function: Does the given resource (as a symb string) have |
| |
# current discussion? Returns 0 if chat/mail data not extracted. |
| |
sub hasDiscussion { |
| |
my $self = shift; |
| |
my $symb = shift; |
| |
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
| |
|
| |
return $self->{DISCUSSION_TIME}->{$symb} > |
| |
$self->{LAST_CHECK}; |
| |
} |
| |
|
| |
# Private function: Does the given resource (as a symb string) have |
| |
# current feedback? Returns the string in the feedback hash, which |
| |
# will be false if it does not exist. |
| |
sub getFeedback { |
| |
my $self = shift; |
| |
my $symb = shift; |
| |
|
| |
if (!defined($self->{FEEDBACK})) { return ""; } |
| |
|
| |
return $self->{FEEDBACK}->{$symb}; |
| |
} |
| |
|
| =pod |
=pod |
| |
|
| =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. |
=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. |
|
Line 1263 sub finishResource {
|
Line 1126 sub finishResource {
|
| return $self->getById($firstResource); |
return $self->getById($firstResource); |
| } |
} |
| |
|
| # -------------------------------------------- Figure out a cascading parameter |
# Parmval reads the parm hash and cascades the lookups. parmval_real does |
| # |
# the actual lookup; parmval caches the results. |
| # For this function to work |
|
| # |
|
| # * parmhash needs to be tied |
|
| # * courseopt and useropt need to be initialized for this user and course |
|
| # |
|
| |
|
| sub parmval { |
sub parmval { |
| my $self = shift; |
my $self = shift; |
| my ($what,$symb)=@_; |
my ($what,$symb)=@_; |
| |
my $hashkey = $what."|||".$symb; |
| |
|
| |
if (defined($self->{PARM_CACHE}->{$hashkey})) { |
| |
return $self->{PARM_CACHE}->{$hashkey}; |
| |
} |
| |
|
| |
my $result = $self->parmval_real($what, $symb); |
| |
$self->{PARM_CACHE}->{$hashkey} = $result; |
| |
return $result; |
| |
} |
| |
|
| |
sub parmval_real { |
| |
my $self = shift; |
| |
my ($what,$symb) = @_; |
| |
|
| my $cid=$ENV{'request.course.id'}; |
my $cid=$ENV{'request.course.id'}; |
| my $csec=$ENV{'request.course.sec'}; |
my $csec=$ENV{'request.course.sec'}; |
| my $uname=$ENV{'user.name'}; |
my $uname=$ENV{'user.name'}; |
|
Line 1307 sub parmval {
|
Line 1179 sub parmval {
|
| |
|
| # ---------------------------------------------------------- first, check user |
# ---------------------------------------------------------- first, check user |
| if ($uname and defined($useropt)) { |
if ($uname and defined($useropt)) { |
| if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; } |
if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; } |
| if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; } |
if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; } |
| if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; } |
if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; } |
| } |
} |
| |
|
| # ------------------------------------------------------- second, check course |
# ------------------------------------------------------- second, check course |
| if ($csec and defined($courseopt)) { |
if ($csec and defined($courseopt)) { |
| if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; } |
if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; } |
| if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; } |
if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; } |
| if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; } |
if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; } |
| } |
} |
| |
|
| if (defined($courseopt)) { |
if (defined($courseopt)) { |
| if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; } |
if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; } |
| if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; } |
if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; } |
| if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; } |
if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; } |
| } |
} |
| |
|
| # ----------------------------------------------------- third, check map parms |
# ----------------------------------------------------- third, check map parms |
| |
|
| my $thisparm=$$parmhash{$symbparm}; |
my $thisparm=$$parmhash{$symbparm}; |
| if ($thisparm) { return $thisparm; } |
if (defined($thisparm)) { return $thisparm; } |
| |
|
| # ----------------------------------------------------- fourth , check default |
# ----------------------------------------------------- fourth , check default |
| |
|
| my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); |
my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); |
| if ($default) { return $default} |
if (defined($default)) { return $default} |
| |
|
| # --------------------------------------------------- fifth , cascade up parts |
# --------------------------------------------------- fifth , cascade up parts |
| |
|
|
Line 1343 sub parmval {
|
Line 1215 sub parmval {
|
| my ($part,$id)=split(/\_/,$space); |
my ($part,$id)=split(/\_/,$space); |
| if ($id) { |
if ($id) { |
| my $partgeneral=$self->parmval($part.".$qualifier",$symb); |
my $partgeneral=$self->parmval($part.".$qualifier",$symb); |
| if ($partgeneral) { return $partgeneral; } |
if (defined($partgeneral)) { return $partgeneral; } |
| } else { |
} else { |
| my $resourcegeneral=$self->parmval("0.$qualifier",$symb); |
my $resourcegeneral=$self->parmval("0.$qualifier",$symb); |
| if ($resourcegeneral) { return $resourcegeneral; } |
if (defined($resourcegeneral)) { return $resourcegeneral; } |
| } |
} |
| } |
} |
| return ''; |
return ''; |
|
Line 1357 sub parmval {
|
Line 1229 sub parmval {
|
| |
|
| package Apache::lonnavmaps::iterator; |
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 |
=pod |
| |
|
| =back |
=back |
|
Line 1381 getIterator behaves as follows:
|
Line 1249 getIterator behaves as follows:
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item B<getIterator>(nav_map, firstResource, finishResource, filterHash): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). It is your responsibility to ensure that the iterator will actually get there. filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0. |
=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. |
| |
|
| 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. |
Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add 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: |
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 |
=over 4 |
| |
|
| =item * some list of tokens here |
=item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned. |
| |
|
| |
=item * END_MAP: The map is now done. |
| |
|
| |
=item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch. |
| |
|
| |
=item * END_BRANCH: The branch is now done. |
| |
|
| =back |
=back |
| |
|
| The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants. |
The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. |
| |
|
| |
=back |
| |
|
| =cut |
=cut |
| |
|
| # Here are the tokens for the iterator: |
# 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 BEGIN_MAP { return 1; } # begining of a new map |
| sub END_MAP { return 2; } # end of the map |
sub END_MAP { return 2; } # end of the map |
| sub BEGIN_BRANCH { return 3; } # beginning of a branch |
sub BEGIN_BRANCH { return 3; } # beginning of a branch |
| sub END_BRANCH { return 4; } # end of a branch |
sub END_BRANCH { return 4; } # end of a branch |
| |
sub FORWARD { return 1; } # go forward |
| |
sub BACKWARD { return 2; } |
| |
|
| # Params: nav map, start resource, end resource, filter, condition, |
sub min { |
| # already seen hash ref |
(my $a, my $b) = @_; |
| |
if ($a < $b) { return $a; } else { return $b; } |
| |
} |
| |
|
| |
# In the CVS repository, documentation of this algorithm is included |
| |
# in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1** |
| |
# will reference the same location in the text as the part of the |
| |
# algorithm is running through. |
| |
|
| sub new { |
sub new { |
| # magic invocation to create a class instance |
# magic invocation to create a class instance |
|
Line 1433 sub new {
|
Line 1317 sub new {
|
| # A hash, used as a set, of resource already seen |
# A hash, used as a set, of resource already seen |
| $self->{ALREADY_SEEN} = shift; |
$self->{ALREADY_SEEN} = shift; |
| if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
| |
$self->{CONDITION} = shift; |
| |
|
| |
# Now, we need to pre-process the map, by walking forward and backward |
| |
# over the parts of the map we're going to look at. |
| |
|
| # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP. |
# The processing steps are exactly the same, except for a few small |
| |
# changes, so I bundle those up in the following list of two elements: |
| |
# (direction_to_iterate, VAL_name, next_resource_method_to_call, |
| |
# first_resource). |
| |
# This prevents writing nearly-identical code twice. |
| |
my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext', |
| |
'FIRST_RESOURCE'], |
| |
[BACKWARD(), 'BOT_UP_VAL', 'getPrevious', |
| |
'FINISH_RESOURCE'] ); |
| |
|
| |
my $maxDepth = 0; # tracks max depth |
| |
|
| |
# **1** |
| |
|
| |
foreach my $pass (@iterations) { |
| |
my $direction = $pass->[0]; |
| |
my $valName = $pass->[1]; |
| |
my $nextResourceMethod = $pass->[2]; |
| |
my $firstResourceName = $pass->[3]; |
| |
|
| |
my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP}, |
| |
$self->{FIRST_RESOURCE}, |
| |
$self->{FINISH_RESOURCE}, |
| |
{}, undef, 0, $direction); |
| |
|
| |
# prime the recursion |
| |
$self->{$firstResourceName}->{DATA}->{$valName} = 0; |
| |
my $depth = 0; |
| |
$iterator->next(); |
| |
my $curRes = $iterator->next(); |
| |
while ($depth > -1) { |
| |
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
| |
if ($curRes == $iterator->END_MAP()) { $depth--; } |
| |
|
| |
if (ref($curRes)) { |
| |
my $resultingVal = $curRes->{DATA}->{$valName}; |
| |
my $nextResources = $curRes->$nextResourceMethod(); |
| |
my $resourceCount = scalar(@{$nextResources}); |
| |
|
| |
if ($resourceCount == 1) { # **3** |
| |
my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; |
| |
$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); |
| |
} |
| |
|
| |
if ($resourceCount > 1) { # **4** |
| |
foreach my $res (@{$nextResources}) { |
| |
my $current = $res->{DATA}->{$valName} || 999999999; |
| |
$res->{DATA}->{$valName} = min($current, $resultingVal + 1); |
| |
} |
| |
} |
| |
} |
| |
|
| |
# Assign the final val (**2**) |
| |
if (ref($curRes) && $direction == BACKWARD()) { |
| |
my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL}, |
| |
$curRes->{DATA}->{BOT_UP_VAL}); |
| |
|
| |
$curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth; |
| |
if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;} |
| |
} |
| |
$curRes = $iterator->next(); |
| |
} |
| |
} |
| |
|
| |
# Set up some bookkeeping information. |
| |
$self->{CURRENT_DEPTH} = 0; |
| |
$self->{MAX_DEPTH} = $maxDepth; |
| |
$self->{STACK} = []; |
| |
$self->{RECURSIVE_ITERATOR_FLAG} = 0; |
| |
|
| |
for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) { |
| |
push @{$self->{STACK}}, []; |
| |
} |
| |
|
| |
# Prime the recursion w/ the first resource **5** |
| |
push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE}; |
| |
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1; |
| |
|
| |
bless ($self); |
| |
|
| |
return $self; |
| |
} |
| |
|
| |
sub next { |
| |
my $self = shift; |
| |
|
| |
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? If so, update the depth |
| |
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; |
| |
} |
| |
|
| |
if (defined($self->{FORCE_NEXT})) { |
| |
my $tmp = $self->{FORCE_NEXT}; |
| |
$self->{FORCE_NEXT} = undef; |
| |
return $tmp; |
| |
} |
| |
|
| |
# Have we not yet begun? If not, return BEGIN_MAP and |
| |
# remember we've started. |
| |
if ( !$self->{STARTED} ) { |
| |
$self->{STARTED} = 1; |
| |
return $self->BEGIN_MAP(); |
| |
} |
| |
|
| |
# Here's the guts of the iterator. |
| |
|
| |
# Find the next resource, if any. |
| |
my $found = 0; |
| |
my $i = $self->{MAX_DEPTH}; |
| |
my $newDepth; |
| |
my $here; |
| |
while ( $i >= 0 && !$found ) { |
| |
if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6** |
| |
$here = pop @{$self->{STACK}->[$i]}; # **7** |
| |
$found = 1; |
| |
$newDepth = $i; |
| |
} |
| |
$i--; |
| |
} |
| |
|
| |
# If we still didn't find anything, we're done. |
| |
if ( !$found ) { |
| |
# We need to get back down to the correct branch depth |
| |
if ( $self->{CURRENT_DEPTH} > 0 ) { |
| |
$self->{CURRENT_DEPTH}--; |
| |
return END_BRANCH(); |
| |
} else { |
| |
return END_MAP(); |
| |
} |
| |
} |
| |
|
| |
# If this is not a resource, it must be an END_BRANCH marker we want |
| |
# to return directly. |
| |
if (!ref($here)) { # **8** |
| |
if ($here == END_BRANCH()) { # paranoia, in case of later extension |
| |
$self->{CURRENT_DEPTH}--; |
| |
return $here; |
| |
} |
| |
} |
| |
|
| |
# Otherwise, it is a resource and it's safe to store in $self->{HERE} |
| |
$self->{HERE} = $here; |
| |
|
| |
# Get to the right level |
| |
if ( $self->{CURRENT_DEPTH} > $newDepth ) { |
| |
push @{$self->{STACK}->[$newDepth]}, $here; |
| |
$self->{CURRENT_DEPTH}--; |
| |
return END_BRANCH(); |
| |
} |
| |
if ( $self->{CURRENT_DEPTH} < $newDepth) { |
| |
push @{$self->{STACK}->[$newDepth]}, $here; |
| |
$self->{CURRENT_DEPTH}++; |
| |
return BEGIN_BRANCH(); |
| |
} |
| |
|
| |
# If we made it here, we have the next resource, and we're at the |
| |
# right branch level. So let's examine the resource for where |
| |
# we can get to from here. |
| |
|
| |
# So we need to look at all the resources we can get to from here, |
| |
# categorize them if we haven't seen them, remember if we have a new |
| |
my $nextUnfiltered = $here->getNext(); |
| |
my $maxDepthAdded = -1; |
| |
|
| |
for (@$nextUnfiltered) { |
| |
if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { |
| |
my $depth = $_->{DATA}->{DISPLAY_DEPTH}; |
| |
push @{$self->{STACK}->[$depth]}, $_; |
| |
$self->{ALREADY_SEEN}->{$_->{ID}} = 1; |
| |
if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; } |
| |
} |
| |
} |
| |
|
| |
# Is this the end of a branch? If so, all of the resources examined above |
| |
# led to lower levels then the one we are currently at, so we push a END_BRANCH |
| |
# marker onto the stack so we don't forget. |
| |
# Example: For the usual A(BC)(DE)F case, when the iterator goes down the |
| |
# BC branch and gets to C, it will see F as the only next resource, but it's |
| |
# one level lower. Thus, this is the end of the branch, since there are no |
| |
# more resources added to this level or above. |
| |
# We don't do this if the examined resource is the finish resource, |
| |
# because the condition given above is true, but the "END_MAP" will |
| |
# take care of things and we should already be at depth 0. |
| |
my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH}; |
| |
if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9** |
| |
push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH(); |
| |
} |
| |
|
| |
# That ends the main iterator logic. Now, do we want to recurse |
| |
# down this map (if this resource is a map)? |
| |
if ($self->{HERE}->is_map() && |
| |
(defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { |
| |
$self->{RECURSIVE_ITERATOR_FLAG} = 1; |
| |
my $firstResource = $self->{HERE}->map_start(); |
| |
my $finishResource = $self->{HERE}->map_finish(); |
| |
|
| |
$self->{RECURSIVE_ITERATOR} = |
| |
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
| |
$finishResource, $self->{FILTER}, |
| |
$self->{ALREADY_SEEN}, $self->{CONDITION}); |
| |
} |
| |
|
| |
return $self->{HERE}; |
| |
|
| |
} |
| |
|
| |
=pod |
| |
|
| |
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). |
| |
|
| |
=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->{HERE}); |
| |
|
| |
if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
| |
$self->{RECURSIVE_ITERATOR}->populateStack($stack); |
| |
} |
| |
} |
| |
|
| |
1; |
| |
|
| |
package Apache::lonnavmaps::DFSiterator; |
| |
|
| |
# Not documented in the perldoc: This is a simple iterator that just walks |
| |
# through the nav map and presents the resources in a depth-first search |
| |
# fashion, ignorant of conditionals, randomized resources, etc. It presents |
| |
# BEGIN_MAP and END_MAP, but does not understand branches at all. It is |
| |
# useful for pre-processing of some kind, and is in fact used by the main |
| |
# iterator that way, but that's about it. |
| |
# One could imagine merging this into the init routine of the main iterator, |
| |
# but this might as well be left seperate, since it is possible some other |
| |
# use might be found for it. - Jeremy |
| |
|
| |
sub BEGIN_MAP { return 1; } # begining of a new map |
| |
sub END_MAP { return 2; } # end of the map |
| |
sub FORWARD { return 1; } # go forward |
| |
sub BACKWARD { return 2; } |
| |
|
| |
# Params: Nav map ref, first resource id/ref, finish resource id/ref, |
| |
# filter hash ref (or undef), already seen hash or undef, condition |
| |
# (as in main iterator), direction FORWARD or BACKWARD (undef->forward). |
| |
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}); |
| |
|
| |
$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} = {} }; |
| |
$self->{CONDITION} = shift; |
| |
$self->{DIRECTION} = shift || FORWARD(); |
| |
|
| |
# Flag: Have we started yet? |
| $self->{STARTED} = 0; |
$self->{STARTED} = 0; |
| |
|
| # Should we continue calling the recursive iterator, if any? |
# Should we continue calling the recursive iterator, if any? |
|
Line 1448 sub new {
|
Line 1630 sub new {
|
| $self->{RECURSIVE_DEPTH} = 0; |
$self->{RECURSIVE_DEPTH} = 0; |
| |
|
| # For keeping track of our branches, we maintain our own stack |
# For keeping track of our branches, we maintain our own stack |
| $self->{BRANCH_STACK} = []; |
$self->{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 |
# Start with the first resource |
| push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE}; |
if ($self->{DIRECTION} == FORWARD) { |
| $self->{BRANCH_STACK_SIZE} = 1; |
push @{$self->{STACK}}, $self->{FIRST_RESOURCE}; |
| |
} else { |
| |
push @{$self->{STACK}}, $self->{FINISH_RESOURCE}; |
| |
} |
| |
|
| bless($self); |
bless($self); |
| return $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 { |
sub next { |
| my $self = shift; |
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 |
# 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. |
# watch the depth; we want to resume our level at the correct time. |
| if ($self->{RECURSIVE_ITERATOR_FLAG}) |
if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
| { |
|
| # grab the next from the recursive iterator |
# grab the next from the recursive iterator |
| my $next = $self->{RECURSIVE_ITERATOR}->next(); |
my $next = $self->{RECURSIVE_ITERATOR}->next(); |
| |
|
|
Line 1499 sub next {
|
Line 1665 sub next {
|
| } |
} |
| |
|
| # Is there a current resource to grab? If not, then return |
# Is there a current resource to grab? If not, then return |
| # END_BRANCH and END_MAP in succession. |
# END_MAP, which will end the iterator. |
| if (scalar(@{$self->{BRANCH_STACK}}) == 0) { |
if (scalar(@{$self->{STACK}}) == 0) { |
| if ($self->{BRANCH_DEPTH} > 0) { |
return $self->END_MAP(); |
| $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 |
# Have we not yet begun? If not, return BEGIN_MAP and |
|
Line 1517 sub next {
|
Line 1677 sub next {
|
| return $self->BEGIN_MAP; |
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(); |
|
| } |
|
| |
|
| # Remember the size for comparision next time. |
|
| $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}}); |
|
| |
|
| # If the next resource we mean to return is going to need |
|
| # a lower branch level, terminate branches until we get |
|
| # there. |
|
| |
|
| # Get the next resource in the branch |
# Get the next resource in the branch |
| $self->{HERE} = pop @{$self->{BRANCH_STACK}}; |
$self->{HERE} = pop @{$self->{STACK}}; |
| |
|
| # Are we at the right depth? If not, close a branch and return |
# remember that we've seen this, so we don't return it again later |
| # the current resource onto the branch stack |
|
| if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH}) |
|
| && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} < |
|
| $self->{BRANCH_DEPTH} ) { |
|
| $self->{BRANCH_DEPTH}--; |
|
| # return it so we can pick it up eventually |
|
| push @{$self->{BRANCH_STACK}}, $self->{HERE}; |
|
| return $self->END_BRANCH(); |
|
| } |
|
| |
|
| # 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; |
$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}; |
|
| } |
|
| |
|
| # Get the next possible resources |
# Get the next possible resources |
| my $nextUnfiltered = $self->{HERE}->getNext(); |
my $nextUnfiltered; |
| |
if ($self->{DIRECTION} == FORWARD()) { |
| |
$nextUnfiltered = $self->{HERE}->getNext(); |
| |
} else { |
| |
$nextUnfiltered = $self->{HERE}->getPrevious(); |
| |
} |
| my $next = []; |
my $next = []; |
| |
|
| # filter the next possibilities to remove things we've |
# filter the next possibilities to remove things we've |
| # already seen. Also, remember what branch depth they should |
# already seen. |
| # be displayed at, since there's no other reliable way to tell. |
|
| foreach (@$nextUnfiltered) { |
foreach (@$nextUnfiltered) { |
| if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { |
if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { |
| push @$next, $_; |
push @$next, $_; |
| $_->{DATA}->{ITERATOR_DEPTH} = |
|
| $self->{BRANCH_DEPTH} + 1; |
|
| } |
} |
| } |
} |
| |
|
| # 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) { |
while (@$next) { |
| # copy the next possibilities over to the branch stack |
# copy the next possibilities over to the stack |
| # in the right order |
push @{$self->{STACK}}, shift @$next; |
| 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 this is a map and we want to recurse down it... (not filtered out) |
| if ($self->{HERE}->is_map() && |
if ($self->{HERE}->is_map() && |
| !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) { |
(defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { |
| $self->{RECURSIVE_ITERATOR_FLAG} = 1; |
$self->{RECURSIVE_ITERATOR_FLAG} = 1; |
| my $firstResource = $self->{HERE}->map_start(); |
my $firstResource = $self->{HERE}->map_start(); |
| my $finishResource = $self->{HERE}->map_finish(); |
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} = |
$self->{RECURSIVE_ITERATOR} = |
| Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, |
Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource, |
| $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN}); |
$finishResource, $self->{FILTER}, $self->{ALREADY_SEEN}, |
| # prime the new iterator with the first resource |
$self->{CONDITION}, $self->{DIRECTION}); |
| #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource; |
|
| } |
} |
| |
|
| return $self->{HERE}; |
return $self->{HERE}; |
| } |
} |
| |
|
| =pod |
|
| |
|
| 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). |
|
| |
|
| =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; |
1; |
| |
|
| package Apache::lonnavmaps::resource; |
package Apache::lonnavmaps::resource; |
|
Line 1673 resource objects have a hash called DATA
|
Line 1745 resource objects have a hash called DATA
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =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. |
=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. |
| |
|
| |
=back |
| |
|
| =cut |
=cut |
| |
|
|
Line 1688 sub new {
|
Line 1762 sub new {
|
| |
|
| # Store this new resource in the parent nav map's cache. |
# Store this new resource in the parent nav map's cache. |
| $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; |
$self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; |
| |
$self->{RESOURCE_ERROR} = 0; |
| |
|
| # A hash that can be used by two-pass algorithms to store data |
# A hash that can be used by two-pass algorithms to store data |
| # about this resource in. Not used by the resource object |
# about this resource in. Not used by the resource object |
|
Line 1699 sub new {
|
Line 1774 sub new {
|
| return $self; |
return $self; |
| } |
} |
| |
|
| =pod |
|
| |
|
| =item * B<is_map>: Returns true if this is a map, false otherwise. |
|
| |
|
| =item * B<title>: 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 |
# 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 |
# pass the name, and to automatically append my ID, pass a true val on the |
| # second param |
# second param |
|
Line 1723 sub navHash {
|
Line 1784 sub navHash {
|
| return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; |
return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; |
| } |
} |
| |
|
| |
=pod |
| |
|
| |
B<Metadata Retreival> |
| |
|
| |
These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation. |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem"). |
| |
|
| |
=item * B<ext>: Returns true if the resource is external. |
| |
|
| |
=item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) |
| |
|
| |
=item * B<kind>: Returns the kind of the resource from the compiled nav map. |
| |
|
| |
=item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false. |
| |
|
| |
=item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?) |
| |
|
| |
=item * B<src>: Returns the source for the resource. |
| |
|
| |
=item * B<symb>: Returns the symb for the resource. |
| |
|
| |
=item * B<title>: Returns the title of the resource. |
| |
|
| |
=item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.) |
| |
|
| |
=back |
| |
|
| |
=cut |
| |
|
| # These info functions can be used directly, as they don't return |
# These info functions can be used directly, as they don't return |
| # resource information. |
# resource information. |
| sub title { my $self=shift; return $self->navHash("title_", 1); } |
sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); } |
| sub type { my $self=shift; return $self->navHash("type_", 1); } |
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; } |
| |
sub from { my $self=shift; return $self->navHash("from_", 1); } |
| sub goesto { my $self=shift; return $self->navHash("goesto_", 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 kind { my $self=shift; return $self->navHash("kind_", 1); } |
| |
sub randomout { my $self=shift; return $self->navHash("randomout_", 1); } |
| |
sub randompick { |
| |
my $self = shift; |
| |
return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb . |
| |
'.0.parameter_randompick'}; |
| |
} |
| sub src { |
sub src { |
| my $self=shift; |
my $self=shift; |
| return $self->navHash("src_", 1); |
return $self->navHash("src_", 1); |
|
Line 1743 sub symb {
|
Line 1841 sub symb {
|
| $self->navHash('map_id_'.$first)) |
$self->navHash('map_id_'.$first)) |
| . '___' . $second . '___' . $symbSrc; |
. '___' . $second . '___' . $symbSrc; |
| } |
} |
| sub is_problem { |
sub title { my $self=shift; return $self->navHash("title_", 1); } |
| my $self=shift; |
sub to { my $self=shift; return $self->navHash("to_", 1); } |
| my $src = $self->src(); |
sub compTitle { |
| return ($src =~ /problem$/); |
my $self = shift; |
| |
my $title = $self->title(); |
| |
if (!$title) { |
| |
$title = $self->src(); |
| |
$title = substr($title, rindex($title, '/') + 1); |
| |
} |
| |
return $title; |
| } |
} |
| |
=pod |
| |
|
| |
B<Predicate Testing the Resource> |
| |
|
| |
These methods are shortcuts to deciding if a given resource has a given property. |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<is_map>: Returns true if the resource is a map type. |
| |
|
| |
=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.) |
| |
|
| |
=item * B<is_page>: Returns true if the resource is a page. |
| |
|
| |
=item * B<is_problem>: Returns true if the resource is a problem. |
| |
|
| |
=item * B<is_sequence>: Returns true if the resource is a sequence. |
| |
|
| |
=back |
| |
|
| |
=cut |
| |
|
| |
|
| sub is_html { |
sub is_html { |
| my $self=shift; |
my $self=shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| return ($src =~ /html$/); |
return ($src =~ /html$/); |
| } |
} |
| sub is_sequence { |
sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); } |
| |
sub is_page { |
| my $self=shift; |
my $self=shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| return ($src =~ /sequence$/); |
return ($src =~ /page$/); |
| } |
} |
| sub is_page { |
sub is_problem { |
| my $self=shift; |
my $self=shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
| return ($src =~ /page$/); |
return ($src =~ /problem$/); |
| |
} |
| |
sub is_sequence { |
| |
my $self=shift; |
| |
my $src = $self->src(); |
| |
return ($src =~ /sequence$/); |
| } |
} |
| |
|
| |
# Private method: Shells out to the parmval in the nav map, handler parts. |
| |
|
| |
|
| # Move this into POD: In order to use these correctly, courseopt |
|
| # and useropt need to be generated |
|
| sub parmval { |
sub parmval { |
| my $self = shift; |
my $self = shift; |
| my $what = shift; |
my $what = shift; |
|
Line 1776 sub parmval {
|
Line 1905 sub parmval {
|
| return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb()); |
return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb()); |
| } |
} |
| |
|
| ##### |
=pod |
| # Map Queries |
|
| ##### |
|
| |
|
| # These methods relate to whether or not the resource is a map, and the |
B<Map Methods> |
| # attributes of that map. |
|
| |
These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>). |
| |
|
| |
=over 4 |
| |
|
| |
=item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map. |
| |
|
| |
=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. |
| |
|
| |
=item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map. |
| |
|
| |
=item * B<map_type>: Returns a string with the type of the map in it. |
| |
|
| |
=back |
| |
|
| |
=cut |
| |
|
| sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); } |
|
| sub map_finish { |
sub map_finish { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
|
Line 1791 sub map_finish {
|
Line 1932 sub map_finish {
|
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
| } |
} |
| |
sub map_pc { |
| |
my $self = shift; |
| |
my $src = $self->src(); |
| |
return $self->navHash("map_pc_$src", 0); |
| |
} |
| sub map_start { |
sub map_start { |
| my $self = shift; |
my $self = shift; |
| my $src = $self->src(); |
my $src = $self->src(); |
|
Line 1798 sub map_start {
|
Line 1944 sub map_start {
|
| $res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
| return $res; |
return $res; |
| } |
} |
| sub map_pc { |
|
| my $self = shift; |
|
| my $src = $self->src(); |
|
| return $self->navHash("map_pc_$src", 0); |
|
| } |
|
| sub map_type { |
sub map_type { |
| my $self = shift; |
my $self = shift; |
| my $pc = $self->map_pc(); |
my $pc = $self->map_pc(); |
|
Line 1825 sub map_type {
|
Line 1966 sub map_type {
|
| |
|
| =head2 Resource Parameters |
=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. |
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. |
| |
|
| 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.) |
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.) |
| |
|
|
Line 1847 These methods are responsible for gettin
|
Line 1988 These methods are responsible for gettin
|
| |
|
| =item * B<tol>: Get the tolerance for the problem. |
=item * B<tol>: Get the tolerance for the problem. |
| |
|
| |
=item * B<tries>: Get the number of tries the user has already used on the problem. |
| |
|
| =item * B<type>: Get the question type for the problem. |
=item * B<type>: Get the question type for the problem. |
| |
|
| =item * B<weight>: Get the weight for the problem. |
=item * B<weight>: Get the weight for the problem. |
|
Line 1868 sub answerdate {
|
Line 2011 sub answerdate {
|
| } |
} |
| return $self->parmval("answerdate", $part); |
return $self->parmval("answerdate", $part); |
| } |
} |
| |
sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); } |
| sub duedate { |
sub duedate { |
| (my $self, my $part) = @_; |
(my $self, my $part) = @_; |
| return $self->parmval("duedate", $part); |
return $self->parmval("duedate", $part); |
|
Line 1892 sub tol {
|
Line 2036 sub tol {
|
| (my $self, my $part) = @_; |
(my $self, my $part) = @_; |
| return $self->parmval("tol", $part); |
return $self->parmval("tol", $part); |
| } |
} |
| |
sub tries { |
| |
my $self = shift; |
| |
my $tries = $self->queryRestoreHash('tries', shift); |
| |
if (!defined($tries)) { return '0';} |
| |
return $tries; |
| |
} |
| sub type { |
sub type { |
| (my $self, my $part) = @_; |
(my $self, my $part) = @_; |
| return $self->parmval("type", $part); |
return $self->parmval("type", $part); |
| } |
} |
| sub weight { |
sub weight { |
| (my $self, my $part) = @_; |
my $self = shift; my $part = shift; |
| return $self->parmval("weight", $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 |
# Multiple things need this |
| sub getReturnHash { |
sub getReturnHash { |
| my $self = shift; |
my $self = shift; |
| |
|
| if (!defined($self->{RETURN_HASH})) { |
if (!defined($self->{RETURN_HASH})) { |
| my %tmpHash = &Apache::lonnet::restore($self->symb()); |
my %tmpHash = &Apache::lonnet::restore($self->symb()); |
| $self->{RETURN_HASH} = \%tmpHash; |
$self->{RETURN_HASH} = \%tmpHash; |
| } |
} |
| } |
} |
|
Line 1945 Misc. functions for the resource.
|
Line 2083 Misc. functions for the resource.
|
| |
|
| =over 4 |
=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<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. |
| |
|
| =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. |
=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: |
| |
|
| |
for (split(/\,/, $res->getFeedback())) { |
| |
my $link = &Apache::lonnet::escape($_); |
| |
... |
| |
|
| |
and use the link as appropriate. |
| |
|
| |
=cut |
| |
|
| |
sub hasDiscussion { |
| |
my $self = shift; |
| |
return $self->{NAV_MAP}->hasDiscussion($self->symb()); |
| |
} |
| |
|
| |
sub getFeedback { |
| |
my $self = shift; |
| |
return $self->{NAV_MAP}->getFeedback($self->src()); |
| |
} |
| |
|
| |
=pod |
| |
|
| |
=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.) |
| |
|
| |
=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. |
| |
|
| =back |
=back |
| |
|
|
Line 1956 Misc. functions for the resource.
|
Line 2118 Misc. functions for the resource.
|
| sub parts { |
sub parts { |
| my $self = shift; |
my $self = shift; |
| |
|
| |
if ($self->ext) { return ['0']; } |
| |
|
| $self->extractParts(); |
$self->extractParts(); |
| return $self->{PARTS}; |
return $self->{PARTS}; |
| } |
} |
|
Line 1964 sub countParts {
|
Line 2128 sub countParts {
|
| my $self = shift; |
my $self = shift; |
| |
|
| my $parts = $self->parts(); |
my $parts = $self->parts(); |
| |
|
| if (scalar(@{$parts}) == 1) { return 1;} |
if ($self->{RESOURCE_ERROR}) { |
| |
return 0; |
| |
} |
| |
|
| |
if (scalar(@{$parts}) < 2) { return 1;} |
| |
|
| return scalar(@{$parts}) - 1; |
return scalar(@{$parts}) - 1; |
| } |
} |
|
Line 1975 sub extractParts {
|
Line 2143 sub extractParts {
|
| my $self = shift; |
my $self = shift; |
| |
|
| return if ($self->{PARTS}); |
return if ($self->{PARTS}); |
| |
return if ($self->ext); |
| |
|
| $self->{PARTS} = []; |
$self->{PARTS} = []; |
| |
|
| # Retrieve part count |
# Retrieve part count, if this is a problem |
| foreach (split(/\,/,&Apache::lonnet::metadata($self->src(), |
if ($self->is_problem()) { |
| 'allpossiblekeys'))) { |
my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys'); |
| if ($_ =~ /^parameter\_(.*)\_opendate$/) { |
if (!$metadata) { |
| push @{$self->{PARTS}}, $1; |
$self->{RESOURCE_ERROR} = 1; |
| |
$self->{PARTS} = []; |
| |
return; |
| } |
} |
| |
|
| |
foreach (split(/\,/,$metadata)) { |
| |
if ($_ =~ /^parameter\_(.*)\_opendate$/) { |
| |
push @{$self->{PARTS}}, $1; |
| |
} |
| |
} |
| |
|
| |
|
| |
# Is this possible to do in one line? - Jeremy |
| |
my @sortedParts = sort @{$self->{PARTS}}; |
| |
$self->{PARTS} = \@sortedParts; |
| } |
} |
| |
|
| # Is this possible to do in one line? - Jeremy |
|
| my @sortedParts = sort @{$self->{PARTS}}; |
|
| $self->{PARTS} = \@sortedParts; |
|
| |
|
| return; |
return; |
| } |
} |
|
Line 1997 sub extractParts {
|
Line 2175 sub extractParts {
|
| |
|
| =head2 Resource Status |
=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. |
Problem resources have status information, reflecting their various dates and completion statuses. |
| |
|
| There are two aspects to the status: the date-related information and the completion information. |
There are two aspects to the status: the date-related information and the completion information. |
| |
|
|
Line 2007 Idiomatic usage of these two methods wou
|
Line 2185 Idiomatic usage of these two methods wou
|
| my $dateStatus = $resource->getDateStatus($_); |
my $dateStatus = $resource->getDateStatus($_); |
| my $completionStatus = $resource->getCompletionStatus($_); |
my $completionStatus = $resource->getCompletionStatus($_); |
| |
|
| |
or |
| |
|
| |
my $status = $resource->status($_); |
| |
|
| ... use it here ... |
... use it here ... |
| } |
} |
| |
|
| |
Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere. |
| |
|
| |
The symbolic constants shown below can be accessed through the resource object: $res->OPEN. |
| |
|
| =over 4 |
=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: |
=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: |
| |
|
| =back |
=back |
| |
|
|
Line 2024 B<Date Codes>
|
Line 2210 B<Date Codes>
|
| |
|
| =item * B<OPEN>: Open and not yet due. |
=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<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived. |
| |
|
| |
=item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set. |
| |
|
| =item * B<ANSWER_OPEN>: The answer date is here. |
=item * B<ANSWER_OPEN>: The answer date is here. |
| |
|
|
Line 2035 B<Date Codes>
|
Line 2224 B<Date Codes>
|
| =cut |
=cut |
| |
|
| # Apparently the compiler optimizes these into constants automatically |
# Apparently the compiler optimizes these into constants automatically |
| sub OPEN_LATER { return 0; } |
sub OPEN_LATER { return 0; } |
| sub OPEN { return 1; } |
sub OPEN { return 1; } |
| sub PAST_DUE { return 2; } |
sub PAST_DUE_NO_ANSWER { return 2; } |
| sub ANSWER_OPEN { return 3; } |
sub PAST_DUE_ANSWER_LATER { return 3; } |
| sub NOTHING_SET { return 4; } |
sub ANSWER_OPEN { return 4; } |
| sub NETWORK_FAILURE { return 100; } |
sub NOTHING_SET { return 5; } |
| |
sub NETWORK_FAILURE { return 100; } |
| |
|
| |
# getDateStatus gets the date status for a given problem part. |
| |
# Because answer date, due date, and open date are fully independent |
| |
# (i.e., it is perfectly possible to *only* have an answer date), |
| |
# we have to completely cover the 3x3 maxtrix of (answer, due, open) x |
| |
# (past, future, none given). This function handles this with a decision |
| |
# tree. Read the comments to follow the decision tree. |
| |
|
| sub getDateStatus { |
sub getDateStatus { |
| my $self = shift; |
my $self = shift; |
| my $part = shift; |
my $part = shift; |
| $part = "0" if (!defined($part)); |
$part = "0" if (!defined($part)); |
| |
|
| |
# Always return network failure if there was one. |
| return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
| |
|
| my $now = time(); |
my $now = time(); |
|
Line 2054 sub getDateStatus {
|
Line 2253 sub getDateStatus {
|
| my $due = $self->duedate($part); |
my $due = $self->duedate($part); |
| my $answer = $self->answerdate($part); |
my $answer = $self->answerdate($part); |
| |
|
| if ($open && $now < $open) {return $self->OPEN_LATER}; |
|
| if ($due && $now < $due) {return $self->OPEN}; |
|
| if ($answer && $now < $answer) {return $self->PAST_DUE}; |
|
| if (!$open && !$due && !$answer) { |
if (!$open && !$due && !$answer) { |
| # no data on the problem at all |
# no data on the problem at all |
| # should this be the same as "open later"? think multipart. |
# should this be the same as "open later"? think multipart. |
| return $self->NOTHING_SET; |
return $self->NOTHING_SET; |
| } |
} |
| return $self->ANSWER_OPEN; |
if (!$open || $now < $open) {return $self->OPEN_LATER} |
| |
if (!$due || $now < $due) {return $self->OPEN} |
| |
if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER} |
| |
if ($answer) { return $self->ANSWER_OPEN; } |
| |
return PAST_DUE_NO_ANSWER; |
| } |
} |
| |
|
| =pod |
=pod |
|
Line 2093 B<Completion Codes>
|
Line 2293 B<Completion Codes>
|
| |
|
| =item * B<NETWORK_FAILURE>: Information not available due to network failure. |
=item * B<NETWORK_FAILURE>: Information not available due to network failure. |
| |
|
| |
=item * B<ATTEMPTED>: Attempted, and not yet graded. |
| |
|
| =back |
=back |
| |
|
| =cut |
=cut |
|
Line 2103 sub INCORRECT_BY_OVERRIDE { return 12; }
|
Line 2305 sub INCORRECT_BY_OVERRIDE { return 12; }
|
| sub CORRECT { return 13; } |
sub CORRECT { return 13; } |
| sub CORRECT_BY_OVERRIDE { return 14; } |
sub CORRECT_BY_OVERRIDE { return 14; } |
| sub EXCUSED { return 15; } |
sub EXCUSED { return 15; } |
| |
sub ATTEMPTED { return 16; } |
| |
|
| sub getCompletionStatus { |
sub getCompletionStatus { |
| my $self = shift; |
my $self = shift; |
| my $part = shift; |
|
| $part = "0" if (!defined($part)); |
|
| return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
| |
|
| # Make sure return hash exists |
my $status = $self->queryRestoreHash('solved', shift); |
| $self->getReturnHash(); |
|
| |
|
| my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'}; |
|
| |
|
| # Left as seperate if statements in case we ever do more with this |
# 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_student') {return $self->CORRECT;} |
|
Line 2121 sub getCompletionStatus {
|
Line 2319 sub getCompletionStatus {
|
| if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } |
if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } |
| if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } |
if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } |
| if ($status eq 'excused') {return $self->EXCUSED; } |
if ($status eq 'excused') {return $self->EXCUSED; } |
| |
if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; } |
| return $self->NOT_ATTEMPTED; |
return $self->NOT_ATTEMPTED; |
| } |
} |
| |
|
| |
sub queryRestoreHash { |
| |
my $self = shift; |
| |
my $hashentry = shift; |
| |
my $part = shift; |
| |
$part = "0" if (!defined($part)); |
| |
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
| |
|
| |
$self->getReturnHash(); |
| |
|
| |
return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry}; |
| |
} |
| |
|
| =pod |
=pod |
| |
|
| B<Composite Status> |
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()): |
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 |
=over 4 |
| |
|
| =item * NETWORK_FAILURE: The network has failed and the information is not available. |
=item * B<NETWORK_FAILURE>: The network has failed and the information is not available. |
| |
|
| |
=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".) |
| |
|
| =item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened.) |
=item * B<CORRECT>: For any reason at all, the part is considered correct. |
| |
|
| =item * CORRECT: For any reason at all, the part is considered correct. |
=item * B<EXCUSED>: For any reason at all, the problem is excused. |
| |
|
| =item * EXCUSED: For any reason at all, the problem is excused. |
=item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set. |
| |
|
| =item * PAST_DUE: The problem is past due, and not considered correct. |
=item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set. |
| |
|
| =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available. |
=item * B<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 * B<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 * B<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 * B<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. |
=item * B<OPEN>: The item is open and not yet tried. |
| |
|
| |
=item * B<ATTEMPTED>: The problem has been attempted. |
| |
|
| =back |
=back |
| |
|
|
Line 2167 sub status {
|
Line 2382 sub status {
|
| |
|
| # What we have is a two-dimensional matrix with 4 entries on one |
# 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, |
# dimension and 5 entries on the other, which we want to colorize, |
| # plus network failure and "no date data". |
# plus network failure and "no date data at all". |
| |
|
| if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
| |
|
| # There are a few whole rows we can dispose of: |
# There are a few whole rows we can dispose of: |
| if ($completionStatus == CORRECT || |
if ($completionStatus == CORRECT || |
| $completionStatus == CORRECT_BY_OVERRIDE ) { |
$completionStatus == CORRECT_BY_OVERRIDE ) { |
| return CORRECT(); |
return CORRECT; |
| |
} |
| |
|
| |
if ($completionStatus == ATTEMPTED) { |
| |
return ATTEMPTED; |
| } |
} |
| |
|
| # If it's EXCUSED, then return that no matter what |
# If it's EXCUSED, then return that no matter what |
|
Line 2186 sub status {
|
Line 2405 sub status {
|
| return NOTHING_SET; |
return NOTHING_SET; |
| } |
} |
| |
|
| # Now we're down to a 3 (incorrect, incorrect_override, not_attempted) |
# Now we're down to a 4 (incorrect, incorrect_override, not_attempted) |
| # by 4 matrix (date status). |
# by 4 matrix (date statuses). |
| |
|
| if ($dateStatus == PAST_DUE) { |
if ($dateStatus == PAST_DUE_ANSWER_LATER || |
| return PAST_DUE; |
$dateStatus == PAST_DUE_NO_ANSWER ) { |
| |
return $dateStatus; |
| } |
} |
| |
|
| if ($dateStatus == ANSWER_OPEN) { |
if ($dateStatus == ANSWER_OPEN) { |
|
Line 2207 sub status {
|
Line 2427 sub status {
|
| # If it's WRONG... |
# If it's WRONG... |
| if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) { |
if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) { |
| # and there are TRIES LEFT: |
# and there are TRIES LEFT: |
| if ($self->tries() < $self->maxtries()) { |
if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) { |
| return TRIES_LEFT; |
return TRIES_LEFT; |
| } |
} |
| return INCORRECT; # otherwise, return orange; student can't fix this |
return INCORRECT; # otherwise, return orange; student can't fix this |
|
Line 2223 sub status {
|
Line 2443 sub status {
|
| |
|
| =over 4 |
=over 4 |
| |
|
| =item * B<getNext>(): Gets the next resource in the navmap after this one. |
=item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. |
| |
|
| =cut |
=item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. |
| |
|
| # For the simple single-link case, to get from a resource to the next |
=cut |
| # resource, you need to look up the "to_" link in the nav hash, then |
|
| # follow that with the "goesto_" link. |
|
| |
|
| sub getNext { |
sub getNext { |
| my $self = shift; |
my $self = shift; |
| my $alreadySeenHash = shift; |
|
| my @branches; |
my @branches; |
| my $to = $self->to(); |
my $to = $self->to(); |
| foreach my $branch ( split(/\,/, $to) ) { |
foreach my $branch ( split(/,/, $to) ) { |
| my $choice = $self->{NAV_MAP}->getById($branch); |
my $choice = $self->{NAV_MAP}->getById($branch); |
| my $next = $choice->goesto(); |
my $next = $choice->goesto(); |
| $next = $self->{NAV_MAP}->getById($next); |
$next = $self->{NAV_MAP}->getById($next); |
| |
|
| # Don't remember it if we've already seen it |
# Don't remember it if the student doesn't have browse priviledges |
| if (!defined($alreadySeenHash) || |
# future note: this may properly belong in the client of the resource |
| !defined($alreadySeenHash->{$next->{ID}})) { |
my $browsePriv = $self->{BROWSE_PRIV}; |
| push @branches, $next; |
if (!defined($browsePriv)) { |
| } |
$browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
| |
$self->{BROWSE_PRIV} = $browsePriv; |
| |
} |
| |
if (!($browsePriv ne '2' && $browsePriv ne 'F')) { |
| |
push @branches, $next; |
| |
} |
| |
} |
| |
return \@branches; |
| |
} |
| |
|
| |
sub getPrevious { |
| |
my $self = shift; |
| |
my @branches; |
| |
my $from = $self->from(); |
| |
foreach my $branch ( split /,/, $from) { |
| |
my $choice = $self->{NAV_MAP}->getById($branch); |
| |
my $prev = $choice->comesfrom(); |
| |
$prev = $self->{NAV_MAP}->getById($prev); |
| |
|
| |
# Don't remember it if the student doesn't have browse priviledges |
| |
# future note: this may properly belong in the client of the resource |
| |
my $browsePriv = $self->{BROWSE_PRIV}; |
| |
if (!defined($browsePriv)) { |
| |
$browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
| |
$self->{BROWSE_PRIV} = $browsePriv; |
| |
} |
| |
if (!($browsePriv ne '2' && $browsePriv ne 'F')) { |
| |
push @branches, $prev; |
| |
} |
| } |
} |
| return \@branches; |
return \@branches; |
| } |
} |
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavmaps.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface