[system] / trunk / webwork-modperl / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

View of /trunk/webwork-modperl/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 903 - (download) (as text) (annotate)
Fri May 23 21:36:35 2003 UTC (10 years ago) by gage
File size: 23971 byte(s)
Added a link to the editor.

This link always prints, (at the moment) even if the
user doesn't have instructor permissions. (FIXME)
-- Mike

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9