1: #
2: # $Id: lonspreadsheet.pm,v 1.140 2002/11/15 18:19:10 matthew 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: package Apache::lonspreadsheet;
54:
55: use strict;
56: use Apache::Constants qw(:common :http);
57: use Apache::lonnet;
58: use Apache::lonhtmlcommon;
59: use Apache::loncoursedata;
60: use Apache::File();
61: use Safe;
62: use Safe::Hole;
63: use Opcode;
64: use GDBM_File;
65: use HTML::TokeParser;
66: use Spreadsheet::WriteExcel;
67:
68: #
69: # Caches for coursewide information
70: #
71: my %Section;
72:
73: #
74: # Caches for previously calculated spreadsheets
75: #
76:
77: my %oldsheets;
78: my %loadedcaches;
79: my %expiredates;
80:
81: #
82: # Cache for stores of an individual user
83: #
84:
85: my $cachedassess;
86: my %cachedstores;
87:
88: #
89: # These cache hashes need to be independent of user, resource and course
90: # (user and course can/should be in the keys)
91: #
92:
93: my %spreadsheets;
94: my %courserdatas;
95: my %userrdatas;
96: my %defaultsheets;
97: my %rowlabel_cache;
98:
99: #
100: # These global hashes are dependent on user, course and resource,
101: # and need to be initialized every time when a sheet is calculated
102: #
103: my %courseopt;
104: my %useropt;
105: my %parmhash;
106:
107: #
108: # Some hashes for stats on timing and performance
109: #
110:
111: my %starttimes;
112: my %usedtimes;
113: my %numbertimes;
114:
115: # Stuff that only the screen handler can know
116:
117: my $includedir;
118: my $tmpdir;
119:
120: # =============================================================================
121: # ===================================== Implements an instance of a spreadsheet
122:
123: ##
124: ## mask - used to reside in the safe space.
125: ##
126: sub mask {
127: my ($lower,$upper)=@_;
128: $upper = $lower if (! defined($upper));
129: #
130: my ($la,$ld) = ($lower=~/([A-Za-z]|\*)(\d+|\*)/);
131: my ($ua,$ud) = ($upper=~/([A-Za-z]|\*)(\d+|\*)/);
132: #
133: my $alpha='';
134: my $num='';
135: #
136: if (($la eq '*') || ($ua eq '*')) {
137: $alpha='[A-Za-z]';
138: } else {
139: if (($la=~/[A-Z]/) && ($ua=~/[A-Z]/) ||
140: ($la=~/[a-z]/) && ($ua=~/[a-z]/)) {
141: $alpha='['.$la.'-'.$ua.']';
142: } else {
143: $alpha='['.$la.'-Za-'.$ua.']';
144: }
145: }
146: if (($ld eq '*') || ($ud eq '*')) {
147: $num='\d+';
148: } else {
149: if (length($ld)!=length($ud)) {
150: $num.='(';
151: foreach ($ld=~m/\d/g) {
152: $num.='['.$_.'-9]';
153: }
154: if (length($ud)-length($ld)>1) {
155: $num.='|\d{'.(length($ld)+1).','.(length($ud)-1).'}';
156: }
157: $num.='|';
158: foreach ($ud=~m/\d/g) {
159: $num.='[0-'.$_.']';
160: }
161: $num.=')';
162: } else {
163: my @lda=($ld=~m/\d/g);
164: my @uda=($ud=~m/\d/g);
165: my $i;
166: my $j=0;
167: my $notdone=1;
168: for ($i=0;($i<=$#lda)&&($notdone);$i++) {
169: if ($lda[$i]==$uda[$i]) {
170: $num.=$lda[$i];
171: $j=$i;
172: } else {
173: $notdone=0;
174: }
175: }
176: if ($j<$#lda-1) {
177: $num.='('.$lda[$j+1];
178: for ($i=$j+2;$i<=$#lda;$i++) {
179: $num.='['.$lda[$i].'-9]';
180: }
181: if ($uda[$j+1]-$lda[$j+1]>1) {
182: $num.='|['.($lda[$j+1]+1).'-'.($uda[$j+1]-1).']\d{'.
183: ($#lda-$j-1).'}';
184: }
185: $num.='|'.$uda[$j+1];
186: for ($i=$j+2;$i<=$#uda;$i++) {
187: $num.='[0-'.$uda[$i].']';
188: }
189: $num.=')';
190: } else {
191: if ($lda[-1]!=$uda[-1]) {
192: $num.='['.$lda[-1].'-'.$uda[-1].']';
193: }
194: }
195: }
196: }
197: return '^'.$alpha.$num."\$";
198: }
199:
200: sub initsheet {
201: my $safeeval = new Safe(shift);
202: my $safehole = new Safe::Hole;
203: $safeeval->permit("entereval");
204: $safeeval->permit(":base_math");
205: $safeeval->permit("sort");
206: $safeeval->deny(":base_io");
207: $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
208: $safehole->wrap(\&Apache::lonspreadsheet::mask,$safeeval,'&mask');
209: $safeeval->share('$@');
210: my $code=<<'ENDDEFS';
211: # ---------------------------------------------------- Inside of the safe space
212:
213: #
214: # f: formulas
215: # t: intermediate format (variable references expanded)
216: # v: output values
217: # c: preloaded constants (A-column)
218: # rl: row label
219: # os: other spreadsheets (for student spreadsheet only)
220:
221: undef %sheet_values; # Holds the (computed, final) values for the sheet
222: # This is only written to by &calc, the spreadsheet computation routine.
223: # It is read by many functions
224: undef %t; # Holds the values of the spreadsheet temporarily. Set in &sett,
225: # which does the translation of strings like C5 into the value in C5.
226: # Used in &calc - %t holds the values that are actually eval'd.
227: undef %f; # Holds the formulas for each cell. This is the users
228: # (spreadsheet authors) data for each cell.
229: # set by &setformulas and returned by &getformulas
230: # &setformulas is called by &readsheet, &tmpread, &updateclasssheet,
231: # &updatestudentassesssheet, &loadstudent, &loadcourse
232: # &getformulas is called by &writesheet, &tmpwrite, &updateclasssheet,
233: # &updatestudentassesssheet, &loadstudent, &loadcourse, &loadassessment,
234: undef %c; # Holds the constants for a sheet. In the assessment
235: # sheets, this is the A column. Used in &MINPARM, &MAXPARM, &expandnamed,
236: # &sett, and &setconstants. There is no &getconstants.
237: # &setconstants is called by &loadstudent, &loadcourse, &load assessment,
238: undef @os; # Holds the names of other spreadsheets - this is used to specify
239: # the spreadsheets that are available for the assessment sheet.
240: # Set by &setothersheets. &setothersheets is called by &handler. A
241: # related subroutine is &othersheets.
242: #$errorlog = '';
243:
244: $maxrow = 0;
245: $sheettype = '';
246:
247: # filename/reference of the sheet
248: $filename = '';
249:
250: # user data
251: $uname = '';
252: $uhome = '';
253: $udom = '';
254:
255: # course data
256:
257: $csec = '';
258: $chome= '';
259: $cnum = '';
260: $cdom = '';
261: $cid = '';
262: $coursefilename = '';
263:
264: # symb
265:
266: $usymb = '';
267:
268: # error messages
269: $errormsg = '';
270:
271:
272: #-------------------------------------------------------
273:
274: =item UWCALC(hashname,modules,units,date)
275:
276: returns the proportion of the module
277: weights not previously completed by the student.
278:
279: =over 4
280:
281: =item hashname
282:
283: name of the hash the module dates have been inserted into
284:
285: =item modules
286:
287: reference to a cell which contains a comma deliminated list of modules
288: covered by the assignment.
289:
290: =item units
291:
292: reference to a cell which contains a comma deliminated list of module
293: weights with respect to the assignment
294:
295: =item date
296:
297: reference to a cell which contains the date the assignment was completed.
298:
299: =back
300:
301: =cut
302:
303: #-------------------------------------------------------
304: sub UWCALC {
305: my ($hashname,$modules,$units,$date) = @_;
306: my @Modules = split(/,/,$modules);
307: my @Units = split(/,/,$units);
308: my $total_weight;
309: foreach (@Units) {
310: $total_weight += $_;
311: }
312: my $usum=0;
313: for (my $i=0; $i<=$#Modules; $i++) {
314: if (&HASH($hashname,$Modules[$i]) eq $date) {
315: $usum += $Units[$i];
316: }
317: }
318: return $usum/$total_weight;
319: }
320:
321: #-------------------------------------------------------
322:
323: =item CDLSUM(list)
324:
325: returns the sum of the elements in a cell which contains
326: a Comma Deliminate List of numerical values.
327: 'list' is a reference to a cell which contains a comma deliminated list.
328:
329: =cut
330:
331: #-------------------------------------------------------
332: sub CDLSUM {
333: my ($list)=@_;
334: my $sum;
335: foreach (split/,/,$list) {
336: $sum += $_;
337: }
338: return $sum;
339: }
340:
341: #-------------------------------------------------------
342:
343: =item CDLITEM(list,index)
344:
345: returns the item at 'index' in a Comma Deliminated List.
346:
347: =over 4
348:
349: =item list
350:
351: reference to a cell which contains a comma deliminated list.
352:
353: =item index
354:
355: the Perl index of the item requested (first element in list has
356: an index of 0)
357:
358: =back
359:
360: =cut
361:
362: #-------------------------------------------------------
363: sub CDLITEM {
364: my ($list,$index)=@_;
365: my @Temp = split/,/,$list;
366: return $Temp[$index];
367: }
368:
369: #-------------------------------------------------------
370:
371: =item CDLHASH(name,key,value)
372:
373: loads a comma deliminated list of keys into
374: the hash 'name', all with a value of 'value'.
375:
376: =over 4
377:
378: =item name
379:
380: name of the hash.
381:
382: =item key
383:
384: (a pointer to) a comma deliminated list of keys.
385:
386: =item value
387:
388: a single value to be entered for each key.
389:
390: =back
391:
392: =cut
393:
394: #-------------------------------------------------------
395: sub CDLHASH {
396: my ($name,$key,$value)=@_;
397: my @Keys;
398: my @Values;
399: # Check to see if we have multiple $key values
400: if ($key =~ /[A-z](\-[A-z])?\d+(\-\d+)?/) {
401: my $keymask = &mask($key);
402: # Assume the keys are addresses
403: my @Temp = grep /$keymask/,keys(%sheet_values);
404: @Keys = $sheet_values{@Temp};
405: } else {
406: $Keys[0]= $key;
407: }
408: my @Temp;
409: foreach $key (@Keys) {
410: @Temp = (@Temp, split/,/,$key);
411: }
412: @Keys = @Temp;
413: if ($value =~ /[A-z](\-[A-z])?\d+(\-\d+)?/) {
414: my $valmask = &mask($value);
415: my @Temp = grep /$valmask/,keys(%sheet_values);
416: @Values =$sheet_values{@Temp};
417: } else {
418: $Values[0]= $value;
419: }
420: $value = $Values[0];
421: # Add values to hash
422: for (my $i = 0; $i<=$#Keys; $i++) {
423: my $key = $Keys[$i];
424: if (! exists ($hashes{$name}->{$key})) {
425: $hashes{$name}->{$key}->[0]=$value;
426: } else {
427: my @Temp = sort(@{$hashes{$name}->{$key}},$value);
428: $hashes{$name}->{$key} = \@Temp;
429: }
430: }
431: return "hash '$name' updated";
432: }
433:
434: #-------------------------------------------------------
435:
436: =item GETHASH(name,key,index)
437:
438: returns the element in hash 'name'
439: reference by the key 'key', at index 'index' in the values list.
440:
441: =cut
442:
443: #-------------------------------------------------------
444: sub GETHASH {
445: my ($name,$key,$index)=@_;
446: if (! defined($index)) {
447: $index = 0;
448: }
449: if ($key =~ /^[A-z]\d+$/) {
450: $key = $sheet_values{$key};
451: }
452: return $hashes{$name}->{$key}->[$index];
453: }
454:
455: #-------------------------------------------------------
456:
457: =item CLEARHASH(name)
458:
459: clears all the values from the hash 'name'
460:
461: =item CLEARHASH(name,key)
462:
463: clears all the values from the hash 'name' associated with the given key.
464:
465: =cut
466:
467: #-------------------------------------------------------
468: sub CLEARHASH {
469: my ($name,$key)=@_;
470: if (defined($key)) {
471: if (exists($hashes{$name}->{$key})) {
472: $hashes{$name}->{$key}=undef;
473: return "hash '$name' key '$key' cleared";
474: }
475: } else {
476: if (exists($hashes{$name})) {
477: $hashes{$name}=undef;
478: return "hash '$name' cleared";
479: }
480: }
481: return "Error in clearing hash";
482: }
483:
484: #-------------------------------------------------------
485:
486: =item HASH(name,key,value)
487:
488: loads values into an internal hash. If a key
489: already has a value associated with it, the values are sorted numerically.
490:
491: =item HASH(name,key)
492:
493: returns the 0th value in the hash 'name' associated with 'key'.
494:
495: =cut
496:
497: #-------------------------------------------------------
498: sub HASH {
499: my ($name,$key,$value)=@_;
500: my @Keys;
501: undef @Keys;
502: my @Values;
503: # Check to see if we have multiple $key values
504: if ($key =~ /[A-z](\-[A-z])?\d+(\-\d+)?/) {
505: my $keymask = &mask($key);
506: # Assume the keys are addresses
507: my @Temp = grep /$keymask/,keys(%sheet_values);
508: @Keys = $sheet_values{@Temp};
509: } else {
510: $Keys[0]= $key;
511: }
512: # If $value is empty, return the first value associated
513: # with the first key.
514: if (! $value) {
515: return $hashes{$name}->{$Keys[0]}->[0];
516: }
517: # Check to see if we have multiple $value(s)
518: if ($value =~ /[A-z](\-[A-z])?\d+(\-\d+)?/) {
519: my $valmask = &mask($value);
520: my @Temp = grep /$valmask/,keys(%sheet_values);
521: @Values =$sheet_values{@Temp};
522: } else {
523: $Values[0]= $value;
524: }
525: # Add values to hash
526: for (my $i = 0; $i<=$#Keys; $i++) {
527: my $key = $Keys[$i];
528: my $value = ($i<=$#Values ? $Values[$i] : $Values[0]);
529: if (! exists ($hashes{$name}->{$key})) {
530: $hashes{$name}->{$key}->[0]=$value;
531: } else {
532: my @Temp = sort(@{$hashes{$name}->{$key}},$value);
533: $hashes{$name}->{$key} = \@Temp;
534: }
535: }
536: return $Values[-1];
537: }
538:
539: #-------------------------------------------------------
540:
541: =item NUM(range)
542:
543: returns the number of items in the range.
544:
545: =cut
546:
547: #-------------------------------------------------------
548: sub NUM {
549: my $mask=mask(@_);
550: my $num= $#{@{grep(/$mask/,keys(%sheet_values))}}+1;
551: return $num;
552: }
553:
554: sub BIN {
555: my ($low,$high,$lower,$upper)=@_;
556: my $mask=mask($lower,$upper);
557: my $num=0;
558: foreach (grep /$mask/,keys(%sheet_values)) {
559: if (($sheet_values{$_}>=$low) && ($sheet_values{$_}<=$high)) {
560: $num++;
561: }
562: }
563: return $num;
564: }
565:
566:
567: #-------------------------------------------------------
568:
569: =item SUM(range)
570:
571: returns the sum of items in the range.
572:
573: =cut
574:
575: #-------------------------------------------------------
576: sub SUM {
577: my $mask=mask(@_);
578: my $sum=0;
579: foreach (grep /$mask/,keys(%sheet_values)) {
580: $sum+=$sheet_values{$_};
581: }
582: return $sum;
583: }
584:
585: #-------------------------------------------------------
586:
587: =item MEAN(range)
588:
589: compute the average of the items in the range.
590:
591: =cut
592:
593: #-------------------------------------------------------
594: sub MEAN {
595: my $mask=mask(@_);
596: my $sum=0;
597: my $num=0;
598: foreach (grep /$mask/,keys(%sheet_values)) {
599: $sum+=$sheet_values{$_};
600: $num++;
601: }
602: if ($num) {
603: return $sum/$num;
604: } else {
605: return undef;
606: }
607: }
608:
609: #-------------------------------------------------------
610:
611: =item STDDEV(range)
612:
613: compute the standard deviation of the items in the range.
614:
615: =cut
616:
617: #-------------------------------------------------------
618: sub STDDEV {
619: my $mask=mask(@_);
620: my $sum=0; my $num=0;
621: foreach (grep /$mask/,keys(%sheet_values)) {
622: $sum+=$sheet_values{$_};
623: $num++;
624: }
625: unless ($num>1) { return undef; }
626: my $mean=$sum/$num;
627: $sum=0;
628: foreach (grep /$mask/,keys(%sheet_values)) {
629: $sum+=($sheet_values{$_}-$mean)**2;
630: }
631: return sqrt($sum/($num-1));
632: }
633:
634: #-------------------------------------------------------
635:
636: =item PROD(range)
637:
638: compute the product of the items in the range.
639:
640: =cut
641:
642: #-------------------------------------------------------
643: sub PROD {
644: my $mask=mask(@_);
645: my $prod=1;
646: foreach (grep /$mask/,keys(%sheet_values)) {
647: $prod*=$sheet_values{$_};
648: }
649: return $prod;
650: }
651:
652: #-------------------------------------------------------
653:
654: =item MAX(range)
655:
656: compute the maximum of the items in the range.
657:
658: =cut
659:
660: #-------------------------------------------------------
661: sub MAX {
662: my $mask=mask(@_);
663: my $max='-';
664: foreach (grep /$mask/,keys(%sheet_values)) {
665: unless ($max) { $max=$sheet_values{$_}; }
666: if (($sheet_values{$_}>$max) || ($max eq '-')) { $max=$sheet_values{$_}; }
667: }
668: return $max;
669: }
670:
671: #-------------------------------------------------------
672:
673: =item MIN(range)
674:
675: compute the minimum of the items in the range.
676:
677: =cut
678:
679: #-------------------------------------------------------
680: sub MIN {
681: my $mask=mask(@_);
682: my $min='-';
683: foreach (grep /$mask/,keys(%sheet_values)) {
684: unless ($max) { $max=$sheet_values{$_}; }
685: if (($sheet_values{$_}<$min) || ($min eq '-')) {
686: $min=$sheet_values{$_};
687: }
688: }
689: return $min;
690: }
691:
692: #-------------------------------------------------------
693:
694: =item SUMMAX(num,lower,upper)
695:
696: compute the sum of the largest 'num' items in the range from
697: 'lower' to 'upper'
698:
699: =cut
700:
701: #-------------------------------------------------------
702: sub SUMMAX {
703: my ($num,$lower,$upper)=@_;
704: my $mask=mask($lower,$upper);
705: my @inside=();
706: foreach (grep /$mask/,keys(%sheet_values)) {
707: push (@inside,$sheet_values{$_});
708: }
709: @inside=sort(@inside);
710: my $sum=0; my $i;
711: for ($i=$#inside;(($i>$#inside-$num) && ($i>=0));$i--) {
712: $sum+=$inside[$i];
713: }
714: return $sum;
715: }
716:
717: #-------------------------------------------------------
718:
719: =item SUMMIN(num,lower,upper)
720:
721: compute the sum of the smallest 'num' items in the range from
722: 'lower' to 'upper'
723:
724: =cut
725:
726: #-------------------------------------------------------
727: sub SUMMIN {
728: my ($num,$lower,$upper)=@_;
729: my $mask=mask($lower,$upper);
730: my @inside=();
731: foreach (grep /$mask/,keys(%sheet_values)) {
732: $inside[$#inside+1]=$sheet_values{$_};
733: }
734: @inside=sort(@inside);
735: my $sum=0; my $i;
736: for ($i=0;(($i<$num) && ($i<=$#inside));$i++) {
737: $sum+=$inside[$i];
738: }
739: return $sum;
740: }
741:
742: #-------------------------------------------------------
743:
744: =item MINPARM(parametername)
745:
746: Returns the minimum value of the parameters matching the parametername.
747: parametername should be a string such as 'duedate'.
748:
749: =cut
750:
751: #-------------------------------------------------------
752: sub MINPARM {
753: my ($expression) = @_;
754: my $min = undef;
755: study($expression);
756: foreach $parameter (keys(%c)) {
757: next if ($parameter !~ /$expression/);
758: if ((! defined($min)) || ($min > $c{$parameter})) {
759: $min = $c{$parameter}
760: }
761: }
762: return $min;
763: }
764:
765: #-------------------------------------------------------
766:
767: =item MAXPARM(parametername)
768:
769: Returns the maximum value of the parameters matching the input parameter name.
770: parametername should be a string such as 'duedate'.
771:
772: =cut
773:
774: #-------------------------------------------------------
775: sub MAXPARM {
776: my ($expression) = @_;
777: my $max = undef;
778: study($expression);
779: foreach $parameter (keys(%c)) {
780: next if ($parameter !~ /$expression/);
781: if ((! defined($min)) || ($max < $c{$parameter})) {
782: $max = $c{$parameter}
783: }
784: }
785: return $max;
786: }
787:
788: #--------------------------------------------------------
789: sub expandnamed {
790: my $expression=shift;
791: if ($expression=~/^\&/) {
792: my ($func,$var,$formula)=($expression=~/^\&(\w+)\(([^\;]+)\;(.*)\)/);
793: my @vars=split(/\W+/,$formula);
794: my %values=();
795: undef %values;
796: foreach ( @vars ) {
797: my $varname=$_;
798: if ($varname=~/\D/) {
799: $formula=~s/$varname/'$c{\''.$varname.'\'}'/ge;
800: $varname=~s/$var/\(\\w\+\)/g;
801: foreach (keys(%c)) {
802: if ($_=~/$varname/) {
803: $values{$1}=1;
804: }
805: }
806: }
807: }
808: if ($func eq 'EXPANDSUM') {
809: my $result='';
810: foreach (keys(%values)) {
811: my $thissum=$formula;
812: $thissum=~s/$var/$_/g;
813: $result.=$thissum.'+';
814: }
815: $result=~s/\+$//;
816: return $result;
817: } else {
818: return 0;
819: }
820: } else {
821: # it is not a function, so it is a parameter name
822: # We should do the following:
823: # 1. Take the list of parameter names
824: # 2. look through the list for ones that match the parameter we want
825: # 3. If there are no collisions, return the one that matches
826: # 4. If there is a collision, return 'bad parameter name error'
827: my $returnvalue = '';
828: my @matches = ();
829: $#matches = -1;
830: study $expression;
831: foreach $parameter (keys(%c)) {
832: push @matches,$parameter if ($parameter =~ /$expression/);
833: }
834: if (scalar(@matches) == 0) {
835: $returnvalue = 'unmatched parameter: '.$parameter;
836: } elsif (scalar(@matches) == 1) {
837: $returnvalue = '$c{\''.$matches[0].'\'}';
838: } elsif (scalar(@matches) > 0) {
839: # more than one match. Look for a concise one
840: $returnvalue = "'non-unique parameter name : $expression'";
841: foreach (@matches) {
842: if (/^$expression$/) {
843: $returnvalue = '$c{\''.$_.'\'}';
844: }
845: }
846: } else {
847: # There was a negative number of matches, which indicates
848: # something is wrong with reality. Better warn the user.
849: $returnvalue = 'bizzare parameter: '.$parameter;
850: }
851: return $returnvalue;
852: }
853: }
854:
855: sub sett {
856: %t=();
857: my $pattern='';
858: if ($sheettype eq 'assesscalc') {
859: $pattern='A';
860: } else {
861: $pattern='[A-Z]';
862: }
863: # Deal with the template row
864: foreach (keys(%f)) {
865: next if ($_!~/template\_(\w)/);
866: my $col=$1;
867: next if ($col=~/^$pattern/);
868: foreach (keys(%f)) {
869: next if ($_!~/A(\d+)/);
870: my $trow=$1;
871: next if (! $trow);
872: # Get the name of this cell
873: my $lb=$col.$trow;
874: # Grab the template declaration
875: $t{$lb}=$f{'template_'.$col};
876: # Replace '#' with the row number
877: $t{$lb}=~s/\#/$trow/g;
878: # Replace '....' with ','
879: $t{$lb}=~s/\.\.+/\,/g;
880: # Replace 'A0' with the value from 'A0'
881: $t{$lb}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
882: # Replace parameters
883: $t{$lb}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.&expandnamed($2)/ge;
884: }
885: }
886: # Deal with the normal cells
887: foreach (keys(%f)) {
888: if (exists($f{$_}) && ($_!~/template\_/)) {
889: my $matches=($_=~/^$pattern(\d+)/);
890: if (($matches) && ($1)) {
891: unless ($f{$_}=~/^\!/) {
892: $t{$_}=$c{$_};
893: }
894: } else {
895: $t{$_}=$f{$_};
896: $t{$_}=~s/\.\.+/\,/g;
897: $t{$_}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
898: $t{$_}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.&expandnamed($2)/ge;
899: }
900: }
901: }
902: # For inserted lines, [B-Z] is also valid
903: unless ($sheettype eq 'assesscalc') {
904: foreach (keys(%f)) {
905: if ($_=~/[B-Z](\d+)/) {
906: if ($f{'A'.$1}=~/^[\~\-]/) {
907: $t{$_}=$f{$_};
908: $t{$_}=~s/\.\.+/\,/g;
909: $t{$_}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
910: $t{$_}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.&expandnamed($2)/ge;
911: }
912: }
913: }
914: }
915: # For some reason 'A0' gets special treatment... This seems superfluous
916: # but I imagine it is here for a reason.
917: $t{'A0'}=$f{'A0'};
918: $t{'A0'}=~s/\.\.+/\,/g;
919: $t{'A0'}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
920: $t{'A0'}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.&expandnamed($2)/ge;
921: }
922:
923: sub calc {
924: undef %sheet_values;
925: &sett();
926: my $notfinished=1;
927: my $lastcalc='';
928: my $depth=0;
929: while ($notfinished) {
930: $notfinished=0;
931: foreach (keys(%t)) {
932: #$errorlog .= "$_:".$t{$_};
933: my $old=$sheet_values{$_};
934: $sheet_values{$_}=eval $t{$_};
935: if ($@) {
936: undef %sheet_values;
937: return $_.': '.$@;
938: }
939: if ($sheet_values{$_} ne $old) { $notfinished=1; $lastcalc=$_; }
940: #$errorlog .= ":".$sheet_values{$_}."\n";
941: }
942: $depth++;
943: if ($depth>100) {
944: undef %sheet_values;
945: return $lastcalc.': Maximum calculation depth exceeded';
946: }
947: }
948: return '';
949: }
950:
951: # ------------------------------------------- End of "Inside of the safe space"
952: ENDDEFS
953: $safeeval->reval($code);
954: return $safeeval;
955: }
956:
957: #
958: #
959: #
960: sub templaterow {
961: my $sheet = shift;
962: my @cols=();
963: my $rowlabel = 'Template';
964: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
965: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z',
966: 'a','b','c','d','e','f','g','h','i','j','k','l','m',
967: 'n','o','p','q','r','s','t','u','v','w','x','y','z') {
968: my $fm=$sheet->{'f'}->{'template_'.$_};
969: $fm=~s/[\'\"]/\&\#34;/g;
970: push(@cols,{ name => 'template_'.$_,
971: formula => $fm,
972: value => $fm });
973: }
974: return ($rowlabel,@cols);
975: }
976:
977: sub outrowassess {
978: # $n is the current row number
979: my ($sheet,$n) = @_;
980: my @cols=();
981: my $rowlabel='';
982: if ($n) {
983: my ($usy,$ufn)=split(/__&&&\__/,$sheet->{'f'}->{'A'.$n});
984: if (exists($sheet->{'rowlabel'}->{$usy})) {
985: $rowlabel = $sheet->{'rowlabel'}->{$usy};
986: } else {
987: $rowlabel = '';
988: }
989: } else {
990: $rowlabel = 'Export';
991: }
992: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
993: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z',
994: 'a','b','c','d','e','f','g','h','i','j','k','l','m',
995: 'n','o','p','q','r','s','t','u','v','w','x','y','z') {
996: my $fm=$sheet->{'f'}->{$_.$n};
997: $fm=~s/[\'\"]/\&\#34;/g;
998: push(@cols,{ name => $_.$n,
999: formula => $fm,
1000: value => $sheet->{'values'}->{$_.$n}});
1001: }
1002: return ($rowlabel,@cols);
1003: }
1004:
1005: sub outrow {
1006: my ($sheet,$n)=@_;
1007: my @cols=();
1008: my $rowlabel;
1009: if ($n) {
1010: $rowlabel = $sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$n}};
1011: } else {
1012: if ($sheet->{'sheettype'} eq 'classcalc') {
1013: $rowlabel = 'Summary';
1014: } else {
1015: $rowlabel = 'Export';
1016: }
1017: }
1018: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
1019: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z',
1020: 'a','b','c','d','e','f','g','h','i','j','k','l','m',
1021: 'n','o','p','q','r','s','t','u','v','w','x','y','z') {
1022: my $fm=$sheet->{'f'}->{$_.$n};
1023: $fm=~s/[\'\"]/\&\#34;/g;
1024: push(@cols,{ name => $_.$n,
1025: formula => $fm,
1026: value => $sheet->{'values'}->{$_.$n}});
1027: }
1028: return ($rowlabel,@cols);
1029: }
1030:
1031: # ------------------------------------------------ Add or change formula values
1032: sub setformulas {
1033: my ($sheet)=shift;
1034: %{$sheet->{'safe'}->varglob('f')}=%{$sheet->{'f'}};
1035: }
1036:
1037: # ------------------------------------------------ Add or change formula values
1038: sub setconstants {
1039: my ($sheet)=shift;
1040: my ($constants) = @_;
1041: if (! ref($constants)) {
1042: my %tmp = @_;
1043: $constants = \%tmp;
1044: }
1045: $sheet->{'constants'} = $constants;
1046: return %{$sheet->{'safe'}->varglob('c')}=%{$sheet->{'constants'}};
1047: }
1048:
1049: # --------------------------------------------- Set names of other spreadsheets
1050: sub setothersheets {
1051: my $sheet = shift;
1052: my @othersheets = @_;
1053: $sheet->{'othersheets'} = \@othersheets;
1054: @{$sheet->{'safe'}->varglob('os')}=@othersheets;
1055: return;
1056: }
1057:
1058: # ------------------------------------------------ Add or change formula values
1059: sub setrowlabels {
1060: my $sheet=shift;
1061: my ($rowlabel) = @_;
1062: if (! ref($rowlabel)) {
1063: my %tmp = @_;
1064: $rowlabel = \%tmp;
1065: }
1066: $sheet->{'rowlabel'}=$rowlabel;
1067: }
1068:
1069: # ------------------------------------------------------- Calculate spreadsheet
1070: sub calcsheet {
1071: my $sheet=shift;
1072: my $result = $sheet->{'safe'}->reval('&calc();');
1073: %{$sheet->{'values'}} = %{$sheet->{'safe'}->varglob('sheet_values')};
1074: return $result;
1075: }
1076:
1077: # ---------------------------------------------------------------- Get formulas
1078: # Return a copy of the formulas
1079: sub getformulas {
1080: my $sheet = shift;
1081: return %{$sheet->{'safe'}->varglob('f')};
1082: }
1083:
1084: sub geterrorlog {
1085: my $sheet = shift;
1086: return ${$sheet->{'safe'}->varglob('errorlog')};
1087: }
1088:
1089: sub gettitle {
1090: my $sheet = shift;
1091: if ($sheet->{'sheettype'} eq 'classcalc') {
1092: return $sheet->{'coursedesc'};
1093: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1094: return 'Grades for '.$sheet->{'uname'}.'@'.$sheet->{'udom'};
1095: } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
1096: if (($sheet->{'usymb'} eq '_feedback') ||
1097: ($sheet->{'usymb'} eq '_evaluation') ||
1098: ($sheet->{'usymb'} eq '_discussion') ||
1099: ($sheet->{'usymb'} eq '_tutoring')) {
1100: my $title = $sheet->{'usymb'};
1101: $title =~ s/^_//;
1102: $title = ucfirst($title);
1103: return $title;
1104: }
1105: return if (! defined($sheet->{'mapid'}) ||
1106: $sheet->{'mapid'} !~ /^\d+$/);
1107: my $mapid = $sheet->{'mapid'};
1108: return if (! defined($sheet->{'resid'}) ||
1109: $sheet->{'resid'} !~ /^\d+$/);
1110: my $resid = $sheet->{'resid'};
1111: my %course_db;
1112: tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db',
1113: &GDBM_READER(),0640);
1114: return if (! tied(%course_db));
1115: my $key = 'title_'.$mapid.'.'.$resid;
1116: my $title = '';
1117: if (exists($course_db{$key})) {
1118: $title = $course_db{$key};
1119: } else {
1120: $title = $sheet->{'usymb'};
1121: }
1122: untie (%course_db);
1123: return $title;
1124: }
1125: }
1126:
1127: # ----------------------------------------------------- Get value of $f{'A'.$n}
1128: sub getfa {
1129: my $sheet = shift;
1130: my ($n)=@_;
1131: return $sheet->{'safe'}->reval('$f{"A'.$n.'"}');
1132: }
1133:
1134: # ------------------------------------------------------------- Export of A-row
1135: sub exportdata {
1136: my $sheet=shift;
1137: my @exportarray=();
1138: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
1139: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') {
1140: if (exists($sheet->{'values'}->{$_.'0'})) {
1141: push(@exportarray,$sheet->{'values'}->{$_.'0'});
1142: } else {
1143: push(@exportarray,'');
1144: }
1145: }
1146: return @exportarray;
1147: }
1148:
1149:
1150:
1151: sub update_student_sheet{
1152: my ($sheet,$c) = @_;
1153: # Load in the studentcalc sheet
1154: &readsheet($sheet,'default_studentcalc');
1155: # Determine the structure (contained assessments, etc) of the sheet
1156: &updatesheet($sheet);
1157: # Load in the cached sheets for this student
1158: &cachedssheets($sheet);
1159: # Load in the (possibly cached) data from the assessment sheets
1160: &loadstudent($sheet,$c);
1161: # Compute the sheet
1162: &calcsheet($sheet);
1163: }
1164:
1165: # ========================================================== End of Spreadsheet
1166: # =============================================================================
1167: #
1168: # Procedures for spreadsheet output
1169: #
1170: # --------------------------------------------- Produce output row n from sheet
1171:
1172: sub get_row {
1173: my ($sheet,$n) = @_;
1174: my ($rowlabel,@rowdata);
1175: if ($n eq '-') {
1176: ($rowlabel,@rowdata) = &templaterow($sheet);
1177: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1178: ($rowlabel,@rowdata) = &outrowassess($sheet,$n);
1179: } else {
1180: ($rowlabel,@rowdata) = &outrow($sheet,$n);
1181: }
1182: return ($rowlabel,@rowdata);
1183: }
1184:
1185: ########################################################################
1186: ########################################################################
1187: sub sort_indicies {
1188: my $sheet = shift;
1189: #
1190: # Sort the rows in some manner
1191: #
1192: my @sortby=();
1193: my @sortidx=();
1194: # Skip row 0
1195: for (my $row=1;$row<=$sheet->{'maxrow'};$row++) {
1196: push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}'));
1197: push (@sortidx, $row);
1198: }
1199: @sortidx=sort { lc($sortby[$a]) cmp lc($sortby[$b]); } @sortidx;
1200: return @sortidx;
1201: }
1202:
1203: #############################################################
1204: ### ###
1205: ### Spreadsheet Output Routines ###
1206: ### ###
1207: #############################################################
1208:
1209: ############################################
1210: ## HTML output routines ##
1211: ############################################
1212: sub html_editable_cell {
1213: my ($cell,$bgcolor) = @_;
1214: my $result;
1215: my ($name,$formula,$value);
1216: if (defined($cell)) {
1217: $name = $cell->{'name'};
1218: $formula = $cell->{'formula'};
1219: $value = $cell->{'value'};
1220: }
1221: $name = '' if (! defined($name));
1222: $formula = '' if (! defined($formula));
1223: if (! defined($value)) {
1224: $value = '<font color="'.$bgcolor.'">#</font>';
1225: if ($formula ne '') {
1226: $value = '<i>undefined value</i>';
1227: }
1228: }
1229: if ($value =~ /^\s*$/ ) {
1230: $value = '<font color="'.$bgcolor.'">#</font>';
1231: }
1232: $formula =~ s/\n/\\n/gs;
1233: $result .= '<a href="javascript:celledit(\''.
1234: $name.'\',\''.$formula.'\');">'.$value.'</a>';
1235: return $result;
1236: }
1237:
1238: sub html_uneditable_cell {
1239: my ($cell,$bgcolor) = @_;
1240: my $value = (defined($cell) ? $cell->{'value'} : '');
1241: return ' '.$value.' ';
1242: }
1243:
1244: sub outsheet_html {
1245: my ($sheet,$r) = @_;
1246: my ($num_uneditable,$realm,$row_type);
1247: if ($sheet->{'sheettype'} eq 'assesscalc') {
1248: $num_uneditable = 1;
1249: $realm = 'Assessment';
1250: $row_type = 'Item';
1251: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1252: $num_uneditable = 26;
1253: $realm = 'User';
1254: $row_type = 'Assessment';
1255: } elsif ($sheet->{'sheettype'} eq 'classcalc') {
1256: $num_uneditable = 26;
1257: $realm = 'Course';
1258: $row_type = 'Student';
1259: } else {
1260: return; # error
1261: }
1262: ####################################
1263: # Print out header table
1264: ####################################
1265: my $num_left = 52-$num_uneditable;
1266: my $tabledata =<<"END";
1267: <table border="2">
1268: <tr>
1269: <th colspan="1" rowspan="2"><font size="+2">$realm</font></th>
1270: <td bgcolor="#FFDDDD" colspan="$num_uneditable">
1271: <b><font size="+1">Import</font></b></td>
1272: <td colspan="$num_left">
1273: <b><font size="+1">Calculations</font></b></td>
1274: </tr><tr>
1275: END
1276: my $label_num = 0;
1277: foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
1278: if ($label_num<$num_uneditable) {
1279: $tabledata.='<td bgcolor="#FFDDDD">';
1280: } else {
1281: $tabledata.='<td>';
1282: }
1283: $tabledata.="<b><font size=+1>$_</font></b></td>";
1284: $label_num++;
1285: }
1286: $tabledata.="</tr>\n";
1287: $r->print($tabledata);
1288: ####################################
1289: # Print out template row
1290: ####################################
1291: my ($rowlabel,@rowdata) = &get_row($sheet,'-');
1292: my $row_html = '<tr><td>'.&format_html_rowlabel($rowlabel).'</td>';
1293: my $num_cols_output = 0;
1294: foreach my $cell (@rowdata) {
1295: if ($num_cols_output++ < $num_uneditable) {
1296: $row_html .= '<td bgcolor="#FFDDDD">';
1297: $row_html .= &html_uneditable_cell($cell,'#FFDDDD');
1298: } else {
1299: $row_html .= '<td bgcolor="#EOFFDD">';
1300: $row_html .= &html_editable_cell($cell,'#E0FFDD');
1301: }
1302: $row_html .= '</td>';
1303: }
1304: $row_html.= "</tr>\n";
1305: $r->print($row_html);
1306: ####################################
1307: # Print out summary/export row
1308: ####################################
1309: my ($rowlabel,@rowdata) = &get_row($sheet,'0');
1310: $row_html = '<tr><td>'.&format_html_rowlabel($rowlabel).'</td>';
1311: $num_cols_output = 0;
1312: foreach my $cell (@rowdata) {
1313: if ($num_cols_output++ < 26) {
1314: $row_html .= '<td bgcolor="#CCCCFF">';
1315: $row_html .= &html_editable_cell($cell,'#CCCCFF');
1316: } else {
1317: $row_html .= '<td bgcolor="#DDCCFF">';
1318: $row_html .= &html_uneditable_cell(undef,'#CCCCFF');
1319: }
1320: $row_html .= '</td>';
1321: }
1322: $row_html.= "</tr>\n";
1323: $r->print($row_html);
1324: $r->print('</table>');
1325: ####################################
1326: # Prepare to output rows
1327: ####################################
1328: my @Rows = &sort_indicies($sheet);
1329: #
1330: # Loop through the rows and output them one at a time
1331: my $rows_output=0;
1332: foreach my $rownum (@Rows) {
1333: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1334: next if ($rowlabel =~ /^\s*$/);
1335: #
1336: my $defaultbg='#E0FF';
1337: #
1338: my $row_html ="\n".'<tr><td><b><font size=+1>'.$rownum.
1339: '</font></b></td>';
1340: #
1341: if ($sheet->{'sheettype'} eq 'classcalc') {
1342: $row_html.='<td>'.&format_html_rowlabel($rowlabel).'</td>';
1343: # Output links for each student?
1344: # Nope, that is already done for us in format_html_rowlabel (for now)
1345: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1346: $row_html.='<td>'.&format_html_rowlabel($rowlabel);
1347: $row_html.= '<br>'.
1348: '<select name="sel_'.$rownum.'" '.
1349: 'onChange="changesheet('.$rownum.')">'.
1350: '<option name="default">Default</option>';
1351: foreach (@{$sheet->{'othersheets'}}) {
1352: $row_html.='<option name="'.$_.'"';
1353: #if ($ufn eq $_) {
1354: # $row_html.=' selected';
1355: #}
1356: $row_html.='>'.$_.'</option>';
1357: }
1358: $row_html.='</select></td>';
1359: } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
1360: $row_html.='<td>'.&format_html_rowlabel($rowlabel).'</td>';
1361: }
1362: #
1363: my $shown_cells = 0;
1364: foreach my $cell (@rowdata) {
1365: my $value = $cell->{'value'};
1366: my $formula = $cell->{'formula'};
1367: my $cellname = $cell->{'name'};
1368: #
1369: my $bgcolor;
1370: if ($shown_cells && ($shown_cells/5 == int($shown_cells/5))) {
1371: $bgcolor = $defaultbg.'99';
1372: } else {
1373: $bgcolor = $defaultbg.'DD';
1374: }
1375: $bgcolor='#FFDDDD' if ($shown_cells < $num_uneditable);
1376: #
1377: $row_html.='<td bgcolor='.$bgcolor.'>';
1378: if ($shown_cells < $num_uneditable) {
1379: $row_html .= &html_uneditable_cell($cell,$bgcolor);
1380: } else {
1381: $row_html .= &html_editable_cell($cell,$bgcolor);
1382: }
1383: $row_html.='</td>';
1384: $shown_cells++;
1385: }
1386: if ($row_html) {
1387: if ($rows_output % 25 == 0) {
1388: $r->print("</table>\n<br>\n");
1389: $r->rflush();
1390: $r->print('<table border=2>'.
1391: '<tr><td> <td>'.$row_type.'</td>'.
1392: '<td>'.
1393: join('</td><td>',
1394: (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
1395: 'abcdefghijklmnopqrstuvwxyz'))).
1396: "</td></tr>\n");
1397: }
1398: $rows_output++;
1399: $r->print($row_html);
1400: }
1401: }
1402: #
1403: $r->print('</table>');
1404: #
1405: # Debugging code (be sure to uncomment errorlog code in safe space):
1406: #
1407: # $r->print("\n<pre>");
1408: # $r->print(&geterrorlog($sheet));
1409: # $r->print("\n</pre>");
1410: return 1;
1411: }
1412:
1413: ############################################
1414: ## csv output routines ##
1415: ############################################
1416: sub outsheet_csv {
1417: my ($sheet,$r) = @_;
1418: my $csvdata = '';
1419: my @Values;
1420: ####################################
1421: # Prepare to output rows
1422: ####################################
1423: my @Rows = &sort_indicies($sheet);
1424: #
1425: # Loop through the rows and output them one at a time
1426: my $rows_output=0;
1427: foreach my $rownum (@Rows) {
1428: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1429: next if ($rowlabel =~ /^\s*$/);
1430: push (@Values,&format_csv_rowlabel($rowlabel));
1431: foreach my $cell (@rowdata) {
1432: push (@Values,'"'.$cell->{'value'}.'"');
1433: }
1434: $csvdata.= join(',',@Values)."\n";
1435: @Values = ();
1436: }
1437: #
1438: # Write the CSV data to a file and serve up a link
1439: #
1440: my $filename = '/prtspool/'.
1441: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
1442: time.'_'.rand(1000000000).'.csv';
1443: my $file;
1444: unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
1445: $r->log_error("Couldn't open $filename for output $!");
1446: $r->print("Problems occured in writing the csv file. ".
1447: "This error has been logged. ".
1448: "Please alert your LON-CAPA administrator.");
1449: $r->print("<pre>\n".$csvdata."</pre>\n");
1450: return 0;
1451: }
1452: print $file $csvdata;
1453: close($file);
1454: $r->print('<br /><br />'.
1455: '<a href="'.$filename.'">Your CSV spreadsheet.</a>'."\n");
1456: #
1457: return 1;
1458: }
1459:
1460: ############################################
1461: ## Excel output routines ##
1462: ############################################
1463: sub outsheet_recursive_excel {
1464: my ($sheet,$r) = @_;
1465: my $c = $r->connection;
1466: return undef if ($sheet->{'sheettype'} ne 'classcalc');
1467: my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r);
1468: return undef if (! defined($workbook));
1469: #
1470: # Create main worksheet
1471: my $main_worksheet = $workbook->addworksheet('main');
1472: #
1473: # Figure out who the students are
1474: my %f=&getformulas($sheet);
1475: my $count = 0;
1476: $r->print(<<END);
1477: <p>
1478: Compiling Excel Workbook with a worksheet for each student.
1479: </p><p>
1480: This operation may take longer than a complete recalculation of the
1481: spreadsheet.
1482: </p><p>
1483: To abort this operation, hit the stop button on your browser.
1484: </p><p>
1485: A link to the spreadsheet will be available at the end of this process.
1486: </p>
1487: <p>
1488: END
1489: $r->rflush();
1490: my $starttime = time;
1491: foreach (keys(%f)) {
1492: next if ($_!~/^A(\d+)/ || $1 == 0 || ($f{$_}=~/^[!~-]/));
1493: $count++;
1494: my ($sname,$sdom) = split(':',$f{$_});
1495: my $student_excel_worksheet=$workbook->addworksheet($sname.'@'.$sdom);
1496: # Create a new spreadsheet
1497: my $studentsheet = &makenewsheet($sname,$sdom,'studentcalc',undef);
1498: # Read in the spreadsheet definition
1499: &update_student_sheet($studentsheet,$c);
1500: # Stuff the sheet into excel
1501: &export_sheet_as_excel($studentsheet,$student_excel_worksheet);
1502: my $totaltime = int((time - $starttime) / $count * $sheet->{'maxrow'});
1503: my $timeleft = int((time - $starttime) / $count * ($sheet->{'maxrow'} - $count));
1504: if ($count % 5 == 0) {
1505: $r->print($count.' students completed.'.
1506: ' Time remaining: '.$timeleft.' sec. '.
1507: ' Estimated total time: '.$totaltime." sec <br />\n");
1508: $r->rflush();
1509: }
1510: if(defined($c) && ($c->aborted())) {
1511: last;
1512: }
1513: }
1514: #
1515: if(! $c->aborted() ) {
1516: $r->print('All students spreadsheets completed!<br />');
1517: $r->rflush();
1518: #
1519: # &export_sheet_as_excel fills $worksheet with the data from $sheet
1520: &export_sheet_as_excel($sheet,$main_worksheet);
1521: #
1522: $workbook->close();
1523: # Okay, the spreadsheet is taken care of, so give the user a link.
1524: $r->print('<br /><br />'.
1525: '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
1526: } else {
1527: $workbook->close(); # Not sure how necessary this is.
1528: #unlink('/home/httpd'.$filename); # No need to keep this around?
1529: }
1530: return 1;
1531: }
1532:
1533: sub outsheet_excel {
1534: my ($sheet,$r) = @_;
1535: my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r);
1536: return undef if (! defined($workbook));
1537: my $sheetname;
1538: if ($sheet->{'sheettype'} eq 'classcalc') {
1539: $sheetname = 'Main';
1540: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1541: $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'};
1542: } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
1543: $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'}.' assessment';
1544: }
1545: my $worksheet = $workbook->addworksheet($sheetname);
1546: #
1547: # &export_sheet_as_excel fills $worksheet with the data from $sheet
1548: &export_sheet_as_excel($sheet,$worksheet);
1549: #
1550: $workbook->close();
1551: # Okay, the spreadsheet is taken care of, so give the user a link.
1552: $r->print('<br /><br />'.
1553: '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
1554: return 1;
1555: }
1556:
1557: sub create_excel_spreadsheet {
1558: my ($sheet,$r) = @_;
1559: my $filename = '/prtspool/'.
1560: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
1561: time.'_'.rand(1000000000).'.xls';
1562: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1563: if (! defined($workbook)) {
1564: $r->log_error("Error creating excel spreadsheet $filename: $!");
1565: $r->print("Problems creating new Excel file. ".
1566: "This error has been logged. ".
1567: "Please alert your LON-CAPA administrator");
1568: return undef;
1569: }
1570: #
1571: # The spreadsheet stores temporary data in files, then put them
1572: # together. If needed we should be able to disable this (memory only).
1573: # The temporary directory must be specified before calling 'addworksheet'.
1574: # File::Temp is used to determine the temporary directory.
1575: $workbook->set_tempdir('/home/httpd/perl/tmp');
1576: #
1577: # Determine the name to give the worksheet
1578: return ($workbook,$filename);
1579: }
1580:
1581: sub export_sheet_as_excel {
1582: my $sheet = shift;
1583: my $worksheet = shift;
1584: #
1585: my $rows_output = 0;
1586: my $cols_output = 0;
1587: ####################################
1588: # Write an identifying row #
1589: ####################################
1590: my @Headerinfo = ($sheet->{'coursedesc'});
1591: my $title = &gettitle($sheet);
1592: $cols_output = 0;
1593: if (defined($title)) {
1594: $worksheet->write($rows_output++,$cols_output++,$title);
1595: }
1596: ####################################
1597: # Write the summary/export row #
1598: ####################################
1599: my ($rowlabel,@rowdata) = &get_row($sheet,'0');
1600: my $label = &format_excel_rowlabel($rowlabel);
1601: $cols_output = 0;
1602: $worksheet->write($rows_output,$cols_output++,$label);
1603: foreach my $cell (@rowdata) {
1604: $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
1605: }
1606: $rows_output+= 2; # Skip a row, just for fun
1607: ####################################
1608: # Prepare to output rows
1609: ####################################
1610: my @Rows = &sort_indicies($sheet);
1611: #
1612: # Loop through the rows and output them one at a time
1613: foreach my $rownum (@Rows) {
1614: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1615: next if ($rowlabel =~ /^\s*$/);
1616: $cols_output = 0;
1617: my $label = &format_excel_rowlabel($rowlabel);
1618: $worksheet->write($rows_output,$cols_output++,$label);
1619: if (ref($label)) {
1620: $cols_output = (scalar(@$label));
1621: }
1622: foreach my $cell (@rowdata) {
1623: $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
1624: }
1625: $rows_output++;
1626: }
1627: return;
1628: }
1629:
1630: ############################################
1631: ## XML output routines ##
1632: ############################################
1633: sub outsheet_xml {
1634: my ($sheet,$r) = @_;
1635: ## Someday XML
1636: ## Will be rendered for the user
1637: ## But not on this day
1638: }
1639:
1640: ##
1641: ## Outsheet - calls other outsheet_* functions
1642: ##
1643: sub outsheet {
1644: my ($r,$sheet)=@_;
1645: if (! exists($ENV{'form.output'})) {
1646: $ENV{'form.output'} = 'HTML';
1647: }
1648: if (lc($ENV{'form.output'}) eq 'csv') {
1649: &outsheet_csv($sheet,$r);
1650: } elsif (lc($ENV{'form.output'}) eq 'excel') {
1651: &outsheet_excel($sheet,$r);
1652: } elsif (lc($ENV{'form.output'}) eq 'recursive excel') {
1653: &outsheet_recursive_excel($sheet,$r);
1654: # } elsif (lc($ENV{'form.output'}) eq 'xml' ) {
1655: # &outsheet_xml($sheet,$r);
1656: } else {
1657: &outsheet_html($sheet,$r);
1658: }
1659: }
1660:
1661: ########################################################################
1662: ########################################################################
1663: sub othersheets {
1664: my ($sheet,$stype)=@_;
1665: $stype = $sheet->{'sheettype'} if (! defined($stype));
1666: #
1667: my $cnum = $sheet->{'cnum'};
1668: my $cdom = $sheet->{'cdom'};
1669: my $chome = $sheet->{'chome'};
1670: #
1671: my @alternatives=();
1672: my %results=&Apache::lonnet::dump($stype.'_spreadsheets',$cdom,$cnum);
1673: my ($tmp) = keys(%results);
1674: unless ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1675: @alternatives = sort (keys(%results));
1676: }
1677: return @alternatives;
1678: }
1679:
1680: #
1681: # -------------------------------------- Parse a spreadsheet
1682: #
1683: sub parse_sheet {
1684: # $sheetxml is a scalar reference or a scalar
1685: my ($sheetxml) = @_;
1686: if (! ref($sheetxml)) {
1687: my $tmp = $sheetxml;
1688: $sheetxml = \$tmp;
1689: }
1690: my %f;
1691: my $parser=HTML::TokeParser->new($sheetxml);
1692: my $token;
1693: while ($token=$parser->get_token) {
1694: if ($token->[0] eq 'S') {
1695: if ($token->[1] eq 'field') {
1696: $f{$token->[2]->{'col'}.$token->[2]->{'row'}}=
1697: $parser->get_text('/field');
1698: }
1699: if ($token->[1] eq 'template') {
1700: $f{'template_'.$token->[2]->{'col'}}=
1701: $parser->get_text('/template');
1702: }
1703: }
1704: }
1705: return \%f;
1706: }
1707:
1708: #
1709: # -------------------------------------- Read spreadsheet formulas for a course
1710: #
1711: sub readsheet {
1712: my ($sheet,$fn)=@_;
1713: #
1714: my $stype = $sheet->{'sheettype'};
1715: my $cnum = $sheet->{'cnum'};
1716: my $cdom = $sheet->{'cdom'};
1717: my $chome = $sheet->{'chome'};
1718: #
1719: if (! defined($fn)) {
1720: # There is no filename. Look for defaults in course and global, cache
1721: unless ($fn=$defaultsheets{$cnum.'_'.$cdom.'_'.$stype}) {
1722: my %tmphash = &Apache::lonnet::get('environment',
1723: ['spreadsheet_default_'.$stype],
1724: $cdom,$cnum);
1725: my ($tmp) = keys(%tmphash);
1726: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1727: $fn = 'default_'.$stype;
1728: } else {
1729: $fn = $tmphash{'spreadsheet_default_'.$stype};
1730: }
1731: unless (($fn) && ($fn!~/^error\:/)) {
1732: $fn='default_'.$stype;
1733: }
1734: $defaultsheets{$cnum.'_'.$cdom.'_'.$stype}=$fn;
1735: }
1736: }
1737: # $fn now has a value
1738: $sheet->{'filename'} = $fn;
1739: # see if sheet is cached
1740: my $fstring='';
1741: if ($fstring=$spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}) {
1742: my %tmp = split(/___;___/,$fstring);
1743: $sheet->{'f'} = \%tmp;
1744: &setformulas($sheet);
1745: } else {
1746: # Not cached, need to read
1747: my %f=();
1748: if ($fn=~/^default\_/) {
1749: my $sheetxml='';
1750: my $fh;
1751: my $dfn=$fn;
1752: $dfn=~s/\_/\./g;
1753: if ($fh=Apache::File->new($includedir.'/'.$dfn)) {
1754: $sheetxml=join('',<$fh>);
1755: } else {
1756: $sheetxml='<field row="0" col="A">"Error"</field>';
1757: }
1758: %f=%{&parse_sheet(\$sheetxml)};
1759: } elsif($fn=~/\/*\.spreadsheet$/) {
1760: my $sheetxml=&Apache::lonnet::getfile
1761: (&Apache::lonnet::filelocation('',$fn));
1762: if ($sheetxml == -1) {
1763: $sheetxml='<field row="0" col="A">"Error loading spreadsheet '
1764: .$fn.'"</field>';
1765: }
1766: %f=%{&parse_sheet(\$sheetxml)};
1767: } else {
1768: my $sheet='';
1769: my %tmphash = &Apache::lonnet::dump($fn,$cdom,$cnum);
1770: my ($tmp) = keys(%tmphash);
1771: unless ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1772: foreach (keys(%tmphash)) {
1773: $f{$_}=$tmphash{$_};
1774: }
1775: }
1776: }
1777: # Cache and set
1778: $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
1779: $sheet->{'f'}=\%f;
1780: &setformulas($sheet);
1781: }
1782: }
1783:
1784: # -------------------------------------------------------- Make new spreadsheet
1785: sub makenewsheet {
1786: my ($uname,$udom,$stype,$usymb)=@_;
1787: my $sheet={};
1788: $sheet->{'uname'} = $uname;
1789: $sheet->{'udom'} = $udom;
1790: $sheet->{'sheettype'} = $stype;
1791: $sheet->{'usymb'} = $usymb;
1792: $sheet->{'mapid'} = $ENV{'form.mapid'};
1793: $sheet->{'resid'} = $ENV{'form.resid'};
1794: $sheet->{'cid'} = $ENV{'request.course.id'};
1795: $sheet->{'csec'} = $Section{$uname.':'.$udom};
1796: $sheet->{'coursefilename'} = $ENV{'request.course.fn'};
1797: $sheet->{'cnum'} = $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1798: $sheet->{'cdom'} = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1799: $sheet->{'chome'} = $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1800: $sheet->{'coursedesc'} = $ENV{'course.'.$ENV{'request.course.id'}.
1801: '.description'};
1802: $sheet->{'uhome'} = &Apache::lonnet::homeserver($uname,$udom);
1803: #
1804: #
1805: $sheet->{'f'} = {};
1806: $sheet->{'constants'} = {};
1807: $sheet->{'othersheets'} = [];
1808: $sheet->{'rowlabel'} = {};
1809: #
1810: #
1811: $sheet->{'safe'}=&initsheet($sheet->{'sheettype'});
1812: #
1813: # Place all the %$sheet items into the safe space except the safe space
1814: # itself
1815: my $initstring = '';
1816: foreach (qw/uname udom sheettype usymb cid csec coursefilename
1817: cnum cdom chome uhome/) {
1818: $initstring.= qq{\$$_="$sheet->{$_}";};
1819: }
1820: $sheet->{'safe'}->reval($initstring);
1821: return $sheet;
1822: }
1823:
1824: # ------------------------------------------------------------ Save spreadsheet
1825: sub writesheet {
1826: my ($sheet,$makedef)=@_;
1827: my $cid=$sheet->{'cid'};
1828: if (&Apache::lonnet::allowed('opa',$cid)) {
1829: my %f=&getformulas($sheet);
1830: my $stype= $sheet->{'sheettype'};
1831: my $cnum = $sheet->{'cnum'};
1832: my $cdom = $sheet->{'cdom'};
1833: my $chome= $sheet->{'chome'};
1834: my $fn = $sheet->{'filename'};
1835: # Cache new sheet
1836: $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
1837: # Write sheet
1838: foreach (keys(%f)) {
1839: delete($f{$_}) if ($f{$_} eq 'import');
1840: }
1841: my $reply = &Apache::lonnet::put($fn,\%f,$cdom,$cnum);
1842: if ($reply eq 'ok') {
1843: $reply = &Apache::lonnet::put($stype.'_spreadsheets',
1844: {$fn => $ENV{'user.name'}.'@'.$ENV{'user.domain'}},
1845: $cdom,$cnum);
1846: if ($reply eq 'ok') {
1847: if ($makedef) {
1848: return &Apache::lonnet::put('environment',
1849: {'spreadsheet_default_'.$stype => $fn },
1850: $cdom,$cnum);
1851: }
1852: return $reply;
1853: }
1854: return $reply;
1855: }
1856: return $reply;
1857: }
1858: return 'unauthorized';
1859: }
1860:
1861: # ----------------------------------------------- Make a temp copy of the sheet
1862: # "Modified workcopy" - interactive only
1863: #
1864: sub tmpwrite {
1865: my ($sheet) = @_;
1866: my $fn=$ENV{'user.name'}.'_'.
1867: $ENV{'user.domain'}.'_spreadsheet_'.$sheet->{'usymb'}.'_'.
1868: $sheet->{'filename'};
1869: $fn=~s/\W/\_/g;
1870: $fn=$tmpdir.$fn.'.tmp';
1871: my $fh;
1872: if ($fh=Apache::File->new('>'.$fn)) {
1873: print $fh join("\n",&getformulas($sheet));
1874: }
1875: }
1876:
1877: # ---------------------------------------------------------- Read the temp copy
1878: sub tmpread {
1879: my ($sheet,$nfield,$nform)=@_;
1880: my $fn=$ENV{'user.name'}.'_'.
1881: $ENV{'user.domain'}.'_spreadsheet_'.$sheet->{'usymb'}.'_'.
1882: $sheet->{'filename'};
1883: $fn=~s/\W/\_/g;
1884: $fn=$tmpdir.$fn.'.tmp';
1885: my $fh;
1886: my %fo=();
1887: my $countrows=0;
1888: if ($fh=Apache::File->new($fn)) {
1889: my $name;
1890: while ($name=<$fh>) {
1891: chomp($name);
1892: my $value=<$fh>;
1893: chomp($value);
1894: $fo{$name}=$value;
1895: if ($name=~/^A(\d+)$/) {
1896: if ($1>$countrows) {
1897: $countrows=$1;
1898: }
1899: }
1900: }
1901: }
1902: if ($nform eq 'changesheet') {
1903: $fo{'A'.$nfield}=(split(/__&&&\__/,$fo{'A'.$nfield}))[0];
1904: unless ($ENV{'form.sel_'.$nfield} eq 'Default') {
1905: $fo{'A'.$nfield}.='__&&&__'.$ENV{'form.sel_'.$nfield};
1906: }
1907: } elsif ($nfield eq 'insertrow') {
1908: $countrows++;
1909: my $newrow=substr('000000'.$countrows,-7);
1910: if ($nform eq 'top') {
1911: $fo{'A'.$countrows}='--- '.$newrow;
1912: } else {
1913: $fo{'A'.$countrows}='~~~ '.$newrow;
1914: }
1915: } else {
1916: if ($nfield) { $fo{$nfield}=$nform; }
1917: }
1918: $sheet->{'f'}=\%fo;
1919: &setformulas($sheet);
1920: }
1921:
1922: ##################################################
1923: ##################################################
1924:
1925: =pod
1926:
1927: =item &parmval()
1928:
1929: Determine the value of a parameter.
1930:
1931: Inputs: $what, the parameter needed, $sheet, the safe space
1932:
1933: Returns: The value of a parameter, or '' if none.
1934:
1935: This function cascades through the possible levels searching for a value for
1936: a parameter. The levels are checked in the following order:
1937: user, course (at section level and course level), map, and lonnet::metadata.
1938: This function uses %parmhash, which must be tied prior to calling it.
1939: This function also requires %courseopt and %useropt to be initialized for
1940: this user and course.
1941:
1942: =cut
1943:
1944: ##################################################
1945: ##################################################
1946: sub parmval {
1947: my ($what,$sheet)=@_;
1948: my $symb = $sheet->{'usymb'};
1949: unless ($symb) { return ''; }
1950: #
1951: my $cid = $sheet->{'cid'};
1952: my $csec = $sheet->{'csec'};
1953: my $uname = $sheet->{'uname'};
1954: my $udom = $sheet->{'udom'};
1955: my $result='';
1956: #
1957: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1958: # Cascading lookup scheme
1959: my $rwhat=$what;
1960: $what =~ s/^parameter\_//;
1961: $what =~ s/\_([^\_]+)$/\.$1/;
1962: #
1963: my $symbparm = $symb.'.'.$what;
1964: my $mapparm = $mapname.'___(all).'.$what;
1965: my $usercourseprefix = $uname.'_'.$udom.'_'.$cid;
1966: #
1967: my $seclevel = $usercourseprefix.'.['.$csec.'].'.$what;
1968: my $seclevelr = $usercourseprefix.'.['.$csec.'].'.$symbparm;
1969: my $seclevelm = $usercourseprefix.'.['.$csec.'].'.$mapparm;
1970: #
1971: my $courselevel = $usercourseprefix.'.'.$what;
1972: my $courselevelr = $usercourseprefix.'.'.$symbparm;
1973: my $courselevelm = $usercourseprefix.'.'.$mapparm;
1974: # fourth, check user
1975: if (defined($uname)) {
1976: return $useropt{$courselevelr} if (defined($useropt{$courselevelr}));
1977: return $useropt{$courselevelm} if (defined($useropt{$courselevelm}));
1978: return $useropt{$courselevel} if (defined($useropt{$courselevel}));
1979: }
1980: # third, check course
1981: if (defined($csec)) {
1982: return $courseopt{$seclevelr} if (defined($courseopt{$seclevelr}));
1983: return $courseopt{$seclevelm} if (defined($courseopt{$seclevelm}));
1984: return $courseopt{$seclevel} if (defined($courseopt{$seclevel}));
1985: }
1986: #
1987: return $courseopt{$courselevelr} if (defined($courseopt{$courselevelr}));
1988: return $courseopt{$courselevelm} if (defined($courseopt{$courselevelm}));
1989: return $courseopt{$courselevel} if (defined($courseopt{$courselevel}));
1990: # second, check map parms
1991: my $thisparm = $parmhash{$symbparm};
1992: return $thisparm if (defined($thisparm));
1993: # first, check default
1994: return &Apache::lonnet::metadata($fn,$rwhat.'.default');
1995: }
1996:
1997:
1998: ##################################################################
1999: ## Row label formatting routines ##
2000: ##################################################################
2001: sub format_html_rowlabel {
2002: my $rowlabel = shift;
2003: return '' if ($rowlabel eq '');
2004: my ($type,$labeldata) = split(':',$rowlabel,2);
2005: my $result = '';
2006: if ($type eq 'symb') {
2007: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2008: $symb = &Apache::lonnet::unescape($symb);
2009: $result = '<a href="/adm/assesscalc?usymb='.$symb.
2010: '&uname='.$uname.'&udom='.$udom.
2011: '&mapid='.$mapid.'&resid='.$resid.'">'.$title.'</a>';
2012: } elsif ($type eq 'student') {
2013: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2014: $result ='<a href="/adm/studentcalc?uname='.$sname.
2015: '&udom='.$sdom.'">';
2016: $result.=$section.' '.$id." ".$fullname.'</a>';
2017: } elsif ($type eq 'parameter') {
2018: $result = $labeldata;
2019: } else {
2020: $result = '<b><font size=+1>'.$rowlabel.'</font></b>';
2021: }
2022: return $result;
2023: }
2024:
2025: sub format_csv_rowlabel {
2026: my $rowlabel = shift;
2027: return '' if ($rowlabel eq '');
2028: my ($type,$labeldata) = split(':',$rowlabel,2);
2029: my $result = '';
2030: if ($type eq 'symb') {
2031: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2032: $symb = &Apache::lonnet::unescape($symb);
2033: $result = $title;
2034: } elsif ($type eq 'student') {
2035: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2036: $result = join('","',($sname,$sdom,$fullname,$section,$id));
2037: } elsif ($type eq 'parameter') {
2038: $labeldata =~ s/<br>/ /g;
2039: $result = $labeldata;
2040: } else {
2041: $result = $rowlabel;
2042: }
2043: return '"'.$result.'"';
2044: }
2045:
2046: sub format_excel_rowlabel {
2047: my $rowlabel = shift;
2048: return '' if ($rowlabel eq '');
2049: my ($type,$labeldata) = split(':',$rowlabel,2);
2050: my $result = '';
2051: if ($type eq 'symb') {
2052: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2053: $symb = &Apache::lonnet::unescape($symb);
2054: $result = $title;
2055: } elsif ($type eq 'student') {
2056: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2057: $section = '' if (! defined($section));
2058: $id = '' if (! defined($id));
2059: my @Data = ($sname,$sdom,$fullname,$section,$id);
2060: $result = \@Data;
2061: } elsif ($type eq 'parameter') {
2062: $labeldata =~ s/<br>/ /g;
2063: $result = $labeldata;
2064: } else {
2065: $result = $rowlabel;
2066: }
2067: return $result;
2068: }
2069:
2070: # ---------------------------------------------- Update rows for course listing
2071: sub updateclasssheet {
2072: my ($sheet) = @_;
2073: my $cnum =$sheet->{'cnum'};
2074: my $cdom =$sheet->{'cdom'};
2075: my $cid =$sheet->{'cid'};
2076: my $chome =$sheet->{'chome'};
2077: #
2078: %Section = ();
2079: #
2080: # Read class list and row labels
2081: my $classlist = &Apache::loncoursedata::get_classlist();
2082: if (! defined($classlist)) {
2083: return 'Could not access course classlist';
2084: }
2085: #
2086: my %currentlist=();
2087: foreach my $student (keys(%$classlist)) {
2088: my ($studentDomain,$studentName,$end,$start,$id,$studentSection,
2089: $fullname,$status) = @{$classlist->{$student}};
2090: $Section{$studentName.':'.$studentDomain} = $studentSection;
2091: if ($ENV{'form.Status'} eq $status || $ENV{'form.Status'} eq 'Any') {
2092: $currentlist{$student}=join(':',('student',$studentName,
2093: $studentDomain,$fullname,
2094: $studentSection,$id));
2095: }
2096: }
2097: #
2098: # Find discrepancies between the course row table and this
2099: #
2100: my %f=&getformulas($sheet);
2101: my $changed=0;
2102: #
2103: $sheet->{'maxrow'}=0;
2104: my %existing=();
2105: #
2106: # Now obsolete rows
2107: foreach (keys(%f)) {
2108: if ($_=~/^A(\d+)/) {
2109: if ($1 > $sheet->{'maxrow'}) {
2110: $sheet->{'maxrow'}= $1;
2111: }
2112: $existing{$f{$_}}=1;
2113: unless ((defined($currentlist{$f{$_}})) || (!$1) ||
2114: ($f{$_}=~/^(~~~|---)/)) {
2115: $f{$_}='!!! Obsolete';
2116: $changed=1;
2117: }
2118: }
2119: }
2120: #
2121: # New and unknown keys
2122: foreach my $student (sort keys(%currentlist)) {
2123: unless ($existing{$student}) {
2124: $changed=1;
2125: $sheet->{'maxrow'}++;
2126: $f{'A'.$sheet->{'maxrow'}}=$student;
2127: }
2128: }
2129: if ($changed) {
2130: $sheet->{'f'} = \%f;
2131: &setformulas($sheet,%f);
2132: }
2133: #
2134: &setrowlabels($sheet,\%currentlist);
2135: }
2136:
2137: # ----------------------------------- Update rows for student and assess sheets
2138: sub get_student_rowlabels {
2139: my ($sheet) = @_;
2140: #
2141: my %course_db;
2142: #
2143: my $stype = $sheet->{'sheettype'};
2144: my $uname = $sheet->{'uname'};
2145: my $udom = $sheet->{'udom'};
2146: #
2147: $sheet->{'rowlabel'} = {};
2148: #
2149: my $identifier =$sheet->{'coursefilename'}.'_'.$stype;
2150: if ($rowlabel_cache{$identifier}) {
2151: %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier});
2152: } else {
2153: # Get the data and store it in the cache
2154: # Tie hash
2155: tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db',
2156: &GDBM_READER(),0640);
2157: if (! tied(%course_db)) {
2158: return 'Could not access course data';
2159: }
2160: #
2161: my %assesslist;
2162: foreach ('Feedback','Evaluation','Tutoring','Discussion') {
2163: my $symb = '_'.lc($_);
2164: $assesslist{$symb} = join(':',('symb',$symb,$uname,$udom,0,0,$_));
2165: }
2166: #
2167: while (my ($key,$srcf) = each(%course_db)) {
2168: next if ($key !~ /^src_(\d+)\.(\d+)$/);
2169: my $mapid = $1;
2170: my $resid = $2;
2171: my $id = $mapid.'.'.$resid;
2172: if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {
2173: my $symb=
2174: &Apache::lonnet::declutter($course_db{'map_id_'.$mapid}).
2175: '___'.$resid.'___'.&Apache::lonnet::declutter($srcf);
2176: $assesslist{$symb}='symb:'.&Apache::lonnet::escape($symb).':'
2177: .$uname.':'.$udom.':'.$mapid.':'.$resid.':'.
2178: $course_db{'title_'.$id};
2179: }
2180: }
2181: untie(%course_db);
2182: # Store away the data
2183: $sheet->{'rowlabel'} = \%assesslist;
2184: $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}});
2185: }
2186:
2187: }
2188:
2189: sub get_assess_rowlabels {
2190: my ($sheet) = @_;
2191: #
2192: my %course_db;
2193: #
2194: my $stype = $sheet->{'sheettype'};
2195: my $uname = $sheet->{'uname'};
2196: my $udom = $sheet->{'udom'};
2197: my $usymb = $sheet->{'usymb'};
2198: #
2199: $sheet->{'rowlabel'} = {};
2200: my $identifier =$sheet->{'coursefilename'}.'_'.$stype.'_'.$usymb;
2201: #
2202: if ($rowlabel_cache{$identifier}) {
2203: %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier});
2204: } else {
2205: # Get the data and store it in the cache
2206: # Tie hash
2207: tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db',
2208: &GDBM_READER(),0640);
2209: if (! tied(%course_db)) {
2210: return 'Could not access course data';
2211: }
2212: #
2213: my %parameter_labels=
2214: ('timestamp' =>
2215: 'parameter:Timestamp of Last Transaction<br>timestamp',
2216: 'subnumber' =>
2217: 'parameter:Number of Submissions<br>subnumber',
2218: 'tutornumber' =>
2219: 'parameter:Number of Tutor Responses<br>tutornumber',
2220: 'totalpoints' =>
2221: 'parameter:Total Points Granted<br>totalpoints');
2222: while (my ($key,$srcf) = each(%course_db)) {
2223: next if ($key !~ /^src_(\d+)\.(\d+)$/);
2224: my $mapid = $1;
2225: my $resid = $2;
2226: my $id = $mapid.'.'.$resid;
2227: if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {
2228: # Loop through the metadata for this key
2229: my @Metadata = split(/,/,
2230: &Apache::lonnet::metadata($srcf,'keys'));
2231: foreach my $key (@Metadata) {
2232: next if ($key !~ /^(stores|parameter)_/);
2233: my $display=
2234: &Apache::lonnet::metadata($srcf,$key.'.display');
2235: unless ($display) {
2236: $display.=
2237: &Apache::lonnet::metadata($srcf,$key.'.name');
2238: }
2239: $display.='<br>'.$key;
2240: $parameter_labels{$key}='parameter:'.$display;
2241: } # end of foreach
2242: }
2243: }
2244: untie(%course_db);
2245: # Store away the results
2246: $sheet->{'rowlabel'} = \%parameter_labels;
2247: $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}});
2248: }
2249:
2250: }
2251:
2252: sub updatestudentassesssheet {
2253: my $sheet = shift;
2254: if ($sheet->{'sheettype'} eq 'studentcalc') {
2255: &get_student_rowlabels($sheet);
2256: } else {
2257: &get_assess_rowlabels($sheet);
2258: }
2259: # Determine if any of the information has changed
2260: my %f=&getformulas($sheet);
2261: my $changed=0;
2262:
2263: $sheet->{'maxrow'} = 0;
2264: my %existing=();
2265: # Now obsolete rows
2266: while (my ($cell, $formula) = each (%f)) {
2267: next if ($cell !~ /^A(\d+)/);
2268: $sheet->{'maxrow'} = $1 if ($1 > $sheet->{'maxrow'});
2269: my ($usy,$ufn)=split(/__&&&\__/,$formula);
2270: $existing{$usy}=1;
2271: unless ((exists($sheet->{'rowlabel'}->{$usy}) &&
2272: (defined($sheet->{'rowlabel'}->{$usy})) || (!$1) ||
2273: ($formula =~ /^(~~~|---)/) )) {
2274: $f{$_}='!!! Obsolete';
2275: $changed=1;
2276: } elsif ($ufn) {
2277: # I do not think this works any more
2278: $sheet->{'rowlabel'}->{$usy}
2279: =~s/assesscalc\?usymb\=/assesscalc\?ufn\=$ufn&\usymb\=/;
2280: }
2281: }
2282: # New and unknown keys
2283: foreach (keys(%{$sheet->{'rowlabel'}})) {
2284: unless ($existing{$_}) {
2285: $changed=1;
2286: $sheet->{'maxrow'}++;
2287: $f{'A'.$sheet->{'maxrow'}}=$_;
2288: }
2289: }
2290: if ($changed) {
2291: $sheet->{'f'} = \%f;
2292: &setformulas($sheet);
2293: }
2294: }
2295:
2296: # ------------------------------------------------ Load data for one assessment
2297:
2298: sub loadstudent{
2299: my ($sheet,$r,$c)=@_;
2300: my %constants=();
2301: my %formulas=&getformulas($sheet);
2302: $cachedassess=$sheet->{'uname'}.':'.$sheet->{'udom'};
2303: # Get ALL the student preformance data
2304: my @tmp = &Apache::lonnet::dump($sheet->{'cid'},
2305: $sheet->{'udom'},
2306: $sheet->{'uname'},
2307: undef);
2308: if ($tmp[0] !~ /^error:/) {
2309: %cachedstores = @tmp;
2310: }
2311: undef @tmp;
2312: #
2313: my @assessdata=();
2314: while (my ($cell,$value) = each (%formulas)) {
2315: if(defined($c) && ($c->aborted())) {
2316: last;
2317: }
2318: next if ($cell !~ /^A(\d+)/);
2319: my $row=$1;
2320: next if (($value =~ /^[!~-]/) || ($row==0));
2321: my ($usy,$ufn)=split(/__&&&\__/,$value);
2322: @assessdata=&exportsheet($sheet,$sheet->{'uname'},
2323: $sheet->{'udom'},
2324: 'assesscalc',$usy,$ufn,$r);
2325: my $index=0;
2326: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
2327: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') {
2328: if (defined($assessdata[$index])) {
2329: my $col=$_;
2330: if ($assessdata[$index]=~/\D/) {
2331: $constants{$col.$row}="'".$assessdata[$index]."'";
2332: } else {
2333: $constants{$col.$row}=$assessdata[$index];
2334: }
2335: unless ($col eq 'A') {
2336: $formulas{$col.$row}='import';
2337: }
2338: }
2339: $index++;
2340: }
2341: }
2342: $cachedassess='';
2343: undef %cachedstores;
2344: $sheet->{'f'} = \%formulas;
2345: &setformulas($sheet);
2346: &setconstants($sheet,\%constants);
2347: }
2348:
2349: # --------------------------------------------------- Load data for one student
2350: #
2351: sub loadcourse {
2352: my ($sheet,$r,$c)=@_;
2353: #
2354: my %constants=();
2355: my %formulas=&getformulas($sheet);
2356: #
2357: my $total=0;
2358: foreach (keys(%formulas)) {
2359: if ($_=~/^A(\d+)/) {
2360: unless ($formulas{$_}=~/^[\!\~\-]/) { $total++; }
2361: }
2362: }
2363: my $now=0;
2364: my $since=time;
2365: $r->print(<<ENDPOP);
2366: <script>
2367: popwin=open('','popwin','width=400,height=100');
2368: popwin.document.writeln('<html><body bgcolor="#FFFFFF">'+
2369: '<h3>Spreadsheet Calculation Progress</h3>'+
2370: '<form name=popremain>'+
2371: '<input type=text size=35 name=remaining value=Starting></form>'+
2372: '</body></html>');
2373: popwin.document.close();
2374: </script>
2375: ENDPOP
2376: $r->rflush();
2377: foreach (keys(%formulas)) {
2378: if(defined($c) && ($c->aborted())) {
2379: last;
2380: }
2381: next if ($_!~/^A(\d+)/);
2382: my $row=$1;
2383: next if (($formulas{$_}=~/^[\!\~\-]/) || ($row==0));
2384: my ($sname,$sdom) = split(':',$formulas{$_});
2385: my @studentdata=&exportsheet($sheet,$sname,$sdom,'studentcalc',
2386: undef,undef,$r);
2387: undef %userrdatas;
2388: $now++;
2389: $r->print('<script>popwin.document.popremain.remaining.value="'.
2390: $now.'/'.$total.': '.int((time-$since)/$now*($total-$now)).
2391: ' secs remaining";</script>');
2392: $r->rflush();
2393: #
2394: my $index=0;
2395: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
2396: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') {
2397: if (defined($studentdata[$index])) {
2398: my $col=$_;
2399: if ($studentdata[$index]=~/\D/) {
2400: $constants{$col.$row}="'".$studentdata[$index]."'";
2401: } else {
2402: $constants{$col.$row}=$studentdata[$index];
2403: }
2404: unless ($col eq 'A') {
2405: $formulas{$col.$row}='import';
2406: }
2407: }
2408: $index++;
2409: }
2410: }
2411: $sheet->{'f'}=\%formulas;
2412: &setformulas($sheet);
2413: &setconstants($sheet,\%constants);
2414: $r->print('<script>popwin.close()</script>');
2415: $r->rflush();
2416: }
2417:
2418: # ------------------------------------------------ Load data for one assessment
2419: #
2420: sub loadassessment {
2421: my ($sheet,$r,$c)=@_;
2422:
2423: my $uhome = $sheet->{'uhome'};
2424: my $uname = $sheet->{'uname'};
2425: my $udom = $sheet->{'udom'};
2426: my $symb = $sheet->{'usymb'};
2427: my $cid = $sheet->{'cid'};
2428: my $cnum = $sheet->{'cnum'};
2429: my $cdom = $sheet->{'cdom'};
2430: my $chome = $sheet->{'chome'};
2431:
2432: my $namespace;
2433: unless ($namespace=$cid) { return ''; }
2434: # Get stored values
2435: my %returnhash=();
2436: if ($cachedassess eq $uname.':'.$udom) {
2437: #
2438: # get data out of the dumped stores
2439: #
2440: my $version=$cachedstores{'version:'.$symb};
2441: my $scope;
2442: for ($scope=1;$scope<=$version;$scope++) {
2443: foreach (split(/\:/,$cachedstores{$scope.':keys:'.$symb})) {
2444: $returnhash{$_}=$cachedstores{$scope.':'.$symb.':'.$_};
2445: }
2446: }
2447: } else {
2448: #
2449: # restore individual
2450: #
2451: %returnhash = &Apache::lonnet::restore($symb,$namespace,$udom,$uname);
2452: for (my $version=1;$version<=$returnhash{'version'};$version++) {
2453: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2454: $returnhash{$_}=$returnhash{$version.':'.$_};
2455: }
2456: }
2457: }
2458: #
2459: # returnhash now has all stores for this resource
2460: # convert all "_" to "." to be able to use libraries, multiparts, etc
2461: #
2462: # This is dumb. It is also necessary :(
2463: my @oldkeys=keys %returnhash;
2464: #
2465: foreach my $name (@oldkeys) {
2466: my $value=$returnhash{$name};
2467: delete $returnhash{$name};
2468: $name=~s/\_/\./g;
2469: $returnhash{$name}=$value;
2470: }
2471: # initialize coursedata and userdata for this user
2472: undef %courseopt;
2473: undef %useropt;
2474:
2475: my $userprefix=$uname.'_'.$udom.'_';
2476:
2477: unless ($uhome eq 'no_host') {
2478: # Get coursedata
2479: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
2480: my %Tmp = &Apache::lonnet::dump('resourcedata',$cdom,$cnum);
2481: $courserdatas{$cid}=\%Tmp;
2482: $courserdatas{$cid.'.last_cache'}=time;
2483: }
2484: while (my ($name,$value) = each(%{$courserdatas{$cid}})) {
2485: $courseopt{$userprefix.$name}=$value;
2486: }
2487: # Get userdata (if present)
2488: unless ((time-$userrdatas{$uname.'@'.$udom.'.last_cache'})<240) {
2489: my %Tmp = &Apache::lonnet::dump('resourcedata',$udom,$uname);
2490: $userrdatas{$cid} = \%Tmp;
2491: # Most of the time the user does not have a 'resourcedata.db'
2492: # file. We need to cache that we got nothing instead of bothering
2493: # with requesting it every time.
2494: $userrdatas{$uname.'@'.$udom.'.last_cache'}=time;
2495: }
2496: while (my ($name,$value) = each(%{$userrdatas{$cid}})) {
2497: $useropt{$userprefix.$name}=$value;
2498: }
2499: }
2500: # now courseopt, useropt initialized for this user and course
2501: # (used by parmval)
2502: #
2503: # Load keys for this assessment only
2504: #
2505: my %thisassess=();
2506: my ($symap,$syid,$srcf)=split(/\_\_\_/,$symb);
2507: foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'keys'))) {
2508: $thisassess{$_}=1;
2509: }
2510: #
2511: # Load parameters
2512: #
2513: my %c=();
2514: if (tie(%parmhash,'GDBM_File',
2515: $sheet->{'coursefilename'}.'_parms.db',&GDBM_READER(),0640)) {
2516: my %f=&getformulas($sheet);
2517: foreach my $cell (keys(%f)) {
2518: next if ($cell !~ /^A/);
2519: next if ($f{$cell} =~/^[\!\~\-]/);
2520: if ($f{$cell}=~/^parameter/) {
2521: if (defined($thisassess{$f{$cell}})) {
2522: my $val = &parmval($f{$cell},$sheet);
2523: $c{$cell} = $val;
2524: $c{$f{$cell}} = $val;
2525: }
2526: } else {
2527: my $key=$f{$cell};
2528: my $ckey=$key;
2529: $key=~s/^stores\_/resource\./;
2530: $key=~s/\_/\./g;
2531: $c{$cell}=$returnhash{$key};
2532: $c{$ckey}=$returnhash{$key};
2533: }
2534: }
2535: untie(%parmhash);
2536: }
2537: &setconstants($sheet,\%c);
2538: }
2539:
2540: # --------------------------------------------------------- Various form fields
2541:
2542: sub textfield {
2543: my ($title,$name,$value)=@_;
2544: return "\n<p><b>$title:</b><br>".
2545: '<input type=text name="'.$name.'" size=80 value="'.$value.'">';
2546: }
2547:
2548: sub hiddenfield {
2549: my ($name,$value)=@_;
2550: return "\n".'<input type=hidden name="'.$name.'" value="'.$value.'">';
2551: }
2552:
2553: sub selectbox {
2554: my ($title,$name,$value,%options)=@_;
2555: my $selout="\n<p><b>$title:</b><br>".'<select name="'.$name.'">';
2556: foreach (sort keys(%options)) {
2557: $selout.='<option value="'.$_.'"';
2558: if ($_ eq $value) { $selout.=' selected'; }
2559: $selout.='>'.$options{$_}.'</option>';
2560: }
2561: return $selout.'</select>';
2562: }
2563:
2564: # =============================================== Update information in a sheet
2565: #
2566: # Add new users or assessments, etc.
2567: #
2568:
2569: sub updatesheet {
2570: my ($sheet)=@_;
2571: if ($sheet->{'sheettype'} eq 'classcalc') {
2572: return &updateclasssheet($sheet);
2573: } else {
2574: return &updatestudentassesssheet($sheet);
2575: }
2576: }
2577:
2578: # =================================================== Load the rows for a sheet
2579: #
2580: # Import the data for rows
2581: #
2582:
2583: sub loadrows {
2584: my ($sheet,$r)=@_;
2585: my $c = $r->connection;
2586: my $stype=$sheet->{'sheettype'};
2587: if ($stype eq 'classcalc') {
2588: &loadcourse($sheet,$r,$c);
2589: } elsif ($stype eq 'studentcalc') {
2590: &loadstudent($sheet,$r,$c);
2591: } else {
2592: &loadassessment($sheet,$r,$c);
2593: }
2594: }
2595:
2596: # ======================================================= Forced recalculation?
2597:
2598: sub checkthis {
2599: my ($keyname,$time)=@_;
2600: return ($time<$expiredates{$keyname});
2601: }
2602:
2603: sub forcedrecalc {
2604: my ($uname,$udom,$stype,$usymb)=@_;
2605: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2606: my $time=$oldsheets{$key.'.time'};
2607: if ($ENV{'form.forcerecalc'}) { return 1; }
2608: unless ($time) { return 1; }
2609: if ($stype eq 'assesscalc') {
2610: my $map=(split(/___/,$usymb))[0];
2611: if (&checkthis('::assesscalc:',$time) ||
2612: &checkthis('::assesscalc:'.$map,$time) ||
2613: &checkthis('::assesscalc:'.$usymb,$time) ||
2614: &checkthis($uname.':'.$udom.':assesscalc:',$time) ||
2615: &checkthis($uname.':'.$udom.':assesscalc:'.$map,$time) ||
2616: &checkthis($uname.':'.$udom.':assesscalc:'.$usymb,$time)) {
2617: return 1;
2618: }
2619: } else {
2620: if (&checkthis('::studentcalc:',$time) ||
2621: &checkthis($uname.':'.$udom.':studentcalc:',$time)) {
2622: return 1;
2623: }
2624: }
2625: return 0;
2626: }
2627:
2628: # ============================================================== Export handler
2629: # exportsheet
2630: # returns the export row for a spreadsheet.
2631: #
2632: sub exportsheet {
2633: my ($sheet,$uname,$udom,$stype,$usymb,$fn,$r)=@_;
2634: $uname = $uname || $sheet->{'uname'};
2635: $udom = $udom || $sheet->{'udom'};
2636: $stype = $stype || $sheet->{'sheettype'};
2637: my @exportarr=();
2638: if (defined($usymb) && ($usymb=~/^\_(\w+)/) &&
2639: (!defined($fn) || $fn eq '')) {
2640: $fn='default_'.$1;
2641: }
2642: #
2643: # Check if cached
2644: #
2645: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2646: my $found='';
2647: if ($oldsheets{$key}) {
2648: foreach (split(/___&\___/,$oldsheets{$key})) {
2649: my ($name,$value)=split(/___=___/,$_);
2650: if ($name eq $fn) {
2651: $found=$value;
2652: }
2653: }
2654: }
2655: unless ($found) {
2656: &cachedssheets($sheet,$uname,$udom);
2657: if ($oldsheets{$key}) {
2658: foreach (split(/___&\___/,$oldsheets{$key})) {
2659: my ($name,$value)=split(/___=___/,$_);
2660: if ($name eq $fn) {
2661: $found=$value;
2662: }
2663: }
2664: }
2665: }
2666: #
2667: # Check if still valid
2668: #
2669: if ($found) {
2670: if (&forcedrecalc($uname,$udom,$stype,$usymb)) {
2671: $found='';
2672: }
2673: }
2674: if ($found) {
2675: #
2676: # Return what was cached
2677: #
2678: @exportarr=split(/___;___/,$found);
2679: return @exportarr;
2680: }
2681: #
2682: # Not cached
2683: #
2684: my ($newsheet)=&makenewsheet($uname,$udom,$stype,$usymb);
2685: &readsheet($newsheet,$fn);
2686: &updatesheet($newsheet);
2687: &loadrows($newsheet,$r);
2688: &calcsheet($newsheet);
2689: @exportarr=&exportdata($newsheet);
2690: ##
2691: ## Store now
2692: ##
2693: #
2694: # load in the old value
2695: #
2696: my %currentlystored=();
2697: if ($stype eq 'studentcalc') {
2698: my @tmp = &Apache::lonnet::get('nohist_calculatedsheets',
2699: [$key],
2700: $sheet->{'cdom'},$sheet->{'cnum'});
2701: if ($tmp[0]!~/^error/) {
2702: %currentlystored = @tmp;
2703: }
2704: } else {
2705: my @tmp = &Apache::lonnet::get('nohist_calculatedsheets_'.
2706: $sheet->{'cid'},[$key],
2707: $sheet->{'udom'},$sheet->{'uname'});
2708: if ($tmp[0]!~/^error/) {
2709: %currentlystored = @tmp;
2710: }
2711: }
2712: #
2713: # Add the new line
2714: #
2715: $currentlystored{$fn}=join('___;___',@exportarr);
2716: #
2717: # Stick everything back together
2718: #
2719: my $newstore='';
2720: foreach (keys(%currentlystored)) {
2721: if ($newstore) { $newstore.='___&___'; }
2722: $newstore.=$_.'___=___'.$currentlystored{$_};
2723: }
2724: my $now=time;
2725: #
2726: # Store away the new value
2727: #
2728: if ($stype eq 'studentcalc') {
2729: &Apache::lonnet::put('nohist_calculatedsheets',
2730: { $key => $newstore,
2731: $key.time => $now },
2732: $sheet->{'cdom'},$sheet->{'cnum'});
2733: } else {
2734: &Apache::lonnet::put('nohist_calculatedsheets_'.$sheet->{'cid'},
2735: { $key => $newstore,
2736: $key.time => $now },
2737: $sheet->{'udom'},
2738: $sheet->{'uname'})
2739: }
2740: return @exportarr;
2741: }
2742:
2743: # ============================================================ Expiration Dates
2744: #
2745: # Load previously cached student spreadsheets for this course
2746: #
2747: sub load_spreadsheet_expirationdates {
2748: undef %expiredates;
2749: my $cid=$ENV{'request.course.id'};
2750: my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
2751: $ENV{'course.'.$cid.'.domain'},
2752: $ENV{'course.'.$cid.'.num'});
2753: if (lc($tmp[0]) !~ /^error/){
2754: %expiredates = @tmp;
2755: }
2756: }
2757:
2758: # ===================================================== Calculated sheets cache
2759: #
2760: # Load previously cached student spreadsheets for this course
2761: #
2762:
2763: sub cachedcsheets {
2764: my $cid=$ENV{'request.course.id'};
2765: my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
2766: $ENV{'course.'.$cid.'.domain'},
2767: $ENV{'course.'.$cid.'.num'});
2768: if ($tmp[0] !~ /^error/) {
2769: my %StupidTempHash = @tmp;
2770: while (my ($key,$value) = each %StupidTempHash) {
2771: $oldsheets{$key} = $value;
2772: }
2773: }
2774: }
2775:
2776: # ===================================================== Calculated sheets cache
2777: #
2778: # Load previously cached assessment spreadsheets for this student
2779: #
2780:
2781: sub cachedssheets {
2782: my ($sheet,$uname,$udom) = @_;
2783: $uname = $uname || $sheet->{'uname'};
2784: $udom = $udom || $sheet->{'udom'};
2785: if (! $loadedcaches{$uname.'_'.$udom}) {
2786: my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
2787: $sheet->{'udom'},
2788: $sheet->{'uname'});
2789: if ($tmp[0] !~ /^error/) {
2790: my %TempHash = @tmp;
2791: my $count = 0;
2792: while (my ($key,$value) = each %TempHash) {
2793: $oldsheets{$key} = $value;
2794: $count++;
2795: }
2796: $loadedcaches{$sheet->{'uname'}.'_'.$sheet->{'udom'}}=1;
2797: }
2798: }
2799:
2800: }
2801:
2802: # ===================================================== Calculated sheets cache
2803: #
2804: # Load previously cached assessment spreadsheets for this student
2805: #
2806:
2807: # ================================================================ Main handler
2808: #
2809: # Interactive call to screen
2810: #
2811: #
2812: sub handler {
2813: my $r=shift;
2814:
2815: my ($sheettype) = ($r->uri=~/\/(\w+)$/);
2816:
2817: if (! exists($ENV{'form.Status'})) {
2818: $ENV{'form.Status'} = 'Active';
2819: }
2820: if ( ! exists($ENV{'form.output'}) ||
2821: ($sheettype ne 'classcalc' &&
2822: lc($ENV{'form.output'}) eq 'recursive excel')) {
2823: $ENV{'form.output'} = 'HTML';
2824: }
2825: #
2826: # Overload checking
2827: #
2828: # Check this server
2829: my $loaderror=&Apache::lonnet::overloaderror($r);
2830: if ($loaderror) { return $loaderror; }
2831: # Check the course homeserver
2832: $loaderror= &Apache::lonnet::overloaderror($r,
2833: $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
2834: if ($loaderror) { return $loaderror; }
2835: #
2836: # HTML Header
2837: #
2838: if ($r->header_only) {
2839: $r->content_type('text/html');
2840: $r->send_http_header;
2841: return OK;
2842: }
2843: #
2844: # Global directory configs
2845: #
2846: $includedir = $r->dir_config('lonIncludes');
2847: $tmpdir = $r->dir_config('lonDaemons').'/tmp/';
2848: #
2849: # Roles Checking
2850: #
2851: # Needs to be in a course
2852: if (! $ENV{'request.course.fn'}) {
2853: # Not in a course, or not allowed to modify parms
2854: $ENV{'user.error.msg'}=
2855: $r->uri.":opa:0:0:Cannot modify spreadsheet";
2856: return HTTP_NOT_ACCEPTABLE;
2857: }
2858: #
2859: # Get query string for limited number of parameters
2860: #
2861: &Apache::loncommon::get_unprocessed_cgi
2862: ($ENV{'QUERY_STRING'},['uname','udom','usymb','ufn','mapid','resid']);
2863: #
2864: # Deal with restricted student permissions
2865: #
2866: if ($ENV{'request.role'} =~ /^st\./) {
2867: delete $ENV{'form.unewfield'} if (exists($ENV{'form.unewfield'}));
2868: delete $ENV{'form.unewformula'} if (exists($ENV{'form.unewformula'}));
2869: }
2870: #
2871: # Clean up symb and spreadsheet filename
2872: #
2873: if (($ENV{'form.usymb'}=~/^\_(\w+)/) && (!$ENV{'form.ufn'})) {
2874: $ENV{'form.ufn'}='default_'.$1;
2875: }
2876: #
2877: # Interactive loading of specific sheet?
2878: #
2879: if (($ENV{'form.load'}) && ($ENV{'form.loadthissheet'} ne 'Default')) {
2880: $ENV{'form.ufn'}=$ENV{'form.loadthissheet'};
2881: }
2882: #
2883: # Determine the user name and domain for the sheet.
2884: my $aname;
2885: my $adom;
2886: unless ($ENV{'form.uname'}) {
2887: $aname=$ENV{'user.name'};
2888: $adom=$ENV{'user.domain'};
2889: } else {
2890: $aname=$ENV{'form.uname'};
2891: $adom=$ENV{'form.udom'};
2892: }
2893: #
2894: # Open page, try to prevent browser cache.
2895: #
2896: $r->content_type('text/html');
2897: $r->header_out('Cache-control','no-cache');
2898: $r->header_out('Pragma','no-cache');
2899: $r->send_http_header;
2900: #
2901: # Header....
2902: #
2903: $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
2904: my $nothing = "''";
2905: if ($ENV{'browser.type'} eq 'explorer') {
2906: $nothing = "'javascript:void(0);'";
2907: }
2908:
2909: if ($ENV{'request.role'} !~ /^st\./) {
2910: $r->print(<<ENDSCRIPT);
2911: <script language="JavaScript">
2912:
2913: var editwin;
2914:
2915: function celledit(cellname,cellformula) {
2916: var edit_text = '';
2917: edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
2918: edit_text += '<form name="editwinform">';
2919: edit_text += '<center><h3>Cell '+cellname+'</h3>';
2920: edit_text += '<textarea name="newformula" cols="40" rows="6"';
2921: edit_text += ' wrap="off" >'+cellformula+'</textarea>';
2922: edit_text += '</br>';
2923: edit_text += '<input type="button" name="accept" value="Accept"';
2924: edit_text += ' onClick=\\\'javascript:';
2925: edit_text += 'opener.document.sheet.unewfield.value=';
2926: edit_text += '"'+cellname+'";';
2927: edit_text += 'opener.document.sheet.unewformula.value=';
2928: edit_text += 'document.editwinform.newformula.value;';
2929: edit_text += 'opener.document.sheet.submit();';
2930: edit_text += 'self.close()\\\' />';
2931: edit_text += ' ';
2932: edit_text += '<input type="button" name="abort" ';
2933: edit_text += 'value="Discard Changes"';
2934: edit_text += ' onClick="javascript:self.close()" />';
2935: edit_text += '</center></body></html>';
2936:
2937: if (editwin != null && !(editwin.closed) ) {
2938: editwin.close();
2939: }
2940:
2941: editwin = window.open($nothing,'CellEditWin','height=200,width=350,scrollbars=no,resizeable=yes,alwaysRaised=yes,dependent=yes',true);
2942: editwin.document.write(edit_text);
2943: }
2944:
2945: function changesheet(cn) {
2946: document.sheet.unewfield.value=cn;
2947: document.sheet.unewformula.value='changesheet';
2948: document.sheet.submit();
2949: }
2950:
2951: function insertrow(cn) {
2952: document.sheet.unewfield.value='insertrow';
2953: document.sheet.unewformula.value=cn;
2954: document.sheet.submit();
2955: }
2956:
2957: </script>
2958: ENDSCRIPT
2959: }
2960: $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
2961: '<form action="'.$r->uri.'" name="sheet" method="post">');
2962: $r->print(&hiddenfield('uname',$ENV{'form.uname'}).
2963: &hiddenfield('udom',$ENV{'form.udom'}).
2964: &hiddenfield('usymb',$ENV{'form.usymb'}).
2965: &hiddenfield('unewfield','').
2966: &hiddenfield('unewformula',''));
2967: $r->rflush();
2968: #
2969: # Full recalc?
2970: #
2971: if ($ENV{'form.forcerecalc'}) {
2972: $r->print('<h4>Completely Recalculating Sheet ...</h4>');
2973: undef %spreadsheets;
2974: undef %courserdatas;
2975: undef %userrdatas;
2976: undef %defaultsheets;
2977: undef %rowlabel_cache;
2978: }
2979: # Read new sheet or modified worksheet
2980: my ($sheet)=&makenewsheet($aname,$adom,$sheettype,$ENV{'form.usymb'});
2981: #
2982: # Check user permissions
2983: if (($sheet->{'sheettype'} eq 'classcalc' ) ||
2984: ($sheet->{'uname'} ne $ENV{'user.name'} ) ||
2985: ($sheet->{'udom'} ne $ENV{'user.domain'})) {
2986: unless (&Apache::lonnet::allowed('vgr',$sheet->{'cid'})) {
2987: $r->print('<h1>Access Permission Denied</h1>'.
2988: '</form></body></html>');
2989: return OK;
2990: }
2991: }
2992: # Print out user information
2993: $r->print('<h2>'.$sheet->{'coursedesc'}.'</h2>');
2994: if ($sheet->{'sheettype'} ne 'classcalc') {
2995: $r->print('<h2>'.&gettitle($sheet).'</h2><p>');
2996: }
2997: if ($sheet->{'sheettype'} eq 'assesscalc') {
2998: $r->print('<b>User:</b> '.$sheet->{'uname'}.
2999: '<br /><b>Domain:</b> '.$sheet->{'udom'}.'<br />');
3000: }
3001: if ($sheet->{'sheettype'} eq 'studentcalc' ||
3002: $sheet->{'sheettype'} eq 'assesscalc') {
3003: $r->print('<b>Section/Group:</b>'.$sheet->{'csec'}.'</p>');
3004: }
3005: #
3006: # If a new formula had been entered, go from work copy
3007: if ($ENV{'form.unewfield'}) {
3008: $r->print('<h2>Modified Workcopy</h2>');
3009: $ENV{'form.unewformula'}=~s/\'/\"/g;
3010: $r->print('<p>New formula: '.$ENV{'form.unewfield'}.'='.
3011: $ENV{'form.unewformula'}.'<p>');
3012: $sheet->{'filename'} = $ENV{'form.ufn'};
3013: &tmpread($sheet,$ENV{'form.unewfield'},$ENV{'form.unewformula'});
3014: } elsif ($ENV{'form.saveas'}) {
3015: $sheet->{'filename'} = $ENV{'form.ufn'};
3016: &tmpread($sheet);
3017: } else {
3018: &readsheet($sheet,$ENV{'form.ufn'});
3019: }
3020: # Additional options
3021: if ($sheet->{'sheettype'} eq 'assesscalc') {
3022: $r->print('<p><font size=+2>'.
3023: '<a href="/adm/studentcalc?'.
3024: 'uname='.$sheet->{'uname'}.
3025: '&udom='.$sheet->{'udom'}.'">'.
3026: 'Level up: Student Sheet</a></font></p>');
3027: }
3028: if (($sheet->{'sheettype'} eq 'studentcalc') &&
3029: (&Apache::lonnet::allowed('vgr',$sheet->{'cid'}))) {
3030: $r->print ('<p><font size=+2><a href="/adm/classcalc">'.
3031: 'Level up: Course Sheet</a></font></p>');
3032: }
3033: # Recalc button
3034: $r->print('<br />'.
3035: '<input type="submit" name="forcerecalc" '.
3036: 'value="Completely Recalculate Sheet"></p>');
3037: # Save dialog
3038: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3039: my $fname=$ENV{'form.ufn'};
3040: $fname=~s/\_[^\_]+$//;
3041: if ($fname eq 'default') { $fname='course_default'; }
3042: $r->print('<input type=submit name=saveas value="Save as ...">'.
3043: '<input type=text size=20 name=newfn value="'.$fname.'">'.
3044: 'make default: <input type=checkbox name="makedefufn"><p>');
3045: }
3046: $r->print(&hiddenfield('ufn',$sheet->{'filename'}));
3047: # Load dialog
3048: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3049: $r->print('<p><input type=submit name=load value="Load ...">'.
3050: '<select name="loadthissheet">'.
3051: '<option name="default">Default</option>');
3052: foreach (&othersheets($sheet)) {
3053: $r->print('<option name="'.$_.'"');
3054: if ($ENV{'form.ufn'} eq $_) {
3055: $r->print(' selected');
3056: }
3057: $r->print('>'.$_.'</option>');
3058: }
3059: $r->print('</select><p>');
3060: if ($sheet->{'sheettype'} eq 'studentcalc') {
3061: &setothersheets($sheet,
3062: &othersheets($sheet,'assesscalc'));
3063: }
3064: }
3065: #
3066: # Set up caching mechanisms
3067: #
3068: &load_spreadsheet_expirationdates();
3069: # Clear out old caches if we have not seen this class before.
3070: if (exists($oldsheets{'course'}) &&
3071: $oldsheets{'course'} ne $sheet->{'cid'}) {
3072: undef %oldsheets;
3073: undef %loadedcaches;
3074: }
3075: $oldsheets{'course'} = $sheet->{'cid'};
3076: #
3077: if ($sheet->{'sheettype'} eq 'classcalc') {
3078: $r->print("Loading previously calculated student sheets ...\n");
3079: $r->rflush();
3080: &cachedcsheets();
3081: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
3082: $r->print("Loading previously calculated assessment sheets ...\n");
3083: $r->rflush();
3084: &cachedssheets($sheet);
3085: }
3086: # Update sheet, load rows
3087: $r->print("Loaded sheet(s), updating rows ...<br>\n");
3088: $r->rflush();
3089: #
3090: &updatesheet($sheet);
3091: $r->print("Updated rows, loading row data ...\n");
3092: $r->rflush();
3093: #
3094: &loadrows($sheet,$r);
3095: $r->print("Loaded row data, calculating sheet ...<br>\n");
3096: $r->rflush();
3097: #
3098: my $calcoutput=&calcsheet($sheet);
3099: $r->print('<h3><font color=red>'.$calcoutput.'</h3></font>');
3100: # See if something to save
3101: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3102: my $fname='';
3103: if ($ENV{'form.saveas'} && ($fname=$ENV{'form.newfn'})) {
3104: $fname=~s/\W/\_/g;
3105: if ($fname eq 'default') { $fname='course_default'; }
3106: $fname.='_'.$sheet->{'sheettype'};
3107: $sheet->{'filename'} = $fname;
3108: $ENV{'form.ufn'}=$fname;
3109: $r->print('<p>Saving spreadsheet: '.
3110: &writesheet($sheet,$ENV{'form.makedefufn'}).
3111: '<p>');
3112: }
3113: }
3114: #
3115: # Write the modified worksheet
3116: $r->print('<b>Current sheet:</b> '.$sheet->{'filename'}.'</p>');
3117: &tmpwrite($sheet);
3118: if ($sheet->{'sheettype'} eq 'studentcalc') {
3119: $r->print('<p>Show rows with empty A column: ');
3120: } else {
3121: $r->print('<p>Show empty rows: ');
3122: }
3123: #
3124: $r->print(&hiddenfield('userselhidden','true').
3125: '<input type="checkbox" name="showall" onClick="submit()"');
3126: #
3127: if ($ENV{'form.showall'}) {
3128: $r->print(' checked');
3129: } else {
3130: unless ($ENV{'form.userselhidden'}) {
3131: unless
3132: ($ENV{'course.'.$sheet->{'cid'}.'.hideemptyrows'} eq 'yes') {
3133: $r->print(' checked');
3134: $ENV{'form.showall'}=1;
3135: }
3136: }
3137: }
3138: $r->print('>');
3139: #
3140: # CSV format checkbox (classcalc sheets only)
3141: $r->print(' Output as <select name="output" size="1" onClick="submit()">'.
3142: "\n");
3143: foreach my $mode (qw/HTML CSV Excel/) {
3144: $r->print('<option value="'.$mode.'"');
3145: if ($ENV{'form.output'} eq $mode) {
3146: $r->print(' selected ');
3147: }
3148: $r->print('>'.$mode.'</option>'."\n");
3149: }
3150: if ($sheet->{'sheettype'} eq 'classcalc') {
3151: $r->print('<option value="recursive excel"');
3152: if ($ENV{'form.output'} eq 'recursive excel') {
3153: $r->print(' selected ');
3154: }
3155: $r->print(">Multi-Sheet Excel</option>\n");
3156: }
3157: $r->print("</select>\n");
3158: #
3159: if ($sheet->{'sheettype'} eq 'classcalc') {
3160: $r->print(' Student Status: '.
3161: &Apache::lonhtmlcommon::StatusOptions
3162: ($ENV{'form.Status'},'sheet'));
3163: }
3164: #
3165: # Buttons to insert rows
3166: # $r->print(<<ENDINSERTBUTTONS);
3167: #<br>
3168: #<input type='button' onClick='insertrow("top");'
3169: #value='Insert Row Top'>
3170: #<input type='button' onClick='insertrow("bottom");'
3171: #value='Insert Row Bottom'><br>
3172: #ENDINSERTBUTTONS
3173: # Print out sheet
3174: &outsheet($r,$sheet);
3175: $r->print('</form></body></html>');
3176: # Done
3177: return OK;
3178: }
3179:
3180: 1;
3181: __END__
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