--- loncom/interface/lonstatistics.pm 2006/05/01 05:39:44 1.130 +++ loncom/interface/lonstatistics.pm 2020/11/10 19:28:32 1.165 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstatistics.pm,v 1.130 2006/05/01 05:39:44 raeburn Exp $ +# $Id: lonstatistics.pm,v 1.165 2020/11/10 19:28:32 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,19 +28,7 @@ # ### -=pod - -=head1 NAME - -lonstatistics - -=head1 SYNOPSIS -Main handler for statistics and chart. - -=over 4 - -=cut package Apache::lonstatistics; @@ -63,6 +51,7 @@ use Apache::loncoursedata; use Apache::lonhtmlcommon; use Apache::lonmysql; use Apache::lonlocal; +use Apache::longroup; use Time::HiRes; # # Statistics Packages @@ -75,34 +64,9 @@ use Apache::lonpercentage; use Apache::lonstudentsubmissions(); use Apache::lonsurveyreports(); use Apache::longradinganalysis(); +use Apache::lonquickgrades(); +use LONCAPA; -####################################################### -####################################################### - -=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 @Groups The groups available in the class - -=item $curr_student The student currently being examined - -=item $prev_student The student previous in the classlist - -=item $next_student The student next in the classlist - -=over - -=cut - -####################################################### -####################################################### # # Classlist variables # @@ -110,43 +74,7 @@ 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 @Groups - -=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); @@ -159,45 +87,7 @@ 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 @Groups - -=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(); @@ -230,12 +120,13 @@ sub PrepareClasslist { $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) { + my ($classgroups,$studentgroups); + my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum); + if (%curr_groups) { ($classgroups,$studentgroups) = - &Apache::loncoursedata::get_group_memberships($classlist, - $cdom,$cnum); + &Apache::loncoursedata::get_group_memberships($classlist, + $field_names, + $cdom,$cnum); } my $now = time; @@ -281,18 +172,18 @@ sub PrepareClasslist { ($enrollment_status eq 'Any')) ){ my $groupcheck = 0; - if (grep/^all$/,@selected_groups) { - push (@Students,$studenthash); + if (grep(/^all$/,@selected_groups)) { + push(@Students,$studenthash); last; - } elsif (grep/^none$/,@selected_groups) { + } elsif (grep(/^none$/,@selected_groups)) { if ($studenthash->{'groups'} eq 'none') { - push (@Students,$studenthash); + push(@Students,$studenthash); last; } } else { foreach my $group (@selected_groups) { - if (grep/^$group$/,@studentsgroups) { - push (@Students,$studenthash); + if (grep(/^$group$/,@studentsgroups)) { + push(@Students,$studenthash); $groupcheck = 1; last; } @@ -309,7 +200,11 @@ sub PrepareClasslist { 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 @@ -367,19 +262,7 @@ sub PrepareClasslist { return; } -####################################################### -####################################################### - -=pod -=item get_selected_sections - -Returns an array of the selected sections - -=cut - -####################################################### -####################################################### sub get_selected_sections { my @selected_sections = &Apache::loncommon::get_env_multiple('form.Section'); @@ -397,19 +280,7 @@ sub get_selected_sections { 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'); @@ -423,21 +294,8 @@ sub get_selected_groups { 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'; } @@ -445,25 +303,25 @@ sub section_and_enrollment_description { my @groups = &Apache::lonstatistics::get_selected_groups(); my $description; if ($mode eq 'localized') { - $description = &mt('Unable to determine section, groups and enrollment'); + $description = &mt('Unable to determine section, groups and access status'); } elsif ($mode eq 'plaintext') { - $description = 'Unable to determine section, groups and enrollment'; + $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); + ' '.§ion_or_group_text($mode,'group',@groups); if ($mode eq 'localized') { - $description .= &mt(' [_1] enrollment status.',$env{'form.Status'}); + $description .= ' '.&mt($env{'form.Status'}.' access status.'); } elsif ($mode eq 'plaintext') { - $description .= ' '.$env{'form.Status'}.' enrollment status.'; + $description .= ' '.$env{'form.Status'}.' access status.'; } return $description; } -####################################################### -####################################################### + + sub section_or_group_text { my ($mode,$type,@items) = @_; @@ -481,21 +339,21 @@ sub section_or_group_text { ); if (scalar(@items) == 1 && $items[0] ne 'all') { if ($mode eq 'localized') { - $text = &mt('[_1] [_2].',$phrases{$type}{single},$items[0]); + $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('[_1].',$phrases{$type}{all}); + $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('[_1] [_2] and [_3].',$phrases{$type}{plural}, + $text = &mt($phrases{$type}{plural}.' [_1] and [_2].', join(', ',@items),$lastitem); } elsif ($mode eq 'plaintext') { $text = $phrases{$type}{plural}.' '.join(', ',@items).' and '. @@ -506,101 +364,33 @@ sub section_or_group_text { } -=pod - -=item get_students - -Returns a list of the selected students - -=cut - -####################################################### -####################################################### sub get_students { if (! @Students) { - &PrepareClasslist() + &PrepareClasslist(); } 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; } -############################################## -############################################## - -=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 - -=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 StudentDataSelect { my ($elementname,$status,$numvisible)=@_; if ($numvisible < 1) { @@ -611,51 +401,37 @@ sub StudentDataSelect { my $Str = "\n"; $Str .= '\n"; return $Str; } -####################################################### -####################################################### - -=pod -=item &get_selected_maps($elementname) -Input: Name of the
'; + $Str .= ''; $Str .= ''; $r->print($Str); @@ -953,85 +658,92 @@ sub DisplayClasslist { my @selected_sections = &get_selected_sections(); if (! @Students) { if ($selected_sections[0] eq 'all') { - if (lc($env{'form.Status'}) eq 'any') { - $Str .= ''. &mt('There are no currently enrolled students in the course.'). - ''; + '
'; } elsif (lc($env{'form.Status'}) eq 'expired') { - $Str .= ''. &mt('There are no previously enrolled students in the course.'). - ''; + '
'; + } elsif (lc($env{'form.Status'}) eq 'future') { + $Str .= ''. + &mt('There are no students with future access in the course.'). + '
'; + } else { # 'any' and any others + $Str .= ''. + &mt('There are no students in the course.'). + '
'; } } else { - my $sections; - if (lc($env{'form.Status'}) eq 'any') { - $Str .= ''. &mt('There are no currently enrolled students in the selected sections.'). - ''; + '
'; } elsif (lc($env{'form.Status'}) eq 'expired') { - $Str .= ''. &mt('There are no previously enrolled students in the selected sections.'). - ''; + '
'; + } elsif (lc($env{'form.Status'}) eq 'future') { + $Str .= ''. + &mt('There are no students with future access in the selected sections.'). + '
'; + } else { # 'any' and any others + $Str .= ''. + &mt('There are no students in the selected sections.'). + '
'; } } - $Str.= ''. - &mt('Click here to return to the chart').''; + $Str.= '' + .'' + .&mt('Return to the chart').'' + .'
'; $r->print($Str); $r->rflush(); return; } - # "Click" is asinine but it is probably not my place to change the world. - $Str .= ''."\n";
- $Str .= '
|
'. &mt('Unable to connect to database!'). - '
'. - &mt('Please notify the server administrator '). - ''.$serveradmin.'
'); + ''); + $r->print('' + .&mt('Please notify the server administrator [_1]', + ,''.$serveradmin.'') + .'
'); $r->print(''. &mt('Course Statistics and Charts cannot be '. - 'retrieved until the database is restarted. '. + 'retrieved until the database is restarted. '. 'Your data is intact but cannot be displayed '. 'at this time.').'
'); $r->print(&Apache::loncommon::end_page()); @@ -1187,18 +911,18 @@ ENDSTYLE # # Clean out the caches if (exists($env{'form.ClearCache'})) { - &Apache::loncoursedata::delete_caches($env{'requres.course.id'}); + &Apache::loncoursedata::delete_caches($env{'request.course.id'}); } # # Begin form output $r->print('\n"); } + &Apache::lonquickgrades::endGradeScreen($r); $r->print(&Apache::loncommon::end_page()); $r->rflush(); # @@ -1257,17 +982,227 @@ ENDSTYLE 1; -####################################################### -####################################################### +__END__ =pod +=head1 NAME + +lonstatistics + +=head1 SYNOPSIS + +Main handler for statistics and chart. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 PACKAGE VARIABLES + +=over + +=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 @Groups The groups available in the class + +=item $curr_student The student currently being examined + +=item $prev_student The student previous in the classlist + +=item $next_student The student next in the classlist + =back -=cut +=head1 SUBROUTINES -####################################################### -####################################################### +=over -__END__ +=item &clear_classlist_variables() + +undef the following package variables: + +=over 4 + +=item * @FullClasslist + +=item * @Students + +=item * @Sections + +=item * @Groups + +=item * %StudentData + +=item * @StudentDataOrder + +=item * @SelectedStudentData + +=item * $curr_student + +=item * $prev_student + +=item * $next_student + +=back + +=item &PrepareClasslist() + +Build up the classlist information. The classlist information is kept in +the following package variables: + +=over 4 + +=item * @FullClasslist + +=item * @Students + +=item * @Sections + +=item * @Groups + +=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. + +=item get_selected_sections() + +Returns an array of the selected sections + +=item get_selected_groups() + +Returns an array of the selected groups + +=item §ion_and_enrollment_description() + +Returns a string describing the currently selected section(s), group(s) and +access status. + +Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized') + 'plaintext' is used for example in Excel spreadsheets. +Returns: scalar description string. + +=item section_or_group_text() + +=item get_students() + +Returns a list of the selected students + +=item ¤t_student() + +Returns a pointer to a hash containing data about the currently +selected student. + +=item &previous_student() + +Returns a pointer to a hash containing data about the student prior +in the list of students. Or something. + +=item &next_student() + +Returns a pointer to a hash containing data about the next student +to be viewed. + +=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 + +=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 + +=item &get_selected_maps($elementname) + +Input: Name of the