Return to lonspreadsheet.pm CVS log

Up to [LON-CAPA] / loncom / interface / spreadsheet

- BUG#4301 - SPRS saving was fuzting things up

    1: #
    2: # $Id: lonspreadsheet.pm,v 1.42 2005/08/29 21:04:52 albertel Exp $
    3: #
    4: # Copyright Michigan State University Board of Trustees
    5: #
    6: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    7: #
    8: # LON-CAPA is free software; you can redistribute it and/or modify
    9: # it under the terms of the GNU General Public License as published by
   10: # the Free Software Foundation; either version 2 of the License, or
   11: # (at your option) any later version.
   12: #
   13: # LON-CAPA is distributed in the hope that it will be useful,
   14: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   16: # GNU General Public License for more details.
   17: #
   18: # You should have received a copy of the GNU General Public License
   19: # along with LON-CAPA; if not, write to the Free Software
   20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   21: #
   22: # /home/httpd/html/adm/gpl.txt
   23: #
   24: # http://www.lon-capa.org/
   25: #
   26: # The LearningOnline Network with CAPA
   27: # Spreadsheet/Grades Display Handler
   28: #
   29: # POD required stuff:
   30: 
   31: =head1 NAME
   32: 
   33: lonspreadsheet
   34: 
   35: =head1 SYNOPSIS
   36: 
   37: Spreadsheet interface to internal LON-CAPA data
   38: 
   39: =head1 DESCRIPTION
   40: 
   41: Lonspreadsheet provides course coordinators the ability to manage their
   42: students grades online.  The students are able to view their own grades, but
   43: not the grades of their peers.  The spreadsheet is highly customizable,
   44: offering the ability to use Perl code to manipulate data, as well as many
   45: built-in functions.
   46: 
   47: =head2 Functions available to user of lonspreadsheet
   48: 
   49: =over 4
   50: 
   51: =cut
   52: 
   53: 
   54: package Apache::lonspreadsheet;
   55:             
   56: use strict;
   57: use warnings FATAL=>'all';
   58: no warnings 'uninitialized';
   59: use Apache::classcalc();
   60: use Apache::studentcalc();
   61: use Apache::assesscalc();
   62: use Apache::Constants qw(:common :http);
   63: use Apache::lonnet;
   64: use Apache::lonhtmlcommon;
   65: use Apache::lonlocal;
   66: use Apache::loncoursedata();
   67: use HTML::Entities();
   68: 
   69: ##
   70: ## HTML utility subroutines really should go in lonhtmlcommon
   71: ##
   72: 
   73: sub textfield {
   74:     my ($title,$name,$value)=@_;
   75:     return "\n<p><b>$title:</b><br />".
   76:         '<input type=text name="'.$name.'" size=80 value="'.$value.'" />';
   77: }
   78: 
   79: sub hiddenfield {
   80:     my ($name,$value)=@_;
   81:     return '<input type=hidden name="'.$name.'" value="'.$value.'" />'."\n";
   82: }
   83: 
   84: sub selectbox {
   85:     my ($title,$name,$value,%options)=@_;
   86:     my $selout="\n<p><b>$title:</b><br />".'<select name="'.$name.'">';
   87:     foreach (sort keys(%options)) {
   88:         $selout.='<option value="'.$_.'"';
   89:         if ($_ eq $value) { $selout.=' selected'; }
   90:         $selout.='>'.&mt($options{$_}).'</option>';
   91:     }
   92:     return $selout.'</select>';
   93: }
   94: 
   95: sub file_dialogs {
   96:     my ($spreadsheet) = @_;
   97:     my $bgcolor = "#FFFFFF";
   98:     my $sheettype = $spreadsheet->{'type'};
   99:     my $result = '';
  100:     my $message = '';
  101:     ##
  102:     ## Deal with saving the spreadsheet
  103:     $spreadsheet->check_formulas_loaded();
  104:     if ((exists($env{'form.save'}) || exists($env{'form.makedefault'})) && 
  105:         exists($env{'form.savefilename'})) {
  106:         $spreadsheet->filename($env{'form.savefilename'});
  107:         my $save_status = $spreadsheet->save();
  108:         if ($save_status ne 'ok') {
  109:             $message .= "An error occurred while saving the spreadsheet".
  110:                 "There error is:".$save_status;
  111:         } else {
  112:             $message .= "Spreadsheet saved as ".$spreadsheet->filename();
  113:         }
  114:     } elsif (exists($env{'form.newformula'}) && 
  115:              exists($env{'form.cell'})       && 
  116:              $env{'form.cell'} ne '' ) {
  117:         ##
  118:         ## Make any requested modifications to the spreadsheet
  119:         $spreadsheet->modify_cell($env{'form.cell'},
  120:                                   $env{'form.newformula'});
  121:         $spreadsheet->save_tmp();
  122:         # output that we are dealing with a temporary file
  123:         $result .=&hiddenfield('workcopy',$sheettype);
  124:         if ($env{'form.newformula'} !~ /^\s*$/) {
  125:             $message .='<table><tr>'.
  126:               '<td valign="top"><pre>'.&mt('Cell').' '.$env{'form.cell'}.' = </pre></td>'.
  127:               '<td><pre>'.$env{'form.newformula'}."</pre></td></tr></table>\n";
  128:         } else {
  129:             $message .= &mt('Deleted contents of cell').' '.$env{'form.cell'}.'.';
  130:         }
  131:     }
  132:     ##
  133:     ## Editing code
  134:     $result .=&hiddenfield('cell','').
  135:               &hiddenfield('newformula','');
  136:     ##
  137:     ## Create the save and load dialogs
  138:     my $filename = $spreadsheet->filename();
  139:     my $truefilename = $filename;
  140:     if ($spreadsheet->is_default()) {
  141:         $filename = 'Default';
  142:     }
  143:     my $save_dialog = '<nobr>'.
  144:         '<input type="submit" name="save" value="'.&mt('Save as').'" /> '.
  145:         '<input type="text" name="savefilename" size="30" value="'.
  146:         $truefilename.'" />'.
  147:         '</nobr>';
  148:     my $makedefault_dialog = '<input type="submit" name="makedefault" '.
  149:         'value="'.&mt('Save as & Make This Sheet the Default').'"/>';
  150:     #
  151:     my $link = '<a href="javascript:openbrowser'.
  152:         "('sheet','loadfilename','spreadsheet')\">".&mt('Select Spreadsheet File')."</a>";
  153:     my $load=&mt('Load:');
  154:     my $load_dialog = <<END;
  155: <table bgcolor="$bgcolor">
  156: <tr><td><input type="submit" name="load" value="$load" /></td>
  157:     <td><nobr>
  158:         <input type="text" name="loadfilename" size="20" value="$filename" />
  159:         $link</nobr>
  160:     </td></tr>
  161: <tr><td>&nbsp;</td><td>
  162:     <select name="fileselect" onchange="document.sheet.loadfilename.value=document.sheet.fileselect.value" >
  163: END
  164:     my $default_filename_set = 0;
  165:     foreach my $sheetfilename ($spreadsheet->othersheets()) {
  166:         $load_dialog .= '    <option value="'.$sheetfilename.'"';
  167:         if ($filename eq $sheetfilename) {
  168:             $load_dialog .= ' selected';
  169:             $default_filename_set = 1;
  170:         }
  171:         $load_dialog .= '>'.$sheetfilename."</option>\n";
  172:     }
  173:     $load_dialog .= "</select>\n</td><td>&nbsp;</td></tr>\n</table>\n";
  174:         #
  175:     $result .=<<END;
  176: <!-- 
  177:     <fieldset title="File Dialogs" >
  178:     <legend>File Dialogs</legend>
  179:   -->
  180: <!-- load / save dialogs -->
  181: <table cellspacing="2">
  182: <tr>
  183:     <td>$load_dialog</td>
  184:     <td>
  185:         <table bgcolor="$bgcolor">
  186:         <tr><td>$save_dialog</td></tr>
  187:         <tr><td align="center">$makedefault_dialog</td></tr>
  188:         </table>
  189:     </td>
  190: </tr>
  191: </table>
  192: <!--
  193:     </fieldset>
  194:   -->
  195: END
  196:     return ($result,$message);
  197: }
  198: 
  199: sub handler {
  200:     my $r=shift;
  201:     #
  202:     # Overload checking
  203:     #
  204:     # Check this server
  205:     my $loaderror=&Apache::lonnet::overloaderror($r);
  206:     if ($loaderror) { return $loaderror; }
  207:     # Check the course homeserver
  208:     $loaderror= &Apache::lonnet::overloaderror($r,
  209:                       $env{'course.'.$env{'request.course.id'}.'.home'});
  210: #    if ($loaderror) { return $loaderror; } 
  211:     #
  212:     # HTML Header
  213:     #
  214:     if ($r->header_only) {
  215:         &Apache::loncommon::content_type($r,'text/html');
  216:         $r->send_http_header;
  217:         return OK;
  218:     }
  219:     #
  220:     # Roles Checking
  221:     #
  222:     # Needs to be in a course
  223:     if (! $env{'request.course.fn'}) { 
  224:         # Not in a course, or not allowed to modify parms
  225:         $env{'user.error.msg'}=
  226:             $r->uri.":opa:0:0:Cannot modify spreadsheet";
  227:         return HTTP_NOT_ACCEPTABLE; 
  228:     }
  229:     my $courseid = $env{'request.course.id'};
  230:     #
  231:     # Do not allow students to continue if standard or external grading is in
  232:     # effect.
  233:     #
  234:     if ($env{'request.role'} =~ /^st\./) {
  235:         if ($env{'course.'.$courseid.'.grading'} eq 'standard' ||
  236: 	    $env{'course.'.$courseid.'.grading'} eq 'external' ) {
  237:             return HTTP_NOT_ACCEPTABLE;
  238:         }
  239:     }
  240:     #
  241:     # Get query string for limited number of parameters
  242:     #
  243:     &Apache::loncommon::get_unprocessed_cgi
  244:         ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename','recalc',
  245:                                'output_format','not_first_run']);
  246:     #
  247:     # Deal with restricted student permissions 
  248:     #
  249:     if ($env{'request.role'} =~ /^st\./) {
  250:         delete $env{'form.cell'}       if (exists($env{'form.cell'}));
  251:         delete $env{'form.newformula'} if (exists($env{'form.newformula'}));
  252:     }
  253:     #
  254:     # Determine basic information about the spreadsheet
  255:     my ($sheettype) = ($r->uri=~/\/(\w+)$/);
  256:     #
  257:     my $symb   = undef;
  258:     $symb = $env{'form.usymb'} if (exists($env{'form.usymb'}));
  259:     my $name   = $env{'user.name'};
  260:     my $domain = $env{'user.domain'};
  261:     if (exists($env{'form.sname'}) && $env{'form.sname'} ne '') {
  262:         $name   = $env{'form.sname'};
  263:         $domain = $env{'form.sdomain'};
  264:     }
  265:     $env{'form.sname'} = $name;
  266:     $env{'form.sdomain'} = $domain;
  267:     ##
  268:     ## Check permissions
  269:     my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
  270:                                                 $env{'request.course.id'});
  271:     # Only those instructors/tas/whatevers with complete access
  272:     # (not section restricted) are able to modify spreadsheets.
  273:     my $allowed_to_view =  &Apache::lonnet::allowed('vgr',
  274:                                                 $env{'request.course.id'});
  275:     if (! $allowed_to_view) {
  276:         $allowed_to_view = &Apache::lonnet::allowed('vgr',
  277:                     $env{'request.course.id'}.'/'.$env{'request.course.sec'});
  278:         # Those who are restricted by section are allowed to view.
  279:         # The routines in lonstatistics which decide which students' 
  280:         # will be shown take care of the restriction by section.
  281:     }
  282:     #
  283:     # Only those able to view others grades will be allowed to continue 
  284:     # if they are not requesting their own.
  285:     if ($sheettype eq 'classcalc') {
  286:         if (! $allowed_to_view) {
  287: 	    $env{'user.error.msg'}=
  288: 		$r->uri.":vgr:0:0:Access Permission Denied";
  289: 	    return HTTP_NOT_ACCEPTABLE; 
  290: 	}
  291:     }
  292:     if ((($name   ne $env{'user.name'} ) ||
  293:          ($domain ne $env{'user.domain'})) && $sheettype ne 'classcalc') {
  294:         # Check that the student is in their section?
  295:         if (exists($env{'request.course.sec'}) && 
  296:             $env{'request.course.sec'} ne '' ) {
  297:             my $stu_sec = &Apache::lonnet::getsection($domain,$name,
  298: 						    $env{'request.course.id'});
  299:             if ($stu_sec ne $env{'request.course.sec'}) {
  300: 		$env{'user.error.msg'}=
  301: 		    $r->uri.":vgr:0:0:Requested student not in your section.";
  302: 		return HTTP_NOT_ACCEPTABLE; 
  303:             }
  304:         }
  305:     }
  306: 
  307:     #
  308:     # Open page, try to prevent browser cache.
  309:     #
  310:     &Apache::loncommon::content_type($r,'text/html');
  311:     &Apache::loncommon::no_cache($r);
  312:     $r->send_http_header;
  313: 
  314:     #
  315:     # Header....
  316:     #
  317:     $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
  318:     my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
  319:     ##
  320:     ## Spit out the javascript required for editing
  321:     ##
  322:     if ($allowed_to_edit) {
  323: 	my %lt=(
  324: 		'ce' => 'Cell',
  325: 		'ac' => 'Accept',
  326: 		'dc' => 'Discard Changes'
  327: 	);
  328:         my $extra_javascript = 
  329:             &Apache::loncommon::browser_and_searcher_javascript();
  330:         $r->print(<<ENDSCRIPT);
  331: <script type="text/javascript">
  332: //<!--
  333:     $extra_javascript
  334: 
  335:     var editwin;
  336: 
  337:     function celledit(cellname,cellformula) {
  338:         var edit_text = '';
  339:         // cellformula may contain less-than and greater-than symbols, so
  340:         // we need to escape them?  
  341:         edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
  342:         edit_text += '<form name="editwinform">';
  343:         edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
  344:         edit_text += '<textarea name="newformula" cols="60" rows="12"';
  345:         edit_text += ' wrap="off" >'+cellformula+'</textarea>';
  346:         edit_text += '</br>';
  347:         edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
  348:         edit_text += ' onClick=\\\'javascript:';
  349:         edit_text += 'opener.document.sheet.cell.value=';
  350:         edit_text +=     '"'+cellname+'";';
  351:         edit_text += 'opener.document.sheet.newformula.value=';
  352:         edit_text +=     'document.editwinform.newformula.value;';
  353:         edit_text += 'opener.document.sheet.submit();';
  354:         edit_text += 'self.close()\\\' />';
  355:         edit_text += '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
  356:         edit_text += '<input type="button" name="abort" ';
  357:         edit_text +=     'value="$lt{'dc'}"';
  358:         edit_text += ' onClick="javascript:self.close()" />';
  359:         edit_text += '</center></body></html>';
  360: 
  361:         if (editwin != null && !(editwin.closed) ) {
  362:             editwin.close();
  363:         }
  364: 
  365:         editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
  366:         editwin.document.write(edit_text);
  367:     }
  368: //-->
  369: </script>
  370: ENDSCRIPT
  371:     }
  372:     &Apache::lonhtmlcommon::clear_breadcrumbs();
  373:     &Apache::lonhtmlcommon::add_breadcrumb
  374:         ({href  => $r->uri,
  375:           title => 'Spreadsheet',
  376:           text  => 'Spreadsheet',
  377:           faq   => 134,
  378:           bug   => 'Spreadsheet'});
  379:     $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
  380:               &Apache::lonhtmlcommon::breadcrumbs(undef,'Spreadsheet').
  381:               '<form action="'.$r->uri.'" name="sheet" method="post">');
  382:     $r->print(&hiddenfield('sname'  ,$env{'form.sname'}).
  383:               &hiddenfield('sdomain',$env{'form.sdomain'}).
  384:               &hiddenfield('usymb'  ,$env{'form.usymb'}));
  385:     $r->rflush();
  386:     ##
  387:     ## Determine the filename to use
  388:     my $filename = undef;
  389:     if ($allowed_to_edit) {
  390:         $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
  391:         #
  392:         if (exists($env{'form.load'}) && exists($env{'form.loadfilename'})) {
  393:             $filename = $env{'form.loadfilename'};
  394:             $env{'form.workcopy'} = 'no';
  395:         }
  396:     }
  397:     ##
  398:     ## Take care of "backdoor" spreadsheet expiration / recalc stuff
  399:     if ($allowed_to_edit && exists($env{'form.recalc'})) {
  400:         if (exists($env{'form.recalc'})) {
  401:             &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
  402:         }
  403:         if ($env{'form.recalc'} eq 'ilovewastingtime') {
  404:             &Apache::lonnet::logthis('spreadsheet expired: entire course');
  405:             # expire ALL spreadsheets
  406:             &Apache::lonnet::expirespread('','','studentcalc');
  407:             &Apache::lonnet::expirespread('','','assesscalc');
  408:             $r->print('<h3>'.
  409:                       &mt('Expired spreadsheet caches for all students').
  410:                       '</h3>');
  411:         } elsif ($env{'form.recalc'} =~ /^symb:/) {
  412:             # expire for all students on this symb
  413:             my ($symb) = ($env{'form.recalc'} =~ /^symb:(.*)$/);
  414:             &Apache::lonnet::logthis('spreadsheet expired: symb = '.$symb);
  415:             &Apache::lonnet::expirespread('','','assesscalc',$symb);
  416:             &Apache::lonnet::expirespread('','','studentcalc');
  417:             $r->print('<h3>'.
  418:               &mt('Expired spreadsheet caches for all students for symb  [_1]',
  419:                   $symb).
  420:                       '</h3>');
  421:         } elsif ($env{'form.recalc'} =~ /^student:/) {
  422:             # expire all assessment spreadsheets for this user
  423:             my ($sname,$sdom) = ($env{'form.recalc'}=~/^student:(.*):(.*)$/);
  424:             &Apache::lonnet::logthis('spreadsheet expired: student = '.
  425:                                      $sname.'@'.$sdom);
  426:             if (defined($sname) && defined($sdom)) {
  427:                 &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
  428:                 &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
  429:                 $r->print('<h3>'.
  430:                           &mt('Expired spreadsheet caches for student [_1]',
  431:                               $sname.'@'.$sdom).
  432:                           '</h3>');
  433:             }
  434:         }
  435:     }
  436:     ##
  437:     ## Make the spreadsheet
  438:     &Apache::Spreadsheet::initialize_spreadsheet_package();
  439:     my $spreadsheet = undef;
  440:     if ($sheettype eq 'classcalc') {
  441:         $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef);
  442:     } elsif ($sheettype eq 'studentcalc') {
  443:         $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef);
  444:     } elsif ($sheettype eq 'assesscalc' && 
  445:              defined($symb) && 
  446:              $allowed_to_edit) {
  447:         $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb);
  448:     } else {
  449:         return HTTP_NOT_ACCEPTABLE;
  450:     }
  451:     if (! defined($spreadsheet)) {
  452:         # error error - run in circles, scream and shout
  453:         return;
  454:     }
  455:     $spreadsheet->initialize();
  456:     #
  457:     # Output selector
  458:     ##
  459:     ## Editing/loading/saving
  460:     if ($allowed_to_edit) {
  461:         my ($html,$action_message) = &file_dialogs($spreadsheet);
  462:         if ($env{'form.makedefault'}) {
  463:             $spreadsheet->make_default();
  464:             if ($action_message) {
  465:                 $action_message .= '<br />';
  466:             }
  467:             $action_message .= &mt('Made this spreadsheet the default');
  468:             if ($sheettype eq 'classcalc') {
  469:                 $action_message .= ' '.&mt('for the course');
  470:             } elsif ($sheettype eq 'studentcalc') {
  471:                 $action_message .= ' '.&mt('for all students');
  472:             } elsif ($sheettype eq 'assesscalc') {
  473:                 $action_message .= ' '.&mt('for all assessments');
  474:             }
  475:             $action_message .= '.';
  476:         }
  477:         $r->print('<table><tr><td valign="top">'.
  478:                   $spreadsheet->html_header().
  479:                   '</td>'.
  480:                   '<td valign="center">'.$html."</td></tr></table>\n");
  481:         if ($action_message ne '') {
  482:             $r->print(<<END);
  483: <table>
  484: <tr><td valign="top"><b>Last Action:</b></td>
  485:     <td>&nbsp;</td>
  486:     <td>$action_message</td>
  487: </tr>
  488: </table>
  489: END
  490:         }
  491:         $r->rflush();
  492:     } else {
  493:         $r->print('<table><tr><td>'.$spreadsheet->html_header().
  494:                   "</td></tr></table>\n");
  495:     }
  496:     $r->rflush();
  497:     #
  498:     $r->print("<table><tr>");
  499:     $r->print('<td><input type="submit" value="'.
  500:               &mt('Generate Spreadsheet').'" />'.
  501:               '</td>');
  502:     if ($allowed_to_view) {
  503:         $r->print('<td>'.
  504:                   &Apache::loncommon::help_open_topic("Spreadsheet_About",
  505:                                                       'Spreadsheet Help').
  506:                   '</td>');
  507:     }
  508:     if ($allowed_to_edit) {
  509:         $r->print('<td>'.
  510:                   &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
  511:                                                       'Editing Help').
  512:                   '</td>');
  513:     }
  514:     $r->print('</tr></table>');
  515:     #
  516:     # Keep track of the filename
  517:     $r->print(&hiddenfield('filename',$filename));
  518:     #
  519:     # Keep track of the number of times we have been called, sort of.
  520:     $r->print(&hiddenfield('not_first_run','whatever'));
  521:     #
  522:     if (exists($env{'form.not_first_run'}) || $sheettype ne 'classcalc') {
  523:         $r->print($spreadsheet->get_html_title());
  524:         if ($allowed_to_view || $allowed_to_edit) {
  525:             $r->print($spreadsheet->parent_link());
  526:         }
  527:         $r->rflush();
  528:         $spreadsheet->display($r);
  529:     }
  530:     $r->print('</form></body></html>');
  531:     $spreadsheet->clear_package();
  532:     return OK;
  533: }
  534: 
  535: 1;
  536: 
  537: __END__
  538: