1: #
2: # $Id: lonspreadsheet.pm,v 1.61.6.2.2.1 2020/09/08 04:39:15 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 Apache::lonquickgrades();
68: use HTML::Entities();
69:
70: ##
71: ## HTML utility subroutines really should go in lonhtmlcommon
72: ##
73:
74: sub textfield {
75: my ($title,$name,$value)=@_;
76: return "\n<p><b>$title:</b><br />".
77: '<input type="text" name="'.$name.'" size="80" value="'.$value.'" />';
78: }
79:
80: sub hiddenfield {
81: my ($name,$value)=@_;
82: return '<input type="hidden" name="'.$name.'" value="'.$value.'" />'."\n";
83: }
84:
85: sub selectbox {
86: my ($title,$name,$value,%options)=@_;
87: my $selout="\n<p><b>$title:</b><br />".'<select name="'.$name.'">';
88: foreach (sort keys(%options)) {
89: $selout.='<option value="'.$_.'"';
90: if ($_ eq $value) { $selout.=' selected="selected"'; }
91: $selout.='>'.&mt($options{$_}).'</option>';
92: }
93: return $selout.'</select>';
94: }
95:
96: sub file_dialogs {
97: my ($spreadsheet) = @_;
98: my $bgcolor = "#FFFFFF";
99: my $sheettype = $spreadsheet->{'type'};
100: my $result = '';
101: my $message = '';
102: ##
103: ## Deal with saving the spreadsheet
104: $spreadsheet->check_formulas_loaded();
105: if ((exists($env{'form.save'}) || exists($env{'form.makedefault'})) &&
106: exists($env{'form.savefilename'})) {
107: $spreadsheet->filename($env{'form.savefilename'});
108: my $save_status = $spreadsheet->save();
109: if ($save_status ne 'ok') {
110: $message .= '<span class="LC_error">'.
111: &mt('An error occurred while saving the spreadsheet. The error is: [_1].',
112: $save_status).'</span>';
113: } else {
114: $message .= '<span class="LC_info">'.&mt('Spreadsheet saved as: [_1] .',
115: '<span class="LC_filename">'.$spreadsheet->filename().'</span>').
116: '</span>';
117: }
118: } elsif (exists($env{'form.newformula'}) &&
119: exists($env{'form.cell'}) &&
120: $env{'form.cell'} ne '' ) {
121: ##
122: ## Make any requested modifications to the spreadsheet
123: $spreadsheet->modify_cell($env{'form.cell'},
124: $env{'form.newformula'});
125: $spreadsheet->save_tmp();
126: # output that we are dealing with a temporary file
127: $result .=&hiddenfield('workcopy',$sheettype);
128: if ($env{'form.newformula'} !~ /^\s*$/) {
129: $message .='<table><tr>'.
130: '<td valign="top"><pre>'.&mt('Cell').' '.$env{'form.cell'}.' = </pre></td>'.
131: '<td><pre>'.$env{'form.newformula'}."</pre></td></tr></table>\n";
132: } else {
133: $message .= &mt('Deleted contents of cell').' '.$env{'form.cell'}.'.';
134: }
135: }
136: ##
137: ## Editing code
138: $result .=&hiddenfield('cell','').
139: &hiddenfield('newformula','');
140: ##
141: ## Create the save and load dialogs
142: my $filename = $spreadsheet->filename();
143: my $truefilename = $filename;
144: if ($spreadsheet->is_default()) {
145: $filename = 'Default';
146: }
147: my $save_dialog = '<span class="LC_nobreak">'.
148: '<input type="submit" name="save" value="'.&mt('Save as').'" /> '.
149: '<input type="text" name="savefilename" size="30" value="'.
150: $truefilename.'" />'.
151: '</span>';
152: my $makedefault_dialog = '<input type="submit" name="makedefault" '.
153: 'value="'.&mt('Save as & Make This Sheet the Default').'"/>';
154: #
155: my $link = '<a href="javascript:openbrowser'.
156: "('sheet','loadfilename','spreadsheet')\">".&mt('Select Spreadsheet File')."</a>";
157: my $load=&mt('Load:');
158: my $load_dialog = <<END;
159: <table bgcolor="$bgcolor">
160: <tr><td><input type="submit" name="load" value="$load" /></td>
161: <td><span class="LC_nobreak">
162: <input type="text" name="loadfilename" size="20" value="$filename" />
163: $link</span>
164: </td></tr>
165: <tr><td> </td><td>
166: <select name="fileselect" onchange="document.sheet.loadfilename.value=document.sheet.fileselect.value" >
167: END
168: my $default_filename_set = 0;
169: foreach my $sheetfilename ($spreadsheet->othersheets()) {
170: $load_dialog .= ' <option value="'.$sheetfilename.'"';
171: if ($filename eq $sheetfilename) {
172: $load_dialog .= ' selected="selected"';
173: $default_filename_set = 1;
174: }
175: $load_dialog .= '>'.$sheetfilename."</option>\n";
176: }
177: $load_dialog .= "</select>\n</td><td> </td></tr>\n</table>\n";
178: #
179: my $headline = &mt('File Dialogs');
180: $result .=<<END;
181: <!--
182: <fieldset title="File Dialogs" >
183: <legend>$headline</legend>
184: -->
185: <!-- load / save dialogs -->
186: <table cellspacing="2">
187: <tr>
188: <td>$load_dialog</td>
189: <td>
190: <table bgcolor="$bgcolor">
191: <tr><td>$save_dialog</td></tr>
192: <tr><td align="center">$makedefault_dialog</td></tr>
193: </table>
194: </td>
195: </tr>
196: </table>
197: <!--
198: </fieldset>
199: -->
200: END
201: return ($result,$message);
202: }
203:
204: sub handler {
205: my $r=shift;
206: #
207: # HTML Header
208: #
209: if ($r->header_only) {
210: &Apache::loncommon::content_type($r,'text/html');
211: $r->send_http_header;
212: return OK;
213: }
214: #
215: # Roles Checking
216: #
217: # Needs to be in a course
218: if (! $env{'request.course.fn'}) {
219: # Not in a course, or not allowed to modify parms
220: $env{'user.error.msg'}=
221: $r->uri.":opa:0:0:Cannot modify spreadsheet";
222: return HTTP_NOT_ACCEPTABLE;
223: }
224: my ($sheettype) = ($r->uri=~/\/(\w+)$/);
225: my $courseid = $env{'request.course.id'};
226:
227: ##
228: ## Check permissions
229: my $allowed_to_edit = &Apache::lonnet::allowed('mgr',
230: $env{'request.course.id'});
231: # Only those instructors/tas/whatevers with complete access
232: # (not section restricted) are able to modify spreadsheets.
233: my $allowed_to_view = &Apache::lonnet::allowed('vgr',
234: $env{'request.course.id'});
235: if (! $allowed_to_view) {
236: $allowed_to_view = &Apache::lonnet::allowed('vgr',
237: $env{'request.course.id'}.'/'.$env{'request.course.sec'});
238: # Those who are restricted by section are allowed to view.
239: # The routines in lonstatistics which decide which students'
240: # will be shown take care of the restriction by section.
241: }
242:
243: #
244: # Check if display of course gradebook is blocked
245: #
246:
247: if ($env{'request.course.id'}) {
248: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
249: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
250: my ($blocked,$blocktext) =
251: &Apache::loncommon::blocking_status('grades',$cnum,$cdom);
252: if ($blocked) {
253: my $checkrole = "cm./$cdom/$cnum";
254: if ($env{'request.course.sec'} ne '') {
255: $checkrole .= "/$env{'request.course.sec'}";
256: }
257: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
258: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
259: &Apache::lonquickgrades::grades_blocked($r,$blocktext,'spreadsheet');
260: return OK;
261: }
262: }
263: }
264:
265: #
266: # Do not allow users without vgr or mgr priv to continue unless
267: # grading type is set to spreadsheet.
268: #
269:
270: if ((!$allowed_to_view) && (!$allowed_to_edit)) {
271: if ($env{'course.'.$courseid.'.grading'} eq 'spreadsheet') {
272: if ($sheettype ne 'studentcalc') {
273: $r->internal_redirect('/adm/studentcalc');
274: return OK;
275: }
276: } else {
277: $r->internal_redirect('/adm/quickgrades');
278: return OK;
279: }
280: }
281: #
282: # Get query string for limited number of parameters
283: #
284: &Apache::loncommon::get_unprocessed_cgi
285: ($ENV{'QUERY_STRING'},['sname','sdomain','usymb','filename','recalc',
286: 'output_format','not_first_run']);
287: #
288: # Deal with restricted student permissions
289: #
290: if ($env{'request.role'} =~ /^st\./) {
291: delete $env{'form.cell'} if (exists($env{'form.cell'}));
292: delete $env{'form.newformula'} if (exists($env{'form.newformula'}));
293: }
294: #
295: # Determine basic information about the spreadsheet
296: #
297: my $symb = undef;
298: $symb = $env{'form.usymb'} if (exists($env{'form.usymb'}));
299: my $name = $env{'user.name'};
300: my $domain = $env{'user.domain'};
301: my $warning;
302: if (exists($env{'form.sname'}) && $env{'form.sname'} ne '') {
303: if (($env{'form.sname'} ne $env{'user.name'}) ||
304: ($env{'form.sdomain'} ne $env{'user.domain'})) {
305: if (($allowed_to_view) || ($allowed_to_edit)) {
306: if (&Apache::lonnet::homeserver($env{'form.sname'},$env{'form.sdomain'}) ne 'no_host') {
307: $name = $env{'form.sname'};
308: $domain = $env{'form.sdomain'};
309: } else {
310: $warning = &mt('Requested user: "[_1]" does not exist; your own sheet is displayed instead.',$env{'form.sname'}.':'.$env{'form.sdomain'});
311: }
312: } else {
313: $warning = &mt('Your current role is not permitted to display this sheet for the requested user: "[_1]"; your own sheet is displayed instead.',$env{'form.sname'}.':'.$env{'form.sdomain'});
314: }
315: }
316: }
317: $env{'form.sname'} = $name;
318: $env{'form.sdomain'} = $domain;
319: my $section = &Apache::lonnet::getsection($domain,$name,
320: $env{'request.course.id'});
321: my @groups;
322: if (($env{'user.name'} eq $name) && ($env{'user.domain'} eq $domain)) {
323: @groups = &Apache::lonnet::sort_course_groups($env{'request.course.id'},
324: split(':',$env{'request.course.groups'}));
325: } else {
326: @groups = &Apache::lonnet::get_users_groups($domain,$name,
327: $env{'request.course.id'});
328: }
329:
330: #
331: # Only those able to view others grades will be allowed to continue
332: # if they are not requesting their own.
333: if ($sheettype eq 'classcalc') {
334: if (!$allowed_to_view) {
335: $r->internal_redirect('/adm/studentcalc');
336: return OK;
337: }
338: }
339: if ((($name ne $env{'user.name'} ) ||
340: ($domain ne $env{'user.domain'})) && $sheettype ne 'classcalc') {
341: # Check that the student is in their section?
342: if (exists($env{'request.course.sec'}) &&
343: $env{'request.course.sec'} ne '' ) {
344: my $stu_sec = &Apache::lonnet::getsection($domain,$name,
345: $env{'request.course.id'});
346: if ($stu_sec ne $env{'request.course.sec'}) {
347: $env{'user.error.msg'}=
348: $r->uri.":vgr:0:0:Requested student not in your section.";
349: return HTTP_NOT_ACCEPTABLE;
350: }
351: }
352: }
353:
354: #
355: # Open page, try to prevent browser cache.
356: #
357: &Apache::loncommon::content_type($r,'text/html');
358: &Apache::loncommon::no_cache($r);
359: $r->send_http_header;
360:
361: #
362: # Header....
363: #
364: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
365: ##
366: ## Spit out the javascript required for editing
367: ##
368: my $js;
369: if ($allowed_to_edit) {
370: my %lt=&Apache::lonlocal::texthash(
371: 'ce' => 'Cell',
372: 'ac' => 'Save',
373: 'dc' => 'Cancel'
374: );
375: my $extra_javascript =
376: &Apache::loncommon::browser_and_searcher_javascript();
377:
378: my $cell_extra_js = &Apache::loncommon::resize_textarea_js();
379: my $cell_edit_start =
380: &Apache::loncommon::start_page('Cell Edit Window',$cell_extra_js,
381: {'only_body' => 1,
382: 'js_ready' => 1,
383: 'add_entries' => {
384: 'onresize' => "resize_textarea('LC_newformula','LC_aftertextarea')",
385: 'onload' => "resize_textarea('LC_newformula','LC_aftertextarea')",
386: }});
387: my $cell_edit_end =
388: &Apache::loncommon::end_page({'js_ready' => 1,});
389:
390: $js = <<ENDSCRIPT;
391: <script type="text/javascript">
392: //<!--
393: $extra_javascript
394:
395: var editwin;
396:
397: function celledit(cellname,cellformula) {
398: var edit_text = '';
399: // cellformula may contain less-than and greater-than symbols, so
400: // we need to escape them?
401: edit_text +='$cell_edit_start';
402: edit_text += '<form name="editwinform" action="">';
403: edit_text += '<center><h3>$lt{'ce'} '+cellname+'</h3>';
404: edit_text += '<textarea id="LC_newformula" name="newformula" ';
405: edit_text += ' cols="60" rows="12"; wrap="off" style="width:100%">';
406: edit_text += cellformula+'</textarea>';
407: edit_text += '<div id="LC_aftertextarea"><br />';
408: edit_text += '<input type="button" name="accept" value="$lt{'ac'}"';
409: edit_text += ' onclick=\\\'javascript:';
410: edit_text += 'opener.document.sheet.cell.value=';
411: edit_text += '"'+cellname+'";';
412: edit_text += 'opener.document.sheet.newformula.value=';
413: edit_text += 'document.editwinform.newformula.value;';
414: edit_text += 'opener.document.sheet.submit();';
415: edit_text += 'self.close()\\\' />';
416: edit_text += ' ';
417: edit_text += '<input type="button" name="abort" ';
418: edit_text += 'value="$lt{'dc'}"';
419: edit_text += ' onclick="javascript:self.close()" />';
420: edit_text += '</center></div></form>$cell_edit_end';
421:
422: if (editwin != null && !(editwin.closed) ) {
423: editwin.close();
424: }
425:
426: editwin = window.open($nothing,'CellEditWin','height=280,width=480,scrollbars=no,resizable=yes,alwaysRaised=yes,dependent=yes',true);
427: editwin.document.write(edit_text);
428: editwin.document.close();
429: }
430: //-->
431: </script>
432: ENDSCRIPT
433: }
434: &Apache::lonhtmlcommon::clear_breadcrumbs();
435: &Apache::lonhtmlcommon::add_breadcrumb
436: ({href => $r->uri,
437: title => 'Spreadsheet',
438: text => 'Spreadsheet',
439: faq => 134,
440: bug => 'Spreadsheet'});
441: $r->print(&Apache::loncommon::start_page('Grades Spreadsheet',$js).
442: &Apache::lonhtmlcommon::breadcrumbs('Spreadsheet',
443: 'Spreadsheet_About').
444: &Apache::lonhtmlcommon::coursepreflink(&mt('Grade display settings'),
445: 'grading'));
446:
447: #
448: # Open the form
449: #
450: if ($warning) {
451: $r->print('<p class="LC_info">'.$warning.'</p>');
452: }
453: $r->print('<form action="'.$r->uri.'" name="sheet" method="post">');
454: $r->print(&hiddenfield('sname' ,$env{'form.sname'}).
455: &hiddenfield('sdomain',$env{'form.sdomain'}).
456: &hiddenfield('usymb' ,$env{'form.usymb'}));
457: $r->rflush();
458: ##
459: ## Determine the filename to use
460: my $filename = undef;
461: if ($allowed_to_edit) {
462: $filename = $env{'form.filename'} if (exists($env{'form.filename'}));
463: #
464: if (exists($env{'form.load'}) && exists($env{'form.loadfilename'})) {
465: $filename = $env{'form.loadfilename'};
466: $env{'form.workcopy'} = 'no';
467: }
468: }
469: ##
470: ## Take care of "backdoor" spreadsheet expiration / recalc stuff
471: if ($allowed_to_edit && exists($env{'form.recalc'})) {
472: if (exists($env{'form.recalc'})) {
473: &Apache::loncoursedata::delete_caches($env{'requres.course.id'});
474: }
475: if ($env{'form.recalc'} eq 'expireallsheets') {
476: &Apache::lonnet::logthis('spreadsheet expired: entire course');
477: # expire ALL spreadsheets
478: &Apache::lonnet::expirespread('','','studentcalc');
479: &Apache::lonnet::expirespread('','','assesscalc');
480: $r->print('<h3>'.
481: &mt('Expired spreadsheet caches for all students').
482: '</h3>');
483: } elsif ($env{'form.recalc'} =~ /^symb:/) {
484: # expire for all students on this symb
485: my ($symb) = ($env{'form.recalc'} =~ /^symb:(.*)$/);
486: &Apache::lonnet::logthis('spreadsheet expired: symb = '.$symb);
487: &Apache::lonnet::expirespread('','','assesscalc',$symb);
488: &Apache::lonnet::expirespread('','','studentcalc');
489: $r->print('<h3>'.
490: &mt('Expired spreadsheet caches for all students for symb [_1]',
491: $symb).
492: '</h3>');
493: } elsif ($env{'form.recalc'} =~ /^student:/) {
494: # expire all assessment spreadsheets for this user
495: my ($sname,$sdom) = ($env{'form.recalc'}=~/^student:(.*):(.*)$/);
496: &Apache::lonnet::logthis('spreadsheet expired: student = '.
497: $sname.'@'.$sdom);
498: if (defined($sname) && defined($sdom)) {
499: &Apache::lonnet::expirespread($sname,$sdom,'assesscalc');
500: &Apache::lonnet::expirespread($sname,$sdom,'studentcalc');
501: $r->print('<h3>'.
502: &mt('Expired spreadsheet caches for student [_1]',
503: $sname.'@'.$sdom).
504: '</h3>');
505: }
506: }
507: }
508: ##
509: ## Make the spreadsheet
510: &Apache::Spreadsheet::initialize_spreadsheet_package();
511: my $spreadsheet = undef;
512: if ($sheettype eq 'classcalc') {
513: $spreadsheet = Apache::classcalc->new($name,$domain,$filename,undef,
514: $section,\@groups);
515: } elsif ($sheettype eq 'studentcalc') {
516: $spreadsheet = Apache::studentcalc->new($name,$domain,$filename,undef,
517: $section,\@groups);
518: } elsif ($sheettype eq 'assesscalc' &&
519: defined($symb) &&
520: $allowed_to_edit) {
521: $spreadsheet = Apache::assesscalc->new($name,$domain,$filename,$symb,
522: $section,\@groups);
523: } else {
524: return HTTP_NOT_ACCEPTABLE;
525: }
526: if (! defined($spreadsheet)) {
527: # error error - run in circles, scream and shout
528: return;
529: }
530: $spreadsheet->initialize();
531: #
532: # Output selector
533: ##
534: ## Editing/loading/saving
535: if ($allowed_to_edit) {
536: my ($html,$action_message) = &file_dialogs($spreadsheet);
537: if ($env{'form.makedefault'}) {
538: $spreadsheet->make_default();
539: if ($action_message) {
540: $action_message .= '<br />';
541: }
542: $action_message .= &mt('Made this spreadsheet the default');
543: if ($sheettype eq 'classcalc') {
544: $action_message .= ' '.&mt('for the course');
545: } elsif ($sheettype eq 'studentcalc') {
546: $action_message .= ' '.&mt('for all students');
547: } elsif ($sheettype eq 'assesscalc') {
548: $action_message .= ' '.&mt('for all assessments');
549: }
550: $action_message .= '.';
551: }
552: $r->print('<table><tr><td valign="top">'.
553: $spreadsheet->html_header().
554: '</td>'.
555: '<td valign="center">'.$html."</td></tr></table>\n");
556: if ($action_message ne '') {
557: $r->print(
558: &Apache::loncommon::confirmwrapper(
559: &mt('Last Action:')
560: .$action_message)
561: );
562: }
563: $r->rflush();
564: } else {
565: $r->print('<table><tr><td>'.$spreadsheet->html_header().
566: "</td></tr></table>\n");
567: }
568: $r->rflush();
569: #
570: $r->print("<table><tr>");
571: $r->print('<td><input type="submit" value="'.
572: &mt('Generate Spreadsheet').'" />'.
573: '</td>');
574: if ($allowed_to_view) {
575: $r->print('<td>'.
576: &Apache::loncommon::help_open_topic("Spreadsheet_About",
577: &mt('Spreadsheet Help')).
578: '</td>');
579: }
580: if ($allowed_to_edit) {
581: $r->print('<td>'.
582: &Apache::loncommon::help_open_topic("Spreadsheet_Editing",
583: &mt('Editing Help')).
584: '</td>');
585: }
586: $r->print('</tr></table>');
587: #
588: # Keep track of the filename
589: $r->print(&hiddenfield('filename',$filename));
590: #
591: # Keep track of the number of times we have been called, sort of.
592: $r->print(&hiddenfield('not_first_run','1'));
593: #
594: if (exists($env{'form.not_first_run'}) || $sheettype ne 'classcalc') {
595: $r->print($spreadsheet->get_html_title());
596: if ($allowed_to_view || $allowed_to_edit) {
597: $r->print($spreadsheet->parent_link());
598: }
599: $r->rflush();
600: $spreadsheet->display($r);
601: }
602: $r->print('</form>');
603: $r->print(&Apache::loncommon::end_page());
604: $spreadsheet->clear_package();
605: return OK;
606: }
607:
608: 1;
609:
610: __END__
611:
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