'."\n";
+#######################################################
+#######################################################
+my @OutputOptions =
+ ({ name => 'HTML, with links',
+ value => 'html, with links',
+ description => 'Output HTML with each symbol linked to the problem '.
+ 'which generated it.'},
+ { 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.'},
+ { name => 'HTML, scores only',
+ value => 'html, scores only',
+ description => 'Output HTML, only showing the total number of correct'.
+ ' problems (or problem parts) and not the maximum possible for '.
+ 'each student'},
+ { name => 'HTML, totals',
+ value => 'html, totals',
+ description => 'Output HTML, but only the summary statistics for each'.
+ ' sequence selected.'},
+ { name => 'Excel, scores only',
+ value => 'excel, scores only',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with a single column for each sequence showing the students '.
+ 'score.'},
+# { name => 'Excel, everything',
+# value => 'excel, everything',
+# description => 'Output an Excel file (compatable with Excel 95), '.
+# 'with a seperate worksheet for each sequence you have selected '.
+# 'the data for each problem part '.
+# '(number of tries, status, points awarded) '.
+# 'will be listed.'},
+ { name => 'Excel, totals',
+ value => 'excel, totals',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with two columns for each sequence, the students score on the '.
+ 'sequence and the students maximum possible on the sequence'},
+ { name => 'CSV, everything',
+ value => 'csv, everything',
+ description => ''},
+ { name => 'CSV, scores only',
+ value => 'csv, scores only',
+ description => ''},
+ { name => 'CSV, totals',
+ value => 'csv, totals',
+ description => ''},
+ );
+sub OutputDescriptions {
+ my $Str = '';
+ $Str .= "
Output Modes
\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 = 'outputmode';
+ #
+ # Format for output options is 'mode, restrictions';
+ my $selected = 'html, with 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';
+ $show = 'all';
+ my ($mode,$restriction) = split(',',$selected);
+ $restriction =~ s/^\s*//;
+ if ($mode =~ /^(html|excel|csv)$/) {
+ $output_mode = $mode;
+ } else {
+ $output_mode = 'html';
+ }
+ if ($restriction eq 'with links') {
+ $show_links = 'yes';
+ } else {
+ $show_links = 'no';
+ }
+ if ($restriction eq 'totals') {
+ $show = 'totals';
+ } elsif ($restriction eq 'scores only') {
+ $show = 'scores';
+ } else {
+ $show = 'everything';
+ }
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
+}
+
+#######################################################
+#######################################################
+
=pod
-=item &FormatStudentData()
+=head2 HTML output routines
-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.
+=item &html_initialize($r)
-=over 4
+Create labels for the columns of student data to show.
+
+=item &html_outputstudent($r,$student)
-Input: $name, $studentInformation, $ChartDB
+Return a line of the chart for a student.
-$name: The name and domain of the current student in name:domain format
+=item &html_finish($r)
-$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.
+=cut
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+#######################################################
+#######################################################
+{
+ my $padding;
+ my $count;
+
+sub html_initialize {
+ my ($r) = @_;
+ #
+ $padding = ' 'x3;
+ $count = 1;
+ #
+ 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 (&get_sequences_to_show) {
+ my $title = $sequence->{'title'};
+ my $base = $sequence->{'base_width'};
+ my $width = $sequence->{'width'};
+ $Str .= $title.' 'x($width-$base).$padding;
+ }
+ $Str .= "total (of shown problems)
\n";
+ $Str .= "
";
+ $r->print($Str);
+ $r->rflush();
+ return;
+}
-Output: $Str
+sub html_outputstudent {
+ my ($r,$student) = @_;
+ my $Str = '';
+ # First, the @StudentData fields need to be listed
+ my @to_show = &get_student_fields_to_show();
+ foreach my $field (@to_show) {
+ my $title=$student->{$field};
+ my $base = length($title);
+ my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+ $Str .= $title.' 'x($width-$base).$padding;
+ }
+ # Get ALL the students 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;
+ }
+ if (scalar(@tmp) < 1) {
+ $Str .= 'No Course Data'."\n";
+ $r->print($Str);
+ $r->rflush();
+ return;
+ }
+ #
+ # By sequence build up the data
+ my $studentstats;
+ my $PerformanceStr = '';
+ foreach my $seq (&get_sequences_to_show) {
+ my ($performance,$score,$seq_max) =
+ &StudentPerformanceOnSequence($student,\%StudentsData,
+ $seq,$show_links);
+ my $ratio = $score.'/'.$seq_max;
+ #
+ if ($show eq 'totals') {
+ $performance = ' 'x(length($seq_max)-length($score)).$ratio;
+ $performance .= ' 'x($seq->{'width'}-length($performance));
+ } elsif ($show eq 'scores') {
+ $performance = $score;
+ $performance .= ' 'x($seq->{'width'}-length($performance));
+ } else {
+ # Pad with extra spaces
+ $performance .= ' 'x($seq->{'width'}-$seq_max-
+ length($ratio)
+ ).$ratio;
+ }
+ #
+ $Str .= $performance.$padding;
+ #
+ $studentstats->{$seq->{'symb'}}->{'score'}= $score;
+ $studentstats->{$seq->{'symb'}}->{'max'} = $seq_max;
+ }
+ #
+ # Total it up and store the statistics info.
+ my ($score,$max) = (0,0);
+ while (my ($symb,$seq_stats) = each (%{$studentstats})) {
+ $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
+ $Statistics->{$symb}->{'max'} += $seq_stats->{'max'};
+ $score += $seq_stats->{'score'};
+ $max += $seq_stats->{'max'};
+ }
+ $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
+ $Str .= " \n";
+ $r->print($Str);
+ #
+ $count++;
+ if($count % 5 == 0) {
+ $r->print("
");
+ }
+ #
+ $r->rflush();
+ return;
+}
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+sub html_finish {
+ my ($r) = @_;
+ $r->print("
\n");
+ $r->rflush();
+ return;
+}
-=back
+}
-=cut
+#######################################################
+#######################################################
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
+=pod
- my $Str = '';
- if(defined($cache->{$name.':error'})) {
- return $Str;
+=head2 EXCEL subroutines
+
+=item &excel_initialize($r)
+
+=item &excel_outputstudent($r,$student)
+
+=item &excel_finish($r)
+
+=cut
+
+#######################################################
+#######################################################
+{
+
+my $excel_sheet;
+my $excel_workbook;
+
+my $filename;
+my $rows_output;
+my $cols_output;
+
+my $num_students;
+my $start_time;
+
+sub excel_initialize {
+ my ($r) = @_;
+ #
+ $filename = '/prtspool/'.
+ $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.xls';
+ #
+ $excel_workbook = undef;
+ $excel_sheet = undef;
+ #
+ $rows_output = 0;
+ $cols_output = 0;
+ #
+ $num_students = 0;
+ $start_time = time;
+ #
+ # 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'};
+ if (length($sheetname) > 31) {
+ $sheetname = substr($sheetname,0,31);
+ }
+ $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];
+ }
}
- 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';
- if (lc($ENV{'form.displaymode'}) ne 'display without links') {
- $Str .= '';
- }
- my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};
- my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};
- if($code eq '*' && $tries < 10 && $tries ne '') {
- $code = $tries;
- }
- $Str .= $code;
- if (lc($ENV{'form.displaymode'}) ne 'display without links') {
- $Str .= '';
- }
- $characterCount++;
- }
+ $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));
+ #
+ $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);
+ }
+ #
+ # Add the Sequence Headers
+ foreach my $seq (&get_sequences_to_show) {
+ $excel_sheet->write($rows_output,$cols_output,$seq->{'title'});
+ if ($show eq 'totals') {
+ $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 ($show eq 'totals') {
+ $rows_output += 2;
+ } else {
+ $rows_output += 1;
+ }
+ #
+ # 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();
+ #
+ 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'});
-
- my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence.
- ':problemsCorrect'},
- $characterCount);
- if($hasData eq 'true') {
- $Str .= ''.$outputProblemsCorrect.'';
- $hasFinalData = 'true';
+sub excel_outputstudent {
+ my ($r,$student) = @_;
+ 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 (&get_sequences_to_show) {
+ my ($performance,$score,$seq_max) =
+ &StudentPerformanceOnSequence($student,\%StudentsData,
+ $seq,'no');
+ if ($show eq 'totals' || $show eq 'scores') {
+ $excel_sheet->write($rows_output,$cols_output++,$score);
+ }
+ if ($show eq 'totals') {
+ $excel_sheet->write($rows_output,$cols_output++,$seq_max);
+ }
+ }
+ #
+ # Bookkeeping
+ $rows_output++;
+ $cols_output=0;
+ #
+ # Time estimate
+ $num_students++;
+ if ($num_students % 10 == 0) {
+ my $time_est = (time - $start_time)/$num_students *
+ (scalar(@Apache::lonstatistics::Students)-$num_students);
+ $time_est = int($time_est);
+ if (int ($time_est/60) > 0) {
+ my $min = int($time_est/60);
+ my $sec = $time_est % 60;
+ $time_est = $min.' minutes';
+ if ($sec > 1) {
+ $time_est.= ', '.$sec.' seconds';
+ } elsif ($sec > 0) {
+ $time_est.= ', '.$sec.' second';
+ }
} else {
- $Str .= ' ';
+ $time_est .= ' seconds';
}
- $Str .= $spacing;
+ $r->print($num_students.' out of '.
+ (scalar(@Apache::lonstatistics::Students)).
+ " students processed. ".
+ $time_est." remain. Elapsed: ".(time - $start_time).
+ " \n");
+ $r->rflush();
}
+ return;
+}
- # 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.'';
- } else {
- $Str .= ' ';
+sub excel_finish {
+ my ($r) = @_;
+ return if (! defined($excel_sheet));
+ #
+ # Write the excel file
+ $excel_workbook->close();
+ my $c = $r->connection();
+ #
+ return if($c->aborted());
+ #
+ # Tell the user where to get their excel file
+ $r->print('
");
+ return;
+}
+
+sub csv_outputstudent {
+ my ($r,$student) = @_;
+}
+
+sub csv_finish {
+ my ($r) = @_;
}
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &StudentPerformanceOnSequence()
+
+Inputs:
+
+=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 StudentPerformanceOnSequence {
+ my ($student,$studentdata,$seq,$links) = @_;
+ $links = 'no' if (! defined($links));
+ my $Str = '';
+ my ($sum,$max) = (0,0);
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ my $resource_data = $studentdata->{$resource->{'symb'}};
+ my $value = '';
+ foreach my $partnum (@{$resource->{'parts'}}) {
+ $max++;
+ 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_student' &&
+ exists($resource_data->{'resource.'.$partnum.'.tries'})){
+ my $num = $resource_data->{'resource.'.$partnum.'.tries'};
+ if ($num > 9) {
+ $symbol = '*';
+ } elsif ($num > 0) {
+ $symbol = $num;
+ } else {
+ $symbol = ' ';
+ }
+ $sum++;
+ } else {
+ $symbol = ' ';
+ }
+ } else {
+ # Unsolved. Did they try?
+ if (exists($resource_data->{'resource.'.$partnum.'.tries'})){
+ $symbol = '.';
+ } else {
+ $symbol = ' ';
+ }
+ }
+ #
+ if ($links eq 'yes' && $symbol ne ' ') {
+ $symbol = ''.$symbol.'';
+ }
+ $value .= $symbol;
+ }
+ $Str .= $value;
+ }
+ return ($Str,$sum,$max);
+}
+
+#######################################################
+#######################################################
sub StudentAverageTotal {
my ($cache, $students, $sequenceKeys)=@_;
my $Str = "\nSummary Tables:\n";
@@ -467,29 +930,8 @@ sub StudentAverageTotal {
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;
-}
-
-
-
-
+#######################################################
+#######################################################
=pod
@@ -501,6 +943,8 @@ problems.
=cut
+#######################################################
+#######################################################
sub CreateLegend {
my $Str = "
".
" 1 correct by student in 1 try\n".
@@ -516,210 +960,18 @@ sub CreateLegend {
return $Str;
}
-=pod
-
-=item &CreateColumnSelectionBox()
-
-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.
-
-=over 4
-Input: $CacheData, $headings
-
-
-$CacheData: A pointer to a hash tied to the cached data
-
-$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
=cut
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
-
- my $notThere = '';
- $notThere .= '';
-
- return $notThere;
-}
-
-=pod
-
-=item &CreateColumnSelectors()
-
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
-
-=over 4
-
-Input: $CacheData, $headings
-
-$CacheData: A pointer to a hash tied to the cached 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
-
-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.
-
-=back
-
-=cut
-
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
-
- my $present = '';
- for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
- $present .= '