--- loncom/interface/statistics/lonstudentassessment.pm	2003/03/03 22:54:05	1.32
+++ loncom/interface/statistics/lonstudentassessment.pm	2003/03/06 21:12:54	1.36
@@ -1,6 +1,6 @@
 # The LearningOnline Network with CAPA
 #
-# $Id: lonstudentassessment.pm,v 1.32 2003/03/03 22:54:05 matthew Exp $
+# $Id: lonstudentassessment.pm,v 1.36 2003/03/06 21:12:54 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -143,6 +143,7 @@ the button marked "Update Disp
 </font>
 </p>
 ENDMSG
+#        $r->print(&OutputDescriptions());
         return;
     }
     #
@@ -155,6 +156,10 @@ ENDMSG
         $initialize     = \&excel_initialize;
         $output_student = \&excel_outputstudent;
         $finish         = \&excel_finish;
+    } elsif ($output_mode eq 'multi-sheet excel') {
+        $initialize     = \&multi_sheet_excel_initialize;
+        $output_student = \&multi_sheet_excel_outputstudent;
+        $finish         = \&multi_sheet_excel_finish;
     } elsif ($output_mode eq 'csv') {
         $initialize     = \&csv_initialize;
         $output_student = \&csv_outputstudent;
@@ -232,7 +237,7 @@ sub CreateInterface {
     $Str .= '<tr>';
     $Str .= '<td align="center"><b>Sections</b></td>';
     $Str .= '<td align="center"><b>Student Data</b></td>';
-    $Str .= '<td align="center"><b>Sequences and Folders</b></td>';
+    $Str .= '<td align="center"><b>Problem Sets</b></td>';
     $Str .= '<td align="center"><b>Output Format</b></td>';
     $Str .= '</tr>'."\n";
     #
@@ -273,33 +278,112 @@ sub CreateInterface {
 my @OutputOptions = 
     ({ name  => 'HTML, with links',
        value => 'html, with links',
-       description => ''},
+       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 => ''},
-     { name  => 'HTML, totals',
-       value => 'html, totals',
-       description => ''},
+       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 => ''},
-     { name  => 'Excel, totals',
-       value => 'excel, totals',
-       description => ''},
+       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 => ''},
-     { name  => 'CSV, totals',
-       value => 'csv, totals',
-       description => ''},
-     { name  => 'CSV, scores only',
-       value => 'csv, scores only',
-       description => ''},
+       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 => ''}
+       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',
+           },
      );
 
+sub OutputDescriptions {
+    my $Str = '';
+    $Str .= "<h2>Output Modes</h2>\n";
+    $Str .= "<dl>\n";
+    foreach my $outputmode (@OutputOptions) {
+	$Str .="    <dt>".$outputmode->{'name'}."</dt>\n";
+	$Str .="        <dd>".$outputmode->{'description'}."</dd>\n";
+    }
+    $Str .= "</dl>\n";
+    return $Str;
+}
+
 sub CreateAndParseOutputSelector {
     my $Str = '';
     my $elementname = 'outputmode';
@@ -318,25 +402,13 @@ sub CreateAndParseOutputSelector {
     $show_links  = 'no';
     $output_mode = 'html';
     $show        = 'all';
-    my ($mode,$restriction) = split(',',$selected);
-    $restriction =~ s/^\s*//;
-    if ($mode =~ /^(html|excel|csv)$/) {
-        $output_mode = $mode;
-    } else {
-        $output_mode = 'html';
-    }
-    if ($restriction eq 'with links') {
-        $show_links = 'yes';
-    } else {
-        $show_links = 'no';
-    }
-    if ($restriction eq 'totals') {
-        $show = 'totals';
-    } elsif ($restriction eq 'scores only') {
-        $show = 'scores';
-    } else {
-        $show = 'everything';
+    foreach my $option (@OutputOptions) {
+        next if ($option->{'value'} ne $selected);
+        $output_mode = $option->{'mode'};
+        $show        = $option->{'show'};
+        $show_links  = $option->{'show_links'};
     }
+
     #
     # Build the form element
     $Str = qq/<select size="5" name="$elementname">/;
@@ -378,7 +450,7 @@ sub html_initialize {
     my ($r) = @_;
     #
     $padding = ' 'x3;
-    $count = 1;
+    $count = 0;
     #
     my $Str = "<pre>\n";
     # First, the @StudentData fields need to be listed
@@ -406,6 +478,10 @@ sub html_initialize {
 sub html_outputstudent {
     my ($r,$student) = @_;
     my $Str = '';
+    #
+    if($count++ % 5 == 0 && $count > 0) {
+        $r->print("</pre><pre>");
+    }
     # First, the @StudentData fields need to be listed
     my @to_show = &get_student_fields_to_show();
     foreach my $field (@to_show) {
@@ -469,11 +545,6 @@ sub html_outputstudent {
     $Str .= " \n";
     $r->print($Str);
     #
-    $count++;
-    if($count % 5 == 0) {
-        $r->print("</pre><pre>");
-    }
-    #
     $r->rflush();
     return;
 }    
@@ -492,6 +563,78 @@ sub html_finish {
 
 =pod
 
+=head2 Multi-Sheet EXCEL subroutines
+
+=item &multi_sheet_excel_initialize($r)
+
+=item &multi_sheet_excel_outputstudent($r,$student)
+
+=item &multi_sheet_excel_finish($r)
+
+=cut
+
+#######################################################
+#######################################################
+{
+
+sub multi_sheet_excel_initialize {
+    my ($r)=@_;
+    $r->print("<h1>Not yet implemented</h1>");
+    # 
+    # 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<br />");
+    $r->print("Number of students: ".$num_students."<br />");
+    $r->print("Number of fields per student: ".$fields_per_student."<br />");
+    $r->print("Total number of fields: ".($fields_per_student*$num_students).
+              "<br />");
+    $r->print("Bytes per field: ".$bytes_per_field." (estimated)"."<br />");
+    $r->print("Estimated size: ".$size_estimate." bytes<br />");
+    $r->print("Number of workbooks: ".$num_workbooks."<br />");
+    $r->rflush();
+    return;
+}
+
+sub multi_sheet_excel_outputstudent {
+    my ($r,$student) = @_;
+}
+
+sub multi_sheet_excel_finish {
+    my ($r) = @_;
+}
+
+}
+#######################################################
+#######################################################
+
+=pod
+
 =head2 EXCEL subroutines
 
 =item &excel_initialize($r)
@@ -513,8 +656,7 @@ my $filename;
 my $rows_output;
 my $cols_output;
 
-my $num_students;
-my $start_time;
+my %prog_state; # progress window state
 
 sub excel_initialize {
     my ($r) = @_;
@@ -529,9 +671,6 @@ sub excel_initialize {
     $rows_output = 0;
     $cols_output = 0;
     #
-    $num_students = 0;
-    $start_time   = time;
-    #
     # Create sheet
     $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
     #
@@ -551,20 +690,55 @@ sub excel_initialize {
     $excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
     #
     # Add a worksheet
-    $excel_sheet = $excel_workbook->addworksheet
-        ($ENV{'course.'.$ENV{'request.course.id'}.'.description'});
+    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];
+        }
+    }
+    $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(1,$cols_output++,$field);
+        $excel_sheet->write($rows_output,$cols_output++,$field);
     }
     #
     # Add the Sequence Headers
     foreach my $seq (&get_sequences_to_show) {
-        $excel_sheet->write(0,$cols_output,$seq->{'title'});
+        $excel_sheet->write($rows_output,$cols_output,$seq->{'title'});
         if ($show eq 'totals') {
-            $excel_sheet->write(1,$cols_output,'score');
-            $excel_sheet->write(1,$cols_output+1,'maximum');
+            $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++;
@@ -573,9 +747,9 @@ sub excel_initialize {
     #
     # Bookkeeping
     if ($show eq 'totals') {
-        $rows_output = 2;
+        $rows_output += 2;
     } else {
-        $rows_output = 1;
+        $rows_output += 1;
     }
     #
     # Let the user know what we are doing
@@ -586,6 +760,11 @@ sub excel_initialize {
     $r->print("</h1>\n");
     $r->rflush();
     #
+    # Initialize progress window
+    %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
+        ($r,'Excel File Compilation Status',
+         'Excel File Compilation Progress', $studentcount);
+    #
     return;
 }
 
@@ -627,30 +806,8 @@ sub excel_outputstudent {
     $rows_output++; 
     $cols_output=0;
     #
-    # Time estimate
-    $num_students++;
-    if ($num_students % 10 == 0) {
-        my $time_est = (time - $start_time)/$num_students * 
-            (scalar(@Apache::lonstatistics::Students)-$num_students);
-        $time_est = int($time_est);
-        if (int ($time_est/60) > 0) {
-            my $min = int($time_est/60);
-            my $sec = $time_est % 60;
-            $time_est = $min.' minutes';
-            if ($sec > 1) {
-                $time_est.= ', '.$sec.' seconds';
-            } elsif ($sec > 0) {
-                $time_est.= ', '.$sec.' second';
-            }
-        } else {
-            $time_est .= ' seconds';
-        }
-        $r->print($num_students.' out of '.
-                  (scalar(@Apache::lonstatistics::Students)).
-                  " students processed.  ".
-                  $time_est." remain.  <br />\n");
-        $r->rflush();
-    }
+    # Update the progress window
+    &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
     return;
 }
 
@@ -664,14 +821,12 @@ sub excel_finish {
     #
     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('<br /><br />'.
+    $r->print('<br />'.
               '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
-    my $total_time = time - $start_time;
-    if (int ($total_time / 60) > 0) {
-        $total_time = int($total_time/60).' minutes, '.($total_time % 60);
-    }
-    $r->print('<br />'.$total_time.' seconds total');
     $r->rflush();
     return;
 }