--- loncom/interface/Attic/lonchart.pm 2002/06/05 05:05:38 1.43
+++ 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.43 2002/06/05 05:05:38 stredwic Exp $
+# $Id: lonchart.pm,v 1.59 2002/07/09 15:43:49 stredwic Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -46,668 +46,1177 @@
#
###
+=pod
+
+=head1 NAME
+
+lonchart
+
+=head1 SYNOPSIS
+
+Quick display of students grades for a course in a compressed table format.
+
+=head1 DESCRIPTION
+
+This module process all student grades for a course and turns them into a
+table like structure.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org
+
+lonchart presents the user with a condensed view all a course's data. The
+class title, the number of students, and the date for the last update of the
+displayed data. There is also a legend that describes the chart values.
+
+For each valid grade for a student is linked with a submission record for that
+problem. The ability to add and remove columns of data from the chart was
+added for reducing the burden of having to scroll through large quantities
+of data. The interface also allows for sorting of students by username,
+last name, and section number of class. Active and expired students are
+also available.
+
+The interface is controlled by three primary buttons: Recalculate Chart,
+Refresh Chart, and Reset Selections. Recalculate Chart will update
+the chart to the most recent data and keep the display settings for the chart
+the same. Refresh Chart is used to redisplay the chart after selecting
+different output formatting. Reset Selections is used to set the chart
+display options back to default values.
+
+=head1 CODE LAYOUT DESCRIPTION
+
+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
+
+ Apache::Constants qw(:common :http)
+ Apache::lonnet()
+ Apache::loncommon()
+ HTML::TokeParser
+ GDBM_File
+
+=cut
+
package Apache::lonchart;
use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet();
use Apache::loncommon();
+use Apache::loncoursedata();
use HTML::TokeParser;
use GDBM_File;
-# -------------------------------------------------------------- Module Globals
-my %hash;
-my %CachData;
-my @cols;
-my $r;
-my $c;
-
-# ------------------------------------------------------------- Find out status
+#my $jr;
+
+=pod
+
+=head1 FORMAT DATA FOR PRINTING
+
+=cut
+
+# ----- FORMAT PRINT DATA ----------------------------------------------
+
+=pod
+
+=item &FormatStudentInformation()
+
+This function produces a formatted string of the student's information:
+username, domain, section, full name, and PID.
+
+=over 4
+
+Input: $cache, $name, $studentInformation, $spacePadding
+
+$cache: This is a pointer to a hash that is tied to the cached data
+
+$name: The name and domain of the current student in name:domain format
+
+$studentInformation: A pointer to an array holding the names used to
+
+remove data from the hash. They represent the name of the data to be removed.
+
+$spacePadding: Extra spaces that represent the space between columns
+
+Output: $Str
+
+$Str: Formatted string.
+
+=back
+
+=cut
+
+sub FormatStudentInformation {
+ my ($cache,$name,$studentInformation,$spacePadding)=@_;
+ my $Str='';
+
+ for(my $index=0; $index<(scalar @$studentInformation); $index++) {
+ if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) {
+ next;
+ }
+ my $data=$cache->{$name.':'.$studentInformation->[$index]};
+ $Str .= $data;
-sub ExtractStudentData {
- my ($name,$coid)=@_;
+ my @dataLength=split(//,$data);
+ my $length=scalar @dataLength;
+ $Str .= (' 'x($cache->{$studentInformation->[$index].'Length'}-
+ $length));
+ $Str .= $spacePadding;
+ }
+
+ return $Str;
+}
+
+=pod
+
+=item &FormatStudentData()
+
+First, FormatStudentInformation is called and prefixes the course information.
+This function produces a formatted string of the student's course information.
+Each column of data represents all the problems for a given sequence. For
+valid grade data, a link is created for that problem to a submission record
+for that problem.
+
+=over 4
+
+Input: $name, $studentInformation, $spacePadding, $ChartDB
+
+$name: The name and domain of the current student in name:domain format
+
+$studentInformation: A pointer to an array holding the names used to
+remove data from the hash. They represent
+the name of the data to be removed.
+
+$spacePadding: Extra spaces that represent the space between columns
+
+$ChartDB: The name of the cached data database which will be tied to that
+database.
+
+Output: $Str
+
+$Str: Formatted string that is an entire row of the chart. It is a
+concatenation of student information and student course information.
+
+=back
+
+=cut
+
+sub FormatStudentData {
+ my ($name,$studentInformation,$spacePadding,$ChartDB)=@_;
my ($sname,$sdom) = split(/\:/,$name);
- my $ResId;
- my $Code;
- my $Tries;
- my $Wrongs;
- my %TempHash;
- my $Version;
- my $problemsCorrect;
- my $problemsSolved;
- my $totalProblems;
- my $LatestVersion;
my $Str;
+ my %CacheData;
+ unless(tie(%CacheData,'GDBM_File',$ChartDB,&GDBM_READER,0640)) {
+ return '';
+ }
# Handle Student information ------------------------------------------
+ # Handle user data
+ $Str=&FormatStudentInformation(\%CacheData, $name, $studentInformation,
+ $spacePadding);
+
# Handle errors
-# if($CachData{$name.':error'} =~ /environment/) {
-# my $errorMessage = $CachData{$name.':error'};
-# return '
';
- $problemsCorrect = 0;
- $totalProblems = 0;
- $problemsSolved = 0;
- my $IterationNo = 0;
- foreach $ResId (@cols) {
- if ($IterationNo == 0) {
- # Looks to be skipping start resource
- $IterationNo++;
- next;
- }
+ my $Version;
+ my $problemsCorrect = 0;
+ my $totalProblems = 0;
+ my $problemsSolved = 0;
+ my $numberOfParts = 0;
+ foreach my $sequence (split(/\:/,$CacheData{'orderedSequences'})) {
+ if(!&ShouldShowColumn(\%CacheData, 'ChartSequence'.$sequence)) {
+ next;
+ }
+
+ my $characterCount=0;
+ foreach my $problemID (split(/\:/,$CacheData{$sequence.':problems'})) {
+ 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.
+ ':parts'})) {
+ $Str .= ' ';
+ $totalProblems++;
+ $characterCount++;
+ }
+ next;
+ }
+
+ 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(/\:/,$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.
+ ':parts'})) {
+
+ if(!defined($CacheData{$name.":$Version:$problem".
+ ":resource.$part.solved"})) {
+ # No grade for this submission, so skip
+ next;
+ }
+
+ my $tries=0;
+ my $code=' ';
+
+ $tries = $CacheData{$name.":$Version:$problem".
+ ":resource.$part.tries"};
+ $partData{$part.':tries'}=($tries) ? $tries : 0;
+
+ my $val = $CacheData{$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;
+ }
+ }
+
+ # 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.='';
+ foreach(split(/\:/,$CacheData{$sequence.':'.$problemID.
+ ':parts'})) {
+ if($partData{$_.':code'} eq '*') {
+ $problemsCorrect++;
+ if (($partData{$_.':tries'}<10) &&
+ ($partData{$_.':tries'} ne '')) {
+ $partData{$_.':code'}=$partData{$_.':tries'};
+ }
+ } elsif($partData{$_.':code'} eq '+') {
+ $problemsCorrect++;
+ }
+
+ $Str .= $partData{$_.':code'};
+ $characterCount++;
+
+ if($partData{$_.':code'} ne 'x') {
+ $totalProblems++;
+ }
+ }
+ $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);
+
+ my $outputProblemsCorrect = sprintf( "%3d", $problemsCorrect );
+ $Str .= ''.$outputProblemsCorrect.'';
+ $problemsSolved += $problemsCorrect;
+ $problemsCorrect=0;
+
+ $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.
+ ' / '.$outputTotalProblems.' ';
- # ResId is 0 for sequences and pages,
- # please check tracetable for changes
- if (!$ResId) {
- my $outputProblemsCorrect = sprintf( "%3d", $problemsCorrect );
- $Str .= ''.$outputProblemsCorrect.
- '
';
- $Str .= '
';
- $problemsSolved += $problemsCorrect;
- $problemsCorrect=0;
- next;
- }
+ untie(%CacheData);
+ return $Str;
+}
- # Set $1 and $2
- $ResId=~/(\d+)\.(\d+)/;
- my $meta=$hash{'src_'.$ResId};
- my $numberOfParts = 0;
- undef %TempHash;
- foreach (split(/\,/,&Apache::lonnet::metadata($meta,'keys'))) {
-#----------- Overwrite $1 in next statement ---------------------------------
- if ($_=~/^stores\_(\d+)\_tries$/) {
- my $Part=&Apache::lonnet::metadata($meta,$_.'.part');
- if ( $TempHash{"$Part"} eq '' ) {
- $TempHash{"$Part"} = $Part;
- $TempHash{$numberOfParts}=$Part;
- $TempHash{"$Part.Code"} = ' ';
- $numberOfParts++;
- }
- }
- }
+=pod
-#----------- Using $1 and $2 -----------------------------------------------
- my $Prob = &Apache::lonnet::symbclean(
- &Apache::lonnet::declutter($hash{'map_id_'.$1} ).
- '___'.$2.'___'.
- &Apache::lonnet::declutter( $hash{'src_'.$ResId} ));
- $Code=' ';
- $Tries = 0;
- $LatestVersion = $CachData{$name.":version:$Prob"};
-
- if ( $LatestVersion ) {
- for ( my $Version=1; $Version<=$LatestVersion; $Version++ ) {
- my $vkeys = $CachData{$name.":$Version:keys:$Prob"};
- my @keys = split(/\:/,$vkeys);
-
- foreach my $Key (@keys) {
-#---------------------- Changing $1 -------------------------------------------
- if (($Key=~/\.(\w+)\.solved$/) && ($Key!~/^\d+\:/)) {
-#---------------------- Using $1 -----------------------------------------------
- my $Part = $1;
- $Tries = $CachData{$name.":$Version:$Prob".
- ":resource.$Part.tries"};
- $TempHash{"$Part.Tries"}=($Tries) ? $Tries : 0;
- my $Val = $CachData{$name.":$Version:$Prob".
- ":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 = ' ';}
-
- $TempHash{"$Part.Code"} = $Code;
- }
- }
- }
-# Actually append problem to output (all parts)
- $Str.='';
- for(my $n = 0; $n < $numberOfParts; $n++) {
- my $part = $TempHash{$n};
- my $code2 = $TempHash{"$part.Code"};
- if($code2 eq '*') {
- $problemsCorrect++;
-# !!!!!!!!!!!------------------------- Should 10 not be maxtries? ------------
- if (($TempHash{"$part.Tries"}<10) ||
- ($TempHash{"$part.Tries"} eq '')) {
- $TempHash{"$part.Code"}=$TempHash{"$part.Tries"};
- }
- } elsif($code2 eq '+') {
- $problemsCorrect++;
- }
-
- $Str .= $TempHash{"$part.Code"};
-
- if($code2 ne 'x') {
- $totalProblems++;
- }
- }
- $Str.='';
- } else {
- for(my $n=0; $n<$numberOfParts; $n++) {
- $Str.=' ';
- $totalProblems++;
- }
- }
+=item &CreateTableHeadings()
+
+This function generates the column headings for the chart.
+
+=over 4
+
+Inputs: $CacheData, $studentInformation, $headings, $spacePadding
+
+$CacheData: pointer to a hash tied to the cached data database
+
+$studentInformation: a pointer to an array containing the names of the data
+held in a column and is used as part of a key into $CacheData
+
+$headings: The names of the headings for the student information
+
+$spacePadding: The spaces to go between columns
+
+Output: $Str
+
+$Str: A formatted string of the table column headings.
+
+=back
+
+=cut
+
+sub CreateTableHeadings {
+ my ($CacheData,$studentInformation,$headings,$spacePadding)=@_;
+ my $Str='
';
return $Str;
}
+=pod
+
+=item &CreateColumnSelectionBox()
+
+If there are columns not being displayed then this selection box is created
+with a list of those columns. When selections are made and the page
+refreshed, the columns will be removed from this box and the column is
+put back in the chart. If there is no columns to select, no row is added
+to the interface table.
+
+=over 4
+Input: $CacheData, $headings
+
+
+$CacheData: A pointer to a hash tied to the cached data
+
+$headings: An array of the names of the columns for the student information.
+They are used for displaying which columns are missing.
+
+Output: $notThere
+
+$notThere: The string contains one row of a table. The first column has the
+name of the selection box. The second contains the selection box
+which has a size of four.
+
+=back
+
+=cut
+
+sub CreateColumnSelectionBox {
+ my ($CacheData,$headings)=@_;
+
+ my $missing=0;
+ my $notThere='
Select column to view:';
+ my $name;
+ $notThere .= '
';
+ $notThere .= '';
+ } else {
+ $notThere='
';
+ }
+
+ return $notThere.'
';
+}
+
+=pod
+
+=item &CreateColumnSelectors()
+
+This function generates the checkboxes above the column headings. The
+column will be removed if the checkbox is unchecked.
+
+=over 4
+
+Input: $CacheData, $headings
+
+$CacheData: A pointer to a hash tied to the cached data
+
+$headings: An array of the names of the columns for the student
+information. They are used to know what are the student information columns
+
+Output: $present
+
+$present: The string contains the first row of a table. Each column contains
+a checkbox which is left justified. Currently left justification is used
+for consistency of location over the column in which it presides.
+
+=back
+
+=cut
+
+sub CreateColumnSelectors {
+ my ($CacheData,$headings)=@_;
+
+ my $found=0;
+ my ($name, $length, $position);
+
+ my $present = '
'."\n";;
+}
+
+=pod
+
+=item &CreateForm()
+
+The interface for this module consists primarily of the controls in this
+function. The student status selection (active, expired, any) is set here.
+The sort buttons: username, last name, and section are set here. The
+other buttons are Recalculate Chart, Refresh Chart, and Reset Selections.
+These controls are in a table to clean up the interface.
+
+=over 4
+
+Input: $CacheData
+
+$CacheData is a hash pointer to tied database for cached data.
+
+Output: $Ptr
+
+$Ptr is a string containing all the html for the above mentioned buttons.
+
+=back
+
+=cut
+
sub CreateForm {
+ my ($CacheData)=@_;
my $OpSel1='';
my $OpSel2='';
my $OpSel3='';
- my $Status = $ENV{'form.status'};
+ my $Status = $CacheData->{'form.ChartStatus'};
if ( $Status eq 'Any' ) { $OpSel3='selected'; }
elsif ($Status eq 'Expired' ) { $OpSel2 = 'selected'; }
else { $OpSel1 = 'selected'; }
- my $Ptr = '