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