--- loncom/interface/statistics/lonstudentassessment.pm 2002/12/16 23:35:46 1.21 +++ loncom/interface/statistics/lonstudentassessment.pm 2005/04/07 07:34:52 1.122 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.21 2002/12/16 23:35:46 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.122 2005/04/07 07:34:52 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,638 +24,1976 @@ # 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 # -### +####################################################### +####################################################### + +=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 Time::HiRes; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); + +####################################################### +####################################################### +=pod + +=item Package Variables + +=over 4 + +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. + +=cut + +####################################################### +####################################################### + +my $Statistics; + +####################################################### +####################################################### + +=pod + +=item $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 -#my $jr; +=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', + '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(''."\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; +} - if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys)); - untie(%cache); - } - $r->print(''."\n"); - if($selected == 0) { - $Str .= '
'."\n"; - $Str .= ' | '; + $Str .= ''.&mt('Student Data').' | '; + $Str .= ''.&mt('Enrollment Status').' | '; + $Str .= ''.&mt('Sequences and Folders').' | '; + $Str .= ''.&mt('Output Format').''. + &Apache::loncommon::help_open_topic("Chart_Output_Formats"). + ' | '; + $Str .= ''.&mt('Output Data').''. + &Apache::loncommon::help_open_topic("Chart_Output_Data"). + ' | '; + $Str .= '|||||||||||||||||||
'."\n"; - my @sections = split(':',$cache->{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); $Str .= ' | '; - $Str .= &CreateColumnSelectionBox($doNotShow); + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ' | '."\n";
- $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .=
+ &mt('Status [_1]',
+ '');
+ $Str .= ' '; return $Str; } -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 .= '
Output Data\n"; + $Str .= "
". + &mt('Unable to retrieve course information.'). + ''); + } + # + $r->print("".$env{'course.'.$env{'request.course.id'}.'.description'}. + " ".localtime(time).""); + # + if ($chosen_output->{'base'} !~ /^final table/) { + $r->print("".$chosen_output->{'shortdesc'}.""); + } + my $Str = "\n"; + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$Apache::lonstatistics::StudentData{$field}->{'title'}; + my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'}; + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # + # Compute the column widths and output the sequence titles + my $total_count; + # + # 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 3 digits for the sum + $width{$symb}->{'width_sum'} += 3; + } + # Compute width of maximum + if ($chosen_output->{'sequence_max'}) { + if ($width{$symb}->{'width_sum'}>0) { + # One digit for the '/' + $width{$symb}->{'width_sum'} +=1; + } + # Use 3 digits for the total + $width{$symb}->{'width_sum'}+=3; + } + # + if ($chosen_output->{'every_problem'}) { + # one problem per digit + $width{$symb}->{'width_parts'}= &count_parts($navmap,$seq); + $width{$symb}->{'width_problem'} += $width{$symb}->{'width_parts'}; + } else { + $width{$symb}->{'width_problem'} = 0; + } + $width{$symb}->{'width_total'} = $width{$symb}->{'width_problem'} + + $width{$symb}->{'width_sum'}; + if ($width{$symb}->{'width_total'} < length(&HTML::Entities::decode($title))) { + $width{$symb}->{'width_total'} = length(&HTML::Entities::decode($title)); + } + # + # Output the sequence titles + $Str .= $title.(' 'x($width{$symb}->{'width_total'}- + length($title) + )).$padding; + } + $total_sum_width = length($total_count)+1; + $Str .= " total\n"; + $Str .= " "; + $r->print($Str); + $r->rflush(); + return; +} +sub html_outputstudent { + my ($r,$student) = @_; my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; + return if (! defined($navmap)); + # + if($count++ % 5 == 0 && $count > 0) { + $r->print(" "); + } + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$student->{$field}; + # Deal with 'comments' - how I love special cases + if ($field eq 'comments') { + $title = ''.&mt('Comments').''; + } + my $base = length($title); + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # Get ALL the students data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state + ($student->{'username'},$student->{'domain'},undef, + $env{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + if (scalar(@tmp) < 1) { + $nodata_count++; + $Str .= 'No Course Data'."\n"; + $r->print($Str); + $r->rflush(); + return; } - if($cache->{$name.':error'} =~ /course/) { - $Str .= 'No course data for student '; - $Str .= ''.$username.'.\n"); + if ($chosen_output->{'summary_table'}) { + if ($single_student_mode) { + $r->print(&SingleStudentTotal()); + } else { + $r->print(&StudentAverageTotal()); + } } - - return $Str; + $r->rflush(); + undef($navmap); + return; } - sub StudentAverageTotal { - my ($cache, $students, $sequenceKeys)=@_; - my $Str = "\nAverageTotal\n"; - my %Correct = (); - my $ProblemsSolved = 0; - my $TotalProblems = 0; - my $StudentCount = 0; - - foreach my $name (@$students) { - $StudentCount++; - foreach my $sequence (@$sequenceKeys) { - $Correct{$cache->{$sequence.':title'}} += - $cache->{$name.':'.$sequence.':problemsCorrect'}; - } - $ProblemsSolved += $cache->{$name.':problemsSolved'}; - $TotalProblems += $cache->{$name.':totalProblems'}; - } - $ProblemsSolved /= $StudentCount; - $TotalProblems /= $StudentCount; - $Str .= "AvgSlvd:$ProblemsSolved AvgTotal: $TotalProblems\n"; - - foreach (%Correct) { - $Str .= "$_ : $Correct{$_}\n"; + my $Str = ' '.&mt('Summary Tables').''.$/; + $Str .= '
'.&mt('Summary table for [_1] ([_2]@[_3])', + $student->{'fullname'}, + $student->{'username'},$student->{'domain'}).''; + $Str .= $/; + $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; -} +=item &excel_finish($r) -=pod +=cut -=item &CreateColumnSelectionBox() +####################################################### +####################################################### +{ + +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_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); + undef ($maximum_formula); + # + undef(%formula_data); + # + undef($navmap); + undef(@sequences); + ($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.'). + ''); + } + # + my $total_columns = scalar(&get_student_fields_to_show()); + my $num_students = scalar(@Apache::lonstatistics::Students); + # + foreach my $seq (@sequences) { + if ($chosen_output->{'every_problem'}) { + $total_columns+=&count_parts($navmap,$seq); + } + # Add 2 because we need a 'sequence_sum' and 'total' column for each + $total_columns += 2; + } + my $too_many_cols_error_message = + ''.&mt('Unable to Complete Request').''.$/. + ''.&mt('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.').' '.$/. + ''.&mt('You may consider reducing the number of Sequences or Folders you have selected.').' '.$/. + ''.&mt('LON-CAPA can produce CSV files of this data or Excel files of the Scores Summary data.').' '.$/; + if ($chosen_output->{'base'} eq 'tries' && $total_columns > 255) { + $r->print($too_many_cols_error_message); + $request_aborted = 1; + } + if ($chosen_output->{'base'} eq 'scores' && $total_columns > 255) { + $r->print($too_many_cols_error_message); + $request_aborted = 1; + } + return if ($request_aborted); + # + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + # Determine rows + my $header_row = $rows_output++; + my $description_row = $rows_output++; + my $notes_row = $rows_output++; + $rows_output++; # blank row + my $summary_header_row; + if ($chosen_output->{'summary_table'}) { + $summary_header_row = $rows_output++; + $rows_output+= scalar(@sequences); + $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,$filename,$format)= + &Apache::loncommon::create_workbook($r); + return if (! defined($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::get_selected_sections(); + $excel_sheet->write($header_row,$cols_output++, + &Apache::lonstatistics::section_and_enrollment_description('plain text'), + $format->{'h3'}); + # + # 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->{'b'}); + # + $cols_output = 0; + $excel_sheet->write($notes_row,$cols_output++, + $chosen_output->{'non_html_notes'}, + $format->{'i'}); + + ############################################## + # 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'; + my $maximum_formula_string = '=0'; + foreach my $seq (@sequences) { + my $symb = $seq->symb; + $excel_sheet->write($sequence_name_row,, + $cols_output,$seq->compTitle,$format->{'bold'}); + # Determine starting cell + $formula_data{$symb}->{'Excel:startcell'}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $formula_data{$symb}->{'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 (&get_resources($navmap,$seq)) { + if (scalar(@{$res->parts}) > 1) { + foreach my $part (@{$res->parts}) { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->compTitle.' part '.$res->part_display($part), + $format->{'bold'}); + $count++; + } + } else { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->compTitle,$format->{'bold'}); + $count++; + } + } + } + # Determine ending cell + if ($count <= 1) { + $formula_data{$symb}->{'Excel:endcell'} = $formula_data{$symb}->{'Excel:startcell'}; + $formula_data{$symb}->{'Excel:endcol'} = $formula_data{$symb}->{'Excel:startcol'}; + } else { + $formula_data{$symb}->{'Excel:endcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output-1); + $formula_data{$symb}->{'Excel:endcol'} = $cols_output-1; + } + # Create the formula for summing up this sequence + if (! exists($formula_data{$symb}->{'Excel:endcell'}) || + ! defined($formula_data{$symb}->{'Excel:endcell'})) { + $formula_data{$symb}->{'Excel:endcell'} = $formula_data{$symb}->{'Excel:startcell'}; + } + $formula_data{$symb}->{'Excel:sum'}= $excel_sheet->store_formula + ('=SUM('.$formula_data{$symb}->{'Excel:startcell'}. + ':'.$formula_data{$symb}->{'Excel:endcell'}.')'); + # 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++; -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. + } + } + 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); + + } 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'; + } + 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, + 'inline',undef,'Statistics','stats_status'); + # + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state, + 'Processing first student'); + return; +} -=over 4 -Input: $CacheData, $headings +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::lonmsg::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $excel_sheet->write($rows_output,$cols_output++,$value); + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $env{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Write out sequence scores and totals data + my %total_cell_translation; + my %maximum_cell_translation; + foreach my $seq (@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'); + } + if ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + # only indiciate if each item is correct or not + foreach my $value (@$rawdata) { + # nonzero means correct + $value = 1 if ($value > 0); + $excel_sheet->write($rows_output,$cols_output++,$value); + } + } else { + foreach my $value (@$rawdata) { + if ($score eq ' ' || !defined($value)) { + $cols_output++; + } else { + $excel_sheet->write($rows_output,$cols_output++, + $value); + } + } + } + } + if ($chosen_output->{'sequence_sum'} && + $chosen_output->{'every_problem'}) { + # Write a formula for the sum of this sequence + my %replaceCells= + ('^'.$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); + } 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; +} +sub excel_finish { + my ($r) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($excel_sheet)) { + return; + } + # + # 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 +} +####################################################### +####################################################### -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=pod -Output: $notThere +=head2 CSV output routines -$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_initialize($r) -=back +=item &csv_outputstudent($r,$student) -=cut +=item &csv_finish($r) -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; +=cut - my $notThere = ''; - $notThere .= ''; +sub csv_finish { + my ($r) = @_; + if ($request_aborted || ! defined($navmap) || ! defined($outputfile)) { + return; + } + 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 - -$CacheData: A pointer to a hash tied to the cached data +=item $student -$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 $studentdata Hash ref to all student data -Output: $present +=item $seq Hash ref, the sequence we are working on -$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 .= ' | '."\n"; - } - - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''; - $present .= '[$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 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') { + $symbol = '+'; + $sum++; + } elsif ($tries > 0) { + if ($tries > 9) { + $symbol = '*'; + } else { + $symbol = $tries; + } + $sum++; } else { - $selectedName = $students->[$index+1]; - return $selectedName; + $symbol = '+'; + $sum++; } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; + } else { + # The student has the problem incorrect or it is ungraded + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted' || + $tries > 0) { + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + # Problem is wrong and has not been attempted. + $symbol=' '; } + } + # + if (! defined($tries)) { + $tries = 0; + } + if ($status =~ /^(incorrect|ungraded)/) { + # Bug 3390: show '-' for tries on incorrect problems + # (csv & excel only) + push(@TriesData,-$tries); } else { - $selectedName = $students->[$index]; - return $selectedName; + push (@TriesData,$tries); } - last; + # + if ( ($links eq 'yes' && $symbol ne ' ') || + ($links eq 'all')) { + if (length($symbol) > 1) { + &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1'); + } + $symbol = ''.$symbol.''; + } + $value .= $symbol; } + $Str .= $value; } - - return 'No Student Selected'; + if ($seq->randompick()) { + $max = $seq->randompick(); + } + if (! $hasdata && $sum == 0) { + $sum = ' '; + } + return ($Str,$performance_length,$sum,$max,\@TriesData); } +####################################################### +####################################################### + =pod -=item &ShouldShowColumn() +=item &student_performance_on_sequence -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 student_performance_on_sequence { + my ($student,$studentdata,$navmap,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; # final result string + my ($score,$max) = (0,0); + my $performance_length = 0; + my $symbol; + my @ScoreData = (); + my $partscore; + my $hasdata = 0; # flag, 0 if there were no submissions on the sequence + 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 = &Apache::lonnet::EXT('resource.'.$part.'.weight', + $symb, + $student->{'domain'}, + $student->{'username'}, + $student->{'section'}); + if (!defined($weight) || ($weight eq '')) { + $weight=1; + } + # + $max += $weight; # see the 'excused' branch below... + $performance_length++; # one character per part + $symbol = ' '; # default to space + # + my $awarded; + if (exists($resource_data->{'resource.'.$part.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$part.'.awarded'}; + $awarded = 0 if (! $awarded); + $hasdata = 1; + } + # + $partscore = $weight*$awarded; + if (! defined($awarded)) { + $partscore = undef; + } + $score += $partscore; + $symbol = $partscore; + if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) { + $symbol = sprintf("%.0f",$symbol); + } + if (length($symbol) > 1) { + $symbol = '*'; + } + if (exists($resource_data->{'resource.'.$part.'.solved'})) { + my $status = $resource_data->{'resource.'.$part.'.solved'}; + if ($status eq 'excused') { + $symbol = 'x'; + $max -= $weight; # Do not count 'excused' problems. + } + $hasdata = 1; + } elsif (!exists($resource_data->{'resource.'.$part.'.awarded'})){ + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$part.'.tries'})){ + $symbol = '.'; + $hasdata = 1; + } else { + $symbol = ' '; + } + } + # + if (! defined($partscore)) { + $partscore = $symbol; + } + push (@ScoreData,$partscore); + # + if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) { + $symbol = ''.$symbol.''; + } + $Str .= $symbol; + } + } + if (! $hasdata && $score == 0) { + $score = ' '; + } + return ($Str,$performance_length,$score,$max,\@ScoreData); +} - my @sequenceKeys=(); - my @sequenceHeadings=(); +####################################################### +####################################################### - my %doNotShow; +=pod - my $index; - my $count = 0; - my $check = ''; - for($index=0; $index < scalar @$headings; $index++) { - $check = 'HeadingColumn'.$headings->[$index]; - if($cache->{'HeadingsFound'} =~ /$check/) { - push(@infoHeadings, $headings->[$index]); - push(@infoKeys, $cacheKey->[$index]); - } else { - $doNotShow{$count.':name'} = $headings->[$index]; - $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index]; - $count++; - } - } +=item &CreateLegend() - foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) { - $check = 'SequenceColumn'.$sequence; - if($cache->{'SequencesFound'} eq 'All Sequences' || - $cache->{'SequencesFound'} =~ /$check/) { - push(@sequenceHeadings, $cache->{$sequence.':title'}); - push(@sequenceKeys, $sequence); - } else { - $doNotShow{$count.':name'} = $cache->{$sequence.':title'}; - $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence; - $count++; - } - } +This function returns a formatted string containing the legend for the +chart. The legend describes the symbols used to represent grades for +problems. - $doNotShow{'count'} = $count; +=cut - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); +####################################################### +####################################################### +sub CreateLegend { + my $Str = "