File:  [LON-CAPA] / loncom / interface / statistics / lonstudentassessment.pm
Revision 1.143: download - view: text, annotated - select for diffs
Fri Aug 18 15:15:38 2006 UTC (17 years, 10 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_2_X, version_2_2_99_0, version_2_2_2, version_2_2_1, version_2_2_0, HEAD
Bug 4954.  Filter title changed from "Enrollment Status" to "Access Status".  Access Status selections in lonhtmlcommon set to:
Currently Has Access
Will Have Future Access
Previously Had Access
Any Access Status
See comment appended to bug 4954 for more information.
Documentation updated to include ability to selectively display students with future access.

    1: # The LearningOnline Network with CAPA
    2: #
    3: # $Id: lonstudentassessment.pm,v 1.143 2006/08/18 15:15:38 raeburn 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 Apache::grades();
   60: use Apache::lonmsgdisplay();
   61: use Time::HiRes;
   62: use Spreadsheet::WriteExcel;
   63: use Spreadsheet::WriteExcel::Utility();
   64: use lib '/home/httpd/lib/perl/';
   65: use LONCAPA;
   66:  
   67: 
   68: #######################################################
   69: #######################################################
   70: =pod
   71: 
   72: =item Package Variables
   73: 
   74: =over 4
   75: 
   76: =item $Statistics Hash ref to store student data.  Indexed by symb,
   77:       contains hashes with keys 'score' and 'max'.
   78: 
   79: =cut
   80: 
   81: #######################################################
   82: #######################################################
   83: 
   84: my $Statistics;
   85: 
   86: #######################################################
   87: #######################################################
   88: 
   89: =pod
   90: 
   91: =item $show_links 'yes' or 'no' for linking to student performance data
   92: 
   93: =item $output_mode 'html', 'excel', or 'csv' for output mode
   94: 
   95: =item $show 'all', 'totals', or 'scores' determines how much data is output
   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 $chosen_output;
  107: my $single_student_mode;
  108: 
  109: #######################################################
  110: #######################################################
  111: # End of package variable declarations
  112: 
  113: =pod
  114: 
  115: =back
  116: 
  117: =cut
  118: 
  119: #######################################################
  120: #######################################################
  121: 
  122: =pod
  123: 
  124: =item &BuildStudentAssessmentPage()
  125: 
  126: Inputs: 
  127: 
  128: =over 4
  129: 
  130: =item $r Apache Request
  131: 
  132: =item $c Apache Connection 
  133: 
  134: =back
  135: 
  136: =cut
  137: 
  138: #######################################################
  139: #######################################################
  140: sub BuildStudentAssessmentPage {
  141:     my ($r,$c)=@_;
  142:     #
  143:     undef($Statistics);
  144:     undef($show_links);
  145:     undef($output_mode);
  146:     undef($chosen_output);
  147:     undef($single_student_mode);
  148:     #
  149:     my %Saveable_Parameters = ('Status' => 'scalar',
  150:                                'chartoutputmode' => 'scalar',
  151:                                'chartoutputdata' => 'scalar',
  152:                                'Section' => 'array',
  153:                                'Groups' => 'array',
  154:                                'StudentData' => 'array',
  155:                                'Maps' => 'array');
  156:     &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters);
  157:     &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters);
  158:     #
  159:     &Apache::lonstatistics::PrepareClasslist();
  160:     #
  161:     $single_student_mode = 0;
  162:     $single_student_mode = 1 if ($env{'form.SelectedStudent'});
  163:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  164:                                             ['selectstudent']);
  165:     if ($env{'form.selectstudent'}) {
  166:         &Apache::lonstatistics::DisplayClasslist($r);
  167:         return;
  168:     }
  169:     #
  170:     # Print out the HTML headers for the interface
  171:     #    This also parses the output mode selector
  172:     #    This step must *always* be done.
  173:     $r->print(&CreateInterface());
  174:     $r->print('<input type="hidden" name="notfirstrun" value="true" />');
  175:     $r->print('<input type="hidden" name="sort" value="'.
  176:               $env{'form.sort'}.'" />');
  177:     $r->rflush();
  178:     #
  179:     if (! exists($env{'form.notfirstrun'}) && ! $single_student_mode) {
  180:         return;
  181:     }
  182:     $r->print('<h4>'.
  183:               &Apache::lonstatistics::section_and_enrollment_description().
  184:               '</h4>');
  185:     #
  186:     my $initialize     = \&html_initialize;
  187:     my $output_student = \&html_outputstudent;
  188:     my $finish         = \&html_finish;
  189:     #
  190:     if ($output_mode eq 'excel') {
  191:         $initialize     = \&excel_initialize;
  192:         $output_student = \&excel_outputstudent;
  193:         $finish         = \&excel_finish;
  194:     } elsif ($output_mode eq 'csv') {
  195:         $initialize     = \&csv_initialize;
  196:         $output_student = \&csv_outputstudent;
  197:         $finish         = \&csv_finish;
  198:     }
  199:     #
  200:     if($c->aborted()) {  return ; }
  201:     #
  202:     # Determine which students we want to look at
  203:     my @Students;
  204:     if ($single_student_mode) {
  205:         @Students = (&Apache::lonstatistics::current_student());
  206:         $r->print(&next_and_previous_buttons());
  207:         $r->rflush();
  208:     } else {
  209:         @Students = @Apache::lonstatistics::Students;
  210:     }
  211:     #
  212:     # Perform generic initialization tasks
  213:     #       Since we use lonnet::EXT to retrieve problem weights,
  214:     #       to ensure current data we must clear the caches out.
  215:     #       This makes sure that parameter changes at the student level
  216:     #       are immediately reflected in the chart.
  217:     &Apache::lonnet::clear_EXT_cache_status();
  218:     #
  219:     # Clean out loncoursedata's package data, just to be safe.
  220:     &Apache::loncoursedata::clear_internal_caches();
  221:     #
  222:     # Call the initialize routine selected above
  223:     $initialize->($r);
  224:     foreach my $student (@Students) {
  225:         if($c->aborted()) { 
  226:             $finish->($r);
  227:             return ; 
  228:         }
  229:         # Call the output_student routine selected above
  230:         $output_student->($r,$student);
  231:     }
  232:     # Call the "finish" routine selected above
  233:     $finish->($r);
  234:     #
  235:     return;
  236: }
  237: 
  238: #######################################################
  239: #######################################################
  240: sub next_and_previous_buttons {
  241:     my $Str = '';
  242:     $Str .= '<input type="hidden" name="SelectedStudent" value="'.
  243:         $env{'form.SelectedStudent'}.'" />';
  244:     #
  245:     # Build the previous student link
  246:     my $previous = &Apache::lonstatistics::previous_student();
  247:     my $previousbutton = '';
  248:     if (defined($previous)) {
  249:         my $sname = $previous->{'username'}.':'.$previous->{'domain'};
  250:         $previousbutton .= '<input type="button" value="'.
  251:             'Previous Student ('.
  252:             $previous->{'username'}.'@'.$previous->{'domain'}.')'.
  253:             '" onclick="document.Statistics.SelectedStudent.value='.
  254:             "'".$sname."'".';'.
  255:             'document.Statistics.submit();" />';
  256:     } else {
  257:         $previousbutton .= '<input type="button" value="'.
  258:             'Previous student (none)'.'" />';
  259:     }
  260:     #
  261:     # Build the next student link
  262:     my $next = &Apache::lonstatistics::next_student();
  263:     my $nextbutton = '';
  264:     if (defined($next)) {
  265:         my $sname = $next->{'username'}.':'.$next->{'domain'};
  266:         $nextbutton .= '<input type="button" value="'.
  267:             'Next Student ('.
  268:             $next->{'username'}.'@'.$next->{'domain'}.')'.
  269:             '" onclick="document.Statistics.SelectedStudent.value='.
  270:             "'".$sname."'".';'.
  271:             'document.Statistics.submit();" />';
  272:     } else {
  273:         $nextbutton .= '<input type="button" value="'.
  274:             'Next student (none)'.'" />';
  275:     }
  276:     #
  277:     # Build the 'all students' button
  278:     my $all = '';
  279:     $all .= '<input type="button" value="All Students" '.
  280:             '" onclick="document.Statistics.SelectedStudent.value='.
  281:             "''".';'.'document.Statistics.submit();" />';
  282:     $Str .= $previousbutton.('&nbsp;'x5).$all.('&nbsp;'x5).$nextbutton;
  283:     return $Str;
  284: }
  285: 
  286: #######################################################
  287: #######################################################
  288: 
  289: sub get_student_fields_to_show {
  290:     my @to_show = @Apache::lonstatistics::SelectedStudentData;
  291:     foreach (@to_show) {
  292:         if ($_ eq 'all') {
  293:             @to_show = @Apache::lonstatistics::StudentDataOrder;
  294:             last;
  295:         }
  296:     }
  297:     return @to_show;
  298: }
  299: 
  300: #######################################################
  301: #######################################################
  302: 
  303: =pod
  304: 
  305: =item &CreateInterface()
  306: 
  307: Called by &BuildStudentAssessmentPage to create the top part of the
  308: page which displays the chart.
  309: 
  310: Inputs: None
  311: 
  312: Returns:  A string containing the HTML for the headers and top table for 
  313: the chart page.
  314: 
  315: =cut
  316: 
  317: #######################################################
  318: #######################################################
  319: sub CreateInterface {
  320:     my $Str = '';
  321:     $Str .= &Apache::lonhtmlcommon::breadcrumbs('Chart','Chart_Description:Chart_Sections:Chart_Student_Data:Chart_Enrollment_Status:Chart_Sequences:Chart_Output_Formats:Chart_Output_Data');
  322: #    $Str .= &CreateLegend();
  323:     $Str .= '<table cellspacing="5">'."\n";
  324:     $Str .= '<tr>';
  325:     $Str .= '<td align="center"><b>'.&mt('Sections').'</b>'.
  326: 	&Apache::loncommon::help_open_topic("Chart_Sections").
  327: 	'</td>';
  328:     $Str .= '<td align="center"><b>'.&mt('Groups').'</b>'.
  329: 	'</td>';
  330:     $Str .= '<td align="center"><b>'.&mt('Student Data</b>').
  331: 	&Apache::loncommon::help_open_topic("Chart_Student_Data").
  332: 	'</td>';
  333:     $Str .= '<td align="center"><b>'.&mt('Access Status').'</b>'.
  334: 	&Apache::loncommon::help_open_topic("Chart_Enrollment_Status").
  335: 	'</td>';
  336:     $Str .= '<td align="center"><b>'.&mt('Sequences and Folders').'</b>'.
  337: 	&Apache::loncommon::help_open_topic("Chart_Sequences").
  338: 	'</td>';
  339:     $Str .= '<td align="center"><b>'.&mt('Output Format').'</b>'.
  340:         &Apache::loncommon::help_open_topic("Chart_Output_Formats").
  341:         '</td>';
  342:     $Str .= '<td align="center"><b>'.&mt('Output Data').'</b>'.
  343:         &Apache::loncommon::help_open_topic("Chart_Output_Data").
  344:         '</td>';
  345:     $Str .= '</tr>'."\n";
  346:     #
  347:     $Str .= '<tr><td align="center">'."\n";
  348:     $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
  349:     $Str .= '</td><td align="center">';
  350:     $Str .= &Apache::lonstatistics::GroupSelect('Group','multiple',5);
  351:     $Str .= '</td><td align="center">';
  352:     $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
  353:                                                       5,undef);
  354:     $Str .= '</td><td>'."\n";
  355:     $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5);
  356:     $Str .= '</td><td>'."\n";
  357:     $Str .= &Apache::lonstatistics::map_select('Maps','multiple,all',5);
  358:     $Str .= '</td><td>'."\n";
  359:     $Str .= &CreateAndParseOutputSelector();
  360:     $Str .= '</td><td>'."\n";
  361:     $Str .= &CreateAndParseOutputDataSelector();
  362:     $Str .= '</td></tr>'."\n";
  363:     $Str .= '</table>'."\n";
  364:     $Str .= '<input type="submit" name="Generate Chart" value="'.
  365:         &mt('Generate Chart').'" />';
  366:     $Str .= '&nbsp;'x5;
  367:     $Str .= '<input type="submit" name="selectstudent" value="'.
  368:         &mt('Select One Student').'" />';
  369:     $Str .= '&nbsp;'x5;
  370:     $Str .= '<input type="submit" name="ClearCache" value="'.
  371:         &mt('Clear Caches').'" />';
  372:     $Str .= '&nbsp;'x5;
  373:     $Str .= 
  374:         &mt('Status [_1]',
  375:             '<input type="text" name="stats_status" size="60" value="" />');
  376:     $Str .= '<br />';
  377:     return $Str;
  378: }
  379: 
  380: #######################################################
  381: #######################################################
  382: 
  383: =pod
  384: 
  385: =item &CreateAndParseOutputSelector()
  386: 
  387: =cut
  388: 
  389: #######################################################
  390: #######################################################
  391: my @OutputOptions = 
  392:     ({ name  => 'HTML, with links',
  393:        value => 'html, with links',
  394:        description => 'Output HTML with each symbol linked to the problem '.
  395: 	   'which generated it.',
  396:        mode => 'html',
  397:        show_links => 'yes',
  398:        },
  399:      { name  => 'HTML, with all links',
  400:        value => 'html, with all links',
  401:        description => 'Output HTML with each symbol linked to the problem '.
  402: 	   'which generated it.  '.
  403:            'This includes links for unattempted problems.',
  404:        mode => 'html',
  405:        show_links => 'all',
  406:        },
  407:      { name  => 'HTML, without links',
  408:        value => 'html, without links',
  409:        description => 'Output HTML.  By not including links, the size of the'.
  410: 	   ' web page is greatly reduced.  If your browser crashes on the '.
  411: 	   'full display, try this.',
  412:        mode => 'html',
  413:        show_links => 'no',
  414:            },
  415:      { name  => 'Excel',
  416:        value => 'excel',
  417:        description => 'Output an Excel file (compatable with Excel 95).',
  418:        mode => 'excel',
  419:        show_links => 'no',
  420:    },
  421:      { name  => 'CSV',
  422:        value => 'csv',
  423:        description => 'Output a comma separated values file suitable for '.
  424:            'import into a spreadsheet program.  Using this method as opposed '.
  425:            'to Excel output allows you to organize your data before importing'.
  426:            ' it into a spreadsheet program.',
  427:        mode => 'csv',
  428:        show_links => 'no',
  429:            },
  430:      );
  431: 
  432: sub OutputDescriptions {
  433:     my $Str = '';
  434:     $Str .= "<h2>Output Formats</h2>\n";
  435:     $Str .= "<dl>\n";
  436:     foreach my $outputmode (@OutputOptions) {
  437: 	$Str .="    <dt>".$outputmode->{'name'}."</dt>\n";
  438: 	$Str .="        <dd>".$outputmode->{'description'}."</dd>\n";
  439:     }
  440:     $Str .= "</dl>\n";
  441:     return $Str;
  442: }
  443: 
  444: sub CreateAndParseOutputSelector {
  445:     my $Str = '';
  446:     my $elementname = 'chartoutputmode';
  447:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  448:                                             [$elementname]);
  449:     #
  450:     # Format for output options is 'mode, restrictions';
  451:     my $selected = (&Apache::loncommon::get_env_multiple('form.'.$elementname))[0];
  452:     $selected = 'html, without links' if (!$selected);
  453: 
  454:     #
  455:     # Set package variables describing output mode
  456:     $show_links  = 'no';
  457:     $output_mode = 'html';
  458:     foreach my $option (@OutputOptions) {
  459:         next if ($option->{'value'} ne $selected);
  460:         $output_mode = $option->{'mode'};
  461:         $show_links  = $option->{'show_links'};
  462:     }
  463: 
  464:     #
  465:     # Build the form element
  466:     $Str = qq/<select size="5" name="$elementname">/;
  467:     foreach my $option (@OutputOptions) {
  468:         $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
  469:         $Str .= " selected " if ($option->{'value'} eq $selected);
  470:         $Str .= ">".&mt($option->{'name'})."<\/option>";
  471:     }
  472:     $Str .= "\n</select>";
  473:     return $Str;
  474: }
  475: 
  476: ##
  477: ## Data selector stuff
  478: ##
  479: my @OutputDataOptions =
  480:     (
  481:      { name  => 'Scores Summary',
  482:        base  => 'scores',
  483:        value => 'sum and total',
  484:        scores => 1,
  485:        tries  => 0,
  486:        every_problem => 0,
  487:        sequence_sum => 1,
  488:        sequence_max => 1,
  489:        grand_total => 1,
  490:        grand_maximum => 1,
  491:        summary_table => 1,
  492:        maximum_row => 1,
  493:        ignore_weight => 0,
  494:        shortdesc => 'Total Score and Maximum Possible for each '.
  495:            'Sequence or Folder',
  496:        longdesc => 'The score of each student as well as the '.
  497:            ' maximum possible on each Sequence or Folder.',
  498:        },
  499:      { name  => 'Scores Per Problem',
  500:        base  => 'scores',
  501:        value => 'scores',
  502:        scores => 1,
  503:        tries  => 0,
  504:        correct => 0,
  505:        every_problem => 1,
  506:        sequence_sum => 1,
  507:        sequence_max => 1,
  508:        grand_total => 1,
  509:        grand_maximum => 1,
  510:        summary_table => 1,
  511:        maximum_row => 1,
  512:        ignore_weight => 0,
  513:        shortdesc => 'Score on each Problem Part',
  514:        longdesc =>'The students score on each problem part, computed as'.
  515:            'the part weight * part awarded',
  516:        },
  517:      { name  =>'Tries',
  518:        base  =>'tries',
  519:        value => 'tries',
  520:        scores => 0,
  521:        tries  => 1,
  522:        correct => 0,
  523:        every_problem => 1,
  524:        sequence_sum => 0,
  525:        sequence_max => 0,
  526:        grand_total => 0,
  527:        grand_maximum => 0,
  528:        summary_table => 0,
  529:        maximum_row => 0,
  530:        ignore_weight => 0,
  531:        shortdesc => 'Number of Tries before success on each Problem Part',
  532:        longdesc =>'The number of tries before success on each problem part.',
  533:        non_html_notes => 'negative values indicate an incorrect problem',
  534:        },
  535:      { name  =>'Parts Correct',
  536:        base  =>'tries',
  537:        value => 'parts correct total',
  538:        scores => 0,
  539:        tries  => 0,
  540:        correct => 1,
  541:        every_problem => 1,
  542:        sequence_sum => 1,
  543:        sequence_max => 1,
  544:        grand_total => 1,
  545:        grand_maximum => 1,
  546:        summary_table => 1,
  547:        maximum_row => 0,
  548:        ignore_weight => 1,
  549:        shortdesc => 'Number of Problem Parts completed successfully.',
  550:        longdesc => 'The Number of Problem Parts completed successfully and '.
  551:            'the maximum possible for each student',
  552:        },
  553:      );
  554: 
  555: sub HTMLifyOutputDataDescriptions {
  556:     my $Str = '';
  557:     $Str .= "<h2>Output Data</h2>\n";
  558:     $Str .= "<dl>\n";
  559:     foreach my $option (@OutputDataOptions) {
  560:         $Str .= '    <dt>'.$option->{'name'}.'</dt>';
  561:         $Str .= '<dd>'.$option->{'longdesc'}.'</dd>'."\n";
  562:     }
  563:     $Str .= "</dl>\n";
  564:     return $Str;
  565: }
  566: 
  567: sub CreateAndParseOutputDataSelector {
  568:     my $Str = '';
  569:     my $elementname = 'chartoutputdata';
  570:     #
  571:     my $selected = (&Apache::loncommon::get_env_multiple('form.'.$elementname))[0];
  572:     $selected = 'scores' if (!$selected);
  573: 
  574:     #
  575:     $chosen_output = $OutputDataOptions[0];
  576:     foreach my $option (@OutputDataOptions) {
  577:         if ($option->{'value'} eq $selected) {
  578:             $chosen_output = $option;
  579:         }
  580:     }
  581:     #
  582:     # Build the form element
  583:     $Str = qq/<select size="5" name="$elementname">/;
  584:     foreach my $option (@OutputDataOptions) {
  585:         $Str .= "\n".'    <option value="'.$option->{'value'}.'"';
  586:         $Str .= " selected " if ($option->{'value'} eq $chosen_output->{'value'});
  587:         $Str .= ">".&mt($option->{'name'})."<\/option>";
  588:     }
  589:     $Str .= "\n</select>";
  590:     return $Str;
  591: 
  592: }
  593: 
  594: #######################################################
  595: #######################################################
  596: sub count_parts {
  597:     my ($navmap,$sequence) = @_;
  598:     my @resources = &get_resources($navmap,$sequence);
  599:     my $count = 0;
  600:     foreach my $res (@resources) {
  601:         $count += scalar(@{$res->parts});
  602:     }
  603:     return $count;
  604: }
  605: 
  606: sub get_resources {
  607:     my ($navmap,$sequence) = @_;
  608:     my @resources = $navmap->retrieveResources($sequence,
  609:                                                sub { shift->is_problem(); },
  610:                                                0,0,0);
  611:     return @resources;
  612: }
  613: 
  614: #######################################################
  615: #######################################################
  616: 
  617: =pod
  618: 
  619: =head2 HTML output routines
  620: 
  621: =item &html_initialize($r)
  622: 
  623: Create labels for the columns of student data to show.
  624: 
  625: =item &html_outputstudent($r,$student)
  626: 
  627: Return a line of the chart for a student.
  628: 
  629: =item &html_finish($r)
  630: 
  631: =cut
  632: 
  633: #######################################################
  634: #######################################################
  635: {
  636:     my $padding;
  637:     my $count;
  638: 
  639:     my $nodata_count; # The number of students for which there is no data
  640:     my %prog_state;   # progress state used by loncommon PrgWin routines
  641:     my $total_sum_width;
  642: 
  643:     my %width; # Holds sequence width information
  644:     my @sequences;
  645:     my $navmap; # Have to keep this around since weakref is a bit zealous
  646: 
  647: sub html_cleanup {
  648:     undef(%prog_state);
  649:     undef(%width);
  650:     #
  651:     undef($navmap);
  652:     undef(@sequences);
  653: }
  654: 
  655: sub html_initialize {
  656:     my ($r) = @_;
  657:     #
  658:     $padding = ' 'x3;
  659:     $count = 0;
  660:     $nodata_count = 0;
  661:     &html_cleanup();
  662:     ($navmap,@sequences) = 
  663:         &Apache::lonstatistics::selected_sequences_with_assessments();
  664:     if (! ref($navmap)) {
  665:         # Unable to get data, so bail out
  666:         $r->print("<h3>".
  667:                   &mt('Unable to retrieve course information.').
  668:                   '</h3>');
  669:     }
  670: 
  671:     # If we're showing links, show a checkbox to open in new
  672:     # windows.
  673:     if ($show_links ne 'no') {
  674:         $r->print(<<NEW_WINDOW_CHECKBOX);
  675: <script type="text/javascript">new_window = true;</script>
  676: <p><label>Show links in new window: 
  677: <input type="checkbox" checked="1" onclick="new_window=this.checked" />
  678: </label></p>
  679: NEW_WINDOW_CHECKBOX
  680:     }
  681: 
  682:     #
  683:     $r->print("<h3>".$env{'course.'.$env{'request.course.id'}.'.description'}.
  684:               "&nbsp;&nbsp;".localtime(time)."</h3>");
  685:     #
  686:     if ($chosen_output->{'base'} !~ /^final table/) {
  687:         $r->print("<h3>".$chosen_output->{'shortdesc'}."</h3>");        
  688:     }
  689:     my $Str = "<pre>\n";
  690:     # First, the @StudentData fields need to be listed
  691:     my @to_show = &get_student_fields_to_show();
  692:     foreach my $field (@to_show) {
  693:         my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
  694:         my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
  695:         my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
  696:         $Str .= $title.' 'x($width-$base).$padding;
  697:     }
  698:     #
  699:     # Compute the column widths and output the sequence titles
  700:     my $total_count;
  701:     #
  702:     # Compute sequence widths
  703:     my $starttime = Time::HiRes::time;
  704:     foreach my $seq (@sequences) {
  705:         my $symb = $seq->symb;
  706:         my $title = $seq->compTitle;
  707:         $width{$symb}->{'width_sum'} = 0;
  708:         # Compute width of sum
  709:         if ($chosen_output->{'sequence_sum'}) {
  710:             if ($chosen_output->{'every_problem'}) {
  711:                 # Use 1 digit for a space
  712:                 $width{$symb}->{'width_sum'} += 1;            
  713:             }
  714: 	    $total_count += &count_parts($navmap,$seq);
  715:             # Use 3 digits for the sum
  716:             $width{$symb}->{'width_sum'} += 3;
  717:         }
  718:         # Compute width of maximum
  719:         if ($chosen_output->{'sequence_max'}) {
  720:             if ($width{$symb}->{'width_sum'}>0) {
  721:                 # One digit for the '/'
  722:                 $width{$symb}->{'width_sum'} +=1;
  723:             }
  724:             # Use 3 digits for the total
  725:             $width{$symb}->{'width_sum'}+=3;
  726:         }
  727: 	#
  728:         if ($chosen_output->{'every_problem'}) {
  729:             # one problem per digit
  730:             $width{$symb}->{'width_parts'}= &count_parts($navmap,$seq);
  731:             $width{$symb}->{'width_problem'} += $width{$symb}->{'width_parts'};
  732:         } else {
  733:             $width{$symb}->{'width_problem'} = 0;
  734:         }
  735:         $width{$symb}->{'width_total'} = $width{$symb}->{'width_problem'} + 
  736:                                      $width{$symb}->{'width_sum'};
  737:         if ($width{$symb}->{'width_total'} < length(&HTML::Entities::decode($title))) {
  738:             $width{$symb}->{'width_total'} = length(&HTML::Entities::decode($title));
  739:         }
  740:         #
  741:         # Output the sequence titles
  742:         $Str .= $title.(' 'x($width{$symb}->{'width_total'}-
  743:                             length($title)
  744:                             )).$padding;
  745:     }
  746:     $total_sum_width = length($total_count)+1;
  747:     $Str .= "    total</pre>\n";
  748:     $Str .= "<pre>";
  749:     $r->print($Str);
  750:     $r->rflush();
  751: 
  752:     $r->print(<<JS);
  753: <script type="text/javascript">
  754: // get the left offset of a given widget as an absolute position
  755: function getLeftOffset (element) {
  756:     return collect(element, "offsetLeft");
  757: }
  758: 
  759: // get the top offset of a given widget as an absolute position
  760: function getTopOffset (element) {
  761:     return collect(element, "offsetTop");
  762: }
  763: 
  764: function collect(element, att) {
  765:     var val = 0;
  766:     while(element) {
  767:         val += element[att];
  768:         element = element.offsetParent;
  769:     }
  770:     return val;
  771: }
  772: 
  773: var currentDiv;
  774: var currentElement;
  775: function popup_score(element, score) {
  776:     popdown_score();
  777:     var left = getLeftOffset(element);
  778:     var top = getTopOffset(element);
  779:     var div = document.createElement("div");
  780:     div.className = "LC_chrt_popup";
  781:     div.appendChild(document.createTextNode(score));
  782:     div.style.position = "absolute";
  783:     div.style.top = (top - 25) + "px";
  784:     div.style.left = (left - 10) + "px";
  785:     currentDiv = div;
  786:     document.body.insertBefore(div, document.body.childNodes[0]);
  787:     element.className = "LC_chrt_popup_up";
  788:     currentElement = element;
  789: }
  790: 
  791: function popdown_score() {
  792:     if (currentDiv) {
  793:         document.body.removeChild(currentDiv);
  794:     }
  795:     if (currentElement) {
  796:         currentElement.className = 'LC_chrt_popup_exists';
  797:     }
  798:     currentDiv = undefined;
  799: }
  800: </script>
  801: JS
  802: 
  803:     #
  804:     # Let the user know what we are doing
  805:     my $studentcount = scalar(@Apache::lonstatistics::Students); 
  806:     if ($env{'form.SelectedStudent'}) {
  807:         $studentcount = '1';
  808:     }
  809:     #
  810:     # Initialize progress window
  811:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
  812:         ($r,'HTML Chart Status',
  813:          'HTML Chart Progress', $studentcount,
  814:          'inline',undef,'Statistics','stats_status');
  815:     #
  816:     &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
  817:                                           'Processing first student');
  818:     return;
  819: }
  820: 
  821: sub html_outputstudent {
  822:     my ($r,$student) = @_;
  823:     my $Str = '';
  824:     return if (! defined($navmap));
  825:     #
  826:     if($count++ % 5 == 0 && $count > 0) {
  827:         $r->print("</pre><pre>");
  828:     }
  829:     # First, the @StudentData fields need to be listed
  830:     my @to_show = &get_student_fields_to_show();
  831:     foreach my $field (@to_show) {
  832:         my $title=$student->{$field};
  833:         # Deal with 'comments' - how I love special cases
  834:         if ($field eq 'comments') {
  835:             $title = '<a href="/adm/'.$student->{'domain'}.'/'.$student->{'username'}.'/'.'aboutme#coursecomment">'.&mt('Comments').'</a>';
  836:         }
  837:         my $base = length($title);
  838:         my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
  839:         $Str .= $title.' 'x($width-$base).$padding;
  840:     }
  841:     # Get ALL the students data
  842:     my %StudentsData;
  843:     my @tmp = &Apache::loncoursedata::get_current_state
  844:         ($student->{'username'},$student->{'domain'},undef,
  845:          $env{'request.course.id'});
  846:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
  847:         %StudentsData = @tmp;
  848:     }
  849:     if (scalar(@tmp) < 1) {
  850:         $nodata_count++;
  851:         $Str .= '<font color="blue">No Course Data</font>'."\n";
  852:         $r->print($Str);
  853:         $r->rflush();
  854:         return;
  855:     }
  856:     #
  857:     # By sequence build up the data
  858:     my $studentstats;
  859:     my $PerformanceStr = '';
  860:     foreach my $seq (@sequences) {
  861:         my $symb = $seq->symb;
  862:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
  863:         if ($chosen_output->{'tries'}) {
  864:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
  865:                 &student_tries_on_sequence($student,\%StudentsData,
  866:                                            $navmap,$seq,$show_links);
  867:         } else {
  868:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
  869:                 &student_performance_on_sequence($student,\%StudentsData,
  870:                                                  $navmap,$seq,$show_links,
  871:                                                  $chosen_output->{ignore_weight});
  872:         }
  873:         my $ratio='';
  874:         if ($chosen_output->{'every_problem'} && 
  875:             $chosen_output->{'sequence_sum'}) {
  876:             $ratio .= ' ';
  877:         }
  878:         if ($chosen_output->{'sequence_sum'} && $score ne ' ') {
  879:             my $score .= sprintf("%3.0f",$score);
  880:             $ratio .= (' 'x(3-length($score))).$score;
  881:         } elsif($chosen_output->{'sequence_sum'}) {
  882:             $ratio .= ' 'x3;
  883:         }
  884:         if ($chosen_output->{'sequence_max'}) {
  885:             if ($chosen_output->{'sequence_sum'}) {
  886:                 $ratio .= '/';
  887:             }
  888:             $ratio .= sprintf("%3.0f",$seq_max);
  889:         }
  890:         #
  891:         if (! $chosen_output->{'every_problem'}) {
  892:             $performance = '';
  893: 	    $performance_length=0;
  894:         }
  895:         $performance .= ' 'x($width{$symb}->{'width_total'} -
  896:                              $performance_length -
  897:                              $width{$symb}->{'width_sum'}).
  898:             $ratio;
  899:         #
  900:         $Str .= $performance.$padding;
  901:         #
  902:         $studentstats->{$symb}->{'score'}= $score;
  903:         $studentstats->{$symb}->{'max'}  = $seq_max;
  904:     }
  905:     #
  906:     # Total it up and store the statistics info.
  907:     my ($score,$max);
  908:     while (my ($symb,$seq_stats) = each (%{$studentstats})) {
  909:         $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
  910:         if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) {
  911:             $Statistics->{$symb}->{'max'} = $seq_stats->{'max'};
  912:         }
  913:         if ($seq_stats->{'score'} ne ' ') {
  914:             $score += $seq_stats->{'score'};
  915:             $Statistics->{$symb}->{'num_students'}++;
  916:         }
  917:         $max   += $seq_stats->{'max'};
  918:     }
  919:     if (! defined($score)) {
  920:         $score = ' ' x $total_sum_width;
  921:     } else {
  922:         $score = sprintf("%.0f",$score);
  923:         $score = (' 'x(3-length($score))).$score;
  924:     }
  925:     $Str .= ' '.' 'x($total_sum_width-length($score)).$score.' / '.$max;
  926:     $Str .= " \n";
  927:     #
  928:     $r->print($Str);
  929:     #
  930:     $r->rflush();
  931:     &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
  932:     return;
  933: }    
  934: 
  935: sub html_finish {
  936:     my ($r) = @_;
  937:     return if (! defined($navmap));
  938:     #
  939:     # Check for suppressed output and close the progress window if so
  940:     $r->print("</pre>\n"); 
  941:     if ($chosen_output->{'summary_table'}) {
  942:         if ($single_student_mode) {
  943:             $r->print(&SingleStudentTotal());
  944:         } else {
  945:             $r->print(&StudentAverageTotal());
  946:         }
  947:     }
  948:     $r->rflush();
  949:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  950:     &html_cleanup();
  951:     return;
  952: }
  953: 
  954: sub StudentAverageTotal {
  955:     my $Str = '<h3>'.&mt('Summary Tables').'</h3>'.$/;
  956:     $Str .= '<table border=2 cellspacing="1">'."\n";
  957:     $Str .= '<tr>'.
  958:         '<th>'.&mt('Title').'</th>'.
  959:         '<th>'.&mt('Average').'</th>'.
  960:         '<th>'.&mt('Maximum').'</th>'.
  961:         '</tr>'.$/;
  962:     foreach my $seq (@sequences) {
  963:         my $symb = $seq->symb;
  964:         my $ave;
  965:         my $num_students = $Statistics->{$symb}->{'num_students'};
  966:         if ($num_students > 0) {
  967:             $ave = int(100*
  968:                        ($Statistics->{$symb}->{'score'}/$num_students)
  969:                        )/100;
  970:         } else {
  971:             $ave = 0;
  972:         }
  973:         my $max = $Statistics->{$symb}->{'max'};
  974:         $ave = sprintf("%.2f",$ave);
  975:         $Str .= '<tr><td>'.$seq->compTitle.'</td>'.
  976:             '<td align="right">'.$ave.'&nbsp;</td>'.
  977:             '<td align="right">'.$max.'&nbsp;'.'</td></tr>'."\n";
  978:     }
  979:     $Str .= "</table>\n";
  980:     return $Str;
  981: }
  982: 
  983: sub SingleStudentTotal {
  984:     return if (! defined($navmap));
  985:     my $student = &Apache::lonstatistics::current_student();
  986:     my $Str = '<h3>'.&mt('Summary table for [_1] ([_2]@[_3])',
  987:                          $student->{'fullname'},
  988:                          $student->{'username'},$student->{'domain'}).'</h3>';
  989:     $Str .= $/;
  990:     $Str .= '<table border=2 cellspacing="1">'."\n";
  991:     $Str .= 
  992:         '<tr>'.
  993:         '<th>'.&mt('Sequence or Folder').'</th>';
  994:     if ($chosen_output->{'base'} eq 'tries') {
  995:         $Str .= '<th>'.&mt('Parts Correct').'</th>';
  996:     } else {
  997:         $Str .= '<th>'.&mt('Score').'</th>';
  998:     }
  999:     $Str .= '<th>'.&mt('Maximum').'</th>'."</tr>\n";
 1000:     my $total = 0;
 1001:     my $total_max = 0;
 1002:     foreach my $seq (@sequences) {
 1003:         my $value = $Statistics->{$seq->symb}->{'score'};
 1004:         my $max = $Statistics->{$seq->symb}->{'max'};
 1005:         $Str .= '<tr><td>'.&HTML::Entities::encode($seq->compTitle).'</td>'.
 1006:             '<td align="right">'.$value.'</td>'.
 1007:                 '<td align="right">'.$max.'</td></tr>'."\n";
 1008:         $total += $value;
 1009:         $total_max +=$max;
 1010:     }
 1011:     $Str .= '<tr><td><b>'.&mt('Total').'</b></td>'.
 1012:         '<td align="right">'.$total.'</td>'.
 1013:         '<td align="right">'.$total_max."</td></tr>\n";
 1014:     $Str .= "</table>\n";
 1015:     return $Str;
 1016: }
 1017: 
 1018: }
 1019: 
 1020: #######################################################
 1021: #######################################################
 1022: 
 1023: =pod
 1024: 
 1025: =head2 EXCEL subroutines
 1026: 
 1027: =item &excel_initialize($r)
 1028: 
 1029: =item &excel_outputstudent($r,$student)
 1030: 
 1031: =item &excel_finish($r)
 1032: 
 1033: =cut
 1034: 
 1035: #######################################################
 1036: #######################################################
 1037: {
 1038: 
 1039: my $excel_sheet;
 1040: my $excel_workbook;
 1041: my $format;
 1042: 
 1043: my $filename;
 1044: my $rows_output;
 1045: my $cols_output;
 1046: 
 1047: my %prog_state; # progress window state
 1048: my $request_aborted;
 1049: 
 1050: my $total_formula;
 1051: my $maximum_formula;
 1052: my %formula_data;
 1053: 
 1054: my $navmap;
 1055: my @sequences;
 1056: 
 1057: sub excel_cleanup {
 1058:     #
 1059:     undef ($excel_sheet);
 1060:     undef ($excel_workbook);
 1061:     undef ($filename);
 1062:     undef ($rows_output);
 1063:     undef ($cols_output);
 1064:     undef (%prog_state);
 1065:     undef ($request_aborted);
 1066:     undef ($total_formula);
 1067:     undef ($maximum_formula);
 1068:     #
 1069:     undef(%formula_data);
 1070:     #
 1071:     undef($navmap);
 1072:     undef(@sequences);
 1073: }
 1074: 
 1075: sub excel_initialize {
 1076:     my ($r) = @_;
 1077: 
 1078:     &excel_cleanup();
 1079:     ($navmap,@sequences) = 
 1080:         &Apache::lonstatistics::selected_sequences_with_assessments();
 1081:     if (! ref($navmap)) {
 1082:         # Unable to get data, so bail out
 1083:         $r->print("<h3>".
 1084:                   &mt('Unable to retrieve course information.').
 1085:                   '</h3>');
 1086:     }
 1087:     #
 1088:     my $total_columns = scalar(&get_student_fields_to_show());
 1089:     my $num_students = scalar(@Apache::lonstatistics::Students);
 1090:     #
 1091:     foreach my $seq (@sequences) {
 1092:         if ($chosen_output->{'every_problem'}) {
 1093:             $total_columns+=&count_parts($navmap,$seq);
 1094:         }
 1095:         # Add 2 because we need a 'sequence_sum' and 'total' column for each
 1096:         $total_columns += 2;
 1097:     }
 1098:     my $too_many_cols_error_message = 
 1099:         '<h2>'.&mt('Unable to Complete Request').'</h2>'.$/.
 1100:         '<p>'.&mt('LON-CAPA is unable to produce your Excel spreadsheet because your selections will result in more than 255 columns.  Excel allows only 255 columns in a spreadsheet.').'</p>'.$/.
 1101:         '<p>'.&mt('You may consider reducing the number of <b>Sequences or Folders</b> you have selected.').'</p>'.$/.
 1102:         '<p>'.&mt('LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the <b>Scores Summary</b> data.').'</p>'.$/;
 1103:     if ($chosen_output->{'base'} eq 'tries' && $total_columns > 255) {
 1104:         $r->print($too_many_cols_error_message);
 1105:         $request_aborted = 1;
 1106:     }
 1107:     if ($chosen_output->{'base'} eq 'scores' && $total_columns > 255) {
 1108:         $r->print($too_many_cols_error_message);
 1109:         $request_aborted = 1;
 1110:     }
 1111:     return if ($request_aborted);
 1112:     #
 1113:     #
 1114:     $excel_workbook = undef;
 1115:     $excel_sheet = undef;
 1116:     #
 1117:     $rows_output = 0;
 1118:     $cols_output = 0;
 1119:     #
 1120:     # Determine rows 
 1121:     my $header_row = $rows_output++;
 1122:     my $description_row = $rows_output++;
 1123:     my $notes_row = $rows_output++;
 1124:     $rows_output++;        # blank row
 1125:     my $summary_header_row;
 1126:     if ($chosen_output->{'summary_table'}) {
 1127:         $summary_header_row = $rows_output++;
 1128:         $rows_output+= scalar(@sequences);
 1129:         $rows_output++;
 1130:     }
 1131:     my $sequence_name_row = $rows_output++;
 1132:     my $resource_name_row = $rows_output++;
 1133:     my $maximum_data_row = $rows_output++;
 1134:     if (! $chosen_output->{'maximum_row'}) {
 1135:         $rows_output--;
 1136:     }
 1137:     my $first_data_row = $rows_output++;
 1138:     #
 1139:     # Create sheet
 1140:     ($excel_workbook,$filename,$format)=
 1141:         &Apache::loncommon::create_workbook($r);
 1142:     return if (! defined($excel_workbook));
 1143:     #
 1144:     # Add a worksheet
 1145:     my $sheetname = $env{'course.'.$env{'request.course.id'}.'.description'};
 1146:     $sheetname = &Apache::loncommon::clean_excel_name($sheetname);
 1147:     $excel_sheet = $excel_workbook->addworksheet($sheetname);
 1148:     #
 1149:     # Put the course description in the header
 1150:     $excel_sheet->write($header_row,$cols_output++,
 1151:                    $env{'course.'.$env{'request.course.id'}.'.description'},
 1152:                         $format->{'h1'});
 1153:     $cols_output += 3;
 1154:     #
 1155:     # Put a description of the sections listed
 1156:     my $sectionstring = '';
 1157:     my @Sections = &Apache::lonstatistics::get_selected_sections();
 1158:     $excel_sheet->write($header_row,$cols_output++,
 1159:                         &Apache::lonstatistics::section_and_enrollment_description('plaintext'),
 1160:                         $format->{'h3'});
 1161:     #
 1162:     # Put the date in there too
 1163:     $excel_sheet->write($header_row,$cols_output++,
 1164:                         'Compiled on '.localtime(time),$format->{'h3'});
 1165:     #
 1166:     $cols_output = 0;
 1167:     $excel_sheet->write($description_row,$cols_output++,
 1168:                         $chosen_output->{'shortdesc'},
 1169:                         $format->{'b'});
 1170:     #
 1171:     $cols_output = 0;
 1172:     $excel_sheet->write($notes_row,$cols_output++,
 1173:                         $chosen_output->{'non_html_notes'},
 1174:                         $format->{'i'});
 1175:     
 1176:     ##############################################
 1177:     # Output headings for the raw data
 1178:     ##############################################
 1179:     #
 1180:     # Add the student headers
 1181:     $cols_output = 0;
 1182:     foreach my $field (&get_student_fields_to_show()) {
 1183:         $excel_sheet->write($resource_name_row,$cols_output++,$field,
 1184:                             $format->{'bold'});
 1185:     }
 1186:     #
 1187:     # Add the remaining column headers
 1188:     my $total_formula_string = '=0';
 1189:     my $maximum_formula_string = '=0';
 1190:     foreach my $seq (@sequences) {
 1191:         my $symb = $seq->symb;
 1192:         $excel_sheet->write($sequence_name_row,,
 1193:                             $cols_output,$seq->compTitle,$format->{'bold'});
 1194:         # Determine starting cell
 1195:         $formula_data{$symb}->{'Excel:startcell'}=
 1196:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1197:             ($first_data_row,$cols_output);
 1198:         $formula_data{$symb}->{'Excel:startcol'}=$cols_output;
 1199:         my $count = 0;
 1200:         if ($chosen_output->{'every_problem'}) {
 1201:             # Put the names of the problems and parts into the sheet
 1202:             foreach my $res (&get_resources($navmap,$seq)) {
 1203:                 if (scalar(@{$res->parts}) > 1) {
 1204:                     foreach my $part (@{$res->parts}) {
 1205:                         $excel_sheet->write($resource_name_row,
 1206:                                             $cols_output++,
 1207:                                             $res->compTitle.' part '.$res->part_display($part),
 1208:                                             $format->{'bold'});
 1209:                         $count++;
 1210:                     }
 1211:                 } else {
 1212:                     $excel_sheet->write($resource_name_row,
 1213:                                         $cols_output++,
 1214:                                         $res->compTitle,$format->{'bold'});
 1215:                     $count++;
 1216:                 }
 1217:             }
 1218:         }
 1219:         # Determine ending cell
 1220:         if ($count <= 1) {
 1221:             $formula_data{$symb}->{'Excel:endcell'} = $formula_data{$symb}->{'Excel:startcell'};
 1222:             $formula_data{$symb}->{'Excel:endcol'}  = $formula_data{$symb}->{'Excel:startcol'};
 1223:         } else {
 1224:             $formula_data{$symb}->{'Excel:endcell'} = 
 1225:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1226:                 ($first_data_row,$cols_output-1);
 1227:             $formula_data{$symb}->{'Excel:endcol'} = $cols_output-1;
 1228:         }
 1229:         # Create the formula for summing up this sequence
 1230:         if (! exists($formula_data{$symb}->{'Excel:endcell'}) ||
 1231:             ! defined($formula_data{$symb}->{'Excel:endcell'})) {
 1232:             $formula_data{$symb}->{'Excel:endcell'} = $formula_data{$symb}->{'Excel:startcell'};
 1233:         }
 1234: 
 1235:         my $start = $formula_data{$symb}->{'Excel:startcell'};
 1236:         my $end = $formula_data{$symb}->{'Excel:endcell'};
 1237:         $formula_data{$symb}->{'Excel:sum'}= $excel_sheet->store_formula
 1238:             ("=IF(COUNT($start\:$end),SUM($start\:$end),\"\")");
 1239:         # Determine cell the score is held in
 1240:         $formula_data{$symb}->{'Excel:scorecell'} = 
 1241:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1242:             ($first_data_row,$cols_output);
 1243:         $formula_data{$symb}->{'Excel:scorecol'}=$cols_output;
 1244:         if ($chosen_output->{'base'} eq 'parts correct total') {
 1245:             $excel_sheet->write($resource_name_row,$cols_output++,
 1246:                                 'parts correct',
 1247:                                 $format->{'bold'});
 1248:         } elsif ($chosen_output->{'sequence_sum'}) {
 1249:             if ($chosen_output->{'correct'}) {
 1250:                 # Only reporting the number correct, so do not call it score
 1251:                 $excel_sheet->write($resource_name_row,$cols_output++,
 1252:                                     'sum',
 1253:                                     $format->{'bold'});
 1254:             } else {
 1255:                 $excel_sheet->write($resource_name_row,$cols_output++,
 1256:                                     'score',
 1257:                                     $format->{'bold'});
 1258:             }
 1259:         }
 1260:         #
 1261:         $total_formula_string.='+'.
 1262:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1263:             ($first_data_row,$cols_output-1);
 1264:         if ($chosen_output->{'sequence_max'}) {
 1265:             $excel_sheet->write($resource_name_row,$cols_output,
 1266:                                 'maximum',
 1267:                                 $format->{'bold'});
 1268:             $formula_data{$symb}->{'Excel:maxcell'} = 
 1269:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1270:                 ($first_data_row,$cols_output);
 1271:             $formula_data{$symb}->{'Excel:maxcol'}=$cols_output;
 1272:             $maximum_formula_string.='+'.
 1273:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1274:                 ($first_data_row,$cols_output);
 1275:             $cols_output++;
 1276: 
 1277:         }
 1278:     }
 1279:     if ($chosen_output->{'grand_total'}) {
 1280:         $excel_sheet->write($resource_name_row,$cols_output++,'Total',
 1281:                             $format->{'bold'});
 1282:     }
 1283:     if ($chosen_output->{'grand_maximum'}) {
 1284:         $excel_sheet->write($resource_name_row,$cols_output++,'Max. Total',
 1285:                             $format->{'bold'});
 1286:     }
 1287:     $total_formula = $excel_sheet->store_formula($total_formula_string);
 1288:     $maximum_formula = $excel_sheet->store_formula($maximum_formula_string);
 1289:     ##############################################
 1290:     # Output a row for MAX, if appropriate
 1291:     ##############################################
 1292:     if ($chosen_output->{'maximum_row'}) {
 1293:         $cols_output = 0;
 1294:         foreach my $field (&get_student_fields_to_show()) {
 1295:             if ($field eq 'username' || $field eq 'fullname' || 
 1296:                 $field eq 'id') {
 1297:                 $excel_sheet->write($maximum_data_row,$cols_output++,'Maximum',
 1298:                                     $format->{'bold'});
 1299:             } else {
 1300:                 $excel_sheet->write($maximum_data_row,$cols_output++,'');
 1301:             }
 1302:         }
 1303:         #
 1304:         # Add the maximums for each sequence or assessment
 1305:         my %total_cell_translation;
 1306:         my %maximum_cell_translation;
 1307:         foreach my $seq (@sequences) {
 1308:             my $symb = $seq->symb;
 1309:             $cols_output=$formula_data{$symb}->{'Excel:startcol'};
 1310:             $total_cell_translation{$formula_data{$symb}->{'Excel:scorecell'}}=
 1311:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1312:                 ($maximum_data_row,$formula_data{$symb}->{'Excel:scorecol'});
 1313:             $maximum_cell_translation{$formula_data{$symb}->{'Excel:maxcell'}}=
 1314:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1315:                 ($maximum_data_row,$formula_data{$symb}->{'Excel:maxcol'});
 1316:             my $weight;
 1317:             my $max = 0;
 1318:             foreach my $resource (&get_resources($navmap,$seq)) {
 1319:                 foreach my $part (@{$resource->parts}){
 1320:                     $weight = 1;
 1321:                     if ($chosen_output->{'scores'}) {
 1322:                         $weight = &Apache::lonnet::EXT
 1323:                             ('resource.'.$part.'.weight',$resource->symb,
 1324:                              undef,undef,undef);
 1325:                         if (!defined($weight) || ($weight eq '')) { 
 1326:                             $weight=1;
 1327:                         }
 1328:                     }
 1329:                     if ($chosen_output->{'scores'} &&
 1330:                         $chosen_output->{'every_problem'}) {
 1331:                         $excel_sheet->write($maximum_data_row,$cols_output++,
 1332:                                             $weight);
 1333:                     }
 1334:                     $max += $weight;
 1335:                 }
 1336:             } 
 1337:             #
 1338:             if ($chosen_output->{'sequence_sum'} && 
 1339:                 $chosen_output->{'every_problem'}) {
 1340: 		my %replaceCells=
 1341: 		    ('^'.$formula_data{$symb}->{'Excel:startcell'}.':'.
 1342: 		         $formula_data{$symb}->{'Excel:endcell'}.'$' =>
 1343: 		     &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($maximum_data_row,$formula_data{$symb}->{'Excel:startcol'}).':'.
 1344: 		     &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($maximum_data_row,$formula_data{$symb}->{'Excel:endcol'}));
 1345:                 $excel_sheet->repeat_formula($maximum_data_row,$cols_output++,
 1346:                                              $formula_data{$symb}->{'Excel:sum'},undef,
 1347: 					     %replaceCells, %replaceCells);
 1348: 			
 1349:             } elsif ($chosen_output->{'sequence_sum'}) {
 1350:                 $excel_sheet->write($maximum_data_row,$cols_output++,$max);
 1351:             }
 1352:             if ($chosen_output->{'sequence_max'}) {
 1353:                 $excel_sheet->write($maximum_data_row,$cols_output++,$max);
 1354:             }
 1355:             #
 1356:         }
 1357:         if ($chosen_output->{'grand_total'}) {
 1358:             $excel_sheet->repeat_formula($maximum_data_row,$cols_output++,
 1359:                                          $total_formula,undef,
 1360:                                          %total_cell_translation);
 1361:         }
 1362:         if ($chosen_output->{'grand_maximum'}) {
 1363:             $excel_sheet->repeat_formula($maximum_data_row,$cols_output++,
 1364:                                          $maximum_formula,undef,
 1365:                                          %maximum_cell_translation);
 1366:         }
 1367:     } # End of MAXIMUM row output  if ($chosen_output->{'maximum_row'}) {
 1368:     $rows_output = $first_data_row;
 1369:     ##############################################
 1370:     # Output summary table, which actually is above the sequence name row.
 1371:     ##############################################
 1372:     if ($chosen_output->{'summary_table'}) {
 1373:         $cols_output = 0;
 1374:         $excel_sheet->write($summary_header_row,$cols_output++,
 1375:                             'Summary Table',$format->{'bold'});
 1376:         if ($chosen_output->{'maximum_row'}) {
 1377:             $excel_sheet->write($summary_header_row,$cols_output++,
 1378:                                 'Maximum',$format->{'bold'});
 1379:         }
 1380:         $excel_sheet->write($summary_header_row,$cols_output++,
 1381:                             'Average',$format->{'bold'});
 1382:         $excel_sheet->write($summary_header_row,$cols_output++,
 1383:                             'Median',$format->{'bold'});
 1384:         $excel_sheet->write($summary_header_row,$cols_output++,
 1385:                             'Std Dev',$format->{'bold'});
 1386:         my $row = $summary_header_row+1;
 1387:         foreach my $seq (@sequences) {
 1388:             my $symb = $seq->symb;
 1389:             $cols_output = 0;
 1390:             $excel_sheet->write($row,$cols_output++,
 1391:                                 $seq->compTitle,
 1392:                                 $format->{'bold'});
 1393:             if ($chosen_output->{'maximum_row'}) {
 1394:                 $excel_sheet->write
 1395:                     ($row,$cols_output++,
 1396:                      '='.
 1397:                      &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1398:                      ($maximum_data_row,$formula_data{$symb}->{'Excel:scorecol'})
 1399:                      );
 1400:             }
 1401:             my $range = 
 1402:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1403:                 ($first_data_row,$formula_data{$symb}->{'Excel:scorecol'}).
 1404:                 ':'.
 1405:                 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1406:                 ($first_data_row+$num_students-1,$formula_data{$symb}->{'Excel:scorecol'});
 1407:             $excel_sheet->write($row,$cols_output++,
 1408:                                 '=AVERAGE('.$range.')');
 1409:             $excel_sheet->write($row,$cols_output++,
 1410:                                 '=MEDIAN('.$range.')');
 1411:             $excel_sheet->write($row,$cols_output++,
 1412:                                 '=STDEV('.$range.')');
 1413:             $row++;
 1414:         }
 1415:     }
 1416:     ##############################################
 1417:     #   Take care of non-excel initialization
 1418:     ##############################################
 1419:     #
 1420:     # Let the user know what we are doing
 1421:     my $studentcount = scalar(@Apache::lonstatistics::Students); 
 1422:     if ($env{'form.SelectedStudent'}) {
 1423:         $studentcount = '1';
 1424:     }
 1425:     if ($studentcount > 1) {
 1426:         $r->print('<h1>'.&mt('Compiling Excel spreadsheet for [_1] students',
 1427:                              $studentcount)."</h1>\n");
 1428:     } else {
 1429:         $r->print('<h1>'.
 1430:                   &mt('Compiling Excel spreadsheet for 1 student').
 1431:                   "</h1>\n");
 1432:     }
 1433:     $r->rflush();
 1434:     #
 1435:     # Initialize progress window
 1436:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
 1437:         ($r,'Excel File Compilation Status',
 1438:          'Excel File Compilation Progress', $studentcount,
 1439:          'inline',undef,'Statistics','stats_status');
 1440:     #
 1441:     &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
 1442:                                           'Processing first student');
 1443:     return;
 1444: }
 1445: 
 1446: sub excel_outputstudent {
 1447:     my ($r,$student) = @_;
 1448:     if ($request_aborted || ! defined($navmap) || ! defined($excel_sheet)) {
 1449:         return;
 1450:     }
 1451:     $cols_output=0;
 1452:     #
 1453:     # Write out student data
 1454:     my @to_show = &get_student_fields_to_show();
 1455:     foreach my $field (@to_show) {
 1456:         my $value = $student->{$field};
 1457:         if ($field eq 'comments') {
 1458:             $value = &Apache::lonmsgdisplay::retrieve_instructor_comments
 1459:                 ($student->{'username'},$student->{'domain'});
 1460:         }
 1461:         $excel_sheet->write($rows_output,$cols_output++,$value);
 1462:     }
 1463:     #
 1464:     # Get student assessment data
 1465:     my %StudentsData;
 1466:     my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
 1467:                                                         $student->{'domain'},
 1468:                                                         undef,
 1469:                                                    $env{'request.course.id'});
 1470:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
 1471:         %StudentsData = @tmp;
 1472:     }
 1473:     #
 1474:     # Write out sequence scores and totals data
 1475:     my %total_cell_translation;
 1476:     my %maximum_cell_translation;
 1477:     foreach my $seq (@sequences) {
 1478:         my $symb = $seq->symb;
 1479:         $cols_output = $formula_data{$symb}->{'Excel:startcol'};
 1480:         # Keep track of cells to translate in total cell
 1481:         $total_cell_translation{$formula_data{$symb}->{'Excel:scorecell'}} = 
 1482:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1483:                         ($rows_output,$formula_data{$symb}->{'Excel:scorecol'});
 1484:         # and maximum cell
 1485:         $maximum_cell_translation{$formula_data{$symb}->{'Excel:maxcell'}} = 
 1486:             &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
 1487:             ($rows_output,$formula_data{$symb}->{'Excel:maxcol'});
 1488:         #
 1489:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
 1490:         if ($chosen_output->{'tries'} || $chosen_output->{'correct'}){
 1491:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1492:                 &student_tries_on_sequence($student,\%StudentsData,
 1493:                                            $navmap,$seq,'no');
 1494:         } else {
 1495:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1496:                 &student_performance_on_sequence($student,\%StudentsData,
 1497:                                                  $navmap,$seq,'no',
 1498:                                                  $chosen_output->{ignore_weight});
 1499:         } 
 1500:         if ($chosen_output->{'every_problem'}) {
 1501:             if ($chosen_output->{'correct'}) {
 1502:                 # only indiciate if each item is correct or not
 1503:                 foreach my $value (@$rawdata) {
 1504:                     # positive means correct, 0 or negative means
 1505:                     # incorrect
 1506:                     $value = $value > 0 ? 1 : 0;
 1507:                     $excel_sheet->write($rows_output,$cols_output++,$value);
 1508:                 }
 1509:             } else {
 1510:                 foreach my $value (@$rawdata) {
 1511:                     if ($score eq ' ' || !defined($value)) {
 1512:                         $cols_output++;
 1513:                     } else {                        
 1514:                         $excel_sheet->write($rows_output,$cols_output++,
 1515:                                             $value);
 1516:                     }
 1517:                 }
 1518:             }
 1519:         }
 1520:         if ($chosen_output->{'sequence_sum'} && 
 1521:             $chosen_output->{'every_problem'}) {
 1522:             # Write a formula for the sum of this sequence
 1523:             my %replaceCells=
 1524: 		('^'.$formula_data{$symb}->{'Excel:startcell'}.':'.$formula_data{$symb}->{'Excel:endcell'}.'$'
 1525: 		 => 
 1526: 		 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$formula_data{$symb}->{'Excel:startcol'}).':'.
 1527: 		 &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell($rows_output,$formula_data{$symb}->{'Excel:endcol'})
 1528: 		 );
 1529:             # The undef is for the format	    
 1530: 	    $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1531: 					 $formula_data{$symb}->{'Excel:sum'},undef,
 1532: 					 %replaceCells, %replaceCells);
 1533:         } elsif ($chosen_output->{'sequence_sum'}) {
 1534:             if ($score eq ' ') {
 1535:                 $cols_output++;
 1536:             } else {
 1537:                 $excel_sheet->write($rows_output,$cols_output++,$score);
 1538:             }
 1539:         }
 1540:         if ($chosen_output->{'sequence_max'}) {
 1541:             $excel_sheet->write($rows_output,$cols_output++,$seq_max);
 1542:         }
 1543:     }
 1544:     #
 1545:     if ($chosen_output->{'grand_total'}) {
 1546:         $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1547:                                      $total_formula,undef,
 1548:                                      %total_cell_translation);
 1549:     }
 1550:     if ($chosen_output->{'grand_maximum'}) {
 1551:         $excel_sheet->repeat_formula($rows_output,$cols_output++,
 1552:                                      $maximum_formula,undef,
 1553:                                      %maximum_cell_translation);
 1554:     }
 1555:     #
 1556:     # Bookkeeping
 1557:     $rows_output++; 
 1558:     $cols_output=0;
 1559:     #
 1560:     # Update the progress window
 1561:     &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
 1562:     return;
 1563: }
 1564: 
 1565: sub excel_finish {
 1566:     my ($r) = @_;
 1567:     if ($request_aborted || ! defined($navmap) || ! defined($excel_sheet)) {
 1568: 	&excel_cleanup();
 1569:         return;
 1570:     }
 1571:     #
 1572:     # Write the excel file
 1573:     $excel_workbook->close();
 1574:     #
 1575:     # Close the progress window
 1576:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
 1577:     #
 1578:     # Tell the user where to get their excel file
 1579:     $r->print('<br />'.
 1580:               '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
 1581:     $r->rflush();
 1582:     &excel_cleanup();
 1583:     return;
 1584: }
 1585: 
 1586: }
 1587: #######################################################
 1588: #######################################################
 1589: 
 1590: =pod
 1591: 
 1592: =head2 CSV output routines
 1593: 
 1594: =item &csv_initialize($r)
 1595: 
 1596: =item &csv_outputstudent($r,$student)
 1597: 
 1598: =item &csv_finish($r)
 1599: 
 1600: =cut
 1601: 
 1602: #######################################################
 1603: #######################################################
 1604: {
 1605: 
 1606: my $outputfile;
 1607: my $filename;
 1608: my $request_aborted;
 1609: my %prog_state; # progress window state
 1610: my $navmap;
 1611: my @sequences;
 1612: 
 1613: sub csv_cleanup {
 1614:     undef($outputfile);
 1615:     undef($filename);
 1616:     undef($request_aborted);
 1617:     undef(%prog_state);
 1618:     #
 1619:     undef($navmap);
 1620:     undef(@sequences);
 1621: }
 1622: 
 1623: sub csv_initialize{
 1624:     my ($r) = @_;
 1625: 
 1626:     &csv_cleanup();
 1627:     ($navmap,@sequences) = 
 1628:         &Apache::lonstatistics::selected_sequences_with_assessments();
 1629:     if (! ref($navmap)) {
 1630:         # Unable to get data, so bail out
 1631:         $r->print("<h3>".
 1632:                   &mt('Unable to retrieve course information.').
 1633:                   '</h3>');
 1634:     }
 1635:     #
 1636:     # Deal with unimplemented requests
 1637:     $request_aborted = undef;
 1638:     if ($chosen_output->{'base'} =~ /final table/) {
 1639:         $r->print(<<END);
 1640: <h2>Unable to Complete Request</h2>
 1641: <p>
 1642: The <b>Summary Table (Scores)</b> option is not available for non-HTML output.
 1643: </p>
 1644: END
 1645:        $request_aborted = 1;
 1646:     }
 1647:     return if ($request_aborted);
 1648:     #
 1649:     # Initialize progress window
 1650:     my $studentcount = scalar(@Apache::lonstatistics::Students);
 1651:     %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
 1652:         ($r,'CSV File Compilation Status',
 1653:          'CSV File Compilation Progress', $studentcount,
 1654:          'inline',undef,'Statistics','stats_status');
 1655:     #
 1656:     # Open a file
 1657:     ($outputfile,$filename) = &Apache::loncommon::create_text_file($r,'csv');
 1658:     if (! defined($outputfile)) { return ''; }
 1659:     #
 1660:     # Datestamp
 1661:     my $description = $env{'course.'.$env{'request.course.id'}.'.description'};
 1662:     print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'.
 1663:         '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'.
 1664:             "\n";
 1665:     print $outputfile '"'.
 1666:         &Apache::loncommon::csv_translate
 1667:         (&Apache::lonstatistics::section_and_enrollment_description()).
 1668:         '"'."\n";
 1669:     foreach my $item ('shortdesc','non_html_notes') {
 1670:         next if (! exists($chosen_output->{$item}));
 1671:         print $outputfile 
 1672:             '"'.&Apache::loncommon::csv_translate($chosen_output->{$item}).'"'.
 1673:             "\n";
 1674:     }
 1675:     #
 1676:     # Print out the headings
 1677:     my $sequence_row = '';
 1678:     my $resource_row = undef;
 1679:     foreach my $field (&get_student_fields_to_show()) {
 1680:         $sequence_row .='"",';
 1681:         $resource_row .= '"'.&Apache::loncommon::csv_translate($field).'",';
 1682:     }
 1683:     foreach my $seq (@sequences) {
 1684:         $sequence_row .= '"'.
 1685:             &Apache::loncommon::csv_translate($seq->compTitle).'",';
 1686:         my $count = 0;
 1687:         if ($chosen_output->{'every_problem'}) {
 1688:             foreach my $res (&get_resources($navmap,$seq)) {
 1689:                 if (scalar(@{$res->parts}) < 1) {
 1690:                     next;
 1691:                 }
 1692:                 foreach my $part (@{$res->parts}) {
 1693:                     $resource_row .= '"'.
 1694:                         &Apache::loncommon::csv_translate
 1695:                         ($res->compTitle.', Part '.$res->part_display($part)).'",';
 1696:                     $count++;
 1697:                 }
 1698:             }
 1699:         }
 1700:         $sequence_row.='"",'x$count;
 1701:         if ($chosen_output->{'sequence_sum'}) {
 1702:             if($chosen_output->{'correct'}) {
 1703:                 $resource_row .= '"sum",';
 1704:             } else {
 1705:                 $resource_row .= '"score",';
 1706:             }
 1707:         }
 1708:         if ($chosen_output->{'sequence_max'}) {
 1709:             $sequence_row.= '"",';
 1710:             $resource_row .= '"maximum possible",';
 1711:         }
 1712:     }
 1713:     if ($chosen_output->{'grand_total'}) {
 1714:         $sequence_row.= '"",';
 1715:         $resource_row.= '"Total",';
 1716:     } 
 1717:     if ($chosen_output->{'grand_maximum'}) {
 1718:         $sequence_row.= '"",';
 1719:         $resource_row.= '"Maximum",';
 1720:     } 
 1721:     chomp($sequence_row);
 1722:     chomp($resource_row);
 1723:     print $outputfile $sequence_row."\n";
 1724:     print $outputfile $resource_row."\n";
 1725:     return;
 1726: }
 1727: 
 1728: sub csv_outputstudent {
 1729:     my ($r,$student) = @_;
 1730:     if ($request_aborted || ! defined($navmap) || ! defined($outputfile)) {
 1731:         return;
 1732:     }
 1733:     my $Str = '';
 1734:     #
 1735:     # Output student fields
 1736:     my @to_show = &get_student_fields_to_show();
 1737:     foreach my $field (@to_show) {
 1738:         my $value = $student->{$field};
 1739:         if ($field eq 'comments') {
 1740:             $value = &Apache::lonmsgdisplay::retrieve_instructor_comments
 1741:                 ($student->{'username'},$student->{'domain'});
 1742:         }        
 1743:         $Str .= '"'.&Apache::loncommon::csv_translate($value).'",';
 1744:     }
 1745:     #
 1746:     # Get student assessment data
 1747:     my %StudentsData;
 1748:     my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
 1749:                                                         $student->{'domain'},
 1750:                                                         undef,
 1751:                                                    $env{'request.course.id'});
 1752:     if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
 1753:         %StudentsData = @tmp;
 1754:     }
 1755:     #
 1756:     # Output performance data
 1757:     my $total = 0;
 1758:     my $maximum = 0;
 1759:     foreach my $seq (@sequences) {
 1760:         my ($performance,$performance_length,$score,$seq_max,$rawdata);
 1761:         if ($chosen_output->{'tries'}){
 1762:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1763:                 &student_tries_on_sequence($student,\%StudentsData,
 1764:                                            $navmap,$seq,'no');
 1765:         } else {
 1766:             ($performance,$performance_length,$score,$seq_max,$rawdata) =
 1767:                 &student_performance_on_sequence($student,\%StudentsData,
 1768:                                                  $navmap,$seq,'no',
 1769:                                                  $chosen_output->{ignore_weight});
 1770:         }
 1771:         if ($chosen_output->{'every_problem'}) {
 1772:             if ($chosen_output->{'correct'}) {
 1773:                 $score = 0;
 1774:                 # Deal with number of parts correct data
 1775:                 $Str .= '"'.join('","',( map { if ($_>0) { 
 1776:                                                    $score += 1;
 1777:                                                    1; 
 1778:                                                } else { 
 1779:                                                    0; 
 1780:                                                }
 1781:                                              } @$rawdata)).'",';
 1782:             } else {
 1783:                 $Str .= '"'.join('","',(@$rawdata)).'",';
 1784:             }
 1785:         }
 1786:         if ($chosen_output->{'sequence_sum'}) {
 1787:             $Str .= '"'.$score.'",';
 1788:         } 
 1789:         if ($chosen_output->{'sequence_max'}) {
 1790:             $Str .= '"'.$seq_max.'",';
 1791:         }
 1792:         $total+=$score;
 1793:         $maximum += $seq_max;
 1794:     }
 1795:     if ($chosen_output->{'grand_total'}) {
 1796:         $Str .= '"'.$total.'",';
 1797:     }
 1798:     if ($chosen_output->{'grand_maximum'}) {
 1799:         $Str .= '"'.$maximum.'",';
 1800:     }
 1801:     chop($Str);
 1802:     $Str .= "\n";
 1803:     print $outputfile $Str;
 1804:     #
 1805:     # Update the progress window
 1806:     &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
 1807:     return;
 1808: }
 1809: 
 1810: sub csv_finish {
 1811:     my ($r) = @_;
 1812:     if ($request_aborted || ! defined($navmap) || ! defined($outputfile)) {
 1813: 	&csv_cleanup();
 1814:         return;
 1815:     }
 1816:     close($outputfile);
 1817:     #
 1818:     # Close the progress window
 1819:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
 1820:     #
 1821:     # Tell the user where to get their csv file
 1822:     $r->print('<br />'.
 1823:               '<a href="'.$filename.'">'.&mt('Your csv file.').'</a>'."\n");
 1824:     $r->rflush();
 1825:     &csv_cleanup();
 1826:     return;
 1827:     
 1828: }
 1829: 
 1830: }
 1831: 
 1832: # This function will return an HTML string including a star, with
 1833: # a mouseover popup showing the "real" value. An optional second
 1834: # argument lets you show something other than a star.
 1835: sub show_star {
 1836:     my $popup = shift;
 1837:     my $symbol = shift || '*';
 1838:     # Escape the popup for JS.
 1839:     $popup =~ s/([^-a-zA-Z0-9:;,._ ()|!\/?=&*])/'\\' . sprintf("%lo", ord($1))/ge;
 1840:     
 1841:     return "<span class=\"LC_chrt_popup_exists\" onmouseover='popup_score(this, \"$popup\");return false;' onmouseout='popdown_score();return false;'>$symbol</span>";
 1842: }
 1843: 
 1844: #######################################################
 1845: #######################################################
 1846: 
 1847: =pod
 1848: 
 1849: =item &StudentTriesOnSequence()
 1850: 
 1851: Inputs:
 1852: 
 1853: =over 4
 1854: 
 1855: =item $student
 1856: 
 1857: =item $studentdata Hash ref to all student data
 1858: 
 1859: =item $seq Hash ref, the sequence we are working on
 1860: 
 1861: =item $links if defined we will output links to each resource.
 1862: 
 1863: =back
 1864: 
 1865: =cut
 1866: 
 1867: #######################################################
 1868: #######################################################
 1869: sub student_tries_on_sequence {
 1870:     my ($student,$studentdata,$navmap,$seq,$links) = @_;
 1871:     $links = 'no' if (! defined($links));
 1872:     my $Str = '';
 1873:     my ($sum,$max) = (0,0);
 1874:     my $performance_length = 0;
 1875:     my @TriesData = ();
 1876:     my $tries;
 1877:     my $hasdata = 0; # flag - true if the student has any data on the sequence
 1878:     foreach my $resource (&get_resources($navmap,$seq)) {
 1879:         my $resource_data = $studentdata->{$resource->symb};
 1880:         my $value = '';
 1881:         foreach my $partnum (@{$resource->parts()}) {
 1882:             $tries = undef;
 1883:             $max++;
 1884:             $performance_length++;
 1885:             my $symbol = ' '; # default to space
 1886:             #
 1887:             my $awarded = 0;
 1888:             if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) {
 1889:                 $awarded = $resource_data->{'resource.'.$partnum.'.awarded'};
 1890:                 $awarded = 0 if (! $awarded);
 1891:             }
 1892:             #
 1893:             my $status = '';
 1894:             if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
 1895:                 $status = $resource_data->{'resource.'.$partnum.'.solved'};
 1896:             }
 1897:             #
 1898:             my $tries = 0;
 1899:             if(exists($resource_data->{'resource.'.$partnum.'.tries'})) {
 1900:                 $tries = $resource_data->{'resource.'.$partnum.'.tries'};
 1901:                 $hasdata =1;
 1902:             }
 1903:             #
 1904:             if ($awarded > 0) {
 1905:                 # The student has gotten the problem correct to some degree
 1906:                 if ($status eq 'excused') {
 1907:                     $symbol = 'x';
 1908:                     $max--;
 1909:                 } elsif ($status eq 'correct_by_override' && !$resource->is_task()) {
 1910:                     $symbol = '+';
 1911:                     $sum++;
 1912:                 } elsif ($tries > 0) {
 1913:                     if ($tries > 9) {
 1914:                         $symbol = show_star($tries);
 1915:                     } else {
 1916:                         $symbol = $tries;
 1917:                     }
 1918:                     $sum++;
 1919:                 } else {
 1920:                     $symbol = '+';
 1921:                     $sum++;
 1922:                 }
 1923:             } else {
 1924:                 # The student has the problem incorrect or it is ungraded
 1925:                 if ($status eq 'excused') {
 1926:                     $symbol = 'x';
 1927:                     $max--;
 1928:                 } elsif ($status eq 'incorrect_by_override') {
 1929:                     $symbol = '-';
 1930:                 } elsif ($status eq 'ungraded_attempted') {
 1931:                     $symbol = 'u';
 1932:                 } elsif ($status eq 'incorrect_attempted' ||
 1933:                          $tries > 0)  {
 1934:                     $symbol = '.';
 1935:                 } else {
 1936:                     # Problem is wrong and has not been attempted.
 1937:                     $symbol=' ';
 1938:                 }
 1939:             }
 1940:             #
 1941:             if (! defined($tries)) {
 1942:                 $tries = 0;
 1943:             }
 1944:             if ($status =~ /^(incorrect|ungraded)/) {
 1945:                 # Bug 3390: show '-' for tries on incorrect problems 
 1946:                 # (csv & excel only)
 1947:                 push(@TriesData,-$tries);
 1948:             } else {
 1949:                 push (@TriesData,$tries);
 1950:             }
 1951:             #
 1952:             if ( ($links eq 'yes' && $symbol ne ' ') ||
 1953:                  ($links eq 'all')) {
 1954:                 if (length($symbol) > 1) {
 1955:                     &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
 1956:                 }
 1957:                 my $link = '/adm/grades'.
 1958:                     '?symb='.&escape($resource->symb).
 1959:                         '&student='.$student->{'username'}.
 1960:                             '&userdom='.$student->{'domain'}.
 1961:                                 '&command=submission';
 1962:                 $symbol = &link($symbol, $link);
 1963:             }
 1964:             $value .= $symbol;
 1965:         }
 1966:         $Str .= $value;
 1967:     }
 1968:     if ($seq->randompick()) {
 1969:         $max = $seq->randompick();
 1970:     }
 1971:     if (! $hasdata && $sum == 0) {
 1972:         $sum = ' ';
 1973:     }
 1974:     return ($Str,$performance_length,$sum,$max,\@TriesData);
 1975: }
 1976: 
 1977: =pod
 1978: 
 1979: =item &link
 1980: 
 1981: Inputs:
 1982: 
 1983: =over 4
 1984: 
 1985: =item $text
 1986: 
 1987: =item $target
 1988: 
 1989: =back
 1990: 
 1991: Takes the text and creates a link to the $text that honors
 1992: the value of 'new window' if clicked on, but uses a real 
 1993: 'href' so middle and right clicks still work.
 1994: 
 1995: $target and $text are assumed to be already correctly escaped; i.e., it
 1996: can be dumped out directly into the output stream as-is.
 1997: 
 1998: =cut
 1999: 
 2000: sub link {
 2001:     my ($text,$target) = @_;
 2002:     return 
 2003:         "<a href='$target' onclick=\"t=this.href;if(new_window)"
 2004:         ."{window.open(t)}else{return void(window."
 2005:         ."location=t)};return false;\">$text</a>";
 2006: }
 2007: 
 2008: #######################################################
 2009: #######################################################
 2010: 
 2011: =pod
 2012: 
 2013: =item &student_performance_on_sequence
 2014: 
 2015: Inputs:
 2016: 
 2017: =over 4
 2018: 
 2019: =item $student
 2020: 
 2021: =item $studentdata Hash ref to all student data
 2022: 
 2023: =item $seq Hash ref, the sequence we are working on
 2024: 
 2025: =item $links if defined we will output links to each resource.
 2026: 
 2027: =back
 2028: 
 2029: =cut
 2030: 
 2031: #######################################################
 2032: #######################################################
 2033: sub student_performance_on_sequence {
 2034:     my ($student,$studentdata,$navmap,$seq,$links,$awarded_only) = @_;
 2035:     $links = 'no' if (! defined($links));
 2036:     my $Str = ''; # final result string
 2037:     my ($score,$max) = (0,0);
 2038:     my $performance_length = 0;
 2039:     my $symbol;
 2040:     my @ScoreData = ();
 2041:     my $partscore;
 2042:     my $hasdata = 0; # flag, 0 if there were no submissions on the sequence
 2043:     foreach my $resource (&get_resources($navmap,$seq)) {
 2044:         my $symb = $resource->symb;
 2045:         my $resource_data = $studentdata->{$symb};
 2046:         foreach my $part (@{$resource->parts()}) {
 2047:             $partscore = undef;
 2048:             my $weight;
 2049:             if (!$awarded_only){
 2050:                 $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
 2051:                                                $symb,
 2052:                                                $student->{'domain'},
 2053:                                                $student->{'username'},
 2054:                                                $student->{'section'});
 2055:             }
 2056:             if (!defined($weight) || ($weight eq '')) { 
 2057:                 $weight=1;
 2058:             }
 2059:             #
 2060:             $max += $weight; # see the 'excused' branch below...
 2061:             $performance_length++; # one character per part
 2062:             $symbol = ' '; # default to space
 2063:             #
 2064:             my $awarded;
 2065:             if (exists($resource_data->{'resource.'.$part.'.awarded'})) {
 2066:                 $awarded = $resource_data->{'resource.'.$part.'.awarded'};
 2067:                 $awarded = 0 if (! $awarded);
 2068:                 $hasdata = 1;
 2069:             }
 2070:             #
 2071:             $partscore = &Apache::grades::compute_points($weight,$awarded);
 2072:             if (! defined($awarded)) {
 2073:                 $partscore = undef;
 2074:             }
 2075:             $score += $partscore;
 2076:             $symbol = $partscore; 
 2077:             if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) {
 2078:                 $symbol = sprintf("%.0f",$symbol);
 2079:             }
 2080:             if (length($symbol) > 1) {
 2081:                 $symbol = show_star($symbol);
 2082:             }
 2083:             if (exists($resource_data->{'resource.'.$part.'.solved'}) &&
 2084:                 $resource_data->{'resource.'.$part.'.solved'} ne '') {
 2085:                 my $status = $resource_data->{'resource.'.$part.'.solved'};
 2086:                 if ($status eq 'excused') {
 2087:                     $symbol = 'x';
 2088:                     $max -= $weight; # Do not count 'excused' problems.
 2089:                 } elsif ($status eq 'ungraded_attempted') {
 2090:                     $symbol = 'u';
 2091:                 }
 2092:                 $hasdata = 1;
 2093:             } elsif ($resource_data->{'resource.'.$part.'.award'} eq 'DRAFT') {
 2094:                 $symbol = 'd';
 2095:                 $hasdata = 1;
 2096:             } elsif (!exists($resource_data->{'resource.'.$part.'.awarded'})){
 2097:                 # Unsolved.  Did they try?
 2098:                 if (exists($resource_data->{'resource.'.$part.'.tries'})){
 2099:                     $symbol = '.';
 2100:                     $hasdata = 1;
 2101:                 } else {
 2102:                     $symbol = ' ';
 2103:                 }
 2104:             }
 2105:             #
 2106:             if (! defined($partscore)) {
 2107:                 $partscore = $symbol;
 2108:             }
 2109:             push (@ScoreData,$partscore);
 2110:             #
 2111:             if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
 2112:                 my $link = '/adm/grades' .
 2113:                     '?symb='.&escape($symb).
 2114:                     '&student='.$student->{'username'}.
 2115:                     '&userdom='.$student->{'domain'}.
 2116:                     '&command=submission';
 2117:                 $symbol = &link($symbol, $link);
 2118:             }
 2119:             $Str .= $symbol;
 2120:         }
 2121:     }
 2122:     if (! $hasdata && $score == 0) {
 2123:         $score = ' ';
 2124:     }
 2125:     return ($Str,$performance_length,$score,$max,\@ScoreData);
 2126: }
 2127: 
 2128: #######################################################
 2129: #######################################################
 2130: 
 2131: =pod
 2132: 
 2133: =item &CreateLegend()
 2134: 
 2135: This function returns a formatted string containing the legend for the
 2136: chart.  The legend describes the symbols used to represent grades for
 2137: problems.
 2138: 
 2139: =cut
 2140: 
 2141: #######################################################
 2142: #######################################################
 2143: sub CreateLegend {
 2144:     my $Str = "<p><pre>".
 2145:               " digit score or number of tries to get correct ".
 2146:               "   *  correct by student in more than 9 tries\n".
 2147: 	      "   +  correct by hand grading or override\n".
 2148:               "   -  incorrect by override\n".
 2149: 	      "   .  incorrect attempted\n".
 2150: 	      "   u  ungraded attempted\n".
 2151:               "   d  draft answer saved but not submitted\n".
 2152:               "      not attempted (blank field)\n".
 2153: 	      "   x  excused".
 2154:               "</pre><p>";
 2155:     return $Str;
 2156: }
 2157: 
 2158: #######################################################
 2159: #######################################################
 2160: 
 2161: =pod 
 2162: 
 2163: =back
 2164: 
 2165: =cut
 2166: 
 2167: #######################################################
 2168: #######################################################
 2169: 
 2170: 1;
 2171: 
 2172: __END__

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