[system] / branches / gage_dev / webwork2 / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

Annotation of /branches/gage_dev/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6310 - (view) (download) (as text)

1 : sh002i 449 ################################################################################
2 : sh002i 1663 # WeBWorK Online Homework Delivery System
3 : sh002i 5319 # Copyright © 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/
4 : gage 6285 # $CVSHeader: webwork2/lib/WeBWorK/ContentGenerator/Problem.pm,v 1.225 2010/05/28 21:29:48 gage Exp $
5 : sh002i 1663 #
6 :     # This program is free software; you can redistribute it and/or modify it under
7 :     # the terms of either: (a) the GNU General Public License as published by the
8 :     # Free Software Foundation; either version 2, or (at your option) any later
9 :     # version, or (b) the "Artistic License" which comes with this package.
10 :     #
11 :     # This program is distributed in the hope that it will be useful, but WITHOUT
12 :     # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 :     # FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the
14 :     # Artistic License for more details.
15 : sh002i 449 ################################################################################
16 :    
17 : malsyned 353 package WeBWorK::ContentGenerator::Problem;
18 : sh002i 818 use base qw(WeBWorK::ContentGenerator);
19 : malsyned 396
20 : sh002i 455 =head1 NAME
21 : gage 1039
22 : sh002i 455 WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
23 :    
24 :     =cut
25 : sh002i 1536
26 : malsyned 396 use strict;
27 :     use warnings;
28 : gage 4235 #use CGI qw(-nosticky );
29 :     use WeBWorK::CGI;
30 : sh002i 919 use File::Path qw(rmtree);
31 : sh002i 3485 use WeBWorK::Debug;
32 : sh002i 455 use WeBWorK::Form;
33 :     use WeBWorK::PG;
34 : sh002i 1234 use WeBWorK::PG::ImageGenerator;
35 : sh002i 623 use WeBWorK::PG::IO;
36 : sh002i 4504 use WeBWorK::Utils qw(readFile writeLog writeCourseLog encodeAnswers decodeAnswers
37 :     ref2string makeTempDirectory path_is_subdir sortByName before after between);
38 : sh002i 4566 use WeBWorK::DB::Utils qw(global2user user2global);
39 : gage 3034 use URI::Escape;
40 : sh002i 1223
41 : jj 2415 use WeBWorK::Utils::Tasks qw(fake_set fake_problem);
42 : sh002i 1536
43 : sh002i 2505 ################################################################################
44 :     # CGI param interface to this module (up-to-date as of v1.153)
45 :     ################################################################################
46 :    
47 :     # Standard params:
48 : sh002i 449 #
49 : sh002i 2505 # user - user ID of real user
50 :     # key - session key
51 :     # effectiveUser - user ID of effective user
52 : sh002i 415 #
53 : sh002i 2505 # Integration with PGProblemEditor:
54 : sh002i 415 #
55 : sh002i 2505 # editMode - if set, indicates alternate problem source location.
56 :     # can be "temporaryFile" or "savedFile".
57 : sh002i 425 #
58 : sh002i 2505 # sourceFilePath - path to file to be edited
59 :     # problemSeed - force problem seed to value
60 :     # success - success message to display
61 :     # failure - failure message to display
62 : toenail 2398 #
63 : sh002i 2505 # Rendering options:
64 :     #
65 :     # displayMode - name of display mode to use
66 :     #
67 :     # showOldAnswers - request that last entered answer be shown (if allowed)
68 :     # showCorrectAnswers - request that correct answers be shown (if allowed)
69 :     # showHints - request that hints be shown (if allowed)
70 :     # showSolutions - request that solutions be shown (if allowed)
71 :     #
72 :     # Problem interaction:
73 :     #
74 :     # AnSwEr# - answer blanks in problem
75 :     #
76 :     # redisplay - name of the "Redisplay Problem" button
77 :     # submitAnswers - name of "Submit Answers" button
78 :     # checkAnswers - name of the "Check Answers" button
79 :     # previewAnswers - name of the "Preview Answers" button
80 : gage 392
81 : sh002i 2505 ################################################################################
82 :     # "can" methods
83 :     ################################################################################
84 : malsyned 1426
85 : sh002i 2505 # Subroutines to determine if a user "can" perform an action. Each subroutine is
86 :     # called with the following arguments:
87 :     #
88 : sh002i 2762 # ($self, $User, $EffectiveUser, $Set, $Problem)
89 : sh002i 2505
90 : glarose 3377 # Note that significant parts of the "can" methods are lifted into the
91 :     # GatewayQuiz module. It isn't direct, however, because of the necessity
92 :     # of dealing with versioning there.
93 :    
94 : sh002i 2505 sub can_showOldAnswers {
95 : sh002i 2762 #my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
96 : sh002i 2505
97 :     return 1;
98 :     }
99 :    
100 :     sub can_showCorrectAnswers {
101 : sh002i 2762 my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
102 : sh002i 2505 my $authz = $self->r->authz;
103 :    
104 :     return
105 :     after($Set->answer_date)
106 :     ||
107 :     $authz->hasPermissions($User->user_id, "show_correct_answers_before_answer_date")
108 :     ;
109 :     }
110 :    
111 :     sub can_showHints {
112 : sh002i 2762 #my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
113 : sh002i 2505
114 :     return 1;
115 :     }
116 :    
117 :     sub can_showSolutions {
118 : sh002i 2762 my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
119 : sh002i 2505 my $authz = $self->r->authz;
120 :    
121 :     return
122 :     after($Set->answer_date)
123 :     ||
124 :     $authz->hasPermissions($User->user_id, "show_solutions_before_answer_date")
125 :     ;
126 :     }
127 :    
128 :     sub can_recordAnswers {
129 : sh002i 2762 my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
130 : sh002i 2505 my $authz = $self->r->authz;
131 : jj 2685 my $thisAttempt = $submitAnswers ? 1 : 0;
132 : sh002i 2505 if ($User->user_id ne $EffectiveUser->user_id) {
133 :     return $authz->hasPermissions($User->user_id, "record_answers_when_acting_as_student");
134 :     }
135 :     if (before($Set->open_date)) {
136 :     return $authz->hasPermissions($User->user_id, "record_answers_before_open_date");
137 :     } elsif (between($Set->open_date, $Set->due_date)) {
138 :     my $max_attempts = $Problem->max_attempts;
139 : jj 2685 my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
140 : sh002i 2505 if ($max_attempts == -1 or $attempts_used < $max_attempts) {
141 :     return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_with_attempts");
142 :     } else {
143 :     return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_without_attempts");
144 :     }
145 : sh002i 2512 } elsif (between($Set->due_date, $Set->answer_date)) {
146 : sh002i 2505 return $authz->hasPermissions($User->user_id, "record_answers_after_due_date");
147 : sh002i 2512 } elsif (after($Set->answer_date)) {
148 : sh002i 2505 return $authz->hasPermissions($User->user_id, "record_answers_after_answer_date");
149 :     }
150 :     }
151 :    
152 :     sub can_checkAnswers {
153 : sh002i 2762 my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
154 : sh002i 2505 my $authz = $self->r->authz;
155 : jj 2685 my $thisAttempt = $submitAnswers ? 1 : 0;
156 : sh002i 2505
157 :     if (before($Set->open_date)) {
158 :     return $authz->hasPermissions($User->user_id, "check_answers_before_open_date");
159 :     } elsif (between($Set->open_date, $Set->due_date)) {
160 :     my $max_attempts = $Problem->max_attempts;
161 : jj 2685 my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
162 : sh002i 2505 if ($max_attempts == -1 or $attempts_used < $max_attempts) {
163 :     return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_with_attempts");
164 :     } else {
165 :     return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_without_attempts");
166 :     }
167 : sh002i 2512 } elsif (between($Set->due_date, $Set->answer_date)) {
168 : sh002i 2505 return $authz->hasPermissions($User->user_id, "check_answers_after_due_date");
169 : sh002i 2512 } elsif (after($Set->answer_date)) {
170 : sh002i 2505 return $authz->hasPermissions($User->user_id, "check_answers_after_answer_date");
171 :     }
172 :     }
173 :    
174 : jj 3564 # Reset the default in some cases
175 :     sub set_showOldAnswers_default {
176 :     my ($self, $ce, $userName, $authz, $set) = @_;
177 : jj 3580 # these people always use the system/course default, so don't
178 :     # override the value of ...->{showOldAnswers}
179 :     return if $authz->hasPermissions($userName, "can_always_use_show_old_answers_default");
180 : jj 3564 # this person should always default to 0
181 :     $ce->{pg}->{options}->{showOldAnswers} = 0
182 :     unless ($authz->hasPermissions($userName, "can_show_old_answers_by_default"));
183 :     # we are after the due date, so default to not showing it
184 : dpvc 3567 $ce->{pg}->{options}->{showOldAnswers} = 0 if $set->{due_date} && after($set->{due_date});
185 : jj 3564 }
186 :    
187 : sh002i 2505 ################################################################################
188 :     # output utilities
189 :     ################################################################################
190 :    
191 : glarose 3377 # Note: the substance of attemptResults is lifted into GatewayQuiz.pm,
192 :     # with some changes to the output format
193 :    
194 : sh002i 2505 sub attemptResults {
195 :     my $self = shift;
196 :     my $pg = shift;
197 :     my $showAttemptAnswers = shift;
198 :     my $showCorrectAnswers = shift;
199 :     my $showAttemptResults = $showAttemptAnswers && shift;
200 :     my $showSummary = shift;
201 :     my $showAttemptPreview = shift || 0;
202 :    
203 :     my $ce = $self->r->ce;
204 :    
205 :     my $problemResult = $pg->{result}; # the overall result of the problem
206 :     my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
207 :    
208 :     my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
209 :    
210 :     my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
211 :    
212 :     # to make grabbing these options easier, we'll pull them out now...
213 :     my %imagesModeOptions = %{$ce->{pg}->{displayModeOptions}->{images}};
214 :    
215 :     my $imgGen = WeBWorK::PG::ImageGenerator->new(
216 :     tempDir => $ce->{webworkDirs}->{tmp},
217 :     latex => $ce->{externalPrograms}->{latex},
218 :     dvipng => $ce->{externalPrograms}->{dvipng},
219 :     useCache => 1,
220 :     cacheDir => $ce->{webworkDirs}->{equationCache},
221 :     cacheURL => $ce->{webworkURLs}->{equationCache},
222 :     cacheDB => $ce->{webworkFiles}->{equationCacheDB},
223 :     dvipng_align => $imagesModeOptions{dvipng_align},
224 :     dvipng_depth_db => $imagesModeOptions{dvipng_depth_db},
225 :     );
226 :    
227 :     my $header;
228 :     #$header .= CGI::th("Part");
229 :     $header .= $showAttemptAnswers ? CGI::th("Entered") : "";
230 :     $header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
231 :     $header .= $showCorrectAnswers ? CGI::th("Correct") : "";
232 :     $header .= $showAttemptResults ? CGI::th("Result") : "";
233 :     $header .= $showMessages ? CGI::th("Messages") : "";
234 : sh002i 2761 my $fully = '';
235 : sh002i 2505 my @tableRows = ( $header );
236 :     my $numCorrect = 0;
237 : gage 3391 my $numBlanks =0;
238 : sh002i 3356 my $tthPreambleCache;
239 : sh002i 2505 foreach my $name (@answerNames) {
240 :     my $answerResult = $pg->{answers}->{$name};
241 :     my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
242 :     my $preview = ($showAttemptPreview
243 : sh002i 3356 ? $self->previewAnswer($answerResult, $imgGen, \$tthPreambleCache)
244 : sh002i 2505 : "");
245 : gage 6284 my $correctAnswerPreview = $self->previewCorrectAnswer($answerResult, $imgGen, \$tthPreambleCache);
246 : sh002i 2505 my $correctAnswer = $answerResult->{correct_ans};
247 :     my $answerScore = $answerResult->{score};
248 :     my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
249 : sh002i 2767 $answerMessage =~ s/\n/<BR>/g;
250 : sh002i 2761 $numCorrect += $answerScore >= 1;
251 : dpvc 3653 $numBlanks++ unless $studentAnswer =~/\S/ || $answerScore >= 1; # unless student answer contains entry
252 : sh002i 2761 my $resultString = $answerScore >= 1 ? "correct" :
253 :     $answerScore > 0 ? int($answerScore*100)."% correct" :
254 :     "incorrect";
255 :     $fully = 'completely ' if $answerScore >0 and $answerScore < 1;
256 : sh002i 2505
257 :     # get rid of the goofy prefix on the answer names (supposedly, the format
258 :     # of the answer names is changeable. this only fixes it for "AnSwEr"
259 :     #$name =~ s/^AnSwEr//;
260 :    
261 :     my $row;
262 :     #$row .= CGI::td($name);
263 :     $row .= $showAttemptAnswers ? CGI::td($self->nbsp($studentAnswer)) : "";
264 : Mgage 6293 $row .= $showAttemptPreview ? CGI::td({onmouseover=>qq!Tip('$studentAnswer',SHADOW, true,
265 :     DELAY, 1000, FADEIN, 300, FADEOUT, 300, STICKY, 1, OFFSETX, -20, CLOSEBTN, true, CLICKCLOSE, false,
266 :     BGCOLOR, '#F4FF91', TITLE, 'Entered:',TITLEBGCOLOR, '#F4FF91', TITLEFONTCOLOR, '#000000')!},
267 :     $self->nbsp($preview)) : "";
268 :     $row .= $showCorrectAnswers ? CGI::td({onmouseover=> qq!Tip('$correctAnswer',SHADOW, true,
269 :     DELAY, 1000, FADEIN, 300, FADEOUT, 300, STICKY, 1, OFFSETX, -20, CLOSEBTN, true, CLICKCLOSE, false,
270 :     BGCOLOR, '#F4FF91', TITLE, 'Entered:',TITLEBGCOLOR, '#F4FF91', TITLEFONTCOLOR, '#000000')!},
271 :     $self->nbsp($correctAnswerPreview)) : "";
272 : sh002i 2505 $row .= $showAttemptResults ? CGI::td($self->nbsp($resultString)) : "";
273 : sh002i 2767 $row .= $showMessages ? CGI::td({-class=>"Message"},$self->nbsp($answerMessage)) : "";
274 : sh002i 2505 push @tableRows, $row;
275 :     }
276 :    
277 :     # render equation images
278 :     $imgGen->render(refresh => 1);
279 :    
280 :     # my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
281 :     my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
282 :     # FIXME -- I left the old code in in case we have to back out.
283 :     # my $summary = "On this attempt, you answered $numCorrect out of "
284 :     # . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
285 :     my $summary = "";
286 : gage 3391 unless (defined($problemResult->{summary}) and $problemResult->{summary} =~ /\S/) {
287 :     if (scalar @answerNames == 1) { #default messages
288 :     if ($numCorrect == scalar @answerNames) {
289 : dpvc 4158 $summary .= CGI::div({class=>"ResultsWithoutError"},"The answer above is correct.");
290 : gage 3391 } else {
291 : dpvc 4158 $summary .= CGI::div({class=>"ResultsWithError"},"The answer above is NOT ${fully}correct.");
292 : gage 3391 }
293 :     } else {
294 :     if ($numCorrect == scalar @answerNames) {
295 : dpvc 4158 $summary .= CGI::div({class=>"ResultsWithoutError"},"All of the answers above are correct.");
296 : gage 3391 }
297 :     unless ($numCorrect + $numBlanks == scalar( @answerNames)) {
298 : dpvc 4158 $summary .= CGI::div({class=>"ResultsWithError"},"At least one of the answers above is NOT ${fully}correct.");
299 : gage 3391 }
300 :     if ($numBlanks) {
301 :     my $s = ($numBlanks>1)?'':'s';
302 :     $summary .= CGI::div({class=>"ResultsAlert"},"$numBlanks of the questions remain$s unanswered.");
303 :     }
304 :     }
305 : sh002i 2505 } else {
306 : gage 3391 $summary = $problemResult->{summary}; # summary has been defined by grader
307 : sh002i 2505 }
308 :     return
309 :     CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows))
310 : sh002i 3768 . ($showSummary ? CGI::p({class=>'attemptResultsSummary'},$summary) : "");
311 : sh002i 2505 }
312 :    
313 :    
314 : glarose 3377 # Note: previewAnswer is lifted into GatewayQuiz.pm
315 :    
316 : sh002i 2505 sub previewAnswer {
317 : sh002i 3356 my ($self, $answerResult, $imgGen, $tthPreambleCache) = @_;
318 : sh002i 2505 my $ce = $self->r->ce;
319 :     my $effectiveUser = $self->{effectiveUser};
320 :     my $set = $self->{set};
321 :     my $problem = $self->{problem};
322 :     my $displayMode = $self->{displayMode};
323 :    
324 :     # note: right now, we have to do things completely differently when we are
325 :     # rendering math from INSIDE the translator and from OUTSIDE the translator.
326 :     # so we'll just deal with each case explicitly here. there's some code
327 :     # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
328 :    
329 :     my $tex = $answerResult->{preview_latex_string};
330 :    
331 :     return "" unless defined $tex and $tex ne "";
332 :    
333 :     if ($displayMode eq "plainText") {
334 :     return $tex;
335 :     } elsif ($displayMode eq "formattedText") {
336 : sh002i 3356
337 :     # read the TTH preamble, or use the cached copy passed in from the caller
338 : glarose 3570 my $tthPreamble='';
339 : sh002i 3356 if (defined $$tthPreambleCache) {
340 :     $tthPreamble = $$tthPreambleCache;
341 :     } else {
342 :     my $tthPreambleFile = $ce->{courseDirs}->{templates} . "/tthPreamble.tex";
343 :     if (-r $tthPreambleFile) {
344 :     $tthPreamble = readFile($tthPreambleFile);
345 :     # thanks to Jim Martino. each line in the definition file should end with
346 :     #a % to prevent adding supurious paragraphs to output:
347 :     $tthPreamble =~ s/(.)\n/$1%\n/g;
348 :     # solves the problem if the file doesn't end with a return:
349 :     $tthPreamble .="%\n";
350 :     # store preamble in cache:
351 :     $$tthPreambleCache = $tthPreamble;
352 :     } else {
353 :     }
354 :     }
355 :    
356 :     # construct TTH command line
357 : sh002i 2505 my $tthCommand = $ce->{externalPrograms}->{tth}
358 : dpvc 3362 . " -L -f5 -u -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
359 :     . $tthPreamble . "\\[" . $tex . "\\]\n"
360 : sh002i 2505 . "END_OF_INPUT\n";
361 :    
362 :     # call tth
363 :     my $result = `$tthCommand`;
364 :     if ($?) {
365 :     return "<b>[tth failed: $? $@]</b>";
366 :     } else {
367 : dpvc 3362 # avoid border problems in tables and remove unneeded initial <br>
368 :     $result =~ s/(<table [^>]*)>/$1 CLASS="ArrayLayout">/gi;
369 :     $result =~ s!\s*<br clear="all" />!!;
370 : sh002i 2505 return $result;
371 :     }
372 : sh002i 3356
373 : sh002i 2505 } elsif ($displayMode eq "images") {
374 :     $imgGen->add($tex);
375 :     } elsif ($displayMode eq "jsMath") {
376 : dpvc 4071 $tex =~ s/</&lt;/g; $tex =~ s/>/&gt;/g;
377 : dpvc 3337 return '<SPAN CLASS="math">\\displaystyle{'.$tex.'}</SPAN>';
378 : sh002i 2505 }
379 :     }
380 : gage 6284 sub previewCorrectAnswer {
381 :     my ($self, $answerResult, $imgGen, $tthPreambleCache) = @_;
382 :     my $ce = $self->r->ce;
383 :     my $effectiveUser = $self->{effectiveUser};
384 :     my $set = $self->{set};
385 :     my $problem = $self->{problem};
386 :     my $displayMode = $self->{displayMode};
387 :    
388 :     # note: right now, we have to do things completely differently when we are
389 :     # rendering math from INSIDE the translator and from OUTSIDE the translator.
390 :     # so we'll just deal with each case explicitly here. there's some code
391 :     # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
392 :    
393 : gage 6295 my $tex = $answerResult->{correct_ans_latex_string};
394 : gage 6304 return $answerResult->{correct_ans} unless defined $tex and $tex=~/\S/; # some answers don't have latex strings defined
395 :     # return "" unless defined $tex and $tex ne "";
396 : gage 6284
397 :     if ($displayMode eq "plainText") {
398 :     return $tex;
399 :     } elsif ($displayMode eq "formattedText") {
400 :    
401 :     # read the TTH preamble, or use the cached copy passed in from the caller
402 :     my $tthPreamble='';
403 :     if (defined $$tthPreambleCache) {
404 :     $tthPreamble = $$tthPreambleCache;
405 :     } else {
406 :     my $tthPreambleFile = $ce->{courseDirs}->{templates} . "/tthPreamble.tex";
407 :     if (-r $tthPreambleFile) {
408 :     $tthPreamble = readFile($tthPreambleFile);
409 :     # thanks to Jim Martino. each line in the definition file should end with
410 :     #a % to prevent adding supurious paragraphs to output:
411 :     $tthPreamble =~ s/(.)\n/$1%\n/g;
412 :     # solves the problem if the file doesn't end with a return:
413 :     $tthPreamble .="%\n";
414 :     # store preamble in cache:
415 :     $$tthPreambleCache = $tthPreamble;
416 :     } else {
417 :     }
418 :     }
419 :    
420 :     # construct TTH command line
421 :     my $tthCommand = $ce->{externalPrograms}->{tth}
422 :     . " -L -f5 -u -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
423 :     . $tthPreamble . "\\[" . $tex . "\\]\n"
424 :     . "END_OF_INPUT\n";
425 :    
426 :     # call tth
427 :     my $result = `$tthCommand`;
428 :     if ($?) {
429 :     return "<b>[tth failed: $? $@]</b>";
430 :     } else {
431 :     # avoid border problems in tables and remove unneeded initial <br>
432 :     $result =~ s/(<table [^>]*)>/$1 CLASS="ArrayLayout">/gi;
433 :     $result =~ s!\s*<br clear="all" />!!;
434 :     return $result;
435 :     }
436 :    
437 :     } elsif ($displayMode eq "images") {
438 :     $imgGen->add($tex);
439 :     } elsif ($displayMode eq "jsMath") {
440 :     $tex =~ s/</&lt;/g; $tex =~ s/>/&gt;/g;
441 :     return '<SPAN CLASS="math">\\displaystyle{'.$tex.'}</SPAN>';
442 :     }
443 :     }
444 : sh002i 2505
445 :     ################################################################################
446 :     # Template escape implementations
447 :     ################################################################################
448 :    
449 : sh002i 476 sub pre_header_initialize {
450 : sh002i 1841 my ($self) = @_;
451 : sh002i 1908 my $r = $self->r;
452 :     my $ce = $r->ce;
453 :     my $db = $r->db;
454 : toenail 2349 my $authz = $r->authz;
455 : sh002i 1908 my $urlpath = $r->urlpath;
456 :    
457 :     my $setName = $urlpath->arg("setID");
458 : sh002i 1841 my $problemNumber = $r->urlpath->arg("problemID");
459 : sh002i 1908 my $userName = $r->param('user');
460 :     my $effectiveUserName = $r->param('effectiveUser');
461 :     my $key = $r->param('key');
462 : sh002i 3816 my $editMode = $r->param("editMode");
463 : gage 1007
464 : sh002i 1636 my $user = $db->getUser($userName); # checked
465 :     die "record for user $userName (real user) does not exist."
466 :     unless defined $user;
467 :    
468 :     my $effectiveUser = $db->getUser($effectiveUserName); # checked
469 :     die "record for user $effectiveUserName (effective user) does not exist."
470 :     unless defined $effectiveUser;
471 :    
472 : sh002i 1197 # obtain the merged set for $effectiveUser
473 : sh002i 1636 my $set = $db->getMergedSet($effectiveUserName, $setName); # checked
474 : sh002i 2738
475 : jj 3564 $self->set_showOldAnswers_default($ce, $userName, $authz, $set);
476 :    
477 : sh002i 2738 # Database fix (in case of undefined published values)
478 :     # this is only necessary because some people keep holding to ww1.9 which did not have a published field
479 :     # make sure published is set to 0 or 1
480 :     if ( $set and $set->published ne "0" and $set->published ne "1") {
481 :     my $globalSet = $db->getGlobalSet($set->set_id);
482 :     $globalSet->published("1"); # defaults to published
483 :     $db->putGlobalSet($globalSet);
484 :     $set = $db->getMergedSet($effectiveUserName, $setName);
485 :     } else {
486 :     # don't do anything just yet, maybe we're a professor and we're
487 :     # fabricating a set or haven't assigned it to ourselves just yet
488 :     }
489 : apizer 6158 # When a set is created enable_reduced_scoring is null, so we have to set it
490 :     if ( $set and $set->enable_reduced_scoring ne "0" and $set->enable_reduced_scoring ne "1") {
491 :     my $globalSet = $db->getGlobalSet($set->set_id);
492 :     $globalSet->enable_reduced_scoring("0"); # defaults to disabled
493 :     $db->putGlobalSet($globalSet);
494 :     $set = $db->getMergedSet($effectiveUserName, $setName);
495 :     }
496 : gage 992
497 : apizer 6158
498 : sh002i 1197 # obtain the merged problem for $effectiveUser
499 : sh002i 1636 my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # checked
500 : toenail 2097
501 : toenail 2349 if ($authz->hasPermissions($userName, "modify_problem_sets")) {
502 : sh002i 1197 # professors are allowed to fabricate sets and problems not
503 :     # assigned to them (or anyone). this allows them to use the
504 :     # editor to
505 : sh002i 2738
506 :     # if a User Set does not exist for this user and this set
507 :     # then we check the Global Set
508 :     # if that does not exist we create a fake set
509 :     # if it does, we add fake user data
510 : sh002i 1197 unless (defined $set) {
511 :     my $userSetClass = $db->{set_user}->{record};
512 : sh002i 1636 my $globalSet = $db->getGlobalSet($setName); # checked
513 : sh002i 2738
514 :     if (not defined $globalSet) {
515 : jj 2020 $set = fake_set($db);
516 :     } else {
517 :     $set = global2user($userSetClass, $globalSet);
518 :     $set->psvn(0);
519 :     }
520 : sh002i 1197 }
521 :    
522 :     # if that is not yet defined obtain the global problem,
523 :     # convert it to a user problem, and add fake user data
524 :     unless (defined $problem) {
525 :     my $userProblemClass = $db->{problem_user}->{record};
526 : sh002i 1636 my $globalProblem = $db->getGlobalProblem($setName, $problemNumber); # checked
527 :     # if the global problem doesn't exist either, bail!
528 : jj 2020 if(not defined $globalProblem) {
529 :     my $sourceFilePath = $r->param("sourceFilePath");
530 : sh002i 4051 die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates}, 1); # 1==path can be relative to dir
531 : jj 2421 # These are problems from setmaker. If declared invalid, they won't come up
532 : jj 2422 $self->{invalidProblem} = $self->{invalidSet} = 1 unless defined $sourceFilePath;
533 : toenail 2398 # die "Problem $problemNumber in set $setName does not exist" unless defined $sourceFilePath;
534 : jj 2020 $problem = fake_problem($db);
535 :     $problem->problem_id(1);
536 :     $problem->source_file($sourceFilePath);
537 :     $problem->user_id($effectiveUserName);
538 :     } else {
539 :     $problem = global2user($userProblemClass, $globalProblem);
540 :     $problem->user_id($effectiveUserName);
541 :     $problem->problem_seed(0);
542 :     $problem->status(0);
543 :     $problem->attempted(0);
544 :     $problem->last_answer("");
545 :     $problem->num_correct(0);
546 :     $problem->num_incorrect(0);
547 :     }
548 : sh002i 1197 }
549 :    
550 :     # now we're sure we have valid UserSet and UserProblem objects
551 :     # yay!
552 :    
553 :     # now deal with possible editor overrides:
554 :    
555 :     # if the caller is asking to override the source file, and
556 :     # editMode calls for a temporary file, do so
557 :     my $sourceFilePath = $r->param("sourceFilePath");
558 : sh002i 4015 if (defined $editMode and $editMode eq "temporaryFile" and defined $sourceFilePath) {
559 : sh002i 4051 die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates}, 1); # 1==path can be relative to dir
560 : sh002i 1197 $problem->source_file($sourceFilePath);
561 :     }
562 :    
563 : toenail 2398 # if the problem does not have a source file or no source file has been passed in
564 :     # then this is really an invalid problem (probably from a bad URL)
565 :     $self->{invalidProblem} = not (defined $sourceFilePath or $problem->source_file);
566 :    
567 : sh002i 1197 # if the caller is asking to override the problem seed, do so
568 :     my $problemSeed = $r->param("problemSeed");
569 :     if (defined $problemSeed) {
570 :     $problem->problem_seed($problemSeed);
571 :     }
572 : toenail 2097
573 : toenail 2244 my $publishedClass = ($set->published) ? "Published" : "Unpublished";
574 : toenail 2278 my $publishedText = ($set->published) ? "visible to students." : "hidden from students.";
575 : gage 5644 $self->addmessage(CGI::span("This set is " . CGI::font({class=>$publishedClass}, $publishedText)));
576 : glarose 3377
577 : glarose 4909 # test for additional problem validity if it's not already invalid
578 : glarose 3377 } else {
579 : sh002i 2738 $self->{invalidProblem} = !(defined $problem and ($set->published || $authz->hasPermissions($userName, "view_unpublished_sets")));
580 :    
581 : toenail 2398 $self->addbadmessage(CGI::p("This problem will not count towards your grade.")) if $problem and not $problem->value and not $self->{invalidProblem};
582 : sh002i 1197 }
583 : toenail 2398
584 : sh002i 1197 $self->{userName} = $userName;
585 :     $self->{effectiveUserName} = $effectiveUserName;
586 :     $self->{user} = $user;
587 :     $self->{effectiveUser} = $effectiveUser;
588 :     $self->{set} = $set;
589 :     $self->{problem} = $problem;
590 :     $self->{editMode} = $editMode;
591 : sh002i 429
592 :     ##### form processing #####
593 :    
594 : sh002i 425 # set options from form fields (see comment at top of file for names)
595 : sh002i 1908 my $displayMode = $r->param("displayMode") || $ce->{pg}->{options}->{displayMode};
596 : sh002i 425 my $redisplay = $r->param("redisplay");
597 : sh002i 429 my $submitAnswers = $r->param("submitAnswers");
598 : sh002i 719 my $checkAnswers = $r->param("checkAnswers");
599 : sh002i 623 my $previewAnswers = $r->param("previewAnswers");
600 : gage 388
601 : sh002i 449 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
602 :    
603 : sh002i 738 $self->{displayMode} = $displayMode;
604 :     $self->{redisplay} = $redisplay;
605 :     $self->{submitAnswers} = $submitAnswers;
606 :     $self->{checkAnswers} = $checkAnswers;
607 :     $self->{previewAnswers} = $previewAnswers;
608 :     $self->{formFields} = $formFields;
609 : toenail 2011
610 : toenail 2093 # get result and send to message
611 : gage 3034 my $status_message = $r->param("status_message");
612 : gage 3055 $self->addmessage(CGI::p("$status_message")) if $status_message;
613 : toenail 2093
614 : toenail 2011 # now that we've set all the necessary variables quit out if the set or problem is invalid
615 :     return if $self->{invalidSet} || $self->{invalidProblem};
616 : sh002i 738
617 : sh002i 449 ##### permissions #####
618 : glarose 4909
619 : sh002i 449 # what does the user want to do?
620 : gage 2998 #FIXME There is a problem with checkboxes -- if they are not checked they are invisible. Hence if the default mode in $ce is 1
621 :     # there is no way to override this. Probably this is ok for the last three options, but it was definitely not ok for showing
622 :     # saved answers which is normally on, but you want to be able to turn it off! This section should be moved to ContentGenerator
623 :     # so that you can set these options anywhere. We also need mechanisms for making them sticky.
624 : jj 3564 # Note: ProblemSet and ProblemSets might set showOldAnswers to '', which
625 :     # needs to be treated as if it is not set.
626 : sh002i 431 my %want = (
627 : jj 3564 showOldAnswers => (defined($r->param("showOldAnswers")) and $r->param("showOldAnswers") ne '') ? $r->param("showOldAnswers") : $ce->{pg}->{options}->{showOldAnswers},
628 : sh002i 1908 showCorrectAnswers => $r->param("showCorrectAnswers") || $ce->{pg}->{options}->{showCorrectAnswers},
629 :     showHints => $r->param("showHints") || $ce->{pg}->{options}->{showHints},
630 :     showSolutions => $r->param("showSolutions") || $ce->{pg}->{options}->{showSolutions},
631 : sh002i 719 recordAnswers => $submitAnswers,
632 : sh002i 747 checkAnswers => $checkAnswers,
633 : jj 2685 getSubmitButton => 1,
634 : sh002i 431 );
635 : sh002i 429
636 : sh002i 431 # are certain options enforced?
637 :     my %must = (
638 :     showOldAnswers => 0,
639 :     showCorrectAnswers => 0,
640 :     showHints => 0,
641 :     showSolutions => 0,
642 : sh002i 2505 recordAnswers => ! $authz->hasPermissions($userName, "avoid_recording_answers"),
643 : sh002i 747 checkAnswers => 0,
644 : jj 2685 getSubmitButton => 0,
645 : sh002i 431 );
646 : gage 3000
647 : sh002i 429 # does the user have permission to use certain options?
648 : sh002i 2762 my @args = ($user, $effectiveUser, $set, $problem);
649 : sh002i 431 my %can = (
650 : sh002i 2505 showOldAnswers => $self->can_showOldAnswers(@args),
651 :     showCorrectAnswers => $self->can_showCorrectAnswers(@args),
652 :     showHints => $self->can_showHints(@args),
653 :     showSolutions => $self->can_showSolutions(@args),
654 : jj 2685 recordAnswers => $self->can_recordAnswers(@args, 0),
655 :     checkAnswers => $self->can_checkAnswers(@args, $submitAnswers),
656 :     getSubmitButton => $self->can_recordAnswers(@args, $submitAnswers),
657 : sh002i 431 );
658 : sh002i 1908
659 : sh002i 429 # final values for options
660 : sh002i 431 my %will;
661 : sh002i 617 foreach (keys %must) {
662 : sh002i 431 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
663 : gage 5636 #warn "final values for options $_ is can $can{$_}, want $want{$_}, must $must{$_}, will $will{$_}";
664 : sh002i 431 }
665 : sh002i 429
666 :     ##### sticky answers #####
667 :    
668 : sh002i 1234 if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) {
669 : sh002i 431 # do this only if new answers are NOT being submitted
670 : sh002i 429 my %oldAnswers = decodeAnswers($problem->last_answer);
671 :     $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
672 :     }
673 :    
674 :     ##### translation #####
675 : gage 1202
676 : sh002i 3485 debug("begin pg processing");
677 : sh002i 424 my $pg = WeBWorK::PG->new(
678 : sh002i 1908 $ce,
679 : malsyned 704 $effectiveUser,
680 : gage 1038 $key,
681 : sh002i 502 $set,
682 :     $problem,
683 : sh002i 1197 $set->psvn, # FIXME: this field should be removed
684 : sh002i 502 $formFields,
685 : sh002i 424 { # translation options
686 : sh002i 434 displayMode => $displayMode,
687 :     showHints => $will{showHints},
688 :     showSolutions => $will{showSolutions},
689 :     refreshMath2img => $will{showHints} || $will{showSolutions},
690 : dpvc 5314 processAnswers => 1,
691 : gage 5715 permissionLevel => $db->getPermissionLevel($userName)->permission,
692 : gage 6086 effectivePermissionLevel => $db->getPermissionLevel($effectiveUserName)->permission,
693 : sh002i 424 },
694 :     );
695 : gage 5715
696 : sh002i 3485 debug("end pg processing");
697 : sh002i 2505
698 : sh002i 684 ##### fix hint/solution options #####
699 :    
700 : gage 1582 $can{showHints} &&= $pg->{flags}->{hintExists}
701 :     &&= $pg->{flags}->{showHintLimit}<=$pg->{state}->{num_of_incorrect_ans};
702 : sh002i 684 $can{showSolutions} &&= $pg->{flags}->{solutionExists};
703 :    
704 : sh002i 449 ##### store fields #####
705 :    
706 :     $self->{want} = \%want;
707 :     $self->{must} = \%must;
708 :     $self->{can} = \%can;
709 :     $self->{will} = \%will;
710 :     $self->{pg} = $pg;
711 :     }
712 :    
713 : sh002i 558 sub if_errors($$) {
714 :     my ($self, $arg) = @_;
715 : sh002i 1908
716 :     if ($self->{isOpen}) {
717 :     return $self->{pg}->{flags}->{error_flag} ? $arg : !$arg;
718 :     } else {
719 :     return !$arg;
720 :     }
721 : sh002i 558 }
722 :    
723 : sh002i 562 sub head {
724 : sh002i 1908 my ($self) = @_;
725 : glarose 4909
726 :     return "" if ( $self->{invalidSet} );
727 : sh002i 555 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
728 :     }
729 : sh002i 476
730 : sh002i 3481 sub options {
731 :     my ($self) = @_;
732 :     #warn "doing options in Problem";
733 :    
734 :     # don't show options if we don't have anything to show
735 : sh002i 3798 return "" if $self->{invalidSet} or $self->{invalidProblem};
736 : sh002i 3481
737 :     my $displayMode = $self->{displayMode};
738 :     my %can = %{ $self->{can} };
739 :    
740 :     my @options_to_show = "displayMode";
741 :     push @options_to_show, "showOldAnswers" if $can{showOldAnswers};
742 :     push @options_to_show, "showHints" if $can{showHints};
743 :     push @options_to_show, "showSolutions" if $can{showSolutions};
744 :    
745 :     return $self->optionsMacro(
746 :     options_to_show => \@options_to_show,
747 :     extra_params => ["editMode", "sourceFilePath"],
748 :     );
749 :     }
750 : sh002i 1131
751 : sh002i 476 sub siblings {
752 : sh002i 1908 my ($self) = @_;
753 :     my $r = $self->r;
754 :     my $db = $r->db;
755 :     my $urlpath = $r->urlpath;
756 : sh002i 476
757 : toenail 2011 # can't show sibling problems if the set is invalid
758 :     return "" if $self->{invalidSet};
759 :    
760 : sh002i 1908 my $courseID = $urlpath->arg("courseID");
761 :     my $setID = $self->{set}->set_id;
762 :     my $eUserID = $r->param("effectiveUser");
763 :     my @problemIDs = sort { $a <=> $b } $db->listUserProblems($eUserID, $setID);
764 : sh002i 526
765 : sh002i 3963 print CGI::start_div({class=>"info-box", id=>"fisheye"});
766 :     print CGI::h2("Problems");
767 : sh002i 3836 #print CGI::start_ul({class=>"LinksMenu"});
768 :     #print CGI::start_li();
769 :     #print CGI::span({style=>"font-size:larger"}, "Problems");
770 : sh002i 1908 print CGI::start_ul();
771 : toenail 2211
772 : sh002i 1908 foreach my $problemID (@problemIDs) {
773 :     my $problemPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Problem",
774 :     courseID => $courseID, setID => $setID, problemID => $problemID);
775 : gage 2998 print CGI::li(CGI::a( {href=>$self->systemLink($problemPage,
776 :     params=>{ displayMode => $self->{displayMode},
777 : gage 3000 showOldAnswers => $self->{will}->{showOldAnswers}
778 : gage 2998 })}, "Problem $problemID")
779 :     );
780 : sh002i 476 }
781 : dpvc 5966
782 : sh002i 1908 print CGI::end_ul();
783 : sh002i 3836 #print CGI::end_li();
784 :     #print CGI::end_ul();
785 : sh002i 3963 print CGI::end_div();
786 : dpvc 5966
787 : sh002i 1223 return "";
788 : sh002i 476 }
789 :    
790 :     sub nav {
791 : sh002i 1908 my ($self, $args) = @_;
792 :     my $r = $self->r;
793 :     my $db = $r->db;
794 :     my $urlpath = $r->urlpath;
795 : dpvc 5966
796 : glarose 4909 return "" if ( $self->{invalidSet} );
797 :    
798 : sh002i 1908 my $courseID = $urlpath->arg("courseID");
799 : toenail 2011 my $setID = $self->{set}->set_id if !($self->{invalidSet});
800 :     my $problemID = $self->{problem}->problem_id if !($self->{invalidProblem});
801 : sh002i 1908 my $eUserID = $r->param("effectiveUser");
802 : dpvc 5966
803 : sh002i 1908 my ($prevID, $nextID);
804 : toenail 2011
805 : dpvc 5966 if (!$self->{invalidProblem}) {
806 : toenail 2011 my @problemIDs = $db->listUserProblems($eUserID, $setID);
807 :     foreach my $id (@problemIDs) {
808 :     $prevID = $id if $id < $problemID
809 :     and (not defined $prevID or $id > $prevID);
810 :     $nextID = $id if $id > $problemID
811 :     and (not defined $nextID or $id < $nextID);
812 :     }
813 : sh002i 1223 }
814 : dpvc 5966
815 : sh002i 1908 my @links;
816 : dpvc 5966
817 : sh002i 1908 if ($prevID) {
818 :     my $prevPage = $urlpath->newFromModule(__PACKAGE__,
819 :     courseID => $courseID, setID => $setID, problemID => $prevID);
820 :     push @links, "Previous Problem", $r->location . $prevPage->path, "navPrev";
821 :     } else {
822 : dpvc 5605 push @links, "Previous Problem", "", "navPrevGrey";
823 : sh002i 1908 }
824 : dpvc 5966
825 :     if (defined($setID) && $setID ne 'Undefined_Set') {
826 :     push @links, "Problem List", $r->location . $urlpath->parent->path, "navProbList";
827 :     } else {
828 :     push @links, "Problem List", "", "navProbListGrey";
829 :     }
830 :    
831 : sh002i 1908 if ($nextID) {
832 :     my $nextPage = $urlpath->newFromModule(__PACKAGE__,
833 :     courseID => $courseID, setID => $setID, problemID => $nextID);
834 :     push @links, "Next Problem", $r->location . $nextPage->path, "navNext";
835 :     } else {
836 : dpvc 5605 push @links, "Next Problem", "", "navNextGrey";
837 : sh002i 1908 }
838 : dpvc 5966
839 : sh002i 3798 my $tail = "";
840 : dpvc 5966
841 : sh002i 3798 $tail .= "&displayMode=".$self->{displayMode} if defined $self->{displayMode};
842 :     $tail .= "&showOldAnswers=".$self->{will}->{showOldAnswers}
843 :     if defined $self->{will}->{showOldAnswers};
844 : sh002i 1908 return $self->navMacro($args, $tail, @links);
845 : sh002i 476 }
846 :    
847 : sh002i 449 sub title {
848 : sh002i 1908 my ($self) = @_;
849 : toenail 2011
850 :     # using the url arguments won't break if the set/problem are invalid
851 : jj 3533 my $setID = WeBWorK::ContentGenerator::underscore2nbsp($self->r->urlpath->arg("setID"));
852 : toenail 2011 my $problemID = $self->r->urlpath->arg("problemID");
853 : dpvc 5966
854 : sh002i 2767 return "$setID: Problem $problemID";
855 : sh002i 449 }
856 :    
857 :     sub body {
858 :     my $self = shift;
859 : sh002i 1908 my $r = $self->r;
860 :     my $ce = $r->ce;
861 :     my $db = $r->db;
862 : toenail 2349 my $authz = $r->authz;
863 : sh002i 1908 my $urlpath = $r->urlpath;
864 : toenail 2349 my $user = $r->param('user');
865 : sh002i 2507 my $effectiveUser = $r->param('effectiveUser');
866 : toenail 2011
867 : glarose 4909 if ( $self->{invalidSet} ) {
868 : toenail 2011 return CGI::div({class=>"ResultsWithError"},
869 : glarose 4909 CGI::p("The selected problem set (" .
870 :     $urlpath->arg("setID") . ") is not " .
871 :     "a valid set for $effectiveUser:"),
872 :     CGI::p($self->{invalidSet}));
873 :     }
874 : sh002i 449
875 : toenail 2011 if ($self->{invalidProblem}) {
876 :     return CGI::div({class=>"ResultsWithError"},
877 :     CGI::p("The selected problem (" . $urlpath->arg("problemID") . ") is not a valid problem for set " . $self->{set}->set_id . "."));
878 :     }
879 :    
880 : sh002i 449 # unpack some useful variables
881 : sh002i 476 my $set = $self->{set};
882 :     my $problem = $self->{problem};
883 : sh002i 1197 my $editMode = $self->{editMode};
884 : sh002i 476 my $submitAnswers = $self->{submitAnswers};
885 : sh002i 719 my $checkAnswers = $self->{checkAnswers};
886 : sh002i 623 my $previewAnswers = $self->{previewAnswers};
887 : sh002i 719 my %want = %{ $self->{want} };
888 : sh002i 1197 my %can = %{ $self->{can} };
889 : sh002i 719 my %must = %{ $self->{must} };
890 : sh002i 476 my %will = %{ $self->{will} };
891 :     my $pg = $self->{pg};
892 : sh002i 449
893 : sh002i 1908 my $courseName = $urlpath->arg("courseID");
894 : gage 1592
895 : sh002i 2505 # FIXME: move editor link to top, next to problem number.
896 :     # format as "[edit]" like we're doing with course info file, etc.
897 :     # add edit link for set as well.
898 : sh002i 1908 my $editorLink = "";
899 : dpvc 4158 # if we are here without a real homework set, carry that through
900 : jj 2020 my $forced_field = [];
901 :     $forced_field = ['sourceFilePath' => $r->param("sourceFilePath")] if
902 :     ($set->set_id eq 'Undefined_Set');
903 : toenail 2398 if ($authz->hasPermissions($user, "modify_problem_sets")) {
904 : sh002i 1908 my $editorPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::PGProblemEditor",
905 :     courseID => $courseName, setID => $set->set_id, problemID => $problem->problem_id);
906 : jj 2020 my $editorURL = $self->systemLink($editorPage, params=>$forced_field);
907 : gage 3888 $editorLink = CGI::p(CGI::a({href=>$editorURL,target =>'WW_Editor'}, "Edit this problem"));
908 : gage 1592 }
909 : sh002i 1908
910 : sh002i 449 ##### translation errors? #####
911 : gage 2861
912 : sh002i 425 if ($pg->{flags}->{error_flag}) {
913 : sh002i 3795 if ($authz->hasPermissions($user, "view_problem_debugging_info")) {
914 :     print $self->errorOutput($pg->{errors}, $pg->{body_text});
915 :     } else {
916 :     print $self->errorOutput($pg->{errors}, "You do not have permission to view the details of this error.");
917 :     }
918 : sh002i 1908 print $editorLink;
919 :     return "";
920 : sh002i 425 }
921 : sh002i 415
922 : sh002i 429 ##### answer processing #####
923 : sh002i 3485 debug("begin answer processing");
924 : sh002i 429 # if answers were submitted:
925 : sh002i 1227 my $scoreRecordedMessage;
926 : jjholt 2156 my $pureProblem;
927 : sh002i 429 if ($submitAnswers) {
928 : sh002i 818 # get a "pure" (unmerged) UserProblem to modify
929 : gage 1007 # this will be undefined if the problem has not been assigned to this user
930 : jjholt 2156 $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id); # checked
931 : sh002i 1227 if (defined $pureProblem) {
932 :     # store answers in DB for sticky answers
933 :     my %answersToStore;
934 :     my %answerHash = %{ $pg->{answers} };
935 : gage 1539 $answersToStore{$_} = $self->{formFields}->{$_} #$answerHash{$_}->{original_student_ans} -- this may have been modified for fields with multiple values. Don't use it!!
936 : sh002i 1227 foreach (keys %answerHash);
937 : sh002i 1908
938 : gage 1507 # There may be some more answers to store -- one which are auxiliary entries to a primary answer. Evaluating
939 :     # matrices works in this way, only the first answer triggers an answer evaluator, the rest are just inputs
940 :     # however we need to store them. Fortunately they are still in the input form.
941 :     my @extra_answer_names = @{ $pg->{flags}->{KEPT_EXTRA_ANSWERS}};
942 : gage 1539 $answersToStore{$_} = $self->{formFields}->{$_} foreach (@extra_answer_names);
943 : gage 1507
944 :     # Now let's encode these answers to store them -- append the extra answers to the end of answer entry order
945 :     my @answer_order = (@{$pg->{flags}->{ANSWER_ENTRY_ORDER}}, @extra_answer_names);
946 : sh002i 1227 my $answerString = encodeAnswers(%answersToStore,
947 : gage 1507 @answer_order);
948 : sh002i 1227
949 :     # store last answer to database
950 :     $problem->last_answer($answerString);
951 : gage 1007 $pureProblem->last_answer($answerString);
952 :     $db->putUserProblem($pureProblem);
953 : sh002i 1227
954 : gage 1007 # store state in DB if it makes sense
955 :     if ($will{recordAnswers}) {
956 :     $problem->status($pg->{state}->{recorded_score});
957 : apizer 6149 $problem->sub_status($pg->{state}->{sub_recorded_score});
958 : gage 1007 $problem->attempted(1);
959 :     $problem->num_correct($pg->{state}->{num_of_correct_ans});
960 :     $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
961 :     $pureProblem->status($pg->{state}->{recorded_score});
962 : apizer 6149 $pureProblem->sub_status($pg->{state}->{sub_recorded_score});
963 : gage 1007 $pureProblem->attempted(1);
964 :     $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
965 :     $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
966 : sh002i 1227 if ($db->putUserProblem($pureProblem)) {
967 :     $scoreRecordedMessage = "Your score was recorded.";
968 :     } else {
969 :     $scoreRecordedMessage = "Your score was not recorded because there was a failure in storing the problem record to the database.";
970 :     }
971 : gage 1007 # write to the transaction log, just to make sure
972 :     writeLog($self->{ce}, "transaction",
973 :     $problem->problem_id."\t".
974 :     $problem->set_id."\t".
975 :     $problem->user_id."\t".
976 :     $problem->source_file."\t".
977 :     $problem->value."\t".
978 :     $problem->max_attempts."\t".
979 :     $problem->problem_seed."\t".
980 :     $pureProblem->status."\t".
981 :     $pureProblem->attempted."\t".
982 :     $pureProblem->last_answer."\t".
983 :     $pureProblem->num_correct."\t".
984 :     $pureProblem->num_incorrect
985 :     );
986 : sh002i 1227 } else {
987 : sh002i 2505 if (before($set->open_date) or after($set->due_date)) {
988 : sh002i 3357 $scoreRecordedMessage = "Your score was not recorded because this homework set is closed.";
989 : sh002i 1227 } else {
990 :     $scoreRecordedMessage = "Your score was not recorded.";
991 :     }
992 : gage 1007 }
993 : sh002i 1227 } else {
994 : sh002i 2505 $scoreRecordedMessage = "Your score was not recorded because this problem has not been assigned to you.";
995 : sh002i 431 }
996 : sh002i 425 }
997 : sh002i 1227
998 : gage 794 # logging student answers
999 : gage 1387
1000 :     my $answer_log = $self->{ce}->{courseFiles}->{logs}->{'answer_log'};
1001 : jjholt 2156 if ( defined($answer_log ) and defined($pureProblem)) {
1002 : dpvc 2735 if ($submitAnswers && !$authz->hasPermissions($effectiveUser, "dont_log_past_answers")) {
1003 :     my $answerString = ""; my $scores = "";
1004 : gage 794 my %answerHash = %{ $pg->{answers} };
1005 : gage 1775 # FIXME this is the line 552 error. make sure original student ans is defined.
1006 :     # The fact that it is not defined is probably due to an error in some answer evaluator.
1007 :     # But I think it is useful to suppress this error message in the log.
1008 : apizer 4030 foreach (sortByName(undef, keys %answerHash)) {
1009 : sh002i 2635 my $orig_ans = $answerHash{$_}->{original_student_ans};
1010 :     my $student_ans = defined $orig_ans ? $orig_ans : '';
1011 : dpvc 2735 $answerString .= $student_ans."\t";
1012 :     $scores .= $answerHash{$_}->{score} >= 1 ? "1" : "0";
1013 : gage 1776 }
1014 :     $answerString = '' unless defined($answerString); # insure string is defined.
1015 : gage 1387 writeCourseLog($self->{ce}, "answer_log",
1016 :     join("",
1017 :     '|', $problem->user_id,
1018 :     '|', $problem->set_id,
1019 :     '|', $problem->problem_id,
1020 : dpvc 2735 '|', $scores, "\t",
1021 : gage 1387 time(),"\t",
1022 :     $answerString,
1023 :     ),
1024 :     );
1025 :    
1026 : gage 794 }
1027 : sh002i 1223 }
1028 :    
1029 : sh002i 3485 debug("end answer processing");
1030 : Mgage 6293 ##### javaScripts #############
1031 :     my $site_url = $ce->{webworkURLs}->{htdocs};
1032 :     print qq!<script type="text/javascript" src="$site_url/js/wz_tooltip.js"></script>!;
1033 : sh002i 1223
1034 : Mgage 6293
1035 : sh002i 429 ##### output #####
1036 : sh002i 1197 # custom message for editor
1037 : toenail 2349 if ($authz->hasPermissions($user, "modify_problem_sets") and defined $editMode) {
1038 : sh002i 1197 if ($editMode eq "temporaryFile") {
1039 : gage 3034 print CGI::p(CGI::div({class=>'temporaryFile'}, "Viewing temporary file: ", $problem->source_file));
1040 : sh002i 1197 } elsif ($editMode eq "savedFile") {
1041 : toenail 2349 # taken care of in the initialization phase
1042 : sh002i 1197 }
1043 :     }
1044 : gage 3034 print CGI::start_div({class=>"problemHeader"});
1045 :    
1046 :    
1047 : toenail 2349
1048 : sh002i 431 # attempt summary
1049 : gage 1480 #FIXME -- the following is a kludge: if showPartialCorrectAnswers is negative don't show anything.
1050 :     # until after the due date
1051 : toenail 2398 # do I need to check $will{showCorrectAnswers} to make preflight work??
1052 : sh002i 2505 if (($pg->{flags}->{showPartialCorrectAnswers} >= 0 and $submitAnswers) ) {
1053 : sh002i 431 # print this if user submitted answers OR requested correct answers
1054 : gage 1480
1055 : gage 1507 print $self->attemptResults($pg, 1,
1056 : sh002i 719 $will{showCorrectAnswers},
1057 : gage 939 $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
1058 : sh002i 719 } elsif ($checkAnswers) {
1059 :     # print this if user previewed answers
1060 : sh002i 2767 print CGI::div({class=>'ResultsWithError'},"ANSWERS ONLY CHECKED -- ANSWERS NOT RECORDED"), CGI::br();
1061 : gage 1507 print $self->attemptResults($pg, 1, $will{showCorrectAnswers}, 1, 1, 1);
1062 : sh002i 719 # show attempt answers
1063 : gage 1507 # show correct answers if asked
1064 : sh002i 719 # show attempt results (correctness)
1065 : gage 1507 # show attempt previews
1066 : sh002i 623 } elsif ($previewAnswers) {
1067 :     # print this if user previewed answers
1068 : sh002i 2767 print CGI::div({class=>'ResultsWithError'},"PREVIEW ONLY -- ANSWERS NOT RECORDED"),CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1);
1069 : sh002i 719 # show attempt answers
1070 : sh002i 623 # don't show correct answers
1071 : sh002i 719 # don't show attempt results (correctness)
1072 :     # show attempt previews
1073 : sh002i 431 }
1074 : gage 392
1075 : malsyned 755 print CGI::end_div();
1076 :    
1077 : sh002i 2505 # main form
1078 : gage 4090 print "\n";
1079 : gage 5678 print CGI::start_form(-method=>"POST", -action=> $r->uri,-name=>"problemMainForm", onsubmit=>"submitAction()");
1080 : sh002i 2505 print $self->hidden_authen_fields;
1081 : gage 4090 print "\n";
1082 : malsyned 755 print CGI::start_div({class=>"problem"});
1083 : sh002i 2505 print CGI::p($pg->{body_text});
1084 : gage 4235 print CGI::p(CGI::b("Note: "). CGI::i($pg->{result}->{msg})) if $pg->{result}->{msg};
1085 : sh002i 3626 print $editorLink; # this is empty unless it is appropriate to have an editor link.
1086 : sh002i 2505 print CGI::end_div();
1087 :    
1088 :     print CGI::start_p();
1089 :    
1090 :     if ($can{showCorrectAnswers}) {
1091 :     print CGI::checkbox(
1092 :     -name => "showCorrectAnswers",
1093 :     -checked => $will{showCorrectAnswers},
1094 :     -label => "Show correct answers",
1095 : gage 5636 -value => 1,
1096 : malsyned 755 );
1097 : sh002i 2505 }
1098 :     if ($can{showHints}) {
1099 :     print CGI::div({style=>"color:red"},
1100 :     CGI::checkbox(
1101 :     -name => "showHints",
1102 :     -checked => $will{showHints},
1103 :     -label => "Show Hints",
1104 : gage 5636 -value =>1,
1105 : sh002i 2505 )
1106 :     );
1107 :     }
1108 :     if ($can{showSolutions}) {
1109 :     print CGI::checkbox(
1110 :     -name => "showSolutions",
1111 :     -checked => $will{showSolutions},
1112 :     -label => "Show Solutions",
1113 : gage 5636 -value => 1,
1114 : sh002i 2505 );
1115 :     }
1116 :    
1117 :     if ($can{showCorrectAnswers} or $can{showHints} or $can{showSolutions}) {
1118 :     print CGI::br();
1119 :     }
1120 :    
1121 :     print CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers");
1122 :     if ($can{checkAnswers}) {
1123 :     print CGI::submit(-name=>"checkAnswers", -label=>"Check Answers");
1124 :     }
1125 : jj 2685 if ($can{getSubmitButton}) {
1126 : sh002i 2507 if ($user ne $effectiveUser) {
1127 :     # if acting as a student, make it clear that answer submissions will
1128 :     # apply to the student's records, not the professor's.
1129 :     print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers for $effectiveUser");
1130 :     } else {
1131 : gage 5678 #print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers", -onclick=>"alert('submit button clicked')");
1132 :     print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers", -onclick=>"");
1133 :     # FIXME for unknown reasons the -onclick label seems to have to be there in order to allow the forms onsubmit to trigger
1134 :     # WFT???
1135 : sh002i 2507 }
1136 : sh002i 2505 }
1137 :    
1138 :     print CGI::end_p();
1139 :    
1140 : gage 794 print CGI::start_div({class=>"scoreSummary"});
1141 : sh002i 1131
1142 : sh002i 431 # score summary
1143 :     my $attempts = $problem->num_correct + $problem->num_incorrect;
1144 :     my $attemptsNoun = $attempts != 1 ? "times" : "time";
1145 : gage 2875 my $problem_status = $problem->status || 0;
1146 :     my $lastScore = sprintf("%.0f%%", $problem_status * 100); # Round to whole number
1147 : sh002i 431 my ($attemptsLeft, $attemptsLeftNoun);
1148 :     if ($problem->max_attempts == -1) {
1149 :     # unlimited attempts
1150 :     $attemptsLeft = "unlimited";
1151 :     $attemptsLeftNoun = "attempts";
1152 :     } else {
1153 :     $attemptsLeft = $problem->max_attempts - $attempts;
1154 :     $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
1155 :     }
1156 : malsyned 755
1157 :     my $setClosed = 0;
1158 : sh002i 476 my $setClosedMessage;
1159 : sh002i 2505 if (before($set->open_date) or after($set->due_date)) {
1160 : malsyned 755 $setClosed = 1;
1161 : sh002i 3318 if (before($set->open_date)) {
1162 : sh002i 3357 $setClosedMessage = "This homework set is not yet open.";
1163 : sh002i 3318 } elsif (after($set->due_date)) {
1164 : sh002i 3357 $setClosedMessage = "This homework set is closed.";
1165 : sh002i 476 }
1166 :     }
1167 : sh002i 3318 #if (before($set->open_date) or after($set->due_date)) {
1168 :     # $setClosed = 1;
1169 : sh002i 3357 # $setClosedMessage = "This homework set is closed.";
1170 : sh002i 3318 # if ($authz->hasPermissions($user, "view_answers")) {
1171 :     # $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
1172 :     # } else {
1173 :     # $setClosedMessage .= " Additional attempts will not be recorded.";
1174 :     # }
1175 :     #}
1176 : gage 3391 unless (defined( $pg->{state}->{state_summary_msg}) and $pg->{state}->{state_summary_msg}=~/\S/) {
1177 :     my $notCountedMessage = ($problem->value) ? "" : "(This problem will not count towards your grade.)";
1178 : gage 4235 print CGI::p(join("",
1179 : gage 3391 $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
1180 :     "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
1181 :     $submitAnswers ?"You received a score of ".sprintf("%.0f%%", $pg->{result}->{score} * 100)." for this attempt.".CGI::br():'',
1182 :     $problem->attempted
1183 :     ? "Your overall recorded score is $lastScore. $notCountedMessage" . CGI::br()
1184 :     : "",
1185 :     $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
1186 : gage 4235 ));
1187 : gage 3391 }else {
1188 :     print CGI::p($pg->{state}->{state_summary_msg});
1189 :     }
1190 : gage 6310
1191 : gage 794 print CGI::end_div();
1192 : gage 6310 print CGI::start_div();
1193 :     print CGI::p({style=>"color:red;"}, "Checking additional error messages");
1194 :     #print CGI::p( "pgcore".ref($pg->{pgcore}));
1195 :     print CGI::p("pg debug<br/>".join(CGI::br(), @{$pg->{pgcore}->{flags}->{DEBUG_messages}} ) );
1196 :     print CGI::p("pg warning<br/>".join(CGI::br(), @{$pg->{pgcore}->{flags}->{WARNING_messages}} ) );
1197 :     print CGI::p("pg internal errors<br/>".join(CGI::br(), @{$pg->{pgcore}->get_internal_debug_messages} ) );
1198 :     print CGI::end_div();
1199 : sh002i 1131 # save state for viewOptions
1200 : gage 1591 print CGI::hidden(
1201 :     -name => "showOldAnswers",
1202 :     -value => $will{showOldAnswers}
1203 :     ),
1204 : gage 1479
1205 : gage 1591 CGI::hidden(
1206 :     -name => "displayMode",
1207 :     -value => $self->{displayMode}
1208 :     );
1209 :     print( CGI::hidden(
1210 :     -name => 'editMode',
1211 :     -value => $self->{editMode},
1212 :     )
1213 :     ) if defined($self->{editMode}) and $self->{editMode} eq 'temporaryFile';
1214 : gage 6237
1215 :     # this is a security risk -- students can use this to find the source code for the problem
1216 : gage 6275
1217 : gage 6274 my $permissionLevel = $db->getPermissionLevel($user)->permission;
1218 :     my $professorPermissionLevel = $ce->{userRoles}->{professor};
1219 :     print( CGI::hidden(
1220 :     -name => 'sourceFilePath',
1221 :     -value => $self->{problem}->{source_file}
1222 :     )) if defined($self->{problem}->{source_file}) and $permissionLevel>= $professorPermissionLevel; # only allow this for professors
1223 : jj 2251
1224 : gage 6274 print( CGI::hidden(
1225 :     -name => 'problemSeed',
1226 :     -value => $r->param("problemSeed")
1227 :     )) if defined($r->param("problemSeed")) and $permissionLevel>= $professorPermissionLevel; # only allow this for professors
1228 : gage 6275
1229 : gage 1591
1230 : sh002i 1131 # end of main form
1231 :     print CGI::endform();
1232 :    
1233 :     print CGI::start_div({class=>"problemFooter"});
1234 :    
1235 : gage 794
1236 : sh002i 1908 my $pastAnswersPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::ShowAnswers",
1237 :     courseID => $courseName);
1238 :     my $showPastAnswersURL = $self->systemLink($pastAnswersPage, authen => 0); # no authen info for form action
1239 :    
1240 : gage 794 # print answer inspection button
1241 : toenail 2398 if ($authz->hasPermissions($user, "view_answers")) {
1242 : gage 794 print "\n",
1243 : dpvc 4389 CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"WW_Info"),"\n",
1244 : sh002i 1131 $self->hidden_authen_fields,"\n",
1245 : gage 1937 CGI::hidden(-name => 'courseID', -value=>$courseName), "\n",
1246 :     CGI::hidden(-name => 'problemID', -value=>$problem->problem_id), "\n",
1247 :     CGI::hidden(-name => 'setID', -value=>$problem->set_id), "\n",
1248 : gage 1395 CGI::hidden(-name => 'studentUser', -value=>$problem->user_id), "\n",
1249 : sh002i 1131 CGI::p( {-align=>"left"},
1250 :     CGI::submit(-name => 'action', -value=>'Show Past Answers')
1251 :     ), "\n",
1252 :     CGI::endform();
1253 :     }
1254 : sh002i 667
1255 : gage 794
1256 : sh002i 3626 print $self->feedbackMacro(
1257 :     module => __PACKAGE__,
1258 :     set => $self->{set}->set_id,
1259 :     problem => $problem->problem_id,
1260 :     displayMode => $self->{displayMode},
1261 :     showOldAnswers => $will{showOldAnswers},
1262 :     showCorrectAnswers => $will{showCorrectAnswers},
1263 :     showHints => $will{showHints},
1264 :     showSolutions => $will{showSolutions},
1265 : gage 6041 pg_object => $pg,
1266 : sh002i 3626 );
1267 : sh002i 1908
1268 : sh002i 1131 print CGI::end_div();
1269 : gage 940
1270 : sh002i 424 # debugging stuff
1271 : sh002i 747 if (0) {
1272 : sh002i 738 print
1273 :     CGI::hr(),
1274 :     CGI::h2("debugging information"),
1275 :     CGI::h3("form fields"),
1276 :     ref2string($self->{formFields}),
1277 :     CGI::h3("user object"),
1278 :     ref2string($self->{user}),
1279 :     CGI::h3("set object"),
1280 :     ref2string($set),
1281 :     CGI::h3("problem object"),
1282 :     ref2string($problem),
1283 :     CGI::h3("PG object"),
1284 :     ref2string($pg, {'WeBWorK::PG::Translator' => 1});
1285 :     }
1286 : gage 6260 debug("leaving body of Problem.pm");
1287 : sh002i 424 return "";
1288 : malsyned 353 }
1289 :    
1290 : jj 2539 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9