--- loncom/interface/lonstatistics.pm 2005/02/25 23:23:47 1.117
+++ loncom/interface/lonstatistics.pm 2005/12/13 16:32:22 1.127
@@ -1,6 +1,6 @@
# The LearningOnline Network with CAPA
#
-# $Id: lonstatistics.pm,v 1.117 2005/02/25 23:23:47 matthew Exp $
+# $Id: lonstatistics.pm,v 1.127 2005/12/13 16:32:22 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -50,13 +50,12 @@ use vars qw(
@FullClasslist
@Students
@Sections
- @SelectedSections
%StudentData
@StudentDataOrder
@SelectedStudentData
$enrollment_status);
-use Apache::lonnet();
+use Apache::lonnet;
use Apache::lonhomework;
use Apache::loncommon;
use Apache::loncoursedata;
@@ -124,8 +123,6 @@ undef the following package variables:
=item @Sections
-=item @SelectedSections
-
=item %StudentData
=item @StudentDataOrder
@@ -148,7 +145,6 @@ sub clear_classlist_variables {
undef(@FullClasslist);
undef(@Students);
undef(@Sections);
- undef(@SelectedSections);
undef(%StudentData);
undef(@SelectedStudentData);
undef($curr_student);
@@ -174,8 +170,6 @@ the following package variables:
=item @Sections
-=item @SelectedSections
-
=item %StudentData
=item @SelectedStudentData
@@ -200,28 +194,16 @@ sub PrepareClasslist {
&clear_classlist_variables();
#
# Retrieve the classlist
- my $cid = $ENV{'request.course.id'};
- my $cdom = $ENV{'course.'.$cid.'.domain'};
- my $cnum = $ENV{'course.'.$cid.'.num'};
- my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cid,
- $cdom,$cnum);
- if (exists($ENV{'form.Section'})) {
- if (ref($ENV{'form.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');
- }
- }
+ my $cid = $env{'request.course.id'};
+ my $cdom = $env{'course.'.$cid.'.domain'};
+ my $cnum = $env{'course.'.$cid.'.num'};
+ my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cdom,
+ $cnum);
+ my @selected_sections = &get_selected_sections();
#
# Deal with instructors with restricted section access
- if ($ENV{'request.course.sec'} !~ /^\s*$/) {
- @SelectedSections = ($ENV{'request.course.sec'});
+ if ($env{'request.course.sec'} !~ /^\s*$/) {
+ @selected_sections = ($env{'request.course.sec'});
}
#
# Set up %StudentData
@@ -235,7 +217,7 @@ sub PrepareClasslist {
#
# get the status requested
$enrollment_status = 'Active';
- $enrollment_status = $ENV{'form.Status'} if (exists($ENV{'form.Status'}));
+ $enrollment_status = $env{'form.Status'} if (exists($env{'form.Status'}));
#
# Process the classlist
while (my ($student,$student_data) = each (%$classlist)) {
@@ -262,7 +244,7 @@ sub PrepareClasslist {
$Sections{$section}++;
#
# Only put in the list those students we are interested in
- foreach my $sect (@SelectedSections) {
+ foreach my $sect (@selected_sections) {
if ( (($sect eq 'all') ||
($section eq $sect)) &&
(($studenthash->{'status'} eq $enrollment_status) ||
@@ -275,8 +257,8 @@ sub PrepareClasslist {
}
#
# Put the consolidated section data in the right place
- if ($ENV{'request.course.sec'} !~ /^\s*$/) {
- @Sections = ($ENV{'request.course.sec'});
+ if ($env{'request.course.sec'} !~ /^\s*$/) {
+ @Sections = ($env{'request.course.sec'});
} else {
@Sections = sort {$a cmp $b} keys(%Sections);
unshift(@Sections,'all'); # Put 'all' at the front of the list
@@ -284,16 +266,17 @@ sub PrepareClasslist {
#
# Sort the Students
my $sortby = 'fullname';
- $sortby = $ENV{'form.sort'} if (exists($ENV{'form.sort'}));
- my @TmpStudents = sort { $a->{$sortby} cmp $b->{$sortby} ||
- $a->{'fullname'} cmp $b->{'fullname'} } @Students;
+ $sortby = $env{'form.sort'} if (exists($env{'form.sort'}));
+ my @TmpStudents = sort { lc($a->{$sortby}) cmp lc($b->{$sortby}) ||
+ lc($a->{'fullname'}) cmp lc($b->{'fullname'}) ||
+ lc($a->{'username'}) cmp lc($b->{'username'}) } @Students;
@Students = @TmpStudents;
#
# Now deal with that current student thing....
$curr_student = undef;
- if (exists($ENV{'form.SelectedStudent'})) {
+ if (exists($env{'form.SelectedStudent'})) {
my ($current_uname,$current_dom) =
- split(':',$ENV{'form.SelectedStudent'});
+ split(':',$env{'form.SelectedStudent'});
my $i;
for ($i = 0; $i<=$#Students; $i++) {
next if (($Students[$i]->{'username'} ne $current_uname) ||
@@ -315,12 +298,9 @@ sub PrepareClasslist {
}
}
#
- if (exists($ENV{'form.StudentData'})) {
- if (ref($ENV{'form.StudentData'}) eq 'ARRAY') {
- @SelectedStudentData = @{$ENV{'form.StudentData'}};
- } else {
- @SelectedStudentData = ($ENV{'form.StudentData'});
- }
+ if (exists($env{'form.StudentData'})) {
+ @SelectedStudentData =
+ &Apache::loncommon::get_env_multiple('form.StudentData');
} else {
@SelectedStudentData = ('username');
}
@@ -334,6 +314,97 @@ sub PrepareClasslist {
return;
}
+#######################################################
+#######################################################
+
+=pod
+
+=item get_selected_sections
+
+Returns an array of the selected sections
+
+=cut
+
+#######################################################
+#######################################################
+sub get_selected_sections {
+ my @selected_sections =
+ &Apache::loncommon::get_env_multiple('form.Section');
+ @selected_sections = ('all') if (! @selected_sections);
+ foreach (@selected_sections) {
+ if ($_ eq 'all') {
+ @selected_sections = ('all');
+ }
+ }
+ #
+ # Deal with instructors with restricted section access
+ if ($env{'request.course.sec'} !~ /^\s*$/) {
+ @selected_sections = ($env{'request.course.sec'});
+ }
+ return @selected_sections;
+}
+
+#######################################################
+#######################################################
+
+=pod
+
+=item §ion_and_enrollment_description
+
+Returns a string describing the currenly selected section(s) and
+enrollment status.
+
+Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized')
+ 'plaintext' is used for example in Excel spreadsheets.
+Returns: scalar description string.
+
+=cut
+
+#######################################################
+#######################################################
+sub section_and_enrollment_description {
+ my ($mode) = @_;
+ if (! defined($mode)) { $mode = 'localized'; }
+ my @sections = &Apache::lonstatistics::get_selected_sections();
+ my $description;
+ if ($mode eq 'localized') {
+ $description = &mt('Unable to determine section and enrollment');
+ } elsif ($mode eq 'plaintext') {
+ $description = 'Unable to determine section and enrollment';
+ } else {
+ $description = 'Bad parameter passed to lonstatistics::section_and_enrollment_description';
+ &Apache::lonnet::logthis($description);
+ }
+ if (scalar(@sections) == 1 && $sections[0] ne 'all') {
+ if ($mode eq 'localized') {
+ $description = &mt('Section [_1]. [_2] enrollment status.',
+ $sections[0],$env{'form.Status'});
+ } elsif ($mode eq 'plaintext') {
+ $description = 'Section '.$sections[0].'. '.
+ $env{'form.Status'}.' enrollment status.';
+ }
+ } elsif (scalar(@sections) && $sections[0] eq 'all') {
+ if ($mode eq 'localized') {
+ $description = &mt('All sections. [_1] enrollment status.',
+ $env{'form.Status'});
+ } elsif ($mode eq 'plaintext') {
+ $description = 'All sections. '.
+ $env{'form.Status'}.' enrollment status.';
+ }
+ } elsif (scalar(@sections)) {
+ my $lastsection = pop(@sections);
+ if ($mode eq 'localized') {
+ $description = &mt('Sections [_1] and [_2]. [_3] enrollment status.',
+ join(', ',@sections),$lastsection,
+ $env{'form.Status'});
+ } elsif ($mode eq 'plaintext') {
+ $description =
+ 'Sections '.join(', ',@sections).' and '.$lastsection.'. '.
+ $env{'form.Status'}.' enrollment status.';
+ }
+ }
+ return $description;
+}
#######################################################
#######################################################
@@ -490,15 +561,14 @@ Returns: Array of symbs of selected maps
#######################################################
sub get_selected_maps {
my ($elementname) = @_;
- my @selected_maps;
- if (exists($ENV{'form.'.$elementname})) {
- if (ref($ENV{'form.'.$elementname})) {
- @selected_maps = @{$ENV{'form.'.$elementname}};
- } else {
- @selected_maps = ($ENV{'form.'.$elementname});
+ my @selected_maps =
+ &Apache::loncommon::get_env_multiple('form.'.$elementname);
+ @selected_maps = ('all') if (! @selected_maps);
+ foreach my $map (@selected_maps) {
+ if ($map eq 'all') {
+ @selected_maps = ('all');
+ last;
}
- } else {
- @selected_maps = ('all');
}
return @selected_maps;
}
@@ -535,7 +605,7 @@ sub selected_sequences_with_assessments
sub { shift->is_map(); },1,0,1);
my @sequences_with_assessments;
for my $sequence ($navmap->getById('0.0'), @sequences) {
- if ($navmap->hasResource($sequence,sub { shift->is_problem(); }, 0)){
+ if ($navmap->hasResource($sequence,sub { shift->is_problem(); },0,1)){
push(@sequences_with_assessments,$sequence);
}
}
@@ -599,21 +669,10 @@ sub map_select {
}
$form .= 'size="'.$numvisible.'" >'."\n";
#
- # Deal with 'all'
- foreach (@selected_maps) {
- if ($_ eq 'all') {
- @selected_maps = ('all');
- last;
- }
- }
- #
# Put in option for 'all'
$form .= ' <option value="all" ';
- foreach (@selected_maps) {
- if ($_ eq 'all') {
- $form .= 'selected ';
- last;
- }
+ if ($selected_maps[0] eq 'all') {
+ $form .= 'selected ';
}
$form .= ">all</option>\n";
#
@@ -649,7 +708,7 @@ sub map_select {
Returns html for a selection box allowing the user to choose one (or more)
of the sections in the course.
-Uses the package variables @Sections and @SelectedSections
+Uses the package variables @Sections
=over 4
=item $elementname The name of the HTML form element
@@ -686,7 +745,7 @@ sub SectionSelect {
# Loop through the sequences
foreach my $s (@Sections) {
$Str .= ' <option value="'.$s.'" ';
- foreach (@SelectedSections) {
+ foreach (&get_selected_sections()) {
if ($s eq $_) {
$Str .= 'selected ';
last;
@@ -731,32 +790,33 @@ sub DisplayClasslist {
my @Fields = ('fullname','username','domain','id','section','status');
#
$Str = '';
+ my @selected_sections = &get_selected_sections();
if (! @Students) {
- if ($SelectedSections[0] eq 'all') {
- if (lc($ENV{'form.Status'}) eq 'any') {
+ if ($selected_sections[0] eq 'all') {
+ if (lc($env{'form.Status'}) eq 'any') {
$Str .= '<h2>'.
&mt('There are no students in the course.').
'</h2>';
- } elsif (lc($ENV{'form.Status'}) eq 'active') {
+ } elsif (lc($env{'form.Status'}) eq 'active') {
$Str .= '<h2>'.
&mt('There are no currently enrolled students in the course.').
'</h2>';
- } elsif (lc($ENV{'form.Status'}) eq 'expired') {
+ } elsif (lc($env{'form.Status'}) eq 'expired') {
$Str .= '<h2>'.
&mt('There are no previously enrolled students in the course.').
'</h2>';
}
} else {
my $sections;
- if (lc($ENV{'form.Status'}) eq 'any') {
+ if (lc($env{'form.Status'}) eq 'any') {
$Str .= '<h2>'.
&mt('There are no students in the selected sections.').
'</h2>';
- } elsif (lc($ENV{'form.Status'}) eq 'active') {
+ } elsif (lc($env{'form.Status'}) eq 'active') {
$Str .= '<h2>'.
&mt('There are no currently enrolled students in the selected sections.').
'</h2>';
- } elsif (lc($ENV{'form.Status'}) eq 'expired') {
+ } elsif (lc($env{'form.Status'}) eq 'expired') {
$Str .= '<h2>'.
&mt('There are no previously enrolled students in the selected sections.').
'</h2>';
@@ -797,7 +857,7 @@ sub DisplayClasslist {
if ($field eq 'fullname' || $field eq 'username') {
$Str .= '<a href="/adm/statistics?reportSelected=';
$Str .= &Apache::lonnet::escape('student_assessment');
- $Str .= '&sort='.&Apache::lonnet::escape($ENV{'form.sort'});
+ $Str .= '&sort='.&Apache::lonnet::escape($env{'form.sort'});
$Str .= '&SelectedStudent=';
$Str .= &Apache::lonnet::escape($sname).'">';
$Str .= $student->{$field}.' ';
@@ -889,16 +949,16 @@ sub handler {
if ($loaderror) { return $loaderror; }
$loaderror=
&Apache::lonnet::overloaderror($r,
- $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
+ $env{'course.'.$env{'request.course.id'}.'.home'});
if ($loaderror) { return $loaderror; }
#
# Check for access
- if (! &Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
- $ENV{'user.error.msg'}=
+ if (! &Apache::lonnet::allowed('vgr',$env{'request.course.id'})) {
+ $env{'user.error.msg'}=
$r->uri.":vgr:0:0:Cannot view grades for complete course";
if (! &Apache::lonnet::allowed('vgr',
- $ENV{'request.course.id'}.'/'.$ENV{'request.course.sec'})) {
- $ENV{'user.error.msg'}=
+ $env{'request.course.id'}.'/'.$env{'request.course.sec'})) {
+ $env{'user.error.msg'}=
$r->uri.":vgr:0:0:Cannot view grades with given role";
return HTTP_NOT_ACCEPTABLE;
}
@@ -939,8 +999,8 @@ ENDSTYLE
text =>'Statistics',
faq=>139,
bug=>'Statistics and Charts'});
- if (! exists($ENV{'form.reportSelected'}) ||
- $ENV{'form.reportSelected'} eq '') {
+ if (! exists($env{'form.reportSelected'}) ||
+ $env{'form.reportSelected'} eq '') {
$r->print(&Apache::lonhtmlcommon::breadcrumbs
(undef,&mt('Statistics Main Page')).
&CreateMainMenu());
@@ -964,8 +1024,8 @@ ENDSTYLE
}
#
# Clean out the caches
- if (exists($ENV{'form.ClearCache'})) {
- &Apache::loncoursedata::delete_caches($ENV{'requres.course.id'});
+ if (exists($env{'form.ClearCache'})) {
+ &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
}
#
# Begin form output
@@ -973,7 +1033,7 @@ ENDSTYLE
$r->print('method="post" action="/adm/statistics">');
$r->rflush();
#
- my $GoToPage = $ENV{'form.reportSelected'};
+ my $GoToPage = $env{'form.reportSelected'};
#
$r->print('<input type="hidden" name="reportSelected" value="'.
$GoToPage.'">');