--- loncom/interface/spreadsheet/studentcalc.pm 2003/09/18 20:12:40 1.22
+++ loncom/interface/spreadsheet/studentcalc.pm 2006/10/02 17:04:33 1.41
@@ -1,5 +1,5 @@
#
-# $Id: studentcalc.pm,v 1.22 2003/09/18 20:12:40 matthew Exp $
+# $Id: studentcalc.pm,v 1.41 2006/10/02 17:04:33 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -58,29 +58,34 @@ use Apache::Spreadsheet();
use Apache::assesscalc();
use HTML::Entities();
use Time::HiRes;
+use Apache::lonlocal;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
+
@Apache::studentcalc::ISA = ('Apache::Spreadsheet');
my @Sequences = ();
+my $navmap;
my %Exportrows = ();
my $current_course;
sub initialize {
- &Apache::assesscalc::initialize();
&initialize_sequence_cache();
+ &Apache::assesscalc::initialize($navmap);
}
sub initialize_package {
- $current_course = $ENV{'request.course.id'};
+ $current_course = $env{'request.course.id'};
&initialize_sequence_cache();
&load_cached_export_rows();
}
sub ensure_correct_sequence_data {
- if ($current_course ne $ENV{'request.course.id'}) {
+ if ($current_course ne $env{'request.course.id'}) {
&initialize_sequence_cache();
- $current_course = $ENV{'request.course.id'};
+ $current_course = $env{'request.course.id'};
}
return;
}
@@ -89,19 +94,40 @@ sub initialize_sequence_cache {
#
# Set up the sequences and assessments
undef(@Sequences);
- my ($top,$sequences,$assessments) =
- &Apache::loncoursedata::get_sequence_assessment_data();
- if (! defined($top) || ! ref($top)) {
- # There has been an error, better report it
- &Apache::lonnet::logthis('top is undefined (studentcalc.pm)');
- return;
+ undef($navmap);
+ $navmap = Apache::lonnavmaps::navmap->new();
+ if (!defined($navmap)) {
+ &Apache::lonnet::logthis('student spreadsheet:Can not open Coursemap');
+ }
+ my @all_sequences = $navmap->retrieveResources(undef,
+ sub { shift->is_map(); },1,0,1);
+ for my $sequence ($navmap->getById('0.0'), @all_sequences) {
+ if ($navmap->hasResource($sequence,sub { shift->is_problem(); }, 0)){
+ push(@Sequences,$sequence);
+ &get_resources($sequence);
+ }
}
- @Sequences = @{$sequences} if (ref($sequences) eq 'ARRAY');
+}
+
+my %res_memoize;
+sub get_resources {
+ my ($seq) = @_;
+ if (exists($res_memoize{$seq->symb()})) {
+ return @{$res_memoize{$seq->symb()}};
+ }
+ return () if (! defined($navmap) || ! ref($navmap));
+ my @resources = $navmap->retrieveResources($seq,
+ sub { shift->is_problem(); },
+ 0,0,0);
+ $res_memoize{$seq->symb()}=\@resources;
+ return @resources;
}
sub clear_package {
undef(@Sequences);
undef(%Exportrows);
+ undef(%res_memoize);
+ undef($navmap);
&Apache::assesscalc::clear_package();
}
@@ -110,15 +136,11 @@ sub get_title {
my @title = ();
#
# Determine the students name
- my %userenv = &Apache::loncoursedata::GetUserName($self->{'name'},
- $self->{'domain'});
- my $name = join(' ',
- @userenv{'firstname','middlename','lastname','generation'});
- $name =~ s/\s+$//;
-
+ my $name = &Apache::loncommon::plainname($self->{'name'},
+ $self->{'domain'});
push (@title,$name);
push (@title,$self->{'coursedesc'});
- push (@title,scalar(localtime(time)));
+ push (@title,&Apache::lonlocal::locallocaltime(time));
return @title;
}
@@ -126,8 +148,8 @@ sub get_html_title {
my $self = shift;
my ($name,$desc,$time) = $self->get_title();
my $title = '<h1>'.$name;
- if ($ENV{'user.name'} ne $self->{'name'} &&
- $ENV{'user.domain'} ne $self->{'domain'}) {
+ if ($env{'user.name'} ne $self->{'name'} &&
+ $env{'user.domain'} ne $self->{'domain'}) {
$title .= ' '.&Apache::loncommon::aboutmewrapper
($self->{'name'}.'@'.$self->{'domain'},
$self->{'name'},$self->{'domain'});
@@ -140,24 +162,15 @@ sub get_html_title {
sub parent_link {
my $self = shift;
- return '<p><a href="/adm/classcalc">Course level sheet</a></p>'."\n";
+ return '<p><a href="/adm/classcalc">'.&mt('Course level sheet').'</a></p>'."\n";
}
sub convenience_links {
my $self = shift;
my ($resource) = @_;
- my $symb = &Apache::lonnet::escape($resource->{'symb'});
- my $result = <<"END";
-<a href="/adm/grades?symb=$symb&command=submission" target="LONcatInfo">
- <img src="/adm/lonMisc/subm_button.gif" border=0 />
- </a>
-<a href="/adm/grades?symb=$symb&command=gradingmenu" target="LONcatInfo">
- <img src="/adm/lonMisc/pgrd_button.gif" border=0 />
- </a>
-<a href="/adm/parmset?symb=$symb" target="LONcatInfo">
- <img src="/adm/lonMisc/pprm_button.gif" border=0 />
- </a>
-END
+ my $result=&Apache::loncommon::submlink('<img src="/adm/lonMisc/subm_button.gif" border="0" />',$self->{'name'},$self->{'domain'},$resource->symb,'LONcatInfo');
+ $result .= &Apache::loncommon::pgrdlink('<img src="/adm/lonMisc/pgrd_button.gif" border="0" />',$self->{'name'},$self->{'domain'},$resource->symb,'LONcatInfo');
+ $result .= &Apache::loncommon::pprmlink('<img src="/adm/lonMisc/pprm_button.gif" border="0" />',$self->{'name'},$self->{'domain'},$resource->symb,'LONcatInfo');
return $result;
}
@@ -171,21 +184,32 @@ sub outsheet_html {
####################################
my @AssessFileNames = $self->othersheets('assesscalc');
my $editing_is_allowed = &Apache::lonnet::allowed('mgr',
- $ENV{'request.course.id'});
+ $env{'request.course.id'});
+ ####################################
+ # Report any calculation errors #
+ ####################################
+ $r->print($self->html_report_error());
####################################
# Determine table structure #
####################################
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";
<p>
<table border="2">
<tr>
- <th colspan="2" rowspan="2"><font size="+2">Student</font></th>
+ <th colspan="2" rowspan="2"><font size="+2">$lt{'st'}</font></th>
<td bgcolor="$importcolor" colspan="$num_uneditable">
- <b><font size="+1">Import</font></b></td>
+ <b><font size="+1">$lt{'im'}</font></b></td>
<td colspan="$num_left">
- <b><font size="+1">Calculations</font></b></td>
+ <b><font size="+1">$lt{'ca'}</font></b></td>
</tr><tr>
END
my $label_num = 0;
@@ -201,37 +225,37 @@ END
$tableheader .="</tr>\n";
if ($self->blackout()) {
$r->print('<font color="red" size="+2"><p>'.
- 'Some computations are not available at this time.<br />'.
- 'There are problems whose status you are allowed to view.'.
+ &mt('Some computations are not available at this time.').'<br />'.
+ &mt('There are problems whose status you are not allowed to view.').
'</font></p>'."\n");
} else {
$r->print($tableheader);
#
# Print out template row
- if (exists($ENV{'request.role.adv'}) && $ENV{'request.role.adv'}) {
+ if (exists($env{'request.role.adv'}) && $env{'request.role.adv'}) {
$r->print('<tr><td>Template</td><td> </td>'.
$self->html_template_row($num_uneditable,
$importcolor)."</tr>\n");
}
#
# Print out summary/export row
- $r->print('<tr><td>Summary</td><td>0</td>'.
+ $r->print('<tr><td>'.&mt('Summary').'</td><td>0</td>'.
$self->html_export_row($exportcolor)."</tr>\n");
}
$r->print("</table>\n");
#
# Prepare to output rows
- if (exists($ENV{'request.role.adv'}) && $ENV{'request.role.adv'}) {
+ if (exists($env{'request.role.adv'}) && $env{'request.role.adv'}) {
$tableheader =<<"END";
</p><p>
<table border="2">
-<tr><th>Row</th><th> </th><th>Assessment</th>
+<tr><th>$lt{'ro'}</th><th> </th><th>$lt{'as'}</th>
END
} else {
$tableheader =<<"END";
</p><p>
<table border="2">
-<tr><th> </th><th>Assessment</th>
+<tr><th> </th><th>$lt{'as'}</th>
END
}
foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
@@ -249,12 +273,19 @@ END
&initialize_sequence_cache();
}
foreach my $Sequence (@Sequences) {
- next if ($Sequence->{'num_assess'} < 1);
- $r->print("<h3>".$Sequence->{'title'}."</h3>\n");
+ $r->print("<h3>".$Sequence->compTitle."</h3>\n");
+
+ my @resources = &get_resources($Sequence);
+ my $first_rownum =
+ $self->get_row_number_from_key($resources[0]->symb);
+ my $last_rownum =
+ $self->get_row_number_from_key($resources[-1]->symb);
+ $r->print(&assess_file_selector([$first_rownum, $last_rownum],
+ undef, \@AssessFileNames));
+
$r->print($tableheader);
- foreach my $resource (@{$Sequence->{'contents'}}) {
- next if ($resource->{'type'} ne 'assessment');
- my $rownum = $self->get_row_number_from_key($resource->{'symb'});
+ foreach my $resource (@resources) {
+ my $rownum = $self->get_row_number_from_key($resource->symb);
my $assess_filename = $self->{'row_source'}->{$rownum};
my $row_output = '<tr>';
if ($editing_is_allowed) {
@@ -264,21 +295,21 @@ END
'<a href="/adm/assesscalc?sname='.$self->{'name'}.
'&sdomain='.$self->{'domain'}.
'&filename='.$assess_filename.
- '&usymb='.&Apache::lonnet::escape($resource->{'symb'}).
- '">'.$resource->{'title'}.'</a><br />';
+ '&usymb='.&escape($resource->symb).
+ '">'.$resource->compTitle.'</a><br />';
$row_output .= &assess_file_selector($rownum,
$assess_filename,
\@AssessFileNames).
'</td>';
} else {
- $row_output .= '<td><a href="'.$resource->{'src'}.'?symb='.
- &Apache::lonnet::escape($resource->{'symb'}).
+ $row_output .= '<td><a href="'.$resource->src.'?symb='.
+ &escape($resource->symb).
'">Go To</a>';
- $row_output .= '</td><td>'.$resource->{'title'}.'</td>';
+ $row_output .= '</td><td>'.$resource->compTitle.'</td>';
}
if ($self->blackout() && $self->{'blackout_rows'}->{$rownum}>0) {
$row_output .=
- '<td colspan="52">Unavailable at this time</td></tr>'."\n";
+ '<td colspan="52">'.&mt('Unavailable at this time').'</td></tr>'."\n";
} else {
$row_output .= $self->html_row($num_uneditable,$rownum,
$exportcolor,$importcolor).
@@ -308,13 +339,26 @@ sub assess_file_selector {
if (!defined($AssessFiles) || ! @$AssessFiles) {
return '';
}
- return '' if (! &Apache::lonnet::allowed('mgr',$ENV{'request.course.id'}));
- my $element_name = 'FileSelect_'.$row;
+ return '' if (! &Apache::lonnet::allowed('mgr',$env{'request.course.id'}));
+ my $element_name;
+ my $source_row = $row;
+ if (ref($row)) {
+ my ($first_rownum, $last_rownum) = @$row;
+ $element_name = "FileSelect_${first_rownum}_${last_rownum}";
+ $source_row = "${first_rownum}:${last_rownum}";
+ } else {
+ $element_name = 'FileSelect_'.$row;
+ }
my $load_dialog = '<select size="1" name="'.$element_name.'" '.
'onchange="'.
- "document.sheet.cell.value='source_$row';".
+ "document.sheet.cell.value='source_${source_row}';".
"document.sheet.newformula.value=document.sheet.$element_name\.value;".
'document.sheet.submit()" '.'>'."\n";
+ if (ref($row)) {
+ $load_dialog .= ' <option name="" value="">' .
+ &mt("Select spreadsheet for entire sequence")
+ . "</option>\n";
+ }
foreach my $file (@{$AssessFiles}) {
$load_dialog .= ' <option name="'.$file.'"';
$load_dialog .= ' selected' if ($default eq $file);
@@ -327,22 +371,38 @@ sub assess_file_selector {
sub modify_cell {
my $self = shift;
my ($cell,$formula) = @_;
- if ($cell =~ /^source_(\d+)$/) {
- # Need to make sure $formula is a valid filename....
- my $row = $1;
- $cell = 'A'.$row;
+
+ my $set_row = sub {
+ my $row = shift;
+ my $formula = shift;
+ my $cell = 'A' . $row;
$self->{'row_source'}->{$row} = $formula;
my $original_source = $self->formula($cell);
if ($original_source =~ /__&&&__/) {
($original_source,undef) = split('__&&&__',$original_source);
}
$formula = $original_source.'__&&&__'.$formula;
+ $self->set_formula($cell,$formula);
+ };
+
+ if ($cell =~ /^source_(\d+):(\d+)$/) {
+ my $first_row = $1;
+ my $last_row = $2;
+ for my $row ($first_row..$last_row) {
+ $set_row->($row, $formula);
+ }
+ } elsif ($cell =~ /^source_(\d+)$/) {
+ # Need to make sure $formula is a valid filename....
+ my $row = $1;
+ $set_row->($row, $formula);
} elsif ($cell =~ /([A-z])\-/) {
$cell = 'template_'.$1;
+ $self->set_formula($cell,$formula);
} elsif ($cell !~ /^([A-z](\d+)|template_[A-z])$/) {
return;
+ } else {
+ $self->set_formula($cell,$formula);
}
- $self->set_formula($cell,$formula);
$self->rebuild_stats();
return;
}
@@ -351,22 +411,21 @@ 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,
- ('Sequence or Folder','Assessment title'));
+ (&mt('Sequence or Folder'),&mt('Assessment title')));
#
# Write each assessments row
if (scalar(@Sequences)< 1) {
&initialize_sequence_cache();
}
foreach my $Sequence (@Sequences) {
- next if ($Sequence->{'num_assess'} < 1);
- foreach my $resource (@{$Sequence->{'contents'}}) {
- my $rownum = $self->get_row_number_from_key($resource->{'symb'});
- my @assessdata = ($Sequence->{'title'},
- $resource->{'title'});
+ foreach my $resource (&get_resources($Sequence)) {
+ my $rownum = $self->get_row_number_from_key($resource->symb);
+ my @assessdata = ($Sequence->compTitle,
+ $resource->compTitle);
$self->csv_output_row($filehandle,$rownum,@assessdata);
}
}
@@ -377,12 +436,12 @@ 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,$format) = @_;
#
# 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),$format->{'h4'});
}
$rows_output++;
#
@@ -391,11 +450,10 @@ sub excel_rows {
&initialize_sequence_cache();
}
foreach my $Sequence (@Sequences) {
- next if ($Sequence->{'num_assess'} < 1);
- foreach my $resource (@{$Sequence->{'contents'}}) {
- my $rownum = $self->get_row_number_from_key($resource->{'symb'});
- my @assessdata = ($Sequence->{'title'},
- $resource->{'title'});
+ foreach my $resource (&get_resources($Sequence)) {
+ my $rownum = $self->get_row_number_from_key($resource->symb);
+ my @assessdata = ($Sequence->compTitle,
+ $resource->compTitle);
$self->excel_output_row($worksheet,$rownum,$rows_output++,
@assessdata);
}
@@ -415,11 +473,10 @@ 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);
- }
+ my @resources = &get_resources($sequence);
+ foreach my $resource (@resources) {
+ my $rownum = $self->get_row_number_from_key($resource->symb);
+ push (@Rows,$rownum);
}
return @Rows;
}
@@ -442,7 +499,7 @@ sub put_sequence_data_in_safe_space {
# 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'});
+ my $title = &HTML::Entities::decode($seq->title());
$title =~ s/&\#058;/:/g;
if (@Rows) {
$data .= 'push(@{$Sequence_Rows{"'.quotemeta($title).'"}},'.
@@ -488,28 +545,24 @@ END
sub compute {
my $self = shift;
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'};
+ $current_course = $env{'request.course.id'};
&clear_package();
&initialize_sequence_cache();
}
$self->initialize_safe_space();
- &Apache::assesscalc::initialize_package($self->{'name'},$self->{'domain'});
+ &Apache::assesscalc::initialize_package($self->{'name'},$self->{'domain'},
+ $navmap);
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) {
- 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'});
+ foreach my $resource (&get_resources($seq)) {
+ my $rownum = $self->get_row_number_from_key($resource->symb);
my $cell = 'A'.$rownum;
my $assess_filename = 'Default';
if (exists($self->{'row_source'}->{$rownum})) {
@@ -517,14 +570,22 @@ sub compute {
} else {
$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'});
+ $f{$cell} = $resource->symb.'__&&&__'.$assess_filename;
+ my $assessSheet;
+ $assessSheet = Apache::assesscalc->new($self->{'name'},
+ $self->{'domain'},
+ $assess_filename,
+ $resource->symb,
+ $self->{'section'},
+ $self->{'groups'});
my @exportdata = $assessSheet->export_data($r);
- if ($connection->aborted()) { $self->cleanup(); return; }
+ #
+ if ($assessSheet->badcalc()) {
+ $self->set_calcerror(
+ &mt('Error computing row for assessment "[_1]" (row [_2]):[_3]',
+ $assessSheet->get_title(),$rownum,$assessSheet->calcerror()));
+ }
+ #
if ($assessSheet->blackout()) {
$self->blackout(1);
$self->{'blackout_rows'}->{$rownum} = 1;
@@ -567,6 +628,7 @@ sub compute {
sub set_row_sources {
my $self = shift;
+ $self->check_formulas_loaded();
while (my ($cell,$value) = each(%{$self->{'formulas'}})) {
next if ($cell !~ /^A(\d+)$/ || $1 < 1);
my $row = $1;
@@ -579,6 +641,7 @@ sub set_row_sources {
sub set_row_numbers {
my $self = shift;
+ $self->check_formulas_loaded();
while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
next if ($cell !~ /^A(\d+)/);
my $row = $1;
@@ -617,12 +680,12 @@ These rows are saved in the courses dire
sub load_cached_export_rows {
undef(%Exportrows);
my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
- $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
- $ENV{'course.'.$ENV{'request.course.id'}.'.num'},undef);
+ $env{'course.'.$env{'request.course.id'}.'.domain'},
+ $env{'course.'.$env{'request.course.id'}.'.num'},undef);
my %Selected_Assess_Sheet;
if ($tmp[0] =~ /^error/) {
&Apache::lonnet::logthis('unable to read cached student export rows '.
- 'for course '.$ENV{'request.course.id'});
+ 'for course '.$env{'request.course.id'});
return;
}
my %tmp = @tmp;
@@ -654,11 +717,16 @@ 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 ($self->temporary());
+ if ($self->badcalc()){
+ # do not save data away when calculations have not been done properly.
+ delete($Exportrows{$student});
+ return;
+ }
return if (! exists($Exportrows{$student}));
+ &Apache::assesscalc::save_cached_export_rows($self->{'name'},
+ $self->{'domain'});
return if (! $self->is_default());
my $key = join(':',($self->{'name'},$self->{'domain'},'studentcalc')).':';
my $timekey = $key.'.time';
@@ -702,9 +770,16 @@ sub export_data {
$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]));
+ my @Data;
+ if ($self->badcalc()) {
+ @Data = ();
+ } else {
+ @Data = @{$Exportrows{$student}->{'data'}};
+ for (my $i=0; $i<=$#Data;$i++) {
+ if ($Data[$i]=~/\D/ && defined($Data[$i])) {
+ $Data[$i]="'".$Data[$i]."'";
+ }
+ }
}
return @Data;
}