--- loncom/interface/statistics/lonstudentassessment.pm 2003/02/25 20:47:47 1.29
+++ loncom/interface/statistics/lonstudentassessment.pm 2004/02/12 14:47:55 1.88
@@ -1,6 +1,6 @@
# The LearningOnline Network with CAPA
#
-# $Id: lonstudentassessment.pm,v 1.29 2003/02/25 20:47:47 matthew Exp $
+# $Id: lonstudentassessment.pm,v 1.88 2004/02/12 14:47:55 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -52,36 +52,74 @@ package Apache::lonstudentassessment;
use strict;
use Apache::lonstatistics;
use Apache::lonhtmlcommon;
+use Apache::loncommon();
use Apache::loncoursedata;
use Apache::lonnet; # for logging porpoises
-use GDBM_File;
+use Apache::lonlocal;
+use Spreadsheet::WriteExcel;
+use Spreadsheet::WriteExcel::Utility();
+
+#######################################################
+#######################################################
+=pod
+
+=item Package Variables
+
+=over 4
+
+=item $Statistics Hash ref to store student data. Indexed by symb,
+ contains hashes with keys 'score' and 'max'.
+
+=cut
+
+#######################################################
+#######################################################
+
+my $Statistics;
#######################################################
#######################################################
=pod
-=item &BuildStudentAssessmentPage()
+=item $show_links 'yes' or 'no' for linking to student performance data
-Inputs:
+=item $output_mode 'html', 'excel', or 'csv' for output mode
-=over 4
+=item $show 'all', 'totals', or 'scores' determines how much data is output
-=item $cacheDB The name of the cache file used to store student data
+=item $single_student_mode evaluates to true if we are showing only one
+student.
-=item $students Array ref containing the name(s) of the students
-selected for display
+=cut
-=item $courseID The ID of the course
+#######################################################
+#######################################################
+my $show_links;
+my $output_mode;
+my $chosen_output;
+my $single_student_mode;
-=item $formName The name of the html form - 'Statistics'
+#######################################################
+#######################################################
+# End of package variable declarations
-=item $headings Array ref of headings to show
+=pod
-=item $spacing A string of spaces
+=back
-=item $studentInformation Array ref of possible headings for student info
-('fullname','section',...)
+=cut
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &BuildStudentAssessmentPage()
+
+Inputs:
+
+=over 4
=item $r Apache Request
@@ -94,147 +132,159 @@ selected for display
#######################################################
#######################################################
sub BuildStudentAssessmentPage {
- my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,
- $studentInformation,$r,$c)=@_;
- my %cache;
- unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
- $r->print('
Unable to tie database.');
+ my ($r,$c)=@_;
+ #
+ undef($Statistics);
+ undef($show_links);
+ undef($output_mode);
+ undef($chosen_output);
+ undef($single_student_mode);
+ #
+ my %Saveable_Parameters = ('Status' => 'scalar',
+ 'chartoutputmode' => 'scalar',
+ 'chartoutputdata' => 'scalar',
+ 'Section' => 'array',
+ 'StudentData' => 'array',
+ 'Maps' => 'array');
+ &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters);
+ &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters);
+ #
+ &Apache::lonstatistics::PrepareClasslist();
+ #
+ $single_student_mode = 0;
+ $single_student_mode = 1 if ($ENV{'form.SelectedStudent'});
+ if ($ENV{'form.selectstudent'}) {
+ &Apache::lonstatistics::DisplayClasslist($r);
return;
}
-
- # Remove students who don't have the proper section.
- my @sectionsSelected = split(':',$cache{'sectionsSelected'});
- for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;
- $studentIndex--) {
- my $value = $cache{$students->[$studentIndex].':section'};
- my $found = 0;
- foreach (@sectionsSelected) {
- if($_ eq 'none') {
- if($value eq '' || !defined($value) || $value eq ' ') {
- $found = 1;
- last;
- }
- } else {
- if($value eq $_) {
- $found = 1;
- last;
- }
- }
- }
- if($found == 0) {
- splice(@$students, $studentIndex, 1);
+ #
+ # Print out the HTML headers for the interface
+ # This also parses the output mode selector
+ # This step must *always* be done.
+ $r->print(&CreateInterface());
+ $r->print('');
+ $r->print('');
+ $r->rflush();
+ #
+ if (! exists($ENV{'form.notfirstrun'}) && ! $single_student_mode) {
+ return;
+ }
+ #
+ my $initialize = \&html_initialize;
+ my $output_student = \&html_outputstudent;
+ my $finish = \&html_finish;
+ #
+ if ($output_mode eq 'excel') {
+ $initialize = \&excel_initialize;
+ $output_student = \&excel_outputstudent;
+ $finish = \&excel_finish;
+ } elsif ($output_mode eq 'csv') {
+ $initialize = \&csv_initialize;
+ $output_student = \&csv_outputstudent;
+ $finish = \&csv_finish;
+ }
+ #
+ if($c->aborted()) { return ; }
+ #
+ # Determine which students we want to look at
+ my @Students;
+ if ($single_student_mode) {
+ @Students = (&Apache::lonstatistics::current_student());
+ $r->print(&next_and_previous_buttons());
+ $r->rflush();
+ } else {
+ @Students = @Apache::lonstatistics::Students;
+ }
+ #
+ # Perform generic initialization tasks
+ # Since we use lonnet::EXT to retrieve problem weights,
+ # to ensure current data we must clear the caches out.
+ # This makes sure that parameter changes at the student level
+ # are immediately reflected in the chart.
+ &Apache::lonnet::clear_EXT_cache_status();
+ #
+ # Clean out loncoursedata's package data, just to be safe.
+ &Apache::loncoursedata::clear_internal_caches();
+ #
+ # Call the initialize routine selected above
+ $initialize->($r);
+ foreach my $student (@Students) {
+ if($c->aborted()) {
+ $finish->($r);
+ return ;
}
+ # Call the output_student routine selected above
+ $output_student->($r,$student);
}
- my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,
- $doNotShow) =
- &ShouldShowColumns(\%cache, $headings, $studentInformation);
-
- my $selectedName = &FindSelectedStudent(\%cache,
- $cache{'StudentAssessmentStudent'},
- $students);
- $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,
- $doNotShow));
- $r->rflush();
+ # Call the "finish" routine selected above
+ $finish->($r);
+ #
+ return;
+}
+#######################################################
+#######################################################
+sub next_and_previous_buttons {
my $Str = '';
- if($selectedName eq 'No Student Selected') {
- $Str .= '
WARNING: ';
- $Str .= 'Please select a student
';
- $r->print($Str);
- return;
+ $Str .= '';
+ #
+ # Build the previous student link
+ my $previous = &Apache::lonstatistics::previous_student();
+ my $previousbutton = '';
+ if (defined($previous)) {
+ my $sname = $previous->{'username'}.':'.$previous->{'domain'};
+ $previousbutton .= '';
+ } else {
+ $previousbutton .= '';
}
-
- $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings,
- $sequenceKeys, $sequenceHeadings));
- untie(%cache);
- if($c->aborted()) { return $Str; }
-
- my $selected=0;
- my $Count = 0;
- $r->print('
WARNING: ';
- $Str .= 'No Students enrolled OR Please select a student
';
- $r->print($Str);
+ #
+ # Build the next student link
+ my $next = &Apache::lonstatistics::next_student();
+ my $nextbutton = '';
+ if (defined($next)) {
+ my $sname = $next->{'username'}.':'.$next->{'domain'};
+ $nextbutton .= '';
} else {
- if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
- $r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys));
- untie(%cache);
- }
+ $nextbutton .= '';
}
- return;
+ #
+ # Build the 'all students' button
+ my $all = '';
+ $all .= '';
+ $Str .= $previousbutton.(' 'x5).$all.(' 'x5).$nextbutton;
+ return $Str;
}
+
+#######################################################
+#######################################################
+
+sub get_student_fields_to_show {
+ my @to_show = @Apache::lonstatistics::SelectedStudentData;
+ foreach (@to_show) {
+ if ($_ eq 'all') {
+ @to_show = @Apache::lonstatistics::StudentDataOrder;
+ last;
+ }
+ }
+ return @to_show;
+}
+
#######################################################
#######################################################
@@ -245,23 +295,7 @@ sub BuildStudentAssessmentPage {
Called by &BuildStudentAssessmentPage to create the top part of the
page which displays the chart.
-Inputs:
-
-=over 4
-
-=item $cache The ubiquitous cache
-
-=item $selectedName The name of the currently selected student, or
-'All Students' or 'No Student Selected'.
-
-=item $students Array ref containing the name(s) of the students selected
-for display.
-
-=item $formName The name of the HTML form to use, 'Statistics'
-
-=item $doNotShow Array ref containing the names of columns to not show
-
-=back
+Inputs: None
Returns: A string containing the HTML for the headers and top table for
the chart page.
@@ -271,343 +305,488 @@ the chart page.
#######################################################
#######################################################
sub CreateInterface {
- my($cache,$selectedName,$students,$formName,$doNotShow)=@_;
-
my $Str = '';
- $Str .= &CreateLegend();
- $Str .= '
'."\n";
- $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= ' ';
return $Str;
}
+
#######################################################
#######################################################
=pod
-=item &CreateTableHeadings()
-
-Create HTML for the columns of student data to show.
-Called by &BuildStudentAssessmentPage(). Calls
-&Apache::lonhtmlcommon::CreateHeadings().
-
-Inputs:
-
-=over 4
-
-=item $cache The ubiquitous cache
-
-=item $spacing A string of spaces
-
-=item $infoKeys Array ref to names of keys to display from the cache
-which describe students
-
-=item $infoHeadings Array ref to headings of columns for student info
-
-=item $sequenceKeys Array ref of names of keys to use to retrieve sequence
-data from the cache
-
-=item $sequenceHeadings Array ref of names of sequences used for output.
-
-=back
-
-Returns: A string containing the HTML of the table headings.
+=item &CreateAndParseOutputSelector()
=cut
#######################################################
#######################################################
-sub CreateTableHeadings {
- my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,
- $sequenceHeadings)=@_;
+my @OutputOptions =
+ ({ name => 'HTML, with links',
+ value => 'html, with links',
+ description => 'Output HTML with each symbol linked to the problem '.
+ 'which generated it.',
+ mode => 'html',
+ show_links => 'yes',
+ },
+ { name => 'HTML, with all links',
+ value => 'html, with all links',
+ description => 'Output HTML with each symbol linked to the problem '.
+ 'which generated it. '.
+ 'This includes links for unattempted problems.',
+ mode => 'html',
+ show_links => 'all',
+ },
+ { name => 'HTML, without links',
+ value => 'html, without links',
+ description => 'Output HTML. By not including links, the size of the'.
+ ' web page is greatly reduced. If your browser crashes on the '.
+ 'full display, try this.',
+ mode => 'html',
+ show_links => 'no',
+ },
+ { name => 'Excel',
+ value => 'excel',
+ description => 'Output an Excel file (compatable with Excel 95).',
+ mode => 'excel',
+ show_links => 'no',
+ },
+ { name => 'CSV',
+ value => 'csv',
+ description => 'Output a comma seperated values file suitable for '.
+ 'import into a spreadsheet program. Using this method as opposed '.
+ 'to Excel output allows you to organize your data before importing'.
+ ' it into a spreadsheet program.',
+ mode => 'csv',
+ show_links => 'no',
+ },
+ );
-# my $Str = '     ';
+sub OutputDescriptions {
my $Str = '';
- $Str .= '
\n";
+ return $Str;
+}
-=item &StudentReport()
+sub CreateAndParseOutputDataSelector {
+ my $Str = '';
+ my $elementname = 'chartoutputdata';
+ #
+ my $selected = 'scores';
+ if (exists($ENV{'form.'.$elementname})) {
+ if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
+ $selected = $ENV{'form.'.$elementname}->[0];
+ } else {
+ $selected = $ENV{'form.'.$elementname};
+ }
+ }
+ #
+ $chosen_output = $OutputDataOptions[0];
+ foreach my $option (@OutputDataOptions) {
+ if ($option->{'value'} eq $selected) {
+ $chosen_output = $option;
+ }
+ }
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
-This is the workhorse subroutine - it handles formatting and display of a
-students performance data. It processes one row of the chart.
+}
-Input:
+#######################################################
+#######################################################
-=over 4
+=pod
-=item $cache The ubiquitous cache
+=head2 HTML output routines
-=item $name The name and domain of the current student in name:domain format
+=item &html_initialize($r)
-=item $spacing A string containing spaces.
+Create labels for the columns of student data to show.
-=item $showSequences Array ref containing the sequences to display
+=item &html_outputstudent($r,$student)
-=back
+Return a line of the chart for a student.
-Output: $Str
-
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+=item &html_finish($r)
=cut
#######################################################
#######################################################
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
+{
+ my $padding;
+ my $count;
+
+ my $nodata_count; # The number of students for which there is no data
+ my %prog_state; # progress state used by loncommon PrgWin routines
+
+sub html_initialize {
+ my ($r) = @_;
+ #
+ $padding = ' 'x3;
+ $count = 0;
+ $nodata_count = 0;
+ undef(%prog_state);
+ #
+ $r->print("
\n";
+ # First, the @StudentData fields need to be listed
+ my @to_show = &get_student_fields_to_show();
+ foreach my $field (@to_show) {
+ my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
+ my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
+ my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+ $Str .= $title.' 'x($width-$base).$padding;
+ }
+ # Now the selected sequences need to be listed
+ foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){
+ my $title = $sequence->{'title'};
+ my $base = $sequence->{'base_width'};
+ my $width = $sequence->{'width'};
+ $Str .= $title.' 'x($width-$base).$padding;
+ }
+ $Str .= "total
\n";
+ return $Str;
+}
-#######################################################
-#######################################################
-sub MaxSeqPr {
- my ($cache, $name, $sequence)=@_;
- my $prCount=0;
- foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
- my $problem = $cache->{$problemID.':problem'};
- foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) {
- if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {
- $prCount++;
- next;
- }
- $prCount++;
- }
- }
- return $prCount;
}
#######################################################
@@ -615,81 +794,701 @@ sub MaxSeqPr {
=pod
-=item &CreateLegend()
+=head2 EXCEL subroutines
-This function returns a formatted string containing the legend for the
-chart. The legend describes the symbols used to represent grades for
-problems.
+=item &excel_initialize($r)
+
+=item &excel_outputstudent($r,$student)
+
+=item &excel_finish($r)
=cut
#######################################################
#######################################################
-sub CreateLegend {
- my $Str = "
".
- " 1 correct by student in 1 try\n".
- " 7 correct by student in 7 tries\n".
- " * correct by student in more than 9 tries\n".
- " + correct by hand grading or override\n".
- " - incorrect by override\n".
- " . incorrect attempted\n".
- " # ungraded attempted\n".
- " not attempted (blank field)\n".
- " x excused".
- "
";
- return $Str;
-}
+{
-#######################################################
-#######################################################
+my $excel_sheet;
+my $excel_workbook;
-=pod
+my $filename;
+my $rows_output;
+my $cols_output;
+
+my %prog_state; # progress window state
+my $request_aborted;
+
+my $total_formula;
+
+sub excel_initialize {
+ my ($r) = @_;
+ #
+ undef ($excel_sheet);
+ undef ($excel_workbook);
+ undef ($filename);
+ undef ($rows_output);
+ undef ($cols_output);
+ undef (%prog_state);
+ undef ($request_aborted);
+ undef ($total_formula);
+ #
+ my $total_columns = scalar(&get_student_fields_to_show());
+
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ if ($chosen_output->{'every_problem'}) {
+ $total_columns += $seq->{'num_assess_parts'};
+ }
+ # Add 2 because we need a 'sequence_sum' and 'total' column for each
+ $total_columns += 2;
+ }
+ if ($chosen_output->{'base'} eq 'tries' && $total_columns > 255) {
+ $r->print(<Unable to Complete Request
+
+LON-CAPA is unable to produce your Excel spreadsheet because your selections
+will result in more than 255 columns. Excel allows only 255 columns in a
+spreadsheet.
+
+You may consider reducing the number of Sequences or Folders you
+have selected.
+
+LON-CAPA can produce CSV files of this data or Excel files of the
+summary data (Parts Correct or Parts Correct & Totals).
+
+LON-CAPA is unable to produce your Excel spreadsheet because your selections
+will result in more than 255 columns. Excel allows only 255 columns in a
+spreadsheet.
+
+You may consider reducing the number of Sequences or Folders you
+have selected.
+
+LON-CAPA can produce CSV files of this data or Excel files of the
+Scores Summary data.
+
+END
+ $request_aborted = 1;
+ }
+ return if ($request_aborted);
+ #
+ $filename = '/prtspool/'.
+ $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.xls';
+ #
+ $excel_workbook = undef;
+ $excel_sheet = undef;
+ #
+ $rows_output = 0;
+ $cols_output = 0;
+ #
+ # Create sheet
+ $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
+ #
+ # Check for errors
+ if (! defined($excel_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 ;
+ }
+ #
+ # The excel 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.
+ $excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
+ #
+ # Add a worksheet
+ my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+ $sheetname = &Apache::loncommon::clean_excel_name($sheetname);
+ $excel_sheet = $excel_workbook->addworksheet($sheetname);
+ #
+ # Define some potentially useful formats
+ my $format;
+ $format->{'header'} = $excel_workbook->add_format(bold => 1,
+ bottom => 1,
+ align => 'center');
+ $format->{'bold'} = $excel_workbook->add_format(bold=>1);
+ $format->{'h1'} = $excel_workbook->add_format(bold=>1, size=>18);
+ $format->{'h2'} = $excel_workbook->add_format(bold=>1, size=>16);
+ $format->{'h3'} = $excel_workbook->add_format(bold=>1, size=>14);
+ $format->{'date'} = $excel_workbook->add_format(num_format=>
+ 'mmm d yyyy hh:mm AM/PM');
+ #
+ # Put the course description in the header
+ $excel_sheet->write($rows_output,$cols_output++,
+ $ENV{'course.'.$ENV{'request.course.id'}.'.description'},
+ $format->{'h1'});
+ $cols_output += 3;
+ #
+ # Put a description of the sections listed
+ my $sectionstring = '';
+ my @Sections = @Apache::lonstatistics::SelectedSections;
+ if (scalar(@Sections) > 1) {
+ if (scalar(@Sections) > 2) {
+ my $last = pop(@Sections);
+ $sectionstring = "Sections ".join(', ',@Sections).', and '.$last;
+ } else {
+ $sectionstring = "Sections ".join(' and ',@Sections);
+ }
+ } else {
+ if ($Sections[0] eq 'all') {
+ $sectionstring = "All sections";
+ } else {
+ $sectionstring = "Section ".$Sections[0];
+ }
+ }
+ $excel_sheet->write($rows_output,$cols_output++,$sectionstring,
+ $format->{'h3'});
+ $cols_output += scalar(@Sections);
+ #
+ # Put the date in there too
+ $excel_sheet->write($rows_output++,$cols_output++,
+ 'Compiled on '.localtime(time),$format->{'h3'});
+ #
+ $cols_output = 0;
+ $excel_sheet->write($rows_output++,$cols_output++,
+ $chosen_output->{'shortdesc'},
+ $format->{'h3'});
+ #
+ # Figure out the rows we need
+ my $sequence_name_row = $rows_output+1;
+ my $resource_name_row = $sequence_name_row+1;
+ my $maximum_data_row = $sequence_name_row+2;
+ my $first_data_row = $sequence_name_row+3;
+ #
+ # Add the student headers
+ $cols_output = 0;
+ foreach my $field (&get_student_fields_to_show()) {
+ $excel_sheet->write($resource_name_row,$cols_output++,$field,
+ $format->{'bold'});
+ }
+ #
+ # Add the remaining column headers
+ my $total_formula_string = '=0';
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ $excel_sheet->write($sequence_name_row,,
+ $cols_output,$seq->{'title'},$format->{'h3'});
+ # Determine starting cell
+ $seq->{'Excel:startcell'}=
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$cols_output);
+ $seq->{'Excel:startcol'}=$cols_output;
+ my $count = 0;
+ if ($chosen_output->{'every_problem'}) {
+ # Put the names of the problems and parts into the sheet
+ foreach my $res (@{$seq->{'contents'}}) {
+ if ($res->{'type'} ne 'assessment' ||
+ ! exists($res->{'parts'}) ||
+ ref($res->{'parts'}) ne 'ARRAY' ||
+ scalar(@{$res->{'parts'}}) < 1) {
+ next;
+ }
+ if (scalar(@{$res->{'parts'}}) > 1) {
+ foreach my $part (@{$res->{'parts'}}) {
+ $excel_sheet->write($resource_name_row,
+ $cols_output++,
+ $res->{'title'}.' part '.$part,
+ $format->{'bold'});
+ }
+ } else {
+ $excel_sheet->write($resource_name_row,
+ $cols_output++,
+ $res->{'title'},$format->{'bold'});
+ }
+ $count++;
+ }
+ }
+ # Determine ending cell
+ if ($count <= 1) {
+ $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'};
+ $seq->{'Excel:endcol'} = $seq->{'Excel:startcol'};
+ } else {
+ $seq->{'Excel:endcell'} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$cols_output-1);
+ $seq->{'Excel:endcol'} = $cols_output-1;
+ }
+ # Create the formula for summing up this sequence
+ if (! exists($seq->{'Excel:endcell'}) ||
+ ! defined($seq->{'Excel:endcell'})) {
+ $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'};
+ }
+ $seq->{'Excel:sum'}= $excel_sheet->store_formula
+ ('=SUM('.$seq->{'Excel:startcell'}.
+ ':'.$seq->{'Excel:endcell'}.')');
+ # Determine cell the score is held in
+ $seq->{'Excel:scorecell'} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$cols_output);
+ $seq->{'Excel:scorecol'}=$cols_output;
+ if ($chosen_output->{'base'} eq 'parts correct total') {
+ $excel_sheet->write($resource_name_row,$cols_output++,
+ 'parts correct',
+ $format->{'bold'});
+ } elsif ($chosen_output->{'sequence_sum'}) {
+ if ($chosen_output->{'correct'}) {
+ # Only reporting the number correct, so do not call it score
+ $excel_sheet->write($resource_name_row,$cols_output++,
+ 'sum',
+ $format->{'bold'});
+ } else {
+ $excel_sheet->write($resource_name_row,$cols_output++,
+ 'score',
+ $format->{'bold'});
+ }
+ }
+ #
+ $total_formula_string.='+'.
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$cols_output-1);
+ if ($chosen_output->{'sequence_max'}) {
+ $excel_sheet->write($resource_name_row,$cols_output++,
+ 'maximum',
+ $format->{'bold'});
+ }
+ }
+ if ($chosen_output->{'grand_total'}) {
+ $excel_sheet->write($resource_name_row,$cols_output++,'Total',
+ $format->{'bold'});
+ }
+ $total_formula = $excel_sheet->store_formula($total_formula_string);
+ #
+ # Output a row for MAX, if appropriate
+ if ($chosen_output->{'scores'}) {
+ $cols_output = 0;
+ foreach my $field (&get_student_fields_to_show()) {
+ if ($field eq 'username' || $field eq 'fullname' ||
+ $field eq 'id') {
+ $excel_sheet->write($maximum_data_row,$cols_output++,'Maximum',
+ $format->{'bold'});
+ } else {
+ $excel_sheet->write($maximum_data_row,$cols_output++,'');
+ }
+ }
+ #
+ # Add the maximums for each sequence or assessment
+ my %total_cell_translation;
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ $cols_output=$seq->{'Excel:startcol'};
+ $total_cell_translation{$seq->{'Excel:scorecell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$seq->{'Excel:scorecol'});
+ my $weight;
+ my $max = 0;
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ foreach my $part (@{$resource->{'parts'}}) {
+ $weight = 1;
+ if ($chosen_output->{'scores'}) {
+ $weight = &Apache::lonnet::EXT
+ ('resource.'.$part.'.weight',$resource->{'symb'},
+ undef,undef,undef);
+ if (!defined($weight) || ($weight eq '')) {
+ $weight=1;
+ }
+ }
+ if ($chosen_output->{'scores'} &&
+ $chosen_output->{'every_problem'}) {
+ $excel_sheet->write($maximum_data_row,$cols_output++,
+ $weight);
+ }
+ $max += $weight;
+ }
+ }
+ #
+ if ($chosen_output->{'sequence_sum'} &&
+ $chosen_output->{'every_problem'}) {
+ my %replaceCells;
+ $replaceCells{$seq->{'Excel:startcell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$seq->{'Excel:startcol'});
+ $replaceCells{$seq->{'Excel:endcell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($maximum_data_row,$seq->{'Excel:endcol'});
+ $excel_sheet->repeat_formula($maximum_data_row,$cols_output++,
+ $seq->{'Excel:sum'},undef,
+ %replaceCells);
+ } elsif ($chosen_output->{'sequence_sum'}) {
+ $excel_sheet->write($maximum_data_row,$cols_output++,$max);
+ }
+ if ($chosen_output->{'sequence_max'}) {
+ $excel_sheet->write($maximum_data_row,$cols_output++,$max);
+ }
+ #
+ }
+ if ($chosen_output->{'grand_total'}) {
+ $excel_sheet->repeat_formula($maximum_data_row,$cols_output++,
+ $total_formula,undef,
+ %total_cell_translation);
+ }
+ } # End of MAXIMUM row output if ($chosen_output->{'scores'}) {
+ $rows_output = $first_data_row;
+ #
+ # Let the user know what we are doing
+ my $studentcount = scalar(@Apache::lonstatistics::Students);
+ if ($ENV{'form.SelectedStudent'}) {
+ $studentcount = '1';
+ }
+ if ($studentcount > 1) {
+ $r->print('
'.&mt('Compiling Excel spreadsheet for [_1] students',
+ $studentcount)."
\n");
+ } else {
+ $r->print('
'.
+ &mt('Compiling Excel spreadsheet for 1 student').
+ "
\n");
+ }
+ $r->rflush();
+ #
+ # Initialize progress window
+ %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
+ ($r,'Excel File Compilation Status',
+ 'Excel File Compilation Progress', $studentcount);
+ #
+ &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
+ 'Processing first student');
+ return;
+}
-=item &CreateColumnSelectionBox()
+sub excel_outputstudent {
+ my ($r,$student) = @_;
+ return if ($request_aborted);
+ return if (! defined($excel_sheet));
+ $cols_output=0;
+ #
+ # Write out student data
+ my @to_show = &get_student_fields_to_show();
+ foreach my $field (@to_show) {
+ $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
+ }
+ #
+ # Get student assessment data
+ my %StudentsData;
+ my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
+ $student->{'domain'},
+ undef,
+ $ENV{'request.course.id'});
+ if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
+ %StudentsData = @tmp;
+ }
+ #
+ # Write out sequence scores and totals data
+ my %total_cell_translation;
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ $cols_output = $seq->{'Excel:startcol'};
+ # Keep track of cells to translate in total cell
+ $total_cell_translation{$seq->{'Excel:scorecell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($rows_output,$seq->{'Excel:scorecol'});
+ #
+ my ($performance,$performance_length,$score,$seq_max,$rawdata);
+ if ($chosen_output->{'tries'} || $chosen_output->{'correct'}){
+ ($performance,$performance_length,$score,$seq_max,$rawdata) =
+ &StudentTriesOnSequence($student,\%StudentsData,
+ $seq,'no');
+ } else {
+ ($performance,$performance_length,$score,$seq_max,$rawdata) =
+ &StudentPerformanceOnSequence($student,\%StudentsData,
+ $seq,'no');
+ }
+ if ($chosen_output->{'every_problem'}) {
+ if ($chosen_output->{'correct'}) {
+ # only indiciate if each item is correct or not
+ foreach my $value (@$rawdata) {
+ # nonzero means correct
+ $value = 1 if ($value > 0);
+ $excel_sheet->write($rows_output,$cols_output++,$value);
+ }
+ } else {
+ foreach my $value (@$rawdata) {
+ $excel_sheet->write($rows_output,$cols_output++,$value);
+ }
+ }
+ }
+ if ($chosen_output->{'sequence_sum'} &&
+ $chosen_output->{'every_problem'}) {
+ # Write a formula for the sum of this sequence
+ my %replaceCells;
+ $replaceCells{$seq->{'Excel:startcell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($rows_output,$seq->{'Excel:startcol'});
+ $replaceCells{$seq->{'Excel:endcell'}} =
+ &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
+ ($rows_output,$seq->{'Excel:endcol'});
+ # The undef is for the format
+ if (scalar(keys(%replaceCells)) == 1) {
+ $excel_sheet->repeat_formula($rows_output,$cols_output++,
+ $seq->{'Excel:sum'},undef,
+ %replaceCells,%replaceCells);
+ } else {
+ $excel_sheet->repeat_formula($rows_output,$cols_output++,
+ $seq->{'Excel:sum'},undef,
+ %replaceCells);
+ }
+ } elsif ($chosen_output->{'sequence_sum'}) {
+ $excel_sheet->write($rows_output,$cols_output++,$score);
+ }
+ if ($chosen_output->{'sequence_max'}) {
+ $excel_sheet->write($rows_output,$cols_output++,$seq_max);
+ }
+ }
+ #
+ if ($chosen_output->{'grand_total'}) {
+ $excel_sheet->repeat_formula($rows_output,$cols_output++,
+ $total_formula,undef,
+ %total_cell_translation);
+ }
+ #
+ # Bookkeeping
+ $rows_output++;
+ $cols_output=0;
+ #
+ # Update the progress window
+ &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
+ return;
+}
-If there are columns not being displayed then this selection box is created
-with a list of those columns. When selections are made and the page
-refreshed, the columns will be removed from this box and the column is
-put back in the chart. If there is no columns to select, no row is added
-to the interface table.
+sub excel_finish {
+ my ($r) = @_;
+ return if ($request_aborted);
+ return if (! defined($excel_sheet));
+ #
+ # Write the excel file
+ $excel_workbook->close();
+ my $c = $r->connection();
+ #
+ return if($c->aborted());
+ #
+ # Close the progress window
+ &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
+ #
+ # Tell the user where to get their excel file
+ $r->print(' '.
+ 'Your Excel spreadsheet.'."\n");
+ $r->rflush();
+ return;
+}
-=over 4
-Input: $CacheData, $headings
+}
+#######################################################
+#######################################################
-$CacheData: A pointer to a hash tied to the cached data
+=pod
-$headings: An array of the names of the columns for the student information.
-They are used for displaying which columns are missing.
+=head2 CSV output routines
-Output: $notThere
+=item &csv_initialize($r)
-$notThere: The string contains one row of a table. The first column has the
-name of the selection box. The second contains the selection box
-which has a size of four.
+=item &csv_outputstudent($r,$student)
-=back
+=item &csv_finish($r)
=cut
#######################################################
#######################################################
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
+{
- my $notThere = '';
- $notThere .= '';
+sub csv_finish {
+ my ($r) = @_;
+ return if ($request_aborted);
+ return if (! defined($outputfile));
+ close($outputfile);
+ #
+ my $c = $r->connection();
+ return if ($c->aborted());
+ #
+ # Close the progress window
+ &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
+ #
+ # Tell the user where to get their csv file
+ $r->print(' '.
+ 'Your csv file.'."\n");
+ $r->rflush();
+ return;
+
+}
- return $notThere;
}
#######################################################
@@ -697,25 +1496,19 @@ sub CreateColumnSelectionBox {
=pod
-=item &CreateColumnSelectors()
+=item &StudentTriesOnSequence()
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
+Inputs:
=over 4
-Input: $CacheData, $headings
+=item $student
-$CacheData: A pointer to a hash tied to the cached data
+=item $studentdata Hash ref to all student data
-$headings: An array of the names of the columns for the student
-information. They are used to know what are the student information columns
+=item $seq Hash ref, the sequence we are working on
-Output: $present
-
-$present: The string contains the first row of a table. Each column contains
-a checkbox which is left justified. Currently left justification is used
-for consistency of location over the column in which it presides.
+=item $links if defined we will output links to each resource.
=back
@@ -723,25 +1516,101 @@ for consistency of location over the col
#######################################################
#######################################################
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
-
- my $present = '';
- for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
- $present .= '
'."\n";
+ if ($seq->{'randompick'}) {
+ $max = $seq->{'randompick'};
}
-
- return $present;
+ return ($Str,$performance_length,$sum,$max,\@TriesData);
}
#######################################################
@@ -749,122 +1618,130 @@ sub CreateColumnSelectors {
=pod
-=back
+=item &StudentPerformanceOnSequence()
-=head1 HELPER FUNCTIONS
+Inputs:
=over 4
-=cut
+=item $student
-#######################################################
-#######################################################
-sub FindSelectedStudent {
- my($cache, $selectedName, $students)=@_;
+=item $studentdata Hash ref to all student data
- if($selectedName eq 'All Students' ||
- $selectedName eq 'No Student Selected') {
- return $selectedName;
- }
+=item $seq Hash ref, the sequence we are working on
- for(my $index=0; $index<(scalar @$students); $index++) {
- my $fullname = $cache->{$students->[$index].':fullname'};
- if($fullname eq $selectedName) {
- if($cache->{'StudentAssessmentMove'} eq 'next') {
- if($index == ((scalar @$students) - 1)) {
- $selectedName = $students->[0];
- return $selectedName;
- } else {
- $selectedName = $students->[$index+1];
- return $selectedName;
+=item $links if defined we will output links to each resource.
+
+=back
+
+=cut
+
+#######################################################
+#######################################################
+sub StudentPerformanceOnSequence {
+ my ($student,$studentdata,$seq,$links) = @_;
+ $links = 'no' if (! defined($links));
+ my $Str = ''; # final result string
+ my ($score,$max) = (0,0);
+ my $performance_length = 0;
+ my $symbol;
+ my @ScoreData = ();
+ my $partscore;
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ my $resource_data = $studentdata->{$resource->{'symb'}};
+ foreach my $part (@{$resource->{'parts'}}) {
+ $partscore = undef;
+ my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
+ $resource->{'symb'},
+ $student->{'domain'},
+ $student->{'username'},
+ $student->{'section'});
+ if (!defined($weight) || ($weight eq '')) {
+ $weight=1;
+ }
+ #
+ $max += $weight; # see the 'excused' branch below...
+ $performance_length++; # one character per part
+ $symbol = ' '; # default to space
+ #
+ my $awarded = 0;
+ if (exists($resource_data->{'resource.'.$part.'.awarded'})) {
+ $awarded = $resource_data->{'resource.'.$part.'.awarded'};
+ $awarded = 0 if (! $awarded);
+ }
+ #
+ $partscore = $weight*$awarded;
+ $score += $partscore;
+ $symbol = $partscore;
+ if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) {
+ $symbol = sprintf("%.0f",$symbol);
+ }
+ if (length($symbol) > 1) {
+ $symbol = '*';
+ }
+ if (exists($resource_data->{'resource.'.$part.'.solved'})) {
+ my $status = $resource_data->{'resource.'.$part.'.solved'};
+ if ($status eq 'excused') {
+ $symbol = 'x';
+ $max -= $weight; # Do not count 'excused' problems.
}
- } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {
- if($index == 0) {
- $selectedName = $students->[-1];
- return $selectedName;
+ } else {
+ # Unsolved. Did they try?
+ if (exists($resource_data->{'resource.'.$part.'.tries'})){
+ $symbol = '.';
} else {
- $selectedName = $students->[$index-1];
- return $selectedName;
+ $symbol = ' ';
}
- } else {
- $selectedName = $students->[$index];
- return $selectedName;
}
- last;
+ #
+ if (! defined($partscore)) {
+ $partscore = $symbol;
+ }
+ push (@ScoreData,$partscore);
+ #
+ if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
+ $symbol = ''.$symbol.'';
+ }
+ $Str .= $symbol;
}
}
-
- return 'No Student Selected';
+ return ($Str,$performance_length,$score,$max,\@ScoreData);
}
+
#######################################################
#######################################################
=pod
-=item &ShouldShowColumn()
-
-Determine if a specified column should be shown on the chart.
-
-=over 4
-
-Input: $cache, $test
-
-$cache: A pointer to the hash tied to the cached data
-
-$test: The form name of the column (heading.$headingIndex) or
-(sequence.$sequenceIndex)
+=item &CreateLegend()
-=back
+This function returns a formatted string containing the legend for the
+chart. The legend describes the symbols used to represent grades for
+problems.
=cut
#######################################################
#######################################################
-sub ShouldShowColumns {
- my ($cache,$headings,$cacheKey)=@_;
-
- my @infoKeys=();
- my @infoHeadings=();
-
- my @sequenceKeys=();
- my @sequenceHeadings=();
-
- my %doNotShow;
-
- my $index;
- my $count = 0;
- my $check = '';
- for($index=0; $index < scalar @$headings; $index++) {
- $check = 'HeadingColumn'.$headings->[$index];
- if($cache->{'HeadingsFound'} =~ /$check/) {
- push(@infoHeadings, $headings->[$index]);
- push(@infoKeys, $cacheKey->[$index]);
- } else {
- $doNotShow{$count.':name'} = $headings->[$index];
- $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index];
- $count++;
- }
- }
-
- foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) {
- $check = 'SequenceColumn'.$sequence;
- if($cache->{'SequencesFound'} eq 'All Sequences' ||
- $cache->{'SequencesFound'} =~ /$check/) {
- push(@sequenceHeadings, $cache->{$sequence.':title'});
- push(@sequenceKeys, $sequence);
- } else {
- $doNotShow{$count.':name'} = $cache->{$sequence.':title'};
- $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence;
- $count++;
- }
- }
-
- $doNotShow{'count'} = $count;
-
- return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,
- \@sequenceKeys, \%doNotShow);
+sub CreateLegend {
+ my $Str = "
".
+ " 1 correct by student in 1 try\n".
+ " 7 correct by student in 7 tries\n".
+ " * correct by student in more than 9 tries\n".
+ " + correct by hand grading or override\n".
+ " - incorrect by override\n".
+ " . incorrect attempted\n".
+ " # ungraded attempted\n".
+ " not attempted (blank field)\n".
+ " x excused".
+ "