--- loncom/interface/lonstatistics.pm 2002/08/06 17:39:15 1.40 +++ loncom/interface/lonstatistics.pm 2006/05/11 20:05:02 1.134 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstatistics.pm,v 1.40 2002/08/06 17:39:15 minaeibi Exp $ +# $Id: lonstatistics.pm,v 1.134 2006/05/11 20:05:02 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,642 +25,1249 @@ # http://www.lon-capa.org/ # # (Navigate problems for statistical reports -# YEAR=2001 -# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei -# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei -# YEAR=2002 -# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei -# 5/12,5/14,5/15,5/19,5/26,7/16,25/7,29/7 Behrouz Minaei # ### -package Apache::lonstatistics; +=pod + +=head1 NAME + +lonstatistics + +=head1 SYNOPSIS + +Main handler for statistics and chart. + +=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::lonchart; -use HTML::TokeParser; -use GDBM_File; +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 Apache::lonstudentsubmissions(); +use Apache::lonsurveyreports(); +use Apache::longradinganalysis(); +####################################################### +####################################################### -sub CheckFormElement { - my ($cache, $ENVName, $cacheName, $default)=@_; - - if(defined($ENV{'form.'.$ENVName})) { - $cache->{$cacheName} = $ENV{'form.'.$ENVName}; - } elsif(!defined($cache->{$cacheName})) { - $cache->{$cacheName} = $default; - } +=pod - return; +=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 +# +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); + undef(@Sections); + undef(@Groups); + undef(%StudentData); + undef(@SelectedStudentData); + undef($curr_student); + undef($prev_student); + undef($next_student); } -sub ProcessFormData{ - my ($cache)=@_; +####################################################### +####################################################### + +=pod - $cache->{'reportKey'} = 'false'; +=item &PrepareClasslist() - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['sort','download', - 'reportSelected', - 'StudentAssessmentStudent']); - &CheckFormElement($cache, 'Status', 'Status', 'Active'); - &CheckFormElement($cache, 'postdata', 'reportSelected', 'Class list'); - &CheckFormElement($cache, 'reportSelected', 'reportSelected', - 'Class list'); - $cache->{'reportSelected'} = - &Apache::lonnet::unescape($cache->{'reportSelected'}); - &CheckFormElement($cache, 'DownloadAll', 'DownloadAll', 'false'); - &CheckFormElement($cache, 'sort', 'sort', 'fullname'); - &CheckFormElement($cache, 'download', 'download', 'false'); - - # student assessment - if(defined($ENV{'form.CreateStudentAssessment'}) || - defined($ENV{'form.NextStudent'}) || - defined($ENV{'form.PreviousStudent'})) { - $cache->{'reportSelected'} = 'Student Assessment'; - } - if(defined($ENV{'form.NextStudent'})) { - $cache->{'StudentAssessmentMove'} = 'next'; - } elsif(defined($ENV{'form.PreviousStudent'})) { - $cache->{'StudentAssessmentMove'} = 'previous'; +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(); + # + # 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($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 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::loncommon::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++) { + 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); + # + # Build up a list of sections + my $section = $studenthash->{'section'}; + if (! defined($section) || $section =~/^\s*$/ || $section == -1) { + $studenthash->{'section'} = 'none'; + $section = $studenthash->{'section'}; + } + $Sections{$section}++; + # + # Only put in the list those students we are interested in + 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 + if ($env{'request.course.sec'} !~ /^\s*$/) { + @Sections = ($env{'request.course.sec'}); } else { - $cache->{'StudentAssessmentMove'} = 'selected'; + @Sections = sort {$a cmp $b} keys(%Sections); + unshift(@Sections,'all'); # Put 'all' at the front of the list } - &CheckFormElement($cache, 'StudentAssessmentStudent', - 'StudentAssessmentStudent', 'All Students'); - $cache->{'StudentAssessmentStudent'} = - &Apache::lonnet::unescape($cache->{'StudentAssessmentStudent'}); - &CheckFormElement($cache, 'DefaultColumns', 'DefaultColumns', 'false'); - - if(defined($ENV{'form.Section'})) { - my @sectionsSelected = (ref($ENV{'form.Section'}) ? - @{$ENV{'form.Section'}} : - ($ENV{'form.Section'})); - $cache->{'sectionsSelected'} = join(':', @sectionsSelected); - } elsif(!defined($cache->{'sectionsSelected'})) { - $cache->{'sectionsSelected'} = $cache->{'sectionList'}; - } - - # Problem analysis - &CheckFormElement($cache, 'Interval', 'Interval', '1'); - - # ProblemStatistcs - &CheckFormElement($cache, 'DisplayCSVFormat', - 'DisplayFormat', 'Display Table Format'); - &CheckFormElement($cache, 'ProblemStatisticsAscend', - 'ProblemStatisticsAscend', 'Ascending'); - &CheckFormElement($cache, 'ProblemStatisticsMaps', - 'ProblemStatisticsMaps', 'All Maps'); - - # Search only form elements - my @headingColumns=(); - my @sequenceColumns=(); - my $foundColumn = 0; - if(defined($ENV{'form.ReselectColumns'})) { - my @reselected = (ref($ENV{'form.ReselectColumns'}) ? - @{$ENV{'form.ReselectColumns'}} - : ($ENV{'form.ReselectColumns'})); - foreach (@reselected) { - if(/HeadingColumn/) { - push(@headingColumns, $_); - $foundColumn = 1; - } elsif(/SequenceColumn/) { - push(@sequenceColumns, $_); - $foundColumn = 1; - } - } - } - - $cache->{'reportKey'} = 'false'; - if($cache->{'reportSelected'} eq 'Analyze') { - $cache->{'reportKey'} = 'Analyze'; - } elsif($cache->{'reportSelected'} eq 'DoDiffGraph') { - $cache->{'reportKey'} = 'DoDiffGraph'; - } elsif($cache->{'reportSelected'} eq 'PercentWrongGraph') { - $cache->{'reportKey'} = 'PercentWrongGraph'; - } - - if(defined($ENV{'form.DoDiffGraph'})) { - $cache->{'reportSelected'} = 'DoDiffGraph'; - $cache->{'reportKey'} = 'DoDiffGraph'; - } elsif(defined($ENV{'form.PercentWrongGraph'})) { - $cache->{'reportSelected'} = 'PercentWrongGraph'; - $cache->{'reportKey'} = 'PercentWrongGraph'; - } - - foreach (keys(%ENV)) { - if(/form\.Analyze/) { - $cache->{'reportSelected'} = 'Analyze'; - $cache->{'reportKey'} = 'Analyze'; - my $data; - (undef, $data)=split(':::', $_); - $cache->{'AnalyzeInfo'}=$data; - } elsif(/form\.HeadingColumn/) { - my $value = $_; - $value =~ s/form\.//; - push(@headingColumns, $value); - $foundColumn=1; - } elsif(/form\.SequenceColumn/) { - my $value = $_; - $value =~ s/form\.//; - push(@sequenceColumns, $value); - $foundColumn=1; - } - } - - if($foundColumn) { - $cache->{'HeadingsFound'} = join(':', @headingColumns); - $cache->{'SequencesFound'} = join(':', @sequenceColumns);; - } - if(!defined($cache->{'HeadingsFound'}) || - $cache->{'DefaultColumns'} ne 'false') { - $cache->{'HeadingsFound'}='HeadingColumnFull Name'; - } - if(!defined($cache->{'SequencesFound'}) || - $cache->{'DefaultColumns'} ne 'false') { - $cache->{'SequencesFound'}='All Sequences'; + # 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 { 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'})) { + my ($current_uname,$current_dom) = + split(':',$env{'form.SelectedStudent'}); + my $i; + for ($i = 0; $i<=$#Students; $i++) { + next if (($Students[$i]->{'username'} ne $current_uname) || + ($Students[$i]->{'domain'} ne $current_dom)); + $curr_student = $Students[$i]; + last; # If we get here, we have our student. + } + 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]; + } + } } - $cache->{'DefaultColumns'} = 'false'; - + # + 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; } -=pod +####################################################### +####################################################### -=item &SortStudents() +=pod -Determines which students to display and in which order. Which are -displayed are determined by their status(active/expired). The order -is determined by the sort button pressed (default to username). The -type of sorting is username, lastname, or section. +=item get_selected_sections -=over 4 +Returns an array of the selected sections -Input: $students, $CacheData +=cut -$students: A array pointer to a list of students (username:domain) +####################################################### +####################################################### +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; +} -$CacheData: A pointer to the hash tied to the cached data +####################################################### +####################################################### + +=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 -Output: \@order +=item §ion_and_enrollment_description -@order: An ordered list of students (username:domain) +Returns a string describing the currently selected section(s), group(s) and +enrollment status. -=back +Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized') + 'plaintext' is used for example in Excel spreadsheets. +Returns: scalar description string. =cut -sub SortStudents { - my ($cache)=@_; +####################################################### +####################################################### +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 { + $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; +} + +####################################################### +####################################################### - my @students = split(':::',$cache->{'NamesOfStudents'}); - my @sorted1Students=(); - foreach (@students) { - if($cache->{'Status'} eq 'Any' || - $cache->{$_.':Status'} eq $cache->{'Status'}) { - push(@sorted1Students, $_); +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; +} - my $sortBy = ''; - if(defined($cache->{'sort'})) { - $sortBy = ':'.$cache->{'sort'}; + +=pod + +=item get_students + +Returns a list of the selected students + +=cut + +####################################################### +####################################################### +sub get_students { + if (! @Students) { + &PrepareClasslist() } - my @order = sort { $cache->{$a.$sortBy} cmp $cache->{$b.$sortBy} || - $cache->{$a.':fullname'} cmp $cache->{$b.':fullname'} } - @sorted1Students; + return @Students; +} - return \@order; +####################################################### +####################################################### + +=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 &SpaceColumns() +=item &previous_student() -Determines the width of all the columns in the chart. It is based on -the max of the data for that column and its header. +Returns a pointer to a hash containing data about the student prior +in the list of students. Or something. -=over 4 +=cut + +####################################################### +####################################################### +sub previous_student { + return $prev_student; +} -Input: $students, $studentInformation, $headings, $ChartDB +####################################################### +####################################################### -$students: An array pointer to a list of students (username:domain) +=pod + +=item &next_student() -$studentInformatin: The type of data for the student information. It is -used as part of the key in $CacheData. +Returns a pointer to a hash containing data about the next student +to be viewed. -$headings: The name of the student information columns. +=cut -$ChartDB: The name of the cache database which is opened for read/write. +####################################################### +####################################################### +sub next_student { + return $next_student; +} -Output: None - All data stored in cache. +############################################## +############################################## + +=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 SpaceColumns { - my ($students,$studentInformation,$headings,$cache)=@_; - - # Initialize Lengths - for(my $index=0; $index<(scalar @$headings); $index++) { - my @titleLength=split(//,$headings->[$index]); - $cache->{$studentInformation->[$index].':columnWidth'}= - scalar @titleLength; - } - - foreach my $name (@$students) { - foreach (@$studentInformation) { - my @dataLength=split(//,$cache->{$name.':'.$_}); - my $length=(scalar @dataLength); - if($length > $cache->{$_.':columnWidth'}) { - $cache->{$_.':columnWidth'}=$length; +############################################## +############################################## +sub StudentDataSelect { + my ($elementname,$status,$numvisible)=@_; + if ($numvisible < 1) { + return; + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; + return $Str; } -sub PrepareData { - my ($c, $cacheDB, $studentInformation, $headings,$r)=@_; +####################################################### +####################################################### - # Test for access to the cache data - my $courseID=$ENV{'request.course.id'}; - my $isRecalculate=0; - if(defined($ENV{'form.Recalculate'})) { - $isRecalculate=1; - } +=pod - my $isCached = &Apache::loncoursedata::TestCacheData($cacheDB, - $isRecalculate); - if($isCached < 0) { - return "Unable to tie hash to db file."; - } +=item &get_selected_maps($elementname) - # Download class list information if not using cached data - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT(),0640)) { - return "Unable to tie hash to db file."; - } +Input: Name of the
'; + $Str .= ''; + $r->print($Str); + $r->rflush(); + # + my @Fields = ('fullname','username','domain','id','section','status','groups'); + # + $Str = ''; + my @selected_sections = &get_selected_sections(); + if (! @Students) { + if ($selected_sections[0] eq 'all') { + if (lc($env{'form.Status'}) eq 'any') { + $Str .= ''."\n";
$Str .= '
|
'."\n"; - $Str .= ' | Analysis Reports: | '."\n"; - $Str .= 'Student Status: | |
{'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.''."\n"; - } - $Str .= ' | '."\n"; - - $Str .= ''; - $Str .= &Apache::lonhtmlcommon::StatusOptions($status, 'Statistics'); - $Str .= ' | '."\n"; - - $Str .= '
'. + &mt('Please notify the server administrator '). + ''.$serveradmin.'
'); + $r->print(''. + &mt('Course Statistics and Charts cannot be '. + 'retrieved until the database is restarted. '. + 'Your data is intact but cannot be displayed '. + 'at this time.').'
'); + $r->print(&Apache::loncommon::end_page()); + return; } - - $r->print(&Apache::lonhtmlcommon::Title('LON-CAPA Statistics')); + # + # Clean out the caches + if (exists($env{'form.ClearCache'})) { + &Apache::loncoursedata::delete_caches($env{'requres.course.id'}); + } + # + # Begin form output $r->print('\n"); } - - $r->print(''."\n"); - $r->print("\n".'