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

Annotation of /trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : sh002i 449 ################################################################################
2 : sh002i 494 # WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
3 : sh002i 449 # $Id$
4 :     ################################################################################
5 :    
6 : malsyned 353 package WeBWorK::ContentGenerator::Problem;
7 : sh002i 818 use base qw(WeBWorK::ContentGenerator);
8 : malsyned 396
9 : sh002i 455 =head1 NAME
10 : gage 1039
11 : sh002i 455 WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
12 :    
13 :     =cut
14 : gage 1202 my $timer0_ON=0; # times pg translation phase
15 : malsyned 396 use strict;
16 :     use warnings;
17 : sh002i 449 use CGI qw();
18 : sh002i 919 use File::Path qw(rmtree);
19 : sh002i 455 use WeBWorK::Form;
20 :     use WeBWorK::PG;
21 : sh002i 623 use WeBWorK::PG::IO;
22 : sh002i 1147 use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string makeTempDirectory);
23 : gage 997 use WeBWorK::DB::Utils qw(global2user user2global findDefaults);
24 : gage 1190 use WeBWorK::Timing;
25 : sh002i 1223
26 : sh002i 449 ############################################################
27 :     #
28 : sh002i 424 # user
29 : malsyned 704 # effectiveUser
30 : sh002i 424 # key
31 : sh002i 415 #
32 : sh002i 424 # displayMode
33 :     # showOldAnswers
34 :     # showCorrectAnswers
35 :     # showHints
36 :     # showSolutions
37 : sh002i 415 #
38 : sh002i 425 # AnSwEr# - answer blanks in problem
39 :     #
40 : sh002i 429 # redisplay - name of the "Redisplay Problem" button
41 :     # submitAnswers - name of "Submit Answers" button
42 : sh002i 818 # checkAnswers - name of the "Check Answers" button
43 :     # previewAnswers - name of the "Preview Answers" button
44 : sh002i 449 #
45 :     ############################################################
46 : gage 392
47 : sh002i 476 sub pre_header_initialize {
48 : sh002i 424 my ($self, $setName, $problemNumber) = @_;
49 : gage 1038 my $r = $self->{r};
50 :     my $courseEnv = $self->{ce};
51 :     my $db = $self->{db};
52 :     my $userName = $r->param('user');
53 :     my $effectiveUserName = $r->param('effectiveUser');
54 : sh002i 1197 my $key = $r->param('key');
55 : gage 997 my $user = $db->getUser($userName);
56 :     my $effectiveUser = $db->getUser($effectiveUserName);
57 : sh002i 1197 my $permissionLevel = $db->getPermissionLevel($userName)->permission();
58 : gage 1007
59 : sh002i 1197 # obtain the merged set for $effectiveUser
60 :     my $set = $db->getMergedSet($effectiveUserName, $setName);
61 : gage 992
62 : sh002i 1197 # obtain the merged problem for $effectiveUser
63 :     my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber);
64 : gage 993
65 : sh002i 1197 my $editMode = $r->param("editMode");
66 : gage 992
67 : sh002i 1197 if ($permissionLevel > 0 and defined $editMode) {
68 :     # professors are allowed to fabricate sets and problems not
69 :     # assigned to them (or anyone). this allows them to use the
70 :     # editor to
71 :    
72 :     # if that is not yet defined obtain the global set, convert
73 :     # it to a user set, and add fake user data
74 :     unless (defined $set) {
75 :     my $userSetClass = $db->{set_user}->{record};
76 :     $set = global2user($userSetClass,
77 :     $db->getGlobalSet($setName));
78 :     die "Set $setName does not exist"
79 :     unless defined $set;
80 :     $set->psvn(0);
81 :     }
82 :    
83 :     # if that is not yet defined obtain the global problem,
84 :     # convert it to a user problem, and add fake user data
85 :     unless (defined $problem) {
86 :     my $userProblemClass = $db->{problem_user}->{record};
87 :     $problem = global2user($userProblemClass,
88 :     $db->getGlobalProblem($setName,$problemNumber));
89 :     die "Problem $problemNumber in set $setName does not exist"
90 :     unless defined $problem;
91 :     $problem->user_id($effectiveUserName);
92 :     $problem->problem_seed(0);
93 :     $problem->status(0);
94 :     $problem->attempted(0);
95 :     $problem->last_answer("");
96 :     $problem->num_correct(0);
97 :     $problem->num_incorrect(0);
98 :     }
99 :    
100 :     # now we're sure we have valid UserSet and UserProblem objects
101 :     # yay!
102 :    
103 :     # now deal with possible editor overrides:
104 :    
105 :     # if the caller is asking to override the source file, and
106 :     # editMode calls for a temporary file, do so
107 :     my $sourceFilePath = $r->param("sourceFilePath");
108 :     if (defined $sourceFilePath and $editMode eq "temporaryFile") {
109 :     $problem->source_file($sourceFilePath);
110 :     }
111 :    
112 :     # if the caller is asking to override the problem seed, do so
113 :     my $problemSeed = $r->param("problemSeed");
114 :     if (defined $problemSeed) {
115 :     $problem->problem_seed($problemSeed);
116 :     }
117 :     } else {
118 :     # students can't view problems not assigned to them
119 :     die "Set $setName is not assigned to $effectiveUserName"
120 :     unless defined $set;
121 :     die "Problem $problemNumber in set $setName is not assigned to $effectiveUserName"
122 :     unless defined $problem;
123 :     }
124 : gage 992
125 : sh002i 1197 $self->{userName} = $userName;
126 :     $self->{effectiveUserName} = $effectiveUserName;
127 :     $self->{user} = $user;
128 :     $self->{effectiveUser} = $effectiveUser;
129 :     $self->{permissionLevel} = $permissionLevel;
130 :     $self->{set} = $set;
131 :     $self->{problem} = $problem;
132 :     $self->{editMode} = $editMode;
133 : sh002i 429
134 :     ##### form processing #####
135 :    
136 : sh002i 425 # set options from form fields (see comment at top of file for names)
137 : sh002i 692 my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode};
138 : sh002i 425 my $redisplay = $r->param("redisplay");
139 : sh002i 429 my $submitAnswers = $r->param("submitAnswers");
140 : sh002i 719 my $checkAnswers = $r->param("checkAnswers");
141 : sh002i 623 my $previewAnswers = $r->param("previewAnswers");
142 : gage 388
143 : gage 926 # fields which may be defined when using Problem Editor
144 : sh002i 1197 #my $override_seed = ($permissionLevel>=10) ? $r->param('problemSeed') : undef;
145 :     #my $override_problem_source = ($permissionLevel>=10) ? $r->param('sourceFilePath') : undef;
146 :     #my $editMode = undef;
147 :     #my $submit_button = $r->param('submit_button');
148 :     #if ( defined($submit_button ) ) {
149 :     # $editMode = "temporaryFile" if $submit_button eq 'Refresh';
150 :     # $editMode = 'savedFile' if $submit_button eq 'Save';
151 :     #}
152 :     #
153 :     ##override using the source file data from the form field
154 :     #$problem->source_file($override_problem_source) if defined($override_problem_source);
155 :     #$problem->problem_seed($override_seed) if defined($override_seed);
156 :     #
157 :     ## store path to source file for title.
158 :     #$self->{problem_source_name} = $problem->source_file;
159 :     #$self->{edit_mode} = $editMode;
160 :     #$self->{current_problem_source} = (defined($override_problem_source) ) ?
161 : gage 1007
162 : sh002i 449 # coerce form fields into CGI::Vars format
163 :     my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
164 :    
165 : sh002i 738 $self->{displayMode} = $displayMode;
166 :     $self->{redisplay} = $redisplay;
167 :     $self->{submitAnswers} = $submitAnswers;
168 :     $self->{checkAnswers} = $checkAnswers;
169 :     $self->{previewAnswers} = $previewAnswers;
170 :     $self->{formFields} = $formFields;
171 :    
172 : sh002i 449 ##### permissions #####
173 :    
174 : sh002i 738 # are we allowed to view this problem?
175 :     $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0;
176 :     return unless $self->{isOpen};
177 :    
178 : sh002i 449 # what does the user want to do?
179 : sh002i 431 my %want = (
180 :     showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers},
181 :     showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers},
182 :     showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints},
183 :     showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions},
184 : sh002i 719 recordAnswers => $submitAnswers,
185 : sh002i 747 checkAnswers => $checkAnswers,
186 : sh002i 431 );
187 : sh002i 429
188 : sh002i 431 # are certain options enforced?
189 :     my %must = (
190 :     showOldAnswers => 0,
191 :     showCorrectAnswers => 0,
192 :     showHints => 0,
193 :     showSolutions => 0,
194 :     recordAnswers => mustRecordAnswers($permissionLevel),
195 : sh002i 747 checkAnswers => 0,
196 : sh002i 431 );
197 :    
198 : sh002i 429 # does the user have permission to use certain options?
199 : sh002i 431 my %can = (
200 :     showOldAnswers => 1,
201 :     showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
202 :     showHints => 1,
203 :     showSolutions => canShowSolutions($permissionLevel, $set->answer_date),
204 :     recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
205 :     $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
206 : sh002i 756 # attempts=num_correct+num_incorrect+1, as this happens before updating $problem
207 :     checkAnswers => canCheckAnswers($permissionLevel, $set->answer_date),
208 : sh002i 431 );
209 : sh002i 429
210 :     # final values for options
211 : sh002i 431 my %will;
212 : sh002i 617 foreach (keys %must) {
213 : sh002i 431 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
214 :     }
215 : sh002i 429
216 :     ##### sticky answers #####
217 :    
218 : sh002i 431 if (not $submitAnswers and $will{showOldAnswers}) {
219 :     # do this only if new answers are NOT being submitted
220 : sh002i 429 my %oldAnswers = decodeAnswers($problem->last_answer);
221 :     $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
222 :     }
223 :    
224 :     ##### translation #####
225 : gage 1202
226 :     $WeBWorK::timer0->continue("begin pg processing") if $timer0_ON;
227 : sh002i 424 my $pg = WeBWorK::PG->new(
228 :     $courseEnv,
229 : malsyned 704 $effectiveUser,
230 : gage 1038 $key,
231 : sh002i 502 $set,
232 :     $problem,
233 : sh002i 1197 $set->psvn, # FIXME: this field should be removed
234 : sh002i 502 $formFields,
235 : sh002i 424 { # translation options
236 : sh002i 434 displayMode => $displayMode,
237 :     showHints => $will{showHints},
238 :     showSolutions => $will{showSolutions},
239 :     refreshMath2img => $will{showHints} || $will{showSolutions},
240 : sh002i 684 processAnswers => 1,
241 : sh002i 424 },
242 :     );
243 : gage 392
244 : gage 1202 $WeBWorK::timer0->continue("end pg processing") if $timer0_ON;
245 : sh002i 684 ##### fix hint/solution options #####
246 :    
247 :     $can{showHints} &&= $pg->{flags}->{hintExists};
248 :     $can{showSolutions} &&= $pg->{flags}->{solutionExists};
249 :    
250 : sh002i 449 ##### store fields #####
251 :    
252 :     $self->{want} = \%want;
253 :     $self->{must} = \%must;
254 :     $self->{can} = \%can;
255 :     $self->{will} = \%will;
256 :    
257 :     $self->{pg} = $pg;
258 :     }
259 :    
260 : sh002i 1131 #sub if_warnings($$) {
261 :     # my ($self, $arg) = @_;
262 :     # return 0 unless $self->{isOpen};
263 :     # return $self->{pg}->{warnings} ne "";
264 :     #}
265 : sh002i 558
266 :     sub if_errors($$) {
267 :     my ($self, $arg) = @_;
268 : sh002i 738 return 0 unless $self->{isOpen};
269 : sh002i 558 return $self->{pg}->{flags}->{error_flag};
270 :     }
271 :    
272 : sh002i 562 sub head {
273 : sh002i 555 my $self = shift;
274 : sh002i 738 return "" unless $self->{isOpen};
275 : sh002i 555 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
276 :     }
277 : sh002i 476
278 : sh002i 1131 sub options {
279 :     my $self = shift;
280 :     return join("",
281 :     CGI::start_form("POST", $self->{r}->uri),
282 :     $self->hidden_authen_fields,
283 :     CGI::hr(),
284 :     CGI::start_div({class=>"viewOptions"}),
285 :     $self->viewOptions(),
286 :     CGI::end_div(),
287 :     CGI::end_form()
288 :     );
289 :     }
290 :    
291 : sh002i 476 sub path {
292 :     my $self = shift;
293 :     my $args = $_[-1];
294 : sh002i 818 my $setName = $self->{set}->set_id;
295 :     my $problemNumber = $self->{problem}->problem_id;
296 : sh002i 476
297 : sh002i 809 my $ce = $self->{ce};
298 : sh002i 476 my $root = $ce->{webworkURLs}->{root};
299 :     my $courseName = $ce->{courseName};
300 :     return $self->pathMacro($args,
301 :     "Home" => "$root",
302 :     $courseName => "$root/$courseName",
303 : sh002i 555 $setName => "$root/$courseName/$setName",
304 : sh002i 476 "Problem $problemNumber" => "",
305 :     );
306 :     }
307 :    
308 :     sub siblings {
309 :     my $self = shift;
310 : sh002i 818 my $setName = $self->{set}->set_id;
311 :     my $problemNumber = $self->{problem}->problem_id;
312 : sh002i 476
313 : sh002i 809 my $ce = $self->{ce};
314 : sh002i 818 my $db = $self->{db};
315 : sh002i 476 my $root = $ce->{webworkURLs}->{root};
316 :     my $courseName = $ce->{courseName};
317 : sh002i 526 print CGI::strong("Problems"), CGI::br();
318 :    
319 : malsyned 704 my $effectiveUser = $self->{r}->param("effectiveUser");
320 : sh002i 1223 my @problemIDs = $db->listUserProblems($effectiveUser, $setName);
321 :     foreach my $problem (sort { $a <=> $b } @problemIDs) {
322 : gage 1190 print CGI::a({-href=>"$root/$courseName/$setName/".$problem."/?"
323 : sh002i 692 . $self->url_authen_args . "&displayMode=" . $self->{displayMode}},
324 : sh002i 1223 "Problem ".$problem), CGI::br();
325 : sh002i 476 }
326 : gage 1202
327 : sh002i 1223 return "";
328 : sh002i 476 }
329 :    
330 :     sub nav {
331 : sh002i 1223 $WeBWorK::timer0->continue("begin nav subroutine") if $timer0_ON;
332 : sh002i 476 my $self = shift;
333 :     my $args = $_[-1];
334 : sh002i 818 my $setName = $self->{set}->set_id;
335 :     my $problemNumber = $self->{problem}->problem_id;
336 : sh002i 476
337 : sh002i 809 my $ce = $self->{ce};
338 : sh002i 818 my $db = $self->{db};
339 : sh002i 476 my $root = $ce->{webworkURLs}->{root};
340 :     my $courseName = $ce->{courseName};
341 :    
342 : malsyned 704 my $wwdb = $self->{wwdb};
343 :     my $effectiveUser = $self->{r}->param("effectiveUser");
344 : sh002i 692 my $tail = "&displayMode=".$self->{displayMode};
345 : sh002i 476
346 : malsyned 795 my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList");
347 : sh002i 476
348 : sh002i 1223 my @problemIDs = $db->listUserProblems($effectiveUser, $setName);
349 :     my ($prevID, $nextID);
350 :     foreach my $id (@problemIDs) {
351 :     $prevID = $id if $id < $problemNumber
352 :     and (not defined $prevID or $id > $prevID);
353 :     $nextID = $id if $id > $problemNumber
354 :     and (not defined $nextID or $id < $nextID);
355 :     }
356 :     unshift @links, "Previous Problem" , ($prevID
357 :     ? "$root/$courseName/$setName/".$prevID
358 : malsyned 795 : "") , "navPrev";
359 : sh002i 1223 push @links, "Next Problem" , ($nextID
360 :     ? "$root/$courseName/$setName/".$nextID
361 : malsyned 795 : "") , "navNext";
362 : sh002i 476
363 : gage 1202 my $result = $self->navMacro($args, $tail, @links);
364 :     $WeBWorK::timer0->continue("end nav subroutine") if $timer0_ON;
365 :     return $result;
366 : sh002i 476 }
367 :    
368 : sh002i 449 sub title {
369 :     my $self = shift;
370 : sh002i 818 my $setName = $self->{set}->set_id;
371 : sh002i 1197 my $problemNumber = $self->{problem}->problem_id;
372 : sh002i 476
373 :     return "$setName : Problem $problemNumber";
374 : sh002i 449 }
375 :    
376 :     sub body {
377 :     my $self = shift;
378 :    
379 : sh002i 739 return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open."))
380 :     unless $self->{isOpen};
381 : sh002i 738
382 : sh002i 449 # unpack some useful variables
383 : sh002i 476 my $r = $self->{r};
384 : sh002i 818 my $db = $self->{db};
385 : sh002i 476 my $set = $self->{set};
386 :     my $problem = $self->{problem};
387 : sh002i 1197 my $editMode = $self->{editMode};
388 : sh002i 476 my $permissionLevel = $self->{permissionLevel};
389 :     my $submitAnswers = $self->{submitAnswers};
390 : sh002i 719 my $checkAnswers = $self->{checkAnswers};
391 : sh002i 623 my $previewAnswers = $self->{previewAnswers};
392 : sh002i 719 my %want = %{ $self->{want} };
393 : sh002i 1197 my %can = %{ $self->{can} };
394 : sh002i 719 my %must = %{ $self->{must} };
395 : sh002i 476 my %will = %{ $self->{will} };
396 :     my $pg = $self->{pg};
397 : sh002i 449
398 :     ##### translation errors? #####
399 :    
400 : sh002i 425 if ($pg->{flags}->{error_flag}) {
401 : sh002i 737 return $self->errorOutput($pg->{errors}, $pg->{body_text});
402 : sh002i 425 }
403 : sh002i 415
404 : sh002i 429 ##### answer processing #####
405 : gage 1202 $WeBWorK::timer0->continue("begin answer processing") if $timer0_ON;
406 : sh002i 429 # if answers were submitted:
407 :     if ($submitAnswers) {
408 : sh002i 818 # get a "pure" (unmerged) UserProblem to modify
409 : gage 1007 # this will be undefined if the problem has not been assigned to this user
410 : sh002i 818 my $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id);
411 : sh002i 431 # store answers in DB for sticky answers
412 : sh002i 429 my %answersToStore;
413 :     my %answerHash = %{ $pg->{answers} };
414 :     $answersToStore{$_} = $answerHash{$_}->{original_student_ans}
415 :     foreach (keys %answerHash);
416 :     my $answerString = encodeAnswers(%answersToStore,
417 :     @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} });
418 : gage 1007
419 : sh002i 429 $problem->last_answer($answerString);
420 : gage 1007 # if $pureProblem is defined ( there is a user ) then record the last answer.
421 :     # FIXME (we're assuming that not being able to get a pure problem is enough to determine
422 :     # whether or not the problem database needs to be updated. This should be thought through
423 :     # more carefully to be sure.
424 :     if ( defined($pureProblem) ) {
425 :     $pureProblem->last_answer($answerString);
426 :     $db->putUserProblem($pureProblem);
427 :     #die "pureProblem = ", defined($pureProblem);
428 : sh002i 429
429 : gage 1007
430 :     # store state in DB if it makes sense
431 :     if ($will{recordAnswers}) {
432 :     $problem->status($pg->{state}->{recorded_score});
433 :     $problem->attempted(1);
434 :     $problem->num_correct($pg->{state}->{num_of_correct_ans});
435 :     $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
436 :     $pureProblem->status($pg->{state}->{recorded_score});
437 :     $pureProblem->attempted(1);
438 :     $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
439 :     $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
440 :     $db->putUserProblem($pureProblem);
441 :     # write to the transaction log, just to make sure
442 :     writeLog($self->{ce}, "transaction",
443 :     $problem->problem_id."\t".
444 :     $problem->set_id."\t".
445 :     $problem->user_id."\t".
446 :     $problem->source_file."\t".
447 :     $problem->value."\t".
448 :     $problem->max_attempts."\t".
449 :     $problem->problem_seed."\t".
450 :     $pureProblem->status."\t".
451 :     $pureProblem->attempted."\t".
452 :     $pureProblem->last_answer."\t".
453 :     $pureProblem->num_correct."\t".
454 :     $pureProblem->num_incorrect
455 :     );
456 :     }
457 : sh002i 431 }
458 : sh002i 425 }
459 : gage 794 # logging student answers
460 :     my $pastAnswerLog = undef;
461 : sh002i 809 if (defined( $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'} )) {
462 : sh002i 1223 $pastAnswerLog = $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'};
463 :     if ($submitAnswers and defined $pastAnswerLog) {
464 : gage 794 my $answerString = "";
465 :     my %answerHash = %{ $pg->{answers} };
466 :     $answerString = $answerString . $answerHash{$_}->{original_student_ans}."\t"
467 :     foreach (sort keys %answerHash);
468 : gage 1007 $answerString = '' unless defined($answerString); # insure string is defined.
469 : sh002i 809 writeLog($self->{ce}, "pastAnswerList",
470 : sh002i 818 '|'.$problem->user_id.
471 : gage 794 '|'.$problem->set_id.
472 : sh002i 818 '|'.$problem->problem_id.'|'."\t".
473 : gage 794 time()."\t".
474 :     $answerString,
475 :     );
476 :     }
477 : sh002i 1223 }
478 : gage 794 # end logging student answers
479 : sh002i 1223
480 : gage 1202 $WeBWorK::timer0->continue("end answer processing") if $timer0_ON;
481 : sh002i 1223
482 : sh002i 429 ##### output #####
483 : sh002i 1131
484 : malsyned 755 print CGI::start_div({class=>"problemHeader"});
485 : sh002i 1131
486 : sh002i 1197 # custom message for editor
487 :     if ($permissionLevel >= 10 and defined $editMode) {
488 :     if ($editMode eq "temporaryFile") {
489 :     print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file));
490 :     } elsif ($editMode eq "savedFile") {
491 :     print CGI::p(CGI::i("Problem saved to: ", $problem->source_file));
492 :     }
493 :     }
494 :    
495 : sh002i 431 # attempt summary
496 :     if ($submitAnswers or $will{showCorrectAnswers}) {
497 :     # print this if user submitted answers OR requested correct answers
498 : sh002i 719 print $self->attemptResults($pg, $submitAnswers,
499 :     $will{showCorrectAnswers},
500 : gage 939 $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
501 : sh002i 719 } elsif ($checkAnswers) {
502 :     # print this if user previewed answers
503 : gage 939 print $self->attemptResults($pg, 1, 0, 1, 1, 1);
504 : sh002i 719 # show attempt answers
505 :     # don't show correct answers
506 :     # show attempt results (correctness)
507 :     # don't show attempt previews
508 : sh002i 623 } elsif ($previewAnswers) {
509 :     # print this if user previewed answers
510 : malsyned 755 print $self->attemptResults($pg, 1, 0, 0, 0, 1);
511 : sh002i 719 # show attempt answers
512 : sh002i 623 # don't show correct answers
513 : sh002i 719 # don't show attempt results (correctness)
514 :     # show attempt previews
515 : sh002i 431 }
516 : gage 392
517 : malsyned 755 print CGI::end_div();
518 :    
519 :     print CGI::start_div({class=>"problem"});
520 : sh002i 1131
521 : malsyned 755 # main form
522 :     print
523 :     CGI::startform("POST", $r->uri),
524 :     $self->hidden_authen_fields,
525 :     CGI::p($pg->{body_text}),
526 :     CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),
527 :     CGI::p(
528 :     ($can{recordAnswers}
529 :     ? CGI::submit(-name=>"submitAnswers",
530 :     -label=>"Submit Answers")
531 :     : ""),
532 :     ($can{checkAnswers}
533 :     ? CGI::submit(-name=>"checkAnswers",
534 :     -label=>"Check Answers")
535 :     : ""),
536 :     CGI::submit(-name=>"previewAnswers",
537 :     -label=>"Preview Answers"),
538 :     );
539 : gage 794 print CGI::end_div();
540 :    
541 :     print CGI::start_div({class=>"scoreSummary"});
542 : sh002i 1131
543 : sh002i 431 # score summary
544 :     my $attempts = $problem->num_correct + $problem->num_incorrect;
545 :     my $attemptsNoun = $attempts != 1 ? "times" : "time";
546 : malsyned 1034 my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number
547 : sh002i 431 my ($attemptsLeft, $attemptsLeftNoun);
548 :     if ($problem->max_attempts == -1) {
549 :     # unlimited attempts
550 :     $attemptsLeft = "unlimited";
551 :     $attemptsLeftNoun = "attempts";
552 :     } else {
553 :     $attemptsLeft = $problem->max_attempts - $attempts;
554 :     $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
555 :     }
556 : malsyned 755
557 :     my $setClosed = 0;
558 : sh002i 476 my $setClosedMessage;
559 :     if (time < $set->open_date or time > $set->due_date) {
560 : malsyned 755 $setClosed = 1;
561 : sh002i 476 $setClosedMessage = "This problem set is closed.";
562 :     if ($permissionLevel > 0) {
563 : sh002i 1131 $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
564 : sh002i 476 } else {
565 :     $setClosedMessage .= " Additional attempts will not be recorded.";
566 :     }
567 :     }
568 : sh002i 449 print CGI::p(
569 :     "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
570 : sh002i 431 $problem->attempted
571 : sh002i 449 ? "Your recorded score is $lastScore." . CGI::br()
572 : sh002i 431 : "",
573 : malsyned 755 $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
574 : sh002i 431 );
575 : gage 794 print CGI::end_div();
576 : malsyned 755
577 : sh002i 1131 # save state for viewOptions
578 :     print CGI::hidden(
579 :     -name => "showOldAnswers",
580 :     -value => $will{showOldAnswers}
581 :     ),
582 :     CGI::hidden(
583 :     -name => "showCorrectAnswers",
584 :     -value => $will{showCorrectAnswers}
585 :     ),
586 :     CGI::hidden(
587 :     -name => "showHints",
588 :     -value => $will{showHints}),
589 :     CGI::hidden(
590 :     -name => "showSolutions",
591 :     -value => $will{showSolutions},
592 :     ),
593 :     CGI::hidden(
594 :     -name => "displayMode",
595 :     -value => $self->{displayMode}
596 :     );
597 :    
598 :     # end of main form
599 :     print CGI::endform();
600 :    
601 :     # stuff we need below (pull these out at the beginning?)
602 : sh002i 809 my $ce = $self->{ce};
603 : sh002i 667 my $root = $ce->{webworkURLs}->{root};
604 :     my $courseName = $ce->{courseName};
605 : gage 794
606 : sh002i 1131 print CGI::start_div({class=>"problemFooter"});
607 :    
608 : gage 794 # arguments for answer inspection button
609 :     my $prof_url = $ce->{webworkURLs}->{oldProf};
610 :     my $cgi_url = $prof_url;
611 :     $cgi_url=~ s|/[^/]*$||; # clip profLogin.pl
612 :     my $authen_args = $self->url_authen_args();
613 :     my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl";
614 :    
615 :     # print answer inspection button
616 : sh002i 1131 if ($self->{permissionLevel} > 0) {
617 : gage 794 print "\n",
618 :     CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
619 : sh002i 1131 $self->hidden_authen_fields,"\n",
620 :     CGI::hidden(-name => 'course', -value=>$courseName), "\n",
621 :     CGI::hidden(-name => 'probNum', -value=>$problem->problem_id), "\n",
622 :     CGI::hidden(-name => 'setNum', -value=>$problem->set_id), "\n",
623 :     CGI::hidden(-name => 'User', -value=>$problem->user_id), "\n",
624 :     CGI::p( {-align=>"left"},
625 :     CGI::submit(-name => 'action', -value=>'Show Past Answers')
626 :     ), "\n",
627 :     CGI::endform();
628 :     }
629 : sh002i 667
630 : sh002i 1131 #print CGI::end_div();
631 :     #
632 :     #print CGI::start_div();
633 : gage 794
634 : sh002i 1131 # arguments for feedback form
635 :     my $feedbackURL = "$root/$courseName/feedback/";
636 : gage 794
637 : sh002i 1131 #print feedback form
638 : gage 940 print
639 :     CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
640 :     $self->hidden_authen_fields,"\n",
641 :     CGI::hidden("module", __PACKAGE__),"\n",
642 :     CGI::hidden("set", $set->set_id),"\n",
643 :     CGI::hidden("problem", $problem->problem_id),"\n",
644 :     CGI::hidden("displayMode", $self->{displayMode}),"\n",
645 :     CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
646 :     CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
647 :     CGI::hidden("showHints", $will{showHints}),"\n",
648 :     CGI::hidden("showSolutions", $will{showSolutions}),"\n",
649 :     CGI::p({-align=>"left"},
650 :     CGI::submit(-name=>"feedbackForm", -label=>"Contact instructor")
651 :     ),
652 :     CGI::endform(),"\n";
653 :    
654 : gage 903 # FIXME print editor link
655 : gage 926 # print editor link if the user is an instructor AND the file is not in temporary editing mode
656 :     if ($self->{permissionLevel}>=10 and ( (not defined($self->{edit_mode})) or $self->{edit_mode} eq 'savedFile') ) {
657 : malsyned 1041 print CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".$set->set_id.
658 : gage 906 '/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');
659 :     }
660 :    
661 : sh002i 1131 print CGI::end_div();
662 : gage 940
663 : sh002i 558 # warning output
664 : sh002i 1131 #if ($pg->{warnings} ne "") {
665 :     # print CGI::hr(), $self->warningOutput($pg->{warnings});
666 :     #}
667 : sh002i 558
668 : sh002i 424 # debugging stuff
669 : sh002i 747 if (0) {
670 : sh002i 738 print
671 :     CGI::hr(),
672 :     CGI::h2("debugging information"),
673 :     CGI::h3("form fields"),
674 :     ref2string($self->{formFields}),
675 :     CGI::h3("user object"),
676 :     ref2string($self->{user}),
677 :     CGI::h3("set object"),
678 :     ref2string($set),
679 :     CGI::h3("problem object"),
680 :     ref2string($problem),
681 :     CGI::h3("PG object"),
682 :     ref2string($pg, {'WeBWorK::PG::Translator' => 1});
683 :     }
684 : gage 392
685 : sh002i 424 return "";
686 : malsyned 353 }
687 :    
688 : sh002i 431 ##### output utilities #####
689 : sh002i 429
690 : malsyned 755 sub attemptResults($$$$$$) {
691 : sh002i 623 my $self = shift;
692 : sh002i 425 my $pg = shift;
693 : sh002i 431 my $showAttemptAnswers = shift;
694 : sh002i 425 my $showCorrectAnswers = shift;
695 : sh002i 431 my $showAttemptResults = $showAttemptAnswers && shift;
696 : malsyned 755 my $showSummary = shift;
697 : sh002i 683 my $showAttemptPreview = shift || 0;
698 : sh002i 425 my $problemResult = $pg->{result}; # the overall result of the problem
699 :     my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
700 :    
701 : sh002i 685 my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
702 :    
703 : malsyned 755 my $header = CGI::th("Part");
704 :     $header .= $showAttemptAnswers ? CGI::th("Entered") : "";
705 :     $header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
706 :     $header .= $showCorrectAnswers ? CGI::th("Correct") : "";
707 :     $header .= $showAttemptResults ? CGI::th("Result") : "";
708 : sh002i 685 $header .= $showMessages ? CGI::th("messages") : "";
709 : sh002i 425 my @tableRows = ( $header );
710 :     my $numCorrect;
711 :     foreach my $name (@answerNames) {
712 :     my $answerResult = $pg->{answers}->{$name};
713 : sh002i 429 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
714 : sh002i 683 my $preview = ($showAttemptPreview
715 :     ? $self->previewAnswer($answerResult)
716 :     : "");
717 : sh002i 425 my $correctAnswer = $answerResult->{correct_ans};
718 :     my $answerScore = $answerResult->{score};
719 : sh002i 685 my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
720 : sh002i 425
721 :     $numCorrect += $answerScore > 0;
722 : sh002i 555 my $resultString = $answerScore ? "correct" : "incorrect";
723 : sh002i 425
724 : sh002i 555 # get rid of the goofy prefix on the answer names (supposedly, the format
725 : sh002i 683 # of the answer names is changeable. this only fixes it for "AnSwEr"
726 : sh002i 555 $name =~ s/^AnSwEr//;
727 :    
728 : sh002i 449 my $row = CGI::td($name);
729 : gage 1128 $row .= $showAttemptAnswers ? CGI::td(nbsp($studentAnswer)) : "";
730 :     $row .= $showAttemptPreview ? CGI::td(nbsp($preview)) : "";
731 :     $row .= $showCorrectAnswers ? CGI::td(nbsp($correctAnswer)) : "";
732 :     $row .= $showAttemptResults ? CGI::td(nbsp($resultString)) : "";
733 :     $row .= $answerMessage ? CGI::td(nbsp($answerMessage)) : "";
734 : sh002i 425 push @tableRows, $row;
735 :     }
736 :    
737 : malsyned 755 my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
738 : malsyned 1049 my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
739 : malsyned 755 my $summary = "On this attempt, you answered $numCorrect out of "
740 :     . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
741 :     return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p($summary) : "");
742 : sh002i 425 }
743 : gage 1128 sub nbsp {
744 :     my $str = shift;
745 :     ($str) ? $str : '&nbsp;'; # returns non-breaking space for empty strings
746 :     }
747 : sh002i 449 sub viewOptions($) {
748 :     my $self = shift;
749 :     my $displayMode = $self->{displayMode};
750 :     my %must = %{ $self->{must} };
751 :     my %can = %{ $self->{can} };
752 :     my %will = %{ $self->{will} };
753 : sh002i 431
754 :     my $optionLine;
755 :     $can{showOldAnswers} and $optionLine .= join "",
756 : gage 940 "Show: &nbsp;".CGI::br(),
757 : sh002i 449 CGI::checkbox(
758 : sh002i 429 -name => "showOldAnswers",
759 : sh002i 431 -checked => $will{showOldAnswers},
760 :     -label => "Saved answers",
761 : gage 940 ), "&nbsp;&nbsp;".CGI::br();
762 : sh002i 431 $can{showCorrectAnswers} and $optionLine .= join "",
763 : sh002i 449 CGI::checkbox(
764 : sh002i 429 -name => "showCorrectAnswers",
765 : sh002i 431 -checked => $will{showCorrectAnswers},
766 : sh002i 429 -label => "Correct answers",
767 : gage 940 ), "&nbsp;&nbsp;".CGI::br();
768 : sh002i 431 $can{showHints} and $optionLine .= join "",
769 : sh002i 449 CGI::checkbox(
770 : sh002i 429 -name => "showHints",
771 : sh002i 431 -checked => $will{showHints},
772 : sh002i 429 -label => "Hints",
773 : gage 940 ), "&nbsp;&nbsp;".CGI::br();
774 : sh002i 431 $can{showSolutions} and $optionLine .= join "",
775 : sh002i 449 CGI::checkbox(
776 : sh002i 429 -name => "showSolutions",
777 : sh002i 431 -checked => $will{showSolutions},
778 : sh002i 429 -label => "Solutions",
779 : gage 940 ), "&nbsp;&nbsp;".CGI::br();
780 : sh002i 449 $optionLine and $optionLine .= join "", CGI::br();
781 : sh002i 431
782 : gage 940 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
783 :     "View&nbsp;equations&nbsp;as:&nbsp;&nbsp;&nbsp;&nbsp;".CGI::br(),
784 : sh002i 449 CGI::radio_group(
785 : sh002i 431 -name => "displayMode",
786 :     -values => ['plainText', 'formattedText', 'images'],
787 :     -default => $displayMode,
788 : gage 940 -linebreak=>'true',
789 : sh002i 431 -labels => {
790 : gage 940 plainText => "plain",
791 :     formattedText => "formatted",
792 : sh002i 431 images => "images",
793 :     }
794 : gage 940 ), CGI::br(),CGI::hr(),
795 : sh002i 431 $optionLine,
796 : gage 942 CGI::submit(-name=>"redisplay", -label=>"Save Options"),
797 : sh002i 429 );
798 :     }
799 :    
800 : sh002i 623 sub previewAnswer($$) {
801 :     my ($self, $answerResult) = @_;
802 : sh002i 809 my $ce = $self->{ce};
803 : malsyned 718 my $effectiveUser = $self->{effectiveUser};
804 :     my $set = $self->{set};
805 :     my $problem = $self->{problem};
806 :     my $displayMode = $self->{displayMode};
807 : sh002i 623
808 : sh002i 682 # note: right now, we have to do things completely differently when we are
809 :     # rendering math from INSIDE the translator and from OUTSIDE the translator.
810 :     # so we'll just deal with each case explicitly here. there's some code
811 :     # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
812 : sh002i 623
813 :     my $tex = $answerResult->{preview_latex_string};
814 :    
815 : sh002i 818 return "" if $tex eq "";
816 : sh002i 737
817 : sh002i 682 if ($displayMode eq "plainText") {
818 :     return $tex;
819 :     } elsif ($displayMode eq "formattedText") {
820 :     my $tthCommand = $ce->{externalPrograms}->{tth}
821 :     . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
822 : sh002i 737 . "\\(".$tex."\\)\n"
823 : sh002i 682 . "END_OF_INPUT\n";
824 :    
825 :     # call tth
826 :     my $result = `$tthCommand`;
827 :     if ($?) {
828 :     return "<b>[tth failed: $? $@]</b>";
829 :     }
830 :     return $result;
831 :     } elsif ($displayMode eq "images") {
832 :     # how are we going to name this?
833 : sh002i 1016 my $targetPathCommon = "/m2i/"
834 : sh002i 919 . $effectiveUser->user_id . "."
835 : sh002i 818 . $set->set_id . "."
836 :     . $problem->problem_id . "."
837 : sh002i 682 . $answerResult->{ans_name} . ".png";
838 :    
839 :     # figure out where to put things
840 : sh002i 1147 my $wd = makeTempDirectory($ce->{courseDirs}->{html_temp}, "webwork-dvipng");
841 : sh002i 682 my $latex = $ce->{externalPrograms}->{latex};
842 :     my $dvipng = $ce->{externalPrograms}->{dvipng};
843 :     my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
844 :     # should use surePathToTmpFile, but we have to
845 :     # isolate it from the problem enivronment first
846 :     my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
847 :    
848 :     # call dvipng to generate a preview
849 :     dvipng($wd, $latex, $dvipng, $tex, $targetPath);
850 : sh002i 920 rmtree($wd, 0, 0);
851 : sh002i 682 if (-e $targetPath) {
852 :     return "<img src=\"$targetURL\" alt=\"$tex\" />";
853 :     } else {
854 :     return "<b>[math2img failed]</b>";
855 :     }
856 : sh002i 623 }
857 :     }
858 : gage 939
859 : gage 794 ##### logging subroutine ####
860 : sh002i 623
861 : gage 794
862 :    
863 : sh002i 431 ##### permission queries #####
864 : sh002i 429
865 :     # this stuff should be abstracted out into the permissions system
866 :     # however, the permission system only knows about things in the
867 :     # course environment and the username. hmmm...
868 :    
869 : sh002i 431 # also, i should fix these so that they have a consistent calling
870 :     # format -- perhaps:
871 :     # canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
872 :    
873 : sh002i 429 sub canShowCorrectAnswers($$) {
874 :     my ($permissionLevel, $answerDate) = @_;
875 :     return $permissionLevel > 0 || time > $answerDate;
876 :     }
877 :    
878 :     sub canShowSolutions($$) {
879 :     my ($permissionLevel, $answerDate) = @_;
880 :     return canShowCorrectAnswers($permissionLevel, $answerDate);
881 :     }
882 :    
883 : sh002i 431 sub canRecordAnswers($$$$$) {
884 :     my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
885 :     my $permHigh = $permissionLevel > 0;
886 :     my $timeOK = time >= $openDate && time <= $dueDate;
887 : sh002i 617 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
888 :     my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
889 :     return $recordAnswers;
890 : sh002i 429 }
891 :    
892 : sh002i 756 sub canCheckAnswers($$) {
893 :     my ($permissionLevel, $answerDate) = @_;
894 :     my $permHigh = $permissionLevel > 0;
895 :     my $timeOK = time >= $answerDate;
896 :     my $recordAnswers = $permHigh || $timeOK;
897 :     return $recordAnswers;
898 : sh002i 747 }
899 :    
900 : sh002i 429 sub mustRecordAnswers($) {
901 :     my ($permissionLevel) = @_;
902 :     return $permissionLevel == 0;
903 :     }
904 :    
905 : sh002i 415 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9