[system] / trunk / pg / lib / Applet.pm Repository:
ViewVC logotype

Diff of /trunk/pg/lib/Applet.pm

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

Revision 5667 Revision 6026
1################################################################################ 1################################################################################
2# WeBWorK Online Homework Delivery System 2# WeBWorK Online Homework Delivery System
3# Copyright 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/ 3# Copyright 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/
4# $CVSHeader: pg/lib/Applet.pm,v 1.10 2008/05/05 17:24:31 gage Exp $ 4# $CVSHeader: pg/lib/Applet.pm,v 1.20 2009/03/10 20:58:46 gage Exp $
5# 5#
6# This program is free software; you can redistribute it and/or modify it under 6# This program is free software; you can redistribute it and/or modify it under
7# the terms of either: (a) the GNU General Public License as published by the 7# the terms of either: (a) the GNU General Public License as published by the
8# Free Software Foundation; either version 2, or (at your option) any later 8# Free Software Foundation; either version 2, or (at your option) any later
9# version, or (b) the "Artistic License" which comes with this package. 9# version, or (b) the "Artistic License" which comes with this package.
21=head1 SYNPOSIS 21=head1 SYNPOSIS
22 22
23 ################################### 23 ###################################
24 # Create link to applet 24 # Create link to applet
25 ################################### 25 ###################################
26 my $appletName = "LineThruPointsWW"; 26 $appletName = "PointGraph";
27 $applet = new FlashApplet( 27$applet = FlashApplet(
28 # can be replaced by $applet =FlashApplet() when using AppletObjects.pl
29 codebase => findAppletCodebase("$appletName.swf"), 28 codebase => findAppletCodebase("$appletName.swf"),
30 appletName => $appletName, 29 appletName => $appletName,
31 appletId => $appletName, 30 appletId => $appletName,
32 submitActionAlias => 'checkAnswer', 31 setStateAlias => 'setXML',
33 ); 32 getStateAlias => 'getXML',
34 33 setConfigAlias => 'config',
34 answerBoxAlias => 'receivedField',
35);
36
35 ################################### 37###################################
36 # Configure applet 38# Configure applet
37 ################################### 39###################################
38 40
39 #xml data to set up the problem-rac 41#data to set up the equation
40 $applet->config(qq{<XML> 42$applet->config(qq{<XML expr='(x - $a)^3 + $b/$a * x' />});
41 <point xval='$xval_1' yval='$yval_1' /> 43# initial points
42 <point xval='$xval_2' yval='$yval_2' /> 44$applet->state(qq{<XML>
43 </XML>}); 45</XML>});
44
45
46 ################################### 46###################################
47 # insert applet header material 47#insert applet into body
48 ################################### 48###################################
49 HEADER_TEXT($applet->insertHeader ); 49
50
51 ###################################
52 # Text section
53 #
54
55 ###################################
56 #insert applet into body
57 ###################################
58 TEXT( MODES(TeX=>'object code', HTML=>$applet->insertObject)); 50TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
51 debug=>0,
52 reset_button=>1,
53 )));
59 54
60 55
61=head1 DESCRIPTION 56=head1 DESCRIPTION
62 57
63This file provides an object to store in one place 58This file provides an object to store in one place
99use MIME::Base64 qw( encode_base64 decode_base64); 94use MIME::Base64 qw( encode_base64 decode_base64);
100 95
101 96
102=head2 Default javaScript functions placed in header 97=head2 Default javaScript functions placed in header
103 98
99=pod
100
104These functions are automatically defined for use for 101These functions are automatically defined for use for
105any javaScript placed in the text of a PG question. 102any javaScript placed in the text of a PG question.
106 103
107 getApplet(appletName) -- finds the applet path in the DOM 104 getApplet(appletName) -- finds the applet path in the DOM
108 105
109 submitAction() -- calls the submit action of the applets 106 submitAction() -- calls the submit action of the applets
110
111 107
112 initializeAction() -- calls the initialize action of the applets 108 initializeWWquestion() -- calls the initialize action of the applets
113 109
114 getQE(name) -- gets an HTML element of the question by name 110 getQE(name) -- gets an HTML element of the question by name
115 or by id. Be sure to keep all names and ids 111 or by id. Be sure to keep all names and ids
116 unique within a given PG question. 112 unique within a given PG question.
117 113
118 getQuestionElement(name) -- long form of getQE(name) 114 getQuestionElement(name) -- long form of getQE(name)
119 115
120 listQuestionElements() -- for discovering the names of inputs in the 116 listQuestionElements() -- for discovering the names of inputs in the
121 PG question. An alert dialog will list all 117 PG question. An alert dialog will list all
122 of the elements. 118 of the elements.
123 Usage: Place this at the END of the question, 119 Usage: Place this at the END of the question, just before END_DOCUMENT():
124 just before END_DOCUMENT():
125 120
126 TEXT(qq!<script> listQuestionElements() </script>!); 121 TEXT(qq!<script> listQuestionElements() </script>!);
127 ENDDOCUMENT(); 122 ENDDOCUMENT();
123 to obtain a list of all of the HTML elements in the question
124
125 ----------------------------------------------------------------------------
126
127
128 List of accessor methods made available by the FlashApplet class:
129 Usage: $current_value = $applet->method(new_value or empty)
130 These can also be set when creating the class -- for exampe:
131 $applet = new FlashApplet(
132 # can be replaced by $applet =FlashApplet() when using AppletObjects.pl
133 codebase => findAppletCodebase("$appletName.swf"),
134 appletName => $appletName,
135 appletId => $appletName,
136 submitActionAlias => 'checkAnswer',
137 );
128 138
129 list of accessor methods format: current_value = $self->method(new_value or empty)
130 139
131 appletId for simplicity and reliability appletId and appletName are always the same 140 appletId for simplicity and reliability appletId and appletName are always the same
132 appletName 141 appletName
133
134 archive the name of the .jar file containing the applet code 142 archive the name of the .jar file containing the applet code
135 code the name of the applet code in the .jar archive 143 code the name of the applet code in the .jar archive
136 codebase a prefix url used to find the archive and the applet itself 144 codebase a prefix url used to find the archive and the applet itself
137 145
138 height rectangle alloted in the html page for displaying the applet 146 height rectangle alloted in the html page for displaying the applet
139 width 147
140
141 params an anonymous array containing name/value pairs 148 params an anonymous array containing name/value pairs
142 to configure the applet [name =>'value, ...] 149 to configure the applet [name =>'value, ...]
143 150
144 header stores the text to be added to the header section of the html page 151 header stores the text to be added to the header section of the html page
145 object stores the text which places the applet on the html page 152 object stores the text which places the applet on the html page
146 153
147 debug in debug mode several alerts mark progress through the procedure of calling the applet 154 debug in debug mode several alerts mark progress through the procedure of calling the applet
148 155
149 config configuration are those customizable attributes of the applet which don't 156 config configuration are those customizable attributes of the applet which don't
150 change as it is used. When stored in hidden answer fields 157 change as it is used. When stored in hidden answer fields
151 it is usually stored in base64 encoded format. 158 it is usually stored in base64 encoded format.
152 base64_config base64 encode version of the contents of config 159 base64_config base64 encode version of the contents of config
153 160
154 configAlias (default: config ) names the applet command called with the contents of $self->config 161 configAlias (default: setConfig ) names the applet command called with the contents of $self->config
155 to configure the applet. The parameters are passed to the applet in plain text using <xml> 162 to configure the applet. The parameters are passed to the applet in plain text using <xml>
156 The outer tags must be <xml> ..... </xml> 163 The outer tags must be <xml> ..... </xml>
164 setConfigAlias (default: setConfig) -- a synonym for configAlias
165 getConfigAlias (default: getConfig) -- retrieves the configuration from the applet. This is used
166 mainly for debugging. In principal the configuration remains the same for a given instance
167 of the applet -- i.e. for the homework question for a single student. The state however
168 will change depending on the interactions between the student and the applet.
157 state state consists of those customizable attributes of the applet which change 169 initialState the state consists of those customizable attributes of the applet which change
158 as the applet is used. It is stored by the calling .pg question so that 170 as the applet is used by the student. It is stored by the calling .pg question so that
159 when revisiting the question the applet 171 when revisiting the question the applet will be restored to the same state it was left in when the question was last
160 will be restored to the same state it was left in when the question was last
161 viewed. 172 viewed.
162 173
163 getStateAlias (default: getState) alias for command called to read the current state of the applet. 174 getStateAlias (default: getState) alias for command called to read the current state of the applet.
164 The state is passed in plain text xml format with outer tags: <xml>....</xml> 175 The state is passed in plain text xml format with outer tags: <xml>....</xml>
165 setStateAlias (default: setState) alias for the command called to reset the state of the applet. 176 setStateAlias (default: setState) alias for the command called to reset the state of the applet.
166 The state is passed in plain text in xml format with outer tags: <xml>....</xml> 177 The state is passed in plain text in xml format with outer tags: <xml>....</xml>
167 178
168 base64_state returns the base64 encoded version of the state stored in the applet object. 179 base64_state returns the base64 encoded version of the state stored in the applet object.
169 180
170 initializeActionAlias -- (default: initializeAction) the name of the javaScript subroutine called to initialize the applet (some overlap with config/ and setState 181 initializeActionAlias -- (default: initializeAction) the name of the javaScript subroutine called to initialize the applet (some overlap with config/ and setState
171 submitActionAlias -- (default: submitAction)the name of the javaScript subroutine called when the submit button of the 182 submitActionAlias -- (default: submitAction)the name of the javaScript subroutine called when the submit button of the
172 .pg question is pressed. 183 .pg question is pressed.
184 answerBoxAlias -- name of answer box to return answer to: default defaultAnswerBox
185 getAnswer -- (formerly sendData) get student answer from applet and place in answerBox
186 returnFieldName -- (deprecated) synonmym for answerBoxAlias
173 187
174 returnFieldName
175
176
177
178
179 188
180=cut 189=cut
181 190
191=head4 More details
182 192
193There are three different "images" of the applet. The first is the java or flash applet itself. The object that actually does the work.
194The second is a perl image of the applet -- henceforth the perlApplet -- which is configured in the .pg file and allows a WeBWorK question
195to communicate with the applet. The third image is a javaScript image of the applet -- henceforth the jsApplet which is a mirror of the perlApplet
196but is available to the javaScript code setup and executed in the virtual HTML page defined by the .pg file of the WeBWorK question. One can think of
197the jsApplet as a runtime version of the perlApplet since it can be accessed and modified after the virtual HTML page has been created by
198the PG rendering process.
183 199
200The perlApplet is initialized by $newApplet = new flashApplet( appletName=>'myApplet',..... ); The jsApplet is automatically defined in
201ww_applet_list["myApplet"] by copying the instance variables of $newApplet to a corresponding javaScript object. So $newApplet->{appletName}
202corresponds to ww_applet_list["myApplet"].appletName. (This paragraph is not yet fully implemented :-().
203
204Currently all messages read by the applet are xml text. If some of the code needs to be printed in the HTML header than it is converted
205to a base64 constant and then converted back to text form when it is read by a javaScript subroutine.
206
207The perlApplet has methods that help place the jsApplet code on the HTML page and create the link to the applet itself.
208In particular instance variables such as "setStateAlias", "getStateAlias" connect the WW default of "setState" to subroutine
209name chosen by the applet designer. The aim is to make it easier to connect to applets previously designed to work
210with javaScript in an HTML page or other systems.
211
212
213The jsApplet acts as an intermediary for commands directed at the applet.
214It is not necessary for the minimal operations of
215configuring the applet and maintaining
216state from one viewing of the WW question to address the applet directly.
217The methods such as "setState", "getState", "setConfig" which are part of the jsApplet
218take care of the book keeping details.
219It is also possible to make direct calls to the applet from handcrafted javaScript subroutines,
220but it may be convenient to store these as additional methods in the
221jsApplet.
222
223=cut
224
225=head4 Detecting that the applet is ready
226
227Timing issues are among the pitfalls awaiting when using flash or java applets in WW questions. It is important that the WW question
228does not issue any commands to the applet until the applet is fully loaded, including the uploading of any additional configuration
229information from XML files. This can be tricky since the timing issues usually don't arise when initiating the applet from an HTML page.
230
231The WW API performs the following actions to determine if the applet is loaded:
232
233 check the ww_applet_list[appletName].isReady flag (1== applet is ready)
234 -- this caches the readiness information so that it doesn't
235 have to be repeated within a given viewing of a WW question
236 If this is 1 then the applet is ready.
237 determine whether the applet's isActive subroutine is defined AND returns 1 when called.
238 -- if the return value is 1 the applet is ready, if it is zero or no response then the applet is NOT ready
239 -- If the applet has an isActive() subroutine -- there is no alias for this --
240 then it must return 1 as soon as the applet is ready. Otherwise
241 the applet will timeout.
242 determine whether the applet's setConfig subroutine is defined.
243 -- applet.{setConfigAlias}.
244 determine whether the applet's setState subroutine is defined.
245 determine whether the jsApplets ww_applet_list[appletName].reportsLoaded flag is set to 1
246 -- this can be set by the applet if it calls the javaScript function
247 "applet_loaded(appletName, loaded_status). The loaded_status is 1 or 0
248
249 Logic for determining applet status: if any one of the above checks succeeds (or returns 1) then the applet is
250 consdered to be ready UNLESS the isActive() exists and the call returns a 0 or no response. In this case
251 the applet is assumed to be loading additional data and is not yet ready.
252
253 For this reason if the isActive subroutine
254 is defined in the applet it must return a 1 once the applet is prepared to accept additional commands.
255 (Since there are some extent flashApplets with non-functioning isActive() subroutines a temporary workaround
256 assuems that after C<maxInitializationAttempts> -- 5 by default -- the applet is in fact ready but the
257 isActive() subroutine is non functioning. This can give rise to false "readiness" signals if the applet
258 takes a long time to load auxiliary files.)
259
260The applet itself can take measures to insure that the setConfig subroutine is prepared to respond immediately once the applet is loaded.
261It can include timers that delay execution of the configuring actions until all of the auxiliary files needed by the applet are loaded.
262
263
264=cut
265
266
267=head4 Initialization sequence
268
269When the WW question is loaded the C<initializeWWquestion> javaScript subroutine calls each of the applets used in the question asking them
270to initialize themselves.
271
272The applets initialization method is as follows:
273
274 -- wait until the applet is loaded and the applet has loaded all of its auxiliary files.
275 -- set the debugMode in the applet
276 -- call the setConfig method in the javaScript applet -- (configuration parameters are "permanent" for the life of the applet
277 -- call the setInitialization method in the javaScript applet -- this often calls the setState method in the applet
278
279=cut
280
281=head Methods defined for the javaScript applet ww_applet_list[appletName]
282
283This is not a comprehensive list
284
285 setConfig -- transmits the information for configuring the applet
286
287 getConfig -- retrieves the configuration information -- this is used mainly for debugging and may not be defined in most applets
288
289
290 setState -- sets the current state (1) from the appletName_state HTML element if this contains an <xml>...</xml> string
291 -- if the value contains <xml>restart_applet</xml> then set the current state to ww_applet_list[appletName].initialState
292 -- if the value is a blank string set the current state to ww_applet_list[appletName].initialState
293
294
295 getState -- retrieves the current state and stores in the appletName_state HTML element.
296
297
298
299
300
301
302
303=head Submit sequence
304
305When the WW question submit button is pressed the form containing the WW question calles the javaScript "submitAction()" which then asks
306each of the applets on the page to perform its submit action which consists of
307
308 -- if the applet is to be reinitialized (appletName_state contains <xml>restart_applet</xml>) then
309 the HTML elements appletName_state and previous_appletName_state are set to <xml>restart_applet</xml>
310 to be interpreted by the next setState command
311 -- Otherwise getState() from the applet and save it to the HTML input element appletName_state
312 -- Perform the javaScript commands in .submitActionScript (default: '' )
313 a typical submitActionScript looks like getQE(this.answerBox).value = getApplet(appletName).getAnswer() )
314
315=head4 Requirements for applets
316
317The following methods are desirable in an applet that preserves state in a WW question. None of them are required.
318
319 setState(str) (default: setXML)
320 -- set the current state of the applet from an xml string
321 -- should be able to accept an empty string or a string of
322 the form <XML>.....</XML> without creating errors
323 -- can be designed to receive other forms of input if it is
324 coordinated with the WW question.
325 getState() (default: getXML)
326 -- return the current state of the applet in an xml string.
327 -- an empty string or a string of the form <XML>.....</XML>
328 are the standard responses.
329 -- can be designed to return other strings if it is
330 coordinated with the WW question.
331 setConfig(str) (default: setConfig)
332 -- If the applet allows configuration this configures the applet
333 from an xml string
334 -- should be able to accept an empty string or a string of the
335 form <XML>.....</XML> without creating errors
336 -- can be designed to receive other forms of input if it is
337 coordinated with the WW question.
338 getConfig (default: getConfig)
339 -- This returns a string defining the configuration of the
340 applet in an xml string
341 -- an empty string or a string of the form <XML>.....</XML>
342 are the standard responses.
343 -- can be designed to return other strings if it is
344 coordinated with the WW question.
345 -- this method is used for debugging to ensure that
346 the configuration was set as expected.
347 getAnswer (default: getAnswer)
348 -- Returns a string (usually NOT xml) which is the
349 response that the student is effectvely submitting to answer
350 the WW question.
351
352
353=cut
184 354
185sub new { 355sub new {
186 my $class = shift; 356 my $class = shift;
187 my $self = { 357 my $self = {
188 appletName =>'', 358 appletName =>'',
190 codebase=>'', 360 codebase=>'',
191# appletId =>'', #always use identical applet Id's and applet Names 361# appletId =>'', #always use identical applet Id's and applet Names
192 params =>undef, 362 params =>undef,
193 width => 550, 363 width => 550,
194 height => 400, 364 height => 400,
365 bgcolor => "#869ca7",
195 base64_state => undef, # this is an state to use for initializing the first occurence of the question. 366 base64_state => undef, # this is a state to use for initializing the first occurence of the question.
196 base64_config => undef, # this is the initial (and final?) configuration 367 base64_config => undef, # this is the initial (and final?) configuration
368# configuration => '', # configuration defining the applet
369 initialState => '', # initial state. (I'm considering storing everything as ascii and converting on the fly to base64 when needed.)
197 getStateAlias => 'getXML', 370 getStateAlias => 'getXML',
198 setStateAlias => 'setXML', 371 setStateAlias => 'setXML',
372 configAlias => '', # deprecated
199 configAlias => 'config', 373 getConfigAlias => 'getConfig',
374 setConfigAlias => 'setConfig',
200 initializeActionAlias => 'setXML', 375 initializeActionAlias => 'setXML',
376 maxInitializationAttempts => 5, # number of attempts to initialize applet
201 submitActionAlias => 'getXML', 377 submitActionAlias => 'getXML',
202 returnFieldName => 'receivedField', 378 submitActionScript => '', # script executed on submitting the WW question
379 answerBoxAlias => 'answerBox',
380 answerBox => '', # deprecated
381 returnFieldName => '', # deprecated
203 headerText => DEFAULT_HEADER_TEXT(), 382 headerText => DEFAULT_HEADER_TEXT(),
204 objectText => '', 383 objectText => '',
205 debug => 0, 384 debugMode => 0,
206 @_, 385 @_,
207 }; 386 };
208 bless $self, $class; 387 bless $self, $class;
209 $self->state('<xml></xml>'); 388 $self->initialState('<xml></xml>');
389 if ($self->{returnFieldName} or $self->{answerBox} ) { # backward compatibility
390 warn "use answerBoxAlias instead of returnFieldName or answerBox";
391 $self->{answerBox}='';
392 $self->{returnFieldName}='';
393 }
394 if ($self->{configAlias}) { # backward compatibility
395 warn "use setConfigAlias instead of configAlias";
396 $self->{configAlias}='';
397 }
210 $self->config('<xml></xml>'); 398 $self->config('<xml></xml>');
211 return $self; 399 return $self;
212} 400}
213 401
214sub header { 402sub header {
250sub submitActionAlias { 438sub submitActionAlias {
251 my $self = shift; 439 my $self = shift;
252 $self->{submitActionAlias} = shift ||$self->{submitActionAlias}; # replace the current contents if non-empty 440 $self->{submitActionAlias} = shift ||$self->{submitActionAlias}; # replace the current contents if non-empty
253 $self->{submitActionAlias}; 441 $self->{submitActionAlias};
254} 442}
443sub submitActionScript {
444 my $self = shift;
445 $self->{submitActionScript} = shift ||$self->{submitActionScript}; # replace the current contents if non-empty
446 $self->{submitActionScript};
447}
255sub getStateAlias { 448sub getStateAlias {
256 my $self = shift; 449 my $self = shift;
257 $self->{getStateAlias} = shift ||$self->{getStateAlias}; # replace the current contents if non-empty 450 $self->{getStateAlias} = shift ||$self->{getStateAlias}; # replace the current contents if non-empty
258 $self->{getStateAlias}; 451 $self->{getStateAlias};
259} 452}
263 $self->{setStateAlias} = shift ||$self->{setStateAlias}; # replace the current contents if non-empty 456 $self->{setStateAlias} = shift ||$self->{setStateAlias}; # replace the current contents if non-empty
264 $self->{setStateAlias}; 457 $self->{setStateAlias};
265} 458}
266sub configAlias { 459sub configAlias {
267 my $self = shift; 460 my $self = shift;
268 $self->{configAlias} = shift ||$self->{configAlias}; # replace the current contents if non-empty 461 $self->{setConfigAlias} = shift ||$self->{setConfigAlias}; # replace the current contents if non-empty
269 $self->{configAlias}; 462 $self->{setConfigAlias};
270} 463}
271sub returnFieldName { 464sub setConfigAlias {
272 my $self = shift; 465 my $self = shift;
273 $self->{returnFieldName} = shift ||$self->{returnFieldName}; # replace the current contents if non-empty 466 $self->{setConfigAlias} = shift ||$self->{setConfigAlias}; # replace the current contents if non-empty
274 $self->{returnFieldName}; 467 $self->{setConfigAlias};
468}
469sub getConfigAlias {
470 my $self = shift;
471 $self->{getConfigAlias} = shift ||$self->{getConfigAlias}; # replace the current contents if non-empty
472 $self->{getConfigAlias};
473}
474
475sub answerBoxName {
476 my $self = shift;
477 $self->{answerBox} = shift ||$self->{answerBox}; # replace the current contents if non-empty
478 $self->{answerBox};
275} 479}
276sub codebase { 480sub codebase {
277 my $self = shift; 481 my $self = shift;
278 $self->{codebase} = shift ||$self->{codebase}; # replace the current codebase if non-empty 482 $self->{codebase} = shift ||$self->{codebase}; # replace the current codebase if non-empty
279 $self->{codebase}; 483 $self->{codebase};
291sub width { 495sub width {
292 my $self = shift; 496 my $self = shift;
293 $self->{width} = shift ||$self->{width}; # replace the current width if non-empty 497 $self->{width} = shift ||$self->{width}; # replace the current width if non-empty
294 $self->{width}; 498 $self->{width};
295} 499}
500sub bgcolor {
501 my $self = shift;
502 $self->{bgcolor} = shift ||$self->{bgcolor}; # replace the current background color if non-empty
503 $self->{bgcolor};
504}
296sub archive { 505sub archive {
297 my $self = shift; 506 my $self = shift;
298 $self->{archive} = shift ||$self->{archive}; # replace the current archive if non-empty 507 $self->{archive} = shift ||$self->{archive}; # replace the current archive if non-empty
299 $self->{archive}; 508 $self->{archive};
300} 509}
301sub appletName { 510sub appletName {
302 my $self = shift; 511 my $self = shift;
303 $self->{appletName} = shift ||$self->{appletName}; # replace the current appletName if non-empty 512 $self->{appletName} = shift ||$self->{appletName}; # replace the current appletName if non-empty
304 $self->{appletName}; 513 $self->{appletName};
305} 514}
306sub debug { 515sub debugMode {
307 my $self = shift; 516 my $self = shift;
308 my $new_flag = shift; 517 my $new_flag = shift;
309 $self->{debug} = $new_flag if defined($new_flag); 518 $self->{debugMode} = $new_flag if defined($new_flag);
310 $self->{debug}; 519 $self->{debugMode};
311} 520}
312sub appletId { 521sub appletId {
313 appletName(@_); 522 appletName(@_);
314} 523}
524sub maxInitializationAttempts {
525 my $self = shift;
526 $self->{maxInitializationAttempts} = shift || $self->{maxInitializationAttempts};
527 $self->{maxInitializationAttempts};
528}
529sub initialState {
530 my $self = shift;
531 my $str = shift;
532 $self->{initialState} = $str ||$self->{initialState}; # replace the current string if non-empty
533 $self->{initialState};
534}
535
536sub config {
537 my $self = shift;
538 my $str = shift;
539 $self->{base64_config} = encode_base64($str) || $self->{base64_config}; # replace the current string if non-empty
540 $self->{base64_config} =~ s/\n//g;
541 decode_base64($self->{base64_config});
542}
543#######################
544# soon to be deprecated?
545#######################
315sub state { 546sub state {
316 my $self = shift; 547 my $self = shift;
317 my $str = shift; 548 my $str = shift;
318 $self->{base64_state} = encode_base64($str) ||$self->{base64_state}; # replace the current string if non-empty 549 $self->{base64_state} = encode_base64($str) ||$self->{base64_state}; # replace the current string if non-empty
319 $self->{base64_state} =~ s/\n//g; 550 $self->{base64_state} =~ s/\n//g;
320 decode_base64($self->{base64_state}); 551 decode_base64($self->{base64_state});
321} 552}
322
323sub base64_state{ 553sub base64_state{
324 my $self = shift; 554 my $self = shift;
325 $self->{base64_state} = shift ||$self->{base64_state}; # replace the current string if non-empty 555 $self->{base64_state} = shift ||$self->{base64_state}; # replace the current string if non-empty
326 $self->{base64_state}; 556 $self->{base64_state};
327} 557}
328sub config { 558
329 my $self = shift;
330 my $str = shift;
331 $self->{base64_config} = encode_base64($str) || $self->{base64_config}; # replace the current string if non-empty
332 $self->{base64_config} =~ s/\n//g;
333 decode_base64($self->{base64_config});
334}
335sub base64_config { 559sub base64_config {
336 my $self = shift; 560 my $self = shift;
337 $self->{base64_config} = shift ||$self->{base64_config}; # replace the current string if non-empty 561 $self->{base64_config} = shift ||$self->{base64_config}; # replace the current string if non-empty
338 $self->{base64_config} =$self->{base64_config}; 562 $self->{base64_config} =$self->{base64_config};
339 $self->{base64_config}; 563 $self->{base64_config};
340} 564}
565
566sub returnFieldName {
567 my $self = shift;
568 warn "use answerBoxName instead of returnFieldName";
569}
570sub answerBox {
571 my $self = shift;
572 warn "use answerBoxAlias instead of AnswerBox";
573}
574#########################
341#FIXME 575#FIXME
342# need to be able to adjust header material 576# need to be able to adjust header material
343 577
344sub insertHeader { 578sub insertHeader {
345 my $self = shift; 579 my $self = shift;
580
346 my $codebase = $self->codebase; 581 my $codebase = $self->codebase;
347 my $appletId = $self->appletId; 582 my $appletId = $self->appletId;
348 my $appletName = $self->appletName; 583 my $appletName = $self->appletName;
349 my $base64_initialState = $self->base64_state; 584 my $base64_initialState = $self->base64_state;
350 my $initializeAction = $self->initializeActionAlias; 585 my $initializeActionAlias = $self->initializeActionAlias;
351 my $submitAction = $self->submitActionAlias; 586 my $submitActionAlias = $self->submitActionAlias;
587 my $submitActionScript = $self->submitActionScript;
352 my $setState = $self->setStateAlias; 588 my $setStateAlias = $self->setStateAlias;
353 my $getState = $self->getStateAlias; 589 my $getStateAlias = $self->getStateAlias;
590
354 my $config = $self->configAlias; 591 my $setConfigAlias = $self->setConfigAlias;
592 my $getConfigAlias = $self->getConfigAlias;
593 my $maxInitializationAttempts = $self->maxInitializationAttempts;
355 my $base64_config = $self->base64_config; 594 my $base64_config = $self->base64_config;
356 my $debugMode = ($self->debug) ? "1": "0"; 595 my $debugMode = ($self->debugMode) ? "1": "0";
357 my $returnFieldName = $self->{returnFieldName}; 596 my $answerBoxAlias = $self->{answerBoxAlias};
358# my $encodeStateQ = ($self->debug)?'' : "state = Base64.encode(state);"; # in debug mode base64 encoding is not used.
359# my $decodeStateQ = "if (!state.match(/<XML>*/i) ) {state = Base64.decode(state)}"; # decode if <XML> is not present
360 my $headerText = $self->header(); 597 my $headerText = $self->header();
598
599
600 $submitActionScript =~ s/"/\\"/g; # escape quotes for ActionScript
601 # other variables should not have quotes.
602
603 $submitActionScript =~ s/\n/ /g; # replace returns with spaces -- returns in the wrong spot can cause trouble with javaScript
604 $submitActionScript =~ s/\r/ /g; # replace returns with spaces -- returns can cause trouble
605 my $base64_submitActionScript = encode_base64($submitActionScript);
606 $base64_submitActionScript =~s/\n//g;
361 607
362 $headerText =~ s/(\$\w+)/$1/gee; # interpolate variables p17 of Cookbook 608 $headerText =~ s/(\$\w+)/$1/gee; # interpolate variables p17 of Cookbook
363 609
364 return $headerText; 610 return $headerText;
365 611
373 my $appletId = $self->{appletName}; 619 my $appletId = $self->{appletName};
374 my $appletName = $self->{appletName}; 620 my $appletName = $self->{appletName};
375 my $archive = $self->{archive}; 621 my $archive = $self->{archive};
376 my $width = $self->{width}; 622 my $width = $self->{width};
377 my $height = $self->{height}; 623 my $height = $self->{height};
624 my $applet_bgcolor = $self->{bgcolor};
378 my $javaParameters = ''; 625 my $javaParameters = '';
379 my $flashParameters = ''; 626 my $flashParameters = '';
380 my %param_hash = %{$self->params()}; 627 my %param_hash = %{$self->params()};
381 foreach my $key (keys %param_hash) { 628 foreach my $key (keys %param_hash) {
382 $javaParameters .= qq!<param name ="$key" value = "$param_hash{$key}">\n!; 629 $javaParameters .= qq!<param name ="$key" value = "$param_hash{$key}">\n!;
387 634
388 $objectText = $self->{objectText}; 635 $objectText = $self->{objectText};
389 $objectText =~ s/(\$\w+)/$1/gee; 636 $objectText =~ s/(\$\w+)/$1/gee;
390 return $objectText; 637 return $objectText;
391} 638}
392sub initialize { 639# sub initialize {
393 my $self = shift; 640# my $self = shift;
394 return q{ 641# return q{
395 <script> 642# <script>
396 initializeAction(); 643# initializeAllApplets();
397 // this should really be done in the <body> tag 644# // this should really be done in the <body> tag
398 </script> 645# </script>
399 }; 646# };
400 647#
401} 648# }
402######################################################## 649########################################################
403# HEADER material for one flash or java applet 650# HEADER material for one flash or java applet
404######################################################## 651########################################################
405 652
406use constant DEFAULT_HEADER_TEXT =><<'END_HEADER_SCRIPT'; 653use constant DEFAULT_HEADER_TEXT =><<'END_HEADER_SCRIPT';
407 654 <script src="/webwork2_files/js/Base64.js" language="javascript">
655 </script>
656 <script src="/webwork2_files/js/ww_applet_support.js" language="javascript">
657 //upload functions stored in /opt/webwork/webwork2/htdocs/js ...
658
659 </script>
408 <script language="JavaScript"> 660 <script language="JavaScript">
409 661
410 // set debug mode for this applet 662
411 set_debug($debugMode); 663
412
413 ////////////////////////////////////////////////////////// 664 //////////////////////////////////////////////////////////
414 //CONFIGURATIONS 665 //TEST code
415 // 666 //
416 // configurations are "permanent" 667 //
417 ////////////////////////////////////////////////////////// 668 //////////////////////////////////////////////////////////
669
670 ww_applet_list["$appletName"] = new ww_applet("$appletName");
418 671
419 applet_config_list["$appletName"] = function() {
420 debug_add("applet_config_list:\n attempt to configure $appletName . $config ( $base64_config ) if config function is defined: "
421 );
422 try {
423 if (( typeof(getApplet("$appletName").$config) == "function" ) ) {
424 debug_add("CONFIGURE $appletName");
425 getApplet("$appletName").$config(Base64.decode("$base64_config"));
426 }
427 } catch(e) {
428 alert("Error executing configuration command $config for $appletName: " + e );
429 }
430 }
431 ////////////////////////////////////////////////////////////
432 //
433 //STATE:
434 // state can vary as the applet is manipulated -- it is reset from the questions _state values
435 //
436 //////////////////////////////////////////////////////////
437 672
438 applet_setState_list["$appletName"] = function(state) { 673 ww_applet_list["$appletName"].code = "$code";
439 debug_add("Begin setState for applet $appletName"); 674 ww_applet_list["$appletName"].codebase = "$codebase";
440 debug_add("Obtain state from $appletName"+"_state"); 675 ww_applet_list["$appletName"].appletID = "$appletID";
441 state = state || getQE("$appletName"+"_state").value; 676 ww_applet_list["$appletName"].base64_state = "$base64_initializationState";
442 if ( base64Q(state) ) { 677 ww_applet_list["$appletName"].initialState = Base64.decode("$base64_intialState");
443 state=Base64.decode(state); 678 ww_applet_list["$appletName"].base64_config = "$base64_config";
444 } 679 ww_applet_list["$appletName"].getStateAlias = "$getStateAlias";
445 if (state.match(/<xml/i) || state.match(/<?xml/i) ) { // if state starts with <?xml 680 ww_applet_list["$appletName"].setStateAlias = "$setStateAlias";
446 681 ww_applet_list["$appletName"].setConfigAlias = "$setConfigAlias";
447 debug_add("applet_setState_list: \n set (decoded) state for $appletName to " + 682 ww_applet_list["$appletName"].getConfigAlias = "$getConfigAlias";
448 state +"\nfunction type is " +typeof(getApplet("$appletName").$setState) 683 ww_applet_list["$appletName"].initializeActionAlias = "$initializeActionAlias";
449 ); 684 ww_applet_list["$appletName"].submitActionAlias = "$submitActionAlias";
450 try { 685 ww_applet_list["$appletName"].submitActionScript = Base64.decode("$submitActionScript_base64");
451 if (( typeof(getApplet("$appletName").$setState) =="function" ) ) { 686 ww_applet_list["$appletName"].answerBoxAlias = "$answerBoxAlias";
452 debug_add("setState for $appletName"); 687 ww_applet_list["$appletName"].maxInitializationAttempts = $maxInitializationAttempts;
453 getApplet("$appletName").$setState( state ); 688 ww_applet_list["$appletName"].debugMode = "$debugMode";
454 }
455 } catch(e) {
456 alert("Error in setting state of $appletName using command $setState : " + e );
457 }
458 } else if (debug) {
459 alert("new state was empty string or did not begin with <xml-- state was not reset");
460 }
461 };
462 applet_getState_list["$appletName"] = function () {
463 debug_add("get current state for applet $appletName and store it in $appletName"+"_state");
464 var applet = getApplet("$appletName");
465 try {
466 if (( typeof(applet.$getState) == "function" ) ) { // there may be no state function
467 state = applet.$getState(); // get state in xml format
468 }
469
470 if (!debug) {state = Base64.encode(state) }; // replace state by encoded version unless in debug mode
471 debug_add("state is "+state); // this should still be in plain text
472 getQE("$appletName"+"_state").value = state; //place state in input item (debug: textarea, otherwise: hidden)
473 } catch (e) {
474 alert("Error in getting state for $appletName " + e );
475 }
476 };
477
478 ////////////////////////////////////////////////////////////
479 //
480 //INITIALIZE
481 //
482 ////////////////////////////////////////////////////////////
483
484 689
485 applet_checkLoaded_list["$appletName"] = function() { // this function returns 0 unless:
486 // applet has already been flagged as ready in applet_isReady_list
487 // applet.config is defined (or alias for .config)
488 // applet.setState is defined
489 // applet.isActive is defined
490 // applet reported that it is loaded by calling loadQ()
491 var ready = 0;
492 var applet = getApplet("$appletName");
493 if (!debug && applet_isReady_list["$appletName"]) {return(1)}; // memorize readiness in non-debug mode
494 if ( typeof(applet.$config) == "function") {
495 debug_add( "applet.config is " + typeof(applet.$config) );
496 ready = 1;
497 }
498 if( typeof(applet.$getState) == "function") {
499 debug_add( "applet.getState is " + typeof(applet.$getState) );
500 ready =1;
501 }
502 if (typeof(applet.isActive) == "function" && applet.isActive ) {
503 debug_add( "applet.isActive is " + typeof(applet.isActive) );
504 ready =1;
505 }
506 if (typeof(applet_reportsLoaded_list["$appletName"]) !="undefined" && applet_reportsLoaded_list["$appletName"] != 0 ) {
507 debug_add( "applet reports that it is loaded " + applet_reportsLoaded_list["$appletName"] );
508 ready =1;
509 }
510 applet_isReady_list["$appletName"]= ready;
511 return(ready);
512 }
513
514 applet_initializeAction_list["$appletName"] = function (state) {
515 applet_setState_list["$appletName"](state);
516 };
517
518 applet_submitAction_list["$appletName"] = function () {
519 if (! applet_isReady_list["$appletName"] ) {
520 alert("$appletName is not ready");
521 }
522 applet_getState_list["$appletName"]();
523 //getQE("$returnFieldName").value = getApplet("$appletName").sendData(); //FIXME -- not needed in general?
524 };
525 </script> 690 </script>
526 691
527END_HEADER_SCRIPT 692END_HEADER_SCRIPT
528 693
529package FlashApplet; 694package FlashApplet;
530@ISA = qw(Applet); 695@ISA = qw(Applet);
531 696
532 697
698=head2 Insertion HTML code for FlashApplet
533 699
534=pod 700=pod
535 701
536The secret to making this applet work with IE in addition to normal browsers 702The secret to making this applet work with IE in addition to normal browsers
537is the addition of the C(<form></form>) construct just before the object. 703is the addition of the C(<form></form>) construct just before the object.
550 <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" 716 <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
551 id="$appletName" width="500" height="375" 717 id="$appletName" width="500" height="375"
552 codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab"> 718 codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab">
553 <param name="movie" value="$codebase/$appletName.swf" /> 719 <param name="movie" value="$codebase/$appletName.swf" />
554 <param name="quality" value="high" /> 720 <param name="quality" value="high" />
555 <param name="bgcolor" value="#869ca7" /> 721 <param name="bgcolor" value="$applet_bgcolor" />
556 <param name="allowScriptAccess" value="sameDomain" /> 722 <param name="allowScriptAccess" value="sameDomain" />
557 <embed src="$codebase/$appletName.swf" quality="high" bgcolor="#869ca7" 723 <embed src="$codebase/$appletName.swf" quality="high" bgcolor="$applet_bgcolor"
558 width="$width" height="$height" name="$appletName" align="middle" id="$appletName" 724 width="$width" height="$height" name="$appletName" align="middle" id="$appletName"
559 play="true" loop="false" quality="high" allowScriptAccess="sameDomain" 725 play="true" loop="false" quality="high" allowScriptAccess="sameDomain"
560 type="application/x-shockwave-flash" 726 type="application/x-shockwave-flash"
561 pluginspage="http://www.macromedia.com/go/getflashplayer"> 727 pluginspage="http://www.macromedia.com/go/getflashplayer">
562 </embed> 728 </embed>
572 <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" 738 <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
573 id="$appletName" width="500" height="375" 739 id="$appletName" width="500" height="375"
574 codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab"> 740 codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab">
575 <param name="movie" value="$codebase/$appletName.swf" /> 741 <param name="movie" value="$codebase/$appletName.swf" />
576 <param name="quality" value="high" /> 742 <param name="quality" value="high" />
577 <param name="bgcolor" value="#869ca7" /> 743 <param name="bgcolor" value="$applet_bgcolor" />
578 <param name="allowScriptAccess" value="sameDomain" /> 744 <param name="allowScriptAccess" value="sameDomain" />
579 <param name="FlashVars" value="$flashParameters"/> 745 <param name="FlashVars" value="$flashParameters"/>
580 <embed src="$codebase/$appletName.swf" quality="high" bgcolor="#869ca7" 746 <embed src="$codebase/$appletName.swf" quality="high" bgcolor="$applet_bgcolor"
581 width="$width" height="$height" name="$appletName" align="middle" id="$appletName" 747 width="$width" height="$height" name="$appletName" align="middle" id="$appletName"
582 play="true" loop="false" quality="high" allowScriptAccess="sameDomain" 748 play="true" loop="false" quality="high" allowScriptAccess="sameDomain"
583 type="application/x-shockwave-flash" 749 type="application/x-shockwave-flash"
584 pluginspage="http://www.macromedia.com/go/getflashplayer" 750 pluginspage="http://www.macromedia.com/go/getflashplayer"
585 FlashVars="$flashParameters"> 751 FlashVars="$flashParameters">
598 764
599 765
600package JavaApplet; 766package JavaApplet;
601@ISA = qw(Applet); 767@ISA = qw(Applet);
602 768
603 769=head2 Insertion HTML code for JavaApplet
604 770
605=pod 771=pod
606 772
607The secret to making this applet work with IE in addition to normal browsers 773The secret to making this applet work with IE in addition to normal browsers
608is the addition of the C(<form></form>) construct just before the object. 774is the addition of the C(<form></form>) construct just before the object.
642 archive = "$archive" 808 archive = "$archive"
643 name = "$appletName" 809 name = "$appletName"
644 id = "$appletName" 810 id = "$appletName"
645 width = "$width" 811 width = "$width"
646 height = "$height" 812 height = "$height"
813 bgcolor = "$applet_bgcolor"
647 MAYSCRIPT 814 MAYSCRIPT
648 > 815 >
649 $javaParameters 816 $javaParameters
650 817
651 Sorry, the Applet could not be started. Please make sure that 818 Sorry, the Applet could not be started. Please make sure that

Legend:
Removed from v.5667  
changed lines
  Added in v.6026

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9