--- loncom/interface/lonstatistics.pm 2003/02/18 20:27:33 1.59
+++ loncom/interface/lonstatistics.pm 2003/02/28 21:19:53 1.62
@@ -1,7 +1,6 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
#
-# $Id: lonstatistics.pm,v 1.59 2003/02/18 20:27:33 matthew Exp $
+# $Id: lonstatistics.pm,v 1.62 2003/02/28 21:19:53 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,12 +25,6 @@
# http://www.lon-capa.org/
#
# (Navigate problems for statistical reports
-# YEAR=2001
-# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei
-# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei
-# YEAR=2002
-# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei
-# 5/12,5/14,5/15,5/19,5/26,7/16,25/7,29/7 Behrouz Minaei
#
###
@@ -47,18 +40,18 @@ Main handler for statistics and chart.
=head1 PACKAGES USED
-use strict;
-use Apache::Constants qw(:common :http);
-use Apache::lonnet();
-use Apache::lonhomework;
-use Apache::loncommon;
-use Apache::loncoursedata;
-use Apache::lonhtmlcommon;
-use Apache::lonproblemanalysis;
-use Apache::lonproblemstatistics;
-use Apache::lonstudentassessment;
-use Apache::lonpercentage;
-use GDBM_File;
+ use strict;
+ use Apache::Constants qw(:common :http);
+ use Apache::lonnet();
+ use Apache::lonhomework;
+ use Apache::loncommon;
+ use Apache::loncoursedata;
+ use Apache::lonhtmlcommon;
+ use Apache::lonproblemanalysis;
+ use Apache::lonproblemstatistics;
+ use Apache::lonstudentassessment;
+ use Apache::lonpercentage;
+ use GDBM_File;
=over 4
@@ -68,20 +61,59 @@ package Apache::lonstatistics;
use strict;
use Apache::Constants qw(:common :http);
+use vars qw(
+ @FullClasslist
+ @Students
+ @Sections
+ @SelectedSections
+ %StudentData
+ @StudentDataOrder
+ @SelectedStudentData
+ $top_map
+ @Sequences
+ @SelectedMaps
+ @Assessments);
+
use Apache::lonnet();
use Apache::lonhomework;
use Apache::loncommon;
use Apache::loncoursedata;
use Apache::lonhtmlcommon;
-use Apache::lonproblemanalysis;
-use Apache::lonproblemstatistics;
-use Apache::lonstudentassessment;
+use Apache::lonproblemanalysis();
+use Apache::lonproblemstatistics();
+use Apache::lonstudentassessment();
use Apache::lonpercentage;
use GDBM_File;
-my @FullClasslist;
-my @Students;
-my @Sections;
+
+#######################################################
+#######################################################
+
+=pod
+
+=item Package Variables
+
+=item @FullClasslist The full classlist
+
+=item @Students The students we are concerned with for this invocation
+
+=item @Sections The sections available in this class
+
+=item $curr_student The student currently being examined
+
+=item $prev_student The student previous in the classlist
+
+=item $next_student The student next in the classlist
+
+=over
+
+=cut
+
+#######################################################
+#######################################################
+#
+# Classlist variables
+#
my $curr_student;
my $prev_student;
my $next_student;
@@ -97,17 +129,25 @@ undef the following package variables:
=over
-=item @FullClasslist The full classlist
+=item @FullClasslist
-=item @Students The students we are concerned with for this invocation
+=item @Students
-=item @Sections The sections available in this class
+=item @Sections
-=item $curr_student The student currently being examined
+=item @SelectedSections
-=item $prev_student The student previous in the classlist
+=item %StudentData
-=item $next_student The student next in the classlist
+=item @StudentDataOrder
+
+=item @SelectedStudentData
+
+=item $curr_student
+
+=item $prev_student
+
+=item $next_student
=back
@@ -119,6 +159,9 @@ sub clear_classlist_variables {
undef(@FullClasslist);
undef(@Students);
undef(@Sections);
+ undef(@SelectedSections);
+ undef(%StudentData);
+ undef(@SelectedStudentData);
undef($curr_student);
undef($prev_student);
undef($next_student);
@@ -136,17 +179,23 @@ the following package variables:
=over
-=item @FullClasslist The full classlist
+=item @FullClasslist
-=item @Students The students we are concerned with for this invocation
+=item @Students
-=item @Sections The sections available in this class
+=item @Sections
-=item $curr_student The student currently being examined
+=item @SelectedSections
-=item $prev_student The student previous in the classlist
+=item %StudentData
-=item $next_student The student next in the classlist
+=item @SelectedStudentData
+
+=item $curr_student
+
+=item $prev_student
+
+=item $next_student
=back
@@ -168,45 +217,74 @@ sub PrepareClasslist {
my $cnum = $ENV{'course.'.$cid.'.num'};
my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cid,
$cdom,$cnum);
- my %valid_section;
- if (exists($ENV{'form.Section'}) && $ENV{'form.Section'} !~ /(all|any)/) {
+ if (exists($ENV{'form.Section'})) {
if (ref($ENV{'form.Section'})) {
- foreach (@$ENV{'form.section'}) {
- $valid_section{$_}++;
- }
- } else {
- $valid_section{$_}++;
+ @SelectedSections = @{$ENV{'form.Section'}};
+ } elsif ($ENV{'form.Section'} !~ /^\s*$/) {
+ @SelectedSections = ($ENV{'form.Section'});
+ }
+ }
+ @SelectedSections = ('all') if (! @SelectedSections);
+ foreach (@SelectedSections) {
+ if ($_ eq 'all') {
+ @SelectedSections = ('all');
}
}
#
+ # Set up %StudentData
+ @StudentDataOrder = qw/fullname username domain id section status/;
+ foreach my $field (@StudentDataOrder) {
+ $StudentData{$field}->{'title'} = $field;
+ $StudentData{$field}->{'base_width'} =
+ scalar (my @Tmp = split(//,$field));
+ $StudentData{$field}->{'width'} =
+ $StudentData{$field}->{'base_width'};
+ }
+
+ #
# Process the classlist
while (my ($student,$student_data) = each (%$classlist)) {
my $studenthash = ();
for (my $i=0; $i< scalar(@$field_names);$i++) {
- $studenthash->{$field_names->[$i]}=$student_data->[$i];
+ my $field = $field_names->[$i];
+ # Store the data
+ $studenthash->{$field}=$student_data->[$i];
+ # Keep track of the width of the fields
+ next if (! exists($StudentData{$field}));
+ my $length = scalar(my @Tmp1 = split(//,$student_data->[$i]));
+ if ($StudentData{$field}->{'width'} < $length) {
+ $StudentData{$field}->{'width'} = $length;
+ }
}
push (@FullClasslist,$studenthash);
#
# Build up a list of sections
my $section = $studenthash->{'section'};
- $section = 'no section' if (! defined($section) || $section =~/^\s*/ );
+ if (! defined($section) || $section =~/^\s*$/ || $section == -1) {
+ $studenthash->{'section'} = 'none';
+ $section = $studenthash->{'section'};
+ }
$Sections{$section}++;
#
# Only put in the list those students we are interested in
- if (defined($ENV{'form.Section'}) &&
- $ENV{'form.Section'} !~ /(all|any)/ &&
- ! exists($valid_section{$section})) {
- next;
+ foreach my $sect (@SelectedSections) {
+ if (($sect eq 'all') || ($section eq $sect)) {
+ push (@Students,$studenthash);
+ last;
+ }
}
- push (@Students,$studenthash);
}
#
# Put the consolidated section data in the right place
- @Sections = sort {$a<=>$b} keys(%Sections);
+ @Sections = sort {$a cmp $b} keys(%Sections);
+ unshift(@Sections,'all'); # Put 'all' at the front of the list
#
# Sort the Students
my $sortby = 'fullname';
- @Students = sort {$a->{$sortby} <=> $b->{$sortby}} @Students;
+ $sortby = $ENV{'form.sort'} if (exists($ENV{'form.sort'}));
+ my @TmpStudents = sort { $a->{$sortby} cmp $b->{$sortby} ||
+ $a->{'fullname'} cmp $b->{'fullname'} } @Students;
+ @Students = @TmpStudents;
#
# Now deal with that current student thing....
if (exists($ENV{'form.StudentAssessmentStudent'})) {
@@ -216,6 +294,7 @@ sub PrepareClasslist {
for ($i = 0; $i<=$#Students; $i++) {
next if (($Students[$i]->{'username'} ne $current_uname) ||
($Students[$i]->{'domain'} ne $current_dom));
+ $curr_student = $Students[$i];
last; # If we get here, we have our student.
}
if ($i == 0) {
@@ -229,11 +308,449 @@ sub PrepareClasslist {
$next_student = $Students[$i+1];
}
}
+ #
+ if (exists($ENV{'form.StudentData'})) {
+ if (ref($ENV{'form.StudentData'}) eq 'ARRAY') {
+ @SelectedStudentData = @{$ENV{'form.StudentData'}};
+ } else {
+ @SelectedStudentData = ($ENV{'form.StudentData'});
+ }
+ } else {
+ @SelectedStudentData = ('fullname');
+ }
+ foreach (@SelectedStudentData) {
+ if ($_ eq 'all') {
+ @SelectedStudentData = ('all');
+ last;
+ }
+ }
+ #
+ return;
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item ¤t_student()
+
+Returns a pointer to a hash containing data about the currently
+selected student.
+
+=cut
+
+#######################################################
+#######################################################
+sub current_student {
+ if (defined($curr_student)) {
+ return $curr_student;
+ } else {
+ return 'All Students';
+ }
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &previous_student()
+
+Returns a pointer to a hash containing data about the student prior
+in the list of students. Or something.
+
+=cut
+
+#######################################################
+#######################################################
+sub previous_student {
+ if (defined($prev_student)) {
+ return $prev_student;
+ } else {
+ return 'No Student Selected';
+ }
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &next_student()
+
+Returns a pointer to a hash containing data about the next student
+to be viewed.
+
+=cut
+
+#######################################################
+#######################################################
+sub next_student {
+ if (defined($next_student)) {
+ return $next_student;
+ } else {
+ return 'No Student Selected';
+ }
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &clear_sequence_variables()
+
+=cut
+
+#######################################################
+#######################################################
+sub clear_sequence_variables {
+ undef($top_map);
+ undef(@Sequences);
+ undef(@Assessments);
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &SetSelectedMaps($elementname)
+
+Sets the @SelectedMaps array from $ENV{'form.'.$elementname};
+
+=cut
+
+#######################################################
+#######################################################
+sub SetSelectedMaps {
+ my $elementname = shift;
+ if (exists($ENV{'form.'.$elementname})) {
+ if (ref($ENV{'form.'.$elementname})) {
+ @SelectedMaps = @{$ENV{'form.'.$elementname}};
+ } else {
+ @SelectedMaps = ($ENV{'form.'.$elementname});
+ }
+ } else {
+ @SelectedMaps = ('all');
+ }
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &PrepareCourseData($r)
+
+=cut
+
+#######################################################
+#######################################################
+sub PrepareCourseData {
+ my ($r) = @_;
+ &clear_sequence_variables();
+ my ($top,$sequences,$assessments) =
+ &Apache::loncoursedata::get_sequence_assessment_data();
+ if (! defined($top) || ! ref($top)) {
+ # There has been an error, better report it
+ &Apache::lonnet::logthis('top is undefined');
+ return;
+ }
+ $top_map = $top if (ref($top));
+ @Sequences = @{$sequences} if (ref($sequences) eq 'ARRAY');
+ @Assessments = @{$assessments} if (ref($assessments) eq 'ARRAY');
+ #
+ # Compute column widths
+ foreach my $seq (@Sequences) {
+ my $name_length = scalar(my @Tmp1 = split(//,$seq->{'title'}));
+ my $num_parts = $seq->{'num_assess_parts'};
+ #
+ # The number of columns needed for the summation text:
+ # " 1/5" = 1+3 columns, " 10/99" = 1+5 columns
+ my $sum_length = 1+1+2*(scalar(my @Tmp2 = split(//,$num_parts)));
+ my $num_col = $num_parts+$sum_length;
+ if ($num_col < $name_length) {
+ $num_col = $name_length;
+ }
+ $seq->{'base_width'} = $name_length;
+ $seq->{'width'} = $num_col;
+ }
+ return;
}
#######################################################
#######################################################
+=pod
+
+=item &log_sequence($sequence,$recursive,$padding)
+
+Write data about the sequence to a logfile. If $recursive is not
+undef the data is written recursively. $padding is used for recursive
+calls.
+
+=cut
+
+#######################################################
+#######################################################
+sub log_sequence {
+ my ($seq,$recursive,$padding) = @_;
+ $padding = '' if (! defined($padding));
+ if (ref($seq) ne 'HASH') {
+ &Apache::lonnet::logthis('log_sequence passed bad sequnce');
+ return;
+ }
+ &Apache::lonnet::logthis($padding.'sequence '.$seq->{'title'});
+ while (my($key,$value) = each(%$seq)) {
+ next if ($key eq 'contents');
+ if (ref($value) eq 'ARRAY') {
+ for (my $i=0;$i< scalar(@$value);$i++) {
+ &Apache::lonnet::logthis($padding.$key.'['.$i.']='.
+ $value->[$i]);
+ }
+ } else {
+ &Apache::lonnet::logthis($padding.$key.'='.$value);
+ }
+ }
+ if (defined($recursive)) {
+ &Apache::lonnet::logthis($padding.'-'x20);
+ &Apache::lonnet::logthis($padding.'contains:');
+ foreach my $item (@{$seq->{'contents'}}) {
+ if ($item->{'type'} eq 'container') {
+ &log_sequence($item,$recursive,$padding.' ');
+ } else {
+ &Apache::lonnet::logthis($padding.'title = '.$item->{'title'});
+ while (my($key,$value) = each(%$item)) {
+ next if ($key eq 'title');
+ if (ref($value) eq 'ARRAY') {
+ for (my $i=0;$i< scalar(@$value);$i++) {
+ &Apache::lonnet::logthis($padding.$key.'['.$i.']='.
+ $value->[$i]);
+ }
+ } else {
+ &Apache::lonnet::logthis($padding.$key.'='.$value);
+ }
+ }
+ }
+ }
+ &Apache::lonnet::logthis($padding.'end contents of '.$seq->{'title'});
+ &Apache::lonnet::logthis($padding.'-'x20);
+ }
+ return;
+}
+
+##############################################
+##############################################
+
+=pod
+
+=item &StudentDataSelect($elementname,$status,$numvisible,$selected)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the fields of student data available (fullname, username, id, section, etc)
+
+=over 4
+
+=item $elementname The name of the HTML form element
+
+=item $status 'multiple' or 'single' selection box
+
+=item $numvisible The number of options to be visible
+
+=back
+
+=cut
+
+##############################################
+##############################################
+sub StudentDataSelect {
+ my ($elementname,$status,$numvisible)=@_;
+ if ($numvisible < 1) {
+ return;
+ }
+ #
+ # Build the form element
+ my $Str = "\n";
+ $Str .= '\n";
+ return $Str;
+}
+
+##############################################
+##############################################
+
+=pod
+
+=item &MapSelect($elementname,$status,$numvisible,$restriction)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the sequences in the course. The values of the sequences are the symbs.
+If the top sequence is selected, the value 'top' will result.
+
+=over 4
+
+=item $elementname The name of the HTML form element
+
+=item $status 'multiple' or 'single' selection box
+
+=item $numvisible The number of options to be visible
+
+=item $restriction Code reference to subroutine which returns true or
+false. The code must expect a reference to a sequence data structure.
+
+=back
+
+=cut
+
+##############################################
+##############################################
+sub MapSelect {
+ my ($elementname,$status,$numvisible,$restriction)=@_;
+ if ($numvisible < 1) {
+ return;
+ }
+ #
+ # Set up array of selected items
+ &SetSelectedMaps($elementname);
+ #
+ # Set up the restriction call
+ if (! defined($restriction)) {
+ $restriction = sub { 1; };
+ }
+ #
+ # Build the form element
+ my $Str = "\n";
+ $Str .= '\n";
+ return $Str;
+}
+
+##############################################
+##############################################
+
+=pod
+
+=item &SectionSelect($elementname,$status,$numvisible)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the sections in the course.
+
+=over 4
+
+=item $elementname The name of the HTML form element
+
+=item $status 'multiple' or 'single' selection box
+
+=item $numvisible The number of options to be visible
+
+=item $selected Array ref to the names of the already selected sections.
+If undef, $ENV{'form.'.$elementname} is used.
+If $ENV{'form.'.$elementname} is also empty, none will be selected.
+
+=item $restriction Code reference to subroutine which returns true or
+false. The code must expect a reference to a sequence data structure.
+
+=back
+
+=cut
+
+##############################################
+##############################################
+sub SectionSelect {
+ my ($elementname,$status,$numvisible)=@_;
+ if ($numvisible < 1) {
+ return;
+ }
+ #
+ # Build the form element
+ my $Str = "\n";
+ $Str .= '\n";
+ return $Str;
+}
+
+##############################################
+##############################################
+
sub CheckFormElement {
my ($cache, $ENVName, $cacheName, $default)=@_;
@@ -241,8 +758,9 @@ sub CheckFormElement {
$cache->{$cacheName} = $ENV{'form.'.$ENVName};
} elsif(!defined($cache->{$cacheName})) {
$cache->{$cacheName} = $default;
+ } else {
+ $ENV{'form.'.$ENVName} = $cache->{$cacheName};
}
-
return;
}
@@ -252,7 +770,7 @@ sub ProcessFormData{
$cache->{'reportKey'} = 'false';
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['sort','download',
+ ['download',
'reportSelected',
'StudentAssessmentStudent',
'ProblemStatisticsSort']);
@@ -399,6 +917,9 @@ sub ProcessFormData{
return;
}
+##################################################
+##################################################
+
=pod
=item &SortStudents()
@@ -598,6 +1119,54 @@ sub PrepareData {
return ('OK', $students);
}
+sub DisplayClasslist {
+ my ($r)=@_;
+ #
+ my @Fields = ('fullname','username','domain','id','section');
+ #
+ my $Str='';
+ $Str .= '