1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2004-2007 1&1 Internet AG, Germany, http://www.1and1.org
2006 Derrell Lipman
2006 STZ-IDA, Germany, http://www.stz-ida.de
License:
LGPL: http://www.gnu.org/licenses/lgpl.html
EPL: http://www.eclipse.org/org/documents/epl-v10.php
See the LICENSE file in the project's top-level directory for details.
Authors:
* Sebastian Werner (wpbasti)
* Andreas Ecker (ecker)
* Derrell Lipman (derrell)
* Andreas Junghans (lucidcake)
************************************************************************ */
/* ************************************************************************
#module(io_remote)
#require(qx.io.remote.Exchange)
************************************************************************ */
/*!
Transports requests to a server using dynamic script tags.
This class should not be used directly by client programmers.
*/
qx.OO.defineClass("qx.io.remote.ScriptTransport", qx.io.remote.AbstractRemoteTransport,
function()
{
qx.io.remote.AbstractRemoteTransport.call(this);
var vUniqueId = ++qx.io.remote.ScriptTransport._uniqueId;
if (vUniqueId >= 2000000000) {
qx.io.remote.ScriptTransport._uniqueId = vUniqueId = 1;
}
this._element = null;
this._uniqueId = vUniqueId;
});
qx.Class._uniqueId = 0;
qx.Class._instanceRegistry = {};
qx.Class.ScriptTransport_PREFIX = "_ScriptTransport_";
qx.Class.ScriptTransport_ID_PARAM = qx.Class.ScriptTransport_PREFIX + "id";
qx.Class.ScriptTransport_DATA_PARAM = qx.Class.ScriptTransport_PREFIX + "data";
qx.Proto._lastReadyState = 0;
/*
---------------------------------------------------------------------------
CLASS PROPERTIES AND METHODS
---------------------------------------------------------------------------
*/
// basic registration to qx.io.remote.Exchange
// the real availability check (activeX stuff and so on) follows at the first real request
qx.io.remote.Exchange.registerType(qx.io.remote.ScriptTransport, "qx.io.remote.ScriptTransport");
qx.io.remote.ScriptTransport.handles =
{
synchronous : false,
asynchronous : true,
crossDomain : true,
fileUpload: false,
responseTypes : [ qx.util.Mime.TEXT, qx.util.Mime.JAVASCRIPT, qx.util.Mime.JSON ]
}
qx.io.remote.ScriptTransport.isSupported = function() {
return true;
}
/*
---------------------------------------------------------------------------
USER METHODS
---------------------------------------------------------------------------
*/
qx.Proto.send = function()
{
var vUrl = this.getUrl();
// --------------------------------------
// Adding parameters
// --------------------------------------
vUrl += (vUrl.indexOf("?") >= 0 ? "&" : "?") + qx.io.remote.ScriptTransport.ScriptTransport_ID_PARAM + "=" + this._uniqueId;
var vParameters = this.getParameters();
var vParametersList = [];
for (var vId in vParameters) {
if (vId.indexOf(qx.io.remote.ScriptTransport.ScriptTransport_PREFIX) == 0) {
this.error("Illegal parameter name. The following prefix is used internally by qooxdoo): " +
qx.io.remote.ScriptTransport.ScriptTransport_PREFIX);
}
var value = vParameters[vId];
if (value instanceof Array) {
for (var i = 0; i < value.length; i++) {
vParametersList.push(encodeURIComponent(vId) + "=" +
encodeURIComponent(value[i]));
}
} else {
vParametersList.push(encodeURIComponent(vId) + "=" +
encodeURIComponent(value));
}
}
if (vParametersList.length > 0) {
vUrl += "&" + vParametersList.join("&");
}
// --------------------------------------
// Sending data
// --------------------------------------
vData = this.getData();
if (vData != null) {
vUrl += "&" + qx.io.remote.ScriptTransport.ScriptTransport_DATA_PARAM + "=" + encodeURIComponent(vData);
}
qx.io.remote.ScriptTransport._instanceRegistry[this._uniqueId] = this;
this._element = document.createElement("script");
this._element.charset = "utf-8"; // IE needs this (it ignores the
// encoding from the header sent by the
// server for dynamic script tags)
this._element.src = vUrl;
document.body.appendChild(this._element);
}
/*
---------------------------------------------------------------------------
EVENT LISTENER
---------------------------------------------------------------------------
*/
// For reference:
// http://msdn.microsoft.com/workshop/author/dhtml/reference/properties/readyState_1.asp
qx.io.remote.ScriptTransport._numericMap =
{
"uninitialized" : 1,
"loading" : 2,
"loaded" : 2,
"interactive" : 3,
"complete" : 4
}
qx.Proto._switchReadyState = function(vReadyState)
{
// Ignoring already stopped requests
switch(this.getState())
{
case "completed":
case "aborted":
case "failed":
case "timeout":
this.warn("Ignore Ready State Change");
return;
}
// Updating internal state
while (this._lastReadyState < vReadyState) {
this.setState(qx.io.remote.Exchange._nativeMap[++this._lastReadyState]);
}
}
qx.Class._requestFinished = function(id, content) {
var vInstance = qx.io.remote.ScriptTransport._instanceRegistry[id];
if (vInstance == null) {
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug")) {
this.warn("Request finished for an unknown instance (probably aborted or timed out before)");
}
} else {
vInstance._responseContent = content;
vInstance._switchReadyState(qx.io.remote.ScriptTransport._numericMap.complete);
}
}
/*
---------------------------------------------------------------------------
REQUEST HEADER SUPPORT
---------------------------------------------------------------------------
*/
qx.Proto.setRequestHeader = function(vLabel, vValue)
{
// TODO
// throw new Error("setRequestHeader is abstract");
}
/*
---------------------------------------------------------------------------
RESPONSE HEADER SUPPORT
---------------------------------------------------------------------------
*/
qx.Proto.getResponseHeader = function(vLabel)
{
return null;
// TODO
// this.error("Need implementation", "getResponseHeader");
}
/*!
Provides an hash of all response headers.
*/
qx.Proto.getResponseHeaders = function()
{
return {}
// TODO
// throw new Error("getResponseHeaders is abstract");
}
/*
---------------------------------------------------------------------------
STATUS SUPPORT
---------------------------------------------------------------------------
*/
/*!
Returns the current status code of the request if available or -1 if not.
*/
qx.Proto.getStatusCode = function()
{
return 200;
// TODO
// this.error("Need implementation", "getStatusCode");
}
/*!
Provides the status text for the current request if available and null otherwise.
*/
qx.Proto.getStatusText = function()
{
return "";
// TODO
// this.error("Need implementation", "getStatusText");
}
/*
---------------------------------------------------------------------------
RESPONSE DATA SUPPORT
---------------------------------------------------------------------------
*/
/*!
Returns the length of the content as fetched thus far
*/
qx.Proto.getFetchedLength = function()
{
return 0;
// TODO
// throw new Error("getFetchedLength is abstract");
}
qx.Proto.getResponseContent = function()
{
if (this.getState() !== "completed")
{
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug")) {
this.warn("Transfer not complete, ignoring content!");
}
return null;
}
if (qx.Settings.getValueOfClass("qx.io.remote.Exchange", "enableDebug")) {
this.debug("Returning content for responseType: " + this.getResponseType());
}
switch(this.getResponseType())
{
case qx.util.Mime.TEXT:
// server is responsible for using a string as the response
case qx.util.Mime.JSON:
case qx.util.Mime.JAVASCRIPT:
return this._responseContent;
default:
this.warn("No valid responseType specified (" + this.getResponseType() + ")!");
return null;
}
}
/*
---------------------------------------------------------------------------
DISPOSER
---------------------------------------------------------------------------
*/
qx.Proto.dispose = function()
{
if (this.getDisposed()) {
return true;
}
if (this._element != null)
{
delete qx.io.remote.ScriptTransport._instanceRegistry[this._uniqueId];
document.body.removeChild(this._element);
this._element = null;
}
return qx.io.remote.AbstractRemoteTransport.prototype.dispose.call(this);
}
|