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

View of /trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9