--- loncom/interface/statistics/lonstudentassessment.pm 2003/02/25 20:47:47 1.29 +++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/07 15:18:39 1.38 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstudentassessment.pm,v 1.29 2003/02/25 20:47:47 matthew Exp $ +# $Id: lonstudentassessment.pm,v 1.38 2003/03/07 15:18:39 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -54,34 +54,65 @@ use Apache::lonstatistics; use Apache::lonhtmlcommon; use Apache::loncoursedata; use Apache::lonnet; # for logging porpoises -use GDBM_File; +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 &BuildStudentAssessmentPage() +=item $show_links 'yes' or 'no' for linking to student performance data -Inputs: +=item $output_mode 'html', 'excel', or 'csv' for output mode -=over 4 +=item $show 'all', 'totals', or 'scores' determines how much data is output -=item $cacheDB The name of the cache file used to store student data +=cut -=item $students Array ref containing the name(s) of the students -selected for display +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $show; -=item $courseID The ID of the course +####################################################### +####################################################### +# End of package variable declarations -=item $formName The name of the html form - 'Statistics' +=pod -=item $headings Array ref of headings to show +=back + +=cut + +####################################################### +####################################################### -=item $spacing A string of spaces +=pod + +=item &BuildStudentAssessmentPage() + +Inputs: -=item $studentInformation Array ref of possible headings for student info -('fullname','section',...) +=over 4 =item $r Apache Request @@ -94,147 +125,92 @@ selected for display ####################################################### ####################################################### 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')); - } +sub get_student_fields_to_show { + my @to_show = @Apache::lonstatistics::SelectedStudentData; + foreach (@to_show) { + if ($_ eq 'all') { + @to_show = @Apache::lonstatistics::StudentDataOrder; + last; + } + } + return @to_show; +} - $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::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 .= ' 'HTML, with links',
+ value => 'html, with links',
+ description => 'Output HTML with each symbol linked to the problem '.
+ 'which generated it.',
+ mode => 'html',
+ show => 'all',
+ show_links => 'yes',
+ },
+ { name => 'HTML, without links',
+ value => 'html, without links',
+ description => 'Output HTML. By not including links, the size of the'.
+ ' web page is greatly reduced. If your browser crashes on the '.
+ 'full display, try this.',
+ mode => 'html',
+ show => 'all',
+ show_links => 'no',
+ },
+ { name => 'HTML, scores only',
+ value => 'html, scores only',
+ description => 'Output HTML, only showing the total number of correct'.
+ ' problems (or problem parts) and not the maximum possible for '.
+ 'each student',
+ mode => 'html',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { name => 'HTML, totals',
+ value => 'html, totals',
+ description => 'Output HTML, but only the summary statistics for each'.
+ ' sequence selected.',
+ mode => 'html',
+ show => 'totals',
+ show_links => 'no',
+ },
+ { name => 'Excel, scores only',
+ value => 'excel, scores only',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with a single column for each sequence showing the students '.
+ 'score.',
+ mode => 'excel',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { name => 'Excel, totals',
+ value => 'excel, totals',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with two columns for each sequence, the students score on the '.
+ 'sequence and the students maximum possible on the sequence',
+ mode => 'excel',
+ show => 'totals',
+ show_links => 'no',
+ },
+ { name => 'multi-sheet Excel',
+ value => 'multi-sheet excel',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with a seperate worksheet for each sequence you have selected '.
+ 'the data for each problem part '.
+ '(number of tries, status, points awarded) will be listed.',
+ mode => 'multi-sheet excel',
+ show => 'totals',
+ show_links => 'no',
+ },
+ { name => 'multi-sheet Excel, by section',
+ value => 'multi-sheet excel, by section',
+ description => 'Output an Excel file (compatable with Excel 95), '.
+ 'with a seperate worksheet for each sequence you have selected '.
+ 'the data for each problem part '.
+ '(number of tries, status, points awarded) will be listed. '.
+ 'There will be one Excel workbook for each section selected.',
+ mode => 'multi-sheet excel',
+ show => 'by section',
+ show_links => 'no',
+ },
+ { name => 'CSV, everything',
+ value => 'csv, everything',
+ description => '',
+ mode => 'csv',
+ show => 'all',
+ show_links => 'no',
+ },
+ { name => 'CSV, scores only',
+ value => 'csv, scores only',
+ description => '',
+ mode => 'csv',
+ show => 'scores',
+ show_links => 'no',
+ },
+ { name => 'CSV, totals',
+ value => 'csv, totals',
+ description => '',
+ mode => 'csv',
+ show => 'totals',
+ show_links => 'no',
+ },
+ );
-=over 4
+sub OutputDescriptions {
+ my $Str = '';
+ $Str .= "Output Modes\n"; + $Str .= "
".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}. + " ".localtime(time).""); + my $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; +} -# my $Str = '     '; +sub html_outputstudent { + my ($r,$student) = @_; my $Str = ''; - $Str .= '
Not yet implemented"); + # + # Estimate the size of the file. We would like to have < 5 megs of data. + my $max_size = 5000000; + my $num_students = scalar(@Apache::lonstatistics::Students); + my $num_sequences = 0; + my $num_data_per_part = 2; # 'status' and 'numtries' + my $fields_per_student = scalar(&get_student_fields_to_show()); + my $bytes_per_field = 20; # Back of the envelope calculation + foreach my $seq (&get_sequences_to_show) { + $num_sequences++ if ($seq->{'num_assess'} > 0); + $fields_per_student += $num_data_per_part * $seq->{'num_assess_parts'}; + } + my $size_estimate = $fields_per_student*$num_students*$bytes_per_field; + # + # Compute number of workbooks + my $num_workbooks = 1; + if ($size_estimate > $max_size) { # try to stay under 5 megs + $num_workbooks += int($size_estimate / $max_size); + } + if ($show eq 'by section') { + if (@Apache::lonstatistics::SelectedSections > 1 && + $Apache::lonstatistics::SelectedSections[0] ne 'all') { + $num_workbooks = scalar(@Apache::lonstatistics::SelectedSections); + } else { + # @Apache::lonstatistics::Sections contains 'all' as well. + $num_workbooks = scalar(@Apache::lonstatistics::Sections) - 1; + } + } + + $r->print("Maximum allowed size: ".$max_size." bytes"); + $r->print("Number of students: ".$num_students." "); + $r->print("Number of fields per student: ".$fields_per_student." "); + $r->print("Total number of fields: ".($fields_per_student*$num_students). + " "); + $r->print("Bytes per field: ".$bytes_per_field." (estimated)"." "); + $r->print("Estimated size: ".$size_estimate." bytes "); + $r->print("Number of workbooks: ".$num_workbooks." "); + $r->rflush(); + return; +} -=item $showSequences Array ref containing the sequences to display +sub multi_sheet_excel_outputstudent { + my ($r,$student) = @_; +} -=back +sub multi_sheet_excel_finish { + my ($r) = @_; +} + +} +####################################################### +####################################################### + +=pod + +=head2 EXCEL subroutines + +=item &excel_initialize($r) -Output: $Str +=item &excel_outputstudent($r,$student) -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +=item &excel_finish($r) =cut ####################################################### ####################################################### -sub StudentReport { - my ($cache,$name,$spacing,$showSequences)=@_; - my ($username,$domain)=split(':',$name); +{ - my $Str = ''; - if(defined($cache->{$name.':error'})) { - return $Str; +my $excel_sheet; +my $excel_workbook; + +my $filename; +my $rows_output; +my $cols_output; + +my %prog_state; # progress window state + +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; + # + # 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); + # + # Put the course description in the header + $excel_sheet->write($rows_output,$cols_output++, + $ENV{'course.'.$ENV{'request.course.id'}.'.description'}); + $cols_output += 3; + # + # Put a description of the sections listed + my $sectionstring = ''; + my @Sections = @Apache::lonstatistics::SelectedSections; + if (scalar(@Sections) > 1) { + if (scalar(@Sections) > 2) { + my $last = pop(@Sections); + $sectionstring = "Sections ".join(', ',@Sections).', and '.$last; + } else { + $sectionstring = "Sections ".join(' and ',@Sections); + } + } else { + if ($Sections[0] eq 'all') { + $sectionstring = "All sections"; + } else { + $sectionstring = "Section ".$Sections[0]; + } } - 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++; - } + $excel_sheet->write($rows_output,$cols_output++,$sectionstring); + $cols_output += scalar(@Sections); + # + # Put the date in there too + $excel_sheet->write($rows_output,$cols_output++, + 'Compiled on '.localtime(time)); + # + $rows_output++; + # + # Add the student headers + $cols_output = 0; + foreach my $field (&get_student_fields_to_show()) { + $excel_sheet->write($rows_output,$cols_output++,$field); + } + # + # Add the Sequence Headers + foreach my $seq (&get_sequences_to_show) { + $excel_sheet->write($rows_output,$cols_output,$seq->{'title'}); + if ($show eq 'totals') { + $excel_sheet->write($rows_output+1,$cols_output,'score'); + $excel_sheet->write($rows_output+1,$cols_output+1,'maximum'); + $cols_output += 2; + } else { + $cols_output++; } + } + # + # Bookkeeping + if ($show eq 'totals') { + $rows_output += 2; + } else { + $rows_output += 1; + } + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + $r->print(" Compiling Excel spreadsheet for ". + $studentcount.' student'); + $r->print('s') if ($studentcount > 1); + $r->print("\n"); + $r->rflush(); + # + # Initialize progress window + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Excel File Compilation Status', + 'Excel File Compilation Progress', $studentcount); + # + 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'; - } else { - $Str .= ' '; +sub excel_outputstudent { + my ($r,$student) = @_; + return if (! defined($excel_sheet)); + $cols_output=0; + # + # Write out student data + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + $excel_sheet->write($rows_output,$cols_output++,$student->{$field}); + } + # + # Get student assessment 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; + } + # + # Write out sequence scores and totals data + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + if ($show eq 'totals' || $show eq 'scores') { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + if ($show eq 'totals') { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); } - $Str .= $spacing; } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} - # 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.''; - } else { - $Str .= ' '; +sub excel_finish { + my ($r) = @_; + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print(''. + 'Your Excel spreadsheet.'."\n"); + $r->rflush(); + return; +} + +} +####################################################### +####################################################### + +=pod + +=head2 CSV output routines + +=item &csv_initialize($r) + +=item &csv_outputstudent($r,$student) + +=item &csv_finish($r) + +=cut + +####################################################### +####################################################### +{ + +my $outputfile; +my $filename; + +my %prog_state; # progress window state + +sub csv_initialize{ + my ($r) = @_; + # + # Clean up + $filename = undef; + $outputfile = undef; + undef(%prog_state); + # + # Open a file + $filename = '/prtspool/'. + $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. + time.'_'.rand(1000000000).'.csv'; + unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) { + $r->log_error("Couldn't open $filename for output $!"); + $r->print("Problems occured in writing the csv file. ". + "This error has been logged. ". + "Please alert your LON-CAPA administrator."); + $outputfile = undef; + } + # + # Datestamp + my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; + print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'. + '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'. + "\n"; + + # + # Print out the headings + my $Str = ''; + my $Str2 = undef; + foreach my $field (&get_student_fields_to_show()) { + if ($show eq 'scores') { + $Str .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } elsif ($show eq 'totals') { + $Str .= '"",'; # first row empty on the student fields + $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } elsif ($show eq 'all') { + $Str .= '"'.&Apache::loncommon::csv_translate($field).'",'; + } } + foreach my $seq (&get_sequences_to_show) { + if ($show eq 'scores') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '",'; + } elsif ($show eq 'totals') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '","",'; + $Str2 .= '"score","total possible",'; + } elsif ($show eq 'all') { + $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}). + '",'; + $Str .= '"",'x($seq->{'num_assess_parts'}-1); + $Str .= '"score","total possible",'; + } + } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + if (defined($Str2)) { + chop($Str2); + $Str2 .= "\n"; + print $outputfile $Str2; + } + # + # Initialize progress window + my $studentcount = scalar(@Apache::lonstatistics::Students); + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'CSV File Compilation Status', + 'CSV File Compilation Progress', $studentcount); + return; +} - if($hasVersion eq 'false') { - $Str = 'No course data.'; +sub csv_outputstudent { + my ($r,$student) = @_; + return if (! defined($outputfile)); + my $Str = ''; + # + # Output student fields + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + $Str .= '"'.&Apache::loncommon::csv_translate($student->{$field}).'",'; + } + # + # Get student assessment 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; + } + # + # Output performance data + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + if ($show eq 'scores') { + $Str .= '"'.$score.'",'; + } elsif ($show eq 'totals') { + $Str .= '"'.$score.'","'.$seq_max.'",'; + } elsif ($show eq 'all') { + $Str .= '"'.join('","',(split(//,$performance),$score,$seq_max)). + '",'; + } } + chop($Str); + $Str .= "\n"; + print $outputfile $Str; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} + +sub csv_finish { + my ($r) = @_; + return if (! defined($outputfile)); + close($outputfile); + # + my $c = $r->connection(); + return if ($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their csv file + $r->print(' '. + 'Your csv file.'."\n"); + $r->rflush(); + return; + +} - return $Str; } ####################################################### ####################################################### +=pod + +=item &StudentPerformanceOnSequence() + +Inputs: + +=over 4 + +=item $student + +=item $studentdata Hash ref to all student data + +=item $seq Hash ref, the sequence we are working on + +=item $links if defined we will output links to each resource. + +=back + +=cut + +####################################################### +####################################################### +sub StudentPerformanceOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + my $value = ''; + foreach my $partnum (@{$resource->{'parts'}}) { + $max++; + my $symbol = ' '; # default to space + # + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + my $status = $resource_data->{'resource.'.$partnum.'.solved'}; + if ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted') { + $symbol = '.'; + } elsif ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_student' && + exists($resource_data->{'resource.'.$partnum.'.tries'})){ + my $num = $resource_data->{'resource.'.$partnum.'.tries'}; + if ($num > 9) { + $symbol = '*'; + } elsif ($num > 0) { + $symbol = $num; + } else { + $symbol = ' '; + } + $sum++; + } else { + $symbol = ' '; + } + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$partnum.'.tries'})){ + $symbol = '.'; + } else { + $symbol = ' '; + } + } + # + if ($links eq 'yes' && $symbol ne ' ') { + $symbol = ''.$symbol.''; + } + $value .= $symbol; + } + $Str .= $value; + } + return ($Str,$sum,$max); +} + ####################################################### ####################################################### sub StudentAverageTotal { @@ -590,29 +1150,6 @@ sub StudentAverageTotal { ####################################################### ####################################################### -####################################################### -####################################################### -sub MaxSeqPr { - my ($cache, $name, $sequence)=@_; - my $prCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - foreach(split(/\:/,$cache->{$sequence.':'.$problemID.':parts'})) { - if($cache->{$name.':'.$problemID.':NoVersion'} eq 'true' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ' || - $cache->{$name.':'.$problemID.':'.$_.':code'} eq '') { - $prCount++; - next; - } - $prCount++; - } - } - return $prCount; -} - -####################################################### -####################################################### - =pod =item &CreateLegend() @@ -643,176 +1180,7 @@ sub CreateLegend { ####################################################### ####################################################### -=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. - -=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; -} - -####################################################### -####################################################### - -=pod - -=back - -=head1 HELPER FUNCTIONS - -=over 4 - -=cut - -####################################################### -####################################################### -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) +=pod =back @@ -820,62 +1188,7 @@ $test: The form name of the column (head ####################################################### ####################################################### -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); -} 1; -####################################################### -####################################################### - -=pod - -=back - -=cut - -####################################################### -####################################################### - __END__