Annotation of loncom/interface/spreadsheet/lonspreadsheet.pm, revision 1.36
1.1 matthew 1: #
1.36 ! matthew 2: # $Id: lonspreadsheet.pm,v 1.35 2004/02/24 20:52:20 matthew Exp $
1.1 matthew 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;
1.23 matthew 57: use warnings FATAL=>'all';
58: no warnings 'uninitialized';
1.1 matthew 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;
1.25 www 65: use Apache::lonlocal;
1.26 matthew 66: use Apache::loncoursedata();
1.1 matthew 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)=@_;
1.28 matthew 75: return "\n<p><b>$title:</b><br />".
76: '<input type=text name="'.$name.'" size=80 value="'.$value.'" />';
1.1 matthew 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)=@_;
1.28 matthew 86: my $selout="\n<p><b>$title:</b><br />".'<select name="'.$name.'">';
1.1 matthew 87: foreach (sort keys(%options)) {
88: $selout.='<option value="'.$_.'"';
89: if ($_ eq $value) { $selout.=' selected'; }
1.27 www 90: $selout.='>'.&mt($options{$_}).'</option>';
1.1 matthew 91: }
92: return $selout.'</select>';
93: }
94:
1.5 matthew 95: sub file_dialogs {
96: my ($spreadsheet) = @_;
97: my $bgcolor = "#FFFFFF";
98: my $sheettype = $spreadsheet->{'type'};
99: my $result = '';
1.11 matthew 100: my $message = '';
1.5 matthew 101: ##
102: ## Deal with saving the spreadsheet
1.11 matthew 103: if ((exists($ENV{'form.save'}) || exists($ENV{'form.makedefault'})) &&
1.5 matthew 104: exists($ENV{'form.savefilename'})) {
105: $spreadsheet->filename($ENV{'form.savefilename'});
106: my $save_status = $spreadsheet->save();
107: if ($save_status ne 'ok') {
1.11 matthew 108: $message .= "An error occurred while saving the spreadsheet".
1.5 matthew 109: "There error is:".$save_status;
110: } else {
1.24 matthew 111: $message .= "Spreadsheet saved as ".$spreadsheet->filename();
1.5 matthew 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);
1.11 matthew 123: if ($ENV{'form.newformula'} !~ /^\s*$/) {
124: $message .='<table><tr>'.
1.27 www 125: '<td valign="top"><pre>'.&mt('Cell').' '.$ENV{'form.cell'}.' = </pre></td>'.
1.11 matthew 126: '<td><pre>'.$ENV{'form.newformula'}."</pre></td></tr></table>\n";
127: } else {
1.27 www 128: $message .= &mt('Deleted contents of cell').' '.$ENV{'form.cell'}.'.';
1.11 matthew 129: }
1.5 matthew 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();
1.10 matthew 138: my $truefilename = $filename;
139: if ($spreadsheet->is_default()) {
140: $filename = 'Default';
141: }
1.5 matthew 142: my $save_dialog = '<nobr>'.
1.27 www 143: '<input type="submit" name="save" value="'.&mt('Save as').'" /> '.
1.5 matthew 144: '<input type="text" name="savefilename" size="30" value="'.
1.10 matthew 145: $truefilename.'" />'.
1.5 matthew 146: '</nobr>';
147: my $makedefault_dialog = '<input type="submit" name="makedefault" '.
1.27 www 148: 'value="'.&mt('Save as & Make This Sheet the Default').'"/>';
1.5 matthew 149: #
150: my $link = '<a href="javascript:openbrowser'.
1.27 www 151: "('sheet','loadfilename','spreadsheet')\">".&mt('Select Spreadsheet File')."</a>";
152: my $load=&mt('Load:');
1.5 matthew 153: my $load_dialog = <<END;
154: <table bgcolor="$bgcolor">
1.27 www 155: <tr><td><input type="submit" name="load" value="$load" /></td>
1.5 matthew 156: <td><nobr>
1.10 matthew 157: <input type="text" name="loadfilename" size="20" value="$filename" />
1.5 matthew 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
1.7 matthew 163: my $default_filename_set = 0;
1.5 matthew 164: foreach my $sheetfilename ($spreadsheet->othersheets()) {
1.28 matthew 165: $load_dialog .= ' <option value="'.$sheetfilename.'"';
1.5 matthew 166: if ($filename eq $sheetfilename) {
167: $load_dialog .= ' selected';
1.7 matthew 168: $default_filename_set = 1;
1.5 matthew 169: }
170: $load_dialog .= '>'.$sheetfilename."</option>\n";
171: }
1.22 matthew 172: $load_dialog .= "</select>\n</td><td> </td></tr>\n</table>\n";
1.5 matthew 173: #
174: $result .=<<END;
1.23 matthew 175: <!--
176: <fieldset title="File Dialogs" >
177: <legend>File Dialogs</legend>
178: -->
1.5 matthew 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>
1.23 matthew 191: <!--
192: </fieldset>
193: -->
1.5 matthew 194: END
1.11 matthew 195: return ($result,$message);
1.5 matthew 196: }
197:
1.1 matthew 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'});
1.4 matthew 209: # if ($loaderror) { return $loaderror; }
1.1 matthew 210: #
211: # HTML Header
212: #
213: if ($r->header_only) {
1.25 www 214: &Apache::loncommon::content_type($r,'text/html');
1.1 matthew 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;
1.17 matthew 227: }
228: my $courseid = $ENV{'request.course.id'};
229: #
1.30 albertel 230: # Do not allow students to continue if standard or external grading is in
231: # effect.
232: #
1.17 matthew 233: if ($ENV{'request.role'} =~ /^st\./) {
1.30 albertel 234: if ($ENV{'course.'.$courseid.'.grading'} eq 'standard' ||
235: $ENV{'course.'.$courseid.'.grading'} eq 'external' ) {
1.17 matthew 236: return HTTP_NOT_ACCEPTABLE;
237: }
1.1 matthew 238: }
239: #
240: # Get query string for limited number of parameters
241: #
242: &Apache::loncommon::get_unprocessed_cgi
1.19 matthew 243: ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename','recalc']);
1.1 matthew 244: #
245: # Deal with restricted student permissions
246: #
247: if ($ENV{'request.role'} =~ /^st\./) {
248: delete $ENV{'form.cell'} if (exists($ENV{'form.cell'}));
249: delete $ENV{'form.newformula'} if (exists($ENV{'form.newformula'}));
250: }
251: #
252: # Determine basic information about the spreadsheet
253: my ($sheettype) = ($r->uri=~/\/(\w+)$/);
254: #
255: my $symb = undef;
256: $symb = $ENV{'form.usymb'} if (exists($ENV{'form.usymb'}));
257: my $name = $ENV{'user.name'};
258: my $domain = $ENV{'user.domain'};
1.34 matthew 259: if (exists($ENV{'form.sname'}) && $ENV{'form.sname'} ne '') {
1.1 matthew 260: $name = $ENV{'form.sname'};
261: $domain = $ENV{'form.sdomain'};
262: }
1.34 matthew 263: $ENV{'form.sname'} = $name;
264: $ENV{'form.sdomain'} = $domain;
1.3 matthew 265: ##
266: ## Check permissions
267: my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
268: $ENV{'request.course.id'});
1.12 matthew 269: # Only those instructors/tas/whatevers with complete access
270: # (not section restricted) are able to modify spreadsheets.
1.3 matthew 271: my $allowed_to_view = &Apache::lonnet::allowed('vgr',
272: $ENV{'request.course.id'});
1.12 matthew 273: if (! $allowed_to_view) {
274: $allowed_to_view = &Apache::lonnet::allowed('vgr',
275: $ENV{'request.course.id'}.'/'.$ENV{'request.course.sec'});
276: # Those who are restricted by section are allowed to view.
277: # The routines in lonstatistics which decide which students'
278: # will be shown take care of the restriction by section.
279: }
1.1 matthew 280: #
1.3 matthew 281: # Only those able to view others grades will be allowed to continue
282: # if they are not requesting their own.
1.12 matthew 283: if ($sheettype eq 'classcalc') {
1.3 matthew 284: if (! $allowed_to_view) {
1.14 www 285: $ENV{'user.error.msg'}=
286: $r->uri.":vgr:0:0:Access Permission Denied";
287: return HTTP_NOT_ACCEPTABLE;
288: }
1.1 matthew 289: }
1.12 matthew 290: if ((($name ne $ENV{'user.name'} ) ||
291: ($domain ne $ENV{'user.domain'})) && $sheettype ne 'classcalc') {
292: # Check that the student is in their section?
293: if (exists($ENV{'request.course.sec'}) &&
294: $ENV{'request.course.sec'} ne '' ) {
295: my $stu_sec = &Apache::lonnet::usection($domain,$name,
296: $ENV{'request.course.id'});
297: if ($stu_sec ne $ENV{'request.course.sec'}) {
1.14 www 298: $ENV{'user.error.msg'}=
299: $r->uri.":vgr:0:0:Requested student not in your section.";
300: return HTTP_NOT_ACCEPTABLE;
1.12 matthew 301: }
302: }
303: }
1.14 www 304:
305: #
306: # Open page, try to prevent browser cache.
307: #
1.25 www 308: &Apache::loncommon::content_type($r,'text/html');
1.15 matthew 309: &Apache::loncommon::no_cache($r);
1.14 www 310: $r->send_http_header;
1.12 matthew 311:
1.1 matthew 312: #
313: # Header....
314: #
315: $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
316: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
317: ##
318: ## Spit out the javascript required for editing
319: ##
1.5 matthew 320: if ($allowed_to_edit) {
1.27 www 321: my %lt=(
322: 'ce' => 'Cell',
323: 'ac' => 'Accept',
324: 'dc' => 'Discard Changes'
325: );
1.5 matthew 326: my $extra_javascript =
327: &Apache::loncommon::browser_and_searcher_javascript();
1.1 matthew 328: $r->print(<<ENDSCRIPT);
1.28 matthew 329: <script type="text/javascript">
330: //<!--
1.5 matthew 331: $extra_javascript
332:
1.1 matthew 333: var editwin;
334:
335: function celledit(cellname,cellformula) {
336: var edit_text = '';
337: // cellformula may contain less-than and greater-than symbols, so
338: // we need to escape them?
339: edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
340: edit_text += '<form name="editwinform">';
1.27 www 341: edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
1.18 matthew 342: edit_text += '<textarea name="newformula" cols="60" rows="12"';
1.1 matthew 343: edit_text += ' wrap="off" >'+cellformula+'</textarea>';
344: edit_text += '</br>';
1.27 www 345: edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
1.1 matthew 346: edit_text += ' onClick=\\\'javascript:';
347: edit_text += 'opener.document.sheet.cell.value=';
348: edit_text += '"'+cellname+'";';
349: edit_text += 'opener.document.sheet.newformula.value=';
350: edit_text += 'document.editwinform.newformula.value;';
351: edit_text += 'opener.document.sheet.submit();';
352: edit_text += 'self.close()\\\' />';
353: edit_text += ' ';
354: edit_text += '<input type="button" name="abort" ';
1.27 www 355: edit_text += 'value="$lt{'dc'}"';
1.1 matthew 356: edit_text += ' onClick="javascript:self.close()" />';
357: edit_text += '</center></body></html>';
358:
359: if (editwin != null && !(editwin.closed) ) {
360: editwin.close();
361: }
362:
1.29 albertel 363: editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
1.1 matthew 364: editwin.document.write(edit_text);
365: }
1.28 matthew 366: //-->
1.1 matthew 367: </script>
368: ENDSCRIPT
369: }
1.33 matthew 370: &Apache::lonhtmlcommon::clear_breadcrumbs();
371: &Apache::lonhtmlcommon::add_breadcrumb
372: ({href => $r->uri,
1.36 ! matthew 373: title => 'Spreadsheet',
! 374: text => 'Spreadsheet',
1.33 matthew 375: faq => 134,
376: bug => 'Spreadsheet'});
1.1 matthew 377: $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
1.36 ! matthew 378: &Apache::lonhtmlcommon::breadcrumbs(undef,'Spreadsheet').
1.1 matthew 379: '<form action="'.$r->uri.'" name="sheet" method="post">');
380: $r->print(&hiddenfield('sname' ,$ENV{'form.sname'}).
381: &hiddenfield('sdomain',$ENV{'form.sdomain'}).
1.6 matthew 382: &hiddenfield('usymb' ,$ENV{'form.usymb'}));
1.1 matthew 383: $r->rflush();
384: ##
385: ## Determine the filename to use
386: my $filename = undef;
1.3 matthew 387: if ($allowed_to_edit) {
1.1 matthew 388: $filename = $ENV{'form.filename'} if (exists($ENV{'form.filename'}));
389: #
390: if (exists($ENV{'form.load'}) && exists($ENV{'form.loadfilename'})) {
391: $filename = $ENV{'form.loadfilename'};
1.7 matthew 392: $ENV{'form.workcopy'} = 'no';
1.1 matthew 393: }
394: }
395: ##
1.19 matthew 396: ## Take care of "backdoor" spreadsheet expiration / recalc stuff
397: if ($allowed_to_edit && exists($ENV{'form.recalc'})) {
1.26 matthew 398: if (exists($ENV{'form.recalc'})) {
399: &Apache::loncoursedata::delete_caches($ENV{'requres.course.id'});
400: }
1.19 matthew 401: if ($ENV{'form.recalc'} eq 'ilovewastingtime') {
402: &Apache::lonnet::logthis('ilovewastingtime');
403: # expire ALL spreadsheets
404: &Apache::lonnet::expirespread('','','studentcalc');
405: &Apache::lonnet::expirespread('','','assesscalc');
406: } elsif ($ENV{'form.recalc'} =~ /^symb:/) {
407: # expire for all students on this symb
408: my ($symb) = ($ENV{'form.recalc'} =~ /^symb:(.*)$/);
409: &Apache::lonnet::logthis('symb = '.$symb);
410: &Apache::lonnet::expirespread('','','assesscalc',$symb);
411: &Apache::lonnet::expirespread('','','studentcalc');
412: } elsif ($ENV{'form.recalc'} =~ /^student:/) {
413: # expire all assessment spreadsheets for this user
414: my ($sname,$sdom) = ($ENV{'form.recalc'}=~/^student:(.*):(.*)$/);
415: &Apache::lonnet::logthis('student = '.$sname.':'.$sdom);
416: if (defined($sname) && defined($sdom)) {
417: &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
418: &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
419: }
420: }
421: }
422: ##
1.1 matthew 423: ## Make the spreadsheet
424: &Apache::Spreadsheet::initialize_spreadsheet_package();
425: my $spreadsheet = undef;
426: if ($sheettype eq 'classcalc') {
427: $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef);
428: } elsif ($sheettype eq 'studentcalc') {
429: $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef);
1.2 matthew 430: } elsif ($sheettype eq 'assesscalc' &&
431: defined($symb) &&
1.3 matthew 432: $allowed_to_edit) {
1.1 matthew 433: $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb);
434: } else {
1.2 matthew 435: return HTTP_NOT_ACCEPTABLE;
436: }
437: if (! defined($spreadsheet)) {
438: # error error - run in circles, scream and shout
1.1 matthew 439: return;
440: }
1.8 matthew 441: $spreadsheet->initialize();
1.5 matthew 442: #
443: # Output selector
1.1 matthew 444: ##
445: ## Editing/loading/saving
1.3 matthew 446: if ($allowed_to_edit) {
1.11 matthew 447: my ($html,$action_message) = &file_dialogs($spreadsheet);
1.10 matthew 448: if ($ENV{'form.makedefault'}) {
449: $spreadsheet->make_default();
1.11 matthew 450: if ($action_message) {
451: $action_message .= '<br />';
452: }
1.27 www 453: $action_message .= &mt('Made this spreadsheet the default');
1.11 matthew 454: if ($sheettype eq 'classcalc') {
1.27 www 455: $action_message .= ' '.&mt('for the course');
1.11 matthew 456: } elsif ($sheettype eq 'studentcalc') {
1.27 www 457: $action_message .= ' '.&mt('for all students');
1.11 matthew 458: } elsif ($sheettype eq 'assesscalc') {
1.27 www 459: $action_message .= ' '.&mt('for all assessments');
1.11 matthew 460: }
461: $action_message .= '.';
1.10 matthew 462: }
1.5 matthew 463: $r->print('<table><tr><td>'.$spreadsheet->html_header().'</td>'.
1.11 matthew 464: '<td valign="bottom">'.$html."</td></tr></table>\n");
1.12 matthew 465: if ($action_message ne '') {
466: $r->print(<<END);
1.11 matthew 467: <table>
468: <tr><td valign="top"><b>Last Action:</b></td>
469: <td> </td>
470: <td>$action_message</td>
471: </tr>
472: </table>
473: END
1.12 matthew 474: }
1.1 matthew 475: $r->rflush();
1.5 matthew 476: } else {
477: $r->print('<table><tr><td>'.$spreadsheet->html_header().
478: "</td></tr></table>\n");
1.1 matthew 479: }
1.11 matthew 480: $r->rflush();
1.1 matthew 481: #
1.19 matthew 482: $r->print("<table><tr>");
1.31 matthew 483: $r->print('<td><input type="submit" value="'.
484: &mt('Generate Spreadsheet').'" />'.
485: '</td>');
1.21 matthew 486: if ($allowed_to_view) {
487: $r->print('<td>'.
488: &Apache::loncommon::help_open_topic("Spreadsheet_About",
489: 'Spreadsheet Help').
490: '</td>');
491: }
492: if ($allowed_to_edit) {
493: $r->print('<td>'.
494: &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
495: 'Editing Help').
496: '</td>');
497: }
1.19 matthew 498: $r->print('</tr></table>');
1.10 matthew 499: #
1.1 matthew 500: # Keep track of the filename
501: $r->print(&hiddenfield('filename',$filename));
502: #
1.5 matthew 503: # Keep track of the number of times we have been called, sort of.
504: $r->print(&hiddenfield('not_first_run','whatever'));
505: #
506: if (exists($ENV{'form.not_first_run'}) || $sheettype ne 'classcalc') {
507: $r->print($spreadsheet->get_html_title());
508: if ($allowed_to_view || $allowed_to_edit) {
509: $r->print($spreadsheet->parent_link());
510: }
1.16 matthew 511: $r->rflush();
1.5 matthew 512: $spreadsheet->display($r);
1.1 matthew 513: }
514: $r->print('</form></body></html>');
515: return OK;
516: }
517:
518: 1;
519:
520: __END__
521:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonspreadsheet.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface / spreadsheet