--- loncom/interface/lonstatistics.pm 2004/01/15 03:18:19 1.93 +++ loncom/interface/lonstatistics.pm 2013/03/18 01:28:27 1.156.2.2 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstatistics.pm,v 1.93 2004/01/15 03:18:19 www Exp $ +# $Id: lonstatistics.pm,v 1.156.2.2 2013/03/18 01:28:27 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,34 +28,7 @@ # ### -=pod - -=head1 NAME - -lonstatistics - -=head1 SYNOPSIS - -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::lonsubmissiontimeanalysis; - use Apache::lonproblemstatistics; - use Apache::lonstudentassessment; - use Apache::lonpercentage; - use Apache::lonmysql; -=over 4 -=cut package Apache::lonstatistics; @@ -64,55 +37,36 @@ use Apache::Constants qw(:common :http); use vars qw( @FullClasslist @Students - @Sections - @SelectedSections + @Sections + @Groups %StudentData @StudentDataOrder @SelectedStudentData - $top_map - @Sequences - @SelectedMaps - @Assessments); + $enrollment_status); -use Apache::lonnet(); +use Apache::lonnet; use Apache::lonhomework; use Apache::loncommon; use Apache::loncoursedata; use Apache::lonhtmlcommon; +use Apache::lonmysql; +use Apache::lonlocal; +use Apache::longroup; +use Time::HiRes; +# +# Statistics Packages use Apache::lonproblemanalysis(); use Apache::lonsubmissiontimeanalysis(); +use Apache::loncorrectproblemplot(); use Apache::lonproblemstatistics(); use Apache::lonstudentassessment(); use Apache::lonpercentage; -use Apache::lonmysql; -use Apache::lonlocal; -use Time::HiRes; - -####################################################### -####################################################### - -=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 +use Apache::lonstudentsubmissions(); +use Apache::lonsurveyreports(); +use Apache::longradinganalysis(); +use Apache::lonquickgrades(); +use LONCAPA; -=item $prev_student The student previous in the classlist - -=item $next_student The student next in the classlist - -=over - -=cut - -####################################################### -####################################################### # # Classlist variables # @@ -120,48 +74,12 @@ my $curr_student; my $prev_student; my $next_student; -####################################################### -####################################################### - -=pod - -=item &clear_classlist_variables() - -undef the following package variables: - -=over - -=item @FullClasslist -=item @Students - -=item @Sections - -=item @SelectedSections - -=item %StudentData - -=item @StudentDataOrder - -=item @SelectedStudentData - -=item $curr_student - -=item $prev_student - -=item $next_student - -=back - -=cut - -####################################################### -####################################################### sub clear_classlist_variables { undef(@FullClasslist); undef(@Students); undef(@Sections); - undef(@SelectedSections); + undef(@Groups); undef(%StudentData); undef(@SelectedStudentData); undef($curr_student); @@ -169,87 +87,49 @@ sub clear_classlist_variables { undef($next_student); } -####################################################### -####################################################### - -=pod -=item &PrepareClasslist() - -Build up the classlist information. The classlist information is kept in -the following package variables: - -=over - -=item @FullClasslist - -=item @Students - -=item @Sections - -=item @SelectedSections - -=item %StudentData - -=item @SelectedStudentData - -=item $curr_student - -=item $prev_student - -=item $next_student - -=back - -$curr_student, $prev_student, and $next_student may not be defined, depending -upon the calling context. - -=cut - -####################################################### -####################################################### sub PrepareClasslist { my %Sections; &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(); + my @selected_groups = &get_selected_groups(); # # 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 - @StudentDataOrder = qw/fullname username domain id section status/; + @StudentDataOrder = qw/fullname username domain id section status groups comments/; foreach my $field (@StudentDataOrder) { - $StudentData{$field}->{'title'} = $field; - $StudentData{$field}->{'base_width'} = length($field); + $StudentData{$field}->{'title'} = &mt($field); + $StudentData{$field}->{'base_width'} = length(&mt($field)); $StudentData{$field}->{'width'} = $StudentData{$field}->{'base_width'}; } # # get the status requested - my $requested_status = 'Active'; - $requested_status = $ENV{'form.Status'} if (exists($ENV{'form.Status'})); + $enrollment_status = 'Active'; + $enrollment_status = $env{'form.Status'} if (exists($env{'form.Status'})); # + # Get groupmembership + my ($classgroups,$studentgroups); + my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum); + if (%curr_groups) { + ($classgroups,$studentgroups) = + &Apache::loncoursedata::get_group_memberships($classlist, + $field_names, + $cdom,$cnum); + } + my $now = time; + # Process the classlist while (my ($student,$student_data) = each (%$classlist)) { my $studenthash = (); @@ -264,6 +144,16 @@ sub PrepareClasslist { $StudentData{$field}->{'width'} = $length; } } + my @studentsgroups = &Apache::loncoursedata::get_students_groups + ($student,$enrollment_status, + $classgroups); + if (@studentsgroups) { + $studenthash->{'groups'} = join(', ',@studentsgroups); + $studenthash->{'groupref'} = \@studentsgroups; + } else { + $studenthash->{'groups'} = 'none'; + $studenthash->{'groupref'} = []; + } push (@FullClasslist,$studenthash); # # Build up a list of sections @@ -275,38 +165,66 @@ 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 $requested_status) || - ($requested_status eq 'Any')) + (($studenthash->{'status'} eq $enrollment_status) || + ($enrollment_status eq 'Any')) ){ - push (@Students,$studenthash); - last; + my $groupcheck = 0; + if (grep(/^all$/,@selected_groups)) { + push(@Students,$studenthash); + last; + } elsif (grep(/^none$/,@selected_groups)) { + if ($studenthash->{'groups'} eq 'none') { + push(@Students,$studenthash); + last; + } + } else { + foreach my $group (@selected_groups) { + if (grep(/^$group$/,@studentsgroups)) { + push(@Students,$studenthash); + $groupcheck = 1; + last; + } + } + if ($groupcheck) { + last; + } + } } } } # # 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); + @Sections = sort { + if ($a == $a && $b == $b ) { return $a <=> $b; } + return $a cmp $b; + } keys(%Sections); + unshift(@Sections,'all'); # Put 'all' at the front of the list } + # Sort the groups + @Groups = sort {$a cmp $b} keys(%{$studentgroups}); + unshift(@Groups,'all'); # Put 'all' at the front of the list + # # 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) || @@ -328,12 +246,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'); } @@ -348,276 +263,134 @@ sub PrepareClasslist { } -####################################################### -####################################################### - -=pod - -=item get_students - -Returns a list of the selected students - -=cut - -####################################################### -####################################################### -sub get_students { - if (! @Students) { - &PrepareClasslist() +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'); + } } - 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; + # + # Deal with instructors with restricted section access + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); + } + return @selected_sections; } -####################################################### -####################################################### - -=pod - -=item &clear_sequence_variables() - -=cut -####################################################### -####################################################### -sub clear_sequence_variables { - undef($top_map); - undef(@Sequences); - undef(@Assessments); +sub get_selected_groups { + my @selected_groups = + &Apache::loncommon::get_env_multiple('form.Group'); + @selected_groups = ('all') if (! @selected_groups); + foreach my $grp (@selected_groups) { + if ($grp eq 'all') { + @selected_groups = ('all'); + last; + } + } + return @selected_groups; } + -####################################################### -####################################################### - -=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}); - } +sub section_and_enrollment_description { + my ($mode) = @_; + if (! defined($mode)) { $mode = 'localized'; } + my @sections = &Apache::lonstatistics::get_selected_sections(); + my @groups = &Apache::lonstatistics::get_selected_groups(); + my $description; + if ($mode eq 'localized') { + $description = &mt('Unable to determine section, groups and access status'); + } elsif ($mode eq 'plaintext') { + $description = 'Unable to determine section, groups and access status'; } else { - @SelectedMaps = ('all'); + $description = 'Bad parameter passed to lonstatistics::section_and_enrollment_description'; + &Apache::lonnet::logthis($description); } + $description = §ion_or_group_text($mode,'section',@sections). + ' '.§ion_or_group_text($mode,'group',@groups); + if ($mode eq 'localized') { + $description .= ' '.&mt($env{'form.Status'}.' access status.'); + } elsif ($mode eq 'plaintext') { + $description .= ' '.$env{'form.Status'}.' access status.'; + } + return $description; } -####################################################### -####################################################### - -=pod - -=item &Sequences_with_Assess() - -Returns an array containing the subset of @Sequences which contain -assessments. -=cut -####################################################### -####################################################### -sub Sequences_with_Assess { - my @Sequences_to_Show; - foreach my $map_symb (@SelectedMaps) { - foreach my $sequence (@Sequences) { - next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all'); - next if ($sequence->{'num_assess'} < 1); - push (@Sequences_to_Show,$sequence); +sub section_or_group_text { + my ($mode,$type,@items) = @_; + my $text; + my %phrases = (); + %{$phrases{'section'}} = ( + single => 'Section', + all => 'All sections', + plural => 'Sections', + ); + %{$phrases{'group'}} = ( + single => 'Group', + all => 'All groups', + plural => 'Groups', + ); + if (scalar(@items) == 1 && $items[0] ne 'all') { + if ($mode eq 'localized') { + $text = &mt($phrases{$type}{single}.' [_1].',$items[0]); + } elsif ($mode eq 'plaintext') { + $text = $phrases{$type}{single}.' '.$items[0].'.'; + + } + } elsif (scalar(@items) && $items[0] eq 'all') { + if ($mode eq 'localized') { + $text = &mt($phrases{$type}{all}.'.'); + } elsif ($mode eq 'plaintext') { + $text = $phrases{$type}{all}.'.'; + } + } elsif (scalar(@items)) { + my $lastitem = pop(@items); + if ($mode eq 'localized') { + $text = &mt($phrases{$type}{plural}.' [_1] and [_2].', + join(', ',@items),$lastitem); + } elsif ($mode eq 'plaintext') { + $text = $phrases{$type}{plural}.' '.join(', ',@items).' and '. + $lastitem.'.'; } } - return @Sequences_to_Show; + return $text; } -####################################################### -####################################################### -=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 = length($seq->{'title'}); - my $num_parts = $seq->{'num_assess_parts'}; - # - # Use 3 digits for each the sum and total, which means 7 total... - my $num_col = $num_parts+7; - if ($num_col < $name_length) { - $num_col = $name_length; - } - $seq->{'base_width'} = $name_length; - $seq->{'width'} = $num_col; +sub get_students { + if (! @Students) { + &PrepareClasslist() } - return; + return @Students; } -####################################################### -####################################################### - -=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; +sub current_student { + return $curr_student; } -############################################## -############################################## - -=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 +sub previous_student { + return $prev_student; +} -=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 +sub next_student { + return $next_student; +} -=back -=cut -############################################## -############################################## sub StudentDataSelect { my ($elementname,$status,$numvisible)=@_; if ($numvisible < 1) { @@ -628,144 +401,141 @@ sub StudentDataSelect { 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. +sub get_selected_maps { + my ($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; + } + } + return @selected_maps; +} -=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 +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 $toplevelseq = $navmap->getById('0.0'); + if (!grep(/^\Q$toplevelseq\E$/,@sequences)) { + unshift(@sequences,$toplevelseq); + } -=item $restriction Code reference to subroutine which returns true or -false. The code must expect a reference to a sequence data structure. + my @sequences_with_assessments; + foreach my $sequence (@sequences) { + if ($navmap->hasResource($sequence,sub { shift->is_problem(); },0,1)){ + 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 + } + } + } -=back + } + return $navmap,@sequences_to_show; +} -=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 .= '\n"; - return $Str; + $form .= "\n"; + return $form; } -############################################## -############################################## - -=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. - -Uses the package variables @Sections and @SelectedSections -=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 SectionSelect { my ($elementname,$status,$numvisible)=@_; if ($numvisible < 1) { @@ -781,16 +551,16 @@ sub SectionSelect { my $Str = "\n"; $Str .= '/; - foreach my $option (@OutputOptions) { - if (exists($option->{'special'}) && - $option->{'special'} =~ /do not show/) { - next; - } - $Str .= "\n".'