--- loncom/interface/Attic/lonchart.pm 2002/07/08 15:03:25 1.57 +++ loncom/interface/Attic/lonchart.pm 2002/07/09 15:43:49 1.59 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # (Publication Handler # -# $Id: lonchart.pm,v 1.57 2002/07/08 15:03:25 stredwic Exp $ +# $Id: lonchart.pm,v 1.59 2002/07/09 15:43:49 stredwic Exp $ # # Copyright Michigan State University Board of Trustees # @@ -84,10 +84,9 @@ display options back to default values. =head1 CODE LAYOUT DESCRIPTION -The code is broken down into five components: formatting data for printing, -downloading data from servers, processing data, helper functions, -and the central processing functions. The module is broken into chunks -for each component. +The code is broken down into three components: formatting data for printing, +helper functions, and the central processing functions. The module is broken +into chunks for each component. =head1 PACKAGES USED @@ -105,6 +104,7 @@ use strict; use Apache::Constants qw(:common :http); use Apache::lonnet(); use Apache::loncommon(); +use Apache::loncoursedata(); use HTML::TokeParser; use GDBM_File; @@ -152,7 +152,7 @@ sub FormatStudentInformation { my $Str=''; for(my $index=0; $index<(scalar @$studentInformation); $index++) { - if(!&ShouldShowColumn($cache, 'heading'.$index)) { + if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) { next; } my $data=$cache->{$name.':'.$studentInformation->[$index]}; @@ -236,7 +236,7 @@ sub FormatStudentData { my $problemsSolved = 0; my $numberOfParts = 0; foreach my $sequence (split(/\:/,$CacheData{'orderedSequences'})) { - if(!&ShouldShowColumn(\%CacheData, 'sequence'.$sequence)) { + if(!&ShouldShowColumn(\%CacheData, 'ChartSequence'.$sequence)) { next; } @@ -245,6 +245,8 @@ sub FormatStudentData { my $problem = $CacheData{$problemID.':problem'}; my $LatestVersion = $CacheData{$name.":version:$problem"}; + # Output blanks for all the parts of this problem if there + # is no version information about the current problem. if(!$LatestVersion) { foreach my $part (split(/\:/,$CacheData{$sequence.':'. $problemID. @@ -257,13 +259,19 @@ sub FormatStudentData { } my %partData=undef; - #initialize data, displays skips correctly + # Initialize part data, display skips correctly + # Skip refers to when a student made no submissions on that + # part/problem. foreach my $part (split(/\:/,$CacheData{$sequence.':'. $problemID. ':parts'})) { $partData{$part.':tries'}=0; $partData{$part.':code'}=' '; } + + # 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. for(my $Version=1; $Version<=$LatestVersion; $Version++) { foreach my $part (split(/\:/,$CacheData{$sequence.':'. $problemID. @@ -271,6 +279,7 @@ sub FormatStudentData { if(!defined($CacheData{$name.":$Version:$problem". ":resource.$part.solved"})) { + # No grade for this submission, so skip next; } @@ -294,6 +303,9 @@ sub FormatStudentData { } } + # All grades (except for versionless parts) are displayed as links + # to their submission record. Loop through all the parts for the + # current problem in the correct order and prepare the output links $Str.=''; @@ -319,6 +331,9 @@ sub FormatStudentData { $Str.=''; } + # Output the number of correct answers for the current sequence. + # This part takes up 6 character slots, but is formated right + # justified. my $spacesNeeded=$CacheData{$sequence.':columnWidth'}-$characterCount; $spacesNeeded -= 3; $Str .= (' 'x$spacesNeeded); @@ -331,6 +346,9 @@ sub FormatStudentData { $Str .= $spacePadding; } + # Output the total correct problems over the total number of problems. + # I don't like this type of formatting, but it is a solution. Need + # a way to dynamically determine the space requirements. my $outputProblemsSolved = sprintf( "%4d", $problemsSolved ); my $outputTotalProblems = sprintf( "%4d", $totalProblems ); $Str .= ''.$outputProblemsSolved. @@ -372,7 +390,7 @@ sub CreateTableHeadings { my $Str=''; for(my $index=0; $index<(scalar @$headings); $index++) { - if(!&ShouldShowColumn($CacheData, 'heading'.$index)) { + if(!&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) { next; } @@ -389,7 +407,7 @@ sub CreateTableHeadings { } foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) { - if(!&ShouldShowColumn($CacheData, 'sequence'.$sequence)) { + if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) { next; } @@ -446,24 +464,24 @@ sub CreateColumnSelectionBox { my $notThere='Select column to view:'; my $name; $notThere .= ''; - $notThere .= ''."\n"; for(my $index=0; $index<(scalar @$headings); $index++) { - if(&ShouldShowColumn($CacheData, 'heading'.$index)) { + if(&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) { next; } $name = $headings->[$index]; - $notThere .= ''."\n"; $missing++; } foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) { - if(&ShouldShowColumn($CacheData, 'sequence'.$sequence)) { + if(&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) { next; } $name = $CacheData->{$sequence.':title'}; - $notThere .= ''."\n"; $missing++; } @@ -511,23 +529,23 @@ sub CreateColumnSelectors { my $present = ''; for(my $index=0; $index<(scalar @$headings); $index++) { - if(!&ShouldShowColumn($CacheData, 'heading'.$index)) { + if(!&ShouldShowColumn($CacheData, 'ChartHeading'.$index)) { next; } $present .= ''; $present .= ''; + $present .= 'name="ChartHeading'.$index.'" />'; $present .= ''; $found++; } foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) { - if(!&ShouldShowColumn($CacheData, 'sequence'.$sequence)) { + if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) { next; } $present .= ''; $present .= ''; + $present .= 'name="ChartSequence'.$sequence.'" />'; $present .= ''; $found++; } @@ -568,34 +586,35 @@ sub CreateForm { my $OpSel1=''; my $OpSel2=''; my $OpSel3=''; - my $Status = $CacheData->{'form.status'}; + my $Status = $CacheData->{'form.ChartStatus'}; if ( $Status eq 'Any' ) { $OpSel3='selected'; } elsif ($Status eq 'Expired' ) { $OpSel2 = 'selected'; } else { $OpSel1 = 'selected'; } - my $Ptr .= '
'."\n"; + my $Ptr .= ''; + $Ptr .= "\n"; $Ptr .= ''; $Ptr .= ''; - $Ptr .= ''. - ''. ''."\n". ''."\n". ' '."\n"; @@ -638,14 +657,15 @@ logo, and course title. =cut sub StartDocument { + my ($title, $header)=@_; my $Str = ''; $Str .= ''; $Str .= ''; - $Str .= 'LON-CAPA Assessment Chart'; + $Str .= $title.''; $Str .= ''; $Str .= ''; $Str .= ''; - $Str .= '

Assessment Chart

'; + $Str .= '

'.$header.'

'; $Str .= '

'.$ENV{'course.'.$ENV{'request.course.id'}.'.description'}; $Str .= '

'; @@ -656,628 +676,14 @@ sub StartDocument { =pod -=head1 DOWNLOAD INFORMATION - -This section contains all the files that get data from other servers -and/or itself. There is one function that has a call to get remote -information but isn't included here which is ProcessTopLevelMap. The -usage was small enough to be ignored, but that portion may be moved -here in the future. - -=cut - -# ----- DOWNLOAD INFORMATION ------------------------------------------- - -=pod - -=item &DownloadPrerequisiteData() - -Collects lastname, generation, middlename, firstname, PID, and section for each -student from their environment database. The list of students is built from -collecting a classlist for the course that is to be displayed. - -=over 4 - -Input: $courseID, $c - -$courseID: The id of the course - -$c: The connection class that can determine if the browser has aborted. It -is used to short circuit this function so that it doesn't 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 - -=back - -=cut - -sub DownloadPrerequisiteData { - my ($courseID, $c)=@_; - my ($courseDomain,$courseNumber)=split(/\_/,$courseID); - - my %classlist=&Apache::lonnet::dump('classlist',$courseDomain, - $courseNumber); - my ($checkForError)=keys (%classlist); - if($checkForError =~ /^(con_lost|error|no_such_host)/i) { - return \%classlist; - } - - foreach my $name (keys(%classlist)) { - if($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.':section'}=\%section; - } - - return \%classlist; -} - -=pod - -=item &DownloadStudentCourseInformation() - -Dump of all the course information for a single student. There is no -pruning of data, it is all stored in a hash and returned. - -=over 4 - -Input: $name, $courseID - -$name: student name:domain - -$courseID: The id of the course - -Output: \%courseData - -\%courseData: A hash pointer to the raw data from the student's course -database. - -=back - -=cut - -sub DownloadStudentCourseInformation { - my ($name,$courseID)=@_; - my ($studentName,$studentDomain) = split(/\:/,$name); - - # Download student course data - my %courseData=&Apache::lonnet::dump($courseID,$studentDomain, - $studentName); - return \%courseData; -} - -# ----- END DOWNLOAD INFORMATION --------------------------------------- - -=pod - -=head1 PROCESSING FUNCTIONS - -These functions process all the data for all the students. Also, they -are the only functions that access the cache database for writing. Thus -they are the only functions that cache data. The downloading and caching -were separated to reduce problems with stopping downloading then can't -tie hash to database later. - -=cut - -# ----- PROCESSING FUNCTIONS --------------------------------------- - -=pod - -=item &ProcessTopResourceMap() - -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. - -=over 4 - -Input: $ChartDB, $c - -$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: A string that contains an error message or "OK" if everything went -smoothly. - -=back - -=cut - -sub ProcessTopResourceMap { - my ($ChartDB,$c)=@_; - my %hash; - my $fn=$ENV{'request.course.fn'}; - if(-e "$fn.db") { - my $tieTries=0; - while($tieTries < 3) { - 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.'; - } - - my %CacheData; - unless(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { - untie(%hash); - return 'Could not tie cache hash.'; - } - - my (@sequences, @currentResource, @finishResource); - my ($currentSequence, $currentResourceID, $lastResourceID); - - $currentResourceID=$hash{'ids_/res/'.$ENV{'request.course.uri'}}; - push(@currentResource, $currentResourceID); - $lastResourceID=-1; - $currentSequence=-1; - my $topLevelSequenceNumber = $currentSequence; - - while(1) { - if($c->aborted()) { - last; - } - # HANDLE NEW SEQUENCE! - #if page || sequence - if(defined($hash{'map_pc_'.$hash{'src_'.$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($CacheData{'orderedSequences'})) { - $CacheData{'orderedSequences'}=$currentSequence; - } else { - $CacheData{'orderedSequences'}.=':'.$currentSequence; - } - - $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; - } - } - } - - # 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) { - my $Problem = &Apache::lonnet::symbclean( - &Apache::lonnet::declutter($hash{'map_id_'.$partA}). - '___'.$partB.'___'. - &Apache::lonnet::declutter($hash{'src_'. - $currentResourceID})); - - $CacheData{$currentResourceID.':problem'}=$Problem; - if(!defined($CacheData{$currentSequence.':problems'})) { - $CacheData{$currentSequence.':problems'}=$currentResourceID; - } else { - $CacheData{$currentSequence.':problems'}.= - ':'.$currentResourceID; - } - - #Get Parts for problem - my $meta=$hash{'src_'.$currentResourceID}; - foreach (split(/\,/,&Apache::lonnet::metadata($meta,'keys'))) { - if($_=~/^stores\_(\d+)\_tries$/) { - my $Part=&Apache::lonnet::metadata($meta,$_.'.part'); - if(!defined($CacheData{$currentSequence.':'. - $currentResourceID.':parts'})) { - $CacheData{$currentSequence.':'.$currentResourceID. - ':parts'}=$Part; - } else { - $CacheData{$currentSequence.':'.$currentResourceID. - ':parts'}.=':'.$Part; - } - } - } - } - - #if resource == finish resource - if($currentResourceID eq $lastResourceID) { - #pop off last resource of sequence - $currentResourceID=pop(@currentResource); - $lastResourceID=pop(@finishResource); - - if(defined($CacheData{$currentSequence.':problems'})) { - # Capture sequence information here - $CacheData{$currentSequence.':title'}= - $hash{'title_'.$currentResourceID}; - - my $totalProblems=0; - foreach my $currentProblem (split(/\:/, - $CacheData{$currentSequence. - ':problems'})) { - foreach (split(/\:/,$CacheData{$currentSequence.':'. - $currentProblem. - ':parts'})) { - $totalProblems++; - } - } - my @titleLength=split(//,$CacheData{$currentSequence. - ':title'}); - # $extra is 3 for problems correct and 3 for space - # between problems correct and problem output - my $extra = 6; - if(($totalProblems + $extra) > (scalar @titleLength)) { - $CacheData{$currentSequence.':columnWidth'}= - $totalProblems + $extra; - } else { - $CacheData{$currentSequence.':columnWidth'}= - (scalar @titleLength); - } - } else { - $CacheData{'orderedSequences'}=~s/$currentSequence//; - $CacheData{'orderedSequences'}=~s/::/:/g; - $CacheData{'orderedSequences'}=~s/^:|:$//g; - } - - $currentSequence=pop(@sequences); - if($currentSequence eq $topLevelSequenceNumber) { - last; - } - } - - # MOVE!!! - #move to next resource - unless(defined($hash{'to_'.$currentResourceID})) { - # big problem, need to handle. Next is probably wrong - last; - } - my @nextResources=(); - foreach (split(/\,/,$hash{'to_'.$currentResourceID})) { - push(@nextResources, $hash{'goesto_'.$_}); - } - push(@currentResource, @nextResources); - # Set the next resource to be processed - $currentResourceID=pop(@currentResource); - } - - unless (untie(%hash)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie coursemap $fn (browse)". - "."); - } - - unless (untie(%CacheData)) { - &Apache::lonnet::logthis("WARNING: ". - "Could not untie Cache Hash (browse)". - "."); - } - - return 'OK'; -} - -=pod - -=item &ProcessSection() - -Determine the section number for a student for the class. A student can have -multiple sections for the same class. The correct one is chosen. - -=over 4 - -Input: $sectionData, $courseid, $ActiveFlag - -$sectionData: A pointer to a hash containing all section data for this -student for the class - -$courseid: The course ID. - -$ActiveFlag: The student's active status (Active/Expired) - -Output: $oldsection, $cursection, or -1 - -$oldsection and $cursection and sections number that will be displayed in the -chart. - --1 is returned if an error occurs. - -=back - -=cut - -sub ProcessSection { - my ($sectionData, $courseid,$ActiveFlag)=@_; - $courseid=~s/\_/\//g; - $courseid=~s/^(\w)/\/$1/; - - my $cursection='-1'; - my $oldsection='-1'; - my $status='Expired'; - my $section=''; - foreach my $key (keys (%$sectionData)) { - my $value = $sectionData->{$key}; - if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) { - $section=$1; - if($key eq $courseid.'_st') { - $section=''; - } - my ($dummy,$end,$start)=split(/\_/,$value); - my $now=time; - my $notactive=0; - if ($start) { - if($now<$start) { - $notactive=1; - } - } - if($end) { - if ($now>$end) { - $notactive=1; - } - } - if($notactive == 0) { - $status='Active'; - $cursection=$section; - last; - } - if($notactive == 1) { - $oldsection=$section; - } - } - } - if($status eq $ActiveFlag) { - if($cursection eq '-1') { - return $oldsection; - } - return $cursection; - } - if($ActiveFlag eq 'Any') { - if($cursection eq '-1') { - return $oldsection; - } - return $cursection; - } - return '-1'; -} - -=pod - -=item &ProcessStudentInformation() - -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. - -=over 4 - -Input: $CacheData, $studentInformation, $section, $date, $name, $courseID - -$CacheData: A hash pointer to the cached data - -$studentInformation: Student information is what was requested in -&DownloadPrerequistedData(). See that function for what data is requested. - -$section: A hash pointer to class section related information. - -$date: A composite of the start and end date for this class for this -student. Format: end:start - -$name: the username:domain information - -$courseID: The course ID - -Output: None - -*NOTE: There is no return value, but if an error occurs a key is added to -the cache data with the value being the error message. The key is -username:domain:error. It will only exist if an error occurs. - -=back - -=cut - -sub ProcessStudentInformation { - my ($CacheData,$studentInformation,$section,$date,$name,$courseID)=@_; - my ($studentName,$studentDomain) = split(/\:/,$name); - - $CacheData->{$name.':username'}=$studentName; - $CacheData->{$name.':domain'}=$studentDomain; - $CacheData->{$name.':date'}=$date; - - my ($checkForError)=keys(%$studentInformation); - if($checkForError =~ /^(con_lost|error|no_such_host)/i) { - $CacheData->{$name.':error'}= - 'Could not download student environment data.'; - $CacheData->{$name.':fullname'}=''; - $CacheData->{$name.':id'}=''; - } else { - $CacheData->{$name.':fullname'}=&ProcessFullName( - $studentInformation->{'lastname'}, - $studentInformation->{'generation'}, - $studentInformation->{'firstname'}, - $studentInformation->{'middlename'}); - $CacheData->{$name.':id'}=$studentInformation->{'id'}; - } - - # Get student's section number - my $sec=&ProcessSection($section, $courseID, $CacheData->{'form.status'}); - if($sec != -1) { - $CacheData->{$name.':section'}=$sec; - } else { - $CacheData->{$name.':section'}=''; - } - - return; -} - -=pod - -=item &ProcessClassList() - -Taking the class list dumped from &DownloadPrerequisiteData(), 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. - -=over 4 - -Input: $classlist, $courseID, $ChartDB, $c - -$classlist: The hash of data collected about a student from -&DownloadPrerequisteData(). The hash contains a list of students, a pointer -to a hash of student information for each student, and each student's 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. - -=back - -=cut - -sub ProcessClassList { - my ($classlist,$courseID,$ChartDB,$c)=@_; - my @names=(); - - my %CacheData; - if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { - foreach my $name (keys(%$classlist)) { - if($name =~ /\:section/ || $name =~ /\:studentInformation/ || - $name eq '') { - next; - } - if($c->aborted()) { - last; - } - push(@names,$name); - &ProcessStudentInformation( - \%CacheData, - $classlist->{$name.':studentInformation'}, - $classlist->{$name.':section'}, - $classlist->{$name}, - $name,$courseID); - } - - # Time of download - $CacheData{'time'}=localtime(); - untie(%CacheData); - } - - return @names; -} - -=pod - -=item &ProcessStudentData() - -Takes the course data downloaded for a student in -&DownloadStudentCourseInformation() 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 student's information has been downloaded and -can be reused from cached data. - -=over 4 - -Input: $courseData, $name, $ChartDB - -$courseData: A hash pointer that points to the course data downloaded for a -student. - -$name: username:domain - -$ChartDB: The name of the cache database file which will allow the data to -be written to the cache. - -Output: None - -*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 -&DownloadStudentCourseInformation(). +=head1 HELPER FUNCTIONS -=back +These are just a couple of functions do various odd and end +jobs. =cut -sub ProcessStudentData { - my ($courseData, $name, $ChartDB)=@_; - - my %CacheData; - if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { - my ($checkForError) = keys(%$courseData); - if($checkForError =~ /^(con_lost|error|no_such_host)/i) { - $CacheData{$name.':error'}='Could not download course data.'; - } else { - foreach my $key (keys (%$courseData)) { - $CacheData{$name.':'.$key}=$courseData->{$key}; - } - if(defined($CacheData{'NamesOfStudents'})) { - $CacheData{'NamesOfStudents'}.=':::'.$name; - } else { - $CacheData{'NamesOfStudents'}=$name; - } - } - untie(%CacheData); - } - - return; -} +# ----- HELPER FUNCTIONS ----------------------------------------------- =pod @@ -1302,34 +708,37 @@ Output: None =cut +# For all data, if ENV data doesn't exist for it, default values is used. sub ProcessFormData { my ($ChartDB, $isCached)=@_; my %CacheData; if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { - if(defined($ENV{'form.sort'})) { - $CacheData{'form.sort'}=$ENV{'form.sort'}; - } elsif(!defined($CacheData{'form.sort'})) { - $CacheData{'form.sort'}='username'; + # Ignore $ENV{'form.ChartRefresh'} + # Ignore $ENV{'form.ChartRecalculate'} + + if(defined($ENV{'form.ChartSort'})) { + $CacheData{'form.ChartSort'}=$ENV{'form.ChartSort'}; + } elsif(!defined($CacheData{'form.ChartSort'})) { + $CacheData{'form.ChartSort'}='username'; } - # Ignore $ENV{'form.refresh'} - # Ignore $ENV{'form.recalculate'} - - if(defined($ENV{'form.status'})) { - $CacheData{'form.status'}=$ENV{'form.status'}; - } elsif(!defined($CacheData{'form.status'})) { - $CacheData{'form.status'}='Active'; + if(defined($ENV{'form.ChartStatus'})) { + $CacheData{'form.ChartStatus'}=$ENV{'form.ChartStatus'}; + } elsif(!defined($CacheData{'form.ChartStatus'})) { + $CacheData{'form.ChartStatus'}='Active'; } + # $found checks for any instances of form data in the ENV. If it is + # missing I assume the chrt button on the remote has been pressed. my @headings=(); my @sequences=(); my $found=0; foreach (keys(%ENV)) { - if(/form\.heading/) { + if(/form\.ChartHeading/) { $found++; push(@headings, $_); - } elsif(/form\.sequence/) { + } elsif(/form\.ChartSequence/) { $found++; push(@sequences, $_); } elsif(/form\./) { @@ -1338,31 +747,33 @@ sub ProcessFormData { } if($found) { - $CacheData{'form.headings'}=join(":::",@headings); - $CacheData{'form.sequences'}=join(":::",@sequences); + $CacheData{'form.ChartHeadings'}=join(":::",@headings); + $CacheData{'form.ChartSequences'}=join(":::",@sequences); } - if(defined($ENV{'form.reselect'})) { - my @reselected = (ref($ENV{'form.reselect'}) ? - @{$ENV{'form.reselect'}} - : ($ENV{'form.reselect'})); + if(defined($ENV{'form.ChartReselect'})) { + my @reselected = (ref($ENV{'form.ChartReselect'}) ? + @{$ENV{'form.ChartReselect'}} + : ($ENV{'form.ChartReselect'})); foreach (@reselected) { - if(/heading/) { - $CacheData{'form.headings'}.=":::".$_; - } elsif(/sequence/) { - $CacheData{'form.sequences'}.=":::".$_; + if(/ChartHeading/) { + $CacheData{'form.ChartHeadings'}.=":::".$_; + } elsif(/ChartSequence/) { + $CacheData{'form.ChartSequences'}.=":::".$_; } } } - if(defined($ENV{'form.reset'}) || (!$found && !$isCached)) { - $CacheData{'form.reset'}='true'; - $CacheData{'form.status'}='Active'; - $CacheData{'form.sort'}='username'; - $CacheData{'form.headings'}='ALLHEADINGS'; - $CacheData{'form.sequences'}='ALLSEQUENCES'; + # !$found and !$isCached are how I determine if the chrt button + # on the remote was pressed and needs to reset all the selections + if(defined($ENV{'form.ChartReset'}) || (!$found && !$isCached)) { + $CacheData{'form.ChartReset'}='true'; + $CacheData{'form.ChartStatus'}='Active'; + $CacheData{'form.ChartSort'}='username'; + $CacheData{'form.ChartHeadings'}='ALLHEADINGS'; + $CacheData{'form.ChartSequences'}='ALLSEQUENCES'; } else { - $CacheData{'form.reset'}='false'; + $CacheData{'form.ChartReset'}='false'; } untie(%CacheData); @@ -1398,94 +809,28 @@ Output: None - All data stored in cache. =cut sub SpaceColumns { - my ($students,$studentInformation,$headings,$ChartDB)=@_; + my ($students,$studentInformation,$headings,$cache)=@_; - my %CacheData; - if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { - # Initialize Lengths - for(my $index=0; $index<(scalar @$headings); $index++) { - my @titleLength=split(//,$$headings[$index]); - $CacheData{$$studentInformation[$index].'Length'}= - scalar @titleLength; - } + # Initialize Lengths + for(my $index=0; $index<(scalar @$headings); $index++) { + my @titleLength=split(//,$$headings[$index]); + $cache->{$$studentInformation[$index].'Length'}= + scalar @titleLength; + } - foreach my $name (@$students) { - foreach (@$studentInformation) { - my @dataLength=split(//,$CacheData{$name.':'.$_}); - my $length=scalar @dataLength; - if($length > $CacheData{$_.'Length'}) { - $CacheData{$_.'Length'}=$length; - } + foreach my $name (@$students) { + foreach (@$studentInformation) { + my @dataLength=split(//,$cache->{$name.':'.$_}); + my $length=scalar @dataLength; + if($length > $cache->{$_.'Length'}) { + $cache->{$_.'Length'}=$length; } } - untie(%CacheData); } return; } -# ----- END PROCESSING FUNCTIONS --------------------------------------- - -=pod - -=head1 HELPER FUNCTIONS - -These are just a couple of functions do various odd and end -jobs. - -=cut - -# ----- HELPER FUNCTIONS ----------------------------------------------- - -=pod - -=item &ProcessFullName() - -Takes lastname, generation, firstname, and middlename (or some partial -set of this data) and returns the full name version as a string. - -=cut - -sub ProcessFullName { - my ($lastname, $generation, $firstname, $middlename)=@_; - my $Str = ''; - - if($lastname ne '') { - $Str .= $lastname.' '; - if($generation ne '') { - $Str .= $generation; - } else { - chop($Str); - } - $Str .= ', '; - if($firstname ne '') { - $Str .= $firstname.' '; - } - if($middlename ne '') { - $Str .= $middlename; - } else { - chop($Str); - if($firstname eq '') { - chop($Str); - } - } - } else { - if($firstname ne '') { - $Str .= $firstname.' '; - } - if($middlename ne '') { - $Str .= $middlename.' '; - } - if($generation ne '') { - $Str .= $generation; - } else { - chop($Str); - } - } - - return $Str; -} - =pod =item &SortStudents() @@ -1519,7 +864,7 @@ sub SortStudents { my ($end,$start)=split(/\:/,$CacheData->{$_.':date'}); my $active=1; my $now=time; - my $Status=$CacheData->{'form.status'}; + my $Status=$CacheData->{'form.ChartStatus'}; $Status = ($Status) ? $Status : 'Active'; if((($end) && $now > $end) && (($Status eq 'Active'))) { $active=0; @@ -1532,7 +877,7 @@ sub SortStudents { } } - my $Pos = $CacheData->{'form.sort'}; + my $Pos = $CacheData->{'form.ChartSort'}; my %sortData; if($Pos eq 'Last Name') { for(my $index=0; $index= 10) { - return -1; - } - - untie(%testData); - - return $isCached; -} - -=pod - =item &ShouldShowColumn() Determine if a specified column should be shown on the chart. @@ -1643,12 +928,12 @@ Output: 0 (false), 1 (true) sub ShouldShowColumn { my ($cache,$test)=@_; - if($cache->{'form.reset'} eq 'true') { + if($cache->{'form.ChartReset'} eq 'true') { return 1; } - my $headings=$cache->{'form.headings'}; - my $sequences=$cache->{'form.sequences'}; + my $headings=$cache->{'form.ChartHeadings'}; + my $sequences=$cache->{'form.ChartSequences'}; if($headings eq 'ALLHEADINGS' || $sequences eq 'ALLSEQUENCES' || $headings=~/$test/ || $sequences=~/$test/) { return 1; @@ -1705,7 +990,7 @@ sub BuildChart { # Start the lonchart document $r->content_type('text/html'); $r->send_http_header; - $r->print(&StartDocument()); + $r->print(&StartDocument('LON-CAPA Assessment Chart', 'Assessment Chart')); $r->rflush(); # Test for access to the CacheData @@ -1713,10 +998,13 @@ sub BuildChart { my $cid=$ENV{'request.course.id'}; my $ChartDB = "/home/httpd/perl/tmp/$ENV{'user.name'}". "_$ENV{'user.domain'}_$cid\_chart.db"; - - $isCached=&TestCacheData($ChartDB); + my $isRecalculate=0; + if(defined($ENV{'form.ChartRecalculate'})) { + $isRecalculate=1; + } + $isCached=&Apache::loncoursedata::TestCacheData($ChartDB, $isRecalculate); if($isCached < 0) { - $r->print("Unable to tie hash to db file"); + $r->print("Unable to tie hash to db file"); $r->rflush(); return; } @@ -1729,24 +1017,65 @@ sub BuildChart { my @headings=('User Name','Domain','Section','PID','Full Name'); my $spacePadding=' '; if(!$isCached) { - my $processTopResourceMapReturn=&ProcessTopResourceMap($ChartDB,$c); + unless(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { + $r->print("Unable to tie hash to db file"); + $r->rflush(); + return; + } + + my $processTopResourceMapReturn= + &Apache::loncoursedata::ProcessTopResourceMap(\%CacheData,$c); if($processTopResourceMapReturn ne 'OK') { - $r->print($processTopResourceMapReturn); + $r->print($processTopResourceMapReturn.''); + untie(%CacheData); + return; + } + + if($c->aborted()) { + untie(%CacheData); + $r->print(''); return; } - if($c->aborted()) { return; } - my $classlist=&DownloadPrerequisiteData($cid, $c); + + my $classlist=&Apache::loncoursedata::DownloadStudentNamePIDSection( + $cid, $c); my ($checkForError)=keys(%$classlist); if($checkForError =~ /^(con_lost|error|no_such_host)/i || defined($classlist->{'error'})) { + $r->print("Error getting student data."); + $r->rflush(); + untie(%CacheData); + return; + } + + if($c->aborted()) { + untie(%CacheData); + $r->print(''); + return; + } + + + @students=&Apache::loncoursedata::ProcessClassList(\%CacheData, + $classlist, $cid, + $CacheData{'form.ChartStatus'}, + $c); + + if($c->aborted()) { + untie(%CacheData); + $r->print(''); return; } - if($c->aborted()) { return; } - @students=&ProcessClassList($classlist,$cid,$ChartDB,$c); - if($c->aborted()) { return; } + &SpaceColumns(\@students,\@studentInformation,\@headings, - $ChartDB); - if($c->aborted()) { return; } + \%CacheData); + + if($c->aborted()) { + untie(%CacheData); + $r->print(''); + return; + } + + untie(%CacheData); } else { if(!$c->aborted() && tie(%CacheData,'GDBM_File',$ChartDB, &GDBM_READER,0640)) { @@ -1802,10 +1131,18 @@ sub BuildChart { } if(!$isCached) { - $courseData=&DownloadStudentCourseInformation($_, $cid); + $courseData= + &Apache::loncoursedata::DownloadStudentCourseInformation($_, + $cid); if($c->aborted()) { last; } - push(@updateStudentList, $_); - &ProcessStudentData($courseData, $_, $ChartDB); + if(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_WRCREAT,0640)) { + &Apache::loncoursedata::ProcessStudentData(\%CacheData, + $courseData, $_); + push(@updateStudentList, $_); + untie(%CacheData); + } else { + next; + } } $r->print(&FormatStudentData($_, \@studentInformation, $spacePadding, $ChartDB)); @@ -1870,7 +1207,7 @@ sub handler { $r->send_http_header; return OK; } - + unless($ENV{'request.course.fn'}) { my $requrl=$r->uri; $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";