--- loncom/interface/lonstatistics.pm 2002/07/24 14:52:32 1.30
+++ loncom/interface/lonstatistics.pm 2013/03/06 11:39:00 1.157
@@ -1,7 +1,6 @@
# The LearningOnline Network with CAPA
-# (Publication Handler
#
-# $Id: lonstatistics.pm,v 1.30 2002/07/24 14:52:32 stredwic Exp $
+# $Id: lonstatistics.pm,v 1.157 2013/03/06 11:39:00 bisitz Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,523 +25,1143 @@
# 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 Behrouz Minaei
#
###
-package Apache::lonstatistics;
+
+
+package Apache::lonstatistics;
use strict;
use Apache::Constants qw(:common :http);
-use Apache::lonnet();
+use vars qw(
+ @FullClasslist
+ @Students
+ @Sections
+ @Groups
+ %StudentData
+ @StudentDataOrder
+ @SelectedStudentData
+ $enrollment_status);
+
+use Apache::lonnet;
use Apache::lonhomework;
use Apache::loncommon;
use Apache::loncoursedata;
use Apache::lonhtmlcommon;
-use Apache::lonproblemanalysis;
-use Apache::lonproblemstatistics;
-use Apache::lonstudentassessment;
-use Apache::lonchart;
-use HTML::TokeParser;
-use GDBM_File;
-
-my $r;
-my %color;
-
-sub CheckFormElement {
- my ($cache, $ENVName, $cacheName, $default)=@_;
-
- if(defined($ENV{'form.'.$ENVName})) {
- $cache->{$cacheName} = $ENV{'form.'.$ENVName};
- } elsif(!defined($cache->{$cacheName})) {
- $cache->{$cacheName} = $default;
- }
+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 Apache::lonstudentsubmissions();
+use Apache::lonsurveyreports();
+use Apache::longradinganalysis();
+use Apache::lonquickgrades();
+use LONCAPA;
+
+#
+# Classlist variables
+#
+my $curr_student;
+my $prev_student;
+my $next_student;
- return;
-}
-sub ProcessFormData{
- my ($cache)=@_;
+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);
+}
- $cache->{'reportKey'} = 'false';
- &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');
-
- 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';
+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 {
- $cache->{'StudentAssessmentMove'} = 'selected';
+ @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];
+ }
+ }
}
- &CheckFormElement($cache, 'StudentAssessmentMap', 'StudentAssessmentMap',
- 'All Maps');
- &CheckFormElement($cache, 'StudentAssessmentStudent',
- 'StudentAssessmentStudent', 'All Students');
- $cache->{'StudentAssessmentStudent'} =
- &Apache::lonnet::unescape($cache->{'StudentAssessmentStudent'});
-
- foreach (keys(%ENV)) {
- if(/form\.Analyze:::/) {
-# $cache->{'reportSelected'} = 'Analyze';
-# $cache->{'reportKey'} = 'Problem Analysis';
- my ($uri, $title, $part, $problem);
- (undef, $uri, $title, $part, $problem)=split(':::', $_);
- $cache->{'AnalyzeURI'} = $uri;
- $cache->{'AnalyzeTitle'} = $title;
- $cache->{'AnalyzePart'} = $part;
- $cache->{'AnalyzeProblem'} = $problem;
-
- &CheckFormElement($cache, 'Interval', 'Interval', '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;
+}
- # Select page to display
- if(defined($ENV{'form.ProblemStatistics'}) ||
- defined($ENV{'form.ProblemStatisticsRecalculate'}) ||
- defined($ENV{'form.DisplayCSVFormat'})) {
- $cache->{'GoToPage'} = 'ProblemStatistics';
- &CheckFormElement($cache, 'DisplayCSVFormat',
- 'DisplayFormat', 'Display Table Format');
- &CheckFormElement($cache, 'Ascend','ProblemStatisticsAscend',
- 'Ascending');
- &CheckFormElement($cache, 'Maps', 'ProblemStatisticsMap',
- 'All Maps');
- } elsif(defined($ENV{'form.ProblemAnalysis'})) {
- $cache->{'GoToPage'} = 'ProblemAnalysis';
- &CheckFormElement($cache, 'Interval', 'Interval', '1');
- } elsif(defined($ENV{'form.DoDiffGraph'})) {
- $cache->{'GoToPage'} = 'DoDiffGraph';
- } elsif(defined($ENV{'form.PercentWrongGraph'})) {
- $cache->{'GoToPage'} = 'PercentWrongGraph';
- } elsif(defined($ENV{'form.ActivityLog'})) {
- $cache->{'GoToPage'} = 'ActivityLog';
- } else {
- $cache->{'GoToPage'} = 'Menu';
+
+sub get_selected_sections {
+ my @selected_sections =
+ &Apache::loncommon::get_env_multiple('form.Section');
+ @selected_sections = ('all') if (! @selected_sections);
+ foreach (@selected_sections) {
+ if ($_ eq 'all') {
+ @selected_sections = ('all');
+ }
}
+ #
+ # Deal with instructors with restricted section access
+ if ($env{'request.course.sec'} !~ /^\s*$/) {
+ @selected_sections = ($env{'request.course.sec'});
+ }
+ return @selected_sections;
+}
- &CheckFormElement($cache, 'Status', 'Status', 'Active');
- return;
+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
-=item &SortStudents()
+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($env{'form.Status'}.' access status.');
+ } elsif ($mode eq 'plaintext') {
+ $description .= ' '.$env{'form.Status'}.' access status.';
+ }
+ return $description;
+}
-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.
-=over 4
-Input: $students, $CacheData
-$students: A array pointer to a list of students (username:domain)
+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($phrases{$type}{single}.' [_1].',$items[0]);
+ } elsif ($mode eq 'plaintext') {
+ $text = $phrases{$type}{single}.' '.$items[0].'.';
-$CacheData: A pointer to the hash tied to the cached data
+ }
+ } elsif (scalar(@items) && $items[0] eq 'all') {
+ if ($mode eq 'localized') {
+ $text = &mt($phrases{$type}{all}.'.');
+ } elsif ($mode eq 'plaintext') {
+ $text = $phrases{$type}{all}.'.';
+ }
+ } elsif (scalar(@items)) {
+ my $lastitem = pop(@items);
+ if ($mode eq 'localized') {
+ $text = &mt($phrases{$type}{plural}.' [_1] and [_2].',
+ join(', ',@items),$lastitem);
+ } elsif ($mode eq 'plaintext') {
+ $text = $phrases{$type}{plural}.' '.join(', ',@items).' and '.
+ $lastitem.'.';
+ }
+ }
+ return $text;
+}
-Output: \@order
-@order: An ordered list of students (username:domain)
+sub get_students {
+ if (! @Students) {
+ &PrepareClasslist()
+ }
+ return @Students;
+}
-=back
-=cut
-sub SortStudents {
- my ($cache)=@_;
+sub current_student {
+ return $curr_student;
+}
- my @students = split(':::',$cache->{'NamesOfStudents'});
- my @sorted1Students=();
- foreach (@students) {
- if($cache->{'Status'} eq 'Any' ||
- $cache->{$_.':Status'} eq $cache->{'Status'}) {
- push(@sorted1Students, $_);
- }
- }
- 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;
- return \@order;
+sub previous_student {
+ return $prev_student;
}
-sub PrepareData {
- my ($c, $cacheDB)=@_;
- # Test for access to the cache data
- my $courseID=$ENV{'request.course.id'};
- my $isRecalculate=0;
- if(defined($ENV{'form.Recalculate'})) {
- $isRecalculate=1;
- }
- my $isCached = &Apache::loncoursedata::TestCacheData($cacheDB,
- $isRecalculate);
- if($isCached < 0) {
- return "Unable to tie hash to db file.";
- }
+sub next_student {
+ return $next_student;
+}
+
- # 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.";
- }
- if(!$isCached) {
- my $processTopResourceMapReturn=
- &Apache::loncoursedata::ProcessTopResourceMap(\%cache, $c);
- if($processTopResourceMapReturn ne 'OK') {
- untie(%cache);
- return $processTopResourceMapReturn;
+sub StudentDataSelect {
+ my ($elementname,$status,$numvisible)=@_;
+ if ($numvisible < 1) {
+ return;
+ }
+ #
+ # Build the form element
+ my $Str = "\n";
+ $Str .= '<select name="'.$elementname.'" ';
+ if ($status ne 'single') {
+ $Str .= 'multiple="multiple" ';
+ }
+ $Str .= 'size="'.$numvisible.'" >'."\n";
+ #
+ # Deal with 'all'
+ $Str .= ' <option value="all"';
+ foreach (@SelectedStudentData) {
+ if ($_ eq 'all') {
+ $Str .= ' selected="selected"';
+ last;
}
}
-
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
+ $Str .= '>'.&mt('all')."</option>\n";
+ #
+ # Loop through the student data fields
+ foreach my $item (@StudentDataOrder) {
+ $Str .= ' <option value="'.$item.'"';
+ foreach (@SelectedStudentData) {
+ if ($item eq $_ ) {
+ $Str .= ' selected="selected"';
+ last;
+ }
+ }
+ $Str .= '>'.&mt($item)."</option>\n";
}
+ $Str .= "</select>\n";
+ return $Str;
+}
- 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.";
+
+
+sub get_selected_maps {
+ my ($elementname) = @_;
+ my @selected_maps =
+ &Apache::loncommon::get_env_multiple('form.'.$elementname);
+ @selected_maps = ('all') if (! @selected_maps);
+ foreach my $map (@selected_maps) {
+ if ($map eq 'all') {
+ @selected_maps = ('all');
+ last;
}
}
+ return @selected_maps;
+}
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
- }
- # Active is a temporary solution, remember to change
- Apache::loncoursedata::ProcessClasslist(\%cache,$classlist,$courseID,$c);
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
- }
- &ProcessFormData(\%cache);
- my $students = &SortStudents(\%cache);
- 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') {
- my @allStudents;
- if($cache{'DownloadAll'} eq 'sorted') {
- @allStudents = @$students;
- } else {
- @allStudents = split(':::', $cache{'NamesOfStudents'});
+sub selected_sequences_with_assessments {
+ my ($mode) = @_;
+ $mode = 'selected' if (! defined($mode));
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ if (!defined($navmap)) {
+ return ('Can not open Coursemap');
+ }
+ #
+ my @sequences = $navmap->retrieveResources(undef,
+ sub { shift->is_map(); },1,0,1);
+ my $toplevelseq = $navmap->getById('0.0');
+ if (!grep(/^\Q$toplevelseq\E$/,@sequences)) {
+ unshift(@sequences,$toplevelseq);
+ }
+
+ my @sequences_with_assessments;
+ foreach my $sequence (@sequences) {
+ if ($navmap->hasResource($sequence,sub { shift->is_problem(); },0,1)){
+ push(@sequences_with_assessments,$sequence);
}
- foreach (@allStudents) {
- my $courseData =
- &Apache::loncoursedata::DownloadCourseInformation(
- $_, $courseID,
- $cache{$_.':lastDownloadTime'});
- &Apache::loncoursedata::ProcessStudentData(\%cache, $courseData,
- $_);
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
+ }
+ #
+ my @sequences_to_show;
+ foreach my $sequence (@sequences_with_assessments) {
+ if ($mode eq 'all') {
+ push (@sequences_to_show,$sequence);
+ } elsif ($mode eq 'selected') {
+ foreach my $map_symb (&get_selected_maps('Maps')) {
+ if ($sequence->symb eq $map_symb || $map_symb eq 'all'){
+ push (@sequences_to_show,$sequence);
+ last; # Only put it in once
+ }
}
}
- $cache{'DownloadAll'} = 'false';
+
}
+ return $navmap,@sequences_to_show;
+}
+
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
+sub map_select {
+ my ($elementname,$status,$numvisible)=@_;
+ if ($numvisible < 1) {
+ return;
+ }
+ #
+ # Set up array of selected items
+ my @selected_maps = &get_selected_maps($elementname);
+ #
+ # Build the form element
+ my $form = "\n";
+ $form .= '<select name="'.$elementname.'" ';
+ if ($status ne 'single') {
+ $form .= 'multiple="multiple" ';
+ }
+ $form .= 'size="'.$numvisible.'" >'."\n";
+ #
+ # Put in option for 'all'
+ $form .= ' <option value="all"';
+ if ($selected_maps[0] eq 'all') {
+ $form .= ' selected="selected"';
+ }
+ $form .= ">all</option>\n";
+ #
+ # Loop through the sequences
+ my @sequences = &selected_sequences_with_assessments('all');
+ my $navmap;
+ if (!ref($sequences[0])) {
+ return $sequences[0];
+ } else {
+ $navmap = shift(@sequences);
}
+ foreach my $seq (@sequences){
+ $form .= ' <option value="'.$seq->symb.'"';
+ foreach (@selected_maps) {
+ if ($seq->symb eq $_) {
+ $form .= ' selected="selected"';
+ last;
+ }
+ }
+ $form .= '>'.$seq->compTitle."</option>\n";
+ }
+ $form .= "</select>\n";
+ return $form;
+}
+
- if($c->aborted()) {
- untie(%cache);
- return 'aborted';
+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 .= '<select name="'.$elementname.'" ';
+ if ($status ne 'single') {
+ $Str .= 'multiple="multiple" ';
+ }
+ $Str .= 'size="'.$numvisible.'" >'."\n";
+ #
+ # Loop through the sequences
+ foreach my $s (@Sections) {
+ $Str .= ' <option value="'.$s.'"';
+ foreach (&get_selected_sections()) {
+ if ($s eq $_) {
+ $Str .= ' selected="selected"';
+ last;
+ }
+ }
+ $Str .= '>'.$s."</option>\n";
}
+ $Str .= "</select>\n";
+ return $Str;
+}
- untie(%cache);
- return ('OK', $students);
+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 .= '<select name="'.$elementname.'" ';
+ if ($status ne 'single') {
+ $Str .= 'multiple="multiple" ';
+ }
+ $Str .= 'size="'.$numvisible.'" >'."\n";
+ #
+ # Loop through the groups
+ foreach my $s (@Groups) {
+ $Str .= ' <option value="'.$s.'"';
+ foreach my $group (&get_selected_groups()) {
+ if ($s eq $group) {
+ $Str .= ' selected="selected"';
+ last;
+ }
+ }
+ $Str .= '>'.$s."</option>\n";
+ }
+ $Str .= "</select>\n";
}
-# Create progress
-sub Create_PrgWin {
- $r->print(<<ENDPOP);
- <script>
- popwin=open('','popwin','width=400,height=100');
- popwin.document.writeln('<html><body bgcolor="#88DDFF">'+
- '<title>LON-CAPA Statistics</title>'+
- '<h4>Computation Progress</h4>'+
- '<form name=popremain>'+
- '<input type=text size=35 name=remaining value=Starting></form>'+
- '</body></html>');
- popwin.document.close();
- </script>
-ENDPOP
+
+
+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 .= '<p><table cellspacing="5">'."\n";
+ $Str .= '<tr>';
+ $Str .= '<th align="center"><b>'.&mt('Sections').'</b></th>';
+ $Str .= '<th align="center"><b>'.&mt('Groups').'</b></th>';
+ $Str .= '<th align="center"><b>'.&mt('Access Status').'</b></th>';
+ $Str .= '</tr>'.$/;
+ $Str .= '<tr>';
+ $Str .= '<td>'.
+ &Apache::lonstatistics::SectionSelect('Section','multiple',5).
+ '</td>';
+ $Str .= '<td>'.
+ &Apache::lonstatistics::GroupSelect('Group','multiple',5).
+ '</td>';
+ $Str .= '<td>'.
+ &Apache::lonhtmlcommon::StatusOptions(undef,undef,5).
+ '</td>';
+
+ $Str .= '</tr>'.$/;
+ $Str .= '</table></p>';
+ $Str .= '<input type="submit" name="selectstudent" value="'.
+ &mt('Update Display').'" />';
+ $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 .= '<p class="LC_info">'.
+ &mt('There are no currently enrolled students in the course.').
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'expired') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no previously enrolled students in the course.').
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'future') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students with future access in the course.').
+ '</p>';
+ } else { # 'any' and any others
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students in the course.').
+ '</p>';
+ }
+ } else {
+ if (lc($env{'form.Status'}) eq 'active') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no currently enrolled students in the selected sections.').
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'expired') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no previously enrolled students in the selected sections.').
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'future') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students with future access in the selected sections.').
+ '</p>';
+ } else { # 'any' and any others
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students in the selected sections.').
+ '</p>';
+ }
+ }
+ $Str.= '<p>'
+ .'<a href="/adm/statistics?reportSelected=student_assessment">'
+ .&mt('Return to the chart').'</a>'
+ .'</p>';
+ $r->print($Str);
+ $r->rflush();
+ return;
+ }
+
+ $Str .= '<h2>'.&mt('Select One Student').'</h2>'
+ .'<p>'.&mt("Click on a student's name or username to view their chart.").'</p>'
+ .&Apache::loncommon::start_data_table()
+ .&Apache::loncommon::start_data_table_header_row();
+ foreach my $field (@Fields) {
+ $Str .= '<th><a href="/adm/statistics?'.
+ 'reportSelected=student_assessment&'.
+ 'selectstudent=1&'.
+ 'sort='.$field.'">'.&mt($field).
+ '</a></th>';
+ }
+ $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 .= '<td>';
+ if ($field eq 'fullname' || $field eq 'username') {
+ $Str .= '<a href="/adm/statistics?reportSelected=';
+ $Str .= &escape('student_assessment');
+ $Str .= '&sort='.&escape($env{'form.sort'});
+ $Str .= '&SelectedStudent=';
+ $Str .= &escape($sname).'">';
+ $Str .= $student->{$field};
+ $Str .= '</a>';
+ } elsif ($field eq 'status') {
+ $Str .= &mt($student->{$field});
+ } else {
+ if ($student->{$field} eq 'none') {
+ $Str .= &mt('none')
+ } else {
+ $Str .= $student->{$field};
+ }
+ }
+ $Str .= '</td>';
+ }
+ $Str .= &Apache::loncommon::end_data_table_row();
+ }
+ $Str .= &Apache::loncommon::end_data_table();
+ #
+ $r->print($Str);
+ $r->rflush();
+ #
+ return;
}
-# update progress
-sub Update_PrgWin {
- my ($totalStudents,$index,$name)=@_;
- $r->print('<script>popwin.document.popremain.remaining.value="'.
- 'Computing '.$index.'/'.$totalStudents.': '.
- $name.'";</script>');
- $r->rflush();
+
+
+sub CreateMainMenu {
+ #
+ # Define menu data
+ my @reports = (
+ {categorytitle => 'Statistics and Analyses',
+ items => [
+ {url => '/adm/statistics?reportSelected=problem_statistics',
+ permission => 'F',
+ icon => 'document-open.png',
+ linktext => ('Overall Problem Statistics'),
+ linktitle => ('Student performance statistics on all problems.')},
+
+ {url => '/adm/statistics?reportSelected=problem_analysis',
+ permission => 'F',
+ icon => 'prob_ana.png',
+ linktext => ('Detailed Problem Analysis'),
+ linktitle => ('Detailed statistics and graphs of student performance on problems.')},
+ ]},
+ {categorytitle => 'Plots',
+ items => [
+ {url => '/adm/statistics?reportSelected=submissiontime_analysis',
+ permission => 'F',
+ icon => 'subtimpl.png',
+ linktext => ('Submission Time Plots'),
+ linktitle => ('Display and analysis of submission times on assessments.')},
+
+ {url => '/adm/statistics?reportSelected=correct_problems_plot',
+ permission => 'F',
+ icon => 'coprplot.png',
+ linktext => ('Correct Problems Plot'),
+ linktitle => ('Display a histogram of student performance in the course.')},
+ ]},
+ {categorytitle => 'Reports',
+ items => [
+ {url => '/adm/statistics?reportSelected=student_submission_reports',
+ permission => 'F',
+ icon => 'edit-copy.png',
+ linktext => ('Student Submission Reports'),
+ linktitle => ('Prepare reports of student submissions.')},
+
+ {url => '/adm/statistics?reportSelected=survey_reports',
+ permission => 'F',
+ icon => 'survey_rep.png',
+ linktext => ('Survey Reports'),
+ linktitle => ('Prepare reports on survey results.')},
+ ]});
+
+return &Apache::lonhtmlcommon::generate_menu(@reports);
+
}
-# close Progress Line
-sub Close_PrgWin {
- $r->print('<script>popwin.close()</script>');
- $r->rflush();
-}
-
-# For loading the colored table for display or un-colored for print
-sub setbgcolor {
- my $PrintTable=shift;
- undef %color;
- if ($PrintTable){
- $color{"gb"}="#FFFFFF";
- $color{"red"}="#FFFFFF";
- $color{"yellow"}="#FFFFFF";
- $color{"green"}="#FFFFFF";
- $color{"purple"}="#FFFFFF";
+
+
+sub handler {
+ my $r=shift;
+ my $c = $r->connection();
+ #
+ # 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 = <<ENDSTYLE;
+<style type="text/css">
+ 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; }
+</style>
+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'));
+ &Apache::lonquickgrades::startGradeScreen($r,'statistics');
+ $r->print(&CreateMainMenu());
} else {
- $color{"gb"}="#DDFFFF";
- $color{"red"}="#FFDDDD";
- $color{"yellow"}="#EEFFCC";
- $color{"green"}="#DDFFDD";
- $color{"purple"}="#FFDDFF";
+ #
+ if (! &Apache::lonmysql::verify_sql_connection()) {
+ my $serveradmin = $r->dir_config('lonAdmEMail');
+ $r->print('<p class="LC_error">'.
+ &mt('Unable to connect to database!').
+ '</p>');
+ $r->print('<p>'
+ .&mt('Please notify the server administrator [_1]',
+ ,'<b>'.$serveradmin.'</b>')
+ .'</p>');
+ $r->print('<p>'.
+ &mt('Course Statistics and Charts cannot be '.
+ 'retrieved until the database is restarted. '.
+ 'Your data is intact but cannot be displayed '.
+ 'at this time.').'</p>');
+ $r->print(&Apache::loncommon::end_page());
+ return;
+ }
+ #
+ # Clean out the caches
+ if (exists($env{'form.ClearCache'})) {
+ &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
+ }
+ #
+ my $GoToPage = $env{'form.reportSelected'};
+ #
+ # Begin form output
+ $r->print('<form name="Statistics" ');
+ if ($GoToPage eq 'student_submission_reports') {
+ $r->print('onsubmit="return checkanon();" ');
+ }
+ $r->print('method="post" action="/adm/statistics">');
+ $r->rflush();
+ $r->print('<input type="hidden" name="reportSelected" value="'.
+ $GoToPage.'" />');
+ 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("</form>\n");
}
-
- return;
+ &Apache::lonquickgrades::endGradeScreen($r);
+ $r->print(&Apache::loncommon::end_page());
+ $r->rflush();
+ #
+ return OK;
}
-sub BuildClasslist {
- my ($cacheDB,$students,$studentInformation,$headings,$spacePadding)=@_;
+1;
+
+__END__
- my %cache;
- unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {
- return '<html><body>Unable to tie database.</body></html>';
- }
-
- my $Str='';
- $Str .= '<table border="0"><tr><td bgcolor="#777777">'."\n";
- $Str .= '<table border="0" cellpadding="3"><tr bgcolor="#e6ffff">'."\n";
-
- my $displayString = '<td align="left"><a href="/adm/statistics?';
- $displayString .= 'sort=LINKDATA">DISPLAYDATA </a></td>'."\n";
- $Str .= &Apache::lonhtmlcommon::CreateStudentInformationHeadings(\%cache,
- $studentInformation,
- $headings,
- $displayString);
- $Str .= '<td align="left">';
- $Str .= '<a href="/adm/statistics?sort=lastDownloadTime">';
- $Str .= 'Last Updated </a></td>'."\n";
- $Str .= '</tr>'."\n";
- my $alternate=0;
- foreach (@$students) {
- my ($username, $domain) = split(':', $_);
- if($alternate) {
- $Str .= '<tr bgcolor="#ffffe6"><td>';
- } else {
- $Str .= '<tr bgcolor="#ffffc6"><td>';
- }
- $alternate = ($alternate + 1) % 2;
- foreach my $data (@$studentInformation) {
- if($data eq 'fullname') {
- $Str .= '<a href="/adm/statistics?reportSelected=';
- $Str .= &Apache::lonnet::escape('Student Assessment');
- $Str .= '&StudentAssessmentStudent=';
- $Str .= &Apache::lonnet::escape($cache{$_.':'.$data}).'">';
- #$Str .= 'Student Assessment'.'">';
- }
+=pod
- $Str .= $cache{$_.':'.$data}.' ';
+=head1 NAME
- if($data eq 'fullname') {
- $Str .= '</a>';
- }
+lonstatistics
- $Str .= '</td><td>';
- }
+=head1 SYNOPSIS
- $Str .= '<a href="/adm/statistics?download='.$_.'">';
- my $downloadTime = $cache{$_.':lastDownloadTime'};
- if($downloadTime ne 'Not downloaded') {
- $downloadTime = localtime($downloadTime);
- }
- $Str .= $downloadTime;
+Main handler for statistics and chart.
- $Str .= ' </a></td></tr>'."\n";
- }
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
- $Str .= '</table></td></tr></table>'."\n";
- untie(%cache);
+=head1 PACKAGE VARIABLES
- return $Str;
-}
+=over
-sub BuildStatistics {
- my ($r)=@_;
+=item @FullClasslist The full classlist
- my $c = $r->connection;
- my @studentInformation=('fullname','section','id','domain','username');
- my @headings=('Full Name', 'Section', 'PID', 'Domain', 'User Name');
- my $spacePadding = ' ';
- my %reports = ('classlist' => 'Class list',
- 'problem_statistics' => 'Problem Statistics',
- 'student_assessment' => 'Student Assessment',
- '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";
-
- &setbgcolor(0);
- my ($returnValue, $students) = &PrepareData($c, $cacheDB);
- if($returnValue ne 'OK') {
- $r->print('<html><body>'.$returnValue."\n".'</body></html>');
- return OK;
- }
-
- my $GoToPage;
- if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {
- $GoToPage = $cache{'reportSelected'};
- $reports{'reportSelected'} = $cache{'reportSelected'};
-# if(defined($cache{'reportKey'}) && $cache{'reportKey'} ne 'false') {
-# $reports{$cache{'reportKey'}} = $cache{'reportSelected'};
-# }
+=item @Students The students we are concerned with for this invocation
- if(defined($cache{'OptionResponses'})) {
- $reports{'problem_analysis'} = 'Problem Analysis';
- }
+=item @Sections The sections available in this class
- $r->print(&Apache::lonhtmlcommon::Title('LON-CAPA Statistics'));
- $r->print('<form name="Statistics" ');
- $r->print('method="post" action="/adm/statistics">');
- $r->print(&Apache::lonhtmlcommon::CreateStatisticsMainMenu(
- $cache{'Status'},
- \%reports));
- untie(%cache);
- } else {
- $r->print('<html><body>Unable to tie database.</body></html>');
- return OK;
- }
+=item @Groups The groups available in the class
- if($GoToPage eq 'Activity Log') {
- &Apache::lonproblemstatistics::Activity();
- } elsif($GoToPage eq 'Problem Statistics') {
- $r->print(
- &Apache::lonproblemstatistics::BuildProblemStatisticsPage($cacheDB,
- $students,
- $courseID,
- $c,$r));
- } elsif($GoToPage eq 'Problem Analysis') {
- $r->print(
- &Apache::lonproblemanalysis::BuildProblemAnalysisPage($cacheDB));
- } elsif($GoToPage eq 'Student Assessment') {
- $r->print(
- &Apache::lonstudentassessment::BuildStudentAssessmentPage($cacheDB,
- $students,
- $courseID,
- $c));
- } elsif($GoToPage eq 'Analyze') {
- $r->print(&Apache::lonproblemanalysis::BuildAnalyzePage($cacheDB,
- $students,
- $courseID));
- } elsif($GoToPage eq 'DoDiffGraph') {
- &Apache::lonproblemstatistics::BuildDiffGraph($courseID);
- } elsif($GoToPage eq 'PercentWrongGraph') {
- &Apache::lonproblemstatistics::BuildWrongGraph($courseID);
- } elsif($GoToPage eq 'Class list') {
- $r->print(&BuildClasslist($cacheDB, $students, \@studentInformation,
- \@headings, $spacePadding));
- }
+=item $curr_student The student currently being examined
- $r->print('</form>'."\n");
- $r->print("\n".'</body>'."\n".'</html>');
- $r->rflush();
+=item $prev_student The student previous in the classlist
- return OK;
-}
+=item $next_student The student next in the classlist
-# ================================================================ Main Handler
+=back
-sub handler {
- $r=shift;
+=head1 SUBROUTINES
- 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;
- }
+=over
- # 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;
- }
+=item &clear_classlist_variables()
- unless($ENV{'request.course.fn'}) {
- my $requrl=$r->uri;
- $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
- return HTTP_NOT_ACCEPTABLE;
- }
+undef the following package variables:
- $r->content_type('text/html');
- $r->send_http_header;
+=over 4
- &BuildStatistics($r);
+=item * @FullClasslist
+
+=item * @Students
+
+=item * @Sections
+
+=item * @Groups
+
+=item * %StudentData
+
+=item * @StudentDataOrder
+
+=item * @SelectedStudentData
+
+=item * $curr_student
+
+=item * $prev_student
+
+=item * $next_student
+
+=back
+
+=item &PrepareClasslist()
+
+Build up the classlist information. The classlist information is kept in
+the following package variables:
+
+=over 4
+
+=item * @FullClasslist
+
+=item * @Students
+
+=item * @Sections
+
+=item * @Groups
+
+=item * %StudentData
+
+=item * @SelectedStudentData
+
+=item * $curr_student
+
+=item * $prev_student
+
+=item * $next_student
+
+=back
+
+$curr_student, $prev_student, and $next_student may not be defined, depending
+upon the calling context.
+
+=item get_selected_sections()
+
+Returns an array of the selected sections
+
+=item get_selected_groups()
+
+Returns an array of the selected groups
+
+=item §ion_and_enrollment_description()
+
+Returns a string describing the currently selected section(s), group(s) and
+access status.
+
+Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized')
+ 'plaintext' is used for example in Excel spreadsheets.
+Returns: scalar description string.
+
+=item section_or_group_text()
+
+=item get_students()
+
+Returns a list of the selected students
+
+=item ¤t_student()
+
+Returns a pointer to a hash containing data about the currently
+selected student.
+
+=item &previous_student()
+
+Returns a pointer to a hash containing data about the student prior
+in the list of students. Or something.
+
+=item &next_student()
+
+Returns a pointer to a hash containing data about the next student
+to be viewed.
+
+=item &StudentDataSelect($elementname,$status,$numvisible,$selected)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the fields of student data available (fullname, username, id, section, etc)
+
+=over 4
+
+=item * $elementname The name of the HTML form element
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=item &get_selected_maps($elementname)
+
+Input: Name of the <select> form element used to specify the maps.
+
+Returns: Array of symbs of selected maps or the description 'all'.
+ If form.$elementname does not exist, 'all' is returned.
+
+=item &selected_sequences_with_assessments()
+
+Retrieve the sequences which were selected by the user to show.
+
+Input: $mode: scalar. Either 'selected' or 'all'. If not specified,
+ 'selected' is used.
+
+Returns: an array containing a navmap object and navmap resources,
+ or an array containing a scalar with an error message.
+
+=item &map_select($elementname,$status,$numvisible,$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
+
+=back
+
+=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
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=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
+
+=item CreateMainMenu()
+
+=back
+
+=cut
- return OK;
-}
-1;
-__END__