loncom/interface/spreadsheet/Spreadsheet.pm - diff

Return to Spreadsheet.pm CVS log

Up to [LON-CAPA] / loncom / interface / spreadsheet

Diff for /loncom/interface/spreadsheet/Spreadsheet.pm between versions 1.25 and 1.53

version 1.25, 2003/09/12 18:59:48	version 1.53, 2005/08/24 18:14:47
Line 59 use HTML::Entities();	Line 59 use HTML::Entities();
use HTML::TokeParser;	use HTML::TokeParser;
use Spreadsheet::WriteExcel;	use Spreadsheet::WriteExcel;
use Time::HiRes;	use Time::HiRes;
	use Apache::lonlocal;

##	##
## Package Variables	## Package Variables
Line 85 sub new {	Line 86 sub new {
my ($stype) = ($class =~ /Apache::(.*)$/);	my ($stype) = ($class =~ /Apache::(.*)$/);
#	#
my ($name,$domain,$filename,$usymb)=@_;	my ($name,$domain,$filename,$usymb)=@_;
	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'};
	}
#	#
my $self = {	my $self = {
name => $name,	name => $name,
Line 93 sub new {	Line 103 sub new {
symb => $usymb,	symb => $usymb,
errorlog => '',	errorlog => '',
maxrow => 0,	maxrow => 0,
cid => $ENV{'request.course.id'},	cid => $env{'request.course.id'},
cnum => $ENV{'course.'.$ENV{'request.course.id'}.'.num'},	cnum => $env{'course.'.$env{'request.course.id'}.'.num'},
cdom => $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},	cdom => $env{'course.'.$env{'request.course.id'}.'.domain'},
chome => $ENV{'course.'.$ENV{'request.course.id'}.'.home'},	coursedesc => $env{'course.'.$env{'request.course.id'}.'.description'},
coursedesc => $ENV{'course.'.$ENV{'request.course.id'}.'.description'},	coursefilename => $env{'request.course.fn'},
coursefilename => $ENV{'request.course.fn'},
#	#
# Flags	# Flags
temporary => 0, # true if this sheet has been modified but not saved	temporary => 0, # true if this sheet has been modified but not saved
new_rows => 0, # true if this sheet has new rows	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	# blackout is used to determine if any data needs to be hidden from the
# student.	# student.
Line 116 sub new {	Line 126 sub new {
othersheets => [],	othersheets => [],
};	};
#	#
$self->{'uhome'} = &Apache::lonnet::homeserver($name,$domain);
#
bless($self,$class);	bless($self,$class);
#
# Load in the spreadsheet definition
$self->filename($filename);	$self->filename($filename);
if (exists($ENV{'form.workcopy'}) &&	#
$self->{'type'} eq $ENV{'form.workcopy'}) {
$self->load_tmp();
} else {
$self->load();
}
return $self;	return $self;
}	}

Line 150 sub filename {	Line 151 sub filename {
$newfilename !~ /\w/ \|\| $newfilename eq '') {	$newfilename !~ /\w/ \|\| $newfilename eq '') {
my $key = 'course.'.$self->{'cid'}.'.spreadsheet_default_'.	my $key = 'course.'.$self->{'cid'}.'.spreadsheet_default_'.
$self->{'type'};	$self->{'type'};
if (exists($ENV{$key}) && $ENV{$key} ne '') {	if (exists($env{$key}) && $env{$key} ne '') {
$newfilename = $ENV{$key};	$newfilename = $env{$key};
} else {	} else {
$newfilename = 'default_'.$self->{'type'};	$newfilename = 'default_'.$self->{'type'};
}	}
Line 159 sub filename {	Line 160 sub filename {
if ($newfilename !~ /\w/ \|\| $newfilename =~ /^\W*$/) {	if ($newfilename !~ /\w/ \|\| $newfilename =~ /^\W*$/) {
$newfilename = 'default_'.$self->{'type'};	$newfilename = 'default_'.$self->{'type'};
}	}
if ($newfilename !~ /^default\.$self->{'type'}$/ ) {	if ($newfilename !~ /^default\.$self->{'type'}$/ &&
	$newfilename !~ /^\/res\/(.*)spreadsheet$/) {
if ($newfilename !~ /_$self->{'type'}$/) {	if ($newfilename !~ /_$self->{'type'}$/) {
$newfilename =~ s/[\s_]*$//;	$newfilename =~ s/[\s_]*$//;
$newfilename .= '_'.$self->{'type'};	$newfilename .= '_'.$self->{'type'};
Line 248 sub initialize_spreadsheet_package {	Line 250 sub initialize_spreadsheet_package {

sub load_spreadsheet_expirationdates {	sub load_spreadsheet_expirationdates {
undef %expiredates;	undef %expiredates;
my $cid=$ENV{'request.course.id'};	my $cid=$env{'request.course.id'};
my @tmp = &Apache::lonnet::dump('nohist_expirationdates',	my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
$ENV{'course.'.$cid.'.domain'},	$env{'course.'.$cid.'.domain'},
$ENV{'course.'.$cid.'.num'});	$env{'course.'.$cid.'.num'});
if (lc($tmp[0]) !~ /^error/){	if (lc($tmp[0]) !~ /^error/){
%expiredates = @tmp;	%expiredates = @tmp;
}	}
Line 305 Returns the safe space required by a Spr	Line 307 Returns the safe space required by a Spr

sub initialize_safe_space {	sub initialize_safe_space {
my $self = shift;	my $self = shift;
	my $usection = &Apache::lonnet::getsection($self->{'domain'},
	$self->{'name'},
	$env{'request.course.id'});
if (! defined($safeeval)) {	if (! defined($safeeval)) {
$safeeval = new Safe(shift);	$safeeval = new Safe(shift);
my $safehole = new Safe::Hole;	my $safehole = new Safe::Hole;
Line 312 sub initialize_safe_space {	Line 317 sub initialize_safe_space {
$safeeval->permit(":base_math");	$safeeval->permit(":base_math");
$safeeval->permit("sort");	$safeeval->permit("sort");
$safeeval->deny(":base_io");	$safeeval->deny(":base_io");
$safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');	$safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&Apache::lonnet::EXT');
$safehole->wrap(\&mask,$safeeval,'&mask');	$safehole->wrap(\&mask,$safeeval,'&mask');
	$safehole->wrap(\&Apache::lonnet::logthis,$safeeval,'&logthis');
$safeeval->share('$@');	$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';	my $code=<<'ENDDEFS';
# ---------------------------------------------------- Inside of the safe space	# ---------------------------------------------------- Inside of the safe space
#	#
Line 324 sub initialize_safe_space {	Line 334 sub initialize_safe_space {
# c: preloaded constants (A-column)	# c: preloaded constants (A-column)
# rl: row label	# rl: row label
# os: other spreadsheets (for student spreadsheet only)	# os: other spreadsheets (for student spreadsheet only)
undef %sheet_values; # Holds the (computed, final) values for the sheet	undef %t; # Holds the forumlas of the spreadsheet to be computed. Set in
# This is only written to by &calc, the spreadsheet computation routine.	# &sett, which does the translation of strings like C5 into the value
# It is read by many functions	# in C5. Used in &calc - %t holds the values that are actually eval'd.
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 %f; # Holds the formulas for each cell. This is the users	undef %f; # Holds the formulas for each cell. This is the users
# (spreadsheet authors) data for each cell.	# (spreadsheet authors) data for each cell.
undef %c; # Holds the constants for a sheet. In the assessment	undef %c; # Holds the constants for a sheet. In the assessment
Line 350 $filename = '';	Line 357 $filename = '';
#	#
# user data	# user data
$name = '';	$name = '';
$uhome = '';
$domain = '';	$domain = '';
#	#
# course data	# course data
$csec = '';	$csec = '';
$chome= '';
$cnum = '';	$cnum = '';
$cdom = '';	$cdom = '';
$cid = '';	$cid = '';
Line 371 $errormsg = '';	Line 376 $errormsg = '';

=pod	=pod

	=item EXT(parameter)

	Calls the system EXT function to determine the value of the given parameter.

	=cut

	#-------------------------------------------------------
	sub EXT {
	my ($parameter) = @_;
	return '' if (! defined($parameter) \|\| $parameter eq '');
	$parameter =~ s/^parameter\./resource\./;
	my $value = &Apache::lonnet::EXT($parameter,$symb,$domain,$name,$usection);
	return $value;
	}

	#-------------------------------------------------------

	=pod

=item NUM(range)	=item NUM(range)

returns the number of items in the range.	returns the number of items in the range.
Line 379 returns the number of items in the range	Line 403 returns the number of items in the range

#-------------------------------------------------------	#-------------------------------------------------------
sub NUM {	sub NUM {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $num= $#{@{grep(/$mask/,keys(%sheet_values))}}+1;	my $num= scalar(@$values);
return $num;	return $num;
}	}

Line 395 sub NUM {	Line 419 sub NUM {
#-------------------------------------------------------	#-------------------------------------------------------
sub BIN {	sub BIN {
my ($low,$high,$lower,$upper)=@_;	my ($low,$high,$lower,$upper)=@_;
my $mask=&mask($lower,$upper);	my $values=&get_values($lower,$upper);
my $num=0;	my $num=0;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
if (($sheet_values{$_}>=$low) && ($sheet_values{$_}<=$high)) {	if (($_>=$low) && ($_<=$high)) {
$num++;	$num++;
}	}
}	}
Line 417 returns the sum of items in the range.	Line 441 returns the sum of items in the range.

#-------------------------------------------------------	#-------------------------------------------------------
sub SUM {	sub SUM {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $sum=0;	my $sum=0;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
$sum+=$sheet_values{$_};	$sum+=$_;
}	}
return $sum;	return $sum;
}	}
Line 437 compute the average of the items in the	Line 461 compute the average of the items in the

#-------------------------------------------------------	#-------------------------------------------------------
sub MEAN {	sub MEAN {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $sum=0;	my $sum=0;
my $num=0;	my $num=0;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
$sum+=$sheet_values{$_};	$sum+=$_;
$num++;	$num++;
}	}
if ($num) {	if ($num) {
Line 463 compute the standard deviation of the it	Line 487 compute the standard deviation of the it

#-------------------------------------------------------	#-------------------------------------------------------
sub STDDEV {	sub STDDEV {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $sum=0; my $num=0;	my $sum=0; my $num=0;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
$sum+=$sheet_values{$_};	$sum+=$_;
$num++;	$num++;
}	}
unless ($num>1) { return undef; }	unless ($num>1) { return undef; }
my $mean=$sum/$num;	my $mean=$sum/$num;
$sum=0;	$sum=0;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
$sum+=($sheet_values{$_}-$mean)**2;	$sum+=($_-$mean)**2;
}	}
return sqrt($sum/($num-1));	return sqrt($sum/($num-1));
}	}
Line 490 compute the product of the items in the	Line 514 compute the product of the items in the

#-------------------------------------------------------	#-------------------------------------------------------
sub PROD {	sub PROD {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $prod=1;	my $prod=1;
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
$prod*=$sheet_values{$_};	$prod*=$_;
}	}
return $prod;	return $prod;
}	}
Line 510 compute the maximum of the items in the	Line 534 compute the maximum of the items in the

#-------------------------------------------------------	#-------------------------------------------------------
sub MAX {	sub MAX {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $max='-';	my $max='-';
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
unless ($max) { $max=$sheet_values{$_}; }	if (($_>$max) \|\| ($max eq '-')) {
if (($sheet_values{$_}>$max) \|\| ($max eq '-')) {	$max=$_;
$max=$sheet_values{$_};
}	}
}	}
return $max;	return $max;
Line 533 compute the minimum of the items in the	Line 556 compute the minimum of the items in the

#-------------------------------------------------------	#-------------------------------------------------------
sub MIN {	sub MIN {
my $mask=&mask(@_);	my $values=&get_values(@_);
my $min='-';	my $min='-';
foreach (grep /$mask/,keys(%sheet_values)) {	foreach (@$values) {
unless ($max) { $max=$sheet_values{$_}; }	if (($_<$min) \|\| ($min eq '-')) {
if (($sheet_values{$_}<$min) \|\| ($min eq '-')) {	$min=$_;
$min=$sheet_values{$_};
}	}
}	}
return $min;	return $min;
Line 558 compute the sum of the largest 'num' ite	Line 580 compute the sum of the largest 'num' ite
#-------------------------------------------------------	#-------------------------------------------------------
sub SUMMAX {	sub SUMMAX {
my ($num,$lower,$upper)=@_;	my ($num,$lower,$upper)=@_;
my $mask=&mask($lower,$upper);	my $values=&get_values($lower,$upper);
my @inside=();	my @inside=sort {$a <=> $b} (@$values);
foreach (grep /$mask/,keys(%sheet_values)) {
push (@inside,$sheet_values{$_});
}
@inside=sort(@inside);
my $sum=0; my $i;	my $sum=0; my $i;
for ($i=$#inside;(($i>$#inside-$num) && ($i>=0));$i--) {	for ($i=$#inside;(($i>$#inside-$num) && ($i>=0));$i--) {
$sum+=$inside[$i];	$sum+=$inside[$i];
Line 585 compute the sum of the smallest 'num' it	Line 603 compute the sum of the smallest 'num' it
#-------------------------------------------------------	#-------------------------------------------------------
sub SUMMIN {	sub SUMMIN {
my ($num,$lower,$upper)=@_;	my ($num,$lower,$upper)=@_;
my $mask=&mask($lower,$upper);	my $values=&get_values($lower,$upper);
my @inside=();	my @inside=sort {$a <=> $b} (@$values);
foreach (grep /$mask/,keys(%sheet_values)) {
$inside[$#inside+1]=$sheet_values{$_};
}
@inside=sort(@inside);
my $sum=0; my $i;	my $sum=0; my $i;
for ($i=0;(($i<$num) && ($i<=$#inside));$i++) {	for ($i=0;(($i<$num) && ($i<=$#inside));$i++) {
$sum+=$inside[$i];	$sum+=$inside[$i];
Line 613 parametername should be a string such as	Line 627 parametername should be a string such as
sub MINPARM {	sub MINPARM {
my ($expression) = @_;	my ($expression) = @_;
my $min = undef;	my $min = undef;
study($expression);
foreach $parameter (keys(%c)) {	foreach $parameter (keys(%c)) {
next if ($parameter !~ /$expression/);	next if ($parameter !~ /$expression/);
if ((! defined($min)) \|\| ($min > $c{$parameter})) {	if ((! defined($min)) \|\| ($min > $c{$parameter})) {
Line 638 parametername should be a string such as	Line 651 parametername should be a string such as
sub MAXPARM {	sub MAXPARM {
my ($expression) = @_;	my ($expression) = @_;
my $max = undef;	my $max = undef;
study($expression);
foreach $parameter (keys(%c)) {	foreach $parameter (keys(%c)) {
next if ($parameter !~ /$expression/);	next if ($parameter !~ /$expression/);
if ((! defined($min)) \|\| ($max < $c{$parameter})) {	if ((! defined($min)) \|\| ($max < $c{$parameter})) {
Line 648 sub MAXPARM {	Line 660 sub MAXPARM {
return $max;	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 = '(\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 {	sub calc {
%sheet_values = %t;
my $notfinished = 1;	my $notfinished = 1;
my $lastcalc = '';	my $lastcalc = '';
my $depth = 0;	my $depth = 0;
Line 677 sub calc {	Line 745 sub calc {
return $lastcalc.': Maximum calculation depth exceeded';	return $lastcalc.': Maximum calculation depth exceeded';
}	}
}	}
return '';	return 'okay';
}	}

# ------------------------------------------- End of "Inside of the safe space"	# ------------------------------------------- End of "Inside of the safe space"
Line 690 ENDDEFS	Line 758 ENDDEFS
# Place some of the %$self items into the safe space except the safe space	# Place some of the %$self items into the safe space except the safe space
# itself	# itself
my $initstring = '';	my $initstring = '';
foreach (qw/name domain type usymb cid csec coursefilename	foreach (qw/name domain type symb cid csec coursefilename
cnum cdom chome uhome/) {	cnum cdom/) {
$initstring.= qq{\$$_="$self->{$_}";};	$initstring.= qq{\$$_="$self->{$_}";};
}	}
	$initstring.=qq{\$usection="$usection";};
$self->{'safe'}->reval($initstring);	$self->{'safe'}->reval($initstring);
return $self;	return $self;
}	}
Line 710 ENDDEFS	Line 779 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	## sub add_hash_to_safe {} # spreadsheet, would like to destroy
##	##
Line 849 sub expandnamed {	Line 827 sub expandnamed {
my @matches = ();	my @matches = ();
my @values = ();	my @values = ();
$#matches = -1;	$#matches = -1;
study $expression;
while (my($parameter,$value) = each(%{$self->{'constants'}})) {	while (my($parameter,$value) = each(%{$self->{'constants'}})) {
next if ($parameter !~ /$expression/);	next if ($parameter !~ /$expression/);
push(@matches,$parameter);	push(@matches,$parameter);
Line 881 sub expandnamed {	Line 858 sub expandnamed {
sub sett {	sub sett {
my $self = shift;	my $self = shift;
my %t=();	my %t=();
	undef(%Apache::Spreadsheet::sheet_values);
#	#
# Deal with the template row	# Deal with the template row
foreach my $col ($self->template_cells()) {	foreach my $col ($self->template_cells()) {
Line 911 sub sett {	Line 889 sub sett {
$t{$cell}=~s/(^\|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;	$t{$cell}=~s/(^\|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
$t{$cell}=~s/(^\|[^\"\'])\[([^\]]+)\]/$1.$self->expandnamed($2)/ge;	$t{$cell}=~s/(^\|[^\"\'])\[([^\]]+)\]/$1.$self->expandnamed($2)/ge;
} elsif ( $col =~ /^[A-Z]$/ ) {	} elsif ( $col =~ /^[A-Z]$/ ) {
if ($formula !~ /^\!/ && exists($self->{'constants'}->{$cell})) {	if ($formula !~ /^\!/ && exists($self->{'constants'}->{$cell})
my $data = $self->{'constants'}->{$cell};	&& $self->{'constants'}->{$cell} ne '') {
$t{$cell} = $data;	$Apache::Spreadsheet::sheet_values{$cell}=
	eval($self->{'constants'}->{$cell});
}	}
} else { # $row > 1 and $col =~ /[a-z]	} else { # $row > 1 and $col =~ /[a-z]
$t{$cell}=$formula;	$t{$cell}=$formula;
Line 932 sub sett {	Line 911 sub sett {
sub sync_safe_space {	sub sync_safe_space {
my $self = shift;	my $self = shift;
# Inside the safe space 'formulas' has a diabolical alter-ego named 'f'.	# 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'.	# 'constants' leads a peaceful hidden life of 'c'.
%{$self->{'safe'}->varglob('c')}=%{$self->{'constants'}};	%{$self->{'safe'}->varglob('c')}=%{$self->{'constants'}};
# 'othersheets' hides as 'os', a disguise few can penetrate.	# 'othersheets' hides as 'os', a disguise few can penetrate.
@{$self->{'safe'}->varglob('os')}=@{$self->{'othersheets'}};	#@{$self->{'safe'}->varglob('os')}=@{$self->{'othersheets'}};
}	}

##	##
Line 991 sub formulas {	Line 970 sub formulas {
$self->{'template_cells'} = [];	$self->{'template_cells'} = [];
return;	return;
} else {	} else {
	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();
	}
	}
return %{$self->{'formulas'}};	return %{$self->{'formulas'}};
}	}
}	}
Line 1143 sub calcsheet {	Line 1132 sub calcsheet {
# $self->logthis($self->get_errorlog());	# $self->logthis($self->get_errorlog());
%{$self->{'values'}} = %{$self->{'safe'}->varglob('sheet_values')};	%{$self->{'values'}} = %{$self->{'safe'}->varglob('sheet_values')};
# $self->logthis($self->get_errorlog());	# $self->logthis($self->get_errorlog());
	if ($result ne 'okay') {
	$self->set_calcerror($result);
	}
return $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	## Output Helpers
Line 1154 sub calcsheet {	Line 1183 sub calcsheet {
sub display {	sub display {
my $self = shift;	my $self = shift;
my ($r) = @_;	my ($r) = @_;
$self->compute($r);
my $outputmode = 'html';	my $outputmode = 'html';
if ($ENV{'form.output_format'} =~ /^(html\|excel\|csv)$/) {	foreach ($self->output_options()) {
$outputmode = $ENV{'form.output_format'};	if ($env{'form.output_format'} eq $_->{'value'}) {
	$outputmode = $_->{'value'};
	last;
	}
}	}
if ($outputmode eq 'html') {	if ($outputmode eq 'html') {
	$self->compute($r);
$self->outsheet_html($r);	$self->outsheet_html($r);
	} elsif ($outputmode eq 'htmlclasslist') {
	# No computation neccessary... This is kludgy
	$self->outsheet_htmlclasslist($r);
} elsif ($outputmode eq 'excel') {	} elsif ($outputmode eq 'excel') {
	$self->compute($r);
$self->outsheet_excel($r);	$self->outsheet_excel($r);
} elsif ($outputmode eq 'csv') {	} elsif ($outputmode eq 'csv') {
	$self->compute($r);
$self->outsheet_csv($r);	$self->outsheet_csv($r);
	} elsif ($outputmode eq 'xml') {
	# $self->compute($r);
	$self->outsheet_xml($r);
}	}
$self->cleanup();	$self->cleanup();
return;	return;
Line 1173 sub display {	Line 1213 sub display {
############################################	############################################
## HTML output routines ##	## 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 {	sub html_export_row {
my $self = shift();	my $self = shift();
my ($color) = @_;	my ($color) = @_;
$color = '#CCCCFF' if (! defined($color));	$color = '#CCCCFF' if (! defined($color));
my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});	my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
my $row_html;	my $row_html;
my @rowdata = $self->get_row(0);	my @rowdata = $self->get_row(0);
foreach my $cell (@rowdata) {	foreach my $cell (@rowdata) {
Line 1194 sub html_export_row {	Line 1246 sub html_export_row {

sub html_template_row {	sub html_template_row {
my $self = shift();	my $self = shift();
my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});	my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
my ($num_uneditable,$importcolor) = @_;	my ($num_uneditable,$importcolor) = @_;
my $row_html;	my $row_html;
my @rowdata = $self->get_template_row();	my @rowdata = $self->get_template_row();
Line 1231 sub html_editable_cell {	Line 1283 sub html_editable_cell {
} elsif ($value =~ /^\s*$/ ) {	} elsif ($value =~ /^\s*$/ ) {
$value = '<font color="'.$bgcolor.'">#</font>';	$value = '<font color="'.$bgcolor.'">#</font>';
} else {	} else {
$value = &HTML::Entities::encode($value) if ($value !~/ /);	$value = &HTML::Entities::encode($value,'<>&"') if ($value !~/ /);
}	}
return $value if (! $allowed);	return $value if (! $allowed);
#	#
Line 1254 sub html_editable_cell {	Line 1306 sub html_editable_cell {
sub html_uneditable_cell {	sub html_uneditable_cell {
my ($cell,$bgcolor) = @_;	my ($cell,$bgcolor) = @_;
my $value = (defined($cell) ? $cell->{'value'} : '');	my $value = (defined($cell) ? $cell->{'value'} : '');
$value = &HTML::Entities::encode($value) if ($value !~/ /);	$value = &HTML::Entities::encode($value,'<>&"') if ($value !~/ /);
return ' '.$value.' ';	return ' '.$value.' ';
}	}

sub html_row {	sub html_row {
my $self = shift();	my $self = shift();
my ($num_uneditable,$row,$exportcolor,$importcolor) = @_;	my ($num_uneditable,$row,$exportcolor,$importcolor) = @_;
my $allowed = &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'});	my $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
my @rowdata = $self->get_row($row);	my @rowdata = $self->get_row($row);
my $num_cols_output = 0;	my $num_cols_output = 0;
my $row_html;	my $row_html;
Line 1285 sub html_row {	Line 1337 sub html_row {

sub html_header {	sub html_header {
my $self = shift;	my $self = shift;
return '' if (! $ENV{'request.role.adv'});	return '' if (! $env{'request.role.adv'});
return "<table>\n".	return "<table>\n".
'<tr><th align="center">Output Format</th><tr>'."\n".	'<tr><th align="center">'.&mt('Output Format').'</th></tr>'."\n".
'<tr><td>'.&output_selector()."</td></tr>\n".	'<tr><td>'.$self->output_selector()."</td></tr>\n".
"</table>\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 => 'xml',
	# description => 'XML'},
	{value => 'csv',
	description => 'Comma Separated Values'},);
	}

sub output_selector {	sub output_selector {
	my $self = shift();
my $output_selector = '<select name="output_format" size="3">'."\n";	my $output_selector = '<select name="output_format" size="3">'."\n";
my $default = 'html';	my $default = 'html';
if (exists($ENV{'form.output_format'})) {	if (exists($env{'form.output_format'})) {
$default = $ENV{'form.output_format'}	$default = $env{'form.output_format'}
} else {	} else {
$ENV{'form.output_format'} = $default;	$env{'form.output_format'} = $default;
}	}
foreach (['html','HTML'],	foreach ($self->output_options()) {
['excel','Excel'],	$output_selector.='<option value="'.$_->{'value'}.'"';
['csv','Comma Seperated Values']) {	if ($_->{'value'} eq $default) {
my ($name,$description) = @{$_};
$output_selector.=qq{<option value="$name"};
if ($name eq $default) {
$output_selector .= ' selected';	$output_selector .= ' selected';
}	}
$output_selector .= ">$description</option>\n";	$output_selector .= ">".&mt($_->{'description'})."</option>\n";
}	}
$output_selector .= "</select>\n";	$output_selector .= "</select>\n";
return $output_selector;	return $output_selector;
Line 1332 sub excel_output_row {	Line 1396 sub excel_output_row {
return;	return;
}	}

sub create_excel_spreadsheet {	#
	# This routine is just a stub
	sub outsheet_htmlclasslist {
my $self = shift;	my $self = shift;
my ($r) = @_;	my ($r) = @_;
my $filename = '/prtspool/'.	$r->print('<h2>'.&mt("This output is not supported").'</h2>');
$ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.	$r->rflush();
time.'_'.rand(1000000000).'.xls';	return;
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);
}	}

sub outsheet_excel {	sub outsheet_excel {
my $self = shift;	my $self = shift;
my ($r) = @_;	my ($r) = @_;
my $connection = $r->connection();	my $connection = $r->connection();
$r->print("<h2>Preparing Excel Spreadsheet</h2>");
#	#
# Create excel worksheet	$r->print($self->html_report_error());
my ($workbook,$filename) = $self->create_excel_spreadsheet($r);	$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));	return if (! defined($workbook));
#	#
# Create main worksheet	# Create main worksheet
Line 1375 sub outsheet_excel {	Line 1428 sub outsheet_excel {
# Write excel header	# Write excel header
foreach my $value ($self->get_title()) {	foreach my $value ($self->get_title()) {
$cols_output = 0;	$cols_output = 0;
$worksheet->write($rows_output++,$cols_output,$value);	$worksheet->write($rows_output++,$cols_output,$value,$format->{'h1'});
}	}
$rows_output++; # skip a line	$rows_output++; # skip a line
#	#
# Write summary/export row	# Write summary/export row
$cols_output = 0;	$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	$rows_output++; # skip a line
#	#
$self->excel_rows($connection,$worksheet,$cols_output,$rows_output);	$self->excel_rows($connection,$worksheet,$cols_output,$rows_output,
	$format);
#	#
#	#
# Close the excel file	# Close the excel file
Line 1403 sub outsheet_csv {	Line 1458 sub outsheet_csv {
my $self = shift;	my $self = shift;
my ($r) = @_;	my ($r) = @_;
my $connection = $r->connection();	my $connection = $r->connection();
	#
	$r->print($self->html_report_error());
	$r->rflush();
	#
my $csvdata = '';	my $csvdata = '';
my @Values;	my @Values;
#	#
# Open the csv file	# Open the csv file
my $filename = '/prtspool/'.	my $filename = '/prtspool/'.
$ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.	$env{'user.name'}.'_'.$env{'user.domain'}.'_'.
time.'_'.rand(1000000000).'.csv';	time.'_'.rand(1000000000).'.csv';
my $file;	my $file;
unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {	unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
$r->log_error("Couldn't open $filename for output $!");	$r->log_error("Couldn't open $filename for output $!");
$r->print("Problems occured in writing the csv file. ".	$r->print(&mt("Problems occured in writing the csv file. ".
"This error has been logged. ".	"This error has been logged. ".
"Please alert your LON-CAPA administrator.");	"Please alert your LON-CAPA administrator."));
$r->print("<pre>\n".$csvdata."</pre>\n");	$r->print("<pre>\n".$csvdata."</pre>\n");
return 0;	return 0;
}	}
Line 1431 sub outsheet_csv {	Line 1490 sub outsheet_csv {
# Close the csv file	# Close the csv file
close($file);	close($file);
$r->print('<br /><br />'.	$r->print('<br /><br />'.
'<a href="'.$filename.'">Your CSV spreadsheet.</a>'."\n");	'<a href="'.$filename.'">'.&mt('Your CSV spreadsheet.').'</a>'."\n");
#	#
return 1;	return 1;
}	}
Line 1467 sub outsheet_xml {	Line 1526 sub outsheet_xml {
## But not on this day	## But not on this day
my $Str = '<spreadsheet type="'.$self->{'type'}.'">'."\n";	my $Str = '<spreadsheet type="'.$self->{'type'}.'">'."\n";
while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {	while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
if ($cell =~ /^template_(\d+)/) {	if ($cell =~ /^template_(\w+)/) {
my $col = $1;	my $col = $1;
$Str .= '<template col="'.$col.'">'.$formula.'</template>'."\n";	$Str .= '<template col="'.$col.'">'.$formula.'</template>'."\n";
} else {	} else {
my ($row,$col) = ($cell =~ /^([A-z])(\d+)/);	my ($col,$row) = ($cell =~ /^([A-z])(\d+)/);
next if (! defined($row) \|\| ! defined($col));	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";	."\n";
}	}
}	}
$Str.="</spreadsheet>";	$Str.="</spreadsheet>";
	$r->print("<pre>\n\n\n".$Str."\n\n\n</pre>");
return $Str;	return $Str;
}	}

Line 1504 sub parse_sheet {	Line 1566 sub parse_sheet {
$formulas{$cell} = $formula;	$formulas{$cell} = $formula;
$sources{$cell} = $source if (defined($source));	$sources{$cell} = $source if (defined($source));
$parser->get_text('/field');	$parser->get_text('/field');
}	} elsif ($token->[1] eq 'template') {
if ($token->[1] eq 'template') {
$formulas{'template_'.$token->[2]->{'col'}}=	$formulas{'template_'.$token->[2]->{'col'}}=
$parser->get_text('/template');	$parser->get_text('/template');
}	}
Line 1546 sub load {	Line 1607 sub load {
my $stype = $self->{'type'};	my $stype = $self->{'type'};
my $cnum = $self->{'cnum'};	my $cnum = $self->{'cnum'};
my $cdom = $self->{'cdom'};	my $cdom = $self->{'cdom'};
my $chome = $self->{'chome'};
#	#
my $filename = $self->filename();	my $filename = $self->filename();
my $cachekey = join('_',($cnum,$cdom,$stype,$filename));	my $cachekey = join('_',($cnum,$cdom,$stype,$filename));
Line 1555 sub load {	Line 1615 sub load {
my ($formulas);	my ($formulas);
if (exists($spreadsheets{$cachekey})) {	if (exists($spreadsheets{$cachekey})) {
$formulas = $spreadsheets{$cachekey}->{'formulas'};	$formulas = $spreadsheets{$cachekey}->{'formulas'};
} else {	$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	# Not cached, need to read
if (! defined($filename)) {	if (! defined($filename)) {
$formulas = $self->load_system_default_sheet();	$formulas = $self->load_system_default_sheet();
} elsif($self->filename() =~ /^\/res\/.*\.spreadsheet$/) {	} elsif($filename =~ /^\/res\/.*\.spreadsheet$/) {
# Load a spreadsheet definition file	# Load a spreadsheet definition file
my $sheetxml=&Apache::lonnet::getfile	my $sheetxml=&Apache::lonnet::getfile
(&Apache::lonnet::filelocation('',$filename));	(&Apache::lonnet::filelocation('',$filename));
Line 1589 sub load {	Line 1653 sub load {
}	}
}	}
$filename=$self->filename(); # filename may have changed	$filename=$self->filename(); # filename may have changed
$cachekey = join('_',($cnum,$cdom,$stype,$filename));	$cachekey = join('_',($cnum,$cdom,$stype,$filename));
%{$spreadsheets{$cachekey}->{'formulas'}} = %{$formulas};	if (ref($formulas) eq 'HASH') {
	%{$spreadsheets{$cachekey}->{'formulas'}} = %{$formulas};
	}
	$self->formulas($formulas);
	$self->set_row_sources();
	$self->set_row_numbers();
	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'};
}	}
$self->formulas($formulas);
$self->set_row_sources();
$self->set_row_numbers();
}	}

sub set_row_sources {	sub set_row_sources {
Line 1622 sub set_row_numbers {	Line 1697 sub set_row_numbers {
##	##
sub exportrow {	sub exportrow {
my $self = shift;	my $self = shift;
	if (exists($self->{'badcalc'}) && $self->{'badcalc'}) {
	return ();
	}
my @exportarray;	my @exportarray;
foreach my $column (@UC_Columns) {	foreach my $column (@UC_Columns) {
push(@exportarray,$self->value($column.'0'));	push(@exportarray,$self->value($column.'0'));
Line 1640 sub save {	Line 1718 sub save {
my $stype = $self->{'type'};	my $stype = $self->{'type'};
my $cnum = $self->{'cnum'};	my $cnum = $self->{'cnum'};
my $cdom = $self->{'cdom'};	my $cdom = $self->{'cdom'};
my $chome = $self->{'chome'};
my $filename = $self->{'filename'};	my $filename = $self->{'filename'};
my $cachekey = join('_',($cnum,$cdom,$stype,$filename));	my $cachekey = join('_',($cnum,$cdom,$stype,$filename));
# Cache new sheet	# Cache new sheet
Line 1652 sub save {	Line 1729 sub save {
my $reply = &Apache::lonnet::put($filename,\%f,$cdom,$cnum);	my $reply = &Apache::lonnet::put($filename,\%f,$cdom,$cnum);
return $reply if ($reply ne 'ok');	return $reply if ($reply ne 'ok');
$reply = &Apache::lonnet::put($stype.'_spreadsheets',	$reply = &Apache::lonnet::put($stype.'_spreadsheets',
{$filename => $ENV{'user.name'}.'@'.$ENV{'user.domain'}},	{$filename => $env{'user.name'}.'@'.$env{'user.domain'}},
$cdom,$cnum);	$cdom,$cnum);
return $reply if ($reply ne 'ok');	return $reply if ($reply ne 'ok');
if ($makedef) {	if ($makedef) {
Line 1678 sub save {	Line 1755 sub save {

sub save_tmp {	sub save_tmp {
my $self = shift;	my $self = shift;
my $filename=$ENV{'user.name'}.'_'.	my $filename=$env{'user.name'}.'_'.
$ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.	$env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};	$self->{'filename'};
$filename=~s/\W/\_/g;	$filename=~s/\W/\_/g;
$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';	$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
Line 1698 sub save_tmp {	Line 1775 sub save_tmp {

sub load_tmp {	sub load_tmp {
my $self = shift;	my $self = shift;
my $filename=$ENV{'user.name'}.'_'.	my $filename=$env{'user.name'}.'_'.
$ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.	$env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};	$self->{'filename'};
$filename=~s/\W/\_/g;	$filename=~s/\W/\_/g;
$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';	$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
Line 1757 sub othersheets {	Line 1834 sub othersheets {
$self->{'cdom'}, $self->{'cnum'});	$self->{'cdom'}, $self->{'cnum'});
my ($tmp) = keys(%results);	my ($tmp) = keys(%results);
if ($tmp =~ /^(con_lost\|error\|no_such_host)/i ) {	if ($tmp =~ /^(con_lost\|error\|no_such_host)/i ) {
@alternatives = ('Default');	@alternatives = (&mt('Default'));
} else {	} else {
@alternatives = ('Default', sort (keys(%results)));	@alternatives = (&mt('Default'), sort (keys(%results)));
}	}
return @alternatives;	return @alternatives;
}	}

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

Removed from v.1.25
changed lines
	Added in v.1.53