--- loncom/interface/lonstatistics.pm 2002/08/06 17:39:15 1.40 +++ loncom/interface/lonstatistics.pm 2004/01/15 03:18:19 1.93 @@ -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.93 2004/01/15 03:18:19 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,642 +25,1180 @@ # 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. + +=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::lonsubmissiontimeanalysis; + use Apache::lonproblemstatistics; + use Apache::lonstudentassessment; + use Apache::lonpercentage; + use Apache::lonmysql; +=over 4 + +=cut + +package Apache::lonstatistics; use strict; use Apache::Constants qw(:common :http); +use vars qw( + @FullClasslist + @Students + @Sections + @SelectedSections + %StudentData + @StudentDataOrder + @SelectedStudentData + $top_map + @Sequences + @SelectedMaps + @Assessments); + 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::lonproblemanalysis(); +use Apache::lonsubmissiontimeanalysis(); +use Apache::lonproblemstatistics(); +use Apache::lonstudentassessment(); +use Apache::lonpercentage; +use Apache::lonmysql; +use Apache::lonlocal; +use Time::HiRes; +####################################################### +####################################################### -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 $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 @SelectedSections + +=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(@SelectedSections); + undef(%StudentData); + undef(@SelectedStudentData); + undef($curr_student); + undef($prev_student); + undef($next_student); } -sub ProcessFormData{ - my ($cache)=@_; +####################################################### +####################################################### - $cache->{'reportKey'} = 'false'; +=pod - &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'; +=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 @SelectedSections + +=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($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'); + } + } + # + # Deal with instructors with restricted section access + if ($ENV{'request.course.sec'} !~ /^\s*$/) { + @SelectedSections = ($ENV{'request.course.sec'}); + } + # + # Set up %StudentData + @StudentDataOrder = qw/fullname username domain id section status/; + foreach my $field (@StudentDataOrder) { + $StudentData{$field}->{'title'} = $field; + $StudentData{$field}->{'base_width'} = length($field); + $StudentData{$field}->{'width'} = + $StudentData{$field}->{'base_width'}; + } + # + # get the status requested + my $requested_status = 'Active'; + $requested_status = $ENV{'form.Status'} if (exists($ENV{'form.Status'})); + # + # 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; + } + } + 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 (@SelectedSections) { + if ( (($sect eq 'all') || + ($section eq $sect)) && + (($studenthash->{'status'} eq $requested_status) || + ($requested_status eq 'Any')) + ){ + push (@Students,$studenthash); + 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 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; + @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'})) { + if (ref($ENV{'form.StudentData'}) eq 'ARRAY') { + @SelectedStudentData = @{$ENV{'form.StudentData'}}; + } else { + @SelectedStudentData = ($ENV{'form.StudentData'}); + } + } else { + @SelectedStudentData = ('username'); + } + foreach (@SelectedStudentData) { + if ($_ eq 'all') { + @SelectedStudentData = ('all'); + last; + } + } + # return; } + +####################################################### +####################################################### + =pod -=item &SortStudents() +=item get_students -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. +Returns a list of the selected students -=over 4 +=cut + +####################################################### +####################################################### +sub get_students { + if (! @Students) { + &PrepareClasslist() + } + return @Students; +} -Input: $students, $CacheData +####################################################### +####################################################### -$students: A array pointer to a list of students (username:domain) +=pod -$CacheData: A pointer to the hash tied to the cached data +=item ¤t_student() -Output: \@order +Returns a pointer to a hash containing data about the currently +selected student. -@order: An ordered list of students (username:domain) +=cut -=back +####################################################### +####################################################### +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 SortStudents { - my ($cache)=@_; +####################################################### +####################################################### +sub previous_student { + return $prev_student; +} + +####################################################### +####################################################### + +=pod + +=item &next_student() - my @students = split(':::',$cache->{'NamesOfStudents'}); - my @sorted1Students=(); - foreach (@students) { - if($cache->{'Status'} eq 'Any' || - $cache->{$_.':Status'} eq $cache->{'Status'}) { - push(@sorted1Students, $_); +Returns a pointer to a hash containing data about the next student +to be viewed. + +=cut + +####################################################### +####################################################### +sub next_student { + return $next_student; +} + +####################################################### +####################################################### + +=pod + +=item &clear_sequence_variables() + +=cut + +####################################################### +####################################################### +sub clear_sequence_variables { + undef($top_map); + undef(@Sequences); + undef(@Assessments); +} + +####################################################### +####################################################### + +=pod + +=item &SetSelectedMaps($elementname) + +Sets the @SelectedMaps array from $ENV{'form.'.$elementname}; + +=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'); } +} - my $sortBy = ''; - if(defined($cache->{'sort'})) { - $sortBy = ':'.$cache->{'sort'}; + +####################################################### +####################################################### + +=pod + +=item &Sequences_with_Assess() + +Returns an array containing the subset of @Sequences which contain +assessments. + +=cut + +####################################################### +####################################################### +sub Sequences_with_Assess { + my @Sequences_to_Show; + foreach my $map_symb (@SelectedMaps) { + foreach my $sequence (@Sequences) { + next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all'); + next if ($sequence->{'num_assess'} < 1); + push (@Sequences_to_Show,$sequence); + } } - my @order = sort { $cache->{$a.$sortBy} cmp $cache->{$b.$sortBy} || - $cache->{$a.':fullname'} cmp $cache->{$b.':fullname'} } - @sorted1Students; + return @Sequences_to_Show; +} + +####################################################### +####################################################### + +=pod + +=item &PrepareCourseData($r) - return \@order; +=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'}; + # + # Use 3 digits for each the sum and total, which means 7 total... + my $num_col = $num_parts+7; + if ($num_col < $name_length) { + $num_col = $name_length; + } + $seq->{'base_width'} = $name_length; + $seq->{'width'} = $num_col; + } + return; } +####################################################### +####################################################### + =pod -=item &SpaceColumns() +=item &log_sequence($sequence,$recursive,$padding) -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. +Write data about the sequence to a logfile. If $recursive is not +undef the data is written recursively. $padding is used for recursive +calls. -=over 4 +=cut -Input: $students, $studentInformation, $headings, $ChartDB +####################################################### +####################################################### +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; +} -$students: An array pointer to a list of students (username:domain) +############################################## +############################################## -$studentInformatin: The type of data for the student information. It is -used as part of the key in $CacheData. +=pod -$headings: The name of the student information columns. +=item &StudentDataSelect($elementname,$status,$numvisible,$selected) -$ChartDB: The name of the cache database which is opened for read/write. +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) -Output: None - All data stored in cache. +=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 &MapSelect($elementname,$status,$numvisible,$restriction) - # 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 html for a selection box allowing the user to choose one (or more) +of the sequences in the course. The values of the sequences are the symbs. +If the top sequence is selected, the value 'top' will result. + +=over 4 - if(!$isCached) { - my $processTopResourceMapReturn= - &Apache::loncoursedata::ProcessTopResourceMap(\%cache, $c, $r); - if($processTopResourceMapReturn ne 'OK') { - untie(%cache); - return $processTopResourceMapReturn; +=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 + +=item $restriction Code reference to subroutine which returns true or +false. The code must expect a reference to a sequence data structure. + +=back + +=cut + +############################################## +############################################## +sub MapSelect { + my ($elementname,$status,$numvisible,$restriction)=@_; + if ($numvisible < 1) { + return; + } + # + # Set up array of selected items + &SetSelectedMaps($elementname); + # + # Set up the restriction call + if (! defined($restriction)) { + $restriction = sub { 1; }; + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; + return $Str; +} - if($c->aborted()) { - untie(%cache); - return 'aborted'; - } +############################################## +############################################## + +=pod + +=item &SectionSelect($elementname,$status,$numvisible) - # Active is a temporary solution, remember to change - Apache::loncoursedata::ProcessClasslist(\%cache,$classlist,$courseID,$c); - if($c->aborted()) { - untie(%cache); - return 'aborted'; +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 and @SelectedSections +=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 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; +} + +####################################################### +####################################################### + +=pod + +=item &CreateAndParseOutputSelector() + +Construct a selection list of options for output and parse output selections. + +=cut - &ProcessFormData(\%cache); - my $students = &SortStudents(\%cache); - &SpaceColumns($students, $studentInformation, $headings, \%cache); - $cache{'updateTime:columnWidth'}=24; +####################################################### +####################################################### +sub OutputDescriptions { + my (@OutputOptions) = @_; + my $Str = ''; + $Str .= "

Output Modes

\n"; + $Str .= "
\n"; + foreach my $outputmode (@OutputOptions) { + $Str .="
".$outputmode->{'name'}."
\n"; + $Str .="
".$outputmode->{'description'}."
\n"; + } + $Str .= "
\n"; + return $Str; +} - if($cache{'download'} ne 'false') { - my $who = $cache{'download'}; - my $courseData = - &Apache::loncoursedata::DownloadCourseInformation( - $who, $courseID, - $cache{$who.':lastDownloadTime'}); - &Apache::loncoursedata::ProcessStudentData(\%cache, $courseData, $who); - $cache{'download'} = 'false'; - } elsif($cache{'DownloadAll'} ne 'false') { - $cache{'DownloadAll'} = 'false'; - my @allStudents; - if($cache{'DownloadAll'} eq 'sorted') { - @allStudents = @$students; +sub CreateAndParseOutputSelector { + my ($elementname,$default,@OutputOptions) = @_; + my $output_mode; + my $show; + my $Str = ''; + # + # Format for output options is 'mode, restrictions'; + my $selected = $default; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; } else { - @allStudents = split(':::', $cache{'NamesOfStudents'}); + $selected = $ENV{'form.'.$elementname}; } - &Create_PrgWin($r); - my $count=1; - foreach (@allStudents) { - &Update_PrgWin(scalar(@allStudents),$count,$_,$r); - my $courseData = - &Apache::loncoursedata::DownloadCourseInformation( - $_, $courseID, - $cache{$_.':lastDownloadTime'}); - &Apache::loncoursedata::ProcessStudentData(\%cache, $courseData, - $_); - if($c->aborted()) { - untie(%cache); - return 'aborted'; - } - $count++; + } + # + # Set package variables describing output mode + $output_mode = 'html'; + $show = 'all'; + foreach my $option (@OutputOptions) { + next if ($option->{'value'} ne $selected); + $output_mode = $option->{'mode'}; + $show = $option->{'show'}; + } + # + # Build the form element + $Str = qq/"; + return ($Str,$output_mode,$show); +} - if($c->aborted()) { - untie(%cache); - return 'aborted'; - } +############################################### +############################################### - untie(%cache); +=pod - return ('OK', $students); -} +=item &Gather_Student_Data() +Ensures all student data is up to date. -# Create progress -sub Create_PrgWin { - my ($r)=@_; - $r->print(< - popwin=open('','popwin','width=400,height=100'); - popwin.document.writeln(''+ - 'LON-CAPA Statistics'+ - '

Computation Progress

'+ - '
'+ - '
'+ - ''); - popwin.document.close(); - -ENDPOP +=cut +############################################### +############################################### +sub Gather_Student_Data { + my ($r) = @_; + my $c = $r->connection(); + # + &Apache::loncoursedata::clear_internal_caches(); + # + my @Sequences = &Apache::lonstatistics::Sequences_with_Assess(); + # + my @Students = @Apache::lonstatistics::Students; + # + # Open the progress window + my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Statistics Compilation Status', + 'Statistics Compilation Progress', scalar(@Students)); + # + while (my $student = shift @Students) { + return if ($c->aborted()); + my ($status,undef) = &Apache::loncoursedata::ensure_current_data + ($student->{'username'},$student->{'domain'}, + $ENV{'request.course.id'}); + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state, + &mt('last student')); + } + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); $r->rflush(); } -# update progress -sub Update_PrgWin { - my ($totalStudents,$index,$name,$r)=@_; - $r->print(''); - $r->rflush(); -} +############################################### +############################################### -# close Progress Line -sub Close_PrgWin { - my ($r)=@_; - $r->print(''); - $r->rflush(); -} +=pod +=item &Gather_Full_Student_Data() -sub BuildClasslist { - my ($cacheDB,$students,$studentInformation,$headings,$r)=@_; +Ensures all student data is up to date. - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - return 'Unable to tie database.'; +=cut + +############################################### +############################################### +sub Gather_Full_Student_Data { + my ($r) = @_; + my $c = $r->connection(); + # + &Apache::loncoursedata::clear_internal_caches(); + # + my @Students = @Apache::lonstatistics::Students; + # + # Open the progress window + my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,&mt('Student Data Compilation Status'), + &mt('Student Data Compilation Progress'), scalar(@Students)); + # + while (my $student = shift @Students) { + return if ($c->aborted()); + my ($status,undef) = &Apache::loncoursedata::ensure_current_full_data + ($student->{'username'},$student->{'domain'}, + $ENV{'request.course.id'}); + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state, + &mt('last student')); } + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + $r->rflush(); +} +################################################## +################################################## +sub DisplayClasslist { + my ($r)=@_; + # + my @Fields = ('fullname','username','domain','id','section'); + # my $Str=''; + if (! @Students) { + if ($SelectedSections[0] eq 'all') { + if (lc($ENV{'form.Status'}) eq 'any') { + $Str .= '

There are no students in the course.

'; + } elsif (lc($ENV{'form.Status'}) eq 'active') { + $Str .= '

There are no currently enrolled students in '. + 'the course.

'; + } elsif (lc($ENV{'form.Status'}) eq 'expired') { + $Str .= '

There are no previously enrolled '. + 'students in the course.

'; + } + } else { + my $sections; + if (@SelectedSections == 1) { + $sections = 'section '.$SelectedSections[0]; + } elsif (@SelectedSections > 2) { + $sections = 'sections '.join(', ',@SelectedSections); + $sections =~ s/, ([^,])*$/, and $1/; + } else { + $sections = 'sections '.join(' and ',@SelectedSections); + } + if (lc($ENV{'form.Status'}) eq 'any') { + $Str .= '

There are no students in '.$sections.'.

'; + } elsif (lc($ENV{'form.Status'}) eq 'active') { + $Str .= '

There are no currently enrolled students '. + 'in '.$sections.'.

'; + } elsif (lc($ENV{'form.Status'}) eq 'expired') { + $Str .= '

There are no previously enrolled students '. + 'in '.$sections.'.

'; + } + } + $Str.= ''. + '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 .= '

Click on a students name or username to view their chart

'; $Str .= '
'."\n"; $Str .= ''."\n"; - - my $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings(\%cache, - $studentInformation, - $headings, $displayString); + foreach my $field (@Fields) { + $Str .= ''; + } $Str .= ''."\n"; - - my $alternate=0; - foreach (@$students) { - my ($username, $domain) = split(':', $_); + # + my $alternate = 0; + foreach my $student (@Students) { # @Students is a package variable + my $sname = $student->{'username'}.':'.$student->{'domain'}; if($alternate) { $Str .= ''; } else { $Str .= ''; } $alternate = ($alternate + 1) % 2; - foreach my $data (@$studentInformation) { + # + foreach my $field (@Fields) { $Str .= ''."\n"; + $Str .= ''; } + $Str .= "\n"; } - - $Str .= ''."\n"; $Str .= '
DISPLAYDATA '.$field. + '
'; - if($data eq 'fullname') { + if ($field eq 'fullname' || $field eq 'username') { $Str .= ''; - $Str .= $cache{$_.':'.$data}.' '; + $Str .= &Apache::lonnet::escape('student_assessment'); + $Str .= '&sort='.&Apache::lonnet::escape($ENV{'form.sort'}); + $Str .= '&SelectedStudent='; + $Str .= &Apache::lonnet::escape($sname).'">'; + $Str .= $student->{$field}.' '; $Str .= ''; - } elsif($data eq 'updateTime') { - $Str .= ''; - $Str .= $cache{$_.':'.$data}.' '; - $Str .= ' '; } else { - $Str .= $cache{$_.':'.$data}.' '; + $Str .= $student->{$field}; } - - $Str .= '
'."\n"; + # $r->print($Str); $r->rflush(); - - untie(%cache); - + # return; } +############################################## +############################################## sub CreateMainMenu { - my ($status, $reports)=@_; - - my $Str = ''; - - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; - - $Str .= ''."\n"; - - $Str .= '
Analysis Reports:Student Status:
{'reportSelected'} eq $reports->{$_}) { - $Str .= ' selected=""'; - } - $Str .= '>'.$reports->{$_}.''."\n"; - } - $Str .= ''; - $Str .= &Apache::lonhtmlcommon::StatusOptions($status, 'Statistics'); - $Str .= '
'."\n"; - $Str .= '
'."\n"; - + # + # 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 Analysis'), + short_description => + &mt('Display and analysis of submission times on assessments.'), + }, +# { 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 BuildStatistics { - my ($r)=@_; - - 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', -# '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"; - - my ($returnValue, $students) = &PrepareData($c, $cacheDB, - \@studentInformation, - \@headings,$r); - if($returnValue ne 'OK') { - $r->print(''.$returnValue."\n".''); - return OK; - } - - 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'}; +############################################## +############################################## +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; } - - if(defined($cache{'OptionResponses'})) { - $reports{'problem_analysis'} = 'Problem Analysis'; + } + # + # 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 + $r->print(&Apache::lonhtmlcommon::Title('Course Statistics and Charts'). + &Apache::loncommon::help_open_faq(139). + &Apache::loncommon::help_open_bug('Statistics and Charts')); + $r->rflush(); + # + # Either print out a menu for them or send them to a report + if (! exists($ENV{'form.reportSelected'}) || + $ENV{'form.reportSelected'} eq '') { + $r->print(&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 '). + ''.$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(''); + 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('
print('method="post" action="/adm/statistics">'); - $r->print(&CreateMainMenu($cache{'Status'}, \%reports)); $r->rflush(); - untie(%cache); - } else { - $r->print('Unable to tie database.'); - return OK; - } - - if($GoToPage eq 'Activity Log') { - &Apache::lonproblemstatistics::Activity(); - } elsif($GoToPage eq 'Problem Statistics') { - &Apache::lonproblemstatistics::BuildProblemStatisticsPage($cacheDB, - $students, - $courseID, - $c,$r); - } elsif($GoToPage eq 'Problem Analysis') { - &Apache::lonproblemanalysis::BuildProblemAnalysisPage($cacheDB, $r); - } elsif($GoToPage eq 'Student Assessment') { - &Apache::lonstudentassessment::BuildStudentAssessmentPage($cacheDB, - $students, - $courseID, - 'Statistics', - \@headings, - $spacing, - \@studentInformation, - $r, $c); - } elsif($GoToPage eq 'Analyze') { - &Apache::lonproblemanalysis::BuildAnalyzePage($cacheDB, $students, - $courseID, $r); - } elsif($GoToPage eq 'DoDiffGraph' || $GoToPage eq 'PercentWrongGraph') { - &Apache::lonproblemstatistics::BuildGraphicChart($GoToPage,$r,$cacheDB); - } elsif($GoToPage eq 'Class list') { - &BuildClasslist($cacheDB, $students, \@studentInformation, - \@headings, $r); + # + my $GoToPage = $ENV{'form.reportSelected'}; + # + # Set up the statistics and chart environment + &PrepareCourseData($r); + # + $r->print(''); + if($GoToPage eq 'activitylog') { +# &Apache::lonproblemstatistics::Activity(); + } elsif($GoToPage eq 'problem_statistics') { + &Apache::lonproblemstatistics::BuildProblemStatisticsPage($r,$c); + } elsif($GoToPage eq 'problem_analysis') { + &Apache::lonproblemanalysis::BuildProblemAnalysisPage($r,$c); + } elsif($GoToPage eq 'submissiontime_analysis') { + &Apache::lonsubmissiontimeanalysis::BuildSubmissionTimePage($r,$c); + } elsif($GoToPage eq 'student_assessment') { + &Apache::lonstudentassessment::BuildStudentAssessmentPage($r,$c); + } elsif($GoToPage eq 'DoDiffGraph' || $GoToPage eq 'PercentWrongGraph') { +# &Apache::lonproblemstatistics::BuildGraphicChart($r,$c); + } elsif($GoToPage eq 'Correct-problems Plot') { + # &Apache::lonpercentage::BuildPercentageGraph($r,$c); + } + # + $r->print("
\n"); } - - $r->print(''."\n"); - $r->print("\n".''."\n".''); + $r->print("\n\n"); $r->rflush(); - + # return OK; } -# ================================================================ Main Handler - -sub handler { - my $r=shift; +1; -# $jr = $r; +####################################################### +####################################################### - 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; - } - - # 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'); - } - &Apache::loncommon::no_cache($r); - $r->send_http_header; - return OK; - } +=pod - unless($ENV{'request.course.fn'}) { - my $requrl=$r->uri; - $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; - return HTTP_NOT_ACCEPTABLE; - } +=back - $r->content_type('text/html'); - $r->send_http_header; +=cut - &BuildStatistics($r); +####################################################### +####################################################### - return OK; -} -1; __END__