[system] / branches / rel-2-2-dev / webwork2 / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

Diff of /branches/rel-2-2-dev/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

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

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