Annotation of loncom/interface/spreadsheet/assesscalc.pm, revision 1.46
1.1 matthew 1: #
1.46 ! albertel 2: # $Id: assesscalc.pm,v 1.45 2005/05/15 02:49:07 albertel Exp $
1.1 matthew 3: #
4: # Copyright Michigan State University Board of Trustees
5: #
6: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
7: #
8: # LON-CAPA is free software; you can redistribute it and/or modify
9: # it under the terms of the GNU General Public License as published by
10: # the Free Software Foundation; either version 2 of the License, or
11: # (at your option) any later version.
12: #
13: # LON-CAPA is distributed in the hope that it will be useful,
14: # but WITHOUT ANY WARRANTY; without even the implied warranty of
15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: # GNU General Public License for more details.
17: #
18: # You should have received a copy of the GNU General Public License
19: # along with LON-CAPA; if not, write to the Free Software
20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21: #
22: # /home/httpd/html/adm/gpl.txt
23: #
24: # http://www.lon-capa.org/
25: #
26: # The LearningOnline Network with CAPA
27: # Spreadsheet/Grades Display Handler
28: #
29: # POD required stuff:
30:
31: =head1 NAME
32:
33: assesscalc
34:
35: =head1 SYNOPSIS
36:
37: =head1 DESCRIPTION
38:
39: =cut
40:
41: ###################################################
42: ### AssessSheet ###
43: ###################################################
44: package Apache::assesscalc;
45:
46: use strict;
1.18 matthew 47: use warnings FATAL=>'all';
48: no warnings 'uninitialized';
1.1 matthew 49: use Apache::Constants qw(:common :http);
50: use Apache::lonnet;
1.2 matthew 51: use Apache::loncommon;
1.1 matthew 52: use Apache::Spreadsheet;
1.25 matthew 53: use Apache::loncoursedata();
1.1 matthew 54: use HTML::Entities();
55: use Spreadsheet::WriteExcel;
56: use GDBM_File;
57: use Time::HiRes;
1.26 www 58: use Apache::lonlocal;
1.1 matthew 59:
60: @Apache::assesscalc::ISA = ('Apache::Spreadsheet');
61:
62: ########################################################
63: ########################################################
64:
65: =pod
66:
67: =head2 Package Variables
68:
69: =over 4
70:
71: =item %Exportrows
72:
73: =item $current_name
74:
75: =item $current_domain
76:
77: =item $current_course
78:
79: =item %parmhash
80:
81: =item %nice_parameter_name
82:
83: =item %useropt
84:
85: =item %courseopt
86:
87: =back
88:
89: =cut
90:
91: ########################################################
92: ########################################################
93:
94: my %Exportrows;
1.22 matthew 95: my %newExportrows;
1.1 matthew 96:
97: my $current_name;
98: my $current_domain;
99: my $current_course;
100:
101: my %parmhash;
102: my %nice_parameter_name;
103:
104: my %useropt;
1.22 matthew 105: my %userdata;
1.1 matthew 106: my %courseopt;
1.37 matthew 107: my $navmap;
1.1 matthew 108:
109: ########################################################
110: ########################################################
111:
112: =pod
113:
114: =head2 Package Subroutines
115:
116: =item &clear_package()
117:
1.22 matthew 118: Reset all package variables and clean up caches.
1.1 matthew 119:
120: =cut
121:
122: ########################################################
123: ########################################################
124: sub clear_package {
1.22 matthew 125: if (defined($current_name) &&
126: defined($current_domain) &&
127: defined($current_course) &&
1.39 albertel 128: $current_course eq $env{'request.course.id'} &&
1.22 matthew 129: %newExportrows) {
130: &save_cached_export_rows($current_name,$current_domain);
131: }
1.1 matthew 132: undef(%Exportrows);
1.22 matthew 133: undef(%newExportrows);
1.1 matthew 134: undef($current_name);
135: undef($current_domain);
136: undef($current_course);
137: undef(%useropt);
1.22 matthew 138: undef(%userdata);
1.1 matthew 139: undef(%courseopt);
1.37 matthew 140: undef($navmap);
1.1 matthew 141: }
142:
1.22 matthew 143: sub save_cached_export_rows {
144: my ($sname,$sdomain) = @_;
145: my $result = &Apache::lonnet::put
1.39 albertel 146: ('nohist_calculatedsheets_'.$env{'request.course.id'},
1.22 matthew 147: $newExportrows{$sname.':'.$sdomain},
148: $sdomain,$sname);
149: delete($newExportrows{$sname.':'.$sdomain});
150: }
151:
1.11 matthew 152: sub initialize {
1.37 matthew 153: my ($in_navmap) = @_;
1.11 matthew 154: &clear_package();
1.37 matthew 155: $navmap = $in_navmap;
156: if (! defined($navmap)) {
157: $navmap = Apache::lonnavmaps::navmap->new();
158: }
159: if (!defined($navmap)) {
160: &Apache::lonnet::logthis('assesscalc:Can not open Coursemap');
161: }
1.25 matthew 162: &Apache::loncoursedata::clear_internal_caches();
1.11 matthew 163: }
164:
1.1 matthew 165: ########################################################
166: ########################################################
167:
168: =pod
169:
170: =item &initialize_package()
171:
172: =cut
173:
174: ########################################################
175: ########################################################
176: sub initialize_package {
1.37 matthew 177: my ($sname,$sdomain,$in_navmap) = @_;
1.1 matthew 178: $current_name = $sname;
179: $current_domain = $sdomain;
1.37 matthew 180: $navmap = $in_navmap;
1.21 matthew 181: undef(%useropt);
1.22 matthew 182: undef(%userdata);
1.39 albertel 183: if ($current_course ne $env{'request.course.id'}) {
184: $current_course = $env{'request.course.id'};
1.13 matthew 185: undef(%courseopt);
186: }
1.1 matthew 187: &load_cached_export_rows();
188: &load_parameter_caches();
1.25 matthew 189: &Apache::loncoursedata::clear_internal_caches();
1.1 matthew 190: }
191:
1.22 matthew 192:
1.1 matthew 193: ########################################################
194: ########################################################
195:
196: =pod
197:
198: =item &load_parameter_caches()
199:
200: =cut
201:
202: ########################################################
203: ########################################################
204: sub load_parameter_caches {
205: my $userprefix = $current_name.':'.$current_domain.'_';
206: $userprefix =~ s/:/_/g;
207: #
208: # Course Parameters Cache
209: if (! %courseopt) {
1.39 albertel 210: $current_course = $env{'request.course.id'};
1.1 matthew 211: undef(%courseopt);
212: if (! defined($current_name) || ! defined($current_domain)) {
213: return;
214: }
1.39 albertel 215: my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
216: my $id = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1 matthew 217: my %Tmp = &Apache::lonnet::dump('resourcedata',$dom,$id);
218: while (my ($name,$value) = each(%Tmp)) {
1.3 matthew 219: $courseopt{$name}=$value;
1.1 matthew 220: }
221: }
222: if (! %useropt) {
223: my %Tmp = &Apache::lonnet::dump('resourcedata',
224: $current_domain,$current_name);
225: while (my ($name,$value) = each(%Tmp)) {
226: if ($name =~ /^error: 2/ || $name =~ /no such file/) {
227: undef(%useropt);
228: last;
229: }
230: $useropt{$userprefix.$name}=$value;
231: }
1.21 matthew 232: $useropt{'loadtime'} = time;
1.1 matthew 233: }
1.22 matthew 234: if (! %userdata) {
235: %userdata = &Apache::loncoursedata::get_current_state($current_name,
236: $current_domain);
237: $userdata{'loadtime'} = time;
238: }
239: return;
1.1 matthew 240: }
241:
242: ########################################################
243: ########################################################
244:
245: =pod
246:
247: =head2 assesscalc object methods
248:
249: =cut
250:
251: ########################################################
252: ########################################################
1.22 matthew 253: sub ensure_current_caches {
1.1 matthew 254: my $self = shift;
1.19 matthew 255: ##
256: ## Check for a modified parameters
257: ##
1.1 matthew 258: if (! defined($current_course) ||
1.39 albertel 259: $current_course ne $env{'request.course.id'} ) {
260: $current_course = $env{'request.course.id'};
1.1 matthew 261: undef(%courseopt);
1.22 matthew 262: undef(%useropt);
263: undef(%userdata);
1.1 matthew 264: }
1.19 matthew 265: ##
266: ## Check for new user
267: ##
1.1 matthew 268: if (! defined($current_name) || $current_name ne $self->{'name'} ||
269: ! defined($current_domain) || $current_domain ne $self->{'domain'}) {
270: $current_domain = $self->{'domain'};
271: $current_name = $self->{'name'};
272: undef(%useropt);
1.22 matthew 273: undef(%userdata);
1.1 matthew 274: }
275: &load_parameter_caches();
276: }
277:
278: ##################################################
279: ##################################################
280:
281: =pod
282:
283: =item &parmval()
284:
285: Determine the value of a parameter.
286:
287: Inputs: $what, the parameter needed, $symb, $uname, $udom, $csec
288:
289: Returns: The value of a parameter, or '' if none.
290:
291: This function cascades through the possible levels searching for a value for
292: a parameter. The levels are checked in the following order:
293: user, course (at section level and course level), map, and lonnet::metadata.
294: This function uses %parmhash, which must be tied prior to calling it.
295: This function also requires %courseopt and %useropt to be initialized for
296: this user and course.
297:
298: =cut
299:
300: ##################################################
301: ##################################################
302: sub parmval {
303: my $self = shift;
1.44 albertel 304: my ($what,$symb,$uname,$udom,$csec,$recurse,$mapname,$id,$fn)=@_;
1.1 matthew 305: $uname = $self->{'name'} if (! defined($uname));
306: $udom = $self->{'domain'} if (! defined($udom));
307: $csec = $self->{'section'} if (! defined($csec));
308: $symb = $self->{'symb'} if (! defined($symb));
309: #
310: my $result='';
311: #
312: # This should be a
1.44 albertel 313: if (!defined($mapname) || !defined($id) || !defined($fn)) {
314: ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
315: }
1.1 matthew 316: # Cascading lookup scheme
317: my $rwhat=$what;
318: $what =~ s/^parameter\_//;
319: $what =~ s/\_([^\_]+)$/\.$1/;
320: #
321: my $symbparm = $symb.'.'.$what;
322: my $mapparm = $mapname.'___(all).'.$what;
1.3 matthew 323: my $courseprefix = $self->{'cid'};
1.1 matthew 324: my $usercourseprefix = $uname.'_'.$udom.'_'.$self->{'cid'};
325: #
1.3 matthew 326: my $seclevel = $courseprefix.'.['.$csec.'].'.$what;
327: my $seclevelr = $courseprefix.'.['.$csec.'].'.$symbparm;
328: my $seclevelm = $courseprefix.'.['.$csec.'].'.$mapparm;
329: #
330: my $courselevel = $courseprefix.'.'.$what;
331: my $courselevelr = $courseprefix.'.'.$symbparm;
332: my $courselevelm = $courseprefix.'.'.$mapparm;
333: #
334: my $ucourselevel = $usercourseprefix.'.'.$what;
335: my $ucourselevelr = $usercourseprefix.'.'.$symbparm;
336: my $ucourselevelm = $usercourseprefix.'.'.$mapparm;
1.1 matthew 337: # check user
338: if (defined($uname)) {
1.3 matthew 339: return $useropt{$ucourselevelr} if (defined($useropt{$ucourselevelr}));
340: return $useropt{$ucourselevelm} if (defined($useropt{$ucourselevelm}));
341: return $useropt{$ucourselevel} if (defined($useropt{$ucourselevel}));
1.1 matthew 342: }
343: # check section
344: if (defined($csec)) {
345: return $courseopt{$seclevelr} if (defined($courseopt{$seclevelr}));
346: return $courseopt{$seclevelm} if (defined($courseopt{$seclevelm}));
347: return $courseopt{$seclevel} if (defined($courseopt{$seclevel}));
348: }
349: #
350: # check course
351: return $courseopt{$courselevelr} if (defined($courseopt{$courselevelr}));
352: # check map parms
353: my $thisparm = $parmhash{$symbparm};
354: return $thisparm if (defined($thisparm));
355: # check default
356: $thisparm = &Apache::lonnet::metadata($fn,$rwhat.'.default');
357: return $thisparm if (defined($thisparm));
1.36 albertel 358: # check more course
359: return $courseopt{$courselevelm} if (defined($courseopt{$courselevelm}));
360: return $courseopt{$courselevel} if (defined($courseopt{$courselevel}));
361:
1.1 matthew 362: # Cascade Up
363: my $space=$what;
1.35 albertel 364: $space=~s/\.[^._]+$//;
1.1 matthew 365: if ($space ne '0') {
366: my @parts=split(/_/,$space);
367: my $id=pop(@parts);
368: my $part=join('_',@parts);
369: if ($part eq '') { $part='0'; }
370: my $newwhat=$rwhat;
371: $newwhat=~s/\Q$space\E/$part/;
1.44 albertel 372: my $partgeneral=$self->parmval($newwhat,$symb,$uname,$udom,$csec,1,
373: $mapname,$id,$fn);
1.1 matthew 374: if (defined($partgeneral)) { return $partgeneral; }
375: }
1.17 albertel 376: if ($recurse) { return undef; }
377: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
378: if (defined($pack_def)) { return $pack_def; }
1.1 matthew 379: #nothing defined
380: return '';
381: }
382:
1.8 matthew 383: sub get_html_title {
384: my $self = shift;
1.29 matthew 385: my ($assess_title,$name,$time) = $self->get_full_title();
1.8 matthew 386: my $title = '<h1>'.$assess_title.'</h1>'.
387: '<h2>'.$name.', '.
388: &Apache::loncommon::aboutmewrapper
389: ($self->{'name'}.'@'.$self->{'domain'},
390: $self->{'name'},$self->{'domain'});
391: $title .= '<h3>'.$time.'</h3>';
392: return $title;
393: }
394:
1.1 matthew 395: sub get_title {
396: my $self = shift;
1.16 matthew 397: if (($self->{'symb'} eq '_feedback') ||
398: ($self->{'symb'} eq '_evaluation') ||
399: ($self->{'symb'} eq '_discussion') ||
400: ($self->{'symb'} eq '_tutoring')) {
401: my $assess_title = ucfirst($self->{'symb'});
1.8 matthew 402: $assess_title =~ s/^_//;
1.29 matthew 403: return $assess_title;
1.1 matthew 404: } else {
1.29 matthew 405: return &Apache::lonnet::gettitle($self->{'symb'});
1.1 matthew 406: }
1.29 matthew 407: }
408:
409: sub get_full_title {
410: my $self = shift;
411: my @title = ($self->get_title());
1.2 matthew 412: # Look up the users identifying information
413: # Get the users information
1.34 albertel 414: my $name = &Apache::loncommon::plainname($self->{'name'},
415: $self->{'domain'});
1.8 matthew 416: push (@title,$name);
1.26 www 417: push (@title,&Apache::lonlocal::locallocaltime(time));
1.8 matthew 418: return @title;
1.1 matthew 419: }
420:
421: sub parent_link {
422: my $self = shift;
423: my $link .= '<p><a href="/adm/studentcalc?'.
424: 'sname='.$self->{'name'}.
425: '&sdomain='.$self->{'domain'}.'">'.
1.26 www 426: &mt('Student level sheet').'</a></p>'."\n";
1.1 matthew 427: return $link;
428: }
429:
430: sub outsheet_html {
431: my $self = shift;
432: my ($r) = @_;
1.29 matthew 433: ####################################
434: # Report any calculation errors #
435: ####################################
436: $r->print($self->html_report_error());
1.1 matthew 437: ###################################
438: # Determine table structure
439: ###################################
1.14 matthew 440: my $importcolor = '#FFFFFF';
1.15 matthew 441: my $exportcolor = '#FFFFAA';
1.1 matthew 442: my $num_uneditable = 1;
443: my $num_left = 52-$num_uneditable;
1.26 www 444: my %lt=&Apache::lonlocal::texthash(
445: 'as' => 'Assessment',
446: 'ca' => 'Calculations',
447: );
1.1 matthew 448: my $tableheader =<<"END";
449: <table border="2">
450: <tr>
1.26 www 451: <th colspan="2" rowspan="2"><font size="+2">$lt{'as'}</font></th>
1.14 matthew 452: <td bgcolor="$importcolor" colspan="$num_uneditable"> </td>
1.1 matthew 453: <td colspan="$num_left">
1.26 www 454: <b><font size="+1">$lt{'ca'}</font></b></td>
1.1 matthew 455: </tr><tr>
456: END
457: my $label_num = 0;
458: foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
459: if ($label_num<$num_uneditable) {
1.14 matthew 460: $tableheader .= '<td bgcolor="'.$importcolor.'">';
1.1 matthew 461: } else {
462: $tableheader .= '<td>';
463: }
464: $tableheader .= "<b><font size=+1>$_</font></b></td>";
465: $label_num++;
466: }
467: $tableheader.="</tr>\n";
468: #
469: $r->print($tableheader);
470: #
471: # Print out template row
472: $r->print('<tr><td>Template</td><td> </td>'.
1.14 matthew 473: $self->html_template_row($num_uneditable,$importcolor).
474: "</tr>\n");
1.1 matthew 475: #
476: # Print out summary/export row
477: $r->print('<tr><td>Export</td><td>0</td>'.
1.14 matthew 478: $self->html_export_row($exportcolor)."</tr>\n");
1.1 matthew 479: #
480: # Prepare to output rows
481: $tableheader =<<"END";
482: <table border="2">
483: <tr><th>row</th><th>Item</th>
484: END
485: foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
486: if ($label_num<$num_uneditable) {
1.14 matthew 487: $tableheader.='<th bgcolor="'.$importcolor.'">';
1.1 matthew 488: } else {
489: $tableheader.='<th>';
490: }
491: $tableheader.="<b><font size=+1>$_</font></b></th>";
492: }
493: #
494: my $num_output = 0;
1.8 matthew 495: foreach my $rownum (sort {$a <=> $b} ($self->rows())) {
1.28 matthew 496: if (! $self->parameter_part_is_valid(
497: $self->{'formulas'}->{'A'.$rownum}
498: )) {
499: next;
500: }
1.1 matthew 501: if ($num_output++ % 50 == 0) {
502: $r->print("</table>\n".$tableheader);
503: }
504: $r->print('<tr><td>'.$rownum.'</td>'.
1.14 matthew 505: $self->assess_html_row($rownum,$importcolor)."</tr>\n");
1.1 matthew 506: }
507: $r->print("</table>\n");
508: return;
509: }
510:
511: sub assess_html_row {
512: my $self = shift();
1.14 matthew 513: my ($row,$importcolor) = @_;
1.1 matthew 514: my $parameter_name = $self->{'formulas'}->{'A'.$row};
515: my @rowdata = $self->get_row($row);
516: my $num_cols_output = 0;
517: my $row_html;
518: if (exists($nice_parameter_name{$parameter_name})) {
519: my $name = $nice_parameter_name{$parameter_name};
520: $name =~ s/ /\ /g;
521: $row_html .= '<td>'.$name.'<br />'.$parameter_name.'</td>';
522: } else {
523: $row_html .= '<td>'.$parameter_name.'</td>';
524: }
525: foreach my $cell (@rowdata) {
1.10 matthew 526: if ($num_cols_output < 1) {
1.14 matthew 527: $row_html .= '<td bgcolor="'.$importcolor.'">';
1.10 matthew 528: $row_html .= &Apache::Spreadsheet::html_uneditable_cell($cell,
529: '#FFDDDD');
530: } else {
531: $row_html .= '<td bgcolor="#EOFFDD">';
532: $row_html .= &Apache::Spreadsheet::html_editable_cell($cell,
533: '#E0FFDD',1);
534: }
1.1 matthew 535: $row_html .= '</td>';
1.10 matthew 536: $num_cols_output++;
1.1 matthew 537: }
538: return $row_html;
539: }
540:
1.9 matthew 541: sub csv_rows {
542: # writes the meat of the spreadsheet to an excel worksheet. Called
543: # by Spreadsheet::outsheet_excel;
1.1 matthew 544: my $self = shift;
1.30 matthew 545: my ($connection,$filehandle) = @_;
1.9 matthew 546: #
547: # Write a header row
548: $self->csv_output_row($filehandle,undef,
1.26 www 549: (&mt('Parameter'),&mt('Description'),&mt('Value')));
1.9 matthew 550: #
551: # Write each row
552: foreach my $rownum (sort {$a <=> $b} ($self->rows())) {
553: my $parameter_name = $self->{'formulas'}->{'A'.$rownum};
554: my $description = '';
555: if (exists($nice_parameter_name{$parameter_name})) {
556: $description = $nice_parameter_name{$parameter_name};
557: }
558: $self->csv_output_row($filehandle,$rownum,
559: $parameter_name,$description);
560: }
561: return;
1.1 matthew 562: }
563:
1.8 matthew 564: sub excel_rows {
565: # writes the meat of the spreadsheet to an excel worksheet. Called
566: # by Spreadsheet::outsheet_excel;
1.1 matthew 567: my $self = shift;
1.38 matthew 568: my ($connection,$worksheet,$cols_output,$rows_output,$format) = @_;
1.30 matthew 569: return if (! ref($worksheet));
1.8 matthew 570: #
571: # Write a header row
572: $cols_output = 0;
573: foreach my $value ('Parameter','Description','Value') {
1.38 matthew 574: $worksheet->write($rows_output,$cols_output++,$value,$format->{'h4'});
1.8 matthew 575: }
1.38 matthew 576: $rows_output++;
1.8 matthew 577: #
578: # Write each row
579: foreach my $rownum (sort {$a <=> $b} ($self->rows())) {
580: my $parameter_name = $self->{'formulas'}->{'A'.$rownum};
581: my $description = '';
582: if (exists($nice_parameter_name{$parameter_name})) {
583: $description = $nice_parameter_name{$parameter_name};
584: }
585: $self->excel_output_row($worksheet,$rownum,$rows_output++,
586: $parameter_name,$description);
587: }
588: return;
1.1 matthew 589: }
590:
1.21 matthew 591: ##
592: ## Routines to support assesscalc::compute
593: ##
594: sub get_parm_names {
595: my $self = shift;
596: my @Mandatory_parameters = @_;
597: my %parameters_and_names;
598: #
1.23 albertel 599: my ($symap,$syid,$srcf) = &Apache::lonnet::decode_symb($self->{'symb'});
1.21 matthew 600: my @Metadata = split(/\,/,&Apache::lonnet::metadata($srcf,'keys'));
601: foreach my $parm (@Mandatory_parameters,@Metadata) {
602: next if ($parm !~ /^(resource\.|stores|parameter)_/);
603: my $cleaned_name = $parm;
604: $cleaned_name =~ s/^resource\./stores_/;
605: $cleaned_name =~ s/\./_/g;
606: my $display = &Apache::lonnet::metadata($srcf,
607: $cleaned_name.'.display');
608: if (! $display) {
609: $display .= &Apache::lonnet::metadata($srcf,$cleaned_name.'.name');
610: }
611: $parameters_and_names{$cleaned_name}=$display;
612: }
613: return (%parameters_and_names);
614: }
615:
616: sub get_parameter_values {
617: my $self = shift();
618: my @Parameters;
619: my ($parameters) = @_;
620: if (!ref($parameters)) {
621: @Parameters = @_;
622: } elsif (ref($parameters) eq 'ARRAY') {
623: @Parameters = @$parameters;
624: } elsif (ref($parameters) eq 'HASH') {
625: @Parameters = keys(%$parameters);
626: }
627: #
628: my %parameters;
629: #
630: my $filename = $self->{'coursefilename'}.'_parms.db';
631: if (tie(%parmhash,'GDBM_File',
632: $self->{'coursefilename'}.'_parms.db',&GDBM_READER(),0640)) {
1.44 albertel 633: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($self->{'symb'});
1.21 matthew 634: foreach my $parmname (@Parameters) {
1.46 ! albertel 635: my $value = $self->parmval($parmname,$self->{'name'},
! 636: $self->{'domain'},$self->{'section'},
! 637: $self->{'symb'},undef,$mapname,$id,$fn);
1.21 matthew 638: $parameters{$parmname} =$value;
639: }
640: untie(%parmhash);
641: } else {
642: $self->logthis('unable to tie '.$filename);
643: }
644: return %parameters;
645: }
646:
647: sub deal_with_export_row {
648: my $self = shift();
649: my @exportarray = @_;
650: $Exportrows{$self->{'symb'}}->{'time'} = time;
651: $Exportrows{$self->{'symb'}}->{$self->{'filename'}} = \@exportarray;
652: #
653: # Save the export data
654: $self->save_export_data();
655: return;
656: }
657:
1.22 matthew 658: sub get_problem_state {
659: my $self = shift;
660: my %student_parameters;
661: if (exists($userdata{$self->{'symb'}}) &&
662: ref($userdata{$self->{'symb'}}) eq 'HASH') {
663: %student_parameters = %{$userdata{$self->{'symb'}}};
664: }
665: return %student_parameters;
666: }
1.21 matthew 667:
1.28 matthew 668: sub determine_parts {
669: my $self = shift;
1.41 albertel 670: my $check_hidden = shift;
1.28 matthew 671: if (exists($self->{'Parts'}) && ref($self->{'Parts'}) eq 'HASH') {
672: return;
673: }
674: my (undef,undef,$url) = &Apache::lonnet::decode_symb($self->{'symb'});
675: my $src = &Apache::lonnet::clutter($url);
676: return if (! defined($src));
677: my %Parts;
678: my $metadata = &Apache::lonnet::metadata($src,'packages');
679: foreach (split(',',$metadata)) {
680: my ($part) = (/^part_(.*)$/);
1.41 albertel 681: if (!defined($part)) { next; }
682: if (!$check_hidden) { $Parts{$part}++; next; }
683: if (!&Apache::loncommon::check_if_partid_hidden
684: ($part,$self->{'symb'},$self->{'name'},$self->{'domain'})
1.28 matthew 685: ) {
686: $Parts{$part}++;
687: }
688: }
689: # Make sure part 0 is defined.
690: $Parts{'0'}++;
691: $self->{'Parts'} = \%Parts;
692: return;
693: }
694:
695: sub parameter_part_is_valid {
696: my $self = shift;
697: my ($parameter) = @_;
698: return 1 if ($parameter eq 'timestamp');
699: if (! defined($self->{'Parts'}) ||
700: ! ref ($self->{'Parts'}) ||
701: ref($self->{'Parts'}) ne 'HASH') {
702: return 1;
703: }
704: #
705: my (undef,$part) =
706: ($parameter =~ m/^(resource|stores|parameter)_([^_]+)_.*/);
707: if (exists($self->{'Parts'}) &&
708: exists($self->{'Parts'}->{$part}) &&
709: $self->{'Parts'}->{$part} ) {
710: return 1;
711: } else {
712: return 0;
713: }
714: }
715:
1.1 matthew 716: sub compute {
717: my $self = shift;
1.19 matthew 718: my ($r) = @_;
1.1 matthew 719: $self->initialize_safe_space();
1.11 matthew 720: #########################################
721: #########################################
722: ### ###
723: ### Retrieve the problem parameters ###
724: ### ###
725: #########################################
726: #########################################
727: my @Mandatory_parameters = ("stores_0_solved",
728: "stores_0_awarddetail",
729: "stores_0_awarded",
730: "timestamp",
731: "stores_0_tries",
732: "stores_0_award");
1.1 matthew 733: #
734: # Definitions
735: undef(%nice_parameter_name);
736: my %parameters; # holds underscored parameters by name
737: #
738: # Get the metadata fields and determine their proper names
1.21 matthew 739: my %nice_parm_names = $self->get_parm_names(@Mandatory_parameters);
740: while (my($cleaned_name,$display) = each(%nice_parm_names)) {
1.1 matthew 741: $parameters{$cleaned_name}++;
742: $nice_parameter_name{$cleaned_name} = $display;
743: }
744: #
745: # Get the values of the metadata fields
1.22 matthew 746: $self->ensure_current_caches();
1.21 matthew 747: %parameters = $self->get_parameter_values(keys(%parameters));
1.1 matthew 748: #
749: # Clean out unnecessary parameters
750: foreach (keys(%parameters)) {
751: delete($parameters{$_}) if (! /(resource\.|stores_|parameter_)/);
752: }
753: #
754: # Get the students performance data
1.43 albertel 755: $self->determine_parts(($parameters{'parameter_0_hiddenparts'} ne ''));
1.22 matthew 756: my %student_parameters = $self->get_problem_state();
1.1 matthew 757: while (my ($parm,$value) = each(%student_parameters)) {
758: $parm =~ s/^resource\./stores_/;
759: $parm =~ s/\./_/g;
1.41 albertel 760: # Clean out any bad parameters
761: next if (! $self->parameter_part_is_valid($parm));
762: $parameters{$parm} = $value;
1.1 matthew 763: }
764: #
765: # Set up the formulas and parameter values
766: my %f=$self->formulas();
767: my %c;
768: #
1.5 matthew 769: # Check for blackout requirements
1.39 albertel 770: if ((!exists($env{'request.role.adv'}) || !$env{'request.role.adv'})) {
1.5 matthew 771: while (my ($parm,$value) = each(%parameters)) {
772: last if ($self->blackout());
773: next if ($parm !~ /^(parameter_.*)_problemstatus$/);
1.24 matthew 774: if ($parameters{$1.'_answerdate'} ne '' &&
1.21 matthew 775: $parameters{$1.'_answerdate'} < time) {
776: next;
777: }
1.5 matthew 778: if (lc($value) eq 'no') {
779: # We must blackout this sheet
780: $self->blackout(1);
781: }
782: }
783: }
784: #
785: # Move the parameters into the spreadsheet
1.1 matthew 786: while (my ($parm,$value) = each(%parameters)) {
787: my $cell = 'A'.$self->get_row_number_from_key($parm);
788: $f{$cell} = $parm;
1.31 matthew 789: if ($parm =~ /_submission$/ && $value =~ /(\{|\})/) {
790: $value = 'witheld';
791: }
1.32 matthew 792: $value = 'q{'.$value.'}' if ($value =~/([^\d\.]|\.\.)/);
1.6 matthew 793: $c{$parm} = $value;
1.1 matthew 794: }
1.6 matthew 795: $self->formulas(\%f);
796: $self->constants(\%c);
1.1 matthew 797: $self->calcsheet();
798: #
799: # Store export row in cache
800: my @exportarray = $self->exportrow();
1.21 matthew 801: $self->deal_with_export_row(@exportarray);
1.12 matthew 802: $self->save() if ($self->need_to_save());
1.1 matthew 803: return;
804: }
805:
806: ##
807: ## sett overrides Spreadsheet::sett
808: ##
809: sub sett {
810: my $self = shift;
811: my %t=();
1.40 albertel 812: undef(%Apache::Spreadsheet::sheet_values);
1.1 matthew 813: #
814: # Deal with the template row by copying the template formulas into each
815: # row.
816: foreach my $col ($self->template_cells()) {
817: next if ($col=~/^A/);
818: foreach my $row ($self->rows()) {
819: # Get the name of this cell
820: my $cell=$col.$row;
821: # Grab the template declaration
822: $t{$cell}=$self->formula('template_'.$col);
823: # Replace '#' with the row number
824: $t{$cell}=~s/\#/$row/g;
825: # Replace '....' with ','
826: $t{$cell}=~s/\.\.+/\,/g;
827: # Replace 'A0' with the value from 'A0'
828: $t{$cell}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
829: # Replace parameters
830: $t{$cell}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.$self->expandnamed($2)/ge;
831: }
832: }
833: #
834: # Deal with the cells which have formulas
835: while (my ($cell,$formula) = each(%{$self->{'formulas'}})) {
836: next if ($cell =~ /template_/);
837: if ($cell =~ /^A/ && $cell ne 'A0') {
1.45 albertel 838: if ($formula !~ /^\!/
839: && exists($self->{'constants'}->{$formula})
840: && $self->{'constants'}->{$formula} ne ''
841: ) {
1.40 albertel 842: $Apache::Spreadsheet::sheet_values{$cell}=
843: eval($self->{'constants'}->{$formula});
1.1 matthew 844: }
845: } else {
846: $t{$cell}=$formula;
847: $t{$cell}=~s/\.\.+/\,/g;
848: $t{$cell}=~s/(^|[^\"\'])([A-Za-z]\d+)/$1\$sheet_values\{\'$2\'\}/g;
849: $t{$cell}=~s/(^|[^\"\'])\[([^\]]+)\]/$1.$self->expandnamed($2)/ge;
850: }
851: }
852: # Put %t into the safe space
853: %{$self->{'safe'}->varglob('t')}=%t;
854: }
855:
856:
857: ########################################################
858: ########################################################
859:
860: =pod
861:
862: =item &load_cached_export_rows()
863:
864: Retrieves and parsers the export rows of the assessment spreadsheets.
865: These rows are saved in the students directory in the format:
866:
867: sname:sdom:assesscalc:symb.time => time
868:
869: sname:sdom:assesscalc:symb => filename___=___Adata___;___Bdata___;___ ...
870:
871: =cut
872:
873: ########################################################
874: ########################################################
875: sub load_cached_export_rows {
1.18 matthew 876: undef(%Exportrows);
1.1 matthew 877: my @tmp = &Apache::lonnet::dump('nohist_calculatedsheets_'.
1.39 albertel 878: $env{'request.course.id'},
1.1 matthew 879: $current_domain,$current_name,undef);
880: if ($tmp[0]!~/^error/) {
881: my %tmp = @tmp;
1.39 albertel 882: my $default_filename = $env{'course.'.$env{'request.course.id'}.
1.1 matthew 883: '.spreadsheet_default_assesscalc'};
884: # We only got one key, so we will access it directly.
885: while (my ($key,$sheetdata) = each(%tmp)) {
886: my ($sname,$sdom,$sheettype,$symb) = split(':',$key);
1.33 matthew 887: if (! defined($sname) || $sname eq '' ||
888: ! defined($sdom) || $sdom eq '' ) {
889: next;
890: }
1.1 matthew 891: if ($symb =~ /\.time$/) {
892: $symb =~ s/\.time$//;
893: $Exportrows{$symb}->{'time'} = $sheetdata;
894: } else {
895: $sheetdata =~ s/^(.*)___=___//;
896: my $filename = $1;
897: $filename = $default_filename if (! defined($filename));
898: my @Data = split('___;___',$sheetdata);
899: $Exportrows{$symb}->{$filename} = \@Data;
900: }
901: }
902: }
903: }
904:
905: #############################################
906: #############################################
907:
908: =pod
909:
910: =item &export_data
911:
912: Returns the export data associated with the spreadsheet. Computes the
913: spreadsheet only if necessary.
914:
915: =cut
916:
917: #############################################
918: #############################################
919: sub export_data {
920: my $self = shift;
1.19 matthew 921: my ($r) = @_;
1.1 matthew 922: my $symb = $self->{'symb'};
1.39 albertel 923: if (! exists($env{'request.role.adv'}) || ! $env{'request.role.adv'} ||
1.5 matthew 924: ! exists($Exportrows{$symb}) || ! defined($Exportrows{$symb}) ||
1.1 matthew 925: ! $self->check_expiration_time($Exportrows{$symb}->{'time'}) ||
926: ! exists($Exportrows{$symb}->{$self->{'filename'}}) ||
1.18 matthew 927: ! defined($Exportrows{$symb}->{$self->{'filename'}}) ||
928: ! ref($Exportrows{$symb}->{$self->{'filename'}})
929: ) {
1.19 matthew 930: $self->compute($r);
1.1 matthew 931: }
1.29 matthew 932: my @Data;
933: if ($self->badcalc()) {
934: @Data = ();
935: } else {
936: @Data = @{$Exportrows{$symb}->{$self->{'filename'}}};
937: if ($Data[0] =~ /^(.*)___=___/) {
938: $self->{'sheetname'} = $1;
939: $Data[0] =~ s/^(.*)___=___//;
940: }
941: for (my $i=0;$i<$#Data;$i++) {
942: if ($Data[$i]=~/\D/ && defined($Data[$i])) {
943: $Data[$i]="'".$Data[$i]."'";
944: }
945: }
1.1 matthew 946: }
947: return @Data;
948: }
949:
950: #############################################
951: #############################################
952:
953: =pod
954:
955: =item &save_export_data()
956:
957: Writes the export data for this spreadsheet to the students cache.
958:
959: =cut
960:
961: #############################################
962: #############################################
963: sub save_export_data {
964: my $self = shift;
1.7 matthew 965: return if ($self->temporary());
1.1 matthew 966: my $student = $self->{'name'}.':'.$self->{'domain'};
967: my $symb = $self->{'symb'};
1.29 matthew 968: if ($self->badcalc()){
969: # do not save data away when calculations have not been done properly.
970: delete($Exportrows{$symb});
971: return;
972: }
1.1 matthew 973: if (! exists($Exportrows{$symb}) ||
974: ! exists($Exportrows{$symb}->{$self->{'filename'}})) {
975: return;
976: }
977: my $key = join(':',($self->{'name'},$self->{'domain'},'assesscalc',$symb));
978: my $timekey = $key.'.time';
1.22 matthew 979: my $newstore= join('___;___',
980: map {s/[^[:print:]]//g;$_;} # strip out unprintable
981: @{$Exportrows{$symb}->{$self->{'filename'}}});
1.1 matthew 982: $newstore = $self->{'filename'}.'___=___'.$newstore;
1.22 matthew 983: $newExportrows{$student}->{$key} = $newstore;
984: $newExportrows{$student}->{$timekey} = $Exportrows{$symb}->{'time'};
1.1 matthew 985: return;
986: }
987:
988: 1;
989:
990: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to assesscalc.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface / spreadsheet