--- loncom/interface/spreadsheet/Spreadsheet.pm	2005/02/03 23:59:41	1.38
+++ loncom/interface/spreadsheet/Spreadsheet.pm	2005/05/13 15:59:07	1.45
@@ -1,5 +1,5 @@
 #
-# $Id: Spreadsheet.pm,v 1.38 2005/02/03 23:59:41 matthew Exp $
+# $Id: Spreadsheet.pm,v 1.45 2005/05/13 15:59:07 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -86,11 +86,14 @@ sub new {
     my ($stype) = ($class =~ /Apache::(.*)$/);
     #
     my ($name,$domain,$filename,$usymb)=@_;
+    if (defined($usymb) && ref($usymb)) {
+        $usymb = $usymb->symb;
+    }
     if (! defined($name) || $name eq '') {
-        $name = $ENV{'user.name'};
+        $name = $env{'user.name'};
     }
     if (! defined($domain) || $domain eq '') {
-        $domain = $ENV{'user.domain'};
+        $domain = $env{'user.domain'};
     }
     #
     my $self = {
@@ -100,12 +103,12 @@ sub new {
         symb     => $usymb,
         errorlog => '',
         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'},
+        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'},
         #
         # Flags
         temporary => 0,  # true if this sheet has been modified but not saved
@@ -129,8 +132,8 @@ sub new {
     #
     # Load in the spreadsheet definition
     $self->filename($filename);
-    if (exists($ENV{'form.workcopy'}) && 
-        $self->{'type'} eq $ENV{'form.workcopy'}) {
+    if (exists($env{'form.workcopy'}) && 
+        $self->{'type'} eq $env{'form.workcopy'}) {
         $self->load_tmp();
     } else {
         $self->load();
@@ -157,8 +160,8 @@ sub filename {
             $newfilename !~ /\w/ || $newfilename eq '') {
             my $key = 'course.'.$self->{'cid'}.'.spreadsheet_default_'.
                 $self->{'type'};
-            if (exists($ENV{$key}) && $ENV{$key} ne '') {
-                $newfilename = $ENV{$key};
+            if (exists($env{$key}) && $env{$key} ne '') {
+                $newfilename = $env{$key};
             } else {
                 $newfilename = 'default_'.$self->{'type'};
             }
@@ -256,10 +259,10 @@ sub initialize_spreadsheet_package {
 
 sub load_spreadsheet_expirationdates {
     undef %expiredates;
-    my $cid=$ENV{'request.course.id'};
+    my $cid=$env{'request.course.id'};
     my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
-                                    $ENV{'course.'.$cid.'.domain'},
-                                    $ENV{'course.'.$cid.'.num'});
+                                    $env{'course.'.$cid.'.domain'},
+                                    $env{'course.'.$cid.'.num'});
     if (lc($tmp[0]) !~ /^error/){
         %expiredates = @tmp;
     }
@@ -315,7 +318,7 @@ sub initialize_safe_space {
   my $self = shift;
   my $usection = &Apache::lonnet::getsection($self->{'domain'},
                                              $self->{'name'},
-                                             $ENV{'request.course.id'});
+                                             $env{'request.course.id'});
   if (! defined($safeeval)) {
       $safeeval = new Safe(shift);
       my $safehole = new Safe::Hole;
@@ -325,6 +328,7 @@ sub initialize_safe_space {
       $safeeval->deny(":base_io");
       $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&Apache::lonnet::EXT');
       $safehole->wrap(\&mask,$safeeval,'&mask');
+      $safehole->wrap(\&Apache::lonnet::logthis,$safeeval,'&logthis');
       $safeeval->share('$@');
       my $code=<<'ENDDEFS';
 # ---------------------------------------------------- Inside of the safe space
@@ -409,8 +413,8 @@ returns the number of items in the range
 
 #-------------------------------------------------------
 sub NUM {
-    my $mask=&mask(@_);
-    my $num= $#{@{grep(eval("/$mask/"),keys(%sheet_values))}}+1;
+    my $values=&get_values(@_);
+    my $num= scalar(@$values);
     return $num;   
 }
 
@@ -425,10 +429,10 @@ sub NUM {
 #-------------------------------------------------------
 sub BIN {
     my ($low,$high,$lower,$upper)=@_;
-    my $mask=&mask($lower,$upper);
+    my $values=&get_values($lower,$upper);
     my $num=0;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        if (($sheet_values{$_}>=$low) && ($sheet_values{$_}<=$high)) {
+    foreach (@$values) {
+        if (($_>=$low) && ($_<=$high)) {
             $num++;
         }
     }
@@ -447,10 +451,10 @@ returns the sum of items in the range.
 
 #-------------------------------------------------------
 sub SUM {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $sum=0;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        $sum+=$sheet_values{$_};
+    foreach (@$values) {
+        $sum+=$_;
     }
     return $sum;   
 }
@@ -467,11 +471,11 @@ compute the average of the items in the
 
 #-------------------------------------------------------
 sub MEAN {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $sum=0; 
     my $num=0;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        $sum+=$sheet_values{$_};
+    foreach (@$values) {
+        $sum+=$_;
         $num++;
     }
     if ($num) {
@@ -493,17 +497,17 @@ compute the standard deviation of the it
 
 #-------------------------------------------------------
 sub STDDEV {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $sum=0; my $num=0;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        $sum+=$sheet_values{$_};
+    foreach (@$values) {
+        $sum+=$_;
         $num++;
     }
     unless ($num>1) { return undef; }
     my $mean=$sum/$num;
     $sum=0;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        $sum+=($sheet_values{$_}-$mean)**2;
+    foreach (@$values) {
+        $sum+=($_-$mean)**2;
     }
     return sqrt($sum/($num-1));    
 }
@@ -520,10 +524,10 @@ compute the product of the items in the
 
 #-------------------------------------------------------
 sub PROD {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $prod=1;
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        $prod*=$sheet_values{$_};
+    foreach (@$values) {
+        $prod*=$_;
     }
     return $prod;   
 }
@@ -540,12 +544,11 @@ compute the maximum of the items in the
 
 #-------------------------------------------------------
 sub MAX {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $max='-';
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        unless ($max) { $max=$sheet_values{$_}; }
-        if (($sheet_values{$_}>$max) || ($max eq '-')) { 
-            $max=$sheet_values{$_}; 
+    foreach (@$values) {
+        if (($_>$max) || ($max eq '-')) { 
+            $max=$_; 
         }
     } 
     return $max;   
@@ -563,12 +566,11 @@ compute the minimum of the items in the
 
 #-------------------------------------------------------
 sub MIN {
-    my $mask=&mask(@_);
+    my $values=&get_values(@_);
     my $min='-';
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-        unless ($max) { $max=$sheet_values{$_}; }
-        if (($sheet_values{$_}<$min) || ($min eq '-')) { 
-            $min=$sheet_values{$_}; 
+    foreach (@$values) {
+        if (($_<$min) || ($min eq '-')) { 
+            $min=$_; 
         }
     }
     return $min;   
@@ -588,12 +590,8 @@ compute the sum of the largest 'num' ite
 #-------------------------------------------------------
 sub SUMMAX {
     my ($num,$lower,$upper)=@_;
-    my $mask=&mask($lower,$upper);
-    my @inside=();
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-	push (@inside,$sheet_values{$_});
-    }
-    @inside=sort(@inside);
+    my $values=&get_values($lower,$upper);
+    my @inside=sort {$a <=> $b} (@$values);
     my $sum=0; my $i;
     for ($i=$#inside;(($i>$#inside-$num) && ($i>=0));$i--) { 
         $sum+=$inside[$i];
@@ -615,12 +613,8 @@ compute the sum of the smallest 'num' it
 #-------------------------------------------------------
 sub SUMMIN {
     my ($num,$lower,$upper)=@_;
-    my $mask=&mask($lower,$upper);
-    my @inside=();
-    foreach (grep eval("/$mask/"),keys(%sheet_values)) {
-	$inside[$#inside+1]=$sheet_values{$_};
-    }
-    @inside=sort(@inside);
+    my $values=&get_values($lower,$upper);
+    my @inside=sort {$a <=> $b} (@$values);
     my $sum=0; my $i;
     for ($i=0;(($i<$num) && ($i<=$#inside));$i++) { 
         $sum+=$inside[$i];
@@ -676,6 +670,63 @@ sub MAXPARM {
     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 {
     %sheet_values = %t;
@@ -739,92 +790,6 @@ ENDDEFS
 
 ######################################################
 
-
-######################################################
-
-=pod
-
-=item  &mask($lower,$upper)
-
-Inputs: $lower and $upper, cell names ("X12" or "a150") or globs ("X*").
-
-Returns:  Regular expression matching spreadsheet cells that are within
-the rectangle defined by $lower and $upper.  Due to the nature of the
-regular expression this result must be used inside an eval().
-
-=cut
-
-######################################################
-{
-
-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-z]|\*)(\d+|\*)/);
-    my ($ua,$ud) = ($upper=~/([A-z]|\*)(\d+|\*)/);
-    #
-    my $alpha='';
-    my $num='';
-    #
-    # Do not put parenthases around $alpha.
-    # $num depends on the value in $1.
-    if (($la eq '*') || ($ua eq '*')) {
-        $alpha='[A-z]';
-    } else {
-        if ($la gt $ua) {
-            my $tmp = $ua;
-            $ua = $la;
-            $la = $ua;
-        }
-        $alpha=qq/[$la-$ua]/;
-    }
-    if ($ld ne '*' && $ud ne '*') {
-        # Make sure $ld <= $ud
-        if ($ld > $ud) {
-            my $tmp = $ud;
-            $ud = $ld;
-            $ld = $tmp;
-        }
-        # Here we make a regular expression using some advanced regexp
-        # abilities.
-        # (\d+) will match the digits of the cell name and dump them in
-        #     to $1
-        # (?(?{ ... code ...} pattern_if_true | pattern_if_false)) will
-        #     choose pattern_if_true if { ... code ... } is true and
-        #     pattern_if_false if { ... code ... } is false.
-        # In this case, pattern_if_true is empty.  pattern_if_false is 
-        #     'donotmatch' and will not match our cells because none of 
-        #     them end with donotmatch.  
-        # Unfortunately, the use of this type of regular expression 
-        #     requires that each match be wrapped in an eval().  Search for
-        #     $mask in this module for examples
-        $num = '(\d+)(?(?{$1>= '.$ld.' && $1<='.$ud.'})|donotmatch)';
-    } else {
-        $num = '(\d+)';
-    }
-    my $expression = '^'.$alpha.$num.'$';
-    $memoizer{$key} = $expression;
-    return $expression;
-}
-
-#
-# Debugging routine
-sub dump_memoized_values {
-    while (my ($key,$value) = each(%memoizer)) {
-        &Apache::lonnet::logthis('memoizer: '.$key.' = '.$value);
-    }
-    return;
-}
-
-}
-
 ##
 ## sub add_hash_to_safe {} # spreadsheet, would like to destroy
 ##
@@ -934,7 +899,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;
             }
@@ -1219,7 +1185,7 @@ sub display {
     my ($r) = @_;
     my $outputmode = 'html';
     foreach ($self->output_options()) {
-        if ($ENV{'form.output_format'} eq $_->{'value'}) {
+        if ($env{'form.output_format'} eq $_->{'value'}) {
             $outputmode = $_->{'value'};
             last;
         }
@@ -1263,7 +1229,7 @@ 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 $allowed = &Apache::lonnet::allowed('mgr',$env{'request.course.id'});
     my $row_html;
     my @rowdata = $self->get_row(0);
     foreach my $cell (@rowdata) {
@@ -1280,7 +1246,7 @@ sub html_export_row {
 
 sub html_template_row {
     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 $row_html;
     my @rowdata = $self->get_template_row();
@@ -1347,7 +1313,7 @@ sub html_uneditable_cell {
 sub html_row {
     my $self = shift();
     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 $num_cols_output = 0;
     my $row_html;
@@ -1371,7 +1337,7 @@ sub html_row {
 
 sub html_header {
     my $self = shift;
-    return '' if (! $ENV{'request.role.adv'});
+    return '' if (! $env{'request.role.adv'});
     return "<table>\n".
         '<tr><th align="center">'.&mt('Output Format').'</th></tr>'."\n".
         '<tr><td>'.$self->output_selector()."</td></tr>\n".
@@ -1396,10 +1362,10 @@ 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'})) {
-        $default = $ENV{'form.output_format'} 
+    if (exists($env{'form.output_format'})) {
+        $default = $env{'form.output_format'} 
     } else {
-        $ENV{'form.output_format'} = $default;
+        $env{'form.output_format'} = $default;
     }
     foreach  ($self->output_options()) {
         $output_selector.='<option value="'.$_->{'value'}.'"';
@@ -1430,31 +1396,6 @@ sub excel_output_row {
     return;
 }
 
-sub create_excel_spreadsheet {
-    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(&mt("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);
-}
-
 #
 # This routine is just a stub 
 sub outsheet_htmlclasslist {
@@ -1475,8 +1416,8 @@ sub outsheet_excel {
     #
     $r->print("<h2>".&mt('Preparing Excel Spreadsheet')."</h2>");
     #
-    # 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
@@ -1487,16 +1428,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($connection,$worksheet,$cols_output,$rows_output);
+    $self->excel_rows($connection,$worksheet,$cols_output,$rows_output,
+                      $format);
     #
     #
     # Close the excel file
@@ -1524,7 +1467,7 @@ sub outsheet_csv   {
     #
     # Open the csv file
     my $filename = '/prtspool/'.
-        $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+        $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
         time.'_'.rand(1000000000).'.csv';
     my $file;
     unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
@@ -1773,7 +1716,7 @@ sub save {
         my $reply = &Apache::lonnet::put($filename,\%f,$cdom,$cnum);
         return $reply if ($reply ne 'ok');
         $reply = &Apache::lonnet::put($stype.'_spreadsheets',
-                     {$filename => $ENV{'user.name'}.'@'.$ENV{'user.domain'}},
+                     {$filename => $env{'user.name'}.'@'.$env{'user.domain'}},
                                       $cdom,$cnum);
         return $reply if ($reply ne 'ok');
         if ($makedef) { 
@@ -1799,8 +1742,8 @@ sub save {
 
 sub save_tmp {
     my $self = shift;
-    my $filename=$ENV{'user.name'}.'_'.
-        $ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
+    my $filename=$env{'user.name'}.'_'.
+        $env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
            $self->{'filename'};
     $filename=~s/\W/\_/g;
     $filename=$Apache::lonnet::tmpdir.$filename.'.tmp';
@@ -1819,8 +1762,8 @@ sub save_tmp {
 
 sub load_tmp {
     my $self = shift;
-    my $filename=$ENV{'user.name'}.'_'.
-        $ENV{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
+    my $filename=$env{'user.name'}.'_'.
+        $env{'user.domain'}.'_spreadsheet_'.$self->{'symb'}.'_'.
             $self->{'filename'};
     $filename=~s/\W/\_/g;
     $filename=$Apache::lonnet::tmpdir.$filename.'.tmp';