--- loncom/interface/statistics/lonstudentassessment.pm 2002/10/24 20:58:06 1.17 +++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/04 14:21:36 1.33 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.17 2002/10/24 20:58:06 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.33 2003/03/04 14:21:36 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,680 +24,921 @@ # 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 -use strict; -use Apache::lonhtmlcommon; -use Apache::loncoursedata; -use GDBM_File; +=head1 NAME -#my $jr; +lonstudentassessment -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>'); - return; - } +=head1 SYNOPSIS - # 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); - } - } - 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(); +Presents assessment data about a student or a group of students. - 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; - } +=head1 Subroutines - $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')); - } +=over 4 - $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); - } - } +=cut +####################################################### +####################################################### -# $r->print("AverageTtal"); - $r->print(&StudentAverageTotal(\%cache, $spacing, $sequenceKeys)); - $r->print("\n"); - $r->rflush(); - untie(%cache); +package Apache::lonstudentassessment; + +use strict; +use Apache::lonstatistics; +use Apache::lonhtmlcommon; +use Apache::loncoursedata; +use Apache::lonnet; # for logging porpoises +use Spreadsheet::WriteExcel; +####################################################### +####################################################### +=pod - $r->print('</pre>'."\n"); - if($selected == 0) { - $Str .= '<h3><font color=blue>WARNING: '; - $Str .= 'Please select a student</font></h3>'; - $r->print($Str); - } +=item Package Variables - return; -} +=over 4 -#---- Student Assessment Web Page -------------------------------------------- +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. -sub CreateInterface { - my($cache,$selectedName,$students,$formName,$doNotShow)=@_; +=cut - 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"; +####################################################### +####################################################### - $Str .= '<tr><td align="center">'."\n"; - my @sections = split(':',$cache->{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); - $Str .= '</td><td align="center">'; - $Str .= &CreateColumnSelectionBox($doNotShow); - $Str .= '</td><td>'."\n"; - $Str .= '<input type="submit" name="DefaultColumns" '; - $Str .= 'value="Default Column Display" />'."\n"; - $Str .= '</td></tr></table>'."\n"; +my $Statistics; - return $Str; -} +####################################################### +####################################################### -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +=pod - my $Str = ''; - $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n"; +=item $show_links 'yes' or 'no' for linking to student performance data - $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 $output_mode 'html', 'excel', or 'csv' for output mode - $Str .= '<td><pre>Total Solved/Total Problems</pre></td>'; - $Str .= '</tr></table>'."\n"; +=item $show 'all', 'totals', or 'scores' determines how much data is output - return $Str; -} +=cut + +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $show; + +####################################################### +####################################################### +# End of package variable declarations =pod -=item &FormatStudentData() +=back -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. +=cut -=over 4 +####################################################### +####################################################### -Input: $name, $studentInformation, $ChartDB +=pod -$name: The name and domain of the current student in name:domain format +=item &BuildStudentAssessmentPage() -$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. +Inputs: -$ChartDB: The name of the cached data database which will be tied to that -database. +=over 4 -Output: $Str +=item $r Apache Request -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +=item $c Apache Connection =back =cut -sub StudentReport { - my ($cache,$name,$spacing,$showSequences)=@_; - my ($username,$domain)=split(':',$name); - - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; +####################################################### +####################################################### +sub BuildStudentAssessmentPage { + my ($r,$c)=@_; + undef($Statistics); + # + # 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->rflush(); + if (! exists($ENV{'form.notfirstrun'})) { + $r->print(<<ENDMSG); +<p> +<font size="+1"> +Please make your selections in the boxes above and hit +the button marked "Update Display". +</font> +</p> +ENDMSG +# $r->print(&OutputDescriptions()); + 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'; - $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; - $Str .= '</a>'; - $characterCount++; - } + # + # + 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 ; } + # + # Call the initialize routine selected above + $initialize->($r); + foreach my $student (@Apache::lonstatistics::Students) { + if($c->aborted()) { + $finish->($r); + return ; } + # Call the output_student routine selected above + $output_student->($r,$student); + } + # Call the "finish" routine selected above + $finish->($r); + # + return; +} - # Output the number of correct answers for the current sequence. - # This part takes up 6 character slots, but is formated right - # justified. - my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount; - $spacesNeeded -= 3; - $Str .= (' 'x$spacesNeeded); - -# my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence. -# ':problemsCorrect'}); - - my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence. - ':problemsCorrect'}, - $characterCount); - if($hasData eq 'true') { - $Str .= '<font color="#007700">'.$outputProblemsCorrect.'</font>'; - $hasFinalData = 'true'; - } else { - $Str .= '<font color="#007700"> </font>'; +####################################################### +####################################################### + +sub get_student_fields_to_show { + my @to_show = @Apache::lonstatistics::SelectedStudentData; + foreach (@to_show) { + if ($_ eq 'all') { + @to_show = @Apache::lonstatistics::StudentDataOrder; + last; } - $Str .= $spacing; } + return @to_show; +} - # 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>'; +sub get_sequences_to_show { + my @Sequences; + foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) { + foreach my $sequence (@Apache::lonstatistics::Sequences) { + next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all'); + next if ($sequence->{'num_assess'} < 1); + push (@Sequences,$sequence); + } } + return @Sequences; +} - if($hasVersion eq 'false') { - $Str = '<b><font color="blue">No course data.</font></b>'; - } +####################################################### +####################################################### + +=pod + +=item &CreateInterface() + +Called by &BuildStudentAssessmentPage to create the top part of the +page which displays the chart. + +Inputs: None + +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>Sections</b></td>'; + $Str .= '<td align="center"><b>Student Data</b></td>'; + $Str .= '<td align="center"><b>Sequences and Folders</b></td>'; + $Str .= '<td align="center"><b>Output Format</b></td>'; + $Str .= '</tr>'."\n"; + # + $Str .= '<tr><td align="center">'."\n"; + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); + $Str .= '</td><td align="center">'; + 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 .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5, + $only_seq_with_assessments); + $Str .= '</td><td>'."\n"; + $Str .= &CreateAndParseOutputSelector(); + $Str .= '</td></tr>'."\n"; + $Str .= '</table>'."\n"; return $Str; } +####################################################### +####################################################### -sub StudentAverageTotal { - - return ""; +=pod + +=item &CreateAndParseOutputSelector() + +=cut - my ($cache,$name,$spacing,$showSequences)=@_; - my $username = $name; +####################################################### +####################################################### +my @OutputOptions = + ({ name => 'HTML, with links', + value => 'html, with links', + description => 'Output HTML with each symbol linked to the problem '. + 'which generated it.'}, + { 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.'}, + { name => 'HTML, scores only', + value => 'html, scores only', + description => 'Output HTML, only showing the total number of correct'. + ' problems (or problem parts) and not the maximum possible for '. + 'each student'}, + { name => 'HTML, totals', + value => 'html, totals', + description => 'Output HTML, but only the summary statistics for each'. + ' sequence selected.'}, + { name => 'Excel, scores only', + value => 'excel, scores only', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with a single column for each sequence showing the students '. + 'score.'}, +# { name => 'Excel, everything', +# value => 'excel, everything', +# description => 'Output an Excel file (compatable with Excel 95), '. +# 'with a seperate worksheet for each sequence you have selected '. +# 'the data for each problem part '. +# '(number of tries, status, points awarded) '. +# 'will be listed.'}, + { name => 'Excel, totals', + value => 'excel, totals', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with two columns for each sequence, the students score on the '. + 'sequence and the students maximum possible on the sequence'}, + { name => 'CSV, everything', + value => 'csv, everything', + description => ''}, + { name => 'CSV, scores only', + value => 'csv, scores only', + description => ''}, + { name => 'CSV, totals', + value => 'csv, totals', + description => ''}, + ); + +sub OutputDescriptions { 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++; - } - } + $Str .= "<h2>Output Modes</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; +} - # 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'; +sub CreateAndParseOutputSelector { + my $Str = ''; + my $elementname = 'outputmode'; + # + # Format for output options is 'mode, restrictions'; + my $selected = 'html, with links'; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; } else { - $Str .= '<font color="#007700"> </font>'; + $selected = $ENV{'form.'.$elementname}; } - $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>'; + # + # Set package variables describing output mode + $show_links = 'no'; + $output_mode = 'html'; + $show = 'all'; + my ($mode,$restriction) = split(',',$selected); + $restriction =~ s/^\s*//; + if ($mode =~ /^(html|excel|csv)$/) { + $output_mode = $mode; } else { - $Str .= '<font color="#000088"> </font>'; + $output_mode = 'html'; } - - if($hasVersion eq 'false') { - $Str = '<b><font color="blue">No course data.</font></b>'; + if ($restriction eq 'with links') { + $show_links = 'yes'; + } else { + $show_links = 'no'; } - + if ($restriction eq 'totals') { + $show = 'totals'; + } elsif ($restriction eq 'scores only') { + $show = 'scores'; + } else { + $show = 'everything'; + } + # + # 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 .= ">".$option->{'name'}."<\/option>"; + } + $Str .= "\n</select>"; return $Str; } - +####################################################### +####################################################### =pod -=item &CreateLegend() +=head2 HTML output routines -This function returns a formatted string containing the legend for the -chart. The legend describes the symbols used to represent grades for -problems. +=item &html_initialize($r) + +Create labels for the columns of student data to show. + +=item &html_outputstudent($r,$student) + +Return a line of the chart for a student. + +=item &html_finish($r) =cut -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 override\n". - " - incorrect by override\n". - " . incorrect attempted\n". - " # ungraded attempted\n". - " not attempted (blank field)\n". - " x excused". - "</pre><p>"; - return $Str; +####################################################### +####################################################### +{ + my $padding; + my $count; + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 1; + # + 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 (&get_sequences_to_show) { + my $title = $sequence->{'title'}; + my $base = $sequence->{'base_width'}; + my $width = $sequence->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + $Str .= "total (of shown problems)</pre>\n"; + $Str .= "<pre>"; + $r->print($Str); + $r->rflush(); + return; } -=pod +sub html_outputstudent { + my ($r,$student) = @_; + my $Str = ''; + # 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) { + $Str .= '<font color="blue">No Course Data</font>'."\n"; + $r->print($Str); + $r->rflush(); + return; + } + # + # By sequence build up the data + my $studentstats; + my $PerformanceStr = ''; + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,$show_links); + my $ratio = $score.'/'.$seq_max; + # + if ($show eq 'totals') { + $performance = ' 'x(length($seq_max)-length($score)).$ratio; + $performance .= ' 'x($seq->{'width'}-length($performance)); + } elsif ($show eq 'scores') { + $performance = $score; + $performance .= ' 'x($seq->{'width'}-length($performance)); + } else { + # Pad with extra spaces + $performance .= ' 'x($seq->{'width'}-$seq_max- + 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'}; + $Statistics->{$symb}->{'max'} += $seq_stats->{'max'}; + $score += $seq_stats->{'score'}; + $max += $seq_stats->{'max'}; + } + $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max; + $Str .= " \n"; + $r->print($Str); + # + $count++; + if($count % 5 == 0) { + $r->print("</pre><pre>"); + } + # + $r->rflush(); + return; +} -=item &CreateColumnSelectionBox() +sub html_finish { + my ($r) = @_; + $r->print("</pre>\n"); + $r->rflush(); + 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. +} -=over 4 -Input: $CacheData, $headings +####################################################### +####################################################### +=pod -$CacheData: A pointer to a hash tied to the cached data +=head2 EXCEL subroutines -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +=item &excel_initialize($r) -Output: $notThere +=item &excel_outputstudent($r,$student) -$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. - -=back +=item &excel_finish($r) =cut -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; - - my $notThere = ''; - $notThere .= '<select name="ReselectColumns" size="4" '; - $notThere .= 'multiple="true">'."\n"; +####################################################### +####################################################### +{ + +my $excel_sheet; +my $excel_workbook; + +my $filename; +my $rows_output; +my $cols_output; + +my $num_students; +my $start_time; + +sub excel_initialize { + my ($r) = @_; + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + $num_students = 0; + $start_time = time; + # + # 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'}; + if (length($sheetname) > 31) { + $sheetname = substr($sheetname,0,31); + } + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Add the student headers + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write(1,$cols_output++,$field); + } + # + # Add the Sequence Headers + foreach my $seq (&get_sequences_to_show) { + $excel_sheet->write(0,$cols_output,$seq->{'title'}); + if ($show eq 'totals') { + $excel_sheet->write(1,$cols_output,'score'); + $excel_sheet->write(1,$cols_output+1,'maximum'); + $cols_output += 2; + } else { + $cols_output++; + } + } + # + # Bookkeeping + if ($show eq 'totals') { + $rows_output = 2; + } else { + $rows_output = 1; + } + # + # 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(); + # + 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 excel_outputstudent { + my ($r,$student) = @_; + 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 + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + if ($show eq 'totals' || $show eq 'scores') { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + if ($show eq 'totals') { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Time estimate + $num_students++; + if ($num_students % 10 == 0) { + my $time_est = (time - $start_time)/$num_students * + (scalar(@Apache::lonstatistics::Students)-$num_students); + $time_est = int($time_est); + if (int ($time_est/60) > 0) { + my $min = int($time_est/60); + my $sec = $time_est % 60; + $time_est = $min.' minutes'; + if ($sec > 1) { + $time_est.= ', '.$sec.' seconds'; + } elsif ($sec > 0) { + $time_est.= ', '.$sec.' second'; + } + } else { + $time_est .= ' seconds'; + } + $r->print($num_students.' out of '. + (scalar(@Apache::lonstatistics::Students)). + " students processed. ". + $time_est." remain. <br />\n"); + $r->rflush(); } + return; +} - $notThere .= '</select>'; +sub excel_finish { + my ($r) = @_; + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Tell the user where to get their excel file + $r->print('<br /><br />'. + '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n"); + my $total_time = time - $start_time; + if (int ($total_time / 60) > 0) { + $total_time = int($total_time/60).' minutes, '.($total_time % 60); + } + $r->print('<br />'.$total_time.' seconds total'); + $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) -$CacheData: A pointer to a hash tied to the cached data +=cut -$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_initialize{ + my ($r) = @_; + $r->print("<h1>Not implemented yet</h1>"); + return; +} -Output: $present +sub csv_outputstudent { + my ($r,$student) = @_; +} -$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. +sub csv_finish { + my ($r) = @_; +} -=back +} -=cut +####################################################### +####################################################### -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; +=pod - 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"; - } +=item &StudentPerformanceOnSequence() - 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"; - } +Inputs: - return $present; -} +=over 4 -#---- END Student Assessment Web Page ---------------------------------------- +=item $student -#---- Student Assessment Worker Functions ------------------------------------ +=item $studentdata Hash ref to all student data -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; +=item $seq Hash ref, the sequence we are working on - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } +=item $links if defined we will output links to each resource. + +=back + +=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 StudentPerformanceOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + my $value = ''; + foreach my $partnum (@{$resource->{'parts'}}) { + $max++; + my $symbol = ' '; # default to space + # + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + my $status = $resource_data->{'resource.'.$partnum.'.solved'}; + if ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted') { + $symbol = '.'; + } elsif ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_student' && + exists($resource_data->{'resource.'.$partnum.'.tries'})){ + my $num = $resource_data->{'resource.'.$partnum.'.tries'}; + if ($num > 9) { + $symbol = '*'; + } elsif ($num > 0) { + $symbol = $num; + } else { + $symbol = ' '; + } + $sum++; } else { - $selectedName = $students->[$index+1]; - return $selectedName; + $symbol = ' '; } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$partnum.'.tries'})){ + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + $symbol = ' '; } - } else { - $selectedName = $students->[$index]; - return $selectedName; } - last; + # + if ($links eq 'yes' && $symbol ne ' ') { + $symbol = '<a href="/adm/grades'. + '?symb='.&Apache::lonnet::escape($resource->{'symb'}). + '&student='.$student->{'username'}. + '&domain='.$student->{'domain'}. + '&command=submission">'.$symbol.'</a>'; + } + $value .= $symbol; } + $Str .= $value; } - - return 'No Student Selected'; + return ($Str,$sum,$max); } -=pod - -=item &ShouldShowColumn() +####################################################### +####################################################### +sub StudentAverageTotal { + my ($cache, $students, $sequenceKeys)=@_; + my $Str = "\n<b>Summary Tables:</b>\n"; + my %Correct = (); + my $ProblemsSolved = 0; + my $TotalProblems = 0; + my $StudentCount = 0; + + foreach my $name (@$students) { + $StudentCount++; + foreach my $sequence (@$sequenceKeys) { + $Correct{$sequence} += + $cache->{$name.':'.$sequence.':problemsCorrect'}; + } + $ProblemsSolved += $cache->{$name.':problemsSolved'}; + $TotalProblems += $cache->{$name.':totalProblems'}; + } + if ($StudentCount) { + $ProblemsSolved = sprintf( "%.2f", + $ProblemsSolved/$StudentCount); + $TotalProblems /= $StudentCount; + } else { + $ProblemsSolved = 0; + $TotalProblems = 0; + } -Determine if a specified column should be shown on the chart. + $Str .= '<table border=2 cellspacing="1">'."\n"; + $Str .= '<tr><td><b>Students Count</b></td><td><b>'. + $StudentCount.'</b></td></tr>'."\n"; + $Str .= '<tr><td><b>Total Problems</b></td><td><b>'. + $TotalProblems.'</b></td></tr>'."\n"; + $Str .= '<tr><td><b>Average Correct</b></td><td><b>'. + $ProblemsSolved.'</b></td></tr>'."\n"; + $Str .= '</table>'."\n"; + + $Str .= '<table border=2 cellspacing="1">'."\n"; + $Str .= '<tr><th>Title</th><th>Total Problems</th>'. + '<th>Average Correct</th></tr>'."\n"; + foreach my $S(@$sequenceKeys) { + my $title=$cache->{$S.':title'}; + #$Str .= $cache->{$S.':problems'}; + #my @problems=split(':', $cache->{$S.':problems'}); + #my $pCount=scalar @problems; + my $pCount=MaxSeqPr($cache,@$students[0],$S); + my $crr; + if ($StudentCount) { + $crr=sprintf( "%.2f", $Correct{$S}/$StudentCount ); + } else { + $crr="0.00"; + } + $Str .= '<tr><td>'.$title. + '</td><td align=center>'.$pCount. + '</td><td align=center>'.$crr. + '</td></tr>'."\n"; + } -=over 4 + $Str .= '</table>'."\n"; -Input: $cache, $test + return $Str; +} -$cache: A pointer to the hash tied to the cached data +####################################################### +####################################################### -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=pod -Output: 0 (false), 1 (true) +=item &CreateLegend() -=back +This function returns a formatted string containing the legend for the +chart. The legend describes the symbols used to represent grades for +problems. =cut -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); - - my @sequenceKeys=(); - my @sequenceHeadings=(); +####################################################### +####################################################### +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; +} - my %doNotShow; - - 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++; - } - } +####################################################### +####################################################### - 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++; - } - } +=pod - $doNotShow{'count'} = $count; +=back - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); -} +=cut -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### 1; + __END__