[system] / trunk / webwork2 / lib / WeBWorK / ContentGenerator / Problem.pm Repository:
ViewVC logotype

Diff of /trunk/webwork2/lib/WeBWorK/ContentGenerator/Problem.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 399 Revision 623
1################################################################################
2# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
3# $Id$
4################################################################################
5
1package WeBWorK::ContentGenerator::Problem; 6package WeBWorK::ContentGenerator::Problem;
2our @ISA = qw(WeBWorK::ContentGenerator); 7
8=head1 NAME
9
10WeBWorK::ContentGenerator::Problem - Allow a student to interact with a problem.
11
12=cut
3 13
4use strict; 14use strict;
5use warnings; 15use warnings;
6use lib '/home/malsyned/xmlrpc/daemon';
7use lib '/Users/gage/webwork-modperl/lib';
8use PGtranslator5;
9use WeBWorK::ContentGenerator; 16use base qw(WeBWorK::ContentGenerator);
10use Apache::Constants qw(:common); 17use CGI qw();
18use File::Temp qw(tempdir);
19use WeBWorK::Form;
20use WeBWorK::PG;
21use WeBWorK::PG::IO;
22use WeBWorK::Utils qw(writeLog encodeAnswers decodeAnswers ref2string);
11 23
12############################################################################### 24############################################################
13# Configuration 25#
26# user
27# key
28#
29# displayMode
30# showOldAnswers
31# showCorrectAnswers
32# showHints
33# showSolutions
34#
35# AnSwEr# - answer blanks in problem
36#
37# redisplay - name of the "Redisplay Problem" button
38# submitAnswers - name of "Submit Answers" button
39#
14############################################################################### 40############################################################
15my $USER_DIRECTORY = '/Users/gage';
16my $COURSE_SCRIPTS_DIRECTORY = "$USER_DIRECTORY/webwork/system/courseScripts/";
17my $MACRO_DIRECTORY = "$USER_DIRECTORY/webwork-modperl/courses/demoCourse/templates/macros/";
18my $TEMPLATE_DIRECTORY = "$USER_DIRECTORY/rochester_problib/";
19my $TEMP_URL = "http://127.0.0.1/~gage/rochester_problibtmp/";
20##my $HTML_DIRECTORY = "/Users/gage/Sites/rochester_problib/" #already obtained from courseEnvironment
21my $HTML_URL = "http://127.0.0.1/~gage/rochester_problib/";
22my $TEMP_DIRECTORY = ""; # has to be here... for now
23 41
24############################################################################### 42sub pre_header_initialize {
25# End configuration 43 my ($self, $setName, $problemNumber) = @_;
26############################################################################### 44 my $courseEnv = $self->{courseEnvironment};
45 my $r = $self->{r};
46 my $userName = $r->param('user');
47
48 ##### database setup #####
49
50 my $cldb = WeBWorK::DB::Classlist->new($courseEnv);
51 my $wwdb = WeBWorK::DB::WW->new($courseEnv);
52 my $authdb = WeBWorK::DB::Auth->new($courseEnv);
53
54 my $user = $cldb->getUser($userName);
55 my $set = $wwdb->getSet($userName, $setName);
56 my $problem = $wwdb->getProblem($userName, $setName, $problemNumber);
57 my $psvn = $wwdb->getPSVN($userName, $setName);
58 my $permissionLevel = $authdb->getPermissions($userName);
59
60 ##### form processing #####
61
62 # set options from form fields (see comment at top of file for names)
63 my $displayMode = $r->param("displayMode") || $courseEnv->{pg}->{options}->{displayMode};
64 my $redisplay = $r->param("redisplay");
65 my $submitAnswers = $r->param("submitAnswers");
66 my $previewAnswers = $r->param("previewAnswers");
67
68 # coerce form fields into CGI::Vars format
69 my $formFields = { WeBWorK::Form->new_from_paramable($r)->Vars };
70
71 ##### permissions #####
72
73 # what does the user want to do?
74 my %want = (
75 showOldAnswers => $r->param("showOldAnswers") || $courseEnv->{pg}->{options}->{showOldAnswers},
76 showCorrectAnswers => $r->param("showCorrectAnswers") || $courseEnv->{pg}->{options}->{showCorrectAnswers},
77 showHints => $r->param("showHints") || $courseEnv->{pg}->{options}->{showHints},
78 showSolutions => $r->param("showSolutions") || $courseEnv->{pg}->{options}->{showSolutions},
79 recordAnswers => $r->param("recordAnswers") || 1,
80 );
81
82 # are certain options enforced?
83 my %must = (
84 showOldAnswers => 0,
85 showCorrectAnswers => 0,
86 showHints => 0,
87 showSolutions => 0,
88 recordAnswers => mustRecordAnswers($permissionLevel),
89 );
90
91 # does the user have permission to use certain options?
92 my %can = (
93 showOldAnswers => 1,
94 showCorrectAnswers => canShowCorrectAnswers($permissionLevel, $set->answer_date),
95 showHints => 1,
96 showSolutions => canShowSolutions($permissionLevel, $set->answer_date),
97 recordAnswers => canRecordAnswers($permissionLevel, $set->open_date, $set->due_date,
98 $problem->max_attempts, $problem->num_correct + $problem->num_incorrect + 1),
99 # num_correct+num_incorrect+1 -- as this happens before updating $problem
100 );
101
102 # final values for options
103 my %will;
104 foreach (keys %must) {
105 $will{$_} = $can{$_} && ($want{$_} || $must{$_});
106 #warn "$_: can? $can{$_} want? $want{$_} must? $must{$_} will? $will{$_}\n";
107 }
108
109 ##### sticky answers #####
110
111 if (not $submitAnswers and $will{showOldAnswers}) {
112 # do this only if new answers are NOT being submitted
113 my %oldAnswers = decodeAnswers($problem->last_answer);
114 $formFields->{$_} = $oldAnswers{$_} foreach keys %oldAnswers;
115 }
116
117 ##### translation #####
118
119 my $pg = WeBWorK::PG->new(
120 $courseEnv,
121 $user,
122 $r->param('key'),
123 $set,
124 $problem,
125 $psvn,
126 $formFields,
127 { # translation options
128 displayMode => $displayMode,
129 showHints => $will{showHints},
130 showSolutions => $will{showSolutions},
131 refreshMath2img => $will{showHints} || $will{showSolutions},
132 # try leaving processAnswers on all the time?
133 processAnswers => 1, #$submitAnswers ? 1 : 0,
134 },
135 );
136
137 ##### store fields #####
138
139 $self->{cldb} = $cldb;
140 $self->{wwdb} = $wwdb;
141 $self->{authdb} = $authdb;
142
143 $self->{user} = $user;
144 $self->{set} = $set;
145 $self->{problem} = $problem;
146 $self->{permissionLevel} = $permissionLevel;
147
148 $self->{displayMode} = $displayMode;
149 $self->{redisplay} = $redisplay;
150 $self->{submitAnswers} = $submitAnswers;
151 $self->{previewAnswers} = $previewAnswers;
152 $self->{formFields} = $formFields;
153
154 $self->{want} = \%want;
155 $self->{must} = \%must;
156 $self->{can} = \%can;
157 $self->{will} = \%will;
158
159 $self->{pg} = $pg;
160}
161
162sub if_warnings($$) {
163 my ($self, $arg) = @_;
164 return $self->{pg}->{warnings} ne "";
165}
166
167sub if_errors($$) {
168 my ($self, $arg) = @_;
169 return $self->{pg}->{flags}->{error_flag};
170}
171
172sub head {
173 my $self = shift;
174
175 return $self->{pg}->{head_text} if $self->{pg}->{head_text};
176}
177
178sub path {
179 my $self = shift;
180 my $args = $_[-1];
181 my $setName = $self->{set}->id;
182 my $problemNumber = $self->{problem}->id;
183
184 my $ce = $self->{courseEnvironment};
185 my $root = $ce->{webworkURLs}->{root};
186 my $courseName = $ce->{courseName};
187 return $self->pathMacro($args,
188 "Home" => "$root",
189 $courseName => "$root/$courseName",
190 $setName => "$root/$courseName/$setName",
191 "Problem $problemNumber" => "",
192 );
193}
194
195sub siblings {
196 my $self = shift;
197 my $setName = $self->{set}->id;
198 my $problemNumber = $self->{problem}->id;
199
200 my $ce = $self->{courseEnvironment};
201 my $root = $ce->{webworkURLs}->{root};
202 my $courseName = $ce->{courseName};
203
204 print CGI::strong("Problems"), CGI::br();
205
206 my $wwdb = $self->{wwdb};
207 my $user = $self->{r}->param("user");
208 my @problems;
209 push @problems, $wwdb->getProblem($user, $setName, $_)
210 foreach ($wwdb->getProblems($user, $setName));
211 foreach my $problem (sort { $a->id <=> $b->id } @problems) {
212 print CGI::a({-href=>"$root/$courseName/$setName/".$problem->id."/?"
213 . $self->url_authen_args}, "Problem ".$problem->id), CGI::br();
214 }
215}
216
217sub nav {
218 my $self = shift;
219 my $args = $_[-1];
220 my $setName = $self->{set}->id;
221 my $problemNumber = $self->{problem}->id;
222
223 my $ce = $self->{courseEnvironment};
224 my $root = $ce->{webworkURLs}->{root};
225 my $courseName = $ce->{courseName};
226
227 my $wwdb = $self->{wwdb};
228 my $user = $self->{r}->param("user");
229
230 my @links = ("Problem List" => "$root/$courseName/$setName");
231
232 my $prevProblem = $wwdb->getProblem($user, $setName, $problemNumber-1);
233 my $nextProblem = $wwdb->getProblem($user, $setName, $problemNumber+1);
234 unshift @links, "Previous Problem" => $prevProblem
235 ? "$root/$courseName/$setName/".$prevProblem->id
236 : "";
237 push @links, "Next Problem" => $nextProblem
238 ? "$root/$courseName/$setName/".$nextProblem->id
239 : "";
240
241 return $self->navMacro($args, @links);
242}
27 243
28sub title { 244sub title {
29 my ($self, $problem_set, $problem) = @_; 245 my $self = shift;
30 my $r = $self->{r}; 246 my $setName = $self->{set}->id;
31 my $user = $r->param('user'); 247 my $problemNumber = $self->{problem}->id;
32 return "Problem $problem of problem set $problem_set for $user"; 248
249 return "$setName : Problem $problemNumber";
33} 250}
34 251
35############################################################################### 252sub body {
36# 253 my $self = shift;
37# INITIALIZATION 254
38# 255 # unpack some useful variables
39# The following code initializes an instantiation of PGtranslator5 in the 256 my $r = $self->{r};
40# parent process. This initialized object is then share with each of the 257 my $wwdb = $self->{wwdb};
41# children forked from this parent process by the daemon. 258 my $set = $self->{set};
42# 259 my $problem = $self->{problem};
43# As far as I can tell, the child processes don't share any variable values even 260 my $permissionLevel = $self->{permissionLevel};
44# though their namespaces are the same. 261 my $submitAnswers = $self->{submitAnswers};
45############################################################################### 262 my $previewAnswers = $self->{previewAnswers};
46# First some dummy values to use for testing. 263 my %will = %{ $self->{will} };
47# These should be available from the problemEnvironment(it might be ok to assume that PG and dangerousMacros 264 my $pg = $self->{pg};
48# live in the courseScripts (system level macros) directory. 265
49 266 ##### translation errors? #####
50#print STDERR "Begin intitalization\n"; 267
51my $dummy_envir = { courseScriptsDirectory => $COURSE_SCRIPTS_DIRECTORY, 268 if ($pg->{flags}->{error_flag}) {
52 displayMode => 'HTML_tth', 269 return translationError($pg->{errors}, $pg->{body_text});
53 macroDirectory => $MACRO_DIRECTORY, 270 }
54 cgiURL => 'foo_cgiURL'}; 271
55 272 ##### answer processing #####
56 273
57my $PG_PL = "${COURSE_SCRIPTS_DIRECTORY}PG.pl"; 274 # if answers were submitted:
58my $DANGEROUS_MACROS_PL = "${COURSE_SCRIPTS_DIRECTORY}dangerousMacros.pl"; 275 if ($submitAnswers) {
59my @MODULE_LIST = ( "Exporter", "DynaLoader", "GD", "WWPlot", "Fun", 276 # store answers in DB for sticky answers
60 "Circle", "Label", "PGrandom", "Units", "Hermite", 277 my %answersToStore;
61 "List", "Match","Multiple", "Select", "AlgParser", 278 my %answerHash = %{ $pg->{answers} };
62 "AnswerHash", "Fraction", "VectorField", "Complex1", 279 $answersToStore{$_} = $answerHash{$_}->{original_student_ans}
63 "Complex", "MatrixReal1", "Matrix","Distributions", 280 foreach (keys %answerHash);
64 "Regression" 281 my $answerString = encodeAnswers(%answersToStore,
65); 282 @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} });
66my @EXTRA_PACKAGES = ( "AlgParserWithImplicitExpand", "Expr", 283 $problem->last_answer($answerString);
67 "ExprWithImplicitExpand", "AnswerEvaluator", 284 $wwdb->setProblem($problem);
68
69);
70my $INITIAL_MACRO_PACKAGES = <<END_OF_TEXT;
71 DOCUMENT();
72 loadMacros(
73 "PGbasicmacros.pl",
74 "PGchoicemacros.pl",
75 "PGanswermacros.pl",
76 "PGnumericalmacros.pl",
77 "PGgraphmacros.pl",
78 "PGauxiliaryFunctions.pl",
79 "PGmatrixmacros.pl",
80 "PGcomplexmacros.pl",
81 "PGstatisticsmacros.pl"
82 285
286 # store state in DB if it makes sense
287 if ($will{recordAnswers}) {
288 $problem->attempted(1);
289 $problem->status($pg->{state}->{recorded_score});
290 $problem->num_correct($pg->{state}->{num_of_correct_ans});
291 $problem->num_incorrect($pg->{state}->{num_of_incorrect_ans});
292 $wwdb->setProblem($problem);
293 # write to the transaction log, just to make sure
294 writeLog($self->{courseEnvironment}, "transaction",
295 $problem->id."\t".
296 $problem->set_id."\t".
297 $problem->login_id."\t".
298 $problem->source_file."\t".
299 $problem->value."\t".
300 $problem->max_attempts."\t".
301 $problem->problem_seed."\t".
302 $problem->status."\t".
303 $problem->attempted."\t".
304 $problem->last_answer."\t".
305 $problem->num_correct."\t".
306 $problem->num_incorrect
83 ); 307 );
308 }
309 }
310
311 ##### output #####
312
313 # attempt summary
314 if ($submitAnswers or $will{showCorrectAnswers}) {
315 # print this if user submitted answers OR requested correct answers
316 print $self->attemptResults($pg, $submitAnswers, $will{showCorrectAnswers},
317 $pg->{flags}->{showPartialCorrectAnswers});
318 } elsif ($previewAnswers) {
319 # print this if user previewed answers
320 print $self->attemptResults($pg, 1, 0, 0);
321 # don't show correctness
322 # don't show correct answers
323 }
324
325 # score summary
326 my $attempts = $problem->num_correct + $problem->num_incorrect;
327 my $attemptsNoun = $attempts != 1 ? "times" : "time";
328 my $lastScore = int ($problem->status * 100) . "%";
329 my ($attemptsLeft, $attemptsLeftNoun);
330 if ($problem->max_attempts == -1) {
331 # unlimited attempts
332 $attemptsLeft = "unlimited";
333 $attemptsLeftNoun = "attempts";
334 } else {
335 $attemptsLeft = $problem->max_attempts - $attempts;
336 $attemptsLeftNoun = $attemptsLeft == 1 ? "attempt" : "attempts";
337 }
338 my $setClosedMessage;
339 if (time < $set->open_date or time > $set->due_date) {
340 $setClosedMessage = "This problem set is closed.";
341 if ($permissionLevel > 0) {
342 $setClosedMessage .= " Since you are a privileged user, additional attempts will be recorded.";
343 } else {
344 $setClosedMessage .= " Additional attempts will not be recorded.";
345 }
346 }
347 print CGI::p(
348 "You have attempted this problem $attempts $attemptsNoun.", CGI::br(),
349 $problem->attempted
350 ? "Your recorded score is $lastScore." . CGI::br()
351 : "",
352 "You have $attemptsLeft $attemptsLeftNoun remaining.", CGI::br(),
353 $setClosedMessage,
354 );
355
356 # BY THE WAY..........
357 # we have to figure out some way to tell the student if their NEW answer,
358 # on THIS attempt, has been recorded. however, this is decided in part by
359 # the grader, so is there any way for us to know? we can rule out several
360 # cases where the answer is NOT being recorded, because of things decided
361 # in &canRecordAnswers...
362
363 print CGI::hr();
364
365 # main form
366 print
367 CGI::startform("POST", $r->uri),
368 $self->hidden_authen_fields,
369 $self->viewOptions,
370 CGI::p(CGI::i($pg->{result}->{msg})),
371 CGI::p($pg->{body_text}),
372 CGI::p(
373 CGI::submit(-name=>"submitAnswers", -label=>"Submit Answers"),
374 CGI::submit(-name=>"previewAnswers", -label=>"Preview Answers"),
375 ),
376 CGI::endform();
377
378 # warning output
379 if ($pg->{warnings} ne "") {
380 print CGI::hr(), warningOutput($pg->{warnings});
381 }
382
383 # debugging stuff
384 print
385 CGI::hr(),
386 CGI::h2("debugging information"),
387 CGI::h3("form fields"),
388 ref2string($self->{formFields}),
389 CGI::h3("user object"),
390 ref2string($self->{user}),
391 CGI::h3("set object"),
392 ref2string($set),
393 CGI::h3("problem object"),
394 ref2string($problem),
395 CGI::h3("PG object"),
396 ref2string($pg, {'WeBWorK::PG::Translator' => 1});
397
398 return "";
399}
400
401##### output utilities #####
402
403# this is used by ProblemSet.pm too, so don't fuck it up
404sub translationError($$) {
405 my ($error, $details) = @_;
406 return
407 CGI::h2("Software Error"),
408 CGI::p(<<EOF),
409WeBWorK has encountered a software error while attempting to process this problem.
410It is likely that there is an error in the problem itself.
411If you are a student, contact your professor to have the error corrected.
412If you are a professor, please consut the error output below for more informaiton.
413EOF
414 CGI::h3("Error messages"), CGI::blockquote(CGI::pre($error)),
415 CGI::h3("Error context"), CGI::blockquote(CGI::pre($details));
416}
417
418# this is used by ProblemSet.pm too, so don't fuck it up
419sub warningOutput($) {
420 my $warnings = shift;
421
422 return
423 CGI::h2("Software Warnings"),
424 CGI::p(<<EOF),
425WeBWorK has encountered warnings while attempting to process this problem.
426It is likely that this indicates an error or ambiguity in the problem itself.
427If you are a student, contact your professor to have the problem corrected.
428If you are a professor, please consut the error output below for more informaiton.
429EOF
430 CGI::h3("Warning messages"),
431 CGI::blockquote(CGI::pre($warnings)),
432 ;
433}
434
435sub attemptResults($$$$$) {
436 my $self = shift;
437 my $pg = shift;
438 my $showAttemptAnswers = shift;
439 my $showCorrectAnswers = shift;
440 my $showAttemptResults = $showAttemptAnswers && shift;
441 my $problemResult = $pg->{result}; # the overall result of the problem
442 my @answerNames = @{ $pg->{flags}->{ANSWER_ENTRY_ORDER} };
443
444 my $header = CGI::th("answer");
445 $header .= $showAttemptAnswers ? CGI::th("attempt") : "";
446 $header .= $showAttemptAnswers ? CGI::th("preview") : "";
447 $header .= $showCorrectAnswers ? CGI::th("correct") : "";
448 $header .= $showAttemptResults ? CGI::th("result") : "";
449 $header .= $showAttemptAnswers ? CGI::th("messages") : "";
450 my @tableRows = ( $header );
451 my $numCorrect;
452 foreach my $name (@answerNames) {
453 my $answerResult = $pg->{answers}->{$name};
454 my $studentAnswer = $answerResult->{student_ans}; # original_student_ans
455 my $preview = $self->previewAnswer($answerResult);
456 my $correctAnswer = $answerResult->{correct_ans};
457 my $answerScore = $answerResult->{score};
458 my $answerMessage = $showAttemptAnswers ? $answerResult->{ans_message} : "";
84 459
85 TEXT("Hello world"); 460 $numCorrect += $answerScore > 0;
461 my $resultString = $answerScore ? "correct" : "incorrect";
86 462
87 ENDDOCUMENT(); 463 # get rid of the goofy prefix on the answer names (supposedly, the format
88 464 # of the answer names is changeable. this only fixes
89END_OF_TEXT 465 $name =~ s/^AnSwEr//;
466
467 my $row = CGI::td($name);
468 $row .= $showAttemptAnswers ? CGI::td($studentAnswer) : "";
469 $row .= $showAttemptAnswers ? CGI::td($preview) : "";
470 $row .= $showCorrectAnswers ? CGI::td($correctAnswer) : "";
471 $row .= $showAttemptResults ? CGI::td($resultString) : "";
472 $row .= $answerMessage ? CGI::td($answerMessage) : "";
473 push @tableRows, $row;
474 }
90 475
91#These here documents have their drawbacks. KEEP END_OF_TEXT left justified!!!!!! 476 my $numCorrectNoun = $numCorrect == 1 ? "question" : "questions";
477 my $scorePercent = int ($problemResult->{score} * 100) . "\%";
478 my $summary = "On this attempt, you answered $numCorrect $numCorrectNoun out of "
479 . scalar @answerNames . " correct, for a score of $scorePercent.";
480 return CGI::table({-border=>1}, CGI::Tr(\@tableRows)) . CGI::p($summary);
481}
92 482
93############################################################################### 483sub viewOptions($) {
94# Now to define the body subroutine which does the hard work. 484 my $self = shift;
95############################################################################### 485 my $displayMode = $self->{displayMode};
96 486 my %must = %{ $self->{must} };
97 487 my %can = %{ $self->{can} };
98#my $SOURCE1 = $INITIAL_MACRO_PACKAGES; 488 my %will = %{ $self->{will} };
99
100sub body {
101 my ($self, $problem_set, $problem) = @_;
102 my $r = $self->{r};
103 my $courseEnvironment = $self->{courseEnvironment};
104 my $user = $r->param('user');
105 489
106 my $rh = {}; # this needs to be set to a hash containing CGI params 490 my $optionLine;
491 $can{showOldAnswers} and $optionLine .= join "",
492 "Show: &nbsp;",
493 CGI::checkbox(
494 -name => "showOldAnswers",
495 -checked => $will{showOldAnswers},
496 -label => "Saved answers",
497 ), "&nbsp;&nbsp;";
498 $can{showCorrectAnswers} and $optionLine .= join "",
499 CGI::checkbox(
500 -name => "showCorrectAnswers",
501 -checked => $will{showCorrectAnswers},
502 -label => "Correct answers",
503 ), "&nbsp;&nbsp;";
504 $can{showHints} and $optionLine .= join "",
505 CGI::checkbox(
506 -name => "showHints",
507 -checked => $will{showHints},
508 -label => "Hints",
509 ), "&nbsp;&nbsp;";
510 $can{showSolutions} and $optionLine .= join "",
511 CGI::checkbox(
512 -name => "showSolutions",
513 -checked => $will{showSolutions},
514 -label => "Solutions",
515 ), "&nbsp;&nbsp;";
516 $optionLine and $optionLine .= join "", CGI::br();
107 517
108 518 return CGI::div({-style=>"border: thin groove; padding: 1ex; margin: 2ex"},
109 my $SOURCE1 = readFile("$problem_set/$problem.pg"); 519 "View equations as: &nbsp;",
110 print STDERR "SOURCEFILE: \n$SOURCE1\n\n"; 520 CGI::radio_group(
111 521 -name => "displayMode",
112 ########################################################################### 522 -values => ['plainText', 'formattedText', 'images'],
113 # The pg problem class should have a method for installing it's problemEnvironment 523 -default => $displayMode,
114 ########################################################################### 524 -labels => {
115 525 plainText => "plain text",
116 my $problemEnvir_rh = defineProblemEnvir($self); 526 formattedText => "formatted text",
117 527 images => "images",
118
119 ##################################################################################
120 # Prime the PGtranslator object and set it loose
121 ##################################################################################
122
123
124 ###############################################################################
125 528 }
126 ############################################################################### 529 ), CGI::br(),
127 #Create the PG translator. 530 $optionLine,
128 ############################################################################### 531 CGI::submit(-name=>"redisplay", -label=>"Redisplay Problem"),
129
130 my $pt = new PGtranslator5; #pt stands for problem translator;
131
132
133 # All of these hard coded directories need to be drawn from courseEnvironment.
134 # In addition I don't think that PGtranslator uses this stack internally yet.
135 # Passing these directories through the problemEnvironment variable is what
136 # is currently being done, but I don't think it is quite right, at least for most
137 # of them.
138
139
140 $pt ->rh_directories( { courseScriptsDirectory => $COURSE_SCRIPTS_DIRECTORY,
141 macroDirectory => $MACRO_DIRECTORY,
142 ,
143 templateDirectory => $TEMPLATE_DIRECTORY,
144 tempDirectory => $TEMP_DIRECTORY,
145 }
146 ); 532 );
147
148 ###############################################################################
149 # First we load the modules from courseScripts directory.
150 # These do the "heavy lifting" in terms of formatting, creating graphs, and
151 # performing other heavy duty algorithms.
152 #
153 ###############################################################################
154
155 $pt -> evaluate_modules( @MODULE_LIST);
156 $pt -> load_extra_packages( @EXTRA_PACKAGES );
157
158 ###############################################################################
159 # Load the environment constants. Some are used by the PGtranslator object but
160 # most of them are installed inside the Safe compartment where the problem
161 # runs.
162 ###############################################################################
163 #$pt -> environment($dummy_envir);
164 $pt -> environment($problemEnvir_rh);
165
166
167 # I've forgotten what this does exactly :-)
168 $pt->initialize();
169
170 ###############################################################################
171 # PG.pl contains the basic code which defines the problem interface, input and output.
172 # dangerousMacros.pl contains subroutines which have access to the hard drive and
173 # and the directory structure. All use of external resources by the problem is supposed
174 # to go through these subroutines. The idea is to put the potentially dangerous
175 # algorithms in on place so they can be watched closely.
176 # These two files are evaluated in the Safe compartment without any restrictions.
177 # They have full use of the perl commands.
178 ###############################################################################
179 my $loadErrors = $pt -> unrestricted_load($PG_PL );
180 print STDERR "$loadErrors\n" if ($loadErrors);
181 $loadErrors = $pt -> unrestricted_load($DANGEROUS_MACROS_PL);
182 print STDERR "$loadErrors\n" if ($loadErrors);
183
184 ###############################################################################
185 # Now set the mask to restrict the operations which can be performed within
186 # a problem or a macro file.
187 ###############################################################################
188 $pt-> set_mask();
189
190 # print "\nPG.pl: $PG_PL<br>\n";
191 # print "DANGEROUS_MACROS_PL: $DANGEROUS_MACROS_PL<br>\n";
192 # print "Print dummy environment<br>\n";
193 # print pretty_print_rh($dummy_envir), "<p>\n\n";
194
195 # Read in the source code for the problem
196
197 #$INITIAL_MACRO_PACKAGES =~ tr /\r/\n/; # change everything to unix line endings.
198 $SOURCE1 =~ tr /\r/\n/;
199 #print STDERR "Source again \n $SOURCE1";
200 $pt->source_string( $SOURCE1 );
201
202 ###############################################################################
203 # Install a safety filter for screening student answers. The default is now the blank
204 # filter since the answer evaluators do a pretty good job of recompiling and screening
205 # student's answers. Still, you could prohibit back ticks, or something of the kind.
206 ###############################################################################
207
208 $pt ->rf_safety_filter( \&safetyFilter); # install blank safety filter
209
210
211 print STDERR "New PGtranslator object inititialization completed.<br>\n";
212 ################################################################################
213 ## This ends the initialization of the PGtranslator object
214 ################################################################################
215
216
217 ################################################################################
218 # Run the problem (output the html text) but also store it within the object.
219 # The correct answers are also calculated and stored within the object
220 ################################################################################
221 $pt ->translate();
222
223 #print problem output
224 print "Problem goes here<p>\n";
225 print "Problem output <br>\n";
226 print "################################################################################<br><br>";
227 print ${$pt->r_text()};
228 print "<br><br>################################################################################<br>";
229 print "<p>End of problem output<br>";
230
231
232 #print source code
233 print "Source code<pre>\n";
234 print $SOURCE1;
235 print "</pre>End source code<p>";
236 ################################################################################
237 # The format for the output is described here. We'll need a local variable
238 # to handle the warnings. From within the problem the warning command
239 # has been slaved to the __WARNINGS__ routine which is defined in Global.
240 # We'll need to provide an alternate mechanism.
241 # The base64 encoding is only needed for xml transmission.
242 ################################################################################
243 print "################################################################################<br>";
244 print "Warnings output<br>";
245 my $WARNINGS = "Let this be a warning:";
246
247 print $WARNINGS;
248
249 ################################################################################
250 # Install the standard problem grader. See gage/xmlrpc/daemon.pm or processProblem8 for detailed
251 # code on how to choose which problem grader to install, depending on courseEnvironment and problem data.
252 # See also PG.pl which provides for problem by problem overrides.
253 ################################################################################
254
255 $pt->rf_problem_grader($pt->rf_std_problem_grader);
256
257 ################################################################################
258 # creates and stores a hash of answer results inside the object: $rh_answer_results
259 ################################################################################
260 $pt -> process_answers($rh->{envir}->{inputs_ref});
261
262
263 # THE UPDATE AND GRADING LOGIC COULD USE AN OVERHAUL. IT WAS SOMEWHAT CONSTRAINED
264 # BY LEGACY CONDITIONS IN THE ORIGINAL PROCESSPROBLEM8. IT'S NOT BAD
265 # BUT IT COULD PROBABLY BE MADE A LITTLE MORE STRAIGHT FORWARD.
266 ################################################################################
267 # updates the problem state stored by the translator object from the problemEnvironment data
268 ################################################################################
269
270 # $pt->rh_problem_state({ recorded_score => $rh->{problem_state}->{recorded_score},
271 # num_of_correct_ans => $rh->{problem_state}->{num_of_correct_ans} ,
272 # num_of_incorrect_ans => $rh->{problem_state}->{num_of_incorrect_ans}
273 # } );
274 ################################################################################
275 # grade the problem (and update the problem state again.)
276 ################################################################################
277
278 # Define an entry order -- the default is the order they are received from the browser.
279 # (Which as I understand it is NOT guaranteed to be the Left->Right Up-> Down order we're
280 # used to in the West.
281
282 my %PG_FLAGS = $pt->h_flags;
283 my $ra_answer_entry_order = ( defined($PG_FLAGS{ANSWER_ENTRY_ORDER}) ) ?
284 $PG_FLAGS{ANSWER_ENTRY_ORDER} : [ keys %{$pt->rh_evaluated_answers} ] ;
285 # Decide whether any answers were submitted.
286 my $answers_submitted = 0;
287 $answers_submitted = 1 if defined( $rh->{answer_form_submitted} ) and 1 == $rh->{answer_form_submitted};
288 # If there are answers, grade them
289 my ($rh_problem_result,$rh_problem_state) = $pt->grade_problem( answers_submitted => $answers_submitted,
290 ANSWER_ENTRY_ORDER => $ra_answer_entry_order
291 ); # grades the problem.
292
293 # Output format expected by Webwork.pm (and I believe processProblem8, but check.)
294 my $out = {
295 text => ${$pt ->r_text()}, # encode_base64( ${$pt ->r_text()} ),
296 header_text => $pt->r_header, # encode_base64( ${ $pt->r_header } ),
297 answers => $pt->rh_evaluated_answers,
298 errors => $pt-> errors(),
299 WARNINGS => $WARNINGS, #encode_base64($WARNINGS ),
300 problem_result => $rh_problem_result,
301 problem_state => $rh_problem_state,
302 PG_flag => \%PG_FLAGS
303 };
304 ##########################################################################################
305 # Debugging printout of environment tables
306 ##########################################################################################
307
308 print "<P>Request item<P>\n\n";
309 print "<TABLE border=\"3\">";
310 print $self->print_form_data('<tr><td>','</td><td>','</td></tr>');
311 print "</table>\n";
312 print "path info <br>\n";
313 print $r->path_info();
314 print "<P>\n\ncourseEnvironment<P>\n\n";
315 print pretty_print_rh($courseEnvironment);
316 print "<P>\n\nproblemEnvironment<P>\n\n";
317 print pretty_print_rh($problemEnvir_rh);
318
319 ##########################################################################################
320 # End
321 ##########################################################################################
322 "";
323} 533}
324# End the"body" routine for the Problem object.
325 534
326 535sub previewAnswer($$) {
327sub safetyFilter { 536 my ($self, $answerResult) = @_;
328 my $answer = shift; # accepts one answer and checks it 537 my $ce = $self->{courseEnvironment};
329 my $submittedAnswer = $answer;
330 $answer = '' unless defined $answer;
331 my ($errorno);
332 $answer =~ tr/\000-\037/ /;
333 #### Return if answer field is empty ########
334 unless ($answer =~ /\S/) {
335# $errorno = "<BR>No answer was submitted.";
336 $errorno = 0; ## don't report blank answer as error
337
338 return ($answer,$errorno);
339 }
340 ######### replace ^ with ** (for exponentiation)
341 # $answer =~ s/\^/**/g;
342 ######### Return if forbidden characters are found
343 unless ($answer =~ /^[a-zA-Z0-9_\-\+ \t\/@%\*\.\n^\(\)]+$/ ) {
344 $answer =~ tr/a-zA-Z0-9_\-\+ \t\/@%\*\.\n^\(\)/#/c;
345 $errorno = "<BR>There are forbidden characters in your answer: $submittedAnswer<BR>";
346
347 return ($answer,$errorno);
348 }
349
350 $errorno = 0;
351 return($answer, $errorno);
352}
353
354
355
356
357########################################################################################
358# This is the problemEnvironment structure that needs to be filled out in order to provide
359# information to PGtranslator which in turn supports the problem environment
360########################################################################################
361
362sub defineProblemEnvir {
363 my $self = shift;
364 my $r = $self->{r}; 538 my $user = $self->{user};
365 my $courseEnvironment = $self->{courseEnvironment}; 539 my $set = $self->{set};
366 my %envir=(); 540 my $problem = $self->{problem};
367# $envir{'refSubmittedAnswers'} = $refSubmittedAnswers if defined($refSubmittedAnswers);
368 $envir{'psvnNumber'} = 123456789;
369 $envir{'psvn'} = 123456789;
370 $envir{'studentName'} = 'Jane Doe';
371 $envir{'studentLogin'} = 'jd001m';
372 $envir{'studentID'} = 'xxx-xx-4321';
373 $envir{'sectionName'} = 'gage';
374 $envir{'sectionNumber'} = '111foobar';
375 $envir{'recitationName'} = 'gage_recitation';
376 $envir{'recitationNumber'} = '11_foobar recitation';
377 $envir{'setNumber'} = 'setAlgebraicGeometry';
378 $envir{'questionNumber'} = 43;
379 $envir{'probNum'} = 43;
380 $envir{'openDate'} = 3014438528;
381 $envir{'formattedOpenDate'} = '3/4/02';
382 $envir{'dueDate'} = 4014438528;
383 $envir{'formattedDueDate'} = '10/4/04';
384 $envir{'answerDate'} = 4014438528;
385 $envir{'formattedAnswerDate'} = '10/4/04';
386 $envir{'problemValue'} = 1;
387 $envir{'fileName'} = 'problem1';
388 $envir{'probFileName'} = 'problem1';
389 $envir{'languageMode'} = 'HTML_tth';
390 $envir{'displayMode'} = 'HTML_tth';
391 $envir{'outputMode'} = 'HTML_tth';
392 $envir{'courseName'} = $courseEnvironment ->{courseName};
393 $envir{'sessionKey'} = 'asdf';
394
395# initialize constants for PGanswermacros.pl
396 $envir{'numRelPercentTolDefault'} = .1;
397 $envir{'numZeroLevelDefault'} = 1E-14;
398 $envir{'numZeroLevelTolDefault'} = 1E-12;
399 $envir{'numAbsTolDefault'} = .001;
400 $envir{'numFormatDefault'} = '';
401 $envir{'functRelPercentTolDefault'} = .1;
402 $envir{'functZeroLevelDefault'} = 1E-14;
403 $envir{'functZeroLevelTolDefault'} = 1E-12;
404 $envir{'functAbsTolDefault'} = .001;
405 $envir{'functNumOfPoints'} = 3;
406 $envir{'functVarDefault'} = 'x';
407 $envir{'functLLimitDefault'} = .0000001;
408 $envir{'functULimitDefault'} = .9999999;
409 $envir{'functMaxConstantOfIntegration'} = 1E8;
410# kludge check definition of number of attempts again. The +1 is because this is used before the current answer is evaluated.
411 $envir{'numOfAttempts'} = 2; #&getProblemNumOfCorrectAns($probNum,$psvn)
412 # &getProblemNumOfIncorrectAns($probNum,$psvn)+1;
413
414#
415#
416# defining directorys and URLs
417 $envir{'templateDirectory'} = $courseEnvironment ->{courseDirs}->{templates};
418############ $envir{'classDirectory'} = $Global::classDirectory;
419# $envir{'cgiDirectory'} = $Global::cgiDirectory;
420# $envir{'cgiURL'} = getWebworkCgiURL();
421
422# $envir{'scriptDirectory'} = $Global::scriptDirectory;##omit
423 $envir{'webworkDocsURL'} = 'http://webwork.math.rochester.edu';
424 $envir{'externalTTHPath'} = '/usr/local/bin/tth';
425 541
426 542 # how are we going to name this?
427# 543 my $targetPathCommon = "/png/"
428 $envir{'inputs_ref'} = $r->param; 544 . $user->id . "."
429 $envir{'problemSeed'} = 3245; 545 . $set->id . "."
430 $envir{'displaySolutionsQ'} = 1; 546 . $problem->id . "."
431 $envir{'displayHintsQ'} = 1; 547 . $answerResult->{ans_name} . ".png";
432 548
433# Directory values -- do we really need them here? 549 # figure out where to put things
434 $envir{courseScriptsDirectory} = $COURSE_SCRIPTS_DIRECTORY; 550 my $wd = tempdir("webwork-dvipng-XXXXXXXX", DIR => $ce->{courseDirs}->{html_temp});
435 $envir{macroDirectory} = $MACRO_DIRECTORY; 551 my $latex = $ce->{externalPrograms}->{latex};
436 $envir{templateDirectory} = $TEMPLATE_DIRECTORY; 552 my $dvipng = $ce->{externalPrograms}->{dvipng};
437 $envir{tempDirectory} = $TEMP_DIRECTORY; 553 my $tex = $answerResult->{preview_latex_string};
438 $envir{tempURL} = $TEMP_URL; 554 my $targetPath = $ce->{courseDirs}->{html_temp} . $targetPathCommon;
439 $envir{htmlURL} = $HTML_URL; 555 # should use surePathToTmpFile, but we have to
440 $envir{'htmlDirectory'} = $courseEnvironment ->{courseDirectory}->{html}; 556 # isolate it from the problem enivronment first
441 # here is a way to pass environment variables defined in webworkCourse.ph 557 my $targetURL = $ce->{courseURLs}->{html_temp} . $targetPathCommon;
442# my $k; 558
443# foreach $k (keys %Global::PG_environment ) { 559 # call dvipng to generate a preview
444# $envir{$k} = $Global::PG_environment{$k}; 560 dvipng($wd, $latex, $dvipng, $tex, $targetPath);
445# } 561 if (-e $targetPath) {
446 \%envir; 562 return "<img src=\"$targetURL\" alt=\"$tex\" />";
447}
448
449########################################################################################
450# This recursive pretty_print function will print a hash and its sub hashes.
451########################################################################################
452sub pretty_print_rh {
453 my $r_input = shift;
454 my $out = '';
455 if ( not ref($r_input) ) {
456 $out = $r_input; # not a reference
457 } elsif (is_hash_ref($r_input)) {
458 local($^W) = 0;
459 $out .= "<TABLE border = \"2\" cellpadding = \"3\" BGCOLOR = \"#FFFFFF\">";
460 foreach my $key (sort keys %$r_input ) {
461 $out .= "<tr><TD> $key</TD><TD>=&gt;</td><td>&nbsp;".pretty_print_rh($r_input->{$key}) . "</td></tr>";
462 }
463 $out .="</table>";
464 } elsif (is_array_ref($r_input) ) {
465 my @array = @$r_input;
466 $out .= "( " ;
467 while (@array) {
468 $out .= pretty_print_rh(shift @array) . " , ";
469 }
470 $out .= " )";
471 } elsif (ref($r_input) eq 'CODE') {
472 $out = "$r_input";
473 } else { 563 } else {
474 $out = $r_input; 564 return "<b>[math2img failed]</b>";
475 }
476 $out;
477}
478
479sub is_hash_ref {
480 my $in =shift;
481 my $save_SIG_die_trap = $SIG{__DIE__};
482 $SIG{__DIE__} = sub {CORE::die(@_) };
483 my $out = eval{ %{ $in } };
484 $out = ($@ eq '') ? 1 : 0;
485 $@='';
486 $SIG{__DIE__} = $save_SIG_die_trap;
487 $out;
488}
489sub is_array_ref {
490 my $in =shift;
491 my $save_SIG_die_trap = $SIG{__DIE__};
492 $SIG{__DIE__} = sub {CORE::die(@_) };
493 my $out = eval{ @{ $in } };
494 $out = ($@ eq '') ? 1 : 0;
495 $@='';
496 $SIG{__DIE__} = $save_SIG_die_trap;
497 $out;
498}
499
500######
501# Utility for slurping souce files
502#######
503
504sub readFile {
505 my $input = shift; # The set and problem: 'set0/prob1.pg'
506 my $filePath =$TEMPLATE_DIRECTORY .$input;
507 print STDERR "Reading problem from file $filePath \n";
508 print STDERR "<br>Reading problem from file $filePath <br>\n";
509 my $out;
510 print "The file is readable = ", -r $filePath, "\n";
511 if (-r $filePath) {
512 open IN, "<$filePath" or print STDERR "Hey, this file was supposed to be readable\n";
513 local($/)=undef;
514 $out = <IN>;
515 close(IN);
516 } else {
517 print "Could not read file at |$filePath|";
518 print STDERR "Could not read file at |$filePath|";
519 }
520 return($out);
521}
522
523my $foo =0;
524
525# The warning mechanism. This needs to be turned into an object of its own
526###############
527## Error message routines cribbed from CGI
528###############
529
530BEGIN { #error message routines cribbed from CGI
531
532 my $CarpLevel = 0; # How many extra package levels to skip on carp.
533 my $MaxEvalLen = 0; # How much eval '...text...' to show. 0 = all.
534
535 sub longmess {
536 my $error = shift;
537 my $mess = "";
538 my $i = 1 + $CarpLevel;
539 my ($pack,$file,$line,$sub,$eval,$require);
540
541 while (($pack,$file,$line,$sub,undef,undef,$eval,$require) = caller($i++)) {
542 if ($error =~ m/\n$/) {
543 $mess .= $error;
544 }
545 else {
546 if (defined $eval) {
547 if ($require) {
548 $sub = "require $eval";
549 }
550 else {
551 $eval =~ s/[\\\']/\\$&/g;
552 if ($MaxEvalLen && length($eval) > $MaxEvalLen) {
553 substr($eval,$MaxEvalLen) = '...';
554 }
555 $sub = "eval '$eval'";
556 }
557 }
558 elsif ($sub eq '(eval)') {
559 $sub = 'eval {...}';
560 }
561
562 $mess .= "\t$sub " if $error eq "called";
563 $mess .= "$error at $file line $line\n";
564 }
565
566 $error = "called";
567 } 565 }
568
569 $mess || $error;
570 }
571} 566}
572###############
573### Our error messages for giving maximum feedback to the user for errors within problems.
574###############
575BEGIN {
576 sub PG_floating_point_exception_handler { # 1st argument is signal name
577 my($sig) = @_;
578 print "Content-type: text/html\n\n<H4>There was a floating point arithmetic error (exception SIG$sig )</H4>--perhaps
579 you divided by zero or took the square root of a negative number?
580 <BR>\n Use the back button to return to the previous page and recheck your entries.<BR>\n";
581 exit(0);
582 }
583
584 $SIG{'FPE'} = \&PG_floating_point_exception_handler;
585#!/usr/bin/perl -w
586 sub PG_warnings_handler {
587 my @input = @_;
588 my $msg_string = longmess(@_);
589 my @msg_array = split("\n",$msg_string);
590 my $out_string = '';
591
592 # Extra stack information is provided in this next block
593 # If the warning message does NOT end in \n then a line
594 # number is appended (see Perl manual about warn function)
595 # The presence of the line number is detected below and extra
596 # stack information is added.
597 # To suppress the line number and the extra stack information
598 # add \n to the end of a warn message (in .pl files. In .pg
599 # files add ~~n instead
600
601 if ($input[$#input]=~/line \d*\.\s*$/) {
602 $out_string .= "##More details: <BR>\n----";
603 foreach my $line (@msg_array) {
604 chomp($line);
605 next unless $line =~/\w+\:\:/;
606 $out_string .= "----" .$line . "<BR>\n";
607 }
608 }
609 567
610 $Global::WARNINGS .="* " . join("<BR>",@input) . "<BR>\n" . $out_string . 568##### permission queries #####
611 "<BR>\n--------------------------------------<BR>\n<BR>\n";
612 $Global::background_plain_url = $Global::background_warn_url;
613 $Global::bg_color = '#FF99CC'; #for warnings -- this change may come too late
614 }
615 569
616 $SIG{__WARN__}=\&PG_warnings_handler; 570# this stuff should be abstracted out into the permissions system
617 571# however, the permission system only knows about things in the
618 $SIG{__DIE__} = sub { 572# course environment and the username. hmmm...
619 my $message = longmess(@_);
620 $message =~ s/\n/<BR>\n/;
621 my ($package, $filename, $line) = caller();
622 # use standard die for errors eminating from XML::Parser::Expat
623 # it uses a trapped eval which sometimes fails -- apparently on purpose
624 # and the error is handled by Expat itself. We don't want
625 # to interfer with that.
626
627 if ($package eq 'XML::Parser::Expat') {
628 die @_;
629 }
630 #print "$package $filename $line \n";
631 print
632 "Content-type: text/html\r\n\r\n <h4>Software error</h4> <p>\n\n$message\n<p>\n
633 Please inform the webwork meister.<p>\n
634 In addition to the error message above the following warnings were detected:
635 <HR>
636 $Global::WARNINGS;
637 <HR>
638 It's sometimes hard to tell exactly what has gone wrong since the
639 full error message may have been sent to
640 standard error instead of to standard out.
641 <p> To debug you can
642 <ul>
643 <li> guess what went wrong and try to fix it.
644 <li> call the offending script directly from the command line
645 of unix
646 <li> enable the debugging features by redefining
647 \$cgiURL in Global.pm and checking the redirection scripts in
648 system/cgi. This will force the standard error to be placed
649 in the standard out pipe as well.
650 <li> Run tail -f error_log <br>
651 from the unix command line to see error messages from the webserver.
652 The standard error output is being placed in the error_log file for the apache
653 web server. To run this command you have to be in the directory containing the
654 error_log or enter the full path name of the error_log. <p>
655 In a standard apache installation, this file is at /usr/local/apache/logs/error_log<p>
656 In a RedHat Linux installation, this file is at /var/log/httpd/error_log<p>
657 At Rochester this file is at /ww/logs/error_log.
658 </ul>
659 Good luck.<p>\n" ;
660 };
661 573
574# also, i should fix these so that they have a consistent calling
575# format -- perhaps:
576# canPERM($courseEnv, $user, $set, $problem, $permissionLevel)
662 577
578sub canShowCorrectAnswers($$) {
579 my ($permissionLevel, $answerDate) = @_;
580 return $permissionLevel > 0 || time > $answerDate;
581}
663 582
583sub canShowSolutions($$) {
584 my ($permissionLevel, $answerDate) = @_;
585 return canShowCorrectAnswers($permissionLevel, $answerDate);
586}
587
588sub canRecordAnswers($$$$$) {
589 my ($permissionLevel, $openDate, $dueDate, $maxAttempts, $attempts) = @_;
590 my $permHigh = $permissionLevel > 0;
591 my $timeOK = time >= $openDate && time <= $dueDate;
592 my $attemptsOK = $maxAttempts == -1 || $attempts <= $maxAttempts;
593 my $recordAnswers = $permHigh || ($timeOK && $attemptsOK);
594 return $recordAnswers;
595}
596
597sub mustRecordAnswers($) {
598 my ($permissionLevel) = @_;
599 return $permissionLevel == 0;
664} 600}
665 601
6661; 6021;
Legend:
Removed from v.399  
changed lines
  Added in v.623
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9