--- loncom/interface/statistics/lonstudentassessment.pm 2002/12/11 18:41:00 1.20 +++ loncom/interface/statistics/lonstudentassessment.pm 2004/04/06 21:42:26 1.81.2.3 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.20 2002/12/11 18:41:00 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.81.2.3 2004/04/06 21:42:26 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,695 +24,1707 @@ # http://www.lon-capa.org/ # # (Navigate problems for statistical reports -# YEAR=2001 -# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei -# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei -# YEAR=2002 -# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei -# 5/12,5/14,5/15,5/19,5/26,7/16 Behrouz Minaei # -### +####################################################### +####################################################### -package Apache::lonstudentassessment; +=pod + +=head1 NAME + +lonstudentassessment + +=head1 SYNOPSIS + +Presents assessment data about a student or a group of students. + +=head1 Subroutines + +=over 4 + +=cut + +####################################################### +####################################################### + +package Apache::lonstudentassessment; use strict; +use Apache::lonstatistics; use Apache::lonhtmlcommon; +use Apache::loncommon(); use Apache::loncoursedata; -use GDBM_File; +use Apache::lonnet; # for logging porpoises +use Apache::lonlocal; +use Spreadsheet::WriteExcel; +use Spreadsheet::WriteExcel::Utility(); + +####################################################### +####################################################### +=pod + +=item Package Variables + +=over 4 + +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. + +=cut + +####################################################### +####################################################### + +my $Statistics; + +####################################################### +####################################################### + +=pod + +=item $show_links 'yes' or 'no' for linking to student performance data + +=item $output_mode 'html', 'excel', or 'csv' for output mode + +=item $show 'all', 'totals', or 'scores' determines how much data is output + +=item $data determines what performance data is shown + +=item $datadescription A short description of the output data selected. + +=item $base 'tries' or 'scores' determines the base of the performance shown + +=item $single_student_mode evaluates to true if we are showing only one +student. + +=cut + +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $data; +my $base; +my $datadescription; +my $single_student_mode; + +####################################################### +####################################################### +# End of package variable declarations + +=pod + +=back + +=cut + +####################################################### +####################################################### + +=pod -#my $jr; +=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('<html><body>Unable to tie database.</body></html>'); + my ($r,$c)=@_; + # + undef($Statistics); + undef($show_links); + undef($output_mode); + undef($data); + undef($base); + undef($datadescription); + 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('<input type="hidden" name="notfirstrun" value="true" />'); + $r->print('<input type="hidden" name="sort" value="'. + $ENV{'form.sort'}.'" />'); + $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 .= '<h3><font color=blue>WARNING: '; - $Str .= 'Please select a student</font></h3>'; - $r->print($Str); - return; + $Str .= '<input type="hidden" name="SelectedStudent" value="'. + $ENV{'form.SelectedStudent'}.'" />'; + # + # Build the previous student link + my $previous = &Apache::lonstatistics::previous_student(); + my $previousbutton = ''; + if (defined($previous)) { + my $sname = $previous->{'username'}.':'.$previous->{'domain'}; + $previousbutton .= '<input type="button" value="'. + 'Previous Student ('. + $previous->{'username'}.'@'.$previous->{'domain'}.')'. + '" onclick="document.Statistics.SelectedStudent.value='. + "'".$sname."'".';'. + 'document.Statistics.submit();" />'; + } else { + $previousbutton .= '<input type="button" value="'. + 'Previous student (none)'.'" />'; } + # + # Build the next student link + my $next = &Apache::lonstatistics::next_student(); + my $nextbutton = ''; + if (defined($next)) { + my $sname = $next->{'username'}.':'.$next->{'domain'}; + $nextbutton .= '<input type="button" value="'. + 'Next Student ('. + $next->{'username'}.'@'.$next->{'domain'}.')'. + '" onclick="document.Statistics.SelectedStudent.value='. + "'".$sname."'".';'. + 'document.Statistics.submit();" />'; + } else { + $nextbutton .= '<input type="button" value="'. + 'Next student (none)'.'" />'; + } + # + # Build the 'all students' button + my $all = ''; + $all .= '<input type="button" value="All Students" '. + '" onclick="document.Statistics.SelectedStudent.value='. + "''".';'.'document.Statistics.submit();" />'; + $Str .= $previousbutton.(' 'x5).$all.(' 'x5).$nextbutton; + return $Str; +} - $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings, - $sequenceKeys, $sequenceHeadings)); - untie(%cache); - if($c->aborted()) { return $Str; } - - my $selected=0; - $r->print('<pre>'."\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 .= '<a href="/adm/statistics?reportSelected='; - $displayString .= &Apache::lonnet::escape('Student Assessment'); - $displayString .= '&download='.$_.'">'; - $displayString .= 'DISPLAYDATA</a>'.$spacing; - $r->print(&Apache::lonhtmlcommon::FormatStudentInformation( - \%cache, $_, - \@updateColumn, - $displayString, - 'preformatted')); - } - - $displayString = 'DISPLAYDATA'.$spacing; - $r->print(&Apache::lonhtmlcommon::FormatStudentInformation( - \%cache, $_, - \@after, - $displayString, - 'preformatted')); - $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys)); - $r->print("\n"); - $r->rflush(); - untie(%cache); +####################################################### +####################################################### + +sub get_student_fields_to_show { + my @to_show = @Apache::lonstatistics::SelectedStudentData; + foreach (@to_show) { + if ($_ eq 'all') { + @to_show = @Apache::lonstatistics::StudentDataOrder; + last; } } + return @to_show; +} +####################################################### +####################################################### -# $r->print("AverageTtal"); -# $r->print(&StudentAverageTotal(\%cache, $spacing, $sequenceKeys)); -# $r->print("\n"); -# $r->rflush(); - untie(%cache); - - - $r->print('</pre>'."\n"); - if($selected == 0) { - $Str .= '<h3><font color=blue>WARNING: '; - $Str .= 'Please select a student</font></h3>'; - $r->print($Str); - } +=pod - return; -} +=item &CreateInterface() -#---- Student Assessment Web Page -------------------------------------------- +Called by &BuildStudentAssessmentPage to create the top part of the +page which displays the chart. -sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; +Inputs: None - my $Str = ''; - $Str .= &CreateLegend(); - $Str .= '<table><tr><td>'."\n"; - $Str .= '<input type="submit" name="PreviousStudent" '; - $Str .= 'value="Previous Student" />'."\n"; - $Str .= '   '."\n"; - $Str .= &Apache::lonhtmlcommon::StudentOptions($cache, $students, - $selectedName, - 'StudentAssessment', - $formName); - $Str .= "\n".'   '."\n"; - $Str .= '<input type="submit" name="NextStudent" '; - $Str .= 'value="Next Student" />'."\n"; - $Str .= '</td></tr></table>'."\n"; - $Str .= '<table cellspacing="5"><tr>'."\n"; - $Str .= '<td align="center"><b>Select Sections</b>'."\n"; - $Str .= '</td>'."\n"; - $Str .= '<td align="center"><b>Select column to view:</b></td>'."\n"; - $Str .= '<td></td></tr>'."\n"; +Returns: A string containing the HTML for the headers and top table for +the chart page. +=cut + +####################################################### +####################################################### +sub CreateInterface { + my $Str = ''; +# $Str .= &CreateLegend(); + $Str .= '<table cellspacing="5">'."\n"; + $Str .= '<tr>'; + $Str .= '<td align="center"><b>'.&mt('Sections').'</b></td>'; + $Str .= '<td align="center"><b>'.&mt('Student Data</b>').'</td>'; + $Str .= '<td align="center"><b>'.&mt('Enrollment Status').'</b></td>'; + $Str .= '<td align="center"><b>'.&mt('Sequences and Folders').'</b></td>'; + $Str .= '<td align="center"><b>'.&mt('Output Format').'</b>'. + &Apache::loncommon::help_open_topic("Chart_Output_Formats"). + '</td>'; + $Str .= '<td align="center"><b>'.&mt('Output Data').'</b>'. + &Apache::loncommon::help_open_topic("Chart_Output_Data"). + '</td>'; + $Str .= '</tr>'."\n"; + # $Str .= '<tr><td align="center">'."\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 .= '</td><td align="center">'; - $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 .= '</td><td>'."\n"; - $Str .= '<input type="submit" name="DefaultColumns" '; - $Str .= 'value="Default Column Display" />'."\n"; + $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5); $Str .= '</td><td>'."\n"; - $Str .= '<input type="submit" name="displaymode" '; - if (! exists($ENV{'form.displaymode'}) || - lc($ENV{'form.displaymode'}) eq 'display with links') { - $Str .= 'value="Display without links" />'; - # Set the current value, in case it is undefined - $ENV{'form.displaymode'} = 'Display with links'; - } else { - $Str .= 'value="Display with links" />'; - } - $Str .= "\n"; - $Str .= '</td></tr></table>'."\n"; - + $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5, + $only_seq_with_assessments); + $Str .= '</td><td>'."\n"; + $Str .= &CreateAndParseOutputSelector(); + $Str .= '</td><td>'."\n"; + $Str .= &CreateAndParseOutputDataSelector(); + $Str .= '</td></tr>'."\n"; + $Str .= '</table>'."\n"; + $Str .= '<input type="submit" name="Generate Chart" value="'. + &mt('Generate Chart').'" />'; + $Str .= ' 'x5; + $Str .= '<input type="submit" name="selectstudent" value="'. + &mt('Select One Student').'" />'; + $Str .= ' 'x5; + $Str .= '<input type="submit" name="ClearCache" value="'. + &mt('Clear Caches').'" />'; + $Str .= ' 'x5; + $Str .= '<br />'; return $Str; } -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +####################################################### +####################################################### - my $Str = ''; - $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n"; +=pod - $Str .= '<tr>'."\n"; - $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings, - $sequenceKeys); - $Str .= '<td></td></tr>'."\n"; - - $Str .= '<tr>'."\n"; - my $displayString = '<td align="left"><pre><a href="/adm/statistics?'; - $displayString .= 'sort=LINKDATA">DISPLAYDATA</a>FORMATTING'; - $displayString .= $spacing.'</pre></td>'."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $infoKeys, - $infoHeadings, - $displayString, - 'preformatted'); - - $displayString = '<td align="left"><pre>DISPLAYDATAFORMATTING'.$spacing; - $displayString .= '</pre></td>'."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $sequenceKeys, - $sequenceHeadings, - $displayString, - 'preformatted'); +=item &CreateAndParseOutputSelector() - $Str .= '<td><pre>Total Solved/Total Problems</pre></td>'; - $Str .= '</tr></table>'."\n"; +=cut + +####################################################### +####################################################### +my @OutputOptions = + ({ name => 'HTML, with links', + value => 'html, with links', + description => 'Output HTML with each symbol linked to the problem '. + 'which generated it.', + mode => 'html', + show_links => 'yes', + }, + { name => 'HTML, with all links', + value => 'html, with all links', + description => 'Output HTML with each symbol linked to the problem '. + 'which generated it. '. + 'This includes links for unattempted problems.', + mode => 'html', + show_links => 'all', + }, + { name => 'HTML, without links', + value => 'html, without links', + description => 'Output HTML. By not including links, the size of the'. + ' web page is greatly reduced. If your browser crashes on the '. + 'full display, try this.', + mode => 'html', + show_links => 'no', + }, + { name => 'Excel', + value => 'excel', + description => 'Output an Excel file (compatable with Excel 95).', + mode => 'excel', + show_links => 'no', + }, + { name => 'CSV', + value => 'csv', + description => 'Output a comma seperated 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 .= "<h2>Output Formats</h2>\n"; + $Str .= "<dl>\n"; + foreach my $outputmode (@OutputOptions) { + $Str .=" <dt>".$outputmode->{'name'}."</dt>\n"; + $Str .=" <dd>".$outputmode->{'description'}."</dd>\n"; + } + $Str .= "</dl>\n"; return $Str; } -=pod +sub CreateAndParseOutputSelector { + my $Str = ''; + my $elementname = 'chartoutputmode'; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + [$elementname]); + # + # Format for output options is 'mode, restrictions'; + my $selected = 'html, without links'; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; + } else { + $selected = $ENV{'form.'.$elementname}; + } + } + # + # Set package variables describing output mode + $show_links = 'no'; + $output_mode = 'html'; + foreach my $option (@OutputOptions) { + next if ($option->{'value'} ne $selected); + $output_mode = $option->{'mode'}; + $show_links = $option->{'show_links'}; + } + + # + # Build the form element + $Str = qq/<select size="5" name="$elementname">/; + foreach my $option (@OutputOptions) { + $Str .= "\n".' <option value="'.$option->{'value'}.'"'; + $Str .= " selected " if ($option->{'value'} eq $selected); + $Str .= ">".&mt($option->{'name'})."<\/option>"; + } + $Str .= "\n</select>"; + return $Str; +} -=item &FormatStudentData() +## +## Data selector stuff +## +my @OutputDataOptions = + ( + { name => 'Scores Summary', + base => 'scores', + value => 'sum and total', + 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', + shortdesc => 'Score on each Problem Part', + longdesc =>'The students score on each problem part, computed as'. + 'the part weight * part awarded', + }, +# { name => 'Scores Sum', +# base => 'scores', +# value => 'sum only', +# shortdesc => 'Sum of Scores on each Problem Part', +# longdesc =>'The total of the scores of the student on each problem'. +# ' part in the sequences or folders selected.', +# }, +# { name => 'Scores Summary Table Only', +# base => 'scores', +# value => 'final table scores', +# shortdesc => 'Summary of Scores', +# longdesc => 'The average score on each sequence or folder for the '. +# 'selected students.', +# }, + { name =>'Tries', + base =>'tries', + value => 'tries', + shortdesc => 'Number of Tries before success on each Problem Part', + longdesc =>'The number of tries before success on each problem part.', + }, + { name =>'Parts Correct', + base =>'tries', + value => 'parts correct total', + shortdesc => 'Number of Problem Parts completed successfully.', + longdesc => 'The Number of Problem Parts completed successfully and '. + 'the maximum possible for each student', + }, +# { name =>'Parts Correct', +# base =>'tries', +# value => 'parts correct', +# shortdesc => 'Number of Problem Parts completed successfully.', +# longdesc => 'The Number of Problem Parts completed successfully'. +# ' on each sequence or folder.', +# }, +# { name => 'Parts Summary Table Only', +# base => 'tries', +# value => 'final table parts', +# shortdesc => 'Summary of Parts Correct', +# longdesc => 'A summary table of the average number of problem parts '. +# 'students were able to get correct on each sequence.', +# }, + ); -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 HTMLifyOutputDataDescriptions { + my $Str = ''; + $Str .= "<h2>Output Data</h2>\n"; + $Str .= "<dl>\n"; + foreach my $option (@OutputDataOptions) { + $Str .= ' <dt>'.$option->{'name'}.'</dt>'; + $Str .= '<dd>'.$option->{'longdesc'}.'</dd>'."\n"; + } + $Str .= "</dl>\n"; + return $Str; +} -=over 4 +sub CreateAndParseOutputDataSelector { + my $Str = ''; + my $elementname = 'chartoutputdata'; + # + my $selected = 'scores'; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; + } else { + $selected = $ENV{'form.'.$elementname}; + } + } + # + $data = 'scores'; + foreach my $option (@OutputDataOptions) { + if ($option->{'value'} eq $selected) { + $data = $option->{'value'}; + $base = $option->{'base'}; + $datadescription = $option->{'shortdesc'}; + } + } + # + # Build the form element + $Str = qq/<select size="5" name="$elementname">/; + foreach my $option (@OutputDataOptions) { + $Str .= "\n".' <option value="'.$option->{'value'}.'"'; + $Str .= " selected " if ($option->{'value'} eq $data); + $Str .= ">".&mt($option->{'name'})."<\/option>"; + } + $Str .= "\n</select>"; + return $Str; + +} -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 + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 0; + $nodata_count = 0; + undef(%prog_state); + # + $r->print("<h3>".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}. + " ".localtime(time)."</h3>"); + + if ($data !~ /^final table/) { + $r->print("<h3>".$datadescription."</h3>"); + } + # + # Set up progress window for 'final table' display only + if ($data =~ /^final table/) { + my $studentcount = scalar(@Apache::lonstatistics::Students); + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Summary Table Status', + 'Summary Table Compilation Progress', $studentcount); + } + my $Str = "<pre>\n"; + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$Apache::lonstatistics::StudentData{$field}->{'title'}; + my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'}; + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # Now the selected sequences need to be listed + foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){ + my $title = $sequence->{'title'}; + my $base = $sequence->{'base_width'}; + my $width = $sequence->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + $Str .= "total</pre>\n"; + $Str .= "<pre>"; + # + # Check for suppression of output + if ($data =~ /^final table/) { + $Str = ''; + } + $r->print($Str); + $r->rflush(); + return; +} +sub html_outputstudent { + my ($r,$student) = @_; my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; + # + if($count++ % 5 == 0 && $count > 0 && $data !~ /^final table/) { + $r->print("</pre><pre>"); + } + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$student->{$field}; + my $base = length($title); + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # Get ALL the students data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state + ($student->{'username'},$student->{'domain'},undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + if (scalar(@tmp) < 1) { + $nodata_count++; + return if ($data =~ /^final table/); + $Str .= '<font color="blue">No Course Data</font>'."\n"; + $r->print($Str); + $r->rflush(); + return; } - if($cache->{$name.':error'} =~ /course/) { - $Str .= '<b><font color="blue">No course data for student </font>'; - $Str .= '<font color="red">'.$username.'.</font></b><br>'; - return $Str; - } - - my $hasVersion = 'false'; - my $hasFinalData = 'false'; - foreach my $sequence (@$showSequences) { - my $hasData = 'false'; - my $characterCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - # All grades (except for versionless parts) are displayed as links - # to their submission record. Loop through all the parts for the - # current problem in the correct order and prepare the output links - foreach(split(/\:/,$cache->{$sequence.':'.$problemID. - ':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $Str .= ' '; - $characterCount++; - next; - } - $hasVersion = 'true'; - $hasData = 'true'; - if (lc($ENV{'form.displaymode'}) ne 'display without links') { - $Str .= '<a href="/adm/grades?symb='; - $Str .= &Apache::lonnet::escape($problem); - $Str .= '&student='.$username.'&domain='.$domain; - $Str .= '&command=submission">'; - } - my $code = $cache->{$name.':'.$problemID.':'.$_.':code'}; - my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'}; - if($code eq '*' && $tries < 10 && $tries ne '') { - $code = $tries; - } - $Str .= $code; - if (lc($ENV{'form.displaymode'}) ne 'display without links') { - $Str .= '</a>'; - } - $characterCount++; - } + # + # 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 ($base eq '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); } - - # 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 .= '<font color="#007700">'.$outputProblemsCorrect.'</font>'; - $hasFinalData = 'true'; + my $ratio = sprintf("%3d",$score).'/'.sprintf("%3d",$seq_max); + # + if ($data eq 'sum and total' || $data eq 'parts correct total') { + $performance = $ratio; + $performance .= ' 'x($seq->{'width'}-length($ratio)); + } elsif ($data eq 'sum only' || $data eq 'parts correct') { + $performance = $score; + $performance .= ' 'x($seq->{'width'}-length($score)); } else { - $Str .= '<font color="#007700"> </font>'; + # Pad with extra spaces + $performance .= ' 'x($seq->{'width'}-$performance_length- + length($ratio) + ).$ratio; + } + # + $Str .= $performance.$padding; + # + $studentstats->{$seq->{'symb'}}->{'score'}= $score; + $studentstats->{$seq->{'symb'}}->{'max'} = $seq_max; + } + # + # Total it up and store the statistics info. + my ($score,$max) = (0,0); + while (my ($symb,$seq_stats) = each (%{$studentstats})) { + $Statistics->{$symb}->{'score'} += $seq_stats->{'score'}; + if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) { + $Statistics->{$symb}->{'max'} = $seq_stats->{'max'}; } - $Str .= $spacing; + $score += $seq_stats->{'score'}; + $max += $seq_stats->{'max'}; } + $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max; + $Str .= " \n"; + # + # Check for suppressed output and update the progress window if so... + if ($data =~ /^final table/) { + $Str = ''; + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state, + 'last student'); + } + # + $r->print($Str); + # + $r->rflush(); + return; +} - # Output the total correct problems over the total number of problems. - # I don't like this type of formatting, but it is a solution. Need - # a way to dynamically determine the space requirements. - my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'}); - my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'}); - if($hasFinalData eq 'true') { - $Str .= '<font color="#000088">'.$outputProblemsSolved. - ' / '.$outputTotalProblems.'</font>'; +sub html_finish { + my ($r) = @_; + # + # Check for suppressed output and close the progress window if so + if ($data =~ /^final table/) { + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); } else { - $Str .= '<font color="#000088"> </font>'; + $r->print("</pre>\n"); } - - if($hasVersion eq 'false') { - $Str = '<b><font color="blue">No course data.</font></b>'; + if ($single_student_mode) { + $r->print(&SingleStudentTotal()); + } else { + $r->print(&StudentAverageTotal()); } - - return $Str; + $r->rflush(); + return; } - sub StudentAverageTotal { - - return ""; - - my ($cache,$name,$spacing,$showSequences)=@_; - my $username = $name; - my $Str = ''; - my $hasVersion = 'false'; - my $hasFinalData = 'false'; - foreach my $sequence (@$showSequences) { - my $hasData = 'false'; - my $characterCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - # All grades (except for versionless parts) are displayed as links - # to their submission record. Loop through all the parts for the - # current problem in the correct order and prepare the output links - foreach(split(/\:/,$cache->{$sequence.':'.$problemID. - ':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $Str .= ' '; - $characterCount++; - next; - } - $hasVersion = 'true'; - $hasData = 'true'; - $Str .= '<a href="/adm/grades?symb='; - $Str .= &Apache::lonnet::escape($problem); - $Str .= '&student= Average &domain= Total'; - $Str .= '&command=submission">'; - my $code = $cache->{$name.':'.$problemID.':'.$_.':code'}; - my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'}; - if($code eq '*' && $tries < 10 && $tries ne '') { - $code = $tries; - } - $Str .= $code; - $Str .= '</a>'; - $characterCount++; - } + my $Str = "<h3>Summary Tables</h3>\n"; + my $num_students = scalar(@Apache::lonstatistics::Students); + my $total_ave = 0; + my $total_max = 0; + $Str .= '<table border=2 cellspacing="1">'."\n"; + $Str .= "<tr><th>Title</th><th>Average</th><th>Maximum</th></tr>\n"; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my $ave; + if ($num_students > $nodata_count) { + $ave = int(100*($Statistics->{$seq->{'symb'}}->{'score'}/ + ($num_students-$nodata_count)))/100; + } else { + $ave = 0; } + $total_ave += $ave; + my $max = $Statistics->{$seq->{'symb'}}->{'max'}; + $total_max += $max; + if ($ave == 0) { + $ave = "0.00"; + } + $ave .= ' '; + $max .= ' '; + $Str .= '<tr><td>'.$seq->{'title'}.'</td>'. + '<td align="right">'.$ave.'</td>'. + '<td align="right">'.$max.'</td></tr>'."\n"; + } + $total_ave = int(100*$total_ave)/100; # only two digit + $Str .= "</table>\n"; + $Str .= '<table border=2 cellspacing="1">'."\n"; + $Str .= '<tr><th>Number of Students</th><th>Average</th>'. + "<th>Maximum</th></tr>\n"; + $Str .= '<tr><td>'.($num_students-$nodata_count).'</td>'. + '<td>'.$total_ave.'</td><td>'.$total_max.'</td>'; + $Str .= "</table>\n"; + return $Str; +} - # 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 .= '<font color="#007700">'.$outputProblemsCorrect.'</font>'; - $hasFinalData = 'true'; - } else { - $Str .= '<font color="#007700"> </font>'; - } - $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 .= '<font color="#000088">'.$outputProblemsSolved. - ' / '.$outputTotalProblems.'</font>'; - } else { - $Str .= '<font color="#000088"> </font>'; - } - - if($hasVersion eq 'false') { - $Str = '<b><font color="blue">No course data.</font></b>'; - } - +sub SingleStudentTotal { + my $student = &Apache::lonstatistics::current_student(); + my $Str = "<h3>Summary table for ".$student->{'fullname'}." ". + $student->{'username'}.'@'.$student->{'domain'}."</h3>\n"; + $Str .= '<table border=2 cellspacing="1">'."\n"; + $Str .= + "<tr><th>Sequence or Folder</th><th>Score</th><th>Maximum</th></tr>\n"; + my $total = 0; + my $total_max = 0; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my $value = $Statistics->{$seq->{'symb'}}->{'score'}; + my $max = $Statistics->{$seq->{'symb'}}->{'max'}; + $Str .= '<tr><td>'.$seq->{'title'}.'</td>'. + '<td align="right">'.$value.'</td>'. + '<td align="right">'.$max.'</td></tr>'."\n"; + $total += $value; + $total_max +=$max; + } + $Str .= '<tr><td><b>Total</b></td>'. + '<td align="right">'.$total.'</td>'. + '<td align="right">'.$total_max."</td></tr>\n"; + $Str .= "</table>\n"; return $Str; } +} +####################################################### +####################################################### =pod -=item &CreateLegend() +=head2 EXCEL subroutines -This function returns a formatted string containing the legend for the -chart. The legend describes the symbols used to represent grades for -problems. +=item &excel_initialize($r) -=cut +=item &excel_outputstudent($r,$student) -sub CreateLegend { - my $Str = "<p><pre>". - " 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". - "</pre><p>"; - return $Str; -} +=item &excel_finish($r) -=pod +=cut -=item &CreateColumnSelectionBox() +####################################################### +####################################################### +{ + +my $excel_sheet; +my $excel_workbook; + +my $filename; +my $rows_output; +my $cols_output; + +my %prog_state; # progress window state +my $request_aborted; + +my $total_formula; + +sub excel_initialize { + my ($r) = @_; + # + undef ($excel_sheet); + undef ($excel_workbook); + undef ($filename); + undef ($rows_output); + undef ($cols_output); + undef (%prog_state); + undef ($request_aborted); + undef ($total_formula); + # + my $total_columns = scalar(&get_student_fields_to_show()); + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + # Add 2 because we need a 'sum' and 'total' column for each + $total_columns += $seq->{'num_assess_parts'}+2; + } + if ($data eq 'tries' && $total_columns > 255) { + $r->print(<<END); +<h2>Unable to Complete Request</h2> +<p> +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. +</p><p> +You may consider reducing the number of <b>Sequences or Folders</b> you +have selected. +</p><p> +LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the +summary data (<b>Parts Correct</b> or <b>Parts Correct & Totals</b>). +</p> +END + $request_aborted = 1; + } + if ($data eq 'scores' && $total_columns > 255) { + $r->print(<<END); +<h2>Unable to Complete Request</h2> +<p> +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. +</p><p> +You may consider reducing the number of <b>Sequences or Folders</b> you +have selected. +</p><p> +LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the +<b>Scores Summary</b> data. +</p> +END + $request_aborted = 1; + } + if ($data =~ /^final table/) { + $r->print(<<END); +<h2>Unable to Complete Request</h2> +<p> +The <b>Summary Table (Scores)</b> option is not available for non-HTML output. +</p> +END + $request_aborted = 1; + } + return if ($request_aborted); + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + # Create sheet + $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename); + # + # Check for errors + if (! defined($excel_workbook)) { + $r->log_error("Error creating excel spreadsheet $filename: $!"); + $r->print("Problems creating new Excel file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator"); + return ; + } + # + # The excel spreadsheet stores temporary data in files, then put them + # together. If needed we should be able to disable this (memory only). + # The temporary directory must be specified before calling 'addworksheet'. + # File::Temp is used to determine the temporary directory. + $excel_workbook->set_tempdir($Apache::lonnet::tmpdir); + # + # Add a worksheet + my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + $sheetname = &Apache::loncommon::clean_excel_name($sheetname); + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Put the course description in the header + $excel_sheet->write($rows_output,$cols_output++, + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}); + $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($rows_output,$cols_output++,$sectionstring); + $cols_output += scalar(@Sections); + # + # Put the date in there too + $excel_sheet->write($rows_output++,$cols_output++, + 'Compiled on '.localtime(time)); + # + $cols_output = 0; + $excel_sheet->write($rows_output++,$cols_output++,$datadescription); + # +# if ($data eq 'tries' || $data eq 'scores') { + $rows_output+=2; +# } + # + # Add the student headers + $cols_output = 0; + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write($rows_output,$cols_output++,$field); + } + my $row_offset = 0; +# if ($data eq 'tries' || $data eq 'scores') { + $row_offset = -1; +# } + # + # Add the remaining column headers + my $total_formula_string = '=0'; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $excel_sheet->write($rows_output+$row_offset, + $cols_output,$seq->{'title'}); + if ($data eq 'tries' || $data eq 'scores') { + # Determine starting cell + $seq->{'Excel:startcell'}= + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$cols_output); + $seq->{'Excel:startcol'}=$cols_output; + # 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($rows_output, + $cols_output++, + $res->{'title'}.' part '.$part); + } + } else { + $excel_sheet->write($rows_output, + $cols_output++, + $res->{'title'}); + } + } + # Determine ending cell + $seq->{'Excel:endcell'} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$cols_output-1); + $seq->{'Excel:endcol'}=$cols_output-1; + # Create the formula for summing up this sequence + $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 + ($rows_output,$cols_output); + $seq->{'Excel:scorecol'}=$cols_output; + if ($data eq 'parts correct total') { + $excel_sheet->write($rows_output,$cols_output++,'parts correct'); + } else { + $excel_sheet->write($rows_output,$cols_output++,'score'); + } + # + $total_formula_string.='+'. + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$cols_output-1); + $excel_sheet->write($rows_output,$cols_output++,'maximum'); + } + $excel_sheet->write($rows_output,$cols_output++,'Grand Total'); + $total_formula = $excel_sheet->store_formula($total_formula_string); + # + # Bookkeeping +# if ($data eq 'sum and total' || $data eq 'parts correct total') { +# $rows_output += 1; +# } else { + $rows_output += 1; +# } + # + # Output a row for MAX + $cols_output = 0; + foreach my $field (&get_student_fields_to_show()) { + if ($field eq 'username' || $field eq 'fullname' || + $field eq 'id') { + $excel_sheet->write($rows_output,$cols_output++,'Maximum'); + } else { + $excel_sheet->write($rows_output,$cols_output++,''); + } + } + # + # Add the maximums for each sequence or assessment + my %total_cell_translation; + my $grand_total = 0; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + $total_cell_translation{$seq->{'Excel:scorecell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:scorecol'}); + my $weight; + my $max = 0; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + foreach my $part (@{$resource->{'parts'}}) { + $weight = 1; + if ($base eq 'scores') { + $weight = &Apache::lonnet::EXT + ('resource.'.$part.'.weight',$resource->{'symb'}, + undef,undef,undef); + if (!defined($weight) || ($weight eq '')) { + $weight=1; + } + } + if ($data eq 'scores') { + $excel_sheet->write($rows_output,$cols_output++,$weight); + } elsif ($data eq 'tries') { + $excel_sheet->write($rows_output,$cols_output++,''); + } + $max += $weight; + } + } + if (! ($data eq 'sum only' || $data eq 'parts correct')) { + $excel_sheet->write($rows_output,$cols_output++,''); + } + # + if ($data eq 'tries' || $data eq 'scores') { + my %replaceCells; + $replaceCells{$seq->{'Excel:startcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:startcol'}); + $replaceCells{$seq->{'Excel:endcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:endcol'}); + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells); + } else { + $excel_sheet->write($rows_output,$cols_output++, + $max); + } + $grand_total+=$max; + } + if ($data eq 'tries' || $data eq 'scores') { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $total_formula,undef, + %total_cell_translation); + } else { + $excel_sheet->write($rows_output,$cols_output++,$grand_total); + } + $rows_output++; + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + $r->print("<h1>Compiling Excel spreadsheet for ". + $studentcount.' student'); + $r->print('s') if ($studentcount > 1); + $r->print("</h1>\n"); + $r->rflush(); + # + # Initialize progress window + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Excel File Compilation Status', + 'Excel File Compilation Progress', $studentcount); + # + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state, + 'Processing first student'); + return; +} -If there are columns not being displayed then this selection box is created -with a list of those columns. When selections are made and the page -refreshed, the columns will be removed from this box and the column is -put back in the chart. If there is no columns to select, no row is added -to the interface table. +sub excel_outputstudent { + my ($r,$student) = @_; + return if ($request_aborted); + return if (! defined($excel_sheet)); + $cols_output=0; + # + # Write out student data + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + $excel_sheet->write($rows_output,$cols_output++,$student->{$field}); + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Write out sequence scores and totals data + my %total_cell_translation; + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + # Keep track of cells to translate in total cell + $total_cell_translation{$seq->{'Excel:scorecell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:scorecol'}); + # + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($base eq '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 ($data eq 'tries' || $data eq 'scores') { + foreach my $value (@$rawdata) { + $excel_sheet->write($rows_output,$cols_output++,$value); + } + # Write a formula for the sum of this sequence + my %replaceCells; + $replaceCells{$seq->{'Excel:startcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:startcol'}); + $replaceCells{$seq->{'Excel:endcell'}} = + &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell + ($rows_output,$seq->{'Excel:endcol'}); + # The undef is for the format + if (scalar(keys(%replaceCells)) == 1) { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells,%replaceCells); + } else { + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $seq->{'Excel:sum'},undef, + %replaceCells); + } + # + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } elsif ($data eq 'sum and total' || $data eq 'sum only' || + $data eq 'parts correct' || $data eq 'parts correct total') { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + if ($data eq 'sum and total' || $data eq 'parts correct total') { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + $excel_sheet->repeat_formula($rows_output,$cols_output++, + $total_formula,undef, + %total_cell_translation); + + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} -=over 4 -Input: $CacheData, $headings +sub excel_finish { + my ($r) = @_; + return if ($request_aborted); + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print('<br />'. + '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n"); + $r->rflush(); + return; +} +} +####################################################### +####################################################### -$CacheData: A pointer to a hash tied to the cached data +=pod -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=head2 CSV output routines -Output: $notThere +=item &csv_initialize($r) -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. +=item &csv_outputstudent($r,$student) -=back +=item &csv_finish($r) =cut -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; - - my $notThere = ''; - $notThere .= '<select name="ReselectColumns" size="4" '; - $notThere .= 'multiple="true">'."\n"; +####################################################### +####################################################### +{ + +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 ($data =~ /final table/) { + $r->print(<<END); +<h2>Unable to Complete Request</h2> +<p> +The <b>Summary Table (Scores)</b> option is not available for non-HTML output. +</p> +END + $request_aborted = 1; + } + return if ($request_aborted); + + # + # 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"; + # + # Print out the headings + my $Str = ''; + my $Str2 = undef; + foreach my $field (&get_student_fields_to_show()) { + if ($data eq 'sum only') { + $Str .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } elsif ($data eq 'sum and total' || $data eq 'parts correct total') { + $Str .= '"",'; # first row empty on the student fields + $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } elsif ($data eq 'scores' || $data eq 'tries' || + $data eq 'parts correct') { + $Str .= '"",'; + $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } + } + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + if ($data eq 'sum only' || $data eq 'parts correct') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '",'; + } elsif ($data eq 'sum and total' || $data eq 'parts correct total') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '","",'; + $Str2 .= '"score","total possible",'; + } elsif ($data eq 'scores' || $data eq 'tries') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '",'; + $Str .= '"",'x($seq->{'num_assess_parts'}-1+2); + foreach my $res (@{$seq->{'contents'}}) { + next if ($res->{'type'} ne 'assessment'); + foreach my $part (@{$res->{'parts'}}) { + $Str2 .= '"'.&Apache::loncommon::csv_translate($res->{'title'}.', Part '.$part).'",'; + } + } + $Str2 .= '"score","total possible",'; + } + } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + if (defined($Str2)) { + chop($Str2); + $Str2 .= "\n"; + print $outputfile $Str2; + } + # + # 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); + return; +} - for(my $index=0; $index<$doNotShow->{'count'}; $index++) { - my $name = $doNotShow->{$index.':name'}; - $notThere .= '<option value="'; - $notThere .= $doNotShow->{$index.':id'}.'">'; - $notThere .= $name.'</option>'."\n"; +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) { + $Str .= '"'.&Apache::loncommon::csv_translate($student->{$field}).'",'; + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; + } + # + # Output performance data + foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) { + my ($performance,$performance_length,$score,$seq_max,$rawdata); + if ($base eq '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 ($data eq 'sum only' || $data eq 'parts correct') { + $Str .= '"'.$score.'",'; + } elsif ($data eq 'sum and total' || $data eq 'parts correct total') { + $Str .= '"'.$score.'","'.$seq_max.'",'; + } elsif ($data eq 'scores' || $data eq 'tries') { + $Str .= '"'.join('","',(@$rawdata,$score,$seq_max)).'",'; + } } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} - $notThere .= '</select>'; +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('<br />'. + '<a href="'.$filename.'">Your csv file.</a>'."\n"); + $r->rflush(); + return; + +} - return $notThere; } +####################################################### +####################################################### + =pod -=item &CreateColumnSelectors() +=item &StudentTriesOnSequence() -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. +Inputs: =over 4 -Input: $CacheData, $headings +=item $student -$CacheData: A pointer to a hash tied to the cached data +=item $studentdata Hash ref to all student data -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns +=item $seq Hash ref, the sequence we are working on -Output: $present - -$present: The string contains the first row of a table. Each column contains -a checkbox which is left justified. Currently left justification is used -for consistency of location over the column in which it presides. +=item $links if defined we will output links to each resource. =back =cut -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; - - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= '<td align="left">'; - $present .= '<input type="checkbox" checked="on" '; - $present .= 'name="HeadingColumn'.$infoHeadings->[$index].'" />'; - $present .= '</td>'."\n"; - } - - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= '<td align="left">'; - $present .= '<input type="checkbox" checked="on" '; - $present .= 'name="SequenceColumn'.$sequenceKeys->[$index].'" />'; - $present .= '</td>'."\n"; - } - - return $present; -} - -#---- END Student Assessment Web Page ---------------------------------------- - -#---- Student Assessment Worker Functions ------------------------------------ - -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; - - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } - - for(my $index=0; $index<(scalar @$students); $index++) { - my $fullname = $cache->{$students->[$index].':fullname'}; - if($fullname eq $selectedName) { - if($cache->{'StudentAssessmentMove'} eq 'next') { - if($index == ((scalar @$students) - 1)) { - $selectedName = $students->[0]; - return $selectedName; +####################################################### +####################################################### +sub StudentTriesOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + my $performance_length = 0; + my @TriesData = (); + my $tries; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + my $value = ''; + foreach my $partnum (@{$resource->{'parts'}}) { + $tries = undef; + $max++; + $performance_length++; + my $symbol = ' '; # default to space + # + my $awarded = 0; + if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$partnum.'.awarded'}; + $awarded = 0 if (! $awarded); + } + # + my $status = ''; + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + $status = $resource_data->{'resource.'.$partnum.'.solved'}; + } + # + my $tries = 0; + if(exists($resource_data->{'resource.'.$partnum.'.tries'})) { + $tries = $resource_data->{'resource.'.$partnum.'.tries'}; + } + # + if ($awarded > 0) { + # The student has gotten the problem correct to some degree + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($tries > 0) { + if ($tries > 9) { + $symbol = '*'; + } else { + $symbol = $tries; + } + $sum++; } else { - $selectedName = $students->[$index+1]; - return $selectedName; + $symbol = '+'; + $sum++; } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; + } else { + # The student has the problem incorrect or it is ungraded + if ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted' || + $tries > 0) { + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + # Problem is wrong and has not been attempted. + $symbol=' '; } - } else { - $selectedName = $students->[$index]; - return $selectedName; } - last; + # + if (! defined($tries)) { + $tries = $symbol; + } + push (@TriesData,$tries); + # + if ( ($links eq 'yes' && $symbol ne ' ') || + ($links eq 'all')) { + if (length($symbol) > 1) { + &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1'); + } + $symbol = '<a href="/adm/grades'. + '?symb='.&Apache::lonnet::escape($resource->{'symb'}). + '&student='.$student->{'username'}. + '&userdom='.$student->{'domain'}. + '&command=submission">'.$symbol.'</a>'; + } + $value .= $symbol; } + $Str .= $value; } - - return 'No Student Selected'; + if ($seq->{'randompick'}) { + $max = $seq->{'randompick'}; + } + return ($Str,$performance_length,$sum,$max,\@TriesData); } +####################################################### +####################################################### + =pod -=item &ShouldShowColumn() +=item &StudentPerformanceOnSequence() -Determine if a specified column should be shown on the chart. +Inputs: =over 4 -Input: $cache, $test +=item $student -$cache: A pointer to the hash tied to the cached data +=item $studentdata Hash ref to all student data -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=item $seq Hash ref, the sequence we are working on -Output: 0 (false), 1 (true) +=item $links if defined we will output links to each resource. =back =cut -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); +####################################################### +####################################################### +sub StudentPerformanceOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; # final result string + my ($score,$max) = (0,0); + my $performance_length = 0; + my $symbol; + my @ScoreData = (); + my $partscore; + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + foreach my $part (@{$resource->{'parts'}}) { + $partscore = undef; + my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', + $resource->{'symb'}, + $student->{'domain'}, + $student->{'username'}, + $student->{'section'}); + if (!defined($weight) || ($weight eq '')) { + $weight=1; + } + # + $max += $weight; # see the 'excused' branch below... + $performance_length++; # one character per part + $symbol = ' '; # default to space + # + my $awarded = 0; + if (exists($resource_data->{'resource.'.$part.'.awarded'})) { + $awarded = $resource_data->{'resource.'.$part.'.awarded'}; + $awarded = 0 if (! $awarded); + } + # + $partscore = $weight*$awarded; + $score += $partscore; + $symbol = $partscore; + if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) { + $symbol = sprintf("%.0f",$symbol); + } + if (length($symbol) > 1) { + $symbol = '*'; + } + if (exists($resource_data->{'resource.'.$part.'.solved'})) { + my $status = $resource_data->{'resource.'.$part.'.solved'}; + if ($status eq 'excused') { + $symbol = 'x'; + $max -= $weight; # Do not count 'excused' problems. + } + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$part.'.tries'})){ + $symbol = '.'; + } else { + $symbol = ' '; + } + } + # + if (! defined($partscore)) { + $partscore = $symbol; + } + push (@ScoreData,$partscore); + # + if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) { + $symbol = '<a href="/adm/grades'. + '?symb='.&Apache::lonnet::escape($resource->{'symb'}). + '&student='.$student->{'username'}. + '&userdom='.$student->{'domain'}. + '&command=submission">'.$symbol.'</a>'; + } + $Str .= $symbol; + } + } + return ($Str,$performance_length,$score,$max,\@ScoreData); +} - my @sequenceKeys=(); - my @sequenceHeadings=(); +####################################################### +####################################################### - my %doNotShow; +=pod - my $index; - my $count = 0; - my $check = ''; - for($index=0; $index < scalar @$headings; $index++) { - $check = 'HeadingColumn'.$headings->[$index]; - if($cache->{'HeadingsFound'} =~ /$check/) { - push(@infoHeadings, $headings->[$index]); - push(@infoKeys, $cacheKey->[$index]); - } else { - $doNotShow{$count.':name'} = $headings->[$index]; - $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index]; - $count++; - } - } +=item &CreateLegend() - foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) { - $check = 'SequenceColumn'.$sequence; - if($cache->{'SequencesFound'} eq 'All Sequences' || - $cache->{'SequencesFound'} =~ /$check/) { - push(@sequenceHeadings, $cache->{$sequence.':title'}); - push(@sequenceKeys, $sequence); - } else { - $doNotShow{$count.':name'} = $cache->{$sequence.':title'}; - $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence; - $count++; - } - } +This function returns a formatted string containing the legend for the +chart. The legend describes the symbols used to represent grades for +problems. - $doNotShow{'count'} = $count; +=cut - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); +####################################################### +####################################################### +sub CreateLegend { + my $Str = "<p><pre>". + " 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". + "</pre><p>"; + return $Str; } -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### + +=pod + +=back + +=cut + +####################################################### +####################################################### 1; + __END__