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