--- loncom/interface/lonstatistics.pm 2004/09/24 19:41:17 1.111
+++ loncom/interface/lonstatistics.pm 2005/03/14 20:28:21 1.119
@@ -1,6 +1,6 @@
# The LearningOnline Network with CAPA
#
-# $Id: lonstatistics.pm,v 1.111 2004/09/24 19:41:17 matthew Exp $
+# $Id: lonstatistics.pm,v 1.119 2005/03/14 20:28:21 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -50,14 +50,9 @@ use vars qw(
@FullClasslist
@Students
@Sections
- @SelectedSections
%StudentData
@StudentDataOrder
@SelectedStudentData
- $top_map
- @Sequences
- @SelectedMaps
- @Assessments
$enrollment_status);
use Apache::lonnet();
@@ -128,8 +123,6 @@ undef the following package variables:
=item @Sections
-=item @SelectedSections
-
=item %StudentData
=item @StudentDataOrder
@@ -152,7 +145,6 @@ sub clear_classlist_variables {
undef(@FullClasslist);
undef(@Students);
undef(@Sections);
- undef(@SelectedSections);
undef(%StudentData);
undef(@SelectedStudentData);
undef($curr_student);
@@ -178,8 +170,6 @@ the following package variables:
=item @Sections
-=item @SelectedSections
-
=item %StudentData
=item @SelectedStudentData
@@ -209,23 +199,11 @@ sub PrepareClasslist {
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 @selected_sections = &get_selected_sections();
#
# Deal with instructors with restricted section access
if ($ENV{'request.course.sec'} !~ /^\s*$/) {
- @SelectedSections = ($ENV{'request.course.sec'});
+ @selected_sections = ($ENV{'request.course.sec'});
}
#
# Set up %StudentData
@@ -266,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) ||
@@ -338,79 +316,40 @@ sub PrepareClasslist {
return;
}
-
#######################################################
#######################################################
=pod
-=item get_students
+=item get_selected_sections
-Returns a list of the selected students
+Returns an array of the selected sections
=cut
#######################################################
#######################################################
-sub get_students {
- if (! @Students) {
- &PrepareClasslist()
+sub get_selected_sections {
+ my @selected_sections;
+ if (exists($ENV{'form.Section'})) {
+ if (ref($ENV{'form.Section'})) {
+ @selected_sections = @{$ENV{'form.Section'}};
+ } elsif ($ENV{'form.Section'} !~ /^\s*$/) {
+ @selected_sections = ($ENV{'form.Section'});
+ }
}
- return @Students;
-}
-
-#######################################################
-#######################################################
-
-=pod
-
-=item ¤t_student()
-
-Returns a pointer to a hash containing data about the currently
-selected student.
-
-=cut
-
-#######################################################
-#######################################################
-sub current_student {
- return $curr_student;
-}
-
-#######################################################
-#######################################################
-
-=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 {
- return $prev_student;
-}
-
-#######################################################
-#######################################################
-
-=pod
-
-=item &next_student()
-
-Returns a pointer to a hash containing data about the next student
-to be viewed.
-
-=cut
-
-#######################################################
-#######################################################
-sub next_student {
- return $next_student;
+ @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;
}
#######################################################
@@ -418,16 +357,28 @@ sub next_student {
=pod
-=item &clear_sequence_variables()
+=item §ion_and_enrollment_description
=cut
#######################################################
#######################################################
-sub clear_sequence_variables {
- undef($top_map);
- undef(@Sequences);
- undef(@Assessments);
+sub section_and_enrollment_description {
+ my @sections = &Apache::lonstatistics::get_selected_sections();
+ my $description = &mt('Unable to determine section and enrollment');
+ if (scalar(@sections) == 1 && $sections[0] ne 'all') {
+ $description = &mt('Section [_1]. [_2] enrollment status',
+ $sections[0],$ENV{'form.Status'});
+ } elsif (scalar(@sections) && $sections[0] eq 'all') {
+ $description = &mt('All sections. [_1] enrollment status',
+ $ENV{'form.Status'});
+ } elsif (scalar(@sections)) {
+ my $lastsection = pop(@sections);
+ $description = &mt('Sections [_1] and [_2]. [_3] enrollment status',
+ join(', ',@sections),$lastsection,
+ $ENV{'form.Status'});
+ }
+ return $description;
}
#######################################################
@@ -435,61 +386,37 @@ sub clear_sequence_variables {
=pod
-=item &SetSelectedMaps($elementname)
+=item get_students
-Sets the @SelectedMaps array from $ENV{'form.'.$elementname};
+Returns a list of the selected students
=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');
+sub get_students {
+ if (! @Students) {
+ &PrepareClasslist()
}
+ return @Students;
}
-
#######################################################
#######################################################
=pod
-=item &Sequences_with_Assess()
+=item ¤t_student()
-Returns an array containing the subset of @Sequences which contain
-assessments.
+Returns a pointer to a hash containing data about the currently
+selected student.
=cut
#######################################################
#######################################################
-sub Sequences_with_Assess {
- my ($mode) = @_;
- $mode = 'selected' if (! defined($mode));
- my @Sequences_to_Show;
- foreach my $sequence (@Sequences) {
- next if ($sequence->{'num_assess'} < 1);
- if ($mode eq 'all') {
- push (@Sequences_to_Show,$sequence);
- } elsif ($mode eq 'selected') {
- foreach my $map_symb (@SelectedMaps) {
- if ($sequence->{'symb'} eq $map_symb || $map_symb eq 'all'){
- push (@Sequences_to_Show,$sequence);
- last; # Only put it in once
- }
- }
- }
-
- }
- return @Sequences_to_Show;
+sub current_student {
+ return $curr_student;
}
#######################################################
@@ -497,26 +424,17 @@ sub Sequences_with_Assess {
=pod
-=item &PrepareCourseData($r)
+=item &previous_student()
+
+Returns a pointer to a hash containing data about the student prior
+in the list of students. Or something.
=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');
- return;
+sub previous_student {
+ return $prev_student;
}
#######################################################
@@ -524,60 +442,17 @@ sub PrepareCourseData {
=pod
-=item &log_sequence($sequence,$recursive,$padding)
+=item &next_student()
-Write data about the sequence to a logfile. If $recursive is not
-undef the data is written recursively. $padding is used for recursive
-calls.
+Returns a pointer to a hash containing data about the next student
+to be viewed.
=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;
+sub next_student {
+ return $next_student;
}
##############################################
@@ -643,12 +518,103 @@ sub StudentDataSelect {
return $Str;
}
+#######################################################
+#######################################################
+
+=pod
+
+=item &get_selected_maps($elementname)
+
+Input: Name of the <select> form element used to specify the maps.
+
+Returns: Array of symbs of selected maps or the description 'all'.
+ If form.$elementname does not exist, 'all' is returned.
+
+=cut
+
+#######################################################
+#######################################################
+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});
+ }
+ } else {
+ @selected_maps = ('all');
+ }
+ foreach my $map (@selected_maps) {
+ if ($map eq 'all') {
+ @selected_maps = ('all');
+ last;
+ }
+ }
+ return @selected_maps;
+}
+
+
+#######################################################
+#######################################################
+
+=pod
+
+=item &selected_sequences_with_assessments
+
+Retrieve the sequences which were selected by the user to show.
+
+Input: $mode: scalar. Either 'selected' or 'all'. If not specified,
+ 'selected' is used.
+
+Returns: an array containing a navmap object and navmap resources,
+ or an array containing a scalar with an error message.
+
+=cut
+
+#######################################################
+#######################################################
+sub selected_sequences_with_assessments {
+ my ($mode) = @_;
+ $mode = 'selected' if (! defined($mode));
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ if (!defined($navmap)) {
+ return ('Can not open Coursemap');
+ }
+ #
+ my @sequences = $navmap->retrieveResources(undef,
+ 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)){
+ push(@sequences_with_assessments,$sequence);
+ }
+ }
+ #
+ my @sequences_to_show;
+ foreach my $sequence (@sequences_with_assessments) {
+ if ($mode eq 'all') {
+ push (@sequences_to_show,$sequence);
+ } elsif ($mode eq 'selected') {
+ foreach my $map_symb (&get_selected_maps('Maps')) {
+ if ($sequence->symb eq $map_symb || $map_symb eq 'all'){
+ push (@sequences_to_show,$sequence);
+ last; # Only put it in once
+ }
+ }
+ }
+
+ }
+ return $navmap,@sequences_to_show;
+}
+
##############################################
##############################################
=pod
-=item &MapSelect($elementname,$status,$numvisible,$restriction)
+=item &map_select($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.
@@ -662,69 +628,56 @@ If the top sequence is selected, the val
=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)=@_;
+sub map_select {
+ my ($elementname,$status,$numvisible)=@_;
if ($numvisible < 1) {
return;
}
#
# Set up array of selected items
- &SetSelectedMaps($elementname);
- #
- # Set up the restriction call
- if (! defined($restriction)) {
- $restriction = sub { 1; };
- }
+ my @selected_maps = &get_selected_maps($elementname);
#
# Build the form element
- my $Str = "\n";
- $Str .= '<select name="'.$elementname.'" ';
+ my $form = "\n";
+ $form .= '<select name="'.$elementname.'" ';
if ($status ne 'single') {
- $Str .= 'multiple="true" ';
- }
- $Str .= 'size="'.$numvisible.'" >'."\n";
- #
- # Deal with 'all'
- foreach (@SelectedMaps) {
- if ($_ eq 'all') {
- @SelectedMaps = ('all');
- last;
- }
+ $form .= 'multiple="true" ';
}
+ $form .= 'size="'.$numvisible.'" >'."\n";
#
# Put in option for 'all'
- $Str .= ' <option value="all" ';
- foreach (@SelectedMaps) {
- if ($_ eq 'all') {
- $Str .= 'selected ';
- last;
- }
+ $form .= ' <option value="all" ';
+ if ($selected_maps[0] eq 'all') {
+ $form .= 'selected ';
}
- $Str .= ">all</option>\n";
+ $form .= ">all</option>\n";
#
# Loop through the sequences
- foreach my $seq (@Sequences) {
- next if (! $restriction->($seq));
- $Str .= ' <option value="'.$seq->{'symb'}.'" ';
- foreach (@SelectedMaps) {
- if ($seq->{'symb'} eq $_) {
- $Str .= 'selected ';
+ my @sequences = &selected_sequences_with_assessments('all');
+ my $navmap;
+ if (!ref($sequences[0])) {
+ return $sequences[0];
+ } else {
+ $navmap = shift(@sequences);
+ }
+ foreach my $seq (@sequences){
+ $form .= ' <option value="'.$seq->symb.'" ';
+ foreach (@selected_maps) {
+ if ($seq->symb eq $_) {
+ $form .= 'selected ';
last;
}
}
- $Str .= '>'.$seq->{'title'}."</option>\n";
+ $form .= '>'.$seq->compTitle."</option>\n";
}
- $Str .= "</select>\n";
- return $Str;
+ $form .= "</select>\n";
+ return $form;
}
##############################################
@@ -737,7 +690,7 @@ sub MapSelect {
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
@@ -774,7 +727,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;
@@ -786,157 +739,6 @@ sub SectionSelect {
return $Str;
}
-#######################################################
-#######################################################
-
-=pod
-
-=item &CreateAndParseOutputSelector()
-
-Construct a selection list of options for output and parse output selections.
-
-=cut
-
-#######################################################
-#######################################################
-sub OutputDescriptions {
- my (@OutputOptions) = @_;
- my $Str = '';
- $Str .= "<h2>Output Modes</h2>\n";
- $Str .= "<dl>\n";
- foreach my $outputmode (@OutputOptions) {
- $Str .=" <dt>".$outputmode->{'name'}."</dt>\n";
- $Str .=" <dd>".$outputmode->{'description'}."</dd>\n";
- }
- $Str .= "</dl>\n";
- return $Str;
-}
-
-sub CreateAndParseOutputSelector {
- my ($elementname,$default,@OutputOptions) = @_;
- my $output_mode;
- my $show;
- my $Str = '';
- #
- # Format for output options is 'mode, restrictions';
- my $selected = $default;
- if (exists($ENV{'form.'.$elementname})) {
- if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
- $selected = $ENV{'form.'.$elementname}->[0];
- } else {
- $selected = $ENV{'form.'.$elementname};
- }
- }
- #
- # Set package variables describing output mode
- $output_mode = 'html';
- $show = 'all';
- foreach my $option (@OutputOptions) {
- next if ($option->{'value'} ne $selected);
- $output_mode = $option->{'mode'};
- $show = $option->{'show'};
- }
- #
- # Build the form element
- $Str = qq/<select size="5" name="$elementname">/;
- foreach my $option (@OutputOptions) {
- if (exists($option->{'special'}) &&
- $option->{'special'} =~ /do not show/) {
- next;
- }
- $Str .= "\n".' <option value="'.$option->{'value'}.'"';
- $Str .= " selected " if ($option->{'value'} eq $selected);
- $Str .= ">".&mt($option->{'name'})."<\/option>";
- }
- $Str .= "\n</select>";
- return ($Str,$output_mode,$show);
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &Gather_Student_Data()
-
-Ensures all student data is up to date.
-
-=cut
-
-###############################################
-###############################################
-sub Gather_Student_Data {
- my ($r) = @_;
- my $c = $r->connection();
- #
- &Apache::loncoursedata::clear_internal_caches();
- #
- my @Sequences = &Apache::lonstatistics::Sequences_with_Assess();
- #
- my @Students = @Apache::lonstatistics::Students;
- #
- # Open the progress window
- my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
- ($r,'Statistics Compilation Status',
- 'Statistics Compilation Progress', scalar(@Students));
- #
- while (my $student = shift @Students) {
- return if ($c->aborted());
- my ($status,undef) = &Apache::loncoursedata::ensure_current_data
- ($student->{'username'},$student->{'domain'},
- $ENV{'request.course.id'});
- &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
- &mt('last student'));
- }
- &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
- $r->rflush();
-}
-
-###############################################
-###############################################
-
-=pod
-
-=item &Gather_Full_Student_Data()
-
-Ensures all student data is up to date.
-
-=cut
-
-###############################################
-###############################################
-sub Gather_Full_Student_Data {
- my ($r,$formname,$inputname) = @_;
- my $status_type;
- if (defined($formname)) {
- $status_type = 'inline';
- } else {
- $status_type = 'popup';
- }
- my $c = $r->connection();
- #
- &Apache::loncoursedata::clear_internal_caches();
- #
- my @Students = @Apache::lonstatistics::Students;
- #
- # Open the progress window
- my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
- ($r,&mt('Student Data Compilation Status'),
- &mt('Student Data Compilation Progress'), scalar(@Students),
- $status_type,undef,$formname,$inputname);
- #
- while (my $student = shift @Students) {
- return if ($c->aborted());
- my ($status,undef) = &Apache::loncoursedata::ensure_current_full_data
- ($student->{'username'},$student->{'domain'},
- $ENV{'request.course.id'});
- &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
- &mt('last student'));
- }
- &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
- $r->rflush();
-}
-
##################################################
##################################################
sub DisplayClasslist {
@@ -970,8 +772,9 @@ 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 ($selected_sections[0] eq 'all') {
if (lc($ENV{'form.Status'}) eq 'any') {
$Str .= '<h2>'.
&mt('There are no students in the course.').
@@ -1163,7 +966,8 @@ sub handler {
td.essay { border: 1px solid gray; }
</style>
ENDSTYLE
- $r->print('<html><head><title>'.
+ my $html=&Apache::lonxml::xmlbegin();
+ $r->print($html.'<head><title>'.
&mt('Course Statistics and Charts').
'</title>'.$style.
"</head>\n".
@@ -1213,9 +1017,6 @@ ENDSTYLE
#
my $GoToPage = $ENV{'form.reportSelected'};
#
- # Set up the statistics and chart environment
- &PrepareCourseData($r);
- #
$r->print('<input type="hidden" name="reportSelected" value="'.
$GoToPage.'">');
if($GoToPage eq 'activitylog') {