'."\n";
+=item $Statistics Hash ref to store student data. Indexed by symb,
+ contains hashes with keys 'score' and 'max'.
- return $Str;
-}
+=cut
-=pod
+#######################################################
+#######################################################
-=item &FormatStudentData()
+my $Statistics;
-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.
+#######################################################
+#######################################################
-=over 4
+=pod
-Input: $name, $studentInformation, $ChartDB
+=item $show_links 'yes' or 'no' for linking to student performance data
-$name: The name and domain of the current student in name:domain format
+=item $output_mode 'html', 'excel', or 'csv' for output mode
-$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.
+=item $show 'all', 'totals', or 'scores' determines how much data is output
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+=cut
-Output: $Str
+#######################################################
+#######################################################
+my $show_links;
+my $output_mode;
+my $show;
+
+#######################################################
+#######################################################
+# End of package variable declarations
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+=pod
=back
=cut
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
+#######################################################
+#######################################################
- my $Str = '';
- if($cache->{$name.':error'} =~ /course/) {
- $Str .= 'No course data for student ';
- $Str .= ''.$username.'. ';
- return $Str;
- }
-
- my $Version;
- my $problemsCorrect = 0;
- my $totalProblems = 0;
- my $problemsSolved = 0;
- my $numberOfParts = 0;
-# foreach my $sequence (split(':', $cache->{'orderedSequences'})) {
- foreach my $sequence (@$showSequences) {
- my $characterCount=0;
- foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
- my $problem = $cache->{$problemID.':problem'};
- my $LatestVersion = $cache->{$name.':version:'.$problem};
-
- # Output dashes for all the parts of this problem if there
- # is no version information about the current problem.
- if(!$LatestVersion) {
- foreach my $part (split(/\:/,$cache->{$sequence.':'.
- $problemID.
- ':parts'})) {
- $Str .= ' ';
- $totalProblems++;
- $characterCount++;
- }
- next;
- }
+=pod
- my %partData=undef;
- # Initialize part data, display skips correctly
- # Skip refers to when a student made no submissions on that
- # part/problem.
- foreach my $part (split(/\:/,$cache->{$sequence.':'.
- $problemID.
- ':parts'})) {
- $partData{$part.':tries'}=0;
- $partData{$part.':code'}=' ';
- }
+=item &BuildStudentAssessmentPage()
- # Looping through all the versions of each part, starting with the
- # oldest version. Basically, it gets the most recent
- # set of grade data for each part.
- for(my $Version=1; $Version<=$LatestVersion; $Version++) {
- foreach my $part (split(/\:/,$cache->{$sequence.':'.
- $problemID.
- ':parts'})) {
-
- if(!defined($cache->{$name.":$Version:$problem".
- ":resource.$part.solved"})) {
- # No grade for this submission, so skip
- next;
- }
+Inputs:
- my $tries=0;
- my $code=' ';
+=over 4
- $tries = $cache->{$name.':'.$Version.':'.$problem.
- ':resource.'.$part.'.tries'};
- $partData{$part.':tries'}=($tries) ? $tries : 0;
-
- my $val = $cache->{$name.':'.$Version.':'.$problem.
- ':resource.'.$part.'.solved'};
- if ($val eq 'correct_by_student') {$code = '*';}
- elsif ($val eq 'correct_by_override') {$code = '+';}
- elsif ($val eq 'incorrect_attempted') {$code = '.';}
- elsif ($val eq 'incorrect_by_override'){$code = '-';}
- elsif ($val eq 'excused') {$code = 'x';}
- elsif ($val eq 'ungraded_attempted') {$code = '#';}
- else {$code = ' ';}
- $partData{$part.':code'}=$code;
- }
- }
+=item $r Apache Request
- # 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
- $Str .= '';
- foreach(split(/\:/,$cache->{$sequence.':'.$problemID.
- ':parts'})) {
- if($partData{$_.':code'} eq '*') {
- $problemsCorrect++;
- if (($partData{$_.':tries'}<10) &&
- ($partData{$_.':tries'} ne '')) {
- $partData{$_.':code'}=$partData{$_.':tries'};
- }
- } elsif($partData{$_.':code'} eq '+') {
- $problemsCorrect++;
- }
+=item $c Apache Connection
- $Str .= $partData{$_.':code'};
- $characterCount++;
+=back
- if($partData{$_.':code'} ne 'x') {
- $totalProblems++;
- }
- }
- $Str.='';
+=cut
+
+#######################################################
+#######################################################
+sub BuildStudentAssessmentPage {
+ my ($r,$c)=@_;
+ undef($Statistics);
+ #
+ # 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->rflush();
+ if (! exists($ENV{'form.notfirstrun'})) {
+ $r->print(<
+
+Please make your selections in the boxes above and hit
+the button marked "Update Display".
+
+
+ENDMSG
+# $r->print(&OutputDescriptions());
+ 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 ; }
+ #
+ # Call the initialize routine selected above
+ $initialize->($r);
+ foreach my $student (@Apache::lonstatistics::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", $problemsCorrect );
- $Str .= ''.$outputProblemsCorrect.'';
- $problemsSolved += $problemsCorrect;
- $problemsCorrect=0;
-
- $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", $problemsSolved );
- my $outputTotalProblems = sprintf( "%4d", $totalProblems );
- $Str .= ''.$outputProblemsSolved.
- ' / '.$outputTotalProblems.'';
+#######################################################
+#######################################################
- 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;
+}
+
+sub get_sequences_to_show {
+ my @Sequences;
+ foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) {
+ foreach my $sequence (@Apache::lonstatistics::Sequences) {
+ next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all');
+ next if ($sequence->{'num_assess'} < 1);
+ push (@Sequences,$sequence);
+ }
+ }
+ return @Sequences;
}
+
+#######################################################
+#######################################################
+
=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";
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.'},
+ { 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;
+}
-$CacheData: A pointer to a hash tied to the cached data
+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;
+}
-$headings: An array of the names of the columns for the student information.
-They are used for displaying which columns are missing.
+#######################################################
+#######################################################
-Output: $notThere
+=pod
-$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.
+=head2 HTML output routines
-=back
+=item &html_initialize($r)
-=cut
+Create labels for the columns of student data to show.
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
+=item &html_outputstudent($r,$student)
- my $notThere = '';
- $notThere .= '';
+=cut
- return $notThere;
+#######################################################
+#######################################################
+{
+ 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;
}
-=pod
-
-=item &CreateColumnSelectors()
+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;
+}
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
+sub html_finish {
+ my ($r) = @_;
+ $r->print("
\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 to know what are the student information columns
+=head2 EXCEL subroutines
-Output: $present
+=item &excel_initialize($r)
-$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 &excel_outputstudent($r,$student)
-=back
+=item &excel_finish($r)
=cut
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
+#######################################################
+#######################################################
+{
+
+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);
+ #
+ # Add the student headers
+ foreach my $field (&get_student_fields_to_show()) {
+ $excel_sheet->write(1,$cols_output++,$field);
+ }
+ #
+ # Add the Sequence Headers
+ foreach my $seq (&get_sequences_to_show) {
+ $excel_sheet->write(0,$cols_output,$seq->{'title'});
+ if ($show eq 'totals') {
+ $excel_sheet->write(1,$cols_output,'score');
+ $excel_sheet->write(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";
+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('
'."\n";
+
+ return $Str;
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &CreateLegend()
+
+This function returns a formatted string containing the legend for the
+chart. The legend describes the symbols used to represent grades for
+problems.
+
+=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".
+ "