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