1: #
2: # $Id: lonspreadsheet.pm,v 1.41 2005/05/17 17:48:19 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: if ((exists($env{'form.save'}) || exists($env{'form.makedefault'})) &&
104: exists($env{'form.savefilename'})) {
105: $spreadsheet->filename($env{'form.savefilename'});
106: my $save_status = $spreadsheet->save();
107: if ($save_status ne 'ok') {
108: $message .= "An error occurred while saving the spreadsheet".
109: "There error is:".$save_status;
110: } else {
111: $message .= "Spreadsheet saved as ".$spreadsheet->filename();
112: }
113: } elsif (exists($env{'form.newformula'}) &&
114: exists($env{'form.cell'}) &&
115: $env{'form.cell'} ne '' ) {
116: ##
117: ## Make any requested modifications to the spreadsheet
118: $spreadsheet->modify_cell($env{'form.cell'},
119: $env{'form.newformula'});
120: $spreadsheet->save_tmp();
121: # output that we are dealing with a temporary file
122: $result .=&hiddenfield('workcopy',$sheettype);
123: if ($env{'form.newformula'} !~ /^\s*$/) {
124: $message .='<table><tr>'.
125: '<td valign="top"><pre>'.&mt('Cell').' '.$env{'form.cell'}.' = </pre></td>'.
126: '<td><pre>'.$env{'form.newformula'}."</pre></td></tr></table>\n";
127: } else {
128: $message .= &mt('Deleted contents of cell').' '.$env{'form.cell'}.'.';
129: }
130: }
131: ##
132: ## Editing code
133: $result .=&hiddenfield('cell','').
134: &hiddenfield('newformula','');
135: ##
136: ## Create the save and load dialogs
137: my $filename = $spreadsheet->filename();
138: my $truefilename = $filename;
139: if ($spreadsheet->is_default()) {
140: $filename = 'Default';
141: }
142: my $save_dialog = '<nobr>'.
143: '<input type="submit" name="save" value="'.&mt('Save as').'" /> '.
144: '<input type="text" name="savefilename" size="30" value="'.
145: $truefilename.'" />'.
146: '</nobr>';
147: my $makedefault_dialog = '<input type="submit" name="makedefault" '.
148: 'value="'.&mt('Save as & Make This Sheet the Default').'"/>';
149: #
150: my $link = '<a href="javascript:openbrowser'.
151: "('sheet','loadfilename','spreadsheet')\">".&mt('Select Spreadsheet File')."</a>";
152: my $load=&mt('Load:');
153: my $load_dialog = <<END;
154: <table bgcolor="$bgcolor">
155: <tr><td><input type="submit" name="load" value="$load" /></td>
156: <td><nobr>
157: <input type="text" name="loadfilename" size="20" value="$filename" />
158: $link</nobr>
159: </td></tr>
160: <tr><td> </td><td>
161: <select name="fileselect" onchange="document.sheet.loadfilename.value=document.sheet.fileselect.value" >
162: END
163: my $default_filename_set = 0;
164: foreach my $sheetfilename ($spreadsheet->othersheets()) {
165: $load_dialog .= ' <option value="'.$sheetfilename.'"';
166: if ($filename eq $sheetfilename) {
167: $load_dialog .= ' selected';
168: $default_filename_set = 1;
169: }
170: $load_dialog .= '>'.$sheetfilename."</option>\n";
171: }
172: $load_dialog .= "</select>\n</td><td> </td></tr>\n</table>\n";
173: #
174: $result .=<<END;
175: <!--
176: <fieldset title="File Dialogs" >
177: <legend>File Dialogs</legend>
178: -->
179: <!-- load / save dialogs -->
180: <table cellspacing="2">
181: <tr>
182: <td>$load_dialog</td>
183: <td>
184: <table bgcolor="$bgcolor">
185: <tr><td>$save_dialog</td></tr>
186: <tr><td align="center">$makedefault_dialog</td></tr>
187: </table>
188: </td>
189: </tr>
190: </table>
191: <!--
192: </fieldset>
193: -->
194: END
195: return ($result,$message);
196: }
197:
198: sub handler {
199: my $r=shift;
200: #
201: # Overload checking
202: #
203: # Check this server
204: my $loaderror=&Apache::lonnet::overloaderror($r);
205: if ($loaderror) { return $loaderror; }
206: # Check the course homeserver
207: $loaderror= &Apache::lonnet::overloaderror($r,
208: $env{'course.'.$env{'request.course.id'}.'.home'});
209: # if ($loaderror) { return $loaderror; }
210: #
211: # HTML Header
212: #
213: if ($r->header_only) {
214: &Apache::loncommon::content_type($r,'text/html');
215: $r->send_http_header;
216: return OK;
217: }
218: #
219: # Roles Checking
220: #
221: # Needs to be in a course
222: if (! $env{'request.course.fn'}) {
223: # Not in a course, or not allowed to modify parms
224: $env{'user.error.msg'}=
225: $r->uri.":opa:0:0:Cannot modify spreadsheet";
226: return HTTP_NOT_ACCEPTABLE;
227: }
228: my $courseid = $env{'request.course.id'};
229: #
230: # Do not allow students to continue if standard or external grading is in
231: # effect.
232: #
233: if ($env{'request.role'} =~ /^st\./) {
234: if ($env{'course.'.$courseid.'.grading'} eq 'standard' ||
235: $env{'course.'.$courseid.'.grading'} eq 'external' ) {
236: return HTTP_NOT_ACCEPTABLE;
237: }
238: }
239: #
240: # Get query string for limited number of parameters
241: #
242: &Apache::loncommon::get_unprocessed_cgi
243: ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename','recalc',
244: 'output_format','not_first_run']);
245: #
246: # Deal with restricted student permissions
247: #
248: if ($env{'request.role'} =~ /^st\./) {
249: delete $env{'form.cell'} if (exists($env{'form.cell'}));
250: delete $env{'form.newformula'} if (exists($env{'form.newformula'}));
251: }
252: #
253: # Determine basic information about the spreadsheet
254: my ($sheettype) = ($r->uri=~/\/(\w+)$/);
255: #
256: my $symb = undef;
257: $symb = $env{'form.usymb'} if (exists($env{'form.usymb'}));
258: my $name = $env{'user.name'};
259: my $domain = $env{'user.domain'};
260: if (exists($env{'form.sname'}) && $env{'form.sname'} ne '') {
261: $name = $env{'form.sname'};
262: $domain = $env{'form.sdomain'};
263: }
264: $env{'form.sname'} = $name;
265: $env{'form.sdomain'} = $domain;
266: ##
267: ## Check permissions
268: my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
269: $env{'request.course.id'});
270: # Only those instructors/tas/whatevers with complete access
271: # (not section restricted) are able to modify spreadsheets.
272: my $allowed_to_view = &Apache::lonnet::allowed('vgr',
273: $env{'request.course.id'});
274: if (! $allowed_to_view) {
275: $allowed_to_view = &Apache::lonnet::allowed('vgr',
276: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
277: # Those who are restricted by section are allowed to view.
278: # The routines in lonstatistics which decide which students'
279: # will be shown take care of the restriction by section.
280: }
281: #
282: # Only those able to view others grades will be allowed to continue
283: # if they are not requesting their own.
284: if ($sheettype eq 'classcalc') {
285: if (! $allowed_to_view) {
286: $env{'user.error.msg'}=
287: $r->uri.":vgr:0:0:Access Permission Denied";
288: return HTTP_NOT_ACCEPTABLE;
289: }
290: }
291: if ((($name ne $env{'user.name'} ) ||
292: ($domain ne $env{'user.domain'})) && $sheettype ne 'classcalc') {
293: # Check that the student is in their section?
294: if (exists($env{'request.course.sec'}) &&
295: $env{'request.course.sec'} ne '' ) {
296: my $stu_sec = &Apache::lonnet::getsection($domain,$name,
297: $env{'request.course.id'});
298: if ($stu_sec ne $env{'request.course.sec'}) {
299: $env{'user.error.msg'}=
300: $r->uri.":vgr:0:0:Requested student not in your section.";
301: return HTTP_NOT_ACCEPTABLE;
302: }
303: }
304: }
305:
306: #
307: # Open page, try to prevent browser cache.
308: #
309: &Apache::loncommon::content_type($r,'text/html');
310: &Apache::loncommon::no_cache($r);
311: $r->send_http_header;
312:
313: #
314: # Header....
315: #
316: $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
317: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
318: ##
319: ## Spit out the javascript required for editing
320: ##
321: if ($allowed_to_edit) {
322: my %lt=(
323: 'ce' => 'Cell',
324: 'ac' => 'Accept',
325: 'dc' => 'Discard Changes'
326: );
327: my $extra_javascript =
328: &Apache::loncommon::browser_and_searcher_javascript();
329: $r->print(<<ENDSCRIPT);
330: <script type="text/javascript">
331: //<!--
332: $extra_javascript
333:
334: var editwin;
335:
336: function celledit(cellname,cellformula) {
337: var edit_text = '';
338: // cellformula may contain less-than and greater-than symbols, so
339: // we need to escape them?
340: edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
341: edit_text += '<form name="editwinform">';
342: edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
343: edit_text += '<textarea name="newformula" cols="60" rows="12"';
344: edit_text += ' wrap="off" >'+cellformula+'</textarea>';
345: edit_text += '</br>';
346: edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
347: edit_text += ' onClick=\\\'javascript:';
348: edit_text += 'opener.document.sheet.cell.value=';
349: edit_text += '"'+cellname+'";';
350: edit_text += 'opener.document.sheet.newformula.value=';
351: edit_text += 'document.editwinform.newformula.value;';
352: edit_text += 'opener.document.sheet.submit();';
353: edit_text += 'self.close()\\\' />';
354: edit_text += ' ';
355: edit_text += '<input type="button" name="abort" ';
356: edit_text += 'value="$lt{'dc'}"';
357: edit_text += ' onClick="javascript:self.close()" />';
358: edit_text += '</center></body></html>';
359:
360: if (editwin != null && !(editwin.closed) ) {
361: editwin.close();
362: }
363:
364: editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
365: editwin.document.write(edit_text);
366: }
367: //-->
368: </script>
369: ENDSCRIPT
370: }
371: &Apache::lonhtmlcommon::clear_breadcrumbs();
372: &Apache::lonhtmlcommon::add_breadcrumb
373: ({href => $r->uri,
374: title => 'Spreadsheet',
375: text => 'Spreadsheet',
376: faq => 134,
377: bug => 'Spreadsheet'});
378: $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
379: &Apache::lonhtmlcommon::breadcrumbs(undef,'Spreadsheet').
380: '<form action="'.$r->uri.'" name="sheet" method="post">');
381: $r->print(&hiddenfield('sname' ,$env{'form.sname'}).
382: &hiddenfield('sdomain',$env{'form.sdomain'}).
383: &hiddenfield('usymb' ,$env{'form.usymb'}));
384: $r->rflush();
385: ##
386: ## Determine the filename to use
387: my $filename = undef;
388: if ($allowed_to_edit) {
389: $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
390: #
391: if (exists($env{'form.load'}) && exists($env{'form.loadfilename'})) {
392: $filename = $env{'form.loadfilename'};
393: $env{'form.workcopy'} = 'no';
394: }
395: }
396: ##
397: ## Take care of "backdoor" spreadsheet expiration / recalc stuff
398: if ($allowed_to_edit && exists($env{'form.recalc'})) {
399: if (exists($env{'form.recalc'})) {
400: &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
401: }
402: if ($env{'form.recalc'} eq 'ilovewastingtime') {
403: &Apache::lonnet::logthis('spreadsheet expired: entire course');
404: # expire ALL spreadsheets
405: &Apache::lonnet::expirespread('','','studentcalc');
406: &Apache::lonnet::expirespread('','','assesscalc');
407: $r->print('<h3>'.
408: &mt('Expired spreadsheet caches for all students').
409: '</h3>');
410: } elsif ($env{'form.recalc'} =~ /^symb:/) {
411: # expire for all students on this symb
412: my ($symb) = ($env{'form.recalc'} =~ /^symb:(.*)$/);
413: &Apache::lonnet::logthis('spreadsheet expired: symb = '.$symb);
414: &Apache::lonnet::expirespread('','','assesscalc',$symb);
415: &Apache::lonnet::expirespread('','','studentcalc');
416: $r->print('<h3>'.
417: &mt('Expired spreadsheet caches for all students for symb [_1]',
418: $symb).
419: '</h3>');
420: } elsif ($env{'form.recalc'} =~ /^student:/) {
421: # expire all assessment spreadsheets for this user
422: my ($sname,$sdom) = ($env{'form.recalc'}=~/^student:(.*):(.*)$/);
423: &Apache::lonnet::logthis('spreadsheet expired: student = '.
424: $sname.'@'.$sdom);
425: if (defined($sname) && defined($sdom)) {
426: &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
427: &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
428: $r->print('<h3>'.
429: &mt('Expired spreadsheet caches for student [_1]',
430: $sname.'@'.$sdom).
431: '</h3>');
432: }
433: }
434: }
435: ##
436: ## Make the spreadsheet
437: &Apache::Spreadsheet::initialize_spreadsheet_package();
438: my $spreadsheet = undef;
439: if ($sheettype eq 'classcalc') {
440: $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef);
441: } elsif ($sheettype eq 'studentcalc') {
442: $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef);
443: } elsif ($sheettype eq 'assesscalc' &&
444: defined($symb) &&
445: $allowed_to_edit) {
446: $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb);
447: } else {
448: return HTTP_NOT_ACCEPTABLE;
449: }
450: if (! defined($spreadsheet)) {
451: # error error - run in circles, scream and shout
452: return;
453: }
454: $spreadsheet->initialize();
455: #
456: # Output selector
457: ##
458: ## Editing/loading/saving
459: if ($allowed_to_edit) {
460: my ($html,$action_message) = &file_dialogs($spreadsheet);
461: if ($env{'form.makedefault'}) {
462: $spreadsheet->make_default();
463: if ($action_message) {
464: $action_message .= '<br />';
465: }
466: $action_message .= &mt('Made this spreadsheet the default');
467: if ($sheettype eq 'classcalc') {
468: $action_message .= ' '.&mt('for the course');
469: } elsif ($sheettype eq 'studentcalc') {
470: $action_message .= ' '.&mt('for all students');
471: } elsif ($sheettype eq 'assesscalc') {
472: $action_message .= ' '.&mt('for all assessments');
473: }
474: $action_message .= '.';
475: }
476: $r->print('<table><tr><td valign="top">'.
477: $spreadsheet->html_header().
478: '</td>'.
479: '<td valign="center">'.$html."</td></tr></table>\n");
480: if ($action_message ne '') {
481: $r->print(<<END);
482: <table>
483: <tr><td valign="top"><b>Last Action:</b></td>
484: <td> </td>
485: <td>$action_message</td>
486: </tr>
487: </table>
488: END
489: }
490: $r->rflush();
491: } else {
492: $r->print('<table><tr><td>'.$spreadsheet->html_header().
493: "</td></tr></table>\n");
494: }
495: $r->rflush();
496: #
497: $r->print("<table><tr>");
498: $r->print('<td><input type="submit" value="'.
499: &mt('Generate Spreadsheet').'" />'.
500: '</td>');
501: if ($allowed_to_view) {
502: $r->print('<td>'.
503: &Apache::loncommon::help_open_topic("Spreadsheet_About",
504: 'Spreadsheet Help').
505: '</td>');
506: }
507: if ($allowed_to_edit) {
508: $r->print('<td>'.
509: &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
510: 'Editing Help').
511: '</td>');
512: }
513: $r->print('</tr></table>');
514: #
515: # Keep track of the filename
516: $r->print(&hiddenfield('filename',$filename));
517: #
518: # Keep track of the number of times we have been called, sort of.
519: $r->print(&hiddenfield('not_first_run','whatever'));
520: #
521: if (exists($env{'form.not_first_run'}) || $sheettype ne 'classcalc') {
522: $r->print($spreadsheet->get_html_title());
523: if ($allowed_to_view || $allowed_to_edit) {
524: $r->print($spreadsheet->parent_link());
525: }
526: $r->rflush();
527: $spreadsheet->display($r);
528: }
529: $r->print('</form></body></html>');
530: $spreadsheet->clear_package();
531: return OK;
532: }
533:
534: 1;
535:
536: __END__
537:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>