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

Diff for /loncom/interface/Attic/lonchart.pm between versions 1.49 and 1.59

version 1.49, 2002/07/01 21:12:06 version 1.59, 2002/07/09 15:43:49
Line 46 Line 46
 #  #
 ###  ###
   
   =pod
   
   =head1 NAME
   
   lonchart
   
   =head1 SYNOPSIS
   
   Quick display of students grades for a course in a compressed table format.
   
   =head1 DESCRIPTION
   
   This module process all student grades for a course and turns them into a 
   table like structure.
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org
   
   lonchart presents the user with a condensed view all a course's data.  The
   class title, the number of students, and the date for the last update of the
   displayed data.  There is also a legend that describes the chart values.  
   
   For each valid grade for a student is linked with a submission record for that
   problem.  The ability to add and remove columns of data from the chart was
   added for reducing the burden of having to scroll through large quantities
   of data.  The interface also allows for sorting of students by username,
   last name, and section number of class.  Active and expired students are
   also available.
   
   The interface is controlled by three primary buttons: Recalculate Chart, 
   Refresh Chart, and Reset Selections.  Recalculate Chart will update 
   the chart to the most recent data and keep the display settings for the chart
   the same.  Refresh Chart is used to redisplay the chart after selecting
   different output formatting.  Reset Selections is used to set the chart
   display options back to default values.
   
   =head1 CODE LAYOUT DESCRIPTION
   
   The code is broken down into three components: formatting data for printing,
   helper functions, and the central processing functions.  The module is broken 
   into chunks for each component.
   
   =head1 PACKAGES USED
   
    Apache::Constants qw(:common :http)
    Apache::lonnet()
    Apache::loncommon()
    HTML::TokeParser
    GDBM_File
   
   =cut
   
 package Apache::lonchart;  package Apache::lonchart;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::loncoursedata();
 use HTML::TokeParser;  use HTML::TokeParser;
 use GDBM_File;  use GDBM_File;
   
 my $jr;   #my $jr; 
   
   =pod
   
   =head1 FORMAT DATA FOR PRINTING
   
   =cut
   
 # ----- FORMAT PRINT DATA ----------------------------------------------  # ----- FORMAT PRINT DATA ----------------------------------------------
   
   =pod
   
   =item &FormatStudentInformation()
   
   This function produces a formatted string of the student's information:
   username, domain, section, full name, and PID.
   
   =over 4
   
   Input: $cache, $name, $studentInformation, $spacePadding
   
   $cache: This is a pointer to a hash that is tied to the cached data
   
   $name:  The name and domain of the current student in name:domain format
   
   $studentInformation: A pointer to an array holding the names used to
   
   remove data from the hash.  They represent the name of the data to be removed.
   
   $spacePadding: Extra spaces that represent the space between columns
   
   Output: $Str
   
   $Str: Formatted string.
   
   =back
   
   =cut
   
 sub FormatStudentInformation {  sub FormatStudentInformation {
     my ($cache,$name,$studentInformation,$reselected,$spacePadding)=@_;      my ($cache,$name,$studentInformation,$spacePadding)=@_;
     my $Str='<pre>';      my $Str='';
   
     for(my $index=0; $index<(scalar @$studentInformation); $index++) {      for(my $index=0; $index<(scalar @$studentInformation); $index++) {
         if(!&ShouldShowColumn($reselected, 'heading', $index)) {          if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) {
             next;              next;
         }          }
  my $data=$cache->{$name.':'.$studentInformation->[$index]};   my $data=$cache->{$name.':'.$studentInformation->[$index]};
Line 79  sub FormatStudentInformation { Line 168  sub FormatStudentInformation {
     return $Str;      return $Str;
 }  }
   
   =pod
   
   =item &FormatStudentData()
   
   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
   
   Input: $name, $studentInformation, $spacePadding, $ChartDB
   
   $name: The name and domain of the current student in name:domain format
   
   $studentInformation: A pointer to an array holding the names used to 
   remove data from the hash.  They represent 
   the name of the data to be removed.
   
   $spacePadding: Extra spaces that represent the space between columns
   
   $ChartDB: The name of the cached data database which will be tied to that 
   database.
   
   Output: $Str
   
   $Str: Formatted string that is an entire row of the chart.  It is a 
   concatenation of student information and student course information.
   
   =back
   
   =cut
   
 sub FormatStudentData {  sub FormatStudentData {
     my ($reselected,$name,$coid,$studentInformation,$spacePadding,$ChartDB)=@_;      my ($name,$studentInformation,$spacePadding,$ChartDB)=@_;
     my ($sname,$sdom) = split(/\:/,$name);      my ($sname,$sdom) = split(/\:/,$name);
     my $Str;      my $Str;
     my %CacheData;      my %CacheData;
Line 91  sub FormatStudentData { Line 214  sub FormatStudentData {
     # Handle Student information ------------------------------------------      # Handle Student information ------------------------------------------
     # Handle user data      # Handle user data
     $Str=&FormatStudentInformation(\%CacheData, $name, $studentInformation,       $Str=&FormatStudentInformation(\%CacheData, $name, $studentInformation, 
                                    $reselected, $spacePadding);                                     $spacePadding);
   
     # Handle errors      # Handle errors
     if($CacheData{$name.':error'} =~ /environment/) {      if($CacheData{$name.':error'} =~ /environment/) {
           $Str .= '<br>';
         untie(%CacheData);          untie(%CacheData);
         $Str .= '</pre>';  
         return $Str;          return $Str;
 # my $errorMessage = $CacheData{$name.':error'};  
 # return '<td>'.$sname.'</td><td>'.$sdom.  
 #    '</td><td><font color="#000088">'.$errorMessage.'</font></td>';  
     }      }
   
     if($CacheData{$name.':error'} =~ /course/) {      if($CacheData{$name.':error'} =~ /course/) {
           $Str .= '<br>';
         untie(%CacheData);          untie(%CacheData);
         $Str .= '</pre>';          return $Str;
  return $Str;  
 # my $errorMessage = 'May have no course data or '.  
 #                   $CacheData{$name.':error'};  
 # return '<td>'.$sname.'</td><td>'.$sdom.  
 #    '</td><td><font color="#000088">'.$errorMessage.'</font></td>';  
     }      }
   
     # Handle problem data ------------------------------------------------      # Handle problem data ------------------------------------------------
Line 120  sub FormatStudentData { Line 236  sub FormatStudentData {
     my $problemsSolved  = 0;      my $problemsSolved  = 0;
     my $numberOfParts   = 0;      my $numberOfParts   = 0;
     foreach my $sequence (split(/\:/,$CacheData{'orderedSequences'})) {      foreach my $sequence (split(/\:/,$CacheData{'orderedSequences'})) {
         if(!&ShouldShowColumn($reselected, 'sequence', $sequence)) {          if(!&ShouldShowColumn(\%CacheData, 'ChartSequence'.$sequence)) {
             next;              next;
         }          }
   
Line 129  sub FormatStudentData { Line 245  sub FormatStudentData {
     my $problem = $CacheData{$problemID.':problem'};      my $problem = $CacheData{$problemID.':problem'};
     my $LatestVersion = $CacheData{$name.":version:$problem"};      my $LatestVersion = $CacheData{$name.":version:$problem"};
   
               # Output blanks for all the parts of this problem if there
               # is no version information about the current problem.
             if(!$LatestVersion) {              if(!$LatestVersion) {
                 foreach my $part (split(/\:/,$CacheData{$sequence.':'.                  foreach my $part (split(/\:/,$CacheData{$sequence.':'.
                                                         $problemID.                                                          $problemID.
Line 141  sub FormatStudentData { Line 259  sub FormatStudentData {
             }              }
   
             my %partData=undef;              my %partData=undef;
             #initialize data, displays skips correctly              # Initialize part data, display skips correctly
               # Skip refers to when a student made no submissions on that
               # part/problem.
             foreach my $part (split(/\:/,$CacheData{$sequence.':'.              foreach my $part (split(/\:/,$CacheData{$sequence.':'.
                                                     $problemID.                                                      $problemID.
                                                     ':parts'})) {                                                      ':parts'})) {
                 $partData{$part.':tries'}=0;                  $partData{$part.':tries'}=0;
                 $partData{$part.':code'}=' ';                  $partData{$part.':code'}=' ';
             }              }
   
               # Looping through all the versions of each part, starting with the
               # oldest version.  Basically, it gets the most recent 
               # set of grade data for each part.
     for(my $Version=1; $Version<=$LatestVersion; $Version++) {      for(my $Version=1; $Version<=$LatestVersion; $Version++) {
                 foreach my $part (split(/\:/,$CacheData{$sequence.':'.                  foreach my $part (split(/\:/,$CacheData{$sequence.':'.
                                                         $problemID.                                                          $problemID.
Line 155  sub FormatStudentData { Line 279  sub FormatStudentData {
   
                     if(!defined($CacheData{$name.":$Version:$problem".                      if(!defined($CacheData{$name.":$Version:$problem".
                                                ":resource.$part.solved"})) {                                                 ":resource.$part.solved"})) {
                           # No grade for this submission, so skip
                         next;                          next;
                     }                      }
   
Line 178  sub FormatStudentData { Line 303  sub FormatStudentData {
                 }                  }
             }              }
   
               # 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
             $Str.='<a href="/adm/grades?symb='.              $Str.='<a href="/adm/grades?symb='.
                 &Apache::lonnet::escape($problem).                  &Apache::lonnet::escape($problem).
                 '&student='.$sname.'&domain='.$sdom.'&command=submission">';                   '&student='.$sname.'&domain='.$sdom.'&command=submission">'; 
Line 203  sub FormatStudentData { Line 331  sub FormatStudentData {
             $Str.='</a>';              $Str.='</a>';
         }          }
   
           # Output the number of correct answers for the current sequence.
           # This part takes up 6 character slots, but is formated right 
           # justified.
         my $spacesNeeded=$CacheData{$sequence.':columnWidth'}-$characterCount;          my $spacesNeeded=$CacheData{$sequence.':columnWidth'}-$characterCount;
         $spacesNeeded -= 3;          $spacesNeeded -= 3;
         $Str .= (' 'x$spacesNeeded);          $Str .= (' 'x$spacesNeeded);
Line 215  sub FormatStudentData { Line 346  sub FormatStudentData {
         $Str .= $spacePadding;          $Str .= $spacePadding;
     }      }
   
     $Str .= '<font color="#000088">'.$problemsSolved.      # Output the total correct problems over the total number of problems.
     ' / '.$totalProblems.'</font></pre>';      # 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><br>';
   
     untie(%CacheData);      untie(%CacheData);
     return $Str;      return $Str;
 }  }
   
   =pod
   
   =item &CreateTableHeadings()
   
   This function generates the column headings for the chart.
   
   =over 4
   
   Inputs: $CacheData, $studentInformation, $headings, $spacePadding
   
   $CacheData: pointer to a hash tied to the cached data database
   
   $studentInformation: a pointer to an array containing the names of the data 
   held in a column and is used as part of a key into $CacheData
   
   $headings: The names of the headings for the student information
   
   $spacePadding: The spaces to go between columns
   
   Output: $Str
   
   $Str: A formatted string of the table column headings.
   
   =back
   
   =cut
   
 sub CreateTableHeadings {  sub CreateTableHeadings {
     my ($CacheData,$studentInformation,$headings,$reselected,$spacePadding)=@_;      my ($CacheData,$studentInformation,$headings,$spacePadding)=@_;
     my $Str='<pre>';      my $Str='<tr>';
   
     for(my $index=0; $index<(scalar @$headings); $index++) {      for(my $index=0; $index<(scalar @$headings); $index++) {
         if(!&ShouldShowColumn($reselected, 'heading', $index)) {          if(!&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) {
             next;              next;
         }          }
   
           $Str .= '<td align="left"><pre>';
  my $data=$$headings[$index];   my $data=$$headings[$index];
  $Str .= $data;   $Str .= $data;
   
Line 239  sub CreateTableHeadings { Line 403  sub CreateTableHeadings {
  $Str .= (' 'x($CacheData->{$$studentInformation[$index].'Length'}-   $Str .= (' 'x($CacheData->{$$studentInformation[$index].'Length'}-
                       $length));                        $length));
  $Str .= $spacePadding;   $Str .= $spacePadding;
           $Str .= '</pre></td>';
     }      }
   
     foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {      foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {
         if(!&ShouldShowColumn($reselected, 'sequence', $sequence)) {          if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) {
             next;              next;
         }          }
   
           $Str .= '<td align="left"><pre>';
         my $name = $CacheData->{$sequence.':title'};          my $name = $CacheData->{$sequence.':title'};
  $Str .= $name;   $Str .= $name;
  my @titleLength=split(//,$CacheData->{$sequence.':title'});   my @titleLength=split(//,$CacheData->{$sequence.':title'});
Line 253  sub CreateTableHeadings { Line 419  sub CreateTableHeadings {
                      (scalar @titleLength);                       (scalar @titleLength);
  $Str .= (' 'x$leftover);   $Str .= (' 'x$leftover);
  $Str .= $spacePadding;   $Str .= $spacePadding;
           $Str .= '</pre></td>';
     }      }
   
     $Str .= 'Total Solved/Total Problems';      $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';
     $Str .= '</pre>';      $Str .= '</tr>';
   
     return $Str;      return $Str;
 }  }
   
   =pod
   
   =item &CreateColumnSelectionBox()
   
   If there are columns not being displayed then this selection box is created
   with a list of those columns.  When selections are made and the page 
   refreshed, the columns will be removed from this box and the column is
   put back in the chart.  If there is no columns to select, no row is added
   to the interface table.
   
   =over 4
   Input: $CacheData, $headings
   
   
   $CacheData: A pointer to a hash tied to the cached data
   
   $headings:  An array of the names of the columns for the student information.  
   They are used for displaying which columns are missing.
   
   Output: $notThere
   
   $notThere: The string contains one row of a table.  The first column has the 
   name of the selection box.  The second contains the selection box 
   which has a size of four.
   
   =back
   
   =cut
   
 sub CreateColumnSelectionBox {  sub CreateColumnSelectionBox {
     my ($CacheData,$studentInformation,$headings,$reselected,$spacePadding)=@_;      my ($CacheData,$headings)=@_;
   
     my $missing=0;      my $missing=0;
     my $notThere='<br><br><b>Select column to view:</b><br><br>';      my $notThere='<tr><td align="right"><b>Select column to view:</b>';
     my $name;      my $name;
     $notThere .= '&nbsp;&nbsp;&nbsp';      $notThere .= '<td align="left">';
     $notThere .= '<select name="reselect" size="4" multiple="true">'."\n";      $notThere .= '<select name="ChartReselect" size="4" multiple="true">'."\n";
   
     for(my $index=0; $index<(scalar @$headings); $index++) {      for(my $index=0; $index<(scalar @$headings); $index++) {
         if(&ShouldShowColumn($reselected, 'heading', $index)) {          if(&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) {
             next;              next;
         }          }
         $name = $headings->[$index];          $name = $headings->[$index];
         $notThere .= '<option value="heading'.$index.'">';          $notThere .= '<option value="ChartHeading'.$index.'">';
         $notThere .= $name.'</option>'."\n";          $notThere .= $name.'</option>'."\n";
         $missing++;          $missing++;
     }      }
   
     foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {      foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {
         if(&ShouldShowColumn($reselected, 'sequence', $sequence)) {          if(&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) {
             next;              next;
         }          }
         $name = $CacheData->{$sequence.':title'};          $name = $CacheData->{$sequence.':title'};
         $notThere .= '<option value="sequence'.$sequence.'">';          $notThere .= '<option value="ChartSequence'.$sequence.'">';
         $notThere .= $name.'</option>'."\n";          $notThere .= $name.'</option>'."\n";
         $missing++;          $missing++;
     }      }
   
     if($missing) {      if($missing) {
         $notThere .= '</select><br><br>';          $notThere .= '</select>';
     } else {      } else {
         $notThere='';          $notThere='<tr><td>';
     }      }
   
     return $notThere;      return $notThere.'</td></tr>';
 }  }
   
   =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 {  sub CreateColumnSelectors {
     my ($CacheData,$studentInformation,$headings,$reselected,$spacePadding)=@_;      my ($CacheData,$headings)=@_;
   
     my $found=0;      my $found=0;
     my ($name, $length, $position);      my ($name, $length, $position);
     my $present='<pre>';  
       my $present = '<tr>';
     for(my $index=0; $index<(scalar @$headings); $index++) {      for(my $index=0; $index<(scalar @$headings); $index++) {
         if(!&ShouldShowColumn($reselected, 'heading', $index)) {          if(!&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) {
             next;              next;
         }          }
         $name = $headings->[$index];          $present .= '<td align="left">';
         $length=$CacheData->{$$studentInformation[$index].'Length'};  
         $position=int($length/2);  
  $present .= (' 'x($position));  
         $present .= '<input type="checkbox" checked="on" ';          $present .= '<input type="checkbox" checked="on" ';
         $present .= 'name="heading'.$index.'">';          $present .= 'name="ChartHeading'.$index.'" />';
         $position+=2;          $present .= '</td>';
  $present .= (' 'x($length-$position));  
  $present .= $spacePadding;  
         $found++;          $found++;
     }      }
   
     foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {      foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) {
         if(!&ShouldShowColumn($reselected, 'sequence', $sequence)) {          if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) {
             next;              next;
         }          }
         $name = $CacheData->{$sequence.':title'};          $present .= '<td align="left">';
         $length=$CacheData->{$sequence.':columnWidth'};  
         $position=int($length/2);  
  $present .= (' 'x($position));  
         $present .= '<input type="checkbox" checked="on" ';          $present .= '<input type="checkbox" checked="on" ';
         $present .= 'name="sequence'.$sequence.'">';          $present .= 'name="ChartSequence'.$sequence.'" />';
         $position+=2;          $present .= '</td>';
  $present .= (' 'x($length-$position));  
  $present .= $spacePadding;  
         $found++;          $found++;
     }      }
   
     if($found) {      if(!$found) {
         $present .= '</pre>';  
         $present  = $present;  
     } else {  
         $present = '';          $present = '';
     }      }
   
     return $present.'</form>'."\n";;      return $present.'<td></td></tr></form>'."\n";;
 }  }
   
   =pod
   
   =item &CreateForm()
   
   The interface for this module consists primarily of the controls in this
   function.  The student status selection (active, expired, any) is set here.
   The sort buttons: username, last name, and section are set here.  The
   other buttons are Recalculate Chart, Refresh Chart, and Reset Selections.
   These controls are in a table to clean up the interface.
   
   =over 4
   
   Input: $CacheData
   
   $CacheData is a hash pointer to tied database for cached data.
   
   Output: $Ptr
   
   $Ptr is a string containing all the html for the above mentioned buttons.
   
   =back
   
   =cut
   
 sub CreateForm {  sub CreateForm {
       my ($CacheData)=@_;
     my $OpSel1='';      my $OpSel1='';
     my $OpSel2='';      my $OpSel2='';
     my $OpSel3='';      my $OpSel3='';
     my $Status = $ENV{'form.status'};      my $Status = $CacheData->{'form.ChartStatus'};
     if ( $Status eq 'Any' ) { $OpSel3='selected'; }      if ( $Status eq 'Any' ) { $OpSel3='selected'; }
     elsif ($Status eq 'Expired' ) { $OpSel2 = 'selected'; }      elsif ($Status eq 'Expired' ) { $OpSel2 = 'selected'; }
     else { $OpSel1 = 'selected'; }      else { $OpSel1 = 'selected'; }
   
     my $Ptr = '<form name="stat" method="post" action="/adm/chart" >'."\n";      my $Ptr .= '<form name="ChartStat" method="post" action="/adm/chart" >';
     $Ptr .= '<input type="submit" name="sort" value="Recalculate Chart"/>';  
     $Ptr .= "\n";      $Ptr .= "\n";
       $Ptr .= '<tr><td align="right">';
       $Ptr .= '</td><td align="left">';
       $Ptr .= '<input type="submit" name="ChartRecalculate" ';
       $Ptr .= 'value="Recalculate Chart"/>'."\n";
     $Ptr .= '&nbsp;&nbsp;&nbsp;';      $Ptr .= '&nbsp;&nbsp;&nbsp;';
     $Ptr .= '<input type="submit" name="refresh" value="Refresh Chart"/>';      $Ptr .= '<input type="submit" name="ChartRefresh" ';
     $Ptr .= "\n";      $Ptr .= 'value="Refresh Chart"/>'."\n";
     $Ptr .= '<br><br>';  
     $Ptr .= '<b> Sort by: &nbsp; </b>'."\n";  
     $Ptr .= '&nbsp;&nbsp;&nbsp;';      $Ptr .= '&nbsp;&nbsp;&nbsp;';
     $Ptr .= '<input type="submit" name="sort" value="User Name" />'."\n";      $Ptr .= '<input type="submit" name="ChartReset" ';
       $Ptr .= 'value="Reset Selections"/></td>'."\n";
       $Ptr .= '</tr><tr><td align="right">';
       $Ptr .= '<b> Sort by: </b>'."\n";
       $Ptr .= '</td><td align="left">';
       $Ptr .= '<input type="submit" name="ChartSort" value="User Name" />'."\n";
     $Ptr .= '&nbsp;&nbsp;&nbsp;';      $Ptr .= '&nbsp;&nbsp;&nbsp;';
     $Ptr .= '<input type="submit" name="sort" value="Last Name" />'."\n";      $Ptr .= '<input type="submit" name="ChartSort" value="Last Name" />'."\n";
     $Ptr .= '&nbsp;&nbsp;&nbsp;';      $Ptr .= '&nbsp;&nbsp;&nbsp;';
     $Ptr .= '<input type="submit" name="sort" value="Section"/>'."\n";      $Ptr .= '<input type="submit" name="ChartSort" value="Section"/>'."\n";
     $Ptr .= '<br><br>';      $Ptr .= '</td></tr><tr><td align="right">';
     $Ptr .= '<b> Student Status: &nbsp; </b>'."\n".      $Ptr .= '<b> Student Status: &nbsp; </b>'."\n".
             '&nbsp;&nbsp;&nbsp;'.              '</td><td align="left">'.
             '<select name="status">'.               '<select name="ChartStatus">'. 
             '<option '.$OpSel1.' >Active</option>'."\n".              '<option '.$OpSel1.' >Active</option>'."\n".
             '<option '.$OpSel2.' >Expired</option>'."\n".              '<option '.$OpSel2.' >Expired</option>'."\n".
     '<option '.$OpSel3.' >Any</option> </select> '."\n";      '<option '.$OpSel3.' >Any</option> </select> '."\n";
       $Ptr .= '</td></tr>';
   
     return $Ptr;      return $Ptr;
 }  }
   
   =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
   
 sub CreateLegend {  sub CreateLegend {
     my $Str = '<h1>'.$ENV{'course.'.$ENV{'request.course.id'}.'.description'}.      my $Str = "<p><pre>".
               '</h1><h3>'.localtime().                "1..9: correct by student in 1..9 tries\n".
               "</h3><p><pre>1..9: correct by student in 1..9 tries\n".  
               "   *: correct by student in more than 9 tries\n".                "   *: correct by student in more than 9 tries\n".
       "   +: correct by override\n".        "   +: correct by override\n".
               "   -: incorrect by override\n".                "   -: incorrect by override\n".
       "   .: incorrect attempted\n".        "   .: incorrect attempted\n".
       "   #: ungraded attempted\n".        "   #: ungraded attempted\n".
               "    : not attempted\n".                "    : not attempted\n".
       "   x: excused</pre><p>";         "   x: excused".
                 "</pre><p>"; 
     return $Str;      return $Str;
 }  }
   
   =pod
   
   =item &StartDocument()
   
   Returns a string containing the header information for the chart: title,
   logo, and course title.
   
   =cut
   
 sub StartDocument {  sub StartDocument {
       my ($title, $header)=@_;
     my $Str = '';      my $Str = '';
     $Str .= '<html>';      $Str .= '<html>';
     $Str .= '<head><title>';      $Str .= '<head><title>';
     $Str .= 'LON-CAPA Assessment Chart</title></head>';      $Str .= $title.'</title></head>';
     $Str .= '<body bgcolor="#FFFFFF">';      $Str .= '<body bgcolor="#FFFFFF">';
     $Str .= '<script>window.focus();</script>';      $Str .= '<script>window.focus();</script>';
     $Str .= '<img align=right src=/adm/lonIcons/lonlogos.gif>';      $Str .= '<img align=right src=/adm/lonIcons/lonlogos.gif>';
     $Str .= '<h1>Assessment Chart</h1>';      $Str .= '<h1>'.$header.'</h1>';
       $Str .= '<h1>'.$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       $Str .= '</h1>';
   
     return $Str;      return $Str;
 }  }
   
 # ----- END FORMAT PRINT DATA ------------------------------------------  # ----- END FORMAT PRINT DATA ------------------------------------------
   
 # ----- DOWNLOAD INFORMATION -------------------------------------------  =pod
   
 sub DownloadPrerequisiteData {  =head1 HELPER FUNCTIONS
     my ($courseID, $c)=@_;  
     my ($courseDomain,$courseNumber)=split(/\_/,$courseID);  
   
     my %classlist=&Apache::lonnet::dump('classlist',$courseDomain,  These are just a couple of functions do various odd and end 
                                         $courseNumber);  jobs.
     my ($checkForError)=keys (%classlist);  
     if($checkForError =~ /^(con_lost|error|no_such_host)/i) {  
         return \%classlist;  
     }  
   
     foreach my $name (keys(%classlist)) {  =cut
         if($c->aborted()) {  
             $classlist{'error'}='aborted';  
             return \%classlist;  
         }  
   
         my ($studentName,$studentDomain) = split(/\:/,$name);  # ----- HELPER FUNCTIONS -----------------------------------------------
         # Download student environment data, specifically the full name and id.  
         my %studentInformation=&Apache::lonnet::get('environment',  
                                                     ['lastname','generation',  
                                                      'firstname','middlename',  
                                                      'id'],  
                                                     $studentDomain,  
                                                     $studentName);  
         $classlist{$name.':studentInformation'}=\%studentInformation;  
   
         if($c->aborted()) {  =pod
             $classlist{'error'}='aborted';  
             return \%classlist;  
         }  
   
         #Section  =item &ProcessFormData()
         my %section=&Apache::lonnet::dump('roles',$studentDomain,$studentName);  
         $classlist{$name.':section'}=\%section;  
     }  
   
     return \%classlist;  Cache form data and set default form data (sort, status, heading.$number,
 }  sequence.$number, reselect, reset, recalculate, and refresh)
   
 sub DownloadStudentCourseInformation {  =over 4
     my ($name,$courseID)=@_;  
     my ($studentName,$studentDomain) = split(/\:/,$name);  
   
     # Download student course data  
     my %courseData=&Apache::lonnet::dump($courseID,$studentDomain,  
  $studentName);  
     return \%courseData;  
 }  
   
 # ----- END DOWNLOAD INFORMATION ---------------------------------------  Input: $ChartDB, $isCached
   
 # ----- END PROCESSING FUNCTIONS ---------------------------------------  $ChartDB: The name of the database for cached data
   
 sub ProcessTopResourceMap {  $isCached: Is there already data for this course cached.  This is used in 
     my ($ChartDB,$c)=@_;  conjunction with the absence of all form data to know to display all selection 
     my %hash;  types.
     my $fn=$ENV{'request.course.fn'};  
     if(-e "$fn.db") {  
  my $tieTries=0;  
  while($tieTries < 3) {  
     if(tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER,0640)) {  
  last;  
     }  
     $tieTries++;  
     sleep 1;  
  }  
  if($tieTries >= 3) {  
             return 'Coursemap undefined.';  
         }  
     } else {  
         return 'Can not open Coursemap.';  
     }  
   
     my %CacheData;  Output: None
     unless(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  
         untie(%hash);  
  return 'Could not tie cache hash.';  
     }  
   
     my (@sequences, @currentResource, @finishResource);  =back
     my ($currentSequence, $currentResourceID, $lastResourceID);  
   
     $currentResourceID=$hash{'ids_/res/'.$ENV{'request.course.uri'}};  =cut
     push(@currentResource, $currentResourceID);  
     $lastResourceID=-1;  
     $currentSequence=-1;  
     my $topLevelSequenceNumber = $currentSequence;  
   
     while(1) {  # For all data, if ENV data doesn't exist for it, default values is used.
         if($c->aborted()) {  sub ProcessFormData {
             last;      my ($ChartDB, $isCached)=@_;
       my %CacheData;
   
       if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
           # Ignore $ENV{'form.ChartRefresh'}
           # Ignore $ENV{'form.ChartRecalculate'}
   
           if(defined($ENV{'form.ChartSort'})) {
               $CacheData{'form.ChartSort'}=$ENV{'form.ChartSort'};
           } elsif(!defined($CacheData{'form.ChartSort'})) {
               $CacheData{'form.ChartSort'}='username';
           }
   
           if(defined($ENV{'form.ChartStatus'})) {
               $CacheData{'form.ChartStatus'}=$ENV{'form.ChartStatus'};
           } elsif(!defined($CacheData{'form.ChartStatus'})) {
               $CacheData{'form.ChartStatus'}='Active';
           }
   
           # $found checks for any instances of form data in the ENV.  If it is
           # missing I assume the chrt button on the remote has been pressed.
           my @headings=();
           my @sequences=();
           my $found=0;
           foreach (keys(%ENV)) {
               if(/form\.ChartHeading/) {
                   $found++;
                   push(@headings, $_);
               } elsif(/form\.ChartSequence/) {
                   $found++;
                   push(@sequences, $_);
               } elsif(/form\./) {
                   $found++;
               }
         }          }
  # HANDLE NEW SEQUENCE!  
  #if page || sequence  
  if(defined($hash{'map_pc_'.$hash{'src_'.$currentResourceID}})) {  
     push(@sequences, $currentSequence);  
     push(@currentResource, $currentResourceID);  
     push(@finishResource, $lastResourceID);  
   
     $currentSequence=$hash{'map_pc_'.$hash{'src_'.$currentResourceID}};  
     $lastResourceID=$hash{'map_finish_'.  
   $hash{'src_'.$currentResourceID}};  
     $currentResourceID=$hash{'map_start_'.  
      $hash{'src_'.$currentResourceID}};  
   
     if(!($currentResourceID) || !($lastResourceID)) {  
  $currentSequence=pop(@sequences);  
  $currentResourceID=pop(@currentResource);  
  $lastResourceID=pop(@finishResource);  
  if($currentSequence eq $topLevelSequenceNumber) {  
     last;  
  }  
     }  
  }  
   
  # Handle gradable resources: exams, problems, etc          if($found) {
  $currentResourceID=~/(\d+)\.(\d+)/;              $CacheData{'form.ChartHeadings'}=join(":::",@headings);
         my $partA=$1;              $CacheData{'form.ChartSequences'}=join(":::",@sequences);
         my $partB=$2;          }
  if($hash{'src_'.$currentResourceID}=~  
    /\.(problem|exam|quiz|assess|survey|form)$/ &&  
    $partA eq $currentSequence) {  
     my $Problem = &Apache::lonnet::symbclean(  
   &Apache::lonnet::declutter($hash{'map_id_'.$partA}).  
   '___'.$partB.'___'.  
   &Apache::lonnet::declutter($hash{'src_'.  
  $currentResourceID}));  
   
     $CacheData{$currentResourceID.':problem'}=$Problem;  
     if(!defined($CacheData{$currentSequence.':problems'})) {  
  $CacheData{$currentSequence.':problems'}=$currentResourceID;  
     } else {  
  $CacheData{$currentSequence.':problems'}.=  
     ':'.$currentResourceID;  
     }  
   
             #Get Parts for problem  
     my $meta=$hash{'src_'.$currentResourceID};  
     foreach (split(/\,/,&Apache::lonnet::metadata($meta,'keys'))) {  
  if($_=~/^stores\_(\d+)\_tries$/) {  
     my $Part=&Apache::lonnet::metadata($meta,$_.'.part');  
                     if(!defined($CacheData{$currentSequence.':'.  
                                           $currentResourceID.':parts'})) {  
                         $CacheData{$currentSequence.':'.$currentResourceID.  
                                    ':parts'}=$Part;  
                     } else {  
                         $CacheData{$currentSequence.':'.$currentResourceID.  
                                    ':parts'}.=':'.$Part;  
                     }  
  }  
     }  
  }  
   
  #if resource == finish resource          if(defined($ENV{'form.ChartReselect'})) {
  if($currentResourceID eq $lastResourceID) {              my @reselected = (ref($ENV{'form.ChartReselect'}) ? 
     #pop off last resource of sequence                                @{$ENV{'form.ChartReselect'}}
     $currentResourceID=pop(@currentResource);                                : ($ENV{'form.ChartReselect'}));
     $lastResourceID=pop(@finishResource);              foreach (@reselected) {
                   if(/ChartHeading/) {
     if(defined($CacheData{$currentSequence.':problems'})) {                      $CacheData{'form.ChartHeadings'}.=":::".$_;
  # Capture sequence information here                  } elsif(/ChartSequence/) {
  if(!defined($CacheData{'orderedSequences'})) {                      $CacheData{'form.ChartSequences'}.=":::".$_;
     $CacheData{'orderedSequences'}=$currentSequence;  
  } else {  
     $CacheData{'orderedSequences'}.=':'.$currentSequence;  
  }  
   
  $CacheData{$currentSequence.':title'}=  
     $hash{'title_'.$currentResourceID};  
   
                 my $totalProblems=0;  
                 foreach my $currentProblem (split(/\:/,  
                                                $CacheData{$currentSequence.  
                                                ':problems'})) {  
                     foreach (split(/\:/,$CacheData{$currentSequence.':'.  
                                                    $currentProblem.  
                                                    ':parts'})) {  
                         $totalProblems++;  
                     }  
                 }                  }
  my @titleLength=split(//,$CacheData{$currentSequence.              }
                                                     ':title'});          }
                 # $extra is 3 for problems correct and 3 for space  
                 # between problems correct and problem output  
                 my $extra = 6;  
  if(($totalProblems + $extra) > (scalar @titleLength)) {  
     $CacheData{$currentSequence.':columnWidth'}=  
                         $totalProblems + $extra;  
  } else {  
     $CacheData{$currentSequence.':columnWidth'}=  
                         (scalar @titleLength);  
  }  
     }  
   
     $currentSequence=pop(@sequences);  
     if($currentSequence eq $topLevelSequenceNumber) {  
  last;  
     }  
  #else  
  }  
   
  # MOVE!!!  
  #move to next resource  
  unless(defined($hash{'to_'.$currentResourceID})) {  
     # big problem, need to handle.  Next is probably wrong  
     last;  
  }  
  my @nextResources=();  
  foreach (split(/\,/,$hash{'to_'.$currentResourceID})) {  
     push(@nextResources, $hash{'goesto_'.$_});  
  }  
  push(@currentResource, @nextResources);  
  # Set the next resource to be processed  
  $currentResourceID=pop(@currentResource);  
     }  
   
     unless (untie(%hash)) {          # !$found and !$isCached are how I determine if the chrt button
         &Apache::lonnet::logthis("<font color=blue>WARNING: ".          # on the remote was pressed and needs to reset all the selections
                                  "Could not untie coursemap $fn (browse)".          if(defined($ENV{'form.ChartReset'}) || (!$found && !$isCached)) {
                                  ".</font>");               $CacheData{'form.ChartReset'}='true';
     }              $CacheData{'form.ChartStatus'}='Active';
               $CacheData{'form.ChartSort'}='username';
               $CacheData{'form.ChartHeadings'}='ALLHEADINGS';
               $CacheData{'form.ChartSequences'}='ALLSEQUENCES';
           } else {
               $CacheData{'form.ChartReset'}='false';
           }
   
     unless (untie(%CacheData)) {          untie(%CacheData);
         &Apache::lonnet::logthis("<font color=blue>WARNING: ".  
                                  "Could not untie Cache Hash (browse)".  
                                  ".</font>");   
     }      }
   
     return 'OK';      return;
 }  }
   
 sub ProcessSection {  =pod
     my ($sectionData, $courseid,$ActiveFlag)=@_;  
     $courseid=~s/\_/\//g;  
     $courseid=~s/^(\w)/\/$1/;  
   
     my $cursection='-1';  
     my $oldsection='-1';  
     my $status='Expired';  
     my $section='';  
     foreach my $key (keys (%$sectionData)) {  
  my $value = $sectionData->{$key};  
         if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {  
     $section=$1;  
     if($key eq $courseid.'_st') {  
  $section='';  
     }  
     my ($dummy,$end,$start)=split(/\_/,$value);  
     my $now=time;  
     my $notactive=0;  
     if ($start) {  
  if($now<$start) {  
     $notactive=1;  
  }  
     }  
     if($end) {  
  if ($now>$end) {  
     $notactive=1;  
  }  
     }  
     if($notactive == 0) {  
  $status='Active';  
  $cursection=$section;  
  last;  
     }  
     if($notactive == 1) {  
  $oldsection=$section;  
     }  
  }  
     }  
     if($status eq $ActiveFlag) {  
  if($cursection eq '-1') {  
     return $oldsection;  
  }  
  return $cursection;  
     }  
     if($ActiveFlag eq 'Any') {  
  if($cursection eq '-1') {  
     return $oldsection;  
  }  
  return $cursection;  
     }  
     return '-1';  
 }  
   
 sub ProcessStudentInformation {  =item &SpaceColumns()
     my ($CacheData,$studentInformation,$section,$date,$name,$courseID,$c)=@_;  
     my ($studentName,$studentDomain) = split(/\:/,$name);  
   
     $CacheData->{$name.':username'}=$studentName;  
     $CacheData->{$name.':domain'}=$studentDomain;  
     $CacheData->{$name.':date'}=$date;  
   
     my ($checkForError)=keys(%$studentInformation);  
     if($checkForError =~ /^(con_lost|error|no_such_host)/i) {  
  $CacheData->{$name.':error'}=  
     'Could not download student environment data.';  
  $CacheData->{$name.':fullname'}='';  
  $CacheData->{$name.':id'}='';  
     } else {  
  $CacheData->{$name.':fullname'}=&ProcessFullName(  
                                           $studentInformation->{'lastname'},  
           $studentInformation->{'generation'},  
           $studentInformation->{'firstname'},  
                                           $studentInformation->{'middlename'});  
  $CacheData->{$name.':id'}=$studentInformation->{'id'};  
     }  
   
     # Get student's section number  Determines the width of all the columns in the chart.  It is based on
     my $sec=&ProcessSection($section, $courseID, $ENV{'form.status'});  the max of the data for that column and its header.
     if($sec != -1) {  
  $CacheData->{$name.':section'}=$sec;  
     } else {  
  $CacheData->{$name.':section'}='';  
     }  
   
     return 0;  =over 4
 }  
   
 sub ProcessClassList {  Input: $students, $studentInformation, $headings, $ChartDB
     my ($classlist,$courseID,$ChartDB,$c)=@_;  
     my @names=();  
   
     my %CacheData;  $students: An array pointer to a list of students (username:domain)
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  
         foreach my $name (keys(%$classlist)) {  
             if($name =~ /\:section/ || $name =~ /\:studentInformation/ ||  
                $name eq '') {  
                 next;  
             }  
             if($c->aborted()) {  
                 last;  
             }  
             push(@names,$name);  
             &ProcessStudentInformation(  
                                     \%CacheData,  
                                     $classlist->{$name.':studentInformation'},  
                                     $classlist->{$name.':section'},  
                                     $classlist->{$name},  
                                     $name,$courseID,$c);  
         }  
   
  untie(%CacheData);  $studentInformatin: The type of data for the student information.  It is
     }  used as part of the key in $CacheData.
   
     return @names;  $headings: The name of the student information columns.
 }  
   
 # ----- END PROCESSING FUNCTIONS ---------------------------------------  $ChartDB: The name of the cache database which is opened for read/write.
   
 # ----- HELPER FUNCTIONS -----------------------------------------------  Output: None - All data stored in cache.
   
   =back
   
   =cut
   
 sub SpaceColumns {  sub SpaceColumns {
     my ($students,$studentInformation,$headings,$ChartDB)=@_;      my ($students,$studentInformation,$headings,$cache)=@_;
   
     my %CacheData;      # Initialize Lengths
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {      for(my $index=0; $index<(scalar @$headings); $index++) {
         # Initialize Lengths          my @titleLength=split(//,$$headings[$index]);
         for(my $index=0; $index<(scalar @$headings); $index++) {          $cache->{$$studentInformation[$index].'Length'}=
     my @titleLength=split(//,$$headings[$index]);              scalar @titleLength;
     $CacheData{$$studentInformation[$index].'Length'}=      }
                 scalar @titleLength;  
  }  
   
         foreach my $name (@$students) {      foreach my $name (@$students) {
             foreach (@$studentInformation) {          foreach (@$studentInformation) {
  my @dataLength=split(//,$CacheData{$name.':'.$_});              my @dataLength=split(//,$cache->{$name.':'.$_});
  my $length=scalar @dataLength;              my $length=scalar @dataLength;
  if($length > $CacheData{$_.'Length'}) {              if($length > $cache->{$_.'Length'}) {
     $CacheData{$_.'Length'}=$length;                  $cache->{$_.'Length'}=$length;
  }  
             }              }
         }          }
         untie(%CacheData);  
     }      }
   
     return;      return;
 }  }
   
 sub ProcessFullName {  =pod
     my ($lastname, $generation, $firstname, $middlename)=@_;  
     my $Str = '';  
   
     if($lastname ne '') {  =item &SortStudents()
  $Str .= $lastname.' ';  
  if($generation ne '') {  
     $Str .= $generation;  
  } else {  
     chop($Str);  
  }  
  $Str .= ', ';  
  if($firstname ne '') {  
     $Str .= $firstname.' ';  
  }  
  if($middlename ne '') {  
     $Str .= $middlename;  
  } else {  
     chop($Str);  
     if($firstname eq '') {  
  chop($Str);  
     }  
  }  
     } else {  
  if($firstname ne '') {  
     $Str .= $firstname.' ';  
  }  
  if($middlename ne '') {  
     $Str .= $middlename.' ';  
  }  
  if($generation ne '') {  
     $Str .= $generation;  
  } else {  
     chop($Str);  
  }  
     }  
   
     return $Str;  Determines which students to display and in which order.  Which are 
 }  displayed are determined by their status(active/expired).  The order
   is determined by the sort button pressed (default to username).  The
   type of sorting is username, lastname, or section.
   
   =over 4
   
   Input: $students, $CacheData
   
   $students: A array pointer to a list of students (username:domain)
   
   $CacheData: A pointer to the hash tied to the cached data
   
   Output: @order
   
   @order: An ordered list of students (username:domain)
   
   =back
   
   =cut
   
 sub SortStudents {  sub SortStudents {
     my ($students,$CacheData)=@_;      my ($students,$CacheData)=@_;
Line 840  sub SortStudents { Line 864  sub SortStudents {
         my ($end,$start)=split(/\:/,$CacheData->{$_.':date'});          my ($end,$start)=split(/\:/,$CacheData->{$_.':date'});
         my $active=1;          my $active=1;
         my $now=time;          my $now=time;
         my $Status=$ENV{'form.status'};          my $Status=$CacheData->{'form.ChartStatus'};
         $Status = ($Status) ? $Status : 'Active';          $Status = ($Status) ? $Status : 'Active';
         if((($end) && $now > $end) && (($Status eq 'Active'))) {           if((($end) && $now > $end) && (($Status eq 'Active'))) { 
             $active=0;               $active=0; 
Line 853  sub SortStudents { Line 877  sub SortStudents {
         }          }
     }      }
   
     my $Pos = $ENV{'form.sort'};      my $Pos = $CacheData->{'form.ChartSort'};
     my %sortData;      my %sortData;
     if($Pos eq 'Last Name') {      if($Pos eq 'Last Name') {
  for(my $index=0; $index<scalar @sorted1Students; $index++) {   for(my $index=0; $index<scalar @sorted1Students; $index++) {
Line 880  sub SortStudents { Line 904  sub SortStudents {
     return @order;      return @order;
 }  }
   
 sub TestCacheData {  =pod
     my ($ChartDB)=@_;  
     my $isCached=-1;  
     my %testData;  
     my $tieTries=0;  
   
     if ((-e "$ChartDB") && ($ENV{'form.sort'} ne 'Recalculate Chart')) {  =item &ShouldShowColumn()
  $isCached = 1;  
     } else {  
  $isCached = 0;  
     }  
   
     while($tieTries < 3) {  Determine if a specified column should be shown on the chart.
         my $result=0;  
         if($isCached) {  
             $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_READER,0640);  
         } else {  
             $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_NEWDB,0640);  
         }  
         if($result) {  
             last;  
         }  
         $tieTries++;  
         sleep 1;  
     }  
     if($tieTries >= 3) {  
         return -1;  
     }  
   
     untie(%testData);  =over 4
   
     return $isCached;  Input: $cache, $test
 }  
   
 sub ExtractStudentData {  $cache: A pointer to the hash tied to the cached data
     my ($courseData, $name, $ChartDB)=@_;  
   
     my %CacheData;  $test: The form name of the column (heading.$headingIndex) or 
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  (sequence.$sequenceIndex)
         my ($checkForError) = keys(%$courseData);  
         if($checkForError =~ /^(con_lost|error|no_such_host)/i) {  
             $CacheData{$name.':error'}='Could not download course data.';  
         } else {  
             foreach my $key (keys (%$courseData)) {  
                 $CacheData{$name.':'.$key}=$courseData->{$key};  
             }  
             if(defined($CacheData{'NamesOfStudents'})) {  
                 $CacheData{'NamesOfStudents'}.=':::'.$name;  
             } else {  
                 $CacheData{'NamesOfStudents'}=$name;  
             }  
         }  
         untie(%CacheData);  
     }  
   
     return;  Output: 0 (false), 1 (true)
 }  
   =back
   
   =cut
   
 sub ShouldShowColumn {  sub ShouldShowColumn {
     my ($reselected,$type,$value)=@_;      my ($cache,$test)=@_;
   
     if($ENV{'form.sort'} eq 'Recalculate Chart') {      if($cache->{'form.ChartReset'} eq 'true') {
         return 1;          return 1;
     }      }
   
     if(defined($ENV{'form.'.$type.$value})) {      my $headings=$cache->{'form.ChartHeadings'};
       my $sequences=$cache->{'form.ChartSequences'};
       if($headings eq 'ALLHEADINGS' || $sequences eq 'ALLSEQUENCES' ||
          $headings=~/$test/ || $sequences=~/$test/) {
         return 1;          return 1;
     }      }
   
     return &CheckForStringInArray($reselected, $type.$value);  
 }  
   
 sub CheckForStringInArray {  
     my ($inputArray,$checkString)=@_;  
     foreach (@$inputArray) {  
 #        $jr->print('a:'.$_.' b:'.$checkString.'<br>');  
         if($_ eq $checkString) {  
             return 1;  
         }  
     }  
     return 0;      return 0;
 }  }
   
 # ----- END HELPER FUNCTIONS --------------------------------------------  # ----- END HELPER FUNCTIONS --------------------------------------------
   
   =pod
   
   =head1 Handler and main function(BuildChart)
   
   The handler does some initial error checking and then passes the torch to
   BuildChart.  BuildChart calls all the appropriate functions to get the
   job done.  These are the only two functions that use print ($r).  All other
   functions return strings to BuildChart to be printed.
   
   =cut
   
   =pod
   
   =item &BuildChart()
   
    The following is the process that BuildChart goes through to 
     create the html document.
   
    -Start the lonchart document
    -Test for access to the CacheData
    -Download class list information if not using cached data 
    -Sort students and print out table desciptive data
    -Output student data
    -If recalculating, store a list of students, but only if all 
     their data was downloaded.  Leave off the others.
    -End document
   
   =over 4
   
   Input: $r
   
   $r:  Used to print html
   
   Output: None
   
   =back
   
   =cut
   
 sub BuildChart {  sub BuildChart {
     my ($r)=@_;      my ($r)=@_;
     my $c = $r->connection;      my $c = $r->connection;
Line 972  sub BuildChart { Line 990  sub BuildChart {
     # Start the lonchart document      # Start the lonchart document
     $r->content_type('text/html');      $r->content_type('text/html');
     $r->send_http_header;      $r->send_http_header;
     $r->print(&StartDocument());      $r->print(&StartDocument('LON-CAPA Assessment Chart', 'Assessment Chart'));
     $r->rflush();      $r->rflush();
   
     # Test for access to the CacheData      # Test for access to the CacheData
Line 980  sub BuildChart { Line 998  sub BuildChart {
     my $cid=$ENV{'request.course.id'};      my $cid=$ENV{'request.course.id'};
     my $ChartDB = "/home/httpd/perl/tmp/$ENV{'user.name'}".      my $ChartDB = "/home/httpd/perl/tmp/$ENV{'user.name'}".
                   "_$ENV{'user.domain'}_$cid\_chart.db";                    "_$ENV{'user.domain'}_$cid\_chart.db";
     # $ENV{'form.domains'} can be either a scalar or an array reference.      my $isRecalculate=0;
     # We need an array.      if(defined($ENV{'form.ChartRecalculate'})) {
     my @reselected = (ref($ENV{'form.reselect'}) ? @{$ENV{'form.reselect'}}          $isRecalculate=1;
                       : ($ENV{'form.reselect'}));      }
       $isCached=&Apache::loncoursedata::TestCacheData($ChartDB, $isRecalculate);
     $isCached=&TestCacheData($ChartDB);  
     if($isCached < 0) {      if($isCached < 0) {
         $r->print("Unable to tie hash to db file");          $r->print("Unable to tie hash to db file</body></html>");
         $r->rflush();          $r->rflush();
         return;          return;
     }      }
       &ProcessFormData($ChartDB, $isCached);
   
     # Download class list information if not using cached data      # Download class list information if not using cached data
     my %CacheData;      my %CacheData;
Line 999  sub BuildChart { Line 1017  sub BuildChart {
     my @headings=('User Name','Domain','Section','PID','Full Name');      my @headings=('User Name','Domain','Section','PID','Full Name');
     my $spacePadding='   ';      my $spacePadding='   ';
     if(!$isCached) {      if(!$isCached) {
         my $processTopResourceMapReturn=&ProcessTopResourceMap($ChartDB,$c);          unless(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
               $r->print("Unable to tie hash to db file</body></html>");
               $r->rflush();
               return;
           }
   
           my $processTopResourceMapReturn=
               &Apache::loncoursedata::ProcessTopResourceMap(\%CacheData,$c);
         if($processTopResourceMapReturn ne 'OK') {          if($processTopResourceMapReturn ne 'OK') {
             $r->print($processTopResourceMapReturn);              $r->print($processTopResourceMapReturn.'</body></html>');
               untie(%CacheData);
               return;
           }
   
           if($c->aborted()) {
               untie(%CacheData);
               $r->print('</body></html>'); 
             return;              return;
         }          }
         if($c->aborted()) { return; }  
         my $classlist=&DownloadPrerequisiteData($cid, $c);          my $classlist=&Apache::loncoursedata::DownloadStudentNamePIDSection(
                                                                      $cid, $c);
         my ($checkForError)=keys(%$classlist);          my ($checkForError)=keys(%$classlist);
         if($checkForError =~ /^(con_lost|error|no_such_host)/i ||          if($checkForError =~ /^(con_lost|error|no_such_host)/i ||
            defined($classlist->{'error'})) {             defined($classlist->{'error'})) {
               $r->print("Error getting student data.</body></html>");
               $r->rflush();
               untie(%CacheData);
               return;
           }
   
           if($c->aborted()) {
               untie(%CacheData);
               $r->print('</body></html>'); 
               return;
           }
   
   
           @students=&Apache::loncoursedata::ProcessClassList(\%CacheData, 
                                                 $classlist, $cid, 
                                                 $CacheData{'form.ChartStatus'},
                                                 $c);
   
           if($c->aborted()) {
               untie(%CacheData);
               $r->print('</body></html>'); 
             return;              return;
         }          }
         if($c->aborted()) { return; }  
         @students=&ProcessClassList($classlist,$cid,$ChartDB,$c);  
         if($c->aborted()) { return; }  
         &SpaceColumns(\@students,\@studentInformation,\@headings,          &SpaceColumns(\@students,\@studentInformation,\@headings,
                       $ChartDB);                        \%CacheData);
         if($c->aborted()) { return; }  
           if($c->aborted()) {
               untie(%CacheData);
               $r->print('</body></html>'); 
               return;
           }
   
           untie(%CacheData);
     } else {      } else {
         if(!$c->aborted() && tie(%CacheData,'GDBM_File',$ChartDB,          if(!$c->aborted() && tie(%CacheData,'GDBM_File',$ChartDB,
                                  &GDBM_READER,0640)) {                                   &GDBM_READER,0640)) {
Line 1025  sub BuildChart { Line 1084  sub BuildChart {
     }      }
   
     # Sort students and print out table desciptive data      # Sort students and print out table desciptive data
       my $downloadTime=0;
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_READER,0640)) {      if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_READER,0640)) {
         if(!$c->aborted()) { @students=&SortStudents(\@students,\%CacheData); }          if(!$c->aborted()) { @students=&SortStudents(\@students,\%CacheData); }
  if(!$c->aborted()) { $r->print(&CreateLegend()); }          if(defined($CacheData{'time'})) { $downloadTime=$CacheData{'time'}; }
           else { $downloadTime=localtime(); }
           if(!$c->aborted()) { $r->print('<h3>'.$downloadTime.'</h3>'); }
           if(!$c->aborted()) { $r->print('<h1>'.(scalar @students).
                                          ' students</h1>'); }
  if(!$c->aborted()) { $r->rflush(); }   if(!$c->aborted()) { $r->rflush(); }
  if(!$c->aborted()) { $r->print(&CreateForm()); }   if(!$c->aborted()) { $r->print(&CreateLegend()); }
           if(!$c->aborted()) { $r->print('<table border="0"><tbody>'); }
    if(!$c->aborted()) { $r->print(&CreateForm(\%CacheData)); }
  if(!$c->aborted()) { $r->print(&CreateColumnSelectionBox(   if(!$c->aborted()) { $r->print(&CreateColumnSelectionBox(
                                                        \%CacheData,                                                         \%CacheData,
                                                        \@studentInformation,                                                          \@headings)); }
        \@headings,           if(!$c->aborted()) { $r->print('</tbody></table>'); }
                                                        \@reselected,          if(!$c->aborted()) { $r->print('<b>Note: Uncheck the boxes above a'); }
                                                        $spacePadding)); }          if(!$c->aborted()) { $r->print(' column to remove that column from'); }
         if(!$c->aborted()) { $r->print('<h3>'.(scalar @students).          if(!$c->aborted()) { $r->print(' the display.</b></pre>'); }
                                        ' students</h3>'); }          if(!$c->aborted()) { $r->print('<table border="0" cellpadding="0" '); }
           if(!$c->aborted()) { $r->print('cellspacing="0"><tbody>'); }
  if(!$c->aborted()) { $r->print(&CreateColumnSelectors(   if(!$c->aborted()) { $r->print(&CreateColumnSelectors(
                                                        \%CacheData,                                                         \%CacheData,
                                                        \@studentInformation,                                                          \@headings)); }
        \@headings,   
                                                        \@reselected,  
                                                        $spacePadding)); }  
  if(!$c->aborted()) { $r->print(&CreateTableHeadings(   if(!$c->aborted()) { $r->print(&CreateTableHeadings(
                                                          \%CacheData,                                                           \%CacheData,
                                                          \@studentInformation,                                                            \@studentInformation, 
  \@headings,    \@headings, 
                                                          \@reselected,  
  $spacePadding)); }   $spacePadding)); }
           if(!$c->aborted()) { $r->print('</tbody></table>'); }
  if(!$c->aborted()) { $r->rflush(); }   if(!$c->aborted()) { $r->rflush(); }
  untie(%CacheData);   untie(%CacheData);
     } else {      } else {
Line 1057  sub BuildChart { Line 1121  sub BuildChart {
  return;   return;
     }      }
   
       # Output student data
     my @updateStudentList = ();      my @updateStudentList = ();
     my $courseData;      my $courseData;
       $r->print('<pre>');
     foreach (@students) {      foreach (@students) {
         if($c->aborted()) {          if($c->aborted()) {
             if(!$isCached &&   
                tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  
                 $CacheData{'NamesOfStudents'}=join(":::", @updateStudentList);  
 #    $CacheData{'NamesOfStudents'}=  
 #            &Apache::lonnet::arrayref2str(\@updateStudentList);  
                 untie(%CacheData);  
             }  
             last;              last;
         }          }
   
         if(!$isCached) {          if(!$isCached) {
             $courseData=&DownloadStudentCourseInformation($_, $cid);              $courseData=
             if($c->aborted()) { next; }                  &Apache::loncoursedata::DownloadStudentCourseInformation($_, 
             push(@updateStudentList, $_);                                                                           $cid);
             &ExtractStudentData($courseData, $_, $ChartDB);              if($c->aborted()) { last; }
               if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
                   &Apache::loncoursedata::ProcessStudentData(\%CacheData, 
                                                              $courseData, $_);
                   push(@updateStudentList, $_);
                   untie(%CacheData);
               } else {
                   next;
               }
         }          }
         $r->print(&FormatStudentData(\@reselected, $_, $cid,           $r->print(&FormatStudentData($_, \@studentInformation,
                                      \@studentInformation,  
                                      $spacePadding, $ChartDB));                                       $spacePadding, $ChartDB));
         $r->rflush();          $r->rflush();
     }      }
   
     $r->print('</body></html>');      # If recalculating, store a list of students, but only if all their 
       # data was downloaded.  Leave off the others.
       if(!$isCached && tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
           $CacheData{'NamesOfStudents'}=join(":::", @updateStudentList);
   #    $CacheData{'NamesOfStudents'}=
   #            &Apache::lonnet::arrayref2str(\@updateStudentList);
           untie(%CacheData);
       }
   
       # End document
       $r->print('</pre></body></html>');
     $r->rflush();      $r->rflush();
   
     return;      return;
Line 1091  sub BuildChart { Line 1167  sub BuildChart {
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
   
   =pod
   
   =item &handler()
   
   The handler checks for permission to access the course data and for 
   initial header problem.  Then it passes the torch to the work horse
   function BuildChart.
   
   =over 4
   
   Input: $r
   
   $r: This is the object that is used to print.
   
   Output: A Value (OK or HTTP_NOT_ACCEPTABLE)
   
   =back
   
   =cut
   
 sub handler {  sub handler {
     my $r=shift;      my $r=shift;
     $jr=$r;  #    $jr=$r;
     unless(&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {      unless(&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
  $ENV{'user.error.msg'}=   $ENV{'user.error.msg'}=
         $r->uri.":vgr:0:0:Cannot view grades for complete course";          $r->uri.":vgr:0:0:Cannot view grades for complete course";
Line 1111  sub handler { Line 1207  sub handler {
         $r->send_http_header;          $r->send_http_header;
         return OK;          return OK;
     }      }
       
     unless($ENV{'request.course.fn'}) {      unless($ENV{'request.course.fn'}) {
         my $requrl=$r->uri;          my $requrl=$r->uri;
         $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";          $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
Removed from v.1.49  
changed lines
  Added in v.1.59

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