[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 1495 - (download) (as text) (annotate)
Tue Sep 9 02:56:49 2003 UTC (9 years, 9 months ago) by gage
File size: 32500 byte(s)
Added logic to show the checkAnswer button when you are
a professor or TA acting as a student.  This allows you
to check the answer without recording results. (I think)

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9