# The LearningOnline Network with CAPA
# Navigate Maps Handler
#
# (Page Handler
#
# (TeX Content Handler
#
# 05/29/00,05/30 Gerd Kortemeyer)
# 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
# 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
#
# 3/1/1,6/1,17/1,29/1,30/1 Gerd Kortemeyer

package Apache::lonnavmaps;

use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet();
use HTML::TokeParser;
use GDBM_File;

# -------------------------------------------------------------- Module Globals
my %hash;
my @rows;

#
# These cache hashes need to be independent of user, resource and course
# (user and course can/should be in the keys)
#

my %courserdatas;
my %userrdatas;

#
# These global hashes are dependent on user, course and resource, 
# and need to be initialized every time when a sheet is calculated
#
my %courseopt;
my %useropt;
my %parmhash;


# ------------------------------------------------------------------ Euclid gcd

sub euclid {
    my ($e,$f)=@_;
    my $a; my $b; my $r;
    if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
    while ($r!=0) {
	$a=$b; $b=$r;
        $r=$a%$b;
    }
    return $b;
}

# --------------------------------------------------------------------- Parmval

# -------------------------------------------- Figure out a cascading parameter
#
# For this function to work
#
# * parmhash needs to be tied
# * courseopt and useropt need to be initialized for this user and course
#

sub parmval {
    my ($what,$symb)=@_;
    my $cid=$ENV{'request.course.id'};
    my $csec=$ENV{'request.course.sec'};
    my $uname=$ENV{'user.name'};
    my $udom=$ENV{'user.domain'};

    unless ($symb) { return ''; }
    my $result='';

    my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);

# ----------------------------------------------------- Cascading lookup scheme
       my $rwhat=$what;
       $what=~s/^parameter\_//;
       $what=~s/\_/\./;

       my $symbparm=$symb.'.'.$what;
       my $mapparm=$mapname.'___(all).'.$what;
       my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;

       my $seclevel=
            $usercourseprefix.'.['.
		$csec.'].'.$what;
       my $seclevelr=
            $usercourseprefix.'.['.
		$csec.'].'.$symbparm;
       my $seclevelm=
            $usercourseprefix.'.['.
		$csec.'].'.$mapparm;

       my $courselevel=
            $usercourseprefix.'.'.$what;
       my $courselevelr=
            $usercourseprefix.'.'.$symbparm;
       my $courselevelm=
            $usercourseprefix.'.'.$mapparm;

# ---------------------------------------------------------- fourth, check user
      
      if ($uname) { 

       if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }

       if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }

       if ($useropt{$courselevel}) { return $useropt{$courselevel}; }

      }

# --------------------------------------------------------- third, check course
     
       if ($csec) {
 
        if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }

        if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }  

        if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }
  
      }

       if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }

       if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }

       if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }

# ----------------------------------------------------- second, check map parms

       my $thisparm=$parmhash{$symbparm};
       if ($thisparm) { return $thisparm; }

# -------------------------------------------------------- first, check default

       return &Apache::lonnet::metadata($fn,$rwhat.'.default');
        
}



# ------------------------------------------------------------- Find out status

sub astatus {
    my $rid=shift;
    my $code=1;
    my $ctext='';
    $rid=~/(\d+)\.(\d+)/;
    my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
	     &Apache::lonnet::declutter($hash{'src_'.$rid});
    my $duedate=&parmval('0.duedate',$symb);
    my $opendate=&parmval('0.opendate',$symb);
    my $answerdate=&parmval('0.answerdate',$symb);
    my $now=time;
    my $tcode=0;
   if ($opendate) {
    if ($now<$duedate) {
        $tcode=2; 
        $ctext='Due: '.localtime($duedate);
        if ($now<$opendate) { 
          $tcode=1; 
          $ctext='Open: '.localtime($opendate);
        }
        if ($duedate-$now<86400) {
	   $tcode=4;
           $ctext='Due: '.localtime($duedate);
        }
     } else {
       $tcode=3;
       if ($now<$answerdate) {  
          $ctext='Answer: '.localtime($duedate);
       }
    }
   } else {
    $tcode=1;
   }
    my $answer=&Apache::lonnet::reply(
              "restore:$ENV{'user.domain'}:$ENV{'user.name'}:".
              $ENV{'request.course.id'}.':'.
              &Apache::lonnet::escape($symb),
              "$ENV{'user.home'}");
    my %returnhash=();
    map {
	my ($name,$value)=split(/\=/,$_);
        $returnhash{&Apache::lonnet::unescape($name)}=
                    &Apache::lonnet::unescape($value);
    } split(/\&/,$answer);
    if ($returnhash{'version'}) {
       my $version;
       for ($version=1;$version<=$returnhash{'version'};$version++) {
          map {
             $returnhash{$_}=$returnhash{$version.':'.$_};
          } split(/\:/,$returnhash{$version.':keys'});
       }
       map {
           if (($_=~/\.(\w+)\.solved$/) && ($_!~/^\d+\:/)) {
               my $part=$1;
               if ($ctext) { $ctext.=', '; }
               if ($part) {
		   $ctext.='Part '.$part.': ';
               }
	       if ($returnhash{$_} eq 'correct_by_student') {
                   unless ($code==2) { $code=3; }
                   $ctext.='solved';
               } elsif ($returnhash{$_} eq 'correct_by_override') {
                   unless ($code==2) { $code=3; }
                   $ctext.='override';
               } elsif ($returnhash{$_} eq 'incorrect_attempted') {
                   $code=2;
                   $ctext.=
                     $returnhash{'resource.'.$part.'.tries'}.'/'.
                     &parmval($part.'.maxtries',$symb).' tries';
               } elsif ($returnhash{$_} eq 'incorrect_by_override') {
                   $code=2;
                   $ctext.='override';
               } elsif ($returnhash{$_} eq 'excused') {
                   unless ($code==2) { $code=3; }
                   $ctext.='excused';
               }
           }
       } keys %returnhash;
    }
    return 'p'.$code.$tcode.'"'.$ctext.'"';
}

# ------------------------------------------------------------ Build page table

sub tracetable {
    my ($sofar,$rid,$beenhere)=@_;
    my $further=$sofar;
    unless ($beenhere=~/\&$rid\&/) {
       $beenhere.=$rid.'&';  

       if (defined($hash{'is_map_'.$rid})) {
           $sofar++;
           my $tprefix='';
           if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}} 
            eq 'sequence') { 
               $tprefix='h'; 
           }
           if (defined($rows[$sofar])) {
              $rows[$sofar].='&'.$tprefix.$rid;
           } else {
              $rows[$sofar]=$tprefix.$rid;
           }
           if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
               (defined($hash{'map_finish_'.$hash{'src_'.$rid}})) &&
               ($tprefix eq 'h')) {
              my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
	      $sofar=
                &tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
                '&'.$frid.'&');
              $sofar++;
              if ($hash{'src_'.$frid}) {
               my $brepriv=&Apache::lonnet::allowed('bre',$hash{'src_'.$frid});
               if (($brepriv eq '2') || ($brepriv eq 'F')) {
		 my $pprefix='';
                 if ($hash{'src_'.$frid}=~
                                 /\.(problem|exam|quiz|assess|survey|form)$/) {
		     $pprefix=&astatus($frid);

                 }
                 if (defined($rows[$sofar])) {
                   $rows[$sofar].='&'.$pprefix.$frid;
                 } else {
                   $rows[$sofar]=$pprefix.$frid;
                 }
	       }
	      }
	   }
       } else {
          $sofar++;
          if ($hash{'src_'.$rid}) {
           my $brepriv=&Apache::lonnet::allowed('bre',$hash{'src_'.$rid});
           if (($brepriv eq '2') || ($brepriv eq 'F')) {
	     my $pprefix='';
             if ($hash{'src_'.$rid}=~
                                 /\.(problem|exam|quiz|assess|survey|form)$/) {
	         $pprefix=&astatus($rid);
             }
             if (defined($rows[$sofar])) {
                $rows[$sofar].='&'.$pprefix.$rid;
             } else {
               $rows[$sofar]=$pprefix.$rid;
             }
	   }
          }
       }

       if (defined($hash{'to_'.$rid})) {
	  my $mincond=1;
          my $next='';
          map {
              my $thiscond=
      &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
              if ($thiscond>=$mincond) {
		  if ($next) {
		      $next.=','.$_.':'.$thiscond;
                  } else {
                      $next=$_.':'.$thiscond;
		  }
                  if ($thiscond>$mincond) { $mincond=$thiscond; }
	      }
          } split(/\,/,$hash{'to_'.$rid});
          map {
              my ($linkid,$condval)=split(/\:/,$_);
              if ($condval>=$mincond) {
                my $now=&tracetable($sofar,$hash{'goesto_'.$linkid},$beenhere);
                if ($now>$further) { $further=$now; }
	      }
          } split(/\,/,$next);

       }
    }
    return $further;
}

# ================================================================ Main Handler

sub handler {
  my $r=shift;


# ------------------------------------------- Set document type for header only

  if ($r->header_only) {
       if ($ENV{'browser.mathml'}) {
           $r->content_type('text/xml');
       } else {
           $r->content_type('text/html');
       }
       $r->send_http_header;
       return OK;
   }

  my $requrl=$r->uri;
# ----------------------------------------------------------------- Tie db file
  if ($ENV{'request.course.fn'}) {
      my $fn=$ENV{'request.course.fn'};
      if (-e "$fn.db") {
          if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER,0640)) &&
             (tie(%parmhash,'GDBM_File',
           $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640))) {
# ------------------------------------------------------------------- Hash tied
              my $firstres=$hash{'map_start_/res/'.$ENV{'request.course.uri'}};
              my $lastres=$hash{'map_finish_/res/'.$ENV{'request.course.uri'}};
              if (($firstres) && ($lastres)) {
# ----------------------------------------------------------------- Render page
# -------------------------------------------------------------- Set parameters


# ---------------------------- initialize coursedata and userdata for this user
    undef %courseopt;
    undef %useropt;

    my $uname=$ENV{'user.name'};
    my $udom=$ENV{'user.domain'};
    my $uhome=$ENV{'user.home'};
    my $cid=$ENV{'request.course.id'};
    my $chome=$ENV{'course.'.$cid.'.home'};
    my ($cdom,$cnum)=split(/\_/,$cid);

    my $userprefix=$uname.'_'.$udom.'_';

    unless ($uhome eq 'no_host') { 
# -------------------------------------------------------------- Get coursedata
      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;
         }
      }
      map {
         my ($name,$value)=split(/\=/,$_);
         $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
                    &Apache::lonnet::unescape($value);
      } split(/\&/,$courserdatas{$cid});
# --------------------------------------------------- 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;
         }
      }
      map {
         my ($name,$value)=split(/\=/,$_);
         $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
	          &Apache::lonnet::unescape($value);
      } split(/\&/,$userrdatas{$uname.'___'.$udom});
    }

                  @rows=();

                  &tracetable(0,$firstres,'&'.$lastres.'&');
                  if ($hash{'src_'.$lastres}) {
                     my $brepriv=
                        &Apache::lonnet::allowed('bre',$hash{'src_'.$lastres});
                     if (($brepriv eq '2') || ($brepriv eq 'F')) {
                        $rows[$#rows+1]=''.$lastres;
		     }
		  }

# ------------------------------------------------------------------ Page parms

                  my $j;
                  my $i;
                  my $lcm=1;
                  my $contents=0;

# ---------------------------------------------- Go through table to get layout

                  for ($i=0;$i<=$#rows;$i++) {
		     if ($rows[$i]) {
		      $contents++;
                      my @colcont=split(/\&/,$rows[$i]);
                      $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
                     } 
                  }


                  unless ($contents) {
                      $r->content_type('text/html');
                      $r->send_http_header;
                      $r->print('<html><body>Empty Map.</body></html>');
                  } else {

# ------------------------------------------------------------------ Build page

# ---------------------------------------------------------------- Send headers

                          $r->content_type('text/html');
                          $r->send_http_header;
                          $r->print(
                   '<html><head><title>Navigate LON-CAPA Maps</title></head>');

			  $r->print('<body bgcolor="#FFFFFF">'.
                                    '<script>window.focus();</script>'.
                           '<img align=right src=/adm/lonIcons/lonlogos.gif>'.
                                    '<h1>Navigate Course Map</h1>');
                          $r->rflush();
# ----------------------------------------------------------------- Start table
                      $r->print('<table cols="'.$lcm.'" border="0">');
                      for ($i=0;$i<=$#rows;$i++) {
			if ($rows[$i]) {
                          $r->print("\n<tr>");
                          my @colcont=split(/\&/,$rows[$i]);
                          my $avespan=$lcm/($#colcont+1);
                          for ($j=0;$j<=$#colcont;$j++) {
                              my $rid=$colcont[$j];
                              my $add='<td>&nbsp;&nbsp;';
                              my $adde='</td>';
                              my $hwk='<font color="#223322">';
                              my $hwke='</font>';
                              if ($rid=~/^h(.+)/) {
				  $rid=$1;
                                  $add='<th bgcolor="#AAFF55">';
                                  $adde='</th>';
                              }
                            if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {
                                  my $code=$1;
                                  my $tcode=$2;
                                  my $ctext=$3;
                                  $rid=$4;
                                  if ($tcode eq '1') {
                                     $add='<td bgcolor="#AAAAAA">';
                                  }
                                  if ($code eq '3') {
                                     $add='<td bgcolor="#AAFFAA">';
				  } else {
                                      $add='<td bgcolor="#FFAAAA">';
				      if ($tcode eq '2') {
                                         $add='<td bgcolor="#FFFFAA">';
                                      }
                                      if ($tcode eq '4') {
                                         $add='<td bgcolor="#FFFF33"><blink>';
                                         $adde='</blink></td>';
                                      }
                                  }
                                  $hwk='<font color="#888811"><b>';
                                  $hwke='</b></font>';
                                  if ($code eq '1') {
                                     $hwke='</b> ('.$ctext.')</font>';
                                  }
                                  if ($code eq '2') {
                                     $hwk='<font color="#992222"><b>';
                                     $hwke='</b> ('.$ctext.')</font>';
                                  }
                                  if ($code eq '3') {
                                     $hwk='<font color="#229922"><b>';
                                     $hwke='</b> ('.$ctext.')</font>';
                                  }
                              }
                              $r->print($add.'<a href="'.$hash{'src_'.$rid}.
                                '">'.$hwk.
                                $hash{'title_'.$rid}.$hwke.'</a>'.$adde);
                          }
                          $r->print('</tr>');
		        }
                      }
                      $r->print("\n</table>");

                      $r->print('</body></html>');
# -------------------------------------------------------------------- End page
                  }                  
# ------------------------------------------------------------- End render page
              } else {
                  $r->content_type('text/html');
                  $r->send_http_header;
		  $r->print('<html><body>Coursemap undefined.</body></html>');
              }
# ------------------------------------------------------------------ Untie hash
              unless (untie(%hash)) {
                   &Apache::lonnet::logthis("<font color=blue>WARNING: ".
                       "Could not untie coursemap $fn (browse).</font>"); 
              }
              unless (untie(%parmhash)) {
                   &Apache::lonnet::logthis("<font color=blue>WARNING: ".
                       "Could not untie parmhash (browse).</font>"); 
              }
# -------------------------------------------------------------------- All done
	      return OK;
# ----------------------------------------------- Errors, hash could no be tied
          }
      } 
  }

  $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
  return HTTP_NOT_ACCEPTABLE; 
}

1;
__END__