--- loncom/interface/spreadsheet/Spreadsheet.pm	2003/05/16 20:55:11	1.1
+++ loncom/interface/spreadsheet/Spreadsheet.pm	2003/06/23 19:58:18	1.17
@@ -1,5 +1,5 @@
 #
-# $Id: Spreadsheet.pm,v 1.1 2003/05/16 20:55:11 matthew Exp $
+# $Id: Spreadsheet.pm,v 1.17 2003/06/23 19:58:18 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -98,6 +98,14 @@ sub new {
         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
+        #
+        # blackout is used to determine if any data needs to be hidden from the
+        # student.
+        blackout => 0,
+        #
         # Data storage
         formulas    => {},
         constants   => {},
@@ -137,24 +145,21 @@ 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'}};
+            $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 (! defined($newfilename) || 
-              $newfilename !~ /\w/   || 
-              $newfilename =~ /^\W*$/) {
-            $newfilename = 'default.'.$self->{'type'};
-        } else {
-            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'};
             }
         }
@@ -179,7 +184,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'};
@@ -212,10 +217,18 @@ 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 initialize_spreadsheet_package {
     &load_spreadsheet_expirationdates();
     &clear_spreadsheet_definition_cache();
@@ -803,30 +816,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;
+            $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;
     }
@@ -1105,18 +1120,38 @@ sub calcsheet {
 ## Output Helpers
 ##
 ###########################################################
+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'};
+    }
+    if ($outputmode eq 'html') {
+        $self->outsheet_html($r);
+    } elsif ($outputmode eq 'excel') {
+        $self->outsheet_excel($r);
+    } elsif ($outputmode eq 'csv') {
+        $self->outsheet_csv($r);
+    }
+    return;
+}
+
 ############################################
 ##         HTML output routines           ##
 ############################################
 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>';
@@ -1128,15 +1163,15 @@ 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="#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>';
@@ -1189,14 +1224,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">';
@@ -1207,6 +1247,55 @@ sub html_row {
     return $row_html;
 }
 
+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".
+        "</table>\n";
+}
+
+sub output_selector {
+    my $output_selector = '<select name="output_format" size="3">'."\n";
+    my $default = 'html';
+    if (exists($ENV{'form.output_format'})) {
+        $default = $ENV{'form.output_format'} 
+    } 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) {
+            $output_selector .= ' selected';
+        }
+        $output_selector .= ">$description</option>\n";
+    }
+    $output_selector .= "</select>\n";
+    return $output_selector;
+}
+
+################################################
+##          Excel output routines             ##
+################################################
+sub excel_output_row {
+    my $self = shift;
+    my ($worksheet,$rownum,$rows_output,@prepend) = @_;
+    my $cols_output = 0;
+    #
+    my @rowdata = $self->get_row($rownum);
+    foreach my $cell (@prepend,@rowdata) {
+        my $value = $cell;
+        $value = $cell->{'value'} if (ref($value));
+        $value =~ s/\&nbsp;/ /gi;
+        $worksheet->write($rows_output,$cols_output++,$value);
+    }
+    return;
+}
+
 sub create_excel_spreadsheet {
     my $self = shift;
     my ($r) = @_;
@@ -1232,6 +1321,103 @@ sub create_excel_spreadsheet {
     return ($workbook,$filename);
 }
 
+sub outsheet_excel {
+    my $self = shift;
+    my ($r) = @_;
+    $r->print("<h2>Preparing Excel Spreadsheet</h2>");
+    #
+    # Create excel worksheet
+    my ($workbook,$filename) = $self->create_excel_spreadsheet($r);
+    return if (! defined($workbook));
+    #
+    # Create main worksheet
+    my $worksheet = $workbook->addworksheet('main');
+    my $rows_output = 0;
+    my $cols_output = 0;
+    #
+    # Write excel header
+    foreach my $value ($self->get_title()) {
+        $cols_output = 0;
+        $worksheet->write($rows_output++,$cols_output,$value);
+    }
+    $rows_output++;    # skip a line
+    #
+    # Write summary/export row
+    $cols_output = 0;
+    $self->excel_output_row($worksheet,0,$rows_output++,'Summary');
+    $rows_output++;    # skip a line
+    #
+    $self->excel_rows($worksheet,$cols_output,$rows_output);
+    #
+    #
+    # Close the excel file
+    $workbook->close();
+    #
+    # Write a link to allow them to download it
+    $r->print('<br />'.
+              '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
+    return;
+}
+
+#################################
+## CSV output routines         ##
+#################################
+sub outsheet_csv   {
+    my $self = shift;
+    my ($r) = @_;
+    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("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($file);
+    #
+    # Close the csv file
+    close($file);
+    $r->print('<br /><br />'.
+              '<a href="'.$filename.'">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/\&nbsp;/ /gi;
+        $value = "'".$value."'";
+        push (@output,$value);
+    }
+    print $filehandle join(',',@output )."\n";
+    return;
+}
+
 ############################################
 ##          XML output routines           ##
 ############################################
@@ -1298,16 +1484,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
@@ -1316,19 +1519,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='<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($self->filename() =~ /^\/res\/.*\.spreadsheet$/) {
             # Load a spreadsheet definition file
             my $sheetxml=&Apache::lonnet::getfile
                 (&Apache::lonnet::filelocation('',$filename));
@@ -1337,31 +1530,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};
     }
@@ -1380,6 +1569,16 @@ sub set_row_sources {
     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.
 ##
@@ -1396,33 +1595,39 @@ sub save {
     my $self = shift;
     my ($makedef)=@_;
     my $cid=$self->{'cid'};
+    # If we are saving it, it must not be temporary
+    $self->temporary(0);
     if (&Apache::lonnet::allowed('opa',$cid)) {
         my %f=$self->formulas();
         my $stype = $self->{'type'};
         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 'assesscalc') {
+                &Apache::lonnet::expirespread('','','studentcalc','');
+            }
         }
         return $reply;
     }
@@ -1433,13 +1638,14 @@ sub save {
 
 sub save_tmp {
     my $self = shift;
-    my $fn=$ENV{'user.name'}.'_'.
+    my $filename=$ENV{'user.name'}.'_'.
         $ENV{'user.domain'}.'_spreadsheet_'.$self->{'usymb'}.'_'.
            $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');
@@ -1468,12 +1674,22 @@ sub load_tmp {
         }
         $spreadsheet_file->close();
     }
+    # flag the sheet as temporary
+    $self->temporary(1);
     $self->formulas(\%formulas);
     $self->set_row_sources();
     $self->set_row_numbers();
     return;
 }
 
+sub temporary {
+    my $self=shift;
+    if (@_) {
+        ($self->{'temporary'})= @_;
+    }
+    return $self->{'temporary'};
+}
+
 sub modify_cell {
     # studentcalc overrides this
     my $self = shift;
@@ -1500,12 +1716,20 @@ sub othersheets {
     my %results=&Apache::lonnet::dump($stype.'_spreadsheets',
                                       $self->{'cdom'}, $self->{'cnum'});
     my ($tmp) = keys(%results);
-    unless ($tmp =~ /^(con_lost|error|no_such_host)/i ) {
-        @alternatives = sort (keys(%results));
+    if ($tmp =~ /^(con_lost|error|no_such_host)/i ) {
+        @alternatives = ('Default');
+    } else {
+        @alternatives = ('Default', sort (keys(%results)));
     }
     return @alternatives; 
 }
 
+sub blackout {
+    my $self = shift;
+    $self->{'blackout'} = $_[0] if (@_);
+    return $self->{'blackout'};
+}
+
 sub get_row {
     my $self = shift;
     my ($n)=@_;
@@ -1531,14 +1755,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 {
@@ -1550,6 +1772,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};
 }