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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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