--- loncom/interface/statistics/lonstudentsubmissions.pm 2010/01/14 17:20:51 1.56 +++ loncom/interface/statistics/lonstudentsubmissions.pm 2012/05/12 03:52:02 1.68.2.1 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstudentsubmissions.pm,v 1.56 2010/01/14 17:20:51 bisitz Exp $ +# $Id: lonstudentsubmissions.pm,v 1.68.2.1 2012/05/12 03:52:02 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -34,6 +34,7 @@ use Apache::loncoursedata(); use Apache::lonstatistics; use Apache::lonlocal; use Apache::lonstathelpers; +use Apache::lonmsgdisplay(); use HTML::Entities(); use Time::Local(); use Spreadsheet::WriteExcel(); @@ -61,6 +62,7 @@ sub BuildStudentSubmissionsPage { # &Apache::lonstatistics::PrepareClasslist(); # + $r->print( &Apache::lonhtmlcommon::breadcrumbs('Student Submission Reports')); $r->print(&CreateInterface()); # my @Students = @Apache::lonstatistics::Students; @@ -76,6 +78,10 @@ sub BuildStudentSubmissionsPage { '
'.&mt('Loading student data...').'
'); $r->rflush(); # + my %anoncounter = + &Apache::lonnet::dump('nohist_anonsurveys', + $env{'course.'.$env{'request.course.id'}.'.domain'}, + $env{'course.'.$env{'request.course.id'}.'.num'}); if (exists($env{'form.problemchoice'}) && ! exists($env{'form.SelectAnother'})) { foreach my $button (@SubmitButtons) { @@ -97,29 +103,104 @@ sub BuildStudentSubmissionsPage { # Determine which problems we are to analyze my @Symbs = &Apache::lonstathelpers::get_selected_symbs('problemchoice'); - foreach my $selected (@Symbs) { - $r->print(''.$/); + + # If there are multi-part problems with anonymous survey and named + # parts check if named was picked for display. + # + my %mixed_named; + foreach my $envkey (%env) { + if ($envkey =~ /^form\.mixed_(\d+:\d+)$/) { + my $item = $1; + if ($env{$envkey} =~ /^symb_(.+)$/) { + my $symb = &unescape($1); + if (ref($mixed_named{$symb}) eq 'ARRAY') { + push(@{$mixed_named{$symb}},$item); + } else { + @{$mixed_named{$symb}} = ($item); + } + } + } } # # Get resource objects my $navmap = Apache::lonnavmaps::navmap->new(); if (!defined($navmap)) { + foreach my $selected (@Symbs) { + $r->print(''.$/); + if (ref($mixed_named{$selected}) eq 'ARRAY') { + foreach my $item (@{$mixed_named{$selected}}) { + $r->print(''.$/); + } + } + } $r->print('
'.&mt("Internal error").'
'); return; } my %already_seen; - my @Problems; + my (@Problems,@anonProbs,@namedProbs,$show_named); foreach my $symb (@Symbs) { my $resource = $navmap->getBySymb($symb); - push(@Problems,$resource); + my ($hasanon,$hasnamed); + if (ref($resource)) { + foreach my $partid (@{$resource->parts}) { + if (($anoncounter{$symb."\0".$partid}) || ($resource->is_anonsurvey($partid))) { + unless (exists($mixed_named{$symb})) { + $hasanon = 1; + } + } else { + $hasnamed = 1; + } + } + if ($hasanon) { + push(@anonProbs,$resource); + } elsif ($hasnamed) { + push(@namedProbs,$resource); + } + } } - # - $r->print('

'. + if (@namedProbs > 0) { + @Problems = @namedProbs; + $show_named = 1; + } elsif (@anonProbs > 0) { + @Problems = @anonProbs; + } + foreach my $selected (@Symbs) { + $r->print(''.$/); + if (ref($mixed_named{$selected}) eq 'ARRAY') { + foreach my $item (@{$mixed_named{$selected}}) { + $r->print(''.$/); + } + } + } + # If these are to be anonymized, do a random shuffle of @Students. + unless ($show_named) { + &array_shuffle(\@Students); + } + # + + my $threshold = $env{'course.'.$env{'request.course.id'}.'.internal.anonsurvey_threshold'}; + if ($threshold eq '') { + my %domconfig = + &Apache::lonnet::get_dom('configuration',['coursedefaults'], + $env{'course.'.$env{'request.course.id'}.'.domain'}); + if (ref($domconfig{'coursedefaults'}) eq 'HASH') { + $threshold = $domconfig{'coursedefaults'}{'anonsurvey_threshold'}; + if ($threshold eq '') { + $threshold = 10; + } + } else { + $threshold = 10; + } + } + $r->print('

'. &Apache::lonstatistics::section_and_enrollment_description(). - '

'); + '

'); if (! scalar(@Problems) || ! defined($Problems[0])) { - $r->print('resource is undefined'); + $r->print(&mt('resource is undefined')); + } elsif (!$show_named && @Students < $threshold) { + $r->print(&mt('The number of students matching the selection criteria is too few for display of submission data for anonymous surveys.').'
'.&mt('There must be at least [quant,_1,student].',$threshold).' '.&mt('Contact a Domain Coordinator if you need the threshold to be changed for this course.')); } else { if (scalar(@Problems) == 1) { my $resource = $Problems[0]; @@ -131,11 +212,11 @@ sub BuildStudentSubmissionsPage { } } if ($env{'form.output'} eq 'excel') { - &prepare_excel_output($r,\@Problems,\@Students); + &prepare_excel_output($r,\@Problems,\@Students,\%anoncounter,$show_named); } elsif ($env{'form.output'} eq 'csv') { - &prepare_csv_output($r,\@Problems,\@Students); + &prepare_csv_output($r,\@Problems,\@Students,\%anoncounter,$show_named); } else { - &prepare_html_output($r,\@Problems,\@Students); + &prepare_html_output($r,\@Problems,\@Students,\%anoncounter,$show_named); } } $r->print('
'); @@ -144,29 +225,46 @@ sub BuildStudentSubmissionsPage { &mt('Prepare Report').'" />'); $r->print(' 'x5); $r->print('

'. - &mt('Computing correct answers greatly increasese the amount of time required to prepare a report.'). + &mt('Computing correct answers greatly increases the amount of time required to prepare a report.'). '

'); $r->print('

'. &mt('Please select problems and use the [_1]Prepare Report[_2] button to continue.','',''). '

'); $r->print(&Apache::lonstathelpers::MultipleProblemSelector - (undef,'problemchoice','Statistics')); + (undef,'problemchoice','Statistics',\%anoncounter)); } } +sub array_shuffle { + my $array = shift; + return unless (ref($array) eq 'ARRAY'); + my $i = scalar(@$array); + my $j; + foreach my $item (@$array) { + --$i; + $j = int(rand($i+1)); + next if($i == $j); + @$array [$i,$j] = @$array[$j,$i]; + } + return @$array; +} + ## ## get_extra_response_headers ## sub get_extra_response_headers { + my ($show_named) = @_; my @extra_resp_headers; if ($env{'form.correctans'} eq 'true') { push(@extra_resp_headers,'Correct'); - } - if ($env{'form.prob_status'} eq 'true') { - push(@extra_resp_headers,'Award Detail'); - push(@extra_resp_headers,'Time'); - push(@extra_resp_headers,'Attempt'); - push(@extra_resp_headers,'Awarded'); + } + if ($show_named) { + if ($env{'form.prob_status'} eq 'true') { + push(@extra_resp_headers,'Award Detail'); + push(@extra_resp_headers,'Time'); + push(@extra_resp_headers,'Attempt'); + push(@extra_resp_headers,'Awarded'); + } } return @extra_resp_headers; } @@ -211,7 +309,7 @@ sub get_headers { ######################################################### ######################################################### sub prepare_html_output { - my ($r,$problems,$students) = @_; + my ($r,$problems,$students,$anoncounter,$show_named) = @_; my $c = $r->connection(); # # Set a flag for the case when there is just one problem @@ -222,33 +320,40 @@ sub prepare_html_output { } # # Compute the number of columns per response - my @extra_resp_headers = &get_extra_response_headers(); + my @extra_resp_headers = &get_extra_response_headers($show_named); # # Create the table header - my @student_columns = ('username','domain','id','section'); - # + my @student_columns = &get_student_columns($show_named); my %headers; my $student_column_count = scalar(@student_columns); $headers{'problem'} = qq{\ }; - foreach (@student_columns) { - $headers{'student'}.= ''.ucfirst($_).''; + foreach my $field (@student_columns) { + $headers{'student'}.= ''.&mt(ucfirst($field)).''; } # # we put the headers into the %headers hash - my $total_col = scalar(@student_columns); + my $total_col = $student_column_count; my $nonempty_part_headers = 0; # my %problem_analysis; foreach my $prob (@$problems) { my %analysis = &Apache::lonstathelpers::get_problem_data($prob->src); $problem_analysis{$prob->src}=\%analysis; + my $symb = $prob->symb(); # my $prob_span = 0; my $single_part = 0; if (scalar(@{$prob->parts}) == 1) { $single_part = 1; } + my $shown_parts = 0; foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } + $shown_parts ++; my $part_span = 0; my $responses = [$prob->responseIds($partid)]; my $resptypes = [$prob->responseType($partid)]; @@ -289,6 +394,7 @@ sub prepare_html_output { } $prob_span += $part_span; } + next if (!$shown_parts); my $title = $prob->compTitle; if ($prob_span > 0) { $headers{'problem'}.= qq{$title}; @@ -306,7 +412,8 @@ sub prepare_html_output { qq{\ }. $headers{'response'}; } - my $full_header = $/.''.$/; + #my $full_header = $/.'
'.$/; + my $full_header = $/.&Apache::loncommon::start_data_table().$/; $full_header .= ''.$headers{'problem'}.''.$/; if ($nonempty_part_headers) { $full_header .= ''.$headers{'part'}.''.$/; @@ -317,17 +424,28 @@ sub prepare_html_output { # Main loop my $count; $r->print($/.$full_header.$/); - my $row_class = 'odd'; # css foreach my $student (@$students) { my $student_row_data; if ($count++ >= 30) { - $r->print('
'.$/.$full_header.$/); + $r->print(&Apache::loncommon::end_data_table().$/.$full_header.$/); $count = 0; } last if ($c->aborted()); - foreach my $field (@student_columns) { - $student_row_data .= - ''.$student->{$field}.''; + if ($show_named) { + foreach my $field (@student_columns) { + $student_row_data .= ''; + # handle comments like in lonstudentassessment.pm + if($field eq 'comments') { + $student_row_data .= + ''.&mt('Comments').''; + } else { + $student_row_data .= $student->{$field}; + } + $student_row_data .= ''; + } + } else { + $student_row_data = ''.&mt('Anonymized').''; } # # Figure out what it is we need to output for this student @@ -335,8 +453,14 @@ sub prepare_html_output { my %prob_data; my $maxrow; foreach my $prob (@$problems) { - $prob_data{$prob->symb}={}; + my $symb = $prob->symb; + $prob_data{$symb}={}; foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } my @responses = $prob->responseIds($partid); my @response_type = $prob->responseType($partid); for (my $i=0;$i<=$#responses;$i++) { @@ -401,11 +525,6 @@ sub prepare_html_output { next if (! $maxrow && ! scalar(@essays)); # # Go through the problem data and output a row. - if ($row_class eq 'even') { - $row_class = 'odd'; - } else { - $row_class = 'even'; - } my $printed_something; for (my $rows_output = 0;$rows_output<$maxrow;$rows_output++) { my $html; @@ -429,21 +548,23 @@ sub prepare_html_output { } } if (! $no_data) { - $r->print(qq{$student_row_data$html}.$/); + $r->print(&Apache::loncommon::start_data_table_row().$student_row_data.$html. + &Apache::loncommon::end_data_table_row().$/); $printed_something=1; } } if (@essays) { - my $tr = qq{}; + my $tr = &Apache::loncommon::start_data_table_row(); my $td = qq{}; if (! $printed_something) { - $r->print($tr.$student_row_data.''.$/); + $r->print($tr.$student_row_data.&Apache::loncommon::end_data_table_row().$/); } $r->print($tr.$td. join(''.$/.$tr.$td,@essays).''.$/); undef(@essays); } } # end of student loop + $r->print(&Apache::loncommon::end_data_table().$/); return; } @@ -625,19 +746,26 @@ sub html_non_essay_results { ######################################################### ######################################################### sub prepare_excel_output { - my ($r,$Problems,$Students) = @_; + my ($r,$Problems,$Students,$anoncounter,$show_named) = @_; my $c = $r->connection(); # # # Determine the number of columns in the spreadsheet my $columncount = 3; # username, domain, id - my @extra_resp_headers = &get_extra_response_headers(); + my @extra_resp_headers = &get_extra_response_headers($show_named); my $lastprob; my %problem_analysis; foreach my $prob (@$Problems) { + my $symb = $prob->symb(); my %analysis = &Apache::lonstathelpers::get_problem_data($prob->src); $problem_analysis{$prob->src}=\%analysis; foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } + my $responses = [$prob->responseIds($partid)]; my $resptypes = [$prob->responseType($partid)]; for (my $i=0;$i 255) { - $r->print('

'.&mt('Unable to complete request').'

'.$/. - '

'.&mt('LON-CAPA is unable to produce your Excel spreadsheet because your selections will result in more than 255 columns. Excel allows only 255 columns in a spreadsheet.').'

'.$/. - '

'.&mt('Consider selecting fewer problems to generate reports on, or reducing the number of items per problem. Or use HTML or CSV output.').'

'.$/. - '

'.&mt('The last problem that will fit in the current spreadsheet is [_1].',$lastprob->compTitle).'

'); + $r->print('

'.&mt('Unable to complete request').'

'.$/. + '

'.&mt('LON-CAPA is unable to produce your Excel spreadsheet because your selections will result in more than 255 columns. Excel allows only 255 columns in a spreadsheet.').'

'.$/. + '

'.&mt('Consider selecting fewer problems to generate reports on, or reducing the number of items per problem. Or use HTML or CSV output.').'

'.$/); + if (ref($lastprob)) { + $r->print('

'.&mt('The last problem that will fit in the current spreadsheet is [_1].',$lastprob->compTitle).'

'); + } $r->rflush(); return; } # # Print out a message telling them what we are doing if (scalar(@$Problems) > 1) { - $r->print('

'. + $r->print('

'. &mt('Preparing Excel spreadsheet of student responses to [_1] problems', scalar(@$Problems)). - '

'); + '

'); } else { - $r->print('

'. + $r->print('

'. &mt('Preparing Excel spreadsheet of student responses'). - '

'); + '

'); } $r->rflush(); # @@ -678,7 +808,17 @@ sub prepare_excel_output { my ($workbook,$filename,$format) = &Apache::loncommon::create_workbook($r); return if (! defined($workbook)); - my $worksheet = $workbook->addworksheet('Student Submission Data'); + + # Worksheet name + # The length of a worksheet name in Excel 95 is limited to 31 characters. + # Let's make sure to not exceed the maximum length in the translation files. + # Otherwise, no Excel file would be created. + my $worksheetname = &mt('Student Submission Data'); + if (length($worksheetname) > 31) { + # nice way to cut off too long name + $worksheetname = substr($worksheetname,0,28,).'...'; + } + my $worksheet = $workbook->addworksheet($worksheetname); # # Add headers to the worksheet my $rows_output = 0; @@ -691,22 +831,28 @@ sub prepare_excel_output { my $partid_row = $rows_output++; my $respid_row = $rows_output++; my $header_row = $rows_output++; - $worksheet->write($title_row ,0,'Problem Title',$format->{'bold'}); - $worksheet->write($partid_row,0,'Part ID',$format->{'bold'}); - $worksheet->write($respid_row,0,'Response ID',$format->{'bold'}); + $worksheet->write($title_row ,0,&mt('Problem Title'),$format->{'bold'}); + $worksheet->write($partid_row,0,&mt('Part ID'),$format->{'bold'}); + $worksheet->write($respid_row,0,&mt('Response ID'),$format->{'bold'}); # Student headers - my @StudentColumns = ('username','domain','id','section'); - foreach (@StudentColumns) { - $worksheet->write($header_row,$cols_output++,ucfirst($_), + my @StudentColumns = &get_student_columns($show_named); + foreach my $field (@StudentColumns) { + $worksheet->write($header_row,$cols_output++,&mt(ucfirst($field)), $format->{'bold'}); } # Problem headers my %start_col; foreach my $prob (@$Problems) { my $title = $prob->compTitle; + my $symb = $prob->symb(); $worksheet->write($title_row,$cols_output, $title,$format->{'h3'}); foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } $worksheet->write($partid_row,$cols_output, $prob->part_display($partid)); my $responses = [$prob->responseIds($partid)]; @@ -733,22 +879,20 @@ sub prepare_excel_output { } # # Populate the worksheet with the student data - my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin - ($r,'Excel File Compilation Status', - 'Excel File Compilation Progress', - scalar(@$Students),'inline',undef,'Statistics','stats_status'); + my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin($r,scalar(@$Students)); my $max_row = $rows_output; foreach my $student (@$Students) { last if ($c->aborted()); $cols_output = 0; my $student_row = $max_row; - foreach my $field (@StudentColumns) { - $worksheet->write($student_row,$cols_output++, - $student->{$field}); - } - my $last_student_col = $cols_output-1; foreach my $prob (@$Problems) { + my $symb = $prob->symb(); foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } my @Response = $prob->responseIds($partid); my @ResponseType = $prob->responseType($partid); for (my $i=0;$i<=$#Response;$i++) { @@ -795,16 +939,24 @@ sub prepare_excel_output { } } } - # Fill in the remaining rows with the students data - for (my $row = $student_row+1;$row<$max_row;$row++) { + # Prepend current student's user information to all rows + for (my $row = $student_row;$row<$max_row;$row++) { my $cols = 0; foreach my $field (@StudentColumns) { - $worksheet->write($row,$cols++, - $student->{$field}); + if ($show_named) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsgdisplay::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $worksheet->write($row,$cols++,$value); + } else { + $worksheet->write($row,$cols++, + &mt('Anonymized')); + } } } - &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state, - 'last student'); + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); } &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); # @@ -910,17 +1062,14 @@ sub excel_format_item { ######################################################### ######################################################### sub prepare_csv_output { - my ($r,$problems,$students) = @_; + my ($r,$problems,$students,$anoncounter,$show_named) = @_; my $c = $r->connection(); # - $r->print('

'. - &mt('Generating CSV report of student responses').'

'); + $r->print('

'. + &mt('Generating CSV report of student responses').'

'); # # Progress window - my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin - ($r,'CSV File Compilation Status', - 'CSV File Compilation Progress', - scalar(@$students),'inline',undef,'Statistics','stats_status'); + my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin($r,scalar(@$students)); $r->rflush(); # @@ -942,10 +1091,11 @@ sub prepare_csv_output { } # # Compute the number of columns per response - my @extra_resp_headers = &get_extra_response_headers(); + my @extra_resp_headers = &get_extra_response_headers($show_named); # # Create the table header - my @student_columns = ('username','domain','id','section'); + my @student_columns = &get_student_columns($show_named); + my $student_column_count = scalar(@student_columns); # my %headers; push(@{$headers{'student'}},@student_columns); @@ -957,12 +1107,18 @@ sub prepare_csv_output { # we put the headers into the %headers hash my %problem_analysis; my %start_col; - my $max_column = scalar(@student_columns); + my $max_column = $student_column_count; foreach my $prob (@$problems) { + my $symb = $prob->symb(); my %analysis = &Apache::lonstathelpers::get_problem_data($prob->src); $problem_analysis{$prob->src}=\%analysis; $headers{'problem'}->[$max_column] = $prob->compTitle; foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } $headers{'part'}->[$max_column] = $prob->part_display($partid); my $responses = [$prob->responseIds($partid)]; my $resptypes = [$prob->responseType($partid)]; @@ -996,7 +1152,13 @@ sub prepare_csv_output { last if ($c->aborted()); my @rows; foreach my $prob (@$problems) { + my $symb = $prob->symb; foreach my $partid (@{$prob->parts}) { + if (($prob->is_anonsurvey($partid)) || ($anoncounter->{$symb."\0".$partid})) { + next if ($show_named); + } else { + next unless ($show_named); + } my @responses = $prob->responseIds($partid); my @response_type = $prob->responseType($partid); for (my $i=0;$i<=$#responses;$i++) { @@ -1034,10 +1196,22 @@ sub prepare_csv_output { } } foreach my $row (@rows) { - print $outputfile '"'.join('","', - map { $student->{$_}; } - @student_columns).'"'; - for (my $i=scalar(@student_columns);$i<$max_column;$i++) { + my $student_row_data = ''; + if ($show_named) { + foreach my $field (@student_columns) { + my $value = $student->{$field}; + if ($field eq 'comments') { + $value = &Apache::lonmsgdisplay::retrieve_instructor_comments + ($student->{'username'},$student->{'domain'}); + } + $student_row_data .= '"'.&Apache::loncommon::csv_translate($value).'",'; + } + $student_row_data =~ s/,$//; + } else { + $student_row_data = '"'.&mt('Anonymized').'"'; + } + print $outputfile $student_row_data; + for (my $i=$student_column_count;$i<$max_column;$i++) { my $value = &Apache::loncommon::csv_translate($row->[$i]); $value ||=''; print $outputfile ',"'.$value.'"'; @@ -1045,8 +1219,7 @@ sub prepare_csv_output { print $outputfile $/; } undef(@rows); - &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state, - 'last student'); + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); } close($outputfile); # @@ -1083,7 +1256,7 @@ sub CreateInterface { foreach ('HTML','Excel','CSV') { $output_selector .= '