--- loncom/interface/statistics/lonstudentassessment.pm 2002/10/22 16:27:39 1.15 +++ loncom/interface/statistics/lonstudentassessment.pm 2009/05/17 23:13:49 1.155 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.15 2002/10/22 16:27:39 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.155 2009/05/17 23:13:49 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,584 +24,2159 @@ # 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::lonhtmlcommon; +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 Apache::grades(); +use Apache::lonmsgdisplay(); +use Time::HiRes; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); +use lib '/home/httpd/lib/perl/'; +use LONCAPA; + + +####################################################### +####################################################### +=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 -#my $jr; +=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 + +=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', + 'Groups' => 'array', + 'StudentData' => 'array', + 'Maps' => 'array'); + &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters); + &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters); + # + &Apache::lonstatistics::PrepareClasslist(); + # + $single_student_mode = 0; + $single_student_mode = 1 if ($env{'form.SelectedStudent'}); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['selectstudent']); + if ($env{'form.selectstudent'}) { + &Apache::lonstatistics::DisplayClasslist($r); return; } - - # Remove students who don't have the proper section. - my @sectionsSelected = split(':',$cache{'sectionsSelected'}); - for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0; - $studentIndex--) { - my $value = $cache{$students->[$studentIndex].':section'}; - my $found = 0; - foreach (@sectionsSelected) { - if($_ eq 'none') { - if($value eq '' || !defined($value) || $value eq ' ') { - $found = 1; - last; - } - } else { - if($value eq $_) { - $found = 1; - last; - } - } - } - if($found == 0) { - splice(@$students, $studentIndex, 1); + # + # Print out the HTML headers for the interface + # This also parses the output mode selector + # This step must *always* be done. + $r->print(&CreateInterface()); + $r->print(''); + $r->print(''); + $r->rflush(); + # + if (! exists($env{'form.notfirstrun'}) && ! $single_student_mode) { + return; + } + $r->print('

'. + &Apache::lonstatistics::section_and_enrollment_description(). + '

'); + # + 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 .= ''; } - - $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);
-        }
-    }
-    $r->print('
'."\n"); - if($selected == 0) { - $Str .= '

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

'; - $r->print($Str); + # + # Build the next student link + my $next = &Apache::lonstatistics::next_student(); + my $nextbutton = ''; + if (defined($next)) { + my $sname = $next->{'username'}.':'.$next->{'domain'}; + $nextbutton .= ''; + } else { + $nextbutton .= ''; } + # + # Build the 'all students' button + my $all = ''; + $all .= ''; + $Str .= $previousbutton.(' 'x5).$all.(' 'x5).$nextbutton; + return $Str; +} - return; +####################################################### +####################################################### + +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; } -#---- Student Assessment Web Page -------------------------------------------- +####################################################### +####################################################### -sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; +=pod - my $Str = ''; - $Str .= &CreateLegend(); - $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''."\n"; + # $Str .= ''. + ''. + ''. + &Apache::loncommon::end_data_table_header_row().$/; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + my $ave; + my $num_students = $Statistics->{$symb}->{'num_students'}; + if ($num_students > 0) { + $ave = int(100* + ($Statistics->{$symb}->{'score'}/$num_students) + )/100; + } else { + $ave = 0; + } + my $max = $Statistics->{$symb}->{'max'}; + $ave = sprintf("%.2f",$ave); + $Str .= &Apache::loncommon::start_data_table_row(). + ''. + ''. + ''. + &Apache::loncommon::end_data_table_row()."\n"; + } + $Str .= &Apache::loncommon::end_data_table()."\n"; return $Str; } -=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. +sub SingleStudentTotal { + return if (! defined($navmap)); + my $student = &Apache::lonstatistics::current_student(); + my $Str = '

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

'; + $Str .= $/; + $Str .= &Apache::loncommon::start_data_table()."\n"; + $Str .= + &Apache::loncommon::start_data_table_header_row(). + ''; + if ($chosen_output->{'base'} eq 'tries') { + $Str .= ''; + } else { + $Str .= ''; + } + $Str .= ''. + &Apache::loncommon::end_data_table_header_row()."\n"; + my $total = 0; + my $total_max = 0; + foreach my $seq (@sequences) { + my $value = $Statistics->{$seq->symb}->{'score'}; + my $max = $Statistics->{$seq->symb}->{'max'}; + $Str .= &Apache::loncommon::start_data_table_row(). + ''. + ''. + ''. + &Apache::loncommon::end_data_table_row()."\n"; + $total += $value; + $total_max +=$max; + } + $Str .= &Apache::loncommon::start_data_table_row(). + ''. + ''. + ''. + &Apache::loncommon::end_data_table_row()."\n"; + $Str .= &Apache::loncommon::end_data_table()."\n"; + return $Str; +} -=over 4 -Input: $CacheData, $headings +} +####################################################### +####################################################### -$CacheData: A pointer to a hash tied to the cached data +=pod -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=head2 EXCEL subroutines -Output: $notThere +=item &excel_initialize($r) -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. +=item &excel_outputstudent($r,$student) -=back +=item &excel_finish($r) =cut -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; +####################################################### +####################################################### +{ + +my $excel_sheet; +my $excel_workbook; +my $format; + +my $filename; +my $rows_output; +my $cols_output; + +my %prog_state; # progress window state +my $request_aborted; + +my $total_formula; +my $maximum_formula; +my %formula_data; + +my $navmap; +my @sequences; + +sub excel_cleanup { + # + undef ($excel_sheet); + undef ($excel_workbook); + undef ($filename); + undef ($rows_output); + undef ($cols_output); + undef (%prog_state); + undef ($request_aborted); + undef ($total_formula); + undef ($maximum_formula); + # + undef(%formula_data); + # + undef($navmap); + undef(@sequences); +} - my $notThere = ''; - $notThere .= ''; + my $start = $formula_data{$symb}->{'Excel:startcell'}; + my $end = $formula_data{$symb}->{'Excel:endcell'}; + $formula_data{$symb}->{'Excel:sum'}= $excel_sheet->store_formula + ("=IF(COUNT($start\:$end),SUM($start\:$end),\"\")"); + # Determine cell the score is held in + $formula_data{$symb}->{'Excel:scorecell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $formula_data{$symb}->{'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'}); + $formula_data{$symb}->{'Excel:maxcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $formula_data{$symb}->{'Excel:maxcol'}=$cols_output; + $maximum_formula_string.='+'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $cols_output++; - return $notThere; + } + } + if ($chosen_output->{'grand_total'}) { + $excel_sheet->write($resource_name_row,$cols_output++,'Total', + $format->{'bold'}); + } + if ($chosen_output->{'grand_maximum'}) { + $excel_sheet->write($resource_name_row,$cols_output++,'Max. Total', + $format->{'bold'}); + } + $total_formula = $excel_sheet->store_formula($total_formula_string); + $maximum_formula = $excel_sheet->store_formula($maximum_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; + my %maximum_cell_translation; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + $cols_output=$formula_data{$symb}->{'Excel:startcol'}; + $total_cell_translation{$formula_data{$symb}->{'Excel:scorecell'}}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$formula_data{$symb}->{'Excel:scorecol'}); + $maximum_cell_translation{$formula_data{$symb}->{'Excel:maxcell'}}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$formula_data{$symb}->{'Excel:maxcol'}); + my $weight; + my $max = 0; + foreach my $resource (&get_resources($navmap,$seq)) { + 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= + ('^'.$formula_data{$symb}->{'Excel:startcell'}.':'. + $formula_data{$symb}->{'Excel:endcell'}.'$' => + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($maximum_data_row,$formula_data{$symb}->{'Excel:startcol'}).':'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($maximum_data_row,$formula_data{$symb}->{'Excel:endcol'})); + $excel_sheet->repeat_formula($maximum_data_row,$cols_output++, + $formula_data{$symb}->{'Excel:sum'},undef, + %replaceCells, %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); + } + if ($chosen_output->{'grand_maximum'}) { + $excel_sheet->repeat_formula($maximum_data_row,$cols_output++, + $maximum_formula,undef, + %maximum_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 (@sequences) { + my $symb = $seq->symb; + $cols_output = 0; + $excel_sheet->write($row,$cols_output++, + $seq->compTitle, + $format->{'bold'}); + if ($chosen_output->{'maximum_row'}) { + $excel_sheet->write + ($row,$cols_output++, + '='. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($maximum_data_row,$formula_data{$symb}->{'Excel:scorecol'}) + ); + } + my $range = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$formula_data{$symb}->{'Excel:scorecol'}). + ':'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row+$num_students-1,$formula_data{$symb}->{'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'; + } + $r->print('

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

\n" + ); + $r->rflush(); + # + # Initialize progress window + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Excel File Compilation Status', + 'Excel File Compilation Progress', $studentcount, + 'inline',undef,'Statistics','stats_status'); + # + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state, + 'Processing first student'); + return; } -=pod +sub excel_outputstudent { + my ($r,$student) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($excel_sheet)) { + return; + } + $cols_output=0; + # + # Write out student data + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsgdisplay::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $excel_sheet->write($rows_output,$cols_output++,$value); + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $env{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Write out sequence scores and totals data + my %total_cell_translation; + my %maximum_cell_translation; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + $cols_output = $formula_data{$symb}->{'Excel:startcol'}; + # Keep track of cells to translate in total cell + $total_cell_translation{$formula_data{$symb}->{'Excel:scorecell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$formula_data{$symb}->{'Excel:scorecol'}); + # and maximum cell + $maximum_cell_translation{$formula_data{$symb}->{'Excel:maxcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$formula_data{$symb}->{'Excel:maxcol'}); + # + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'} || $chosen_output->{'correct'}){ + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_tries_on_sequence($student,\%StudentsData, + $navmap,$seq,'no'); + } else { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_performance_on_sequence($student,\%StudentsData, + $navmap,$seq,'no', + $chosen_output->{ignore_weight}); + } + if ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + # only indiciate if each item is correct or not + foreach my $value (@$rawdata) { + # positive means correct, 0 or negative means + # incorrect + $value = $value > 0 ? 1 : 0; + $excel_sheet->write($rows_output,$cols_output++,$value); + } + } else { + foreach my $value (@$rawdata) { + if ($score eq ' ' || !defined($value)) { + $cols_output++; + } else { + $excel_sheet->write($rows_output,$cols_output++, + $value); + } + } + } + } + if ($chosen_output->{'sequence_sum'} && + $chosen_output->{'every_problem'}) { + # Write a formula for the sum of this sequence + my %replaceCells= + ('^'.$formula_data{$symb}->{'Excel:startcell'}.':'.$formula_data{$symb}->{'Excel:endcell'}.'$' + => + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$formula_data{$symb}->{'Excel:startcol'}).':'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$formula_data{$symb}->{'Excel:endcol'}) + ); + # The undef is for the format + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $formula_data{$symb}->{'Excel:sum'},undef, + %replaceCells, %replaceCells); + } elsif ($chosen_output->{'sequence_sum'}) { + if ($score eq ' ') { + $cols_output++; + } else { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + } + if ($chosen_output->{'sequence_max'}) { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + if ($chosen_output->{'grand_total'}) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $total_formula,undef, + %total_cell_translation); + } + if ($chosen_output->{'grand_maximum'}) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $maximum_formula,undef, + %maximum_cell_translation); + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} -=item &CreateColumnSelectors() +sub excel_finish { + my ($r) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($excel_sheet)) { + &excel_cleanup(); + return; + } + # + # Write the excel file + $excel_workbook->close(); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print('
'. + ''.&mt('Your Excel spreadsheet').''."\n"); + $r->rflush(); + &excel_cleanup(); + return; +} -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. +} +####################################################### +####################################################### -=over 4 +=pod -Input: $CacheData, $headings +=head2 CSV output routines -$CacheData: A pointer to a hash tied to the cached data +=item &csv_initialize($r) -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns +=item &csv_outputstudent($r,$student) -Output: $present +=item &csv_finish($r) -$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. +=cut -=back +####################################################### +####################################################### +{ + +my $outputfile; +my $filename; +my $request_aborted; +my %prog_state; # progress window state +my $navmap; +my @sequences; + +sub csv_cleanup { + undef($outputfile); + undef($filename); + undef($request_aborted); + undef(%prog_state); + # + undef($navmap); + undef(@sequences); +} -=cut +sub csv_initialize{ + my ($r) = @_; -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; + &csv_cleanup(); + ($navmap,@sequences) = + &Apache::lonstatistics::selected_sequences_with_assessments(); + if (! ref($navmap)) { + # Unable to get data, so bail out + $r->print("

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

'); + } + # + # Deal with unimplemented requests + $request_aborted = undef; + if ($chosen_output->{'base'} =~ /final table/) { + $r->print(<Unable to Complete Request +

+The Summary Table (Scores) option is not available for non-HTML output. +

+END + $request_aborted = 1; + } + return if ($request_aborted); + # + # Initialize progress window + my $studentcount = scalar(@Apache::lonstatistics::Students); + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'CSV File Compilation Status', + 'CSV File Compilation Progress', $studentcount, + 'inline',undef,'Statistics','stats_status'); + # + # Open a file + ($outputfile,$filename) = &Apache::loncommon::create_text_file($r,'csv'); + if (! defined($outputfile)) { return ''; } + # + # Datestamp + my $description = $env{'course.'.$env{'request.course.id'}.'.description'}; + print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'. + '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'. + "\n"; + print $outputfile '"'. + &Apache::loncommon::csv_translate + (&Apache::lonstatistics::section_and_enrollment_description()). + '"'."\n"; + foreach my $item ('shortdesc','non_html_notes') { + next if (! exists($chosen_output->{$item})); + print $outputfile + '"'.&Apache::loncommon::csv_translate($chosen_output->{$item}).'"'. + "\n"; + } + # + # Print out the headings + my $sequence_row = ''; + my $resource_row = undef; + foreach my $field (&get_student_fields_to_show()) { + $sequence_row .='"",'; + $resource_row .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } + foreach my $seq (@sequences) { + $sequence_row .= '"'. + &Apache::loncommon::csv_translate($seq->compTitle).'",'; + my $count = 0; + if ($chosen_output->{'every_problem'}) { + foreach my $res (&get_resources($navmap,$seq)) { + if (scalar(@{$res->parts}) < 1) { + next; + } + foreach my $part (@{$res->parts}) { + $resource_row .= '"'. + &Apache::loncommon::csv_translate + ($res->compTitle.', Part '.$res->part_display($part)).'",'; + $count++; + } + } + } + $sequence_row.='"",'x$count; + if ($chosen_output->{'sequence_sum'}) { + if($chosen_output->{'correct'}) { + $resource_row .= '"sum",'; + } else { + $resource_row .= '"score",'; + } + } + if ($chosen_output->{'sequence_max'}) { + $sequence_row.= '"",'; + $resource_row .= '"maximum possible",'; + } + } + if ($chosen_output->{'grand_total'}) { + $sequence_row.= '"",'; + $resource_row.= '"Total",'; + } + if ($chosen_output->{'grand_maximum'}) { + $sequence_row.= '"",'; + $resource_row.= '"Maximum",'; + } + chomp($sequence_row); + chomp($resource_row); + print $outputfile $sequence_row."\n"; + print $outputfile $resource_row."\n"; + return; +} - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= '
'."\n"; +sub csv_outputstudent { + my ($r,$student) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($outputfile)) { + return; + } + my $Str = ''; + # + # Output student fields + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsgdisplay::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $Str .= '"'.&Apache::loncommon::csv_translate($value).'",'; + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $env{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; } + # + # Output performance data + my $total = 0; + my $maximum = 0; + foreach my $seq (@sequences) { + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'}){ + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_tries_on_sequence($student,\%StudentsData, + $navmap,$seq,'no'); + } else { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &student_performance_on_sequence($student,\%StudentsData, + $navmap,$seq,'no', + $chosen_output->{ignore_weight}); + } + if ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + $score = 0; + # Deal with number of parts correct data + $Str .= '"'.join('","',( map { if ($_>0) { + $score += 1; + 1; + } else { + 0; + } + } @$rawdata)).'",'; + } else { + $Str .= '"'.join('","',(@$rawdata)).'",'; + } + } + if ($chosen_output->{'sequence_sum'}) { + $Str .= '"'.$score.'",'; + } + if ($chosen_output->{'sequence_max'}) { + $Str .= '"'.$seq_max.'",'; + } + $total+=$score; + $maximum += $seq_max; + } + if ($chosen_output->{'grand_total'}) { + $Str .= '"'.$total.'",'; + } + if ($chosen_output->{'grand_maximum'}) { + $Str .= '"'.$maximum.'",'; + } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''."\n"; +sub csv_finish { + my ($r) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($outputfile)) { + &csv_cleanup(); + return; } + close($outputfile); + # + # 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(); + &csv_cleanup(); + return; + +} - return $present; } -#---- END Student Assessment Web Page ---------------------------------------- +# This function will return an HTML string including a star, with +# a mouseover popup showing the "real" value. An optional second +# argument lets you show something other than a star. +sub show_star { + my $popup = shift; + my $symbol = shift || '*'; + # Escape the popup for JS. + $popup =~ s/([^-a-zA-Z0-9:;,._ ()|!\/?=&*])/'\\' . sprintf("%lo", ord($1))/ge; + + return "$symbol"; +} -#---- Student Assessment Worker Functions ------------------------------------ +####################################################### +####################################################### -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; +=pod - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } +=item &StudentTriesOnSequence() + +Inputs: + +=over 4 + +=item $student + +=item $studentdata Hash ref to all student data + +=item $seq Hash ref, the sequence we are working on - 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; +=item $links if defined we will output links to each resource. + +=back + +=cut + +####################################################### +####################################################### +sub student_tries_on_sequence { + my ($student,$studentdata,$navmap,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + my $performance_length = 0; + my @TriesData = (); + my $tries; + my $hasdata = 0; # flag - true if the student has any data on the sequence + foreach my $resource (&get_resources($navmap,$seq)) { + my $resource_data = $studentdata->{$resource->symb}; + my $value = ''; + foreach my $partnum (@{$resource->parts()}) { + $tries = undef; + $max++; + $performance_length++; + my $symbol = ' '; # default to space + # + my $awarded = 0; + if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$partnum.'.awarded'}; + $awarded = 0 if (! $awarded); + } + # + my $status = ''; + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + $status = $resource_data->{'resource.'.$partnum.'.solved'}; + } + # + my $tries = 0; + if(exists($resource_data->{'resource.'.$partnum.'.tries'})) { + $tries = $resource_data->{'resource.'.$partnum.'.tries'}; + $hasdata =1; + } + # + if ($awarded > 0) { + # The student has gotten the problem correct to some degree + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_override' && !$resource->is_task()) { + $symbol = '+'; + $sum++; + } elsif ($tries > 0) { + if ($tries > 9) { + $symbol = show_star($tries); + } 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 = 'u'; + } elsif ($status eq 'incorrect_attempted' || + $tries > 0) { + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + # Problem is wrong and has not been attempted. + $symbol=' '; } + } + # + if (! defined($tries)) { + $tries = 0; + } + if ($status =~ /^(incorrect|ungraded)/) { + # Bug 3390: show '-' for tries on incorrect problems + # (csv & excel only) + push(@TriesData,-$tries); } else { - $selectedName = $students->[$index]; - return $selectedName; + push (@TriesData,$tries); } - last; + # + if ( ($links eq 'yes' && $symbol ne ' ') || + ($links eq 'all')) { + my $link = '/adm/grades'. + '?symb='.&escape($resource->shown_symb). + '&student='.$student->{'username'}. + '&userdom='.$student->{'domain'}. + '&command=submission'; + $symbol = &link($symbol, $link); + } + $value .= $symbol; } + $Str .= $value; } - - return 'No Student Selected'; + if ($seq->randompick()) { + $max = $seq->randompick(); + } + if (! $hasdata && $sum == 0) { + $sum = ' '; + } + return ($Str,$performance_length,$sum,$max,\@TriesData); } =pod -=item &ShouldShowColumn() +=item &link -Determine if a specified column should be shown on the chart. +Inputs: =over 4 -Input: $cache, $test +=item $text -$cache: A pointer to the hash tied to the cached data +=item $target -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=back -Output: 0 (false), 1 (true) +Takes the text and creates a link to the $text that honors +the value of 'new window' if clicked on, but uses a real +'href' so middle and right clicks still work. -=back +$target and $text are assumed to be already correctly escaped; i.e., it +can be dumped out directly into the output stream as-is. =cut -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; +sub link { + my ($text,$target) = @_; + return + "$text"; +} - my @infoKeys=(); - my @infoHeadings=(); +####################################################### +####################################################### - my @sequenceKeys=(); - my @sequenceHeadings=(); +=pod - my %doNotShow; +=item &student_performance_on_sequence - 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++; - } - } +Inputs: - 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++; +=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 student_performance_on_sequence { + my ($student,$studentdata,$navmap,$seq,$links,$awarded_only) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; # final result string + my ($score,$max) = (0,0); + my $performance_length = 0; + my $symbol; + my @ScoreData = (); + my $partscore; + my $hasdata = 0; # flag, 0 if there were no submissions on the sequence + foreach my $resource (&get_resources($navmap,$seq)) { + my $symb = $resource->symb; + my $resource_data = $studentdata->{$symb}; + foreach my $part (@{$resource->parts()}) { + $partscore = undef; + my $weight; + if (!$awarded_only){ + $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', + $symb, + $student->{'domain'}, + $student->{'username'}, + $student->{'section'}); + } + if (!defined($weight) || ($weight eq '')) { + $weight=1; + } + # + $max += $weight; # see the 'excused' branch below... + $performance_length++; # one character per part + $symbol = ' '; # default to space + # + my $awarded; + if (exists($resource_data->{'resource.'.$part.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$part.'.awarded'}; + $awarded = 0 if (! $awarded); + $hasdata = 1; + } + # + $partscore = &Apache::grades::compute_points($weight,$awarded); + if (! defined($awarded)) { + $partscore = undef; + } + $score += $partscore; + $symbol = $partscore; + if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) { + $symbol = sprintf("%.0f",$symbol); + } + if (length($symbol) > 1) { + $symbol = show_star($symbol); + } + if (exists($resource_data->{'resource.'.$part.'.solved'}) && + $resource_data->{'resource.'.$part.'.solved'} ne '') { + my $status = $resource_data->{'resource.'.$part.'.solved'}; + if ($status eq 'excused') { + $symbol = 'x'; + $max -= $weight; # Do not count 'excused' problems. + } elsif ($status eq 'ungraded_attempted') { + $symbol = 'u'; + } + $hasdata = 1; + } elsif ($resource_data->{'resource.'.$part.'.award'} eq 'DRAFT') { + $symbol = 'd'; + $hasdata = 1; + } elsif (!exists($resource_data->{'resource.'.$part.'.awarded'})){ + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$part.'.tries'})){ + $symbol = '.'; + $hasdata = 1; + } else { + $symbol = ' '; + } + } + # + if (! defined($partscore)) { + $partscore = $symbol; + } + push (@ScoreData,$partscore); + # + if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) { + my $link = '/adm/grades' . + '?symb='.&escape($resource->shown_symb). + '&student='.$student->{'username'}. + '&userdom='.$student->{'domain'}. + '&command=submission'; + $symbol = &link($symbol, $link); + } + $Str .= $symbol; } } + if (! $hasdata && $score == 0) { + $score = ' '; + } + return ($Str,$performance_length,$score,$max,\@ScoreData); +} - $doNotShow{'count'} = $count; +####################################################### +####################################################### - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); +=pod + +=item &CreateLegend() + +This function returns a formatted string containing the legend for the +chart. The legend describes the symbols used to represent grades for +problems. + +=cut + +####################################################### +####################################################### +sub CreateLegend { + my $Str = "

".
+              " digit score or number of tries to get correct ".
+              "   *  correct by student in more than 9 tries\n".
+	      "   +  correct by hand grading or override\n".
+              "   -  incorrect by override\n".
+	      "   .  incorrect attempted\n".
+	      "   u  ungraded attempted\n".
+              "   d  draft answer saved but not submitted\n".
+              "      not attempted (blank field)\n".
+	      "   x  excused".
+              "

"; + return $Str; } -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### + +=pod + +=back + +=cut + +####################################################### +####################################################### 1; + __END__

'."\n"; - $Str .= ''. + &Apache::loncommon::help_open_topic("Chart_Sections"). + ''.&mt('Groups').''. + ''.&mt('Student Data'). + &Apache::loncommon::help_open_topic("Chart_Student_Data"). + ''.&mt('Access Status').''. + &Apache::loncommon::help_open_topic("Chart_Enrollment_Status"). + ''.&mt('Sequences and Folders').''. + &Apache::loncommon::help_open_topic("Chart_Sequences"). + ''.&mt('Output Format').''. + &Apache::loncommon::help_open_topic("Chart_Output_Formats"). + ''.&mt('Output Data').''. + &Apache::loncommon::help_open_topic("Chart_Output_Data"). + '
'."\n"; - my @sections = split(':',$cache->{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); $Str .= ''; - $Str .= &CreateColumnSelectionBox($doNotShow); + $Str .= &Apache::lonstatistics::GroupSelect('Group','multiple',5); + $Str .= ''; + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ''."\n"; - $Str .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= ' 'x5; + $Str .= ''; + $Str .= '

'; + $Str .= + &mt('Status [_1]', + ''); + $Str .= '

'; return $Str; } -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +####################################################### +####################################################### + +=pod + +=item &CreateAndParseOutputSelector() + +=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 .= ''."\n"; + $Str .= "

Output Formats

\n"; + $Str .= "
\n"; + foreach my $outputmode (@OutputOptions) { + $Str .="
".$outputmode->{'name'}."
\n"; + $Str .="
".$outputmode->{'description'}."
\n"; + } + $Str .= "
\n"; + return $Str; +} - $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'); +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 = (&Apache::loncommon::get_env_multiple('form.'.$elementname))[0]; + $selected = 'html, without links' if (!$selected); + + # + # 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'}; + } - $Str .= ''; - $Str .= '
DISPLAYDATAFORMATTING';
-    $displayString .= $spacing.'
DISPLAYDATAFORMATTING'.$spacing;
-    $displayString .= '
Total Solved/Total Problems
'."\n"; + # + # Build the form element + $Str = qq/"; + return $Str; +} +## +## Data selector stuff +## +my @OutputDataOptions = + ( + { name => 'Scores Summary', + base => 'scores', + value => 'sum and total', + scores => 1, + tries => 0, + every_problem => 0, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 1, + ignore_weight => 0, + shortdesc => 'Total Score and Maximum Possible for each '. + 'Sequence or Folder', + longdesc => 'The score of each student as well as the '. + ' maximum possible on each Sequence or Folder.', + }, + { name => 'Scores Per Problem', + base => 'scores', + value => 'scores', + scores => 1, + tries => 0, + correct => 0, + every_problem => 1, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 1, + ignore_weight => 0, + shortdesc => 'Score on each Problem Part', + longdesc =>'The students score on each problem part, computed as'. + 'the part weight * part awarded', + }, + { name =>'Tries', + base =>'tries', + value => 'tries', + scores => 0, + tries => 1, + correct => 0, + every_problem => 1, + sequence_sum => 0, + sequence_max => 0, + grand_total => 0, + grand_maximum => 0, + summary_table => 0, + maximum_row => 0, + ignore_weight => 0, + shortdesc => 'Number of Tries before success on each Problem Part', + longdesc =>'The number of tries before success on each problem part.', + non_html_notes => 'negative values indicate an incorrect problem', + }, + { name =>'Parts Correct', + base =>'tries', + value => 'parts correct total', + scores => 0, + tries => 0, + correct => 1, + every_problem => 1, + sequence_sum => 1, + sequence_max => 1, + grand_total => 1, + grand_maximum => 1, + summary_table => 1, + maximum_row => 0, + ignore_weight => 1, + shortdesc => 'Number of Problem Parts completed successfully.', + longdesc => 'The Number of Problem Parts completed successfully and '. + 'the maximum possible for each student', + }, + ); + +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; } -=pod +sub CreateAndParseOutputDataSelector { + my $Str = ''; + my $elementname = 'chartoutputdata'; + # + my $selected = (&Apache::loncommon::get_env_multiple('form.'.$elementname))[0]; + $selected = 'scores' if (!$selected); + + # + $chosen_output = $OutputDataOptions[0]; + foreach my $option (@OutputDataOptions) { + if ($option->{'value'} eq $selected) { + $chosen_output = $option; + } + } + # + # Build the form element + $Str = qq/"; + return $Str; -=item &FormatStudentData() +} -First, FormatStudentInformation is called and prefixes the course information. -This function produces a formatted string of the student's course information. -Each column of data represents all the problems for a given sequence. For -valid grade data, a link is created for that problem to a submission record -for that problem. +####################################################### +####################################################### +sub count_parts { + my ($navmap,$sequence) = @_; + my @resources = &get_resources($navmap,$sequence); + my $count = 0; + foreach my $res (@resources) { + $count += scalar(@{$res->parts}); + } + return $count; +} -=over 4 +sub get_resources { + my ($navmap,$sequence) = @_; + my @resources = $navmap->retrieveResources($sequence, + sub { shift->is_problem(); }, + 0,0,0); + return @resources; +} -Input: $name, $studentInformation, $ChartDB +####################################################### +####################################################### -$name: The name and domain of the current student in name:domain format +=pod -$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. +=head2 HTML output routines -$ChartDB: The name of the cached data database which will be tied to that -database. +=item &html_initialize($r) -Output: $Str +Create labels for the columns of student data to show. -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +=item &html_outputstudent($r,$student) -=back +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 + my $total_sum_width; + + my %width; # Holds sequence width information + my @sequences; + my $navmap; # Have to keep this around since weakref is a bit zealous + +sub html_cleanup { + undef(%prog_state); + undef(%width); + # + undef($navmap); + undef(@sequences); +} - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 0; + $nodata_count = 0; + &html_cleanup(); + ($navmap,@sequences) = + &Apache::lonstatistics::selected_sequences_with_assessments(); + if (! ref($navmap)) { + # Unable to get data, so bail out + $r->print("

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

'); } - 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++; + + # If we're showing links, show a checkbox to open in new + # windows. + if ($show_links ne 'no') { + my $labeltext = &mt('Show links in new window:'); + $r->print(<new_window = true; +

+NEW_WINDOW_CHECKBOX + } + + # + $r->print("

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

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

".&mt($chosen_output->{'shortdesc'})."

"); + } + my $Str = "
\n";
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
+        my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    #
+    # Compute the column widths and output the sequence titles
+    my $total_count;
+    #
+    # Compute sequence widths
+    my $starttime = Time::HiRes::time;
+    foreach my $seq (@sequences) {
+        my $symb = $seq->symb;
+        my $title = $seq->compTitle;
+        $width{$symb}->{'width_sum'} = 0;
+        # Compute width of sum
+        if ($chosen_output->{'sequence_sum'}) {
+            if ($chosen_output->{'every_problem'}) {
+                # Use 1 digit for a space
+                $width{$symb}->{'width_sum'} += 1;            
             }
+	    $total_count += &count_parts($navmap,$seq);
+            # Use 6 digits for the sum
+            $width{$symb}->{'width_sum'} += 6;
         }
-
-        # 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';
+        # Compute width of maximum
+        if ($chosen_output->{'sequence_max'}) {
+            if ($width{$symb}->{'width_sum'}>0) {
+                # One digit for the '/'
+                $width{$symb}->{'width_sum'} +=1;
+            }
+            # Use 6 digits for the total
+            $width{$symb}->{'width_sum'}+=6;
+        }
+	#
+        if ($chosen_output->{'every_problem'}) {
+            # one problem per digit
+            $width{$symb}->{'width_parts'}= &count_parts($navmap,$seq);
+            $width{$symb}->{'width_problem'} += $width{$symb}->{'width_parts'};
         } else {
-            $Str .= '     ';
+            $width{$symb}->{'width_problem'} = 0;
+        }
+        $width{$symb}->{'width_total'} = $width{$symb}->{'width_problem'} + 
+                                     $width{$symb}->{'width_sum'};
+        if ($width{$symb}->{'width_total'} < length(&HTML::Entities::decode($title))) {
+            $width{$symb}->{'width_total'} = length(&HTML::Entities::decode($title));
         }
-        $Str .= $spacing;
+        #
+        # Output the sequence titles
+        $Str .= $title.(' 'x($width{$symb}->{'width_total'}-
+                            length($title)
+                            )).$padding;
     }
+    $total_sum_width = length($total_count)+1;
+    $Str .= "    total
\n"; + $Str .= "
";
+    $r->print($Str);
+    $r->rflush();
 
-    # 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 .= '           ';
-    }
+    $r->print(<
+// get the left offset of a given widget as an absolute position
+function getLeftOffset (element) {
+    return collect(element, "offsetLeft");
+}
+
+// get the top offset of a given widget as an absolute position
+function getTopOffset (element) {
+    return collect(element, "offsetTop");
+}
 
-    if($hasVersion eq 'false') {
-        $Str = 'No course data.';
+function collect(element, att) {
+    var val = 0;
+    while(element) {
+        val += element[att];
+        element = element.offsetParent;
     }
+    return val;
+}
 
-    return $Str;
+var currentDiv;
+var currentElement;
+function popup_score(element, score) {
+    popdown_score();
+    var left = getLeftOffset(element);
+    var top = getTopOffset(element);
+    var div = document.createElement("div");
+    div.className = "LC_chrt_popup";
+    div.appendChild(document.createTextNode(score));
+    div.style.position = "absolute";
+    div.style.top = (top - 25) + "px";
+    div.style.left = (left - 10) + "px";
+    currentDiv = div;
+    document.body.insertBefore(div, document.body.childNodes[0]);
+    element.className = "LC_chrt_popup_up";
+    currentElement = element;
 }
 
-=pod
+function popdown_score() {
+    if (currentDiv) {
+        document.body.removeChild(currentDiv);
+    }
+    if (currentElement) {
+        currentElement.className = 'LC_chrt_popup_exists';
+    }
+    currentDiv = undefined;
+}
+
+JS
 
-=item &CreateLegend()
+    #
+    # Let the user know what we are doing
+    my $studentcount = scalar(@Apache::lonstatistics::Students); 
+    if ($env{'form.SelectedStudent'}) {
+        $studentcount = '1';
+    }
+    #
+    # Initialize progress window
+    %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
+        ($r,'HTML Chart Status',
+         'HTML Chart Progress', $studentcount,
+         'inline',undef,'Statistics','stats_status');
+    #
+    &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
+                                          'Processing first student');
+    return;
+}
 
-This function returns a formatted string containing the legend for the
-chart.  The legend describes the symbols used to represent grades for
-problems.
+sub html_outputstudent {
+    my ($r,$student) = @_;
+    my $Str = '';
+    return if (! defined($navmap));
+    #
+    if($count++ % 5 == 0 && $count > 0) {
+        $r->print("
");
+    }
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$student->{$field};
+        # Deal with 'comments' - how I love special cases
+        if ($field eq 'comments') {
+            $title = ''.&mt('Comments').'';
+        }
+        my $base = length($title);
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    # Get ALL the students data
+    my %StudentsData;
+    my @tmp = &Apache::loncoursedata::get_current_state
+        ($student->{'username'},$student->{'domain'},undef,
+         $env{'request.course.id'});
+    if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:(.*)/)) {
+        %StudentsData = @tmp;
+    } else {
+	my $error = $1;
+	if (scalar(@tmp) < 1) {
+	    $Str .= ''
+                   .&mt('No Course Data')
+                   .''."\n";
+	} else {
+            $Str .= ''
+                   .&mt('Error getting student data ([_1])',$error)
+                   .''."\n";
+	}
+        $nodata_count++;
+        $r->print($Str);
+        $r->rflush();
+        return;
+    }
+    #
+    # By sequence build up the data
+    my $studentstats;
+    my $PerformanceStr = '';
+    foreach my $seq (@sequences) {
+        my $symb = $seq->symb;
+        my ($performance,$performance_length,$score,$seq_max,$rawdata);
+        if ($chosen_output->{'tries'}) {
+            ($performance,$performance_length,$score,$seq_max,$rawdata) =
+                &student_tries_on_sequence($student,\%StudentsData,
+                                           $navmap,$seq,$show_links);
+        } else {
+            ($performance,$performance_length,$score,$seq_max,$rawdata) =
+                &student_performance_on_sequence($student,\%StudentsData,
+                                                 $navmap,$seq,$show_links,
+                                                 $chosen_output->{ignore_weight});
+        }
+        my $ratio='';
+        if ($chosen_output->{'every_problem'} && 
+            $chosen_output->{'sequence_sum'}) {
+            $ratio .= ' ';
+        }
+        if ($chosen_output->{'sequence_sum'} && $score ne ' ') {
+            my $score .= sprintf("%3.2f",$score);
+            $ratio .= (' 'x(6-length($score))).$score;
+        } elsif($chosen_output->{'sequence_sum'}) {
+            $ratio .= ' 'x6;
+        }
+        if ($chosen_output->{'sequence_max'}) {
+            if ($chosen_output->{'sequence_sum'}) {
+                $ratio .= '/';
+            }
+            my $sequence_total=sprintf("%3.2f",$seq_max);
+            $ratio .= $sequence_total.(' 'x(6-length($sequence_total)));
+        }
+        #
+        if (! $chosen_output->{'every_problem'}) {
+            $performance = '';
+	    $performance_length=0;
+        }
+        $performance .= ' 'x($width{$symb}->{'width_total'} -
+                             $performance_length -
+                             $width{$symb}->{'width_sum'}).
+            $ratio;
+        #
+        $Str .= $performance.$padding;
+        #
+        $studentstats->{$symb}->{'score'}= $score;
+        $studentstats->{$symb}->{'max'}  = $seq_max;
+    }
+    #
+    # Total it up and store the statistics info.
+    my ($score,$max);
+    while (my ($symb,$seq_stats) = each (%{$studentstats})) {
+        $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
+        if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) {
+            $Statistics->{$symb}->{'max'} = $seq_stats->{'max'};
+        }
+        if ($seq_stats->{'score'} ne ' ') {
+            $score += $seq_stats->{'score'};
+            $Statistics->{$symb}->{'num_students'}++;
+        }
+        $max   += $seq_stats->{'max'};
+    }
+    if (! defined($score)) {
+        $score = ' ' x $total_sum_width;
+    } else {
+        $score = sprintf("%.2f",$score);
+        $score = (' 'x(6-length($score))).$score;
+    }
+    $Str .= ' '.' 'x($total_sum_width-length($score)).$score.' / '.$max;
+    $Str .= " \n";
+    #
+    $r->print($Str);
+    #
+    $r->rflush();
+    &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
+    return;
+}    
 
-=cut
+sub html_finish {
+    my ($r) = @_;
+    return if (! defined($navmap));
+    #
+    # Check for suppressed output and close the progress window if so
+    $r->print("
\n"); + if ($chosen_output->{'summary_table'}) { + if ($single_student_mode) { + $r->print(&SingleStudentTotal()); + } else { + $r->print(&StudentAverageTotal()); + } + } + $r->rflush(); + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + &html_cleanup(); + return; +} -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".
-              "

"; +sub StudentAverageTotal { + my $Str = '

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

'.$/; + $Str .= &Apache::loncommon::start_data_table(); + $Str .= &Apache::loncommon::start_data_table_header_row(). + '
'.&mt('Title').''.&mt('Average').''.&mt('Maximum').''.$seq->compTitle.''.$ave.' '.$max.' '.''.&mt('Sequence or Folder').''.&mt('Parts Correct').''.&mt('Score').''.&mt('Maximum').''.&HTML::Entities::encode($seq->compTitle).''.$value.''.$max.''.&mt('Total').''.$total.''.$total_max.''; - $present .= '[$index].'" />'; - $present .= ''; - $present .= '[$index].'" />'; - $present .= '