--- loncom/interface/spreadsheet/studentcalc.pm 2003/06/12 21:17:11 1.11 +++ loncom/interface/spreadsheet/studentcalc.pm 2003/10/14 18:36:54 1.23 @@ -1,5 +1,5 @@ # -# $Id: studentcalc.pm,v 1.11 2003/06/12 21:17:11 matthew Exp $ +# $Id: studentcalc.pm,v 1.23 2003/10/14 18:36:54 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -45,6 +45,9 @@ studentcalc ################################################### package Apache::studentcalc; +use warnings FATAL=>'all'; +no warnings 'uninitialized'; + use strict; use Apache::Constants qw(:common :http); use Apache::lonnet; @@ -54,8 +57,8 @@ use Apache::lonnavmaps; use Apache::Spreadsheet(); use Apache::assesscalc(); use HTML::Entities(); -use Spreadsheet::WriteExcel; use Time::HiRes; +use Apache::lonlocal; @Apache::studentcalc::ISA = ('Apache::Spreadsheet'); @@ -86,7 +89,7 @@ sub ensure_correct_sequence_data { sub initialize_sequence_cache { # # Set up the sequences and assessments - @Sequences = (); + undef(@Sequences); my ($top,$sequences,$assessments) = &Apache::loncoursedata::get_sequence_assessment_data(); if (! defined($top) || ! ref($top)) { @@ -98,8 +101,9 @@ sub initialize_sequence_cache { } sub clear_package { - @Sequences = undef; - %Exportrows = undef; + undef(@Sequences); + undef(%Exportrows); + &Apache::assesscalc::clear_package(); } sub get_title { @@ -115,7 +119,7 @@ sub get_title { push (@title,$name); push (@title,$self->{'coursedesc'}); - push (@title,scalar(localtime(time))); + push (@title,&Apache::lonlocal::locallocaltime(time)); return @title; } @@ -125,7 +129,7 @@ sub get_html_title { my $title = '

'.$name; if ($ENV{'user.name'} ne $self->{'name'} && $ENV{'user.domain'} ne $self->{'domain'}) { - $title .= &Apache::loncommon::aboutmewrapper + $title .= ' '.&Apache::loncommon::aboutmewrapper ($self->{'name'}.'@'.$self->{'domain'}, $self->{'name'},$self->{'domain'}); } @@ -137,16 +141,32 @@ sub get_html_title { sub parent_link { my $self = shift; - my $link .= '

'. - 'Course level sheet

'."\n"; - return $link; + return '

'.&mt('Course level sheet').'

'."\n"; +} + +sub convenience_links { + my $self = shift; + my ($resource) = @_; + my $symb = &Apache::lonnet::escape($resource->{'symb'}); + my $result = <<"END"; + + + + + + + + + +END + return $result; } sub outsheet_html { my $self = shift; my ($r) = @_; + my $importcolor = '#FFFFAA'; + my $exportcolor = '#88FF88'; #################################### # Get the list of assessment files # #################################### @@ -158,21 +178,28 @@ sub outsheet_html { #################################### my $num_uneditable = 26; my $num_left = 52-$num_uneditable; + my %lt=&Apache::lonlocal::texthash( + 'st' => 'Student', + 'im' => 'Import', + 'ca' => 'Calculations', + 'as' => 'Assessment', + 'ro' => 'Row', + ); my $tableheader =<<"END";

- - + + + $lt{'ca'} END my $label_num = 0; foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){ if ($label_num<$num_uneditable) { - $tableheader .='\n"; if ($self->blackout()) { $r->print('

'. - 'Some computations are not available at this time.
'. - 'There are problems whose status you are allowed to view.'. + &mt('Some computations are not available at this time.').'
'. + &mt('There are problems whose status you are not allowed to view.'). '

'."\n"); } else { $r->print($tableheader); @@ -191,12 +218,13 @@ END # Print out template row if (exists($ENV{'request.role.adv'}) && $ENV{'request.role.adv'}) { $r->print(''. - $self->html_template_row($num_uneditable)."\n"); + $self->html_template_row($num_uneditable, + $importcolor)."\n"); } # # Print out summary/export row - $r->print(''. - $self->html_export_row()."\n"); + $r->print(''. + $self->html_export_row($exportcolor)."\n"); } $r->print("
Student - Import$lt{'st'} + $lt{'im'} - Calculations
'; + $tableheader .=''; } else { $tableheader .=''; } @@ -182,8 +209,8 @@ END $tableheader .="
Template 
Summary0
'.&mt('Summary').'0
\n"); # @@ -205,13 +233,13 @@ END $tableheader =<<"END";

- + END } else { $tableheader =<<"END";

RowAssessment
$lt{'ro'} $lt{'as'}
- + END } foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){ @@ -239,6 +267,7 @@ END my $row_output = ''; if ($editing_is_allowed) { $row_output .= ''; + $row_output .= ''; $row_output .= ''."\n"; + ''."\n"; } else { - $row_output .= $self->html_row($num_uneditable,$rownum). + $row_output .= $self->html_row($num_uneditable,$rownum, + $exportcolor,$importcolor). "\n"; } $r->print($row_output); @@ -333,7 +363,7 @@ sub csv_rows { # # Write a header row $self->csv_output_row($filehandle,undef, - ('Sequence or Folder','Assessment title')); + (&mt('Sequence or Folder'),&mt('Assessment title'))); # # Write each assessments row if (scalar(@Sequences)< 1) { @@ -360,7 +390,7 @@ sub excel_rows { # Write a header row $cols_output = 0; foreach my $value ('Container','Assessment title') { - $worksheet->write($rows_output,$cols_output++,$value); + $worksheet->write($rows_output,$cols_output++,&mt($value)); } $rows_output++; # @@ -386,35 +416,106 @@ sub outsheet_recursive_excel { my ($r) = @_; } +## +## Routines to deal with sequences in the safe space +## +sub get_rows_in_sequence { + my $self = shift(); + my ($sequence) = @_; + my @Rows; + foreach my $resource (@{$sequence->{'contents'}}) { + if ($resource->{'type'} eq 'assessment') { + my $rownum = $self->get_row_number_from_key($resource->{'symb'}); + push (@Rows,$rownum); + } + } + return @Rows; +} + +sub remove_sequence_data_from_safe_space { + my $self = shift(); + my $command = 'undef(%Sequence_Rows);'; + $self->{'safe'}->reval($command); +} + +sub put_sequence_data_in_safe_space { + my $self = shift(); + my $data = 'undef(%Sequence_Rows);'; + # Build up the %Sequence_Rows hash - each sequence title is associated with + # an array pointer, which holds the rows in the sequence. + foreach my $seq (@Sequences) { + my @Rows = $self->get_rows_in_sequence($seq); + # + # Potential problems with sequence titles: + # 1. duplicate titles - they get the total for the titles + # 2. control characters in titles - use q{} around the string to + # deal with it. + my $title = &HTML::Entities::decode($seq->{'title'}); + $title =~ s/&\#058;/:/g; + if (@Rows) { + $data .= 'push(@{$Sequence_Rows{"'.quotemeta($title).'"}},'. + '('.join(',',@Rows).'));'."\n";; + } + } + my $new_code = $data.<<'END'; +sub SUMSEQ { + my ($col,@titles) = @_; + return 'bad column: '.$col if ($col !~ /^[A-z]$/); + my $sum = 0; + foreach my $title (@titles) { + while (my ($seq_title,$rows) = each(%Sequence_Rows)) { + my $regexp; + if ($title =~ /^regexp:(.*)$/) { + $regexp = $1; + } elsif (lc($title) eq 'all') { + $regexp = '.'; + } + if (defined($regexp)) { + next if ($seq_title !~ /$regexp/); + } else { + next if ($seq_title ne $title); + } + foreach my $rownum (@{$rows}) { + my $cell = $col.$rownum; + if (exists($sheet_values{$cell})) { + $sum += $sheet_values{$cell}; + } + } + } + } + return $sum; +} +END + $self->{'safe'}->reval($new_code); + return; +} + +## +## Main computation method +## sub compute { my $self = shift; - $self->logthis('computing'); + my ($r) = @_; + my $connection = $r->connection(); + if ($connection->aborted()) { $self->cleanup; return; } if (! defined($current_course) || - $current_course ne $ENV{'request.course.id'}) { + $current_course ne $ENV{'request.course.id'} || + ! @Sequences ) { $current_course = $ENV{'request.course.id'}; &clear_package(); &initialize_sequence_cache(); } $self->initialize_safe_space(); - my @sequences = @Sequences; - if (@sequences < 1) { - my ($top,$sequences,$assessments) = - &Apache::loncoursedata::get_sequence_assessment_data(); - if (! defined($top) || ! ref($top)) { - &Apache::lonnet::logthis('top is undefined'); - return; - } - @sequences = @{$sequences} if (ref($sequences) eq 'ARRAY'); - } &Apache::assesscalc::initialize_package($self->{'name'},$self->{'domain'}); my %f = $self->formulas(); # # Process the formulas list - # the formula for the A column of a row is symb__&&__filename my %c = $self->constants(); - foreach my $seq (@sequences) { + foreach my $seq (@Sequences) { next if ($seq->{'num_assess'}<1); foreach my $resource (@{$seq->{'contents'}}) { + if ($connection->aborted()) { $self->cleanup(); return; } next if ($resource->{'type'} ne 'assessment'); my $rownum = $self->get_row_number_from_key($resource->{'symb'}); my $cell = 'A'.$rownum; @@ -425,11 +526,13 @@ sub compute { $self->{'row_source'}->{$rownum} = $assess_filename; } $f{$cell} = $resource->{'symb'}.'__&&&__'.$assess_filename; + if ($connection->aborted()) { $self->cleanup(); return; } my $assessSheet = Apache::assesscalc->new($self->{'name'}, $self->{'domain'}, $assess_filename, $resource->{'symb'}); - my @exportdata = $assessSheet->export_data(); + my @exportdata = $assessSheet->export_data($r); + if ($connection->aborted()) { $self->cleanup(); return; } if ($assessSheet->blackout()) { $self->blackout(1); $self->{'blackout_rows'}->{$rownum} = 1; @@ -454,7 +557,9 @@ sub compute { } $self->constants(\%c); $self->formulas(\%f); + $self->put_sequence_data_in_safe_space(); $self->calcsheet(); + $self->remove_sequence_data_from_safe_space(); # # Store export row in cache my @exportarray=$self->exportrow(); @@ -471,7 +576,7 @@ sub compute { sub set_row_sources { my $self = shift; while (my ($cell,$value) = each(%{$self->{'formulas'}})) { - next if ($cell !~ /^A(\d+)/ && $1 > 0); + next if ($cell !~ /^A(\d+)$/ || $1 < 1); my $row = $1; (undef,$value) = split('__&&&__',$value); $value = 'Default' if (! defined($value)); @@ -488,7 +593,7 @@ sub set_row_numbers { next if ($row == 0); my ($symb,undef) = split('__&&&__',$formula); $self->{'row_numbers'}->{$symb} = $row; - $self->{'maxrow'} = $1 if ($1 > $self->{'maxrow'}); + $self->{'maxrow'} = $row if ($row > $self->{'maxrow'}); } } @@ -518,7 +623,7 @@ These rows are saved in the courses dire ############################################# ############################################# sub load_cached_export_rows { - %Exportrows = undef; + undef(%Exportrows); my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets', $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}, $ENV{'course.'.$ENV{'request.course.id'}.'.num'},undef); @@ -557,6 +662,8 @@ Writes the export data for this student ############################################# sub save_export_data { my $self = shift; + &Apache::assesscalc::save_cached_export_rows($self->{'name'}, + $self->{'domain'}); return if ($self->temporary()); my $student = $self->{'name'}.':'.$self->{'domain'}; return if (! exists($Exportrows{$student})); @@ -566,7 +673,7 @@ sub save_export_data { my $newstore = join('___;___', @{$Exportrows{$student}->{'data'}}); $newstore = '___=___'.$newstore; - &Apache::lonnet::put('nohist_calculatedsheets', + my $result= &Apache::lonnet::put('nohist_calculatedsheets', { $key => $newstore, $timekey => $Exportrows{$student}->{'time'} }, $self->{'cdom'}, @@ -590,11 +697,19 @@ spreadsheet only if necessary. ############################################# sub export_data { my $self = shift; + my ($r) = @_; + my $connection = $r->connection(); my $student = $self->{'name'}.':'.$self->{'domain'}; if (! exists($Exportrows{$student}) || + ! defined($Exportrows{$student}) || + ! exists($Exportrows{$student}->{'data'}) || + ! defined($Exportrows{$student}->{'data'}) || + ! exists($Exportrows{$student}->{'time'}) || + ! defined($Exportrows{$student}->{'time'}) || ! $self->check_expiration_time($Exportrows{$student}->{'time'})) { - $self->compute(); + $self->compute($r); } + if ($connection->aborted()) { $self->cleanup(); return; } my @Data = @{$Exportrows{$student}->{'data'}}; for (my $i=0; $i<=$#Data;$i++) { $Data[$i]="'".$Data[$i]."'" if ($Data[$i]=~/\D/ && defined($Data[$i]));
 Assessment
 $lt{'as'}
'.$rownum.''.$self->convenience_links($resource).''. 'Unavailable at this time
'.&mt('Unavailable at this time').'