--- loncom/interface/statistics/lonstudentassessment.pm 2002/09/22 18:24:45 1.12
+++ loncom/interface/statistics/lonstudentassessment.pm 2003/10/29 16:20:14 1.73
@@ -1,12 +1,10 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
#
-# $Id: lonstudentassessment.pm,v 1.12 2002/09/22 18:24:45 minaeibi Exp $
+# $Id: lonstudentassessment.pm,v 1.73 2003/10/29 16:20:14 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
-#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
@@ -26,579 +24,1587 @@
# http://www.lon-capa.org/
#
# (Navigate problems for statistical reports
-# YEAR=2001
-# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei
-# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei
-# YEAR=2002
-# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei
-# 5/12,5/14,5/15,5/19,5/26,7/16 Behrouz Minaei
#
-###
+#######################################################
+#######################################################
+
+=pod
+
+=head1 NAME
+
+lonstudentassessment
+
+=head1 SYNOPSIS
+
+Presents assessment data about a student or a group of students.
+
+=head1 Subroutines
+
+=over 4
+
+=cut
-package Apache::lonstudentassessment;
+#######################################################
+#######################################################
+
+package Apache::lonstudentassessment;
use strict;
+use Apache::lonstatistics;
use Apache::lonhtmlcommon;
use Apache::loncoursedata;
-use GDBM_File;
+use Apache::lonnet; # for logging porpoises
+use Spreadsheet::WriteExcel;
-#my $jr;
+#######################################################
+#######################################################
+=pod
-sub BuildStudentAssessmentPage {
- my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,
- $studentInformation,$r,$c)=@_;
-# $jr = $r;
- my %cache;
- unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
- $r->print('
'."\n";
- $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,
- $sequenceKeys,
- $sequenceHeadings,
- $displayString,
- 'preformatted');
+=item $datadescription A short description of the output data selected.
- $Str .= '
Total Solved/Total Problems
';
- $Str .= '
'."\n";
+=item $base 'tries' or 'scores' determines the base of the performance shown
- return $Str;
-}
+=item $single_student_mode evaluates to true if we are showing only one
+student.
+
+=cut
+
+#######################################################
+#######################################################
+my $show_links;
+my $output_mode;
+my $data;
+my $base;
+my $datadescription;
+my $single_student_mode;
+
+#######################################################
+#######################################################
+# End of package variable declarations
=pod
-=item &FormatStudentData()
+=back
-First, FormatStudentInformation is called and prefixes the course information.
-This function produces a formatted string of the student's course information.
-Each column of data represents all the problems for a given sequence. For
-valid grade data, a link is created for that problem to a submission record
-for that problem.
+=cut
-=over 4
+#######################################################
+#######################################################
-Input: $name, $studentInformation, $ChartDB
+=pod
-$name: The name and domain of the current student in name:domain format
+=item &BuildStudentAssessmentPage()
-$studentInformation: A pointer to an array holding the names used to
-remove data from the hash. They represent
-the name of the data to be removed.
+Inputs:
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+=over 4
-Output: $Str
+=item $r Apache Request
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+=item $c Apache Connection
=back
=cut
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
+#######################################################
+#######################################################
+sub BuildStudentAssessmentPage {
+ my ($r,$c)=@_;
- my $Str = '';
- if(defined($cache->{$name.':error'})) {
- return $Str;
+ undef($Statistics);
+ undef($show_links);
+ undef($output_mode);
+ undef($data);
+ undef($base);
+ undef($datadescription);
+ undef($single_student_mode);
+
+ $single_student_mode = 0;
+ $single_student_mode = 1 if ($ENV{'form.SelectedStudent'});
+ if ($ENV{'form.selectstudent'}) {
+ &Apache::lonstatistics::DisplayClasslist($r);
+ return;
}
- if($cache->{$name.':error'} =~ /course/) {
- $Str .= 'No course data for student ';
- $Str .= ''.$username.'. ';
- return $Str;
- }
-
- my $hasVersion = 'false';
- my $hasFinalData = 'false';
- foreach my $sequence (@$showSequences) {
- my $hasData = 'false';
- my $characterCount=0;
- foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
- my $problem = $cache->{$problemID.':problem'};
- # All grades (except for versionless parts) are displayed as links
- # to their submission record. Loop through all the parts for the
- # current problem in the correct order and prepare the output links
- foreach(split(/\:/,$cache->{$sequence.':'.$problemID.
- ':parts'})) {
- if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {
- $Str .= ' ';
- $characterCount++;
- next;
- }
- $hasVersion = 'true';
- $hasData = 'true';
- $Str .= '';
- my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};
- my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};
- if($code eq '*' && $tries < 10 && $tries ne '') {
- $code = $tries;
- }
- $Str .= $code;
- $Str .= '';
- $characterCount++;
- }
+ #
+ # 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);
+ }
+ # Call the "finish" routine selected above
+ $finish->($r);
+ #
+ return;
+}
- # Output the number of correct answers for the current sequence.
- # This part takes up 6 character slots, but is formated right
- # justified.
- my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;
- $spacesNeeded -= 3;
- $Str .= (' 'x$spacesNeeded);
-
- my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence.
- ':problemsCorrect'});
- if($hasData eq 'true') {
- $Str .= ''.$outputProblemsCorrect.'';
- $hasFinalData = 'true';
- } else {
- $Str .= ' ';
- }
- $Str .= $spacing;
- }
-
- # Output the total correct problems over the total number of problems.
- # I don't like this type of formatting, but it is a solution. Need
- # a way to dynamically determine the space requirements.
- my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'});
- my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'});
- if($hasFinalData eq 'true') {
- $Str .= ''.$outputProblemsSolved.
- ' / '.$outputTotalProblems.'';
+#######################################################
+#######################################################
+sub next_and_previous_buttons {
+ my $Str = '';
+ $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 {
- $Str .= ' ';
+ $previousbutton .= '';
}
-
- if($hasVersion eq 'false') {
- $Str = 'No course data.';
+ #
+ # Build the next student link
+ my $next = &Apache::lonstatistics::next_student();
+ my $nextbutton = '';
+ if (defined($next)) {
+ my $sname = $next->{'username'}.':'.$next->{'domain'};
+ $nextbutton .= '';
+ } else {
+ $nextbutton .= '';
}
-
+ #
+ # 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;
+}
+
+#######################################################
+#######################################################
+
=pod
-=item &CreateLegend()
+=item &CreateInterface()
-This function returns a formatted string containing the legend for the
-chart. The legend describes the symbols used to represent grades for
-problems.
+Called by &BuildStudentAssessmentPage to create the top part of the
+page which displays the chart.
+
+Inputs: None
+
+Returns: A string containing the HTML for the headers and top table for
+the chart page.
=cut
-sub CreateLegend {
- my $Str = "
".
- "1..9 correct by student in 1..9 tries\n".
- " * correct by student in more than 9 tries\n".
- " + correct by override\n".
- " - incorrect by override\n".
- " . incorrect attempted\n".
- " # ungraded attempted\n".
- " not attempted\n".
- " x excused".
- "
'."\n";
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= ' ';
return $Str;
}
+#######################################################
+#######################################################
+
=pod
-=item &CreateColumnSelectionBox()
+=item &CreateAndParseOutputSelector()
-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.
+=cut
-=over 4
-Input: $CacheData, $headings
+#######################################################
+#######################################################
+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',
+ },
+ );
+
+sub OutputDescriptions {
+ my $Str = '';
+ $Str .= "
Output Formats
\n";
+ $Str .= "
\n";
+ foreach my $outputmode (@OutputOptions) {
+ $Str .="
".$outputmode->{'name'}."
\n";
+ $Str .="
".$outputmode->{'description'}."
\n";
+ }
+ $Str .= "
\n";
+ return $Str;
+}
+
+sub CreateAndParseOutputSelector {
+ my $Str = '';
+ my $elementname = 'chartoutputmode';
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
+ [$elementname]);
+ #
+ # Format for output options is 'mode, restrictions';
+ my $selected = 'html, without links';
+ if (exists($ENV{'form.'.$elementname})) {
+ if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
+ $selected = $ENV{'form.'.$elementname}->[0];
+ } else {
+ $selected = $ENV{'form.'.$elementname};
+ }
+ }
+ #
+ # Set package variables describing output mode
+ $show_links = 'no';
+ $output_mode = 'html';
+ foreach my $option (@OutputOptions) {
+ next if ($option->{'value'} ne $selected);
+ $output_mode = $option->{'mode'};
+ $show_links = $option->{'show_links'};
+ }
+
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
+}
+
+##
+## Data selector stuff
+##
+my @OutputDataOptions =
+ (
+ { name => 'Scores Summary',
+ base => 'scores',
+ value => 'sum and total',
+ shortdesc => 'Total Score and Maximum Possible for each '.
+ 'Sequence or Folder',
+ longdesc => 'The score of each student as well as the '.
+ ' maximum possible on each Sequence or Folder.',
+ },
+ { name => 'Scores Per Problem',
+ base => 'scores',
+ value => 'scores',
+ shortdesc => 'Score on each Problem Part',
+ longdesc =>'The students score on each problem part, computed as'.
+ 'the part weight * part awarded',
+ },
+# { name => 'Scores Sum',
+# base => 'scores',
+# value => 'sum only',
+# shortdesc => 'Sum of Scores on each Problem Part',
+# longdesc =>'The total of the scores of the student on each problem'.
+# ' part in the sequences or folders selected.',
+# },
+# { name => 'Scores Summary Table Only',
+# base => 'scores',
+# value => 'final table scores',
+# shortdesc => 'Summary of Scores',
+# longdesc => 'The average score on each sequence or folder for the '.
+# 'selected students.',
+# },
+ { name =>'Tries',
+ base =>'tries',
+ value => 'tries',
+ shortdesc => 'Number of Tries before success on each Problem Part',
+ longdesc =>'The number of tries before success on each problem part.',
+ },
+ { name =>'Parts Correct',
+ base =>'tries',
+ value => 'parts correct total',
+ shortdesc => 'Number of Problem Parts completed successfully.',
+ longdesc => 'The Number of Problem Parts completed successfully and '.
+ 'the maximum possible for each student',
+ },
+# { name =>'Parts Correct',
+# base =>'tries',
+# value => 'parts correct',
+# shortdesc => 'Number of Problem Parts completed successfully.',
+# longdesc => 'The Number of Problem Parts completed successfully'.
+# ' on each sequence or folder.',
+# },
+# { name => 'Parts Summary Table Only',
+# base => 'tries',
+# value => 'final table parts',
+# shortdesc => 'Summary of Parts Correct',
+# longdesc => 'A summary table of the average number of problem parts '.
+# 'students were able to get correct on each sequence.',
+# },
+ );
+sub HTMLifyOutputDataDescriptions {
+ my $Str = '';
+ $Str .= "
\n";
+ return $Str;
+}
-$CacheData: A pointer to a hash tied to the cached data
+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};
+ }
+ }
+ #
+ $data = 'scores';
+ foreach my $option (@OutputDataOptions) {
+ if ($option->{'value'} eq $selected) {
+ $data = $option->{'value'};
+ $base = $option->{'base'};
+ $datadescription = $option->{'shortdesc'};
+ }
+ }
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
-$headings: An array of the names of the columns for the student information.
-They are used for displaying which columns are missing.
+}
-Output: $notThere
+#######################################################
+#######################################################
-$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.
+=pod
-=back
+=head2 HTML output routines
+
+=item &html_initialize($r)
+
+Create labels for the columns of student data to show.
+
+=item &html_outputstudent($r,$student)
+
+Return a line of the chart for a student.
+
+=item &html_finish($r)
=cut
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
+#######################################################
+#######################################################
+{
+ 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("
");
+ }
+ #
+ # Set up progress window for 'final table' display only
+ if ($data =~ /^final table/) {
+ my $studentcount = scalar(@Apache::lonstatistics::Students);
+ %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
+ ($r,'Summary Table Status',
+ 'Summary Table Compilation Progress', $studentcount);
+ }
+ my $Str = "
\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;
+}
- return $notThere;
}
+#######################################################
+#######################################################
+
=pod
-=item &CreateColumnSelectors()
+=head2 EXCEL subroutines
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
+=item &excel_initialize($r)
-=over 4
+=item &excel_outputstudent($r,$student)
-Input: $CacheData, $headings
+=item &excel_finish($r)
-$CacheData: A pointer to a hash tied to the cached data
+=cut
-$headings: An array of the names of the columns for the student
-information. They are used to know what are the student information columns
+#######################################################
+#######################################################
+{
+
+my $excel_sheet;
+my $excel_workbook;
+
+my $filename;
+my $rows_output;
+my $cols_output;
+
+my %prog_state; # progress window state
+my $request_aborted;
+
+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);
+ #
+ my $total_columns = scalar(&get_student_fields_to_show());
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ # Add 2 because we need a 'sum' and 'total' column for each
+ $total_columns += $seq->{'num_assess_parts'}+2;
+ }
+ if ($data 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
+summary data (Scores Sum or Scores Sum & Totals).
+
+END
+ $request_aborted = 1;
+ }
+ if ($data =~ /^final table/) {
+ $r->print(<Unable to Complete Request
+
+The Summary Table (Scores) option is not available for non-HTML output.
+
+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);
+ #
+ # Put the course description in the header
+ $excel_sheet->write($rows_output,$cols_output++,
+ $ENV{'course.'.$ENV{'request.course.id'}.'.description'});
+ $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);
+ $cols_output += scalar(@Sections);
+ #
+ # Put the date in there too
+ $excel_sheet->write($rows_output++,$cols_output++,
+ 'Compiled on '.localtime(time));
+ #
+ $cols_output = 0;
+ $excel_sheet->write($rows_output++,$cols_output++,$datadescription);
+ #
+ if ($data eq 'tries' || $data eq 'scores') {
+ $rows_output++;
+ }
+ #
+ # Add the student headers
+ $cols_output = 0;
+ foreach my $field (&get_student_fields_to_show()) {
+ $excel_sheet->write($rows_output,$cols_output++,$field);
+ }
+ my $row_offset = 0;
+ if ($data eq 'tries' || $data eq 'scores') {
+ $row_offset = -1;
+ }
+ #
+ # Add the remaining column headers
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ $excel_sheet->write($rows_output+$row_offset,
+ $cols_output,$seq->{'title'});
+ if ($data eq 'tries' || $data eq 'scores') {
+ foreach my $res (@{$seq->{'contents'}}) {
+ next if ($res->{'type'} ne 'assessment');
+ if (scalar(@{$res->{'parts'}}) > 1) {
+ foreach my $part (@{$res->{'parts'}}) {
+ $excel_sheet->write($rows_output,
+ $cols_output++,
+ $res->{'title'}.' part '.$part);
+ }
+ } else {
+ $excel_sheet->write($rows_output,
+ $cols_output++,
+ $res->{'title'});
+ }
+ }
+ $excel_sheet->write($rows_output,$cols_output++,'score');
+ $excel_sheet->write($rows_output,$cols_output++,'maximum');
+ } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
+ $excel_sheet->write($rows_output+1,$cols_output,'score');
+ $excel_sheet->write($rows_output+1,$cols_output+1,'maximum');
+ $cols_output += 2;
+ } else {
+ $cols_output++;
+ }
+ }
+ #
+ # Bookkeeping
+ if ($data eq 'sum and total' || $data eq 'parts correct total') {
+ $rows_output += 2;
+ } else {
+ $rows_output += 1;
+ }
+ #
+ # Output a row for MAX
+ $cols_output = 0;
+ foreach my $field (&get_student_fields_to_show()) {
+ if ($field eq 'username' || $field eq 'fullname' ||
+ $field eq 'id') {
+ $excel_sheet->write($rows_output,$cols_output++,'Maximum');
+ } else {
+ $excel_sheet->write($rows_output,$cols_output++,'');
+ }
+ }
+ #
+ # Add the maximums for each sequence or assessment
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ my $weight;
+ my $max = 0;
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ foreach my $part (@{$resource->{'parts'}}) {
+ $weight = 1;
+ if ($base eq 'scores') {
+ $weight = &Apache::lonnet::EXT
+ ('resource.'.$part.'.weight',$resource->{'symb'},
+ undef,undef,undef);
+ if (!defined($weight) || ($weight eq '')) {
+ $weight=1;
+ }
+ }
+ if ($data eq 'scores') {
+ $excel_sheet->write($rows_output,$cols_output++,$weight);
+ } elsif ($data eq 'tries') {
+ $excel_sheet->write($rows_output,$cols_output++,'');
+ }
+ $max += $weight;
+ }
+ }
+ if (! ($data eq 'sum only' || $data eq 'parts correct')) {
+ $excel_sheet->write($rows_output,$cols_output++,'');
+ }
+ $excel_sheet->write($rows_output,$cols_output++,$max);
+ }
+ $rows_output++;
+ #
+ # Let the user know what we are doing
+ my $studentcount = scalar(@Apache::lonstatistics::Students);
+ $r->print("
Compiling Excel spreadsheet for ".
+ $studentcount.' student');
+ $r->print('s') if ($studentcount > 1);
+ $r->print("
\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;
+}
-Output: $present
+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
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ my ($performance,$performance_length,$score,$seq_max,$rawdata);
+ if ($base eq 'tries') {
+ ($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 ($data eq 'tries' || $data eq 'scores') {
+ foreach my $value (@$rawdata) {
+ $excel_sheet->write($rows_output,$cols_output++,$value);
+ }
+ $excel_sheet->write($rows_output,$cols_output++,$score);
+ $excel_sheet->write($rows_output,$cols_output++,$seq_max);
+ } elsif ($data eq 'sum and total' || $data eq 'sum only' ||
+ $data eq 'parts correct' || $data eq 'parts correct total') {
+ $excel_sheet->write($rows_output,$cols_output++,$score);
+ }
+ if ($data eq 'sum and total' || $data eq 'parts correct total') {
+ $excel_sheet->write($rows_output,$cols_output++,$seq_max);
+ }
+ }
+ #
+ # Bookkeeping
+ $rows_output++;
+ $cols_output=0;
+ #
+ # Update the progress window
+ &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
+ return;
+}
+
+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;
+}
-$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.
+}
+#######################################################
+#######################################################
-=back
+=pod
+
+=head2 CSV output routines
+
+=item &csv_initialize($r)
+
+=item &csv_outputstudent($r,$student)
+
+=item &csv_finish($r)
=cut
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
+#######################################################
+#######################################################
+{
+
+my $outputfile;
+my $filename;
+my $request_aborted;
+my %prog_state; # progress window state
+
+sub csv_initialize{
+ my ($r) = @_;
+ #
+ # Clean up
+ undef($outputfile);
+ undef($filename);
+ undef($request_aborted);
+ undef(%prog_state);
+ #
+ # Deal with unimplemented requests
+ $request_aborted = undef;
+ if ($data =~ /final table/) {
+ $r->print(<Unable to Complete Request
+
+The Summary Table (Scores) option is not available for non-HTML output.
+
'."\n";
+sub csv_outputstudent {
+ my ($r,$student) = @_;
+ return if ($request_aborted);
+ return if (! defined($outputfile));
+ my $Str = '';
+ #
+ # Output student fields
+ my @to_show = &get_student_fields_to_show();
+ foreach my $field (@to_show) {
+ $Str .= '"'.&Apache::loncommon::csv_translate($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;
}
+ #
+ # Output performance data
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ my ($performance,$performance_length,$score,$seq_max,$rawdata);
+ if ($base eq 'tries') {
+ ($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 ($data eq 'sum only' || $data eq 'parts correct') {
+ $Str .= '"'.$score.'",';
+ } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
+ $Str .= '"'.$score.'","'.$seq_max.'",';
+ } elsif ($data eq 'scores' || $data eq 'tries') {
+ $Str .= '"'.join('","',(@$rawdata,$score,$seq_max)).'",';
+ }
+ }
+ chop($Str);
+ $Str .= "\n";
+ print $outputfile $Str;
+ #
+ # Update the progress window
+ &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
+ return;
+}
+
+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 $present;
}
-#---- END Student Assessment Web Page ----------------------------------------
+#######################################################
+#######################################################
-#---- Student Assessment Worker Functions ------------------------------------
+=pod
-sub FindSelectedStudent {
- my($cache, $selectedName, $students)=@_;
+=item &StudentTriesOnSequence()
- if($selectedName eq 'All Students' ||
- $selectedName eq 'No Student Selected') {
- return $selectedName;
- }
+Inputs:
- 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;
+=over 4
+
+=item $student
+
+=item $studentdata Hash ref to all student data
+
+=item $seq Hash ref, the sequence we are working on
+
+=item $links if defined we will output links to each resource.
+
+=back
+
+=cut
+
+#######################################################
+#######################################################
+sub StudentTriesOnSequence {
+ my ($student,$studentdata,$seq,$links) = @_;
+ $links = 'no' if (! defined($links));
+ my $Str = '';
+ my ($sum,$max) = (0,0);
+ my $performance_length = 0;
+ my @TriesData = ();
+ my $tries;
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ my $resource_data = $studentdata->{$resource->{'symb'}};
+ my $value = '';
+ foreach my $partnum (@{$resource->{'parts'}}) {
+ $tries = undef;
+ $max++;
+ $performance_length++;
+ my $symbol = ' '; # default to space
+ #
+ if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
+ my $status = $resource_data->{'resource.'.$partnum.'.solved'};
+ if ($status eq 'correct_by_override') {
+ $symbol = '+';
+ $sum++;
+ } elsif ($status eq 'incorrect_by_override') {
+ $symbol = '-';
+ } elsif ($status eq 'ungraded_attempted') {
+ $symbol = '#';
+ } elsif ($status eq 'incorrect_attempted') {
+ $symbol = '.';
+ } elsif ($status eq 'excused') {
+ $symbol = 'x';
+ $max--;
+ } elsif (($status eq 'correct_by_scantron' ||
+ $status eq 'correct_by_student') &&
+ exists($resource_data->{'resource.'.$partnum.'.tries'})){
+ $tries = $resource_data->{'resource.'.$partnum.'.tries'};
+ if ($tries > 9) {
+ $symbol = '*';
+ } elsif ($tries > 0) {
+ $symbol = $tries;
+ } else {
+ $symbol = ' ';
+ }
+ $sum++;
+ } elsif (exists($resource_data->{'resource.'.
+ $partnum.'.tries'})){
+ $symbol = '.';
} else {
- $selectedName = $students->[$index+1];
- return $selectedName;
+ $symbol = ' ';
}
- } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {
- if($index == 0) {
- $selectedName = $students->[-1];
- return $selectedName;
+ } else {
+ # Unsolved. Did they try?
+ if (exists($resource_data->{'resource.'.$partnum.'.tries'})){
+ $symbol = '.';
} else {
- $selectedName = $students->[$index-1];
- return $selectedName;
+ $symbol = ' ';
}
- } else {
- $selectedName = $students->[$index];
- return $selectedName;
}
- last;
+ #
+ if (! defined($tries)) {
+ $tries = $symbol;
+ }
+ push (@TriesData,$tries);
+ #
+ if ( ($links eq 'yes' && $symbol ne ' ') ||
+ ($links eq 'all')) {
+ if (length($symbol) > 1) {
+ &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
+ }
+ $symbol = ''.$symbol.'';
+ }
+ $value .= $symbol;
}
+ $Str .= $value;
}
-
- return 'No Student Selected';
+ if ($seq->{'randompick'}) {
+ $max = $seq->{'randompick'};
+ }
+ return ($Str,$performance_length,$sum,$max,\@TriesData);
}
+#######################################################
+#######################################################
+
=pod
-=item &ShouldShowColumn()
+=item &StudentPerformanceOnSequence()
-Determine if a specified column should be shown on the chart.
+Inputs:
=over 4
-Input: $cache, $test
+=item $student
-$cache: A pointer to the hash tied to the cached data
+=item $studentdata Hash ref to all student data
-$test: The form name of the column (heading.$headingIndex) or
-(sequence.$sequenceIndex)
+=item $seq Hash ref, the sequence we are working on
-Output: 0 (false), 1 (true)
+=item $links if defined we will output links to each resource.
=back
=cut
-sub ShouldShowColumns {
- my ($cache,$headings,$cacheKey)=@_;
-
- my @infoKeys=();
- my @infoHeadings=();
+#######################################################
+#######################################################
+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.
+ }
+ } else {
+ # Unsolved. Did they try?
+ if (exists($resource_data->{'resource.'.$part.'.tries'})){
+ $symbol = '.';
+ } else {
+ $symbol = ' ';
+ }
+ }
+ #
+ if (! defined($partscore)) {
+ $partscore = $symbol;
+ }
+ push (@ScoreData,$partscore);
+ #
+ if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
+ $symbol = ''.$symbol.'';
+ }
+ $Str .= $symbol;
+ }
+ }
+ return ($Str,$performance_length,$score,$max,\@ScoreData);
+}
- my @sequenceKeys=();
- my @sequenceHeadings=();
+#######################################################
+#######################################################
- my %doNotShow;
+=pod
- 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++;
- }
- }
+=item &CreateLegend()
- 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++;
- }
- }
+This function returns a formatted string containing the legend for the
+chart. The legend describes the symbols used to represent grades for
+problems.
- $doNotShow{'count'} = $count;
+=cut
- 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".
+ "