[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.55 and 1.57

version 1.55, 2002/07/08 13:38:52 version 1.57, 2002/07/08 15:03:25
Line 672  here in the future. Line 672  here in the future.
   
 =item &DownloadPrerequisiteData()  =item &DownloadPrerequisiteData()
   
 Collects lastname, generation, middlename, firstname PID, and section for each  Collects lastname, generation, middlename, firstname, PID, and section for each
 student from their environment database.  The list of students is built from  student from their environment database.  The list of students is built from
 collecting a classlist for the course that is to be displayed.  collecting a classlist for the course that is to be displayed.
   
Line 793  tie hash to database later. Line 793  tie hash to database later.
   
 =pod  =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  =cut
   
 sub ProcessTopResourceMap {  sub ProcessTopResourceMap {
Line 981  sub ProcessTopResourceMap { Line 1003  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 1035  sub ProcessSection { Line 1086  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 1066  sub ProcessStudentInformation { Line 1153  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 1089  sub ProcessClassList { Line 1210  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 1100  sub ProcessClassList { Line 1221  sub ProcessClassList {
     return @names;      return @names;
 }  }
   
   =pod
   
   =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 {  sub ProcessStudentData {
     my ($courseData, $name, $ChartDB)=@_;      my ($courseData, $name, $ChartDB)=@_;
   
Line 1519  functions return strings to BuildChart t Line 1674  functions return strings to BuildChart t
   
 =item &BuildChart()  =item &BuildChart()
   
  The following is the process that BuildChart goes through to create the   The following is the process that BuildChart goes through to 
   html document.    create the html document.
   
  -Start the lonchart document   -Start the lonchart document
  -Test for access to the CacheData   -Test for access to the CacheData
  -Download class list information if not using cached data    -Download class list information if not using cached data 
  -Sort students and print out table desciptive data   -Sort students and print out table desciptive data
  -Output student data   -Output student data
  -If recalculating, store a list of students, but only if all their data was    -If recalculating, store a list of students, but only if all 
   downloaded.  Leave off the others.    their data was downloaded.  Leave off the others.
  -End document   -End document
   
 =over 4  =over 4
Removed from v.1.55  
changed lines
  Added in v.1.57

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