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

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

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

Revision 738 Revision 2221
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.137 2004/05/24 20:41:10 apizer 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
27# effectiveUser 43# effectiveUser
35# 51#
36# AnSwEr# - answer blanks in problem 52# AnSwEr# - answer blanks in problem
37# 53#
38# redisplay - name of the "Redisplay Problem" button 54# redisplay - name of the "Redisplay Problem" button
39# 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
40# 60#
41############################################################ 61############################################################
42 62
63# FIXME: what is this?
64sub templateName {
65 "problem";
66}
67
43sub pre_header_initialize { 68sub pre_header_initialize {
44 my ($self, $setName, $problemNumber) = @_; 69 my ($self) = @_;
45 my $courseEnv = $self->{courseEnvironment};
46 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");
47 my $userName = $r->param('user'); 77 my $userName = $r->param('user');
48 my $effectiveUserName = $r->param('effectiveUser'); 78 my $effectiveUserName = $r->param('effectiveUser');
79 my $key = $r->param('key');
49 80
50 ##### database setup #####
51
52 my $cldb = WeBWorK::DB::Classlist->new($courseEnv);
53 my $wwdb = WeBWorK::DB::WW->new($courseEnv);
54 my $authdb = WeBWorK::DB::Auth->new($courseEnv);
55
56 my $user = $cldb->getUser($userName); 81 my $user = $db->getUser($userName); # checked
82 die "record for user $userName (real user) does not exist."
83 unless defined $user;
84
57 my $effectiveUser = $cldb->getUser($effectiveUserName); 85 my $effectiveUser = $db->getUser($effectiveUserName); # checked
86 die "record for user $effectiveUserName (effective user) does not exist."
87 unless defined $effectiveUser;
88
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
58 my $set = $wwdb->getSet($effectiveUserName, $setName); 95 my $set = $db->getMergedSet($effectiveUserName, $setName); # checked
96
97 # obtain the merged problem for $effectiveUser
59 my $problem = $wwdb->getProblem($effectiveUserName, $setName, $problemNumber); 98 my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # checked
60 my $psvn = $wwdb->getPSVN($effectiveUserName, $setName); 99
61 my $permissionLevel = $authdb->getPermissions($userName); 100 my $editMode = $r->param("editMode");
62 101
63 $self->{cldb} = $cldb; 102 if ($permissionLevel > 0) {
64 $self->{wwdb} = $wwdb; 103 # professors are allowed to fabricate sets and problems not
65 $self->{authdb} = $authdb; 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) ? "visable to students." : "hidden from students.";
173 $self->addmessage(CGI::p("This set is " . CGI::font({class=>$published}, $published)));
174 } else {
66 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
67 $self->{userName} = $userName; 185 $self->{userName} = $userName;
186 $self->{effectiveUserName} = $effectiveUserName;
68 $self->{user} = $user; 187 $self->{user} = $user;
69 $self->{effectiveUser} = $effectiveUser; 188 $self->{effectiveUser} = $effectiveUser;
70 $self->{set} = $set;
71 $self->{problem} = $problem;
72 $self->{permissionLevel} = $permissionLevel; 189 $self->{permissionLevel} = $permissionLevel;
190 $self->{set} = $set;
191 $self->{problem} = $problem;
192 $self->{editMode} = $editMode;
73 193
74 ##### form processing ##### 194 ##### form processing #####
75 195
76 # 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)
77 my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; 197 my $displayMode = $r->param("displayMode") || $ce->{pg}->{options}->{displayMode};
78 my $redisplay = $r->param("redisplay"); 198 my $redisplay = $r->param("redisplay");
79 my $submitAnswers = $r->param("submitAnswers"); 199 my $submitAnswers = $r->param("submitAnswers");
80 my $checkAnswers = $r->param("checkAnswers"); 200 my $checkAnswers = $r->param("checkAnswers");
81 my $previewAnswers = $r->param("previewAnswers"); 201 my $previewAnswers = $r->param("previewAnswers");
82 202
83 # coerce form fields into CGI::Vars format
84 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; 203 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
85 204
86 $self->{displayMode} = $displayMode; 205 $self->{displayMode} = $displayMode;
87 $self->{redisplay} = $redisplay; 206 $self->{redisplay} = $redisplay;
88 $self->{submitAnswers} = $submitAnswers; 207 $self->{submitAnswers} = $submitAnswers;
89 $self->{checkAnswers} = $checkAnswers; 208 $self->{checkAnswers} = $checkAnswers;
90 $self->{previewAnswers} = $previewAnswers; 209 $self->{previewAnswers} = $previewAnswers;
91 $self->{formFields} = $formFields; 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};
92 220
93 ##### permissions ##### 221 ##### permissions #####
94 222
95 # are we allowed to view this problem? 223 # are we allowed to view this problem?
96 $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0; 224 $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0;
97 return unless $self->{isOpen}; 225 return unless $self->{isOpen};
98 226
99 # what does the user want to do? 227 # what does the user want to do?
100 my %want = ( 228 my %want = (
101 showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers}, 229 showOldAnswers => $r->param("showOldAnswers") || $ce->{pg}->{options}->{showOldAnswers},
102 showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers}, 230 showCorrectAnswers => $r->param("showCorrectAnswers") || $ce->{pg}->{options}->{showCorrectAnswers},
103 showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints}, 231 showHints => $r->param("showHints") || $ce->{pg}->{options}->{showHints},
104 showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions}, 232 showSolutions => $r->param("showSolutions") || $ce->{pg}->{options}->{showSolutions},
105 #recordAnswers => $r->param("recordAnswers") || 1,
106 recordAnswers => $submitAnswers, 233 recordAnswers => $submitAnswers,
234 checkAnswers => $checkAnswers,
107 ); 235 );
108 236
109 # are certain options enforced? 237 # are certain options enforced?
110 my %must = ( 238 my %must = (
111 showOldAnswers => 0, 239 showOldAnswers => 0,
112 showCorrectAnswers => 0, 240 showCorrectAnswers => 0,
113 showHints => 0, 241 showHints => 0,
114 showSolutions => 0, 242 showSolutions => 0,
115 recordAnswers => mustRecordAnswers($permissionLevel), 243 recordAnswers => mustRecordAnswers($permissionLevel),
244 checkAnswers => 0,
116 ); 245 );
117 246
118 # does the user have permission to use certain options? 247 # does the user have permission to use certain options?
119 my %can = ( 248 my %can = (
120 showOldAnswers => 1, 249 showOldAnswers => 1,
121 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date), 250 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
122 showHints => 1, 251 showHints => 1,
123 showSolutions => canShowSolutions($permissionLevel, $set->answer_date), 252 showSolutions => canShowSolutions($permissionLevel, $set->answer_date),
124 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date, 253 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
125 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1), 254 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
126 # 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 )
127 ); 296 );
128 297
129 # final values for options 298 # final values for options
130 my %will; 299 my %will;
131 foreach (keys %must) { 300 foreach (keys %must) {
132 $will{$_} = $can{$_} && ($want{$_} || $must{$_}); 301 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
133 } 302 }
134 303
135 ##### sticky answers ##### 304 ##### sticky answers #####
136 305
137 if (not $submitAnswers and $will{showOldAnswers}) { 306 if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) {
138 # do this only if new answers are NOT being submitted 307 # do this only if new answers are NOT being submitted
139 my %oldAnswers = decodeAnswers($problem->last_answer); 308 my %oldAnswers = decodeAnswers($problem->last_answer);
140 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers; 309 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
141 } 310 }
142 311
143 ##### translation ##### 312 ##### translation #####
144 313
314 $WeBWorK::timer->continue("begin pg processing") if defined($WeBWorK::timer);
145 my $pg = WeBWorK::PG->new( 315 my $pg = WeBWorK::PG->new(
146 $courseEnv, 316 $ce,
147 $effectiveUser, 317 $effectiveUser,
148 $r->param('key'), 318 $key,
149 $set, 319 $set,
150 $problem, 320 $problem,
151 $psvn, 321 $set->psvn, # FIXME: this field should be removed
152 $formFields, 322 $formFields,
153 { # translation options 323 { # translation options
154 displayMode => $displayMode, 324 displayMode => $displayMode,
155 showHints => $will{showHints}, 325 showHints => $will{showHints},
156 showSolutions => $will{showSolutions}, 326 showSolutions => $will{showSolutions},
157 refreshMath2img => $will{showHints} || $will{showSolutions}, 327 refreshMath2img => $will{showHints} || $will{showSolutions},
158 processAnswers => 1, 328 processAnswers => 1,
159 }, 329 },
160 ); 330 );
161 331
332 $WeBWorK::timer->continue("end pg processing") if defined($WeBWorK::timer);
162 ##### fix hint/solution options ##### 333 ##### fix hint/solution options #####
163 334
164 $can{showHints} &&= $pg->{flags}->{hintExists}; 335 $can{showHints} &&= $pg->{flags}->{hintExists}
336 &&= $pg->{flags}->{showHintLimit}<=$pg->{state}->{num_of_incorrect_ans};
165 $can{showSolutions} &&= $pg->{flags}->{solutionExists}; 337 $can{showSolutions} &&= $pg->{flags}->{solutionExists};
166 338
167 ##### store fields ##### 339 ##### store fields #####
168 340
169 $self->{want} = \%want; 341 $self->{want} = \%want;
170 $self->{must} = \%must; 342 $self->{must} = \%must;
171 $self->{can} = \%can; 343 $self->{can} = \%can;
172 $self->{will} = \%will; 344 $self->{will} = \%will;
173
174 $self->{pg} = $pg; 345 $self->{pg} = $pg;
175}
176
177sub if_warnings($$) {
178 my ($self, $arg) = @_;
179 return 0 unless $self->{isOpen};
180 return $self->{pg}->{warnings} ne "";
181} 346}
182 347
183sub if_errors($$) { 348sub if_errors($$) {
184 my ($self, $arg) = @_; 349 my ($self, $arg) = @_;
185 return 0 unless $self->{isOpen}; 350
351 if ($self->{isOpen}) {
186 return $self->{pg}->{flags}->{error_flag}; 352 return $self->{pg}->{flags}->{error_flag} ? $arg : !$arg;
353 } else {
354 return !$arg;
355 }
187} 356}
188 357
189sub head { 358sub head {
190 my $self = shift; 359 my ($self) = @_;
360
191 return "" unless $self->{isOpen}; 361 return "" unless $self->{isOpen};
192 return $self->{pg}->{head_text} if $self->{pg}->{head_text}; 362 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
193} 363}
194 364
195sub path { 365sub options {
196 my $self = shift; 366 my ($self) = @_;
197 my $args = $_[-1];
198 my $setName = $self->{set}->id;
199 my $problemNumber = $self->{problem}->id;
200 367
201 my $ce = $self->{courseEnvironment}; 368 return "" if $self->{invalidProblem};
202 my $root = $ce->{webworkURLs}->{root}; 369
203 my $courseName = $ce->{courseName}; 370 return join("",
204 return $self->pathMacro($args, 371 CGI::start_form("POST", $self->{r}->uri),
205 "Home" => "$root", 372 $self->hidden_authen_fields,
206 $courseName => "$root/$courseName", 373 CGI::hr(),
207 $setName => "$root/$courseName/$setName", 374 CGI::start_div({class=>"viewOptions"}),
208 "Problem $problemNumber" => "", 375 $self->viewOptions(),
376 CGI::end_div(),
377 CGI::end_form()
209 ); 378 );
210} 379}
211 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
212sub siblings { 398sub siblings {
213 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");
214 my $setName = $self->{set}->id; 408 my $setID = $self->{set}->set_id;
215 my $problemNumber = $self->{problem}->id;
216
217 my $ce = $self->{courseEnvironment};
218 my $root = $ce->{webworkURLs}->{root};
219 my $courseName = $ce->{courseName};
220
221 print CGI::strong("Problems"), CGI::br();
222
223 my $wwdb = $self->{wwdb};
224 my $effectiveUser = $self->{r}->param("effectiveUser"); 409 my $eUserID = $r->param("effectiveUser");
225 my @problems; 410 my @problemIDs = sort { $a <=> $b } $db->listUserProblems($eUserID, $setID);
226 push @problems, $wwdb->getProblem($effectiveUser, $setName, $_) 411
227 foreach ($wwdb->getProblems($effectiveUser, $setName)); 412 print CGI::start_ul({class=>"LinksMenu"});
228 foreach my $problem (sort { $a->id <=> $b->id } @problems) { 413 print CGI::start_li();
229 print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?" 414 print CGI::span({style=>"font-size:larger"}, "Problems");
230 . $self->url_authen_args . "&displayMode=" . $self->{displayMode}}, 415 print CGI::start_ul();
231 "Problem ".$problem->id), CGI::br(); 416
417 foreach my $problemID (@problemIDs) {
418 my $problemPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Problem",
419 courseID => $courseID, setID => $setID, problemID => $problemID);
420 print CGI::li(CGI::a({href=>$self->systemLink($problemPage, params=>{displayMode => $self->{displayMode}})}, "Problem $problemID"));
232 } 421 }
422
423 print CGI::end_ul();
424 print CGI::end_li();
425 print CGI::end_ul();
426
427 return "";
233} 428}
234 429
235sub nav { 430sub nav {
236 my $self = shift; 431 my ($self, $args) = @_;
237 my $args = $_[-1]; 432 my $r = $self->r;
238 my $setName = $self->{set}->id; 433 my $db = $r->db;
239 my $problemNumber = $self->{problem}->id; 434 my $urlpath = $r->urlpath;
240 435
241 my $ce = $self->{courseEnvironment}; 436 my $courseID = $urlpath->arg("courseID");
242 my $root = $ce->{webworkURLs}->{root}; 437 my $setID = $self->{set}->set_id if !($self->{invalidSet});
243 my $courseName = $ce->{courseName}; 438 my $problemID = $self->{problem}->problem_id if !($self->{invalidProblem});
244
245 my $wwdb = $self->{wwdb};
246 my $effectiveUser = $self->{r}->param("effectiveUser"); 439 my $eUserID = $r->param("effectiveUser");
440
441 my ($prevID, $nextID);
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 }
452
453 my @links;
454
455 if ($prevID) {
456 my $prevPage = $urlpath->newFromModule(__PACKAGE__,
457 courseID => $courseID, setID => $setID, problemID => $prevID);
458 push @links, "Previous Problem", $r->location . $prevPage->path, "navPrev";
459 } else {
460 push @links, "Previous Problem", "", "navPrev";
461 }
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
247 my $tail = "&displayMode=".$self->{displayMode}; 473 my $tail = "&displayMode=".$self->{displayMode};
248
249 my @links = ("Problem List" => "$root/$courseName/$setName");
250
251 my $prevProblem = $wwdb->getProblem($effectiveUser, $setName, $problemNumber-1);
252 my $nextProblem = $wwdb->getProblem($effectiveUser, $setName, $problemNumber+1);
253 unshift @links, "Previous Problem" => $prevProblem
254 ? "$root/$courseName/$setName/".$prevProblem->id
255 : "";
256 push @links, "Next Problem" => $nextProblem
257 ? "$root/$courseName/$setName/".$nextProblem->id
258 : "";
259
260 return $self->navMacro($args, $tail, @links); 474 return $self->navMacro($args, $tail, @links);
261} 475}
262 476
263sub title { 477sub title {
264 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
265 my $setName = $self->{set}->id; 484 #my $setID = $self->{set}->set_id;
266 my $problemNumber = $self->{problem}->id; 485 #my $problemID = $self->{problem}->problem_id;
267 486
268 return "$setName : Problem $problemNumber"; 487 return "$setID : $problemID";
269} 488}
270 489
271sub body { 490sub body {
272 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 }
273 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
274 unless ($self->{isOpen}) { 507 unless ($self->{isOpen}) {
508 return CGI::div({class=>"ResultsWithError"},
275 return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open.")); 509 CGI::p("This problem is not available because the problem set that contains it is not yet open."));
276 } 510 }
277
278 # unpack some useful variables 511 # unpack some useful variables
279 my $r = $self->{r};
280 my $wwdb = $self->{wwdb};
281 my $set = $self->{set}; 512 my $set = $self->{set};
282 my $problem = $self->{problem}; 513 my $problem = $self->{problem};
514 my $editMode = $self->{editMode};
283 my $permissionLevel = $self->{permissionLevel}; 515 my $permissionLevel = $self->{permissionLevel};
284 my $submitAnswers = $self->{submitAnswers}; 516 my $submitAnswers = $self->{submitAnswers};
285 my $checkAnswers = $self->{checkAnswers}; 517 my $checkAnswers = $self->{checkAnswers};
286 my $previewAnswers = $self->{previewAnswers}; 518 my $previewAnswers = $self->{previewAnswers};
287 my %want = %{ $self->{want} }; 519 my %want = %{ $self->{want} };
288 my %can = %{ $self->{can} }; 520 my %can = %{ $self->{can} };
289 my %must = %{ $self->{must} }; 521 my %must = %{ $self->{must} };
290 my %will = %{ $self->{will} }; 522 my %will = %{ $self->{will} };
291 my $pg = $self->{pg}; 523 my $pg = $self->{pg};
292 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
293 ##### translation errors? ##### 549 ##### translation errors? #####
294 550
295 if ($pg->{flags}->{error_flag}) { 551 if ($pg->{flags}->{error_flag}) {
296 return $self->errorOutput($pg->{errors}, $pg->{body_text}); 552 print $self->errorOutput($pg->{errors}, $pg->{body_text});
553 print $editorLink;
554 return "";
297 } 555 }
298 556
299 ##### answer processing ##### 557 ##### answer processing #####
300 558 $WeBWorK::timer->continue("begin answer processing") if defined($WeBWorK::timer);
301 # if answers were submitted: 559 # if answers were submitted:
560 my $scoreRecordedMessage;
561 my $pureProblem;
302 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) {
303 # store answers in DB for sticky answers 567 # store answers in DB for sticky answers
304 my %answersToStore; 568 my %answersToStore;
305 my %answerHash = %{ $pg->{answers} }; 569 my %answerHash = %{ $pg->{answers} };
306 $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!!
307 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);
308 my $answerString = encodeAnswers(%answersToStore, 581 my $answerString = encodeAnswers(%answersToStore,
309 @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); 582 @answer_order);
583
584 # store last answer to database
310 $problem->last_answer($answerString); 585 $problem->last_answer($answerString);
586 $pureProblem->last_answer($answerString);
311 $wwdb->setProblem($problem); 587 $db->putUserProblem($pureProblem);
312 588
313 # store state in DB if it makes sense 589 # store state in DB if it makes sense
314 if ($will{recordAnswers}) { 590 if ($will{recordAnswers}) {
315 $problem->attempted(1);
316 $problem->status($pg->{state}->{recorded_score}); 591 $problem->status($pg->{state}->{recorded_score});
592 $problem->attempted(1);
317 $problem->num_correct($pg->{state}->{num_of_correct_ans}); 593 $problem->num_correct($pg->{state}->{num_of_correct_ans});
318 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); 594 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
319 $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 }
320 # write to the transaction log, just to make sure 604 # write to the transaction log, just to make sure
321 writeLog($self->{courseEnvironment}, "transaction", 605 writeLog($self->{ce}, "transaction",
322 $problem->id."\t". 606 $problem->problem_id."\t".
323 $problem->set_id."\t". 607 $problem->set_id."\t".
324 $problem->login_id."\t". 608 $problem->user_id."\t".
325 $problem->source_file."\t". 609 $problem->source_file."\t".
326 $problem->value."\t". 610 $problem->value."\t".
327 $problem->max_attempts."\t". 611 $problem->max_attempts."\t".
328 $problem->problem_seed."\t". 612 $problem->problem_seed."\t".
329 $problem->status."\t". 613 $pureProblem->status."\t".
330 $problem->attempted."\t". 614 $pureProblem->attempted."\t".
331 $problem->last_answer."\t". 615 $pureProblem->last_answer."\t".
332 $problem->num_correct."\t". 616 $pureProblem->num_correct."\t".
333 $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 ),
334 ); 655 );
656
335 } 657 }
336 } 658 }
337 659
660 $WeBWorK::timer->continue("end answer processing") if defined($WeBWorK::timer);
661
338 ##### output ##### 662 ##### output #####
339 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.
340 # attempt summary 683 # attempt summary
341 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) ) {
342 # print this if user submitted answers OR requested correct answers 688 # print this if user submitted answers OR requested correct answers
689
343 print $self->attemptResults($pg, $submitAnswers, 690 print $self->attemptResults($pg, 1,
344 $will{showCorrectAnswers}, 691 $will{showCorrectAnswers},
345 $pg->{flags}->{showPartialCorrectAnswers}, 0); 692 $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
346 } elsif ($checkAnswers) { 693 } elsif ($checkAnswers) {
347 # print this if user previewed answers 694 # print this if user previewed answers
348 print $self->attemptResults($pg, 1, 0, 1, 0); 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);
349 # show attempt answers 697 # show attempt answers
350 # don't show correct answers 698 # show correct answers if asked
351 # show attempt results (correctness) 699 # show attempt results (correctness)
352 # don't show attempt previews 700 # show attempt previews
353 } elsif ($previewAnswers) { 701 } elsif ($previewAnswers) {
354 # print this if user previewed answers 702 # print this if user previewed answers
355 print $self->attemptResults($pg, 1, 0, 0, 1); 703 print CGI::div({class=>'ResultsWithError'},"PREVIEW ONLY -- NOT RECORDED"),CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1);
356 # show attempt answers 704 # show attempt answers
357 # don't show correct answers 705 # don't show correct answers
358 # don't show attempt results (correctness) 706 # don't show attempt results (correctness)
359 # show attempt previews 707 # show attempt previews
360 } 708 }
361 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"});
756
362 # score summary 757 # score summary
363 my $attempts = $problem->num_correct + $problem->num_incorrect; 758 my $attempts = $problem->num_correct + $problem->num_incorrect;
364 my $attemptsNoun = $attempts != 1 ? "times" : "time"; 759 my $attemptsNoun = $attempts != 1 ? "times" : "time";
365 my $lastScore = int ($problem->status * 100) . "%"; 760 my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number
366 my ($attemptsLeft, $attemptsLeftNoun); 761 my ($attemptsLeft, $attemptsLeftNoun);
367 if ($problem->max_attempts == -1) { 762 if ($problem->max_attempts == -1) {
368 # unlimited attempts 763 # unlimited attempts
369 $attemptsLeft = "unlimited"; 764 $attemptsLeft = "unlimited";
370 $attemptsLeftNoun = "attempts"; 765 $attemptsLeftNoun = "attempts";
371 } else { 766 } else {
372 $attemptsLeft = $problem->max_attempts - $attempts; 767 $attemptsLeft = $problem->max_attempts - $attempts;
373 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; 768 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
374 } 769 }
770
771 my $setClosed = 0;
375 my $setClosedMessage; 772 my $setClosedMessage;
376 if (time < $set->open_date or time > $set->due_date) { 773 if (time < $set->open_date or time > $set->due_date) {
774 $setClosed = 1;
377 $setClosedMessage = "This problem set is closed."; 775 $setClosedMessage = "This problem set is closed.";
378 if ($permissionLevel > 0) { 776 if ($permissionLevel > 0) {
379 $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.";
380 } else { 778 } else {
381 $setClosedMessage .= " Additional attempts will not be recorded."; 779 $setClosedMessage .= " Additional attempts will not be recorded.";
382 } 780 }
383 } 781 }
782
783 my $notCountedMessage = ($problem->value) ? "" : "(This problem will not count towards your grade.)";
384 print CGI::p( 784 print CGI::p(
785 $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
385 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), 786 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
386 $problem->attempted 787 $problem->attempted
387 ? "Your recorded score is $lastScore." . CGI::br() 788 ? "Your recorded score is $lastScore. $notCountedMessage" . CGI::br()
388 : "", 789 : "",
389 "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), 790 $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
390 $setClosedMessage,
391 ); 791 );
392 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
393 print CGI::hr(); 815 print CGI::endform();
394 816
395 # 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
396 print 872 print
397 CGI::startform("POST", $r->uri), 873 CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
398 $self->hidden_authen_fields, 874 $self->hidden_authen_fields,"\n",
399 CGI::p(CGI::i($pg->{result}->{msg})), 875 CGI::hidden("module", __PACKAGE__),"\n",
400 CGI::p($pg->{body_text}), 876 CGI::hidden("set", $set->set_id),"\n",
401 CGI::p( 877 CGI::hidden("problem", $problem->problem_id),"\n",
402 ($can{recordAnswers} 878 CGI::hidden("displayMode", $self->{displayMode}),"\n",
403 ? CGI::submit(-name=>"submitAnswers", 879 CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
404 -label=>"Submit Answers") 880 CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
405 : ""), 881 CGI::hidden("showHints", $will{showHints}),"\n",
406 ($can{recordAnswers} 882 CGI::hidden("showSolutions", $will{showSolutions}),"\n",
407 ? CGI::submit(-name=>"checkAnswers", 883 CGI::p({-align=>"left"},
408 -label=>"Check Answers") 884 CGI::submit(-name=>"feedbackForm", -label=>"Email instructor")
409 : ""),
410 CGI::submit(-name=>"previewAnswers",
411 -label=>"Preview Answers"),
412 ), 885 ),
413 $self->viewOptions(),
414 CGI::endform(); 886 CGI::endform(),"\n";
415 887
416 # feedback form 888 # FIXME print editor link
417 my $ce = $self->{courseEnvironment}; 889 print $editorLink; #empty unless it is appropriate to have an editor link.
418 my $root = $ce->{webworkURLs}->{root}; 890
419 my $courseName = $ce->{courseName}; 891 print CGI::end_div();
420 my $feedbackURL = "$root/$courseName/feedback/";
421 print
422 CGI::startform("POST", $feedbackURL),
423 $self->hidden_authen_fields,
424 CGI::hidden("module", __PACKAGE__),
425 CGI::hidden("set", $set->id),
426 CGI::hidden("problem", $problem->id),
427 CGI::hidden("displayMode", $self->{displayMode}),
428 CGI::hidden("showOldAnswers", $will{showOldAnswers}),
429 CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),
430 CGI::hidden("showHints", $will{showHints}),
431 CGI::hidden("showSolutions", $will{showSolutions}),
432 CGI::p({-align=>"right"},
433 CGI::submit(-name=>"feedbackForm", -label=>"Send Feedback")
434 ),
435 CGI::endform();
436 892
437 # warning output 893 # warning output
438 if ($pg->{warnings} ne "") { 894 #if ($pg->{warnings} ne "") {
439 print CGI::hr(), $self->warningOutput($pg->{warnings}); 895 # print CGI::hr(), $self->warningOutput($pg->{warnings});
440 } 896 #}
441 897
442 # debugging stuff 898 # debugging stuff
443 if (1) { 899 if (0) {
444 print 900 print
445 CGI::hr(), 901 CGI::hr(),
446 CGI::h2("debugging information"), 902 CGI::h2("debugging information"),
447 CGI::h3("form fields"), 903 CGI::h3("form fields"),
448 ref2string($self->{formFields}), 904 ref2string($self->{formFields}),
459 return ""; 915 return "";
460} 916}
461 917
462##### output utilities ##### 918##### output utilities #####
463 919
464sub attemptResults($$$$$) { 920sub attemptResults {
465 my $self = shift; 921 my $self = shift;
466 my $pg = shift; 922 my $pg = shift;
467 my $showAttemptAnswers = shift; 923 my $showAttemptAnswers = shift;
468 my $showCorrectAnswers = shift; 924 my $showCorrectAnswers = shift;
469 my $showAttemptResults = $showAttemptAnswers && shift; 925 my $showAttemptResults = $showAttemptAnswers && shift;
926 my $showSummary = shift;
470 my $showAttemptPreview = shift || 0; 927 my $showAttemptPreview = shift || 0;
928
929 my $ce = $self->r->ce;
930
471 my $problemResult = $pg->{result}; # the overall result of the problem 931 my $problemResult = $pg->{result}; # the overall result of the problem
472 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; 932 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
473 933
474 my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames; 934 my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
475 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;
476 my $header = CGI::th("part"); 948 #$header .= CGI::th("Part");
477 $header .= $showAttemptAnswers ? CGI::th("entered") : ""; 949 $header .= $showAttemptAnswers ? CGI::th("Entered") : "";
478 $header .= $showAttemptPreview ? CGI::th("preview") : ""; 950 $header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
479 $header .= $showCorrectAnswers ? CGI::th("correct") : ""; 951 $header .= $showCorrectAnswers ? CGI::th("Correct") : "";
480 $header .= $showAttemptResults ? CGI::th("result") : ""; 952 $header .= $showAttemptResults ? CGI::th("Result") : "";
481 $header .= $showMessages ? CGI::th("messages") : ""; 953 $header .= $showMessages ? CGI::th("Messages") : "";
482 my @tableRows = ( $header ); 954 my @tableRows = ( $header );
483 my $numCorrect; 955 my $numCorrect;
484 foreach my $name (@answerNames) { 956 foreach my $name (@answerNames) {
485 my $answerResult = $pg->{answers}->{$name}; 957 my $answerResult = $pg->{answers}->{$name};
486 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans 958 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
487 my $preview = ($showAttemptPreview 959 my $preview = ($showAttemptPreview
488 ? $self->previewAnswer($answerResult) 960 ? $self->previewAnswer($answerResult, $imgGen)
489 : ""); 961 : "");
490 my $correctAnswer = $answerResult->{correct_ans}; 962 my $correctAnswer = $answerResult->{correct_ans};
491 my $answerScore = $answerResult->{score}; 963 my $answerScore = $answerResult->{score};
492 my $answerMessage = $showMessages ? $answerResult->{ans_message} : ""; 964 my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
493 965 #FIXME --Can we be sure that $answerScore is an integer-- could the problem give partial credit?
494 $numCorrect += $answerScore > 0; 966 $numCorrect += $answerScore > 0;
495 my $resultString = $answerScore ? "correct" : "incorrect"; 967 my $resultString = $answerScore == 1 ? "correct" : "incorrect";
496 968
497 # 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
498 # of the answer names is changeable. this only fixes it for "AnSwEr" 970 # of the answer names is changeable. this only fixes it for "AnSwEr"
499 $name =~ s/^AnSwEr//; 971 #$name =~ s/^AnSwEr//;
500 972
973 my $row;
501 my $row = CGI::td($name); 974 #$row .= CGI::td($name);
502 $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : ""; 975 $row .= $showAttemptAnswers ? CGI::td($self->nbsp($studentAnswer)) : "";
503 $row .= $showAttemptPreview ? CGI::td($preview) : ""; 976 $row .= $showAttemptPreview ? CGI::td($self->nbsp($preview)) : "";
504 $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; 977 $row .= $showCorrectAnswers ? CGI::td($self->nbsp($correctAnswer)) : "";
505 $row .= $showAttemptResults ? CGI::td($resultString) : ""; 978 $row .= $showAttemptResults ? CGI::td($self->nbsp($resultString)) : "";
506 $row .= $answerMessage ? CGI::td($answerMessage) : ""; 979 $row .= $showMessages ? CGI::td($self->nbsp($answerMessage)) : "";
507 push @tableRows, $row; 980 push @tableRows, $row;
508 } 981 }
509 982
983 # render equation images
984 $imgGen->render(refresh => 1);
985
510 my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions"; 986# my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
511 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.
512 my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of " 989# my $summary = "On this attempt, you answered $numCorrect out of "
513 . scalar @answerNames . " correct, for a score of $scorePercent."; 990# . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
514 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) : "");
515} 1009}
516 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
517sub viewOptions($) { 1018sub viewOptions {
518 my $self = shift; 1019 my ($self) = @_;
1020 my $ce = $self->r->ce;
1021
519 my $displayMode = $self->{displayMode}; 1022 my $displayMode = $self->{displayMode};
520 my %must = %{ $self->{must} }; 1023 my %must = %{ $self->{must} };
521 my %can = %{ $self->{can} }; 1024 my %can = %{ $self->{can} };
522 my %will = %{ $self->{will} }; 1025 my %will = %{ $self->{will} };
523 1026
524 my $optionLine; 1027 my $optionLine;
525 $can{showOldAnswers} and $optionLine .= join "", 1028 $can{showOldAnswers} and $optionLine .= join "",
526 "Show: &nbsp;", 1029 "Show: &nbsp;".CGI::br(),
527 CGI::checkbox( 1030 CGI::checkbox(
528 -name => "showOldAnswers", 1031 -name => "showOldAnswers",
529 -checked => $will{showOldAnswers}, 1032 -checked => $will{showOldAnswers},
530 -label => "Saved answers", 1033 -label => "Saved answers",
531 ), "&nbsp;&nbsp;"; 1034 ), "&nbsp;&nbsp;".CGI::br();
532 $can{showCorrectAnswers} and $optionLine .= join "", 1035
533 CGI::checkbox(
534 -name => "showCorrectAnswers",
535 -checked => $will{showCorrectAnswers},
536 -label => "Correct answers",
537 ), "&nbsp;&nbsp;";
538 $can{showHints} and $optionLine .= join "",
539 CGI::checkbox(
540 -name => "showHints",
541 -checked => $will{showHints},
542 -label => "Hints",
543 ), "&nbsp;&nbsp;";
544 $can{showSolutions} and $optionLine .= join "",
545 CGI::checkbox(
546 -name => "showSolutions",
547 -checked => $will{showSolutions},
548 -label => "Solutions",
549 ), "&nbsp;&nbsp;";
550 $optionLine and $optionLine .= join "", CGI::br(); 1036 $optionLine and $optionLine .= join "", CGI::br();
551 1037
552 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, 1038 my %display_modes = %{WeBWorK::PG::DISPLAY_MODES()};
553 "View equations as: &nbsp;", 1039 my @active_modes = grep { exists $display_modes{$_} }
1040 @{$ce->{pg}->{displayModes}};
1041 my $modeLine = (scalar(@active_modes)>1) ?
1042 "View&nbsp;equations&nbsp;as:&nbsp;&nbsp;&nbsp;&nbsp;".CGI::br().
554 CGI::radio_group( 1043 CGI::radio_group(
555 -name => "displayMode", 1044 -name => "displayMode",
556 -values => ['plainText', 'formattedText', 'images'], 1045 -values => \@active_modes,
557 -default => $displayMode, 1046 -default => $displayMode,
1047 -linebreak=>'true',
558 -labels => { 1048 -labels => {
559 plainText => "plain text", 1049 plainText => "plain",
560 formattedText => "formatted text", 1050 formattedText => "formatted",
561 images => "images", 1051 images => "images",
1052 jsMath => "jsMath",
1053 asciimath => "asciimath",
562 } 1054 },
563 ), CGI::br(), 1055 ). CGI::br().CGI::hr() : '';
1056
1057 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
1058 $modeLine,
564 $optionLine, 1059 $optionLine,
565 CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"), 1060 CGI::submit(-name=>"redisplay", -label=>"Save Options"),
566 ); 1061 );
567} 1062}
568 1063
569sub previewAnswer($$) { 1064sub previewAnswer {
570 my ($self, $answerResult) = @_; 1065 my ($self, $answerResult, $imgGen) = @_;
571 my $ce = $self->{courseEnvironment}; 1066 my $ce = $self->r->ce;
572 my $effectiveUser = $self->{effectiveUser}; 1067 my $effectiveUser = $self->{effectiveUser};
573 my $set = $self->{set}; 1068 my $set = $self->{set};
574 my $problem = $self->{problem}; 1069 my $problem = $self->{problem};
575 my $displayMode = $self->{displayMode}; 1070 my $displayMode = $self->{displayMode};
576 1071
579 # so we'll just deal with each case explicitly here. there's some code 1074 # so we'll just deal with each case explicitly here. there's some code
580 # duplication that can be dealt with later by abstracting out tth/dvipng/etc. 1075 # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
581 1076
582 my $tex = $answerResult->{preview_latex_string}; 1077 my $tex = $answerResult->{preview_latex_string};
583 1078
584 return "" unless $tex; 1079 return "" unless defined $tex and $tex ne "";
585 1080
586 if ($displayMode eq "plainText") { 1081 if ($displayMode eq "plainText") {
587 return $tex; 1082 return $tex;
588 } elsif ($displayMode eq "formattedText") { 1083 } elsif ($displayMode eq "formattedText") {
589 my $tthCommand = $ce->{externalPrograms}->{tth} 1084 my $tthCommand = $ce->{externalPrograms}->{tth}
596 if ($?) { 1091 if ($?) {
597 return "<b>[tth failed: $? $@]</b>"; 1092 return "<b>[tth failed: $? $@]</b>";
598 } 1093 }
599 return $result; 1094 return $result;
600 } elsif ($displayMode eq "images") { 1095 } elsif ($displayMode eq "images") {
601 # how are we going to name this? 1096 $imgGen->add($tex);
602 my $targetPathCommon = "/png/" 1097 } elsif ($displayMode eq "jsMath") {
603 . $effectiveUser->id . "." 1098
604 . $set->id . "." 1099 return '<DIV CLASS="math">'.$tex.'</DIV>' ;
605 . $problem->id . "." 1100
606 . $answerResult->{ans_name} . ".png"; 1101
607 1102
608 # figure out where to put things 1103
609 my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp});
610 my $latex = $ce->{externalPrograms}->{latex};
611 my $dvipng = $ce->{externalPrograms}->{dvipng};
612 my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
613 # should use surePathToTmpFile, but we have to
614 # isolate it from the problem enivronment first
615 my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
616
617 # call dvipng to generate a preview
618 dvipng($wd, $latex, $dvipng, $tex, $targetPath);
619 if (-e $targetPath) {
620 return "<img src=\"$targetURL\" alt=\"$tex\" />";
621 } else {
622 return "<b>[math2img failed]</b>";
623 }
624 } 1104 }
625} 1105}
626 1106
627##### permission queries ##### 1107##### permission queries #####
628 1108
629# this stuff should be abstracted out into the permissions system 1109# this stuff should be abstracted out into the permissions system
630# however, the permission system only knows about things in the 1110# however, the permission system only knows about things in the
631# course environment and the username. hmmm... 1111# course environment and the username. hmmm...
632 1112
633# also, i should fix these so that they have a consistent calling 1113# also, i should fix these so that they have a consistent calling
634# format -- perhaps: 1114# format -- perhaps:
635# canPERM($courseEnv, $user, $set, $problem, $permissionLevel) 1115# canPERM($ce, $user, $set, $problem, $permissionLevel)
636 1116
637sub canShowCorrectAnswers($$) { 1117sub canShowCorrectAnswers($$) {
638 my ($permissionLevel, $answerDate) = @_; 1118 my ($permissionLevel, $answerDate) = @_;
639 return $permissionLevel > 0 || time > $answerDate; 1119 return $permissionLevel > 0 || time > $answerDate;
640} 1120}
651 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts; 1131 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
652 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK); 1132 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
653 return $recordAnswers; 1133 return $recordAnswers;
654} 1134}
655 1135
1136sub canCheckAnswers($$) {
1137 my ($permissionLevel, $answerDate) = @_;
1138 my $permHigh = $permissionLevel > 0;
1139 my $timeOK = time >= $answerDate;
1140 my $recordAnswers = $permHigh || $timeOK;
1141 return $recordAnswers;
1142}
1143
656sub mustRecordAnswers($) { 1144sub mustRecordAnswers($) {
657 my ($permissionLevel) = @_; 1145 my ($permissionLevel) = @_;
658 return $permissionLevel == 0; 1146 return $permissionLevel == 0;
659} 1147}
660 1148
1149
1150# FIXME: does this even get used?
1151sub submiterror {
1152 my $self = shift;
1153 my $submiterror = (defined($self->{submiterror}) ) ? $self->{submiterror} : '';
1154 $submiterror;
1155}
6611; 11561;

Legend:
Removed from v.738  
changed lines
  Added in v.2221

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9