--- loncom/interface/loncoursedata.pm 2003/02/25 20:36:29 1.52
+++ loncom/interface/loncoursedata.pm 2003/10/24 13:34:45 1.106
@@ -1,6 +1,6 @@
# The LearningOnline Network with CAPA
#
-# $Id: loncoursedata.pm,v 1.52 2003/02/25 20:36:29 matthew Exp $
+# $Id: loncoursedata.pm,v 1.106 2003/10/24 13:34:45 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -52,6 +52,8 @@ use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet();
use Apache::lonhtmlcommon;
+use Time::HiRes;
+use Apache::lonmysql;
use HTML::TokeParser;
use GDBM_File;
@@ -64,203 +66,6 @@ and/or itself.
=cut
-# ----- DOWNLOAD INFORMATION -------------------------------------------
-
-=pod
-
-=item &DownloadClasslist()
-
-Collects lastname, generation, middlename, firstname, PID, and section for each
-student from their environment database. The section data is also download, though
-it is in a rough format, and is processed later. The list of students is built from
-collecting a classlist for the course that is to be displayed. Once the classlist
-has been downloaded, its date stamp is recorded. Unless the datestamp for the
-class database is reset or is modified, this data will not be downloaded again.
-Also, there was talk about putting the fullname and section
-and perhaps other pieces of data into the classlist file. This would
-reduce the number of different file accesses and reduce the amount of
-processing on this side.
-
-=over 4
-
-Input: $courseID, $lastDownloadTime, $c
-
-$courseID: The id of the course
-
-$lastDownloadTime: This is the date stamp for when this information was
-last gathered. If it is set to Not downloaded, it will gather the data
-again, though it currently does not remove the old data.
-
-$c: The connection class that can determine if the browser has aborted. It
-is used to short circuit this function so that it does not continue to
-get information when there is no need.
-
-Output: \%classlist
-
-\%classlist: A pointer to a hash containing the following data:
-
--A list of student name:domain (as keys) (known below as $name)
-
--A hash pointer for each student containing lastname, generation, firstname,
-middlename, and PID : Key is $name.studentInformation
-
--A hash pointer to each students section data : Key is $name.section
-
--If there was an error in dump, it will be returned in the hash. See
-the error codes for dump in lonnet. Also, an error key will be
-generated if an abort occurs.
-
-=back
-
-=cut
-
-sub DownloadClasslist {
- my ($courseID, $lastDownloadTime, $c)=@_;
- my ($courseDomain,$courseNumber)=split(/\_/,$courseID);
- my %classlist;
-
- my $modifiedTime = &Apache::lonnet::GetFileTimestamp($courseDomain,
- $courseNumber,
- 'classlist.db',
- $Apache::lonnet::perlvar{'lonUsersDir'});
-
- # Always download the information if lastDownloadTime is set to
- # Not downloaded, otherwise it is only downloaded if the file
- # has been updated and has a more recent date stamp
- if($lastDownloadTime ne 'Not downloaded' &&
- $lastDownloadTime >= $modifiedTime && $modifiedTime >= 0) {
- # Data is not gathered so return UpToDate as true. This
- # will be interpreted in ProcessClasslist
- $classlist{'lastDownloadTime'}=time;
- $classlist{'UpToDate'} = 'true';
- return \%classlist;
- }
-
- %classlist=&Apache::lonnet::dump('classlist',$courseDomain, $courseNumber);
- foreach(keys (%classlist)) {
- if(/^(con_lost|error|no_such_host)/i) {
- return;
- }
- }
-
- foreach my $name (keys(%classlist)) {
- if(defined($c) && ($c->aborted())) {
- $classlist{'error'}='aborted';
- return \%classlist;
- }
-
- my ($studentName,$studentDomain) = split(/\:/,$name);
- # Download student environment data, specifically the full name and id.
- my %studentInformation=&Apache::lonnet::get('environment',
- ['lastname','generation',
- 'firstname','middlename',
- 'id'],
- $studentDomain,
- $studentName);
- $classlist{$name.':studentInformation'}=\%studentInformation;
-
- if($c->aborted()) {
- $classlist{'error'}='aborted';
- return \%classlist;
- }
-
- #Section
- my %section=&Apache::lonnet::dump('roles',$studentDomain,$studentName);
- $classlist{$name.':sections'}=\%section;
- }
-
- $classlist{'UpToDate'} = 'false';
- $classlist{'lastDownloadTime'}=time;
-
- return \%classlist;
-}
-
-=pod
-
-=item &DownloadCourseInformation()
-
-Dump of all the course information for a single student. The data can be
-pruned by making use of dumps regular expression arguement. This function
-also takes a regular expression which it passes straight through to dump.
-The data is no escaped, because it is done elsewhere. It also
-checks the timestamp of the students course database file and only downloads
-if it has been modified since the last download.
-
-=over 4
-
-Input: $namedata, $courseID, $lastDownloadTime, $WhatIWant
-
-$namedata: student name:domain
-
-$courseID: The id of the course
-
-$lastDownloadTime: This is the date stamp for when this information was
-last gathered. If it is set to Not downloaded, it will gather the data
-again, though it currently does not remove the old data.
-
-$WhatIWant: Regular expression used to get selected data with dump
-
-Output: \%courseData
-
-\%courseData: A hash pointer to the raw data from the students course
-database.
-
-=back
-
-=cut
-
-sub DownloadCourseInformation {
- my ($namedata,$courseID,$lastDownloadTime,$WhatIWant)=@_;
- my %courseData;
- my ($name,$domain) = split(/\:/,$namedata);
-
- my $modifiedTime = &Apache::lonnet::GetFileTimestamp($domain, $name,
- $courseID.'.db',
- $Apache::lonnet::perlvar{'lonUsersDir'});
-
- if($lastDownloadTime ne 'Not downloaded' &&
- $lastDownloadTime >= $modifiedTime && $modifiedTime >= 0) {
- # Data is not gathered so return UpToDate as true. This
- # will be interpreted in ProcessClasslist
- $courseData{$namedata.':lastDownloadTime'}=time;
- $courseData{$namedata.':UpToDate'} = 'true';
- return \%courseData;
- }
-
- # Download course data
- if(!defined($WhatIWant)) {
- # set the regular expression to everything by setting it to period
- $WhatIWant = '.';
- }
- %courseData=&Apache::lonnet::dump($courseID, $domain, $name, $WhatIWant);
- $courseData{'UpToDate'} = 'false';
- $courseData{'lastDownloadTime'}=time;
-
- my %newData;
- foreach (keys(%courseData)) {
- # need to have the keys to be prepended with the name:domain of the
- # student to reduce data collision later.
- $newData{$namedata.':'.$_} = $courseData{$_};
- }
-
- return \%newData;
-}
-
-# ----- END DOWNLOAD INFORMATION ---------------------------------------
-
-=pod
-
-=head1 PROCESSING FUNCTIONS
-
-These functions process all the data for all the students. Also, they
-are the functions that access the cache database for writing the majority of
-the time. The downloading and caching were separated to reduce problems
-with stopping downloading then can not tie hash to database later.
-
-=cut
-
-# ----- PROCESSING FUNCTIONS ---------------------------------------
-
####################################################
####################################################
@@ -275,12 +80,11 @@ assessment contents of each sequence in
The returned structure is a hash reference.
-{ title => 'title',
- symb => 'symb',
- source => '/s/o/u/r/c/e',
+{ title => 'title',
+ symb => 'symb',
+ src => '/s/o/u/r/c/e',
type => (container|assessment),
num_assess => 2, # only for container
- contents => [ {},{},{},{} ], # only for container
parts => [11,13,15], # only for assessment
response_ids => [12,14,16], # only for assessment
contents => [........] # only for container
@@ -300,12 +104,16 @@ sub get_sequence_assessment_data {
my $fn=$ENV{'request.course.fn'};
##
## use navmaps
- my $navmap = Apache::lonnavmaps::navmap->new($fn.".db",$fn."_parms.db",
- 1,0);
+ my $navmap = Apache::lonnavmaps::navmap->new();
if (!defined($navmap)) {
return 'Can not open Coursemap';
}
+ # We explicity grab the top level map because I am not sure we
+ # are pulling it from the iterator.
+ my $top_level_map = $navmap->getById('0.0');
+ #
my $iterator = $navmap->getIterator(undef, undef, undef, 1);
+ my $curRes = $iterator->next(); # Top level sequence
##
## Prime the pump
##
@@ -313,8 +121,9 @@ sub get_sequence_assessment_data {
## resources. This means we have to start out with something to look
## at.
my $title = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
- my $symb = 'top';
- my $src = 'not applicable';
+ my $symb = $top_level_map->symb();
+ my $src = $top_level_map->src();
+ my $randompick = $top_level_map->randompick();
#
my @Sequences;
my @Assessments;
@@ -324,29 +133,45 @@ sub get_sequence_assessment_data {
symb => $symb,
type => 'container',
num_assess => 0,
- contents => [], };
+ num_assess_parts => 0,
+ contents => [],
+ randompick => $randompick,
+ };
push (@Sequences,$top);
push (@Nested_Sequences, $top);
#
# We need to keep track of which sequences contain homework problems
#
+ my $previous_too;
my $previous;
- my $curRes = $iterator->next(); # BEGIN_MAP
- $curRes = $iterator->next(); # The first item in the top level map.
while (scalar(@Nested_Sequences)) {
+ $previous_too = $previous;
$previous = $curRes;
$curRes = $iterator->next();
my $currentmap = $Nested_Sequences[-1]; # Last one on the stack
if ($curRes == $iterator->BEGIN_MAP()) {
+ if (! ref($previous)) {
+ $previous = $previous_too;
+ }
+ if (! ref($previous)) {
+ next;
+ }
# get the map itself, instead of BEGIN_MAP
$title = $previous->title();
+ $title =~ s/\:/\&\#058;/g;
$symb = $previous->symb();
$src = $previous->src();
+ # pick up the filename if there is no title available
+ if (! defined($title) || $title eq '') {
+ ($title) = ($src=~/\/([^\/]*)$/);
+ }
+ $randompick = $previous->randompick();
my $newmap = { title => $title,
src => $src,
symb => $symb,
type => 'container',
num_assess => 0,
+ randompick => $randompick,
contents => [],
};
push (@{$currentmap->{'contents'}},$newmap); # this is permanent
@@ -362,1184 +187,1569 @@ sub get_sequence_assessment_data {
next if (! $curRes->is_problem());# && !$curRes->randomout);
# Okay, from here on out we only deal with assessments
$title = $curRes->title();
+ $title =~ s/\:/\&\#058;/g;
$symb = $curRes->symb();
$src = $curRes->src();
my $parts = $curRes->parts();
+ my %partdata;
+ foreach my $part (@$parts) {
+ my @Responses = $curRes->responseType($part);
+ my @Ids = $curRes->responseIds($part);
+ $partdata{$part}->{'ResponseTypes'}= \@Responses;
+ $partdata{$part}->{'ResponseIds'} = \@Ids;
+ # Count how many responses of each type there are in this part
+ foreach (@Responses) {
+ $partdata{$part}->{$_}++;
+ }
+ }
my $assessment = { title => $title,
src => $src,
symb => $symb,
type => 'assessment',
+ parts => $parts,
+ num_parts => scalar(@$parts),
+ partdata => \%partdata,
};
push(@Assessments,$assessment);
push(@{$currentmap->{'contents'}},$assessment);
$currentmap->{'num_assess'}++;
+ $currentmap->{'num_assess_parts'}+= scalar(@$parts);
}
+ $navmap->untieHashes();
return ($top,\@Sequences,\@Assessments);
}
-#################################################
-#################################################
-
-=pod
-
-=item &ProcessTopResourceMap()
+sub LoadDiscussion {
+ my ($courseID)=@_;
+ my %Discuss=();
+ my %contrib=&Apache::lonnet::dump(
+ $courseID,
+ $ENV{'course.'.$courseID.'.domain'},
+ $ENV{'course.'.$courseID.'.num'});
+
+ #my %contrib=&DownloadCourseInformation($name, $courseID, 0);
-Trace through the "big hash" created in rat/lonuserstate.pm::loadmap.
-Basically, this function organizes a subset of the data and stores it in
-cached data. The data stored is the problems, sequences, sequence titles,
-parts of problems, and their ordering. Column width information is also
-partially handled here on a per sequence basis.
+ foreach my $temp(keys %contrib) {
+ if ($temp=~/^version/) {
+ my $ver=$contrib{$temp};
+ my ($dummy,$prb)=split(':',$temp);
+ for (my $idx=1; $idx<=$ver; $idx++ ) {
+ my $name=$contrib{"$idx:$prb:sendername"};
+ $Discuss{"$name:$prb"}=$idx;
+ }
+ }
+ }
-=over 4
+ return \%Discuss;
+}
-Input: $cache, $c
+################################################
+################################################
-$cache: A pointer to a hash to store the information
+=pod
-$c: The connection class used to determine if an abort has been sent to the
-browser
+=item &GetUserName(username,userdomain)
-Output: A string that contains an error message or "OK" if everything went
-smoothly.
+Returns a hash with the following entries:
+ 'firstname', 'middlename', 'lastname', 'generation', and 'fullname'
-=back
+ 'fullname' is the result of &Apache::loncoursedata::ProcessFullName.
=cut
-sub ProcessTopResourceMap {
- my ($cache,$c)=@_;
- my %hash;
- my $fn=$ENV{'request.course.fn'};
- if(-e "$fn.db") {
- my $tieTries=0;
- while($tieTries < 3) {
- if($c->aborted()) {
- return;
- }
- if(tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) {
- last;
- }
- $tieTries++;
- sleep 1;
- }
- if($tieTries >= 3) {
- return 'Coursemap undefined.';
- }
- } else {
- return 'Can not open Coursemap.';
- }
+################################################
+################################################
+sub GetUserName {
+ my ($username,$userdomain) = @_;
+ $username = $ENV{'user.name'} if (! defined($username));
+ $userdomain = $ENV{'user.domain'} if (! defined($username));
+ my %userenv = &Apache::lonnet::get('environment',
+ ['firstname','middlename','lastname','generation'],
+ $userdomain,$username);
+ $userenv{'fullname'} = &ProcessFullName($userenv{'lastname'},
+ $userenv{'generation'},
+ $userenv{'firstname'},
+ $userenv{'middlename'});
+ return %userenv;
+}
- my $oldkeys;
- delete $cache->{'OptionResponses'};
- if(defined($cache->{'ResourceKeys'})) {
- $oldkeys = $cache->{'ResourceKeys'};
- foreach (split(':::', $cache->{'ResourceKeys'})) {
- delete $cache->{$_};
- }
- delete $cache->{'ResourceKeys'};
- }
-
- # Initialize state machine. Set information pointing to top level map.
- my (@sequences, @currentResource, @finishResource);
- my ($currentSequence, $currentResourceID, $lastResourceID);
-
- $currentResourceID=$hash{'ids_'.
- &Apache::lonnet::clutter($ENV{'request.course.uri'})};
- push(@currentResource, $currentResourceID);
- $lastResourceID=-1;
- $currentSequence=-1;
- my $topLevelSequenceNumber = $currentSequence;
-
- my %sequenceRecord;
- my %allkeys;
- while(1) {
- if($c->aborted()) {
- last;
- }
- # HANDLE NEW SEQUENCE!
- #if page || sequence
- if(defined($hash{'map_pc_'.$hash{'src_'.$currentResourceID}}) &&
- !defined($sequenceRecord{$currentResourceID})) {
- $sequenceRecord{$currentResourceID}++;
- push(@sequences, $currentSequence);
- push(@currentResource, $currentResourceID);
- push(@finishResource, $lastResourceID);
-
- $currentSequence=$hash{'map_pc_'.$hash{'src_'.$currentResourceID}};
-
- # Mark sequence as containing problems. If it doesn't, then
- # it will be removed when processing for this sequence is
- # complete. This allows the problems in a sequence
- # to be outputed before problems in the subsequences
- if(!defined($cache->{'orderedSequences'})) {
- $cache->{'orderedSequences'}=$currentSequence;
- } else {
- $cache->{'orderedSequences'}.=':'.$currentSequence;
- }
- $allkeys{'orderedSequences'}++;
+################################################
+################################################
- $lastResourceID=$hash{'map_finish_'.
- $hash{'src_'.$currentResourceID}};
- $currentResourceID=$hash{'map_start_'.
- $hash{'src_'.$currentResourceID}};
-
- if(!($currentResourceID) || !($lastResourceID)) {
- $currentSequence=pop(@sequences);
- $currentResourceID=pop(@currentResource);
- $lastResourceID=pop(@finishResource);
- if($currentSequence eq $topLevelSequenceNumber) {
- last;
- }
- }
- next;
- }
+=pod
- # Handle gradable resources: exams, problems, etc
- $currentResourceID=~/(\d+)\.(\d+)/;
- my $partA=$1;
- my $partB=$2;
- if($hash{'src_'.$currentResourceID}=~
- /\.(problem|exam|quiz|assess|survey|form)$/ &&
- $partA eq $currentSequence &&
- !defined($sequenceRecord{$currentSequence.':'.
- $currentResourceID})) {
- $sequenceRecord{$currentSequence.':'.$currentResourceID}++;
- my $Problem = &Apache::lonnet::symbclean(
- &Apache::lonnet::declutter($hash{'map_id_'.$partA}).
- '___'.$partB.'___'.
- &Apache::lonnet::declutter($hash{'src_'.
- $currentResourceID}));
-
- $cache->{$currentResourceID.':problem'}=$Problem;
- $allkeys{$currentResourceID.':problem'}++;
- if(!defined($cache->{$currentSequence.':problems'})) {
- $cache->{$currentSequence.':problems'}=$currentResourceID;
- } else {
- $cache->{$currentSequence.':problems'}.=
- ':'.$currentResourceID;
- }
- $allkeys{$currentSequence.':problems'}++;
+=item &ProcessFullName()
- my $meta=$hash{'src_'.$currentResourceID};
-# $cache->{$currentResourceID.':title'}=
-# &Apache::lonnet::metdata($meta,'title');
- $cache->{$currentResourceID.':title'}=
- $hash{'title_'.$currentResourceID};
- $allkeys{$currentResourceID.':title'}++;
- $cache->{$currentResourceID.':source'}=
- $hash{'src_'.$currentResourceID};
- $allkeys{$currentResourceID.':source'}++;
-
- # Get Parts for problem
- my %beenHere;
- foreach (split(/\,/,&Apache::lonnet::metadata($meta,'packages'))) {
- if(/^\w+response_\d+.*/) {
- my (undef, $partId, $responseId) = split(/_/,$_);
- if($beenHere{'p:'.$partId} == 0) {
- $beenHere{'p:'.$partId}++;
- if(!defined($cache->{$currentSequence.':'.
- $currentResourceID.':parts'})) {
- $cache->{$currentSequence.':'.$currentResourceID.
- ':parts'}=$partId;
- } else {
- $cache->{$currentSequence.':'.$currentResourceID.
- ':parts'}.=':'.$partId;
- }
- $allkeys{$currentSequence.':'.$currentResourceID.
- ':parts'}++;
- }
- if($beenHere{'r:'.$partId.':'.$responseId} == 0) {
- $beenHere{'r:'.$partId.':'.$responseId}++;
- if(!defined($cache->{$currentSequence.':'.
- $currentResourceID.':'.$partId.
- ':responseIDs'})) {
- $cache->{$currentSequence.':'.$currentResourceID.
- ':'.$partId.':responseIDs'}=$responseId;
- } else {
- $cache->{$currentSequence.':'.$currentResourceID.
- ':'.$partId.':responseIDs'}.=':'.
- $responseId;
- }
- $allkeys{$currentSequence.':'.$currentResourceID.':'.
- $partId.':responseIDs'}++;
- }
- if(/^optionresponse/ &&
- $beenHere{'o:'.$partId.':'.$currentResourceID} == 0) {
- $beenHere{'o:'.$partId.$currentResourceID}++;
- if(defined($cache->{'OptionResponses'})) {
- $cache->{'OptionResponses'}.= ':::'.
- $currentSequence.':'.$currentResourceID.':'.
- $partId.':'.$responseId;
- } else {
- $cache->{'OptionResponses'}= $currentSequence.':'.
- $currentResourceID.':'.
- $partId.':'.$responseId;
- }
- $allkeys{'OptionResponses'}++;
- }
- }
- }
- }
+Takes lastname, generation, firstname, and middlename (or some partial
+set of this data) and returns the full name version as a string. Format
+is Lastname generation, firstname middlename or a subset of this.
- # if resource == finish resource, then it is the end of a sequence/page
- if($currentResourceID eq $lastResourceID) {
- # pop off last resource of sequence
- $currentResourceID=pop(@currentResource);
- $lastResourceID=pop(@finishResource);
-
- if(defined($cache->{$currentSequence.':problems'})) {
- # Capture sequence information here
- $cache->{$currentSequence.':title'}=
- $hash{'title_'.$currentResourceID};
- $allkeys{$currentSequence.':title'}++;
- $cache->{$currentSequence.':source'}=
- $hash{'src_'.$currentResourceID};
- $allkeys{$currentSequence.':source'}++;
-
- my $totalProblems=0;
- foreach my $currentProblem (split(/\:/,
- $cache->{$currentSequence.
- ':problems'})) {
- foreach (split(/\:/,$cache->{$currentSequence.':'.
- $currentProblem.
- ':parts'})) {
- $totalProblems++;
- }
- }
- my @titleLength=split(//,$cache->{$currentSequence.
- ':title'});
- # $extra is 5 for problems correct and 3 for space
- # between problems correct and problem output
- my $extra = 8;
- if(($totalProblems + $extra) > (scalar @titleLength)) {
- $cache->{$currentSequence.':columnWidth'}=
- $totalProblems + $extra;
- } else {
- $cache->{$currentSequence.':columnWidth'}=
- (scalar @titleLength);
- }
- $allkeys{$currentSequence.':columnWidth'}++;
- } else {
- # Remove sequence from list, if it contains no problems to
- # display.
- $cache->{'orderedSequences'}=~s/$currentSequence//;
- $cache->{'orderedSequences'}=~s/::/:/g;
- $cache->{'orderedSequences'}=~s/^:|:$//g;
- }
+=cut
- $currentSequence=pop(@sequences);
- if($currentSequence eq $topLevelSequenceNumber) {
- last;
- }
- }
+################################################
+################################################
+sub ProcessFullName {
+ my ($lastname, $generation, $firstname, $middlename)=@_;
+ my $Str = '';
- # MOVE!!!
- # move to next resource
- unless(defined($hash{'to_'.$currentResourceID})) {
- # big problem, need to handle. Next is probably wrong
- my $errorMessage = 'Big problem in ';
- $errorMessage .= 'loncoursedata::ProcessTopLevelMap.';
- $errorMessage .= " bighash to_$currentResourceID not defined!";
- &Apache::lonnet::logthis($errorMessage);
- if (!defined($currentResourceID)) {last;}
- }
- my @nextResources=();
- foreach (split(/\,/,$hash{'to_'.$currentResourceID})) {
- if(!defined($sequenceRecord{$currentSequence.':'.
- $hash{'goesto_'.$_}})) {
- push(@nextResources, $hash{'goesto_'.$_});
- }
- }
- push(@currentResource, @nextResources);
- # Set the next resource to be processed
- $currentResourceID=pop(@currentResource);
- }
+ # Strip whitespace preceeding & following name components.
+ $lastname =~ s/(\s+$|^\s+)//g;
+ $generation =~ s/(\s+$|^\s+)//g;
+ $firstname =~ s/(\s+$|^\s+)//g;
+ $middlename =~ s/(\s+$|^\s+)//g;
- my @theKeys = keys(%allkeys);
- my $newkeys = join(':::', @theKeys);
- $cache->{'ResourceKeys'} = join(':::', $newkeys);
- if($newkeys ne $oldkeys) {
- $cache->{'ResourceUpdated'} = 'true';
+ if($lastname ne '') {
+ $Str .= $lastname;
+ $Str .= ' '.$generation if ($generation ne '');
+ $Str .= ',';
+ $Str .= ' '.$firstname if ($firstname ne '');
+ $Str .= ' '.$middlename if ($middlename ne '');
} else {
- $cache->{'ResourceUpdated'} = 'false';
- }
-
- unless (untie(%hash)) {
- &Apache::lonnet::logthis("WARNING: ".
- "Could not untie coursemap $fn (browse)".
- ".");
+ $Str .= $firstname if ($firstname ne '');
+ $Str .= ' '.$middlename if ($middlename ne '');
+ $Str .= ' '.$generation if ($generation ne '');
}
- return 'OK';
+ return $Str;
}
+################################################
+################################################
+
=pod
-=item &ProcessClasslist()
+=item &make_into_hash($values);
-Taking the class list dumped from &DownloadClasslist(), all the
-students and their non-class information is processed using the
-&ProcessStudentInformation() function. A date stamp is also recorded for
-when the data was processed.
+Returns a reference to a hash as described by $values. $values is
+assumed to be the result of
+ join(':',map {&Apache::lonnet::escape($_)} %orighash);
-Takes data downloaded for a student and breaks it up into managable pieces and
-stored in cache data. The username, domain, class related date, PID,
-full name, and section are all processed here.
+This is a helper function for get_current_state.
-=over 4
+=cut
-Input: $cache, $classlist, $courseID, $ChartDB, $c
+################################################
+################################################
+sub make_into_hash {
+ my $values = shift;
+ my %tmp = map { &Apache::lonnet::unescape($_); }
+ split(':',$values);
+ return \%tmp;
+}
-$cache: A hash pointer to store the data
-$classlist: The hash of data collected about a student from
-&DownloadClasslist(). The hash contains a list of students, a pointer
-to a hash of student information for each student, and each students section
-number.
-
-$courseID: The course ID
-
-$ChartDB: The name of the cache database file.
-
-$c: The connection class used to determine if an abort has been sent to the
-browser
-
-Output: @names
-
-@names: An array of students whose information has been processed, and are to
-be considered in an arbitrary order. The entries in @names are of the form
-username:domain.
-
-The values in $cache are as follows:
-
- *NOTE: for the following $name implies username:domain
- $name.':error' only defined if an error occured. Value
- contains the error message
- $name.':lastDownloadTime' unconverted time of the last update of a
- student\'s course data
- $name.'updateTime' coverted time of the last update of a
- student\'s course data
- $name.':username' username of a student
- $name.':domain' domain of a student
- $name.':fullname' full name of a student
- $name.':id' PID of a student
- $name.':Status' active/expired status of a student
- $name.':section' section of a student
+################################################
+################################################
-=back
+=pod
-=cut
+=head1 LOCAL DATA CACHING SUBROUTINES
-sub ProcessClasslist {
- my ($cache,$classlist,$courseID,$c)=@_;
- my @names=();
-
- $cache->{'ClasslistTimeStamp'}=$classlist->{'lastDownloadTime'};
- if($classlist->{'UpToDate'} eq 'true') {
- return split(/:::/,$cache->{'NamesOfStudents'});;
- }
+The local caching is done using MySQL. There is no fall-back implementation
+if MySQL is not running.
- foreach my $name (keys(%$classlist)) {
- if($name =~ /\:section/ || $name =~ /\:studentInformation/ ||
- $name eq '' || $name eq 'UpToDate' || $name eq 'lastDownloadTime') {
- next;
- }
- if($c->aborted()) {
- return ();
- }
- my $studentInformation = $classlist->{$name.':studentInformation'};
- my $date = $classlist->{$name};
- my ($studentName,$studentDomain) = split(/\:/,$name);
-
- $cache->{$name.':username'}=$studentName;
- $cache->{$name.':domain'}=$studentDomain;
- # Initialize timestamp for student
- if(!defined($cache->{$name.':lastDownloadTime'})) {
- $cache->{$name.':lastDownloadTime'}='Not downloaded';
- $cache->{$name.':updateTime'}=' Not updated';
- }
-
- my $error = 0;
- foreach(keys(%$studentInformation)) {
- if(/^(con_lost|error|no_such_host)/i) {
- $cache->{$name.':error'}=
- 'Could not download student environment data.';
- $cache->{$name.':fullname'}='';
- $cache->{$name.':id'}='';
- $error = 1;
- }
- }
- next if($error);
- push(@names,$name);
- $cache->{$name.':fullname'}=&ProcessFullName(
- $studentInformation->{'lastname'},
- $studentInformation->{'generation'},
- $studentInformation->{'firstname'},
- $studentInformation->{'middlename'});
- $cache->{$name.':id'}=$studentInformation->{'id'};
-
- my ($end, $start)=split(':',$date);
- $courseID=~s/\_/\//g;
- $courseID=~s/^(\w)/\/$1/;
-
- my $sec='';
- my $sectionData = $classlist->{$name.':sections'};
- foreach my $key (keys (%$sectionData)) {
- my $value = $sectionData->{$key};
- if ($key=~/^$courseID(?:\/)*(\w+)*\_st$/) {
- my $tempsection=$1;
- if($key eq $courseID.'_st') {
- $tempsection='';
- }
- my (undef,$roleend,$rolestart)=split(/\_/,$value);
- if($roleend eq $end && $rolestart eq $start) {
- $sec = $tempsection;
- last;
- }
- }
- }
+The programmers interface is to call &get_current_state() or some other
+primary interface subroutine (described below). The internals of this
+storage system are documented here.
- my $status='Expired';
- if(((!$end) || time < $end) && ((!$start) || (time > $start))) {
- $status='Active';
- }
- $cache->{$name.':Status'}=$status;
- $cache->{$name.':section'}=$sec;
-
- if($sec eq '' || !defined($sec) || $sec eq ' ') {
- $sec = 'none';
- }
- if(defined($cache->{'sectionList'})) {
- if($cache->{'sectionList'} !~ /(^$sec:|^$sec$|:$sec$|:$sec:)/) {
- $cache->{'sectionList'} .= ':'.$sec;
- }
- } else {
- $cache->{'sectionList'} = $sec;
- }
- }
+There are six tables used to store student performance data (the results of
+a dumpcurrent). Each of these tables is created in MySQL with a name of
+$courseid_*****, where ***** is 'symb', 'part', or whatever is appropriate
+for the table. The tables and their purposes are described below.
- $cache->{'ClasslistTimestamp'}=time;
- $cache->{'NamesOfStudents'}=join(':::',@names);
+Some notes before we get started.
- return @names;
-}
+Each table must have a PRIMARY KEY, which is a column or set of columns which
+will serve to uniquely identify a row of data. NULL is not allowed!
-=pod
+INDEXes work best on integer data.
-=item &ProcessStudentData()
+JOIN is used to combine data from many tables into one output.
-Takes the course data downloaded for a student in
-&DownloadCourseInformation() and breaks it up into key value pairs
-to be stored in the cached data. The keys are comprised of the
-$username:$domain:$keyFromCourseDatabase. The student username:domain is
-stored away signifying that the students information has been downloaded and
-can be reused from cached data.
+lonmysql.pm is used for some of the interface, specifically the table creation
+calls. The inserts are done in bulk by directly calling the database handler.
+The SELECT ... JOIN statement used to retrieve the data does not have an
+interface in lonmysql.pm and I shudder at the thought of writing one.
+
+=head3 Table Descriptions
=over 4
-Input: $cache, $courseData, $name
+=item Tables used to store meta information
-$cache: A hash pointer to store data
+The following tables hold data required to keep track of the current status
+of a students data in the tables or to look up the students data in the tables.
-$courseData: A hash pointer that points to the course data downloaded for a
-student.
+=over 4
-$name: username:domain
+=item $symb_table
-Output: None
+The symb_table has two columns. The first is a 'symb_id' and the second
+is the text name for the 'symb' (limited to 64k). The 'symb_id' is generated
+automatically by MySQL so inserts should be done on this table with an
+empty first element. This table has its PRIMARY KEY on the 'symb_id'.
-*NOTE: There is no output, but an error message is stored away in the cache
-data. This is checked in &FormatStudentData(). The key username:domain:error
-will only exist if an error occured. The error is an error from
-&DownloadCourseInformation().
+=item $part_table
-=back
+The part_table has two columns. The first is a 'part_id' and the second
+is the text name for the 'part' (limited to 100 characters). The 'part_id' is
+generated automatically by MySQL so inserts should be done on this table with
+an empty first element. This table has its PRIMARY KEY on the 'part' (100
+characters) and a KEY on 'part_id'.
-=cut
+=item $student_table
-sub ProcessStudentData {
- my ($cache,$courseData,$name)=@_;
+The student_table has two columns. The first is a 'student_id' and the second
+is the text description of the 'student' (typically username:domain) (less
+than 100 characters). The 'student_id' is automatically generated by MySQL.
+The use of the name 'student_id' is loaded, I know, but this ID is used ONLY
+internally to the MySQL database and is not the same as the students ID
+(stored in the students environment). This table has its PRIMARY KEY on the
+'student' (100 characters).
- if(!&CheckDateStampError($courseData, $cache, $name)) {
- return;
- }
+=item $studentdata_table
- # This little delete thing, should not be here. Move some other
- # time though.
- if(defined($cache->{$name.':keys'})) {
- foreach (split(':::', $cache->{$name.':keys'})) {
- delete $cache->{$name.':'.$_};
- }
- delete $cache->{$name.':keys'};
- }
+The studentdata_table has four columns: 'student_id' (the unique id of
+the student), 'updatetime' (the time the students data was last updated),
+'fullupdatetime' (the time the students full data was last updated),
+'section', and 'classification'( the students current classification).
+This table has its PRIMARY KEY on 'student_id'.
- my %courseKeys;
- # user name:domain was prepended earlier in DownloadCourseInformation
- foreach (keys %$courseData) {
- my $currentKey = $_;
- $currentKey =~ s/^$name//;
- $courseKeys{$currentKey}++;
- $cache->{$_}=$courseData->{$_};
- }
+=back
- $cache->{$name.':keys'} = join(':::', keys(%courseKeys));
+=item Tables used to store current status data
- return;
-}
+The following tables store data only about the students current status on
+a problem, meaning only the data related to the last attempt on a problem.
-=pod
+=over 4
+
+=item $performance_table
+
+The performance_table has 9 columns. The first three are 'symb_id',
+'student_id', and 'part_id'. These comprise the PRIMARY KEY for this table
+and are directly related to the $symb_table, $student_table, and $part_table
+described above. MySQL does better indexing on numeric items than text,
+so we use these three "index tables". The remaining columns are
+'solved', 'tries', 'awarded', 'award', 'awarddetail', and 'timestamp'.
+These are either the MySQL type TINYTEXT or various integers ('tries' and
+'timestamp'). This table has KEYs of 'student_id' and 'symb_id'.
+For use of this table, see the functions described below.
+
+=item $parameters_table
+
+The parameters_table holds the data that does not fit neatly into the
+performance_table. The parameters table has four columns: 'symb_id',
+'student_id', 'parameter', and 'value'. 'symb_id', 'student_id', and
+'parameter' comprise the PRIMARY KEY for this table. 'parameter' is
+limited to 255 characters. 'value' is limited to 64k characters.
+
+=back
-=item &ExtractStudentData()
+=item Tables used for storing historic data
-HISTORY: This function originally existed in every statistics module,
-and performed different tasks, the had some overlap. Due to the need
-for the data from the different modules, they were combined into
-a single function.
-
-This function now extracts all the necessary course data for a student
-from what was downloaded from their homeserver. There is some extra
-time overhead compared to the ProcessStudentInformation function, but
-it would have had to occurred at some point anyways. This is now
-typically called while downloading the data it will process. It is
-the brother function to ProcessStudentInformation.
+The following tables are used to store almost all of the transactions a student
+has made on a homework problem. See loncapa/docs/homework/datastorage for
+specific information about each of the parameters stored.
=over 4
-Input: $input, $output, $data, $name
+=item $fulldump_response_table
-$input: A hash that contains the input data to be processed
+The response table holds data (documented in loncapa/docs/homework/datastorage)
+associated with a particular response id which is stored when a student
+attempts a problem. The following are the columns of the table, in order:
+'symb_id','part_id','response_id','student_id','transaction','tries',
+'awarddetail', 'response_specific' (data particular to the response
+type), 'response_specific_value', and 'submission (the text of the students
+submission). The primary key is based on the first five columns listed above.
+
+=item $fulldump_part_table
+
+The part table holds data (documented in loncapa/docs/homework/datastorage)
+associated with a particular part id which is stored when a student attempts
+a problem. The following are the columns of the table, in order:
+'symb_id','part_id','student_id','transaction','tries','award','awarded',
+and 'previous'. The primary key is based on the first five columns listed
+above.
+
+=item $fulldump_timestamp_table
+
+The timestamp table holds the timestamps of the transactions which are
+stored in $fulldump_response_table and $fulldump_part_table. This data is
+about both the response and part data. Columns: 'symb_id','student_id',
+'transaction', and 'timestamp'.
+The primary key is based on the first 3 columns.
-$output: A hash to contain the processed data
+=back
+
+=back
+
+=head3 Important Subroutines
+
+Here is a brief overview of the subroutines which are likely to be of
+interest:
-$data: A hash containing the information on what is to be
-processed and how (basically).
+=over 4
-$name: username:domain
+=item &get_current_state(): programmers interface.
-The input is slightly different here, but is quite simple.
-It is currently used where the $input, $output, and $data
-can and are often the same hashes, but they do not need
-to be.
+=item &init_dbs(): table creation
-Output: None
+=item &update_student_data(): data storage calls
-*NOTE: There is no output, but an error message is stored away in the cache
-data. This is checked in &FormatStudentData(). The key username:domain:error
-will only exist if an error occured. The error is an error from
-&DownloadCourseInformation().
+=item &get_student_data_from_performance_cache(): data retrieval
=back
-=cut
+=head3 Main Documentation
-sub ExtractStudentData {
- my ($input, $output, $data, $name)=@_;
+=over 4
- if(!&CheckDateStampError($input, $data, $name)) {
- return;
- }
+=cut
- # This little delete thing, should not be here. Move some other
- # time though.
- my %allkeys;
- if(defined($output->{$name.':keys'})) {
- foreach (split(':::', $output->{$name.':keys'})) {
- delete $output->{$name.':'.$_};
- }
- delete $output->{$name.':keys'};
- }
+################################################
+################################################
- my ($username,$domain)=split(':',$name);
+################################################
+################################################
+{ # Begin scope of table identifiers
- my $Version;
- my $problemsCorrect = 0;
- my $totalProblems = 0;
- my $problemsSolved = 0;
- my $numberOfParts = 0;
- my $totalAwarded = 0;
- foreach my $sequence (split(':', $data->{'orderedSequences'})) {
- foreach my $problemID (split(':', $data->{$sequence.':problems'})) {
- my $problem = $data->{$problemID.':problem'};
- my $LatestVersion = $input->{$name.':version:'.$problem};
-
- # Output dashes for all the parts of this problem if there
- # is no version information about the current problem.
- $output->{$name.':'.$problemID.':NoVersion'} = 'false';
- $allkeys{$name.':'.$problemID.':NoVersion'}++;
- if(!$LatestVersion) {
- foreach my $part (split(/\:/,$data->{$sequence.':'.
- $problemID.
- ':parts'})) {
- $output->{$name.':'.$problemID.':'.$part.':tries'} = 0;
- $output->{$name.':'.$problemID.':'.$part.':awarded'} = 0;
- $output->{$name.':'.$problemID.':'.$part.':code'} = ' ';
- $allkeys{$name.':'.$problemID.':'.$part.':tries'}++;
- $allkeys{$name.':'.$problemID.':'.$part.':awarded'}++;
- $allkeys{$name.':'.$problemID.':'.$part.':code'}++;
- $totalProblems++;
- }
- $output->{$name.':'.$problemID.':NoVersion'} = 'true';
- next;
- }
+my $current_course ='';
+my $symb_table;
+my $part_table;
+my $student_table;
+my $studentdata_table;
+my $performance_table;
+my $parameters_table;
+my $fulldump_response_table;
+my $fulldump_part_table;
+my $fulldump_timestamp_table;
- my %partData=undef;
- # Initialize part data, display skips correctly
- # Skip refers to when a student made no submissions on that
- # part/problem.
- foreach my $part (split(/\:/,$data->{$sequence.':'.
- $problemID.
- ':parts'})) {
- $partData{$part.':tries'}=0;
- $partData{$part.':code'}=' ';
- $partData{$part.':awarded'}=0;
- $partData{$part.':timestamp'}=0;
- foreach my $response (split(':', $data->{$sequence.':'.
- $problemID.':'.
- $part.':responseIDs'})) {
- $partData{$part.':'.$response.':submission'}='';
- }
- }
+my @Tables;
+################################################
+################################################
- # Looping through all the versions of each part, starting with the
- # oldest version. Basically, it gets the most recent
- # set of grade data for each part.
- my @submissions = ();
- for(my $Version=1; $Version<=$LatestVersion; $Version++) {
- foreach my $part (split(/\:/,$data->{$sequence.':'.
- $problemID.
- ':parts'})) {
-
- if(!defined($input->{"$name:$Version:$problem".
- ":resource.$part.solved"})) {
- # No grade for this submission, so skip
- next;
- }
+=pod
- my $tries=0;
- my $code=' ';
- my $awarded=0;
-
- $tries = $input->{$name.':'.$Version.':'.$problem.
- ':resource.'.$part.'.tries'};
- $awarded = $input->{$name.':'.$Version.':'.$problem.
- ':resource.'.$part.'.awarded'};
-
- $partData{$part.':awarded'}=($awarded) ? $awarded : 0;
- $partData{$part.':tries'}=($tries) ? $tries : 0;
-
- $partData{$part.':timestamp'}=$input->{$name.':'.$Version.':'.
- $problem.
- ':timestamp'};
- if(!$input->{$name.':'.$Version.':'.$problem.':resource.'.$part.
- '.previous'}) {
- foreach my $response (split(':',
- $data->{$sequence.':'.
- $problemID.':'.
- $part.':responseIDs'})) {
- @submissions=($input->{$name.':'.$Version.':'.
- $problem.
- ':resource.'.$part.'.'.
- $response.'.submission'},
- @submissions);
- }
- }
+=item &init_dbs()
- my $val = $input->{$name.':'.$Version.':'.$problem.
- ':resource.'.$part.'.solved'};
- if ($val eq 'correct_by_student') {$code = '*';}
- elsif ($val eq 'correct_by_override') {$code = '+';}
- elsif ($val eq 'incorrect_attempted') {$code = '.';}
- elsif ($val eq 'incorrect_by_override'){$code = '-';}
- elsif ($val eq 'excused') {$code = 'x';}
- elsif ($val eq 'ungraded_attempted') {$code = '#';}
- else {$code = ' ';}
- $partData{$part.':code'}=$code;
- }
- }
+Input: course id
- foreach my $part (split(/\:/,$data->{$sequence.':'.$problemID.
- ':parts'})) {
- $output->{$name.':'.$problemID.':'.$part.':wrong'} =
- $partData{$part.':tries'};
- $allkeys{$name.':'.$problemID.':'.$part.':wrong'}++;
-
- if($partData{$part.':code'} eq '*') {
- $output->{$name.':'.$problemID.':'.$part.':wrong'}--;
- $problemsCorrect++;
- } elsif($partData{$part.':code'} eq '+') {
- $output->{$name.':'.$problemID.':'.$part.':wrong'}--;
- $problemsCorrect++;
- }
+Output: 0 on success, positive integer on error
- $output->{$name.':'.$problemID.':'.$part.':tries'} =
- $partData{$part.':tries'};
- $output->{$name.':'.$problemID.':'.$part.':code'} =
- $partData{$part.':code'};
- $output->{$name.':'.$problemID.':'.$part.':awarded'} =
- $partData{$part.':awarded'};
- $allkeys{$name.':'.$problemID.':'.$part.':tries'}++;
- $allkeys{$name.':'.$problemID.':'.$part.':code'}++;
- $allkeys{$name.':'.$problemID.':'.$part.':awarded'}++;
-
- $totalAwarded += $partData{$part.':awarded'};
- $output->{$name.':'.$problemID.':'.$part.':timestamp'} =
- $partData{$part.':timestamp'};
- $allkeys{$name.':'.$problemID.':'.$part.':timestamp'}++;
-
- foreach my $response (split(':', $data->{$sequence.':'.
- $problemID.':'.
- $part.':responseIDs'})) {
- $output->{$name.':'.$problemID.':'.$part.':'.$response.
- ':submission'}=join(':::',@submissions);
- $allkeys{$name.':'.$problemID.':'.$part.':'.$response.
- ':submission'}++;
- }
+This routine issues the calls to lonmysql to create the tables used to
+store student data.
- if($partData{$part.':code'} ne 'x') {
- $totalProblems++;
- }
- }
- }
+=cut
- $output->{$name.':'.$sequence.':problemsCorrect'} = $problemsCorrect;
- $allkeys{$name.':'.$sequence.':problemsCorrect'}++;
- $problemsSolved += $problemsCorrect;
- $problemsCorrect=0;
+################################################
+################################################
+sub init_dbs {
+ my $courseid = shift;
+ &setup_table_names($courseid);
+ #
+ # Drop any of the existing tables
+ foreach my $table (@Tables) {
+ &Apache::lonmysql::drop_table($table);
}
+ #
+ # Note - changes to this table must be reflected in the code that
+ # stores the data (calls &Apache::lonmysql::store_row with this table
+ # id
+ my $symb_table_def = {
+ id => $symb_table,
+ permanent => 'no',
+ columns => [{ name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL',
+ auto_inc => 'yes', },
+ { name => 'symb',
+ type => 'MEDIUMTEXT',
+ restrictions => 'NOT NULL'},
+ ],
+ 'PRIMARY KEY' => ['symb_id'],
+ };
+ #
+ my $part_table_def = {
+ id => $part_table,
+ permanent => 'no',
+ columns => [{ name => 'part_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL',
+ auto_inc => 'yes', },
+ { name => 'part',
+ type => 'VARCHAR(100)',
+ restrictions => 'NOT NULL'},
+ ],
+ 'PRIMARY KEY' => ['part (100)'],
+ 'KEY' => [{ columns => ['part_id']},],
+ };
+ #
+ my $student_table_def = {
+ id => $student_table,
+ permanent => 'no',
+ columns => [{ name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL',
+ auto_inc => 'yes', },
+ { name => 'student',
+ type => 'VARCHAR(100)',
+ restrictions => 'NOT NULL'},
+ { name => 'classification',
+ type => 'varchar(100)', },
+ ],
+ 'PRIMARY KEY' => ['student (100)'],
+ 'KEY' => [{ columns => ['student_id']},],
+ };
+ #
+ my $studentdata_table_def = {
+ id => $studentdata_table,
+ permanent => 'no',
+ columns => [{ name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL UNIQUE',},
+ { name => 'updatetime',
+ type => 'INT UNSIGNED'},
+ { name => 'fullupdatetime',
+ type => 'INT UNSIGNED'},
+ { name => 'section',
+ type => 'VARCHAR(100)'},
+ { name => 'classification',
+ type => 'VARCHAR(100)', },
+ ],
+ 'PRIMARY KEY' => ['student_id'],
+ };
+ #
+ my $performance_table_def = {
+ id => $performance_table,
+ permanent => 'no',
+ columns => [{ name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'part_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'part',
+ type => 'VARCHAR(100)',
+ restrictions => 'NOT NULL'},
+ { name => 'solved',
+ type => 'TINYTEXT' },
+ { name => 'tries',
+ type => 'SMALLINT UNSIGNED' },
+ { name => 'awarded',
+ type => 'TINYTEXT' },
+ { name => 'award',
+ type => 'TINYTEXT' },
+ { name => 'awarddetail',
+ type => 'TINYTEXT' },
+ { name => 'timestamp',
+ type => 'INT UNSIGNED'},
+ ],
+ 'PRIMARY KEY' => ['symb_id','student_id','part_id'],
+ 'KEY' => [{ columns=>['student_id'] },
+ { columns=>['symb_id'] },],
+ };
+ #
+ my $fulldump_part_table_def = {
+ id => $fulldump_part_table,
+ permanent => 'no',
+ columns => [
+ { name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'part_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'transaction',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'tries',
+ type => 'SMALLINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'award',
+ type => 'TINYTEXT' },
+ { name => 'awarded',
+ type => 'TINYTEXT' },
+ { name => 'previous',
+ type => 'SMALLINT UNSIGNED' },
+# { name => 'regrader',
+# type => 'TINYTEXT' },
+# { name => 'afterduedate',
+# type => 'TINYTEXT' },
+ ],
+ 'PRIMARY KEY' => ['symb_id','part_id','student_id','transaction'],
+ 'KEY' => [
+ { columns=>['symb_id'] },
+ { columns=>['part_id'] },
+ { columns=>['student_id'] },
+ ],
+ };
+ #
+ my $fulldump_response_table_def = {
+ id => $fulldump_response_table,
+ permanent => 'no',
+ columns => [
+ { name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'part_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'response_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'transaction',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'awarddetail',
+ type => 'TINYTEXT' },
+# { name => 'message',
+# type => 'CHAR' },
+ { name => 'response_specific',
+ type => 'TINYTEXT' },
+ { name => 'response_specific_value',
+ type => 'TINYTEXT' },
+ { name => 'submission',
+ type => 'TEXT'},
+ ],
+ 'PRIMARY KEY' => ['symb_id','part_id','response_id','student_id',
+ 'transaction'],
+ 'KEY' => [
+ { columns=>['symb_id'] },
+ { columns=>['part_id','response_id'] },
+ { columns=>['student_id'] },
+ ],
+ };
+ my $fulldump_timestamp_table_def = {
+ id => $fulldump_timestamp_table,
+ permanent => 'no',
+ columns => [
+ { name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'transaction',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'timestamp',
+ type => 'INT UNSIGNED'},
+ ],
+ 'PRIMARY KEY' => ['symb_id','student_id','transaction'],
+ 'KEY' => [
+ { columns=>['symb_id'] },
+ { columns=>['student_id'] },
+ { columns=>['transaction'] },
+ ],
+ };
- $output->{$name.':problemsSolved'} = $problemsSolved;
- $output->{$name.':totalProblems'} = $totalProblems;
- $output->{$name.':totalAwarded'} = $totalAwarded;
- $allkeys{$name.':problemsSolved'}++;
- $allkeys{$name.':totalProblems'}++;
- $allkeys{$name.':totalAwarded'}++;
+ #
+ my $parameters_table_def = {
+ id => $parameters_table,
+ permanent => 'no',
+ columns => [{ name => 'symb_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'student_id',
+ type => 'MEDIUMINT UNSIGNED',
+ restrictions => 'NOT NULL' },
+ { name => 'parameter',
+ type => 'TINYTEXT',
+ restrictions => 'NOT NULL' },
+ { name => 'value',
+ type => 'MEDIUMTEXT' },
+ ],
+ 'PRIMARY KEY' => ['symb_id','student_id','parameter (255)'],
+ };
+ #
+ # Create the tables
+ my $tableid;
+ $tableid = &Apache::lonmysql::create_table($symb_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating symb_table: ".
+ &Apache::lonmysql::get_error());
+ return 1;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($part_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating part_table: ".
+ &Apache::lonmysql::get_error());
+ return 2;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($student_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating student_table: ".
+ &Apache::lonmysql::get_error());
+ return 3;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($studentdata_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating studentdata_table: ".
+ &Apache::lonmysql::get_error());
+ return 4;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($performance_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating preformance_table: ".
+ &Apache::lonmysql::get_error());
+ return 5;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($parameters_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating parameters_table: ".
+ &Apache::lonmysql::get_error());
+ return 6;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($fulldump_part_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating fulldump_part_table: ".
+ &Apache::lonmysql::get_error());
+ return 7;
+ }
+ #
+ $tableid = &Apache::lonmysql::create_table($fulldump_response_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating fulldump_response_table: ".
+ &Apache::lonmysql::get_error());
+ return 8;
+ }
+ $tableid = &Apache::lonmysql::create_table($fulldump_timestamp_table_def);
+ if (! defined($tableid)) {
+ &Apache::lonnet::logthis("error creating fulldump_timestamp_table: ".
+ &Apache::lonmysql::get_error());
+ return 9;
+ }
+ return 0;
+}
- $output->{$name.':keys'} = join(':::', keys(%allkeys));
+################################################
+################################################
- return;
-}
+=pod
-sub LoadDiscussion {
- my ($courseID)=@_;
- my %Discuss=();
- my %contrib=&Apache::lonnet::dump(
- $courseID,
- $ENV{'course.'.$courseID.'.domain'},
- $ENV{'course.'.$courseID.'.num'});
-
- #my %contrib=&DownloadCourseInformation($name, $courseID, 0);
+=item &delete_caches()
- foreach my $temp(keys %contrib) {
- if ($temp=~/^version/) {
- my $ver=$contrib{$temp};
- my ($dummy,$prb)=split(':',$temp);
- for (my $idx=1; $idx<=$ver; $idx++ ) {
- my $name=$contrib{"$idx:$prb:sendername"};
- $Discuss{"$name:$prb"}=$idx;
- }
- }
- }
+=cut
- return \%Discuss;
+################################################
+################################################
+sub delete_caches {
+ my $courseid = shift;
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ #
+ &setup_table_names($courseid);
+ #
+ my $dbh = &Apache::lonmysql::get_dbh();
+ foreach my $table (@Tables) {
+ my $command = 'DROP TABLE '.$table.';';
+ $dbh->do($command);
+ if ($dbh->err) {
+ &Apache::lonnet::logthis($command.' resulted in error: '.$dbh->errstr);
+ }
+ }
+ return;
}
-# ----- END PROCESSING FUNCTIONS ---------------------------------------
+################################################
+################################################
=pod
-=head1 HELPER FUNCTIONS
+=item &get_part_id()
+
+Get the MySQL id of a problem part string.
+
+Input: $part
-These are just a couple of functions do various odd and end
-jobs. There was also a couple of bulk functions added. These are
-&DownloadStudentCourseData(), &DownloadStudentCourseDataSeparate(), and
-&CheckForResidualDownload(). These functions now act as the interface
-for downloading student course data. The statistical modules should
-no longer make the calls to dump and download and process etc. They
-make calls to these bulk functions to get their data.
+Output: undef on error, integer $part_id on success.
+
+=item &get_part()
+
+Get the string describing a part from the MySQL id of the problem part.
+
+Input: $part_id
+
+Output: undef on error, $part string on success.
=cut
-# ----- HELPER FUNCTIONS -----------------------------------------------
+################################################
+################################################
-sub CheckDateStampError {
- my ($courseData, $cache, $name)=@_;
- if($courseData->{$name.':UpToDate'} eq 'true') {
- $cache->{$name.':lastDownloadTime'} =
- $courseData->{$name.':lastDownloadTime'};
- if($courseData->{$name.':lastDownloadTime'} eq 'Not downloaded') {
- $cache->{$name.':updateTime'} = ' Not updated';
- } else {
- $cache->{$name.':updateTime'}=
- localtime($courseData->{$name.':lastDownloadTime'});
+my $have_read_part_table = 0;
+my %ids_by_part;
+my %parts_by_id;
+
+sub get_part_id {
+ my ($part) = @_;
+ $part = 0 if (! defined($part));
+ if (! $have_read_part_table) {
+ my @Result = &Apache::lonmysql::get_rows($part_table);
+ foreach (@Result) {
+ $ids_by_part{$_->[1]}=$_->[0];
+ }
+ $have_read_part_table = 1;
+ }
+ if (! exists($ids_by_part{$part})) {
+ &Apache::lonmysql::store_row($part_table,[undef,$part]);
+ undef(%ids_by_part);
+ my @Result = &Apache::lonmysql::get_rows($part_table);
+ foreach (@Result) {
+ $ids_by_part{$_->[1]}=$_->[0];
}
- return 0;
- }
-
- $cache->{$name.':lastDownloadTime'}=$courseData->{$name.':lastDownloadTime'};
- if($courseData->{$name.':lastDownloadTime'} eq 'Not downloaded') {
- $cache->{$name.':updateTime'} = ' Not updated';
- } else {
- $cache->{$name.':updateTime'}=
- localtime($courseData->{$name.':lastDownloadTime'});
}
+ return $ids_by_part{$part} if (exists($ids_by_part{$part}));
+ return undef; # error
+}
- if(defined($courseData->{$name.':error'})) {
- $cache->{$name.':error'}=$courseData->{$name.':error'};
- return 0;
+sub get_part {
+ my ($part_id) = @_;
+ if (! exists($parts_by_id{$part_id}) ||
+ ! defined($parts_by_id{$part_id}) ||
+ $parts_by_id{$part_id} eq '') {
+ my @Result = &Apache::lonmysql::get_rows($part_table);
+ foreach (@Result) {
+ $parts_by_id{$_->[0]}=$_->[1];
+ }
}
-
- return 1;
+ return $parts_by_id{$part_id} if(exists($parts_by_id{$part_id}));
+ return undef; # error
}
+################################################
+################################################
+
=pod
-=item &ProcessFullName()
+=item &get_symb_id()
-Takes lastname, generation, firstname, and middlename (or some partial
-set of this data) and returns the full name version as a string. Format
-is Lastname generation, firstname middlename or a subset of this.
+Get the MySQL id of a symb.
-=cut
+Input: $symb
-sub ProcessFullName {
- my ($lastname, $generation, $firstname, $middlename)=@_;
- my $Str = '';
+Output: undef on error, integer $symb_id on success.
- # Strip whitespace preceeding & following name components.
- $lastname =~ s/(\s+$|^\s+)//g;
- $generation =~ s/(\s+$|^\s+)//g;
- $firstname =~ s/(\s+$|^\s+)//g;
- $middlename =~ s/(\s+$|^\s+)//g;
+=item &get_symb()
- if($lastname ne '') {
- $Str .= $lastname;
- $Str .= ' '.$generation if ($generation ne '');
- $Str .= ',';
- $Str .= ' '.$firstname if ($firstname ne '');
- $Str .= ' '.$middlename if ($middlename ne '');
- } else {
- $Str .= $firstname if ($firstname ne '');
- $Str .= ' '.$middlename if ($middlename ne '');
- $Str .= ' '.$generation if ($generation ne '');
+Get the symb associated with a MySQL symb_id.
+
+Input: $symb_id
+
+Output: undef on error, $symb on success.
+
+=cut
+
+################################################
+################################################
+
+my $have_read_symb_table = 0;
+my %ids_by_symb;
+my %symbs_by_id;
+
+sub get_symb_id {
+ my ($symb) = @_;
+ if (! $have_read_symb_table) {
+ my @Result = &Apache::lonmysql::get_rows($symb_table);
+ foreach (@Result) {
+ $ids_by_symb{$_->[1]}=$_->[0];
+ }
+ $have_read_symb_table = 1;
+ }
+ if (! exists($ids_by_symb{$symb})) {
+ &Apache::lonmysql::store_row($symb_table,[undef,$symb]);
+ undef(%ids_by_symb);
+ my @Result = &Apache::lonmysql::get_rows($symb_table);
+ foreach (@Result) {
+ $ids_by_symb{$_->[1]}=$_->[0];
+ }
}
+ return $ids_by_symb{$symb} if(exists( $ids_by_symb{$symb}));
+ return undef; # error
+}
- return $Str;
+sub get_symb {
+ my ($symb_id) = @_;
+ if (! exists($symbs_by_id{$symb_id}) ||
+ ! defined($symbs_by_id{$symb_id}) ||
+ $symbs_by_id{$symb_id} eq '') {
+ my @Result = &Apache::lonmysql::get_rows($symb_table);
+ foreach (@Result) {
+ $symbs_by_id{$_->[0]}=$_->[1];
+ }
+ }
+ return $symbs_by_id{$symb_id} if(exists( $symbs_by_id{$symb_id}));
+ return undef; # error
}
+################################################
+################################################
+
=pod
-=item &TestCacheData()
+=item &get_student_id()
-Determine if the cache database can be accessed with a tie. It waits up to
-ten seconds before returning failure. This function exists to help with
-the problems with stopping the data download. When an abort occurs and the
-user quickly presses a form button and httpd child is created. This
-child needs to wait for the other to finish (hopefully within ten seconds).
+Get the MySQL id of a student.
-=over 4
+Input: $sname, $dom
-Input: $ChartDB
+Output: undef on error, integer $student_id on success.
-$ChartDB: The name of the cache database to be opened
+=item &get_student()
-Output: -1, 0, 1
+Get student username:domain associated with the MySQL student_id.
--1: Could not tie database
- 0: Use cached data
- 1: New cache database created, use that.
+Input: $student_id
-=back
+Output: undef on error, string $student (username:domain) on success.
=cut
-sub TestCacheData {
- my ($ChartDB,$isRecalculate,$totalDelay)=@_;
- my $isCached=-1;
- my %testData;
- my $tieTries=0;
-
- if(!defined($totalDelay)) {
- $totalDelay = 10;
- }
+################################################
+################################################
- if ((-e "$ChartDB") && (!$isRecalculate)) {
- $isCached = 1;
- } else {
- $isCached = 0;
+my $have_read_student_table = 0;
+my %ids_by_student;
+my %students_by_id;
+
+sub get_student_id {
+ my ($sname,$sdom) = @_;
+ my $student = $sname.':'.$sdom;
+ if (! $have_read_student_table) {
+ my @Result = &Apache::lonmysql::get_rows($student_table);
+ foreach (@Result) {
+ $ids_by_student{$_->[1]}=$_->[0];
+ }
+ $have_read_student_table = 1;
+ }
+ if (! exists($ids_by_student{$student})) {
+ &Apache::lonmysql::store_row($student_table,
+ [undef,$student,undef]);
+ undef(%ids_by_student);
+ my @Result = &Apache::lonmysql::get_rows($student_table);
+ foreach (@Result) {
+ $ids_by_student{$_->[1]}=$_->[0];
+ }
}
+ return $ids_by_student{$student} if(exists( $ids_by_student{$student}));
+ return undef; # error
+}
- while($tieTries < $totalDelay) {
- my $result=0;
- if($isCached) {
- $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_READER(),0640);
- } else {
- $result=tie(%testData,'GDBM_File',$ChartDB,&GDBM_NEWDB(),0640);
- }
- if($result) {
- last;
+sub get_student {
+ my ($student_id) = @_;
+ if (! exists($students_by_id{$student_id}) ||
+ ! defined($students_by_id{$student_id}) ||
+ $students_by_id{$student_id} eq '') {
+ my @Result = &Apache::lonmysql::get_rows($student_table);
+ foreach (@Result) {
+ $students_by_id{$_->[0]}=$_->[1];
}
- $tieTries++;
- sleep 1;
- }
- if($tieTries >= $totalDelay) {
- return -1;
}
+ return $students_by_id{$student_id} if(exists($students_by_id{$student_id}));
+ return undef; # error
+}
- untie(%testData);
+################################################
+################################################
- return $isCached;
-}
+=pod
-sub DownloadStudentCourseData {
- my ($students,$checkDate,$cacheDB,$extract,$status,$courseID,$r,$c)=@_;
+=item &clear_internal_caches()
- my $title = 'LON-CAPA Statistics';
- my $heading = 'Download and Process Course Data';
- my $studentCount = scalar(@$students);
+Causes the internal caches used in get_student_id, get_student,
+get_symb_id, get_symb, get_part_id, and get_part to be undef'd.
- my $WhatIWant;
- $WhatIWant = '(^version:|';
- $WhatIWant .= '^\d+:.+?:(resource\.\d+\.';
- $WhatIWant .= '(solved|tries|previous|awarded|(\d+\.submission))\s*$';#'
- $WhatIWant .= '|timestamp)';
- $WhatIWant .= ')';
-# $WhatIWant = '.';
+Needs to be called before the first operation with the MySQL database
+for a given Apache request.
- if($status eq 'true') {
- &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);
- }
+=cut
- my $displayString;
- my $count=0;
- foreach (@$students) {
- my %cache;
+################################################
+################################################
+sub clear_internal_caches {
+ $have_read_part_table = 0;
+ undef(%ids_by_part);
+ undef(%parts_by_id);
+ $have_read_symb_table = 0;
+ undef(%ids_by_symb);
+ undef(%symbs_by_id);
+ $have_read_student_table = 0;
+ undef(%ids_by_student);
+ undef(%students_by_id);
+}
- if($c->aborted()) { return 'Aborted'; }
- if($status eq 'true') {
- $count++;
- my $displayString = $count.'/'.$studentCount.': '.$_;
- &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);
- }
+################################################
+################################################
- my $downloadTime='Not downloaded';
- my $needUpdate = 'false';
- if($checkDate eq 'true' &&
- tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
- $downloadTime = $cache{$_.':lastDownloadTime'};
- $needUpdate = $cache{'ResourceUpdated'};
- untie(%cache);
- }
+=pod
- if($c->aborted()) { return 'Aborted'; }
+=item &update_full_student_data($sname,$sdom,$courseid)
- if($needUpdate eq 'true') {
- $downloadTime = 'Not downloaded';
- }
- my $courseData =
- &DownloadCourseInformation($_, $courseID, $downloadTime,
- $WhatIWant);
- if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) {
- foreach my $key (keys(%$courseData)) {
- if($key =~ /^(con_lost|error|no_such_host)/i) {
- $courseData->{$_.':error'} = 'No course data for '.$_;
- last;
- }
- }
- if($extract eq 'true') {
- &ExtractStudentData($courseData, \%cache, \%cache, $_);
- } else {
- &ProcessStudentData(\%cache, $courseData, $_);
- }
- untie(%cache);
- } else {
- next;
- }
- }
- if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }
+Does a lonnet::dump on a student to populate the courses tables.
- return 'OK';
-}
+Input: $sname, $sdom, $courseid
-sub DownloadStudentCourseDataSeparate {
- my ($students,$checkDate,$cacheDB,$extract,$status,$courseID,$r,$c)=@_;
- my $residualFile = $Apache::lonnet::tmpdir.$courseID.'DownloadFile.db';
- my $title = 'LON-CAPA Statistics';
- my $heading = 'Download Course Data';
+Output: $returnstatus
- my $WhatIWant;
- $WhatIWant = '(^version:|';
- $WhatIWant .= '^\d+:.+?:(resource\.\d+\.';
- $WhatIWant .= '(solved|tries|previous|awarded|(\d+\.submission))\s*$';#'
- $WhatIWant .= '|timestamp)';
- $WhatIWant .= ')';
+$returnstatus is a string describing any errors that occured. 'okay' is the
+default.
+
+This subroutine loads a students data using lonnet::dump and inserts
+it into the MySQL database. The inserts are done on three tables,
+$fulldump_response_table, $fulldump_part_table, and $fulldump_timestamp_table.
+The INSERT calls are made directly by this subroutine, not through lonmysql
+because we do a 'bulk'insert which takes advantage of MySQLs non-SQL
+compliant INSERT command to insert multiple rows at a time.
+If anything has gone wrong during this process, $returnstatus is updated with
+a description of the error.
+
+Once the "fulldump" tables are updated, the tables used for chart and
+spreadsheet (which hold only the current state of the student on their
+homework, not historical data) are updated. If all updates have occured
+successfully, the studentdata table is updated to reflect the time of the
+update.
+
+Notice we do not insert the data and immediately query it. This means it
+is possible for there to be data returned this first time that is not
+available the second time. CYA.
- &CheckForResidualDownload($cacheDB, 'true', 'true', $courseID, $r, $c);
+=cut
- my $studentCount = scalar(@$students);
- if($status eq 'true') {
- &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);
+################################################
+################################################
+sub update_full_student_data {
+ my ($sname,$sdom,$courseid) = @_;
+ #
+ # Set up database names
+ &setup_table_names($courseid);
+ #
+ my $student_id = &get_student_id($sname,$sdom);
+ my $student = $sname.':'.$sdom;
+ #
+ my $returnstatus = 'okay';
+ #
+ # Download students data
+ my $time_of_retrieval = time;
+ my @tmp = &Apache::lonnet::dump($courseid,$sdom,$sname);
+ if (@tmp && $tmp[0] =~ /^error/) {
+ $returnstatus = 'error retrieving full student data';
+ return $returnstatus;
+ } elsif (! @tmp) {
+ $returnstatus = 'okay: no student data';
+ return $returnstatus;
}
- my $count=0;
- my $displayString='';
- foreach (@$students) {
- if($c->aborted()) {
- return 'Aborted';
- }
-
- if($status eq 'true') {
- $count++;
- $displayString = $count.'/'.$studentCount.': '.$_;
- &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);
+ my %studentdata = @tmp;
+ #
+ # Get database handle and clean out the tables
+ my $dbh = &Apache::lonmysql::get_dbh();
+ $dbh->do('DELETE FROM '.$fulldump_response_table.' WHERE student_id='.
+ $student_id);
+ $dbh->do('DELETE FROM '.$fulldump_part_table.' WHERE student_id='.
+ $student_id);
+ $dbh->do('DELETE FROM '.$fulldump_timestamp_table.' WHERE student_id='.
+ $student_id);
+ #
+ # Parse and store the data into a form we can handle
+ my $partdata;
+ my $respdata;
+ while (my ($key,$value) = each(%studentdata)) {
+ next if ($key =~ /^(\d+):(resource$|subnum$|keys:)/);
+ my ($transaction,$symb,$parameter) = split(':',$key);
+ my $symb_id = &get_symb_id($symb);
+ if ($parameter eq 'timestamp') {
+ # We can deal with 'timestamp' right away
+ my @timestamp_storage = ($symb_id,$student_id,
+ $transaction,$value);
+ my $store_command = 'INSERT IGNORE INTO '.$fulldump_timestamp_table.
+ " VALUES ('".join("','",@timestamp_storage)."');";
+ $dbh->do($store_command);
+ if ($dbh->err()) {
+ &Apache::lonnet::logthis('unable to execute '.$store_command);
+ &Apache::lonnet::logthis($dbh->errstr());
+ }
+ next;
+ } elsif ($parameter eq 'version') {
+ next;
+ } elsif ($parameter =~ /^resource\.(.*)\.(tries|
+ award|
+ awarded|
+ previous|
+ solved|
+ awarddetail|
+ submission|
+ submissiongrading|
+ molecule)\s*$/x){
+ # we do not have enough information to store an
+ # entire row, so we save it up until later.
+ my ($part_and_resp_id,$field) = ($1,$2);
+ my ($part,$part_id,$resp,$resp_id);
+ if ($part_and_resp_id =~ /\./) {
+ ($part,$resp) = split(/\./,$part_and_resp_id);
+ $part_id = &get_part_id($part);
+ $resp_id = &get_part_id($resp);
+ } else {
+ $part_id = &get_part_id($part_and_resp_id);
+ }
+ # Deal with part specific data
+ if ($field =~ /^(tries|award|awarded|previous)$/) {
+ $partdata->{$symb_id}->{$part_id}->{$transaction}->{$field}=$value;
+ }
+ # deal with response specific data
+ if (defined($resp_id) &&
+ $field =~ /^(awarddetail|
+ submission|
+ submissiongrading|
+ molecule)$/x) {
+ if ($field eq 'submission') {
+ # We have to be careful with user supplied input.
+ # most of the time we are okay because it is escaped.
+ # However, there is one wrinkle: submissions which end in
+ # and odd number of '\' cause insert errors to occur.
+ # Best trap this somehow...
+ $value =~ s/\'/\\\'/g;
+ my ($offensive_string) = ($value =~ /(\\+)$/);
+ if (length($offensive_string) % 2) {
+ $value =~ s/\\$/\\\\/;
+ }
+ }
+ if ($field eq 'submissiongrading' ||
+ $field eq 'molecule') {
+ $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific'}=$field;
+ $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{'response_specific_value'}=$value;
+ } else {
+ $respdata->{$symb_id}->{$part_id}->{$resp_id}->{$transaction}->{$field}=$value;
+ }
+ }
}
-
- my %cache;
- my $downloadTime='Not downloaded';
- my $needUpdate = 'false';
- if($checkDate eq 'true' &&
- tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
- $downloadTime = $cache{$_.':lastDownloadTime'};
- $needUpdate = $cache{'ResourceUpdated'};
- untie(%cache);
+ }
+ ##
+ ## Store the part data
+ my $store_command = 'INSERT IGNORE INTO '.$fulldump_part_table.
+ ' VALUES '."\n";
+ my $store_rows = 0;
+ while (my ($symb_id,$hash1) = each (%$partdata)) {
+ while (my ($part_id,$hash2) = each (%$hash1)) {
+ while (my ($transaction,$data) = each (%$hash2)) {
+ $store_command .= "('".join("','",$symb_id,$part_id,
+ $student_id,
+ $transaction,
+ $data->{'tries'},
+ $data->{'award'},
+ $data->{'awarded'},
+ $data->{'previous'})."'),";
+ $store_rows++;
+ }
}
-
- if($c->aborted()) {
- return 'Aborted';
+ }
+ if ($store_rows) {
+ chop($store_command);
+ $dbh->do($store_command);
+ if ($dbh->err) {
+ $returnstatus = 'error storing part data';
+ &Apache::lonnet::logthis('insert error '.$dbh->errstr());
+ &Apache::lonnet::logthis("While attempting\n".$store_command);
}
-
- if($needUpdate eq 'true') {
- $downloadTime = 'Not downloaded';
- }
-
- my $error = 0;
- my $courseData =
- &DownloadCourseInformation($_, $courseID, $downloadTime,
- $WhatIWant);
- my %downloadData;
- unless(tie(%downloadData,'GDBM_File',$residualFile,
- &GDBM_WRCREAT(),0640)) {
- return 'Failed to tie temporary download hash.';
- }
- foreach my $key (keys(%$courseData)) {
- $downloadData{$key} = $courseData->{$key};
- if($key =~ /^(con_lost|error|no_such_host)/i) {
- $error = 1;
- last;
+ }
+ ##
+ ## Store the response data
+ $store_command = 'INSERT IGNORE INTO '.$fulldump_response_table.
+ ' VALUES '."\n";
+ $store_rows = 0;
+ while (my ($symb_id,$hash1) = each (%$respdata)) {
+ while (my ($part_id,$hash2) = each (%$hash1)) {
+ while (my ($resp_id,$hash3) = each (%$hash2)) {
+ while (my ($transaction,$data) = each (%$hash3)) {
+ $store_command .= "('".join("','",$symb_id,$part_id,
+ $resp_id,$student_id,
+ $transaction,
+ $data->{'awarddetail'},
+ $data->{'response_specific'},
+ $data->{'response_specific_value'},
+ $data->{'submission'})."'),";
+ $store_rows++;
+ }
}
}
- if($error) {
- foreach my $deleteKey (keys(%$courseData)) {
- delete $downloadData{$deleteKey};
- }
- $downloadData{$_.':error'} = 'No course data for '.$_;
+ }
+ if ($store_rows) {
+ chop($store_command);
+ $dbh->do($store_command);
+ if ($dbh->err) {
+ $returnstatus = 'error storing response data';
+ &Apache::lonnet::logthis('insert error '.$dbh->errstr());
+ &Apache::lonnet::logthis("While attempting\n".$store_command);
}
- untie(%downloadData);
}
- if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }
-
- return &CheckForResidualDownload($cacheDB, 'true', 'true',
- $courseID, $r, $c);
+ ##
+ ## Update the students "current" data in the performance
+ ## and parameters tables.
+ my ($status,undef) = &store_student_data
+ ($sname,$sdom,$courseid,
+ &Apache::lonnet::convert_dump_to_currentdump(\%studentdata));
+ if ($returnstatus eq 'okay' && $status ne 'okay') {
+ $returnstatus = 'error storing current data:'.$status;
+ } elsif ($status ne 'okay') {
+ $returnstatus .= ' error storing current data:'.$status;
+ }
+ ##
+ ## Update the students time......
+ if ($returnstatus eq 'okay') {
+ &Apache::lonmysql::replace_row
+ ($studentdata_table,
+ [$student_id,$time_of_retrieval,$time_of_retrieval,undef,undef]);
+ }
+ return $returnstatus;
}
-sub CheckForResidualDownload {
- my ($cacheDB,$extract,$status,$courseID,$r,$c)=@_;
+################################################
+################################################
- my $residualFile = $Apache::lonnet::tmpdir.$courseID.'DownloadFile.db';
- if(!-e $residualFile) {
- return 'OK';
- }
+=pod
+
+=item &update_student_data()
+
+Input: $sname, $sdom, $courseid
+
+Output: $returnstatus, \%student_data
- my %downloadData;
- my %cache;
- unless(tie(%downloadData,'GDBM_File',$residualFile,&GDBM_READER(),0640)) {
- return 'Can not tie database for check for residual download: tempDB';
+$returnstatus is a string describing any errors that occured. 'okay' is the
+default.
+\%student_data is the data returned by a call to lonnet::currentdump.
+
+This subroutine loads a students data using lonnet::currentdump and inserts
+it into the MySQL database. The inserts are done on two tables,
+$performance_table and $parameters_table. $parameters_table holds the data
+that is not included in $performance_table. See the description of
+$performance_table elsewhere in this file. The INSERT calls are made
+directly by this subroutine, not through lonmysql because we do a 'bulk'
+insert which takes advantage of MySQLs non-SQL compliant INSERT command to
+insert multiple rows at a time. If anything has gone wrong during this
+process, $returnstatus is updated with a description of the error and
+\%student_data is returned.
+
+Notice we do not insert the data and immediately query it. This means it
+is possible for there to be data returned this first time that is not
+available the second time. CYA.
+
+=cut
+
+################################################
+################################################
+sub update_student_data {
+ my ($sname,$sdom,$courseid) = @_;
+ #
+ # Set up database names
+ &setup_table_names($courseid);
+ #
+ my $student_id = &get_student_id($sname,$sdom);
+ my $student = $sname.':'.$sdom;
+ #
+ my $returnstatus = 'okay';
+ #
+ # Download students data
+ my $time_of_retrieval = time;
+ my @tmp = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
+ if ((scalar(@tmp) > 0) && ($tmp[0] =~ /^error:/)) {
+ &Apache::lonnet::logthis('error getting data for '.
+ $sname.':'.$sdom.' in course '.$courseid.
+ ':'.$tmp[0]);
+ $returnstatus = 'error getting data';
+ return ($returnstatus,undef);
}
- unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) {
- untie(%downloadData);
- return 'Can not tie database for check for residual download: cacheDB';
+ if (scalar(@tmp) < 1) {
+ return ('no data',undef);
}
-
- my @students=();
- my %checkStudent;
- my $key;
- while(($key, undef) = each %downloadData) {
- my @temp = split(':', $key);
- my $student = $temp[0].':'.$temp[1];
- if(!defined($checkStudent{$student})) {
- $checkStudent{$student}++;
- push(@students, $student);
- }
+ my %student_data = @tmp;
+ my @Results = &store_student_data($sname,$sdom,$courseid,\%student_data);
+ #
+ # Set the students update time
+ if ($Results[0] eq 'okay') {
+ &Apache::lonmysql::replace_row($studentdata_table,
+ [$student_id,$time_of_retrieval,undef,undef,undef]);
}
+ #
+ return @Results;
+}
- my $heading = 'Process Course Data';
- my $title = 'LON-CAPA Statistics';
- my $studentCount = scalar(@students);
- if($status eq 'true') {
- &Apache::lonhtmlcommon::Create_PrgWin($r, $title, $heading);
+sub store_student_data {
+ my ($sname,$sdom,$courseid,$student_data) = @_;
+ #
+ my $student_id = &get_student_id($sname,$sdom);
+ my $student = $sname.':'.$sdom;
+ #
+ my $returnstatus = 'okay';
+ #
+ # Remove all of the students data from the table
+ my $dbh = &Apache::lonmysql::get_dbh();
+ $dbh->do('DELETE FROM '.$performance_table.' WHERE student_id='.
+ $student_id);
+ $dbh->do('DELETE FROM '.$parameters_table.' WHERE student_id='.
+ $student_id);
+ #
+ # Store away the data
+ #
+ my $starttime = Time::HiRes::time;
+ my $elapsed = 0;
+ my $rows_stored;
+ my $store_parameters_command = 'INSERT IGNORE INTO '.$parameters_table.
+ ' VALUES '."\n";
+ my $num_parameters = 0;
+ my $store_performance_command = 'INSERT IGNORE INTO '.$performance_table.
+ ' VALUES '."\n";
+ return ('error',undef) if (! defined($dbh));
+ while (my ($current_symb,$param_hash) = each(%{$student_data})) {
+ #
+ # make sure the symb is set up properly
+ my $symb_id = &get_symb_id($current_symb);
+ #
+ # Load data into the tables
+ while (my ($parameter,$value) = each(%$param_hash)) {
+ my $newstring;
+ if ($parameter !~ /(timestamp|resource\.(.*)\.(solved|tries|awarded|award|awarddetail|previous))/) {
+ $newstring = "('".join("','",
+ $symb_id,$student_id,
+ $parameter)."',".
+ $dbh->quote($value)."),\n";
+ $num_parameters ++;
+ if ($newstring !~ /''/) {
+ $store_parameters_command .= $newstring;
+ $rows_stored++;
+ }
+ }
+ next if ($parameter !~ /^resource\.(.*)\.solved$/);
+ #
+ my $part = $1;
+ my $part_id = &get_part_id($part);
+ next if (!defined($part_id));
+ my $solved = $value;
+ my $tries = $param_hash->{'resource.'.$part.'.tries'};
+ my $awarded = $param_hash->{'resource.'.$part.'.awarded'};
+ my $award = $param_hash->{'resource.'.$part.'.award'};
+ my $awarddetail = $param_hash->{'resource.'.$part.'.awarddetail'};
+ my $timestamp = $param_hash->{'timestamp'};
+ #
+ $solved = '' if (! defined($solved));
+ $tries = '' if (! defined($tries));
+ $awarded = '' if (! defined($awarded));
+ $award = '' if (! defined($award));
+ $awarddetail = '' if (! defined($awarddetail));
+ $newstring = "('".join("','",$symb_id,$student_id,$part_id,$part,
+ $solved,$tries,$awarded,$award,
+ $awarddetail,$timestamp)."'),\n";
+ $store_performance_command .= $newstring;
+ $rows_stored++;
+ }
+ }
+ chop $store_parameters_command;
+ chop $store_parameters_command;
+ chop $store_performance_command;
+ chop $store_performance_command;
+ my $start = Time::HiRes::time;
+ $dbh->do($store_performance_command);
+ if ($dbh->err()) {
+ &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
+ &Apache::lonnet::logthis('command = '.$store_performance_command);
+ $returnstatus = 'error: unable to insert performance into database';
+ return ($returnstatus,$student_data);
+ }
+ $dbh->do($store_parameters_command) if ($num_parameters>0);
+ if ($dbh->err()) {
+ &Apache::lonnet::logthis(' bigass insert error:'.$dbh->errstr());
+ &Apache::lonnet::logthis('command = '.$store_parameters_command);
+ &Apache::lonnet::logthis('rows_stored = '.$rows_stored);
+ &Apache::lonnet::logthis('student_id = '.$student_id);
+ $returnstatus = 'error: unable to insert parameters into database';
+ return ($returnstatus,$student_data);
}
+ $elapsed += Time::HiRes::time - $start;
+ return ($returnstatus,$student_data);
+}
- my $count=1;
- foreach my $name (@students) {
- last if($c->aborted());
+######################################
+######################################
- if($status eq 'true') {
- my $displayString = $count.'/'.$studentCount.': '.$name;
- &Apache::lonhtmlcommon::Update_PrgWin($displayString, $r);
- }
+=pod
+
+=item &ensure_tables_are_set_up($courseid)
+
+Checks to be sure the MySQL tables for the given class are set up.
+If $courseid is omitted it will be obtained from the environment.
+
+Returns nothing on success and 'error' on failure
+
+=cut
- if($extract eq 'true') {
- &ExtractStudentData(\%downloadData, \%cache, \%cache, $name);
- } else {
- &ProcessStudentData(\%cache, \%downloadData, $name);
+######################################
+######################################
+sub ensure_tables_are_set_up {
+ my ($courseid) = @_;
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ #
+ # Clean out package variables
+ &setup_table_names($courseid);
+ #
+ # if the tables do not exist, make them
+ my @CurrentTable = &Apache::lonmysql::tables_in_db();
+ my ($found_symb,$found_student,$found_part,$found_studentdata,
+ $found_performance,$found_parameters,$found_fulldump_part,
+ $found_fulldump_response,$found_fulldump_timestamp);
+ foreach (@CurrentTable) {
+ $found_symb = 1 if ($_ eq $symb_table);
+ $found_student = 1 if ($_ eq $student_table);
+ $found_part = 1 if ($_ eq $part_table);
+ $found_studentdata = 1 if ($_ eq $studentdata_table);
+ $found_performance = 1 if ($_ eq $performance_table);
+ $found_parameters = 1 if ($_ eq $parameters_table);
+ $found_fulldump_part = 1 if ($_ eq $fulldump_part_table);
+ $found_fulldump_response = 1 if ($_ eq $fulldump_response_table);
+ $found_fulldump_timestamp = 1 if ($_ eq $fulldump_timestamp_table);
+ }
+ if (!$found_symb || !$found_studentdata ||
+ !$found_student || !$found_part ||
+ !$found_performance || !$found_parameters ||
+ !$found_fulldump_part || !$found_fulldump_response ||
+ !$found_fulldump_timestamp ) {
+ if (&init_dbs($courseid)) {
+ return 'error';
}
- $count++;
}
+}
- if($status eq 'true') { &Apache::lonhtmlcommon::Close_PrgWin($r); }
+################################################
+################################################
- untie(%cache);
- untie(%downloadData);
+=pod
- if(!$c->aborted()) {
- my @files = ($residualFile);
- unlink(@files);
- }
+=item &ensure_current_data()
- return 'OK';
-}
+Input: $sname, $sdom, $courseid
+
+Output: $status, $data
+
+This routine ensures the data for a given student is up to date.
+The $studentdata_table is queried to determine the time of the last update.
+If the students data is out of date, &update_student_data() is called.
+The return values from the call to &update_student_data() are returned.
+=cut
+
+################################################
+################################################
+sub ensure_current_data {
+ my ($sname,$sdom,$courseid) = @_;
+ my $status = 'okay'; # return value
+ #
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ &ensure_tables_are_set_up($courseid);
+ #
+ # Get the update time for the user
+ my $updatetime = 0;
+ my $modifiedtime = &Apache::lonnet::GetFileTimestamp
+ ($sdom,$sname,$courseid.'.db',
+ $Apache::lonnet::perlvar{'lonUsersDir'});
+ #
+ my $student_id = &get_student_id($sname,$sdom);
+ my @Result = &Apache::lonmysql::get_rows($studentdata_table,
+ "student_id ='$student_id'");
+ my $data = undef;
+ if (@Result) {
+ $updatetime = $Result[0]->[1];
+ }
+ if ($modifiedtime > $updatetime) {
+ ($status,$data) = &update_student_data($sname,$sdom,$courseid);
+ }
+ return ($status,$data);
+}
################################################
################################################
=pod
-=item &make_into_hash($values);
+=item &ensure_current_full_data($sname,$sdom,$courseid)
-Returns a reference to a hash as described by $values. $values is
-assumed to be the result of
- join(':',map {&Apache::lonnet::escape($_)} %orighash;
+Input: $sname, $sdom, $courseid
-This is a helper function for get_current_state.
+Output: $status
+
+This routine ensures the fulldata (the data from a lonnet::dump, not a
+lonnet::currentdump) for a given student is up to date.
+The $studentdata_table is queried to determine the time of the last update.
+If the students fulldata is out of date, &update_full_student_data() is
+called.
+
+The return value from the call to &update_full_student_data() is returned.
=cut
################################################
################################################
-sub make_into_hash {
- my $values = shift;
- my %tmp = map { &Apache::lonnet::unescape($_); }
- split(':',$values);
- return \%tmp;
+sub ensure_current_full_data {
+ my ($sname,$sdom,$courseid) = @_;
+ my $status = 'okay'; # return value
+ #
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ &ensure_tables_are_set_up($courseid);
+ #
+ # Get the update time for the user
+ my $modifiedtime = &Apache::lonnet::GetFileTimestamp
+ ($sdom,$sname,$courseid.'.db',
+ $Apache::lonnet::perlvar{'lonUsersDir'});
+ #
+ my $student_id = &get_student_id($sname,$sdom);
+ my @Result = &Apache::lonmysql::get_rows($studentdata_table,
+ "student_id ='$student_id'");
+ my $updatetime;
+ if (@Result && ref($Result[0]) eq 'ARRAY') {
+ $updatetime = $Result[0]->[2];
+ }
+ if (! defined($updatetime) || $modifiedtime > $updatetime) {
+ $status = &update_full_student_data($sname,$sdom,$courseid);
+ }
+ return $status;
}
+################################################
+################################################
+
+=pod
+
+=item &get_student_data_from_performance_cache()
+
+Input: $sname, $sdom, $symb, $courseid
+
+Output: hash reference containing the data for the given student.
+If $symb is undef, all the students data is returned.
+
+This routine is the heart of the local caching system. See the description
+of $performance_table, $symb_table, $student_table, and $part_table. The
+main task is building the MySQL request. The tables appear in the request
+in the order in which they should be parsed by MySQL. When searching
+on a student the $student_table is used to locate the 'student_id'. All
+rows in $performance_table which have a matching 'student_id' are returned,
+with data from $part_table and $symb_table which match the entries in
+$performance_table, 'part_id' and 'symb_id'. When searching on a symb,
+the $symb_table is processed first, with matching rows grabbed from
+$performance_table and filled in from $part_table and $student_table in
+that order.
+
+Running 'EXPLAIN ' on the 'SELECT' statements generated can be quite
+interesting, especially if you play with the order the tables are listed.
+
+=cut
+
+################################################
+################################################
+sub get_student_data_from_performance_cache {
+ my ($sname,$sdom,$symb,$courseid)=@_;
+ my $student = $sname.':'.$sdom if (defined($sname) && defined($sdom));
+ &setup_table_names($courseid);
+ #
+ # Return hash
+ my $studentdata;
+ #
+ my $dbh = &Apache::lonmysql::get_dbh();
+ my $request = "SELECT ".
+ "d.symb,a.part,a.solved,a.tries,a.awarded,a.award,a.awarddetail,".
+ "a.timestamp ";
+ if (defined($student)) {
+ $request .= "FROM $student_table AS b ".
+ "LEFT JOIN $performance_table AS a ON b.student_id=a.student_id ".
+# "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
+ "LEFT JOIN $symb_table AS d ON d.symb_id = a.symb_id ".
+ "WHERE student='$student'";
+ if (defined($symb) && $symb ne '') {
+ $request .= " AND d.symb=".$dbh->quote($symb);
+ }
+ } elsif (defined($symb) && $symb ne '') {
+ $request .= "FROM $symb_table as d ".
+ "LEFT JOIN $performance_table AS a ON d.symb_id=a.symb_id ".
+# "LEFT JOIN $part_table AS c ON c.part_id = a.part_id ".
+ "LEFT JOIN $student_table AS b ON b.student_id = a.student_id ".
+ "WHERE symb='".$dbh->quote($symb)."'";
+ }
+ my $starttime = Time::HiRes::time;
+ my $rows_retrieved = 0;
+ my $sth = $dbh->prepare($request);
+ $sth->execute();
+ if ($sth->err()) {
+ &Apache::lonnet::logthis("Unable to execute MySQL request:");
+ &Apache::lonnet::logthis("\n".$request."\n");
+ &Apache::lonnet::logthis("error is:".$sth->errstr());
+ return undef;
+ }
+ foreach my $row (@{$sth->fetchall_arrayref}) {
+ $rows_retrieved++;
+ my ($symb,$part,$solved,$tries,$awarded,$award,$awarddetail,$time) =
+ (@$row);
+ my $base = 'resource.'.$part;
+ $studentdata->{$symb}->{$base.'.solved'} = $solved;
+ $studentdata->{$symb}->{$base.'.tries'} = $tries;
+ $studentdata->{$symb}->{$base.'.awarded'} = $awarded;
+ $studentdata->{$symb}->{$base.'.award'} = $award;
+ $studentdata->{$symb}->{$base.'.awarddetail'} = $awarddetail;
+ $studentdata->{$symb}->{'timestamp'} = $time if (defined($time) && $time ne '');
+ }
+ ## Get misc parameters
+ $request = 'SELECT c.symb,a.parameter,a.value '.
+ "FROM $student_table AS b ".
+ "LEFT JOIN $parameters_table AS a ON b.student_id=a.student_id ".
+ "LEFT JOIN $symb_table AS c ON c.symb_id = a.symb_id ".
+ "WHERE student='$student'";
+ if (defined($symb) && $symb ne '') {
+ $request .= " AND c.symb=".$dbh->quote($symb);
+ }
+ $sth = $dbh->prepare($request);
+ $sth->execute();
+ if ($sth->err()) {
+ &Apache::lonnet::logthis("Unable to execute MySQL request:");
+ &Apache::lonnet::logthis("\n".$request."\n");
+ &Apache::lonnet::logthis("error is:".$sth->errstr());
+ if (defined($symb) && $symb ne '') {
+ $studentdata = $studentdata->{$symb};
+ }
+ return $studentdata;
+ }
+ #
+ foreach my $row (@{$sth->fetchall_arrayref}) {
+ $rows_retrieved++;
+ my ($symb,$parameter,$value) = (@$row);
+ $studentdata->{$symb}->{$parameter} = $value;
+ }
+ #
+ if (defined($symb) && $symb ne '') {
+ $studentdata = $studentdata->{$symb};
+ }
+ return $studentdata;
+}
################################################
################################################
=pod
-=item &get_current_state($sname,$sdom,$symb,$courseid);
+=item &get_current_state()
+
+Input: $sname,$sdom,$symb,$courseid
+
+Output: Described below
Retrieve the current status of a students performance. $sname and
$sdom are the only required parameters. If $symb is undef the results
@@ -1561,7 +1771,7 @@ If $symb is specified, a hash of
)
is returned.
-If no data is found for $symb, or if the student has not performance data,
+If no data is found for $symb, or if the student has no performance data,
an empty list is returned.
=cut
@@ -1570,100 +1780,395 @@ an empty list is returned.
################################################
sub get_current_state {
my ($sname,$sdom,$symb,$courseid,$forcedownload)=@_;
- return () if (! defined($sname) || ! defined($sdom));
#
$courseid = $ENV{'request.course.id'} if (! defined($courseid));
#
- my $cachefilename = $Apache::lonnet::tmpdir.$ENV{'user.name'}.'_'.
- $ENV{'user.domain'}.'_'.
- $courseid.'_student_data.db';
- my %cache;
+ return () if (! defined($sname) || ! defined($sdom));
#
- my %student_data; # return values go here
+ my ($status,$data) = &ensure_current_data($sname,$sdom,$courseid);
+# &Apache::lonnet::logthis
+# ('sname = '.$sname.
+# ' domain = '.$sdom.
+# ' status = '.$status.
+# ' data is '.(defined($data)?'defined':'undefined'));
+# while (my ($symb,$hash) = each(%$data)) {
+# &Apache::lonnet::logthis($symb."\n----------------------------------");
+# while (my ($key,$value) = each (%$hash)) {
+# &Apache::lonnet::logthis(" ".$key." = ".$value);
+# }
+# }
#
- my $updatetime = 0;
- my $key = &Apache::lonnet::escape($sname).':'.
- &Apache::lonnet::escape($sdom).':';
- # Open the cache file
- if (tie(%cache,'GDBM_File',$cachefilename,&GDBM_READER(),0640)) {
- if (exists($cache{$key.'time'})) {
- $updatetime = $cache{$key.'time'};
-# &Apache::lonnet::logthis('got updatetime of '.$updatetime);
- }
- untie(%cache);
- }
- # timestamp/devalidation
- my $modifiedtime = 1;
- # Take whatever steps are neccessary at this point to give $modifiedtime a
- # new value
- #
- if (($updatetime < $modifiedtime) ||
- (defined($forcedownload) && $forcedownload)) {
-# &Apache::lonnet::logthis("loading data");
- # Get all the students current data
- my $time_of_retrieval = time;
- my @tmp = &Apache::lonnet::currentdump($courseid,$sdom,$sname);
- if ((scalar(@tmp) > 0) && ($tmp[0] =~ /^error:/)) {
- &Apache::lonnet::logthis('error getting data for '.
- $sname.':'.$sdom.' in course '.$courseid.
- ':'.$tmp[0]);
- return ();
- }
- %student_data = @tmp;
- #
- # Store away the data
- #
- # The cache structure is colon deliminated.
- # $uname:$udom:time => timestamp
- # $uname:$udom:$symb => $parm1:$val1:$parm2:$val2 ...
- #
- # BEWARE: The colons are NOT escaped so can search with escaped
- # keys instead of unescaping every key.
- #
- if (tie(%cache,'GDBM_File',$cachefilename,&GDBM_WRCREAT(),0640)) {
-# &Apache::lonnet::logthis("writing data");
- while (my ($current_symb,$param_hash) = each(%student_data)) {
- my @Parameters = %{$param_hash};
- my $value = join(':',map { &Apache::lonnet::escape($_); }
- @Parameters);
- # Store away the values
- $cache{$key.&Apache::lonnet::escape($current_symb)}=$value;
- }
- $cache{$key.'time'}=$time_of_retrieval;
- untie(%cache);
- }
+ if (defined($data) && defined($symb) && ref($data->{$symb})) {
+ return %{$data->{$symb}};
+ } elsif (defined($data) && ! defined($symb) && ref($data)) {
+ return %$data;
+ }
+ if ($status eq 'no data') {
+ return ();
} else {
- &Apache::lonnet::logthis('retrieving cached data ');
- if (tie(%cache,'GDBM_File',$cachefilename,&GDBM_READER(),0640)) {
- if (defined($symb)) {
- my $searchkey = $key.&Apache::lonnet::escape($symb);
- if (exists($cache{$searchkey})) {
- $student_data{$symb} = &make_into_hash($cache{$searchkey});
- }
- } else {
- my $searchkey = '^'.$key.'(.*)$';#'
- while (my ($testkey,$params)=each(%cache)) {
- if ($testkey =~ /$searchkey/) { # \Q \E? May be necc.
- my $tmpsymb = $1;
- next if ($tmpsymb =~ 'time');
-# &Apache::lonnet::logthis('found '.$tmpsymb.':');
- $student_data{&Apache::lonnet::unescape($tmpsymb)} =
- &make_into_hash($params);
- }
- }
- }
- untie(%cache);
+ if ($status ne 'okay' && $status ne '') {
+ &Apache::lonnet::logthis('status = '.$status);
+ return ();
}
+ my $returnhash = &get_student_data_from_performance_cache($sname,$sdom,
+ $symb,$courseid);
+ return %$returnhash if (defined($returnhash));
}
- if (! defined($symb)) {
-# &Apache::lonnet::logthis("returning all data");
- return %student_data;
- } elsif (exists($student_data{$symb})) {
-# &Apache::lonnet::logthis("returning data for symb=".$symb);
- return %{$student_data{$symb}};
- } else {
- return ();
+ return ();
+}
+
+################################################
+################################################
+
+=pod
+
+=item &get_problem_statistics()
+
+Gather data on a given problem. The database is assumed to be
+populated and all local caching variables are assumed to be set
+properly. This means you need to call &ensure_current_data for
+the students you are concerned with prior to calling this routine.
+
+Inputs: $students, $symb, $part, $courseid
+
+=over 4
+
+=item $students is an array of hash references.
+Each hash must contain at least the 'username' and 'domain' of a student.
+
+=item $symb is the symb for the problem.
+
+=item $part is the part id you need statistics for
+
+=item $courseid is the course id, of course!
+
+=back
+
+Outputs: See the code for up to date information. A hash reference is
+returned. The hash has the following keys defined:
+
+=over 4
+
+=item num_students The number of students attempting the problem
+
+=item tries The total number of tries for the students
+
+=item max_tries The maximum number of tries taken
+
+=item mean_tries The average number of tries
+
+=item num_solved The number of students able to solve the problem
+
+=item num_override The number of students whose answer is 'correct_by_override'
+
+=item deg_of_diff The degree of difficulty of the problem
+
+=item std_tries The standard deviation of the number of tries
+
+=item skew_tries The skew of the number of tries
+
+=item per_wrong The number of students attempting the problem who were not
+able to answer it correctly.
+
+=back
+
+=cut
+
+################################################
+################################################
+sub get_problem_statistics {
+ my ($students,$symb,$part,$courseid) = @_;
+ return if (! defined($symb) || ! defined($part));
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ #
+ &setup_table_names($courseid);
+ my $symb_id = &get_symb_id($symb);
+ my $part_id = &get_part_id($part);
+ my $stats_table = $courseid.'_problem_stats';
+ #
+ my $dbh = &Apache::lonmysql::get_dbh();
+ return undef if (! defined($dbh));
+ #
+ # A) Number of Students attempting problem
+ # B) Total number of tries of students attempting problem
+ # C) Mod (largest number of tries for solving the problem)
+ # D) Mean (average number of tries for solving the problem)
+ # E) Number of students to solve the problem
+ # F) Number of students to solve the problem by override
+ # G) Number of students unable to solve the problem
+ # H) Degree of difficulty : 1-(E+F)/B
+ # I) Standard deviation of number of tries
+ # J) Skew of tries: sqrt(sum(Xi-D)^3)/A
+ #
+ $dbh->do('DROP TABLE '.$stats_table); # May return an error
+ my $request =
+ 'CREATE TEMPORARY TABLE '.$stats_table.
+ ' SELECT student_id,solved,award,tries FROM '.$performance_table.
+ ' WHERE symb_id='.$symb_id.' AND part_id='.$part_id;
+ if (defined($students)) {
+ $request .= ' AND ('.
+ join(' OR ', map {'student_id='.
+ &get_student_id($_->{'username'},
+ $_->{'domain'})
+ } @$students
+ ).')';
+ }
+# &Apache::lonnet::logthis($request);
+ $dbh->do($request);
+ my ($num,$tries,$mod,$mean,$STD) = &execute_SQL_request
+ ($dbh,
+ 'SELECT COUNT(*),SUM(tries),MAX(tries),AVG(tries),STD(tries) FROM '.
+ $stats_table);
+ my ($Solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
+ $stats_table.
+ " WHERE solved='correct_by_student' OR solved='correct_by_scantron'");
+ my ($solved) = &execute_SQL_request($dbh,'SELECT COUNT(tries) FROM '.
+ $stats_table.
+ " WHERE solved='correct_by_override'");
+ $num = 0 if (! defined($num));
+ $tries = 0 if (! defined($tries));
+ $mod = 0 if (! defined($mod));
+ $STD = 0 if (! defined($STD));
+ $Solved = 0 if (! defined($Solved));
+ $solved = 0 if (! defined($solved));
+ #
+ my $DegOfDiff = 'nan';
+ $DegOfDiff = 1-($Solved)/$tries if ($tries>0);
+
+ my $SKEW = 'nan';
+ my $wrongpercent = 0;
+ if ($num > 0) {
+ ($SKEW) = &execute_SQL_request($dbh,'SELECT SQRT(SUM('.
+ 'POWER(tries - '.$STD.',3)'.
+ '))/'.$num.' FROM '.$stats_table);
+ $wrongpercent=int(10*100*($num-$Solved+$solved)/$num)/10;
+ }
+ #
+ $dbh->do('DROP TABLE '.$stats_table); # May return an error
+ #
+ # Store in metadata
+ #
+ if ($num) {
+ my %storestats=();
+
+ my $urlres=(&Apache::lonnet::decode_symb($symb))[2];
+
+ $storestats{$courseid.'___'.$urlres.'___timestamp'}=time;
+ $storestats{$courseid.'___'.$urlres.'___stdno'}=$num;
+ $storestats{$courseid.'___'.$urlres.'___avetries'}=$mean;
+ $storestats{$courseid.'___'.$urlres.'___difficulty'}=$DegOfDiff;
+
+ $urlres=~/^(\w+)\/(\w+)/;
+ &Apache::lonnet::put('nohist_resevaldata',\%storestats,$1,$2);
+ }
+ #
+ # Return result
+ #
+ return { num_students => $num,
+ tries => $tries,
+ max_tries => $mod,
+ mean_tries => $mean,
+ std_tries => $STD,
+ skew_tries => $SKEW,
+ num_solved => $Solved,
+ num_override => $solved,
+ per_wrong => $wrongpercent,
+ deg_of_diff => $DegOfDiff };
+}
+
+sub execute_SQL_request {
+ my ($dbh,$request)=@_;
+# &Apache::lonnet::logthis($request);
+ my $sth = $dbh->prepare($request);
+ $sth->execute();
+ my $row = $sth->fetchrow_arrayref();
+ if (ref($row) eq 'ARRAY' && scalar(@$row)>0) {
+ return @$row;
+ }
+ return ();
+}
+
+sub get_student_data {
+ my ($students,$courseid) = @_;
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ &setup_table_names($courseid);
+ my $dbh = &Apache::lonmysql::get_dbh();
+ return undef if (! defined($dbh));
+ my $request = 'SELECT '.
+ 'student_id, student '.
+ 'FROM '.$student_table;
+ if (defined($students)) {
+ $request .= ' WHERE ('.
+ join(' OR ', map {'student_id='.
+ &get_student_id($_->{'username'},
+ $_->{'domain'})
+ } @$students
+ ).')';
+ }
+ $request.= ' ORDER BY student_id';
+ my $sth = $dbh->prepare($request);
+ $sth->execute();
+ if ($dbh->err) {
+ &Apache::lonnet::logthis('error = '.$dbh->errstr());
+ return undef;
+ }
+ my $dataset = $sth->fetchall_arrayref();
+ if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
+ return $dataset;
+ }
+}
+
+sub get_optionresponse_data {
+ my ($students,$symb,$response,$courseid) = @_;
+ return undef if (! defined($symb) ||
+ ! defined($response));
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ #
+ &setup_table_names($courseid);
+ my $symb_id = &get_symb_id($symb);
+ my $response_id = &get_part_id($response);
+ #
+ my $dbh = &Apache::lonmysql::get_dbh();
+ return undef if (! defined($dbh));
+ my $request = 'SELECT '.
+ 'a.student_id, a.awarddetail, a.response_specific_value, '.
+ 'a.submission, b.timestamp, c.tries '.
+ 'FROM '.$fulldump_response_table.' AS a '.
+ 'LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
+ 'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
+ 'a.transaction = b.transaction '.
+ 'LEFT JOIN '.$fulldump_part_table.' AS c '.
+ 'ON a.symb_id=c.symb_id AND a.student_id=c.student_id AND '.
+ 'a.part_id=c.part_id AND a.transaction = c.transaction '.
+ 'WHERE '.
+ 'a.symb_id='.$symb_id.' AND a.response_id='.$response_id;
+ if (defined($students)) {
+ $request .= ' AND ('.
+ join(' OR ', map {'a.student_id='.
+ &get_student_id($_->{'username'},
+ $_->{'domain'})
+ } @$students
+ ).')';
+ }
+ $request .= ' ORDER BY b.timestamp';
+# &Apache::lonnet::logthis("request =\n".$request);
+ my $sth = $dbh->prepare($request);
+ $sth->execute();
+ if ($dbh->err) {
+ &Apache::lonnet::logthis('error = '.$dbh->errstr());
+ return undef;
+ }
+ my $dataset = $sth->fetchall_arrayref();
+ if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
+ return $dataset;
+ }
+}
+
+sub get_response_time_data {
+ my ($students,$symb,$response,$courseid) = @_;
+ return undef if (! defined($symb) ||
+ ! defined($response));
+ $courseid = $ENV{'request.course.id'} if (! defined($courseid));
+ #
+ &setup_table_names($courseid);
+ my $symb_id = &get_symb_id($symb);
+ my $response_id = &get_part_id($response);
+ #
+ my $dbh = &Apache::lonmysql::get_dbh();
+ return undef if (! defined($dbh));
+ my $request = 'SELECT '.
+ 'a.student_id, a.awarddetail, b.timestamp '.
+ 'FROM '.$fulldump_response_table.' AS a '.
+ 'NATURAL LEFT JOIN '.$fulldump_timestamp_table.' AS b '.
+# 'ON a.symb_id=b.symb_id AND a.student_id=b.student_id AND '.
+# 'a.transaction = b.transaction '.
+ 'WHERE '.
+ 'a.symb_id='.$symb_id.' AND a.response_id='.$response_id;
+ if (defined($students)) {
+ $request .= ' AND ('.
+ join(' OR ', map {'a.student_id='.
+ &get_student_id($_->{'username'},
+ $_->{'domain'})
+ } @$students
+ ).')';
+ }
+ $request .= ' ORDER BY b.timestamp';
+# &Apache::lonnet::logthis("request =\n".$request);
+ my $sth = $dbh->prepare($request);
+ $sth->execute();
+ if ($dbh->err) {
+ &Apache::lonnet::logthis('error = '.$dbh->errstr());
+ return undef;
+ }
+ my $dataset = $sth->fetchall_arrayref();
+ if (ref($dataset) eq 'ARRAY' && scalar(@$dataset)>0) {
+ return $dataset;
+ }
+
+}
+
+################################################
+################################################
+
+=pod
+
+=item &setup_table_names()
+
+input: course id
+
+output: none
+
+Cleans up the package variables for local caching.
+
+=cut
+
+################################################
+################################################
+sub setup_table_names {
+ my ($courseid) = @_;
+ if (! defined($courseid)) {
+ $courseid = $ENV{'request.course.id'};
+ }
+ #
+ if (! defined($current_course) || $current_course ne $courseid) {
+ # Clear out variables
+ $have_read_part_table = 0;
+ undef(%ids_by_part);
+ undef(%parts_by_id);
+ $have_read_symb_table = 0;
+ undef(%ids_by_symb);
+ undef(%symbs_by_id);
+ $have_read_student_table = 0;
+ undef(%ids_by_student);
+ undef(%students_by_id);
+ #
+ $current_course = $courseid;
}
+ #
+ # Set up database names
+ my $base_id = $courseid;
+ $symb_table = $base_id.'_'.'symb';
+ $part_table = $base_id.'_'.'part';
+ $student_table = $base_id.'_'.'student';
+ $studentdata_table = $base_id.'_'.'studentdata';
+ $performance_table = $base_id.'_'.'performance';
+ $parameters_table = $base_id.'_'.'parameters';
+ $fulldump_part_table = $base_id.'_'.'partdata';
+ $fulldump_response_table = $base_id.'_'.'responsedata';
+ $fulldump_timestamp_table = $base_id.'_'.'timestampdata';
+ #
+ @Tables = (
+ $symb_table,
+ $part_table,
+ $student_table,
+ $studentdata_table,
+ $performance_table,
+ $parameters_table,
+ $fulldump_part_table,
+ $fulldump_response_table,
+ $fulldump_timestamp_table,
+ );
+ return;
}
################################################
@@ -1671,6 +2176,24 @@ sub get_current_state {
=pod
+=back
+
+=item End of Local Data Caching Subroutines
+
+=cut
+
+################################################
+################################################
+
+} # End scope of table identifiers
+
+################################################
+################################################
+
+=pod
+
+=head3 Classlist Subroutines
+
=item &get_classlist();
Retrieve the classist of a given class or of the current class. Student
@@ -1684,23 +2207,39 @@ $ENV{'course.'.$cid.'.domain'}, and $ENV
Returns a reference to a hash which contains:
keys '$sname:$sdom'
- values [$end,$start,$id,$section,$fullname]
+ values [$sdom,$sname,$end,$start,$id,$section,$fullname,$status]
+
+The constant values CL_SDOM, CL_SNAME, CL_END, etc. can be used
+as indices into the returned list to future-proof clients against
+changes in the list order.
=cut
################################################
################################################
+sub CL_SDOM { return 0; }
+sub CL_SNAME { return 1; }
+sub CL_END { return 2; }
+sub CL_START { return 3; }
+sub CL_ID { return 4; }
+sub CL_SECTION { return 5; }
+sub CL_FULLNAME { return 6; }
+sub CL_STATUS { return 7; }
+
sub get_classlist {
my ($cid,$cdom,$cnum) = @_;
$cid = $cid || $ENV{'request.course.id'};
$cdom = $cdom || $ENV{'course.'.$cid.'.domain'};
$cnum = $cnum || $ENV{'course.'.$cid.'.num'};
- my $now = time;
+ my $now = time;
#
my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
while (my ($student,$info) = each(%classlist)) {
- return undef if ($student =~ /^(con_lost|error|no_such_host)/i);
+ if ($student =~ /^(con_lost|error|no_such_host)/i) {
+ &Apache::lonnet::logthis('get_classlist error for '.$cid.':'.$student);
+ return undef;
+ }
my ($sname,$sdom) = split(/:/,$student);
my @Values = split(/:/,$info);
my ($end,$start,$id,$section,$fullname);
500 Internal Server Error
Internal Server Error
The server encountered an internal error or
misconfiguration and was unable to complete
your request.
Please contact the server administrator at
root@localhost to inform them of the time this error occurred,
and the actions you performed just before this error.
More information about this error may be available
in the server error log.