--- loncom/interface/spreadsheet/lonspreadsheet.pm	2003/05/19 14:06:18	1.2
+++ loncom/interface/spreadsheet/lonspreadsheet.pm	2005/05/17 17:48:19	1.41
@@ -1,5 +1,5 @@
 #
-# $Id: lonspreadsheet.pm,v 1.2 2003/05/19 14:06:18 matthew Exp $
+# $Id: lonspreadsheet.pm,v 1.41 2005/05/17 17:48:19 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,15 +83,118 @@ 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>';
 }
 
+sub file_dialogs {
+    my ($spreadsheet) = @_;
+    my $bgcolor = "#FFFFFF";
+    my $sheettype = $spreadsheet->{'type'};
+    my $result = '';
+    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'});
+        my $save_status = $spreadsheet->save();
+        if ($save_status ne 'ok') {
+            $message .= "An error occurred while saving the spreadsheet".
+                "There error is:".$save_status;
+        } else {
+            $message .= "Spreadsheet saved as ".$spreadsheet->filename();
+        }
+    } 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->save_tmp();
+        # output that we are dealing with a temporary file
+        $result .=&hiddenfield('workcopy',$sheettype);
+        if ($env{'form.newformula'} !~ /^\s*$/) {
+            $message .='<table><tr>'.
+              '<td valign="top"><pre>'.&mt('Cell').' '.$env{'form.cell'}.' = </pre></td>'.
+              '<td><pre>'.$env{'form.newformula'}."</pre></td></tr></table>\n";
+        } else {
+            $message .= &mt('Deleted contents of cell').' '.$env{'form.cell'}.'.';
+        }
+    }
+    ##
+    ## Editing code
+    $result .=&hiddenfield('cell','').
+              &hiddenfield('newformula','');
+    ##
+    ## Create the save and load dialogs
+    my $filename = $spreadsheet->filename();
+    my $truefilename = $filename;
+    if ($spreadsheet->is_default()) {
+        $filename = 'Default';
+    }
+    my $save_dialog = '<nobr>'.
+        '<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="'.&mt('Save as & Make This Sheet the Default').'"/>';
+    #
+    my $link = '<a href="javascript:openbrowser'.
+        "('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>
+    <td><nobr>
+        <input type="text" name="loadfilename" size="20" value="$filename" />
+        $link</nobr>
+    </td></tr>
+<tr><td>&nbsp;</td><td>
+    <select name="fileselect" onchange="document.sheet.loadfilename.value=document.sheet.fileselect.value" >
+END
+    my $default_filename_set = 0;
+    foreach my $sheetfilename ($spreadsheet->othersheets()) {
+        $load_dialog .= '    <option value="'.$sheetfilename.'"';
+        if ($filename eq $sheetfilename) {
+            $load_dialog .= ' selected';
+            $default_filename_set = 1;
+        }
+        $load_dialog .= '>'.$sheetfilename."</option>\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>
+    <td>$load_dialog</td>
+    <td>
+        <table bgcolor="$bgcolor">
+        <tr><td>$save_dialog</td></tr>
+        <tr><td align="center">$makedefault_dialog</td></tr>
+        </table>
+    </td>
+</tr>
+</table>
+<!--
+    </fieldset>
+  -->
+END
+    return ($result,$message);
+}
+
 sub handler {
     my $r=shift;
     #
@@ -98,13 +205,13 @@ sub handler {
     if ($loaderror) { return $loaderror; }
     # Check the course homeserver
     $loaderror= &Apache::lonnet::overloaderror($r,
-                      $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
-    if ($loaderror) { return $loaderror; } 
+                      $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;
     }
@@ -112,55 +219,97 @@ 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;
+    ##
+    ## Check permissions
+    my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
+                                                $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'});
+    if (! $allowed_to_view) {
+        $allowed_to_view = &Apache::lonnet::allowed('vgr',
+                    $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.
     }
     #
+    # Only those able to view others grades will be allowed to continue 
+    # if they are not requesting their own.
+    if ($sheettype eq 'classcalc') {
+        if (! $allowed_to_view) {
+	    $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') {
+        # Check that the student is in their section?
+        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.
     #
-    $r->content_type('text/html');
-    $r->header_out('Cache-control','no-cache');
-    $r->header_out('Pragma','no-cache');
+    &Apache::loncommon::content_type($r,'text/html');
+    &Apache::loncommon::no_cache($r);
     $r->send_http_header;
-    #
-    # Check user permissions - only those able to view others grades
-    # will be allowed to continue if they are not requesting their own.
-    if (($sheettype eq 'classcalc') || 
-        ($name   ne $ENV{'user.name'} ) ||
-        ($domain ne $ENV{'user.domain'})) {
-        if (! &Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
-            $r->print('<h1>Access Permission Denied</h1>'.
-                      '</form></body></html>');
-            return OK;
-        }
-    }
+
     #
     # Header....
     #
@@ -169,9 +318,18 @@ sub handler {
     ##
     ## Spit out the javascript required for editing
     ##
-    if (&Apache::lonnet::allowed('mgr',$ENV{'request.course.id'})) {
+    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">
+<script type="text/javascript">
+//<!--
+    $extra_javascript
 
     var editwin;
 
@@ -181,11 +339,11 @@ sub handler {
         // we need to escape them?  
         edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
         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+'";';
@@ -195,7 +353,7 @@ 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>';
 
@@ -203,30 +361,75 @@ sub handler {
             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
     }
+    &Apache::lonhtmlcommon::clear_breadcrumbs();
+    &Apache::lonhtmlcommon::add_breadcrumb
+        ({href  => $r->uri,
+          title => 'Spreadsheet',
+          text  => 'Spreadsheet',
+          faq   => 134,
+          bug   => 'Spreadsheet'});
     $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
+              &Apache::lonhtmlcommon::breadcrumbs(undef,'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();
     ##
-    ## Check permissions
-    my $editing_is_allowed = &Apache::lonnet::allowed('mgr',
-                                                $ENV{'request.course.id'});
-    ##
     ## Determine the filename to use
     my $filename = undef;
-    if ($editing_is_allowed) {
-        $filename = $ENV{'form.filename'} if (exists($ENV{'form.filename'}));
+    if ($allowed_to_edit) {
+        $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
         #
-        if (exists($ENV{'form.load'}) && exists($ENV{'form.loadfilename'})) {
-            $filename = $ENV{'form.loadfilename'};
+        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>');
+            }
         }
     }
     ##
@@ -239,7 +442,7 @@ ENDSCRIPT
         $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef);
     } elsif ($sheettype eq 'assesscalc' && 
              defined($symb) && 
-             $editing_is_allowed) {
+             $allowed_to_edit) {
         $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb);
     } else {
         return HTTP_NOT_ACCEPTABLE;
@@ -248,85 +451,83 @@ ENDSCRIPT
         # error error - run in circles, scream and shout
         return;
     }
+    $spreadsheet->initialize();
+    #
+    # Output selector
     ##
     ## Editing/loading/saving
-    if ($editing_is_allowed) {
-        ##
-        ## Deal with saving the spreadsheet
-        if (exists($ENV{'form.save'}) && 
-            exists($ENV{'form.savefilename'})) {
-            $spreadsheet->filename($ENV{'form.savefilename'});
-            my $save_status = $spreadsheet->save();
-            if ($save_status ne 'ok') {
-                $r->print("An error occurred while saving the spreadsheet".
-                          "There error is:".$save_status);
-            } else {
-                $r->print("Spreadsheet saved as ".$ENV{'form.savefilename'});
+    if ($allowed_to_edit) {
+        my ($html,$action_message) = &file_dialogs($spreadsheet);
+        if ($env{'form.makedefault'}) {
+            $spreadsheet->make_default();
+            if ($action_message) {
+                $action_message .= '<br />';
             }
-        } 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->save_tmp();
-            # output that we are dealing with a temporary file
-            $r->print(&hiddenfield('workcopy',$sheettype));
-            $r->print('<pre>'.$ENV{'form.cell'}.' = '.
-                      $ENV{'form.newformula'}.'</pre>'."\n");
-        }
-        ##
-        ## Editing code
-        $r->print(&hiddenfield('cell','').
-                  &hiddenfield('newformula',''));
-        ##
-        ## Create the save and load dialogs
-        $filename = $spreadsheet->filename();
-        $filename = '' if ($filename =~ /^default\.$sheettype/i);
-        $filename =~ s/_$sheettype$//;
-        my $save_dialog = 
-            '<input type="submit" name="save" value="Save as ..." /> '.
-                '<input type="text" name="savefilename" size="30" value="'.
-                    $filename.'" />';
-        my $makedefault_dialog = 
-            '<input type="submit" name="makedefault" value="Make Default"/>';
-        #
-        my $load_dialog = 
-            '<input type="submit" name="load" value="Load ..." />'.
-                '<select name="loadfilename">'.
-                    '<option name="Default">Default</option>'."\n";
-        foreach my $sheetfilename ($spreadsheet->othersheets()) {
-            $sheetfilename =~ s/_$sheettype$//;
-            $load_dialog .= '<option name="'.$sheetfilename.'"';
-            if ($filename eq $sheetfilename) {
-                $load_dialog .= ' selected';
+            $action_message .= &mt('Made this spreadsheet the default');
+            if ($sheettype eq 'classcalc') {
+                $action_message .= ' '.&mt('for the course');
+            } elsif ($sheettype eq 'studentcalc') {
+                $action_message .= ' '.&mt('for all students');
+            } elsif ($sheettype eq 'assesscalc') {
+                $action_message .= ' '.&mt('for all assessments');
             }
-            $load_dialog .= '>'.$sheetfilename."</option>\n";
+            $action_message .= '.';
         }
-        #
-        $r->print(<<END);
-<!-- load / save dialogs -->
-<table cellspacing="3">
-<tr>
-<td>$load_dialog</td>
-<td>$save_dialog</td>
-<td>$makedefault_dialog</td>
+        $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>
+<tr><td valign="top"><b>Last Action:</b></td>
+    <td>&nbsp;</td>
+    <td>$action_message</td>
 </tr>
 </table>
 END
+        }
         $r->rflush();
+    } else {
+        $r->print('<table><tr><td>'.$spreadsheet->html_header().
+                  "</td></tr></table>\n");
+    }
+    $r->rflush();
+    #
+    $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));
     #
-    $r->print($spreadsheet->get_title());
-    $r->print($spreadsheet->parent_link());
-    if (defined($spreadsheet)) {
+    # 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') {
+        $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>');
+    $spreadsheet->clear_package();
     return OK;
 }