--- loncom/interface/Attic/lonspreadsheet.pm 2002/10/25 19:47:14 1.129 +++ loncom/interface/Attic/lonspreadsheet.pm 2002/11/12 20:14:51 1.138 @@ -1,5 +1,5 @@ # -# $Id: lonspreadsheet.pm,v 1.129 2002/10/25 19:47:14 matthew Exp $ +# $Id: lonspreadsheet.pm,v 1.138 2002/11/12 20:14:51 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -62,6 +62,9 @@ use GDBM_File; use HTML::TokeParser; use Apache::lonhtmlcommon; use Apache::loncoursedata; +use Apache::File(); +use Spreadsheet::WriteExcel; + # # Caches for coursewide information # @@ -91,7 +94,7 @@ my %spreadsheets; my %courserdatas; my %userrdatas; my %defaultsheets; -my %updatedata; +my %rowlabel_cache; # # These global hashes are dependent on user, course and resource, @@ -122,6 +125,7 @@ my $tmpdir; ## sub mask { my ($lower,$upper)=@_; + $upper = $lower if (! defined($upper)); # my ($la,$ld) = ($lower=~/([A-Za-z]|\*)(\d+|\*)/); my ($ua,$ud) = ($upper=~/([A-Za-z]|\*)(\d+|\*)/); @@ -130,9 +134,8 @@ sub mask { my $num=''; # if (($la eq '*') || ($ua eq '*')) { - $alpha='[A-Za-z]'; + $alpha='[A-Za-z]'; } else { - if (($la=~/[A-Z]/) && ($ua=~/[A-Z]/) || ($la=~/[a-z]/) && ($ua=~/[a-z]/)) { $alpha='['.$la.'-'.$ua.']'; @@ -194,8 +197,6 @@ sub mask { return '^'.$alpha.$num."\$"; } - - sub initsheet { my $safeeval = new Safe(shift); my $safehole = new Safe::Hole; @@ -238,6 +239,7 @@ undef @os; # Holds the names of other s # the spreadsheets that are available for the assessment sheet. # Set by &setothersheets. &setothersheets is called by &handler. A # related subroutine is &othersheets. +#$errorlog = ''; $maxrow = 0; $sheettype = ''; @@ -591,7 +593,8 @@ compute the average of the items in the #------------------------------------------------------- sub MEAN { my $mask=mask(@_); - my $sum=0; my $num=0; + my $sum=0; + my $num=0; foreach (grep /$mask/,keys(%sheet_values)) { $sum+=$sheet_values{$_}; $num++; @@ -926,6 +929,7 @@ sub calc { while ($notfinished) { $notfinished=0; foreach (keys(%t)) { + #$errorlog .= "$_:".$t{$_}; my $old=$sheet_values{$_}; $sheet_values{$_}=eval $t{$_}; if ($@) { @@ -933,6 +937,7 @@ sub calc { return $_.': '.$@; } if ($sheet_values{$_} ne $old) { $notfinished=1; $lastcalc=$_; } + #$errorlog .= ":".$sheet_values{$_}."\n"; } $depth++; if ($depth>100) { @@ -950,54 +955,39 @@ ENDDEFS } # -# +# # sub templaterow { my $sheet = shift; my @cols=(); - $cols[0]='Template'; + my $rowlabel = 'Template'; foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M', 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z', 'a','b','c','d','e','f','g','h','i','j','k','l','m', 'n','o','p','q','r','s','t','u','v','w','x','y','z') { my $fm=$sheet->{'f'}->{'template_'.$_}; $fm=~s/[\'\"]/\&\#34;/g; - push(@cols,"'template_$_','$fm'".'___eq___'.$fm); + push(@cols,{ name => 'template_'.$_, + formula => $fm, + value => $fm }); } - return @cols; + return ($rowlabel,@cols); } - sub outrowassess { # $n is the current row number - my $sheet = shift; - my $n=shift; - my $csv = $ENV{'form.showcsv'}; + my ($sheet,$n) = @_; my @cols=(); + my $rowlabel=''; if ($n) { my ($usy,$ufn)=split(/__&&&\__/,$sheet->{'f'}->{'A'.$n}); - if ($sheet->{'rowlabel'}->{$usy}) { - $cols[0]=&format_rowlabel($sheet->{'rowlabel'}->{$usy}); - if (! $csv) { - $cols[0].='
'. - ''; + $rowlabel = ''; } } else { - $cols[0]='Export'; + $rowlabel = 'Export'; } foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M', 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z', @@ -1005,19 +995,25 @@ sub outrowassess { 'n','o','p','q','r','s','t','u','v','w','x','y','z') { my $fm=$sheet->{'f'}->{$_.$n}; $fm=~s/[\'\"]/\&\#34;/g; - push(@cols,"'$_$n','$fm'".'___eq___'.$sheet->{'values'}->{$_.$n}); + push(@cols,{ name => $_.$n, + formula => $fm, + value => $sheet->{'values'}->{$_.$n}}); } - return @cols; + return ($rowlabel,@cols); } sub outrow { - my $sheet=shift; - my $n=shift; + my ($sheet,$n)=@_; my @cols=(); + my $rowlabel; if ($n) { - $cols[0]=&format_rowlabel($sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$n}}); + $rowlabel = $sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$n}}; } else { - $cols[0]='Export'; + if ($sheet->{'sheettype'} eq 'classcalc') { + $rowlabel = 'Summary'; + } else { + $rowlabel = 'Export'; + } } foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M', 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z', @@ -1025,9 +1021,11 @@ sub outrow { 'n','o','p','q','r','s','t','u','v','w','x','y','z') { my $fm=$sheet->{'f'}->{$_.$n}; $fm=~s/[\'\"]/\&\#34;/g; - push(@cols,"'$_$n','$fm'".'___eq___'.$sheet->{'values'}->{$_.$n}); + push(@cols,{ name => $_.$n, + formula => $fm, + value => $sheet->{'values'}->{$_.$n}}); } - return @cols; + return ($rowlabel,@cols); } # ------------------------------------------------ Add or change formula values @@ -1077,11 +1075,17 @@ sub calcsheet { } # ---------------------------------------------------------------- Get formulas +# Return a copy of the formulas sub getformulas { my $sheet = shift; return %{$sheet->{'safe'}->varglob('f')}; } +sub geterrorlog { + my $sheet = shift; + return ${$sheet->{'safe'}->varglob('errorlog')}; +} + # ----------------------------------------------------- Get value of $f{'A'.$n} sub getfa { my $sheet = shift; @@ -1095,189 +1099,508 @@ sub exportdata { my @exportarray=(); foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M', 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') { - push(@exportarray,$sheet->{'values'}->{$_.'0'}); + if (exists($sheet->{'values'}->{$_.'0'})) { + push(@exportarray,$sheet->{'values'}->{$_.'0'}); + } else { + push(@exportarray,''); + } } return @exportarray; } + + +sub update_student_sheet{ + my $sheet = shift; + # Load in the studentcalc sheet + &readsheet($sheet,'default_studentcalc'); + # Determine the structure (contained assessments, etc) of the sheet + &updatesheet($sheet); + # Load in the cached sheets for this student + &cachedssheets($sheet); + # Load in the (possibly cached) data from the assessment sheets + &loadstudent($sheet); + # Compute the sheet + &calcsheet($sheet); +} + # ========================================================== End of Spreadsheet # ============================================================================= - # -# Procedures for screen output +# Procedures for spreadsheet output # # --------------------------------------------- Produce output row n from sheet -sub rown { - my ($sheet,$n)=@_; - my $defaultbg; - my $rowdata=''; - my $dataflag=0; - unless ($n eq '-') { - $defaultbg=((($n-1)/5)==int(($n-1)/5))?'#E0E0':'#FFFF'; - } else { - $defaultbg='#E0FF'; - } - unless ($ENV{'form.showcsv'}) { - $rowdata.="\n$n"; - } else { - $rowdata.="\n".'"'.$n.'"'; - } - my $showf=0; - # - # Determine how many pink (uneditable) cells there are in this sheet. - my $maxred=1; - my $sheettype=$sheet->{'sheettype'}; - if ($sheettype eq 'studentcalc') { - $maxred=26; - } elsif ($sheettype eq 'assesscalc') { - $maxred=1; - } else { - $maxred=26; - } - $maxred=1 if (&getfa($sheet,$n)=~/^[\~\-]/); - # - # Get the proper row - my @rowdata; +sub get_row { + my ($sheet,$n) = @_; + my ($rowlabel,@rowdata); if ($n eq '-') { - @rowdata = &templaterow($sheet); - $n=-1; - $dataflag=1; - } elsif ($sheettype eq 'studentcalc') { - @rowdata = &outrowassess($sheet,$n); - } else { - @rowdata = &outrow($sheet,$n); - } - # - foreach (@rowdata) { - my $bgcolor=$defaultbg.((($showf-1)/5==int(($showf-1)/5))?'99':'DD'); - my ($fm,$vl)=split(/\_\_\_eq\_\_\_/,$_); - if ((($vl ne '') || ($vl eq '0')) && - (($showf==1) || ($sheettype ne 'studentcalc'))) { $dataflag=1; } - if ($showf==0) { $vl=$_; } - unless ($ENV{'form.showcsv'}) { - if ($showf<=$maxred) { $bgcolor='#FFDDDD'; } - if (($n==0) && ($showf<=26)) { $bgcolor='#CCCCFF'; } - if (($showf>$maxred) || ((!$n) && ($showf>0))) { - if ($vl eq '') { - $vl='#'; - } - $rowdata.=''; - if ($ENV{'request.role'} =~ /^st\./) { - $rowdata.=$vl; - } else { - $rowdata.=''. - $vl.''; - } - $rowdata.=''; - } else { - $rowdata.=' '.$vl.' '; - } - } else { - $rowdata.=',"'.$vl.'"'; - } - $showf++; - } # End of foreach($safeval...) - if ($ENV{'form.showall'} || ($dataflag)) { - return $rowdata.($ENV{'form.showcsv'}?'':''); + ($rowlabel,@rowdata) = &templaterow($sheet); + } elsif ($sheet->{'sheettype'} eq 'studentcalc') { + ($rowlabel,@rowdata) = &outrowassess($sheet,$n); } else { - return ''; + ($rowlabel,@rowdata) = &outrow($sheet,$n); } + return ($rowlabel,@rowdata); } -# ------------------------------------------------------------- Print out sheet - -sub outsheet { - my ($r,$sheet)=@_; - my $maxred = 26; # The maximum number of cells to show as - # red (uneditable) - # To make student sheets uneditable could we - # set $maxred = 52? - # - my $realm='Course'; # 'assessment', 'user', or 'course' sheet - if ($sheet->{'sheettype'} eq 'assesscalc') { - $maxred=1; - $realm='Assessment'; - } elsif ($sheet->{'sheettype'} eq 'studentcalc') { - $maxred=26; - $realm='User'; - } - # - # Column label - my $tabledata; - if ($ENV{'form.showcsv'}) { - $tabledata='
';
-    } else { 
-        $tabledata=''.
-                  ''.
-                  '';
-        my $showf=0;
-        foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
-                 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z',
-                 'a','b','c','d','e','f','g','h','i','j','k','l','m',
-                 'n','o','p','q','r','s','t','u','v','w','x','y','z') {
-            $showf++;
-            if ($showf<=$maxred) { 
-                $tabledata.='";
-        }
-        $tabledata.=''.&rown($sheet,'-').
-            &rown($sheet,0);
-    }
-    $r->print($tabledata);
-    #
-    # Prepare to output rows
-    my $row;
+########################################################################
+########################################################################
+sub sort_indicies {
+    my $sheet = shift;
     #
     # Sort the rows in some manner
     #
     my @sortby=();
     my @sortidx=();
-    for ($row=1;$row<=$sheet->{'maxrow'};$row++) {
+    for (my $row=1;$row<=$sheet->{'maxrow'};$row++) {
         push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}'));
-        push (@sortidx, $row-1);
+        push (@sortidx, $row);
     }
     @sortidx=sort { lc($sortby[$a]) cmp lc($sortby[$b]); } @sortidx;
-    #
-    # Determine the type of child spreadsheets
-    my $what='Student';
+    return @sortidx;
+}
+
+#############################################################
+###                                                       ###
+###              Spreadsheet Output Routines              ###
+###                                                       ###
+#############################################################
+
+############################################
+##         HTML output routines           ##
+############################################
+sub html_editable_cell {
+    my ($cell,$bgcolor) = @_;
+    my $result;
+    my ($name,$formula,$value);
+    if (defined($cell)) {
+        $name    = $cell->{'name'};
+        $formula = $cell->{'formula'};
+        $value   = $cell->{'value'};
+    }
+    $name    = '' if (! defined($name));
+    $formula = '' if (! defined($formula));
+    if (! defined($value)) {
+        $value = '#';
+        if ($formula ne '') {
+            $value = 'undefined value';
+        }
+    }
+    if ($value =~ /^\s*$/ ) {
+        $value = '#';
+    }
+    $formula =~ s/\n/\\n/gs;
+    $result .= ''.$value.'';
+    return $result;
+}
+
+sub html_uneditable_cell {
+    my ($cell,$bgcolor) = @_;
+    my $value = (defined($cell) ? $cell->{'value'} : '');
+    return ' '.$value.' ';
+}
+
+sub outsheet_html  {
+    my ($sheet,$r) = @_;
+    my ($num_uneditable,$realm,$row_type);
     if ($sheet->{'sheettype'} eq 'assesscalc') {
-        $what='Item';
+        $num_uneditable = 1;
+        $realm = 'Assessment';
+        $row_type = 'Item';
     } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
-        $what='Assessment';
+        $num_uneditable = 26;
+        $realm = 'User';
+        $row_type = 'Assessment';
+    } elsif ($sheet->{'sheettype'} eq 'classcalc') {
+        $num_uneditable = 26;
+        $realm = 'Course';
+        $row_type = 'Student';
+    } else {
+        return;  # error
+    }
+    ####################################
+    # Print out header table
+    ####################################
+    my $num_left = 52-$num_uneditable;
+    my $tabledata =<<"END";
+
'. - ''.$realm.'ImportCalculations
'; - } else { - $tabledata.=''; - } - $tabledata.="$_
+ + + + + +END + my $label_num = 0; + foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){ + if ($label_num<$num_uneditable) { + $tabledata.='"; + $label_num++; } + $tabledata.="\n"; + $r->print($tabledata); + #################################### + # Print out template row + #################################### + my ($rowlabel,@rowdata) = &get_row($sheet,'-'); + my $row_html = ''; + my $num_cols_output = 0; + foreach my $cell (@rowdata) { + if ($num_cols_output++ < $num_uneditable) { + $row_html .= ''; + } + $row_html.= "\n"; + $r->print($row_html); + #################################### + # Print out summary/export row + #################################### + my ($rowlabel,@rowdata) = &get_row($sheet,'0'); + my $rowcount = 0; + $row_html = ''; + $num_cols_output = 0; + foreach my $cell (@rowdata) { + if ($num_cols_output++ < 26) { + $row_html .= ''; + } + $row_html.= "\n"; + $r->print($row_html); + $r->print('
$realm + Import + Calculations
'; + } else { + $tabledata.=''; + } + $tabledata.="$_
'.&format_html_rowlabel($rowlabel).''; + $row_html .= &html_uneditable_cell($cell,'#FFDDDD'); + } else { + $row_html .= ''; + $row_html .= &html_editable_cell($cell,'#E0FFDD'); + } + $row_html .= '
'.&format_html_rowlabel($rowlabel).''; + $row_html .= &html_editable_cell($cell,'#CCCCFF'); + } else { + $row_html .= ''; + $row_html .= &html_uneditable_cell(undef,'#CCCCFF'); + } + $row_html .= '
'); + #################################### + # Prepare to output rows + #################################### + my @Rows = &sort_indicies($sheet); # # Loop through the rows and output them one at a time - my $n=0; - for ($row=0;$row<$sheet->{'maxrow'};$row++) { - my $thisrow=&rown($sheet,$sortidx[$row]+1); - if ($thisrow) { - if (($n/25==int($n/25)) && (!$ENV{'form.showcsv'})) { + my $rows_output=0; + foreach my $rownum (@Rows) { + my ($rowlabel,@rowdata) = &get_row($sheet,$rownum); + next if ($rowlabel =~ /^\s*$/); + # + my $defaultbg='#E0FF'; + # + my $row_html ="\n".''.$rownum. + ''; + # + if ($sheet->{'sheettype'} eq 'classcalc') { + $row_html.=''.&format_html_rowlabel($rowlabel).''; + # Output links for each student? + # Nope, that is already done for us in format_html_rowlabel (for now) + } elsif ($sheet->{'sheettype'} eq 'studentcalc') { + $row_html.=''.&format_html_rowlabel($rowlabel); + $row_html.= '
'. + ''; + } elsif ($sheet->{'sheettype'} eq 'assesscalc') { + $row_html.=''.&format_html_rowlabel($rowlabel).''; + } + # + my $shown_cells = 0; + foreach my $cell (@rowdata) { + my $value = $cell->{'value'}; + my $formula = $cell->{'formula'}; + my $cellname = $cell->{'name'}; + # + my $bgcolor; + if ($shown_cells && ($shown_cells/5 == int($shown_cells/5))) { + $bgcolor = $defaultbg.'99'; + } else { + $bgcolor = $defaultbg.'DD'; + } + $bgcolor='#FFDDDD' if ($shown_cells < $num_uneditable); + # + $row_html.=''; + if ($shown_cells < $num_uneditable) { + $row_html .= &html_uneditable_cell($cell,$bgcolor); + } else { + $row_html .= &html_editable_cell($cell,$bgcolor); + } + $row_html.=''; + $shown_cells++; + } + if ($row_html) { + if ($rows_output % 25 == 0) { $r->print("\n
\n"); $r->rflush(); - $r->print(''); - $r->print('
 '.$what.''. + $r->print(''. + ''. + '\n"); } - $n++; - $r->print($thisrow); + $rows_output++; + $r->print($row_html); } } - $r->print($ENV{'form.showcsv'}?'':'
 '.$row_type.''. join('', (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZ'. 'abcdefghijklmnopqrstuvwxyz'))). "
'); + # + $r->print('
'); + # + # Debugging code (be sure to uncomment errorlog code in safe space): + # + # $r->print("\n
");
+    # $r->print(&geterrorlog($sheet));
+    # $r->print("\n
"); + return 1; } -# -# ----------------------------------------------- Read list of available sheets -# +############################################ +## csv output routines ## +############################################ +sub outsheet_csv { + my ($sheet,$r) = @_; + my $csvdata = ''; + my @Values; + #################################### + # Prepare to output rows + #################################### + my @Rows = &sort_indicies($sheet); + # + # Loop through the rows and output them one at a time + my $rows_output=0; + foreach my $rownum (@Rows) { + my ($rowlabel,@rowdata) = &get_row($sheet,$rownum); + next if ($rowlabel =~ /^\s*$/); + push (@Values,&format_csv_rowlabel($rowlabel)); + foreach my $cell (@rowdata) { + push (@Values,'"'.$cell->{'value'}.'"'); + } + $csvdata.= join(',',@Values)."\n"; + @Values = (); + } + # + # Write the CSV data to a file and serve up a link + # + 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("
\n".$csvdata."
\n"); + return 0; + } + print $file $csvdata; + close($file); + $r->print('

'. + 'Your CSV spreadsheet.'."\n"); + # + return 1; +} + +############################################ +## Excel output routines ## +############################################ +sub outsheet_recursive_excel { + my ($sheet,$r) = @_; + my $c = $r->connection; + return undef if ($sheet->{'sheettype'} ne 'classcalc'); + my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r); + return undef if (! defined($workbook)); + # + # Create main worksheet + my $main_worksheet = $workbook->addworksheet('main'); + # + # Figure out who the students are + my %f=&getformulas($sheet); + my $count = 0; + $r->print(< +Compiling Excel Workbook with a worksheet for each student. +

+This operation may take longer than a complete recalculation of the +spreadsheet. +

+To abort this operation, hit the stop button on your browser. +

+A link to the spreadsheet will be available at the end of this process. +

+

+END + $r->rflush(); + my $starttime = time; + foreach (keys(%f)) { + next if ($_!~/^A(\d+)/ || $1 == 0 || ($f{$_}=~/^[!~-]/)); + $count++; + my ($sname,$sdom) = split(':',$f{$_}); + my $student_excel_worksheet=$workbook->addworksheet($sname.'@'.$sdom); + # Create a new spreadsheet + my $studentsheet = &makenewsheet($sname,$sdom,'studentcalc',undef); + # Read in the spreadsheet definition + &update_student_sheet($studentsheet); + # Stuff the sheet into excel + &export_sheet_as_excel($studentsheet,$student_excel_worksheet); + my $totaltime = int((time - $starttime) / $count * $sheet->{'maxrow'}); + my $timeleft = int((time - $starttime) / $count * ($sheet->{'maxrow'} - $count)); + if ($count % 5 == 0) { + $r->print($count.' students completed.'. + ' Time remaining: '.$timeleft.' sec. '. + ' Estimated total time: '.$totaltime." sec
\n"); + $r->rflush(); + } + if(defined($c) && ($c->aborted())) { + last; + } + } + # + if(! $c->aborted() ) { + $r->print('All students spreadsheets completed!
'); + $r->rflush(); + # + # &export_sheet_as_excel fills $worksheet with the data from $sheet + &export_sheet_as_excel($sheet,$main_worksheet); + # + $workbook->close(); + # Okay, the spreadsheet is taken care of, so give the user a link. + $r->print('

'. + 'Your Excel spreadsheet.'."\n"); + } else { + $workbook->close(); # Not sure how necessary this is. + #unlink('/home/httpd'.$filename); # No need to keep this around? + } + return 1; +} + +sub outsheet_excel { + my ($sheet,$r) = @_; + my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r); + return undef if (! defined($workbook)); + my $sheetname; + if ($sheet->{'sheettype'} eq 'classcalc') { + $sheetname = 'Main'; + } elsif ($sheet->{'sheettype'} eq 'studentcalc') { + $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'}; + } elsif ($sheet->{'sheettype'} eq 'assesscalc') { + $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'}.' assessment'; + } + my $worksheet = $workbook->addworksheet($sheetname); + # + # &export_sheet_as_excel fills $worksheet with the data from $sheet + &export_sheet_as_excel($sheet,$worksheet); + # + $workbook->close(); + # Okay, the spreadsheet is taken care of, so give the user a link. + $r->print('

'. + 'Your Excel spreadsheet.'."\n"); + return 1; +} + +sub create_excel_spreadsheet { + my ($sheet,$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 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); +} + +sub export_sheet_as_excel { + my $sheet = shift; + my $worksheet = shift; + #################################### + # Prepare to output rows + #################################### + my @Rows = &sort_indicies($sheet); + # + # Loop through the rows and output them one at a time + my $rows_output=0; + foreach my $rownum (@Rows) { + my ($rowlabel,@rowdata) = &get_row($sheet,$rownum); + next if ($rowlabel =~ /^\s*$/); + my $cols_output = 0; + my $label = &format_excel_rowlabel($rowlabel); + $worksheet->write($rows_output,$cols_output++,$label); + if (ref($label)) { + $cols_output = (scalar(@$label)); + } + foreach my $cell (@rowdata) { + $worksheet->write($rows_output,$cols_output++, + $cell->{'value'}); + } + $rows_output++; + } + return; +} + +############################################ +## XML output routines ## +############################################ +sub outsheet_xml { + my ($sheet,$r) = @_; + ## Someday XML + ## Will be rendered for the user + ## But not on this day +} + +## +## Outsheet - calls other outsheet_* functions +## +sub outsheet { + my ($r,$sheet)=@_; + if (! exists($ENV{'form.output'})) { + $ENV{'form.output'} = 'HTML'; + } + if (lc($ENV{'form.output'}) eq 'csv') { + &outsheet_csv($sheet,$r); + } elsif (lc($ENV{'form.output'}) eq 'excel') { + &outsheet_excel($sheet,$r); + } elsif (lc($ENV{'form.output'}) eq 'recursive excel') { + &outsheet_recursive_excel($sheet,$r); +# } elsif (lc($ENV{'form.output'}) eq 'xml' ) { +# &outsheet_xml($sheet,$r); + } else { + &outsheet_html($sheet,$r); + } +} + +######################################################################## +######################################################################## sub othersheets { my ($sheet,$stype)=@_; $stype = $sheet->{'sheettype'} if (! defined($stype)); @@ -1295,7 +1618,6 @@ sub othersheets { return @alternatives; } - # # -------------------------------------- Parse a spreadsheet # @@ -1414,6 +1736,8 @@ sub makenewsheet { $sheet->{'cnum'} = $ENV{'course.'.$ENV{'request.course.id'}.'.num'}; $sheet->{'cdom'} = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; $sheet->{'chome'} = $ENV{'course.'.$ENV{'request.course.id'}.'.home'}; + $sheet->{'coursedesc'} = $ENV{'course.'.$ENV{'request.course.id'}. + 'description'}; $sheet->{'uhome'} = &Apache::lonnet::homeserver($uname,$udom); # # @@ -1450,31 +1774,19 @@ sub writesheet { # Cache new sheet $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f); # Write sheet - my $sheetdata=''; foreach (keys(%f)) { - unless ($f{$_} eq 'import') { - $sheetdata.=&Apache::lonnet::escape($_).'='. - &Apache::lonnet::escape($f{$_}).'&'; - } + delete($f{$_}) if ($f{$_} eq 'import'); } - $sheetdata=~s/\&$//; - my $reply=&Apache::lonnet::reply('put:'.$cdom.':'.$cnum.':'.$fn.':'. - $sheetdata,$chome); + my $reply = &Apache::lonnet::put($fn,\%f,$cdom,$cnum); if ($reply eq 'ok') { - $reply=&Apache::lonnet::reply('put:'.$cdom.':'.$cnum.':'. - $stype.'_spreadsheets:'. - &Apache::lonnet::escape($fn). - '='.$ENV{'user.name'}.'@'. - $ENV{'user.domain'}, - $chome); + $reply = &Apache::lonnet::put($stype.'_spreadsheets', + {$fn => $ENV{'user.name'}.'@'.$ENV{'user.domain'}}, + $cdom,$cnum); if ($reply eq 'ok') { if ($makedef) { - return &Apache::lonnet::reply('put:'.$cdom.':'.$cnum. - ':environment:'. - 'spreadsheet_default_'. - $stype.'='. - &Apache::lonnet::escape($fn), - $chome); + return &Apache::lonnet::put('environment', + {'spreadsheet_default_'.$stype => $fn }, + $cdom,$cnum); } return $reply; } @@ -1621,36 +1933,74 @@ sub parmval { return &Apache::lonnet::metadata($fn,$rwhat.'.default'); } -sub format_rowlabel { + +################################################################## +## Row label formatting routines ## +################################################################## +sub format_html_rowlabel { my $rowlabel = shift; + return '' if ($rowlabel eq ''); my ($type,$labeldata) = split(':',$rowlabel,2); my $result = ''; if ($type eq 'symb') { my ($symb,$uname,$udom,$title) = split(':',$labeldata); $symb = &Apache::lonnet::unescape($symb); - if ($ENV{'form.showcsv'}) { - $result = $title; - } else { - $result = ''.$title.''; - } + $result = ''.$title.''; } elsif ($type eq 'student') { my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata); - if ($ENV{'form.showcsv'}) { - $result = '"'. - join('","',($sname,$sdom,$fullname,$section,$id).'"'); - } else { - $result =''; - $result.=$section.' '.$id." ".$fullname.''; - } + $result =''; + $result.=$section.' '.$id." ".$fullname.''; } elsif ($type eq 'parameter') { - if ($ENV{'form.showcsv'}) { - $labeldata =~ s/
/ /g; - } $result = $labeldata; } else { - &Apache::lonnet::logthis("lonspreadsheet:bogus rowlabel type: $type"); + $result = ''.$rowlabel.''; + } + return $result; +} + +sub format_csv_rowlabel { + my $rowlabel = shift; + return '' if ($rowlabel eq ''); + my ($type,$labeldata) = split(':',$rowlabel,2); + my $result = ''; + if ($type eq 'symb') { + my ($symb,$uname,$udom,$title) = split(':',$labeldata); + $symb = &Apache::lonnet::unescape($symb); + $result = $title; + } elsif ($type eq 'student') { + my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata); + $result = join('","',($sname,$sdom,$fullname,$section,$id)); + } elsif ($type eq 'parameter') { + $labeldata =~ s/
/ /g; + $result = $labeldata; + } else { + $result = $rowlabel; + } + return '"'.$result.'"'; +} + +sub format_excel_rowlabel { + my $rowlabel = shift; + return '' if ($rowlabel eq ''); + my ($type,$labeldata) = split(':',$rowlabel,2); + my $result = ''; + if ($type eq 'symb') { + my ($symb,$uname,$udom,$title) = split(':',$labeldata); + $symb = &Apache::lonnet::unescape($symb); + $result = $title; + } elsif ($type eq 'student') { + my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata); + $section = '' if (! defined($section)); + $id = '' if (! defined($id)); + my @Data = ($sname,$sdom,$fullname,$section,$id); + $result = \@Data; + } elsif ($type eq 'parameter') { + $labeldata =~ s/
/ /g; + $result = $labeldata; + } else { + $result = $rowlabel; } return $result; } @@ -1664,7 +2014,6 @@ sub updateclasssheet { my $chome =$sheet->{'chome'}; # %Section = (); - # # Read class list and row labels my $classlist = &Apache::loncoursedata::get_classlist(); @@ -1723,29 +2072,80 @@ sub updateclasssheet { } # ----------------------------------- Update rows for student and assess sheets -sub updatestudentassesssheet { +sub get_student_rowlabels { my ($sheet) = @_; # - my %bighash; + my %course_db; # my $stype = $sheet->{'sheettype'}; my $uname = $sheet->{'uname'}; my $udom = $sheet->{'udom'}; + # $sheet->{'rowlabel'} = {}; - my $identifier =$sheet->{'coursefilename'}.'_'.$stype.'_'.$uname.'_'.$udom; - if ($updatedata{$identifier}) { - %{$sheet->{'rowlabel'}}=split(/___;___/,$updatedata{$identifier}); + # + my $identifier =$sheet->{'coursefilename'}.'_'.$stype; + if ($rowlabel_cache{$identifier}) { + %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier}); } else { + # Get the data and store it in the cache # Tie hash - tie(%bighash,'GDBM_File',$sheet->{'coursefilename'}.'.db', + tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db', &GDBM_READER(),0640); - if (! tied(%bighash)) { + if (! tied(%course_db)) { + return 'Could not access course data'; + } + # + my %assesslist; + foreach ('Feedback','Evaluation','Tutoring','Discussion') { + my $symb = '_'.lc($_); + $assesslist{$symb} = join(':',('symb',$symb,$uname,$udom,$_)); + } + # + while (my ($key,$srcf) = each(%course_db)) { + next if ($key !~ /^src_(\d+)\.(\d+)$/); + my $mapid = $1; + my $resid = $2; + my $id = $mapid.'.'.$resid; + if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) { + my $symb= + &Apache::lonnet::declutter($course_db{'map_id_'.$mapid}). + '___'.$resid.'___'.&Apache::lonnet::declutter($srcf); + $assesslist{$symb}='symb:'.&Apache::lonnet::escape($symb).':' + .$uname.':'.$udom.':'.$course_db{'title_'.$id}; + } + } + untie(%course_db); + # Store away the data + $sheet->{'rowlabel'} = \%assesslist; + $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}}); + } + +} + +sub get_assess_rowlabels { + my ($sheet) = @_; + # + my %course_db; + # + my $stype = $sheet->{'sheettype'}; + my $uname = $sheet->{'uname'}; + my $udom = $sheet->{'udom'}; + my $usymb = $sheet->{'usymb'}; + # + $sheet->{'rowlabel'} = {}; + my $identifier =$sheet->{'coursefilename'}.'_'.$stype.'_'.$usymb; + # + if ($rowlabel_cache{$identifier}) { + %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier}); + } else { + # Get the data and store it in the cache + # Tie hash + tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db', + &GDBM_READER(),0640); + if (! tied(%course_db)) { return 'Could not access course data'; } - # Get all assessments # - # parameter_labels is used in the assessment sheets to provide labels - # for the parameters. my %parameter_labels= ('timestamp' => 'parameter:Timestamp of Last Transaction
timestamp', @@ -1755,29 +2155,16 @@ sub updatestudentassesssheet { 'parameter:Number of Tutor Responses
tutornumber', 'totalpoints' => 'parameter:Total Points Granted
totalpoints'); - # - # assesslist holds the descriptions of all assessments - my %assesslist; - foreach ('Feedback','Evaluation','Tutoring','Discussion') { - my $symb = '_'.lc($_); - $assesslist{$symb} = join(':',('symb',$symb,$uname,$udom,$_)); - } - while (($_,undef) = each(%bighash)) { - next if ($_!~/^src\_(\d+)\.(\d+)$/); - my $mapid=$1; - my $resid=$2; - my $id=$mapid.'.'.$resid; - my $srcf=$bighash{$_}; + while (my ($key,$srcf) = each(%course_db)) { + next if ($key !~ /^src_(\d+)\.(\d+)$/); + my $mapid = $1; + my $resid = $2; + my $id = $mapid.'.'.$resid; if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) { - my $symb= - &Apache::lonnet::declutter($bighash{'map_id_'.$mapid}). - '___'.$resid.'___'.&Apache::lonnet::declutter($srcf); - $assesslist{$symb}='symb:'.&Apache::lonnet::escape($symb).':' - .$uname.':'.$udom.':'.$bighash{'title_'.$id}; - next if ($stype ne 'assesscalc'); - foreach my $key (split(/\,/, - &Apache::lonnet::metadata($srcf,'keys') - )) { + # Loop through the metadata for this key + my @Metadata = split(/,/, + &Apache::lonnet::metadata($srcf,'keys')); + foreach my $key (@Metadata) { next if ($key !~ /^(stores|parameter)_/); my $display= &Apache::lonnet::metadata($srcf,$key.'.display'); @@ -1789,46 +2176,43 @@ sub updatestudentassesssheet { $parameter_labels{$key}='parameter:'.$display; } # end of foreach } - } # end of foreach (keys(%bighash)) - untie(%bighash); - # - # %parameter_labels has a list of storage and parameter displays by - # unikey - # %assesslist has a list of all resource, by symb - # - if ($stype eq 'assesscalc') { - $sheet->{'rowlabel'} = \%parameter_labels; - } elsif ($stype eq 'studentcalc') { - $sheet->{'rowlabel'} = \%assesslist; - } - $updatedata{$sheet->{'coursefilename'}.'_'.$stype.'_' - .$uname.'_'.$udom}= - join('___;___',%{$sheet->{'rowlabel'}}); - # Get current from cache + } + untie(%course_db); + # Store away the results + $sheet->{'rowlabel'} = \%parameter_labels; + $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}}); } - # Find discrepancies between the course row table and this - # + +} + +sub updatestudentassesssheet { + my $sheet = shift; + if ($sheet->{'sheettype'} eq 'studentcalc') { + &get_student_rowlabels($sheet); + } else { + &get_assess_rowlabels($sheet); + } + # Determine if any of the information has changed my %f=&getformulas($sheet); my $changed=0; $sheet->{'maxrow'} = 0; my %existing=(); # Now obsolete rows - foreach (keys(%f)) { - next if ($_!~/^A(\d+)/); - if ($1 > $sheet->{'maxrow'}) { - $sheet->{'maxrow'} = $1; - } - my ($usy,$ufn)=split(/__&&&\__/,$f{$_}); + while (my ($cell, $formula) = each (%f)) { + next if ($cell !~ /^A(\d+)/); + $sheet->{'maxrow'} = $1 if ($1 > $sheet->{'maxrow'}); + my ($usy,$ufn)=split(/__&&&\__/,$formula); $existing{$usy}=1; unless ((exists($sheet->{'rowlabel'}->{$usy}) && (defined($sheet->{'rowlabel'}->{$usy})) || (!$1) || - ($f{$_}=~/^(~~~|---)/))){ + ($formula =~ /^(~~~|---)/) )) { $f{$_}='!!! Obsolete'; $changed=1; } elsif ($ufn) { + # I do not think this works any more $sheet->{'rowlabel'}->{$usy} - =~s/assesscalc\?usymb\=/assesscalc\?ufn\=$ufn\&usymb\=/; + =~s/assesscalc\?usymb\=/assesscalc\?ufn\=$ufn&\usymb\=/; } } # New and unknown keys @@ -1843,13 +2227,11 @@ sub updatestudentassesssheet { $sheet->{'f'} = \%f; &setformulas($sheet); } - # - undef %existing; } # ------------------------------------------------ Load data for one assessment -sub loadstudent { +sub loadstudent{ my ($sheet)=@_; my %c=(); my %f=&getformulas($sheet); @@ -1865,18 +2247,18 @@ sub loadstudent { undef @tmp; # my @assessdata=(); - foreach (keys(%f)) { - next if ($_!~/^A(\d+)/); + while (my ($cell,$value) = each (%f)) { + next if ($cell !~ /^A(\d+)/); my $row=$1; - next if (($f{$_}=~/^[\!\~\-]/) || ($row==0)); - my ($usy,$ufn)=split(/__&&&\__/,$f{$_}); + next if (($value =~ /^[!~-]/) || ($row==0)); + my ($usy,$ufn)=split(/__&&&\__/,$value); @assessdata=&exportsheet($sheet,$sheet->{'uname'}, $sheet->{'udom'}, 'assesscalc',$usy,$ufn); my $index=0; foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M', 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') { - if ($assessdata[$index]) { + if (defined($assessdata[$index])) { my $col=$_; if ($assessdata[$index]=~/\D/) { $c{$col.$row}="'".$assessdata[$index]."'"; @@ -1901,8 +2283,10 @@ sub loadstudent { # sub loadcourse { my ($sheet,$r)=@_; + # my %c=(); my %f=&getformulas($sheet); + # my $total=0; foreach (keys(%f)) { if ($_=~/^A(\d+)/) { @@ -1927,8 +2311,8 @@ ENDPOP next if ($_!~/^A(\d+)/); my $row=$1; next if (($f{$_}=~/^[\!\~\-]/) || ($row==0)); - my @studentdata=&exportsheet($sheet,split(/\:/,$f{$_}), - 'studentcalc'); + my ($sname,$sdom) = split(':',$f{$_}); + my @studentdata=&exportsheet($sheet,$sname,$sdom,'studentcalc'); undef %userrdatas; $now++; $r->print('