--- loncom/interface/Attic/lonspreadsheet.pm 2000/12/04 22:09:39 1.4 +++ loncom/interface/Attic/lonspreadsheet.pm 2000/12/11 16:51:12 1.12 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Spreadsheet/Grades Display Handler # -# 11/11,11/15,11/27,12/04 Gerd Kortemeyer +# 11/11,11/15,11/27,12/04,12/05,12/06,12/07,12/08,12/09,12/11 Gerd Kortemeyer package Apache::lonspreadsheet; @@ -10,10 +10,28 @@ use Safe; use Safe::Hole; use Opcode; use Apache::lonnet; -use Apache::Constants qw(:common); +use Apache::Constants qw(:common :http); use HTML::TokeParser; +use GDBM_File; +# +# These cache hashes need to be independent of user, resource and course +# (user and course are in the keys) +# +use vars qw(%spreadsheets %courserdatas %userrdatas); +# +# These global hashes are dependent on user, course and resource, +# and need to be initialized every time when a sheet is calculated +# +my %courseopt; +my %useropt; +my %parmhash; +my $csec; +my $uname; +my $udom; +# ============================================================================= +# ===================================== Implements an instance of a spreadsheet sub initsheet { my $safeeval = new Safe; @@ -30,29 +48,41 @@ sub initsheet { # f: formulas # t: intermediate format (variable references expanded) # v: output values -# +# c: preloaded constants (A-column) +# rl: row label %v=(); %t=(); %f=(); +%c=(); +%rl=(); + +$maxrow=0; +$sheettype=''; +$filename=''; sub mask { my ($lower,$upper)=@_; - $lower=~/([A-Z]|\*)(\d+|\*)/; + $lower=~/([A-Za-z]|\*)(\d+|\*)/; my $la=$1; my $ld=$2; - $upper=~/([A-Z]|\*)(\d+|\*)/; + $upper=~/([A-Za-z]|\*)(\d+|\*)/; my $ua=$1; my $ud=$2; my $alpha=''; my $num=''; if (($la eq '*') || ($ua eq '*')) { - $alpha='[A-Z]'; + $alpha='[A-Za-z]'; } else { - $alpha='['.$la.'-'.$ua.']'; + if (($la=~/[A-Z]/) && ($ua=~/[A-Z]/) || + ($la=~/[a-z]/) && ($ua=~/[a-z]/)) { + $alpha='['.$la.'-'.$ua.']'; + } else { + $alpha='['.$la.'-Za-'.$ua.']'; + } } if (($ld eq '*') || ($ud eq '*')) { @@ -74,11 +104,13 @@ sub mask { } else { my @lda=($ld=~m/\d/g); my @uda=($ud=~m/\d/g); - my $i; $j=0; - for ($i=0;$i<=$#lda;$i++) { + my $i; $j=0; $notdone=1; + for ($i=0;($i<=$#lda)&&($notdone);$i++) { if ($lda[$i]==$uda[$i]) { $num.=$lda[$i]; $j=$i; + } else { + $notdone=0; } } if ($j<$#lda-1) { @@ -96,7 +128,9 @@ sub mask { } $num.=')'; } else { - $num.='['.$lda[$#lda].'-'.$uda[$#uda].']'; + if ($lda[$#lda]!=$uda[$#uda]) { + $num.='['.$lda[$#lda].'-'.$uda[$#uda].']'; + } } } } @@ -227,9 +261,15 @@ sub sett { %t=(); map { if ($f{$_}) { - $t{$_}=$f{$_}; - $t{$_}=~s/\.+/\,/g; - $t{$_}=~s/(^|[^\"\'])([A-Z]\d+)/$1\$v\{\'$2\'\}/g; + if ($_=~/^A/) { + unless ($f{$_}=~/^\!/) { + $t{$_}=$c{$_}; + } + } else { + $t{$_}=$f{$_}; + $t{$_}=~s/\.\.+/\,/g; + $t{$_}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$v\{\'$2\'\}/g; + } } } keys %f; } @@ -259,6 +299,25 @@ sub calc { return ''; } +sub outrow { + my $n=shift; + my @cols=(); + if ($n) { + $cols[0]=$rl{$f{'A'.$n}}; + } else { + $cols[0]='Export'; + } + map { + my $fm=$f{$_.$n}; + $fm=~s/[\'\"]/\&\#34;/g; + $cols[$#cols+1]="'$_$n','$fm'".'___eq___'.$v{$_.$n}; + } ('A','B','C','D','E','F','G','H','I','J','K','L','M', + 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z', + 'a','b','c','d','e','f','g','h','i','j','k','l','m', + 'n','o','p','q','r','s','t','u','v','w','x','y','z'); + return @cols; +} + # ------------------------------------------- End of "Inside of the safe space" ENDDEFS $safeeval->reval($code); @@ -269,7 +328,21 @@ ENDDEFS sub setformulas { my ($safeeval,@f)=@_; - $safeeval->reval('%f=(%f,'."('".join("','",@f)."'));"); + $safeeval->reval('%f='."('".join("','",@f)."');"); +} + +# ------------------------------------------------ Add or change formula values + +sub setconstants { + my ($safeeval,@c)=@_; + $safeeval->reval('%c='."('".join("','",@c)."');"); +} + +# ------------------------------------------------ Add or change formula values + +sub setrowlabels { + my ($safeeval,@rl)=@_; + $safeeval->reval('%rl='."('".join("','",@rl)."');"); } # ------------------------------------------------------- Calculate spreadsheet @@ -293,18 +366,121 @@ sub getformulas { return $safeeval->reval('%f'); } -# ------------------------------------------------------------ Read spreadsheet +# -------------------------------------------------------------------- Set type -sub readf { - my $fn=shift; +sub settype { + my ($safeeval,$type)=@_; + $safeeval->reval('$sheettype="'.$type.'";'); +} + +# -------------------------------------------------------------------- Get type + +sub gettype { + my $safeeval=shift; + return $safeeval->reval('$sheettype'); +} +# ------------------------------------------------------------------ Set maxrow + +sub setmaxrow { + my ($safeeval,$row)=@_; + $safeeval->reval('$maxrow='.$row.';'); +} + +# ------------------------------------------------------------------ Get maxrow + +sub getmaxrow { + my $safeeval=shift; + return $safeeval->reval('$maxrow'); +} + +# ---------------------------------------------------------------- Set filename + +sub setfilename { + my ($safeeval,$fn)=@_; + $safeeval->reval('$filename="'.$fn.'";'); +} + +# ---------------------------------------------------------------- Get filename + +sub getfilename { + my $safeeval=shift; + return $safeeval->reval('$filename'); +} + +# ========================================================== End of Spreadsheet +# ============================================================================= + + +# --------------------------------------------- Produce output row n from sheet + +sub rown { + my ($safeeval,$n)=@_; + my $defaultbg=((($n-1)/5)==int(($n-1)/5))?'#E0E0':'#FFFF'; + my $rowdata="\n$n"; + my $showf=0; + map { + my $bgcolor=$defaultbg.((($showf-1)/5==int(($showf-1)/5))?'99':'DD'); + my ($fm,$vl)=split(/\_\_\_eq\_\_\_/,$_); + if ($showf==0) { $vl=$_; } + if ($showf<=1) { $bgcolor='#FFDDDD'; } + if (($n==0) && ($showf<=26)) { $bgcolor='#CCCCFF'; } + if ($showf>1) { + if ($vl eq '') { + $vl='#'; + } + $rowdata.= + ''.$vl. + ''; + } else { + $rowdata.=' '.$vl.' '; + } + $showf++; + } $safeeval->reval('&outrow('.$n.')'); + return $rowdata.''; +} + +# ------------------------------------------------------------- Print out sheet + +sub outsheet { + my $safeeval=shift; + my $tabledata=''. + ''; + map { + $tabledata.=""; + } ('B','C','D','E','F','G','H','I','J','K','L','M', + 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z', + 'a','b','c','d','e','f','g','h','i','j','k','l','m', + 'n','o','p','q','r','s','t','u','v','w','x','y','z'); + $tabledata.=''; + my $row; + my $maxrow=&getmaxrow($safeeval); + for ($row=0;$row<=$maxrow;$row++) { + $tabledata.=&rown($safeeval,$row); + } + $tabledata.='
 A Import$_
'; +} + + + +# --------------------------------------- Read spreadsheet formulas from a file + +sub readsheet { + my ($safeeval,$fn)=@_; + &setfilename($safeeval,$fn); + $fn=~/\.(\w+)/; + &settype($safeeval,$1); my %f=(); - my $content; - { - my $fh=Apache::File->new($fn); - $content=join('',<$fh>); + unless ($spreadsheets{$fn}) { + $spreadsheets{$fn}=''; + { + my $fh; + if ($fh=Apache::File->new($fn)) { + $spreadsheets{$fn}=join('',<$fh>); + } + } } { - my $parser=HTML::TokeParser->new(\$content); + my $parser=HTML::TokeParser->new(\$spreadsheets{$fn}); my $token; while ($token=$parser->get_token) { if ($token->[0] eq 'S') { @@ -315,6 +491,42 @@ sub readf { } } } + &setformulas($safeeval,%f); +} + +# ----------------------------------------------- Make a temp copy of the sheet + +sub tmpwrite { + my ($safeeval,$tmpdir,$symb)=@_; + my $fn=$uname.'_'.$udom.'_spreadsheet_'.&getfilename($safeeval); + $fn=~s/\W/\_/g; + $fn=$tmpdir.$fn.'.tmp'; + my $fh; + if ($fh=Apache::File->new('>'.$fn)) { + print $fh join("\n",&getformulas($safeeval)); + } +} + +# ---------------------------------------------------------- Read the temp copy + +sub tmpread { + my ($safeeval,$tmpdir,$symb,$nfield,$nform)=@_; + my $fn=$uname.'_'.$udom.'_spreadsheet_'.&getfilename($safeeval); + $fn=~s/\W/\_/g; + $fn=$tmpdir.$fn.'.tmp'; + my $fh; + my %fo=(); + if ($fh=Apache::File->new($fn)) { + my $name; + while ($name=<$fh>) { + chomp($name); + my $value=<$fh>; + chomp($value); + $fo{$name}=$value; + } + } + $fo{$nfield}=$nform; + &setformulas($safeeval,%fo); } # --------------------------------------------------------------- Read metadata @@ -344,32 +556,405 @@ sub readmeta { return %returnhash; } +# ================================================================== Parameters +# -------------------------------------------- Figure out a cascading parameter -# ----------------------------------------------------------------------------- +sub parmval { + my ($what,$symb)=@_; -sub handler { + unless ($symb) { return ''; } + my $result=''; - my $r=shift; + 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 $seclevel= + $ENV{'request.course.id'}.'.['. + $csec.'].'.$what; + my $seclevelr= + $ENV{'request.course.id'}.'.['. + $csec.'].'.$symbparm; + my $seclevelm= + $ENV{'request.course.id'}.'.['. + $csec.'].'.$mapparm; + + my $courselevel= + $ENV{'request.course.id'}.'.'.$what; + my $courselevelr= + $ENV{'request.course.id'}.'.'.$symbparm; + my $courselevelm= + $ENV{'request.course.id'}.'.'.$mapparm; + +# ---------------------------------------------------------- fourth, check user + + if ($uname) { + + if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; } - $r->content_type('text/html'); - $r->send_http_header; + if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; } - $r->print('LON-CAPA Spreadsheet'); - $r->print(''); + if ($useropt{$courselevel}) { return $useropt{$courselevel}; } + + } + +# --------------------------------------------------------- third, check course + + if ($csec) { - my $sheetone=initsheet(); + if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; } - &setformulas($sheetone,('A1' => '5', 'B2' => '6', 'C4' => 'A1+B2')); - $r->print(&calcsheet($sheetone)); - my %output=&getformulas($sheetone); - - $r->print('FORM:'.$output{'A1'}.' '.$output{'B2'}.' '.$output{'C4'}); + if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; } - my %output=&getvalues($sheetone); + 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'); + +} + + +# ----------------------------------------------------------------- Update rows + +sub updaterows { + my $safeeval=shift; + my %bighash; +# -------------------------------------------------------------------- Tie hash + if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', + &GDBM_READER,0640)) { +# --------------------------------------------------------- Get all assessments + + my %allkeys=(); + my %allassess=(); + + my $stype=&gettype($safeeval); + + map { + if ($_=~/^src\_(\d+)\.(\d+)$/) { + my $mapid=$1; + my $resid=$2; + my $id=$mapid.'.'.$resid; + my $srcf=$bighash{$_}; + if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) { + my $symb= + &Apache::lonnet::declutter($bighash{'map_id_'.$mapid}). + '___'.$resid.'___'. + &Apache::lonnet::declutter($srcf); + $allassess{$symb}=$bighash{'title_'.$id}; + + if ($stype eq 'assesscalc') { + map { + if (($_=~/^stores\_(.*)/) || ($_=~/^parameter\_(.*)/)) { + my $key=$_; + my $display= + &Apache::lonnet::metadata($srcf,$key.'.display'); + unless ($display) { + $display= + &Apache::lonnet::metadata($srcf,$key.'.name'); + } + $allkeys{$key}=$display; + } + } split(/\,/,&Apache::lonnet::metadata($srcf,'keys')); + } + } + } + } keys %bighash; + untie(%bighash); - $r->print('
OUT:'.$output{'A1'}.' '.$output{'B2'}.' '.$output{'C4'}); +# +# %allkeys has a list of storage and parameter displays by unikey +# %allassess has a list of all resource displays by symb +# +# -------------------- Find discrepancies between the course row table and this +# + my %f=&getformulas($safeeval); + my $changed=0; - $r->print(''); + my %current=(); + if ($stype eq 'assesscalc') { + %current=%allkeys; + } elsif ($stype eq 'studentcalc') { + %current=%allassess; + } + + my $maxrow=0; + my %existing=(); + +# ----------------------------------------------------------- Now obsolete rows + map { + if ($_=~/^A(\d+)/) { + $maxrow=($1>$maxrow)?$1:$maxrow; + $existing{$f{$_}}=1; + unless (defined($current{$f{$_}})) { + $f{$_}='!!! Obsolete'; + $changed=1; + } + } + } keys %f; + +# -------------------------------------------------------- New and unknown keys + + map { + unless ($existing{$_}) { + $changed=1; + $maxrow++; + $f{'A'.$maxrow}=$_; + } + } keys %current; + + if ($changed) { &setformulas($safeeval,%f); } + + &setmaxrow($safeeval,$maxrow); + &setrowlabels($safeeval,%current); + + } else { + return 'Could not access course data'; + } +} + +# ------------------------------------------------ Load data for one assessment + +sub rowaassess { + my ($safeeval,$symb)=@_; + my $uhome=&Apache::lonnet::homeserver($uname,$udom); + my $namespace; + unless ($namespace=$ENV{'request.course.id'}) { return ''; } + +# ----------------------------------------------------------- Get stored values + my $answer=&Apache::lonnet::reply( + "restore:$udom:$uname:$namespace:$symb",$uhome); + my %returnhash=(); + map { + my ($name,$value)=split(/\=/,$_); + $returnhash{&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } split(/\&/,$answer); + my $version; + for ($version=1;$version<=$returnhash{'version'};$version++) { + map { + $returnhash{$_}=$returnhash{$version.':'.$_}; + } split(/\:/,$returnhash{$version.':keys'}); + } +# ----------------------------- returnhash now has all stores for this resource + +# ---------------------------- initialize coursedata and userdata for this user + %courseopt=(); + %useropt=(); + my $uhome=&Apache::lonnet::homeserver($uname,$udom); + unless ($uhome eq 'no_host') { +# -------------------------------------------------------------- Get coursedata + unless ($courserdatas{$ENV{'request.course.id'}}) { + my $reply=&Apache::lonnet::reply('dump:'. + $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'. + $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.':resourcedata', + $ENV{'course.'.$ENV{'request.course.id'}.'.home'}); + if ($reply!~/^error\:/) { + $courserdatas{$ENV{'request.course.id'}}=$reply; + } + } + map { + my ($name,$value)=split(/\=/,$_); + $courseopt{&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } split(/\&/,$courserdatas{$ENV{'request.course.id'}}); +# --------------------------------------------------- Get userdata (if present) + unless ($userrdatas{$uname.'___'.$udom}) { + my $reply= + &Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); + if ($reply!~/^error\:/) { + $userrdatas{$uname.'___'.$udom}=$reply; + } + } + map { + my ($name,$value)=split(/\=/,$_); + $useropt{&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } split(/\&/,$userrdatas{$uname.'___'.$udom}); + } +# -- now courseopt, useropt initialized for this user and course (used parmval) + + my %c=(); + my %f=&getformulas($safeeval); + map { + if ($_=~/^A/) { + unless ($f{$_}=~/^\!/) { + if ($f{$_}=~/^parameter/) { + $c{$_}=&parmval($f{$_},$symb); + } else { + $c{$_}=$returnhash{$f{$_}}; + } + } + } + } keys %f; + + &setconstants($safeeval,%c); +} + +# --------------------------------------------------------- Various form fields + +sub textfield { + my ($title,$name,$value)=@_; + return "\n

$title:
". + ''; +} + +sub hiddenfield { + my ($name,$value)=@_; + return "\n".''; +} + +sub selectbox { + my ($title,$name,$value,%options)=@_; + my $selout="\n

$title:
".''; +} + +# ==================================== Sub handler to get export of assessments + +# ================================================================ Main handler + +sub handler { + my $r=shift; + + $uname=''; + $udom=''; + $csec=''; + + if ($r->header_only) { + $r->content_type('text/html'); + $r->send_http_header; + return OK; + } + +# ----------------------------------------------------- Needs to be in a course + + if (($ENV{'request.course.fn'}) || + ($ENV{'request.state'} eq 'construct')) { + +# --------------------------- Get query string for limited number of parameters + map { + my ($name, $value) = split(/=/,$_); + $value =~ tr/+/ /; + $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; + if (($name eq 'uname') || ($name eq 'udom') || ($name eq 'usymb')) { + unless ($ENV{'form.'.$name}) { + $ENV{'form.'.$name}=$value; + } + } + } (split(/&/,$ENV{'QUERY_STRING'})); + +# ------------------------------------------- Nothing there? Must be login user + + unless ($ENV{'form.uname'}) { + $uname=$ENV{'user.name'}; + $udom=$ENV{'user.domain'}; + } else { + $uname=$ENV{'form.uname'}; + $udom=$ENV{'form.udom'}; + } +# ------------------------------------------------------------------- Open page + + $r->content_type('text/html'); + $r->header_out('Cache-control','no-cache'); + $r->header_out('Pragma','no-cache'); + $r->send_http_header; + + $r->print('LON-CAPA Spreadsheet'); + $r->print(< + + function celledit(cn,cf) { + var cnf=prompt(cn,cf); + if (cnf!=null) { + document.sheet.unewfield.value=cn; + document.sheet.unewformula.value=cnf; + document.sheet.submit(); + } + } + + +ENDSCRIPT + $r->print(''. + '

'. + &hiddenfield('uname',$ENV{'form.uname'}). + &hiddenfield('udom',$ENV{'form.udom'}). + &hiddenfield('usymb',$ENV{'form.usymb'}). + &hiddenfield('unewfield',''). + &hiddenfield('unewformula','')); + my $sheetone=initsheet(); + if ($ENV{'form.unewfield'}) { + $r->print('

Modified Workcopy

'); + $ENV{'form.unewformula'}=~s/\'/\"/g; + $r->print('New formula: '.$ENV{'form.unewfield'}.'='. + $ENV{'form.unewformula'}.'
'); + &tmpread($sheetone,$r->dir_config('lonDaemons').'/tmp/', + $ENV{'form.usymb'}, + $ENV{'form.unewfield'},$ENV{'form.unewformula'}); + &setfilename($sheetone,$r->filename); + $r->filename=~/\.(\w+)/; + &settype($sheetone,$1); + } else { + &readsheet($sheetone,$r->filename); + } + if (tie(%parmhash,'GDBM_File', + $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640)) { + $csec=&Apache::lonnet::usection($udom,$uname,$ENV{'request.course.id'}); + if ($csec eq '-1') { + $r->print('

'. + "User '$uname' at domain '$udom' not a student in this course

"); + } + &updaterows($sheetone); + untie(%parmhash); + } else { + $r->print('

'. + 'Could not initialize import fields (not in a course)

'); + } + &tmpwrite($sheetone,$r->dir_config('lonDaemons').'/tmp/', + $ENV{'form.usymb'}); + $r->print("User '$uname' at domain '$udom' for '". + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}."'"); + if ($csec) { + $r->print(", group/section '$csec'"); + } + $r->print("\n"); + if (&gettype($sheetone) eq 'assesscalc') { + &rowaassess($sheetone,$ENV{'form.usymb'}); + } + &calcsheet($sheetone); + $r->print(&outsheet($sheetone)); + + $r->print('
'); + + } else { +# ----------------------------- Not in a course, or not allowed to modify parms + $ENV{'user.error.msg'}= + $r->uri.":opa:0:0:Cannot modify spreadsheet"; + return HTTP_NOT_ACCEPTABLE; + } return OK; }