--- loncom/interface/lonstatistics.pm 2003/02/25 20:47:47 1.60 +++ loncom/interface/lonstatistics.pm 2010/05/03 16:41:51 1.152 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstatistics.pm,v 1.60 2003/02/25 20:47:47 matthew Exp $ +# $Id: lonstatistics.pm,v 1.152 2010/05/03 16:41:51 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,199 +28,130 @@ # ### -=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::lonproblemstatistics; - use Apache::lonstudentassessment; - use Apache::lonpercentage; - use GDBM_File; - -=over 4 - -=cut package Apache::lonstatistics; use strict; use Apache::Constants qw(:common :http); -use Apache::lonnet(); +use vars qw( + @FullClasslist + @Students + @Sections + @Groups + %StudentData + @StudentDataOrder + @SelectedStudentData + $enrollment_status); + +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::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 GDBM_File; - -use vars qw/@FullClasslist @Students @Sections @SelectedSections - $curr_student $prev_student $next_student - $top_map @Sequences @Assessments /; - -####################################################### -####################################################### - -=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 LONCAPA; -=item $prev_student The student previous in the classlist - -=item $next_student The student next in the classlist - -=over - -=cut - -####################################################### -####################################################### # # Classlist variables # -my @FullClasslist; -my @Students; -my @Sections; -my @SelectedSections; 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 $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); undef($prev_student); 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 $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 $r = shift; 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'}; - # Remove the empty sections - for (my $i=0; $i<=$#SelectedSections; $i++) { - if ($SelectedSections[$i] =~ /^\s*$/) { - splice(@SelectedSections,$i,1); - } - } - } else { - if ($ENV{'form.Section'} !~ /^\s*$/) { - @SelectedSections = ($ENV{'form.Section'}); - } - } + 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*$/) { + @selected_sections = ($env{'request.course.sec'}); } - @SelectedSections = ('any') if (! @SelectedSections); # + # Set up %StudentData + @StudentDataOrder = qw/fullname username domain id section status groups comments/; + foreach my $field (@StudentDataOrder) { + $StudentData{$field}->{'title'} = &mt($field); + $StudentData{$field}->{'base_width'} = length(&mt($field)); + $StudentData{$field}->{'width'} = + $StudentData{$field}->{'base_width'}; + } + # + # get the status requested + $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 = (); 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 = length($student_data->[$i]); + if ($StudentData{$field}->{'width'} < $length) { + $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); # @@ -233,29 +164,66 @@ sub PrepareClasslist { $Sections{$section}++; # # Only put in the list those students we are interested in - foreach my $sect (@SelectedSections) { - if (($sect eq 'any') || ($section eq $sect)) { - push (@Students,$studenthash); - last; + foreach my $sect (@selected_sections) { + if ( (($sect eq 'all') || + ($section eq $sect)) && + (($studenthash->{'status'} eq $enrollment_status) || + ($enrollment_status eq 'Any')) + ){ + 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 - @Sections = sort {$a cmp $b} keys(%Sections); + if ($env{'request.course.sec'} !~ /^\s*$/) { + @Sections = ($env{'request.course.sec'}); + } else { + @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.... - if (exists($ENV{'form.StudentAssessmentStudent'})) { + $curr_student = undef; + if (exists($env{'form.SelectedStudent'})) { my ($current_uname,$current_dom) = - split(':',$ENV{'form.StudentAssessmentStudent'}); + split(':',$env{'form.SelectedStudent'}); my $i; for ($i = 0; $i<=$#Students; $i++) { next if (($Students[$i]->{'username'} ne $current_uname) || @@ -263,231 +231,335 @@ sub PrepareClasslist { $curr_student = $Students[$i]; last; # If we get here, we have our student. } - if ($i == 0) { - $prev_student = 'none'; - } else { - $prev_student = $Students[$i-1]; + if (defined($curr_student)) { + if ($i == 0) { + $prev_student = undef; + } else { + $prev_student = $Students[$i-1]; + } + if ($i == $#Students) { + $next_student = undef; + } else { + $next_student = $Students[$i+1]; + } } - if ($i == $#Students) { - $next_student = 'none'; - } else { - $next_student = $Students[$i+1]; + } + # + if (exists($env{'form.StudentData'})) { + @SelectedStudentData = + &Apache::loncommon::get_env_multiple('form.StudentData'); + } else { + @SelectedStudentData = ('username'); + } + foreach (@SelectedStudentData) { + if ($_ eq 'all') { + @SelectedStudentData = ('all'); + last; } } + # + return; } -####################################################### -####################################################### -# -# Course Sequences variables -# -my $top_map; -my @Sequences; -my @Assessments; -####################################################### -####################################################### - -=pod - -=item &clear_sequence_variables() +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; +} -=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 +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 { + $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; +} -=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 'HASH'); -=pod - - ## - ## Debugging code - ## - foreach my $s (@Sequences) { - next if ($s->{'title'} ne 'Bioenergetics: Enzyme Regulation'); - &Apache::lonnet::logthis('-----------------------------------'); - &Apache::lonnet::logthis('title = '.$s->{'title'}); - &Apache::lonnet::logthis('symb = '.$s->{'symb'}); - &Apache::lonnet::logthis('num_assess = '.$s->{'num_assess'}); - foreach my $a (@{$s->{'contents'}}) { - &Apache::lonnet::logthis(' --------------------------------'); - &Apache::lonnet::logthis(' title = '.$a->{'title'}); - &Apache::lonnet::logthis(' symb = '.$a->{'symb'}); +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 $text; +} -=cut - return; +sub get_students { + if (! @Students) { + &PrepareClasslist() + } + return @Students; } -############################################## -############################################## - -=pod -=item &MapSelect($elementname,$status,$numvisible,$selected,$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 current_student { + return $curr_student; +} -=over 4 -=item $elementname The name of the HTML form element -=item $status 'multiple' or 'single' selection box +sub previous_student { + return $prev_student; +} -=item $numvisible The number of options to be visible -=item $selected Array ref to the names of the already selected maps. -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. +sub next_student { + return $next_student; +} -=back -=cut -############################################## -############################################## -sub MapSelect { - my ($elementname,$status,$numvisible,$selected,$restriction)=@_; +sub StudentDataSelect { + my ($elementname,$status,$numvisible)=@_; if ($numvisible < 1) { return; } # - # Set up array of selected items - my @Selected; - if (! defined($selected)) { - if (exists($ENV{'form.'.$elementname})) { - if (ref($ENV{'form.'.$elementname})) { - @Selected = @$ENV{'form.'.$elementname}; - } else { - @Selected = ($ENV{'form.'.$elementname}); - } - } else { - @Selected = (); - } - } else { - if (ref($selected)) { - @Selected = @$selected; - } else { - @Selected = ($selected); - } - } - # - # 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) +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; +} -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 +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 $numvisible The number of options to be visible + 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 + } + } + } -=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. + } + return $navmap,@sequences_to_show; +} -=item $restriction Code reference to subroutine which returns true or -false. The code must expect a reference to a sequence data structure. -=back +sub map_select { + my ($elementname,$status,$numvisible)=@_; + if ($numvisible < 1) { + return; + } + # + # Set up array of selected items + my @selected_maps = &get_selected_maps($elementname); + # + # Build the form element + my $form = "\n"; + $form .= '\n"; + return $form; +} -=cut -############################################## -############################################## sub SectionSelect { my ($elementname,$status,$numvisible)=@_; if ($numvisible < 1) { return; } # + # Make sure we have the data we need to continue + if (! @Sections) { + &PrepareClasslist() + } + # # Build the form element my $Str = "\n"; $Str .= ''."\n"; + # + # Loop through the groups + foreach my $s (@Groups) { + $Str .= '