--- loncom/interface/statistics/lonstudentassessment.pm 2002/10/24 20:58:06 1.17 +++ loncom/interface/statistics/lonstudentassessment.pm 2004/03/08 17:31:37 1.96 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.17 2002/10/24 20:58:06 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.96 2004/03/08 17:31:37 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,680 +24,1840 @@ # http://www.lon-capa.org/ # # (Navigate problems for statistical reports -# YEAR=2001 -# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei -# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei -# YEAR=2002 -# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei -# 5/12,5/14,5/15,5/19,5/26,7/16 Behrouz Minaei # -### +####################################################### +####################################################### -package Apache::lonstudentassessment; +=pod + +=head1 NAME + +lonstudentassessment + +=head1 SYNOPSIS + +Presents assessment data about a student or a group of students. + +=head1 Subroutines + +=over 4 + +=cut + +####################################################### +####################################################### + +package Apache::lonstudentassessment; use strict; +use Apache::lonstatistics; use Apache::lonhtmlcommon; +use Apache::loncommon(); use Apache::loncoursedata; -use GDBM_File; +use Apache::lonnet; # for logging porpoises +use Apache::lonlocal; +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 $show_links 'yes' or 'no' for linking to student performance data + +=item $output_mode 'html', 'excel', or 'csv' for output mode + +=item $show 'all', 'totals', or 'scores' determines how much data is output + +=item $single_student_mode evaluates to true if we are showing only one +student. + +=cut + +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $chosen_output; +my $single_student_mode; + +####################################################### +####################################################### +# End of package variable declarations + +=pod + +=back + +=cut + +####################################################### +####################################################### + +=pod + +=item &BuildStudentAssessmentPage() + +Inputs: + +=over 4 + +=item $r Apache Request + +=item $c Apache Connection + +=back -#my $jr; +=cut +####################################################### +####################################################### sub BuildStudentAssessmentPage { - my ($cacheDB,$students,$courseID,$formName,$headings,$spacing, - $studentInformation,$r,$c)=@_; -# $jr = $r; - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print('Unable to tie database.'); + 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'}); + 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; + # + 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 ; } + # + # 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); + 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 .= ''; } + # + # Build the next student link + my $next = &Apache::lonstatistics::next_student(); + my $nextbutton = ''; + if (defined($next)) { + my $sname = $next->{'username'}.':'.$next->{'domain'}; + $nextbutton .= ''; + } else { + $nextbutton .= ''; + } + # + # Build the 'all students' button + my $all = ''; + $all .= ''; + $Str .= $previousbutton.(' 'x5).$all.(' 'x5).$nextbutton; + return $Str; +} - $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings, - $sequenceKeys, $sequenceHeadings)); - untie(%cache); - if($c->aborted()) { return $Str; } - - my $selected=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, $_);
-                }
-            }
-            my $displayString = '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);
+#######################################################
+#######################################################
+
+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;
+}
 
+#######################################################
+#######################################################
 
-#    $r->print("AverageTtal");
-    $r->print(&StudentAverageTotal(\%cache, $spacing, $sequenceKeys));
-    $r->print("\n");
-    $r->rflush();
-    untie(%cache);
+=pod
 
+=item &CreateInterface()
 
-    $r->print('
'."\n"); - if($selected == 0) { - $Str .= '

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

'; - $r->print($Str); - } +Called by &BuildStudentAssessmentPage to create the top part of the +page which displays the chart. - return; -} +Inputs: None -#---- Student Assessment Web Page -------------------------------------------- +Returns: A string containing the HTML for the headers and top table for +the chart page. -sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; +=cut +####################################################### +####################################################### +sub CreateInterface { my $Str = ''; - $Str .= &CreateLegend(); - $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''."\n"; + # $Str .= ''."\n"; - } - - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''."\n"; - } - - return $present; -} - -#---- END Student Assessment Web Page ---------------------------------------- - -#---- Student Assessment Worker Functions ------------------------------------ - -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; +####################################################### +####################################################### +sub StudentTriesOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + my $performance_length = 0; + my @TriesData = (); + my $tries; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + 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'}; + } + # + 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=' '; } - } else { - $selectedName = $students->[$index]; - return $selectedName; } - last; + # + if (! defined($tries)) { + $tries = $symbol; + } + push (@TriesData,$tries); + # + 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'}; + } + 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 -$cache: A pointer to the hash tied to the cached data +=item $studentdata Hash ref to all student data -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=item $seq Hash ref, the sequence we are working on -Output: 0 (false), 1 (true) +=item $links if defined we will output links to each resource. =back =cut -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); +####################################################### +####################################################### +sub StudentPerformanceOnSequence { + my ($student,$studentdata,$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; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + foreach my $part (@{$resource->{'parts'}}) { + $partscore = undef; + my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', + $resource->{'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 = 0; + if (exists($resource_data->{'resource.'.$part.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$part.'.awarded'}; + $awarded = 0 if (! $awarded); + } + # + $partscore = $weight*$awarded; + $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. + } + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$part.'.tries'})){ + $symbol = '.'; + } else { + $symbol = ' '; + } + } + # + if (! defined($partscore)) { + $partscore = $symbol; + } + push (@ScoreData,$partscore); + # + if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) { + $symbol = ''.$symbol.''; + } + $Str .= $symbol; + } + } + 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; } -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### + +=pod + +=back + +=cut + +####################################################### +####################################################### 1; + __END__ 500 Internal Server Error

Internal Server Error

The server encountered an internal error or misconfiguration and was unable to complete your request.

Please contact the server administrator at root@localhost to inform them of the time this error occurred, and the actions you performed just before this error.

More information about this error may be available in the server error log.

'."\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); + 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 .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= ' 'x5; + $Str .= '
'; return $Str; } -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +####################################################### +####################################################### - my $Str = ''; - $Str .= ''."\n"; +=pod - $Str .= ''."\n"; - $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings, - $sequenceKeys); - $Str .= ''."\n"; - - $Str .= ''."\n"; - my $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $infoKeys, - $infoHeadings, - $displayString, - 'preformatted'); - - $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $sequenceKeys, - $sequenceHeadings, - $displayString, - 'preformatted'); +=item &CreateAndParseOutputSelector() - $Str .= ''; - $Str .= '
DISPLAYDATAFORMATTING';
-    $displayString .= $spacing.'
DISPLAYDATAFORMATTING'.$spacing;
-    $displayString .= '
Total Solved/Total Problems
'."\n"; +=cut + +####################################################### +####################################################### +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', + }, + ); +sub OutputDescriptions { + my $Str = ''; + $Str .= "

Output Formats

\n"; + $Str .= "
\n"; + foreach my $outputmode (@OutputOptions) { + $Str .="
".$outputmode->{'name'}."
\n"; + $Str .="
".$outputmode->{'description'}."
\n"; + } + $Str .= "
\n"; return $Str; } -=pod +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'}; + } -=item &FormatStudentData() + # + # Build the form element + $Str = qq/"; + return $Str; +} -First, FormatStudentInformation is called and prefixes the course information. -This function produces a formatted string of the student's course information. -Each column of data represents all the problems for a given sequence. For -valid grade data, a link is created for that problem to a submission record -for that problem. +## +## 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, + 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, + 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, + 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.', + }, + { 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, + 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', + }, + ); -=over 4 +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; +} -Input: $name, $studentInformation, $ChartDB +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; + +} -$name: The name and domain of the current student in name:domain format +####################################################### +####################################################### -$studentInformation: A pointer to an array holding the names used to -remove data from the hash. They represent -the name of the data to be removed. +=pod -$ChartDB: The name of the cached data database which will be tied to that -database. +=head2 HTML output routines -Output: $Str +=item &html_initialize($r) -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +Create labels for the columns of student data to show. -=back +=item &html_outputstudent($r,$student) + +Return a line of the chart for a student. + +=item &html_finish($r) =cut -sub StudentReport { - my ($cache,$name,$spacing,$showSequences)=@_; - my ($username,$domain)=split(':',$name); +####################################################### +####################################################### +{ + my $padding; + my $count; + + my $nodata_count; # The number of students for which there is no data + my %prog_state; # progress state used by loncommon PrgWin routines + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 0; + $nodata_count = 0; + undef(%prog_state); + # + $r->print("

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

"); - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; + if ($chosen_output->{'base'} !~ /^final table/) { + $r->print("

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

"); } - 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'; - $Str .= ''; - my $code = $cache->{$name.':'.$problemID.':'.$_.':code'}; - my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'}; - if($code eq '*' && $tries < 10 && $tries ne '') { - $code = $tries; - } - $Str .= $code; - $Str .= ''; - $characterCount++; + 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
+    foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){
+        #
+        # Comptue column widths
+        $sequence->{'width_sum'} = 0;
+        if ($chosen_output->{'sequence_sum'}) {
+            # Use 3 digits for the sum
+            $sequence->{'width_sum'} = 3;
+        }
+        if ($chosen_output->{'sequence_max'}) {
+            if ($sequence->{'width_sum'}>0) {
+                # One digit for the '/'
+                $sequence->{'width_sum'} +=1;
             }
+            # Use 3 digits for the total
+            $sequence->{'width_sum'}+=3;
         }
-
-        # 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.'';
-    } else {
-        $Str .= '           ';
-    }
-
-    if($hasVersion eq 'false') {
-        $Str = 'No course data.';
+	#
+        if ($chosen_output->{'every_problem'}) {
+            # one problem per digit
+            $sequence->{'width_problem'} = $sequence->{'num_assess_parts'};
+        } else {
+            $sequence->{'width_problem'} = 0;
+        }
+        $sequence->{'width_total'} = $sequence->{'width_problem'} + 
+                                     $sequence->{'width_sum'};
+        if ($sequence->{'width_total'} < length(&HTML::Entities::decode($sequence->{'title'}))) {
+            $sequence->{'width_total'} = length(&HTML::Entities::decode($sequence->{'title'}));
+        }
+        #
+        # Output the sequence titles
+        $Str .= 
+            $sequence->{'title'}.' 'x($sequence->{'width_total'}-
+                                      length($sequence->{'title'})
+                                      ).$padding;
     }
-
-    return $Str;
+    $Str .= "total
\n"; + $Str .= "
";
+    $r->print($Str);
+    $r->rflush();
+    return;
 }
 
-
-sub StudentAverageTotal {
-    
-    return "";
-
-    my ($cache,$name,$spacing,$showSequences)=@_;
-    my $username = $name;
+sub html_outputstudent {
+    my ($r,$student) = @_;
     my $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';
-                $Str .= '';
-                my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};
-                my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};
-                if($code eq '*' && $tries < 10 && $tries ne '') {
-                    $code = $tries;
-                }
-                $Str .= $code;
-                $Str .= '';
-                $characterCount++;
+    #
+    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};
+        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;
+    }
+    #
+    # By sequence build up the data
+    my $studentstats;
+    my $PerformanceStr = '';
+    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,$show_links);
+        } else {
+            ($performance,$performance_length,$score,$seq_max,$rawdata) =
+                &StudentPerformanceOnSequence($student,\%StudentsData,
+                                              $seq,$show_links);
+        }
+        my $ratio='';
+        if ($chosen_output->{'sequence_sum'}) {
+            $ratio .= sprintf("%3d",$score);
+        }
+        if ($chosen_output->{'sequence_max'}) {
+            if ($chosen_output->{'sequence_sum'}) {
+                $ratio .= '/';
             }
+            $ratio .= sprintf("%3d",$seq_max);
+        }
+        #
+        if (! $chosen_output->{'every_problem'}) {
+            $performance = '';
+	    $performance_length=0;
         }
+        $performance .= ' 'x($seq->{'width_total'}-$performance_length-$seq->{'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) = (0,0);
+    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'};
+        }
+        $score += $seq_stats->{'score'};
+        $max   += $seq_stats->{'max'};
+    }
+    $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
+    $Str .= " \n";
+    #
+    $r->print($Str);
+    #
+    $r->rflush();
+    return;
+}    
 
-        # Output the number of correct answers for the current sequence.
-        # This part takes up 6 character slots, but is formated right
-        # justified.
-        my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;
-        $spacesNeeded -= 3;
-        $Str .= (' 'x$spacesNeeded);
-
-#        my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence.
-#							    ':problemsCorrect'});
-
-	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.'';
-    } else {
-        $Str .= '           ';
+sub html_finish {
+    my ($r) = @_;
+    #
+    # 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()); + } } + $r->rflush(); + return; +} - if($hasVersion eq 'false') { - $Str = 'No course data.'; +sub StudentAverageTotal { + my $Str = "

Summary Tables

\n"; + my $num_students = scalar(@Apache::lonstatistics::Students); + my $total_ave = 0; + my $total_max = 0; + $Str .= ''."\n"; + $Str .= "\n"; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my $ave; + if ($num_students > $nodata_count) { + $ave = int(100*($Statistics->{$seq->{'symb'}}->{'score'}/ + ($num_students-$nodata_count)))/100; + } else { + $ave = 0; + } + $total_ave += $ave; + my $max = $Statistics->{$seq->{'symb'}}->{'max'}; + $total_max += $max; + $ave = sprintf("%.2f",$ave); + $Str .= ''. + ''. + ''."\n"; } + $total_ave = sprintf('%.2f',$total_ave); # only two digit + $Str .= "
TitleAverageMaximum
'.$seq->{'title'}.''.$ave.' '.$max.' '.'
\n"; + $Str .= ''."\n"; + $Str .= ''. + "\n"; + $Str .= ''. + ''. + ''. + ''; + $Str .= "
Number of StudentsAverageMaximum
'.($num_students-$nodata_count).''.$total_ave.' '.''.$total_max.' '.'
\n"; + return $Str; +} +sub SingleStudentTotal { + my $student = &Apache::lonstatistics::current_student(); + my $Str = "

Summary table for ".$student->{'fullname'}." ". + $student->{'username'}.'@'.$student->{'domain'}."

\n"; + $Str .= ''."\n"; + $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 .= "
Sequence or FolderScoreMaximum
'.$seq->{'title'}.''.$value.''.$max.'
Total'.$total.''.$total_max."
\n"; return $Str; } +} +####################################################### +####################################################### =pod -=item &CreateLegend() +=head2 EXCEL subroutines -This function returns a formatted string containing the legend for the -chart. The legend describes the symbols used to represent grades for -problems. +=item &excel_initialize($r) -=cut +=item &excel_outputstudent($r,$student) -sub CreateLegend { - my $Str = "

".
-              "   1  correct by student in 1 try\n".
-              "   7  correct by student in 7 tries\n".
-              "   *  correct by student in more than 9 tries\n".
-	      "   +  correct by override\n".
-              "   -  incorrect by override\n".
-	      "   .  incorrect attempted\n".
-	      "   #  ungraded attempted\n".
-              "      not attempted (blank field)\n".
-	      "   x  excused".
-              "

"; - return $Str; -} +=item &excel_finish($r) -=pod +=cut -=item &CreateColumnSelectionBox() +####################################################### +####################################################### +{ + +my $excel_sheet; +my $excel_workbook; + +my $filename; +my $rows_output; +my $cols_output; + +my %prog_state; # progress window state +my $request_aborted; + +my $total_formula; + +sub excel_initialize { + my ($r) = @_; + # + undef ($excel_sheet); + undef ($excel_workbook); + undef ($filename); + undef ($rows_output); + undef ($cols_output); + undef (%prog_state); + undef ($request_aborted); + undef ($total_formula); + # + my $total_columns = scalar(&get_student_fields_to_show()); + my $num_students = scalar(@Apache::lonstatistics::Students); + # + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + if ($chosen_output->{'every_problem'}) { + $total_columns += $seq->{'num_assess_parts'}; + } + # Add 2 because we need a 'sequence_sum' and 'total' column for each + $total_columns += 2; + } + if ($chosen_output->{'base'} eq 'tries' && $total_columns > 255) { + $r->print(<Unable to Complete Request +

+LON-CAPA is unable to produce your Excel spreadsheet because your selections +will result in more than 255 columns. Excel allows only 255 columns in a +spreadsheet. +

+You may consider reducing the number of Sequences or Folders you +have selected. +

+LON-CAPA can produce CSV files of this data or Excel files of the +summary data (Parts Correct or Parts Correct & Totals). +

+END + $request_aborted = 1; + } + if ($chosen_output->{'base'} eq 'scores' && $total_columns > 255) { + $r->print(<Unable to Complete Request +

+LON-CAPA is unable to produce your Excel spreadsheet because your selections +will result in more than 255 columns. Excel allows only 255 columns in a +spreadsheet. +

+You may consider reducing the number of Sequences or Folders you +have selected. +

+LON-CAPA can produce CSV files of this data or Excel files of the +Scores Summary data. +

+END + $request_aborted = 1; + } + return if ($request_aborted); + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + # Determine rows + my $header_row = $rows_output++; + my $description_row = $rows_output++; + $rows_output++; # blank row + my $summary_header_row; + if ($chosen_output->{'summary_table'}) { + $summary_header_row = $rows_output++; + $rows_output+= scalar(&Apache::lonstatistics::Sequences_with_Assess()); + $rows_output++; + } + my $sequence_name_row = $rows_output++; + my $resource_name_row = $rows_output++; + my $maximum_data_row = $rows_output++; + if (! $chosen_output->{'maximum_row'}) { + $rows_output--; + } + my $first_data_row = $rows_output++; + # + # 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); + # + my $format = &Apache::loncommon::define_excel_formats($excel_workbook); + # + # Add a worksheet + my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $sheetname = &Apache::loncommon::clean_excel_name($sheetname); + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Put the course description in the header + $excel_sheet->write($header_row,$cols_output++, + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}, + $format->{'h1'}); + $cols_output += 3; + # + # Put a description of the sections listed + my $sectionstring = ''; + my @Sections = @Apache::lonstatistics::SelectedSections; + if (scalar(@Sections) > 1) { + if (scalar(@Sections) > 2) { + my $last = pop(@Sections); + $sectionstring = "Sections ".join(', ',@Sections).', and '.$last; + } else { + $sectionstring = "Sections ".join(' and ',@Sections); + } + } else { + if ($Sections[0] eq 'all') { + $sectionstring = "All sections"; + } else { + $sectionstring = "Section ".$Sections[0]; + } + } + $excel_sheet->write($header_row,$cols_output++,$sectionstring, + $format->{'h3'}); + $cols_output += scalar(@Sections); + # + # Put the date in there too + $excel_sheet->write($header_row,$cols_output++, + 'Compiled on '.localtime(time),$format->{'h3'}); + # + $cols_output = 0; + $excel_sheet->write($description_row,$cols_output++, + $chosen_output->{'shortdesc'}, + $format->{'h3'}); + ############################################## + # Output headings for the raw data + ############################################## + # + # Add the student headers + $cols_output = 0; + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write($resource_name_row,$cols_output++,$field, + $format->{'bold'}); + } + # + # Add the remaining column headers + my $total_formula_string = '=0'; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $excel_sheet->write($sequence_name_row,, + $cols_output,$seq->{'title'},$format->{'bold'}); + # Determine starting cell + $seq->{'Excel:startcell'}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $seq->{'Excel:startcol'}=$cols_output; + my $count = 0; + if ($chosen_output->{'every_problem'}) { + # Put the names of the problems and parts into the sheet + foreach my $res (@{$seq->{'contents'}}) { + if ($res->{'type'} ne 'assessment' || + ! exists($res->{'parts'}) || + ref($res->{'parts'}) ne 'ARRAY' || + scalar(@{$res->{'parts'}}) < 1) { + next; + } + if (scalar(@{$res->{'parts'}}) > 1) { + foreach my $part (@{$res->{'parts'}}) { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->{'title'}.' part '.$part, + $format->{'bold'}); + } + } else { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->{'title'},$format->{'bold'}); + } + $count++; + } + } + # Determine ending cell + if ($count <= 1) { + $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'}; + $seq->{'Excel:endcol'} = $seq->{'Excel:startcol'}; + } else { + $seq->{'Excel:endcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output-1); + $seq->{'Excel:endcol'} = $cols_output-1; + } + # Create the formula for summing up this sequence + if (! exists($seq->{'Excel:endcell'}) || + ! defined($seq->{'Excel:endcell'})) { + $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'}; + } + $seq->{'Excel:sum'}= $excel_sheet->store_formula + ('=SUM('.$seq->{'Excel:startcell'}. + ':'.$seq->{'Excel:endcell'}.')'); + # Determine cell the score is held in + $seq->{'Excel:scorecell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $seq->{'Excel:scorecol'}=$cols_output; + if ($chosen_output->{'base'} eq 'parts correct total') { + $excel_sheet->write($resource_name_row,$cols_output++, + 'parts correct', + $format->{'bold'}); + } elsif ($chosen_output->{'sequence_sum'}) { + if ($chosen_output->{'correct'}) { + # Only reporting the number correct, so do not call it score + $excel_sheet->write($resource_name_row,$cols_output++, + 'sum', + $format->{'bold'}); + } else { + $excel_sheet->write($resource_name_row,$cols_output++, + 'score', + $format->{'bold'}); + } + } + # + $total_formula_string.='+'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output-1); + if ($chosen_output->{'sequence_max'}) { + $excel_sheet->write($resource_name_row,$cols_output++, + 'maximum', + $format->{'bold'}); + } + } + if ($chosen_output->{'grand_total'}) { + $excel_sheet->write($resource_name_row,$cols_output++,'Total', + $format->{'bold'}); + } + $total_formula = $excel_sheet->store_formula($total_formula_string); + ############################################## + # Output a row for MAX, if appropriate + ############################################## + if ($chosen_output->{'maximum_row'}) { + $cols_output = 0; + foreach my $field (&get_student_fields_to_show()) { + if ($field eq 'username' || $field eq 'fullname' || + $field eq 'id') { + $excel_sheet->write($maximum_data_row,$cols_output++,'Maximum', + $format->{'bold'}); + } else { + $excel_sheet->write($maximum_data_row,$cols_output++,''); + } + } + # + # Add the maximums for each sequence or assessment + my %total_cell_translation; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $cols_output=$seq->{'Excel:startcol'}; + $total_cell_translation{$seq->{'Excel:scorecell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$seq->{'Excel:scorecol'}); + my $weight; + my $max = 0; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + foreach my $part (@{$resource->{'parts'}}) { + $weight = 1; + if ($chosen_output->{'scores'}) { + $weight = &Apache::lonnet::EXT + ('resource.'.$part.'.weight',$resource->{'symb'}, + undef,undef,undef); + if (!defined($weight) || ($weight eq '')) { + $weight=1; + } + } + if ($chosen_output->{'scores'} && + $chosen_output->{'every_problem'}) { + $excel_sheet->write($maximum_data_row,$cols_output++, + $weight); + } + $max += $weight; + } + } + # + if ($chosen_output->{'sequence_sum'} && + $chosen_output->{'every_problem'}) { + my %replaceCells; + $replaceCells{$seq->{'Excel:startcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$seq->{'Excel:startcol'}); + $replaceCells{$seq->{'Excel:endcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$seq->{'Excel:endcol'}); + $excel_sheet->repeat_formula($maximum_data_row,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells); + } elsif ($chosen_output->{'sequence_sum'}) { + $excel_sheet->write($maximum_data_row,$cols_output++,$max); + } + if ($chosen_output->{'sequence_max'}) { + $excel_sheet->write($maximum_data_row,$cols_output++,$max); + } + # + } + if ($chosen_output->{'grand_total'}) { + $excel_sheet->repeat_formula($maximum_data_row,$cols_output++, + $total_formula,undef, + %total_cell_translation); + } + } # End of MAXIMUM row output if ($chosen_output->{'maximum_row'}) { + $rows_output = $first_data_row; + ############################################## + # Output summary table, which actually is above the sequence name row. + ############################################## + if ($chosen_output->{'summary_table'}) { + $cols_output = 0; + $excel_sheet->write($summary_header_row,$cols_output++, + 'Summary Table',$format->{'bold'}); + if ($chosen_output->{'maximum_row'}) { + $excel_sheet->write($summary_header_row,$cols_output++, + 'Maximum',$format->{'bold'}); + } + $excel_sheet->write($summary_header_row,$cols_output++, + 'Average',$format->{'bold'}); + $excel_sheet->write($summary_header_row,$cols_output++, + 'Median',$format->{'bold'}); + $excel_sheet->write($summary_header_row,$cols_output++, + 'Std Dev',$format->{'bold'}); + my $row = $summary_header_row+1; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $cols_output = 0; + $excel_sheet->write($row,$cols_output++, + $seq->{'title'}, + $format->{'bold'}); + if ($chosen_output->{'maximum_row'}) { + $excel_sheet->write + ($row,$cols_output++, + '='. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$seq->{'Excel:scorecol'}) + ); + } + my $range = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$seq->{'Excel:scorecol'}). + ':'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row+$num_students-1,$seq->{'Excel:scorecol'}); + $excel_sheet->write($row,$cols_output++, + '=AVERAGE('.$range.')'); + $excel_sheet->write($row,$cols_output++, + '=MEDIAN('.$range.')'); + $excel_sheet->write($row,$cols_output++, + '=STDEV('.$range.')'); + $row++; + } + } + ############################################## + # Take care of non-excel initialization + ############################################## + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + if ($ENV{'form.SelectedStudent'}) { + $studentcount = '1'; + } + if ($studentcount > 1) { + $r->print('

'.&mt('Compiling Excel spreadsheet for [_1] students', + $studentcount)."

\n"); + } else { + $r->print('

'. + &mt('Compiling Excel spreadsheet for 1 student'). + "

\n"); + } + $r->rflush(); + # + # Initialize progress window + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Excel File Compilation Status', + 'Excel File Compilation Progress', $studentcount); + # + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state, + 'Processing first student'); + return; +} -If there are columns not being displayed then this selection box is created -with a list of those columns. When selections are made and the page -refreshed, the columns will be removed from this box and the column is -put back in the chart. If there is no columns to select, no row is added -to the interface table. +sub 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) { + $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 + my %total_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'}); + # + 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) { + $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; + $replaceCells{$seq->{'Excel:startcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:startcol'}); + $replaceCells{$seq->{'Excel:endcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:endcol'}); + # The undef is for the format + if (scalar(keys(%replaceCells)) == 1) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells,%replaceCells); + } else { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells); + } + } elsif ($chosen_output->{'sequence_sum'}) { + $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); + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} -=over 4 -Input: $CacheData, $headings +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; +} +} +####################################################### +####################################################### -$CacheData: A pointer to a hash tied to the cached data +=pod -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=head2 CSV output routines -Output: $notThere +=item &csv_initialize($r) -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. +=item &csv_outputstudent($r,$student) -=back +=item &csv_finish($r) =cut -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; - - my $notThere = ''; - $notThere .= ''; +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 $notThere; } +####################################################### +####################################################### + =pod -=item &CreateColumnSelectors() +=item &StudentTriesOnSequence() -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. +Inputs: =over 4 -Input: $CacheData, $headings +=item $student -$CacheData: A pointer to a hash tied to the cached data +=item $studentdata Hash ref to all student 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 +=item $seq Hash ref, the sequence we are working on -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. +=item $links if defined we will output links to each resource. =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 .= '