File:  [LON-CAPA] / loncom / interface / loncoursedata.pm
Revision 1.201.2.2: download - view: text, annotated - select for diffs
Wed Mar 14 17:07:29 2018 UTC (6 years, 3 months ago) by raeburn
Branches: version_2_11_X
CVS tags: version_2_11_2_msu
Diff to branchpoint 1.201: preferred, unified
- For 2.11
  Backport 1.204.

    1: # The LearningOnline Network with CAPA
    2: #
    3: # $Id: loncoursedata.pm,v 1.201.2.2 2018/03/14 17:07:29 raeburn Exp $
    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: =pod
   29: 
   30: =head1 NAME
   31: 
   32: Apache::loncoursedata
   33: 
   34: =head1 SYNOPSIS
   35: 
   36: Set of functions that download and process student and course information.
   37: 
   38: =head1 PACKAGES USED
   39: 
   40:   Apache::lonnet
   41:   Apache::longroup
   42:   Time::HiRes
   43:   Apache::lonmysql
   44:   LONCAPA
   45:   Digest::MD5
   46: 
   47: =cut
   48: 
   49: package Apache::loncoursedata;
   50: 
   51: use strict;
   52: use Apache::lonnet;
   53: use Apache::longroup();
   54: use Time::HiRes();
   55: use Apache::lonmysql();
   56: use LONCAPA;
   57: use Digest::MD5();
   58: 
   59: =pod 
   60: 
   61: =head2 make_into_hash
   62: 
   63: Turn a colon separated string into a hash and return a reference
   64: to it.  Numbering from 0 even elements are keys and odd elements
   65: are values e.g. a:b:c:d creates a hash like
   66:   a => b, c =>d
   67: 
   68: =cut
   69: 
   70: sub make_into_hash {
   71:     my $values = shift;
   72:     my %tmp = map { &unescape($_); } split(':',$values);
   73:     return \%tmp;
   74: }
   75: 
   76: 
   77: { # Begin scope of table identifiers
   78: 
   79: my $current_course ='';
   80: my $symb_table;
   81: my $part_table;
   82: my $student_table;
   83: my $groupnames_table;
   84: my $students_groups_table;
   85: my $performance_table;
   86: my $parameters_table;
   87: my $fulldump_response_table;
   88: my $fulldump_part_table;
   89: my $fulldump_timestamp_table;
   90: my $weight_table;
   91: 
   92: my @Tables;
   93: 
   94: 
   95: 
   96: sub init_dbs {
   97:     my ($courseid,$drop) = @_;
   98:     &setup_table_names($courseid);
   99:     #
  100:     # Drop any of the existing tables
  101:     if ($drop) {
  102:         foreach my $table (@Tables) {
  103:             &Apache::lonmysql::drop_table($table);
  104:         }
  105:     }
  106:     #
  107:     # Note - changes to this table must be reflected in the code that 
  108:     # stores the data (calls &Apache::lonmysql::store_row with this table
  109:     # id
  110:     my $symb_table_def = {
  111:         id => $symb_table,
  112:         permanent => 'no',
  113:         columns => [{ name => 'symb_id',
  114:                       type => 'MEDIUMINT UNSIGNED',
  115:                       restrictions => 'NOT NULL',
  116:                       auto_inc     => 'yes', },
  117:                     { name => 'symb',
  118:                       type => 'MEDIUMTEXT',
  119:                       restrictions => 'NOT NULL'},
  120:                     ],
  121:         'PRIMARY KEY' => ['symb_id'],
  122:     };
  123:     #
  124:     my $part_table_def = {
  125:         id => $part_table,
  126:         permanent => 'no',
  127:         columns => [{ name => 'part_id',
  128:                       type => 'MEDIUMINT UNSIGNED',
  129:                       restrictions => 'NOT NULL',
  130:                       auto_inc     => 'yes', },
  131:                     { name => 'part',
  132:                       type => 'VARCHAR(100) BINARY',
  133:                       restrictions => 'NOT NULL'},
  134:                     ],
  135:         'PRIMARY KEY' => ['part (100)'],
  136:         'KEY' => [{ columns => ['part_id']},],
  137:     };
  138:     #
  139:     my $student_table_def = {
  140:         id => $student_table,
  141:         permanent => 'no',
  142:         columns => [{ name => 'student_id',
  143:                       type => 'MEDIUMINT UNSIGNED',
  144:                       restrictions => 'NOT NULL',
  145:                       auto_inc     => 'yes', },
  146:                     { name => 'student',
  147:                       type => 'VARCHAR(100) BINARY',
  148:                       restrictions => 'NOT NULL UNIQUE'},
  149:                     { name => 'section',
  150:                       type => 'VARCHAR(100) BINARY',
  151:                       restrictions => 'NOT NULL'},
  152:                     { name => 'start',
  153:                       type => 'INT',
  154:                       restrictions => 'NOT NULL'},
  155:                     { name => 'end',
  156:                       type => 'INT',
  157:                       restrictions => 'NOT NULL'},
  158:                     { name => 'classification',
  159:                       type => 'VARCHAR(100) BINARY', },
  160:                     { name => 'updatetime',
  161:                       type => 'INT UNSIGNED'},
  162:                     { name => 'fullupdatetime',
  163:                       type => 'INT UNSIGNED'},
  164:                     ],
  165:         'PRIMARY KEY' => ['student_id'],
  166:         'KEY' => [{ columns => ['student (100)',
  167:                                 'section (100)',
  168:                                 'start',
  169: 				'end']},],
  170:     };
  171:     #
  172:     my $groupnames_table_def = {
  173:         id => $groupnames_table,
  174:         permanent => 'no',
  175:         columns => [{ name => 'group_id',
  176:                       type => 'MEDIUMINT UNSIGNED',
  177:                       restrictions => 'NOT NULL',
  178:                       auto_inc => 'yes', },
  179:                     { name => 'groupname',
  180:                       type => 'VARCHAR(100) BINARY',
  181:                       restrictions => 'NOT NULL UNIQUE'},
  182:                    ],
  183:         'PRIMARY KEY' => ['group_id'],
  184:         'KEY' => [{ columns => ['groupname (100)',]},],
  185:     };
  186:     #
  187:     my $students_groups_table_def = {
  188:         id => $students_groups_table,
  189:         permanent => 'no',
  190:         columns => [{ name => 'student_id',
  191:                       type => 'MEDIUMINT UNSIGNED',
  192:                       restrictions => 'NOT NULL', },
  193:                     { name => 'group_id',
  194:                       type => 'MEDIUMINT UNSIGNED',
  195:                       restrictions => 'NOT NULL', },
  196:                    ],
  197:         'PRIMARY KEY' => ['student_id','group_id'],
  198:         'KEY' => [{ columns => ['student_id'] },
  199:                   { columns => ['group_id'] },],
  200:     };
  201:     #
  202:     my $performance_table_def = {
  203:         id => $performance_table,
  204:         permanent => 'no',
  205:         columns => [{ name => 'symb_id',
  206:                       type => 'MEDIUMINT UNSIGNED',
  207:                       restrictions => 'NOT NULL'  },
  208:                     { name => 'student_id',
  209:                       type => 'MEDIUMINT UNSIGNED',
  210:                       restrictions => 'NOT NULL'  },
  211:                     { name => 'part_id',
  212:                       type => 'MEDIUMINT UNSIGNED',
  213:                       restrictions => 'NOT NULL' },
  214:                     { name => 'part',
  215:                       type => 'VARCHAR(100) BINARY',
  216:                       restrictions => 'NOT NULL'},                    
  217:                     { name => 'solved',
  218:                       type => 'TINYTEXT' },
  219:                     { name => 'tries',
  220:                       type => 'SMALLINT UNSIGNED' },
  221:                     { name => 'awarded',
  222:                       type => 'REAL' },
  223:                     { name => 'award',
  224:                       type => 'TINYTEXT' },
  225:                     { name => 'awarddetail',
  226:                       type => 'TINYTEXT' },
  227:                     { name => 'timestamp',
  228:                       type => 'INT UNSIGNED'},
  229:                     ],
  230:         'PRIMARY KEY' => ['symb_id','student_id','part_id'],
  231:         'KEY' => [{ columns=>['student_id'] },
  232:                   { columns=>['symb_id'] },],
  233:     };
  234:     #
  235:     my $fulldump_part_table_def = {
  236:         id => $fulldump_part_table,
  237:         permanent => 'no',
  238:         columns => [
  239:                     { name => 'symb_id',
  240:                       type => 'MEDIUMINT UNSIGNED',
  241:                       restrictions => 'NOT NULL'  },
  242:                     { name => 'part_id',
  243:                       type => 'MEDIUMINT UNSIGNED',
  244:                       restrictions => 'NOT NULL' },
  245:                     { name => 'student_id',
  246:                       type => 'MEDIUMINT UNSIGNED',
  247:                       restrictions => 'NOT NULL'  },
  248:                     { name => 'transaction',
  249:                       type => 'MEDIUMINT UNSIGNED',
  250:                       restrictions => 'NOT NULL' },
  251:                     { name => 'tries',
  252:                       type => 'SMALLINT UNSIGNED',
  253:                       restrictions => 'NOT NULL' },
  254:                     { name => 'award',
  255:                       type => 'TINYTEXT' },
  256:                     { name => 'awarded',
  257:                       type => 'REAL' },
  258:                     { name => 'previous',
  259:                       type => 'SMALLINT UNSIGNED' },
  260: #                    { name => 'regrader',
  261: #                      type => 'TINYTEXT' },
  262: #                    { name => 'afterduedate',
  263: #                      type => 'TINYTEXT' },
  264:                     ],
  265:         'PRIMARY KEY' => ['symb_id','part_id','student_id','transaction'],
  266:         'KEY' => [
  267:                   { columns=>['symb_id'] },
  268:                   { columns=>['part_id'] },
  269:                   { columns=>['student_id'] },
  270:                   ],
  271:     };
  272:     #
  273:     my $fulldump_response_table_def = {
  274:         id => $fulldump_response_table,
  275:         permanent => 'no',
  276:         columns => [
  277:                     { name => 'symb_id',
  278:                       type => 'MEDIUMINT UNSIGNED',
  279:                       restrictions => 'NOT NULL'  },
  280:                     { name => 'part_id',
  281:                       type => 'MEDIUMINT UNSIGNED',
  282:                       restrictions => 'NOT NULL' },
  283:                     { name => 'response_id',
  284:                       type => 'MEDIUMINT UNSIGNED',
  285:                       restrictions => 'NOT NULL'  },
  286:                     { name => 'student_id',
  287:                       type => 'MEDIUMINT UNSIGNED',
  288:                       restrictions => 'NOT NULL'  },
  289:                     { name => 'transaction',
  290:                       type => 'MEDIUMINT UNSIGNED',
  291:                       restrictions => 'NOT NULL' },
  292:                     { name => 'awarddetail',
  293:                       type => 'TINYTEXT' },
  294: #                    { name => 'message',
  295: #                      type => 'CHAR BINARY'},
  296:                     { name => 'response_specific',
  297:                       type => 'TINYTEXT' },
  298:                     { name => 'response_specific_value',
  299:                       type => 'TINYTEXT' },
  300:                     { name => 'response_specific_2',
  301:                       type => 'TINYTEXT' },
  302:                     { name => 'response_specific_value_2',
  303:                       type => 'TINYTEXT' },
  304:                     { name => 'submission',
  305:                       type => 'TEXT'},
  306:                     ],
  307:             'PRIMARY KEY' => ['symb_id','part_id','response_id','student_id',
  308:                               'transaction'],
  309:             'KEY' => [
  310:                       { columns=>['symb_id'] },
  311:                       { columns=>['part_id','response_id'] },
  312:                       { columns=>['student_id'] },
  313:                       ],
  314:     };
  315:     my $fulldump_timestamp_table_def = {
  316:         id => $fulldump_timestamp_table,
  317:         permanent => 'no',
  318:         columns => [
  319:                     { name => 'symb_id',
  320:                       type => 'MEDIUMINT UNSIGNED',
  321:                       restrictions => 'NOT NULL'  },
  322:                     { name => 'student_id',
  323:                       type => 'MEDIUMINT UNSIGNED',
  324:                       restrictions => 'NOT NULL'  },
  325:                     { name => 'transaction',
  326:                       type => 'MEDIUMINT UNSIGNED',
  327:                       restrictions => 'NOT NULL' },
  328:                     { name => 'timestamp',
  329:                       type => 'INT UNSIGNED'},
  330:                     ],
  331:         'PRIMARY KEY' => ['symb_id','student_id','transaction'],
  332:         'KEY' => [
  333:                   { columns=>['symb_id'] },
  334:                   { columns=>['student_id'] },
  335:                   { columns=>['transaction'] },
  336:                   ],
  337:     };
  338:     #
  339:     my $parameters_table_def = {
  340:         id => $parameters_table,
  341:         permanent => 'no',
  342:         columns => [{ name => 'symb_id',
  343:                       type => 'MEDIUMINT UNSIGNED',
  344:                       restrictions => 'NOT NULL'  },
  345:                     { name => 'student_id',
  346:                       type => 'MEDIUMINT UNSIGNED',
  347:                       restrictions => 'NOT NULL'  },
  348:                     { name => 'parameter',
  349:                       type => 'TINYTEXT',
  350:                       restrictions => 'NOT NULL'  },
  351:                     { name => 'value',
  352:                       type => 'MEDIUMTEXT' },
  353:                     ],
  354:         'PRIMARY KEY' => ['symb_id','student_id','parameter (255)'],
  355:     };
  356:     #
  357:     my $weight_table_def = {
  358:         id => $weight_table,
  359:         permanent => 'no',
  360:         columns => [{ name => 'symb_id',
  361:                       type => 'MEDIUMINT UNSIGNED',
  362:                       restrictions => 'NOT NULL'  },
  363:                     { name => 'part_id',
  364:                       type => 'MEDIUMINT UNSIGNED',
  365:                       restrictions => 'NOT NULL'  },
  366:                     { name => 'weight',
  367:                       type => 'REAL',
  368:                       restrictions => 'NOT NULL'  },
  369:                     ],
  370:         'PRIMARY KEY' => ['symb_id','part_id'],
  371:     };
  372:     #
  373:     # Create the tables
  374:     my $tableid;
  375:     $tableid = &Apache::lonmysql::create_table($symb_table_def);
  376:     if (! defined($tableid)) {
  377:         &Apache::lonnet::logthis("error creating symb_table: ".
  378:                                  &Apache::lonmysql::get_error());
  379:         return 1;
  380:     }
  381:     #
  382:     $tableid = &Apache::lonmysql::create_table($part_table_def);
  383:     if (! defined($tableid)) {
  384:         &Apache::lonnet::logthis("error creating part_table: ".
  385:                                  &Apache::lonmysql::get_error());
  386:         return 2;
  387:     }
  388:     #
  389:     $tableid = &Apache::lonmysql::create_table($student_table_def);
  390:     if (! defined($tableid)) {
  391:         &Apache::lonnet::logthis("error creating student_table: ".
  392:                                  &Apache::lonmysql::get_error());
  393:         return 3;
  394:     }
  395:     #
  396:     $tableid = &Apache::lonmysql::create_table($performance_table_def);
  397:     if (! defined($tableid)) {
  398:         &Apache::lonnet::logthis("error creating preformance_table: ".
  399:                                  &Apache::lonmysql::get_error());
  400:         return 5;
  401:     }
  402:     #
  403:     $tableid = &Apache::lonmysql::create_table($parameters_table_def);
  404:     if (! defined($tableid)) {
  405:         &Apache::lonnet::logthis("error creating parameters_table: ".
  406:                                  &Apache::lonmysql::get_error());
  407:         return 6;
  408:     }
  409:     #
  410:     $tableid = &Apache::lonmysql::create_table($fulldump_part_table_def);
  411:     if (! defined($tableid)) {
  412:         &Apache::lonnet::logthis("error creating fulldump_part_table: ".
  413:                                  &Apache::lonmysql::get_error());
  414:         return 7;
  415:     }
  416:     #
  417:     $tableid = &Apache::lonmysql::create_table($fulldump_response_table_def);
  418:     if (! defined($tableid)) {
  419:         &Apache::lonnet::logthis("error creating fulldump_response_table: ".
  420:                                  &Apache::lonmysql::get_error());
  421:         return 8;
  422:     }
  423:     $tableid = &Apache::lonmysql::create_table($fulldump_timestamp_table_def);
  424:     if (! defined($tableid)) {
  425:         &Apache::lonnet::logthis("error creating fulldump_timestamp_table: ".
  426:                                  &Apache::lonmysql::get_error());
  427:         return 9;
  428:     }
  429:     $tableid = &Apache::lonmysql::create_table($weight_table_def);
  430:     if (! defined($tableid)) {
  431:         &Apache::lonnet::logthis("error creating weight_table: ".
  432:                                  &Apache::lonmysql::get_error());
  433:         return 10;
  434:     }
  435:     $tableid = &Apache::lonmysql::create_table($groupnames_table_def);
  436:     if (! defined($tableid)) {
  437:         &Apache::lonnet::logthis("error creating groupnames_table: ".
  438:                                  &Apache::lonmysql::get_error());
  439:         return 11;
  440:     }
  441:     $tableid = &Apache::lonmysql::create_table($students_groups_table_def);
  442:     if (! defined($tableid)) {
  443:         &Apache::lonnet::logthis("error creating student_groups_table: ".
  444:                                  &Apache::lonmysql::get_error());
  445:         return 12;
  446:     }
  447:     return 0;
  448: }
  449: 
  450: =pod
  451: 
  452: =head2 delete_caches
  453: 
  454: Drops all of the tables in the local mysql cache associated with the
  455: specified course id.
  456: 
  457: TODO:  The drops should be pushed into lonmysql to further isolate 
  458: mysql code from other modules.
  459: 
  460: =cut
  461: sub delete_caches {
  462:     my $courseid = shift;
  463:     $courseid = $env{'request.course.id'} if (! defined($courseid));
  464:     #
  465:     &setup_table_names($courseid);
  466:     #
  467:     my $dbh = &Apache::lonmysql::get_dbh();
  468:     foreach my $table (@Tables) {
  469:         my $command = 'DROP TABLE '.$table.';';
  470:         $dbh->do($command);
  471:         if ($dbh->err) {
  472:             &Apache::lonnet::logthis($command.' resulted in error: '.$dbh->errstr);
  473:         }
  474:     }
  475:     return;
  476: }
  477: 
  478: 
  479: my $have_read_part_table = 0;
  480: my %ids_by_part;
  481: my %parts_by_id;
  482: 
  483: sub get_part_id {
  484:     my ($part) = @_;
  485:     $part = 0 if (! defined($part));
  486:     if (! $have_read_part_table) {
  487:         my @Result = &Apache::lonmysql::get_rows($part_table);
  488:         foreach (@Result) {
  489:             $ids_by_part{$_->[1]}=$_->[0];
  490:         }
  491:         $have_read_part_table = 1;
  492:     }
  493:     if (! exists($ids_by_part{$part})) {
  494:         &Apache::lonmysql::store_row($part_table,[undef,$part]);
  495:         undef(%ids_by_part);
  496:         my @Result = &Apache::lonmysql::get_rows($part_table);
  497:         foreach (@Result) {
  498:             $ids_by_part{$_->[1]}=$_->[0];
  499:         }
  500:     }
  501:     return $ids_by_part{$part} if (exists($ids_by_part{$part}));
  502:     return undef; # error
  503: }
  504: 
  505: sub get_part {
  506:     my ($part_id) = @_;
  507:     if (! exists($parts_by_id{$part_id})  || 
  508:         ! defined($parts_by_id{$part_id}) ||
  509:         $parts_by_id{$part_id} eq '') {
  510:         my @Result = &Apache::lonmysql::get_rows($part_table);
  511:         foreach (@Result) {
  512:             $parts_by_id{$_->[0]}=$_->[1];
  513:         }
  514:     }
  515:     return $parts_by_id{$part_id} if(exists($parts_by_id{$part_id}));
  516:     return undef; # error
  517: }
  518: 
  519: 
  520: my $have_read_symb_table = 0;
  521: my %ids_by_symb;
  522: my %symbs_by_id;
  523: 
  524: sub get_symb_id {
  525:     my ($symb) = @_;
  526:     if (! $have_read_symb_table) {
  527:         my @Result = &Apache::lonmysql::get_rows($symb_table);
  528:         foreach (@Result) {
  529:             $ids_by_symb{$_->[1]}=$_->[0];
  530:         }
  531:         $have_read_symb_table = 1;
  532:     }
  533:     if (! exists($ids_by_symb{$symb})) {
  534:         &Apache::lonmysql::store_row($symb_table,[undef,$symb]);
  535:         undef(%ids_by_symb);
  536:         my @Result = &Apache::lonmysql::get_rows($symb_table);
  537:         foreach (@Result) {
  538:             $ids_by_symb{$_->[1]}=$_->[0];
  539:         }
  540:     }
  541:     return $ids_by_symb{$symb} if(exists( $ids_by_symb{$symb}));
  542:     return undef; # error
  543: }
  544: 
  545: sub get_symb {
  546:     my ($symb_id) = @_;
  547:     if (! exists($symbs_by_id{$symb_id})  || 
  548:         ! defined($symbs_by_id{$symb_id}) ||
  549:         $symbs_by_id{$symb_id} eq '') {
  550:         my @Result = &Apache::lonmysql::get_rows($symb_table);
  551:         foreach (@Result) {
  552:             $symbs_by_id{$_->[0]}=$_->[1];
  553:         }
  554:     }
  555:     return $symbs_by_id{$symb_id} if(exists( $symbs_by_id{$symb_id}));
  556:     return undef; # error
  557: }
  558: 
  559: my $have_read_student_table = 0;
  560: my %ids_by_student;
  561: my %students_by_id;
  562: 
  563: sub get_student_id {
  564:     my ($sname,$sdom) = @_;
  565:     my $student = $sname.':'.$sdom;
  566:     if (! $have_read_student_table) {
  567:         my @Result = &Apache::lonmysql::get_rows($student_table);
  568:         foreach (@Result) {
  569:             $ids_by_student{$_->[1]}=$_->[0];
  570:         }
  571:         $have_read_student_table = 1;
  572:     }
  573:     if (! exists($ids_by_student{$student})) {
  574:         &populate_student_table();
  575:         undef(%ids_by_student);
  576:         undef(%students_by_id);
  577:         my @Result = &Apache::lonmysql::get_rows($student_table);
  578:         foreach (@Result) {
  579:             $ids_by_student{$_->[1]}=$_->[0];
  580:         }
  581:     }
  582:     return $ids_by_student{$student} if(exists( $ids_by_student{$student}));
  583:     return undef; # error
  584: }
  585: 
  586: sub get_student {
  587:     my ($student_id) = @_;
  588:     if (! exists($students_by_id{$student_id})  || 
  589:         ! defined($students_by_id{$student_id}) ||
  590:         $students_by_id{$student_id} eq '') {
  591:         my @Result = &Apache::lonmysql::get_rows($student_table);
  592:         foreach (@Result) {
  593:             $students_by_id{$_->[0]}=$_->[1];
  594:         }
  595:     }
  596:     return $students_by_id{$student_id} if(exists($students_by_id{$student_id}));
  597:     return undef; # error
  598: }
  599: 
  600: sub populate_student_table {
  601:     my ($courseid) = @_;
  602:     if (! defined($courseid)) {
  603:         $courseid = $env{'request.course.id'};
  604:     }
  605:     #
  606:     &setup_table_names($courseid);
  607:     &init_dbs($courseid,0);
  608:     my $dbh = &Apache::lonmysql::get_dbh();
  609:     my $request = 'INSERT IGNORE INTO '.$student_table.
  610:         "(student,section,start,end) VALUES ";
  611:     my $cdom = $env{'course.'.$courseid.'.domain'};
  612:     my $cnum = $env{'course.'.$courseid.'.num'};
  613:     my $classlist = &get_classlist($cdom,$cnum);
  614:     my $student_count=0;
  615:     while (my ($student,$data) = each %$classlist) {
  616:         my ($section,$start,$end) = ($data->[&CL_SECTION()],
  617: 				     $data->[&CL_START()],
  618: 				     $data->[&CL_END()]);
  619:         if ($section eq '' || $section =~ /^\s*$/) {
  620:             $section = 'none';
  621:         }
  622: 	if (!defined($start)) { $start = 0; }
  623: 	if (!defined($end))   { $end   = 0; }
  624:         $request .= "('".$student."','".$section."','".$start."','".$end."'),";
  625:         $student_count++;
  626:     }
  627:     return if ($student_count == 0);
  628:     chop($request);
  629:     $dbh->do($request);
  630:     if ($dbh->err()) {
  631:         &Apache::lonnet::logthis("error ".$dbh->errstr().
  632:                                  " occurred executing \n".
  633:                                  $request);
  634:     }
  635:     return;
  636: }
  637: 
  638: my $have_read_groupnames_table = 0;
  639: my %ids_by_groupname;
  640: 
  641: sub get_group_id {
  642:     my ($groupname) = @_;
  643:     if (! $have_read_groupnames_table) {
  644:         my @Result = &Apache::lonmysql::get_rows($groupnames_table);
  645:         foreach (@Result) {
  646:             $ids_by_groupname{$_->[1]}=$_->[0];
  647:         }
  648:         $have_read_groupnames_table = 1;
  649:     }
  650:     if (! exists($ids_by_groupname{$groupname})) {
  651:         &populate_groupnames_table();
  652:         undef(%ids_by_groupname);
  653:         my @Result = &Apache::lonmysql::get_rows($groupnames_table);
  654:         foreach (@Result) {
  655:             $ids_by_groupname{$_->[1]}=$_->[0];
  656:         }
  657:     }
  658:     if (exists($ids_by_groupname{$groupname})) {
  659:         return $ids_by_groupname{$groupname};
  660:     }
  661:     return undef; # error
  662: }
  663: 
  664: sub populate_groupnames_table {
  665:     my ($courseid) = @_;
  666:     if (! defined($courseid)) {
  667:         $courseid = $env{'request.course.id'};
  668:     }
  669:     &setup_table_names($courseid);
  670:     &init_dbs($courseid,0);
  671:     my $dbh = &Apache::lonmysql::get_dbh();
  672:     my $cdom = $env{'course.'.$courseid.'.domain'};
  673:     my $cnum = $env{'course.'.$courseid.'.num'};
  674:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
  675:     return if (!%curr_groups);
  676:     my $request = 'INSERT IGNORE INTO '.$groupnames_table.
  677:                   '(groupname) VALUES ';
  678:     foreach my $groupname (sort(keys(%curr_groups)),'none') {
  679:         $request .= "('".$groupname."'),";
  680:     }
  681:     chop($request);
  682:     $dbh->do($request);
  683:     if ($dbh->err()) {
  684:         &Apache::lonnet::logthis("error ".$dbh->errstr().
  685:                                  " occurred executing \n".
  686:                                  $request);
  687:     }
  688:     return;
  689: }
  690: 
  691: my $have_read_studentsgroups_table = 0;
  692: my %groupids_by_studentid;
  693: 
  694: sub get_students_groupids {
  695:     my ($student_id) = @_;
  696:     if (! $have_read_studentsgroups_table) {
  697:         my @Result = &Apache::lonmysql::get_rows($students_groups_table);
  698:         foreach (@Result) {
  699:             push(@{$groupids_by_studentid{$_->[0]}},$_->[1]);
  700:         }
  701:         $have_read_studentsgroups_table = 1;
  702:     }
  703:     if (! exists($groupids_by_studentid{$student_id})) {
  704:         &populate_students_groups_table();
  705:         undef(%groupids_by_studentid);
  706:         my @Result = &Apache::lonmysql::get_rows($students_groups_table);
  707:         foreach (@Result) {
  708:             push(@{$groupids_by_studentid{$_->[0]}},$_->[1]);
  709:         }
  710:     }
  711:     if (exists($groupids_by_studentid{$student_id})) {
  712:         if (ref($groupids_by_studentid{$student_id}) eq 'ARRAY') {
  713:             return @{$groupids_by_studentid{$student_id}};
  714:         }
  715:     }
  716:     return undef; # error
  717: }
  718: 
  719: 
  720: sub populate_students_groups_table {
  721:     my ($courseid) = @_;
  722:     if (! defined($courseid)) {
  723:         $courseid = $env{'request.course.id'};
  724:     }
  725:     #
  726:     &setup_table_names($courseid);
  727:     &init_dbs($courseid,0);
  728:     my $dbh = &Apache::lonmysql::get_dbh();
  729:     my $request = 'INSERT IGNORE INTO '.$students_groups_table.
  730:         "(student_id,group_id) VALUES ";
  731:     my $cdom = $env{'course.'.$courseid.'.domain'};
  732:     my $cnum = $env{'course.'.$courseid.'.num'};
  733:     my ($classlist,$keylist) = &get_classlist($cdom,$cnum);
  734:     my ($classgroups,$studentgroups) = &get_group_memberships($classlist,
  735:                                                               $keylist,
  736:                                                               $cdom,$cnum);
  737:     my $record_count = 0;
  738:     foreach my $student (sort(keys(%{$classgroups}))) {
  739:         my $student_id = &get_student_id(split(':',$student));
  740:         my @studentsgroups = &get_students_groups($student,'Active',$classgroups);
  741:         if (@studentsgroups < 1) {
  742:             @studentsgroups = ('none');
  743:         }
  744:         foreach my $groupname (@studentsgroups) {
  745:             my $group_id = &get_group_id($groupname);
  746:             $request .= "('".$student_id."','".$group_id."'),";
  747:             $record_count++;
  748:         }
  749:     }
  750:     return if ($record_count == 0);
  751:     chop($request);
  752:     $dbh->do($request);
  753:     if ($dbh->err()) {
  754:         &Apache::lonnet::logthis("error ".$dbh->errstr().
  755:                                  " occurred executing \n".
  756:                                  $request);
  757:     }
  758:     return;
  759: }
  760: 
  761: sub clear_internal_caches {
  762:     $have_read_part_table = 0;
  763:     undef(%ids_by_part);
  764:     undef(%parts_by_id);
  765:     $have_read_symb_table = 0;
  766:     undef(%ids_by_symb);
  767:     undef(%symbs_by_id);
  768:     $have_read_student_table = 0;
  769:     undef(%ids_by_student);
  770:     undef(%students_by_id);
  771:     $have_read_groupnames_table = 0;
  772:     undef(%ids_by_groupname);
  773: }
  774: 
  775: sub symb_is_for_task {
  776:     my ($symb) = @_;
  777:     return ($symb =~ /\.task$/);
  778: }
  779: 
  780: 
  781: sub update_full_student_data {
  782:     my ($sname,$sdom,$courseid) = @_;
  783:     #
  784:     # Set up database names
  785:     &setup_table_names($courseid);
  786:     #
  787:     my $student_id = &get_student_id($sname,$sdom);
  788:     my $student = $sname.':'.$sdom;
  789:     #
  790:     my $returnstatus = 'okay';
  791:     #
  792:     # Download students data
  793:     my $time_of_retrieval = time;
  794:     my @tmp = &Apache::lonnet::dumpstore($courseid,$sdom,$sname);
  795:     if (@tmp && $tmp[0] =~ /^error/) {
  796:         $returnstatus = 'error retrieving full student data';
  797:         return $returnstatus;
  798:     } elsif (! @tmp) {
  799:         $returnstatus = 'okay: no student data';
  800:         return $returnstatus;
  801:     }
  802:     my %studentdata = @tmp;
  803:     #
  804:     # Get database handle and clean out the tables 
  805:     my $dbh = &Apache::lonmysql::get_dbh();
  806:     $dbh->do('DELETE FROM '.$fulldump_response_table.' WHERE student_id='.
  807:              $student_id);
  808:     $dbh->do('DELETE FROM '.$fulldump_part_table.' WHERE student_id='.
  809:              $student_id);
  810:     $dbh->do('DELETE FROM '.$fulldump_timestamp_table.' WHERE student_id='.
  811:              $student_id);
  812:     #
  813:     # Parse and store the data into a form we can handle
  814:     my $partdata;
  815:     my $respdata;
  816:     while (my ($key,$value) = each(%studentdata)) {
  817:         next if ($key =~ /^(\d+):(resource$|subnum$|keys:)/);
  818:         my ($transaction,$symb,$parameter) = split(':',$key);
  819: 	$symb = &unescape($symb);
  820: 	$parameter = &unescape($parameter);
  821:         my $symb_id = &get_symb_id($symb);
  822:         if ($parameter eq 'timestamp') {
  823:             # We can deal with 'timestamp' right away
  824:             my @timestamp_storage = ($symb_id,$student_id,
  825:                                      $transaction,$value);
  826:             my $store_command = 'INSERT IGNORE INTO '.$fulldump_timestamp_table.
  827:                 " VALUES ('".join("','",@timestamp_storage)."');";
  828:             $dbh->do($store_command);
  829:             if ($dbh->err()) {
  830:                 &Apache::lonnet::logthis('unable to execute '.$store_command);
  831:                 &Apache::lonnet::logthis($dbh->errstr());
  832:             }
  833:             next;
  834:         } elsif ($parameter eq 'version') {
  835:             next;
  836: 	} elsif (&symb_is_for_task($symb)) {
  837: 	    next if ($parameter !~ /^resource\.(.*)\.(award|
  838: 						      awarded|
  839: 						      solved|
  840: 						      submission|
  841: 						      portfiles|
  842: 						      status|
  843: 						      version|
  844: 						      regrader)\s*$/x);
  845: 	    my ($version_and_part_id, $field) = ($1,$2);
  846: 
  847: 	    next if ($version_and_part_id !~ /\./ 
  848: 		     && $field ne 'regrader' && $field ne 'version');
  849: 
  850: 	    my ($version, $part, $instance) = 
  851: 		split(/\./,$version_and_part_id);
  852: 
  853: 	    #skip and instance dimension or criteria specific data
  854: 	    next if (defined($instance) 
  855: 		     && $instance ne $field
  856: 		     && $instance ne 'bridgetask');
  857: 	    
  858: 	    if (!defined($part)) {
  859: 		$part = $version;
  860: 	    }
  861: 	    my $resp_id = &get_part_id('0');
  862: 	    my $part_id = &get_part_id($part);
  863: 	    
  864: 	    if ($field eq 'version') {
  865: 		# for tasks each version is an attempt at it thus
  866: 		#     version -> tries
  867: 		$partdata->{$symb_id}{$part_id}{$transaction}{'tries'}=
  868: 		    $value;
  869: 		# at new version time the record gets reset thus adding a
  870: 		# virtual response awarddetail of 'new_version'
  871: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific'}='status';
  872: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific_value'}='new_version';
  873: 
  874: 	    } elsif ($field eq 'award' || $field eq 'awarded' 
  875: 		     || $field eq 'solved') {
  876: 		$partdata->{$symb_id}{$part_id}{$transaction}{$field}=
  877: 		    $value;
  878: 	    } elsif ($field eq 'portfiles') {
  879: 		# tasks only accepts portfolio submissions
  880: 		$value = $dbh->quote($value);
  881: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'submission'}=$value;
  882: 	    } elsif ($field eq 'status') {
  883: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific'}=$field;
  884: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific_value'}=$value;
  885: 	    } elsif ($field eq 'regrader') {
  886: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific_2'}=$field;
  887: 		$respdata->{$symb_id}{$part_id}{$resp_id}{$transaction}{'response_specific_value_2'}=$value;
  888: 	    }
  889: 	} elsif ($parameter =~ /^resource\.(.*)\.(tries|
  890:                                                   award|
  891:                                                   awarded|
  892:                                                   previous|
  893:                                                   solved|
  894:                                                   awarddetail|
  895:                                                   submission|
  896:                                                   submissiongrading|
  897:                                                   molecule)\s*$/x){
  898:             # we do not have enough information to store an 
  899:             # entire row, so we save it up until later.
  900:             my ($part_and_resp_id,$field) = ($1,$2);
  901:             my ($part,$part_id,$resp,$resp_id);
  902:             if ($part_and_resp_id =~ /\./) {
  903:                 ($part,$resp) = split(/\./,$part_and_resp_id);
  904:                 $part_id = &get_part_id($part);
  905:                 $resp_id = &get_part_id($resp);
  906:             } else {
  907:                 $part_id = &get_part_id($part_and_resp_id);
  908:             }
  909:             # Deal with part specific data
  910:             if ($field =~ /^(tries|award|awarded|previous)$/) {
  911:                 $partdata->{$symb_id}->{$part_id}->{$transaction}->{$field}=$value;
  912:             }
  913:             # deal with response specific data
  914:             if (defined($resp_id) &&
  915:                 $field =~ /^(awarddetail|
  916:                              submission|
  917:                              submissiongrading|
  918:                              molecule)$/x) {
  919:                 if ($field eq 'submission') {
  920:                     # We have to be careful with user supplied input.
  921:                     # most of the time we are okay because it is escaped.
  922:                     # However, there is one wrinkle: submissions which end in
  923:                     # and odd number of '\' cause insert errors to occur.  
  924:                     # Best trap this somehow...
  925:                     $value = $dbh->quote($value);
  926:                 }
  927:                 if ($field eq 'submissiongrading' || 
  928:                     $field eq 'molecule') {
  929:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific'}=$field;
  930:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific_value'}=$value;
  931:                 } else {
  932:                     $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{$field}=$value;
  933:                 }
  934:             }
  935:         }
  936:     }
  937:     ##
  938:     ## Store the part data
  939:     my $store_command = 'INSERT IGNORE INTO '.$fulldump_part_table.
  940:         ' VALUES '."\n";
  941:     my $store_rows = 0;
  942:     while (my ($symb_id,$hash1) = each (%$partdata)) {
  943:         while (my ($part_id,$hash2) = each (%$hash1)) {
  944:             while (my ($transaction,$data) = each (%$hash2)) {
  945:                 $store_command .= "('".join("','",$symb_id,$part_id,
  946:                                             $student_id,
  947:                                             $transaction,
  948:                                             $data->{'tries'},
  949:                                             $data->{'award'},
  950:                                             $data->{'awarded'},
  951:                                             $data->{'previous'})."'),";
  952:                 $store_rows++;
  953:             }
  954:         }
  955:     }
  956:     if ($store_rows) {
  957:         chop($store_command);
  958:         $dbh->do($store_command);
  959:         if ($dbh->err) {
  960:             $returnstatus = 'error saving part data';
  961:             &Apache::lonnet::logthis('insert error '.$dbh->errstr());
  962:             &Apache::lonnet::logthis("While attempting\n".$store_command);
  963:         }
  964:     }
  965:     ##
  966:     ## Store the response data
  967:     $store_command = 'INSERT IGNORE INTO '.$fulldump_response_table.
  968:         ' VALUES '."\n";
  969:     $store_rows = 0;
  970:     while (my ($symb_id,$hash1) = each (%$respdata)) {
  971:         while (my ($part_id,$hash2) = each (%$hash1)) {
  972:             while (my ($resp_id,$hash3) = each (%$hash2)) {
  973:                 while (my ($transaction,$data) = each (%$hash3)) {
  974:                     my $submission = $data->{'submission'};
  975:                     # We have to be careful with user supplied input.
  976:                     # most of the time we are okay because it is escaped.
  977:                     # However, there is one wrinkle: submissions which end in
  978:                     # and odd number of '\' cause insert errors to occur.  
  979:                     # Best trap this somehow...
  980:                     $submission = $dbh->quote($submission);
  981:                     $store_command .= "('".
  982:                         join("','",$symb_id,$part_id,
  983:                              $resp_id,$student_id,
  984:                              $transaction,
  985:                              $data->{'awarddetail'},
  986:                              $data->{'response_specific'},
  987:                              $data->{'response_specific_value'},
  988:                              $data->{'response_specific_2'},
  989:                              $data->{'response_specific_value_2'}).
  990:                              "',".$submission."),";
  991:                     $store_rows++;
  992:                 }
  993:             }
  994:         }
  995:     }
  996:     if ($store_rows) {
  997:         chop($store_command);
  998:         $dbh->do($store_command);
  999:         if ($dbh->err) {
 1000:             $returnstatus = 'error saving response data';
 1001:             &Apache::lonnet::logthis('insert error '.$dbh->errstr());
 1002:             &Apache::lonnet::logthis("While attempting\n".$store_command);
 1003:         }
 1004:     }
 1005:     ##
 1006:     ## Update the students "current" data in the performance 
 1007:     ## and parameters tables.
 1008:     my ($status,undef) = &store_student_data
 1009:         ($sname,$sdom,$courseid,
 1010:          &Apache::lonnet::convert_dump_to_currentdump(\%studentdata));
 1011:     if ($returnstatus eq 'okay' && $status ne 'okay') {
 1012:         $returnstatus = 'error saving current data:'.$status;
 1013:     } elsif ($status ne 'okay') {
 1014:         $returnstatus .= ' error saving current data:'.$status;
 1015:     }        
 1016:     ##
 1017:     ## Update the students time......
 1018:     if ($returnstatus eq 'okay') {
 1019:         &store_updatetime($student_id,$time_of_retrieval,$time_of_retrieval);
 1020:         if ($dbh->err) {
 1021:             if ($returnstatus eq 'okay') {
 1022:                 $returnstatus = 'error updating student time';
 1023:             } else {
 1024:                 $returnstatus = 'error updating student time';
 1025:             }
 1026:         }
 1027:     }
 1028:     return $returnstatus;
 1029: }
 1030: 
 1031: 
 1032: sub update_student_data {
 1033:     my ($sname,$sdom,$courseid) = @_;
 1034:     #
 1035:     # Set up database names
 1036:     &setup_table_names($courseid);
 1037:     #
 1038:     my $student_id = &get_student_id($sname,$sdom);
 1039:     my $student = $sname.':'.$sdom;
 1040:     #
 1041:     my $returnstatus = 'okay';
 1042:     #
 1043:     # Download students data
 1044:     my $time_of_retrieval = time;
 1045:     my %student_data = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
 1046:     if (&Apache::lonnet::error(%student_data)) {
 1047:         &Apache::lonnet::logthis('error getting data for '.
 1048:                                  $sname.':'.$sdom.' in course '.$courseid.
 1049:                                  ':'.(%student_data)[0]);
 1050:         $returnstatus =(%student_data)[0] ;
 1051:         return ($returnstatus,undef);
 1052:     }
 1053:     if (scalar(keys(%student_data)) < 1) {
 1054:         return ('no data',undef);
 1055:     }
 1056:     my @Results = &store_student_data($sname,$sdom,$courseid,\%student_data);
 1057:     #
 1058:     # Set the students update time
 1059:     if ($Results[0] eq 'okay') {
 1060:         &store_updatetime($student_id,$time_of_retrieval);
 1061:     }
 1062:     #
 1063:     return @Results;
 1064: }
 1065: 
 1066: sub store_updatetime {
 1067:     my ($student_id,$updatetime,$fullupdatetime)=@_;
 1068:     my $values = '';
 1069:     if (defined($updatetime)) {
 1070:         $values = 'updatetime='.$updatetime.' ';
 1071:     }
 1072:     if (defined($fullupdatetime)) {
 1073:         if ($values ne '') {
 1074:             $values .= ',';
 1075:         }
 1076:         $values .= 'fullupdatetime='.$fullupdatetime.' ';
 1077:     }
 1078:     return if ($values eq '');
 1079:     my $dbh = &Apache::lonmysql::get_dbh();
 1080:     my $request = 'UPDATE '.$student_table.' SET '.$values.
 1081:         ' WHERE student_id='.$student_id.' LIMIT 1';
 1082:     $dbh->do($request);
 1083: }
 1084: 
 1085: sub store_student_data {
 1086:     my ($sname,$sdom,$courseid,$student_data) = @_;
 1087:     #
 1088:     my $student_id = &get_student_id($sname,$sdom);
 1089:     my $student = $sname.':'.$sdom;
 1090:     #
 1091:     my $returnstatus = 'okay';
 1092:     #
 1093:     # Remove all of the students data from the table
 1094:     my $dbh = &Apache::lonmysql::get_dbh();
 1095:     $dbh->do('DELETE FROM '.$performance_table.' WHERE student_id='.
 1096:              $student_id);
 1097:     $dbh->do('DELETE FROM '.$parameters_table.' WHERE student_id='.
 1098:              $student_id);
 1099:     #
 1100:     # Store away the data
 1101:     #
 1102:     my $starttime = Time::HiRes::time;
 1103:     my $elapsed = 0;
 1104:     my $rows_stored;
 1105:     my $store_parameters_command  = 'INSERT IGNORE INTO '.$parameters_table.
 1106:         ' VALUES '."\n";
 1107:     my $num_parameters = 0;
 1108:     my $store_performance_command = 'INSERT IGNORE INTO '.$performance_table.
 1109:         ' VALUES '."\n";
 1110:     return ('error',undef) if (! defined($dbh));
 1111:     while (my ($current_symb,$param_hash) = each(%{$student_data})) {
 1112:         #
 1113:         # make sure the symb is set up properly
 1114:         my $symb_id = &get_symb_id($current_symb);
 1115:         #
 1116:         # Parameters
 1117:         while (my ($parameter,$value) = each(%$param_hash)) {
 1118:             if ($parameter !~ /(timestamp|resource\.(.*)\.(solved|tries|awarded|award|awarddetail|previous))/) {
 1119:                 my $sql_parameter = "('".join("','",
 1120:                                               $symb_id,$student_id,
 1121:                                               $parameter)."',".
 1122:                                                   $dbh->quote($value)."),\n";
 1123:                 $num_parameters ++;
 1124:                 if ($sql_parameter !~ /''/) {
 1125:                     $store_parameters_command .= $sql_parameter;
 1126:                     #$rows_stored++;
 1127:                 }
 1128:             }
 1129:         }
 1130:         # Performance
 1131:         my %stored;
 1132:         while (my ($parameter,$value) = each(%$param_hash)) {
 1133:             next if ($parameter !~ /^resource\.(.*)\.(solved|awarded)$/);
 1134:             my $part  = $1;
 1135: 	    my $which = $2;
 1136: 	    next if ($part =~ /\./);
 1137:             next if (exists($stored{$part}));
 1138:             $stored{$part}++;
 1139:             #
 1140:             my $part_id = &get_part_id($part);
 1141:             next if (!defined($part_id));
 1142: 	    
 1143:             my ($solved,$awarded);
 1144: 	    if ($which eq 'solved') {
 1145: 		$solved  = $value;
 1146: 		$awarded = $param_hash->{'resource.'.$part.'.awarded'};
 1147: 	    } else {
 1148: 		$solved  = $param_hash->{'resource.'.$part.'.solved'};
 1149: 		$awarded = $value;
 1150: 	    }
 1151:             my $award   = $param_hash->{'resource.'.$part.'.award'};
 1152:             my $awarddetail = $param_hash->{'resource.'.$part.'.awarddetail'};
 1153:             my $timestamp = $param_hash->{'timestamp'};
 1154: 	    my $tries   = $param_hash->{'resource.'.$part.'.tries'};
 1155: 	    if (&symb_is_for_task($current_symb)) {
 1156: 		$tries   = $param_hash->{'resource.'.$part.'.version'};
 1157: 	    }
 1158:             #
 1159:             $solved      = '' if (! defined($solved));
 1160:             $tries       = '' if (! defined($tries));
 1161:             $awarded     = '' if (! defined($awarded));
 1162:             $award       = '' if (! defined($award));
 1163:             $awarddetail = '' if (! defined($awarddetail));
 1164:             my $sql_performance = 
 1165:                 "('".join("','",$symb_id,$student_id,$part_id,$part,
 1166:                                 $solved,$tries,$awarded,$award,
 1167:                                 $awarddetail,$timestamp)."'),\n";
 1168:             $store_performance_command .= $sql_performance;
 1169:             $rows_stored++;
 1170:         }
 1171:     }
 1172:     if (! $rows_stored) { return ($returnstatus, undef); }
 1173:     $store_parameters_command =~ s|,\n$||;
 1174:     $store_performance_command =~ s|,\n$||;
 1175:     my $start = Time::HiRes::time;
 1176:     $dbh->do($store_performance_command);
 1177:     if ($dbh->err()) {
 1178:         &Apache::lonnet::logthis('performance bigass insert error:'.
 1179:                                  $dbh->errstr());
 1180:         &Apache::lonnet::logthis('command = '.$/.$store_performance_command);
 1181:         $returnstatus = 'error: unable to insert performance into database';
 1182:         return ($returnstatus,$student_data);
 1183:     }
 1184:     $dbh->do($store_parameters_command) if ($num_parameters>0);
 1185:     if ($dbh->err()) {
 1186:         &Apache::lonnet::logthis('parameters bigass insert error:'.
 1187:                                  $dbh->errstr());
 1188:         &Apache::lonnet::logthis('command = '.$/.$store_parameters_command);
 1189:         &Apache::lonnet::logthis('rows_stored = '.$rows_stored);
 1190:         &Apache::lonnet::logthis('student_id = '.$student_id);
 1191:         $returnstatus = 'error: unable to insert parameters into database';
 1192:         return ($returnstatus,$student_data);
 1193:     }
 1194:     $elapsed += Time::HiRes::time - $start;
 1195:     return ($returnstatus,$student_data);
 1196: }
 1197: 
 1198: 
 1199: sub ensure_tables_are_set_up {
 1200:     my ($courseid) = @_;
 1201:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 1202:     # 
 1203:     # Clean out package variables
 1204:     &setup_table_names($courseid);
 1205:     #
 1206:     # if the tables do not exist, make them
 1207:     my @CurrentTable = &Apache::lonmysql::tables_in_db();
 1208:     my ($found_symb,$found_student,$found_groups,$found_groupnames,$found_part,
 1209:         $found_performance,$found_parameters,$found_fulldump_part,
 1210:         $found_fulldump_response,$found_fulldump_timestamp,
 1211:         $found_weight);
 1212:     foreach (@CurrentTable) {
 1213:         $found_symb        = 1 if ($_ eq $symb_table);
 1214:         $found_student     = 1 if ($_ eq $student_table);
 1215:         $found_groups      = 1 if ($_ eq $students_groups_table);
 1216:         $found_groupnames  = 1 if ($_ eq $groupnames_table);
 1217:         $found_part        = 1 if ($_ eq $part_table);
 1218:         $found_performance = 1 if ($_ eq $performance_table);
 1219:         $found_parameters  = 1 if ($_ eq $parameters_table);
 1220:         $found_fulldump_part      = 1 if ($_ eq $fulldump_part_table);
 1221:         $found_fulldump_response  = 1 if ($_ eq $fulldump_response_table);
 1222:         $found_fulldump_timestamp = 1 if ($_ eq $fulldump_timestamp_table);
 1223:         $found_weight      = 1 if ($_ eq $weight_table);
 1224:     }
 1225:     if (!$found_symb          || 
 1226:         !$found_student       || !$found_part              ||
 1227:         !$found_performance   || !$found_parameters        ||
 1228:         !$found_fulldump_part || !$found_fulldump_response ||
 1229:         !$found_fulldump_timestamp || !$found_weight ) {
 1230:         if (&init_dbs($courseid,1)) {
 1231:             return 'error';
 1232:         }
 1233:     }
 1234: }
 1235: 
 1236: sub ensure_current_data {
 1237:     my ($sname,$sdom,$courseid) = @_;
 1238:     my $status = 'okay';   # return value
 1239:     #
 1240:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 1241:     &ensure_tables_are_set_up($courseid);
 1242:     #
 1243:     # Get the update time for the user
 1244:     my $updatetime = 0;
 1245:     my $getuserdir = 1;
 1246:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
 1247:         ($sdom,$sname,$courseid.'.db',$getuserdir);
 1248:     #
 1249:     if ($modifiedtime == -1) {
 1250: 	return ('no data',undef);
 1251:     }
 1252: 
 1253:     my $student_id = &get_student_id($sname,$sdom);
 1254:     &get_students_groupids($student_id);
 1255:     my @Result = &Apache::lonmysql::get_rows($student_table,
 1256:                                              "student_id ='$student_id'");
 1257:     my $data = undef;
 1258:     if (@Result) {
 1259:         $updatetime = $Result[0]->[6];  # Ack!  This is dumb!
 1260:     }
 1261:     if ($modifiedtime > $updatetime) {
 1262:         ($status,$data) = &update_student_data($sname,$sdom,$courseid);
 1263:     }
 1264:     return ($status,$data);
 1265: }
 1266: 
 1267: 
 1268: sub ensure_current_full_data {
 1269:     my ($sname,$sdom,$courseid) = @_;
 1270:     my $status = 'okay';   # return value
 1271:     #
 1272:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 1273:     &ensure_tables_are_set_up($courseid);
 1274:     #
 1275:     # Get the update time for the user
 1276:     my $getuserdir = 1;
 1277:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
 1278:         ($sdom,$sname,$courseid.'.db',$getuserdir);
 1279:     #
 1280:     my $student_id = &get_student_id($sname,$sdom);
 1281:     &get_students_groupids($student_id);
 1282:     my @Result = &Apache::lonmysql::get_rows($student_table,
 1283:                                              "student_id ='$student_id'");
 1284:     my $updatetime;
 1285:     if (@Result && ref($Result[0]) eq 'ARRAY') {
 1286:         $updatetime = $Result[0]->[7];
 1287:     }
 1288:     if (! defined($updatetime) || $modifiedtime > $updatetime) {
 1289:         $status = &update_full_student_data($sname,$sdom,$courseid);
 1290:     }
 1291:     return $status;
 1292: }
 1293: 
 1294: sub ensure_current_groups {
 1295:     my ($courseid) = @_;  
 1296:     my ($cdom,$cnum);
 1297:     if (defined($courseid)) {
 1298:         my %coursehash = &Apache::lonnet::coursedescription($courseid);
 1299:         $cdom = $coursehash{'domain'};
 1300:         $cnum = $coursehash{'num'};
 1301:     } elsif ($env{'request.course.id'}) {
 1302:         $courseid = $env{'request.course.id'};
 1303:         $cdom = $env{'course.'.$courseid.'.domain'};
 1304:         $cnum = $env{'course.'.$courseid.'.num'};
 1305:     }
 1306:     if ($cdom eq '' || $cnum eq '') {
 1307:         return 'error: invalid course';
 1308:     }
 1309:     &setup_table_names($courseid);
 1310:     my @CurrentTables = &Apache::lonmysql::tables_in_db();
 1311:     unless (grep(/^\Q$groupnames_table\E$/,@CurrentTables)) {
 1312:         return;
 1313:     }
 1314:     # Get the update time for the groupnames table
 1315:     my $getuserdir = 1;
 1316:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
 1317:         ($cdom,$cnum,'coursegroups.db',$getuserdir);
 1318:     my %tableinfo = &Apache::lonmysql::table_information($groupnames_table);
 1319:     my $updatetime;
 1320:     if ($tableinfo{'Update_time'}) {
 1321:         $updatetime = $tableinfo{'Update_time'};
 1322:     }
 1323:     if (! defined($updatetime) || $modifiedtime > $updatetime) {
 1324:         my (%groups_in_sql,%removegroups,$addgroup);
 1325:         my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
 1326:         my @Result = &Apache::lonmysql::get_rows($groupnames_table);
 1327:         foreach my $row (@Result) {
 1328:             my ($id,$name) = @{$row};
 1329:             unless (exists($curr_groups{$name})) {
 1330:                 $groups_in_sql{$name}=$id;
 1331:             } elsif ($id) {
 1332:                 $removegroups{$id} = $name;
 1333:             }
 1334:         }
 1335:         foreach my $group (keys(%curr_groups)) {
 1336:             unless (exists($groups_in_sql{$group})) {
 1337:                 $addgroup = 1;
 1338:                 last;
 1339:             }
 1340:         }
 1341:         if (keys(%removegroups)) {
 1342:             my $dbh = &Apache::lonmysql::get_dbh();
 1343:             foreach my $group_id (keys(%removegroups)) {
 1344:                 my $command = 'DELETE FROM '.$groupnames_table.' WHERE group_id='.
 1345:                               $group_id;
 1346:                 $dbh->do($command);
 1347:                 if ($dbh->err()) {
 1348:                     &Apache::lonnet::logthis("error ".$dbh->errstr().
 1349:                                              " occurred executing \n".
 1350:                                              "SQL command: $command");
 1351:                 }
 1352:             }
 1353:         }
 1354:         if ($addgroup) {
 1355:             &populate_groupnames_table($courseid);
 1356:         }
 1357:     }
 1358:     return;
 1359: }
 1360: 
 1361: sub ensure_current_students_groups {
 1362:     my ($courseid) = @_;
 1363:     my ($cdom,$cnum);
 1364:     if (defined($courseid)) {
 1365:         my %coursehash = &Apache::lonnet::coursedescription($courseid);
 1366:         $cdom = $coursehash{'domain'};
 1367:         $cnum = $coursehash{'num'};
 1368:     } elsif ($env{'request.course.id'}) {
 1369:         $courseid = $env{'request.course.id'};
 1370:         $cdom = $env{'course.'.$courseid.'.domain'};
 1371:         $cnum = $env{'course.'.$courseid.'.num'};
 1372:     }
 1373:     &setup_table_names($courseid);
 1374:     my @CurrentTables = &Apache::lonmysql::tables_in_db();
 1375:     unless (grep(/^\Q$students_groups_table\E$/,@CurrentTables)) {
 1376:         return;
 1377:     }
 1378:     # Get the update time for the groupnames table
 1379:     my $getuserdir = 1;
 1380:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
 1381:         ($cdom,$cnum,'groupmembership.db',$getuserdir);
 1382:     my %tableinfo = &Apache::lonmysql::table_information($students_groups_table);
 1383:     my $updatetime;
 1384:     if ($tableinfo{'Update_time'}) {
 1385:         $updatetime = $tableinfo{'Update_time'};
 1386:     }
 1387:     if ((!defined($updatetime)) || ($modifiedtime > $updatetime)) {
 1388:         if (&Apache::lonmysql::drop_table($students_groups_table)) {
 1389:             if (&init_dbs($courseid)) {
 1390:                 return "error creating $students_groups_table\n";
 1391:             } else {
 1392:                 &populate_students_groups_table($courseid);
 1393:             }
 1394:         }
 1395:     }
 1396:     return;
 1397: }
 1398: 
 1399: sub ensure_current_sections {
 1400:     my ($courseid) = @_;
 1401:     my ($cdom,$cnum);
 1402:     if (defined($courseid)) {
 1403:         my %coursehash = &Apache::lonnet::coursedescription($courseid);
 1404:         $cdom = $coursehash{'domain'};
 1405:         $cnum = $coursehash{'num'};
 1406:     } elsif ($env{'request.course.id'}) {
 1407:         $courseid = $env{'request.course.id'};
 1408:         $cdom = $env{'course.'.$courseid.'.domain'};
 1409:         $cnum = $env{'course.'.$courseid.'.num'};
 1410:     }
 1411:     &setup_table_names($courseid);
 1412:     my @CurrentTables = &Apache::lonmysql::tables_in_db();
 1413:     unless (grep(/^\Q$student_table\E$/,@CurrentTables)) {
 1414:         return;
 1415:     }
 1416:     # Get the update time for the student table
 1417:     my $getuserdir = 1;
 1418:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
 1419:         ($cdom,$cnum,'classlist.db',$getuserdir);
 1420:     my %tableinfo = &Apache::lonmysql::table_information($student_table);
 1421:     my $updatetime;
 1422:     if ($tableinfo{'Update_time'}) {
 1423:         $updatetime = $tableinfo{'Update_time'};
 1424:     }
 1425:     if ((!defined($updatetime)) || ($modifiedtime > $updatetime)) {
 1426:         &update_student_table($cdom,$cnum);
 1427:     }
 1428:     return;
 1429: }
 1430: 
 1431: sub update_student_table {
 1432:     my ($cdom,$cnum) = @_;
 1433:     return unless (($cdom ne '') && ($cnum ne ''));
 1434:     my (%roster,%sqldata);
 1435:     my $classlist = &get_classlist($cdom,$cnum);
 1436:     while (my ($student,$data) = each (%$classlist)) {
 1437:         my ($section,$start,$end) = ($data->[&CL_SECTION()],
 1438:                                      $data->[&CL_START()],
 1439:                                      $data->[&CL_END()]);
 1440:         if ($section eq '' || $section =~ /^\s*$/) {
 1441:             $section = 'none';
 1442:         }
 1443:         if ($start eq '') { $start = 0; }
 1444:         if ($end eq '')   { $end   = 0; }
 1445:         $roster{$student}{'section'} = $section;
 1446:         $roster{$student}{'start'} = $start;
 1447:         $roster{$student}{'end'} = $end;
 1448:     }
 1449:     my $dbh = &Apache::lonmysql::get_dbh();
 1450:     my $statement = "SELECT student_id,student,section,start,end FROM $student_table";
 1451:     my $sth = $dbh->prepare($statement);
 1452:     $sth->execute();
 1453:     if ($sth->err()) {
 1454:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
 1455:         &Apache::lonnet::logthis("\n".$statement."\n");
 1456:         &Apache::lonnet::logthis("error is:".$sth->errstr());
 1457:         return undef;
 1458:     }
 1459:     foreach my $row (@{$sth->fetchall_arrayref}) {
 1460:         my ($id,$student,$section,$start,$end) = (@$row);
 1461:         if (ref($roster{$student}) eq 'HASH') {
 1462:             if (($roster{$student}{'section'} ne $section) ||
 1463:                 ($roster{$student}{'start'} ne $start) ||
 1464:                 ($roster{$student}{'end'} ne $end)) {
 1465:                 $sqldata{$id} = {
 1466:                                   section => $roster{$student}{'section'},
 1467:                                   start   => $roster{$student}{'start'},
 1468:                                   end     => $roster{$student}{'end'},
 1469:                                 };
 1470:             }
 1471:         }
 1472:     }
 1473:     $sth->finish();
 1474:     if (keys(%sqldata)) { 
 1475:         foreach my $id (sort { $a <=> $b } keys(%sqldata)) {
 1476:             my $request = "UPDATE $student_table SET section='$sqldata{$id}{section}'".
 1477:                           ", start='$sqldata{$id}{start}'".
 1478:                           ", end='$sqldata{$id}{end}' WHERE student_id='$id'";
 1479:             $dbh->do($request);
 1480:         }
 1481:     }
 1482:     return;
 1483: }
 1484: 
 1485: sub get_student_data_from_performance_cache {
 1486:     my ($sname,$sdom,$symb,$courseid)=@_;
 1487:     my $student = $sname.':'.$sdom if (defined($sname) && defined($sdom));
 1488:     &setup_table_names($courseid);
 1489:     #
 1490:     # Return hash
 1491:     my $studentdata;
 1492:     #
 1493:     my $dbh = &Apache::lonmysql::get_dbh();
 1494:     my $request = "SELECT ".
 1495:         "d.symb,a.part,a.solved,a.tries,a.awarded,a.award,a.awarddetail,".
 1496:             "a.timestamp ";
 1497:     if (defined($student)) {
 1498:         $request .= "FROM $student_table AS b ".
 1499:             "LEFT JOIN $performance_table AS a ON b.student_id=a.student_id ".
 1500: #            "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
 1501:             "LEFT JOIN $symb_table AS d ON d.symb_id = a.symb_id ".
 1502:                 "WHERE student='$student'";
 1503:         if (defined($symb) && $symb ne '') {
 1504:             $request .= " AND d.symb=".$dbh->quote($symb);
 1505:         }
 1506:     } elsif (defined($symb) && $symb ne '') {
 1507:         $request .= "FROM $symb_table as d ".
 1508:             "LEFT JOIN $performance_table AS a ON d.symb_id=a.symb_id ".
 1509: #            "LEFT JOIN $part_table    AS c ON c.part_id = a.part_id ".
 1510:             "LEFT JOIN $student_table AS b ON b.student_id = a.student_id ".
 1511:                 "WHERE symb='".$dbh->quote($symb)."'";
 1512:     }
 1513:     my $starttime = Time::HiRes::time;
 1514:     my $rows_retrieved = 0;
 1515:     my $sth = $dbh->prepare($request);
 1516:     $sth->execute();
 1517:     if ($sth->err()) {
 1518:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
 1519:         &Apache::lonnet::logthis("\n".$request."\n");
 1520:         &Apache::lonnet::logthis("error is:".$sth->errstr());
 1521:         return undef;
 1522:     }
 1523:     foreach my $row (@{$sth->fetchall_arrayref}) {
 1524:         $rows_retrieved++;
 1525:         my ($symb,$part,$solved,$tries,$awarded,$award,$awarddetail,$time) = 
 1526:             (@$row);
 1527:         my $base = 'resource.'.$part;
 1528:         $studentdata->{$symb}->{$base.'.solved'}  = $solved;
 1529:         $studentdata->{$symb}->{$base.'.tries'}   = $tries;
 1530:         $studentdata->{$symb}->{$base.'.awarded'} = $awarded;
 1531:         $studentdata->{$symb}->{$base.'.award'}   = $award;
 1532:         $studentdata->{$symb}->{$base.'.awarddetail'} = $awarddetail;
 1533:         $studentdata->{$symb}->{'timestamp'} = $time if (defined($time) && $time ne '');
 1534:     }
 1535:     ## Get misc parameters
 1536:     $request = 'SELECT c.symb,a.parameter,a.value '.
 1537:         "FROM $student_table AS b ".
 1538:         "LEFT JOIN $parameters_table AS a ON b.student_id=a.student_id ".
 1539:         "LEFT JOIN $symb_table AS c ON c.symb_id = a.symb_id ".
 1540:         "WHERE student='$student'";
 1541:     if (defined($symb) && $symb ne '') {
 1542:         $request .= " AND c.symb=".$dbh->quote($symb);
 1543:     }
 1544:     $sth = $dbh->prepare($request);
 1545:     $sth->execute();
 1546:     if ($sth->err()) {
 1547:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
 1548:         &Apache::lonnet::logthis("\n".$request."\n");
 1549:         &Apache::lonnet::logthis("error is:".$sth->errstr());
 1550:         if (defined($symb) && $symb ne '') {
 1551:             $studentdata = $studentdata->{$symb};
 1552:         }
 1553:         return $studentdata;
 1554:     }
 1555:     #
 1556:     foreach my $row (@{$sth->fetchall_arrayref}) {
 1557:         $rows_retrieved++;
 1558:         my ($symb,$parameter,$value) = (@$row);
 1559:         $studentdata->{$symb}->{$parameter}  = $value;
 1560:     }
 1561:     #
 1562:     if (defined($symb) && $symb ne '') {
 1563:         $studentdata = $studentdata->{$symb};
 1564:     }
 1565:     return $studentdata;
 1566: }
 1567: 
 1568: 
 1569: sub get_current_state {
 1570:     my ($sname,$sdom,$symb,$courseid,$forcedownload)=@_;
 1571:     #
 1572:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 1573:     #
 1574:     return () if (! defined($sname) || ! defined($sdom));
 1575:     #
 1576:     my ($status,$data) = &ensure_current_data($sname,$sdom,$courseid);
 1577: #    &Apache::lonnet::logthis
 1578: #        ('sname = '.$sname.
 1579: #         ' domain = '.$sdom.
 1580: #         ' status = '.$status.
 1581: #         ' data is '.(defined($data)?'defined':'undefined'));
 1582: #    while (my ($symb,$hash) = each(%$data)) {
 1583: #        &Apache::lonnet::logthis($symb."\n----------------------------------");
 1584: #        while (my ($key,$value) = each (%$hash)) {
 1585: #            &Apache::lonnet::logthis("   ".$key." = ".$value);
 1586: #        }
 1587: #    }
 1588:     #
 1589:     if (defined($data) && defined($symb) && ref($data->{$symb})) {
 1590:         return %{$data->{$symb}};
 1591:     } elsif (defined($data) && ! defined($symb) && ref($data)) {
 1592:         return %$data;
 1593:     } 
 1594:     if ($status eq 'no data') {
 1595:         return ();
 1596:     } else {
 1597:         if ($status ne 'okay' && $status ne '') {
 1598:             &Apache::lonnet::logthis('status = '.$status);
 1599:             return ('error: '.$status,undef);
 1600:         }
 1601:         my $returnhash = &get_student_data_from_performance_cache($sname,$sdom,
 1602:                                                       $symb,$courseid);
 1603:         return %$returnhash if (defined($returnhash));
 1604:     }
 1605:     return ();
 1606: }
 1607: 
 1608: 
 1609: sub get_problem_statistics {
 1610:     my ($Sections,$Groups,$status,$symb,$part,$courseid,$starttime,$endtime) = @_;
 1611:     return if (! defined($symb) || ! defined($part));
 1612:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 1613:     #
 1614:     &setup_table_names($courseid);
 1615:     my $symb_id = &get_symb_id($symb);
 1616:     my $part_id = &get_part_id($part);
 1617:     my $stats_table = &temp_table_name($courseid,'problem_stats');
 1618:     #
 1619:     my $dbh = &Apache::lonmysql::get_dbh();
 1620:     return undef if (! defined($dbh));
 1621:     #
 1622:     # Clean out the table
 1623:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
 1624:     my $request = 
 1625:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
 1626:         'SELECT a.student_id,a.solved,a.award,a.awarded,a.tries '.
 1627:         'FROM '.$performance_table.' AS a ';
 1628:     #
 1629:     # See if we need to include some requirements on the students
 1630:     if ((defined($Sections) && lc($Sections->[0]) ne 'all') || 
 1631:         (defined($status)   && lc($status)        ne 'any')) {
 1632:         $request .= 'NATURAL LEFT JOIN '.$student_table.' AS b ';
 1633:     }
 1634:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
 1635:     if (defined($groups_join)) {
 1636:         $request .= $groups_join;
 1637:     }
 1638:     $request .= ' WHERE a.symb_id='.$symb_id.' AND a.part_id='.$part_id;
 1639:     #
 1640:     # Limit the students included to those specified
 1641:     my ($section_limits,$enrollment_limits)=
 1642:         &limit_by_section_and_status($Sections,$status,'b');
 1643:     #
 1644:     # Limit by starttime and endtime
 1645:     my $time_requirements = undef;
 1646:     if (defined($starttime)) {
 1647:         $time_requirements .= 'a.timestamp>='.$starttime;
 1648:         if (defined($endtime)) {
 1649:             $time_requirements .= ' AND a.timestamp<='.$endtime;
 1650:         }
 1651:     } elsif (defined($endtime)) {
 1652:         $time_requirements .= 'a.timestamp<='.$endtime;
 1653:     }
 1654:     if (defined($time_requirements)) {
 1655:         $request .= ' AND '.$time_requirements;
 1656:     }
 1657:     if (defined($section_limits)) {
 1658:         $request .= ' AND '.$section_limits;
 1659:     }
 1660:     if (defined($enrollment_limits)) {
 1661:         $request .= ' AND '.$enrollment_limits;
 1662:     }
 1663:     # Limit by group, as required
 1664:     if (defined($group_limits)) {
 1665:         $request .= ' AND '.$group_limits;
 1666:     }
 1667:     #
 1668:     # Finally, execute the request to create the temporary table
 1669:     $dbh->do($request);
 1670:     #
 1671:     # Collect the first suite of statistics
 1672:     $request = 'SELECT COUNT(*),SUM(tries),'.
 1673:         'AVG(tries),STD(tries) '.
 1674:         'FROM '.$stats_table;
 1675:     my ($num,$tries,$mean,$STD) = &execute_SQL_request
 1676:         ($dbh,$request);
 1677:     #
 1678:     $request = 'SELECT MAX(tries),MIN(tries) FROM '.$stats_table.
 1679:         ' WHERE awarded>0';
 1680:     my ($max,$min) = &execute_SQL_request($dbh,$request);
 1681:     #
 1682:     $request = 'SELECT SUM(awarded) FROM '.$stats_table;
 1683:     my ($Solved) = &execute_SQL_request($dbh,$request);
 1684:     #
 1685:     $request = 'SELECT SUM(awarded) FROM '.$stats_table.
 1686:         " WHERE solved='correct_by_override'";
 1687:     my ($solved) = &execute_SQL_request($dbh,$request);
 1688:     #
 1689:     $Solved -= $solved;
 1690:     #
 1691:     $num    = 0 if (! defined($num));
 1692:     $tries  = 0 if (! defined($tries));
 1693:     $max    = 0 if (! defined($max));
 1694:     $min    = 0 if (! defined($min));
 1695:     $STD    = 0 if (! defined($STD));
 1696:     $Solved = 0 if (! defined($Solved) || $Solved < 0);
 1697:     $solved = 0 if (! defined($solved));
 1698:     #
 1699:     # Compute the more complicated statistics
 1700:     my $DegOfDiff = 'nan';
 1701:     $DegOfDiff = 1-($Solved)/$tries if ($tries>0);
 1702:     #
 1703:     my $SKEW = 'nan';
 1704:     my $wrongpercent = 0;
 1705:     my $numwrong = 'nan';
 1706:     if ($num > 0) {
 1707:         ($SKEW) = &execute_SQL_request($dbh,'SELECT SQRT(SUM('.
 1708:                                      'POWER(tries - '.$STD.',3)'.
 1709:                                      '))/'.$num.' FROM '.$stats_table);
 1710:         $numwrong = $num-$Solved;
 1711:         $wrongpercent=int(10*100*$numwrong/$num)/10;
 1712:     }
 1713:     #
 1714:     # Drop the temporary table
 1715:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
 1716:     #
 1717:     # Return result
 1718:     return { num_students => $num,
 1719:              tries        => $tries,
 1720:              max_tries    => $max,
 1721:              min_tries    => $min,
 1722:              mean_tries   => $mean,
 1723:              std_tries    => $STD,
 1724:              skew_tries   => $SKEW,
 1725:              num_solved   => $Solved,
 1726:              num_override => $solved,
 1727:              num_wrong    => $numwrong,
 1728:              per_wrong    => $wrongpercent,
 1729:              deg_of_diff  => $DegOfDiff };
 1730: }
 1731: 
 1732: ##
 1733: ## This is a helper for get_statistics
 1734: sub execute_SQL_request {
 1735:     my ($dbh,$request)=@_;
 1736: #    &Apache::lonnet::logthis($request);
 1737:     my $sth = $dbh->prepare($request);
 1738:     if (!$sth) {
 1739: 	die($dbh->errstr . " SQL: $request");
 1740:     }
 1741:     $sth->execute();
 1742:     my $row = $sth->fetchrow_arrayref();
 1743:     if (ref($row) eq 'ARRAY' && scalar(@$row)>0) {
 1744:         return @$row;
 1745:     }
 1746:     return ();
 1747: }
 1748: 
 1749: 
 1750: sub populate_weight_table {
 1751:     my ($courseid) = @_;
 1752:     if (! defined($courseid)) {
 1753:         $courseid = $env{'request.course.id'};
 1754:     }
 1755:     #
 1756:     &setup_table_names($courseid);
 1757:     my $navmap = Apache::lonnavmaps::navmap->new();
 1758:     if (!defined($navmap)) {
 1759:         &Apache::lonnet::logthis('loncoursedata::populate_weight_table:'.$/.
 1760:                                  '  unable to get navmaps resource'.$/.
 1761:                                  '  '.join(' ',(caller)));
 1762:         return;
 1763:     }
 1764:     my @sequences = $navmap->retrieveResources(undef,
 1765:                                                sub { shift->is_map(); },1,0,1);
 1766:     my @resources;
 1767:     foreach my $seq (@sequences) {
 1768:         push(@resources,$navmap->retrieveResources($seq,
 1769:                                                    sub {shift->is_problem();},
 1770:                                                    0,0,0));
 1771:     }
 1772:     if (! scalar(@resources)) {
 1773:         &Apache::lonnet::logthis('loncoursedata::populate_weight_table:'.$/.
 1774:                                  ' no resources returned for '.$courseid);
 1775:         return;
 1776:     }
 1777:     #       Since we use lonnet::EXT to retrieve problem weights,
 1778:     #       to ensure current data we must clear the caches out.
 1779:     &Apache::lonnet::clear_EXT_cache_status();
 1780:     my $dbh = &Apache::lonmysql::get_dbh();
 1781:     my $request = 'INSERT IGNORE INTO '.$weight_table.
 1782:         "(symb_id,part_id,weight) VALUES ";
 1783:     my $weight;
 1784:     foreach my $res (@resources) {
 1785:         my $symb_id = &get_symb_id($res->symb);
 1786:         foreach my $part (@{$res->parts}) {
 1787:             my $part_id = &get_part_id($part);
 1788:             $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
 1789:                                            $res->symb,
 1790:                                            undef,undef,undef);
 1791:             if (!defined($weight) || ($weight eq '')) { 
 1792:                 $weight=1;
 1793:             }
 1794:             $request .= "('".$symb_id."','".$part_id."','".$weight."'),";
 1795:         }
 1796:     }
 1797:     $request =~ s/(,)$//;
 1798: #    &Apache::lonnet::logthis('request = '.$/.$request);
 1799:     $dbh->do($request);
 1800:     if ($dbh->err()) {
 1801:         &Apache::lonnet::logthis("error ".$dbh->errstr().
 1802:                                  " occurred executing \n".
 1803:                                  $request);
 1804:     }
 1805:     return;
 1806: }
 1807: 
 1808: sub limit_by_start_end_time {
 1809:     my ($starttime,$endtime,$table) = @_;
 1810:     my $time_requirements = undef;
 1811:     if (defined($starttime)) {
 1812:         $time_requirements .= $table.".timestamp>='".$starttime."'";
 1813:         if (defined($endtime)) {
 1814:             $time_requirements .= " AND ".$table.".timestamp<='".$endtime."'";
 1815:         }
 1816:     } elsif (defined($endtime)) {
 1817:         $time_requirements .= $table.".timestamp<='".$endtime."'";
 1818:     }
 1819:     return $time_requirements;
 1820: }
 1821: 
 1822: 
 1823: sub limit_by_section_and_status {
 1824:     my ($Sections,$enrollment,$tablename) = @_;
 1825:     my $student_requirements = undef;
 1826:     if ( (defined($Sections) && $Sections->[0] ne 'all')) {
 1827:         $student_requirements = '('.
 1828:             join(' OR ', map { $tablename.".section='".$_."'" } @$Sections
 1829:                  ).')';
 1830:     }
 1831:     my $enrollment_requirements=undef;
 1832:     if (defined($enrollment) && $enrollment ne 'Any') {
 1833: 	my $now = time();
 1834: 	if ( $enrollment eq 'Future' ) {
 1835: 	    $enrollment_requirements = 
 1836: 		"( $tablename.start > $now AND ".
 1837: 		"( $tablename.end = 0 OR $tablename.end > $now))";
 1838: 	} elsif ( $enrollment eq 'Active' ) {
 1839: 	    $enrollment_requirements = 
 1840: 		"(( $tablename.start = 0 OR $tablename.start < $now )  AND ".
 1841: 		" ( $tablename.end   = 0 OR $tablename.end   > $now ))";
 1842: 	} elsif ( $enrollment eq 'Expired' ) {
 1843: 	    $enrollment_requirements = 
 1844: 		"(( $tablename.start < $now )  AND ".
 1845: 		" ( $tablename.end   < $now ))";
 1846: 	}
 1847:     }
 1848:     return ($student_requirements,$enrollment_requirements);
 1849: }
 1850: 
 1851: 
 1852: 
 1853: sub limit_by_group {
 1854:     my ($Groups,$stutable,$grptable,$stugrptab) = @_;
 1855:     my $groups_join = undef;
 1856:     my $group_limits = undef;
 1857:     if ( (defined($Groups) && $Groups->[0] ne 'all')) {
 1858:         $groups_join =
 1859:           ' LEFT JOIN '.$students_groups_table.
 1860:                      ' AS '.$stugrptab.' ON '.
 1861:                      $stugrptab.'.student_id = '.$stutable.'.student_id'.
 1862:           ' LEFT JOIN '.$groupnames_table.
 1863:                      ' AS '.$grptable.' ON '.
 1864:                      $stugrptab.'.group_id = '.$grptable.'.group_id ';
 1865:         $group_limits =
 1866:           ' ('.
 1867:              join(' OR ', map {  "$grptable.groupname='".$_."'" } @$Groups
 1868:            ).')';
 1869:     }
 1870:     return ($groups_join,$group_limits);
 1871: }
 1872: 
 1873: 
 1874: sub RNK_student { return 0; };
 1875: sub RNK_score   { return 1; };
 1876: 
 1877: sub rank_students_by_scores_on_resources {
 1878:     my ($resources,$Sections,$Groups,$enrollment,$courseid,$starttime,$endtime,
 1879:         $has_award_for) = @_;
 1880:     return if (! defined($resources) || ! ref($resources) eq 'ARRAY');
 1881:     if (! defined($courseid)) {
 1882:         $courseid = $env{'request.course.id'};
 1883:     }
 1884:     #
 1885:     &setup_table_names($courseid);
 1886:     my $dbh = &Apache::lonmysql::get_dbh();
 1887:     my ($section_limits,$enrollment_limits)=
 1888:         &limit_by_section_and_status($Sections,$enrollment,'b');
 1889:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
 1890:     my $symb_limits = '('.join(' OR ',map {'a.symb_id='.&get_symb_id($_);
 1891:                                        } @$resources
 1892:                                ).')';
 1893:     my ($award_col, $award_join, $award_clause) = ('', '', '');
 1894:     if ($has_award_for) {
 1895:         my $resource_id = &get_symb_id($has_award_for);
 1896:         $award_col = ", perf.awarded";
 1897:         $award_join = "LEFT JOIN $performance_table AS perf ON perf.symb_id"
 1898:             ." = $resource_id AND perf.student_id = b.student_id ";
 1899:         $award_clause = "AND perf.awarded IS NOT NULL";
 1900:     }
 1901:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
 1902:     my $request = "SELECT b.student,SUM(a.awarded*w.weight) AS score "
 1903:         ."$award_col FROM $performance_table AS a ".
 1904:         "NATURAL LEFT JOIN $weight_table AS w ".
 1905:         "LEFT JOIN $student_table AS b ON a.student_id=b.student_id ".
 1906:         "$award_join $groups_join "; 
 1907:     my $limits;
 1908:     if (defined($section_limits)) {
 1909:         $limits .= $section_limits.' AND ';
 1910:     }
 1911:     if (defined($enrollment_limits)) {
 1912:         $limits .= $enrollment_limits.' AND ';
 1913:     }
 1914:     if (defined($time_limits)) {
 1915:         $limits .= $time_limits.' AND ';
 1916:     }
 1917:     if ($symb_limits ne '()') {
 1918:         $limits .= $symb_limits.' AND ';
 1919:     }
 1920:     if (defined($group_limits)) {
 1921:         $limits .= $group_limits.' AND ';
 1922:     }
 1923:     if ($limits) {
 1924:         $limits =~ s/( AND )$//;   # Remove extra conjunction
 1925:         $request .= "WHERE $limits";
 1926:     } 
 1927:     $request .= " $award_clause GROUP BY a.student_id ORDER BY score, b.student";
 1928:     #&Apache::lonnet::logthis('request = '.$/.$request);
 1929:     my $sth = $dbh->prepare($request) or die "Can't prepare $request";
 1930:     $sth->execute();
 1931:     my $rows = $sth->fetchall_arrayref();
 1932:     return ($rows);
 1933: }
 1934: 
 1935: sub get_sum_of_scores {
 1936:     my ($symb,$part,$students,$courseid,$starttime,$endtime) = @_;
 1937:     if (! defined($courseid)) {
 1938:         $courseid = $env{'request.course.id'};
 1939:     }
 1940:     if (defined($students) && 
 1941:         ((@$students == 0) ||
 1942:          (@$students == 1 && (! defined($students->[0]) || 
 1943:                               $students->[0] eq ''))
 1944:          )
 1945:         ){
 1946:         undef($students);
 1947:     }
 1948:     #
 1949:     &setup_table_names($courseid);
 1950:     my $dbh = &Apache::lonmysql::get_dbh();
 1951:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
 1952:     my $request = 'SELECT SUM(a.awarded*w.weight),SUM(w.weight) FROM '.
 1953:         $performance_table.' AS a '.
 1954:         'NATURAL LEFT JOIN '.$weight_table.' AS w ';
 1955:     $request .= 'WHERE a.symb_id='.&get_symb_id($symb).
 1956:         ' AND a.part_id='.&get_part_id($part);
 1957:     if (defined($time_limits)) {
 1958:         $request .= ' AND '.$time_limits;
 1959:     }
 1960:     if (defined($students)) {
 1961:         $request .= ' AND ('.
 1962:             join(' OR ',map {'a.student_id='.&get_student_id(split(':',$_));
 1963:                          } @$students).
 1964:                              ')';
 1965:     }
 1966:     my $sth = $dbh->prepare($request);
 1967:     $sth->execute();
 1968:     my $rows = $sth->fetchrow_arrayref();
 1969:     if ($dbh->err) {
 1970:         &Apache::lonnet::logthis('error 1 = '.$dbh->errstr());
 1971:         &Apache::lonnet::logthis('prepared then executed, fetchrow_arrayrefed'.
 1972:                                  $/.$request);
 1973:         return (undef,undef);
 1974:     }
 1975:     return ($rows->[0],$rows->[1]);
 1976: }
 1977: 
 1978: 
 1979: sub score_stats {
 1980:     my ($Sections,$Groups,$enrollment,$symbs,$starttime,$endtime,$courseid)=@_;
 1981:     if (! defined($courseid)) {
 1982:         $courseid = $env{'request.course.id'};
 1983:     }
 1984:     #
 1985:     &setup_table_names($courseid);
 1986:     my $dbh = &Apache::lonmysql::get_dbh();
 1987:     #
 1988:     my ($section_limits,$enrollment_limits)=
 1989:         &limit_by_section_and_status($Sections,$enrollment,'b');
 1990:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
 1991:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
 1992:     my @Symbids = map { &get_symb_id($_); } @{$symbs};
 1993:     #
 1994:     my $stats_table = &temp_table_name($courseid,'problem_stats');
 1995:     my $symb_restriction = join(' OR ',map {'a.symb_id='.$_;} @Symbids);
 1996:     my $request = 'DROP TABLE '.$stats_table;
 1997:     $dbh->do($request);
 1998:     $request = 
 1999:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
 2000:         'SELECT a.student_id,'.
 2001:         'SUM(a.awarded*w.weight) AS score FROM '.
 2002:         $performance_table.' AS a '.
 2003:         'NATURAL LEFT JOIN '.$weight_table.' AS w '.
 2004:         'LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id '.
 2005:         $groups_join;
 2006:     my $limit = ' WHERE ('.$symb_restriction.')';
 2007:     if ($time_limits) {
 2008:         $limit .= ' AND '.$time_limits;
 2009:     }
 2010:     if ($section_limits) {
 2011:         $limit .= ' AND '.$section_limits;
 2012:     }
 2013:     if ($enrollment_limits) {
 2014:         $limit .= ' AND '.$enrollment_limits;
 2015:     }
 2016:     if ($group_limits) {
 2017:         $limit .= ' AND '.$group_limits;
 2018:     }
 2019:     $request .= $limit.' GROUP BY a.student_id';
 2020: #    &Apache::lonnet::logthis('request = '.$/.$request);
 2021:     my $sth = $dbh->prepare($request);
 2022:     $sth->execute();
 2023:     $request = 
 2024:         'SELECT AVG(score),STD(score),MAX(score),MIN(score),COUNT(score) '.
 2025:         'FROM '.$stats_table;
 2026:     my ($ave,$std,$max,$min,$count) = &execute_SQL_request($dbh,$request);
 2027: #    &Apache::lonnet::logthis('request = '.$/.$request);
 2028:     
 2029:     $request = 'SELECT SUM(weight) FROM '.$weight_table.
 2030:         ' AS a WHERE ('.$symb_restriction.')';
 2031:     my ($max_possible) = &execute_SQL_request($dbh,$request);
 2032:     # &Apache::lonnet::logthis('request = '.$/.$request);
 2033:     return($min,$max,$ave,$std,$count,$max_possible);
 2034: }
 2035: 
 2036: 
 2037: 
 2038: sub count_stats {
 2039:     my ($Sections,$Groups,$enrollment,$symbs,$starttime,$endtime,$courseid)=@_;
 2040:     if (! defined($courseid)) {
 2041:         $courseid = $env{'request.course.id'};
 2042:     }
 2043:     #
 2044:     &setup_table_names($courseid);
 2045:     my $dbh = &Apache::lonmysql::get_dbh();
 2046:     #
 2047:     my ($section_limits,$enrollment_limits)=
 2048:         &limit_by_section_and_status($Sections,$enrollment,'b');
 2049:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
 2050:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
 2051:     my @Symbids = map { &get_symb_id($_); } @{$symbs};
 2052:     #
 2053:     my $stats_table = &temp_table_name($courseid,'problem_stats');
 2054:     my $symb_restriction = join(' OR ',map {'a.symb_id='.$_;} @Symbids);
 2055:     my $request = 'DROP TABLE '.$stats_table;
 2056:     $dbh->do($request);
 2057:     $request = 
 2058:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
 2059:         'SELECT a.student_id,'.
 2060:         'SUM(a.awarded) AS count FROM '.
 2061:         $performance_table.' AS a '.
 2062:         'LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id '.
 2063:         $groups_join;
 2064:     my $limit =  ' WHERE ('.$symb_restriction.')';
 2065:     if ($time_limits) {
 2066:         $limit .= ' AND '.$time_limits;
 2067:     }
 2068:     if ($section_limits) {
 2069:         $limit .= ' AND '.$section_limits;
 2070:     }
 2071:     if ($enrollment_limits) {
 2072:         $limit .= ' AND '.$enrollment_limits;
 2073:     }
 2074:     if ($group_limits) {
 2075:         $limit .= ' AND '.$group_limits;
 2076:     }
 2077:     $request .= $limit.' GROUP BY a.student_id';
 2078: #    &Apache::lonnet::logthis('request = '.$/.$request);
 2079:     my $sth = $dbh->prepare($request);
 2080:     $sth->execute();
 2081:     $request = 
 2082:         'SELECT AVG(count),STD(count),MAX(count),MIN(count),COUNT(count) '.
 2083:         'FROM '.$stats_table;
 2084:     my ($ave,$std,$max,$min,$count) = &execute_SQL_request($dbh,$request);
 2085: #    &Apache::lonnet::logthis('request = '.$/.$request);
 2086:     return($min,$max,$ave,$std,$count);
 2087: }
 2088: 
 2089: 
 2090: sub get_student_data {
 2091:     my ($students,$courseid) = @_;
 2092:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 2093:     &setup_table_names($courseid);
 2094:     my $dbh = &Apache::lonmysql::get_dbh();
 2095:     return undef if (! defined($dbh));
 2096:     my $request = 'SELECT '.
 2097:         'student_id, student '.
 2098:         'FROM '.$student_table;
 2099:     if (defined($students)) {
 2100:         $request .= ' WHERE ('.
 2101:             join(' OR ', map {'student_id='.
 2102:                                   &get_student_id($_->{'username'},
 2103:                                                   $_->{'domain'})
 2104:                               } @$students
 2105:                  ).')';
 2106:     }
 2107:     $request.= ' ORDER BY student_id';
 2108:     my $sth = $dbh->prepare($request);
 2109:     $sth->execute();
 2110:     if ($dbh->err) {
 2111:         &Apache::lonnet::logthis('error 2 = '.$dbh->errstr());
 2112:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2113:         return undef;
 2114:     }
 2115:     my $dataset = $sth->fetchall_arrayref();
 2116:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
 2117:         return $dataset;
 2118:     }
 2119: }
 2120: 
 2121: sub RD_student_id      { return 0; }
 2122: sub RD_awarddetail     { return 1; }
 2123: sub RD_response_eval   { return 2; }
 2124: sub RD_response_eval_2 { return 3; }
 2125: sub RD_submission      { return 4; }
 2126: sub RD_timestamp       { return 5; }
 2127: sub RD_tries           { return 6; }
 2128: sub RD_sname           { return 7; }
 2129: 
 2130: sub get_response_data {
 2131:     my ($Sections,$Groups,$enrollment,$symb,$response,$courseid) = @_;
 2132:     return undef if (! defined($symb) || 
 2133:                ! defined($response));
 2134:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 2135:     #
 2136:     &setup_table_names($courseid);
 2137:     my $symb_id = &get_symb_id($symb);
 2138:     if (! defined($symb_id)) {
 2139:         &Apache::lonnet::logthis('Unable to find symb for '.$symb.' in '.$courseid);
 2140:         return undef;
 2141:     }
 2142:     my $response_id = &get_part_id($response);
 2143:     if (! defined($response_id)) {
 2144:         &Apache::lonnet::logthis('Unable to find id for '.$response.' in '.$courseid);
 2145:         return undef;
 2146:     }
 2147:     #
 2148:     my $dbh = &Apache::lonmysql::get_dbh();
 2149:     return undef if (! defined($dbh));
 2150:     #
 2151:     my ($student_requirements,$enrollment_requirements) = 
 2152:         &limit_by_section_and_status($Sections,$enrollment,'d');
 2153:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'d','e','f');
 2154:     my $request = 'SELECT '.
 2155:         'a.student_id, a.awarddetail, a.response_specific_value, '.
 2156:         'a.response_specific_value_2, a.submission, b.timestamp, '.
 2157: 	'c.tries, d.student '.
 2158:         'FROM '.$fulldump_response_table.' AS a '.
 2159:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
 2160:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
 2161:         'a.transaction = b.transaction '.
 2162:         'LEFT JOIN '.$fulldump_part_table.' AS c '.
 2163:         'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.        
 2164:         'a.part_id=c.part_id AND a.transaction = c.transaction '.
 2165:         'LEFT JOIN '.$student_table.' AS d '.
 2166:         'ON a.student_id=d.student_id '.
 2167:         $groups_join;
 2168:     my $limit = ' WHERE '.
 2169:         'a.symb_id='.$symb_id.' AND a.response_id='.$response_id;
 2170:     if (defined($student_requirements)) {
 2171:         $limit .= ' AND '.$student_requirements;
 2172:     }
 2173:     if (defined($enrollment_requirements)) {
 2174:         $limit .= ' AND '.$enrollment_requirements;
 2175:     }
 2176:     if (defined($group_limits)) {
 2177:         $limit .= ' AND '.$group_limits;
 2178:     }
 2179:     $request .= $limit.' ORDER BY b.timestamp';
 2180: #    &Apache::lonnet::logthis("request =\n".$request);
 2181:     my $sth = $dbh->prepare($request);
 2182:     $sth->execute();
 2183:     if ($dbh->err) {
 2184:         &Apache::lonnet::logthis('error 3 = '.$dbh->errstr());
 2185:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2186:         return undef;
 2187:     }
 2188:     my $dataset = $sth->fetchall_arrayref();
 2189:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
 2190:         # Clear the \'s from around the submission
 2191:         for (my $i =0;$i<scalar(@$dataset);$i++) {
 2192:             $dataset->[$i]->[&RD_submission()] =~ s/(\'$|^\')//g;
 2193:         }
 2194:         return $dataset;
 2195:     }
 2196: }
 2197: 
 2198: 
 2199: sub RDs_awarddetail     { return 3; }
 2200: sub RDs_submission      { return 2; }
 2201: sub RDs_timestamp       { return 1; }
 2202: sub RDs_tries           { return 0; }
 2203: sub RDs_awarded         { return 4; }
 2204: sub RDs_response_eval   { return 5; }
 2205: sub RDs_response_eval_2 { return 6; }
 2206: sub RDs_part_award      { return 7; }
 2207: 
 2208: sub get_response_data_by_student {
 2209:     my ($student,$symb,$response,$courseid) = @_;
 2210:     return undef if (! defined($symb) || 
 2211:                      ! defined($response));
 2212:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 2213:     #
 2214:     &setup_table_names($courseid);
 2215:     my $symb_id = &get_symb_id($symb);
 2216:     my $response_id = &get_part_id($response);
 2217:     #
 2218:     my $student_id = &get_student_id($student->{'username'},
 2219:                                      $student->{'domain'});
 2220:     #
 2221:     my $dbh = &Apache::lonmysql::get_dbh();
 2222:     return undef if (! defined($dbh));
 2223:     my $request = 'SELECT '.
 2224:         'c.tries, b.timestamp, a.submission, a.awarddetail, c.awarded, '.
 2225: 	'a.response_specific_value, a.response_specific_value_2, c.award '.
 2226:         'FROM '.$fulldump_response_table.' AS a '.
 2227:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
 2228:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
 2229:         'a.transaction = b.transaction '.
 2230:         'LEFT JOIN '.$fulldump_part_table.' AS c '.
 2231:         'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.        
 2232:         'a.part_id=c.part_id AND a.transaction = c.transaction '.
 2233:         'LEFT JOIN '.$student_table.' AS d '.
 2234:         'ON a.student_id=d.student_id '.
 2235:         'LEFT JOIN '.$performance_table.' AS e '.
 2236:         'ON a.symb_id=e.symb_id AND a.part_id=e.part_id AND '.
 2237:         'a.student_id=e.student_id AND c.tries=e.tries '.
 2238:         'WHERE '.
 2239:         'a.symb_id='.$symb_id.' AND a.response_id='.$response_id.
 2240:         ' AND a.student_id='.$student_id.' ORDER BY b.timestamp';
 2241: #    &Apache::lonnet::logthis("request =\n".$request);
 2242:     my $sth = $dbh->prepare($request);
 2243:     $sth->execute();
 2244:     if ($dbh->err) {
 2245:         &Apache::lonnet::logthis('error 4 = '.$dbh->errstr());
 2246:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2247:         return undef;
 2248:     }
 2249:     my $dataset = $sth->fetchall_arrayref();
 2250:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
 2251:         # Clear the \'s from around the submission
 2252:         for (my $i =0;$i<scalar(@$dataset);$i++) {
 2253:             $dataset->[$i]->[&RDs_submission] =~ s/(\'$|^\')//g;
 2254:         }
 2255:         return $dataset;
 2256:     }
 2257:     return undef; # error occurred
 2258: }
 2259: 
 2260: sub RT_student_id { return 0; }
 2261: sub RT_awarded    { return 1; }
 2262: sub RT_tries      { return 2; }
 2263: sub RT_timestamp  { return 3; }
 2264: 
 2265: sub get_response_time_data {
 2266:     my ($sections,$groups,$enrollment,$symb,$part,$courseid) = @_;
 2267:     return undef if (! defined($symb) || 
 2268:                      ! defined($part));
 2269:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 2270:     #
 2271:     &setup_table_names($courseid);
 2272:     my $symb_id = &get_symb_id($symb);
 2273:     if (! defined($symb_id)) {
 2274:         &Apache::lonnet::logthis('Unable to find symb for '.$symb.' in '.$courseid);
 2275:         return undef;
 2276:     }
 2277:     my $part_id = &get_part_id($part);
 2278:     if (! defined($part_id)) {
 2279:         &Apache::lonnet::logthis('Unable to find id for '.$part.' in '.$courseid);
 2280:         return undef;
 2281:     }
 2282:     #
 2283:     my $dbh = &Apache::lonmysql::get_dbh();
 2284:     return undef if (! defined($dbh));
 2285:     my ($student_requirements,$enrollment_requirements) = 
 2286:         &limit_by_section_and_status($sections,$enrollment,'d');
 2287:     my ($groups_join,$group_limits) = &limit_by_group($groups,'d','e','f');
 2288:     my $request = 'SELECT '.
 2289:         'a.student_id, a.awarded, a.tries, b.timestamp '.
 2290:         'FROM '.$fulldump_part_table.' AS a '.
 2291:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
 2292:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
 2293:         'a.transaction = b.transaction '.
 2294:         'LEFT JOIN '.$student_table.' as d '.
 2295:         'ON a.student_id=d.student_id '.
 2296:         $groups_join;
 2297:     my $limit = ' WHERE '.
 2298:         'a.symb_id='.$symb_id.' AND a.part_id='.$part_id;
 2299:     if (defined($student_requirements)) {
 2300:         $limit .= ' AND '.$student_requirements;
 2301:     }
 2302:     if (defined($enrollment_requirements)) {
 2303:         $limit .= ' AND '.$enrollment_requirements;
 2304:     }
 2305:     if (defined($group_limits)) {
 2306:         $limit .= ' AND '.$group_limits;  
 2307:     }
 2308:     $request .= $limit.' ORDER BY b.timestamp';
 2309: #    &Apache::lonnet::logthis("request =\n".$request);
 2310:     my $sth = $dbh->prepare($request);
 2311:     $sth->execute();
 2312:     if ($dbh->err) {
 2313:         &Apache::lonnet::logthis('error 5 = '.$dbh->errstr());
 2314:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2315:         return undef;
 2316:     }
 2317:     my $dataset = $sth->fetchall_arrayref();
 2318:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
 2319:         return $dataset;
 2320:     }
 2321: 
 2322: }
 2323: 
 2324: sub get_student_scores {
 2325:     my ($sections,$groups,$Symbs,$enrollment,$courseid,$starttime,$endtime) = @_;
 2326:     $courseid = $env{'request.course.id'} if (! defined($courseid));
 2327:     &setup_table_names($courseid);
 2328:     my $dbh = &Apache::lonmysql::get_dbh();
 2329:     return (undef) if (! defined($dbh));
 2330:     my $tmptable = &temp_table_name($courseid,'temp_'.time);
 2331:     my $request = 'DROP TABLE IF EXISTS '.$tmptable;
 2332: #    &Apache::lonnet::logthis('request = '.$/.$request);
 2333:     $dbh->do($request);
 2334:     #
 2335:     my $symb_requirements;
 2336:     if (defined($Symbs)  && @$Symbs) {
 2337:         $symb_requirements = '('.
 2338:             join(' OR ', map{ "(a.symb_id='".&get_symb_id($_->{'symb'}).
 2339:                               "' AND a.part_id='".&get_part_id($_->{'part'}).
 2340:                               "')"
 2341:                               } @$Symbs).')';
 2342:     }
 2343:     #
 2344:     my ($student_requirements,$enrollment_requirements) = 
 2345:         &limit_by_section_and_status($sections,$enrollment,'b');
 2346:     #
 2347:     my ($groups_join,$group_limits) = &limit_by_group($groups,'b','d','e');
 2348:     my $time_requirements = &limit_by_start_end_time($starttime,$endtime,'a');
 2349:     ##
 2350:     $request = 'CREATE TEMPORARY TABLE IF NOT EXISTS '.$tmptable.
 2351:         ' SELECT a.student_id,SUM(a.awarded*c.weight) AS score FROM '.
 2352:         $performance_table.' AS a ';
 2353:     $request .= "LEFT JOIN ".$weight_table.' AS c ON a.symb_id=c.symb_id AND a.part_id=c.part_id ';
 2354:     if (defined($student_requirements) || defined($enrollment_requirements)) {
 2355:         $request .= ' LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id ';
 2356:     }
 2357:     if (defined($groups_join)) {
 2358:         $request .= $groups_join;
 2359:     }
 2360:     if (defined($symb_requirements)       || 
 2361:         defined($student_requirements)    ||
 2362:         defined($enrollment_requirements) ||
 2363:         defined($group_limits) ) {
 2364:         $request .= ' WHERE ';
 2365:     }
 2366:     if (defined($symb_requirements)) {
 2367:         $request .= $symb_requirements.' AND ';
 2368:     }
 2369:     if (defined($student_requirements)) {
 2370:         $request .= $student_requirements.' AND ';
 2371:     }
 2372:     if (defined($enrollment_requirements)) {
 2373:         $request .= $enrollment_requirements.' AND ';
 2374:     }
 2375:     if (defined($time_requirements)) {
 2376:         $request .= $time_requirements.' AND ';
 2377:     }
 2378:     $request =~ s/ AND $//; # Strip of the trailing ' AND '.
 2379:     $request .= ' GROUP BY a.student_id';
 2380: #    &Apache::lonnet::logthis("request = \n".$request);
 2381:     my $sth = $dbh->prepare($request);
 2382:     $sth->execute();
 2383:     if ($dbh->err) {
 2384:         &Apache::lonnet::logthis('error 6 = '.$dbh->errstr());
 2385:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2386:         return undef;
 2387:     }
 2388:     $request = 'SELECT score,COUNT(*) FROM '.$tmptable.' GROUP BY score';
 2389: #    &Apache::lonnet::logthis("request = \n".$request);
 2390:     $sth = $dbh->prepare($request);
 2391:     $sth->execute();
 2392:     if ($dbh->err) {
 2393:         &Apache::lonnet::logthis('error 7 = '.$dbh->errstr());
 2394:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
 2395:         return undef;
 2396:     }
 2397:     my $dataset = $sth->fetchall_arrayref();
 2398:     return $dataset;
 2399: }
 2400: 
 2401: 
 2402: 
 2403: sub setup_table_names {
 2404:     my ($courseid) = @_;
 2405:     if (! defined($courseid)) {
 2406:         $courseid = $env{'request.course.id'};
 2407:     }
 2408:     #
 2409:     if (! defined($current_course) || $current_course ne $courseid) {
 2410:         # Clear out variables
 2411:         $have_read_part_table = 0;
 2412:         undef(%ids_by_part);
 2413:         undef(%parts_by_id);
 2414:         $have_read_symb_table = 0;
 2415:         undef(%ids_by_symb);
 2416:         undef(%symbs_by_id);
 2417:         $have_read_student_table = 0;
 2418:         undef(%ids_by_student);
 2419:         undef(%students_by_id);
 2420:         $have_read_groupnames_table = 0;
 2421:         undef(%ids_by_groupname);
 2422:         #
 2423:         $current_course = $courseid;
 2424:     }
 2425:     #
 2426:     # Set up database names
 2427:     my $base_id = 'md5_'.&Digest::MD5::md5_hex($courseid);
 2428:     $symb_table               = $base_id.'_'.'symb';
 2429:     $part_table               = $base_id.'_'.'part';
 2430:     $student_table            = $base_id.'_'.'student';
 2431:     $groupnames_table         = $base_id.'_'.'groupnames';
 2432:     $students_groups_table    = $base_id.'_'.'studentgroups';
 2433:     $performance_table        = $base_id.'_'.'performance';
 2434:     $parameters_table         = $base_id.'_'.'parameters';
 2435:     $fulldump_part_table      = $base_id.'_'.'partdata';
 2436:     $fulldump_response_table  = $base_id.'_'.'responsedata';
 2437:     $fulldump_timestamp_table = $base_id.'_'.'timestampdata';
 2438:     $weight_table             = $base_id.'_'.'weight';
 2439:     #
 2440:     @Tables = (
 2441:                $symb_table,
 2442:                $part_table,
 2443:                $student_table,
 2444:                $groupnames_table,
 2445:                $students_groups_table,
 2446:                $performance_table,
 2447:                $parameters_table,
 2448:                $fulldump_part_table,
 2449:                $fulldump_response_table,
 2450:                $fulldump_timestamp_table,
 2451:                $weight_table,
 2452:                );
 2453:     return;
 2454: }
 2455: 
 2456: sub temp_table_name {
 2457:     my ($courseid,$affix) = @_;
 2458:     my $base_id = 'md5_'.&Digest::MD5::md5_hex($courseid);
 2459:     return $base_id.'_'.$affix;
 2460: }
 2461: 
 2462: 
 2463: } # End scope of table identifiers
 2464: 
 2465: 
 2466: 
 2467: sub CL_SDOM     { return 0; }
 2468: sub CL_SNAME    { return 1; }
 2469: sub CL_END      { return 2; }
 2470: sub CL_START    { return 3; }
 2471: sub CL_ID       { return 4; }
 2472: sub CL_SECTION  { return 5; }
 2473: sub CL_FULLNAME { return 6; }
 2474: sub CL_STATUS   { return 7; }
 2475: sub CL_TYPE     { return 8; }
 2476: sub CL_LOCKEDTYPE   { return 9; }
 2477: sub CL_CREDITS  { return 10; }
 2478: sub CL_INSTSEC { return 11; }
 2479: sub CL_GROUP    { return 12; }
 2480: sub CL_PERMANENTEMAIL { return 13; }
 2481: sub CL_ROLE     { return 14; }
 2482: sub CL_EXTENT   { return 15; }
 2483: sub CL_PHOTO   { return 16; }
 2484: sub CL_THUMBNAIL { return 17; }
 2485: sub CL_AUTHORQUOTA { return 18; }
 2486: sub CL_AUTHORUSAGE { return 19; }
 2487: 
 2488: sub get_classlist {
 2489:     my ($cdom,$cnum) = @_;
 2490:     my $cid = $cdom.'_'.$cnum;
 2491:     if (!defined($cdom) || !defined($cnum)) {
 2492: 	$cid =  $env{'request.course.id'};
 2493: 	$cdom = $env{'course.'.$cid.'.domain'};
 2494: 	$cnum = $env{'course.'.$cid.'.num'};
 2495:     }
 2496:     my $now = time;
 2497:     #
 2498:     my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
 2499:     while (my ($student,$info) = each(%classlist)) {
 2500:         if ($student =~ /^(con_lost|error|no_such_host)/i) {
 2501:             &Apache::lonnet::logthis('get_classlist error for '.$cid.':'.$student);
 2502:             return undef;
 2503:         }
 2504:         my ($sname,$sdom) = split(/:/,$student);
 2505:         my @Values = split(/:/,$info);
 2506:         my ($end,$start,$id,$section,$fullname,$type,$lockedtype,$credits,$instsec);
 2507:         if (@Values > 2) {
 2508:             ($end,$start,$id,$section,$fullname,$type,$lockedtype,$credits,$instsec) = @Values;
 2509:         } else { # We have to get the data ourselves
 2510:             ($end,$start) = @Values;
 2511:             $section = &Apache::lonnet::getsection($sdom,$sname,$cid);
 2512:             my %info=&Apache::lonnet::get('environment',
 2513:                                           ['firstname','middlename',
 2514:                                            'lastname','generation','id'],
 2515:                                           $sdom, $sname);
 2516:             my ($tmp) = keys(%info);
 2517:             if ($tmp =~/^(con_lost|error|no_such_host)/i) {
 2518:                 $fullname = 'not available';
 2519:                 $id = 'not available';
 2520:                 &Apache::lonnet::logthis('unable to retrieve environment '.
 2521:                                          'for '.$sname.':'.$sdom);
 2522:             } else {
 2523:                 $fullname = &Apache::lonnet::format_name(@info{qw/firstname middlename lastname generation/},'lastname');
 2524:                 $id = $info{'id'};
 2525:             }
 2526:             # Update the classlist with this students information
 2527:             if ($fullname ne 'not available') {
 2528: 		my $enrolldata = join(':',$end,$start,$id,$section,$fullname);
 2529: 		my $reply=&Apache::lonnet::cput('classlist',
 2530:                                                 {$student => $enrolldata},
 2531:                                                 $cdom,$cnum);
 2532:                 if ($reply !~ /^(ok|delayed)/) {
 2533:                     &Apache::lonnet::logthis('Unable to update classlist for '.
 2534:                                              'student '.$sname.':'.$sdom.
 2535:                                              ' error:'.$reply);
 2536:                 }
 2537:             }
 2538:         }
 2539:         my $status='Expired';
 2540:         if(((!$end) || $now < $end) && ((!$start) || ($now > $start))) {
 2541:             $status='Active';
 2542:         }
 2543:         if(($now < $start) && ((!$end) || $now < $end )) {
 2544:             $status='Future';
 2545:         }
 2546:         $classlist{$student} = 
 2547:             [$sdom,$sname,$end,$start,$id,$section,$fullname,$status,$type,
 2548:              $lockedtype,$credits,$instsec];
 2549:     }
 2550:     if (wantarray()) {
 2551:         return (\%classlist,['domain','username','end','start','id',
 2552:                              'section','fullname','status','type',
 2553:                              'lockedtype','credits','instsec']);
 2554:     } else {
 2555:         return \%classlist;
 2556:     }
 2557: }
 2558: 
 2559: sub get_group_memberships {
 2560:     my ($classlist,$keylist,$cdom,$cnum) = @_;
 2561: 
 2562:     return ({},{}) if (!ref($classlist) || !ref($keylist));
 2563: 
 2564:     my $cid = $cdom.'_'.$cnum;
 2565:     if (!defined($cdom) || !defined($cnum)) {
 2566:         $cid =  $env{'request.course.id'};
 2567:         $cdom = $env{'course.'.$cid.'.domain'};
 2568:         $cnum = $env{'course.'.$cid.'.num'};
 2569:     }
 2570:     my (%classgroups,%studentgroups);
 2571:     my $now = time;
 2572:     my $access_end = $env{'course.'.$cid.'.default_enrollment_end_date'};
 2573:     my %curr_groups =&Apache::longroup::coursegroups($cdom,$cnum);
 2574:     if (%curr_groups) {
 2575:         my $grpindex = &CL_GROUP();
 2576:         my %groupmemberhash = 
 2577: 	    &Apache::lonnet::get_group_membership($cdom,$cnum);
 2578:         foreach my $student (keys(%{$classlist})) {
 2579:             %{$classgroups{$student}} = ();
 2580:             my $hasgroup = 0;
 2581:             foreach my $status ('previous','future','active','aftercourse') {
 2582:                 %{$classgroups{$student}{$status}} = ();
 2583:             }
 2584:             foreach my $group (keys(%curr_groups)) {
 2585:                 if (defined($groupmemberhash{$group.':'.$student})) {
 2586:                     my ($end,$start) = split(/:/,$groupmemberhash{$group.':'.
 2587:                                                                     $student});
 2588:                     if ($start == -1) {
 2589:                         next;
 2590:                     } else {
 2591:                         $studentgroups{$group} ++;
 2592:                         $hasgroup = 1;
 2593:                         if ($end && $end < $now) {
 2594:                             $classgroups{$student}{'previous'}{$group} =
 2595:                                          $groupmemberhash{$group.':'.$student};
 2596:                             if ($classlist->{$student}[&CL_STATUS()] eq 'Expired') {
 2597:                                 if ($access_end && $access_end < $now) {
 2598:                                     if ($access_end - $end < 86400) {
 2599:                                         $classgroups{$student}{'aftercourse'}{$group} = $groupmemberhash{$group.':'.$student};
 2600:                                     }
 2601:                                 }
 2602:                             }
 2603:                         } elsif ($now > $start) {
 2604:                             if (!$end || $end > $now) {
 2605:                                 $classgroups{$student}{'active'}{$group} =
 2606:                                          $groupmemberhash{$group.':'.$student};
 2607:                             }
 2608:                         } else {
 2609:                             $classgroups{$student}{'future'}{$group} =
 2610:                                          $groupmemberhash{$group.':'.$student};
 2611:                         }
 2612:                     }
 2613:                 }
 2614:             }
 2615:             if (!$hasgroup) {
 2616:                 $studentgroups{'none'} ++;
 2617:             } else {
 2618:                 $classlist->{$student}->[$grpindex] = join(',',
 2619:                               sort(keys(%{$classgroups{$student}{'active'}})));
 2620:             }
 2621:         }
 2622:     }
 2623:     return (\%classgroups,\%studentgroups);
 2624: }
 2625:                                                                                    
 2626: sub get_students_groups {
 2627:     my ($student,$enrollment_status,$classgroups) = @_;
 2628:     my @studentsgroups = ();
 2629:     if (ref($$classgroups{$student}{'active'}) eq 'HASH') {
 2630:         push(@studentsgroups,keys(%{$$classgroups{$student}{'active'}}));
 2631:     }
 2632:     if ($enrollment_status eq 'Any') {
 2633:         foreach my $status ('previous','future') {
 2634:             if (ref($$classgroups{$student}{$status}) eq 'HASH') {
 2635:                 push(@studentsgroups,keys(%{$$classgroups{$student}{$status}}));
 2636:             }
 2637:         }
 2638:     } else {
 2639:         if (ref($$classgroups{$student}{'aftercourse'}) eq 'HASH') {
 2640:             push(@studentsgroups,keys(%{$$classgroups{$student}{'aftercourse'}}));
 2641:         }
 2642:     }
 2643:     return @studentsgroups;
 2644: }
 2645: 
 2646: 
 2647: # ----- END HELPER FUNCTIONS --------------------------------------------
 2648: 
 2649: 1;
 2650: __END__
 2651: 
 2652: 
 2653: =pod
 2654: 
 2655: =head1 NAME
 2656: 
 2657: Apache::loncoursedata
 2658: 
 2659: =head1 SYNOPSIS
 2660: 
 2661: Set of functions that download and process student and course information.
 2662: 
 2663: =head1 PACKAGES USED
 2664: 
 2665:   Apache::lonnet
 2666:   Apache::longroup
 2667:   Time::HiRes
 2668:   Apache::lonmysql
 2669:   LONCAPA
 2670:   Digest::MD5
 2671:  
 2672: =head1 DOWNLOAD INFORMATION
 2673: 
 2674: This section contains all the functions that get data from other servers 
 2675: and/or itself.
 2676: 
 2677: 
 2678: 
 2679: =head1 LOCAL DATA CACHING SUBROUTINES
 2680: 
 2681: The local caching is done using MySQL.  There is no fall-back implementation
 2682: if MySQL is not running.
 2683: 
 2684: The programmers interface is to call &get_current_state() or some other
 2685: primary interface subroutine (described below).  The internals of this 
 2686: storage system are documented here.
 2687: 
 2688: There are six tables used to store student performance data (the results of
 2689: a dumpcurrent).  Each of these tables is created in MySQL with a name of
 2690: $courseid_*****, where ***** is 'symb', 'part', or whatever is appropriate 
 2691: for the table.  The tables and their purposes are described below.
 2692: 
 2693: Some notes before we get started.
 2694: 
 2695: Each table must have a PRIMARY KEY, which is a column or set of columns which
 2696: will serve to uniquely identify a row of data.  NULL is not allowed!
 2697: 
 2698: INDEXes work best on integer data.
 2699: 
 2700: JOIN is used to combine data from many tables into one output.
 2701: 
 2702: lonmysql.pm is used for some of the interface, specifically the table creation
 2703: calls.  The inserts are done in bulk by directly calling the database handler.
 2704: The SELECT ... JOIN statement used to retrieve the data does not have an
 2705: interface in lonmysql.pm and I shudder at the thought of writing one.
 2706: 
 2707: =head2 Table Descriptions
 2708: 
 2709: =over 4
 2710: 
 2711: =head2 Tables used to store meta information
 2712: 
 2713: The following tables hold data required to keep track of the current status
 2714: of a students data in the tables or to look up the students data in the tables.
 2715: 
 2716: =over 4
 2717: 
 2718: =item C<$symb_table>
 2719: 
 2720: The symb_table has two columns.  The first is a 'symb_id' and the second
 2721: is the text name for the 'symb' (limited to 64k).  The 'symb_id' is generated
 2722: automatically by MySQL so inserts should be done on this table with an
 2723: empty first element.  This table has its PRIMARY KEY on the 'symb_id'.
 2724: 
 2725: =item C<$part_table>
 2726: 
 2727: The part_table has two columns.  The first is a 'part_id' and the second
 2728: is the text name for the 'part' (limited to 100 characters).  The 'part_id' is
 2729: generated automatically by MySQL so inserts should be done on this table with
 2730: an empty first element.  This table has its PRIMARY KEY on the 'part' (100
 2731: characters) and a KEY on 'part_id'.
 2732: 
 2733: =item C<$student_table>
 2734: 
 2735: The student_table has 7 columns.  The first is a 'student_id' assigned by 
 2736: MySQL.  The second is 'student' which is username:domain.  The third through
 2737: fifth are 'section', 'status' (enrollment status), and 'classification' 
 2738: (to be used in the future).  The sixth and seventh ('updatetime' and 
 2739: 'fullupdatetime') contain the time of last update and full update of student
 2740: data.  This table has its PRIMARY KEY on the 'student_id' column and is indexed
 2741: on 'student', 'section', and 'status'.
 2742: 
 2743: =item C<$groupnames_table>
 2744: 
 2745: The groupnames_table has 2 columns.  The first is a 'group_id' assigned by 
 2746: MySQL.  The second is 'groupname' which is the name of the group in the course.
 2747: 
 2748: =item C<$students_groups_table>
 2749: 
 2750: The students_groups_table has 2 columns.  The first is the 'student_id', and the 
 2751: second is the 'group_id'. These two columns comprise the PRIMARY KEY for this 
 2752: table, as an individual student may be affiliated with more than one group at
 2753: any time. This table is indexed on both student_id and group_id.
 2754: 
 2755: =back 
 2756: 
 2757: =head2 Tables used to store current status data
 2758: 
 2759: The following tables store data only about the students current status on 
 2760: a problem, meaning only the data related to the last attempt on a problem.
 2761: 
 2762: =over 4
 2763: 
 2764: =item C<$performance_table>
 2765: 
 2766: The performance_table has 9 columns.  The first three are 'symb_id', 
 2767: 'student_id', and 'part_id'.  These comprise the PRIMARY KEY for this table
 2768: and are directly related to the $symb_table, $student_table, and $part_table
 2769: described above.  MySQL does better indexing on numeric items than text,
 2770: so we use these three "index tables".  The remaining columns are
 2771: 'solved', 'tries', 'awarded', 'award', 'awarddetail', and 'timestamp'.
 2772: These are either the MySQL type TINYTEXT or various integers ('tries' and 
 2773: 'timestamp').  This table has KEYs of 'student_id' and 'symb_id'.
 2774: For use of this table, see the functions described below.
 2775: 
 2776: =item C<$parameters_table>
 2777: 
 2778: The parameters_table holds the data that does not fit neatly into the
 2779: performance_table.  The parameters table has four columns: 'symb_id',
 2780: 'student_id', 'parameter', and 'value'.  'symb_id', 'student_id', and
 2781: 'parameter' comprise the PRIMARY KEY for this table.  'parameter' is 
 2782: limited to 255 characters.  'value' is limited to 64k characters.
 2783: 
 2784: =back
 2785: 
 2786: =head2 Tables used for storing historic data
 2787: 
 2788: The following tables are used to store almost all of the transactions a student
 2789: has made on a homework problem.  See loncapa/docs/homework/datastorage for 
 2790: specific information about each of the parameters stored.  
 2791: 
 2792: =over 4
 2793: 
 2794: =item C<$fulldump_response_table>
 2795: 
 2796: The response table holds data (documented in loncapa/docs/homework/datastorage)
 2797: associated with a particular response id which is stored when a student 
 2798: attempts a problem.  The following are the columns of the table, in order:
 2799: 'symb_id','part_id','response_id','student_id','transaction','tries',
 2800: 'awarddetail', 'response_specific', 'response_specific_value',
 2801: 'response_specific_2', 'response_specific_value_2', and 'submission
 2802: (the text of the students submission).  The primary key is based on the
 2803: first five columns listed above.
 2804: 
 2805: =item C<$fulldump_part_table()>
 2806: 
 2807: The part table holds data (documented in loncapa/docs/homework/datastorage)
 2808: associated with a particular part id which is stored when a student attempts
 2809: a problem.  The following are the columns of the table, in order:
 2810: 'symb_id','part_id','student_id','transaction','tries','award','awarded',
 2811: and 'previous'.  The primary key is based on the first five columns listed 
 2812: above.
 2813: 
 2814: =item C<$fulldump_timestamp_table()>
 2815: 
 2816: The timestamp table holds the timestamps of the transactions which are
 2817: stored in $fulldump_response_table and $fulldump_part_table.  This data is
 2818: about both the response and part data.  Columns: 'symb_id','student_id',
 2819: 'transaction', and 'timestamp'.  
 2820: The primary key is based on the first 3 columns.
 2821: 
 2822: =item C<$weight_table()>
 2823: 
 2824: The weight table holds the weight for the problems used in the class.
 2825: Whereas the weight of a problem can vary by section and student the data
 2826: here is applied to the class as a whole.
 2827: Columns: 'symb_id','part_id','response_id','weight'.
 2828: 
 2829: =back
 2830: 
 2831: 
 2832: =head1 IMPORTANT SUBROUTINES
 2833: 
 2834: Here is a brief overview of the subroutines which are likely to be of 
 2835: interest:
 2836: 
 2837: =over 4
 2838: 
 2839: =item C<&get_current_state()>
 2840: 
 2841: programmers interface.
 2842: 
 2843: =item C<&init_dbs()>
 2844: 
 2845: table creation
 2846: 
 2847: =item C<&update_student_data()>
 2848: 
 2849: data storage calls
 2850: 
 2851: =item C<&get_student_data_from_performance_cache()>
 2852: 
 2853: data retrieval
 2854: 
 2855: =back
 2856: 
 2857: =head1 OTHER SUBROUTINES
 2858: 
 2859: =over 4
 2860: 
 2861: =item C<&make_into_hash($values)>
 2862: 
 2863: Returns a reference to a hash as described by $values.  $values is
 2864: assumed to be the result of 
 2865:     join(':',map {&escape($_)} %orighash);
 2866: 
 2867: This is a helper function for get_current_state.
 2868: 
 2869: =item C<&init_dbs()>
 2870: 
 2871: Input: course id
 2872: 
 2873: Output: 0 on success, positive integer on error
 2874: 
 2875: This routine issues the calls to lonmysql to create the tables used to
 2876: store student data.
 2877: 
 2878: item C<&delete_caches()>
 2879: 
 2880: This routine drops all the tables associated with a course from the 
 2881: MySQL database.
 2882: 
 2883: Input: course id (optional, determined by environment if omitted) 
 2884: 
 2885: Returns: nothing
 2886: 
 2887: =item C<&get_part_id()>
 2888: 
 2889: Get the MySQL id of a problem part string.
 2890: 
 2891: Input: $part
 2892: 
 2893: Output: undef on error, integer $part_id on success.
 2894: 
 2895: =item C<&get_part()>
 2896: 
 2897: Get the string describing a part from the MySQL id of the problem part.
 2898: 
 2899: Input: $part_id
 2900: 
 2901: Output: undef on error, $part string on success.
 2902: 
 2903: =item C<&get_symb_id()>
 2904: 
 2905: Get the MySQL id of a symb.
 2906: 
 2907: Input: $symb
 2908: 
 2909: Output: undef on error, integer $symb_id on success.
 2910: 
 2911: =item C<&get_symb()>
 2912: 
 2913: Get the symb associated with a MySQL symb_id.
 2914: 
 2915: Input: $symb_id
 2916: 
 2917: Output: undef on error, $symb on success.
 2918: 
 2919: =item C<&get_student_id()>
 2920: 
 2921: Get the MySQL id of a student.
 2922: 
 2923: Input: $sname, $dom
 2924: 
 2925: Output: undef on error, integer $student_id on success.
 2926: 
 2927: =item C<&get_student()>
 2928: 
 2929: Get student username:domain associated with the MySQL student_id.
 2930: 
 2931: Input: $student_id
 2932: 
 2933: Output: undef on error, string $student (username:domain) on success.
 2934: 
 2935: =item C<&clear_internal_caches()>
 2936: 
 2937: Causes the internal caches used in get_student_id, get_student,
 2938: get_symb_id, get_symb, get_part_id, and get_part to be undef'd.
 2939: 
 2940: Needs to be called before the first operation with the MySQL database
 2941: for a given Apache request.
 2942: 
 2943: =item C<&update_full_student_data($sname,$sdom,$courseid)>
 2944: 
 2945: Does a lonnet::dump on a student to populate the courses tables.
 2946: 
 2947: Input: $sname, $sdom, $courseid
 2948: 
 2949: Output: $returnstatus
 2950: 
 2951: $returnstatus is a string describing any errors that occurred.  'okay' is the
 2952: default.
 2953: 
 2954: This subroutine loads a students data using lonnet::dump and inserts
 2955: it into the MySQL database.  The inserts are done on three tables, 
 2956: $fulldump_response_table, $fulldump_part_table, and $fulldump_timestamp_table.
 2957: The INSERT calls are made directly by this subroutine, not through lonmysql 
 2958: because we do a 'bulk'insert which takes advantage of MySQLs non-SQL 
 2959: compliant INSERT command to insert multiple rows at a time.  
 2960: If anything has gone wrong during this process, $returnstatus is updated with 
 2961: a description of the error.
 2962: 
 2963: Once the "fulldump" tables are updated, the tables used for chart and
 2964: spreadsheet (which hold only the current state of the student on their
 2965: homework, not historical data) are updated.  If all updates have occurred 
 2966: successfully, $student_table is updated to reflect the time of the update.
 2967: 
 2968: Notice we do not insert the data and immediately query it.  This means it
 2969: is possible for there to be data returned this first time that is not 
 2970: available the second time.  CYA.
 2971: 
 2972: 
 2973: =item C<&update_student_data()>
 2974: 
 2975: Input: $sname, $sdom, $courseid
 2976: 
 2977: Output: $returnstatus, \%student_data
 2978: 
 2979: $returnstatus is a string describing any errors that occurred.  'okay' is the
 2980: default.
 2981: \%student_data is the data returned by a call to lonnet::currentdump.
 2982: 
 2983: This subroutine loads a students data using lonnet::currentdump and inserts
 2984: it into the MySQL database.  The inserts are done on two tables, 
 2985: $performance_table and $parameters_table.  $parameters_table holds the data 
 2986: that is not included in $performance_table.  See the description of 
 2987: $performance_table elsewhere in this file.  The INSERT calls are made
 2988: directly by this subroutine, not through lonmysql because we do a 'bulk'
 2989: insert which takes advantage of MySQLs non-SQL compliant INSERT command to 
 2990: insert multiple rows at a time.  If anything has gone wrong during this
 2991: process, $returnstatus is updated with a description of the error and
 2992: \%student_data is returned.  
 2993: 
 2994: Notice we do not insert the data and immediately query it.  This means it
 2995: is possible for there to be data returned this first time that is not 
 2996: available the second time.  CYA.
 2997: 
 2998: =item &ensure_tables_are_set_up($courseid)
 2999: 
 3000: Checks to be sure the MySQL tables for the given class are set up.
 3001: If $courseid is omitted it will be obtained from the environment.
 3002: 
 3003: Returns nothing on success and 'error' on failure
 3004: 
 3005: 
 3006: =item C<&ensure_current_data()>
 3007: 
 3008: Input: $sname, $sdom, $courseid
 3009: 
 3010: Output: $status, $data
 3011: 
 3012: This routine ensures the data for a given student is up to date.
 3013: The $student_table is queried to determine the time of the last update.  
 3014: If the students data is out of date, &update_student_data() is called.  
 3015: The return values from the call to &update_student_data() are returned.
 3016: 
 3017: =item C<&ensure_current_full_data($sname,$sdom,$courseid)>
 3018: 
 3019: Input: $sname, $sdom, $courseid
 3020: 
 3021: Output: $status
 3022: 
 3023: This routine ensures the fulldata (the data from a lonnet::dump, not a
 3024: lonnet::currentdump) for a given student is up to date.
 3025: The $student_table is queried to determine the time of the last update.  
 3026: If the students fulldata is out of date, &update_full_student_data() is
 3027: called.  
 3028: 
 3029: The return value from the call to &update_full_student_data() is returned.
 3030: 
 3031: =item C<&get_student_data_from_performance_cache()>
 3032: 
 3033: Input: $sname, $sdom, $symb, $courseid
 3034: 
 3035: Output: hash reference containing the data for the given student.
 3036: If $symb is undef, all the students data is returned.
 3037: 
 3038: This routine is the heart of the local caching system.  See the description
 3039: of $performance_table, $symb_table, $student_table, and $part_table.  The
 3040: main task is building the MySQL request.  The tables appear in the request
 3041: in the order in which they should be parsed by MySQL.  When searching
 3042: on a student the $student_table is used to locate the 'student_id'.  All
 3043: rows in $performance_table which have a matching 'student_id' are returned,
 3044: with data from $part_table and $symb_table which match the entries in
 3045: $performance_table, 'part_id' and 'symb_id'.  When searching on a symb,
 3046: the $symb_table is processed first, with matching rows grabbed from 
 3047: $performance_table and filled in from $part_table and $student_table in
 3048: that order.  
 3049: 
 3050: Running 'EXPLAIN ' on the 'SELECT' statements generated can be quite 
 3051: interesting, especially if you play with the order the tables are listed.  
 3052: 
 3053: 
 3054: =item C<&get_current_state()>
 3055: 
 3056: Input: $sname,$sdom,$symb,$courseid
 3057: 
 3058: Output: Described below
 3059: 
 3060: Retrieve the current status of a students performance.  $sname and
 3061: $sdom are the only required parameters.  If $symb is undef the results
 3062: of an &Apache::lonnet::currentdump() will be returned.  
 3063: If $courseid is undef it will be retrieved from the environment.
 3064: 
 3065: The return structure is based on &Apache::lonnet::currentdump.  If
 3066: $symb is unspecified, all the students data is returned in a hash of
 3067: the form:
 3068: ( 
 3069:   symb1 => { param1 => value1, param2 => value2 ... },
 3070:   symb2 => { param1 => value1, param2 => value2 ... },
 3071: )
 3072: 
 3073: If $symb is specified, a hash of 
 3074: (
 3075:   param1 => value1, 
 3076:   param2 => value2,
 3077: )
 3078: is returned.
 3079: 
 3080: If no data is found for $symb, or if the student has no performance data,
 3081: an empty list is returned.
 3082: 
 3083: =item C<&get_problem_statistics()>
 3084: 
 3085: Gather data on a given problem.  The database is assumed to be 
 3086: populated and all local caching variables are assumed to be set
 3087: properly.  This means you need to call &ensure_current_data for
 3088: the students you are concerned with prior to calling this routine.
 3089: 
 3090: Inputs: $Sections, Groups, $status, $symb, $part, $courseid, $starttime,
 3091:         $endtime
 3092: 
 3093: =over 4
 3094: 
 3095: =item $Sections Array ref containing section names for students.  
 3096: 'all' is allowed to be the first (and only) item in the array.
 3097: 
 3098: =item $Groups Array ref containing group names for students.
 3099: 'all' is allowed to be the first (and only) item in the array.
 3100: 
 3101: =item $status String describing the status of students
 3102: 
 3103: =item $symb is the symb for the problem.
 3104: 
 3105: =item $part is the part id you need statistics for
 3106: 
 3107: =item $courseid is the course id, of course!
 3108: 
 3109: =item $starttime and $endtime are unix times which to use to limit
 3110: the statistical data.
 3111: 
 3112: =back
 3113: 
 3114: Outputs: See the code for up to date information.  A hash reference is
 3115: returned.  The hash has the following keys defined:
 3116: 
 3117: =over 4
 3118: 
 3119: =item * num_students 
 3120: 
 3121: The number of students attempting the problem
 3122:       
 3123: =item tries 
 3124: 
 3125: The total number of tries for the students
 3126:       
 3127: =item max_tries 
 3128: 
 3129: The maximum number of tries taken
 3130:       
 3131: =item mean_tries 
 3132: 
 3133: The average number of tries
 3134:       
 3135: =item num_solved T
 3136: 
 3137: he number of students able to solve the problem
 3138:       
 3139: =item num_override 
 3140: 
 3141: The number of students whose answer is 'correct_by_override'
 3142:       
 3143: =item deg_of_diff 
 3144: 
 3145: The degree of difficulty of the problem
 3146:       
 3147: =item std_tries 
 3148: 
 3149: The standard deviation of the number of tries
 3150:       
 3151: =item skew_tries 
 3152: 
 3153: The skew of the number of tries
 3154: 
 3155: =item per_wrong 
 3156: 
 3157: The number of students attempting the problem who were not
 3158: able to answer it correctly.
 3159: 
 3160: =back
 3161: 
 3162: =item C<&populate_weight_table()>
 3163: 
 3164: =item C<&limit_by_start_end_times()>
 3165: 
 3166: Build SQL WHERE condition which limits the data collected by the start
 3167: and end times provided
 3168: 
 3169: Inputs: $starttime, $endtime, $table
 3170: 
 3171: Returns: $time_limits
 3172: 
 3173: 
 3174: =item C<&limit_by_section_and_status()C>
 3175: 
 3176: Build SQL WHERE condition which limits the data collected by section and
 3177: student status.
 3178: 
 3179: Inputs: $Sections (array ref)
 3180:     $enrollment (string: 'any', 'expired', 'active')
 3181:     $tablename The name of the table that holds the student data
 3182: 
 3183: Returns: $student_requirements,$enrollment_requirements
 3184: 
 3185: =item C<&limit_by_group()>
 3186:                                                                                
 3187: Build SQL LEFT JOIN statement to include students_groups and groupnames tables and SQL WHERE condition which limits the data collected by group.
 3188:                                                                                
 3189: Inputs: $Groups (array ref)
 3190:     $stutable   The name of the table which holds the student data.
 3191:     $grptable   The name of the table which maps group_id to groupname.
 3192:     $stugrptab  The name of the table which holds student group affiliations.   
 3193: Returns: $groups_join,$group_limits
 3194:    $groups_join  JOIN part of SQL statement (to include group related tables) 
 3195:    $group_limits SQL WHERE condition limiting to requested groups
 3196: 
 3197: =item C<rank_students_by_scores_on_resources()>
 3198: 
 3199: Inputs: 
 3200:     $resources: array ref of hash ref.  Each hash ref needs key 'symb'.
 3201:     $Sections: array ref of sections to include,
 3202:     $Groups: array ref of groups to include.
 3203:     $enrollment: string,
 3204:     $courseid (may be omitted)
 3205:     $starttime (may be omitted)
 3206:     $endtime (may be omitted)
 3207:     $has_award_for (may be omitted)
 3208: 
 3209: Returns; An array of arrays.  The sub arrays contain a student name and
 3210: their score on the resources. $starttime and $endtime constrain the
 3211: list to awards obtained during the given time limits. $has_score_on
 3212: constrains the list to those students who at least attempted the
 3213: resource identified by the given symb, which is used to filter out
 3214: such students for statistics that would be adversely affected by such
 3215: students.
 3216: 
 3217: =item C<&get_sum_of_scores>
 3218: 
 3219: Inputs: $resource (hash ref, needs {'symb'} key),
 3220: $part, (the part id),
 3221: $students (array ref, contents of array are scalars holding 'sname:sdom'),
 3222: $courseid
 3223: 
 3224: Returns: the sum of the score on the problem part over the students and the
 3225:    maximum possible value for the sum (taken from the weight table).
 3226:  
 3227: 
 3228: =item C<&score_stats()>
 3229: 
 3230: Inputs: $Sections, $enrollment, $symbs, $starttime,
 3231:         $endtime, $courseid
 3232: 
 3233: $Sections, $enrollment, $starttime, $endtime, and $courseid are the same as 
 3234: elsewhere in this module.  
 3235: $symbs is an array ref of symbs
 3236: 
 3237: Returns: minimum, maximum, mean, s.d., number of students, and maximum
 3238:   possible of student scores on the given resources
 3239: 
 3240: =item C<&count_stats()>
 3241: 
 3242: Inputs: $Sections, $Groups, $enrollment, $symbs, $starttime,
 3243:         $endtime, $courseid
 3244: 
 3245: $Sections, $Groups $enrollment, $starttime, $endtime, and $courseid are the 
 3246: same as elsewhere in this module.  
 3247: $symbs is an array ref of symbs
 3248: 
 3249: Returns: minimum, maximum, mean, s.d., and number of students
 3250:   of the number of items correct on the given resources
 3251: 
 3252: =item C<get_student_data()>
 3253: 
 3254: =item C<&get_student_scores($Sections,$Groups,$Symbs,$enrollment,$courseid)>
 3255: 
 3256: =item C<&setup_table_names()>
 3257: 
 3258: input: course id
 3259: 
 3260: output: none
 3261: 
 3262: =back
 3263: 
 3264: =head3 End of Local Data Caching Subroutines
 3265: 
 3266: =head3 Classlist Subroutines
 3267: 
 3268: =over
 3269: 
 3270: =item &get_classlist();
 3271: 
 3272: Retrieve the classist of a given class or of the current class.  Student
 3273: information is returned from the classlist.db file and, if needed,
 3274: from the students environment.
 3275: 
 3276: Optional arguments are $cdom, and $cnum (course domain,
 3277: and course number, respectively).  If either is ommitted the course
 3278: will be taken from the current environment ($env{'request.course.id'},
 3279: $env{'course.'.$cid.'.domain'}, and $env{'course.'.$cid.'.num'}).
 3280: 
 3281: Returns a reference to a hash which contains:
 3282:  keys    '$sname:$sdom'
 3283:  values  [$sdom,$sname,$end,$start,$id,$section,$fullname,$status,$type,
 3284:           $lockedtype,$credits,$instsec]
 3285: 
 3286: The constant values CL_SDOM, CL_SNAME, CL_END, etc. can be used
 3287: as indices into the returned list to future-proof clients against
 3288: changes in the list order.
 3289: 
 3290: =back
 3291: 
 3292: =cut
 3293: 
 3294: 

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