--- loncom/interface/statistics/lonstudentsubmissions.pm	2010/08/24 14:05:19	1.61
+++ loncom/interface/statistics/lonstudentsubmissions.pm	2012/12/10 23:18:47	1.68.2.2
@@ -1,6 +1,6 @@
 # The LearningOnline Network with CAPA
 #
-# $Id: lonstudentsubmissions.pm,v 1.61 2010/08/24 14:05:19 raeburn Exp $
+# $Id: lonstudentsubmissions.pm,v 1.68.2.2 2012/12/10 23:18:47 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;
@@ -192,9 +194,9 @@ sub BuildStudentSubmissionsPage {
                 $threshold = 10;
             }
         }
-        $r->print('<h4>'.
+        $r->print('<p>'.
                   &Apache::lonstatistics::section_and_enrollment_description().
-                  '</h4>');
+                  '</p>');
         if (! scalar(@Problems) || ! defined($Problems[0])) {
             $r->print(&mt('resource is undefined'));
         } elsif (!$show_named && @Students < $threshold) {
@@ -321,25 +323,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{<th colspan="$student_column_count">\&nbsp;</th>};
-    foreach (@student_columns) {
-        $headers{'student'}.= '<th>'.ucfirst($_).'</th>';
+    foreach my $field (@student_columns) {
+        $headers{'student'}.= '<th>'.&mt(ucfirst($field)).'</th>';
     }
     #
     # 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;
@@ -419,7 +412,8 @@ sub prepare_html_output {
             qq{<th colspan="$student_column_count">\&nbsp;</th>}.
             $headers{'response'};
     }
-    my $full_header = $/.'<table>'.$/;
+    #my $full_header = $/.'<table>'.$/;
+    my $full_header = $/.&Apache::loncommon::start_data_table().$/;
     $full_header .= '<tr align="left">'.$headers{'problem'}.'</tr>'.$/;
     if ($nonempty_part_headers) {
         $full_header .= '<tr align="left">'.$headers{'part'}.'</tr>'.$/;
@@ -430,11 +424,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('</table>'.$/.$full_header.$/);
+            $r->print(&Apache::loncommon::end_data_table().$/.$full_header.$/);
             $count = 0;
         }
         last if ($c->aborted());
@@ -532,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;
@@ -560,22 +548,23 @@ sub prepare_html_output {
                 }
             }
             if (! $no_data) {
-                $r->print(qq{<tr class="$row_class">$student_row_data$html</tr>}.$/);
+                $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{<tr class="$row_class">};
+            my $tr = &Apache::loncommon::start_data_table_row();
             my $td = qq{<td  valign="top" class="essay" colspan="$total_col">};
             if (! $printed_something) {
-                $r->print($tr.$student_row_data.'</tr>'.$/);
+                $r->print($tr.$student_row_data.&Apache::loncommon::end_data_table_row().$/);
             }
             $r->print($tr.$td.
                       join('</td></tr>'.$/.$tr.$td,@essays).'</td></tr>'.$/);
             undef(@essays);
         }
     } # end of student loop
-    $r->print('</table>'.$/);
+    $r->print(&Apache::loncommon::end_data_table().$/);
     return;
 }
 
@@ -741,7 +730,14 @@ sub html_non_essay_results {
             }
         }
     } else {
-        @values = map { $response->{$_}; } @$headers;
+        foreach my $original_header (@$headers) {
+            if ($original_header eq 'Time') {
+                push(@values,&Apache::lonlocal::locallocaltime($response->{$original_header}));
+            } else {
+                # A normal column
+                push(@values,$response->{$original_header});
+            }
+        }
     }
     my $td = '<td valign="top">';
     my $str = $td.join('</td>'.$td,@values).'</td>';
@@ -792,9 +788,9 @@ sub prepare_excel_output {
         $lastprob = $prob;
     }
     if ($columncount > 255) {
-        $r->print('<h1>'.&mt('Unable to complete request').'</h1>'.$/.
-                  '<p>'.&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.').'</p>'.$/.
-                  '<p>'.&mt('Consider selecting fewer problems to generate reports on, or reducing the number of items per problem.  Or use HTML or CSV output.').'</p>'.$/);
+        $r->print('<p class="LC_error">'.&mt('Unable to complete request').'</p>'.$/.
+                  '<p class="LC_warning">'.&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.').'</p>'.$/.
+                  '<p class="LC_warning">'.&mt('Consider selecting fewer problems to generate reports on, or reducing the number of items per problem.  Or use HTML or CSV output.').'</p>'.$/);
         if (ref($lastprob)) {
             $r->print('<p>'.&mt('The last problem that will fit in the current spreadsheet is [_1].',$lastprob->compTitle).'</p>');
         }
@@ -804,14 +800,14 @@ sub prepare_excel_output {
     #
     # Print out a message telling them what we are doing
     if (scalar(@$Problems) > 1) {
-        $r->print('<h2>'.
+        $r->print('<p class="LC_info">'.
                   &mt('Preparing Excel spreadsheet of student responses to [_1] problems',
                       scalar(@$Problems)).
-                  '</h2>');
+                  '</p>');
     } else {
-        $r->print('<h2>'.
+        $r->print('<p class="LC_info">'.
                   &mt('Preparing Excel spreadsheet of student responses').
-                  '</h2>');
+                  '</p>');
     }
     $r->rflush();
     #
@@ -819,7 +815,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;
@@ -832,18 +838,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
@@ -885,25 +886,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}) {
@@ -958,21 +946,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);
     #
@@ -1081,14 +1072,11 @@ sub prepare_csv_output {
     my ($r,$problems,$students,$anoncounter,$show_named) = @_;
     my $c = $r->connection();
     #
-    $r->print('<h2>'.
-              &mt('Generating CSV report of student responses').'</h2>');
+    $r->print('<p class="LC_info">'.
+              &mt('Generating CSV report of student responses').'</p>');
     #
     # 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();
     #
@@ -1113,12 +1101,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;
@@ -1131,7 +1114,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);
@@ -1222,9 +1205,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').'"';
             }
@@ -1237,8 +1226,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);
     #
@@ -1255,7 +1243,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;
@@ -1283,7 +1271,6 @@ sub CreateInterface {
     ##
     ## Environment variable initialization
     my $Str = '';
-    $Str .= &Apache::lonhtmlcommon::breadcrumbs('Student Submission Reports');
     $Str .= '<br />';
     $Str .= &Apache::loncommon::start_data_table();
     $Str .= &Apache::loncommon::start_data_table_header_row();
@@ -1363,15 +1350,23 @@ sub CreateInterface {
     $Str .= &Apache::loncommon::end_data_table_row();
     $Str .= &Apache::loncommon::end_data_table();
     #
-    $Str .= '<p><span class="LC_nobreak">'
-           .&mt('Status: [_1]',
-                    '<input type="text" name="stats_status"'
-                   .' size="60" value="" readonly="readonly" />')
-           .'</span></p>';
-    ##
     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__