Diff for /loncom/interface/loncoursedata.pm between versions 1.22 and 1.90

version 1.22, 2002/08/28 21:50:27 version 1.90, 2003/09/26 19:23:14
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # (Publication Handler  
 #  #
 # $Id$  # $Id$
 #  #
Line 53  use strict; Line 52  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
 use Apache::lonnet();  use Apache::lonnet();
 use Apache::lonhtmlcommon;  use Apache::lonhtmlcommon;
   use Time::HiRes;
   use Apache::lonmysql;
 use HTML::TokeParser;  use HTML::TokeParser;
 use GDBM_File;  use GDBM_File;
   
Line 65  and/or itself. Line 66  and/or itself.
   
 =cut  =cut
   
 # ----- DOWNLOAD INFORMATION -------------------------------------------  ####################################################
   ####################################################
   
 =pod  =pod
   
 =item &DownloadClasslist()  =item &get_sequence_assessment_data()
   
 Collects lastname, generation, middlename, firstname, PID, and section for each  AT THIS TIME THE USE OF THIS FUNCTION IS *NOT* RECOMMENDED
 student from their environment database.  The section data is also download, though  
 it is in a rough format, and is processed later.  The list of students is built from  
 collecting a classlist for the course that is to be displayed.  Once the classlist  
 has been downloaded, its date stamp is recorded.  Unless the datestamp for the  
 class database is reset or is modified, this data will not be downloaded again.    
 Also, there was talk about putting the fullname and section  
 and perhaps other pieces of data into the classlist file.  This would  
 reduce the number of different file accesses and reduce the amount of   
 processing on this side.  
   
 =over 4  Use lonnavmaps to build a data structure describing the order and 
   assessment contents of each sequence in the current course.
   
   The returned structure is a hash reference. 
   
   { title => 'title',
     symb  => 'symb',
     src   => '/s/o/u/r/c/e',
     type  => (container|assessment),
     num_assess   => 2,               # only for container
     parts        => [11,13,15],      # only for assessment
     response_ids => [12,14,16],      # only for assessment
     contents     => [........]       # only for container
   }
   
   $hash->{'contents'} is a reference to an array of hashes of the same structure.
   
   Also returned are array references to the sequences and assessments contained
   in the course.
   
 Input: $courseID, $lastDownloadTime, $c  
   
 $courseID:  The id of the course  =cut
   
 $lastDownloadTime:  This is the date stamp for when this information was  ####################################################
 last gathered.  If it is set to 'Not downloaded', it will gather the data  ####################################################
 again, though it currently does not remove the old data.  sub get_sequence_assessment_data {
       my $fn=$ENV{'request.course.fn'};
       ##
       ## use navmaps
       my $navmap = Apache::lonnavmaps::navmap->new();
       if (!defined($navmap)) {
           return 'Can not open Coursemap';
       }
       # We explicity grab the top level map because I am not sure we
       # are pulling it from the iterator.
       my $top_level_map = $navmap->getById('0.0');
       #
       my $iterator = $navmap->getIterator(undef, undef, undef, 1);
       my $curRes = $iterator->next(); # Top level sequence
       ##
       ## Prime the pump 
       ## 
       ## We are going to loop until we run out of sequences/pages to explore for
       ## resources.  This means we have to start out with something to look
       ## at.
       my $title = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       my $symb  = $top_level_map->symb();
       my $src   = $top_level_map->src();
       my $randompick = $top_level_map->randompick();
       #
       my @Sequences; 
       my @Assessments;
       my @Nested_Sequences = ();   # Stack of sequences, keeps track of depth
       my $top = { title    => $title,
                   src      => $src,
                   symb     => $symb,
                   type     => 'container',
                   num_assess => 0,
                   num_assess_parts => 0,
                   contents   => [], 
                   randompick => $randompick,
               };
       push (@Sequences,$top);
       push (@Nested_Sequences, $top);
       #
       # We need to keep track of which sequences contain homework problems
       # 
       my $previous_too;
       my $previous;
       while (scalar(@Nested_Sequences)) {
           $previous_too = $previous;
           $previous = $curRes;
           $curRes = $iterator->next();
           my $currentmap = $Nested_Sequences[-1]; # Last one on the stack
           if ($curRes == $iterator->BEGIN_MAP()) {
               if (! ref($previous)) {
                   $previous = $previous_too;
               }
               if (! ref($previous)) {
                   next;
               }
               # get the map itself, instead of BEGIN_MAP
               $title = $previous->title();
               $title =~ s/\:/\&\#058;/g;
               $symb  = $previous->symb();
               $src   = $previous->src();
               # pick up the filename if there is no title available
               if (! defined($title) || $title eq '') {
                   ($title) = ($src=~/\/([^\/]*)$/);
               }
               $randompick = $previous->randompick();
               my $newmap = { title    => $title,
                              src      => $src,
                              symb     => $symb,
                              type     => 'container',
                              num_assess => 0,
                              randompick => $randompick,
                              contents   => [],
                          };
               push (@{$currentmap->{'contents'}},$newmap); # this is permanent
               push (@Sequences,$newmap);
               push (@Nested_Sequences, $newmap); # this is a stack
               next;
           }
           if ($curRes == $iterator->END_MAP()) {
               pop(@Nested_Sequences);
               next;
           }
           next if (! ref($curRes));
           next if (! $curRes->is_problem());# && !$curRes->randomout);
           # Okay, from here on out we only deal with assessments
           $title = $curRes->title();
           $title =~ s/\:/\&\#058;/g;
           $symb  = $curRes->symb();
           $src   = $curRes->src();
           my $parts = $curRes->parts();
           my %partdata;
           foreach my $part (@$parts) {
               my @Responses = $curRes->responseType($part);
               my @Ids       = $curRes->responseIds($part);
               $partdata{$part}->{'ResponseTypes'}= \@Responses;
               $partdata{$part}->{'ResponseIds'}  = \@Ids;
           }
           my $assessment = { title => $title,
                              src   => $src,
                              symb  => $symb,
                              type  => 'assessment',
                              parts => $parts,
                              num_parts => scalar(@$parts),
                              partdata => \%partdata,
                          };
           push(@Assessments,$assessment);
           push(@{$currentmap->{'contents'}},$assessment);
           $currentmap->{'num_assess'}++;
           $currentmap->{'num_assess_parts'}+= scalar(@$parts);
       }
       $navmap->untieHashes();
       return ($top,\@Sequences,\@Assessments);
   }
   
 $c: The connection class that can determine if the browser has aborted.  It  sub LoadDiscussion {
 is used to short circuit this function so that it does not continue to       my ($courseID)=@_;
 get information when there is no need.      my %Discuss=();
       my %contrib=&Apache::lonnet::dump(
                   $courseID,
                   $ENV{'course.'.$courseID.'.domain'},
                   $ENV{'course.'.$courseID.'.num'});
     
       #my %contrib=&DownloadCourseInformation($name, $courseID, 0);
   
 Output: \%classlist      foreach my $temp(keys %contrib) {
    if ($temp=~/^version/) {
       my $ver=$contrib{$temp};
       my ($dummy,$prb)=split(':',$temp);
       for (my $idx=1; $idx<=$ver; $idx++ ) {
    my $name=$contrib{"$idx:$prb:sendername"};
    $Discuss{"$name:$prb"}=$idx;
       }
    }
       }       
   
 \%classlist: A pointer to a hash containing the following data:      return \%Discuss;
   }
   
 -A list of student name:domain (as keys) (known below as $name)  ################################################
   ################################################
   
 -A hash pointer for each student containing lastname, generation, firstname,  =pod
 middlename, and PID : Key is $name.'studentInformation'  
   
 -A hash pointer to each students section data : Key is $name.section  =item &GetUserName(username,userdomain)
   
 -If there was an error in dump, it will be returned in the hash.  See  Returns a hash with the following entries:
 the error codes for dump in lonnet.  Also, an error key will be      'firstname', 'middlename', 'lastname', 'generation', and 'fullname'
 generated if an abort occurs.  
   
 =back     'fullname' is the result of &Apache::loncoursedata::ProcessFullName.
   
 =cut  =cut
   
 sub DownloadClasslist {  ################################################
     my ($courseID, $lastDownloadTime, $c)=@_;  ################################################
     my ($courseDomain,$courseNumber)=split(/\_/,$courseID);  sub GetUserName {
     my %classlist;      my ($username,$userdomain) = @_;
       $username = $ENV{'user.name'} if (! defined($username));
     my $modifiedTime = &Apache::lonnet::GetFileTimestamp($courseDomain, $courseNumber,      $userdomain = $ENV{'user.domain'} if (! defined($username));
                                                          'classlist.db',       my %userenv = &Apache::lonnet::get('environment',
                                                          $Apache::lonnet::perlvar{'lonUsersDir'});                             ['firstname','middlename','lastname','generation'],
                                          $userdomain,$username);
     # Always download the information if lastDownloadTime is set to      $userenv{'fullname'} = &ProcessFullName($userenv{'lastname'},
     # 'Not downloaded', otherwise it is only downloaded if the file                                              $userenv{'generation'},
     # has been updated and has a more recent date stamp                                              $userenv{'firstname'},
     if($lastDownloadTime ne 'Not downloaded' &&                                              $userenv{'middlename'});
        $lastDownloadTime >= $modifiedTime && $modifiedTime >= 0) {      return %userenv;
         # Data is not gathered so return UpToDate as true.  This  }
         # will be interpreted in ProcessClasslist  
         $classlist{'lastDownloadTime'}=time;  
         $classlist{'UpToDate'} = 'true';  
         return \%classlist;  
     }  
   
     %classlist=&Apache::lonnet::dump('classlist',$courseDomain, $courseNumber);  ################################################
     foreach(keys (%classlist)) {  ################################################
         if(/^(con_lost|error|no_such_host)/i) {  
             return \%classlist;  
         }  
     }  
   
     foreach my $name (keys(%classlist)) {  =pod
         if(defined($c) && ($c->aborted())) {  
             $classlist{'error'}='aborted';  
             return \%classlist;  
         }  
   
         my ($studentName,$studentDomain) = split(/\:/,$name);  =item &ProcessFullName()
         # 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()) {  Takes lastname, generation, firstname, and middlename (or some partial
             $classlist{'error'}='aborted';  set of this data) and returns the full name version as a string.  Format
             return \%classlist;  is Lastname generation, firstname middlename or a subset of this.
         }  
   =cut
   
   ################################################
   ################################################
   sub ProcessFullName {
       my ($lastname, $generation, $firstname, $middlename)=@_;
       my $Str = '';
   
       # Strip whitespace preceeding & following name components.
       $lastname   =~ s/(\s+$|^\s+)//g;
       $generation =~ s/(\s+$|^\s+)//g;
       $firstname  =~ s/(\s+$|^\s+)//g;
       $middlename =~ s/(\s+$|^\s+)//g;
   
         #Section      if($lastname ne '') {
         my %section=&Apache::lonnet::dump('roles',$studentDomain,$studentName);   $Str .= $lastname;
         $classlist{$name.':sections'}=\%section;   $Str .= ' '.$generation if ($generation ne '');
    $Str .= ',';
           $Str .= ' '.$firstname  if ($firstname ne '');
           $Str .= ' '.$middlename if ($middlename ne '');
       } else {
           $Str .= $firstname      if ($firstname ne '');
           $Str .= ' '.$middlename if ($middlename ne '');
           $Str .= ' '.$generation if ($generation ne '');
     }      }
   
     $classlist{'UpToDate'} = 'false';      return $Str;
     $classlist{'lastDownloadTime'}=time;  }
   
   ################################################
   ################################################
   
   =pod
   
   =item &make_into_hash($values);
   
   Returns a reference to a hash as described by $values.  $values is
   assumed to be the result of 
       join(':',map {&Apache::lonnet::escape($_)} %orighash);
   
   This is a helper function for get_current_state.
   
   =cut
   
     return \%classlist;  ################################################
   ################################################
   sub make_into_hash {
       my $values = shift;
       my %tmp = map { &Apache::lonnet::unescape($_); }
                                              split(':',$values);
       return \%tmp;
 }  }
   
   
   ################################################
   ################################################
   
 =pod  =pod
   
 =item &DownloadCourseInformation()  =head1 LOCAL DATA CACHING SUBROUTINES
   
   The local caching is done using MySQL.  There is no fall-back implementation
   if MySQL is not running.
   
   The programmers interface is to call &get_current_state() or some other
   primary interface subroutine (described below).  The internals of this 
   storage system are documented here.
   
   There are six tables used to store student performance data (the results of
   a dumpcurrent).  Each of these tables is created in MySQL with a name of
   $courseid_*****, where ***** is 'symb', 'part', or whatever is appropriate 
   for the table.  The tables and their purposes are described below.
   
   Some notes before we get started.
   
 Dump of all the course information for a single student.  The data can be  Each table must have a PRIMARY KEY, which is a column or set of columns which
 pruned by making use of dumps regular expression arguement.  This function  will serve to uniquely identify a row of data.  NULL is not allowed!
 also takes a regular expression which it passes straight through to dump.    
 The data is no escaped, because it is done elsewhere.  It also  INDEXes work best on integer data.
 checks the timestamp of the students course database file and only downloads  
 if it has been modified since the last download.  JOIN is used to combine data from many tables into one output.
   
   lonmysql.pm is used for some of the interface, specifically the table creation
   calls.  The inserts are done in bulk by directly calling the database handler.
   The SELECT ... JOIN statement used to retrieve the data does not have an
   interface in lonmysql.pm and I shudder at the thought of writing one.
   
   =head3 Table Descriptions
   
 =over 4  =over 4
   
 Input: $namedata, $courseID, $lastDownloadTime, $WhatIWant  =item Tables used to store meta information
   
 $namedata: student name:domain  The following tables hold data required to keep track of the current status
   of a students data in the tables or to look up the students data in the tables.
   
 $courseID:  The id of the course  =over 4
   
 $lastDownloadTime:  This is the date stamp for when this information was  =item $symb_table
 last gathered.  If it is set to 'Not downloaded', it will gather the data  
 again, though it currently does not remove the old data.  
   
 $WhatIWant:  Regular expression used to get selected data with dump  The symb_table has two columns.  The first is a 'symb_id' and the second
   is the text name for the 'symb' (limited to 64k).  The 'symb_id' is generated
   automatically by MySQL so inserts should be done on this table with an
   empty first element.  This table has its PRIMARY KEY on the 'symb_id'.
   
 Output: \%courseData  =item $part_table
   
 \%courseData:  A hash pointer to the raw data from the student's course  The part_table has two columns.  The first is a 'part_id' and the second
 database.  is the text name for the 'part' (limited to 100 characters).  The 'part_id' is
   generated automatically by MySQL so inserts should be done on this table with
   an empty first element.  This table has its PRIMARY KEY on the 'part' (100
   characters) and a KEY on 'part_id'.
   
 =back  =item $student_table
   
 =cut  The student_table has two columns.  The first is a 'student_id' and the second
   is the text description of the 'student' (typically username:domain) (less
   than 100 characters).  The 'student_id' is automatically generated by MySQL.
   The use of the name 'student_id' is loaded, I know, but this ID is used ONLY 
   internally to the MySQL database and is not the same as the students ID 
   (stored in the students environment).  This table has its PRIMARY KEY on the
   'student' (100 characters).
   
 sub DownloadCourseInformation {  =item $studentdata_table
     my ($namedata,$courseID,$lastDownloadTime,$WhatIWant)=@_;  
     my %courseData;  
     my ($name,$domain) = split(/\:/,$namedata);  
   
     my $modifiedTime = &Apache::lonnet::GetFileTimestamp($domain, $name,  The studentdata_table has four columns:  'student_id' (the unique id of 
                                       $courseID.'.db',   the student), 'updatetime' (the time the students data was last updated),
                                       $Apache::lonnet::perlvar{'lonUsersDir'});  'fullupdatetime' (the time the students full data was last updated),
   'section', and 'classification'( the students current classification).
   This table has its PRIMARY KEY on 'student_id'.
   
     if($lastDownloadTime >= $modifiedTime && $modifiedTime >= 0) {  =back 
         # Data is not gathered so return UpToDate as true.  This  
         # will be interpreted in ProcessClasslist  
         $courseData{$namedata.':lastDownloadTime'}=time;  
         $courseData{$namedata.':UpToDate'} = 'true';  
         return \%courseData;  
     }  
   
     # Download course data  =item Tables used to store current status data
     if(!defined($WhatIWant)) {  
         # set the regular expression to everything by setting it to period  
         $WhatIWant = '.';  
     }  
     %courseData=&Apache::lonnet::dump($courseID, $domain, $name, $WhatIWant);  
     $courseData{'UpToDate'} = 'false';  
     $courseData{'lastDownloadTime'}=time;  
   
     my %newData;  The following tables store data only about the students current status on 
     foreach (keys(%courseData)) {  a problem, meaning only the data related to the last attempt on a problem.
         # need to have the keys to be prepended with the name:domain of the  
         # student to reduce data collision later.  
         $newData{$namedata.':'.$_} = $courseData{$_};  
     }  
   
     return \%newData;  =over 4
 }  
   
 # ----- END DOWNLOAD INFORMATION ---------------------------------------  =item $performance_table
   
 =pod  The performance_table has 9 columns.  The first three are 'symb_id', 
   'student_id', and 'part_id'.  These comprise the PRIMARY KEY for this table
   and are directly related to the $symb_table, $student_table, and $part_table
   described above.  MySQL does better indexing on numeric items than text,
   so we use these three "index tables".  The remaining columns are
   'solved', 'tries', 'awarded', 'award', 'awarddetail', and 'timestamp'.
   These are either the MySQL type TINYTEXT or various integers ('tries' and 
   'timestamp').  This table has KEYs of 'student_id' and 'symb_id'.
   For use of this table, see the functions described below.
   
   =item $parameters_table
   
   The parameters_table holds the data that does not fit neatly into the
   performance_table.  The parameters table has four columns: 'symb_id',
   'student_id', 'parameter', and 'value'.  'symb_id', 'student_id', and
   'parameter' comprise the PRIMARY KEY for this table.  'parameter' is 
   limited to 255 characters.  'value' is limited to 64k characters.
   
 =head1 PROCESSING FUNCTIONS  =back
   
 These functions process all the data for all the students.  Also, they  =item Tables used for storing historic data
 are the functions that access the cache database for writing the majority of  
 the time.  The downloading and caching were separated to reduce problems   
 with stopping downloading then can't tie hash to database later.  
   
 =cut  The following tables are used to store almost all of the transactions a student
   has made on a homework problem.  See loncapa/docs/homework/datastorage for 
   specific information about each of the parameters stored.  
   
 # ----- PROCESSING FUNCTIONS ---------------------------------------  =over 4
   
 =pod  =item $fulldump_response_table
   
 =item &ProcessTopResourceMap()  The response table holds data (documented in loncapa/docs/homework/datastorage)
   associated with a particular response id which is stored when a student 
   attempts a problem.  The following are the columns of the table, in order:
   'symb_id','part_id','response_id','student_id','transaction','tries',
   'awarddetail', 'awarded','response_specific' (data particular to the response
   type), 'response_specific_value', and 'submission (the text of the students
   submission).  The primary key is based on the first five columns listed above.
   
   =item $fulldump_part_table
   
   The part table holds data (documented in loncapa/docs/homework/datastorage)
   associated with a particular part id which is stored when a student attempts
   a problem.  The following are the columns of the table, in order:
   'symb_id','part_id','student_id','transaction','tries','award','awarded',
   and 'previous'.  The primary key is based on the first five columns listed 
   above.
   
   =item $fulldump_timestamp_table
   
   The timestamp table holds the timestamps of the transactions which are
   stored in $fulldump_response_table and $fulldump_part_table.  This data is
   about both the response and part data.  Columns: 'symb_id','student_id',
   'transaction', and 'timestamp'.  
   The primary key is based on the first 3 columns.
   
 Trace through the "big hash" created in rat/lonuserstate.pm::loadmap.    =back
 Basically, this function organizes a subset of the data and stores it in  
 cached data.  The data stored is the problems, sequences, sequence titles,  =back
 parts of problems, and their ordering.  Column width information is also   
 partially handled here on a per sequence basis.  =head3 Important Subroutines
   
   Here is a brief overview of the subroutines which are likely to be of 
   interest:
   
 =over 4  =over 4
   
 Input: $cache, $c  =item &get_current_state(): programmers interface.
   
 $cache:  A pointer to a hash to store the information  =item &init_dbs(): table creation
   
 $c:  The connection class used to determine if an abort has been sent to the   =item &update_student_data(): data storage calls
 browser  
   
 Output: A string that contains an error message or "OK" if everything went   =item &get_student_data_from_performance_cache(): data retrieval
 smoothly.  
   
 =back  =back
   
   =head3 Main Documentation
   
   =over 4
   
 =cut  =cut
   
 sub ProcessTopResourceMap {  ################################################
     my ($cache,$c)=@_;  ################################################
     my %hash;  
     my $fn=$ENV{'request.course.fn'};  
     if(-e "$fn.db") {  
  my $tieTries=0;  
  while($tieTries < 3) {  
             if($c->aborted()) {  
                 return;  
             }  
     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.';  
     }  
   
     # Initialize state machine.  Set information pointing to top level map.  ################################################
     my (@sequences, @currentResource, @finishResource);  ################################################
     my ($currentSequence, $currentResourceID, $lastResourceID);  { # Begin scope of table identifiers
   
     $currentResourceID=$hash{'ids_/res/'.$ENV{'request.course.uri'}};  my $current_course ='';
     push(@currentResource, $currentResourceID);  my $symb_table;
     $lastResourceID=-1;  my $part_table;
     $currentSequence=-1;  my $student_table;
     my $topLevelSequenceNumber = $currentSequence;  my $studentdata_table;
   my $performance_table;
     my %sequenceRecord;  my $parameters_table;
     while(1) {  my $fulldump_response_table;
         if($c->aborted()) {  my $fulldump_part_table;
             last;  my $fulldump_timestamp_table;
         }  
  # HANDLE NEW SEQUENCE!  my @Tables;
  #if page || sequence  ################################################
  if(defined($hash{'map_pc_'.$hash{'src_'.$currentResourceID}}) &&  ################################################
            !defined($sequenceRecord{$currentResourceID})) {  
             $sequenceRecord{$currentResourceID}++;  
     push(@sequences, $currentSequence);  
     push(@currentResource, $currentResourceID);  
     push(@finishResource, $lastResourceID);  
   
     $currentSequence=$hash{'map_pc_'.$hash{'src_'.$currentResourceID}};  
   
             # Mark sequence as containing problems.  If it doesn't, then  
             # it will be removed when processing for this sequence is  
             # complete.  This allows the problems in a sequence  
             # to be outputed before problems in the subsequences  
             if(!defined($cache->{'orderedSequences'})) {  
                 $cache->{'orderedSequences'}=$currentSequence;  
             } else {  
                 $cache->{'orderedSequences'}.=':'.$currentSequence;  
             }  
   
     $lastResourceID=$hash{'map_finish_'.  =pod
   $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;  
  }  
     }  
             next;  
  }  
   
  # Handle gradable resources: exams, problems, etc  =item &init_dbs()
  $currentResourceID=~/(\d+)\.(\d+)/;  
         my $partA=$1;  
         my $partB=$2;  
  if($hash{'src_'.$currentResourceID}=~  
    /\.(problem|exam|quiz|assess|survey|form)$/ &&  
    $partA eq $currentSequence &&   
            !defined($sequenceRecord{$currentSequence.':'.  
                                     $currentResourceID})) {  
             $sequenceRecord{$currentSequence.':'.$currentResourceID}++;  
     my $Problem = &Apache::lonnet::symbclean(  
   &Apache::lonnet::declutter($hash{'map_id_'.$partA}).  
   '___'.$partB.'___'.  
   &Apache::lonnet::declutter($hash{'src_'.  
  $currentResourceID}));  
   
     $cache->{$currentResourceID.':problem'}=$Problem;  
     if(!defined($cache->{$currentSequence.':problems'})) {  
  $cache->{$currentSequence.':problems'}=$currentResourceID;  
     } else {  
  $cache->{$currentSequence.':problems'}.=  
     ':'.$currentResourceID;  
     }  
   
     my $meta=$hash{'src_'.$currentResourceID};  Input: course id
 #            $cache->{$currentResourceID.':title'}=  
 #                &Apache::lonnet::metdata($meta,'title');  
             $cache->{$currentResourceID.':title'}=  
                 $hash{'title_'.$currentResourceID};  
             $cache->{$currentResourceID.':source'}=  
                 $hash{'src_'.$currentResourceID};  
   
             # Get Parts for problem  
             my %beenHere;  
             foreach (split(/\,/,&Apache::lonnet::metadata($meta,'packages'))) {  
                 if(/^\w+response_\d+.*/) {  
                     my (undef, $partId, $responseId) = split(/_/,$_);  
                     if($beenHere{'p:'.$partId} ==  0) {  
                         $beenHere{'p:'.$partId}++;  
                         if(!defined($cache->{$currentSequence.':'.  
                                             $currentResourceID.':parts'})) {  
                             $cache->{$currentSequence.':'.$currentResourceID.  
                                      ':parts'}=$partId;  
                         } else {  
                             $cache->{$currentSequence.':'.$currentResourceID.  
                                      ':parts'}.=':'.$partId;  
                         }  
                     }  
                     if($beenHere{'r:'.$partId.':'.$responseId} == 0) {  
                         $beenHere{'r:'.$partId.':'.$responseId}++;  
                         if(!defined($cache->{$currentSequence.':'.  
                                              $currentResourceID.':'.$partId.  
                                              ':responseIDs'})) {  
                             $cache->{$currentSequence.':'.$currentResourceID.  
                                      ':'.$partId.':responseIDs'}=$responseId;  
                         } else {  
                             $cache->{$currentSequence.':'.$currentResourceID.  
                                      ':'.$partId.':responseIDs'}.=':'.  
                                                                   $responseId;  
                         }  
                     }  
                     if(/^optionresponse/ &&   
                        $beenHere{'o:'.$partId.':'.$currentResourceID} == 0) {  
                         $beenHere{'o:'.$partId.$currentResourceID}++;  
                         if(defined($cache->{'OptionResponses'})) {  
                             $cache->{'OptionResponses'}.= ':::'.  
                                 $currentSequence.':'.$currentResourceID.':'.  
                                 $partId.':'.$responseId;  
                         } else {  
                             $cache->{'OptionResponses'}= $currentSequence.':'.  
                                 $currentResourceID.':'.  
                                 $partId.':'.$responseId;  
                         }  
                     }  
                 }  
             }  
         }  
   
  # if resource == finish resource, then it is the end of a sequence/page  Output: 0 on success, positive integer on error
  if($currentResourceID eq $lastResourceID) {  
     # pop off last resource of sequence  
     $currentResourceID=pop(@currentResource);  
     $lastResourceID=pop(@finishResource);  
   
     if(defined($cache->{$currentSequence.':problems'})) {  
  # Capture sequence information here  
  $cache->{$currentSequence.':title'}=  
     $hash{'title_'.$currentResourceID};  
                 $cache->{$currentSequence.':source'}=  
                     $hash{'src_'.$currentResourceID};  
   
                 my $totalProblems=0;  
                 foreach my $currentProblem (split(/\:/,  
                                                $cache->{$currentSequence.  
                                                ':problems'})) {  
                     foreach (split(/\:/,$cache->{$currentSequence.':'.  
                                                    $currentProblem.  
                                                    ':parts'})) {  
                         $totalProblems++;  
                     }  
                 }  
  my @titleLength=split(//,$cache->{$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)) {  
     $cache->{$currentSequence.':columnWidth'}=  
                         $totalProblems + $extra;  
  } else {  
     $cache->{$currentSequence.':columnWidth'}=  
                         (scalar @titleLength);  
  }  
     } else {  
                 # Remove sequence from list, if it contains no problems to  
                 # display.  
                 $cache->{'orderedSequences'}=~s/$currentSequence//;  
                 $cache->{'orderedSequences'}=~s/::/:/g;  
                 $cache->{'orderedSequences'}=~s/^:|:$//g;  
             }  
   
     $currentSequence=pop(@sequences);  This routine issues the calls to lonmysql to create the tables used to
     if($currentSequence eq $topLevelSequenceNumber) {  store student data.
  last;  
     }  
         }  
   
  # MOVE!!!  =cut
  # move to next resource  
  unless(defined($hash{'to_'.$currentResourceID})) {  
     # big problem, need to handle.  Next is probably wrong  
             my $errorMessage = 'Big problem in ';  
             $errorMessage .= 'loncoursedata::ProcessTopLevelMap.';  
             $errorMessage .= '  bighash to_$currentResourceID not defined!';  
             &Apache::lonnet::logthis($errorMessage);  
     last;  
  }  
  my @nextResources=();  
  foreach (split(/\,/,$hash{'to_'.$currentResourceID})) {  
             if(!defined($sequenceRecord{$currentSequence.':'.  
                                         $hash{'goesto_'.$_}})) {  
                 push(@nextResources, $hash{'goesto_'.$_});  
             }  
  }  
  push(@currentResource, @nextResources);  
  # Set the next resource to be processed  
  $currentResourceID=pop(@currentResource);  
     }  
   
     unless (untie(%hash)) {  ################################################
         &Apache::lonnet::logthis("<font color=blue>WARNING: ".  ################################################
                                  "Could not untie coursemap $fn (browse)".  sub init_dbs {
                                  ".</font>");       my $courseid = shift;
       &setup_table_names($courseid);
       #
       # Drop any of the existing tables
       foreach my $table (@Tables) {
           &Apache::lonmysql::drop_table($table);
       }
       #
       # Note - changes to this table must be reflected in the code that 
       # stores the data (calls &Apache::lonmysql::store_row with this table
       # id
       my $symb_table_def = {
           id => $symb_table,
           permanent => 'no',
           columns => [{ name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL',
                         auto_inc     => 'yes', },
                       { name => 'symb',
                         type => 'MEDIUMTEXT',
                         restrictions => 'NOT NULL'},
                       ],
           'PRIMARY KEY' => ['symb_id'],
       };
       #
       my $part_table_def = {
           id => $part_table,
           permanent => 'no',
           columns => [{ name => 'part_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL',
                         auto_inc     => 'yes', },
                       { name => 'part',
                         type => 'VARCHAR(100)',
                         restrictions => 'NOT NULL'},
                       ],
           'PRIMARY KEY' => ['part (100)'],
           'KEY' => [{ columns => ['part_id']},],
       };
       #
       my $student_table_def = {
           id => $student_table,
           permanent => 'no',
           columns => [{ name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL',
                         auto_inc     => 'yes', },
                       { name => 'student',
                         type => 'VARCHAR(100)',
                         restrictions => 'NOT NULL'},
                       { name => 'classification',
                         type => 'varchar(100)', },
                       ],
           'PRIMARY KEY' => ['student (100)'],
           'KEY' => [{ columns => ['student_id']},],
       };
       #
       my $studentdata_table_def = {
           id => $studentdata_table,
           permanent => 'no',
           columns => [{ name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL UNIQUE',},
                       { name => 'updatetime',
                         type => 'INT UNSIGNED'},
                       { name => 'fullupdatetime',
                         type => 'INT UNSIGNED'},
                       { name => 'section',
                         type => 'VARCHAR(100)'},
                       { name => 'classification',
                         type => 'VARCHAR(100)', },
                       ],
           'PRIMARY KEY' => ['student_id'],
       };
       #
       my $performance_table_def = {
           id => $performance_table,
           permanent => 'no',
           columns => [{ name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'part_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'part',
                         type => 'VARCHAR(100)',
                         restrictions => 'NOT NULL'},                    
                       { name => 'solved',
                         type => 'TINYTEXT' },
                       { name => 'tries',
                         type => 'SMALLINT UNSIGNED' },
                       { name => 'awarded',
                         type => 'TINYTEXT' },
                       { name => 'award',
                         type => 'TINYTEXT' },
                       { name => 'awarddetail',
                         type => 'TINYTEXT' },
                       { name => 'timestamp',
                         type => 'INT UNSIGNED'},
                       ],
           'PRIMARY KEY' => ['symb_id','student_id','part_id'],
           'KEY' => [{ columns=>['student_id'] },
                     { columns=>['symb_id'] },],
       };
       #
       my $fulldump_part_table_def = {
           id => $fulldump_part_table,
           permanent => 'no',
           columns => [
                       { name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'part_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'transaction',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'tries',
                         type => 'SMALLINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'award',
                         type => 'TINYTEXT' },
                       { name => 'awarded',
                         type => 'TINYTEXT' },
                       { name => 'previous',
                         type => 'SMALLINT UNSIGNED' },
   #                    { name => 'regrader',
   #                      type => 'TINYTEXT' },
   #                    { name => 'afterduedate',
   #                      type => 'TINYTEXT' },
                       ],
           'PRIMARY KEY' => ['symb_id','part_id','student_id','transaction'],
           'KEY' => [
                     { columns=>['symb_id'] },
                     { columns=>['part_id'] },
                     { columns=>['student_id'] },
                     ],
       };
       #
       my $fulldump_response_table_def = {
           id => $fulldump_response_table,
           permanent => 'no',
           columns => [
                       { name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'part_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'response_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'transaction',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'tries',
                         type => 'SMALLINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'awarddetail',
                         type => 'TINYTEXT' },
                       { name => 'awarded',
                         type => 'TINYTEXT' },
   #                    { name => 'message',
   #                      type => 'CHAR' },
                       { name => 'response_specific',
                         type => 'TINYTEXT' },
                       { name => 'response_specific_value',
                         type => 'TINYTEXT' },
                       { name => 'submission',
                         type => 'TEXT'},
                       ],
               'PRIMARY KEY' => ['symb_id','part_id','response_id','student_id',
                                 'transaction'],
               'KEY' => [
                         { columns=>['symb_id'] },
                         { columns=>['part_id','response_id'] },
                         { columns=>['student_id'] },
                         ],
       };
       my $fulldump_timestamp_table_def = {
           id => $fulldump_timestamp_table,
           permanent => 'no',
           columns => [
                       { name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'transaction',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL' },
                       { name => 'timestamp',
                         type => 'INT UNSIGNED'},
                       ],
           'PRIMARY KEY' => ['symb_id','student_id','transaction'],
           'KEY' => [
                     { columns=>['symb_id'] },
                     { columns=>['student_id'] },
                     { columns=>['transaction'] },
                     ],
       };
   
       #
       my $parameters_table_def = {
           id => $parameters_table,
           permanent => 'no',
           columns => [{ name => 'symb_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'student_id',
                         type => 'MEDIUMINT UNSIGNED',
                         restrictions => 'NOT NULL'  },
                       { name => 'parameter',
                         type => 'TINYTEXT',
                         restrictions => 'NOT NULL'  },
                       { name => 'value',
                         type => 'MEDIUMTEXT' },
                       ],
           'PRIMARY KEY' => ['symb_id','student_id','parameter (255)'],
       };
       #
       # Create the tables
       my $tableid;
       $tableid = &Apache::lonmysql::create_table($symb_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating symb_table: ".
                                    &Apache::lonmysql::get_error());
           return 1;
       }
       #
       $tableid = &Apache::lonmysql::create_table($part_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating part_table: ".
                                    &Apache::lonmysql::get_error());
           return 2;
       }
       #
       $tableid = &Apache::lonmysql::create_table($student_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating student_table: ".
                                    &Apache::lonmysql::get_error());
           return 3;
       }
       #
       $tableid = &Apache::lonmysql::create_table($studentdata_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating studentdata_table: ".
                                    &Apache::lonmysql::get_error());
           return 4;
       }
       #
       $tableid = &Apache::lonmysql::create_table($performance_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating preformance_table: ".
                                    &Apache::lonmysql::get_error());
           return 5;
       }
       #
       $tableid = &Apache::lonmysql::create_table($parameters_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating parameters_table: ".
                                    &Apache::lonmysql::get_error());
           return 6;
       }
       #
       $tableid = &Apache::lonmysql::create_table($fulldump_part_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating fulldump_part_table: ".
                                    &Apache::lonmysql::get_error());
           return 7;
       }
       #
       $tableid = &Apache::lonmysql::create_table($fulldump_response_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating fulldump_response_table: ".
                                    &Apache::lonmysql::get_error());
           return 8;
       }
       $tableid = &Apache::lonmysql::create_table($fulldump_timestamp_table_def);
       if (! defined($tableid)) {
           &Apache::lonnet::logthis("error creating fulldump_timestamp_table: ".
                                    &Apache::lonmysql::get_error());
           return 9;
     }      }
       return 0;
     return 'OK';  
 }  }
   
   ################################################
   ################################################
   
 =pod  =pod
   
 =item &ProcessClasslist()  =item &delete_caches()
   
 Taking the class list dumped from &DownloadClasslist(), all the   =cut
 students and their non-class information is processed using the   
 &ProcessStudentInformation() function.  A date stamp is also recorded for  
 when the data was processed.  
   
 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.  sub delete_caches {
       my $courseid = shift;
       $courseid = $ENV{'request.course.id'} if (! defined($courseid));
       #
       &setup_table_names($courseid);
       #
       my $dbh = &Apache::lonmysql::get_dbh();
       foreach my $table (@Tables) {
           my $command = 'DROP TABLE '.$table.';';
           $dbh->do($command);
           if ($dbh->err) {
               &Apache::lonnet::logthis($command.' resulted in error: '.$dbh->errstr);
           }
       }
       return;
   }
   
 =over 4  ################################################
   ################################################
   
 Input: $cache, $classlist, $courseID, $ChartDB, $c  =pod
   
 $cache: A hash pointer to store the data  =item &get_part_id()
   
 $classlist:  The hash of data collected about a student from   Get the MySQL id of a problem part string.
 &DownloadClasslist().  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  Input: $part
   
 $ChartDB:  The name of the cache database file.  Output: undef on error, integer $part_id on success.
   
 $c:  The connection class used to determine if an abort has been sent to the   =item &get_part()
 browser  
   
 Output: @names  Get the string describing a part from the MySQL id of the problem part.
   
 @names:  An array of students whose information has been processed, and are to   Input: $part_id
 be considered in an arbitrary order.  
   
 =back  Output: undef on error, $part string on success.
   
 =cut  =cut
   
 sub ProcessClasslist {  ################################################
     my ($cache,$classlist,$courseID,$c)=@_;  ################################################
     my @names=();  
   
     $cache->{'ClasslistTimeStamp'}=$classlist->{'lastDownloadTime'};  
     if($classlist->{'UpToDate'} eq 'true') {  
         return split(/:::/,$cache->{'NamesOfStudents'});;  
     }  
   
     foreach my $name (keys(%$classlist)) {  
         if($name =~ /\:section/ || $name =~ /\:studentInformation/ ||  
            $name eq '' || $name eq 'UpToDate' || $name eq 'lastDownloadTime') {  
             next;  
         }  
         if($c->aborted()) {  
             return ();  
         }  
         my $studentInformation = $classlist->{$name.':studentInformation'},  
         my $sectionData = $classlist->{$name.':sections'},  
         my $date = $classlist->{$name},  
         my ($studentName,$studentDomain) = split(/\:/,$name);  
   
         $cache->{$name.':username'}=$studentName;  
         $cache->{$name.':domain'}=$studentDomain;  
         # Initialize timestamp for student  
         if(!defined($cache->{$name.':lastDownloadTime'})) {  
             $cache->{$name.':lastDownloadTime'}='Not downloaded';  
             $cache->{$name.':updateTime'}=' Not updated';  
         }  
   
         my $error = 0;  
         foreach(keys(%$studentInformation)) {  
             if(/^(con_lost|error|no_such_host)/i) {  
                 $cache->{$name.':error'}=  
                     'Could not download student environment data.';  
                 $cache->{$name.':fullname'}='';  
                 $cache->{$name.':id'}='';  
                 $error = 1;  
             }  
         }  
         next if($error);  
         push(@names,$name);  
         $cache->{$name.':fullname'}=&ProcessFullName(  
                                           $studentInformation->{'lastname'},  
                                           $studentInformation->{'generation'},  
                                           $studentInformation->{'firstname'},  
                                           $studentInformation->{'middlename'});  
         $cache->{$name.':id'}=$studentInformation->{'id'};  
   
         my ($end, $start)=split(':',$date);  
         $courseID=~s/\_/\//g;  
         $courseID=~s/^(\w)/\/$1/;  
   
         my $sec='';  
         foreach my $key (keys (%$sectionData)) {  
             my $value = $sectionData->{$key};  
             if ($key=~/^$courseID(?:\/)*(\w+)*\_st$/) {  
                 my $tempsection=$1;  
                 if($key eq $courseID.'_st') {  
                     $tempsection='';  
                 }  
                 my ($dummy,$roleend,$rolestart)=split(/\_/,$value);  
                 if($roleend eq $end && $rolestart eq $start) {  
                     $sec = $tempsection;  
                     last;  
                 }  
             }  
         }  
   
         my $status='Expired';  my $have_read_part_table = 0;
         if(((!$end) || time < $end) && ((!$start) || (time > $start))) {  my %ids_by_part;
             $status='Active';  my %parts_by_id;
   
   sub get_part_id {
       my ($part) = @_;
       $part = 0 if (! defined($part));
       if (! $have_read_part_table) {
           my @Result = &Apache::lonmysql::get_rows($part_table);
           foreach (@Result) {
               $ids_by_part{$_->[1]}=$_->[0];
           }
           $have_read_part_table = 1;
       }
       if (! exists($ids_by_part{$part})) {
           &Apache::lonmysql::store_row($part_table,[undef,$part]);
           undef(%ids_by_part);
           my @Result = &Apache::lonmysql::get_rows($part_table);
           foreach (@Result) {
               $ids_by_part{$_->[1]}=$_->[0];
         }          }
         $cache->{$name.':Status'}=$status;      }
         $cache->{$name.':section'}=$sec;      return $ids_by_part{$part} if (exists($ids_by_part{$part}));
       return undef; # error
   }
   
         if($sec eq '' || !defined($sec) || $sec eq ' ') {  sub get_part {
             $sec = 'none';      my ($part_id) = @_;
         }      if (! exists($parts_by_id{$part_id})  || 
         if(defined($cache->{'sectionList'})) {          ! defined($parts_by_id{$part_id}) ||
             if($cache->{'sectionList'} !~ /(^$sec:|^$sec$|:$sec$|:$sec:)/) {          $parts_by_id{$part_id} eq '') {
                 $cache->{'sectionList'} .= ':'.$sec;          my @Result = &Apache::lonmysql::get_rows($part_table);
             }          foreach (@Result) {
         } else {              $parts_by_id{$_->[0]}=$_->[1];
             $cache->{'sectionList'} = $sec;  
         }          }
     }      }
       return $parts_by_id{$part_id} if(exists($parts_by_id{$part_id}));
     $cache->{'ClasslistTimestamp'}=time;      return undef; # error
     $cache->{'NamesOfStudents'}=join(':::',@names);  
   
     return @names;  
 }  }
   
 =pod  ################################################
   ################################################
   
 =item &ProcessStudentData()  =pod
   
 Takes the course data downloaded for a student in   =item &get_symb_id()
 &DownloadCourseInformation() 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  Get the MySQL id of a symb.
   
 Input: $cache, $courseData, $name  Input: $symb
   
 $cache: A hash pointer to store data  Output: undef on error, integer $symb_id on success.
   
 $courseData:  A hash pointer that points to the course data downloaded for a   =item &get_symb()
 student.  
   
 $name:  username:domain  Get the symb associated with a MySQL symb_id.
   
 Output: None  Input: $symb_id
   
 *NOTE:  There is no output, but an error message is stored away in the cache   Output: undef on error, $symb on success.
 data.  This is checked in &FormatStudentData().  The key username:domain:error   
 will only exist if an error occured.  The error is an error from   
 &DownloadCourseInformation().  
   
 =back  
   
 =cut  =cut
   
 sub ProcessStudentData {  ################################################
     my ($cache,$courseData,$name)=@_;  ################################################
   
     if(!&CheckDateStampError($courseData, $cache, $name)) {  my $have_read_symb_table = 0;
         return;  my %ids_by_symb;
   my %symbs_by_id;
   
   sub get_symb_id {
       my ($symb) = @_;
       if (! $have_read_symb_table) {
           my @Result = &Apache::lonmysql::get_rows($symb_table);
           foreach (@Result) {
               $ids_by_symb{$_->[1]}=$_->[0];
           }
           $have_read_symb_table = 1;
       }
       if (! exists($ids_by_symb{$symb})) {
           &Apache::lonmysql::store_row($symb_table,[undef,$symb]);
           undef(%ids_by_symb);
           my @Result = &Apache::lonmysql::get_rows($symb_table);
           foreach (@Result) {
               $ids_by_symb{$_->[1]}=$_->[0];
           }
     }      }
       return $ids_by_symb{$symb} if(exists( $ids_by_symb{$symb}));
       return undef; # error
   }
   
     # user name:domain was prepended earlier in DownloadCourseInformation  sub get_symb {
     foreach (keys %$courseData) {      my ($symb_id) = @_;
         $cache->{$_}=$courseData->{$_};      if (! exists($symbs_by_id{$symb_id})  || 
           ! defined($symbs_by_id{$symb_id}) ||
           $symbs_by_id{$symb_id} eq '') {
           my @Result = &Apache::lonmysql::get_rows($symb_table);
           foreach (@Result) {
               $symbs_by_id{$_->[0]}=$_->[1];
           }
     }      }
       return $symbs_by_id{$symb_id} if(exists( $symbs_by_id{$symb_id}));
     return;      return undef; # error
 }  }
   
   ################################################
   ################################################
   
 =pod  =pod
   
 =item &ExtractStudentData()  =item &get_student_id()
   
 HISTORY: This function originally existed in every statistics module,  Get the MySQL id of a student.
 and performed different tasks, the had some overlap.  Due to the need  
 for the data from the different modules, they were combined into  
 a single function.  
   
 This function now extracts all the necessary course data for a student  
 from what was downloaded from their homeserver.  There is some extra  
 time overhead compared to the ProcessStudentInformation function, but  
 it would have had to occurred at some point anyways.  This is now  
 typically called while downloading the data it will process.  It is  
 the brother function to ProcessStudentInformation.  
   
 =over 4  Input: $sname, $dom
   
 Input: $input, $output, $data, $name  Output: undef on error, integer $student_id on success.
   
 $input: A hash that contains the input data to be processed  =item &get_student()
   
 $output: A hash to contain the processed data  Get student username:domain associated with the MySQL student_id.
   
 $data: A hash containing the information on what is to be  Input: $student_id
 processed and how (basically).  
   
 $name:  username:domain  Output: undef on error, string $student (username:domain) on success.
   
 The input is slightly different here, but is quite simple.  =cut
 It is currently used where the $input, $output, and $data  
 can and are often the same hashes, but they do not need  
 to be.  
   
 Output: None  ################################################
   ################################################
   
 *NOTE:  There is no output, but an error message is stored away in the cache   my $have_read_student_table = 0;
 data.  This is checked in &FormatStudentData().  The key username:domain:error   my %ids_by_student;
 will only exist if an error occured.  The error is an error from   my %students_by_id;
 &DownloadCourseInformation().  
   sub get_student_id {
       my ($sname,$sdom) = @_;
       my $student = $sname.':'.$sdom;
       if (! $have_read_student_table) {
           my @Result = &Apache::lonmysql::get_rows($student_table);
           foreach (@Result) {
               $ids_by_student{$_->[1]}=$_->[0];
           }
           $have_read_student_table = 1;
       }
       if (! exists($ids_by_student{$student})) {
           &Apache::lonmysql::store_row($student_table,[undef,$student,undef]);
           undef(%ids_by_student);
           my @Result = &Apache::lonmysql::get_rows($student_table);
           foreach (@Result) {
               $ids_by_student{$_->[1]}=$_->[0];
           }
       }
       return $ids_by_student{$student} if(exists( $ids_by_student{$student}));
       return undef; # error
   }
   
 =back  sub get_student {
       my ($student_id) = @_;
       if (! exists($students_by_id{$student_id})  || 
           ! defined($students_by_id{$student_id}) ||
           $students_by_id{$student_id} eq '') {
           my @Result = &Apache::lonmysql::get_rows($student_table);
           foreach (@Result) {
               $students_by_id{$_->[0]}=$_->[1];
           }
       }
       return $students_by_id{$student_id} if(exists($students_by_id{$student_id}));
       return undef; # error
   }
   
 =cut  ################################################
   ################################################
   
 sub ExtractStudentData {  =pod
     my ($input, $output, $data, $name)=@_;  
   
     if(!&CheckDateStampError($input, $data, $name)) {  =item &update_full_student_data($sname,$sdom,$courseid)
         return;  
     }  
   
     my ($username,$domain)=split(':',$name);  Does a lonnet::dump on a student to populate the courses tables.
   
     my $Version;  Input: $sname, $sdom, $courseid
     my $problemsCorrect = 0;  
     my $totalProblems   = 0;  
     my $problemsSolved  = 0;  
     my $numberOfParts   = 0;  
     my $totalAwarded    = 0;  
     foreach my $sequence (split(':', $data->{'orderedSequences'})) {  
         foreach my $problemID (split(':', $data->{$sequence.':problems'})) {  
             my $problem = $data->{$problemID.':problem'};  
             my $LatestVersion = $input->{$name.':version:'.$problem};  
   
             # Output dashes for all the parts of this problem if there  
             # is no version information about the current problem.  
             if(!$LatestVersion) {  
                 foreach my $part (split(/\:/,$data->{$sequence.':'.  
                                                       $problemID.  
                                                       ':parts'})) {  
                     $output->{$name.':'.$problemID.':'.$part.':tries'} = 0;  
                     $output->{$name.':'.$problemID.':'.$part.':awarded'} = 0;  
                     $output->{$name.':'.$problemID.':'.$part.':code'} = ' ';  
                     $totalProblems++;  
                 }  
                 $output->{$name.':'.$problemID.':NoVersion'} = 'true';  
                 next;  
             }  
   
             my %partData=undef;  Output: $returnstatus
             # Initialize part data, display skips correctly  
             # Skip refers to when a student made no submissions on that  
             # part/problem.  
             foreach my $part (split(/\:/,$data->{$sequence.':'.  
                                                  $problemID.  
                                                  ':parts'})) {  
                 $partData{$part.':tries'}=0;  
                 $partData{$part.':code'}=' ';  
                 $partData{$part.':awarded'}=0;  
                 $partData{$part.':timestamp'}=0;  
                 foreach my $response (split(':', $data->{$sequence.':'.  
                                                          $problemID.':'.  
                                                          $part.':responseIDs'})) {  
                     $partData{$part.':'.$response.':submission'}='';  
                 }  
             }  
   
             # Looping through all the versions of each part, starting with the  $returnstatus is a string describing any errors that occured.  'okay' is the
             # oldest version.  Basically, it gets the most recent   default.
             # set of grade data for each part.  
             my @submissions = ();  This subroutine loads a students data using lonnet::dump and inserts
     for(my $Version=1; $Version<=$LatestVersion; $Version++) {  it into the MySQL database.  The inserts are done on three tables, 
                 foreach my $part (split(/\:/,$data->{$sequence.':'.  $fulldump_response_table, $fulldump_part_table, and $fulldump_timestamp_table.
                                                      $problemID.  The INSERT calls are made directly by this subroutine, not through lonmysql 
                                                      ':parts'})) {  because we do a 'bulk'insert which takes advantage of MySQLs non-SQL 
   compliant INSERT command to insert multiple rows at a time.  
                     if(!defined($input->{"$name:$Version:$problem".  If anything has gone wrong during this process, $returnstatus is updated with 
                                          ":resource.$part.solved"})) {  a description of the error.
                         # No grade for this submission, so skip  
                         next;  Once the "fulldump" tables are updated, the tables used for chart and
                     }  spreadsheet (which hold only the current state of the student on their
   homework, not historical data) are updated.  If all updates have occured 
   successfully, the studentdata table is updated to reflect the time of the
   update.
   
   Notice we do not insert the data and immediately query it.  This means it
   is possible for there to be data returned this first time that is not 
   available the second time.  CYA.
   
                     my $tries=0;  =cut
                     my $code=' ';  
                     my $awarded=0;  
   
                     $tries = $input->{$name.':'.$Version.':'.$problem.  
                                       ':resource.'.$part.'.tries'};  
                     $awarded = $input->{$name.':'.$Version.':'.$problem.  
                                         ':resource.'.$part.'.awarded'};  
   
                     $partData{$part.':awarded'}=($awarded) ? $awarded : 0;  
                     $partData{$part.':tries'}=($tries) ? $tries : 0;  
   
                     $partData{$part.':timestamp'}=$input->{$name.':'.$Version.':'.  
                                                            $problem.  
                                                            ':timestamp'};  
                     if(!$input->{$name.':'.$Version.':'.$problem.':resource.'.$part.  
                                  '.previous'}) {  
                         foreach my $response (split(':',  
                                                    $data->{$sequence.':'.  
                                                            $problemID.':'.  
                                                            $part.':responseIDs'})) {  
                             @submissions=($input->{$name.':'.$Version.':'.  
                                                    $problem.  
                                                    ':resource.'.$part.'.'.  
                                                    $response.'.submission'},  
                                           @submissions);  
                         }  
                     }  
   
                     my $val = $input->{$name.':'.$Version.':'.$problem.  ################################################
                                        ':resource.'.$part.'.solved'};  ################################################
                     if    ($val eq 'correct_by_student')   {$code = '*';}   sub update_full_student_data {
                     elsif ($val eq 'correct_by_override')  {$code = '+';}      my ($sname,$sdom,$courseid) = @_;
                     elsif ($val eq 'incorrect_attempted')  {$code = '.';}       #
                     elsif ($val eq 'incorrect_by_override'){$code = '-';}      # Set up database names
                     elsif ($val eq 'excused')              {$code = 'x';}      &setup_table_names($courseid);
                     elsif ($val eq 'ungraded_attempted')   {$code = '#';}      #
                     else                                   {$code = ' ';}      my $student_id = &get_student_id($sname,$sdom);
                     $partData{$part.':code'}=$code;      my $student = $sname.':'.$sdom;
                 }      #
       my $returnstatus = 'okay';
       #
       # Download students data
       my $time_of_retrieval = time;
       my @tmp = &Apache::lonnet::dump($courseid,$sdom,$sname);
       if (@tmp && $tmp[0] =~ /^error/) {
           $returnstatus = 'error retrieving full student data';
           return $returnstatus;
       } elsif (! @tmp) {
           $returnstatus = 'okay: no student data';
           return $returnstatus;
       }
       my %studentdata = @tmp;
       #
       # Get database handle and clean out the tables 
       my $dbh = &Apache::lonmysql::get_dbh();
       $dbh->do('DELETE FROM '.$fulldump_response_table.' WHERE student_id='.
                $student_id);
       $dbh->do('DELETE FROM '.$fulldump_part_table.' WHERE student_id='.
                $student_id);
       $dbh->do('DELETE FROM '.$fulldump_timestamp_table.' WHERE student_id='.
                $student_id);
       #
       # Parse and store the data into a form we can handle
       my $partdata;
       my $respdata;
       while (my ($key,$value) = each(%studentdata)) {
           next if ($key =~ /^(\d+):(resource$|subnum$|keys:)/);
           my ($transaction,$symb,$parameter) = split(':',$key);
           my $symb_id = &get_symb_id($symb);
           if ($parameter eq 'timestamp') {
               # We can deal with 'timestamp' right away
               my @timestamp_storage = ($symb_id,$student_id,
                                        $transaction,$value);
               my $store_command = 'INSERT INTO '.$fulldump_timestamp_table.
                   " VALUES ('".join("','",@timestamp_storage)."');";
               $dbh->do($store_command);
               if ($dbh->err()) {
                   &Apache::lonnet::logthis('unable to execute '.$store_command);
                   &Apache::lonnet::logthis($dbh->errstr());
             }              }
               next;
             foreach my $part (split(/\:/,$data->{$sequence.':'.$problemID.          } elsif ($parameter eq 'version') {
                                                  ':parts'})) {              next;
                 $output->{$name.':'.$problemID.':'.$part.':wrong'} =           } elsif ($parameter =~ /^resource\.(.*)\.(tries|
                     $partData{$part.':tries'};                                                    award|
                                                     awarded|
                 if($partData{$part.':code'} eq '*') {                                                    previous|
                     $output->{$name.':'.$problemID.':'.$part.':wrong'}--;                                                    solved|
                     $problemsCorrect++;                                                    awarddetail|
                 } elsif($partData{$part.':code'} eq '+') {                                                    submission|
                     $output->{$name.':'.$problemID.':'.$part.':wrong'}--;                                                    submissiongrading|
                     $problemsCorrect++;                                                    molecule)\s*$/x){
               # we do not have enough information to store an 
               # entire row, so we save it up until later.
               my ($part_and_resp_id,$field) = ($1,$2);
               my ($part,$part_id,$resp,$resp_id);
               if ($part_and_resp_id =~ /\./) {
                   ($part,$resp) = split(/\./,$part_and_resp_id);
                   $part_id = &get_part_id($part);
                   $resp_id = &get_part_id($resp);
               } else {
                   $part_id = &get_part_id($part_and_resp_id);
               }
               # Deal with part specific data
               if ($field =~ /^(tries|award|awarded|previous)$/) {
                   $partdata->{$symb_id}->{$part_id}->{$transaction}->{$field}=$value;
               }
               # deal with response specific data
               if (defined($resp_id) &&
                   $field =~ /^(tries|
                                awarddetail|
                                awarded|
                                submission|
                                submissiongrading|
                                molecule)$/x) {
                   if ($field eq 'submission') {
                       # We have to be careful with user supplied input.
                       # most of the time we are okay because it is escaped.
                       # However, there is one wrinkle: submissions which end in
                       # and odd number of '\' cause insert errors to occur.  
                       # Best trap this somehow...
                       my ($offensive_string) = ($value =~ /(\\+)$/);
                       if (length($offensive_string) % 2) {
                           $value =~ s/\\$/\\\\/;
                       }
                 }                  }
                   if ($field eq 'submissiongrading' || 
                 $output->{$name.':'.$problemID.':'.$part.':tries'} =                       $field eq 'molecule') {
                     $partData{$part.':tries'};                      $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific'}=$field;
                 $output->{$name.':'.$problemID.':'.$part.':code'} =                      $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific_value'}=$value;
                     $partData{$part.':code'};                  } else {
                 $output->{$name.':'.$problemID.':'.$part.':awarded'} =                      $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{$field}=$value;
                     $partData{$part.':awarded'};  
                 $totalAwarded += $partData{$part.':awarded'};  
                 $output->{$name.':'.$problemID.':'.$part.':timestamp'} =  
                     $partData{$part.':timestamp'};  
                 foreach my $response (split(':', $data->{$sequence.':'.  
                                                          $problemID.':'.  
                                                          $part.':responseIDs'})) {  
                     $output->{$name.':'.$problemID.':'.$part.':'.$response.  
                               ':submission'}=join(':::',@submissions);  
                 }                  }
               }
                 if($partData{$part.':code'} ne 'x') {          }
                     $totalProblems++;      }
       ##
       ## Store the part data
       my $store_command = 'INSERT INTO '.$fulldump_part_table.
           ' VALUES '."\n";
       my $store_rows = 0;
       while (my ($symb_id,$hash1) = each (%$partdata)) {
           while (my ($part_id,$hash2) = each (%$hash1)) {
               while (my ($transaction,$data) = each (%$hash2)) {
                   $store_command .= "('".join("','",$symb_id,$part_id,
                                               $student_id,
                                               $transaction,
                                               $data->{'tries'},
                                               $data->{'award'},
                                               $data->{'awarded'},
                                               $data->{'previous'})."'),";
                   $store_rows++;
               }
           }
       }
       if ($store_rows) {
           chop($store_command);
           $dbh->do($store_command);
           if ($dbh->err) {
               $returnstatus = 'error storing part data';
               &Apache::lonnet::logthis('insert error '.$dbh->errstr());
               &Apache::lonnet::logthis("While attempting\n".$store_command);
           }
       }
       ##
       ## Store the response data
       $store_command = 'INSERT INTO '.$fulldump_response_table.
           ' VALUES '."\n";
       $store_rows = 0;
       while (my ($symb_id,$hash1) = each (%$respdata)) {
           while (my ($part_id,$hash2) = each (%$hash1)) {
               while (my ($resp_id,$hash3) = each (%$hash2)) {
                   while (my ($transaction,$data) = each (%$hash3)) {
                       $store_command .= "('".join("','",$symb_id,$part_id,
                                                   $resp_id,$student_id,
                                                   $transaction,
                                                   $data->{'tries'},
                                                   $data->{'awarddetail'},
                                                   $data->{'awarded'},
                                                   $data->{'response_specific'},
                                                   $data->{'response_specific_value'},
                                                   $data->{'submission'})."'),";
                       $store_rows++;
                 }                  }
             }              }
         }          }
   
         $output->{$name.':'.$sequence.':problemsCorrect'} = $problemsCorrect;  
         $problemsSolved += $problemsCorrect;  
  $problemsCorrect=0;  
     }      }
       if ($store_rows) {
           chop($store_command);
           $dbh->do($store_command);
           if ($dbh->err) {
               $returnstatus = 'error storing response data';
               &Apache::lonnet::logthis('insert error '.$dbh->errstr());
               &Apache::lonnet::logthis("While attempting\n".$store_command);
           }
       }
       ##
       ## Update the students "current" data in the performance 
       ## and parameters tables.
       my ($status,undef) = &store_student_data
           ($sname,$sdom,$courseid,
            &Apache::lonnet::convert_dump_to_currentdump(\%studentdata));
       if ($returnstatus eq 'okay' && $status ne 'okay') {
           $returnstatus = 'error storing current data:'.$status;
       } elsif ($status ne 'okay') {
           $returnstatus .= ' error storing current data:'.$status;
       }        
       ##
       ## Update the students time......
       if ($returnstatus eq 'okay') {
           &Apache::lonmysql::replace_row
               ($studentdata_table,
                [$student_id,$time_of_retrieval,$time_of_retrieval,undef,undef]);
       }
       return $returnstatus;
   }
   
     $output->{$name.':problemsSolved'} = $problemsSolved;  ################################################
     $output->{$name.':totalProblems'} = $totalProblems;  ################################################
     $output->{$name.':totalAwarded'} = $totalAwarded;  
   
     return;  =pod
 }  
   
 sub LoadDiscussion {  =item &update_student_data()
     my ($courseID)=@_;  
     my %Discuss=();  
     my %contrib=&Apache::lonnet::dump(  
                 $courseID,  
                 $ENV{'course.'.$courseID.'.domain'},  
                 $ENV{'course.'.$courseID.'.num'});  
     
     #my %contrib=&DownloadCourseInformation($name, $courseID, 0);  
   
     foreach my $temp(keys %contrib) {  Input: $sname, $sdom, $courseid
  if ($temp=~/^version/) {  
     my $ver=$contrib{$temp};  
     my ($dummy,$prb)=split(':',$temp);  
     for (my $idx=1; $idx<=$ver; $idx++ ) {  
  my $name=$contrib{"$idx:$prb:sendername"};  
  $Discuss{"$name:$prb"}=$idx;  
     }  
  }  
     }         
   
     return \%Discuss;  Output: $returnstatus, \%student_data
   
   $returnstatus is a string describing any errors that occured.  'okay' is the
   default.
   \%student_data is the data returned by a call to lonnet::currentdump.
   
   This subroutine loads a students data using lonnet::currentdump and inserts
   it into the MySQL database.  The inserts are done on two tables, 
   $performance_table and $parameters_table.  $parameters_table holds the data 
   that is not included in $performance_table.  See the description of 
   $performance_table elsewhere in this file.  The INSERT calls are made
   directly by this subroutine, not through lonmysql because we do a 'bulk'
   insert which takes advantage of MySQLs non-SQL compliant INSERT command to 
   insert multiple rows at a time.  If anything has gone wrong during this
   process, $returnstatus is updated with a description of the error and
   \%student_data is returned.  
   
   Notice we do not insert the data and immediately query it.  This means it
   is possible for there to be data returned this first time that is not 
   available the second time.  CYA.
   
   =cut
   
   ################################################
   ################################################
   sub update_student_data {
       my ($sname,$sdom,$courseid) = @_;
       #
       # Set up database names
       &setup_table_names($courseid);
       #
       my $student_id = &get_student_id($sname,$sdom);
       my $student = $sname.':'.$sdom;
       #
       my $returnstatus = 'okay';
       #
       # Download students data
       my $time_of_retrieval = time;
       my @tmp = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
       if ((scalar(@tmp) > 0) && ($tmp[0] =~ /^error:/)) {
           &Apache::lonnet::logthis('error getting data for '.
                                    $sname.':'.$sdom.' in course '.$courseid.
                                    ':'.$tmp[0]);
           $returnstatus = 'error getting data';
           return ($returnstatus,undef);
       }
       if (scalar(@tmp) < 1) {
           return ('no data',undef);
       }
       my %student_data = @tmp;
       my @Results = &store_student_data($sname,$sdom,$courseid,\%student_data);
       #
       # Set the students update time
       &Apache::lonmysql::replace_row($studentdata_table,
                            [$student_id,$time_of_retrieval,undef,undef,undef]);
       #
       return @Results;
   }
   
   sub store_student_data {
       my ($sname,$sdom,$courseid,$student_data) = @_;
       #
       my $student_id = &get_student_id($sname,$sdom);
       my $student = $sname.':'.$sdom;
       #
       my $returnstatus = 'okay';
       #
       # Remove all of the students data from the table
       my $dbh = &Apache::lonmysql::get_dbh();
       $dbh->do('DELETE FROM '.$performance_table.' WHERE student_id='.
                $student_id);
       $dbh->do('DELETE FROM '.$parameters_table.' WHERE student_id='.
                $student_id);
       #
       # Store away the data
       #
       my $starttime = Time::HiRes::time;
       my $elapsed = 0;
       my $rows_stored;
       my $store_parameters_command  = 'INSERT INTO '.$parameters_table.
           ' VALUES '."\n";
       my $num_parameters = 0;
       my $store_performance_command = 'INSERT INTO '.$performance_table.
           ' VALUES '."\n";
       return ('error',undef) if (! defined($dbh));
       while (my ($current_symb,$param_hash) = each(%{$student_data})) {
           #
           # make sure the symb is set up properly
           my $symb_id = &get_symb_id($current_symb);
           #
           # Load data into the tables
           while (my ($parameter,$value) = each(%$param_hash)) {
               my $newstring;
               if ($parameter !~ /(timestamp|resource\.(.*)\.(solved|tries|awarded|award|awarddetail|previous))/) {
                   $newstring = "('".join("','",
                                          $symb_id,$student_id,
                                          $parameter)."',".
                                              $dbh->quote($value)."),\n";
                   $num_parameters ++;
                   if ($newstring !~ /''/) {
                       $store_parameters_command .= $newstring;
                       $rows_stored++;
                   }
               }
               next if ($parameter !~ /^resource\.(.*)\.solved$/);
               #
               my $part = $1;
               my $part_id = &get_part_id($part);
               next if (!defined($part_id));
               my $solved  = $value;
               my $tries   = $param_hash->{'resource.'.$part.'.tries'};
               my $awarded = $param_hash->{'resource.'.$part.'.awarded'};
               my $award   = $param_hash->{'resource.'.$part.'.award'};
               my $awarddetail = $param_hash->{'resource.'.$part.'.awarddetail'};
               my $timestamp = $param_hash->{'timestamp'};
               #
               $solved      = '' if (! defined($solved));
               $tries       = '' if (! defined($tries));
               $awarded     = '' if (! defined($awarded));
               $award       = '' if (! defined($award));
               $awarddetail = '' if (! defined($awarddetail));
               $newstring = "('".join("','",$symb_id,$student_id,$part_id,$part,
                                      $solved,$tries,$awarded,$award,
                                      $awarddetail,$timestamp)."'),\n";
               $store_performance_command .= $newstring;
               $rows_stored++;
           }
       }
       chop $store_parameters_command;
       chop $store_parameters_command;
       chop $store_performance_command;
       chop $store_performance_command;
       my $start = Time::HiRes::time;
       $dbh->do($store_parameters_command) if ($num_parameters>0);
       if ($dbh->err()) {
           &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
           &Apache::lonnet::logthis('command = '.$store_parameters_command);
           &Apache::lonnet::logthis('rows_stored = '.$rows_stored);
           &Apache::lonnet::logthis('student_id = '.$student_id);
           $returnstatus = 'error: unable to insert parameters into database';
           return ($returnstatus,$student_data);
       }
       $dbh->do($store_performance_command);
       if ($dbh->err()) {
           &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
           &Apache::lonnet::logthis('command = '.$store_performance_command);
           $returnstatus = 'error: unable to insert performance into database';
           return ($returnstatus,$student_data);
       }
       $elapsed += Time::HiRes::time - $start;
       return ($returnstatus,$student_data);
 }  }
   
 # ----- END PROCESSING FUNCTIONS ---------------------------------------  ######################################
   ######################################
   
 =pod  =pod
   
 =head1 HELPER FUNCTIONS  =item &ensure_tables_are_set_up($courseid)
   
 These are just a couple of functions do various odd and end   Checks to be sure the MySQL tables for the given class are set up.
 jobs.  There was also a couple of bulk functions added.  These are  If $courseid is omitted it will be obtained from the environment.
 &DownloadStudentCourseData(), &DownloadStudentCourseDataSeparate(), and  
 &CheckForResidualDownload().  These functions now act as the interface  
 for downloading student course data.  The statistical modules should  
 no longer make the calls to dump and download and process etc.  They  
 make calls to these bulk functions to get their data.  
   
 =cut  Returns nothing on success and 'error' on failure
   
 # ----- HELPER FUNCTIONS -----------------------------------------------  =cut
   
 sub CheckDateStampError {  ######################################
     my ($courseData, $cache, $name)=@_;  ######################################
     if($courseData->{$name.':UpToDate'} eq 'true') {  sub ensure_tables_are_set_up {
         $cache->{$name.':lastDownloadTime'} =       my ($courseid) = @_;
             $courseData->{$name.':lastDownloadTime'};      $courseid = $ENV{'request.course.id'} if (! defined($courseid));
         if($courseData->{$name.':lastDownloadTime'} eq 'Not downloaded') {      # 
             $cache->{$name.':updateTime'} = ' Not updated';      # Clean out package variables
         } else {      &setup_table_names($courseid);
             $cache->{$name.':updateTime'}=      #
                 localtime($courseData->{$name.':lastDownloadTime'});      # if the tables do not exist, make them
       my @CurrentTable = &Apache::lonmysql::tables_in_db();
       my ($found_symb,$found_student,$found_part,$found_studentdata,
           $found_performance,$found_parameters,$found_fulldump_part,
           $found_fulldump_response,$found_fulldump_timestamp);
       foreach (@CurrentTable) {
           $found_symb        = 1 if ($_ eq $symb_table);
           $found_student     = 1 if ($_ eq $student_table);
           $found_part        = 1 if ($_ eq $part_table);
           $found_studentdata = 1 if ($_ eq $studentdata_table);
           $found_performance = 1 if ($_ eq $performance_table);
           $found_parameters  = 1 if ($_ eq $parameters_table);
           $found_fulldump_part      = 1 if ($_ eq $fulldump_part_table);
           $found_fulldump_response  = 1 if ($_ eq $fulldump_response_table);
           $found_fulldump_timestamp = 1 if ($_ eq $fulldump_timestamp_table);
       }
       if (!$found_symb        || !$found_studentdata || 
           !$found_student     || !$found_part   ||
           !$found_performance || !$found_parameters ||
           !$found_fulldump_part || !$found_fulldump_response ||
           !$found_fulldump_timestamp ) {
           if (&init_dbs($courseid)) {
               return 'error';
         }          }
         return 0;  
     }      }
   }
   
     $cache->{$name.':lastDownloadTime'}=$courseData->{$name.':lastDownloadTime'};  ################################################
     if($courseData->{$name.':lastDownloadTime'} eq 'Not downloaded') {  ################################################
         $cache->{$name.':updateTime'} = ' Not updated';  
     } else {  
         $cache->{$name.':updateTime'}=  
             localtime($courseData->{$name.':lastDownloadTime'});  
     }  
   
     if(defined($courseData->{$name.':error'})) {  =pod
         $cache->{$name.':error'}=$courseData->{$name.':error'};  
         return 0;  =item &ensure_current_data()
     }  
   Input: $sname, $sdom, $courseid
   
   Output: $status, $data
   
     return 1;  This routine ensures the data for a given student is up to date.
   The $studentdata_table is queried to determine the time of the last update.  
   If the students data is out of date, &update_student_data() is called.  
   The return values from the call to &update_student_data() are returned.
   
   =cut
   
   ################################################
   ################################################
   sub ensure_current_data {
       my ($sname,$sdom,$courseid) = @_;
       my $status = 'okay';   # return value
       #
       $courseid = $ENV{'request.course.id'} if (! defined($courseid));
       &ensure_tables_are_set_up($courseid);
       #
       # Get the update time for the user
       my $updatetime = 0;
       my $modifiedtime = &Apache::lonnet::GetFileTimestamp
           ($sdom,$sname,$courseid.'.db',
            $Apache::lonnet::perlvar{'lonUsersDir'});
       #
       my $student_id = &get_student_id($sname,$sdom);
       my @Result = &Apache::lonmysql::get_rows($studentdata_table,
                                                "student_id ='$student_id'");
       my $data = undef;
       if (@Result) {
           $updatetime = $Result[0]->[1];
       }
       if ($modifiedtime > $updatetime) {
           ($status,$data) = &update_student_data($sname,$sdom,$courseid);
       }
       return ($status,$data);
 }  }
   
   ################################################
   ################################################
   
 =pod  =pod
   
 =item &ProcessFullName()  =item &ensure_current_full_data($sname,$sdom,$courseid)
   
 Takes lastname, generation, firstname, and middlename (or some partial  Input: $sname, $sdom, $courseid
 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  Output: $status
   
 sub ProcessFullName {  This routine ensures the fulldata (the data from a lonnet::dump, not a
     my ($lastname, $generation, $firstname, $middlename)=@_;  lonnet::currentdump) for a given student is up to date.
     my $Str = '';  The $studentdata_table is queried to determine the time of the last update.  
   If the students fulldata is out of date, &update_full_student_data() is
   called.  
   
     if($lastname ne '') {  The return value from the call to &update_full_student_data() is returned.
  $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;  =cut
   
   ################################################
   ################################################
   sub ensure_current_full_data {
       my ($sname,$sdom,$courseid) = @_;
       my $status = 'okay';   # return value
       #
       $courseid = $ENV{'request.course.id'} if (! defined($courseid));
       &ensure_tables_are_set_up($courseid);
       #
       # Get the update time for the user
       my $modifiedtime = &Apache::lonnet::GetFileTimestamp
           ($sdom,$sname,$courseid.'.db',
            $Apache::lonnet::perlvar{'lonUsersDir'});
       #
       my $student_id = &get_student_id($sname,$sdom);
       my @Result = &Apache::lonmysql::get_rows($studentdata_table,
                                                "student_id ='$student_id'");
       my $updatetime;
       if (@Result && ref($Result[0]) eq 'ARRAY') {
           $updatetime = $Result[0]->[2];
       }
       if (! defined($updatetime) || $modifiedtime > $updatetime) {
           $status = &update_full_student_data($sname,$sdom,$courseid);
       }
       return $status;
 }  }
   
   ################################################
   ################################################
   
 =pod  =pod
   
 =item &TestCacheData()  =item &get_student_data_from_performance_cache()
   
 Determine if the cache database can be accessed with a tie.  It waits up to  Input: $sname, $sdom, $symb, $courseid
 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  Output: hash reference containing the data for the given student.
   If $symb is undef, all the students data is returned.
   
 Input: $ChartDB  This routine is the heart of the local caching system.  See the description
   of $performance_table, $symb_table, $student_table, and $part_table.  The
   main task is building the MySQL request.  The tables appear in the request
   in the order in which they should be parsed by MySQL.  When searching
   on a student the $student_table is used to locate the 'student_id'.  All
   rows in $performance_table which have a matching 'student_id' are returned,
   with data from $part_table and $symb_table which match the entries in
   $performance_table, 'part_id' and 'symb_id'.  When searching on a symb,
   the $symb_table is processed first, with matching rows grabbed from 
   $performance_table and filled in from $part_table and $student_table in
   that order.  
   
 $ChartDB: The name of the cache database to be opened  Running 'EXPLAIN ' on the 'SELECT' statements generated can be quite 
   interesting, especially if you play with the order the tables are listed.  
   
 Output: -1, 0, 1  =cut
   
 -1: Couldn't tie database  ################################################
  0: Use cached data  ################################################
  1: New cache database created, use that.  sub get_student_data_from_performance_cache {
       my ($sname,$sdom,$symb,$courseid)=@_;
       my $student = $sname.':'.$sdom if (defined($sname) && defined($sdom));
       &setup_table_names($courseid);
       #
       # Return hash
       my $studentdata;
       #
       my $dbh = &Apache::lonmysql::get_dbh();
       my $request = "SELECT ".
           "d.symb,a.part,a.solved,a.tries,a.awarded,a.award,a.awarddetail,".
               "a.timestamp ";
       if (defined($student)) {
           $request .= "FROM $student_table AS b ".
               "LEFT JOIN $performance_table AS a ON b.student_id=a.student_id ".
   #            "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
               "LEFT JOIN $symb_table AS d ON d.symb_id = a.symb_id ".
                   "WHERE student='$student'";
           if (defined($symb) && $symb ne '') {
               $request .= " AND d.symb=".$dbh->quote($symb);
           }
       } elsif (defined($symb) && $symb ne '') {
           $request .= "FROM $symb_table as d ".
               "LEFT JOIN $performance_table AS a ON d.symb_id=a.symb_id ".
   #            "LEFT JOIN $part_table    AS c ON c.part_id = a.part_id ".
               "LEFT JOIN $student_table AS b ON b.student_id = a.student_id ".
                   "WHERE symb='".$dbh->quote($symb)."'";
       }
       my $starttime = Time::HiRes::time;
       my $rows_retrieved = 0;
       my $sth = $dbh->prepare($request);
       $sth->execute();
       if ($sth->err()) {
           &Apache::lonnet::logthis("Unable to execute MySQL request:");
           &Apache::lonnet::logthis("\n".$request."\n");
           &Apache::lonnet::logthis("error is:".$sth->errstr());
           return undef;
       }
       foreach my $row (@{$sth->fetchall_arrayref}) {
           $rows_retrieved++;
           my ($symb,$part,$solved,$tries,$awarded,$award,$awarddetail,$time) = 
               (@$row);
           my $base = 'resource.'.$part;
           $studentdata->{$symb}->{$base.'.solved'}  = $solved;
           $studentdata->{$symb}->{$base.'.tries'}   = $tries;
           $studentdata->{$symb}->{$base.'.awarded'} = $awarded;
           $studentdata->{$symb}->{$base.'.award'}   = $award;
           $studentdata->{$symb}->{$base.'.awarddetail'} = $awarddetail;
           $studentdata->{$symb}->{'timestamp'} = $time if (defined($time) && $time ne '');
       }
       if (defined($symb) && $symb ne '') {
           $studentdata = $studentdata->{$symb};
       }
       return $studentdata;
   }
   
 =back  ################################################
   ################################################
   
 =cut  =pod
   
 sub TestCacheData {  =item &get_current_state()
     my ($ChartDB,$isRecalculate,$totalDelay)=@_;  
     my $isCached=-1;  
     my %testData;  
     my $tieTries=0;  
   
     if(!defined($totalDelay)) {  Input: $sname,$sdom,$symb,$courseid
         $totalDelay = 10;  
     }  
   
     if ((-e "$ChartDB") && (!$isRecalculate)) {  Output: Described below
  $isCached = 1;  
     } else {  
  $isCached = 0;  
     }  
   
     while($tieTries < $totalDelay) {  Retrieve the current status of a students performance.  $sname and
         my $result=0;  $sdom are the only required parameters.  If $symb is undef the results
         if($isCached) {  of an &Apache::lonnet::currentdump() will be returned.  
             $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_READER(),0640);  If $courseid is undef it will be retrieved from the environment.
         } else {  
             $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_NEWDB(),0640);  The return structure is based on &Apache::lonnet::currentdump.  If
         }  $symb is unspecified, all the students data is returned in a hash of
         if($result) {  the form:
             last;  ( 
     symb1 => { param1 => value1, param2 => value2 ... },
     symb2 => { param1 => value1, param2 => value2 ... },
   )
   
   If $symb is specified, a hash of 
   (
     param1 => value1, 
     param2 => value2,
   )
   is returned.
   
   If no data is found for $symb, or if the student has no performance data,
   an empty list is returned.
   
   =cut
   
   ################################################
   ################################################
   sub get_current_state {
       my ($sname,$sdom,$symb,$courseid,$forcedownload)=@_;
       #
       $courseid = $ENV{'request.course.id'} if (! defined($courseid));
       #
       return () if (! defined($sname) || ! defined($sdom));
       #
       my ($status,$data) = &ensure_current_data($sname,$sdom,$courseid);
   #    &Apache::lonnet::logthis
   #        ('sname = '.$sname.
   #         ' domain = '.$sdom.
   #         ' status = '.$status.
   #         ' data is '.(defined($data)?'defined':'undefined'));
   #    while (my ($symb,$hash) = each(%$data)) {
   #        &Apache::lonnet::logthis($symb."\n----------------------------------");
   #        while (my ($key,$value) = each (%$hash)) {
   #            &Apache::lonnet::logthis("   ".$key." = ".$value);
   #        }
   #    }
       #
       if (defined($data) && defined($symb) && ref($data->{$symb})) {
           return %{$data->{$symb}};
       } elsif (defined($data) && ! defined($symb) && ref($data)) {
           return %$data;
       } 
       if ($status eq 'no data') {
           return ();
       } else {
           if ($status ne 'okay' && $status ne '') {
               &Apache::lonnet::logthis('status = '.$status);
               return ();
         }          }
         $tieTries++;          my $returnhash = &get_student_data_from_performance_cache($sname,$sdom,
         sleep 1;                                                        $symb,$courseid);
     }          return %$returnhash if (defined($returnhash));
     if($tieTries >= $totalDelay) {  
         return -1;  
     }      }
       return ();
   }
   
     untie(%testData);  ################################################
   ################################################
   
     return $isCached;  =pod
 }  
   
 sub DownloadStudentCourseData {  =item &get_problem_statistics()
     my ($students,$checkDate,$cacheDB,$extract,$status,$courseID,$r,$c)=@_;  
   
     my $title = 'LON-CAPA Statistics';  Gather data on a given problem.  The database is assumed to be 
     my $heading = 'Download and Process Course Data';  populated and all local caching variables are assumed to be set
     my $studentCount = scalar(@$students);  properly.  This means you need to call &ensure_current_data for
     my %cache;  the students you are concerned with prior to calling this routine.
   
   Inputs: $students, $symb, $part, $courseid
   
     my $WhatIWant;  =over 4
     $WhatIWant = '(^version:|';  
     $WhatIWant .= '^\d+:.+?:(resource\.\d+\.';  
     $WhatIWant .= '(solved|tries|previous|awarded|(\d+\.submission))\s*$';  
     $WhatIWant .= '|timestamp)';  
     $WhatIWant .= ')';  
 #    $WhatIWant = '.';  
   
     if($status eq 'true') {  =item $students is an array of hash references.  
         &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);  Each hash must contain at least the 'username' and 'domain' of a student.
     }  
   
     my $displayString;  =item $symb is the symb for the problem.
     my $count=0;  
     foreach (@$students) {  
         if($c->aborted()) { return 'Aborted'; }  
   
         if($status eq 'true') {  =item $part is the part id you need statistics for
             $count++;  
             my $displayString = $count.'/'.$studentCount.': '.$_;  
             &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);  
         }  
   
         my $downloadTime='Not downloaded';  =item $courseid is the course id, of course!
         if($checkDate eq 'true'  &&   
            tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
             $downloadTime = $cache{$_.':lastDownloadTime'};  
             untie(%cache);  
         }  
   
         if($c->aborted()) { return 'Aborted'; }  =back
   
         if($downloadTime eq 'Not downloaded') {  Outputs: See the code for up to date information.  A hash reference is
             my $courseData =   returned.  The hash has the following keys defined:
                 &DownloadCourseInformation($_, $courseID, $downloadTime,   
                                            $WhatIWant);  
             if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) {  
                 foreach my $key (keys(%$courseData)) {  
                     if($key =~ /^(con_lost|error|no_such_host)/i) {  
                         $courseData->{$_.':error'} = 'No course data for '.$_;  
                         last;  
                     }  
                 }  
                 if($extract eq 'true') {  
                     &ExtractStudentData($courseData, \%cache, \%cache, $_);  
                 } else {  
                     &ProcessStudentData(\%cache, $courseData, $_);  
                 }  
                 untie(%cache);  
             } else {  
                 next;  
             }  
         }  
     }  
     if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }  
   
     return 'OK';  =over 4
 }  
   
 sub DownloadStudentCourseDataSeparate {  =item num_students The number of students attempting the problem
     my ($students,$checkDate,$cacheDB,$extract,$status,$courseID,$r,$c)=@_;        
     my $residualFile = '/home/httpd/perl/tmp/'.$courseID.'DownloadFile.db';  =item tries The total number of tries for the students
     my $title = 'LON-CAPA Statistics';        
     my $heading = 'Download Course Data';  =item max_tries The maximum number of tries taken
         
   =item mean_tries The average number of tries
         
   =item num_solved The number of students able to solve the problem
         
   =item num_override The number of students whose answer is 'correct_by_override'
         
   =item deg_of_diff The degree of difficulty of the problem
         
   =item std_tries The standard deviation of the number of tries
         
   =item skew_tries The skew of the number of tries
   
     my $WhatIWant;  =item per_wrong The number of students attempting the problem who were not
     $WhatIWant = '(^version:|';  able to answer it correctly.
     $WhatIWant .= '^\d+:.+?:(resource\.\d+\.';  
     $WhatIWant .= '(solved|tries|previous|awarded|(\d+\.submission))\s*$';  
     $WhatIWant .= '|timestamp)';  
     $WhatIWant .= ')';  
   
     &CheckForResidualDownload($courseID, $cacheDB, $students, $c);  =back
   
     my %cache;  =cut
   
     my $studentCount = scalar(@$students);  ################################################
     if($status eq 'true') {  ################################################
         &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);  sub get_problem_statistics {
       my ($students,$symb,$part,$courseid) = @_;
       return if (! defined($symb) || ! defined($part));
       $courseid = $ENV{'request.course.id'} if (! defined($courseid));
       #
       my $symb_id = &get_symb_id($symb);
       my $part_id = &get_part_id($part);
       my $stats_table = $courseid.'_problem_stats';
       #
       my $dbh = &Apache::lonmysql::get_dbh();
       return undef if (! defined($dbh));
       #
       # A) Number of Students attempting problem
       # B) Total number of tries of students attempting problem
       # C) Mod (largest number of tries for solving the problem)
       # D) Mean (average number of tries for solving the problem)
       # E) Number of students to solve the problem
       # F) Number of students to solve the problem by override
       # G) Number of students unable to solve the problem
       # H) Degree of difficulty : 1-(E+F)/B
       # I) Standard deviation of number of tries
       # J) Skew of tries: sqrt(sum(Xi-D)^3)/A
       #
       $dbh->do('DROP TABLE '.$stats_table);  # May return an error
       my $request = 
           'CREATE TEMPORARY TABLE '.$stats_table.
               ' SELECT student_id,solved,award,tries FROM '.$performance_table.
                   ' WHERE symb_id='.$symb_id.' AND part_id='.$part_id;
       if (defined($students)) {
           $request .= ' AND ('.
               join(' OR ', map {'student_id='.
                                     &get_student_id($_->{'username'},
                                                     $_->{'domain'})
                                     } @$students
                    ).')';
       }
   #    &Apache::lonnet::logthis($request);
       $dbh->do($request);
       my ($num,$tries,$mod,$mean,$STD) = &execute_SQL_request
           ($dbh,
            'SELECT COUNT(*),SUM(tries),MAX(tries),AVG(tries),STD(tries) FROM '.
            $stats_table);
       my ($Solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
                                           $stats_table.
                                           " WHERE solved='correct_by_student'");
       my ($solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
                                           $stats_table.
                                           " WHERE solved='correct_by_override'");
       $num    = 0 if (! defined($num));
       $tries  = 0 if (! defined($tries));
       $mod    = 0 if (! defined($mod));
       $STD    = 0 if (! defined($STD));
       $Solved = 0 if (! defined($Solved));
       $solved = 0 if (! defined($solved));
       #
       my $DegOfDiff = 'nan';
       $DegOfDiff = 1-($Solved)/$tries if ($tries>0);
   
       my $SKEW = 'nan';
       my $wrongpercent = 0;
       if ($num > 0) {
           ($SKEW) = &execute_SQL_request($dbh,'SELECT SQRT(SUM('.
                                        'POWER(tries - '.$STD.',3)'.
                                        '))/'.$num.' FROM '.$stats_table);
           $wrongpercent=int(10*100*($num-$Solved+$solved)/$num)/10;
       }
       #
       $dbh->do('DROP TABLE '.$stats_table);  # May return an error
       #
       # Store in metadata
       #
       if ($num) {
    my %storestats=();
   
           my $urlres=(&Apache::lonnet::decode_symb($symb))[2];
   
    $storestats{$courseid.'___'.$urlres.'___timestamp'}=time;       
    $storestats{$courseid.'___'.$urlres.'___stdno'}=$num;
    $storestats{$courseid.'___'.$urlres.'___avetries'}=$mean;   
    $storestats{$courseid.'___'.$urlres.'___difficulty'}=$DegOfDiff;
   
    $urlres=~/^(\w+)\/(\w+)/; 
    &Apache::lonnet::put('nohist_resevaldata',\%storestats,$1,$2); 
       }
       #
       # Return result
       #
       return { num_students => $num,
                tries        => $tries,
                max_tries    => $mod,
                mean_tries   => $mean,
                std_tries    => $STD,
                skew_tries   => $SKEW,
                num_solved   => $Solved,
                num_override => $solved,
                per_wrong    => $wrongpercent,
                deg_of_diff  => $DegOfDiff };
   }
   
   sub execute_SQL_request {
       my ($dbh,$request)=@_;
   #    &Apache::lonnet::logthis($request);
       my $sth = $dbh->prepare($request);
       $sth->execute();
       my $row = $sth->fetchrow_arrayref();
       if (ref($row) eq 'ARRAY' && scalar(@$row)>0) {
           return @$row;
     }      }
     my $count=0;      return ();
     my $displayString='';  }
     foreach (@$students) {  
         if($c->aborted()) {  
             return 'Aborted';  
         }  
   
         if($status eq 'true') {  
             $count++;  
             $displayString = $count.'/'.$studentCount.': '.$_;  
             &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);  
         }  
   
         my $downloadTime='Not downloaded';  ################################################
         if($checkDate eq 'true'  &&   ################################################
            tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {  
             $downloadTime = $cache{$_.':lastDownloadTime'};  
             untie(%cache);  
         }  
   
         if($c->aborted()) {  =pod
             return 'Aborted';  
         }  
   
         if($downloadTime eq 'Not downloaded') {  =item &setup_table_names()
             my $error = 0;  
             my $courseData =   input: course id
                 &DownloadCourseInformation($_, $courseID, $downloadTime,  
                                            $WhatIWant);  output: none
             my %downloadData;  
             unless(tie(%downloadData,'GDBM_File',$residualFile,  Cleans up the package variables for local caching.
                        &GDBM_WRCREAT(),0640)) {  
                 return 'Failed to tie temporary download hash.';  
             }  
             foreach my $key (keys(%$courseData)) {  
                 $downloadData{$key} = $courseData->{$key};  
                 if($key =~ /^(con_lost|error|no_such_host)/i) {  
                     $error = 1;  
                     last;  
                 }  
             }  
             if($error) {  
                 foreach my $deleteKey (keys(%$courseData)) {  
                     delete $downloadData{$deleteKey};  
                 }  
                 $downloadData{$_.':error'} = 'No course data for '.$_;  
             }  
             untie(%downloadData);  
         }  
     }  
     if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }  
   
     return &CheckForResidualDownload($cacheDB, 'true', 'true',   =cut
                                      $courseID, $r, $c);  
   ################################################
   ################################################
   sub setup_table_names {
       my ($courseid) = @_;
       if (! defined($courseid)) {
           $courseid = $ENV{'request.course.id'};
       }
       #
       if (! defined($current_course) || $current_course ne $courseid) {
           # Clear out variables
           $have_read_part_table = 0;
           undef(%ids_by_part);
           undef(%parts_by_id);
           $have_read_symb_table = 0;
           undef(%ids_by_symb);
           undef(%symbs_by_id);
           $have_read_student_table = 0;
           undef(%ids_by_student);
           undef(%students_by_id);
           #
           $current_course = $courseid;
       }
       #
       # Set up database names
       my $base_id = $courseid;
       $symb_table        = $base_id.'_'.'symb';
       $part_table        = $base_id.'_'.'part';
       $student_table     = $base_id.'_'.'student';
       $studentdata_table = $base_id.'_'.'studentdata';
       $performance_table = $base_id.'_'.'performance';
       $parameters_table  = $base_id.'_'.'parameters';
       $fulldump_part_table      = $base_id.'_'.'partdata';
       $fulldump_response_table  = $base_id.'_'.'responsedata';
       $fulldump_timestamp_table = $base_id.'_'.'timestampdata';
       #
       @Tables = (
                  $symb_table,
                  $part_table,
                  $student_table,
                  $studentdata_table,
                  $performance_table,
                  $parameters_table,
                  $fulldump_part_table,
                  $fulldump_response_table,
                  $fulldump_timestamp_table,
                  );
       return;
 }  }
   
 sub CheckForResidualDownload {  ################################################
     my ($cacheDB,$extract,$status,$courseID,$r,$c)=@_;  ################################################
   
     my $residualFile = '/home/httpd/perl/tmp/'.$courseID.'DownloadFile.db';  =pod
     if(!-e $residualFile) {  
         return 'OK';  
     }  
   
     my %downloadData;  =back
     my %cache;  
     unless(tie(%downloadData,'GDBM_File',$residualFile,&GDBM_READER(),0640)) {  
         return 'Can not tie database for check for residual download: tempDB';  
     }  
     unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) {  
         untie(%downloadData);  
         return 'Can not tie database for check for residual download: cacheDB';  
     }  
   
     my @students=();  =item End of Local Data Caching Subroutines
     my %checkStudent;  
     my $key;  
     while(($key, undef) = each %downloadData) {  
         my @temp = split(':', $key);  
         my $student = $temp[0].':'.$temp[1];  
         if(!defined($checkStudent{$student})) {  
             $checkStudent{$student}++;  
             push(@students, $student);  
         }  
     }  
   
     my $heading = 'Process Course Data';  =cut
     my $title = 'LON-CAPA Statistics';  
     my $studentCount = scalar(@students);  
     if($status eq 'true') {  
         &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);  
     }  
   
     my $count=1;  ################################################
     foreach my $name (@students) {  ################################################
         last if($c->aborted());  
   
         if($status eq 'true') {  } # End scope of table identifiers
             my $displayString = $count.'/'.$studentCount.': '.$name;  
             &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);  
         }  
   
         if($extract eq 'true') {  ################################################
             &ExtractStudentData(\%downloadData, \%cache, \%cache, $name);  ################################################
         } else {  
             &ProcessStudentData(\%cache, \%downloadData, $name);  
         }  
         $count++;  
     }  
   
     if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }  =pod
   
     untie(%cache);  =head3 Classlist Subroutines
     untie(%downloadData);  
   
     if(!$c->aborted()) {  =item &get_classlist();
         my @files = ($residualFile);  
         unlink(@files);  Retrieve the classist of a given class or of the current class.  Student
     }  information is returned from the classlist.db file and, if needed,
   from the students environment.
   
   Optional arguments are $cid, $cdom, and $cnum (course id, course domain,
   and course number, respectively).  Any omitted arguments will be taken 
   from the current environment ($ENV{'request.course.id'},
   $ENV{'course.'.$cid.'.domain'}, and $ENV{'course.'.$cid.'.num'}).
   
   Returns a reference to a hash which contains:
    keys    '$sname:$sdom'
    values  [$sdom,$sname,$end,$start,$id,$section,$fullname,$status]
   
   The constant values CL_SDOM, CL_SNAME, CL_END, etc. can be used
   as indices into the returned list to future-proof clients against
   changes in the list order.
   
     return 'OK';  =cut
   
   ################################################
   ################################################
   
   sub CL_SDOM     { return 0; }
   sub CL_SNAME    { return 1; }
   sub CL_END      { return 2; }
   sub CL_START    { return 3; }
   sub CL_ID       { return 4; }
   sub CL_SECTION  { return 5; }
   sub CL_FULLNAME { return 6; }
   sub CL_STATUS   { return 7; }
   
   sub get_classlist {
       my ($cid,$cdom,$cnum) = @_;
       $cid = $cid || $ENV{'request.course.id'};
       $cdom = $cdom || $ENV{'course.'.$cid.'.domain'};
       $cnum = $cnum || $ENV{'course.'.$cid.'.num'};
       my $now = time;
       #
       my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
       while (my ($student,$info) = each(%classlist)) {
           if ($student =~ /^(con_lost|error|no_such_host)/i) {
               &Apache::lonnet::logthis('get_classlist error for '.$cid.':'.$student);
               return undef;
           }
           my ($sname,$sdom) = split(/:/,$student);
           my @Values = split(/:/,$info);
           my ($end,$start,$id,$section,$fullname);
           if (@Values > 2) {
               ($end,$start,$id,$section,$fullname) = @Values;
           } else { # We have to get the data ourselves
               ($end,$start) = @Values;
               $section = &Apache::lonnet::getsection($sdom,$sname,$cid);
               my %info=&Apache::lonnet::get('environment',
                                             ['firstname','middlename',
                                              'lastname','generation','id'],
                                             $sdom, $sname);
               my ($tmp) = keys(%info);
               if ($tmp =~/^(con_lost|error|no_such_host)/i) {
                   $fullname = 'not available';
                   $id = 'not available';
                   &Apache::lonnet::logthis('unable to retrieve environment '.
                                            'for '.$sname.':'.$sdom);
               } else {
                   $fullname = &ProcessFullName(@info{qw/lastname generation 
                                                          firstname middlename/});
                   $id = $info{'id'};
               }
               # Update the classlist with this students information
               if ($fullname ne 'not available') {
                   my $enrolldata = join(':',$end,$start,$id,$section,$fullname);
                   my $reply=&Apache::lonnet::cput('classlist',
                                                   {$student => $enrolldata},
                                                   $cdom,$cnum);
                   if ($reply !~ /^(ok|delayed)/) {
                       &Apache::lonnet::logthis('Unable to update classlist for '.
                                                'student '.$sname.':'.$sdom.
                                                ' error:'.$reply);
                   }
               }
           }
           my $status='Expired';
           if(((!$end) || $now < $end) && ((!$start) || ($now > $start))) {
               $status='Active';
           }
           $classlist{$student} = 
               [$sdom,$sname,$end,$start,$id,$section,$fullname,$status];
       }
       if (wantarray()) {
           return (\%classlist,['domain','username','end','start','id',
                                'section','fullname','status']);
       } else {
           return \%classlist;
       }
 }  }
   
 # ----- END HELPER FUNCTIONS --------------------------------------------  # ----- END HELPER FUNCTIONS --------------------------------------------
   
 1;  1;
 __END__  __END__
   
   

Removed from v.1.22  
changed lines
  Added in v.1.90


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