File:  [LON-CAPA] / loncom / interface / spreadsheet / classcalc.pm
Revision 1.20: download - view: text, annotated - select for diffs
Fri Jun 4 21:43:36 2004 UTC (19 years, 10 months ago) by matthew
Branches: MAIN
CVS tags: version_1_1_99_0, HEAD
Initialize student spreadsheet package before creating progress window.

    1: #
    2: # $Id: classcalc.pm,v 1.20 2004/06/04 21:43:36 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: classcalc
   34: 
   35: =head1 SYNOPSIS
   36: 
   37: =head1 DESCRIPTION
   38: 
   39: =over 4
   40: 
   41: =cut
   42: 
   43: ###################################################
   44: ###                 CourseSheet                 ###
   45: ###################################################
   46: package Apache::classcalc;
   47: 
   48: use strict;
   49: use warnings FATAL=>'all';
   50: no warnings 'uninitialized';
   51: use Apache::Constants qw(:common :http);
   52: use Apache::loncoursedata();
   53: use Apache::lonhtmlcommon();
   54: use Apache::Spreadsheet;
   55: use Apache::studentcalc;
   56: use Apache::lonstatistics();
   57: use HTML::Entities();
   58: use Spreadsheet::WriteExcel;
   59: use Apache::lonnet;
   60: use Time::HiRes;
   61: use Apache::lonlocal;
   62: 
   63: @Apache::classcalc::ISA = ('Apache::Spreadsheet');
   64: 
   65: ##
   66: ## Package variable
   67: ##
   68: 
   69: my @Students;
   70: 
   71: sub initialize {
   72:     &Apache::lonstatistics::clear_classlist_variables();
   73:     @Students = &Apache::lonstatistics::get_students();
   74:     return;
   75: }
   76: 
   77: sub clear_package {
   78:     undef(@Students);
   79:     &Apache::studentcalc::clear_package();
   80: }
   81: 
   82: sub html_header {
   83:     my $self = shift;
   84:     my ($toprow,$bottomrow);
   85:     &Apache::lonstatistics::clear_classlist_variables();
   86:     foreach (['Sections',&Apache::lonstatistics::SectionSelect('Section','multpile',3)],
   87:              ['Enrollment Status',&Apache::lonhtmlcommon::StatusOptions(undef,undef,3)],
   88:              ['Output Format',$self->output_selector()]) {
   89:         my ($name,$selector) = @{$_};
   90:         $toprow .= '<th align="center"><b>'.&mt($name).'</b></th>';
   91:         $bottomrow .= '<td>'.$selector.'</td>';
   92:     }
   93:     return "<p>\n<table>\n".
   94:         "<tr>".$toprow."</tr>\n".
   95:         "<tr>".$bottomrow."</tr>\n".
   96:         "</table>\n</p>";
   97: }
   98: 
   99: sub get_title {
  100:     my $self = shift;
  101:     # Section info should be included
  102:     my @title = ($self->{'coursedesc'}, &Apache::lonlocal::locallocaltime(time) );
  103:     return @title;
  104: }
  105: 
  106: sub get_html_title {
  107:     my $self = shift;
  108:     my ($classcalc_title,$time) = $self->get_title();
  109:     my $title = '<h1>'.$classcalc_title."</h1>\n".'<h3>'.$time."</h3>\n";
  110:     return $title;
  111: }
  112: 
  113: sub parent_link {
  114:     return '';
  115: }
  116: 
  117: sub outsheet_html {
  118:     my $self = shift;
  119:     my ($r) = @_;
  120:     ####################################
  121:     # Report any calculation errors    #
  122:     ####################################
  123:     $r->print($self->html_report_error());
  124:     ###################################
  125:     # Determine table structure
  126:     ###################################
  127:     my $importcolor = '#88FF88';
  128:     my $exportcolor = '#BBBBFF';
  129:     my $num_uneditable = 26;
  130:     my $num_left = 52-$num_uneditable;
  131:     #
  132:     my %header=&Apache::lonlocal::texthash(
  133:                                            'course'       => 'Course',
  134:                                            'import'       => 'Import',
  135:                                            'calculations' => 'Calculations',
  136:                                            'student'      => 'Student',
  137:                                            'status'       => 'Status',
  138:                                            'username'     => 'Username',
  139:                                            'domain'       => 'Domain',
  140:                                            'section'      => 'Section',
  141:                                            'row'          => 'Row',
  142:                                            );
  143:     my $tableheader =<<"END";
  144: <p>
  145: <table border="2">
  146: <tr>
  147:   <th colspan="2" rowspan="2"><font size="+2">$header{'course'}</font></th>
  148:   <td bgcolor="$importcolor" colspan="$num_uneditable">
  149:       <b><font size="+1">$header{'import'}</font></b></td>
  150:   <td colspan="$num_left">
  151:       <b><font size="+1">$header{'calculations'}</font></b></td>
  152: </tr><tr>
  153: END
  154:     my $label_num = 0;
  155:     foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
  156:         if ($label_num<$num_uneditable) { 
  157:             $tableheader.='<th bgcolor="'.$importcolor.'">';
  158:         } else {
  159:             $tableheader.='<th>';
  160:         }
  161:         $tableheader.="<b><font size=+1>$_</font></b></th>";
  162:         $label_num++;
  163:     }
  164:     $tableheader.="</tr>\n";
  165:     #
  166:     $r->print($tableheader);
  167:     #
  168:     # Print out template row
  169:     $r->print('<tr><td>'.&mt('Template').'</td><td>&nbsp;</td>'.
  170: 	      $self->html_template_row($num_uneditable,$importcolor).
  171:               "</tr>\n");
  172:     #
  173:     # Print out summary/export row
  174:     $r->print('<tr><td>'.&mt('Summary').'</td><td>0</td>'.
  175: 	      $self->html_export_row($exportcolor)."</tr>\n");
  176:     #
  177:     # Prepare to output rows
  178:     $tableheader =<<"END";
  179: </p><p>
  180: <table border="2">
  181: <tr><th>$header{'row'}</th>
  182:   <th>$header{'student'}</th>
  183:   <th>$header{'username'}</th>
  184:   <th>$header{'domain'}</th>
  185:   <th>$header{'section'}</th>
  186:   <th>$header{'status'}</th>
  187: END
  188:     foreach (split(//,'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')){
  189: 	if ($label_num<$num_uneditable) { 
  190:             $tableheader.='<th bgcolor="'.$importcolor.'">';
  191:         } else {
  192:             $tableheader.='<th>';
  193:         }
  194:         $tableheader.="<b><font size=+1>$_</font></b></th>";
  195:     }
  196:     #
  197:     my $num_output = 0;
  198:     foreach my $student (@Students) {
  199: 	if ($num_output++ % 50 == 0) {
  200: 	    $r->print("</table>\n".$tableheader);
  201: 	}
  202: 	my $rownum = $self->get_row_number_from_key
  203: 	    ($student->{'username'}.':'.$student->{'domain'});
  204:         my $link = '<a href="/adm/studentcalc?sname='.$student->{'username'}.
  205:             '&sdomain='.$student->{'domain'}.'">';
  206:         $student->{'section'} = 'none' if ($student->{'section'} eq '-1');
  207: 	$r->print('<tr>'.'<td>'.$rownum.'</td>'.
  208: 		  '<td>'.$student->{'fullname'}.'</td>'.
  209: 		  '<td>'.$link.$student->{'username'}.'</a></td>'.
  210: 		  '<td>'.$student->{'domain'}  .'</td>'.
  211: 		  '<td>'.$student->{'section'} .'</td>'.
  212: 		  '<td>'.$student->{'status'}  .'</td>'.
  213: 		  $self->html_row($num_uneditable,$rownum,$exportcolor,
  214:                                   $importcolor).
  215:                   "</tr>\n");
  216:     }
  217:     $r->print("</table></p>\n");
  218:     return;
  219: }
  220: 
  221: sub excel_rows {
  222:     # writes the meat of the spreadsheet to an excel worksheet.  Called
  223:     # by Spreadsheet::outsheet_excel;
  224:     my $self = shift;
  225:     my ($connection,$worksheet,$cols_output,$rows_output) = @_;
  226:     #
  227:     # Write a header row
  228:     $cols_output = 0;
  229:     foreach my $value ('Fullname','Username','Domain','Section','Status','ID') {
  230:         $worksheet->write($rows_output,$cols_output++,&mt($value));
  231:     }
  232:     $rows_output++;    
  233:     #
  234:     # Write each students row
  235:     foreach my $student (@Students) {
  236:         $cols_output = 0;
  237: 	my $rownum = $self->get_row_number_from_key
  238: 	    ($student->{'username'}.':'.$student->{'domain'});
  239:         $student->{'section'} = 'none' if ($student->{'section'} eq '-1');
  240:         my @studentdata = ($student->{'fullname'},
  241:                            $student->{'username'},
  242:                            $student->{'domain'},
  243:                            $student->{'section'},
  244:                            $student->{'status'},
  245:                            $student->{'id'});
  246:         $self->excel_output_row($worksheet,$rownum,$rows_output++,
  247:                                 @studentdata);
  248:     }
  249:     return;
  250: }
  251: 
  252: sub csv_rows {
  253:     # writes the meat of the spreadsheet to an excel worksheet.  Called
  254:     # by Spreadsheet::outsheet_excel;
  255:     my $self = shift;
  256:     my ($connection,$filehandle) = @_;
  257:     #
  258:     # Write a header row
  259:     $self->csv_output_row($filehandle,undef,
  260:                    (&mt('Fullname'),&mt('Username'),&mt('Domain'),&mt('Section'),&mt('Status'),&mt('ID')));
  261:     #
  262:     # Write each students row
  263:     foreach my $student (@Students) {
  264: 	my $rownum = $self->get_row_number_from_key
  265: 	    ($student->{'username'}.':'.$student->{'domain'});
  266:         $student->{'section'} = 'none' if ($student->{'section'} eq '-1');
  267:         my @studentdata = ($student->{'fullname'},
  268:                            $student->{'username'},
  269:                            $student->{'domain'},
  270:                            $student->{'section'},
  271:                            $student->{'status'},
  272:                            $student->{'id'});
  273:         $self->csv_output_row($filehandle,$rownum,@studentdata);
  274:     }
  275:     return;
  276: }
  277: 
  278: sub output_options {
  279:     my $self = shift();
  280:     return  ({value       => 'htmlclasslist',
  281:               description => 'Student Sheet Links'},
  282:              {value       => 'html',
  283:               description => 'HTML'},
  284:              {value       => 'excel',
  285:               description => 'Excel'},
  286:              {value       => 'csv',
  287:               description => 'Comma Separated Values'},
  288: #             {value       => 'xml',
  289: #              description => 'XML'},
  290:              );
  291: }
  292: 
  293: sub outsheet_recursive_excel {
  294:     my $self = shift;
  295:     my ($r) = @_;
  296: }
  297: 
  298: sub outsheet_htmlclasslist {
  299:     my $self = shift;
  300:     my ($r) = @_;
  301:     #
  302:     # Determine if we should output expire caches links...
  303:     my $show_expire_link = 0;
  304:     if (exists($ENV{'user.role.dc./'.$ENV{'request.role.domain'}.'/'})){
  305:         $show_expire_link = 1;
  306:     }
  307:     #
  308:     if ($show_expire_link) {
  309:         $r->print('<a href="/adm/classcalc?output_format=htmlclasslist&'.
  310:                   'recalc=ilovewastingtime&not_first_run=1">'.
  311:                   &mt('Expire all student spreadsheets').'</a>'.$/);
  312:     }
  313:     #
  314:     $r->print('<h3>'.
  315:               &mt('Click on a student to be taken to their spreadsheet').
  316:               '</h3>');
  317:     #
  318:     my %header=&Apache::lonlocal::texthash(
  319:                                            'student'      => 'Student',
  320:                                            'status'       => 'Status',
  321:                                            'username'     => 'Username',
  322:                                            'domain'       => 'Domain',
  323:                                            'section'      => 'Section',
  324:                                            );
  325:     #
  326:     # Prepare to output rows
  327:     my $tableheader =<<"END";
  328: </p><p>
  329: <table border="2">
  330: <tr>
  331:   <th></th>
  332:   <th>$header{'student'}</th>
  333:   <th>$header{'username'}</th>
  334:   <th>$header{'domain'}</th>
  335:   <th>$header{'section'}</th>
  336:   <th>$header{'status'}</th>
  337: END
  338:     if ($show_expire_link) {
  339:         $tableheader.= '<th>&nbsp;</th>';
  340:     }
  341:     $tableheader.= "</tr>\n";
  342:     #
  343:     my $num_output = 0;
  344:     foreach my $student (@Students) {
  345: 	if ($num_output++ % 50 == 0) {
  346: 	    $r->print("</table>\n".$tableheader);
  347: 	}
  348:         my $link = '<a href="/adm/studentcalc?sname='.$student->{'username'}.
  349:             '&sdomain='.$student->{'domain'}.'">';
  350:         $student->{'section'} = 'none' if ($student->{'section'} eq '-1');
  351: 	$r->print('<tr>'.
  352:                   '<td>'.$num_output.'</td>'.
  353: 		  '<td>'.$link.$student->{'fullname'}.'</a></td>'.
  354: 		  '<td>'.$link.$student->{'username'}.'</a></td>'.
  355: 		  '<td>'.$student->{'domain'}  .'</td>'.
  356: 		  '<td>'.$student->{'section'} .'</td>'.
  357: 		  '<td>'.$student->{'status'}  .'</td>');
  358:         if ($show_expire_link) {
  359:             $r->print('<td>'.
  360:                       '<a href="/adm/classcalc?recalc=student:'.
  361:                       $student->{'username'}.':'.$student->{'domain'}.'&'.
  362:                       'output_format=htmlclasslist&'.
  363:                       'not_first_run=1'.'">Expire Record</a>'.$/);
  364:         }
  365:         $r->print("</tr>\n");
  366:     }
  367:     $r->print("</table></p>\n");
  368:     return;
  369: }
  370: 
  371: sub compute {
  372:     my $self = shift;
  373:     my ($r) = @_;
  374:     my $connection = $r->connection();
  375:     if ($connection->aborted()) { $self->cleanup(); return; }
  376:     $self->initialize_safe_space();
  377:     my %c = $self->constants();
  378:     my %f = $self->formulas();
  379:     &Apache::studentcalc::initialize_package();
  380:     my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
  381:         ($r,&mt('Spreadsheet Computation Status'),
  382:          &mt('Spreadsheet Computation'), scalar(@Students));
  383:     &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
  384:                                           &mt('Processing first student'));
  385:     foreach my $student (@Students) {
  386:         if ($connection->aborted()) { $self->cleanup(); return; }
  387:         my $sname = $student->{'username'}.':'.$student->{'domain'};
  388: 	my $studentsheet = Apache::studentcalc->new
  389: 	    ($student->{'username'},$student->{'domain'},undef);
  390:         if ($connection->aborted()) { $self->cleanup(); return; }
  391: 	my @exportdata = $studentsheet->export_data($r);
  392:         if ($studentsheet->badcalc()) {
  393:             $self->set_calcerror($sname.' : '.
  394:                                  $studentsheet->calcerror());
  395:         }
  396:         if ($connection->aborted()) { $self->cleanup(); return; }
  397: 	my $rownum = $self->get_row_number_from_key($sname);
  398:         $f{'A'.$rownum} = $sname;
  399:         $self->{'row_source'}->{$rownum} = $sname;
  400:         $c{'A'.$rownum} = shift(@exportdata);
  401: 	foreach (split(//,'BCDEFGHIJKLMNOPQRSTUVWXYZ')) {
  402:             my $cell = $_.$rownum;
  403:             my $data = shift(@exportdata);
  404:             if (defined($data)) {
  405:                 $f{$cell} = 'import';
  406:                 $c{$cell} = $data;
  407:             }
  408: 	}
  409:         &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
  410:                                                  'last student');
  411:     }
  412:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  413:     $r->rflush();
  414:     $self->constants(\%c);
  415:     $self->formulas(\%f);
  416:     $self->calcsheet();
  417:     $self->save() if ($self->need_to_save());
  418: }
  419: 
  420: 1;
  421: 
  422: __END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>