Parent Directory
| 
Revision Log
Revision 718 -
(view)
(download)
(as text)
Original Path: trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm
| 1 : | sh002i | 449 | ################################################################################ |
| 2 : | sh002i | 494 | # WeBWorK mod_perl (c) 2000-2002 WeBWorK Project |
| 3 : | sh002i | 449 | # $Id$ |
| 4 : | ################################################################################ | ||
| 5 : | |||
| 6 : | malsyned | 353 | package WeBWorK::ContentGenerator::Problem; |
| 7 : | malsyned | 396 | |
| 8 : | sh002i | 455 | =head1 NAME |
| 9 : | |||
| 10 : | WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem. | ||
| 11 : | |||
| 12 : | =cut | ||
| 13 : | |||
| 14 : | malsyned | 396 | use strict; |
| 15 : | use warnings; | ||
| 16 : | sh002i | 449 | use base qw(WeBWorK::ContentGenerator); |
| 17 : | use CGI qw(); | ||
| 18 : | sh002i | 623 | use File::Temp qw(tempdir); |
| 19 : | sh002i | 455 | use WeBWorK::Form; |
| 20 : | use WeBWorK::PG; | ||
| 21 : | sh002i | 623 | use WeBWorK::PG::IO; |
| 22 : | sh002i | 562 | use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); |
| 23 : | malsyned | 353 | |
| 24 : | sh002i | 449 | ############################################################ |
| 25 : | # | ||
| 26 : | sh002i | 424 | # user |
| 27 : | malsyned | 704 | # effectiveUser |
| 28 : | sh002i | 424 | # key |
| 29 : | sh002i | 415 | # |
| 30 : | sh002i | 424 | # displayMode |
| 31 : | # showOldAnswers | ||
| 32 : | # showCorrectAnswers | ||
| 33 : | # showHints | ||
| 34 : | # showSolutions | ||
| 35 : | sh002i | 415 | # |
| 36 : | sh002i | 425 | # AnSwEr# - answer blanks in problem |
| 37 : | # | ||
| 38 : | sh002i | 429 | # redisplay - name of the "Redisplay Problem" button |
| 39 : | # submitAnswers - name of "Submit Answers" button | ||
| 40 : | sh002i | 449 | # |
| 41 : | ############################################################ | ||
| 42 : | gage | 392 | |
| 43 : | sh002i | 476 | sub pre_header_initialize { |
| 44 : | sh002i | 424 | my ($self, $setName, $problemNumber) = @_; |
| 45 : | my $courseEnv = $self->{courseEnvironment}; | ||
| 46 : | my $r = $self->{r}; | ||
| 47 : | malsyned | 704 | my $userName = $r->param('user'); |
| 48 : | my $effectiveUserName = $r->param('effectiveUser'); | ||
| 49 : | malsyned | 353 | |
| 50 : | sh002i | 429 | ##### database setup ##### |
| 51 : | |||
| 52 : | sh002i | 449 | my $cldb = WeBWorK::DB::Classlist->new($courseEnv); |
| 53 : | my $wwdb = WeBWorK::DB::WW->new($courseEnv); | ||
| 54 : | my $authdb = WeBWorK::DB::Auth->new($courseEnv); | ||
| 55 : | sh002i | 429 | |
| 56 : | sh002i | 449 | my $user = $cldb->getUser($userName); |
| 57 : | malsyned | 704 | my $effectiveUser = $cldb->getUser($effectiveUserName); |
| 58 : | my $set = $wwdb->getSet($effectiveUserName, $setName); | ||
| 59 : | my $problem = $wwdb->getProblem($effectiveUserName, $setName, $problemNumber); | ||
| 60 : | my $psvn = $wwdb->getPSVN($effectiveUserName, $setName); | ||
| 61 : | my $permissionLevel = $authdb->getPermissions($userName); | ||
| 62 : | malsyned | 396 | |
| 63 : | sh002i | 429 | ##### form processing ##### |
| 64 : | |||
| 65 : | sh002i | 425 | # set options from form fields (see comment at top of file for names) |
| 66 : | sh002i | 692 | my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; |
| 67 : | sh002i | 425 | my $redisplay = $r->param("redisplay"); |
| 68 : | sh002i | 429 | my $submitAnswers = $r->param("submitAnswers"); |
| 69 : | sh002i | 623 | my $previewAnswers = $r->param("previewAnswers"); |
| 70 : | gage | 388 | |
| 71 : | sh002i | 449 | # coerce form fields into CGI::Vars format |
| 72 : | my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; | ||
| 73 : | |||
| 74 : | ##### permissions ##### | ||
| 75 : | |||
| 76 : | # what does the user want to do? | ||
| 77 : | sh002i | 431 | my %want = ( |
| 78 : | showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers}, | ||
| 79 : | showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers}, | ||
| 80 : | showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints}, | ||
| 81 : | showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions}, | ||
| 82 : | recordAnswers => $r->param("recordAnswers") || 1, | ||
| 83 : | ); | ||
| 84 : | sh002i | 429 | |
| 85 : | sh002i | 431 | # are certain options enforced? |
| 86 : | my %must = ( | ||
| 87 : | showOldAnswers => 0, | ||
| 88 : | showCorrectAnswers => 0, | ||
| 89 : | showHints => 0, | ||
| 90 : | showSolutions => 0, | ||
| 91 : | recordAnswers => mustRecordAnswers($permissionLevel), | ||
| 92 : | ); | ||
| 93 : | |||
| 94 : | sh002i | 429 | # does the user have permission to use certain options? |
| 95 : | sh002i | 431 | my %can = ( |
| 96 : | showOldAnswers => 1, | ||
| 97 : | showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date), | ||
| 98 : | showHints => 1, | ||
| 99 : | showSolutions => canShowSolutions($permissionLevel, $set->answer_date), | ||
| 100 : | recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date, | ||
| 101 : | $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1), | ||
| 102 : | # num_correct+num_incorrect+1 -- as this happens before updating $problem | ||
| 103 : | ); | ||
| 104 : | sh002i | 429 | |
| 105 : | # final values for options | ||
| 106 : | sh002i | 431 | my %will; |
| 107 : | sh002i | 617 | foreach (keys %must) { |
| 108 : | sh002i | 431 | $will{$_} = $can{$_} && ($want{$_} || $must{$_}); |
| 109 : | } | ||
| 110 : | sh002i | 429 | |
| 111 : | ##### sticky answers ##### | ||
| 112 : | |||
| 113 : | sh002i | 431 | if (not $submitAnswers and $will{showOldAnswers}) { |
| 114 : | # do this only if new answers are NOT being submitted | ||
| 115 : | sh002i | 429 | my %oldAnswers = decodeAnswers($problem->last_answer); |
| 116 : | $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers; | ||
| 117 : | } | ||
| 118 : | |||
| 119 : | ##### translation ##### | ||
| 120 : | |||
| 121 : | sh002i | 424 | my $pg = WeBWorK::PG->new( |
| 122 : | $courseEnv, | ||
| 123 : | malsyned | 704 | $effectiveUser, |
| 124 : | sh002i | 424 | $r->param('key'), |
| 125 : | sh002i | 502 | $set, |
| 126 : | $problem, | ||
| 127 : | $psvn, | ||
| 128 : | $formFields, | ||
| 129 : | sh002i | 424 | { # translation options |
| 130 : | sh002i | 434 | displayMode => $displayMode, |
| 131 : | showHints => $will{showHints}, | ||
| 132 : | showSolutions => $will{showSolutions}, | ||
| 133 : | refreshMath2img => $will{showHints} || $will{showSolutions}, | ||
| 134 : | sh002i | 684 | processAnswers => 1, |
| 135 : | sh002i | 424 | }, |
| 136 : | ); | ||
| 137 : | gage | 392 | |
| 138 : | sh002i | 684 | ##### fix hint/solution options ##### |
| 139 : | |||
| 140 : | $can{showHints} &&= $pg->{flags}->{hintExists}; | ||
| 141 : | $can{showSolutions} &&= $pg->{flags}->{solutionExists}; | ||
| 142 : | |||
| 143 : | sh002i | 449 | ##### store fields ##### |
| 144 : | |||
| 145 : | $self->{cldb} = $cldb; | ||
| 146 : | $self->{wwdb} = $wwdb; | ||
| 147 : | $self->{authdb} = $authdb; | ||
| 148 : | |||
| 149 : | sh002i | 692 | $self->{userName} = $userName; |
| 150 : | sh002i | 449 | $self->{user} = $user; |
| 151 : | malsyned | 704 | $self->{effectiveUser} = $effectiveUser; |
| 152 : | sh002i | 449 | $self->{set} = $set; |
| 153 : | $self->{problem} = $problem; | ||
| 154 : | $self->{permissionLevel} = $permissionLevel; | ||
| 155 : | |||
| 156 : | sh002i | 623 | $self->{displayMode} = $displayMode; |
| 157 : | $self->{redisplay} = $redisplay; | ||
| 158 : | $self->{submitAnswers} = $submitAnswers; | ||
| 159 : | $self->{previewAnswers} = $previewAnswers; | ||
| 160 : | $self->{formFields} = $formFields; | ||
| 161 : | sh002i | 449 | |
| 162 : | $self->{want} = \%want; | ||
| 163 : | $self->{must} = \%must; | ||
| 164 : | $self->{can} = \%can; | ||
| 165 : | $self->{will} = \%will; | ||
| 166 : | |||
| 167 : | $self->{pg} = $pg; | ||
| 168 : | } | ||
| 169 : | |||
| 170 : | sh002i | 558 | sub if_warnings($$) { |
| 171 : | my ($self, $arg) = @_; | ||
| 172 : | return $self->{pg}->{warnings} ne ""; | ||
| 173 : | } | ||
| 174 : | |||
| 175 : | sub if_errors($$) { | ||
| 176 : | my ($self, $arg) = @_; | ||
| 177 : | return $self->{pg}->{flags}->{error_flag}; | ||
| 178 : | } | ||
| 179 : | |||
| 180 : | sh002i | 562 | sub head { |
| 181 : | sh002i | 555 | my $self = shift; |
| 182 : | |||
| 183 : | return $self->{pg}->{head_text} if $self->{pg}->{head_text}; | ||
| 184 : | } | ||
| 185 : | sh002i | 476 | |
| 186 : | sub path { | ||
| 187 : | my $self = shift; | ||
| 188 : | my $args = $_[-1]; | ||
| 189 : | my $setName = $self->{set}->id; | ||
| 190 : | my $problemNumber = $self->{problem}->id; | ||
| 191 : | |||
| 192 : | my $ce = $self->{courseEnvironment}; | ||
| 193 : | my $root = $ce->{webworkURLs}->{root}; | ||
| 194 : | my $courseName = $ce->{courseName}; | ||
| 195 : | return $self->pathMacro($args, | ||
| 196 : | "Home" => "$root", | ||
| 197 : | $courseName => "$root/$courseName", | ||
| 198 : | sh002i | 555 | $setName => "$root/$courseName/$setName", |
| 199 : | sh002i | 476 | "Problem $problemNumber" => "", |
| 200 : | ); | ||
| 201 : | } | ||
| 202 : | |||
| 203 : | sub siblings { | ||
| 204 : | my $self = shift; | ||
| 205 : | my $setName = $self->{set}->id; | ||
| 206 : | my $problemNumber = $self->{problem}->id; | ||
| 207 : | |||
| 208 : | my $ce = $self->{courseEnvironment}; | ||
| 209 : | my $root = $ce->{webworkURLs}->{root}; | ||
| 210 : | my $courseName = $ce->{courseName}; | ||
| 211 : | |||
| 212 : | sh002i | 526 | print CGI::strong("Problems"), CGI::br(); |
| 213 : | |||
| 214 : | sh002i | 476 | my $wwdb = $self->{wwdb}; |
| 215 : | malsyned | 704 | my $effectiveUser = $self->{r}->param("effectiveUser"); |
| 216 : | sh002i | 476 | my @problems; |
| 217 : | malsyned | 704 | push @problems, $wwdb->getProblem($effectiveUser, $setName, $_) |
| 218 : | foreach ($wwdb->getProblems($effectiveUser, $setName)); | ||
| 219 : | sh002i | 476 | foreach my $problem (sort { $a->id <=> $b->id } @problems) { |
| 220 : | print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?" | ||
| 221 : | sh002i | 692 | . $self->url_authen_args . "&displayMode=" . $self->{displayMode}}, |
| 222 : | "Problem ".$problem->id), CGI::br(); | ||
| 223 : | sh002i | 476 | } |
| 224 : | } | ||
| 225 : | |||
| 226 : | sub nav { | ||
| 227 : | my $self = shift; | ||
| 228 : | my $args = $_[-1]; | ||
| 229 : | my $setName = $self->{set}->id; | ||
| 230 : | my $problemNumber = $self->{problem}->id; | ||
| 231 : | |||
| 232 : | my $ce = $self->{courseEnvironment}; | ||
| 233 : | my $root = $ce->{webworkURLs}->{root}; | ||
| 234 : | my $courseName = $ce->{courseName}; | ||
| 235 : | |||
| 236 : | malsyned | 704 | my $wwdb = $self->{wwdb}; |
| 237 : | my $effectiveUser = $self->{r}->param("effectiveUser"); | ||
| 238 : | sh002i | 692 | my $tail = "&displayMode=".$self->{displayMode}; |
| 239 : | sh002i | 476 | |
| 240 : | sh002i | 555 | my @links = ("Problem List" => "$root/$courseName/$setName"); |
| 241 : | sh002i | 476 | |
| 242 : | malsyned | 704 | my $prevProblem = $wwdb->getProblem($effectiveUser, $setName, $problemNumber-1); |
| 243 : | my $nextProblem = $wwdb->getProblem($effectiveUser, $setName, $problemNumber+1); | ||
| 244 : | sh002i | 555 | unshift @links, "Previous Problem" => $prevProblem |
| 245 : | ? "$root/$courseName/$setName/".$prevProblem->id | ||
| 246 : | : ""; | ||
| 247 : | push @links, "Next Problem" => $nextProblem | ||
| 248 : | ? "$root/$courseName/$setName/".$nextProblem->id | ||
| 249 : | : ""; | ||
| 250 : | sh002i | 476 | |
| 251 : | sh002i | 692 | return $self->navMacro($args, $tail, @links); |
| 252 : | sh002i | 476 | } |
| 253 : | |||
| 254 : | sh002i | 449 | sub title { |
| 255 : | my $self = shift; | ||
| 256 : | sh002i | 476 | my $setName = $self->{set}->id; |
| 257 : | my $problemNumber = $self->{problem}->id; | ||
| 258 : | |||
| 259 : | return "$setName : Problem $problemNumber"; | ||
| 260 : | sh002i | 449 | } |
| 261 : | |||
| 262 : | sub body { | ||
| 263 : | my $self = shift; | ||
| 264 : | |||
| 265 : | # unpack some useful variables | ||
| 266 : | sh002i | 476 | my $r = $self->{r}; |
| 267 : | my $wwdb = $self->{wwdb}; | ||
| 268 : | my $set = $self->{set}; | ||
| 269 : | my $problem = $self->{problem}; | ||
| 270 : | my $permissionLevel = $self->{permissionLevel}; | ||
| 271 : | my $submitAnswers = $self->{submitAnswers}; | ||
| 272 : | sh002i | 623 | my $previewAnswers = $self->{previewAnswers}; |
| 273 : | sh002i | 476 | my %will = %{ $self->{will} }; |
| 274 : | my $pg = $self->{pg}; | ||
| 275 : | sh002i | 449 | |
| 276 : | ##### translation errors? ##### | ||
| 277 : | |||
| 278 : | sh002i | 425 | if ($pg->{flags}->{error_flag}) { |
| 279 : | sh002i | 526 | return translationError($pg->{errors}, $pg->{body_text}); |
| 280 : | sh002i | 425 | } |
| 281 : | sh002i | 415 | |
| 282 : | sh002i | 429 | ##### answer processing ##### |
| 283 : | |||
| 284 : | # if answers were submitted: | ||
| 285 : | if ($submitAnswers) { | ||
| 286 : | sh002i | 431 | # store answers in DB for sticky answers |
| 287 : | sh002i | 429 | my %answersToStore; |
| 288 : | my %answerHash = %{ $pg->{answers} }; | ||
| 289 : | $answersToStore{$_} = $answerHash{$_}->{original_student_ans} | ||
| 290 : | foreach (keys %answerHash); | ||
| 291 : | my $answerString = encodeAnswers(%answersToStore, | ||
| 292 : | @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); | ||
| 293 : | $problem->last_answer($answerString); | ||
| 294 : | $wwdb->setProblem($problem); | ||
| 295 : | |||
| 296 : | sh002i | 449 | # store state in DB if it makes sense |
| 297 : | sh002i | 431 | if ($will{recordAnswers}) { |
| 298 : | $problem->attempted(1); | ||
| 299 : | $problem->status($pg->{state}->{recorded_score}); | ||
| 300 : | $problem->num_correct($pg->{state}->{num_of_correct_ans}); | ||
| 301 : | $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); | ||
| 302 : | $wwdb->setProblem($problem); | ||
| 303 : | sh002i | 562 | # write to the transaction log, just to make sure |
| 304 : | writeLog($self->{courseEnvironment}, "transaction", | ||
| 305 : | $problem->id."\t". | ||
| 306 : | $problem->set_id."\t". | ||
| 307 : | $problem->login_id."\t". | ||
| 308 : | $problem->source_file."\t". | ||
| 309 : | $problem->value."\t". | ||
| 310 : | $problem->max_attempts."\t". | ||
| 311 : | $problem->problem_seed."\t". | ||
| 312 : | $problem->status."\t". | ||
| 313 : | $problem->attempted."\t". | ||
| 314 : | $problem->last_answer."\t". | ||
| 315 : | $problem->num_correct."\t". | ||
| 316 : | $problem->num_incorrect | ||
| 317 : | ); | ||
| 318 : | sh002i | 431 | } |
| 319 : | sh002i | 425 | } |
| 320 : | |||
| 321 : | sh002i | 429 | ##### output ##### |
| 322 : | sh002i | 425 | |
| 323 : | sh002i | 431 | # attempt summary |
| 324 : | if ($submitAnswers or $will{showCorrectAnswers}) { | ||
| 325 : | # print this if user submitted answers OR requested correct answers | ||
| 326 : | sh002i | 623 | print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, |
| 327 : | sh002i | 683 | $pg->{flags}->{showPartialCorrectAnswers}, 0); |
| 328 : | sh002i | 623 | } elsif ($previewAnswers) { |
| 329 : | # print this if user previewed answers | ||
| 330 : | sh002i | 683 | print $self->attemptResults($pg, 1, 0, 0, 1); |
| 331 : | sh002i | 623 | # don't show correctness |
| 332 : | # don't show correct answers | ||
| 333 : | sh002i | 431 | } |
| 334 : | gage | 392 | |
| 335 : | sh002i | 431 | # score summary |
| 336 : | my $attempts = $problem->num_correct + $problem->num_incorrect; | ||
| 337 : | my $attemptsNoun = $attempts != 1 ? "times" : "time"; | ||
| 338 : | my $lastScore = int ($problem->status * 100) . "%"; | ||
| 339 : | my ($attemptsLeft, $attemptsLeftNoun); | ||
| 340 : | if ($problem->max_attempts == -1) { | ||
| 341 : | # unlimited attempts | ||
| 342 : | $attemptsLeft = "unlimited"; | ||
| 343 : | $attemptsLeftNoun = "attempts"; | ||
| 344 : | } else { | ||
| 345 : | $attemptsLeft = $problem->max_attempts - $attempts; | ||
| 346 : | $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; | ||
| 347 : | } | ||
| 348 : | sh002i | 476 | my $setClosedMessage; |
| 349 : | if (time < $set->open_date or time > $set->due_date) { | ||
| 350 : | $setClosedMessage = "This problem set is closed."; | ||
| 351 : | if ($permissionLevel > 0) { | ||
| 352 : | $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded."; | ||
| 353 : | } else { | ||
| 354 : | $setClosedMessage .= " Additional attempts will not be recorded."; | ||
| 355 : | } | ||
| 356 : | } | ||
| 357 : | sh002i | 449 | print CGI::p( |
| 358 : | "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), | ||
| 359 : | sh002i | 431 | $problem->attempted |
| 360 : | sh002i | 449 | ? "Your recorded score is $lastScore." . CGI::br() |
| 361 : | sh002i | 431 | : "", |
| 362 : | sh002i | 476 | "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), |
| 363 : | $setClosedMessage, | ||
| 364 : | sh002i | 431 | ); |
| 365 : | |||
| 366 : | sh002i | 449 | print CGI::hr(); |
| 367 : | sh002i | 431 | |
| 368 : | sh002i | 429 | # main form |
| 369 : | |||
| 370 : | sh002i | 449 | CGI::startform("POST", $r->uri), |
| 371 : | sh002i | 429 | $self->hidden_authen_fields, |
| 372 : | sh002i | 449 | CGI::p(CGI::i($pg->{result}->{msg})), |
| 373 : | CGI::p($pg->{body_text}), | ||
| 374 : | sh002i | 623 | CGI::p( |
| 375 : | CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"), | ||
| 376 : | CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"), | ||
| 377 : | ), | ||
| 378 : | sh002i | 671 | $self->viewOptions(), |
| 379 : | sh002i | 449 | CGI::endform(); |
| 380 : | sh002i | 429 | |
| 381 : | sh002i | 667 | # feedback form |
| 382 : | my $ce = $self->{courseEnvironment}; | ||
| 383 : | my $root = $ce->{webworkURLs}->{root}; | ||
| 384 : | my $courseName = $ce->{courseName}; | ||
| 385 : | my $feedbackURL = "$root/$courseName/feedback/"; | ||
| 386 : | |||
| 387 : | CGI::startform("POST", $feedbackURL), | ||
| 388 : | $self->hidden_authen_fields, | ||
| 389 : | CGI::hidden("module", __PACKAGE__), | ||
| 390 : | CGI::hidden("set", $set->id), | ||
| 391 : | CGI::hidden("problem", $problem->id), | ||
| 392 : | CGI::hidden("displayMode", $self->{displayMode}), | ||
| 393 : | CGI::hidden("showOldAnswers", $will{showOldAnswers}), | ||
| 394 : | CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}), | ||
| 395 : | CGI::hidden("showHints", $will{showHints}), | ||
| 396 : | CGI::hidden("showSolutions", $will{showSolutions}), | ||
| 397 : | CGI::p({-align=>"right"}, | ||
| 398 : | CGI::submit(-name=>"feedbackForm", -label=>"Send Feedback") | ||
| 399 : | ), | ||
| 400 : | CGI::endform(); | ||
| 401 : | |||
| 402 : | sh002i | 558 | # warning output |
| 403 : | if ($pg->{warnings} ne "") { | ||
| 404 : | print CGI::hr(), warningOutput($pg->{warnings}); | ||
| 405 : | } | ||
| 406 : | |||
| 407 : | sh002i | 424 | # debugging stuff |
| 408 : | sh002i | 692 | |
| 409 : | # CGI::hr(), | ||
| 410 : | # CGI::h2("debugging information"), | ||
| 411 : | # CGI::h3("form fields"), | ||
| 412 : | # ref2string($self->{formFields}), | ||
| 413 : | # CGI::h3("user object"), | ||
| 414 : | # ref2string($self->{user}), | ||
| 415 : | # CGI::h3("set object"), | ||
| 416 : | # ref2string($set), | ||
| 417 : | # CGI::h3("problem object"), | ||
| 418 : | # ref2string($problem), | ||
| 419 : | # CGI::h3("PG object"), | ||
| 420 : | # ref2string($pg, {'WeBWorK::PG::Translator' => 1}); | ||
| 421 : | gage | 392 | |
| 422 : | sh002i | 424 | return ""; |
| 423 : | malsyned | 353 | } |
| 424 : | |||
| 425 : | sh002i | 431 | ##### output utilities ##### |
| 426 : | sh002i | 429 | |
| 427 : | sh002i | 526 | # this is used by ProblemSet.pm too, so don't fuck it up |
| 428 : | sh002i | 429 | sub translationError($$) { |
| 429 : | my ($error, $details) = @_; | ||
| 430 : | return | ||
| 431 : | sh002i | 449 | CGI::h2("Software Error"), |
| 432 : | CGI::p(<<EOF), | ||
| 433 : | sh002i | 429 | WeBWorK has encountered a software error while attempting to process this problem. |
| 434 : | It is likely that there is an error in the problem itself. | ||
| 435 : | If you are a student, contact your professor to have the error corrected. | ||
| 436 : | If you are a professor, please consut the error output below for more informaiton. | ||
| 437 : | EOF | ||
| 438 : | sh002i | 449 | CGI::h3("Error messages"), CGI::blockquote(CGI::pre($error)), |
| 439 : | CGI::h3("Error context"), CGI::blockquote(CGI::pre($details)); | ||
| 440 : | sh002i | 429 | } |
| 441 : | |||
| 442 : | sh002i | 558 | # this is used by ProblemSet.pm too, so don't fuck it up |
| 443 : | sub warningOutput($) { | ||
| 444 : | my $warnings = shift; | ||
| 445 : | |||
| 446 : | return | ||
| 447 : | CGI::h2("Software Warnings"), | ||
| 448 : | CGI::p(<<EOF), | ||
| 449 : | WeBWorK has encountered warnings while attempting to process this problem. | ||
| 450 : | It is likely that this indicates an error or ambiguity in the problem itself. | ||
| 451 : | If you are a student, contact your professor to have the problem corrected. | ||
| 452 : | If you are a professor, please consut the error output below for more informaiton. | ||
| 453 : | EOF | ||
| 454 : | CGI::h3("Warning messages"), | ||
| 455 : | CGI::blockquote(CGI::pre($warnings)), | ||
| 456 : | ; | ||
| 457 : | } | ||
| 458 : | |||
| 459 : | sh002i | 623 | sub attemptResults($$$$$) { |
| 460 : | my $self = shift; | ||
| 461 : | sh002i | 425 | my $pg = shift; |
| 462 : | sh002i | 431 | my $showAttemptAnswers = shift; |
| 463 : | sh002i | 425 | my $showCorrectAnswers = shift; |
| 464 : | sh002i | 431 | my $showAttemptResults = $showAttemptAnswers && shift; |
| 465 : | sh002i | 683 | my $showAttemptPreview = shift || 0; |
| 466 : | sh002i | 425 | my $problemResult = $pg->{result}; # the overall result of the problem |
| 467 : | my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; | ||
| 468 : | |||
| 469 : | sh002i | 685 | my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames; |
| 470 : | |||
| 471 : | my $header = CGI::th("part"); | ||
| 472 : | $header .= $showAttemptAnswers ? CGI::th("entered") : ""; | ||
| 473 : | sh002i | 683 | $header .= $showAttemptPreview ? CGI::th("preview") : ""; |
| 474 : | sh002i | 449 | $header .= $showCorrectAnswers ? CGI::th("correct") : ""; |
| 475 : | $header .= $showAttemptResults ? CGI::th("result") : ""; | ||
| 476 : | sh002i | 685 | $header .= $showMessages ? CGI::th("messages") : ""; |
| 477 : | sh002i | 425 | my @tableRows = ( $header ); |
| 478 : | my $numCorrect; | ||
| 479 : | foreach my $name (@answerNames) { | ||
| 480 : | my $answerResult = $pg->{answers}->{$name}; | ||
| 481 : | sh002i | 429 | my $studentAnswer = $answerResult->{student_ans}; # original_student_ans |
| 482 : | sh002i | 683 | my $preview = ($showAttemptPreview |
| 483 : | ? $self->previewAnswer($answerResult) | ||
| 484 : | : ""); | ||
| 485 : | sh002i | 425 | my $correctAnswer = $answerResult->{correct_ans}; |
| 486 : | my $answerScore = $answerResult->{score}; | ||
| 487 : | sh002i | 685 | my $answerMessage = $showMessages ? $answerResult->{ans_message} : ""; |
| 488 : | sh002i | 425 | |
| 489 : | $numCorrect += $answerScore > 0; | ||
| 490 : | sh002i | 555 | my $resultString = $answerScore ? "correct" : "incorrect"; |
| 491 : | sh002i | 425 | |
| 492 : | sh002i | 555 | # get rid of the goofy prefix on the answer names (supposedly, the format |
| 493 : | sh002i | 683 | # of the answer names is changeable. this only fixes it for "AnSwEr" |
| 494 : | sh002i | 555 | $name =~ s/^AnSwEr//; |
| 495 : | |||
| 496 : | sh002i | 449 | my $row = CGI::td($name); |
| 497 : | $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : ""; | ||
| 498 : | sh002i | 683 | $row .= $showAttemptPreview ? CGI::td($preview) : ""; |
| 499 : | sh002i | 449 | $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; |
| 500 : | $row .= $showAttemptResults ? CGI::td($resultString) : ""; | ||
| 501 : | $row .= $answerMessage ? CGI::td($answerMessage) : ""; | ||
| 502 : | sh002i | 425 | push @tableRows, $row; |
| 503 : | } | ||
| 504 : | |||
| 505 : | sh002i | 431 | my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions"; |
| 506 : | sh002i | 425 | my $scorePercent = int ($problemResult->{score} * 100) . "\%"; |
| 507 : | sh002i | 431 | my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of " |
| 508 : | sh002i | 425 | . scalar @answerNames . " correct, for a score of $scorePercent."; |
| 509 : | sh002i | 476 | return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary); |
| 510 : | sh002i | 425 | } |
| 511 : | |||
| 512 : | sh002i | 449 | sub viewOptions($) { |
| 513 : | my $self = shift; | ||
| 514 : | my $displayMode = $self->{displayMode}; | ||
| 515 : | my %must = %{ $self->{must} }; | ||
| 516 : | my %can = %{ $self->{can} }; | ||
| 517 : | my %will = %{ $self->{will} }; | ||
| 518 : | sh002i | 431 | |
| 519 : | my $optionLine; | ||
| 520 : | $can{showOldAnswers} and $optionLine .= join "", | ||
| 521 : | sh002i | 429 | "Show: ", |
| 522 : | sh002i | 449 | CGI::checkbox( |
| 523 : | sh002i | 429 | -name => "showOldAnswers", |
| 524 : | sh002i | 431 | -checked => $will{showOldAnswers}, |
| 525 : | -label => "Saved answers", | ||
| 526 : | ), " "; | ||
| 527 : | $can{showCorrectAnswers} and $optionLine .= join "", | ||
| 528 : | sh002i | 449 | CGI::checkbox( |
| 529 : | sh002i | 429 | -name => "showCorrectAnswers", |
| 530 : | sh002i | 431 | -checked => $will{showCorrectAnswers}, |
| 531 : | sh002i | 429 | -label => "Correct answers", |
| 532 : | sh002i | 431 | ), " "; |
| 533 : | $can{showHints} and $optionLine .= join "", | ||
| 534 : | sh002i | 449 | CGI::checkbox( |
| 535 : | sh002i | 429 | -name => "showHints", |
| 536 : | sh002i | 431 | -checked => $will{showHints}, |
| 537 : | sh002i | 429 | -label => "Hints", |
| 538 : | sh002i | 431 | ), " "; |
| 539 : | $can{showSolutions} and $optionLine .= join "", | ||
| 540 : | sh002i | 449 | CGI::checkbox( |
| 541 : | sh002i | 429 | -name => "showSolutions", |
| 542 : | sh002i | 431 | -checked => $will{showSolutions}, |
| 543 : | sh002i | 429 | -label => "Solutions", |
| 544 : | sh002i | 431 | ), " "; |
| 545 : | sh002i | 449 | $optionLine and $optionLine .= join "", CGI::br(); |
| 546 : | sh002i | 431 | |
| 547 : | sh002i | 449 | return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, |
| 548 : | sh002i | 431 | "View equations as: ", |
| 549 : | sh002i | 449 | CGI::radio_group( |
| 550 : | sh002i | 431 | -name => "displayMode", |
| 551 : | -values => ['plainText', 'formattedText', 'images'], | ||
| 552 : | -default => $displayMode, | ||
| 553 : | -labels => { | ||
| 554 : | plainText => "plain text", | ||
| 555 : | formattedText => "formatted text", | ||
| 556 : | images => "images", | ||
| 557 : | } | ||
| 558 : | sh002i | 449 | ), CGI::br(), |
| 559 : | sh002i | 431 | $optionLine, |
| 560 : | sh002i | 449 | CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"), |
| 561 : | sh002i | 429 | ); |
| 562 : | } | ||
| 563 : | |||
| 564 : | sh002i | 623 | sub previewAnswer($$) { |
| 565 : | my ($self, $answerResult) = @_; | ||
| 566 : | malsyned | 718 | my $ce = $self->{courseEnvironment}; |
| 567 : | my $effectiveUser = $self->{effectiveUser}; | ||
| 568 : | my $set = $self->{set}; | ||
| 569 : | my $problem = $self->{problem}; | ||
| 570 : | my $displayMode = $self->{displayMode}; | ||
| 571 : | sh002i | 623 | |
| 572 : | sh002i | 682 | # note: right now, we have to do things completely differently when we are |
| 573 : | # rendering math from INSIDE the translator and from OUTSIDE the translator. | ||
| 574 : | # so we'll just deal with each case explicitly here. there's some code | ||
| 575 : | # duplication that can be dealt with later by abstracting out tth/dvipng/etc. | ||
| 576 : | sh002i | 623 | |
| 577 : | my $tex = $answerResult->{preview_latex_string}; | ||
| 578 : | |||
| 579 : | sh002i | 682 | if ($displayMode eq "plainText") { |
| 580 : | return $tex; | ||
| 581 : | } elsif ($displayMode eq "formattedText") { | ||
| 582 : | my $tthCommand = $ce->{externalPrograms}->{tth} | ||
| 583 : | . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n" | ||
| 584 : | . "\\($tex\\)\n" | ||
| 585 : | . "END_OF_INPUT\n"; | ||
| 586 : | |||
| 587 : | |||
| 588 : | # call tth | ||
| 589 : | my $result = `$tthCommand`; | ||
| 590 : | if ($?) { | ||
| 591 : | return "<b>[tth failed: $? $@]</b>"; | ||
| 592 : | } | ||
| 593 : | return $result; | ||
| 594 : | } elsif ($displayMode eq "images") { | ||
| 595 : | # how are we going to name this? | ||
| 596 : | my $targetPathCommon = "/png/" | ||
| 597 : | malsyned | 717 | . $effectiveUser->id . "." |
| 598 : | sh002i | 682 | . $set->id . "." |
| 599 : | . $problem->id . "." | ||
| 600 : | . $answerResult->{ans_name} . ".png"; | ||
| 601 : | |||
| 602 : | # figure out where to put things | ||
| 603 : | my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp}); | ||
| 604 : | my $latex = $ce->{externalPrograms}->{latex}; | ||
| 605 : | my $dvipng = $ce->{externalPrograms}->{dvipng}; | ||
| 606 : | my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon; | ||
| 607 : | # should use surePathToTmpFile, but we have to | ||
| 608 : | # isolate it from the problem enivronment first | ||
| 609 : | my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon; | ||
| 610 : | |||
| 611 : | # call dvipng to generate a preview | ||
| 612 : | dvipng($wd, $latex, $dvipng, $tex, $targetPath); | ||
| 613 : | if (-e $targetPath) { | ||
| 614 : | return "<img src=\"$targetURL\" alt=\"$tex\" />"; | ||
| 615 : | } else { | ||
| 616 : | return "<b>[math2img failed]</b>"; | ||
| 617 : | } | ||
| 618 : | sh002i | 623 | } |
| 619 : | } | ||
| 620 : | |||
| 621 : | sh002i | 431 | ##### permission queries ##### |
| 622 : | sh002i | 429 | |
| 623 : | # this stuff should be abstracted out into the permissions system | ||
| 624 : | # however, the permission system only knows about things in the | ||
| 625 : | # course environment and the username. hmmm... | ||
| 626 : | |||
| 627 : | sh002i | 431 | # also, i should fix these so that they have a consistent calling |
| 628 : | # format -- perhaps: | ||
| 629 : | # canPERM($courseEnv, $user, $set, $problem, $permissionLevel) | ||
| 630 : | |||
| 631 : | sh002i | 429 | sub canShowCorrectAnswers($$) { |
| 632 : | my ($permissionLevel, $answerDate) = @_; | ||
| 633 : | return $permissionLevel > 0 || time > $answerDate; | ||
| 634 : | } | ||
| 635 : | |||
| 636 : | sub canShowSolutions($$) { | ||
| 637 : | my ($permissionLevel, $answerDate) = @_; | ||
| 638 : | return canShowCorrectAnswers($permissionLevel, $answerDate); | ||
| 639 : | } | ||
| 640 : | |||
| 641 : | sh002i | 431 | sub canRecordAnswers($$$$$) { |
| 642 : | my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_; | ||
| 643 : | my $permHigh = $permissionLevel > 0; | ||
| 644 : | my $timeOK = time >= $openDate && time <= $dueDate; | ||
| 645 : | sh002i | 617 | my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts; |
| 646 : | my $recordAnswers = $permHigh || ($timeOK && $attemptsOK); | ||
| 647 : | return $recordAnswers; | ||
| 648 : | sh002i | 429 | } |
| 649 : | |||
| 650 : | sub mustRecordAnswers($) { | ||
| 651 : | my ($permissionLevel) = @_; | ||
| 652 : | return $permissionLevel == 0; | ||
| 653 : | } | ||
| 654 : | |||
| 655 : | sh002i | 415 | 1; |
| aubreyja at gmail dot com | ViewVC Help |
| Powered by ViewVC 1.0.9 |