--- trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2002/11/20 19:12:44 634 +++ trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm 2003/06/09 23:25:09 1096 @@ -4,26 +4,29 @@ ################################################################################ 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 base qw(WeBWorK::ContentGenerator); use CGI qw(); +use File::Path qw(rmtree); use File::Temp qw(tempdir); use WeBWorK::Form; use WeBWorK::PG; use WeBWorK::PG::IO; use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string); +use WeBWorK::DB::Utils qw(global2user user2global findDefaults); ############################################################ # # user +# effectiveUser # key # # displayMode @@ -36,47 +39,131 @@ # # 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 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); + + # obtain the effective user set, or if that is not yet defined obtain global set + my $set = $db->getMergedSet($effectiveUserName, $setName); + unless (defined $set) { + my $userSetClass = $courseEnv->{dbLayout}->{set_user}->{record}; + $set = global2user($userSetClass, $db->getGlobalSet($setName)); + $set->psvn('000'); + } + my $psvn = $set->psvn(); + + # obtain the effective user problem, or if that is not yet defined obtain global problem + my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber); + unless (defined $problem) { + my $userProblemClass = $courseEnv->{dbLayout}->{problem_user}->{record}; + $problem = global2user($userProblemClass, $db->getGlobalProblem($setName,$problemNumber)); + +# $problem->max_attempts(-1); # default is infinite number of attempts +# $problem->value; +# $problem->problem_seed; +# $problem->source_file; + $problem->user_id($userName); # is this the right value for this unassigned problem? FIXME + $problem->status(0); + $problem->attempted(0); + $problem->num_correct(0); + $problem->num_incorrect(0); + $problem->last_answer(' '); + } + #$problem = $db->getGlobalProblem($setName, $problemNumber) unless defined($problem); + # FIXME + # a better solution at this point would be to take set and problem, convert them to global_user type + # so that they have the right methods. + # Stuff the local copy of $set and $problem with default data where it won't have been defined + # Make sure that nothing bad is stored back in the database. + # It would be nice to store lastAnswer somewhere -- perhaps that could be done as a special case. + + + # This supplies a psvn if $set doesn't have it. Unfortunately the problem is called on to provide + # data in many places and it might not even have methods defined. + + # global sets will not have a defined psvn +# my $psvn; +# if ($set->can('psvn') ) { +# $psvn = $set->psvn(); +# } else { # we are viewing an unassigned problem set, psvn's are irrelevant +# $psvn = '0000'; +# } + + my $permissionLevel = $db->getPermissionLevel($userName)->permission(); + + $self->{userName} = $userName; + $self->{user} = $user; + $self->{effectiveUser} = $effectiveUser; + $self->{set} = $set; + $self->{problem} = $problem; + $self->{permissionLevel} = $permissionLevel; ##### 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) ) ? +# $override_problem_source : +# $problem->source_file; # 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? @@ -86,6 +173,7 @@ showHints => 0, showSolutions => 0, recordAnswers => mustRecordAnswers($permissionLevel), + checkAnswers => 0, ); # does the user have permission to use certain options? @@ -96,14 +184,14 @@ 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), ); # final values for options my %will; foreach (keys %must) { $will{$_} = $can{$_} && ($want{$_} || $must{$_}); - #warn "$_: can? $can{$_} want? $want{$_} must? $must{$_} will? $will{$_}\n"; } ##### sticky answers ##### @@ -118,38 +206,29 @@ my $pg = WeBWorK::PG->new( $courseEnv, - $user, - $r->param('key'), + $effectiveUser, + $key, $set, $problem, $psvn, $formFields, { # translation options displayMode => $displayMode, + override_seed => $override_seed, + override_problem_source =>$override_problem_source, 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 ##### + ##### fix hint/solution options ##### - $self->{cldb} = $cldb; - $self->{wwdb} = $wwdb; - $self->{authdb} = $authdb; - - $self->{user} = $user; - $self->{set} = $set; - $self->{problem} = $problem; - $self->{permissionLevel} = $permissionLevel; + $can{showHints} &&= $pg->{flags}->{hintExists}; + $can{showSolutions} &&= $pg->{flags}->{solutionExists}; - $self->{displayMode} = $displayMode; - $self->{redisplay} = $redisplay; - $self->{submitAnswers} = $submitAnswers; - $self->{previewAnswers} = $previewAnswers; - $self->{formFields} = $formFields; + ##### store fields ##### $self->{want} = \%want; $self->{must} = \%must; @@ -161,27 +240,29 @@ 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 head { my $self = shift; - + return "" unless $self->{isOpen}; 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 $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, @@ -194,57 +275,70 @@ 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 $effectiveUser = $self->{r}->param("effectiveUser"); 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(); + push @problems, $db->getMergedProblem($effectiveUser, $setName, $_) + foreach ($db->listUserProblems($effectiveUser, $setName)); + foreach my $problem (sort { $a->problem_id <=> $b->problem_id } @problems) { + print CGI::a({-href=>"$root/$courseName/$setName/".$problem->problem_id."/?" + . $self->url_authen_args . "&displayMode=" . $self->{displayMode}}, + "Problem ".$problem->problem_id), CGI::br(); } } sub nav { 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 - : ""; + my $wwdb = $self->{wwdb}; + my $effectiveUser = $self->{r}->param("effectiveUser"); + my $tail = "&displayMode=".$self->{displayMode}; + + my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList"); + + my $prevProblem = $db->getMergedProblem($effectiveUser, $setName, $problemNumber-1); + my $nextProblem = $db->getMergedProblem($effectiveUser, $setName, $problemNumber+1); + unshift @links, "Previous Problem" , ($prevProblem + ? "$root/$courseName/$setName/".$prevProblem->problem_id + : "") , "navPrev"; + push @links, "Next Problem" , ($nextProblem + ? "$root/$courseName/$setName/".$nextProblem->problem_id + : "") , "navNext"; - return $self->navMacro($args, @links); + return $self->navMacro($args, $tail, @links); } sub title { my $self = shift; - my $setName = $self->{set}->id; - my $problemNumber = $self->{problem}->id; + my $setName = $self->{set}->set_id; + + my $file_action; + my $edit_mode = $self->{edit_mode}; + if ( not defined($edit_mode) ) { + $file_action = ''; + } elsif ( $edit_mode eq 'temporaryFile') { + $file_action .= 'Editing temporary file : '. CGI::br() . $self->{problem_source_name}; + } elsif ( $edit_mode eq 'savedFile' ){ + $file_action .= 'Problem saved to : '. CGI::br() . $self->{problem_source_name}; + } + my $problemNumber = $self->{problem}->problem_id . " : " . $file_action; return "$setName : Problem $problemNumber"; } @@ -252,27 +346,37 @@ sub body { my $self = shift; + 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 $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 ##### # if answers were submitted: if ($submitAnswers) { + # 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); # store answers in DB for sticky answers my %answersToStore; my %answerHash = %{ $pg->{answers} }; @@ -280,52 +384,126 @@ foreach (keys %answerHash); my $answerString = encodeAnswers(%answersToStore, @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} }); + $problem->last_answer($answerString); - $wwdb->setProblem($problem); + # if $pureProblem is defined ( there is a user ) then record the last answer. + # FIXME (we're assuming that not being able to get a pure problem is enough to determine + # whether or not the problem database needs to be updated. This should be thought through + # more carefully to be sure. + if ( defined($pureProblem) ) { + $pureProblem->last_answer($answerString); + $db->putUserProblem($pureProblem); + #die "pureProblem = ", defined($pureProblem); + - # 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); - # 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 - ); + # 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}); + $db->putUserProblem($pureProblem); + # 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 + ); + } } } + # logging student answers + my $pastAnswerLog = undef; + if (defined( $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'} )) { + + $pastAnswerLog = $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'}; + + if ($submitAnswers and defined($pastAnswerLog) ) { + 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. + writeLog($self->{ce}, "pastAnswerList", + '|'.$problem->user_id. + '|'.$problem->set_id. + '|'.$problem->problem_id.'|'."\t". + time()."\t". + $answerString, + + ); + + } - ##### output ##### + } + # end logging student answers + ##### output ##### + print CGI::start_div({class=>"problemHeader"}); # attempt summary if ($submitAnswers or $will{showCorrectAnswers}) { # print this if user submitted answers OR requested correct answers - print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers}, - $pg->{flags}->{showPartialCorrectAnswers}); + print $self->attemptResults($pg, $submitAnswers, + $will{showCorrectAnswers}, + $pg->{flags}->{showPartialCorrectAnswers}, 1, 1); + } elsif ($checkAnswers) { + # print this if user previewed answers + print $self->attemptResults($pg, 1, 0, 1, 1, 1); + # show attempt answers + # don't show correct answers + # show attempt results (correctness) + # don't show attempt previews } elsif ($previewAnswers) { # print this if user previewed answers - print $self->attemptResults($pg, 1, 0, 0); - # don't show correctness + print $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"}); + #print CGI::hr(); + # 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{recordAnswers} + ? CGI::submit(-name=>"submitAnswers", + -label=>"Submit Answers") + : ""), + ($can{checkAnswers} + ? CGI::submit(-name=>"checkAnswers", + -label=>"Check Answers") + : ""), + CGI::submit(-name=>"previewAnswers", + -label=>"Preview 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 @@ -335,8 +513,11 @@ $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."; @@ -349,128 +530,172 @@ $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(); +# print CGI::hr(), CGI::start_div({class=>"viewOptions"}); +# print $self->viewOptions(),CGI::end_div(), +# save state for viewOptions + print CGI::hidden(-name => "showOldAnswers", + -value => $will{showOldAnswers}, + ), + CGI::hidden(-name => "showCorrectAnswers", + -value => $will{showCorrectAnswers}, + ), + CGI::hidden(-name => "showHints", + -value => $will{showHints}, + ), + CGI::hidden(-name => "showSolutions", + -value => $will{showSolutions}, + ), + CGI::hidden(-name => "displayMode", + -value => $self->{displayMode} + ); + print CGI::endform(); + + print CGI::start_div({class=>"problemFooter"}); + # feedback form + my $ce = $self->{ce}; + my $root = $ce->{webworkURLs}->{root}; + my $courseName = $ce->{courseName}; + my $feedbackURL = "$root/$courseName/feedback/"; - print CGI::hr(); + # arguments for answer inspection button + my $prof_url = $ce->{webworkURLs}->{oldProf}; + my $cgi_url = $prof_url; + $cgi_url=~ s|/[^/]*$||; # clip profLogin.pl + my $authen_args = $self->url_authen_args(); + my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl"; + + + print CGI::end_div(); + print CGI::start_div(); + # 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 => 'probNum', -value=>$problem->problem_id), "\n", + CGI::hidden(-name => 'setNum', -value=>$problem->set_id), "\n", + CGI::hidden(-name => 'User', -value=>$problem->user_id), "\n", + CGI::p( {-align=>"left"}, + CGI::submit(-name => 'action', -value=>'Show Past Answers') + ), "\n", + CGI::endform(); + + + + } #print feedback form + - # main 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::submit(-name=>"previewAnswers", -label=>"Preview Answers"), + 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=>"Contact instructor") ), - CGI::endform(); + 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(); + + # end answer inspection button # warning output if ($pg->{warnings} ne "") { - print CGI::hr(), warningOutput($pg->{warnings}); + print CGI::hr(), $self->warningOutput($pg->{warnings}); } # debugging stuff - #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}); + 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(<{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 .= $showAttemptAnswers ? CGI::th("preview") : ""; - $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 $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 = $self->previewAnswer($answerResult); + 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"; # get rid of the goofy prefix on the answer names (supposedly, the format - # of the answer names is changeable. this only fixes + # 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 .= $showAttemptAnswers ? CGI::td($preview) : ""; + $row .= $showAttemptPreview ? 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 $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); + my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions"; + my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100); + my $summary = "On this attempt, you answered $numCorrect out of " + . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent."; + return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p($summary) : ""); } sub viewOptions($) { @@ -482,82 +707,127 @@ my $optionLine; $can{showOldAnswers} and $optionLine .= join "", - "Show:  ", + "Show:  ".CGI::br(), CGI::checkbox( -name => "showOldAnswers", -checked => $will{showOldAnswers}, -label => "Saved answers", - ), "  "; + ), "  ".CGI::br(); $can{showCorrectAnswers} and $optionLine .= join "", CGI::checkbox( -name => "showCorrectAnswers", -checked => $will{showCorrectAnswers}, -label => "Correct answers", - ), "  "; + ), "  ".CGI::br(); $can{showHints} and $optionLine .= join "", CGI::checkbox( -name => "showHints", -checked => $will{showHints}, -label => "Hints", - ), "  "; + ), "  ".CGI::br(); $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) = @_; - 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 $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}; - 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]"; + + return "" if $tex eq ""; + + 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 = 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); + rmtree($wd, 0, 0); + if (-e $targetPath) { + return "\"$tex\""; + } else { + return "[math2img failed]"; + } } } +sub options { + my $self=shift; + my $out; + $out .=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() + ); +return $out; + +} +##### logging subroutine #### + + + ##### permission queries ##### # this stuff should be abstracted out into the permissions system @@ -587,6 +857,14 @@ return $recordAnswers; } +sub canCheckAnswers($$) { + my ($permissionLevel, $answerDate) = @_; + my $permHigh = $permissionLevel > 0; + my $timeOK = time >= $answerDate; + my $recordAnswers = $permHigh || $timeOK; + return $recordAnswers; +} + sub mustRecordAnswers($) { my ($permissionLevel) = @_; return $permissionLevel == 0;