--- trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2002/09/20 22:47:22 558 +++ trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2003/09/25 02:03:43 1530 @@ -4,24 +4,30 @@ ################################################################################ package WeBWorK::ContentGenerator::Problem; +use base qw(WeBWorK::ContentGenerator); =head1 NAME - + WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem. =cut - +my $timer0_ON=0; # times pg translation phase use strict; use warnings; -use base qw(WeBWorK::ContentGenerator); use CGI qw(); +use File::Path qw(rmtree); use WeBWorK::Form; use WeBWorK::PG; -use WeBWorK::Utils qw(ref2string encodeAnswers decodeAnswers); +use WeBWorK::PG::ImageGenerator; +use WeBWorK::PG::IO; +use WeBWorK::Utils qw(writeLog writeCourseLog encodeAnswers decodeAnswers ref2string makeTempDirectory); +use WeBWorK::DB::Utils qw(global2user user2global findDefaults); +use WeBWorK::Timing; ############################################################ # # user +# effectiveUser # key # # displayMode @@ -34,46 +40,154 @@ # # redisplay - name of the "Redisplay Problem" button # submitAnswers - name of "Submit Answers" button +# checkAnswers - name of the "Check Answers" button +# previewAnswers - name of the "Preview Answers" button # ############################################################ +sub templateName { + "problem"; +} + sub pre_header_initialize { my ($self, $setName, $problemNumber) = @_; - my $courseEnv = $self->{courseEnvironment}; - my $r = $self->{r}; - my $userName = $r->param('user'); - - ##### database setup ##### - - 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); + my $r = $self->{r}; + my $courseEnv = $self->{ce}; + my $db = $self->{db}; + my $userName = $r->param('user'); + my $effectiveUserName = $r->param('effectiveUser'); + my $key = $r->param('key'); + my $user = $db->getUser($userName); + my $effectiveUser = $db->getUser($effectiveUserName); + my $permissionLevel = $db->getPermissionLevel($userName)->permission(); + + # obtain the merged set for $effectiveUser + my $set = $db->getMergedSet($effectiveUserName, $setName); + + # obtain the merged problem for $effectiveUser + my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); + + my $editMode = $r->param("editMode"); + + if ($permissionLevel > 0 and defined $editMode) { + # professors are allowed to fabricate sets and problems not + # assigned to them (or anyone). this allows them to use the + # editor to + + # if that is not yet defined obtain the global set, convert + # it to a user set, and add fake user data + unless (defined $set) { + my $userSetClass = $db->{set_user}->{record}; + $set = global2user($userSetClass, + $db->getGlobalSet($setName)); + die "Set $setName does not exist" + unless defined $set; + $set->psvn(0); + } + + # if that is not yet defined obtain the global problem, + # convert it to a user problem, and add fake user data + unless (defined $problem) { + my $userProblemClass = $db->{problem_user}->{record}; + $problem = global2user($userProblemClass, + $db->getGlobalProblem($setName,$problemNumber)); + die "Problem $problemNumber in set $setName does not exist" + unless defined $problem; + $problem->user_id($effectiveUserName); + $problem->problem_seed(0); + $problem->status(0); + $problem->attempted(0); + $problem->last_answer(""); + $problem->num_correct(0); + $problem->num_incorrect(0); + } + + # now we're sure we have valid UserSet and UserProblem objects + # yay! + + # now deal with possible editor overrides: + + # if the caller is asking to override the source file, and + # editMode calls for a temporary file, do so + my $sourceFilePath = $r->param("sourceFilePath"); + if (defined $sourceFilePath and $editMode eq "temporaryFile") { + $problem->source_file($sourceFilePath); + } + + # if the caller is asking to override the problem seed, do so + my $problemSeed = $r->param("problemSeed"); + if (defined $problemSeed) { + $problem->problem_seed($problemSeed); + } + } else { + # students can't view problems not assigned to them + die "Set $setName is not assigned to $effectiveUserName" + unless defined $set; + die "Problem $problemNumber in set $setName is not assigned to $effectiveUserName" + unless defined $problem; + } + + $self->{userName} = $userName; + $self->{effectiveUserName} = $effectiveUserName; + $self->{user} = $user; + $self->{effectiveUser} = $effectiveUser; + $self->{permissionLevel} = $permissionLevel; + $self->{set} = $set; + $self->{problem} = $problem; + $self->{editMode} = $editMode; ##### 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 $checkAnswers = $r->param("checkAnswers"); + my $previewAnswers = $r->param("previewAnswers"); + + # fields which may be defined when using Problem Editor + #my $override_seed = ($permissionLevel>=10) ? $r->param('problemSeed') : undef; + #my $override_problem_source = ($permissionLevel>=10) ? $r->param('sourceFilePath') : undef; + #my $editMode = undef; + #my $submit_button = $r->param('submit_button'); + #if ( defined($submit_button ) ) { + # $editMode = "temporaryFile" if $submit_button eq 'Refresh'; + # $editMode = 'savedFile' if $submit_button eq 'Save'; + #} + # + ##override using the source file data from the form field + #$problem->source_file($override_problem_source) if defined($override_problem_source); + #$problem->problem_seed($override_seed) if defined($override_seed); + # + ## store path to source file for title. + #$self->{problem_source_name} = $problem->source_file; + #$self->{edit_mode} = $editMode; + #$self->{current_problem_source} = (defined($override_problem_source) ) ? # coerce form fields into CGI::Vars format my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars }; + $self->{displayMode} = $displayMode; + $self->{redisplay} = $redisplay; + $self->{submitAnswers} = $submitAnswers; + $self->{checkAnswers} = $checkAnswers; + $self->{previewAnswers} = $previewAnswers; + $self->{formFields} = $formFields; + ##### permissions ##### + # are we allowed to view this problem? + $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0; + return unless $self->{isOpen}; + # 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}, showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints}, showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions}, - recordAnswers => $r->param("recordAnswers") || 1, + recordAnswers => $submitAnswers, + checkAnswers => $checkAnswers, ); # are certain options enforced? @@ -83,6 +197,7 @@ showHints => 0, showSolutions => 0, recordAnswers => mustRecordAnswers($permissionLevel), + checkAnswers => 0, ); # does the user have permission to use certain options? @@ -93,58 +208,72 @@ showSolutions => canShowSolutions($permissionLevel, $set->answer_date), recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date, $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1), - # num_correct+num_incorrect+1 -- as this happens before updating $problem + # attempts=num_correct+num_incorrect+1, as this happens before updating $problem + checkAnswers => canCheckAnswers($permissionLevel, $set->answer_date), ); - + ######################################################### + # more complicated logic for showing check answer button: + ######################################################### + # checkAnswers button shows up after due date -- once a student can't record anymore + # checkAnswers button always shows up when an instructor or TA is acting + # as someone else (the $user and $effectiveUserName aren't the same). + $can{checkAnswers} = ($can{checkAnswers} && not $can{recordAnswers} ) || + ( defined($userName) and defined($effectiveUserName) and + ($userName ne $effectiveUserName) + ); + ######################################################### + # more complicated logif for showing "submit answer" button + ######################################################### + # We hide the submit answer button if someone is acting as a student + # This prevents errors where you accidently submit the answer for a student + # Not sure whether this a feature or a bug + + $can{recordAnswers} = ($can{recordAnswers} and not + ( defined($userName) and defined($effectiveUserName) and + ($userName ne $effectiveUserName) + ) + ); # final values for options my %will; - foreach(keys %must) { + foreach (keys %must) { $will{$_} = $can{$_} && ($want{$_} || $must{$_}); } ##### sticky answers ##### - if (not $submitAnswers and $will{showOldAnswers}) { + if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) { # do this only if new answers are NOT being submitted my %oldAnswers = decodeAnswers($problem->last_answer); $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers; } ##### translation ##### - + + $WeBWorK::timer0->continue("begin pg processing") if $timer0_ON; my $pg = WeBWorK::PG->new( $courseEnv, - $user, - $r->param('key'), + $effectiveUser, + $key, $set, $problem, - $psvn, + $set->psvn, # FIXME: this field should be removed $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, }, ); - ##### store fields ##### + $WeBWorK::timer0->continue("end pg processing") if $timer0_ON; + ##### fix hint/solution options ##### + + $can{showHints} &&= $pg->{flags}->{hintExists}; + $can{showSolutions} &&= $pg->{flags}->{solutionExists}; - $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->{formFields} = $formFields; + ##### store fields ##### $self->{want} = \%want; $self->{must} = \%must; @@ -154,29 +283,44 @@ $self->{pg} = $pg; } -sub if_warnings($$) { - my ($self, $arg) = @_; - return $self->{pg}->{warnings} ne ""; -} +#sub if_warnings($$) { +# my ($self, $arg) = @_; +# return 0 unless $self->{isOpen}; +# return $self->{pg}->{warnings} ne ""; +#} sub if_errors($$) { my ($self, $arg) = @_; + return 0 unless $self->{isOpen}; return $self->{pg}->{flags}->{error_flag}; } -sub header { +sub head { my $self = shift; - + return "" unless $self->{isOpen}; return $self->{pg}->{head_text} if $self->{pg}->{head_text}; } +sub options { + my $self = shift; + return join("", + CGI::start_form("POST", $self->{r}->uri), + $self->hidden_authen_fields, + CGI::hr(), + CGI::start_div({class=>"viewOptions"}), + $self->viewOptions(), + CGI::end_div(), + CGI::end_form() + ); +} + sub path { my $self = shift; my $args = $_[-1]; - my $setName = $self->{set}->id; - my $problemNumber = $self->{problem}->id; + my $setName = $self->{set}->set_id; + my $problemNumber = $self->{problem}->problem_id; - my $ce = $self->{courseEnvironment}; + my $ce = $self->{ce}; my $root = $ce->{webworkURLs}->{root}; my $courseName = $ce->{courseName}; return $self->pathMacro($args, @@ -189,57 +333,68 @@ sub siblings { my $self = shift; - my $setName = $self->{set}->id; - my $problemNumber = $self->{problem}->id; + my $setName = $self->{set}->set_id; + my $problemNumber = $self->{problem}->problem_id; - my $ce = $self->{courseEnvironment}; + my $ce = $self->{ce}; + my $db = $self->{db}; 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(); + my $effectiveUser = $self->{r}->param("effectiveUser"); + my @problemIDs = $db->listUserProblems($effectiveUser, $setName); + foreach my $problem (sort { $a <=> $b } @problemIDs) { + print '  '.CGI::a({-href=>"$root/$courseName/$setName/".$problem."/?" + . $self->url_authen_args . "&displayMode=" . $self->{displayMode}}, + "Problem ".$problem), CGI::br(); } + + return ""; } sub nav { + $WeBWorK::timer0->continue("begin nav subroutine") if $timer0_ON; my $self = shift; my $args = $_[-1]; - my $setName = $self->{set}->id; - my $problemNumber = $self->{problem}->id; + my $setName = $self->{set}->set_id; + my $problemNumber = $self->{problem}->problem_id; - my $ce = $self->{courseEnvironment}; + my $ce = $self->{ce}; + my $db = $self->{db}; 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); + my $wwdb = $self->{wwdb}; + my $effectiveUser = $self->{r}->param("effectiveUser"); + my $tail = "&displayMode=".$self->{displayMode}; + + my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList"); + + my @problemIDs = $db->listUserProblems($effectiveUser, $setName); + my ($prevID, $nextID); + foreach my $id (@problemIDs) { + $prevID = $id if $id < $problemNumber + and (not defined $prevID or $id > $prevID); + $nextID = $id if $id > $problemNumber + and (not defined $nextID or $id < $nextID); + } + unshift @links, "Previous Problem" , ($prevID + ? "$root/$courseName/$setName/".$prevID + : "") , "navPrev"; + push @links, "Next Problem" , ($nextID + ? "$root/$courseName/$setName/".$nextID + : "") , "navNext"; + + my $result = $self->navMacro($args, $tail, @links); + $WeBWorK::timer0->continue("end nav subroutine") if $timer0_ON; + return $result; } sub title { my $self = shift; - my $setName = $self->{set}->id; - my $problemNumber = $self->{problem}->id; + my $setName = $self->{set}->set_id; + my $problemNumber = $self->{problem}->problem_id; return "$setName : Problem $problemNumber"; } @@ -247,61 +402,221 @@ sub body { my $self = shift; - #$self->prepare(@_); + return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open.")) + unless $self->{isOpen}; # unpack some useful variables my $r = $self->{r}; - my $wwdb = $self->{wwdb}; + my $db = $self->{db}; my $set = $self->{set}; my $problem = $self->{problem}; + my $editMode = $self->{editMode}; my $permissionLevel = $self->{permissionLevel}; my $submitAnswers = $self->{submitAnswers}; + my $checkAnswers = $self->{checkAnswers}; + my $previewAnswers = $self->{previewAnswers}; + my %want = %{ $self->{want} }; + my %can = %{ $self->{can} }; + my %must = %{ $self->{must} }; my %will = %{ $self->{will} }; my $pg = $self->{pg}; ##### translation errors? ##### if ($pg->{flags}->{error_flag}) { - return translationError($pg->{errors}, $pg->{body_text}); + return $self->errorOutput($pg->{errors}, $pg->{body_text}); } ##### answer processing ##### - + $WeBWorK::timer0->continue("begin answer processing") if $timer0_ON; # if answers were submitted: + my $scoreRecordedMessage; if ($submitAnswers) { - # store answers in DB for sticky answers - my %answersToStore; - my %answerHash = %{ $pg->{answers} }; - $answersToStore{$_} = $answerHash{$_}->{original_student_ans} - foreach (keys %answerHash); - my $answerString = encodeAnswers(%answersToStore, - @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); - $problem->last_answer($answerString); - $wwdb->setProblem($problem); - - # store state in DB if it makes sense - if ($will{recordAnswers}) { - $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}); - $wwdb->setProblem($problem); + # get a "pure" (unmerged) UserProblem to modify + # this will be undefined if the problem has not been assigned to this user + my $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id); + if (defined $pureProblem) { + # store answers in DB for sticky answers + my %answersToStore; + my %answerHash = %{ $pg->{answers} }; + $answersToStore{$_} = $answerHash{$_}->{original_student_ans} + foreach (keys %answerHash); + # There may be some more answers to store -- one which are auxiliary entries to a primary answer. Evaluating + # matrices works in this way, only the first answer triggers an answer evaluator, the rest are just inputs + # however we need to store them. Fortunately they are still in the input form. + my @extra_answer_names = @{ $pg->{flags}->{KEPT_EXTRA_ANSWERS}}; + + $answersToStore{$_} = $r->param($_) foreach (@extra_answer_names); + + # Now let's encode these answers to store them -- append the extra answers to the end of answer entry order + my @answer_order = (@{$pg->{flags}->{ANSWER_ENTRY_ORDER}}, @extra_answer_names); + my $answerString = encodeAnswers(%answersToStore, + @answer_order); + + # store last answer to database + $problem->last_answer($answerString); + $pureProblem->last_answer($answerString); + $db->putUserProblem($pureProblem); + + # store state in DB if it makes sense + if ($will{recordAnswers}) { + $problem->status($pg->{state}->{recorded_score}); + $problem->attempted(1); + $problem->num_correct($pg->{state}->{num_of_correct_ans}); + $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); + $pureProblem->status($pg->{state}->{recorded_score}); + $pureProblem->attempted(1); + $pureProblem->num_correct($pg->{state}->{num_of_correct_ans}); + $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans}); + if ($db->putUserProblem($pureProblem)) { + $scoreRecordedMessage = "Your score was recorded."; + } else { + $scoreRecordedMessage = "Your score was not recorded because there was a failure in storing the problem record to the database."; + } + # write to the transaction log, just to make sure + writeLog($self->{ce}, "transaction", + $problem->problem_id."\t". + $problem->set_id."\t". + $problem->user_id."\t". + $problem->source_file."\t". + $problem->value."\t". + $problem->max_attempts."\t". + $problem->problem_seed."\t". + $pureProblem->status."\t". + $pureProblem->attempted."\t". + $pureProblem->last_answer."\t". + $pureProblem->num_correct."\t". + $pureProblem->num_incorrect + ); + } else { + if (time < $set->open_date or time > $set->due_date) { + $scoreRecordedMessage = "Your score was not recorded because this problem set is closed."; + } else { + $scoreRecordedMessage = "Your score was not recorded."; + } + } + } else { + $scoreRecordedMessage = "Your score was not recorded because this problem has not been built for you."; + } + } + + # logging student answers + + my $answer_log = $self->{ce}->{courseFiles}->{logs}->{'answer_log'}; + if ( defined($answer_log )) { + if ($submitAnswers ) { + my $answerString = ""; + my %answerHash = %{ $pg->{answers} }; + $answerString = $answerString . $answerHash{$_}->{original_student_ans}."\t" + foreach (sort keys %answerHash); + $answerString = '' unless defined($answerString); # insure string is defined. + writeCourseLog($self->{ce}, "answer_log", + join("", + '|', $problem->user_id, + '|', $problem->set_id, + '|', $problem->problem_id, + '|',"\t", + time(),"\t", + $answerString, + ), + ); + } } + $WeBWorK::timer0->continue("end answer processing") if $timer0_ON; + ##### output ##### + print CGI::start_div({class=>"problemHeader"}); + + # custom message for editor + if ($permissionLevel >= 10 and defined $editMode) { + if ($editMode eq "temporaryFile") { + print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file)); + } elsif ($editMode eq "savedFile") { + print CGI::p(CGI::i("Problem saved to: ", $problem->source_file)); + } + } + # attempt summary - if ($submitAnswers or $will{showCorrectAnswers}) { + #FIXME -- the following is a kludge: if showPartialCorrectAnswers is negative don't show anything. + # until after the due date + # do I need to check $wills{howCorrectAnswers} to make preflight work?? + if (($pg->{flags}->{showPartialCorrectAnswers}>= 0 and $submitAnswers) ) { # print this if user submitted answers OR requested correct answers - print attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, - $pg->{flags}->{showPartialCorrectAnswers}); + + print $self->attemptResults($pg, 1, + $will{showCorrectAnswers}, + $pg->{flags}->{showPartialCorrectAnswers}, 1, 1); + } elsif ($checkAnswers) { + # print this if user previewed answers + print "ANSWERS ONLY CHECKED -- ",CGI::br(),"ANSWERS NOT RECORDED", CGI::br(); + print $self->attemptResults($pg, 1, $will{showCorrectAnswers}, 1, 1, 1); + # show attempt answers + # show correct answers if asked + # show attempt results (correctness) + # show attempt previews + } elsif ($previewAnswers) { + # print this if user previewed answers + print "PREVIEW ONLY -- NOT RECORDED",CGI::br(),$self->attemptResults($pg, 1, 0, 0, 0, 1); + # show attempt answers + # don't show correct answers + # don't show attempt results (correctness) + # show attempt previews } + print CGI::end_div(); + + print CGI::start_div({class=>"problem"}); + + # main form + print + CGI::startform("POST", $r->uri), + $self->hidden_authen_fields, + CGI::p($pg->{body_text}), + CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})), + CGI::p( + ($can{showCorrectAnswers} + ? CGI::checkbox( + -name => "showCorrectAnswers", + -checked => $will{showCorrectAnswers}, + -label => "Show correct answers", + ) ." " + : "" ), + ($can{showHints} + ? CGI::checkbox( + -name => "showHints", + -checked => $will{showHints}, + -label => "Show Hints", + ) . " " + : " " ), + ($can{showSolutions} + ? CGI::checkbox( + -name => "showSolutions", + -checked => $will{showSolutions}, + -label => "Show Solutions", + ) . " " + : " " ),CGI::br(), + CGI::submit(-name=>"previewAnswers", + -label=>"Preview Answers"), + ($can{recordAnswers} + ? CGI::submit(-name=>"submitAnswers", + -label=>"Submit Answers") + : ""), + ( $can{checkAnswers} + ? CGI::submit(-name=>"checkAnswers", + -label=>"Check Answers") + : ""), + ); + print CGI::end_div(); + + print CGI::start_div({class=>"scoreSummary"}); + # score summary my $attempts = $problem->num_correct + $problem->num_incorrect; my $attemptsNoun = $attempts != 1 ? "times" : "time"; - my $lastScore = int ($problem->status * 100) . "%"; + my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number my ($attemptsLeft, $attemptsLeftNoun); if ($problem->max_attempts == -1) { # unlimited attempts @@ -311,144 +626,227 @@ $attemptsLeft = $problem->max_attempts - $attempts; $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts"; } + + my $setClosed = 0; my $setClosedMessage; if (time < $set->open_date or time > $set->due_date) { + $setClosed = 1; $setClosedMessage = "This problem set is closed."; if ($permissionLevel > 0) { - $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded."; + $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded."; } else { $setClosedMessage .= " Additional attempts will not be recorded."; } } print CGI::p( + $submitAnswers ? $scoreRecordedMessage . CGI::br() : "", "You have attempted this problem $attempts $attemptsNoun.", CGI::br(), $problem->attempted ? "Your recorded score is $lastScore." . CGI::br() : "", - "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(), - $setClosedMessage, + $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining." ); + print CGI::end_div(); + + # save state for viewOptions + print CGI::hidden( + -name => "showOldAnswers", + -value => $will{showOldAnswers} + ), + + CGI::hidden( + -name => "displayMode", + -value => $self->{displayMode} + ); - # 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... + # end of main form + print CGI::endform(); - print CGI::hr(); + # stuff we need below (pull these out at the beginning?) + my $ce = $self->{ce}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; - # main form + print CGI::start_div({class=>"problemFooter"}); + + # arguments for answer inspection button + my $prof_url = $ce->{webworkURLs}->{oldProf}; + my $webworkURL = $ce->{webworkURLs}->{root}; + my $cgi_url = $prof_url; + $cgi_url=~ s|/[^/]*$||; # clip profLogin.pl + my $authen_args = $self->url_authen_args(); + my $showPastAnswersURL = "$webworkURL/$courseName/instructor/show_answers/"; + + # print answer inspection button + if ($self->{permissionLevel} > 0) { + print "\n", + CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n", + $self->hidden_authen_fields,"\n", + CGI::hidden(-name => 'course', -value=>$courseName), "\n", + CGI::hidden(-name => 'problemNumber', -value=>$problem->problem_id), "\n", + CGI::hidden(-name => 'setName', -value=>$problem->set_id), "\n", + CGI::hidden(-name => 'studentUser', -value=>$problem->user_id), "\n", + CGI::p( {-align=>"left"}, + CGI::submit(-name => 'action', -value=>'Show Past Answers') + ), "\n", + CGI::endform(); + } + + #print CGI::end_div(); + # + #print CGI::start_div(); + + # arguments for feedback form + my $feedbackURL = "$root/$courseName/feedback/"; + + #print feedback form print - CGI::startform("POST", $r->uri), - $self->hidden_authen_fields, - $self->viewOptions, - CGI::p(CGI::i($pg->{result}->{msg})), - CGI::p($pg->{body_text}), - CGI::p(CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers")), - CGI::endform(); + CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n", + $self->hidden_authen_fields,"\n", + CGI::hidden("module", __PACKAGE__),"\n", + CGI::hidden("set", $set->set_id),"\n", + CGI::hidden("problem", $problem->problem_id),"\n", + CGI::hidden("displayMode", $self->{displayMode}),"\n", + CGI::hidden("showOldAnswers", $will{showOldAnswers}),"\n", + CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n", + CGI::hidden("showHints", $will{showHints}),"\n", + CGI::hidden("showSolutions", $will{showSolutions}),"\n", + CGI::p({-align=>"left"}, + CGI::submit(-name=>"feedbackForm", -label=>"Email instructor") + ), + CGI::endform(),"\n"; + + # FIXME print editor link + # print editor link if the user is an instructor AND the file is not in temporary editing mode + if ($self->{permissionLevel}>=10 and ( (not defined($self->{edit_mode})) or $self->{edit_mode} eq 'savedFile') ) { + print CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".$set->set_id. + '/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem'); + } + + print CGI::end_div(); # warning output - if ($pg->{warnings} ne "") { - print CGI::hr(), warningOutput($pg->{warnings}); - } + #if ($pg->{warnings} ne "") { + # print CGI::hr(), $self->warningOutput($pg->{warnings}); + #} # debugging stuff - #print - # hr(), - # 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}); + if (0) { + 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 - CGI::h2("Software Error"), - CGI::p(<{ce}; my $problemResult = $pg->{result}; # the overall result of the problem my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }; - my $header = CGI::th("answer"); - $header .= $showAttemptAnswers ? CGI::th("attempt") : ""; - $header .= $showCorrectAnswers ? CGI::th("correct") : ""; - $header .= $showAttemptResults ? CGI::th("result") : ""; - $header .= $showAttemptAnswers ? CGI::th("messages") : ""; + my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames; + + my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview"; + my $imgGen = WeBWorK::PG::ImageGenerator->new( + tempDir => $ce->{webworkDirs}->{tmp}, + latex => $ce->{externalPrograms}->{latex}, + dvipng => $ce->{externalPrograms}->{dvipng}, + useCache => 1, + cacheDir => $ce->{webworkDirs}->{equationCache}, + cacheURL => $ce->{webworkURLs}->{equationCache}, + cacheDB => $ce->{webworkFiles}->{equationCacheDB}, + ); + + my $header; + #$header .= CGI::th("Part"); + $header .= $showAttemptAnswers ? CGI::th("Entered") : ""; + $header .= $showAttemptPreview ? CGI::th("Answer Preview") : ""; + $header .= $showCorrectAnswers ? CGI::th("Correct") : ""; + $header .= $showAttemptResults ? CGI::th("Result") : ""; + $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, $imgGen) + : ""); my $correctAnswer = $answerResult->{correct_ans}; my $answerScore = $answerResult->{score}; - my $answerMessage = $showAttemptAnswers ? $answerResult->{ans_message} : ""; - + my $answerMessage = $showMessages ? $answerResult->{ans_message} : ""; + #FIXME --Can we be sure that $answerScore is an integer-- could the problem give partial credit? $numCorrect += $answerScore > 0; 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//; + # 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 .= $showCorrectAnswers ? CGI::td($correctAnswer) : ""; - $row .= $showAttemptResults ? CGI::td($resultString) : ""; - $row .= $answerMessage ? CGI::td($answerMessage) : ""; + my $row; + #$row .= CGI::td($name); + $row .= $showAttemptAnswers ? CGI::td(nbsp($studentAnswer)) : ""; + $row .= $showAttemptPreview ? CGI::td(nbsp($preview)) : ""; + $row .= $showCorrectAnswers ? CGI::td(nbsp($correctAnswer)) : ""; + $row .= $showAttemptResults ? CGI::td(nbsp($resultString)) : ""; + $row .= $answerMessage ? CGI::td(nbsp($answerMessage)) : ""; push @tableRows, $row; } - my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions"; - 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); + # render equation images + $imgGen->render(refresh => 1); + +# my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions"; + my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100); +# FIXME -- I left the old code in in case we have to back out. +# my $summary = "On this attempt, you answered $numCorrect out of " +# . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent."; + my $summary = ""; + if (scalar @answerNames == 1) { + if ($numCorrect == scalar @answerNames) { + $summary .= "The above answer is correct."; + } else { + $summary .= "The above answer is NOT correct."; + } + } else { + if ($numCorrect == scalar @answerNames) { + $summary .= "All of the above answers are correct."; + } else { + $summary .= "At least one of the above answers is NOT correct."; + } + } + #FIXME there must be a better way to force refresh. + my $refresh_warning = 'Hold down shift and click "refresh" or "reload" to update answer preview images.'; + return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . + CGI::div({style=>'color:red; font-size:10pt'},$refresh_warning) . + ($showSummary ? CGI::p({class=>'emphasis'},$summary) : ""); +} +sub nbsp { + my $str = shift; + ($str =~/\S/) ? $str : ' ' ; # returns non-breaking space for empty strings + # tricky cases: $str =0; + # $str is a complex number } - sub viewOptions($) { my $self = shift; my $displayMode = $self->{displayMode}; @@ -458,49 +856,98 @@ my $optionLine; $can{showOldAnswers} and $optionLine .= join "", - "Show:  ", + "Show:  ".CGI::br(), CGI::checkbox( -name => "showOldAnswers", -checked => $will{showOldAnswers}, -label => "Saved answers", - ), "  "; - $can{showCorrectAnswers} and $optionLine .= join "", - CGI::checkbox( - -name => "showCorrectAnswers", - -checked => $will{showCorrectAnswers}, - -label => "Correct answers", - ), "  "; - $can{showHints} and $optionLine .= join "", - CGI::checkbox( - -name => "showHints", - -checked => $will{showHints}, - -label => "Hints", - ), "  "; - $can{showSolutions} and $optionLine .= join "", - CGI::checkbox( - -name => "showSolutions", - -checked => $will{showSolutions}, - -label => "Solutions", - ), "  "; + ), "  ".CGI::br(); + $optionLine and $optionLine .= join "", CGI::br(); - return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"}, - "View equations as:  ", + return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"}, + "View equations as:    ".CGI::br(), CGI::radio_group( -name => "displayMode", -values => ['plainText', 'formattedText', 'images'], -default => $displayMode, + -linebreak=>'true', -labels => { - plainText => "plain text", - formattedText => "formatted text", + plainText => "plain", + formattedText => "formatted", images => "images", } - ), CGI::br(), + ), CGI::br(),CGI::hr(), $optionLine, - CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"), + CGI::submit(-name=>"redisplay", -label=>"Save Options"), ); } +sub previewAnswer($$) { + my ($self, $answerResult, $imgGen) = @_; + my $ce = $self->{ce}; + my $effectiveUser = $self->{effectiveUser}; + 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}; + + return "" unless defined $tex and $tex ne ""; + + 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 = "/m2i/" + # . $effectiveUser->user_id . "." + # . $set->set_id . "." + # . $problem->problem_id . "." + # . $answerResult->{ans_name} . ".png"; + # + ## figure out where to put things + #my $wd = makeTempDirectory($ce->{courseDirs}->{html_temp}, "webwork-dvipng"); + #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); + #rmtree($wd, 0, 0); + #if (-e $targetPath) { + # return "\"$tex\""; + #} else { + # return "[math2img failed]"; + #} + $imgGen->add($answerResult->{preview_latex_string}); + + } +} + +##### logging subroutine #### + + + ##### permission queries ##### # this stuff should be abstracted out into the permissions system @@ -525,8 +972,17 @@ 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 canCheckAnswers($$) { + my ($permissionLevel, $answerDate) = @_; + my $permHigh = $permissionLevel > 0; + my $timeOK = time >= $answerDate; + my $recordAnswers = $permHigh || $timeOK; + return $recordAnswers; } sub mustRecordAnswers($) {