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

1.1       stredwic    1: # The LearningOnline Network with CAPA
                      2: #
1.197   ! raeburn     3: # $Id: loncoursedata.pm,v 1.196 2015/03/10 02:45:56 raeburn Exp $
1.1       stredwic    4: #
                      5: # Copyright Michigan State University Board of Trustees
                      6: #
                      7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      8: #
                      9: # LON-CAPA is free software; you can redistribute it and/or modify
                     10: # it under the terms of the GNU General Public License as published by
                     11: # the Free Software Foundation; either version 2 of the License, or
                     12: # (at your option) any later version.
                     13: #
                     14: # LON-CAPA is distributed in the hope that it will be useful,
                     15: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     16: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     17: # GNU General Public License for more details.
                     18: #
                     19: # You should have received a copy of the GNU General Public License
                     20: # along with LON-CAPA; if not, write to the Free Software
                     21: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     22: #
                     23: # /home/httpd/html/adm/gpl.txt
                     24: #
                     25: # http://www.lon-capa.org/
                     26: #
                     27: ###
                     28: =pod
                     29: 
                     30: =head1 NAME
                     31: 
1.189     jms        32: Apache::loncoursedata
1.1       stredwic   33: 
                     34: =head1 SYNOPSIS
                     35: 
1.22      stredwic   36: Set of functions that download and process student and course information.
1.1       stredwic   37: 
                     38: =head1 PACKAGES USED
                     39: 
1.181     albertel   40:   Apache::lonnet
                     41:   Apache::longroup
                     42:   Time::HiRes
                     43:   Apache::lonmysql
                     44:   LONCAPA
                     45:   Digest::MD5
1.190     jms        46: 
1.1       stredwic   47: =cut
                     48: 
                     49: package Apache::loncoursedata;
                     50: 
                     51: use strict;
1.146     albertel   52: use Apache::lonnet;
1.181     albertel   53: use Apache::longroup();
                     54: use Time::HiRes();
                     55: use Apache::lonmysql();
1.173     www        56: use LONCAPA;
1.181     albertel   57: use Digest::MD5();
1.1       stredwic   58: 
1.191     foxr       59: =pod 
                     60: 
1.193     raeburn    61: =head2 make_into_hash
1.191     foxr       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: 
1.47      matthew    70: sub make_into_hash {
                     71:     my $values = shift;
1.173     www        72:     my %tmp = map { &unescape($_); } split(':',$values);
1.47      matthew    73:     return \%tmp;
                     74: }
                     75: 
                     76: 
1.89      matthew    77: { # Begin scope of table identifiers
1.57      matthew    78: 
                     79: my $current_course ='';
                     80: my $symb_table;
                     81: my $part_table;
                     82: my $student_table;
1.167     raeburn    83: my $groupnames_table;
                     84: my $students_groups_table;
1.57      matthew    85: my $performance_table;
                     86: my $parameters_table;
1.89      matthew    87: my $fulldump_response_table;
                     88: my $fulldump_part_table;
                     89: my $fulldump_timestamp_table;
1.127     matthew    90: my $weight_table;
1.57      matthew    91: 
1.89      matthew    92: my @Tables;
1.57      matthew    93: 
                     94: 
                     95: 
                     96: sub init_dbs {
1.134     matthew    97:     my ($courseid,$drop) = @_;
1.57      matthew    98:     &setup_table_names($courseid);
                     99:     #
1.73      matthew   100:     # Drop any of the existing tables
1.134     matthew   101:     if ($drop) {
                    102:         foreach my $table (@Tables) {
                    103:             &Apache::lonmysql::drop_table($table);
                    104:         }
1.73      matthew   105:     }
                    106:     #
1.57      matthew   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',
1.132     matthew   132:                       type => 'VARCHAR(100) BINARY',
1.57      matthew   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',
1.132     matthew   147:                       type => 'VARCHAR(100) BINARY',
1.113     matthew   148:                       restrictions => 'NOT NULL UNIQUE'},
                    149:                     { name => 'section',
1.132     matthew   150:                       type => 'VARCHAR(100) BINARY',
1.113     matthew   151:                       restrictions => 'NOT NULL'},
1.178     albertel  152:                     { name => 'start',
                    153:                       type => 'INT',
                    154:                       restrictions => 'NOT NULL'},
                    155:                     { name => 'end',
                    156:                       type => 'INT',
1.57      matthew   157:                       restrictions => 'NOT NULL'},
1.85      matthew   158:                     { name => 'classification',
1.132     matthew   159:                       type => 'VARCHAR(100) BINARY', },
1.57      matthew   160:                     { name => 'updatetime',
1.89      matthew   161:                       type => 'INT UNSIGNED'},
                    162:                     { name => 'fullupdatetime',
                    163:                       type => 'INT UNSIGNED'},
1.57      matthew   164:                     ],
1.87      matthew   165:         'PRIMARY KEY' => ['student_id'],
1.113     matthew   166:         'KEY' => [{ columns => ['student (100)',
                    167:                                 'section (100)',
1.178     albertel  168:                                 'start',
                    169: 				'end']},],
1.57      matthew   170:     };
                    171:     #
1.167     raeburn   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:     #
1.57      matthew   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' },
1.73      matthew   214:                     { name => 'part',
1.132     matthew   215:                       type => 'VARCHAR(100) BINARY',
1.73      matthew   216:                       restrictions => 'NOT NULL'},                    
1.57      matthew   217:                     { name => 'solved',
                    218:                       type => 'TINYTEXT' },
                    219:                     { name => 'tries',
                    220:                       type => 'SMALLINT UNSIGNED' },
                    221:                     { name => 'awarded',
1.127     matthew   222:                       type => 'REAL' },
1.57      matthew   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:     #
1.89      matthew   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',
1.127     matthew   257:                       type => 'REAL' },
1.89      matthew   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',
1.132     matthew   295: #                      type => 'CHAR BINARY'},
1.89      matthew   296:                     { name => 'response_specific',
                    297:                       type => 'TINYTEXT' },
                    298:                     { name => 'response_specific_value',
                    299:                       type => 'TINYTEXT' },
1.159     albertel  300:                     { name => 'response_specific_2',
                    301:                       type => 'TINYTEXT' },
                    302:                     { name => 'response_specific_value_2',
                    303:                       type => 'TINYTEXT' },
1.89      matthew   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:     #
1.57      matthew   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:     #
1.127     matthew   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:     #
1.57      matthew   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:     }
1.89      matthew   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:     }
1.127     matthew   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:     }
1.167     raeburn   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:     }
1.57      matthew   447:     return 0;
1.70      matthew   448: }
                    449: 
1.191     foxr      450: =pod
                    451: 
                    452: =head2 delete_caches
1.70      matthew   453: 
1.191     foxr      454: Drops all of the tables in the local mysql cache associated with the
                    455: specified course id.
1.70      matthew   456: 
1.192     raeburn   457: TODO:  The drops should be pushed into lonmysql to further isolate 
1.191     foxr      458: mysql code from other modules.
                    459: 
                    460: =cut
1.70      matthew   461: sub delete_caches {
                    462:     my $courseid = shift;
1.146     albertel  463:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.70      matthew   464:     #
                    465:     &setup_table_names($courseid);
                    466:     #
                    467:     my $dbh = &Apache::lonmysql::get_dbh();
1.89      matthew   468:     foreach my $table (@Tables) {
1.70      matthew   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;
1.57      matthew   476: }
                    477: 
                    478: 
1.61      matthew   479: my $have_read_part_table = 0;
1.57      matthew   480: my %ids_by_part;
                    481: my %parts_by_id;
                    482: 
                    483: sub get_part_id {
                    484:     my ($part) = @_;
1.61      matthew   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:     }
1.57      matthew   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: 
1.61      matthew   520: my $have_read_symb_table = 0;
1.57      matthew   521: my %ids_by_symb;
                    522: my %symbs_by_id;
                    523: 
                    524: sub get_symb_id {
                    525:     my ($symb) = @_;
1.61      matthew   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:     }
1.57      matthew   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: 
1.190     jms       559: my $have_read_student_table = 0;
                    560: my %ids_by_student;
                    561: my %students_by_id;
1.57      matthew   562: 
1.190     jms       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);
1.57      matthew   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: }
1.99      matthew   599: 
1.113     matthew   600: sub populate_student_table {
                    601:     my ($courseid) = @_;
                    602:     if (! defined($courseid)) {
1.146     albertel  603:         $courseid = $env{'request.course.id'};
1.113     matthew   604:     }
                    605:     #
                    606:     &setup_table_names($courseid);
1.134     matthew   607:     &init_dbs($courseid,0);
1.113     matthew   608:     my $dbh = &Apache::lonmysql::get_dbh();
                    609:     my $request = 'INSERT IGNORE INTO '.$student_table.
1.178     albertel  610:         "(student,section,start,end) VALUES ";
1.150     albertel  611:     my $cdom = $env{'course.'.$courseid.'.domain'};
                    612:     my $cnum = $env{'course.'.$courseid.'.num'};
                    613:     my $classlist = &get_classlist($cdom,$cnum);
1.113     matthew   614:     my $student_count=0;
                    615:     while (my ($student,$data) = each %$classlist) {
1.178     albertel  616:         my ($section,$start,$end) = ($data->[&CL_SECTION()],
                    617: 				     $data->[&CL_START()],
                    618: 				     $data->[&CL_END()]);
1.113     matthew   619:         if ($section eq '' || $section =~ /^\s*$/) {
                    620:             $section = 'none';
                    621:         }
1.178     albertel  622: 	if (!defined($start)) { $start = 0; }
                    623: 	if (!defined($end))   { $end   = 0; }
                    624:         $request .= "('".$student."','".$section."','".$start."','".$end."'),";
1.113     matthew   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().
1.188     bisitz    632:                                  " occurred executing \n".
1.113     matthew   633:                                  $request);
                    634:     }
                    635:     return;
                    636: }
                    637: 
1.167     raeburn   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'};
1.171     raeburn   674:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
1.169     albertel  675:     return if (!%curr_groups);
1.167     raeburn   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().
1.188     bisitz    685:                                  " occurred executing \n".
1.167     raeburn   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'};
1.170     raeburn   733:     my ($classlist,$keylist) = &get_classlist($cdom,$cnum);
1.167     raeburn   734:     my ($classgroups,$studentgroups) = &get_group_memberships($classlist,
1.170     raeburn   735:                                                               $keylist,
1.167     raeburn   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().
1.188     bisitz    755:                                  " occurred executing \n".
1.167     raeburn   756:                                  $request);
                    757:     }
                    758:     return;
                    759: }
                    760: 
1.99      matthew   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);
1.167     raeburn   771:     $have_read_groupnames_table = 0;
                    772:     undef(%ids_by_groupname);
1.99      matthew   773: }
                    774: 
1.164     albertel  775: sub symb_is_for_task {
                    776:     my ($symb) = @_;
                    777:     return ($symb =~ /\.task$/);
                    778: }
                    779: 
1.89      matthew   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;
1.157     albertel  794:     my @tmp = &Apache::lonnet::dumpstore($courseid,$sdom,$sname);
1.89      matthew   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);
1.179     albertel  819: 	$symb = &unescape($symb);
                    820: 	$parameter = &unescape($parameter);
1.89      matthew   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);
1.98      matthew   826:             my $store_command = 'INSERT IGNORE INTO '.$fulldump_timestamp_table.
1.89      matthew   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;
1.165     albertel  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|
1.90      matthew   890:                                                   award|
                    891:                                                   awarded|
                    892:                                                   previous|
                    893:                                                   solved|
                    894:                                                   awarddetail|
                    895:                                                   submission|
                    896:                                                   submissiongrading|
                    897:                                                   molecule)\s*$/x){
1.89      matthew   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:             }
1.90      matthew   909:             # Deal with part specific data
1.89      matthew   910:             if ($field =~ /^(tries|award|awarded|previous)$/) {
                    911:                 $partdata->{$symb_id}->{$part_id}->{$transaction}->{$field}=$value;
                    912:             }
1.90      matthew   913:             # deal with response specific data
1.89      matthew   914:             if (defined($resp_id) &&
1.100     matthew   915:                 $field =~ /^(awarddetail|
1.90      matthew   916:                              submission|
                    917:                              submissiongrading|
                    918:                              molecule)$/x) {
1.89      matthew   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...
1.116     matthew   925:                     $value = $dbh->quote($value);
1.89      matthew   926:                 }
1.90      matthew   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:                 }
1.89      matthew   934:             }
                    935:         }
                    936:     }
                    937:     ##
                    938:     ## Store the part data
1.98      matthew   939:     my $store_command = 'INSERT IGNORE INTO '.$fulldump_part_table.
1.89      matthew   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,
1.101     matthew   948:                                             $data->{'tries'},
1.89      matthew   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) {
1.182     albertel  960:             $returnstatus = 'error saving part data';
1.89      matthew   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
1.98      matthew   967:     $store_command = 'INSERT IGNORE INTO '.$fulldump_response_table.
1.89      matthew   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)) {
1.112     matthew   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'},
1.162     albertel  987:                              $data->{'response_specific_value'},
1.159     albertel  988:                              $data->{'response_specific_2'},
                    989:                              $data->{'response_specific_value_2'}).
1.112     matthew   990:                              "',".$submission."),";
1.89      matthew   991:                     $store_rows++;
                    992:                 }
                    993:             }
                    994:         }
                    995:     }
                    996:     if ($store_rows) {
                    997:         chop($store_command);
                    998:         $dbh->do($store_command);
                    999:         if ($dbh->err) {
1.182     albertel 1000:             $returnstatus = 'error saving response data';
1.89      matthew  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') {
1.182     albertel 1012:         $returnstatus = 'error saving current data:'.$status;
1.89      matthew  1013:     } elsif ($status ne 'okay') {
1.182     albertel 1014:         $returnstatus .= ' error saving current data:'.$status;
1.89      matthew  1015:     }        
                   1016:     ##
                   1017:     ## Update the students time......
                   1018:     if ($returnstatus eq 'okay') {
1.113     matthew  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:         }
1.89      matthew  1027:     }
                   1028:     return $returnstatus;
                   1029: }
                   1030: 
1.57      matthew  1031: 
                   1032: sub update_student_data {
                   1033:     my ($sname,$sdom,$courseid) = @_;
                   1034:     #
1.60      matthew  1035:     # Set up database names
                   1036:     &setup_table_names($courseid);
                   1037:     #
1.57      matthew  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;
1.177     albertel 1045:     my %student_data = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
                   1046:     if (&Apache::lonnet::error(%student_data)) {
1.57      matthew  1047:         &Apache::lonnet::logthis('error getting data for '.
                   1048:                                  $sname.':'.$sdom.' in course '.$courseid.
1.177     albertel 1049:                                  ':'.(%student_data)[0]);
                   1050:         $returnstatus =(%student_data)[0] ;
1.79      matthew  1051:         return ($returnstatus,undef);
1.57      matthew  1052:     }
1.177     albertel 1053:     if (scalar(keys(%student_data)) < 1) {
1.57      matthew  1054:         return ('no data',undef);
                   1055:     }
1.89      matthew  1056:     my @Results = &store_student_data($sname,$sdom,$courseid,\%student_data);
                   1057:     #
                   1058:     # Set the students update time
1.96      matthew  1059:     if ($Results[0] eq 'okay') {
1.148     matthew  1060:         &store_updatetime($student_id,$time_of_retrieval);
1.95      matthew  1061:     }
1.89      matthew  1062:     #
                   1063:     return @Results;
                   1064: }
                   1065: 
1.113     matthew  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: 
1.89      matthew  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';
1.57      matthew  1092:     #
                   1093:     # Remove all of the students data from the table
1.60      matthew  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);
1.57      matthew  1099:     #
                   1100:     # Store away the data
                   1101:     #
                   1102:     my $starttime = Time::HiRes::time;
                   1103:     my $elapsed = 0;
                   1104:     my $rows_stored;
1.98      matthew  1105:     my $store_parameters_command  = 'INSERT IGNORE INTO '.$parameters_table.
1.60      matthew  1106:         ' VALUES '."\n";
1.61      matthew  1107:     my $num_parameters = 0;
1.98      matthew  1108:     my $store_performance_command = 'INSERT IGNORE INTO '.$performance_table.
1.60      matthew  1109:         ' VALUES '."\n";
1.79      matthew  1110:     return ('error',undef) if (! defined($dbh));
1.89      matthew  1111:     while (my ($current_symb,$param_hash) = each(%{$student_data})) {
1.57      matthew  1112:         #
                   1113:         # make sure the symb is set up properly
                   1114:         my $symb_id = &get_symb_id($current_symb);
                   1115:         #
1.147     matthew  1116:         # Parameters
1.63      matthew  1117:         while (my ($parameter,$value) = each(%$param_hash)) {
                   1118:             if ($parameter !~ /(timestamp|resource\.(.*)\.(solved|tries|awarded|award|awarddetail|previous))/) {
1.147     matthew  1119:                 my $sql_parameter = "('".join("','",
                   1120:                                               $symb_id,$student_id,
                   1121:                                               $parameter)."',".
                   1122:                                                   $dbh->quote($value)."),\n";
1.61      matthew  1123:                 $num_parameters ++;
1.147     matthew  1124:                 if ($sql_parameter !~ /''/) {
                   1125:                     $store_parameters_command .= $sql_parameter;
1.149     albertel 1126:                     #$rows_stored++;
1.57      matthew  1127:                 }
                   1128:             }
1.147     matthew  1129:         }
                   1130:         # Performance
                   1131:         my %stored;
                   1132:         while (my ($parameter,$value) = each(%$param_hash)) {
                   1133:             next if ($parameter !~ /^resource\.(.*)\.(solved|awarded)$/);
1.161     albertel 1134:             my $part  = $1;
                   1135: 	    my $which = $2;
1.151     albertel 1136: 	    next if ($part =~ /\./);
1.147     matthew  1137:             next if (exists($stored{$part}));
                   1138:             $stored{$part}++;
1.57      matthew  1139:             #
                   1140:             my $part_id = &get_part_id($part);
                   1141:             next if (!defined($part_id));
1.161     albertel 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: 	    }
1.57      matthew  1151:             my $award   = $param_hash->{'resource.'.$part.'.award'};
                   1152:             my $awarddetail = $param_hash->{'resource.'.$part.'.awarddetail'};
                   1153:             my $timestamp = $param_hash->{'timestamp'};
1.164     albertel 1154: 	    my $tries   = $param_hash->{'resource.'.$part.'.tries'};
                   1155: 	    if (&symb_is_for_task($current_symb)) {
                   1156: 		$tries   = $param_hash->{'resource.'.$part.'.version'};
                   1157: 	    }
1.60      matthew  1158:             #
1.74      matthew  1159:             $solved      = '' if (! defined($solved));
1.57      matthew  1160:             $tries       = '' if (! defined($tries));
                   1161:             $awarded     = '' if (! defined($awarded));
                   1162:             $award       = '' if (! defined($award));
                   1163:             $awarddetail = '' if (! defined($awarddetail));
1.147     matthew  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;
1.57      matthew  1169:             $rows_stored++;
                   1170:         }
                   1171:     }
1.149     albertel 1172:     if (! $rows_stored) { return ($returnstatus, undef); }
1.147     matthew  1173:     $store_parameters_command =~ s|,\n$||;
                   1174:     $store_performance_command =~ s|,\n$||;
1.57      matthew  1175:     my $start = Time::HiRes::time;
1.94      matthew  1176:     $dbh->do($store_performance_command);
                   1177:     if ($dbh->err()) {
1.147     matthew  1178:         &Apache::lonnet::logthis('performance bigass insert error:'.
                   1179:                                  $dbh->errstr());
                   1180:         &Apache::lonnet::logthis('command = '.$/.$store_performance_command);
1.94      matthew  1181:         $returnstatus = 'error: unable to insert performance into database';
                   1182:         return ($returnstatus,$student_data);
                   1183:     }
1.61      matthew  1184:     $dbh->do($store_parameters_command) if ($num_parameters>0);
1.57      matthew  1185:     if ($dbh->err()) {
1.147     matthew  1186:         &Apache::lonnet::logthis('parameters bigass insert error:'.
                   1187:                                  $dbh->errstr());
                   1188:         &Apache::lonnet::logthis('command = '.$/.$store_parameters_command);
1.87      matthew  1189:         &Apache::lonnet::logthis('rows_stored = '.$rows_stored);
                   1190:         &Apache::lonnet::logthis('student_id = '.$student_id);
1.57      matthew  1191:         $returnstatus = 'error: unable to insert parameters into database';
1.89      matthew  1192:         return ($returnstatus,$student_data);
1.57      matthew  1193:     }
                   1194:     $elapsed += Time::HiRes::time - $start;
1.89      matthew  1195:     return ($returnstatus,$student_data);
1.57      matthew  1196: }
                   1197: 
                   1198: 
1.89      matthew  1199: sub ensure_tables_are_set_up {
                   1200:     my ($courseid) = @_;
1.146     albertel 1201:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.61      matthew  1202:     # 
                   1203:     # Clean out package variables
1.57      matthew  1204:     &setup_table_names($courseid);
                   1205:     #
                   1206:     # if the tables do not exist, make them
                   1207:     my @CurrentTable = &Apache::lonmysql::tables_in_db();
1.167     raeburn  1208:     my ($found_symb,$found_student,$found_groups,$found_groupnames,$found_part,
1.89      matthew  1209:         $found_performance,$found_parameters,$found_fulldump_part,
1.127     matthew  1210:         $found_fulldump_response,$found_fulldump_timestamp,
                   1211:         $found_weight);
1.57      matthew  1212:     foreach (@CurrentTable) {
                   1213:         $found_symb        = 1 if ($_ eq $symb_table);
                   1214:         $found_student     = 1 if ($_ eq $student_table);
1.167     raeburn  1215:         $found_groups      = 1 if ($_ eq $students_groups_table);
                   1216:         $found_groupnames  = 1 if ($_ eq $groupnames_table);
1.57      matthew  1217:         $found_part        = 1 if ($_ eq $part_table);
                   1218:         $found_performance = 1 if ($_ eq $performance_table);
                   1219:         $found_parameters  = 1 if ($_ eq $parameters_table);
1.89      matthew  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);
1.127     matthew  1223:         $found_weight      = 1 if ($_ eq $weight_table);
1.57      matthew  1224:     }
1.127     matthew  1225:     if (!$found_symb          || 
                   1226:         !$found_student       || !$found_part              ||
                   1227:         !$found_performance   || !$found_parameters        ||
1.89      matthew  1228:         !$found_fulldump_part || !$found_fulldump_response ||
1.127     matthew  1229:         !$found_fulldump_timestamp || !$found_weight ) {
1.134     matthew  1230:         if (&init_dbs($courseid,1)) {
1.89      matthew  1231:             return 'error';
1.57      matthew  1232:         }
                   1233:     }
1.89      matthew  1234: }
                   1235: 
                   1236: sub ensure_current_data {
                   1237:     my ($sname,$sdom,$courseid) = @_;
                   1238:     my $status = 'okay';   # return value
                   1239:     #
1.146     albertel 1240:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.89      matthew  1241:     &ensure_tables_are_set_up($courseid);
1.57      matthew  1242:     #
                   1243:     # Get the update time for the user
                   1244:     my $updatetime = 0;
1.187     raeburn  1245:     my $getuserdir = 1;
1.60      matthew  1246:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
1.187     raeburn  1247:         ($sdom,$sname,$courseid.'.db',$getuserdir);
1.57      matthew  1248:     #
1.177     albertel 1249:     if ($modifiedtime == -1) {
                   1250: 	return ('no data',undef);
                   1251:     }
                   1252: 
1.87      matthew  1253:     my $student_id = &get_student_id($sname,$sdom);
1.196     raeburn  1254:     &get_students_groupids($student_id);
1.113     matthew  1255:     my @Result = &Apache::lonmysql::get_rows($student_table,
1.87      matthew  1256:                                              "student_id ='$student_id'");
1.57      matthew  1257:     my $data = undef;
                   1258:     if (@Result) {
1.180     albertel 1259:         $updatetime = $Result[0]->[6];  # Ack!  This is dumb!
1.57      matthew  1260:     }
                   1261:     if ($modifiedtime > $updatetime) {
                   1262:         ($status,$data) = &update_student_data($sname,$sdom,$courseid);
                   1263:     }
                   1264:     return ($status,$data);
                   1265: }
                   1266: 
1.89      matthew  1267: 
                   1268: sub ensure_current_full_data {
                   1269:     my ($sname,$sdom,$courseid) = @_;
                   1270:     my $status = 'okay';   # return value
                   1271:     #
1.146     albertel 1272:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.89      matthew  1273:     &ensure_tables_are_set_up($courseid);
                   1274:     #
                   1275:     # Get the update time for the user
1.187     raeburn  1276:     my $getuserdir = 1;
1.89      matthew  1277:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
1.187     raeburn  1278:         ($sdom,$sname,$courseid.'.db',$getuserdir);
1.89      matthew  1279:     #
                   1280:     my $student_id = &get_student_id($sname,$sdom);
1.196     raeburn  1281:     &get_students_groupids($student_id);
1.113     matthew  1282:     my @Result = &Apache::lonmysql::get_rows($student_table,
1.89      matthew  1283:                                              "student_id ='$student_id'");
                   1284:     my $updatetime;
                   1285:     if (@Result && ref($Result[0]) eq 'ARRAY') {
1.180     albertel 1286:         $updatetime = $Result[0]->[7];
1.89      matthew  1287:     }
                   1288:     if (! defined($updatetime) || $modifiedtime > $updatetime) {
                   1289:         $status = &update_full_student_data($sname,$sdom,$courseid);
                   1290:     }
                   1291:     return $status;
                   1292: }
                   1293: 
1.197   ! raeburn  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:     &ensure_tables_are_set_up($courseid);
        !          1310:     # Get the update time for the groupnames table
        !          1311:     my $getuserdir = 1;
        !          1312:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
        !          1313:         ($cdom,$cnum,'coursegroups.db',$getuserdir);
        !          1314:     my %tableinfo = &Apache::lonmysql::table_information($groupnames_table);
        !          1315:     my $updatetime;
        !          1316:     if ($tableinfo{'Update_time'}) {
        !          1317:         $updatetime = $tableinfo{'Update_time'};
        !          1318:     }
        !          1319:     print STDERR "1. updatetime is ||$updatetime|| and modifidtime is ||$modifiedtime||\n"; 
        !          1320:     if (! defined($updatetime) || $modifiedtime > $updatetime) {
        !          1321:         my (%groups_in_sql,%removegroups,$addgroup);
        !          1322:         my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
        !          1323:         my @Result = &Apache::lonmysql::get_rows($groupnames_table);
        !          1324:         foreach my $row (@Result) {
        !          1325:             my ($id,$name) = @{$row};
        !          1326:             unless (exists($curr_groups{$name})) {
        !          1327:                 $groups_in_sql{$name}=$id;
        !          1328:             } elsif ($id) {
        !          1329:                 $removegroups{$id} = $name;
        !          1330:             }
        !          1331:         }
        !          1332:         foreach my $group (keys(%curr_groups)) {
        !          1333:             unless (exists($groups_in_sql{$group})) {
        !          1334:                 $addgroup = 1;
        !          1335:                 last;
        !          1336:             }
        !          1337:         }
        !          1338:         if (keys(%removegroups)) {
        !          1339:             my $dbh = &Apache::lonmysql::get_dbh();
        !          1340:             foreach my $group_id (keys(%removegroups)) {
        !          1341:                 my $command = 'DELETE FROM '.$groupnames_table.' WHERE group_id='.
        !          1342:                               $group_id;
        !          1343:                 $dbh->do($command);
        !          1344:                 if ($dbh->err()) {
        !          1345:                     &Apache::lonnet::logthis("error ".$dbh->errstr().
        !          1346:                                              " occurred executing \n".
        !          1347:                                              "SQL command: $command");
        !          1348:                 }
        !          1349:             }
        !          1350:         }
        !          1351:         if ($addgroup) {
        !          1352:             &populate_groupnames_table($courseid);
        !          1353:         }
        !          1354:     }
        !          1355:     return;
        !          1356: }
        !          1357: 
        !          1358: sub ensure_current_students_groups {
        !          1359:     my ($courseid) = @_;
        !          1360:     my ($cdom,$cnum);
        !          1361:     if (defined($courseid)) {
        !          1362:         my %coursehash = &Apache::lonnet::coursedescription($courseid);
        !          1363:         $cdom = $coursehash{'domain'};
        !          1364:         $cnum = $coursehash{'num'};
        !          1365:     } elsif ($env{'request.course.id'}) {
        !          1366:         $courseid = $env{'request.course.id'};
        !          1367:         $cdom = $env{'course.'.$courseid.'.domain'};
        !          1368:         $cnum = $env{'course.'.$courseid.'.num'};
        !          1369:     }
        !          1370:     &ensure_tables_are_set_up($courseid);
        !          1371:     # Get the update time for the groupnames table
        !          1372:     my $getuserdir = 1;
        !          1373:     my $modifiedtime = &Apache::lonnet::GetFileTimestamp
        !          1374:         ($cdom,$cnum,'groupmembership.db',$getuserdir);
        !          1375:     my %tableinfo = &Apache::lonmysql::table_information($students_groups_table);
        !          1376:     my $updatetime;
        !          1377:     if ($tableinfo{'Update_time'}) {
        !          1378:         $updatetime = $tableinfo{'Update_time'};
        !          1379:     }
        !          1380:     print STDERR "2. updatetime is ||$updatetime|| and modifidtime is ||$modifiedtime||\n";
        !          1381:     if ((!defined($updatetime)) || ($modifiedtime > $updatetime)) {
        !          1382:         if (&Apache::lonmysql::drop_table($students_groups_table)) {
        !          1383:             if (&init_dbs($courseid)) {
        !          1384:                 return "error creating $students_groups_table\n";
        !          1385:             } else {
        !          1386:                 &populate_students_groups_table($courseid);
        !          1387:             }
        !          1388:         }
        !          1389:     }
        !          1390:     return;
        !          1391: }
1.57      matthew  1392: 
                   1393: sub get_student_data_from_performance_cache {
                   1394:     my ($sname,$sdom,$symb,$courseid)=@_;
                   1395:     my $student = $sname.':'.$sdom if (defined($sname) && defined($sdom));
1.61      matthew  1396:     &setup_table_names($courseid);
1.57      matthew  1397:     #
                   1398:     # Return hash
                   1399:     my $studentdata;
                   1400:     #
                   1401:     my $dbh = &Apache::lonmysql::get_dbh();
                   1402:     my $request = "SELECT ".
1.73      matthew  1403:         "d.symb,a.part,a.solved,a.tries,a.awarded,a.award,a.awarddetail,".
1.63      matthew  1404:             "a.timestamp ";
1.57      matthew  1405:     if (defined($student)) {
                   1406:         $request .= "FROM $student_table AS b ".
                   1407:             "LEFT JOIN $performance_table AS a ON b.student_id=a.student_id ".
1.73      matthew  1408: #            "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
1.57      matthew  1409:             "LEFT JOIN $symb_table AS d ON d.symb_id = a.symb_id ".
                   1410:                 "WHERE student='$student'";
                   1411:         if (defined($symb) && $symb ne '') {
1.67      matthew  1412:             $request .= " AND d.symb=".$dbh->quote($symb);
1.57      matthew  1413:         }
                   1414:     } elsif (defined($symb) && $symb ne '') {
                   1415:         $request .= "FROM $symb_table as d ".
                   1416:             "LEFT JOIN $performance_table AS a ON d.symb_id=a.symb_id ".
1.73      matthew  1417: #            "LEFT JOIN $part_table    AS c ON c.part_id = a.part_id ".
1.57      matthew  1418:             "LEFT JOIN $student_table AS b ON b.student_id = a.student_id ".
                   1419:                 "WHERE symb='".$dbh->quote($symb)."'";
                   1420:     }
                   1421:     my $starttime = Time::HiRes::time;
                   1422:     my $rows_retrieved = 0;
                   1423:     my $sth = $dbh->prepare($request);
                   1424:     $sth->execute();
                   1425:     if ($sth->err()) {
                   1426:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
                   1427:         &Apache::lonnet::logthis("\n".$request."\n");
                   1428:         &Apache::lonnet::logthis("error is:".$sth->errstr());
                   1429:         return undef;
                   1430:     }
                   1431:     foreach my $row (@{$sth->fetchall_arrayref}) {
                   1432:         $rows_retrieved++;
1.63      matthew  1433:         my ($symb,$part,$solved,$tries,$awarded,$award,$awarddetail,$time) = 
1.57      matthew  1434:             (@$row);
                   1435:         my $base = 'resource.'.$part;
                   1436:         $studentdata->{$symb}->{$base.'.solved'}  = $solved;
                   1437:         $studentdata->{$symb}->{$base.'.tries'}   = $tries;
                   1438:         $studentdata->{$symb}->{$base.'.awarded'} = $awarded;
                   1439:         $studentdata->{$symb}->{$base.'.award'}   = $award;
                   1440:         $studentdata->{$symb}->{$base.'.awarddetail'} = $awarddetail;
                   1441:         $studentdata->{$symb}->{'timestamp'} = $time if (defined($time) && $time ne '');
1.67      matthew  1442:     }
1.97      matthew  1443:     ## Get misc parameters
                   1444:     $request = 'SELECT c.symb,a.parameter,a.value '.
                   1445:         "FROM $student_table AS b ".
                   1446:         "LEFT JOIN $parameters_table AS a ON b.student_id=a.student_id ".
                   1447:         "LEFT JOIN $symb_table AS c ON c.symb_id = a.symb_id ".
                   1448:         "WHERE student='$student'";
                   1449:     if (defined($symb) && $symb ne '') {
                   1450:         $request .= " AND c.symb=".$dbh->quote($symb);
                   1451:     }
                   1452:     $sth = $dbh->prepare($request);
                   1453:     $sth->execute();
                   1454:     if ($sth->err()) {
                   1455:         &Apache::lonnet::logthis("Unable to execute MySQL request:");
                   1456:         &Apache::lonnet::logthis("\n".$request."\n");
                   1457:         &Apache::lonnet::logthis("error is:".$sth->errstr());
                   1458:         if (defined($symb) && $symb ne '') {
                   1459:             $studentdata = $studentdata->{$symb};
                   1460:         }
                   1461:         return $studentdata;
                   1462:     }
                   1463:     #
                   1464:     foreach my $row (@{$sth->fetchall_arrayref}) {
                   1465:         $rows_retrieved++;
                   1466:         my ($symb,$parameter,$value) = (@$row);
                   1467:         $studentdata->{$symb}->{$parameter}  = $value;
                   1468:     }
                   1469:     #
1.67      matthew  1470:     if (defined($symb) && $symb ne '') {
                   1471:         $studentdata = $studentdata->{$symb};
1.57      matthew  1472:     }
                   1473:     return $studentdata;
                   1474: }
                   1475: 
1.46      matthew  1476: 
                   1477: sub get_current_state {
1.47      matthew  1478:     my ($sname,$sdom,$symb,$courseid,$forcedownload)=@_;
                   1479:     #
1.146     albertel 1480:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.47      matthew  1481:     #
1.61      matthew  1482:     return () if (! defined($sname) || ! defined($sdom));
                   1483:     #
1.57      matthew  1484:     my ($status,$data) = &ensure_current_data($sname,$sdom,$courseid);
1.77      matthew  1485: #    &Apache::lonnet::logthis
                   1486: #        ('sname = '.$sname.
                   1487: #         ' domain = '.$sdom.
                   1488: #         ' status = '.$status.
                   1489: #         ' data is '.(defined($data)?'defined':'undefined'));
1.73      matthew  1490: #    while (my ($symb,$hash) = each(%$data)) {
                   1491: #        &Apache::lonnet::logthis($symb."\n----------------------------------");
                   1492: #        while (my ($key,$value) = each (%$hash)) {
                   1493: #            &Apache::lonnet::logthis("   ".$key." = ".$value);
                   1494: #        }
                   1495: #    }
1.47      matthew  1496:     #
1.79      matthew  1497:     if (defined($data) && defined($symb) && ref($data->{$symb})) {
                   1498:         return %{$data->{$symb}};
                   1499:     } elsif (defined($data) && ! defined($symb) && ref($data)) {
                   1500:         return %$data;
                   1501:     } 
                   1502:     if ($status eq 'no data') {
1.57      matthew  1503:         return ();
                   1504:     } else {
                   1505:         if ($status ne 'okay' && $status ne '') {
                   1506:             &Apache::lonnet::logthis('status = '.$status);
1.177     albertel 1507:             return ('error: '.$status,undef);
1.47      matthew  1508:         }
1.57      matthew  1509:         my $returnhash = &get_student_data_from_performance_cache($sname,$sdom,
                   1510:                                                       $symb,$courseid);
                   1511:         return %$returnhash if (defined($returnhash));
1.46      matthew  1512:     }
1.57      matthew  1513:     return ();
1.61      matthew  1514: }
                   1515: 
                   1516: 
1.190     jms      1517: sub get_problem_statistics {
                   1518:     my ($Sections,$Groups,$status,$symb,$part,$courseid,$starttime,$endtime) = @_;
                   1519:     return if (! defined($symb) || ! defined($part));
                   1520:     $courseid = $env{'request.course.id'} if (! defined($courseid));
                   1521:     #
                   1522:     &setup_table_names($courseid);
                   1523:     my $symb_id = &get_symb_id($symb);
                   1524:     my $part_id = &get_part_id($part);
                   1525:     my $stats_table = &temp_table_name($courseid,'problem_stats');
                   1526:     #
                   1527:     my $dbh = &Apache::lonmysql::get_dbh();
                   1528:     return undef if (! defined($dbh));
                   1529:     #
                   1530:     # Clean out the table
                   1531:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
                   1532:     my $request = 
                   1533:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
                   1534:         'SELECT a.student_id,a.solved,a.award,a.awarded,a.tries '.
                   1535:         'FROM '.$performance_table.' AS a ';
                   1536:     #
                   1537:     # See if we need to include some requirements on the students
                   1538:     if ((defined($Sections) && lc($Sections->[0]) ne 'all') || 
                   1539:         (defined($status)   && lc($status)        ne 'any')) {
                   1540:         $request .= 'NATURAL LEFT JOIN '.$student_table.' AS b ';
                   1541:     }
                   1542:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
                   1543:     if (defined($groups_join)) {
                   1544:         $request .= $groups_join;
                   1545:     }
                   1546:     $request .= ' WHERE a.symb_id='.$symb_id.' AND a.part_id='.$part_id;
                   1547:     #
                   1548:     # Limit the students included to those specified
                   1549:     my ($section_limits,$enrollment_limits)=
                   1550:         &limit_by_section_and_status($Sections,$status,'b');
                   1551:     #
                   1552:     # Limit by starttime and endtime
                   1553:     my $time_requirements = undef;
                   1554:     if (defined($starttime)) {
                   1555:         $time_requirements .= 'a.timestamp>='.$starttime;
                   1556:         if (defined($endtime)) {
                   1557:             $time_requirements .= ' AND a.timestamp<='.$endtime;
                   1558:         }
                   1559:     } elsif (defined($endtime)) {
                   1560:         $time_requirements .= 'a.timestamp<='.$endtime;
1.122     matthew  1561:     }
                   1562:     if (defined($time_requirements)) {
                   1563:         $request .= ' AND '.$time_requirements;
1.115     matthew  1564:     }
1.178     albertel 1565:     if (defined($section_limits)) {
                   1566:         $request .= ' AND '.$section_limits;
                   1567:     }
                   1568:     if (defined($enrollment_limits)) {
                   1569:         $request .= ' AND '.$enrollment_limits;
                   1570:     }
1.167     raeburn  1571:     # Limit by group, as required
                   1572:     if (defined($group_limits)) {
                   1573:         $request .= ' AND '.$group_limits;
                   1574:     }
1.123     matthew  1575:     #
                   1576:     # Finally, execute the request to create the temporary table
1.61      matthew  1577:     $dbh->do($request);
1.123     matthew  1578:     #
                   1579:     # Collect the first suite of statistics
1.128     matthew  1580:     $request = 'SELECT COUNT(*),SUM(tries),'.
                   1581:         'AVG(tries),STD(tries) '.
1.109     matthew  1582:         'FROM '.$stats_table;
1.128     matthew  1583:     my ($num,$tries,$mean,$STD) = &execute_SQL_request
1.109     matthew  1584:         ($dbh,$request);
1.128     matthew  1585:     #
                   1586:     $request = 'SELECT MAX(tries),MIN(tries) FROM '.$stats_table.
                   1587:         ' WHERE awarded>0';
                   1588:     if (defined($time_requirements)) {
                   1589:         $request .= ' AND '.$time_requirements;
                   1590:     }
                   1591:     my ($max,$min) = &execute_SQL_request($dbh,$request);
                   1592:     #
1.109     matthew  1593:     $request = 'SELECT SUM(awarded) FROM '.$stats_table;
1.128     matthew  1594:     if (defined($time_requirements)) {
                   1595:         $request .= ' AND '.$time_requirements;
                   1596:     }
1.109     matthew  1597:     my ($Solved) = &execute_SQL_request($dbh,$request);
1.128     matthew  1598:     #
1.109     matthew  1599:     $request = 'SELECT SUM(awarded) FROM '.$stats_table.
                   1600:         " WHERE solved='correct_by_override'";
1.128     matthew  1601:     if (defined($time_requirements)) {
                   1602:         $request .= ' AND '.$time_requirements;
                   1603:     }
1.109     matthew  1604:     my ($solved) = &execute_SQL_request($dbh,$request);
                   1605:     #
1.133     matthew  1606:     $Solved -= $solved;
                   1607:     #
1.61      matthew  1608:     $num    = 0 if (! defined($num));
                   1609:     $tries  = 0 if (! defined($tries));
1.128     matthew  1610:     $max    = 0 if (! defined($max));
                   1611:     $min    = 0 if (! defined($min));
1.61      matthew  1612:     $STD    = 0 if (! defined($STD));
1.133     matthew  1613:     $Solved = 0 if (! defined($Solved) || $Solved < 0);
1.61      matthew  1614:     $solved = 0 if (! defined($solved));
                   1615:     #
1.123     matthew  1616:     # Compute the more complicated statistics
1.61      matthew  1617:     my $DegOfDiff = 'nan';
1.66      matthew  1618:     $DegOfDiff = 1-($Solved)/$tries if ($tries>0);
1.123     matthew  1619:     #
1.61      matthew  1620:     my $SKEW = 'nan';
1.66      matthew  1621:     my $wrongpercent = 0;
1.128     matthew  1622:     my $numwrong = 'nan';
1.61      matthew  1623:     if ($num > 0) {
                   1624:         ($SKEW) = &execute_SQL_request($dbh,'SELECT SQRT(SUM('.
                   1625:                                      'POWER(tries - '.$STD.',3)'.
                   1626:                                      '))/'.$num.' FROM '.$stats_table);
1.128     matthew  1627:         $numwrong = $num-$Solved;
                   1628:         $wrongpercent=int(10*100*$numwrong/$num)/10;
1.61      matthew  1629:     }
                   1630:     #
1.123     matthew  1631:     # Drop the temporary table
                   1632:     $dbh->do('DROP TABLE '.$stats_table);  # May return an error
1.81      matthew  1633:     #
                   1634:     # Return result
1.66      matthew  1635:     return { num_students => $num,
                   1636:              tries        => $tries,
1.128     matthew  1637:              max_tries    => $max,
                   1638:              min_tries    => $min,
1.66      matthew  1639:              mean_tries   => $mean,
                   1640:              std_tries    => $STD,
                   1641:              skew_tries   => $SKEW,
                   1642:              num_solved   => $Solved,
                   1643:              num_override => $solved,
1.128     matthew  1644:              num_wrong    => $numwrong,
1.66      matthew  1645:              per_wrong    => $wrongpercent,
1.81      matthew  1646:              deg_of_diff  => $DegOfDiff };
1.61      matthew  1647: }
                   1648: 
1.127     matthew  1649: ##
                   1650: ## This is a helper for get_statistics
1.61      matthew  1651: sub execute_SQL_request {
                   1652:     my ($dbh,$request)=@_;
                   1653: #    &Apache::lonnet::logthis($request);
                   1654:     my $sth = $dbh->prepare($request);
1.153     albertel 1655:     if (!$sth) {
                   1656: 	die($dbh->errstr . " SQL: $request");
                   1657:     }
1.61      matthew  1658:     $sth->execute();
                   1659:     my $row = $sth->fetchrow_arrayref();
                   1660:     if (ref($row) eq 'ARRAY' && scalar(@$row)>0) {
                   1661:         return @$row;
                   1662:     }
                   1663:     return ();
                   1664: }
1.123     matthew  1665: 
1.127     matthew  1666: 
                   1667: sub populate_weight_table {
                   1668:     my ($courseid) = @_;
                   1669:     if (! defined($courseid)) {
1.146     albertel 1670:         $courseid = $env{'request.course.id'};
1.127     matthew  1671:     }
                   1672:     #
                   1673:     &setup_table_names($courseid);
1.144     matthew  1674:     my $navmap = Apache::lonnavmaps::navmap->new();
                   1675:     if (!defined($navmap)) {
                   1676:         &Apache::lonnet::logthis('loncoursedata::populate_weight_table:'.$/.
                   1677:                                  '  unable to get navmaps resource'.$/.
                   1678:                                  '  '.join(' ',(caller)));
                   1679:         return;
                   1680:     }
                   1681:     my @sequences = $navmap->retrieveResources(undef,
                   1682:                                                sub { shift->is_map(); },1,0,1);
                   1683:     my @resources;
                   1684:     foreach my $seq (@sequences) {
                   1685:         push(@resources,$navmap->retrieveResources($seq,
                   1686:                                                    sub {shift->is_problem();},
                   1687:                                                    0,0,0));
                   1688:     }
                   1689:     if (! scalar(@resources)) {
                   1690:         &Apache::lonnet::logthis('loncoursedata::populate_weight_table:'.$/.
                   1691:                                  ' no resources returned for '.$courseid);
1.127     matthew  1692:         return;
                   1693:     }
                   1694:     #       Since we use lonnet::EXT to retrieve problem weights,
                   1695:     #       to ensure current data we must clear the caches out.
                   1696:     &Apache::lonnet::clear_EXT_cache_status();
                   1697:     my $dbh = &Apache::lonmysql::get_dbh();
                   1698:     my $request = 'INSERT IGNORE INTO '.$weight_table.
                   1699:         "(symb_id,part_id,weight) VALUES ";
                   1700:     my $weight;
1.144     matthew  1701:     foreach my $res (@resources) {
                   1702:         my $symb_id = &get_symb_id($res->symb);
                   1703:         foreach my $part (@{$res->parts}) {
1.127     matthew  1704:             my $part_id = &get_part_id($part);
                   1705:             $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
1.144     matthew  1706:                                            $res->symb,
1.127     matthew  1707:                                            undef,undef,undef);
                   1708:             if (!defined($weight) || ($weight eq '')) { 
                   1709:                 $weight=1;
                   1710:             }
                   1711:             $request .= "('".$symb_id."','".$part_id."','".$weight."'),";
                   1712:         }
                   1713:     }
                   1714:     $request =~ s/(,)$//;
                   1715: #    &Apache::lonnet::logthis('request = '.$/.$request);
                   1716:     $dbh->do($request);
                   1717:     if ($dbh->err()) {
                   1718:         &Apache::lonnet::logthis("error ".$dbh->errstr().
1.188     bisitz   1719:                                  " occurred executing \n".
1.127     matthew  1720:                                  $request);
                   1721:     }
                   1722:     return;
                   1723: }
                   1724: 
1.129     matthew  1725: sub limit_by_start_end_time {
                   1726:     my ($starttime,$endtime,$table) = @_;
                   1727:     my $time_requirements = undef;
                   1728:     if (defined($starttime)) {
                   1729:         $time_requirements .= $table.".timestamp>='".$starttime."'";
                   1730:         if (defined($endtime)) {
                   1731:             $time_requirements .= " AND ".$table.".timestamp<='".$endtime."'";
                   1732:         }
                   1733:     } elsif (defined($endtime)) {
                   1734:         $time_requirements .= $table.".timestamp<='".$endtime."'";
                   1735:     }
                   1736:     return $time_requirements;
                   1737: }
                   1738: 
1.127     matthew  1739: 
                   1740: sub limit_by_section_and_status {
                   1741:     my ($Sections,$enrollment,$tablename) = @_;
                   1742:     my $student_requirements = undef;
                   1743:     if ( (defined($Sections) && $Sections->[0] ne 'all')) {
                   1744:         $student_requirements = '('.
                   1745:             join(' OR ', map { $tablename.".section='".$_."'" } @$Sections
                   1746:                  ).')';
                   1747:     }
                   1748:     my $enrollment_requirements=undef;
                   1749:     if (defined($enrollment) && $enrollment ne 'Any') {
1.178     albertel 1750: 	my $now = time();
                   1751: 	if ( $enrollment eq 'Future' ) {
                   1752: 	    $enrollment_requirements = 
                   1753: 		"( $tablename.start > $now AND ".
                   1754: 		"( $tablename.end = 0 OR $tablename.end > $now))";
                   1755: 	} elsif ( $enrollment eq 'Active' ) {
                   1756: 	    $enrollment_requirements = 
                   1757: 		"(( $tablename.start = 0 OR $tablename.start < $now )  AND ".
                   1758: 		" ( $tablename.end   = 0 OR $tablename.end   > $now ))";
                   1759: 	} elsif ( $enrollment eq 'Expired' ) {
                   1760: 	    $enrollment_requirements = 
                   1761: 		"(( $tablename.start < $now )  AND ".
                   1762: 		" ( $tablename.end   < $now ))";
                   1763: 	}
1.127     matthew  1764:     }
                   1765:     return ($student_requirements,$enrollment_requirements);
                   1766: }
                   1767: 
1.190     jms      1768: 
1.167     raeburn  1769: 
                   1770: sub limit_by_group {
                   1771:     my ($Groups,$stutable,$grptable,$stugrptab) = @_;
                   1772:     my $groups_join = undef;
                   1773:     my $group_limits = undef;
                   1774:     if ( (defined($Groups) && $Groups->[0] ne 'all')) {
                   1775:         $groups_join =
                   1776:           ' LEFT JOIN '.$students_groups_table.
                   1777:                      ' AS '.$stugrptab.' ON '.
                   1778:                      $stugrptab.'.student_id = '.$stutable.'.student_id'.
                   1779:           ' LEFT JOIN '.$groupnames_table.
                   1780:                      ' AS '.$grptable.' ON '.
                   1781:                      $stugrptab.'.group_id = '.$grptable.'.group_id ';
                   1782:         $group_limits =
                   1783:           ' ('.
                   1784:              join(' OR ', map {  "$grptable.groupname='".$_."'" } @$Groups
                   1785:            ).')';
                   1786:     }
                   1787:     return ($groups_join,$group_limits);
                   1788: }
1.127     matthew  1789: 
                   1790: 
                   1791: sub RNK_student { return 0; };
                   1792: sub RNK_score   { return 1; };
                   1793: 
                   1794: sub rank_students_by_scores_on_resources {
1.167     raeburn  1795:     my ($resources,$Sections,$Groups,$enrollment,$courseid,$starttime,$endtime,
                   1796:         $has_award_for) = @_;
1.127     matthew  1797:     return if (! defined($resources) || ! ref($resources) eq 'ARRAY');
                   1798:     if (! defined($courseid)) {
1.146     albertel 1799:         $courseid = $env{'request.course.id'};
1.127     matthew  1800:     }
                   1801:     #
                   1802:     &setup_table_names($courseid);
                   1803:     my $dbh = &Apache::lonmysql::get_dbh();
                   1804:     my ($section_limits,$enrollment_limits)=
                   1805:         &limit_by_section_and_status($Sections,$enrollment,'b');
1.167     raeburn  1806:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
1.127     matthew  1807:     my $symb_limits = '('.join(' OR ',map {'a.symb_id='.&get_symb_id($_);
                   1808:                                        } @$resources
                   1809:                                ).')';
1.154     bowersj2 1810:     my ($award_col, $award_join, $award_clause) = ('', '', '');
1.155     albertel 1811:     if ($has_award_for) {
1.154     bowersj2 1812:         my $resource_id = &get_symb_id($has_award_for);
                   1813:         $award_col = ", perf.awarded";
                   1814:         $award_join = "LEFT JOIN $performance_table AS perf ON perf.symb_id"
                   1815:             ." = $resource_id AND perf.student_id = b.student_id ";
                   1816:         $award_clause = "AND perf.awarded IS NOT NULL";
                   1817:     }
1.130     matthew  1818:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
1.154     bowersj2 1819:     my $request = "SELECT b.student,SUM(a.awarded*w.weight) AS score "
                   1820:         ."$award_col FROM $performance_table AS a ".
                   1821:         "NATURAL LEFT JOIN $weight_table AS w ".
                   1822:         "LEFT JOIN $student_table AS b ON a.student_id=b.student_id ".
1.167     raeburn  1823:         "$award_join $groups_join "; 
                   1824:     my $limits;
1.127     matthew  1825:     if (defined($section_limits)) {
1.167     raeburn  1826:         $limits .= $section_limits.' AND ';
1.127     matthew  1827:     }
                   1828:     if (defined($enrollment_limits)) {
1.167     raeburn  1829:         $limits .= $enrollment_limits.' AND ';
1.127     matthew  1830:     }
1.130     matthew  1831:     if (defined($time_limits)) {
1.167     raeburn  1832:         $limits .= $time_limits.' AND ';
1.130     matthew  1833:     }
1.127     matthew  1834:     if ($symb_limits ne '()') {
1.167     raeburn  1835:         $limits .= $symb_limits.' AND ';
                   1836:     }
                   1837:     if (defined($group_limits)) {
                   1838:         $limits .= $group_limits.' AND ';
1.127     matthew  1839:     }
1.167     raeburn  1840:     if ($limits) {
                   1841:         $limits =~ s/( AND )$//;   # Remove extra conjunction
                   1842:         $request .= "WHERE $limits";
                   1843:     } 
1.154     bowersj2 1844:     $request .= " $award_clause GROUP BY a.student_id ORDER BY score";
1.127     matthew  1845:     #&Apache::lonnet::logthis('request = '.$/.$request);
1.154     bowersj2 1846:     my $sth = $dbh->prepare($request) or die "Can't prepare $request";
1.127     matthew  1847:     $sth->execute();
                   1848:     my $rows = $sth->fetchall_arrayref();
                   1849:     return ($rows);
                   1850: }
                   1851: 
                   1852: sub get_sum_of_scores {
1.143     matthew  1853:     my ($symb,$part,$students,$courseid,$starttime,$endtime) = @_;
1.127     matthew  1854:     if (! defined($courseid)) {
1.146     albertel 1855:         $courseid = $env{'request.course.id'};
1.127     matthew  1856:     }
1.138     matthew  1857:     if (defined($students) && 
                   1858:         ((@$students == 0) ||
                   1859:          (@$students == 1 && (! defined($students->[0]) || 
                   1860:                               $students->[0] eq ''))
                   1861:          )
                   1862:         ){
                   1863:         undef($students);
                   1864:     }
1.127     matthew  1865:     #
                   1866:     &setup_table_names($courseid);
                   1867:     my $dbh = &Apache::lonmysql::get_dbh();
1.130     matthew  1868:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
1.127     matthew  1869:     my $request = 'SELECT SUM(a.awarded*w.weight),SUM(w.weight) FROM '.
                   1870:         $performance_table.' AS a '.
                   1871:         'NATURAL LEFT JOIN '.$weight_table.' AS w ';
1.143     matthew  1872:     $request .= 'WHERE a.symb_id='.&get_symb_id($symb).
1.127     matthew  1873:         ' AND a.part_id='.&get_part_id($part);
1.130     matthew  1874:     if (defined($time_limits)) {
                   1875:         $request .= ' AND '.$time_limits;
                   1876:     }
1.127     matthew  1877:     if (defined($students)) {
                   1878:         $request .= ' AND ('.
                   1879:             join(' OR ',map {'a.student_id='.&get_student_id(split(':',$_));
                   1880:                          } @$students).
                   1881:                              ')';
                   1882:     }
                   1883:     my $sth = $dbh->prepare($request);
                   1884:     $sth->execute();
                   1885:     my $rows = $sth->fetchrow_arrayref();
                   1886:     if ($dbh->err) {
1.138     matthew  1887:         &Apache::lonnet::logthis('error 1 = '.$dbh->errstr());
                   1888:         &Apache::lonnet::logthis('prepared then executed, fetchrow_arrayrefed'.
                   1889:                                  $/.$request);
1.127     matthew  1890:         return (undef,undef);
                   1891:     }
                   1892:     return ($rows->[0],$rows->[1]);
                   1893: }
                   1894: 
1.129     matthew  1895: 
                   1896: sub score_stats {
1.167     raeburn  1897:     my ($Sections,$Groups,$enrollment,$symbs,$starttime,$endtime,$courseid)=@_;
1.129     matthew  1898:     if (! defined($courseid)) {
1.146     albertel 1899:         $courseid = $env{'request.course.id'};
1.129     matthew  1900:     }
                   1901:     #
                   1902:     &setup_table_names($courseid);
                   1903:     my $dbh = &Apache::lonmysql::get_dbh();
                   1904:     #
                   1905:     my ($section_limits,$enrollment_limits)=
                   1906:         &limit_by_section_and_status($Sections,$enrollment,'b');
1.167     raeburn  1907:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
1.129     matthew  1908:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
                   1909:     my @Symbids = map { &get_symb_id($_); } @{$symbs};
                   1910:     #
1.181     albertel 1911:     my $stats_table = &temp_table_name($courseid,'problem_stats');
1.129     matthew  1912:     my $symb_restriction = join(' OR ',map {'a.symb_id='.$_;} @Symbids);
                   1913:     my $request = 'DROP TABLE '.$stats_table;
                   1914:     $dbh->do($request);
                   1915:     $request = 
                   1916:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
                   1917:         'SELECT a.student_id,'.
                   1918:         'SUM(a.awarded*w.weight) AS score FROM '.
                   1919:         $performance_table.' AS a '.
                   1920:         'NATURAL LEFT JOIN '.$weight_table.' AS w '.
                   1921:         'LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id '.
1.167     raeburn  1922:         $groups_join;
                   1923:     my $limit = ' WHERE ('.$symb_restriction.')';
1.129     matthew  1924:     if ($time_limits) {
1.167     raeburn  1925:         $limit .= ' AND '.$time_limits;
1.129     matthew  1926:     }
                   1927:     if ($section_limits) {
1.167     raeburn  1928:         $limit .= ' AND '.$section_limits;
1.129     matthew  1929:     }
                   1930:     if ($enrollment_limits) {
1.167     raeburn  1931:         $limit .= ' AND '.$enrollment_limits;
1.129     matthew  1932:     }
1.167     raeburn  1933:     if ($group_limits) {
                   1934:         $limit .= ' AND '.$group_limits;
                   1935:     }
                   1936:     $request .= $limit.' GROUP BY a.student_id';
1.129     matthew  1937: #    &Apache::lonnet::logthis('request = '.$/.$request);
                   1938:     my $sth = $dbh->prepare($request);
                   1939:     $sth->execute();
                   1940:     $request = 
                   1941:         'SELECT AVG(score),STD(score),MAX(score),MIN(score),COUNT(score) '.
                   1942:         'FROM '.$stats_table;
                   1943:     my ($ave,$std,$max,$min,$count) = &execute_SQL_request($dbh,$request);
                   1944: #    &Apache::lonnet::logthis('request = '.$/.$request);
                   1945:     
                   1946:     $request = 'SELECT SUM(weight) FROM '.$weight_table.
1.152     bowersj2 1947:         ' AS a WHERE ('.$symb_restriction.')';
1.129     matthew  1948:     my ($max_possible) = &execute_SQL_request($dbh,$request);
                   1949:     # &Apache::lonnet::logthis('request = '.$/.$request);
                   1950:     return($min,$max,$ave,$std,$count,$max_possible);
                   1951: }
                   1952: 
                   1953: 
                   1954: 
                   1955: sub count_stats {
1.167     raeburn  1956:     my ($Sections,$Groups,$enrollment,$symbs,$starttime,$endtime,$courseid)=@_;
1.129     matthew  1957:     if (! defined($courseid)) {
1.146     albertel 1958:         $courseid = $env{'request.course.id'};
1.129     matthew  1959:     }
                   1960:     #
                   1961:     &setup_table_names($courseid);
                   1962:     my $dbh = &Apache::lonmysql::get_dbh();
                   1963:     #
                   1964:     my ($section_limits,$enrollment_limits)=
                   1965:         &limit_by_section_and_status($Sections,$enrollment,'b');
1.167     raeburn  1966:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'b','c','d');
1.129     matthew  1967:     my $time_limits = &limit_by_start_end_time($starttime,$endtime,'a');
                   1968:     my @Symbids = map { &get_symb_id($_); } @{$symbs};
                   1969:     #
1.181     albertel 1970:     my $stats_table = &temp_table_name($courseid,'problem_stats');
1.129     matthew  1971:     my $symb_restriction = join(' OR ',map {'a.symb_id='.$_;} @Symbids);
                   1972:     my $request = 'DROP TABLE '.$stats_table;
                   1973:     $dbh->do($request);
                   1974:     $request = 
                   1975:         'CREATE TEMPORARY TABLE '.$stats_table.' '.
                   1976:         'SELECT a.student_id,'.
1.151     albertel 1977:         'SUM(a.awarded) AS count FROM '.
1.129     matthew  1978:         $performance_table.' AS a '.
                   1979:         'LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id '.
1.167     raeburn  1980:         $groups_join;
                   1981:     my $limit =  ' WHERE ('.$symb_restriction.')';
1.129     matthew  1982:     if ($time_limits) {
1.167     raeburn  1983:         $limit .= ' AND '.$time_limits;
1.129     matthew  1984:     }
                   1985:     if ($section_limits) {
1.167     raeburn  1986:         $limit .= ' AND '.$section_limits;
1.129     matthew  1987:     }
                   1988:     if ($enrollment_limits) {
1.167     raeburn  1989:         $limit .= ' AND '.$enrollment_limits;
1.129     matthew  1990:     }
1.167     raeburn  1991:     if ($group_limits) {
1.168     raeburn  1992:         $limit .= ' AND '.$group_limits;
1.167     raeburn  1993:     }
                   1994:     $request .= $limit.' GROUP BY a.student_id';
1.131     matthew  1995: #    &Apache::lonnet::logthis('request = '.$/.$request);
1.129     matthew  1996:     my $sth = $dbh->prepare($request);
                   1997:     $sth->execute();
                   1998:     $request = 
                   1999:         'SELECT AVG(count),STD(count),MAX(count),MIN(count),COUNT(count) '.
                   2000:         'FROM '.$stats_table;
                   2001:     my ($ave,$std,$max,$min,$count) = &execute_SQL_request($dbh,$request);
1.131     matthew  2002: #    &Apache::lonnet::logthis('request = '.$/.$request);
1.129     matthew  2003:     return($min,$max,$ave,$std,$count);
                   2004: }
1.127     matthew  2005: 
                   2006: 
1.105     matthew  2007: sub get_student_data {
                   2008:     my ($students,$courseid) = @_;
1.146     albertel 2009:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.105     matthew  2010:     &setup_table_names($courseid);
                   2011:     my $dbh = &Apache::lonmysql::get_dbh();
                   2012:     return undef if (! defined($dbh));
                   2013:     my $request = 'SELECT '.
                   2014:         'student_id, student '.
                   2015:         'FROM '.$student_table;
                   2016:     if (defined($students)) {
                   2017:         $request .= ' WHERE ('.
                   2018:             join(' OR ', map {'student_id='.
                   2019:                                   &get_student_id($_->{'username'},
                   2020:                                                   $_->{'domain'})
                   2021:                               } @$students
                   2022:                  ).')';
                   2023:     }
                   2024:     $request.= ' ORDER BY student_id';
                   2025:     my $sth = $dbh->prepare($request);
                   2026:     $sth->execute();
                   2027:     if ($dbh->err) {
1.138     matthew  2028:         &Apache::lonnet::logthis('error 2 = '.$dbh->errstr());
                   2029:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.105     matthew  2030:         return undef;
                   2031:     }
                   2032:     my $dataset = $sth->fetchall_arrayref();
                   2033:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
                   2034:         return $dataset;
                   2035:     }
                   2036: }
                   2037: 
1.159     albertel 2038: sub RD_student_id      { return 0; }
                   2039: sub RD_awarddetail     { return 1; }
                   2040: sub RD_response_eval   { return 2; }
                   2041: sub RD_response_eval_2 { return 3; }
                   2042: sub RD_submission      { return 4; }
                   2043: sub RD_timestamp       { return 5; }
                   2044: sub RD_tries           { return 6; }
                   2045: sub RD_sname           { return 7; }
1.108     matthew  2046: 
                   2047: sub get_response_data {
1.167     raeburn  2048:     my ($Sections,$Groups,$enrollment,$symb,$response,$courseid) = @_;
1.103     matthew  2049:     return undef if (! defined($symb) || 
1.100     matthew  2050:                ! defined($response));
1.146     albertel 2051:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.100     matthew  2052:     #
                   2053:     &setup_table_names($courseid);
                   2054:     my $symb_id = &get_symb_id($symb);
1.137     matthew  2055:     if (! defined($symb_id)) {
                   2056:         &Apache::lonnet::logthis('Unable to find symb for '.$symb.' in '.$courseid);
                   2057:         return undef;
                   2058:     }
1.100     matthew  2059:     my $response_id = &get_part_id($response);
1.137     matthew  2060:     if (! defined($response_id)) {
                   2061:         &Apache::lonnet::logthis('Unable to find id for '.$response.' in '.$courseid);
                   2062:         return undef;
                   2063:     }
1.100     matthew  2064:     #
                   2065:     my $dbh = &Apache::lonmysql::get_dbh();
                   2066:     return undef if (! defined($dbh));
1.126     matthew  2067:     #
1.127     matthew  2068:     my ($student_requirements,$enrollment_requirements) = 
                   2069:         &limit_by_section_and_status($Sections,$enrollment,'d');
1.167     raeburn  2070:     my ($groups_join,$group_limits) = &limit_by_group($Groups,'d','e','f');
1.100     matthew  2071:     my $request = 'SELECT '.
1.105     matthew  2072:         'a.student_id, a.awarddetail, a.response_specific_value, '.
1.159     albertel 2073:         'a.response_specific_value_2, a.submission, b.timestamp, '.
                   2074: 	'c.tries, d.student '.
1.100     matthew  2075:         'FROM '.$fulldump_response_table.' AS a '.
                   2076:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
                   2077:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
                   2078:         'a.transaction = b.transaction '.
                   2079:         'LEFT JOIN '.$fulldump_part_table.' AS c '.
                   2080:         'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.        
                   2081:         'a.part_id=c.part_id AND a.transaction = c.transaction '.
1.108     matthew  2082:         'LEFT JOIN '.$student_table.' AS d '.
                   2083:         'ON a.student_id=d.student_id '.
1.167     raeburn  2084:         $groups_join;
                   2085:     my $limit = ' WHERE '.
1.100     matthew  2086:         'a.symb_id='.$symb_id.' AND a.response_id='.$response_id;
1.167     raeburn  2087:     if (defined($student_requirements)) {
                   2088:         $limit .= ' AND '.$student_requirements;
                   2089:     }
                   2090:     if (defined($enrollment_requirements)) {
                   2091:         $limit .= ' AND '.$enrollment_requirements;
                   2092:     }
                   2093:     if (defined($group_limits)) {
1.168     raeburn  2094:         $limit .= ' AND '.$group_limits;
1.100     matthew  2095:     }
1.167     raeburn  2096:     $request .= $limit.' ORDER BY b.timestamp';
1.103     matthew  2097: #    &Apache::lonnet::logthis("request =\n".$request);
1.100     matthew  2098:     my $sth = $dbh->prepare($request);
                   2099:     $sth->execute();
1.105     matthew  2100:     if ($dbh->err) {
1.138     matthew  2101:         &Apache::lonnet::logthis('error 3 = '.$dbh->errstr());
                   2102:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.105     matthew  2103:         return undef;
                   2104:     }
1.100     matthew  2105:     my $dataset = $sth->fetchall_arrayref();
                   2106:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
1.117     matthew  2107:         # Clear the \'s from around the submission
                   2108:         for (my $i =0;$i<scalar(@$dataset);$i++) {
1.176     albertel 2109:             $dataset->[$i]->[&RD_submission()] =~ s/(\'$|^\')//g;
1.117     matthew  2110:         }
1.103     matthew  2111:         return $dataset;
1.100     matthew  2112:     }
1.118     matthew  2113: }
                   2114: 
                   2115: 
1.159     albertel 2116: sub RDs_awarddetail     { return 3; }
                   2117: sub RDs_submission      { return 2; }
                   2118: sub RDs_timestamp       { return 1; }
                   2119: sub RDs_tries           { return 0; }
                   2120: sub RDs_awarded         { return 4; }
                   2121: sub RDs_response_eval   { return 5; }
                   2122: sub RDs_response_eval_2 { return 6; }
1.160     albertel 2123: sub RDs_part_award      { return 7; }
1.118     matthew  2124: 
                   2125: sub get_response_data_by_student {
                   2126:     my ($student,$symb,$response,$courseid) = @_;
                   2127:     return undef if (! defined($symb) || 
                   2128:                      ! defined($response));
1.146     albertel 2129:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.118     matthew  2130:     #
                   2131:     &setup_table_names($courseid);
                   2132:     my $symb_id = &get_symb_id($symb);
                   2133:     my $response_id = &get_part_id($response);
                   2134:     #
                   2135:     my $student_id = &get_student_id($student->{'username'},
                   2136:                                      $student->{'domain'});
                   2137:     #
                   2138:     my $dbh = &Apache::lonmysql::get_dbh();
                   2139:     return undef if (! defined($dbh));
                   2140:     my $request = 'SELECT '.
1.159     albertel 2141:         'c.tries, b.timestamp, a.submission, a.awarddetail, c.awarded, '.
1.160     albertel 2142: 	'a.response_specific_value, a.response_specific_value_2, c.award '.
1.118     matthew  2143:         'FROM '.$fulldump_response_table.' AS a '.
                   2144:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
                   2145:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
                   2146:         'a.transaction = b.transaction '.
                   2147:         'LEFT JOIN '.$fulldump_part_table.' AS c '.
                   2148:         'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.        
                   2149:         'a.part_id=c.part_id AND a.transaction = c.transaction '.
                   2150:         'LEFT JOIN '.$student_table.' AS d '.
                   2151:         'ON a.student_id=d.student_id '.
1.119     matthew  2152:         'LEFT JOIN '.$performance_table.' AS e '.
                   2153:         'ON a.symb_id=e.symb_id AND a.part_id=e.part_id AND '.
                   2154:         'a.student_id=e.student_id AND c.tries=e.tries '.
1.118     matthew  2155:         'WHERE '.
                   2156:         'a.symb_id='.$symb_id.' AND a.response_id='.$response_id.
                   2157:         ' AND a.student_id='.$student_id.' ORDER BY b.timestamp';
1.125     matthew  2158: #    &Apache::lonnet::logthis("request =\n".$request);
1.118     matthew  2159:     my $sth = $dbh->prepare($request);
                   2160:     $sth->execute();
                   2161:     if ($dbh->err) {
1.138     matthew  2162:         &Apache::lonnet::logthis('error 4 = '.$dbh->errstr());
                   2163:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.118     matthew  2164:         return undef;
                   2165:     }
                   2166:     my $dataset = $sth->fetchall_arrayref();
                   2167:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
                   2168:         # Clear the \'s from around the submission
                   2169:         for (my $i =0;$i<scalar(@$dataset);$i++) {
1.176     albertel 2170:             $dataset->[$i]->[&RDs_submission] =~ s/(\'$|^\')//g;
1.118     matthew  2171:         }
                   2172:         return $dataset;
                   2173:     }
                   2174:     return undef; # error occurred
1.106     matthew  2175: }
1.108     matthew  2176: 
                   2177: sub RT_student_id { return 0; }
                   2178: sub RT_awarded    { return 1; }
                   2179: sub RT_tries      { return 2; }
                   2180: sub RT_timestamp  { return 3; }
1.106     matthew  2181: 
                   2182: sub get_response_time_data {
1.167     raeburn  2183:     my ($sections,$groups,$enrollment,$symb,$part,$courseid) = @_;
1.106     matthew  2184:     return undef if (! defined($symb) || 
1.107     matthew  2185:                      ! defined($part));
1.146     albertel 2186:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.106     matthew  2187:     #
                   2188:     &setup_table_names($courseid);
                   2189:     my $symb_id = &get_symb_id($symb);
1.142     matthew  2190:     if (! defined($symb_id)) {
                   2191:         &Apache::lonnet::logthis('Unable to find symb for '.$symb.' in '.$courseid);
                   2192:         return undef;
                   2193:     }
1.107     matthew  2194:     my $part_id = &get_part_id($part);
1.142     matthew  2195:     if (! defined($part_id)) {
                   2196:         &Apache::lonnet::logthis('Unable to find id for '.$part.' in '.$courseid);
                   2197:         return undef;
                   2198:     }
1.106     matthew  2199:     #
                   2200:     my $dbh = &Apache::lonmysql::get_dbh();
                   2201:     return undef if (! defined($dbh));
1.142     matthew  2202:     my ($student_requirements,$enrollment_requirements) = 
                   2203:         &limit_by_section_and_status($sections,$enrollment,'d');
1.167     raeburn  2204:     my ($groups_join,$group_limits) = &limit_by_group($groups,'d','e','f');
1.106     matthew  2205:     my $request = 'SELECT '.
1.107     matthew  2206:         'a.student_id, a.awarded, a.tries, b.timestamp '.
                   2207:         'FROM '.$fulldump_part_table.' AS a '.
1.142     matthew  2208:         'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
                   2209:         'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
                   2210:         'a.transaction = b.transaction '.
                   2211:         'LEFT JOIN '.$student_table.' as d '.
                   2212:         'ON a.student_id=d.student_id '.
1.167     raeburn  2213:         $groups_join;
                   2214:     my $limit = ' WHERE '.
1.107     matthew  2215:         'a.symb_id='.$symb_id.' AND a.part_id='.$part_id;
1.167     raeburn  2216:     if (defined($student_requirements)) {
                   2217:         $limit .= ' AND '.$student_requirements;
                   2218:     }
                   2219:     if (defined($enrollment_requirements)) {
                   2220:         $limit .= ' AND '.$enrollment_requirements;
                   2221:     }
                   2222:     if (defined($group_limits)) {
                   2223:         $limit .= ' AND '.$group_limits;  
1.106     matthew  2224:     }
1.167     raeburn  2225:     $request .= $limit.' ORDER BY b.timestamp';
1.106     matthew  2226: #    &Apache::lonnet::logthis("request =\n".$request);
                   2227:     my $sth = $dbh->prepare($request);
                   2228:     $sth->execute();
                   2229:     if ($dbh->err) {
1.138     matthew  2230:         &Apache::lonnet::logthis('error 5 = '.$dbh->errstr());
                   2231:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.106     matthew  2232:         return undef;
                   2233:     }
                   2234:     my $dataset = $sth->fetchall_arrayref();
                   2235:     if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
                   2236:         return $dataset;
                   2237:     }
                   2238: 
1.100     matthew  2239: }
1.61      matthew  2240: 
1.113     matthew  2241: sub get_student_scores {
1.167     raeburn  2242:     my ($sections,$groups,$Symbs,$enrollment,$courseid,$starttime,$endtime) = @_;
1.146     albertel 2243:     $courseid = $env{'request.course.id'} if (! defined($courseid));
1.113     matthew  2244:     &setup_table_names($courseid);
                   2245:     my $dbh = &Apache::lonmysql::get_dbh();
                   2246:     return (undef) if (! defined($dbh));
1.181     albertel 2247:     my $tmptable = &temp_table_name($courseid,'temp_'.time);
1.145     matthew  2248:     my $request = 'DROP TABLE IF EXISTS '.$tmptable;
                   2249: #    &Apache::lonnet::logthis('request = '.$/.$request);
                   2250:     $dbh->do($request);
1.114     matthew  2251:     #
                   2252:     my $symb_requirements;
1.113     matthew  2253:     if (defined($Symbs)  && @$Symbs) {
                   2254:         $symb_requirements = '('.
1.114     matthew  2255:             join(' OR ', map{ "(a.symb_id='".&get_symb_id($_->{'symb'}).
1.121     matthew  2256:                               "' AND a.part_id='".&get_part_id($_->{'part'}).
                   2257:                               "')"
1.113     matthew  2258:                               } @$Symbs).')';
                   2259:     }
1.114     matthew  2260:     #
1.145     matthew  2261:     my ($student_requirements,$enrollment_requirements) = 
                   2262:         &limit_by_section_and_status($sections,$enrollment,'b');
1.114     matthew  2263:     #
1.167     raeburn  2264:     my ($groups_join,$group_limits) = &limit_by_group($groups,'b','d','e');
1.145     matthew  2265:     my $time_requirements = &limit_by_start_end_time($starttime,$endtime,'a');
1.114     matthew  2266:     ##
1.145     matthew  2267:     $request = 'CREATE TEMPORARY TABLE IF NOT EXISTS '.$tmptable.
                   2268:         ' SELECT a.student_id,SUM(a.awarded*c.weight) AS score FROM '.
1.114     matthew  2269:         $performance_table.' AS a ';
1.145     matthew  2270:     $request .= "LEFT JOIN ".$weight_table.' AS c ON a.symb_id=c.symb_id AND a.part_id=c.part_id ';
1.114     matthew  2271:     if (defined($student_requirements) || defined($enrollment_requirements)) {
1.167     raeburn  2272:         $request .= ' LEFT JOIN '.$student_table.' AS b ON a.student_id=b.student_id ';
                   2273:     }
                   2274:     if (defined($groups_join)) {
                   2275:         $request .= $groups_join;
1.114     matthew  2276:     }
1.167     raeburn  2277:     if (defined($symb_requirements)       || 
                   2278:         defined($student_requirements)    ||
                   2279:         defined($enrollment_requirements) ||
                   2280:         defined($group_limits) ) {
1.113     matthew  2281:         $request .= ' WHERE ';
                   2282:     }
1.114     matthew  2283:     if (defined($symb_requirements)) {
                   2284:         $request .= $symb_requirements.' AND ';
                   2285:     }
                   2286:     if (defined($student_requirements)) {
                   2287:         $request .= $student_requirements.' AND ';
                   2288:     }
                   2289:     if (defined($enrollment_requirements)) {
                   2290:         $request .= $enrollment_requirements.' AND ';
                   2291:     }
1.121     matthew  2292:     if (defined($time_requirements)) {
                   2293:         $request .= $time_requirements.' AND ';
                   2294:     }
                   2295:     $request =~ s/ AND $//; # Strip of the trailing ' AND '.
1.114     matthew  2296:     $request .= ' GROUP BY a.student_id';
                   2297: #    &Apache::lonnet::logthis("request = \n".$request);
1.113     matthew  2298:     my $sth = $dbh->prepare($request);
                   2299:     $sth->execute();
                   2300:     if ($dbh->err) {
1.138     matthew  2301:         &Apache::lonnet::logthis('error 6 = '.$dbh->errstr());
                   2302:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.113     matthew  2303:         return undef;
                   2304:     }
                   2305:     $request = 'SELECT score,COUNT(*) FROM '.$tmptable.' GROUP BY score';
                   2306: #    &Apache::lonnet::logthis("request = \n".$request);
                   2307:     $sth = $dbh->prepare($request);
                   2308:     $sth->execute();
                   2309:     if ($dbh->err) {
1.138     matthew  2310:         &Apache::lonnet::logthis('error 7 = '.$dbh->errstr());
                   2311:         &Apache::lonnet::logthis('prepared then executed '.$/.$request);
1.113     matthew  2312:         return undef;
                   2313:     }
                   2314:     my $dataset = $sth->fetchall_arrayref();
                   2315:     return $dataset;
                   2316: }
                   2317: 
1.61      matthew  2318: 
                   2319: 
                   2320: sub setup_table_names {
                   2321:     my ($courseid) = @_;
                   2322:     if (! defined($courseid)) {
1.146     albertel 2323:         $courseid = $env{'request.course.id'};
1.61      matthew  2324:     }
                   2325:     #
                   2326:     if (! defined($current_course) || $current_course ne $courseid) {
                   2327:         # Clear out variables
                   2328:         $have_read_part_table = 0;
                   2329:         undef(%ids_by_part);
                   2330:         undef(%parts_by_id);
                   2331:         $have_read_symb_table = 0;
                   2332:         undef(%ids_by_symb);
                   2333:         undef(%symbs_by_id);
                   2334:         $have_read_student_table = 0;
                   2335:         undef(%ids_by_student);
                   2336:         undef(%students_by_id);
1.167     raeburn  2337:         $have_read_groupnames_table = 0;
                   2338:         undef(%ids_by_groupname);
1.61      matthew  2339:         #
                   2340:         $current_course = $courseid;
                   2341:     }
                   2342:     #
                   2343:     # Set up database names
1.181     albertel 2344:     my $base_id = 'md5_'.&Digest::MD5::md5_hex($courseid);
1.167     raeburn  2345:     $symb_table               = $base_id.'_'.'symb';
                   2346:     $part_table               = $base_id.'_'.'part';
                   2347:     $student_table            = $base_id.'_'.'student';
                   2348:     $groupnames_table         = $base_id.'_'.'groupnames';
                   2349:     $students_groups_table    = $base_id.'_'.'studentgroups';
                   2350:     $performance_table        = $base_id.'_'.'performance';
                   2351:     $parameters_table         = $base_id.'_'.'parameters';
1.89      matthew  2352:     $fulldump_part_table      = $base_id.'_'.'partdata';
                   2353:     $fulldump_response_table  = $base_id.'_'.'responsedata';
                   2354:     $fulldump_timestamp_table = $base_id.'_'.'timestampdata';
1.127     matthew  2355:     $weight_table             = $base_id.'_'.'weight';
1.89      matthew  2356:     #
                   2357:     @Tables = (
                   2358:                $symb_table,
                   2359:                $part_table,
                   2360:                $student_table,
1.167     raeburn  2361:                $groupnames_table,
                   2362:                $students_groups_table,
1.89      matthew  2363:                $performance_table,
                   2364:                $parameters_table,
                   2365:                $fulldump_part_table,
                   2366:                $fulldump_response_table,
                   2367:                $fulldump_timestamp_table,
1.127     matthew  2368:                $weight_table,
1.89      matthew  2369:                );
1.61      matthew  2370:     return;
1.3       stredwic 2371: }
1.1       stredwic 2372: 
1.181     albertel 2373: sub temp_table_name {
                   2374:     my ($courseid,$affix) = @_;
                   2375:     my $base_id = 'md5_'.&Digest::MD5::md5_hex($courseid);
                   2376:     return $base_id.'_'.$affix;
                   2377: }
                   2378: 
1.57      matthew  2379: 
1.89      matthew  2380: } # End scope of table identifiers
1.57      matthew  2381: 
                   2382: 
                   2383: 
1.190     jms      2384: sub CL_SDOM     { return 0; }
                   2385: sub CL_SNAME    { return 1; }
                   2386: sub CL_END      { return 2; }
                   2387: sub CL_START    { return 3; }
                   2388: sub CL_ID       { return 4; }
                   2389: sub CL_SECTION  { return 5; }
                   2390: sub CL_FULLNAME { return 6; }
                   2391: sub CL_STATUS   { return 7; }
                   2392: sub CL_TYPE     { return 8; }
                   2393: sub CL_LOCKEDTYPE   { return 9; }
1.194     raeburn  2394: sub CL_CREDITS  { return 10; }
                   2395: sub CL_GROUP    { return 11; }
                   2396: sub CL_PERMANENTEMAIL { return 12; }
                   2397: sub CL_ROLE     { return 13; }
                   2398: sub CL_EXTENT   { return 14; }
                   2399: sub CL_PHOTO   { return 15; }
                   2400: sub CL_THUMBNAIL { return 16; }
1.195     raeburn  2401: sub CL_AUTHORQUOTA { return 17; }
                   2402: sub CL_AUTHORUSAGE { return 18; }
1.57      matthew  2403: 
1.190     jms      2404: sub get_classlist {
                   2405:     my ($cdom,$cnum) = @_;
1.150     albertel 2406:     my $cid = $cdom.'_'.$cnum;
                   2407:     if (!defined($cdom) || !defined($cnum)) {
                   2408: 	$cid =  $env{'request.course.id'};
                   2409: 	$cdom = $env{'course.'.$cid.'.domain'};
                   2410: 	$cnum = $env{'course.'.$cid.'.num'};
                   2411:     }
1.57      matthew  2412:     my $now = time;
1.35      matthew  2413:     #
                   2414:     my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
                   2415:     while (my ($student,$info) = each(%classlist)) {
1.60      matthew  2416:         if ($student =~ /^(con_lost|error|no_such_host)/i) {
                   2417:             &Apache::lonnet::logthis('get_classlist error for '.$cid.':'.$student);
                   2418:             return undef;
                   2419:         }
1.35      matthew  2420:         my ($sname,$sdom) = split(/:/,$student);
                   2421:         my @Values = split(/:/,$info);
1.194     raeburn  2422:         my ($end,$start,$id,$section,$fullname,$type,$lockedtype,$credits);
1.35      matthew  2423:         if (@Values > 2) {
1.194     raeburn  2424:             ($end,$start,$id,$section,$fullname,$type,$lockedtype,$credits) = @Values;
1.35      matthew  2425:         } else { # We have to get the data ourselves
                   2426:             ($end,$start) = @Values;
1.37      matthew  2427:             $section = &Apache::lonnet::getsection($sdom,$sname,$cid);
1.35      matthew  2428:             my %info=&Apache::lonnet::get('environment',
                   2429:                                           ['firstname','middlename',
                   2430:                                            'lastname','generation','id'],
                   2431:                                           $sdom, $sname);
                   2432:             my ($tmp) = keys(%info);
                   2433:             if ($tmp =~/^(con_lost|error|no_such_host)/i) {
                   2434:                 $fullname = 'not available';
                   2435:                 $id = 'not available';
1.38      matthew  2436:                 &Apache::lonnet::logthis('unable to retrieve environment '.
                   2437:                                          'for '.$sname.':'.$sdom);
1.35      matthew  2438:             } else {
1.141     albertel 2439:                 $fullname = &Apache::lonnet::format_name(@info{qw/firstname middlename lastname generation/},'lastname');
1.35      matthew  2440:                 $id = $info{'id'};
                   2441:             }
1.36      matthew  2442:             # Update the classlist with this students information
                   2443:             if ($fullname ne 'not available') {
1.141     albertel 2444: 		my $enrolldata = join(':',$end,$start,$id,$section,$fullname);
                   2445: 		my $reply=&Apache::lonnet::cput('classlist',
1.36      matthew  2446:                                                 {$student => $enrolldata},
                   2447:                                                 $cdom,$cnum);
                   2448:                 if ($reply !~ /^(ok|delayed)/) {
                   2449:                     &Apache::lonnet::logthis('Unable to update classlist for '.
                   2450:                                              'student '.$sname.':'.$sdom.
                   2451:                                              ' error:'.$reply);
                   2452:                 }
                   2453:             }
1.35      matthew  2454:         }
                   2455:         my $status='Expired';
                   2456:         if(((!$end) || $now < $end) && ((!$start) || ($now > $start))) {
                   2457:             $status='Active';
                   2458:         }
1.174     albertel 2459:         if(($now < $start) && ((!$end) || $now < $end )) {
                   2460:             $status='Future';
                   2461:         }
1.35      matthew  2462:         $classlist{$student} = 
1.194     raeburn  2463:             [$sdom,$sname,$end,$start,$id,$section,$fullname,$status,$type,
                   2464:              $lockedtype,$credits];
1.35      matthew  2465:     }
                   2466:     if (wantarray()) {
                   2467:         return (\%classlist,['domain','username','end','start','id',
1.194     raeburn  2468:                              'section','fullname','status','type',
                   2469:                              'lockedtype','credits']);
1.35      matthew  2470:     } else {
                   2471:         return \%classlist;
                   2472:     }
                   2473: }
                   2474: 
1.166     raeburn  2475: sub get_group_memberships {
1.170     raeburn  2476:     my ($classlist,$keylist,$cdom,$cnum) = @_;
1.172     albertel 2477: 
                   2478:     return ({},{}) if (!ref($classlist) || !ref($keylist));
                   2479: 
1.166     raeburn  2480:     my $cid = $cdom.'_'.$cnum;
                   2481:     if (!defined($cdom) || !defined($cnum)) {
                   2482:         $cid =  $env{'request.course.id'};
                   2483:         $cdom = $env{'course.'.$cid.'.domain'};
                   2484:         $cnum = $env{'course.'.$cid.'.num'};
                   2485:     }
                   2486:     my (%classgroups,%studentgroups);
                   2487:     my $now = time;
                   2488:     my $access_end = $env{'course.'.$cid.'.default_enrollment_end_date'};
1.171     raeburn  2489:     my %curr_groups =&Apache::longroup::coursegroups($cdom,$cnum);
1.169     albertel 2490:     if (%curr_groups) {
1.183     banghart 2491:         my $grpindex = &CL_GROUP();
1.169     albertel 2492:         my %groupmemberhash = 
                   2493: 	    &Apache::lonnet::get_group_membership($cdom,$cnum);
1.166     raeburn  2494:         foreach my $student (keys(%{$classlist})) {
                   2495:             %{$classgroups{$student}} = ();
                   2496:             my $hasgroup = 0;
                   2497:             foreach my $status ('previous','future','active','aftercourse') {
                   2498:                 %{$classgroups{$student}{$status}} = ();
                   2499:             }
                   2500:             foreach my $group (keys(%curr_groups)) {
                   2501:                 if (defined($groupmemberhash{$group.':'.$student})) {
                   2502:                     my ($end,$start) = split(/:/,$groupmemberhash{$group.':'.
                   2503:                                                                     $student});
                   2504:                     if ($start == -1) {
                   2505:                         next;
                   2506:                     } else {
                   2507:                         $studentgroups{$group} ++;
                   2508:                         $hasgroup = 1;
                   2509:                         if ($end && $end < $now) {
                   2510:                             $classgroups{$student}{'previous'}{$group} =
                   2511:                                          $groupmemberhash{$group.':'.$student};
                   2512:                             if ($classlist->{$student}[&CL_STATUS()] eq 'Expired') {
                   2513:                                 if ($access_end && $access_end < $now) {
                   2514:                                     if ($access_end - $end < 86400) {
                   2515:                                         $classgroups{$student}{'aftercourse'}{$group} = $groupmemberhash{$group.':'.$student};
                   2516:                                     }
                   2517:                                 }
                   2518:                             }
                   2519:                         } elsif ($now > $start) {
                   2520:                             if (!$end || $end > $now) {
                   2521:                                 $classgroups{$student}{'active'}{$group} =
                   2522:                                          $groupmemberhash{$group.':'.$student};
                   2523:                             }
                   2524:                         } else {
                   2525:                             $classgroups{$student}{'future'}{$group} =
                   2526:                                          $groupmemberhash{$group.':'.$student};
                   2527:                         }
                   2528:                     }
                   2529:                 }
                   2530:             }
                   2531:             if (!$hasgroup) {
                   2532:                 $studentgroups{'none'} ++;
1.170     raeburn  2533:             } else {
                   2534:                 $classlist->{$student}->[$grpindex] = join(',',
                   2535:                               sort(keys(%{$classgroups{$student}{'active'}})));
1.166     raeburn  2536:             }
                   2537:         }
                   2538:     }
                   2539:     return (\%classgroups,\%studentgroups);
                   2540: }
                   2541:                                                                                    
                   2542: sub get_students_groups {
                   2543:     my ($student,$enrollment_status,$classgroups) = @_;
                   2544:     my @studentsgroups = ();
                   2545:     if (ref($$classgroups{$student}{'active'}) eq 'HASH') {
                   2546:         push(@studentsgroups,keys(%{$$classgroups{$student}{'active'}}));
                   2547:     }
                   2548:     if ($enrollment_status eq 'Any') {
                   2549:         foreach my $status ('previous','future') {
                   2550:             if (ref($$classgroups{$student}{$status}) eq 'HASH') {
                   2551:                 push(@studentsgroups,keys(%{$$classgroups{$student}{$status}}));
                   2552:             }
                   2553:         }
                   2554:     } else {
                   2555:         if (ref($$classgroups{$student}{'aftercourse'}) eq 'HASH') {
                   2556:             push(@studentsgroups,keys(%{$$classgroups{$student}{'aftercourse'}}));
                   2557:         }
                   2558:     }
                   2559:     return @studentsgroups;
                   2560: }
                   2561: 
                   2562: 
1.1       stredwic 2563: # ----- END HELPER FUNCTIONS --------------------------------------------
                   2564: 
                   2565: 1;
                   2566: __END__
1.36      matthew  2567: 
1.190     jms      2568: 
                   2569: =pod
                   2570: 
                   2571: =head1 NAME
                   2572: 
                   2573: Apache::loncoursedata
                   2574: 
                   2575: =head1 SYNOPSIS
                   2576: 
                   2577: Set of functions that download and process student and course information.
                   2578: 
                   2579: =head1 PACKAGES USED
                   2580: 
                   2581:   Apache::lonnet
                   2582:   Apache::longroup
                   2583:   Time::HiRes
                   2584:   Apache::lonmysql
                   2585:   LONCAPA
                   2586:   Digest::MD5
                   2587:  
                   2588: =head1 DOWNLOAD INFORMATION
                   2589: 
                   2590: This section contains all the functions that get data from other servers 
                   2591: and/or itself.
                   2592: 
                   2593: 
                   2594: 
                   2595: =head1 LOCAL DATA CACHING SUBROUTINES
                   2596: 
                   2597: The local caching is done using MySQL.  There is no fall-back implementation
                   2598: if MySQL is not running.
                   2599: 
                   2600: The programmers interface is to call &get_current_state() or some other
                   2601: primary interface subroutine (described below).  The internals of this 
                   2602: storage system are documented here.
                   2603: 
                   2604: There are six tables used to store student performance data (the results of
                   2605: a dumpcurrent).  Each of these tables is created in MySQL with a name of
                   2606: $courseid_*****, where ***** is 'symb', 'part', or whatever is appropriate 
                   2607: for the table.  The tables and their purposes are described below.
                   2608: 
                   2609: Some notes before we get started.
                   2610: 
                   2611: Each table must have a PRIMARY KEY, which is a column or set of columns which
                   2612: will serve to uniquely identify a row of data.  NULL is not allowed!
                   2613: 
                   2614: INDEXes work best on integer data.
                   2615: 
                   2616: JOIN is used to combine data from many tables into one output.
                   2617: 
                   2618: lonmysql.pm is used for some of the interface, specifically the table creation
                   2619: calls.  The inserts are done in bulk by directly calling the database handler.
                   2620: The SELECT ... JOIN statement used to retrieve the data does not have an
                   2621: interface in lonmysql.pm and I shudder at the thought of writing one.
                   2622: 
                   2623: =head2 Table Descriptions
                   2624: 
                   2625: =over 4
                   2626: 
                   2627: =head2 Tables used to store meta information
                   2628: 
                   2629: The following tables hold data required to keep track of the current status
                   2630: of a students data in the tables or to look up the students data in the tables.
                   2631: 
                   2632: =over 4
                   2633: 
                   2634: =item C<$symb_table>
                   2635: 
                   2636: The symb_table has two columns.  The first is a 'symb_id' and the second
                   2637: is the text name for the 'symb' (limited to 64k).  The 'symb_id' is generated
                   2638: automatically by MySQL so inserts should be done on this table with an
                   2639: empty first element.  This table has its PRIMARY KEY on the 'symb_id'.
                   2640: 
                   2641: =item C<$part_table>
                   2642: 
                   2643: The part_table has two columns.  The first is a 'part_id' and the second
                   2644: is the text name for the 'part' (limited to 100 characters).  The 'part_id' is
                   2645: generated automatically by MySQL so inserts should be done on this table with
                   2646: an empty first element.  This table has its PRIMARY KEY on the 'part' (100
                   2647: characters) and a KEY on 'part_id'.
                   2648: 
                   2649: =item C<$student_table>
                   2650: 
                   2651: The student_table has 7 columns.  The first is a 'student_id' assigned by 
                   2652: MySQL.  The second is 'student' which is username:domain.  The third through
                   2653: fifth are 'section', 'status' (enrollment status), and 'classification' 
                   2654: (to be used in the future).  The sixth and seventh ('updatetime' and 
                   2655: 'fullupdatetime') contain the time of last update and full update of student
                   2656: data.  This table has its PRIMARY KEY on the 'student_id' column and is indexed
                   2657: on 'student', 'section', and 'status'.
                   2658: 
                   2659: =item C<$groupnames_table>
                   2660: 
                   2661: The groupnames_table has 2 columns.  The first is a 'group_id' assigned by 
                   2662: MySQL.  The second is 'groupname' which is the name of the group in the course.
                   2663: 
                   2664: =item C<$students_groups_table>
                   2665: 
                   2666: The students_groups_table has 2 columns.  The first is the 'student_id', and the 
                   2667: second is the 'group_id'. These two columns comprise the PRIMARY KEY for this 
                   2668: table, as an individual student may be affiliated with more than one group at
                   2669: any time. This table is indexed on both student_id and group_id.
                   2670: 
                   2671: =back 
                   2672: 
                   2673: =head2 Tables used to store current status data
                   2674: 
                   2675: The following tables store data only about the students current status on 
                   2676: a problem, meaning only the data related to the last attempt on a problem.
                   2677: 
                   2678: =over 4
                   2679: 
                   2680: =item C<$performance_table>
                   2681: 
                   2682: The performance_table has 9 columns.  The first three are 'symb_id', 
                   2683: 'student_id', and 'part_id'.  These comprise the PRIMARY KEY for this table
                   2684: and are directly related to the $symb_table, $student_table, and $part_table
                   2685: described above.  MySQL does better indexing on numeric items than text,
                   2686: so we use these three "index tables".  The remaining columns are
                   2687: 'solved', 'tries', 'awarded', 'award', 'awarddetail', and 'timestamp'.
                   2688: These are either the MySQL type TINYTEXT or various integers ('tries' and 
                   2689: 'timestamp').  This table has KEYs of 'student_id' and 'symb_id'.
                   2690: For use of this table, see the functions described below.
                   2691: 
                   2692: =item C<$parameters_table>
                   2693: 
                   2694: The parameters_table holds the data that does not fit neatly into the
                   2695: performance_table.  The parameters table has four columns: 'symb_id',
                   2696: 'student_id', 'parameter', and 'value'.  'symb_id', 'student_id', and
                   2697: 'parameter' comprise the PRIMARY KEY for this table.  'parameter' is 
                   2698: limited to 255 characters.  'value' is limited to 64k characters.
                   2699: 
                   2700: =back
                   2701: 
                   2702: =head2 Tables used for storing historic data
                   2703: 
                   2704: The following tables are used to store almost all of the transactions a student
                   2705: has made on a homework problem.  See loncapa/docs/homework/datastorage for 
                   2706: specific information about each of the parameters stored.  
                   2707: 
                   2708: =over 4
                   2709: 
                   2710: =item C<$fulldump_response_table>
                   2711: 
                   2712: The response table holds data (documented in loncapa/docs/homework/datastorage)
                   2713: associated with a particular response id which is stored when a student 
                   2714: attempts a problem.  The following are the columns of the table, in order:
                   2715: 'symb_id','part_id','response_id','student_id','transaction','tries',
                   2716: 'awarddetail', 'response_specific', 'response_specific_value',
                   2717: 'response_specific_2', 'response_specific_value_2', and 'submission
                   2718: (the text of the students submission).  The primary key is based on the
                   2719: first five columns listed above.
                   2720: 
                   2721: =item C<$fulldump_part_table()>
                   2722: 
                   2723: The part table holds data (documented in loncapa/docs/homework/datastorage)
                   2724: associated with a particular part id which is stored when a student attempts
                   2725: a problem.  The following are the columns of the table, in order:
                   2726: 'symb_id','part_id','student_id','transaction','tries','award','awarded',
                   2727: and 'previous'.  The primary key is based on the first five columns listed 
                   2728: above.
                   2729: 
                   2730: =item C<$fulldump_timestamp_table()>
                   2731: 
                   2732: The timestamp table holds the timestamps of the transactions which are
                   2733: stored in $fulldump_response_table and $fulldump_part_table.  This data is
                   2734: about both the response and part data.  Columns: 'symb_id','student_id',
                   2735: 'transaction', and 'timestamp'.  
                   2736: The primary key is based on the first 3 columns.
                   2737: 
                   2738: =item C<$weight_table()>
                   2739: 
                   2740: The weight table holds the weight for the problems used in the class.
                   2741: Whereas the weight of a problem can vary by section and student the data
                   2742: here is applied to the class as a whole.
                   2743: Columns: 'symb_id','part_id','response_id','weight'.
                   2744: 
                   2745: =back
                   2746: 
                   2747: 
                   2748: =head1 IMPORTANT SUBROUTINES
                   2749: 
                   2750: Here is a brief overview of the subroutines which are likely to be of 
                   2751: interest:
                   2752: 
                   2753: =over 4
                   2754: 
                   2755: =item C<&get_current_state()>
                   2756: 
                   2757: programmers interface.
                   2758: 
                   2759: =item C<&init_dbs()>
                   2760: 
                   2761: table creation
                   2762: 
                   2763: =item C<&update_student_data()>
                   2764: 
                   2765: data storage calls
                   2766: 
                   2767: =item C<&get_student_data_from_performance_cache()>
                   2768: 
                   2769: data retrieval
                   2770: 
                   2771: =back
                   2772: 
                   2773: =head1 OTHER SUBROUTINES
                   2774: 
                   2775: =over 4
                   2776: 
                   2777: =item C<&make_into_hash($values)>
                   2778: 
                   2779: Returns a reference to a hash as described by $values.  $values is
                   2780: assumed to be the result of 
                   2781:     join(':',map {&escape($_)} %orighash);
                   2782: 
                   2783: This is a helper function for get_current_state.
                   2784: 
                   2785: =item C<&init_dbs()>
                   2786: 
                   2787: Input: course id
                   2788: 
                   2789: Output: 0 on success, positive integer on error
                   2790: 
                   2791: This routine issues the calls to lonmysql to create the tables used to
                   2792: store student data.
                   2793: 
                   2794: item C<&delete_caches()>
                   2795: 
                   2796: This routine drops all the tables associated with a course from the 
                   2797: MySQL database.
                   2798: 
                   2799: Input: course id (optional, determined by environment if omitted) 
                   2800: 
                   2801: Returns: nothing
                   2802: 
                   2803: =item C<&get_part_id()>
                   2804: 
                   2805: Get the MySQL id of a problem part string.
                   2806: 
                   2807: Input: $part
                   2808: 
                   2809: Output: undef on error, integer $part_id on success.
                   2810: 
                   2811: =item C<&get_part()>
                   2812: 
                   2813: Get the string describing a part from the MySQL id of the problem part.
                   2814: 
                   2815: Input: $part_id
                   2816: 
                   2817: Output: undef on error, $part string on success.
                   2818: 
                   2819: =item C<&get_symb_id()>
                   2820: 
                   2821: Get the MySQL id of a symb.
                   2822: 
                   2823: Input: $symb
                   2824: 
                   2825: Output: undef on error, integer $symb_id on success.
                   2826: 
                   2827: =item C<&get_symb()>
                   2828: 
                   2829: Get the symb associated with a MySQL symb_id.
                   2830: 
                   2831: Input: $symb_id
                   2832: 
                   2833: Output: undef on error, $symb on success.
                   2834: 
                   2835: =item C<&get_student_id()>
                   2836: 
                   2837: Get the MySQL id of a student.
                   2838: 
                   2839: Input: $sname, $dom
                   2840: 
                   2841: Output: undef on error, integer $student_id on success.
                   2842: 
                   2843: =item C<&get_student()>
                   2844: 
                   2845: Get student username:domain associated with the MySQL student_id.
                   2846: 
                   2847: Input: $student_id
                   2848: 
                   2849: Output: undef on error, string $student (username:domain) on success.
                   2850: 
                   2851: =item C<&clear_internal_caches()>
                   2852: 
                   2853: Causes the internal caches used in get_student_id, get_student,
                   2854: get_symb_id, get_symb, get_part_id, and get_part to be undef'd.
                   2855: 
                   2856: Needs to be called before the first operation with the MySQL database
                   2857: for a given Apache request.
                   2858: 
                   2859: =item C<&update_full_student_data($sname,$sdom,$courseid)>
                   2860: 
                   2861: Does a lonnet::dump on a student to populate the courses tables.
                   2862: 
                   2863: Input: $sname, $sdom, $courseid
                   2864: 
                   2865: Output: $returnstatus
                   2866: 
                   2867: $returnstatus is a string describing any errors that occurred.  'okay' is the
                   2868: default.
                   2869: 
                   2870: This subroutine loads a students data using lonnet::dump and inserts
                   2871: it into the MySQL database.  The inserts are done on three tables, 
                   2872: $fulldump_response_table, $fulldump_part_table, and $fulldump_timestamp_table.
                   2873: The INSERT calls are made directly by this subroutine, not through lonmysql 
                   2874: because we do a 'bulk'insert which takes advantage of MySQLs non-SQL 
                   2875: compliant INSERT command to insert multiple rows at a time.  
                   2876: If anything has gone wrong during this process, $returnstatus is updated with 
                   2877: a description of the error.
                   2878: 
                   2879: Once the "fulldump" tables are updated, the tables used for chart and
                   2880: spreadsheet (which hold only the current state of the student on their
                   2881: homework, not historical data) are updated.  If all updates have occurred 
                   2882: successfully, $student_table is updated to reflect the time of the update.
                   2883: 
                   2884: Notice we do not insert the data and immediately query it.  This means it
                   2885: is possible for there to be data returned this first time that is not 
                   2886: available the second time.  CYA.
                   2887: 
                   2888: 
                   2889: =item C<&update_student_data()>
                   2890: 
                   2891: Input: $sname, $sdom, $courseid
                   2892: 
                   2893: Output: $returnstatus, \%student_data
                   2894: 
                   2895: $returnstatus is a string describing any errors that occurred.  'okay' is the
                   2896: default.
                   2897: \%student_data is the data returned by a call to lonnet::currentdump.
                   2898: 
                   2899: This subroutine loads a students data using lonnet::currentdump and inserts
                   2900: it into the MySQL database.  The inserts are done on two tables, 
                   2901: $performance_table and $parameters_table.  $parameters_table holds the data 
                   2902: that is not included in $performance_table.  See the description of 
                   2903: $performance_table elsewhere in this file.  The INSERT calls are made
                   2904: directly by this subroutine, not through lonmysql because we do a 'bulk'
                   2905: insert which takes advantage of MySQLs non-SQL compliant INSERT command to 
                   2906: insert multiple rows at a time.  If anything has gone wrong during this
                   2907: process, $returnstatus is updated with a description of the error and
                   2908: \%student_data is returned.  
                   2909: 
                   2910: Notice we do not insert the data and immediately query it.  This means it
                   2911: is possible for there to be data returned this first time that is not 
                   2912: available the second time.  CYA.
                   2913: 
                   2914: =item &ensure_tables_are_set_up($courseid)
                   2915: 
                   2916: Checks to be sure the MySQL tables for the given class are set up.
                   2917: If $courseid is omitted it will be obtained from the environment.
                   2918: 
                   2919: Returns nothing on success and 'error' on failure
                   2920: 
                   2921: 
                   2922: =item C<&ensure_current_data()>
                   2923: 
                   2924: Input: $sname, $sdom, $courseid
                   2925: 
                   2926: Output: $status, $data
                   2927: 
                   2928: This routine ensures the data for a given student is up to date.
                   2929: The $student_table is queried to determine the time of the last update.  
                   2930: If the students data is out of date, &update_student_data() is called.  
                   2931: The return values from the call to &update_student_data() are returned.
                   2932: 
                   2933: =item C<&ensure_current_full_data($sname,$sdom,$courseid)>
                   2934: 
                   2935: Input: $sname, $sdom, $courseid
                   2936: 
                   2937: Output: $status
                   2938: 
                   2939: This routine ensures the fulldata (the data from a lonnet::dump, not a
                   2940: lonnet::currentdump) for a given student is up to date.
                   2941: The $student_table is queried to determine the time of the last update.  
                   2942: If the students fulldata is out of date, &update_full_student_data() is
                   2943: called.  
                   2944: 
                   2945: The return value from the call to &update_full_student_data() is returned.
                   2946: 
                   2947: =item C<&get_student_data_from_performance_cache()>
                   2948: 
                   2949: Input: $sname, $sdom, $symb, $courseid
                   2950: 
                   2951: Output: hash reference containing the data for the given student.
                   2952: If $symb is undef, all the students data is returned.
                   2953: 
                   2954: This routine is the heart of the local caching system.  See the description
                   2955: of $performance_table, $symb_table, $student_table, and $part_table.  The
                   2956: main task is building the MySQL request.  The tables appear in the request
                   2957: in the order in which they should be parsed by MySQL.  When searching
                   2958: on a student the $student_table is used to locate the 'student_id'.  All
                   2959: rows in $performance_table which have a matching 'student_id' are returned,
                   2960: with data from $part_table and $symb_table which match the entries in
                   2961: $performance_table, 'part_id' and 'symb_id'.  When searching on a symb,
                   2962: the $symb_table is processed first, with matching rows grabbed from 
                   2963: $performance_table and filled in from $part_table and $student_table in
                   2964: that order.  
                   2965: 
                   2966: Running 'EXPLAIN ' on the 'SELECT' statements generated can be quite 
                   2967: interesting, especially if you play with the order the tables are listed.  
                   2968: 
                   2969: 
                   2970: =item C<&get_current_state()>
                   2971: 
                   2972: Input: $sname,$sdom,$symb,$courseid
                   2973: 
                   2974: Output: Described below
                   2975: 
                   2976: Retrieve the current status of a students performance.  $sname and
                   2977: $sdom are the only required parameters.  If $symb is undef the results
                   2978: of an &Apache::lonnet::currentdump() will be returned.  
                   2979: If $courseid is undef it will be retrieved from the environment.
                   2980: 
                   2981: The return structure is based on &Apache::lonnet::currentdump.  If
                   2982: $symb is unspecified, all the students data is returned in a hash of
                   2983: the form:
                   2984: ( 
                   2985:   symb1 => { param1 => value1, param2 => value2 ... },
                   2986:   symb2 => { param1 => value1, param2 => value2 ... },
                   2987: )
                   2988: 
                   2989: If $symb is specified, a hash of 
                   2990: (
                   2991:   param1 => value1, 
                   2992:   param2 => value2,
                   2993: )
                   2994: is returned.
                   2995: 
                   2996: If no data is found for $symb, or if the student has no performance data,
                   2997: an empty list is returned.
                   2998: 
                   2999: =item C<&get_problem_statistics()>
                   3000: 
                   3001: Gather data on a given problem.  The database is assumed to be 
                   3002: populated and all local caching variables are assumed to be set
                   3003: properly.  This means you need to call &ensure_current_data for
                   3004: the students you are concerned with prior to calling this routine.
                   3005: 
                   3006: Inputs: $Sections, Groups, $status, $symb, $part, $courseid, $starttime,
                   3007:         $endtime
                   3008: 
                   3009: =over 4
                   3010: 
                   3011: =item $Sections Array ref containing section names for students.  
                   3012: 'all' is allowed to be the first (and only) item in the array.
                   3013: 
                   3014: =item $Groups Array ref containing group names for students.
                   3015: 'all' is allowed to be the first (and only) item in the array.
                   3016: 
                   3017: =item $status String describing the status of students
                   3018: 
                   3019: =item $symb is the symb for the problem.
                   3020: 
                   3021: =item $part is the part id you need statistics for
                   3022: 
                   3023: =item $courseid is the course id, of course!
                   3024: 
                   3025: =item $starttime and $endtime are unix times which to use to limit
                   3026: the statistical data.
                   3027: 
                   3028: =back
                   3029: 
                   3030: Outputs: See the code for up to date information.  A hash reference is
                   3031: returned.  The hash has the following keys defined:
                   3032: 
                   3033: =over 4
                   3034: 
                   3035: =item * num_students 
                   3036: 
                   3037: The number of students attempting the problem
                   3038:       
                   3039: =item tries 
                   3040: 
                   3041: The total number of tries for the students
                   3042:       
                   3043: =item max_tries 
                   3044: 
                   3045: The maximum number of tries taken
                   3046:       
                   3047: =item mean_tries 
                   3048: 
                   3049: The average number of tries
                   3050:       
                   3051: =item num_solved T
                   3052: 
                   3053: he number of students able to solve the problem
                   3054:       
                   3055: =item num_override 
                   3056: 
                   3057: The number of students whose answer is 'correct_by_override'
                   3058:       
                   3059: =item deg_of_diff 
                   3060: 
                   3061: The degree of difficulty of the problem
                   3062:       
                   3063: =item std_tries 
                   3064: 
                   3065: The standard deviation of the number of tries
                   3066:       
                   3067: =item skew_tries 
                   3068: 
                   3069: The skew of the number of tries
                   3070: 
                   3071: =item per_wrong 
                   3072: 
                   3073: The number of students attempting the problem who were not
                   3074: able to answer it correctly.
                   3075: 
                   3076: =back
                   3077: 
                   3078: =item C<&populate_weight_table()>
                   3079: 
                   3080: =item C<&limit_by_start_end_times()>
                   3081: 
                   3082: Build SQL WHERE condition which limits the data collected by the start
                   3083: and end times provided
                   3084: 
                   3085: Inputs: $starttime, $endtime, $table
                   3086: 
                   3087: Returns: $time_limits
                   3088: 
                   3089: 
1.197   ! raeburn  3090: =item C<&limit_by_section_and_status()C>
1.190     jms      3091: 
                   3092: Build SQL WHERE condition which limits the data collected by section and
                   3093: student status.
                   3094: 
                   3095: Inputs: $Sections (array ref)
                   3096:     $enrollment (string: 'any', 'expired', 'active')
                   3097:     $tablename The name of the table that holds the student data
                   3098: 
                   3099: Returns: $student_requirements,$enrollment_requirements
                   3100: 
                   3101: =item C<&limit_by_group()>
                   3102:                                                                                
                   3103: Build SQL LEFT JOIN statement to include students_groups and groupnames tables and SQL WHERE condition which limits the data collected by group.
                   3104:                                                                                
                   3105: Inputs: $Groups (array ref)
                   3106:     $stutable   The name of the table which holds the student data.
                   3107:     $grptable   The name of the table which maps group_id to groupname.
                   3108:     $stugrptab  The name of the table which holds student group affiliations.   
                   3109: Returns: $groups_join,$group_limits
                   3110:    $groups_join  JOIN part of SQL statement (to include group related tables) 
                   3111:    $group_limits SQL WHERE condition limiting to requested groups
                   3112: 
                   3113: =item C<rank_students_by_scores_on_resources()>
                   3114: 
                   3115: Inputs: 
                   3116:     $resources: array ref of hash ref.  Each hash ref needs key 'symb'.
                   3117:     $Sections: array ref of sections to include,
                   3118:     $Groups: array ref of groups to include.
                   3119:     $enrollment: string,
                   3120:     $courseid (may be omitted)
                   3121:     $starttime (may be omitted)
                   3122:     $endtime (may be omitted)
                   3123:     $has_award_for (may be omitted)
                   3124: 
                   3125: Returns; An array of arrays.  The sub arrays contain a student name and
                   3126: their score on the resources. $starttime and $endtime constrain the
                   3127: list to awards obtained during the given time limits. $has_score_on
                   3128: constrains the list to those students who at least attempted the
                   3129: resource identified by the given symb, which is used to filter out
                   3130: such students for statistics that would be adversely affected by such
                   3131: students.
                   3132: 
                   3133: =item C<&get_sum_of_scores>
                   3134: 
                   3135: Inputs: $resource (hash ref, needs {'symb'} key),
                   3136: $part, (the part id),
                   3137: $students (array ref, contents of array are scalars holding 'sname:sdom'),
                   3138: $courseid
                   3139: 
                   3140: Returns: the sum of the score on the problem part over the students and the
                   3141:    maximum possible value for the sum (taken from the weight table).
                   3142:  
                   3143: 
                   3144: =item C<&score_stats()>
                   3145: 
                   3146: Inputs: $Sections, $enrollment, $symbs, $starttime,
                   3147:         $endtime, $courseid
                   3148: 
                   3149: $Sections, $enrollment, $starttime, $endtime, and $courseid are the same as 
                   3150: elsewhere in this module.  
                   3151: $symbs is an array ref of symbs
                   3152: 
                   3153: Returns: minimum, maximum, mean, s.d., number of students, and maximum
                   3154:   possible of student scores on the given resources
                   3155: 
                   3156: =item C<&count_stats()>
                   3157: 
                   3158: Inputs: $Sections, $Groups, $enrollment, $symbs, $starttime,
                   3159:         $endtime, $courseid
                   3160: 
                   3161: $Sections, $Groups $enrollment, $starttime, $endtime, and $courseid are the 
                   3162: same as elsewhere in this module.  
                   3163: $symbs is an array ref of symbs
                   3164: 
                   3165: Returns: minimum, maximum, mean, s.d., and number of students
                   3166:   of the number of items correct on the given resources
                   3167: 
                   3168: =item C<get_student_data()>
                   3169: 
                   3170: =item C<&get_student_scores($Sections,$Groups,$Symbs,$enrollment,$courseid)>
                   3171: 
                   3172: =item C<&setup_table_names()>
                   3173: 
                   3174: input: course id
                   3175: 
                   3176: output: none
                   3177: 
                   3178: =back
                   3179: 
                   3180: =head3 End of Local Data Caching Subroutines
                   3181: 
                   3182: =head3 Classlist Subroutines
                   3183: 
                   3184: =over
                   3185: 
                   3186: =item &get_classlist();
                   3187: 
                   3188: Retrieve the classist of a given class or of the current class.  Student
                   3189: information is returned from the classlist.db file and, if needed,
                   3190: from the students environment.
                   3191: 
                   3192: Optional arguments are $cdom, and $cnum (course domain,
                   3193: and course number, respectively).  If either is ommitted the course
                   3194: will be taken from the current environment ($env{'request.course.id'},
                   3195: $env{'course.'.$cid.'.domain'}, and $env{'course.'.$cid.'.num'}).
                   3196: 
                   3197: Returns a reference to a hash which contains:
                   3198:  keys    '$sname:$sdom'
1.194     raeburn  3199:  values  [$sdom,$sname,$end,$start,$id,$section,$fullname,$status,$type,
                   3200:           $lockedtype,$credits]
1.190     jms      3201: 
                   3202: The constant values CL_SDOM, CL_SNAME, CL_END, etc. can be used
                   3203: as indices into the returned list to future-proof clients against
                   3204: changes in the list order.
                   3205: 
                   3206: =back
                   3207: 
                   3208: =cut
                   3209: 
                   3210: 

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