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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
/**
* Override Prototype's response implementation.
*/
Object.extend(Ajax.Request.prototype,
{
/**
* Customize the response, dispatch onXXX response code events, and
* tries to execute response actions (javascript statements).
*/
respondToReadyState : function(readyState)
{
var event = Ajax.Request.Events[readyState];
var transport = this.transport, json = this.getHeaderData(Prado.CallbackRequest.DATA_HEADER);
if (event == 'Complete')
{
try
{
Prado.CallbackRequest.updatePageState(this,transport);
Ajax.Responders.dispatch('on' + transport.status, this, transport, json);
Prado.CallbackRequest.dispatchActions(transport,this.getHeaderData(Prado.CallbackRequest.ACTION_HEADER));
(this.options['on' + this.transport.status]
|| this.options['on' + (this.responseIsSuccess() ? 'Success' : 'Failure')]
|| Prototype.emptyFunction)(transport, json);
} catch (e) {
this.dispatchException(e);
}
if ((this.header('Content-type') || '').match(/^text\/javascript/i))
this.evalResponse();
}
try {
(this.options['on' + event] || Prototype.emptyFunction)(transport, json);
Ajax.Responders.dispatch('on' + event, this, transport, json);
} catch (e) {
this.dispatchException(e);
}
/* Avoid memory leak in MSIE: clean up the oncomplete event handler */
if (event == 'Complete')
this.transport.onreadystatechange = Prototype.emptyFunction;
},
/**
* Gets header data assuming JSON encoding.
* @param string header name
* @return object header data as javascript structures.
*/
getHeaderData : function(name)
{
try
{
var json = this.header(name);
return eval('(' + json + ')');
}
catch (e)
{
if(typeof(json) == "string")
{
Logger.info("using json")
return Prado.CallbackRequest.decode(json);
}
}
}
});
/**
* Prado Callback client-side request handler.
*/
Prado.CallbackRequest = Class.create();
/**
* Static definitions.
*/
Object.extend(Prado.CallbackRequest,
{
/**
* Callback request target POST field name.
*/
FIELD_CALLBACK_TARGET : 'PRADO_CALLBACK_TARGET',
/**
* Callback request parameter POST field name.
*/
FIELD_CALLBACK_PARAMETER : 'PRADO_CALLBACK_PARAMETER',
/**
* Callback request page state field name,
*/
FIELD_CALLBACK_PAGESTATE : 'PRADO_PAGESTATE',
/**
* List of form fields that will be collected during callback.
*/
PostDataLoaders : [],
/**
* Response data header name.
*/
DATA_HEADER : 'X-PRADO-DATA',
/**
* Response javascript execution statement header name.
*/
ACTION_HEADER : 'X-PRADO-ACTIONS',
/**
* Response errors/exceptions header name.
*/
ERROR_HEADER : 'X-PRADO-ERROR',
/**
* Page state header name.
*/
PAGESTATE_HEADER : 'X-PRADO-PAGESTATE',
/**
* Current requests in progress.
*/
requestInProgress : null,
/**
* Dispatch callback response actions.
*/
dispatchActions : function(transport,actions)
{
if(actions && actions.length > 0)
actions.each(this.__run.bind(this,transport));
},
/**
* Prase and evaluate a Callback clien-side action
*/
__run : function(transport, command)
{
for(var method in command)
{
if(command[method][0])
{
var id = command[method][0];
if($(id) || id.indexOf("[]") > -1)
method.toFunction().apply(this,command[method].concat(transport));
else if(typeof(Logger) != "undefined")
{
Logger.error("Error in executing callback response:",
"Unable to find HTML element with ID '"+id+"' before executing "+method+"().");
}
}
}
},
/**
* Respond to Prado Callback request exceptions.
*/
Exception :
{
/**
* Server returns 500 exception. Just log it.
*/
"on500" : function(request, transport, data)
{
var e = request.getHeaderData(Prado.CallbackRequest.ERROR_HEADER);
Logger.error("Callback Server Error "+e.code, this.formatException(e));
},
/**
* Callback OnComplete event,logs reponse and data to console.
*/
'on200' : function(request, transport, data)
{
if(transport.status < 500)
{
var msg = 'HTTP '+transport.status+" with response : \n";
msg += transport.responseText + "\n";
msg += "Data : \n"+inspect(data)+"\n";
msg += "Actions : \n";
data = request.getHeaderData(Prado.CallbackRequest.ACTION_HEADER);
if(data && data.length > 0)
{
data.each(function(action)
{
msg += inspect(action)+"\n";
});
}
Logger.warn(msg);
}
},
/**
* Uncaught exceptions during callback response.
*/
onException : function(request,e)
{
msg = "";
for(var v in e)
{
if(typeof(v[e]) != "object" && typeof(v[e]) != "function")
msg += v+":"+e[v]+"\n";
}
Logger.error('Uncaught Callback Client Exception:', e);
},
/**
* Formats the exception message for display in console.
*/
formatException : function(e)
{
var msg = e.type + " with message \""+e.message+"\"";
msg += " in "+e.file+"("+e.line+")\n";
msg += "Stack trace:\n";
var trace = e.trace;
for(var i = 0; i<trace.length; i++)
{
msg += " #"+i+" "+trace[i].file;
msg += "("+trace[i].line+"): ";
msg += trace[i]["class"]+"->"+trace[i]["function"]+"()"+"\n";
}
msg += e.version+" "+e.time+"\n";
return msg;
}
},
/**
* @return string JSON encoded data.
*/
encode : function(data)
{
return Prado.JSON.stringify(data);
},
/**
* @return mixed javascript data decoded from string using JSON decoding.
*/
decode : function(data)
{
if(typeof(data) == "string" && data.trim().length > 0)
return Prado.JSON.parse(data);
else
return null;
},
/**
* Dispatch a priority request, it will call abortRequestInProgress first.
*/
dispatchPriorityRequest : function(callback)
{
Logger.info("priority request "+callback.id)
this.abortRequestInProgress();
callback.request = new Ajax.Request(callback.url, callback.options);
callback.timeout = setTimeout(function()
{
Logger.warn("priority timeout");
Prado.CallbackRequest.abortRequestInProgress();
},callback.options.RequestTimeOut);
this.requestInProgress = callback;
Logger.info("dispatched "+this.requestInProgress)
},
/**
* Dispatch a normal request, no timeouts or aborting of requests.
*/
dispatchNormalRequest : function(callback)
{
Logger.info("dispatching normal request");
new Ajax.Request(callback.url, callback.options);
},
/**
* Abort the current priority request in progress.
*/
abortRequestInProgress : function()
{
inProgress = Prado.CallbackRequest.requestInProgress;
Logger.info("aborting ... "+inProgress);
if(inProgress)
{
Logger.warn("aborted "+inProgress.id)
inProgress.request.transport.abort();
clearTimeout(inProgress.timeout);
Prado.CallbackRequest.requestInProgress = null;
return true;
}
return false;
},
/**
* Updates the page state. It will update only if EnablePageStateUpdate and
* HasPriority options are both true.
*/
updatePageState : function(request, transport)
{
pagestate = $(this.FIELD_CALLBACK_PAGESTATE);
if(request.options.EnablePageStateUpdate && request.options.HasPriority && pagestate)
{
data = request.header(this.PAGESTATE_HEADER);
if(typeof(data) == "string" && data.length > 0)
{
Logger.warn("updating page state");
pagestate.value = data;
}
else
{
Logger.debug("Bad page state:"+data);
}
}
}
})
/**
* Automatically aborts the current request when a priority request has returned.
*/
Ajax.Responders.register({onComplete : function(request)
{
if(request.options.HasPriority)
Prado.CallbackRequest.abortRequestInProgress();
}});
//Add HTTP exception respones when logger is enabled.
Event.OnLoad(function()
{
if(typeof Logger != "undefined")
Ajax.Responders.register(Prado.CallbackRequest.Exception);
});
/**
* Create and prepare a new callback request.
*/
Prado.CallbackRequest.prototype =
{
/**
* Callback URL, same url as the current page.
*/
url : window.location.href,
/**
* Callback options, including onXXX events.
*/
options : { },
/**
* Callback target ID. E.g. $control->getUniqueID();
*/
id : null,
/**
* Current callback request.
*/
request : null,
/**
* Prepare and inititate a callback request.
*/
initialize : function(id, options)
{
this.id = id;
this.options =
{
RequestTimeOut : 30000, // 30 second timeout.
EnablePageStateUpdate : true,
HasPriority : true,
CausesValidation : true,
ValidationGroup : null,
PostInputs : true
}
Object.extend(this.options, options || {});
//override parameter and postBody options.
Object.extend(this.options,
{
postBody : this._getPostData(),
parameters : ''
});
if(this.options.CausesValidation && typeof(Prado.Validation) != "undefined")
{
var form = this.options.Form || Prado.Validation.getForm();
if(Prado.Validation.validate(form,this.options.ValidationGroup,this) == false)
return;
}
if(this.options.HasPriority)
Prado.CallbackRequest.dispatchPriorityRequest(this);
else
Prado.CallbackRequest.dispatchNormalRequest(this);
},
/**
* Collects the form inputs, encode the parameters, and sets the callback
* target id. The resulting string is the request content body.
* @return string request body content containing post data.
*/
_getPostData : function()
{
var data = {};
var callback = Prado.CallbackRequest;
if(this.options.PostInputs != false)
{
callback.PostDataLoaders.each(function(name)
{
$A(document.getElementsByName(name)).each(function(element)
{
var value = $F(element);
if(typeof(value) != "undefined")
data[name] = value;
})
})
}
if(typeof(this.options.params) != "undefined")
data[callback.FIELD_CALLBACK_PARAMETER] = callback.encode(this.options.params);
var pageState = $F(callback.FIELD_CALLBACK_PAGESTATE);
if(typeof(pageState) != "undefined")
data[callback.FIELD_CALLBACK_PAGESTATE] = pageState;
data[callback.FIELD_CALLBACK_TARGET] = this.id;
return $H(data).toQueryString();
}
}
/**
* Create a new callback request using default settings.
* @param string callback handler unique ID.
* @param mixed parameter to pass to callback handler on the server side.
* @param function client side onSuccess event handler.
* @param object additional request options.
* @return boolean always false.
*/
Prado.Callback = function(UniqueID, parameter, onSuccess, options)
{
var callback =
{
'params' : parameter || '',
'onSuccess' : onSuccess || Prototype.emptyFunction
};
Object.extend(callback, options || {});
new Prado.CallbackRequest(UniqueID, callback);
return false;
}
|