Annotation of loncom/interface/statistics/lonstudentsubmissions.pm, revision 1.26

1.1       matthew     1: # The LearningOnline Network with CAPA
                      2: #
1.26    ! matthew     3: # $Id: lonstudentsubmissions.pm,v 1.25 2004/10/08 16:40:54 matthew Exp $
1.1       matthew     4: #
                      5: # Copyright Michigan State University Board of Trustees
                      6: #
                      7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      8: #
                      9: # LON-CAPA is free software; you can redistribute it and/or modify
                     10: # it under the terms of the GNU General Public License as published by
                     11: # the Free Software Foundation; either version 2 of the License, or
                     12: # (at your option) any later version.
                     13: #
                     14: # LON-CAPA is distributed in the hope that it will be useful,
                     15: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     16: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     17: # GNU General Public License for more details.
                     18: #
                     19: # You should have received a copy of the GNU General Public License
                     20: # along with LON-CAPA; if not, write to the Free Software
                     21: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     22: #
                     23: # /home/httpd/html/adm/gpl.txt
                     24: #
                     25: # http://www.lon-capa.org/
                     26: #
                     27: package Apache::lonstudentsubmissions;
                     28: 
                     29: use strict;
                     30: use Apache::lonnet();
                     31: use Apache::loncommon();
                     32: use Apache::lonhtmlcommon();
                     33: use Apache::loncoursedata();
                     34: use Apache::lonstatistics;
                     35: use Apache::lonlocal;
                     36: use Apache::lonstathelpers;
                     37: use HTML::Entities();
                     38: use Time::Local();
                     39: use Spreadsheet::WriteExcel();
                     40: 
1.18      matthew    41: my @SubmitButtons = ({ name => 'SelectAnother',
1.1       matthew    42:                        text => 'Choose a different Problem' },
                     43:                      { name => 'Generate',
1.16      matthew    44:                        text => 'Generate Report'},
1.1       matthew    45:                      );
                     46: 
                     47: sub BuildStudentSubmissionsPage {
                     48:     my ($r,$c)=@_;
                     49:     #
                     50:     my %Saveable_Parameters = ('Status' => 'scalar',
                     51:                                'Section' => 'array',
                     52:                                'NumPlots' => 'scalar',
                     53:                                );
                     54:     &Apache::loncommon::store_course_settings('student_submissions',
                     55:                                               \%Saveable_Parameters);
                     56:     &Apache::loncommon::restore_course_settings('student_submissions',
                     57:                                                 \%Saveable_Parameters);
                     58:     #
                     59:     &Apache::lonstatistics::PrepareClasslist();
                     60:     #
                     61:     $r->print(&CreateInterface());
                     62:     #
                     63:     my @Students = @Apache::lonstatistics::Students;
                     64:     #
                     65:     if (@Students < 1) {
                     66:         $r->print('<h2>There are no students in the sections selected</h2>');
                     67:     }
                     68:     #
1.11      matthew    69:     my @CacheButtonHTML = 
1.19      matthew    70:         &Apache::lonstathelpers::manage_caches($r,'Statistics','stats_status',
                     71:                                    '<h3>'.&mt('Loading student data').'</h3>');
1.1       matthew    72:     $r->rflush();
                     73:     #
                     74:     if (exists($ENV{'form.problemchoice'}) && 
                     75:         ! exists($ENV{'form.SelectAnother'})) {
                     76:         foreach my $button (@SubmitButtons) {
                     77:             if ($button->{'name'} eq 'break') {
                     78:                 $r->print("<br />\n");
                     79:             } else {
                     80:                 $r->print('<input type="submit" name="'.$button->{'name'}.'" '.
                     81:                           'value="'.&mt($button->{'text'}).'" />');
                     82:                 $r->print('&nbsp;'x5);
                     83:             }
                     84:         }
1.11      matthew    85:         foreach my $html (@CacheButtonHTML) {
                     86:             $r->print($html.('&nbsp;'x5));
                     87:         }
1.1       matthew    88:         #
1.18      matthew    89:         $r->print('<hr />'.$/);
1.1       matthew    90:         $r->rflush();
                     91:         #
1.18      matthew    92:         # Determine which problems we are to analyze
                     93:         my @Symbs = 
                     94:             &Apache::lonstathelpers::get_selected_symbs('problemchoice');
                     95:         foreach my $selected (@Symbs) {
                     96:             $r->print('<input type="hidden" name="problemchoice" value="'.
                     97:                       $selected.'" />'.$/);
                     98:         }
1.1       matthew    99:         #
1.18      matthew   100:         # Get resource objects
                    101:         my $navmap = Apache::lonnavmaps::navmap->new();
                    102:         if (!defined($navmap)) {
                    103:             $r->print('<h1>'.&mt("Internal error").'</h1>');
                    104:             return;
                    105:         }
                    106:         my %already_seen;
                    107:         my @Problems;
                    108:         foreach my $symb (@Symbs) {
                    109:             my $resource = $navmap->getBySymb($symb);
                    110:             push(@Problems,$resource);
1.1       matthew   111:         }
1.25      matthew   112:         # 
1.18      matthew   113:         if (! scalar(@Problems) || ! defined($Problems[0])) {
1.1       matthew   114:             $r->print('resource is undefined');
                    115:         } else {
1.18      matthew   116:             if (scalar(@Problems) == 1) {
                    117:                 my $resource = $Problems[0];
                    118:                 $r->print('<h1>'.$resource->title.'</h1>');
                    119:                 $r->print('<h3>'.$resource->src.'</h3>');
                    120:                 if ($ENV{'form.renderprob'} eq 'true') {
                    121:                     $r->print(
                    122:                               &Apache::lonstathelpers::render_resource({src => $resource->src})
                    123:                               );
                    124:                     $r->rflush();
                    125:                 }
                    126:             }
1.21      matthew   127:             if ($ENV{'form.output'} eq 'excel') {
                    128:                 &prepare_excel_output($r,\@Problems,\@Students);
1.22      matthew   129:             } elsif ($ENV{'form.output'} eq 'csv') {
                    130:                 &prepare_csv_output($r,\@Problems,\@Students);
1.21      matthew   131:             } else {
                    132:                 &prepare_html_output($r,\@Problems,\@Students);
                    133:             }
1.1       matthew   134:         }
                    135:         $r->print('<hr />');
                    136:     } else {
                    137:         $r->print('<input type="submit" name="Generate" value="'.
1.17      matthew   138:                   &mt('Prepare Report').'" />');
1.1       matthew   139:         $r->print('&nbsp;'x5);
1.19      matthew   140:         $r->print('<p>'.
                    141:                   &mt('Computing correct answers greatly increasese the amount of time required to prepare a report.').
                    142:                   '</p>');
                    143:         $r->print('<p>'.
                    144:                   &mt('please select problems and use the <b>Prepare Report</b> button to continue.').
                    145:                   '</p>');
1.18      matthew   146:         $r->print(&Apache::lonstathelpers::MultipleProblemSelector
1.19      matthew   147:                   (undef,'problemchoice','Statistics'));
1.18      matthew   148:     }
                    149: }
                    150: 
                    151: #########################################################
                    152: #########################################################
1.21      matthew   153: ##
                    154: ##    HTML Output Routines
                    155: ##
                    156: #########################################################
                    157: #########################################################
                    158: sub prepare_html_output {
                    159:     my ($r,$problems,$students) = @_;
                    160:     my $c = $r->connection();
                    161:     #
                    162:     # Set a flag for the case when there is just one problem
                    163:     my $single_response = 0;
                    164:     if (scalar(@$problems) == 1 &&
                    165:         $problems->[0]->countResponses == 1) {
                    166:         $single_response = 1;
                    167:     }
                    168:     #
                    169:     # Compute the number of columns per response
                    170:     my @response_headers = ('Submission');
                    171:     if ($ENV{'form.correctans'} eq 'true') {
                    172:         push(@response_headers,'Correct');
                    173:     } 
                    174:     if ($ENV{'form.prob_status'} eq 'true') {
                    175:         push(@response_headers,'Award Detail'); 
                    176:         push(@response_headers,'Time');
                    177:         push(@response_headers,'Attempt');
                    178:         push(@response_headers,'Awarded');
                    179:     }
                    180:     my $response_multiplier = scalar(@response_headers);
                    181:     #
                    182:     # Create the table header
                    183:     my @student_columns = ('username','domain','id');
                    184:     #
                    185:     my %headers;
                    186:     my $student_column_count = scalar(@student_columns);
                    187:     $headers{'problem'} = qq{<th colspan="$student_column_count">\&nbsp;</th>};
                    188:     foreach (@student_columns) {
                    189:         $headers{'student'}.= '<th>'.ucfirst($_).'</th>';
                    190:     }
                    191:     #
                    192:     # we put the headers into the %headers hash
                    193:     my $total_col = scalar(@student_columns);
                    194:     my $nonempty_part_headers = 0;
                    195:     foreach my $prob (@$problems) {
                    196:         my $prob_span = 0;
                    197:         my $single_part = 0;
                    198:         if (scalar(@{$prob->parts}) == 1) {
                    199:             $single_part = 1;
                    200:         }
                    201:         foreach my $partid (@{$prob->parts}) {
                    202:             my $part_span = 0;
                    203:             my $responses = [$prob->responseIds($partid)];
                    204:             my $resptypes = [$prob->responseType($partid)];
                    205:             for (my $i=0;$i<scalar(@$responses);$i++) {
                    206:                 if ($resptypes->[$i] eq 'essay') {
                    207:                     # do something clever, like shut up.
                    208:                 } else {
                    209:                     $total_col += scalar(@response_headers);
                    210:                     $headers{'response'} .=
                    211:                         '<th colspan="'.scalar(@response_headers).'">'.
                    212:                         &mt('Response [_1]',$responses->[$i]).'</th>';
                    213:                     $headers{'student'}.= '<th>'.join('</th><th>',
                    214:                                                       @response_headers).
                    215:                                                           '</th>';
                    216:                     $part_span += scalar(@response_headers);
                    217:                 }
                    218:             }
                    219:             if (! $single_part) {
                    220:                 my $tmpname = $partid;
                    221:                 if ($partid =~/^\d+$/) {
1.24      matthew   222:                     $tmpname = $prob->part_display($partid);
1.21      matthew   223:                 }
                    224:                 $headers{'part'} .= qq{<th colspan="$part_span">$tmpname</th>};
                    225:                 $nonempty_part_headers = 1;
                    226:             } else {
                    227:                 $headers{'part'} .= qq{<th colspan="$part_span">&nbsp</th>};
                    228:             }
                    229:             $prob_span += $part_span;
                    230:         }
1.23      matthew   231:         my $title = $prob->compTitle;
1.21      matthew   232:         if ($prob_span > 0) {
                    233:             $headers{'problem'}.= qq{<th colspan="$prob_span">$title</th>};
                    234:         } elsif ($single_response) {
                    235:             $prob_span = scalar(@student_columns);
                    236:             $headers{'problem'} = qq{<th colspan="$prob_span">$title</th>};
                    237:         }
                    238:     }
                    239:     if (exists($headers{'part'})) {
                    240:         $headers{'part'} = qq{<th colspan="$student_column_count">\&nbsp;</th>}.
                    241:             $headers{'part'};
                    242:     }
                    243:     if (exists($headers{'response'})) {
                    244:         $headers{'response'}=
                    245:             qq{<th colspan="$student_column_count">\&nbsp;</th>}.
                    246:             $headers{'response'};
                    247:     }
                    248:     my $full_header = $/.'<table>'.$/;
                    249:     $full_header .= '<tr align="left">'.$headers{'problem'}.'</tr>'.$/;
                    250:     if ($nonempty_part_headers) {
                    251:         $full_header .= '<tr align="left">'.$headers{'part'}.'</tr>'.$/;
                    252:     }
                    253:     $full_header .= '<tr align="left">'.$headers{'response'}.'</tr>'.$/;
                    254:     $full_header .= '<tr align="left">'.$headers{'student'}.'</tr>'.$/;
                    255:     #
                    256:     # Main loop
                    257:     my $count;
                    258:     $r->print($/.$full_header.$/);
                    259:     my $row_class = 'odd';   # css 
                    260:     foreach my $student (@$students) {
                    261:         my $student_row_data;
                    262:         if ($count++ >= 30) {
                    263:             $r->print('</table>'.$/.$full_header.$/);
                    264:             $count = 0;
                    265:         }
                    266:         last if ($c->aborted());
                    267:         foreach my $field (@student_columns) {
                    268:             $student_row_data .= 
                    269:                 '<td valign="top">'.$student->{$field}.'</td>';
                    270:         }
                    271:         #
                    272:         # Figure out what it is we need to output for this student
                    273:         my @essays;
                    274:         my %problem_data;
                    275:         my $maxrow;
                    276:         foreach my $prob (@$problems) {
                    277:             my $symb = $prob->symb;
                    278:             $problem_data{$symb}={};
                    279:             foreach my $partid (@{$prob->parts}) {
                    280:                 my @responses = $prob->responseIds($partid);
                    281:                 my @response_type = $prob->responseType($partid);
                    282:                 for (my $i=0;$i<=$#responses;$i++) {
                    283:                     my $respid   = $responses[$i];
                    284:                     my $resptype = $response_type[$i];
                    285:                     my $width = scalar(@response_headers);
                    286:                     $problem_data{$symb}->{$partid}->{$respid}={};
                    287:                     my $resp_data = $problem_data{$symb}->{$partid}->{$respid};
                    288:                     $resp_data->{'fake'} = qq{<td colspan="$width">&nbsp</td>};
                    289:                     my $results = 
                    290:                         &Apache::loncoursedata::get_response_data_by_student
                    291:                         ($student,$prob->symb(),$respid);
                    292:                     if (! defined($results)) {
                    293:                         $results = [];
                    294:                     }
                    295:                     #
                    296:                     if (scalar(@$results) > $maxrow && $resptype ne 'essay') {
                    297:                         $maxrow = scalar(@$results);
                    298:                     }
                    299:                     for (my $j=scalar(@$results)-1;$j>=0;$j--) {
                    300:                         my $response = $results->[$j];
                    301:                         if ($ENV{'form.all_sub'} ne 'true') {
                    302:                             next if ($j ne scalar(@$results)-1);
                    303:                         }
                    304:                         if ($resptype eq 'essay') {
                    305:                             push(@essays,
                    306:                                  &html_essay_results($student,
                    307:                                                      $prob,$partid,$respid,
                    308:                                                      $response,
                    309:                                                      $single_response).
                    310:                                  '</td>');
                    311:                         } else {
                    312:                             push(@{$resp_data->{'real'}},
                    313:                                  &html_results($student,
                    314:                                                $prob,$partid,$respid,
                    315:                                                $response,$resptype));
                    316:                         }
                    317:                     } 
                    318:                 } # end of $i loop
                    319:             } # end of partid loop
                    320:         } # end of prob loop
                    321:         #
                    322:         # if there is no data, skip this student.
                    323:         next if (! $maxrow && ! scalar(@essays));
                    324:         #
                    325:         # Go through the problem data and output a row.
                    326:         if ($row_class eq 'even') {
                    327:             $row_class = 'odd'; 
                    328:         } else {
                    329:             $row_class = 'even'; 
                    330:         }
                    331:         my $printed_something;
                    332:         for (my $rows_output = 0;$rows_output<$maxrow;$rows_output++) {
                    333:             my $html;
                    334:             my $no_data = 1;
                    335:             foreach my $prob (@$problems) {
                    336:                 my $symb = $prob->symb;
                    337:                 foreach my $partid (@{$prob->parts}) {
                    338:                     my @responses     = $prob->responseIds($partid);
                    339:                     my @response_type = $prob->responseType($partid);
                    340:                     for (my $i=0;$i<=$#responses;$i++) {
                    341:                         my $respid   = $responses[$i];
                    342:                         my $resp_data = 
                    343:                             $problem_data{$symb}->{$partid}->{$respid};
                    344:                         next if ($response_type[$i] eq 'essay');
                    345:                         if (defined($resp_data->{'real'}->[$rows_output])) {
                    346:                             $html .= $resp_data->{'real'}->[$rows_output];
                    347:                             $no_data = 0;
                    348:                         } else {
                    349:                             $html .= $resp_data->{'fake'};
                    350:                         }
                    351:                     }
                    352:                 }
                    353:             }
                    354:             if (! $no_data) {
                    355:                 $r->print(qq{<tr class="$row_class">$student_row_data$html</tr>}.$/);
                    356:                 $printed_something=1;
                    357:             }
                    358:         }
                    359:         if (@essays) {
                    360:             my $tr = qq{<tr class="$row_class">};
                    361:             my $td = qq{<td  valign="top" class="essay" colspan="$total_col">};
                    362:             if (! $printed_something) {
                    363:                 $r->print($tr.$student_row_data.'</tr>'.$/);
                    364:             }
                    365:             $r->print($tr.$td.
                    366:                       join('</td></tr>'.$/.$tr.$td,@essays).'</td></tr>'.$/);
                    367:             undef(@essays);
                    368:         }
                    369:     } # end of student loop
                    370:     return;
                    371: }
                    372: 
                    373: #####################################################
                    374: ##
                    375: ##     HTML helper routines
                    376: ##
                    377: #####################################################
                    378: sub html_essay_results {
                    379:     my ($student,$prob,$partid,$respid,$response,$single_response)=@_;
                    380:     #
                    381:     my $submission =$response->[&Apache::loncoursedata::RDs_submission()];
                    382:     $submission = &html_format_sub($submission,'essay');
                    383:     #
                    384:     my $correct = '';
                    385:     if ($ENV{'form.correctans'} eq 'true') {
1.26    ! matthew   386:         $correct = &Apache::lonstathelpers::get_student_answer
1.21      matthew   387:             ($prob,$student->{'username'},$student->{'domain'},
                    388:              $partid,$respid);
                    389:         $correct = &html_format_sub($correct,'essay');
                    390:     }
                    391:     my $Str;
                    392:     if (! $single_response) {
1.23      matthew   393:         my $id = $prob->compTitle;
1.21      matthew   394:         if (defined($partid) && $partid ne '0') {
1.24      matthew   395:             $id .= ' '.$prob->part_display($partid);
1.21      matthew   396:         }
                    397:         if (defined($respid)) {
                    398:             $id .= ' '.$respid;
                    399:         }
                    400:         $Str .= '<nobr>'.$id.'</nobr>'.('&nbsp;'x4);
                    401:     }
                    402:     if ($ENV{'form.prob_status'} eq 'true') {
                    403:         $Str .= '<nobr>';
                    404:         $Str .= $response->[&Apache::loncoursedata::RDs_awarddetail()].
                    405:             ('&nbsp;'x4);
                    406:         $Str .= &mt('Attempt [_1]',
                    407:                     $response->[&Apache::loncoursedata::RDs_tries()]).
                    408:                         ('&nbsp;'x4);
                    409:         $Str .= &Apache::lonlocal::locallocaltime
                    410:             ($response->[&Apache::loncoursedata::RDs_timestamp()]).
                    411:             ('&nbsp;'x4);
                    412:         $Str .= &mt('Awarded: [_1]',
                    413:                     $response->[&Apache::loncoursedata::RDs_awarded()]).
                    414:                         ('&nbsp;'x4);
                    415:         $Str .= '</nobr><br />';
                    416:     }
                    417:     $Str .= $submission;
                    418:     if (defined($correct) && $correct !~ /^\s*$/) {
                    419:         $Str .= '<hr /><b>'.&mt('Correct').'</b>'.$correct
                    420:     }
                    421:     return $Str;
                    422: }
                    423: 
                    424: sub html_results {
                    425:     my ($student,$prob,$partid,$respid,$response,$resptype) = @_;
                    426:     my $submission =$response->[&Apache::loncoursedata::RDs_submission()];
                    427:     $submission = &html_format_sub($submission,$resptype);
                    428:     my $correct = '';
                    429:     if ($ENV{'form.correctans'} eq 'true') {
1.26    ! matthew   430:         $correct = &Apache::lonstathelpers::get_student_answer
1.21      matthew   431:             ($prob,$student->{'username'},$student->{'domain'},
                    432:              $partid,$respid);
                    433:         $correct = &html_format_sub($correct,$resptype);
                    434:     }
                    435:     my $Str;
                    436:     $Str .= '<td valign="top">'.$submission.'</td>';
                    437:     if ($ENV{'form.correctans'} eq 'true') {
                    438:         $Str .= '<td valign="top">'.$correct.'</td>';
                    439:     }
                    440:     if ($ENV{'form.prob_status'} eq 'true') {
                    441:         $Str .= '<td valign="top">'.
                    442:             $response->[&Apache::loncoursedata::RDs_awarddetail()].
                    443:             '</td>';
                    444:         $Str .= '<td valign="top"><nobr>'.
                    445:             &Apache::lonlocal::locallocaltime
                    446:             ($response->[&Apache::loncoursedata::RDs_timestamp()]).
                    447:             '</nobr></td>';
                    448:         $Str .= '<td valign="top">'.
                    449:             $response->[&Apache::loncoursedata::RDs_tries()].
                    450:             '</td>';
                    451:         $Str .= '<td valign="top">'.
                    452:             $response->[&Apache::loncoursedata::RDs_awarded()].
                    453:             '</td>';
                    454:     }
                    455:     return $Str;
                    456: }
                    457: 
                    458: sub html_format_sub {
                    459:     my ($submission,$resptype) = @_;
                    460:     return '' if (! defined($submission) || $submission eq '');
1.25      matthew   461:     $submission = &HTML::Entities::decode($submission);
                    462:     $submission =~ s/\\\"/\"/g;
                    463:     $submission =~ s/\\\'/\'/g;
1.21      matthew   464:     if ($resptype eq 'essay') {
                    465:         $submission =~ s|\\r\\n|$/|g;
                    466:         $submission = &HTML::Entities::encode($submission,'<>&"');
                    467:         $submission =~ s|$/\s*$/|$/</p><p>$/|g;
                    468:         $submission =~ s|\\||g;
                    469:         $submission = '<p>'.$submission.'</p>';
                    470:     } elsif ($resptype eq 'radiobutton') {
1.25      matthew   471:         $submission = &HTML::Entities::encode($submission,'<>&"');
1.21      matthew   472:         $submission =~ s/=([^=])$//;
                    473:     } elsif ($resptype =~ /^(option|match|rank)$/) {
                    474:         $submission = 
                    475:             '<ul class="sub_studentans">'.
                    476:             '<li>'.join('</li><li>',
1.25      matthew   477:                         map { &HTML::Entities::encode($_,'<>&"'); 
                    478:                           } map { 
                    479:                               &Apache::lonnet::unescape($_) ;
                    480:                           } sort split('&',$submission)
1.21      matthew   481:                         ).
                    482:                         '</li><ul>';
1.25      matthew   483:     } else {
                    484:         $submission = &HTML::Entities::encode($submission,'<>&"');
1.21      matthew   485:     }
                    486:     return $submission;
                    487: }
1.18      matthew   488: 
1.21      matthew   489: #########################################################
                    490: #########################################################
                    491: ##
                    492: ##    Excel Output Routines
                    493: ##
                    494: #########################################################
                    495: #########################################################
                    496: sub prepare_excel_output {
1.19      matthew   497:     my ($r,$Problems,$Students) = @_;
1.18      matthew   498:     my $c = $r->connection();
                    499:     #
1.19      matthew   500:     #
                    501:     # Determine the number of columns in the spreadsheet
                    502:     my $columncount = 3; # username, domain, id
1.20      matthew   503:     my $response_multiplier = 1;
                    504:     $response_multiplier ++   if ($ENV{'form.correctans'} eq 'true');
                    505:     $response_multiplier += 4 if ($ENV{'form.prob_status'} eq 'true');
                    506:     my $lastprob;
1.19      matthew   507:     foreach my $prob (@$Problems) {
1.20      matthew   508:         $columncount += ($response_multiplier * $prob->countResponses);
1.19      matthew   509:         last if ($columncount > 255);
1.20      matthew   510:         $lastprob = $prob;
1.19      matthew   511:     }
                    512:     if ($columncount > 255) {
                    513:         $r->print('<h1>'.&mt('Unable to complete request').'</h1>'.$/.
                    514:                   '<p>'.&mt('LON-CAPA is unable to produce your Excel spreadsheet because your selections will result in more than 255 columns.  Excel allows only 255 columns in a spreadsheet.').'</p>'.$/.
1.20      matthew   515:                   '<p>'.&mt('Consider selecting fewer problems to generate reports on, or reducing the number of items per problem.  Or use HTML or CSV output.').'</p>'.$/.
1.23      matthew   516:                   '<p>'.&mt('The last problem that will fit in the current spreadsheet is [_1].',$lastprob->compTitle).'</p>');
1.19      matthew   517:         $r->rflush();
                    518:         return;
                    519:     }
                    520:     #
                    521:     # Print out a message telling them what we are doing
1.18      matthew   522:     if (scalar(@$Problems) > 1) {
                    523:         $r->print('<h2>'.
                    524:                   &mt('Preparing Excel spreadsheet of student responses to [_1] problems',
                    525:                       scalar(@$Problems)).
                    526:                   '</h2>');
                    527:     } else {
                    528:         $r->print('<h2>'.
                    529:                   &mt('Preparing Excel spreadsheet of student responses').
                    530:                   '</h2>');
                    531:     }
                    532:     $r->rflush();
                    533:     #
                    534:     # Create the excel spreadsheet
                    535:     my $filename = '/prtspool/'.
                    536:         $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
                    537:         time.'_'.rand(1000000000).'.xls';
                    538:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                    539:     if (! defined($workbook)) {
                    540:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                    541:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                    542:                             "This error has been logged.  ".
                    543:                             "Please alert your LON-CAPA administrator").
                    544:                   '</p>');
                    545:         return undef;
                    546:     }
                    547:     #
                    548:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                    549:     #
                    550:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                    551:     my $worksheet  = $workbook->addworksheet('Student Submission Data');
                    552:     #
                    553:     # Add headers to the worksheet
                    554:     my $rows_output = 0;
                    555:     $worksheet->write($rows_output++,0,
                    556:                     $ENV{'course.'.$ENV{'request.course.id'}.'.description'},
                    557:                       $format->{'h1'});
                    558:     $rows_output++;
                    559:     my $cols_output = 0;
                    560:     my $title_row  = $rows_output++;
                    561:     my $partid_row = $rows_output++;
                    562:     my $respid_row = $rows_output++;
                    563:     my $header_row = $rows_output++;
                    564:     $worksheet->write($title_row ,0,'Problem Title',$format->{'bold'});
                    565:     $worksheet->write($partid_row,0,'Part ID',$format->{'bold'});
                    566:     $worksheet->write($respid_row,0,'Response ID',$format->{'bold'});
                    567:     # Student headers
                    568:     my @StudentColumns = ('username','domain','id');
                    569:     foreach (@StudentColumns) {
1.19      matthew   570:         $worksheet->write($header_row,$cols_output++,ucfirst($_),
                    571:                           $format->{'bold'});
1.18      matthew   572:     }
                    573:     # Problem headers
                    574:     foreach my $prob (@$Problems) {
1.23      matthew   575:         my $title = $prob->compTitle;
1.18      matthew   576:         $worksheet->write($title_row,$cols_output,
                    577:                           $title,$format->{'h3'});
                    578:         foreach my $partid (@{$prob->parts}) {
1.24      matthew   579:             $worksheet->write($partid_row,$cols_output,
                    580:                               $prob->part_display($partid));
1.18      matthew   581:             my $responses = [$prob->responseIds($partid)];
                    582:             my $resptypes = [$prob->responseType($partid)];
                    583:             for (my $i=0;$i<scalar(@$responses);$i++) {
                    584:                 $worksheet->write($respid_row,$cols_output,
                    585:                                   $resptypes->[$i].', '.$responses->[$i]);
                    586:                 $worksheet->write($header_row,$cols_output,'Submission');
                    587:                 $cols_output++;
1.19      matthew   588:                 if ($ENV{'form.correctans'} eq 'true') {
                    589:                     $worksheet->write($header_row,$cols_output,'Correct');
                    590:                     $cols_output++;
                    591:                 }
1.20      matthew   592:                 if ($ENV{'form.prob_status'} eq 'true') {
                    593:                     $worksheet->write($header_row,$cols_output++,
                    594:                                       'Award Detail');
                    595:                     $worksheet->write($header_row,$cols_output++,'Attempt');
                    596:                     $worksheet->write($header_row,$cols_output++,'Time');
                    597:                     $worksheet->write($header_row,$cols_output++,'Awarded');
                    598:                 }
1.18      matthew   599:             }
                    600:         }
                    601:     }
                    602:     #
                    603:     # Populate the worksheet with the student data
                    604:     my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
                    605:         ($r,'Excel File Compilation Status',
                    606:          'Excel File Compilation Progress', 
                    607:          scalar(@$Students),'inline',undef,'Statistics','stats_status');
1.20      matthew   608:     my $max_row = $rows_output;
1.18      matthew   609:     foreach my $student (@$Students) {
                    610:         last if ($c->aborted());
                    611:         $cols_output = 0;
1.20      matthew   612:         my $student_row = $max_row;
1.18      matthew   613:         foreach my $field (@StudentColumns) {
1.20      matthew   614:             $worksheet->write($student_row,$cols_output++,
1.18      matthew   615:                               $student->{$field});
                    616:         }
1.20      matthew   617:         my $last_student_col = $cols_output-1;
                    618:         my $response_count;
1.18      matthew   619:         foreach my $prob (@$Problems) {
                    620:             foreach my $partid (@{$prob->parts}) {
                    621:                 my @Response = $prob->responseIds($partid);
                    622:                 my @ResponseType = $prob->responseType($partid);
                    623:                 for (my $i=0;$i<=$#Response;$i++) {
1.20      matthew   624:                     my $response_start_col = $last_student_col + 
                    625:                         $response_count * $response_multiplier + 1;
                    626:                     $response_count++;
1.18      matthew   627:                     my $respid   = $Response[$i];
                    628:                     my $resptype = $ResponseType[$i];
                    629:                     my $results = 
                    630:                         &Apache::loncoursedata::get_response_data_by_student
                    631:                         ($student,$prob->symb(),$respid);
1.20      matthew   632:                     if (! defined($results)) {
                    633:                         $results = [];
                    634:                     }
                    635:                     #
                    636:                     $rows_output = $student_row;
                    637:                     #
                    638:                     for (my $j=scalar(@$results)-1;$j>=0;$j--) {
                    639:                         $cols_output = $response_start_col;
                    640:                         my $response = $results->[$j];
                    641:                         if ($ENV{'form.all_sub'} ne 'true') {
                    642:                             next if ($j ne scalar(@$results)-1);
                    643:                         }
                    644:                         my $cols_output = &write_excel_row
                    645:                             ($worksheet,
                    646:                              $rows_output++,$cols_output,
                    647:                              $response,$student,
                    648:                              $prob,$partid,$respid,
                    649:                              $format,$resptype);
                    650:                         if ($rows_output > $max_row) {
                    651:                             $max_row = $rows_output;
                    652:                         }
1.19      matthew   653:                     }
1.18      matthew   654:                 }
                    655:             }
                    656:         }
                    657:         $rows_output++;
                    658:         &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
                    659:                                                  'last student');
                    660:     }
                    661:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
                    662:     #
                    663:     # Close the excel file
                    664:     $workbook->close();
                    665:     #
                    666:     # Write a link to allow them to download it
                    667:     $r->print('<p><a href="'.$filename.'">'.
                    668:               &mt('Your Excel spreadsheet.').
                    669:               '</a></p>'."\n");
                    670:     $r->print('<script>'.
                    671:               'window.document.Statistics.stats_status.value="'.
                    672:               'Done compiling spreadsheet.  See link below to download.'.
                    673:               '";</script>');
                    674:     $r->rflush();
                    675:     return;
                    676: }
                    677: 
1.20      matthew   678: sub write_excel_row {
                    679:     my ($worksheet,$row,$col,$response,$student,$prob,$partid,$respid,
                    680:         $format,$resptype) = @_;
                    681:     # 
                    682:     my $submission =$response->[&Apache::loncoursedata::RDs_submission()];
                    683:     $submission = &excel_format_response($submission,$resptype);
                    684:     $worksheet->write($row,$col++,$submission);
                    685:     if ($ENV{'form.correctans'} eq 'true') {
1.26    ! matthew   686:         my $correct = &Apache::lonstathelpers::get_student_answer
1.20      matthew   687:             ($prob,$student->{'username'},$student->{'domain'},
                    688:              $partid,$respid);
                    689:         $correct =&excel_format_response($correct,$resptype);
                    690:         $worksheet->write($row,$col++,$correct);
                    691:     }
                    692:     if ($ENV{'form.prob_status'} eq 'true') {
                    693:         $worksheet->write
                    694:             ($row,$col++,
                    695:              $response->[&Apache::loncoursedata::RDs_awarddetail()]);
                    696:         $worksheet->write
                    697:             ($row,$col++,$response->[&Apache::loncoursedata::RDs_tries()]);
                    698:         $worksheet->write
                    699:             ($row,$col++,
                    700:              &Apache::lonstathelpers::calc_serial
                    701:              ($response->[&Apache::loncoursedata::RDs_timestamp()]),
                    702:              $format->{'date'});
                    703:         $worksheet->write
                    704:             ($row,$col++,$response->[&Apache::loncoursedata::RDs_awarded()]);
                    705:     }
                    706:     return $col;
                    707: }
                    708: 
1.18      matthew   709: sub excel_format_response {
                    710:     my ($answer,$responsetype) = @_;
                    711:     if ($responsetype eq 'radiobutton') {
                    712:         $answer =~ s/=([^=])$//;
1.19      matthew   713:     } elsif ($responsetype =~ /^(option|match)$/) {
1.18      matthew   714:         $answer = join("\n",
                    715:                        map { 
                    716:                            &Apache::lonnet::unescape($_) ;
                    717:                        } sort split('&',$answer)
                    718:                        );
1.25      matthew   719:     } elsif ($responsetype eq 'string') {
                    720:         $answer =~ s/\\(n|r)/\n/g;
                    721:         $answer =~ s/(\s*$|^\s*)//g;
                    722:         $answer =~ s/\\\'/\'/g;
1.1       matthew   723:     }
1.18      matthew   724:     if ($answer =~ m/^=/) {
                    725:         $answer = ' '.$answer;
                    726:     }
                    727:     return $answer;
1.1       matthew   728: }
                    729: 
                    730: #########################################################
                    731: #########################################################
1.17      matthew   732: ##
                    733: ##      CSV output of student answers
                    734: ##
                    735: #########################################################
                    736: #########################################################
                    737: sub prepare_csv_output {
1.22      matthew   738:     my ($r,$problems,$students) = @_;
1.17      matthew   739:     my $c = $r->connection();
                    740:     #
                    741:     $r->print('<h2>'.
                    742:               &mt('Generating CSV report of student responses').'</h2>');
                    743:     #
                    744:     # Progress window
                    745:     my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
                    746:         ($r,'CSV File Compilation Status',
                    747:          'CSV File Compilation Progress', 
1.22      matthew   748:          scalar(@$students),'inline',undef,'Statistics','stats_status');
                    749:     
1.17      matthew   750:     $r->rflush();
                    751:     #
                    752:     # Open a file
                    753:     my $outputfile;
                    754:     my $filename = '/prtspool/'.
                    755:         $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
                    756:             time.'_'.rand(1000000000).'.csv';
                    757:     unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) {
                    758:         $r->log_error("Couldn't open $filename for output $!");
                    759:         $r->print("Problems occured in writing the csv file.  ".
                    760:                   "This error has been logged.  ".
                    761:                   "Please alert your LON-CAPA administrator.");
                    762:         $outputfile = undef;
                    763:     }
                    764:     #
1.22      matthew   765:     # Compute the number of columns per response
                    766:     my @response_headers = ('Submission');
                    767:     if ($ENV{'form.correctans'} eq 'true') {
                    768:         push(@response_headers,'Correct');
                    769:     } 
                    770:     if ($ENV{'form.prob_status'} eq 'true') {
                    771:         push(@response_headers,'Award Detail'); 
                    772:         push(@response_headers,'Time');
                    773:         push(@response_headers,'Attempt');
                    774:         push(@response_headers,'Awarded');
                    775:     }
                    776:     my $response_multiplier = scalar(@response_headers);
                    777:     #
                    778:     # Create the table header
                    779:     my @student_columns = ('username','domain','id');
1.17      matthew   780:     #
1.22      matthew   781:     my %headers;
                    782:     push(@{$headers{'student'}},@student_columns);
                    783:     # Pad for the student data
                    784:     foreach my $row ('problem','part','response') {
                    785:         foreach (@student_columns) {
                    786:             push(@{$headers{$row}},'');
                    787:         }
                    788:     }
                    789:     #
                    790:     # we put the headers into the %headers hash
                    791:     my $prob_start_idx = 0;
                    792:     foreach my $prob (@$problems) {
1.23      matthew   793:         $headers{'problem'}->[$prob_start_idx] = $prob->compTitle;
1.22      matthew   794:         my $part_start_idx = $prob_start_idx;
                    795:         foreach my $partid (@{$prob->parts}) {
1.24      matthew   796:             $headers{'part'}->[$part_start_idx] = $prob->part_display($partid);
1.22      matthew   797:             my $responses = [$prob->responseIds($partid)];
                    798:             for (my $i=0;$i<scalar(@$responses);$i++) {
                    799:                 my $resp_idx = $prob_start_idx + $response_multiplier * $i;
                    800:                 $headers{'response'}->[$resp_idx]=
                    801:                     &mt('Response [_1]',$responses->[$i]);
                    802:                 for (my $j=0;$j<=$#response_headers;$j++) {
                    803:                     $headers{'student'}->[$resp_idx+$j]=$response_headers[$j];
                    804:                 }
1.17      matthew   805:             }
1.22      matthew   806:             $part_start_idx += scalar(@$responses)*$response_multiplier;
1.17      matthew   807:         }
1.22      matthew   808:         $prob_start_idx += $prob->countResponses * $response_multiplier;
1.17      matthew   809:     }
1.22      matthew   810:     foreach my $row ('problem','part','response','student') {
                    811:         print $outputfile '"'.join('","',map { ''; } @student_columns).'","'.
                    812:             join('","',
                    813:                  map { 
                    814:                      &Apache::loncommon::csv_translate($_); 
                    815:                  } @{$headers{$row}}).'"'.$/;
1.17      matthew   816:     }
                    817:     #
1.22      matthew   818:     # Main loop
                    819:     foreach my $student (@$students) {
                    820:         my @rows;
                    821:         my $prob_start_idx = 0;
                    822:         foreach my $prob (@$problems) {
                    823:             my $part_start_idx = 0;
                    824:             foreach my $partid (@{$prob->parts}) {
                    825:                 my @responses = $prob->responseIds($partid);
                    826:                 my @response_type = $prob->responseType($partid);
                    827:                 for (my $i=0;$i<=$#responses;$i++) {
                    828:                     my $resp_start_idx = $response_multiplier * $i;
                    829:                     my $respid   = $responses[$i];
                    830:                     my $results = 
                    831:                         &Apache::loncoursedata::get_response_data_by_student
                    832:                         ($student,$prob->symb(),$respid);
                    833:                     if (! defined($results)) {
                    834:                         $results = [];
                    835:                     }
                    836:                     for (my $j=0; $j<scalar(@$results);$j++) {
                    837:                         if ($ENV{'form.all_sub'} ne 'true') {
                    838:                             next if ($j != 0);
                    839:                         }
                    840:                         my $idx = scalar(@$results) - $j - 1;
                    841:                         my $response = $results->[$idx];
                    842:                         my @data = &compile_response_data($response,$student,
                    843:                                                           $prob,$partid,
                    844:                                                           $respid);
                    845:                         for (my $k=0;$k<=$#data;$k++) {
                    846:                             $rows[$j]->[$prob_start_idx + $part_start_idx +
                    847:                                         $resp_start_idx + $k] = $data[$k];
                    848:                         }
                    849:                     }
                    850:                 }
                    851:                 $part_start_idx += scalar(@responses)*$response_multiplier;
1.17      matthew   852:             }
1.22      matthew   853:             $prob_start_idx += $prob->countResponses * $response_multiplier;
                    854:         }
                    855:         foreach my $row (@rows) {
                    856:             print $outputfile '"'.join('","',
                    857:                                        map { $student->{$_}; }
                    858:                                        @student_columns).'"';
                    859:                                            
                    860:             for (my $i=0;$i<$prob_start_idx;$i++) {
                    861:                 my $value = &Apache::loncommon::csv_translate($row->[$i]);
                    862:                 $value ||='';
                    863:                 print $outputfile ',"'.$value.'"';
1.17      matthew   864:             }
1.22      matthew   865:             print $outputfile $/;
1.17      matthew   866:         }
1.22      matthew   867:         undef(@rows);
1.17      matthew   868:         &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
                    869:                                                  'last student');
                    870:     }
                    871:     close($outputfile);
                    872:     #
                    873:     # Close the progress window
                    874:     &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
                    875:     #
                    876:     # Tell the user where to get their csv file
                    877:     $r->print('<br />'.
                    878:               '<a href="'.$filename.'">'.&mt('Your csv file.').'</a>'."\n");
                    879:     $r->rflush();
                    880:     return;
                    881: }
                    882: 
1.22      matthew   883: sub compile_response_data {
                    884:     my ($response,$student,$prob,$partid,$respid) = @_;
                    885:     my @rowdata;
                    886:     push(@rowdata,$response->[&Apache::loncoursedata::RDs_submission()]);
1.17      matthew   887:     if ($ENV{'form.correctans'} eq 'true') {
1.26    ! matthew   888:         my $correct = &Apache::lonstathelpers::get_student_answer
1.22      matthew   889:             ($prob,$student->{'username'},$student->{'domain'},
                    890:              $partid,$respid);
                    891:         push(@rowdata,$correct);
1.17      matthew   892:     }
1.22      matthew   893:     if ($ENV{'form.prob_status'}) {
                    894:         push(@rowdata,$response->[&Apache::loncoursedata::RDs_awarddetail()]);
                    895:         push(@rowdata,&Apache::lonlocal::locallocaltime
                    896:              ($response->[&Apache::loncoursedata::RDs_timestamp()]));
                    897:         push(@rowdata,$response->[&Apache::loncoursedata::RDs_tries()]);
                    898:         push(@rowdata,$response->[&Apache::loncoursedata::RDs_awarded()]);
1.17      matthew   899:     }
1.22      matthew   900:     return @rowdata;
1.15      matthew   901: }
                    902: 
1.1       matthew   903: #########################################################
                    904: #########################################################
                    905: ##
                    906: ##   Generic Interface Routines
                    907: ##
                    908: #########################################################
                    909: #########################################################
                    910: sub CreateInterface {
                    911:     ##
1.16      matthew   912:     ## Output Selection
1.19      matthew   913:     my $output_selector = $/.'<select name="output">'.$/;
1.22      matthew   914:     foreach ('HTML','Excel','CSV') {
1.19      matthew   915:         $output_selector .= '    <option value="'.lc($_).'"';
1.16      matthew   916:         if ($ENV{'form.output'} eq lc($_)) {
1.19      matthew   917:             $output_selector .= ' selected ';
1.16      matthew   918:         }
1.19      matthew   919:         $output_selector .='>'.&mt($_).'</option>'.$/;
1.16      matthew   920:     } 
1.19      matthew   921:     $output_selector .= '</select>'.$/;
1.16      matthew   922:     ##
1.1       matthew   923:     ## Environment variable initialization
                    924:     my $Str = '';
1.2       matthew   925:     $Str .= &Apache::lonhtmlcommon::breadcrumbs
1.5       matthew   926:         (undef,'Student Submission Reports');
1.11      matthew   927:     $Str .= '<p>';
1.1       matthew   928:     $Str .= '<table cellspacing="5">'."\n";
                    929:     $Str .= '<tr>';
1.16      matthew   930:     $Str .= '<th>'.&mt('Sections').'</th>';
                    931:     $Str .= '<th>'.&mt('Enrollment Status').'</th>';
1.21      matthew   932:     $Str .= '<th>'.&mt('Output as [_1]',$output_selector).'</th>';
1.1       matthew   933:     $Str .= '</tr>'."\n";
1.11      matthew   934:     #
1.1       matthew   935:     $Str .= '<tr><td align="center">'."\n";
                    936:     $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
                    937:     $Str .= '</td>';
                    938:     #
                    939:     $Str .= '<td align="center">';
                    940:     $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5);
                    941:     $Str .= '</td>';
1.6       matthew   942:     #
1.15      matthew   943:     # Render problem checkbox
                    944:     my $prob_checkbox = '<input type="checkbox" name="renderprob" ';
                    945:     if (exists($ENV{'form.renderprob'}) && $ENV{'form.renderprob'} eq 'true') {
                    946:         $prob_checkbox .= 'checked ';
                    947:     }
                    948:     $prob_checkbox .= 'value="true" />';
                    949:     #
                    950:     # Compute correct answers checkbox
                    951:     my $ans_checkbox = '<input type="checkbox" name="correctans" ';
1.13      matthew   952:     if (exists($ENV{'form.correctans'}) && $ENV{'form.correctans'} eq 'true') {
1.15      matthew   953:         $ans_checkbox .= 'checked ';
1.13      matthew   954:     }
1.15      matthew   955:     $ans_checkbox .= 'value="true" />';
                    956:     #
1.19      matthew   957:     # Show all submissions checkbox
                    958:     my $all_sub_checkbox = '<input type="checkbox" name="all_sub" ';
                    959:     if (exists($ENV{'form.all_sub'}) && 
                    960:         $ENV{'form.all_sub'} eq 'true') {
                    961:         $all_sub_checkbox .= 'checked ';
1.15      matthew   962:     }
1.19      matthew   963:     $all_sub_checkbox.= 'value="true" />';
1.15      matthew   964:     #
1.20      matthew   965:     # problem status checkbox
                    966:     my $prob_status_checkbox = '<input type="checkbox" name="prob_status" ';
                    967:     if (exists($ENV{'form.prob_status'}) && 
                    968:         $ENV{'form.prob_status'} eq 'true') {
                    969:         $prob_status_checkbox .= 'checked ';
1.15      matthew   970:     }
1.20      matthew   971:     $prob_status_checkbox .= 'value="true" />';
1.15      matthew   972:     #
1.16      matthew   973:     $Str .= '<td align="right" halign="top">'.
                    974:         '<label><b>'.
1.20      matthew   975:         &mt('Show problem [_1]',$prob_checkbox).'</b></label><br />'.
                    976:         '<label><b>'.
                    977:         &mt('Show correct answers [_1]',$ans_checkbox).'</b></label><br />'.
                    978:         '<label><b>'.
                    979:         &mt('Show all submissions [_1]',$all_sub_checkbox).
                    980:         '</b></label><br />'.
1.15      matthew   981:         '<label><b>'.
1.20      matthew   982:         &mt('Show problem grading [_1]',$prob_status_checkbox).
                    983:         '</b></label><br />'.
1.15      matthew   984:         '</td>';
1.13      matthew   985:     #
1.1       matthew   986:     $Str .= '</tr>'."\n";
                    987:     $Str .= '</table>'."\n";
                    988:     #
1.11      matthew   989:     $Str .= '<nobr>'.&mt('Status: [_1]',
                    990:                          '<input type="text" '.
                    991:                          'name="stats_status" size="60" value="" />').
                    992:             '</nobr>'.'</p>';    
                    993:     ##
1.1       matthew   994:     return $Str;
                    995: }
                    996: 
                    997: 1;
                    998: 
                    999: __END__

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