Diff for /loncom/interface/statistics/lonstudentassessment.pm between versions 1.3 and 1.33

version 1.3, 2002/07/26 16:22:09 version 1.33, 2003/03/04 14:21:36
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # (Publication Handler  
 #  #
 # $Id$  # $Id$
 #  #
 # Copyright Michigan State University Board of Trustees  # Copyright Michigan State University Board of Trustees
 #  #
 # This file is part of the LearningOnline Network with CAPA (LON-CAPA).  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #  
 # LON-CAPA is free software; you can redistribute it and/or modify  # LON-CAPA is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by  # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2 of the License, or  # the Free Software Foundation; either version 2 of the License, or
Line 26 Line 24
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # (Navigate problems for statistical reports  # (Navigate problems for statistical reports
 # YEAR=2001  
 # 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei  
 # 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei  
 # YEAR=2002  
 # 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei  
 # 5/12,5/14,5/15,5/19,5/26,7/16  Behrouz Minaei  
 #  #
 ###  #######################################################
   #######################################################
   
   =pod
   
   =head1 NAME
   
   lonstudentassessment
   
   =head1 SYNOPSIS
   
   Presents assessment data about a student or a group of students.
   
 package Apache::lonstudentassessment;   =head1 Subroutines
   
   =over 4 
   
   =cut
   
   #######################################################
   #######################################################
   
   package Apache::lonstudentassessment;
   
 use strict;  use strict;
   use Apache::lonstatistics;
 use Apache::lonhtmlcommon;  use Apache::lonhtmlcommon;
 use Apache::loncoursedata;  use Apache::loncoursedata;
 use GDBM_File;  use Apache::lonnet; # for logging porpoises
   use Spreadsheet::WriteExcel;
 sub BuildStudentAssessmentPage {  
     my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,  
         $studentInformation,$r,$c)=@_;  
   
     my %cache;  
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {  
         $r->print('<html><body>Unable to tie database.</body></html>');  
         return;  
     }  
   
     # Remove students who don't have the proper section.  #######################################################
     my @sectionsSelected = split(':',$cache{'sectionsSelected'});  #######################################################
     for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;  =pod
         $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 $selectedName = &FindSelectedStudent(\%cache,   =item Package Variables
                                             $cache{'StudentAssessmentStudent'},  
                                             $students);  
     $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName));  
   
     my $Ptr = '';  =over 4
     if($selectedName eq 'No Student Selected') {  
  $Ptr .= '<h3><font color=blue>WARNING: ';  
         $Ptr .= 'Please select a student</font></h3>';  
         $r->print($Ptr);  
         return;  
     }  
   
     my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys) =   =item $Statistics Hash ref to store student data.  Indexed by symb,
         &ShouldShowColumns(\%cache, $headings, $studentInformation);        contains hashes with keys 'score' and 'max'.
   
     $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings,  =cut
                                    $sequenceKeys, $sequenceHeadings));  
     untie(%cache);  
   
     my $selected=0;  
     $r->print('<pre>'."\n");  
     foreach (@$students) {  
         next if ($_ ne $selectedName &&   
                  $selectedName ne 'All Students');  
         $selected = 1;  
         my $courseData;   
         if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {  
             if($cache{$_.':lastDownloadTime'} eq 'Not downloaded') {  
                 untie(%cache);  
                 $courseData =   
                     &Apache::loncoursedata::DownloadCourseInformation($_,   
                                                                     $courseID);  
                 if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT,0640)) {  
                     &Apache::loncoursedata::ProcessStudentData(\%cache,   
                                                              $courseData, $_);  
                     untie(%cache);  
                 } else {  
                     last if($c->aborted());  
                     next;  
                 }  
             } else {  
                 untie(%cache);  
             }  
         } else {  
             last if($c->aborted());  
             next;  
         }  
   
         last if ($c->aborted());  #######################################################
   #######################################################
   
         if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {  my $Statistics;
             my $displayString = 'DISPLAYDATA'.$spacing;  
             $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(  
                                                          \%cache, $_,  
                                                          $infoKeys,  
                                                          $displayString,  
                                                          'preformatted'));  
             $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));  
             $r->print("\n");  
             untie(%cache);  
         }  
     }  
     $r->print('</pre>'."\n");  
     if($selected == 0) {  
  $Ptr .= '<h3><font color=blue>WARNING: ';  
         $Ptr .= 'Please select a student</font></h3>';  
         $r->print($Ptr);  
     }  
   
     return;  #######################################################
 }  #######################################################
   
 #---- Student Assessment Web Page --------------------------------------------  =pod
   
 sub CreateInterface {  =item $show_links 'yes' or 'no' for linking to student performance data
     my($cache,$selectedName,$students,$formName)=@_;  
     my $Ptr = '';  
     $Ptr .= &CreateLegend();  
     $Ptr .= '<table><tr><td>'."\n";  
     $Ptr .= '<input type="submit" name="PreviousStudent" ';  
     $Ptr .= 'value="Previous Student" />'."\n";  
     $Ptr .= '&nbsp&nbsp&nbsp'."\n";  
     $Ptr .= &Apache::lonhtmlcommon::StudentOptions($cache, $students,   
                                                    $selectedName,   
                                                    'StudentAssessment',   
                                                    $formName);  
     $Ptr .= "\n".'&nbsp&nbsp&nbsp'."\n";  
     $Ptr .= '<input type="submit" name="NextStudent" ';  
     $Ptr .= 'value="Next Student" />'."\n";  
     $Ptr .= '</td></tr></table>'."\n";  
     $Ptr .= '<table><tr><td align="center"><b>Select Sections</b>';  
     $Ptr .= '</td></tr>'."\n";  
   
     $Ptr .= '<tr><td align="center">'."\n";  
     my @sections = split(':',$cache->{'sectionList'});  
     my @selectedSections = split(':',$cache->{'sectionsSelected'});  
     $Ptr .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections,  
                                                           \@selectedSections,  
                                                           'Statistics');  
     $Ptr .= '</td></tr></table>'."\n";  
   
     return $Ptr;  
 }  
   
 sub CreateTableHeadings {  
     my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,  
        $sequenceHeadings)=@_;  
   
     my $Str = '';  =item $output_mode 'html', 'excel', or 'csv' for output mode
     $Str .= '<table border="0" cellpadding="0" cellspacing="0"><tr>'."\n";  
   
     my $displayString = '<td align="left"><pre><a href="/adm/statistics?';  =item $show 'all', 'totals', or 'scores' determines how much data is output
     $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>DISPLAYDATA'.$spacing;  
     $displayString .= '</pre></td>'."\n";  
     $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,  
                                                    $sequenceKeys,  
                                                    $sequenceHeadings,  
                                                    $displayString,  
                                                    'preformatted');  
   
     $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';  =cut
     $Str .= '</tr></table>'."\n";  
   
     return $Str;  #######################################################
 }  #######################################################
   my $show_links;
   my $output_mode;
   my $show;
   
   #######################################################
   #######################################################
   # End of package variable declarations
   
 =pod  =pod
   
 =item &FormatStudentData()  =back
   
 First, FormatStudentInformation is called and prefixes the course information.  =cut
 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.  
   
 =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   Inputs: 
 remove data from the hash.  They represent   
 the name of the data to be removed.  
   
 $ChartDB: The name of the cached data database which will be tied to that   =over 4
 database.  
   
 Output: $Str  =item $r Apache Request
   
 $Str: Formatted string that is an entire row of the chart.  It is a   =item $c Apache Connection 
 concatenation of student information and student course information.  
   
 =back  =back
   
 =cut  =cut
   
 sub StudentReport {  #######################################################
     my ($cache,$name,$spacing,$showSequences)=@_;  #######################################################
     my ($username,$domain)=split(':',$name);  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 &quot;Update&nbsp;Display&quot;.
   </font>
   </p>
   ENDMSG
   #        $r->print(&OutputDescriptions());
           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 ; }
       #
       # 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;
   }
   
   #######################################################
   #######################################################
   
     my $Str = '';  sub get_student_fields_to_show {
     if($cache->{$name.':error'} =~ /course/) {      my @to_show = @Apache::lonstatistics::SelectedStudentData;
         $Str .= '<b><font color="blue">No course data for student </font>';      foreach (@to_show) {
         $Str .= '<font color="red">'.$username.'.</font></b><br>';          if ($_ eq 'all') {
         return $Str;              @to_show = @Apache::lonstatistics::StudentDataOrder;
     }              last;
           }
     my $Version;      }
     my $problemsCorrect = 0;      return @to_show;
     my $totalProblems   = 0;  }
     my $problemsSolved  = 0;  
     my $numberOfParts   = 0;  
 #    foreach my $sequence (split(':', $cache->{'orderedSequences'})) {  
     foreach my $sequence (@$showSequences) {  
         my $characterCount=0;  
         foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {  
             my $problem = $cache->{$problemID.':problem'};  
             my $LatestVersion = $cache->{$name.':version:'.$problem};  
   
             # Output dashes for all the parts of this problem if there  
             # is no version information about the current problem.  
             if(!$LatestVersion) {  
                 foreach my $part (split(/\:/,$cache->{$sequence.':'.  
                                                       $problemID.  
                                                       ':parts'})) {  
                     $Str .= ' ';  
                     $totalProblems++;  
                     $characterCount++;  
                 }  
                 next;  
             }  
   
             my %partData=undef;  sub get_sequences_to_show {
             # Initialize part data, display skips correctly      my @Sequences;
             # Skip refers to when a student made no submissions on that      foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) {
             # part/problem.          foreach my $sequence (@Apache::lonstatistics::Sequences) {
             foreach my $part (split(/\:/,$cache->{$sequence.':'.              next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all');
                                                   $problemID.              next if ($sequence->{'num_assess'} < 1);
                                                   ':parts'})) {              push (@Sequences,$sequence);
                 $partData{$part.':tries'}=0;          }
                 $partData{$part.':code'}=' ';      }
             }      return @Sequences;
   }
   
             # Looping through all the versions of each part, starting with the  
             # oldest version.  Basically, it gets the most recent   
             # set of grade data for each part.  
     for(my $Version=1; $Version<=$LatestVersion; $Version++) {  
                 foreach my $part (split(/\:/,$cache->{$sequence.':'.  
                                                       $problemID.  
                                                       ':parts'})) {  
   
                     if(!defined($cache->{$name.":$Version:$problem".  
                                                ":resource.$part.solved"})) {  
                         # No grade for this submission, so skip  
                         next;  
                     }  
   
                     my $tries=0;  #######################################################
                     my $code=' ';  #######################################################
   
                     $tries = $cache->{$name.':'.$Version.':'.$problem.  =pod
                                       ':resource.'.$part.'.tries'};  
                     $partData{$part.':tries'}=($tries) ? $tries : 0;  
   
                     my $val = $cache->{$name.':'.$Version.':'.$problem.  
                                        ':resource.'.$part.'.solved'};  
                     if    ($val eq 'correct_by_student')   {$code = '*';}   
                     elsif ($val eq 'correct_by_override')  {$code = '+';}  
                     elsif ($val eq 'incorrect_attempted')  {$code = '.';}   
                     elsif ($val eq 'incorrect_by_override'){$code = '-';}  
                     elsif ($val eq 'excused')              {$code = 'x';}  
                     elsif ($val eq 'ungraded_attempted')   {$code = '#';}  
                     else                                   {$code = ' ';}  
                     $partData{$part.':code'}=$code;  
                 }  
             }  
   
             # All grades (except for versionless parts) are displayed as links  =item &CreateInterface()
             # to their submission record.  Loop through all the parts for the  
             # current problem in the correct order and prepare the output links  
             $Str .= '<a href="/adm/grades?symb=';  
             $Str .= &Apache::lonnet::escape($problem);  
             $Str .= '&student='.$username.'&domain='.$domain;  
             $Str .= '&command=submission">';   
             foreach(split(/\:/,$cache->{$sequence.':'.$problemID.  
                                         ':parts'})) {  
                 if($partData{$_.':code'} eq '*') {  
                     $problemsCorrect++;  
                     if (($partData{$_.':tries'}<10) &&  
                         ($partData{$_.':tries'} ne '')) {  
                         $partData{$_.':code'}=$partData{$_.':tries'};  
                     }  
                 } elsif($partData{$_.':code'} eq '+') {  
                     $problemsCorrect++;  
                 }  
   
                 $Str .= $partData{$_.':code'};  Called by &BuildStudentAssessmentPage to create the top part of the
                 $characterCount++;  page which displays the chart.
   
                 if($partData{$_.':code'} ne 'x') {  Inputs: None
                     $totalProblems++;  
                 }  
             }  
             $Str.='</a>';  
         }  
   
         # Output the number of correct answers for the current sequence.  Returns:  A string containing the HTML for the headers and top table for 
         # This part takes up 6 character slots, but is formated right   the chart page.
         # justified.  
         my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;  
         $spacesNeeded -= 3;  
         $Str .= (' 'x$spacesNeeded);  
   
  my $outputProblemsCorrect = sprintf( "%3d", $problemsCorrect );  
  $Str .= '<font color="#007700">'.$outputProblemsCorrect.'</font>';  
  $problemsSolved += $problemsCorrect;  
  $problemsCorrect=0;  
   
         $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", $problemsSolved );  
     my $outputTotalProblems  = sprintf( "%4d", $totalProblems );  
     $Str .= '<font color="#000088">'.$outputProblemsSolved.  
     ' / '.$outputTotalProblems.'</font>';  
   
   =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;      return $Str;
 }  }
   
 =pod  #######################################################
   #######################################################
   
 =item &CreateLegend()  =pod
   
 This function returns a formatted string containing the legend for the  =item &CreateAndParseOutputSelector()
 chart.  The legend describes the symbols used to represent grades for  
 problems.  
   
 =cut  =cut
   
 sub CreateLegend {  #######################################################
     my $Str = "<p><pre>".  #######################################################
               "1..9: correct by student in 1..9 tries\n".  my @OutputOptions = 
               "   *: correct by student in more than 9 tries\n".      ({ name  => 'HTML, with links',
       "   +: correct by override\n".         value => 'html, with links',
               "   -: incorrect by override\n".         description => 'Output HTML with each symbol linked to the problem '.
       "   .: incorrect attempted\n".     'which generated it.'},
       "   #: ungraded attempted\n".       { name  => 'HTML, without links',
               "    : not attempted\n".         value => 'html, without links',
       "   x: excused".         description => 'Output HTML.  By not including links, the size of the'.
               "</pre><p>";      ' 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 = '';
       $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;
   }
   
   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 {
               $selected = $ENV{'form.'.$elementname};
           }
       }
       #
       # 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 {
           $output_mode = 'html';
       }
       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;      return $Str;
 }  }
   
   #######################################################
   #######################################################
   
 =pod  =pod
   
 =item &CreateColumnSelectionBox()  =head2 HTML output routines
   
 If there are columns not being displayed then this selection box is created  =item &html_initialize($r)
 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  Create labels for the columns of student data to show.
 Input: $CacheData, $headings  
   
   =item &html_outputstudent($r,$student)
   
 $CacheData: A pointer to a hash tied to the cached data  Return a line of the chart for a student.
   
 $headings:  An array of the names of the columns for the student information.    =item &html_finish($r)
 They are used for displaying which columns are missing.  
   
 Output: $notThere  =cut
   
 $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.  {
       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;
   }
   
 =back  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;
   }    
   
 =cut  sub html_finish {
       my ($r) = @_;
       $r->print("</pre>\n"); 
       $r->rflush();
       return;
   }
   
   }
   
   #######################################################
   #######################################################
   
   =pod
   
 sub CreateColumnSelectionBox {  =head2 EXCEL subroutines
     my ($CacheData,$headings)=@_;  
   
     my $missing=0;  =item &excel_initialize($r)
     my $notThere='<tr><td align="right"><b>Select column to view:</b>';  
     my $name;  
     $notThere .= '<td align="left">';  
     $notThere .= '<select name="ChartReselect" size="4" multiple="true">'."\n";  
   
     for(my $index=0; $index<(scalar @$headings); $index++) {  =item &excel_outputstudent($r,$student)
         if(&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) {  
             next;  =item &excel_finish($r)
   
   =cut
   
   #######################################################
   #######################################################
   {
   
   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++;
         }          }
         $name = $headings->[$index];  
         $notThere .= '<option value="ChartHeading'.$index.'">';  
         $notThere .= $name.'</option>'."\n";  
         $missing++;  
     }      }
       #
       # 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;
   }
   
     foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {  sub excel_outputstudent {
         if(&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) {      my ($r,$student) = @_;
             next;      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);
         }          }
         $name = $CacheData->{$sequence.':title'};  
         $notThere .= '<option value="ChartSequence'.$sequence.'">';  
         $notThere .= $name.'</option>'."\n";  
         $missing++;  
     }      }
       #
       # 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;
   }
   
     if($missing) {  sub excel_finish {
         $notThere .= '</select>';      my ($r) = @_;
     } else {      return if (! defined($excel_sheet));
         $notThere='<tr><td>';      #
       # 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.'</td></tr>';  
 }  }
   #######################################################
   #######################################################
   
 =pod  =pod
   
 =item &CreateColumnSelectors()  =head2 CSV output routines
   
 This function generates the checkboxes above the column headings.  The   =item &csv_initialize($r)
 column will be removed if the checkbox is unchecked.  
   
 =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  sub csv_finish {
 a checkbox which is left justified.  Currently left justification is used      my ($r) = @_;
 for consistency of location over the column in which it presides.  }
   
 =back  }
   
 =cut  #######################################################
   #######################################################
   
 sub CreateColumnSelectors {  
     my ($headings)=@_;  
 =pod  =pod
     my $found=0;  
     my ($name, $length, $position);  
   
     my $present = '<tr>';  =item &StudentPerformanceOnSequence()
     for(my $index=0; $index<(scalar @$headings); $index++) {  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="ChartHeading'.$index.'" />';  
         $present .= '</td>';  
         $found++;  
     }  
   
     foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {  Inputs:
         if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) {  
             next;  
         }  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="ChartSequence'.$sequence.'" />';  
         $present .= '</td>';  
         $found++;  
     }  
   
     if(!$found) {  =over 4
         $present = '';  
     }  
   
     return $present.'<td></td></tr></form>'."\n";;  =item $student
 =cut  
 }  
   
 #---- END Student Assessment Web Page ----------------------------------------  =item $studentdata Hash ref to all student data
   
 #---- Student Assessment Worker Functions ------------------------------------  =item $seq Hash ref, the sequence we are working on
   
 sub FindSelectedStudent {  =item $links if defined we will output links to each resource.
     my($cache, $selectedName, $students)=@_;  
   
     if($selectedName eq 'All Students' ||   =back
        $selectedName eq 'No Student Selected') {  
         return $selectedName;  =cut
     }  
   
     for(my $index=0; $index<(scalar @$students); $index++) {  #######################################################
         my $fullname = $cache->{$students->[$index].':fullname'};  #######################################################
         if($fullname eq $selectedName) {  sub StudentPerformanceOnSequence {
             if($cache->{'StudentAssessmentMove'} eq 'next') {      my ($student,$studentdata,$seq,$links) = @_;
                 if($index == ((scalar @$students) - 1)) {      $links = 'no' if (! defined($links));
                     $selectedName = $students->[0];      my $Str = '';
                     return $selectedName;      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 {                  } else {
                     $selectedName = $students->[$index+1];                      $symbol = ' ';
                     return $selectedName;  
                 }                  }
             } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {              } else {
                 if($index == 0) {                  # Unsolved.  Did they try?
                     $selectedName = $students->[-1];                  if (exists($resource_data->{'resource.'.$partnum.'.tries'})){
                     return $selectedName;                      $symbol = '.';
                 } else {                  } else {
                     $selectedName = $students->[$index-1];                      $symbol = ' ';
                     return $selectedName;  
                 }                  }
             } 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 ($Str,$sum,$max);
     return 'No Student Selected';  
 }  }
   
 =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   =pod
 (sequence.$sequenceIndex)  
   
 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  =cut
   
 sub ShouldShowColumns {  #######################################################
     my ($cache,$headings,$cacheKey)=@_;  #######################################################
   sub CreateLegend {
     my @infoKeys=();      my $Str = "<p><pre>".
     my @infoHeadings=();                "   1  correct by student in 1 try\n".
                 "   7  correct by student in 7 tries\n".
     my @sequenceKeys=();                "   *  correct by student in more than 9 tries\n".
     my @sequenceHeadings=();        "   +  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 $index;  #######################################################
     for($index=0; $index < scalar @$headings; $index++) {  #######################################################
         push(@infoHeadings, $headings->[$index]);  
         push(@infoKeys, $cacheKey->[$index]);  
     }  
   
     foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) {  =pod 
         push(@sequenceHeadings, $cache->{$sequence.':title'});  
         push(@sequenceKeys, $sequence);  
     }  
   
 #    my $headings=$cache->{'form.ChartHeadings'};  =back
 #    my $sequences=$cache->{'form.ChartSequences'};  
 #    if($headings eq 'ALLHEADINGS' || $sequences eq 'ALLSEQUENCES' ||  
 #       $headings=~/$test/ || $sequences=~/$test/) {  
 #        return 1;  
 #    }  
   
     return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,   =cut
             \@sequenceKeys);  
 }  
   
 #---- END Student Assessment Worker Functions --------------------------------  #######################################################
   #######################################################
   
 1;  1;
   
 __END__  __END__

Removed from v.1.3  
changed lines
  Added in v.1.33


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>