--- loncom/interface/statistics/lonstudentassessment.pm 2003/02/21 18:41:56 1.28 +++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/04 14:21:36 1.33 @@ -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.33 2003/03/04 14:21:36 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -55,34 +54,65 @@ use Apache::lonstatistics; use Apache::lonhtmlcommon; use Apache::loncoursedata; use Apache::lonnet; # for logging porpoises -use GDBM_File; +use Spreadsheet::WriteExcel; + +####################################################### +####################################################### +=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 + +=cut + +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $show; -=item $cacheDB The name of the cache file used to store student data +####################################################### +####################################################### +# End of package variable declarations -=item $students Array ref containing the name(s) of the students -selected for display +=pod -=item $courseID The ID of the course +=back -=item $formName The name of the html form - 'Statistics' +=cut -=item $headings Array ref of headings to show +####################################################### +####################################################### -=item $spacing A string of spaces +=pod -=item $studentInformation Array ref of possible headings for student info -('fullname','section',...) +=item &BuildStudentAssessmentPage() + +Inputs: + +=over 4 =item $r Apache Request @@ -95,147 +125,88 @@ 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); + # + # Print out the HTML headers for the interface + # This also parses the output mode selector + # This step must always be done. + $r->print(&CreateInterface()); + $r->print(''); + $r->rflush(); + if (! exists($ENV{'form.notfirstrun'})) { + $r->print(< + +Please make your selections in the boxes above and hit +the button marked "Update Display". + +

+ENDMSG +# $r->print(&OutputDescriptions()); return; } + # + # + my $initialize = \&html_initialize; + my $output_student = \&html_outputstudent; + my $finish = \&html_finish; + # + if ($output_mode eq 'excel') { + $initialize = \&excel_initialize; + $output_student = \&excel_outputstudent; + $finish = \&excel_finish; + } elsif ($output_mode eq 'csv') { + $initialize = \&csv_initialize; + $output_student = \&csv_outputstudent; + $finish = \&csv_finish; + } + # + if($c->aborted()) { return ; } + # + # Call the initialize routine selected above + $initialize->($r); + foreach my $student (@Apache::lonstatistics::Students) { + if($c->aborted()) { + $finish->($r); + return ; + } + # Call the output_student routine selected above + $output_student->($r,$student); + } + # Call the "finish" routine selected above + $finish->($r); + # + return; +} - # 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); +####################################################### +####################################################### + +sub get_student_fields_to_show { + my @to_show = @Apache::lonstatistics::SelectedStudentData; + foreach (@to_show) { + if ($_ eq 'all') { + @to_show = @Apache::lonstatistics::StudentDataOrder; + last; } } - 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(); + return @to_show; +} - my $Str = ''; - if($selectedName eq 'No Student Selected') { - $Str .= '

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

'; - $r->print($Str); - return; +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; +} - $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); - } else { - if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys)); - untie(%cache); - } - } - return; -} ####################################################### ####################################################### @@ -246,23 +217,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,128 +227,294 @@ the chart page. ####################################################### ####################################################### sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; - my $Str = ''; - $Str .= &CreateLegend(); - $Str .= ''."\n"; - } - - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''."\n"; - } - - return $present; -} - -####################################################### -####################################################### - -=pod - -=back - -=head1 HELPER FUNCTIONS - -=over 4 - -=cut - -####################################################### -####################################################### -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; - - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } - - 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; - } else { - $selectedName = $students->[$index+1]; - return $selectedName; - } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; - } else { - $selectedName = $students->[$index-1]; - return $selectedName; - } - } else { - $selectedName = $students->[$index]; - return $selectedName; - } - last; - } - } - - return 'No Student Selected'; -} -####################################################### -####################################################### - -=pod - -=item &ShouldShowColumn() - -Determine if a specified column should be shown on the chart. - -=over 4 - -Input: $cache, $test - -$cache: A pointer to the hash tied to the cached data - -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=pod =back @@ -823,62 +938,7 @@ $test: The form name of the column (head ####################################################### ####################################################### -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); - - my @sequenceKeys=(); - my @sequenceHeadings=(); - my %doNotShow; - - 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++; - } - } - - 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++; - } - } - - $doNotShow{'count'} = $count; - - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); -} 1; -####################################################### -####################################################### - -=pod - -=back - -=cut - -####################################################### -####################################################### - __END__
'."\n"; - $Str .= '{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); $Str .= ''; - $Str .= &CreateColumnSelectionBox($doNotShow); + my $only_seq_with_assessments = sub { + my $s=shift; + if ($s->{'num_assess'} < 1) { + return 0; + } else { + return 1; + } + }; + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ''."\n"; - $Str .= ' 'HTML, with links', + value => 'html, with links', + description => 'Output HTML with each symbol linked to the problem '. + 'which generated it.'}, + { name => 'HTML, without links', + value => 'html, without links', + description => 'Output HTML. By not including links, the size of the'. + ' web page is greatly reduced. If your browser crashes on the '. + 'full display, try this.'}, + { name => 'HTML, scores only', + value => 'html, scores only', + description => 'Output HTML, only showing the total number of correct'. + ' problems (or problem parts) and not the maximum possible for '. + 'each student'}, + { name => 'HTML, totals', + value => 'html, totals', + description => 'Output HTML, but only the summary statistics for each'. + ' sequence selected.'}, + { name => 'Excel, scores only', + value => 'excel, scores only', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with a single column for each sequence showing the students '. + 'score.'}, +# { name => 'Excel, everything', +# value => 'excel, everything', +# description => 'Output an Excel file (compatable with Excel 95), '. +# 'with a seperate worksheet for each sequence you have selected '. +# 'the data for each problem part '. +# '(number of tries, status, points awarded) '. +# 'will be listed.'}, + { name => 'Excel, totals', + value => 'excel, totals', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with two columns for each sequence, the students score on the '. + 'sequence and the students maximum possible on the sequence'}, + { name => 'CSV, everything', + value => 'csv, everything', + description => ''}, + { name => 'CSV, scores only', + value => 'csv, scores only', + description => ''}, + { name => 'CSV, totals', + value => 'csv, totals', + description => ''}, + ); -=over 4 +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; +} -=item $cache The ubiquitous cache +sub CreateAndParseOutputSelector { + my $Str = ''; + my $elementname = 'outputmode'; + # + # Format for output options is 'mode, restrictions'; + my $selected = 'html, with links'; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; + } else { + $selected = $ENV{'form.'.$elementname}; + } + } + # + # Set package variables describing output mode + $show_links = 'no'; + $output_mode = 'html'; + $show = 'all'; + my ($mode,$restriction) = split(',',$selected); + $restriction =~ s/^\s*//; + if ($mode =~ /^(html|excel|csv)$/) { + $output_mode = $mode; + } else { + $output_mode = 'html'; + } + if ($restriction eq 'with links') { + $show_links = 'yes'; + } else { + $show_links = 'no'; + } + if ($restriction eq 'totals') { + $show = 'totals'; + } elsif ($restriction eq 'scores only') { + $show = 'scores'; + } else { + $show = 'everything'; + } + # + # Build the form element + $Str = qq/"; + return $Str; +} -=item $spacing A string of spaces +####################################################### +####################################################### -=item $infoKeys Array ref to names of keys to display from the cache -which describe students +=pod -=item $infoHeadings Array ref to headings of columns for student info +=head2 HTML output routines -=item $sequenceKeys Array ref of names of keys to use to retrieve sequence -data from the cache +=item &html_initialize($r) -=item $sequenceHeadings Array ref of names of sequences used for output. +Create labels for the columns of student data to show. -=back +=item &html_outputstudent($r,$student) -Returns: A string containing the HTML of the table headings. +Return a line of the chart for a student. + +=item &html_finish($r) =cut ####################################################### ####################################################### -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +{ + my $padding; + my $count; + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 1; + # + my $Str = "
\n";
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
+        my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    # Now the selected sequences need to be listed
+    foreach my $sequence (&get_sequences_to_show) {
+        my $title = $sequence->{'title'};
+        my $base  = $sequence->{'base_width'};
+        my $width = $sequence->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    $Str .= "total (of shown problems)
\n"; + $Str .= "
";
+    $r->print($Str);
+    $r->rflush();
+    return;
+}
 
-#    my $Str = '     ';
+sub html_outputstudent {
+    my ($r,$student) = @_;
     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');
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$student->{$field};
+        my $base = length($title);
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    # Get ALL the students data
+    my %StudentsData;
+    my @tmp = &Apache::loncoursedata::get_current_state
+        ($student->{'username'},$student->{'domain'},undef,
+         $ENV{'request.course.id'});
+    if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
+        %StudentsData = @tmp;
+    }
+    if (scalar(@tmp) < 1) {
+        $Str .= 'No Course Data'."\n";
+        $r->print($Str);
+        $r->rflush();
+        return;
+    }
+    #
+    # By sequence build up the data
+    my $studentstats;
+    my $PerformanceStr = '';
+    foreach my $seq (&get_sequences_to_show) {
+        my ($performance,$score,$seq_max) =
+            &StudentPerformanceOnSequence($student,\%StudentsData,
+                                          $seq,$show_links);
+        my $ratio = $score.'/'.$seq_max;
+        #
+        if ($show eq 'totals') {
+            $performance = ' 'x(length($seq_max)-length($score)).$ratio;
+            $performance .= ' 'x($seq->{'width'}-length($performance));
+        } elsif ($show eq 'scores') {
+            $performance = $score;
+            $performance .= ' 'x($seq->{'width'}-length($performance));
+        } else {
+            # Pad with extra spaces
+            $performance .= ' 'x($seq->{'width'}-$seq_max-
+                                 length($ratio)
+                                 ).$ratio;
+        }
+        #
+        $Str .= $performance.$padding;
+        #
+        $studentstats->{$seq->{'symb'}}->{'score'}= $score;
+        $studentstats->{$seq->{'symb'}}->{'max'}  = $seq_max;
+    }
+    #
+    # Total it up and store the statistics info.
+    my ($score,$max) = (0,0);
+    while (my ($symb,$seq_stats) = each (%{$studentstats})) {
+        $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
+        $Statistics->{$symb}->{'max'}   += $seq_stats->{'max'};
+        $score += $seq_stats->{'score'};
+        $max   += $seq_stats->{'max'};
+    }
+    $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
+    $Str .= " \n";
+    $r->print($Str);
+    #
+    $count++;
+    if($count % 5 == 0) {
+        $r->print("
");
+    }
+    #
+    $r->rflush();
+    return;
+}    
 
-    $Str .= '
'; - $Str .= '
     
     
DISPLAYDATAFORMATTING';
-    $displayString .= $spacing.'
DISPLAYDATAFORMATTING'.$spacing;
-    $displayString .= '
Total Solved/Total Problems
'."\n"; +sub html_finish { + my ($r) = @_; + $r->print("
\n"); + $r->rflush(); + return; +} - return $Str; } ####################################################### @@ -401,132 +522,318 @@ sub CreateTableHeadings { =pod -=item &StudentReport() +=head2 EXCEL subroutines -This is the workhorse subroutine - it handles formatting and display of a -students performance data. It processes one row of the chart. +=item &excel_initialize($r) -Input: +=item &excel_outputstudent($r,$student) -=over 4 +=item &excel_finish($r) -=item $cache The ubiquitous cache +=cut -=item $name The name and domain of the current student in name:domain format +####################################################### +####################################################### +{ -=item $spacing A string containing spaces. +my $excel_sheet; +my $excel_workbook; -=item $showSequences Array ref containing the sequences to display +my $filename; +my $rows_output; +my $cols_output; + +my $num_students; +my $start_time; + +sub excel_initialize { + my ($r) = @_; + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + $num_students = 0; + $start_time = time; + # + # Create sheet + $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename); + # + # Check for errors + if (! defined($excel_workbook)) { + $r->log_error("Error creating excel spreadsheet $filename: $!"); + $r->print("Problems creating new Excel file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator"); + return ; + } + # + # The excel spreadsheet stores temporary data in files, then put them + # together. If needed we should be able to disable this (memory only). + # The temporary directory must be specified before calling 'addworksheet'. + # File::Temp is used to determine the temporary directory. + $excel_workbook->set_tempdir($Apache::lonnet::tmpdir); + # + # Add a worksheet + my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + if (length($sheetname) > 31) { + $sheetname = substr($sheetname,0,31); + } + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Add the student headers + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write(1,$cols_output++,$field); + } + # + # Add the Sequence Headers + foreach my $seq (&get_sequences_to_show) { + $excel_sheet->write(0,$cols_output,$seq->{'title'}); + if ($show eq 'totals') { + $excel_sheet->write(1,$cols_output,'score'); + $excel_sheet->write(1,$cols_output+1,'maximum'); + $cols_output += 2; + } else { + $cols_output++; + } + } + # + # Bookkeeping + if ($show eq 'totals') { + $rows_output = 2; + } else { + $rows_output = 1; + } + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + $r->print("

Compiling Excel spreadsheet for ". + $studentcount.' student'); + $r->print('s') if ($studentcount > 1); + $r->print("

\n"); + $r->rflush(); + # + return; +} -=back +sub excel_outputstudent { + my ($r,$student) = @_; + return if (! defined($excel_sheet)); + $cols_output=0; + # + # Write out student data + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + $excel_sheet->write($rows_output,$cols_output++,$student->{$field}); + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Write out sequence scores and totals data + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + if ($show eq 'totals' || $show eq 'scores') { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + if ($show eq 'totals') { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Time estimate + $num_students++; + if ($num_students % 10 == 0) { + my $time_est = (time - $start_time)/$num_students * + (scalar(@Apache::lonstatistics::Students)-$num_students); + $time_est = int($time_est); + if (int ($time_est/60) > 0) { + my $min = int($time_est/60); + my $sec = $time_est % 60; + $time_est = $min.' minutes'; + if ($sec > 1) { + $time_est.= ', '.$sec.' seconds'; + } elsif ($sec > 0) { + $time_est.= ', '.$sec.' second'; + } + } else { + $time_est .= ' seconds'; + } + $r->print($num_students.' out of '. + (scalar(@Apache::lonstatistics::Students)). + " students processed. ". + $time_est." remain.
\n"); + $r->rflush(); + } + return; +} -Output: $Str +sub excel_finish { + my ($r) = @_; + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Tell the user where to get their excel file + $r->print('

'. + 'Your Excel spreadsheet.'."\n"); + my $total_time = time - $start_time; + if (int ($total_time / 60) > 0) { + $total_time = int($total_time/60).' minutes, '.($total_time % 60); + } + $r->print('
'.$total_time.' seconds total'); + $r->rflush(); + return; +} + +} +####################################################### +####################################################### + +=pod + +=head2 CSV output routines -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +=item &csv_initialize($r) + +=item &csv_outputstudent($r,$student) + +=item &csv_finish($r) =cut ####################################################### ####################################################### -sub StudentReport { - my ($cache,$name,$spacing,$showSequences)=@_; - my ($username,$domain)=split(':',$name); +{ - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; - } - 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++; - } - } - - # 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; - } +sub csv_initialize{ + my ($r) = @_; + $r->print("

Not implemented yet

"); + return; +} - # Output the total correct problems over the total number of problems. - # I don't like this type of formatting, but it is a solution. Need - # a way to dynamically determine the space requirements. - my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'}); - my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'}); - if($hasFinalData eq 'true') { - $Str .= ''.$outputProblemsSolved. - ' / '.$outputTotalProblems.''; - } else { - $Str .= ' '; - } +sub csv_outputstudent { + my ($r,$student) = @_; +} - if($hasVersion eq 'false') { - $Str = 'No course data.'; - } +sub csv_finish { + my ($r) = @_; +} - return $Str; } ####################################################### ####################################################### +=pod + +=item &StudentPerformanceOnSequence() + +Inputs: + +=over 4 + +=item $student + +=item $studentdata Hash ref to all student data + +=item $seq Hash ref, the sequence we are working on + +=item $links if defined we will output links to each resource. + +=back + +=cut + +####################################################### +####################################################### +sub StudentPerformanceOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + my $value = ''; + foreach my $partnum (@{$resource->{'parts'}}) { + $max++; + my $symbol = ' '; # default to space + # + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + my $status = $resource_data->{'resource.'.$partnum.'.solved'}; + if ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted') { + $symbol = '.'; + } elsif ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_student' && + exists($resource_data->{'resource.'.$partnum.'.tries'})){ + my $num = $resource_data->{'resource.'.$partnum.'.tries'}; + if ($num > 9) { + $symbol = '*'; + } elsif ($num > 0) { + $symbol = $num; + } else { + $symbol = ' '; + } + $sum++; + } else { + $symbol = ' '; + } + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$partnum.'.tries'})){ + $symbol = '.'; + } else { + $symbol = ' '; + } + } + # + if ($links eq 'yes' && $symbol ne ' ') { + $symbol = ''.$symbol.''; + } + $value .= $symbol; + } + $Str .= $value; + } + return ($Str,$sum,$max); +} + ####################################################### ####################################################### sub StudentAverageTotal { @@ -593,29 +900,6 @@ sub StudentAverageTotal { ####################################################### ####################################################### -####################################################### -####################################################### -sub MaxSeqPr { - my ($cache, $name, $sequence)=@_; - my $prCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $prCount++; - next; - } - $prCount++; - } - } - return $prCount; -} - -####################################################### -####################################################### - =pod =item &CreateLegend() @@ -646,176 +930,7 @@ 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 - -$CacheData: A pointer to a hash tied to the cached data - -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. - -Output: $notThere - -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. - -=back - -=cut - -####################################################### -####################################################### -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; - - my $notThere = ''; - $notThere .= ''; - - return $notThere; -} - -####################################################### -####################################################### - -=pod - -=item &CreateColumnSelectors() - -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. - -=over 4 - -Input: $CacheData, $headings - -$CacheData: A pointer to a hash tied to the cached data - -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns - -Output: $present - -$present: The string contains the first row of a table. Each column contains -a checkbox which is left justified. Currently left justification is used -for consistency of location over the column in which it presides. - -=back - -=cut - -####################################################### -####################################################### -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; - - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= '
'; - $present .= '[$index].'" />'; - $present .= ''; - $present .= '[$index].'" />'; - $present .= '