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

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

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