--- loncom/interface/Attic/lonspreadsheet.pm 2002/10/22 13:13:15 1.121
+++ loncom/interface/Attic/lonspreadsheet.pm 2003/03/14 21:34:04 1.160.2.1
@@ -1,5 +1,5 @@
#
-# $Id: lonspreadsheet.pm,v 1.121 2002/10/22 13:13:15 matthew Exp $
+# $Id: lonspreadsheet.pm,v 1.160.2.1 2003/03/14 21:34:04 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -53,15 +53,19 @@ 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::Entities();
use HTML::TokeParser;
-use Apache::lonhtmlcommon;
-use Apache::loncoursedata;
+use Spreadsheet::WriteExcel;
+
#
# Caches for coursewide information
#
@@ -91,7 +95,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,19 +126,16 @@ my $tmpdir;
##
sub mask {
my ($lower,$upper)=@_;
-
- $lower=~/([A-Za-z]|\*)(\d+|\*)/;
- my $la=$1;
- my $ld=$2;
-
- $upper=~/([A-Za-z]|\*)(\d+|\*)/;
- my $ua=$1;
- my $ud=$2;
+ $upper = $lower if (! defined($upper));
+ #
+ my ($la,$ld) = ($lower=~/([A-Za-z]|\*)(\d+|\*)/);
+ my ($ua,$ud) = ($upper=~/([A-Za-z]|\*)(\d+|\*)/);
+ #
my $alpha='';
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]/)) {
@@ -188,8 +189,8 @@ sub mask {
}
$num.=')';
} else {
- if ($lda[$#lda]!=$uda[$#uda]) {
- $num.='['.$lda[$#lda].'-'.$uda[$#uda].']';
+ if ($lda[-1]!=$uda[-1]) {
+ $num.='['.$lda[-1].'-'.$uda[-1].']';
}
}
}
@@ -197,8 +198,6 @@ sub mask {
return '^'.$alpha.$num."\$";
}
-
-
sub initsheet {
my $safeeval = new Safe(shift);
my $safehole = new Safe::Hole;
@@ -208,7 +207,6 @@ sub initsheet {
$safeeval->deny(":base_io");
$safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
$safehole->wrap(\&Apache::lonspreadsheet::mask,$safeeval,'&mask');
- $safehole->wrap(\&Apache::lonspreadsheet::templaterow,$safeeval,'&templaterow');
$safeeval->share('$@');
my $code=<<'ENDDEFS';
# ---------------------------------------------------- Inside of the safe space
@@ -238,12 +236,11 @@ undef %c; # Holds the constants for a sh
# sheets, this is the A column. Used in &MINPARM, &MAXPARM, &expandnamed,
# &sett, and &setconstants. There is no &getconstants.
# &setconstants is called by &loadstudent, &loadcourse, &load assessment,
-undef %rowlabel; # Holds the 'prefix' for each row. Set by &setrowlabels.
- # &setrowlabels is called by &updateclasssheet, &updatestudentassesssheet,
undef @os; # Holds the names of other spreadsheets - this is used to specify
# 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 = '';
@@ -597,7 +594,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++;
@@ -834,9 +832,11 @@ sub expandnamed {
foreach $parameter (keys(%c)) {
push @matches,$parameter if ($parameter =~ /$expression/);
}
- if ($#matches == 0) {
+ if (scalar(@matches) == 0) {
+ $returnvalue = 'unmatched parameter: '.$parameter;
+ } elsif (scalar(@matches) == 1) {
$returnvalue = '$c{\''.$matches[0].'\'}';
- } elsif ($#matches > 0) {
+ } elsif (scalar(@matches) > 0) {
# more than one match. Look for a concise one
$returnvalue = "'non-unique parameter name : $expression'";
foreach (@matches) {
@@ -845,7 +845,9 @@ sub expandnamed {
}
}
} else {
- $returnvalue = "'bad parameter name : $expression'";
+ # There was a negative number of matches, which indicates
+ # something is wrong with reality. Better warn the user.
+ $returnvalue = 'bizzare parameter: '.$parameter;
}
return $returnvalue;
}
@@ -928,6 +930,7 @@ sub calc {
while ($notfinished) {
$notfinished=0;
foreach (keys(%t)) {
+ #$errorlog .= "$_:".$t{$_};
my $old=$sheet_values{$_};
$sheet_values{$_}=eval $t{$_};
if ($@) {
@@ -935,6 +938,7 @@ sub calc {
return $_.': '.$@;
}
if ($sheet_values{$_} ne $old) { $notfinished=1; $lastcalc=$_; }
+ #$errorlog .= ":".$sheet_values{$_}."\n";
}
$depth++;
if ($depth>100) {
@@ -945,92 +949,86 @@ sub calc {
return '';
}
+# ------------------------------------------- End of "Inside of the safe space"
+ENDDEFS
+ $safeeval->reval($code);
+ return $safeeval;
+}
+
#
-# This is actually used for the student spreadsheet, not the assessment sheet
-# Do not be fooled by the name!
+#
#
-sub outrowassess {
- # $n is the current row number
- my $n=shift;
- my $csv = shift;
+sub templaterow {
+ my $sheet = shift;
my @cols=();
- if ($n) {
- my ($usy,$ufn)=split(/__&&&\__/,$f{'A'.$n});
- if ($rowlabel{$usy}) {
- $cols[0]=$rowlabel{$usy};
- if (! $csv) {
- $cols[0].=''.
- 'Default ';
- }
- } else {
- $cols[0]='';
- }
- if (! $csv) {
- foreach (@os) {
- $cols[0].='';
- }
- $cols[0].=' ';
- }
- } else {
- $cols[0]='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',
'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=$f{$_.$n};
- $fm=~s/[\'\"]/\&\#34;/g;
- push(@cols,"'$_$n','$fm'".'___eq___'.$sheet_values{$_.$n});
+ push(@cols,{ name => 'template_'.$_,
+ formula => $sheet->{'f'}->{'template_'.$_},
+ value => $sheet->{'f'}->{'template_'.$_} });
}
- return @cols;
+ return ($rowlabel,@cols);
}
-sub outrow {
- my $n=shift;
+sub outrowassess {
+ # $n is the current row number
+ my ($sheet,$n) = @_;
my @cols=();
+ my $rowlabel='';
if ($n) {
- $cols[0]=$rowlabel{$f{'A'.$n}};
+ my ($usy,$ufn)=split(/__&&&\__/,$sheet->{'f'}->{'A'.$n});
+ if (exists($sheet->{'rowlabel'}->{$usy})) {
+ # This is dumb, but we need the information when we output
+ # the html version of the studentcalc spreadsheet for the
+ # links to the assesscalc sheets.
+ $rowlabel = $sheet->{'rowlabel'}->{$usy}.':'.
+ &Apache::lonnet::escape($ufn);
+ } else {
+ $rowlabel = '';
+ }
+ } elsif ($ENV{'request.role'} =~ /^st\./) {
+ $rowlabel = 'Summary 0';
} else {
- $cols[0]='Export 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') {
- my $fm=$f{$_.$n};
- $fm=~s/[\'\"]/\&\#34;/g;
- push(@cols,"'$_$n','$fm'".'___eq___'.$sheet_values{$_.$n});
+ push(@cols,{ name => $_.$n,
+ formula => $sheet->{'f'}->{$_.$n},
+ value => $sheet->{'values'}->{$_.$n}});
}
- return @cols;
+ return ($rowlabel,@cols);
}
-sub templaterow {
+sub outrow {
+ my ($sheet,$n)=@_;
my @cols=();
- $cols[0]='Template 0';
+ } else {
+ $rowlabel = 'Export 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') {
- my $fm=$f{'template_'.$_};
- $fm=~s/[\'\"]/\&\#34;/g;
- push(@cols,"'template_$_','$fm'".'___eq___'.$fm);
+ push(@cols,{ name => $_.$n,
+ formula => $sheet->{'f'}->{$_.$n},
+ value => $sheet->{'values'}->{$_.$n}});
}
- return @cols;
+ return ($rowlabel,@cols);
}
-
-# ------------------------------------------- End of "Inside of the safe space"
-ENDDEFS
- $safeeval->reval($code);
- return $safeeval;
-}
-
-
# ------------------------------------------------ Add or change formula values
sub setformulas {
my ($sheet)=shift;
@@ -1040,6 +1038,12 @@ sub setformulas {
# ------------------------------------------------ Add or change formula values
sub setconstants {
my ($sheet)=shift;
+ my ($constants) = @_;
+ if (! ref($constants)) {
+ my %tmp = @_;
+ $constants = \%tmp;
+ }
+ $sheet->{'constants'} = $constants;
return %{$sheet->{'safe'}->varglob('c')}=%{$sheet->{'constants'}};
}
@@ -1055,7 +1059,12 @@ sub setothersheets {
# ------------------------------------------------ Add or change formula values
sub setrowlabels {
my $sheet=shift;
- %{$sheet->{'safe'}->varglob('rowlabel')}=%{$sheet->{'rowlabel'}};
+ my ($rowlabel) = @_;
+ if (! ref($rowlabel)) {
+ my %tmp = @_;
+ $rowlabel = \%tmp;
+ }
+ $sheet->{'rowlabel'}=$rowlabel;
}
# ------------------------------------------------------- Calculate spreadsheet
@@ -1067,11 +1076,55 @@ 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')};
+}
+
+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;
@@ -1085,182 +1138,603 @@ 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,$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
-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 # ';
- }
- $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'}?'':'# ';
+ if ($formula ne '') {
+ $value = 'undefined value ';
+ }
+ } elsif ($value =~ /^\s*$/ ) {
+ $value = '# ';
+ } else {
+ $value = &HTML::Entities::encode($value) if ($value !~/ /);
+ }
+ # Make the formula safe for outputting
+ $formula =~ s/\'/\"/g;
+ # The formula will be parsed by the browser *twice* before being
+ # displayed to the user for editing.
+ $formula = &HTML::Entities::encode(&HTML::Entities::encode($formula));
+ # Escape newlines so they make it into the edit window
+ $formula =~ s/\n/\\n/gs;
+ # Glue everything together
+ $result .= "".$value." ";
+ return $result;
+}
-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
+sub html_uneditable_cell {
+ my ($cell,$bgcolor) = @_;
+ my $value = (defined($cell) ? $cell->{'value'} : '');
+ $value = &HTML::Entities::encode($value) if ($value !~/ /);
+ return ' '.$value.' ';
+}
+
+sub outsheet_html {
+ my ($sheet,$r) = @_;
+ my ($num_uneditable,$realm,$row_type);
+ my $requester_is_student = ($ENV{'request.role'} =~ /^st\./);
if ($sheet->{'sheettype'} eq 'assesscalc') {
- $maxred=1;
- $realm='Assessment';
+ $num_uneditable = 1;
+ $realm = 'Assessment';
+ $row_type = 'Item';
} elsif ($sheet->{'sheettype'} eq 'studentcalc') {
- $maxred=26;
- $realm='User';
+ $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
+ Import
+
+ Calculations
+
+END
+ my $label_num = 0;
+ foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
+ if ($label_num<$num_uneditable) {
+ $tabledata.='';
+ } else {
+ $tabledata.=' ';
+ }
+ $tabledata.="$_ ";
+ $label_num++;
+ }
+ $tabledata.=" \n";
+ $r->print($tabledata);
+ ####################################
+ # Print out template row
+ ####################################
+ my ($num_cols_output,$row_html,$rowlabel,@rowdata);
+
+ if (! $requester_is_student) {
+ ($rowlabel,@rowdata) = &get_row($sheet,'-');
+ $row_html = ''.&format_html_rowlabel($sheet,$rowlabel).' ';
+ $num_cols_output = 0;
+ foreach my $cell (@rowdata) {
+ if ($requester_is_student ||
+ $num_cols_output++ < $num_uneditable) {
+ $row_html .= '';
+ $row_html .= &html_uneditable_cell($cell,'#FFDDDD');
+ } else {
+ $row_html .= ' ';
+ $row_html .= &html_editable_cell($cell,'#E0FFDD');
+ }
+ $row_html .= ' ';
+ }
+ $row_html.= "'.&format_html_rowlabel($sheet,$rowlabel).' ';
+ $num_cols_output = 0;
+ foreach my $cell (@rowdata) {
+ if ($num_cols_output++ < 26 && ! $requester_is_student) {
+ $row_html .= '';
+ $row_html .= &html_editable_cell($cell,'#CCCCFF');
+ } else {
+ $row_html .= ' ';
+ $row_html .= &html_uneditable_cell($cell,'#CCCCFF');
+ }
+ $row_html .= ' ';
}
+ $row_html.= "
');
+ ####################################
+ # Prepare to output rows
+ ####################################
+ my @Rows = &sort_indicies($sheet);
#
- # Column label
- my $tabledata;
- if ($ENV{'form.showcsv'}) {
- $tabledata='';
- } else {
- $tabledata=' '.
- ''.$realm.' '.
- 'Import Calculations ';
- 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.='';
+ # 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*$/);
+ next if (($sheet->{'sheettype'} eq 'assesscalc') &&
+ (! $ENV{'form.showall'}) &&
+ ($rowdata[0]->{'value'} =~ /^\s*$/));
+ 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);
+ }
+ #
+ my $defaultbg='#E0FF';
+ #
+ my $row_html ="\n".' '.$rownum.
+ ' '.&format_html_rowlabel($sheet,$rowlabel).' ';
+ # Output links for each student?
+ # Nope, that is already done for us in format_html_rowlabel
+ # (for now)
+ } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
+ my $ufn = (split(/:/,$rowlabel))[5];
+ $row_html.=''.&format_html_rowlabel($sheet,$rowlabel);
+ $row_html.= ''.
+ 'Default ';
+
+ foreach (@{$sheet->{'othersheets'}}) {
+ $row_html.='';
+ }
+ $row_html.=' ';
+ } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
+ $row_html.=''.&format_html_rowlabel($sheet,$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 {
- $tabledata.='';
+ $bgcolor = $defaultbg.'DD';
+ }
+ $bgcolor='#FFDDDD' if ($shown_cells < $num_uneditable);
+ #
+ $row_html.=' ';
+ if ($requester_is_student || $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'.
+ ' '.$row_type.' '.
+ ''.
+ join(' ',
+ (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
+ 'abcdefghijklmnopqrstuvwxyz'))).
+ " $_
');
+ #
+ # Debugging code (be sure to uncomment errorlog code in safe space):
+ #
+ # $r->print("\n");
+ # $r->print(&geterrorlog($sheet));
+ # $r->print("\n ");
+ return 1;
+}
+
+############################################
+## csv output routines ##
+############################################
+sub outsheet_csv {
+ my ($sheet,$r) = @_;
+ my $csvdata = '';
+ my @Values;
+ ####################################
# Prepare to output rows
- my $row;
+ ####################################
+ my @Rows = &sort_indicies($sheet);
#
- my @sortby=();
- my @sortidx=();
- for ($row=1;$row<=$sheet->{'maxrow'};$row++) {
- push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}'));
- push (@sortidx, $row-1);
+ # 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($sheet,$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 my $rownum (&sort_indicies($sheet)) {
+ $count++;
+ my ($sname,$sdom) = split(':',$f{'A'.$rownum});
+ 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 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') {
- $what='Assessment';
+ $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;
+ #
+ 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);
+ }
+ ####################################
+ # Write the summary/export row #
+ ####################################
+ my ($rowlabel,@rowdata) = &get_row($sheet,'0');
+ my $label = &format_excel_rowlabel($sheet,$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 $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'})) {
- $r->print("\n
'.$what.' ');
- $r->print(''.
- join(' ',
- (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
- 'abcdefghijklmnopqrstuvwxyz'))).
- "
');
+ return;
}
-#
-# ----------------------------------------------- Read list of available sheets
-#
+############################################
+## 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 ($sheet,$r)=@_;
+ 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));
@@ -1278,7 +1752,6 @@ sub othersheets {
return @alternatives;
}
-
#
# -------------------------------------- Parse a spreadsheet
#
@@ -1355,7 +1828,8 @@ sub readsheet {
if ($fh=Apache::File->new($includedir.'/'.$dfn)) {
$sheetxml=join('',<$fh>);
} else {
- $sheetxml='"Error" ';
+ # $sheetxml='"Error" ';
+ $sheetxml=''.
+ '"Unable to load spreadsheet" ';
+ }
+ %f=%{&parse_sheet(\$sheetxml)};
}
}
# Cache and set
@@ -1391,12 +1879,16 @@ 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'};
$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);
#
#
@@ -1433,31 +1925,26 @@ 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);
+ $reply = &Apache::lonnet::put('environment',
+ {'spreadsheet_default_'.$stype => $fn },
+ $cdom,$cnum);
+ if ($reply eq 'ok' &&
+ ($sheet->{'sheettype'} eq 'studentcalc' ||
+ $sheet->{'sheettype'} eq 'assesscalc')) {
+ # Expire the spreadsheets of the other students.
+ &Apache::lonnet::expirespread('','','studentcalc','');
+ }
+ return $reply;
}
return $reply;
}
@@ -1480,7 +1967,10 @@ sub tmpwrite {
$fn=$tmpdir.$fn.'.tmp';
my $fh;
if ($fh=Apache::File->new('>'.$fn)) {
- print $fh join("\n",&getformulas($sheet));
+ my %f = &getformulas($sheet);
+ while( my ($cell,$formula) = each(%f)) {
+ print $fh &Apache::lonnet::escape($cell)."=".&Apache::lonnet::escape($formula)."\n";
+ }
}
}
@@ -1496,32 +1986,36 @@ sub tmpread {
my %fo=();
my $countrows=0;
if ($fh=Apache::File->new($fn)) {
- my $name;
- while ($name=<$fh>) {
- chomp($name);
- my $value=<$fh>;
- chomp($value);
- $fo{$name}=$value;
- if ($name=~/^A(\d+)$/) {
- if ($1>$countrows) {
- $countrows=$1;
- }
- }
- }
- }
+ while (<$fh>) {
+ chomp;
+ my ($cell,$formula) = split(/=/);
+ $cell = &Apache::lonnet::unescape($cell);
+ $formula = &Apache::lonnet::unescape($formula);
+ $fo{$cell} = $formula;
+ }
+ }
+# chomp($value);
+# $fo{$name}=$value;
+# if ($name=~/^A(\d+)$/) {
+# if ($1>$countrows) {
+# $countrows=$1;
+# }
+# }
+# }
+# }
if ($nform eq 'changesheet') {
- $fo{'A'.$nfield}=(split(/\_\_\&\&\&\_\_/,$fo{'A'.$nfield}))[0];
+ $fo{'A'.$nfield}=(split(/__&&&\__/,$fo{'A'.$nfield}))[0];
unless ($ENV{'form.sel_'.$nfield} eq 'Default') {
$fo{'A'.$nfield}.='__&&&__'.$ENV{'form.sel_'.$nfield};
}
- } elsif ($nfield eq 'insertrow') {
- $countrows++;
- my $newrow=substr('000000'.$countrows,-7);
- if ($nform eq 'top') {
- $fo{'A'.$countrows}='--- '.$newrow;
- } else {
- $fo{'A'.$countrows}='~~~ '.$newrow;
- }
+# } elsif ($nfield eq 'insertrow') {
+# $countrows++;
+# my $newrow=substr('000000'.$countrows,-7);
+# if ($nform eq 'top') {
+# $fo{'A'.$countrows}='--- '.$newrow;
+# } else {
+# $fo{'A'.$countrows}='~~~ '.$newrow;
+# }
} else {
if ($nfield) { $fo{$nfield}=$nform; }
}
@@ -1600,8 +2094,114 @@ sub parmval {
# second, check map parms
my $thisparm = $parmhash{$symbparm};
return $thisparm if (defined($thisparm));
+
# first, check default
- return &Apache::lonnet::metadata($fn,$rwhat.'.default');
+ $thisparm = &Apache::lonnet::metadata($fn,$rwhat.'.default');
+ return $thisparm if (defined($thisparm));
+
+ #Cascade Up
+ my $space=$what;
+ $space=~s/\.\w+$//;
+ if ($space ne '0') {
+ my @parts=split(/_/,$space);
+ my $id=pop(@parts);
+ my $part=join('_',@parts);
+ if ($part eq '') { $part='0'; }
+ my $newwhat=$rwhat;
+ $newwhat=~s/\Q$space\E/$part/;
+ my $partgeneral=&parmval($newwhat,$symb,$uname,$udom,$csec);
+ if (defined($partgeneral)) { return $partgeneral; }
+ }
+
+ #nothing defined
+ return '';
+}
+
+
+##################################################################
+## Row label formatting routines ##
+##################################################################
+sub format_html_rowlabel {
+ my $sheet = shift;
+ my $rowlabel = shift;
+ return '' if ($rowlabel eq '');
+ my ($type,$labeldata) = split(':',$rowlabel,2);
+ my $result = '';
+ if ($type eq 'symb') {
+ my ($symb,$mapid,$resid,$title,$ufn) = split(':',$labeldata);
+ $ufn = 'default' if (!defined($ufn) || $ufn eq '');
+ $ufn = &Apache::lonnet::unescape($ufn);
+ $symb = &Apache::lonnet::unescape($symb);
+ $title = &Apache::lonnet::unescape($title);
+ $result = ''.$title.' ';
+ } elsif ($type eq 'student') {
+ my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
+ if ($fullname =~ /^\s*$/) {
+ $fullname = $sname.'@'.$sdom;
+ }
+ $result ='';
+ $result.=$section.' '.$id." ".$fullname.' ';
+ } elsif ($type eq 'parameter') {
+ $result = $labeldata;
+ } else {
+ $result = ''.$rowlabel.' ';
- $rowlabel.=$studentSection.' '.$id." ".$fullname;
- $rowlabel.=' ';
- }
- $currentlist{$student}=$rowlabel;
+ $currentlist{$student}=join(':',('student',$studentName,
+ $studentDomain,$fullname,
+ $studentSection,$id));
}
}
#
@@ -1664,11 +2256,11 @@ sub updateclasssheet {
}
#
# New and unknown keys
- foreach (sort keys(%currentlist)) {
- unless ($existing{$_}) {
+ foreach my $student (sort keys(%currentlist)) {
+ unless ($existing{$student}) {
$changed=1;
$sheet->{'maxrow'}++;
- $f{'A'.$sheet->{'maxrow'}}=$_;
+ $f{'A'.$sheet->{'maxrow'}}=$student;
}
}
if ($changed) {
@@ -1676,84 +2268,105 @@ sub updateclasssheet {
&setformulas($sheet,%f);
}
#
- $sheet->{'rowlabel'} = \%currentlist;
- &setrowlabels($sheet);
+ &setrowlabels($sheet,\%currentlist);
}
# ----------------------------------- Update rows for student and assess sheets
-sub updatestudentassesssheet {
+sub get_student_rowlabels {
my ($sheet) = @_;
- my %bighash;
- my $stype=$sheet->{'sheettype'};
- my $uname=$sheet->{'uname'};
- my $udom =$sheet->{'udom'};
+ #
+ my %course_db;
+ #
+ my $stype = $sheet->{'sheettype'};
+ my $uname = $sheet->{'uname'};
+ my $udom = $sheet->{'udom'};
+ #
$sheet->{'rowlabel'} = {};
- if ($updatedata
- {$ENV{'request.course.fn'}.'_'.$stype.'_'.$uname.'_'.$udom}) {
- %{$sheet->{'rowlabel'}}=split(/___;___/,
- $updatedata{$ENV{'request.course.fn'}.
- '_'.$stype.'_'.$uname.'_'.$udom});
+ #
+ 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',$ENV{'request.course.fn'}.'.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';
}
- # Get all assessments
- my %allkeys=('timestamp' =>
- 'Timestamp of Last TransactionFeedback ',
- '_evaluation' =>'Evaluation ',
- '_tutoring' =>'Tutoring ',
- '_discussion' =>'Discussion '
- );
- } else {
- %allassess =
- ('_feedback' => "Feedback",
- '_evaluation' => "Evaluation",
- '_tutoring' => "Tutoring",
- '_discussion' => "Discussion",
- );
- }
- while (($_,undef) = each(%bighash)) {
- next if ($_!~/^src\_(\d+)\.(\d+)$/);
- my $mapid=$1;
- my $resid=$2;
- my $id=$mapid.'.'.$resid;
- my $srcf=$bighash{$_};
+ #
+ my %assesslist = ();
+ foreach ('Feedback','Evaluation','Tutoring','Discussion') {
+ my $symb = '_'.lc($_);
+ $assesslist{$symb} = join(':',('symb',$symb,0,0,
+ &Apache::lonnet::escape($_)));
+ }
+ #
+ 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}).
+ &Apache::lonnet::declutter($course_db{'map_id_'.$mapid}).
'___'.$resid.'___'.&Apache::lonnet::declutter($srcf);
- if (! $ENV{'form.showcsv'}) {
- $allassess{$symb}=
- ''.
- $bighash{'title_'.$id}.' ';
- } else {
- $allassess{$symb}=$bighash{'title_'.$id};
- }
- next if ($stype ne 'assesscalc');
- foreach my $key (split(/\,/,
- &Apache::lonnet::metadata($srcf,'keys')
- )) {
+ $assesslist{$symb} ='symb:'.&Apache::lonnet::escape($symb).':'
+ .$mapid.':'.$resid.':'.
+ &Apache::lonnet::escape($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';
+ }
+ #
+ my %parameter_labels=
+ ('timestamp' =>
+ 'parameter:Timestamp of Last TransactionLON-CAPA Spreadsheet ');
+ my $nothing = "''";
+ if ($ENV{'browser.type'} eq 'explorer') {
+ $nothing = "'javascript:void(0);'";
+ }
+
if ($ENV{'request.role'} !~ /^st\./) {
$r->print(<
- function celledit(cn,cf) {
- var cnf=prompt(cn,cf);
- if (cnf!=null) {
- document.sheet.unewfield.value=cn;
- document.sheet.unewformula.value=cnf;
- document.sheet.submit();
+ var editwin;
+
+ function celledit(cellname,cellformula) {
+ var edit_text = '';
+ // cellformula may contain less-than and greater-than symbols, so
+ // we need to escape them?
+ edit_text +='Cell Edit Window ';
+ edit_text += '