[BACK]Return to lonstudentassessment.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface / statistics

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

version 1.6, 2002/08/01 20:49:06 version 1.33, 2003/03/04 14:21:36
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # (Publication Handler  
 #  #
 # $Id$  # $Id$
 #  #
 # Copyright Michigan State University Board of Trustees  # Copyright Michigan State University Board of Trustees
 #  #
 # This file is part of the LearningOnline Network with CAPA (LON-CAPA).  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #  
 # LON-CAPA is free software; you can redistribute it and/or modify  # LON-CAPA is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by  # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2 of the License, or  # the Free Software Foundation; either version 2 of the License, or
Line 26 Line 24
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # (Navigate problems for statistical reports  # (Navigate problems for statistical reports
 # YEAR=2001  
 # 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei  
 # 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei  
 # YEAR=2002  
 # 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei  
 # 5/12,5/14,5/15,5/19,5/26,7/16  Behrouz Minaei  
 #  #
 ###  #######################################################
   #######################################################
 package Apache::lonstudentassessment;   
   
 use strict;  =pod
 use Apache::lonhtmlcommon;  
 use Apache::loncoursedata;  
 use GDBM_File;  
   
 #my $jr;  =head1 NAME
   
 sub BuildStudentAssessmentPage {  lonstudentassessment
     my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,  
         $studentInformation,$r,$c)=@_;  
 #    $jr = $r;  
     my %cache;  
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
         $r->print('<html><body>Unable to tie database.</body></html>');  
         return;  
     }  
   
     # Remove students who don't have the proper section.  
     my @sectionsSelected = split(':',$cache{'sectionsSelected'});  
     for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;  
         $studentIndex--) {  
         my $value = $cache{$students->[$studentIndex].':section'};  
         my $found = 0;  
         foreach (@sectionsSelected) {  
             if($_ eq 'none') {  
                 if($value eq '' || !defined($value) || $value eq ' ') {  
                     $found = 1;  
                     last;  
                 }  
             } else {  
                 if($value eq $_) {  
                     $found = 1;  
                     last;  
                 }  
             }  
         }  
         if($found == 0) {  
             splice(@$students, $studentIndex, 1);  
         }  
     }  
     my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,  
         $doNotShow) =   
         &ShouldShowColumns(\%cache, $headings, $studentInformation);  
   
     my $selectedName = &FindSelectedStudent(\%cache,   
                                             $cache{'StudentAssessmentStudent'},  
                                             $students);  
     $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,  
                                $doNotShow));  
   
     my $Str = '';  =head1 SYNOPSIS
     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,  Presents assessment data about a student or a group of students.
                                    $sequenceKeys, $sequenceHeadings));  
     untie(%cache);  
     if($c->aborted()) {  return $Str; }  
   
     my $selected=0;  
     $r->print('<pre>'."\n");  
     foreach (@$students) {  
         if($c->aborted()) {  return $Str; }  
         next if ($_ ne $selectedName &&   
                  $selectedName ne 'All Students');  
         $selected = 1;  
         my $courseData;   
         my $downloadTime='';  
         if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
             $downloadTime = $cache{$_.':lastDownloadTime'};  
             untie(%cache);  
         }  
         if($downloadTime eq 'Not downloaded') {  
             $courseData =   
                 &Apache::loncoursedata::DownloadCourseInformation($_,   
                                                                   $courseID);  
             unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) {  
                 next;  
             }  
             &Apache::loncoursedata::ProcessStudentData(\%cache,   
                                                        $courseData, $_);  
             untie(%cache);  
         }  
   
         next if($c->aborted());  
   
         if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
             my $displayString = 'DISPLAYDATA'.$spacing;  
             $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(  
                                                          \%cache, $_,  
                                                          $infoKeys,  
                                                          $displayString,  
                                                          'preformatted'));  
             $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));  
             $r->print("\n");  
             untie(%cache);  
         }  
     }  
     $r->print('</pre>'."\n");  
     if($selected == 0) {  
  $Str .= '<h3><font color=blue>WARNING: ';  
         $Str .= 'Please select a student</font></h3>';  
         $r->print($Str);  
     }  
   
     return;  =head1 Subroutines
 }  
   
 #---- Student Assessment Web Page --------------------------------------------  =over 4 
   
 sub CreateInterface {  =cut
     my($cache,$selectedName,$students,$formName,$doNotShow)=@_;  
   
     my $Str = '';  #######################################################
     $Str .= &CreateLegend();  #######################################################
     $Str .= '<table><tr><td>'."\n";  
     $Str .= '<input type="submit" name="PreviousStudent" ';  
     $Str .= 'value="Previous Student" />'."\n";  
     $Str .= '&nbsp&nbsp&nbsp'."\n";  
     $Str .= &Apache::lonhtmlcommon::StudentOptions($cache, $students,   
                                                    $selectedName,   
                                                    'StudentAssessment',   
                                                    $formName);  
     $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";  package Apache::lonstudentassessment;
     my @sections = split(':',$cache->{'sectionList'});  
     my @selectedSections = split(':',$cache->{'sectionsSelected'});  
     $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections,  
                                                           \@selectedSections,  
                                                           'Statistics');  
     $Str .= '</td><td align="center">';  
     $Str .= &CreateColumnSelectionBox($doNotShow);  
     $Str .= '</td><td>'."\n";  
     $Str .= '<input type="submit" name="DefaultColumns" ';  
     $Str .= 'value="Default Column Display" />'."\n";  
     $Str .= '</td></tr></table>'."\n";  
   
     return $Str;  use strict;
 }  use Apache::lonstatistics;
   use Apache::lonhtmlcommon;
   use Apache::loncoursedata;
   use Apache::lonnet; # for logging porpoises
   use Spreadsheet::WriteExcel;
   
 sub CreateTableHeadings {  #######################################################
     my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,  #######################################################
        $sequenceHeadings)=@_;  =pod
   
     my $Str = '';  =item Package Variables
     $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n";  
   
     $Str .= '<tr>'."\n";  =over 4
     $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings,  
                                    $sequenceKeys);  
     $Str .= '<td></td></tr>'."\n";  
   
     $Str .= '<tr>'."\n";  
     my $displayString = '<td align="left"><pre><a href="/adm/statistics?';  
     $displayString .= 'sort=LINKDATA">DISPLAYDATA</a>FORMATTING';  
     $displayString .= $spacing.'</pre></td>'."\n";  
     $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,   
                                                    $infoKeys,  
                                                    $infoHeadings,  
                                                    $displayString,  
                                                    'preformatted');  
   
     $displayString  = '<td align="left"><pre>DISPLAYDATA'.$spacing;  
     $displayString .= '</pre></td>'."\n";  
     $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,  
                                                    $sequenceKeys,  
                                                    $sequenceHeadings,  
                                                    $displayString,  
                                                    'preformatted');  
   
     $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';  =item $Statistics Hash ref to store student data.  Indexed by symb,
     $Str .= '</tr></table>'."\n";        contains hashes with keys 'score' and 'max'.
   
     return $Str;  =cut
 }  
   
 =pod  #######################################################
   #######################################################
   
 =item &FormatStudentData()  my $Statistics;
   
 First, FormatStudentInformation is called and prefixes the course information.  #######################################################
 This function produces a formatted string of the student's course information.  #######################################################
 Each column of data represents all the problems for a given sequence.  For  
 valid grade data, a link is created for that problem to a submission record  
 for that problem.  
   
 =over 4  =pod
   
 Input: $name, $studentInformation, $ChartDB  =item $show_links 'yes' or 'no' for linking to student performance data
   
 $name: The name and domain of the current student in name:domain format  =item $output_mode 'html', 'excel', or 'csv' for output mode
   
 $studentInformation: A pointer to an array holding the names used to   =item $show 'all', 'totals', or 'scores' determines how much data is output
 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   =cut
 database.  
   
 Output: $Str  #######################################################
   #######################################################
   my $show_links;
   my $output_mode;
   my $show;
   
   #######################################################
   #######################################################
   # End of package variable declarations
   
 $Str: Formatted string that is an entire row of the chart.  It is a   =pod
 concatenation of student information and student course information.  
   
 =back  =back
   
 =cut  =cut
   
 sub StudentReport {  #######################################################
     my ($cache,$name,$spacing,$showSequences)=@_;  #######################################################
     my ($username,$domain)=split(':',$name);  
   
     my $Str = '';  =pod
     if($cache->{$name.':error'} =~ /course/) {  
         $Str .= '<b><font color="blue">No course data for student </font>';  
         $Str .= '<font color="red">'.$username.'.</font></b><br>';  
         return $Str;  
     }  
   
     my $Version;  
     my $problemsCorrect = 0;  
     my $totalProblems   = 0;  
     my $problemsSolved  = 0;  
     my $numberOfParts   = 0;  
 #    foreach my $sequence (split(':', $cache->{'orderedSequences'})) {  
     foreach my $sequence (@$showSequences) {  
         my $characterCount=0;  
         foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {  
             my $problem = $cache->{$problemID.':problem'};  
             my $LatestVersion = $cache->{$name.':version:'.$problem};  
   
             # Output dashes for all the parts of this problem if there  
             # is no version information about the current problem.  
             if(!$LatestVersion) {  
                 foreach my $part (split(/\:/,$cache->{$sequence.':'.  
                                                       $problemID.  
                                                       ':parts'})) {  
                     $Str .= ' ';  
                     $totalProblems++;  
                     $characterCount++;  
                 }  
                 next;  
             }  
   
             my %partData=undef;  =item &BuildStudentAssessmentPage()
             # Initialize part data, display skips correctly  
             # Skip refers to when a student made no submissions on that  
             # part/problem.  
             foreach my $part (split(/\:/,$cache->{$sequence.':'.  
                                                   $problemID.  
                                                   ':parts'})) {  
                 $partData{$part.':tries'}=0;  
                 $partData{$part.':code'}=' ';  
             }  
   
             # Looping through all the versions of each part, starting with the  Inputs: 
             # oldest version.  Basically, it gets the most recent   
             # set of grade data for each part.  
     for(my $Version=1; $Version<=$LatestVersion; $Version++) {  
                 foreach my $part (split(/\:/,$cache->{$sequence.':'.  
                                                       $problemID.  
                                                       ':parts'})) {  
   
                     if(!defined($cache->{$name.":$Version:$problem".  
                                                ":resource.$part.solved"})) {  
                         # No grade for this submission, so skip  
                         next;  
                     }  
   
                     my $tries=0;  =over 4
                     my $code=' ';  
   
                     $tries = $cache->{$name.':'.$Version.':'.$problem.  =item $r Apache Request
                                       ':resource.'.$part.'.tries'};  
                     $partData{$part.':tries'}=($tries) ? $tries : 0;  
   
                     my $val = $cache->{$name.':'.$Version.':'.$problem.  
                                        ':resource.'.$part.'.solved'};  
                     if    ($val eq 'correct_by_student')   {$code = '*';}   
                     elsif ($val eq 'correct_by_override')  {$code = '+';}  
                     elsif ($val eq 'incorrect_attempted')  {$code = '.';}   
                     elsif ($val eq 'incorrect_by_override'){$code = '-';}  
                     elsif ($val eq 'excused')              {$code = 'x';}  
                     elsif ($val eq 'ungraded_attempted')   {$code = '#';}  
                     else                                   {$code = ' ';}  
                     $partData{$part.':code'}=$code;  
                 }  
             }  
   
             # All grades (except for versionless parts) are displayed as links  =item $c Apache Connection 
             # to their submission record.  Loop through all the parts for the  
             # current problem in the correct order and prepare the output links  
             $Str .= '<a href="/adm/grades?symb=';  
             $Str .= &Apache::lonnet::escape($problem);  
             $Str .= '&student='.$username.'&domain='.$domain;  
             $Str .= '&command=submission">';   
             foreach(split(/\:/,$cache->{$sequence.':'.$problemID.  
                                         ':parts'})) {  
                 if($partData{$_.':code'} eq '*') {  
                     $problemsCorrect++;  
                     if (($partData{$_.':tries'}<10) &&  
                         ($partData{$_.':tries'} ne '')) {  
                         $partData{$_.':code'}=$partData{$_.':tries'};  
                     }  
                 } elsif($partData{$_.':code'} eq '+') {  
                     $problemsCorrect++;  
                 }  
   
                 $Str .= $partData{$_.':code'};  =back
                 $characterCount++;  
   
                 if($partData{$_.':code'} ne 'x') {  =cut
                     $totalProblems++;  
                 }  #######################################################
             }  #######################################################
             $Str.='</a>';  sub BuildStudentAssessmentPage {
       my ($r,$c)=@_;
       undef($Statistics);
       #
       # Print out the HTML headers for the interface
       #    This also parses the output mode selector
       #    This step must always be done.
       $r->print(&CreateInterface());
       $r->print('<input type="hidden" name="notfirstrun" value="true" />');
       $r->rflush();
       if (! exists($ENV{'form.notfirstrun'})) {
           $r->print(<<ENDMSG);
   <p>
   <font size="+1">
   Please make your selections in the boxes above and hit 
   the button marked &quot;Update&nbsp;Display&quot;.
   </font>
   </p>
   ENDMSG
   #        $r->print(&OutputDescriptions());
           return;
       }
       #
       #
       my $initialize     = \&html_initialize;
       my $output_student = \&html_outputstudent;
       my $finish         = \&html_finish;
       #
       if ($output_mode eq 'excel') {
           $initialize     = \&excel_initialize;
           $output_student = \&excel_outputstudent;
           $finish         = \&excel_finish;
       } elsif ($output_mode eq 'csv') {
           $initialize     = \&csv_initialize;
           $output_student = \&csv_outputstudent;
           $finish         = \&csv_finish;
       }
       #
       if($c->aborted()) {  return ; }
       #
       # Call the initialize routine selected above
       $initialize->($r);
       foreach my $student (@Apache::lonstatistics::Students) {
           if($c->aborted()) { 
               $finish->($r);
               return ; 
         }          }
           # Call the output_student routine selected above
           $output_student->($r,$student);
       }
       # Call the "finish" routine selected above
       $finish->($r);
       #
       return;
   }
   
         # 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", $problemsCorrect );  
  $Str .= '<font color="#007700">'.$outputProblemsCorrect.'</font>';  
  $problemsSolved += $problemsCorrect;  
  $problemsCorrect=0;  
   
         $Str .= $spacing;  
     }  
   
     # Output the total correct problems over the total number of problems.  
     # I don't like this type of formatting, but it is a solution.  Need  
     # a way to dynamically determine the space requirements.  
     my $outputProblemsSolved = sprintf( "%4d", $problemsSolved );  
     my $outputTotalProblems  = sprintf( "%4d", $totalProblems );  
     $Str .= '<font color="#000088">'.$outputProblemsSolved.  
     ' / '.$outputTotalProblems.'</font>';  
   
     return $Str;  sub get_student_fields_to_show {
       my @to_show = @Apache::lonstatistics::SelectedStudentData;
       foreach (@to_show) {
           if ($_ eq 'all') {
               @to_show = @Apache::lonstatistics::StudentDataOrder;
               last;
           }
       }
       return @to_show;
   }
   
   sub get_sequences_to_show {
       my @Sequences;
       foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) {
           foreach my $sequence (@Apache::lonstatistics::Sequences) {
               next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all');
               next if ($sequence->{'num_assess'} < 1);
               push (@Sequences,$sequence);
           }
       }
       return @Sequences;
 }  }
   
   
   #######################################################
   #######################################################
   
 =pod  =pod
   
 =item &CreateLegend()  =item &CreateInterface()
   
 This function returns a formatted string containing the legend for the  Called by &BuildStudentAssessmentPage to create the top part of the
 chart.  The legend describes the symbols used to represent grades for  page which displays the chart.
 problems.  
   Inputs: None
   
   Returns:  A string containing the HTML for the headers and top table for 
   the chart page.
   
 =cut  =cut
   
 sub CreateLegend {  #######################################################
     my $Str = "<p><pre>".  #######################################################
               "1..9: correct by student in 1..9 tries\n".  sub CreateInterface {
               "   *: correct by student in more than 9 tries\n".      my $Str = '';
       "   +: correct by override\n".  #    $Str .= &CreateLegend();
               "   -: incorrect by override\n".      $Str .= '<table cellspacing="5">'."\n";
       "   .: incorrect attempted\n".      $Str .= '<tr>';
       "   #: ungraded attempted\n".      $Str .= '<td align="center"><b>Sections</b></td>';
               "    : not attempted\n".      $Str .= '<td align="center"><b>Student Data</b></td>';
       "   x: excused".      $Str .= '<td align="center"><b>Sequences and Folders</b></td>';
               "</pre><p>";       $Str .= '<td align="center"><b>Output Format</b></td>';
       $Str .= '</tr>'."\n";
       #
       $Str .= '<tr><td align="center">'."\n";
       $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
       $Str .= '</td><td align="center">';
       my $only_seq_with_assessments = sub { 
           my $s=shift;
           if ($s->{'num_assess'} < 1) { 
               return 0;
           } else { 
               return 1;
           }
       };
       $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
                                                         5,undef);
       $Str .= '</td><td>'."\n";
       $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
                                                 $only_seq_with_assessments);
       $Str .= '</td><td>'."\n";
       $Str .= &CreateAndParseOutputSelector();
       $Str .= '</td></tr>'."\n";
       $Str .= '</table>'."\n";
     return $Str;      return $Str;
 }  }
   
   #######################################################
   #######################################################
   
 =pod  =pod
   
 =item &CreateColumnSelectionBox()  =item &CreateAndParseOutputSelector()
   
 If there are columns not being displayed then this selection box is created  =cut
 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  #######################################################
   my @OutputOptions = 
       ({ name  => 'HTML, with links',
          value => 'html, with links',
          description => 'Output HTML with each symbol linked to the problem '.
      'which generated it.'},
        { name  => 'HTML, without links',
          value => 'html, without links',
          description => 'Output HTML.  By not including links, the size of the'.
      ' web page is greatly reduced.  If your browser crashes on the '.
      'full display, try this.'},
        { name  => 'HTML, scores only',
          value => 'html, scores only',
          description => 'Output HTML, only showing the total number of correct'.
      ' problems (or problem parts) and not the maximum possible for '.
      'each student'},
        { name  => 'HTML, totals',
          value => 'html, totals',
          description => 'Output HTML, but only the summary statistics for each'.
      ' sequence selected.'},
        { name  => 'Excel, scores only',
          value => 'excel, scores only',
          description => 'Output an Excel file (compatable with Excel 95), '.
      'with a single column for each sequence showing the students '.
      'score.'},
   #     { name  => 'Excel, everything',
   #       value => 'excel, everything',
   #       description => 'Output an Excel file (compatable with Excel 95), '.
   #   'with a seperate worksheet for each sequence you have selected '.
   #           'the data for each problem part '.
   #           '(number of tries, status, points awarded) '.
   #           'will be listed.'},
        { name  => 'Excel, totals',
          value => 'excel, totals',
          description => 'Output an Excel file (compatable with Excel 95), '.
      'with two columns for each sequence, the students score on the '.
      'sequence and the students maximum possible on the sequence'},
        { name  => 'CSV, everything',
          value => 'csv, everything',
          description => ''},
        { name  => 'CSV, scores only',
          value => 'csv, scores only',
          description => ''},
        { name  => 'CSV, totals',
          value => 'csv, totals',
          description => ''},
        );
   
   sub OutputDescriptions {
       my $Str = '';
       $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;
   }
   
 $CacheData: A pointer to a hash tied to the cached data  sub CreateAndParseOutputSelector {
       my $Str = '';
       my $elementname = 'outputmode';
       #
       # Format for output options is 'mode, restrictions';
       my $selected = 'html, with links';
       if (exists($ENV{'form.'.$elementname})) {
           if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
               $selected = $ENV{'form.'.$elementname}->[0];
           } else {
               $selected = $ENV{'form.'.$elementname};
           }
       }
       #
       # Set package variables describing output mode
       $show_links  = 'no';
       $output_mode = 'html';
       $show        = 'all';
       my ($mode,$restriction) = split(',',$selected);
       $restriction =~ s/^\s*//;
       if ($mode =~ /^(html|excel|csv)$/) {
           $output_mode = $mode;
       } else {
           $output_mode = 'html';
       }
       if ($restriction eq 'with links') {
           $show_links = 'yes';
       } else {
           $show_links = 'no';
       }
       if ($restriction eq 'totals') {
           $show = 'totals';
       } elsif ($restriction eq 'scores only') {
           $show = 'scores';
       } else {
           $show = 'everything';
       }
       #
       # Build the form element
       $Str = qq/<select size="5" name="$elementname">/;
       foreach my $option (@OutputOptions) {
           $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
           $Str .= " selected " if ($option->{'value'} eq $selected);
           $Str .= ">".$option->{'name'}."<\/option>";
       }
       $Str .= "\n</select>";
       return $Str;
   }
   
 $headings:  An array of the names of the columns for the student information.    #######################################################
 They are used for displaying which columns are missing.  #######################################################
   
 Output: $notThere  =pod
   
 $notThere: The string contains one row of a table.  The first column has the   =head2 HTML output routines
 name of the selection box.  The second contains the selection box   
 which has a size of four.  
   
 =back  =item &html_initialize($r)
   
 =cut  Create labels for the columns of student data to show.
   
 sub CreateColumnSelectionBox {  =item &html_outputstudent($r,$student)
     my ($doNotShow)=@_;  
   
     my $notThere = '';  Return a line of the chart for a student.
     $notThere .= '<select name="ReselectColumns" size="4" ';  
     $notThere .= 'multiple="true">'."\n";  
   
     for(my $index=0; $index<$doNotShow->{'count'}; $index++) {  =item &html_finish($r)
         my $name = $doNotShow->{$index.':name'};  
         $notThere .= '<option value="';  
         $notThere .= $doNotShow->{$index.':id'}.'">';  
         $notThere .= $name.'</option>'."\n";  
     }  
   
     $notThere .= '</select>';  =cut
   
     return $notThere;  #######################################################
   #######################################################
   {
       my $padding;
       my $count;
   
   sub html_initialize {
       my ($r) = @_;
       #
       $padding = ' 'x3;
       $count = 1;
       #
       my $Str = "<pre>\n";
       # First, the @StudentData fields need to be listed
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
           my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
           my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       # Now the selected sequences need to be listed
       foreach my $sequence (&get_sequences_to_show) {
           my $title = $sequence->{'title'};
           my $base  = $sequence->{'base_width'};
           my $width = $sequence->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       $Str .= "total (of shown problems)</pre>\n";
       $Str .= "<pre>";
       $r->print($Str);
       $r->rflush();
       return;
 }  }
   
 =pod  sub html_outputstudent {
       my ($r,$student) = @_;
 =item &CreateColumnSelectors()      my $Str = '';
       # First, the @StudentData fields need to be listed
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           my $title=$student->{$field};
           my $base = length($title);
           my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
       }
       # Get ALL the students data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state
           ($student->{'username'},$student->{'domain'},undef,
            $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
       }
       if (scalar(@tmp) < 1) {
           $Str .= '<font color="blue">No Course Data</font>'."\n";
           $r->print($Str);
           $r->rflush();
           return;
       }
       #
       # By sequence build up the data
       my $studentstats;
       my $PerformanceStr = '';
       foreach my $seq (&get_sequences_to_show) {
           my ($performance,$score,$seq_max) =
               &StudentPerformanceOnSequence($student,\%StudentsData,
                                             $seq,$show_links);
           my $ratio = $score.'/'.$seq_max;
           #
           if ($show eq 'totals') {
               $performance = ' 'x(length($seq_max)-length($score)).$ratio;
               $performance .= ' 'x($seq->{'width'}-length($performance));
           } elsif ($show eq 'scores') {
               $performance = $score;
               $performance .= ' 'x($seq->{'width'}-length($performance));
           } else {
               # Pad with extra spaces
               $performance .= ' 'x($seq->{'width'}-$seq_max-
                                    length($ratio)
                                    ).$ratio;
           }
           #
           $Str .= $performance.$padding;
           #
           $studentstats->{$seq->{'symb'}}->{'score'}= $score;
           $studentstats->{$seq->{'symb'}}->{'max'}  = $seq_max;
       }
       #
       # Total it up and store the statistics info.
       my ($score,$max) = (0,0);
       while (my ($symb,$seq_stats) = each (%{$studentstats})) {
           $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
           $Statistics->{$symb}->{'max'}   += $seq_stats->{'max'};
           $score += $seq_stats->{'score'};
           $max   += $seq_stats->{'max'};
       }
       $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
       $Str .= " \n";
       $r->print($Str);
       #
       $count++;
       if($count % 5 == 0) {
           $r->print("</pre><pre>");
       }
       #
       $r->rflush();
       return;
   }    
   
 This function generates the checkboxes above the column headings.  The   sub html_finish {
 column will be removed if the checkbox is unchecked.      my ($r) = @_;
       $r->print("</pre>\n"); 
       $r->rflush();
       return;
   }
   
 =over 4  }
   
 Input: $CacheData, $headings  #######################################################
   #######################################################
   
 $CacheData: A pointer to a hash tied to the cached data  =pod
   
 $headings:  An array of the names of the columns for the student   =head2 EXCEL subroutines
 information.  They are used to know what are the student information columns  
   
 Output: $present  =item &excel_initialize($r)
   
 $present: The string contains the first row of a table.  Each column contains  =item &excel_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 &excel_finish($r)
   
 =cut  =cut
   
 sub CreateColumnSelectors {  #######################################################
     my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;  #######################################################
   {
   
   my $excel_sheet;
   my $excel_workbook;
   
   my $filename;
   my $rows_output;
   my $cols_output;
   
   my $num_students;
   my $start_time;
   
   sub excel_initialize {
       my ($r) = @_;
       #
       $filename = '/prtspool/'.
           $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
               time.'_'.rand(1000000000).'.xls';
       #
       $excel_workbook = undef;
       $excel_sheet = undef;
       #
       $rows_output = 0;
       $cols_output = 0;
       #
       $num_students = 0;
       $start_time   = time;
       #
       # Create sheet
       $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
       #
       # Check for errors
       if (! defined($excel_workbook)) {
           $r->log_error("Error creating excel spreadsheet $filename: $!");
           $r->print("Problems creating new Excel file.  ".
                     "This error has been logged.  ".
                     "Please alert your LON-CAPA administrator");
           return ;
       }
       #
       # The excel spreadsheet stores temporary data in files, then put them
       # together.  If needed we should be able to disable this (memory only).
       # The temporary directory must be specified before calling 'addworksheet'.
       # File::Temp is used to determine the temporary directory.
       $excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
       #
       # Add a worksheet
       my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       if (length($sheetname) > 31) {
           $sheetname = substr($sheetname,0,31);
       }
       $excel_sheet = $excel_workbook->addworksheet($sheetname);
       #
       # Add the student headers
       foreach my $field (&get_student_fields_to_show()) {
           $excel_sheet->write(1,$cols_output++,$field);
       }
       #
       # Add the Sequence Headers
       foreach my $seq (&get_sequences_to_show) {
           $excel_sheet->write(0,$cols_output,$seq->{'title'});
           if ($show eq 'totals') {
               $excel_sheet->write(1,$cols_output,'score');
               $excel_sheet->write(1,$cols_output+1,'maximum');
               $cols_output += 2;
           } else {
               $cols_output++;
           }
       }
       #
       # Bookkeeping
       if ($show eq 'totals') {
           $rows_output = 2;
       } else {
           $rows_output = 1;
       }
       #
       # Let the user know what we are doing
       my $studentcount = scalar(@Apache::lonstatistics::Students); 
       $r->print("<h1>Compiling Excel spreadsheet for ".
                 $studentcount.' student');
       $r->print('s') if ($studentcount > 1);
       $r->print("</h1>\n");
       $r->rflush();
       #
       return;
   }
   
     my $present = '';  sub excel_outputstudent {
     for(my $index=0; $index<(scalar @$infoHeadings); $index++) {      my ($r,$student) = @_;
         $present .= '<td align="left">';      return if (! defined($excel_sheet));
         $present .= '<input type="checkbox" checked="on" ';      $cols_output=0;
         $present .= 'name="HeadingColumn'.$infoHeadings->[$index].'" />';      #
         $present .= '</td>'."\n";      # Write out student data
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
       }
       #
       # Get student assessment data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
                                                           $student->{'domain'},
                                                           undef,
                                                      $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
       }
       #
       # Write out sequence scores and totals data
       foreach my $seq (&get_sequences_to_show) {
           my ($performance,$score,$seq_max) =
               &StudentPerformanceOnSequence($student,\%StudentsData,
                                             $seq,'no');
           if ($show eq 'totals' || $show eq 'scores') {
               $excel_sheet->write($rows_output,$cols_output++,$score);
           }
           if ($show eq 'totals') {
               $excel_sheet->write($rows_output,$cols_output++,$seq_max);
           }
       }
       #
       # Bookkeeping
       $rows_output++; 
       $cols_output=0;
       #
       # Time estimate
       $num_students++;
       if ($num_students % 10 == 0) {
           my $time_est = (time - $start_time)/$num_students * 
               (scalar(@Apache::lonstatistics::Students)-$num_students);
           $time_est = int($time_est);
           if (int ($time_est/60) > 0) {
               my $min = int($time_est/60);
               my $sec = $time_est % 60;
               $time_est = $min.' minutes';
               if ($sec > 1) {
                   $time_est.= ', '.$sec.' seconds';
               } elsif ($sec > 0) {
                   $time_est.= ', '.$sec.' second';
               }
           } else {
               $time_est .= ' seconds';
           }
           $r->print($num_students.' out of '.
                     (scalar(@Apache::lonstatistics::Students)).
                     " students processed.  ".
                     $time_est." remain.  <br />\n");
           $r->rflush();
     }      }
       return;
   }
   
     for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) {  sub excel_finish {
         $present .= '<td align="left">';      my ($r) = @_;
         $present .= '<input type="checkbox" checked="on" ';      return if (! defined($excel_sheet));
         $present .= 'name="SequenceColumn'.$sequenceKeys->[$index].'" />';      #
         $present .= '</td>'."\n";      # Write the excel file
       $excel_workbook->close();
       my $c = $r->connection();
       #
       return if($c->aborted());
       #
       # Tell the user where to get their excel file
       $r->print('<br /><br />'.
                 '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
       my $total_time = time - $start_time;
       if (int ($total_time / 60) > 0) {
           $total_time = int($total_time/60).' minutes, '.($total_time % 60);
     }      }
       $r->print('<br />'.$total_time.' seconds total');
       $r->rflush();
       return;
   }
   
     return $present;  
 }  }
   #######################################################
   #######################################################
   
 #---- END Student Assessment Web Page ----------------------------------------  =pod
   
 #---- Student Assessment Worker Functions ------------------------------------  =head2 CSV output routines
   
 sub FindSelectedStudent {  =item &csv_initialize($r)
     my($cache, $selectedName, $students)=@_;  
   
     if($selectedName eq 'All Students' ||   =item &csv_outputstudent($r,$student)
        $selectedName eq 'No Student Selected') {  
         return $selectedName;  
     }  
   
     for(my $index=0; $index<(scalar @$students); $index++) {  =item &csv_finish($r)
         my $fullname = $cache->{$students->[$index].':fullname'};  
         if($fullname eq $selectedName) {  =cut
             if($cache->{'StudentAssessmentMove'} eq 'next') {  
                 if($index == ((scalar @$students) - 1)) {  #######################################################
                     $selectedName = $students->[0];  #######################################################
                     return $selectedName;  {
                 } else {  
                     $selectedName = $students->[$index+1];  sub csv_initialize{
                     return $selectedName;      my ($r) = @_;
                 }      $r->print("<h1>Not implemented yet</h1>");
             } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {      return;
                 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';  sub csv_outputstudent {
       my ($r,$student) = @_;
 }  }
   
   sub csv_finish {
       my ($r) = @_;
   }
   
   }
   
   #######################################################
   #######################################################
   
 =pod  =pod
   
 =item &ShouldShowColumn()  =item &StudentPerformanceOnSequence()
   
 Determine if a specified column should be shown on the chart.  Inputs:
   
 =over 4  =over 4
   
 Input: $cache, $test  =item $student
   
 $cache: A pointer to the hash tied to the cached data  =item $studentdata Hash ref to all student data
   
 $test: The form name of the column (heading.$headingIndex) or   =item $seq Hash ref, the sequence we are working on
 (sequence.$sequenceIndex)  
   
 Output: 0 (false), 1 (true)  =item $links if defined we will output links to each resource.
   
 =back  =back
   
 =cut  =cut
   
 sub ShouldShowColumns {  #######################################################
     my ($cache,$headings,$cacheKey)=@_;  #######################################################
   sub StudentPerformanceOnSequence {
     my @infoKeys=();      my ($student,$studentdata,$seq,$links) = @_;
     my @infoHeadings=();      $links = 'no' if (! defined($links));
       my $Str = '';
     my @sequenceKeys=();      my ($sum,$max) = (0,0);
     my @sequenceHeadings=();      foreach my $resource (@{$seq->{'contents'}}) {
           next if ($resource->{'type'} ne 'assessment');
     my %doNotShow;          my $resource_data = $studentdata->{$resource->{'symb'}};
           my $value = '';
     my $index;          foreach my $partnum (@{$resource->{'parts'}}) {
     my $count = 0;              $max++;
     my $check = '';              my $symbol = ' '; # default to space
     for($index=0; $index < scalar @$headings; $index++) {              #
         $check = 'HeadingColumn'.$headings->[$index];              if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
         if($cache->{'HeadingsFound'} =~ /$check/) {                  my $status = $resource_data->{'resource.'.$partnum.'.solved'};
             push(@infoHeadings, $headings->[$index]);                  if ($status eq 'correct_by_override') {
             push(@infoKeys, $cacheKey->[$index]);                      $symbol = '+';
         } else {                      $sum++;
             $doNotShow{$count.':name'} = $headings->[$index];                  } elsif ($status eq 'incorrect_by_override') {
             $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index];                      $symbol = '-';
             $count++;                  } 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);
   }
   
     foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) {  #######################################################
         $check = 'SequenceColumn'.$sequence;  #######################################################
         if($cache->{'SequencesFound'} eq 'All Sequences' ||   sub StudentAverageTotal {
            $cache->{'SequencesFound'} =~ /$check/) {      my ($cache, $students, $sequenceKeys)=@_;
             push(@sequenceHeadings, $cache->{$sequence.':title'});      my $Str = "\n<b>Summary Tables:</b>\n";
             push(@sequenceKeys, $sequence);      my %Correct = ();
       my $ProblemsSolved = 0;
       my $TotalProblems = 0;
       my $StudentCount = 0;
   
       foreach my $name (@$students) {
           $StudentCount++;
           foreach my $sequence (@$sequenceKeys) {
               $Correct{$sequence} +=
          $cache->{$name.':'.$sequence.':problemsCorrect'};
           }
    $ProblemsSolved += $cache->{$name.':problemsSolved'};
           $TotalProblems += $cache->{$name.':totalProblems'};
       }
       if ($StudentCount) { 
           $ProblemsSolved = sprintf( "%.2f", 
                                $ProblemsSolved/$StudentCount);
           $TotalProblems /= $StudentCount;
       } else {
           $ProblemsSolved = 0;
           $TotalProblems  = 0;
       }
   
       $Str .= '<table border=2 cellspacing="1">'."\n";
       $Str .= '<tr><td><b>Students Count</b></td><td><b>'.
               $StudentCount.'</b></td></tr>'."\n";
       $Str .= '<tr><td><b>Total Problems</b></td><td><b>'.
               $TotalProblems.'</b></td></tr>'."\n";
       $Str .= '<tr><td><b>Average Correct</b></td><td><b>'.
               $ProblemsSolved.'</b></td></tr>'."\n";
       $Str .= '</table>'."\n";
   
       $Str .= '<table border=2 cellspacing="1">'."\n";
       $Str .= '<tr><th>Title</th><th>Total Problems</th>'.
               '<th>Average Correct</th></tr>'."\n";
       foreach my $S(@$sequenceKeys) {
           my $title=$cache->{$S.':title'};
    #$Str .= $cache->{$S.':problems'};
    #my @problems=split(':', $cache->{$S.':problems'});
    #my $pCount=scalar @problems;
    my $pCount=MaxSeqPr($cache,@$students[0],$S);
           my $crr;
    if ($StudentCount) {
               $crr=sprintf( "%.2f", $Correct{$S}/$StudentCount );
         } else {          } else {
             $doNotShow{$count.':name'} = $cache->{$sequence.':title'};              $crr="0.00";
             $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence;  
             $count++;  
         }          }
           $Str .= '<tr><td>'.$title.
                   '</td><td align=center>'.$pCount.
                   '</td><td align=center>'.$crr.
                   '</td></tr>'."\n";
     }      }
   
     $doNotShow{'count'} = $count;      $Str .= '</table>'."\n";
   
       return $Str;
   }
   
   #######################################################
   #######################################################
   
   =pod
   
   =item &CreateLegend()
   
   This function returns a formatted string containing the legend for the
   chart.  The legend describes the symbols used to represent grades for
   problems.
   
   =cut
   
     return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,   #######################################################
             \@sequenceKeys, \%doNotShow);  #######################################################
   sub CreateLegend {
       my $Str = "<p><pre>".
                 "   1  correct by student in 1 try\n".
                 "   7  correct by student in 7 tries\n".
                 "   *  correct by student in more than 9 tries\n".
         "   +  correct by hand grading or override\n".
                 "   -  incorrect by override\n".
         "   .  incorrect attempted\n".
         "   #  ungraded attempted\n".
                 "      not attempted (blank field)\n".
         "   x  excused".
                 "</pre><p>";
       return $Str;
 }  }
   
 #---- END Student Assessment Worker Functions --------------------------------  #######################################################
   #######################################################
   
   =pod 
   
   =back
   
   =cut
   
   #######################################################
   #######################################################
   
 1;  1;
   
 __END__  __END__
Removed from v.1.6  
changed lines
  Added in v.1.33

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