--- loncom/interface/spreadsheet/Spreadsheet.pm	2003/09/16 15:36:32	1.27
+++ loncom/interface/spreadsheet/Spreadsheet.pm	2005/04/21 17:30:24	1.37.2.1
@@ -1,5 +1,5 @@
 #
-# $Id: Spreadsheet.pm,v 1.27 2003/09/16 15:36:32 matthew Exp $
+# $Id: Spreadsheet.pm,v 1.37.2.1 2005/04/21 17:30:24 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -59,6 +59,7 @@ use HTML::Entities();
 use HTML::TokeParser;
 use Spreadsheet::WriteExcel;
 use Time::HiRes;
+use Apache::lonlocal;
 
 ##
 ## Package Variables
@@ -85,6 +86,12 @@ sub new {
     my ($stype) = ($class =~ /Apache::(.*)$/);
     #
     my ($name,$domain,$filename,$usymb)=@_;
+    if (! defined($name) || $name eq '') {
+        $name = $ENV{'user.name'};
+    }
+    if (! defined($domain) || $domain eq '') {
+        $domain = $ENV{'user.domain'};
+    }
     #
     my $self = {
         name     => $name,
@@ -159,7 +166,8 @@ sub filename {
         if ($newfilename !~ /\w/ || $newfilename =~ /^\W*$/) {
             $newfilename = 'default_'.$self->{'type'};
         }
-        if ($newfilename !~ /^default\.$self->{'type'}$/ ) {
+        if ($newfilename !~ /^default\.$self->{'type'}$/ &&
+            $newfilename !~ /^\/res\/(.*)spreadsheet$/) {
             if ($newfilename !~ /_$self->{'type'}$/) {
                 $newfilename =~ s/[\s_]*$//;
                 $newfilename .= '_'.$self->{'type'};
@@ -613,7 +621,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})) {
@@ -638,7 +645,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})) {
@@ -677,7 +683,7 @@ sub calc {
             return $lastcalc.': Maximum calculation depth exceeded';
         }
     }
-    return '';
+    return 'okay';
 }
 
 # ------------------------------------------- End of "Inside of the safe space"
@@ -844,7 +850,6 @@ sub expandnamed {
         my @matches = ();
         my @values = ();
         $#matches = -1;
-        study $expression;
         while (my($parameter,$value) = each(%{$self->{'constants'}})) {
             next if ($parameter !~ /$expression/);
             push(@matches,$parameter);
@@ -906,7 +911,8 @@ 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})) {
+            if ($formula !~ /^\!/ && exists($self->{'constants'}->{$cell})
+		&& $self->{'constants'}->{$cell} ne '') {
                 my $data = $self->{'constants'}->{$cell};
                 $t{$cell} = $data;
             }
@@ -1138,9 +1144,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
@@ -1149,17 +1195,28 @@ 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;
+        }
     }
     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 '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;
@@ -1168,6 +1225,18 @@ sub display {
 ############################################
 ##         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 ($color) = @_;
@@ -1226,7 +1295,7 @@ sub html_editable_cell {
     } elsif ($value =~ /^\s*$/ ) {
         $value = '<font color="'.$bgcolor.'">#</font>';
     } else {
-        $value = &HTML::Entities::encode($value) if ($value !~/&nbsp;/);
+        $value = &HTML::Entities::encode($value,'<>&"') if ($value !~/&nbsp;/);
     }
     return $value if (! $allowed);
     #
@@ -1249,7 +1318,7 @@ sub html_editable_cell {
 sub html_uneditable_cell {
     my ($cell,$bgcolor) = @_;
     my $value = (defined($cell) ? $cell->{'value'} : '');
-    $value = &HTML::Entities::encode($value) if ($value !~/&nbsp;/);
+    $value = &HTML::Entities::encode($value,'<>&"') if ($value !~/&nbsp;/);
     return '&nbsp;'.$value.'&nbsp;';
 }
 
@@ -1282,12 +1351,27 @@ sub html_header {
     my $self = shift;
     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       => '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'})) {
@@ -1295,15 +1379,12 @@ sub output_selector {
     } else {
         $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;
@@ -1336,9 +1417,9 @@ sub create_excel_spreadsheet {
     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.  ".
+        $r->print(&mt("Problems creating new Excel file.  ".
                   "This error has been logged.  ".
-                  "Please alert your LON-CAPA administrator");
+                  "Please alert your LON-CAPA administrator"));
         return undef;
     }
     #
@@ -1352,11 +1433,25 @@ sub create_excel_spreadsheet {
     return ($workbook,$filename);
 }
 
+#
+# This routine is just a stub 
+sub outsheet_htmlclasslist {
+    my $self = shift;
+    my ($r) = @_;
+    $r->print('<h2>'.&mt("This output is not supported").'</h2>');
+    $r->rflush();
+    return;
+}
+
 sub outsheet_excel {
     my $self = shift;
     my ($r) = @_;
     my $connection = $r->connection();
-    $r->print("<h2>Preparing Excel Spreadsheet</h2>");
+    #
+    $r->print($self->html_report_error());
+    $r->rflush();
+    #
+    $r->print("<h2>".&mt('Preparing Excel Spreadsheet')."</h2>");
     #
     # Create excel worksheet
     my ($workbook,$filename) = $self->create_excel_spreadsheet($r);
@@ -1398,6 +1493,10 @@ sub outsheet_csv   {
     my $self = shift;
     my ($r) = @_;
     my $connection = $r->connection();
+    #
+    $r->print($self->html_report_error());
+    $r->rflush();
+    #
     my $csvdata = '';
     my @Values;
     #
@@ -1408,9 +1507,9 @@ sub outsheet_csv   {
     my $file;
     unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
         $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.  ".
-                  "Please alert your LON-CAPA administrator.");
+                  "Please alert your LON-CAPA administrator."));
         $r->print("<pre>\n".$csvdata."</pre>\n");
         return 0;
     }
@@ -1426,7 +1525,7 @@ sub outsheet_csv   {
     # Close the csv file
     close($file);
     $r->print('<br /><br />'.
-              '<a href="'.$filename.'">Your CSV spreadsheet.</a>'."\n");
+              '<a href="'.$filename.'">'.&mt('Your CSV spreadsheet.').'</a>'."\n");
     #
     return 1;
 }
@@ -1462,17 +1561,20 @@ sub outsheet_xml   {
     ## But not on this day
     my $Str = '<spreadsheet type="'.$self->{'type'}.'">'."\n";
     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;
 }
 
@@ -1499,8 +1601,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');
             }
@@ -1554,7 +1655,7 @@ sub load {
         # Not cached, need to read
         if (! defined($filename)) {
             $formulas = $self->load_system_default_sheet();
-        } elsif($self->filename() =~ /^\/res\/.*\.spreadsheet$/) {
+        } elsif($filename =~ /^\/res\/.*\.spreadsheet$/) {
             # Load a spreadsheet definition file
             my $sheetxml=&Apache::lonnet::getfile
                 (&Apache::lonnet::filelocation('',$filename));
@@ -1617,6 +1718,9 @@ sub set_row_numbers {
 ##
 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'));
@@ -1752,9 +1856,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 = ('Default', sort (keys(%results)));
+        @alternatives = (&mt('Default'), sort (keys(%results)));
     }
     return @alternatives; 
 }