';
@@ -1187,16 +1320,20 @@ sub html_editable_cell {
} elsif ($value =~ /^\s*$/ ) {
$value = '#';
} 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 .= "".$value."";
@@ -1206,20 +1343,25 @@ 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 .= '
';
@@ -1232,30 +1374,42 @@ sub html_row {
sub html_header {
my $self = shift;
- return '' if (! $ENV{'request.role.adv'});
+ return '' if (! $env{'request.role.adv'});
return "
\n".
- '
Output Format
'."\n".
- '
'.&output_selector()."
\n".
+ '
'.&mt('Output Format').'
'."\n".
+ '
'.$self->output_selector()."
\n".
"
\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 {
+ my $self = shift();
my $output_selector = '\n";
return $output_selector;
@@ -1279,38 +1433,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('
'.&mt("This output is not supported").'
');
+ $r->rflush();
+ return;
}
sub outsheet_excel {
my $self = shift;
my ($r) = @_;
- $r->print("
");
#
- # Create excel worksheet
- my ($workbook,$filename) = $self->create_excel_spreadsheet($r);
+ # Create excel workbook
+ my ($workbook,$filename,$format)=&Apache::loncommon::create_workbook($r);
return if (! defined($workbook));
#
# Create main worksheet
@@ -1321,16 +1465,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 +1488,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("
\n".$csvdata."
\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('
'.
+ ''.&mt('Your CSV spreadsheet.').''."\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 ##
############################################
@@ -1353,17 +1563,20 @@ sub outsheet_xml {
## But not on this day
my $Str = ''."\n";
while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
- if ($cell =~ /^template_(\d+)/) {
+ if ($cell =~ /^template_(\w+)/) {
my $col = $1;
$Str .= ''.$formula.''."\n";
} else {
- my ($row,$col) = ($cell =~ /^([A-z])(\d+)/);
+ my ($col,$row) = ($cell =~ /^([A-z])(\d+)/);
next if (! defined($row) || ! defined($col));
- $Str .= ''.$formula.''
+ next if ($row != 0);
+ $Str .=
+ ''.$formula.''
."\n";
}
}
$Str.="";
+ $r->print("
\n\n\n".$Str."\n\n\n
");
return $Str;
}
@@ -1390,8 +1603,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,16 +1620,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='"Error"';
+ $sheetxml='';
+ }
+ $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
@@ -1426,19 +1655,9 @@ 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='"Error"';
- $sheetxml='';
- }
- ($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,31 +1666,27 @@ sub load {
.$self->filename().'"';
}
($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=''.
- '"Unable to load spreadsheet"';
- }
- ($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};
}
@@ -1483,18 +1698,31 @@ 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.
##
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'));
@@ -1514,27 +1742,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;
}
@@ -1545,14 +1779,14 @@ 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');
@@ -1565,8 +1799,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';
@@ -1594,7 +1828,6 @@ sub temporary {
if (@_) {
($self->{'temporary'})= @_;
}
- $self->logthis('temporary = '.$self->{'temporary'});
return $self->{'temporary'};
}
@@ -1625,9 +1858,9 @@ sub othersheets {
$self->{'cdom'}, $self->{'cnum'});
my ($tmp) = keys(%results);
if ($tmp =~ /^(con_lost|error|no_such_host)/i ) {
- @alternatives = ('Default');
+ @alternatives = (&mt('Default'));
} else {
- @alternatives = sort (keys(%results));
+ @alternatives = (&mt('Default'), sort (keys(%results)));
}
return @alternatives;
}
@@ -1663,14 +1896,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 +1913,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};
}