--- loncom/interface/statistics/lonstudentsubmissions.pm 2010/08/04 01:56:07 1.60 +++ loncom/interface/statistics/lonstudentsubmissions.pm 2014/03/28 15:07:01 1.71 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonstudentsubmissions.pm,v 1.60 2010/08/04 01:56:07 raeburn Exp $ +# $Id: lonstudentsubmissions.pm,v 1.71 2014/03/28 15:07:01 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -30,10 +30,12 @@ use strict; use Apache::lonnet; use Apache::loncommon(); use Apache::lonhtmlcommon(); +use Apache::lonquickgrades(); 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 +63,8 @@ sub BuildStudentSubmissionsPage { # &Apache::lonstatistics::PrepareClasslist(); # + $r->print( &Apache::lonhtmlcommon::breadcrumbs('Student Submission Reports')); + &Apache::lonquickgrades::startGradeScreen($r,'statistics'); $r->print(&CreateInterface()); # my @Students = @Apache::lonstatistics::Students; @@ -177,11 +181,28 @@ sub BuildStudentSubmissionsPage { &array_shuffle(\@Students); } # - $r->print('

'. + + 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]; @@ -206,7 +227,7 @@ 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.','',''). @@ -304,25 +325,16 @@ sub prepare_html_output { my @extra_resp_headers = &get_extra_response_headers($show_named); # # Create the table header - my @student_columns; - if ($show_named) { - @student_columns = @Apache::lonstatistics::SelectedStudentData; - if (grep(/^all$/,@student_columns)) { - @student_columns = qw(fullname username domain id section status groups comments); - } - } else { - @student_columns = ('username'); - } - # + 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; @@ -402,7 +414,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'}.''.$/; @@ -413,11 +426,10 @@ 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()); @@ -515,11 +527,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; @@ -543,22 +550,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(''.$/); + $r->print(&Apache::loncommon::end_data_table().$/); return; } @@ -723,8 +731,29 @@ sub html_non_essay_results { push(@values,$response->{$original_header}); } } + # FIXME: Bug #6700 - Properly process multiple answer fields + # Would be a good place here but the data needs to be properly + # compiled somewhere before. + # elsif (($resptype =~ /^(numerical|formula|custom)$/) && + # (submission) && (ref)) { + # de-ref...: push(@values,$response->{$original_header}); } } else { - @values = map { $response->{$_}; } @$headers; + foreach my $original_header (@$headers) { + if ($original_header eq 'Time') { + push(@values,&Apache::lonlocal::locallocaltime($response->{$original_header})); + } elsif (($original_header eq 'Submission') && + !($resptype =~ /^(radiobutton|option|match|rank)$/)) { + # encode all submissions which have not been encoded above + push(@values,&HTML::Entities::encode($response->{$original_header},'<>&"')); + } elsif (($original_header eq 'Correct') && + ($resptype eq 'radiobutton')) { + # encode foil separators + push(@values,&HTML::Entities::encode($response->{$original_header},'&')); + } else { + # A normal column + push(@values,$response->{$original_header}); + } + } } my $td = ''; my $str = $td.join(''.$td,@values).''; @@ -775,9 +804,9 @@ sub prepare_excel_output { $lastprob = $prob; } if ($columncount > 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.').'

'.$/); + $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).'

'); } @@ -787,14 +816,14 @@ sub prepare_excel_output { # # 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(); # @@ -802,7 +831,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; @@ -815,18 +854,13 @@ 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; - if ($show_named) { - @StudentColumns = qw(username domain id section); - } else { - @StudentColumns = qw(username); - } - 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 @@ -868,25 +902,12 @@ 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) { - if ($show_named) { - $worksheet->write($student_row,$cols_output++, - $student->{$field}); - } else { - $worksheet->write($student_row,$cols_output++, - &mt('Anonymized')); - } - } - my $last_student_col = $cols_output-1; foreach my $prob (@$Problems) { my $symb = $prob->symb(); foreach my $partid (@{$prob->parts}) { @@ -941,21 +962,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) { if ($show_named) { - $worksheet->write($row,$cols++, - $student->{$field}); + 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); # @@ -1064,14 +1088,11 @@ sub prepare_csv_output { 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(); # @@ -1096,12 +1117,7 @@ sub prepare_csv_output { my @extra_resp_headers = &get_extra_response_headers($show_named); # # Create the table header - my @student_columns = ('username','domain','id','section'); - if ($show_named) { - @student_columns = qw(username domain id section); - } else { - @student_columns = qw(username); - } + my @student_columns = &get_student_columns($show_named); my $student_column_count = scalar(@student_columns); # my %headers; @@ -1114,7 +1130,7 @@ 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); @@ -1205,9 +1221,15 @@ sub prepare_csv_output { foreach my $row (@rows) { my $student_row_data = ''; if ($show_named) { - $student_row_data = '"'.join('","', - map { $student->{$_}; } - @student_columns).'"'; + 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').'"'; } @@ -1220,8 +1242,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); # @@ -1238,7 +1259,7 @@ sub prepare_csv_output { sub csv_format_item { my ($item,$type) = @_; if ($type eq 'Time') { - $item = localtime($item); + $item = &Apache::lonlocal::locallocaltime($item); } $item =&Apache::loncommon::csv_translate($item); return $item; @@ -1266,7 +1287,6 @@ sub CreateInterface { ## ## Environment variable initialization my $Str = ''; - $Str .= &Apache::lonhtmlcommon::breadcrumbs('Student Submission Reports'); $Str .= '
'; $Str .= &Apache::loncommon::start_data_table(); $Str .= &Apache::loncommon::start_data_table_header_row(); @@ -1346,15 +1366,23 @@ sub CreateInterface { $Str .= &Apache::loncommon::end_data_table_row(); $Str .= &Apache::loncommon::end_data_table(); # - $Str .= '

' - .&mt('Status: [_1]', - '') - .'

'; - ## return $Str; } +sub get_student_columns { + my ($show_named) = @_; + my @student_columns; + if ($show_named) { + @student_columns = @Apache::lonstatistics::SelectedStudentData; + if (grep(/^all$/,@student_columns)) { + @student_columns = qw(fullname username domain id section status groups comments); + } + } else { + @student_columns = ('username'); + } + return @student_columns; +} + 1; __END__