--- loncom/interface/statistics/lonstudentassessment.pm 2002/09/22 18:33:01 1.13 +++ loncom/interface/statistics/lonstudentassessment.pm 2005/01/21 18:52:40 1.110 @@ -1,12 +1,10 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.13 2002/09/22 18:33:01 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.110 2005/01/21 18:52:40 albertel Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). -# # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or @@ -26,580 +24,1948 @@ # 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; +package Apache::lonstudentassessment; use strict; +use Apache::lonstatistics; use Apache::lonhtmlcommon; +use Apache::loncommon(); use Apache::loncoursedata; -use GDBM_File; +use Apache::lonnet; # for logging porpoises +use Apache::lonlocal; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); + +####################################################### +####################################################### +=pod + +=item Package Variables + +=over 4 + +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. + +=cut + +####################################################### +####################################################### + +my $Statistics; + +####################################################### +####################################################### + +=pod + +=item $show_links 'yes' or 'no' for linking to student performance data + +=item $output_mode 'html', 'excel', or 'csv' for output mode + +=item $show 'all', 'totals', or 'scores' determines how much data is output + +=item $single_student_mode evaluates to true if we are showing only one +student. + +=cut + +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $chosen_output; +my $single_student_mode; + +####################################################### +####################################################### +# End of package variable declarations + +=pod + +=back + +=cut + +####################################################### +####################################################### + +=pod + +=item &BuildStudentAssessmentPage() + +Inputs: + +=over 4 + +=item $r Apache Request + +=item $c Apache Connection + +=back -#my $jr; +=cut +####################################################### +####################################################### sub BuildStudentAssessmentPage { - my ($cacheDB,$students,$courseID,$formName,$headings,$spacing, - $studentInformation,$r,$c)=@_; -# $jr = $r; - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print('
Unable to tie database.'); + my ($r,$c)=@_; + # + undef($Statistics); + undef($show_links); + undef($output_mode); + undef($chosen_output); + undef($single_student_mode); + # + my %Saveable_Parameters = ('Status' => 'scalar', + 'chartoutputmode' => 'scalar', + 'chartoutputdata' => 'scalar', + 'Section' => 'array', + 'StudentData' => 'array', + 'Maps' => 'array'); + &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters); + &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters); + # + &Apache::lonstatistics::PrepareClasslist(); + # + $single_student_mode = 0; + $single_student_mode = 1 if ($ENV{'form.SelectedStudent'}); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['selectstudent']); + if ($ENV{'form.selectstudent'}) { + &Apache::lonstatistics::DisplayClasslist($r); return; } - - # Remove students who don't have the proper section. - my @sectionsSelected = split(':',$cache{'sectionsSelected'}); - for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0; - $studentIndex--) { - my $value = $cache{$students->[$studentIndex].':section'}; - my $found = 0; - foreach (@sectionsSelected) { - if($_ eq 'none') { - if($value eq '' || !defined($value) || $value eq ' ') { - $found = 1; - last; - } - } else { - if($value eq $_) { - $found = 1; - last; - } - } - } - if($found == 0) { - splice(@$students, $studentIndex, 1); + # + # Print out the HTML headers for the interface + # This also parses the output mode selector + # This step must *always* be done. + $r->print(&CreateInterface()); + $r->print(''); + $r->print(''); + $r->rflush(); + # + if (! exists($ENV{'form.notfirstrun'}) && ! $single_student_mode) { + return; + } + # + my $initialize = \&html_initialize; + my $output_student = \&html_outputstudent; + my $finish = \&html_finish; + # + 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 .= ''."\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 .= '
'."\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); + my $only_seq_with_assessments = sub { + my $s=shift; + if ($s->{'num_assess'} < 1) { + return 0; + } else { + return 1; + } + }; + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ' | '."\n";
- $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .= '';
+ $Str .= ' 'x5;
+ $Str .=
+ &mt('Status[_1]',
+ '');
+ $Str .= ' '; return $Str; } -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +####################################################### +####################################################### - my $Str = ''; - $Str .= '
Output Formats\n"; + $Str .= "
Output Data\n"; + $Str .= "
".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}. + " ".localtime(time).""); - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; + if ($chosen_output->{'base'} !~ /^final table/) { + $r->print("".$chosen_output->{'shortdesc'}.""); } - if($cache->{$name.':error'} =~ /course/) { - $Str .= 'No course data for student '; - $Str .= ''.$username.'.'; - return $Str; - } - - my $hasVersion = 'false'; - my $hasFinalData = 'false'; - foreach my $sequence (@$showSequences) { - my $hasData = 'false'; - my $characterCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - # All grades (except for versionless parts) are displayed as links - # to their submission record. Loop through all the parts for the - # current problem in the correct order and prepare the output links - foreach(split(/\:/,$cache->{$sequence.':'.$problemID. - ':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $Str .= ' '; - $characterCount++; - next; - } - $hasVersion = 'true'; - $hasData = 'true'; - $Str .= ''; - my $code = $cache->{$name.':'.$problemID.':'.$_.':code'}; - my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'}; - if($code eq '*' && $tries < 10 && $tries ne '') { - $code = $tries; - } - $Str .= $code; - $Str .= ''; - $characterCount++; + my $Str = " \n"; + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$Apache::lonstatistics::StudentData{$field}->{'title'}; + my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'}; + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # + # Compute the column widths and output the sequence titles + my $total_count; + foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){ + # + # Comptue column widths + $sequence->{'width_sum'} = 0; + if ($chosen_output->{'sequence_sum'}) { + if ($chosen_output->{'every_problem'}) { + # Use 1 digit for a space + $sequence->{'width_sum'} += 1; + } + $total_count += $sequence->{'num_assess_parts'}; + # Use 3 digits for the sum + $sequence->{'width_sum'} += 3; + } + if ($chosen_output->{'sequence_max'}) { + if ($sequence->{'width_sum'}>0) { + # One digit for the '/' + $sequence->{'width_sum'} +=1; } + # Use 3 digits for the total + $sequence->{'width_sum'}+=3; + } + # + if ($chosen_output->{'every_problem'}) { + # one problem per digit + $sequence->{'width_problem'} = $sequence->{'num_assess_parts'}; + } else { + $sequence->{'width_problem'} = 0; } + $sequence->{'width_total'} = $sequence->{'width_problem'} + + $sequence->{'width_sum'}; + if ($sequence->{'width_total'} < length(&HTML::Entities::decode($sequence->{'title'}))) { + $sequence->{'width_total'} = length(&HTML::Entities::decode($sequence->{'title'})); + } + # + # Output the sequence titles + $Str .= + $sequence->{'title'}.' 'x($sequence->{'width_total'}- + length($sequence->{'title'}) + ).$padding; + } + $total_sum_width = length($total_count)+1; + $Str .= " total\n"; + $Str .= " "; + $r->print($Str); + $r->rflush(); + return; +} - # Output the number of correct answers for the current sequence. - # This part takes up 6 character slots, but is formated right - # justified. - my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount; - $spacesNeeded -= 3; - $Str .= (' 'x$spacesNeeded); - - my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence. - ':problemsCorrect'}); - if($hasData eq 'true') { - $Str .= ''.$outputProblemsCorrect.''; - $hasFinalData = 'true'; - } else { - $Str .= ' '; - } - $Str .= $spacing; - } - - # Output the total correct problems over the total number of problems. - # I don't like this type of formatting, but it is a solution. Need - # a way to dynamically determine the space requirements. - my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'}); - my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'}); - if($hasFinalData eq 'true') { - $Str .= ''.$outputProblemsSolved. - ' / '.$outputTotalProblems.''; +sub html_outputstudent { + my ($r,$student) = @_; + my $Str = ''; + # + 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; + } + # + # By sequence build up the data + my $studentstats; + my $PerformanceStr = ''; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'}) { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &StudentTriesOnSequence($student,\%StudentsData, + $seq,$show_links); + } else { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,$show_links); + } + my $ratio=''; + if ($chosen_output->{'every_problem'}) { + $ratio .= ' '; + } + if ($chosen_output->{'sequence_sum'} && $score ne ' ') { + $ratio .= sprintf("%3.0f",$score); + } elsif($chosen_output->{'sequence_sum'}) { + $ratio .= ' 'x3; + } + if ($chosen_output->{'sequence_max'}) { + if ($chosen_output->{'sequence_sum'}) { + $ratio .= '/'; + } + $ratio .= sprintf("%3.0f",$seq_max); + } + # + if (! $chosen_output->{'every_problem'}) { + $performance = ''; + $performance_length=0; + } + $performance .= ' 'x($seq->{'width_total'}-$performance_length-$seq->{'width_sum'}). + $ratio; + # + $Str .= $performance.$padding; + # + $studentstats->{$seq->{'symb'}}->{'score'}= $score; + $studentstats->{$seq->{'symb'}}->{'max'} = $seq_max; + } + # + # Total it up and store the statistics info. + my ($score,$max); + while (my ($symb,$seq_stats) = each (%{$studentstats})) { + $Statistics->{$symb}->{'score'} += $seq_stats->{'score'}; + if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) { + $Statistics->{$symb}->{'max'} = $seq_stats->{'max'}; + } + if ($seq_stats->{'score'} ne ' ') { + $score += $seq_stats->{'score'}; + $Statistics->{$symb}->{'num_students'}++; + } + $max += $seq_stats->{'max'}; + } + if (! defined($score)) { + $score = ' ' x $total_sum_width; } else { - $Str .= ' '; + $score = sprintf("%.0f",$score); } + $Str .= ' '.' 'x($total_sum_width-length($score)).$score.' / '.$max; + $Str .= " \n"; + # + $r->print($Str); + # + $r->rflush(); + return; +} - if($hasVersion eq 'false') { - $Str = 'No course data.'; +sub html_finish { + my ($r) = @_; + # + # Check for suppressed output and close the progress window if so + $r->print("\n"); + if ($chosen_output->{'summary_table'}) { + if ($single_student_mode) { + $r->print(&SingleStudentTotal()); + } else { + $r->print(&StudentAverageTotal()); + } } + $r->rflush(); + return; +} +sub StudentAverageTotal { + my $Str = ' '.&mt('Summary Tables').''.$/; + $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 SingleStudentTotal { + my $student = &Apache::lonstatistics::current_student(); + my $Str = ' '.&mt('Summary table for [_1] ([_2]@[_3])', + $student->{'fullname'}, + $student->{'username'},$student->{'domain'}).''; + $Str .= $/; + $Str .= '
'.&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); + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + # Determine rows + my $header_row = $rows_output++; + my $description_row = $rows_output++; + 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(&Apache::lonstatistics::Sequences_with_Assess()); + $rows_output++; + } + my $sequence_name_row = $rows_output++; + my $resource_name_row = $rows_output++; + my $maximum_data_row = $rows_output++; + if (! $chosen_output->{'maximum_row'}) { + $rows_output--; + } + my $first_data_row = $rows_output++; + # + # Create sheet + $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename); + # + # Check for errors + if (! defined($excel_workbook)) { + $r->log_error("Error creating excel spreadsheet $filename: $!"); + $r->print("Problems creating new Excel file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator"); + return ; + } + # + # The excel spreadsheet stores temporary data in files, then put them + # together. If needed we should be able to disable this (memory only). + # The temporary directory must be specified before calling 'addworksheet'. + # File::Temp is used to determine the temporary directory. + $excel_workbook->set_tempdir($Apache::lonnet::tmpdir); + # + my $format = &Apache::loncommon::define_excel_formats($excel_workbook); + # + # Add a worksheet + my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $sheetname = &Apache::loncommon::clean_excel_name($sheetname); + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Put the course description in the header + $excel_sheet->write($header_row,$cols_output++, + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}, + $format->{'h1'}); + $cols_output += 3; + # + # Put a description of the sections listed + my $sectionstring = ''; + my @Sections = @Apache::lonstatistics::SelectedSections; + if (scalar(@Sections) > 1) { + if (scalar(@Sections) > 2) { + my $last = pop(@Sections); + $sectionstring = "Sections ".join(', ',@Sections).', and '.$last; + } else { + $sectionstring = "Sections ".join(' and ',@Sections); + } + } else { + if ($Sections[0] eq 'all') { + $sectionstring = "All sections"; + } else { + $sectionstring = "Section ".$Sections[0]; + } + } + $excel_sheet->write($header_row,$cols_output++,$sectionstring, + $format->{'h3'}); + $cols_output += scalar(@Sections); + # + # Put the date in there too + $excel_sheet->write($header_row,$cols_output++, + 'Compiled on '.localtime(time),$format->{'h3'}); + # + $cols_output = 0; + $excel_sheet->write($description_row,$cols_output++, + $chosen_output->{'shortdesc'}, + $format->{'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 (&Apache::lonstatistics::Sequences_with_Assess()) { + $excel_sheet->write($sequence_name_row,, + $cols_output,$seq->{'title'},$format->{'bold'}); + # Determine starting cell + $seq->{'Excel:startcell'}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $seq->{'Excel:startcol'}=$cols_output; + my $count = 0; + if ($chosen_output->{'every_problem'}) { + # Put the names of the problems and parts into the sheet + foreach my $res (@{$seq->{'contents'}}) { + if ($res->{'type'} ne 'assessment' || + ! exists($res->{'parts'}) || + ref($res->{'parts'}) ne 'ARRAY' || + scalar(@{$res->{'parts'}}) < 1) { + next; + } + if (scalar(@{$res->{'parts'}}) > 1) { + foreach my $part (@{$res->{'parts'}}) { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->{'title'}.' part '.$part, + $format->{'bold'}); + $count++; + } + } else { + $excel_sheet->write($resource_name_row, + $cols_output++, + $res->{'title'},$format->{'bold'}); + $count++; + } + } + } + # Determine ending cell + if ($count <= 1) { + $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'}; + $seq->{'Excel:endcol'} = $seq->{'Excel:startcol'}; + } else { + $seq->{'Excel:endcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output-1); + $seq->{'Excel:endcol'} = $cols_output-1; + } + # Create the formula for summing up this sequence + if (! exists($seq->{'Excel:endcell'}) || + ! defined($seq->{'Excel:endcell'})) { + $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'}; + } + $seq->{'Excel:sum'}= $excel_sheet->store_formula + ('=SUM('.$seq->{'Excel:startcell'}. + ':'.$seq->{'Excel:endcell'}.')'); + # Determine cell the score is held in + $seq->{'Excel:scorecell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $seq->{'Excel:scorecol'}=$cols_output; + if ($chosen_output->{'base'} eq 'parts correct total') { + $excel_sheet->write($resource_name_row,$cols_output++, + 'parts correct', + $format->{'bold'}); + } elsif ($chosen_output->{'sequence_sum'}) { + if ($chosen_output->{'correct'}) { + # Only reporting the number correct, so do not call it score + $excel_sheet->write($resource_name_row,$cols_output++, + 'sum', + $format->{'bold'}); + } else { + $excel_sheet->write($resource_name_row,$cols_output++, + 'score', + $format->{'bold'}); + } + } + # + $total_formula_string.='+'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output-1); + if ($chosen_output->{'sequence_max'}) { + $excel_sheet->write($resource_name_row,$cols_output, + 'maximum', + $format->{'bold'}); + $seq->{'Excel:maxcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $seq->{'Excel:maxcol'}=$cols_output; + $maximum_formula_string.='+'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($first_data_row,$cols_output); + $cols_output++; - my $notThere = ''; - $notThere .= ''; +sub excel_finish { + my ($r) = @_; + return if ($request_aborted); + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print(''. + 'Your Excel spreadsheet.'."\n"); + $r->rflush(); + return; +} - return $notThere; } +####################################################### +####################################################### =pod -=item &CreateColumnSelectors() +=head2 CSV output routines -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. +=item &csv_initialize($r) -=over 4 +=item &csv_outputstudent($r,$student) -Input: $CacheData, $headings +=item &csv_finish($r) + +=cut + +####################################################### +####################################################### +{ + +my $outputfile; +my $filename; +my $request_aborted; +my %prog_state; # progress window state + +sub csv_initialize{ + my ($r) = @_; + # + # Clean up + undef($outputfile); + undef($filename); + undef($request_aborted); + undef(%prog_state); + # + # Deal with unimplemented requests + $request_aborted = undef; + if ($chosen_output->{'base'} =~ /final table/) { + $r->print(< +The Summary Table (Scores) option is not available for non-HTML output. + +END + $request_aborted = 1; + } + return if ($request_aborted); + # + # Initialize progress window + my $studentcount = scalar(@Apache::lonstatistics::Students); + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'CSV File Compilation Status', + 'CSV File Compilation Progress', $studentcount, + 'inline',undef,'Statistics','stats_status'); + # + # Open a file + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.csv'; + unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) { + $r->log_error("Couldn't open $filename for output $!"); + $r->print("Problems occured in writing the csv file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator."); + $outputfile = undef; + } + # + # Datestamp + my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'. + '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'. + "\n"; + foreach my $item ('shortdesc','non_html_notes') { + next if (! exists($chosen_output->{$item})); + print $outputfile + '"'.&Apache::loncommon::csv_translate($chosen_output->{$item}).'"'. + "\n"; + } + # + # Print out the headings + my $sequence_row = ''; + my $resource_row = undef; + foreach my $field (&get_student_fields_to_show()) { + $sequence_row .='"",'; + $resource_row .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $sequence_row .= '"'. + &Apache::loncommon::csv_translate($seq->{'title'}).'",'; + my $count = 0; + if ($chosen_output->{'every_problem'}) { + foreach my $res (@{$seq->{'contents'}}) { + if ($res->{'type'} ne 'assessment' || + ! exists($res->{'parts'}) || + ref($res->{'parts'}) ne 'ARRAY' || + scalar(@{$res->{'parts'}}) < 1) { + next; + } + foreach my $part (@{$res->{'parts'}}) { + $resource_row .= '"'. + &Apache::loncommon::csv_translate($res->{'title'}. + ', Part '.$part + ).'",'; + $count++; + } + } + } + $sequence_row.='"",'x$count; + if ($chosen_output->{'sequence_sum'}) { + if($chosen_output->{'correct'}) { + $resource_row .= '"sum",'; + } else { + $resource_row .= '"score",'; + } + } + if ($chosen_output->{'sequence_max'}) { + $sequence_row.= '"",'; + $resource_row .= '"maximum possible",'; + } + } + if ($chosen_output->{'grand_total'}) { + $sequence_row.= '"",'; + $resource_row.= '"Total",'; + } + if ($chosen_output->{'grand_maximum'}) { + $sequence_row.= '"",'; + $resource_row.= '"Maximum",'; + } + chomp($sequence_row); + chomp($resource_row); + print $outputfile $sequence_row."\n"; + print $outputfile $resource_row."\n"; + return; +} -$CacheData: A pointer to a hash tied to the cached data +sub csv_outputstudent { + my ($r,$student) = @_; + return if ($request_aborted); + return if (! defined($outputfile)); + my $Str = ''; + # + # Output student fields + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsg::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $Str .= '"'.&Apache::loncommon::csv_translate($value).'",'; + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Output performance data + my $total = 0; + my $maximum = 0; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($chosen_output->{'tries'}){ + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &StudentTriesOnSequence($student,\%StudentsData, + $seq,'no'); + } else { + ($performance,$performance_length,$score,$seq_max,$rawdata) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + } + if ($chosen_output->{'every_problem'}) { + if ($chosen_output->{'correct'}) { + $score = 0; + # Deal with number of parts correct data + $Str .= '"'.join('","',( map { if ($_>0) { + $score += 1; + 1; + } else { + 0; + } + } @$rawdata)).'",'; + } else { + $Str .= '"'.join('","',(@$rawdata)).'",'; + } + } + if ($chosen_output->{'sequence_sum'}) { + $Str .= '"'.$score.'",'; + } + if ($chosen_output->{'sequence_max'}) { + $Str .= '"'.$seq_max.'",'; + } + $total+=$score; + $maximum += $seq_max; + } + if ($chosen_output->{'grand_total'}) { + $Str .= '"'.$total.'",'; + } + if ($chosen_output->{'grand_maximum'}) { + $Str .= '"'.$maximum.'",'; + } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns +sub csv_finish { + my ($r) = @_; + return if ($request_aborted); + return if (! defined($outputfile)); + close($outputfile); + # + my $c = $r->connection(); + return if ($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their csv file + $r->print(''. + ''.&mt('Your csv file.').''."\n"); + $r->rflush(); + return; + +} -Output: $present +} -$present: The string contains the first row of a table. Each column contains -a checkbox which is left justified. Currently left justification is used -for consistency of location over the column in which it presides. +####################################################### +####################################################### -=back +=pod -=cut +=item &StudentTriesOnSequence() -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; +Inputs: - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= ' ';
- $present .= '[$index].'" />';
- $present .= ' | '."\n";
- }
+=over 4
- for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) {
- $present .= '';
- $present .= '[$index].'" />';
- $present .= ' | '."\n";
- }
+=item $student
- return $present;
-}
+=item $studentdata Hash ref to all student data
-#---- END Student Assessment Web Page ----------------------------------------
+=item $seq Hash ref, the sequence we are working on
-#---- Student Assessment Worker Functions ------------------------------------
+=item $links if defined we will output links to each resource.
-sub FindSelectedStudent {
- my($cache, $selectedName, $students)=@_;
+=back
- if($selectedName eq 'All Students' ||
- $selectedName eq 'No Student Selected') {
- return $selectedName;
- }
+=cut
- for(my $index=0; $index<(scalar @$students); $index++) {
- my $fullname = $cache->{$students->[$index].':fullname'};
- if($fullname eq $selectedName) {
- if($cache->{'StudentAssessmentMove'} eq 'next') {
- if($index == ((scalar @$students) - 1)) {
- $selectedName = $students->[0];
- return $selectedName;
+#######################################################
+#######################################################
+sub StudentTriesOnSequence {
+ my ($student,$studentdata,$seq,$links) = @_;
+ $links = 'no' if (! defined($links));
+ my $Str = '';
+ my ($sum,$max) = (0,0);
+ my $performance_length = 0;
+ my @TriesData = ();
+ my $tries;
+ my $hasdata = 0; # flag - true if the student has any data on the sequence
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ my $resource_data = $studentdata->{$resource->{'symb'}};
+ my $value = '';
+ foreach my $partnum (@{$resource->{'parts'}}) {
+ $tries = undef;
+ $max++;
+ $performance_length++;
+ my $symbol = ' '; # default to space
+ #
+ my $awarded = 0;
+ if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) {
+ $awarded = $resource_data->{'resource.'.$partnum.'.awarded'};
+ $awarded = 0 if (! $awarded);
+ }
+ #
+ my $status = '';
+ if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
+ $status = $resource_data->{'resource.'.$partnum.'.solved'};
+ }
+ #
+ my $tries = 0;
+ if(exists($resource_data->{'resource.'.$partnum.'.tries'})) {
+ $tries = $resource_data->{'resource.'.$partnum.'.tries'};
+ $hasdata =1;
+ }
+ #
+ if ($awarded > 0) {
+ # The student has gotten the problem correct to some degree
+ if ($status eq 'excused') {
+ $symbol = 'x';
+ $max--;
+ } elsif ($status eq 'correct_by_override') {
+ $symbol = '+';
+ $sum++;
+ } elsif ($tries > 0) {
+ if ($tries > 9) {
+ $symbol = '*';
+ } else {
+ $symbol = $tries;
+ }
+ $sum++;
} else {
- $selectedName = $students->[$index+1];
- return $selectedName;
+ $symbol = '+';
+ $sum++;
}
- } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {
- if($index == 0) {
- $selectedName = $students->[-1];
- return $selectedName;
+ } else {
+ # The student has the problem incorrect or it is ungraded
+ if ($status eq 'excused') {
+ $symbol = 'x';
+ $max--;
+ } elsif ($status eq 'incorrect_by_override') {
+ $symbol = '-';
+ } elsif ($status eq 'ungraded_attempted') {
+ $symbol = '#';
+ } elsif ($status eq 'incorrect_attempted' ||
+ $tries > 0) {
+ $symbol = '.';
} else {
- $selectedName = $students->[$index-1];
- return $selectedName;
+ # Problem is wrong and has not been attempted.
+ $symbol=' ';
}
+ }
+ #
+ if (! defined($tries)) {
+ $tries = 0;
+ }
+ if ($status =~ /^(incorrect|ungraded)/) {
+ # Bug 3390: show '-' for tries on incorrect problems
+ # (csv & excel only)
+ push(@TriesData,-$tries);
} else {
- $selectedName = $students->[$index];
- return $selectedName;
+ push (@TriesData,$tries);
}
- last;
+ #
+ if ( ($links eq 'yes' && $symbol ne ' ') ||
+ ($links eq 'all')) {
+ if (length($symbol) > 1) {
+ &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
+ }
+ $symbol = ''.$symbol.'';
+ }
+ $value .= $symbol;
}
+ $Str .= $value;
}
-
- return 'No Student Selected';
+ if ($seq->{'randompick'}) {
+ $max = $seq->{'randompick'};
+ }
+ if (! $hasdata && $sum == 0) {
+ $sum = ' ';
+ }
+ return ($Str,$performance_length,$sum,$max,\@TriesData);
}
+#######################################################
+#######################################################
+
=pod
-=item &ShouldShowColumn()
+=item &StudentPerformanceOnSequence()
-Determine if a specified column should be shown on the chart.
+Inputs:
=over 4
-Input: $cache, $test
+=item $student
-$cache: A pointer to the hash tied to the cached data
+=item $studentdata Hash ref to all student data
-$test: The form name of the column (heading.$headingIndex) or
-(sequence.$sequenceIndex)
+=item $seq Hash ref, the sequence we are working on
-Output: 0 (false), 1 (true)
+=item $links if defined we will output links to each resource.
=back
=cut
-sub ShouldShowColumns {
- my ($cache,$headings,$cacheKey)=@_;
-
- my @infoKeys=();
- my @infoHeadings=();
+#######################################################
+#######################################################
+sub StudentPerformanceOnSequence {
+ my ($student,$studentdata,$seq,$links) = @_;
+ $links = 'no' if (! defined($links));
+ my $Str = ''; # final result string
+ my ($score,$max) = (0,0);
+ my $performance_length = 0;
+ my $symbol;
+ my @ScoreData = ();
+ my $partscore;
+ my $hasdata = 0; # flag, 0 if there were no submissions on the sequence
+ foreach my $resource (@{$seq->{'contents'}}) {
+ next if ($resource->{'type'} ne 'assessment');
+ my $resource_data = $studentdata->{$resource->{'symb'}};
+ foreach my $part (@{$resource->{'parts'}}) {
+ $partscore = undef;
+ my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
+ $resource->{'symb'},
+ $student->{'domain'},
+ $student->{'username'},
+ $student->{'section'});
+ if (!defined($weight) || ($weight eq '')) {
+ $weight=1;
+ }
+ #
+ $max += $weight; # see the 'excused' branch below...
+ $performance_length++; # one character per part
+ $symbol = ' '; # default to space
+ #
+ my $awarded;
+ 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;
+ } else {
+ # Unsolved. Did they try?
+ if (exists($resource_data->{'resource.'.$part.'.tries'})){
+ $symbol = '.';
+ $hasdata = 1;
+ } else {
+ $symbol = ' ';
+ }
+ }
+ #
+ if (! defined($partscore)) {
+ $partscore = $symbol;
+ }
+ push (@ScoreData,$partscore);
+ #
+ if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
+ $symbol = ''.$symbol.'';
+ }
+ $Str .= $symbol;
+ }
+ }
+ if (! $hasdata && $score == 0) {
+ $score = ' ';
+ }
+ return ($Str,$performance_length,$score,$max,\@ScoreData);
+}
- my @sequenceKeys=();
- my @sequenceHeadings=();
+#######################################################
+#######################################################
- my %doNotShow;
+=pod
- my $index;
- my $count = 0;
- my $check = '';
- for($index=0; $index < scalar @$headings; $index++) {
- $check = 'HeadingColumn'.$headings->[$index];
- if($cache->{'HeadingsFound'} =~ /$check/) {
- push(@infoHeadings, $headings->[$index]);
- push(@infoKeys, $cacheKey->[$index]);
- } else {
- $doNotShow{$count.':name'} = $headings->[$index];
- $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index];
- $count++;
- }
- }
+=item &CreateLegend()
- foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) {
- $check = 'SequenceColumn'.$sequence;
- if($cache->{'SequencesFound'} eq 'All Sequences' ||
- $cache->{'SequencesFound'} =~ /$check/) {
- push(@sequenceHeadings, $cache->{$sequence.':title'});
- push(@sequenceKeys, $sequence);
- } else {
- $doNotShow{$count.':name'} = $cache->{$sequence.':title'};
- $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence;
- $count++;
- }
- }
+This function returns a formatted string containing the legend for the
+chart. The legend describes the symbols used to represent grades for
+problems.
- $doNotShow{'count'} = $count;
+=cut
- return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,
- \@sequenceKeys, \%doNotShow);
+#######################################################
+#######################################################
+sub CreateLegend {
+ my $Str = "". + " 1 correct by student in 1 try\n". + " 7 correct by student in 7 tries\n". + " * correct by student in more than 9 tries\n". + " + correct by hand grading or override\n". + " - incorrect by override\n". + " . incorrect attempted\n". + " # ungraded attempted\n". + " not attempted (blank field)\n". + " x excused". + " "; + return $Str; } -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### + +=pod + +=back + +=cut + +####################################################### +####################################################### 1; + __END__ |