--- loncom/interface/lonstatistics.pm 2003/03/03 19:17:51 1.63 +++ 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.63 2003/03/03 19:17:51 matthew Exp $ +# $Id: lonstatistics.pm,v 1.130 2006/05/01 05:39:44 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -38,21 +38,6 @@ lonstatistics 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 @@ -64,27 +49,32 @@ 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 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 Apache::lonstudentsubmissions(); +use Apache::lonsurveyreports(); +use Apache::longradinganalysis(); ####################################################### ####################################################### @@ -99,6 +89,8 @@ use GDBM_File; =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 @@ -135,7 +127,7 @@ undef the following package variables: =item @Sections -=item @SelectedSections +=item @Groups =item %StudentData @@ -159,7 +151,7 @@ sub clear_classlist_variables { undef(@FullClasslist); undef(@Students); undef(@Sections); - undef(@SelectedSections); + undef(@Groups); undef(%StudentData); undef(@SelectedStudentData); undef($curr_student); @@ -185,7 +177,7 @@ the following package variables: =item @Sections -=item @SelectedSections +=item @Groups =item %StudentData @@ -207,40 +199,46 @@ upon the calling context. ####################################################### ####################################################### 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'}}; - } 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*$/) { + @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 + $enrollment_status = 'Active'; + $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 = (); @@ -255,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 @@ -266,29 +274,62 @@ sub PrepareClasslist { $Sections{$section}++; # # Only put in the list those students we are interested in - foreach my $sect (@SelectedSections) { - if (($sect eq 'all') || ($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); - unshift(@Sections,'all'); # Put 'all' at the front of the list + 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.... - 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) || @@ -296,26 +337,25 @@ 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 ($i == $#Students) { - $next_student = 'none'; - } else { - $next_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 (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 = ('fullname'); + @SelectedStudentData = ('username'); } foreach (@SelectedStudentData) { if ($_ eq 'all') { @@ -332,82 +372,155 @@ sub PrepareClasslist { =pod -=item ¤t_student() +=item get_selected_sections -Returns a pointer to a hash containing data about the currently -selected student. +Returns an array of the selected sections =cut ####################################################### ####################################################### -sub current_student { - if (defined($curr_student)) { - return $curr_student; - } else { - return 'All Students'; +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 &previous_student() - -Returns a pointer to a hash containing data about the student prior -in the list of students. Or something. - + +=item get_selected_groups + +Returns an array of the selected groups + =cut - + ####################################################### ####################################################### -sub previous_student { - if (defined($prev_student)) { - return $prev_student; - } else { - return 'No Student Selected'; +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 &next_student() +=item §ion_and_enrollment_description -Returns a pointer to a hash containing data about the next student -to be viewed. +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 next_student { - if (defined($next_student)) { - return $next_student; +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 enrollment'); + } elsif ($mode eq 'plaintext') { + $description = 'Unable to determine section, groups and enrollment'; } else { - return 'No Student Selected'; + $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; } ####################################################### ####################################################### +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 &clear_sequence_variables() +=item get_students + +Returns a list of the selected students =cut ####################################################### ####################################################### -sub clear_sequence_variables { - undef($top_map); - undef(@Sequences); - undef(@Assessments); +sub get_students { + if (! @Students) { + &PrepareClasslist() + } + return @Students; } ####################################################### @@ -415,25 +528,17 @@ sub clear_sequence_variables { =pod -=item &SetSelectedMaps($elementname) +=item ¤t_student() -Sets the @SelectedMaps array from $ENV{'form.'.$elementname}; +Returns a pointer to a hash containing data about the currently +selected student. =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 current_student { + return $curr_student; } ####################################################### @@ -441,42 +546,17 @@ sub SetSelectedMaps { =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'); - # - # Compute column widths - foreach my $seq (@Sequences) { - my $name_length = length($seq->{'title'}); - my $num_parts = $seq->{'num_assess_parts'}; - # - # The number of columns needed for the summation text: - # " 1/5" = 1+3 columns, " 10/99" = 1+5 columns - my $sum_length = 1+1+2*(length($num_parts)); - my $num_col = $num_parts+$sum_length; - if ($num_col < $name_length) { - $num_col = $name_length; - } - $seq->{'base_width'} = $name_length; - $seq->{'width'} = $num_col; - } - return; +sub previous_student { + return $prev_student; } ####################################################### @@ -484,60 +564,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; } ############################################## @@ -603,12 +640,96 @@ sub StudentDataSelect { return $Str; } +####################################################### +####################################################### + +=pod + +=item &get_selected_maps($elementname) + +Input: Name of the '."\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 .= ' \n"; + $form .= '>'.$seq->compTitle."\n"; } - $Str .= "\n"; - return $Str; + $form .= "\n"; + return $form; } ############################################## @@ -697,6 +805,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 =over 4 =item $elementname The name of the HTML form element @@ -705,13 +814,6 @@ of the sections in the course. =item $numvisible The number of options to be visible -=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. - -=item $restriction Code reference to subroutine which returns true or -false. The code must expect a reference to a sequence data structure. - =back =cut @@ -724,6 +826,11 @@ sub SectionSelect { 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 .= '