# The LearningOnline Network with CAPA
# (Publication Handler
#
# $Id: lonchart.pm,v 1.59 2002/07/09 15:43:49 stredwic Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
# Homework Performance Chart
#
# (Navigate Maps Handler
#
# (Page Handler
#
# (TeX Content Handler
# YEAR=2000
# 05/29/00,05/30 Gerd Kortemeyer)
# 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
# 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
# YEAR=2001
# 3/1/1,6/1,17/1,29/1,30/1,31/1 Gerd Kortemeyer)
# 7/10/01 Behrouz Minaei
# 9/8 Gerd Kortemeyer
# 10/1, 10/19, 11/17, 11/22, 11/24, 11/28 12/18 Behrouz Minaei
# YEAR=2002
# 2/1, 2/6, 2/19, 2/28 Behrouz Minaei
#
###
=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;
#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;
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 $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($CacheData{$name.':error'} =~ /environment/) {
$Str .= '
';
untie(%CacheData);
return $Str;
}
if($CacheData{$name.':error'} =~ /course/) {
$Str .= '
';
untie(%CacheData);
return $Str;
}
# Handle problem data ------------------------------------------------
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.'
';
untie(%CacheData);
return $Str;
}
=pod
=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='
'; my $data=$$headings[$index]; $Str .= $data; my @dataLength=split(//,$data); my $length=scalar @dataLength; $Str .= (' 'x($CacheData->{$$studentInformation[$index].'Length'}- $length)); $Str .= $spacePadding; $Str .= '
'; my $name = $CacheData->{$sequence.':title'}; $Str .= $name; my @titleLength=split(//,$CacheData->{$sequence.':title'}); my $leftover=$CacheData->{$sequence.':columnWidth'}- (scalar @titleLength); $Str .= (' 'x$leftover); $Str .= $spacePadding; $Str .= '
Total Solved/Total Problems