1: #
2: # $Id: lonspreadsheet.pm,v 1.148 2002/11/21 19:50:49 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,$r,$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,$r,$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: my @sortidx=();
1190: #
1191: if ($sheet->{'sheettype'} eq 'classcalc') {
1192: my @sortby=(undef);
1193: # Skip row 0
1194: for (my $row=1;$row<=$sheet->{'maxrow'};$row++) {
1195: my (undef,$sname,$sdom,$fullname,$section,$id) =
1196: split(':',$sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$row}});
1197: push (@sortby, lc($fullname));
1198: push (@sortidx, $row);
1199: }
1200: @sortidx = sort { $sortby[$a] cmp $sortby[$b]; } @sortidx;
1201: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1202: my @sortby1=(undef);
1203: my @sortby2=(undef);
1204: # Skip row 0
1205: for (my $row=1;$row<=$sheet->{'maxrow'};$row++) {
1206: my (undef,$symb,$uname,$udom,$mapid,$resid,$title) =
1207: split(':',$sheet->{'rowlabel'}->{$sheet->{'f'}->{'A'.$row}});
1208: $symb = &Apache::lonnet::unescape($symb);
1209: my ($sequence) = ($symb =~ /\/([^\/]*\.sequence)/);
1210: if ($sequence eq '') {
1211: $sequence = $symb;
1212: }
1213: push (@sortby1, $sequence);
1214: push (@sortby2, $title);
1215: push (@sortidx, $row);
1216: }
1217: @sortidx = sort { $sortby1[$a] cmp $sortby1[$b] ||
1218: $sortby2[$a] cmp $sortby2[$b] } @sortidx;
1219: } else {
1220: my @sortby=(undef);
1221: # Skip row 0
1222: for (my $row=1;$row<=$sheet->{'maxrow'};$row++) {
1223: push (@sortby, $sheet->{'safe'}->reval('$f{"A'.$row.'"}'));
1224: push (@sortidx, $row);
1225: }
1226: @sortidx = sort { $sortby[$a] cmp $sortby[$b]; } @sortidx;
1227: }
1228: return @sortidx;
1229: }
1230:
1231: #############################################################
1232: ### ###
1233: ### Spreadsheet Output Routines ###
1234: ### ###
1235: #############################################################
1236:
1237: ############################################
1238: ## HTML output routines ##
1239: ############################################
1240: sub html_editable_cell {
1241: my ($cell,$bgcolor) = @_;
1242: my $result;
1243: my ($name,$formula,$value);
1244: if (defined($cell)) {
1245: $name = $cell->{'name'};
1246: $formula = $cell->{'formula'};
1247: $value = $cell->{'value'};
1248: }
1249: $name = '' if (! defined($name));
1250: $formula = '' if (! defined($formula));
1251: if (! defined($value)) {
1252: $value = '<font color="'.$bgcolor.'">#</font>';
1253: if ($formula ne '') {
1254: $value = '<i>undefined value</i>';
1255: }
1256: }
1257: if ($value =~ /^\s*$/ ) {
1258: $value = '<font color="'.$bgcolor.'">#</font>';
1259: }
1260: $formula =~ s/\n/\\n/gs;
1261: $result .= '<a href="javascript:celledit(\''.
1262: $name.'\',\''.$formula.'\');">'.$value.'</a>';
1263: return $result;
1264: }
1265:
1266: sub html_uneditable_cell {
1267: my ($cell,$bgcolor) = @_;
1268: my $value = (defined($cell) ? $cell->{'value'} : '');
1269: return ' '.$value.' ';
1270: }
1271:
1272: sub outsheet_html {
1273: my ($sheet,$r) = @_;
1274: my ($num_uneditable,$realm,$row_type);
1275: if ($sheet->{'sheettype'} eq 'assesscalc') {
1276: $num_uneditable = 1;
1277: $realm = 'Assessment';
1278: $row_type = 'Item';
1279: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1280: $num_uneditable = 26;
1281: $realm = 'User';
1282: $row_type = 'Assessment';
1283: } elsif ($sheet->{'sheettype'} eq 'classcalc') {
1284: $num_uneditable = 26;
1285: $realm = 'Course';
1286: $row_type = 'Student';
1287: } else {
1288: return; # error
1289: }
1290: ####################################
1291: # Print out header table
1292: ####################################
1293: my $num_left = 52-$num_uneditable;
1294: my $tabledata =<<"END";
1295: <table border="2">
1296: <tr>
1297: <th colspan="1" rowspan="2"><font size="+2">$realm</font></th>
1298: <td bgcolor="#FFDDDD" colspan="$num_uneditable">
1299: <b><font size="+1">Import</font></b></td>
1300: <td colspan="$num_left">
1301: <b><font size="+1">Calculations</font></b></td>
1302: </tr><tr>
1303: END
1304: my $label_num = 0;
1305: foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
1306: if ($label_num<$num_uneditable) {
1307: $tabledata.='<td bgcolor="#FFDDDD">';
1308: } else {
1309: $tabledata.='<td>';
1310: }
1311: $tabledata.="<b><font size=+1>$_</font></b></td>";
1312: $label_num++;
1313: }
1314: $tabledata.="</tr>\n";
1315: $r->print($tabledata);
1316: ####################################
1317: # Print out template row
1318: ####################################
1319: my ($rowlabel,@rowdata) = &get_row($sheet,'-');
1320: my $row_html = '<tr><td>'.&format_html_rowlabel($rowlabel).'</td>';
1321: my $num_cols_output = 0;
1322: foreach my $cell (@rowdata) {
1323: if ($num_cols_output++ < $num_uneditable) {
1324: $row_html .= '<td bgcolor="#FFDDDD">';
1325: $row_html .= &html_uneditable_cell($cell,'#FFDDDD');
1326: } else {
1327: $row_html .= '<td bgcolor="#EOFFDD">';
1328: $row_html .= &html_editable_cell($cell,'#E0FFDD');
1329: }
1330: $row_html .= '</td>';
1331: }
1332: $row_html.= "</tr>\n";
1333: $r->print($row_html);
1334: ####################################
1335: # Print out summary/export row
1336: ####################################
1337: my ($rowlabel,@rowdata) = &get_row($sheet,'0');
1338: $row_html = '<tr><td>'.&format_html_rowlabel($rowlabel).'</td>';
1339: $num_cols_output = 0;
1340: foreach my $cell (@rowdata) {
1341: if ($num_cols_output++ < 26) {
1342: $row_html .= '<td bgcolor="#CCCCFF">';
1343: $row_html .= &html_editable_cell($cell,'#CCCCFF');
1344: } else {
1345: $row_html .= '<td bgcolor="#DDCCFF">';
1346: $row_html .= &html_uneditable_cell(undef,'#CCCCFF');
1347: }
1348: $row_html .= '</td>';
1349: }
1350: $row_html.= "</tr>\n";
1351: $r->print($row_html);
1352: $r->print('</table>');
1353: ####################################
1354: # Prepare to output rows
1355: ####################################
1356: my @Rows = &sort_indicies($sheet);
1357: #
1358: # Loop through the rows and output them one at a time
1359: my $rows_output=0;
1360: foreach my $rownum (@Rows) {
1361: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1362: next if ($rowlabel =~ /^\s*$/);
1363: next if (($sheet->{'sheettype'} eq 'assesscalc') &&
1364: (! $ENV{'form.showall'}) &&
1365: ($rowdata[0]->{'value'} =~ /^\s*$/));
1366: if (! $ENV{'form.showall'} &&
1367: $sheet->{'sheettype'} =~ /^(studentcalc|classcalc)$/) {
1368: my $row_is_empty = 1;
1369: foreach my $cell (@rowdata) {
1370: if ($cell->{'value'} !~ /^\s*$/) {
1371: $row_is_empty = 0;
1372: last;
1373: }
1374: }
1375: next if ($row_is_empty);
1376: }
1377: #
1378: my $defaultbg='#E0FF';
1379: #
1380: my $row_html ="\n".'<tr><td><b><font size=+1>'.$rownum.
1381: '</font></b></td>';
1382: #
1383: if ($sheet->{'sheettype'} eq 'classcalc') {
1384: $row_html.='<td>'.&format_html_rowlabel($rowlabel).'</td>';
1385: # Output links for each student?
1386: # Nope, that is already done for us in format_html_rowlabel (for now)
1387: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1388: $row_html.='<td>'.&format_html_rowlabel($rowlabel);
1389: $row_html.= '<br>'.
1390: '<select name="sel_'.$rownum.'" '.
1391: 'onChange="changesheet('.$rownum.')">'.
1392: '<option name="default">Default</option>';
1393: foreach (@{$sheet->{'othersheets'}}) {
1394: $row_html.='<option name="'.$_.'"';
1395: #if ($ufn eq $_) {
1396: # $row_html.=' selected';
1397: #}
1398: $row_html.='>'.$_.'</option>';
1399: }
1400: $row_html.='</select></td>';
1401: } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
1402: $row_html.='<td>'.&format_html_rowlabel($rowlabel).'</td>';
1403: }
1404: #
1405: my $shown_cells = 0;
1406: foreach my $cell (@rowdata) {
1407: my $value = $cell->{'value'};
1408: my $formula = $cell->{'formula'};
1409: my $cellname = $cell->{'name'};
1410: #
1411: my $bgcolor;
1412: if ($shown_cells && ($shown_cells/5 == int($shown_cells/5))) {
1413: $bgcolor = $defaultbg.'99';
1414: } else {
1415: $bgcolor = $defaultbg.'DD';
1416: }
1417: $bgcolor='#FFDDDD' if ($shown_cells < $num_uneditable);
1418: #
1419: $row_html.='<td bgcolor='.$bgcolor.'>';
1420: if ($shown_cells < $num_uneditable) {
1421: $row_html .= &html_uneditable_cell($cell,$bgcolor);
1422: } else {
1423: $row_html .= &html_editable_cell($cell,$bgcolor);
1424: }
1425: $row_html.='</td>';
1426: $shown_cells++;
1427: }
1428: if ($row_html) {
1429: if ($rows_output % 25 == 0) {
1430: $r->print("</table>\n<br>\n");
1431: $r->rflush();
1432: $r->print('<table border=2>'.
1433: '<tr><td> <td>'.$row_type.'</td>'.
1434: '<td>'.
1435: join('</td><td>',
1436: (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
1437: 'abcdefghijklmnopqrstuvwxyz'))).
1438: "</td></tr>\n");
1439: }
1440: $rows_output++;
1441: $r->print($row_html);
1442: }
1443: }
1444: #
1445: $r->print('</table>');
1446: #
1447: # Debugging code (be sure to uncomment errorlog code in safe space):
1448: #
1449: # $r->print("\n<pre>");
1450: # $r->print(&geterrorlog($sheet));
1451: # $r->print("\n</pre>");
1452: return 1;
1453: }
1454:
1455: ############################################
1456: ## csv output routines ##
1457: ############################################
1458: sub outsheet_csv {
1459: my ($sheet,$r) = @_;
1460: my $csvdata = '';
1461: my @Values;
1462: ####################################
1463: # Prepare to output rows
1464: ####################################
1465: my @Rows = &sort_indicies($sheet);
1466: #
1467: # Loop through the rows and output them one at a time
1468: my $rows_output=0;
1469: foreach my $rownum (@Rows) {
1470: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1471: next if ($rowlabel =~ /^\s*$/);
1472: push (@Values,&format_csv_rowlabel($rowlabel));
1473: foreach my $cell (@rowdata) {
1474: push (@Values,'"'.$cell->{'value'}.'"');
1475: }
1476: $csvdata.= join(',',@Values)."\n";
1477: @Values = ();
1478: }
1479: #
1480: # Write the CSV data to a file and serve up a link
1481: #
1482: my $filename = '/prtspool/'.
1483: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
1484: time.'_'.rand(1000000000).'.csv';
1485: my $file;
1486: unless ($file = Apache::File->new('>'.'/home/httpd'.$filename)) {
1487: $r->log_error("Couldn't open $filename for output $!");
1488: $r->print("Problems occured in writing the csv file. ".
1489: "This error has been logged. ".
1490: "Please alert your LON-CAPA administrator.");
1491: $r->print("<pre>\n".$csvdata."</pre>\n");
1492: return 0;
1493: }
1494: print $file $csvdata;
1495: close($file);
1496: $r->print('<br /><br />'.
1497: '<a href="'.$filename.'">Your CSV spreadsheet.</a>'."\n");
1498: #
1499: return 1;
1500: }
1501:
1502: ############################################
1503: ## Excel output routines ##
1504: ############################################
1505: sub outsheet_recursive_excel {
1506: my ($sheet,$r) = @_;
1507: my $c = $r->connection;
1508: return undef if ($sheet->{'sheettype'} ne 'classcalc');
1509: my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r);
1510: return undef if (! defined($workbook));
1511: #
1512: # Create main worksheet
1513: my $main_worksheet = $workbook->addworksheet('main');
1514: #
1515: # Figure out who the students are
1516: my %f=&getformulas($sheet);
1517: my $count = 0;
1518: $r->print(<<END);
1519: <p>
1520: Compiling Excel Workbook with a worksheet for each student.
1521: </p><p>
1522: This operation may take longer than a complete recalculation of the
1523: spreadsheet.
1524: </p><p>
1525: To abort this operation, hit the stop button on your browser.
1526: </p><p>
1527: A link to the spreadsheet will be available at the end of this process.
1528: </p>
1529: <p>
1530: END
1531: $r->rflush();
1532: my $starttime = time;
1533: foreach my $rownum (&sort_indicies($sheet)) {
1534: $count++;
1535: my ($sname,$sdom) = split(':',$f{'A'.$rownum});
1536: my $student_excel_worksheet=$workbook->addworksheet($sname.'@'.$sdom);
1537: # Create a new spreadsheet
1538: my $studentsheet = &makenewsheet($sname,$sdom,'studentcalc',undef);
1539: # Read in the spreadsheet definition
1540: &update_student_sheet($studentsheet,$r,$c);
1541: # Stuff the sheet into excel
1542: &export_sheet_as_excel($studentsheet,$student_excel_worksheet);
1543: my $totaltime = int((time - $starttime) / $count * $sheet->{'maxrow'});
1544: my $timeleft = int((time - $starttime) / $count * ($sheet->{'maxrow'} - $count));
1545: if ($count % 5 == 0) {
1546: $r->print($count.' students completed.'.
1547: ' Time remaining: '.$timeleft.' sec. '.
1548: ' Estimated total time: '.$totaltime." sec <br />\n");
1549: $r->rflush();
1550: }
1551: if(defined($c) && ($c->aborted())) {
1552: last;
1553: }
1554: }
1555: #
1556: if(! $c->aborted() ) {
1557: $r->print('All students spreadsheets completed!<br />');
1558: $r->rflush();
1559: #
1560: # &export_sheet_as_excel fills $worksheet with the data from $sheet
1561: &export_sheet_as_excel($sheet,$main_worksheet);
1562: #
1563: $workbook->close();
1564: # Okay, the spreadsheet is taken care of, so give the user a link.
1565: $r->print('<br /><br />'.
1566: '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
1567: } else {
1568: $workbook->close(); # Not sure how necessary this is.
1569: #unlink('/home/httpd'.$filename); # No need to keep this around?
1570: }
1571: return 1;
1572: }
1573:
1574: sub outsheet_excel {
1575: my ($sheet,$r) = @_;
1576: my ($workbook,$filename) = &create_excel_spreadsheet($sheet,$r);
1577: return undef if (! defined($workbook));
1578: my $sheetname;
1579: if ($sheet->{'sheettype'} eq 'classcalc') {
1580: $sheetname = 'Main';
1581: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
1582: $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'};
1583: } elsif ($sheet->{'sheettype'} eq 'assesscalc') {
1584: $sheetname = $sheet->{'uname'}.'@'.$sheet->{'udom'}.' assessment';
1585: }
1586: my $worksheet = $workbook->addworksheet($sheetname);
1587: #
1588: # &export_sheet_as_excel fills $worksheet with the data from $sheet
1589: &export_sheet_as_excel($sheet,$worksheet);
1590: #
1591: $workbook->close();
1592: # Okay, the spreadsheet is taken care of, so give the user a link.
1593: $r->print('<br /><br />'.
1594: '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
1595: return 1;
1596: }
1597:
1598: sub create_excel_spreadsheet {
1599: my ($sheet,$r) = @_;
1600: my $filename = '/prtspool/'.
1601: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
1602: time.'_'.rand(1000000000).'.xls';
1603: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1604: if (! defined($workbook)) {
1605: $r->log_error("Error creating excel spreadsheet $filename: $!");
1606: $r->print("Problems creating new Excel file. ".
1607: "This error has been logged. ".
1608: "Please alert your LON-CAPA administrator");
1609: return undef;
1610: }
1611: #
1612: # The spreadsheet stores temporary data in files, then put them
1613: # together. If needed we should be able to disable this (memory only).
1614: # The temporary directory must be specified before calling 'addworksheet'.
1615: # File::Temp is used to determine the temporary directory.
1616: $workbook->set_tempdir('/home/httpd/perl/tmp');
1617: #
1618: # Determine the name to give the worksheet
1619: return ($workbook,$filename);
1620: }
1621:
1622: sub export_sheet_as_excel {
1623: my $sheet = shift;
1624: my $worksheet = shift;
1625: #
1626: my $rows_output = 0;
1627: my $cols_output = 0;
1628: ####################################
1629: # Write an identifying row #
1630: ####################################
1631: my @Headerinfo = ($sheet->{'coursedesc'});
1632: my $title = &gettitle($sheet);
1633: $cols_output = 0;
1634: if (defined($title)) {
1635: $worksheet->write($rows_output++,$cols_output++,$title);
1636: }
1637: ####################################
1638: # Write the summary/export row #
1639: ####################################
1640: my ($rowlabel,@rowdata) = &get_row($sheet,'0');
1641: my $label = &format_excel_rowlabel($rowlabel);
1642: $cols_output = 0;
1643: $worksheet->write($rows_output,$cols_output++,$label);
1644: foreach my $cell (@rowdata) {
1645: $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
1646: }
1647: $rows_output+= 2; # Skip a row, just for fun
1648: ####################################
1649: # Prepare to output rows
1650: ####################################
1651: my @Rows = &sort_indicies($sheet);
1652: #
1653: # Loop through the rows and output them one at a time
1654: foreach my $rownum (@Rows) {
1655: my ($rowlabel,@rowdata) = &get_row($sheet,$rownum);
1656: next if ($rowlabel =~ /^[\s]*$/);
1657: $cols_output = 0;
1658: my $label = &format_excel_rowlabel($rowlabel);
1659: if ( ! $ENV{'form.showall'} &&
1660: $sheet->{'sheettype'} =~ /^(studentcalc|classcalc)$/) {
1661: my $row_is_empty = 1;
1662: foreach my $cell (@rowdata) {
1663: if ($cell->{'value'} !~ /^\s*$/) {
1664: $row_is_empty = 0;
1665: last;
1666: }
1667: }
1668: next if ($row_is_empty);
1669: }
1670: $worksheet->write($rows_output,$cols_output++,$label);
1671: if (ref($label)) {
1672: $cols_output = (scalar(@$label));
1673: }
1674: foreach my $cell (@rowdata) {
1675: $worksheet->write($rows_output,$cols_output++,$cell->{'value'});
1676: }
1677: $rows_output++;
1678: }
1679: return;
1680: }
1681:
1682: ############################################
1683: ## XML output routines ##
1684: ############################################
1685: sub outsheet_xml {
1686: my ($sheet,$r) = @_;
1687: ## Someday XML
1688: ## Will be rendered for the user
1689: ## But not on this day
1690: }
1691:
1692: ##
1693: ## Outsheet - calls other outsheet_* functions
1694: ##
1695: sub outsheet {
1696: my ($sheet,$r)=@_;
1697: if (! exists($ENV{'form.output'})) {
1698: $ENV{'form.output'} = 'HTML';
1699: }
1700: if (lc($ENV{'form.output'}) eq 'csv') {
1701: &outsheet_csv($sheet,$r);
1702: } elsif (lc($ENV{'form.output'}) eq 'excel') {
1703: &outsheet_excel($sheet,$r);
1704: } elsif (lc($ENV{'form.output'}) eq 'recursive excel') {
1705: &outsheet_recursive_excel($sheet,$r);
1706: # } elsif (lc($ENV{'form.output'}) eq 'xml' ) {
1707: # &outsheet_xml($sheet,$r);
1708: } else {
1709: &outsheet_html($sheet,$r);
1710: }
1711: }
1712:
1713: ########################################################################
1714: ########################################################################
1715: sub othersheets {
1716: my ($sheet,$stype)=@_;
1717: $stype = $sheet->{'sheettype'} if (! defined($stype));
1718: #
1719: my $cnum = $sheet->{'cnum'};
1720: my $cdom = $sheet->{'cdom'};
1721: my $chome = $sheet->{'chome'};
1722: #
1723: my @alternatives=();
1724: my %results=&Apache::lonnet::dump($stype.'_spreadsheets',$cdom,$cnum);
1725: my ($tmp) = keys(%results);
1726: unless ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1727: @alternatives = sort (keys(%results));
1728: }
1729: return @alternatives;
1730: }
1731:
1732: #
1733: # -------------------------------------- Parse a spreadsheet
1734: #
1735: sub parse_sheet {
1736: # $sheetxml is a scalar reference or a scalar
1737: my ($sheetxml) = @_;
1738: if (! ref($sheetxml)) {
1739: my $tmp = $sheetxml;
1740: $sheetxml = \$tmp;
1741: }
1742: my %f;
1743: my $parser=HTML::TokeParser->new($sheetxml);
1744: my $token;
1745: while ($token=$parser->get_token) {
1746: if ($token->[0] eq 'S') {
1747: if ($token->[1] eq 'field') {
1748: $f{$token->[2]->{'col'}.$token->[2]->{'row'}}=
1749: $parser->get_text('/field');
1750: }
1751: if ($token->[1] eq 'template') {
1752: $f{'template_'.$token->[2]->{'col'}}=
1753: $parser->get_text('/template');
1754: }
1755: }
1756: }
1757: return \%f;
1758: }
1759:
1760: #
1761: # -------------------------------------- Read spreadsheet formulas for a course
1762: #
1763: sub readsheet {
1764: my ($sheet,$fn)=@_;
1765: #
1766: my $stype = $sheet->{'sheettype'};
1767: my $cnum = $sheet->{'cnum'};
1768: my $cdom = $sheet->{'cdom'};
1769: my $chome = $sheet->{'chome'};
1770: #
1771: if (! defined($fn)) {
1772: # There is no filename. Look for defaults in course and global, cache
1773: unless ($fn=$defaultsheets{$cnum.'_'.$cdom.'_'.$stype}) {
1774: my %tmphash = &Apache::lonnet::get('environment',
1775: ['spreadsheet_default_'.$stype],
1776: $cdom,$cnum);
1777: my ($tmp) = keys(%tmphash);
1778: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1779: $fn = 'default_'.$stype;
1780: } else {
1781: $fn = $tmphash{'spreadsheet_default_'.$stype};
1782: }
1783: unless (($fn) && ($fn!~/^error\:/)) {
1784: $fn='default_'.$stype;
1785: }
1786: $defaultsheets{$cnum.'_'.$cdom.'_'.$stype}=$fn;
1787: }
1788: }
1789: # $fn now has a value
1790: $sheet->{'filename'} = $fn;
1791: # see if sheet is cached
1792: my $fstring='';
1793: if ($fstring=$spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}) {
1794: my %tmp = split(/___;___/,$fstring);
1795: $sheet->{'f'} = \%tmp;
1796: &setformulas($sheet);
1797: } else {
1798: # Not cached, need to read
1799: my %f=();
1800: if ($fn=~/^default\_/) {
1801: my $sheetxml='';
1802: my $fh;
1803: my $dfn=$fn;
1804: $dfn=~s/\_/\./g;
1805: if ($fh=Apache::File->new($includedir.'/'.$dfn)) {
1806: $sheetxml=join('',<$fh>);
1807: } else {
1808: # $sheetxml='<field row="0" col="A">"Error"</field>';
1809: $sheetxml='<field row="0" col="A"></field>';
1810: }
1811: %f=%{&parse_sheet(\$sheetxml)};
1812: } elsif($fn=~/\/*\.spreadsheet$/) {
1813: my $sheetxml=&Apache::lonnet::getfile
1814: (&Apache::lonnet::filelocation('',$fn));
1815: if ($sheetxml == -1) {
1816: $sheetxml='<field row="0" col="A">"Error loading spreadsheet '
1817: .$fn.'"</field>';
1818: }
1819: %f=%{&parse_sheet(\$sheetxml)};
1820: } else {
1821: my $sheet='';
1822: my %tmphash = &Apache::lonnet::dump($fn,$cdom,$cnum);
1823: my ($tmp) = keys(%tmphash);
1824: unless ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1825: foreach (keys(%tmphash)) {
1826: $f{$_}=$tmphash{$_};
1827: }
1828: }
1829: }
1830: # Cache and set
1831: $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
1832: $sheet->{'f'}=\%f;
1833: &setformulas($sheet);
1834: }
1835: }
1836:
1837: # -------------------------------------------------------- Make new spreadsheet
1838: sub makenewsheet {
1839: my ($uname,$udom,$stype,$usymb)=@_;
1840: my $sheet={};
1841: $sheet->{'uname'} = $uname;
1842: $sheet->{'udom'} = $udom;
1843: $sheet->{'sheettype'} = $stype;
1844: $sheet->{'usymb'} = $usymb;
1845: $sheet->{'mapid'} = $ENV{'form.mapid'};
1846: $sheet->{'resid'} = $ENV{'form.resid'};
1847: $sheet->{'cid'} = $ENV{'request.course.id'};
1848: $sheet->{'csec'} = $Section{$uname.':'.$udom};
1849: $sheet->{'coursefilename'} = $ENV{'request.course.fn'};
1850: $sheet->{'cnum'} = $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
1851: $sheet->{'cdom'} = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
1852: $sheet->{'chome'} = $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1853: $sheet->{'coursedesc'} = $ENV{'course.'.$ENV{'request.course.id'}.
1854: '.description'};
1855: $sheet->{'uhome'} = &Apache::lonnet::homeserver($uname,$udom);
1856: #
1857: #
1858: $sheet->{'f'} = {};
1859: $sheet->{'constants'} = {};
1860: $sheet->{'othersheets'} = [];
1861: $sheet->{'rowlabel'} = {};
1862: #
1863: #
1864: $sheet->{'safe'}=&initsheet($sheet->{'sheettype'});
1865: #
1866: # Place all the %$sheet items into the safe space except the safe space
1867: # itself
1868: my $initstring = '';
1869: foreach (qw/uname udom sheettype usymb cid csec coursefilename
1870: cnum cdom chome uhome/) {
1871: $initstring.= qq{\$$_="$sheet->{$_}";};
1872: }
1873: $sheet->{'safe'}->reval($initstring);
1874: return $sheet;
1875: }
1876:
1877: # ------------------------------------------------------------ Save spreadsheet
1878: sub writesheet {
1879: my ($sheet,$makedef)=@_;
1880: my $cid=$sheet->{'cid'};
1881: if (&Apache::lonnet::allowed('opa',$cid)) {
1882: my %f=&getformulas($sheet);
1883: my $stype= $sheet->{'sheettype'};
1884: my $cnum = $sheet->{'cnum'};
1885: my $cdom = $sheet->{'cdom'};
1886: my $chome= $sheet->{'chome'};
1887: my $fn = $sheet->{'filename'};
1888: # Cache new sheet
1889: $spreadsheets{$cnum.'_'.$cdom.'_'.$stype.'_'.$fn}=join('___;___',%f);
1890: # Write sheet
1891: foreach (keys(%f)) {
1892: delete($f{$_}) if ($f{$_} eq 'import');
1893: }
1894: my $reply = &Apache::lonnet::put($fn,\%f,$cdom,$cnum);
1895: if ($reply eq 'ok') {
1896: $reply = &Apache::lonnet::put($stype.'_spreadsheets',
1897: {$fn => $ENV{'user.name'}.'@'.$ENV{'user.domain'}},
1898: $cdom,$cnum);
1899: if ($reply eq 'ok') {
1900: if ($makedef) {
1901: return &Apache::lonnet::put('environment',
1902: {'spreadsheet_default_'.$stype => $fn },
1903: $cdom,$cnum);
1904: }
1905: return $reply;
1906: }
1907: return $reply;
1908: }
1909: return $reply;
1910: }
1911: return 'unauthorized';
1912: }
1913:
1914: # ----------------------------------------------- Make a temp copy of the sheet
1915: # "Modified workcopy" - interactive only
1916: #
1917: sub tmpwrite {
1918: my ($sheet) = @_;
1919: my $fn=$ENV{'user.name'}.'_'.
1920: $ENV{'user.domain'}.'_spreadsheet_'.$sheet->{'usymb'}.'_'.
1921: $sheet->{'filename'};
1922: $fn=~s/\W/\_/g;
1923: $fn=$tmpdir.$fn.'.tmp';
1924: my $fh;
1925: if ($fh=Apache::File->new('>'.$fn)) {
1926: print $fh join("\n",&getformulas($sheet));
1927: }
1928: }
1929:
1930: # ---------------------------------------------------------- Read the temp copy
1931: sub tmpread {
1932: my ($sheet,$nfield,$nform)=@_;
1933: my $fn=$ENV{'user.name'}.'_'.
1934: $ENV{'user.domain'}.'_spreadsheet_'.$sheet->{'usymb'}.'_'.
1935: $sheet->{'filename'};
1936: $fn=~s/\W/\_/g;
1937: $fn=$tmpdir.$fn.'.tmp';
1938: my $fh;
1939: my %fo=();
1940: my $countrows=0;
1941: if ($fh=Apache::File->new($fn)) {
1942: my $name;
1943: while ($name=<$fh>) {
1944: chomp($name);
1945: my $value=<$fh>;
1946: chomp($value);
1947: $fo{$name}=$value;
1948: if ($name=~/^A(\d+)$/) {
1949: if ($1>$countrows) {
1950: $countrows=$1;
1951: }
1952: }
1953: }
1954: }
1955: if ($nform eq 'changesheet') {
1956: $fo{'A'.$nfield}=(split(/__&&&\__/,$fo{'A'.$nfield}))[0];
1957: unless ($ENV{'form.sel_'.$nfield} eq 'Default') {
1958: $fo{'A'.$nfield}.='__&&&__'.$ENV{'form.sel_'.$nfield};
1959: }
1960: } elsif ($nfield eq 'insertrow') {
1961: $countrows++;
1962: my $newrow=substr('000000'.$countrows,-7);
1963: if ($nform eq 'top') {
1964: $fo{'A'.$countrows}='--- '.$newrow;
1965: } else {
1966: $fo{'A'.$countrows}='~~~ '.$newrow;
1967: }
1968: } else {
1969: if ($nfield) { $fo{$nfield}=$nform; }
1970: }
1971: $sheet->{'f'}=\%fo;
1972: &setformulas($sheet);
1973: }
1974:
1975: ##################################################
1976: ##################################################
1977:
1978: =pod
1979:
1980: =item &parmval()
1981:
1982: Determine the value of a parameter.
1983:
1984: Inputs: $what, the parameter needed, $sheet, the safe space
1985:
1986: Returns: The value of a parameter, or '' if none.
1987:
1988: This function cascades through the possible levels searching for a value for
1989: a parameter. The levels are checked in the following order:
1990: user, course (at section level and course level), map, and lonnet::metadata.
1991: This function uses %parmhash, which must be tied prior to calling it.
1992: This function also requires %courseopt and %useropt to be initialized for
1993: this user and course.
1994:
1995: =cut
1996:
1997: ##################################################
1998: ##################################################
1999: sub parmval {
2000: my ($what,$sheet)=@_;
2001: my $symb = $sheet->{'usymb'};
2002: unless ($symb) { return ''; }
2003: #
2004: my $cid = $sheet->{'cid'};
2005: my $csec = $sheet->{'csec'};
2006: my $uname = $sheet->{'uname'};
2007: my $udom = $sheet->{'udom'};
2008: my $result='';
2009: #
2010: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
2011: # Cascading lookup scheme
2012: my $rwhat=$what;
2013: $what =~ s/^parameter\_//;
2014: $what =~ s/\_([^\_]+)$/\.$1/;
2015: #
2016: my $symbparm = $symb.'.'.$what;
2017: my $mapparm = $mapname.'___(all).'.$what;
2018: my $usercourseprefix = $uname.'_'.$udom.'_'.$cid;
2019: #
2020: my $seclevel = $usercourseprefix.'.['.$csec.'].'.$what;
2021: my $seclevelr = $usercourseprefix.'.['.$csec.'].'.$symbparm;
2022: my $seclevelm = $usercourseprefix.'.['.$csec.'].'.$mapparm;
2023: #
2024: my $courselevel = $usercourseprefix.'.'.$what;
2025: my $courselevelr = $usercourseprefix.'.'.$symbparm;
2026: my $courselevelm = $usercourseprefix.'.'.$mapparm;
2027: # fourth, check user
2028: if (defined($uname)) {
2029: return $useropt{$courselevelr} if (defined($useropt{$courselevelr}));
2030: return $useropt{$courselevelm} if (defined($useropt{$courselevelm}));
2031: return $useropt{$courselevel} if (defined($useropt{$courselevel}));
2032: }
2033: # third, check course
2034: if (defined($csec)) {
2035: return $courseopt{$seclevelr} if (defined($courseopt{$seclevelr}));
2036: return $courseopt{$seclevelm} if (defined($courseopt{$seclevelm}));
2037: return $courseopt{$seclevel} if (defined($courseopt{$seclevel}));
2038: }
2039: #
2040: return $courseopt{$courselevelr} if (defined($courseopt{$courselevelr}));
2041: return $courseopt{$courselevelm} if (defined($courseopt{$courselevelm}));
2042: return $courseopt{$courselevel} if (defined($courseopt{$courselevel}));
2043: # second, check map parms
2044: my $thisparm = $parmhash{$symbparm};
2045: return $thisparm if (defined($thisparm));
2046: # first, check default
2047: return &Apache::lonnet::metadata($fn,$rwhat.'.default');
2048: }
2049:
2050:
2051: ##################################################################
2052: ## Row label formatting routines ##
2053: ##################################################################
2054: sub format_html_rowlabel {
2055: my $rowlabel = shift;
2056: return '' if ($rowlabel eq '');
2057: my ($type,$labeldata) = split(':',$rowlabel,2);
2058: my $result = '';
2059: if ($type eq 'symb') {
2060: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2061: $symb = &Apache::lonnet::unescape($symb);
2062: $result = '<a href="/adm/assesscalc?usymb='.$symb.
2063: '&uname='.$uname.'&udom='.$udom.
2064: '&mapid='.$mapid.'&resid='.$resid.'">'.$title.'</a>';
2065: } elsif ($type eq 'student') {
2066: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2067: if ($fullname =~ /^\s*$/) {
2068: $fullname = $sname.'@'.$sdom;
2069: }
2070: $result ='<a href="/adm/studentcalc?uname='.$sname.
2071: '&udom='.$sdom.'">';
2072: $result.=$section.' '.$id." ".$fullname.'</a>';
2073: } elsif ($type eq 'parameter') {
2074: $result = $labeldata;
2075: } else {
2076: $result = '<b><font size=+1>'.$rowlabel.'</font></b>';
2077: }
2078: return $result;
2079: }
2080:
2081: sub format_csv_rowlabel {
2082: my $rowlabel = shift;
2083: return '' if ($rowlabel eq '');
2084: my ($type,$labeldata) = split(':',$rowlabel,2);
2085: my $result = '';
2086: if ($type eq 'symb') {
2087: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2088: $symb = &Apache::lonnet::unescape($symb);
2089: $result = $title;
2090: } elsif ($type eq 'student') {
2091: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2092: $result = join('","',($sname,$sdom,$fullname,$section,$id));
2093: } elsif ($type eq 'parameter') {
2094: $labeldata =~ s/<br>/ /g;
2095: $result = $labeldata;
2096: } else {
2097: $result = $rowlabel;
2098: }
2099: return '"'.$result.'"';
2100: }
2101:
2102: sub format_excel_rowlabel {
2103: my $rowlabel = shift;
2104: return '' if ($rowlabel eq '');
2105: my ($type,$labeldata) = split(':',$rowlabel,2);
2106: my $result = '';
2107: if ($type eq 'symb') {
2108: my ($symb,$uname,$udom,$mapid,$resid,$title) = split(':',$labeldata);
2109: $symb = &Apache::lonnet::unescape($symb);
2110: $result = $title;
2111: } elsif ($type eq 'student') {
2112: my ($sname,$sdom,$fullname,$section,$id) = split(':',$labeldata);
2113: $section = '' if (! defined($section));
2114: $id = '' if (! defined($id));
2115: my @Data = ($sname,$sdom,$fullname,$section,$id);
2116: $result = \@Data;
2117: } elsif ($type eq 'parameter') {
2118: $labeldata =~ s/<br>/ /g;
2119: $result = $labeldata;
2120: } else {
2121: $result = $rowlabel;
2122: }
2123: return $result;
2124: }
2125:
2126: # ---------------------------------------------- Update rows for course listing
2127: sub updateclasssheet {
2128: my ($sheet) = @_;
2129: my $cnum =$sheet->{'cnum'};
2130: my $cdom =$sheet->{'cdom'};
2131: my $cid =$sheet->{'cid'};
2132: my $chome =$sheet->{'chome'};
2133: #
2134: %Section = ();
2135: #
2136: # Read class list and row labels
2137: my $classlist = &Apache::loncoursedata::get_classlist();
2138: if (! defined($classlist)) {
2139: return 'Could not access course classlist';
2140: }
2141: #
2142: my %currentlist=();
2143: foreach my $student (keys(%$classlist)) {
2144: my ($studentDomain,$studentName,$end,$start,$id,$studentSection,
2145: $fullname,$status) = @{$classlist->{$student}};
2146: $Section{$studentName.':'.$studentDomain} = $studentSection;
2147: if ($ENV{'form.Status'} eq $status || $ENV{'form.Status'} eq 'Any') {
2148: $currentlist{$student}=join(':',('student',$studentName,
2149: $studentDomain,$fullname,
2150: $studentSection,$id));
2151: }
2152: }
2153: #
2154: # Find discrepancies between the course row table and this
2155: #
2156: my %f=&getformulas($sheet);
2157: my $changed=0;
2158: #
2159: $sheet->{'maxrow'}=0;
2160: my %existing=();
2161: #
2162: # Now obsolete rows
2163: foreach (keys(%f)) {
2164: if ($_=~/^A(\d+)/) {
2165: if ($1 > $sheet->{'maxrow'}) {
2166: $sheet->{'maxrow'}= $1;
2167: }
2168: $existing{$f{$_}}=1;
2169: unless ((defined($currentlist{$f{$_}})) || (!$1) ||
2170: ($f{$_}=~/^(~~~|---)/)) {
2171: $f{$_}='!!! Obsolete';
2172: $changed=1;
2173: }
2174: }
2175: }
2176: #
2177: # New and unknown keys
2178: foreach my $student (sort keys(%currentlist)) {
2179: unless ($existing{$student}) {
2180: $changed=1;
2181: $sheet->{'maxrow'}++;
2182: $f{'A'.$sheet->{'maxrow'}}=$student;
2183: }
2184: }
2185: if ($changed) {
2186: $sheet->{'f'} = \%f;
2187: &setformulas($sheet,%f);
2188: }
2189: #
2190: &setrowlabels($sheet,\%currentlist);
2191: }
2192:
2193: # ----------------------------------- Update rows for student and assess sheets
2194: sub get_student_rowlabels {
2195: my ($sheet) = @_;
2196: #
2197: my %course_db;
2198: #
2199: my $stype = $sheet->{'sheettype'};
2200: my $uname = $sheet->{'uname'};
2201: my $udom = $sheet->{'udom'};
2202: #
2203: $sheet->{'rowlabel'} = {};
2204: #
2205: my $identifier =$sheet->{'coursefilename'}.'_'.$stype;
2206: if ($rowlabel_cache{$identifier}) {
2207: %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier});
2208: } else {
2209: # Get the data and store it in the cache
2210: # Tie hash
2211: tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db',
2212: &GDBM_READER(),0640);
2213: if (! tied(%course_db)) {
2214: return 'Could not access course data';
2215: }
2216: #
2217: my %assesslist;
2218: foreach ('Feedback','Evaluation','Tutoring','Discussion') {
2219: my $symb = '_'.lc($_);
2220: $assesslist{$symb} = join(':',('symb',$symb,$uname,$udom,0,0,$_));
2221: }
2222: #
2223: while (my ($key,$srcf) = each(%course_db)) {
2224: next if ($key !~ /^src_(\d+)\.(\d+)$/);
2225: my $mapid = $1;
2226: my $resid = $2;
2227: my $id = $mapid.'.'.$resid;
2228: if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {
2229: my $symb=
2230: &Apache::lonnet::declutter($course_db{'map_id_'.$mapid}).
2231: '___'.$resid.'___'.&Apache::lonnet::declutter($srcf);
2232: $assesslist{$symb}='symb:'.&Apache::lonnet::escape($symb).':'
2233: .$uname.':'.$udom.':'.$mapid.':'.$resid.':'.
2234: $course_db{'title_'.$id};
2235: }
2236: }
2237: untie(%course_db);
2238: # Store away the data
2239: $sheet->{'rowlabel'} = \%assesslist;
2240: $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}});
2241: }
2242:
2243: }
2244:
2245: sub get_assess_rowlabels {
2246: my ($sheet) = @_;
2247: #
2248: my %course_db;
2249: #
2250: my $stype = $sheet->{'sheettype'};
2251: my $uname = $sheet->{'uname'};
2252: my $udom = $sheet->{'udom'};
2253: my $usymb = $sheet->{'usymb'};
2254: #
2255: $sheet->{'rowlabel'} = {};
2256: my $identifier =$sheet->{'coursefilename'}.'_'.$stype.'_'.$usymb;
2257: #
2258: if ($rowlabel_cache{$identifier}) {
2259: %{$sheet->{'rowlabel'}}=split(/___;___/,$rowlabel_cache{$identifier});
2260: } else {
2261: # Get the data and store it in the cache
2262: # Tie hash
2263: tie(%course_db,'GDBM_File',$sheet->{'coursefilename'}.'.db',
2264: &GDBM_READER(),0640);
2265: if (! tied(%course_db)) {
2266: return 'Could not access course data';
2267: }
2268: #
2269: my %parameter_labels=
2270: ('timestamp' =>
2271: 'parameter:Timestamp of Last Transaction<br>timestamp',
2272: 'subnumber' =>
2273: 'parameter:Number of Submissions<br>subnumber',
2274: 'tutornumber' =>
2275: 'parameter:Number of Tutor Responses<br>tutornumber',
2276: 'totalpoints' =>
2277: 'parameter:Total Points Granted<br>totalpoints');
2278: while (my ($key,$srcf) = each(%course_db)) {
2279: next if ($key !~ /^src_(\d+)\.(\d+)$/);
2280: my $mapid = $1;
2281: my $resid = $2;
2282: my $id = $mapid.'.'.$resid;
2283: if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {
2284: # Loop through the metadata for this key
2285: my @Metadata = split(/,/,
2286: &Apache::lonnet::metadata($srcf,'keys'));
2287: foreach my $key (@Metadata) {
2288: next if ($key !~ /^(stores|parameter)_/);
2289: my $display=
2290: &Apache::lonnet::metadata($srcf,$key.'.display');
2291: unless ($display) {
2292: $display.=
2293: &Apache::lonnet::metadata($srcf,$key.'.name');
2294: }
2295: $display.='<br>'.$key;
2296: $parameter_labels{$key}='parameter:'.$display;
2297: } # end of foreach
2298: }
2299: }
2300: untie(%course_db);
2301: # Store away the results
2302: $sheet->{'rowlabel'} = \%parameter_labels;
2303: $rowlabel_cache{$identifier}=join('___;___',%{$sheet->{'rowlabel'}});
2304: }
2305:
2306: }
2307:
2308: sub updatestudentassesssheet {
2309: my $sheet = shift;
2310: if ($sheet->{'sheettype'} eq 'studentcalc') {
2311: &get_student_rowlabels($sheet);
2312: } else {
2313: &get_assess_rowlabels($sheet);
2314: }
2315: # Determine if any of the information has changed
2316: my %f=&getformulas($sheet);
2317: my $changed=0;
2318:
2319: $sheet->{'maxrow'} = 0;
2320: my %existing=();
2321: # Now obsolete rows
2322: foreach my $cell (keys(%f)) {
2323: my $formula = $f{$cell};
2324: next if ($cell !~ /^A(\d+)/);
2325: $sheet->{'maxrow'} = $1 if ($1 > $sheet->{'maxrow'});
2326: my ($usy,$ufn)=split(/__&&&\__/,$formula);
2327: $existing{$usy}=1;
2328: unless ((exists($sheet->{'rowlabel'}->{$usy}) &&
2329: (defined($sheet->{'rowlabel'}->{$usy})) || (!$1) ||
2330: ($formula =~ /^(~~~|---)/) )) {
2331: $f{$_}='!!! Obsolete';
2332: $changed=1;
2333: } elsif ($ufn) {
2334: # I do not think this works any more
2335: $sheet->{'rowlabel'}->{$usy}
2336: =~s/assesscalc\?usymb\=/assesscalc\?ufn\=$ufn&\usymb\=/;
2337: }
2338: }
2339: # New and unknown keys
2340: foreach (keys(%{$sheet->{'rowlabel'}})) {
2341: unless ($existing{$_}) {
2342: $changed=1;
2343: $sheet->{'maxrow'}++;
2344: $f{'A'.$sheet->{'maxrow'}}=$_;
2345: }
2346: }
2347: if ($changed) {
2348: $sheet->{'f'} = \%f;
2349: &setformulas($sheet);
2350: }
2351: }
2352:
2353: # ------------------------------------------------ Load data for one assessment
2354:
2355: sub loadstudent{
2356: my ($sheet,$r,$c)=@_;
2357: my %constants=();
2358: my %formulas=&getformulas($sheet);
2359: $cachedassess=$sheet->{'uname'}.':'.$sheet->{'udom'};
2360: # Get ALL the student preformance data
2361: my @tmp = &Apache::lonnet::dump($sheet->{'cid'},
2362: $sheet->{'udom'},
2363: $sheet->{'uname'},
2364: undef);
2365: if ($tmp[0] !~ /^error:/) {
2366: %cachedstores = @tmp;
2367: }
2368: undef @tmp;
2369: #
2370: my @assessdata=();
2371: foreach my $cell (keys(%formulas)) {
2372: my $value = $formulas{$cell};
2373: if(defined($c) && ($c->aborted())) {
2374: last;
2375: }
2376: next if ($cell !~ /^A(\d+)/);
2377: my $row=$1;
2378: next if (($value =~ /^[!~-]/) || ($row==0));
2379: my ($usy,$ufn)=split(/__&&&\__/,$value);
2380: @assessdata=&exportsheet($sheet,$sheet->{'uname'},
2381: $sheet->{'udom'},
2382: 'assesscalc',$usy,$ufn,$r);
2383: my $index=0;
2384: foreach my $col ('A','B','C','D','E','F','G','H','I','J','K','L','M',
2385: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') {
2386: if (defined($assessdata[$index])) {
2387: if ($assessdata[$index]=~/\D/) {
2388: $constants{$col.$row}="'".$assessdata[$index]."'";
2389: } else {
2390: $constants{$col.$row}=$assessdata[$index];
2391: }
2392: $formulas{$col.$row}='import' if ($col ne 'A');
2393: }
2394: $index++;
2395: }
2396: }
2397: $cachedassess='';
2398: undef %cachedstores;
2399: $sheet->{'f'} = \%formulas;
2400: &setformulas($sheet);
2401: &setconstants($sheet,\%constants);
2402: }
2403:
2404: # --------------------------------------------------- Load data for one student
2405: #
2406: sub loadcourse {
2407: my ($sheet,$r,$c)=@_;
2408: #
2409: my %constants=();
2410: my %formulas=&getformulas($sheet);
2411: #
2412: my $total=0;
2413: foreach (keys(%formulas)) {
2414: if ($_=~/^A(\d+)/) {
2415: unless ($formulas{$_}=~/^[\!\~\-]/) { $total++; }
2416: }
2417: }
2418: my $now=0;
2419: my $since=time;
2420: $r->print(<<ENDPOP);
2421: <script>
2422: popwin=open('','popwin','width=400,height=100');
2423: popwin.document.writeln('<html><body bgcolor="#FFFFFF">'+
2424: '<h3>Spreadsheet Calculation Progress</h3>'+
2425: '<form name=popremain>'+
2426: '<input type=text size=35 name=remaining value=Starting></form>'+
2427: '</body></html>');
2428: popwin.document.close();
2429: </script>
2430: ENDPOP
2431: $r->rflush();
2432: foreach (keys(%formulas)) {
2433: if(defined($c) && ($c->aborted())) {
2434: last;
2435: }
2436: next if ($_!~/^A(\d+)/);
2437: my $row=$1;
2438: next if (($formulas{$_}=~/^[\!\~\-]/) || ($row==0));
2439: my ($sname,$sdom) = split(':',$formulas{$_});
2440: my @studentdata=&exportsheet($sheet,$sname,$sdom,'studentcalc',
2441: undef,undef,$r);
2442: undef %userrdatas;
2443: $now++;
2444: $r->print('<script>popwin.document.popremain.remaining.value="'.
2445: $now.'/'.$total.': '.int((time-$since)/$now*($total-$now)).
2446: ' secs remaining";</script>');
2447: $r->rflush();
2448: #
2449: my $index=0;
2450: foreach ('A','B','C','D','E','F','G','H','I','J','K','L','M',
2451: 'N','O','P','Q','R','S','T','U','V','W','X','Y','Z') {
2452: if (defined($studentdata[$index])) {
2453: my $col=$_;
2454: if ($studentdata[$index]=~/\D/) {
2455: $constants{$col.$row}="'".$studentdata[$index]."'";
2456: } else {
2457: $constants{$col.$row}=$studentdata[$index];
2458: }
2459: unless ($col eq 'A') {
2460: $formulas{$col.$row}='import';
2461: }
2462: }
2463: $index++;
2464: }
2465: }
2466: $sheet->{'f'}=\%formulas;
2467: &setformulas($sheet);
2468: &setconstants($sheet,\%constants);
2469: $r->print('<script>popwin.close()</script>');
2470: $r->rflush();
2471: }
2472:
2473: # ------------------------------------------------ Load data for one assessment
2474: #
2475: sub loadassessment {
2476: my ($sheet,$r,$c)=@_;
2477:
2478: my $uhome = $sheet->{'uhome'};
2479: my $uname = $sheet->{'uname'};
2480: my $udom = $sheet->{'udom'};
2481: my $symb = $sheet->{'usymb'};
2482: my $cid = $sheet->{'cid'};
2483: my $cnum = $sheet->{'cnum'};
2484: my $cdom = $sheet->{'cdom'};
2485: my $chome = $sheet->{'chome'};
2486:
2487: my $namespace;
2488: unless ($namespace=$cid) { return ''; }
2489: # Get stored values
2490: my %returnhash=();
2491: if ($cachedassess eq $uname.':'.$udom) {
2492: #
2493: # get data out of the dumped stores
2494: #
2495: my $version=$cachedstores{'version:'.$symb};
2496: my $scope;
2497: for ($scope=1;$scope<=$version;$scope++) {
2498: foreach (split(/\:/,$cachedstores{$scope.':keys:'.$symb})) {
2499: $returnhash{$_}=$cachedstores{$scope.':'.$symb.':'.$_};
2500: }
2501: }
2502: } else {
2503: #
2504: # restore individual
2505: #
2506: %returnhash = &Apache::lonnet::restore($symb,$namespace,$udom,$uname);
2507: for (my $version=1;$version<=$returnhash{'version'};$version++) {
2508: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2509: $returnhash{$_}=$returnhash{$version.':'.$_};
2510: }
2511: }
2512: }
2513: #
2514: # returnhash now has all stores for this resource
2515: # convert all "_" to "." to be able to use libraries, multiparts, etc
2516: #
2517: # This is dumb. It is also necessary :(
2518: my @oldkeys=keys %returnhash;
2519: #
2520: foreach my $name (@oldkeys) {
2521: my $value=$returnhash{$name};
2522: delete $returnhash{$name};
2523: $name=~s/\_/\./g;
2524: $returnhash{$name}=$value;
2525: }
2526: # initialize coursedata and userdata for this user
2527: undef %courseopt;
2528: undef %useropt;
2529:
2530: my $userprefix=$uname.'_'.$udom.'_';
2531:
2532: unless ($uhome eq 'no_host') {
2533: # Get coursedata
2534: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
2535: my %Tmp = &Apache::lonnet::dump('resourcedata',$cdom,$cnum);
2536: $courserdatas{$cid}=\%Tmp;
2537: $courserdatas{$cid.'.last_cache'}=time;
2538: }
2539: while (my ($name,$value) = each(%{$courserdatas{$cid}})) {
2540: $courseopt{$userprefix.$name}=$value;
2541: }
2542: # Get userdata (if present)
2543: unless ((time-$userrdatas{$uname.'@'.$udom.'.last_cache'})<240) {
2544: my %Tmp = &Apache::lonnet::dump('resourcedata',$udom,$uname);
2545: $userrdatas{$cid} = \%Tmp;
2546: # Most of the time the user does not have a 'resourcedata.db'
2547: # file. We need to cache that we got nothing instead of bothering
2548: # with requesting it every time.
2549: $userrdatas{$uname.'@'.$udom.'.last_cache'}=time;
2550: }
2551: while (my ($name,$value) = each(%{$userrdatas{$cid}})) {
2552: $useropt{$userprefix.$name}=$value;
2553: }
2554: }
2555: # now courseopt, useropt initialized for this user and course
2556: # (used by parmval)
2557: #
2558: # Load keys for this assessment only
2559: #
2560: my %thisassess=();
2561: my ($symap,$syid,$srcf)=split(/\_\_\_/,$symb);
2562: foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'keys'))) {
2563: $thisassess{$_}=1;
2564: }
2565: #
2566: # Load parameters
2567: #
2568: my %c=();
2569: if (tie(%parmhash,'GDBM_File',
2570: $sheet->{'coursefilename'}.'_parms.db',&GDBM_READER(),0640)) {
2571: my %f=&getformulas($sheet);
2572: foreach my $cell (keys(%f)) {
2573: next if ($cell !~ /^A/);
2574: next if ($f{$cell} =~/^[\!\~\-]/);
2575: if ($f{$cell}=~/^parameter/) {
2576: if (defined($thisassess{$f{$cell}})) {
2577: my $val = &parmval($f{$cell},$sheet);
2578: $c{$cell} = $val;
2579: $c{$f{$cell}} = $val;
2580: }
2581: } else {
2582: my $key=$f{$cell};
2583: my $ckey=$key;
2584: $key=~s/^stores\_/resource\./;
2585: $key=~s/\_/\./g;
2586: $c{$cell}=$returnhash{$key};
2587: $c{$ckey}=$returnhash{$key};
2588: }
2589: }
2590: untie(%parmhash);
2591: }
2592: &setconstants($sheet,\%c);
2593: }
2594:
2595: # --------------------------------------------------------- Various form fields
2596:
2597: sub textfield {
2598: my ($title,$name,$value)=@_;
2599: return "\n<p><b>$title:</b><br>".
2600: '<input type=text name="'.$name.'" size=80 value="'.$value.'">';
2601: }
2602:
2603: sub hiddenfield {
2604: my ($name,$value)=@_;
2605: return "\n".'<input type=hidden name="'.$name.'" value="'.$value.'">';
2606: }
2607:
2608: sub selectbox {
2609: my ($title,$name,$value,%options)=@_;
2610: my $selout="\n<p><b>$title:</b><br>".'<select name="'.$name.'">';
2611: foreach (sort keys(%options)) {
2612: $selout.='<option value="'.$_.'"';
2613: if ($_ eq $value) { $selout.=' selected'; }
2614: $selout.='>'.$options{$_}.'</option>';
2615: }
2616: return $selout.'</select>';
2617: }
2618:
2619: # =============================================== Update information in a sheet
2620: #
2621: # Add new users or assessments, etc.
2622: #
2623:
2624: sub updatesheet {
2625: my ($sheet)=@_;
2626: if ($sheet->{'sheettype'} eq 'classcalc') {
2627: return &updateclasssheet($sheet);
2628: } else {
2629: return &updatestudentassesssheet($sheet);
2630: }
2631: }
2632:
2633: # =================================================== Load the rows for a sheet
2634: #
2635: # Import the data for rows
2636: #
2637:
2638: sub loadrows {
2639: my ($sheet,$r)=@_;
2640: my $c = $r->connection;
2641: my $stype=$sheet->{'sheettype'};
2642: if ($stype eq 'classcalc') {
2643: &loadcourse($sheet,$r,$c);
2644: } elsif ($stype eq 'studentcalc') {
2645: &loadstudent($sheet,$r,$c);
2646: } else {
2647: &loadassessment($sheet,$r,$c);
2648: }
2649: }
2650:
2651: # ======================================================= Forced recalculation?
2652:
2653: sub checkthis {
2654: my ($keyname,$time)=@_;
2655: if (! exists($expiredates{$keyname})) {
2656: return 0;
2657: } else {
2658: return ($time<$expiredates{$keyname});
2659: }
2660: }
2661:
2662: sub forcedrecalc {
2663: my ($uname,$udom,$stype,$usymb)=@_;
2664: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2665: my $time=$oldsheets{$key.'.time'};
2666: if ($ENV{'form.forcerecalc'}) { return 1; }
2667: unless ($time) { return 1; }
2668: if ($stype eq 'assesscalc') {
2669: my $map=(split(/___/,$usymb))[0];
2670: if (&checkthis('::assesscalc:',$time) ||
2671: &checkthis('::assesscalc:'.$map,$time) ||
2672: &checkthis('::assesscalc:'.$usymb,$time) ||
2673: &checkthis($uname.':'.$udom.':assesscalc:',$time) ||
2674: &checkthis($uname.':'.$udom.':assesscalc:'.$map,$time) ||
2675: &checkthis($uname.':'.$udom.':assesscalc:'.$usymb,$time)) {
2676: return 1;
2677: }
2678: } else {
2679: if (&checkthis('::studentcalc:',$time) ||
2680: &checkthis($uname.':'.$udom.':studentcalc:',$time)) {
2681: return 1;
2682: }
2683: }
2684: return 0;
2685: }
2686:
2687: # ============================================================== Export handler
2688: # exportsheet
2689: # returns the export row for a spreadsheet.
2690: #
2691: sub exportsheet {
2692: my ($sheet,$uname,$udom,$stype,$usymb,$fn,$r)=@_;
2693: my $flag = 0;
2694: $uname = $uname || $sheet->{'uname'};
2695: $udom = $udom || $sheet->{'udom'};
2696: $stype = $stype || $sheet->{'sheettype'};
2697: my @exportarr=();
2698: if (defined($usymb) && ($usymb=~/^\_(\w+)/) &&
2699: (!defined($fn) || $fn eq '')) {
2700: $fn='default_'.$1;
2701: }
2702: #
2703: # Check if cached
2704: #
2705: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2706: my $found='';
2707: if ($oldsheets{$key}) {
2708: foreach (split(/___&\___/,$oldsheets{$key})) {
2709: my ($name,$value)=split(/___=___/,$_);
2710: if ($name eq $fn) {
2711: $found=$value;
2712: }
2713: }
2714: }
2715: unless ($found) {
2716: &cachedssheets($sheet,$uname,$udom);
2717: if ($oldsheets{$key}) {
2718: foreach (split(/___&\___/,$oldsheets{$key})) {
2719: my ($name,$value)=split(/___=___/,$_);
2720: if ($name eq $fn) {
2721: $found=$value;
2722: }
2723: }
2724: }
2725: }
2726: #
2727: # Check if still valid
2728: #
2729: if ($found) {
2730: if (&forcedrecalc($uname,$udom,$stype,$usymb)) {
2731: $found='';
2732: }
2733: }
2734: if ($found) {
2735: #
2736: # Return what was cached
2737: #
2738: @exportarr=split(/___;___/,$found);
2739: return @exportarr;
2740: }
2741: #
2742: # Not cached
2743: #
2744: my ($newsheet)=&makenewsheet($uname,$udom,$stype,$usymb);
2745: &readsheet($newsheet,$fn);
2746: &updatesheet($newsheet);
2747: &loadrows($newsheet,$r);
2748: &calcsheet($newsheet);
2749: @exportarr=&exportdata($newsheet);
2750: ##
2751: ## Store now
2752: ##
2753: #
2754: # load in the old value
2755: #
2756: my %currentlystored=();
2757: if ($stype eq 'studentcalc') {
2758: my @tmp = &Apache::lonnet::get('nohist_calculatedsheets',
2759: [$key],
2760: $sheet->{'cdom'},$sheet->{'cnum'});
2761: if ($tmp[0]!~/^error/) {
2762: # We only got one key, so we will access it directly.
2763: foreach (split('___&___',$tmp[1])) {
2764: my ($key,$value) = split('___=___',$_);
2765: $key = '' if (! defined($key));
2766: $currentlystored{$key} = $value;
2767: }
2768: }
2769: } else {
2770: my @tmp = &Apache::lonnet::get('nohist_calculatedsheets_'.
2771: $sheet->{'cid'},[$key],
2772: $sheet->{'udom'},$sheet->{'uname'});
2773: if ($tmp[0]!~/^error/) {
2774: # We only got one key, so we will access it directly.
2775: foreach (split('___&___',$tmp[1])) {
2776: my ($key,$value) = split('___=___',$_);
2777: $key = '' if (! defined($key));
2778: $currentlystored{$key} = $value;
2779: }
2780: }
2781: }
2782: #
2783: # Add the new line
2784: #
2785: $currentlystored{$fn}=join('___;___',@exportarr);
2786: #
2787: # Stick everything back together
2788: #
2789: my $newstore='';
2790: foreach (keys(%currentlystored)) {
2791: if ($newstore) { $newstore.='___&___'; }
2792: $newstore.=$_.'___=___'.$currentlystored{$_};
2793: }
2794: my $now=time;
2795: #
2796: # Store away the new value
2797: #
2798: my $timekey = $key.'.time';
2799: if ($stype eq 'studentcalc') {
2800: my $result = &Apache::lonnet::put('nohist_calculatedsheets',
2801: { $key => $newstore,
2802: $timekey => $now },
2803: $sheet->{'cdom'},
2804: $sheet->{'cnum'});
2805: } else {
2806: my $result = &Apache::lonnet::put('nohist_calculatedsheets_'.$sheet->{'cid'},
2807: { $key => $newstore,
2808: $timekey => $now },
2809: $sheet->{'udom'},
2810: $sheet->{'uname'});
2811: }
2812: return @exportarr;
2813: }
2814:
2815: # ============================================================ Expiration Dates
2816: #
2817: # Load previously cached student spreadsheets for this course
2818: #
2819: sub load_spreadsheet_expirationdates {
2820: undef %expiredates;
2821: my $cid=$ENV{'request.course.id'};
2822: my @tmp = &Apache::lonnet::dump('nohist_expirationdates',
2823: $ENV{'course.'.$cid.'.domain'},
2824: $ENV{'course.'.$cid.'.num'});
2825: if (lc($tmp[0]) !~ /^error/){
2826: %expiredates = @tmp;
2827: }
2828: }
2829:
2830: # ===================================================== Calculated sheets cache
2831: #
2832: # Load previously cached student spreadsheets for this course
2833: #
2834:
2835: sub cachedcsheets {
2836: my $cid=$ENV{'request.course.id'};
2837: my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
2838: $ENV{'course.'.$cid.'.domain'},
2839: $ENV{'course.'.$cid.'.num'});
2840: if ($tmp[0] !~ /^error/) {
2841: my %StupidTempHash = @tmp;
2842: while (my ($key,$value) = each %StupidTempHash) {
2843: $oldsheets{$key} = $value;
2844: }
2845: }
2846: }
2847:
2848: # ===================================================== Calculated sheets cache
2849: #
2850: # Load previously cached assessment spreadsheets for this student
2851: #
2852:
2853: sub cachedssheets {
2854: my ($sheet,$uname,$udom) = @_;
2855: $uname = $uname || $sheet->{'uname'};
2856: $udom = $udom || $sheet->{'udom'};
2857: if (! $loadedcaches{$uname.'_'.$udom}) {
2858: my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets',
2859: $sheet->{'udom'},
2860: $sheet->{'uname'});
2861: if ($tmp[0] !~ /^error/) {
2862: my %TempHash = @tmp;
2863: my $count = 0;
2864: while (my ($key,$value) = each %TempHash) {
2865: $oldsheets{$key} = $value;
2866: $count++;
2867: }
2868: $loadedcaches{$sheet->{'uname'}.'_'.$sheet->{'udom'}}=1;
2869: }
2870: }
2871:
2872: }
2873:
2874: # ===================================================== Calculated sheets cache
2875: #
2876: # Load previously cached assessment spreadsheets for this student
2877: #
2878:
2879: # ================================================================ Main handler
2880: #
2881: # Interactive call to screen
2882: #
2883: #
2884: sub handler {
2885: my $r=shift;
2886:
2887: my ($sheettype) = ($r->uri=~/\/(\w+)$/);
2888:
2889: if (! exists($ENV{'form.Status'})) {
2890: $ENV{'form.Status'} = 'Active';
2891: }
2892: if ( ! exists($ENV{'form.output'}) ||
2893: ($sheettype ne 'classcalc' &&
2894: lc($ENV{'form.output'}) eq 'recursive excel')) {
2895: $ENV{'form.output'} = 'HTML';
2896: }
2897: #
2898: # Overload checking
2899: #
2900: # Check this server
2901: my $loaderror=&Apache::lonnet::overloaderror($r);
2902: if ($loaderror) { return $loaderror; }
2903: # Check the course homeserver
2904: $loaderror= &Apache::lonnet::overloaderror($r,
2905: $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
2906: if ($loaderror) { return $loaderror; }
2907: #
2908: # HTML Header
2909: #
2910: if ($r->header_only) {
2911: $r->content_type('text/html');
2912: $r->send_http_header;
2913: return OK;
2914: }
2915: #
2916: # Global directory configs
2917: #
2918: $includedir = $r->dir_config('lonIncludes');
2919: $tmpdir = $r->dir_config('lonDaemons').'/tmp/';
2920: #
2921: # Roles Checking
2922: #
2923: # Needs to be in a course
2924: if (! $ENV{'request.course.fn'}) {
2925: # Not in a course, or not allowed to modify parms
2926: $ENV{'user.error.msg'}=
2927: $r->uri.":opa:0:0:Cannot modify spreadsheet";
2928: return HTTP_NOT_ACCEPTABLE;
2929: }
2930: #
2931: # Get query string for limited number of parameters
2932: #
2933: &Apache::loncommon::get_unprocessed_cgi
2934: ($ENV{'QUERY_STRING'},['uname','udom','usymb','ufn','mapid','resid']);
2935: #
2936: # Deal with restricted student permissions
2937: #
2938: if ($ENV{'request.role'} =~ /^st\./) {
2939: delete $ENV{'form.unewfield'} if (exists($ENV{'form.unewfield'}));
2940: delete $ENV{'form.unewformula'} if (exists($ENV{'form.unewformula'}));
2941: }
2942: #
2943: # Clean up symb and spreadsheet filename
2944: #
2945: if (($ENV{'form.usymb'}=~/^\_(\w+)/) && (!$ENV{'form.ufn'})) {
2946: $ENV{'form.ufn'}='default_'.$1;
2947: }
2948: #
2949: # Interactive loading of specific sheet?
2950: #
2951: if (($ENV{'form.load'}) && ($ENV{'form.loadthissheet'} ne 'Default')) {
2952: $ENV{'form.ufn'}=$ENV{'form.loadthissheet'};
2953: }
2954: #
2955: # Determine the user name and domain for the sheet.
2956: my $aname;
2957: my $adom;
2958: unless ($ENV{'form.uname'}) {
2959: $aname=$ENV{'user.name'};
2960: $adom=$ENV{'user.domain'};
2961: } else {
2962: $aname=$ENV{'form.uname'};
2963: $adom=$ENV{'form.udom'};
2964: }
2965: #
2966: # Open page, try to prevent browser cache.
2967: #
2968: $r->content_type('text/html');
2969: $r->header_out('Cache-control','no-cache');
2970: $r->header_out('Pragma','no-cache');
2971: $r->send_http_header;
2972: #
2973: # Header....
2974: #
2975: $r->print('<html><head><title>LON-CAPA Spreadsheet</title>');
2976: my $nothing = "''";
2977: if ($ENV{'browser.type'} eq 'explorer') {
2978: $nothing = "'javascript:void(0);'";
2979: }
2980:
2981: if ($ENV{'request.role'} !~ /^st\./) {
2982: $r->print(<<ENDSCRIPT);
2983: <script language="JavaScript">
2984:
2985: var editwin;
2986:
2987: function celledit(cellname,cellformula) {
2988: var edit_text = '';
2989: edit_text +='<html><head><title>Cell Edit Window</title></head><body>';
2990: edit_text += '<form name="editwinform">';
2991: edit_text += '<center><h3>Cell '+cellname+'</h3>';
2992: edit_text += '<textarea name="newformula" cols="40" rows="6"';
2993: edit_text += ' wrap="off" >'+cellformula+'</textarea>';
2994: edit_text += '</br>';
2995: edit_text += '<input type="button" name="accept" value="Accept"';
2996: edit_text += ' onClick=\\\'javascript:';
2997: edit_text += 'opener.document.sheet.unewfield.value=';
2998: edit_text += '"'+cellname+'";';
2999: edit_text += 'opener.document.sheet.unewformula.value=';
3000: edit_text += 'document.editwinform.newformula.value;';
3001: edit_text += 'opener.document.sheet.submit();';
3002: edit_text += 'self.close()\\\' />';
3003: edit_text += ' ';
3004: edit_text += '<input type="button" name="abort" ';
3005: edit_text += 'value="Discard Changes"';
3006: edit_text += ' onClick="javascript:self.close()" />';
3007: edit_text += '</center></body></html>';
3008:
3009: if (editwin != null && !(editwin.closed) ) {
3010: editwin.close();
3011: }
3012:
3013: editwin = window.open($nothing,'CellEditWin','height=200,width=350,scrollbars=no,resizeable=yes,alwaysRaised=yes,dependent=yes',true);
3014: editwin.document.write(edit_text);
3015: }
3016:
3017: function changesheet(cn) {
3018: document.sheet.unewfield.value=cn;
3019: document.sheet.unewformula.value='changesheet';
3020: document.sheet.submit();
3021: }
3022:
3023: function insertrow(cn) {
3024: document.sheet.unewfield.value='insertrow';
3025: document.sheet.unewformula.value=cn;
3026: document.sheet.submit();
3027: }
3028:
3029: </script>
3030: ENDSCRIPT
3031: }
3032: $r->print('</head>'.&Apache::loncommon::bodytag('Grades Spreadsheet').
3033: '<form action="'.$r->uri.'" name="sheet" method="post">');
3034: $r->print(&hiddenfield('uname',$ENV{'form.uname'}).
3035: &hiddenfield('udom',$ENV{'form.udom'}).
3036: &hiddenfield('usymb',$ENV{'form.usymb'}).
3037: &hiddenfield('unewfield','').
3038: &hiddenfield('unewformula',''));
3039: $r->rflush();
3040: #
3041: # Full recalc?
3042: #
3043: if ($ENV{'form.forcerecalc'}) {
3044: $r->print('<h4>Completely Recalculating Sheet ...</h4>');
3045: undef %spreadsheets;
3046: undef %courserdatas;
3047: undef %userrdatas;
3048: undef %defaultsheets;
3049: undef %rowlabel_cache;
3050: }
3051: # Read new sheet or modified worksheet
3052: my ($sheet)=&makenewsheet($aname,$adom,$sheettype,$ENV{'form.usymb'});
3053: #
3054: # Check user permissions
3055: if (($sheet->{'sheettype'} eq 'classcalc' ) ||
3056: ($sheet->{'uname'} ne $ENV{'user.name'} ) ||
3057: ($sheet->{'udom'} ne $ENV{'user.domain'})) {
3058: unless (&Apache::lonnet::allowed('vgr',$sheet->{'cid'})) {
3059: $r->print('<h1>Access Permission Denied</h1>'.
3060: '</form></body></html>');
3061: return OK;
3062: }
3063: }
3064: # Print out user information
3065: $r->print('<h2>'.$sheet->{'coursedesc'}.'</h2>');
3066: if ($sheet->{'sheettype'} ne 'classcalc') {
3067: $r->print('<h2>'.&gettitle($sheet).'</h2><p>');
3068: }
3069: if ($sheet->{'sheettype'} eq 'assesscalc') {
3070: $r->print('<b>User:</b> '.$sheet->{'uname'}.
3071: '<br /><b>Domain:</b> '.$sheet->{'udom'}.'<br />');
3072: }
3073: if ($sheet->{'sheettype'} eq 'studentcalc' ||
3074: $sheet->{'sheettype'} eq 'assesscalc') {
3075: $r->print('<b>Section/Group:</b>'.$sheet->{'csec'}.'</p>');
3076: }
3077: #
3078: # If a new formula had been entered, go from work copy
3079: if ($ENV{'form.unewfield'}) {
3080: $r->print('<h2>Modified Workcopy</h2>');
3081: $ENV{'form.unewformula'}=~s/\'/\"/g;
3082: $r->print('<p>New formula: '.$ENV{'form.unewfield'}.'='.
3083: $ENV{'form.unewformula'}.'<p>');
3084: $sheet->{'filename'} = $ENV{'form.ufn'};
3085: &tmpread($sheet,$ENV{'form.unewfield'},$ENV{'form.unewformula'});
3086: } elsif ($ENV{'form.saveas'}) {
3087: $sheet->{'filename'} = $ENV{'form.ufn'};
3088: &tmpread($sheet);
3089: } else {
3090: &readsheet($sheet,$ENV{'form.ufn'});
3091: }
3092: # Additional options
3093: if ($sheet->{'sheettype'} eq 'assesscalc') {
3094: $r->print('<p><font size=+2>'.
3095: '<a href="/adm/studentcalc?'.
3096: 'uname='.$sheet->{'uname'}.
3097: '&udom='.$sheet->{'udom'}.'">'.
3098: 'Level up: Student Sheet</a></font></p>');
3099: }
3100: if (($sheet->{'sheettype'} eq 'studentcalc') &&
3101: (&Apache::lonnet::allowed('vgr',$sheet->{'cid'}))) {
3102: $r->print ('<p><font size=+2><a href="/adm/classcalc">'.
3103: 'Level up: Course Sheet</a></font></p>');
3104: }
3105: # Recalc button
3106: $r->print('<br />'.
3107: '<input type="submit" name="forcerecalc" '.
3108: 'value="Completely Recalculate Sheet"></p>');
3109: # Save dialog
3110: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3111: my $fname=$ENV{'form.ufn'};
3112: $fname=~s/\_[^\_]+$//;
3113: if ($fname eq 'default') { $fname='course_default'; }
3114: $r->print('<input type=submit name=saveas value="Save as ...">'.
3115: '<input type=text size=20 name=newfn value="'.$fname.'">'.
3116: 'make default: <input type=checkbox name="makedefufn"><p>');
3117: }
3118: $r->print(&hiddenfield('ufn',$sheet->{'filename'}));
3119: # Load dialog
3120: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3121: $r->print('<p><input type=submit name=load value="Load ...">'.
3122: '<select name="loadthissheet">'.
3123: '<option name="default">Default</option>');
3124: foreach (&othersheets($sheet)) {
3125: $r->print('<option name="'.$_.'"');
3126: if ($ENV{'form.ufn'} eq $_) {
3127: $r->print(' selected');
3128: }
3129: $r->print('>'.$_.'</option>');
3130: }
3131: $r->print('</select><p>');
3132: if ($sheet->{'sheettype'} eq 'studentcalc') {
3133: &setothersheets($sheet,
3134: &othersheets($sheet,'assesscalc'));
3135: }
3136: }
3137: #
3138: # Set up caching mechanisms
3139: #
3140: &load_spreadsheet_expirationdates();
3141: # Clear out old caches if we have not seen this class before.
3142: if (exists($oldsheets{'course'}) &&
3143: $oldsheets{'course'} ne $sheet->{'cid'}) {
3144: undef %oldsheets;
3145: undef %loadedcaches;
3146: }
3147: $oldsheets{'course'} = $sheet->{'cid'};
3148: #
3149: if ($sheet->{'sheettype'} eq 'classcalc') {
3150: $r->print("Loading previously calculated student sheets ...\n");
3151: $r->rflush();
3152: &cachedcsheets();
3153: } elsif ($sheet->{'sheettype'} eq 'studentcalc') {
3154: $r->print("Loading previously calculated assessment sheets ...\n");
3155: $r->rflush();
3156: &cachedssheets($sheet);
3157: }
3158: # Update sheet, load rows
3159: $r->print("Loaded sheet(s), updating rows ...<br>\n");
3160: $r->rflush();
3161: #
3162: &updatesheet($sheet);
3163: $r->print("Updated rows, loading row data ...\n");
3164: $r->rflush();
3165: #
3166: &loadrows($sheet,$r);
3167: $r->print("Loaded row data, calculating sheet ...<br>\n");
3168: $r->rflush();
3169: #
3170: my $calcoutput=&calcsheet($sheet);
3171: $r->print('<h3><font color=red>'.$calcoutput.'</h3></font>');
3172: # See if something to save
3173: if (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'})) {
3174: my $fname='';
3175: if ($ENV{'form.saveas'} && ($fname=$ENV{'form.newfn'})) {
3176: $fname=~s/\W/\_/g;
3177: if ($fname eq 'default') { $fname='course_default'; }
3178: $fname.='_'.$sheet->{'sheettype'};
3179: $sheet->{'filename'} = $fname;
3180: $ENV{'form.ufn'}=$fname;
3181: $r->print('<p>Saving spreadsheet: '.
3182: &writesheet($sheet,$ENV{'form.makedefufn'}).
3183: '<p>');
3184: }
3185: }
3186: #
3187: # Write the modified worksheet
3188: $r->print('<b>Current sheet:</b> '.$sheet->{'filename'}.'</p>');
3189: &tmpwrite($sheet);
3190: if ($sheet->{'sheettype'} eq 'assesscalc') {
3191: $r->print('<p>Show rows with empty A column: ');
3192: } else {
3193: $r->print('<p>Show empty rows: ');
3194: }
3195: #
3196: $r->print(&hiddenfield('userselhidden','true').
3197: '<input type="checkbox" name="showall" onClick="submit()"');
3198: #
3199: if ($ENV{'form.showall'}) {
3200: $r->print(' checked');
3201: } else {
3202: unless ($ENV{'form.userselhidden'}) {
3203: unless
3204: ($ENV{'course.'.$sheet->{'cid'}.'.hideemptyrows'} eq 'yes') {
3205: $r->print(' checked');
3206: $ENV{'form.showall'}=1;
3207: }
3208: }
3209: }
3210: $r->print('>');
3211: #
3212: # CSV format checkbox (classcalc sheets only)
3213: $r->print(' Output as <select name="output" size="1" onClick="submit()">'.
3214: "\n");
3215: foreach my $mode (qw/HTML CSV Excel/) {
3216: $r->print('<option value="'.$mode.'"');
3217: if ($ENV{'form.output'} eq $mode) {
3218: $r->print(' selected ');
3219: }
3220: $r->print('>'.$mode.'</option>'."\n");
3221: }
3222: if ($sheet->{'sheettype'} eq 'classcalc') {
3223: $r->print('<option value="recursive excel"');
3224: if ($ENV{'form.output'} eq 'recursive excel') {
3225: $r->print(' selected ');
3226: }
3227: $r->print(">Multi-Sheet Excel</option>\n");
3228: }
3229: $r->print("</select>\n");
3230: #
3231: if ($sheet->{'sheettype'} eq 'classcalc') {
3232: $r->print(' Student Status: '.
3233: &Apache::lonhtmlcommon::StatusOptions
3234: ($ENV{'form.Status'},'sheet'));
3235: }
3236: #
3237: # Buttons to insert rows
3238: # $r->print(<<ENDINSERTBUTTONS);
3239: #<br>
3240: #<input type='button' onClick='insertrow("top");'
3241: #value='Insert Row Top'>
3242: #<input type='button' onClick='insertrow("bottom");'
3243: #value='Insert Row Bottom'><br>
3244: #ENDINSERTBUTTONS
3245: # Print out sheet
3246: &outsheet($sheet,$r);
3247: $r->print('</form></body></html>');
3248: # Done
3249: return OK;
3250: }
3251:
3252: 1;
3253: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>