Annotation of loncom/interface/statistics/lonstudentassessment.pm, revision 1.117

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

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