[BACK]Return to lonnavmaps.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.45 and 1.62

version 1.45, 2002/09/02 18:25:55 version 1.62, 2002/10/03 19:10:28
Line 67  my %courseopt; Line 67  my %courseopt;
 my %useropt;  my %useropt;
 my %parmhash;  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  # ------------------------------------------------------------------ Euclid gcd
   
 sub euclid {  sub euclid {
Line 74  sub euclid { Line 78  sub euclid {
     my $a; my $b; my $r;      my $a; my $b; my $r;
     if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }      if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
     while ($r!=0) {      while ($r!=0) {
  $a=$b; $b=$r;          $a=$b; $b=$r;
         $r=$a%$b;          $r=$a%$b;
     }      }
     return $b;      return $b;
Line 120  sub parmval { Line 124  sub parmval {
     my $courselevelm=$usercourseprefix.'.'.$mapparm;      my $courselevelm=$usercourseprefix.'.'.$mapparm;
   
 # ---------------------------------------------------------- first, check user  # ---------------------------------------------------------- first, check user
     if ($uname) {      if (defined($uname)) {
  if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }          if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
  if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }          if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
  if ($useropt{$courselevel}) { return $useropt{$courselevel}; }          if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
     }      }
   
 # ------------------------------------------------------- second, check course  # ------------------------------------------------------- second, check course
     if ($csec) {      if (defined($csec)) {
  if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }          if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
         if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }          if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
         if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }          if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
     }      }
   
     if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }      if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
     if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }      if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
     if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }      if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; }
   
 # ----------------------------------------------------- third, check map parms  # ----------------------------------------------------- third, check map parms
   
     my $thisparm=$parmhash{$symbparm};      my $thisparm=$parmhash{$symbparm};
     if ($thisparm) { return $thisparm; }      if (defined($thisparm)) { return $thisparm; }
   
 # ----------------------------------------------------- fourth , check default  # ----------------------------------------------------- fourth , check default
   
     my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');      my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
     if ($default) { return $default}      if (defined($default)) { return $default}
   
 # --------------------------------------------------- fifth , cascade up parts  # --------------------------------------------------- fifth , cascade up parts
   
     my ($space,@qualifier)=split(/\./,$rwhat);      my ($space,@qualifier)=split(/\./,$rwhat);
     my $qualifier=join('.',@qualifier);      my $qualifier=join('.',@qualifier);
     unless ($space eq '0') {      unless ($space eq '0') {
  my ($part,$id)=split(/\_/,$space);          my ($part,$id)=split(/\_/,$space);
  if ($id) {          if ($id) {
     my $partgeneral=&parmval($part.".$qualifier",$symb);              my $partgeneral=&parmval($part.".$qualifier",$symb);
     if ($partgeneral) { return $partgeneral; }              if (defined($partgeneral)) { return $partgeneral; }
  } else {          } else {
     my $resourcegeneral=&parmval("0.$qualifier",$symb);              my $resourcegeneral=&parmval("0.$qualifier",$symb);
     if ($resourcegeneral) { return $resourcegeneral; }              if (defined($resourcegeneral)) { return $resourcegeneral; }
  }          }
     }      }
     return '';      return '';
 }  }
Line 186  sub astatus { Line 190  sub astatus {
     my $ctext='';      my $ctext='';
     $rid=~/(\d+)\.(\d+)/;      $rid=~/(\d+)\.(\d+)/;
     my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.      my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
  &Apache::lonnet::declutter($hash{'src_'.$rid});          &Apache::lonnet::declutter($hash{'src_'.$rid});
     my %duedate=();      my %duedate=();
     my %opendate=();      my %opendate=();
     my %answerdate=();      my %answerdate=();
     # need to always check part 0's open/due/answer status      # need to always check part 0's open/due/answer status
     foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'keys')))) {      foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) {
         if ($_=~/^parameter\_(.*)\_opendate$/) {          if ($_=~/^parameter\_(.*)\_opendate$/) {
     my $part=$1;              my $part=$1;
             $duedate{$part}=&parmval($part.'.duedate',$symb);              $duedate{$part}=&parmval($part.'.duedate',$symb);
             $opendate{$part}=&parmval($part.'.opendate',$symb);              $opendate{$part}=&parmval($part.'.opendate',$symb);
             $answerdate{$part}=&parmval($part.'.answerdate',$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 $now=time;
Line 205  sub astatus { Line 215  sub astatus {
     my %returnhash=&Apache::lonnet::restore($symb);      my %returnhash=&Apache::lonnet::restore($symb);
   
     foreach (sort(keys(%opendate))) {      foreach (sort(keys(%opendate))) {
  my $duedate=$duedate{$_};          my $duedate=$duedate{$_};
  my $opendate=$opendate{$_};          my $opendate=$opendate{$_};
  my $answerdate=$answerdate{$_};          my $answerdate=$answerdate{$_};
  my $preface='';          my $preface='';
  unless ($_ eq '0') { $preface=' Part: '.$_.' '; }          unless ($_ eq '0') { $preface=' Part: '.$_.' '; }
  if ($opendate) {          if ($opendate) {
     if ($now<$duedate || (!$duedate)) {              if ($now<$duedate || (!$duedate)) {
  unless ($tcode==4) { $tcode=2; }                  unless ($tcode==4) { $tcode=2; }
  if ($duedate) {                  if ($duedate) {
     $ctext.=$preface.'Due: '.localtime($duedate);                      $ctext.=$preface.'Due: '.localtime($duedate);
  } else {                  } else {
     $ctext.=$preface.'No Due Date';                      $ctext.=$preface.'No Due Date';
  }                  }
  if ($now<$opendate) {                  if ($now<$opendate) {
     unless ($tcode) { $tcode=1; }                      unless ($tcode) { $tcode=1; }
     $ctext.=$preface.'Open: '.localtime($opendate);                      $ctext.=$preface.'Open: '.localtime($opendate);
  }                  }
  if ($duedate && $duedate-$now<86400) {                  if ($duedate && $duedate-$now<86400) {
     $tcode=4;                      $tcode=4;
     $ctext.=$preface.'Due: '.localtime($duedate);                      $ctext.=$preface.'Due: '.localtime($duedate);
  }                  }
     } else {              } else {
  unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; }                  unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; }
  if ($now<$answerdate) {                  if ($now<$answerdate) {
     $ctext.='Answer: '.localtime($duedate);                      $ctext.='Answer: '.localtime($duedate);
  }                  }
     }              }
  } else {          } else {
     unless (($tcode==2) || ($tcode==4)) { $tcode=1; }              unless (($tcode==2) || ($tcode==4)) { $tcode=1; }
  }          }
           
  my $status=$returnhash{'resource.'.$_.'.solved'};          my $status=$returnhash{'resource.'.$_.'.solved'};
           
  if ($status eq 'correct_by_student') {          if ($status eq 'correct_by_student') {
     if ($code==0||$code==3) { $code=3; } else { $code=4; }              if ($code==0||$code==3) { $code=3; } else { $code=4; }
     $ctext.=' solved';              $ctext.=' solved';
  } elsif ($status eq 'correct_by_override') {          } elsif ($status eq 'correct_by_override') {
     if ($code==0||$code==3) { $code=3; } else { $code=4; }              if ($code==0||$code==3) { $code=3; } else { $code=4; }
     $ctext.=' override';              $ctext.=' override';
  } elsif ($status eq 'incorrect_attempted') {          } elsif ($status eq 'incorrect_attempted') {
     if ($code!=4 && $code!=3) { $code=2; }              if ($code!=4 && $code!=3) { $code=2; }
     if ($code==3) { $code=4; }              if ($code==3) { $code=4; }
     $ctext.=' ('.              $ctext.=' ('.
  ($returnhash{'resource.'.$_.'.tries'}?                  ($returnhash{'resource.'.$_.'.tries'}?
  $returnhash{'resource.'.$_.'.tries'}:'0');                   $returnhash{'resource.'.$_.'.tries'}:'0');
     my $numtries = &parmval($_.'.maxtries',$symb);              my $numtries = &parmval($_.'.maxtries',$symb);
     if ($numtries) { $ctext.='/'.$numtries.' tries'; }              if ($numtries) { $ctext.='/'.$numtries.' tries'; }
     $ctext.=')';              $ctext.=')';
  } elsif ($status eq 'incorrect_by_override') {          } elsif ($status eq 'incorrect_by_override') {
     if ($code!=4 && $code!=3) { $code=2; }              if ($code!=4 && $code!=3) { $code=2; }
     if ($code==3) { $code=4; }              if ($code==3) { $code=4; }
     $ctext.=' override';              $ctext.=' override';
  } elsif ($status eq 'excused') {          } elsif ($status eq 'excused') {
     if ($code==0||$code==3) { $code=3; } else { $code=4; }              if ($code==0||$code==3) { $code=3; } else { $code=4; }
     $ctext.=' excused';              $ctext.=' excused';
  } else {          } else {
     if ($code==0) { $code=1; }              if ($code==0) { $code=1; }
  }          }
     }      }
   
     return 'p'.$code.$tcode.'"'.$ctext.'"';      return 'p'.$code.$tcode.'"'.$ctext.'"';
Line 272  sub astatus { Line 282  sub astatus {
 sub addresource {  sub addresource {
     my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;      my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;
     if ($showtypes eq 'problems') {      if ($showtypes eq 'problems') {
  if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {          if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {
     return;              return;
  }          }
     }      }
     my $brepriv=&Apache::lonnet::allowed('bre',$resource);      my $brepriv=&Apache::lonnet::allowed('bre',$resource);
     if ($hash{'src_'.$rid}) {      if ($hash{'src_'.$rid}) {
  if (($brepriv eq '2') || ($brepriv eq 'F')) {          if (($brepriv eq '2') || ($brepriv eq 'F')) {
     my $pprefix='';              my $pprefix='';
     if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) {              if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) {
  $pprefix=&astatus($rid);                  $pprefix=&astatus($rid);
     }              }
     $$sofar++;              $$sofar++;
     if ($indent) { $pprefix='i'.$indent.','.$pprefix; }              if ($indent) { $pprefix='i'.$indent.','.$pprefix; }
     if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; }              if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; }
     if (defined($rows[$$sofar])) {              if (defined($rows[$$sofar])) {
  $rows[$$sofar].='&'.$pprefix.$rid;                  $rows[$$sofar].='&'.$pprefix.$rid;
     } else {              } else {
  $rows[$$sofar]=$pprefix.$rid;                  $rows[$$sofar]=$pprefix.$rid;
     }              }
  }          }
     }      }
 }  }
   
Line 300  sub followlinks () { Line 310  sub followlinks () {
     my $mincond=1;      my $mincond=1;
     my $next='';      my $next='';
     foreach (split(/\,/,$hash{'to_'.$rid})) {      foreach (split(/\,/,$hash{'to_'.$rid})) {
  my $thiscond=          my $thiscond=
     &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});              &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
  if ($thiscond>=$mincond) {          if ($thiscond>=$mincond) {
     if ($next) {              if ($next) {
  $next.=','.$_.':'.$thiscond;                  $next.=','.$_.':'.$thiscond;
     } else {              } else {
  $next=$_.':'.$thiscond;                  $next=$_.':'.$thiscond;
     }              }
     if ($thiscond>$mincond) { $mincond=$thiscond; }              if ($thiscond>$mincond) { $mincond=$thiscond; }
  }          }
     }      }
     my $col=0;      my $col=0;
     &Apache::lonxml::debug("following links -$next-");      &Apache::lonxml::debug("following links -$next-");
     foreach (split(/\,/,$next)) {      foreach (split(/\,/,$next)) {
  my ($nextlinkid,$condval)=split(/\:/,$_);          my ($nextlinkid,$condval)=split(/\:/,$_);
  if ($condval>=$mincond) {          if ($condval>=$mincond) {
     my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid},              my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid},
  $beenhere,$showtypes,$indent,$linkid);                                  $beenhere,$showtypes,$indent,$linkid);
     if ($now>$further) {              if ($now>$further) {                
  if ($col>0) {                  if ($col>0) {
     my $string;                      my $string;
     for(my $i=0;$i<$col;$i++) { $string.='&'; }                      for(my $i=0;$i<$col;$i++) { $string.='&'; }
     for(my $i=$further+1;$now-1>$i;$i++) {                      for(my $i=$further+1;$now-1>$i;$i++) {
  $rows[$i]=$string.$rows[$i];                          $rows[$i]=$string.$rows[$i];
     }                      }
  }                  }
  $further=$now;                  $further=$now;
     }              }
  }          }
  $col++;          $col++;
     }      }
     return $further;      return $further;
 }  }
Line 345  sub tracetable { Line 355  sub tracetable {
     $beenhere.=$rid.'&';      $beenhere.=$rid.'&';
   
     if (defined($hash{'is_map_'.$rid})) {      if (defined($hash{'is_map_'.$rid})) {
  $sofar++;          $sofar++;
  my $tprefix='';          my $tprefix='';
  if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}          if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
     eq 'sequence') {              eq 'sequence') {
     $tprefix='h';              $tprefix='h';
  } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}          } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
  eq 'page') {                   eq 'page') {
     $tprefix='j';              $tprefix='j';
     if ($indent) { $tprefix='i'.$indent.','.$tprefix; }              if ($indent) { $tprefix='i'.$indent.','.$tprefix; }
     if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; }              if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; }
     $newshowtypes='problems';              $newshowtypes='problems';
     $indent++;              $indent++;
     #if in a .page continue to link the encompising .page              #if in a .page continue to link the encompising .page
     if (!$linkid) { $linkid=$rid; }              if (!$linkid) { $linkid=$rid; }
  }          }
  if (defined($rows[$sofar])) {          if (defined($rows[$sofar])) {
     $rows[$sofar].='&'.$tprefix.$rid;              $rows[$sofar].='&'.$tprefix.$rid;
  } else {          } else {
     $rows[$sofar]=$tprefix.$rid;              $rows[$sofar]=$tprefix.$rid;
  }          }
  if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&          if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
     (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {              (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
     my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};              my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
     $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},              $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
        '&'.$frid.'&',$newshowtypes,$indent,$linkid);                                 '&'.$frid.'&',$newshowtypes,$indent,$linkid);
     &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes,              &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes,
  $indent,$linkid);                           $indent,$linkid);
     if ($tprefix =~ /j$/) { $indent--; $linkid=''; }              if ($tprefix =~ /j$/) { $indent--; $linkid=''; }
  }          }
     } else {      } else {
  &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,          &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,
      $indent,$linkid);                       $indent,$linkid);
     }      }
   
     if (defined($hash{'to_'.$rid})) {      if (defined($hash{'to_'.$rid})) {
  $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,          $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,
       $indent,$linkid);                                $indent,$linkid);
     }      }
   
     return $further;      return $further;
Line 392  sub tracetable { Line 402  sub tracetable {
 sub handler {  sub handler {
     my $r=shift;      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  # ------------------------------------------- Set document type for header only
   
     if ($r->header_only) {      if ($r->header_only) {
  if ($ENV{'browser.mathml'}) {          if ($ENV{'browser.mathml'}) {
     $r->content_type('text/xml');              $r->content_type('text/xml');
  } else {          } else {
     $r->content_type('text/html');              $r->content_type('text/html');
  }          }
  $r->send_http_header;          $r->send_http_header;
  return OK;          return OK;
     }      }
     my $requrl=$r->uri;      my $requrl=$r->uri;
     my $hashtied;      my $hashtied;
 # ----------------------------------------------------------------- Tie db file  # ----------------------------------------------------------------- Tie db file
     my $fn;      my $fn;
     if ($ENV{'request.course.fn'}) {      if ($ENV{'request.course.fn'}) {
  $fn=$ENV{'request.course.fn'};          $fn=$ENV{'request.course.fn'};
  if (-e "$fn.db") {          if (-e "$fn.db") {
     if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) &&              if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) &&
  (tie(%parmhash,'GDBM_File',                  (tie(%parmhash,'GDBM_File',
      $ENV{'request.course.fn'}.'_parms.db',                       $ENV{'request.course.fn'}.'_parms.db',
      &GDBM_READER(),0640))) {                       &GDBM_READER(),0640))) {
  $hashtied=1;                  $hashtied=1;
     }              }
  }          }
     }      }
     if (!$hashtied) {      if (!$hashtied) {
  $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";          $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
  return HTTP_NOT_ACCEPTABLE;           return HTTP_NOT_ACCEPTABLE; 
     }      }
   
 # ------------------------------------------------------------------- Hash tied  # ------------------------------------------------------------------- Hash tied
   
     if ($ENV{'browser.mathml'}) {      if ($ENV{'browser.mathml'}) {
  $r->content_type('text/xml');          $r->content_type('text/xml');
     } else {      } else {
  $r->content_type('text/html');          $r->content_type('text/html');
     }      }
     &Apache::loncommon::no_cache($r);      &Apache::loncommon::no_cache($r);
     $r->send_http_header;      $r->send_http_header;
Line 439  sub handler { Line 455  sub handler {
     my $lastres=$hash{'map_finish_'.      my $lastres=$hash{'map_finish_'.
            &Apache::lonnet::clutter($ENV{'request.course.uri'})};             &Apache::lonnet::clutter($ENV{'request.course.uri'})};
     if (!(($firstres) && ($lastres))) {      if (!(($firstres) && ($lastres))) {
  $r->print('<html><body>Coursemap undefined.</body></html>');          $r->print('<html><body>Coursemap undefined.</body></html>');
     } else {      } else {
   
 # ----------------------------------------------------------------- Render page  # ----------------------------------------------------------------- Render page
Line 447  sub handler { Line 463  sub handler {
   
   
 # ---------------------------- initialize coursedata and userdata for this user  # ---------------------------- initialize coursedata and userdata for this user
  undef %courseopt;          undef %courseopt;
  undef %useropt;          undef %useropt;
   
  my $uname=$ENV{'user.name'};          my $uname=$ENV{'user.name'};
  my $udom=$ENV{'user.domain'};          my $udom=$ENV{'user.domain'};
  my $uhome=$ENV{'user.home'};          my $uhome=$ENV{'user.home'};
  my $cid=$ENV{'request.course.id'};          my $cid=$ENV{'request.course.id'};
  my $chome=$ENV{'course.'.$cid.'.home'};          my $chome=$ENV{'course.'.$cid.'.home'};
  my ($cdom,$cnum)=split(/\_/,$cid);          my ($cdom,$cnum)=split(/\_/,$cid);
   
  my $userprefix=$uname.'_'.$udom.'_';          my $userprefix=$uname.'_'.$udom.'_';
           
  unless ($uhome eq 'no_host') {           unless ($uhome eq 'no_host') { 
 # -------------------------------------------------------------- Get coursedata  # ------------------------------------------------- Get coursedata (if present)
     unless ((time-$courserdatas{$cid.'.last_cache'})<240) {              unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
  my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.                  my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
  ':resourcedata',$chome);                                                   ':resourcedata',$chome);
  if ($reply!~/^error\:/) {                  if ($reply!~/^error\:/) {
     $courserdatas{$cid}=$reply;                      $courserdatas{$cid}=$reply;
     $courserdatas{$cid.'.last_cache'}=time;                      $courserdatas{$cid.'.last_cache'}=time;
  }                  }
     }                  # check to see if network failed
     foreach (split(/\&/,$courserdatas{$cid})) {                  elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
  my ($name,$value)=split(/\=/,$_);                  {
  $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=                      $networkFailedFlag = 1;
     &Apache::lonnet::unescape($value);                  }
     }              }
               foreach (split(/\&/,$courserdatas{$cid})) {
                   my ($name,$value)=split(/\=/,$_);
                   $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
                       &Apache::lonnet::unescape($value);
               }
 # --------------------------------------------------- Get userdata (if present)  # --------------------------------------------------- Get userdata (if present)
     unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {              unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
  my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);                  my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
  if ($reply!~/^error\:/) {                  if ($reply!~/^error\:/) {
     $userrdatas{$uname.'___'.$udom}=$reply;                      $userrdatas{$uname.'___'.$udom}=$reply;
     $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;                      $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
  }                  }
     }              }
     foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {              foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
  my ($name,$value)=split(/\=/,$_);                  my ($name,$value)=split(/\=/,$_);
  $useropt{$userprefix.&Apache::lonnet::unescape($name)}=                  $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
     &Apache::lonnet::unescape($value);                      &Apache::lonnet::unescape($value);
     }              }
  }          }
   
  @rows=();          @rows=();
   
  &tracetable(0,$firstres,'&','',0);          &tracetable(0,$firstres,'&','',0);
   
 # ------------------------------------------------------------------ Page parms  # ------------------------------------------------------------------ Page parms
   
  my $j;          my $j;
  my $i;          my $i;
  my $lcm=1;          my $lcm=1;
  my $contents=0;          my $contents=0;
   
 # ---------------------------------------------- Go through table to get layout  # ---------------------------------------------- Go through table to get layout
   
  for ($i=0;$i<=$#rows;$i++) {          for ($i=0;$i<=$#rows;$i++) {
     if ($rows[$i]) {              if ($rows[$i]) {
  &Apache::lonxml::debug("Row $i is:".$rows[$i]);                  &Apache::lonxml::debug("Row $i is:".$rows[$i]);
  $contents++;                  $contents++;
  my @colcont=split(/\&/,$rows[$i]);                  my @colcont=split(/\&/,$rows[$i]);
  $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));                  $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
     }               } 
  }          }
   
   
  unless ($contents) {          unless ($contents) {
     $r->print('<html><body>Empty Map.</body></html>');              $r->print('<html><body>Empty Map.</body></html>');
  } else {          } else {
   
 # ------------------------------------------------------------------ Build page  # ------------------------------------------------------------------ Build page
   
     my $currenturl=$ENV{'form.postdata'};              my $currenturl=$ENV{'form.postdata'};
     $currenturl=~s/^http\:\/\///;              $currenturl=~s/^http\:\/\///;
     $currenturl=~s/^[^\/]+//;              $currenturl=~s/^[^\/]+//;
   
 # ---------------------------------------------------------------- Send headers  # ---------------------------------------------------------------- Send headers
   
     my $date=localtime;              my $date=localtime;
     my $now=time;              my $now=time;
 # ----------------------------------------- Get email status and discussiontime  # ----------------------------------------- Get email status and discussiontime
   
     my %emailstatus=&Apache::lonnet::dump('email_status');              my %emailstatus=&Apache::lonnet::dump('email_status');
     my $logouttime=$emailstatus{'logout'};              my $logouttime=$emailstatus{'logout'};
     my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}};              my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}};
     my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime);              my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime);
   
     my %discussiontimes=&Apache::lonnet::dump('discussiontimes',              my %discussiontimes=&Apache::lonnet::dump('discussiontimes',
   $cdom,$cnum);                                                            $cdom,$cnum);
   
     my %feedback=();              my %feedback=();
     my %error=();              my %error=();
     foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'.              foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'.
  $ENV{'user.domain'}.':'.                                                                   $ENV{'user.domain'}.':'.
  $ENV{'user.name'}.':nohist_email',                                                                   $ENV{'user.name'}.':nohist_email',
  $ENV{'user.home'}))) {                                                                   $ENV{'user.home'}))) {
  $msgid=&Apache::lonnet::unescape($msgid);                  $msgid=&Apache::lonnet::unescape($msgid);
  my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));                  my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
  if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {                  if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
     my ($what,$url)=($1,$2);                      my ($what,$url)=($1,$2);
     my %status=                      my %status=
  &Apache::lonnet::get('email_status',[$msgid]);                          &Apache::lonnet::get('email_status',[$msgid]);
     if ($status{$msgid}=~/^error\:/) {                       if ($status{$msgid}=~/^error\:/) { 
  $status{$msgid}='';                           $status{$msgid}=''; 
     }                      }
                           
     if (($status{$msgid} eq 'new') ||                       if (($status{$msgid} eq 'new') || 
  (!$status{$msgid})) {                           (!$status{$msgid})) { 
  if ($what eq 'Error') {                          if ($what eq 'Error') {
     $error{$url}.=','.$msgid;                               $error{$url}.=','.$msgid; 
  } else {                          } else {
     $feedback{$url}.=','.$msgid;                              $feedback{$url}.=','.$msgid;
  }                          }
     }                      }
  }                  }
     }              }
 # ----------------------------------------------------------- Start Page Output  # ----------------------------------------------------------- Start Page Output
             my $bodytagadd='';              my $bodytagadd='';
     $r->print(              $r->print(
                    '<html><head><title>Navigate Course Map</title></head>');                     '<html><head><title>Navigate Course Map</title></head>');
     if (($currenturl=~/^\/res/) &&              if (($currenturl=~/^\/res/) &&
  ($currenturl!~/^\/res\/adm/)) {                  ($currenturl!~/^\/res\/adm/)) {
  $bodytagadd='onLoad="window.location.hash='."'curloc'".'"';                  $bodytagadd='onLoad="window.location.hash='."'curloc'".'"';
     }              }
     $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',              $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
                                                   $bodytagadd));                                                    $bodytagadd));
     $r->print('<script>window.focus();</script>');              $r->print('<script>window.focus();</script>');
     my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};              my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
     if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }              if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
     $r->print("<h3>$date</h3>\n");              $r->print("<h3>$date</h3>\n");
     $r->rflush();              $r->rflush();
     $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.              $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
       localtime($lastcheck).                        localtime($lastcheck).
       '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>');                         '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
     if (($currenturl=~/^\/res/) &&              if (($currenturl=~/^\/res/) &&
  ($currenturl!~/^\/res\/adm/)) {                  ($currenturl!~/^\/res\/adm/)) {
  $r->print('<a href="#curloc">Current Location</a><p>');                  $r->print('<a href="#curloc">Current Location</a><p>');
     }              }
   
               # Handle a network error
   
               if ($networkFailedFlag)
               {
                   $r->print('<H2>LON-CAPA network failure.</H2>'."\n");
                   $r->print("<p>LON-CAPA's network is having difficulties, some problem" .
                             " information, such as due dates, will not be available.");
               }
 # ----------------------------------------------------- The little content list  # ----------------------------------------------------- The little content list
     for ($i=0;$i<=$#rows;$i++) {              for ($i=0;$i<=$#rows;$i++) {
  if ($rows[$i]) {                  if ($rows[$i]) {
     my @colcont=split(/\&/,$rows[$i]);                      my @colcont=split(/\&/,$rows[$i]);
     my $avespan=$lcm/($#colcont+1);                      my $avespan=$lcm/($#colcont+1);
     for ($j=0;$j<=$#colcont;$j++) {                      for ($j=0;$j<=$#colcont;$j++) {
  my $rid=$colcont[$j];                          my $rid=$colcont[$j];
  if ($rid=~/^h(.+)/) {                          if ($rid=~/^h(.+)/) {
     $rid=$1;                              $rid=$1;
     $r->print('&nbsp;&nbsp;&nbsp;<a href="#'.                              $r->print('&nbsp;&nbsp;&nbsp;<a href="#'.
       $rid.'">'.$hash{'title_'.$rid}.                                        $rid.'">'.$hash{'title_'.$rid}.
       '</a><br>');                                        '</a><br>');
  }                          }
     }                      }
  }                  }
     }              }
 # ----------------------------------------------------------------- Start table  # ----------------------------------------------------------------- Start table
     $r->print('<hr><table cols="'.$lcm.'" border="0">');              $r->print('<hr><table cols="'.$lcm.'" border="0">');
     for ($i=0;$i<=$#rows;$i++) {              for ($i=0;$i<=$#rows;$i++) {
  if ($rows[$i]) {                  if ($rows[$i]) {
     $r->print("\n<tr>");                      $r->print("\n<tr>");
     my @colcont=split(/\&/,$rows[$i]);                      my @colcont=split(/\&/,$rows[$i]);
     my $avespan=$lcm/($#colcont+1);                      my $avespan=$lcm/($#colcont+1);
   
     # for each item I wish to print on this row...                      # for each item I wish to print on this row...
     for ($j=0;$j<=$#colcont;$j++) {                      for ($j=0;$j<=$#colcont;$j++) {
  my $indent;my $indentstr;                          my $indent;my $indentstr;
  my $linkid;                          my $linkid;
  my $rid=$colcont[$j];                          my $rid=$colcont[$j];
   
  # bug? $rid can't accept a list of two elements  
                         $rid=~/(\d+)\.(\d+)$/;                          $rid=~/(\d+)\.(\d+)$/;
  my $src=                          my $src=
    &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});                             &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
  my $symb=                          my $symb=
   &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src;            &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src;
  my $add='<td>';                          my $add='<td>';
  my $adde='</td>';                          my $adde='</td>';
  my $hwk='<font color="#223322">';                          my $hwk='<font color="#223322">';
  my $hwke='</font>';                          my $hwke='</font>';
  if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; }                          if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; }
  if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; }                          if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; }
  if ($rid=~/^h(.+)/) {                          if ($rid=~/^h(.+)/) {
     $rid=$1;                              $rid=$1;
     $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">';                              $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">';
     $adde='</th>';                              $adde='</th>';
                             if (($ENV{'user.adv'}) &&                               if (($ENV{'user.adv'}) && 
  ($parmhash{$symb.'.0.parameter_randompick'})) {                                  ($parmhash{$symb.'.0.parameter_randompick'})) {
                                $adde=' (randomly select '.                                 $adde=' (randomly select '.
    $parmhash{$symb.'.0.parameter_randompick'}.                                     $parmhash{$symb.'.0.parameter_randompick'}.
                                    ')</th>';                                     ')</th>';
                             }                              }
  }                          }
  if ($rid=~/^j(.+)/) { $rid=$1; }                          if ($rid=~/^j(.+)/) { $rid=$1; }
  if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {                          if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {
     # sub astatus describes what code/tcode mean                              # sub astatus describes what code/tcode mean
     my $code=$1;                              my $code=$1;
     my $tcode=$2;                              my $tcode=$2;
     my $ctext=$3;                              my $ctext=$3;
     $rid=$4;                              $rid=$4;
     if ($tcode eq '1') {                              
  $add='<td bgcolor="#AAAAAA">';                              # will open later
     }                              if ($tcode eq '1') { 
     if ($code eq '3') {                                  $add='<td bgcolor="#AAAAAA">';
  $add='<td bgcolor="#AAFFAA">';                              }
     } elsif ($code eq '4') {  
  $add='<td bgcolor="#E0FFAA">';                              # solved/correct
     } else {                              if ($code eq '3') {
  $add='<td bgcolor="#CCCCFF">';                                  $add='<td bgcolor="#AAFFAA">';
  if ($tcode eq '2') {                              } elsif ($code eq '4') { # partially correct
     $add='<td bgcolor="#FFFFAA">';                                  $add='<td bgcolor="#E0FFAA">';
  }                              } else {
  if ($tcode eq '4') {                                  # not attempted
     $add='<td bgcolor="#FFFF33">';                                  
     $adde='</td>';                                  # we end up here on network failure, so pick a neutral
  }                                  # color if the network failed instead of bright red.
     }                                  if ( $networkFailedFlag )
     $hwk='<font color="#888811"><b>';                                  {
     $hwke='</b></font>';                                      $add = '<td bgcolor="#AAAAAA">';
     if ($code eq '1') {                                  }
  $hwke='</b> ('.$ctext.')</font>';                                  else
     }                                  {
     if ($code eq '2' || $code eq '4') {                                      $add='<td bgcolor="#FFAAAA">';
  $hwk='<font color="#992222"><b>';                                  }
  $hwke='</b> ('.$ctext.')</font>';  
     }                                  if ($tcode eq '2') { # open, not past due
     if ($code eq '3') {                                      $add='<td bgcolor="#FFFFAA">';
  $hwk='<font color="#229922"><b>';                                  }
  $hwke='</b> ('.$ctext.')</font>';  
     }                                  if ($tcode eq '4') { # due in next 24 hours
  }                                      $add='<td bgcolor="#FFFF33">';
  if ($rid && $hash{'src_'.$rid} eq $currenturl) {                                      $adde='</td>';
     $add=$add.'<a name="curloc"></a>'.                                  }
  '<font color=red size=+2><b>&gt; </b></font>';                              }
     $adde=                              $hwk='<font color="#888811"><b>';
  '<font color=red size=+2><b> &lt;</b></font>'.$adde;                              $hwke='</b></font>';
  }                              if ($code eq '1') {
  if ($discussiontimes{$symb}>$lastcheck) {                                  $hwke='</b> ('.$ctext.')</font>';
     $adde=                              }
  '<img border=0 src="/adm/lonMisc/chat.gif">'.                              if ($code eq '2' || $code eq '4') {
     $adde;                                  $hwk='<font color="#992222"><b>';
  }                                  $hwke='</b> ('.$ctext.')</font>';
  if ($error{$src}) {                              }
     foreach (split(/\,/,$error{$src})) {                              if ($code eq '3') {
  if ($_) {                                  $hwk='<font color="#229922"><b>';
     $adde=                                  $hwke='</b> ('.$ctext.')</font>';
  '&nbsp;<a href="/adm/email?display='.                              }
     &Apache::lonnet::escape($_).                              if ($networkFailedFlag) 
  '"><img src="/adm/lonMisc/bomb.gif" border=0></a>'                              {
     .$adde;                                  $hwke='</b> (status unavailable)</font>';
  }                              }
     }                          }
  }                          if ($rid && $hash{'src_'.$rid} eq $currenturl) {
  if ($feedback{$src}) {                              $add=$add.'<a name="curloc"></a>'.
     foreach (split(/\,/,$feedback{$src})) {                                  '<font color=red size=+2><b>&gt; </b></font>';
  if ($_) {                              $adde=
     $adde=                                  '<font color=red size=+2><b> &lt;</b></font>'.$adde;
  '&nbsp;<a href="/adm/email?display='.                          }
     &Apache::lonnet::escape($_).                          if ($discussiontimes{$symb}>$lastcheck) {
  '"><img src="/adm/lonMisc/feedback.gif" border=0></a>'                              $adde=
     .$adde;                                  '<img border=0 src="/adm/lonMisc/chat.gif">'.
  }                                      $adde;
     }                          }
  }                          if ($error{$src}) {
  if ($indent) {                              foreach (split(/\,/,$error{$src})) {
     my $is="&nbsp;&nbsp;";                                  if ($_) {
     for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; }                                      $adde=
  }                                          '&nbsp;<a href="/adm/email?display='.
  if (!$linkid) { $linkid=$rid; }                                              &Apache::lonnet::escape($_).
                                                   '"><img src="/adm/lonMisc/bomb.gif" border=0></a>'
                                                       .$adde;
                                   }
                               }
                           }
                           if ($feedback{$src}) {
                               foreach (split(/\,/,$feedback{$src})) {
                                   if ($_) {
                                       $adde=
                                           '&nbsp;<a href="/adm/email?display='.
                                               &Apache::lonnet::escape($_).
                                                   '"><img src="/adm/lonMisc/feedback.gif" border=0></a>'
                                                       .$adde;
                                   }
                               }
                           }
                           if ($indent) {
                               my $is="&nbsp;&nbsp;";
                               for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; }
                           }
                           if (!$linkid) { $linkid=$rid; }
                         if ($hash{'randomout_'.$rid}) {                          if ($hash{'randomout_'.$rid}) {
                             $adde=' <i>(hidden)</i>'.$adde;                              $adde=' <i>(hidden)</i>'.$adde;
                         }                          }
  $r->print($add.$indentstr);                          $r->print($add.$indentstr);
  if ($rid) {                          if ($rid) {
     $r->print('<a href="'.$hash{'src_'.$linkid}.                              $r->print('<a href="'.$hash{'src_'.$linkid}.
                                       (($hash{'src_'.$linkid}=~/\?/)?'&':'?').                                        (($hash{'src_'.$linkid}=~/\?/)?'&':'?').
                                       'symb='.&Apache::lonnet::escape($symb)                                        'symb='.&Apache::lonnet::escape($symb)
                                        .'">'.                                         .'">'.
       $hwk.$hash{'title_'.$rid}.$hwke.'</a>');                                        $hwk.$hash{'title_'.$rid}.$hwke.'</a>');
  }                          }
  $r->print($adde);                          $r->print($adde);
     }                      }
     $r->print('</tr>');                      $r->print('</tr>');
  }                  }
     }              }
     $r->print("\n</table>");              $r->print("\n</table>");
     $r->print('</body></html>');              $r->print('</body></html>');
 # -------------------------------------------------------------------- End page  # -------------------------------------------------------------------- End page
  }                            }                  
 # ------------------------------------------------------------- End render page  # ------------------------------------------------------------- End render page
     }      }
 # ------------------------------------------------------------------ Untie hash  # ------------------------------------------------------------------ Untie hash
     unless (untie(%hash)) {      unless (untie(%hash)) {
  &Apache::lonnet::logthis("<font color=blue>WARNING: ".          &Apache::lonnet::logthis("<font color=blue>WARNING: ".
  "Could not untie coursemap $fn (browse).</font>");                                    "Could not untie coursemap $fn (browse).</font>"); 
     }      }
     unless (untie(%parmhash)) {      unless (untie(%parmhash)) {
  &Apache::lonnet::logthis("<font color=blue>WARNING: ".          &Apache::lonnet::logthis("<font color=blue>WARNING: ".
  "Could not untie parmhash (browse).</font>");                                    "Could not untie parmhash (browse).</font>"); 
       }
       return OK;
   }
   
   sub new_handle {
       my $r = shift;
   
       # Handle header-only request
       if ($r->header_only) {
           if ($ENV{'browser.mathml'}) {
               $r->content_type('text/xml');
           } else {
               $r->content_type('text/html');
           }
           $r->send_http_header;
           return OK;
       }
   
       # Send header, don't cache this page
       if ($ENV{'browser.mathml'}) {
           $r->content_type('text/xml');
       } else {
           $r->content_type('text/html');
       }
       &Apache::loncommon::no_cache($r);
       $r->send_http_header;
   
       # Header
       $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
                                             ''));
       # Initialize the nav map
       my $navmap = Apache::lonnavmaps::navmap->new(
                           $ENV{"request.course.fn"}.".db",
                           $ENV{"request.course.fn"}."_parms.db", 1);
   
   
       if (!defined($navmap)) {
           my $requrl = $r->uri;
           $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
           return HTTP_NOT_ACCEPTABLE;
       }
   
       # Check that it's defined
       if (!($navmap->courseMapDefined())) {
           $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
                     '</body></html>');
           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 = "#FFCCCC";
   
       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' );
   
       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";
           }
       }
   
       # Begin the HTML table
       # four cols: resource + indent, chat+feedback, icon, text string
       $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
   
       my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);
       my $curRes = $mapIterator->next();
       undef $res; # so we don't accidentally use it later
       my $indentLevel = -1;
       my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";
   
       my $isNewBranch = 0;
       my $now = time();
       my $in24Hours = $now + 24 * 60 * 60;
   
       while ($curRes != $mapIterator->END_NAV_MAP) {
           if ($curRes == $mapIterator->BEGIN_MAP() ||
               $curRes == $mapIterator->BEGIN_BRANCH()) {
               $indentLevel++;
           }
           if ($curRes == $mapIterator->END_MAP() ||
               $curRes == $mapIterator->END_BRANCH()) {
               $indentLevel--;
           }
           if ($curRes == $mapIterator->BEGIN_BRANCH()) {
               $isNewBranch = 1;
           }
   
           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
       } 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
               }
   
       # Step two: Show the parts
               foreach my $part (@parts) {
   
    my $deltalevel = 0; # for inserting the branch icon
                   
                   # For each thing we're displaying...
   
                   my $stack = $mapIterator->getStack();
                   my $src = getLinkForResource($stack);
   
                   my $srcHasQuestion = $src =~ /\?/;
                   my $link = $src.
                       ($srcHasQuestion?'&':'?') .
                       'symb='.&Apache::lonnet::escape($curRes->symb()).
                       '"';
                   my $title = $curRes->title();
                   my $partLabel = "";
                   my $newBranchText = "";
   
                   # If this is a new branch, label it so
                   # (temporary, this should be an icon w/ alt text)
                   if ($isNewBranch) {
                       $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
                       $isNewBranch = 0;
       $deltalevel = 1;
                   }
   
                   # links to open and close the folders
                   my $linkopen = "<a href=\"$link\">";
                   my $linkclose = "</a>";
   
                   my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
                   if ($curRes->is_problem()) { 
       if ($part eq "0" || $condensed) {
    $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; 
       } else {
    $icon = $indentString;
       }
                   }
   
                   # Display the correct icon, link to open or shut map
                   if ($curRes->is_map()) { 
                       my $mapId = $curRes->map_pc();
                       my $nowOpen = !defined($filterHash{$mapId});
                       $icon = $nowOpen ?
                           "folder_opened.gif" : "folder_closed.gif";
       $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
                       $linkopen = "<a href=\"/adm/navmaps?filter=";
                       $linkopen .= $nowOpen ? 
                           addToFilter(\%filterHash, $mapId) :
                           removeFromFilter(\%filterHash, $mapId);
                       $linkopen .= "\">";
                       $linkclose = "</a>";
                       
                   }
                   
                   my $colorizer = "";
                   if ($curRes->is_problem()) {
                       my $status = $curRes->status($part);
                       my $color = $colormap{$status};
                       if ($color ne "") {
                           $colorizer = "bgcolor=\"$color\"";
                       }
                   }
   
    # FIRST ROW: The resource indentation, branch icon, and name
                   $r->print("  <tr><td align=\"left\" valign=\"top\">\n");
   
                   # print indentation
                   for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
                       $r->print($indentString);
                   }
   
                   $r->print("  ${newBranchText}${linkopen}$icon${linkclose}\n");
   
                   if ($curRes->is_problem() && $part != "0" && !$condensed) { 
       $partLabel = " (Part $part)"; 
       $title = "";
    }
   
                   $r->print("  <a href=\"$link\">$title$partLabel</a></td>");
   
    my $discussionHTML = ""; my $feedbackHTML = "";
   
    # SECOND ROW: Is there text or feedback?
    if ($curRes->hasDiscussion()) {
       $discussionHTML = $linkopen .
    '<img border="0" src="/adm/lonMisc/chat.gif" />' .
    $linkclose;
    }
   
    if ($curRes->getFeedback()) {
       my $feedback = $curRes->getFeedback();
       foreach (split(/\,/, $feedback)) {
    if ($_) {
       $feedbackHTML .= '&nbsp;<a href="/adm/email?display='
    . &Apache::lonnet::escape($_) . '">'
    . '<img src="/adm/lonMisc/feedback.gif" '
    . 'border="0" /></a>';
    }
       }
    }
   
    $r->print("<td align=\"left\">$discussionHTML$feedbackHTML</td>");
   
    # 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 ROW: Problem status icon
    if ($curRes->is_problem() &&
       !$firstDisplayed) {
       my $icon = $statusIconMap{$curRes->status($part)};
       if ($icon) {
    $r->print("<td width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");
       } else {
    $r->print("<td></td>\n");
       }
    } else { # not problem, no icon
       $r->print("<td></td>\n");
    }
   
     # FOURTH ROW: Text description
    $r->print("<td $colorizer align=\"right\">\n");
                   
                   if ($curRes->kind() eq "res" &&
                       $curRes->is_problem() &&
       !$firstDisplayed) {
                       $r->print (getDescription($curRes, $part));
                   }
   
    $r->print("</td></tr>\n");
               }
           }
           $curRes = $mapIterator->next();
     }      }
   
       $r->print("</table></body></html>");
   
       $navmap->untieHashes();
   
     return OK;      return OK;
 }  }
   
   # Convenience functions: Returns a string that adds or subtracts
   # the second argument from the first hash, appropriate for the 
   # query string that determines which folders to recurse on
   sub addToFilter {
       my $hashIn = shift;
       my $addition = shift;
       my %hash = %$hashIn;
       $hash{$addition} = 1;
   
       return join (",", keys(%hash));
   }
   
   sub removeFromFilter {
       my $hashIn = shift;
       my $subtraction = shift;
       my %hash = %$hashIn;
   
       delete $hash{$subtraction};
       return join(",", keys(%hash));
   }
   
   # Convenience function: Given a stack returned from getStack on the iterator,
   # return the correct src() value.
   # Later, this should add an anchor when we start putting anchors in pages.
   sub getLinkForResource {
       my $stack = shift;
       my $res;
   
       # Check to see if there are any pages in the stack
       foreach $res (@$stack) {
           if (defined($res) && $res->is_page()) {
               return $res->src();
           }
       }
   
       # Failing that, return the src of the last resource that is defined
       # (when we first recurse on a map, it puts an undefined resource
       # on the bottom because $self->{HERE} isn't defined yet, and we
       # want the src for the map anyhow)
       foreach (@$stack) {
           if (defined($_)) { $res = $_; }
       }
   
       return $res->src();
   }
   
   # Convenience function: This seperates the logic of how to create
   # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
   # etc.) into a seperate function. It takes a resource object as the
   # first parameter, and the part number of the resource as the second.
   # It's basically a big switch statement on the status of the resource.
   
   sub getDescription {
       my $res = shift;
       my $part = shift;
       my $status = $res->getDateStatus();
   
       if ($status == $res->NETWORK_FAILURE) { return ""; }
       if ($status == $res->NOTHING_SET) {
           return "Not currently assigned.";
       }
       if ($status == $res->OPEN_LATER) {
           return "Opens: " . timeToHumanString($res->opendate($part));
       }
       if ($status == $res->OPEN) {
    if ($res->duedate()) {
       return "Due: $status " . timeToHumanString($res->duedate($part));
    } else {
       return "Open, no due date";
    }
       }
       if ($status == $res->PAST_DUE_ANSWER_LATER) {
           return "Answer opens: " . timeToHumanString($res->answerdate($part));
       }
       if ($status == $res->PAST_DUE_NO_ANSWER) {
           return "Was Due: " . timeToHumanString($res->duedate($part));
       }
       if ($status == $res->ANSWER_OPEN) {
           return "Answer available";
       }
       if ($status == $res->EXCUSED) {
    return "Excused by instructor";
       }
       if ($status == $res->TRIES_LEFT) {
    my $tries = $res->tries();
    my $maxtries = $res->maxtries();
    my $triesString = "($tries of $maxtries tries used)";
    if ($res->duedate()) {
       return "Due: $status " . timeToHumanString($res->duedate($part)) .
    " $triesString";
    } else {
       return "No due date $triesString";
    }
       }
   }
   
   # I want to change this into something more human-friendly. For
   # now, this is a simple call to localtime. The final function
   # probably belongs in loncommon.
   sub timeToHumanString {
       my ($time) = @_;
       # zero, '0' and blank are bad times
       if ($time) {
    return localtime($time);
       } else {
    return 'Never';
       }
   }
   
 1;  1;
 __END__  
   
   package Apache::lonnavmaps::navmap;
   
   # LEFT:
   # * Actual handler code (multi-part)
   # * Branches (aieee!) (and conditionals)
   
   =pod
   
   lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
   
   =head1 navmap object: Encapsulating the compiled nav map
   
   navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
   
   Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.
   
   You must obtain resource objects through the navmap object.
   
   =head2 Methods
   
   =over 4
   
   =item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
   
   =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
   
   =cut
   
   use strict;
   use GDBM_File;
   
   sub new {
       # magic invocation to create a class instance
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = {};
   
       $self->{NAV_HASH_FILE} = shift;
       $self->{PARM_HASH_FILE} = shift;
       $self->{GENERATE_COURSE_USER_OPT} = shift;
       $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
   
       # Resource cache stores navmapresource's as we reference them. We generate
       # them on-demand so we don't pay for creating resources unless we use them.
       $self->{RESOURCE_CACHE} = {};
   
       # Network failure flag, if we accessed the course or user opt and
       # failed
       $self->{NETWORK_FAILURE} = 0;
   
       # tie the nav hash
       my %navmaphash;
       if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
                 &GDBM_READER(), 0640))) {
           return undef;
       }
       $self->{NAV_HASH} = \%navmaphash;
       
       my %parmhash;
       if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
                 &GDBM_READER(), 0640)))
       {
    untie $self->{PARM_HASH};
           return undef;
       }
       $self->{PARM_HASH} = \%parmhash;
       $self->{HASH_TIED} = 1;
   
       # If the course opt hash and the user opt hash should be generated,
       # generate them
       if ($self->{GENERATE_COURSE_USER_OPT}) {
           my $uname=$ENV{'user.name'};
           my $udom=$ENV{'user.domain'};
           my $uhome=$ENV{'user.home'};
           my $cid=$ENV{'request.course.id'};
           my $chome=$ENV{'course.'.$cid.'.home'};
           my ($cdom,$cnum)=split(/\_/,$cid);
           
           my $userprefix=$uname.'_'.$udom.'_';
           
           my %courserdatas; my %useropt; my %courseopt;
           unless ($uhome eq 'no_host') { 
   # ------------------------------------------------- Get coursedata (if present)
               unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
                   my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
                                                    ':resourcedata',$chome);
                   if ($reply!~/^error\:/) {
                       $courserdatas{$cid}=$reply;
                       $courserdatas{$cid.'.last_cache'}=time;
                   }
                   # check to see if network failed
                   elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
                   {
                       $self->{NETWORK_FAILURE} = 1;
                   }
               }
               foreach (split(/\&/,$courserdatas{$cid})) {
                   my ($name,$value)=split(/\=/,$_);
                   $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
                       &Apache::lonnet::unescape($value);
               }
   # --------------------------------------------------- Get userdata (if present)
               unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
                   my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
                   if ($reply!~/^error\:/) {
                       $userrdatas{$uname.'___'.$udom}=$reply;
                       $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
                   }
                   # check to see if network failed
                   elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
                   {
                       $self->{NETWORK_FAILURE} = 1;
                   }
               }
               foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
                   my ($name,$value)=split(/\=/,$_);
                   $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
                       &Apache::lonnet::unescape($value);
               }
               $self->{COURSE_OPT} = \%courseopt;
               $self->{USER_OPT} = \%useropt;
           }
       }   
   
       if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
           my $cid=$ENV{'request.course.id'};
           my ($cdom,$cnum)=split(/\_/,$cid);
           
           my %emailstatus = &Apache::lonnet::dump('email_status');
           my $logoutTime = $emailstatus{'logout'};
           my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
           $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
                                  $courseLeaveTime : $logoutTime);
           my %discussiontime = &Apache::lonnet::dump('discussiontimes', 
                                                      $cdom, $cnum);
           my %feedback=();
           my %error=();
           my $keys = &Apache::lonnet::reply('keys:'.
                                             $ENV{'user.domain'}.':'.
                                             $ENV{'user.name'}.':nohist_email',
                                             $ENV{'user.home'});
   
           foreach my $msgid (split(/\&/, $keys)) {
               $msgid=&Apache::lonnet::unescape($msgid);
               my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
               if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
                   my ($what,$url)=($1,$2);
                   my %status=
                       &Apache::lonnet::get('email_status',[$msgid]);
                   if ($status{$msgid}=~/^error\:/) { 
                       $status{$msgid}=''; 
                   }
                   
                   if (($status{$msgid} eq 'new') || 
                       (!$status{$msgid})) { 
                       if ($what eq 'Error') {
                           $error{$url}.=','.$msgid; 
                       } else {
                           $feedback{$url}.=','.$msgid;
                       }
                   }
               }
           }
           
           $self->{FEEDBACK} = \%feedback;
           $self->{ERROR_MSG} = \%error; # what is this? JB
           $self->{DISCUSSION_TIME} = \%discussiontime;
           $self->{EMAIL_STATUS} = \%emailstatus;
           
       }    
       
       bless($self);
           
       return $self;
   }
   
   # Checks to see if coursemap is defined, matching test in old lonnavmaps
   sub courseMapDefined {
       my $self = shift;
       my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
   
       my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
       my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
       return $firstres && $lastres;
   }
   
   sub getIterator {
       my $self = shift;
       my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
                                                        shift, shift);
       return $iterator;
   }
   
   # unties the hash when done
   sub untieHashes {
       my $self = shift;
       untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
       untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
       $self->{HASH_TIED} = 0;
   }
   
   # when the object is destroyed, be sure to untie all the hashes we tied.
   sub DESTROY {
       my $self = shift;
       $self->untieHashes();
   }
   
   # Private function: Does the given resource (as a symb string) have
   # current discussion? Returns 0 if chat/mail data not extracted.
   sub hasDiscussion {
       my $self = shift;
       my $symb = shift;
       if (!defined($self->{DISCUSSION_TIME})) { return 0; }
   
       return $self->{DISCUSSION_TIME}->{$symb} >
      $self->{LAST_CHECK};
   }
   
   # Private function: Does the given resource (as a symb string) have
   # current feedback? Returns the string in the feedback hash, which
   # will be false if it does not exist.
   sub getFeedback { 
       my $self = shift;
       my $symb = shift;
   
       if (!defined($self->{FEEDBACK})) { return ""; }
       
       return $self->{FEEDBACK}->{$symb};
   }
   
   =pod
   
   =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
   
   =cut
   
   # The strategy here is to cache the resource objects, and only construct them
   # as we use them. The real point is to prevent reading any more from the tied
   # hash then we have to, which should hopefully alleviate speed problems.
   # Caching is just an incidental detail I throw in because it makes sense.
   
   sub getById {
       my $self = shift;
       my $id = shift;
   
       if (defined ($self->{RESOURCE_CACHE}->{$id}))
       {
           return $self->{RESOURCE_CACHE}->{$id};
       }
   
       # resource handles inserting itself into cache.
       return Apache::lonnavmaps::resource->new($self, $id);
   }
   
   =pod
   
   =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
   
   =cut
   
   sub firstResource {
       my $self = shift;
       my $firstResource = $self->{NAV_HASH}->{'map_start_' .
                        &Apache::lonnet::clutter($ENV{'request.course.uri'})};
       return $self->getById($firstResource);
   }
   
   =pod
   
   =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
   
   =cut
   
   sub finishResource {
       my $self = shift;
       my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
                        &Apache::lonnet::clutter($ENV{'request.course.uri'})};
       return $self->getById($firstResource);
   }
   
   # -------------------------------------------- Figure out a cascading parameter
   #
   # For this function to work
   #
   # * parmhash needs to be tied
   # * courseopt and useropt need to be initialized for this user and course
   #
   
   sub parmval {
       my $self = shift;
       my ($what,$symb)=@_;
       my $cid=$ENV{'request.course.id'};
       my $csec=$ENV{'request.course.sec'};
       my $uname=$ENV{'user.name'};
       my $udom=$ENV{'user.domain'};
   
       unless ($symb) { return ''; }
       my $result='';
   
       my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
   
   # ----------------------------------------------------- Cascading lookup scheme
       my $rwhat=$what;
       $what=~s/^parameter\_//;
       $what=~s/\_/\./;
   
       my $symbparm=$symb.'.'.$what;
       my $mapparm=$mapname.'___(all).'.$what;
       my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
   
       my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
       my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
       my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
   
       my $courselevel= $usercourseprefix.'.'.$what;
       my $courselevelr=$usercourseprefix.'.'.$symbparm;
       my $courselevelm=$usercourseprefix.'.'.$mapparm;
   
       my $useropt = $self->{USER_OPT};
       my $courseopt = $self->{COURSE_OPT};
       my $parmhash = $self->{PARM_HASH};
   
   # ---------------------------------------------------------- first, check user
       if ($uname and defined($useropt)) {
           if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
           if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
           if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
       }
   
   # ------------------------------------------------------- second, check course
       if ($csec and defined($courseopt)) {
           if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
           if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
           if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
       }
   
       if (defined($courseopt)) {
           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=$self->parmval($part.".$qualifier",$symb);
               if (defined($partgeneral)) { return $partgeneral; }
           } else {
               my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
               if (defined($resourcegeneral)) { return $resourcegeneral; }
           }
       }
       return '';
   }
   
   
   1;
   
   package Apache::lonnavmaps::iterator;
   
   # This package must precede "navmap" because "navmap" uses it. In
   # order to keep the documentation order straight, the iterator is documented
   # after the navmap object.
   
   =pod
   
   =back
   
   =head1 navmap Iterator
   
   An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.
   
   To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:
   
   C<my $resourceIterator = $navmap-E<gt>getIterator();>
   
   To get the next thing from the iterator, call B<next>:
   
   C<my $nextThing = $resourceIterator-E<gt>next()>
   
   getIterator behaves as follows:
   
   =over 4
   
   =item B<getIterator>(nav_map, firstResource, finishResource, filterHash): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). It is your responsibility to ensure that the iterator will actually get there. filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 1, then only resource that exist IN the filterHash will be recursed on. If it is a 0, only resources NOT in the filterHash will be recursed on. Defaults to 0.
   
   Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples.
   
   The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
   
   =over 4
   
   =item * some list of tokens here
   
   =back
   
   The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_NAV_MAP. (Perl will automatically optimize these into constants.
   
   =cut
   
   # Here are the tokens for the iterator:
   
   sub END_NAV_MAP { return 0; }  # Represents end of entire nav map
   sub BEGIN_MAP { return 1; }    # begining of a new map
   sub END_MAP { return 2; }      # end of the map
   sub BEGIN_BRANCH { return 3; } # beginning of a branch
   sub END_BRANCH { return 4; }   # end of a branch
   
   # Params: nav map, start resource, end resource, filter, condition, 
   # already seen hash ref
   
   sub new {
       # magic invocation to create a class instance
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = {};
   
       $self->{NAV_MAP} = shift;
       return undef unless ($self->{NAV_MAP});
   
       # Handle the parameters
       $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
       $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
   
       # If the given resources are just the ID of the resource, get the
       # objects
       if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} = 
                $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
       if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} = 
                $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
   
       $self->{FILTER} = shift;
   
       # A hash, used as a set, of resource already seen
       $self->{ALREADY_SEEN} = shift;
       if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
   
       # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
       $self->{STARTED} = 0;
   
       # Should we continue calling the recursive iterator, if any?
       $self->{RECURSIVE_ITERATOR_FLAG} = 0;
       # The recursive iterator, if any
       $self->{RECURSIVE_ITERATOR} = undef;
       # Are we recursing on a map, or a branch?
       $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
       # And the count of how deep it is, so that this iterator can keep track of
       # when to pick back up again.
       $self->{RECURSIVE_DEPTH} = 0;
   
       # For keeping track of our branches, we maintain our own stack
       $self->{BRANCH_STACK} = [];
       # If the size shrinks, we exhausted a branch
       $self->{BRANCH_STACK_SIZE} = 0;
       $self->{BRANCH_DEPTH} = 0;
   
       # For returning two things in a forced sequence
       $self->{FORCE_NEXT} = undef;
   
       # Start with the first resource
       push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
       $self->{BRANCH_STACK_SIZE} = 1;
   
       bless($self);
       return $self;
   }
   
   # Note... this function is *touchy*. I strongly recommend tracing
   # through it with the debugger a few times on a non-trivial map before
   # modifying it. Order is *everything*.
   sub next {
       my $self = shift;
       
       # Iterator logic goes here
   
       # Is this return value pre-determined?
       if (defined($self->{FORCE_NEXT})) {
           my $tmp = $self->{FORCE_NEXT};
           $self->{FORCE_NEXT} = undef;
           return $tmp;
       }
   
       # Are we using a recursive iterator? If so, pull from that and
       # watch the depth; we want to resume our level at the correct time.
       if ($self->{RECURSIVE_ITERATOR_FLAG})
       {
           # grab the next from the recursive iterator
           my $next = $self->{RECURSIVE_ITERATOR}->next();
           
           # is it a begin or end map? Update depth if so
           if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
           if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
   
           # Are we back at depth 0? If so, stop recursing.
           if ($self->{RECURSIVE_DEPTH} == 0) {
               $self->{RECURSIVE_ITERATOR_FLAG} = 0;
           }
           
           return $next;
       }
   
       # Is there a current resource to grab? If not, then return
       # END_BRANCH and END_MAP in succession.
       if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
           if ($self->{BRANCH_DEPTH} > 0) {
               $self->{FORCE_NEXT} = $self->END_MAP();
               $self->{BRANCH_DEPTH}--;
               return $self->END_BRANCH();
           } else {
               return $self->END_MAP();
           }
       }
   
       # Have we not yet begun? If not, return BEGIN_MAP and 
       # remember that we've started.
       if ( !$self->{STARTED} ) {
           $self->{STARTED} = 1;
           return $self->BEGIN_MAP;
       }
   
       # Did the branch stack shrink since last run? If so,
       # we exhausted a branch last time, therefore, we're about
       # to start a new one. (We know because we already checked to see
       # if the stack was empty.)
       if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
           $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
           $self->{BRANCH_DEPTH}++;
           return $self->BEGIN_BRANCH();
       }
   
       # 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}};
   
       # 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.
       $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
       
       # Are we at the utter end? If so, return the END_NAV_MAP marker.
       if ($self->{HERE} == $self->{NAV_MAP}->finishResource() ) {
           $self->{FORCE_NEXT} = $self->END_NAV_MAP;
           return $self->{HERE};
       }
       
       # Get the next possible resources
       my $nextUnfiltered = $self->{HERE}->getNext();
       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.
       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}--;
           }
           return $self->{HERE};
       }
       
       while (@$next) {
           # copy the next possibilities over to the branch stack
           # in the right order
           push @{$self->{BRANCH_STACK}}, shift @$next;
       }
   
       if ($nextCount >= 2) {
           $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
           $self->{BRANCH_DEPTH}++;
           return $self->{HERE}; 
       }
   
       # If this is a map and we want to recurse down it... (not filtered out)
       if ($self->{HERE}->is_map() && 
            !defined($self->{FILTER}->{$self->{HERE}->map_pc()})) { 
           $self->{RECURSIVE_ITERATOR_FLAG} = 1;
           my $firstResource = $self->{HERE}->map_start();
           my $finishResource = $self->{HERE}->map_finish();
   
           # Odd perl syntax here; $self->new allows one to create a new iterator
           # can't figure out how to ref this package directly correctly
           # isn't MAIN::new, __PACKAGE__::new or Apache::lonnavmaps::iterator->new
           $self->{RECURSIVE_ITERATOR} =
             Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, 
                        $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN});
           # prime the new iterator with the first resource
           #push @{$self->{RECURSIVE_ITERATOR}->{BRANCH_STACK}}, $firstResource;
       }
   
       return $self->{HERE};
   }
   
   =pod
   
   The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).
   
   =cut
   
   sub getStack {
       my $self=shift;
   
       my @stack;
   
       $self->populateStack(\@stack);
   
       return \@stack;
   }
   
   # Private method: Calls the iterators recursively to populate the stack.
   sub populateStack {
       my $self=shift;
       my $stack = shift;
   
       push @$stack, $self->{HERE};
   
       if ($self->{RECURSIVE_ITERATOR_FLAG}) {
           $self->{RECURSIVE_ITERATOR}->populateStack($stack);
       }
   }
   
   1;
   
   package Apache::lonnavmaps::resource;
   
   use Apache::lonnet;
   
   =pod
   
   =head1 Object: resource
   
   A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.
   
   A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
   
   You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
   
   =head2 Public Members
   
   resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.
   
   =head2 Methods
   
   =over 4
   
   =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. 
   
   =cut
   
   sub new {
       # magic invocation to create a class instance
       my $proto = shift;
       my $class = ref($proto) || $proto;
       my $self = {};
   
       $self->{NAV_MAP} = shift;
       $self->{ID} = shift;
   
       # Store this new resource in the parent nav map's cache.
       $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
   
       # A hash that can be used by two-pass algorithms to store data
       # about this resource in. Not used by the resource object
       # directly.
       $self->{DATA} = {};
      
       bless($self);
       
       return $self;
   }
   
   =pod
   
   =item * B<is_map>: Returns true if this is a map, false otherwise.
   
   =item * B<title>: Returns title.
   
   =item * B<type>: Returns the type of the resource, "start", "normal", or "finish". 
   
   =item * B<problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field.)
   
   =back
   
   =cut
   
   # private function: simplify the NAV_HASH lookups we keep doing
   # pass the name, and to automatically append my ID, pass a true val on the
   # second param
   sub navHash {
       my $self = shift;
       my $param = shift;
       my $id = shift;
       return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
   }
   
   # These info functions can be used directly, as they don't return
   # resource information.
   sub title { my $self=shift; return $self->navHash("title_", 1); }
   sub type { my $self=shift; return $self->navHash("type_", 1); }
   sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
   # "to" can return a comma seperated list for branches
   sub to { my $self=shift; return $self->navHash("to_", 1); }
   sub kind { my $self=shift; return $self->navHash("kind_", 1); }
   sub src { 
       my $self=shift;
       return $self->navHash("src_", 1);
   }
   sub symb {
       my $self=shift;
       (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
       my $symbSrc = &Apache::lonnet::declutter($self->src());
       return &Apache::lonnet::declutter(
            $self->navHash('map_id_'.$first)) 
           . '___' . $second . '___' . $symbSrc;
   }
   sub is_problem {
       my $self=shift;
       my $src = $self->src();
       return ($src =~ /problem$/);
   }
   sub is_html {
       my $self=shift;
       my $src = $self->src();
       return ($src =~ /html$/);
   }
   sub is_sequence {
       my $self=shift;
       my $src = $self->src();
       return ($src =~ /sequence$/);
   }
   sub is_page {
       my $self=shift;
       my $src = $self->src();
       return ($src =~ /page$/);
   }
   
   
   
   
   # Move this into POD: In order to use these correctly, courseopt
   # and useropt need to be generated
   sub parmval {
       my $self = shift;
       my $what = shift;
       my $part = shift || "0";
       return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
   }
   
   #####
   # Map Queries
   #####
   
   # These methods relate to whether or not the resource is a map, and the 
   # attributes of that map.
   
   sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
   sub map_finish {
       my $self = shift;
       my $src = $self->src();
       my $res = $self->navHash("map_finish_$src", 0);
       $res = $self->{NAV_MAP}->getById($res);
       return $res;
   }
   sub map_start {
       my $self = shift;
       my $src = $self->src();
       my $res = $self->navHash("map_start_$src", 0);
       $res = $self->{NAV_MAP}->getById($res);
       return $res;
   }
   sub map_pc {
       my $self = shift;
       my $src = $self->src();
       return $self->navHash("map_pc_$src", 0);
   }
   sub map_type {
       my $self = shift;
       my $pc = $self->map_pc();
       return $self->navHash("map_type_$pc", 0);
   }
   
   
   
   #####
   # Property queries
   #####
   
   # These functions will be responsible for returning the CORRECT
   # VALUE for the parameter, no matter what. So while they may look
   # like direct calls to parmval, they can be more then that.
   # So, for instance, the duedate function should use the "duedatetype"
   # information, rather then the resource object user.
   
   =pod
   
   =head2 Resource Parameters
   
   In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to "part 0", but can be directed to another part by passing the part as the second parameter.
   
   These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
   
   =over 4
   
   =item * B<acc>: Get the Client IP/Name Access Control information.
   
   =item * B<answerdate>: Get the answer-reveal date for the problem.
   
   =item * B<duedate>: Get the due date for the problem.
   
   =item * B<tries>: Get the number of tries the student has used on the problem.
   
   =item * B<maxtries>: Get the number of max tries allowed.
   
   =item * B<opendate>: Get the open date for the problem.
   
   =item * B<sig>: Get the significant figures setting.
   
   =item * B<tol>: Get the tolerance for the problem.
   
   =item * B<type>: Get the question type for the problem.
   
   =item * B<weight>: Get the weight for the problem.
   
   =back
   
   =cut
   
   sub acc {
       (my $self, my $part) = @_;
       return $self->parmval("acc", $part);
   }
   sub answerdate {
       (my $self, my $part) = @_;
       # Handle intervals
       if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
           return $self->duedate($part) + 
               $self->parmval("answerdate", $part);
       }
       return $self->parmval("answerdate", $part);
   }
   sub duedate {
       (my $self, my $part) = @_;
       return $self->parmval("duedate", $part);
   }
   sub maxtries {
       (my $self, my $part) = @_;
       return $self->parmval("maxtries", $part);
   }
   sub opendate {
       (my $self, my $part) = @_;
       if ($self->parmval("opendate.type", $part) eq 'date_interval') {
           return $self->duedate($part) -
               $self->parmval("opendate", $part);
       }
       return $self->parmval("opendate");
   }
   sub sig {
       (my $self, my $part) = @_;
       return $self->parmval("sig", $part);
   }
   sub tol {
       (my $self, my $part) = @_;
       return $self->parmval("tol", $part);
   }
   sub type {
       (my $self, my $part) = @_;
       return $self->parmval("type", $part);
   }
   sub weight {
       (my $self, my $part) = @_;
       return $self->parmval("weight", $part);
   }
   sub tries {
       my $self = shift;
       my $part = shift;
       $part = '0' if (!defined($part));
   
       # Make sure return hash is loaded, should error check
       $self->getReturnHash();
       
       my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
       if (!defined($tries)) {return '0';}
       return $tries;
   }
   
   # Multiple things need this
   sub getReturnHash {
       my $self = shift;
       
       if (!defined($self->{RETURN_HASH})) {
           my %tmpHash = &Apache::lonnet::restore($self->symb());
           $self->{RETURN_HASH} = \%tmpHash;
       }
   }       
   
   ######
   # Status queries
   ######
   
   # These methods query the status of problems.
   
   # If we need to count parts, this function determines the number of
   # parts from the metadata. When called, it returns a reference to a list
   # of strings corresponding to the parts. (Thus, using it in a scalar context
   # tells you how many parts you have in the problem:
   # $partcount = scalar($resource->countParts());
   # Don't use $self->{PARTS} directly because you don't know if it's been
   # computed yet.
   
   =pod
   
   =head2 Resource misc
   
   Misc. functions for the resource.
   
   =over 4
   
   =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
   
   =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
   
    for (split(/\,/, $res->getFeedback())) {
       my $link = &Apache::lonnet::escape($_);
       ...
   
   and use the link as appropriate.
   
   =cut
   
   sub hasDiscussion {
       my $self = shift;
       return $self->{NAV_MAP}->hasDiscussion($self->symb());
   }
   
   sub getFeedback {
       my $self = shift;
       return $self->{NAV_MAP}->getFeedback($self->symb());
   }
   
   =pod
   
   =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)
   
   =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.
   
   =back
   
   =cut
   
   sub parts {
       my $self = shift;
   
       $self->extractParts();
       return $self->{PARTS};
   }
   
   sub countParts {
       my $self = shift;
       
       my $parts = $self->parts();
       
       if (scalar(@{$parts}) == 1) { return 1;}
   
       return scalar(@{$parts}) - 1;
   }
   
   # Private function: Extracts the parts information and saves it
   sub extractParts { 
       my $self = shift;
       
       return if ($self->{PARTS});
   
       $self->{PARTS} = [];
   
       # Retrieve part count
       foreach (split(/\,/,&Apache::lonnet::metadata($self->src(), 
                                                     'allpossiblekeys'))) {
           if ($_ =~ /^parameter\_(.*)\_opendate$/) {
               push @{$self->{PARTS}}, $1;
           }
       }
       
       # Is this possible to do in one line? - Jeremy
       my @sortedParts = sort @{$self->{PARTS}};
       $self->{PARTS} = \@sortedParts;
   
       return;
   }
   
   =pod
   
   =head2 Resource Status
   
   Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status.
   
   There are two aspects to the status: the date-related information and the completion information.
   
   Idiomatic usage of these two methods would probably look something like
   
    foreach ($resource->parts()) {
       my $dateStatus = $resource->getDateStatus($_);
       my $completionStatus = $resource->getCompletionStatus($_);
   
       ... use it here ...
    }
   
   =over 4
   
   =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. You should still check to see if there is a due date at all, if you care about that. The possible return values are:
   
   =back
   
   B<Date Codes>
   
   =over 4
   
   =item * B<OPEN_LATER>: The problem will be opened later.
   
   =item * B<OPEN>: Open and not yet due.
   
   
   =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
   
   =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
   
   =item * B<ANSWER_OPEN>: The answer date is here.
   
   =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
   
   =back
   
   =cut
   
   # Apparently the compiler optimizes these into constants automatically
   sub OPEN_LATER             { return 0; }
   sub OPEN                   { return 1; }
   sub PAST_DUE_NO_ANSWER     { return 2; }
   sub PAST_DUE_ANSWER_LATER  { return 3; }
   sub ANSWER_OPEN            { return 4; }
   sub NOTHING_SET            { return 5; } 
   sub NETWORK_FAILURE        { return 100; }
   
   # getDateStatus gets the date status for a given problem part. 
   # Because answer date, due date, and open date are fully independent
   # (i.e., it is perfectly possible to *only* have an answer date), 
   # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
   # (past, future, none given). This function handles this with a decision
   # tree. Read the comments to follow the decision tree.
   
   sub getDateStatus {
       my $self = shift;
       my $part = shift;
       $part = "0" if (!defined($part));
   
       # Always return network failure if there was one.
       return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
   
       my $now = time();
   
       my $open = $self->opendate($part);
       my $due = $self->duedate($part);
       my $answer = $self->answerdate($part);
   
       if (!$open && !$due && !$answer) {
           # no data on the problem at all
           # should this be the same as "open later"? think multipart.
           return $self->NOTHING_SET;
       }
       if (!$open || $now < $open) {return $self->OPEN_LATER}
       if (!$due || $now < $due) {return $self->OPEN}
       if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
       if ($answer) { return $self->ANSWER_OPEN; }
       return PAST_DUE_NO_ANSWER;
   }
   
   =pod
   
   B<>
   
   =over 4
   
   =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:
   
   =back 
   
   B<Completion Codes>
   
   =over 4
   
   =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
   
   =item * B<INCORRECT>: Attempted, but wrong by student.
   
   =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
   
   =item * B<CORRECT>: Correct or correct by instructor.
   
   =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
   
   =item * B<EXCUSED>: Excused. Not yet implemented.
   
   =item * B<NETWORK_FAILURE>: Information not available due to network failure.
   
   =back
   
   =cut
   
   sub NOT_ATTEMPTED         { return 10; }
   sub INCORRECT             { return 11; }
   sub INCORRECT_BY_OVERRIDE { return 12; }
   sub CORRECT               { return 13; }
   sub CORRECT_BY_OVERRIDE   { return 14; }
   sub EXCUSED               { return 15; }
   
   sub getCompletionStatus {
       my $self = shift;
       my $part = shift;
       $part = "0" if (!defined($part));
       return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
   
       # Make sure return hash exists
       $self->getReturnHash();
       
       my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
   
       # Left as seperate if statements in case we ever do more with this
       if ($status eq 'correct_by_student') {return $self->CORRECT;}
       if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
       if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
       if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
       if ($status eq 'excused') {return $self->EXCUSED; }
       return $self->NOT_ATTEMPTED;
   }
   
   =pod
   
   B<Composite Status>
   
   Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()):
   
   =over 4
   
   =item * NETWORK_FAILURE: The network has failed and the information is not available.
   
   =item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
   
   =item * CORRECT: For any reason at all, the part is considered correct.
   
   =item * EXCUSED: For any reason at all, the problem is excused.
   
   =item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.
   
   =item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.
   
   =item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.
   
   =item * OPEN_LATER: The problem is not yet open.
   
   =item * TRIES_LEFT: The problem is open, has been tried, is not correct, but there are tries left.
   
   =item * INCORRECT: The problem is open, and all tries have been used without getting the correct answer.
   
   =item * OPEN: The item is open and not yet tried.
   
   =back
   
   =cut
   
   sub TRIES_LEFT { return 10; }
   
   sub status {
       my $self = shift;
       my $part = shift;
       if (!defined($part)) { $part = "0"; }
       my $completionStatus = $self->getCompletionStatus($part);
       my $dateStatus = $self->getDateStatus($part);
   
       # What we have is a two-dimensional matrix with 4 entries on one
       # dimension and 5 entries on the other, which we want to colorize,
       # plus network failure and "no date data at all".
   
       if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
   
       # There are a few whole rows we can dispose of:
       if ($completionStatus == CORRECT ||
           $completionStatus == CORRECT_BY_OVERRIDE ) {
           return CORRECT(); 
       }
   
       # If it's EXCUSED, then return that no matter what
       if ($completionStatus == EXCUSED) {
           return EXCUSED; 
       }
   
       if ($dateStatus == NOTHING_SET) {
           return NOTHING_SET;
       }
   
       # Now we're down to a 3 (incorrect, incorrect_override, not_attempted)
       # by 4 matrix (date status).
   
       if ($dateStatus == PAST_DUE_ANSWER_LATER ||
           $dateStatus == PAST_DUE_NO_ANSWER ) {
           return $dateStatus; 
       }
   
       if ($dateStatus == ANSWER_OPEN) {
           return ANSWER_OPEN;
       }
   
       # Now: (incorrect, incorrect_override, not_attempted) x 
       # (open_later), (open)
       
       if ($dateStatus == OPEN_LATER) {
           return OPEN_LATER;
       }
   
       # If it's WRONG...
       if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
           # and there are TRIES LEFT:
           if ($self->tries() < $self->maxtries()) {
               return TRIES_LEFT;
           }
           return INCORRECT; # otherwise, return orange; student can't fix this
       }
   
       # Otherwise, it's untried and open
       return OPEN; 
   }
   
   =pod
   
   =head2 Resource/Nav Map Navigation
   
   =over 4
   
   =item * B<getNext>(): Gets the next resource in the navmap after this one.
   
   =cut
   
   # For the simple single-link case, to get from a resource to the next
   # resource, you need to look up the "to_" link in the nav hash, then
   # follow that with the "goesto_" link.
   
   sub getNext {
       my $self = shift;
       my $alreadySeenHash = shift;
       my @branches;
       my $to = $self->to();
       foreach my $branch ( split(/\,/, $to) ) {
           my $choice = $self->{NAV_MAP}->getById($branch);
           my $next = $choice->goesto();
           $next = $self->{NAV_MAP}->getById($next);
   
           # Don't remember it if we've already seen it 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;
               }
       }
       return \@branches;
   }
   
   =pod
   
   =back
   
   =cut
   
   1;
   
   __END__
   
   
Removed from v.1.45  
changed lines
  Added in v.1.62

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>