--- loncom/interface/Attic/lonspreadsheet.pm 2001/01/01 20:25:57 1.25 +++ loncom/interface/Attic/lonspreadsheet.pm 2001/01/02 16:03:14 1.28 @@ -3,7 +3,7 @@ # # 11/11,11/15,11/27,12/04,12/05,12/06,12/07, # 12/08,12/09,12/11,12/12,12/15,12/16,12/18,12/19,12/30, -# 01/01/01 Gerd Kortemeyer +# 01/01/01,02/01 Gerd Kortemeyer package Apache::lonspreadsheet; @@ -18,9 +18,10 @@ use HTML::TokeParser; # # These cache hashes need to be independent of user, resource and course -# (user and course are in the keys) +# (user and course can/should be in the keys) # -use vars qw(%spreadsheets %courserdatas %userrdatas); +use vars qw(%spreadsheets %courserdatas %userrdatas %defaultsheets); + # # These global hashes are dependent on user, course and resource, # and need to be initialized every time when a sheet is calculated @@ -28,9 +29,11 @@ use vars qw(%spreadsheets %courserdatas my %courseopt; my %useropt; my %parmhash; -my $csec; -my $uname; -my $udom; + +# Stuff that only the screen handler can know + +my $includedir; +my $tmpdir; # ============================================================================= # ===================================== Implements an instance of a spreadsheet @@ -61,8 +64,28 @@ sub initsheet { $maxrow=0; $sheettype=''; + +# filename/reference of the sheet + $filename=''; +# user data +$uname=''; +$uhome=''; +$udom=''; + +# course data + +$csec=''; +$chome=''; +$cnum=''; +$cdom=''; +$cid=''; + +# symb + +$usymb=''; + sub mask { my ($lower,$upper)=@_; @@ -382,13 +405,12 @@ sub outrow { } sub exportrowa { - my $rowa=''; + my @exportarray=(); map { - $rowa.=$v{$_.'0'}."___;___"; + $exportarray[$#exportarray+1]=$v{$_.'0'}; } ('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'); - $rowa=~s/\_\_\_\;\_\_\_$//; - return $rowa; + return @exportarray; } # ------------------------------------------- End of "Inside of the safe space" @@ -439,19 +461,13 @@ sub getformulas { return $safeeval->reval('%f'); } -# -------------------------------------------------------------------- Set type - -sub settype { - my ($safeeval,$type)=@_; - $safeeval->reval('$sheettype="'.$type.'";'); -} - # -------------------------------------------------------------------- Get type sub gettype { my $safeeval=shift; return $safeeval->reval('$sheettype'); } + # ------------------------------------------------------------------ Set maxrow sub setmaxrow { @@ -479,10 +495,72 @@ sub getfilename { my $safeeval=shift; return $safeeval->reval('$filename'); } +# --------------------------------------------------------------- Get course ID + +sub getcid { + my $safeeval=shift; + return $safeeval->reval('$cid'); +} + +# ----------------------------------------------------------- Get course number + +sub getcnum { + my $safeeval=shift; + return $safeeval->reval('$cnum'); +} + +# ------------------------------------------------------------- Get course home + +sub getchome { + my $safeeval=shift; + return $safeeval->reval('$chome'); +} + +# ----------------------------------------------------------- Get course domain + +sub getcdom { + my $safeeval=shift; + return $safeeval->reval('$cdom'); +} + +# ---------------------------------------------------------- Get course section + +sub getcsec { + my $safeeval=shift; + return $safeeval->reval('$csec'); +} + +# --------------------------------------------------------------- Get user name + +sub getuname { + my $safeeval=shift; + return $safeeval->reval('$uname'); +} + +# ------------------------------------------------------------- Get user domain + +sub getudom { + my $safeeval=shift; + return $safeeval->reval('$udom'); +} + +# --------------------------------------------------------------- Get user home + +sub getuhome { + my $safeeval=shift; + return $safeeval->reval('$uhome'); +} + +# -------------------------------------------------------------------- Get symb + +sub getusymb { + my $safeeval=shift; + return $safeeval->reval('$usymb'); +} # ------------------------------------------------------------- Export of A-row -sub exportrow { +sub exportdata { my $safeeval=shift; return $safeeval->reval('&exportrowa()'); } @@ -490,7 +568,9 @@ sub exportrow { # ========================================================== End of Spreadsheet # ============================================================================= - +# +# Procedures for screen output +# # --------------------------------------------- Produce output row n from sheet sub rown { @@ -600,25 +680,57 @@ sub outsheet { $r->print(''); } +# +# -------------------------------------- Read spreadsheet formulas for a course +# + +sub readsheet { + my ($safeeval,$fn)=@_; + my $stype=&gettype($safeeval); + my $cnum=&getcnum($safeeval); + my $cdom=&getcdom($safeeval); + my $chome=&getchome($safeeval); + +# --------- There is no filename. Look for defaults in course and global, cache + + unless($fn) { + unless ($fn=$defaultsheets{$cnum.'_'.$cdom.'_'.$stype}) { + $fn=&Apache::lonnet::reply('get:'.$cdom.':'.$cnum. + ':environment:spreadsheet_default_'.$stype, + $chome); + unless (($fn) && ($fn!~/^error\:/)) { + $fn='default_'.$stype; + } + $defaultsheets{$cnum.'_'.$cdom.'_'.$stype}=$fn; + } + } +# ---------------------------------------------------------- fn now has a value -# ------------------------------------- Read spreadsheet formulas from a course + &setfilename($safeeval,$fn); -sub readsheet { - my ($safeeval,$fn,$r)=@_; - my %f=(); - if (($fn eq '') || ($fn=~/^default\_/)) { +# ------------------------------------------------------ see if sheet is cached + my $fstring=''; + if ($fstring=$spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}) { + &setformulas($safeeval,split(/\_\_\_\;\_\_\_/,$fstring)); + } else { + +# ---------------------------------------------------- Not cached, need to read + + my %f=(); + + if ($fn=~/^default\_/) { my $sheetxml=''; { my $fh; - if ($fh=Apache::File->new($r->dir_config('lonIncludes'). + if ($fh=Apache::File->new($includedir. '/default.'.&gettype($safeeval))) { $sheetxml=join('',<$fh>); } } - my $parser=HTML::TokeParser->new(\$sheetxml); - my $token; - while ($token=$parser->get_token) { + my $parser=HTML::TokeParser->new(\$sheetxml); + my $token; + while ($token=$parser->get_token) { if ($token->[0] eq 'S') { if ($token->[1] eq 'field') { $f{$token->[2]->{'col'}.$token->[2]->{'row'}}= @@ -629,56 +741,84 @@ sub readsheet { $parser->get_text('/template'); } } - } - &setfilename($safeeval,'default_'.&gettype($safeeval)); - } else { - &setfilename($safeeval,$fn); - unless ($spreadsheets{$fn}) { - $spreadsheets{$fn}=''; - my $reply=&Apache::lonnet::reply('dump:'. - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'. - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.':'.$fn, - $ENV{'course.'.$ENV{'request.course.id'}.'.home'}); + } + } else { + my $sheet=''; + my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.':'.$fn, + $chome); unless ($reply=~/^error\:/) { - $spreadsheets{$fn}=$reply; - } + $sheet=$reply; + } + map { + my ($name,$value)=split(/\=/,$_); + $f{&Apache::lonnet::unescape($name)}= + &Apache::lonnet::unescape($value); + } split(/\&/,$sheet); } - map { - my ($name,$value)=split(/\=/,$_); - $f{&Apache::lonnet::unescape($name)}= - &Apache::lonnet::unescape($value); - } split(/\&/,$spreadsheets{$fn}); +# --------------------------------------------------------------- Cache and set + $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f); + &setformulas($safeeval,%f); } +} - &setformulas($safeeval,%f); +# -------------------------------------------------------- Make new spreadsheet + +sub makenewsheet { + my ($uname,$udom,$stype,$usymb)=@_; + my $safeeval=initsheet(); + $safeeval->reval( + '$uname='.$uname. + ';$udom='.$udom. + ';$sheettype='.$stype. + ';$usymb='.$usymb. + ';$cid='.$ENV{'request.course.id'}. + ';$cnum='.$ENV{'course.'.$ENV{'request.course.id'}.'.num'}. + ';$cdom='.$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}. + ';$chome='.$ENV{'course.'.$ENV{'request.course.id'}.'.home'}.';'); + return $safeeval; } # ------------------------------------------------------------ Save spreadsheet sub writesheet { - my $safeeval=shift; - if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) { + my ($safeeval,$makedef)=@_; + my $cid=&getcid($safeeval); + if (&Apache::lonnet::allowed('opa',$cid)) { my %f=&getformulas($safeeval); + my $stype=&gettype($safeeval); + my $cnum=&getcnum($safeeval); + my $cdom=&getcdom($safeeval); + my $chome=&getchome($safeeval); + my $fn=&getfilename($safeeval); + +# ------------------------------------------------------------- Cache new sheet + $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f); +# ----------------------------------------------------------------- Write sheet my $sheetdata=''; map { $sheetdata.=&Apache::lonnet::escape($_).'='. &Apache::lonnet::escape($f{$_}).'&'; } keys %f; $sheetdata=~s/\&$//; - my $reply=&Apache::lonnet::reply('put:'. - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'. - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.':'. - &getfilename($safeeval).':'. - $sheetdata, - $ENV{'course.'.$ENV{'request.course.id'}.'.home'}); + my $reply=&Apache::lonnet::reply('put:'.$cdom.':'.$cnum.':'.$fn.':'. + $sheetdata,$chome); if ($reply eq 'ok') { - return &Apache::lonnet::reply('put:'. - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'. - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.':'. - &gettype($safeeval).'_spreadsheets:'. - &Apache::lonnet::escape(&getfilename($safeeval)).'='. - $ENV{'user.name'}, - $ENV{'course.'.$ENV{'request.course.id'}.'.home'}); + $reply=&Apache::lonnet::reply('put:'.$cdom.':'.$cnum.':'. + &stype.'_spreadsheets:'. + &Apache::lonnet::escape($fn).'='.$ENV{'user.name'}, + $chome); + if ($reply eq 'ok') { + if ($makedef) { + return &Apache::lonnet::reply('put:'.$cdom.':'.$cnum. + ':environment:spreadsheet_default_'.$stype.'='. + &Apache::lonnet::escape($fn), + $chome); + } else { + return $reply; + } + } else { + return $reply; + } } else { return $reply; } @@ -687,10 +827,14 @@ sub writesheet { } # ----------------------------------------------- Make a temp copy of the sheet +# "Modified workcopy" - interactive only +# sub tmpwrite { - my ($safeeval,$tmpdir,$symb)=@_; - my $fn=$uname.'_'.$udom.'_spreadsheet_'.$symb.'_'.&getfilename($safeeval); + my $safeeval=shift; + my $fn=$ENV{'user.name'}.'_'. + $ENV{'user.domain'}.'_spreadsheet_'.&getusymb($safeeval).'_'. + &getfilename($safeeval); $fn=~s/\W/\_/g; $fn=$tmpdir.$fn.'.tmp'; my $fh; @@ -702,8 +846,10 @@ sub tmpwrite { # ---------------------------------------------------------- Read the temp copy sub tmpread { - my ($safeeval,$tmpdir,$symb,$nfield,$nform)=@_; - my $fn=$uname.'_'.$udom.'_spreadsheet_'.$symb.'_'.&getfilename($safeeval); + my ($safeeval,$nfield,$nform)=@_; + my $fn=$ENV{'user.name'}.'_'. + $ENV{'user.domain'}.'_spreadsheet_'.&getusymb($safeeval).'_'. + &getfilename($safeeval); $fn=~s/\W/\_/g; $fn=$tmpdir.$fn.'.tmp'; my $fh; @@ -721,38 +867,17 @@ sub tmpread { &setformulas($safeeval,%fo); } -# --------------------------------------------------------------- Read metadata - -sub readmeta { - my $fn=shift; - unless ($fn=~/\.meta$/) { $fn.='meta'; } - my $content; - my %returnhash=(); - { - my $fh=Apache::File->new($fn); - $content=join('',<$fh>); - } - my $parser=HTML::TokeParser->new(\$content); - my $token; - while ($token=$parser->get_token) { - if ($token->[0] eq 'S') { - my $entry=$token->[1]; - if (($entry eq 'stores') || ($entry eq 'parameter')) { - my $unikey=$entry; - $unikey.='_'.$token->[2]->{'part'}; - $unikey.='_'.$token->[2]->{'name'}; - $returnhash{$unikey}=$token->[2]->{'display'}; - } - } - } - return %returnhash; -} - # ================================================================== Parameters # -------------------------------------------- Figure out a cascading parameter +# sub parmval { - my ($what,$symb)=@_; + my ($what,$safeeval)=@_; + my $cid=&getcid($safeeval); + my $csec=&getcsec($safeeval); + my $uname=&getuname($safeeval); + my $udom=&getudom($safeeval); + my $symb=&getusymb($safeeval); unless ($symb) { return ''; } my $result=''; @@ -765,23 +890,24 @@ sub parmval { my $symbparm=$symb.'.'.$what; my $mapparm=$mapname.'___(all).'.$what; + my $usercourseprefix=$cid.'_'.$uname.'_'.$udom; my $seclevel= - $ENV{'request.course.id'}.'.['. + $usercourseprefix.'.['. $csec.'].'.$what; my $seclevelr= - $ENV{'request.course.id'}.'.['. + $usercourseprefix.'.['. $csec.'].'.$symbparm; my $seclevelm= - $ENV{'request.course.id'}.'.['. + $usercourseprefix.'.['. $csec.'].'.$mapparm; my $courselevel= - $ENV{'request.course.id'}.'.'.$what; + $usercourseprefix.'.'.$what; my $courselevelr= - $ENV{'request.course.id'}.'.'.$symbparm; + $usercourseprefix.'.'.$symbparm; my $courselevelm= - $ENV{'request.course.id'}.'.'.$mapparm; + $usercourseprefix.'.'.$mapparm; # ---------------------------------------------------------- fourth, check user @@ -826,13 +952,17 @@ sub parmval { # ---------------------------------------------- Update rows for course listing -sub updatestudentrows { +sub updateclasssheet { my $safeeval=shift; - my $cid=$ENV{'request.course.id'}; + my $cnum=&getcnum($safeeval); + my $cdom=&getcdom($safeeval); + my $cid=&getcid($safeeval); + my $chome=&getchome($safeeval); + +# ---------------------------------------------- Read class list and row labels + my $classlst=&Apache::lonnet::reply - ('dump:'.$ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist', - $ENV{'course.'.$cid.'.home'}); + ('dump:'.$cdom.':'.$cnum.':classlist',$chome); my %currentlist=(); my $now=time; unless ($classlst=~/^error\:/) { @@ -844,23 +974,21 @@ sub updatestudentrows { if ($active) { my $rowlabel=''; $name=&Apache::lonnet::unescape($name); - my ($cname,$cdom)=split(/\:/,$name); - my $csec= - &Apache::lonnet::usection($cdom,$cname,$ENV{'request.course.id'}); - if ($csec==-1) { + my ($sname,$sdom)=split(/\:/,$name); + my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid); + if ($ssec==-1) { $rowlabel='Data not available: '.$name. ''; } else { - my %reply=&Apache::lonnet::idrget($cdom,$cname); - my $reply=&Apache::lonnet::reply('get:'.$cdom.':'.$cname. + my %reply=&Apache::lonnet::idrget($sdom,$sname); + my $reply=&Apache::lonnet::reply('get:'.$sdom.':'.$sname. ':environment:firstname&middlename&lastname&generation', - &Apache::lonnet::homeserver($cname,$cdom)); - $rowlabel=$csec.' '.$reply{$cname}.'
'; + &Apache::lonnet::homeserver($sname,$sdom)); + $rowlabel=$ssec.' '.$reply{$sname}.'
'; map { $rowlabel.=&Apache::lonnet::unescape($_).' '; } split(/\&/,$reply); } - $currentlist{&Apache::lonnet::unescape($name)}=$rowlabel; } } split(/\&/,$classlst); @@ -904,9 +1032,10 @@ sub updatestudentrows { return 'Could not access course data'; } } -# ----------------------------------------------------------------- Update rows -sub updaterows { +# ----------------------------------- Update rows for student and assess sheets + +sub updatestudentassesssheet { my $safeeval=shift; my %bighash; # -------------------------------------------------------------------- Tie hash @@ -1051,8 +1180,7 @@ sub rowazclass { &Apache::lonnet::ssi( '/adm/studentcalc',('utarget' => 'export', 'uname' => $tname, - 'udom' => $tdom, - 'usymb' => $f{$_}))); + 'udom' => $tdom))); my $index=0; map { if ($assessdata[$index]) { @@ -1144,7 +1272,7 @@ sub rowaassess { if ($_=~/^A/) { unless ($f{$_}=~/^\!/) { if ($f{$_}=~/^parameter/) { - $c{$_}=&parmval($f{$_},$symb); + $c{$_}=&parmval($f{$_},$safeeval); } else { my $key=$f{$_}; $key=~s/^stores\_/resource\./; @@ -1182,20 +1310,73 @@ sub selectbox { return $selout.''; } +# =============================================== Update information in a sheet +# +# Add new users or assessments, etc. +# + +sub updatesheet { + my $safeeval=shift; + my $stype=&gettype($safeeval); + if ($stype eq 'classcalc') { + return &updateclasssheet($safeeval); + } else { + return &updatestudentassesssheet($safeeval); + } +} + +# =================================================== Load the rows for a sheet +# +# Import the data for rows +# + +sub loadrows() { + my $safeeval=shift; + my $stype=&gettype($safeeval); + if ($stype eq 'classcalc') { + &loadcourse($thissheet); + } elsif ($stype eq 'studentcalc') { + &loadstudent($thissheet); + } else { + &loadassessment($thissheet); + } +} + +# ============================================================== Export handler +# +# Non-interactive call from with program +# + +sub exportsheet { + my ($uname,$udom,$stype,$usymb,$fn)=@_; + my $thissheet=($uname,$udom,$stype,$usymb); + &readsheet($thissheet,$fn); + &updatesheet($thissheet); + &loadrows($thissheet); + &calcsheet($thissheet); + return &exportdata($thissheet); +} + # ================================================================ Main handler +# +# Interactive call to screen +# +# + sub handler { my $r=shift; - $uname=''; - $udom=''; - $csec=''; - - if ($r->header_only) { + if ($r->header_only) { $r->content_type('text/html'); $r->send_http_header; return OK; - } + } + +# ---------------------------------------------------- Global directory configs + +$includedir=r->dir_config('lonIncludes'); +$tmpdir=$r->dir_config('lonDaemons').'/tmp/'; # ----------------------------------------------------- Needs to be in a course @@ -1280,25 +1461,10 @@ ENDSCRIPT $ENV{'form.unewfield'},$ENV{'form.unewformula'}); } elsif ($ENV{'form.saveas'}) { &setfilename($sheetone,$ENV{'form.ufn'}); - &tmpread($sheetone,$r->dir_config('lonDaemons').'/tmp/', + &tmpread($sheetone,, $ENV{'form.usymb'}); } else { unless ($ENV{'form.ufn'}) { - my $reply=&Apache::lonnet::reply('get:'. - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'. - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}. - ':environment:spreadsheet_default_'. - &gettype($sheetone), - $ENV{'course.'.$ENV{'request.course.id'}.'.home'}); - unless ($reply=~/^error\:/) { - $ENV{'form.ufn'}=$reply; - unless ($reroute) { - $r->print('

Using customized default spreadsheet

'); - } - } - } - &readsheet($sheetone,$ENV{'form.ufn'},$r); - $ENV{'form.ufn'}=&getfilename($sheetone); } if (&gettype($sheetone) eq 'classcalc') { @@ -1379,6 +1545,8 @@ ENDSCRIPT &rowaassess($sheetone,$ENV{'form.usymb'}); } elsif (&gettype($sheetone) eq 'studentcalc') { &rowazstudent($sheetone); + } else { + &rowazclass($sheetone); } my $calcoutput=&calcsheet($sheetone); unless ($reroute) { @@ -1401,6 +1569,8 @@ ENDSCRIPT return HTTP_NOT_ACCEPTABLE; } return OK; + + $bombnomatterwhat='yes'; } 1;