[system] / branches / ghe3_dev / webwork2 / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

View of /branches/ghe3_dev/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 919 - (download) (as text) (annotate)
Wed May 28 00:24:27 2003 UTC (9 years, 11 months ago) by sh002i
Original Path: trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm
File size: 24092 byte(s)
changed ->id to ->whatever_id
-sam

    1 ################################################################################
    2 # WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
    3 # $Id$
    4 ################################################################################
    5 
    6 package WeBWorK::ContentGenerator::Problem;
    7 use base qw(WeBWorK::ContentGenerator);
    8 
    9 =head1 NAME
   10 
   11 WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
   12 
   13 =cut
   14 
   15 use strict;
   16 use warnings;
   17 use CGI qw();
   18 use File::Path qw(rmtree);
   19 use File::Temp qw(tempdir);
   20 use WeBWorK::Form;
   21 use WeBWorK::PG;
   22 use WeBWorK::PG::IO;
   23 use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string);
   24 
   25 ############################################################
   26 #
   27 # user
   28 # effectiveUser
   29 # key
   30 #
   31 # displayMode
   32 # showOldAnswers
   33 # showCorrectAnswers
   34 # showHints
   35 # showSolutions
   36 #
   37 # AnSwEr# - answer blanks in problem
   38 #
   39 # redisplay - name of the "Redisplay Problem" button
   40 # submitAnswers - name of "Submit Answers" button
   41 # checkAnswers - name of the "Check Answers" button
   42 # previewAnswers - name of the "Preview Answers" button
   43 #
   44 ############################################################
   45 
   46 sub pre_header_initialize {
   47   my ($self, $setName, $problemNumber) = @_;
   48   my $r = $self->{r};
   49   my $courseEnv = $self->{ce};
   50   my $db = $self->{db};
   51   my $userName = $r->param('user');
   52   my $effectiveUserName = $r->param('effectiveUser');
   53 
   54   my $user            = $db->getUser($userName);
   55   my $effectiveUser   = $db->getUser($effectiveUserName);
   56   my $set             = $db->getGlobalUserSet($effectiveUserName, $setName);
   57   my $problem         = $db->getGlobalUserProblem($effectiveUserName, $setName, $problemNumber);
   58   my $psvn            = $set->psvn();
   59   my $permissionLevel = $db->getPermissionLevel($userName)->permission();
   60 
   61   $self->{userName}        = $userName;
   62   $self->{user}            = $user;
   63   $self->{effectiveUser}   = $effectiveUser;
   64   $self->{set}             = $set;
   65   $self->{problem}         = $problem;
   66   $self->{permissionLevel} = $permissionLevel;
   67 
   68   ##### form processing #####
   69 
   70   # set options from form fields (see comment at top of file for names)
   71   my $displayMode        = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode};
   72   my $redisplay          = $r->param("redisplay");
   73   my $submitAnswers      = $r->param("submitAnswers");
   74   my $checkAnswers       = $r->param("checkAnswers");
   75   my $previewAnswers     = $r->param("previewAnswers");
   76 
   77   # coerce form fields into CGI::Vars format
   78   my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
   79 
   80   $self->{displayMode}    = $displayMode;
   81   $self->{redisplay}      = $redisplay;
   82   $self->{submitAnswers}  = $submitAnswers;
   83   $self->{checkAnswers}   = $checkAnswers;
   84   $self->{previewAnswers} = $previewAnswers;
   85   $self->{formFields}     = $formFields;
   86 
   87   ##### permissions #####
   88 
   89   # are we allowed to view this problem?
   90   $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0;
   91   return unless $self->{isOpen};
   92 
   93   # what does the user want to do?
   94   my %want = (
   95     showOldAnswers     => $r->param("showOldAnswers")     || $courseEnv->{pg}->{options}->{showOldAnswers},
   96     showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers},
   97     showHints          => $r->param("showHints")          || $courseEnv->{pg}->{options}->{showHints},
   98     showSolutions      => $r->param("showSolutions")      || $courseEnv->{pg}->{options}->{showSolutions},
   99     recordAnswers      => $submitAnswers,
  100     checkAnswers       => $checkAnswers,
  101   );
  102 
  103   # are certain options enforced?
  104   my %must = (
  105     showOldAnswers     => 0,
  106     showCorrectAnswers => 0,
  107     showHints          => 0,
  108     showSolutions      => 0,
  109     recordAnswers      => mustRecordAnswers($permissionLevel),
  110     checkAnswers       => 0,
  111   );
  112 
  113   # does the user have permission to use certain options?
  114   my %can = (
  115     showOldAnswers     => 1,
  116     showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
  117     showHints          => 1,
  118     showSolutions      => canShowSolutions($permissionLevel, $set->answer_date),
  119     recordAnswers      => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
  120       $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
  121       # attempts=num_correct+num_incorrect+1, as this happens before updating $problem
  122     checkAnswers       => canCheckAnswers($permissionLevel, $set->answer_date),
  123   );
  124 
  125   # final values for options
  126   my %will;
  127   foreach (keys %must) {
  128     $will{$_} = $can{$_} && ($want{$_} || $must{$_});
  129   }
  130 
  131   ##### sticky answers #####
  132 
  133   if (not $submitAnswers and $will{showOldAnswers}) {
  134     # do this only if new answers are NOT being submitted
  135     my %oldAnswers = decodeAnswers($problem->last_answer);
  136     $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
  137   }
  138 
  139   ##### translation #####
  140 
  141   my $pg = WeBWorK::PG->new(
  142     $courseEnv,
  143     $effectiveUser,
  144     $r->param('key'),
  145     $set,
  146     $problem,
  147     $psvn,
  148     $formFields,
  149     { # translation options
  150       displayMode     => $displayMode,
  151       showHints       => $will{showHints},
  152       showSolutions   => $will{showSolutions},
  153       refreshMath2img => $will{showHints} || $will{showSolutions},
  154       processAnswers  => 1,
  155     },
  156   );
  157 
  158   ##### fix hint/solution options #####
  159 
  160   $can{showHints}     &&= $pg->{flags}->{hintExists};
  161   $can{showSolutions} &&= $pg->{flags}->{solutionExists};
  162 
  163   ##### store fields #####
  164 
  165   $self->{want} = \%want;
  166   $self->{must} = \%must;
  167   $self->{can}  = \%can;
  168   $self->{will} = \%will;
  169 
  170   $self->{pg} = $pg;
  171 }
  172 
  173 sub if_warnings($$) {
  174   my ($self, $arg) = @_;
  175   return 0 unless $self->{isOpen};
  176   return $self->{pg}->{warnings} ne "";
  177 }
  178 
  179 sub if_errors($$) {
  180   my ($self, $arg) = @_;
  181   return 0 unless $self->{isOpen};
  182   return $self->{pg}->{flags}->{error_flag};
  183 }
  184 
  185 sub head {
  186   my $self = shift;
  187   return "" unless $self->{isOpen};
  188   return $self->{pg}->{head_text} if $self->{pg}->{head_text};
  189 }
  190 
  191 sub path {
  192   my $self = shift;
  193   my $args = $_[-1];
  194   my $setName = $self->{set}->set_id;
  195   my $problemNumber = $self->{problem}->problem_id;
  196 
  197   my $ce = $self->{ce};
  198   my $root = $ce->{webworkURLs}->{root};
  199   my $courseName = $ce->{courseName};
  200   return $self->pathMacro($args,
  201     "Home" => "$root",
  202     $courseName => "$root/$courseName",
  203     $setName => "$root/$courseName/$setName",
  204     "Problem $problemNumber" => "",
  205   );
  206 }
  207 
  208 sub siblings {
  209   my $self = shift;
  210   my $setName = $self->{set}->set_id;
  211   my $problemNumber = $self->{problem}->problem_id;
  212 
  213   my $ce = $self->{ce};
  214   my $db = $self->{db};
  215   my $root = $ce->{webworkURLs}->{root};
  216   my $courseName = $ce->{courseName};
  217 
  218   print CGI::strong("Problems"), CGI::br();
  219 
  220   my $effectiveUser = $self->{r}->param("effectiveUser");
  221   my @problems;
  222   push @problems, $db->getGlobalUserProblem($effectiveUser, $setName, $_)
  223     foreach ($db->listUserProblems($effectiveUser, $setName));
  224   foreach my $problem (sort { $a->problem_id <=> $b->problem_id } @problems) {
  225     print CGI::a({-href=>"$root/$courseName/$setName/".$problem->problem_id."/?"
  226       . $self->url_authen_args . "&displayMode=" . $self->{displayMode}},
  227         "Problem ".$problem->problem_id), CGI::br();
  228   }
  229 }
  230 
  231 sub nav {
  232   my $self = shift;
  233   my $args = $_[-1];
  234   my $setName = $self->{set}->set_id;
  235   my $problemNumber = $self->{problem}->problem_id;
  236 
  237   my $ce = $self->{ce};
  238   my $db = $self->{db};
  239   my $root = $ce->{webworkURLs}->{root};
  240   my $courseName = $ce->{courseName};
  241 
  242   my $wwdb          = $self->{wwdb};
  243   my $effectiveUser = $self->{r}->param("effectiveUser");
  244   my $tail = "&displayMode=".$self->{displayMode};
  245 
  246   my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList");
  247 
  248   my $prevProblem = $db->getGlobalUserProblem($effectiveUser, $setName, $problemNumber-1);
  249   my $nextProblem = $db->getGlobalUserProblem($effectiveUser, $setName, $problemNumber+1);
  250   unshift @links, "Previous Problem" , ($prevProblem
  251     ? "$root/$courseName/$setName/".$prevProblem->problem_id
  252     : "") , "navPrev";
  253   push @links, "Next Problem" , ($nextProblem
  254     ? "$root/$courseName/$setName/".$nextProblem->problem_id
  255     : "") , "navNext";
  256 
  257   return $self->navMacro($args, $tail, @links);
  258 }
  259 
  260 sub title {
  261   my $self = shift;
  262   my $setName = $self->{set}->set_id;
  263   my $problemNumber = $self->{problem}->problem_id;
  264 
  265   return "$setName : Problem $problemNumber";
  266 }
  267 
  268 sub body {
  269   my $self = shift;
  270 
  271   return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open."))
  272     unless $self->{isOpen};
  273 
  274   # unpack some useful variables
  275   my $r               = $self->{r};
  276   my $db              = $self->{db};
  277   my $set             = $self->{set};
  278   my $problem         = $self->{problem};
  279   my $permissionLevel = $self->{permissionLevel};
  280   my $submitAnswers   = $self->{submitAnswers};
  281   my $checkAnswers    = $self->{checkAnswers};
  282   my $previewAnswers  = $self->{previewAnswers};
  283   my %want            = %{ $self->{want} };
  284   my %can             = %{ $self->{can} };
  285   my %must            = %{ $self->{must} };
  286   my %will            = %{ $self->{will} };
  287   my $pg              = $self->{pg};
  288 
  289   ##### translation errors? #####
  290 
  291   if ($pg->{flags}->{error_flag}) {
  292     return $self->errorOutput($pg->{errors}, $pg->{body_text});
  293   }
  294 
  295   ##### answer processing #####
  296 
  297   # if answers were submitted:
  298   if ($submitAnswers) {
  299     # get a "pure" (unmerged) UserProblem to modify
  300     my $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id);
  301     # store answers in DB for sticky answers
  302     my %answersToStore;
  303     my %answerHash = %{ $pg->{answers} };
  304     $answersToStore{$_} = $answerHash{$_}->{original_student_ans}
  305       foreach (keys %answerHash);
  306     my $answerString = encodeAnswers(%answersToStore,
  307       @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} });
  308     $pureProblem->last_answer($answerString);
  309     $problem->last_answer($answerString);
  310     $db->putUserProblem($pureProblem);
  311 
  312     # store state in DB if it makes sense
  313     if ($will{recordAnswers}) {
  314       $problem->status($pg->{state}->{recorded_score});
  315       $problem->attempted(1);
  316       $problem->num_correct($pg->{state}->{num_of_correct_ans});
  317       $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
  318       $pureProblem->status($pg->{state}->{recorded_score});
  319       $pureProblem->attempted(1);
  320       $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
  321       $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
  322       $db->putUserProblem($pureProblem);
  323       # write to the transaction log, just to make sure
  324       writeLog($self->{ce}, "transaction",
  325         $problem->problem_id."\t".
  326         $problem->set_id."\t".
  327         $problem->user_id."\t".
  328         $problem->source_file."\t".
  329         $problem->value."\t".
  330         $problem->max_attempts."\t".
  331         $problem->problem_seed."\t".
  332         $pureProblem->status."\t".
  333         $pureProblem->attempted."\t".
  334         $pureProblem->last_answer."\t".
  335         $pureProblem->num_correct."\t".
  336         $pureProblem->num_incorrect
  337       );
  338     }
  339   }
  340   # logging student answers
  341   my $pastAnswerLog = undef;
  342   if (defined( $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'} )) {
  343 
  344     $pastAnswerLog  =   $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'};
  345 
  346     if ($submitAnswers and defined($pastAnswerLog) ) {
  347       my $answerString = "";
  348       my %answerHash = %{ $pg->{answers} };
  349       $answerString = $answerString . $answerHash{$_}->{original_student_ans}."\t"
  350         foreach (sort keys  %answerHash);
  351       writeLog($self->{ce}, "pastAnswerList",
  352           '|'.$problem->user_id.
  353           '|'.$problem->set_id.
  354           '|'.$problem->problem_id.'|'."\t".
  355           time()."\t".
  356           $answerString,
  357 
  358         );
  359 
  360     }
  361 
  362    }
  363   # end logging student answers
  364 
  365   ##### output #####
  366   print CGI::start_div({class=>"problemHeader"});
  367   # attempt summary
  368   if ($submitAnswers or $will{showCorrectAnswers}) {
  369     # print this if user submitted answers OR requested correct answers
  370     print $self->attemptResults($pg, $submitAnswers,
  371       $will{showCorrectAnswers},
  372       $pg->{flags}->{showPartialCorrectAnswers}, 1, 0);
  373   } elsif ($checkAnswers) {
  374     # print this if user previewed answers
  375     print $self->attemptResults($pg, 1, 0, 1, 1, 0);
  376       # show attempt answers
  377       # don't show correct answers
  378       # show attempt results (correctness)
  379       # don't show attempt previews
  380   } elsif ($previewAnswers) {
  381     # print this if user previewed answers
  382     print $self->attemptResults($pg, 1, 0, 0, 0, 1);
  383       # show attempt answers
  384       # don't show correct answers
  385       # don't show attempt results (correctness)
  386       # show attempt previews
  387   }
  388 
  389   print CGI::end_div();
  390 
  391   print CGI::start_div({class=>"problem"});
  392   #print CGI::hr();
  393   # main form
  394   print
  395     CGI::startform("POST", $r->uri),
  396     $self->hidden_authen_fields,
  397     CGI::p($pg->{body_text}),
  398     CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),
  399     CGI::p(
  400       ($can{recordAnswers}
  401         ? CGI::submit(-name=>"submitAnswers",
  402           -label=>"Submit Answers")
  403         : ""),
  404       ($can{checkAnswers}
  405         ? CGI::submit(-name=>"checkAnswers",
  406           -label=>"Check Answers")
  407         : ""),
  408       CGI::submit(-name=>"previewAnswers",
  409         -label=>"Preview Answers"),
  410     );
  411   print CGI::end_div();
  412 
  413   print CGI::start_div({class=>"scoreSummary"});
  414   # score summary
  415   my $attempts = $problem->num_correct + $problem->num_incorrect;
  416   my $attemptsNoun = $attempts != 1 ? "times" : "time";
  417   my $lastScore = int ($problem->status * 100) . "%";
  418   my ($attemptsLeft, $attemptsLeftNoun);
  419   if ($problem->max_attempts == -1) {
  420     # unlimited attempts
  421     $attemptsLeft = "unlimited";
  422     $attemptsLeftNoun = "attempts";
  423   } else {
  424     $attemptsLeft = $problem->max_attempts - $attempts;
  425     $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
  426   }
  427 
  428   my $setClosed = 0;
  429   my $setClosedMessage;
  430   if (time < $set->open_date or time > $set->due_date) {
  431     $setClosed = 1;
  432     $setClosedMessage = "This problem set is closed.";
  433     if ($permissionLevel > 0) {
  434       $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded.";
  435     } else {
  436       $setClosedMessage .= " Additional attempts will not be recorded.";
  437     }
  438   }
  439   print CGI::p(
  440     "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
  441     $problem->attempted
  442       ? "Your recorded score is $lastScore." . CGI::br()
  443       : "",
  444     $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
  445   );
  446   print CGI::end_div();
  447   print CGI::hr(), CGI::start_div({class=>"viewOptions"});
  448   print
  449     $self->viewOptions(),CGI::end_div(),
  450     CGI::endform();
  451 
  452   print  CGI::start_div({class=>"problemFooter"});
  453   # feedback form
  454   my $ce = $self->{ce};
  455   my $root = $ce->{webworkURLs}->{root};
  456   my $courseName = $ce->{courseName};
  457   my $feedbackURL = "$root/$courseName/feedback/";
  458 
  459   # arguments for answer inspection button
  460   my $prof_url = $ce->{webworkURLs}->{oldProf};
  461   my $cgi_url = $prof_url;
  462   $cgi_url=~ s|/[^/]*$||;  # clip profLogin.pl
  463   my $authen_args = $self->url_authen_args();
  464   my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl";
  465 
  466   #print feedback form
  467   print
  468     CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
  469     $self->hidden_authen_fields,"\n",
  470     CGI::hidden("module",             __PACKAGE__),"\n",
  471     CGI::hidden("set",                $set->set_id),"\n",
  472     CGI::hidden("problem",            $problem->problem_id),"\n",
  473     CGI::hidden("displayMode",        $self->{displayMode}),"\n",
  474     CGI::hidden("showOldAnswers",     $will{showOldAnswers}),"\n",
  475     CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
  476     CGI::hidden("showHints",          $will{showHints}),"\n",
  477     CGI::hidden("showSolutions",      $will{showSolutions}),"\n",
  478     CGI::p({-align=>"right"},
  479       CGI::submit(-name=>"feedbackForm", -label=>"Send Feedback")
  480     ),
  481     CGI::endform(),"\n";
  482   # print answer inspection button
  483   if ($self->{permissionLevel} >0)      {
  484 
  485 
  486     print "\n",
  487       CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
  488         $self->hidden_authen_fields,"\n",
  489         CGI::hidden(-name => 'course',  -value=>$courseName), "\n",
  490         CGI::hidden(-name => 'probNum', -value=>$problem->problem_id), "\n",
  491         CGI::hidden(-name => 'setNum',  -value=>$problem->set_id), "\n",
  492         CGI::hidden(-name => 'User',    -value=>$problem->user_id), "\n",
  493         CGI::submit(-name => 'action',  -value=>'Show Past Answers'), "\n",
  494         CGI::endform();
  495 
  496 
  497 
  498   }
  499   # FIXME print editor link
  500   if ($self->{permissionLevel}>=10 ) {
  501     print CGI::a({-href=>"/webwork/$courseName/instructor/pgProblemEditor/".$set->set_id.
  502     '/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');
  503   }
  504   print CGI::end_div();
  505 
  506   # end answer inspection button
  507   # warning output
  508   if ($pg->{warnings} ne "") {
  509     print CGI::hr(), $self->warningOutput($pg->{warnings});
  510   }
  511 
  512   # debugging stuff
  513   if (0) {
  514     print
  515       CGI::hr(),
  516       CGI::h2("debugging information"),
  517       CGI::h3("form fields"),
  518       ref2string($self->{formFields}),
  519       CGI::h3("user object"),
  520       ref2string($self->{user}),
  521       CGI::h3("set object"),
  522       ref2string($set),
  523       CGI::h3("problem object"),
  524       ref2string($problem),
  525       CGI::h3("PG object"),
  526       ref2string($pg, {'WeBWorK::PG::Translator' => 1});
  527   }
  528 
  529   return "";
  530 }
  531 
  532 ##### output utilities #####
  533 
  534 sub attemptResults($$$$$$) {
  535   my $self = shift;
  536   my $pg = shift;
  537   my $showAttemptAnswers = shift;
  538   my $showCorrectAnswers = shift;
  539   my $showAttemptResults = $showAttemptAnswers && shift;
  540   my $showSummary = shift;
  541   my $showAttemptPreview = shift || 0;
  542   my $problemResult = $pg->{result}; # the overall result of the problem
  543   my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
  544 
  545   my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
  546 
  547   my $header = CGI::th("Part");
  548   $header .= $showAttemptAnswers ? CGI::th("Entered")  : "";
  549   $header .= $showAttemptPreview ? CGI::th("Answer Preview")  : "";
  550   $header .= $showCorrectAnswers ? CGI::th("Correct")  : "";
  551   $header .= $showAttemptResults ? CGI::th("Result")   : "";
  552   $header .= $showMessages       ? CGI::th("messages") : "";
  553   my @tableRows = ( $header );
  554   my $numCorrect;
  555   foreach my $name (@answerNames) {
  556     my $answerResult  = $pg->{answers}->{$name};
  557     my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
  558     my $preview       = ($showAttemptPreview
  559                           ? $self->previewAnswer($answerResult)
  560           : "");
  561     my $correctAnswer = $answerResult->{correct_ans};
  562     my $answerScore   = $answerResult->{score};
  563     my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
  564 
  565     $numCorrect += $answerScore > 0;
  566     my $resultString = $answerScore ? "correct" : "incorrect";
  567 
  568     # get rid of the goofy prefix on the answer names (supposedly, the format
  569     # of the answer names is changeable. this only fixes it for "AnSwEr"
  570     $name =~ s/^AnSwEr//;
  571 
  572     my $row = CGI::td($name);
  573     $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : "";
  574     $row .= $showAttemptPreview ? CGI::td($preview)       : "";
  575     $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : "";
  576     $row .= $showAttemptResults ? CGI::td($resultString)  : "";
  577     $row .= $answerMessage      ? CGI::td($answerMessage) : "";
  578     push @tableRows, $row;
  579   }
  580 
  581   my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
  582   my $scorePercent = int ($problemResult->{score} * 100) . "\%";
  583   my $summary = "On this attempt, you answered $numCorrect out of "
  584     . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
  585   return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p($summary) : "");
  586 }
  587 
  588 sub viewOptions($) {
  589   my $self = shift;
  590   my $displayMode = $self->{displayMode};
  591   my %must = %{ $self->{must} };
  592   my %can  = %{ $self->{can}  };
  593   my %will = %{ $self->{will} };
  594 
  595   my $optionLine;
  596   $can{showOldAnswers} and $optionLine .= join "",
  597     "Show: &nbsp;",
  598     CGI::checkbox(
  599       -name    => "showOldAnswers",
  600       -checked => $will{showOldAnswers},
  601       -label   => "Saved answers",
  602     ), "&nbsp;&nbsp;";
  603   $can{showCorrectAnswers} and $optionLine .= join "",
  604     CGI::checkbox(
  605       -name    => "showCorrectAnswers",
  606       -checked => $will{showCorrectAnswers},
  607       -label   => "Correct answers",
  608     ), "&nbsp;&nbsp;";
  609   $can{showHints} and $optionLine .= join "",
  610     CGI::checkbox(
  611       -name    => "showHints",
  612       -checked => $will{showHints},
  613       -label   => "Hints",
  614     ), "&nbsp;&nbsp;";
  615   $can{showSolutions} and $optionLine .= join "",
  616     CGI::checkbox(
  617       -name    => "showSolutions",
  618       -checked => $will{showSolutions},
  619       -label   => "Solutions",
  620     ), "&nbsp;&nbsp;";
  621   $optionLine and $optionLine .= join "", CGI::br();
  622 
  623   return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"},
  624       "View equations as: &nbsp;",
  625     CGI::radio_group(
  626       -name    => "displayMode",
  627       -values  => ['plainText', 'formattedText', 'images'],
  628       -default => $displayMode,
  629       -labels  => {
  630         plainText     => "plain text",
  631         formattedText => "formatted text",
  632         images        => "images",
  633       }
  634     ), CGI::br(),
  635     $optionLine,
  636     CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"),
  637   );
  638 }
  639 
  640 sub previewAnswer($$) {
  641   my ($self, $answerResult) = @_;
  642   my $ce            = $self->{ce};
  643   my $effectiveUser = $self->{effectiveUser};
  644   my $set           = $self->{set};
  645   my $problem       = $self->{problem};
  646   my $displayMode   = $self->{displayMode};
  647 
  648   # note: right now, we have to do things completely differently when we are
  649   # rendering math from INSIDE the translator and from OUTSIDE the translator.
  650   # so we'll just deal with each case explicitly here. there's some code
  651   # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
  652 
  653   my $tex = $answerResult->{preview_latex_string};
  654 
  655   return "" if $tex eq "";
  656 
  657   if ($displayMode eq "plainText") {
  658     return $tex;
  659   } elsif ($displayMode eq "formattedText") {
  660     my $tthCommand = $ce->{externalPrograms}->{tth}
  661       . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
  662       . "\\(".$tex."\\)\n"
  663       . "END_OF_INPUT\n";
  664 
  665     # call tth
  666     my $result = `$tthCommand`;
  667     if ($?) {
  668       return "<b>[tth failed: $? $@]</b>";
  669     }
  670     return $result;
  671   } elsif ($displayMode eq "images") {
  672     # how are we going to name this?
  673     my $targetPathCommon = "/png/"
  674       . $effectiveUser->user_id . "."
  675       . $set->set_id . "."
  676       . $problem->problem_id . "."
  677       . $answerResult->{ans_name} . ".png";
  678 
  679     # figure out where to put things
  680     my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp});
  681     my $latex = $ce->{externalPrograms}->{latex};
  682     my $dvipng = $ce->{externalPrograms}->{dvipng};
  683     my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
  684         # should use surePathToTmpFile, but we have to
  685         # isolate it from the problem enivronment first
  686     my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
  687 
  688     # call dvipng to generate a preview
  689     dvipng($wd, $latex, $dvipng, $tex, $targetPath);
  690     rmtree($envir->{dvipngTempDir}, 0, 0);
  691     if (-e $targetPath) {
  692       return "<img src=\"$targetURL\" alt=\"$tex\" />";
  693     } else {
  694       return "<b>[math2img failed]</b>";
  695     }
  696   }
  697 }
  698 ##### logging subroutine ####
  699 
  700 
  701 
  702 ##### permission queries #####
  703 
  704 # this stuff should be abstracted out into the permissions system
  705 # however, the permission system only knows about things in the
  706 # course environment and the username. hmmm...
  707 
  708 # also, i should fix these so that they have a consistent calling
  709 # format -- perhaps:
  710 #   canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
  711 
  712 sub canShowCorrectAnswers($$) {
  713   my ($permissionLevel, $answerDate) = @_;
  714   return $permissionLevel > 0 || time > $answerDate;
  715 }
  716 
  717 sub canShowSolutions($$) {
  718   my ($permissionLevel, $answerDate) = @_;
  719   return canShowCorrectAnswers($permissionLevel, $answerDate);
  720 }
  721 
  722 sub canRecordAnswers($$$$$) {
  723   my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
  724   my $permHigh = $permissionLevel > 0;
  725   my $timeOK = time >= $openDate && time <= $dueDate;
  726   my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
  727   my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
  728   return $recordAnswers;
  729 }
  730 
  731 sub canCheckAnswers($$) {
  732   my ($permissionLevel, $answerDate) = @_;
  733   my $permHigh = $permissionLevel > 0;
  734   my $timeOK = time >= $answerDate;
  735   my $recordAnswers = $permHigh || $timeOK;
  736   return $recordAnswers;
  737 }
  738 
  739 sub mustRecordAnswers($) {
  740   my ($permissionLevel) = @_;
  741   return $permissionLevel == 0;
  742 }
  743 
  744 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9