[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.28 and 1.33

version 1.28, 2003/02/21 18:41:56 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$
 #  #
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
   
   =cut
   
   #######################################################
   #######################################################
   my $show_links;
   my $output_mode;
   my $show;
   
 =item $cacheDB The name of the cache file used to store student data  #######################################################
   #######################################################
   # End of package variable declarations
   
 =item $students Array ref containing the name(s) of the students   =pod
 selected for display  
   
 =item $courseID The ID of the course  =back
   
 =item $formName The name of the html form - 'Statistics'  =cut
   
 =item $headings Array ref of headings to show  #######################################################
   #######################################################
   
 =item $spacing A string of spaces  =pod
   
 =item $studentInformation Array ref of possible headings for student info  =item &BuildStudentAssessmentPage()
 ('fullname','section',...)  
   Inputs: 
   
   =over 4
   
 =item $r Apache Request  =item $r Apache Request
   
Line 95  selected for display Line 125  selected for display
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub BuildStudentAssessmentPage {  sub BuildStudentAssessmentPage {
     my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,      my ($r,$c)=@_;
         $studentInformation,$r,$c)=@_;      undef($Statistics);
     my %cache;      #
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {      # Print out the HTML headers for the interface
         $r->print('<html><body>Unable to tie database.</body></html>');      #    This also parses the output mode selector
       #    This step must always be done.
       $r->print(&CreateInterface());
       $r->print('<input type="hidden" name="notfirstrun" value="true" />');
       $r->rflush();
       if (! exists($ENV{'form.notfirstrun'})) {
           $r->print(<<ENDMSG);
   <p>
   <font size="+1">
   Please make your selections in the boxes above and hit 
   the button marked &quot;Update&nbsp;Display&quot;.
   </font>
   </p>
   ENDMSG
   #        $r->print(&OutputDescriptions());
         return;          return;
     }      }
       #
       #
       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;
   }
   
     # Remove students who don't have the proper section.  #######################################################
     my @sectionsSelected = split(':',$cache{'sectionsSelected'});  #######################################################
     for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;  
         $studentIndex--) {  sub get_student_fields_to_show {
         my $value = $cache{$students->[$studentIndex].':section'};      my @to_show = @Apache::lonstatistics::SelectedStudentData;
         my $found = 0;      foreach (@to_show) {
         foreach (@sectionsSelected) {          if ($_ eq 'all') {
             if($_ eq 'none') {              @to_show = @Apache::lonstatistics::StudentDataOrder;
                 if($value eq '' || !defined($value) || $value eq ' ') {              last;
                     $found = 1;  
                     last;  
                 }  
             } else {  
                 if($value eq $_) {  
                     $found = 1;  
                     last;  
                 }  
             }  
         }  
         if($found == 0) {  
             splice(@$students, $studentIndex, 1);  
         }          }
     }      }
     my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,      return @to_show;
         $doNotShow) =  }
         &ShouldShowColumns(\%cache, $headings, $studentInformation);  
   
     my $selectedName = &FindSelectedStudent(\%cache,  
                                             $cache{'StudentAssessmentStudent'},  
                                             $students);  
     $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,  
                                $doNotShow));  
     $r->rflush();  
   
     my $Str = '';  sub get_sequences_to_show {
     if($selectedName eq 'No Student Selected') {      my @Sequences;
  $Str .= '<h3><font color=blue>WARNING: ';      foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) {
         $Str .= 'Please select a student</font></h3>';          foreach my $sequence (@Apache::lonstatistics::Sequences) {
         $r->print($Str);              next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all');
         return;              next if ($sequence->{'num_assess'} < 1);
               push (@Sequences,$sequence);
           }
     }      }
       return @Sequences;
   }
   
     $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;  
             $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(  
                                                          \%cache, $_,  
                                                          \@after,  
                                                          $displayString,  
                                                          'preformatted'));  
             $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;  
 }  
 #######################################################  #######################################################
 #######################################################  #######################################################
   
Line 246  sub BuildStudentAssessmentPage { Line 217  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 227  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>Sequences and Folders</b></td>';
                                                    $selectedName,      $Str .= '<td align="center"><b>Output Format</b></td>';
                                                    'StudentAssessment',      $Str .= '</tr>'."\n";
                                                    $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";      $Str .= '<tr><td align="center">'."\n";
     my @sections = split(':',$cache->{'sectionList'});      $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
     my @selectedSections = split(':',$cache->{'sectionsSelected'});  
     $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections,  
                                                           \@selectedSections,  
                                                           'Statistics');  
     $Str .= '</td><td align="center">';      $Str .= '</td><td align="center">';
     $Str .= &CreateColumnSelectionBox($doNotShow);      my $only_seq_with_assessments = sub { 
           my $s=shift;
           if ($s->{'num_assess'} < 1) { 
               return 0;
           } else { 
               return 1;
           }
       };
       $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
                                                         5,undef);
     $Str .= '</td><td>'."\n";      $Str .= '</td><td>'."\n";
     $Str .= '<input type="submit" name="DefaultColumns" ';      $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
     $Str .= 'value="Default Column Display" />'."\n";                                                $only_seq_with_assessments);
     $Str .= '</td><td>'."\n";      $Str .= '</td><td>'."\n";
     $Str .= '<input type="submit" name="displaymode" ';      $Str .= &CreateAndParseOutputSelector();
     if (! exists($ENV{'form.displaymode'}) ||      $Str .= '</td></tr>'."\n";
         lc($ENV{'form.displaymode'}) eq 'display with links') {      $Str .= '</table>'."\n";
         $Str .= 'value="Display without links" />';  
         # Set the current value, in case it is undefined  
         $ENV{'form.displaymode'} = 'Display with links';  
     } else {  
         $Str .= 'value="Display with links" />';  
     }  
     $Str .= "\n";  
     $Str .= '</td></tr></table>'."\n";  
   
     return $Str;      return $Str;
 }  }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
   
 =pod  =pod
   
 =item &CreateTableHeadings()  =item &CreateAndParseOutputSelector()
   
 Create HTML for the columns of student data to show.  =cut
 Called by &BuildStudentAssessmentPage().  Calls  
 &Apache::lonhtmlcommon::CreateHeadings().  
   
 Inputs:  #######################################################
   #######################################################
   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 => ''},
        );
   
 =over 4  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;
   }
   
 =item $cache The ubiquitous cache  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;
   }
   
 =item $spacing A string of spaces  #######################################################
   #######################################################
   
 =item $infoKeys Array ref to names of keys to display from the cache   =pod
 which describe students  
   
 =item $infoHeadings Array ref to headings of columns for student info  =head2 HTML output routines
   
 =item $sequenceKeys Array ref of names of keys to use to retrieve sequence  =item &html_initialize($r)
 data from the cache  
   
 =item $sequenceHeadings Array ref of names of sequences used for output.  Create labels for the columns of student data to show.
   
 =back  =item &html_outputstudent($r,$student)
   
 Returns: A string containing the HTML of the table headings.  Return a line of the chart for a student.
   
   =item &html_finish($r)
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub CreateTableHeadings {  {
     my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys,      my $padding;
        $sequenceHeadings)=@_;      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;
   }
   
 #    my $Str = '&nbsp&nbsp&nbsp&nbsp&nbsp';  sub html_outputstudent {
       my ($r,$student) = @_;
     my $Str = '';      my $Str = '';
     $Str .= '<table border="0" cellpadding="0" cellspacing="0">'."\n";      # First, the @StudentData fields need to be listed
     $Str .= '<tr>'."\n";      my @to_show = &get_student_fields_to_show();
     $Str .= '<td><pre>     </pre></td>'."\n";      foreach my $field (@to_show) {
     $Str .= &CreateColumnSelectors($infoHeadings, $sequenceHeadings,          my $title=$student->{$field};
                                    $sequenceKeys);          my $base = length($title);
     $Str .= '<td></td></tr>'."\n";          my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
           $Str .= $title.' 'x($width-$base).$padding;
     $Str .= '<tr>'."\n";      }
     my $displayString = '';      # Get ALL the students data
     $displayString .= '<td><pre>     </pre></td>'."\n";      my %StudentsData;
     $displayString .= '<td align="left"><pre><a href="/adm/statistics?';      my @tmp = &Apache::loncoursedata::get_current_state
     $displayString .= 'sort=LINKDATA">DISPLAYDATA</a>FORMATTING';          ($student->{'username'},$student->{'domain'},undef,
     $displayString .= $spacing.'</pre></td>'."\n";           $ENV{'request.course.id'});
     $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,      if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
                                                    $infoKeys,          %StudentsData = @tmp;
                                                    $infoHeadings,      }
                                                    $displayString,      if (scalar(@tmp) < 1) {
                                                    'preformatted');          $Str .= '<font color="blue">No Course Data</font>'."\n";
           $r->print($Str);
     $displayString  = '<td align="left"><pre>DISPLAYDATAFORMATTING'.$spacing;          $r->rflush();
     $displayString .= '</pre></td>'."\n";          return;
     $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,      }
                                                    $sequenceKeys,      #
                                                    $sequenceHeadings,      # By sequence build up the data
                                                    $displayString,      my $studentstats;
                                                    'preformatted');      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;
   }    
   
     $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';  sub html_finish {
     $Str .= '</tr></table>'."\n";      my ($r) = @_;
       $r->print("</pre>\n"); 
       $r->rflush();
       return;
   }
   
     return $Str;  
 }  }
   
 #######################################################  #######################################################
Line 401  sub CreateTableHeadings { Line 522  sub CreateTableHeadings {
   
 =pod  =pod
   
 =item &StudentReport()  =head2 EXCEL subroutines
   
 This is the workhorse subroutine - it handles formatting and display of a  =item &excel_initialize($r)
 students performance data.  It processes one row of the chart.  
   
 Input:   =item &excel_outputstudent($r,$student)
   
 =over 4  =item &excel_finish($r)
   
 =item $cache The ubiquitous cache  =cut
   
 =item $name The name and domain of the current student in name:domain format  #######################################################
   #######################################################
   {
   
 =item $spacing A string containing spaces.  my $excel_sheet;
   my $excel_workbook;
   
 =item $showSequences Array ref containing the sequences to display  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;
   }
   
 =back  sub excel_outputstudent {
       my ($r,$student) = @_;
       return if (! defined($excel_sheet));
       $cols_output=0;
       #
       # Write out student data
       my @to_show = &get_student_fields_to_show();
       foreach my $field (@to_show) {
           $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
       }
       #
       # Get student assessment data
       my %StudentsData;
       my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
                                                           $student->{'domain'},
                                                           undef,
                                                      $ENV{'request.course.id'});
       if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
           %StudentsData = @tmp;
       }
       #
       # Write out sequence scores and totals data
       foreach my $seq (&get_sequences_to_show) {
           my ($performance,$score,$seq_max) =
               &StudentPerformanceOnSequence($student,\%StudentsData,
                                             $seq,'no');
           if ($show eq 'totals' || $show eq 'scores') {
               $excel_sheet->write($rows_output,$cols_output++,$score);
           }
           if ($show eq 'totals') {
               $excel_sheet->write($rows_output,$cols_output++,$seq_max);
           }
       }
       #
       # Bookkeeping
       $rows_output++; 
       $cols_output=0;
       #
       # Time estimate
       $num_students++;
       if ($num_students % 10 == 0) {
           my $time_est = (time - $start_time)/$num_students * 
               (scalar(@Apache::lonstatistics::Students)-$num_students);
           $time_est = int($time_est);
           if (int ($time_est/60) > 0) {
               my $min = int($time_est/60);
               my $sec = $time_est % 60;
               $time_est = $min.' minutes';
               if ($sec > 1) {
                   $time_est.= ', '.$sec.' seconds';
               } elsif ($sec > 0) {
                   $time_est.= ', '.$sec.' second';
               }
           } else {
               $time_est .= ' seconds';
           }
           $r->print($num_students.' out of '.
                     (scalar(@Apache::lonstatistics::Students)).
                     " students processed.  ".
                     $time_est." remain.  <br />\n");
           $r->rflush();
       }
       return;
   }
   
 Output: $Str  sub excel_finish {
       my ($r) = @_;
       return if (! defined($excel_sheet));
       #
       # Write the excel file
       $excel_workbook->close();
       my $c = $r->connection();
       #
       return if($c->aborted());
       #
       # Tell the user where to get their excel file
       $r->print('<br /><br />'.
                 '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
       my $total_time = time - $start_time;
       if (int ($total_time / 60) > 0) {
           $total_time = int($total_time/60).' minutes, '.($total_time % 60);
       }
       $r->print('<br />'.$total_time.' seconds total');
       $r->rflush();
       return;
   }
   
   }
   #######################################################
   #######################################################
   
   =pod
   
   =head2 CSV output routines
   
 $Str: Formatted string that is an entire row of the chart.  It is a  =item &csv_initialize($r)
 concatenation of student information and student course information.  
   =item &csv_outputstudent($r,$student)
   
   =item &csv_finish($r)
   
 =cut  =cut
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub StudentReport {  {
     my ($cache,$name,$spacing,$showSequences)=@_;  
     my ($username,$domain)=split(':',$name);  
   
     my $Str = '';  sub csv_initialize{
     if(defined($cache->{$name.':error'})) {      my ($r) = @_;
         return $Str;      $r->print("<h1>Not implemented yet</h1>");
     }      return;
     if($cache->{$name.':error'} =~ /course/) {  }
         $Str .= '<b><font color="blue">No course data for student </font>';  
         $Str .= '<font color="red">'.$username.'.</font></b><br>';  
         return $Str;  
     }  
   
     my $hasVersion = 'false';  
     my $hasFinalData = 'false';  
     foreach my $sequence (@$showSequences) {  
         my $hasData = 'false';  
         my $characterCount=0;  
         foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {  
             my $problem = $cache->{$problemID.':problem'};  
             # All grades (except for versionless parts) are displayed as links  
             # to their submission record.  Loop through all the parts for the  
             # current problem in the correct order and prepare the output links  
             foreach(split(/\:/,$cache->{$sequence.':'.$problemID.  
                                         ':parts'})) {  
                 if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||  
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||  
                    $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {  
                     $Str .= ' ';  
                     $characterCount++;  
                     next;  
                 }  
                 $hasVersion = 'true';  
                 $hasData = 'true';  
                 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 {  
             $Str .= '<font color="#007700">     </font>';  
         }  
         $Str .= $spacing;  
     }  
   
     # Output the total correct problems over the total number of problems.  sub csv_outputstudent {
     # I don't like this type of formatting, but it is a solution.  Need      my ($r,$student) = @_;
     # a way to dynamically determine the space requirements.  }
     my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'});  
     my $outputTotalProblems  = sprintf("%4d", $cache->{$name.':totalProblems'});  
     if($hasFinalData eq 'true') {  
         $Str .= '<font color="#000088">'.$outputProblemsSolved.  
     ' / '.$outputTotalProblems.'</font>';  
     } else {  
         $Str .= '<font color="#000088">           </font>';  
     }  
   
     if($hasVersion eq 'false') {  sub csv_finish {
         $Str = '<b><font color="blue">No course data.</font></b>';      my ($r) = @_;
     }  }
   
     return $Str;  
 }  }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
   
   =pod
   
   =item &StudentPerformanceOnSequence()
   
   Inputs:
   
   =over 4
   
   =item $student
   
   =item $studentdata Hash ref to all student data
   
   =item $seq Hash ref, the sequence we are working on
   
   =item $links if defined we will output links to each resource.
   
   =back
   
   =cut
   
   #######################################################
   #######################################################
   sub StudentPerformanceOnSequence {
       my ($student,$studentdata,$seq,$links) = @_;
       $links = 'no' if (! defined($links));
       my $Str = '';
       my ($sum,$max) = (0,0);
       foreach my $resource (@{$seq->{'contents'}}) {
           next if ($resource->{'type'} ne 'assessment');
           my $resource_data = $studentdata->{$resource->{'symb'}};
           my $value = '';
           foreach my $partnum (@{$resource->{'parts'}}) {
               $max++;
               my $symbol = ' '; # default to space
               #
               if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
                   my $status = $resource_data->{'resource.'.$partnum.'.solved'};
                   if ($status eq 'correct_by_override') {
                       $symbol = '+';
                       $sum++;
                   } elsif ($status eq 'incorrect_by_override') {
                       $symbol = '-';
                   } elsif ($status eq 'ungraded_attempted') {
                       $symbol = '#';
                   } elsif ($status eq 'incorrect_attempted')  {
                       $symbol = '.';
                   } elsif ($status eq 'excused') {
                       $symbol = 'x';
                       $max--;
                   } elsif ($status eq 'correct_by_student' &&
                       exists($resource_data->{'resource.'.$partnum.'.tries'})){
                       my $num = $resource_data->{'resource.'.$partnum.'.tries'};
                       if ($num > 9) {
                           $symbol = '*';
                       } elsif ($num > 0) {
                           $symbol = $num;
                       } else {
                           $symbol = ' ';
                       }
                       $sum++;
                   } else {
                       $symbol = ' ';
                   }
               } else {
                   # Unsolved.  Did they try?
                   if (exists($resource_data->{'resource.'.$partnum.'.tries'})){
                       $symbol = '.';
                   } else {
                       $symbol = ' ';
                   }
               }
               #
               if ($links eq 'yes' && $symbol ne ' ') {
                   $symbol = '<a href="/adm/grades'.
                       '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
                           '&student='.$student->{'username'}.
                               '&domain='.$student->{'domain'}.
                                   '&command=submission">'.$symbol.'</a>';
               }
               $value .= $symbol;
           }
           $Str .= $value;
       }
       return ($Str,$sum,$max);
   }
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub StudentAverageTotal {  sub StudentAverageTotal {
Line 593  sub StudentAverageTotal { Line 900  sub StudentAverageTotal {
 #######################################################  #######################################################
 #######################################################  #######################################################
   
 #######################################################  
 #######################################################  
 sub MaxSeqPr {  
     my ($cache, $name, $sequence)=@_;  
     my $prCount=0;  
     foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {  
         my $problem = $cache->{$problemID.':problem'};  
         foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) {  
             if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||  
                $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||  
                $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {  
                  $prCount++;  
                  next;  
             }  
             $prCount++;  
         }  
     }  
     return $prCount;  
 }  
   
 #######################################################  
 #######################################################  
   
 =pod  =pod
   
 =item &CreateLegend()  =item &CreateLegend()
Line 646  sub CreateLegend { Line 930  sub CreateLegend {
 #######################################################  #######################################################
 #######################################################  #######################################################
   
 =pod  =pod 
   
 =item &CreateColumnSelectionBox()  
   
 If there are columns not being displayed then this selection box is created  
 with a list of those columns.  When selections are made and the page  
 refreshed, the columns will be removed from this box and the column is  
 put back in the chart.  If there is no columns to select, no row is added  
 to the interface table.  
   
 =over 4  
 Input: $CacheData, $headings  
   
 $CacheData: A pointer to a hash tied to the cached data  
   
 $headings:  An array of the names of the columns for the student information.  
 They are used for displaying which columns are missing.  
   
 Output: $notThere  
   
 $notThere: The string contains one row of a table.  The first column has the  
 name of the selection box.  The second contains the selection box  
 which has a size of four.  
   
 =back  
   
 =cut  
   
 #######################################################  
 #######################################################  
 sub CreateColumnSelectionBox {  
     my ($doNotShow)=@_;  
   
     my $notThere = '';  
     $notThere .= '<select name="ReselectColumns" size="4" ';  
     $notThere .= 'multiple="true">'."\n";  
   
     for(my $index=0; $index<$doNotShow->{'count'}; $index++) {  
         my $name = $doNotShow->{$index.':name'};  
         $notThere .= '<option value="';  
         $notThere .= $doNotShow->{$index.':id'}.'">';  
         $notThere .= $name.'</option>'."\n";  
     }  
   
     $notThere .= '</select>';  
   
     return $notThere;  
 }  
   
 #######################################################  
 #######################################################  
   
 =pod  
   
 =item &CreateColumnSelectors()  
   
 This function generates the checkboxes above the column headings.  The  
 column will be removed if the checkbox is unchecked.  
   
 =over 4  
   
 Input: $CacheData, $headings  
   
 $CacheData: A pointer to a hash tied to the cached data  
   
 $headings:  An array of the names of the columns for the student   
 information.  They are used to know what are the student information columns  
   
 Output: $present  
   
 $present: The string contains the first row of a table.  Each column contains  
 a checkbox which is left justified.  Currently left justification is used  
 for consistency of location over the column in which it presides.  
   
 =back  
   
 =cut  
   
 #######################################################  
 #######################################################  
 sub CreateColumnSelectors {  
     my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;  
   
     my $present = '';  
     for(my $index=0; $index<(scalar @$infoHeadings); $index++) {  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="HeadingColumn'.$infoHeadings->[$index].'" />';  
         $present .= '</td>'."\n";  
     }  
   
     for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) {  
         $present .= '<td align="left">';  
         $present .= '<input type="checkbox" checked="on" ';  
         $present .= 'name="SequenceColumn'.$sequenceKeys->[$index].'" />';  
         $present .= '</td>'."\n";  
     }  
   
     return $present;  
 }  
   
 #######################################################  
 #######################################################  
   
 =pod  
   
 =back  
   
 =head1 HELPER FUNCTIONS  
   
 =over 4  
   
 =cut   
   
 #######################################################  
 #######################################################  
 sub FindSelectedStudent {  
     my($cache, $selectedName, $students)=@_;  
   
     if($selectedName eq 'All Students' ||  
        $selectedName eq 'No Student Selected') {  
         return $selectedName;  
     }  
   
     for(my $index=0; $index<(scalar @$students); $index++) {  
         my $fullname = $cache->{$students->[$index].':fullname'};  
         if($fullname eq $selectedName) {  
             if($cache->{'StudentAssessmentMove'} eq 'next') {  
                 if($index == ((scalar @$students) - 1)) {  
                     $selectedName = $students->[0];  
                     return $selectedName;  
                 } else {  
                     $selectedName = $students->[$index+1];  
                     return $selectedName;  
                 }  
             } elsif($cache->{'StudentAssessmentMove'} eq 'previous') {  
                 if($index == 0) {  
                     $selectedName = $students->[-1];  
                     return $selectedName;  
                 } else {  
                     $selectedName = $students->[$index-1];  
                     return $selectedName;  
                 }  
             } else {  
                 $selectedName = $students->[$index];  
                 return $selectedName;  
             }  
             last;  
         }  
     }  
   
     return 'No Student Selected';  
 }  
 #######################################################  
 #######################################################  
   
 =pod  
   
 =item &ShouldShowColumn()  
   
 Determine if a specified column should be shown on the chart.  
   
 =over 4  
   
 Input: $cache, $test  
   
 $cache: A pointer to the hash tied to the cached data  
   
 $test: The form name of the column (heading.$headingIndex) or   
 (sequence.$sequenceIndex)  
   
 =back  =back
   
Line 823  $test: The form name of the column (head Line 938  $test: The form name of the column (head
   
 #######################################################  #######################################################
 #######################################################  #######################################################
 sub ShouldShowColumns {  
     my ($cache,$headings,$cacheKey)=@_;  
   
     my @infoKeys=();  
     my @infoHeadings=();  
   
     my @sequenceKeys=();  
     my @sequenceHeadings=();  
   
     my %doNotShow;  
   
     my $index;  
     my $count = 0;  
     my $check = '';  
     for($index=0; $index < scalar @$headings; $index++) {  
         $check = 'HeadingColumn'.$headings->[$index];  
         if($cache->{'HeadingsFound'} =~ /$check/) {  
             push(@infoHeadings, $headings->[$index]);  
             push(@infoKeys, $cacheKey->[$index]);  
         } else {  
             $doNotShow{$count.':name'} = $headings->[$index];  
             $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index];  
             $count++;  
         }  
     }  
   
     foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) {  
         $check = 'SequenceColumn'.$sequence;  
         if($cache->{'SequencesFound'} eq 'All Sequences' ||  
            $cache->{'SequencesFound'} =~ /$check/) {  
             push(@sequenceHeadings, $cache->{$sequence.':title'});  
             push(@sequenceKeys, $sequence);  
         } else {  
             $doNotShow{$count.':name'} = $cache->{$sequence.':title'};  
             $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence;  
             $count++;  
         }  
     }  
   
     $doNotShow{'count'} = $count;  
   
     return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,  
             \@sequenceKeys, \%doNotShow);  
 }  
 1;  1;
   
 #######################################################  
 #######################################################  
   
 =pod   
   
 =back  
   
 =cut  
   
 #######################################################  
 #######################################################  
   
 __END__  __END__
Removed from v.1.28  
changed lines
  Added in v.1.33

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