--- loncom/interface/statistics/lonstudentassessment.pm 2003/02/21 18:41:56 1.28 +++ loncom/interface/statistics/lonstudentassessment.pm 2005/02/25 19:48:01 1.114 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.28 2003/02/21 18:41:56 matthew Exp $ +# $Id: lonstudentassessment.pm,v 1.114 2005/02/25 19:48:01 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -53,36 +52,75 @@ package Apache::lonstudentassessment; use strict; use Apache::lonstatistics; use Apache::lonhtmlcommon; +use Apache::loncommon(); use Apache::loncoursedata; use Apache::lonnet; # for logging porpoises -use GDBM_File; +use Apache::lonlocal; +use Time::HiRes; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); + +####################################################### +####################################################### +=pod + +=item Package Variables + +=over 4 + +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. + +=cut + +####################################################### +####################################################### + +my $Statistics; ####################################################### ####################################################### =pod -=item &BuildStudentAssessmentPage() +=item $show_links 'yes' or 'no' for linking to student performance data -Inputs: +=item $output_mode 'html', 'excel', or 'csv' for output mode -=over 4 +=item $show 'all', 'totals', or 'scores' determines how much data is output -=item $cacheDB The name of the cache file used to store student data +=item $single_student_mode evaluates to true if we are showing only one +student. -=item $students Array ref containing the name(s) of the students -selected for display +=cut -=item $courseID The ID of the course +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $chosen_output; +my $single_student_mode; -=item $formName The name of the html form - 'Statistics' +####################################################### +####################################################### +# End of package variable declarations -=item $headings Array ref of headings to show +=pod -=item $spacing A string of spaces +=back -=item $studentInformation Array ref of possible headings for student info -('fullname','section',...) +=cut + +####################################################### +####################################################### + +=pod + +=item &BuildStudentAssessmentPage() + +Inputs: + +=over 4 =item $r Apache Request @@ -95,147 +133,164 @@ selected for display ####################################################### ####################################################### sub BuildStudentAssessmentPage { - my ($cacheDB,$students,$courseID,$formName,$headings,$spacing, - $studentInformation,$r,$c)=@_; - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print('Unable to tie database.'); + my ($r,$c)=@_; + # + undef($Statistics); + undef($show_links); + undef($output_mode); + undef($chosen_output); + undef($single_student_mode); + # + my %Saveable_Parameters = ('Status' => 'scalar', + 'chartoutputmode' => 'scalar', + 'chartoutputdata' => 'scalar', + 'Section' => 'array', + 'StudentData' => 'array', + 'Maps' => 'array'); + &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters); + &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters); + # + &Apache::lonstatistics::PrepareClasslist(); + # + $single_student_mode = 0; + $single_student_mode = 1 if ($ENV{'form.SelectedStudent'}); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['selectstudent']); + if ($ENV{'form.selectstudent'}) { + &Apache::lonstatistics::DisplayClasslist($r); return; } - - # 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); + # + # 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; + &Apache::lonnet::logthis('got here! 1'); + # + 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; + } + # + &Apache::lonnet::logthis('got here! 2'); + 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); + &Apache::lonnet::logthis('got here! 3'); + foreach my $student (@Students) { + if($c->aborted()) { + $finish->($r); + return ; } + # Call the output_student routine selected above + $output_student->($r,$student); } - 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(); + # Call the "finish" routine selected above + $finish->($r); + # + return; +} +####################################################### +####################################################### +sub next_and_previous_buttons { my $Str = ''; - if($selectedName eq 'No Student Selected') { - $Str .= '

WARNING: '; - $Str .= 'Please select a student

'; - $r->print($Str); - return; + $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 { + $previousbutton .= ''; } - - $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings, - $sequenceKeys, $sequenceHeadings)); - untie(%cache); - if($c->aborted()) { return $Str; } - - my $selected=0; - my $Count = 0; - $r->print('
'."\n");
-    foreach (@$students) {
-        if($c->aborted()) { return $Str; }
-        next if ($_ ne $selectedName &&
-                 $selectedName ne 'All Students');
-        $selected = 1;
-
-        my @who = ($_);
-        next if(&Apache::loncoursedata::DownloadStudentCourseData(\@who, 'true',
-                                                             $cacheDB, 'true',
-                                                             'false', $courseID,
-                                                             $r, $c) ne 'OK');
-        next if($c->aborted());
-
-        if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
-            my @before=();
-            my @after=();
-            my @updateColumn=();
-            my $foundUpdate = 0;
-            foreach(@$infoKeys) {
-                if(/updateTime/) {
-                    $foundUpdate=1;
-                    push(@updateColumn, $_);
-                    next;
-                }
-                if($foundUpdate) {
-                    push(@after, $_);
-                } else {
-                    push(@before, $_);
-                }
-            }
-            $Count++;
-	    my $out = '';
-	    $out .= sprintf("%3d) ", $Count);
-            if($Count % 2) {
-                $out .= '';
-            } else {
-                $out .= '';
-            }
-	    my $displayString = $out.'DISPLAYDATA'.$spacing;
-	    $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(
-                                                         \%cache, $_,
-                                                         \@before,
-                                                         $displayString,
-                                                         'preformatted'));
-
-            if($foundUpdate) {
-                $displayString = '';
-                $displayString .= '';
-                $displayString .= 'DISPLAYDATA'.$spacing;
-                $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(
-                                                                   \%cache, $_,
-                                                                   \@updateColumn,
-                                                                   $displayString,
-                                                                   'preformatted'));
-            }
-
-            $displayString = 'DISPLAYDATA'.$spacing;
-            $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(
-                                                         \%cache, $_,
-                                                         \@after,
-                                                         $displayString,
-                                                         'preformatted'));
-            $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));
-            $r->print("\n");
-            $r->rflush();
-            untie(%cache);
-        }
-    }
-    $r->print('
'."\n"); - if($selected == 0) { - $Str .= '

WARNING: '; - $Str .= 'No Students enrolled OR Please select a student

'; - $r->print($Str); + # + # Build the next student link + my $next = &Apache::lonstatistics::next_student(); + my $nextbutton = ''; + if (defined($next)) { + my $sname = $next->{'username'}.':'.$next->{'domain'}; + $nextbutton .= ''; } else { - if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys)); - untie(%cache); - } + $nextbutton .= ''; } - return; + # + # 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; } + ####################################################### ####################################################### @@ -246,23 +301,7 @@ sub BuildStudentAssessmentPage { Called by &BuildStudentAssessmentPage to create the top part of the page which displays the chart. -Inputs: - -=over 4 - -=item $cache The ubiquitous cache - -=item $selectedName The name of the currently selected student, or -'All Students' or 'No Student Selected'. - -=item $students Array ref containing the name(s) of the students selected -for display. - -=item $formName The name of the HTML form to use, 'Statistics' - -=item $doNotShow Array ref containing the names of columns to not show - -=back +Inputs: None Returns: A string containing the HTML for the headers and top table for the chart page. @@ -272,375 +311,598 @@ the chart page. ####################################################### ####################################################### sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; - my $Str = ''; - $Str .= &CreateLegend(); - $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''."\n"; + # $Str .= '
'."\n"; - $Str .= ''.&mt('Student Data').''.&mt('Enrollment Status').''.&mt('Sequences and Folders').''.&mt('Output Format').''. + &Apache::loncommon::help_open_topic("Chart_Output_Formats"). + ''.&mt('Output Data').''. + &Apache::loncommon::help_open_topic("Chart_Output_Data"). + '
'."\n"; - my @sections = split(':',$cache->{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); $Str .= ''; - $Str .= &CreateColumnSelectionBox($doNotShow); + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ''."\n"; - $Str .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= ' 'x5; + $Str .= + &mt('Status[_1]', + ''); + $Str .= '
'; return $Str; } + ####################################################### ####################################################### =pod -=item &CreateTableHeadings() - -Create HTML for the columns of student data to show. -Called by &BuildStudentAssessmentPage(). Calls -&Apache::lonhtmlcommon::CreateHeadings(). - -Inputs: - -=over 4 - -=item $cache The ubiquitous cache - -=item $spacing A string of spaces - -=item $infoKeys Array ref to names of keys to display from the cache -which describe students - -=item $infoHeadings Array ref to headings of columns for student info - -=item $sequenceKeys Array ref of names of keys to use to retrieve sequence -data from the cache - -=item $sequenceHeadings Array ref of names of sequences used for output. - -=back - -Returns: A string containing the HTML of the table headings. +=item &CreateAndParseOutputSelector() =cut ####################################################### ####################################################### -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +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 separated 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', + }, + ); -# my $Str = '     '; +sub OutputDescriptions { my $Str = ''; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings, - $sequenceKeys); - $Str .= ''."\n"; - - $Str .= ''."\n"; - my $displayString = ''; - $displayString .= ''."\n"; - $displayString .= ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $infoKeys, - $infoHeadings, - $displayString, - 'preformatted'); - - $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $sequenceKeys, - $sequenceHeadings, - $displayString, - 'preformatted'); - - $Str .= ''; - $Str .= '
     
     
DISPLAYDATAFORMATTING';
-    $displayString .= $spacing.'
DISPLAYDATAFORMATTING'.$spacing;
-    $displayString .= '
Total Solved/Total Problems
'."\n"; - + $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; +} -=pod +## +## Data selector stuff +## +my @OutputDataOptions = + ( + { name => 'Scores Summary', + base => 'scores', + value => 'sum and total', + scores => 1, + tries => 0, + every_problem => 0, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 1, + 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', + scores => 1, + tries => 0, + correct => 0, + every_problem => 1, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 1, + shortdesc => 'Score on each Problem Part', + longdesc =>'The students score on each problem part, computed as'. + 'the part weight * part awarded', + }, + { name =>'Tries', + base =>'tries', + value => 'tries', + scores => 0, + tries => 1, + correct => 0, + every_problem => 1, + sequence_sum => 0, + sequence_max => 0, + grand_total => 0, + grand_maximum => 0, + summary_table => 0, + maximum_row => 0, + shortdesc => 'Number of Tries before success on each Problem Part', + longdesc =>'The number of tries before success on each problem part.', + non_html_notes => 'negative values indicate an incorrect problem', + }, + { name =>'Parts Correct', + base =>'tries', + value => 'parts correct total', + scores => 0, + tries => 0, + correct => 1, + every_problem => 1, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 0, + shortdesc => 'Number of Problem Parts completed successfully.', + longdesc => 'The Number of Problem Parts completed successfully and '. + 'the maximum possible for each student', + }, + ); -=item &StudentReport() +sub HTMLifyOutputDataDescriptions { + my $Str = ''; + $Str .= "

Output Data

\n"; + $Str .= "
\n"; + foreach my $option (@OutputDataOptions) { + $Str .= '
'.$option->{'name'}.'
'; + $Str .= '
'.$option->{'longdesc'}.'
'."\n"; + } + $Str .= "
\n"; + return $Str; +} -This is the workhorse subroutine - it handles formatting and display of a -students performance data. It processes one row of the chart. +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}; + } + } + # + $chosen_output = $OutputDataOptions[0]; + foreach my $option (@OutputDataOptions) { + if ($option->{'value'} eq $selected) { + $chosen_output = $option; + } + } + # + # Build the form element + $Str = qq/"; + return $Str; -Input: +} -=over 4 +####################################################### +####################################################### -=item $cache The ubiquitous cache +=pod -=item $name The name and domain of the current student in name:domain format +=head2 HTML output routines -=item $spacing A string containing spaces. +=item &html_initialize($r) -=item $showSequences Array ref containing the sequences to display +Create labels for the columns of student data to show. -=back +=item &html_outputstudent($r,$student) -Output: $Str +Return a line of the chart for a student. -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +=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 + my $total_sum_width; + + my %width; # Holds sequence width information + my @sequences; + my $navmap; # Have to keep this around since weakref is a bit zealous + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 0; + $nodata_count = 0; + undef(%prog_state); + undef(%width); + undef($navmap); + undef(@sequences); + &Apache::lonnet::logthis('called html_initialize'); + # + $r->print("

".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}. + "  ".localtime(time)."

"); + # + if ($chosen_output->{'base'} !~ /^final table/) { + $r->print("

".$chosen_output->{'shortdesc'}."

"); + } + 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;
+    }
+    #
+    # Compute the column widths and output the sequence titles
+    my $total_count;
+    ($navmap,@sequences) = 
+        &Apache::lonstatistics::selected_sequences_with_assessments();
+    if (! ref($navmap)) {
+        # Unable to get data, so bail out
+        $r->print("

". + &mt('Unable to retrieve course information.'). + '

'); + } + # + # Compute sequence widths + my $starttime = Time::HiRes::time; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + my $title = $seq->compTitle; + $width{$symb}->{'width_sum'} = 0; + # Compute width of sum + if ($chosen_output->{'sequence_sum'}) { + if ($chosen_output->{'every_problem'}) { + # Use 1 digit for a space + $width{$symb}->{'width_sum'} += 1; + } + $total_count += $width{$symb}->{'num_assess_parts'}; + # Use 3 digits for the sum + $width{$symb}->{'width_sum'} += 3; + } + # Compute width of maximum + if ($chosen_output->{'sequence_max'}) { + if ($width{$symb}->{'width_sum'}>0) { + # One digit for the '/' + $width{$symb}->{'width_sum'} +=1; + } + # Use 3 digits for the total + $width{$symb}->{'width_sum'}+=3; + } + # + if ($chosen_output->{'every_problem'}) { + # one problem per digit + $width{$symb}->{'width_parts'}=0; + $starttime = Time::HiRes::time; + my @resources = + $navmap->retrieveResources($seq,sub { shift->is_problem(); }, + 0,0,0); + $starttime = Time::HiRes::time; + foreach my $res (@resources) { + my @parts = @{$res->parts}; + $width{$symb}->{'width_parts'} += scalar(@parts); + } + &Apache::lonnet::logthis('2elapsed:'.(Time::HiRes::time-$starttime)); $width{$symb}->{'width_problem'} += + $width{$symb}->{'width_parts'}; + } else { + $width{$symb}->{'width_problem'} = 0; + } + $width{$symb}->{'width_total'} = $width{$symb}->{'width_problem'} + + $width{$symb}->{'width_sum'}; + if ($width{$symb}->{'width_total'} < length(&HTML::Entities::decode($title))) { + $width{$symb}->{'width_total'} = length(&HTML::Entities::decode($title)); + } + # + # Output the sequence titles + $Str .= $title.(' 'x($width{$symb}->{'width_total'}- + length($title) + )).$padding; + } + $total_sum_width = length($total_count)+1; + $Str .= " total
\n"; + $Str .= "
";
+    $r->print($Str);
+    $r->rflush();
+    return;
+}
 
+sub html_outputstudent {
+    my ($r,$student) = @_;
     my $Str = '';
-    if(defined($cache->{$name.':error'})) {
-        return $Str;
+    return if (! defined($navmap));
+    #
+    if($count++ % 5 == 0 && $count > 0) {
+        $r->print("
");
+    }
+    # 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};
+        # Deal with 'comments' - how I love special cases
+        if ($field eq 'comments') {
+            $title = ''.&mt('Comments').'';
+        }
+        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) {
+        $nodata_count++;
+        $Str .= 'No Course Data'."\n";
+        $r->print($Str);
+        $r->rflush();
+        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'; - 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++; + # + # By sequence build up the data + my $studentstats; + my $PerformanceStr = ''; + foreach my $seq (@sequences) { + &Apache::lonnet::logthis('computing student data for '.$seq->compTitle); + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'}) { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_tries_on_sequence($student,\%StudentsData, + $navmap,$seq,$show_links); + } else { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_performance_on_sequence($student,\%StudentsData, + $navmap,$seq,$show_links); + } + my $ratio=''; + if ($chosen_output->{'every_problem'}) { + $ratio .= ' '; + } + if ($chosen_output->{'sequence_sum'} && $score ne ' ') { + $ratio .= sprintf("%3.0f",$score); + } elsif($chosen_output->{'sequence_sum'}) { + $ratio .= ' 'x3; + } + if ($chosen_output->{'sequence_max'}) { + if ($chosen_output->{'sequence_sum'}) { + $ratio .= '/'; } + $ratio .= sprintf("%3.0f",$seq_max); } - - # 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'; - } 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.''; + # + if (! $chosen_output->{'every_problem'}) { + $performance = ''; + $performance_length=0; + } + $performance .= ' 'x($width{$seq->symb}->{'width_total'} - + $performance_length - + $width{$seq->symb}->{'width_sum'}). + $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); + while (my ($symb,$seq_stats) = each (%{$studentstats})) { + $Statistics->{$symb}->{'score'} += $seq_stats->{'score'}; + if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) { + $Statistics->{$symb}->{'max'} = $seq_stats->{'max'}; + } + if ($seq_stats->{'score'} ne ' ') { + $score += $seq_stats->{'score'}; + $Statistics->{$symb}->{'num_students'}++; + } + $max += $seq_stats->{'max'}; + } + if (! defined($score)) { + $score = ' ' x $total_sum_width; } else { - $Str .= ' '; + $score = sprintf("%.0f",$score); } + $Str .= ' '.' 'x($total_sum_width-length($score)).$score.' / '.$max; + $Str .= " \n"; + # + $r->print($Str); + # + $r->rflush(); + return; +} - if($hasVersion eq 'false') { - $Str = 'No course data.'; +sub html_finish { + my ($r) = @_; + return if (! defined($navmap)); + # + # Check for suppressed output and close the progress window if so + $r->print("
\n"); + if ($chosen_output->{'summary_table'}) { + if ($single_student_mode) { + $r->print(&SingleStudentTotal()); + } else { + $r->print(&StudentAverageTotal()); + } } - - return $Str; + $r->rflush(); + undef($navmap); + return; } -####################################################### -####################################################### - -####################################################### -####################################################### sub StudentAverageTotal { - my ($cache, $students, $sequenceKeys)=@_; - my $Str = "\nSummary Tables:\n"; - my %Correct = (); - my $ProblemsSolved = 0; - my $TotalProblems = 0; - my $StudentCount = 0; - - foreach my $name (@$students) { - $StudentCount++; - foreach my $sequence (@$sequenceKeys) { - $Correct{$sequence} += - $cache->{$name.':'.$sequence.':problemsCorrect'}; - } - $ProblemsSolved += $cache->{$name.':problemsSolved'}; - $TotalProblems += $cache->{$name.':totalProblems'}; - } - if ($StudentCount) { - $ProblemsSolved = sprintf( "%.2f", - $ProblemsSolved/$StudentCount); - $TotalProblems /= $StudentCount; - } else { - $ProblemsSolved = 0; - $TotalProblems = 0; - } - + my $Str = '

'.&mt('Summary Tables').'

'.$/; $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= '
Students Count'. - $StudentCount.'
Total Problems'. - $TotalProblems.'
Average Correct'. - $ProblemsSolved.'
'."\n"; - - $Str .= ''."\n"; - $Str .= ''. - ''."\n"; - foreach my $S(@$sequenceKeys) { - my $title=$cache->{$S.':title'}; - #$Str .= $cache->{$S.':problems'}; - #my @problems=split(':', $cache->{$S.':problems'}); - #my $pCount=scalar @problems; - my $pCount=MaxSeqPr($cache,@$students[0],$S); - my $crr; - if ($StudentCount) { - $crr=sprintf( "%.2f", $Correct{$S}/$StudentCount ); - } else { - $crr="0.00"; - } - $Str .= ''."\n"; + $Str .= ''. + ''. + ''. + ''. + ''.$/; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + my $ave; + my $num_students = $Statistics->{$symb}->{'num_students'}; + if ($num_students > 0) { + $ave = int(100* + ($Statistics->{$symb}->{'score'}/$num_students) + )/100; + } else { + $ave = 0; + } + my $max = $Statistics->{$symb}->{'max'}; + $ave = sprintf("%.2f",$ave); + $Str .= ''. + ''. + ''."\n"; } - - $Str .= '
TitleTotal ProblemsAverage Correct
'.$title. - ''.$pCount. - ''.$crr. - '
'.&mt('Title').''.&mt('Average').''.&mt('Maximum').'
'.$seq->compTitle.''.$ave.' '.$max.' '.'
'."\n"; - + $Str .= "
\n"; 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++; - } +sub SingleStudentTotal { + my $student = &Apache::lonstatistics::current_student(); + my $Str = '

'.&mt('Summary table for [_1] ([_2]@[_3])', + $student->{'fullname'}, + $student->{'username'},$student->{'domain'}).'

'; + $Str .= $/; + $Str .= ''."\n"; + $Str .= + ''. + ''; + if ($chosen_output->{'base'} eq 'tries') { + $Str .= ''; + } else { + $Str .= ''; } - return $prCount; + $Str .= ''."\n"; + my $total = 0; + my $total_max = 0; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my $value = $Statistics->{$seq->symb}->{'score'}; + my $max = $Statistics->{$seq->symb}->{'max'}; + $Str .= ''. + ''. + ''."\n"; + $total += $value; + $total_max +=$max; + } + $Str .= ''. + ''. + '\n"; + $Str .= "
'.&mt('Sequence or Folder').''.&mt('Parts Correct').''.&mt('Score').''.&mt('Maximum').'
'.&HTML::Entities::encode($seq->compTitle).''.$value.''.$max.'
'.&mt('Total').''.$total.''.$total_max."
\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 - -####################################################### -####################################################### -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".
-              "

"; - return $Str; } ####################################################### @@ -648,103 +910,808 @@ sub CreateLegend { =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 +=head2 EXCEL subroutines -$CacheData: A pointer to a hash tied to the cached data +=item &excel_initialize($r) -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=item &excel_outputstudent($r,$student) -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. - -=back +=item &excel_finish($r) =cut ####################################################### ####################################################### -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; +{ - my $notThere = ''; - $notThere .= ''; +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) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsg::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $excel_sheet->write($rows_output,$cols_output++,$value); + } + # + # 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 + my %total_cell_translation; + my %maximum_cell_translation; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $cols_output = $seq->{'Excel:startcol'}; + # Keep track of cells to translate in total cell + $total_cell_translation{$seq->{'Excel:scorecell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:scorecol'}); + # and maximum cell + $maximum_cell_translation{$seq->{'Excel:maxcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:maxcol'}); + # + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'} || $chosen_output->{'correct'}){ + ($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 ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + # only indiciate if each item is correct or not + foreach my $value (@$rawdata) { + # nonzero means correct + $value = 1 if ($value > 0); + $excel_sheet->write($rows_output,$cols_output++,$value); + } + } else { + foreach my $value (@$rawdata) { + if ($score eq ' ' || !defined($value)) { + $cols_output++; + } else { + $excel_sheet->write($rows_output,$cols_output++, + $value); + } + } + } + } + if ($chosen_output->{'sequence_sum'} && + $chosen_output->{'every_problem'}) { + # Write a formula for the sum of this sequence + my %replaceCells= + ('^'.$seq->{'Excel:startcell'}.':'.$seq->{'Excel:endcell'}.'$' + => + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$seq->{'Excel:startcol'}).':'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$seq->{'Excel:endcol'}) + ); + # The undef is for the format + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells); + } elsif ($chosen_output->{'sequence_sum'}) { + if ($score eq ' ') { + $cols_output++; + } else { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + } + if ($chosen_output->{'sequence_max'}) { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + if ($chosen_output->{'grand_total'}) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $total_formula,undef, + %total_cell_translation); + } + if ($chosen_output->{'grand_maximum'}) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $maximum_formula,undef, + %maximum_cell_translation); + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} - return $notThere; +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; } +} ####################################################### ####################################################### =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 +=head2 CSV output routines -$CacheData: A pointer to a hash tied to the cached data +=item &csv_initialize($r) -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns +=item &csv_outputstudent($r,$student) -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 +=item &csv_finish($r) =cut ####################################################### ####################################################### -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; +{ - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= ''; - $present .= '[$index].'" />'; - $present .= ''."\n"; +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 ($chosen_output->{'base'} =~ /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); + # + # 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, + 'inline',undef,'Statistics','stats_status'); + # + # 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"; + foreach my $item ('shortdesc','non_html_notes') { + next if (! exists($chosen_output->{$item})); + print $outputfile + '"'.&Apache::loncommon::csv_translate($chosen_output->{$item}).'"'. + "\n"; + } + # + # Print out the headings + my $sequence_row = ''; + my $resource_row = undef; + foreach my $field (&get_student_fields_to_show()) { + $sequence_row .='"",'; + $resource_row .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $sequence_row .= '"'. + &Apache::loncommon::csv_translate($seq->{'title'}).'",'; + my $count = 0; + if ($chosen_output->{'every_problem'}) { + foreach my $res (@{$seq->{'contents'}}) { + if ($res->{'type'} ne 'assessment' || + ! exists($res->{'parts'}) || + ref($res->{'parts'}) ne 'ARRAY' || + scalar(@{$res->{'parts'}}) < 1) { + next; + } + foreach my $part (@{$res->{'parts'}}) { + $resource_row .= '"'. + &Apache::loncommon::csv_translate($res->{'title'}. + ', Part '.$part + ).'",'; + $count++; + } + } + } + $sequence_row.='"",'x$count; + if ($chosen_output->{'sequence_sum'}) { + if($chosen_output->{'correct'}) { + $resource_row .= '"sum",'; + } else { + $resource_row .= '"score",'; + } + } + if ($chosen_output->{'sequence_max'}) { + $sequence_row.= '"",'; + $resource_row .= '"maximum possible",'; + } } + if ($chosen_output->{'grand_total'}) { + $sequence_row.= '"",'; + $resource_row.= '"Total",'; + } + if ($chosen_output->{'grand_maximum'}) { + $sequence_row.= '"",'; + $resource_row.= '"Maximum",'; + } + chomp($sequence_row); + chomp($resource_row); + print $outputfile $sequence_row."\n"; + print $outputfile $resource_row."\n"; + return; +} - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''; - $present .= '[$index].'" />'; - $present .= ''."\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) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsg::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $Str .= '"'.&Apache::loncommon::csv_translate($value).'",'; + } + # + # 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 + my $total = 0; + my $maximum = 0; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'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 ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + $score = 0; + # Deal with number of parts correct data + $Str .= '"'.join('","',( map { if ($_>0) { + $score += 1; + 1; + } else { + 0; + } + } @$rawdata)).'",'; + } else { + $Str .= '"'.join('","',(@$rawdata)).'",'; + } + } + if ($chosen_output->{'sequence_sum'}) { + $Str .= '"'.$score.'",'; + } + if ($chosen_output->{'sequence_max'}) { + $Str .= '"'.$seq_max.'",'; + } + $total+=$score; + $maximum += $seq_max; + } + if ($chosen_output->{'grand_total'}) { + $Str .= '"'.$total.'",'; } + if ($chosen_output->{'grand_maximum'}) { + $Str .= '"'.$maximum.'",'; + } + 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('
'. + ''.&mt('Your csv file.').''."\n"); + $r->rflush(); + return; + +} - return $present; } ####################################################### @@ -752,70 +1719,153 @@ sub CreateColumnSelectors { =pod -=back +=item &StudentTriesOnSequence() -=head1 HELPER FUNCTIONS +Inputs: =over 4 -=cut +=item $student -####################################################### -####################################################### -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; +=item $studentdata Hash ref to all student data - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } +=item $seq Hash ref, the sequence we are working on + +=item $links if defined we will output links to each resource. + +=back - 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; +=cut + +####################################################### +####################################################### +sub student_tries_on_sequence { + my ($student,$studentdata,$navmap,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + my $performance_length = 0; + my @TriesData = (); + my $tries; + my $hasdata = 0; # flag - true if the student has any data on the sequence + my @resources = + $navmap->retrieveResources($seq,sub { shift->is_problem(); },0,0,0); + foreach my $resource (@resources) { + my $resource_data = $studentdata->{$resource->symb}; + my $value = ''; + foreach my $partnum (@{$resource->parts()}) { + $tries = undef; + $max++; + $performance_length++; + my $symbol = ' '; # default to space + # + my $awarded = 0; + if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$partnum.'.awarded'}; + $awarded = 0 if (! $awarded); + } + # + my $status = ''; + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + $status = $resource_data->{'resource.'.$partnum.'.solved'}; + } + # + my $tries = 0; + if(exists($resource_data->{'resource.'.$partnum.'.tries'})) { + $tries = $resource_data->{'resource.'.$partnum.'.tries'}; + $hasdata =1; + } + # + if ($awarded > 0) { + # The student has gotten the problem correct to some degree + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($tries > 0) { + if ($tries > 9) { + $symbol = '*'; + } else { + $symbol = $tries; + } + $sum++; } else { - $selectedName = $students->[$index+1]; - return $selectedName; + $symbol = '+'; + $sum++; } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; + } else { + # The student has the problem incorrect or it is ungraded + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted' || + $tries > 0) { + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + # Problem is wrong and has not been attempted. + $symbol=' '; } + } + # + if (! defined($tries)) { + $tries = 0; + } + if ($status =~ /^(incorrect|ungraded)/) { + # Bug 3390: show '-' for tries on incorrect problems + # (csv & excel only) + push(@TriesData,-$tries); } else { - $selectedName = $students->[$index]; - return $selectedName; + push (@TriesData,$tries); } - 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'; + if ($seq->randompick()) { + $max = $seq->randompick(); + } + if (! $hasdata && $sum == 0) { + $sum = ' '; + } + 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 + +=item $studentdata Hash ref to all student data -$cache: A pointer to the hash tied to the cached data +=item $seq Hash ref, the sequence we are working on -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=item $links if defined we will output links to each resource. =back @@ -823,51 +1873,122 @@ $test: The form name of the column (head ####################################################### ####################################################### -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); +sub student_performance_on_sequence { + my ($student,$studentdata,$navmap,$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; + my $hasdata = 0; # flag, 0 if there were no submissions on the sequence + my @resources = + $navmap->retrieveResources($seq,sub { shift->is_problem(); },0,0,0); + foreach my $resource (@resources) { + my $symb = $resource->symb; + my $resource_data = $studentdata->{$symb}; + foreach my $part (@{$resource->parts()}) { + $partscore = undef; + my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', + $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; + if (exists($resource_data->{'resource.'.$part.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$part.'.awarded'}; + $awarded = 0 if (! $awarded); + $hasdata = 1; + } + # + $partscore = $weight*$awarded; + if (! defined($awarded)) { + $partscore = undef; + } + $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. + } + $hasdata = 1; + } elsif (!exists($resource_data->{'resource.'.$part.'.awarded'})){ + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$part.'.tries'})){ + $symbol = '.'; + $hasdata = 1; + } else { + $symbol = ' '; + } + } + # + if (! defined($partscore)) { + $partscore = $symbol; + } + push (@ScoreData,$partscore); + # + if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) { + $symbol = ''.$symbol.''; + } + $Str .= $symbol; + } + } + if (! $hasdata && $score == 0) { + $score = ' '; + } + 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".
+              "

"; + return $Str; } -1; ####################################################### ####################################################### @@ -881,4 +2002,6 @@ sub ShouldShowColumns { ####################################################### ####################################################### +1; + __END__