Diff for /loncom/interface/statistics/lonstudentassessment.pm between versions 1.27 and 1.36

version 1.27, 2003/01/13 01:34:11 version 1.36, 2003/03/06 21:12:54
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # (Publication Handler  
 #  #
 # $Id$  # $Id$
 #  #
Line 25 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  =pod
 # 5/12,5/14,5/15,5/19,5/26,7/16,12/24  Behrouz Minaei  
 # YEAR=2003    =head1 NAME
 # 1/11  Behrouz Minaei  
 ###  lonstudentassessment
   
   =head1 SYNOPSIS
   
   Presents assessment data about a student or a group of students.
   
   =head1 Subroutines
   
   =over 4 
   
   =cut
   
   #######################################################
   #######################################################
   
 package Apache::lonstudentassessment;  package Apache::lonstudentassessment;
   
 use strict;  use 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;
   
   #######################################################
   #######################################################
   =pod
   
   =item Package Variables
   
   =over 4
   
   =item $Statistics Hash ref to store student data.  Indexed by symb,
         contains hashes with keys 'score' and 'max'.
   
   =cut
   
   #######################################################
   #######################################################
   
   my $Statistics;
   
   #######################################################
   #######################################################
   
   =pod
   
   =item $show_links 'yes' or 'no' for linking to student performance data
   
   =item $output_mode 'html', 'excel', or 'csv' for output mode
   
   =item $show 'all', 'totals', or 'scores' determines how much data is output
   
   =cut
   
   #######################################################
   #######################################################
   my $show_links;
   my $output_mode;
   my $show;
   
   #######################################################
   #######################################################
   # End of package variable declarations
   
   =pod
   
   =back
   
   =cut
   
   #######################################################
   #######################################################
   
   =pod
   
   =item &BuildStudentAssessmentPage()
   
   Inputs: 
   
   =over 4
   
   =item $r Apache Request
   
   =item $c Apache Connection 
   
   =back
   
   =cut
   
   #######################################################
   #######################################################
 sub BuildStudentAssessmentPage {  sub BuildStudentAssessmentPage {
     my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,      my ($r,$c)=@_;
         $studentInformation,$r,$c)=@_;      undef($Statistics);
     my %cache;      #
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {      # Print out the HTML headers for the interface
         $r->print('<html><body>Unable to tie database.</body></html>');      #    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;          return;
     }      }
       #
     # Remove students who don't have the proper section.      #
     my @sectionsSelected = split(':',$cache{'sectionsSelected'});      my $initialize     = \&html_initialize;
     for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;      my $output_student = \&html_outputstudent;
         $studentIndex--) {      my $finish         = \&html_finish;
         my $value = $cache{$students->[$studentIndex].':section'};      #
         my $found = 0;      if ($output_mode eq 'excel') {
         foreach (@sectionsSelected) {          $initialize     = \&excel_initialize;
             if($_ eq 'none') {          $output_student = \&excel_outputstudent;
                 if($value eq '' || !defined($value) || $value eq ' ') {          $finish         = \&excel_finish;
                     $found = 1;      } elsif ($output_mode eq 'multi-sheet excel') {
                     last;          $initialize     = \&multi_sheet_excel_initialize;
                 }          $output_student = \&multi_sheet_excel_outputstudent;
             } else {          $finish         = \&multi_sheet_excel_finish;
                 if($value eq $_) {      } elsif ($output_mode eq 'csv') {
                     $found = 1;          $initialize     = \&csv_initialize;
                     last;          $output_student = \&csv_outputstudent;
                 }          $finish         = \&csv_finish;
             }      }
         }      #
         if($found == 0) {      if($c->aborted()) {  return ; }
             splice(@$students, $studentIndex, 1);      #
       # 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);
     }      }
     my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,      # Call the "finish" routine selected above
         $doNotShow) =      $finish->($r);
         &ShouldShowColumns(\%cache, $headings, $studentInformation);      #
       return;
     my $selectedName = &FindSelectedStudent(\%cache,  }
                                             $cache{'StudentAssessmentStudent'},  
                                             $students);  
     $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,  
                                $doNotShow));  
     $r->rflush();  
   
     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;  
     }  
   
     $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings,  sub get_student_fields_to_show {
                                    $sequenceKeys, $sequenceHeadings));      my @to_show = @Apache::lonstatistics::SelectedStudentData;
     untie(%cache);      foreach (@to_show) {
     if($c->aborted()) {  return $Str; }          if ($_ eq 'all') {
               @to_show = @Apache::lonstatistics::StudentDataOrder;
     my $selected=0;              last;
     my $Count = 0;          }
     $r->print('<pre>'."\n");      }
     foreach (@$students) {      return @to_show;
         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, $_);  
                 }  
             }  
             $Count++;  
     my $out = '';  
     $out .= sprintf("%3d) ", $Count);  
             if($Count % 2) {  
                 $out .= '<bgcolor="#FFFFFF">';  
             } else {  
                 $out .= '<bgcolor="#505050">';  
             }  
     my $displayString = $out.'DISPLAYDATA'.$spacing;  
     $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(  
                                                          \%cache, $_,  
                                                          \@before,  
                                                          $displayString,  
                                                          'preformatted'));  
   
             if($foundUpdate) {  
                 $displayString = '';  
                 $displayString .= '<a href="/adm/statistics?reportSelected=';  
                 $displayString .= &Apache::lonnet::escape('Student Assessment');  
                 $displayString .= '&download='.$_.'">';  
                 $displayString .= 'DISPLAYDATA</a>'.$spacing;  
                 $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(  
                                                                    \%cache, $_,  
                                                                    \@updateColumn,  
                                                                    $displayString,  
                                                                    'preformatted'));  
             }  
   
             $displayString = 'DISPLAYDATA'.$spacing;  sub get_sequences_to_show {
             $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(      my @Sequences;
                                                          \%cache, $_,      foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) {
                                                          \@after,          foreach my $sequence (@Apache::lonstatistics::Sequences) {
                                                          $displayString,              next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all');
                                                          'preformatted'));              next if ($sequence->{'num_assess'} < 1);
             $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));              push (@Sequences,$sequence);
             $r->print("\n");          }
             $r->rflush();  
             untie(%cache);  
         }  
     }  
     $r->print('</pre>'."\n");   
     if($selected == 0) {  
  $Str .= '<h3><font color=blue>WARNING: ';  
         $Str .= 'No Students enrolled OR Please select a student</font></h3>';  
         $r->print($Str);  
     } else {  
  if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
     $r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys));  
     untie(%cache);  
  }  
     }      }
     return;      return @Sequences;
 }  }
   
   
 #---- Student Assessment Web Page --------------------------------------------  #######################################################
   #######################################################
   
 sub CreateInterface {  =pod
     my($cache,$selectedName,$students,$formName,$doNotShow)=@_;  
   
     my $Str = '';  =item &CreateInterface()
     $Str .= &CreateLegend();  
     $Str .= '<table><tr><td>'."\n";  Called by &BuildStudentAssessmentPage to create the top part of the
     $Str .= '<input type="submit" name="PreviousStudent" ';  page which displays the chart.
     $Str .= 'value="Previous Student" />'."\n";  
     $Str .= '&nbsp&nbsp&nbsp'."\n";  Inputs: None
     $Str .= &Apache::lonhtmlcommon::StudentOptions($cache, $students,  
                                                    $selectedName,  Returns:  A string containing the HTML for the headers and top table for 
                                                    'StudentAssessment',  the chart page.
                                                    $formName);  
     $Str .= "\n".'&nbsp&nbsp&nbsp'."\n";  =cut
     $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";  
   
   #######################################################
   #######################################################
   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>Problem Sets</b></td>';
       $Str .= '<td align="center"><b>Output Format</b></td>';
       $Str .= '</tr>'."\n";
       #
     $Str .= '<tr><td align="center">'."\n";      $Str .= '<tr><td align="center">'."\n";
     my @sections = split(':',$cache->{'sectionList'});      $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
     my @selectedSections = split(':',$cache->{'sectionsSelected'});  
     $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections,  
                                                           \@selectedSections,  
                                                           'Statistics');  
     $Str .= '</td><td align="center">';      $Str .= '</td><td align="center">';
     $Str .= &CreateColumnSelectionBox($doNotShow);      my $only_seq_with_assessments = sub { 
           my $s=shift;
           if ($s->{'num_assess'} < 1) { 
               return 0;
           } else { 
               return 1;
           }
       };
       $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
                                                         5,undef);
     $Str .= '</td><td>'."\n";      $Str .= '</td><td>'."\n";
     $Str .= '<input type="submit" name="DefaultColumns" ';      $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
     $Str .= 'value="Default Column Display" />'."\n";                                                $only_seq_with_assessments);
     $Str .= '</td><td>'."\n";      $Str .= '</td><td>'."\n";
     $Str .= '<input type="submit" name="displaymode" ';      $Str .= &CreateAndParseOutputSelector();
     if (! exists($ENV{'form.displaymode'}) ||      $Str .= '</td></tr>'."\n";
         lc($ENV{'form.displaymode'}) eq 'display with links') {      $Str .= '</table>'."\n";
         $Str .= 'value="Display without links" />';  
         # Set the current value, in case it is undefined  
         $ENV{'form.displaymode'} = 'Display with links';  
     } else {  
         $Str .= 'value="Display with links" />';  
     }  
     $Str .= "\n";  
     $Str .= '</td></tr></table>'."\n";  
   
     return $Str;      return $Str;
 }  }
   
 sub CreateTableHeadings {  #######################################################
     my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,  #######################################################
        $sequenceHeadings)=@_;  
   
 #    my $Str = '&nbsp&nbsp&nbsp&nbsp&nbsp';  =pod
     my $Str = '';  
     $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n";  
     $Str .= '<tr>'."\n";  
     $Str .= '<td><pre>     </pre></td>'."\n";  
     $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings,  
                                    $sequenceKeys);  
     $Str .= '<td></td></tr>'."\n";  
   
     $Str .= '<tr>'."\n";  
     my $displayString = '';  
     $displayString .= '<td><pre>     </pre></td>'."\n";  
     $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');  
   
     $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';  =item &CreateAndParseOutputSelector()
     $Str .= '</tr></table>'."\n";  
   
     return $Str;  =cut
 }  
   
 =pod  #######################################################
   #######################################################
   my @OutputOptions = 
       ({ name  => 'HTML, with links',
          value => 'html, with links',
          description => 'Output HTML with each symbol linked to the problem '.
      'which generated it.',
          mode => 'html',
          show => 'all',
          show_links => 'yes',
          },
        { name  => 'HTML, without links',
          value => 'html, without links',
          description => 'Output HTML.  By not including links, the size of the'.
      ' web page is greatly reduced.  If your browser crashes on the '.
      'full display, try this.',
          mode => 'html',
          show => 'all',
          show_links => 'no',
              },
        { 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',
          mode => 'html',
          show => 'scores',
          show_links => 'no',
              },
        { name  => 'HTML, totals',
          value => 'html, totals',
          description => 'Output HTML, but only the summary statistics for each'.
      ' sequence selected.',
          mode => 'html',
          show => 'totals',
          show_links => 'no',
          },
        { 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.',
          mode => 'excel',
          show => 'scores',
          show_links => 'no',
              },
        { 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',
          mode => 'excel',
          show => 'totals',
          show_links => 'no',
              },
        { name  => 'multi-sheet Excel',
          value => 'multi-sheet excel',
          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.',
          mode => 'multi-sheet excel',
          show => 'totals',
          show_links => 'no',
              },
        { name  => 'multi-sheet Excel, by section',
          value => 'multi-sheet excel, by section',
          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.  '.
              'There will be one Excel workbook for each section selected.',
          mode => 'multi-sheet excel',
          show => 'by section',
          show_links => 'no',
              },
        { name  => 'CSV, everything',
          value => 'csv, everything',
          description => '',
          mode => 'csv',
          show => 'all',
          show_links => 'no',
              },
        { name  => 'CSV, scores only',
          value => 'csv, scores only',
          description => '',
          mode => 'csv',
          show => 'scores',
          show_links => 'no',
              },
        { name  => 'CSV, totals',
          value => 'csv, totals',
          description => '',
          mode => 'csv',
          show => 'totals',
          show_links => 'no',
              },
        );
   
 =item &FormatStudentData()  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;
   }
   
 First, FormatStudentInformation is called and prefixes the course information.  sub CreateAndParseOutputSelector {
 This function produces a formatted string of the student\'s course information.      my $Str = '';
 Each column of data represents all the problems for a given sequence.  For      my $elementname = 'outputmode';
 valid grade data, a link is created for that problem to a submission record      #
 for that problem.      # 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';
       foreach my $option (@OutputOptions) {
           next if ($option->{'value'} ne $selected);
           $output_mode = $option->{'mode'};
           $show        = $option->{'show'};
           $show_links  = $option->{'show_links'};
       }
   
       #
       # Build the form element
       $Str = qq/<select size="5" name="$elementname">/;
       foreach my $option (@OutputOptions) {
           $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
           $Str .= " selected " if ($option->{'value'} eq $selected);
           $Str .= ">".$option->{'name'}."<\/option>";
       }
       $Str .= "\n</select>";
       return $Str;
   }
   
 =over 4  #######################################################
   #######################################################
   
 Input: $name, $studentInformation, $ChartDB  =pod
   
 $name: The name and domain of the current student in name:domain format  =head2 HTML output routines
   
 $studentInformation: A pointer to an array holding the names used to   =item &html_initialize($r)
 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   Create labels for the columns of student data to show.
 database.  
   
 Output: $Str  =item &html_outputstudent($r,$student)
   
 $Str: Formatted string that is an entire row of the chart.  It is a  Return a line of the chart for a student.
 concatenation of student information and student course information.  
   
 =back  =item &html_finish($r)
   
 =cut  =cut
   
 sub StudentReport {  #######################################################
     my ($cache,$name,$spacing,$showSequences)=@_;  #######################################################
     my ($username,$domain)=split(':',$name);  {
       my $padding;
       my $count;
   
   sub html_initialize {
       my ($r) = @_;
       #
       $padding = ' 'x3;
       $count = 0;
       #
       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;
   }
   
   sub html_outputstudent {
       my ($r,$student) = @_;
     my $Str = '';      my $Str = '';
     if(defined($cache->{$name.':error'})) {      #
         return $Str;      if($count++ % 5 == 0 && $count > 0) {
           $r->print("</pre><pre>");
       }
       # First, the @StudentData fields need to be listed
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           my $title=$student->{$field};
           my $base = length($title);
           my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       # Get ALL the students data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state
           ($student->{'username'},$student->{'domain'},undef,
            $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
     }      }
     if($cache->{$name.':error'} =~ /course/) {      if (scalar(@tmp) < 1) {
         $Str .= '<b><font color="blue">No course data for student </font>';          $Str .= '<font color="blue">No Course Data</font>'."\n";
         $Str .= '<font color="red">'.$username.'.</font></b><br>';          $r->print($Str);
         return $Str;          $r->rflush();
     }          return;
       }
     my $hasVersion = 'false';      #
     my $hasFinalData = 'false';      # By sequence build up the data
     foreach my $sequence (@$showSequences) {      my $studentstats;
         my $hasData = 'false';      my $PerformanceStr = '';
         my $characterCount=0;      foreach my $seq (&get_sequences_to_show) {
         foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {          my ($performance,$score,$seq_max) =
             my $problem = $cache->{$problemID.':problem'};              &StudentPerformanceOnSequence($student,\%StudentsData,
             # All grades (except for versionless parts) are displayed as links                                            $seq,$show_links);
             # to their submission record.  Loop through all the parts for the          my $ratio = $score.'/'.$seq_max;
             # current problem in the correct order and prepare the output links          #
             foreach(split(/\:/,$cache->{$sequence.':'.$problemID.          if ($show eq 'totals') {
                                         ':parts'})) {              $performance = ' 'x(length($seq_max)-length($score)).$ratio;
                 if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||              $performance .= ' 'x($seq->{'width'}-length($performance));
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||          } elsif ($show eq 'scores') {
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {              $performance = $score;
                     $Str .= ' ';              $performance .= ' 'x($seq->{'width'}-length($performance));
                     $characterCount++;          } else {
                     next;              # Pad with extra spaces
                 }              $performance .= ' 'x($seq->{'width'}-$seq_max-
                 $hasVersion = 'true';                                   length($ratio)
                 $hasData = 'true';                                   ).$ratio;
                 if (lc($ENV{'form.displaymode'}) ne 'display without links') {  
                     $Str .= '<a href="/adm/grades?symb=';  
                     $Str .= &Apache::lonnet::escape($problem);  
                     $Str .= '&student='.$username.'&domain='.$domain;  
                     $Str .= '&command=submission">';  
                 }  
                 my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};  
                 my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};  
                 if($code eq '*' && $tries < 10 && $tries ne '') {  
                     $code = $tries;  
                 }  
                 $Str .= $code;  
                 if (lc($ENV{'form.displaymode'}) ne 'display without links') {  
                     $Str .= '</a>';  
                 }  
                 $characterCount++;  
             }  
         }          }
           #
           $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);
       #
       $r->rflush();
       return;
   }    
   
   sub html_finish {
       my ($r) = @_;
       $r->print("</pre>\n"); 
       $r->rflush();
       return;
   }
   
   }
   
   #######################################################
   #######################################################
   
   =pod
   
   =head2 Multi-Sheet EXCEL subroutines
   
   =item &multi_sheet_excel_initialize($r)
   
   =item &multi_sheet_excel_outputstudent($r,$student)
   
   =item &multi_sheet_excel_finish($r)
   
         # Output the number of correct answers for the current sequence.  =cut
         # This part takes up 6 character slots, but is formated right  
         # justified.  #######################################################
         my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;  #######################################################
         $spacesNeeded -= 3;  {
         $Str .= (' 'x$spacesNeeded);  
   sub multi_sheet_excel_initialize {
 #        my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence.      my ($r)=@_;
 #    ':problemsCorrect'});      $r->print("<h1>Not yet implemented</h1>");
       # 
  my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence.      # Estimate the size of the file.  We would like to have < 5 megs of data.
                                             ':problemsCorrect'},      my $max_size = 5000000;
                                             $characterCount);      my $num_students  = scalar(@Apache::lonstatistics::Students);
         if($hasData eq 'true') {      my $num_sequences = 0;
             $Str .= '<font color="#007700">'.$outputProblemsCorrect.'</font>';      my $num_data_per_part  = 2; # 'status' and 'numtries'
             $hasFinalData = 'true';      my $fields_per_student = scalar(&get_student_fields_to_show());
       my $bytes_per_field    = 20; # Back of the envelope calculation
       foreach my $seq (&get_sequences_to_show) {
           $num_sequences++ if ($seq->{'num_assess'} > 0);
           $fields_per_student += $num_data_per_part * $seq->{'num_assess_parts'};
       }
       my $size_estimate = $fields_per_student*$num_students*$bytes_per_field;
       #
       # Compute number of workbooks
       my $num_workbooks = 1;
       if ($size_estimate > $max_size) { # try to stay under 5 megs
           $num_workbooks += int($size_estimate / $max_size);
       }
       if ($show eq 'by section') {
           if (@Apache::lonstatistics::SelectedSections > 1 && 
               $Apache::lonstatistics::SelectedSections[0] ne 'all') {
               $num_workbooks = scalar(@Apache::lonstatistics::SelectedSections);
         } else {          } else {
             $Str .= '<font color="#007700">     </font>';              # @Apache::lonstatistics::Sections contains 'all' as well.
               $num_workbooks = scalar(@Apache::lonstatistics::Sections) - 1;
         }          }
         $Str .= $spacing;  
     }      }
       
       $r->print("Maximum allowed size: ".$max_size." bytes<br />");
       $r->print("Number of students: ".$num_students."<br />");
       $r->print("Number of fields per student: ".$fields_per_student."<br />");
       $r->print("Total number of fields: ".($fields_per_student*$num_students).
                 "<br />");
       $r->print("Bytes per field: ".$bytes_per_field." (estimated)"."<br />");
       $r->print("Estimated size: ".$size_estimate." bytes<br />");
       $r->print("Number of workbooks: ".$num_workbooks."<br />");
       $r->rflush();
       return;
   }
   
   sub multi_sheet_excel_outputstudent {
       my ($r,$student) = @_;
   }
   
   sub multi_sheet_excel_finish {
       my ($r) = @_;
   }
   
   }
   #######################################################
   #######################################################
   
   =pod
   
   =head2 EXCEL subroutines
   
   =item &excel_initialize($r)
   
   =item &excel_outputstudent($r,$student)
   
   =item &excel_finish($r)
   
   =cut
   
     # 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'});  my $excel_sheet;
     if($hasFinalData eq 'true') {  my $excel_workbook;
         $Str .= '<font color="#000088">'.$outputProblemsSolved.  
     ' / '.$outputTotalProblems.'</font>';  my $filename;
   my $rows_output;
   my $cols_output;
   
   my %prog_state; # progress window state
   
   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;
       #
       # 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);
       #
       # Put the course description in the header
       $excel_sheet->write($rows_output,$cols_output++,
                      $ENV{'course.'.$ENV{'request.course.id'}.'.description'});
       $cols_output += 3;
       #
       # Put a description of the sections listed
       my $sectionstring = '';
       my @Sections = @Apache::lonstatistics::SelectedSections;
       if (scalar(@Sections) > 1) {
           if (scalar(@Sections) > 2) {
               my $last = pop(@Sections);
               $sectionstring = "Sections ".join(', ',@Sections).', and '.$last;
           } else {
               $sectionstring = "Sections ".join(' and ',@Sections);
           }
       } else {
           if ($Sections[0] eq 'all') {
               $sectionstring = "All sections";
           } else {
               $sectionstring = "Section ".$Sections[0];
           }
       }
       $excel_sheet->write($rows_output,$cols_output++,$sectionstring);
       $cols_output += scalar(@Sections);
       #
       # Put the date in there too
       $excel_sheet->write($rows_output,$cols_output++,
                           'Compiled on '.localtime(time));
       #
       $rows_output++;
       #
       # Add the student headers
       $cols_output = 0;
       foreach my $field (&get_student_fields_to_show()) {
           $excel_sheet->write($rows_output,$cols_output++,$field);
       }
       #
       # Add the Sequence Headers
       foreach my $seq (&get_sequences_to_show) {
           $excel_sheet->write($rows_output,$cols_output,$seq->{'title'});
           if ($show eq 'totals') {
               $excel_sheet->write($rows_output+1,$cols_output,'score');
               $excel_sheet->write($rows_output+1,$cols_output+1,'maximum');
               $cols_output += 2;
           } else {
               $cols_output++;
           }
       }
       #
       # Bookkeeping
       if ($show eq 'totals') {
           $rows_output += 2;
     } else {      } else {
         $Str .= '<font color="#000088">           </font>';          $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();
       #
       # Initialize progress window
       %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
           ($r,'Excel File Compilation Status',
            'Excel File Compilation Progress', $studentcount);
       #
       return;
   }
   
     if($hasVersion eq 'false') {  sub excel_outputstudent {
         $Str = '<b><font color="blue">No course data.</font></b>';      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;
       #
       # Update the progress window
       &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
       return;
   }
   
   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());
       #
       # Close the progress window
       &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
       #
       # Tell the user where to get their excel file
       $r->print('<br />'.
                 '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
       $r->rflush();
       return;
   }
   
   }
   #######################################################
   #######################################################
   
   =pod
   
   =head2 CSV output routines
   
   =item &csv_initialize($r)
   
   =item &csv_outputstudent($r,$student)
   
   =item &csv_finish($r)
   
   =cut
   
   #######################################################
   #######################################################
   {
   
   sub csv_initialize{
       my ($r) = @_;
       $r->print("<h1>Not implemented yet</h1>");
       return;
   }
   
   sub csv_outputstudent {
       my ($r,$student) = @_;
   }
   
   sub csv_finish {
       my ($r) = @_;
   }
   
     return $Str;  
 }  }
   
   #######################################################
   #######################################################
   
   =pod
   
   =item &StudentPerformanceOnSequence()
   
   Inputs:
   
   =over 4
   
   =item $student
   
   =item $studentdata Hash ref to all student data
   
   =item $seq Hash ref, the sequence we are working on
   
   =item $links if defined we will output links to each resource.
   
   =back
   
   =cut
   
   #######################################################
   #######################################################
   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 {
                       $symbol = ' ';
                   }
               } else {
                   # Unsolved.  Did they try?
                   if (exists($resource_data->{'resource.'.$partnum.'.tries'})){
                       $symbol = '.';
                   } else {
                       $symbol = ' ';
                   }
               }
               #
               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);
   }
   
   #######################################################
   #######################################################
 sub StudentAverageTotal {  sub StudentAverageTotal {
     my ($cache, $students, $sequenceKeys)=@_;      my ($cache, $students, $sequenceKeys)=@_;
     my $Str = "\n<b>Summary Tables:</b>\n";      my $Str = "\n<b>Summary Tables:</b>\n";
Line 467  sub StudentAverageTotal { Line 1019  sub StudentAverageTotal {
     return $Str;      return $Str;
 }  }
   
   #######################################################
   #######################################################
 sub MaxSeqPr {  
     my ($cache, $name, $sequence)=@_;  
     my $prCount=0;  
     foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {  
         my $problem = $cache->{$problemID.':problem'};  
         foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) {  
             if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||  
                $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||  
                $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {  
                  $prCount++;  
                  next;  
             }  
             $prCount++;  
         }  
     }  
     return $prCount;  
 }  
   
   
   
   
   
 =pod  =pod
   
Line 501  problems. Line 1032  problems.
   
 =cut  =cut
   
   #######################################################
   #######################################################
 sub CreateLegend {  sub CreateLegend {
     my $Str = "<p><pre>".      my $Str = "<p><pre>".
               "   1  correct by student in 1 try\n".                "   1  correct by student in 1 try\n".
Line 516  sub CreateLegend { Line 1049  sub CreateLegend {
     return $Str;      return $Str;
 }  }
   
 =pod  #######################################################
   #######################################################
 =item &CreateColumnSelectionBox()  
   
 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  
   
   
 $CacheData: A pointer to a hash tied to the cached data  
   
 $headings:  An array of the names of the columns for the student information.  
 They are used for displaying which columns are missing.  
   
 Output: $notThere  
   
 $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  
   
 =cut  
   
 sub CreateColumnSelectionBox {  
     my ($doNotShow)=@_;  
   
     my $notThere = '';  
     $notThere .= '<select name="ReselectColumns" size="4" ';  
     $notThere .= 'multiple="true">'."\n";  
   
     for(my $index=0; $index<$doNotShow->{'count'}; $index++) {  
         my $name = $doNotShow->{$index.':name'};  
         $notThere .= '<option value="';  
         $notThere .= $doNotShow->{$index.':id'}.'">';  
         $notThere .= $name.'</option>'."\n";  
     }  
   
     $notThere .= '</select>';  
   
     return $notThere;  
 }  
   
 =pod  
   
 =item &CreateColumnSelectors()  
   
 This function generates the checkboxes above the column headings.  The  
 column will be removed if the checkbox is unchecked.  
   
 =over 4  =pod 
   
 Input: $CacheData, $headings  
   
 $CacheData: A pointer to a hash tied to the cached data  
   
 $headings:  An array of the names of the columns for the student   
 information.  They are used to know what are the student information columns  
   
 Output: $present  
   
 $present: The string contains the first row of a table.  Each column contains  
 a checkbox which is left justified.  Currently left justification is used  
 for consistency of location over the column in which it presides.  
   
 =back  =back
   
 =cut  =cut
   
 sub CreateColumnSelectors {  #######################################################
     my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;  #######################################################
   
     my $present = '';  
     for(my $index=0; $index<(scalar @$infoHeadings); $index++) {  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="HeadingColumn'.$infoHeadings->[$index].'" />';  
         $present .= '</td>'."\n";  
     }  
   
     for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) {  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="SequenceColumn'.$sequenceKeys->[$index].'" />';  
         $present .= '</td>'."\n";  
     }  
   
     return $present;  
 }  
   
 #---- END Student Assessment Web Page ----------------------------------------  
   
 #---- Student Assessment Worker Functions ------------------------------------  
   
 sub FindSelectedStudent {  
     my($cache, $selectedName, $students)=@_;  
   
     if($selectedName eq 'All Students' ||  
        $selectedName eq 'No Student Selected') {  
         return $selectedName;  
     }  
   
     for(my $index=0; $index<(scalar @$students); $index++) {  
         my $fullname = $cache->{$students->[$index].':fullname'};  
         if($fullname eq $selectedName) {  
             if($cache->{'StudentAssessmentMove'} eq 'next') {  
                 if($index == ((scalar @$students) - 1)) {  
                     $selectedName = $students->[0];  
                     return $selectedName;  
                 } else {  
                     $selectedName = $students->[$index+1];  
                     return $selectedName;  
                 }  
             } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {  
                 if($index == 0) {  
                     $selectedName = $students->[-1];  
                     return $selectedName;  
                 } else {  
                     $selectedName = $students->[$index-1];  
                     return $selectedName;  
                 }  
             } else {  
                 $selectedName = $students->[$index];  
                 return $selectedName;  
             }  
             last;  
         }  
     }  
   
     return 'No Student Selected';  
 }  
   
 =pod  
   
 =item &ShouldShowColumn()  
   
 Determine if a specified column should be shown on the chart.  
   
 =over 4  
   
 Input: $cache, $test  
   
 $cache: A pointer to the hash tied to the cached data  
   
 $test: The form name of the column (heading.$headingIndex) or   
 (sequence.$sequenceIndex)  
   
 Output: 0 (false), 1 (true)  
   
 =back  
   
 =cut  
   
 sub ShouldShowColumns {  
     my ($cache,$headings,$cacheKey)=@_;  
   
     my @infoKeys=();  
     my @infoHeadings=();  
   
     my @sequenceKeys=();  
     my @sequenceHeadings=();  
   
     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++;  
         }  
     }  
   
     $doNotShow{'count'} = $count;  
   
     return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,  
             \@sequenceKeys, \%doNotShow);  
 }  
   
 #---- END Student Assessment Worker Functions --------------------------------  
   
 1;  1;
   
 __END__  __END__

Removed from v.1.27  
changed lines
  Added in v.1.36


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