--- loncom/interface/spreadsheet/Spreadsheet.pm 2003/05/23 19:36:04 1.5
+++ loncom/interface/spreadsheet/Spreadsheet.pm 2007/01/23 01:29:15 1.73
@@ -1,5 +1,5 @@
#
-# $Id: Spreadsheet.pm,v 1.5 2003/05/23 19:36:04 matthew Exp $
+# $Id: Spreadsheet.pm,v 1.73 2007/01/23 01:29:15 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -48,6 +48,8 @@ Spreadsheet
package Apache::Spreadsheet;
use strict;
+#use warnings FATAL=>'all';
+#no warnings 'uninitialized';
use Apache::Constants qw(:common :http);
use Apache::lonnet;
use Safe;
@@ -57,6 +59,10 @@ use HTML::Entities();
use HTML::TokeParser;
use Spreadsheet::WriteExcel;
use Time::HiRes;
+use Apache::lonlocal;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
+
##
## Package Variables
@@ -82,22 +88,46 @@ sub new {
my $class = ref($this) || $this;
my ($stype) = ($class =~ /Apache::(.*)$/);
#
- my ($name,$domain,$filename,$usymb)=@_;
+ my ($name,$domain,$filename,$usymb,$section,$groups)=@_;
+ if (defined($usymb) && ref($usymb)) {
+ $usymb = $usymb->symb;
+ }
+ if (! defined($name) || $name eq '') {
+ $name = $env{'user.name'};
+ }
+ if (! defined($domain) || $domain eq '') {
+ $domain = $env{'user.domain'};
+ }
+ if (! defined($section) || $section eq '') {
+ $section = &Apache::lonnet::getsection($domain,$name,
+ $env{'request.course.id'});
+ }
+ if (! defined($groups)) {
+
+ my @usersgroups = &Apache::lonnet::get_users_groups($domain,$name,
+ $env{'request.course.id'});
+ $groups = \@usersgroups;
+ }
#
my $self = {
name => $name,
domain => $domain,
+ section => $section,
+ groups => $groups,
type => $stype,
symb => $usymb,
errorlog => '',
- maxrow => '',
- 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'},
- coursedesc => $ENV{'course.'.$ENV{'request.course.id'}.'.description'},
- coursefilename => $ENV{'request.course.fn'},
- temporary => '',
+ maxrow => 0,
+ cid => $env{'request.course.id'},
+ cnum => $env{'course.'.$env{'request.course.id'}.'.num'},
+ cdom => $env{'course.'.$env{'request.course.id'}.'.domain'},
+ coursedesc => $env{'course.'.$env{'request.course.id'}.'.description'},
+ coursefilename => $env{'request.course.fn'},
+ #
+ # Flags
+ temporary => 0, # true if this sheet has been modified but not saved
+ new_rows => 0, # true if this sheet has new rows
+ loaded => 0, # true if the formulas have been loaded
#
# blackout is used to determine if any data needs to be hidden from the
# student.
@@ -111,18 +141,9 @@ sub new {
othersheets => [],
};
#
- $self->{'uhome'} = &Apache::lonnet::homeserver($name,$domain);
- #
bless($self,$class);
- #
- # Load in the spreadsheet definition
$self->filename($filename);
- if (exists($ENV{'form.workcopy'}) &&
- $self->{'type'} eq $ENV{'form.workcopy'}) {
- $self->load_tmp();
- } else {
- $self->load();
- }
+ #
return $self;
}
@@ -142,27 +163,29 @@ sub filename {
if (@_) {
my ($newfilename) = @_;
if (! defined($newfilename) || $newfilename eq 'Default' ||
- $newfilename !~ /\w/ || $newfilename =~ /\W/) {
- my %tmphash = &Apache::lonnet::get('environment',
- ['spreadsheet_default_'.
- $self->{'type'}],
- $self->{'cdom'},
- $self->{'cnum'});
- my ($tmp) = keys(%tmphash);
- if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
- $newfilename=$tmphash{'spreadsheet_default_'.$self->{'type'}};
- }
- }
- if (! defined($newfilename) ||
- $newfilename !~ /\w/ ||
- $newfilename =~ /^\W*$/) {
- $newfilename = 'default.'.$self->{'type'};
- } else {
- my $regexp = '_'.$self->{'type'}.'$';
- if ($newfilename !~ /$regexp/) {
- $newfilename .= '_'.$self->{'type'};
+ $newfilename !~ /\w/ || $newfilename eq '') {
+ my $key = 'course.'.$self->{'cid'}.'.spreadsheet_default_'.
+ $self->{'type'};
+ if (exists($env{$key}) && $env{$key} ne '') {
+ $newfilename = $env{$key};
+ } else {
+ $newfilename = 'default_'.$self->{'type'};
}
}
+ if ($newfilename eq &mt('LON-CAPA Standard')) {
+ undef($newfilename);
+ } else {
+ if ($newfilename !~ /\w/ || $newfilename =~ /^\W*$/) {
+ $newfilename = 'default_'.$self->{'type'};
+ }
+ if ($newfilename !~ /^default\.$self->{'type'}$/ &&
+ $newfilename !~ /^\/res\/(.*)spreadsheet$/) {
+ if ($newfilename !~ /_$self->{'type'}$/) {
+ $newfilename =~ s/[\s_]*$//;
+ $newfilename .= '_'.$self->{'type'};
+ }
+ }
+ }
$self->{'filename'} = $newfilename;
return;
}
@@ -184,9 +207,11 @@ default spreadsheets.......!
sub make_default {
my $self = shift();
my $result = &Apache::lonnet::put('environment',
- {'spreadsheet_default_'.$self->{'type'} => $self->filename()},
+ {'spreadsheet_default_'.$self->{'type'} => $self->filename()},
$self->{'cdom'},$self->{'cnum'});
return $result if ($result ne 'ok');
+ &Apache::lonnet::appenv('course.'.$self->{'cid'}.'.spreadsheet_default_'.
+ $self->{'type'} => $self->filename());
my $symb = $self->{'symb'};
$symb = '' if (! defined($symb));
&Apache::lonnet::expirespread('','',$self->{'type'},$symb);
@@ -207,20 +232,30 @@ course environment. Returns 0 otherwise
sub is_default {
my $self = shift;
# Check to find out if we are the default spreadsheet (filenames match)
- my $default_filename = '';
- my %tmphash = &Apache::lonnet::get('environment',
- ['spreadsheet_default_'.
- $self->{'type'}],
- $self->{'cdom'},
- $self->{'cnum'});
- my ($tmp) = keys(%tmphash);
- if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
- $default_filename = $tmphash{'spreadsheet_default_'.$self->{'type'}};
+ my $default_filename = $env{'course.'.$self->{'cid'}.
+ '.spreadsheet_default_'.$self->{'type'}};
+ if ($default_filename =~ /^\s*$/) {
+ $default_filename = 'default_'.$self->{'type'};
}
return 1 if ($self->filename() eq $default_filename);
return 0;
}
+sub initialize {
+ # This method is here to remind you that it will be overridden by
+ # the descendents of the spreadsheet class.
+}
+
+sub clear_package {
+ # This method is here to remind you that it will be overridden by
+ # the descendents of the spreadsheet class.
+}
+
+sub cleanup {
+ my $self = shift();
+ $self->clear_package();
+}
+
sub initialize_spreadsheet_package {
&load_spreadsheet_expirationdates();
&clear_spreadsheet_definition_cache();
@@ -228,10 +263,10 @@ sub initialize_spreadsheet_package {
sub load_spreadsheet_expirationdates {
undef %expiredates;
- my $cid=$ENV{'request.course.id'};
+ my $cid=$env{'request.course.id'};
my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
- $ENV{'course.'.$cid.'.domain'},
- $ENV{'course.'.$cid.'.num'});
+ $env{'course.'.$cid.'.domain'},
+ $env{'course.'.$cid.'.num'});
if (lc($tmp[0]) !~ /^error/){
%expiredates = @tmp;
}
@@ -240,18 +275,28 @@ sub load_spreadsheet_expirationdates {
sub check_expiration_time {
my $self = shift;
my ($time)=@_;
- my ($key1,$key2,$key3,$key4);
+ return 0 if (! defined($time));
+ my ($key1,$key2,$key3,$key4,$key5);
+ # Description of keys
+ #
+ # key1: all sheets of this type have expired
+ # key2: all sheets of this type for this student
+ # key3: all sheets of this type in this map for this student
+ # key4: this assessment sheet for this student
+ # key5: this assessment sheet for all students
$key1 = '::'.$self->{'type'}.':';
$key2 = $self->{'name'}.':'.$self->{'domain'}.':'.$self->{'type'}.':';
$key3 = $key2.$self->{'container'} if (defined($self->{'container'}));
- $key4 = $key2.$self->{'usymb'} if (defined($self->{'usymb'}));
- foreach my $key ($key1,$key2,$key3,$key4) {
+ $key4 = $key2.$self->{'symb'} if (defined($self->{'symb'}));
+ $key5 = $key1.$self->{'symb'} if (defined($self->{'symb'}));
+ my $returnvalue = 1; # default to okay
+ foreach my $key ($key1,$key2,$key3,$key4,$key5) {
next if (! defined($key));
- if (exists($expiredates{$key}) &&$expiredates{$key} > $time) {
- return 0;
+ if (exists($expiredates{$key}) && $expiredates{$key} > $time) {
+ $returnvalue = 0; # need to recompute
}
}
- return 1;
+ return $returnvalue;
}
######################################################
@@ -269,18 +314,31 @@ Returns the safe space required by a Spr
=cut
######################################################
+{
+
+ my $safeeval;
+
sub initialize_safe_space {
- my $self = shift;
- my $safeeval = new Safe(shift);
- my $safehole = new Safe::Hole;
- $safeeval->permit("entereval");
- $safeeval->permit(":base_math");
- $safeeval->permit("sort");
- $safeeval->deny(":base_io");
- $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
- $safehole->wrap(\&mask,$safeeval,'&mask');
- $safeeval->share('$@');
- my $code=<<'ENDDEFS';
+ my $self = shift;
+ my $usection = &Apache::lonnet::getsection($self->{'domain'},
+ $self->{'name'},
+ $env{'request.course.id'});
+ if (! defined($safeeval)) {
+ $safeeval = new Safe(shift);
+ my $safehole = new Safe::Hole;
+ $safeeval->permit("entereval");
+ $safeeval->permit(":base_math");
+ $safeeval->permit("sort");
+ $safeeval->deny(":base_io");
+ $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&Apache::lonnet::EXT');
+ $safehole->wrap(\&mask,$safeeval,'&mask');
+ $safehole->wrap(\&Apache::lonnet::logthis,$safeeval,'&logthis');
+ $safeeval->share('$@');
+ # Holds the (computed, final) values for the sheet
+ # This is only written to by &calc, the spreadsheet computation routine.
+ # It is read by many functions
+ $safeeval->share('%sheet_values');
+ my $code=<<'ENDDEFS';
# ---------------------------------------------------- Inside of the safe space
#
# f: formulas
@@ -289,12 +347,9 @@ sub initialize_safe_space {
# c: preloaded constants (A-column)
# rl: row label
# os: other spreadsheets (for student spreadsheet only)
-undef %sheet_values; # Holds the (computed, final) values for the sheet
- # This is only written to by &calc, the spreadsheet computation routine.
- # It is read by many functions
-undef %t; # Holds the values of the spreadsheet temporarily. Set in &sett,
- # which does the translation of strings like C5 into the value in C5.
- # Used in &calc - %t holds the values that are actually eval'd.
+undef %t; # Holds the forumlas of the spreadsheet to be computed. Set in
+ # &sett, which does the translation of strings like C5 into the value
+ # in C5. Used in &calc - %t holds the values that are actually eval'd.
undef %f; # Holds the formulas for each cell. This is the users
# (spreadsheet authors) data for each cell.
undef %c; # Holds the constants for a sheet. In the assessment
@@ -315,12 +370,10 @@ $filename = '';
#
# user data
$name = '';
-$uhome = '';
$domain = '';
#
# course data
$csec = '';
-$chome= '';
$cnum = '';
$cdom = '';
$cid = '';
@@ -336,6 +389,27 @@ $errormsg = '';
=pod
+=item EXT(parameter)
+
+Calls the system EXT function to determine the value of the given parameter.
+
+=cut
+
+#-------------------------------------------------------
+sub EXT {
+ my ($parameter,$specific_symb) = @_;
+ return '' if (! defined($parameter) || $parameter eq '');
+ $parameter =~ s/^parameter\./resource\./;
+ if ($specific_symb eq '') { $specific_symb = $symb; }
+ my $value = &Apache::lonnet::EXT($parameter,$specific_symb,$domain,$name,
+ $usection);
+ return $value;
+}
+
+#-------------------------------------------------------
+
+=pod
+
=item NUM(range)
returns the number of items in the range.
@@ -344,8 +418,8 @@ returns the number of items in the range
#-------------------------------------------------------
sub NUM {
- my $mask=&mask(@_);
- my $num= $#{@{grep(/$mask/,keys(%sheet_values))}}+1;
+ my $values=&get_values(@_);
+ my $num= scalar(@$values);
return $num;
}
@@ -360,10 +434,10 @@ sub NUM {
#-------------------------------------------------------
sub BIN {
my ($low,$high,$lower,$upper)=@_;
- my $mask=&mask($lower,$upper);
+ my $values=&get_values($lower,$upper);
my $num=0;
- foreach (grep /$mask/,keys(%sheet_values)) {
- if (($sheet_values{$_}>=$low) && ($sheet_values{$_}<=$high)) {
+ foreach (@$values) {
+ if (($_>=$low) && ($_<=$high)) {
$num++;
}
}
@@ -382,10 +456,10 @@ returns the sum of items in the range.
#-------------------------------------------------------
sub SUM {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $sum=0;
- foreach (grep /$mask/,keys(%sheet_values)) {
- $sum+=$sheet_values{$_};
+ foreach (@$values) {
+ $sum+=$_;
}
return $sum;
}
@@ -402,11 +476,11 @@ compute the average of the items in the
#-------------------------------------------------------
sub MEAN {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $sum=0;
my $num=0;
- foreach (grep /$mask/,keys(%sheet_values)) {
- $sum+=$sheet_values{$_};
+ foreach (@$values) {
+ $sum+=$_;
$num++;
}
if ($num) {
@@ -428,17 +502,17 @@ compute the standard deviation of the it
#-------------------------------------------------------
sub STDDEV {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $sum=0; my $num=0;
- foreach (grep /$mask/,keys(%sheet_values)) {
- $sum+=$sheet_values{$_};
+ foreach (@$values) {
+ $sum+=$_;
$num++;
}
unless ($num>1) { return undef; }
my $mean=$sum/$num;
$sum=0;
- foreach (grep /$mask/,keys(%sheet_values)) {
- $sum+=($sheet_values{$_}-$mean)**2;
+ foreach (@$values) {
+ $sum+=($_-$mean)**2;
}
return sqrt($sum/($num-1));
}
@@ -455,10 +529,10 @@ compute the product of the items in the
#-------------------------------------------------------
sub PROD {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $prod=1;
- foreach (grep /$mask/,keys(%sheet_values)) {
- $prod*=$sheet_values{$_};
+ foreach (@$values) {
+ $prod*=$_;
}
return $prod;
}
@@ -475,12 +549,11 @@ compute the maximum of the items in the
#-------------------------------------------------------
sub MAX {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $max='-';
- foreach (grep /$mask/,keys(%sheet_values)) {
- unless ($max) { $max=$sheet_values{$_}; }
- if (($sheet_values{$_}>$max) || ($max eq '-')) {
- $max=$sheet_values{$_};
+ foreach (@$values) {
+ if (($_>$max) || ($max eq '-')) {
+ $max=$_;
}
}
return $max;
@@ -498,12 +571,11 @@ compute the minimum of the items in the
#-------------------------------------------------------
sub MIN {
- my $mask=&mask(@_);
+ my $values=&get_values(@_);
my $min='-';
- foreach (grep /$mask/,keys(%sheet_values)) {
- unless ($max) { $max=$sheet_values{$_}; }
- if (($sheet_values{$_}<$min) || ($min eq '-')) {
- $min=$sheet_values{$_};
+ foreach (@$values) {
+ if (($_<$min) || ($min eq '-')) {
+ $min=$_;
}
}
return $min;
@@ -523,12 +595,8 @@ compute the sum of the largest 'num' ite
#-------------------------------------------------------
sub SUMMAX {
my ($num,$lower,$upper)=@_;
- my $mask=&mask($lower,$upper);
- my @inside=();
- foreach (grep /$mask/,keys(%sheet_values)) {
- push (@inside,$sheet_values{$_});
- }
- @inside=sort(@inside);
+ my $values=&get_values($lower,$upper);
+ my @inside=sort {$a <=> $b} (@$values);
my $sum=0; my $i;
for ($i=$#inside;(($i>$#inside-$num) && ($i>=0));$i--) {
$sum+=$inside[$i];
@@ -550,12 +618,8 @@ compute the sum of the smallest 'num' it
#-------------------------------------------------------
sub SUMMIN {
my ($num,$lower,$upper)=@_;
- my $mask=&mask($lower,$upper);
- my @inside=();
- foreach (grep /$mask/,keys(%sheet_values)) {
- $inside[$#inside+1]=$sheet_values{$_};
- }
- @inside=sort(@inside);
+ my $values=&get_values($lower,$upper);
+ my @inside=sort {$a <=> $b} (@$values);
my $sum=0; my $i;
for ($i=0;(($i<$num) && ($i<=$#inside));$i++) {
$sum+=$inside[$i];
@@ -578,7 +642,6 @@ parametername should be a string such as
sub MINPARM {
my ($expression) = @_;
my $min = undef;
- study($expression);
foreach $parameter (keys(%c)) {
next if ($parameter !~ /$expression/);
if ((! defined($min)) || ($min > $c{$parameter})) {
@@ -603,7 +666,6 @@ parametername should be a string such as
sub MAXPARM {
my ($expression) = @_;
my $max = undef;
- study($expression);
foreach $parameter (keys(%c)) {
next if ($parameter !~ /$expression/);
if ((! defined($min)) || ($max < $c{$parameter})) {
@@ -613,9 +675,65 @@ sub MAXPARM {
return $max;
}
+#-------------------------------------------------------
+
+=pod
+
+=item &get_values($lower,$upper)
+
+Inputs: $lower and $upper, cell names ("X12" or "a150") or globs ("X*").
+
+Returns: an array ref of the values of the cells that exist in the
+ speced range
+
+=cut
+
+#-------------------------------------------------------
+sub get_values {
+ my ($lower,$upper)=@_;
+ $upper = $lower if (! defined($upper));
+ my @values;
+ my ($la,$ld) = ($lower=~/([A-z]|\*)(\d+|\*)/);
+ my ($ua,$ud) = ($upper=~/([A-z]|\*)(\d+|\*)/);
+ my ($alpha,$num);
+ if ($ld ne '*' && $ud ne '*') {
+ my @alpha;
+ if (($la eq '*') || ($ua eq '*')) {
+ @alpha=('A'..'z');
+ } else {
+ if ($la gt $ua) { ($la,$ua)=($ua,$la); }
+ if ((lc($la) ne $la) && (lc($ua) eq $ua)) {
+ @alpha=($la..'Z','a'..$ua);
+ } else {
+ @alpha=($la..$ua);
+ }
+ }
+ my @num=($ld..$ud);
+ foreach my $a (@alpha) {
+ foreach my $n (@num) {
+ if (exists($sheet_values{$a.$n})) {
+ push(@values,$sheet_values{$a.$n});
+ }
+ }
+ }
+ return \@values;
+ } else {
+ $num = '([1-9]\d*)';
+ }
+ if (($la eq '*') || ($ua eq '*')) {
+ $alpha='[A-z]';
+ } else {
+ if ($la gt $ua) { ($la,$ua)=($ua,$la); }
+ $alpha=qq/[$la-$ua]/;
+ }
+ my $expression = '^'.$alpha.$num.'$';
+ foreach (grep /$expression/,keys(%sheet_values)) {
+ push(@values,$sheet_values{$_});
+ }
+ return \@values;
+}
sub calc {
- %sheet_values = %t;
my $notfinished = 1;
my $lastcalc = '';
my $depth = 0;
@@ -642,25 +760,30 @@ sub calc {
return $lastcalc.': Maximum calculation depth exceeded';
}
}
- return '';
+ return 'okay';
}
# ------------------------------------------- End of "Inside of the safe space"
ENDDEFS
- $safeeval->reval($code);
+ $safeeval->reval($code);
+ }
$self->{'safe'} = $safeeval;
$self->{'root'} = $self->{'safe'}->root();
#
# Place some of the %$self items into the safe space except the safe space
# itself
my $initstring = '';
- foreach (qw/name domain type usymb cid csec coursefilename
- cnum cdom chome uhome/) {
+ foreach (qw/name domain type symb cid csec coursefilename
+ cnum cdom/) {
$initstring.= qq{\$$_="$self->{$_}";};
}
+ $initstring.=qq{\$usection="$usection";};
$self->{'safe'}->reval($initstring);
return $self;
}
+
+}
+
######################################################
=pod
@@ -671,97 +794,6 @@ ENDDEFS
######################################################
-
-######################################################
-
-
-######################################################
-{
-
-my %memoizer;
-
-sub mask {
- my ($lower,$upper)=@_;
- my $key = $lower.'_'.$upper;
- if (exists($memoizer{$key})) {
- return $memoizer{$key};
- }
- $upper = $lower if (! defined($upper));
- #
- my ($la,$ld) = ($lower=~/([A-Za-z]|\*)(\d+|\*)/);
- my ($ua,$ud) = ($upper=~/([A-Za-z]|\*)(\d+|\*)/);
- #
- my $alpha='';
- my $num='';
- #
- if (($la eq '*') || ($ua eq '*')) {
- $alpha='[A-Za-z]';
- } else {
- 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 '*')) {
- $num='\d+';
- } else {
- if (length($ld)!=length($ud)) {
- $num.='(';
- foreach ($ld=~m/\d/g) {
- $num.='['.$_.'-9]';
- }
- if (length($ud)-length($ld)>1) {
- $num.='|\d{'.(length($ld)+1).','.(length($ud)-1).'}';
- }
- $num.='|';
- foreach ($ud=~m/\d/g) {
- $num.='[0-'.$_.']';
- }
- $num.=')';
- } else {
- my @lda=($ld=~m/\d/g);
- my @uda=($ud=~m/\d/g);
- my $i;
- my $j=0;
- my $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) {
- $num.='('.$lda[$j+1];
- for ($i=$j+2;$i<=$#lda;$i++) {
- $num.='['.$lda[$i].'-9]';
- }
- if ($uda[$j+1]-$lda[$j+1]>1) {
- $num.='|['.($lda[$j+1]+1).'-'.($uda[$j+1]-1).']\d{'.
- ($#lda-$j-1).'}';
- }
- $num.='|'.$uda[$j+1];
- for ($i=$j+2;$i<=$#uda;$i++) {
- $num.='[0-'.$uda[$i].']';
- }
- $num.=')';
- } else {
- if ($lda[-1]!=$uda[-1]) {
- $num.='['.$lda[-1].'-'.$uda[-1].']';
- }
- }
- }
- }
- my $expression ='^'.$alpha.$num."\$";
- $memoizer{$key} = $expression;
- return $expression;
-}
-
-}
-
##
## sub add_hash_to_safe {} # spreadsheet, would like to destroy
##
@@ -775,10 +807,12 @@ sub expandnamed {
if ($expression=~/^\&/) {
my ($func,$var,$formula)=($expression=~/^\&(\w+)\(([^\;]+)\;(.*)\)/);
my @vars=split(/\W+/,$formula);
+ # make the list uniq
+ @vars = keys(%{{ map { $_ => 1 } @vars }});
my %values=();
foreach my $varname ( @vars ) {
- if ($varname=~/\D/) {
- $formula=~s/$varname/'$c{\''.$varname.'\'}'/ge;
+ if ($varname=~/^(parameter|stores|timestamp)/) {
+ $formula=~s/$varname/'$c{\''.$varname.'\'}'/ge;
$varname=~s/$var/\([\\w:\\- ]\+\)/g;
foreach (keys(%{$self->{'constants'}})) {
if ($_=~/$varname/) {
@@ -795,7 +829,7 @@ sub expandnamed {
$result.=$thissum.'+';
}
$result=~s/\+$//;
- return $result;
+ return '('.$result.')';
} else {
return 0;
}
@@ -808,30 +842,31 @@ sub expandnamed {
# 4. If there is a collision, return 'bad parameter name error'
my $returnvalue = '';
my @matches = ();
+ my @values = ();
$#matches = -1;
- study $expression;
- my $parameter;
- foreach $parameter (keys(%{$self->{'constants'}})) {
- push @matches,$parameter if ($parameter =~ /$expression/);
+ while (my($parameter,$value) = each(%{$self->{'constants'}})) {
+ next if ($parameter !~ /$expression/);
+ push(@matches,$parameter);
+ push(@values,$value);
}
if (scalar(@matches) == 0) {
- $returnvalue = 'unmatched parameter: '.$parameter;
+ $returnvalue = '""';#'"unmatched parameter: '.$parameter.'"';
} elsif (scalar(@matches) == 1) {
# why do we not do this lookup here, instead of delaying it?
- $returnvalue = '$c{\''.$matches[0].'\'}';
+ $returnvalue = $values[0];
} elsif (scalar(@matches) > 0) {
# more than one match. Look for a concise one
$returnvalue = "'non-unique parameter name : $expression'";
- foreach (@matches) {
- if (/^$expression$/) {
+ for (my $i=0; $i<=$#matches;$i++) {
+ if ($matches[$i] =~ /^$expression$/) {
# why do we not do this lookup here?
- $returnvalue = '$c{\''.$_.'\'}';
+ $returnvalue = $values[$i];
}
}
} else {
# There was a negative number of matches, which indicates
# something is wrong with reality. Better warn the user.
- $returnvalue = 'bizzare parameter: '.$parameter;
+ $returnvalue = '"bizzare parameter: '.$expression.'"';
}
return $returnvalue;
}
@@ -840,6 +875,7 @@ sub expandnamed {
sub sett {
my $self = shift;
my %t=();
+ undef(%Apache::Spreadsheet::sheet_values);
#
# Deal with the template row
foreach my $col ($self->template_cells()) {
@@ -870,9 +906,10 @@ sub sett {
$t{$cell}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
$t{$cell}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.$self->expandnamed($2)/ge;
} elsif ( $col =~ /^[A-Z]$/ ) {
- if ($formula !~ /^\!/ && exists($self->{'constants'}->{$cell})) {
- my $data = $self->{'constants'}->{$cell};
- $t{$cell} = $data;
+ if ($formula !~ /^\!/ && exists($self->{'constants'}->{$cell})
+ && $self->{'constants'}->{$cell} ne '') {
+ $Apache::Spreadsheet::sheet_values{$cell}=
+ eval($self->{'constants'}->{$cell});
}
} else { # $row > 1 and $col =~ /[a-z]
$t{$cell}=$formula;
@@ -891,11 +928,11 @@ sub sett {
sub sync_safe_space {
my $self = shift;
# Inside the safe space 'formulas' has a diabolical alter-ego named 'f'.
- %{$self->{'safe'}->varglob('f')}=%{$self->{'formulas'}};
+ #%{$self->{'safe'}->varglob('f')}=%{$self->{'formulas'}};
# 'constants' leads a peaceful hidden life of 'c'.
%{$self->{'safe'}->varglob('c')}=%{$self->{'constants'}};
# 'othersheets' hides as 'os', a disguise few can penetrate.
- @{$self->{'safe'}->varglob('os')}=@{$self->{'othersheets'}};
+ #@{$self->{'safe'}->varglob('os')}=@{$self->{'othersheets'}};
}
##
@@ -948,15 +985,32 @@ sub formulas {
$self->{'formulas'} = $formulas;
$self->{'rows'} = [];
$self->{'template_cells'} = [];
+ $self->{'loaded'} = 1;
return;
} else {
+ $self->check_formulas_loaded();
return %{$self->{'formulas'}};
}
}
+sub check_formulas_loaded {
+ my $self=shift;
+ if (!$self->{'loaded'}) {
+ $self->{'loaded'}=1;
+ # Load in the spreadsheet definition
+ if (exists($env{'form.workcopy'}) &&
+ $self->{'type'} eq $env{'form.workcopy'}) {
+ $self->load_tmp();
+ } else {
+ $self->load();
+ }
+ }
+}
+
sub set_formula {
my $self = shift;
my ($cell,$formula) = @_;
+ $self->check_formulas_loaded();
$self->{'formulas'}->{$cell}=$formula;
return;
}
@@ -966,7 +1020,7 @@ sub set_formula {
##
sub formulas_keys {
my $self = shift;
- my @keys = keys(%{$self->{'formulas'}});
+ $self->check_formulas_loaded();
return keys(%{$self->{'formulas'}});
}
@@ -977,6 +1031,7 @@ sub formulas_keys {
sub formula {
my $self = shift;
my $cell = shift;
+ $self->check_formulas_loaded();
if (defined($cell) && exists($self->{'formulas'}->{$cell})) {
return $self->{'formulas'}->{$cell};
}
@@ -1055,6 +1110,7 @@ sub rebuild_stats {
my $self = shift;
$self->{'rows'}=[];
$self->{'template_cells'}=[];
+ $self->check_formulas_loaded();
while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
push(@{$self->{'rows'}},$1) if ($cell =~ /^A(\d+)/ && $1 != 0);
push(@{$self->{'template_cells'}},$1) if ($cell =~ /^template_(\w+)/);
@@ -1102,9 +1158,49 @@ sub calcsheet {
# $self->logthis($self->get_errorlog());
%{$self->{'values'}} = %{$self->{'safe'}->varglob('sheet_values')};
# $self->logthis($self->get_errorlog());
+ if ($result ne 'okay') {
+ $self->set_calcerror($result);
+ }
return $result;
}
+sub set_badcalc {
+ my $self = shift();
+ $self->{'badcalc'} =1;
+ return;
+}
+
+sub badcalc {
+ my $self = shift;
+ if (exists($self->{'badcalc'}) && $self->{'badcalc'}) {
+ return 1;
+ } else {
+ return 0;
+ }
+}
+
+sub set_calcerror {
+ my $self = shift;
+ if (@_) {
+ $self->set_badcalc();
+ if (exists($self->{'calcerror'})) {
+ $self->{'calcerror'}.="\n".$_[0];
+ } else {
+ $self->{'calcerror'}.=$_[0];
+ }
+ }
+}
+
+sub calcerror {
+ my $self = shift;
+ if ($self->badcalc()) {
+ if (exists($self->{'calcerror'})) {
+ return $self->{'calcerror'};
+ }
+ }
+ return;
+}
+
###########################################################
##
## Output Helpers
@@ -1113,36 +1209,71 @@ sub calcsheet {
sub display {
my $self = shift;
my ($r) = @_;
- $self->compute($r);
my $outputmode = 'html';
- if ($ENV{'form.output_format'} =~ /^(html|excel|csv)$/) {
- $outputmode = $ENV{'form.output_format'};
+ foreach ($self->output_options()) {
+ if ($env{'form.output_format'} eq $_->{'value'}) {
+ $outputmode = $_->{'value'};
+ last;
+ }
}
+ $self->{outputmode} = $outputmode;
if ($outputmode eq 'html') {
+ $self->compute($r);
+ $self->outsheet_html($r);
+ } elsif ($outputmode eq 'htmlclasslist') {
+ # No computation neccessary... This is kludgy
+ $self->outsheet_htmlclasslist($r);
+ } elsif ($outputmode eq 'source') {
+ # No computation necessary. Rumor has it that this is some
+ # sort of kludge w.r.t. not "computing". It's also
+ # a bit of of a kludge that we call "outsheet_html" and
+ # let the 'outputmode' cause the outputting of source.
$self->outsheet_html($r);
} elsif ($outputmode eq 'excel') {
+ $self->compute($r);
$self->outsheet_excel($r);
} elsif ($outputmode eq 'csv') {
+ $self->compute($r);
$self->outsheet_csv($r);
+ } elsif ($outputmode eq 'xml') {
+# $self->compute($r);
+ $self->outsheet_xml($r);
}
+ $self->cleanup();
return;
}
############################################
## HTML output routines ##
############################################
+sub html_report_error {
+ my $self = shift();
+ my $Str = '';
+ if ($self->badcalc()) {
+ $Str = '<h3 style="color:red">'.
+ &mt('An error occurred while calculating this spreadsheet').
+ "</h3>\n".
+ '<pre>'.$self->calcerror()."</pre>\n";
+ }
+ return $Str;
+}
+
sub html_export_row {
my $self = shift();
- my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});
+ my ($color) = @_;
+ $color = '#CCCCFF' if (! defined($color));
+ my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
my $row_html;
my @rowdata = $self->get_row(0);
foreach my $cell (@rowdata) {
if ($cell->{'name'} =~ /^[A-Z]/) {
- $row_html .= '<td bgcolor="#CCCCFF">'.
- &html_editable_cell($cell,'#CCCCFF',$allowed).'</td>';
+ $row_html .= '<td bgcolor="'.$color.'">'.
+ &html_editable_cell($cell,$color,$allowed,
+ $self->{outputmode} eq 'source').'</td>';
} else {
$row_html .= '<td bgcolor="#DDCCFF">'.
- &html_editable_cell($cell,'#DDCCFF',$allowed).'</td>';
+ &html_editable_cell($cell,'#DDCCFF',$allowed,
+ $self->{outputmode} eq 'source').'</td>';
}
}
return $row_html;
@@ -1150,26 +1281,27 @@ sub html_export_row {
sub html_template_row {
my $self = shift();
- my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});
- my ($num_uneditable) = @_;
+ my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
+ my ($num_uneditable,$importcolor) = @_;
my $row_html;
my @rowdata = $self->get_template_row();
my $count = 0;
for (my $i = 0; $i<=$#rowdata; $i++) {
my $cell = $rowdata[$i];
if ($i < $num_uneditable) {
- $row_html .= '<td bgcolor="#DDCCFF">'.
- &html_editable_cell($cell,'#DDCCFF',$allowed).'</td>';
+ $row_html .= '<td bgcolor="'.$importcolor.'">'.
+ &html_uneditable_cell($cell,'#FFDDDD',$allowed).'</td>';
} else {
- $row_html .= '<td bgcolor="#EOFFDD">'.
- &html_editable_cell($cell,'#EOFFDD',$allowed).'</td>';
+ $row_html .= '<td bgcolor="#E0FFDD">'.
+ &html_editable_cell($cell,'#E0FFDD',$allowed,
+ $self->{outputmode} eq 'source').'</td>';
}
}
return $row_html;
}
sub html_editable_cell {
- my ($cell,$bgcolor,$allowed) = @_;
+ my ($cell,$bgcolor,$allowed,$showsource) = @_;
my $result;
my ($name,$formula,$value);
if (defined($cell)) {
@@ -1179,7 +1311,13 @@ sub html_editable_cell {
}
$name = '' if (! defined($name));
$formula = '' if (! defined($formula));
- if (! defined($value)) {
+ if ($showsource) {
+ if (!defined($formula) || $formula =~ /^\s*$/) {
+ $value = '<font color="'.$bgcolor.'">#</font>';
+ } else {
+ $value = &HTML::Entities::encode($formula, '<>&"');
+ }
+ } elsif (! defined($value)) {
$value = '<font color="'.$bgcolor.'">#</font>';
if ($formula ne '') {
$value = '<i>undefined value</i>';
@@ -1187,16 +1325,20 @@ sub html_editable_cell {
} elsif ($value =~ /^\s*$/ ) {
$value = '<font color="'.$bgcolor.'">#</font>';
} else {
- $value = &HTML::Entities::encode($value) if ($value !~/ /);
+ $value = &HTML::Entities::encode($value,'<>&"') if ($value !~/ /);
}
return $value if (! $allowed);
- # Make the formula safe for outputting
- $formula =~ s/\'/\"/g;
+ #
# The formula will be parsed by the browser twice before being
- # displayed to the user for editing.
- $formula = &HTML::Entities::encode(&HTML::Entities::encode($formula));
- # Escape newlines so they make it into the edit window
- $formula =~ s/\n/\\n/gs;
+ # displayed to the user for editing.
+ #
+ # The encoding string "^A-blah" is placed in []'s inside a regexp, so
+ # we specify the characters we want left alone by putting a '^' in front.
+ $formula = &HTML::Entities::encode($formula,'^A-z0-9 !#$%-;=?~');
+ # HTML::Entities::encode does not catch everything - we need '\' encoded
+ $formula =~ s/\\/&\#092/g;
+ # Escape it again - this time the only encodable character is '&'
+ $formula =~ s/\&/\&/g;
# Glue everything together
$result .= "<a href=\"javascript:celledit(\'".
$name."','".$formula."');\">".$value."</a>";
@@ -1206,24 +1348,30 @@ sub html_editable_cell {
sub html_uneditable_cell {
my ($cell,$bgcolor) = @_;
my $value = (defined($cell) ? $cell->{'value'} : '');
- $value = &HTML::Entities::encode($value) if ($value !~/ /);
+ $value = &HTML::Entities::encode($value,'<>&"') if ($value !~/ /);
return ' '.$value.' ';
}
sub html_row {
my $self = shift();
- my ($num_uneditable,$row) = @_;
- my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});
+ my ($num_uneditable,$row,$exportcolor,$importcolor) = @_;
+ my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
my @rowdata = $self->get_row($row);
my $num_cols_output = 0;
my $row_html;
+ my $color = $importcolor;
+ if ($row == 0) {
+ $color = $exportcolor;
+ }
+ $color = '#FFDDDD' if (! defined($color));
foreach my $cell (@rowdata) {
if ($num_cols_output++ < $num_uneditable) {
- $row_html .= '<td bgcolor="#FFDDDD">';
+ $row_html .= '<td bgcolor="'.$color.'">';
$row_html .= &html_uneditable_cell($cell,'#FFDDDD');
} else {
- $row_html .= '<td bgcolor="#EOFFDD">';
- $row_html .= &html_editable_cell($cell,'#E0FFDD',$allowed);
+ $row_html .= '<td bgcolor="#E0FFDD">';
+ $row_html .= &html_editable_cell($cell,'#E0FFDD',$allowed,
+ $self->{outputmode} eq 'source');
}
$row_html .= '</td>';
}
@@ -1232,30 +1380,44 @@ sub html_row {
sub html_header {
my $self = shift;
- return '' if (! $ENV{'request.role.adv'});
+ return '' if (! $env{'request.role.adv'});
return "<table>\n".
- '<tr><th align="center">Output Format</th><tr>'."\n".
- '<tr><td>'.&output_selector()."</td></tr>\n".
+ '<tr><th align="center">'.&mt('Output Format').'</th></tr>'."\n".
+ '<tr><td>'.$self->output_selector()."</td></tr>\n".
"</table>\n";
}
+##
+## Default output types are HTML, Excel, and CSV
+sub output_options {
+ my $self = shift();
+ return ({value => 'html',
+ description => 'HTML'},
+ {value => 'excel',
+ description => 'Excel'},
+ {value => 'source',
+ description => 'Show Source'},
+# {value => 'xml',
+# description => 'XML'},
+ {value => 'csv',
+ description => 'Comma Separated Values'},);
+}
+
sub output_selector {
+ my $self = shift();
my $output_selector = '<select name="output_format" size="3">'."\n";
my $default = 'html';
- if (exists($ENV{'form.output_format'})) {
- $default = $ENV{'form.output_format'}
+ if (exists($env{'form.output_format'})) {
+ $default = $env{'form.output_format'}
} else {
- $ENV{'form.output_format'} = $default;
+ $env{'form.output_format'} = $default;
}
- foreach (['html','HTML'],
- ['excel','Excel'],
- ['csv','Comma Seperated Values']) {
- my ($name,$description) = @{$_};
- $output_selector.=qq{<option value="$name"};
- if ($name eq $default) {
+ foreach ($self->output_options()) {
+ $output_selector.='<option value="'.$_->{'value'}.'"';
+ if ($_->{'value'} eq $default) {
$output_selector .= ' selected';
}
- $output_selector .= ">$description</option>\n";
+ $output_selector .= ">".&mt($_->{'description'})."</option>\n";
}
$output_selector .= "</select>\n";
return $output_selector;
@@ -1279,38 +1441,28 @@ sub excel_output_row {
return;
}
-sub create_excel_spreadsheet {
+#
+# This routine is just a stub
+sub outsheet_htmlclasslist {
my $self = shift;
my ($r) = @_;
- my $filename = '/prtspool/'.
- $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
- time.'_'.rand(1000000000).'.xls';
- my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
- if (! defined($workbook)) {
- $r->log_error("Error creating excel spreadsheet $filename: $!");
- $r->print("Problems creating new Excel file. ".
- "This error has been logged. ".
- "Please alert your LON-CAPA administrator");
- return undef;
- }
- #
- # The excel spreadsheet stores temporary data in files, then put them
- # together. If needed we should be able to disable this (memory only).
- # The temporary directory must be specified before calling 'addworksheet'.
- # File::Temp is used to determine the temporary directory.
- $workbook->set_tempdir('/home/httpd/perl/tmp');
- #
- # Determine the name to give the worksheet
- return ($workbook,$filename);
+ $r->print('<h2>'.&mt("This output is not supported").'</h2>');
+ $r->rflush();
+ return;
}
sub outsheet_excel {
my $self = shift;
my ($r) = @_;
- $r->print("<h2>Preparing Excel Spreadsheet</h2>");
+ my $connection = $r->connection();
#
- # Create excel worksheet
- my ($workbook,$filename) = $self->create_excel_spreadsheet($r);
+ $r->print($self->html_report_error());
+ $r->rflush();
+ #
+ $r->print("<h2>".&mt('Preparing Excel Spreadsheet')."</h2>");
+ #
+ # Create excel workbook
+ my ($workbook,$filename,$format)=&Apache::loncommon::create_workbook($r);
return if (! defined($workbook));
#
# Create main worksheet
@@ -1321,16 +1473,18 @@ sub outsheet_excel {
# Write excel header
foreach my $value ($self->get_title()) {
$cols_output = 0;
- $worksheet->write($rows_output++,$cols_output,$value);
+ $worksheet->write($rows_output++,$cols_output,$value,$format->{'h1'});
}
$rows_output++; # skip a line
#
# Write summary/export row
$cols_output = 0;
- $self->excel_output_row($worksheet,0,$rows_output++,'Summary');
+ $self->excel_output_row($worksheet,0,$rows_output++,'Summary',
+ $format->{'b'});
$rows_output++; # skip a line
#
- $self->excel_rows($worksheet,$cols_output,$rows_output);
+ $self->excel_rows($connection,$worksheet,$cols_output,$rows_output,
+ $format);
#
#
# Close the excel file
@@ -1342,6 +1496,70 @@ sub outsheet_excel {
return;
}
+#################################
+## CSV output routines ##
+#################################
+sub outsheet_csv {
+ my $self = shift;
+ my ($r) = @_;
+ my $connection = $r->connection();
+ #
+ $r->print($self->html_report_error());
+ $r->rflush();
+ #
+ my $csvdata = '';
+ my @Values;
+ #
+ # Open the csv file
+ my $filename = '/prtspool/'.
+ $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.csv';
+ my $file;
+ unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
+ $r->log_error("Couldn't open $filename for output $!");
+ $r->print(&mt("Problems occured in writing the csv file. ".
+ "This error has been logged. ".
+ "Please alert your LON-CAPA administrator."));
+ $r->print("<pre>\n".$csvdata."</pre>\n");
+ return 0;
+ }
+ #
+ # Output the title information
+ foreach my $value ($self->get_title()) {
+ print $file "'".&Apache::loncommon::csv_translate($value)."'\n";
+ }
+ #
+ # Output the body of the spreadsheet
+ $self->csv_rows($connection,$file);
+ #
+ # Close the csv file
+ close($file);
+ $r->print('<br /><br />'.
+ '<a href="'.$filename.'">'.&mt('Your CSV spreadsheet.').'</a>'."\n");
+ #
+ return 1;
+}
+
+sub csv_output_row {
+ my $self = shift;
+ my ($filehandle,$rownum,@prepend) = @_;
+ #
+ my @rowdata = ();
+ if (defined($rownum)) {
+ @rowdata = $self->get_row($rownum);
+ }
+ my @output = ();
+ foreach my $cell (@prepend,@rowdata) {
+ my $value = $cell;
+ $value = $cell->{'value'} if (ref($value));
+ $value =~ s/\ / /gi;
+ $value = "'".$value."'";
+ push (@output,$value);
+ }
+ print $filehandle join(',',@output )."\n";
+ return;
+}
+
############################################
## XML output routines ##
############################################
@@ -1352,18 +1570,22 @@ sub outsheet_xml {
## Will be rendered for the user
## But not on this day
my $Str = '<spreadsheet type="'.$self->{'type'}.'">'."\n";
+ $self->check_formulas_loaded();
while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
- if ($cell =~ /^template_(\d+)/) {
+ if ($cell =~ /^template_(\w+)/) {
my $col = $1;
$Str .= '<template col="'.$col.'">'.$formula.'</template>'."\n";
} else {
- my ($row,$col) = ($cell =~ /^([A-z])(\d+)/);
+ my ($col,$row) = ($cell =~ /^([A-z])(\d+)/);
next if (! defined($row) || ! defined($col));
- $Str .= '<field row="'.$row.'" col="'.$col.'" >'.$formula.'</cell>'
+ next if ($row != 0);
+ $Str .=
+ '<field row="'.$row.'" col="'.$col.'" >'.$formula.'</field>'
."\n";
}
}
$Str.="</spreadsheet>";
+ $r->print("<pre>\n\n\n".$Str."\n\n\n</pre>");
return $Str;
}
@@ -1390,8 +1612,7 @@ sub parse_sheet {
$formulas{$cell} = $formula;
$sources{$cell} = $source if (defined($source));
$parser->get_text('/field');
- }
- if ($token->[1] eq 'template') {
+ } elsif ($token->[1] eq 'template') {
$formulas{'template_'.$token->[2]->{'col'}}=
$parser->get_text('/template');
}
@@ -1408,37 +1629,47 @@ sub clear_spreadsheet_definition_cache {
undef(%spreadsheets);
}
-sub load {
+sub load_system_default_sheet {
my $self = shift;
my $includedir = $Apache::lonnet::perlvar{'lonIncludes'};
+ # load in the default defined spreadsheet
+ my $sheetxml='';
+ my $fh;
+ if ($fh=Apache::File->new($includedir.'/default_'.$self->{'type'})) {
+ $sheetxml=join('',<$fh>);
+ $fh->close();
+ } else {
+ # $sheetxml='<field row="0" col="A">"Error"</field>';
+ $sheetxml='<field row="0" col="A"></field>';
+ }
+ $self->filename('default_');
+ my ($formulas,undef) = &parse_sheet(\$sheetxml);
+ return $formulas;
+}
+
+sub load {
+ my $self = shift;
#
my $stype = $self->{'type'};
my $cnum = $self->{'cnum'};
my $cdom = $self->{'cdom'};
- my $chome = $self->{'chome'};
- my $filename = $self->{'filename'};
#
+ my $filename = $self->filename();
my $cachekey = join('_',($cnum,$cdom,$stype,$filename));
#
# see if sheet is cached
my ($formulas);
if (exists($spreadsheets{$cachekey})) {
$formulas = $spreadsheets{$cachekey}->{'formulas'};
+ $self->formulas($formulas);
+ $self->{'row_source'}=$spreadsheets{$cachekey}->{'row_source'};
+ $self->{'row_numbers'}=$spreadsheets{$cachekey}->{'row_numbers'};
+ $self->{'maxrow'}=$spreadsheets{$cachekey}->{'maxrow'};
} else {
# Not cached, need to read
- if (! defined($self->filename())) {
- # load in the default defined spreadsheet
- my $sheetxml='';
- my $fh;
- if ($fh=Apache::File->new($includedir.'/default.'.$filename)) {
- $sheetxml=join('',<$fh>);
- $fh->close();
- } else {
- # $sheetxml='<field row="0" col="A">"Error"</field>';
- $sheetxml='<field row="0" col="A"></field>';
- }
- ($formulas,undef) = &parse_sheet(\$sheetxml);
- } elsif($self->filename() =~ /^\/*\.spreadsheet$/) {
+ if (! defined($filename)) {
+ $formulas = $self->load_system_default_sheet();
+ } elsif($filename =~ /^\/res\/.*\.spreadsheet$/) {
# Load a spreadsheet definition file
my $sheetxml=&Apache::lonnet::getfile
(&Apache::lonnet::filelocation('',$filename));
@@ -1447,54 +1678,86 @@ sub load {
.$self->filename().'"</field>';
}
($formulas,undef) = &parse_sheet(\$sheetxml);
+ # Get just the filename and set the sheets filename
+ my ($newfilename) = ($filename =~ /\/([^\/]*)\.spreadsheet$/);
+ if ($self->is_default()) {
+ $self->filename($newfilename);
+ $self->make_default();
+ } else {
+ $self->filename($newfilename);
+ }
} else {
# Load the spreadsheet definition file from the save file
- my %tmphash = &Apache::lonnet::dump($self->filename(),$cdom,$cnum);
+ my %tmphash = &Apache::lonnet::dump($filename,$cdom,$cnum);
my ($tmp) = keys(%tmphash);
- if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
+ if (%tmphash
+ && $tmp !~ /^(con_lost|error|no_such_host)/i) {
while (my ($cell,$formula) = each(%tmphash)) {
$formulas->{$cell}=$formula;
}
} else {
- # Unable to grab the specified spreadsheet,
- # so we get the default ones instead.
- $filename = 'default.'.$stype;
- $self->filename($filename);
- my $sheetxml;
- if (my $fh=Apache::File->new($includedir.'/'.$filename)) {
- $sheetxml = join('',<$fh>);
- $fh->close();
- } else {
- $sheetxml='<field row="0" col="A">'.
- '"Unable to load spreadsheet"</field>';
- }
- ($formulas,undef) = &parse_sheet(\$sheetxml);
- $self->formulas($formulas);
+ $formulas = $self->load_system_default_sheet();
}
}
- $cachekey = join('_',($cnum,$cdom,$stype,$filename));
- %{$spreadsheets{$cachekey}->{'formulas'}} = %{$formulas};
+ $self->formulas($formulas);
+ $self->set_row_sources();
+ $self->set_row_numbers();
+ $self->cache_sheet($formulas);
}
- $self->formulas($formulas);
- $self->set_row_sources();
- $self->set_row_numbers();
+}
+
+sub cache_sheet {
+ my $self = shift;
+ my ($formulas) = @_;
+ my $stype = $self->{'type'};
+ my $cnum = $self->{'cnum'};
+ my $cdom = $self->{'cdom'};
+ #
+ my $filename = $self->filename();
+ my $cachekey = join('_',($cnum,$cdom,$stype,$filename));
+
+ if (ref($formulas) eq 'HASH') {
+ %{$spreadsheets{$cachekey}->{'formulas'}} = %{$formulas};
+ }
+ if (ref($self->{'row_source'})) {
+ %{$spreadsheets{$cachekey}->{'row_source'}} =%{$self->{'row_source'}};
+ }
+ if (ref($self->{'row_numbers'})) {
+ %{$spreadsheets{$cachekey}->{'row_numbers'}}=%{$self->{'row_numbers'}};
+ }
+ $spreadsheets{$cachekey}->{'maxrow'} = $self->{'maxrow'};
}
sub set_row_sources {
my $self = shift;
+ $self->check_formulas_loaded();
while (my ($cell,$value) = each(%{$self->{'formulas'}})) {
- next if ($cell !~ /^A(\d+)/ && $1 > 0);
+ next if ($cell !~ /^A(\d+)/ || $1 < 1);
my $row = $1;
$self->{'row_source'}->{$row} = $value;
}
return;
}
+sub set_row_numbers {
+ my $self = shift;
+ $self->check_formulas_loaded();
+ while (my ($cell,$value) = each(%{$self->{'formulas'}})) {
+ next if ($cell !~ /^A(\d+)$/);
+ next if (! defined($value));
+ $self->{'row_numbers'}->{$value} = $1;
+ $self->{'maxrow'} = $1 if ($1 > $self->{'maxrow'});
+ }
+}
+
##
## exportrow is *not* used to get the export row from a computed sub-sheet.
##
sub exportrow {
my $self = shift;
+ if (exists($self->{'badcalc'}) && $self->{'badcalc'}) {
+ return ();
+ }
my @exportarray;
foreach my $column (@UC_Columns) {
push(@exportarray,$self->value($column.'0'));
@@ -1513,28 +1776,34 @@ sub save {
my $stype = $self->{'type'};
my $cnum = $self->{'cnum'};
my $cdom = $self->{'cdom'};
- my $chome = $self->{'chome'};
- my $fn = $self->{'filename'};
+ my $filename = $self->{'filename'};
# Cache new sheet
- $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
+ $self->cache_sheet(\%f);
# Write sheet
foreach (keys(%f)) {
delete($f{$_}) if ($f{$_} eq 'import');
}
- my $reply = &Apache::lonnet::put($fn,\%f,$cdom,$cnum);
+ my $reply = &Apache::lonnet::put($filename,\%f,$cdom,$cnum);
return $reply if ($reply ne 'ok');
$reply = &Apache::lonnet::put($stype.'_spreadsheets',
- {$fn => $ENV{'user.name'}.'@'.$ENV{'user.domain'}},
+ {$filename => $env{'user.name'}.'@'.$env{'user.domain'}},
$cdom,$cnum);
return $reply if ($reply ne 'ok');
if ($makedef) {
$reply = &Apache::lonnet::put('environment',
- {'spreadsheet_default_'.$stype => $fn },
+ {'spreadsheet_default_'.$stype => $filename },
$cdom,$cnum);
return $reply if ($reply ne 'ok');
+ &Apache::lonnet::appenv('course.'.$self->{'cid'}.'.spreadsheet_default_'.
+ $self->{'type'} => $self->filename());
}
if ($self->is_default()) {
- &Apache::lonnet::expirespread('','',$self->{'type'},'');
+ if ($self->{'type'} eq 'studentcalc') {
+ &Apache::lonnet::expirespread('','','studentcalc','');
+ } elsif ($self->{'type'} eq 'assesscalc') {
+ &Apache::lonnet::expirespread('','','assesscalc','');
+ &Apache::lonnet::expirespread('','','studentcalc','');
+ }
}
return $reply;
}
@@ -1545,19 +1814,19 @@ sub save {
sub save_tmp {
my $self = shift;
- my $fn=$ENV{'user.name'}.'_'.
- $ENV{'user.domain'}.'_spreadsheet_'.$self->{'usymb'}.'_'.
+ my $filename=$env{'user.name'}.'_'.
+ $env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};
- $fn=~s/\W/\_/g;
- $fn=$Apache::lonnet::tmpdir.$fn.'.tmp';
+ $filename=~s/\W/\_/g;
+ $filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
$self->temporary(1);
my $fh;
- if ($fh=Apache::File->new('>'.$fn)) {
+ if ($fh=Apache::File->new('>'.$filename)) {
my %f = $self->formulas();
while( my ($cell,$formula) = each(%f)) {
next if ($formula eq 'import');
- print $fh &Apache::lonnet::escape($cell)."=".
- &Apache::lonnet::escape($formula)."\n";
+ print $fh &escape($cell)."=".
+ &escape($formula)."\n";
}
$fh->close();
}
@@ -1565,8 +1834,8 @@ sub save_tmp {
sub load_tmp {
my $self = shift;
- my $filename=$ENV{'user.name'}.'_'.
- $ENV{'user.domain'}.'_spreadsheet_'.$self->{'usymb'}.'_'.
+ my $filename=$env{'user.name'}.'_'.
+ $env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};
$filename=~s/\W/\_/g;
$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
@@ -1575,8 +1844,8 @@ sub load_tmp {
while (<$spreadsheet_file>) {
chomp;
my ($cell,$formula) = split(/=/);
- $cell = &Apache::lonnet::unescape($cell);
- $formula = &Apache::lonnet::unescape($formula);
+ $cell = &unescape($cell);
+ $formula = &unescape($formula);
$formulas{$cell} = $formula;
}
$spreadsheet_file->close();
@@ -1594,7 +1863,6 @@ sub temporary {
if (@_) {
($self->{'temporary'})= @_;
}
- $self->logthis('temporary = '.$self->{'temporary'});
return $self->{'temporary'};
}
@@ -1620,14 +1888,13 @@ sub othersheets {
my ($stype) = @_;
$stype = $self->{'type'} if (! defined($stype) || $stype !~ /calc$/);
#
- my @alternatives=();
+ my @alternatives=(&mt('Default'), &mt('LON-CAPA Standard'));
my %results=&Apache::lonnet::dump($stype.'_spreadsheets',
$self->{'cdom'}, $self->{'cnum'});
my ($tmp) = keys(%results);
- if ($tmp =~ /^(con_lost|error|no_such_host)/i ) {
- @alternatives = ('Default');
- } else {
- @alternatives = sort (keys(%results));
+ if (%results
+ && $tmp !~ /^(con_lost|error|no_such_host)/i ) {
+ push(@alternatives, sort(keys(%results)));
}
return @alternatives;
}
@@ -1663,14 +1930,12 @@ sub get_template_row {
return @cols;
}
-sub set_row_numbers {
+sub need_to_save {
my $self = shift;
- my %f=$self->formulas();
- while (my ($cell,$value) = each(%{$self->{'formulas'}})) {
- next if ($cell !~ /^A(\d+)$/);
- next if (! defined($value));
- $self->{'row_numbers'}->{$value} = $1;
+ if ($self->{'new_rows'} && ! $self->temporary()) {
+ return 1;
}
+ return 0;
}
sub get_row_number_from_key {
@@ -1682,6 +1947,9 @@ sub get_row_number_from_key {
# may not be the key we need to save
$self->{'maxrow'}++;
$self->{'row_numbers'}->{$key} = $self->{'maxrow'};
+# $self->logthis('added row '.$self->{'row_numbers'}->{$key}.
+# ' for '.$key);
+ $self->{'new_rows'} = 1;
}
return $self->{'row_numbers'}->{$key};
}