--- loncom/interface/lonstatistics.pm 2002/10/21 00:19:39 1.52 +++ loncom/interface/lonstatistics.pm 2003/02/25 20:47:47 1.60 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstatistics.pm,v 1.52 2002/10/21 00:19:39 minaeibi Exp $ +# $Id: lonstatistics.pm,v 1.60 2003/02/25 20:47:47 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,16 +25,39 @@ # 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::lonproblemstatistics; + use Apache::lonstudentassessment; + use Apache::lonpercentage; + use GDBM_File; + +=over 4 + +=cut + +package Apache::lonstatistics; use strict; use Apache::Constants qw(:common :http); @@ -48,9 +70,435 @@ use Apache::lonproblemanalysis; use Apache::lonproblemstatistics; use Apache::lonstudentassessment; use Apache::lonpercentage; -use HTML::TokeParser; use GDBM_File; +use vars qw/@FullClasslist @Students @Sections @SelectedSections + $curr_student $prev_student $next_student + $top_map @Sequences @Assessments /; + +####################################################### +####################################################### + +=pod + +=item Package Variables + +=item @FullClasslist The full classlist + +=item @Students The students we are concerned with for this invocation + +=item @Sections The sections available in this class + +=item $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 @FullClasslist; +my @Students; +my @Sections; +my @SelectedSections; +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 $curr_student + +=item $prev_student + +=item $next_student + +=back + +=cut + +####################################################### +####################################################### +sub clear_classlist_variables { + undef(@FullClasslist); + undef(@Students); + undef(@Sections); + undef(@SelectedSections); + undef($curr_student); + undef($prev_student); + undef($next_student); +} + +####################################################### +####################################################### + +=pod + +=item &PrepareClasslist() + +Build up the classlist information. The classlist information is kept in +the following package variables: + +=over + +=item @FullClasslist + +=item @Students + +=item @Sections + +=item @SelectedSections + +=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 $r = shift; + my %Sections; + &clear_classlist_variables(); + # + # Retrieve the classlist + my $cid = $ENV{'request.course.id'}; + my $cdom = $ENV{'course.'.$cid.'.domain'}; + my $cnum = $ENV{'course.'.$cid.'.num'}; + my ($classlist,$field_names) = &Apache::loncoursedata::get_classlist($cid, + $cdom,$cnum); + if (exists($ENV{'form.Section'})) { + if (ref($ENV{'form.Section'})) { + @SelectedSections = @$ENV{'form.Section'}; + # Remove the empty sections + for (my $i=0; $i<=$#SelectedSections; $i++) { + if ($SelectedSections[$i] =~ /^\s*$/) { + splice(@SelectedSections,$i,1); + } + } + } else { + if ($ENV{'form.Section'} !~ /^\s*$/) { + @SelectedSections = ($ENV{'form.Section'}); + } + } + } + @SelectedSections = ('any') if (! @SelectedSections); + # + # Process the classlist + while (my ($student,$student_data) = each (%$classlist)) { + my $studenthash = (); + for (my $i=0; $i< scalar(@$field_names);$i++) { + $studenthash->{$field_names->[$i]}=$student_data->[$i]; + } + 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 'any') || ($section eq $sect)) { + push (@Students,$studenthash); + last; + } + } + } + # + # Put the consolidated section data in the right place + @Sections = sort {$a cmp $b} keys(%Sections); + # + # 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.... + if (exists($ENV{'form.StudentAssessmentStudent'})) { + my ($current_uname,$current_dom) = + split(':',$ENV{'form.StudentAssessmentStudent'}); + 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 ($i == 0) { + $prev_student = 'none'; + } else { + $prev_student = $Students[$i-1]; + } + if ($i == $#Students) { + $next_student = 'none'; + } else { + $next_student = $Students[$i+1]; + } + } +} + +####################################################### +####################################################### +# +# Course Sequences variables +# +my $top_map; +my @Sequences; +my @Assessments; + +####################################################### +####################################################### + +=pod + +=item &clear_sequence_variables() + +=cut + +####################################################### +####################################################### +sub clear_sequence_variables { + undef($top_map); + undef(@Sequences); + undef(@Assessments); +} + +####################################################### +####################################################### + +=pod + +=item &PrepareCourseData($r) + +=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 'HASH'); + +=pod + + ## + ## Debugging code + ## + foreach my $s (@Sequences) { + next if ($s->{'title'} ne 'Bioenergetics: Enzyme Regulation'); + &Apache::lonnet::logthis('-----------------------------------'); + &Apache::lonnet::logthis('title = '.$s->{'title'}); + &Apache::lonnet::logthis('symb = '.$s->{'symb'}); + &Apache::lonnet::logthis('num_assess = '.$s->{'num_assess'}); + foreach my $a (@{$s->{'contents'}}) { + &Apache::lonnet::logthis(' --------------------------------'); + &Apache::lonnet::logthis(' title = '.$a->{'title'}); + &Apache::lonnet::logthis(' symb = '.$a->{'symb'}); + } + } + +=cut + + return; +} + +############################################## +############################################## + +=pod + +=item &MapSelect($elementname,$status,$numvisible,$selected,$restriction) + +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 + +=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 $selected Array ref to the names of the already selected maps. +If undef, $ENV{'form.'.$elementname} is used. +If $ENV{'form.'.$elementname} is also empty, none will be selected. + +=item $restriction Code reference to subroutine which returns true or +false. The code must expect a reference to a sequence data structure. + +=back + +=cut + +############################################## +############################################## +sub MapSelect { + my ($elementname,$status,$numvisible,$selected,$restriction)=@_; + if ($numvisible < 1) { + return; + } + # + # Set up array of selected items + my @Selected; + if (! defined($selected)) { + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname})) { + @Selected = @$ENV{'form.'.$elementname}; + } else { + @Selected = ($ENV{'form.'.$elementname}); + } + } else { + @Selected = (); + } + } else { + if (ref($selected)) { + @Selected = @$selected; + } else { + @Selected = ($selected); + } + } + # + # Set up the restriction call + if (! defined($restriction)) { + $restriction = sub { 1; }; + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; + return $Str; +} + + +############################################## +############################################## + +=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. + +=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 + +=item $selected Array ref to the names of the already selected sections. +If undef, $ENV{'form.'.$elementname} is used. +If $ENV{'form.'.$elementname} is also empty, none will be selected. + +=item $restriction Code reference to subroutine which returns true or +false. The code must expect a reference to a sequence data structure. + +=back + +=cut + +############################################## +############################################## +sub SectionSelect { + my ($elementname,$status,$numvisible)=@_; + if ($numvisible < 1) { + return; + } + # + # Build the form element + my $Str = "\n"; + $Str .= '\n"; + return $Str; +} + +############################################## +############################################## sub CheckFormElement { my ($cache, $ENVName, $cacheName, $default)=@_; @@ -59,8 +507,9 @@ sub CheckFormElement { $cache->{$cacheName} = $ENV{'form.'.$ENVName}; } elsif(!defined($cache->{$cacheName})) { $cache->{$cacheName} = $default; + } else { + $ENV{'form.'.$ENVName} = $cache->{$cacheName}; } - return; } @@ -70,17 +519,29 @@ sub ProcessFormData{ $cache->{'reportKey'} = 'false'; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['sort','download', + ['download', 'reportSelected', 'StudentAssessmentStudent', 'ProblemStatisticsSort']); + &CheckFormElement($cache, 'DownloadAll', 'DownloadAll', 'false'); + if ($cache->{'DownloadAll'} ne 'false') { + # Clean the hell out of that cache! + # We cannot untie the hash at this scope (stupid libgd :( ) + # So, remove every single key. What a waste of time.... + # Of course, if you are doing this you are probably resigned + # to waiting a while. + &Apache::lonnet::logthis("Cleaning out the cache file"); + while (my ($key,undef)=each(%$cache)) { + next if ($key eq 'DownloadAll'); + delete($cache->{$key}); + } + } &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', @@ -245,9 +706,11 @@ sub SortStudents { my $sortBy = ''; if(defined($cache->{'sort'})) { $sortBy = ':'.$cache->{'sort'}; + } else { + $sortBy = ':fullname'; } - my @order = sort { $cache->{$a.$sortBy} cmp $cache->{$b.$sortBy} || - $cache->{$a.':fullname'} cmp $cache->{$b.':fullname'} } + my @order = sort { lc($cache->{$a.$sortBy}) cmp lc($cache->{$b.$sortBy}) || + lc($cache->{$a.':fullname'}) cmp lc($cache->{$b.':fullname'}) } @sorted1Students; return \@order; @@ -312,7 +775,7 @@ sub PrepareData { $isRecalculate=1; } - my $isCached = &Apache::loncoursedata::TestCacheData($cacheDB, + my $isCached = &Apache::loncoursedata::TestCacheData($cacheDB, $isRecalculate); if($isCached < 0) { return "Unable to tie hash to db file."; @@ -383,16 +846,16 @@ sub PrepareData { if($download ne 'false') { my @who = ($download); - if(&Apache::loncoursedata::DownloadStudentCourseData(\@who, 'false', - $cacheDB, 'true', + 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', + if(&Apache::loncoursedata::DownloadStudentCourseData(\@allStudents, + 'false', + $cacheDB, 'true', 'true', $courseID, $r, $c) ne 'OK') { return 'Stop at download all'; @@ -402,6 +865,54 @@ sub PrepareData { return ('OK', $students); } +sub DisplayClasslist { + my ($r)=@_; + # + my @Fields = ('fullname','username','domain','id','section'); + # + my $Str=''; + $Str .= '
'."\n"; + $Str .= ''."\n"; + foreach my $field (@Fields) { + $Str .= ''; + } + $Str .= ''."\n"; + # + my $alternate = 0; + foreach my $student (@Students) { + my $sname = $student->{'username'}.':'.$student->{'domain'}; + if($alternate) { + $Str .= ''; + } else { + $Str .= ''; + } + $alternate = ($alternate + 1) % 2; + # + foreach my $field (@Fields) { + $Str .= ''; + } + $Str .= "\n"; + } + $Str .= '
'.$field. + '
'; + if ($field eq 'fullname') { + $Str .= ''; + $Str .= $student->{$field}.' '; + $Str .= ''; + } else { + $Str .= $student->{$field}; + } + $Str .= '
'."\n"; + # + $r->print($Str); + $r->rflush(); + # + return; +} + sub BuildClasslist { my ($cacheDB,$students,$studentInformation,$headings,$r)=@_; @@ -410,19 +921,37 @@ sub BuildClasslist { return 'Unable to tie database.'; } +# my $Ptr = ''; +# $Ptr .= ''; +# $Ptr .= ''."\n"; +# $Ptr .= '
Select Sections'; +# $Ptr .= ''."\n"; +# my @sectionsSelected = split(':',$cache{'sectionsSelected'}); +# my @sections = split(':',$cache{'sectionList'}); +# $Ptr .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, +# \@sectionsSelected, +# 'Statistics'); +# $Ptr .= '

'; +# $r->print($Ptr); +# $r->rflush(); +# my %mySections = (); +# foreach (@sections) { $mySections{$_} = 'True'; } +# $r->print("
$cache{'sectionsSelected'}
"); + my $Str=''; $Str .= '
'."\n"; $Str .= ''."\n"; my $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings(\%cache, + $Str .= &Apache::lonhtmlcommon::CreateHeadings(\%cache, $studentInformation, $headings, $displayString); $Str .= ''."\n"; my $alternate=0; foreach (@$students) { +# if ($mySections{$cache{$_.':'.'section'}} ne 'True') {next;} my ($username, $domain) = split(':', $_); if($alternate) { $Str .= ''; @@ -470,8 +999,8 @@ sub CreateMainMenu { $Str .= '
DISPLAYDATA 
'."\n"; $Str .= ''."\n"; - $Str .= ''."\n"; - $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; $Str .= ''."\n"; $Str .= '
Analysis Reports:Student Status:
Select a ReportStudent Status
'Class list', 'problem_statistics' => 'Problem Statistics', 'student_assessment' => 'Student Assessment', - 'percentage' => 'Percentage Graphs', + 'percentage' => 'Correct-problems Plot', # 'activitylog' => 'Activity Log', 'reportSelected' => 'Class list'); @@ -526,15 +1054,15 @@ sub BuildStatistics { $r->print(&Apache::lonhtmlcommon::Title('Course Statistics and Charts')); - my ($returnValue, $students) = &PrepareData($c, $cacheDB, - \@studentInformation, + 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, + &Apache::loncoursedata::CheckForResidualDownload($cacheDB, 'true', 'true', $courseID, $r, $c); @@ -544,8 +1072,8 @@ sub BuildStatistics { if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { $GoToPage = $cache{'reportSelected'}; $reports{'reportSelected'} = $cache{'reportSelected'}; - if(defined($cache{'reportKey'}) && - !exists($reports{$cache{'reportKey'}}) && + if(defined($cache{'reportKey'}) && + !exists($reports{$cache{'reportKey'}}) && $cache{'reportKey'} ne 'false') { $reports{$cache{'reportKey'}} = $cache{'reportSelected'}; } @@ -567,9 +1095,9 @@ sub BuildStatistics { if($GoToPage eq 'Activity Log') { &Apache::lonproblemstatistics::Activity(); } elsif($GoToPage eq 'Problem Statistics') { - &Apache::lonproblemstatistics::BuildProblemStatisticsPage($cacheDB, - $students, - $courseID, + &Apache::lonproblemstatistics::BuildProblemStatisticsPage($cacheDB, + $students, + $courseID, $c,$r); } elsif($GoToPage eq 'Option Response Analysis') { &Apache::lonproblemanalysis::BuildProblemAnalysisPage($cacheDB, $r); @@ -583,7 +1111,7 @@ sub BuildStatistics { \@studentInformation, $r, $c); } elsif($GoToPage eq 'Analyze') { - &Apache::lonproblemanalysis::BuildAnalyzePage($cacheDB, $students, + &Apache::lonproblemanalysis::BuildAnalyzePage($cacheDB, $students, $courseID, $r); } elsif($GoToPage eq 'DoDiffGraph' || $GoToPage eq 'PercentWrongGraph') { my $courseDescription = $ENV{'course.'.$courseID.'.description'}; @@ -593,9 +1121,10 @@ sub BuildStatistics { $students, $courseID, $r, $c); } elsif($GoToPage eq 'Class list') { - &BuildClasslist($cacheDB, $students, \@studentInformation, - \@headings, $r); - } elsif($GoToPage eq 'Percentage Graphs') { + &DisplayClasslist($r); +# &BuildClasslist($cacheDB, $students, \@studentInformation, +# \@headings, $r); + } elsif($GoToPage eq 'Correct-problems Plot') { &Apache::lonpercentage::BuildPercentageGraph($cacheDB, $students, $courseID, $c, $r); } @@ -624,7 +1153,7 @@ sub handler { 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; + return HTTP_NOT_ACCEPTABLE; } # Set document type for header only @@ -642,16 +1171,30 @@ sub handler { unless($ENV{'request.course.fn'}) { my $requrl=$r->uri; $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; - return HTTP_NOT_ACCEPTABLE; + return HTTP_NOT_ACCEPTABLE; } $r->content_type('text/html'); $r->send_http_header; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sort']); + + &PrepareClasslist($r); + + &PrepareCourseData($r); + &BuildStatistics($r); return OK; } 1; + +=pod + +=back + +=cut + __END__