--- loncom/interface/Attic/lonspreadsheet.pm 2002/11/06 20:00:13 1.134 +++ loncom/interface/Attic/lonspreadsheet.pm 2002/11/12 22:44:28 1.139 @@ -1,5 +1,5 @@ # -# $Id: lonspreadsheet.pm,v 1.134 2002/11/06 20:00:13 matthew Exp $ +# $Id: lonspreadsheet.pm,v 1.139 2002/11/12 22:44:28 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -64,6 +64,7 @@ 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 = 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 @@ -1137,6 +1191,7 @@ sub sort_indicies { # my @sortby=(); my @sortidx=(); + # Skip row 0 for (my $row=1;$row<=$sheet->{'maxrow'};$row++) { push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}')); push (@sortidx, $row); @@ -1145,9 +1200,15 @@ sub sort_indicies { return @sortidx; } -######################################################################## -######################################################################## - +############################################################# +### ### +### Spreadsheet Output Routines ### +### ### +############################################################# + +############################################ +## HTML output routines ## +############################################ sub html_editable_cell { my ($cell,$bgcolor) = @_; my $result; @@ -1168,6 +1229,7 @@ sub html_editable_cell { if ($value =~ /^\s*$/ ) { $value = '#'; } + $formula =~ s/\n/\\n/gs; $result .= ''.$value.''; return $result; @@ -1179,9 +1241,6 @@ sub html_uneditable_cell { return ' '.$value.' '; } -######################################################################## -######################################################################## - sub outsheet_html { my ($sheet,$r) = @_; my ($num_uneditable,$realm,$row_type); @@ -1248,7 +1307,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);
+ # 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,48 +1575,71 @@ 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);
$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)=@_;
if (! exists($ENV{'form.output'})) {
@@ -1467,6 +1649,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 {
@@ -1605,6 +1789,8 @@ sub makenewsheet {
$sheet->{'udom'} = $udom;
$sheet->{'sheettype'} = $stype;
$sheet->{'usymb'} = $usymb;
+ $sheet->{'mapid'} = $ENV{'form.mapid'};
+ $sheet->{'resid'} = $ENV{'form.resid'};
$sheet->{'cid'} = $ENV{'request.course.id'};
$sheet->{'csec'} = $Section{$uname.':'.$udom};
$sheet->{'coursefilename'} = $ENV{'request.course.fn'};
@@ -1612,7 +1798,7 @@ sub makenewsheet {
$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'};
+ '.description'};
$sheet->{'uhome'} = &Apache::lonnet::homeserver($uname,$udom);
#
#
@@ -1818,10 +2004,11 @@ sub format_html_rowlabel {
my ($type,$labeldata) = split(':',$rowlabel,2);
my $result = '';
if ($type eq 'symb') {
- my ($symb,$uname,$udom,$title) = split(':',$labeldata);
+ my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
$symb = &Apache::lonnet::unescape($symb);
$result = ''.$title.'';
+ '&uname='.$uname.'&udom='.$udom.
+ '&mapid='.$mapid.'&resid='.$resid.'">'.$title.'';
} elsif ($type eq 'student') {
my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
$result ='{'sheettype'};
- if ($stype eq 'classcalc') {
+ if ($sheet->{'sheettype'} eq 'classcalc') {
return &updateclasssheet($sheet);
} else {
return &updatestudentassesssheet($sheet);
@@ -2450,7 +2672,7 @@ sub exportsheet {
}
#
# Not cached
- #
+ #
my ($newsheet)=&makenewsheet($uname,$udom,$stype,$usymb);
&readsheet($newsheet,$fn);
&updatesheet($newsheet);
@@ -2514,7 +2736,7 @@ sub exportsheet {
#
# Load previously cached student spreadsheets for this course
#
-sub expirationdates {
+sub load_spreadsheet_expirationdates {
undef %expiredates;
my $cid=$ENV{'request.course.id'};
my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
@@ -2552,18 +2774,21 @@ sub cachedssheets {
my ($sheet,$uname,$udom) = @_;
$uname = $uname || $sheet->{'uname'};
$udom = $udom || $sheet->{'udom'};
- if (! $loadedcaches{$sheet->{'uname'}.'_'.$sheet->{'udom'}}) {
+ if (! $loadedcaches{$uname.'_'.$udom}) {
my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
$sheet->{'udom'},
$sheet->{'uname'});
if ($tmp[0] !~ /^error/) {
- my %StupidTempHash = @tmp;
- while (my ($key,$value) = each %StupidTempHash) {
+ my %TempHash = @tmp;
+ my $count = 0;
+ while (my ($key,$value) = each %TempHash) {
$oldsheets{$key} = $value;
+ $count++;
}
$loadedcaches{$sheet->{'uname'}.'_'.$sheet->{'udom'}}=1;
}
}
+
}
# ===================================================== Calculated sheets cache
@@ -2579,12 +2804,19 @@ sub cachedssheets {
sub handler {
my $r=shift;
+ my ($sheettype) = ($r->uri=~/\/(\w+)$/);
+
if (! exists($ENV{'form.Status'})) {
$ENV{'form.Status'} = 'Active';
}
- if (! exists($ENV{'form.output'})) {
+ if ( ! exists($ENV{'form.output'}) ||
+ ($sheettype ne 'classcalc' &&
+ lc($ENV{'form.output'}) eq 'recursive excel')) {
$ENV{'form.output'} = 'HTML';
}
+ #
+ # Overload checking
+ #
# Check this server
my $loaderror=&Apache::lonnet::overloaderror($r);
if ($loaderror) { return $loaderror; }
@@ -2592,15 +2824,22 @@ sub handler {
$loaderror= &Apache::lonnet::overloaderror($r,
$ENV{'course.'.$ENV{'request.course.id'}.'.home'});
if ($loaderror) { return $loaderror; }
-
+ #
+ # HTML Header
+ #
if ($r->header_only) {
$r->content_type('text/html');
$r->send_http_header;
return OK;
}
+ #
# Global directory configs
+ #
$includedir = $r->dir_config('lonIncludes');
$tmpdir = $r->dir_config('lonDaemons').'/tmp/';
+ #
+ # Roles Checking
+ #
# Needs to be in a course
if (! $ENV{'request.course.fn'}) {
# Not in a course, or not allowed to modify parms
@@ -2608,17 +2847,27 @@ sub handler {
$r->uri.":opa:0:0:Cannot modify spreadsheet";
return HTTP_NOT_ACCEPTABLE;
}
+ #
# Get query string for limited number of parameters
- &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['uname','udom','usymb','ufn']);
+ #
+ &Apache::loncommon::get_unprocessed_cgi
+ ($ENV{'QUERY_STRING'},['uname','udom','usymb','ufn','mapid','resid']);
+ #
+ # Deal with restricted student permissions
+ #
if ($ENV{'request.role'} =~ /^st\./) {
delete $ENV{'form.unewfield'} if (exists($ENV{'form.unewfield'}));
delete $ENV{'form.unewformula'} if (exists($ENV{'form.unewformula'}));
}
+ #
+ # Clean up symb and spreadsheet filename
+ #
if (($ENV{'form.usymb'}=~/^\_(\w+)/) && (!$ENV{'form.ufn'})) {
$ENV{'form.ufn'}='default_'.$1;
}
+ #
# Interactive loading of specific sheet?
+ #
if (($ENV{'form.load'}) && ($ENV{'form.loadthissheet'} ne 'Default')) {
$ENV{'form.ufn'}=$ENV{'form.loadthissheet'};
}
@@ -2634,24 +2883,55 @@ sub handler {
$adom=$ENV{'form.udom'};
}
#
- # Open page
+ # Open page, try to prevent browser cache.
+ #
$r->content_type('text/html');
$r->header_out('Cache-control','no-cache');
$r->header_out('Pragma','no-cache');
$r->send_http_header;
- # Screen output
+ #
+ # Header....
+ #
$r->print('