1: #
2: # $Id: lonspreadsheet.pm,v 1.43 2006/04/06 16:43:49 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> </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> </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: my $section = &Apache::lonnet::getsection($domain,$name,
268: $env{'request.course.id'});
269: ##
270: ## Check permissions
271: my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
272: $env{'request.course.id'});
273: # Only those instructors/tas/whatevers with complete access
274: # (not section restricted) are able to modify spreadsheets.
275: my $allowed_to_view = &Apache::lonnet::allowed('vgr',
276: $env{'request.course.id'});
277: if (! $allowed_to_view) {
278: $allowed_to_view = &Apache::lonnet::allowed('vgr',
279: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
280: # Those who are restricted by section are allowed to view.
281: # The routines in lonstatistics which decide which students'
282: # will be shown take care of the restriction by section.
283: }
284: #
285: # Only those able to view others grades will be allowed to continue
286: # if they are not requesting their own.
287: if ($sheettype eq 'classcalc') {
288: if (! $allowed_to_view) {
289: $env{'user.error.msg'}=
290: $r->uri.":vgr:0:0:Access Permission Denied";
291: return HTTP_NOT_ACCEPTABLE;
292: }
293: }
294: if ((($name ne $env{'user.name'} ) ||
295: ($domain ne $env{'user.domain'})) && $sheettype ne 'classcalc') {
296: # Check that the student is in their section?
297: if (exists($env{'request.course.sec'}) &&
298: $env{'request.course.sec'} ne '' ) {
299: my $stu_sec = &Apache::lonnet::getsection($domain,$name,
300: $env{'request.course.id'});
301: if ($stu_sec ne $env{'request.course.sec'}) {
302: $env{'user.error.msg'}=
303: $r->uri.":vgr:0:0:Requested student not in your section.";
304: return HTTP_NOT_ACCEPTABLE;
305: }
306: }
307: }
308:
309: #
310: # Open page, try to prevent browser cache.
311: #
312: &Apache::loncommon::content_type($r,'text/html');
313: &Apache::loncommon::no_cache($r);
314: $r->send_http_header;
315:
316: #
317: # Header....
318: #
319: $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
320: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
321: ##
322: ## Spit out the javascript required for editing
323: ##
324: if ($allowed_to_edit) {
325: my %lt=(
326: 'ce' => 'Cell',
327: 'ac' => 'Accept',
328: 'dc' => 'Discard Changes'
329: );
330: my $extra_javascript =
331: &Apache::loncommon::browser_and_searcher_javascript();
332: $r->print(<<ENDSCRIPT);
333: <script type="text/javascript">
334: //<!--
335: $extra_javascript
336:
337: var editwin;
338:
339: function celledit(cellname,cellformula) {
340: var edit_text = '';
341: // cellformula may contain less-than and greater-than symbols, so
342: // we need to escape them?
343: edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
344: edit_text += '<form name="editwinform">';
345: edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
346: edit_text += '<textarea name="newformula" cols="60" rows="12"';
347: edit_text += ' wrap="off" >'+cellformula+'</textarea>';
348: edit_text += '</br>';
349: edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
350: edit_text += ' onClick=\\\'javascript:';
351: edit_text += 'opener.document.sheet.cell.value=';
352: edit_text += '"'+cellname+'";';
353: edit_text += 'opener.document.sheet.newformula.value=';
354: edit_text += 'document.editwinform.newformula.value;';
355: edit_text += 'opener.document.sheet.submit();';
356: edit_text += 'self.close()\\\' />';
357: edit_text += ' ';
358: edit_text += '<input type="button" name="abort" ';
359: edit_text += 'value="$lt{'dc'}"';
360: edit_text += ' onClick="javascript:self.close()" />';
361: edit_text += '</center></body></html>';
362:
363: if (editwin != null && !(editwin.closed) ) {
364: editwin.close();
365: }
366:
367: editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
368: editwin.document.write(edit_text);
369: }
370: //-->
371: </script>
372: ENDSCRIPT
373: }
374: &Apache::lonhtmlcommon::clear_breadcrumbs();
375: &Apache::lonhtmlcommon::add_breadcrumb
376: ({href => $r->uri,
377: title => 'Spreadsheet',
378: text => 'Spreadsheet',
379: faq => 134,
380: bug => 'Spreadsheet'});
381: $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
382: &Apache::lonhtmlcommon::breadcrumbs(undef,'Spreadsheet').
383: '<form action="'.$r->uri.'" name="sheet" method="post">');
384: $r->print(&hiddenfield('sname' ,$env{'form.sname'}).
385: &hiddenfield('sdomain',$env{'form.sdomain'}).
386: &hiddenfield('usymb' ,$env{'form.usymb'}));
387: $r->rflush();
388: ##
389: ## Determine the filename to use
390: my $filename = undef;
391: if ($allowed_to_edit) {
392: $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
393: #
394: if (exists($env{'form.load'}) && exists($env{'form.loadfilename'})) {
395: $filename = $env{'form.loadfilename'};
396: $env{'form.workcopy'} = 'no';
397: }
398: }
399: ##
400: ## Take care of "backdoor" spreadsheet expiration / recalc stuff
401: if ($allowed_to_edit && exists($env{'form.recalc'})) {
402: if (exists($env{'form.recalc'})) {
403: &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
404: }
405: if ($env{'form.recalc'} eq 'ilovewastingtime') {
406: &Apache::lonnet::logthis('spreadsheet expired: entire course');
407: # expire ALL spreadsheets
408: &Apache::lonnet::expirespread('','','studentcalc');
409: &Apache::lonnet::expirespread('','','assesscalc');
410: $r->print('<h3>'.
411: &mt('Expired spreadsheet caches for all students').
412: '</h3>');
413: } elsif ($env{'form.recalc'} =~ /^symb:/) {
414: # expire for all students on this symb
415: my ($symb) = ($env{'form.recalc'} =~ /^symb:(.*)$/);
416: &Apache::lonnet::logthis('spreadsheet expired: symb = '.$symb);
417: &Apache::lonnet::expirespread('','','assesscalc',$symb);
418: &Apache::lonnet::expirespread('','','studentcalc');
419: $r->print('<h3>'.
420: &mt('Expired spreadsheet caches for all students for symb [_1]',
421: $symb).
422: '</h3>');
423: } elsif ($env{'form.recalc'} =~ /^student:/) {
424: # expire all assessment spreadsheets for this user
425: my ($sname,$sdom) = ($env{'form.recalc'}=~/^student:(.*):(.*)$/);
426: &Apache::lonnet::logthis('spreadsheet expired: student = '.
427: $sname.'@'.$sdom);
428: if (defined($sname) && defined($sdom)) {
429: &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
430: &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
431: $r->print('<h3>'.
432: &mt('Expired spreadsheet caches for student [_1]',
433: $sname.'@'.$sdom).
434: '</h3>');
435: }
436: }
437: }
438: ##
439: ## Make the spreadsheet
440: &Apache::Spreadsheet::initialize_spreadsheet_package();
441: my $spreadsheet = undef;
442: if ($sheettype eq 'classcalc') {
443: $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef,
444: $section);
445: } elsif ($sheettype eq 'studentcalc') {
446: $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef,
447: $section);
448: } elsif ($sheettype eq 'assesscalc' &&
449: defined($symb) &&
450: $allowed_to_edit) {
451: $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb,
452: $section);
453: } else {
454: return HTTP_NOT_ACCEPTABLE;
455: }
456: if (! defined($spreadsheet)) {
457: # error error - run in circles, scream and shout
458: return;
459: }
460: $spreadsheet->initialize();
461: #
462: # Output selector
463: ##
464: ## Editing/loading/saving
465: if ($allowed_to_edit) {
466: my ($html,$action_message) = &file_dialogs($spreadsheet);
467: if ($env{'form.makedefault'}) {
468: $spreadsheet->make_default();
469: if ($action_message) {
470: $action_message .= '<br />';
471: }
472: $action_message .= &mt('Made this spreadsheet the default');
473: if ($sheettype eq 'classcalc') {
474: $action_message .= ' '.&mt('for the course');
475: } elsif ($sheettype eq 'studentcalc') {
476: $action_message .= ' '.&mt('for all students');
477: } elsif ($sheettype eq 'assesscalc') {
478: $action_message .= ' '.&mt('for all assessments');
479: }
480: $action_message .= '.';
481: }
482: $r->print('<table><tr><td valign="top">'.
483: $spreadsheet->html_header().
484: '</td>'.
485: '<td valign="center">'.$html."</td></tr></table>\n");
486: if ($action_message ne '') {
487: $r->print(<<END);
488: <table>
489: <tr><td valign="top"><b>Last Action:</b></td>
490: <td> </td>
491: <td>$action_message</td>
492: </tr>
493: </table>
494: END
495: }
496: $r->rflush();
497: } else {
498: $r->print('<table><tr><td>'.$spreadsheet->html_header().
499: "</td></tr></table>\n");
500: }
501: $r->rflush();
502: #
503: $r->print("<table><tr>");
504: $r->print('<td><input type="submit" value="'.
505: &mt('Generate Spreadsheet').'" />'.
506: '</td>');
507: if ($allowed_to_view) {
508: $r->print('<td>'.
509: &Apache::loncommon::help_open_topic("Spreadsheet_About",
510: 'Spreadsheet Help').
511: '</td>');
512: }
513: if ($allowed_to_edit) {
514: $r->print('<td>'.
515: &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
516: 'Editing Help').
517: '</td>');
518: }
519: $r->print('</tr></table>');
520: #
521: # Keep track of the filename
522: $r->print(&hiddenfield('filename',$filename));
523: #
524: # Keep track of the number of times we have been called, sort of.
525: $r->print(&hiddenfield('not_first_run','whatever'));
526: #
527: if (exists($env{'form.not_first_run'}) || $sheettype ne 'classcalc') {
528: $r->print($spreadsheet->get_html_title());
529: if ($allowed_to_view || $allowed_to_edit) {
530: $r->print($spreadsheet->parent_link());
531: }
532: $r->rflush();
533: $spreadsheet->display($r);
534: }
535: $r->print('</form></body></html>');
536: $spreadsheet->clear_package();
537: return OK;
538: }
539:
540: 1;
541:
542: __END__
543:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>