Annotation of loncom/interface/statistics/lonstudentassessment.pm, revision 1.84
1.1 stredwic 1: # The LearningOnline Network with CAPA
2: #
1.84 ! matthew 3: # $Id: lonstudentassessment.pm,v 1.83 2004/02/06 19:29:00 matthew Exp $
1.1 stredwic 4: #
5: # Copyright Michigan State University Board of Trustees
6: #
7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
8: # LON-CAPA is free software; you can redistribute it and/or modify
9: # it under the terms of the GNU General Public License as published by
10: # the Free Software Foundation; either version 2 of the License, or
11: # (at your option) any later version.
12: #
13: # LON-CAPA is distributed in the hope that it will be useful,
14: # but WITHOUT ANY WARRANTY; without even the implied warranty of
15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: # GNU General Public License for more details.
17: #
18: # You should have received a copy of the GNU General Public License
19: # along with LON-CAPA; if not, write to the Free Software
20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21: #
22: # /home/httpd/html/adm/gpl.txt
23: #
24: # http://www.lon-capa.org/
25: #
26: # (Navigate problems for statistical reports
1.28 matthew 27: #
28: #######################################################
29: #######################################################
30:
31: =pod
32:
33: =head1 NAME
34:
35: lonstudentassessment
36:
37: =head1 SYNOPSIS
38:
39: Presents assessment data about a student or a group of students.
40:
41: =head1 Subroutines
42:
43: =over 4
44:
45: =cut
46:
47: #######################################################
48: #######################################################
1.1 stredwic 49:
1.21 minaeibi 50: package Apache::lonstudentassessment;
1.1 stredwic 51:
52: use strict;
1.28 matthew 53: use Apache::lonstatistics;
1.1 stredwic 54: use Apache::lonhtmlcommon;
1.77 matthew 55: use Apache::loncommon();
1.1 stredwic 56: use Apache::loncoursedata;
1.28 matthew 57: use Apache::lonnet; # for logging porpoises
1.75 matthew 58: use Apache::lonlocal;
1.31 matthew 59: use Spreadsheet::WriteExcel;
1.76 matthew 60: use Spreadsheet::WriteExcel::Utility();
1.31 matthew 61:
62: #######################################################
63: #######################################################
64: =pod
65:
66: =item Package Variables
67:
68: =over 4
69:
70: =item $Statistics Hash ref to store student data. Indexed by symb,
71: contains hashes with keys 'score' and 'max'.
72:
73: =cut
74:
75: #######################################################
76: #######################################################
1.1 stredwic 77:
1.30 matthew 78: my $Statistics;
79:
1.28 matthew 80: #######################################################
81: #######################################################
82:
83: =pod
84:
1.31 matthew 85: =item $show_links 'yes' or 'no' for linking to student performance data
86:
87: =item $output_mode 'html', 'excel', or 'csv' for output mode
88:
1.32 matthew 89: =item $show 'all', 'totals', or 'scores' determines how much data is output
1.31 matthew 90:
1.54 matthew 91: =item $data determines what performance data is shown
92:
93: =item $datadescription A short description of the output data selected.
94:
95: =item $base 'tries' or 'scores' determines the base of the performance shown
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.54 matthew 106: my $data;
107: my $base;
108: my $datadescription;
1.49 matthew 109: my $single_student_mode;
1.28 matthew 110:
1.31 matthew 111: #######################################################
112: #######################################################
113: # End of package variable declarations
1.28 matthew 114:
1.31 matthew 115: =pod
1.28 matthew 116:
1.31 matthew 117: =back
1.28 matthew 118:
1.31 matthew 119: =cut
1.28 matthew 120:
1.31 matthew 121: #######################################################
122: #######################################################
1.28 matthew 123:
1.31 matthew 124: =pod
1.28 matthew 125:
1.31 matthew 126: =item &BuildStudentAssessmentPage()
1.28 matthew 127:
1.31 matthew 128: Inputs:
1.4 stredwic 129:
1.31 matthew 130: =over 4
1.28 matthew 131:
132: =item $r Apache Request
133:
134: =item $c Apache Connection
135:
136: =back
137:
138: =cut
139:
140: #######################################################
141: #######################################################
1.1 stredwic 142: sub BuildStudentAssessmentPage {
1.30 matthew 143: my ($r,$c)=@_;
1.74 matthew 144: #
1.30 matthew 145: undef($Statistics);
1.66 matthew 146: undef($show_links);
147: undef($output_mode);
148: undef($data);
149: undef($base);
150: undef($datadescription);
151: undef($single_student_mode);
1.74 matthew 152: #
153: my %Saveable_Parameters = ('Status' => 'scalar',
154: 'chartoutputmode' => 'scalar',
155: 'chartoutputdata' => 'scalar',
156: 'Section' => 'array',
157: 'StudentData' => 'array',
158: 'Maps' => 'array');
159: &Apache::loncommon::store_course_settings('chart',\%Saveable_Parameters);
160: &Apache::loncommon::restore_course_settings('chart',\%Saveable_Parameters);
161: #
162: &Apache::lonstatistics::PrepareClasslist();
163: #
1.65 matthew 164: $single_student_mode = 0;
1.49 matthew 165: $single_student_mode = 1 if ($ENV{'form.SelectedStudent'});
1.59 matthew 166: if ($ENV{'form.selectstudent'}) {
167: &Apache::lonstatistics::DisplayClasslist($r);
168: return;
169: }
1.30 matthew 170: #
1.31 matthew 171: # Print out the HTML headers for the interface
172: # This also parses the output mode selector
1.54 matthew 173: # This step must *always* be done.
1.30 matthew 174: $r->print(&CreateInterface());
1.31 matthew 175: $r->print('<input type="hidden" name="notfirstrun" value="true" />');
1.49 matthew 176: $r->print('<input type="hidden" name="sort" value="'.
177: $ENV{'form.sort'}.'" />');
1.7 stredwic 178: $r->rflush();
1.58 matthew 179: #
1.49 matthew 180: if (! exists($ENV{'form.notfirstrun'}) && ! $single_student_mode) {
1.31 matthew 181: return;
182: }
183: #
184: my $initialize = \&html_initialize;
185: my $output_student = \&html_outputstudent;
186: my $finish = \&html_finish;
187: #
188: if ($output_mode eq 'excel') {
189: $initialize = \&excel_initialize;
190: $output_student = \&excel_outputstudent;
191: $finish = \&excel_finish;
192: } elsif ($output_mode eq 'csv') {
193: $initialize = \&csv_initialize;
194: $output_student = \&csv_outputstudent;
195: $finish = \&csv_finish;
196: }
1.30 matthew 197: #
198: if($c->aborted()) { return ; }
1.31 matthew 199: #
1.49 matthew 200: # Determine which students we want to look at
201: my @Students;
202: if ($single_student_mode) {
203: @Students = (&Apache::lonstatistics::current_student());
204: $r->print(&next_and_previous_buttons());
205: $r->rflush();
206: } else {
207: @Students = @Apache::lonstatistics::Students;
208: }
1.56 matthew 209: #
210: # Perform generic initialization tasks
211: # Since we use lonnet::EXT to retrieve problem weights,
212: # to ensure current data we must clear the caches out.
213: # This makes sure that parameter changes at the student level
214: # are immediately reflected in the chart.
215: &Apache::lonnet::clear_EXT_cache_status();
1.69 matthew 216: #
217: # Clean out loncoursedata's package data, just to be safe.
218: &Apache::loncoursedata::clear_internal_caches();
1.49 matthew 219: #
1.31 matthew 220: # Call the initialize routine selected above
221: $initialize->($r);
1.49 matthew 222: foreach my $student (@Students) {
1.31 matthew 223: if($c->aborted()) {
224: $finish->($r);
225: return ;
1.1 stredwic 226: }
1.31 matthew 227: # Call the output_student routine selected above
228: $output_student->($r,$student);
229: }
230: # Call the "finish" routine selected above
231: $finish->($r);
232: #
233: return;
234: }
235:
236: #######################################################
237: #######################################################
1.49 matthew 238: sub next_and_previous_buttons {
239: my $Str = '';
240: $Str .= '<input type="hidden" name="SelectedStudent" value="'.
241: $ENV{'form.SelectedStudent'}.'" />';
242: #
243: # Build the previous student link
244: my $previous = &Apache::lonstatistics::previous_student();
245: my $previousbutton = '';
246: if (defined($previous)) {
247: my $sname = $previous->{'username'}.':'.$previous->{'domain'};
248: $previousbutton .= '<input type="button" value="'.
249: 'Previous Student ('.
250: $previous->{'username'}.'@'.$previous->{'domain'}.')'.
251: '" onclick="document.Statistics.SelectedStudent.value='.
252: "'".$sname."'".';'.
253: 'document.Statistics.submit();" />';
254: } else {
255: $previousbutton .= '<input type="button" value="'.
256: 'Previous student (none)'.'" />';
257: }
258: #
259: # Build the next student link
260: my $next = &Apache::lonstatistics::next_student();
261: my $nextbutton = '';
262: if (defined($next)) {
263: my $sname = $next->{'username'}.':'.$next->{'domain'};
264: $nextbutton .= '<input type="button" value="'.
265: 'Next Student ('.
266: $next->{'username'}.'@'.$next->{'domain'}.')'.
267: '" onclick="document.Statistics.SelectedStudent.value='.
268: "'".$sname."'".';'.
269: 'document.Statistics.submit();" />';
270: } else {
271: $nextbutton .= '<input type="button" value="'.
272: 'Next student (none)'.'" />';
273: }
274: #
275: # Build the 'all students' button
276: my $all = '';
277: $all .= '<input type="button" value="All Students" '.
278: '" onclick="document.Statistics.SelectedStudent.value='.
279: "''".';'.'document.Statistics.submit();" />';
280: $Str .= $previousbutton.(' 'x5).$all.(' 'x5).$nextbutton;
281: return $Str;
282: }
283:
284: #######################################################
285: #######################################################
1.30 matthew 286:
1.31 matthew 287: sub get_student_fields_to_show {
288: my @to_show = @Apache::lonstatistics::SelectedStudentData;
289: foreach (@to_show) {
290: if ($_ eq 'all') {
291: @to_show = @Apache::lonstatistics::StudentDataOrder;
292: last;
293: }
294: }
295: return @to_show;
296: }
297:
1.28 matthew 298: #######################################################
299: #######################################################
300:
301: =pod
1.2 stredwic 302:
1.28 matthew 303: =item &CreateInterface()
1.21 minaeibi 304:
1.28 matthew 305: Called by &BuildStudentAssessmentPage to create the top part of the
306: page which displays the chart.
307:
1.30 matthew 308: Inputs: None
1.28 matthew 309:
310: Returns: A string containing the HTML for the headers and top table for
311: the chart page.
312:
313: =cut
314:
315: #######################################################
316: #######################################################
1.2 stredwic 317: sub CreateInterface {
1.4 stredwic 318: my $Str = '';
1.30 matthew 319: # $Str .= &CreateLegend();
320: $Str .= '<table cellspacing="5">'."\n";
321: $Str .= '<tr>';
1.75 matthew 322: $Str .= '<td align="center"><b>'.&mt('Sections').'</b></td>';
323: $Str .= '<td align="center"><b>'.&mt('Student Data</b>').'</td>';
324: $Str .= '<td align="center"><b>'.&mt('Enrollment Status').'</b></td>';
325: $Str .= '<td align="center"><b>'.&mt('Sequences and Folders').'</b></td>';
326: $Str .= '<td align="center"><b>'.&mt('Output Format').'</b>'.
1.58 matthew 327: &Apache::loncommon::help_open_topic("Chart_Output_Formats").
328: '</td>';
1.75 matthew 329: $Str .= '<td align="center"><b>'.&mt('Output Data').'</b>'.
1.58 matthew 330: &Apache::loncommon::help_open_topic("Chart_Output_Data").
331: '</td>';
1.30 matthew 332: $Str .= '</tr>'."\n";
333: #
1.4 stredwic 334: $Str .= '<tr><td align="center">'."\n";
1.29 matthew 335: $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5);
1.4 stredwic 336: $Str .= '</td><td align="center">';
1.30 matthew 337: my $only_seq_with_assessments = sub {
338: my $s=shift;
339: if ($s->{'num_assess'} < 1) {
340: return 0;
341: } else {
342: return 1;
343: }
344: };
345: $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple',
346: 5,undef);
1.46 matthew 347: $Str .= '</td><td>'."\n";
348: $Str .= &Apache::lonhtmlcommon::StatusOptions(undef,undef,5);
1.4 stredwic 349: $Str .= '</td><td>'."\n";
1.30 matthew 350: $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5,
351: $only_seq_with_assessments);
1.31 matthew 352: $Str .= '</td><td>'."\n";
353: $Str .= &CreateAndParseOutputSelector();
1.54 matthew 354: $Str .= '</td><td>'."\n";
355: $Str .= &CreateAndParseOutputDataSelector();
1.30 matthew 356: $Str .= '</td></tr>'."\n";
357: $Str .= '</table>'."\n";
1.75 matthew 358: $Str .= '<input type="submit" name="Generate Chart" value="'.
359: &mt('Generate Chart').'" />';
1.59 matthew 360: $Str .= ' 'x5;
1.75 matthew 361: $Str .= '<input type="submit" name="selectstudent" value="'.
362: &mt('Select One Student').'" />';
1.59 matthew 363: $Str .= ' 'x5;
1.75 matthew 364: $Str .= '<input type="submit" name="ClearCache" value="'.
365: &mt('Clear Caches').'" />';
1.61 www 366: $Str .= ' 'x5;
367: $Str .= '<br />';
1.4 stredwic 368: return $Str;
1.1 stredwic 369: }
1.30 matthew 370:
371: #######################################################
372: #######################################################
373:
374: =pod
375:
1.31 matthew 376: =item &CreateAndParseOutputSelector()
1.30 matthew 377:
378: =cut
379:
380: #######################################################
381: #######################################################
1.32 matthew 382: my @OutputOptions =
383: ({ name => 'HTML, with links',
384: value => 'html, with links',
1.33 matthew 385: description => 'Output HTML with each symbol linked to the problem '.
1.35 matthew 386: 'which generated it.',
387: mode => 'html',
388: show_links => 'yes',
389: },
1.47 matthew 390: { name => 'HTML, with all links',
391: value => 'html, with all links',
392: description => 'Output HTML with each symbol linked to the problem '.
393: 'which generated it. '.
394: 'This includes links for unattempted problems.',
395: mode => 'html',
396: show_links => 'all',
397: },
1.32 matthew 398: { name => 'HTML, without links',
399: value => 'html, without links',
1.33 matthew 400: description => 'Output HTML. By not including links, the size of the'.
401: ' web page is greatly reduced. If your browser crashes on the '.
1.35 matthew 402: 'full display, try this.',
403: mode => 'html',
404: show_links => 'no',
405: },
1.54 matthew 406: { name => 'Excel',
407: value => 'excel',
408: description => 'Output an Excel file (compatable with Excel 95).',
1.35 matthew 409: mode => 'excel',
410: show_links => 'no',
1.54 matthew 411: },
412: { name => 'CSV',
413: value => 'csv',
414: description => 'Output a comma seperated values file suitable for '.
1.57 matthew 415: 'import into a spreadsheet program. Using this method as opposed '.
416: 'to Excel output allows you to organize your data before importing'.
417: ' it into a spreadsheet program.',
1.35 matthew 418: mode => 'csv',
419: show_links => 'no',
420: },
1.32 matthew 421: );
422:
1.33 matthew 423: sub OutputDescriptions {
424: my $Str = '';
1.58 matthew 425: $Str .= "<h2>Output Formats</h2>\n";
1.33 matthew 426: $Str .= "<dl>\n";
427: foreach my $outputmode (@OutputOptions) {
428: $Str .=" <dt>".$outputmode->{'name'}."</dt>\n";
429: $Str .=" <dd>".$outputmode->{'description'}."</dd>\n";
430: }
431: $Str .= "</dl>\n";
432: return $Str;
433: }
434:
1.31 matthew 435: sub CreateAndParseOutputSelector {
436: my $Str = '';
1.44 matthew 437: my $elementname = 'chartoutputmode';
1.73 matthew 438: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
439: [$elementname]);
1.31 matthew 440: #
441: # Format for output options is 'mode, restrictions';
1.50 matthew 442: my $selected = 'html, without links';
1.31 matthew 443: if (exists($ENV{'form.'.$elementname})) {
444: if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
445: $selected = $ENV{'form.'.$elementname}->[0];
446: } else {
447: $selected = $ENV{'form.'.$elementname};
448: }
449: }
450: #
451: # Set package variables describing output mode
452: $show_links = 'no';
453: $output_mode = 'html';
1.35 matthew 454: foreach my $option (@OutputOptions) {
455: next if ($option->{'value'} ne $selected);
456: $output_mode = $option->{'mode'};
457: $show_links = $option->{'show_links'};
1.31 matthew 458: }
1.35 matthew 459:
1.31 matthew 460: #
461: # Build the form element
462: $Str = qq/<select size="5" name="$elementname">/;
1.32 matthew 463: foreach my $option (@OutputOptions) {
464: $Str .= "\n".' <option value="'.$option->{'value'}.'"';
465: $Str .= " selected " if ($option->{'value'} eq $selected);
1.75 matthew 466: $Str .= ">".&mt($option->{'name'})."<\/option>";
1.31 matthew 467: }
468: $Str .= "\n</select>";
469: return $Str;
470: }
1.30 matthew 471:
1.54 matthew 472: ##
473: ## Data selector stuff
474: ##
475: my @OutputDataOptions =
1.57 matthew 476: (
1.72 matthew 477: { name => 'Scores Summary',
1.57 matthew 478: base => 'scores',
479: value => 'sum and total',
480: shortdesc => 'Total Score and Maximum Possible for each '.
481: 'Sequence or Folder',
482: longdesc => 'The score of each student as well as the '.
483: ' maximum possible on each Sequence or Folder.',
484: },
1.71 matthew 485: { name => 'Scores Per Problem',
1.57 matthew 486: base => 'scores',
1.71 matthew 487: value => 'scores',
488: shortdesc => 'Score on each Problem Part',
489: longdesc =>'The students score on each problem part, computed as'.
490: 'the part weight * part awarded',
1.57 matthew 491: },
1.71 matthew 492: # { name => 'Scores Sum',
493: # base => 'scores',
494: # value => 'sum only',
495: # shortdesc => 'Sum of Scores on each Problem Part',
496: # longdesc =>'The total of the scores of the student on each problem'.
497: # ' part in the sequences or folders selected.',
498: # },
499: # { name => 'Scores Summary Table Only',
500: # base => 'scores',
501: # value => 'final table scores',
502: # shortdesc => 'Summary of Scores',
503: # longdesc => 'The average score on each sequence or folder for the '.
504: # 'selected students.',
505: # },
1.57 matthew 506: { name =>'Tries',
507: base =>'tries',
508: value => 'tries',
509: shortdesc => 'Number of Tries before success on each Problem Part',
510: longdesc =>'The number of tries before success on each problem part.',
511: },
512: { name =>'Parts Correct',
513: base =>'tries',
514: value => 'parts correct total',
515: shortdesc => 'Number of Problem Parts completed successfully.',
516: longdesc => 'The Number of Problem Parts completed successfully and '.
517: 'the maximum possible for each student',
518: },
1.71 matthew 519: # { name =>'Parts Correct',
520: # base =>'tries',
521: # value => 'parts correct',
522: # shortdesc => 'Number of Problem Parts completed successfully.',
523: # longdesc => 'The Number of Problem Parts completed successfully'.
524: # ' on each sequence or folder.',
525: # },
526: # { name => 'Parts Summary Table Only',
527: # base => 'tries',
528: # value => 'final table parts',
529: # shortdesc => 'Summary of Parts Correct',
530: # longdesc => 'A summary table of the average number of problem parts '.
531: # 'students were able to get correct on each sequence.',
532: # },
1.57 matthew 533: );
534:
535: sub HTMLifyOutputDataDescriptions {
536: my $Str = '';
1.58 matthew 537: $Str .= "<h2>Output Data</h2>\n";
1.57 matthew 538: $Str .= "<dl>\n";
539: foreach my $option (@OutputDataOptions) {
540: $Str .= ' <dt>'.$option->{'name'}.'</dt>';
541: $Str .= '<dd>'.$option->{'longdesc'}.'</dd>'."\n";
542: }
543: $Str .= "</dl>\n";
544: return $Str;
545: }
1.54 matthew 546:
547: sub CreateAndParseOutputDataSelector {
548: my $Str = '';
549: my $elementname = 'chartoutputdata';
550: #
551: my $selected = 'scores';
552: if (exists($ENV{'form.'.$elementname})) {
553: if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) {
554: $selected = $ENV{'form.'.$elementname}->[0];
555: } else {
556: $selected = $ENV{'form.'.$elementname};
557: }
558: }
559: #
560: $data = 'scores';
561: foreach my $option (@OutputDataOptions) {
562: if ($option->{'value'} eq $selected) {
563: $data = $option->{'value'};
564: $base = $option->{'base'};
565: $datadescription = $option->{'shortdesc'};
566: }
567: }
568: #
569: # Build the form element
570: $Str = qq/<select size="5" name="$elementname">/;
571: foreach my $option (@OutputDataOptions) {
572: $Str .= "\n".' <option value="'.$option->{'value'}.'"';
573: $Str .= " selected " if ($option->{'value'} eq $data);
1.75 matthew 574: $Str .= ">".&mt($option->{'name'})."<\/option>";
1.54 matthew 575: }
576: $Str .= "\n</select>";
577: return $Str;
578:
579: }
580:
1.28 matthew 581: #######################################################
582: #######################################################
1.1 stredwic 583:
1.28 matthew 584: =pod
585:
1.31 matthew 586: =head2 HTML output routines
1.28 matthew 587:
1.31 matthew 588: =item &html_initialize($r)
1.28 matthew 589:
1.31 matthew 590: Create labels for the columns of student data to show.
1.28 matthew 591:
1.31 matthew 592: =item &html_outputstudent($r,$student)
1.28 matthew 593:
1.31 matthew 594: Return a line of the chart for a student.
1.28 matthew 595:
1.31 matthew 596: =item &html_finish($r)
1.28 matthew 597:
598: =cut
599:
600: #######################################################
601: #######################################################
1.31 matthew 602: {
603: my $padding;
604: my $count;
605:
1.39 matthew 606: my $nodata_count; # The number of students for which there is no data
607: my %prog_state; # progress state used by loncommon PrgWin routines
608:
1.31 matthew 609: sub html_initialize {
610: my ($r) = @_;
1.30 matthew 611: #
612: $padding = ' 'x3;
1.35 matthew 613: $count = 0;
1.39 matthew 614: $nodata_count = 0;
1.66 matthew 615: undef(%prog_state);
1.30 matthew 616: #
1.38 matthew 617: $r->print("<h3>".$ENV{'course.'.$ENV{'request.course.id'}.'.description'}.
618: " ".localtime(time)."</h3>");
1.39 matthew 619:
1.55 matthew 620: if ($data !~ /^final table/) {
621: $r->print("<h3>".$datadescription."</h3>");
622: }
1.39 matthew 623: #
624: # Set up progress window for 'final table' display only
1.54 matthew 625: if ($data =~ /^final table/) {
1.39 matthew 626: my $studentcount = scalar(@Apache::lonstatistics::Students);
627: %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
628: ($r,'Summary Table Status',
629: 'Summary Table Compilation Progress', $studentcount);
630: }
1.31 matthew 631: my $Str = "<pre>\n";
1.30 matthew 632: # First, the @StudentData fields need to be listed
1.31 matthew 633: my @to_show = &get_student_fields_to_show();
1.30 matthew 634: foreach my $field (@to_show) {
635: my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
636: my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
637: my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
638: $Str .= $title.' 'x($width-$base).$padding;
639: }
640: # Now the selected sequences need to be listed
1.40 matthew 641: foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()){
1.31 matthew 642: my $title = $sequence->{'title'};
643: my $base = $sequence->{'base_width'};
644: my $width = $sequence->{'width'};
645: $Str .= $title.' 'x($width-$base).$padding;
1.30 matthew 646: }
1.54 matthew 647: $Str .= "total</pre>\n";
1.31 matthew 648: $Str .= "<pre>";
1.39 matthew 649: #
650: # Check for suppression of output
1.54 matthew 651: if ($data =~ /^final table/) {
1.39 matthew 652: $Str = '';
653: }
1.31 matthew 654: $r->print($Str);
655: $r->rflush();
656: return;
1.30 matthew 657: }
658:
1.31 matthew 659: sub html_outputstudent {
660: my ($r,$student) = @_;
1.2 stredwic 661: my $Str = '';
1.35 matthew 662: #
1.55 matthew 663: if($count++ % 5 == 0 && $count > 0 && $data !~ /^final table/) {
1.35 matthew 664: $r->print("</pre><pre>");
665: }
1.30 matthew 666: # First, the @StudentData fields need to be listed
1.31 matthew 667: my @to_show = &get_student_fields_to_show();
1.30 matthew 668: foreach my $field (@to_show) {
669: my $title=$student->{$field};
1.31 matthew 670: my $base = length($title);
1.30 matthew 671: my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
672: $Str .= $title.' 'x($width-$base).$padding;
673: }
674: # Get ALL the students data
675: my %StudentsData;
676: my @tmp = &Apache::loncoursedata::get_current_state
677: ($student->{'username'},$student->{'domain'},undef,
678: $ENV{'request.course.id'});
679: if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
680: %StudentsData = @tmp;
681: }
682: if (scalar(@tmp) < 1) {
1.39 matthew 683: $nodata_count++;
1.54 matthew 684: return if ($data =~ /^final table/);
1.30 matthew 685: $Str .= '<font color="blue">No Course Data</font>'."\n";
1.31 matthew 686: $r->print($Str);
687: $r->rflush();
688: return;
1.30 matthew 689: }
690: #
691: # By sequence build up the data
692: my $studentstats;
1.31 matthew 693: my $PerformanceStr = '';
1.40 matthew 694: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.54 matthew 695: my ($performance,$performance_length,$score,$seq_max,$rawdata);
696: if ($base eq 'tries') {
697: ($performance,$performance_length,$score,$seq_max,$rawdata) =
698: &StudentTriesOnSequence($student,\%StudentsData,
699: $seq,$show_links);
700: } else {
701: ($performance,$performance_length,$score,$seq_max,$rawdata) =
702: &StudentPerformanceOnSequence($student,\%StudentsData,
703: $seq,$show_links);
704: }
705: my $ratio = sprintf("%3d",$score).'/'.sprintf("%3d",$seq_max);
1.31 matthew 706: #
1.54 matthew 707: if ($data eq 'sum and total' || $data eq 'parts correct total') {
708: $performance = $ratio;
709: $performance .= ' 'x($seq->{'width'}-length($ratio));
710: } elsif ($data eq 'sum only' || $data eq 'parts correct') {
711: $performance = $score;
712: $performance .= ' 'x($seq->{'width'}-length($score));
1.31 matthew 713: } else {
714: # Pad with extra spaces
1.51 matthew 715: $performance .= ' 'x($seq->{'width'}-$performance_length-
1.31 matthew 716: length($ratio)
717: ).$ratio;
1.30 matthew 718: }
1.31 matthew 719: #
720: $Str .= $performance.$padding;
721: #
722: $studentstats->{$seq->{'symb'}}->{'score'}= $score;
723: $studentstats->{$seq->{'symb'}}->{'max'} = $seq_max;
1.30 matthew 724: }
725: #
726: # Total it up and store the statistics info.
727: my ($score,$max) = (0,0);
728: while (my ($symb,$seq_stats) = each (%{$studentstats})) {
729: $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
1.54 matthew 730: if ($Statistics->{$symb}->{'max'} < $seq_stats->{'max'}) {
731: $Statistics->{$symb}->{'max'} = $seq_stats->{'max'};
732: }
1.30 matthew 733: $score += $seq_stats->{'score'};
734: $max += $seq_stats->{'max'};
735: }
1.31 matthew 736: $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
1.30 matthew 737: $Str .= " \n";
1.39 matthew 738: #
739: # Check for suppressed output and update the progress window if so...
1.54 matthew 740: if ($data =~ /^final table/) {
1.39 matthew 741: $Str = '';
742: &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
743: 'last student');
744: }
745: #
1.31 matthew 746: $r->print($Str);
747: #
748: $r->rflush();
749: return;
1.30 matthew 750: }
1.2 stredwic 751:
1.31 matthew 752: sub html_finish {
753: my ($r) = @_;
1.39 matthew 754: #
755: # Check for suppressed output and close the progress window if so
1.54 matthew 756: if ($data =~ /^final table/) {
1.39 matthew 757: &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
758: } else {
759: $r->print("</pre>\n");
760: }
1.49 matthew 761: if ($single_student_mode) {
762: $r->print(&SingleStudentTotal());
763: } else {
764: $r->print(&StudentAverageTotal());
765: }
1.31 matthew 766: $r->rflush();
767: return;
768: }
769:
1.39 matthew 770: sub StudentAverageTotal {
771: my $Str = "<h3>Summary Tables</h3>\n";
772: my $num_students = scalar(@Apache::lonstatistics::Students);
773: my $total_ave = 0;
774: my $total_max = 0;
775: $Str .= '<table border=2 cellspacing="1">'."\n";
776: $Str .= "<tr><th>Title</th><th>Average</th><th>Maximum</th></tr>\n";
1.40 matthew 777: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.42 matthew 778: my $ave;
779: if ($num_students > $nodata_count) {
780: $ave = int(100*($Statistics->{$seq->{'symb'}}->{'score'}/
781: ($num_students-$nodata_count)))/100;
782: } else {
783: $ave = 0;
784: }
1.39 matthew 785: $total_ave += $ave;
1.54 matthew 786: my $max = $Statistics->{$seq->{'symb'}}->{'max'};
1.39 matthew 787: $total_max += $max;
1.82 matthew 788: $ave = sprintf("%.2f",$ave);
1.39 matthew 789: $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
1.82 matthew 790: '<td align="right">'.$ave.' </td>'.
791: '<td align="right">'.$max.' '.'</td></tr>'."\n";
1.39 matthew 792: }
1.82 matthew 793: $total_ave = sprintf('%.2f',$total_ave); # only two digit
1.39 matthew 794: $Str .= "</table>\n";
795: $Str .= '<table border=2 cellspacing="1">'."\n";
796: $Str .= '<tr><th>Number of Students</th><th>Average</th>'.
797: "<th>Maximum</th></tr>\n";
1.82 matthew 798: $Str .= '<tr>'.
799: '<td align="right">'.($num_students-$nodata_count).'</td>'.
800: '<td align="right">'.$total_ave.' '.'</td>'.
801: '<td align="right">'.$total_max.' '.'</td>';
1.39 matthew 802: $Str .= "</table>\n";
803: return $Str;
804: }
805:
1.49 matthew 806: sub SingleStudentTotal {
807: my $student = &Apache::lonstatistics::current_student();
1.52 matthew 808: my $Str = "<h3>Summary table for ".$student->{'fullname'}." ".
809: $student->{'username'}.'@'.$student->{'domain'}."</h3>\n";
1.49 matthew 810: $Str .= '<table border=2 cellspacing="1">'."\n";
811: $Str .=
812: "<tr><th>Sequence or Folder</th><th>Score</th><th>Maximum</th></tr>\n";
813: my $total = 0;
814: my $total_max = 0;
815: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
816: my $value = $Statistics->{$seq->{'symb'}}->{'score'};
817: my $max = $Statistics->{$seq->{'symb'}}->{'max'};
818: $Str .= '<tr><td>'.$seq->{'title'}.'</td>'.
819: '<td align="right">'.$value.'</td>'.
820: '<td align="right">'.$max.'</td></tr>'."\n";
821: $total += $value;
822: $total_max +=$max;
823: }
824: $Str .= '<tr><td><b>Total</b></td>'.
825: '<td align="right">'.$total.'</td>'.
826: '<td align="right">'.$total_max."</td></tr>\n";
827: $Str .= "</table>\n";
828: return $Str;
829: }
830:
1.31 matthew 831: }
832:
833: #######################################################
834: #######################################################
835:
836: =pod
837:
838: =head2 EXCEL subroutines
839:
840: =item &excel_initialize($r)
841:
842: =item &excel_outputstudent($r,$student)
843:
844: =item &excel_finish($r)
845:
846: =cut
847:
848: #######################################################
849: #######################################################
850: {
851:
852: my $excel_sheet;
1.32 matthew 853: my $excel_workbook;
854:
855: my $filename;
856: my $rows_output;
857: my $cols_output;
858:
1.36 matthew 859: my %prog_state; # progress window state
1.54 matthew 860: my $request_aborted;
1.31 matthew 861:
1.76 matthew 862: my $total_formula;
863:
1.31 matthew 864: sub excel_initialize {
865: my ($r) = @_;
866: #
1.66 matthew 867: undef ($excel_sheet);
868: undef ($excel_workbook);
869: undef ($filename);
870: undef ($rows_output);
871: undef ($cols_output);
872: undef (%prog_state);
873: undef ($request_aborted);
1.76 matthew 874: undef ($total_formula);
1.66 matthew 875: #
1.54 matthew 876: my $total_columns = scalar(&get_student_fields_to_show());
877: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
878: # Add 2 because we need a 'sum' and 'total' column for each
879: $total_columns += $seq->{'num_assess_parts'}+2;
880: }
881: if ($data eq 'tries' && $total_columns > 255) {
882: $r->print(<<END);
883: <h2>Unable to Complete Request</h2>
884: <p>
885: LON-CAPA is unable to produce your Excel spreadsheet because your selections
886: will result in more than 255 columns. Excel allows only 255 columns in a
887: spreadsheet.
888: </p><p>
889: You may consider reducing the number of <b>Sequences or Folders</b> you
890: have selected.
891: </p><p>
892: LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the
893: summary data (<b>Parts Correct</b> or <b>Parts Correct & Totals</b>).
894: </p>
895: END
896: $request_aborted = 1;
897: }
898: if ($data eq 'scores' && $total_columns > 255) {
899: $r->print(<<END);
900: <h2>Unable to Complete Request</h2>
901: <p>
902: LON-CAPA is unable to produce your Excel spreadsheet because your selections
903: will result in more than 255 columns. Excel allows only 255 columns in a
904: spreadsheet.
905: </p><p>
906: You may consider reducing the number of <b>Sequences or Folders</b> you
907: have selected.
908: </p><p>
909: LON-CAPA can produce <b>CSV</b> files of this data or Excel files of the
1.80 matthew 910: <b>Scores Summary</b> data.
1.54 matthew 911: </p>
912: END
913: $request_aborted = 1;
914: }
915: if ($data =~ /^final table/) {
916: $r->print(<<END);
917: <h2>Unable to Complete Request</h2>
918: <p>
919: The <b>Summary Table (Scores)</b> option is not available for non-HTML output.
920: </p>
921: END
922: $request_aborted = 1;
923: }
924: return if ($request_aborted);
925: #
1.32 matthew 926: $filename = '/prtspool/'.
1.31 matthew 927: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
928: time.'_'.rand(1000000000).'.xls';
1.32 matthew 929: #
930: $excel_workbook = undef;
931: $excel_sheet = undef;
932: #
933: $rows_output = 0;
934: $cols_output = 0;
935: #
936: # Create sheet
937: $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
938: #
939: # Check for errors
940: if (! defined($excel_workbook)) {
1.31 matthew 941: $r->log_error("Error creating excel spreadsheet $filename: $!");
942: $r->print("Problems creating new Excel file. ".
943: "This error has been logged. ".
944: "Please alert your LON-CAPA administrator");
1.32 matthew 945: return ;
1.31 matthew 946: }
947: #
948: # The excel spreadsheet stores temporary data in files, then put them
949: # together. If needed we should be able to disable this (memory only).
950: # The temporary directory must be specified before calling 'addworksheet'.
951: # File::Temp is used to determine the temporary directory.
1.32 matthew 952: $excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
953: #
954: # Add a worksheet
1.33 matthew 955: my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1.67 matthew 956: $sheetname = &Apache::loncommon::clean_excel_name($sheetname);
1.33 matthew 957: $excel_sheet = $excel_workbook->addworksheet($sheetname);
1.32 matthew 958: #
1.34 matthew 959: # Put the course description in the header
960: $excel_sheet->write($rows_output,$cols_output++,
961: $ENV{'course.'.$ENV{'request.course.id'}.'.description'});
962: $cols_output += 3;
963: #
964: # Put a description of the sections listed
965: my $sectionstring = '';
966: my @Sections = @Apache::lonstatistics::SelectedSections;
967: if (scalar(@Sections) > 1) {
968: if (scalar(@Sections) > 2) {
969: my $last = pop(@Sections);
970: $sectionstring = "Sections ".join(', ',@Sections).', and '.$last;
971: } else {
972: $sectionstring = "Sections ".join(' and ',@Sections);
973: }
974: } else {
975: if ($Sections[0] eq 'all') {
976: $sectionstring = "All sections";
977: } else {
978: $sectionstring = "Section ".$Sections[0];
979: }
980: }
981: $excel_sheet->write($rows_output,$cols_output++,$sectionstring);
982: $cols_output += scalar(@Sections);
983: #
984: # Put the date in there too
1.54 matthew 985: $excel_sheet->write($rows_output++,$cols_output++,
1.34 matthew 986: 'Compiled on '.localtime(time));
987: #
1.54 matthew 988: $cols_output = 0;
989: $excel_sheet->write($rows_output++,$cols_output++,$datadescription);
990: #
991: if ($data eq 'tries' || $data eq 'scores') {
992: $rows_output++;
993: }
1.34 matthew 994: #
1.32 matthew 995: # Add the student headers
1.34 matthew 996: $cols_output = 0;
1.32 matthew 997: foreach my $field (&get_student_fields_to_show()) {
1.34 matthew 998: $excel_sheet->write($rows_output,$cols_output++,$field);
1.32 matthew 999: }
1.54 matthew 1000: my $row_offset = 0;
1001: if ($data eq 'tries' || $data eq 'scores') {
1002: $row_offset = -1;
1003: }
1.32 matthew 1004: #
1.54 matthew 1005: # Add the remaining column headers
1.76 matthew 1006: my $total_formula_string = '=0';
1.40 matthew 1007: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.54 matthew 1008: $excel_sheet->write($rows_output+$row_offset,
1009: $cols_output,$seq->{'title'});
1010: if ($data eq 'tries' || $data eq 'scores') {
1.76 matthew 1011: # Determine starting cell
1012: $seq->{'Excel:startcell'}=
1013: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1014: ($rows_output,$cols_output);
1015: $seq->{'Excel:startcol'}=$cols_output;
1016: # Put the names of the problems and parts into the sheet
1.82 matthew 1017: my $count = 0;
1.54 matthew 1018: foreach my $res (@{$seq->{'contents'}}) {
1.84 ! matthew 1019: if ($res->{'type'} ne 'assessment' ||
! 1020: ! exists($res->{'parts'}) ||
! 1021: ref($res->{'parts'}) ne 'ARRAY' ||
! 1022: scalar(@{$res->{'parts'}}) < 1) {
! 1023: next;
! 1024: }
1.54 matthew 1025: if (scalar(@{$res->{'parts'}}) > 1) {
1026: foreach my $part (@{$res->{'parts'}}) {
1027: $excel_sheet->write($rows_output,
1028: $cols_output++,
1029: $res->{'title'}.' part '.$part);
1030: }
1031: } else {
1032: $excel_sheet->write($rows_output,
1033: $cols_output++,
1034: $res->{'title'});
1035: }
1.82 matthew 1036: $count++;
1.54 matthew 1037: }
1.76 matthew 1038: # Determine ending cell
1.82 matthew 1039: if ($count == 1) {
1040: $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'};
1041: $seq->{'Excel:endcol'} = $seq->{'Excel:startcol'};
1042: } else {
1.83 matthew 1043: $seq->{'Excel:endcell'} =
1044: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1045: ($rows_output,$cols_output-1);
1.82 matthew 1046: $seq->{'Excel:endcol'} = $cols_output-1;
1047: }
1.76 matthew 1048: # Create the formula for summing up this sequence
1.83 matthew 1049: if (! exists($seq->{'Excel:endcell'}) ||
1050: ! defined($seq->{'Excel:endcell'})) {
1051: $seq->{'Excel:endcell'} = $seq->{'Excel:startcell'};
1052: }
1.76 matthew 1053: $seq->{'Excel:sum'}= $excel_sheet->store_formula
1054: ('=SUM('.$seq->{'Excel:startcell'}.
1055: ':'.$seq->{'Excel:endcell'}.')');
1.79 matthew 1056: }
1057: # Determine cell the score is held in
1058: $seq->{'Excel:scorecell'} =
1059: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1060: ($rows_output,$cols_output);
1061: $seq->{'Excel:scorecol'}=$cols_output;
1062: if ($data eq 'parts correct total') {
1063: $excel_sheet->write($rows_output,$cols_output++,'parts correct');
1.32 matthew 1064: } else {
1.79 matthew 1065: $excel_sheet->write($rows_output,$cols_output++,'score');
1.32 matthew 1066: }
1.79 matthew 1067: #
1068: $total_formula_string.='+'.
1069: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1070: ($rows_output,$cols_output-1);
1071: $excel_sheet->write($rows_output,$cols_output++,'maximum');
1.32 matthew 1072: }
1.79 matthew 1073: $excel_sheet->write($rows_output,$cols_output++,'Grand Total');
1.76 matthew 1074: $total_formula = $excel_sheet->store_formula($total_formula_string);
1.32 matthew 1075: #
1076: # Bookkeeping
1.54 matthew 1077: if ($data eq 'sum and total' || $data eq 'parts correct total') {
1.34 matthew 1078: $rows_output += 2;
1.32 matthew 1079: } else {
1.34 matthew 1080: $rows_output += 1;
1.45 matthew 1081: }
1082: #
1083: # Output a row for MAX
1.54 matthew 1084: $cols_output = 0;
1085: foreach my $field (&get_student_fields_to_show()) {
1086: if ($field eq 'username' || $field eq 'fullname' ||
1087: $field eq 'id') {
1088: $excel_sheet->write($rows_output,$cols_output++,'Maximum');
1089: } else {
1090: $excel_sheet->write($rows_output,$cols_output++,'');
1091: }
1092: }
1093: #
1094: # Add the maximums for each sequence or assessment
1.76 matthew 1095: my %total_cell_translation;
1.79 matthew 1096: my $grand_total = 0;
1.54 matthew 1097: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.76 matthew 1098: $total_cell_translation{$seq->{'Excel:scorecell'}} =
1099: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1100: ($rows_output,$seq->{'Excel:scorecol'});
1.54 matthew 1101: my $weight;
1102: my $max = 0;
1103: foreach my $resource (@{$seq->{'contents'}}) {
1104: next if ($resource->{'type'} ne 'assessment');
1105: foreach my $part (@{$resource->{'parts'}}) {
1106: $weight = 1;
1107: if ($base eq 'scores') {
1108: $weight = &Apache::lonnet::EXT
1109: ('resource.'.$part.'.weight',$resource->{'symb'},
1110: undef,undef,undef);
1111: if (!defined($weight) || ($weight eq '')) {
1112: $weight=1;
1113: }
1114: }
1115: if ($data eq 'scores') {
1116: $excel_sheet->write($rows_output,$cols_output++,$weight);
1117: } elsif ($data eq 'tries') {
1118: $excel_sheet->write($rows_output,$cols_output++,'');
1119: }
1120: $max += $weight;
1.45 matthew 1121: }
1.54 matthew 1122: }
1123: if (! ($data eq 'sum only' || $data eq 'parts correct')) {
1124: $excel_sheet->write($rows_output,$cols_output++,'');
1.45 matthew 1125: }
1.79 matthew 1126: #
1127: if ($data eq 'tries' || $data eq 'scores') {
1128: my %replaceCells;
1129: $replaceCells{$seq->{'Excel:startcell'}} =
1130: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1131: ($rows_output,$seq->{'Excel:startcol'});
1132: $replaceCells{$seq->{'Excel:endcell'}} =
1133: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1134: ($rows_output,$seq->{'Excel:endcol'});
1135: $excel_sheet->repeat_formula($rows_output,$cols_output++,
1136: $seq->{'Excel:sum'},undef,
1137: %replaceCells);
1138: } else {
1139: $excel_sheet->write($rows_output,$cols_output++,
1140: $max);
1141: }
1142: $grand_total+=$max;
1143: }
1144: if ($data eq 'tries' || $data eq 'scores') {
1.76 matthew 1145: $excel_sheet->repeat_formula($rows_output,$cols_output++,
1.79 matthew 1146: $total_formula,undef,
1147: %total_cell_translation);
1148: } else {
1149: $excel_sheet->write($rows_output,$cols_output++,$grand_total);
1.76 matthew 1150: }
1.54 matthew 1151: $rows_output++;
1.32 matthew 1152: #
1153: # Let the user know what we are doing
1154: my $studentcount = scalar(@Apache::lonstatistics::Students);
1155: $r->print("<h1>Compiling Excel spreadsheet for ".
1156: $studentcount.' student');
1157: $r->print('s') if ($studentcount > 1);
1158: $r->print("</h1>\n");
1159: $r->rflush();
1.31 matthew 1160: #
1.36 matthew 1161: # Initialize progress window
1162: %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
1163: ($r,'Excel File Compilation Status',
1164: 'Excel File Compilation Progress', $studentcount);
1165: #
1.62 matthew 1166: &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,
1167: 'Processing first student');
1.31 matthew 1168: return;
1169: }
1170:
1171: sub excel_outputstudent {
1172: my ($r,$student) = @_;
1.54 matthew 1173: return if ($request_aborted);
1.32 matthew 1174: return if (! defined($excel_sheet));
1175: $cols_output=0;
1176: #
1177: # Write out student data
1178: my @to_show = &get_student_fields_to_show();
1179: foreach my $field (@to_show) {
1180: $excel_sheet->write($rows_output,$cols_output++,$student->{$field});
1181: }
1182: #
1183: # Get student assessment data
1184: my %StudentsData;
1185: my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
1186: $student->{'domain'},
1187: undef,
1188: $ENV{'request.course.id'});
1189: if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
1190: %StudentsData = @tmp;
1191: }
1192: #
1193: # Write out sequence scores and totals data
1.76 matthew 1194: my %total_cell_translation;
1.40 matthew 1195: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.76 matthew 1196: # Keep track of cells to translate in total cell
1197: $total_cell_translation{$seq->{'Excel:scorecell'}} =
1198: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1199: ($rows_output,$seq->{'Excel:scorecol'});
1200: #
1.54 matthew 1201: my ($performance,$performance_length,$score,$seq_max,$rawdata);
1202: if ($base eq 'tries') {
1203: ($performance,$performance_length,$score,$seq_max,$rawdata) =
1204: &StudentTriesOnSequence($student,\%StudentsData,
1205: $seq,'no');
1206: } else {
1207: ($performance,$performance_length,$score,$seq_max,$rawdata) =
1208: &StudentPerformanceOnSequence($student,\%StudentsData,
1209: $seq,'no');
1210: }
1211: if ($data eq 'tries' || $data eq 'scores') {
1212: foreach my $value (@$rawdata) {
1213: $excel_sheet->write($rows_output,$cols_output++,$value);
1214: }
1.76 matthew 1215: # Write a formula for the sum of this sequence
1216: my %replaceCells;
1217: $replaceCells{$seq->{'Excel:startcell'}} =
1218: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1219: ($rows_output,$seq->{'Excel:startcol'});
1220: $replaceCells{$seq->{'Excel:endcell'}} =
1221: &Spreadsheet::WriteExcel::Utility::xl_rowcol_to_cell
1222: ($rows_output,$seq->{'Excel:endcol'});
1223: # The undef is for the format
1.81 matthew 1224: if (scalar(keys(%replaceCells)) == 1) {
1225: $excel_sheet->repeat_formula($rows_output,$cols_output++,
1226: $seq->{'Excel:sum'},undef,
1227: %replaceCells,%replaceCells);
1228: } else {
1229: $excel_sheet->repeat_formula($rows_output,$cols_output++,
1230: $seq->{'Excel:sum'},undef,
1231: %replaceCells);
1232: }
1.76 matthew 1233: #
1.54 matthew 1234: $excel_sheet->write($rows_output,$cols_output++,$seq_max);
1235: } elsif ($data eq 'sum and total' || $data eq 'sum only' ||
1236: $data eq 'parts correct' || $data eq 'parts correct total') {
1.32 matthew 1237: $excel_sheet->write($rows_output,$cols_output++,$score);
1238: }
1.54 matthew 1239: if ($data eq 'sum and total' || $data eq 'parts correct total') {
1.32 matthew 1240: $excel_sheet->write($rows_output,$cols_output++,$seq_max);
1241: }
1242: }
1.76 matthew 1243: #
1244: $excel_sheet->repeat_formula($rows_output,$cols_output++,
1245: $total_formula,undef,
1246: %total_cell_translation);
1247:
1.32 matthew 1248: #
1249: # Bookkeeping
1250: $rows_output++;
1251: $cols_output=0;
1252: #
1.36 matthew 1253: # Update the progress window
1254: &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
1.32 matthew 1255: return;
1.31 matthew 1256: }
1257:
1258: sub excel_finish {
1259: my ($r) = @_;
1.54 matthew 1260: return if ($request_aborted);
1.32 matthew 1261: return if (! defined($excel_sheet));
1262: #
1263: # Write the excel file
1264: $excel_workbook->close();
1265: my $c = $r->connection();
1266: #
1267: return if($c->aborted());
1268: #
1.36 matthew 1269: # Close the progress window
1270: &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
1271: #
1.32 matthew 1272: # Tell the user where to get their excel file
1.36 matthew 1273: $r->print('<br />'.
1.32 matthew 1274: '<a href="'.$filename.'">Your Excel spreadsheet.</a>'."\n");
1275: $r->rflush();
1276: return;
1.31 matthew 1277: }
1278:
1279: }
1.30 matthew 1280: #######################################################
1281: #######################################################
1282:
1283: =pod
1284:
1.31 matthew 1285: =head2 CSV output routines
1286:
1287: =item &csv_initialize($r)
1288:
1289: =item &csv_outputstudent($r,$student)
1290:
1291: =item &csv_finish($r)
1.30 matthew 1292:
1293: =cut
1294:
1295: #######################################################
1296: #######################################################
1.31 matthew 1297: {
1298:
1.37 matthew 1299: my $outputfile;
1300: my $filename;
1.54 matthew 1301: my $request_aborted;
1.37 matthew 1302: my %prog_state; # progress window state
1303:
1.31 matthew 1304: sub csv_initialize{
1305: my ($r) = @_;
1.37 matthew 1306: #
1307: # Clean up
1.66 matthew 1308: undef($outputfile);
1309: undef($filename);
1310: undef($request_aborted);
1.37 matthew 1311: undef(%prog_state);
1312: #
1.54 matthew 1313: # Deal with unimplemented requests
1314: $request_aborted = undef;
1315: if ($data =~ /final table/) {
1316: $r->print(<<END);
1317: <h2>Unable to Complete Request</h2>
1318: <p>
1319: The <b>Summary Table (Scores)</b> option is not available for non-HTML output.
1320: </p>
1321: END
1322: $request_aborted = 1;
1323: }
1324: return if ($request_aborted);
1325:
1326: #
1.37 matthew 1327: # Open a file
1328: $filename = '/prtspool/'.
1329: $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
1330: time.'_'.rand(1000000000).'.csv';
1331: unless ($outputfile = Apache::File->new('>/home/httpd'.$filename)) {
1332: $r->log_error("Couldn't open $filename for output $!");
1333: $r->print("Problems occured in writing the csv file. ".
1334: "This error has been logged. ".
1335: "Please alert your LON-CAPA administrator.");
1336: $outputfile = undef;
1337: }
1.38 matthew 1338: #
1339: # Datestamp
1340: my $description = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1341: print $outputfile '"'.&Apache::loncommon::csv_translate($description).'",'.
1342: '"'.&Apache::loncommon::csv_translate(scalar(localtime(time))).'"'.
1343: "\n";
1.37 matthew 1344: #
1345: # Print out the headings
1346: my $Str = '';
1347: my $Str2 = undef;
1348: foreach my $field (&get_student_fields_to_show()) {
1.54 matthew 1349: if ($data eq 'sum only') {
1.37 matthew 1350: $Str .= '"'.&Apache::loncommon::csv_translate($field).'",';
1.54 matthew 1351: } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
1.37 matthew 1352: $Str .= '"",'; # first row empty on the student fields
1353: $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
1.54 matthew 1354: } elsif ($data eq 'scores' || $data eq 'tries' ||
1355: $data eq 'parts correct') {
1.53 matthew 1356: $Str .= '"",';
1357: $Str2 .= '"'.&Apache::loncommon::csv_translate($field).'",';
1.37 matthew 1358: }
1359: }
1.40 matthew 1360: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.54 matthew 1361: if ($data eq 'sum only' || $data eq 'parts correct') {
1.37 matthew 1362: $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
1363: '",';
1.54 matthew 1364: } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
1.37 matthew 1365: $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
1366: '","",';
1367: $Str2 .= '"score","total possible",';
1.54 matthew 1368: } elsif ($data eq 'scores' || $data eq 'tries') {
1.37 matthew 1369: $Str .= '"'.&Apache::loncommon::csv_translate($seq->{'title'}).
1370: '",';
1.53 matthew 1371: $Str .= '"",'x($seq->{'num_assess_parts'}-1+2);
1372: foreach my $res (@{$seq->{'contents'}}) {
1.54 matthew 1373: next if ($res->{'type'} ne 'assessment');
1.53 matthew 1374: foreach my $part (@{$res->{'parts'}}) {
1375: $Str2 .= '"'.&Apache::loncommon::csv_translate($res->{'title'}.', Part '.$part).'",';
1376: }
1377: }
1378: $Str2 .= '"score","total possible",';
1.37 matthew 1379: }
1380: }
1381: chop($Str);
1382: $Str .= "\n";
1383: print $outputfile $Str;
1384: if (defined($Str2)) {
1385: chop($Str2);
1386: $Str2 .= "\n";
1387: print $outputfile $Str2;
1388: }
1389: #
1390: # Initialize progress window
1391: my $studentcount = scalar(@Apache::lonstatistics::Students);
1392: %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
1393: ($r,'CSV File Compilation Status',
1394: 'CSV File Compilation Progress', $studentcount);
1.31 matthew 1395: return;
1396: }
1397:
1398: sub csv_outputstudent {
1399: my ($r,$student) = @_;
1.54 matthew 1400: return if ($request_aborted);
1.37 matthew 1401: return if (! defined($outputfile));
1402: my $Str = '';
1403: #
1404: # Output student fields
1405: my @to_show = &get_student_fields_to_show();
1406: foreach my $field (@to_show) {
1407: $Str .= '"'.&Apache::loncommon::csv_translate($student->{$field}).'",';
1408: }
1409: #
1410: # Get student assessment data
1411: my %StudentsData;
1412: my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'},
1413: $student->{'domain'},
1414: undef,
1415: $ENV{'request.course.id'});
1416: if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
1417: %StudentsData = @tmp;
1418: }
1419: #
1420: # Output performance data
1.40 matthew 1421: foreach my $seq (&Apache::lonstatistics::Sequences_with_Assess()) {
1.54 matthew 1422: my ($performance,$performance_length,$score,$seq_max,$rawdata);
1423: if ($base eq 'tries') {
1424: ($performance,$performance_length,$score,$seq_max,$rawdata) =
1425: &StudentTriesOnSequence($student,\%StudentsData,
1426: $seq,'no');
1427: } else {
1428: ($performance,$performance_length,$score,$seq_max,$rawdata) =
1429: &StudentPerformanceOnSequence($student,\%StudentsData,
1430: $seq,'no');
1431: }
1432: if ($data eq 'sum only' || $data eq 'parts correct') {
1.37 matthew 1433: $Str .= '"'.$score.'",';
1.54 matthew 1434: } elsif ($data eq 'sum and total' || $data eq 'parts correct total') {
1.37 matthew 1435: $Str .= '"'.$score.'","'.$seq_max.'",';
1.54 matthew 1436: } elsif ($data eq 'scores' || $data eq 'tries') {
1437: $Str .= '"'.join('","',(@$rawdata,$score,$seq_max)).'",';
1.37 matthew 1438: }
1439: }
1440: chop($Str);
1441: $Str .= "\n";
1442: print $outputfile $Str;
1443: #
1444: # Update the progress window
1445: &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student');
1446: return;
1.31 matthew 1447: }
1448:
1449: sub csv_finish {
1450: my ($r) = @_;
1.54 matthew 1451: return if ($request_aborted);
1.37 matthew 1452: return if (! defined($outputfile));
1453: close($outputfile);
1454: #
1455: my $c = $r->connection();
1456: return if ($c->aborted());
1457: #
1458: # Close the progress window
1459: &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
1460: #
1461: # Tell the user where to get their csv file
1462: $r->print('<br />'.
1463: '<a href="'.$filename.'">Your csv file.</a>'."\n");
1464: $r->rflush();
1465: return;
1466:
1.31 matthew 1467: }
1.2 stredwic 1468:
1469: }
1470:
1.28 matthew 1471: #######################################################
1472: #######################################################
1473:
1.2 stredwic 1474: =pod
1475:
1.54 matthew 1476: =item &StudentTriesOnSequence()
1.2 stredwic 1477:
1.30 matthew 1478: Inputs:
1.2 stredwic 1479:
1480: =over 4
1481:
1.30 matthew 1482: =item $student
1.28 matthew 1483:
1.30 matthew 1484: =item $studentdata Hash ref to all student data
1.2 stredwic 1485:
1.30 matthew 1486: =item $seq Hash ref, the sequence we are working on
1.2 stredwic 1487:
1.30 matthew 1488: =item $links if defined we will output links to each resource.
1.2 stredwic 1489:
1.28 matthew 1490: =back
1.2 stredwic 1491:
1492: =cut
1.1 stredwic 1493:
1.28 matthew 1494: #######################################################
1495: #######################################################
1.54 matthew 1496: sub StudentTriesOnSequence {
1.32 matthew 1497: my ($student,$studentdata,$seq,$links) = @_;
1.31 matthew 1498: $links = 'no' if (! defined($links));
1.1 stredwic 1499: my $Str = '';
1.30 matthew 1500: my ($sum,$max) = (0,0);
1.51 matthew 1501: my $performance_length = 0;
1.54 matthew 1502: my @TriesData = ();
1503: my $tries;
1.30 matthew 1504: foreach my $resource (@{$seq->{'contents'}}) {
1505: next if ($resource->{'type'} ne 'assessment');
1506: my $resource_data = $studentdata->{$resource->{'symb'}};
1507: my $value = '';
1508: foreach my $partnum (@{$resource->{'parts'}}) {
1.54 matthew 1509: $tries = undef;
1.30 matthew 1510: $max++;
1.51 matthew 1511: $performance_length++;
1.30 matthew 1512: my $symbol = ' '; # default to space
1513: #
1.78 matthew 1514: my $awarded = 0;
1515: if (exists($resource_data->{'resource.'.$partnum.'.awarded'})) {
1516: $awarded = $resource_data->{'resource.'.$partnum.'.awarded'};
1517: $awarded = 0 if (! $awarded);
1518: }
1519: #
1520: my $status = '';
1.30 matthew 1521: if (exists($resource_data->{'resource.'.$partnum.'.solved'})) {
1.78 matthew 1522: $status = $resource_data->{'resource.'.$partnum.'.solved'};
1523: }
1524: #
1525: my $tries = 0;
1526: if(exists($resource_data->{'resource.'.$partnum.'.tries'})) {
1527: $tries = $resource_data->{'resource.'.$partnum.'.tries'};
1528: }
1529: #
1530: if ($awarded > 0) {
1531: # The student has gotten the problem correct to some degree
1532: if ($status eq 'excused') {
1533: $symbol = 'x';
1534: $max--;
1535: } elsif ($status eq 'correct_by_override') {
1.30 matthew 1536: $symbol = '+';
1537: $sum++;
1.78 matthew 1538: } elsif ($tries > 0) {
1.54 matthew 1539: if ($tries > 9) {
1.30 matthew 1540: $symbol = '*';
1.78 matthew 1541: } else {
1.54 matthew 1542: $symbol = $tries;
1.30 matthew 1543: }
1544: $sum++;
1545: } else {
1.78 matthew 1546: $symbol = '+';
1547: $sum++;
1.2 stredwic 1548: }
1.30 matthew 1549: } else {
1.78 matthew 1550: # The student has the problem incorrect or it is ungraded
1551: if ($status eq 'excused') {
1552: $symbol = 'x';
1553: $max--;
1554: } elsif ($status eq 'incorrect_by_override') {
1555: $symbol = '-';
1556: } elsif ($status eq 'ungraded_attempted') {
1557: $symbol = '#';
1558: } elsif ($status eq 'incorrect_attempted' ||
1559: $tries > 0) {
1.30 matthew 1560: $symbol = '.';
1561: } else {
1.78 matthew 1562: # Problem is wrong and has not been attempted.
1563: $symbol=' ';
1.18 matthew 1564: }
1.2 stredwic 1565: }
1.54 matthew 1566: #
1567: if (! defined($tries)) {
1568: $tries = $symbol;
1569: }
1570: push (@TriesData,$tries);
1.30 matthew 1571: #
1.47 matthew 1572: if ( ($links eq 'yes' && $symbol ne ' ') ||
1573: ($links eq 'all')) {
1.49 matthew 1574: if (length($symbol) > 1) {
1575: &Apache::lonnet::logthis('length of symbol "'.$symbol.'" > 1');
1576: }
1.30 matthew 1577: $symbol = '<a href="/adm/grades'.
1578: '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
1579: '&student='.$student->{'username'}.
1.64 albertel 1580: '&userdom='.$student->{'domain'}.
1.30 matthew 1581: '&command=submission">'.$symbol.'</a>';
1582: }
1583: $value .= $symbol;
1.2 stredwic 1584: }
1.30 matthew 1585: $Str .= $value;
1.17 minaeibi 1586: }
1.51 matthew 1587: if ($seq->{'randompick'}) {
1588: $max = $seq->{'randompick'};
1589: }
1.54 matthew 1590: return ($Str,$performance_length,$sum,$max,\@TriesData);
1591: }
1592:
1593: #######################################################
1594: #######################################################
1595:
1596: =pod
1597:
1598: =item &StudentPerformanceOnSequence()
1599:
1600: Inputs:
1601:
1602: =over 4
1603:
1604: =item $student
1605:
1606: =item $studentdata Hash ref to all student data
1607:
1608: =item $seq Hash ref, the sequence we are working on
1609:
1610: =item $links if defined we will output links to each resource.
1611:
1612: =back
1613:
1614: =cut
1615:
1616: #######################################################
1617: #######################################################
1618: sub StudentPerformanceOnSequence {
1619: my ($student,$studentdata,$seq,$links) = @_;
1620: $links = 'no' if (! defined($links));
1621: my $Str = ''; # final result string
1622: my ($score,$max) = (0,0);
1623: my $performance_length = 0;
1624: my $symbol;
1625: my @ScoreData = ();
1626: my $partscore;
1627: foreach my $resource (@{$seq->{'contents'}}) {
1628: next if ($resource->{'type'} ne 'assessment');
1629: my $resource_data = $studentdata->{$resource->{'symb'}};
1630: foreach my $part (@{$resource->{'parts'}}) {
1631: $partscore = undef;
1632: my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
1633: $resource->{'symb'},
1634: $student->{'domain'},
1635: $student->{'username'},
1636: $student->{'section'});
1637: if (!defined($weight) || ($weight eq '')) {
1638: $weight=1;
1639: }
1640: #
1641: $max += $weight; # see the 'excused' branch below...
1642: $performance_length++; # one character per part
1643: $symbol = ' '; # default to space
1644: #
1645: my $awarded = 0;
1646: if (exists($resource_data->{'resource.'.$part.'.awarded'})) {
1647: $awarded = $resource_data->{'resource.'.$part.'.awarded'};
1.67 matthew 1648: $awarded = 0 if (! $awarded);
1.54 matthew 1649: }
1650: #
1651: $partscore = $weight*$awarded;
1652: $score += $partscore;
1.63 matthew 1653: $symbol = $partscore;
1.70 matthew 1654: if (abs($symbol - sprintf("%.0f",$symbol)) < 0.001) {
1655: $symbol = sprintf("%.0f",$symbol);
1656: }
1.54 matthew 1657: if (length($symbol) > 1) {
1658: $symbol = '*';
1659: }
1660: if (exists($resource_data->{'resource.'.$part.'.solved'})) {
1661: my $status = $resource_data->{'resource.'.$part.'.solved'};
1662: if ($status eq 'excused') {
1663: $symbol = 'x';
1664: $max -= $weight; # Do not count 'excused' problems.
1665: }
1666: } else {
1667: # Unsolved. Did they try?
1668: if (exists($resource_data->{'resource.'.$part.'.tries'})){
1669: $symbol = '.';
1670: } else {
1671: $symbol = ' ';
1672: }
1673: }
1674: #
1.60 matthew 1675: if (! defined($partscore)) {
1676: $partscore = $symbol;
1677: }
1678: push (@ScoreData,$partscore);
1679: #
1.54 matthew 1680: if ( ($links eq 'yes' && $symbol ne ' ') || ($links eq 'all')) {
1681: $symbol = '<a href="/adm/grades'.
1682: '?symb='.&Apache::lonnet::escape($resource->{'symb'}).
1683: '&student='.$student->{'username'}.
1.64 albertel 1684: '&userdom='.$student->{'domain'}.
1.54 matthew 1685: '&command=submission">'.$symbol.'</a>';
1686: }
1.60 matthew 1687: $Str .= $symbol;
1.54 matthew 1688: }
1689: }
1690: return ($Str,$performance_length,$score,$max,\@ScoreData);
1.1 stredwic 1691: }
1.23 minaeibi 1692:
1.28 matthew 1693: #######################################################
1694: #######################################################
1.23 minaeibi 1695:
1.2 stredwic 1696: =pod
1697:
1698: =item &CreateLegend()
1699:
1700: This function returns a formatted string containing the legend for the
1701: chart. The legend describes the symbols used to represent grades for
1702: problems.
1703:
1704: =cut
1705:
1.28 matthew 1706: #######################################################
1707: #######################################################
1.2 stredwic 1708: sub CreateLegend {
1709: my $Str = "<p><pre>".
1.13 minaeibi 1710: " 1 correct by student in 1 try\n".
1711: " 7 correct by student in 7 tries\n".
1.12 minaeibi 1712: " * correct by student in more than 9 tries\n".
1.20 minaeibi 1713: " + correct by hand grading or override\n".
1.12 minaeibi 1714: " - incorrect by override\n".
1715: " . incorrect attempted\n".
1716: " # ungraded attempted\n".
1.13 minaeibi 1717: " not attempted (blank field)\n".
1.12 minaeibi 1718: " x excused".
1.17 minaeibi 1719: "</pre><p>";
1.2 stredwic 1720: return $Str;
1721: }
1722:
1.28 matthew 1723: #######################################################
1724: #######################################################
1725:
1.30 matthew 1726: =pod
1.2 stredwic 1727:
1728: =back
1729:
1730: =cut
1731:
1.28 matthew 1732: #######################################################
1733: #######################################################
1.2 stredwic 1734:
1.28 matthew 1735: 1;
1.2 stredwic 1736:
1.1 stredwic 1737: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>