--- loncom/interface/statistics/lonstudentassessment.pm 2002/08/13 00:37:18 1.8
+++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/03 19:28:29 1.31
@@ -1,12 +1,10 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
#
-# $Id: lonstudentassessment.pm,v 1.8 2002/08/13 00:37:18 stredwic Exp $
+# $Id: lonstudentassessment.pm,v 1.31 2003/03/03 19:28:29 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,559 +24,726 @@
# 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
#
-###
+#######################################################
+#######################################################
-package Apache::lonstudentassessment;
+=pod
-use strict;
-use Apache::lonhtmlcommon;
-use Apache::loncoursedata;
-use GDBM_File;
+=head1 NAME
-#my $jr;
+lonstudentassessment
-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('
Unable to tie database.');
- return;
- }
+=head1 SYNOPSIS
- # Remove students who don't have the proper section.
- my @sectionsSelected = split(':',$cache{'sectionsSelected'});
- for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;
- $studentIndex--) {
- my $value = $cache{$students->[$studentIndex].':section'};
- my $found = 0;
- foreach (@sectionsSelected) {
- if($_ eq 'none') {
- if($value eq '' || !defined($value) || $value eq ' ') {
- $found = 1;
- last;
- }
- } else {
- if($value eq $_) {
- $found = 1;
- last;
- }
- }
- }
- if($found == 0) {
- splice(@$students, $studentIndex, 1);
- }
- }
- my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,
- $doNotShow) =
- &ShouldShowColumns(\%cache, $headings, $studentInformation);
-
- my $selectedName = &FindSelectedStudent(\%cache,
- $cache{'StudentAssessmentStudent'},
- $students);
- $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,
- $doNotShow));
- $r->rflush();
+Presents assessment data about a student or a group of students.
- my $Str = '';
- if($selectedName eq 'No Student Selected') {
- $Str .= '
'."\n";
+my $Statistics;
- return $Str;
-}
+#######################################################
+#######################################################
=pod
-=item &FormatStudentData()
+=item $show_links 'yes' or 'no' for linking to student performance data
-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 $output_mode 'html', 'excel', or 'csv' for output mode
-=over 4
+=item $show 'all' or 'totals' determines how much data is output
-Input: $name, $studentInformation, $ChartDB
+=cut
-$name: The name and domain of the current student in name:domain format
+#######################################################
+#######################################################
+my $show_links;
+my $output_mode;
+my $show;
+
+#######################################################
+#######################################################
+# End of package variable declarations
-$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.
+=pod
+
+=back
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+=cut
+
+#######################################################
+#######################################################
+
+=pod
-Output: $Str
+=item &BuildStudentAssessmentPage()
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+Inputs:
+
+=over 4
+
+=item $r Apache Request
+
+=item $c Apache Connection
=back
=cut
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
-
- my $Str = '';
- if(defined($cache->{$name.':error'})) {
- return $Str;
+#######################################################
+#######################################################
+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
+ return;
}
- if($cache->{$name.':error'} =~ /course/) {
- $Str .= 'No course data for student ';
- $Str .= ''.$username.'. ';
- return $Str;
- }
-
- foreach my $sequence (@$showSequences) {
- 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'})) {
- $characterCount++;
- if(defined($cache->{$name.':'.$problemID.':NoVersion'}) ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ') {
- $Str .= ' ';
- next;
- }
- $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.='';
- }
+ #
+ #
+ 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", $cache->{$name.':'.$sequence.
- ':problemsCorrect'});
- $Str .= ''.$outputProblemsCorrect.'';
- $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'});
- $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
+#######################################################
+#######################################################
+sub CreateAndParseOutputSelector {
+ my $Str = '';
+ my $elementname = 'outputmode';
+ #
+ # Format for output options is 'mode, restrictions';
+ my @Options = ('html, with links','html, without links',
+ 'html, totals only','excel, totals only',
+ 'csv, totals only','csv, everything');
+ 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 only') {
+ $show = 'totals';
+ } else {
+ $show = 'everything';
+ }
+ #
+ # Build the form element
+ $Str = qq/';
+sub html_finish {
+ my ($r) = @_;
+ $r->print("\n");
+ $r->rflush();
+ return;
+}
- 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;
+
+sub excel_initialize {
+ my ($r) = @_;
+ #
+ $r->print("
Not implemented yet
");
+ return;
+ my $filename = '/prtspool/'.
+ $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.xls';
+ $excel_sheet = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
+ if (! defined($excel_sheet)) {
+ $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 0;
+ }
+ #
+ # 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_sheet->set_tempdir($Apache::lonnet::tmpdir);
+ #
+ # Determine the name to give the worksheet
+# $excel_sheet->addworksheet();
-Output: $present
+ 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.
+sub excel_outputstudent {
+ my ($r,$student) = @_;
+}
-=back
+sub excel_finish {
+ my ($r) = @_;
+}
-=cut
+}
+#######################################################
+#######################################################
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
+=pod
- my $present = '';
- for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
- $present .= '
'."\n";
- return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,
- \@sequenceKeys, \%doNotShow);
+ 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
+
+#######################################################
+#######################################################
+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".
+ "