File:  [LON-CAPA] / loncom / interface / statistics / lonstudentassessment.pm
Revision 1.82: download - view: text, annotated - select for diffs
Tue Jan 27 19:50:03 2004 UTC (20 years, 5 months ago) by matthew
Branches: MAIN
CVS tags: HEAD
Bug 2628: This will address the bug with the formatting of the values
shown for the summary table.
Also improved the handling of 'score' cells in the Excel output in the
case where there is only one thing in the sequence.

    1: # The LearningOnline Network with CAPA
    2: #
    3: # $Id: lonstudentassessment.pm,v 1.82 2004/01/27 19:50:03 matthew Exp $
    4: #
    5: # Copyright Michigan State University Board of Trustees
    6: #
    7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    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: # (Navigate problems for statistical reports
   27: #
   28: #######################################################
   29: #######################################################
   30: 
   31: =pod
   32: 
   33: =head1 NAME
   34: 
   35: lonstudentassessment
   36: 
   37: =head1 SYNOPSIS
   38: 
   39: Presents assessment data about a student or a group of students.
   40: 
   41: =head1 Subroutines
   42: 
   43: =over 4 
   44: 
   45: =cut
   46: 
   47: #######################################################
   48: #######################################################
   49: 
   50: package Apache::lonstudentassessment;
   51: 
   52: use strict;
   53: use Apache::lonstatistics;
   54: use Apache::lonhtmlcommon;
   55: use Apache::loncommon();
   56: use Apache::loncoursedata;
   57: use Apache::lonnet; # for logging porpoises
   58: use Apache::lonlocal;
   59: use Spreadsheet::WriteExcel;
   60: use Spreadsheet::WriteExcel::Utility();
   61: 
   62: #######################################################
   63: #######################################################
   64: =pod
   65: 
   66: =item Package Variables
   67: 
   68: =over 4
   69: 
   70: =item $Statistics Hash ref to store student data.  Indexed by symb,
   71:       contains hashes with keys 'score' and 'max'.
   72: 
   73: =cut
   74: 
   75: #######################################################
   76: #######################################################
   77: 
   78: my $Statistics;
   79: 
   80: #######################################################
   81: #######################################################
   82: 
   83: =pod
   84: 
   85: =item $show_links 'yes' or 'no' for linking to student performance data
   86: 
   87: =item $output_mode 'html', 'excel', or 'csv' for output mode
   88: 
   89: =item $show 'all', 'totals', or 'scores' determines how much data is output
   90: 
   91: =item $data  determines what performance data is shown
   92: 
   93: =item $datadescription A short description of the output data selected.
   94: 
   95: =item $base 'tries' or 'scores' determines the base of the performance shown
   96: 
   97: =item $single_student_mode evaluates to true if we are showing only one
   98: student.
   99: 
  100: =cut
  101: 
  102: #######################################################
  103: #######################################################
  104: my $show_links;
  105: my $output_mode;
  106: my $data;
  107: my $base;
  108: my $datadescription;
  109: my $single_student_mode;
  110: 
  111: #######################################################
  112: #######################################################
  113: # End of package variable declarations
  114: 
  115: =pod
  116: 
  117: =back
  118: 
  119: =cut
  120: 
  121: #######################################################
  122: #######################################################
  123: 
  124: =pod
  125: 
  126: =item &BuildStudentAssessmentPage()
  127: 
  128: Inputs: 
  129: 
  130: =over 4
  131: 
  132: =item $r Apache Request
  133: 
  134: =item $c Apache Connection 
  135: 
  136: =back
  137: 
  138: =cut
  139: 
  140: #######################################################
  141: #######################################################
  142: sub BuildStudentAssessmentPage {
  143:     my ($r,$c)=@_;
  144:     #
  145:     undef($Statistics);
  146:     undef($show_links);
  147:     undef($output_mode);
  148:     undef($data);
  149:     undef($base);
  150:     undef($datadescription);
  151:     undef($single_student_mode);
  152:     #
  153:     my %Saveable_Parameters = ('Status' => 'scalar',
  154:                                'chartoutputmode' => 'scalar',
  155:                                'chartoutputdata' => 'scalar',
  156:                                'Section' => 'array',
  157:                                'StudentData' => 'array',
  158:                                'Maps' => 'array');
  159:     &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters);
  160:     &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters);
  161:     #
  162:     &Apache::lonstatistics::PrepareClasslist();
  163:     #
  164:     $single_student_mode = 0;
  165:     $single_student_mode = 1 if ($ENV{'form.SelectedStudent'});
  166:     if ($ENV{'form.selectstudent'}) {
  167:         &Apache::lonstatistics::DisplayClasslist($r);
  168:         return;
  169:     }
  170:     #
  171:     # Print out the HTML headers for the interface
  172:     #    This also parses the output mode selector
  173:     #    This step must *always* be done.
  174:     $r->print(&CreateInterface());
  175:     $r->print('<input type="hidden" name="notfirstrun" value="true" />');
  176:     $r->print('<input type="hidden" name="sort" value="'.
  177:               $ENV{'form.sort'}.'" />');
  178:     $r->rflush();
  179:     #
  180:     if (! exists($ENV{'form.notfirstrun'}) && ! $single_student_mode) {
  181:         return;
  182:     }
  183:     #
  184:     my $initialize     = \&html_initialize;
  185:     my $output_student = \&html_outputstudent;
  186:     my $finish         = \&html_finish;
  187:     #
  188:     if ($output_mode eq 'excel') {
  189:         $initialize     = \&excel_initialize;
  190:         $output_student = \&excel_outputstudent;
  191:         $finish         = \&excel_finish;
  192:     } elsif ($output_mode eq 'csv') {
  193:         $initialize     = \&csv_initialize;
  194:         $output_student = \&csv_outputstudent;
  195:         $finish         = \&csv_finish;
  196:     }
  197:     #
  198:     if($c->aborted()) {  return ; }
  199:     #
  200:     # Determine which students we want to look at
  201:     my @Students;
  202:     if ($single_student_mode) {
  203:         @Students = (&Apache::lonstatistics::current_student());
  204:         $r->print(&next_and_previous_buttons());
  205:         $r->rflush();
  206:     } else {
  207:         @Students = @Apache::lonstatistics::Students;
  208:     }
  209:     #
  210:     # Perform generic initialization tasks
  211:     #       Since we use lonnet::EXT to retrieve problem weights,
  212:     #       to ensure current data we must clear the caches out.
  213:     #       This makes sure that parameter changes at the student level
  214:     #       are immediately reflected in the chart.
  215:     &Apache::lonnet::clear_EXT_cache_status();
  216:     #
  217:     # Clean out loncoursedata's package data, just to be safe.
  218:     &Apache::loncoursedata::clear_internal_caches();
  219:     #
  220:     # Call the initialize routine selected above
  221:     $initialize->($r);
  222:     foreach my $student (@Students) {
  223:         if($c->aborted()) { 
  224:             $finish->($r);
  225:             return ; 
  226:         }
  227:         # Call the output_student routine selected above
  228:         $output_student->($r,$student);
  229:     }
  230:     # Call the "finish" routine selected above
  231:     $finish->($r);
  232:     #
  233:     return;
  234: }
  235: 
  236: #######################################################
  237: #######################################################
  238: sub next_and_previous_buttons {
  239:     my $Str = '';
  240:     $Str .= '<input type="hidden" name="SelectedStudent" value="'.
  241:         $ENV{'form.SelectedStudent'}.'" />';
  242:     #
  243:     # Build the previous student link
  244:     my $previous = &Apache::lonstatistics::previous_student();
  245:     my $previousbutton = '';
  246:     if (defined($previous)) {
  247:         my $sname = $previous->{'username'}.':'.$previous->{'domain'};
  248:         $previousbutton .= '<input type="button" value="'.
  249:             'Previous Student ('.
  250:             $previous->{'username'}.'@'.$previous->{'domain'}.')'.
  251:             '" onclick="document.Statistics.SelectedStudent.value='.
  252:             "'".$sname."'".';'.
  253:             'document.Statistics.submit();" />';
  254:     } else {
  255:         $previousbutton .= '<input type="button" value="'.
  256:             'Previous student (none)'.'" />';
  257:     }
  258:     #
  259:     # Build the next student link
  260:     my $next = &Apache::lonstatistics::next_student();
  261:     my $nextbutton = '';
  262:     if (defined($next)) {
  263:         my $sname = $next->{'username'}.':'.$next->{'domain'};
  264:         $nextbutton .= '<input type="button" value="'.
  265:             'Next Student ('.
  266:             $next->{'username'}.'@'.$next->{'domain'}.')'.
  267:             '" onclick="document.Statistics.SelectedStudent.value='.
  268:             "'".$sname."'".';'.
  269:             'document.Statistics.submit();" />';
  270:     } else {
  271:         $nextbutton .= '<input type="button" value="'.
  272:             'Next student (none)'.'" />';
  273:     }
  274:     #
  275:     # Build the 'all students' button
  276:     my $all = '';
  277:     $all .= '<input type="button" value="All Students" '.
  278:             '" onclick="document.Statistics.SelectedStudent.value='.
  279:             "''".';'.'document.Statistics.submit();" />';
  280:     $Str .= $previousbutton.('&nbsp;'x5).$all.('&nbsp;'x5).$nextbutton;
  281:     return $Str;
  282: }
  283: 
  284: #######################################################
  285: #######################################################
  286: 
  287: sub get_student_fields_to_show {
  288:     my @to_show = @Apache::lonstatistics::SelectedStudentData;
  289:     foreach (@to_show) {
  290:         if ($_ eq 'all') {
  291:             @to_show = @Apache::lonstatistics::StudentDataOrder;
  292:             last;
  293:         }
  294:     }
  295:     return @to_show;
  296: }
  297: 
  298: #######################################################
  299: #######################################################
  300: 
  301: =pod
  302: 
  303: =item &CreateInterface()
  304: 
  305: Called by &BuildStudentAssessmentPage to create the top part of the
  306: page which displays the chart.
  307: 
  308: Inputs: None
  309: 
  310: Returns:  A string containing the HTML for the headers and top table for 
  311: the chart page.
  312: 
  313: =cut
  314: 
  315: #######################################################
  316: #######################################################
  317: sub CreateInterface {
  318:     my $Str = '';
  319: #    $Str .= &CreateLegend();
  320:     $Str .= '<table cellspacing="5">'."\n";
  321:     $Str .= '<tr>';
  322:     $Str .= '<td align="center"><b>'.&mt('Sections').'</b></td>';
  323:     $Str .= '<td align="center"><b>'.&mt('Student Data</b>').'</td>';
  324:     $Str .= '<td align="center"><b>'.&mt('Enrollment Status').'</b></td>';
  325:     $Str .= '<td align="center"><b>'.&mt('Sequences and Folders').'</b></td>';
  326:     $Str .= '<td align="center"><b>'.&mt('Output Format').'</b>'.
  327:         &Apache::loncommon::help_open_topic("Chart_Output_Formats").
  328:         '</td>';
  329:     $Str .= '<td align="center"><b>'.&mt('Output Data').'</b>'.
  330:         &Apache::loncommon::help_open_topic("Chart_Output_Data").
  331:         '</td>';
  332:     $Str .= '</tr>'."\n";
  333:     #
  334:     $Str .= '<tr><td align="center">'."\n";
  335:     $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
  336:     $Str .= '</td><td align="center">';
  337:     my $only_seq_with_assessments = sub { 
  338:         my $s=shift;
  339:         if ($s->{'num_assess'} < 1) { 
  340:             return 0;
  341:         } else { 
  342:             return 1;
  343:         }
  344:     };
  345:     $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
  346:                                                       5,undef);
  347:     $Str .= '</td><td>'."\n";
  348:     $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5);
  349:     $Str .= '</td><td>'."\n";
  350:     $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
  351:                                               $only_seq_with_assessments);
  352:     $Str .= '</td><td>'."\n";
  353:     $Str .= &CreateAndParseOutputSelector();
  354:     $Str .= '</td><td>'."\n";
  355:     $Str .= &CreateAndParseOutputDataSelector();
  356:     $Str .= '</td></tr>'."\n";
  357:     $Str .= '</table>'."\n";
  358:     $Str .= '<input type="submit" name="Generate Chart" value="'.
  359:         &mt('Generate Chart').'" />';
  360:     $Str .= '&nbsp;'x5;
  361:     $Str .= '<input type="submit" name="selectstudent" value="'.
  362:         &mt('Select One Student').'" />';
  363:     $Str .= '&nbsp;'x5;
  364:     $Str .= '<input type="submit" name="ClearCache" value="'.
  365:         &mt('Clear Caches').'" />';
  366:     $Str .= '&nbsp;'x5;
  367:     $Str .= '<br />';
  368:     return $Str;
  369: }
  370: 
  371: #######################################################
  372: #######################################################
  373: 
  374: =pod
  375: 
  376: =item &CreateAndParseOutputSelector()
  377: 
  378: =cut
  379: 
  380: #######################################################
  381: #######################################################
  382: my @OutputOptions = 
  383:     ({ name  => 'HTML, with links',
  384:        value => 'html, with links',
  385:        description => 'Output HTML with each symbol linked to the problem '.
  386: 	   'which generated it.',
  387:        mode => 'html',
  388:        show_links => 'yes',
  389:        },
  390:      { name  => 'HTML, with all links',
  391:        value => 'html, with all links',
  392:        description => 'Output HTML with each symbol linked to the problem '.
  393: 	   'which generated it.  '.
  394:            'This includes links for unattempted problems.',
  395:        mode => 'html',
  396:        show_links => 'all',
  397:        },
  398:      { name  => 'HTML, without links',
  399:        value => 'html, without links',
  400:        description => 'Output HTML.  By not including links, the size of the'.
  401: 	   ' web page is greatly reduced.  If your browser crashes on the '.
  402: 	   'full display, try this.',
  403:        mode => 'html',
  404:        show_links => 'no',
  405:            },
  406:      { name  => 'Excel',
  407:        value => 'excel',
  408:        description => 'Output an Excel file (compatable with Excel 95).',
  409:        mode => 'excel',
  410:        show_links => 'no',
  411:    },
  412:      { name  => 'CSV',
  413:        value => 'csv',
  414:        description => 'Output a comma seperated values file suitable for '.
  415:            'import into a spreadsheet program.  Using this method as opposed '.
  416:            'to Excel output allows you to organize your data before importing'.
  417:            ' it into a spreadsheet program.',
  418:        mode => 'csv',
  419:        show_links => 'no',
  420:            },
  421:      );
  422: 
  423: sub OutputDescriptions {
  424:     my $Str = '';
  425:     $Str .= "<h2>Output Formats</h2>\n";
  426:     $Str .= "<dl>\n";
  427:     foreach my $outputmode (@OutputOptions) {
  428: 	$Str .="    <dt>".$outputmode->{'name'}."</dt>\n";
  429: 	$Str .="        <dd>".$outputmode->{'description'}."</dd>\n";
  430:     }
  431:     $Str .= "</dl>\n";
  432:     return $Str;
  433: }
  434: 
  435: sub CreateAndParseOutputSelector {
  436:     my $Str = '';
  437:     my $elementname = 'chartoutputmode';
  438:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  439:                                             [$elementname]);
  440:     #
  441:     # Format for output options is 'mode, restrictions';
  442:     my $selected = 'html, without links';
  443:     if (exists($ENV{'form.'.$elementname})) {
  444:         if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
  445:             $selected = $ENV{'form.'.$elementname}->[0];
  446:         } else {
  447:             $selected = $ENV{'form.'.$elementname};
  448:         }
  449:     }
  450:     #
  451:     # Set package variables describing output mode
  452:     $show_links  = 'no';
  453:     $output_mode = 'html';
  454:     foreach my $option (@OutputOptions) {
  455:         next if ($option->{'value'} ne $selected);
  456:         $output_mode = $option->{'mode'};
  457:         $show_links  = $option->{'show_links'};
  458:     }
  459: 
  460:     #
  461:     # Build the form element
  462:     $Str = qq/<select size="5" name="$elementname">/;
  463:     foreach my $option (@OutputOptions) {
  464:         $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
  465:         $Str .= " selected " if ($option->{'value'} eq $selected);
  466:         $Str .= ">".&mt($option->{'name'})."<\/option>";
  467:     }
  468:     $Str .= "\n</select>";
  469:     return $Str;
  470: }
  471: 
  472: ##
  473: ## Data selector stuff
  474: ##
  475: my @OutputDataOptions =
  476:     (
  477:      { name  => 'Scores Summary',
  478:        base  => 'scores',
  479:        value => 'sum and total',
  480:        shortdesc => 'Total Score and Maximum Possible for each '.
  481:            'Sequence or Folder',
  482:        longdesc => 'The score of each student as well as the '.
  483:            ' maximum possible on each Sequence or Folder.',
  484:        },
  485:      { name  => 'Scores Per Problem',
  486:        base  => 'scores',
  487:        value => 'scores',
  488:        shortdesc => 'Score on each Problem Part',
  489:        longdesc =>'The students score on each problem part, computed as'.
  490:            'the part weight * part awarded',
  491:        },
  492: #     { name  => 'Scores Sum',
  493: #       base  => 'scores',
  494: #       value => 'sum only',
  495: #       shortdesc => 'Sum of Scores on each Problem Part',
  496: #       longdesc =>'The total of the scores of the student on each problem'.
  497: #           ' part in the sequences or folders selected.',
  498: #       },
  499: #     { name  => 'Scores Summary Table Only',
  500: #       base  => 'scores',
  501: #       value => 'final table scores',
  502: #       shortdesc => 'Summary of Scores',
  503: #       longdesc  => 'The average score on each sequence or folder for the '.
  504: #           'selected students.',
  505: #       },
  506:      { name  =>'Tries',
  507:        base  =>'tries',
  508:        value => 'tries',
  509:        shortdesc => 'Number of Tries before success on each Problem Part',
  510:        longdesc =>'The number of tries before success on each problem part.',
  511:        },
  512:      { name  =>'Parts Correct',
  513:        base  =>'tries',
  514:        value => 'parts correct total',
  515:        shortdesc => 'Number of Problem Parts completed successfully.',
  516:        longdesc => 'The Number of Problem Parts completed successfully and '.
  517:            'the maximum possible for each student',
  518:        },
  519: #     { name  =>'Parts Correct',
  520: #       base  =>'tries',
  521: #       value => 'parts correct',
  522: #       shortdesc => 'Number of Problem Parts completed successfully.',
  523: #       longdesc => 'The Number of Problem Parts completed successfully'.
  524: #           ' on each sequence or folder.',
  525: #       },
  526: #     { name  => 'Parts Summary Table Only',
  527: #       base  => 'tries',
  528: #       value => 'final table parts',
  529: #       shortdesc => 'Summary of Parts Correct',
  530: #       longdesc  => 'A summary table of the average number of problem parts '.
  531: #           'students were able to get correct on each sequence.',
  532: #       },
  533:      );
  534: 
  535: sub HTMLifyOutputDataDescriptions {
  536:     my $Str = '';
  537:     $Str .= "<h2>Output Data</h2>\n";
  538:     $Str .= "<dl>\n";
  539:     foreach my $option (@OutputDataOptions) {
  540:         $Str .= '    <dt>'.$option->{'name'}.'</dt>';
  541:         $Str .= '<dd>'.$option->{'longdesc'}.'</dd>'."\n";
  542:     }
  543:     $Str .= "</dl>\n";
  544:     return $Str;
  545: }
  546: 
  547: sub CreateAndParseOutputDataSelector {
  548:     my $Str = '';
  549:     my $elementname = 'chartoutputdata';
  550:     #
  551:     my $selected = 'scores';
  552:     if (exists($ENV{'form.'.$elementname})) {
  553:         if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
  554:             $selected = $ENV{'form.'.$elementname}->[0];
  555:         } else {
  556:             $selected = $ENV{'form.'.$elementname};
  557:         }
  558:     }
  559:     #
  560:     $data = 'scores';
  561:     foreach my $option (@OutputDataOptions) {
  562:         if ($option->{'value'} eq $selected) {
  563:             $data = $option->{'value'};
  564:             $base = $option->{'base'};
  565:             $datadescription = $option->{'shortdesc'};
  566:         }
  567:     }
  568:     #
  569:     # Build the form element
  570:     $Str = qq/<select size="5" name="$elementname">/;
  571:     foreach my $option (@OutputDataOptions) {
  572:         $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
  573:         $Str .= " selected " if ($option->{'value'} eq $data);
  574:         $Str .= ">".&mt($option->{'name'})."<\/option>";
  575:     }
  576:     $Str .= "\n</select>";
  577:     return $Str;
  578: 
  579: }
  580: 
  581: #######################################################
  582: #######################################################
  583: 
  584: =pod
  585: 
  586: =head2 HTML output routines
  587: 
  588: =item &html_initialize($r)
  589: 
  590: Create labels for the columns of student data to show.
  591: 
  592: =item &html_outputstudent($r,$student)
  593: 
  594: Return a line of the chart for a student.
  595: 
  596: =item &html_finish($r)
  597: 
  598: =cut
  599: 
  600: #######################################################
  601: #######################################################
  602: {
  603:     my $padding;
  604:     my $count;
  605: 
  606:     my $nodata_count; # The number of students for which there is no data
  607:     my %prog_state;   # progress state used by loncommon PrgWin routines
  608: 
  609: sub html_initialize {
  610:     my ($r) = @_;
  611:     #
  612:     $padding = ' 'x3;
  613:     $count = 0;
  614:     $nodata_count = 0;
  615:     undef(%prog_state);
  616:     #
  617:     $r->print("<h3>".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}.
  618:               "&nbsp;&nbsp;".localtime(time)."</h3>");
  619: 
  620:     if ($data !~ /^final table/) {
  621:         $r->print("<h3>".$datadescription."</h3>");        
  622:     }
  623:     #
  624:     # Set up progress window for 'final table' display only
  625:     if ($data =~ /^final table/) {
  626:         my $studentcount = scalar(@Apache::lonstatistics::Students); 
  627:         %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
  628:             ($r,'Summary Table Status',
  629:              'Summary Table Compilation Progress', $studentcount);
  630:     }
  631:     my $Str = "<pre>\n";
  632:     # First, the @StudentData fields need to be listed
  633:     my @to_show = &get_student_fields_to_show();
  634:     foreach my $field (@to_show) {
  635:         my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
  636:         my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
  637:         my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
  638:         $Str .= $title.' 'x($width-$base).$padding;
  639:     }
  640:     # Now the selected sequences need to be listed
  641:     foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){
  642:         my $title = $sequence->{'title'};
  643:         my $base  = $sequence->{'base_width'};
  644:         my $width = $sequence->{'width'};
  645:         $Str .= $title.' 'x($width-$base).$padding;
  646:     }
  647:     $Str .= "total</pre>\n";
  648:     $Str .= "<pre>";
  649:     #
  650:     # Check for suppression of output
  651:     if ($data =~ /^final table/) {
  652:         $Str = '';
  653:     }
  654:     $r->print($Str);
  655:     $r->rflush();
  656:     return;
  657: }
  658: 
  659: sub html_outputstudent {
  660:     my ($r,$student) = @_;
  661:     my $Str = '';
  662:     #
  663:     if($count++ % 5 == 0 && $count > 0 && $data !~ /^final table/) {
  664:         $r->print("</pre><pre>");
  665:     }
  666:     # First, the @StudentData fields need to be listed
  667:     my @to_show = &get_student_fields_to_show();
  668:     foreach my $field (@to_show) {
  669:         my $title=$student->{$field};
  670:         my $base = length($title);
  671:         my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
  672:         $Str .= $title.' 'x($width-$base).$padding;
  673:     }
  674:     # Get ALL the students data
  675:     my %StudentsData;
  676:     my @tmp = &Apache::loncoursedata::get_current_state
  677:         ($student->{'username'},$student->{'domain'},undef,
  678:          $ENV{'request.course.id'});
  679:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
  680:         %StudentsData = @tmp;
  681:     }
  682:     if (scalar(@tmp) < 1) {
  683:         $nodata_count++;
  684:         return if ($data =~ /^final table/);
  685:         $Str .= '<font color="blue">No Course Data</font>'."\n";
  686:         $r->print($Str);
  687:         $r->rflush();
  688:         return;
  689:     }
  690:     #
  691:     # By sequence build up the data
  692:     my $studentstats;
  693:     my $PerformanceStr = '';
  694:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
  695:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
  696:         if ($base eq 'tries') {
  697:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
  698:                 &StudentTriesOnSequence($student,\%StudentsData,
  699:                                         $seq,$show_links);
  700:         } else {
  701:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
  702:                 &StudentPerformanceOnSequence($student,\%StudentsData,
  703:                                               $seq,$show_links);
  704:         }
  705:         my $ratio = sprintf("%3d",$score).'/'.sprintf("%3d",$seq_max);
  706:         #
  707:         if ($data eq 'sum and total' || $data eq 'parts correct total') {
  708:             $performance  = $ratio;
  709:             $performance .= ' 'x($seq->{'width'}-length($ratio));
  710:         } elsif ($data eq 'sum only' || $data eq 'parts correct') {
  711:             $performance  = $score;
  712:             $performance .= ' 'x($seq->{'width'}-length($score));
  713:         } else {
  714:             # Pad with extra spaces
  715:             $performance .= ' 'x($seq->{'width'}-$performance_length-
  716:                                  length($ratio)
  717:                                  ).$ratio;
  718:         }
  719:         #
  720:         $Str .= $performance.$padding;
  721:         #
  722:         $studentstats->{$seq->{'symb'}}->{'score'}= $score;
  723:         $studentstats->{$seq->{'symb'}}->{'max'}  = $seq_max;
  724:     }
  725:     #
  726:     # Total it up and store the statistics info.
  727:     my ($score,$max) = (0,0);
  728:     while (my ($symb,$seq_stats) = each (%{$studentstats})) {
  729:         $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
  730:         if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) {
  731:             $Statistics->{$symb}->{'max'} = $seq_stats->{'max'};
  732:         }
  733:         $score += $seq_stats->{'score'};
  734:         $max   += $seq_stats->{'max'};
  735:     }
  736:     $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
  737:     $Str .= " \n";
  738:     #
  739:     # Check for suppressed output and update the progress window if so...
  740:     if ($data =~ /^final table/) {
  741:         $Str = '';
  742:         &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
  743:                                                  'last student');
  744:     }
  745:     #
  746:     $r->print($Str);
  747:     #
  748:     $r->rflush();
  749:     return;
  750: }    
  751: 
  752: sub html_finish {
  753:     my ($r) = @_;
  754:     #
  755:     # Check for suppressed output and close the progress window if so
  756:     if ($data =~ /^final table/) {
  757:         &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  758:     } else {
  759:         $r->print("</pre>\n"); 
  760:     }
  761:     if ($single_student_mode) {
  762:         $r->print(&SingleStudentTotal());
  763:     } else {
  764:         $r->print(&StudentAverageTotal());
  765:     }
  766:     $r->rflush();
  767:     return;
  768: }
  769: 
  770: sub StudentAverageTotal {
  771:     my $Str = "<h3>Summary Tables</h3>\n";
  772:     my $num_students = scalar(@Apache::lonstatistics::Students);
  773:     my $total_ave = 0;
  774:     my $total_max = 0;
  775:     $Str .= '<table border=2 cellspacing="1">'."\n";
  776:     $Str .= "<tr><th>Title</th><th>Average</th><th>Maximum</th></tr>\n";
  777:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
  778:         my $ave;
  779:         if ($num_students > $nodata_count) {
  780:             $ave = int(100*($Statistics->{$seq->{'symb'}}->{'score'}/
  781:                             ($num_students-$nodata_count)))/100;
  782:         } else {
  783:             $ave = 0;
  784:         }
  785:         $total_ave += $ave;
  786:         my $max = $Statistics->{$seq->{'symb'}}->{'max'};
  787:         $total_max += $max;
  788:         $ave = sprintf("%.2f",$ave);
  789:         $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
  790:             '<td align="right">'.$ave.'&nbsp;</td>'.
  791:             '<td align="right">'.$max.'&nbsp;'.'</td></tr>'."\n";
  792:     }
  793:     $total_ave = sprintf('%.2f',$total_ave); # only two digit
  794:     $Str .= "</table>\n";
  795:     $Str .= '<table border=2 cellspacing="1">'."\n";
  796:     $Str .= '<tr><th>Number of Students</th><th>Average</th>'.
  797:         "<th>Maximum</th></tr>\n";
  798:     $Str .= '<tr>'.
  799:         '<td align="right">'.($num_students-$nodata_count).'</td>'.
  800:         '<td align="right">'.$total_ave.'&nbsp;'.'</td>'.
  801:         '<td align="right">'.$total_max.'&nbsp;'.'</td>';
  802:     $Str .= "</table>\n";
  803:     return $Str;
  804: }
  805: 
  806: sub SingleStudentTotal {
  807:     my $student = &Apache::lonstatistics::current_student();
  808:     my $Str = "<h3>Summary table for ".$student->{'fullname'}." ".
  809:         $student->{'username'}.'@'.$student->{'domain'}."</h3>\n";
  810:     $Str .= '<table border=2 cellspacing="1">'."\n";
  811:     $Str .= 
  812:         "<tr><th>Sequence or Folder</th><th>Score</th><th>Maximum</th></tr>\n";
  813:     my $total = 0;
  814:     my $total_max = 0;
  815:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
  816:         my $value = $Statistics->{$seq->{'symb'}}->{'score'};
  817:         my $max = $Statistics->{$seq->{'symb'}}->{'max'};
  818:         $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
  819:             '<td align="right">'.$value.'</td>'.
  820:                 '<td align="right">'.$max.'</td></tr>'."\n";
  821:         $total += $value;
  822:         $total_max +=$max;
  823:     }
  824:     $Str .= '<tr><td><b>Total</b></td>'.
  825:         '<td align="right">'.$total.'</td>'.
  826:         '<td align="right">'.$total_max."</td></tr>\n";
  827:     $Str .= "</table>\n";
  828:     return $Str;
  829: }
  830: 
  831: }
  832: 
  833: #######################################################
  834: #######################################################
  835: 
  836: =pod
  837: 
  838: =head2 EXCEL subroutines
  839: 
  840: =item &excel_initialize($r)
  841: 
  842: =item &excel_outputstudent($r,$student)
  843: 
  844: =item &excel_finish($r)
  845: 
  846: =cut
  847: 
  848: #######################################################
  849: #######################################################
  850: {
  851: 
  852: my $excel_sheet;
  853: my $excel_workbook;
  854: 
  855: my $filename;
  856: my $rows_output;
  857: my $cols_output;
  858: 
  859: my %prog_state; # progress window state
  860: my $request_aborted;
  861: 
  862: my $total_formula;
  863: 
  864: sub excel_initialize {
  865:     my ($r) = @_;
  866:     #
  867:     undef ($excel_sheet);
  868:     undef ($excel_workbook);
  869:     undef ($filename);
  870:     undef ($rows_output);
  871:     undef ($cols_output);
  872:     undef (%prog_state);
  873:     undef ($request_aborted);
  874:     undef ($total_formula);
  875:     #
  876:     my $total_columns = scalar(&get_student_fields_to_show());
  877:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
  878:         # Add 2 because we need a 'sum' and 'total' column for each
  879:         $total_columns += $seq->{'num_assess_parts'}+2;
  880:     }
  881:     if ($data eq 'tries' && $total_columns > 255) {
  882:         $r->print(<<END);
  883: <h2>Unable to Complete Request</h2>
  884: <p>
  885: LON-CAPA is unable to produce your Excel spreadsheet because your selections
  886: will result in more than 255 columns.  Excel allows only 255 columns in a
  887: spreadsheet.
  888: </p><p>
  889: You may consider reducing the number of <b>Sequences or Folders</b> you
  890: have selected.  
  891: </p><p>
  892: LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the
  893: summary data (<b>Parts Correct</b> or <b>Parts Correct & Totals</b>).
  894: </p>
  895: END
  896:        $request_aborted = 1;
  897:     }
  898:     if ($data eq 'scores' && $total_columns > 255) {
  899:         $r->print(<<END);
  900: <h2>Unable to Complete Request</h2>
  901: <p>
  902: LON-CAPA is unable to produce your Excel spreadsheet because your selections
  903: will result in more than 255 columns.  Excel allows only 255 columns in a
  904: spreadsheet.
  905: </p><p>
  906: You may consider reducing the number of <b>Sequences or Folders</b> you
  907: have selected.  
  908: </p><p>
  909: LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the
  910: <b>Scores Summary</b> data.
  911: </p>
  912: END
  913:        $request_aborted = 1;
  914:     }
  915:     if ($data =~ /^final table/) {
  916:         $r->print(<<END);
  917: <h2>Unable to Complete Request</h2>
  918: <p>
  919: The <b>Summary Table (Scores)</b> option is not available for non-HTML output.
  920: </p>
  921: END
  922:        $request_aborted = 1;
  923:     }
  924:     return if ($request_aborted);
  925:     #
  926:     $filename = '/prtspool/'.
  927:         $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
  928:             time.'_'.rand(1000000000).'.xls';
  929:     #
  930:     $excel_workbook = undef;
  931:     $excel_sheet = undef;
  932:     #
  933:     $rows_output = 0;
  934:     $cols_output = 0;
  935:     #
  936:     # Create sheet
  937:     $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
  938:     #
  939:     # Check for errors
  940:     if (! defined($excel_workbook)) {
  941:         $r->log_error("Error creating excel spreadsheet $filename: $!");
  942:         $r->print("Problems creating new Excel file.  ".
  943:                   "This error has been logged.  ".
  944:                   "Please alert your LON-CAPA administrator");
  945:         return ;
  946:     }
  947:     #
  948:     # The excel spreadsheet stores temporary data in files, then put them
  949:     # together.  If needed we should be able to disable this (memory only).
  950:     # The temporary directory must be specified before calling 'addworksheet'.
  951:     # File::Temp is used to determine the temporary directory.
  952:     $excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
  953:     #
  954:     # Add a worksheet
  955:     my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
  956:     $sheetname = &Apache::loncommon::clean_excel_name($sheetname);
  957:     $excel_sheet = $excel_workbook->addworksheet($sheetname);
  958:     #
  959:     # Put the course description in the header
  960:     $excel_sheet->write($rows_output,$cols_output++,
  961:                    $ENV{'course.'.$ENV{'request.course.id'}.'.description'});
  962:     $cols_output += 3;
  963:     #
  964:     # Put a description of the sections listed
  965:     my $sectionstring = '';
  966:     my @Sections = @Apache::lonstatistics::SelectedSections;
  967:     if (scalar(@Sections) > 1) {
  968:         if (scalar(@Sections) > 2) {
  969:             my $last = pop(@Sections);
  970:             $sectionstring = "Sections ".join(', ',@Sections).', and '.$last;
  971:         } else {
  972:             $sectionstring = "Sections ".join(' and ',@Sections);
  973:         }
  974:     } else {
  975:         if ($Sections[0] eq 'all') {
  976:             $sectionstring = "All sections";
  977:         } else {
  978:             $sectionstring = "Section ".$Sections[0];
  979:         }
  980:     }
  981:     $excel_sheet->write($rows_output,$cols_output++,$sectionstring);
  982:     $cols_output += scalar(@Sections);
  983:     #
  984:     # Put the date in there too
  985:     $excel_sheet->write($rows_output++,$cols_output++,
  986:                         'Compiled on '.localtime(time));
  987:     #
  988:     $cols_output = 0;
  989:     $excel_sheet->write($rows_output++,$cols_output++,$datadescription);
  990:     #
  991:     if ($data eq 'tries' || $data eq 'scores') {
  992:         $rows_output++;
  993:     }
  994:     #
  995:     # Add the student headers
  996:     $cols_output = 0;
  997:     foreach my $field (&get_student_fields_to_show()) {
  998:         $excel_sheet->write($rows_output,$cols_output++,$field);
  999:     }
 1000:     my $row_offset = 0;
 1001:     if ($data eq 'tries' || $data eq 'scores') {
 1002:         $row_offset = -1;
 1003:     }
 1004:     #
 1005:     # Add the remaining column headers
 1006:     my $total_formula_string = '=0';
 1007:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
 1008:         $excel_sheet->write($rows_output+$row_offset,
 1009:                             $cols_output,$seq->{'title'});
 1010:         if ($data eq 'tries' || $data eq 'scores') {
 1011:             # Determine starting cell
 1012:             $seq->{'Excel:startcell'}=
 1013:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1014:                 ($rows_output,$cols_output);
 1015:             $seq->{'Excel:startcol'}=$cols_output;
 1016:             # Put the names of the problems and parts into the sheet
 1017:             my $count = 0;
 1018:             foreach my $res (@{$seq->{'contents'}}) {
 1019:                 next if ($res->{'type'} ne 'assessment');
 1020:                 if (scalar(@{$res->{'parts'}}) > 1) {
 1021:                     foreach my $part (@{$res->{'parts'}}) {
 1022:                         $excel_sheet->write($rows_output,
 1023:                                             $cols_output++,
 1024:                                             $res->{'title'}.' part '.$part);
 1025:                     }
 1026:                 } else {
 1027:                     $excel_sheet->write($rows_output,
 1028:                                         $cols_output++,
 1029:                                         $res->{'title'});
 1030:                 }
 1031:                 $count++;
 1032:             }
 1033:             # Determine ending cell
 1034:             if ($count == 1) {
 1035:                 $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'};
 1036:                 $seq->{'Excel:endcol'}  = $seq->{'Excel:startcol'};
 1037:             } else {
 1038:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1039:                     ($rows_output,$cols_output-1);
 1040:                 $seq->{'Excel:endcol'} = $cols_output-1;
 1041:             }
 1042:             # Create the formula for summing up this sequence
 1043:             $seq->{'Excel:sum'}= $excel_sheet->store_formula
 1044:                                         ('=SUM('.$seq->{'Excel:startcell'}.
 1045:                                              ':'.$seq->{'Excel:endcell'}.')');
 1046:         }
 1047:         # Determine cell the score is held in
 1048:         $seq->{'Excel:scorecell'} = 
 1049:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1050:             ($rows_output,$cols_output);
 1051:         $seq->{'Excel:scorecol'}=$cols_output;
 1052:         if ($data eq 'parts correct total') {
 1053:             $excel_sheet->write($rows_output,$cols_output++,'parts correct');
 1054:         } else {
 1055:             $excel_sheet->write($rows_output,$cols_output++,'score');
 1056:         }
 1057:         #
 1058:         $total_formula_string.='+'.
 1059:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1060:             ($rows_output,$cols_output-1);
 1061:         $excel_sheet->write($rows_output,$cols_output++,'maximum');
 1062:     }
 1063:     $excel_sheet->write($rows_output,$cols_output++,'Grand Total');
 1064:     $total_formula = $excel_sheet->store_formula($total_formula_string);
 1065:     #
 1066:     # Bookkeeping
 1067:     if ($data eq 'sum and total' || $data eq 'parts correct total') {
 1068:         $rows_output += 2;
 1069:     } else {
 1070:         $rows_output += 1;
 1071:     }
 1072:     #
 1073:     # Output a row for MAX
 1074:     $cols_output = 0;
 1075:     foreach my $field (&get_student_fields_to_show()) {
 1076:         if ($field eq 'username' || $field eq 'fullname' || 
 1077:             $field eq 'id') {
 1078:             $excel_sheet->write($rows_output,$cols_output++,'Maximum');
 1079:         } else {
 1080:             $excel_sheet->write($rows_output,$cols_output++,'');
 1081:         }
 1082:     }
 1083:     #
 1084:     # Add the maximums for each sequence or assessment
 1085:     my %total_cell_translation;
 1086:     my $grand_total = 0;
 1087:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
 1088:         $total_cell_translation{$seq->{'Excel:scorecell'}} = 
 1089:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1090:                         ($rows_output,$seq->{'Excel:scorecol'});
 1091:         my $weight;
 1092:         my $max = 0;
 1093:         foreach my $resource (@{$seq->{'contents'}}) {
 1094:             next if ($resource->{'type'} ne 'assessment');
 1095:             foreach my $part (@{$resource->{'parts'}}) {
 1096:                 $weight = 1;
 1097:                 if ($base eq 'scores') {
 1098:                     $weight = &Apache::lonnet::EXT
 1099:                         ('resource.'.$part.'.weight',$resource->{'symb'},
 1100:                          undef,undef,undef);
 1101:                     if (!defined($weight) || ($weight eq '')) { 
 1102:                         $weight=1;
 1103:                     }
 1104:                 }
 1105:                 if ($data eq 'scores') {
 1106:                     $excel_sheet->write($rows_output,$cols_output++,$weight);
 1107:                 } elsif ($data eq 'tries') {
 1108:                     $excel_sheet->write($rows_output,$cols_output++,'');
 1109:                 }
 1110:                 $max += $weight;
 1111:             }
 1112:         } 
 1113:         if (! ($data eq 'sum only' || $data eq 'parts correct')) {
 1114:             $excel_sheet->write($rows_output,$cols_output++,'');
 1115:         }
 1116:         #
 1117:         if ($data eq 'tries' || $data eq 'scores') {
 1118:             my %replaceCells;
 1119:             $replaceCells{$seq->{'Excel:startcell'}} = 
 1120:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1121:                 ($rows_output,$seq->{'Excel:startcol'});
 1122:             $replaceCells{$seq->{'Excel:endcell'}} = 
 1123:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1124:                 ($rows_output,$seq->{'Excel:endcol'});
 1125:             $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1126:                                          $seq->{'Excel:sum'},undef,
 1127:                                          %replaceCells);
 1128:         } else {
 1129:             $excel_sheet->write($rows_output,$cols_output++,
 1130:                                 $max);
 1131:         }
 1132:         $grand_total+=$max;
 1133:     }
 1134:     if ($data eq 'tries' || $data eq 'scores') {
 1135:         $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1136:                                      $total_formula,undef,
 1137:                                      %total_cell_translation);
 1138:     } else {
 1139:         $excel_sheet->write($rows_output,$cols_output++,$grand_total);
 1140:     }
 1141:     $rows_output++;
 1142:     #
 1143:     # Let the user know what we are doing
 1144:     my $studentcount = scalar(@Apache::lonstatistics::Students); 
 1145:     $r->print("<h1>Compiling Excel spreadsheet for ".
 1146:               $studentcount.' student');
 1147:     $r->print('s') if ($studentcount > 1);
 1148:     $r->print("</h1>\n");
 1149:     $r->rflush();
 1150:     #
 1151:     # Initialize progress window
 1152:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
 1153:         ($r,'Excel File Compilation Status',
 1154:          'Excel File Compilation Progress', $studentcount);
 1155:     #
 1156:     &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
 1157:                                           'Processing first student');
 1158:     return;
 1159: }
 1160: 
 1161: sub excel_outputstudent {
 1162:     my ($r,$student) = @_;
 1163:     return if ($request_aborted);
 1164:     return if (! defined($excel_sheet));
 1165:     $cols_output=0;
 1166:     #
 1167:     # Write out student data
 1168:     my @to_show = &get_student_fields_to_show();
 1169:     foreach my $field (@to_show) {
 1170:         $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
 1171:     }
 1172:     #
 1173:     # Get student assessment data
 1174:     my %StudentsData;
 1175:     my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
 1176:                                                         $student->{'domain'},
 1177:                                                         undef,
 1178:                                                    $ENV{'request.course.id'});
 1179:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
 1180:         %StudentsData = @tmp;
 1181:     }
 1182:     #
 1183:     # Write out sequence scores and totals data
 1184:     my %total_cell_translation;
 1185:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
 1186:         # Keep track of cells to translate in total cell
 1187:         $total_cell_translation{$seq->{'Excel:scorecell'}} = 
 1188:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1189:                         ($rows_output,$seq->{'Excel:scorecol'});
 1190:         #
 1191:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
 1192:         if ($base eq 'tries') {
 1193:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1194:                 &StudentTriesOnSequence($student,\%StudentsData,
 1195:                                         $seq,'no');
 1196:         } else {
 1197:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1198:                 &StudentPerformanceOnSequence($student,\%StudentsData,
 1199:                                               $seq,'no');
 1200:         }
 1201:         if ($data eq 'tries' || $data eq 'scores') {
 1202:             foreach my $value (@$rawdata) {
 1203:                 $excel_sheet->write($rows_output,$cols_output++,$value);
 1204:             }
 1205:             # Write a formula for the sum of this sequence
 1206:             my %replaceCells;
 1207:             $replaceCells{$seq->{'Excel:startcell'}} = 
 1208:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1209:                             ($rows_output,$seq->{'Excel:startcol'});
 1210:             $replaceCells{$seq->{'Excel:endcell'}} = 
 1211:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1212:                             ($rows_output,$seq->{'Excel:endcol'});
 1213:             # The undef is for the format
 1214:             if (scalar(keys(%replaceCells)) == 1) {
 1215:                 $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1216:                                              $seq->{'Excel:sum'},undef,
 1217:                                              %replaceCells,%replaceCells);
 1218:             } else {
 1219:                 $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1220:                                              $seq->{'Excel:sum'},undef,
 1221:                                              %replaceCells);
 1222:             }
 1223:             #
 1224:             $excel_sheet->write($rows_output,$cols_output++,$seq_max);
 1225:         } elsif ($data eq 'sum and total' || $data eq 'sum only' || 
 1226:             $data eq 'parts correct' || $data eq 'parts correct total') {
 1227:             $excel_sheet->write($rows_output,$cols_output++,$score);
 1228:         }
 1229:         if ($data eq 'sum and total' || $data eq 'parts correct total') {
 1230:             $excel_sheet->write($rows_output,$cols_output++,$seq_max);
 1231:         }
 1232:     }
 1233:     #
 1234:     $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1235:                                  $total_formula,undef,
 1236:                                  %total_cell_translation);
 1237: 
 1238:     #
 1239:     # Bookkeeping
 1240:     $rows_output++; 
 1241:     $cols_output=0;
 1242:     #
 1243:     # Update the progress window
 1244:     &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
 1245:     return;
 1246: }
 1247: 
 1248: sub excel_finish {
 1249:     my ($r) = @_;
 1250:     return if ($request_aborted);
 1251:     return if (! defined($excel_sheet));
 1252:     #
 1253:     # Write the excel file
 1254:     $excel_workbook->close();
 1255:     my $c = $r->connection();
 1256:     #
 1257:     return if($c->aborted());
 1258:     #
 1259:     # Close the progress window
 1260:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
 1261:     #
 1262:     # Tell the user where to get their excel file
 1263:     $r->print('<br />'.
 1264:               '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
 1265:     $r->rflush();
 1266:     return;
 1267: }
 1268: 
 1269: }
 1270: #######################################################
 1271: #######################################################
 1272: 
 1273: =pod
 1274: 
 1275: =head2 CSV output routines
 1276: 
 1277: =item &csv_initialize($r)
 1278: 
 1279: =item &csv_outputstudent($r,$student)
 1280: 
 1281: =item &csv_finish($r)
 1282: 
 1283: =cut
 1284: 
 1285: #######################################################
 1286: #######################################################
 1287: {
 1288: 
 1289: my $outputfile;
 1290: my $filename;
 1291: my $request_aborted;
 1292: my %prog_state; # progress window state
 1293: 
 1294: sub csv_initialize{
 1295:     my ($r) = @_;
 1296:     # 
 1297:     # Clean up
 1298:     undef($outputfile);
 1299:     undef($filename);
 1300:     undef($request_aborted);
 1301:     undef(%prog_state);
 1302:     #
 1303:     # Deal with unimplemented requests
 1304:     $request_aborted = undef;
 1305:     if ($data =~ /final table/) {
 1306:         $r->print(<<END);
 1307: <h2>Unable to Complete Request</h2>
 1308: <p>
 1309: The <b>Summary Table (Scores)</b> option is not available for non-HTML output.
 1310: </p>
 1311: END
 1312:        $request_aborted = 1;
 1313:     }
 1314:     return if ($request_aborted);
 1315: 
 1316:     #
 1317:     # Open a file
 1318:     $filename = '/prtspool/'.
 1319:         $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
 1320:             time.'_'.rand(1000000000).'.csv';
 1321:     unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) {
 1322:         $r->log_error("Couldn't open $filename for output $!");
 1323:         $r->print("Problems occured in writing the csv file.  ".
 1324:                   "This error has been logged.  ".
 1325:                   "Please alert your LON-CAPA administrator.");
 1326:         $outputfile = undef;
 1327:     }
 1328:     #
 1329:     # Datestamp
 1330:     my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
 1331:     print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'.
 1332:         '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'.
 1333:             "\n";
 1334:     #
 1335:     # Print out the headings
 1336:     my $Str = '';
 1337:     my $Str2 = undef;
 1338:     foreach my $field (&get_student_fields_to_show()) {
 1339:         if ($data eq 'sum only') {
 1340:             $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
 1341:         } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
 1342:             $Str .= '"",'; # first row empty on the student fields
 1343:             $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
 1344:         } elsif ($data eq 'scores' || $data eq 'tries' || 
 1345:                  $data eq 'parts correct') {
 1346:             $Str  .= '"",';
 1347:             $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
 1348:         }
 1349:     }
 1350:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
 1351:         if ($data eq 'sum only' || $data eq 'parts correct') {
 1352:             $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
 1353:                 '",';
 1354:         } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
 1355:             $Str  .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
 1356:                 '","",';
 1357:             $Str2 .= '"score","total possible",';
 1358:         } elsif ($data eq 'scores' || $data eq 'tries') {
 1359:             $Str  .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
 1360:                 '",';
 1361:             $Str .= '"",'x($seq->{'num_assess_parts'}-1+2);
 1362:             foreach my $res (@{$seq->{'contents'}}) {
 1363:                 next if ($res->{'type'} ne 'assessment');
 1364:                 foreach my $part (@{$res->{'parts'}}) {
 1365:                     $Str2 .= '"'.&Apache::loncommon::csv_translate($res->{'title'}.', Part '.$part).'",';
 1366:                 }
 1367:             }
 1368:             $Str2 .= '"score","total possible",';
 1369:         }
 1370:     }
 1371:     chop($Str);
 1372:     $Str .= "\n";
 1373:     print $outputfile $Str;
 1374:     if (defined($Str2)) {
 1375:         chop($Str2);
 1376:         $Str2 .= "\n";
 1377:         print $outputfile $Str2;
 1378:     }
 1379:     #
 1380:     # Initialize progress window
 1381:     my $studentcount = scalar(@Apache::lonstatistics::Students);
 1382:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
 1383:         ($r,'CSV File Compilation Status',
 1384:          'CSV File Compilation Progress', $studentcount);
 1385:     return;
 1386: }
 1387: 
 1388: sub csv_outputstudent {
 1389:     my ($r,$student) = @_;
 1390:     return if ($request_aborted);
 1391:     return if (! defined($outputfile));
 1392:     my $Str = '';
 1393:     #
 1394:     # Output student fields
 1395:     my @to_show = &get_student_fields_to_show();
 1396:     foreach my $field (@to_show) {
 1397:         $Str .= '"'.&Apache::loncommon::csv_translate($student->{$field}).'",';
 1398:     }
 1399:     #
 1400:     # Get student assessment data
 1401:     my %StudentsData;
 1402:     my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
 1403:                                                         $student->{'domain'},
 1404:                                                         undef,
 1405:                                                    $ENV{'request.course.id'});
 1406:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
 1407:         %StudentsData = @tmp;
 1408:     }
 1409:     #
 1410:     # Output performance data
 1411:     foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
 1412:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
 1413:         if ($base eq 'tries') {
 1414:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1415:                 &StudentTriesOnSequence($student,\%StudentsData,
 1416:                                         $seq,'no');
 1417:         } else {
 1418:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1419:                 &StudentPerformanceOnSequence($student,\%StudentsData,
 1420:                                               $seq,'no');
 1421:         }
 1422:         if ($data eq 'sum only' || $data eq 'parts correct') {
 1423:             $Str .= '"'.$score.'",';
 1424:         } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
 1425:             $Str  .= '"'.$score.'","'.$seq_max.'",';
 1426:         } elsif ($data eq 'scores' || $data eq 'tries') {
 1427:             $Str .= '"'.join('","',(@$rawdata,$score,$seq_max)).'",';
 1428:         }
 1429:     }
 1430:     chop($Str);
 1431:     $Str .= "\n";
 1432:     print $outputfile $Str;
 1433:     #
 1434:     # Update the progress window
 1435:     &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
 1436:     return;
 1437: }
 1438: 
 1439: sub csv_finish {
 1440:     my ($r) = @_;
 1441:     return if ($request_aborted);
 1442:     return if (! defined($outputfile));
 1443:     close($outputfile);
 1444:     #
 1445:     my $c = $r->connection();
 1446:     return if ($c->aborted());
 1447:     #
 1448:     # Close the progress window
 1449:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
 1450:     #
 1451:     # Tell the user where to get their csv file
 1452:     $r->print('<br />'.
 1453:               '<a href="'.$filename.'">Your csv file.</a>'."\n");
 1454:     $r->rflush();
 1455:     return;
 1456:     
 1457: }
 1458: 
 1459: }
 1460: 
 1461: #######################################################
 1462: #######################################################
 1463: 
 1464: =pod
 1465: 
 1466: =item &StudentTriesOnSequence()
 1467: 
 1468: Inputs:
 1469: 
 1470: =over 4
 1471: 
 1472: =item $student
 1473: 
 1474: =item $studentdata Hash ref to all student data
 1475: 
 1476: =item $seq Hash ref, the sequence we are working on
 1477: 
 1478: =item $links if defined we will output links to each resource.
 1479: 
 1480: =back
 1481: 
 1482: =cut
 1483: 
 1484: #######################################################
 1485: #######################################################
 1486: sub StudentTriesOnSequence {
 1487:     my ($student,$studentdata,$seq,$links) = @_;
 1488:     $links = 'no' if (! defined($links));
 1489:     my $Str = '';
 1490:     my ($sum,$max) = (0,0);
 1491:     my $performance_length = 0;
 1492:     my @TriesData = ();
 1493:     my $tries;
 1494:     foreach my $resource (@{$seq->{'contents'}}) {
 1495:         next if ($resource->{'type'} ne 'assessment');
 1496:         my $resource_data = $studentdata->{$resource->{'symb'}};
 1497:         my $value = '';
 1498:         foreach my $partnum (@{$resource->{'parts'}}) {
 1499:             $tries = undef;
 1500:             $max++;
 1501:             $performance_length++;
 1502:             my $symbol = ' '; # default to space
 1503:             #
 1504:             my $awarded = 0;
 1505:             if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) {
 1506:                 $awarded = $resource_data->{'resource.'.$partnum.'.awarded'};
 1507:                 $awarded = 0 if (! $awarded);
 1508:             }
 1509:             #
 1510:             my $status = '';
 1511:             if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
 1512:                 $status = $resource_data->{'resource.'.$partnum.'.solved'};
 1513:             }
 1514:             #
 1515:             my $tries = 0;
 1516:             if(exists($resource_data->{'resource.'.$partnum.'.tries'})) {
 1517:                 $tries = $resource_data->{'resource.'.$partnum.'.tries'};
 1518:             }
 1519:             #
 1520:             if ($awarded > 0) {
 1521:                 # The student has gotten the problem correct to some degree
 1522:                 if ($status eq 'excused') {
 1523:                     $symbol = 'x';
 1524:                     $max--;
 1525:                 } elsif ($status eq 'correct_by_override') {
 1526:                     $symbol = '+';
 1527:                     $sum++;
 1528:                 } elsif ($tries > 0) {
 1529:                     if ($tries > 9) {
 1530:                         $symbol = '*';
 1531:                     } else {
 1532:                         $symbol = $tries;
 1533:                     }
 1534:                     $sum++;
 1535:                 } else {
 1536:                     $symbol = '+';
 1537:                     $sum++;
 1538:                 }
 1539:             } else {
 1540:                 # The student has the problem incorrect or it is ungraded
 1541:                 if ($status eq 'excused') {
 1542:                     $symbol = 'x';
 1543:                     $max--;
 1544:                 } elsif ($status eq 'incorrect_by_override') {
 1545:                     $symbol = '-';
 1546:                 } elsif ($status eq 'ungraded_attempted') {
 1547:                     $symbol = '#';
 1548:                 } elsif ($status eq 'incorrect_attempted' ||
 1549:                          $tries > 0)  {
 1550:                     $symbol = '.';
 1551:                 } else {
 1552:                     # Problem is wrong and has not been attempted.
 1553:                     $symbol=' ';
 1554:                 }
 1555:             }
 1556:             #
 1557:             if (! defined($tries)) {
 1558:                 $tries = $symbol;
 1559:             }
 1560:             push (@TriesData,$tries);
 1561:             #
 1562:             if ( ($links eq 'yes' && $symbol ne ' ') ||
 1563:                  ($links eq 'all')) {
 1564:                 if (length($symbol) > 1) {
 1565:                     &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
 1566:                 }
 1567:                 $symbol = '<a href="/adm/grades'.
 1568:                     '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
 1569:                         '&student='.$student->{'username'}.
 1570:                             '&userdom='.$student->{'domain'}.
 1571:                                 '&command=submission">'.$symbol.'</a>';
 1572:             }
 1573:             $value .= $symbol;
 1574:         }
 1575:         $Str .= $value;
 1576:     }
 1577:     if ($seq->{'randompick'}) {
 1578:         $max = $seq->{'randompick'};
 1579:     }
 1580:     return ($Str,$performance_length,$sum,$max,\@TriesData);
 1581: }
 1582: 
 1583: #######################################################
 1584: #######################################################
 1585: 
 1586: =pod
 1587: 
 1588: =item &StudentPerformanceOnSequence()
 1589: 
 1590: Inputs:
 1591: 
 1592: =over 4
 1593: 
 1594: =item $student
 1595: 
 1596: =item $studentdata Hash ref to all student data
 1597: 
 1598: =item $seq Hash ref, the sequence we are working on
 1599: 
 1600: =item $links if defined we will output links to each resource.
 1601: 
 1602: =back
 1603: 
 1604: =cut
 1605: 
 1606: #######################################################
 1607: #######################################################
 1608: sub StudentPerformanceOnSequence {
 1609:     my ($student,$studentdata,$seq,$links) = @_;
 1610:     $links = 'no' if (! defined($links));
 1611:     my $Str = ''; # final result string
 1612:     my ($score,$max) = (0,0);
 1613:     my $performance_length = 0;
 1614:     my $symbol;
 1615:     my @ScoreData = ();
 1616:     my $partscore;
 1617:     foreach my $resource (@{$seq->{'contents'}}) {
 1618:         next if ($resource->{'type'} ne 'assessment');
 1619:         my $resource_data = $studentdata->{$resource->{'symb'}};
 1620:         foreach my $part (@{$resource->{'parts'}}) {
 1621:             $partscore = undef;
 1622:             my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
 1623:                                               $resource->{'symb'},
 1624:                                               $student->{'domain'},
 1625:                                               $student->{'username'},
 1626:                                               $student->{'section'});
 1627:             if (!defined($weight) || ($weight eq '')) { 
 1628:                 $weight=1;
 1629:             }
 1630:             #
 1631:             $max += $weight; # see the 'excused' branch below...
 1632:             $performance_length++; # one character per part
 1633:             $symbol = ' '; # default to space
 1634:             #
 1635:             my $awarded = 0;
 1636:             if (exists($resource_data->{'resource.'.$part.'.awarded'})) {
 1637:                 $awarded = $resource_data->{'resource.'.$part.'.awarded'};
 1638:                 $awarded = 0 if (! $awarded);
 1639:             }
 1640:             #
 1641:             $partscore = $weight*$awarded;
 1642:             $score += $partscore;
 1643:             $symbol = $partscore; 
 1644:             if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) {
 1645:                 $symbol = sprintf("%.0f",$symbol);
 1646:             }
 1647:             if (length($symbol) > 1) {
 1648:                 $symbol = '*';
 1649:             }
 1650:             if (exists($resource_data->{'resource.'.$part.'.solved'})) {
 1651:                 my $status = $resource_data->{'resource.'.$part.'.solved'};
 1652:                 if ($status eq 'excused') {
 1653:                     $symbol = 'x';
 1654:                     $max -= $weight; # Do not count 'excused' problems.
 1655:                 }
 1656:             } else {
 1657:                 # Unsolved.  Did they try?
 1658:                 if (exists($resource_data->{'resource.'.$part.'.tries'})){
 1659:                     $symbol = '.';
 1660:                 } else {
 1661:                     $symbol = ' ';
 1662:                 }
 1663:             }
 1664:             #
 1665:             if (! defined($partscore)) {
 1666:                 $partscore = $symbol;
 1667:             }
 1668:             push (@ScoreData,$partscore);
 1669:             #
 1670:             if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
 1671:                 $symbol = '<a href="/adm/grades'.
 1672:                     '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
 1673:                     '&student='.$student->{'username'}.
 1674:                     '&userdom='.$student->{'domain'}.
 1675:                     '&command=submission">'.$symbol.'</a>';
 1676:             }
 1677:             $Str .= $symbol;
 1678:         }
 1679:     }
 1680:     return ($Str,$performance_length,$score,$max,\@ScoreData);
 1681: }
 1682: 
 1683: #######################################################
 1684: #######################################################
 1685: 
 1686: =pod
 1687: 
 1688: =item &CreateLegend()
 1689: 
 1690: This function returns a formatted string containing the legend for the
 1691: chart.  The legend describes the symbols used to represent grades for
 1692: problems.
 1693: 
 1694: =cut
 1695: 
 1696: #######################################################
 1697: #######################################################
 1698: sub CreateLegend {
 1699:     my $Str = "<p><pre>".
 1700:               "   1  correct by student in 1 try\n".
 1701:               "   7  correct by student in 7 tries\n".
 1702:               "   *  correct by student in more than 9 tries\n".
 1703: 	      "   +  correct by hand grading or override\n".
 1704:               "   -  incorrect by override\n".
 1705: 	      "   .  incorrect attempted\n".
 1706: 	      "   #  ungraded attempted\n".
 1707:               "      not attempted (blank field)\n".
 1708: 	      "   x  excused".
 1709:               "</pre><p>";
 1710:     return $Str;
 1711: }
 1712: 
 1713: #######################################################
 1714: #######################################################
 1715: 
 1716: =pod 
 1717: 
 1718: =back
 1719: 
 1720: =cut
 1721: 
 1722: #######################################################
 1723: #######################################################
 1724: 
 1725: 1;
 1726: 
 1727: __END__

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