loncom/interface/spreadsheet/assesscalc.pm - view

File: [LON-CAPA] / loncom / interface / spreadsheet / assesscalc.pm
Revision 1.58: download - view: text, annotated - select for diffs
Tue Jan 23 01:36:26 2007 UTC (17 years, 4 months ago) by albertel
Branches: MAIN
CVS tags: version_2_9_X, version_2_9_99_0, version_2_9_1, version_2_9_0, version_2_8_X, version_2_8_99_1, version_2_8_99_0, version_2_8_2, version_2_8_1, version_2_8_0, version_2_7_X, version_2_7_99_1, version_2_7_99_0, version_2_7_1, version_2_7_0, version_2_6_X, version_2_6_99_1, version_2_6_99_0, version_2_6_3, version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_X, version_2_5_99_1, version_2_5_99_0, version_2_5_2, version_2_5_1, version_2_5_0, version_2_4_X, version_2_4_99_0, version_2_4_2, version_2_4_1, version_2_4_0, version_2_3_99_0, version_2_10_X, version_2_10_1, version_2_10_0_RC2, version_2_10_0_RC1, version_2_10_0, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, bz6209-base, bz6209, bz5969, bz2851, PRINT_INCOMPLETE_base, PRINT_INCOMPLETE, HEAD, GCI_3, GCI_2, GCI_1, BZ5971-printing-apage, BZ5434-fox, BZ4492-merge, BZ4492-feature_horizontal_radioresponse

- allow [&EXPANDSUM()] to span lines

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