--- loncom/interface/lonstatistics.pm 2002/08/30 15:35:08 1.49 +++ loncom/interface/lonstatistics.pm 2008/09/16 15:40:15 1.141 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstatistics.pm,v 1.49 2002/08/30 15:35:08 stredwic Exp $ +# $Id: lonstatistics.pm,v 1.141 2008/09/16 15:40:15 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,623 +25,1264 @@ # 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::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 HTML::TokeParser; -use GDBM_File; +use Apache::lonstudentsubmissions(); +use Apache::lonsurveyreports(); +use Apache::longradinganalysis(); +use LONCAPA; +####################################################### +####################################################### -sub CheckFormElement { - my ($cache, $ENVName, $cacheName, $default)=@_; +=pod - if(defined($ENV{'form.'.$ENVName})) { - $cache->{$cacheName} = $ENV{'form.'.$ENVName}; - } elsif(!defined($cache->{$cacheName})) { - $cache->{$cacheName} = $default; - } +=item Package Variables - return; -} +=item @FullClasslist The full classlist -sub ProcessFormData{ - my ($cache)=@_; +=item @Students The students we are concerned with for this invocation - $cache->{'reportKey'} = 'false'; +=item @Sections The sections available in this class - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['sort','download', - 'reportSelected', - 'StudentAssessmentStudent', - 'ProblemStatisticsSort']); - &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'); - &CheckFormElement($cache, 'StatisticsMaps', - 'StatisticsMaps', 'All Maps'); - &CheckFormElement($cache, 'StatisticsProblemSelect', - 'StatisticsProblemSelect', 'All Problems'); - &CheckFormElement($cache, 'StatisticsPartSelect', - 'StatisticsPartSelect', 'All Parts'); - 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'}; - } - - # 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'; - } else { - $cache->{'StudentAssessmentMove'} = 'selected'; - } - &CheckFormElement($cache, 'StudentAssessmentStudent', - 'StudentAssessmentStudent', 'All Students'); - $cache->{'StudentAssessmentStudent'} = - &Apache::lonnet::unescape($cache->{'StudentAssessmentStudent'}); - &CheckFormElement($cache, 'DefaultColumns', 'DefaultColumns', 'false'); - - # Problem analysis - &CheckFormElement($cache, 'Interval', 'Interval', '1'); - - # ProblemStatistcs - &CheckFormElement($cache, 'DisplayCSVFormat', - 'DisplayFormat', 'Display Table Format'); - &CheckFormElement($cache, 'ProblemStatisticsAscend', - 'ProblemStatisticsAscend', 'Ascending'); - &CheckFormElement($cache, 'ProblemStatisticsSort', - 'ProblemStatisticsSort', 'Homework Sets Order'); - &CheckFormElement($cache, 'DisplayLegend', 'DisplayLegend', - 'Hide Legend'); - &CheckFormElement($cache, 'SortProblems', 'SortProblems', - 'Sort Within Sequence'); - - # 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'; - } - $cache->{'DefaultColumns'} = 'false'; +=item @Groups The groups available in the class - return; -} +=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 &SortStudents() +=item &clear_classlist_variables() -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. +undef the following package variables: -=over 4 +=over -Input: $students, $CacheData +=item @FullClasslist -$students: A array pointer to a list of students (username:domain) +=item @Students -$CacheData: A pointer to the hash tied to the cached data +=item @Sections -Output: \@order +=item @Groups -@order: An ordered list of students (username:domain) +=item %StudentData -=back +=item @StudentDataOrder -=cut +=item @SelectedStudentData -sub SortStudents { - my ($cache)=@_; +=item $curr_student - my @students = split(':::',$cache->{'NamesOfStudents'}); - my @sorted1Students=(); - foreach (@students) { - if($cache->{'Status'} eq 'Any' || - $cache->{$_.':Status'} eq $cache->{'Status'}) { - push(@sorted1Students, $_); - } - } +=item $prev_student - my $sortBy = ''; - if(defined($cache->{'sort'})) { - $sortBy = ':'.$cache->{'sort'}; - } - my @order = sort { $cache->{$a.$sortBy} cmp $cache->{$b.$sortBy} || - $cache->{$a.':fullname'} cmp $cache->{$b.':fullname'} } - @sorted1Students; +=item $next_student + +=back - return \@order; +=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); } +####################################################### +####################################################### + =pod -=item &SpaceColumns() +=item &PrepareClasslist() -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. +Build up the classlist information. The classlist information is kept in +the following package variables: -=over 4 +=over -Input: $students, $studentInformation, $headings, $ChartDB +=item @FullClasslist -$students: An array pointer to a list of students (username:domain) +=item @Students -$studentInformatin: The type of data for the student information. It is -used as part of the key in $CacheData. +=item @Sections -$headings: The name of the student information columns. +=item @Groups -$ChartDB: The name of the cache database which is opened for read/write. +=item %StudentData -Output: None - All data stored in cache. +=item @SelectedStudentData + +=item $curr_student + +=item $prev_student + +=item $next_student =back -=cut +$curr_student, $prev_student, and $next_student may not be defined, depending +upon the calling context. -sub SpaceColumns { - my ($students,$studentInformation,$headings,$cache)=@_; +=cut - # 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 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::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++) { + 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 { + @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 { 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]; + } + } + } + # + 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; } -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_sections - # 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."; - } +Returns an array of the selected sections + +=cut - if(!$isCached) { - my $processTopResourceMapReturn= - &Apache::loncoursedata::ProcessTopResourceMap(\%cache, $c, $r); - if($processTopResourceMapReturn ne 'OK') { - untie(%cache); - return $processTopResourceMapReturn; +####################################################### +####################################################### +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'); } } - - if($c->aborted()) { - untie(%cache); - return 'aborted'; + # + # Deal with instructors with restricted section access + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); } + return @selected_sections; +} - my $classlist=&Apache::loncoursedata::DownloadClasslist($courseID, - $cache{'ClasslistTimestamp'}, - $c); - foreach (keys(%$classlist)) { - if(/^(con_lost|error|no_such_host)/i) { - untie(%cache); - return "Error getting student 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 - if($c->aborted()) { - untie(%cache); - return 'aborted'; - } +=item §ion_and_enrollment_description - # Active is a temporary solution, remember to change - Apache::loncoursedata::ProcessClasslist(\%cache,$classlist,$courseID,$c); - if($c->aborted()) { - untie(%cache); - return 'aborted'; - } +Returns a string describing the currently selected section(s), group(s) and +access status. - &ProcessFormData(\%cache); - my $students = &SortStudents(\%cache); - &SpaceColumns($students, $studentInformation, $headings, \%cache); - $cache{'updateTime:columnWidth'}=24; +Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized') + 'plaintext' is used for example in Excel spreadsheets. +Returns: scalar description string. - my $download = $cache{'download'}; - my $downloadAll = $cache{'DownloadAll'}; - my @allStudents=(); - if($download ne 'false') { - $cache{'download'} = 'false'; - } elsif($downloadAll ne 'false') { - $cache{'DownloadAll'} = 'false'; - if($downloadAll eq 'sorted') { - @allStudents = @$students; - } else { - @allStudents = split(':::', $cache{'NamesOfStudents'}); - } +=cut + +####################################################### +####################################################### +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(' [_1] access status.',$env{'form.Status'}); + } elsif ($mode eq 'plaintext') { + $description .= ' '.$env{'form.Status'}.' access status.'; } + return $description; +} + +####################################################### +####################################################### - untie(%cache); +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].'.'; - if($download ne 'false') { - my @who = ($download); - if(&Apache::loncoursedata::DownloadStudentCourseData(\@who, 'false', - $cacheDB, 'true', - 'false', $courseID, - $r, $c) ne 'OK') { - return 'Stop at download individual'; } - } elsif($downloadAll ne 'false') { - if(&Apache::loncoursedata::DownloadStudentCourseData(\@allStudents, - 'false', - $cacheDB, 'true', - 'true', $courseID, - $r, $c) ne 'OK') { - return 'Stop at download all'; + } 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 ('OK', $students); + return $text; } -sub BuildClasslist { - my ($cacheDB,$students,$studentInformation,$headings,$r)=@_; - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - return 'Unable to tie database.'; - } +=pod - my $Str=''; - $Str .= '
'."\n"; - $Str .= ''."\n"; +=item get_students - my $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings(\%cache, - $studentInformation, - $headings, $displayString); - $Str .= ''."\n"; +Returns a list of the selected students - my $alternate=0; - foreach (@$students) { - my ($username, $domain) = split(':', $_); - if($alternate) { - $Str .= ''; - } else { - $Str .= ''; - } - $alternate = ($alternate + 1) % 2; - foreach my $data (@$studentInformation) { - $Str .= ''."\n"; - } +####################################################### +####################################################### +sub get_students { + if (! @Students) { + &PrepareClasslist() } + return @Students; +} - $Str .= ''."\n"; - $Str .= '
DISPLAYDATA 
'; - if($data eq 'fullname') { - $Str .= ''; - $Str .= $cache{$_.':'.$data}.' '; - $Str .= ''; - } elsif($data eq 'updateTime') { - $Str .= ''; - $Str .= $cache{$_.':'.$data}.' '; - $Str .= ' '; - } else { - $Str .= $cache{$_.':'.$data}.' '; - } +=cut - $Str .= '
'."\n"; - $r->print($Str); - $r->rflush(); +####################################################### +####################################################### + +=pod - untie(%cache); +=item ¤t_student() - return; +Returns a pointer to a hash containing data about the currently +selected student. + +=cut + +####################################################### +####################################################### +sub current_student { + return $curr_student; } -sub CreateMainMenu { - my ($status, $reports)=@_; +####################################################### +####################################################### - my $Str = ''; +=pod - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - - $Str .= ''."\n"; +=item &previous_student() - $Str .= '
Analysis Reports:Student Status:
{'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.''."\n"; - } - $Str .= ''; - $Str .= &Apache::lonhtmlcommon::StatusOptions($status, 'Statistics'); - $Str .= '
'."\n"; - $Str .= '
'."\n"; +Returns a pointer to a hash containing data about the student prior +in the list of students. Or something. - return $Str; +=cut + +####################################################### +####################################################### +sub previous_student { + return $prev_student; } -sub BuildStatistics { - my ($r)=@_; +####################################################### +####################################################### + +=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 - my $c = $r->connection; - my @studentInformation=('fullname','section','id','domain','username', - 'updateTime'); - my @headings=('Full Name', 'Section', 'PID', 'Domain', 'User Name', - 'Last Updated'); - my $spacing = ' '; - my %reports = ('classlist' => 'Class list', - 'problem_statistics' => 'Problem Statistics', - 'student_assessment' => 'Student Assessment', - 'percentage' => 'Percentage Graphs', -# 'activitylog' => 'Activity Log', - 'reportSelected' => 'Class list'); - - my %cache; - my $courseID=$ENV{'request.course.id'}; - my $cacheDB = "/home/httpd/perl/tmp/$ENV{'user.name'}". - "_$ENV{'user.domain'}_$courseID\_statistics.db"; - - $r->print(&Apache::lonhtmlcommon::Title('Course Statistics and Charts')); - - my ($returnValue, $students) = &PrepareData($c, $cacheDB, - \@studentInformation, - \@headings,$r); - if($returnValue ne 'OK') { - $r->print($returnValue."\n".''); - return OK; - } - if(!$c->aborted()) { - &Apache::loncoursedata::CheckForResidualDownload($cacheDB, - 'true', 'true', - $courseID, - $r, $c); - } - - my $GoToPage; - if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $GoToPage = $cache{'reportSelected'}; - $reports{'reportSelected'} = $cache{'reportSelected'}; - if(defined($cache{'reportKey'}) && - !exists($reports{$cache{'reportKey'}}) && - $cache{'reportKey'} ne 'false') { - $reports{$cache{'reportKey'}} = $cache{'reportSelected'}; +=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) { + return; + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; + return $Str; +} + +####################################################### +####################################################### + +=pod + +=item &get_selected_maps($elementname) + +Input: Name of the '."\n"; + # + # Put in option for 'all' + $form .= ' \n"; + } + $form .= "\n"; + return $form; } -# ================================================================ Main Handler +############################################## +############################################## -sub handler { - my $r=shift; +=pod + +=item &SectionSelect($elementname,$status,$numvisible) + +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 -# $jr = $r; +=item $status 'multiple' or 'single' selection box - unless(&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) { - $ENV{'user.error.msg'}= - $r->uri.":vgr:0:0:Cannot view grades for complete course"; - return HTTP_NOT_ACCEPTABLE; +=item $numvisible The number of options to be visible + +=back + +=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"; + return $Str; +} - # Set document type for header only - if($r->header_only) { - if ($ENV{'browser.mathml'}) { - $r->content_type('text/xml'); - } else { - $r->content_type('text/html'); +############################################## +############################################## + +=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"; +} + - unless($ENV{'request.course.fn'}) { - my $requrl=$r->uri; - $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; - return HTTP_NOT_ACCEPTABLE; +################################################## +################################################## +sub DisplayClasslist { + my ($r)=@_; + &Apache::lonhtmlcommon::add_breadcrumb + ({text=>'Select One Student'}); + # + # Output some of the standard interface components + my $Str; + $Str .= &Apache::lonhtmlcommon::breadcrumbs('Select One Student'); + $Str .= '

'."\n"; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''.$/; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + + $Str .= ''.$/; + $Str .= '
'.&mt('Sections').''.&mt('Groups').''.&mt('Access Status').'
'. + &Apache::lonstatistics::SectionSelect('Section','multiple',5). + ''. + &Apache::lonstatistics::GroupSelect('Group','multiple',5). + ''. + &Apache::lonhtmlcommon::StatusOptions(undef,undef,5). + '

'; + $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 'active') { + $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 { + if (lc($env{'form.Status'}) eq 'active') { + $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('Return to the chart').'' + .'

'; + $r->print($Str); + $r->rflush(); + return; } - $r->content_type('text/html'); - $r->send_http_header; + $Str .= '

'.&mt('Select One Student').'

' + .'

'.&mt("Click on a student's name or username to view their chart").'

' + .&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row(); + foreach my $field (@Fields) { + $Str .= ''.&mt($field). + ''; + } + $Str .= &Apache::loncommon::end_data_table_header_row(); + # + foreach my $student (@Students) { # @Students is a package variable + my $sname = $student->{'username'}.':'.$student->{'domain'}; + $Str .= &Apache::loncommon::start_data_table_row(); + # + foreach my $field (@Fields) { + $Str .= ''; + if ($field eq 'fullname' || $field eq 'username') { + $Str .= ''; + $Str .= $student->{$field}.' '; + $Str .= ''; + } elsif ($field eq 'status') { + $Str .= &mt($student->{$field}); + } else { + $Str .= $student->{$field}; + } + $Str .= ''; + } + $Str .= &Apache::loncommon::end_data_table_row(); + } + $Str .= &Apache::loncommon::end_data_table(); + # + $r->print($Str); + $r->rflush(); + # + return; +} - &BuildStatistics($r); +############################################## +############################################## +sub CreateMainMenu { + # + # Define menu data + my @reports = ({ internal_name => 'problem_statistics', + name => &mt('Overall Problem Statistics'), + short_description => + &mt('Student performance statistics on all problems.'), + }, + { internal_name => 'problem_analysis', + name => &mt('Detailed Problem Analysis'), + short_description => + &mt('Detailed statistics and graphs of student performance on problems.'), + }, + { internal_name => 'submissiontime_analysis', + name => &mt('Submission Time Plots'), + short_description => + &mt('Display and analysis of submission times on assessments.'), + }, + { internal_name => 'student_submission_reports', + name => &mt('Student Submission Reports'), + short_description => + &mt('Prepare reports of student submissions.'), + }, + { internal_name => 'survey_reports', + name => &mt('Survey Reports'), + short_description => + &mt('Prepare reports on survey results.'), + }, + { internal_name => 'correct_problems_plot', + name => &mt('Correct Problems Plot'), + short_description => + &mt('Display a histogram of student performance in the course.'), + }, +# { internal_name => 'grading_analysis', +# name => &mt('Detailed Grading Analysis'), +# short_description => +# &mt('Display statistics about who graded who.'), +# }, +# { internal_name => 'student_assessment', +# name => &mt('Problem Status Chart'), +# short_description => +# &mt('Brief view of each students performance in course.'), +# }, + # 'percentage' => 'Correct-problems Plot', + # 'activitylog' => 'Activity Log', + ); + # + # Create the menu + my $Str; + $Str .= '

'.&mt('Please select a report to generate').'

'; + foreach my $reportdata (@reports) { + $Str .='

'. + $reportdata->{'name'}."

\n"; + $Str .= ' '.(' 'x8).$reportdata->{'short_description'}. + "\n"; + } + $Str .="\n"; + # + return $Str; +} +############################################## +############################################## +sub handler { + my $r=shift; + my $c = $r->connection(); + # + # Check for overloading + my $loaderror=&Apache::lonnet::overloaderror($r); + if ($loaderror) { return $loaderror; } + $loaderror= + &Apache::lonnet::overloaderror($r, + $env{'course.'.$env{'request.course.id'}.'.home'}); + if ($loaderror) { return $loaderror; } + # + # Check for access + if (! &Apache::lonnet::allowed('vgr',$env{'request.course.id'})) { + $env{'user.error.msg'}= + $r->uri.":vgr:0:0:Cannot view grades for complete course"; + if (! &Apache::lonnet::allowed('vgr', + $env{'request.course.id'}.'/'.$env{'request.course.sec'})) { + $env{'user.error.msg'}= + $r->uri.":vgr:0:0:Cannot view grades with given role"; + return HTTP_NOT_ACCEPTABLE; + } + } + # + # Send the header + &Apache::loncommon::no_cache($r); + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + if ($r->header_only) { return OK; } + # + # Extract form elements from query string + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sort','reportSelected', + 'SelectedStudent']); + # + # Give the LON-CAPA page header + my $style = < + ul.sub_studentans { list-style-type: none } + ul.sub_correctans { list-style-type: none } + tr.even { background-color: \#CCCCCC } + td.essay { border: 1px solid gray; } + +ENDSTYLE + + $r->print(&Apache::loncommon::start_page('Course Statistics and Charts', + $style)); + $r->rflush(); + # + # Either print out a menu for them or send them to a report + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/statistics', + title=>'Statistics', + text =>'Statistics', + faq=>139, + bug=>'Statistics and Charts'}); + if (! exists($env{'form.reportSelected'}) || + $env{'form.reportSelected'} eq '') { + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Statistics Main Page'). + &CreateMainMenu()); + } else { + # + if (! &Apache::lonmysql::verify_sql_connection()) { + my $serveradmin = $r->dir_config('lonAdmEMail'); + $r->print('

'. + &mt('Unable to connect to database!'). + '

'); + $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. '. + 'Your data is intact but cannot be displayed '. + 'at this time.').'

'); + $r->print(&Apache::loncommon::end_page()); + return; + } + # + # Clean out the caches + if (exists($env{'form.ClearCache'})) { + &Apache::loncoursedata::delete_caches($env{'requres.course.id'}); + } + # + # Begin form output + $r->print('
print('method="post" action="/adm/statistics">'); + $r->rflush(); + # + my $GoToPage = $env{'form.reportSelected'}; + # + $r->print(''); + if($GoToPage eq 'activitylog') { +# &Apache::lonproblemstatistics::Activity(); + } elsif($GoToPage eq 'problem_statistics') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/statistics?reportselected=problem_statistics', + text=>'Overall Problem Statistics'}); + &Apache::lonproblemstatistics::BuildProblemStatisticsPage($r,$c); + } elsif($GoToPage eq 'problem_analysis') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/statistics?reportselected=problem_analysis', + text=>'Detailed Problem Analysis'}); + &Apache::lonproblemanalysis::BuildProblemAnalysisPage($r,$c); + } elsif($GoToPage eq 'submissiontime_analysis') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=> + '/adm/statistics?reportselected=submissiontime_analysis', + text=>'Submission Time Plots'}); + &Apache::lonsubmissiontimeanalysis::BuildSubmissionTimePage($r,$c); + } elsif($GoToPage eq 'student_submission_reports') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=> + '/adm/statistics?reportselected=student_submission_reports', + text=>'Student Submission Reports'}); + &Apache::lonstudentsubmissions::BuildStudentSubmissionsPage($r,$c); + } elsif($GoToPage eq 'survey_reports') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=> + '/adm/statistics?reportselected=survey_reports', + text=>'Survey Reports'}); + &Apache::lonsurveyreports::BuildSurveyReportsPage($r,$c); + } elsif($GoToPage eq 'correct_problems_plot') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/statistics?reportselected=correct_problems_plot', + text=>'Correct Problems Plot'}); + &Apache::loncorrectproblemplot::BuildCorrectProblemsPage($r,$c); + } elsif($GoToPage eq 'student_assessment') { + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/statistics?reportselected=student_assessment', + text=>'Chart'}); + &Apache::lonstudentassessment::BuildStudentAssessmentPage($r,$c); + } elsif($GoToPage eq 'grading_analysis') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>'/adm/statistics?reportselected=grading_anaylsis', + text=>'Grading Analysis'}); + &Apache::longradinganalysis::build_grading_analysis_page($r,$c); + } + # + $r->print("
\n"); + } + $r->print(&Apache::loncommon::end_page()); + $r->rflush(); + # return OK; } + 1; + +####################################################### +####################################################### + +=pod + +=back + +=cut + +####################################################### +####################################################### + __END__