--- loncom/interface/spreadsheet/lonspreadsheet.pm	2003/06/19 16:04:06	1.13
+++ loncom/interface/spreadsheet/lonspreadsheet.pm	2006/05/01 19:30:10	1.48
@@ -1,5 +1,5 @@
 #
-# $Id: lonspreadsheet.pm,v 1.13 2003/06/19 16:04:06 matthew Exp $
+# $Id: lonspreadsheet.pm,v 1.48 2006/05/01 19:30:10 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -54,12 +54,16 @@ built-in functions.
 package Apache::lonspreadsheet;
             
 use strict;
+use warnings FATAL=>'all';
+no warnings 'uninitialized';
 use Apache::classcalc();
 use Apache::studentcalc();
 use Apache::assesscalc();
 use Apache::Constants qw(:common :http);
 use Apache::lonnet;
 use Apache::lonhtmlcommon;
+use Apache::lonlocal;
+use Apache::loncoursedata();
 use HTML::Entities();
 
 ##
@@ -68,8 +72,8 @@ use HTML::Entities();
 
 sub textfield {
     my ($title,$name,$value)=@_;
-    return "\n<p><b>$title:</b><br>".
-        '<input type=text name="'.$name.'" size=80 value="'.$value.'">';
+    return "\n<p><b>$title:</b><br />".
+        '<input type=text name="'.$name.'" size=80 value="'.$value.'" />';
 }
 
 sub hiddenfield {
@@ -79,11 +83,11 @@ sub hiddenfield {
 
 sub selectbox {
     my ($title,$name,$value,%options)=@_;
-    my $selout="\n<p><b>$title:</b><br>".'<select name="'.$name.'">';
+    my $selout="\n<p><b>$title:</b><br />".'<select name="'.$name.'">';
     foreach (sort keys(%options)) {
         $selout.='<option value="'.$_.'"';
         if ($_ eq $value) { $selout.=' selected'; }
-        $selout.='>'.$options{$_}.'</option>';
+        $selout.='>'.&mt($options{$_}).'</option>';
     }
     return $selout.'</select>';
 }
@@ -96,33 +100,33 @@ sub file_dialogs {
     my $message = '';
     ##
     ## Deal with saving the spreadsheet
-    if ((exists($ENV{'form.save'}) || exists($ENV{'form.makedefault'})) && 
-        exists($ENV{'form.savefilename'})) {
-        $spreadsheet->filename($ENV{'form.savefilename'});
+    $spreadsheet->check_formulas_loaded();
+    if ((exists($env{'form.save'}) || exists($env{'form.makedefault'})) && 
+        exists($env{'form.savefilename'})) {
+        $spreadsheet->filename($env{'form.savefilename'});
         my $save_status = $spreadsheet->save();
         if ($save_status ne 'ok') {
             $message .= "An error occurred while saving the spreadsheet".
                 "There error is:".$save_status;
-            return $result;
         } else {
-            $message .= "Spreadsheet saved as ".$ENV{'form.savefilename'};
+            $message .= "Spreadsheet saved as ".$spreadsheet->filename();
         }
-    } elsif (exists($ENV{'form.newformula'}) && 
-             exists($ENV{'form.cell'})       && 
-             $ENV{'form.cell'} ne '' ) {
+    } elsif (exists($env{'form.newformula'}) && 
+             exists($env{'form.cell'})       && 
+             $env{'form.cell'} ne '' ) {
         ##
         ## Make any requested modifications to the spreadsheet
-        $spreadsheet->modify_cell($ENV{'form.cell'},
-                                  $ENV{'form.newformula'});
+        $spreadsheet->modify_cell($env{'form.cell'},
+                                  $env{'form.newformula'});
         $spreadsheet->save_tmp();
         # output that we are dealing with a temporary file
         $result .=&hiddenfield('workcopy',$sheettype);
-        if ($ENV{'form.newformula'} !~ /^\s*$/) {
+        if ($env{'form.newformula'} !~ /^\s*$/) {
             $message .='<table><tr>'.
-              '<td valign="top"><pre>Cell '.$ENV{'form.cell'}.' = </pre></td>'.
-              '<td><pre>'.$ENV{'form.newformula'}."</pre></td></tr></table>\n";
+              '<td valign="top"><pre>'.&mt('Cell').' '.$env{'form.cell'}.' = </pre></td>'.
+              '<td><pre>'.$env{'form.newformula'}."</pre></td></tr></table>\n";
         } else {
-            $message .= 'Deleted contents of cell '.$ENV{'form.cell'}.'.';
+            $message .= &mt('Deleted contents of cell').' '.$env{'form.cell'}.'.';
         }
     }
     ##
@@ -137,18 +141,19 @@ sub file_dialogs {
         $filename = 'Default';
     }
     my $save_dialog = '<nobr>'.
-        '<input type="submit" name="save" value="Save as" /> '.
+        '<input type="submit" name="save" value="'.&mt('Save as').'" /> '.
         '<input type="text" name="savefilename" size="30" value="'.
         $truefilename.'" />'.
         '</nobr>';
     my $makedefault_dialog = '<input type="submit" name="makedefault" '.
-        'value="Save as & Make This Sheet the Default"/>';
+        'value="'.&mt('Save as & Make This Sheet the Default').'"/>';
     #
     my $link = '<a href="javascript:openbrowser'.
-        "('sheet','loadfilename','spreadsheet')\">Select Spreadsheet File</a>";
+        "('sheet','loadfilename','spreadsheet')\">".&mt('Select Spreadsheet File')."</a>";
+    my $load=&mt('Load:');
     my $load_dialog = <<END;
 <table bgcolor="$bgcolor">
-<tr><td><input type="submit" name="load" value="Load" /></td>
+<tr><td><input type="submit" name="load" value="$load" /></td>
     <td><nobr>
         <input type="text" name="loadfilename" size="20" value="$filename" />
         $link</nobr>
@@ -158,16 +163,20 @@ sub file_dialogs {
 END
     my $default_filename_set = 0;
     foreach my $sheetfilename ($spreadsheet->othersheets()) {
-        $load_dialog .= '    <option name="'.$sheetfilename.'"';
+        $load_dialog .= '    <option value="'.$sheetfilename.'"';
         if ($filename eq $sheetfilename) {
             $load_dialog .= ' selected';
             $default_filename_set = 1;
         }
         $load_dialog .= '>'.$sheetfilename."</option>\n";
     }
-    $load_dialog .= "</td><td>&nbsp;</td></tr>\n</table>\n";
+    $load_dialog .= "</select>\n</td><td>&nbsp;</td></tr>\n</table>\n";
         #
     $result .=<<END;
+<!-- 
+    <fieldset title="File Dialogs" >
+    <legend>File Dialogs</legend>
+  -->
 <!-- load / save dialogs -->
 <table cellspacing="2">
 <tr>
@@ -180,6 +189,9 @@ END
     </td>
 </tr>
 </table>
+<!--
+    </fieldset>
+  -->
 END
     return ($result,$message);
 }
@@ -194,13 +206,13 @@ sub handler {
     if ($loaderror) { return $loaderror; }
     # Check the course homeserver
     $loaderror= &Apache::lonnet::overloaderror($r,
-                      $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
+                      $env{'course.'.$env{'request.course.id'}.'.home'});
 #    if ($loaderror) { return $loaderror; } 
     #
     # HTML Header
     #
     if ($r->header_only) {
-        $r->content_type('text/html');
+        &Apache::loncommon::content_type($r,'text/html');
         $r->send_http_header;
         return OK;
     }
@@ -208,54 +220,72 @@ sub handler {
     # Roles Checking
     #
     # Needs to be in a course
-    if (! $ENV{'request.course.fn'}) { 
+    if (! $env{'request.course.fn'}) { 
         # Not in a course, or not allowed to modify parms
-        $ENV{'user.error.msg'}=
+        $env{'user.error.msg'}=
             $r->uri.":opa:0:0:Cannot modify spreadsheet";
         return HTTP_NOT_ACCEPTABLE; 
     }
+    my $courseid = $env{'request.course.id'};
+    #
+    # Do not allow students to continue if standard or external grading is in
+    # effect.
+    #
+    if ($env{'request.role'} =~ /^st\./) {
+        if ($env{'course.'.$courseid.'.grading'} eq 'standard' ||
+	    $env{'course.'.$courseid.'.grading'} eq 'external' ) {
+            return HTTP_NOT_ACCEPTABLE;
+        }
+    }
     #
     # Get query string for limited number of parameters
     #
     &Apache::loncommon::get_unprocessed_cgi
-        ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename']);
+        ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename','recalc',
+                               'output_format','not_first_run']);
     #
     # Deal with restricted student permissions 
     #
-    if ($ENV{'request.role'} =~ /^st\./) {
-        delete $ENV{'form.cell'}       if (exists($ENV{'form.cell'}));
-        delete $ENV{'form.newformula'} if (exists($ENV{'form.newformula'}));
+    if ($env{'request.role'} =~ /^st\./) {
+        delete $env{'form.cell'}       if (exists($env{'form.cell'}));
+        delete $env{'form.newformula'} if (exists($env{'form.newformula'}));
     }
     #
     # Determine basic information about the spreadsheet
     my ($sheettype) = ($r->uri=~/\/(\w+)$/);
     #
     my $symb   = undef;
-    $symb = $ENV{'form.usymb'} if (exists($ENV{'form.usymb'}));
-    my $name   = $ENV{'user.name'};
-    my $domain = $ENV{'user.domain'};
-    if (exists($ENV{'form.sname'})) {
-        $name   = $ENV{'form.sname'};
-        $domain = $ENV{'form.sdomain'};
+    $symb = $env{'form.usymb'} if (exists($env{'form.usymb'}));
+    my $name   = $env{'user.name'};
+    my $domain = $env{'user.domain'};
+    if (exists($env{'form.sname'}) && $env{'form.sname'} ne '') {
+        $name   = $env{'form.sname'};
+        $domain = $env{'form.sdomain'};
+    }
+    $env{'form.sname'} = $name;
+    $env{'form.sdomain'} = $domain;
+    my $section = &Apache::lonnet::getsection($domain,$name,
+					      $env{'request.course.id'});
+    my @groups;
+    if (($env{'user.name'} eq $name) && ($env{'user.domain'} eq $domain)) {
+        @groups = &Apache::lonnet::sort_course_groups($env{'request.course.id'},
+                                    split(':',$env{'request.course.groups'}));
+    } else {
+        @groups = &Apache::lonnet::get_users_groups($domain,$name,
+                                                    $env{'request.course.id'});
     }
-    #
-    # Open page, try to prevent browser cache.
-    #
-    $r->content_type('text/html');
-    $r->header_out('Cache-control','no-cache');
-    $r->header_out('Pragma','no-cache');
-    $r->send_http_header;
+
     ##
     ## Check permissions
     my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
-                                                $ENV{'request.course.id'});
+                                                $env{'request.course.id'});
     # Only those instructors/tas/whatevers with complete access
     # (not section restricted) are able to modify spreadsheets.
     my $allowed_to_view =  &Apache::lonnet::allowed('vgr',
-                                                $ENV{'request.course.id'});
+                                                $env{'request.course.id'});
     if (! $allowed_to_view) {
         $allowed_to_view = &Apache::lonnet::allowed('vgr',
-                    $ENV{'request.course.id'}.'/'.$ENV{'request.course.sec'});
+                    $env{'request.course.id'}.'/'.$env{'request.course.sec'});
         # Those who are restricted by section are allowed to view.
         # The routines in lonstatistics which decide which students' 
         # will be shown take care of the restriction by section.
@@ -265,41 +295,60 @@ sub handler {
     # if they are not requesting their own.
     if ($sheettype eq 'classcalc') {
         if (! $allowed_to_view) {
-            $r->print('<h1>Access Permission Denied</h1>'.
-                      '</form></body></html>');
-            return OK;
-        }
+	    $env{'user.error.msg'}=
+		$r->uri.":vgr:0:0:Access Permission Denied";
+	    return HTTP_NOT_ACCEPTABLE; 
+	}
     }
-    if ((($name   ne $ENV{'user.name'} ) ||
-         ($domain ne $ENV{'user.domain'})) && $sheettype ne 'classcalc') {
+    if ((($name   ne $env{'user.name'} ) ||
+         ($domain ne $env{'user.domain'})) && $sheettype ne 'classcalc') {
         # Check that the student is in their section?
-        if (exists($ENV{'request.course.sec'}) && 
-            $ENV{'request.course.sec'} ne '' ) {
-            my $stu_sec = &Apache::lonnet::usection($domain,$name,
-                                                    $ENV{'request.course.id'});
-            if ($stu_sec ne $ENV{'request.course.sec'}) {
-                $r->print
-                    ('<h1>The student requested is not in your section.</h1>'.
-                     '</form></body></html>');
-                return OK;
+        if (exists($env{'request.course.sec'}) && 
+            $env{'request.course.sec'} ne '' ) {
+            my $stu_sec = &Apache::lonnet::getsection($domain,$name,
+						    $env{'request.course.id'});
+            if ($stu_sec ne $env{'request.course.sec'}) {
+		$env{'user.error.msg'}=
+		    $r->uri.":vgr:0:0:Requested student not in your section.";
+		return HTTP_NOT_ACCEPTABLE; 
             }
         }
     }
 
     #
+    # Open page, try to prevent browser cache.
+    #
+    &Apache::loncommon::content_type($r,'text/html');
+    &Apache::loncommon::no_cache($r);
+    $r->send_http_header;
+
+    #
     # Header....
     #
-    $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
     my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
     ##
     ## Spit out the javascript required for editing
     ##
+    my $js;
     if ($allowed_to_edit) {
+	my %lt=(
+		'ce' => 'Cell',
+		'ac' => 'Accept',
+		'dc' => 'Discard Changes'
+	);
         my $extra_javascript = 
             &Apache::loncommon::browser_and_searcher_javascript();
-        $r->print(<<ENDSCRIPT);
-<script language="JavaScript">
-
+	
+	my $cell_edit_start = 
+	    &Apache::loncommon::start_page('Cell Edit Window',undef,
+					   {'only_body' => 1,
+					    'js_ready'  => 1,});
+	my $cell_edit_end = 
+	    &Apache::loncommon::end_page({'js_ready'  => 1,});
+
+        $js = <<ENDSCRIPT;
+<script type="text/javascript">
+//<!--
     $extra_javascript
 
     var editwin;
@@ -308,13 +357,13 @@ sub handler {
         var edit_text = '';
         // cellformula may contain less-than and greater-than symbols, so
         // we need to escape them?  
-        edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
+        edit_text +='$cell_edit_start';
         edit_text += '<form name="editwinform">';
-        edit_text += '<center><h3>Cell '+cellname+'</h3>';
-        edit_text += '<textarea name="newformula" cols="40" rows="6"';
+        edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
+        edit_text += '<textarea name="newformula" cols="60" rows="12"';
         edit_text += ' wrap="off" >'+cellformula+'</textarea>';
         edit_text += '</br>';
-        edit_text += '<input type="button" name="accept" value="Accept"';
+        edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
         edit_text += ' onClick=\\\'javascript:';
         edit_text += 'opener.document.sheet.cell.value=';
         edit_text +=     '"'+cellname+'";';
@@ -324,35 +373,83 @@ sub handler {
         edit_text += 'self.close()\\\' />';
         edit_text += '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
         edit_text += '<input type="button" name="abort" ';
-        edit_text +=     'value="Discard Changes"';
+        edit_text +=     'value="$lt{'dc'}"';
         edit_text += ' onClick="javascript:self.close()" />';
-        edit_text += '</center></body></html>';
+        edit_text += '</center>$cell_edit_end';
 
         if (editwin != null && !(editwin.closed) ) {
             editwin.close();
         }
 
-        editwin = window.open($nothing,'CellEditWin','height=200,width=350,scrollbars=no,resizeable=yes,alwaysRaised=yes,dependent=yes',true);
+        editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
         editwin.document.write(edit_text);
     }
+//-->
 </script>
 ENDSCRIPT
     }
-    $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
+    &Apache::lonhtmlcommon::clear_breadcrumbs();
+    &Apache::lonhtmlcommon::add_breadcrumb
+        ({href  => $r->uri,
+          title => 'Spreadsheet',
+          text  => 'Spreadsheet',
+          faq   => 134,
+          bug   => 'Spreadsheet'});
+    $r->print(&Apache::loncommon::start_page('Grades Spreadsheet',$js).
+              &Apache::lonhtmlcommon::breadcrumbs('Spreadsheet').
               '<form action="'.$r->uri.'" name="sheet" method="post">');
-    $r->print(&hiddenfield('sname'  ,$ENV{'form.sname'}).
-              &hiddenfield('sdomain',$ENV{'form.sdomain'}).
-              &hiddenfield('usymb'  ,$ENV{'form.usymb'}));
+    $r->print(&hiddenfield('sname'  ,$env{'form.sname'}).
+              &hiddenfield('sdomain',$env{'form.sdomain'}).
+              &hiddenfield('usymb'  ,$env{'form.usymb'}));
     $r->rflush();
     ##
     ## Determine the filename to use
     my $filename = undef;
     if ($allowed_to_edit) {
-        $filename = $ENV{'form.filename'} if (exists($ENV{'form.filename'}));
+        $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
         #
-        if (exists($ENV{'form.load'}) && exists($ENV{'form.loadfilename'})) {
-            $filename = $ENV{'form.loadfilename'};
-            $ENV{'form.workcopy'} = 'no';
+        if (exists($env{'form.load'}) && exists($env{'form.loadfilename'})) {
+            $filename = $env{'form.loadfilename'};
+            $env{'form.workcopy'} = 'no';
+        }
+    }
+    ##
+    ## Take care of "backdoor" spreadsheet expiration / recalc stuff
+    if ($allowed_to_edit && exists($env{'form.recalc'})) {
+        if (exists($env{'form.recalc'})) {
+            &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
+        }
+        if ($env{'form.recalc'} eq 'ilovewastingtime') {
+            &Apache::lonnet::logthis('spreadsheet expired: entire course');
+            # expire ALL spreadsheets
+            &Apache::lonnet::expirespread('','','studentcalc');
+            &Apache::lonnet::expirespread('','','assesscalc');
+            $r->print('<h3>'.
+                      &mt('Expired spreadsheet caches for all students').
+                      '</h3>');
+        } elsif ($env{'form.recalc'} =~ /^symb:/) {
+            # expire for all students on this symb
+            my ($symb) = ($env{'form.recalc'} =~ /^symb:(.*)$/);
+            &Apache::lonnet::logthis('spreadsheet expired: symb = '.$symb);
+            &Apache::lonnet::expirespread('','','assesscalc',$symb);
+            &Apache::lonnet::expirespread('','','studentcalc');
+            $r->print('<h3>'.
+              &mt('Expired spreadsheet caches for all students for symb  [_1]',
+                  $symb).
+                      '</h3>');
+        } elsif ($env{'form.recalc'} =~ /^student:/) {
+            # expire all assessment spreadsheets for this user
+            my ($sname,$sdom) = ($env{'form.recalc'}=~/^student:(.*):(.*)$/);
+            &Apache::lonnet::logthis('spreadsheet expired: student = '.
+                                     $sname.'@'.$sdom);
+            if (defined($sname) && defined($sdom)) {
+                &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
+                &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
+                $r->print('<h3>'.
+                          &mt('Expired spreadsheet caches for student [_1]',
+                              $sname.'@'.$sdom).
+                          '</h3>');
+            }
         }
     }
     ##
@@ -360,13 +457,16 @@ ENDSCRIPT
     &Apache::Spreadsheet::initialize_spreadsheet_package();
     my $spreadsheet = undef;
     if ($sheettype eq 'classcalc') {
-        $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef);
+        $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef,
+					      $section,\@groups);
     } elsif ($sheettype eq 'studentcalc') {
-        $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef);
+        $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef,
+						$section,\@groups);
     } elsif ($sheettype eq 'assesscalc' && 
              defined($symb) && 
              $allowed_to_edit) {
-        $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb);
+        $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb,
+					       $section,\@groups);
     } else {
         return HTTP_NOT_ACCEPTABLE;
     }
@@ -381,23 +481,25 @@ ENDSCRIPT
     ## Editing/loading/saving
     if ($allowed_to_edit) {
         my ($html,$action_message) = &file_dialogs($spreadsheet);
-        if ($ENV{'form.makedefault'}) {
+        if ($env{'form.makedefault'}) {
             $spreadsheet->make_default();
             if ($action_message) {
                 $action_message .= '<br />';
             }
-            $action_message .= 'Made this spreadsheet the default';
+            $action_message .= &mt('Made this spreadsheet the default');
             if ($sheettype eq 'classcalc') {
-                $action_message .= ' for the course';
+                $action_message .= ' '.&mt('for the course');
             } elsif ($sheettype eq 'studentcalc') {
-                $action_message .= ' for all students';
+                $action_message .= ' '.&mt('for all students');
             } elsif ($sheettype eq 'assesscalc') {
-                $action_message .= ' for all assessments';
+                $action_message .= ' '.&mt('for all assessments');
             }
             $action_message .= '.';
         }
-        $r->print('<table><tr><td>'.$spreadsheet->html_header().'</td>'.
-                  '<td valign="bottom">'.$html."</td></tr></table>\n");
+        $r->print('<table><tr><td valign="top">'.
+                  $spreadsheet->html_header().
+                  '</td>'.
+                  '<td valign="center">'.$html."</td></tr></table>\n");
         if ($action_message ne '') {
             $r->print(<<END);
 <table>
@@ -415,9 +517,23 @@ END
     }
     $r->rflush();
     #
-    if ($sheettype eq 'classcalc') {
-        $r->print('<input type="submit" value="Generate Spreadsheet" /><br />');
+    $r->print("<table><tr>");
+    $r->print('<td><input type="submit" value="'.
+              &mt('Generate Spreadsheet').'" />'.
+              '</td>');
+    if ($allowed_to_view) {
+        $r->print('<td>'.
+                  &Apache::loncommon::help_open_topic("Spreadsheet_About",
+                                                      'Spreadsheet Help').
+                  '</td>');
     }
+    if ($allowed_to_edit) {
+        $r->print('<td>'.
+                  &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
+                                                      'Editing Help').
+                  '</td>');
+    }
+    $r->print('</tr></table>');
     #
     # Keep track of the filename
     $r->print(&hiddenfield('filename',$filename));
@@ -425,14 +541,16 @@ END
     # Keep track of the number of times we have been called, sort of.
     $r->print(&hiddenfield('not_first_run','whatever'));
     #
-    if (exists($ENV{'form.not_first_run'}) || $sheettype ne 'classcalc') {
+    if (exists($env{'form.not_first_run'}) || $sheettype ne 'classcalc') {
         $r->print($spreadsheet->get_html_title());
         if ($allowed_to_view || $allowed_to_edit) {
             $r->print($spreadsheet->parent_link());
         }
+        $r->rflush();
         $spreadsheet->display($r);
     }
-    $r->print('</form></body></html>');
+    $r->print('</form>'.&Apache::loncommon::end_page());
+    $spreadsheet->clear_package();
     return OK;
 }