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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9