--- loncom/interface/spreadsheet/assesscalc.pm 2003/09/10 18:33:35 1.21 +++ loncom/interface/spreadsheet/assesscalc.pm 2003/12/08 19:58:39 1.30 @@ -1,5 +1,5 @@ # -# $Id: assesscalc.pm,v 1.21 2003/09/10 18:33:35 matthew Exp $ +# $Id: assesscalc.pm,v 1.30 2003/12/08 19:58:39 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -50,10 +50,12 @@ use Apache::Constants qw(:common :http); use Apache::lonnet; use Apache::loncommon; use Apache::Spreadsheet; +use Apache::loncoursedata(); use HTML::Entities(); use Spreadsheet::WriteExcel; use GDBM_File; use Time::HiRes; +use Apache::lonlocal; @Apache::assesscalc::ISA = ('Apache::Spreadsheet'); @@ -90,6 +92,7 @@ use Time::HiRes; ######################################################## my %Exportrows; +my %newExportrows; my $current_name; my $current_domain; @@ -99,6 +102,7 @@ my %parmhash; my %nice_parameter_name; my %useropt; +my %userdata; my %courseopt; ######################################################## @@ -110,23 +114,43 @@ my %courseopt; =item &clear_package() -Reset all package variables. +Reset all package variables and clean up caches. =cut ######################################################## ######################################################## sub clear_package { + if (defined($current_name) && + defined($current_domain) && + defined($current_course) && + $current_course eq $ENV{'request.course.id'} && + %newExportrows) { + &save_cached_export_rows($current_name,$current_domain); + } undef(%Exportrows); + undef(%newExportrows); undef($current_name); undef($current_domain); undef($current_course); undef(%useropt); + undef(%userdata); undef(%courseopt); } +sub save_cached_export_rows { + my ($sname,$sdomain) = @_; + my $start = Time::HiRes::time; + my $result = &Apache::lonnet::put + ('nohist_calculatedsheets_'.$ENV{'request.course.id'}, + $newExportrows{$sname.':'.$sdomain}, + $sdomain,$sname); + delete($newExportrows{$sname.':'.$sdomain}); +} + sub initialize { &clear_package(); + &Apache::loncoursedata::clear_internal_caches(); } ######################################################## @@ -145,14 +169,17 @@ sub initialize_package { $current_name = $sname; $current_domain = $sdomain; undef(%useropt); + undef(%userdata); if ($current_course ne $ENV{'request.course.id'}) { $current_course = $ENV{'request.course.id'}; undef(%courseopt); } &load_cached_export_rows(); &load_parameter_caches(); + &Apache::loncoursedata::clear_internal_caches(); } + ######################################################## ######################################################## @@ -194,6 +221,12 @@ sub load_parameter_caches { } $useropt{'loadtime'} = time; } + if (! %userdata) { + %userdata = &Apache::loncoursedata::get_current_state($current_name, + $current_domain); + $userdata{'loadtime'} = time; + } + return; } ######################################################## @@ -207,7 +240,7 @@ sub load_parameter_caches { ######################################################## ######################################################## -sub ensure_current_parameter_caches { +sub ensure_current_caches { my $self = shift; ## ## Check for a modified parameters @@ -216,6 +249,8 @@ sub ensure_current_parameter_caches { $current_course ne $ENV{'request.course.id'} ) { $current_course = $ENV{'request.course.id'}; undef(%courseopt); + undef(%useropt); + undef(%userdata); } ## ## Check for new user @@ -225,6 +260,7 @@ sub ensure_current_parameter_caches { $current_domain = $self->{'domain'}; $current_name = $self->{'name'}; undef(%useropt); + undef(%userdata); } &load_parameter_caches(); } @@ -332,7 +368,7 @@ sub parmval { sub get_html_title { my $self = shift; - my ($assess_title,$name,$time) = $self->get_title(); + my ($assess_title,$name,$time) = $self->get_full_title(); my $title = '

'.$assess_title.'

'. '

'.$name.', '. &Apache::loncommon::aboutmewrapper @@ -344,17 +380,21 @@ sub get_html_title { sub get_title { my $self = shift; - my @title = (); if (($self->{'symb'} eq '_feedback') || ($self->{'symb'} eq '_evaluation') || ($self->{'symb'} eq '_discussion') || ($self->{'symb'} eq '_tutoring')) { my $assess_title = ucfirst($self->{'symb'}); $assess_title =~ s/^_//; - push(@title,$assess_title); + return $assess_title; } else { - push(@title,&Apache::lonnet::gettitle($self->{'symb'})); + return &Apache::lonnet::gettitle($self->{'symb'}); } +} + +sub get_full_title { + my $self = shift; + my @title = ($self->get_title()); # Look up the users identifying information # Get the users information my %userenv = &Apache::loncoursedata::GetUserName($self->{'name'}, @@ -363,7 +403,7 @@ sub get_title { join(' ',@userenv{'firstname','middlename','lastname','generation'}); $name =~ s/\s+$//; push (@title,$name); - push (@title,scalar(localtime(time))); + push (@title,&Apache::lonlocal::locallocaltime(time)); return @title; } @@ -372,13 +412,17 @@ sub parent_link { my $link .= '

'. - 'Student level sheet

'."\n"; + &mt('Student level sheet').'

'."\n"; return $link; } sub outsheet_html { my $self = shift; my ($r) = @_; + #################################### + # Report any calculation errors # + #################################### + $r->print($self->html_report_error()); ################################### # Determine table structure ################################### @@ -386,13 +430,17 @@ sub outsheet_html { my $exportcolor = '#FFFFAA'; my $num_uneditable = 1; my $num_left = 52-$num_uneditable; + my %lt=&Apache::lonlocal::texthash( + 'as' => 'Assessment', + 'ca' => 'Calculations', + ); my $tableheader =<<"END"; - + + $lt{'ca'} END my $label_num = 0; @@ -434,6 +482,11 @@ END # my $num_output = 0; foreach my $rownum (sort {$a <=> $b} ($self->rows())) { + if (! $self->parameter_part_is_valid( + $self->{'formulas'}->{'A'.$rownum} + )) { + next; + } if ($num_output++ % 50 == 0) { $r->print("
Assessment$lt{'as'}   - Calculations
\n".$tableheader); } @@ -478,11 +531,11 @@ sub csv_rows { # writes the meat of the spreadsheet to an excel worksheet. Called # by Spreadsheet::outsheet_excel; my $self = shift; - my ($filehandle) = @_; + my ($connection,$filehandle) = @_; # # Write a header row $self->csv_output_row($filehandle,undef, - ('Parameter','Description','Value')); + (&mt('Parameter'),&mt('Description'),&mt('Value'))); # # Write each row foreach my $rownum (sort {$a <=> $b} ($self->rows())) { @@ -501,7 +554,8 @@ sub excel_rows { # writes the meat of the spreadsheet to an excel worksheet. Called # by Spreadsheet::outsheet_excel; my $self = shift; - my ($worksheet,$cols_output,$rows_output) = @_; + my ($connection,$worksheet,$cols_output,$rows_output) = @_; + return if (! ref($worksheet)); # # Write a header row $cols_output = 0; @@ -531,7 +585,7 @@ sub get_parm_names { my @Mandatory_parameters = @_; my %parameters_and_names; # - my ($symap,$syid,$srcf)=split(/___/,$self->{'symb'}); + my ($symap,$syid,$srcf) = &Apache::lonnet::decode_symb($self->{'symb'}); my @Metadata = split(/\,/,&Apache::lonnet::metadata($srcf,'keys')); foreach my $parm (@Mandatory_parameters,@Metadata) { next if ($parm !~ /^(resource\.|stores|parameter)_/); @@ -587,13 +641,67 @@ sub deal_with_export_row { return; } +sub get_problem_state { + my $self = shift; + my %student_parameters; + if (exists($userdata{$self->{'symb'}}) && + ref($userdata{$self->{'symb'}}) eq 'HASH') { + %student_parameters = %{$userdata{$self->{'symb'}}}; + } + return %student_parameters; +} + +sub determine_parts { + my $self = shift; + if (exists($self->{'Parts'}) && ref($self->{'Parts'}) eq 'HASH') { + return; + } + my (undef,undef,$url) = &Apache::lonnet::decode_symb($self->{'symb'}); + my $src = &Apache::lonnet::clutter($url); + return if (! defined($src)); + my %Parts; + my $metadata = &Apache::lonnet::metadata($src,'packages'); + foreach (split(',',$metadata)) { + my ($part) = (/^part_(.*)$/); + if (defined($part) && + ! &Apache::loncommon::check_if_partid_hidden + ($part,$self->{'symb'},$self->{'name'},$self->{'domain'}) + ) { + $Parts{$part}++; + } + } + # Make sure part 0 is defined. + $Parts{'0'}++; + $self->{'Parts'} = \%Parts; + return; +} + +sub parameter_part_is_valid { + my $self = shift; + my ($parameter) = @_; + return 1 if ($parameter eq 'timestamp'); + if (! defined($self->{'Parts'}) || + ! ref ($self->{'Parts'}) || + ref($self->{'Parts'}) ne 'HASH') { + return 1; + } + # + my (undef,$part) = + ($parameter =~ m/^(resource|stores|parameter)_([^_]+)_.*/); + if (exists($self->{'Parts'}) && + exists($self->{'Parts'}->{$part}) && + $self->{'Parts'}->{$part} ) { + return 1; + } else { + return 0; + } +} sub compute { my $self = shift; my ($r) = @_; my $connection = $r->connection(); if ($connection->aborted()) { $self->cleanup(); return; } -# $self->logthis('computing'); $self->initialize_safe_space(); ######################################### ######################################### @@ -622,7 +730,7 @@ sub compute { # # Get the values of the metadata fields if ($connection->aborted()) { $self->cleanup(); return; } - $self->ensure_current_parameter_caches(); + $self->ensure_current_caches(); if ($connection->aborted()) { $self->cleanup(); return; } %parameters = $self->get_parameter_values(keys(%parameters)); if ($connection->aborted()) { $self->cleanup(); return; } @@ -633,17 +741,21 @@ sub compute { } # # Get the students performance data - my %student_parameters = - &Apache::loncoursedata::get_current_state($self->{'name'}, - $self->{'domain'}, - $self->{'symb'}, - $self->{'cid'}); + my %student_parameters = $self->get_problem_state(); while (my ($parm,$value) = each(%student_parameters)) { $parm =~ s/^resource\./stores_/; $parm =~ s/\./_/g; $parameters{$parm} = $value; } # + # Clean out any bad parameters + $self->determine_parts(); + foreach my $param (keys(%parameters)) { + if (! $self->parameter_part_is_valid($param)) { + delete ($parameters{$param}); + } + } + # # Set up the formulas and parameter values my %f=$self->formulas(); my %c; @@ -653,7 +765,7 @@ sub compute { while (my ($parm,$value) = each(%parameters)) { last if ($self->blackout()); next if ($parm !~ /^(parameter_.*)_problemstatus$/); - if ($parameters{$1.'_answerdate'} eq '' || + if ($parameters{$1.'_answerdate'} ne '' && $parameters{$1.'_answerdate'} < time) { next; } @@ -666,7 +778,6 @@ sub compute { if ($connection->aborted()) { $self->cleanup(); return; } # # Move the parameters into the spreadsheet - if ($connection->aborted()) { $self->cleanup(); return; } while (my ($parm,$value) = each(%parameters)) { my $cell = 'A'.$self->get_row_number_from_key($parm); $f{$cell} = $parm; @@ -805,13 +916,20 @@ sub export_data { $self->compute($r); } if ($connection->aborted()) { $self->cleanup(); return; } - my @Data = @{$Exportrows{$symb}->{$self->{'filename'}}}; - if ($Data[0] =~ /^(.*)___=___/) { - $self->{'sheetname'} = $1; - $Data[0] =~ s/^(.*)___=___//; - } - for (my $i=0;$i<$#Data;$i++) { - $Data[$i]="'".$Data[$i]."'" if ($Data[$i]=~/\D/ && defined($Data[$i])); + my @Data; + if ($self->badcalc()) { + @Data = (); + } else { + @Data = @{$Exportrows{$symb}->{$self->{'filename'}}}; + if ($Data[0] =~ /^(.*)___=___/) { + $self->{'sheetname'} = $1; + $Data[0] =~ s/^(.*)___=___//; + } + for (my $i=0;$i<$#Data;$i++) { + if ($Data[$i]=~/\D/ && defined($Data[$i])) { + $Data[$i]="'".$Data[$i]."'"; + } + } } return @Data; } @@ -834,21 +952,23 @@ sub save_export_data { return if ($self->temporary()); my $student = $self->{'name'}.':'.$self->{'domain'}; my $symb = $self->{'symb'}; + if ($self->badcalc()){ + # do not save data away when calculations have not been done properly. + delete($Exportrows{$symb}); + return; + } if (! exists($Exportrows{$symb}) || ! exists($Exportrows{$symb}->{$self->{'filename'}})) { return; } my $key = join(':',($self->{'name'},$self->{'domain'},'assesscalc',$symb)); my $timekey = $key.'.time'; - my $newstore= join('___;___',@{$Exportrows{$symb}->{$self->{'filename'}}}); + my $newstore= join('___;___', + map {s/[^[:print:]]//g;$_;} # strip out unprintable + @{$Exportrows{$symb}->{$self->{'filename'}}}); $newstore = $self->{'filename'}.'___=___'.$newstore; - my $result = &Apache::lonnet::put - ('nohist_calculatedsheets_'.$ENV{'request.course.id'}, - { $key => $newstore, - $timekey => $Exportrows{$symb}->{'time'} }, - $self->{'domain'}, - $self->{'name'}); - + $newExportrows{$student}->{$key} = $newstore; + $newExportrows{$student}->{$timekey} = $Exportrows{$symb}->{'time'}; return; }