# The LearningOnline Network with CAPA
#
# $Id: lonstudentassessment.pm,v 1.29 2003/02/25 20:47:47 matthew 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/
#
# (Navigate problems for statistical reports
#
#######################################################
#######################################################
=pod
=head1 NAME
lonstudentassessment
=head1 SYNOPSIS
Presents assessment data about a student or a group of students.
=head1 Subroutines
=over 4
=cut
#######################################################
#######################################################
package Apache::lonstudentassessment;
use strict;
use Apache::lonstatistics;
use Apache::lonhtmlcommon;
use Apache::loncoursedata;
use Apache::lonnet; # for logging porpoises
use GDBM_File;
#######################################################
#######################################################
=pod
=item &BuildStudentAssessmentPage()
Inputs:
=over 4
=item $cacheDB The name of the cache file used to store student data
=item $students Array ref containing the name(s) of the students
selected for display
=item $courseID The ID of the course
=item $formName The name of the html form - 'Statistics'
=item $headings Array ref of headings to show
=item $spacing A string of spaces
=item $studentInformation Array ref of possible headings for student info
('fullname','section',...)
=item $r Apache Request
=item $c Apache Connection
=back
=cut
#######################################################
#######################################################
sub BuildStudentAssessmentPage {
my ($cacheDB,$students,$courseID,$formName,$headings,$spacing,
$studentInformation,$r,$c)=@_;
my %cache;
unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
$r->print('Unable to tie database.');
return;
}
# Remove students who don't have the proper section.
my @sectionsSelected = split(':',$cache{'sectionsSelected'});
for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0;
$studentIndex--) {
my $value = $cache{$students->[$studentIndex].':section'};
my $found = 0;
foreach (@sectionsSelected) {
if($_ eq 'none') {
if($value eq '' || !defined($value) || $value eq ' ') {
$found = 1;
last;
}
} else {
if($value eq $_) {
$found = 1;
last;
}
}
}
if($found == 0) {
splice(@$students, $studentIndex, 1);
}
}
my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys,
$doNotShow) =
&ShouldShowColumns(\%cache, $headings, $studentInformation);
my $selectedName = &FindSelectedStudent(\%cache,
$cache{'StudentAssessmentStudent'},
$students);
$r->print(&CreateInterface(\%cache, $selectedName, $students, $formName,
$doNotShow));
$r->rflush();
my $Str = '';
if($selectedName eq 'No Student Selected') {
$Str .= '
WARNING: ';
$Str .= 'No Students enrolled OR Please select a student
';
$r->print($Str);
} else {
if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) {
$r->print(&StudentAverageTotal(\%cache, $students, $sequenceKeys));
untie(%cache);
}
}
return;
}
#######################################################
#######################################################
=pod
=item &CreateInterface()
Called by &BuildStudentAssessmentPage to create the top part of the
page which displays the chart.
Inputs:
=over 4
=item $cache The ubiquitous cache
=item $selectedName The name of the currently selected student, or
'All Students' or 'No Student Selected'.
=item $students Array ref containing the name(s) of the students selected
for display.
=item $formName The name of the HTML form to use, 'Statistics'
=item $doNotShow Array ref containing the names of columns to not show
=back
Returns: A string containing the HTML for the headers and top table for
the chart page.
=cut
#######################################################
#######################################################
sub CreateInterface {
my($cache,$selectedName,$students,$formName,$doNotShow)=@_;
my $Str = '';
$Str .= &CreateLegend();
$Str .= '
'."\n";
return $Str;
}
#######################################################
#######################################################
=pod
=item &StudentReport()
This is the workhorse subroutine - it handles formatting and display of a
students performance data. It processes one row of the chart.
Input:
=over 4
=item $cache The ubiquitous cache
=item $name The name and domain of the current student in name:domain format
=item $spacing A string containing spaces.
=item $showSequences Array ref containing the sequences to display
=back
Output: $Str
$Str: Formatted string that is an entire row of the chart. It is a
concatenation of student information and student course information.
=cut
#######################################################
#######################################################
sub StudentReport {
my ($cache,$name,$spacing,$showSequences)=@_;
my ($username,$domain)=split(':',$name);
my $Str = '';
if(defined($cache->{$name.':error'})) {
return $Str;
}
if($cache->{$name.':error'} =~ /course/) {
$Str .= 'No course data for student ';
$Str .= ''.$username.'. ';
return $Str;
}
my $hasVersion = 'false';
my $hasFinalData = 'false';
foreach my $sequence (@$showSequences) {
my $hasData = 'false';
my $characterCount=0;
foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
my $problem = $cache->{$problemID.':problem'};
# 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
foreach(split(/\:/,$cache->{$sequence.':'.$problemID.
':parts'})) {
if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||
$cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||
$cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {
$Str .= ' ';
$characterCount++;
next;
}
$hasVersion = 'true';
$hasData = 'true';
if (lc($ENV{'form.displaymode'}) ne 'display without links') {
$Str .= '';
}
my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};
my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};
if($code eq '*' && $tries < 10 && $tries ne '') {
$code = $tries;
}
$Str .= $code;
if (lc($ENV{'form.displaymode'}) ne 'display without links') {
$Str .= '';
}
$characterCount++;
}
}
# Output the number of correct answers for the current sequence.
# This part takes up 6 character slots, but is formated right
# justified.
my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount;
$spacesNeeded -= 3;
$Str .= (' 'x$spacesNeeded);
# my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence.
# ':problemsCorrect'});
my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence.
':problemsCorrect'},
$characterCount);
if($hasData eq 'true') {
$Str .= ''.$outputProblemsCorrect.'';
$hasFinalData = 'true';
} else {
$Str .= ' ';
}
$Str .= $spacing;
}
# 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", $cache->{$name.':problemsSolved'});
my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'});
if($hasFinalData eq 'true') {
$Str .= ''.$outputProblemsSolved.
' / '.$outputTotalProblems.'';
} else {
$Str .= ' ';
}
if($hasVersion eq 'false') {
$Str = 'No course data.';
}
return $Str;
}
#######################################################
#######################################################
#######################################################
#######################################################
sub StudentAverageTotal {
my ($cache, $students, $sequenceKeys)=@_;
my $Str = "\nSummary Tables:\n";
my %Correct = ();
my $ProblemsSolved = 0;
my $TotalProblems = 0;
my $StudentCount = 0;
foreach my $name (@$students) {
$StudentCount++;
foreach my $sequence (@$sequenceKeys) {
$Correct{$sequence} +=
$cache->{$name.':'.$sequence.':problemsCorrect'};
}
$ProblemsSolved += $cache->{$name.':problemsSolved'};
$TotalProblems += $cache->{$name.':totalProblems'};
}
if ($StudentCount) {
$ProblemsSolved = sprintf( "%.2f",
$ProblemsSolved/$StudentCount);
$TotalProblems /= $StudentCount;
} else {
$ProblemsSolved = 0;
$TotalProblems = 0;
}
$Str .= '
'."\n";
$Str .= '
Students Count
'.
$StudentCount.'
'."\n";
$Str .= '
Total Problems
'.
$TotalProblems.'
'."\n";
$Str .= '
Average Correct
'.
$ProblemsSolved.'
'."\n";
$Str .= '
'."\n";
$Str .= '
'."\n";
$Str .= '
Title
Total Problems
'.
'
Average Correct
'."\n";
foreach my $S(@$sequenceKeys) {
my $title=$cache->{$S.':title'};
#$Str .= $cache->{$S.':problems'};
#my @problems=split(':', $cache->{$S.':problems'});
#my $pCount=scalar @problems;
my $pCount=MaxSeqPr($cache,@$students[0],$S);
my $crr;
if ($StudentCount) {
$crr=sprintf( "%.2f", $Correct{$S}/$StudentCount );
} else {
$crr="0.00";
}
$Str .= '
'.$title.
'
'.$pCount.
'
'.$crr.
'
'."\n";
}
$Str .= '
'."\n";
return $Str;
}
#######################################################
#######################################################
#######################################################
#######################################################
sub MaxSeqPr {
my ($cache, $name, $sequence)=@_;
my $prCount=0;
foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
my $problem = $cache->{$problemID.':problem'};
foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) {
if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' ||
$cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' ||
$cache->{$name.':'.$problemID.':'.$_.':code'} eq '') {
$prCount++;
next;
}
$prCount++;
}
}
return $prCount;
}
#######################################################
#######################################################
=pod
=item &CreateLegend()
This function returns a formatted string containing the legend for the
chart. The legend describes the symbols used to represent grades for
problems.
=cut
#######################################################
#######################################################
sub CreateLegend {
my $Str = "
".
" 1 correct by student in 1 try\n".
" 7 correct by student in 7 tries\n".
" * correct by student in more than 9 tries\n".
" + correct by hand grading or override\n".
" - incorrect by override\n".
" . incorrect attempted\n".
" # ungraded attempted\n".
" not attempted (blank field)\n".
" x excused".
"
";
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 ($doNotShow)=@_;
my $notThere = '';
$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 ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
my $present = '';
for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
$present .= '