';
- $r->print($Str);
- }
+Called by &BuildStudentAssessmentPage to create the top part of the
+page which displays the chart.
- return;
-}
+Inputs: None
-#---- Student Assessment Web Page --------------------------------------------
+Returns: A string containing the HTML for the headers and top table for
+the chart page.
-sub CreateInterface {
- my($cache,$selectedName,$students,$formName,$doNotShow)=@_;
+=cut
+#######################################################
+#######################################################
+sub CreateInterface {
my $Str = '';
- $Str .= &CreateLegend();
- $Str .= '
'."\n";
+#######################################################
+#######################################################
+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 => 'all',
+ 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 => 'all',
+ 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 => 'all',
+ show_links => 'no',
+ },
+ { 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',
+ mode => 'html',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { name => 'HTML, totals',
+ value => 'html, totals',
+ description => 'Output HTML, but only the summary statistics for each'.
+ ' sequence selected for each student.',
+ mode => 'html',
+ show => 'totals',
+ show_links => 'no',
+ },
+ { name => 'HTML, summary table only',
+ value => 'html summary table only',
+ description => 'Output HTML, but only the final summary table for '.
+ 'all students across all sequences.',
+ mode => 'html',
+ show => 'final table',
+ show_links => 'no',
+ },
+ { 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.',
+ mode => 'excel',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { 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',
+ mode => 'excel',
+ show => 'totals',
+ show_links => 'no',
+ },
+# { name => 'multi-sheet Excel',
+# value => 'multi-sheet excel',
+# 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.',
+# mode => 'multi-sheet excel',
+# show => 'totals',
+# show_links => 'no',
+# },
+# { name => 'multi-sheet Excel, by section',
+# value => 'multi-sheet excel, by section',
+# 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. '.
+# 'There will be one Excel workbook for each section selected.',
+# mode => 'multi-sheet excel',
+# show => 'by section',
+# show_links => 'no',
+# },
+ { name => 'CSV, everything',
+ value => 'csv, everything',
+ description => '',
+ mode => 'csv',
+ show => 'all',
+ show_links => 'no',
+ },
+ { name => 'CSV, scores only',
+ value => 'csv, scores only',
+ description => '',
+ mode => 'csv',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { name => 'CSV, totals',
+ value => 'csv, totals',
+ description => '',
+ mode => 'csv',
+ show => 'totals',
+ show_links => 'no',
+ },
+ );
+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;
}
-=pod
-
-=item &FormatStudentData()
-
-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.
+sub CreateAndParseOutputSelector {
+ my $Str = '';
+ my $elementname = 'chartoutputmode';
+ #
+ # 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';
+ foreach my $option (@OutputOptions) {
+ next if ($option->{'value'} ne $selected);
+ $output_mode = $option->{'mode'};
+ $show = $option->{'show'};
+ $show_links = $option->{'show_links'};
+ }
+
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
+}
-=over 4
+#######################################################
+#######################################################
-Input: $name, $studentInformation, $ChartDB
+=pod
-$name: The name and domain of the current student in name:domain format
+=head2 HTML output routines
-$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 &html_initialize($r)
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+Create labels for the columns of student data to show.
-Output: $Str
+=item &html_outputstudent($r,$student)
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+Return a line of the chart for a student.
-=back
+=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;
+ #
+ $r->print("
");
+
+ #
+ # Set up progress window for 'final table' display only
+ if ($show eq '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 (of shown problems)
\n";
return $Str;
}
+}
+#######################################################
+#######################################################
=pod
-=item &CreateLegend()
+=head2 Multi-Sheet 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 &multi_sheet_excel_initialize($r)
-=cut
+=item &multi_sheet_excel_outputstudent($r,$student)
-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 override\n".
- " - incorrect by override\n".
- " . incorrect attempted\n".
- " # ungraded attempted\n".
- " not attempted (blank field)\n".
- " x excused".
- "
");
+ #
+ # Estimate the size of the file. We would like to have < 5 megs of data.
+ my $max_size = 5000000;
+ my $num_students = scalar(@Apache::lonstatistics::Students);
+ my $num_sequences = 0;
+ my $num_data_per_part = 2; # 'status' and 'numtries'
+ my $fields_per_student = scalar(&get_student_fields_to_show());
+ my $bytes_per_field = 20; # Back of the envelope calculation
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ $num_sequences++ if ($seq->{'num_assess'} > 0);
+ $fields_per_student += $num_data_per_part * $seq->{'num_assess_parts'};
+ }
+ my $size_estimate = $fields_per_student*$num_students*$bytes_per_field;
+ #
+ # Compute number of workbooks
+ my $num_workbooks = 1;
+ if ($size_estimate > $max_size) { # try to stay under 5 megs
+ $num_workbooks += int($size_estimate / $max_size);
+ }
+ if ($show eq 'by section') {
+ if (@Apache::lonstatistics::SelectedSections > 1 &&
+ $Apache::lonstatistics::SelectedSections[0] ne 'all') {
+ $num_workbooks = scalar(@Apache::lonstatistics::SelectedSections);
+ } else {
+ # @Apache::lonstatistics::Sections contains 'all' as well.
+ $num_workbooks = scalar(@Apache::lonstatistics::Sections) - 1;
+ }
+ }
+
+ $r->print("Maximum allowed size: ".$max_size." bytes ");
+ $r->print("Number of students: ".$num_students." ");
+ $r->print("Number of fields per student: ".$fields_per_student." ");
+ $r->print("Total number of fields: ".($fields_per_student*$num_students).
+ " ");
+ $r->print("Bytes per field: ".$bytes_per_field." (estimated)"." ");
+ $r->print("Estimated size: ".$size_estimate." bytes ");
+ $r->print("Number of workbooks: ".$num_workbooks." ");
+ $r->rflush();
+ 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 multi_sheet_excel_outputstudent {
+ my ($r,$student) = @_;
+}
-=over 4
-Input: $CacheData, $headings
+sub multi_sheet_excel_finish {
+ my ($r) = @_;
+}
+}
+#######################################################
+#######################################################
-$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 EXCEL subroutines
-Output: $notThere
+=item &excel_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 &excel_outputstudent($r,$student)
-=back
+=item &excel_finish($r)
=cut
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
-
- my $notThere = '';
- $notThere .= '';
+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());
+ #
+ # 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;
+}
- return $notThere;
}
+#######################################################
+#######################################################
=pod
-=item &CreateColumnSelectors()
+=head2 CSV output routines
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
+=item &csv_initialize($r)
-=over 4
+=item &csv_outputstudent($r,$student)
+
+=item &csv_finish($r)
+
+=cut
+
+#######################################################
+#######################################################
+{
+
+my $outputfile;
+my $filename;
+
+my %prog_state; # progress window state
+
+sub csv_initialize{
+ my ($r) = @_;
+ #
+ # Clean up
+ $filename = undef;
+ $outputfile = undef;
+ undef(%prog_state);
+ #
+ # Open a file
+ $filename = '/prtspool/'.
+ $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.csv';
+ unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) {
+ $r->log_error("Couldn't open $filename for output $!");
+ $r->print("Problems occured in writing the csv file. ".
+ "This error has been logged. ".
+ "Please alert your LON-CAPA administrator.");
+ $outputfile = undef;
+ }
+ #
+ # Datestamp
+ my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+ print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'.
+ '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'.
+ "\n";
-Input: $CacheData, $headings
+ #
+ # Print out the headings
+ my $Str = '';
+ my $Str2 = undef;
+ foreach my $field (&get_student_fields_to_show()) {
+ if ($show eq 'scores') {
+ $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
+ } elsif ($show eq 'totals') {
+ $Str .= '"",'; # first row empty on the student fields
+ $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
+ } elsif ($show eq 'all') {
+ $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
+ }
+ }
+ foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
+ if ($show eq 'scores') {
+ $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
+ '",';
+ } elsif ($show eq 'totals') {
+ $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
+ '","",';
+ $Str2 .= '"score","total possible",';
+ } elsif ($show eq 'all') {
+ $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
+ '",';
+ $Str .= '"",'x($seq->{'num_assess_parts'}-1);
+ $Str .= '"score","total possible",';
+ }
+ }
+ chop($Str);
+ $Str .= "\n";
+ print $outputfile $Str;
+ if (defined($Str2)) {
+ chop($Str2);
+ $Str2 .= "\n";
+ print $outputfile $Str2;
+ }
+ #
+ # Initialize progress window
+ my $studentcount = scalar(@Apache::lonstatistics::Students);
+ %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
+ ($r,'CSV File Compilation Status',
+ 'CSV File Compilation Progress', $studentcount);
+ return;
+}
-$CacheData: A pointer to a hash tied to the cached data
+sub csv_outputstudent {
+ my ($r,$student) = @_;
+ 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,$score,$seq_max) =
+ &StudentPerformanceOnSequence($student,\%StudentsData,
+ $seq,'no');
+ if ($show eq 'scores') {
+ $Str .= '"'.$score.'",';
+ } elsif ($show eq 'totals') {
+ $Str .= '"'.$score.'","'.$seq_max.'",';
+ } elsif ($show eq 'all') {
+ $Str .= '"'.join('","',(split(//,$performance),$score,$seq_max)).
+ '",';
+ }
+ }
+ chop($Str);
+ $Str .= "\n";
+ print $outputfile $Str;
+ #
+ # Update the progress window
+ &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
+ return;
+}
-$headings: An array of the names of the columns for the student
-information. They are used to know what are the student information columns
+sub csv_finish {
+ my ($r) = @_;
+ 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;
+
+}
-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
+=pod
-=cut
+=item &StudentPerformanceOnSequence()
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
+Inputs:
- my $present = '';
- for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
- $present .= '
'."\n";
- }
+=item $student
- return $present;
-}
+=item $studentdata Hash ref to all student data
-#---- END Student Assessment Web Page ----------------------------------------
+=item $seq Hash ref, the sequence we are working on
-#---- Student Assessment Worker Functions ------------------------------------
+=item $links if defined we will output links to each resource.
-sub FindSelectedStudent {
- my($cache, $selectedName, $students)=@_;
+=back
- if($selectedName eq 'All Students' ||
- $selectedName eq 'No Student Selected') {
- return $selectedName;
- }
+=cut
- 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;
+#######################################################
+#######################################################
+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++;
+ } 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 ( ($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';
+ return ($Str,$sum,$max);
}
-=pod
+#######################################################
+#######################################################
-=item &ShouldShowColumn()
+=pod
-Determine if a specified column should be shown on the chart.
+=item &CreateLegend()
-=over 4
+This function returns a formatted string containing the legend for the
+chart. The legend describes the symbols used to represent grades for
+problems.
-Input: $cache, $test
+=cut
-$cache: A pointer to the hash tied to the cached data
+#######################################################
+#######################################################
+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".
+ "