Annotation of loncom/interface/loncoursedata.pm, revision 1.104

1.1       stredwic    1: # The LearningOnline Network with CAPA
                      2: #
1.104   ! matthew     3: # $Id: loncoursedata.pm,v 1.103 2003/10/09 14:50:01 matthew Exp $
1.1       stredwic    4: #
                      5: # Copyright Michigan State University Board of Trustees
                      6: #
                      7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      8: #
                      9: # LON-CAPA is free software; you can redistribute it and/or modify
                     10: # it under the terms of the GNU General Public License as published by
                     11: # the Free Software Foundation; either version 2 of the License, or
                     12: # (at your option) any later version.
                     13: #
                     14: # LON-CAPA is distributed in the hope that it will be useful,
                     15: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     16: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     17: # GNU General Public License for more details.
                     18: #
                     19: # You should have received a copy of the GNU General Public License
                     20: # along with LON-CAPA; if not, write to the Free Software
                     21: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     22: #
                     23: # /home/httpd/html/adm/gpl.txt
                     24: #
                     25: # http://www.lon-capa.org/
                     26: #
                     27: ###
                     28: 
                     29: =pod
                     30: 
                     31: =head1 NAME
                     32: 
                     33: loncoursedata
                     34: 
                     35: =head1 SYNOPSIS
                     36: 
1.22      stredwic   37: Set of functions that download and process student and course information.
1.1       stredwic   38: 
                     39: =head1 PACKAGES USED
                     40: 
                     41:  Apache::Constants qw(:common :http)
                     42:  Apache::lonnet()
1.22      stredwic   43:  Apache::lonhtmlcommon
1.1       stredwic   44:  HTML::TokeParser
                     45:  GDBM_File
                     46: 
                     47: =cut
                     48: 
                     49: package Apache::loncoursedata;
                     50: 
                     51: use strict;
                     52: use Apache::Constants qw(:common :http);
                     53: use Apache::lonnet();
1.13      stredwic   54: use Apache::lonhtmlcommon;
1.57      matthew    55: use Time::HiRes;
                     56: use Apache::lonmysql;
1.1       stredwic   57: use HTML::TokeParser;
                     58: use GDBM_File;
                     59: 
                     60: =pod
                     61: 
                     62: =head1 DOWNLOAD INFORMATION
                     63: 
1.22      stredwic   64: This section contains all the functions that get data from other servers 
                     65: and/or itself.
1.1       stredwic   66: 
                     67: =cut
                     68: 
1.50      matthew    69: ####################################################
                     70: ####################################################
1.45      matthew    71: 
                     72: =pod
                     73: 
                     74: =item &get_sequence_assessment_data()
                     75: 
                     76: AT THIS TIME THE USE OF THIS FUNCTION IS *NOT* RECOMMENDED
                     77: 
                     78: Use lonnavmaps to build a data structure describing the order and 
                     79: assessment contents of each sequence in the current course.
                     80: 
                     81: The returned structure is a hash reference. 
                     82: 
1.61      matthew    83: { title => 'title',
                     84:   symb  => 'symb',
                     85:   src   => '/s/o/u/r/c/e',
1.45      matthew    86:   type  => (container|assessment),
1.50      matthew    87:   num_assess   => 2,               # only for container
1.45      matthew    88:   parts        => [11,13,15],      # only for assessment
1.50      matthew    89:   response_ids => [12,14,16],      # only for assessment
                     90:   contents     => [........]       # only for container
1.45      matthew    91: }
                     92: 
1.50      matthew    93: $hash->{'contents'} is a reference to an array of hashes of the same structure.
                     94: 
                     95: Also returned are array references to the sequences and assessments contained
                     96: in the course.
1.49      matthew    97: 
1.45      matthew    98: 
                     99: =cut
                    100: 
1.50      matthew   101: ####################################################
                    102: ####################################################
1.45      matthew   103: sub get_sequence_assessment_data {
                    104:     my $fn=$ENV{'request.course.fn'};
                    105:     ##
                    106:     ## use navmaps
1.83      bowersj2  107:     my $navmap = Apache::lonnavmaps::navmap->new();
1.45      matthew   108:     if (!defined($navmap)) {
                    109:         return 'Can not open Coursemap';
                    110:     }
1.75      matthew   111:     # We explicity grab the top level map because I am not sure we
                    112:     # are pulling it from the iterator.
                    113:     my $top_level_map = $navmap->getById('0.0');
                    114:     #
1.45      matthew   115:     my $iterator = $navmap->getIterator(undef, undef, undef, 1);
1.61      matthew   116:     my $curRes = $iterator->next(); # Top level sequence
1.45      matthew   117:     ##
                    118:     ## Prime the pump 
                    119:     ## 
                    120:     ## We are going to loop until we run out of sequences/pages to explore for
                    121:     ## resources.  This means we have to start out with something to look
                    122:     ## at.
1.76      matthew   123:     my $title = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1.75      matthew   124:     my $symb  = $top_level_map->symb();
                    125:     my $src   = $top_level_map->src();
                    126:     my $randompick = $top_level_map->randompick();
1.45      matthew   127:     #
1.49      matthew   128:     my @Sequences; 
                    129:     my @Assessments;
1.45      matthew   130:     my @Nested_Sequences = ();   # Stack of sequences, keeps track of depth
                    131:     my $top = { title    => $title,
1.52      matthew   132:                 src      => $src,
1.45      matthew   133:                 symb     => $symb,
                    134:                 type     => 'container',
                    135:                 num_assess => 0,
1.53      matthew   136:                 num_assess_parts => 0,
1.75      matthew   137:                 contents   => [], 
                    138:                 randompick => $randompick,
                    139:             };
1.49      matthew   140:     push (@Sequences,$top);
1.45      matthew   141:     push (@Nested_Sequences, $top);
                    142:     #
                    143:     # We need to keep track of which sequences contain homework problems
                    144:     # 
1.78      matthew   145:     my $previous_too;
1.52      matthew   146:     my $previous;
1.45      matthew   147:     while (scalar(@Nested_Sequences)) {
1.78      matthew   148:         $previous_too = $previous;
1.50      matthew   149:         $previous = $curRes;
1.45      matthew   150:         $curRes = $iterator->next();
                    151:         my $currentmap = $Nested_Sequences[-1]; # Last one on the stack
                    152:         if ($curRes == $iterator->BEGIN_MAP()) {
1.78      matthew   153:             if (! ref($previous)) {
                    154:                 $previous = $previous_too;
                    155:             }
                    156:             if (! ref($previous)) {
                    157:                 next;
                    158:             }
1.45      matthew   159:             # get the map itself, instead of BEGIN_MAP
1.51      matthew   160:             $title = $previous->title();
1.84      matthew   161:             $title =~ s/\:/\&\#058;/g;
1.51      matthew   162:             $symb  = $previous->symb();
                    163:             $src   = $previous->src();
1.81      matthew   164:             # pick up the filename if there is no title available
                    165:             if (! defined($title) || $title eq '') {
                    166:                 ($title) = ($src=~/\/([^\/]*)$/);
                    167:             }
1.75      matthew   168:             $randompick = $previous->randompick();
1.45      matthew   169:             my $newmap = { title    => $title,
                    170:                            src      => $src,
                    171:                            symb     => $symb,
                    172:                            type     => 'container',
                    173:                            num_assess => 0,
1.75      matthew   174:                            randompick => $randompick,
1.45      matthew   175:                            contents   => [],
                    176:                        };
                    177:             push (@{$currentmap->{'contents'}},$newmap); # this is permanent
1.49      matthew   178:             push (@Sequences,$newmap);
1.45      matthew   179:             push (@Nested_Sequences, $newmap); # this is a stack
                    180:             next;
                    181:         }
                    182:         if ($curRes == $iterator->END_MAP()) {
                    183:             pop(@Nested_Sequences);
                    184:             next;
                    185:         }
                    186:         next if (! ref($curRes));
1.50      matthew   187:         next if (! $curRes->is_problem());# && !$curRes->randomout);
1.45      matthew   188:         # Okay, from here on out we only deal with assessments
                    189:         $title = $curRes->title();
1.84      matthew   190:         $title =~ s/\:/\&\#058;/g;
1.45      matthew   191:         $symb  = $curRes->symb();
                    192:         $src   = $curRes->src();
                    193:         my $parts = $curRes->parts();
1.87      matthew   194:         my %partdata;
                    195:         foreach my $part (@$parts) {
1.88      matthew   196:             my @Responses = $curRes->responseType($part);
                    197:             my @Ids       = $curRes->responseIds($part);
                    198:             $partdata{$part}->{'ResponseTypes'}= \@Responses;
                    199:             $partdata{$part}->{'ResponseIds'}  = \@Ids;
1.91      matthew   200:             # Count how many responses of each type there are in this part
                    201:             foreach (@Responses) {
                    202:                 $partdata{$part}->{$_}++;
                    203:             }
1.87      matthew   204:         }
1.45      matthew   205:         my $assessment = { title => $title,
                    206:                            src   => $src,
                    207:                            symb  => $symb,
                    208:                            type  => 'assessment',
1.53      matthew   209:                            parts => $parts,
                    210:                            num_parts => scalar(@$parts),
1.87      matthew   211:                            partdata => \%partdata,
1.45      matthew   212:                        };
1.49      matthew   213:         push(@Assessments,$assessment);
1.45      matthew   214:         push(@{$currentmap->{'contents'}},$assessment);
                    215:         $currentmap->{'num_assess'}++;
1.53      matthew   216:         $currentmap->{'num_assess_parts'}+= scalar(@$parts);
1.45      matthew   217:     }
1.58      matthew   218:     $navmap->untieHashes();
1.49      matthew   219:     return ($top,\@Sequences,\@Assessments);
1.45      matthew   220: }
1.50      matthew   221: 
1.4       stredwic  222: sub LoadDiscussion {
1.13      stredwic  223:     my ($courseID)=@_;
1.5       minaeibi  224:     my %Discuss=();
                    225:     my %contrib=&Apache::lonnet::dump(
                    226:                 $courseID,
                    227:                 $ENV{'course.'.$courseID.'.domain'},
                    228:                 $ENV{'course.'.$courseID.'.num'});
                    229: 				 
                    230:     #my %contrib=&DownloadCourseInformation($name, $courseID, 0);
                    231: 
1.4       stredwic  232:     foreach my $temp(keys %contrib) {
                    233: 	if ($temp=~/^version/) {
                    234: 	    my $ver=$contrib{$temp};
                    235: 	    my ($dummy,$prb)=split(':',$temp);
                    236: 	    for (my $idx=1; $idx<=$ver; $idx++ ) {
                    237: 		my $name=$contrib{"$idx:$prb:sendername"};
1.5       minaeibi  238: 		$Discuss{"$name:$prb"}=$idx;	
1.4       stredwic  239: 	    }
                    240: 	}
                    241:     }       
1.5       minaeibi  242: 
                    243:     return \%Discuss;
1.1       stredwic  244: }
                    245: 
1.71      matthew   246: ################################################
                    247: ################################################
                    248: 
                    249: =pod
                    250: 
                    251: =item &GetUserName(username,userdomain)
                    252: 
                    253: Returns a hash with the following entries:
                    254:    'firstname', 'middlename', 'lastname', 'generation', and 'fullname'
                    255: 
                    256:    'fullname' is the result of &Apache::loncoursedata::ProcessFullName.
                    257: 
                    258: =cut
                    259: 
                    260: ################################################
                    261: ################################################
                    262: sub GetUserName {
                    263:     my ($username,$userdomain) = @_;
                    264:     $username = $ENV{'user.name'} if (! defined($username));
                    265:     $userdomain = $ENV{'user.domain'} if (! defined($username));
                    266:     my %userenv = &Apache::lonnet::get('environment',
                    267:                            ['firstname','middlename','lastname','generation'],
                    268:                                        $userdomain,$username);
                    269:     $userenv{'fullname'} = &ProcessFullName($userenv{'lastname'},
                    270:                                             $userenv{'generation'},
                    271:                                             $userenv{'firstname'},
                    272:                                             $userenv{'middlename'});
                    273:     return %userenv;
                    274: }
                    275: 
                    276: ################################################
                    277: ################################################
                    278: 
1.1       stredwic  279: =pod
                    280: 
                    281: =item &ProcessFullName()
                    282: 
                    283: Takes lastname, generation, firstname, and middlename (or some partial
                    284: set of this data) and returns the full name version as a string.  Format
                    285: is Lastname generation, firstname middlename or a subset of this.
                    286: 
                    287: =cut
                    288: 
1.71      matthew   289: ################################################
                    290: ################################################
1.1       stredwic  291: sub ProcessFullName {
                    292:     my ($lastname, $generation, $firstname, $middlename)=@_;
                    293:     my $Str = '';
                    294: 
1.34      matthew   295:     # Strip whitespace preceeding & following name components.
                    296:     $lastname   =~ s/(\s+$|^\s+)//g;
                    297:     $generation =~ s/(\s+$|^\s+)//g;
                    298:     $firstname  =~ s/(\s+$|^\s+)//g;
                    299:     $middlename =~ s/(\s+$|^\s+)//g;
                    300: 
1.1       stredwic  301:     if($lastname ne '') {
1.34      matthew   302: 	$Str .= $lastname;
                    303: 	$Str .= ' '.$generation if ($generation ne '');
                    304: 	$Str .= ',';
                    305:         $Str .= ' '.$firstname  if ($firstname ne '');
                    306:         $Str .= ' '.$middlename if ($middlename ne '');
1.1       stredwic  307:     } else {
1.34      matthew   308:         $Str .= $firstname      if ($firstname ne '');
                    309:         $Str .= ' '.$middlename if ($middlename ne '');
                    310:         $Str .= ' '.$generation if ($generation ne '');
1.1       stredwic  311:     }
                    312: 
                    313:     return $Str;
                    314: }
                    315: 
1.46      matthew   316: ################################################
                    317: ################################################
                    318: 
                    319: =pod
                    320: 
1.47      matthew   321: =item &make_into_hash($values);
                    322: 
                    323: Returns a reference to a hash as described by $values.  $values is
                    324: assumed to be the result of 
1.57      matthew   325:     join(':',map {&Apache::lonnet::escape($_)} %orighash);
1.47      matthew   326: 
                    327: This is a helper function for get_current_state.
                    328: 
                    329: =cut
                    330: 
                    331: ################################################
                    332: ################################################
                    333: sub make_into_hash {
                    334:     my $values = shift;
                    335:     my %tmp = map { &Apache::lonnet::unescape($_); }
                    336:                                            split(':',$values);
                    337:     return \%tmp;
                    338: }
                    339: 
                    340: 
                    341: ################################################
                    342: ################################################
                    343: 
                    344: =pod
                    345: 
1.57      matthew   346: =head1 LOCAL DATA CACHING SUBROUTINES
                    347: 
                    348: The local caching is done using MySQL.  There is no fall-back implementation
                    349: if MySQL is not running.
                    350: 
                    351: The programmers interface is to call &get_current_state() or some other
                    352: primary interface subroutine (described below).  The internals of this 
                    353: storage system are documented here.
                    354: 
                    355: There are six tables used to store student performance data (the results of
                    356: a dumpcurrent).  Each of these tables is created in MySQL with a name of
                    357: $courseid_*****, where ***** is 'symb', 'part', or whatever is appropriate 
                    358: for the table.  The tables and their purposes are described below.
                    359: 
                    360: Some notes before we get started.
                    361: 
                    362: Each table must have a PRIMARY KEY, which is a column or set of columns which
                    363: will serve to uniquely identify a row of data.  NULL is not allowed!
                    364: 
                    365: INDEXes work best on integer data.
                    366: 
                    367: JOIN is used to combine data from many tables into one output.
                    368: 
                    369: lonmysql.pm is used for some of the interface, specifically the table creation
                    370: calls.  The inserts are done in bulk by directly calling the database handler.
                    371: The SELECT ... JOIN statement used to retrieve the data does not have an
                    372: interface in lonmysql.pm and I shudder at the thought of writing one.
                    373: 
                    374: =head3 Table Descriptions
                    375: 
                    376: =over 4
                    377: 
1.89      matthew   378: =item Tables used to store meta information
                    379: 
                    380: The following tables hold data required to keep track of the current status
                    381: of a students data in the tables or to look up the students data in the tables.
                    382: 
                    383: =over 4
                    384: 
1.57      matthew   385: =item $symb_table
                    386: 
                    387: The symb_table has two columns.  The first is a 'symb_id' and the second
                    388: is the text name for the 'symb' (limited to 64k).  The 'symb_id' is generated
                    389: automatically by MySQL so inserts should be done on this table with an
                    390: empty first element.  This table has its PRIMARY KEY on the 'symb_id'.
                    391: 
                    392: =item $part_table
                    393: 
                    394: The part_table has two columns.  The first is a 'part_id' and the second
                    395: is the text name for the 'part' (limited to 100 characters).  The 'part_id' is
                    396: generated automatically by MySQL so inserts should be done on this table with
                    397: an empty first element.  This table has its PRIMARY KEY on the 'part' (100
                    398: characters) and a KEY on 'part_id'.
                    399: 
                    400: =item $student_table
                    401: 
                    402: The student_table has two columns.  The first is a 'student_id' and the second
                    403: is the text description of the 'student' (typically username:domain) (less
                    404: than 100 characters).  The 'student_id' is automatically generated by MySQL.
                    405: The use of the name 'student_id' is loaded, I know, but this ID is used ONLY 
                    406: internally to the MySQL database and is not the same as the students ID 
                    407: (stored in the students environment).  This table has its PRIMARY KEY on the
                    408: 'student' (100 characters).
                    409: 
1.87      matthew   410: =item $studentdata_table
1.57      matthew   411: 
1.89      matthew   412: The studentdata_table has four columns:  'student_id' (the unique id of 
                    413: the student), 'updatetime' (the time the students data was last updated),
                    414: 'fullupdatetime' (the time the students full data was last updated),
                    415: 'section', and 'classification'( the students current classification).
                    416: This table has its PRIMARY KEY on 'student_id'.
                    417: 
                    418: =back 
                    419: 
                    420: =item Tables used to store current status data
                    421: 
                    422: The following tables store data only about the students current status on 
                    423: a problem, meaning only the data related to the last attempt on a problem.
                    424: 
                    425: =over 4
1.57      matthew   426: 
                    427: =item $performance_table
                    428: 
                    429: The performance_table has 9 columns.  The first three are 'symb_id', 
                    430: 'student_id', and 'part_id'.  These comprise the PRIMARY KEY for this table
                    431: and are directly related to the $symb_table, $student_table, and $part_table
                    432: described above.  MySQL does better indexing on numeric items than text,
                    433: so we use these three "index tables".  The remaining columns are
                    434: 'solved', 'tries', 'awarded', 'award', 'awarddetail', and 'timestamp'.
                    435: These are either the MySQL type TINYTEXT or various integers ('tries' and 
                    436: 'timestamp').  This table has KEYs of 'student_id' and 'symb_id'.
                    437: For use of this table, see the functions described below.
                    438: 
                    439: =item $parameters_table
                    440: 
                    441: The parameters_table holds the data that does not fit neatly into the
                    442: performance_table.  The parameters table has four columns: 'symb_id',
                    443: 'student_id', 'parameter', and 'value'.  'symb_id', 'student_id', and
                    444: 'parameter' comprise the PRIMARY KEY for this table.  'parameter' is 
                    445: limited to 255 characters.  'value' is limited to 64k characters.
                    446: 
                    447: =back
                    448: 
1.89      matthew   449: =item Tables used for storing historic data
                    450: 
                    451: The following tables are used to store almost all of the transactions a student
                    452: has made on a homework problem.  See loncapa/docs/homework/datastorage for 
                    453: specific information about each of the parameters stored.  
                    454: 
                    455: =over 4
                    456: 
                    457: =item $fulldump_response_table
                    458: 
                    459: The response table holds data (documented in loncapa/docs/homework/datastorage)
                    460: associated with a particular response id which is stored when a student 
                    461: attempts a problem.  The following are the columns of the table, in order:
                    462: 'symb_id','part_id','response_id','student_id','transaction','tries',
1.93      matthew   463: 'awarddetail', 'response_specific' (data particular to the response
1.89      matthew   464: type), 'response_specific_value', and 'submission (the text of the students
                    465: submission).  The primary key is based on the first five columns listed above.
                    466: 
                    467: =item $fulldump_part_table
                    468: 
                    469: The part table holds data (documented in loncapa/docs/homework/datastorage)
                    470: associated with a particular part id which is stored when a student attempts
                    471: a problem.  The following are the columns of the table, in order:
                    472: 'symb_id','part_id','student_id','transaction','tries','award','awarded',
                    473: and 'previous'.  The primary key is based on the first five columns listed 
                    474: above.
                    475: 
                    476: =item $fulldump_timestamp_table
                    477: 
                    478: The timestamp table holds the timestamps of the transactions which are
                    479: stored in $fulldump_response_table and $fulldump_part_table.  This data is
                    480: about both the response and part data.  Columns: 'symb_id','student_id',
                    481: 'transaction', and 'timestamp'.  
                    482: The primary key is based on the first 3 columns.
                    483: 
                    484: =back
                    485: 
                    486: =back
                    487: 
1.57      matthew   488: =head3 Important Subroutines
                    489: 
                    490: Here is a brief overview of the subroutines which are likely to be of 
                    491: interest:
                    492: 
                    493: =over 4
                    494: 
                    495: =item &get_current_state(): programmers interface.
                    496: 
                    497: =item &init_dbs(): table creation
                    498: 
                    499: =item &update_student_data(): data storage calls
                    500: 
                    501: =item &get_student_data_from_performance_cache(): data retrieval
                    502: 
                    503: =back
                    504: 
                    505: =head3 Main Documentation
                    506: 
                    507: =over 4
                    508: 
                    509: =cut
                    510: 
                    511: ################################################
                    512: ################################################
                    513: 
                    514: ################################################
                    515: ################################################
1.89      matthew   516: { # Begin scope of table identifiers
1.57      matthew   517: 
                    518: my $current_course ='';
                    519: my $symb_table;
                    520: my $part_table;
                    521: my $student_table;
1.87      matthew   522: my $studentdata_table;
1.57      matthew   523: my $performance_table;
                    524: my $parameters_table;
1.89      matthew   525: my $fulldump_response_table;
                    526: my $fulldump_part_table;
                    527: my $fulldump_timestamp_table;
1.57      matthew   528: 
1.89      matthew   529: my @Tables;
1.57      matthew   530: ################################################
                    531: ################################################
                    532: 
                    533: =pod
                    534: 
                    535: =item &init_dbs()
                    536: 
                    537: Input: course id
                    538: 
                    539: Output: 0 on success, positive integer on error
                    540: 
                    541: This routine issues the calls to lonmysql to create the tables used to
                    542: store student data.
                    543: 
                    544: =cut
                    545: 
                    546: ################################################
                    547: ################################################
                    548: sub init_dbs {
                    549:     my $courseid = shift;
                    550:     &setup_table_names($courseid);
                    551:     #
1.73      matthew   552:     # Drop any of the existing tables
1.89      matthew   553:     foreach my $table (@Tables) {
1.73      matthew   554:         &Apache::lonmysql::drop_table($table);
                    555:     }
                    556:     #
1.57      matthew   557:     # Note - changes to this table must be reflected in the code that 
                    558:     # stores the data (calls &Apache::lonmysql::store_row with this table
                    559:     # id
                    560:     my $symb_table_def = {
                    561:         id => $symb_table,
                    562:         permanent => 'no',
                    563:         columns => [{ name => 'symb_id',
                    564:                       type => 'MEDIUMINT UNSIGNED',
                    565:                       restrictions => 'NOT NULL',
                    566:                       auto_inc     => 'yes', },
                    567:                     { name => 'symb',
                    568:                       type => 'MEDIUMTEXT',
                    569:                       restrictions => 'NOT NULL'},
                    570:                     ],
                    571:         'PRIMARY KEY' => ['symb_id'],
                    572:     };
                    573:     #
                    574:     my $part_table_def = {
                    575:         id => $part_table,
                    576:         permanent => 'no',
                    577:         columns => [{ name => 'part_id',
                    578:                       type => 'MEDIUMINT UNSIGNED',
                    579:                       restrictions => 'NOT NULL',
                    580:                       auto_inc     => 'yes', },
                    581:                     { name => 'part',
                    582:                       type => 'VARCHAR(100)',
                    583:                       restrictions => 'NOT NULL'},
                    584:                     ],
                    585:         'PRIMARY KEY' => ['part (100)'],
                    586:         'KEY' => [{ columns => ['part_id']},],
                    587:     };
                    588:     #
                    589:     my $student_table_def = {
                    590:         id => $student_table,
                    591:         permanent => 'no',
                    592:         columns => [{ name => 'student_id',
                    593:                       type => 'MEDIUMINT UNSIGNED',
                    594:                       restrictions => 'NOT NULL',
                    595:                       auto_inc     => 'yes', },
                    596:                     { name => 'student',
                    597:                       type => 'VARCHAR(100)',
                    598:                       restrictions => 'NOT NULL'},
1.85      matthew   599:                     { name => 'classification',
                    600:                       type => 'varchar(100)', },
1.57      matthew   601:                     ],
                    602:         'PRIMARY KEY' => ['student (100)'],
                    603:         'KEY' => [{ columns => ['student_id']},],
                    604:     };
                    605:     #
1.87      matthew   606:     my $studentdata_table_def = {
                    607:         id => $studentdata_table,
1.57      matthew   608:         permanent => 'no',
1.87      matthew   609:         columns => [{ name => 'student_id',
                    610:                       type => 'MEDIUMINT UNSIGNED',
1.57      matthew   611:                       restrictions => 'NOT NULL UNIQUE',},
                    612:                     { name => 'updatetime',
1.89      matthew   613:                       type => 'INT UNSIGNED'},
                    614:                     { name => 'fullupdatetime',
                    615:                       type => 'INT UNSIGNED'},
1.87      matthew   616:                     { name => 'section',
                    617:                       type => 'VARCHAR(100)'},
                    618:                     { name => 'classification',
                    619:                       type => 'VARCHAR(100)', },
1.57      matthew   620:                     ],
1.87      matthew   621:         'PRIMARY KEY' => ['student_id'],
1.57      matthew   622:     };
                    623:     #
                    624:     my $performance_table_def = {
                    625:         id => $performance_table,
                    626:         permanent => 'no',
                    627:         columns => [{ name => 'symb_id',
                    628:                       type => 'MEDIUMINT UNSIGNED',
                    629:                       restrictions => 'NOT NULL'  },
                    630:                     { name => 'student_id',
                    631:                       type => 'MEDIUMINT UNSIGNED',
                    632:                       restrictions => 'NOT NULL'  },
                    633:                     { name => 'part_id',
                    634:                       type => 'MEDIUMINT UNSIGNED',
                    635:                       restrictions => 'NOT NULL' },
1.73      matthew   636:                     { name => 'part',
                    637:                       type => 'VARCHAR(100)',
                    638:                       restrictions => 'NOT NULL'},                    
1.57      matthew   639:                     { name => 'solved',
                    640:                       type => 'TINYTEXT' },
                    641:                     { name => 'tries',
                    642:                       type => 'SMALLINT UNSIGNED' },
                    643:                     { name => 'awarded',
                    644:                       type => 'TINYTEXT' },
                    645:                     { name => 'award',
                    646:                       type => 'TINYTEXT' },
                    647:                     { name => 'awarddetail',
                    648:                       type => 'TINYTEXT' },
                    649:                     { name => 'timestamp',
                    650:                       type => 'INT UNSIGNED'},
                    651:                     ],
                    652:         'PRIMARY KEY' => ['symb_id','student_id','part_id'],
                    653:         'KEY' => [{ columns=>['student_id'] },
                    654:                   { columns=>['symb_id'] },],
                    655:     };
                    656:     #
1.89      matthew   657:     my $fulldump_part_table_def = {
                    658:         id => $fulldump_part_table,
                    659:         permanent => 'no',
                    660:         columns => [
                    661:                     { name => 'symb_id',
                    662:                       type => 'MEDIUMINT UNSIGNED',
                    663:                       restrictions => 'NOT NULL'  },
                    664:                     { name => 'part_id',
                    665:                       type => 'MEDIUMINT UNSIGNED',
                    666:                       restrictions => 'NOT NULL' },
                    667:                     { name => 'student_id',
                    668:                       type => 'MEDIUMINT UNSIGNED',
                    669:                       restrictions => 'NOT NULL'  },
                    670:                     { name => 'transaction',
                    671:                       type => 'MEDIUMINT UNSIGNED',
                    672:                       restrictions => 'NOT NULL' },
                    673:                     { name => 'tries',
                    674:                       type => 'SMALLINT UNSIGNED',
                    675:                       restrictions => 'NOT NULL' },
                    676:                     { name => 'award',
                    677:                       type => 'TINYTEXT' },
                    678:                     { name => 'awarded',
                    679:                       type => 'TINYTEXT' },
                    680:                     { name => 'previous',
                    681:                       type => 'SMALLINT UNSIGNED' },
                    682: #                    { name => 'regrader',
                    683: #                      type => 'TINYTEXT' },
                    684: #                    { name => 'afterduedate',
                    685: #                      type => 'TINYTEXT' },
                    686:                     ],
                    687:         'PRIMARY KEY' => ['symb_id','part_id','student_id','transaction'],
                    688:         'KEY' => [
                    689:                   { columns=>['symb_id'] },
                    690:                   { columns=>['part_id'] },
                    691:                   { columns=>['student_id'] },
                    692:                   ],
                    693:     };
                    694:     #
                    695:     my $fulldump_response_table_def = {
                    696:         id => $fulldump_response_table,
                    697:         permanent => 'no',
                    698:         columns => [
                    699:                     { name => 'symb_id',
                    700:                       type => 'MEDIUMINT UNSIGNED',
                    701:                       restrictions => 'NOT NULL'  },
                    702:                     { name => 'part_id',
                    703:                       type => 'MEDIUMINT UNSIGNED',
                    704:                       restrictions => 'NOT NULL' },
                    705:                     { name => 'response_id',
                    706:                       type => 'MEDIUMINT UNSIGNED',
                    707:                       restrictions => 'NOT NULL'  },
                    708:                     { name => 'student_id',
                    709:                       type => 'MEDIUMINT UNSIGNED',
                    710:                       restrictions => 'NOT NULL'  },
                    711:                     { name => 'transaction',
                    712:                       type => 'MEDIUMINT UNSIGNED',
                    713:                       restrictions => 'NOT NULL' },
                    714:                     { name => 'awarddetail',
                    715:                       type => 'TINYTEXT' },
                    716: #                    { name => 'message',
                    717: #                      type => 'CHAR' },
                    718:                     { name => 'response_specific',
                    719:                       type => 'TINYTEXT' },
                    720:                     { name => 'response_specific_value',
                    721:                       type => 'TINYTEXT' },
                    722:                     { name => 'submission',
                    723:                       type => 'TEXT'},
                    724:                     ],
                    725:             'PRIMARY KEY' => ['symb_id','part_id','response_id','student_id',
                    726:                               'transaction'],
                    727:             'KEY' => [
                    728:                       { columns=>['symb_id'] },
                    729:                       { columns=>['part_id','response_id'] },
                    730:                       { columns=>['student_id'] },
                    731:                       ],
                    732:     };
                    733:     my $fulldump_timestamp_table_def = {
                    734:         id => $fulldump_timestamp_table,
                    735:         permanent => 'no',
                    736:         columns => [
                    737:                     { name => 'symb_id',
                    738:                       type => 'MEDIUMINT UNSIGNED',
                    739:                       restrictions => 'NOT NULL'  },
                    740:                     { name => 'student_id',
                    741:                       type => 'MEDIUMINT UNSIGNED',
                    742:                       restrictions => 'NOT NULL'  },
                    743:                     { name => 'transaction',
                    744:                       type => 'MEDIUMINT UNSIGNED',
                    745:                       restrictions => 'NOT NULL' },
                    746:                     { name => 'timestamp',
                    747:                       type => 'INT UNSIGNED'},
                    748:                     ],
                    749:         'PRIMARY KEY' => ['symb_id','student_id','transaction'],
                    750:         'KEY' => [
                    751:                   { columns=>['symb_id'] },
                    752:                   { columns=>['student_id'] },
                    753:                   { columns=>['transaction'] },
                    754:                   ],
                    755:     };
                    756: 
                    757:     #
1.57      matthew   758:     my $parameters_table_def = {
                    759:         id => $parameters_table,
                    760:         permanent => 'no',
                    761:         columns => [{ name => 'symb_id',
                    762:                       type => 'MEDIUMINT UNSIGNED',
                    763:                       restrictions => 'NOT NULL'  },
                    764:                     { name => 'student_id',
                    765:                       type => 'MEDIUMINT UNSIGNED',
                    766:                       restrictions => 'NOT NULL'  },
                    767:                     { name => 'parameter',
                    768:                       type => 'TINYTEXT',
                    769:                       restrictions => 'NOT NULL'  },
                    770:                     { name => 'value',
                    771:                       type => 'MEDIUMTEXT' },
                    772:                     ],
                    773:         'PRIMARY KEY' => ['symb_id','student_id','parameter (255)'],
                    774:     };
                    775:     #
                    776:     # Create the tables
                    777:     my $tableid;
                    778:     $tableid = &Apache::lonmysql::create_table($symb_table_def);
                    779:     if (! defined($tableid)) {
                    780:         &Apache::lonnet::logthis("error creating symb_table: ".
                    781:                                  &Apache::lonmysql::get_error());
                    782:         return 1;
                    783:     }
                    784:     #
                    785:     $tableid = &Apache::lonmysql::create_table($part_table_def);
                    786:     if (! defined($tableid)) {
                    787:         &Apache::lonnet::logthis("error creating part_table: ".
                    788:                                  &Apache::lonmysql::get_error());
                    789:         return 2;
                    790:     }
                    791:     #
                    792:     $tableid = &Apache::lonmysql::create_table($student_table_def);
                    793:     if (! defined($tableid)) {
                    794:         &Apache::lonnet::logthis("error creating student_table: ".
                    795:                                  &Apache::lonmysql::get_error());
                    796:         return 3;
                    797:     }
                    798:     #
1.87      matthew   799:     $tableid = &Apache::lonmysql::create_table($studentdata_table_def);
1.57      matthew   800:     if (! defined($tableid)) {
1.87      matthew   801:         &Apache::lonnet::logthis("error creating studentdata_table: ".
1.57      matthew   802:                                  &Apache::lonmysql::get_error());
                    803:         return 4;
                    804:     }
                    805:     #
                    806:     $tableid = &Apache::lonmysql::create_table($performance_table_def);
                    807:     if (! defined($tableid)) {
                    808:         &Apache::lonnet::logthis("error creating preformance_table: ".
                    809:                                  &Apache::lonmysql::get_error());
                    810:         return 5;
                    811:     }
                    812:     #
                    813:     $tableid = &Apache::lonmysql::create_table($parameters_table_def);
                    814:     if (! defined($tableid)) {
                    815:         &Apache::lonnet::logthis("error creating parameters_table: ".
                    816:                                  &Apache::lonmysql::get_error());
                    817:         return 6;
                    818:     }
1.89      matthew   819:     #
                    820:     $tableid = &Apache::lonmysql::create_table($fulldump_part_table_def);
                    821:     if (! defined($tableid)) {
                    822:         &Apache::lonnet::logthis("error creating fulldump_part_table: ".
                    823:                                  &Apache::lonmysql::get_error());
                    824:         return 7;
                    825:     }
                    826:     #
                    827:     $tableid = &Apache::lonmysql::create_table($fulldump_response_table_def);
                    828:     if (! defined($tableid)) {
                    829:         &Apache::lonnet::logthis("error creating fulldump_response_table: ".
                    830:                                  &Apache::lonmysql::get_error());
                    831:         return 8;
                    832:     }
                    833:     $tableid = &Apache::lonmysql::create_table($fulldump_timestamp_table_def);
                    834:     if (! defined($tableid)) {
                    835:         &Apache::lonnet::logthis("error creating fulldump_timestamp_table: ".
                    836:                                  &Apache::lonmysql::get_error());
                    837:         return 9;
                    838:     }
1.57      matthew   839:     return 0;
1.70      matthew   840: }
                    841: 
                    842: ################################################
                    843: ################################################
                    844: 
                    845: =pod
                    846: 
                    847: =item &delete_caches()
                    848: 
                    849: =cut
                    850: 
                    851: ################################################
                    852: ################################################
                    853: sub delete_caches {
                    854:     my $courseid = shift;
                    855:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                    856:     #
                    857:     &setup_table_names($courseid);
                    858:     #
                    859:     my $dbh = &Apache::lonmysql::get_dbh();
1.89      matthew   860:     foreach my $table (@Tables) {
1.70      matthew   861:         my $command = 'DROP TABLE '.$table.';';
                    862:         $dbh->do($command);
                    863:         if ($dbh->err) {
                    864:             &Apache::lonnet::logthis($command.' resulted in error: '.$dbh->errstr);
                    865:         }
                    866:     }
                    867:     return;
1.57      matthew   868: }
                    869: 
                    870: ################################################
                    871: ################################################
                    872: 
                    873: =pod
                    874: 
                    875: =item &get_part_id()
                    876: 
                    877: Get the MySQL id of a problem part string.
                    878: 
                    879: Input: $part
                    880: 
                    881: Output: undef on error, integer $part_id on success.
                    882: 
                    883: =item &get_part()
                    884: 
                    885: Get the string describing a part from the MySQL id of the problem part.
                    886: 
                    887: Input: $part_id
                    888: 
                    889: Output: undef on error, $part string on success.
                    890: 
                    891: =cut
                    892: 
                    893: ################################################
                    894: ################################################
                    895: 
1.61      matthew   896: my $have_read_part_table = 0;
1.57      matthew   897: my %ids_by_part;
                    898: my %parts_by_id;
                    899: 
                    900: sub get_part_id {
                    901:     my ($part) = @_;
1.61      matthew   902:     $part = 0 if (! defined($part));
                    903:     if (! $have_read_part_table) {
                    904:         my @Result = &Apache::lonmysql::get_rows($part_table);
                    905:         foreach (@Result) {
                    906:             $ids_by_part{$_->[1]}=$_->[0];
                    907:         }
                    908:         $have_read_part_table = 1;
                    909:     }
1.57      matthew   910:     if (! exists($ids_by_part{$part})) {
                    911:         &Apache::lonmysql::store_row($part_table,[undef,$part]);
                    912:         undef(%ids_by_part);
                    913:         my @Result = &Apache::lonmysql::get_rows($part_table);
                    914:         foreach (@Result) {
                    915:             $ids_by_part{$_->[1]}=$_->[0];
                    916:         }
                    917:     }
                    918:     return $ids_by_part{$part} if (exists($ids_by_part{$part}));
                    919:     return undef; # error
                    920: }
                    921: 
                    922: sub get_part {
                    923:     my ($part_id) = @_;
                    924:     if (! exists($parts_by_id{$part_id})  || 
                    925:         ! defined($parts_by_id{$part_id}) ||
                    926:         $parts_by_id{$part_id} eq '') {
                    927:         my @Result = &Apache::lonmysql::get_rows($part_table);
                    928:         foreach (@Result) {
                    929:             $parts_by_id{$_->[0]}=$_->[1];
                    930:         }
                    931:     }
                    932:     return $parts_by_id{$part_id} if(exists($parts_by_id{$part_id}));
                    933:     return undef; # error
                    934: }
                    935: 
                    936: ################################################
                    937: ################################################
                    938: 
                    939: =pod
                    940: 
                    941: =item &get_symb_id()
                    942: 
                    943: Get the MySQL id of a symb.
                    944: 
                    945: Input: $symb
                    946: 
                    947: Output: undef on error, integer $symb_id on success.
                    948: 
                    949: =item &get_symb()
                    950: 
                    951: Get the symb associated with a MySQL symb_id.
                    952: 
                    953: Input: $symb_id
                    954: 
                    955: Output: undef on error, $symb on success.
                    956: 
                    957: =cut
                    958: 
                    959: ################################################
                    960: ################################################
                    961: 
1.61      matthew   962: my $have_read_symb_table = 0;
1.57      matthew   963: my %ids_by_symb;
                    964: my %symbs_by_id;
                    965: 
                    966: sub get_symb_id {
                    967:     my ($symb) = @_;
1.61      matthew   968:     if (! $have_read_symb_table) {
                    969:         my @Result = &Apache::lonmysql::get_rows($symb_table);
                    970:         foreach (@Result) {
                    971:             $ids_by_symb{$_->[1]}=$_->[0];
                    972:         }
                    973:         $have_read_symb_table = 1;
                    974:     }
1.57      matthew   975:     if (! exists($ids_by_symb{$symb})) {
                    976:         &Apache::lonmysql::store_row($symb_table,[undef,$symb]);
                    977:         undef(%ids_by_symb);
                    978:         my @Result = &Apache::lonmysql::get_rows($symb_table);
                    979:         foreach (@Result) {
                    980:             $ids_by_symb{$_->[1]}=$_->[0];
                    981:         }
                    982:     }
                    983:     return $ids_by_symb{$symb} if(exists( $ids_by_symb{$symb}));
                    984:     return undef; # error
                    985: }
                    986: 
                    987: sub get_symb {
                    988:     my ($symb_id) = @_;
                    989:     if (! exists($symbs_by_id{$symb_id})  || 
                    990:         ! defined($symbs_by_id{$symb_id}) ||
                    991:         $symbs_by_id{$symb_id} eq '') {
                    992:         my @Result = &Apache::lonmysql::get_rows($symb_table);
                    993:         foreach (@Result) {
                    994:             $symbs_by_id{$_->[0]}=$_->[1];
                    995:         }
                    996:     }
                    997:     return $symbs_by_id{$symb_id} if(exists( $symbs_by_id{$symb_id}));
                    998:     return undef; # error
                    999: }
                   1000: 
                   1001: ################################################
                   1002: ################################################
                   1003: 
                   1004: =pod
                   1005: 
                   1006: =item &get_student_id()
                   1007: 
                   1008: Get the MySQL id of a student.
                   1009: 
                   1010: Input: $sname, $dom
                   1011: 
                   1012: Output: undef on error, integer $student_id on success.
                   1013: 
                   1014: =item &get_student()
                   1015: 
                   1016: Get student username:domain associated with the MySQL student_id.
                   1017: 
                   1018: Input: $student_id
                   1019: 
                   1020: Output: undef on error, string $student (username:domain) on success.
                   1021: 
                   1022: =cut
                   1023: 
                   1024: ################################################
                   1025: ################################################
                   1026: 
1.61      matthew  1027: my $have_read_student_table = 0;
1.57      matthew  1028: my %ids_by_student;
                   1029: my %students_by_id;
                   1030: 
                   1031: sub get_student_id {
                   1032:     my ($sname,$sdom) = @_;
                   1033:     my $student = $sname.':'.$sdom;
1.61      matthew  1034:     if (! $have_read_student_table) {
                   1035:         my @Result = &Apache::lonmysql::get_rows($student_table);
                   1036:         foreach (@Result) {
                   1037:             $ids_by_student{$_->[1]}=$_->[0];
                   1038:         }
                   1039:         $have_read_student_table = 1;
                   1040:     }
1.57      matthew  1041:     if (! exists($ids_by_student{$student})) {
1.85      matthew  1042:         &Apache::lonmysql::store_row($student_table,[undef,$student,undef]);
1.57      matthew  1043:         undef(%ids_by_student);
                   1044:         my @Result = &Apache::lonmysql::get_rows($student_table);
                   1045:         foreach (@Result) {
                   1046:             $ids_by_student{$_->[1]}=$_->[0];
                   1047:         }
                   1048:     }
                   1049:     return $ids_by_student{$student} if(exists( $ids_by_student{$student}));
                   1050:     return undef; # error
                   1051: }
                   1052: 
                   1053: sub get_student {
                   1054:     my ($student_id) = @_;
                   1055:     if (! exists($students_by_id{$student_id})  || 
                   1056:         ! defined($students_by_id{$student_id}) ||
                   1057:         $students_by_id{$student_id} eq '') {
                   1058:         my @Result = &Apache::lonmysql::get_rows($student_table);
                   1059:         foreach (@Result) {
                   1060:             $students_by_id{$_->[0]}=$_->[1];
                   1061:         }
                   1062:     }
                   1063:     return $students_by_id{$student_id} if(exists($students_by_id{$student_id}));
                   1064:     return undef; # error
                   1065: }
1.99      matthew  1066: 
                   1067: ################################################
                   1068: ################################################
                   1069: 
                   1070: =pod
                   1071: 
                   1072: =item &clear_internal_caches()
                   1073: 
                   1074: Causes the internal caches used in get_student_id, get_student,
                   1075: get_symb_id, get_symb, get_part_id, and get_part to be undef'd.
                   1076: 
                   1077: Needs to be called before the first operation with the MySQL database
                   1078: for a given Apache request.
                   1079: 
                   1080: =cut
                   1081: 
                   1082: ################################################
                   1083: ################################################
                   1084: sub clear_internal_caches {
                   1085:     $have_read_part_table = 0;
                   1086:     undef(%ids_by_part);
                   1087:     undef(%parts_by_id);
                   1088:     $have_read_symb_table = 0;
                   1089:     undef(%ids_by_symb);
                   1090:     undef(%symbs_by_id);
                   1091:     $have_read_student_table = 0;
                   1092:     undef(%ids_by_student);
                   1093:     undef(%students_by_id);
                   1094: }
                   1095: 
1.57      matthew  1096: 
                   1097: ################################################
                   1098: ################################################
                   1099: 
                   1100: =pod
                   1101: 
1.89      matthew  1102: =item &update_full_student_data($sname,$sdom,$courseid)
                   1103: 
                   1104: Does a lonnet::dump on a student to populate the courses tables.
                   1105: 
                   1106: Input: $sname, $sdom, $courseid
                   1107: 
                   1108: Output: $returnstatus
                   1109: 
                   1110: $returnstatus is a string describing any errors that occured.  'okay' is the
                   1111: default.
                   1112: 
                   1113: This subroutine loads a students data using lonnet::dump and inserts
                   1114: it into the MySQL database.  The inserts are done on three tables, 
                   1115: $fulldump_response_table, $fulldump_part_table, and $fulldump_timestamp_table.
                   1116: The INSERT calls are made directly by this subroutine, not through lonmysql 
                   1117: because we do a 'bulk'insert which takes advantage of MySQLs non-SQL 
                   1118: compliant INSERT command to insert multiple rows at a time.  
                   1119: If anything has gone wrong during this process, $returnstatus is updated with 
                   1120: a description of the error.
                   1121: 
                   1122: Once the "fulldump" tables are updated, the tables used for chart and
                   1123: spreadsheet (which hold only the current state of the student on their
                   1124: homework, not historical data) are updated.  If all updates have occured 
                   1125: successfully, the studentdata table is updated to reflect the time of the
                   1126: update.
                   1127: 
                   1128: Notice we do not insert the data and immediately query it.  This means it
                   1129: is possible for there to be data returned this first time that is not 
                   1130: available the second time.  CYA.
                   1131: 
                   1132: =cut
                   1133: 
                   1134: ################################################
                   1135: ################################################
                   1136: sub update_full_student_data {
                   1137:     my ($sname,$sdom,$courseid) = @_;
                   1138:     #
                   1139:     # Set up database names
                   1140:     &setup_table_names($courseid);
                   1141:     #
                   1142:     my $student_id = &get_student_id($sname,$sdom);
                   1143:     my $student = $sname.':'.$sdom;
                   1144:     #
                   1145:     my $returnstatus = 'okay';
                   1146:     #
                   1147:     # Download students data
                   1148:     my $time_of_retrieval = time;
                   1149:     my @tmp = &Apache::lonnet::dump($courseid,$sdom,$sname);
                   1150:     if (@tmp && $tmp[0] =~ /^error/) {
                   1151:         $returnstatus = 'error retrieving full student data';
                   1152:         return $returnstatus;
                   1153:     } elsif (! @tmp) {
                   1154:         $returnstatus = 'okay: no student data';
                   1155:         return $returnstatus;
                   1156:     }
                   1157:     my %studentdata = @tmp;
                   1158:     #
                   1159:     # Get database handle and clean out the tables 
                   1160:     my $dbh = &Apache::lonmysql::get_dbh();
                   1161:     $dbh->do('DELETE FROM '.$fulldump_response_table.' WHERE student_id='.
                   1162:              $student_id);
                   1163:     $dbh->do('DELETE FROM '.$fulldump_part_table.' WHERE student_id='.
                   1164:              $student_id);
                   1165:     $dbh->do('DELETE FROM '.$fulldump_timestamp_table.' WHERE student_id='.
                   1166:              $student_id);
                   1167:     #
                   1168:     # Parse and store the data into a form we can handle
                   1169:     my $partdata;
                   1170:     my $respdata;
                   1171:     while (my ($key,$value) = each(%studentdata)) {
                   1172:         next if ($key =~ /^(\d+):(resource$|subnum$|keys:)/);
                   1173:         my ($transaction,$symb,$parameter) = split(':',$key);
                   1174:         my $symb_id = &get_symb_id($symb);
                   1175:         if ($parameter eq 'timestamp') {
                   1176:             # We can deal with 'timestamp' right away
                   1177:             my @timestamp_storage = ($symb_id,$student_id,
                   1178:                                      $transaction,$value);
1.98      matthew  1179:             my $store_command = 'INSERT IGNORE INTO '.$fulldump_timestamp_table.
1.89      matthew  1180:                 " VALUES ('".join("','",@timestamp_storage)."');";
                   1181:             $dbh->do($store_command);
                   1182:             if ($dbh->err()) {
                   1183:                 &Apache::lonnet::logthis('unable to execute '.$store_command);
                   1184:                 &Apache::lonnet::logthis($dbh->errstr());
                   1185:             }
                   1186:             next;
                   1187:         } elsif ($parameter eq 'version') {
                   1188:             next;
1.90      matthew  1189:         } elsif ($parameter =~ /^resource\.(.*)\.(tries|
                   1190:                                                   award|
                   1191:                                                   awarded|
                   1192:                                                   previous|
                   1193:                                                   solved|
                   1194:                                                   awarddetail|
                   1195:                                                   submission|
                   1196:                                                   submissiongrading|
                   1197:                                                   molecule)\s*$/x){
1.89      matthew  1198:             # we do not have enough information to store an 
                   1199:             # entire row, so we save it up until later.
                   1200:             my ($part_and_resp_id,$field) = ($1,$2);
                   1201:             my ($part,$part_id,$resp,$resp_id);
                   1202:             if ($part_and_resp_id =~ /\./) {
                   1203:                 ($part,$resp) = split(/\./,$part_and_resp_id);
                   1204:                 $part_id = &get_part_id($part);
                   1205:                 $resp_id = &get_part_id($resp);
                   1206:             } else {
                   1207:                 $part_id = &get_part_id($part_and_resp_id);
                   1208:             }
1.90      matthew  1209:             # Deal with part specific data
1.89      matthew  1210:             if ($field =~ /^(tries|award|awarded|previous)$/) {
                   1211:                 $partdata->{$symb_id}->{$part_id}->{$transaction}->{$field}=$value;
                   1212:             }
1.90      matthew  1213:             # deal with response specific data
1.89      matthew  1214:             if (defined($resp_id) &&
1.100     matthew  1215:                 $field =~ /^(awarddetail|
1.90      matthew  1216:                              submission|
                   1217:                              submissiongrading|
                   1218:                              molecule)$/x) {
1.89      matthew  1219:                 if ($field eq 'submission') {
                   1220:                     # We have to be careful with user supplied input.
                   1221:                     # most of the time we are okay because it is escaped.
                   1222:                     # However, there is one wrinkle: submissions which end in
                   1223:                     # and odd number of '\' cause insert errors to occur.  
                   1224:                     # Best trap this somehow...
1.102     matthew  1225:                     $value =~ s/\'/\\\'/g;
1.89      matthew  1226:                     my ($offensive_string) = ($value =~ /(\\+)$/);
                   1227:                     if (length($offensive_string) % 2) {
                   1228:                         $value =~ s/\\$/\\\\/;
                   1229:                     }
                   1230:                 }
1.90      matthew  1231:                 if ($field eq 'submissiongrading' || 
                   1232:                     $field eq 'molecule') {
                   1233:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific'}=$field;
                   1234:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific_value'}=$value;
                   1235:                 } else {
                   1236:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{$field}=$value;
                   1237:                 }
1.89      matthew  1238:             }
                   1239:         }
                   1240:     }
                   1241:     ##
                   1242:     ## Store the part data
1.98      matthew  1243:     my $store_command = 'INSERT IGNORE INTO '.$fulldump_part_table.
1.89      matthew  1244:         ' VALUES '."\n";
                   1245:     my $store_rows = 0;
                   1246:     while (my ($symb_id,$hash1) = each (%$partdata)) {
                   1247:         while (my ($part_id,$hash2) = each (%$hash1)) {
                   1248:             while (my ($transaction,$data) = each (%$hash2)) {
                   1249:                 $store_command .= "('".join("','",$symb_id,$part_id,
                   1250:                                             $student_id,
                   1251:                                             $transaction,
1.101     matthew  1252:                                             $data->{'tries'},
1.89      matthew  1253:                                             $data->{'award'},
                   1254:                                             $data->{'awarded'},
                   1255:                                             $data->{'previous'})."'),";
                   1256:                 $store_rows++;
                   1257:             }
                   1258:         }
                   1259:     }
                   1260:     if ($store_rows) {
                   1261:         chop($store_command);
                   1262:         $dbh->do($store_command);
                   1263:         if ($dbh->err) {
                   1264:             $returnstatus = 'error storing part data';
                   1265:             &Apache::lonnet::logthis('insert error '.$dbh->errstr());
                   1266:             &Apache::lonnet::logthis("While attempting\n".$store_command);
                   1267:         }
                   1268:     }
                   1269:     ##
                   1270:     ## Store the response data
1.98      matthew  1271:     $store_command = 'INSERT IGNORE INTO '.$fulldump_response_table.
1.89      matthew  1272:         ' VALUES '."\n";
                   1273:     $store_rows = 0;
                   1274:     while (my ($symb_id,$hash1) = each (%$respdata)) {
                   1275:         while (my ($part_id,$hash2) = each (%$hash1)) {
                   1276:             while (my ($resp_id,$hash3) = each (%$hash2)) {
                   1277:                 while (my ($transaction,$data) = each (%$hash3)) {
                   1278:                     $store_command .= "('".join("','",$symb_id,$part_id,
                   1279:                                                 $resp_id,$student_id,
                   1280:                                                 $transaction,
                   1281:                                                 $data->{'awarddetail'},
1.90      matthew  1282:                                                 $data->{'response_specific'},
                   1283:                                                 $data->{'response_specific_value'},
1.89      matthew  1284:                                                 $data->{'submission'})."'),";
                   1285:                     $store_rows++;
                   1286:                 }
                   1287:             }
                   1288:         }
                   1289:     }
                   1290:     if ($store_rows) {
                   1291:         chop($store_command);
                   1292:         $dbh->do($store_command);
                   1293:         if ($dbh->err) {
                   1294:             $returnstatus = 'error storing response data';
                   1295:             &Apache::lonnet::logthis('insert error '.$dbh->errstr());
                   1296:             &Apache::lonnet::logthis("While attempting\n".$store_command);
                   1297:         }
                   1298:     }
                   1299:     ##
                   1300:     ## Update the students "current" data in the performance 
                   1301:     ## and parameters tables.
                   1302:     my ($status,undef) = &store_student_data
                   1303:         ($sname,$sdom,$courseid,
                   1304:          &Apache::lonnet::convert_dump_to_currentdump(\%studentdata));
                   1305:     if ($returnstatus eq 'okay' && $status ne 'okay') {
                   1306:         $returnstatus = 'error storing current data:'.$status;
                   1307:     } elsif ($status ne 'okay') {
                   1308:         $returnstatus .= ' error storing current data:'.$status;
                   1309:     }        
                   1310:     ##
                   1311:     ## Update the students time......
                   1312:     if ($returnstatus eq 'okay') {
                   1313:         &Apache::lonmysql::replace_row
                   1314:             ($studentdata_table,
                   1315:              [$student_id,$time_of_retrieval,$time_of_retrieval,undef,undef]);
                   1316:     }
                   1317:     return $returnstatus;
                   1318: }
                   1319: 
                   1320: ################################################
                   1321: ################################################
                   1322: 
                   1323: =pod
                   1324: 
1.57      matthew  1325: =item &update_student_data()
                   1326: 
                   1327: Input: $sname, $sdom, $courseid
                   1328: 
                   1329: Output: $returnstatus, \%student_data
                   1330: 
                   1331: $returnstatus is a string describing any errors that occured.  'okay' is the
                   1332: default.
                   1333: \%student_data is the data returned by a call to lonnet::currentdump.
                   1334: 
                   1335: This subroutine loads a students data using lonnet::currentdump and inserts
                   1336: it into the MySQL database.  The inserts are done on two tables, 
                   1337: $performance_table and $parameters_table.  $parameters_table holds the data 
                   1338: that is not included in $performance_table.  See the description of 
                   1339: $performance_table elsewhere in this file.  The INSERT calls are made
                   1340: directly by this subroutine, not through lonmysql because we do a 'bulk'
                   1341: insert which takes advantage of MySQLs non-SQL compliant INSERT command to 
                   1342: insert multiple rows at a time.  If anything has gone wrong during this
                   1343: process, $returnstatus is updated with a description of the error and
                   1344: \%student_data is returned.  
                   1345: 
                   1346: Notice we do not insert the data and immediately query it.  This means it
                   1347: is possible for there to be data returned this first time that is not 
                   1348: available the second time.  CYA.
                   1349: 
                   1350: =cut
                   1351: 
                   1352: ################################################
                   1353: ################################################
                   1354: sub update_student_data {
                   1355:     my ($sname,$sdom,$courseid) = @_;
                   1356:     #
1.60      matthew  1357:     # Set up database names
                   1358:     &setup_table_names($courseid);
                   1359:     #
1.57      matthew  1360:     my $student_id = &get_student_id($sname,$sdom);
                   1361:     my $student = $sname.':'.$sdom;
                   1362:     #
                   1363:     my $returnstatus = 'okay';
                   1364:     #
                   1365:     # Download students data
                   1366:     my $time_of_retrieval = time;
                   1367:     my @tmp = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
                   1368:     if ((scalar(@tmp) > 0) && ($tmp[0] =~ /^error:/)) {
                   1369:         &Apache::lonnet::logthis('error getting data for '.
                   1370:                                  $sname.':'.$sdom.' in course '.$courseid.
                   1371:                                  ':'.$tmp[0]);
                   1372:         $returnstatus = 'error getting data';
1.79      matthew  1373:         return ($returnstatus,undef);
1.57      matthew  1374:     }
                   1375:     if (scalar(@tmp) < 1) {
                   1376:         return ('no data',undef);
                   1377:     }
                   1378:     my %student_data = @tmp;
1.89      matthew  1379:     my @Results = &store_student_data($sname,$sdom,$courseid,\%student_data);
                   1380:     #
                   1381:     # Set the students update time
1.96      matthew  1382:     if ($Results[0] eq 'okay') {
1.95      matthew  1383:         &Apache::lonmysql::replace_row($studentdata_table,
1.89      matthew  1384:                          [$student_id,$time_of_retrieval,undef,undef,undef]);
1.95      matthew  1385:     }
1.89      matthew  1386:     #
                   1387:     return @Results;
                   1388: }
                   1389: 
                   1390: sub store_student_data {
                   1391:     my ($sname,$sdom,$courseid,$student_data) = @_;
                   1392:     #
                   1393:     my $student_id = &get_student_id($sname,$sdom);
                   1394:     my $student = $sname.':'.$sdom;
                   1395:     #
                   1396:     my $returnstatus = 'okay';
1.57      matthew  1397:     #
                   1398:     # Remove all of the students data from the table
1.60      matthew  1399:     my $dbh = &Apache::lonmysql::get_dbh();
                   1400:     $dbh->do('DELETE FROM '.$performance_table.' WHERE student_id='.
                   1401:              $student_id);
                   1402:     $dbh->do('DELETE FROM '.$parameters_table.' WHERE student_id='.
                   1403:              $student_id);
1.57      matthew  1404:     #
                   1405:     # Store away the data
                   1406:     #
                   1407:     my $starttime = Time::HiRes::time;
                   1408:     my $elapsed = 0;
                   1409:     my $rows_stored;
1.98      matthew  1410:     my $store_parameters_command  = 'INSERT IGNORE INTO '.$parameters_table.
1.60      matthew  1411:         ' VALUES '."\n";
1.61      matthew  1412:     my $num_parameters = 0;
1.98      matthew  1413:     my $store_performance_command = 'INSERT IGNORE INTO '.$performance_table.
1.60      matthew  1414:         ' VALUES '."\n";
1.79      matthew  1415:     return ('error',undef) if (! defined($dbh));
1.89      matthew  1416:     while (my ($current_symb,$param_hash) = each(%{$student_data})) {
1.57      matthew  1417:         #
                   1418:         # make sure the symb is set up properly
                   1419:         my $symb_id = &get_symb_id($current_symb);
                   1420:         #
                   1421:         # Load data into the tables
1.63      matthew  1422:         while (my ($parameter,$value) = each(%$param_hash)) {
1.57      matthew  1423:             my $newstring;
1.63      matthew  1424:             if ($parameter !~ /(timestamp|resource\.(.*)\.(solved|tries|awarded|award|awarddetail|previous))/) {
1.57      matthew  1425:                 $newstring = "('".join("','",
                   1426:                                        $symb_id,$student_id,
1.69      matthew  1427:                                        $parameter)."',".
                   1428:                                            $dbh->quote($value)."),\n";
1.61      matthew  1429:                 $num_parameters ++;
1.57      matthew  1430:                 if ($newstring !~ /''/) {
                   1431:                     $store_parameters_command .= $newstring;
                   1432:                     $rows_stored++;
                   1433:                 }
                   1434:             }
                   1435:             next if ($parameter !~ /^resource\.(.*)\.solved$/);
                   1436:             #
                   1437:             my $part = $1;
                   1438:             my $part_id = &get_part_id($part);
                   1439:             next if (!defined($part_id));
                   1440:             my $solved  = $value;
                   1441:             my $tries   = $param_hash->{'resource.'.$part.'.tries'};
                   1442:             my $awarded = $param_hash->{'resource.'.$part.'.awarded'};
                   1443:             my $award   = $param_hash->{'resource.'.$part.'.award'};
                   1444:             my $awarddetail = $param_hash->{'resource.'.$part.'.awarddetail'};
                   1445:             my $timestamp = $param_hash->{'timestamp'};
1.60      matthew  1446:             #
1.74      matthew  1447:             $solved      = '' if (! defined($solved));
1.57      matthew  1448:             $tries       = '' if (! defined($tries));
                   1449:             $awarded     = '' if (! defined($awarded));
                   1450:             $award       = '' if (! defined($award));
                   1451:             $awarddetail = '' if (! defined($awarddetail));
1.73      matthew  1452:             $newstring = "('".join("','",$symb_id,$student_id,$part_id,$part,
1.57      matthew  1453:                                    $solved,$tries,$awarded,$award,
1.63      matthew  1454:                                    $awarddetail,$timestamp)."'),\n";
1.57      matthew  1455:             $store_performance_command .= $newstring;
                   1456:             $rows_stored++;
                   1457:         }
                   1458:     }
                   1459:     chop $store_parameters_command;
1.60      matthew  1460:     chop $store_parameters_command;
                   1461:     chop $store_performance_command;
1.57      matthew  1462:     chop $store_performance_command;
                   1463:     my $start = Time::HiRes::time;
1.94      matthew  1464:     $dbh->do($store_performance_command);
                   1465:     if ($dbh->err()) {
                   1466:         &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
                   1467:         &Apache::lonnet::logthis('command = '.$store_performance_command);
                   1468:         $returnstatus = 'error: unable to insert performance into database';
                   1469:         return ($returnstatus,$student_data);
                   1470:     }
1.61      matthew  1471:     $dbh->do($store_parameters_command) if ($num_parameters>0);
1.57      matthew  1472:     if ($dbh->err()) {
                   1473:         &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
1.61      matthew  1474:         &Apache::lonnet::logthis('command = '.$store_parameters_command);
1.87      matthew  1475:         &Apache::lonnet::logthis('rows_stored = '.$rows_stored);
                   1476:         &Apache::lonnet::logthis('student_id = '.$student_id);
1.57      matthew  1477:         $returnstatus = 'error: unable to insert parameters into database';
1.89      matthew  1478:         return ($returnstatus,$student_data);
1.57      matthew  1479:     }
                   1480:     $elapsed += Time::HiRes::time - $start;
1.89      matthew  1481:     return ($returnstatus,$student_data);
1.57      matthew  1482: }
                   1483: 
1.89      matthew  1484: ######################################
                   1485: ######################################
1.57      matthew  1486: 
                   1487: =pod
                   1488: 
1.89      matthew  1489: =item &ensure_tables_are_set_up($courseid)
1.57      matthew  1490: 
1.89      matthew  1491: Checks to be sure the MySQL tables for the given class are set up.
                   1492: If $courseid is omitted it will be obtained from the environment.
1.57      matthew  1493: 
1.89      matthew  1494: Returns nothing on success and 'error' on failure
1.57      matthew  1495: 
                   1496: =cut
                   1497: 
1.89      matthew  1498: ######################################
                   1499: ######################################
                   1500: sub ensure_tables_are_set_up {
                   1501:     my ($courseid) = @_;
1.61      matthew  1502:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   1503:     # 
                   1504:     # Clean out package variables
1.57      matthew  1505:     &setup_table_names($courseid);
                   1506:     #
                   1507:     # if the tables do not exist, make them
                   1508:     my @CurrentTable = &Apache::lonmysql::tables_in_db();
1.87      matthew  1509:     my ($found_symb,$found_student,$found_part,$found_studentdata,
1.89      matthew  1510:         $found_performance,$found_parameters,$found_fulldump_part,
                   1511:         $found_fulldump_response,$found_fulldump_timestamp);
1.57      matthew  1512:     foreach (@CurrentTable) {
                   1513:         $found_symb        = 1 if ($_ eq $symb_table);
                   1514:         $found_student     = 1 if ($_ eq $student_table);
                   1515:         $found_part        = 1 if ($_ eq $part_table);
1.87      matthew  1516:         $found_studentdata = 1 if ($_ eq $studentdata_table);
1.57      matthew  1517:         $found_performance = 1 if ($_ eq $performance_table);
                   1518:         $found_parameters  = 1 if ($_ eq $parameters_table);
1.89      matthew  1519:         $found_fulldump_part      = 1 if ($_ eq $fulldump_part_table);
                   1520:         $found_fulldump_response  = 1 if ($_ eq $fulldump_response_table);
                   1521:         $found_fulldump_timestamp = 1 if ($_ eq $fulldump_timestamp_table);
1.57      matthew  1522:     }
1.87      matthew  1523:     if (!$found_symb        || !$found_studentdata || 
1.57      matthew  1524:         !$found_student     || !$found_part   ||
1.89      matthew  1525:         !$found_performance || !$found_parameters ||
                   1526:         !$found_fulldump_part || !$found_fulldump_response ||
                   1527:         !$found_fulldump_timestamp ) {
1.57      matthew  1528:         if (&init_dbs($courseid)) {
1.89      matthew  1529:             return 'error';
1.57      matthew  1530:         }
                   1531:     }
1.89      matthew  1532: }
                   1533: 
                   1534: ################################################
                   1535: ################################################
                   1536: 
                   1537: =pod
                   1538: 
                   1539: =item &ensure_current_data()
                   1540: 
                   1541: Input: $sname, $sdom, $courseid
                   1542: 
                   1543: Output: $status, $data
                   1544: 
                   1545: This routine ensures the data for a given student is up to date.
                   1546: The $studentdata_table is queried to determine the time of the last update.  
                   1547: If the students data is out of date, &update_student_data() is called.  
                   1548: The return values from the call to &update_student_data() are returned.
                   1549: 
                   1550: =cut
                   1551: 
                   1552: ################################################
                   1553: ################################################
                   1554: sub ensure_current_data {
                   1555:     my ($sname,$sdom,$courseid) = @_;
                   1556:     my $status = 'okay';   # return value
                   1557:     #
                   1558:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   1559:     &ensure_tables_are_set_up($courseid);
1.57      matthew  1560:     #
                   1561:     # Get the update time for the user
                   1562:     my $updatetime = 0;
1.60      matthew  1563:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
                   1564:         ($sdom,$sname,$courseid.'.db',
                   1565:          $Apache::lonnet::perlvar{'lonUsersDir'});
1.57      matthew  1566:     #
1.87      matthew  1567:     my $student_id = &get_student_id($sname,$sdom);
                   1568:     my @Result = &Apache::lonmysql::get_rows($studentdata_table,
                   1569:                                              "student_id ='$student_id'");
1.57      matthew  1570:     my $data = undef;
                   1571:     if (@Result) {
                   1572:         $updatetime = $Result[0]->[1];
                   1573:     }
                   1574:     if ($modifiedtime > $updatetime) {
                   1575:         ($status,$data) = &update_student_data($sname,$sdom,$courseid);
                   1576:     }
                   1577:     return ($status,$data);
                   1578: }
                   1579: 
                   1580: ################################################
                   1581: ################################################
                   1582: 
                   1583: =pod
                   1584: 
1.89      matthew  1585: =item &ensure_current_full_data($sname,$sdom,$courseid)
                   1586: 
                   1587: Input: $sname, $sdom, $courseid
                   1588: 
                   1589: Output: $status
                   1590: 
                   1591: This routine ensures the fulldata (the data from a lonnet::dump, not a
                   1592: lonnet::currentdump) for a given student is up to date.
                   1593: The $studentdata_table is queried to determine the time of the last update.  
                   1594: If the students fulldata is out of date, &update_full_student_data() is
                   1595: called.  
                   1596: 
                   1597: The return value from the call to &update_full_student_data() is returned.
                   1598: 
                   1599: =cut
                   1600: 
                   1601: ################################################
                   1602: ################################################
                   1603: sub ensure_current_full_data {
                   1604:     my ($sname,$sdom,$courseid) = @_;
                   1605:     my $status = 'okay';   # return value
                   1606:     #
                   1607:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   1608:     &ensure_tables_are_set_up($courseid);
                   1609:     #
                   1610:     # Get the update time for the user
                   1611:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
                   1612:         ($sdom,$sname,$courseid.'.db',
                   1613:          $Apache::lonnet::perlvar{'lonUsersDir'});
                   1614:     #
                   1615:     my $student_id = &get_student_id($sname,$sdom);
                   1616:     my @Result = &Apache::lonmysql::get_rows($studentdata_table,
                   1617:                                              "student_id ='$student_id'");
                   1618:     my $updatetime;
                   1619:     if (@Result && ref($Result[0]) eq 'ARRAY') {
                   1620:         $updatetime = $Result[0]->[2];
                   1621:     }
                   1622:     if (! defined($updatetime) || $modifiedtime > $updatetime) {
                   1623:         $status = &update_full_student_data($sname,$sdom,$courseid);
                   1624:     }
                   1625:     return $status;
                   1626: }
                   1627: 
                   1628: ################################################
                   1629: ################################################
                   1630: 
                   1631: =pod
                   1632: 
1.57      matthew  1633: =item &get_student_data_from_performance_cache()
                   1634: 
                   1635: Input: $sname, $sdom, $symb, $courseid
                   1636: 
                   1637: Output: hash reference containing the data for the given student.
                   1638: If $symb is undef, all the students data is returned.
                   1639: 
                   1640: This routine is the heart of the local caching system.  See the description
                   1641: of $performance_table, $symb_table, $student_table, and $part_table.  The
                   1642: main task is building the MySQL request.  The tables appear in the request
                   1643: in the order in which they should be parsed by MySQL.  When searching
                   1644: on a student the $student_table is used to locate the 'student_id'.  All
                   1645: rows in $performance_table which have a matching 'student_id' are returned,
                   1646: with data from $part_table and $symb_table which match the entries in
                   1647: $performance_table, 'part_id' and 'symb_id'.  When searching on a symb,
                   1648: the $symb_table is processed first, with matching rows grabbed from 
                   1649: $performance_table and filled in from $part_table and $student_table in
                   1650: that order.  
                   1651: 
                   1652: Running 'EXPLAIN ' on the 'SELECT' statements generated can be quite 
                   1653: interesting, especially if you play with the order the tables are listed.  
                   1654: 
                   1655: =cut
                   1656: 
                   1657: ################################################
                   1658: ################################################
                   1659: sub get_student_data_from_performance_cache {
                   1660:     my ($sname,$sdom,$symb,$courseid)=@_;
                   1661:     my $student = $sname.':'.$sdom if (defined($sname) && defined($sdom));
1.61      matthew  1662:     &setup_table_names($courseid);
1.57      matthew  1663:     #
                   1664:     # Return hash
                   1665:     my $studentdata;
                   1666:     #
                   1667:     my $dbh = &Apache::lonmysql::get_dbh();
                   1668:     my $request = "SELECT ".
1.73      matthew  1669:         "d.symb,a.part,a.solved,a.tries,a.awarded,a.award,a.awarddetail,".
1.63      matthew  1670:             "a.timestamp ";
1.57      matthew  1671:     if (defined($student)) {
                   1672:         $request .= "FROM $student_table AS b ".
                   1673:             "LEFT JOIN $performance_table AS a ON b.student_id=a.student_id ".
1.73      matthew  1674: #            "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
1.57      matthew  1675:             "LEFT JOIN $symb_table AS d ON d.symb_id = a.symb_id ".
                   1676:                 "WHERE student='$student'";
                   1677:         if (defined($symb) && $symb ne '') {
1.67      matthew  1678:             $request .= " AND d.symb=".$dbh->quote($symb);
1.57      matthew  1679:         }
                   1680:     } elsif (defined($symb) && $symb ne '') {
                   1681:         $request .= "FROM $symb_table as d ".
                   1682:             "LEFT JOIN $performance_table AS a ON d.symb_id=a.symb_id ".
1.73      matthew  1683: #            "LEFT JOIN $part_table    AS c ON c.part_id = a.part_id ".
1.57      matthew  1684:             "LEFT JOIN $student_table AS b ON b.student_id = a.student_id ".
                   1685:                 "WHERE symb='".$dbh->quote($symb)."'";
                   1686:     }
                   1687:     my $starttime = Time::HiRes::time;
                   1688:     my $rows_retrieved = 0;
                   1689:     my $sth = $dbh->prepare($request);
                   1690:     $sth->execute();
                   1691:     if ($sth->err()) {
                   1692:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
                   1693:         &Apache::lonnet::logthis("\n".$request."\n");
                   1694:         &Apache::lonnet::logthis("error is:".$sth->errstr());
                   1695:         return undef;
                   1696:     }
                   1697:     foreach my $row (@{$sth->fetchall_arrayref}) {
                   1698:         $rows_retrieved++;
1.63      matthew  1699:         my ($symb,$part,$solved,$tries,$awarded,$award,$awarddetail,$time) = 
1.57      matthew  1700:             (@$row);
                   1701:         my $base = 'resource.'.$part;
                   1702:         $studentdata->{$symb}->{$base.'.solved'}  = $solved;
                   1703:         $studentdata->{$symb}->{$base.'.tries'}   = $tries;
                   1704:         $studentdata->{$symb}->{$base.'.awarded'} = $awarded;
                   1705:         $studentdata->{$symb}->{$base.'.award'}   = $award;
                   1706:         $studentdata->{$symb}->{$base.'.awarddetail'} = $awarddetail;
                   1707:         $studentdata->{$symb}->{'timestamp'} = $time if (defined($time) && $time ne '');
1.67      matthew  1708:     }
1.97      matthew  1709:     ## Get misc parameters
                   1710:     $request = 'SELECT c.symb,a.parameter,a.value '.
                   1711:         "FROM $student_table AS b ".
                   1712:         "LEFT JOIN $parameters_table AS a ON b.student_id=a.student_id ".
                   1713:         "LEFT JOIN $symb_table AS c ON c.symb_id = a.symb_id ".
                   1714:         "WHERE student='$student'";
                   1715:     if (defined($symb) && $symb ne '') {
                   1716:         $request .= " AND c.symb=".$dbh->quote($symb);
                   1717:     }
                   1718:     $sth = $dbh->prepare($request);
                   1719:     $sth->execute();
                   1720:     if ($sth->err()) {
                   1721:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
                   1722:         &Apache::lonnet::logthis("\n".$request."\n");
                   1723:         &Apache::lonnet::logthis("error is:".$sth->errstr());
                   1724:         if (defined($symb) && $symb ne '') {
                   1725:             $studentdata = $studentdata->{$symb};
                   1726:         }
                   1727:         return $studentdata;
                   1728:     }
                   1729:     #
                   1730:     foreach my $row (@{$sth->fetchall_arrayref}) {
                   1731:         $rows_retrieved++;
                   1732:         my ($symb,$parameter,$value) = (@$row);
                   1733:         $studentdata->{$symb}->{$parameter}  = $value;
                   1734:     }
                   1735:     #
1.67      matthew  1736:     if (defined($symb) && $symb ne '') {
                   1737:         $studentdata = $studentdata->{$symb};
1.57      matthew  1738:     }
                   1739:     return $studentdata;
                   1740: }
                   1741: 
                   1742: ################################################
                   1743: ################################################
                   1744: 
                   1745: =pod
                   1746: 
                   1747: =item &get_current_state()
                   1748: 
                   1749: Input: $sname,$sdom,$symb,$courseid
                   1750: 
                   1751: Output: Described below
1.46      matthew  1752: 
1.47      matthew  1753: Retrieve the current status of a students performance.  $sname and
1.46      matthew  1754: $sdom are the only required parameters.  If $symb is undef the results
1.47      matthew  1755: of an &Apache::lonnet::currentdump() will be returned.  
1.46      matthew  1756: If $courseid is undef it will be retrieved from the environment.
                   1757: 
                   1758: The return structure is based on &Apache::lonnet::currentdump.  If
                   1759: $symb is unspecified, all the students data is returned in a hash of
                   1760: the form:
                   1761: ( 
                   1762:   symb1 => { param1 => value1, param2 => value2 ... },
                   1763:   symb2 => { param1 => value1, param2 => value2 ... },
                   1764: )
                   1765: 
                   1766: If $symb is specified, a hash of 
                   1767: (
                   1768:   param1 => value1, 
                   1769:   param2 => value2,
                   1770: )
                   1771: is returned.
                   1772: 
1.57      matthew  1773: If no data is found for $symb, or if the student has no performance data,
1.46      matthew  1774: an empty list is returned.
                   1775: 
                   1776: =cut
                   1777: 
                   1778: ################################################
                   1779: ################################################
                   1780: sub get_current_state {
1.47      matthew  1781:     my ($sname,$sdom,$symb,$courseid,$forcedownload)=@_;
                   1782:     #
1.46      matthew  1783:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
1.47      matthew  1784:     #
1.61      matthew  1785:     return () if (! defined($sname) || ! defined($sdom));
                   1786:     #
1.57      matthew  1787:     my ($status,$data) = &ensure_current_data($sname,$sdom,$courseid);
1.77      matthew  1788: #    &Apache::lonnet::logthis
                   1789: #        ('sname = '.$sname.
                   1790: #         ' domain = '.$sdom.
                   1791: #         ' status = '.$status.
                   1792: #         ' data is '.(defined($data)?'defined':'undefined'));
1.73      matthew  1793: #    while (my ($symb,$hash) = each(%$data)) {
                   1794: #        &Apache::lonnet::logthis($symb."\n----------------------------------");
                   1795: #        while (my ($key,$value) = each (%$hash)) {
                   1796: #            &Apache::lonnet::logthis("   ".$key." = ".$value);
                   1797: #        }
                   1798: #    }
1.47      matthew  1799:     #
1.79      matthew  1800:     if (defined($data) && defined($symb) && ref($data->{$symb})) {
                   1801:         return %{$data->{$symb}};
                   1802:     } elsif (defined($data) && ! defined($symb) && ref($data)) {
                   1803:         return %$data;
                   1804:     } 
                   1805:     if ($status eq 'no data') {
1.57      matthew  1806:         return ();
                   1807:     } else {
                   1808:         if ($status ne 'okay' && $status ne '') {
                   1809:             &Apache::lonnet::logthis('status = '.$status);
1.47      matthew  1810:             return ();
                   1811:         }
1.57      matthew  1812:         my $returnhash = &get_student_data_from_performance_cache($sname,$sdom,
                   1813:                                                       $symb,$courseid);
                   1814:         return %$returnhash if (defined($returnhash));
1.46      matthew  1815:     }
1.57      matthew  1816:     return ();
1.61      matthew  1817: }
                   1818: 
                   1819: ################################################
                   1820: ################################################
                   1821: 
                   1822: =pod
                   1823: 
                   1824: =item &get_problem_statistics()
                   1825: 
                   1826: Gather data on a given problem.  The database is assumed to be 
                   1827: populated and all local caching variables are assumed to be set
                   1828: properly.  This means you need to call &ensure_current_data for
                   1829: the students you are concerned with prior to calling this routine.
                   1830: 
                   1831: Inputs: $students, $symb, $part, $courseid
                   1832: 
1.64      matthew  1833: =over 4
                   1834: 
                   1835: =item $students is an array of hash references.  
                   1836: Each hash must contain at least the 'username' and 'domain' of a student.
                   1837: 
                   1838: =item $symb is the symb for the problem.
                   1839: 
                   1840: =item $part is the part id you need statistics for
                   1841: 
                   1842: =item $courseid is the course id, of course!
                   1843: 
                   1844: =back
                   1845: 
1.66      matthew  1846: Outputs: See the code for up to date information.  A hash reference is
                   1847: returned.  The hash has the following keys defined:
1.64      matthew  1848: 
                   1849: =over 4
                   1850: 
1.66      matthew  1851: =item num_students The number of students attempting the problem
                   1852:       
                   1853: =item tries The total number of tries for the students
                   1854:       
                   1855: =item max_tries The maximum number of tries taken
                   1856:       
                   1857: =item mean_tries The average number of tries
                   1858:       
                   1859: =item num_solved The number of students able to solve the problem
                   1860:       
                   1861: =item num_override The number of students whose answer is 'correct_by_override'
                   1862:       
                   1863: =item deg_of_diff The degree of difficulty of the problem
                   1864:       
                   1865: =item std_tries The standard deviation of the number of tries
                   1866:       
                   1867: =item skew_tries The skew of the number of tries
1.64      matthew  1868: 
1.66      matthew  1869: =item per_wrong The number of students attempting the problem who were not
                   1870: able to answer it correctly.
1.64      matthew  1871: 
                   1872: =back
                   1873: 
1.61      matthew  1874: =cut
                   1875: 
                   1876: ################################################
                   1877: ################################################
                   1878: sub get_problem_statistics {
                   1879:     my ($students,$symb,$part,$courseid) = @_;
                   1880:     return if (! defined($symb) || ! defined($part));
                   1881:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   1882:     #
1.100     matthew  1883:     &setup_table_names($courseid);
1.61      matthew  1884:     my $symb_id = &get_symb_id($symb);
                   1885:     my $part_id = &get_part_id($part);
                   1886:     my $stats_table = $courseid.'_problem_stats';
                   1887:     #
                   1888:     my $dbh = &Apache::lonmysql::get_dbh();
                   1889:     return undef if (! defined($dbh));
                   1890:     #
                   1891:     # A) Number of Students attempting problem
                   1892:     # B) Total number of tries of students attempting problem
                   1893:     # C) Mod (largest number of tries for solving the problem)
                   1894:     # D) Mean (average number of tries for solving the problem)
                   1895:     # E) Number of students to solve the problem
                   1896:     # F) Number of students to solve the problem by override
                   1897:     # G) Number of students unable to solve the problem
                   1898:     # H) Degree of difficulty : 1-(E+F)/B
                   1899:     # I) Standard deviation of number of tries
                   1900:     # J) Skew of tries: sqrt(sum(Xi-D)^3)/A
                   1901:     #
                   1902:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
                   1903:     my $request = 
                   1904:         'CREATE TEMPORARY TABLE '.$stats_table.
                   1905:             ' SELECT student_id,solved,award,tries FROM '.$performance_table.
                   1906:                 ' WHERE symb_id='.$symb_id.' AND part_id='.$part_id;
1.64      matthew  1907:     if (defined($students)) {
                   1908:         $request .= ' AND ('.
                   1909:             join(' OR ', map {'student_id='.
                   1910:                                   &get_student_id($_->{'username'},
                   1911:                                                   $_->{'domain'})
                   1912:                                   } @$students
                   1913:                  ).')';
                   1914:     }
1.61      matthew  1915: #    &Apache::lonnet::logthis($request);
                   1916:     $dbh->do($request);
                   1917:     my ($num,$tries,$mod,$mean,$STD) = &execute_SQL_request
                   1918:         ($dbh,
                   1919:          'SELECT COUNT(*),SUM(tries),MAX(tries),AVG(tries),STD(tries) FROM '.
                   1920:          $stats_table);
                   1921:     my ($Solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
                   1922:                                         $stats_table.
1.92      matthew  1923:          " WHERE solved='correct_by_student' OR solved='correct_by_scantron'");
1.61      matthew  1924:     my ($solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
                   1925:                                         $stats_table.
                   1926:                                         " WHERE solved='correct_by_override'");
                   1927:     $num    = 0 if (! defined($num));
                   1928:     $tries  = 0 if (! defined($tries));
                   1929:     $mod    = 0 if (! defined($mod));
                   1930:     $STD    = 0 if (! defined($STD));
                   1931:     $Solved = 0 if (! defined($Solved));
                   1932:     $solved = 0 if (! defined($solved));
                   1933:     #
                   1934:     my $DegOfDiff = 'nan';
1.66      matthew  1935:     $DegOfDiff = 1-($Solved)/$tries if ($tries>0);
1.61      matthew  1936: 
                   1937:     my $SKEW = 'nan';
1.66      matthew  1938:     my $wrongpercent = 0;
1.61      matthew  1939:     if ($num > 0) {
                   1940:         ($SKEW) = &execute_SQL_request($dbh,'SELECT SQRT(SUM('.
                   1941:                                      'POWER(tries - '.$STD.',3)'.
                   1942:                                      '))/'.$num.' FROM '.$stats_table);
1.66      matthew  1943:         $wrongpercent=int(10*100*($num-$Solved+$solved)/$num)/10;
1.61      matthew  1944:     }
                   1945:     #
                   1946:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
1.81      matthew  1947:     #
                   1948:     # Store in metadata
                   1949:     #
1.80      www      1950:     if ($num) {
                   1951: 	my %storestats=();
                   1952: 
1.86      www      1953:         my $urlres=(&Apache::lonnet::decode_symb($symb))[2];
1.80      www      1954: 
                   1955: 	$storestats{$courseid.'___'.$urlres.'___timestamp'}=time;       
                   1956: 	$storestats{$courseid.'___'.$urlres.'___stdno'}=$num;
                   1957: 	$storestats{$courseid.'___'.$urlres.'___avetries'}=$mean;	   
                   1958: 	$storestats{$courseid.'___'.$urlres.'___difficulty'}=$DegOfDiff;
                   1959: 
                   1960: 	$urlres=~/^(\w+)\/(\w+)/; 
                   1961: 	&Apache::lonnet::put('nohist_resevaldata',\%storestats,$1,$2); 
                   1962:     }
1.81      matthew  1963:     #
                   1964:     # Return result
                   1965:     #
1.66      matthew  1966:     return { num_students => $num,
                   1967:              tries        => $tries,
                   1968:              max_tries    => $mod,
                   1969:              mean_tries   => $mean,
                   1970:              std_tries    => $STD,
                   1971:              skew_tries   => $SKEW,
                   1972:              num_solved   => $Solved,
                   1973:              num_override => $solved,
                   1974:              per_wrong    => $wrongpercent,
1.81      matthew  1975:              deg_of_diff  => $DegOfDiff };
1.61      matthew  1976: }
                   1977: 
                   1978: sub execute_SQL_request {
                   1979:     my ($dbh,$request)=@_;
                   1980: #    &Apache::lonnet::logthis($request);
                   1981:     my $sth = $dbh->prepare($request);
                   1982:     $sth->execute();
                   1983:     my $row = $sth->fetchrow_arrayref();
                   1984:     if (ref($row) eq 'ARRAY' && scalar(@$row)>0) {
                   1985:         return @$row;
                   1986:     }
                   1987:     return ();
                   1988: }
                   1989: 
1.103     matthew  1990: #sub get_timestamp_data {
                   1991: #    my ($students,$symb,
1.100     matthew  1992: sub get_optionresponse_data {
                   1993:     my ($students,$symb,$response,$courseid) = @_;
1.103     matthew  1994:     return undef if (! defined($symb) || 
1.100     matthew  1995:                ! defined($response));
                   1996:     $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   1997:     #
                   1998:     &setup_table_names($courseid);
                   1999:     my $symb_id = &get_symb_id($symb);
                   2000:     my $response_id = &get_part_id($response);
                   2001:     #
                   2002:     my $dbh = &Apache::lonmysql::get_dbh();
                   2003:     return undef if (! defined($dbh));
                   2004:     my $request = 'SELECT '.
1.104   ! matthew  2005:         'a.awarddetail, a.response_specific_value, a.submission, '.
        !          2006:         'b.timestamp, c.tries '.
1.100     matthew  2007:         'FROM '.$fulldump_response_table.' AS a '.
                   2008:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
                   2009:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
                   2010:         'a.transaction = b.transaction '.
                   2011:         'LEFT JOIN '.$fulldump_part_table.' AS c '.
                   2012:         'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.        
                   2013:         'a.part_id=c.part_id AND a.transaction = c.transaction '.
                   2014:         'WHERE '.
                   2015:         'a.symb_id='.$symb_id.' AND a.response_id='.$response_id;
                   2016:     if (defined($students)) {
                   2017:         $request .= ' AND ('.
1.103     matthew  2018:             join(' OR ', map {'a.student_id='.
1.100     matthew  2019:                                   &get_student_id($_->{'username'},
                   2020:                                                   $_->{'domain'})
                   2021:                               } @$students
                   2022:                  ).')';
                   2023:     }
                   2024:     $request .= ' ORDER BY b.timestamp';
1.103     matthew  2025: #    &Apache::lonnet::logthis("request =\n".$request);
1.100     matthew  2026:     my $sth = $dbh->prepare($request);
                   2027:     $sth->execute();
                   2028:     my $dataset = $sth->fetchall_arrayref();
                   2029:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
1.103     matthew  2030:         return $dataset;
1.100     matthew  2031:     }
                   2032: }
1.61      matthew  2033: 
                   2034: ################################################
                   2035: ################################################
                   2036: 
                   2037: =pod
                   2038: 
                   2039: =item &setup_table_names()
                   2040: 
                   2041: input: course id
                   2042: 
                   2043: output: none
                   2044: 
                   2045: Cleans up the package variables for local caching.
                   2046: 
                   2047: =cut
                   2048: 
                   2049: ################################################
                   2050: ################################################
                   2051: sub setup_table_names {
                   2052:     my ($courseid) = @_;
                   2053:     if (! defined($courseid)) {
                   2054:         $courseid = $ENV{'request.course.id'};
                   2055:     }
                   2056:     #
                   2057:     if (! defined($current_course) || $current_course ne $courseid) {
                   2058:         # Clear out variables
                   2059:         $have_read_part_table = 0;
                   2060:         undef(%ids_by_part);
                   2061:         undef(%parts_by_id);
                   2062:         $have_read_symb_table = 0;
                   2063:         undef(%ids_by_symb);
                   2064:         undef(%symbs_by_id);
                   2065:         $have_read_student_table = 0;
                   2066:         undef(%ids_by_student);
                   2067:         undef(%students_by_id);
                   2068:         #
                   2069:         $current_course = $courseid;
                   2070:     }
                   2071:     #
                   2072:     # Set up database names
                   2073:     my $base_id = $courseid;
                   2074:     $symb_table        = $base_id.'_'.'symb';
                   2075:     $part_table        = $base_id.'_'.'part';
                   2076:     $student_table     = $base_id.'_'.'student';
1.87      matthew  2077:     $studentdata_table = $base_id.'_'.'studentdata';
1.61      matthew  2078:     $performance_table = $base_id.'_'.'performance';
                   2079:     $parameters_table  = $base_id.'_'.'parameters';
1.89      matthew  2080:     $fulldump_part_table      = $base_id.'_'.'partdata';
                   2081:     $fulldump_response_table  = $base_id.'_'.'responsedata';
                   2082:     $fulldump_timestamp_table = $base_id.'_'.'timestampdata';
                   2083:     #
                   2084:     @Tables = (
                   2085:                $symb_table,
                   2086:                $part_table,
                   2087:                $student_table,
                   2088:                $studentdata_table,
                   2089:                $performance_table,
                   2090:                $parameters_table,
                   2091:                $fulldump_part_table,
                   2092:                $fulldump_response_table,
                   2093:                $fulldump_timestamp_table,
                   2094:                );
1.61      matthew  2095:     return;
1.3       stredwic 2096: }
1.1       stredwic 2097: 
1.35      matthew  2098: ################################################
                   2099: ################################################
                   2100: 
                   2101: =pod
                   2102: 
1.57      matthew  2103: =back
                   2104: 
                   2105: =item End of Local Data Caching Subroutines
                   2106: 
                   2107: =cut
                   2108: 
                   2109: ################################################
                   2110: ################################################
                   2111: 
1.89      matthew  2112: } # End scope of table identifiers
1.57      matthew  2113: 
                   2114: ################################################
                   2115: ################################################
                   2116: 
                   2117: =pod
                   2118: 
                   2119: =head3 Classlist Subroutines
                   2120: 
1.35      matthew  2121: =item &get_classlist();
                   2122: 
                   2123: Retrieve the classist of a given class or of the current class.  Student
                   2124: information is returned from the classlist.db file and, if needed,
                   2125: from the students environment.
                   2126: 
                   2127: Optional arguments are $cid, $cdom, and $cnum (course id, course domain,
                   2128: and course number, respectively).  Any omitted arguments will be taken 
                   2129: from the current environment ($ENV{'request.course.id'},
                   2130: $ENV{'course.'.$cid.'.domain'}, and $ENV{'course.'.$cid.'.num'}).
                   2131: 
                   2132: Returns a reference to a hash which contains:
                   2133:  keys    '$sname:$sdom'
1.54      bowersj2 2134:  values  [$sdom,$sname,$end,$start,$id,$section,$fullname,$status]
                   2135: 
                   2136: The constant values CL_SDOM, CL_SNAME, CL_END, etc. can be used
                   2137: as indices into the returned list to future-proof clients against
                   2138: changes in the list order.
1.35      matthew  2139: 
                   2140: =cut
                   2141: 
                   2142: ################################################
                   2143: ################################################
1.54      bowersj2 2144: 
                   2145: sub CL_SDOM     { return 0; }
                   2146: sub CL_SNAME    { return 1; }
                   2147: sub CL_END      { return 2; }
                   2148: sub CL_START    { return 3; }
                   2149: sub CL_ID       { return 4; }
                   2150: sub CL_SECTION  { return 5; }
                   2151: sub CL_FULLNAME { return 6; }
                   2152: sub CL_STATUS   { return 7; }
1.35      matthew  2153: 
                   2154: sub get_classlist {
                   2155:     my ($cid,$cdom,$cnum) = @_;
                   2156:     $cid = $cid || $ENV{'request.course.id'};
                   2157:     $cdom = $cdom || $ENV{'course.'.$cid.'.domain'};
                   2158:     $cnum = $cnum || $ENV{'course.'.$cid.'.num'};
1.57      matthew  2159:     my $now = time;
1.35      matthew  2160:     #
                   2161:     my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
                   2162:     while (my ($student,$info) = each(%classlist)) {
1.60      matthew  2163:         if ($student =~ /^(con_lost|error|no_such_host)/i) {
                   2164:             &Apache::lonnet::logthis('get_classlist error for '.$cid.':'.$student);
                   2165:             return undef;
                   2166:         }
1.35      matthew  2167:         my ($sname,$sdom) = split(/:/,$student);
                   2168:         my @Values = split(/:/,$info);
                   2169:         my ($end,$start,$id,$section,$fullname);
                   2170:         if (@Values > 2) {
                   2171:             ($end,$start,$id,$section,$fullname) = @Values;
                   2172:         } else { # We have to get the data ourselves
                   2173:             ($end,$start) = @Values;
1.37      matthew  2174:             $section = &Apache::lonnet::getsection($sdom,$sname,$cid);
1.35      matthew  2175:             my %info=&Apache::lonnet::get('environment',
                   2176:                                           ['firstname','middlename',
                   2177:                                            'lastname','generation','id'],
                   2178:                                           $sdom, $sname);
                   2179:             my ($tmp) = keys(%info);
                   2180:             if ($tmp =~/^(con_lost|error|no_such_host)/i) {
                   2181:                 $fullname = 'not available';
                   2182:                 $id = 'not available';
1.38      matthew  2183:                 &Apache::lonnet::logthis('unable to retrieve environment '.
                   2184:                                          'for '.$sname.':'.$sdom);
1.35      matthew  2185:             } else {
                   2186:                 $fullname = &ProcessFullName(@info{qw/lastname generation 
                   2187:                                                        firstname middlename/});
                   2188:                 $id = $info{'id'};
                   2189:             }
1.36      matthew  2190:             # Update the classlist with this students information
                   2191:             if ($fullname ne 'not available') {
                   2192:                 my $enrolldata = join(':',$end,$start,$id,$section,$fullname);
                   2193:                 my $reply=&Apache::lonnet::cput('classlist',
                   2194:                                                 {$student => $enrolldata},
                   2195:                                                 $cdom,$cnum);
                   2196:                 if ($reply !~ /^(ok|delayed)/) {
                   2197:                     &Apache::lonnet::logthis('Unable to update classlist for '.
                   2198:                                              'student '.$sname.':'.$sdom.
                   2199:                                              ' error:'.$reply);
                   2200:                 }
                   2201:             }
1.35      matthew  2202:         }
                   2203:         my $status='Expired';
                   2204:         if(((!$end) || $now < $end) && ((!$start) || ($now > $start))) {
                   2205:             $status='Active';
                   2206:         }
                   2207:         $classlist{$student} = 
                   2208:             [$sdom,$sname,$end,$start,$id,$section,$fullname,$status];
                   2209:     }
                   2210:     if (wantarray()) {
                   2211:         return (\%classlist,['domain','username','end','start','id',
                   2212:                              'section','fullname','status']);
                   2213:     } else {
                   2214:         return \%classlist;
                   2215:     }
                   2216: }
                   2217: 
1.1       stredwic 2218: # ----- END HELPER FUNCTIONS --------------------------------------------
                   2219: 
                   2220: 1;
                   2221: __END__
1.36      matthew  2222: 
1.35      matthew  2223: 

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