--- trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2002/07/19 06:19:34 434 +++ trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2002/11/20 19:12:44 634 @@ -1,13 +1,28 @@ +################################################################################ +# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project +# $Id$ +################################################################################ + package WeBWorK::ContentGenerator::Problem; -use base qw(WeBWorK::ContentGenerator); + +=head1 NAME + +WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem. + +=cut use strict; use warnings; -use CGI qw(:html :form); -use WeBWorK::Utils qw(ref2string encodeAnswers decodeAnswers); -use WeBWorK::PG; +use base qw(WeBWorK::ContentGenerator); +use CGI qw(); +use File::Temp qw(tempdir); use WeBWorK::Form; +use WeBWorK::PG; +use WeBWorK::PG::IO; +use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); +############################################################ +# # user # key # @@ -21,44 +36,25 @@ # # redisplay - name of the "Redisplay Problem" button # submitAnswers - name of "Submit Answers" button +# +############################################################ -sub title { - my ($self, $setName, $problemNumber) = @_; - my $userName = $self->{r}->param('user'); - return "Problem $problemNumber of problem set $setName for $userName"; -} - -# TODO: -# :) enforce permissions for showCorrectAnswers and showSolutions -# (use $PRIV = $mustPRIV || ($canPRIV && $wantPRIV) -- 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 - -sub body { +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//; - ##### database setup ##### - # this should probably go in initialize() or whatever it's called - my $classlist = WeBWorK::DB::Classlist->new($courseEnv); - my $wwdb = WeBWorK::DB::WW->new($courseEnv); - my $authdb = WeBWorK::DB::Auth->new($courseEnv); - - my $user = $classlist->getUser($userName); - my $set = $wwdb->getSet($userName, $setName); - my $problem = $wwdb->getProblem($userName, $setName, $problemNumber); + my $cldb = WeBWorK::DB::Classlist->new($courseEnv); + my $wwdb = WeBWorK::DB::WW->new($courseEnv); + my $authdb = WeBWorK::DB::Auth->new($courseEnv); + + my $user = $cldb->getUser($userName); + my $set = $wwdb->getSet($userName, $setName); + my $problem = $wwdb->getProblem($userName, $setName, $problemNumber); + my $psvn = $wwdb->getPSVN($userName, $setName); my $permissionLevel = $authdb->getPermissions($userName); ##### form processing ##### @@ -67,7 +63,14 @@ 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 }; + ##### permissions ##### + + # what does the user want to do? my %want = ( showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers}, showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers}, @@ -76,11 +79,6 @@ recordAnswers => $r->param("recordAnswers") || 1, ); - # coerce form fields into CGI::Vars format - my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; - - ##### permissions ##### - # are certain options enforced? my %must = ( showOldAnswers => 0, @@ -103,8 +101,9 @@ # final values for options my %will; - foreach(keys %must) { + foreach (keys %must) { $will{$_} = $can{$_} && ($want{$_} || $must{$_}); + #warn "$_: can? $can{$_} want? $want{$_} must? $must{$_} will? $will{$_}\n"; } ##### sticky answers ##### @@ -119,10 +118,12 @@ 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}, @@ -131,17 +132,141 @@ # try leaving processAnswers on all the time? processAnswers => 1, #$submitAnswers ? 1 : 0, }, - $formFields ); - # handle any errors in translation + ##### store fields ##### + + $self->{cldb} = $cldb; + $self->{wwdb} = $wwdb; + $self->{authdb} = $authdb; + + $self->{user} = $user; + $self->{set} = $set; + $self->{problem} = $problem; + $self->{permissionLevel} = $permissionLevel; + + $self->{displayMode} = $displayMode; + $self->{redisplay} = $redisplay; + $self->{submitAnswers} = $submitAnswers; + $self->{previewAnswers} = $previewAnswers; + $self->{formFields} = $formFields; + + $self->{want} = \%want; + $self->{must} = \%must; + $self->{can} = \%can; + $self->{will} = \%will; + + $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->{r}->param("user"); + 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}, "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->{r}->param("user"); + + 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, @links); +} + +sub title { + my $self = shift; + my $setName = $self->{set}->id; + my $problemNumber = $self->{problem}->id; + + return "$setName : Problem $problemNumber"; +} + +sub body { + my $self = shift; + + # unpack some useful variables + 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}) { - # there was an error in translation - print - h2("Software Error"), - translationError($pg->{errors}, $pg->{body_text}); - - return ""; + return translationError($pg->{errors}, $pg->{body_text}); } ##### answer processing ##### @@ -158,20 +283,28 @@ $problem->last_answer($answerString); $wwdb->setProblem($problem); - # store score in DB if it makes sense + # store state in DB if it makes sense if ($will{recordAnswers}) { - # the grader makes a lot of decisions for us... - # all we have to do is update information from - # the 'state' hash in the $pg hash. $problem->attempted(1); $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); - } else { - print p("Your score was not recorded for some reason. ;)"); + # 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 + ); } } @@ -180,8 +313,13 @@ # attempt summary if ($submitAnswers or $will{showCorrectAnswers}) { # print this if user submitted answers OR requested correct answers - print attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, + print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, $pg->{flags}->{showPartialCorrectAnswers}); + } elsif ($previewAnswers) { + # print this if user previewed answers + print $self->attemptResults($pg, 1, 0, 0); + # don't show correctness + # don't show correct answers } # score summary @@ -197,67 +335,98 @@ $attemptsLeft = $problem->max_attempts - $attempts; $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; } - print p( - "You have attempted this problem $attempts $attemptsNoun.", br(), + 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." . br() + ? "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 hr(); + print CGI::hr(); # main form print - startform("POST", $r->uri), + CGI::startform("POST", $r->uri), $self->hidden_authen_fields, - p(i($pg->{result}->{msg})), - p($pg->{body_text}), - p(submit(-name=>"submitAnswers", -label=>"Submit Answers")), - viewOptions($displayMode, \%must, \%can, \%will), - endform(), - hr(); + $self->viewOptions, + CGI::p(CGI::i($pg->{result}->{msg})), + CGI::p($pg->{body_text}), + CGI::p( + CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"), + CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"), + ), + CGI::endform(); + + # warning output + if ($pg->{warnings} ne "") { + print CGI::hr(), warningOutput($pg->{warnings}); + } # debugging stuff - print - h2("debugging information"), - h3("form fields"), - ref2string($formFields), - h3("user object"), - ref2string($user), - h3("set object"), - ref2string($set), - h3("problem object"), - ref2string($problem), - h3("PG object"), - ref2string($pg, {'WeBWorK::PG::Translator' => 1}); + #print + # 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), + # CGI::h3("problem object"), + # ref2string($problem), + # CGI::h3("PG object"), + # ref2string($pg, {'WeBWorK::PG::Translator' => 1}); return ""; } ##### output utilities ##### +# this is used by ProblemSet.pm too, so don't fuck it up sub translationError($$) { my ($error, $details) = @_; return - p(<{result}; # the overall result of the problem my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; - my $header = th("answer"); - $header .= $showAttemptAnswers ? th("attempt") : ""; - $header .= $showCorrectAnswers ? th("correct") : ""; - $header .= $showAttemptResults ? th("result") : ""; - $header .= $showAttemptAnswers ? th("messages") : ""; + my $header = CGI::th("answer"); + $header .= $showAttemptAnswers ? CGI::th("attempt") : ""; + $header .= $showAttemptAnswers ? CGI::th("preview") : ""; + $header .= $showCorrectAnswers ? CGI::th("correct") : ""; + $header .= $showAttemptResults ? CGI::th("result") : ""; + $header .= $showAttemptAnswers ? 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 = $self->previewAnswer($answerResult); my $correctAnswer = $answerResult->{correct_ans}; my $answerScore = $answerResult->{score}; my $answerMessage = $showAttemptAnswers ? $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 + $name =~ s/^AnSwEr//; - my $row = td($name); - $row .= $showAttemptAnswers ? td($studentAnswer) : ""; - $row .= $showCorrectAnswers ? td($correctAnswer) : ""; - $row .= $showAttemptResults ? td($resultString) : ""; - $row .= $answerMessage ? td($answerMessage) : ""; + my $row = CGI::td($name); + $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : ""; + $row .= $showAttemptAnswers ? CGI::td($preview) : ""; + $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; + $row .= $showAttemptResults ? CGI::td($resultString) : ""; + $row .= $answerMessage ? CGI::td($answerMessage) : ""; push @tableRows, $row; } my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions"; my $scorePercent = int ($problemResult->{score} * 100) . "\%"; - #my $message = i($problemResult->{msg}); my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of " . scalar @answerNames . " correct, for a score of $scorePercent."; - #return table({-border=>1}, Tr(\@tableRows)) . p($message, br(), $summary); - return table({-border=>1}, Tr(\@tableRows)) . p($summary); + return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary); } -sub viewOptions($\%\%\%) { - my $displayMode = shift; - my %must = %{ shift() }; - my %can = %{ shift() }; - my %will = %{ shift() }; +sub viewOptions($) { + my $self = shift; + my $displayMode = $self->{displayMode}; + my %must = %{ $self->{must} }; + my %can = %{ $self->{can} }; + my %will = %{ $self->{will} }; my $optionLine; $can{showOldAnswers} and $optionLine .= join "", "Show:  ", - checkbox( + CGI::checkbox( -name => "showOldAnswers", -checked => $will{showOldAnswers}, -label => "Saved answers", ), "  "; $can{showCorrectAnswers} and $optionLine .= join "", - checkbox( + CGI::checkbox( -name => "showCorrectAnswers", -checked => $will{showCorrectAnswers}, -label => "Correct answers", ), "  "; $can{showHints} and $optionLine .= join "", - checkbox( + CGI::checkbox( -name => "showHints", -checked => $will{showHints}, -label => "Hints", ), "  "; $can{showSolutions} and $optionLine .= join "", - checkbox( + CGI::checkbox( -name => "showSolutions", -checked => $will{showSolutions}, -label => "Solutions", ), "  "; - $optionLine and $optionLine .= join "", br(); + $optionLine and $optionLine .= join "", CGI::br(); - return div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, + return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, "View equations as:  ", - radio_group( + CGI::radio_group( -name => "displayMode", -values => ['plainText', 'formattedText', 'images'], -default => $displayMode, @@ -344,12 +519,45 @@ formattedText => "formatted text", images => "images", } - ), br(), + ), CGI::br(), $optionLine, - submit(-name=>"redisplay", -label=>"Redisplay Problem"), + CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"), ); } +sub previewAnswer($$) { + my ($self, $answerResult) = @_; + my $ce = $self->{courseEnvironment}; + my $user = $self->{user}; + my $set = $self->{set}; + my $problem = $self->{problem}; + + # 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 $tex = $answerResult->{preview_latex_string}; + 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 @@ -374,8 +582,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($) {