[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 1326 - (download) (as text) (annotate)
Wed Jul 9 01:54:31 2003 UTC (9 years, 10 months ago) by gage
File size: 31037 byte(s)
Check for empty string instead of truth when inserting   in
answer table.  This fixes bug #86
--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 my $timer0_ON=1;  # times pg translation phase
   15 use strict;
   16 use warnings;
   17 use CGI qw();
   18 use File::Path qw(rmtree);
   19 use WeBWorK::Form;
   20 use WeBWorK::PG;
   21 use WeBWorK::PG::ImageGenerator;
   22 use WeBWorK::PG::IO;
   23 use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string makeTempDirectory);
   24 use WeBWorK::DB::Utils qw(global2user user2global findDefaults);
   25 use WeBWorK::Timing;
   26 
   27 ############################################################
   28 #
   29 # user
   30 # effectiveUser
   31 # key
   32 #
   33 # displayMode
   34 # showOldAnswers
   35 # showCorrectAnswers
   36 # showHints
   37 # showSolutions
   38 #
   39 # AnSwEr# - answer blanks in problem
   40 #
   41 # redisplay - name of the "Redisplay Problem" button
   42 # submitAnswers - name of "Submit Answers" button
   43 # checkAnswers - name of the "Check Answers" button
   44 # previewAnswers - name of the "Preview Answers" button
   45 #
   46 ############################################################
   47 
   48 sub pre_header_initialize {
   49   my ($self, $setName, $problemNumber) = @_;
   50   my $r                    = $self->{r};
   51   my $courseEnv            = $self->{ce};
   52   my $db                   = $self->{db};
   53   my $userName             = $r->param('user');
   54   my $effectiveUserName    = $r->param('effectiveUser');
   55   my $key                  = $r->param('key');
   56   my $user                 = $db->getUser($userName);
   57   my $effectiveUser        = $db->getUser($effectiveUserName);
   58   my $permissionLevel      = $db->getPermissionLevel($userName)->permission();
   59 
   60   # obtain the merged set for $effectiveUser
   61   my $set = $db->getMergedSet($effectiveUserName, $setName);
   62 
   63   # obtain the merged problem for $effectiveUser
   64   my $problem = $db->getMergedProblem($effectiveUserName, $setName, $problemNumber);
   65 
   66   my $editMode = $r->param("editMode");
   67 
   68   if ($permissionLevel > 0 and defined $editMode) {
   69     # professors are allowed to fabricate sets and problems not
   70     # assigned to them (or anyone). this allows them to use the
   71     # editor to
   72 
   73     # if that is not yet defined obtain the global set, convert
   74     # it to a user set, and add fake user data
   75     unless (defined $set) {
   76       my $userSetClass = $db->{set_user}->{record};
   77       $set = global2user($userSetClass,
   78         $db->getGlobalSet($setName));
   79       die "Set $setName does not exist"
   80         unless defined $set;
   81       $set->psvn(0);
   82     }
   83 
   84     # if that is not yet defined obtain the global problem,
   85     # convert it to a user problem, and add fake user data
   86     unless (defined $problem) {
   87       my $userProblemClass = $db->{problem_user}->{record};
   88       $problem = global2user($userProblemClass,
   89         $db->getGlobalProblem($setName,$problemNumber));
   90       die "Problem $problemNumber in set $setName does not exist"
   91         unless defined $problem;
   92       $problem->user_id($effectiveUserName);
   93       $problem->problem_seed(0);
   94       $problem->status(0);
   95       $problem->attempted(0);
   96       $problem->last_answer("");
   97       $problem->num_correct(0);
   98       $problem->num_incorrect(0);
   99     }
  100 
  101     # now we're sure we have valid UserSet and UserProblem objects
  102     # yay!
  103 
  104     # now deal with possible editor overrides:
  105 
  106     # if the caller is asking to override the source file, and
  107     # editMode calls for a temporary file, do so
  108     my $sourceFilePath = $r->param("sourceFilePath");
  109     if (defined $sourceFilePath and $editMode eq "temporaryFile") {
  110       $problem->source_file($sourceFilePath);
  111     }
  112 
  113     # if the caller is asking to override the problem seed, do so
  114     my $problemSeed = $r->param("problemSeed");
  115     if (defined $problemSeed) {
  116       $problem->problem_seed($problemSeed);
  117     }
  118   } else {
  119     # students can't view problems not assigned to them
  120     die "Set $setName is not assigned to $effectiveUserName"
  121       unless defined $set;
  122     die "Problem $problemNumber in set $setName is not assigned to $effectiveUserName"
  123       unless defined $problem;
  124   }
  125 
  126   $self->{userName}          = $userName;
  127   $self->{effectiveUserName} = $effectiveUserName;
  128   $self->{user}              = $user;
  129   $self->{effectiveUser}     = $effectiveUser;
  130   $self->{permissionLevel}   = $permissionLevel;
  131   $self->{set}               = $set;
  132   $self->{problem}           = $problem;
  133   $self->{editMode}          = $editMode;
  134 
  135   ##### form processing #####
  136 
  137   # set options from form fields (see comment at top of file for names)
  138   my $displayMode        = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode};
  139   my $redisplay          = $r->param("redisplay");
  140   my $submitAnswers      = $r->param("submitAnswers");
  141   my $checkAnswers       = $r->param("checkAnswers");
  142   my $previewAnswers     = $r->param("previewAnswers");
  143 
  144   # fields which may be defined when using Problem Editor
  145   #my $override_seed = ($permissionLevel>=10) ? $r->param('problemSeed') : undef;
  146   #my $override_problem_source = ($permissionLevel>=10) ? $r->param('sourceFilePath') : undef;
  147   #my $editMode = undef;
  148   #my $submit_button = $r->param('submit_button');
  149   #if ( defined($submit_button ) ) {
  150   # $editMode = "temporaryFile" if $submit_button eq 'Refresh';
  151   # $editMode = 'savedFile'     if $submit_button eq 'Save';
  152   #}
  153   #
  154   ##override using the source file data from the form field
  155   #$problem->source_file($override_problem_source) if defined($override_problem_source);
  156   #$problem->problem_seed($override_seed)          if defined($override_seed);
  157   #
  158   ## store path to source file for title.
  159   #$self->{problem_source_name}    =  $problem->source_file;
  160   #$self->{edit_mode}   = $editMode;
  161   #$self->{current_problem_source}  = (defined($override_problem_source) ) ?
  162 
  163   # coerce form fields into CGI::Vars format
  164   my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
  165 
  166   $self->{displayMode}    = $displayMode;
  167   $self->{redisplay}      = $redisplay;
  168   $self->{submitAnswers}  = $submitAnswers;
  169   $self->{checkAnswers}   = $checkAnswers;
  170   $self->{previewAnswers} = $previewAnswers;
  171   $self->{formFields}     = $formFields;
  172 
  173   ##### permissions #####
  174 
  175   # are we allowed to view this problem?
  176   $self->{isOpen} = time >= $set->open_date || $permissionLevel > 0;
  177   return unless $self->{isOpen};
  178 
  179   # what does the user want to do?
  180   my %want = (
  181     showOldAnswers     => $r->param("showOldAnswers")     || $courseEnv->{pg}->{options}->{showOldAnswers},
  182     showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers},
  183     showHints          => $r->param("showHints")          || $courseEnv->{pg}->{options}->{showHints},
  184     showSolutions      => $r->param("showSolutions")      || $courseEnv->{pg}->{options}->{showSolutions},
  185     recordAnswers      => $submitAnswers,
  186     checkAnswers       => $checkAnswers,
  187   );
  188 
  189   # are certain options enforced?
  190   my %must = (
  191     showOldAnswers     => 0,
  192     showCorrectAnswers => 0,
  193     showHints          => 0,
  194     showSolutions      => 0,
  195     recordAnswers      => mustRecordAnswers($permissionLevel),
  196     checkAnswers       => 0,
  197   );
  198 
  199   # does the user have permission to use certain options?
  200   my %can = (
  201     showOldAnswers     => 1,
  202     showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
  203     showHints          => 1,
  204     showSolutions      => canShowSolutions($permissionLevel, $set->answer_date),
  205     recordAnswers      => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
  206       $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
  207       # attempts=num_correct+num_incorrect+1, as this happens before updating $problem
  208     checkAnswers       => canCheckAnswers($permissionLevel, $set->answer_date),
  209   );
  210 
  211   # final values for options
  212   my %will;
  213   foreach (keys %must) {
  214     $will{$_} = $can{$_} && ($want{$_} || $must{$_});
  215   }
  216 
  217   ##### sticky answers #####
  218 
  219   if (not ($submitAnswers or $previewAnswers or $checkAnswers) and $will{showOldAnswers}) {
  220     # do this only if new answers are NOT being submitted
  221     my %oldAnswers = decodeAnswers($problem->last_answer);
  222     $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
  223   }
  224 
  225   ##### translation #####
  226 
  227   $WeBWorK::timer0->continue("begin pg processing") if $timer0_ON;
  228   my $pg = WeBWorK::PG->new(
  229     $courseEnv,
  230     $effectiveUser,
  231     $key,
  232     $set,
  233     $problem,
  234     $set->psvn, # FIXME: this field should be removed
  235     $formFields,
  236     { # translation options
  237       displayMode     => $displayMode,
  238       showHints       => $will{showHints},
  239       showSolutions   => $will{showSolutions},
  240       refreshMath2img => $will{showHints} || $will{showSolutions},
  241       processAnswers  => 1,
  242     },
  243   );
  244 
  245   $WeBWorK::timer0->continue("end pg processing") if $timer0_ON;
  246   ##### fix hint/solution options #####
  247 
  248   $can{showHints}     &&= $pg->{flags}->{hintExists};
  249   $can{showSolutions} &&= $pg->{flags}->{solutionExists};
  250 
  251   ##### store fields #####
  252 
  253   $self->{want} = \%want;
  254   $self->{must} = \%must;
  255   $self->{can}  = \%can;
  256   $self->{will} = \%will;
  257 
  258   $self->{pg} = $pg;
  259 }
  260 
  261 #sub if_warnings($$) {
  262 # my ($self, $arg) = @_;
  263 # return 0 unless $self->{isOpen};
  264 # return $self->{pg}->{warnings} ne "";
  265 #}
  266 
  267 sub if_errors($$) {
  268   my ($self, $arg) = @_;
  269   return 0 unless $self->{isOpen};
  270   return $self->{pg}->{flags}->{error_flag};
  271 }
  272 
  273 sub head {
  274   my $self = shift;
  275   return "" unless $self->{isOpen};
  276   return $self->{pg}->{head_text} if $self->{pg}->{head_text};
  277 }
  278 
  279 sub options {
  280   my $self = shift;
  281   return join("",
  282     CGI::start_form("POST", $self->{r}->uri),
  283     $self->hidden_authen_fields,
  284     CGI::hr(),
  285     CGI::start_div({class=>"viewOptions"}),
  286     $self->viewOptions(),
  287     CGI::end_div(),
  288     CGI::end_form()
  289   );
  290 }
  291 
  292 sub path {
  293   my $self = shift;
  294   my $args = $_[-1];
  295   my $setName = $self->{set}->set_id;
  296   my $problemNumber = $self->{problem}->problem_id;
  297 
  298   my $ce = $self->{ce};
  299   my $root = $ce->{webworkURLs}->{root};
  300   my $courseName = $ce->{courseName};
  301   return $self->pathMacro($args,
  302     "Home" => "$root",
  303     $courseName => "$root/$courseName",
  304     $setName => "$root/$courseName/$setName",
  305     "Problem $problemNumber" => "",
  306   );
  307 }
  308 
  309 sub siblings {
  310   my $self = shift;
  311   my $setName = $self->{set}->set_id;
  312   my $problemNumber = $self->{problem}->problem_id;
  313 
  314   my $ce = $self->{ce};
  315   my $db = $self->{db};
  316   my $root = $ce->{webworkURLs}->{root};
  317   my $courseName = $ce->{courseName};
  318   print CGI::strong("Problems"), CGI::br();
  319 
  320   my $effectiveUser = $self->{r}->param("effectiveUser");
  321   my @problemIDs = $db->listUserProblems($effectiveUser, $setName);
  322   foreach my $problem (sort { $a <=> $b } @problemIDs) {
  323     print CGI::a({-href=>"$root/$courseName/$setName/".$problem."/?"
  324       . $self->url_authen_args . "&displayMode=" . $self->{displayMode}},
  325       "Problem ".$problem), CGI::br();
  326   }
  327 
  328   return "";
  329 }
  330 
  331 sub nav {
  332   $WeBWorK::timer0->continue("begin nav subroutine") if $timer0_ON;
  333   my $self = shift;
  334   my $args = $_[-1];
  335   my $setName = $self->{set}->set_id;
  336   my $problemNumber = $self->{problem}->problem_id;
  337 
  338   my $ce = $self->{ce};
  339   my $db = $self->{db};
  340   my $root = $ce->{webworkURLs}->{root};
  341   my $courseName = $ce->{courseName};
  342 
  343   my $wwdb          = $self->{wwdb};
  344   my $effectiveUser = $self->{r}->param("effectiveUser");
  345   my $tail = "&displayMode=".$self->{displayMode};
  346 
  347   my @links = ("Problem List" , "$root/$courseName/$setName", "navProbList");
  348 
  349   my @problemIDs = $db->listUserProblems($effectiveUser, $setName);
  350   my ($prevID, $nextID);
  351   foreach my $id (@problemIDs) {
  352     $prevID = $id if $id < $problemNumber
  353       and (not defined $prevID or $id > $prevID);
  354     $nextID = $id if $id > $problemNumber
  355       and (not defined $nextID or $id < $nextID);
  356   }
  357   unshift @links, "Previous Problem" , ($prevID
  358     ? "$root/$courseName/$setName/".$prevID
  359     : "") , "navPrev";
  360   push @links, "Next Problem" , ($nextID
  361     ? "$root/$courseName/$setName/".$nextID
  362     : "") , "navNext";
  363 
  364   my $result = $self->navMacro($args, $tail, @links);
  365   $WeBWorK::timer0->continue("end nav subroutine") if $timer0_ON;
  366   return $result;
  367 }
  368 
  369 sub title {
  370   my $self = shift;
  371   my $setName = $self->{set}->set_id;
  372   my $problemNumber = $self->{problem}->problem_id;
  373 
  374   return "$setName : Problem $problemNumber";
  375 }
  376 
  377 sub body {
  378   my $self = shift;
  379 
  380   return CGI::p(CGI::font({-color=>"red"}, "This problem is not available because the problem set that contains it is not yet open."))
  381     unless $self->{isOpen};
  382 
  383   # unpack some useful variables
  384   my $r               = $self->{r};
  385   my $db              = $self->{db};
  386   my $set             = $self->{set};
  387   my $problem         = $self->{problem};
  388   my $editMode        = $self->{editMode};
  389   my $permissionLevel = $self->{permissionLevel};
  390   my $submitAnswers   = $self->{submitAnswers};
  391   my $checkAnswers    = $self->{checkAnswers};
  392   my $previewAnswers  = $self->{previewAnswers};
  393   my %want            = %{ $self->{want} };
  394   my %can             = %{ $self->{can}  };
  395   my %must            = %{ $self->{must} };
  396   my %will            = %{ $self->{will} };
  397   my $pg              = $self->{pg};
  398 
  399   ##### translation errors? #####
  400 
  401   if ($pg->{flags}->{error_flag}) {
  402     return $self->errorOutput($pg->{errors}, $pg->{body_text});
  403   }
  404 
  405   ##### answer processing #####
  406   $WeBWorK::timer0->continue("begin answer processing") if $timer0_ON;
  407   # if answers were submitted:
  408   my $scoreRecordedMessage;
  409   if ($submitAnswers) {
  410     # get a "pure" (unmerged) UserProblem to modify
  411     # this will be undefined if the problem has not been assigned to this user
  412     my $pureProblem = $db->getUserProblem($problem->user_id, $problem->set_id, $problem->problem_id);
  413     if (defined $pureProblem) {
  414       # store answers in DB for sticky answers
  415       my %answersToStore;
  416       my %answerHash = %{ $pg->{answers} };
  417       $answersToStore{$_} = $answerHash{$_}->{original_student_ans}
  418         foreach (keys %answerHash);
  419       my $answerString = encodeAnswers(%answersToStore,
  420         @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} });
  421 
  422       # store last answer to database
  423       $problem->last_answer($answerString);
  424       $pureProblem->last_answer($answerString);
  425       $db->putUserProblem($pureProblem);
  426 
  427       # store state in DB if it makes sense
  428       if ($will{recordAnswers}) {
  429         $problem->status($pg->{state}->{recorded_score});
  430         $problem->attempted(1);
  431         $problem->num_correct($pg->{state}->{num_of_correct_ans});
  432         $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
  433         $pureProblem->status($pg->{state}->{recorded_score});
  434         $pureProblem->attempted(1);
  435         $pureProblem->num_correct($pg->{state}->{num_of_correct_ans});
  436         $pureProblem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
  437         if ($db->putUserProblem($pureProblem)) {
  438           $scoreRecordedMessage = "Your score was recorded.";
  439         } else {
  440           $scoreRecordedMessage = "Your score was not recorded because there was a failure in storing the problem record to the database.";
  441         }
  442         # write to the transaction log, just to make sure
  443         writeLog($self->{ce}, "transaction",
  444           $problem->problem_id."\t".
  445           $problem->set_id."\t".
  446           $problem->user_id."\t".
  447           $problem->source_file."\t".
  448           $problem->value."\t".
  449           $problem->max_attempts."\t".
  450           $problem->problem_seed."\t".
  451           $pureProblem->status."\t".
  452           $pureProblem->attempted."\t".
  453           $pureProblem->last_answer."\t".
  454           $pureProblem->num_correct."\t".
  455           $pureProblem->num_incorrect
  456         );
  457       } else {
  458         if (time < $set->open_date or time > $set->due_date) {
  459           $scoreRecordedMessage = "Your score was not recorded because this problem set is closed.";
  460         } else {
  461           $scoreRecordedMessage = "Your score was not recorded.";
  462         }
  463       }
  464     } else {
  465       $scoreRecordedMessage = "Your score was not recorded because this problem has not been built for you.";
  466     }
  467   }
  468 
  469   # logging student answers
  470   my $pastAnswerLog = undef;
  471   if (defined( $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'} )) {
  472     $pastAnswerLog = $self->{ce}->{webworkFiles}->{logs}->{'pastAnswerList'};
  473     if ($submitAnswers and defined $pastAnswerLog) {
  474       my $answerString = "";
  475       my %answerHash = %{ $pg->{answers} };
  476       $answerString = $answerString . $answerHash{$_}->{original_student_ans}."\t"
  477         foreach (sort keys  %answerHash);
  478       $answerString = '' unless defined($answerString); # insure string is defined.
  479       writeLog($self->{ce}, "pastAnswerList",
  480           '|'.$problem->user_id.
  481           '|'.$problem->set_id.
  482           '|'.$problem->problem_id.'|'."\t".
  483           time()."\t".
  484           $answerString,
  485         );
  486     }
  487   }
  488 
  489   $WeBWorK::timer0->continue("end answer processing") if $timer0_ON;
  490 
  491   ##### output #####
  492 
  493   print CGI::start_div({class=>"problemHeader"});
  494 
  495   # custom message for editor
  496   if ($permissionLevel >= 10 and defined $editMode) {
  497     if ($editMode eq "temporaryFile") {
  498       print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file));
  499     } elsif ($editMode eq "savedFile") {
  500       print CGI::p(CGI::i("Problem saved to: ", $problem->source_file));
  501     }
  502   }
  503 
  504   # attempt summary
  505   if ($submitAnswers or $will{showCorrectAnswers}) {
  506     # print this if user submitted answers OR requested correct answers
  507     print $self->attemptResults($pg, $submitAnswers,
  508       $will{showCorrectAnswers},
  509       $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
  510   } elsif ($checkAnswers) {
  511     # print this if user previewed answers
  512     print $self->attemptResults($pg, 1, 0, 1, 1, 1);
  513       # show attempt answers
  514       # don't show correct answers
  515       # show attempt results (correctness)
  516       # don't show attempt previews
  517   } elsif ($previewAnswers) {
  518     # print this if user previewed answers
  519     print $self->attemptResults($pg, 1, 0, 0, 0, 1);
  520       # show attempt answers
  521       # don't show correct answers
  522       # don't show attempt results (correctness)
  523       # show attempt previews
  524   }
  525 
  526   print CGI::end_div();
  527 
  528   print CGI::start_div({class=>"problem"});
  529 
  530   # main form
  531   print
  532     CGI::startform("POST", $r->uri),
  533     $self->hidden_authen_fields,
  534     CGI::p($pg->{body_text}),
  535     CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),
  536     CGI::p(
  537       ($can{recordAnswers}
  538         ? CGI::submit(-name=>"submitAnswers",
  539           -label=>"Submit Answers")
  540         : ""),
  541       ($can{checkAnswers}
  542         ? CGI::submit(-name=>"checkAnswers",
  543           -label=>"Check Answers")
  544         : ""),
  545       CGI::submit(-name=>"previewAnswers",
  546         -label=>"Preview Answers"),
  547     );
  548   print CGI::end_div();
  549 
  550   print CGI::start_div({class=>"scoreSummary"});
  551 
  552   # score summary
  553   my $attempts = $problem->num_correct + $problem->num_incorrect;
  554   my $attemptsNoun = $attempts != 1 ? "times" : "time";
  555   my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number
  556   my ($attemptsLeft, $attemptsLeftNoun);
  557   if ($problem->max_attempts == -1) {
  558     # unlimited attempts
  559     $attemptsLeft = "unlimited";
  560     $attemptsLeftNoun = "attempts";
  561   } else {
  562     $attemptsLeft = $problem->max_attempts - $attempts;
  563     $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
  564   }
  565 
  566   my $setClosed = 0;
  567   my $setClosedMessage;
  568   if (time < $set->open_date or time > $set->due_date) {
  569     $setClosed = 1;
  570     $setClosedMessage = "This problem set is closed.";
  571     if ($permissionLevel > 0) {
  572       $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
  573     } else {
  574       $setClosedMessage .= " Additional attempts will not be recorded.";
  575     }
  576   }
  577   print CGI::p(
  578     $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
  579     "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
  580     $problem->attempted
  581       ? "Your recorded score is $lastScore." . CGI::br()
  582       : "",
  583     $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
  584   );
  585   print CGI::end_div();
  586 
  587   # save state for viewOptions
  588   print CGI::hidden(
  589       -name  => "showOldAnswers",
  590       -value => $will{showOldAnswers}
  591     ),
  592     CGI::hidden(
  593       -name  => "showCorrectAnswers",
  594       -value => $will{showCorrectAnswers}
  595     ),
  596     CGI::hidden(
  597       -name  => "showHints",
  598       -value => $will{showHints}),
  599     CGI::hidden(
  600       -name  => "showSolutions",
  601       -value => $will{showSolutions},
  602     ),
  603     CGI::hidden(
  604       -name  => "displayMode",
  605       -value => $self->{displayMode}
  606     );
  607 
  608   # end of main form
  609   print CGI::endform();
  610 
  611   # stuff we need below (pull these out at the beginning?)
  612   my $ce = $self->{ce};
  613   my $root = $ce->{webworkURLs}->{root};
  614   my $courseName = $ce->{courseName};
  615 
  616   print  CGI::start_div({class=>"problemFooter"});
  617 
  618   # arguments for answer inspection button
  619   my $prof_url = $ce->{webworkURLs}->{oldProf};
  620   my $cgi_url = $prof_url;
  621   $cgi_url=~ s|/[^/]*$||;  # clip profLogin.pl
  622   my $authen_args = $self->url_authen_args();
  623   my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl";
  624 
  625   # print answer inspection button
  626   if ($self->{permissionLevel} > 0) {
  627     print "\n",
  628       CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
  629       $self->hidden_authen_fields,"\n",
  630       CGI::hidden(-name => 'course',  -value=>$courseName), "\n",
  631       CGI::hidden(-name => 'probNum', -value=>$problem->problem_id), "\n",
  632       CGI::hidden(-name => 'setNum',  -value=>$problem->set_id), "\n",
  633       CGI::hidden(-name => 'User',    -value=>$problem->user_id), "\n",
  634       CGI::p( {-align=>"left"},
  635         CGI::submit(-name => 'action',  -value=>'Show Past Answers')
  636       ), "\n",
  637       CGI::endform();
  638   }
  639 
  640   #print CGI::end_div();
  641   #
  642   #print CGI::start_div();
  643 
  644   # arguments for feedback form
  645   my $feedbackURL = "$root/$courseName/feedback/";
  646 
  647   #print feedback form
  648   print
  649     CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
  650     $self->hidden_authen_fields,"\n",
  651     CGI::hidden("module",             __PACKAGE__),"\n",
  652     CGI::hidden("set",                $set->set_id),"\n",
  653     CGI::hidden("problem",            $problem->problem_id),"\n",
  654     CGI::hidden("displayMode",        $self->{displayMode}),"\n",
  655     CGI::hidden("showOldAnswers",     $will{showOldAnswers}),"\n",
  656     CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
  657     CGI::hidden("showHints",          $will{showHints}),"\n",
  658     CGI::hidden("showSolutions",      $will{showSolutions}),"\n",
  659     CGI::p({-align=>"left"},
  660       CGI::submit(-name=>"feedbackForm", -label=>"Contact instructor")
  661     ),
  662     CGI::endform(),"\n";
  663 
  664   # FIXME print editor link
  665   # print editor link if the user is an instructor AND the file is not in temporary editing mode
  666   if ($self->{permissionLevel}>=10 and ( (not defined($self->{edit_mode}))  or $self->{edit_mode} eq 'savedFile') ) {
  667     print CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".$set->set_id.
  668     '/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');
  669   }
  670 
  671   print CGI::end_div();
  672 
  673   # warning output
  674   #if ($pg->{warnings} ne "") {
  675   # print CGI::hr(), $self->warningOutput($pg->{warnings});
  676   #}
  677 
  678   # debugging stuff
  679   if (0) {
  680     print
  681       CGI::hr(),
  682       CGI::h2("debugging information"),
  683       CGI::h3("form fields"),
  684       ref2string($self->{formFields}),
  685       CGI::h3("user object"),
  686       ref2string($self->{user}),
  687       CGI::h3("set object"),
  688       ref2string($set),
  689       CGI::h3("problem object"),
  690       ref2string($problem),
  691       CGI::h3("PG object"),
  692       ref2string($pg, {'WeBWorK::PG::Translator' => 1});
  693   }
  694 
  695   return "";
  696 }
  697 
  698 ##### output utilities #####
  699 
  700 sub attemptResults($$$$$$) {
  701   my $self = shift;
  702   my $pg = shift;
  703   my $showAttemptAnswers = shift;
  704   my $showCorrectAnswers = shift;
  705   my $showAttemptResults = $showAttemptAnswers && shift;
  706   my $showSummary = shift;
  707   my $showAttemptPreview = shift || 0;
  708   my $ce = $self->{ce};
  709   my $problemResult = $pg->{result}; # the overall result of the problem
  710   my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
  711 
  712   my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
  713 
  714   my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
  715   my $imgGen = WeBWorK::PG::ImageGenerator->new(
  716     tempDir  => $ce->{webworkDirs}->{tmp},
  717     dir  => $ce->{courseDirs}->{html_temp},
  718     url  => $ce->{courseURLs}->{html_temp},
  719     basename => $basename,
  720     latex  => $ce->{externalPrograms}->{latex},
  721     dvipng   => $ce->{externalPrograms}->{dvipng},
  722   );
  723 
  724   my $header;
  725   #$header .= CGI::th("Part");
  726   $header .= $showAttemptAnswers ? CGI::th("Entered")  : "";
  727   $header .= $showAttemptPreview ? CGI::th("Answer Preview")  : "";
  728   $header .= $showCorrectAnswers ? CGI::th("Correct")  : "";
  729   $header .= $showAttemptResults ? CGI::th("Result")   : "";
  730   $header .= $showMessages       ? CGI::th("messages") : "";
  731   my @tableRows = ( $header );
  732   my $numCorrect;
  733   foreach my $name (@answerNames) {
  734     my $answerResult  = $pg->{answers}->{$name};
  735     my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
  736     my $preview       = ($showAttemptPreview
  737                           ? $self->previewAnswer($answerResult, $imgGen)
  738                           : "");
  739     my $correctAnswer = $answerResult->{correct_ans};
  740     my $answerScore   = $answerResult->{score};
  741     my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
  742 
  743     $numCorrect += $answerScore > 0;
  744     my $resultString = $answerScore ? "correct" : "incorrect";
  745 
  746     # get rid of the goofy prefix on the answer names (supposedly, the format
  747     # of the answer names is changeable. this only fixes it for "AnSwEr"
  748     $name =~ s/^AnSwEr//;
  749 
  750     my $row;
  751     #$row .= CGI::td($name);
  752     $row .= $showAttemptAnswers ? CGI::td(nbsp($studentAnswer)) : "";
  753     $row .= $showAttemptPreview ? CGI::td(nbsp($preview))       : "";
  754     $row .= $showCorrectAnswers ? CGI::td(nbsp($correctAnswer)) : "";
  755     $row .= $showAttemptResults ? CGI::td(nbsp($resultString))  : "";
  756     $row .= $answerMessage      ? CGI::td(nbsp($answerMessage)) : "";
  757     push @tableRows, $row;
  758   }
  759 
  760   # render equation images
  761   $imgGen->render(refresh => 1);
  762 
  763   my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
  764   my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
  765   my $summary = "On this attempt, you answered $numCorrect out of "
  766     . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
  767   return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p({class=>'emphasis'},$summary) : "");
  768 }
  769 sub nbsp {
  770   my $str = shift;
  771   ($str eq '') ? '&nbsp;' : $str  ;  # returns non-breaking space for empty strings
  772 }
  773 sub viewOptions($) {
  774   my $self = shift;
  775   my $displayMode = $self->{displayMode};
  776   my %must = %{ $self->{must} };
  777   my %can  = %{ $self->{can}  };
  778   my %will = %{ $self->{will} };
  779 
  780   my $optionLine;
  781   $can{showOldAnswers} and $optionLine .= join "",
  782     "Show: &nbsp;".CGI::br(),
  783     CGI::checkbox(
  784       -name    => "showOldAnswers",
  785       -checked => $will{showOldAnswers},
  786       -label   => "Saved answers",
  787     ), "&nbsp;&nbsp;".CGI::br();
  788   $can{showCorrectAnswers} and $optionLine .= join "",
  789     CGI::checkbox(
  790       -name    => "showCorrectAnswers",
  791       -checked => $will{showCorrectAnswers},
  792       -label   => "Correct answers",
  793     ), "&nbsp;&nbsp;".CGI::br();
  794   $can{showHints} and $optionLine .= join "",
  795     CGI::checkbox(
  796       -name    => "showHints",
  797       -checked => $will{showHints},
  798       -label   => "Hints",
  799     ), "&nbsp;&nbsp;".CGI::br();
  800   $can{showSolutions} and $optionLine .= join "",
  801     CGI::checkbox(
  802       -name    => "showSolutions",
  803       -checked => $will{showSolutions},
  804       -label   => "Solutions",
  805     ), "&nbsp;&nbsp;".CGI::br();
  806   $optionLine and $optionLine .= join "", CGI::br();
  807 
  808   return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
  809       "View&nbsp;equations&nbsp;as:&nbsp;&nbsp;&nbsp;&nbsp;".CGI::br(),
  810     CGI::radio_group(
  811       -name    => "displayMode",
  812       -values  => ['plainText', 'formattedText', 'images'],
  813       -default => $displayMode,
  814       -linebreak=>'true',
  815       -labels  => {
  816         plainText     => "plain",
  817         formattedText => "formatted",
  818         images        => "images",
  819       }
  820     ), CGI::br(),CGI::hr(),
  821     $optionLine,
  822     CGI::submit(-name=>"redisplay", -label=>"Save Options"),
  823   );
  824 }
  825 
  826 sub previewAnswer($$) {
  827   my ($self, $answerResult, $imgGen) = @_;
  828   my $ce            = $self->{ce};
  829   my $effectiveUser = $self->{effectiveUser};
  830   my $set           = $self->{set};
  831   my $problem       = $self->{problem};
  832   my $displayMode   = $self->{displayMode};
  833 
  834   # note: right now, we have to do things completely differently when we are
  835   # rendering math from INSIDE the translator and from OUTSIDE the translator.
  836   # so we'll just deal with each case explicitly here. there's some code
  837   # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
  838 
  839   my $tex = $answerResult->{preview_latex_string};
  840 
  841   return "" unless defined $tex and $tex ne "";
  842 
  843   if ($displayMode eq "plainText") {
  844     return $tex;
  845   } elsif ($displayMode eq "formattedText") {
  846     my $tthCommand = $ce->{externalPrograms}->{tth}
  847       . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
  848       . "\\(".$tex."\\)\n"
  849       . "END_OF_INPUT\n";
  850 
  851     # call tth
  852     my $result = `$tthCommand`;
  853     if ($?) {
  854       return "<b>[tth failed: $? $@]</b>";
  855     }
  856     return $result;
  857   } elsif ($displayMode eq "images") {
  858     ## how are we going to name this?
  859     #my $targetPathCommon = "/m2i/"
  860     # . $effectiveUser->user_id . "."
  861     # . $set->set_id . "."
  862     # . $problem->problem_id . "."
  863     # . $answerResult->{ans_name} . ".png";
  864     #
  865     ## figure out where to put things
  866     #my $wd = makeTempDirectory($ce->{courseDirs}->{html_temp}, "webwork-dvipng");
  867     #my $latex = $ce->{externalPrograms}->{latex};
  868     #my $dvipng = $ce->{externalPrograms}->{dvipng};
  869     #my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
  870     #   # should use surePathToTmpFile, but we have to
  871     #   # isolate it from the problem enivronment first
  872     #my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
  873     #
  874     ## call dvipng to generate a preview
  875     #dvipng($wd, $latex, $dvipng, $tex, $targetPath);
  876     #rmtree($wd, 0, 0);
  877     #if (-e $targetPath) {
  878     # return "<img src=\"$targetURL\" alt=\"$tex\" />";
  879     #} else {
  880     # return "<b>[math2img failed]</b>";
  881     #}
  882     $imgGen->add($answerResult->{preview_latex_string});
  883 
  884   }
  885 }
  886 
  887 ##### logging subroutine ####
  888 
  889 
  890 
  891 ##### permission queries #####
  892 
  893 # this stuff should be abstracted out into the permissions system
  894 # however, the permission system only knows about things in the
  895 # course environment and the username. hmmm...
  896 
  897 # also, i should fix these so that they have a consistent calling
  898 # format -- perhaps:
  899 #   canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
  900 
  901 sub canShowCorrectAnswers($$) {
  902   my ($permissionLevel, $answerDate) = @_;
  903   return $permissionLevel > 0 || time > $answerDate;
  904 }
  905 
  906 sub canShowSolutions($$) {
  907   my ($permissionLevel, $answerDate) = @_;
  908   return canShowCorrectAnswers($permissionLevel, $answerDate);
  909 }
  910 
  911 sub canRecordAnswers($$$$$) {
  912   my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
  913   my $permHigh = $permissionLevel > 0;
  914   my $timeOK = time >= $openDate && time <= $dueDate;
  915   my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
  916   my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
  917   return $recordAnswers;
  918 }
  919 
  920 sub canCheckAnswers($$) {
  921   my ($permissionLevel, $answerDate) = @_;
  922   my $permHigh = $permissionLevel > 0;
  923   my $timeOK = time >= $answerDate;
  924   my $recordAnswers = $permHigh || $timeOK;
  925   return $recordAnswers;
  926 }
  927 
  928 sub mustRecordAnswers($) {
  929   my ($permissionLevel) = @_;
  930   return $permissionLevel == 0;
  931 }
  932 
  933 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9