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