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