--- trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2002/08/05 21:34:18 455 +++ trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2003/01/07 21:19:38 692 @@ -1,5 +1,5 @@ ################################################################################ -# WeBWorK mod_perl (c) 1995-2002 WeBWorK Team, Univeristy of Rochester +# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project # $Id$ ################################################################################ @@ -15,20 +15,11 @@ use warnings; use base qw(WeBWorK::ContentGenerator); use CGI qw(); +use File::Temp qw(tempdir); use WeBWorK::Form; use WeBWorK::PG; -use WeBWorK::Utils qw(ref2string encodeAnswers decodeAnswers); - -# TODO: -# :) enforce permissions for showCorrectAnswers and showSolutions -# (use $PRIV = $canPRIV && ($wantPRIV || $mustPRIV) -- cool syntax!) -# :) if answers were not submitted and there are student answers in the DB, -# decode them and put them into $formFields for the translator -# :) store submitted answers hash in database for sticky answers -# :) deal with the results of answer evaluation and grading :p -# :) introduce a recordAnswers option, which works on the same principle as -# the other permission-based options -# 7. make warnings work +use WeBWorK::PG::IO; +use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); ############################################################ # @@ -48,15 +39,12 @@ # ############################################################ -sub prepare { +sub pre_header_initialize { my ($self, $setName, $problemNumber) = @_; my $courseEnv = $self->{courseEnvironment}; my $r = $self->{r}; - my $userName = $r->param('user'); - - # fix format of setName and problem - $setName =~ s/^set//; - $problemNumber =~ s/^prob//; + my $authUserName = $r->param("user"); + my $userName = $r->param("effectiveUser"); ##### database setup ##### @@ -67,14 +55,16 @@ my $user = $cldb->getUser($userName); my $set = $wwdb->getSet($userName, $setName); my $problem = $wwdb->getProblem($userName, $setName, $problemNumber); - my $permissionLevel = $authdb->getPermissions($userName); + my $psvn = $wwdb->getPSVN($userName, $setName); + my $permissionLevel = $authdb->getPermissions($authUserName); ##### form processing ##### # set options from form fields (see comment at top of file for names) - my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; + my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode}; my $redisplay = $r->param("redisplay"); my $submitAnswers = $r->param("submitAnswers"); + my $previewAnswers = $r->param("previewAnswers"); # coerce form fields into CGI::Vars format my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; @@ -112,7 +102,7 @@ # final values for options my %will; - foreach(keys %must) { + foreach (keys %must) { $will{$_} = $can{$_} && ($want{$_} || $must{$_}); } @@ -128,36 +118,43 @@ my $pg = WeBWorK::PG->new( $courseEnv, - $r->param('user'), + $user, $r->param('key'), - $setName, - $problemNumber, + $set, + $problem, + $psvn, + $formFields, { # translation options displayMode => $displayMode, showHints => $will{showHints}, showSolutions => $will{showSolutions}, refreshMath2img => $will{showHints} || $will{showSolutions}, - # try leaving processAnswers on all the time? - processAnswers => 1, #$submitAnswers ? 1 : 0, + processAnswers => 1, }, - $formFields ); + ##### fix hint/solution options ##### + + $can{showHints} &&= $pg->{flags}->{hintExists}; + $can{showSolutions} &&= $pg->{flags}->{solutionExists}; + ##### store fields ##### $self->{cldb} = $cldb; $self->{wwdb} = $wwdb; $self->{authdb} = $authdb; + $self->{userName} = $userName; $self->{user} = $user; $self->{set} = $set; $self->{problem} = $problem; $self->{permissionLevel} = $permissionLevel; - $self->{displayMode} = $displayMode; - $self->{redisplay} = $redisplay; - $self->{submitAnswers} = $submitAnswers; - $self->{formFields} = $formFields; + $self->{displayMode} = $displayMode; + $self->{redisplay} = $redisplay; + $self->{submitAnswers} = $submitAnswers; + $self->{previewAnswers} = $previewAnswers; + $self->{formFields} = $formFields; $self->{want} = \%want; $self->{must} = \%must; @@ -167,31 +164,116 @@ $self->{pg} = $pg; } +sub if_warnings($$) { + my ($self, $arg) = @_; + return $self->{pg}->{warnings} ne ""; +} + +sub if_errors($$) { + my ($self, $arg) = @_; + return $self->{pg}->{flags}->{error_flag}; +} + +sub head { + my $self = shift; + + return $self->{pg}->{head_text} if $self->{pg}->{head_text}; +} + +sub path { + my $self = shift; + my $args = $_[-1]; + my $setName = $self->{set}->id; + my $problemNumber = $self->{problem}->id; + + my $ce = $self->{courseEnvironment}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; + return $self->pathMacro($args, + "Home" => "$root", + $courseName => "$root/$courseName", + $setName => "$root/$courseName/$setName", + "Problem $problemNumber" => "", + ); +} + +sub siblings { + my $self = shift; + my $setName = $self->{set}->id; + my $problemNumber = $self->{problem}->id; + + my $ce = $self->{courseEnvironment}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; + + print CGI::strong("Problems"), CGI::br(); + + my $wwdb = $self->{wwdb}; + my $user = $self->{userName}; + my @problems; + push @problems, $wwdb->getProblem($user, $setName, $_) + foreach ($wwdb->getProblems($user, $setName)); + foreach my $problem (sort { $a->id <=> $b->id } @problems) { + print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?" + . $self->url_authen_args . "&displayMode=" . $self->{displayMode}}, + "Problem ".$problem->id), CGI::br(); + } +} + +sub nav { + my $self = shift; + my $args = $_[-1]; + my $setName = $self->{set}->id; + my $problemNumber = $self->{problem}->id; + + my $ce = $self->{courseEnvironment}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; + + my $wwdb = $self->{wwdb}; + my $user = $self->{userName}; + my $tail = "&displayMode=".$self->{displayMode}; + + my @links = ("Problem List" => "$root/$courseName/$setName"); + + my $prevProblem = $wwdb->getProblem($user, $setName, $problemNumber-1); + my $nextProblem = $wwdb->getProblem($user, $setName, $problemNumber+1); + unshift @links, "Previous Problem" => $prevProblem + ? "$root/$courseName/$setName/".$prevProblem->id + : ""; + push @links, "Next Problem" => $nextProblem + ? "$root/$courseName/$setName/".$nextProblem->id + : ""; + + return $self->navMacro($args, $tail, @links); +} + sub title { my $self = shift; - #return "Set " . $self->{set}->id . " problem " . $self->{problem}->id; - return "hold on a sec"; + my $setName = $self->{set}->id; + my $problemNumber = $self->{problem}->id; + + return "$setName : Problem $problemNumber"; } sub body { my $self = shift; - $self->prepare(@_); - # unpack some useful variables - my $r = $self->{r}; - my $wwdb = $self->{wwdb}; - my $set = $self->{set}; - my $problem = $self->{problem}; - my $submitAnswers = $self->{submitAnswers}; - my %will = %{ $self->{will} }; - my $pg = $self->{pg}; + my $r = $self->{r}; + my $wwdb = $self->{wwdb}; + my $set = $self->{set}; + my $problem = $self->{problem}; + my $permissionLevel = $self->{permissionLevel}; + my $submitAnswers = $self->{submitAnswers}; + my $previewAnswers = $self->{previewAnswers}; + my %will = %{ $self->{will} }; + my $pg = $self->{pg}; ##### translation errors? ##### if ($pg->{flags}->{error_flag}) { - print translationError($pg->{errors}, $pg->{body_text}); - return ""; + return translationError($pg->{errors}, $pg->{body_text}); } ##### answer processing ##### @@ -214,9 +296,22 @@ $problem->status($pg->{state}->{recorded_score}); $problem->num_correct($pg->{state}->{num_of_correct_ans}); $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); - #warn "Would have stored the following:\n", - # $problem->toString, "\n"; $wwdb->setProblem($problem); + # write to the transaction log, just to make sure + writeLog($self->{courseEnvironment}, "transaction", + $problem->id."\t". + $problem->set_id."\t". + $problem->login_id."\t". + $problem->source_file."\t". + $problem->value."\t". + $problem->max_attempts."\t". + $problem->problem_seed."\t". + $problem->status."\t". + $problem->attempted."\t". + $problem->last_answer."\t". + $problem->num_correct."\t". + $problem->num_incorrect + ); } } @@ -225,8 +320,13 @@ # attempt summary if ($submitAnswers or $will{showCorrectAnswers}) { # print this if user submitted answers OR requested correct answers - print attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, - $pg->{flags}->{showPartialCorrectAnswers}); + print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, + $pg->{flags}->{showPartialCorrectAnswers}, 0); + } elsif ($previewAnswers) { + # print this if user previewed answers + print $self->attemptResults($pg, 1, 0, 0, 1); + # don't show correctness + # don't show correct answers } # score summary @@ -242,21 +342,24 @@ $attemptsLeft = $problem->max_attempts - $attempts; $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; } + my $setClosedMessage; + if (time < $set->open_date or time > $set->due_date) { + $setClosedMessage = "This problem set is closed."; + if ($permissionLevel > 0) { + $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded."; + } else { + $setClosedMessage .= " Additional attempts will not be recorded."; + } + } print CGI::p( "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), $problem->attempted ? "Your recorded score is $lastScore." . CGI::br() : "", - "You have $attemptsLeft $attemptsLeftNoun remaining." + "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), + $setClosedMessage, ); - # BY THE WAY.......... - # we have to figure out some way to tell the student if their NEW answer, - # on THIS attempt, has been recorded. however, this is decided in part by - # the grader, so is there any way for us to know? we can rule out several - # cases where the answer is NOT being recorded, because of things decided - # in &canRecordAnswers... - print CGI::hr(); # main form @@ -265,23 +368,52 @@ $self->hidden_authen_fields, CGI::p(CGI::i($pg->{result}->{msg})), CGI::p($pg->{body_text}), - CGI::p(CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers")), - $self->viewOptions, + CGI::p( + CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"), + CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"), + ), + $self->viewOptions(), CGI::endform(); + # feedback form + my $ce = $self->{courseEnvironment}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; + my $feedbackURL = "$root/$courseName/feedback/"; + print + CGI::startform("POST", $feedbackURL), + $self->hidden_authen_fields, + CGI::hidden("module", __PACKAGE__), + CGI::hidden("set", $set->id), + CGI::hidden("problem", $problem->id), + CGI::hidden("displayMode", $self->{displayMode}), + CGI::hidden("showOldAnswers", $will{showOldAnswers}), + CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}), + CGI::hidden("showHints", $will{showHints}), + CGI::hidden("showSolutions", $will{showSolutions}), + CGI::p({-align=>"right"}, + CGI::submit(-name=>"feedbackForm", -label=>"Send Feedback") + ), + CGI::endform(); + + # warning output + if ($pg->{warnings} ne "") { + print CGI::hr(), warningOutput($pg->{warnings}); + } + # debugging stuff #print - # hr(), - # h2("debugging information"), - # h3("form fields"), - # ref2string($formFields), - # h3("user object"), - # ref2string($user), - # h3("set object"), + # CGI::hr(), + # CGI::h2("debugging information"), + # CGI::h3("form fields"), + # ref2string($self->{formFields}), + # CGI::h3("user object"), + # ref2string($self->{user}), + # CGI::h3("set object"), # ref2string($set), - # h3("problem object"), + # CGI::h3("problem object"), # ref2string($problem), - # h3("PG object"), + # CGI::h3("PG object"), # ref2string($pg, {'WeBWorK::PG::Translator' => 1}); return ""; @@ -289,6 +421,7 @@ ##### output utilities ##### +# this is used by ProblemSet.pm too, so don't fuck it up sub translationError($$) { my ($error, $details) = @_; return @@ -303,33 +436,63 @@ CGI::h3("Error context"), CGI::blockquote(CGI::pre($details)); } -sub attemptResults($$$) { +# this is used by ProblemSet.pm too, so don't fuck it up +sub warningOutput($) { + my $warnings = shift; + + return + CGI::h2("Software Warnings"), + CGI::p(<{result}; # the overall result of the problem my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; - my $header = CGI::th("answer"); - $header .= $showAttemptAnswers ? CGI::th("attempt") : ""; + my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames; + + my $header = CGI::th("part"); + $header .= $showAttemptAnswers ? CGI::th("entered") : ""; + $header .= $showAttemptPreview ? CGI::th("preview") : ""; $header .= $showCorrectAnswers ? CGI::th("correct") : ""; $header .= $showAttemptResults ? CGI::th("result") : ""; - $header .= $showAttemptAnswers ? CGI::th("messages") : ""; + $header .= $showMessages ? CGI::th("messages") : ""; my @tableRows = ( $header ); my $numCorrect; foreach my $name (@answerNames) { my $answerResult = $pg->{answers}->{$name}; my $studentAnswer = $answerResult->{student_ans}; # original_student_ans + my $preview = ($showAttemptPreview + ? $self->previewAnswer($answerResult) + : ""); my $correctAnswer = $answerResult->{correct_ans}; my $answerScore = $answerResult->{score}; - my $answerMessage = $showAttemptAnswers ? $answerResult->{ans_message} : ""; + my $answerMessage = $showMessages ? $answerResult->{ans_message} : ""; $numCorrect += $answerScore > 0; - my $resultString = $answerScore ? "correct :^)" : "incorrect >:("; + my $resultString = $answerScore ? "correct" : "incorrect"; + + # get rid of the goofy prefix on the answer names (supposedly, the format + # of the answer names is changeable. this only fixes it for "AnSwEr" + $name =~ s/^AnSwEr//; my $row = CGI::td($name); $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : ""; + $row .= $showAttemptPreview ? CGI::td($preview) : ""; $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; $row .= $showAttemptResults ? CGI::td($resultString) : ""; $row .= $answerMessage ? CGI::td($answerMessage) : ""; @@ -340,7 +503,7 @@ my $scorePercent = int ($problemResult->{score} * 100) . "\%"; my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of " . scalar @answerNames . " correct, for a score of $scorePercent."; - return CGI::table({-border=>1}, CGI::tr(\@tableRows)) . CGI::p($summary); + return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary); } sub viewOptions($) { @@ -395,6 +558,63 @@ ); } +sub previewAnswer($$) { + my ($self, $answerResult) = @_; + my $ce = $self->{courseEnvironment}; + my $user = $self->{user}; + my $set = $self->{set}; + my $problem = $self->{problem}; + my $displayMode = $self->{displayMode}; + + # note: right now, we have to do things completely differently when we are + # rendering math from INSIDE the translator and from OUTSIDE the translator. + # so we'll just deal with each case explicitly here. there's some code + # duplication that can be dealt with later by abstracting out tth/dvipng/etc. + + my $tex = $answerResult->{preview_latex_string}; + + if ($displayMode eq "plainText") { + return $tex; + } elsif ($displayMode eq "formattedText") { + my $tthCommand = $ce->{externalPrograms}->{tth} + . " -L -f5 -r 2> /dev/null < /dev/null\n" + . "\\($tex\\)\n" + . "END_OF_INPUT\n"; + + + # call tth + my $result = `$tthCommand`; + if ($?) { + return "[tth failed: $? $@]"; + } + return $result; + } elsif ($displayMode eq "images") { + # how are we going to name this? + my $targetPathCommon = "/png/" + . $user->id . "." + . $set->id . "." + . $problem->id . "." + . $answerResult->{ans_name} . ".png"; + + # figure out where to put things + my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp}); + my $latex = $ce->{externalPrograms}->{latex}; + my $dvipng = $ce->{externalPrograms}->{dvipng}; + my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon; + # should use surePathToTmpFile, but we have to + # isolate it from the problem enivronment first + my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon; + + # call dvipng to generate a preview + dvipng($wd, $latex, $dvipng, $tex, $targetPath); + if (-e $targetPath) { + return "\"$tex\""; + } else { + return "[math2img failed]"; + } + } +} + ##### permission queries ##### # this stuff should be abstracted out into the permissions system @@ -419,8 +639,9 @@ my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_; my $permHigh = $permissionLevel > 0; my $timeOK = time >= $openDate && time <= $dueDate; - my $attemptsOK = $attempts <= $maxAttempts; - return $permHigh || ($timeOK && $attemptsOK); + my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts; + my $recordAnswers = $permHigh || ($timeOK && $attemptsOK); + return $recordAnswers; } sub mustRecordAnswers($) {