--- loncom/interface/lonstatistics.pm 2005/03/15 21:22:38 1.120 +++ loncom/interface/lonstatistics.pm 2006/05/01 05:39:44 1.130 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstatistics.pm,v 1.120 2005/03/15 21:22:38 matthew Exp $ +# $Id: lonstatistics.pm,v 1.130 2006/05/01 05:39:44 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -49,13 +49,14 @@ use Apache::Constants qw(:common :http); use vars qw( @FullClasslist @Students - @Sections + @Sections + @Groups %StudentData @StudentDataOrder @SelectedStudentData $enrollment_status); -use Apache::lonnet(); +use Apache::lonnet; use Apache::lonhomework; use Apache::loncommon; use Apache::loncoursedata; @@ -73,6 +74,7 @@ use Apache::lonstudentassessment(); use Apache::lonpercentage; use Apache::lonstudentsubmissions(); use Apache::lonsurveyreports(); +use Apache::longradinganalysis(); ####################################################### ####################################################### @@ -87,6 +89,8 @@ use Apache::lonsurveyreports(); =item @Sections The sections available in this class +=item @Groups The groups available in the class + =item $curr_student The student currently being examined =item $prev_student The student previous in the classlist @@ -123,6 +127,8 @@ undef the following package variables: =item @Sections +=item @Groups + =item %StudentData =item @StudentDataOrder @@ -145,6 +151,7 @@ sub clear_classlist_variables { undef(@FullClasslist); undef(@Students); undef(@Sections); + undef(@Groups); undef(%StudentData); undef(@SelectedStudentData); undef($curr_student); @@ -170,6 +177,8 @@ the following package variables: =item @Sections +=item @Groups + =item %StudentData =item @SelectedStudentData @@ -194,20 +203,21 @@ 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); + 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'}); + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); } # # Set up %StudentData - @StudentDataOrder = qw/fullname username domain id section status comments/; + @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)); @@ -217,8 +227,18 @@ 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'})); # + # Get groupmembership + my (%curr_groups,$classgroups,$studentgroups); + my $numgroups = &Apache::loncommon::coursegroups(\%curr_groups,$cdom,$cnum); + if ($numgroups) { + ($classgroups,$studentgroups) = + &Apache::loncoursedata::get_group_memberships($classlist, + $cdom,$cnum); + } + my $now = time; + # Process the classlist while (my ($student,$student_data) = each (%$classlist)) { my $studenthash = (); @@ -233,6 +253,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 @@ -250,32 +280,56 @@ sub PrepareClasslist { (($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); 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) || @@ -297,12 +351,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'); } @@ -330,14 +381,8 @@ Returns an array of the selected section ####################################################### ####################################################### 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'}); - } - } + my @selected_sections = + &Apache::loncommon::get_env_multiple('form.Section'); @selected_sections = ('all') if (! @selected_sections); foreach (@selected_sections) { if ($_ eq 'all') { @@ -346,37 +391,73 @@ sub get_selected_sections { } # # Deal with instructors with restricted section access - if ($ENV{'request.course.sec'} !~ /^\s*$/) { - @selected_sections = ($ENV{'request.course.sec'}); + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); } return @selected_sections; } ####################################################### ####################################################### - + +=pod + +=item get_selected_groups + +Returns an array of the selected groups + +=cut + +####################################################### +####################################################### +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 §ion_and_enrollment_description +Returns a string describing the currently selected section(s), group(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 = &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'}); + my @groups = &Apache::lonstatistics::get_selected_groups(); + my $description; + if ($mode eq 'localized') { + $description = &mt('Unable to determine section, groups and enrollment'); + } elsif ($mode eq 'plaintext') { + $description = 'Unable to determine section, groups and enrollment'; + } 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(' [_1] enrollment status.',$env{'form.Status'}); + } elsif ($mode eq 'plaintext') { + $description .= ' '.$env{'form.Status'}.' enrollment status.'; } return $description; } @@ -384,6 +465,47 @@ sub section_and_enrollment_description { ####################################################### ####################################################### +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('[_1] [_2].',$phrases{$type}{single},$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('[_1].',$phrases{$type}{all}); + } elsif ($mode eq 'plaintext') { + $text = $phrases{$type}{all}.'.'; + } + } elsif (scalar(@items)) { + my $lastitem = pop(@items); + if ($mode eq 'localized') { + $text = &mt('[_1] [_2] and [_3].',$phrases{$type}{plural}, + join(', ',@items),$lastitem); + } elsif ($mode eq 'plaintext') { + $text = $phrases{$type}{plural}.' '.join(', ',@items).' and '. + $lastitem.'.'; + } + } + return $text; +} + + =pod =item get_students @@ -536,16 +658,9 @@ 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}); - } - } else { - @selected_maps = ('all'); - } + 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'); @@ -739,6 +854,65 @@ sub SectionSelect { return $Str; } +############################################## +############################################## + +=pod + +=item &GroupSelect($elementname,$status,$numvisible) + +Returns html for a selection box allowing the user to choose one (or more) +of the groups in the course. + +Uses the package variables @Groups +=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 GroupSelect { + my ($elementname,$status,$numvisible)=@_; + if ($numvisible < 1) { + return; + } + # + # Make sure we have the data we need to continue + if (! @Groups) { + &PrepareClasslist(); + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; +} + + ################################################## ################################################## sub DisplayClasslist { @@ -752,12 +926,16 @@ sub DisplayClasslist { $Str .= '