version 1.87, 2002/10/28 13:58:58
|
version 1.133, 2003/01/31 22:46:50
|
Line 37
|
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 GDBM_File; |
|
use POSIX qw (floor strftime); |
use POSIX qw (floor strftime); |
|
|
# -------------------------------------------------------------- Module Globals |
my %navmaphash; |
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; |
my %parmhash; |
|
|
# This parameter keeps track of whether obtaining the user's information |
# symbolic constants |
# failed, which the colorizer in astatus can use |
sub SYMB { return 1; } |
my $networkFailedFlag = 0; |
sub URL { return 2; } |
|
sub NOTHING { return 3; } |
# ------------------------------------------------------------------ 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 (defined($uname)) { |
|
if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; } |
|
if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; } |
|
if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; } |
|
} |
|
|
|
# ------------------------------------------------------- second, check course |
|
if (defined($csec)) { |
|
if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; } |
|
if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; } |
|
if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; } |
|
} |
|
|
|
if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; } |
|
if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; } |
|
if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; } |
|
|
|
# ----------------------------------------------------- third, check map parms |
|
|
|
my $thisparm=$parmhash{$symbparm}; |
|
if (defined($thisparm)) { return $thisparm; } |
|
|
|
# ----------------------------------------------------- fourth , check default |
|
|
|
my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); |
|
if (defined($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 (defined($partgeneral)) { return $partgeneral; } |
|
} else { |
|
my $resourcegeneral=&parmval("0.$qualifier",$symb); |
|
if (defined($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.'"'; |
# Some data |
} |
|
|
|
|
|
sub addresource { |
sub cleanup { |
my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_; |
if (tied(%navmaphash)){ |
if ($showtypes eq 'problems') { |
&Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); |
if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) { |
unless (untie(%navmaphash)) { |
return; |
&Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash'); |
} |
} |
} |
} |
my $brepriv=&Apache::lonnet::allowed('bre',$resource); |
if (tied(%parmhash)){ |
if ($hash{'src_'.$rid}) { |
&Apache::lonnet::logthis('Cleanup navmaps: parmhash'); |
if (($brepriv eq '2') || ($brepriv eq 'F')) { |
unless (untie(%parmhash)) { |
my $pprefix=''; |
&Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); |
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; |
|
real_handler($r); |
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
|
|
|
if ($ENV{'form.jtest'} ne "1") |
|
{ |
|
return new_handle($r); |
|
} |
|
|
|
# ------------------------------------------- Set document type for header only |
|
|
|
if ($r->header_only) { |
|
if ($ENV{'browser.mathml'}) { |
|
$r->content_type('text/xml'); |
|
} else { |
|
$r->content_type('text/html'); |
|
} |
|
$r->send_http_header; |
|
return OK; |
|
} |
|
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 |
|
|
|
if ($ENV{'browser.mathml'}) { |
|
$r->content_type('text/xml'); |
|
} else { |
|
$r->content_type('text/html'); |
|
} |
|
&Apache::loncommon::no_cache($r); |
|
$r->send_http_header; |
|
|
|
my $firstres=$hash{'map_start_'. |
|
&Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
|
my $lastres=$hash{'map_finish_'. |
|
&Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
|
if (!(($firstres) && ($lastres))) { |
|
$r->print('<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'}; |
|
$currenturl=~s/^http\:\/\///; |
|
$currenturl=~s/^[^\/]+//; |
|
|
|
# ---------------------------------------------------------------- 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('<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 |
|
if ($code eq '3') { |
|
$add='<td bgcolor="#AAFFAA">'; |
|
} elsif ($code eq '4') { # partially correct |
|
$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 |
|
$add='<td bgcolor="#FFFFAA">'; |
|
} |
|
|
|
if ($tcode eq '4') { # due in next 24 hours |
|
$add='<td bgcolor="#FFFF33">'; |
|
$adde='</td>'; |
|
} |
|
} |
|
$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 { |
sub real_handler { |
my $r = shift; |
my $r = shift; |
|
|
|
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
|
|
# Handle header-only request |
# Handle header-only request |
if ($r->header_only) { |
if ($r->header_only) { |
if ($ENV{'browser.mathml'}) { |
if ($ENV{'browser.mathml'}) { |
Line 820 sub new_handle {
|
Line 102 sub new_handle {
|
&Apache::loncommon::no_cache($r); |
&Apache::loncommon::no_cache($r); |
$r->send_http_header; |
$r->send_http_header; |
|
|
# Initialize the nav map |
# Create the nav map |
my $navmap = Apache::lonnavmaps::navmap->new( |
my $navmap = Apache::lonnavmaps::navmap->new( |
$ENV{"request.course.fn"}.".db", |
$ENV{"request.course.fn"}.".db", |
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
Line 832 sub new_handle {
|
Line 114 sub new_handle {
|
return HTTP_NOT_ACCEPTABLE; |
return HTTP_NOT_ACCEPTABLE; |
} |
} |
|
|
|
$r->print("<html><head>\n"); |
|
$r->print("<title>Navigate Course Contents</title></head>"); |
|
|
# Header |
# Header |
$r->print(&Apache::loncommon::bodytag('Navigate Course Map','', |
$r->print(&Apache::loncommon::bodytag('Navigate Course Contents','', |
'')); |
'')); |
$r->print('<script>window.focus();</script>'); |
$r->print('<script>window.focus();</script>'); |
my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; |
|
if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); } |
|
my $date=localtime; |
|
$r->print("<h3>$date</h3>\n"); |
|
$r->rflush(); |
$r->rflush(); |
|
|
|
# Now that we've displayed some stuff to the user, init the navmap |
|
$navmap->init(); |
|
|
|
$r->print('<table border="0" cellpadding="2" cellspacing="0">'); |
|
my $date=localtime; |
|
$r->print('<tr><td align="right" valign="bottom">Key: </td>'); |
|
|
|
# Print discussions and feedback header |
if ($navmap->{LAST_CHECK}) { |
if ($navmap->{LAST_CHECK}) { |
$r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '. |
$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})). |
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); |
'</td><td align="center" valign="bottom"> '. |
|
'<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'. |
|
'</td>'); |
} else { |
} else { |
$r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'. |
$r->print('<td align="center" valign="bottom"> '. |
'<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); |
'<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; |
|
} |
|
|
|
# Determine where the "here" marker is and where the screen jumps to. |
|
my $hereType; # the type of marker, SYMB, URL, or NOTHING |
|
my $here; # the actual URL or SYMB for the here marker |
|
my $jumpType; # The type of the thing we have a jump for, SYMB or URL |
|
my $jump; # the SYMB/URL of the resource we need to jump to |
|
|
|
if ( $ENV{'form.alreadyHere'} ) { # we came from a user's manipulation of the nav page |
|
# If this is a click on a folder or something, we want to preserve the "here" |
|
# from the querystring, and get the new "jump" marker |
|
$hereType = $ENV{'form.hereType'}; |
|
$here = $ENV{'form.here'}; |
|
$jumpType = $ENV{'form.jumpType'} || NOTHING(); |
|
$jump = $ENV{'form.jump'}; |
|
} else { # the user is visiting the nav map from the remote |
|
# We're coming from the remote. We have either a url, a symb, or nothing, |
|
# and we need to figure out what. |
|
# Preference: Symb |
|
|
|
if ($ENV{'form.symb'}) { |
|
$hereType = $jumpType = SYMB(); |
|
$here = $jump = $ENV{'form.symb'}; |
|
} elsif ($ENV{'form.postdata'}) { |
|
# couldn't find a symb, is there a URL? |
|
my $currenturl = $ENV{'form.postdata'}; |
|
$currenturl=~s/^http\:\/\///; |
|
$currenturl=~s/^[^\/]+//; |
|
|
|
$hereType = $jumpType = URL; |
|
$here = $jump = $currenturl; |
|
} else { |
|
# Nothing |
|
$hereType = $jumpType = NOTHING(); |
|
} |
|
} |
|
|
|
|
|
# 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 = "&alreadyHere=1"; |
|
|
|
if ($condition) { |
|
$r->print("<a href=\"navmaps?condition=0&filter=&$queryAdd" . |
|
"&hereType=$hereType&here=" . Apache::lonnet::escape($here) . |
|
"\">Close All Folders</a>"); |
|
} else { |
|
$r->print("<a href=\"navmaps?condition=1&filter=&$queryAdd" . |
|
"&hereType=$hereType&here=" . Apache::lonnet::escape($here) . |
|
"\">Open All Folders</a>"); |
|
} |
|
|
|
$r->print('<br> '); |
|
$r->rflush(); |
|
|
# Check that it's defined |
# Check that it's defined |
if (!($navmap->courseMapDefined())) { |
if (!($navmap->courseMapDefined())) { |
Line 861 sub new_handle {
|
Line 219 sub new_handle {
|
# 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 => '', |
$res->CORRECT => '', |
$res->EXCUSED => '#BBBBFF', |
$res->EXCUSED => '#3333FF', |
$res->PAST_DUE_ANSWER_LATER => '', |
$res->PAST_DUE_ANSWER_LATER => '', |
$res->PAST_DUE_NO_ANSWER => '', |
$res->PAST_DUE_NO_ANSWER => '', |
$res->ANSWER_OPEN => '#CCFFCC', |
$res->ANSWER_OPEN => '#006600', |
$res->OPEN_LATER => '', |
$res->OPEN_LATER => '', |
$res->TRIES_LEFT => '', |
$res->TRIES_LEFT => '', |
$res->INCORRECT => '', |
$res->INCORRECT => '', |
Line 878 sub new_handle {
|
Line 239 sub new_handle {
|
# is not yet done and due in less then 24 hours |
# is not yet done and due in less then 24 hours |
my $hurryUpColor = "#FF0000"; |
my $hurryUpColor = "#FF0000"; |
|
|
|
# Keep these mappings in sync with lonquickgrades, which uses the colors |
|
# instead of the icons. |
my %statusIconMap = |
my %statusIconMap = |
( $res->NETWORK_FAILURE => '', |
( $res->NETWORK_FAILURE => '', |
$res->NOTHING_SET => '', |
$res->NOTHING_SET => '', |
Line 910 sub new_handle {
|
Line 273 sub new_handle {
|
} |
} |
} |
} |
|
|
my $currenturl = $ENV{'form.postdata'}; |
# Is this a new-style course? If so, we want to suppress showing the top-level |
$currenturl=~s/^http\:\/\///; |
# maps in their own folders, in favor of "inlining" them. |
$currenturl=~s/^[^\/]+//; |
my $topResource = $navmap->getById("0.0"); |
# 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"; |
|
|
|
$r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />'); |
|
|
|
# Begin the HTML table |
# Begin the HTML table |
# four cols: resource + indent, chat+feedback, icon, text string |
# four cols: resource + indent, chat+feedback, icon, text string |
$r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"); |
$r->print('<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"); |
|
|
my $condition = 0; |
|
if ($ENV{'form.condition'}) { |
|
$condition = 1; |
|
} |
|
|
|
# This needs to be updated to use symbs from the remote, |
# This needs to be updated to use symbs from the remote, |
# instead of uris. The changes to this and the main rendering |
# instead of uris. The changes to this and the main rendering |
# loop should be obvious. |
# loop should be obvious. |
# Here's a simple example of the iterator. |
# Here's a simple example of the iterator. |
# If there is a current resource |
# Preprocess the map: Look for current URL, force inlined maps to display |
if ($currenturl && !$ENV{'form.alreadyHere'}) { |
|
# Give me every resource... |
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); |
my $mapIterator = $navmap->getIterator(undef, undef, {}, 1); |
my $found = 0; |
my $found = 0; |
my $depth = 1; |
my $depth = 1; |
my $currentJumpIndex = 0; # keeps track of when the current resource is found, |
$mapIterator->next(); # discard the first BEGIN_MAP |
# so we can back up a few and put the anchor above the |
my $curRes = $mapIterator->next(); |
# current resource |
|
my $currentJumpDelta = 2; # change this to change how many resources are displayed |
while ($depth > 0 && !$found) { |
# before the current resource when using #current |
if (ref($curRes) && $curRes->src() eq $currenturl) { |
$mapIterator->next(); # discard the first BEGIN_MAP |
# If this is the correct resource, be sure to |
my $curRes = $mapIterator->next(); |
# show it by making sure the containing maps |
my $counter = 0; |
# are open. |
my $foundJump = ($jumpType == NOTHING()); # look for jump point if we have one |
|
my $looped = 0; |
my $mapStack = $mapIterator->getStack(); |
|
for my $map (@{$mapStack}) { |
# We only need to do this if we need to open the maps to show the |
if ($condition) { |
# current position. This will change the counter so we can't count |
undef $filterHash{$map->map_pc()}; |
# for the jump marker with this loop. |
} else { |
while ($depth > 0 && !$ENV{'form.alreadyHere'}) { |
$filterHash{$map->map_pc()} = 1; |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
} |
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
|
|
if (ref($curRes) && !$ENV{'form.alreadyHere'} && |
|
($hereType == SYMB() && $curRes->symb() eq $here) || |
|
(ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) { |
|
my $mapStack = $mapIterator->getStack(); |
|
|
|
# Ensure the parent maps are open |
|
for my $map (@{$mapStack}) { |
|
if ($condition) { |
|
undef $filterHash{$map->map_pc()}; |
|
} else { |
|
$filterHash{$map->map_pc()} = 1; |
} |
} |
$found = 1; |
|
} |
} |
$curRes = $mapIterator->next(); |
$ENV{'form.alreadyHere'} = 1; |
|
} |
|
$looped = 1; |
|
|
|
$curRes = $mapIterator->next(); |
|
} |
|
|
|
$mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0); |
|
$depth = 1; |
|
$mapIterator->next(); |
|
$curRes = $mapIterator->next(); |
|
|
|
while ($depth > 0 && !$foundJump) { |
|
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
if (ref($curRes)) { $counter++; } |
|
|
|
if (ref($curRes) && |
|
(($jumpType == SYMB() && $curRes->symb() eq $jump) || |
|
($jumpType == URL() && $curRes->src() eq $jump))) { |
|
# 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. |
|
$currentJumpIndex = $counter; |
|
$foundJump = 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 = 0; |
my $indentLevel = 0; |
my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />"; |
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 $now = time(); |
my $in24Hours = $now + 24 * 60 * 60; |
my $in24Hours = $now + 24 * 60 * 60; |
my $depth = 1; |
|
my $displayedHereMarker = 0; |
my $displayedHereMarker = 0; |
|
my $displayedJumpMarker = 0; |
|
|
# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" |
# We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" |
# code in iterator->next), so ignore the first one |
# code in iterator->next), so ignore the first one |
my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, |
$mapIterator = $navmap->getIterator(undef, undef, \%filterHash, |
$condition); |
$condition); |
$mapIterator->next(); |
$mapIterator->next(); |
my $curRes = $mapIterator->next(); |
$curRes = $mapIterator->next(); |
|
$depth = 1; |
|
|
|
my @backgroundColors = ("#FFFFFF", "#F6F6F6"); |
|
my $rowNum = 0; |
|
|
|
$counter = 0; |
|
|
while ($depth > 0) { |
while ($depth > 0) { |
if ($curRes == $mapIterator->BEGIN_MAP() || |
if ($curRes == $mapIterator->BEGIN_MAP() || |
Line 994 sub new_handle {
|
Line 390 sub new_handle {
|
if ($curRes == $mapIterator->BEGIN_BRANCH()) { |
if ($curRes == $mapIterator->BEGIN_BRANCH()) { |
$isNewBranch = 1; |
$isNewBranch = 1; |
} |
} |
if ($curRes == $mapIterator->BEGIN_MAP()) { |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
$depth++; |
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
} |
|
if ($curRes == $mapIterator->END_MAP()) { |
|
$depth--; |
|
} |
|
|
|
# Is this resource being blotted out? |
if (ref($curRes)) { $counter++; } |
if (ref($curRes) && !advancedUser() && $curRes->randomout()) { |
|
$curRes = $mapIterator->next(); |
|
next; # and totally ignore this resource |
|
} |
|
|
|
if (ref($curRes) && $curRes->src()) { |
if (ref($curRes)) { |
|
|
|
my $deltalevel = $isNewBranch? 1 : 0; # reserves space for branch icon |
|
|
|
if ($indentLevel - $deltalevel < 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 |
# Step one: Decide which parts to show |
my @parts = @{$curRes->parts()}; |
my @parts = @{$curRes->parts()}; |
Line 1015 sub new_handle {
|
Line 413 sub new_handle {
|
my $condensed = 0; |
my $condensed = 0; |
|
|
if ($curRes->is_problem()) { |
if ($curRes->is_problem()) { |
# Is it multipart? |
|
|
|
|
# Is it multipart? |
if ($multipart) { |
if ($multipart) { |
# If it's multipart, see if part 0 is "open" |
# If it's multipart, see if part 0 is "open" |
# if it is, display all parts, if it isn't, |
# if it is, display all parts, if it isn't, |
# just display first |
# just display first |
if (!$curRes->opendate("0")) { |
if (!$curRes->opendate("0")) { |
@parts = ("0"); # just display the zero-th part |
# no parts are open, display as one part |
|
@parts = ("0"); |
$condensed = 1; |
$condensed = 1; |
} else { |
} else { |
# Otherwise, only display part 0 if we want to |
# Otherwise, only display part 0 if we want to |
# attach feedback or email information to it |
# attach feedback or email information to it |
if ($curRes->hasDiscussion() || $curRes->getFeedback()) { |
if ($curRes->hasDiscussion() || $curRes->getFeedback()) { |
|
# Is this right? I think this will toss it |
|
# if it DOES have discussion, not if it doesn't? |
|
# - Jeremy (yes, commenting on his own code) |
shift @parts; |
shift @parts; |
} else { |
} else { |
# If there's discussion or feedback, that counts |
|
# as a difference, so display the parts. |
|
|
|
# Now, we decide whether to condense the |
# Now, we decide whether to condense the |
# parts due to similarity |
# parts due to similarity |
my $status = $curRes->status($parts[1]); |
my $status = $curRes->status($parts[1]); |
Line 1053 sub new_handle {
|
Line 452 sub new_handle {
|
} |
} |
} |
} |
|
|
# $allSame is true if all the statuses were |
# $*allSame is true if all the statuses were |
# the same. Now, if they are all the same and |
# the same. Now, if they are all the same and |
# match one of the statuses to condense, or they |
# match one of the statuses to condense, or they |
# are all open with the same due date, or they are |
# are all open with the same due date, or they are |
Line 1073 sub new_handle {
|
Line 472 sub new_handle {
|
} 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 |
# Is it a multipart problem with a single part, now in |
# @parts with "0" filtered out? If so, forget it's a multi-part |
# @parts with "0" filtered out? If so, 'forget' it's a multi-part |
# problem and treat it like a single-part problem. |
# problem and treat it like a single-part problem. |
if ( scalar(@parts) == 1 ) { |
if ( scalar(@parts) == 1 ) { |
$multipart = 0; |
$multipart = 0; |
Line 1085 sub new_handle {
|
Line 484 sub new_handle {
|
|
|
# Display one part, in event of network error. |
# Display one part, in event of network error. |
# If this is a single part, we can at least show the correct |
# If this is a single part, we can at least show the correct |
# status, but if it's multipart, we're lost. |
# status, but if it's multipart, we're lost, since we can't |
|
# retreive the metadata to count the parts |
if ($curRes->{RESOURCE_ERROR}) { |
if ($curRes->{RESOURCE_ERROR}) { |
@parts = ("0"); |
@parts = ("0"); |
} |
} |
|
|
# Step two: Show the parts |
# Step Two: Print the actual data. |
|
|
|
# For each part we intend to display... |
foreach my $part (@parts) { |
foreach my $part (@parts) { |
|
|
my $deltalevel = 0; # for inserting the branch icon |
|
my $nonLinkedText = ""; # unlinked stuff after title |
my $nonLinkedText = ""; # unlinked stuff after title |
|
|
# For each thing we're displaying... |
|
|
|
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(); |
|
if (!$title) { |
my $title = $curRes->compTitle(); |
$title = $curRes->src(); |
if ($src=~/^\/uploaded\//) { |
$title = substr ($title, rindex($title, "/") + 1); |
$nonLinkedText=$title; |
|
$title=''; |
} |
} |
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 = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">"; |
$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">"; |
$isNewBranch = 0; |
$isNewBranch = 0; |
$deltalevel = 1; |
|
} |
} |
|
|
# links to open and close the folders |
# links to open and close the folders |
Line 1147 sub new_handle {
|
Line 547 sub new_handle {
|
$linkopen .= ($nowOpen xor $condition) ? |
$linkopen .= ($nowOpen xor $condition) ? |
addToFilter(\%filterHash, $mapId) : |
addToFilter(\%filterHash, $mapId) : |
removeFromFilter(\%filterHash, $mapId); |
removeFromFilter(\%filterHash, $mapId); |
$linkopen .= "&condition=$condition&$queryAdd\">"; |
$linkopen .= "&condition=$condition&$queryAdd" . |
|
"&hereType=$hereType&here=" . |
|
Apache::lonnet::escape($here) . "&jumpType=".SYMB()."&" . |
|
"jump=" . Apache::lonnet::escape($curRes->symb()) ."\">"; |
$linkclose = "</a>"; |
$linkclose = "</a>"; |
|
|
} |
} |
Line 1155 sub new_handle {
|
Line 558 sub new_handle {
|
my $colorizer = ""; |
my $colorizer = ""; |
my $color; |
my $color; |
if ($curRes->is_problem()) { |
if ($curRes->is_problem()) { |
my $status = $curRes->status($part); |
$color = $colormap{$curRes->status}; |
$color = $colormap{$status}; |
|
|
|
# Special case in the navmaps: If in less then |
if (dueInLessThen24Hours($curRes, $part) || |
# 24 hours, give it a bit of urgency |
lastTry($curRes, $part)) { |
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, give a bit of urgency |
|
my $tries = $curRes->tries($part); |
|
my $maxtries = $curRes->maxtries($part); |
|
if ($tries && $maxtries && $maxtries > 1 && |
|
$maxtries - $tries == 1) { |
|
$color = $hurryUpColor; |
$color = $hurryUpColor; |
} |
} |
|
|
if ($color ne "") { |
if ($color ne "") { |
$colorizer = "bgcolor=\"$color\""; |
$colorizer = "bgcolor=\"$color\""; |
} |
} |
Line 1184 sub new_handle {
|
Line 574 sub new_handle {
|
$nonLinkedText .= ' <i>(hidden)</i> '; |
$nonLinkedText .= ' <i>(hidden)</i> '; |
} |
} |
|
|
# FIRST COL: The resource indentation, branch icon, and name |
$rowNum++; |
$r->print(" <tr><td align=\"left\" valign=\"center\" width=\"60%\">\n"); |
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\">\n"); |
|
|
|
# Print the anchor if necessary |
|
if ($counter == $currentJumpIndex - $currentJumpDelta ) { |
|
$r->print('<a name="curloc" />'); |
|
$displayedJumpMarker = 1; |
|
} |
|
|
# print indentation |
# print indentation |
for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) { |
for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) { |
Line 1198 sub new_handle {
|
Line 597 sub new_handle {
|
my $curMarkerEnd = ""; |
my $curMarkerEnd = ""; |
|
|
# Is this the current resource? |
# Is this the current resource? |
if ($curRes->src() eq $currenturl && !$displayedHereMarker) { |
if (!$displayedHereMarker && |
$curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">> </font>'; |
(($hereType == SYMB() && $curRes->symb eq $here) || |
|
($hereType == URL() && $curRes->src eq $here))) { |
|
$curMarkerBegin = '<font color="red" size="+2">> </font>'; |
$curMarkerEnd = '<font color="red" size="+2"> <</font>'; |
$curMarkerEnd = '<font color="red" size="+2"> <</font>'; |
$displayedHereMarker = 1; |
$displayedHereMarker = 1; |
} |
} |
Line 1214 sub new_handle {
|
Line 615 sub new_handle {
|
|
|
$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText"); |
$r->print(" $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText"); |
|
|
if ($curRes->{RESOURCE_ERROR}) { |
#if ($curRes->{RESOURCE_ERROR}) { |
$r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", |
# $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", |
'<font size="-1">Host down</font>')); |
# '<font size="-1">Host down</font>')); |
} |
# } |
|
|
my $discussionHTML = ""; my $feedbackHTML = ""; |
$r->print("</td>\n"); |
|
|
# SECOND COL: Is there text, feedback, errors?? |
# SECOND COL: Is there text, feedback, errors?? |
|
my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; |
|
|
if ($curRes->hasDiscussion()) { |
if ($curRes->hasDiscussion()) { |
$discussionHTML = $linkopen . |
$discussionHTML = $linkopen . |
'<img border="0" src="/adm/lonMisc/chat.gif" />' . |
'<img border="0" src="/adm/lonMisc/chat.gif" />' . |
Line 1240 sub new_handle {
|
Line 643 sub new_handle {
|
} |
} |
} |
} |
|
|
$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML </td>"); |
if ($curRes->getErrors()) { |
|
my $errors = $curRes->getErrors(); |
|
foreach (split(/,/, $errors)) { |
|
if ($_) { |
|
$errorHTML .= ' <a href="/adm/email?display=' |
|
. &Apache::lonnet::escape($_) . '">' |
|
. '<img src="/adm/lonMisc/bomb.gif" ' |
|
. 'border="0" /></a>'; |
|
} |
|
} |
|
} |
|
|
|
$r->print("<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>"); |
|
|
# Is this the first displayed part of a multi-part problem |
# Is this the first displayed part of a multi-part problem |
# that has not been condensed, so we should suppress these two |
# that has not been condensed, so we should suppress these two |
# columns? |
# columns so we don't display useless status info about part |
|
# "0"? |
my $firstDisplayed = !$condensed && $multipart && $part eq "0"; |
my $firstDisplayed = !$condensed && $multipart && $part eq "0"; |
|
|
# THIRD COL: Problem status icon |
# THIRD COL: Problem status icon |
Line 1262 sub new_handle {
|
Line 678 sub new_handle {
|
} |
} |
|
|
# FOURTH COL: Text description |
# FOURTH COL: Text description |
#$r->print("<td $colorizer align=\"right\" valign=\"center\">\n"); |
|
$r->print("<td align=\"right\" valign=\"center\">\n"); |
$r->print("<td align=\"right\" valign=\"center\">\n"); |
|
|
if ($curRes->kind() eq "res" && |
if ($curRes->kind() eq "res" && |
Line 1277 sub new_handle {
|
Line 692 sub new_handle {
|
} |
} |
|
|
$r->print(" </td></tr>\n"); |
$r->print(" </td></tr>\n"); |
|
|
|
if (!($counter % 20)) { $r->rflush(); } |
|
if ($counter == 2) { $r->rflush(); } |
} |
} |
} |
} |
$curRes = $mapIterator->next(); |
$curRes = $mapIterator->next(); |
} |
} |
|
|
$r->print("</table></body></html>"); |
$r->print("</table>"); |
|
|
|
# Print out the part that jumps to #curloc if it exists |
|
if ($displayedJumpMarker) { |
|
$r->print('<script>location += "#curloc";</script>'); |
|
} |
|
|
|
# renderer call |
|
$mapIterator = $navmap->getIterator(undef, undef, \%filterHash, 0); |
|
my $render = render({ 'cols' => [0,1,2,3], 'iterator' => $mapIterator, |
|
'url' => '/adm/navmaps', |
|
'queryString' => 'alreadyHere=1' }); |
|
$r->print('|' . $render . '|'); |
|
|
$navmap->untieHashes(); |
$navmap->untieHashes(); |
|
|
|
$r->print("</body></html>"); |
|
|
return OK; |
return OK; |
} |
} |
|
|
Line 1394 sub getDescription {
|
Line 826 sub getDescription {
|
} |
} |
} |
} |
|
|
|
# Convenience function, so others can use it: Is the problem due in less then |
|
# 24 hours, and still can be done? |
|
|
|
sub dueInLessThen24Hours { |
|
my $res = shift; |
|
my $part = shift; |
|
my $status = $res->status($part); |
|
|
|
return ($status == $res->OPEN() || $status == $res->ATTEMPTED() || |
|
$status == $res->TRIES_LEFT()) && |
|
$res->duedate() && $res->duedate() < time()+(24*60*60) && |
|
$res->duedate() > time(); |
|
} |
|
|
|
# Convenience function, so others can use it: Is there only one try remaining for the |
|
# part, with more then one try to begin with, not due yet and still can be done? |
|
sub lastTry { |
|
my $res = shift; |
|
my $part = shift; |
|
|
|
my $tries = $res->tries($part); |
|
my $maxtries = $res->maxtries($part); |
|
return $tries && $maxtries && $maxtries > 1 && |
|
$maxtries - $tries == 1 && $res->duedate() && |
|
$res->duedate() > time(); |
|
} |
|
|
|
# This puts a human-readable name on the ENV variable. |
sub advancedUser { |
sub advancedUser { |
return $ENV{'user.adv'}; |
return $ENV{'user.adv'}; |
} |
} |
Line 1439 sub timeToHumanString {
|
Line 899 sub timeToHumanString {
|
$delta = -$delta; |
$delta = -$delta; |
} |
} |
|
|
# Is it in the future? |
|
if ( $delta > 0 ) { |
if ( $delta > 0 ) { |
# Is it less then a minute away? |
|
my $tense = $inPast ? " ago" : ""; |
my $tense = $inPast ? " ago" : ""; |
my $prefix = $inPast ? "" : "in "; |
my $prefix = $inPast ? "" : "in "; |
|
|
|
# Less then a minute |
if ( $delta < $minute ) { |
if ( $delta < $minute ) { |
if ($delta == 1) { return "${prefix}1 second$tense"; } |
if ($delta == 1) { return "${prefix}1 second$tense"; } |
return "$prefix$delta seconds$tense"; |
return "$prefix$delta seconds$tense"; |
} |
} |
|
|
# Is it less then an hour away? |
# Less then an hour |
if ( $delta < $hour ) { |
if ( $delta < $hour ) { |
# If so, use minutes |
# If so, use minutes |
my $minutes = floor($delta / 60); |
my $minutes = floor($delta / 60); |
Line 1503 sub timeToHumanString {
|
Line 964 sub timeToHumanString {
|
} |
} |
} |
} |
|
|
|
|
|
=pod |
|
|
|
=head1 navmap renderer |
|
|
|
The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this. |
|
|
|
Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors. |
|
|
|
The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}). |
|
|
|
=head2 Overview of Columns |
|
|
|
The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table. |
|
|
|
Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer. |
|
|
|
At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it. |
|
|
|
The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist: |
|
|
|
=over 4 |
|
|
|
=item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash: |
|
|
|
=over 4 |
|
|
|
=item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links. |
|
|
|
=item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count. |
|
|
|
=back |
|
|
|
=item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map. |
|
|
|
=item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap. |
|
|
|
=item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap. |
|
|
|
=back |
|
|
|
If you add any others please be sure to document them here. |
|
|
|
An example of a column renderer that will show the ID number of a resource, along with the part name if any: |
|
|
|
sub { |
|
my ($resource, $part, $params) = @_; |
|
if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; } |
|
return '<td>' . $resource->{ID} . '</td>'; |
|
} |
|
|
|
Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc. |
|
|
|
=head2 Parameters |
|
|
|
=over 4 |
|
|
|
=item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like. |
|
|
|
=item * B<cols>: An array reference |
|
|
|
=item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed. |
|
|
|
=item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored. |
|
|
|
=item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL. |
|
|
|
=item * B<hereURL>: A URL identifying where to place the 'here' marker. |
|
|
|
=item * B<hereSymb>: A Symb identifying where to place the 'here' marker. |
|
|
|
=item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. |
|
|
|
=item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed. |
|
|
|
=item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown. |
|
|
|
=back |
|
|
|
=head2 Additional Info |
|
|
|
In addition to the parameters you can pass to the renderer, which will be passed through unchange to the column renderers, the renderer will generate the following information which your renderer may find useful: |
|
|
|
=over 4 |
|
|
|
=back |
|
|
|
=cut |
|
|
|
sub resource { return 0; } |
|
sub communication_status { return 1; } |
|
sub quick_status { return 2; } |
|
sub long_status { return 3; } |
|
|
|
# Data for render_resource |
|
|
|
my $resObj = 'Apache::lonnavmaps::resource'; |
|
# Defines a status->color mapping, null string means don't color |
|
my %colormap = |
|
( $resObj->NETWORK_FAILURE => '', |
|
$resObj->CORRECT => '', |
|
$resObj->EXCUSED => '#3333FF', |
|
$resObj->PAST_DUE_ANSWER_LATER => '', |
|
$resObj->PAST_DUE_NO_ANSWER => '', |
|
$resObj->ANSWER_OPEN => '#006600', |
|
$resObj->OPEN_LATER => '', |
|
$resObj->TRIES_LEFT => '', |
|
$resObj->INCORRECT => '', |
|
$resObj->OPEN => '', |
|
$resObj->NOTHING_SET => '' ); |
|
# And a special case in the nav map; what to do when the assignment |
|
# is not yet done and due in less then 24 hours |
|
my $hurryUpColor = "#FF0000"; |
|
|
|
sub render_resource { |
|
my ($resource, $part, $params) = @_; |
|
|
|
my $nonLinkedText = ''; # stuff after resource title not in link |
|
|
|
my $it = $params->{'iterator'}; |
|
my $filter = $it->{FILTER}; |
|
my $stack = $it->getStack(); |
|
my $src = getLinkForResource($stack); |
|
|
|
my $srcHasQuestion = $src =~ /\?/; |
|
my $link = $src. |
|
($srcHasQuestion?'&':'?') . |
|
'symb=' . &Apache::lonnet::escape($resource->symb()). |
|
'"'; |
|
|
|
my $title = $resource->compTitle(); |
|
if ($src =~ /^\/uploaded\//) { |
|
$nonLinkedText=$title; |
|
$title = ''; |
|
} |
|
my $partLabel = ""; |
|
my $newBranchText = ""; |
|
|
|
# If this is a new branch, label it so |
|
if ($params->{'isNewBranch'}) { |
|
$newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />"; |
|
$params->{'isNewBranch'} = 0; |
|
} |
|
|
|
# links to open and close the folder |
|
my $linkopen = "<a href='$link'>"; |
|
my $linkclose = "</a>"; |
|
|
|
# Default icon: HTML page |
|
my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />"; |
|
|
|
if ($resource->is_problem()) { |
|
if ($part eq "0" || $params->{'condensed'}) { |
|
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />'; |
|
} else { |
|
$icon = $params->{'indentString'}; |
|
} |
|
} |
|
|
|
# Display the correct map icon to open or shut map |
|
if ($resource->is_map()) { |
|
my $mapId = $resource->map_pc(); |
|
my $nowOpen = !defined($filter->{$mapId}); |
|
if ($it->{CONDITION}) { |
|
$nowOpen = !$nowOpen; |
|
} |
|
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; |
|
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
|
|
|
$linkopen = "<a href='" . $params->{'url'} . '?' . |
|
$params->{'queryString'} . '&filter='; |
|
$linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
|
addToFilter($filter, $mapId) : |
|
removeFromFilter($filter, $mapId); |
|
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
|
. $params->{'hereType'} . '&here=' . |
|
&Apache::lonnet::escape($params->{'here'}) . |
|
'&jumpType=' . SYMB() . '&jump=' . |
|
&Apache::lonnet::escape($params->{$resource->symb()}) . "'>"; |
|
} |
|
|
|
if ($resource->randomout()) { |
|
$nonLinkedText .= ' <i>(hidden)</i> '; |
|
} |
|
|
|
# We're done preparing and finally ready to start the rendering |
|
my $result = "<td align='left' valign='center'>"; |
|
|
|
# print indentation |
|
for (my $i = 0; $i < $params->{'indentLevel'} - |
|
$params->{'deltaLevel'}; $i++) { |
|
$result .= $params->{'indentString'}; |
|
} |
|
|
|
# Decide what to display |
|
$result .= "$newBranchText$linkopen$icon$linkclose"; |
|
|
|
my $curMarkerBegin = ''; |
|
my $curMarkerEnd = ''; |
|
|
|
# Is this the current resource? |
|
if (!$params->{'displayedHereMarker'} && |
|
(($params->{'hereType'} == SYMB() && |
|
$resource->symb() eq $params->{'here'}) || |
|
($params->{'hereType'} == URL() && |
|
$resource->src() eq $params->{'here'}))) { |
|
$curMarkerBegin = '<font color="red" size="+2">> </font>'; |
|
$curMarkerEnd = '<font color="red" size="+2"><</font>'; |
|
} |
|
|
|
if ($resource->is_problem() && $part ne "0" && |
|
!$params->{'condensed'}) { |
|
$partLabel = " (Part $part)"; |
|
$title = ""; |
|
} |
|
|
|
if ($params->{'multipart'} && $params->{'condensed'}) { |
|
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; |
|
} |
|
|
|
$result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText"; |
|
|
|
return $result; |
|
} |
|
|
|
sub render_communication_status { |
|
my ($resource, $part, $params) = @_; |
|
return "<td align='center'>comm_status</td>"; |
|
} |
|
sub render_quick_status { |
|
my ($resource, $part, $params) = @_; |
|
return "<td align='center'>quick_status</td>"; |
|
} |
|
sub render_long_status { |
|
my ($resource, $part, $params) = @_; |
|
return "<td align='center'>long_status</td>"; |
|
} |
|
|
|
my @preparedColumns = (\&render_resource, \&render_communication_status, |
|
\&render_quick_status, \&render_long_status); |
|
|
|
sub setDefault { |
|
my ($val, $default) = @_; |
|
if (!defined($val)) { return $default; } |
|
return $val; |
|
} |
|
|
|
sub render { |
|
my $args = shift; |
|
|
|
# Configure the renderer. |
|
my $cols = $args->{'cols'}; |
|
if (!defined($cols)) { |
|
# no columns, no nav maps. |
|
return ''; |
|
} |
|
my $it = $args->{'iterator'}; |
|
if (!defined($it)) { |
|
# no iterator, no nav map. |
|
return ''; |
|
} |
|
|
|
my $showParts = setDefault($args->{'showParts'}, 1); |
|
my $condenseParts = setDefault($args->{'condenseParts'}, 1); |
|
my $jumpToURL = $args->{'jumpToURL'}; |
|
my $jumpToSymb = $args->{'jumpToSymb'}; |
|
my $hereURL = $args->{'hereURL'}; |
|
my $hereSymb = $args->{'hereSymb'}; |
|
|
|
#if (defined($jumpToURL)) { |
|
# $args->{'jumpType'} = |
|
|
|
# End parameter setting |
|
|
|
# Data |
|
my $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"; |
|
my $res = "Apache::lonnavmaps::resource"; |
|
my %condenseStatuses = |
|
( $res->NETWORK_FAILURE => 1, |
|
$res->NOTHING_SET => 1, |
|
$res->CORRECT => 1 ); |
|
my @backgroundColors = ("#FFFFFF", "#F6F6F6"); |
|
my $currentJumpIndex = 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 $currentJumpDelta = 2; # change this to change how many resources are displayed |
|
# before the current resource when using #current |
|
|
|
# Shared variables |
|
$args->{'counter'} = 0; # counts the rows |
|
$args->{'indentLevel'} = 0; |
|
$args->{'isNewBranch'} = 0; |
|
$args->{'condensed'} = 0; |
|
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />"); |
|
$args->{'displayedHereMarker'} = 0; |
|
|
|
my $displayedJumpMarker = 0; |
|
# Set up iteration. |
|
my $depth = 1; |
|
$it->next(); # discard initial BEGIN_MAP |
|
my $curRes = $it->next(); |
|
my $now = time(); |
|
my $in24Hours = $now + 24 * 60 * 60; |
|
my $rownum = 0; |
|
|
|
while ($depth > 0) { |
|
if ($curRes == $it->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $it->END_MAP()) { $depth--; } |
|
|
|
# Maintain indentation level. |
|
if ($curRes == $it->BEGIN_MAP() || |
|
$curRes == $it->BEGIN_BRANCH() ) { |
|
$args->{'indentLevel'}++; |
|
} |
|
if ($curRes == $it->END_MAP() || |
|
$curRes == $it->END_BRANCH() ) { |
|
$args->{'indentLevel'}--; |
|
} |
|
# Notice new branches |
|
if ($curRes == $it->BEGIN_BRANCH()) { |
|
$args->{'isNewBranch'} = 1; |
|
} |
|
|
|
# If this isn't an actual resource, continue on |
|
if (!ref($curRes)) { |
|
$curRes = $it->next(); |
|
next; |
|
} |
|
|
|
$args->{'counter'}++; |
|
# reserve space for branch symbol |
|
$args->{'deltalevel'} = $args->{'isNewBranch'}? 1 : 0; |
|
if ($args->{'indentLevel'} - $args->{'deltalevel'} < 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 = $it->next(); |
|
next; |
|
} |
|
|
|
# Does it have multiple parts? |
|
$args->{'multipart'} = 0; |
|
$args->{'condensed'} = 0; |
|
my @parts; |
|
|
|
# Decide what parts to show. |
|
if ($curRes->is_problem() && $showParts) { |
|
@parts = @{$curRes->parts()}; |
|
$args->{'multipart'} = scalar(@parts) > 1; |
|
|
|
if ($condenseParts) { # do the condensation |
|
if (!$curRes->opendate("0")) { |
|
@parts = ("0"); |
|
$args->{'condensed'} = 1; |
|
} |
|
if (!$args->{'condensed'}) { |
|
# Decide whether to condense based on 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]); |
|
$args->{'condensed'} = 1; |
|
} |
|
|
|
} |
|
} |
|
|
|
} else { |
|
# Not showing parts |
|
@parts = ("0"); # show main part only |
|
} |
|
|
|
# If the multipart problem was condensed, "forget" it was multipart |
|
if (scalar(@parts) == 1) { |
|
$args->{'multipart'} = 0; |
|
} |
|
|
|
# In the event of a network error, display one part. |
|
# 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"); |
|
} |
|
|
|
# Now, we've decided what parts to show. Loop through them and |
|
# show them. |
|
foreach my $part (@parts) { |
|
$rownum ++; |
|
my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)]; |
|
|
|
$result .= " <tr bgcolor='$backgroundColor'>\n"; |
|
|
|
# Now, display each column. |
|
foreach my $col (@$cols) { |
|
$result .= " <td>"; |
|
|
|
# If this is the first column and it's time to print |
|
# the anchor, do so |
|
if ($col == $cols->[0] && |
|
$args->{'counter'} == $args->{'currentJumpIndex'} - |
|
$args->{'currentJumpDelta'}) { |
|
$result .= '<a name="curloc" />'; |
|
$displayedJumpMarker = 1; |
|
} |
|
|
|
|
|
if (ref($col)) { |
|
$result .= &$col($curRes, $part, $args); |
|
} else { |
|
$result .= &{$preparedColumns[$col]}($curRes, $part, $args); |
|
} |
|
|
|
$result .= "</td>\n"; |
|
} |
|
|
|
$result .= " </tr>\n"; |
|
} |
|
|
|
|
|
$curRes = $it->next(); |
|
} |
|
|
|
$result .= "</table>"; |
|
|
|
return $result; |
|
} |
|
|
1; |
1; |
|
|
package Apache::lonnavmaps::navmap; |
package Apache::lonnavmaps::navmap; |
|
|
=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, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere. |
|
|
=head1 navmap object: Encapsulating the compiled nav map |
=head1 navmap object: Encapsulating the compiled nav map |
|
|
Line 1543 sub new {
|
Line 1456 sub new {
|
$self->{GENERATE_COURSE_USER_OPT} = shift; |
$self->{GENERATE_COURSE_USER_OPT} = shift; |
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = 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 1552 sub new {
|
Line 1465 sub new {
|
$self->{NETWORK_FAILURE} = 0; |
$self->{NETWORK_FAILURE} = 0; |
|
|
# tie the nav hash |
# tie the nav hash |
my %navmaphash; |
|
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
&GDBM_READER(), 0640))) { |
&GDBM_READER(), 0640))) { |
return undef; |
return undef; |
} |
} |
$self->{NAV_HASH} = \%navmaphash; |
|
|
|
my %parmhash; |
|
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}; |
untie $self->{PARM_HASH}; |
return undef; |
return undef; |
} |
} |
$self->{PARM_HASH} = \%parmhash; |
|
$self->{HASH_TIED} = 1; |
$self->{HASH_TIED} = 1; |
|
$self->{NAV_HASH} = \%navmaphash; |
|
$self->{PARM_HASH} = \%parmhash; |
|
|
|
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 |
Line 1581 sub new {
|
Line 1502 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 1632 sub new {
|
Line 1553 sub new {
|
my %emailstatus = &Apache::lonnet::dump('email_status'); |
my %emailstatus = &Apache::lonnet::dump('email_status'); |
my $logoutTime = $emailstatus{'logout'}; |
my $logoutTime = $emailstatus{'logout'}; |
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
$self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? |
$self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ? |
$courseLeaveTime : $logoutTime); |
$courseLeaveTime : $logoutTime); |
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
$cdom, $cnum); |
$cdom, $cnum); |
Line 1673 sub new {
|
Line 1594 sub new {
|
} |
} |
|
|
$self->{PARM_CACHE} = {}; |
$self->{PARM_CACHE} = {}; |
|
} |
bless($self); |
|
|
# Internal function: Takes a key to look up in the nav hash and implements internal |
return $self; |
# memory caching of that key. |
|
sub navhash { |
|
my $self = shift; my $key = shift; |
|
return $self->{NAV_HASH}->{$key}; |
} |
} |
|
|
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
Line 1684 sub courseMapDefined {
|
Line 1608 sub courseMapDefined {
|
my $self = shift; |
my $self = shift; |
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
|
|
my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; |
my $firstres = $self->navhash("map_start_$uri"); |
my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; |
my $lastres = $self->navhash("map_finish_$uri"); |
return $firstres && $lastres; |
return $firstres && $lastres; |
} |
} |
|
|
Line 1710 sub DESTROY {
|
Line 1634 sub DESTROY {
|
$self->untieHashes(); |
$self->untieHashes(); |
} |
} |
|
|
# Private function: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
# current discussion? Returns 0 if chat/mail data not extracted. |
# current discussion? Returns 0 if chat/mail data not extracted. |
sub hasDiscussion { |
sub hasDiscussion { |
my $self = shift; |
my $self = shift; |
my $symb = shift; |
my $symb = shift; |
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
|
|
|
#return defined($self->{DISCUSSION_TIME}->{$symb}); |
return $self->{DISCUSSION_TIME}->{$symb} > |
return $self->{DISCUSSION_TIME}->{$symb} > |
$self->{LAST_CHECK}; |
$self->{LAST_CHECK}; |
} |
} |
|
|
# Private function: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
# current feedback? Returns the string in the feedback hash, which |
# current feedback? Returns the string in the feedback hash, which |
# will be false if it does not exist. |
# will be false if it does not exist. |
sub getFeedback { |
sub getFeedback { |
Line 1733 sub getFeedback {
|
Line 1658 sub getFeedback {
|
return $self->{FEEDBACK}->{$symb}; |
return $self->{FEEDBACK}->{$symb}; |
} |
} |
|
|
|
# Private method: Get the errors for that resource (by source). |
|
sub getErrors { |
|
my $self = shift; |
|
my $src = shift; |
|
|
|
if (!defined($self->{ERROR_MSG})) { return ""; } |
|
return $self->{ERROR_MSG}->{$src}; |
|
} |
|
|
=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 1754 sub getById {
|
Line 1688 sub getById {
|
} |
} |
|
|
# resource handles inserting itself into cache. |
# resource handles inserting itself into cache. |
return Apache::lonnavmaps::resource->new($self, $id); |
# Not clear why the quotes are necessary, but as of this |
|
# writing it doesn't work without them. |
|
return "Apache::lonnavmaps::resource"->new($self, $id); |
} |
} |
|
|
=pod |
=pod |
Line 1765 sub getById {
|
Line 1701 sub getById {
|
|
|
sub firstResource { |
sub firstResource { |
my $self = shift; |
my $self = shift; |
my $firstResource = $self->{NAV_HASH}->{'map_start_' . |
my $firstResource = $self->navhash('map_start_' . |
&Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
return $self->getById($firstResource); |
return $self->getById($firstResource); |
} |
} |
|
|
Line 1778 sub firstResource {
|
Line 1714 sub firstResource {
|
|
|
sub finishResource { |
sub finishResource { |
my $self = shift; |
my $self = shift; |
my $firstResource = $self->{NAV_HASH}->{'map_finish_' . |
my $firstResource = $self->navhash('map_finish_' . |
&Apache::lonnet::clutter($ENV{'request.course.uri'})}; |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
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)=@_; |
Line 1887 sub parmval_real {
|
Line 1817 sub parmval_real {
|
return ''; |
return ''; |
} |
} |
|
|
|
|
1; |
1; |
|
|
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 1916 getIterator behaves as follows:
|
Line 1841 getIterator behaves as follows:
|
|
|
=over 4 |
=over 4 |
|
|
=item B<getIterator>(firstResource, finishResource, filterHash, condition): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to. |
=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): 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. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content. |
|
|
Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown. |
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: |
|
|
Line 1936 The iterator will return either a refere
|
Line 1861 The iterator will return either a refere
|
|
|
The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. |
The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP. |
|
|
|
Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned. |
|
|
=back |
=back |
|
|
=cut |
=cut |
Line 1946 sub BEGIN_MAP { return 1; } # beginin
|
Line 1873 sub BEGIN_MAP { return 1; } # beginin
|
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; } |
|
|
|
sub min { |
|
(my $a, my $b) = @_; |
|
if ($a < $b) { return $a; } else { return $b; } |
|
} |
|
|
# Params: nav map, start resource, end resource, filter, condition, |
# In the CVS repository, documentation of this algorithm is included |
# already seen hash ref |
# 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 1977 sub new {
|
Line 1913 sub new {
|
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; |
$self->{CONDITION} = shift; |
$self->{CONDITION} = shift; |
|
|
# Flag: Have we started yet? If not, the first action is to return BEGIN_MAP. |
# Do we want to automatically follow "redirection" maps? |
|
$self->{FORCE_TOP} = 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. |
|
|
|
# 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 |
|
|
|
# If there is only one resource in this map, and it's a map, we |
|
# want to remember that, so the user can ask for the first map |
|
# that isn't just a redirector. |
|
my $resource; my $resourceCount = 0; |
|
|
|
# **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)) { |
|
# If there's only one resource, this will save it |
|
# we have to filter empty resources from consideration here, |
|
# or even "empty", redirecting maps have two (start & finish) |
|
# or three (start, finish, plus redirector) |
|
if($direction == FORWARD && $curRes->src()) { |
|
$resource = $curRes; $resourceCount++; |
|
} |
|
my $resultingVal = $curRes->{DATA}->{$valName}; |
|
my $nextResources = $curRes->$nextResourceMethod(); |
|
my $nextCount = scalar(@{$nextResources}); |
|
|
|
if ($nextCount == 1) { # **3** |
|
my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999; |
|
$nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current); |
|
} |
|
|
|
if ($nextCount > 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(); |
|
} |
|
} |
|
|
|
# Check: Was this only one resource, a map? |
|
if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) { |
|
my $firstResource = $resource->map_start(); |
|
my $finishResource = $resource->map_finish(); |
|
return |
|
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
|
$finishResource, $self->{FILTER}, |
|
$self->{ALREADY_SEEN}, |
|
$self->{CONDITION}, 0); |
|
|
|
} |
|
|
|
# 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}); |
|
} |
|
|
|
# If this is a blank resource, don't actually return it. |
|
# Should you ever find you need it, make sure to add an option to the code |
|
# that you can use; other things depend on this behavior. |
|
if (!$self->{HERE}->src() || !$self->{HERE}->browsePriv()) { |
|
return $self->next(); |
|
} |
|
|
|
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 |
|
|
|
# Unlike the main iterator, this DOES return all resources, even blank ones. |
|
# The main iterator needs them to correctly preprocess the map. |
|
|
|
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 1991 sub new {
|
Line 2261 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 |
|
|
|
# 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 2034 sub next {
|
Line 2295 sub next {
|
return $next; |
return $next; |
} |
} |
|
|
# Is this return value pre-determined? |
|
if (defined($self->{FORCE_NEXT})) { |
|
my $tmp = $self->{FORCE_NEXT}; |
|
$self->{FORCE_NEXT} = undef; |
|
return $tmp; |
|
} |
|
|
|
# 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 2060 sub next {
|
Line 2308 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; |
|
|
# 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}--; |
|
} |
|
} |
|
|
|
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) |
Line 2145 sub next {
|
Line 2344 sub next {
|
my $finishResource = $self->{HERE}->map_finish(); |
my $finishResource = $self->{HERE}->map_finish(); |
|
|
$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}, |
$self->{CONDITION}); |
$self->{CONDITION}, $self->{DIRECTION}); |
} |
} |
|
|
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 2241 sub navHash {
|
Line 2412 sub navHash {
|
my $self = shift; |
my $self = shift; |
my $param = shift; |
my $param = shift; |
my $id = shift; |
my $id = shift; |
return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; |
return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:"")); |
} |
} |
|
|
=pod |
=pod |
|
|
B<Metadata Retreival> |
B<Metadata Retreival> |
|
|
These are methods that help you retrieve metadata about the resource: |
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 |
=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<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<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<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. |
=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<randompick>: Returns true for a map if the randompick feature is being used on the map. (?) |
|
|
Line 2301 sub symb {
|
Line 2474 sub symb {
|
} |
} |
sub title { my $self=shift; return $self->navHash("title_", 1); } |
sub title { my $self=shift; return $self->navHash("title_", 1); } |
sub to { my $self=shift; return $self->navHash("to_", 1); } |
sub to { my $self=shift; return $self->navHash("to_", 1); } |
|
sub compTitle { |
|
my $self = shift; |
|
my $title = $self->title(); |
|
if (!$title) { |
|
$title = $self->src(); |
|
$title = substr($title, rindex($title, '/') + 1); |
|
} |
|
return $title; |
|
} |
=pod |
=pod |
|
|
B<Predicate Testing the Resource> |
B<Predicate Testing the Resource> |
Line 2318 These methods are shortcuts to deciding
|
Line 2499 These methods are shortcuts to deciding
|
|
|
=item * B<is_problem>: Returns true if the resource is a problem. |
=item * B<is_problem>: Returns true if the resource is a problem. |
|
|
=item * B<is_sequence>: Returns true if the resource sequence. |
=item * B<is_sequence>: Returns true if the resource is a sequence. |
|
|
=back |
=back |
|
|
Line 2347 sub is_sequence {
|
Line 2528 sub is_sequence {
|
return ($src =~ /sequence$/); |
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 2466 sub answerdate {
|
Line 2642 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 2490 sub tol {
|
Line 2667 sub tol {
|
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("tol", $part); |
return $self->parmval("tol", $part); |
} |
} |
sub tries { |
sub tries { |
my $self = shift; |
my $self = shift; |
my $part = shift; |
my $tries = $self->queryRestoreHash('tries', shift); |
$part = '0' if (!defined($part)); |
if (!defined($tries)) { return '0';} |
|
|
# 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; |
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); |
} |
} |
|
|
Line 2562 sub hasDiscussion {
|
Line 2733 sub hasDiscussion {
|
|
|
sub getFeedback { |
sub getFeedback { |
my $self = shift; |
my $self = shift; |
return $self->{NAV_MAP}->getFeedback($self->src()); |
my $source = $self->src(); |
|
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
|
return $self->{NAV_MAP}->getFeedback($source); |
|
} |
|
|
|
sub getErrors { |
|
my $self = shift; |
|
my $source = $self->src(); |
|
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
|
return $self->{NAV_MAP}->getErrors($source); |
} |
} |
|
|
=pod |
=pod |
Line 2635 sub extractParts {
|
Line 2815 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 2652 Idiomatic usage of these two methods wou
|
Line 2832 Idiomatic usage of these two methods wou
|
... 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. The possible return values are: |
=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: |
Line 2765 sub ATTEMPTED { return 16; }
|
Line 2949 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 2784 sub getCompletionStatus {
|
Line 2963 sub getCompletionStatus {
|
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 |
|
|
Line 2892 sub status {
|
Line 3083 sub status {
|
|
|
=over 4 |
=over 4 |
|
|
=item * B<getNext>($alreadySeenHashRef): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case. The "alreadySeenHashRef" is an optional parameter that can be passed in to the method. If $$alreadySeenHashRef{$res->id()} is true in that hash, getNext will not return it in the list. In other words, you can use it to suppress resources you've already seen in the getNext method directly. |
=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. |
|
|
=item * B<getPrevious>($alreadySeenHashRef): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. $alreadySeenHashRef is the same as in getNext. |
=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. |
|
|
=cut |
=cut |
|
|
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) ) { |
Line 2908 sub getNext {
|
Line 3098 sub getNext {
|
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 or if |
push @branches, $next; |
# the student doesn't have browse priviledges |
|
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
if (!defined($alreadySeenHash) || |
|
!defined($alreadySeenHash->{$next->{ID}}) || |
|
($browsePriv ne '2' && $browsePriv ne 'F')) { |
|
push @branches, $next; |
|
} |
|
} |
} |
return \@branches; |
return \@branches; |
} |
} |
|
|
sub getPrevious { |
sub getPrevious { |
my $self = shift; |
my $self = shift; |
my $alreadySeenHash = shift; |
|
my @branches; |
my @branches; |
my $from = $self->from(); |
my $from = $self->from(); |
foreach my $branch ( split /,/, $from) { |
foreach my $branch ( split /,/, $from) { |
Line 2930 sub getPrevious {
|
Line 3112 sub getPrevious {
|
my $prev = $choice->comesfrom(); |
my $prev = $choice->comesfrom(); |
$prev = $self->{NAV_MAP}->getById($prev); |
$prev = $self->{NAV_MAP}->getById($prev); |
|
|
# Skip it if we've already seen it or the user doesn't have |
push @branches, $prev; |
# browse privs |
|
my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); |
|
if (!defined($alreadySeenHash) || |
|
!defined($alreadySeenHash->{$prev->{ID}}) || |
|
($browsePriv ne '2' && $browsePriv ne 'F')) { |
|
push @branches, $prev; |
|
} |
|
} |
} |
return \@branches; |
return \@branches; |
} |
} |
|
|
|
sub browsePriv { |
|
my $self = shift; |
|
if (defined($self->{BROWSE_PRIV})) { |
|
return $self->{BROWSE_PRIV}; |
|
} |
|
|
|
$self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src()); |
|
} |
|
|
=pod |
=pod |
|
|
=back |
=back |