--- loncom/interface/spreadsheet/Spreadsheet.pm 2003/05/28 17:38:57 1.10
+++ loncom/interface/spreadsheet/Spreadsheet.pm 2003/09/05 01:57:54 1.23
@@ -1,5 +1,5 @@
#
-# $Id: Spreadsheet.pm,v 1.10 2003/05/28 17:38:57 matthew Exp $
+# $Id: Spreadsheet.pm,v 1.23 2003/09/05 01:57:54 matthew 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;
@@ -90,14 +92,17 @@ sub new {
type => $stype,
symb => $usymb,
errorlog => '',
- maxrow => '',
+ maxrow => 0,
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 => '',
+ #
+ # Flags
+ temporary => 0, # true if this sheet has been modified but not saved
+ new_rows => 0, # true if this sheet has new rows
#
# blackout is used to determine if any data needs to be hidden from the
# student.
@@ -142,25 +147,21 @@ sub filename {
if (@_) {
my ($newfilename) = @_;
if (! defined($newfilename) || $newfilename eq 'Default' ||
- $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'};
+ $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'};
}
- } elsif ($newfilename !~ /^\/res\/.*\.spreadsheet/ &&
- $newfilename !~ /^default\.$self->{'type'}$/ ) {
- my $regexp = '_'.$self->{'type'}.'$';
- if ($newfilename !~ /$regexp/) {
+ }
+ if ($newfilename !~ /\w/ || $newfilename =~ /^\W*$/) {
+ $newfilename = 'default_'.$self->{'type'};
+ }
+ if ($newfilename !~ /^default\.$self->{'type'}$/ ) {
+ if ($newfilename !~ /_$self->{'type'}$/) {
+ $newfilename =~ s/[\s_]*$//;
$newfilename .= '_'.$self->{'type'};
}
}
@@ -185,7 +186,7 @@ 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');
my $symb = $self->{'symb'};
@@ -218,10 +219,28 @@ sub is_default {
if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
$default_filename = $tmphash{'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();
@@ -241,18 +260,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;
}
######################################################
@@ -778,8 +807,8 @@ sub expandnamed {
my @vars=split(/\W+/,$formula);
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/) {
@@ -809,30 +838,32 @@ 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.'"';
} 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;
}
@@ -1126,6 +1157,7 @@ sub display {
} elsif ($outputmode eq 'csv') {
$self->outsheet_csv($r);
}
+ $self->cleanup();
return;
}
@@ -1134,13 +1166,15 @@ sub display {
############################################
sub html_export_row {
my $self = shift();
+ 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).'</td>';
} else {
$row_html .= '<td bgcolor="#DDCCFF">'.
&html_editable_cell($cell,'#DDCCFF',$allowed).'</td>';
@@ -1152,14 +1186,14 @@ 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 ($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="#FFDDDD">'.
+ $row_html .= '<td bgcolor="'.$importcolor.'">'.
&html_uneditable_cell($cell,'#FFDDDD',$allowed).'</td>';
} else {
$row_html .= '<td bgcolor="#EOFFDD">'.
@@ -1191,13 +1225,17 @@ sub html_editable_cell {
$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>";
@@ -1213,14 +1251,19 @@ sub html_uneditable_cell {
sub html_row {
my $self = shift();
- my ($num_uneditable,$row) = @_;
+ 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">';
@@ -1308,6 +1351,7 @@ sub create_excel_spreadsheet {
sub outsheet_excel {
my $self = shift;
my ($r) = @_;
+ my $connection = $r->connection();
$r->print("<h2>Preparing Excel Spreadsheet</h2>");
#
# Create excel worksheet
@@ -1331,7 +1375,7 @@ sub outsheet_excel {
$self->excel_output_row($worksheet,0,$rows_output++,'Summary');
$rows_output++; # skip a line
#
- $self->excel_rows($worksheet,$cols_output,$rows_output);
+ $self->excel_rows($connection,$worksheet,$cols_output,$rows_output);
#
#
# Close the excel file
@@ -1349,6 +1393,7 @@ sub outsheet_excel {
sub outsheet_csv {
my $self = shift;
my ($r) = @_;
+ my $connection = $r->connection();
my $csvdata = '';
my @Values;
#
@@ -1372,7 +1417,7 @@ sub outsheet_csv {
}
#
# Output the body of the spreadsheet
- $self->csv_rows($file);
+ $self->csv_rows($connection,$file);
#
# Close the csv file
close($file);
@@ -1468,16 +1513,33 @@ 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
@@ -1486,18 +1548,8 @@ sub load {
$formulas = $spreadsheets{$cachekey}->{'formulas'};
} 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);
+ if (! defined($filename)) {
+ $formulas = $self->load_system_default_sheet();
} elsif($self->filename() =~ /^\/res\/.*\.spreadsheet$/) {
# Load a spreadsheet definition file
my $sheetxml=&Apache::lonnet::getfile
@@ -1507,31 +1559,27 @@ 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) {
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();
}
}
+ $filename=$self->filename(); # filename may have changed
$cachekey = join('_',($cnum,$cdom,$stype,$filename));
%{$spreadsheets{$cachekey}->{'formulas'}} = %{$formulas};
}
@@ -1543,13 +1591,23 @@ sub load {
sub set_row_sources {
my $self = shift;
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;
+ 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.
##
@@ -1574,27 +1632,33 @@ sub save {
my $cnum = $self->{'cnum'};
my $cdom = $self->{'cdom'};
my $chome = $self->{'chome'};
- my $fn = $self->{'filename'};
+ my $filename = $self->{'filename'};
+ my $cachekey = join('_',($cnum,$cdom,$stype,$filename));
# Cache new sheet
- $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
+ %{$spreadsheets{$cachekey}->{'formulas'}}=%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');
}
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;
}
@@ -1606,7 +1670,7 @@ sub save {
sub save_tmp {
my $self = shift;
my $filename=$ENV{'user.name'}.'_'.
- $ENV{'user.domain'}.'_spreadsheet_'.$self->{'usymb'}.'_'.
+ $ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};
$filename=~s/\W/\_/g;
$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
@@ -1626,7 +1690,7 @@ sub save_tmp {
sub load_tmp {
my $self = shift;
my $filename=$ENV{'user.name'}.'_'.
- $ENV{'user.domain'}.'_spreadsheet_'.$self->{'usymb'}.'_'.
+ $ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
$self->{'filename'};
$filename=~s/\W/\_/g;
$filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
@@ -1686,7 +1750,7 @@ sub othersheets {
if ($tmp =~ /^(con_lost|error|no_such_host)/i ) {
@alternatives = ('Default');
} else {
- @alternatives = sort (keys(%results));
+ @alternatives = ('Default', sort (keys(%results)));
}
return @alternatives;
}
@@ -1722,14 +1786,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 {
@@ -1741,6 +1803,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};
}