[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 4031
1################################################################################ 1################################################################################
2# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project 2# WeBWorK Online Homework Delivery System
3# $Id$ 3# Copyright © 2000-2006 The WeBWorK Project, http://openwebwork.sf.net/
4# $CVSHeader: webwork-modperl/lib/WeBWorK/ContentGenerator/Problem.pm,v 1.196 2006/03/02 16:50:39 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);
30use WeBWorK::Debug;
19use WeBWorK::Form; 31use WeBWorK::Form;
20use WeBWorK::PG; 32use WeBWorK::PG;
33use WeBWorK::PG::ImageGenerator;
21use WeBWorK::PG::IO; 34use WeBWorK::PG::IO;
22use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); 35use WeBWorK::Utils qw(readFile writeLog writeCourseLog encodeAnswers decodeAnswers ref2string makeTempDirectory path_is_subdir sortByName);
36use WeBWorK::DB::Utils qw(global2user user2global findDefaults);
37use URI::Escape;
23 38
39use WeBWorK::Utils::Tasks qw(fake_set fake_problem);
40
24############################################################ 41################################################################################
42# CGI param interface to this module (up-to-date as of v1.153)
43################################################################################
44
45# Standard params:
25# 46#
26# user 47# user - user ID of real user
27# key 48# key - session key
49# effectiveUser - user ID of effective user
28# 50#
29# displayMode 51# Integration with PGProblemEditor:
30# showOldAnswers
31# showCorrectAnswers
32# showHints
33# showSolutions
34# 52#
35# AnSwEr# - answer blanks in problem 53# editMode - if set, indicates alternate problem source location.
54# can be "temporaryFile" or "savedFile".
36# 55#
56# sourceFilePath - path to file to be edited
57# problemSeed - force problem seed to value
58# success - success message to display
59# failure - failure message to display
60#
61# Rendering options:
62#
63# displayMode - name of display mode to use
64#
65# showOldAnswers - request that last entered answer be shown (if allowed)
66# showCorrectAnswers - request that correct answers be shown (if allowed)
67# showHints - request that hints be shown (if allowed)
68# showSolutions - request that solutions be shown (if allowed)
69#
70# Problem interaction:
71#
72# AnSwEr# - answer blanks in problem
73#
37# redisplay - name of the "Redisplay Problem" button 74# redisplay - name of the "Redisplay Problem" button
38# submitAnswers - name of "Submit Answers" button 75# submitAnswers - name of "Submit Answers" button
39# 76# checkAnswers - name of the "Check Answers" button
77# previewAnswers - name of the "Preview Answers" button
78
40############################################################ 79################################################################################
80# "can" methods
81################################################################################
82
83# Subroutines to determine if a user "can" perform an action. Each subroutine is
84# called with the following arguments:
85#
86# ($self, $User, $EffectiveUser, $Set, $Problem)
87
88# Note that significant parts of the "can" methods are lifted into the
89# GatewayQuiz module. It isn't direct, however, because of the necessity
90# of dealing with versioning there.
91
92sub can_showOldAnswers {
93 #my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
94
95 return 1;
96}
97
98sub can_showCorrectAnswers {
99 my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
100 my $authz = $self->r->authz;
101
102 return
103 after($Set->answer_date)
104 ||
105 $authz->hasPermissions($User->user_id, "show_correct_answers_before_answer_date")
106 ;
107}
108
109sub can_showHints {
110 #my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
111
112 return 1;
113}
114
115sub can_showSolutions {
116 my ($self, $User, $EffectiveUser, $Set, $Problem) = @_;
117 my $authz = $self->r->authz;
118
119 return
120 after($Set->answer_date)
121 ||
122 $authz->hasPermissions($User->user_id, "show_solutions_before_answer_date")
123 ;
124}
125
126sub can_recordAnswers {
127 my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
128 my $authz = $self->r->authz;
129 my $thisAttempt = $submitAnswers ? 1 : 0;
130 if ($User->user_id ne $EffectiveUser->user_id) {
131 return $authz->hasPermissions($User->user_id, "record_answers_when_acting_as_student");
132 }
133 if (before($Set->open_date)) {
134 return $authz->hasPermissions($User->user_id, "record_answers_before_open_date");
135 } elsif (between($Set->open_date, $Set->due_date)) {
136 my $max_attempts = $Problem->max_attempts;
137 my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
138 if ($max_attempts == -1 or $attempts_used < $max_attempts) {
139 return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_with_attempts");
140 } else {
141 return $authz->hasPermissions($User->user_id, "record_answers_after_open_date_without_attempts");
142 }
143 } elsif (between($Set->due_date, $Set->answer_date)) {
144 return $authz->hasPermissions($User->user_id, "record_answers_after_due_date");
145 } elsif (after($Set->answer_date)) {
146 return $authz->hasPermissions($User->user_id, "record_answers_after_answer_date");
147 }
148}
149
150sub can_checkAnswers {
151 my ($self, $User, $EffectiveUser, $Set, $Problem, $submitAnswers) = @_;
152 my $authz = $self->r->authz;
153 my $thisAttempt = $submitAnswers ? 1 : 0;
154
155 if (before($Set->open_date)) {
156 return $authz->hasPermissions($User->user_id, "check_answers_before_open_date");
157 } elsif (between($Set->open_date, $Set->due_date)) {
158 my $max_attempts = $Problem->max_attempts;
159 my $attempts_used = $Problem->num_correct + $Problem->num_incorrect + $thisAttempt;
160 if ($max_attempts == -1 or $attempts_used < $max_attempts) {
161 return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_with_attempts");
162 } else {
163 return $authz->hasPermissions($User->user_id, "check_answers_after_open_date_without_attempts");
164 }
165 } elsif (between($Set->due_date, $Set->answer_date)) {
166 return $authz->hasPermissions($User->user_id, "check_answers_after_due_date");
167 } elsif (after($Set->answer_date)) {
168 return $authz->hasPermissions($User->user_id, "check_answers_after_answer_date");
169 }
170}
171
172# Helper functions for calculating times
173sub before { return time <= $_[0] }
174sub after { return time >= $_[0] }
175sub between { my $t = time; return $t > $_[0] && $t < $_[1] }
176
177# Reset the default in some cases
178sub set_showOldAnswers_default {
179 my ($self, $ce, $userName, $authz, $set) = @_;
180 # these people always use the system/course default, so don't
181 # override the value of ...->{showOldAnswers}
182 return if $authz->hasPermissions($userName, "can_always_use_show_old_answers_default");
183 # this person should always default to 0
184 $ce->{pg}->{options}->{showOldAnswers} = 0
185 unless ($authz->hasPermissions($userName, "can_show_old_answers_by_default"));
186 # we are after the due date, so default to not showing it
187 $ce->{pg}->{options}->{showOldAnswers} = 0 if $set->{due_date} && after($set->{due_date});
188}
189
190################################################################################
191# output utilities
192################################################################################
193
194# Note: the substance of attemptResults is lifted into GatewayQuiz.pm,
195# with some changes to the output format
196
197sub attemptResults {
198 my $self = shift;
199 my $pg = shift;
200 my $showAttemptAnswers = shift;
201 my $showCorrectAnswers = shift;
202 my $showAttemptResults = $showAttemptAnswers && shift;
203 my $showSummary = shift;
204 my $showAttemptPreview = shift || 0;
205
206 my $ce = $self->r->ce;
207
208 my $problemResult = $pg->{result}; # the overall result of the problem
209 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
210
211 my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
212
213 my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
214
215 # to make grabbing these options easier, we'll pull them out now...
216 my %imagesModeOptions = %{$ce->{pg}->{displayModeOptions}->{images}};
217
218 my $imgGen = WeBWorK::PG::ImageGenerator->new(
219 tempDir => $ce->{webworkDirs}->{tmp},
220 latex => $ce->{externalPrograms}->{latex},
221 dvipng => $ce->{externalPrograms}->{dvipng},
222 useCache => 1,
223 cacheDir => $ce->{webworkDirs}->{equationCache},
224 cacheURL => $ce->{webworkURLs}->{equationCache},
225 cacheDB => $ce->{webworkFiles}->{equationCacheDB},
226 dvipng_align => $imagesModeOptions{dvipng_align},
227 dvipng_depth_db => $imagesModeOptions{dvipng_depth_db},
228 );
229
230 my $header;
231 #$header .= CGI::th("Part");
232 $header .= $showAttemptAnswers ? CGI::th("Entered") : "";
233 $header .= $showAttemptPreview ? CGI::th("Answer Preview") : "";
234 $header .= $showCorrectAnswers ? CGI::th("Correct") : "";
235 $header .= $showAttemptResults ? CGI::th("Result") : "";
236 $header .= $showMessages ? CGI::th("Messages") : "";
237 my $fully = '';
238 my @tableRows = ( $header );
239 my $numCorrect = 0;
240 my $numBlanks =0;
241 my $tthPreambleCache;
242 foreach my $name (@answerNames) {
243 my $answerResult = $pg->{answers}->{$name};
244 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
245 my $preview = ($showAttemptPreview
246 ? $self->previewAnswer($answerResult, $imgGen, \$tthPreambleCache)
247 : "");
248 my $correctAnswer = $answerResult->{correct_ans};
249 my $answerScore = $answerResult->{score};
250 my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
251 $answerMessage =~ s/\n/<BR>/g;
252 $numCorrect += $answerScore >= 1;
253 $numBlanks++ unless $studentAnswer =~/\S/ || $answerScore >= 1; # unless student answer contains entry
254 my $resultString = $answerScore >= 1 ? "correct" :
255 $answerScore > 0 ? int($answerScore*100)."% correct" :
256 "incorrect";
257 $fully = 'completely ' if $answerScore >0 and $answerScore < 1;
258
259 # get rid of the goofy prefix on the answer names (supposedly, the format
260 # of the answer names is changeable. this only fixes it for "AnSwEr"
261 #$name =~ s/^AnSwEr//;
262
263 my $row;
264 #$row .= CGI::td($name);
265 $row .= $showAttemptAnswers ? CGI::td($self->nbsp($studentAnswer)) : "";
266 $row .= $showAttemptPreview ? CGI::td($self->nbsp($preview)) : "";
267 $row .= $showCorrectAnswers ? CGI::td($self->nbsp($correctAnswer)) : "";
268 $row .= $showAttemptResults ? CGI::td($self->nbsp($resultString)) : "";
269 $row .= $showMessages ? CGI::td({-class=>"Message"},$self->nbsp($answerMessage)) : "";
270 push @tableRows, $row;
271 }
272
273 # render equation images
274 $imgGen->render(refresh => 1);
275
276# my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
277 my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
278# FIXME -- I left the old code in in case we have to back out.
279# my $summary = "On this attempt, you answered $numCorrect out of "
280# . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
281 my $summary = "";
282 unless (defined($problemResult->{summary}) and $problemResult->{summary} =~ /\S/) {
283 if (scalar @answerNames == 1) { #default messages
284 if ($numCorrect == scalar @answerNames) {
285 $summary .= CGI::div({class=>"ResultsWithoutError"},"The above answer is correct.");
286 } else {
287 $summary .= CGI::div({class=>"ResultsWithError"},"The above answer is NOT ${fully}correct.");
288 }
289 } else {
290 if ($numCorrect == scalar @answerNames) {
291 $summary .= CGI::div({class=>"ResultsWithoutError"},"All of the above answers are correct.");
292 }
293 unless ($numCorrect + $numBlanks == scalar( @answerNames)) {
294 $summary .= CGI::div({class=>"ResultsWithError"},"At least one of the above answers is NOT ${fully}correct.");
295 }
296 if ($numBlanks) {
297 my $s = ($numBlanks>1)?'':'s';
298 $summary .= CGI::div({class=>"ResultsAlert"},"$numBlanks of the questions remain$s unanswered.");
299 }
300 }
301 } else {
302 $summary = $problemResult->{summary}; # summary has been defined by grader
303 }
304 return
305 CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows))
306 . ($showSummary ? CGI::p({class=>'attemptResultsSummary'},$summary) : "");
307}
308
309
310# Note: previewAnswer is lifted into GatewayQuiz.pm
311
312sub previewAnswer {
313 my ($self, $answerResult, $imgGen, $tthPreambleCache) = @_;
314 my $ce = $self->r->ce;
315 my $effectiveUser = $self->{effectiveUser};
316 my $set = $self->{set};
317 my $problem = $self->{problem};
318 my $displayMode = $self->{displayMode};
319
320 # note: right now, we have to do things completely differently when we are
321 # rendering math from INSIDE the translator and from OUTSIDE the translator.
322 # so we'll just deal with each case explicitly here. there's some code
323 # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
324
325 my $tex = $answerResult->{preview_latex_string};
326
327 return "" unless defined $tex and $tex ne "";
328
329 if ($displayMode eq "plainText") {
330 return $tex;
331 } elsif ($displayMode eq "formattedText") {
332
333 # read the TTH preamble, or use the cached copy passed in from the caller
334 my $tthPreamble='';
335 if (defined $$tthPreambleCache) {
336 $tthPreamble = $$tthPreambleCache;
337 } else {
338 my $tthPreambleFile = $ce->{courseDirs}->{templates} . "/tthPreamble.tex";
339 if (-r $tthPreambleFile) {
340 $tthPreamble = readFile($tthPreambleFile);
341 # thanks to Jim Martino. each line in the definition file should end with
342 #a % to prevent adding supurious paragraphs to output:
343 $tthPreamble =~ s/(.)\n/$1%\n/g;
344 # solves the problem if the file doesn't end with a return:
345 $tthPreamble .="%\n";
346 # store preamble in cache:
347 $$tthPreambleCache = $tthPreamble;
348 } else {
349 }
350 }
351
352 # construct TTH command line
353 my $tthCommand = $ce->{externalPrograms}->{tth}
354 . " -L -f5 -u -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
355 . $tthPreamble . "\\[" . $tex . "\\]\n"
356 . "END_OF_INPUT\n";
357
358 # call tth
359 my $result = `$tthCommand`;
360 if ($?) {
361 return "<b>[tth failed: $? $@]</b>";
362 } else {
363 # avoid border problems in tables and remove unneeded initial <br>
364 $result =~ s/(<table [^>]*)>/$1 CLASS="ArrayLayout">/gi;
365 $result =~ s!\s*<br clear="all" />!!;
366 return $result;
367 }
368
369 } elsif ($displayMode eq "images") {
370 $imgGen->add($tex);
371 } elsif ($displayMode eq "jsMath") {
372 return '<SPAN CLASS="math">\\displaystyle{'.$tex.'}</SPAN>';
373 }
374}
375
376################################################################################
377# Template escape implementations
378################################################################################
41 379
42sub pre_header_initialize { 380sub pre_header_initialize {
43 my ($self, $setName, $problemNumber) = @_; 381 my ($self) = @_;
44 my $courseEnv = $self->{courseEnvironment};
45 my $r = $self->{r}; 382 my $r = $self->r;
383 my $ce = $r->ce;
384 my $db = $r->db;
385 my $authz = $r->authz;
386 my $urlpath = $r->urlpath;
387
388 my $setName = $urlpath->arg("setID");
389 my $problemNumber = $r->urlpath->arg("problemID");
46 my $userName = $r->param('user'); 390 my $userName = $r->param('user');
391 my $effectiveUserName = $r->param('effectiveUser');
392 my $key = $r->param('key');
393 my $editMode = $r->param("editMode");
47 394
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); 395 my $user = $db->getUser($userName); # checked
55 my $set = $wwdb->getSet($userName, $setName); 396 die "record for user $userName (real user) does not exist."
397 unless defined $user;
398
399 my $effectiveUser = $db->getUser($effectiveUserName); # checked
400 die "record for user $effectiveUserName (effective user) does not exist."
401 unless defined $effectiveUser;
402
403 # obtain the merged set for $effectiveUser
404 my $set = $db->getMergedSet($effectiveUserName, $setName); # checked
405
406 $self->set_showOldAnswers_default($ce, $userName, $authz, $set);
407
408# gateway check here: we want to be sure that someone isn't trying to take
409# a GatewayQuiz through the regular problem/homework mechanism, thereby
410# circumventing the versioning, time limits, etc.
411 if (defined $set and defined $set->assignment_type and $set->assignment_type() =~ /gateway/) {
412 unless ($editMode eq "temporaryFile" and $authz->hasPermissions($userName, "modify_student_data")) {
413 die('Invalid access attempt: the Problem ContentGenerator was called for a GatewayQuiz assignment.' );
414 }
415 }
416
417 # Database fix (in case of undefined published values)
418 # this is only necessary because some people keep holding to ww1.9 which did not have a published field
419 # make sure published is set to 0 or 1
420 if ( $set and $set->published ne "0" and $set->published ne "1") {
421 my $globalSet = $db->getGlobalSet($set->set_id);
422 $globalSet->published("1"); # defaults to published
423 $db->putGlobalSet($globalSet);
424 $set = $db->getMergedSet($effectiveUserName, $setName);
425 } else {
426 # don't do anything just yet, maybe we're a professor and we're
427 # fabricating a set or haven't assigned it to ourselves just yet
428 }
429
430 # obtain the merged problem for $effectiveUser
56 my $problem = $wwdb->getProblem($userName, $setName, $problemNumber); 431 my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); # checked
57 my $psvn = $wwdb->getPSVN($userName, $setName); 432
58 my $permissionLevel = $authdb->getPermissions($userName); 433 if ($authz->hasPermissions($userName, "modify_problem_sets")) {
434 # professors are allowed to fabricate sets and problems not
435 # assigned to them (or anyone). this allows them to use the
436 # editor to
437
438 # if a User Set does not exist for this user and this set
439 # then we check the Global Set
440 # if that does not exist we create a fake set
441 # if it does, we add fake user data
442 unless (defined $set) {
443 my $userSetClass = $db->{set_user}->{record};
444 my $globalSet = $db->getGlobalSet($setName); # checked
445
446 if (not defined $globalSet) {
447 $set = fake_set($db);
448 } else {
449 $set = global2user($userSetClass, $globalSet);
450 $set->psvn(0);
451 }
452 }
453
454 # if that is not yet defined obtain the global problem,
455 # convert it to a user problem, and add fake user data
456 unless (defined $problem) {
457 my $userProblemClass = $db->{problem_user}->{record};
458 my $globalProblem = $db->getGlobalProblem($setName, $problemNumber); # checked
459 # if the global problem doesn't exist either, bail!
460 if(not defined $globalProblem) {
461 my $sourceFilePath = $r->param("sourceFilePath");
462 die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates});
463 # These are problems from setmaker. If declared invalid, they won't come up
464 $self->{invalidProblem} = $self->{invalidSet} = 1 unless defined $sourceFilePath;
465# die "Problem $problemNumber in set $setName does not exist" unless defined $sourceFilePath;
466 $problem = fake_problem($db);
467 $problem->problem_id(1);
468 $problem->source_file($sourceFilePath);
469 $problem->user_id($effectiveUserName);
470 } else {
471 $problem = global2user($userProblemClass, $globalProblem);
472 $problem->user_id($effectiveUserName);
473 $problem->problem_seed(0);
474 $problem->status(0);
475 $problem->attempted(0);
476 $problem->last_answer("");
477 $problem->num_correct(0);
478 $problem->num_incorrect(0);
479 }
480 }
481
482 # now we're sure we have valid UserSet and UserProblem objects
483 # yay!
484
485 # now deal with possible editor overrides:
486
487 # if the caller is asking to override the source file, and
488 # editMode calls for a temporary file, do so
489 my $sourceFilePath = $r->param("sourceFilePath");
490 if (defined $editMode and $editMode eq "temporaryFile" and defined $sourceFilePath) {
491 die "sourceFilePath is unsafe!" unless path_is_subdir($sourceFilePath, $ce->{courseDirs}->{templates});
492 $problem->source_file($sourceFilePath);
493 }
494
495 # if the problem does not have a source file or no source file has been passed in
496 # then this is really an invalid problem (probably from a bad URL)
497 $self->{invalidProblem} = not (defined $sourceFilePath or $problem->source_file);
498
499 # if the caller is asking to override the problem seed, do so
500 my $problemSeed = $r->param("problemSeed");
501 if (defined $problemSeed) {
502 $problem->problem_seed($problemSeed);
503 }
504
505 my $publishedClass = ($set->published) ? "Published" : "Unpublished";
506 my $publishedText = ($set->published) ? "visible to students." : "hidden from students.";
507 $self->addmessage(CGI::p("This set is " . CGI::font({class=>$publishedClass}, $publishedText)));
508
509 # test for additional set validity if it's not already invalid
510 } else {
511 # A set is valid if it exists and if it is either published or the user is privileged.
512 $self->{invalidSet} = !(defined $set and ($set->published || $authz->hasPermissions($userName, "view_unpublished_sets")));
513 $self->{invalidProblem} = !(defined $problem and ($set->published || $authz->hasPermissions($userName, "view_unpublished_sets")));
514
515 $self->addbadmessage(CGI::p("This problem will not count towards your grade.")) if $problem and not $problem->value and not $self->{invalidProblem};
516 }
517
518 $self->{userName} = $userName;
519 $self->{effectiveUserName} = $effectiveUserName;
520 $self->{user} = $user;
521 $self->{effectiveUser} = $effectiveUser;
522 $self->{set} = $set;
523 $self->{problem} = $problem;
524 $self->{editMode} = $editMode;
59 525
60 ##### form processing ##### 526 ##### form processing #####
61 527
62 # set options from form fields (see comment at top of file for names) 528 # set options from form fields (see comment at top of file for names)
63 my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; 529 my $displayMode = $r->param("displayMode") || $ce->{pg}->{options}->{displayMode};
64 my $redisplay = $r->param("redisplay"); 530 my $redisplay = $r->param("redisplay");
65 my $submitAnswers = $r->param("submitAnswers"); 531 my $submitAnswers = $r->param("submitAnswers");
532 my $checkAnswers = $r->param("checkAnswers");
66 my $previewAnswers = $r->param("previewAnswers"); 533 my $previewAnswers = $r->param("previewAnswers");
67 534
68 # coerce form fields into CGI::Vars format
69 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; 535 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
70 536
537 $self->{displayMode} = $displayMode;
538 $self->{redisplay} = $redisplay;
539 $self->{submitAnswers} = $submitAnswers;
540 $self->{checkAnswers} = $checkAnswers;
541 $self->{previewAnswers} = $previewAnswers;
542 $self->{formFields} = $formFields;
543
544 # get result and send to message
545 my $status_message = $r->param("status_message");
546 $self->addmessage(CGI::p("$status_message")) if $status_message;
547
548 # now that we've set all the necessary variables quit out if the set or problem is invalid
549 return if $self->{invalidSet} || $self->{invalidProblem};
550
71 ##### permissions ##### 551 ##### permissions #####
72 552
553 # are we allowed to view this problem?
554 $self->{isOpen} = after($set->open_date) || $authz->hasPermissions($userName, "view_unopened_sets");
555 return unless $self->{isOpen};
556
73 # what does the user want to do? 557 # what does the user want to do?
558 #FIXME There is a problem with checkboxes -- if they are not checked they are invisible. Hence if the default mode in $ce is 1
559 # there is no way to override this. Probably this is ok for the last three options, but it was definitely not ok for showing
560 # saved answers which is normally on, but you want to be able to turn it off! This section should be moved to ContentGenerator
561 # so that you can set these options anywhere. We also need mechanisms for making them sticky.
562 # Note: ProblemSet and ProblemSets might set showOldAnswers to '', which
563 # needs to be treated as if it is not set.
74 my %want = ( 564 my %want = (
75 showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers}, 565 showOldAnswers => (defined($r->param("showOldAnswers")) and $r->param("showOldAnswers") ne '') ? $r->param("showOldAnswers") : $ce->{pg}->{options}->{showOldAnswers},
76 showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers}, 566 showCorrectAnswers => $r->param("showCorrectAnswers") || $ce->{pg}->{options}->{showCorrectAnswers},
77 showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints}, 567 showHints => $r->param("showHints") || $ce->{pg}->{options}->{showHints},
78 showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions}, 568 showSolutions => $r->param("showSolutions") || $ce->{pg}->{options}->{showSolutions},
79 recordAnswers => $r->param("recordAnswers") || 1, 569 recordAnswers => $submitAnswers,
570 checkAnswers => $checkAnswers,
571 getSubmitButton => 1,
80 ); 572 );
81 573
82 # are certain options enforced? 574 # are certain options enforced?
83 my %must = ( 575 my %must = (
84 showOldAnswers => 0, 576 showOldAnswers => 0,
85 showCorrectAnswers => 0, 577 showCorrectAnswers => 0,
86 showHints => 0, 578 showHints => 0,
87 showSolutions => 0, 579 showSolutions => 0,
88 recordAnswers => mustRecordAnswers($permissionLevel), 580 recordAnswers => ! $authz->hasPermissions($userName, "avoid_recording_answers"),
581 checkAnswers => 0,
582 getSubmitButton => 0,
89 ); 583 );
90 584
91 # does the user have permission to use certain options? 585 # does the user have permission to use certain options?
586 my @args = ($user, $effectiveUser, $set, $problem);
92 my %can = ( 587 my %can = (
93 showOldAnswers => 1, 588 showOldAnswers => $self->can_showOldAnswers(@args),
94 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date), 589 showCorrectAnswers => $self->can_showCorrectAnswers(@args),
95 showHints => 1, 590 showHints => $self->can_showHints(@args),
96 showSolutions => canShowSolutions($permissionLevel, $set->answer_date), 591 showSolutions => $self->can_showSolutions(@args),
97 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date, 592 recordAnswers => $self->can_recordAnswers(@args, 0),
98 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1), 593 checkAnswers => $self->can_checkAnswers(@args, $submitAnswers),
99 # num_correct+num_incorrect+1 -- as this happens before updating $problem 594 getSubmitButton => $self->can_recordAnswers(@args, $submitAnswers),
100 ); 595 );
101 596
102 # final values for options 597 # final values for options
103 my %will; 598 my %will;
104 foreach (keys %must) { 599 foreach (keys %must) {
105 $will{$_} = $can{$_} && ($want{$_} || $must{$_}); 600 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
106 #warn "$_: can? $can{$_} want? $want{$_} must? $must{$_} will? $will{$_}\n";
107 } 601 }
108 602
109 ##### sticky answers ##### 603 ##### sticky answers #####
110 604
111 if (not $submitAnswers and $will{showOldAnswers}) { 605 if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) {
112 # do this only if new answers are NOT being submitted 606 # do this only if new answers are NOT being submitted
113 my %oldAnswers = decodeAnswers($problem->last_answer); 607 my %oldAnswers = decodeAnswers($problem->last_answer);
114 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers; 608 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
115 } 609 }
116 610
117 ##### translation ##### 611 ##### translation #####
118 612
613 debug("begin pg processing");
119 my $pg = WeBWorK::PG->new( 614 my $pg = WeBWorK::PG->new(
120 $courseEnv, 615 $ce,
121 $user, 616 $effectiveUser,
122 $r->param('key'), 617 $key,
123 $set, 618 $set,
124 $problem, 619 $problem,
125 $psvn, 620 $set->psvn, # FIXME: this field should be removed
126 $formFields, 621 $formFields,
127 { # translation options 622 { # translation options
128 displayMode => $displayMode, 623 displayMode => $displayMode,
129 showHints => $will{showHints}, 624 showHints => $will{showHints},
130 showSolutions => $will{showSolutions}, 625 showSolutions => $will{showSolutions},
131 refreshMath2img => $will{showHints} || $will{showSolutions}, 626 refreshMath2img => $will{showHints} || $will{showSolutions},
132 # try leaving processAnswers on all the time? 627 processAnswers => 1,
133 processAnswers => 1, #$submitAnswers ? 1 : 0,
134 }, 628 },
135 ); 629 );
136 630
631 debug("end pg processing");
632
633 ##### fix hint/solution options #####
634
635 $can{showHints} &&= $pg->{flags}->{hintExists}
636 &&= $pg->{flags}->{showHintLimit}<=$pg->{state}->{num_of_incorrect_ans};
637 $can{showSolutions} &&= $pg->{flags}->{solutionExists};
638
137 ##### store fields ##### 639 ##### 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 640
154 $self->{want} = \%want; 641 $self->{want} = \%want;
155 $self->{must} = \%must; 642 $self->{must} = \%must;
156 $self->{can} = \%can; 643 $self->{can} = \%can;
157 $self->{will} = \%will; 644 $self->{will} = \%will;
158
159 $self->{pg} = $pg; 645 $self->{pg} = $pg;
160}
161
162sub if_warnings($$) {
163 my ($self, $arg) = @_;
164 return $self->{pg}->{warnings} ne "";
165} 646}
166 647
167sub if_errors($$) { 648sub if_errors($$) {
168 my ($self, $arg) = @_; 649 my ($self, $arg) = @_;
650
651 if ($self->{isOpen}) {
169 return $self->{pg}->{flags}->{error_flag}; 652 return $self->{pg}->{flags}->{error_flag} ? $arg : !$arg;
653 } else {
654 return !$arg;
655 }
170} 656}
171 657
172sub head { 658sub head {
173 my $self = shift; 659 my ($self) = @_;
174 660
661 return "" unless $self->{isOpen};
175 return $self->{pg}->{head_text} if $self->{pg}->{head_text}; 662 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
176} 663}
177 664
178sub path { 665sub options {
179 my $self = shift; 666 my ($self) = @_;
180 my $args = $_[-1]; 667 #warn "doing options in Problem";
181 my $setName = $self->{set}->id;
182 my $problemNumber = $self->{problem}->id;
183 668
184 my $ce = $self->{courseEnvironment}; 669 # don't show options if we don't have anything to show
185 my $root = $ce->{webworkURLs}->{root}; 670 return "" if $self->{invalidSet} or $self->{invalidProblem};
186 my $courseName = $ce->{courseName}; 671 return "" unless $self->{isOpen};
672
673 my $displayMode = $self->{displayMode};
674 my %can = %{ $self->{can} };
675
676 my @options_to_show = "displayMode";
677 push @options_to_show, "showOldAnswers" if $can{showOldAnswers};
678 push @options_to_show, "showHints" if $can{showHints};
679 push @options_to_show, "showSolutions" if $can{showSolutions};
680
187 return $self->pathMacro($args, 681 return $self->optionsMacro(
188 "Home" => "$root", 682 options_to_show => \@options_to_show,
189 $courseName => "$root/$courseName", 683 extra_params => ["editMode", "sourceFilePath"],
190 $setName => "$root/$courseName/$setName",
191 "Problem $problemNumber" => "",
192 ); 684 );
193} 685}
194 686
195sub siblings { 687sub siblings {
196 my $self = shift; 688 my ($self) = @_;
689 my $r = $self->r;
690 my $db = $r->db;
691 my $urlpath = $r->urlpath;
692
693 # can't show sibling problems if the set is invalid
694 return "" if $self->{invalidSet};
695
696 my $courseID = $urlpath->arg("courseID");
197 my $setName = $self->{set}->id; 697 my $setID = $self->{set}->set_id;
198 my $problemNumber = $self->{problem}->id; 698 my $eUserID = $r->param("effectiveUser");
699 my @problemIDs = sort { $a <=> $b } $db->listUserProblems($eUserID, $setID);
199 700
200 my $ce = $self->{courseEnvironment}; 701 print CGI::start_div({class=>"info-box", id=>"fisheye"});
201 my $root = $ce->{webworkURLs}->{root}; 702 print CGI::h2("Problems");
202 my $courseName = $ce->{courseName}; 703 #print CGI::start_ul({class=>"LinksMenu"});
203 704 #print CGI::start_li();
204 print CGI::strong("Problems"), CGI::br(); 705 #print CGI::span({style=>"font-size:larger"}, "Problems");
205 706 print CGI::start_ul();
206 my $wwdb = $self->{wwdb}; 707
207 my $user = $self->{r}->param("user"); 708 foreach my $problemID (@problemIDs) {
208 my @problems; 709 my $problemPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Problem",
209 push @problems, $wwdb->getProblem($user, $setName, $_) 710 courseID => $courseID, setID => $setID, problemID => $problemID);
210 foreach ($wwdb->getProblems($user, $setName)); 711 print CGI::li(CGI::a( {href=>$self->systemLink($problemPage,
211 foreach my $problem (sort { $a->id <=> $b->id } @problems) { 712 params=>{ displayMode => $self->{displayMode},
212 print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?" 713 showOldAnswers => $self->{will}->{showOldAnswers}
213 . $self->url_authen_args}, "Problem ".$problem->id), CGI::br(); 714 })}, "Problem $problemID")
715 );
214 } 716 }
717
718 print CGI::end_ul();
719 #print CGI::end_li();
720 #print CGI::end_ul();
721 print CGI::end_div();
722
723 return "";
215} 724}
216 725
217sub nav { 726sub nav {
218 my $self = shift; 727 my ($self, $args) = @_;
219 my $args = $_[-1]; 728 my $r = $self->r;
220 my $setName = $self->{set}->id; 729 my $db = $r->db;
221 my $problemNumber = $self->{problem}->id; 730 my $urlpath = $r->urlpath;
222 731
223 my $ce = $self->{courseEnvironment}; 732 my $courseID = $urlpath->arg("courseID");
224 my $root = $ce->{webworkURLs}->{root}; 733 my $setID = $self->{set}->set_id if !($self->{invalidSet});
225 my $courseName = $ce->{courseName}; 734 my $problemID = $self->{problem}->problem_id if !($self->{invalidProblem});
735 my $eUserID = $r->param("effectiveUser");
226 736
227 my $wwdb = $self->{wwdb}; 737 my ($prevID, $nextID);
228 my $user = $self->{r}->param("user"); 738
739 if (!$self->{invalidProblem}) {
740 my @problemIDs = $db->listUserProblems($eUserID, $setID);
741 foreach my $id (@problemIDs) {
742 $prevID = $id if $id < $problemID
743 and (not defined $prevID or $id > $prevID);
744 $nextID = $id if $id > $problemID
745 and (not defined $nextID or $id < $nextID);
746 }
747 }
229 748
230 my @links = ("Problem List" => "$root/$courseName/$setName"); 749 my @links;
231 750
232 my $prevProblem = $wwdb->getProblem($user, $setName, $problemNumber-1); 751 if ($prevID) {
233 my $nextProblem = $wwdb->getProblem($user, $setName, $problemNumber+1); 752 my $prevPage = $urlpath->newFromModule(__PACKAGE__,
234 unshift @links, "Previous Problem" => $prevProblem 753 courseID => $courseID, setID => $setID, problemID => $prevID);
235 ? "$root/$courseName/$setName/".$prevProblem->id 754 push @links, "Previous Problem", $r->location . $prevPage->path, "navPrev";
236 : ""; 755 } else {
237 push @links, "Next Problem" => $nextProblem 756 push @links, "Previous Problem", "", "navPrev";
238 ? "$root/$courseName/$setName/".$nextProblem->id 757 }
239 : "";
240 758
759 push @links, "Problem List", $r->location . $urlpath->parent->path, "navProbList";
760
761 if ($nextID) {
762 my $nextPage = $urlpath->newFromModule(__PACKAGE__,
763 courseID => $courseID, setID => $setID, problemID => $nextID);
764 push @links, "Next Problem", $r->location . $nextPage->path, "navNext";
765 } else {
766 push @links, "Next Problem", "", "navNext";
767 }
768
769 my $tail = "";
770
771 $tail .= "&displayMode=".$self->{displayMode} if defined $self->{displayMode};
772 $tail .= "&showOldAnswers=".$self->{will}->{showOldAnswers}
773 if defined $self->{will}->{showOldAnswers};
241 return $self->navMacro($args, @links); 774 return $self->navMacro($args, $tail, @links);
242} 775}
243 776
244sub title { 777sub title {
245 my $self = shift; 778 my ($self) = @_;
246 my $setName = $self->{set}->id; 779
247 my $problemNumber = $self->{problem}->id; 780 # using the url arguments won't break if the set/problem are invalid
781 my $setID = WeBWorK::ContentGenerator::underscore2nbsp($self->r->urlpath->arg("setID"));
782 my $problemID = $self->r->urlpath->arg("problemID");
248 783
249 return "$setName : Problem $problemNumber"; 784 return "$setID: Problem $problemID";
250} 785}
251 786
252sub body { 787sub body {
253 my $self = shift; 788 my $self = shift;
789 my $r = $self->r;
790 my $ce = $r->ce;
791 my $db = $r->db;
792 my $authz = $r->authz;
793 my $urlpath = $r->urlpath;
794 my $user = $r->param('user');
795 my $effectiveUser = $r->param('effectiveUser');
796
797 if ($self->{invalidSet}) {
798 return CGI::div({class=>"ResultsWithError"},
799 CGI::p("The selected homework set (" . $urlpath->arg("setID") . ") is not a valid set for " . $r->param("effectiveUser") . "."));
800 }
254 801
802 if ($self->{invalidProblem}) {
803 return CGI::div({class=>"ResultsWithError"},
804 CGI::p("The selected problem (" . $urlpath->arg("problemID") . ") is not a valid problem for set " . $self->{set}->set_id . "."));
805 }
806
807 unless ($self->{isOpen}) {
808 return CGI::div({class=>"ResultsWithError"},
809 CGI::p("This problem is not available because the homework set that contains it is not yet open."));
810 }
255 # unpack some useful variables 811 # unpack some useful variables
256 my $r = $self->{r};
257 my $wwdb = $self->{wwdb};
258 my $set = $self->{set}; 812 my $set = $self->{set};
259 my $problem = $self->{problem}; 813 my $problem = $self->{problem};
260 my $permissionLevel = $self->{permissionLevel}; 814 my $editMode = $self->{editMode};
261 my $submitAnswers = $self->{submitAnswers}; 815 my $submitAnswers = $self->{submitAnswers};
816 my $checkAnswers = $self->{checkAnswers};
262 my $previewAnswers = $self->{previewAnswers}; 817 my $previewAnswers = $self->{previewAnswers};
818 my %want = %{ $self->{want} };
819 my %can = %{ $self->{can} };
820 my %must = %{ $self->{must} };
263 my %will = %{ $self->{will} }; 821 my %will = %{ $self->{will} };
264 my $pg = $self->{pg}; 822 my $pg = $self->{pg};
265 823
824 my $courseName = $urlpath->arg("courseID");
825
826 # FIXME: move editor link to top, next to problem number.
827 # format as "[edit]" like we're doing with course info file, etc.
828 # add edit link for set as well.
829 my $editorLink = "";
830 # if we are here without a real problem set, carry that through
831 my $forced_field = [];
832 $forced_field = ['sourceFilePath' => $r->param("sourceFilePath")] if
833 ($set->set_id eq 'Undefined_Set');
834 if ($authz->hasPermissions($user, "modify_problem_sets")) {
835 my $editorPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::PGProblemEditor",
836 courseID => $courseName, setID => $set->set_id, problemID => $problem->problem_id);
837 my $editorURL = $self->systemLink($editorPage, params=>$forced_field);
838 $editorLink = CGI::p(CGI::a({href=>$editorURL,target =>'WW_Editor'}, "Edit this problem"));
839 }
840
266 ##### translation errors? ##### 841 ##### translation errors? #####
267 842
268 if ($pg->{flags}->{error_flag}) { 843 if ($pg->{flags}->{error_flag}) {
269 return translationError($pg->{errors}, $pg->{body_text}); 844 if ($authz->hasPermissions($user, "view_problem_debugging_info")) {
845 print $self->errorOutput($pg->{errors}, $pg->{body_text});
846 } else {
847 print $self->errorOutput($pg->{errors}, "You do not have permission to view the details of this error.");
848 }
849 print $editorLink;
850 return "";
270 } 851 }
271 852
272 ##### answer processing ##### 853 ##### answer processing #####
273 854 debug("begin answer processing");
274 # if answers were submitted: 855 # if answers were submitted:
856 my $scoreRecordedMessage;
857 my $pureProblem;
275 if ($submitAnswers) { 858 if ($submitAnswers) {
859 # get a "pure" (unmerged) UserProblem to modify
860 # this will be undefined if the problem has not been assigned to this user
861 $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id); # checked
862 if (defined $pureProblem) {
276 # store answers in DB for sticky answers 863 # store answers in DB for sticky answers
277 my %answersToStore; 864 my %answersToStore;
278 my %answerHash = %{ $pg->{answers} }; 865 my %answerHash = %{ $pg->{answers} };
279 $answersToStore{$_} = $answerHash{$_}->{original_student_ans} 866 $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); 867 foreach (keys %answerHash);
868
869 # There may be some more answers to store -- one which are auxiliary entries to a primary answer. Evaluating
870 # matrices works in this way, only the first answer triggers an answer evaluator, the rest are just inputs
871 # however we need to store them. Fortunately they are still in the input form.
872 my @extra_answer_names = @{ $pg->{flags}->{KEPT_EXTRA_ANSWERS}};
873 $answersToStore{$_} = $self->{formFields}->{$_} foreach (@extra_answer_names);
874
875 # Now let's encode these answers to store them -- append the extra answers to the end of answer entry order
876 my @answer_order = (@{$pg->{flags}->{ANSWER_ENTRY_ORDER}}, @extra_answer_names);
281 my $answerString = encodeAnswers(%answersToStore, 877 my $answerString = encodeAnswers(%answersToStore,
282 @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); 878 @answer_order);
879
880 # store last answer to database
283 $problem->last_answer($answerString); 881 $problem->last_answer($answerString);
882 $pureProblem->last_answer($answerString);
284 $wwdb->setProblem($problem); 883 $db->putUserProblem($pureProblem);
285 884
286 # store state in DB if it makes sense 885 # store state in DB if it makes sense
287 if ($will{recordAnswers}) { 886 if ($will{recordAnswers}) {
288 $problem->attempted(1);
289 $problem->status($pg->{state}->{recorded_score}); 887 $problem->status($pg->{state}->{recorded_score});
888 $problem->attempted(1);
290 $problem->num_correct($pg->{state}->{num_of_correct_ans}); 889 $problem->num_correct($pg->{state}->{num_of_correct_ans});
291 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); 890 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
292 $wwdb->setProblem($problem); 891 $pureProblem->status($pg->{state}->{recorded_score});
892 $pureProblem->attempted(1);
893 $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
894 $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
895 if ($db->putUserProblem($pureProblem)) {
896 $scoreRecordedMessage = "Your score was recorded.";
897 } else {
898 $scoreRecordedMessage = "Your score was not recorded because there was a failure in storing the problem record to the database.";
899 }
293 # write to the transaction log, just to make sure 900 # write to the transaction log, just to make sure
294 writeLog($self->{courseEnvironment}, "transaction", 901 writeLog($self->{ce}, "transaction",
295 $problem->id."\t". 902 $problem->problem_id."\t".
296 $problem->set_id."\t". 903 $problem->set_id."\t".
297 $problem->login_id."\t". 904 $problem->user_id."\t".
298 $problem->source_file."\t". 905 $problem->source_file."\t".
299 $problem->value."\t". 906 $problem->value."\t".
300 $problem->max_attempts."\t". 907 $problem->max_attempts."\t".
301 $problem->problem_seed."\t". 908 $problem->problem_seed."\t".
302 $problem->status."\t". 909 $pureProblem->status."\t".
303 $problem->attempted."\t". 910 $pureProblem->attempted."\t".
304 $problem->last_answer."\t". 911 $pureProblem->last_answer."\t".
305 $problem->num_correct."\t". 912 $pureProblem->num_correct."\t".
306 $problem->num_incorrect 913 $pureProblem->num_incorrect
914 );
915 } else {
916 if (before($set->open_date) or after($set->due_date)) {
917 $scoreRecordedMessage = "Your score was not recorded because this homework set is closed.";
918 } else {
919 $scoreRecordedMessage = "Your score was not recorded.";
920 }
921 }
922 } else {
923 $scoreRecordedMessage = "Your score was not recorded because this problem has not been assigned to you.";
924 }
925 }
926
927 # logging student answers
928
929 my $answer_log = $self->{ce}->{courseFiles}->{logs}->{'answer_log'};
930 if ( defined($answer_log ) and defined($pureProblem)) {
931 if ($submitAnswers && !$authz->hasPermissions($effectiveUser, "dont_log_past_answers")) {
932 my $answerString = ""; my $scores = "";
933 my %answerHash = %{ $pg->{answers} };
934 # FIXME this is the line 552 error. make sure original student ans is defined.
935 # The fact that it is not defined is probably due to an error in some answer evaluator.
936 # But I think it is useful to suppress this error message in the log.
937 foreach (sortByName(undef, keys %answerHash)) {
938 my $orig_ans = $answerHash{$_}->{original_student_ans};
939 my $student_ans = defined $orig_ans ? $orig_ans : '';
940 $answerString .= $student_ans."\t";
941 $scores .= $answerHash{$_}->{score} >= 1 ? "1" : "0";
942 }
943 $answerString = '' unless defined($answerString); # insure string is defined.
944 writeCourseLog($self->{ce}, "answer_log",
945 join("",
946 '|', $problem->user_id,
947 '|', $problem->set_id,
948 '|', $problem->problem_id,
949 '|', $scores, "\t",
950 time(),"\t",
951 $answerString,
952 ),
307 ); 953 );
308 } 954
309 } 955 }
956 }
957
958 debug("end answer processing");
310 959
311 ##### output ##### 960 ##### output #####
961 # custom message for editor
962 if ($authz->hasPermissions($user, "modify_problem_sets") and defined $editMode) {
963 if ($editMode eq "temporaryFile") {
964 print CGI::p(CGI::div({class=>'temporaryFile'}, "Viewing temporary file: ", $problem->source_file));
965 } elsif ($editMode eq "savedFile") {
966 # taken care of in the initialization phase
967 }
968 }
969 print CGI::start_div({class=>"problemHeader"});
312 970
971
972
313 # attempt summary 973 # attempt summary
314 if ($submitAnswers or $will{showCorrectAnswers}) { 974 #FIXME -- the following is a kludge: if showPartialCorrectAnswers is negative don't show anything.
975 # until after the due date
976 # do I need to check $will{showCorrectAnswers} to make preflight work??
977 if (($pg->{flags}->{showPartialCorrectAnswers} >= 0 and $submitAnswers) ) {
315 # print this if user submitted answers OR requested correct answers 978 # print this if user submitted answers OR requested correct answers
316 print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, 979
980 print $self->attemptResults($pg, 1,
981 $will{showCorrectAnswers},
317 $pg->{flags}->{showPartialCorrectAnswers}); 982 $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
983 } elsif ($checkAnswers) {
984 # print this if user previewed answers
985 print CGI::div({class=>'ResultsWithError'},"ANSWERS ONLY CHECKED -- ANSWERS NOT RECORDED"), CGI::br();
986 print $self->attemptResults($pg, 1, $will{showCorrectAnswers}, 1, 1, 1);
987 # show attempt answers
988 # show correct answers if asked
989 # show attempt results (correctness)
990 # show attempt previews
318 } elsif ($previewAnswers) { 991 } elsif ($previewAnswers) {
319 # print this if user previewed answers 992 # print this if user previewed answers
320 print $self->attemptResults($pg, 1, 0, 0); 993 print CGI::div({class=>'ResultsWithError'},"PREVIEW ONLY -- ANSWERS NOT RECORDED"),CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1);
321 # don't show correctness 994 # show attempt answers
322 # don't show correct answers 995 # don't show correct answers
996 # don't show attempt results (correctness)
997 # show attempt previews
998 }
999
1000 print CGI::end_div();
1001
1002 # main form
1003 print CGI::startform("POST", $r->uri);
1004 print $self->hidden_authen_fields;
1005
1006 print CGI::start_div({class=>"problem"});
1007 print CGI::p($pg->{body_text});
1008 print CGI::p(CGI::b("Note: "), CGI::i($pg->{result}->{msg})) if $pg->{result}->{msg};
1009 print $editorLink; # this is empty unless it is appropriate to have an editor link.
1010 print CGI::end_div();
1011
1012 print CGI::start_p();
1013
1014 if ($can{showCorrectAnswers}) {
1015 print CGI::checkbox(
1016 -name => "showCorrectAnswers",
1017 -checked => $will{showCorrectAnswers},
1018 -label => "Show correct answers",
1019 );
1020 }
1021 if ($can{showHints}) {
1022 print CGI::div({style=>"color:red"},
1023 CGI::checkbox(
1024 -name => "showHints",
1025 -checked => $will{showHints},
1026 -label => "Show Hints",
1027 )
1028 );
1029 }
1030 if ($can{showSolutions}) {
1031 print CGI::checkbox(
1032 -name => "showSolutions",
1033 -checked => $will{showSolutions},
1034 -label => "Show Solutions",
1035 );
1036 }
1037
1038 if ($can{showCorrectAnswers} or $can{showHints} or $can{showSolutions}) {
1039 print CGI::br();
1040 }
1041
1042 print CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers");
1043 if ($can{checkAnswers}) {
1044 print CGI::submit(-name=>"checkAnswers", -label=>"Check Answers");
1045 }
1046 if ($can{getSubmitButton}) {
1047 if ($user ne $effectiveUser) {
1048 # if acting as a student, make it clear that answer submissions will
1049 # apply to the student's records, not the professor's.
1050 print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers for $effectiveUser");
1051 } else {
1052 print CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers");
323 } 1053 }
1054 }
1055
1056 print CGI::end_p();
1057
1058 print CGI::start_div({class=>"scoreSummary"});
324 1059
325 # score summary 1060 # score summary
326 my $attempts = $problem->num_correct + $problem->num_incorrect; 1061 my $attempts = $problem->num_correct + $problem->num_incorrect;
327 my $attemptsNoun = $attempts != 1 ? "times" : "time"; 1062 my $attemptsNoun = $attempts != 1 ? "times" : "time";
328 my $lastScore = int ($problem->status * 100) . "%"; 1063 my $problem_status = $problem->status || 0;
1064 my $lastScore = sprintf("%.0f%%", $problem_status * 100); # Round to whole number
329 my ($attemptsLeft, $attemptsLeftNoun); 1065 my ($attemptsLeft, $attemptsLeftNoun);
330 if ($problem->max_attempts == -1) { 1066 if ($problem->max_attempts == -1) {
331 # unlimited attempts 1067 # unlimited attempts
332 $attemptsLeft = "unlimited"; 1068 $attemptsLeft = "unlimited";
333 $attemptsLeftNoun = "attempts"; 1069 $attemptsLeftNoun = "attempts";
334 } else { 1070 } else {
335 $attemptsLeft = $problem->max_attempts - $attempts; 1071 $attemptsLeft = $problem->max_attempts - $attempts;
336 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; 1072 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
337 } 1073 }
1074
1075 my $setClosed = 0;
338 my $setClosedMessage; 1076 my $setClosedMessage;
339 if (time < $set->open_date or time > $set->due_date) { 1077 if (before($set->open_date) or after($set->due_date)) {
1078 $setClosed = 1;
1079 if (before($set->open_date)) {
1080 $setClosedMessage = "This homework set is not yet open.";
1081 } elsif (after($set->due_date)) {
340 $setClosedMessage = "This problem set is closed."; 1082 $setClosedMessage = "This homework set is closed.";
341 if ($permissionLevel > 0) { 1083 }
1084 }
1085 #if (before($set->open_date) or after($set->due_date)) {
1086 # $setClosed = 1;
1087 # $setClosedMessage = "This homework set is closed.";
1088 # if ($authz->hasPermissions($user, "view_answers")) {
342 $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded."; 1089 # $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
343 } else { 1090 # } else {
344 $setClosedMessage .= " Additional attempts will not be recorded."; 1091 # $setClosedMessage .= " Additional attempts will not be recorded.";
345 } 1092 # }
346 } 1093 #}
1094 unless (defined( $pg->{state}->{state_summary_msg}) and $pg->{state}->{state_summary_msg}=~/\S/) {
1095 my $notCountedMessage = ($problem->value) ? "" : "(This problem will not count towards your grade.)";
347 print CGI::p( 1096 print CGI::p(
1097 $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
348 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), 1098 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
1099 $submitAnswers ?"You received a score of ".sprintf("%.0f%%", $pg->{result}->{score} * 100)." for this attempt.".CGI::br():'',
349 $problem->attempted 1100 $problem->attempted
350 ? "Your recorded score is $lastScore." . CGI::br() 1101 ? "Your overall recorded score is $lastScore. $notCountedMessage" . CGI::br()
351 : "", 1102 : "",
352 "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), 1103 $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
353 $setClosedMessage, 1104 );
1105 }else {
1106 print CGI::p($pg->{state}->{state_summary_msg});
1107 }
1108 print CGI::end_div();
1109
1110 # save state for viewOptions
1111 print CGI::hidden(
1112 -name => "showOldAnswers",
1113 -value => $will{showOldAnswers}
1114 ),
1115
1116 CGI::hidden(
1117 -name => "displayMode",
1118 -value => $self->{displayMode}
1119 );
1120 print( CGI::hidden(
1121 -name => 'editMode',
1122 -value => $self->{editMode},
1123 )
1124 ) if defined($self->{editMode}) and $self->{editMode} eq 'temporaryFile';
1125 print( CGI::hidden(
1126 -name => 'sourceFilePath',
1127 -value => $self->{problem}->{source_file}
1128 )) if defined($self->{problem}->{source_file});
1129
1130 print( CGI::hidden(
1131 -name => 'problemSeed',
1132 -value => $r->param("problemSeed")
1133 )) if defined($r->param("problemSeed"));
1134
1135 # end of main form
1136 print CGI::endform();
1137
1138 print CGI::start_div({class=>"problemFooter"});
1139
1140 ## arguments for answer inspection button
1141 #my $prof_url = $ce->{webworkURLs}->{oldProf};
1142 #my $webworkURL = $ce->{webworkURLs}->{root};
1143 #my $cgi_url = $prof_url;
1144 #$cgi_url=~ s|/[^/]*$||; # clip profLogin.pl
1145 #my $authen_args = $self->url_authen_args();
1146 #my $showPastAnswersURL = "$webworkURL/$courseName/instructor/show_answers/";
1147
1148 my $pastAnswersPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Instructor::ShowAnswers",
1149 courseID => $courseName);
1150 my $showPastAnswersURL = $self->systemLink($pastAnswersPage, authen => 0); # no authen info for form action
1151
1152 # print answer inspection button
1153 if ($authz->hasPermissions($user, "view_answers")) {
1154 print "\n",
1155 CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
1156 $self->hidden_authen_fields,"\n",
1157 CGI::hidden(-name => 'courseID', -value=>$courseName), "\n",
1158 CGI::hidden(-name => 'problemID', -value=>$problem->problem_id), "\n",
1159 CGI::hidden(-name => 'setID', -value=>$problem->set_id), "\n",
1160 CGI::hidden(-name => 'studentUser', -value=>$problem->user_id), "\n",
1161 CGI::p( {-align=>"left"},
1162 CGI::submit(-name => 'action', -value=>'Show Past Answers')
1163 ), "\n",
1164 CGI::endform();
1165 }
1166
1167 ## feedback form url
1168 #my $feedbackPage = $urlpath->newFromModule("WeBWorK::ContentGenerator::Feedback",
1169 # courseID => $courseName);
1170 #my $feedbackURL = $self->systemLink($feedbackPage, authen => 0); # no authen info for form action
1171 #
1172 ##print feedback form
1173 #print
1174 # CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
1175 # $self->hidden_authen_fields,"\n",
1176 # CGI::hidden("module", __PACKAGE__),"\n",
1177 # CGI::hidden("set", $set->set_id),"\n",
1178 # CGI::hidden("problem", $problem->problem_id),"\n",
1179 # CGI::hidden("displayMode", $self->{displayMode}),"\n",
1180 # CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n",
1181 # CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
1182 # CGI::hidden("showHints", $will{showHints}),"\n",
1183 # CGI::hidden("showSolutions", $will{showSolutions}),"\n",
1184 # CGI::p({-align=>"left"},
1185 # CGI::submit(-name=>"feedbackForm", -label=>"Email instructor")
1186 # ),
1187 # CGI::endform(),"\n";
1188
1189 print $self->feedbackMacro(
1190 module => __PACKAGE__,
1191 set => $self->{set}->set_id,
1192 problem => $problem->problem_id,
1193 displayMode => $self->{displayMode},
1194 showOldAnswers => $will{showOldAnswers},
1195 showCorrectAnswers => $will{showCorrectAnswers},
1196 showHints => $will{showHints},
1197 showSolutions => $will{showSolutions},
354 ); 1198 );
355 1199
356 print CGI::hr(); 1200 print CGI::end_div();
357
358 # main form
359 print
360 CGI::startform("POST", $r->uri),
361 $self->hidden_authen_fields,
362 $self->viewOptions,
363 CGI::p(CGI::i($pg->{result}->{msg})),
364 CGI::p($pg->{body_text}),
365 CGI::p(
366 CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"),
367 CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"),
368 ),
369 CGI::endform();
370
371 # warning output
372 if ($pg->{warnings} ne "") {
373 print CGI::hr(), warningOutput($pg->{warnings});
374 }
375 1201
376 # debugging stuff 1202 # debugging stuff
1203 if (0) {
377 #print 1204 print
378 # CGI::hr(), 1205 CGI::hr(),
379 # CGI::h2("debugging information"), 1206 CGI::h2("debugging information"),
380 # CGI::h3("form fields"), 1207 CGI::h3("form fields"),
381 # ref2string($self->{formFields}), 1208 ref2string($self->{formFields}),
382 # CGI::h3("user object"), 1209 CGI::h3("user object"),
383 # ref2string($self->{user}), 1210 ref2string($self->{user}),
384 # CGI::h3("set object"), 1211 CGI::h3("set object"),
385 # ref2string($set), 1212 ref2string($set),
386 # CGI::h3("problem object"), 1213 CGI::h3("problem object"),
387 # ref2string($problem), 1214 ref2string($problem),
388 # CGI::h3("PG object"), 1215 CGI::h3("PG object"),
389 # ref2string($pg, {'WeBWorK::PG::Translator' => 1}); 1216 ref2string($pg, {'WeBWorK::PG::Translator' => 1});
1217 }
390 1218
391 return ""; 1219 return "";
392} 1220}
393 1221
394##### output utilities #####
395
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($$$$$) {
429 my $self = shift;
430 my $pg = shift;
431 my $showAttemptAnswers = shift;
432 my $showCorrectAnswers = shift;
433 my $showAttemptResults = $showAttemptAnswers && shift;
434 my $problemResult = $pg->{result}; # the overall result of the problem
435 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
436
437 my $header = CGI::th("answer");
438 $header .= $showAttemptAnswers ? CGI::th("attempt") : "";
439 $header .= $showAttemptAnswers ? CGI::th("preview") : "";
440 $header .= $showCorrectAnswers ? CGI::th("correct") : "";
441 $header .= $showAttemptResults ? CGI::th("result") : "";
442 $header .= $showAttemptAnswers ? CGI::th("messages") : "";
443 my @tableRows = ( $header );
444 my $numCorrect;
445 foreach my $name (@answerNames) {
446 my $answerResult = $pg->{answers}->{$name};
447 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
448 my $preview = $self->previewAnswer($answerResult);
449 my $correctAnswer = $answerResult->{correct_ans};
450 my $answerScore = $answerResult->{score};
451 my $answerMessage = $showAttemptAnswers ? $answerResult->{ans_message} : "";
452
453 $numCorrect += $answerScore > 0;
454 my $resultString = $answerScore ? "correct" : "incorrect";
455
456 # get rid of the goofy prefix on the answer names (supposedly, the format
457 # of the answer names is changeable. this only fixes
458 $name =~ s/^AnSwEr//;
459
460 my $row = CGI::td($name);
461 $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : "";
462 $row .= $showAttemptAnswers ? CGI::td($preview) : "";
463 $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : "";
464 $row .= $showAttemptResults ? CGI::td($resultString) : "";
465 $row .= $answerMessage ? CGI::td($answerMessage) : "";
466 push @tableRows, $row;
467 }
468
469 my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions";
470 my $scorePercent = int ($problemResult->{score} * 100) . "\%";
471 my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of "
472 . scalar @answerNames . " correct, for a score of $scorePercent.";
473 return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary);
474}
475
476sub viewOptions($) {
477 my $self = shift;
478 my $displayMode = $self->{displayMode};
479 my %must = %{ $self->{must} };
480 my %can = %{ $self->{can} };
481 my %will = %{ $self->{will} };
482
483 my $optionLine;
484 $can{showOldAnswers} and $optionLine .= join "",
485 "Show: &nbsp;",
486 CGI::checkbox(
487 -name => "showOldAnswers",
488 -checked => $will{showOldAnswers},
489 -label => "Saved answers",
490 ), "&nbsp;&nbsp;";
491 $can{showCorrectAnswers} and $optionLine .= join "",
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();
510
511 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"},
512 "View equations as: &nbsp;",
513 CGI::radio_group(
514 -name => "displayMode",
515 -values => ['plainText', 'formattedText', 'images'],
516 -default => $displayMode,
517 -labels => {
518 plainText => "plain text",
519 formattedText => "formatted text",
520 images => "images",
521 }
522 ), CGI::br(),
523 $optionLine,
524 CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"),
525 );
526}
527
528sub previewAnswer($$) {
529 my ($self, $answerResult) = @_;
530 my $ce = $self->{courseEnvironment};
531 my $user = $self->{user};
532 my $set = $self->{set};
533 my $problem = $self->{problem};
534
535 # how are we going to name this?
536 my $targetPathCommon = "/png/"
537 . $user->id . "."
538 . $set->id . "."
539 . $problem->id . "."
540 . $answerResult->{ans_name} . ".png";
541
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};
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
552 # call dvipng to generate a preview
553 dvipng($wd, $latex, $dvipng, $tex, $targetPath);
554 if (-e $targetPath) {
555 return "<img src=\"$targetURL\" alt=\"$tex\" />";
556 } else {
557 return "<b>[math2img failed]</b>";
558 }
559}
560
561##### permission queries #####
562
563# this stuff should be abstracted out into the permissions system
564# however, the permission system only knows about things in the
565# course environment and the username. hmmm...
566
567# also, i should fix these so that they have a consistent calling
568# format -- perhaps:
569# canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
570
571sub canShowCorrectAnswers($$) {
572 my ($permissionLevel, $answerDate) = @_;
573 return $permissionLevel > 0 || time > $answerDate;
574}
575
576sub canShowSolutions($$) {
577 my ($permissionLevel, $answerDate) = @_;
578 return canShowCorrectAnswers($permissionLevel, $answerDate);
579}
580
581sub canRecordAnswers($$$$$) {
582 my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
583 my $permHigh = $permissionLevel > 0;
584 my $timeOK = time >= $openDate && time <= $dueDate;
585 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
586 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
587 return $recordAnswers;
588}
589
590sub mustRecordAnswers($) {
591 my ($permissionLevel) = @_;
592 return $permissionLevel == 0;
593}
594
5951; 12221;
Legend:
Removed from v.634  
changed lines
  Added in v.4031
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9