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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9