--- loncom/interface/Attic/lonspreadsheet.pm 2002/11/06 20:00:13 1.134 +++ loncom/interface/Attic/lonspreadsheet.pm 2002/11/19 22:36:09 1.143 @@ -1,5 +1,5 @@ # -# $Id: lonspreadsheet.pm,v 1.134 2002/11/06 20:00:13 matthew Exp $ +# $Id: lonspreadsheet.pm,v 1.143 2002/11/19 22:36:09 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -53,17 +53,18 @@ built-in functions. package Apache::lonspreadsheet; use strict; +use Apache::Constants qw(:common :http); +use Apache::lonnet; +use Apache::lonhtmlcommon; +use Apache::loncoursedata; +use Apache::File(); use Safe; use Safe::Hole; use Opcode; -use Apache::lonnet; -use Apache::Constants qw(:common :http); use GDBM_File; use HTML::TokeParser; -use Apache::lonhtmlcommon; -use Apache::loncoursedata; -use Apache::File(); use Spreadsheet::WriteExcel; + # # Caches for coursewide information # @@ -93,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, @@ -1085,6 +1086,44 @@ sub geterrorlog { return ${$sheet->{'safe'}->varglob('errorlog')}; } +sub gettitle { + my $sheet = shift; + if ($sheet->{'sheettype'} eq 'classcalc') { + return $sheet->{'coursedesc'}; + } elsif ($sheet->{'sheettype'} eq 'studentcalc') { + return 'Grades for '.$sheet->{'uname'}.'@'.$sheet->{'udom'}; + } elsif ($sheet->{'sheettype'} eq 'assesscalc') { + if (($sheet->{'usymb'} eq '_feedback') || + ($sheet->{'usymb'} eq '_evaluation') || + ($sheet->{'usymb'} eq '_discussion') || + ($sheet->{'usymb'} eq '_tutoring')) { + my $title = $sheet->{'usymb'}; + $title =~ s/^_//; + $title = ucfirst($title); + return $title; + } + return if (! defined($sheet->{'mapid'}) || + $sheet->{'mapid'} !~ /^\d+$/); + my $mapid = $sheet->{'mapid'}; + return if (! defined($sheet->{'resid'}) || + $sheet->{'resid'} !~ /^\d+$/); + my $resid = $sheet->{'resid'}; + my %course_db; + tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db', + &GDBM_READER(),0640); + return if (! tied(%course_db)); + my $key = 'title_'.$mapid.'.'.$resid; + my $title = ''; + if (exists($course_db{$key})) { + $title = $course_db{$key}; + } else { + $title = $sheet->{'usymb'}; + } + untie (%course_db); + return $title; + } +} + # ----------------------------------------------------- Get value of $f{'A'.$n} sub getfa { my $sheet = shift; @@ -1107,11 +1146,26 @@ sub exportdata { return @exportarray; } + + +sub update_student_sheet{ + my ($sheet,$r,$c) = @_; + # 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,$r,$c); + # Compute the sheet + &calcsheet($sheet); +} + # ========================================================== End of Spreadsheet # ============================================================================= - # -# Procedures for screen output +# Procedures for spreadsheet output # # --------------------------------------------- Produce output row n from sheet @@ -1132,22 +1186,57 @@ sub get_row { ######################################################################## sub sort_indicies { my $sheet = shift; - # - # Sort the rows in some manner - # - my @sortby=(); my @sortidx=(); - for (my $row=1;$row<=$sheet->{'maxrow'};$row++) { - push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}')); - push (@sortidx, $row); + # + if ($sheet->{'sheettype'} eq 'classcalc') { + my @sortby=(undef); + # Skip row 0 + for (my $row=1;$row<=$sheet->{'maxrow'};$row++) { + my (undef,$sname,$sdom,$fullname,$section,$id) = + split(':',$sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$row}}); + push (@sortby, lc($fullname)); + push (@sortidx, $row); + } + @sortidx = sort { $sortby[$a] cmp $sortby[$b]; } @sortidx; + } elsif ($sheet->{'sheettype'} eq 'studentcalc') { + my @sortby1=(undef); + my @sortby2=(undef); + # Skip row 0 + for (my $row=1;$row<=$sheet->{'maxrow'};$row++) { + my (undef,$symb,$uname,$udom,$mapid,$resid,$title) = + split(':',$sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$row}}); + $symb = &Apache::lonnet::unescape($symb); + my ($sequence) = ($symb =~ /\/([^\/]*\.sequence)/); + if ($sequence eq '') { + $sequence = $symb; + } + push (@sortby1, $sequence); + push (@sortby2, $title); + push (@sortidx, $row); + } + @sortidx = sort { $sortby1[$a] cmp $sortby1[$b] || + $sortby2[$a] cmp $sortby2[$b] } @sortidx; + } else { + my @sortby=(undef); + # Skip row 0 + for (my $row=1;$row<=$sheet->{'maxrow'};$row++) { + push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}')); + push (@sortidx, $row); + } + @sortidx = sort { $sortby[$a] cmp $sortby[$b]; } @sortidx; } - @sortidx=sort { lc($sortby[$a]) cmp lc($sortby[$b]); } @sortidx; return @sortidx; } -######################################################################## -######################################################################## - +############################################################# +### ### +### Spreadsheet Output Routines ### +### ### +############################################################# + +############################################ +## HTML output routines ## +############################################ sub html_editable_cell { my ($cell,$bgcolor) = @_; my $result; @@ -1168,6 +1257,7 @@ sub html_editable_cell { if ($value =~ /^\s*$/ ) { $value = '#'; } + $formula =~ s/\n/\\n/gs; $result .= ''.$value.''; return $result; @@ -1179,9 +1269,6 @@ sub html_uneditable_cell { return ' '.$value.' '; } -######################################################################## -######################################################################## - sub outsheet_html { my ($sheet,$r) = @_; my ($num_uneditable,$realm,$row_type); @@ -1248,7 +1335,6 @@ END # Print out summary/export row #################################### my ($rowlabel,@rowdata) = &get_row($sheet,'0'); - my $rowcount = 0; $row_html = '
+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,$r,$c);
+ # 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';
- &Apache::lonnet::logthis("spreadsheet:filename = ".$filename);
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 0;
+ return undef;
}
#
# The spreadsheet stores temporary data in files, then put them
@@ -1416,50 +1617,84 @@ sub outsheet_excel {
$workbook->set_tempdir('/home/httpd/perl/tmp');
#
# Determine the name to give the worksheet
- 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';
+ return ($workbook,$filename);
+}
+
+sub export_sheet_as_excel {
+ my $sheet = shift;
+ my $worksheet = shift;
+ #
+ my $rows_output = 0;
+ my $cols_output = 0;
+ ####################################
+ # Write an identifying row #
+ ####################################
+ my @Headerinfo = ($sheet->{'coursedesc'});
+ my $title = &gettitle($sheet);
+ $cols_output = 0;
+ if (defined($title)) {
+ $worksheet->write($rows_output++,$cols_output++,$title);
}
- my $worksheet = $workbook->addworksheet($sheetname);
+ ####################################
+ # Write the summary/export row #
+ ####################################
+ my ($rowlabel,@rowdata) = &get_row($sheet,'0');
+ my $label = &format_excel_rowlabel($rowlabel);
+ $cols_output = 0;
+ $worksheet->write($rows_output,$cols_output++,$label);
+ foreach my $cell (@rowdata) {
+ $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
+ }
+ $rows_output+= 2; # Skip a row, just for fun
####################################
# 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);
- my $cols_output = 0;
+ next if ($rowlabel =~ /^[\s]*$/);
+ $cols_output = 0;
my $label = &format_excel_rowlabel($rowlabel);
+ if ( ! $ENV{'form.showall'} &&
+ $sheet->{'sheettype'} =~ /^(studentcalc|classcalc)$/) {
+ my $row_is_empty = 1;
+ foreach my $cell (@rowdata) {
+ if ($cell->{'value'} !~ /^\s*$/) {
+ $row_is_empty = 0;
+ last;
+ }
+ }
+ next if ($row_is_empty);
+ }
$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'});
+ $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
}
$rows_output++;
}
- #
- $workbook->close();
- # Okay, the spreadsheet is taken care of, so give the user a link.
- $r->print('
'.
- 'Your Excel spreadsheet.'."\n");
- return 1;
+ 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)=@_;
+ my ($sheet,$r)=@_;
if (! exists($ENV{'form.output'})) {
$ENV{'form.output'} = 'HTML';
}
@@ -1467,6 +1702,8 @@ sub outsheet {
&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 {
@@ -1569,7 +1806,8 @@ sub readsheet {
if ($fh=Apache::File->new($includedir.'/'.$dfn)) {
$sheetxml=join('',<$fh>);
} else {
- $sheetxml='