[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 994 - (view) (download) (as text)
Original Path: trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9