--- loncom/interface/Attic/lonchart.pm 2001/02/05 18:58:04 1.3
+++ loncom/interface/Attic/lonchart.pm 2002/07/17 12:36:17 1.60
@@ -1,4 +1,30 @@
# The LearningOnline Network with CAPA
+# (Publication Handler
+#
+# $Id: lonchart.pm,v 1.60 2002/07/17 12:36:17 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
@@ -6,304 +32,1200 @@
# (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
#
-# 3/1/1,6/1,17/1,29/1,30/1 Gerd Kortemeyer)
-#
-# 1/31 Gerd Kortemeyer
+###
+
+=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 @cols;
-my @rowlabels;
-my @students;
-
-# ------------------------------------------------------------- Find out status
-
-sub astatus {
- my ($rid,$student)=@_;
- my ($uname,$udom)=split(/\:/,$student);
- my $code=' ';
- $rid=~/(\d+)\.(\d+)/;
- my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
- &Apache::lonnet::declutter($hash{'src_'.$rid});
- my $answer=&Apache::lonnet::reply(
- "restore:$udom:$uname:".
- $ENV{'request.course.id'}.':'.
- &Apache::lonnet::escape($symb),
- &Apache::lonnet::homeserver($uname,$udom));
- my %returnhash=();
- map {
- my ($name,$value)=split(/\=/,$_);
- $returnhash{&Apache::lonnet::unescape($name)}=
- &Apache::lonnet::unescape($value);
- } split(/\&/,$answer);
- if ($returnhash{'version'}) {
- my $version;
- for ($version=1;$version<=$returnhash{'version'};$version++) {
- map {
- $returnhash{$_}=$returnhash{$version.':'.$_};
- } split(/\:/,$returnhash{$version.':keys'});
- }
- my $totaltries=0;
- map {
- if (($_=~/\.(\w+)\.solved$/) && ($_!~/^\d+\:/)) {
- my $part=$1;
- if ($returnhash{$_} eq 'correct_by_student') {
- unless (($code eq '.') || ($code eq '-')) { $code='*'; }
- $totaltries+=$returnhash{'resource.'.$part.'.tries'};
- } elsif ($returnhash{$_} eq 'correct_by_override') {
- unless (($code eq '.') || ($code eq '-')) { $code='+'; }
- } elsif ($returnhash{$_} eq 'incorrect_attempted') {
- $code='.';
- } elsif ($returnhash{$_} eq 'incorrect_by_override') {
- $code='-';
- } elsif ($returnhash{$_} eq 'excused') {
- unless (($code eq '.') || ($code eq '-')) { $code='x'; }
- }
- }
- } keys %returnhash;
- if (($code eq '*') && ($totaltries<10)) { $code="$totaltries"; }
- }
- return $code;
-}
-
-# ------------------------------------------------------------ Build page table
-
-sub tracetable {
- my ($rid,$beenhere)=@_;
- unless ($beenhere=~/\&$rid\&/) {
- $beenhere.=$rid.'&';
- if (defined($hash{'is_map_'.$rid})) {
- if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
- eq 'sequence') {
- $cols[$#cols+1]=0;
- }
- if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
- (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
- my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
-
- &tracetable($hash{'map_start_'.$hash{'src_'.$rid}},
- '&'.$frid.'&');
-
- if ($hash{'src_'.$frid}) {
- if ($hash{'src_'.$frid}=~
- /\.(problem|exam|quiz|assess|survey|form)$/) {
- $cols[$#cols+1]=$frid;
- }
- }
-
- }
- } else {
- if ($hash{'src_'.$rid}) {
- if ($hash{'src_'.$rid}=~
- /\.(problem|exam|quiz|assess|survey|form)$/) {
- $cols[$#cols+1]=$rid;
- }
- }
- }
- if (defined($hash{'to_'.$rid})) {
- map {
- &tracetable($hash{'goesto_'.$_},$beenhere);
- } split(/\,/,$hash{'to_'.$rid});
- }
+#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='';
+ my $data;
+
+ for(my $index=0; $index<(scalar @$studentInformation); $index++) {
+ if(!&ShouldShowColumn($cache, 'ChartHeading'.$index)) {
+ next;
+ }
+ $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;
}
-# ================================================================ Main Handler
+=pod
-sub handler {
- my $r=shift;
+=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.
- if (&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
-# ------------------------------------------- Set document type for header only
+$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 '';
+ }
+
+# my $section = &Apache::loncoursedata::CheckStatus($name, \%CacheData,
+# $CacheData{'form.Status'});
+# if($section eq 'not found') {
+# untie(%CacheData);
+# 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;
+ }
+ }
- if ($r->header_only) {
- if ($ENV{'browser.mathml'}) {
- $r->content_type('text/xml');
- } else {
- $r->content_type('text/html');
- }
- $r->send_http_header;
- return OK;
- }
-
- my $requrl=$r->uri;
-# ----------------------------------------------------------------- Tie db file
- if ($ENV{'request.course.fn'}) {
- my $fn=$ENV{'request.course.fn'};
- if (-e "$fn.db") {
- if (tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER,0640)) {
-# ------------------------------------------------------------------- Hash tied
-
-
-# ------------------------------------------------------------------ Build page
-
-# ---------------------------------------------------------------- Send headers
-
- $r->content_type('text/html');
- $r->send_http_header;
- $r->print(
- 'LON-CAPA Assessment Chart');
-
- $r->print(''.
- ''.
- ''.
- '
Assessment Chart
');
-
-# ---------------------------------------------------------------- Course title
-
- $r->print('
');
-
-
-# ------------------------------- This is going to take a while, produce output
-
- $r->rflush();
-
-# ----------------------- Get first and last resource, see if there is anything
-
-
- my $firstres=$hash{'map_start_/res/'.$ENV{'request.course.uri'}};
- my $lastres=$hash{'map_finish_/res/'.$ENV{'request.course.uri'}};
- if (($firstres) && ($lastres)) {
-# ----------------------------------------------------------------- Render page
-
- my $cid=$ENV{'request.course.id'};
- my $chome=$ENV{'course.'.$cid.'.home'};
- my ($cdom,$cnum)=split(/\_/,$cid);
-
-# ---------------------------------------------- Read class list and row labels
-
- undef @rowlabels;
- undef @students;
-
- my $classlst=&Apache::lonnet::reply
- ('dump:'.$cdom.':'.$cnum.':classlist',$chome);
- my $now=time;
- unless ($classlst=~/^error\:/) {
- map {
- my ($name,$value)=split(/\=/,$_);
- my ($end,$start)=split(/\:/,&Apache::lonnet::unescape($value));
- my $active=1;
- if (($end) && ($now>$end)) { $active=0; }
- if ($active) {
- my $thisindex=$#students+1;
- $name=&Apache::lonnet::unescape($name);
- $students[$thisindex]=$name;
- my ($sname,$sdom)=split(/\:/,$name);
- my $ssec=&Apache::lonnet::usection($sdom,$sname,$cid);
- if ($ssec==-1) {
- $rowlabels[$thisindex]=
- 'Data not available: '.$name;
- } else {
- my %reply=&Apache::lonnet::idrget($sdom,$sname);
- my $reply=&Apache::lonnet::reply('get:'.$sdom.':'.$sname.
- ':environment:lastname&generation&firstname&middlename',
- &Apache::lonnet::homeserver($sname,$sdom));
- $rowlabels[$thisindex]=
- sprintf('%3s',$ssec).' '.$reply{$sname}.' ';
- my $i=0;
- map {
- $i++;
- if ( $_ ne '') {
- $rowlabels[$thisindex].=&Apache::lonnet::unescape($_).'
-';
- }
- if ($i == 2) {
- chop($rowlabels[$thisindex]);
- $rowlabels[$thisindex].=', ';
- }
- } split(/\&/,$reply);
-
- }
+ # 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++;
+ }
}
- } sort split(/\&/,$classlst);
+ $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='
';
+
+ 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 {
- $r->print('
Could not access course data
');
+ $notThere='
';
}
- my $allstudents=$#students+1;
- $r->print('
'.$allstudents.' students
');
- $r->rflush();
+ 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
-# --------------- Find all assessments and put them into some linear-like order
+$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.
- &tracetable($firstres,'&'.$lastres.'&');
+=back
-# ----------------------------------------------------------------- Start table
+=cut
- $r->print('
'."\n";;
}
-} else {
- $ENV{'user.error.msg'}=
- $r->uri.":vgr:0:0:Cannot view grades for complete course";
- return HTTP_NOT_ACCEPTABLE;
+=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 = $CacheData->{'form.Status'};
+ if ( $Status eq 'Any' ) { $OpSel3='selected'; }
+ elsif ($Status eq 'Expired' ) { $OpSel2 = 'selected'; }
+ else { $OpSel1 = 'selected'; }
+
+ my $Ptr .= '
'.
- '