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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9