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