[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 1387 - (download) (as text) (annotate)
Tue Jul 15 00:56:50 2003 UTC (9 years, 10 months ago) by gage
File size: 31145 byte(s)
Changes made to make show Past answers work.  Basically I duplicated
writeLog with writeCourseLog which writes to the courses log directory.
I also defined answer_log in that directory.

    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 writeCourseLog 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 '&nbsp;&nbsp;'.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 
  471   my $answer_log    = $self->{ce}->{courseFiles}->{logs}->{'answer_log'};
  472   if ( defined($answer_log )) {
  473     if ($submitAnswers ) {
  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       writeCourseLog($self->{ce}, "answer_log",
  480               join("",
  481             '|', $problem->user_id,
  482             '|', $problem->set_id,
  483             '|', $problem->problem_id,
  484             '|',"\t",
  485             time(),"\t",
  486             $answerString,
  487           ),
  488       );
  489 
  490     }
  491   }
  492 
  493   $WeBWorK::timer0->continue("end answer processing") if $timer0_ON;
  494 
  495   ##### output #####
  496 
  497   print CGI::start_div({class=>"problemHeader"});
  498 
  499   # custom message for editor
  500   if ($permissionLevel >= 10 and defined $editMode) {
  501     if ($editMode eq "temporaryFile") {
  502       print CGI::p(CGI::i("Editing temporary file: ", $problem->source_file));
  503     } elsif ($editMode eq "savedFile") {
  504       print CGI::p(CGI::i("Problem saved to: ", $problem->source_file));
  505     }
  506   }
  507 
  508   # attempt summary
  509   if ($submitAnswers or $will{showCorrectAnswers}) {
  510     # print this if user submitted answers OR requested correct answers
  511     print $self->attemptResults($pg, $submitAnswers,
  512       $will{showCorrectAnswers},
  513       $pg->{flags}->{showPartialCorrectAnswers}, 1, 1);
  514   } elsif ($checkAnswers) {
  515     # print this if user previewed answers
  516     print $self->attemptResults($pg, 1, 0, 1, 1, 1);
  517       # show attempt answers
  518       # don't show correct answers
  519       # show attempt results (correctness)
  520       # don't show attempt previews
  521   } elsif ($previewAnswers) {
  522     # print this if user previewed answers
  523     print $self->attemptResults($pg, 1, 0, 0, 0, 1);
  524       # show attempt answers
  525       # don't show correct answers
  526       # don't show attempt results (correctness)
  527       # show attempt previews
  528   }
  529 
  530   print CGI::end_div();
  531 
  532   print CGI::start_div({class=>"problem"});
  533 
  534   # main form
  535   print
  536     CGI::startform("POST", $r->uri),
  537     $self->hidden_authen_fields,
  538     CGI::p($pg->{body_text}),
  539     CGI::p($pg->{result}->{msg} ? CGI::b("Note: ") : "", CGI::i($pg->{result}->{msg})),
  540     CGI::p(
  541       ($can{recordAnswers}
  542         ? CGI::submit(-name=>"submitAnswers",
  543           -label=>"Submit Answers")
  544         : ""),
  545       ($can{checkAnswers}
  546         ? CGI::submit(-name=>"checkAnswers",
  547           -label=>"Check Answers")
  548         : ""),
  549       CGI::submit(-name=>"previewAnswers",
  550         -label=>"Preview Answers"),
  551     );
  552   print CGI::end_div();
  553 
  554   print CGI::start_div({class=>"scoreSummary"});
  555 
  556   # score summary
  557   my $attempts = $problem->num_correct + $problem->num_incorrect;
  558   my $attemptsNoun = $attempts != 1 ? "times" : "time";
  559   my $lastScore = sprintf("%.0f%%", $problem->status * 100); # Round to whole number
  560   my ($attemptsLeft, $attemptsLeftNoun);
  561   if ($problem->max_attempts == -1) {
  562     # unlimited attempts
  563     $attemptsLeft = "unlimited";
  564     $attemptsLeftNoun = "attempts";
  565   } else {
  566     $attemptsLeft = $problem->max_attempts - $attempts;
  567     $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
  568   }
  569 
  570   my $setClosed = 0;
  571   my $setClosedMessage;
  572   if (time < $set->open_date or time > $set->due_date) {
  573     $setClosed = 1;
  574     $setClosedMessage = "This problem set is closed.";
  575     if ($permissionLevel > 0) {
  576       $setClosedMessage .= " However, since you are a privileged user, additional attempts will be recorded.";
  577     } else {
  578       $setClosedMessage .= " Additional attempts will not be recorded.";
  579     }
  580   }
  581   print CGI::p(
  582     $submitAnswers ? $scoreRecordedMessage . CGI::br() : "",
  583     "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
  584     $problem->attempted
  585       ? "Your recorded score is $lastScore." . CGI::br()
  586       : "",
  587     $setClosed ? $setClosedMessage : "You have $attemptsLeft $attemptsLeftNoun remaining."
  588   );
  589   print CGI::end_div();
  590 
  591   # save state for viewOptions
  592   print CGI::hidden(
  593       -name  => "showOldAnswers",
  594       -value => $will{showOldAnswers}
  595     ),
  596     CGI::hidden(
  597       -name  => "showCorrectAnswers",
  598       -value => $will{showCorrectAnswers}
  599     ),
  600     CGI::hidden(
  601       -name  => "showHints",
  602       -value => $will{showHints}),
  603     CGI::hidden(
  604       -name  => "showSolutions",
  605       -value => $will{showSolutions},
  606     ),
  607     CGI::hidden(
  608       -name  => "displayMode",
  609       -value => $self->{displayMode}
  610     );
  611 
  612   # end of main form
  613   print CGI::endform();
  614 
  615   # stuff we need below (pull these out at the beginning?)
  616   my $ce = $self->{ce};
  617   my $root = $ce->{webworkURLs}->{root};
  618   my $courseName = $ce->{courseName};
  619 
  620   print  CGI::start_div({class=>"problemFooter"});
  621 
  622   # arguments for answer inspection button
  623   my $prof_url = $ce->{webworkURLs}->{oldProf};
  624   my $cgi_url = $prof_url;
  625   $cgi_url=~ s|/[^/]*$||;  # clip profLogin.pl
  626   my $authen_args = $self->url_authen_args();
  627   my $showPastAnswersURL = "$cgi_url/showPastAnswers.pl";
  628 
  629   # print answer inspection button
  630   if ($self->{permissionLevel} > 0) {
  631     print "\n",
  632       CGI::start_form(-method=>"POST",-action=>$showPastAnswersURL,-target=>"information"),"\n",
  633       $self->hidden_authen_fields,"\n",
  634       CGI::hidden(-name => 'course',  -value=>$courseName), "\n",
  635       CGI::hidden(-name => 'probNum', -value=>$problem->problem_id), "\n",
  636       CGI::hidden(-name => 'setNum',  -value=>$problem->set_id), "\n",
  637       CGI::hidden(-name => 'User',    -value=>$problem->user_id), "\n",
  638       CGI::p( {-align=>"left"},
  639         CGI::submit(-name => 'action',  -value=>'Show Past Answers')
  640       ), "\n",
  641       CGI::endform();
  642   }
  643 
  644   #print CGI::end_div();
  645   #
  646   #print CGI::start_div();
  647 
  648   # arguments for feedback form
  649   my $feedbackURL = "$root/$courseName/feedback/";
  650 
  651   #print feedback form
  652   print
  653     CGI::start_form(-method=>"POST", -action=>$feedbackURL),"\n",
  654     $self->hidden_authen_fields,"\n",
  655     CGI::hidden("module",             __PACKAGE__),"\n",
  656     CGI::hidden("set",                $set->set_id),"\n",
  657     CGI::hidden("problem",            $problem->problem_id),"\n",
  658     CGI::hidden("displayMode",        $self->{displayMode}),"\n",
  659     CGI::hidden("showOldAnswers",     $will{showOldAnswers}),"\n",
  660     CGI::hidden("showCorrectAnswers", $will{showCorrectAnswers}),"\n",
  661     CGI::hidden("showHints",          $will{showHints}),"\n",
  662     CGI::hidden("showSolutions",      $will{showSolutions}),"\n",
  663     CGI::p({-align=>"left"},
  664       CGI::submit(-name=>"feedbackForm", -label=>"Contact instructor")
  665     ),
  666     CGI::endform(),"\n";
  667 
  668   # FIXME print editor link
  669   # print editor link if the user is an instructor AND the file is not in temporary editing mode
  670   if ($self->{permissionLevel}>=10 and ( (not defined($self->{edit_mode}))  or $self->{edit_mode} eq 'savedFile') ) {
  671     print CGI::a({-href=>$ce->{webworkURLs}->{root}."/$courseName/instructor/pgProblemEditor/".$set->set_id.
  672     '/'.$problem->problem_id.'?'.$self->url_authen_args},'Edit this problem');
  673   }
  674 
  675   print CGI::end_div();
  676 
  677   # warning output
  678   #if ($pg->{warnings} ne "") {
  679   # print CGI::hr(), $self->warningOutput($pg->{warnings});
  680   #}
  681 
  682   # debugging stuff
  683   if (0) {
  684     print
  685       CGI::hr(),
  686       CGI::h2("debugging information"),
  687       CGI::h3("form fields"),
  688       ref2string($self->{formFields}),
  689       CGI::h3("user object"),
  690       ref2string($self->{user}),
  691       CGI::h3("set object"),
  692       ref2string($set),
  693       CGI::h3("problem object"),
  694       ref2string($problem),
  695       CGI::h3("PG object"),
  696       ref2string($pg, {'WeBWorK::PG::Translator' => 1});
  697   }
  698 
  699   return "";
  700 }
  701 
  702 ##### output utilities #####
  703 
  704 sub attemptResults($$$$$$) {
  705   my $self = shift;
  706   my $pg = shift;
  707   my $showAttemptAnswers = shift;
  708   my $showCorrectAnswers = shift;
  709   my $showAttemptResults = $showAttemptAnswers && shift;
  710   my $showSummary = shift;
  711   my $showAttemptPreview = shift || 0;
  712   my $ce = $self->{ce};
  713   my $problemResult = $pg->{result}; # the overall result of the problem
  714   my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
  715 
  716   my $showMessages = $showAttemptAnswers && grep { $pg->{answers}->{$_}->{ans_message} } @answerNames;
  717 
  718   my $basename = "equation-" . $self->{set}->psvn. "." . $self->{problem}->problem_id . "-preview";
  719   my $imgGen = WeBWorK::PG::ImageGenerator->new(
  720     tempDir  => $ce->{webworkDirs}->{tmp},
  721     dir  => $ce->{courseDirs}->{html_temp},
  722     url  => $ce->{courseURLs}->{html_temp},
  723     basename => $basename,
  724     latex  => $ce->{externalPrograms}->{latex},
  725     dvipng   => $ce->{externalPrograms}->{dvipng},
  726   );
  727 
  728   my $header;
  729   #$header .= CGI::th("Part");
  730   $header .= $showAttemptAnswers ? CGI::th("Entered")  : "";
  731   $header .= $showAttemptPreview ? CGI::th("Answer Preview")  : "";
  732   $header .= $showCorrectAnswers ? CGI::th("Correct")  : "";
  733   $header .= $showAttemptResults ? CGI::th("Result")   : "";
  734   $header .= $showMessages       ? CGI::th("messages") : "";
  735   my @tableRows = ( $header );
  736   my $numCorrect;
  737   foreach my $name (@answerNames) {
  738     my $answerResult  = $pg->{answers}->{$name};
  739     my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
  740     my $preview       = ($showAttemptPreview
  741                           ? $self->previewAnswer($answerResult, $imgGen)
  742                           : "");
  743     my $correctAnswer = $answerResult->{correct_ans};
  744     my $answerScore   = $answerResult->{score};
  745     my $answerMessage = $showMessages ? $answerResult->{ans_message} : "";
  746 
  747     $numCorrect += $answerScore > 0;
  748     my $resultString = $answerScore ? "correct" : "incorrect";
  749 
  750     # get rid of the goofy prefix on the answer names (supposedly, the format
  751     # of the answer names is changeable. this only fixes it for "AnSwEr"
  752     $name =~ s/^AnSwEr//;
  753 
  754     my $row;
  755     #$row .= CGI::td($name);
  756     $row .= $showAttemptAnswers ? CGI::td(nbsp($studentAnswer)) : "";
  757     $row .= $showAttemptPreview ? CGI::td(nbsp($preview))       : "";
  758     $row .= $showCorrectAnswers ? CGI::td(nbsp($correctAnswer)) : "";
  759     $row .= $showAttemptResults ? CGI::td(nbsp($resultString))  : "";
  760     $row .= $answerMessage      ? CGI::td(nbsp($answerMessage)) : "";
  761     push @tableRows, $row;
  762   }
  763 
  764   # render equation images
  765   $imgGen->render(refresh => 1);
  766 
  767   my $numIncorrectNoun = scalar @answerNames == 1 ? "question" : "questions";
  768   my $scorePercent = sprintf("%.0f%%", $problemResult->{score} * 100);
  769   my $summary = "On this attempt, you answered $numCorrect out of "
  770     . scalar @answerNames . " $numIncorrectNoun correct, for a score of $scorePercent.";
  771   return CGI::table({-class=>"attemptResults"}, CGI::Tr(\@tableRows)) . ($showSummary ? CGI::p({class=>'emphasis'},$summary) : "");
  772 }
  773 sub nbsp {
  774   my $str = shift;
  775   ($str =~/\S/) ? $str : '&nbsp;'  ;  # returns non-breaking space for empty strings
  776                                       # tricky cases:   $str =0;
  777                                       #  $str is a complex number
  778 }
  779 sub viewOptions($) {
  780   my $self = shift;
  781   my $displayMode = $self->{displayMode};
  782   my %must = %{ $self->{must} };
  783   my %can  = %{ $self->{can}  };
  784   my %will = %{ $self->{will} };
  785 
  786   my $optionLine;
  787   $can{showOldAnswers} and $optionLine .= join "",
  788     "Show: &nbsp;".CGI::br(),
  789     CGI::checkbox(
  790       -name    => "showOldAnswers",
  791       -checked => $will{showOldAnswers},
  792       -label   => "Saved answers",
  793     ), "&nbsp;&nbsp;".CGI::br();
  794   $can{showCorrectAnswers} and $optionLine .= join "",
  795     CGI::checkbox(
  796       -name    => "showCorrectAnswers",
  797       -checked => $will{showCorrectAnswers},
  798       -label   => "Correct answers",
  799     ), "&nbsp;&nbsp;".CGI::br();
  800   $can{showHints} and $optionLine .= join "",
  801     CGI::checkbox(
  802       -name    => "showHints",
  803       -checked => $will{showHints},
  804       -label   => "Hints",
  805     ), "&nbsp;&nbsp;".CGI::br();
  806   $can{showSolutions} and $optionLine .= join "",
  807     CGI::checkbox(
  808       -name    => "showSolutions",
  809       -checked => $will{showSolutions},
  810       -label   => "Solutions",
  811     ), "&nbsp;&nbsp;".CGI::br();
  812   $optionLine and $optionLine .= join "", CGI::br();
  813 
  814   return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex align: left"},
  815       "View&nbsp;equations&nbsp;as:&nbsp;&nbsp;&nbsp;&nbsp;".CGI::br(),
  816     CGI::radio_group(
  817       -name    => "displayMode",
  818       -values  => ['plainText', 'formattedText', 'images'],
  819       -default => $displayMode,
  820       -linebreak=>'true',
  821       -labels  => {
  822         plainText     => "plain",
  823         formattedText => "formatted",
  824         images        => "images",
  825       }
  826     ), CGI::br(),CGI::hr(),
  827     $optionLine,
  828     CGI::submit(-name=>"redisplay", -label=>"Save Options"),
  829   );
  830 }
  831 
  832 sub previewAnswer($$) {
  833   my ($self, $answerResult, $imgGen) = @_;
  834   my $ce            = $self->{ce};
  835   my $effectiveUser = $self->{effectiveUser};
  836   my $set           = $self->{set};
  837   my $problem       = $self->{problem};
  838   my $displayMode   = $self->{displayMode};
  839 
  840   # note: right now, we have to do things completely differently when we are
  841   # rendering math from INSIDE the translator and from OUTSIDE the translator.
  842   # so we'll just deal with each case explicitly here. there's some code
  843   # duplication that can be dealt with later by abstracting out tth/dvipng/etc.
  844 
  845   my $tex = $answerResult->{preview_latex_string};
  846 
  847   return "" unless defined $tex and $tex ne "";
  848 
  849   if ($displayMode eq "plainText") {
  850     return $tex;
  851   } elsif ($displayMode eq "formattedText") {
  852     my $tthCommand = $ce->{externalPrograms}->{tth}
  853       . " -L -f5 -r 2> /dev/null <<END_OF_INPUT; echo > /dev/null\n"
  854       . "\\(".$tex."\\)\n"
  855       . "END_OF_INPUT\n";
  856 
  857     # call tth
  858     my $result = `$tthCommand`;
  859     if ($?) {
  860       return "<b>[tth failed: $? $@]</b>";
  861     }
  862     return $result;
  863   } elsif ($displayMode eq "images") {
  864     ## how are we going to name this?
  865     #my $targetPathCommon = "/m2i/"
  866     # . $effectiveUser->user_id . "."
  867     # . $set->set_id . "."
  868     # . $problem->problem_id . "."
  869     # . $answerResult->{ans_name} . ".png";
  870     #
  871     ## figure out where to put things
  872     #my $wd = makeTempDirectory($ce->{courseDirs}->{html_temp}, "webwork-dvipng");
  873     #my $latex = $ce->{externalPrograms}->{latex};
  874     #my $dvipng = $ce->{externalPrograms}->{dvipng};
  875     #my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
  876     #   # should use surePathToTmpFile, but we have to
  877     #   # isolate it from the problem enivronment first
  878     #my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
  879     #
  880     ## call dvipng to generate a preview
  881     #dvipng($wd, $latex, $dvipng, $tex, $targetPath);
  882     #rmtree($wd, 0, 0);
  883     #if (-e $targetPath) {
  884     # return "<img src=\"$targetURL\" alt=\"$tex\" />";
  885     #} else {
  886     # return "<b>[math2img failed]</b>";
  887     #}
  888     $imgGen->add($answerResult->{preview_latex_string});
  889 
  890   }
  891 }
  892 
  893 ##### logging subroutine ####
  894 
  895 
  896 
  897 ##### permission queries #####
  898 
  899 # this stuff should be abstracted out into the permissions system
  900 # however, the permission system only knows about things in the
  901 # course environment and the username. hmmm...
  902 
  903 # also, i should fix these so that they have a consistent calling
  904 # format -- perhaps:
  905 #   canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
  906 
  907 sub canShowCorrectAnswers($$) {
  908   my ($permissionLevel, $answerDate) = @_;
  909   return $permissionLevel > 0 || time > $answerDate;
  910 }
  911 
  912 sub canShowSolutions($$) {
  913   my ($permissionLevel, $answerDate) = @_;
  914   return canShowCorrectAnswers($permissionLevel, $answerDate);
  915 }
  916 
  917 sub canRecordAnswers($$$$$) {
  918   my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
  919   my $permHigh = $permissionLevel > 0;
  920   my $timeOK = time >= $openDate && time <= $dueDate;
  921   my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
  922   my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
  923   return $recordAnswers;
  924 }
  925 
  926 sub canCheckAnswers($$) {
  927   my ($permissionLevel, $answerDate) = @_;
  928   my $permHigh = $permissionLevel > 0;
  929   my $timeOK = time >= $answerDate;
  930   my $recordAnswers = $permHigh || $timeOK;
  931   return $recordAnswers;
  932 }
  933 
  934 sub mustRecordAnswers($) {
  935   my ($permissionLevel) = @_;
  936   return $permissionLevel == 0;
  937 }
  938 
  939 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9