Diff for /loncom/interface/statistics/lonstudentassessment.pm between versions 1.28 and 1.50

version 1.28, 2003/02/21 18:41:56 version 1.50, 2003/05/29 21:41:10
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # (Publication Handler  
 #  #
 # $Id$  # $Id$
 #  #
Line 55  use Apache::lonstatistics; Line 54  use Apache::lonstatistics;
 use Apache::lonhtmlcommon;  use Apache::lonhtmlcommon;
 use Apache::loncoursedata;  use Apache::loncoursedata;
 use Apache::lonnet; # for logging porpoises  use Apache::lonnet; # for logging porpoises
 use GDBM_File;  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  =pod
   
 =item &BuildStudentAssessmentPage()  =item $show_links 'yes' or 'no' for linking to student performance data
   
 Inputs:   =item $output_mode 'html', 'excel', or 'csv' for output mode
   
 =over 4  =item $show 'all', 'totals', or 'scores' determines how much data is output
   
   =item $single_student_mode evaluates to true if we are showing only one
   student.
   
   =cut
   
 =item $cacheDB The name of the cache file used to store student data  #######################################################
   #######################################################
   my $show_links;
   my $output_mode;
   my $show;
   my $single_student_mode;
   
   #######################################################
   #######################################################
   # End of package variable declarations
   
 =item $students Array ref containing the name(s) of the students   =pod
 selected for display  
   =back
   
   =cut
   
 =item $courseID The ID of the course  #######################################################
   #######################################################
   
 =item $formName The name of the html form - 'Statistics'  =pod
   
 =item $headings Array ref of headings to show  =item &BuildStudentAssessmentPage()
   
 =item $spacing A string of spaces  Inputs: 
   
 =item $studentInformation Array ref of possible headings for student info  =over 4
 ('fullname','section',...)  
   
 =item $r Apache Request  =item $r Apache Request
   
Line 95  selected for display Line 129  selected for display
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub BuildStudentAssessmentPage {  sub BuildStudentAssessmentPage {
     my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,      my ($r,$c)=@_;
         $studentInformation,$r,$c)=@_;      undef($Statistics);
     my %cache;      $single_student_mode = 1 if ($ENV{'form.SelectedStudent'});
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {      #
         $r->print('<html><body>Unable to tie database.</body></html>');      # Print out the HTML headers for the interface
       #    This also parses the output mode selector
       #    This step must always be done.
       $r->print(&CreateInterface());
       $r->print('<input type="hidden" name="notfirstrun" value="true" />');
       $r->print('<input type="hidden" name="sort" value="'.
                 $ENV{'form.sort'}.'" />');
       $r->rflush();
       if (! exists($ENV{'form.notfirstrun'}) && ! $single_student_mode) {
           $r->print(<<ENDMSG);
   <p>
   <font size="+2">
   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);      #
       # Determine which students we want to look at
       my @Students;
       if ($single_student_mode) {
           @Students = (&Apache::lonstatistics::current_student());
           $r->print(&next_and_previous_buttons());
           $r->rflush();
       } else {
           @Students = @Apache::lonstatistics::Students;
       }
       #
       # Call the initialize routine selected above
       $initialize->($r);
       foreach my $student (@Students) {
           if($c->aborted()) { 
               $finish->($r);
               return ; 
         }          }
           # Call the output_student routine selected above
           $output_student->($r,$student);
     }      }
     my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,      # 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();  
   
   #######################################################
   #######################################################
   sub next_and_previous_buttons {
     my $Str = '';      my $Str = '';
     if($selectedName eq 'No Student Selected') {      $Str .= '<input type="hidden" name="SelectedStudent" value="'.
  $Str .= '<h3><font color=blue>WARNING: ';          $ENV{'form.SelectedStudent'}.'" />';
         $Str .= 'Please select a student</font></h3>';      #
         $r->print($Str);      # Build the previous student link
         return;      my $previous = &Apache::lonstatistics::previous_student();
       my $previousbutton = '';
       if (defined($previous)) {
           my $sname = $previous->{'username'}.':'.$previous->{'domain'};
           $previousbutton .= '<input type="button" value="'.
               'Previous Student ('.
               $previous->{'username'}.'@'.$previous->{'domain'}.')'.
               '" onclick="document.Statistics.SelectedStudent.value='.
               "'".$sname."'".';'.
               'document.Statistics.submit();" />';
       } else {
           $previousbutton .= '<input type="button" value="'.
               'Previous student (none)'.'" />';
       }
       #
       # Build the next student link
       my $next = &Apache::lonstatistics::next_student();
       my $nextbutton = '';
       if (defined($next)) {
           my $sname = $next->{'username'}.':'.$next->{'domain'};
           $nextbutton .= '<input type="button" value="'.
               'Next Student ('.
               $next->{'username'}.'@'.$next->{'domain'}.')'.
               '" onclick="document.Statistics.SelectedStudent.value='.
               "'".$sname."'".';'.
               'document.Statistics.submit();" />';
       } else {
           $nextbutton .= '<input type="button" value="'.
               'Next student (none)'.'" />';
     }      }
       #
       # Build the 'all students' button
       my $all = '';
       $all .= '<input type="button" value="All Students" '.
               '" onclick="document.Statistics.SelectedStudent.value='.
               "''".';'.'document.Statistics.submit();" />';
       $Str .= $previousbutton.('&nbsp;'x5).$all.('&nbsp;'x5).$nextbutton;
       return $Str;
   }
   
     $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings,  #######################################################
                                    $sequenceKeys, $sequenceHeadings));  #######################################################
     untie(%cache);  
     if($c->aborted()) {  return $Str; }  
   
     my $selected=0;  
     my $Count = 0;  
     $r->print('<pre>'."\n");  
     foreach (@$students) {  
         if($c->aborted()) { return $Str; }  
         next if ($_ ne $selectedName &&  
                  $selectedName ne 'All Students');  
         $selected = 1;  
   
         my @who = ($_);  
         next if(&Apache::loncoursedata::DownloadStudentCourseData(\@who, 'true',  
                                                              $cacheDB, 'true',  
                                                              'false', $courseID,  
                                                              $r, $c) ne 'OK');  
         next if($c->aborted());  
   
         if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
             my @before=();  
             my @after=();  
             my @updateColumn=();  
             my $foundUpdate = 0;  
             foreach(@$infoKeys) {  
                 if(/updateTime/) {  
                     $foundUpdate=1;  
                     push(@updateColumn, $_);  
                     next;  
                 }  
                 if($foundUpdate) {  
                     push(@after, $_);  
                 } else {  
                     push(@before, $_);  
                 }  
             }  
             $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_student_fields_to_show {
             $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(      my @to_show = @Apache::lonstatistics::SelectedStudentData;
                                                          \%cache, $_,      foreach (@to_show) {
                                                          \@after,          if ($_ eq 'all') {
                                                          $displayString,              @to_show = @Apache::lonstatistics::StudentDataOrder;
                                                          'preformatted'));              last;
             $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));          }
             $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 @to_show;
 }  }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
   
Line 246  sub BuildStudentAssessmentPage { Line 273  sub BuildStudentAssessmentPage {
 Called by &BuildStudentAssessmentPage to create the top part of the  Called by &BuildStudentAssessmentPage to create the top part of the
 page which displays the chart.  page which displays the chart.
   
 Inputs:  Inputs: None
   
 =over 4  
   
 =item $cache The ubiquitous cache  
   
 =item $selectedName The name of the currently selected student, or  
 'All Students' or 'No Student Selected'.  
   
 =item $students Array ref containing the name(s) of the students selected  
 for display.  
   
 =item $formName The name of the HTML form to use, 'Statistics'  
   
 =item $doNotShow Array ref containing the names of columns to not show  
   
 =back  
   
 Returns:  A string containing the HTML for the headers and top table for   Returns:  A string containing the HTML for the headers and top table for 
 the chart page.  the chart page.
Line 272  the chart page. Line 283  the chart page.
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateInterface {  sub CreateInterface {
     my($cache,$selectedName,$students,$formName,$doNotShow)=@_;  
   
     my $Str = '';      my $Str = '';
     $Str .= &CreateLegend();  #    $Str .= &CreateLegend();
     $Str .= '<table><tr><td>'."\n";      $Str .= '<table cellspacing="5">'."\n";
     $Str .= '<input type="submit" name="PreviousStudent" ';      $Str .= '<tr>';
     $Str .= 'value="Previous Student" />'."\n";      $Str .= '<td align="center"><b>Sections</b></td>';
     $Str .= '&nbsp&nbsp&nbsp'."\n";      $Str .= '<td align="center"><b>Student Data</b></td>';
     $Str .= &Apache::lonhtmlcommon::StudentOptions($cache, $students,      $Str .= '<td align="center"><b>Enrollment Status</b></td>';
                                                    $selectedName,      $Str .= '<td align="center"><b>Sequences and Folders</b></td>';
                                                    'StudentAssessment',      $Str .= '<td align="center"><b>Output Format</b></td>';
                                                    $formName);      $Str .= '</tr>'."\n";
     $Str .= "\n".'&nbsp&nbsp&nbsp'."\n";      #
     $Str .= '<input type="submit" name="NextStudent" ';  
     $Str .= 'value="Next Student" />'."\n";  
     $Str .= '</td></tr></table>'."\n";  
     $Str .= '<table cellspacing="5"><tr>'."\n";  
     $Str .= '<td align="center"><b>Select Sections</b>'."\n";  
     $Str .= '</td>'."\n";  
     $Str .= '<td align="center"><b>Select column to view:</b></td>'."\n";  
     $Str .= '<td></td></tr>'."\n";  
   
     $Str .= '<tr><td align="center">'."\n";      $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::lonhtmlcommon::StatusOptions(undef,undef,5);
     $Str .= 'value="Default Column Display" />'."\n";  
     $Str .= '</td><td>'."\n";      $Str .= '</td><td>'."\n";
     $Str .= '<input type="submit" name="displaymode" ';      $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
     if (! exists($ENV{'form.displaymode'}) ||                                                $only_seq_with_assessments);
         lc($ENV{'form.displaymode'}) eq 'display with links') {      $Str .= '</td><td>'."\n";
         $Str .= 'value="Display without links" />';      $Str .= &CreateAndParseOutputSelector();
         # Set the current value, in case it is undefined      $Str .= '</td></tr>'."\n";
         $ENV{'form.displaymode'} = 'Display with links';      $Str .= '</table>'."\n";
     } else {  
         $Str .= 'value="Display with links" />';  
     }  
     $Str .= "\n";  
     $Str .= '</td></tr></table>'."\n";  
   
     return $Str;      return $Str;
 }  }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
   
 =pod  =pod
   
 =item &CreateTableHeadings()  =item &CreateAndParseOutputSelector()
   
 Create HTML for the columns of student data to show.  
 Called by &BuildStudentAssessmentPage().  Calls  
 &Apache::lonhtmlcommon::CreateHeadings().  
   
 Inputs:  
   
 =over 4  
   
 =item $cache The ubiquitous cache  
   
 =item $spacing A string of spaces  
   
 =item $infoKeys Array ref to names of keys to display from the cache   
 which describe students  
   
 =item $infoHeadings Array ref to headings of columns for student info  
   
 =item $sequenceKeys Array ref of names of keys to use to retrieve sequence  
 data from the cache  
   
 =item $sequenceHeadings Array ref of names of sequences used for output.  
   
 =back  
   
 Returns: A string containing the HTML of the table headings.  
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateTableHeadings {  my @OutputOptions = 
     my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,      ({ name  => 'HTML, with links',
        $sequenceHeadings)=@_;         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, with all links',
          value => 'html, with all links',
          description => 'Output HTML with each symbol linked to the problem '.
      'which generated it.  '.
              'This includes links for unattempted problems.',
          mode => 'html',
          show => 'all',
          show_links => 'all',
          },
        { name  => 'HTML, without links',
          value => 'html, without links',
          description => 'Output HTML.  By not including links, the size of the'.
      ' web page is greatly reduced.  If your browser crashes on the '.
      'full display, try this.',
          mode => 'html',
          show => '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 for each student.',
          mode => 'html',
          show => 'totals',
          show_links => 'no',
          },
        { name  => 'HTML, summary table only',
          value => 'html summary table only',
          description => 'Output HTML, but only the final summary table for '.
              'all students across all sequences.',
          mode => 'html',
          show => 'final table',
          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',
              },
        );
   
 #    my $Str = '&nbsp&nbsp&nbsp&nbsp&nbsp';  sub OutputDescriptions {
     my $Str = '';      my $Str = '';
     $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n";      $Str .= "<h2>Output Modes</h2>\n";
     $Str .= '<tr>'."\n";      $Str .= "<dl>\n";
     $Str .= '<td><pre>     </pre></td>'."\n";      foreach my $outputmode (@OutputOptions) {
     $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings,   $Str .="    <dt>".$outputmode->{'name'}."</dt>\n";
                                    $sequenceKeys);   $Str .="        <dd>".$outputmode->{'description'}."</dd>\n";
     $Str .= '<td></td></tr>'."\n";      }
       $Str .= "</dl>\n";
     $Str .= '<tr>'."\n";      return $Str;
     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>';  
     $Str .= '</tr></table>'."\n";  
   
   sub CreateAndParseOutputSelector {
       my $Str = '';
       my $elementname = 'chartoutputmode';
       #
       # Format for output options is 'mode, restrictions';
       my $selected = 'html, without links';
       if (exists($ENV{'form.'.$elementname})) {
           if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
               $selected = $ENV{'form.'.$elementname}->[0];
           } else {
               $selected = $ENV{'form.'.$elementname};
           }
       }
       #
       # Set package variables describing output mode
       $show_links  = 'no';
       $output_mode = 'html';
       $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;      return $Str;
 }  }
   
Line 401  sub CreateTableHeadings { Line 498  sub CreateTableHeadings {
   
 =pod  =pod
   
 =item &StudentReport()  =head2 HTML output routines
   
 This is the workhorse subroutine - it handles formatting and display of a  =item &html_initialize($r)
 students performance data.  It processes one row of the chart.  
   
 Input:   Create labels for the columns of student data to show.
   
 =over 4  =item &html_outputstudent($r,$student)
   
 =item $cache The ubiquitous cache  
   
 =item $name The name and domain of the current student in name:domain format  
   
 =item $spacing A string containing spaces.  Return a line of the chart for a student.
   
 =item $showSequences Array ref containing the sequences to display  =item &html_finish($r)
   
 =back  
   
 Output: $Str  
   
 $Str: Formatted string that is an entire row of the chart.  It is a  
 concatenation of student information and student course information.  
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub StudentReport {  {
     my ($cache,$name,$spacing,$showSequences)=@_;      my $padding;
     my ($username,$domain)=split(':',$name);      my $count;
   
       my $nodata_count; # The number of students for which there is no data
       my %prog_state;   # progress state used by loncommon PrgWin routines
   
   sub html_initialize {
       my ($r) = @_;
       #
       $padding = ' 'x3;
       $count = 0;
       $nodata_count = 0;
       #
       $r->print("<h3>".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}.
                 "&nbsp;&nbsp;".localtime(time)."</h3>");
   
       #
       # Set up progress window for 'final table' display only
       if ($show eq 'final table') {
           my $studentcount = scalar(@Apache::lonstatistics::Students); 
           %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
               ($r,'Summary Table Status',
                'Summary Table Compilation Progress', $studentcount);
       }
       my $Str = "<pre>\n";
       # First, the @StudentData fields need to be listed
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
           my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
           my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       # Now the selected sequences need to be listed
       foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){
           my $title = $sequence->{'title'};
           my $base  = $sequence->{'base_width'};
           my $width = $sequence->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       $Str .= "total (of shown problems)</pre>\n";
       $Str .= "<pre>";
       #
       # Check for suppression of output
       if ($show eq 'final table') {
           $Str = '';
       }
       $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 (scalar(@tmp) < 1) {
           $nodata_count++;
           return if ($show eq 'final table');
           $Str .= '<font color="blue">No Course Data</font>'."\n";
           $r->print($Str);
           $r->rflush();
           return;
     }      }
     if($cache->{$name.':error'} =~ /course/) {      #
         $Str .= '<b><font color="blue">No course data for student </font>';      # By sequence build up the data
         $Str .= '<font color="red">'.$username.'.</font></b><br>';      my $studentstats;
         return $Str;      my $PerformanceStr = '';
     }      foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           my ($performance,$score,$seq_max) =
     my $hasVersion = 'false';              &StudentPerformanceOnSequence($student,\%StudentsData,
     my $hasFinalData = 'false';                                            $seq,$show_links);
     foreach my $sequence (@$showSequences) {          my $ratio = $score.'/'.$seq_max;
         my $hasData = 'false';          #
         my $characterCount=0;          if ($show eq 'totals') {
         foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {              $performance = ' 'x(length($seq_max)-length($score)).$ratio;
             my $problem = $cache->{$problemID.':problem'};              $performance .= ' 'x($seq->{'width'}-length($performance));
             # All grades (except for versionless parts) are displayed as links          } elsif ($show eq 'scores') {
             # to their submission record.  Loop through all the parts for the              $performance = $score;
             # current problem in the correct order and prepare the output links              $performance .= ' 'x($seq->{'width'}-length($performance));
             foreach(split(/\:/,$cache->{$sequence.':'.$problemID.  
                                         ':parts'})) {  
                 if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||  
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||  
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {  
                     $Str .= ' ';  
                     $characterCount++;  
                     next;  
                 }  
                 $hasVersion = 'true';  
                 $hasData = 'true';  
                 if (lc($ENV{'form.displaymode'}) ne 'display without links') {  
                     $Str .= '<a href="/adm/grades?symb=';  
                     $Str .= &Apache::lonnet::escape($problem);  
                     $Str .= '&student='.$username.'&domain='.$domain;  
                     $Str .= '&command=submission">';  
                 }  
                 my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};  
                 my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};  
                 if($code eq '*' && $tries < 10 && $tries ne '') {  
                     $code = $tries;  
                 }  
                 $Str .= $code;  
                 if (lc($ENV{'form.displaymode'}) ne 'display without links') {  
                     $Str .= '</a>';  
                 }  
                 $characterCount++;  
             }  
         }  
   
         # Output the number of correct answers for the current sequence.  
         # This part takes up 6 character slots, but is formated right  
         # justified.  
         my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;  
         $spacesNeeded -= 3;  
         $Str .= (' 'x$spacesNeeded);  
   
 #        my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence.  
 #    ':problemsCorrect'});  
   
  my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence.  
                                             ':problemsCorrect'},  
                                             $characterCount);  
         if($hasData eq 'true') {  
             $Str .= '<font color="#007700">'.$outputProblemsCorrect.'</font>';  
             $hasFinalData = 'true';  
         } else {          } else {
             $Str .= '<font color="#007700">     </font>';              # Pad with extra spaces
               $performance .= ' 'x($seq->{'width'}-$seq_max-
                                    length($ratio)
                                    ).$ratio;
         }          }
         $Str .= $spacing;          #
     }          $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";
       #
       # Check for suppressed output and update the progress window if so...
       if ($show eq 'final table') {
           $Str = '';
           &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
                                                    'last student');
       }
       #
       $r->print($Str);
       #
       $r->rflush();
       return;
   }    
   
     # Output the total correct problems over the total number of problems.  sub html_finish {
     # I don't like this type of formatting, but it is a solution.  Need      my ($r) = @_;
     # a way to dynamically determine the space requirements.      #
     my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'});      # Check for suppressed output and close the progress window if so
     my $outputTotalProblems  = sprintf("%4d", $cache->{$name.':totalProblems'});      if ($show eq 'final table') {
     if($hasFinalData eq 'true') {          &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
         $Str .= '<font color="#000088">'.$outputProblemsSolved.  
     ' / '.$outputTotalProblems.'</font>';  
     } else {      } else {
         $Str .= '<font color="#000088">           </font>';          $r->print("</pre>\n"); 
     }      }
       if ($single_student_mode) {
     if($hasVersion eq 'false') {          $r->print(&SingleStudentTotal());
         $Str = '<b><font color="blue">No course data.</font></b>';      } else {
           $r->print(&StudentAverageTotal());
     }      }
       $r->rflush();
     return $Str;      return;
 }  }
   
 #######################################################  
 #######################################################  
   
 #######################################################  
 #######################################################  
 sub StudentAverageTotal {  sub StudentAverageTotal {
     my ($cache, $students, $sequenceKeys)=@_;      my $Str = "<h3>Summary Tables</h3>\n";
     my $Str = "\n<b>Summary Tables:</b>\n";      my $num_students = scalar(@Apache::lonstatistics::Students);
     my %Correct = ();      my $total_ave = 0;
     my $ProblemsSolved = 0;      my $total_max = 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;  
     }  
   
     $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 .= '<table border=2 cellspacing="1">'."\n";
     $Str .= '<tr><th>Title</th><th>Total Problems</th>'.      $Str .= "<tr><th>Title</th><th>Average</th><th>Maximum</th></tr>\n";
             '<th>Average Correct</th></tr>'."\n";      foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
     foreach my $S(@$sequenceKeys) {          my $ave;
         my $title=$cache->{$S.':title'};          if ($num_students > $nodata_count) {
  #$Str .= $cache->{$S.':problems'};              $ave = int(100*($Statistics->{$seq->{'symb'}}->{'score'}/
  #my @problems=split(':', $cache->{$S.':problems'});                              ($num_students-$nodata_count)))/100;
  #my $pCount=scalar @problems;  
  my $pCount=MaxSeqPr($cache,@$students[0],$S);  
         my $crr;  
  if ($StudentCount) {  
             $crr=sprintf( "%.2f", $Correct{$S}/$StudentCount );  
         } else {          } else {
             $crr="0.00";              $ave = 0;
         }          }
         $Str .= '<tr><td>'.$title.          $total_ave += $ave;
                 '</td><td align=center>'.$pCount.          my $max = $seq->{'num_assess_parts'};
                 '</td><td align=center>'.$crr.          $total_max += $max;
                 '</td></tr>'."\n";          if ($ave == 0) {
               $ave = "0.00";
           }
           $ave .= '&nbsp;';
           $max .= '&nbsp;&nbsp;&nbsp;';
           $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
               '<td align="right">'.$ave.'</td>'.
                   '<td align="right">'.$max.'</td></tr>'."\n";
     }      }
       $total_ave = int(100*$total_ave)/100; # only two digit
     $Str .= '</table>'."\n";      $Str .= "</table>\n";
       $Str .= '<table border=2 cellspacing="1">'."\n";
       $Str .= '<tr><th>Number of Students</th><th>Average</th>'.
           "<th>Maximum</th></tr>\n";
       $Str .= '<tr><td>'.($num_students-$nodata_count).'</td>'.
           '<td>'.$total_ave.'</td><td>'.$total_max.'</td>';
       $Str .= "</table>\n";
     return $Str;      return $Str;
 }  }
   
 #######################################################  sub SingleStudentTotal {
 #######################################################      my $student = &Apache::lonstatistics::current_student();
       my $Str = "<h3>Summary Table For ".$student->{'username'}.'@'.
           $student->{'domain'}."</h3>\n";
       $Str .= '<table border=2 cellspacing="1">'."\n";
       $Str .= 
           "<tr><th>Sequence or Folder</th><th>Score</th><th>Maximum</th></tr>\n";
       my $total = 0;
       my $total_max = 0;
       foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           my $value = $Statistics->{$seq->{'symb'}}->{'score'};
           my $max = $Statistics->{$seq->{'symb'}}->{'max'};
           $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
               '<td align="right">'.$value.'</td>'.
                   '<td align="right">'.$max.'</td></tr>'."\n";
           $total += $value;
           $total_max +=$max;
       }
       $Str .= '<tr><td><b>Total</b></td>'.
           '<td align="right">'.$total.'</td>'.
           '<td align="right">'.$total_max."</td></tr>\n";
       $Str .= "</table>\n";
       return $Str;
   }
   
 #######################################################  
 #######################################################  
 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;  
 }  }
   
 #######################################################  #######################################################
Line 618  sub MaxSeqPr { Line 739  sub MaxSeqPr {
   
 =pod  =pod
   
 =item &CreateLegend()  =head2 Multi-Sheet EXCEL subroutines
   
 This function returns a formatted string containing the legend for the  =item &multi_sheet_excel_initialize($r)
 chart.  The legend describes the symbols used to represent grades for  
 problems.  =item &multi_sheet_excel_outputstudent($r,$student)
   
   =item &multi_sheet_excel_finish($r)
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateLegend {  {
     my $Str = "<p><pre>".  
               "   1  correct by student in 1 try\n".  sub multi_sheet_excel_initialize {
               "   7  correct by student in 7 tries\n".      my ($r)=@_;
               "   *  correct by student in more than 9 tries\n".      $r->print("<h1>Not yet implemented</h1>");
       "   +  correct by hand grading or override\n".      # 
               "   -  incorrect by override\n".      # Estimate the size of the file.  We would like to have < 5 megs of data.
       "   .  incorrect attempted\n".      my $max_size = 5000000;
       "   #  ungraded attempted\n".      my $num_students  = scalar(@Apache::lonstatistics::Students);
               "      not attempted (blank field)\n".      my $num_sequences = 0;
       "   x  excused".      my $num_data_per_part  = 2; # 'status' and 'numtries'
               "</pre><p>";      my $fields_per_student = scalar(&get_student_fields_to_show());
     return $Str;      my $bytes_per_field    = 20; # Back of the envelope calculation
       foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           $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 {
               # @Apache::lonstatistics::Sections contains 'all' as well.
               $num_workbooks = scalar(@Apache::lonstatistics::Sections) - 1;
           }
       }
       
       $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  =pod
   
 =item &CreateColumnSelectionBox()  =head2 EXCEL subroutines
   
 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.  =item &excel_initialize($r)
 They are used for displaying which columns are missing.  
   
 Output: $notThere  =item &excel_outputstudent($r,$student)
   
 $notThere: The string contains one row of a table.  The first column has the  =item &excel_finish($r)
 name of the selection box.  The second contains the selection box  
 which has a size of four.  
   
 =back  
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateColumnSelectionBox {  {
     my ($doNotShow)=@_;  
   
     my $notThere = '';  my $excel_sheet;
     $notThere .= '<select name="ReselectColumns" size="4" ';  my $excel_workbook;
     $notThere .= 'multiple="true">'."\n";  
   
     for(my $index=0; $index<$doNotShow->{'count'}; $index++) {  my $filename;
         my $name = $doNotShow->{$index.':name'};  my $rows_output;
         $notThere .= '<option value="';  my $cols_output;
         $notThere .= $doNotShow->{$index.':id'}.'">';  
         $notThere .= $name.'</option>'."\n";  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 (&Apache::lonstatistics::Sequences_with_Assess()) {
           $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 {
           $rows_output += 1;
       }
       #
       # Output a row for MAX
       if ($show ne 'totals') {
           $cols_output = 0;
           foreach my $field (&get_student_fields_to_show()) {
               if ($field eq 'username' || $field eq 'fullname' || 
                   $field eq 'id') {
                   $excel_sheet->write($rows_output,$cols_output++,'Maximum');
               } else {
                   $excel_sheet->write($rows_output,$cols_output++,'');
               }
           }
           #
           # Add the Sequence Headers
           foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
               $excel_sheet->write($rows_output,$cols_output++,
                                   $seq->{'num_assess_parts'});
           }
           $rows_output++;
       }
       #
       # Let the user know what we are doing
       my $studentcount = scalar(@Apache::lonstatistics::Students); 
       $r->print("<h1>Compiling Excel spreadsheet for ".
                 $studentcount.' student');
       $r->print('s') if ($studentcount > 1);
       $r->print("</h1>\n");
       $r->rflush();
       #
       # Initialize progress window
       %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
           ($r,'Excel File Compilation Status',
            'Excel File Compilation Progress', $studentcount);
       #
       return;
   }
   
     $notThere .= '</select>';  sub excel_outputstudent {
       my ($r,$student) = @_;
       return if (! defined($excel_sheet));
       $cols_output=0;
       #
       # Write out student data
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
       }
       #
       # Get student assessment data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
                                                           $student->{'domain'},
                                                           undef,
                                                      $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
       }
       #
       # Write out sequence scores and totals data
       foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           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;
   }
   
     return $notThere;  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  =pod
   
 =item &CreateColumnSelectors()  =head2 CSV output routines
   
 This function generates the checkboxes above the column headings.  The  
 column will be removed if the checkbox is unchecked.  
   
 =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 to know what are the student information columns  
   
 Output: $present  =item &csv_initialize($r)
   
 $present: The string contains the first row of a table.  Each column contains  =item &csv_outputstudent($r,$student)
 a checkbox which is left justified.  Currently left justification is used  
 for consistency of location over the column in which it presides.  
   
 =back  =item &csv_finish($r)
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateColumnSelectors {  {
     my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;  
   my $outputfile;
   my $filename;
   
   my %prog_state; # progress window state
   
     my $present = '';  sub csv_initialize{
     for(my $index=0; $index<(scalar @$infoHeadings); $index++) {      my ($r) = @_;
         $present .= '<td align="left">';      # 
         $present .= '<input type="checkbox" checked="on" ';      # Clean up
         $present .= 'name="HeadingColumn'.$infoHeadings->[$index].'" />';      $filename = undef;
         $present .= '</td>'."\n";      $outputfile = undef;
       undef(%prog_state);
       #
       # Open a file
       $filename = '/prtspool/'.
           $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
               time.'_'.rand(1000000000).'.csv';
       unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) {
           $r->log_error("Couldn't open $filename for output $!");
           $r->print("Problems occured in writing the csv file.  ".
                     "This error has been logged.  ".
                     "Please alert your LON-CAPA administrator.");
           $outputfile = undef;
       }
       #
       # Datestamp
       my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'.
           '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'.
               "\n";
   
       #
       # Print out the headings
       my $Str = '';
       my $Str2 = undef;
       foreach my $field (&get_student_fields_to_show()) {
           if ($show eq 'scores') {
               $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
           } elsif ($show eq 'totals') {
               $Str .= '"",'; # first row empty on the student fields
               $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
           } elsif ($show eq 'all') {
               $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
           }
       }
       foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           if ($show eq 'scores') {
               $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
                   '",';
           } elsif ($show eq 'totals') {
               $Str  .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
                   '","",';
               $Str2 .= '"score","total possible",';
           } elsif ($show eq 'all') {
               $Str  .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
                   '",';
               $Str .= '"",'x($seq->{'num_assess_parts'}-1);
               $Str .= '"score","total possible",';
           }
     }      }
       chop($Str);
       $Str .= "\n";
       print $outputfile $Str;
       if (defined($Str2)) {
           chop($Str2);
           $Str2 .= "\n";
           print $outputfile $Str2;
       }
       #
       # Initialize progress window
       my $studentcount = scalar(@Apache::lonstatistics::Students);
       %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
           ($r,'CSV File Compilation Status',
            'CSV File Compilation Progress', $studentcount);
       return;
   }
   
     for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) {  sub csv_outputstudent {
         $present .= '<td align="left">';      my ($r,$student) = @_;
         $present .= '<input type="checkbox" checked="on" ';      return if (! defined($outputfile));
         $present .= 'name="SequenceColumn'.$sequenceKeys->[$index].'" />';      my $Str = '';
         $present .= '</td>'."\n";      #
       # Output student fields
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           $Str .= '"'.&Apache::loncommon::csv_translate($student->{$field}).'",';
       }
       #
       # Get student assessment data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
                                                           $student->{'domain'},
                                                           undef,
                                                      $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
       }
       #
       # Output performance data
       foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
           my ($performance,$score,$seq_max) =
               &StudentPerformanceOnSequence($student,\%StudentsData,
                                             $seq,'no');
           if ($show eq 'scores') {
               $Str .= '"'.$score.'",';
           } elsif ($show eq 'totals') {
               $Str  .= '"'.$score.'","'.$seq_max.'",';
           } elsif ($show eq 'all') {
               $Str .= '"'.join('","',(split(//,$performance),$score,$seq_max)).
                   '",';
           }
     }      }
       chop($Str);
       $Str .= "\n";
       print $outputfile $Str;
       #
       # Update the progress window
       &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
       return;
   }
   
   sub csv_finish {
       my ($r) = @_;
       return if (! defined($outputfile));
       close($outputfile);
       #
       my $c = $r->connection();
       return if ($c->aborted());
       #
       # Close the progress window
       &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
       #
       # Tell the user where to get their csv file
       $r->print('<br />'.
                 '<a href="'.$filename.'">Your csv file.</a>'."\n");
       $r->rflush();
       return;
       
   }
   
     return $present;  
 }  }
   
 #######################################################  #######################################################
Line 752  sub CreateColumnSelectors { Line 1194  sub CreateColumnSelectors {
   
 =pod  =pod
   
 =back  =item &StudentPerformanceOnSequence()
   
 =head1 HELPER FUNCTIONS  Inputs:
   
 =over 4  =over 4
   
 =cut   =item $student
   
 #######################################################  =item $studentdata Hash ref to all student data
 #######################################################  
 sub FindSelectedStudent {  
     my($cache, $selectedName, $students)=@_;  
   
     if($selectedName eq 'All Students' ||  =item $seq Hash ref, the sequence we are working on
        $selectedName eq 'No Student Selected') {  
         return $selectedName;  =item $links if defined we will output links to each resource.
     }  
   =back
   
   =cut
   
     for(my $index=0; $index<(scalar @$students); $index++) {  #######################################################
         my $fullname = $cache->{$students->[$index].':fullname'};  #######################################################
         if($fullname eq $selectedName) {  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++;
                   } elsif (exists($resource_data->{'resource.'.
                                                        $partnum.'.tries'})){
                       $symbol = '.';
                 } 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 ' ') ||
                    ($links eq 'all')) {
                   if (length($symbol) > 1) {
                       &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
                   }
                   $symbol = '<a href="/adm/grades'.
                       '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
                           '&student='.$student->{'username'}.
                               '&domain='.$student->{'domain'}.
                                   '&command=submission">'.$symbol.'</a>';
               }
               $value .= $symbol;
         }          }
           $Str .= $value;
     }      }
       return ($Str,$sum,$max);
     return 'No Student Selected';  
 }  }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
   
 =pod  =pod
   
 =item &ShouldShowColumn()  =item &CreateLegend()
   
 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)  
   
 =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 {  sub CreateLegend {
     my ($cache,$headings,$cacheKey)=@_;      my $Str = "<p><pre>".
                 "   1  correct by student in 1 try\n".
     my @infoKeys=();                "   7  correct by student in 7 tries\n".
     my @infoHeadings=();                "   *  correct by student in more than 9 tries\n".
         "   +  correct by hand grading or override\n".
     my @sequenceKeys=();                "   -  incorrect by override\n".
     my @sequenceHeadings=();        "   .  incorrect attempted\n".
         "   #  ungraded attempted\n".
     my %doNotShow;                "      not attempted (blank field)\n".
         "   x  excused".
     my $index;                "</pre><p>";
     my $count = 0;      return $Str;
     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);  
 }  }
 1;  
   
 #######################################################  #######################################################
 #######################################################  #######################################################
Line 881  sub ShouldShowColumns { Line 1327  sub ShouldShowColumns {
 #######################################################  #######################################################
 #######################################################  #######################################################
   
   1;
   
 __END__  __END__

Removed from v.1.28  
changed lines
  Added in v.1.50


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