--- loncom/interface/lonnavmaps.pm 2002/11/01 18:24:45 1.94 +++ loncom/interface/lonnavmaps.pm 2003/02/28 16:16:59 1.150 @@ -2,7 +2,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.94 2002/11/01 18:24:45 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.150 2003/02/28 16:16:59 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -37,767 +37,87 @@ # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer # YEAR=2002 # 1/1 Gerd Kortemeyer -# +# Oct-Nov Jeremy Bowers package Apache::lonnavmaps; use strict; use Apache::Constants qw(:common :http); -use Apache::lonnet(); use Apache::loncommon(); -use GDBM_File; +use Apache::lonmenu(); use POSIX qw (floor strftime); -# -------------------------------------------------------------- Module Globals -my %hash; -my @rows; - -# -# These cache hashes need to be independent of user, resource and course -# (user and course can/should be in the keys) -# - -my %courserdatas; -my %userrdatas; - -# -# These global hashes are dependent on user, course and resource, -# and need to be initialized every time when a sheet is calculated -# -my %courseopt; -my %useropt; +my %navmaphash; my %parmhash; -# This parameter keeps track of whether obtaining the user's information -# failed, which the colorizer in astatus can use -my $networkFailedFlag = 0; - -# ------------------------------------------------------------------ Euclid gcd - -sub euclid { - my ($e,$f)=@_; - my $a; my $b; my $r; - if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; } - while ($r!=0) { - $a=$b; $b=$r; - $r=$a%$b; - } - return $b; -} - -# --------------------------------------------------------------------- Parmval - -# -------------------------------------------- Figure out a cascading parameter -# -# For this function to work -# -# * parmhash needs to be tied -# * courseopt and useropt need to be initialized for this user and course -# - -sub parmval { - my ($what,$symb)=@_; - my $cid=$ENV{'request.course.id'}; - my $csec=$ENV{'request.course.sec'}; - my $uname=$ENV{'user.name'}; - my $udom=$ENV{'user.domain'}; - - unless ($symb) { return ''; } - my $result=''; - - my ($mapname,$id,$fn)=split(/\_\_\_/,$symb); - -# ----------------------------------------------------- Cascading lookup scheme - my $rwhat=$what; - $what=~s/^parameter\_//; - $what=~s/\_/\./; - - my $symbparm=$symb.'.'.$what; - my $mapparm=$mapname.'___(all).'.$what; - my $usercourseprefix=$uname.'_'.$udom.'_'.$cid; - - my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what; - my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm; - my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm; - - my $courselevel= $usercourseprefix.'.'.$what; - my $courselevelr=$usercourseprefix.'.'.$symbparm; - my $courselevelm=$usercourseprefix.'.'.$mapparm; - -# ---------------------------------------------------------- first, check user - if (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.'"'; -} - - -sub addresource { - my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_; - if ($showtypes eq 'problems') { - if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) { - return; - } - } - my $brepriv=&Apache::lonnet::allowed('bre',$resource); - if ($hash{'src_'.$rid}) { - if (($brepriv eq '2') || ($brepriv eq 'F')) { - my $pprefix=''; - if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) { - $pprefix=&astatus($rid); - } - $$sofar++; - if ($indent) { $pprefix='i'.$indent.','.$pprefix; } - if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; } - if (defined($rows[$$sofar])) { - $rows[$$sofar].='&'.$pprefix.$rid; - } else { - $rows[$$sofar]=$pprefix.$rid; - } - } - } -} - -sub followlinks () { - my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_; - my $mincond=1; - my $next=''; - foreach (split(/\,/,$hash{'to_'.$rid})) { - my $thiscond= - &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}}); - if ($thiscond>=$mincond) { - if ($next) { - $next.=','.$_.':'.$thiscond; - } else { - $next=$_.':'.$thiscond; - } - if ($thiscond>$mincond) { $mincond=$thiscond; } - } - } - my $col=0; - &Apache::lonxml::debug("following links -$next-"); - foreach (split(/\,/,$next)) { - my ($nextlinkid,$condval)=split(/\:/,$_); - if ($condval>=$mincond) { - my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid}, - $beenhere,$showtypes,$indent,$linkid); - if ($now>$further) { - if ($col>0) { - my $string; - for(my $i=0;$i<$col;$i++) { $string.='&'; } - for(my $i=$further+1;$now-1>$i;$i++) { - $rows[$i]=$string.$rows[$i]; - } - } - $further=$now; - } - } - $col++; - } - return $further; -} -# ------------------------------------------------------------ Build page table - -sub tracetable { - my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_; - my $newshowtypes=$showtypes; - my $further=$sofar; -# $Apache::lonxml::debug=1; - &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid}); - if ($beenhere=~/\&$rid\&/) { return $further; } - $beenhere.=$rid.'&'; - - if (defined($hash{'is_map_'.$rid})) { - $sofar++; - my $tprefix=''; - if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} - eq 'sequence') { - $tprefix='h'; - } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} - eq 'page') { - $tprefix='j'; - if ($indent) { $tprefix='i'.$indent.','.$tprefix; } - if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; } - $newshowtypes='problems'; - $indent++; - #if in a .page continue to link the encompising .page - if (!$linkid) { $linkid=$rid; } - } - if (defined($rows[$sofar])) { - $rows[$sofar].='&'.$tprefix.$rid; - } else { - $rows[$sofar]=$tprefix.$rid; - } - if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) && - (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) { - my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}}; - $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}}, - '&'.$frid.'&',$newshowtypes,$indent,$linkid); - &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes, - $indent,$linkid); - if ($tprefix =~ /j$/) { $indent--; $linkid=''; } +# symbolic constants +sub SYMB { return 1; } +sub URL { return 2; } +sub NOTHING { return 3; } + +# Some data + +my $resObj = "Apache::lonnavmaps::resource"; + +# Keep these mappings in sync with lonquickgrades, which uses the colors +# instead of the icons. +my %statusIconMap = + ( $resObj->NETWORK_FAILURE => '', + $resObj->NOTHING_SET => '', + $resObj->CORRECT => 'navmap.correct.gif', + $resObj->EXCUSED => 'navmap.correct.gif', + $resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', + $resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', + $resObj->ANSWER_OPEN => 'navmap.wrong.gif', + $resObj->OPEN_LATER => '', + $resObj->TRIES_LEFT => 'navmap.open.gif', + $resObj->INCORRECT => 'navmap.wrong.gif', + $resObj->OPEN => 'navmap.open.gif', + $resObj->ATTEMPTED => 'navmap.open.gif' ); + +my %iconAltTags = + ( 'navmap.correct.gif' => 'Correct', + 'navmap.wrong.gif' => 'Incorrect', + 'navmap.open.gif' => 'Open' ); + +# 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 cleanup { + if (tied(%navmaphash)){ + &Apache::lonnet::logthis('Cleanup navmaps: navmaphash'); + unless (untie(%navmaphash)) { + &Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash'); + } + } + if (tied(%parmhash)){ + &Apache::lonnet::logthis('Cleanup navmaps: parmhash'); + unless (untie(%parmhash)) { + &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash'); } - } 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 { - my $r=shift; - - &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); - - if ($ENV{'form.jtest'} ne "1") - { - return new_handle($r); - } - -# ------------------------------------------- Set document type for header only - - if ($r->header_only) { - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); - } - $r->send_http_header; - return OK; - } - 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('Coursemap undefined.'); - } 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('Empty Map.'); - } 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( - 'Navigate Course Map'); - if (($currenturl=~/^\/res/) && - ($currenturl!~/^\/res\/adm/)) { - $bodytagadd='onLoad="window.location.hash='."'curloc'".'"'; - } - $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', - $bodytagadd)); - $r->print(''); - my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; - if (defined($desc)) { $r->print("

$desc

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

$date

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

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

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

LON-CAPA network failure.

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

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

'); - for ($i=0;$i<=$#rows;$i++) { - if ($rows[$i]) { - $r->print("\n"); - my @colcont=split(/\&/,$rows[$i]); - my $avespan=$lcm/($#colcont+1); - - # for each item I wish to print on this row... - for ($j=0;$j<=$#colcont;$j++) { - my $indent;my $indentstr; - my $linkid; - my $rid=$colcont[$j]; - $rid=~/(\d+)\.(\d+)$/; - my $src= - &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2}); - my $symb= - &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src; - my $add=''; - my $hwk=''; - my $hwke=''; - if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; } - if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; } - if ($rid=~/^h(.+)/) { - $rid=$1; - $add=''; - if (($ENV{'user.adv'}) && - ($parmhash{$symb.'.0.parameter_randompick'})) { - $adde=' (randomly select '. - $parmhash{$symb.'.0.parameter_randompick'}. - ')'; - } - } - if ($rid=~/^j(.+)/) { $rid=$1; } - if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) { - # sub astatus describes what code/tcode mean - my $code=$1; - my $tcode=$2; - my $ctext=$3; - $rid=$4; - - # will open later - if ($tcode eq '1') { - $add=''; - } - } - $hwk=''; - $hwke=''; - if ($code eq '1') { - $hwke=' ('.$ctext.')'; - } - if ($code eq '2' || $code eq '4') { - $hwk=''; - $hwke=' ('.$ctext.')'; - } - if ($code eq '3') { - $hwk=''; - $hwke=' ('.$ctext.')'; - } - if ($networkFailedFlag) - { - $hwke=' (status unavailable)'; - } - } - if ($rid && $hash{'src_'.$rid} eq $currenturl) { - $add=$add.''. - '> '; - $adde= - ' <'.$adde; - } - if ($discussiontimes{$symb}>$lastcheck) { - $adde= - ''. - $adde; - } - if ($error{$src}) { - foreach (split(/\,/,$error{$src})) { - if ($_) { - $adde= - ' ' - .$adde; - } - } - } - if ($feedback{$src}) { - foreach (split(/\,/,$feedback{$src})) { - if ($_) { - $adde= - ' ' - .$adde; - } - } - } - if ($indent) { - my $is="  "; - for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; } - } - if (!$linkid) { $linkid=$rid; } - if ($hash{'randomout_'.$rid}) { - $adde=' (hidden)'.$adde; - } - $r->print($add.$indentstr); - if ($rid) { - $r->print(''. - $hwk.$hash{'title_'.$rid}.$hwke.''); - } - $r->print($adde); - } - $r->print(''); - } - } - $r->print("\n
'; - my $adde=''; - $adde=''; - } - - # solved/correct - if ($code eq '3') { - $add=''; - } elsif ($code eq '4') { # partially correct - $add=''; - } else { - # not attempted - - # we end up here on network failure, so pick a neutral - # color if the network failed instead of bright red. - if ( $networkFailedFlag ) - { - $add = ''; - } - else - { - $add=''; - } - - if ($tcode eq '2') { # open, not past due - $add=''; - } - - if ($tcode eq '4') { # due in next 24 hours - $add=''; - $adde='
"); - $r->print(''); -# -------------------------------------------------------------------- End page - } -# ------------------------------------------------------------- End render page - } -# ------------------------------------------------------------------ Untie hash - unless (untie(%hash)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie coursemap $fn (browse)."); - } - unless (untie(%parmhash)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie parmhash (browse)."); - } - return OK; + my $r = shift; + real_handler($r); } -sub new_handle { +sub real_handler { my $r = shift; # Handle header-only request @@ -820,7 +140,7 @@ sub new_handle { &Apache::loncommon::no_cache($r); $r->send_http_header; - # Create the nav map the nav map + # Create the nav map my $navmap = Apache::lonnavmaps::navmap->new( $ENV{"request.course.fn"}.".db", $ENV{"request.course.fn"}."_parms.db", 1, 1); @@ -832,27 +152,33 @@ sub new_handle { return HTTP_NOT_ACCEPTABLE; } + $r->print("\n"); + $r->print("Navigate Course Contents"); +# ------------------------------------------------------------ Get query string + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); +# ----------------------------------------------------- Force menu registration + my $addentries=''; + if ($ENV{'form.register'}) { + $addentries=' onLoad="'.&Apache::lonmenu::loadevents(). + '" onUnload="'.&Apache::lonmenu::unloadevents().'"'; + $r->print(&Apache::lonmenu::registerurl(1)); + } + # Header - $r->print(&Apache::loncommon::bodytag('Navigate Course Map','', - '')); + $r->print(''. + &Apache::loncommon::bodytag('Navigate Course Contents','', + $addentries)); $r->print(''); - my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; - if (defined($desc)) { $r->print("

$desc

\n"); } - my $date=localtime; - $r->print("

$date

\n"); + $r->rflush(); - if ($navmap->{LAST_CHECK}) { - $r->print(' New discussion since '. - strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). - '
New message (click to open)

'); - } else { - $r->print(' Discussions'. - '
New message (click to open)

'); - } # Now that we've displayed some stuff to the user, init the navmap $navmap->init(); + + $r->print('
 '); + $r->rflush(); + # Check that it's defined if (!($navmap->courseMapDefined())) { $r->print('Coursemap undefined.' . @@ -860,506 +186,17 @@ sub new_handle { return OK; } - # Grab a resource object so we have access to the constants; this - # is technically not proper, but should be harmless - my $res = $navmap->firstResource(); - - # Defines a status->color mapping, null string means don't color - my %colormap = - ( $res->NETWORK_FAILURE => '', - $res->CORRECT => '', - $res->EXCUSED => '#BBBBFF', - $res->PAST_DUE_ANSWER_LATER => '', - $res->PAST_DUE_NO_ANSWER => '', - $res->ANSWER_OPEN => '#CCFFCC', - $res->OPEN_LATER => '', - $res->TRIES_LEFT => '', - $res->INCORRECT => '', - $res->OPEN => '', - $res->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"; - - my %statusIconMap = - ( $res->NETWORK_FAILURE => '', - $res->NOTHING_SET => '', - $res->CORRECT => 'navmap.correct.gif', - $res->EXCUSED => 'navmap.correct.gif', - $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', - $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', - $res->ANSWER_OPEN => 'navmap.wrong.gif', - $res->OPEN_LATER => '', - $res->TRIES_LEFT => 'navmap.open.gif', - $res->INCORRECT => 'navmap.wrong.gif', - $res->OPEN => 'navmap.open.gif', - $res->ATTEMPTED => 'navmap.open.gif' ); - - my %iconAltTags = - ( 'navmap.correct.gif' => 'Correct', - 'navmap.wrong.gif' => 'Incorrect', - 'navmap.open.gif' => 'Open' ); - - my %condenseStatuses = - ( $res->NETWORK_FAILURE => 1, - $res->NOTHING_SET => 1, - $res->CORRECT => 1 ); - - my %filterHash; - # Figure out what we're not displaying - foreach (split(/\,/, $ENV{"form.filter"})) { - if ($_) { - $filterHash{$_} = "1"; - } - } - - # Is this a new-style course? If so, we want to suppress showing the top-level - # maps in their own folders, in favor of "inlining" them. - my $topResource = $navmap->getById("0.0"); - my $inlineTopLevelMaps = $topResource->src() =~ m|^/uploaded/.*default\.sequence$|; - - my $currenturl = $ENV{'form.postdata'}; - $currenturl=~s/^http\:\/\///; - $currenturl=~s/^[^\/]+//; - # alreadyHere allows us to only open the maps necessary to view - # the current location once, while at the same time remembering - # the current location. Without that check, the user would never - # be able to close those maps; the user would close it, and the - # currenturl scan would re-open it. - my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) . - "&alreadyHere=1"; - - my $condition = 0; - if ($ENV{'form.condition'}) { - $condition = 1; - } - - if ($condition) { - $r->print('Close All Folders

'); - } else { - $r->print('Open All Folders

'); - } - - # Begin the HTML table - # four cols: resource + indent, chat+feedback, icon, text string - $r->print('' ."\n"); - - # This needs to be updated to use symbs from the remote, - # instead of uris. The changes to this and the main rendering - # loop should be obvious. - # Here's a simple example of the iterator. - # Preprocess the map: Look for current URL, force inlined maps to display - - my $mapIterator = $navmap->getIterator(undef, undef, {}, 1); - my $found = 0; - my $depth = 1; - my $currentUrlIndex = 0; # keeps track of when the current resource is found, - # so we can back up a few and put the anchor above the - # current resource - $mapIterator->next(); # discard the first BEGIN_MAP - my $curRes = $mapIterator->next(); - my $counter = 0; - - while ($depth > 0) { - if ($curRes == $mapIterator->BEGIN_MAP()) { - $depth++; - } - if ($curRes == $mapIterator->END_MAP()) { - $depth--; - } - - if (ref($curRes)) { $counter++; } - - my $mapStack = $mapIterator->getStack(); - if ($currenturl && !$ENV{'form.alreadyHere'} && ref($curRes) && - $curRes->src() eq $currenturl) { - # If this is the correct resource, be sure to - # show it by making sure the containing maps - # are open. - - $currentUrlIndex = $counter; - - for my $map (@{$mapStack}) { - if ($condition) { - undef $filterHash{$map->map_pc()}; - } else { - $filterHash{$map->map_pc()} = 1; - } - } - $ENV{'form.alreadyHere'} = 1; - } - - # Preprocessing: If we're inlining nav maps into the top-level display, - # make sure we show this map! - if ($inlineTopLevelMaps && ref($curRes) && $curRes->is_map && - scalar(@{$mapStack}) == 1) { - if ($condition) { - undef $filterHash{$curRes->map_pc()}; - } else { - $filterHash{$curRes->map_pc()} = 1; - } - } - - $curRes = $mapIterator->next(); - } - - undef $res; # so we don't accidentally use it later - my $indentLevel = 0; - my $indentString = "\"\""; - - my $isNewBranch = 0; - my $now = time(); - my $in24Hours = $now + 24 * 60 * 60; - my $displayedHereMarker = 0; - - # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}" - # code in iterator->next), so ignore the first one - $mapIterator = $navmap->getIterator(undef, undef, \%filterHash, - $condition); - $mapIterator->next(); - $curRes = $mapIterator->next(); - my $deltadepth = 0; - $depth = 1; - - my @backgroundColors = ("#FFFFFF", "#F6F6F6"); - my $rowNum = 0; - - $counter = 0; - - while ($depth > 0) { - # If we're in a new style course, and this is a BEGIN_MAP, END_MAP, or - # map resource and the stack depth is only one, just plain ignore this resource - # entirely. (This has the effect of inlining the resources in that map - # in the nav map.) - if ($inlineTopLevelMaps && scalar(@{$mapIterator->getStack()}) == 1 && - ref($curRes) && $curRes->is_map()) { - # We let the normal depth stuff occur, but we need to shift everything - # over by one to the left to make it look right. - $deltadepth = -1; - $curRes = $mapIterator->next(); - next; - } - - if ($curRes == $mapIterator->BEGIN_MAP() || - $curRes == $mapIterator->BEGIN_BRANCH()) { - $indentLevel++; - } - if ($curRes == $mapIterator->END_MAP() || - $curRes == $mapIterator->END_BRANCH()) { - $indentLevel--; - } - if ($curRes == $mapIterator->BEGIN_BRANCH()) { - $isNewBranch = 1; - } - if ($curRes == $mapIterator->BEGIN_MAP()) { - $depth++; - } - if ($curRes == $mapIterator->END_MAP()) { - $depth--; - } - - if (ref($curRes)) { $counter++; } - - if ($depth == 1) { $deltadepth = 0; } # we're done shifting, because we're - # out of the inlined map - - # Is this resource being blotted out? - if (ref($curRes) && !advancedUser() && $curRes->randomout()) { - $curRes = $mapIterator->next(); - next; # and totally ignore this resource - } - - if (ref($curRes) && $curRes->src()) { - - # Step one: Decide which parts to show - my @parts = @{$curRes->parts()}; - my $multipart = scalar(@parts) > 1; - my $condensed = 0; - - if ($curRes->is_problem()) { - # Is it multipart? - - if ($multipart) { - # If it's multipart, see if part 0 is "open" - # if it is, display all parts, if it isn't, - # just display first - if (!$curRes->opendate("0")) { - @parts = ("0"); # just display the zero-th part - $condensed = 1; - } else { - # Otherwise, only display part 0 if we want to - # attach feedback or email information to it - if ($curRes->hasDiscussion() || $curRes->getFeedback()) { - shift @parts; - } else { - # If there's discussion or feedback, that counts - # as a difference, so display the parts. - - # Now, we decide whether to condense the - # parts due to similarity - my $status = $curRes->status($parts[1]); - my $due = $curRes->duedate($parts[1]); - my $open = $curRes->opendate($parts[1]); - my $statusAllSame = 1; - my $dueAllSame = 1; - my $openAllSame = 1; - for (my $i = 2; $i < scalar(@parts); $i++) { - if ($curRes->status($parts[$i]) != $status){ - $statusAllSame = 0; - } - if ($curRes->duedate($parts[$i]) != $due ) { - $dueAllSame = 0; - } - if ($curRes->opendate($parts[$i]) != $open) { - $openAllSame = 0; - } - } - - # $allSame is true if all the statuses were - # the same. Now, if they are all the same and - # match one of the statuses to condense, or they - # are all open with the same due date, or they are - # all OPEN_LATER with the same open date, display the - # status of the first non-zero part (to get the 'correct' - # status right, since 0 is never 'correct' or 'open'). - if (($statusAllSame && defined($condenseStatuses{$status})) || - ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| - ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ - @parts = ($parts[1]); - $condensed = 1; - } - } - } - } - - } else { - $parts[0] = "0"; # this is to get past foreach loop below - # you can consider a non-problem resource as a resource - # with only one part without loss - } - - # Is it a multipart problem with a single part, now in - # @parts with "0" filtered out? If so, forget it's a multi-part - # problem and treat it like a single-part problem. - if ( scalar(@parts) == 1 ) { - $multipart = 0; - } - - # Display one part, in event of network error. - # If this is a single part, we can at least show the correct - # status, but if it's multipart, we're lost. - if ($curRes->{RESOURCE_ERROR}) { - @parts = ("0"); - } - - # Step two: Show the parts - foreach my $part (@parts) { - - my $deltalevel = 0; # for inserting the branch icon - my $nonLinkedText = ""; # unlinked stuff after title - - # For each thing we're displaying... - - my $stack = $mapIterator->getStack(); - my $src = getLinkForResource($stack); - - my $srcHasQuestion = $src =~ /\?/; - my $link = $src. - ($srcHasQuestion?'&':'?') . - 'symb='.&Apache::lonnet::escape($curRes->symb()). - '"'; - my $title = $curRes->title(); - if (!$title) { - $title = $curRes->src(); - $title = substr ($title, rindex($title, "/") + 1); - } - my $partLabel = ""; - my $newBranchText = ""; - - # If this is a new branch, label it so - # (temporary, this should be an icon w/ alt text) - if ($isNewBranch) { - $newBranchText = ""; - $isNewBranch = 0; - $deltalevel = 1; - } - - # links to open and close the folders - my $linkopen = ""; - my $linkclose = ""; - - my $icon = "\"\""; - if ($curRes->is_problem()) { - if ($part eq "0" || $condensed) { - $icon = ''; - } else { - $icon = $indentString; - } - } - - # Display the correct icon, link to open or shut map - if ($curRes->is_map()) { - my $mapId = $curRes->map_pc(); - my $nowOpen = (!defined($filterHash{$mapId})); - if ($condition) {$nowOpen = !$nowOpen;} - $icon = $nowOpen ? - "navmap.folder.closed.gif" : "navmap.folder.open.gif"; - $icon = "\"\""; - $linkopen = ""; - $linkclose = ""; - - } - - my $colorizer = ""; - my $color; - if ($curRes->is_problem()) { - my $status = $curRes->status($part); - $color = $colormap{$status}; - - # Special case in the navmaps: If in less then - # 24 hours, give it a bit of urgency - if (($status == $curRes->OPEN() || $status == $curRes->ATTEMPTED() || - $status == $curRes->TRIES_LEFT()) - && $curRes->duedate() && - $curRes->duedate() < time()+(24*60*60) && - $curRes->duedate() > time()) { - $color = $hurryUpColor; - } - # Special case: If this is the last try, and there is - # more then one available, and it's not due yet, give a bit of urgency - my $tries = $curRes->tries($part); - my $maxtries = $curRes->maxtries($part); - if ($tries && $maxtries && $maxtries > 1 && - $maxtries - $tries == 1 && $curRes->duedate() && - $curRes->duedate() > time()) { - $color = $hurryUpColor; - } - if ($color ne "") { - $colorizer = "bgcolor=\"$color\""; - } - } - - if ($curRes->randomout()) { - $nonLinkedText .= ' (hidden) '; - } - - $rowNum++; - my $backgroundColor = $backgroundColors[$rowNum % scalar(@backgroundColors)]; - - # FIRST COL: The resource indentation, branch icon, name, and anchor - $r->print(" "); - - # Is this the first displayed part of a multi-part problem - # that has not been condensed, so we should suppress these two - # columns? - my $firstDisplayed = !$condensed && $multipart && $part eq "0"; - - # THIRD COL: Problem status icon - if ($curRes->is_problem() && - !$firstDisplayed) { - my $icon = $statusIconMap{$curRes->status($part)}; - my $alt = $iconAltTags{$icon}; - if ($icon) { - $r->print("\n"); - } else { - $r->print("\n"); - } - } else { # not problem, no icon - $r->print("\n"); - } - - # FOURTH COL: Text description - #$r->print("\n"); - } - } - $curRes = $mapIterator->next(); - } - - $r->print("
\n"); - - # anchor for current resource... - 5 is deliberate: If it's that - # high on the screen, don't bother focusing on it. Also this will - # print multiple anchors if this is an expanded multi-part problem... - # who cares? - if ($counter == $currentUrlIndex - 5) { - $r->print(''); - } - - # print indentation - for (my $i = 0; $i < $indentLevel - $deltalevel + $deltadepth; $i++) { - $r->print($indentString); - } - - $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); - - my $curMarkerBegin = ""; - my $curMarkerEnd = ""; - - # Is this the current resource? - if ($curRes->src() eq $currenturl && !$displayedHereMarker) { - $curMarkerBegin = '> '; - $curMarkerEnd = ' <'; - $displayedHereMarker = 1; - } - - if ($curRes->is_problem() && $part ne "0" && !$condensed) { - $partLabel = " (Part $part)"; - $title = ""; - } - if ($multipart && $condensed) { - $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)'; - } - - $r->print(" $curMarkerBegin$title$partLabel $curMarkerEnd $nonLinkedText"); - - if ($curRes->{RESOURCE_ERROR}) { - $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down", - 'Host down')); - } - - my $discussionHTML = ""; my $feedbackHTML = ""; - - # SECOND COL: Is there text, feedback, errors?? - if ($curRes->hasDiscussion()) { - $discussionHTML = $linkopen . - '' . - $linkclose; - } - - if ($curRes->getFeedback()) { - my $feedback = $curRes->getFeedback(); - foreach (split(/\,/, $feedback)) { - if ($_) { - $feedbackHTML .= ' ' - . ''; - } - } - } - - $r->print("$discussionHTML$feedbackHTML $linkopen\"$alt\"$linkclose  \n"); - $r->print("\n"); - - if ($curRes->kind() eq "res" && - $curRes->is_problem() && - !$firstDisplayed) { - $r->print ("") if ($color); - $r->print (getDescription($curRes, $part)); - $r->print ("") if ($color); - } - if ($curRes->is_map() && advancedUser() && $curRes->randompick()) { - $r->print('(randomly select ' . $curRes->randompick() .')'); - } - - $r->print(" 
"); + # renderer call + my $render = render({ 'cols' => [0,1,2,3], + 'url' => '/adm/navmaps', + #'printKey' => 1, + 'r' => $r}); $navmap->untieHashes(); + $r->print(""); + $r->rflush(); + return OK; } @@ -1468,6 +305,34 @@ 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 { return $ENV{'user.adv'}; } @@ -1513,17 +378,18 @@ sub timeToHumanString { $delta = -$delta; } - # Is it in the future? if ( $delta > 0 ) { - # Is it less then a minute away? + my $tense = $inPast ? " ago" : ""; my $prefix = $inPast ? "" : "in "; + + # Less then a minute if ( $delta < $minute ) { if ($delta == 1) { return "${prefix}1 second$tense"; } return "$prefix$delta seconds$tense"; } - # Is it less then an hour away? + # Less then an hour if ( $delta < $hour ) { # If so, use minutes my $minutes = floor($delta / 60); @@ -1577,13 +443,790 @@ 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 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: 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: If true, the resource will not be linked. Default: false, resource will have links. + +=item * B: 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. + +=item * B: If true, the resource's folder will not be clickable to open or close it. Default is false. + +=back + +=item B: 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: 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: 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 '' . $resource->{ID} . ' ' . $part . ''; } + return '' . $resource->{ID} . ''; + } + +Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc. + +=head2 Parameters + +Most of these parameters are only useful if you are *not* using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically. + +=over 4 + +=item * B: 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. If one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information, plus the 'iterator_map' parameter if any. + +=item * B: If you are letting the renderer do the iterator handling, you can instruct the renderer to render only a particular map by passing it the source of the map you want to process, like '/res/103/jerf/navmap.course.sequence'. + +=item * B: A reference to a navmap, used only if an iterator is not passed in. If this is necessary to make an iterator but it is not passed in, a new one will be constructed based on ENV info. This is useful to do basic error checking before passing it off to render. + +=item * B: An array reference + +=item * B: 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: 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: 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. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information. + +=item * B: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info. + +=item * B: A Symb identifying where to place the 'here' marker. Default same as hereURL. + +=item * B: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text. + +=item * B: A string which will be prepended to the query string used when the folders are opened or closed. + +=item * B: The url the folders will link to, which should be the current page. Required if the resource info column is shown. + +=item * B: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}. + +=item * B: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself. + +=item * B: If true, print the key that appears on the top of the standard navmaps. Default is false. + +=item * B: If true, print the "Close all folders" or "open all folders" links. Default is true. + +=item * B: A function that takes the resource object as its only parameter and returns a true or false value. If true, the resource is displayed. If false, it is simply skipped in the display. By default, all resources are showne. + +=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: + +If you want to know how many rows were printed, the 'counter' element of the hash passed into the render function will contain the count. You may want to check whether any resources were printed at all. + +=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 + +sub render_resource { + my ($resource, $part, $params) = @_; + + my $nonLinkedText = ''; # stuff after resource title not in link + + my $link = $params->{"resourceLink"}; + my $src = $resource->src(); + my $it = $params->{"iterator"}; + my $filter = $it->{FILTER}; + + 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 = ""; + } + + # links to open and close the folder + my $linkopen = ""; + my $linkclose = ""; + + # Default icon: HTML page + my $icon = ""; + + if ($resource->is_problem()) { + if ($part eq "0" || $params->{'condensed'}) { + $icon = ''; + } 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; + } + + if (!$params->{'resource_no_folder_link'}) { + $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; + $icon = ""; + + $linkopen = "{'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($resource->symb()) . + "&folderManip=1'>"; + } else { + # Don't allow users to manipulate folder + $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . + '.nomanip.gif'; + $icon = ""; + + $linkopen = ""; + $linkclose = ""; + } + } + + if ($resource->randomout()) { + $nonLinkedText .= ' (hidden) '; + } + + # We're done preparing and finally ready to start the rendering + my $result = ""; + + my $indentLevel = $params->{'indentLevel'}; + if ($newBranchText) { $indentLevel--; } + + # print indentation + for (my $i = 0; $i < $indentLevel; $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 = '> '; + $curMarkerEnd = '<'; + } + + if ($resource->is_problem() && $part ne "0" && + !$params->{'condensed'}) { + $partLabel = " (Part $part)"; + $title = ""; + } + + if ($params->{'multipart'} && $params->{'condensed'}) { + $nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; + } + + if (!$params->{'resource_nolink'}) { + $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText"; + } else { + $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText"; + } + + return $result; +} + +sub render_communication_status { + my ($resource, $part, $params) = @_; + my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; + + my $link = $params->{"resourceLink"}; + my $linkopen = ""; + my $linkclose = ""; + + if ($resource->hasDiscussion()) { + $discussionHTML = $linkopen . + '' . + $linkclose; + } + + if ($resource->getFeedback()) { + my $feedback = $resource->getFeedback(); + foreach (split(/\,/, $feedback)) { + if ($_) { + $feedbackHTML .= ' ' + . ''; + } + } + } + + if ($resource->getErrors()) { + my $errors = $resource->getErrors(); + foreach (split(/,/, $errors)) { + if ($_) { + $errorHTML .= ' ' + . ''; + } + } + } + + return "$discussionHTML$feedbackHTML$errorHTML "; + +} +sub render_quick_status { + my ($resource, $part, $params) = @_; + my $result = ""; + my $firstDisplayed = !$params->{'condensed'} && + $params->{'multipart'} && $part eq "0"; + + my $link = $params->{"resourceLink"}; + my $linkopen = ""; + my $linkclose = ""; + + if ($resource->is_problem() && + !$firstDisplayed) { + my $icon = $statusIconMap{$resource->status($part)}; + my $alt = $iconAltTags{$icon}; + if ($icon) { + $result .= "$linkopen$alt$linkclose\n"; + } else { + $result .= " \n"; + } + } else { # not problem, no icon + $result .= " \n"; + } + + return $result; +} +sub render_long_status { + my ($resource, $part, $params) = @_; + my $result = "\n"; + my $firstDisplayed = !$params->{'condensed'} && + $params->{'multipart'} && $part eq "0"; + + my $color; + if ($resource->is_problem()) { + $color = $colormap{$resource->status}; + + if (dueInLessThen24Hours($resource, $part) || + lastTry($resource, $part)) { + $color = $hurryUpColor; + } + } + + if ($resource->kind() eq "res" && + $resource->is_problem() && + !$firstDisplayed) { + if ($color) {$result .= ""; } + $result .= getDescription($resource, $part); + if ($color) {$result .= ""; } + } + if ($resource->is_map() && advancedUser() && $resource->randompick()) { + $result .= '(randomly select ' . $resource->randompick() .')'; + } + + $result .= " \n"; + + return $result; +} + +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; + &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); + my $result = ''; + + # Configure the renderer. + my $cols = $args->{'cols'}; + if (!defined($cols)) { + # no columns, no nav maps. + return ''; + } + my $mustCloseNavMap = 0; + my $navmap; + if (defined($args->{'navmap'})) { + $navmap = $args->{'navmap'}; + } + + my $queryString = $args->{'queryString'}; + my $jumpToURL = $args->{'jumpToURL'}; + my $jumpToSymb = $args->{'jumpToSymb'}; + my $jumpType; + my $hereURL = $args->{'hereURL'}; + my $hereSymb = $args->{'hereSymb'}; + my $hereType; + my $here; + my $jump; + my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0); + my $currentJumpDelta = 2; # change this to change how many resources are displayed + # before the current resource when using #current + + # If we were passed 'here' information, we are not rendering + # after a folder manipulation, and we were not passed an + # iterator, make sure we open the folders to show the "here" + # marker + my $filterHash = {}; + # Figure out what we're not displaying + foreach (split(/\,/, $ENV{"form.filter"})) { + if ($_) { + $filterHash->{$_} = "1"; + } + } + + my $condition = 0; + if ($ENV{'form.condition'}) { + $condition = 1; + } + + if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) { + # Step 1: Check to see if we have a navmap + if (!defined($navmap)) { + $navmap = Apache::lonnavmaps::navmap->new( + $ENV{"request.course.fn"}.".db", + $ENV{"request.course.fn"}."_parms.db", 1, 1); + $mustCloseNavMap = 1; + } + $navmap->init(); + + # Step two: Locate what kind of here marker is necessary + # Determine where the "here" marker is and where the screen jumps to. + + # 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(); + } + # Step three: Ensure the folders are open + my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); + my $depth = 1; + $mapIterator->next(); # discard the first BEGIN_MAP + my $curRes = $mapIterator->next(); + my $counter = 0; + my $found = 0; + + # We only need to do this if we need to open the maps to show the + # current position. This will change the counter so we can't count + # for the jump marker with this loop. + while ($depth > 0 && !$found) { + if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } + if ($curRes == $mapIterator->END_MAP()) { $depth--; } + + if (ref($curRes) && + ($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(); + } + + # Since we changed the folders, (re-)locate the jump point, if any + $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); + $depth = 1; + $mapIterator->next(); + $curRes = $mapIterator->next(); + my $foundJump = 0; + + 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))) { + + # 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(); + } + + } + if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # 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'}; + } + + my $it = $args->{'iterator'}; + if (!defined($it)) { + # Construct a default iterator based on $ENV{'form.'} information + + # Step 1: Check to see if we have a navmap + if (!defined($navmap)) { + $navmap = Apache::lonnavmaps::navmap->new( + $ENV{"request.course.fn"}.".db", + $ENV{"request.course.fn"}."_parms.db", 1, 1); + $mustCloseNavMap = 1; + } + # Paranoia: Make sure it's ready + $navmap->init(); + + # See if we're being passed a specific map + if ($args->{'iterator_map'}) { + my $map = $args->{'iterator_map'}; + $map = $navmap->getResourceByUrl($map); + my $firstResource = $map->map_start(); + my $finishResource = $map->map_finish(); + + $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition); + } else { + $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition); + } + } + + my $showParts = setDefault($args->{'showParts'}, 1); + my $condenseParts = setDefault($args->{'condenseParts'}, 1); + # 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 $r = $args->{'r'}; + my $printKey = $args->{'printKey'}; + my $printCloseAll = $args->{'printCloseAll'}; + if (!defined($printCloseAll)) { $printCloseAll = 1; } + my $filterFunc = setDefault($args->{'filterFunc'}, + sub {return 1;}); + + # Print key? + if ($printKey) { + $result .= ''; + my $date=localtime; + $result.=''; + if ($navmap->{LAST_CHECK}) { + $result .= + ' New discussion since '. + strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). + ''; + } else { + $result .= ''; + } + + $result .= '
Key:    '. + ' New message (click to open)

'. + '

  '. + ' Discussions'. + '   New message (click to open)'. + '
'; + } + + if ($printCloseAll) { + if ($condition) { + $result.="Close All Folders"; + } else { + $result.="Open All Folders"; + } + $result .= "

\n"; + } + + if ($r) { + $r->print($result); + $r->rflush(); + $result = ""; + } + # End parameter setting + + # Data + $result .= '' ."\n"; + my $res = "Apache::lonnavmaps::resource"; + my %condenseStatuses = + ( $res->NETWORK_FAILURE => 1, + $res->NOTHING_SET => 1, + $res->CORRECT => 1 ); + my @backgroundColors = ("#FFFFFF", "#F6F6F6"); + + # Shared variables + $args->{'counter'} = 0; # counts the rows + $args->{'indentLevel'} = 0; + $args->{'isNewBranch'} = 0; + $args->{'condensed'} = 0; + $args->{'indentString'} = setDefault($args->{'indentString'}, ""); + $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; + + # export "here" marker information + $args->{'here'} = $here; + $args->{'hereType'} = $hereType; + + 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'}++; + + # If this has been filtered out, continue on + if (!(&$filterFunc($curRes))) { + $curRes = $it->next(); + $args->{'isNewBranch'} = 0; # Don't falsely remember this + 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 .= " \n"; + + # Set up some data about the parts that the cols might want + my $filter = $it->{FILTER}; + my $stack = $it->getStack(); + my $src = getLinkForResource($stack); + + my $srcHasQuestion = $src =~ /\?/; + $args->{"resourceLink"} = $src. + ($srcHasQuestion?'&':'?') . + 'symb=' . &Apache::lonnet::escape($curRes->symb()); + + # Now, display each column. + foreach my $col (@$cols) { + my $colHTML = ''; + if (ref($col)) { + $colHTML .= &$col($curRes, $part, $args); + } else { + $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args); + } + + # If this is the first column and it's time to print + # the anchor, do so + if ($col == $cols->[0] && + $args->{'counter'} == $args->{'currentJumpIndex'} - + $currentJumpDelta) { + # Jam the anchor after the \n"; + $args->{'isNewBranch'} = 0; + } + + if ($r && $rownum % 20 == 0) { + $r->print($result); + $result = ""; + $r->rflush(); + } + + $curRes = $it->next(); + } + + # Print out the part that jumps to #curloc if it exists + if ($displayedJumpMarker) { + $result .= "\n"; + } + + $result .= "
tag; + # necessary for valid HTML (which Mozilla requires) + $colHTML =~ s/\>/\>\/; + $displayedJumpMarker = 1; + } + $result .= $colHTML . "\n"; + } + $result .= "
"; + + if ($r) { + $r->print($result); + $result = ""; + $r->rflush(); + } + + if ($mustCloseNavMap) { $navmap->untieHashes(); } + + return $result; +} + 1; package Apache::lonnavmaps::navmap; =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 @@ -1617,7 +1260,7 @@ sub new { $self->{GENERATE_COURSE_USER_OPT} = shift; $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift; - # Resource cache stores navmapresource's as we reference them. We generate + # Resource cache stores navmap resources as we reference them. We generate # them on-demand so we don't pay for creating resources unless we use them. $self->{RESOURCE_CACHE} = {}; @@ -1626,22 +1269,23 @@ sub new { $self->{NETWORK_FAILURE} = 0; # tie the nav hash - my %navmaphash; + if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, &GDBM_READER(), 0640))) { return undef; } - $self->{NAV_HASH} = \%navmaphash; - my %parmhash; if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, &GDBM_READER(), 0640))) { untie $self->{PARM_HASH}; return undef; } - $self->{PARM_HASH} = \%parmhash; + $self->{HASH_TIED} = 1; + $self->{NAV_HASH} = \%navmaphash; + $self->{PARM_HASH} = \%parmhash; + $self->{INITED} = 0; bless($self); @@ -1650,6 +1294,7 @@ sub new { sub init { my $self = shift; + if ($self->{INITED}) { return; } # If the course opt hash and the user opt hash should be generated, # generate them @@ -1663,7 +1308,7 @@ sub init { my $userprefix=$uname.'_'.$udom.'_'; - my %courserdatas; my %useropt; my %courseopt; + my %courserdatas; my %useropt; my %courseopt; my %userrdatas; unless ($uhome eq 'no_host') { # ------------------------------------------------- Get coursedata (if present) unless ((time-$courserdatas{$cid.'.last_cache'})<240) { @@ -1714,7 +1359,7 @@ sub init { my %emailstatus = &Apache::lonnet::dump('email_status'); my $logoutTime = $emailstatus{'logout'}; my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; - $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ? + $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ? $courseLeaveTime : $logoutTime); my %discussiontime = &Apache::lonnet::dump('discussiontimes', $cdom, $cnum); @@ -1755,6 +1400,14 @@ sub init { } $self->{PARM_CACHE} = {}; + $self->{INITED} = 1; +} + +# Internal function: Takes a key to look up in the nav hash and implements internal +# 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 @@ -1762,16 +1415,15 @@ sub courseMapDefined { my $self = shift; my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); - my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; - my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; + my $firstres = $self->navhash("map_start_$uri"); + my $lastres = $self->navhash("map_finish_$uri"); return $firstres && $lastres; } sub getIterator { my $self = shift; - my $iterator = Apache::lonnavmaps::DFSiterator->new($self, shift, shift, - shift, undef, shift, - $ENV{'form.direction'}); + my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, + shift, undef, shift); return $iterator; } @@ -1789,18 +1441,19 @@ sub DESTROY { $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. sub hasDiscussion { my $self = shift; my $symb = shift; if (!defined($self->{DISCUSSION_TIME})) { return 0; } + #return defined($self->{DISCUSSION_TIME}->{$symb}); return $self->{DISCUSSION_TIME}->{$symb} > $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 # will be false if it does not exist. sub getFeedback { @@ -1812,6 +1465,15 @@ sub getFeedback { 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 =item * B(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object. @@ -1833,7 +1495,9 @@ sub getById { } # 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 @@ -1844,8 +1508,8 @@ sub getById { sub firstResource { my $self = shift; - my $firstResource = $self->{NAV_HASH}->{'map_start_' . - &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + my $firstResource = $self->navhash('map_start_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})); return $self->getById($firstResource); } @@ -1857,19 +1521,13 @@ sub firstResource { sub finishResource { my $self = shift; - my $firstResource = $self->{NAV_HASH}->{'map_finish_' . - &Apache::lonnet::clutter($ENV{'request.course.uri'})}; + my $firstResource = $self->navhash('map_finish_' . + &Apache::lonnet::clutter($ENV{'request.course.uri'})); return $self->getById($firstResource); } -# -------------------------------------------- Figure out a cascading parameter -# -# For this function to work -# -# * parmhash needs to be tied -# * courseopt and useropt need to be initialized for this user and course -# - +# Parmval reads the parm hash and cascades the lookups. parmval_real does +# the actual lookup; parmval caches the results. sub parmval { my $self = shift; my ($what,$symb)=@_; @@ -1966,15 +1624,110 @@ sub parmval_real { return ''; } +=pod + +=item * B(url): Retrieves a resource object by URL of the resource. If passed a resource object, it will simply return it, so it is safe to use this method in code like "$res = $navmap->getResourceByUrl($res)", if you're not sure if $res is already an object, or just a URL. If the resource appears multiple times in the course, only the first instance will be returned. As a result, this is probably useful only for maps. + +=item * B(map, filterFunc, recursive, bailout): The map is a specification of a map to retreive the resources from, either as a url or as an object. The filterFunc is a reference to a function that takes a resource object as its one argument and returns true if the resource should be included, or false if it should not be. If recursive is true, the map will be recursively examined, otherwise it will not be. If bailout is true, the function will return as soon as it finds a resource, if false it will finish. By default, the map is the top-level map of the course, filterFunc is a function that always returns 1, recursive is true, bailout is false. The resources will be returned in a list reference containing the resource objects for the corresponding resources, with B in the list; regardless of branching, recursion, etc., it will be a flat list. + +Thus, this is suitable for cases where you don't want the structure, just a list of all resources. It is also suitable for finding out how many resources match a given description; for this use, if all you want to know is if I resources match the description, the bailout parameter will allow you to avoid potentially expensive enumeration of all matching resources. + +=item * B(map, filterFunc, recursive): Convience method for + + scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0 + +which will tell whether the map has resources matching the description in the filter function. + +=cut + +sub getResourceByUrl { + my $self = shift; + my $resUrl = shift; + + if (ref($resUrl)) { return $resUrl; } + + $resUrl = &Apache::lonnet::clutter($resUrl); + my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl}; + if ($resId =~ /,/) { + $resId = (split (/,/, $resId))[0]; + } + if (!$resId) { return ''; } + return $self->getById($resId); +} + +sub retrieveResources { + my $self = shift; + my $map = shift; + my $filterFunc = shift; + if (!defined ($filterFunc)) { + $filterFunc = sub {return 1;}; + } + my $recursive = shift; + if (!defined($recursive)) { $recursive = 1; } + my $bailout = shift; + if (!defined($bailout)) { $bailout = 0; } + + # Create the necessary iterator. + if (!ref($map)) { # assume it's a url of a map. + $map = $self->getMapByUrl($map); + } + + # Check the map's validity. + if (!$map || !$map->is_map()) { + # Oh, to throw an exception.... how I'd love that! + return (); + } + + # Get an iterator. + my $it = $self->getIterator($map->map_start(), $map->map_finish(), + !$recursive); + + my @resources = (); + + # Run down the iterator and collect the resources. + my $depth = 1; + $it->next(); + my $curRes = $it->next(); + + while ($depth > 0) { + if ($curRes == $it->BEGIN_MAP()) { + $depth++; + } + if ($curRes == $it->END_MAP()) { + $depth--; + } + + if (ref($curRes)) { + if (!&$filterFunc($curRes)) { + next; + } + + push @resources, $curRes; + + if ($bailout) { + return @resources; + } + } + + $curRes = $it->next(); + } + + return @resources; +} + +sub hasResource { + my $self = shift; + my $map = shift; + my $filterFunc = shift; + my $recursive = shift; + + return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0; +} 1; package Apache::lonnavmaps::iterator; -# This package must precede "navmap" because "navmap" uses it. In -# order to keep the documentation order straight, the iterator is documented -# after the navmap object. - =pod =back @@ -1995,9 +1748,9 @@ getIterator behaves as follows: =over 4 -=item B(firstResource, finishResource, filterHash, condition, direction): 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. Direction specifies which direction to recurse, either FORWARD or BACKWARD, with FORWARD being default. +=item * B(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: @@ -2015,6 +1768,8 @@ The iterator will return either a refere 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 =cut @@ -2028,6 +1783,16 @@ sub END_BRANCH { return 4; } # end of sub FORWARD { return 1; } # go forward sub BACKWARD { return 2; } +sub min { + (my $a, my $b) = @_; + if ($a < $b) { return $a; } else { return $b; } +} + +# In the CVS repository, documentation of this algorithm is included +# in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1** +# will reference the same location in the text as the part of the +# algorithm is running through. + sub new { # magic invocation to create a class instance my $proto = shift; @@ -2055,35 +1820,315 @@ sub new { if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; $self->{CONDITION} = shift; + # 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. - # Now we're ready to start iterating. + # 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. + my $browsePriv = $self->{HERE}->browsePriv(); + if (!$self->{HERE}->src() || + (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) { + return $self->next(); + } + + return $self->{HERE}; + +} + +=pod + +The other method available on the iterator is B, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map). + +=cut + +sub getStack { + my $self=shift; + + my @stack; + + $self->populateStack(\@stack); + + return \@stack; +} + +# Private method: Calls the iterators recursively to populate the stack. +sub populateStack { + my $self=shift; + my $stack = shift; + + push @$stack, $self->{HERE} if ($self->{HERE}); + + if ($self->{RECURSIVE_ITERATOR_FLAG}) { + $self->{RECURSIVE_ITERATOR}->populateStack($stack); + } } 1; package Apache::lonnavmaps::DFSiterator; -# UNDOCUMENTED: This is a private library, it should not generally be used -# by the outside world. What it does is walk through the nav map in a -# depth-first fashion. This is not appropriate for most uses, but it is -# used by the main iterator for pre-processing. It also is able to isolate -# much of the complexity of the main iterator, so the main iterator is much -# simpler. +# 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 -# Here are the tokens for the iterator, replicated from iterator for convenience: +# 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 BEGIN_BRANCH { return 3; } # beginning of a branch -sub END_BRANCH { return 4; } # end of a branch sub FORWARD { return 1; } # go forward sub BACKWARD { return 2; } -# Params: nav map, start resource, end resource, filter, condition, -# already seen hash ref - +# 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; @@ -2093,7 +2138,6 @@ sub new { $self->{NAV_MAP} = shift; return undef unless ($self->{NAV_MAP}); - # Handle the parameters $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); @@ -2108,11 +2152,11 @@ sub new { # A hash, used as a set, of resource already seen $self->{ALREADY_SEEN} = shift; - if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; + if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} }; $self->{CONDITION} = shift; $self->{DIRECTION} = shift || FORWARD(); - # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP. + # Flag: Have we started yet? $self->{STARTED} = 0; # Should we continue calling the recursive iterator, if any? @@ -2126,38 +2170,25 @@ sub new { $self->{RECURSIVE_DEPTH} = 0; # For keeping track of our branches, we maintain our own stack - $self->{BRANCH_STACK} = []; - # If the size shrinks, we exhausted a branch - $self->{BRANCH_STACK_SIZE} = 0; - $self->{BRANCH_DEPTH} = 0; - - # For returning two things in a forced sequence - $self->{FORCE_NEXT} = undef; + $self->{STACK} = []; # Start with the first resource if ($self->{DIRECTION} == FORWARD) { - push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE}; + push @{$self->{STACK}}, $self->{FIRST_RESOURCE}; } else { - push @{$self->{BRANCH_STACK}}, $self->{FINISH_RESOURCE}; + push @{$self->{STACK}}, $self->{FINISH_RESOURCE}; } - $self->{BRANCH_STACK_SIZE} = 1; bless($self); return $self; } -# Note... this function is *touchy*. I strongly recommend tracing -# through it with the debugger a few times on a non-trivial map before -# modifying it. Order is *everything*. sub next { my $self = shift; - # Iterator logic goes here - # Are we using a recursive iterator? If so, pull from that and # watch the depth; we want to resume our level at the correct time. - if ($self->{RECURSIVE_ITERATOR_FLAG}) - { + if ($self->{RECURSIVE_ITERATOR_FLAG}) { # grab the next from the recursive iterator my $next = $self->{RECURSIVE_ITERATOR}->next(); @@ -2173,23 +2204,10 @@ sub 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 - # END_BRANCH and END_MAP in succession. - if (scalar(@{$self->{BRANCH_STACK}}) == 0) { - if ($self->{BRANCH_DEPTH} > 0) { - $self->{FORCE_NEXT} = $self->END_MAP(); - $self->{BRANCH_DEPTH}--; - return $self->END_BRANCH(); - } else { - return $self->END_MAP(); - } + # END_MAP, which will end the iterator. + if (scalar(@{$self->{STACK}}) == 0) { + return $self->END_MAP(); } # Have we not yet begun? If not, return BEGIN_MAP and @@ -2199,40 +2217,10 @@ sub next { 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 - $self->{HERE} = pop @{$self->{BRANCH_STACK}}; + $self->{HERE} = pop @{$self->{STACK}}; - # Are we at the right depth? If not, close a branch and return - # 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. + # remember that we've seen this, so we don't return it again later $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1; # Get the next possible resources @@ -2245,40 +2233,16 @@ sub next { my $next = []; # filter the next possibilities to remove things we've - # already seen. Also, remember what branch depth they should - # be displayed at, since there's no other reliable way to tell. + # already seen. foreach (@$nextUnfiltered) { if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { 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) { - # copy the next possibilities over to the branch stack - # in the right order - push @{$self->{BRANCH_STACK}}, shift @$next; - } - - if ($nextCount >= 2) { - $self->{FORCE_NEXT} = $self->BEGIN_BRANCH(); - $self->{BRANCH_DEPTH}++; - return $self->{HERE}; + # copy the next possibilities over to the stack + push @{$self->{STACK}}, shift @$next; } # If this is a map and we want to recurse down it... (not filtered out) @@ -2297,34 +2261,6 @@ sub next { return $self->{HERE}; } -=pod - -The other method available on the iterator is B, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map). - -=cut - -sub getStack { - my $self=shift; - - my @stack; - - $self->populateStack(\@stack); - - return \@stack; -} - -# Private method: Calls the iterators recursively to populate the stack. -sub populateStack { - my $self=shift; - my $stack = shift; - - push @$stack, $self->{HERE} if ($self->{HERE}); - - if ($self->{RECURSIVE_ITERATOR_FLAG}) { - $self->{RECURSIVE_ITERATOR}->populateStack($stack); - } -} - 1; package Apache::lonnavmaps::resource; @@ -2339,7 +2275,7 @@ A resource object encapsulates a resourc A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object. -You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource. +You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource. =head2 Public Members @@ -2385,24 +2321,26 @@ sub navHash { my $self = shift; my $param = shift; my $id = shift; - return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")}; + return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:"")); } =pod B -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 +=item * B: 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: Returns true if the resource is external. =item * B: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B instead.) =item * B: Returns the kind of the resource from the compiled nav map. -=item * B: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. +=item * B: 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: Returns true for a map if the randompick feature is being used on the map. (?) @@ -2445,7 +2383,15 @@ sub symb { } sub title { my $self=shift; return $self->navHash("title_", 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 B @@ -2460,9 +2406,7 @@ These methods are shortcuts to deciding =item * B: Returns true if the resource is a page. -=item * B: Returns true if the resource is a problem. - -=item * B: Returns true if the resource sequence. +=item * B: Returns true if the resource is a sequence. =back @@ -2491,12 +2435,7 @@ sub is_sequence { return ($src =~ /sequence$/); } - - - - -# Move this into POD: In order to use these correctly, courseopt -# and useropt need to be generated +# Private method: Shells out to the parmval in the nav map, handler parts. sub parmval { my $self = shift; my $what = shift; @@ -2527,6 +2466,7 @@ These methods are useful for getting inf sub map_finish { my $self = shift; my $src = $self->src(); + $src = Apache::lonnet::clutter($src); my $res = $self->navHash("map_finish_$src", 0); $res = $self->{NAV_MAP}->getById($res); return $res; @@ -2539,6 +2479,7 @@ sub map_pc { sub map_start { my $self = shift; my $src = $self->src(); + $src = Apache::lonnet::clutter($src); my $res = $self->navHash("map_start_$src", 0); $res = $self->{NAV_MAP}->getById($res); return $res; @@ -2610,6 +2551,7 @@ sub answerdate { } return $self->parmval("answerdate", $part); } +sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); } sub duedate { (my $self, my $part) = @_; return $self->parmval("duedate", $part); @@ -2634,24 +2576,18 @@ sub tol { (my $self, my $part) = @_; return $self->parmval("tol", $part); } -sub tries { - my $self = shift; - my $part = shift; - $part = '0' if (!defined($part)); - - # Make sure return hash is loaded, should error check - $self->getReturnHash(); - - my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'}; - if (!defined($tries)) {return '0';} +sub tries { + my $self = shift; + my $tries = $self->queryRestoreHash('tries', shift); + if (!defined($tries)) { return '0';} return $tries; } sub type { (my $self, my $part) = @_; return $self->parmval("type", $part); } -sub weight { - (my $self, my $part) = @_; +sub weight { + my $self = shift; my $part = shift; return $self->parmval("weight", $part); } @@ -2706,12 +2642,21 @@ sub hasDiscussion { sub getFeedback { 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 -=item * B(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.) +=item * B(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater than two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.) =item * B(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B may return an array with fewer parts in it then countParts might lead you to believe. @@ -2762,12 +2707,15 @@ sub extractParts { foreach (split(/\,/,$metadata)) { if ($_ =~ /^parameter\_(.*)\_opendate$/) { - push @{$self->{PARTS}}, $1; + my $part = $1; + # check to see if part is turned off. + if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { + push @{$self->{PARTS}}, $1; + } } } - # Is this possible to do in one line? - Jeremy my @sortedParts = sort @{$self->{PARTS}}; $self->{PARTS} = \@sortedParts; } @@ -2779,7 +2727,7 @@ sub extractParts { =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. @@ -2796,6 +2744,10 @@ Idiomatic usage of these two methods wou ... 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 =item * B($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: @@ -2909,14 +2861,9 @@ sub ATTEMPTED { return 16; } sub getCompletionStatus { my $self = shift; - my $part = shift; - $part = "0" if (!defined($part)); return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); - # Make sure return hash exists - $self->getReturnHash(); - - my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'}; + my $status = $self->queryRestoreHash('solved', shift); # Left as seperate if statements in case we ever do more with this if ($status eq 'correct_by_student') {return $self->CORRECT;} @@ -2928,11 +2875,23 @@ sub getCompletionStatus { 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 B -Along with directly returning the date or completion status, the resource object includes a convenience function B() 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() 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 @@ -3036,15 +2995,14 @@ sub status { =over 4 -=item * B($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(): 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($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(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case. =cut sub getNext { my $self = shift; - my $alreadySeenHash = shift; my @branches; my $to = $self->to(); foreach my $branch ( split(/,/, $to) ) { @@ -3052,21 +3010,13 @@ sub getNext { my $next = $choice->goesto(); $next = $self->{NAV_MAP}->getById($next); - # Don't remember it if we've already seen it or if - # 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; - } + push @branches, $next; } return \@branches; } sub getPrevious { my $self = shift; - my $alreadySeenHash = shift; my @branches; my $from = $self->from(); foreach my $branch ( split /,/, $from) { @@ -3074,18 +3024,20 @@ sub getPrevious { my $prev = $choice->comesfrom(); $prev = $self->{NAV_MAP}->getById($prev); - # Skip it if we've already seen it or the user doesn't have - # 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; - } + push @branches, $prev; } 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 =back