--- loncom/interface/lonstatistics.pm 2004/09/02 21:05:24 1.109 +++ loncom/interface/lonstatistics.pm 2005/10/04 18:27:32 1.125 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstatistics.pm,v 1.109 2004/09/02 21:05:24 matthew Exp $ +# $Id: lonstatistics.pm,v 1.125 2005/10/04 18:27:32 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -50,17 +50,12 @@ use vars qw( @FullClasslist @Students @Sections - @SelectedSections %StudentData @StudentDataOrder @SelectedStudentData - $top_map - @Sequences - @SelectedMaps - @Assessments $enrollment_status); -use Apache::lonnet(); +use Apache::lonnet; use Apache::lonhomework; use Apache::loncommon; use Apache::loncoursedata; @@ -128,8 +123,6 @@ undef the following package variables: =item @Sections -=item @SelectedSections - =item %StudentData =item @StudentDataOrder @@ -152,7 +145,6 @@ sub clear_classlist_variables { undef(@FullClasslist); undef(@Students); undef(@Sections); - undef(@SelectedSections); undef(%StudentData); undef(@SelectedStudentData); undef($curr_student); @@ -178,8 +170,6 @@ the following package variables: =item @Sections -=item @SelectedSections - =item %StudentData =item @SelectedStudentData @@ -204,28 +194,16 @@ sub PrepareClasslist { &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'); - } - } + 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(); # # Deal with instructors with restricted section access - if ($ENV{'request.course.sec'} !~ /^\s*$/) { - @SelectedSections = ($ENV{'request.course.sec'}); + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); } # # Set up %StudentData @@ -239,7 +217,7 @@ sub PrepareClasslist { # # get the status requested $enrollment_status = 'Active'; - $enrollment_status = $ENV{'form.Status'} if (exists($ENV{'form.Status'})); + $enrollment_status = $env{'form.Status'} if (exists($env{'form.Status'})); # # Process the classlist while (my ($student,$student_data) = each (%$classlist)) { @@ -266,7 +244,7 @@ sub PrepareClasslist { $Sections{$section}++; # # Only put in the list those students we are interested in - foreach my $sect (@SelectedSections) { + foreach my $sect (@selected_sections) { if ( (($sect eq 'all') || ($section eq $sect)) && (($studenthash->{'status'} eq $enrollment_status) || @@ -279,8 +257,8 @@ sub PrepareClasslist { } # # Put the consolidated section data in the right place - if ($ENV{'request.course.sec'} !~ /^\s*$/) { - @Sections = ($ENV{'request.course.sec'}); + if ($env{'request.course.sec'} !~ /^\s*$/) { + @Sections = ($env{'request.course.sec'}); } else { @Sections = sort {$a cmp $b} keys(%Sections); unshift(@Sections,'all'); # Put 'all' at the front of the list @@ -288,16 +266,16 @@ sub PrepareClasslist { # # Sort the Students my $sortby = 'fullname'; - $sortby = $ENV{'form.sort'} if (exists($ENV{'form.sort'})); + $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'})) { + if (exists($env{'form.SelectedStudent'})) { my ($current_uname,$current_dom) = - split(':',$ENV{'form.SelectedStudent'}); + split(':',$env{'form.SelectedStudent'}); my $i; for ($i = 0; $i<=$#Students; $i++) { next if (($Students[$i]->{'username'} ne $current_uname) || @@ -319,12 +297,9 @@ sub PrepareClasslist { } } # - if (exists($ENV{'form.StudentData'})) { - if (ref($ENV{'form.StudentData'}) eq 'ARRAY') { - @SelectedStudentData = @{$ENV{'form.StudentData'}}; - } else { - @SelectedStudentData = ($ENV{'form.StudentData'}); - } + if (exists($env{'form.StudentData'})) { + @SelectedStudentData = + &Apache::loncommon::get_env_multiple('form.StudentData'); } else { @SelectedStudentData = ('username'); } @@ -338,43 +313,34 @@ sub PrepareClasslist { return; } - ####################################################### ####################################################### =pod -=item get_students +=item get_selected_sections -Returns a list of the selected students +Returns an array of the selected sections =cut ####################################################### ####################################################### -sub get_students { - if (! @Students) { - &PrepareClasslist() +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'); + } } - return @Students; -} - -####################################################### -####################################################### - -=pod - -=item ¤t_student() - -Returns a pointer to a hash containing data about the currently -selected student. - -=cut - -####################################################### -####################################################### -sub current_student { - return $curr_student; + # + # Deal with instructors with restricted section access + if ($env{'request.course.sec'} !~ /^\s*$/) { + @selected_sections = ($env{'request.course.sec'}); + } + return @selected_sections; } ####################################################### @@ -382,52 +348,61 @@ sub current_student { =pod -=item &previous_student() +=item §ion_and_enrollment_description -Returns a pointer to a hash containing data about the student prior -in the list of students. Or something. +Returns a string describing the currenly selected section(s) and +enrollment status. -=cut - -####################################################### -####################################################### -sub previous_student { - return $prev_student; -} - -####################################################### -####################################################### - -=pod - -=item &next_student() - -Returns a pointer to a hash containing data about the next student -to be viewed. +Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized') + 'plaintext' is used for example in Excel spreadsheets. +Returns: scalar description string. =cut ####################################################### ####################################################### -sub next_student { - return $next_student; -} - -####################################################### -####################################################### - -=pod - -=item &clear_sequence_variables() - -=cut - -####################################################### -####################################################### -sub clear_sequence_variables { - undef($top_map); - undef(@Sequences); - undef(@Assessments); +sub section_and_enrollment_description { + my ($mode) = @_; + if (! defined($mode)) { $mode = 'localized'; } + my @sections = &Apache::lonstatistics::get_selected_sections(); + my $description; + if ($mode eq 'localized') { + $description = &mt('Unable to determine section and enrollment'); + } elsif ($mode eq 'plaintext') { + $description = 'Unable to determine section and enrollment'; + } else { + $description = 'Bad parameter passed to lonstatistics::section_and_enrollment_description'; + &Apache::lonnet::logthis($description); + } + if (scalar(@sections) == 1 && $sections[0] ne 'all') { + if ($mode eq 'localized') { + $description = &mt('Section [_1]. [_2] enrollment status.', + $sections[0],$env{'form.Status'}); + } elsif ($mode eq 'plaintext') { + $description = 'Section '.$sections[0].'. '. + $env{'form.Status'}.' enrollment status.'; + } + } elsif (scalar(@sections) && $sections[0] eq 'all') { + if ($mode eq 'localized') { + $description = &mt('All sections. [_1] enrollment status.', + $env{'form.Status'}); + } elsif ($mode eq 'plaintext') { + $description = 'All sections. '. + $env{'form.Status'}.' enrollment status.'; + } + } elsif (scalar(@sections)) { + my $lastsection = pop(@sections); + if ($mode eq 'localized') { + $description = &mt('Sections [_1] and [_2]. [_3] enrollment status.', + join(', ',@sections),$lastsection, + $env{'form.Status'}); + } elsif ($mode eq 'plaintext') { + $description = + 'Sections '.join(', ',@sections).' and '.$lastsection.'. '. + $env{'form.Status'}.' enrollment status.'; + } + } + return $description; } ####################################################### @@ -435,61 +410,37 @@ sub clear_sequence_variables { =pod -=item &SetSelectedMaps($elementname) +=item get_students -Sets the @SelectedMaps array from $ENV{'form.'.$elementname}; +Returns a list of the selected students =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'); +sub get_students { + if (! @Students) { + &PrepareClasslist() } + return @Students; } - ####################################################### ####################################################### =pod -=item &Sequences_with_Assess() +=item ¤t_student() -Returns an array containing the subset of @Sequences which contain -assessments. +Returns a pointer to a hash containing data about the currently +selected student. =cut ####################################################### ####################################################### -sub Sequences_with_Assess { - my ($mode) = @_; - $mode = 'selected' if (! defined($mode)); - my @Sequences_to_Show; - foreach my $sequence (@Sequences) { - next if ($sequence->{'num_assess'} < 1); - if ($mode eq 'all') { - push (@Sequences_to_Show,$sequence); - } elsif ($mode eq 'selected') { - foreach my $map_symb (@SelectedMaps) { - if ($sequence->{'symb'} eq $map_symb || $map_symb eq 'all'){ - push (@Sequences_to_Show,$sequence); - last; # Only put it in once - } - } - } - - } - return @Sequences_to_Show; +sub current_student { + return $curr_student; } ####################################################### @@ -497,26 +448,17 @@ sub Sequences_with_Assess { =pod -=item &PrepareCourseData($r) +=item &previous_student() + +Returns a pointer to a hash containing data about the student prior +in the list of students. Or something. =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'); - return; +sub previous_student { + return $prev_student; } ####################################################### @@ -524,60 +466,17 @@ sub PrepareCourseData { =pod -=item &log_sequence($sequence,$recursive,$padding) +=item &next_student() -Write data about the sequence to a logfile. If $recursive is not -undef the data is written recursively. $padding is used for recursive -calls. +Returns a pointer to a hash containing data about the next student +to be viewed. =cut ####################################################### ####################################################### -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; +sub next_student { + return $next_student; } ############################################## @@ -643,12 +542,96 @@ sub StudentDataSelect { return $Str; } +####################################################### +####################################################### + +=pod + +=item &get_selected_maps($elementname) + +Input: Name of the '."\n"; - # - # Deal with 'all' - foreach (@SelectedMaps) { - if ($_ eq 'all') { - @SelectedMaps = ('all'); - last; - } + $form .= 'multiple="true" '; } + $form .= 'size="'.$numvisible.'" >'."\n"; # # Put in option for 'all' - $Str .= ' \n"; + $form .= '>'.$seq->compTitle."\n"; } - $Str .= "\n"; - return $Str; + $form .= "\n"; + return $form; } ############################################## @@ -737,7 +707,7 @@ sub MapSelect { 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 +Uses the package variables @Sections =over 4 =item $elementname The name of the HTML form element @@ -774,7 +744,7 @@ sub SectionSelect { # Loop through the sequences foreach my $s (@Sections) { $Str .= '