--- loncom/interface/statistics/lonstudentassessment.pm 2003/01/13 01:34:11 1.27 +++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/04 14:21:36 1.33 @@ -1,7 +1,6 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.27 2003/01/13 01:34:11 minaeibi Exp $ +# $Id: lonstudentassessment.pm,v 1.33 2003/03/04 14:21:36 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,387 +24,818 @@ # 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,12/24 Behrouz Minaei -# YEAR=2003 -# 1/11 Behrouz Minaei -### +# +####################################################### +####################################################### + +=pod + +=head1 NAME + +lonstudentassessment + +=head1 SYNOPSIS + +Presents assessment data about a student or a group of students. + +=head1 Subroutines + +=over 4 + +=cut + +####################################################### +####################################################### package Apache::lonstudentassessment; use strict; +use Apache::lonstatistics; use Apache::lonhtmlcommon; use Apache::loncoursedata; -use GDBM_File; +use Apache::lonnet; # for logging porpoises +use Spreadsheet::WriteExcel; + +####################################################### +####################################################### +=pod + +=item Package Variables + +=over 4 + +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. + +=cut + +####################################################### +####################################################### + +my $Statistics; + +####################################################### +####################################################### + +=pod + +=item $show_links 'yes' or 'no' for linking to student performance data + +=item $output_mode 'html', 'excel', or 'csv' for output mode +=item $show 'all', 'totals', or 'scores' determines how much data is output + +=cut +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $show; + +####################################################### +####################################################### +# End of package variable declarations + +=pod + +=back + +=cut + +####################################################### +####################################################### + +=pod + +=item &BuildStudentAssessmentPage() + +Inputs: + +=over 4 + +=item $r Apache Request + +=item $c Apache Connection + +=back + +=cut + +####################################################### +####################################################### sub BuildStudentAssessmentPage { - my ($cacheDB,$students,$courseID,$formName,$headings,$spacing, - $studentInformation,$r,$c)=@_; - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - $r->print('
Unable to tie database.'); + my ($r,$c)=@_; + undef($Statistics); + # + # Print out the HTML headers for the interface + # This also parses the output mode selector + # This step must always be done. + $r->print(&CreateInterface()); + $r->print(''); + $r->rflush(); + if (! exists($ENV{'form.notfirstrun'})) { + $r->print(<'."\n"); - foreach (@$students) { - if($c->aborted()) { return $Str; } - next if ($_ ne $selectedName && - $selectedName ne 'All Students'); - $selected = 1; - - my @who = ($_); - next if(&Apache::loncoursedata::DownloadStudentCourseData(\@who, 'true', - $cacheDB, 'true', - 'false', $courseID, - $r, $c) ne 'OK'); - next if($c->aborted()); - - if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER(),0640)) { - my @before=(); - my @after=(); - my @updateColumn=(); - my $foundUpdate = 0; - foreach(@$infoKeys) { - if(/updateTime/) { - $foundUpdate=1; - push(@updateColumn, $_); - next; - } - if($foundUpdate) { - push(@after, $_); - } else { - push(@before, $_); - } - } - $Count++; - my $out = ''; - $out .= sprintf("%3d) ", $Count); - if($Count % 2) { - $out .= ''."\n"); - if($selected == 0) { - $Str .= ''; - } else { - $out .= ' '; - } - my $displayString = $out.'DISPLAYDATA'.$spacing; - $r->print(&Apache::lonhtmlcommon::FormatStudentInformation( - \%cache, $_, - \@before, - $displayString, - 'preformatted')); - - if($foundUpdate) { - $displayString = ''; - $displayString .= ''; - $displayString .= 'DISPLAYDATA'.$spacing; - $r->print(&Apache::lonhtmlcommon::FormatStudentInformation( - \%cache, $_, - \@updateColumn, - $displayString, - 'preformatted')); - } - $displayString = 'DISPLAYDATA'.$spacing; - $r->print(&Apache::lonhtmlcommon::FormatStudentInformation( - \%cache, $_, - \@after, - $displayString, - 'preformatted')); - $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys)); - $r->print("\n"); - $r->rflush(); - untie(%cache); - } - } - $r->print('
'."\n"; - $Str .= '{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Str .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); $Str .= ' | '; - $Str .= &CreateColumnSelectionBox($doNotShow); + my $only_seq_with_assessments = sub { + my $s=shift; + if ($s->{'num_assess'} < 1) { + return 0; + } else { + return 1; + } + }; + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); $Str .= ' | '."\n"; - $Str .= ' | '."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $infoKeys, - $infoHeadings, - $displayString, - 'preformatted'); - - $displayString = 'DISPLAYDATAFORMATTING'.$spacing; - $displayString .= ' | '."\n";
- $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache,
- $sequenceKeys,
- $sequenceHeadings,
- $displayString,
- 'preformatted');
+=pod
+
+=item &CreateAndParseOutputSelector()
+
+=cut
- $Str .= 'Total Solved/Total Problems | ';
- $Str .= '
\n"; + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$Apache::lonstatistics::StudentData{$field}->{'title'}; + my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'}; + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # Now the selected sequences need to be listed + foreach my $sequence (&get_sequences_to_show) { + my $title = $sequence->{'title'}; + my $base = $sequence->{'base_width'}; + my $width = $sequence->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + $Str .= "total (of shown problems)\n"; + $Str .= "
"; + $r->print($Str); + $r->rflush(); + return; +} +sub html_outputstudent { + my ($r,$student) = @_; my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; + # First, the @StudentData fields need to be listed + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + my $title=$student->{$field}; + my $base = length($title); + my $width=$Apache::lonstatistics::StudentData{$field}->{'width'}; + $Str .= $title.' 'x($width-$base).$padding; + } + # Get ALL the students data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state + ($student->{'username'},$student->{'domain'},undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; } - if($cache->{$name.':error'} =~ /course/) { - $Str .= 'No course data for student '; - $Str .= ''.$username.'.
'; - return $Str; - } - - my $hasVersion = 'false'; - my $hasFinalData = 'false'; - foreach my $sequence (@$showSequences) { - my $hasData = 'false'; - my $characterCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - # All grades (except for versionless parts) are displayed as links - # to their submission record. Loop through all the parts for the - # current problem in the correct order and prepare the output links - foreach(split(/\:/,$cache->{$sequence.':'.$problemID. - ':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $Str .= ' '; - $characterCount++; - next; - } - $hasVersion = 'true'; - $hasData = 'true'; - if (lc($ENV{'form.displaymode'}) ne 'display without links') { - $Str .= ''; - } - my $code = $cache->{$name.':'.$problemID.':'.$_.':code'}; - my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'}; - if($code eq '*' && $tries < 10 && $tries ne '') { - $code = $tries; - } - $Str .= $code; - if (lc($ENV{'form.displaymode'}) ne 'display without links') { - $Str .= ''; - } - $characterCount++; - } - } + if (scalar(@tmp) < 1) { + $Str .= 'No Course Data'."\n"; + $r->print($Str); + $r->rflush(); + return; + } + # + # By sequence build up the data + my $studentstats; + my $PerformanceStr = ''; + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,$show_links); + my $ratio = $score.'/'.$seq_max; + # + if ($show eq 'totals') { + $performance = ' 'x(length($seq_max)-length($score)).$ratio; + $performance .= ' 'x($seq->{'width'}-length($performance)); + } elsif ($show eq 'scores') { + $performance = $score; + $performance .= ' 'x($seq->{'width'}-length($performance)); + } else { + # Pad with extra spaces + $performance .= ' 'x($seq->{'width'}-$seq_max- + length($ratio) + ).$ratio; + } + # + $Str .= $performance.$padding; + # + $studentstats->{$seq->{'symb'}}->{'score'}= $score; + $studentstats->{$seq->{'symb'}}->{'max'} = $seq_max; + } + # + # Total it up and store the statistics info. + my ($score,$max) = (0,0); + while (my ($symb,$seq_stats) = each (%{$studentstats})) { + $Statistics->{$symb}->{'score'} += $seq_stats->{'score'}; + $Statistics->{$symb}->{'max'} += $seq_stats->{'max'}; + $score += $seq_stats->{'score'}; + $max += $seq_stats->{'max'}; + } + $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max; + $Str .= " \n"; + $r->print($Str); + # + $count++; + if($count % 5 == 0) { + $r->print("
"); + } + # + $r->rflush(); + return; +} - # Output the number of correct answers for the current sequence. - # This part takes up 6 character slots, but is formated right - # justified. - my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount; - $spacesNeeded -= 3; - $Str .= (' 'x$spacesNeeded); - -# my $outputProblemsCorrect = sprintf("%3d", $cache->{$name.':'.$sequence. -# ':problemsCorrect'}); - - my $outputProblemsCorrect = sprintf("%2d/%2d", $cache->{$name.':'.$sequence. - ':problemsCorrect'}, - $characterCount); - if($hasData eq 'true') { - $Str .= ''.$outputProblemsCorrect.''; - $hasFinalData = 'true'; +sub html_finish { + my ($r) = @_; + $r->print("\n"); + $r->rflush(); + return; +} + +} + +####################################################### +####################################################### + +=pod + +=head2 EXCEL subroutines + +=item &excel_initialize($r) + +=item &excel_outputstudent($r,$student) + +=item &excel_finish($r) + +=cut + +####################################################### +####################################################### +{ + +my $excel_sheet; +my $excel_workbook; + +my $filename; +my $rows_output; +my $cols_output; + +my $num_students; +my $start_time; + +sub excel_initialize { + my ($r) = @_; + # + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.xls'; + # + $excel_workbook = undef; + $excel_sheet = undef; + # + $rows_output = 0; + $cols_output = 0; + # + $num_students = 0; + $start_time = time; + # + # Create sheet + $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename); + # + # Check for errors + if (! defined($excel_workbook)) { + $r->log_error("Error creating excel spreadsheet $filename: $!"); + $r->print("Problems creating new Excel file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator"); + return ; + } + # + # The excel spreadsheet stores temporary data in files, then put them + # together. If needed we should be able to disable this (memory only). + # The temporary directory must be specified before calling 'addworksheet'. + # File::Temp is used to determine the temporary directory. + $excel_workbook->set_tempdir($Apache::lonnet::tmpdir); + # + # Add a worksheet + my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + if (length($sheetname) > 31) { + $sheetname = substr($sheetname,0,31); + } + $excel_sheet = $excel_workbook->addworksheet($sheetname); + # + # Add the student headers + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write(1,$cols_output++,$field); + } + # + # Add the Sequence Headers + foreach my $seq (&get_sequences_to_show) { + $excel_sheet->write(0,$cols_output,$seq->{'title'}); + if ($show eq 'totals') { + $excel_sheet->write(1,$cols_output,'score'); + $excel_sheet->write(1,$cols_output+1,'maximum'); + $cols_output += 2; } else { - $Str .= ' '; + $cols_output++; } - $Str .= $spacing; } - - # Output the total correct problems over the total number of problems. - # I don't like this type of formatting, but it is a solution. Need - # a way to dynamically determine the space requirements. - my $outputProblemsSolved = sprintf("%4d", $cache->{$name.':problemsSolved'}); - my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'}); - if($hasFinalData eq 'true') { - $Str .= ''.$outputProblemsSolved. - ' / '.$outputTotalProblems.''; + # + # Bookkeeping + if ($show eq 'totals') { + $rows_output = 2; } else { - $Str .= ' '; + $rows_output = 1; } + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + $r->print("
". " 1 correct by student in 1 try\n". @@ -516,210 +927,18 @@ sub CreateLegend { return $Str; } -=pod - -=item &CreateColumnSelectionBox() - -If there are columns not being displayed then this selection box is created -with a list of those columns. When selections are made and the page -refreshed, the columns will be removed from this box and the column is -put back in the chart. If there is no columns to select, no row is added -to the interface table. - -=over 4 -Input: $CacheData, $headings - +####################################################### +####################################################### -$CacheData: A pointer to a hash tied to the cached data - -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. - -Output: $notThere - -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. +=pod =back =cut -sub CreateColumnSelectionBox { - my ($doNotShow)=@_; - - my $notThere = ''; - $notThere .= ''; - - return $notThere; -} - -=pod - -=item &CreateColumnSelectors() - -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. - -=over 4 - -Input: $CacheData, $headings - -$CacheData: A pointer to a hash tied to the cached data - -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns - -Output: $present - -$present: The string contains the first row of a table. Each column contains -a checkbox which is left justified. Currently left justification is used -for consistency of location over the column in which it presides. - -=back - -=cut - -sub CreateColumnSelectors { - my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_; - - my $present = ''; - for(my $index=0; $index<(scalar @$infoHeadings); $index++) { - $present .= ''; - $present .= '[$index].'" />'; - $present .= ' '."\n"; - } - - for(my $index=0; $index<(scalar @$sequenceHeadings); $index++) { - $present .= ''; - $present .= '[$index].'" />'; - $present .= ' '."\n"; - } - - return $present; -} - -#---- END Student Assessment Web Page ---------------------------------------- - -#---- Student Assessment Worker Functions ------------------------------------ - -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; - - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } - - for(my $index=0; $index<(scalar @$students); $index++) { - my $fullname = $cache->{$students->[$index].':fullname'}; - if($fullname eq $selectedName) { - if($cache->{'StudentAssessmentMove'} eq 'next') { - if($index == ((scalar @$students) - 1)) { - $selectedName = $students->[0]; - return $selectedName; - } else { - $selectedName = $students->[$index+1]; - return $selectedName; - } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; - } else { - $selectedName = $students->[$index-1]; - return $selectedName; - } - } else { - $selectedName = $students->[$index]; - return $selectedName; - } - last; - } - } - - return 'No Student Selected'; -} - -=pod - -=item &ShouldShowColumn() - -Determine if a specified column should be shown on the chart. - -=over 4 - -Input: $cache, $test - -$cache: A pointer to the hash tied to the cached data - -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) - -Output: 0 (false), 1 (true) - -=back - -=cut - -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); - - my @sequenceKeys=(); - my @sequenceHeadings=(); - - my %doNotShow; - - my $index; - my $count = 0; - my $check = ''; - for($index=0; $index < scalar @$headings; $index++) { - $check = 'HeadingColumn'.$headings->[$index]; - if($cache->{'HeadingsFound'} =~ /$check/) { - push(@infoHeadings, $headings->[$index]); - push(@infoKeys, $cacheKey->[$index]); - } else { - $doNotShow{$count.':name'} = $headings->[$index]; - $doNotShow{$count.':id'} = 'HeadingColumn'.$headings->[$index]; - $count++; - } - } - - foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) { - $check = 'SequenceColumn'.$sequence; - if($cache->{'SequencesFound'} eq 'All Sequences' || - $cache->{'SequencesFound'} =~ /$check/) { - push(@sequenceHeadings, $cache->{$sequence.':title'}); - push(@sequenceKeys, $sequence); - } else { - $doNotShow{$count.':name'} = $cache->{$sequence.':title'}; - $doNotShow{$count.':id'} = 'SequenceColumn'.$sequence; - $count++; - } - } - - $doNotShow{'count'} = $count; - - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys, \%doNotShow); -} - -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### 1; + __END__