loncom/interface/loncoursedata.pm - view

File: [LON-CAPA] / loncom / interface / loncoursedata.pm
Revision 1.100: download - view: text, annotated - select for diffs
Thu Oct 2 20:48:57 2003 UTC (20 years, 9 months ago) by matthew
Branches: MAIN
CVS tags: HEAD

Removed 'tries' from $fulldump_response_table as 'tries' only applies to
parts, not responses.
Added &get_optionresponse_data to retrieve option response data.  This
routine is evolving, which is my excuse for not documenting it futher
and continuing to log the MySQL request.
Added paranoid call to &setup_table_names in &get_problem_statistics which
is completely unneccessary and utterly benign.

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