[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 1227 - (download) (as text) (annotate)
Fri Jun 20 01:18:33 2003 UTC (9 years, 11 months ago) by sh002i
File size: 30337 byte(s)
misc warning elimination, added message to tell you if your score was
recorded.

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9