[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 1000 - (download) (as text) (annotate)
Tue Jun 3 22:27:16 2003 UTC (9 years, 11 months ago) by gage
File size: 28156 byte(s)
The conversion of set and problem from global to global-user now works.
You will get "pink screen" errors for now because not all of the vaules
in problem have been given correct defaults.
I'll do that next.

--Mike

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9