[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.54 and 1.58

version 1.54, 2002/07/03 14:11:14 version 1.58, 2002/07/08 16:50:03
Line 48 Line 48
   
 =pod  =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 five components: formatting data for printing,
   downloading data from servers, processing data, 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  =cut
   
 package Apache::lonchart;  package Apache::lonchart;
Line 60  use HTML::TokeParser; Line 109  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,$spacePadding)=@_;      my ($cache,$name,$studentInformation,$spacePadding)=@_;
     my $Str='';      my $Str='';
Line 83  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 ($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 126  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 138  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 152  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 175  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 200  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 212  sub FormatStudentData { Line 346  sub FormatStudentData {
         $Str .= $spacePadding;          $Str .= $spacePadding;
     }      }
   
       # Output the total correct problems over the total number of problems.
       # I don't like this type of formatting, but it is a solution.  Need
       # a way to dynamically determine the space requirements.
     my $outputProblemsSolved = sprintf( "%4d", $problemsSolved );      my $outputProblemsSolved = sprintf( "%4d", $problemsSolved );
     my $outputTotalProblems  = sprintf( "%4d", $totalProblems );      my $outputTotalProblems  = sprintf( "%4d", $totalProblems );
     $Str .= '<font color="#000088">'.$outputProblemsSolved.      $Str .= '<font color="#000088">'.$outputProblemsSolved.
Line 221  sub FormatStudentData { Line 358  sub FormatStudentData {
     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,$spacePadding)=@_;      my ($CacheData,$studentInformation,$headings,$spacePadding)=@_;
     my $Str='<tr>';      my $Str='<tr>';
Line 259  sub CreateTableHeadings { Line 423  sub CreateTableHeadings {
     }      }
   
     $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';      $Str .= '<td><pre>Total Solved/Total Problems</pre></td>';
     $Str .= '</tr></tbody></table>';      $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,$spacePadding)=@_;      my ($CacheData,$headings)=@_;
   
     my $missing=0;      my $missing=0;
     my $notThere='<tr><td align="right"><b>Select column to view:</b>';      my $notThere='<tr><td align="right"><b>Select column to view:</b>';
Line 299  sub CreateColumnSelectionBox { Line 492  sub CreateColumnSelectionBox {
         $notThere='<tr><td>';          $notThere='<tr><td>';
     }      }
   
     return $notThere.'</td></tr></tbody></table>';      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,$spacePadding)=@_;      my ($CacheData,$headings)=@_;
   
     my $found=0;      my $found=0;
     my ($name, $length, $position);      my ($name, $length, $position);
   
     my $present='<pre><b>Note: Uncheck the boxes above a column to ';      my $present = '<tr>';
     $present .= 'remove that column from the display.</b></pre>'."\n";  
   
     $present .= '<table border="0" cellpadding="0" cellspacing="0">';  
     $present .= '<tbody><tr>';  
     for(my $index=0; $index<(scalar @$headings); $index++) {      for(my $index=0; $index<(scalar @$headings); $index++) {
         if(!&ShouldShowColumn($CacheData, 'heading'.$index)) {          if(!&ShouldShowColumn($CacheData, 'heading'.$index)) {
             next;              next;
Line 342  sub CreateColumnSelectors { Line 557  sub CreateColumnSelectors {
     return $present.'<td></td></tr></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 ($CacheData)=@_;
     my $OpSel1='';      my $OpSel1='';
Line 353  sub CreateForm { Line 592  sub CreateForm {
     else { $OpSel1 = 'selected'; }      else { $OpSel1 = 'selected'; }
   
     my $Ptr .= '<form name="stat" method="post" action="/adm/chart" >'."\n";      my $Ptr .= '<form name="stat" method="post" action="/adm/chart" >'."\n";
     $Ptr .= '<table border="0"><tbody>';  
     $Ptr .= '<tr><td align="right">';      $Ptr .= '<tr><td align="right">';
     $Ptr .= '</td><td align="left">';      $Ptr .= '</td><td align="left">';
     $Ptr .= '<input type="submit" name="recalculate" ';      $Ptr .= '<input type="submit" name="recalculate" ';
Line 384  sub CreateForm { Line 622  sub CreateForm {
     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 = "<p><pre>".      my $Str = "<p><pre>".
               "1..9: correct by student in 1..9 tries\n".                "1..9: correct by student in 1..9 tries\n".
Line 398  sub CreateLegend { Line 646  sub CreateLegend {
     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 $Str = '';      my $Str = '';
     $Str .= '<html>';      $Str .= '<html>';
Line 415  sub StartDocument { Line 672  sub StartDocument {
   
 # ----- END FORMAT PRINT DATA ------------------------------------------  # ----- END FORMAT PRINT DATA ------------------------------------------
   
   =pod
   
   =head1 DOWNLOAD INFORMATION
   
   This section contains all the files that get data from other servers 
   and/or itself.  There is one function that has a call to get remote
   information but isn't included here which is ProcessTopLevelMap.  The
   usage was small enough to be ignored, but that portion may be moved
   here in the future.
   
   =cut
   
 # ----- DOWNLOAD INFORMATION -------------------------------------------  # ----- DOWNLOAD INFORMATION -------------------------------------------
   
   =pod
   
   =item &DownloadPrerequisiteData()
   
   Collects lastname, generation, middlename, firstname, PID, and section for each
   student from their environment database.  The list of students is built from
   collecting a classlist for the course that is to be displayed.
   
   =over 4
   
   Input: $courseID, $c
   
   $courseID:  The id of the course
   
   $c: The connection class that can determine if the browser has aborted.  It
   is used to short circuit this function so that it doesn't continue to 
   get information when there is no need.
   
   Output: \%classlist
   
   \%classlist: A pointer to a hash containing the following data:
   
   -A list of student name:domain (as keys) (known below as $name)
   
   -A hash pointer for each student containing lastname, generation, firstname,
   middlename, and PID : Key is $name.'studentInformation'
   
   -A hash pointer to each students section data : Key is $name.section
   
   =back
   
   =cut
   
 sub DownloadPrerequisiteData {  sub DownloadPrerequisiteData {
     my ($courseID, $c)=@_;      my ($courseID, $c)=@_;
     my ($courseDomain,$courseNumber)=split(/\_/,$courseID);      my ($courseDomain,$courseNumber)=split(/\_/,$courseID);
Line 457  sub DownloadPrerequisiteData { Line 759  sub DownloadPrerequisiteData {
     return \%classlist;      return \%classlist;
 }  }
   
   =pod
   
   =item &DownloadStudentCourseInformation()
   
   Dump of all the course information for a single student.  There is no
   pruning of data, it is all stored in a hash and returned.
   
   =over 4
   
   Input: $name, $courseID
   
   $name: student name:domain
   
   $courseID:  The id of the course
   
   Output: \%courseData
   
   \%courseData:  A hash pointer to the raw data from the student's course
   database.
   
   =back
   
   =cut
   
 sub DownloadStudentCourseInformation {  sub DownloadStudentCourseInformation {
     my ($name,$courseID)=@_;      my ($name,$courseID)=@_;
     my ($studentName,$studentDomain) = split(/\:/,$name);      my ($studentName,$studentDomain) = split(/\:/,$name);
Line 469  sub DownloadStudentCourseInformation { Line 795  sub DownloadStudentCourseInformation {
   
 # ----- END DOWNLOAD INFORMATION ---------------------------------------  # ----- END DOWNLOAD INFORMATION ---------------------------------------
   
 # ----- END PROCESSING FUNCTIONS ---------------------------------------  =pod
   
   =head1 PROCESSING FUNCTIONS
   
   These functions process all the data for all the students.  Also, they
   are the only functions that access the cache database for writing.  Thus
   they are the only functions that cache data.  The downloading and caching
   were separated to reduce problems with stopping downloading then can't
   tie hash to database later.
   
   =cut
   
   # ----- PROCESSING FUNCTIONS ---------------------------------------
   
   =pod
   
   =item &ProcessTopResourceMap()
   
   Trace through the "big hash" created in rat/lonuserstate.pm::loadmap.  
   Basically, this function organizes a subset of the data and stores it in
   cached data.  The data stored is the problems, sequences, sequence titles,
   parts of problems, and their ordering.  Column width information is also 
   partially handled here on a per sequence basis.
   
   =over 4
   
   Input: $ChartDB, $c
   
   $ChartDB:  The name of the cache database file
   
   $c:  The connection class used to determine if an abort has been sent to the 
   browser
   
   Output: A string that contains an error message or "OK" if everything went 
   smoothly.
   
   =back
   
   =cut
   
 sub ProcessTopResourceMap {  sub ProcessTopResourceMap {
     my ($ChartDB,$c)=@_;      my ($ChartDB,$c)=@_;
Line 497  sub ProcessTopResourceMap { Line 861  sub ProcessTopResourceMap {
  return 'Could not tie cache hash.';   return 'Could not tie cache hash.';
     }      }
   
       # Initialize state machine.  Set information pointing to top level map.
     my (@sequences, @currentResource, @finishResource);      my (@sequences, @currentResource, @finishResource);
     my ($currentSequence, $currentResourceID, $lastResourceID);      my ($currentSequence, $currentResourceID, $lastResourceID);
   
Line 565  sub ProcessTopResourceMap { Line 930  sub ProcessTopResourceMap {
     ':'.$currentResourceID;      ':'.$currentResourceID;
     }      }
   
             #Get Parts for problem              # Get Parts for problem
     my $meta=$hash{'src_'.$currentResourceID};      my $meta=$hash{'src_'.$currentResourceID};
     foreach (split(/\,/,&Apache::lonnet::metadata($meta,'keys'))) {      foreach (split(/\,/,&Apache::lonnet::metadata($meta,'keys'))) {
  if($_=~/^stores\_(\d+)\_tries$/) {   if($_=~/^stores\_(\d+)\_tries$/) {
Line 582  sub ProcessTopResourceMap { Line 947  sub ProcessTopResourceMap {
     }      }
  }   }
   
  #if resource == finish resource   # if resource == finish resource, then it is the end of a sequence/page
  if($currentResourceID eq $lastResourceID) {   if($currentResourceID eq $lastResourceID) {
     #pop off last resource of sequence      # pop off last resource of sequence
     $currentResourceID=pop(@currentResource);      $currentResourceID=pop(@currentResource);
     $lastResourceID=pop(@finishResource);      $lastResourceID=pop(@finishResource);
   
Line 616  sub ProcessTopResourceMap { Line 981  sub ProcessTopResourceMap {
                         (scalar @titleLength);                          (scalar @titleLength);
  }   }
     } else {      } else {
                   # Remove sequence from list, if it contains no problems to
                   # display.
                 $CacheData{'orderedSequences'}=~s/$currentSequence//;                  $CacheData{'orderedSequences'}=~s/$currentSequence//;
                 $CacheData{'orderedSequences'}=~s/::/:/g;                  $CacheData{'orderedSequences'}=~s/::/:/g;
                 $CacheData{'orderedSequences'}=~s/^:|:$//g;                  $CacheData{'orderedSequences'}=~s/^:|:$//g;
Line 628  sub ProcessTopResourceMap { Line 995  sub ProcessTopResourceMap {
  }   }
   
  # MOVE!!!   # MOVE!!!
  #move to next resource   # move to next resource
  unless(defined($hash{'to_'.$currentResourceID})) {   unless(defined($hash{'to_'.$currentResourceID})) {
     # big problem, need to handle.  Next is probably wrong      # big problem, need to handle.  Next is probably wrong
     last;      last;
Line 657  sub ProcessTopResourceMap { Line 1024  sub ProcessTopResourceMap {
     return 'OK';      return 'OK';
 }  }
   
   =pod
   
   =item &ProcessSection()
   
   Determine the section number for a student for the class.  A student can have 
   multiple sections for the same class.  The correct one is chosen.
   
   =over 4
   
   Input: $sectionData, $courseid, $ActiveFlag
   
   $sectionData:  A pointer to a hash containing all section data for this 
   student for the class
   
   $courseid:  The course ID.
   
   $ActiveFlag:  The student's active status (Active/Expired)
   
   Output: $oldsection, $cursection, or -1
   
   $oldsection and $cursection and sections number that will be displayed in the 
   chart.
   
   -1 is returned if an error occurs.
   
   =back
   
   =cut
   
 sub ProcessSection {  sub ProcessSection {
     my ($sectionData, $courseid,$ActiveFlag)=@_;      my ($sectionData, $courseid,$ActiveFlag)=@_;
     $courseid=~s/\_/\//g;      $courseid=~s/\_/\//g;
Line 711  sub ProcessSection { Line 1107  sub ProcessSection {
     return '-1';      return '-1';
 }  }
   
   =pod
   
   =item &ProcessStudentInformation()
   
   Takes data downloaded for a student and breaks it up into managable pieces and 
   stored in cache data.  The username, domain, class related date, PID, 
   full name, and section are all processed here.
   
   =over 4
   
   Input: $CacheData, $studentInformation, $section, $date, $name, $courseID
   
   $CacheData:  A hash pointer to the cached data
   
   $studentInformation:  Student information is what was requested in 
   &DownloadPrerequistedData().  See that function for what data is requested.
   
   $section: A hash pointer to class section related information.
   
   $date:  A composite of the start and end date for this class for this
   student.  Format:  end:start
   
   $name:  the username:domain information
   
   $courseID: The course ID
   
   Output: None
   
   *NOTE:  There is no return value, but if an error occurs a key is added to 
   the cache data with the value being the error message.  The key is 
   username:domain:error.  It will only exist if an error occurs.
   
   =back
   
   =cut
   
 sub ProcessStudentInformation {  sub ProcessStudentInformation {
     my ($CacheData,$studentInformation,$section,$date,$name,$courseID,$c)=@_;      my ($CacheData,$studentInformation,$section,$date,$name,$courseID)=@_;
     my ($studentName,$studentDomain) = split(/\:/,$name);      my ($studentName,$studentDomain) = split(/\:/,$name);
   
     $CacheData->{$name.':username'}=$studentName;      $CacheData->{$name.':username'}=$studentName;
Line 742  sub ProcessStudentInformation { Line 1174  sub ProcessStudentInformation {
  $CacheData->{$name.':section'}='';   $CacheData->{$name.':section'}='';
     }      }
   
     return 0;      return;
 }  }
   
   =pod
   
   =item &ProcessClassList()
   
   Taking the class list dumped from &DownloadPrerequisiteData(), all the 
   students and their non-class information is processed using the 
   &ProcessStudentInformation() function.  A date stamp is also recorded for
   when the data was processed.
   
   =over 4
   
   Input: $classlist, $courseID, $ChartDB, $c
   
   $classlist:  The hash of data collected about a student from 
   &DownloadPrerequisteData().  The hash contains a list of students, a pointer 
   to a hash of student information for each student, and each student's section 
   number.
   
   $courseID:  The course ID
   
   $ChartDB:  The name of the cache database file.
   
   $c:  The connection class used to determine if an abort has been sent to the 
   browser
   
   Output: @names
   
   @names:  An array of students whose information has been processed, and are to 
   be considered in an arbitrary order.
   
   =back
   
   =cut
   
 sub ProcessClassList {  sub ProcessClassList {
     my ($classlist,$courseID,$ChartDB,$c)=@_;      my ($classlist,$courseID,$ChartDB,$c)=@_;
     my @names=();      my @names=();
Line 765  sub ProcessClassList { Line 1231  sub ProcessClassList {
                                     $classlist->{$name.':studentInformation'},                                      $classlist->{$name.':studentInformation'},
                                     $classlist->{$name.':section'},                                      $classlist->{$name.':section'},
                                     $classlist->{$name},                                      $classlist->{$name},
                                     $name,$courseID,$c);                                      $name,$courseID);
         }          }
   
         # Time of download          # Time of download
Line 776  sub ProcessClassList { Line 1242  sub ProcessClassList {
     return @names;      return @names;
 }  }
   
 # ----- END PROCESSING FUNCTIONS ---------------------------------------  =pod
   
 # ----- HELPER FUNCTIONS -----------------------------------------------  =item &ProcessStudentData()
   
   Takes the course data downloaded for a student in 
   &DownloadStudentCourseInformation() and breaks it up into key value pairs
   to be stored in the cached data.  The keys are comprised of the 
   $username:$domain:$keyFromCourseDatabase.  The student username:domain is
   stored away signifying that the student's information has been downloaded and 
   can be reused from cached data.
   
   =over 4
   
   Input: $courseData, $name, $ChartDB
   
   $courseData:  A hash pointer that points to the course data downloaded for a 
   student.
   
   $name:  username:domain
   
   $ChartDB:  The name of the cache database file which will allow the data to
   be written to the cache.
   
   Output: None
   
   *NOTE:  There is no output, but an error message is stored away in the cache 
   data.  This is checked in &FormatStudentData().  The key username:domain:error 
   will only exist if an error occured.  The error is an error from 
   &DownloadStudentCourseInformation().
   
   =back
   
   =cut
   
   sub ProcessStudentData {
       my ($courseData, $name, $ChartDB)=@_;
   
       my %CacheData;
       if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
           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;
   }
   
   =pod
   
   =item &ProcessFormData()
   
   Cache form data and set default form data (sort, status, heading.$number,
   sequence.$number, reselect, reset, recalculate, and refresh)
   
   =over 4
   
   Input: $ChartDB, $isCached
   
   $ChartDB: The name of the database for cached data
   
   $isCached: Is there already data for this course cached.  This is used in 
   conjunction with the absence of all form data to know to display all selection 
   types.
   
   Output: None
   
   =back
   
   =cut
   
   # For all data, if ENV data doesn't exist for it, default values is used.
   sub ProcessFormData {
       my ($ChartDB, $isCached)=@_;
       my %CacheData;
   
       if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
           # Ignore $ENV{'form.refresh'}
           # Ignore $ENV{'form.recalculate'}
   
           if(defined($ENV{'form.sort'})) {
               $CacheData{'form.sort'}=$ENV{'form.sort'};
           } elsif(!defined($CacheData{'form.sort'})) {
               $CacheData{'form.sort'}='username';
           }
   
           if(defined($ENV{'form.status'})) {
               $CacheData{'form.status'}=$ENV{'form.status'};
           } elsif(!defined($CacheData{'form.status'})) {
               $CacheData{'form.status'}='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\.heading/) {
                   $found++;
                   push(@headings, $_);
               } elsif(/form\.sequence/) {
                   $found++;
                   push(@sequences, $_);
               } elsif(/form\./) {
                   $found++;
               }
           }
   
           if($found) {
               $CacheData{'form.headings'}=join(":::",@headings);
               $CacheData{'form.sequences'}=join(":::",@sequences);
           }
   
           if(defined($ENV{'form.reselect'})) {
               my @reselected = (ref($ENV{'form.reselect'}) ? 
                                 @{$ENV{'form.reselect'}}
                                 : ($ENV{'form.reselect'}));
               foreach (@reselected) {
                   if(/heading/) {
                       $CacheData{'form.headings'}.=":::".$_;
                   } elsif(/sequence/) {
                       $CacheData{'form.sequences'}.=":::".$_;
                   }
               }
           }
   
           # !$found and !$isCached are how I determine if the chrt button
           # on the remote was pressed and needs to reset all the selections
           if(defined($ENV{'form.reset'}) || (!$found && !$isCached)) {
               $CacheData{'form.reset'}='true';
               $CacheData{'form.status'}='Active';
               $CacheData{'form.sort'}='username';
               $CacheData{'form.headings'}='ALLHEADINGS';
               $CacheData{'form.sequences'}='ALLSEQUENCES';
           } else {
               $CacheData{'form.reset'}='false';
           }
   
           untie(%CacheData);
       }
   
       return;
   }
   
   =pod
   
   =item &SpaceColumns()
   
   Determines the width of all the columns in the chart.  It is based on
   the max of the data for that column and its header.
   
   =over 4
   
   Input: $students, $studentInformation, $headings, $ChartDB
   
   $students: An array pointer to a list of students (username:domain)
   
   $studentInformatin: The type of data for the student information.  It is
   used as part of the key in $CacheData.
   
   $headings: The name of the student information columns.
   
   $ChartDB: The name of the cache database which is opened for read/write.
   
   Output: None - All data stored in cache.
   
   =back
   
   =cut
   
 sub SpaceColumns {  sub SpaceColumns {
     my ($students,$studentInformation,$headings,$ChartDB)=@_;      my ($students,$studentInformation,$headings,$ChartDB)=@_;
Line 807  sub SpaceColumns { Line 1450  sub SpaceColumns {
     return;      return;
 }  }
   
   # ----- END PROCESSING FUNCTIONS ---------------------------------------
   
   =pod
   
   =head1 HELPER FUNCTIONS
   
   These are just a couple of functions do various odd and end 
   jobs.
   
   =cut
   
   # ----- HELPER FUNCTIONS -----------------------------------------------
   
   =pod
   
   =item &ProcessFullName()
   
   Takes lastname, generation, firstname, and middlename (or some partial
   set of this data) and returns the full name version as a string.  Format
   is Lastname generation, firstname middlename or a subset of this.
   
   =cut
   
 sub ProcessFullName {  sub ProcessFullName {
     my ($lastname, $generation, $firstname, $middlename)=@_;      my ($lastname, $generation, $firstname, $middlename)=@_;
     my $Str = '';      my $Str = '';
Line 847  sub ProcessFullName { Line 1513  sub ProcessFullName {
     return $Str;      return $Str;
 }  }
   
   =pod
   
   =item &SortStudents()
   
   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 895  sub SortStudents { Line 1586  sub SortStudents {
     return @order;      return @order;
 }  }
   
   =pod
   
   =item &TestCacheData()
   
   Determine if the cache database can be accessed with a tie.  It waits up to
   ten seconds before returning failure.  This function exists to help with
   the problems with stopping the data download.  When an abort occurs and the
   user quickly presses a form button and httpd child is created.  This
   child needs to wait for the other to finish (hopefully within ten seconds).
   
   =over 4
   
   Input: $ChartDB
   
   $ChartDB: The name of the cache database to be opened
   
   Output: -1, 0, 1
   
   -1: Couldn't tie database
    0: Use cached data
    1: New cache database created, use that.
   
   =back
   
   =cut
   
 sub TestCacheData {  sub TestCacheData {
     my ($ChartDB)=@_;      my ($ChartDB)=@_;
     my $isCached=-1;      my $isCached=-1;
Line 929  sub TestCacheData { Line 1646  sub TestCacheData {
     return $isCached;      return $isCached;
 }  }
   
 sub ExtractStudentData {  =pod
     my ($courseData, $name, $ChartDB)=@_;  
   
     my %CacheData;  =item &ShouldShowColumn()
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  
         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;  Determine if a specified column should be shown on the chart.
 }  
   =over 4
   
   Input: $cache, $test
   
   $cache: A pointer to the hash tied to the cached data
   
   $test: The form name of the column (heading.$headingIndex) or 
   (sequence.$sequenceIndex)
   
   Output: 0 (false), 1 (true)
   
   =back
   
   =cut
   
 sub ShouldShowColumn {  sub ShouldShowColumn {
     my ($cache,$test)=@_;      my ($cache,$test)=@_;
Line 967  sub ShouldShowColumn { Line 1681  sub ShouldShowColumn {
         return 1;          return 1;
     }      }
   
 #    my $reselected=$cache->{'form.reselect'};  
 #    if($reselected=~/$test/) {  
 #        return 1;  
 #    }  
   
     return 0;      return 0;
 }  }
   
 sub ProcessFormData {  # ----- END HELPER FUNCTIONS --------------------------------------------
     my ($ChartDB)=@_;  
     my %CacheData;  
   
     if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {  =pod
         if(defined($ENV{'form.sort'})) {  
             $CacheData{'form.sort'}=$ENV{'form.sort'};  
         } elsif(!defined($CacheData{'form.sort'})) {  
             $CacheData{'form.sort'}='username';  
         }  
   
         # Ignore $ENV{'form.refresh'}  =head1 Handler and main function(BuildChart)
         # Ignore $ENV{'form.recalculate'}  
   
         if(defined($ENV{'form.status'})) {  The handler does some initial error checking and then passes the torch to
             $CacheData{'form.status'}=$ENV{'form.status'};  BuildChart.  BuildChart calls all the appropriate functions to get the
         } elsif(!defined($CacheData{'form.status'})) {  job done.  These are the only two functions that use print ($r).  All other
             $CacheData{'form.status'}='Active';  functions return strings to BuildChart to be printed.
         }  
   
         my @headings=();  =cut
         my @sequences=();  
         my $found=0;  
         foreach (keys(%ENV)) {  
             if(/form\.heading/) {  
                 $found++;  
                 push(@headings, $_);  
             } elsif(/form\.sequence/) {  
                 $found++;  
                 push(@sequences, $_);  
             } elsif(/form\./) {  
                 $found++;  
             }  
         }  
   
         if($found) {  =pod
             $CacheData{'form.headings'}=join(":::",@headings);  
             $CacheData{'form.sequences'}=join(":::",@sequences);  
         }  
   
         if(defined($ENV{'form.reselect'})) {  =item &BuildChart()
             my @reselected = (ref($ENV{'form.reselect'}) ?   
                               @{$ENV{'form.reselect'}}  
                               : ($ENV{'form.reselect'}));  
             foreach (@reselected) {  
                 if(/heading/) {  
                     $CacheData{'form.headings'}.=":::".$_;  
                 } elsif(/sequence/) {  
                     $CacheData{'form.sequences'}.=":::".$_;  
                 }  
             }  
         }  
   
         if(defined($ENV{'form.reset'})) {   The following is the process that BuildChart goes through to 
             $CacheData{'form.reset'}='true';    create the html document.
             $CacheData{'form.status'}='Active';  
             $CacheData{'form.sort'}='username';  
             $CacheData{'form.headings'}='ALLHEADINGS';  
             $CacheData{'form.sequences'}='ALLSEQUENCES';  
         } else {  
             $CacheData{'form.reset'}='false';  
         }  
   
         untie(%CacheData);   -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
   
     return;  =over 4
 }  
   
 # ----- END HELPER FUNCTIONS --------------------------------------------  Input: $r
   
   $r:  Used to print html
   
   Output: None
   
   =back
   
   =cut
   
 sub BuildChart {  sub BuildChart {
     my ($r)=@_;      my ($r)=@_;
Line 1068  sub BuildChart { Line 1747  sub BuildChart {
         $r->rflush();          $r->rflush();
         return;          return;
     }      }
     &ProcessFormData($ChartDB);      &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 1103  sub BuildChart { Line 1782  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); }
         my $downloadTime=0;  
         if(defined($CacheData{'time'})) { $downloadTime=$CacheData{'time'}; }          if(defined($CacheData{'time'})) { $downloadTime=$CacheData{'time'}; }
         else { $downloadTime=localtime(); }          else { $downloadTime=localtime(); }
         if(!$c->aborted()) { $r->print('<h3>'.$downloadTime.'</h3>'); }          if(!$c->aborted()) { $r->print('<h3>'.$downloadTime.'</h3>'); }
Line 1113  sub BuildChart { Line 1792  sub BuildChart {
                                        ' students</h1>'); }                                         ' students</h1>'); }
  if(!$c->aborted()) { $r->rflush(); }   if(!$c->aborted()) { $r->rflush(); }
  if(!$c->aborted()) { $r->print(&CreateLegend()); }   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(&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>'); }
                                                        $spacePadding)); }          if(!$c->aborted()) { $r->print('<b>Note: Uncheck the boxes above a'); }
           if(!$c->aborted()) { $r->print(' column to remove that column from'); }
           if(!$c->aborted()) { $r->print(' the display.</b></pre>'); }
           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,   
                                                        $spacePadding)); }  
  if(!$c->aborted()) { $r->print(&CreateTableHeadings(   if(!$c->aborted()) { $r->print(&CreateTableHeadings(
                                                          \%CacheData,                                                           \%CacheData,
                                                          \@studentInformation,                                                            \@studentInformation, 
  \@headings,    \@headings, 
  $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 1136  sub BuildChart { Line 1819  sub BuildChart {
  return;   return;
     }      }
   
       # Output student data
     my @updateStudentList = ();      my @updateStudentList = ();
     my $courseData;      my $courseData;
     $r->print('<pre>');      $r->print('<pre>');
Line 1148  sub BuildChart { Line 1832  sub BuildChart {
             $courseData=&DownloadStudentCourseInformation($_, $cid);              $courseData=&DownloadStudentCourseInformation($_, $cid);
             if($c->aborted()) { last; }              if($c->aborted()) { last; }
             push(@updateStudentList, $_);              push(@updateStudentList, $_);
             &ExtractStudentData($courseData, $_, $ChartDB);              &ProcessStudentData($courseData, $_, $ChartDB);
         }          }
         $r->print(&FormatStudentData($_, $cid, \@studentInformation,          $r->print(&FormatStudentData($_, \@studentInformation,
                                      $spacePadding, $ChartDB));                                       $spacePadding, $ChartDB));
         $r->rflush();          $r->rflush();
     }      }
   
       # 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)) {      if(!$isCached && tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) {
         $CacheData{'NamesOfStudents'}=join(":::", @updateStudentList);          $CacheData{'NamesOfStudents'}=join(":::", @updateStudentList);
 #    $CacheData{'NamesOfStudents'}=  #    $CacheData{'NamesOfStudents'}=
Line 1162  sub BuildChart { Line 1848  sub BuildChart {
         untie(%CacheData);          untie(%CacheData);
     }      }
   
       # End document
     $r->print('</pre></body></html>');      $r->print('</pre></body></html>');
     $r->rflush();      $r->rflush();
   
Line 1170  sub BuildChart { Line 1857  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;
Line 1190  sub handler { Line 1897  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.54  
changed lines
  Added in v.1.58

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