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

Diff of /branches/gage_dev/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

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

Revision 634 Revision 2166
1################################################################################ 1################################################################################
2# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project 2# WeBWorK Online Homework Delivery System
3# $Id$ 3# Copyright © 2000-2003 The WeBWorK Project, http://openwebwork.sf.net/
4# $CVSHeader: webwork-modperl/lib/WeBWorK/ContentGenerator/Problem.pm,v 1.131 2004/05/22 19:01:37 jjholt Exp $
5#
6# This program is free software; you can redistribute it and/or modify it under
7# the terms of either: (a) the GNU General Public License as published by the
8# Free Software Foundation; either version 2, or (at your option) any later
9# version, or (b) the "Artistic License" which comes with this package.
10#
11# This program is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13# FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the
14# Artistic License for more details.
4################################################################################ 15################################################################################
5 16
6package WeBWorK::ContentGenerator::Problem; 17package WeBWorK::ContentGenerator::Problem;
18use base qw(WeBWorK::ContentGenerator);
7 19
8=head1 NAME 20=head1 NAME
9 21
10WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem. 22WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
11 23
12=cut 24=cut
13 25
14use strict; 26use strict;
15use warnings; 27use warnings;
16use base qw(WeBWorK::ContentGenerator);
17use CGI qw(); 28use CGI qw();
18use File::Temp qw(tempdir); 29use File::Path qw(rmtree);
19use WeBWorK::Form; 30use WeBWorK::Form;
20use WeBWorK::PG; 31use WeBWorK::PG;
32use WeBWorK::PG::ImageGenerator;
21use WeBWorK::PG::IO; 33use WeBWorK::PG::IO;
22use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); 34use WeBWorK::Utils qw(writeLog writeCourseLog encodeAnswers decodeAnswers ref2string makeTempDirectory);
35use WeBWorK::DB::Utils qw(global2user user2global findDefaults);
36use WeBWorK::Timing;
37
38use WeBWorK::Utils::Tasks qw(fake_set fake_problem);
23 39
24############################################################ 40############################################################
25# 41#
26# user 42# user
43# effectiveUser
27# key 44# key
28# 45#
29# displayMode 46# displayMode
30# showOldAnswers 47# showOldAnswers
31# showCorrectAnswers 48# showCorrectAnswers
… …
34# 51#
35# AnSwEr# - answer blanks in problem 52# AnSwEr# - answer blanks in problem
36# 53#
37# redisplay - name of the "Redisplay Problem" button 54# redisplay - name of the "Redisplay Problem" button
38# submitAnswers - name of "Submit Answers" button 55# submitAnswers - name of "Submit Answers" button
56# checkAnswers - name of the "Check Answers" button
57# previewAnswers - name of the "Preview Answers" button
58#
59# FIXME: this table is heinously out of date
39# 60#
40############################################################ 61############################################################
41 62
63# FIXME: what is this?
64sub templateName {
65 "problem";
66}
67
42sub pre_header_initialize { 68sub pre_header_initialize {
43 my ($self, $setName, $problemNumber) = @_; 69 my ($self) = @_;
44 my $courseEnv = $self->{courseEnvironment};
45 my $r = $self->{r}; 70 my $r = $self->r;
71 my $ce = $r->ce;
72 my $db = $r->db;
73 my $urlpath = $r->urlpath;
74
75 my $setName = $urlpath->arg("setID");
76 my $problemNumber = $r->urlpath->arg("problemID");
46 my $userName = $r->param('user'); 77 my $userName = $r->param('user');
78 my $effectiveUserName = $r->param('effectiveUser');
79 my $key = $r->param('key');
47 80
48 ##### database setup #####
49
50 my $cldb = WeBWorK::DB::Classlist->new($courseEnv);
51 my $wwdb = WeBWorK::DB::WW->new($courseEnv);
52 my $authdb = WeBWorK::DB::Auth->new($courseEnv);
53
54 my $user = $cldb->getUser($userName); 81 my $user = $db->getUser($userName); # checked
55 my $set = $wwdb->getSet($userName, $setName); 82 die "record for user $userName (real user) does not exist."
56 my $problem = $wwdb->getProblem($userName, $setName, $problemNumber); 83 unless defined $user;
57 my $psvn = $wwdb->getPSVN($userName, $setName); 84
85 my $effectiveUser = $db->getUser($effectiveUserName); # checked
86 die "record for user $effectiveUserName (effective user) does not exist."
87 unless defined $effectiveUser;
88
58 my $permissionLevel = $authdb->getPermissions($userName); 89 my $PermissionLevel = $db->getPermissionLevel($userName); # checked
90 die "permission level record for user $userName does not exist (but the user does? odd...)"
91 unless defined $PermissionLevel;
92 my $permissionLevel = $PermissionLevel->permission;
93
94 # obtain the merged set for $effectiveUser
95 my $set = $db->getMergedSet($effectiveUserName, $setName); # checked
96
97 # obtain the merged problem for $effectiveUser
98 my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # checked
99
100 my $editMode = $r->param("editMode");
101
102 if ($permissionLevel > 0) {
103 # professors are allowed to fabricate sets and problems not
104 # assigned to them (or anyone). this allows them to use the
105 # editor to
106
107 # if that is not yet defined obtain the global set, convert
108 # it to a user set, and add fake user data
109 unless (defined $set) {
110 my $userSetClass = $db->{set_user}->{record};
111 my $globalSet = $db->getGlobalSet($setName); # checked
112 # if the global set doesn't exist either, bail!
113 if(not defined $globalSet) {
114 $set = fake_set($db);
115 } else {
116 $set = global2user($userSetClass, $globalSet);
117 $set->psvn(0);
118
119 # FIXME: This is a temporary fix to fill in the database
120 # We want the published field to contain either 1 or 0 so if it has not been set to 0, default to 1
121 # this will fill in all the empty fields but not change anything that has been specifically set to 1 or 0
122 $globalSet->published("1") unless $globalSet->published eq "0";
123 $db->putGlobalSet($globalSet);
124 }
125 }
126
127 # if that is not yet defined obtain the global problem,
128 # convert it to a user problem, and add fake user data
129 unless (defined $problem) {
130 my $userProblemClass = $db->{problem_user}->{record};
131 my $globalProblem = $db->getGlobalProblem($setName, $problemNumber); # checked
132 # if the global problem doesn't exist either, bail!
133 if(not defined $globalProblem) {
134 my $sourceFilePath = $r->param("sourceFilePath");
135 die "Problem $problemNumber in set $setName does not exist"
136 unless defined $sourceFilePath;
137 $problem = fake_problem($db);
138 $problem->problem_id(1);
139 $problem->source_file($sourceFilePath);
140 $problem->user_id($effectiveUserName);
141 } else {
142 $problem = global2user($userProblemClass, $globalProblem);
143 $problem->user_id($effectiveUserName);
144 $problem->problem_seed(0);
145 $problem->status(0);
146 $problem->attempted(0);
147 $problem->last_answer("");
148 $problem->num_correct(0);
149 $problem->num_incorrect(0);
150 }
151 }
152
153 # now we're sure we have valid UserSet and UserProblem objects
154 # yay!
155
156 # now deal with possible editor overrides:
157
158 # if the caller is asking to override the source file, and
159 # editMode calls for a temporary file, do so
160 my $sourceFilePath = $r->param("sourceFilePath");
161 if (defined $sourceFilePath and
162 (not defined $editMode or $editMode eq "temporaryFile")) {
163 $problem->source_file($sourceFilePath);
164 }
165
166 # if the caller is asking to override the problem seed, do so
167 my $problemSeed = $r->param("problemSeed");
168 if (defined $problemSeed) {
169 $problem->problem_seed($problemSeed);
170 }
171
172 my $published = ($set->published) ? "Published" : "Unpublished";
173 $self->addmessage(CGI::p("This set is " . CGI::font({class=>$published}, $published)));
174 } else {
175
176 $self->addmessage(CGI::div({class=>"ResultsWithError"}, CGI::p("This problem will not count towards your grade."))) unless $problem->value;;
177 # students can't view problems not assigned to them
178
179 # A set is valid if it exists and if it is either published or the user is privileged.
180 $self->{invalidSet} = (grep /$setName/, $db->listUserSets($effectiveUserName)) == 0 || !($set->published || $permissionLevel->permission > 0); # this is redundant because of the above if
181 $self->{invalidProblem} = (grep /$problemNumber/, $db->listUserProblems($effectiveUserName, $setName)) == 0 || !($set->published || $permissionLevel->permission > 0);;
182
183 }
184
185 $self->{userName} = $userName;
186 $self->{effectiveUserName} = $effectiveUserName;
187 $self->{user} = $user;
188 $self->{effectiveUser} = $effectiveUser;
189 $self->{permissionLevel} = $permissionLevel;
190 $self->{set} = $set;
191 $self->{problem} = $problem;
192 $self->{editMode} = $editMode;
59 193
60 ##### form processing ##### 194 ##### form processing #####
61 195
62 # set options from form fields (see comment at top of file for names) 196 # set options from form fields (see comment at top of file for names)
63 my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; 197 my $displayMode = $r->param("displayMode") || $ce->{pg}->{options}->{displayMode};
64 my $redisplay = $r->param("redisplay"); 198 my $redisplay = $r->param("redisplay");
65 my $submitAnswers = $r->param("submitAnswers"); 199 my $submitAnswers = $r->param("submitAnswers");
200 my $checkAnswers = $r->param("checkAnswers");
66 my $previewAnswers = $r->param("previewAnswers"); 201 my $previewAnswers = $r->param("previewAnswers");
67 202
68 # coerce form fields into CGI::Vars format
69 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; 203 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
70 204
205 $self->{displayMode} = $displayMode;
206 $self->{redisplay} = $redisplay;
207 $self->{submitAnswers} = $submitAnswers;
208 $self->{checkAnswers} = $checkAnswers;
209 $self->{previewAnswers} = $previewAnswers;
210 $self->{formFields} = $formFields;
211
212 # get result and send to message
213 my $success = $r->param("sucess");
214 my $failure = $r->param("failure");
215 $self->addmessage(CGI::div({class=>"ResultsWithError"}, CGI::p($failure))) if $failure;
216 $self->addmessage(CGI::div({class=>"ResultsWithoutError"}, CGI::p($success))) if $success;
217
218 # now that we've set all the necessary variables quit out if the set or problem is invalid
219 return if $self->{invalidSet} || $self->{invalidProblem};
220
71 ##### permissions ##### 221 ##### permissions #####
222
223 # are we allowed to view this problem?
224 $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0;
225 return unless $self->{isOpen};
72 226
73 # what does the user want to do? 227 # what does the user want to do?
74 my %want = ( 228 my %want = (
75 showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers}, 229 showOldAnswers => $r->param("showOldAnswers") || $ce->{pg}->{options}->{showOldAnswers},
76 showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers}, 230 showCorrectAnswers => $r->param("showCorrectAnswers") || $ce->{pg}->{options}->{showCorrectAnswers},
77 showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints}, 231 showHints => $r->param("showHints") || $ce->{pg}->{options}->{showHints},
78 showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions}, 232 showSolutions => $r->param("showSolutions") || $ce->{pg}->{options}->{showSolutions},
79 recordAnswers => $r->param("recordAnswers") || 1, 233 recordAnswers => $submitAnswers,
234 checkAnswers => $checkAnswers,
80 ); 235 );
81 236
82 # are certain options enforced? 237 # are certain options enforced?
83 my %must = ( 238 my %must = (
84 showOldAnswers => 0, 239 showOldAnswers => 0,
85 showCorrectAnswers => 0, 240 showCorrectAnswers => 0,
86 showHints => 0, 241 showHints => 0,
87 showSolutions => 0, 242 showSolutions => 0,
88 recordAnswers => mustRecordAnswers($permissionLevel), 243 recordAnswers => mustRecordAnswers($permissionLevel),
244 checkAnswers => 0,
89 ); 245 );
90 246
91 # does the user have permission to use certain options? 247 # does the user have permission to use certain options?
92 my %can = ( 248 my %can = (
93 showOldAnswers => 1, 249 showOldAnswers => 1,
94 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date), 250 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
95 showHints => 1, 251 showHints => 1,
96 showSolutions => canShowSolutions($permissionLevel, $set->answer_date), 252 showSolutions => canShowSolutions($permissionLevel, $set->answer_date),
97 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date, 253 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
98 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1), 254 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
99 # num_correct+num_incorrect+1 -- as this happens before updating $problem 255 # attempts=num_correct+num_incorrect+1, as this happens before updating $problem
256 checkAnswers => canCheckAnswers($permissionLevel, $set->answer_date),
257 );
258
259 # more complicated logic for showing check answer button:
260 # checkAnswers button shows up after due date -- once a student can't record anymore
261 # checkAnswers button always shows up when an instructor or TA is acting
262 # as someone else (the $user and $effectiveUserName aren't the same).
263 $can{checkAnswers} = (
264 # $can{recordAnswers} will be false if the due date has passed OR the
265 # student has used up all of her attempts
266 ($can{checkAnswers} and not $can{recordAnswers})
267 or
268 (
269 # FIXME: this is not the right way to check for this.
270 # also, canCheckAnswers() will show this button if the permission
271 # level is positive, which is always true when an instructor is
272 # acting as a student
273 defined($userName)
274 and
275 defined($effectiveUserName)
276 and
277 ($userName ne $effectiveUserName)
278 )
279 );
280
281 # more complicated logif for showing "submit answer" button:
282 # We hide the submit answer button if someone is acting as a student
283 # This prevents errors where you accidently submit the answer for a student
284 # Not sure whether this a feature or a bug
285 $can{recordAnswers} = (
286 $can{recordAnswers}
287 and not
288 (
289 # FIXME: this is not the right way to check for this.
290 defined($userName)
291 and
292 defined($effectiveUserName)
293 and
294 ($userName ne $effectiveUserName)
295 )
100 ); 296 );
101 297
102 # final values for options 298 # final values for options
103 my %will; 299 my %will;
104 foreach (keys %must) { 300 foreach (keys %must) {
105 $will{$_} = $can{$_} && ($want{$_} || $must{$_}); 301 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
106 #warn "$_: can? $can{$_} want? $want{$_} must? $must{$_} will? $will{$_}\n";
107 } 302 }
108 303
109 ##### sticky answers ##### 304 ##### sticky answers #####
110 305
111 if (not $submitAnswers and $will{showOldAnswers}) { 306 if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) {
112 # do this only if new answers are NOT being submitted 307 # do this only if new answers are NOT being submitted
113 my %oldAnswers = decodeAnswers($problem->last_answer); 308 my %oldAnswers = decodeAnswers($problem->last_answer);
114 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers; 309 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
115 } 310 }
116 311
117 ##### translation ##### 312 ##### translation #####
118 313
314 $WeBWorK::timer->continue("begin pg processing") if defined($WeBWorK::timer);
119 my $pg = WeBWorK::PG->new( 315 my $pg = WeBWorK::PG->new(
120 $courseEnv, 316 $ce,
121 $user, 317 $effectiveUser,
122 $r->param('key'), 318 $key,
123 $set, 319 $set,
124 $problem, 320 $problem,
125 $psvn, 321 $set->psvn, # FIXME: this field should be removed
126 $formFields, 322 $formFields,
127 { # translation options 323 { # translation options
128 displayMode => $displayMode, 324 displayMode => $displayMode,
129 showHints => $will{showHints}, 325 showHints => $will{showHints},
130 showSolutions => $will{showSolutions}, 326 showSolutions => $will{showSolutions},
131 refreshMath2img => $will{showHints} || $will{showSolutions}, 327 refreshMath2img => $will{showHints} || $will{showSolutions},
132 # try leaving processAnswers on all the time? 328 processAnswers => 1,
133 processAnswers => 1, #$submitAnswers ? 1 : 0,
134 }, 329 },
135 ); 330 );
136 331
332 $WeBWorK::timer->continue("end pg processing") if defined($WeBWorK::timer);
333 ##### fix hint/solution options #####
334
335 $can{showHints} &&= $pg->{flags}->{hintExists}
336 &&= $pg->{flags}->{showHintLimit}<=$pg->{state}->{num_of_incorrect_ans};
337 $can{showSolutions} &&= $pg->{flags}->{solutionExists};
338
137 ##### store fields ##### 339 ##### store fields #####
138
139 $self->{cldb} = $cldb;
140 $self->{wwdb} = $wwdb;
141 $self->{authdb} = $authdb;
142
143 $self->{user} = $user;
144 $self->{set} = $set;
145 $self->{problem} = $problem;
146 $self->{permissionLevel} = $permissionLevel;
147
148 $self->{displayMode} = $displayMode;
149 $self->{redisplay} = $redisplay;
150 $self->{submitAnswers} = $submitAnswers;
151 $self->{previewAnswers} = $previewAnswers;
152 $self->{formFields} = $formFields;
153 340
154 $self->{want} = \%want; 341 $self->{want} = \%want;
155 $self->{must} = \%must; 342 $self->{must} = \%must;
156 $self->{can} = \%can; 343 $self->{can} = \%can;
157 $self->{will} = \%will; 344 $self->{will} = \%will;
158
159 $self->{pg} = $pg; 345 $self->{pg} = $pg;
160}
161
162sub if_warnings($$) {
163 my ($self, $arg) = @_;
164 return $self->{pg}->{warnings} ne "";
165} 346}
166 347
167sub if_errors($$) { 348sub if_errors($$) {
168 my ($self, $arg) = @_; 349 my ($self, $arg) = @_;
350
351 if ($self->{isOpen}) {
169 return $self->{pg}->{flags}->{error_flag}; 352 return $self->{pg}->{flags}->{error_flag} ? $arg : !$arg;
353 } else {
354 return !$arg;
355 }
170} 356}
171 357
172sub head { 358sub head {
173 my $self = shift; 359 my ($self) = @_;
174 360
361 return "" unless $self->{isOpen};
175 return $self->{pg}->{head_text} if $self->{pg}->{head_text}; 362 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
176} 363}
177 364
178sub path { 365sub options {
179 my $self = shift; 366 my ($self) = @_;
180 my $args = $_[-1];
181 my $setName = $self->{set}->id;
182 my $problemNumber = $self->{problem}->id;
183 367
184 my $ce = $self->{courseEnvironment}; 368 return "" if $self->{invalidProblem};
185 my $root = $ce->{webworkURLs}->{root}; 369
186 my $courseName = $ce->{courseName}; 370 return join("",
187 return $self->pathMacro($args, 371 CGI::start_form("POST", $self->{r}->uri),
188 "Home" => "$root", 372 $self->hidden_authen_fields,
189 $courseName => "$root/$courseName", 373 CGI::hr(),
190 $setName => "$root/$courseName/$setName", 374 CGI::start_div({class=>"viewOptions"}),
191 "Problem $problemNumber" => "", 375 $self->viewOptions(),
376 CGI::end_div(),
377 CGI::end_form()
192 ); 378 );
193} 379}
194 380
381#sub path {
382# my $self = shift;
383# my $args = $_[-1];
384# my $setName = $self->{set}->set_id;
385# my $problemNumber = $self->{problem}->problem_id;
386#
387# my $ce = $self->{ce};
388# my $root = $ce->{webworkURLs}->{root};
389# my $courseName = $ce->{courseName};
390# return $self->pathMacro($args,
391# "Home" => "$root",
392# $courseName => "$root/$courseName",
393# $setName => "$root/$courseName/$setName",
394# "Problem $problemNumber" => "",
395# );
396#}
397
195sub siblings { 398sub siblings {
196 my $self = shift; 399 my ($self) = @_;
400 my $r = $self->r;
401 my $db = $r->db;
402 my $urlpath = $r->urlpath;
403
404 # can't show sibling problems if the set is invalid
405 return "" if $self->{invalidSet};
406
407 my $courseID = $urlpath->arg("courseID");
197 my $setName = $self->{set}->id; 408 my $setID = $self->{set}->set_id;
198 my $problemNumber = $self->{problem}->id; 409 my $eUserID = $r->param("effectiveUser");
410 my @problemIDs = sort { $a <=> $b } $db->listUserProblems($eUserID, $setID);
199 411
200 my $ce = $self->{courseEnvironment}; 412 print CGI::start_ul({class=>"LinksMenu"});
201 my $root = $ce->{webworkURLs}->{root}; 413 print CGI::start_li();
202 my $courseName = $ce->{courseName}; 414 print CGI::span({style=>"font-size:larger"}, "Problems");
415 print CGI::start_ul();
203 416
204 print CGI::strong("Problems"), CGI::br(); 417 foreach my $problemID (@problemIDs) {
205 418 my $problemPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Problem",
206 my $wwdb = $self->{wwdb}; 419 courseID => $courseID, setID => $setID, problemID => $problemID);
207 my $user = $self->{r}->param("user"); 420 print CGI::li(CGI::a({href=>$self->systemLink($problemPage)}, "Problem $problemID"));
208 my @problems;
209 push @problems, $wwdb->getProblem($user, $setName, $_)
210 foreach ($wwdb->getProblems($user, $setName));
211 foreach my $problem (sort { $a->id <=> $b->id } @problems) {
212 print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?"
213 . $self->url_authen_args}, "Problem ".$problem->id), CGI::br();
214 } 421 }
422
423 print CGI::end_ul();
424 print CGI::end_li();
425 print CGI::end_ul();
426
427 return "";
215} 428}
216 429
217sub nav { 430sub nav {
218 my $self = shift; 431 my ($self, $args) = @_;
219 my $args = $_[-1]; 432 my $r = $self->r;
220 my $setName = $self->{set}->id; 433 my $db = $r->db;
221 my $problemNumber = $self->{problem}->id; 434 my $urlpath = $r->urlpath;
222 435
223 my $ce = $self->{courseEnvironment}; 436 my $courseID = $urlpath->arg("courseID");
224 my $root = $ce->{webworkURLs}->{root}; 437 my $setID = $self->{set}->set_id if !($self->{invalidSet});
225 my $courseName = $ce->{courseName}; 438 my $problemID = $self->{problem}->problem_id if !($self->{invalidProblem});
439 my $eUserID = $r->param("effectiveUser");
226 440
227 my $wwdb = $self->{wwdb}; 441 my ($prevID, $nextID);
228 my $user = $self->{r}->param("user"); 442
443 if (!$self->{invalidProblem}) {
444 my @problemIDs = $db->listUserProblems($eUserID, $setID);
445 foreach my $id (@problemIDs) {
446 $prevID = $id if $id < $problemID
447 and (not defined $prevID or $id > $prevID);
448 $nextID = $id if $id > $problemID
449 and (not defined $nextID or $id < $nextID);
450 }
451 }
229 452
230 my @links = ("Problem List" => "$root/$courseName/$setName"); 453 my @links;
231 454
232 my $prevProblem = $wwdb->getProblem($user, $setName, $problemNumber-1); 455 if ($prevID) {
233 my $nextProblem = $wwdb->getProblem($user, $setName, $problemNumber+1); 456 my $prevPage = $urlpath->newFromModule(__PACKAGE__,
234 unshift @links, "Previous Problem" => $prevProblem 457 courseID => $courseID, setID => $setID, problemID => $prevID);
235 ? "$root/$courseName/$setName/".$prevProblem->id 458 push @links, "Previous Problem", $r->location . $prevPage->path, "navPrev";
236 : ""; 459 } else {
237 push @links, "Next Problem" => $nextProblem 460 push @links, "Previous Problem", "", "navPrev";
238 ? "$root/$courseName/$setName/".$nextProblem->id 461 }
239 : "";
240 462
463 push @links, "Problem List", $r->location . $urlpath->parent->path, "navProbList";
464
465 if ($nextID) {
466 my $nextPage = $urlpath->newFromModule(__PACKAGE__,
467 courseID => $courseID, setID => $setID, problemID => $nextID);
468 push @links, "Next Problem", $r->location . $nextPage->path, "navNext";
469 } else {
470 push @links, "Next Problem", "", "navNext";
471 }
472
473 my $tail = "&displayMode=".$self->{displayMode};
241 return $self->navMacro($args, @links); 474 return $self->navMacro($args, $tail, @links);
242} 475}
243 476
244sub title { 477sub title {
245 my $self = shift; 478 my ($self) = @_;
479
480 # using the url arguments won't break if the set/problem are invalid
481 my $setID = $self->r->urlpath->arg("setID");
482 my $problemID = $self->r->urlpath->arg("problemID");
483
246 my $setName = $self->{set}->id; 484 #my $setID = $self->{set}->set_id;
247 my $problemNumber = $self->{problem}->id; 485 #my $problemID = $self->{problem}->problem_id;
248 486
249 return "$setName : Problem $problemNumber"; 487 return "$setID : $problemID";
250} 488}
251 489
252sub body { 490sub body {
253 my $self = shift; 491 my $self = shift;
492 my $r = $self->r;
493 my $ce = $r->ce;
494 my $db = $r->db;
495 my $urlpath = $r->urlpath;
496
497 if ($self->{invalidSet}) {
498 return CGI::div({class=>"ResultsWithError"},
499 CGI::p("The selected problem set (" . $urlpath->arg("setID") . ") is not a valid set for " . $r->param("effectiveUser") . "."));
500 }
254 501
502 if ($self->{invalidProblem}) {
503 return CGI::div({class=>"ResultsWithError"},
504 CGI::p("The selected problem (" . $urlpath->arg("problemID") . ") is not a valid problem for set " . $self->{set}->set_id . "."));
505 }
506
507 unless ($self->{isOpen}) {
508 return CGI::div({class=>"ResultsWithError"},
509 CGI::p("This problem is not available because the problem set that contains it is not yet open."));
510 }
255 # unpack some useful variables 511 # unpack some useful variables
256 my $r = $self->{r};
257 my $wwdb = $self->{wwdb};
258 my $set = $self->{set}; 512 my $set = $self->{set};
259 my $problem = $self->{problem}; 513 my $problem = $self->{problem};
514 my $editMode = $self->{editMode};
260 my $permissionLevel = $self->{permissionLevel}; 515 my $permissionLevel = $self->{permissionLevel};
261 my $submitAnswers = $self->{submitAnswers}; 516 my $submitAnswers = $self->{submitAnswers};
517 my $checkAnswers = $self->{checkAnswers};
262 my $previewAnswers = $self->{previewAnswers}; 518 my $previewAnswers = $self->{previewAnswers};
519 my %want = %{ $self->{want} };
520 my %can = %{ $self->{can} };
521 my %must = %{ $self->{must} };
263 my %will = %{ $self->{will} }; 522 my %will = %{ $self->{will} };
264 my $pg = $self->{pg}; 523 my $pg = $self->{pg};
265 524
525 #my $root = $ce->{webworkURLs}->{root};
526 my $courseName = $urlpath->arg("courseID");
527
528 #####create Editor link #####
529 ## print editor link if the user is an instructor AND the file is not in temporary editing mode
530 #my $editorLinkMessage = '';
531 ## and ( (not defined($self->{editMode})) or $self->{editMode} eq 'savedFile') # FIXME is this needed?
532 #if ($self->{permissionLevel}>=10 ) {
533 # $editorLinkMessage = CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".
534 # $set->set_id.'/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');
535 #}
536
537 my $editorLink = "";
538 # if we are here without a real problem set, carry that through
539 my $forced_field = [];
540 $forced_field = ['sourceFilePath' => $r->param("sourceFilePath")] if
541 ($set->set_id eq 'Undefined_Set');
542 if ($self->{permissionLevel}>=10) {
543 my $editorPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::PGProblemEditor",
544 courseID => $courseName, setID => $set->set_id, problemID => $problem->problem_id);
545 my $editorURL = $self->systemLink($editorPage, params=>$forced_field);
546 $editorLink = CGI::a({href=>$editorURL}, "Edit this problem");
547 }
548
266 ##### translation errors? ##### 549 ##### translation errors? #####
267 550
268 if ($pg->{flags}->{error_flag}) { 551 if ($pg->{flags}->{error_flag}) {
269 return translationError($pg->{errors}, $pg->{body_text}); 552 print $self->errorOutput($pg->{errors}, $pg->{body_text});
553 print $editorLink;
554 return "";
270 } 555 }
271 556
272 ##### answer processing ##### 557 ##### answer processing #####
273 558 $WeBWorK::timer->continue("begin answer processing") if defined($WeBWorK::timer);
274 # if answers were submitted: 559 # if answers were submitted:
560 my $scoreRecordedMessage;
561 my $pureProblem;
275 if ($submitAnswers) { 562 if ($submitAnswers) {
563 # get a "pure" (unmerged) UserProblem to modify
564 # this will be undefined if the problem has not been assigned to this user
565 $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id); # checked
566 if (defined $pureProblem) {
276 # store answers in DB for sticky answers 567 # store answers in DB for sticky answers
277 my %answersToStore; 568 my %answersToStore;
278 my %answerHash = %{ $pg->{answers} }; 569 my %answerHash = %{ $pg->{answers} };
279 $answersToStore{$_} = $answerHash{$_}->{original_student_ans} 570 $answersToStore{$_} = $self->{formFields}->{$_} #$answerHash{$_}->{original_student_ans} -- this may have been modified for fields with multiple values. Don't use it!!
280 foreach (keys %answerHash); 571 foreach (keys %answerHash);
572
573 # There may be some more answers to store -- one which are auxiliary entries to a primary answer. Evaluating
574 # matrices works in this way, only the first answer triggers an answer evaluator, the rest are just inputs
575 # however we need to store them. Fortunately they are still in the input form.
576 my @extra_answer_names = @{ $pg->{flags}->{KEPT_EXTRA_ANSWERS}};
577 $answersToStore{$_} = $self->{formFields}->{$_} foreach (@extra_answer_names);
578
579 # Now let's encode these answers to store them -- append the extra answers to the end of answer entry order
580 my @answer_order = (@{$pg->{flags}->{ANSWER_ENTRY_ORDER}}, @extra_answer_names);
281 my $answerString = encodeAnswers(%answersToStore, 581 my $answerString = encodeAnswers(%answersToStore,
282 @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); 582 @answer_order);
583
584 # store last answer to database
283 $problem->last_answer($answerString); 585 $problem->last_answer($answerString);
586 $pureProblem->last_answer($answerString);
284 $wwdb->setProblem($problem); 587 $db->putUserProblem($pureProblem);
285 588
286 # store state in DB if it makes sense 589 # store state in DB if it makes sense
287 if ($will{recordAnswers}) { 590 if ($will{recordAnswers}) {
288 $problem->attempted(1);
289 $problem->status($pg->{state}->{recorded_score}); 591 $problem->status($pg->{state}->{recorded_score});
592 $problem->attempted(1);
290 $problem->num_correct($pg->{state}->{num_of_correct_ans}); 593 $problem->num_correct($pg->{state}->{num_of_correct_ans});
291 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); 594 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
292 $wwdb->setProblem($problem); 595 $pureProblem->status($pg->{state}->{recorded_score});
596 $pureProblem->attempted(1);
597 $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
598 $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
599 if ($db->putUserProblem($pureProblem)) {
600 $scoreRecordedMessage = "Your score was recorded.";
601 } else {
602 $scoreRecordedMessage = "Your score was not recorded because there was a failure in storing the problem record to the database.";
603 }
293 # write to the transaction log, just to make sure 604 # write to the transaction log, just to make sure
294 writeLog($self->{courseEnvironment}, "transaction", 605 writeLog($self->{ce}, "transaction",
295 $problem->id."\t". 606 $problem->problem_id."\t".
296 $problem->set_id."\t". 607 $problem->set_id."\t".
297 $problem->login_id."\t". 608 $problem->user_id."\t".
298 $problem->source_file."\t". 609 $problem->source_file."\t".
299 $problem->value."\t". 610 $problem->value."\t".
300 $problem->max_attempts."\t". 611 $problem->max_attempts."\t".
301 $problem->problem_seed."\t". 612 $problem->problem_seed."\t".
302 $problem->status."\t". 613 $pureProblem->status."\t".
303 $problem->attempted."\t". 614 $pureProblem->attempted."\t".
304 $problem->last_answer."\t". 615 $pureProblem->last_answer."\t".
305 $problem->num_correct."\t". 616 $pureProblem->num_correct."\t".
306 $problem->num_incorrect 617 $pureProblem->num_incorrect
618 );
619 } else {
620 if (time < $set->open_date or time > $set->due_date) {
621 $scoreRecordedMessage = "Your score was not recorded because this problem set is closed.";
622 } else {
623 $scoreRecordedMessage = "Your score was not recorded.";
624 }
625 }
626 } else {
627 $scoreRecordedMessage = "Your score was not recorded because this problem has not been built for you.";
628 }
629 }
630
631 # logging student answers
632
633 my $answer_log = $self->{ce}->{courseFiles}->{logs}->{'answer_log'};
634 if ( defined($answer_log ) and defined($pureProblem)) {
635 if ($submitAnswers ) {
636 my $answerString = "";
637 my %answerHash = %{ $pg->{answers} };
638 # FIXME this is the line 552 error. make sure original student ans is defined.
639 # The fact that it is not defined is probably due to an error in some answer evaluator.
640 # But I think it is useful to suppress this error message in the log.
641 foreach (sort keys %answerHash) {
642 my $student_ans = $answerHash{$_}->{original_student_ans} ||'';
643 $answerString .= $student_ans."\t"
644 }
645 $answerString = '' unless defined($answerString); # insure string is defined.
646 writeCourseLog($self->{ce}, "answer_log",
647 join("",
648 '|', $problem->user_id,
649 '|', $problem->set_id,
650 '|', $problem->problem_id,
651 '|',"\t",
652 time(),"\t",
653 $answerString,
654 ),
307 ); 655 );
656
308 } 657 }
309 } 658 }
310 659
660 $WeBWorK::timer->continue("end answer processing") if defined($WeBWorK::timer);
661
311 ##### output ##### 662 ##### output #####
312 663
664 print CGI::start_div({class=>"problemHeader"});
665
666 # custom message for editor
667 if ($permissionLevel >= 10 and defined $editMode) {
668 if ($editMode eq "temporaryFile") {
669 print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file));
670 } elsif ($editMode eq "savedFile") {
671 # FIXME: this is all done automatically if submitError exists.
672 #if ( defined($r->param('submiterror')) and $r->param('submiterror') ) {
673 # FIXME The following line doesn't work because the submiterror hook has already been called.
674 # The actions below should take place during the initialization phase.
675 # $self->{submiterror} .= $r->param('submiterror');
676 # print CGI::p(CGI::div({class=>'ResultsWithError'},$self->{submiterror}));
677 #} else {
678 # print CGI::p(CGI::div({ class=>'ResultsWithoutError'}, "Problem saved to: ", $problem->source_file));
679 #}
680 }
681 }
682 #FIXME we need error messages here if the problem was really not saved.
313 # attempt summary 683 # attempt summary
314 if ($submitAnswers or $will{showCorrectAnswers}) { 684 #FIXME -- the following is a kludge: if showPartialCorrectAnswers is negative don't show anything.
685 # until after the due date
686 # do I need to check $wills{howCorrectAnswers} to make preflight work??
687 if (($pg->{flags}->{showPartialCorrectAnswers}>= 0 and $submitAnswers) ) {
315 # print this if user submitted answers OR requested correct answers 688 # print this if user submitted answers OR requested correct answers
316 print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, 689
690 print $self->attemptResults($pg, 1,
691 $will{showCorrectAnswers},
317 $pg->{flags}->{showPartialCorrectAnswers}); 692 $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
693 } elsif ($checkAnswers) {
694 # print this if user previewed answers
695 print CGI::div({class=>'ResultsWithError'},"ANSWERS ONLY CHECKED -- ",CGI::br(),"ANSWERS NOT RECORDED", CGI::br() );
696 print $self->attemptResults($pg, 1, $will{showCorrectAnswers}, 1, 1, 1);
697 # show attempt answers
698 # show correct answers if asked
699 # show attempt results (correctness)
700 # show attempt previews
318 } elsif ($previewAnswers) { 701 } elsif ($previewAnswers) {
319 # print this if user previewed answers 702 # print this if user previewed answers
320 print $self->attemptResults($pg, 1, 0, 0); 703 print CGI::div({class=>'ResultsWithError'},"PREVIEW ONLY -- NOT RECORDED"),CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1);
321 # don't show correctness 704 # show attempt answers
322 # don't show correct answers 705 # don't show correct answers
706 # don't show attempt results (correctness)
707 # show attempt previews
323 } 708 }
709
710 print CGI::end_div();
711
712 print CGI::start_div({class=>"problem"});
713
714 # main form
715 print
716 CGI::startform("POST", $r->uri),
717 $self->hidden_authen_fields,
718 CGI::p($pg->{body_text}),
719 CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),
720 CGI::p(
721 ($can{showCorrectAnswers}
722 ? CGI::checkbox(
723 -name => "showCorrectAnswers",
724 -checked => $will{showCorrectAnswers},
725 -label => "Show correct answers",
726 ) ." "
727 : "" ),
728 ($can{showHints}
729 ? '<div style="color:red">'. CGI::checkbox(
730 -name => "showHints",
731 -checked => $will{showHints},
732 -label => "Show Hints",
733 ) . "</div> "
734 : " " ),
735 ($can{showSolutions}
736 ? CGI::checkbox(
737 -name => "showSolutions",
738 -checked => $will{showSolutions},
739 -label => "Show Solutions",
740 ) . " "
741 : " " ),CGI::br(),
742 CGI::submit(-name=>"previewAnswers",
743 -label=>"Preview Answers"),
744 ($can{recordAnswers}
745 ? CGI::submit(-name=>"submitAnswers",
746 -label=>"Submit Answers")
747 : ""),
748 ( $can{checkAnswers}
749 ? CGI::submit(-name=>"checkAnswers",
750 -label=>"Check Answers")
751 : ""),
752 );
753 print CGI::end_div();
754
755 print CGI::start_div({class=>"scoreSummary"});
324 756
325 # score summary 757 # score summary
326 my $attempts = $problem->num_correct + $problem->num_incorrect; 758 my $attempts = $problem->num_correct + $problem->num_incorrect;
327 my $attemptsNoun = $attempts != 1 ? "times" : "time"; 759 my $attemptsNoun = $attempts != 1 ? "times" : "time";
328 my $lastScore = int ($problem->status * 100) . "%"; 760 my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number
329 my ($attemptsLeft, $attemptsLeftNoun); 761 my ($attemptsLeft, $attemptsLeftNoun);
330 if ($problem->max_attempts == -1) { 762 if ($problem->max_attempts == -1) {
331 # unlimited attempts 763 # unlimited attempts
332 $attemptsLeft = "unlimited"; 764 $attemptsLeft = "unlimited";
333 $attemptsLeftNoun = "attempts"; 765 $attemptsLeftNoun = "attempts";
334 } else { 766 } else {
335 $attemptsLeft = $problem->max_attempts - $attempts; 767 $attemptsLeft = $problem->max_attempts - $attempts;
336 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; 768 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
337 } 769 }
770
771 my $setClosed = 0;
338 my $setClosedMessage; 772 my $setClosedMessage;
339 if (time < $set->open_date or time > $set->due_date) { 773 if (time < $set->open_date or time > $set->due_date) {
774 $setClosed = 1;
340 $setClosedMessage = "This problem set is closed."; 775 $setClosedMessage = "This problem set is closed.";
341 if ($permissionLevel > 0) { 776 if ($permissionLevel > 0) {
342 $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded."; 777 $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
343 } else { 778 } else {
344 $setClosedMessage .= " Additional attempts will not be recorded."; 779 $setClosedMessage .= " Additional attempts will not be recorded.";
345 } 780 }
346 } 781 }
782
783 my $notCountedMessage = ($problem->value) ? "" : "(This problem will not count towards your grade.)";
347 print CGI::p( 784 print CGI::p(
785 $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
348 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), 786 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
349 $problem->attempted 787 $problem->attempted
350 ? "Your recorded score is $lastScore." . CGI::br() 788 ? "Your recorded score is $lastScore. $notCountedMessage" . CGI::br()
351 : "", 789 : "",
352 "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), 790 $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
353 $setClosedMessage,
354 ); 791 );
355 792 print CGI::end_div();
793
794 # save state for viewOptions
795 print CGI::hidden(
796 -name => "showOldAnswers",
797 -value => $will{showOldAnswers}
798 ),
799
800 CGI::hidden(
801 -name => "displayMode",
802 -value => $self->{displayMode}
803 );
804 print( CGI::hidden(
805 -name => 'editMode',
806 -value => $self->{editMode},
807 )
808 ) if defined($self->{editMode}) and $self->{editMode} eq 'temporaryFile';
809 print( CGI::hidden(
810 -name => 'sourceFilePath',
811 -value => $self->{problem}->{source_file}
812 )) if defined($self->{problem}->{source_file});
813
814 # end of main form
356 print CGI::hr(); 815 print CGI::endform();
357 816
358 # main form 817 print CGI::start_div({class=>"problemFooter"});
818
819 ## arguments for answer inspection button
820 #my $prof_url = $ce->{webworkURLs}->{oldProf};
821 #my $webworkURL = $ce->{webworkURLs}->{root};
822 #my $cgi_url = $prof_url;
823 #$cgi_url=~ s|/[^/]*$||; # clip profLogin.pl
824 #my $authen_args = $self->url_authen_args();
825 #my $showPastAnswersURL = "$webworkURL/$courseName/instructor/show_answers/";
826
827 my $pastAnswersPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::ShowAnswers",
828 courseID => $courseName);
829 my $showPastAnswersURL = $self->systemLink($pastAnswersPage, authen => 0); # no authen info for form action
830
831 # print answer inspection button
832 if ($self->{permissionLevel} > 0) {
833 print "\n",
834 CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
835 $self->hidden_authen_fields,"\n",
836 CGI::hidden(-name => 'courseID', -value=>$courseName), "\n",
837 CGI::hidden(-name => 'problemID', -value=>$problem->problem_id), "\n",
838 CGI::hidden(-name => 'setID', -value=>$problem->set_id), "\n",
839 CGI::hidden(-name => 'studentUser', -value=>$problem->user_id), "\n",
840 CGI::p( {-align=>"left"},
841 CGI::submit(-name => 'action', -value=>'Show Past Answers')
842 ), "\n",
843 CGI::endform();
844 }
845
846 ## arguments for feedback form
847 #my $feedbackURL = "$root/$courseName/feedback/";
848 #
849 ##print feedback form
850 #print
851 # CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
852 # $self->hidden_authen_fields,"\n",
853 # CGI::hidden("module", __PACKAGE__),"\n",
854 # CGI::hidden("set", $set->set_id),"\n",
855 # CGI::hidden("problem", $problem->problem_id),"\n",
856 # CGI::hidden("displayMode", $self->{displayMode}),"\n",
857 # CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
858 # CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
859 # CGI::hidden("showHints", $will{showHints}),"\n",
860 # CGI::hidden("showSolutions", $will{showSolutions}),"\n",
861 # CGI::p({-align=>"left"},
862 # CGI::submit(-name=>"feedbackForm", -label=>"Email instructor")
863 # ),
864 # CGI::endform(),"\n";
865
866 # feedback form url
867 my $feedbackPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Feedback",
868 courseID => $courseName);
869 my $feedbackURL = $self->systemLink($feedbackPage, authen => 0); # no authen info for form action
870
871 #print feedback form
359 print 872 print
360 CGI::startform("POST", $r->uri), 873 CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
361 $self->hidden_authen_fields, 874 $self->hidden_authen_fields,"\n",
362 $self->viewOptions, 875 CGI::hidden("module", __PACKAGE__),"\n",
363 CGI::p(CGI::i($pg->{result}->{msg})), 876 CGI::hidden("set", $set->set_id),"\n",
364 CGI::p($pg->{body_text}), 877 CGI::hidden("problem", $problem->problem_id),"\n",
365 CGI::p( 878 CGI::hidden("displayMode", $self->{displayMode}),"\n",
366 CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"), 879 CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
367 CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"), 880 CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
881 CGI::hidden("showHints", $will{showHints}),"\n",
882 CGI::hidden("showSolutions", $will{showSolutions}),"\n",
883 CGI::p({-align=>"left"},
884 CGI::submit(-name=>"feedbackForm", -label=>"Email instructor")
368 ), 885 ),
369 CGI::endform(); 886 CGI::endform(),"\n";
887
888 # FIXME print editor link
889 print $editorLink; #empty unless it is appropriate to have an editor link.
890
891 print CGI::end_div();
370 892
371 # warning output 893 # warning output
372 if ($pg->{warnings} ne "") { 894 #if ($pg->{warnings} ne "") {
373 print CGI::hr(), warningOutput($pg->{warnings}); 895 # print CGI::hr(), $self->warningOutput($pg->{warnings});
374 } 896 #}
375 897
376 # debugging stuff 898 # debugging stuff
899 if (0) {
377 #print 900 print
378 # CGI::hr(), 901 CGI::hr(),
379 # CGI::h2("debugging information"), 902 CGI::h2("debugging information"),
380 # CGI::h3("form fields"), 903 CGI::h3("form fields"),
381 # ref2string($self->{formFields}), 904 ref2string($self->{formFields}),
382 # CGI::h3("user object"), 905 CGI::h3("user object"),
383 # ref2string($self->{user}), 906 ref2string($self->{user}),
384 # CGI::h3("set object"), 907 CGI::h3("set object"),
385 # ref2string($set), 908 ref2string($set),
386 # CGI::h3("problem object"), 909 CGI::h3("problem object"),
387 # ref2string($problem), 910 ref2string($problem),
388 # CGI::h3("PG object"), 911 CGI::h3("PG object"),
389 # ref2string($pg, {'WeBWorK::PG::Translator' => 1}); 912 ref2string($pg, {'WeBWorK::PG::Translator' => 1});
913 }
390 914
391 return ""; 915 return "";
392} 916}
393 917
394##### output utilities ##### 918##### output utilities #####
395 919
396# this is used by ProblemSet.pm too, so don't fuck it up
397sub translationError($$) {
398 my ($error, $details) = @_;
399 return
400 CGI::h2("Software Error"),
401 CGI::p(<<EOF),
402WeBWorK has encountered a software error while attempting to process this problem.
403It is likely that there is an error in the problem itself.
404If you are a student, contact your professor to have the error corrected.
405If you are a professor, please consut the error output below for more informaiton.
406EOF
407 CGI::h3("Error messages"), CGI::blockquote(CGI::pre($error)),
408 CGI::h3("Error context"), CGI::blockquote(CGI::pre($details));
409}
410
411# this is used by ProblemSet.pm too, so don't fuck it up
412sub warningOutput($) {
413 my $warnings = shift;
414
415 return
416 CGI::h2("Software Warnings"),
417 CGI::p(<<EOF),
418WeBWorK has encountered warnings while attempting to process this problem.
419It is likely that this indicates an error or ambiguity in the problem itself.
420If you are a student, contact your professor to have the problem corrected.
421If you are a professor, please consut the error output below for more informaiton.
422EOF
423 CGI::h3("Warning messages"),
424 CGI::blockquote(CGI::pre($warnings)),
425 ;
426}
427
428sub attemptResults($$$$$) { 920sub attemptResults {
429 my $self = shift; 921 my $self = shift;
430 my $pg = shift; 922 my $pg = shift;
431 my $showAttemptAnswers = shift; 923 my $showAttemptAnswers = shift;
432 my $showCorrectAnswers = shift; 924 my $showCorrectAnswers = shift;
433 my $showAttemptResults = $showAttemptAnswers && shift; 925 my $showAttemptResults = $showAttemptAnswers && shift;
926 my $showSummary = shift;
927 my $showAttemptPreview = shift || 0;
928
929 my $ce = $self->r->ce;
930
434 my $problemResult = $pg->{result}; # the overall result of the problem 931 my $problemResult = $pg->{result}; # the overall result of the problem
435 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; 932 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
436 933
934 my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
935
936 my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
937 my $imgGen = WeBWorK::PG::ImageGenerator->new(
938 tempDir => $ce->{webworkDirs}->{tmp},
939 latex => $ce->{externalPrograms}->{latex},
940 dvipng => $ce->{externalPrograms}->{dvipng},
941 useCache => 1,
942 cacheDir => $ce->{webworkDirs}->{equationCache},
943 cacheURL => $ce->{webworkURLs}->{equationCache},
944 cacheDB => $ce->{webworkFiles}->{equationCacheDB},
945 );
946
947 my $header;
437 my $header = CGI::th("answer"); 948 #$header .= CGI::th("Part");
438 $header .= $showAttemptAnswers ? CGI::th("attempt") : ""; 949 $header .= $showAttemptAnswers ? CGI::th("Entered") : "";
439 $header .= $showAttemptAnswers ? CGI::th("preview") : ""; 950 $header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
440 $header .= $showCorrectAnswers ? CGI::th("correct") : ""; 951 $header .= $showCorrectAnswers ? CGI::th("Correct") : "";
441 $header .= $showAttemptResults ? CGI::th("result") : ""; 952 $header .= $showAttemptResults ? CGI::th("Result") : "";
442 $header .= $showAttemptAnswers ? CGI::th("messages") : ""; 953 $header .= $showMessages ? CGI::th("Messages") : "";
443 my @tableRows = ( $header ); 954 my @tableRows = ( $header );
444 my $numCorrect; 955 my $numCorrect;
445 foreach my $name (@answerNames) { 956 foreach my $name (@answerNames) {
446 my $answerResult = $pg->{answers}->{$name}; 957 my $answerResult = $pg->{answers}->{$name};
447 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans 958 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
448 my $preview = $self->previewAnswer($answerResult); 959 my $preview = ($showAttemptPreview
960 ? $self->previewAnswer($answerResult, $imgGen)
961 : "");
449 my $correctAnswer = $answerResult->{correct_ans}; 962 my $correctAnswer = $answerResult->{correct_ans};
450 my $answerScore = $answerResult->{score}; 963 my $answerScore = $answerResult->{score};
451 my $answerMessage = $showAttemptAnswers ? $answerResult->{ans_message} : ""; 964 my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
452 965 #FIXME --Can we be sure that $answerScore is an integer-- could the problem give partial credit?
453 $numCorrect += $answerScore > 0; 966 $numCorrect += $answerScore > 0;
454 my $resultString = $answerScore ? "correct" : "incorrect"; 967 my $resultString = $answerScore == 1 ? "correct" : "incorrect";
455 968
456 # get rid of the goofy prefix on the answer names (supposedly, the format 969 # get rid of the goofy prefix on the answer names (supposedly, the format
457 # of the answer names is changeable. this only fixes 970 # of the answer names is changeable. this only fixes it for "AnSwEr"
458 $name =~ s/^AnSwEr//; 971 #$name =~ s/^AnSwEr//;
459 972
973 my $row;
460 my $row = CGI::td($name); 974 #$row .= CGI::td($name);
461 $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : ""; 975 $row .= $showAttemptAnswers ? CGI::td($self->nbsp($studentAnswer)) : "";
462 $row .= $showAttemptAnswers ? CGI::td($preview) : ""; 976 $row .= $showAttemptPreview ? CGI::td($self->nbsp($preview)) : "";
463 $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; 977 $row .= $showCorrectAnswers ? CGI::td($self->nbsp($correctAnswer)) : "";
464 $row .= $showAttemptResults ? CGI::td($resultString) : ""; 978 $row .= $showAttemptResults ? CGI::td($self->nbsp($resultString)) : "";
465 $row .= $answerMessage ? CGI::td($answerMessage) : ""; 979 $row .= $showMessages ? CGI::td($self->nbsp($answerMessage)) : "";
466 push @tableRows, $row; 980 push @tableRows, $row;
467 } 981 }
468 982
983 # render equation images
984 $imgGen->render(refresh => 1);
985
469 my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions"; 986# my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
470 my $scorePercent = int ($problemResult->{score} * 100) . "\%"; 987 my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
988# FIXME -- I left the old code in in case we have to back out.
471 my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of " 989# my $summary = "On this attempt, you answered $numCorrect out of "
472 . scalar @answerNames . " correct, for a score of $scorePercent."; 990# . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
473 return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary); 991 my $summary = "";
992 if (scalar @answerNames == 1) {
993 if ($numCorrect == scalar @answerNames) {
994 $summary .= CGI::div({class=>"ResultsWithoutError"},"The above answer is correct.");
995 } else {
996 $summary .= CGI::div({class=>"ResultsWithError"},"The above answer is NOT correct.");
997 }
998 } else {
999 if ($numCorrect == scalar @answerNames) {
1000 $summary .= CGI::div({class=>"ResultsWithoutError"},"All of the above answers are correct.");
1001 } else {
1002 $summary .= CGI::div({class=>"ResultsWithError"},"At least one of the above answers is NOT correct.");
1003 }
1004 }
1005
1006 return
1007 CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows))
1008 . ($showSummary ? CGI::p({class=>'emphasis'},$summary) : "");
474} 1009}
475 1010
1011#sub nbsp {
1012# my $str = shift;
1013# ($str =~/\S/) ? $str : '&nbsp;' ; # returns non-breaking space for empty strings
1014# # tricky cases: $str =0;
1015# # $str is a complex number
1016#}
1017
476sub viewOptions($) { 1018sub viewOptions {
477 my $self = shift; 1019 my ($self) = @_;
1020
478 my $displayMode = $self->{displayMode}; 1021 my $displayMode = $self->{displayMode};
479 my %must = %{ $self->{must} }; 1022 my %must = %{ $self->{must} };
480 my %can = %{ $self->{can} }; 1023 my %can = %{ $self->{can} };
481 my %will = %{ $self->{will} }; 1024 my %will = %{ $self->{will} };
482 1025
483 my $optionLine; 1026 my $optionLine;
484 $can{showOldAnswers} and $optionLine .= join "", 1027 $can{showOldAnswers} and $optionLine .= join "",
485 "Show: &nbsp;", 1028 "Show: &nbsp;".CGI::br(),
486 CGI::checkbox( 1029 CGI::checkbox(
487 -name => "showOldAnswers", 1030 -name => "showOldAnswers",
488 -checked => $will{showOldAnswers}, 1031 -checked => $will{showOldAnswers},
489 -label => "Saved answers", 1032 -label => "Saved answers",
490 ), "&nbsp;&nbsp;"; 1033 ), "&nbsp;&nbsp;".CGI::br();
491 $can{showCorrectAnswers} and $optionLine .= join "", 1034
492 CGI::checkbox(
493 -name => "showCorrectAnswers",
494 -checked => $will{showCorrectAnswers},
495 -label => "Correct answers",
496 ), "&nbsp;&nbsp;";
497 $can{showHints} and $optionLine .= join "",
498 CGI::checkbox(
499 -name => "showHints",
500 -checked => $will{showHints},
501 -label => "Hints",
502 ), "&nbsp;&nbsp;";
503 $can{showSolutions} and $optionLine .= join "",
504 CGI::checkbox(
505 -name => "showSolutions",
506 -checked => $will{showSolutions},
507 -label => "Solutions",
508 ), "&nbsp;&nbsp;";
509 $optionLine and $optionLine .= join "", CGI::br(); 1035 $optionLine and $optionLine .= join "", CGI::br();
510 1036
511 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, 1037 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
512 "View equations as: &nbsp;", 1038 "View&nbsp;equations&nbsp;as:&nbsp;&nbsp;&nbsp;&nbsp;".CGI::br(),
513 CGI::radio_group( 1039 CGI::radio_group(
514 -name => "displayMode", 1040 -name => "displayMode",
515 -values => ['plainText', 'formattedText', 'images'], 1041 -values => ['plainText', 'formattedText', 'images', 'jsMath'],
516 -default => $displayMode, 1042 -default => $displayMode,
1043 -linebreak=>'true',
517 -labels => { 1044 -labels => {
518 plainText => "plain text", 1045 plainText => "plain",
519 formattedText => "formatted text", 1046 formattedText => "formatted",
520 images => "images", 1047 images => "images",
1048 jsMath => "jsMath",
521 } 1049 }
522 ), CGI::br(), 1050 ), CGI::br(),CGI::hr(),
523 $optionLine, 1051 $optionLine,
524 CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"), 1052 CGI::submit(-name=>"redisplay", -label=>"Save Options"),
525 ); 1053 );
526} 1054}
527 1055
528sub previewAnswer($$) { 1056sub previewAnswer {
529 my ($self, $answerResult) = @_; 1057 my ($self, $answerResult, $imgGen) = @_;
530 my $ce = $self->{courseEnvironment}; 1058 my $ce = $self->r->ce;
531 my $user = $self->{user}; 1059 my $effectiveUser = $self->{effectiveUser};
532 my $set = $self->{set}; 1060 my $set = $self->{set};
533 my $problem = $self->{problem}; 1061 my $problem = $self->{problem};
1062 my $displayMode = $self->{displayMode};
534 1063
535 # how are we going to name this? 1064 # note: right now, we have to do things completely differently when we are
536 my $targetPathCommon = "/png/" 1065 # rendering math from INSIDE the translator and from OUTSIDE the translator.
537 . $user->id . "." 1066 # so we'll just deal with each case explicitly here. there's some code
538 . $set->id . "." 1067 # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
539 . $problem->id . "."
540 . $answerResult->{ans_name} . ".png";
541 1068
542 # figure out where to put things
543 my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp});
544 my $latex = $ce->{externalPrograms}->{latex};
545 my $dvipng = $ce->{externalPrograms}->{dvipng};
546 my $tex = $answerResult->{preview_latex_string}; 1069 my $tex = $answerResult->{preview_latex_string};
547 my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
548 # should use surePathToTmpFile, but we have to
549 # isolate it from the problem enivronment first
550 my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
551 1070
552 # call dvipng to generate a preview 1071 return "" unless defined $tex and $tex ne "";
553 dvipng($wd, $latex, $dvipng, $tex, $targetPath); 1072
554 if (-e $targetPath) { 1073 if ($displayMode eq "plainText") {
555 return "<img src=\"$targetURL\" alt=\"$tex\" />"; 1074 return $tex;
556 } else { 1075 } elsif ($displayMode eq "formattedText") {
1076 my $tthCommand = $ce->{externalPrograms}->{tth}
1077 . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
1078 . "\\(".$tex."\\)\n"
1079 . "END_OF_INPUT\n";
1080
1081 # call tth
1082 my $result = `$tthCommand`;
1083 if ($?) {
557 return "<b>[math2img failed]</b>"; 1084 return "<b>[tth failed: $? $@]</b>";
558 } 1085 }
1086 return $result;
1087 } elsif ($displayMode eq "images") {
1088 $imgGen->add($answerResult->{preview_latex_string});
1089 }
559} 1090}
560 1091
561##### permission queries ##### 1092##### permission queries #####
562 1093
563# this stuff should be abstracted out into the permissions system 1094# this stuff should be abstracted out into the permissions system
564# however, the permission system only knows about things in the 1095# however, the permission system only knows about things in the
565# course environment and the username. hmmm... 1096# course environment and the username. hmmm...
566 1097
567# also, i should fix these so that they have a consistent calling 1098# also, i should fix these so that they have a consistent calling
568# format -- perhaps: 1099# format -- perhaps:
569# canPERM($courseEnv, $user, $set, $problem, $permissionLevel) 1100# canPERM($ce, $user, $set, $problem, $permissionLevel)
570 1101
571sub canShowCorrectAnswers($$) { 1102sub canShowCorrectAnswers($$) {
572 my ($permissionLevel, $answerDate) = @_; 1103 my ($permissionLevel, $answerDate) = @_;
573 return $permissionLevel > 0 || time > $answerDate; 1104 return $permissionLevel > 0 || time > $answerDate;
574} 1105}
… …
585 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts; 1116 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
586 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK); 1117 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
587 return $recordAnswers; 1118 return $recordAnswers;
588} 1119}
589 1120
1121sub canCheckAnswers($$) {
1122 my ($permissionLevel, $answerDate) = @_;
1123 my $permHigh = $permissionLevel > 0;
1124 my $timeOK = time >= $answerDate;
1125 my $recordAnswers = $permHigh || $timeOK;
1126 return $recordAnswers;
1127}
1128
590sub mustRecordAnswers($) { 1129sub mustRecordAnswers($) {
591 my ($permissionLevel) = @_; 1130 my ($permissionLevel) = @_;
592 return $permissionLevel == 0; 1131 return $permissionLevel == 0;
593} 1132}
594 1133
1134
1135# FIXME: does this even get used?
1136sub submiterror {
1137 my $self = shift;
1138 my $submiterror = (defined($self->{submiterror}) ) ? $self->{submiterror} : '';
1139 $submiterror;
1140}
5951; 11411;
Legend:
Removed from v.634  
changed lines
  Added in v.2166
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9