| … | |
… | |
| 12 | |
12 | |
| 13 | =cut |
13 | =cut |
| 14 | |
14 | |
| 15 | use strict; |
15 | use strict; |
| 16 | use warnings; |
16 | use warnings; |
| 17 | use WeBWorK::Utils qw(runtime_use); |
17 | use WeBWorK::PG::ImageGenerator; |
|
|
18 | use WeBWorK::Utils qw(runtime_use formatDateTime makeTempDirectory); |
| 18 | |
19 | |
| 19 | sub new { |
20 | sub new { |
| 20 | shift; # throw away invocant -- we don't need it |
21 | shift; # throw away invocant -- we don't need it |
| 21 | my ($ce, $user, $key, $set, $problem, $psvn, $formFields, |
22 | my ($ce, $user, $key, $set, $problem, $psvn, $formFields, |
| 22 | $translationOptions) = @_; |
23 | $translationOptions) = @_; |
| … | |
… | |
| 24 | my $renderer = $ce->{pg}->{renderer}; |
25 | my $renderer = $ce->{pg}->{renderer}; |
| 25 | |
26 | |
| 26 | runtime_use $renderer; |
27 | runtime_use $renderer; |
| 27 | |
28 | |
| 28 | return $renderer->new(@_); |
29 | return $renderer->new(@_); |
|
|
30 | } |
|
|
31 | |
|
|
32 | sub defineProblemEnvir { |
|
|
33 | my ( |
|
|
34 | $self, |
|
|
35 | $ce, |
|
|
36 | $user, |
|
|
37 | $key, |
|
|
38 | $set, |
|
|
39 | $problem, |
|
|
40 | $psvn, |
|
|
41 | $formFields, |
|
|
42 | $options, |
|
|
43 | ) = @_; |
|
|
44 | |
|
|
45 | my %envir; |
|
|
46 | |
|
|
47 | # ---------------------------------------------------------------------- |
|
|
48 | |
|
|
49 | # PG environment variables |
|
|
50 | # from docs/pglanguage/pgreference/environmentvariables as of 06/25/2002 |
|
|
51 | # any changes are noted by "ADDED:" or "REMOVED:" |
|
|
52 | |
|
|
53 | # Vital state information |
|
|
54 | # ADDED: displayHintsQ, displaySolutionsQ, refreshMath2img, |
|
|
55 | # texDisposition |
|
|
56 | |
|
|
57 | $envir{psvn} = $set->psvn; |
|
|
58 | $envir{psvnNumber} = $envir{psvn}; |
|
|
59 | $envir{probNum} = $problem->problem_id; |
|
|
60 | $envir{questionNumber} = $envir{probNum}; |
|
|
61 | $envir{fileName} = $problem->source_file; |
|
|
62 | $envir{probFileName} = $envir{fileName}; |
|
|
63 | $envir{problemSeed} = $problem->problem_seed; |
|
|
64 | $envir{displayMode} = translateDisplayModeNames($options->{displayMode}); |
|
|
65 | $envir{languageMode} = $envir{displayMode}; |
|
|
66 | $envir{outputMode} = $envir{displayMode}; |
|
|
67 | $envir{displayHintsQ} = $options->{showHints}; |
|
|
68 | $envir{displaySolutionsQ} = $options->{showSolutions}; |
|
|
69 | $envir{texDisposition} = "pdf"; # in webwork-modperl, we use pdflatex |
|
|
70 | |
|
|
71 | # Problem Information |
|
|
72 | # ADDED: courseName, formatedDueDate |
|
|
73 | |
|
|
74 | $envir{openDate} = $set->open_date; |
|
|
75 | $envir{formattedOpenDate} = formatDateTime($envir{openDate}); |
|
|
76 | $envir{dueDate} = $set->due_date; |
|
|
77 | $envir{formattedDueDate} = formatDateTime($envir{dueDate}); |
|
|
78 | $envir{formatedDueDate} = $envir{formattedDueDate}; # typo in many header files |
|
|
79 | $envir{answerDate} = $set->answer_date; |
|
|
80 | $envir{formattedAnswerDate} = formatDateTime($envir{answerDate}); |
|
|
81 | $envir{numOfAttempts} = ($problem->num_correct || 0) + ($problem->num_incorrect || 0); |
|
|
82 | $envir{problemValue} = $problem->value; |
|
|
83 | $envir{sessionKey} = $key; |
|
|
84 | $envir{courseName} = $ce->{courseName}; |
|
|
85 | |
|
|
86 | # Student Information |
|
|
87 | # ADDED: studentID |
|
|
88 | |
|
|
89 | $envir{sectionName} = $user->section; |
|
|
90 | $envir{sectionNumber} = $envir{sectionName}; |
|
|
91 | $envir{recitationName} = $user->recitation; |
|
|
92 | $envir{recitationNumber} = $envir{recitationName}; |
|
|
93 | $envir{setNumber} = $set->set_id; |
|
|
94 | $envir{studentLogin} = $user->user_id; |
|
|
95 | $envir{studentName} = $user->first_name . " " . $user->last_name; |
|
|
96 | $envir{studentID} = $user->student_id; |
|
|
97 | |
|
|
98 | # Answer Information |
|
|
99 | # REMOVED: refSubmittedAnswers |
|
|
100 | |
|
|
101 | $envir{inputs_ref} = $formFields; |
|
|
102 | |
|
|
103 | # External Programs |
|
|
104 | # ADDED: externalLaTeXPath, externalDvipngPath, |
|
|
105 | # externalGif2EpsPath, externalPng2EpsPath |
|
|
106 | |
|
|
107 | $envir{externalTTHPath} = $ce->{externalPrograms}->{tth}; |
|
|
108 | $envir{externalLaTeXPath} = $ce->{externalPrograms}->{latex}; |
|
|
109 | $envir{externalDvipngPath} = $ce->{externalPrograms}->{dvipng}; |
|
|
110 | $envir{externalGif2EpsPath} = $ce->{externalPrograms}->{gif2eps}; |
|
|
111 | $envir{externalPng2EpsPath} = $ce->{externalPrograms}->{png2eps}; |
|
|
112 | $envir{externalGif2PngPath} = $ce->{externalPrograms}->{gif2png}; |
|
|
113 | |
|
|
114 | # Directories and URLs |
|
|
115 | # REMOVED: courseName |
|
|
116 | # ADDED: dvipngTempDir |
|
|
117 | |
|
|
118 | $envir{cgiDirectory} = undef; |
|
|
119 | $envir{cgiURL} = undef; |
|
|
120 | $envir{classDirectory} = undef; |
|
|
121 | $envir{courseScriptsDirectory} = $ce->{pg}->{directories}->{macros}."/"; |
|
|
122 | $envir{htmlDirectory} = $ce->{courseDirs}->{html}."/"; |
|
|
123 | $envir{htmlURL} = $ce->{courseURLs}->{html}."/"; |
|
|
124 | $envir{macroDirectory} = $ce->{courseDirs}->{macros}."/"; |
|
|
125 | $envir{templateDirectory} = $ce->{courseDirs}->{templates}."/"; |
|
|
126 | $envir{tempDirectory} = $ce->{courseDirs}->{html_temp}."/"; |
|
|
127 | $envir{tempURL} = $ce->{courseURLs}->{html_temp}."/"; |
|
|
128 | $envir{scriptDirectory} = undef; |
|
|
129 | $envir{webworkDocsURL} = $ce->{webworkURLs}->{docs}."/"; |
|
|
130 | |
|
|
131 | # Information for sending mail |
|
|
132 | |
|
|
133 | $envir{mailSmtpServer} = $ce->{mail}->{smtpServer}; |
|
|
134 | $envir{mailSmtpSender} = $ce->{mail}->{smtpSender}; |
|
|
135 | $envir{ALLOW_MAIL_TO} = $ce->{mail}->{allowedRecipients}; |
|
|
136 | |
|
|
137 | # Default values for evaluating answers |
|
|
138 | |
|
|
139 | my $ansEvalDefaults = $ce->{pg}->{ansEvalDefaults}; |
|
|
140 | $envir{$_} = $ansEvalDefaults->{$_} foreach (keys %$ansEvalDefaults); |
|
|
141 | |
|
|
142 | # ---------------------------------------------------------------------- |
|
|
143 | |
|
|
144 | my $basename = "equation-$envir{psvn}.$envir{probNum}"; |
|
|
145 | $basename .= ".$envir{problemSeed}" if $envir{problemSeed}; |
|
|
146 | |
|
|
147 | # Object for generating equation images |
|
|
148 | $envir{imagegen} = WeBWorK::PG::ImageGenerator->new( |
|
|
149 | tempDir => $ce->{webworkDirs}->{tmp}, # global temp dir |
|
|
150 | latex => $envir{externalLaTeXPath}, |
|
|
151 | dvipng => $envir{externalDvipngPath}, |
|
|
152 | useCache => 1, |
|
|
153 | cacheDir => $ce->{webworkDirs}->{equationCache}, |
|
|
154 | cacheURL => $ce->{webworkURLs}->{equationCache}, |
|
|
155 | cacheDB => $ce->{webworkFiles}->{equationCacheDB}, |
|
|
156 | ); |
|
|
157 | |
|
|
158 | # Other things... |
|
|
159 | $envir{QUIZ_PREFIX} = $options->{QUIZ_PREFIX}; # used by quizzes |
|
|
160 | $envir{PROBLEM_GRADER_TO_USE} = $ce->{pg}->{options}->{grader}; |
|
|
161 | $envir{PRINT_FILE_NAMES_FOR} = $ce->{pg}->{specialPGEnvironmentVars}->{PRINT_FILE_NAMES_FOR}; |
|
|
162 | |
|
|
163 | # variables for interpreting capa problems. |
|
|
164 | $envir{CAPA_Tools} = $ce->{pg}->{specialPGEnvironmentVars}->{CAPA_Tools}; |
|
|
165 | $envir{CAPA_MCTools} = $ce->{pg}->{specialPGEnvironmentVars}->{CAPA_MCTools}; |
|
|
166 | $envir{CAPA_Graphics_URL} = $ce->{pg}->{specialPGEnvironmentVars}->{CAPA_Graphics_URL}; |
|
|
167 | $envir{CAPA_GraphicsDirectory} = $ce->{pg}->{specialPGEnvironmentVars}->{CAPA_GraphicsDirectory}; |
|
|
168 | |
|
|
169 | return \%envir; |
|
|
170 | } |
|
|
171 | |
|
|
172 | sub translateDisplayModeNames($) { |
|
|
173 | my $name = shift; |
|
|
174 | return { |
|
|
175 | tex => "TeX", |
|
|
176 | plainText => "HTML", |
|
|
177 | formattedText => "HTML_tth", |
|
|
178 | images => "HTML_dpng", # "HTML_img", |
|
|
179 | }->{$name}; |
|
|
180 | } |
|
|
181 | |
|
|
182 | sub oldSafetyFilter { |
|
|
183 | my $answer = shift; # accepts one answer and checks it |
|
|
184 | my $submittedAnswer = $answer; |
|
|
185 | $answer = '' unless defined $answer; |
|
|
186 | my ($errorno); |
|
|
187 | $answer =~ tr/\000-\037/ /; |
|
|
188 | # Return if answer field is empty |
|
|
189 | unless ($answer =~ /\S/) { |
|
|
190 | #$errorno = "<BR>No answer was submitted."; |
|
|
191 | $errorno = 0; ## don't report blank answer as error |
|
|
192 | return ($answer,$errorno); |
|
|
193 | } |
|
|
194 | # replace ^ with ** (for exponentiation) |
|
|
195 | # $answer =~ s/\^/**/g; |
|
|
196 | # Return if forbidden characters are found |
|
|
197 | unless ($answer =~ /^[a-zA-Z0-9_\-\+ \t\/@%\*\.\n^\[\]\(\)\,\|]+$/ ) { |
|
|
198 | $answer =~ tr/a-zA-Z0-9_\-\+ \t\/@%\*\.\n^\(\)/#/c; |
|
|
199 | $errorno = "<BR>There are forbidden characters in your answer: $submittedAnswer<BR>"; |
|
|
200 | return ($answer,$errorno); |
|
|
201 | } |
|
|
202 | $errorno = 0; |
|
|
203 | return($answer, $errorno); |
|
|
204 | } |
|
|
205 | |
|
|
206 | sub nullSafetyFilter { |
|
|
207 | return shift, 0; # no errors |
| 29 | } |
208 | } |
| 30 | |
209 | |
| 31 | 1; |
210 | 1; |
| 32 | |
211 | |
| 33 | __END__ |
212 | __END__ |
| … | |
… | |
| 72 | |
251 | |
| 73 | Modules which support this API must implement the following method: |
252 | Modules which support this API must implement the following method: |
| 74 | |
253 | |
| 75 | =over |
254 | =over |
| 76 | |
255 | |
| 77 | =item new (ENVIRONMENT, USER, KEY, SET, PROBLEM, PSVN, FIELDS, OPTIONS) |
256 | =item new ENVIRONMENT, USER, KEY, SET, PROBLEM, PSVN, FIELDS, OPTIONS |
| 78 | |
257 | |
| 79 | The C<new> method creates a translator, initializes it using the parameters |
258 | The C<new> method creates a translator, initializes it using the parameters |
| 80 | specified, translates a PG file, and processes answers. It returns a reference |
259 | specified, translates a PG file, and processes answers. It returns a reference |
| 81 | to a blessed hash containing the results of the translation process. |
260 | to a blessed hash containing the results of the translation process. |
| 82 | |
261 | |
| … | |
… | |
| 196 | |
375 | |
| 197 | A hash containing PG_flags (see the Translator docs). |
376 | A hash containing PG_flags (see the Translator docs). |
| 198 | |
377 | |
| 199 | =back |
378 | =back |
| 200 | |
379 | |
|
|
380 | =head1 METHODS PROVIDED BY THE BASE CLASS |
|
|
381 | |
|
|
382 | The following methods are provided for use by subclasses of WeBWorK::PG. |
|
|
383 | |
|
|
384 | =over |
|
|
385 | |
|
|
386 | =item defineProblemEnvir ENVIRONMENT, USER, KEY, SET, PROBLEM, PSVN, FIELDS, OPTIONS |
|
|
387 | |
|
|
388 | Generate a problem environment hash to pass to the renderer. |
|
|
389 | |
|
|
390 | =item translateDisplayModeNames NAME |
|
|
391 | |
|
|
392 | NAME contains |
|
|
393 | |
|
|
394 | =back |
|
|
395 | |
| 201 | =head1 AUTHOR |
396 | =head1 AUTHOR |
| 202 | |
397 | |
| 203 | Written by Sam Hathaway, sh002i (at) math.rochester.edu. |
398 | Written by Sam Hathaway, sh002i (at) math.rochester.edu. |
| 204 | |
399 | |
| 205 | =cut |
400 | =cut |
Parent Directory
| 
Revision Log
| 
Patch