[system] / trunk / webwork-modperl / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

Annotation of /trunk/webwork-modperl/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9