/*
Copyright (c) 2009, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.net/yui/license.txt
version: 3.0.0b1
build: 1163
*/
YUI.add('io-base', function(Y) {
/**
* Base IO functionality. Provides basic XHR transport support.
* @module io
* @submodule io-base
*/
/**
* The io class is a utility that brokers HTTP requests through a simplified
* interface. Specifically, it allows JavaScript to make HTTP requests to
* a resource without a page reload. The underlying transport for making
* same-domain requests is the XMLHttpRequest object. YUI.io can also use
* Flash, if specified as a transport, for cross-domain requests.
*
* @class io
*/
/**
* @event io:start
* @description This event is fired by YUI.io when a transaction is initiated.
* @type Event Custom
*/
var E_START = 'io:start',
/**
* @event io:complete
* @description This event is fired by YUI.io when a transaction is complete.
* Response status and data are accessible, if available.
* @type Event Custom
*/
E_COMPLETE = 'io:complete',
/**
* @event io:success
* @description This event is fired by YUI.io when a transaction is complete, and
* the HTTP status resolves to HTTP2xx.
* @type Event Custom
*/
E_SUCCESS = 'io:success',
/**
* @event io:failure
* @description This event is fired by YUI.io when a transaction is complete, and
* the HTTP status resolves to HTTP4xx, 5xx and above.
* @type Event Custom
*/
E_FAILURE = 'io:failure',
/**
* @event io:end
* @description This event signifies the end of the transaction lifecycle. The
* transaction transport is destroyed.
* @type Event Custom
*/
E_END = 'io:end',
//--------------------------------------
// Properties
//--------------------------------------
/**
* @description A transaction counter that increments for each transaction.
*
* @property transactionId
* @private
* @static
* @type int
*/
transactionId = 0,
/**
* @description Object of default HTTP headers to be initialized and sent
* for all transactions.
*
* @property _headers
* @private
* @static
* @type object
*/
_headers = {
'X-Requested-With' : 'XMLHttpRequest'
},
/**
* @description Object that stores timeout values for any transaction with
* a defined "timeout" configuration property.
*
* @property _timeOut
* @private
* @static
* @type object
*/
_timeout = {},
// Window reference
w = Y.config.win;
//--------------------------------------
// Methods
//--------------------------------------
/**
* @description Method for requesting a transaction. _io() is implemented as
* yui.io(). Each transaction may include a configuration object. Its
* properties are:
*
* method: HTTP method verb (e.g., GET or POST). If this property is not
* not defined, the default value will be GET.
*
* data: This is the name-value string that will be sent as the transaction
* data. If the request is HTTP GET, the data become part of
* querystring. If HTTP POST, the data are sent in the message body.
*
* xdr: Defines the transport to be used for cross-domain requests. By
* setting this property, the transaction will use the specified
* transport instead of XMLHttpRequest. Currently, the only alternate
* transport supported is Flash (e.g., { xdr: 'flash' }).
*
* form: This is a defined object used to process HTML form as data. The
* properties are:
* {
* id: object, //HTML form object or id of HTML form
* useDisabled: boolean, //Allow disabled HTML form field values
* to be sent as part of the data.
* }
*
* on: This is a defined object used to create and handle specific
* events during a transaction lifecycle. These events will fire in
* addition to the global io events. The events are:
* start - This event is fired when a request is sent to a resource.
* complete - This event fires when the transaction is complete.
* success - This event fires when the response status resolves to
* HTTP 2xx.
* failure - This event fires when the response status resolves to
* HTTP 4xx, 5xx; and, for all transaction exceptions,
* including aborted transactions and transaction timeouts.
* end - This even is fired at the conclusion of the transaction
* lifecycle, after a success or failure resolution.
*
* The properties are:
* {
* start: function(id, args){},
* complete: function(id, responseobject, args){},
* success: function(id, responseobject, args){},
* failure: function(id, responseobject, args){},
* end: function(id, args){}
* }
* Each property can reference a function or be written as an
* inline function.
*
* context: Object reference for an event handler when it is implemented
* as a method of a base object. Defining "context" will preserve
* the proper reference of "this" used in the event handler.
* headers: This is a defined object of client headers, as many as.
* desired for the transaction. These headers are sentThe object
* pattern is:
* {
* header: value
* }
*
* timeout: This value, defined as milliseconds, is a time threshold for the
* transaction. When this threshold is reached, and the transaction's
* Complete event has not yet fired, the transaction will be aborted.
* arguments: Object, array, string, or number passed to all registered
* event handlers. This value is available as the second
* argument in the "start" and "abort" event handlers; and, it is
* the third argument in the "complete", "success", and "failure"
* event handlers.
*
* @method _io
* @private
* @static
* @param {string} uri - qualified path to transaction resource.
* @param {object} c - configuration object for the transaction.
* @return object
*/
function _io(uri, c) {
var u, f,
// Set default value of argument c to Object if
// configuration object "c" does not exist.
c = c || {},
o = _create((arguments.length === 3) ? arguments[2] : null, c),
m = (c.method) ? c.method.toUpperCase() : 'GET',
d = (c.data) ? c.data : null;
o.abort = function () {
c.xdr ? o.c.abort(o.id, c) : _ioCancel(o, 'abort');
};
o.isInProgress = function() {
var s = (c.xdr) ? _isInProgress(o) : (o.c.readyState !== 4 && o.c.readyState !== 0);
return s;
};
/* Determine configuration properties */
// If config.form is defined, perform data operations.
if (c.form) {
if (c.form.upload) {
u = Y.io._upload(o, uri, c);
return u;
}
// Serialize the HTML form into a string of name-value pairs.
f = Y.io._serialize(c.form);
// If config.data is defined, concatenate the data to the form string.
if (d) {
f += "&" + d;
Y.log('Configuration object.data added to serialized HTML form data. The string is: ' + f, 'info', 'io');
}
if (m === 'POST') {
d = f;
_setHeader('Content-Type', 'application/x-www-form-urlencoded');
}
else if (m === 'GET') {
uri = _concat(uri, f);
Y.log('Configuration object.data added to serialized HTML form data. The querystring is: ' + uri, 'info', 'io');
}
}
else if (d && m === 'POST') {
_setHeader('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8');
}
if (c.xdr) {
Y.io._xdr(uri, o, c);
return o;
}
// If config.timeout is defined, and the request is standard XHR,
// initialize timeout polling.
if (c.timeout) {
_startTimeout(o, c.timeout);
}
/* End Configuration Properties */
o.c.onreadystatechange = function() { _readyState(o, c); };
try { _open(o.c, m, uri); } catch (e0) {}
_setHeaders(o.c, (c.headers || {}));
// Do not pass null, in the absence of data, as this
// will result in a POST request with no Content-Length
// defined.
_async(o, (d || ''), c);
return o;
}
/**
* @description Method for creating and subscribing transaction events.
*
* @method _tPubSub
* @private
* @static
* @param {string} e - event to be published
* @param {object} c - configuration data subset for event subscription.
*
* @return void
*/
function _tPubSub(e, c){
var event = new Y.EventTarget().publish('transaction:' + e);
event.subscribe(c.on[e], (c.context || this), c.arguments);
return event;
}
/**
* @description Fires event "io:start" and creates, fires a
* transaction-specific start event, if config.on.start is
* defined.
*
* @method _ioStart
* @private
* @static
* @param {number} id - transaction id
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
function _ioStart(id, c) {
var m = Y.io._fn || {},
fn = (m && m[id]) ? m[id] : null,
event;
// Set default value of argument c, property "on" to Object if
// the property is null or undefined.
c.on = c.on || {};
if (fn) {
c.on.start = fn.start;
}
Y.fire(E_START, id);
if (c.on.start) {
event = _tPubSub('start', c);
event.fire(id);
}
Y.log('Transaction ' + id + ' started.', 'info', 'io');
}
/**
* @description Fires event "io:complete" and creates, fires a
* transaction-specific "complete" event, if config.on.complete is
* defined.
*
* @method _ioComplete
* @private
* @static
* @param {object} o - transaction object.
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
function _ioComplete(o, c) {
var r, event;
// Set default value of argument c, property "on" to Object if
// the property is null or undefined.
c.on = c.on || {};
r = (o.status) ? _response(o.status) : o.c;
Y.fire(E_COMPLETE, o.id, r);
if (c.on.complete) {
event = _tPubSub('complete', c);
event.fire(o.id, r);
}
Y.log('Transaction ' + o.id + ' completed.', 'info', 'io');
}
/**
* @description Fires event "io:success" and creates, fires a
* transaction-specific "success" event, if config.on.success is
* defined.
*
* @method _ioSuccess
* @private
* @static
* @param {object} o - transaction object.
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
function _ioSuccess(o, c) {
var m = Y.io._fn || {},
fn = (m && m[o.id]) ? m[o.id] : null,
event;
// Set default value of argument c, property "on" to Object if
// the property is null or undefined.
c.on = c.on || {};
if (fn) {
c.on.success = fn.success;
//Decode the response from IO.swf
o.c.responseText = decodeURI(o.c.responseText);
}
Y.fire(E_SUCCESS, o.id, o.c);
if (c.on.success) {
event = _tPubSub('success', c);
event.fire(o.id, o.c);
}
Y.log('HTTP Status evaluates to Success. The transaction is: ' + o.id, 'info', 'io');
_ioEnd(o, c);
}
/**
* @description Fires event "io:failure" and creates, fires a
* transaction-specific "failure" event, if config.on.failure is
* defined.
*
* @method _ioFailure
* @private
* @static
* @param {object} o - transaction object.
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
function _ioFailure(o, c) {
var m = Y.io._fn || {},
fn = (m && m[o.id]) ? m[o.id] : null,
r, event;
// Set default value of argument c, property "on" to Object if
// the property is null or undefined.
c.on = c.on || {};
if (fn) {
c.on.failure = fn.failure;
//Decode the response from IO.swf
o.c.responseText = decodeURI(o.c.responseText);
}
r = (o.status) ? _response(o.status) : o.c;
Y.fire(E_FAILURE, o.id, r);
if (c.on.failure) {
event = _tPubSub('failure', c);
event.fire(o.id, r);
}
Y.log('HTTP Status evaluates to Failure. The transaction is: ' + o.id, 'info', 'io');
_ioEnd(o, c);
}
/**
* @description Fires event "io:end" and creates, fires a
* transaction-specific "end" event, if config.on.end is
* defined.
*
* @method _ioEnd
* @private
* @static
* @param {object} o - transaction object.
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
function _ioEnd(o, c) {
var m = Y.io._fn || {},
fn = (m && m[o.id]) ? m[o.id] : null,
event;
// Set default value of argument c, property "on" to Object if
// the property is null or undefined.
c.on = c.on || {};
if (fn) {
c.on.end = fn.end;
delete m[o.id];
}
Y.fire(E_END, o.id);
if (c.on.end) {
event = _tPubSub('end', c);
event.fire(o.id);
}
_destroy(o, (c.xdr) ? true : false );
Y.log('Transaction ' + o.id + ' ended.', 'info', 'io');
}
/**
* @description Terminates a transaction due to an explicit abort or
* timeout.
*
* @method _ioCancel
* @private
* @static
* @param {object} o - Transaction object generated by _create().
* @param {object} c - Configuration object passed to YUI.io().
* @param {string} s - Identifies timed out or aborted transaction.
*
* @return void
*/
function _ioCancel(o, s) {
if (o && o.c) {
o.status = s;
o.c.abort();
}
Y.log('Transaction cancelled due to time out or explicitly aborted. The transaction is: ' + o.id, 'info', 'io');
}
/**
* @description Determines if a cross-domain transaction is still
* in progress.
*
* @method _isInProgress
* @private
* @static
* @param {object} o - Transaction object generated by _create().
*
* @return boolean
*/
function _isInProgress(o) {
return o.c.isInProgress(o.id);
}
function _response(s) {
return { status:0, statusText:s };
}
/**
* @description Method that increments _transactionId for each transaction.
*
* @method _id
* @private
* @static
* @return int
*/
function _id() {
var id = transactionId;
transactionId++;
Y.log('Transaction id generated. The id is: ' + id, 'info', 'io');
return id;
}
/**
* @description Method that creates a unique transaction object for each
* request.
*
* @method _create
* @private
* @static
* @param {number} s - URI or root data.
* @param {number} c - configuration object
* @return object
*/
function _create(i, c) {
var o = {};
o.id = Y.Lang.isNumber(i) ? i : _id();
if (c.xdr) {
o.c = Y.io._transport[c.xdr.use];
}
else if (c.form && c.form.upload) {
o.c = {};
}
else {
o.c = _xhr();
}
return o;
};
/**
* @description Method that creates the XMLHttpRequest transport
*
* @method _xhr
* @private
* @static
* @return object
*/
function _xhr() {
return (w.XMLHttpRequest) ? new XMLHttpRequest() : new ActiveXObject('Microsoft.XMLHTTP');
}
/**
* @description Method that concatenates string data for HTTP GET transactions.
*
* @method _concat
* @private
* @static
* @param {string} s - URI or root data.
* @param {string} d - data to be concatenated onto URI.
* @return int
*/
function _concat(s, d) {
s += ((s.indexOf('?') == -1) ? '?' : '&') + d;
return s;
}
/**
* @description Method that stores default client headers for all transactions.
* If a label is passed with no value argument, the header will be deleted.
*
* @method _setHeader
* @private
* @static
* @param {string} l - HTTP header
* @param {string} v - HTTP header value
* @return int
*/
function _setHeader(l, v) {
if (v) {
_headers[l] = v;
}
else {
delete _headers[l];
}
}
/**
* @description Method that sets all HTTP headers to be sent in a transaction.
*
* @method _setHeaders
* @private
* @static
* @param {object} o - XHR instance for the specific transaction.
* @param {object} h - HTTP headers for the specific transaction, as defined
* in the configuration object passed to YUI.io().
* @return void
*/
function _setHeaders(o, h) {
var p;
for (p in _headers) {
if (_headers.hasOwnProperty(p)) {
if (h[p]) {
// Configuration headers will supersede IO preset headers,
// if headers match.
Y.log('Matching configuration HTTP header: ' + p + ' found with value of ' + _headers[p], 'info', 'io');
break;
}
else {
h[p] = _headers[p];
Y.log('HTTP header ' + p + ' found with value of ' + _headers[p], 'info', 'io');
}
}
}
for (p in h) {
if (h.hasOwnProperty(p)) {
o.setRequestHeader(p, h[p]);
Y.log('HTTP Header ' + p + ' set with value of ' + h[p], 'info', 'io');
}
}
}
function _open(o, m, uri) {
o.open(m, uri, true);
}
/**
* @description Method that sends the transaction request.
*
* @method _async
* @private
* @static
* @param {object} o - Transaction object generated by _create().
* @param {string} d - Transaction data.
* @param {object} c - Configuration object passed to YUI.io().
* @return void
*/
function _async(o, d, c) {
o.c.send(d);
_ioStart(o.id, c);
}
/**
* @description Starts timeout count if the configuration object
* has a defined timeout property.
*
* @method _startTimeout
* @private
* @static
* @param {object} o - Transaction object generated by _create().
* @param {object} c - Configuration object passed to YUI.io().
* @return void
*/
function _startTimeout(o, timeout) {
_timeout[o.id] = w.setTimeout(function() { _ioCancel(o, 'timeout'); }, timeout);
}
/**
* @description Clears the timeout interval started by _startTimeout().
*
* @method _clearTimeout
* @private
* @static
* @param {number} id - Transaction id.
* @return void
*/
function _clearTimeout(id) {
w.clearTimeout(_timeout[id]);
delete _timeout[id];
}
/**
* @description Event handler bound to onreadystatechange.
*
* @method _readyState
* @private
* @static
* @param {object} o - Transaction object generated by _create().
* @param {object} c - Configuration object passed to YUI.io().
* @return void
*/
function _readyState(o, c) {
if (o.c.readyState === 4) {
if (c.timeout) {
_clearTimeout(o.id);
}
w.setTimeout(
function() {
_ioComplete(o, c);
_handleResponse(o, c);
}, 0);
}
}
/**
* @description Method that determines if a transaction response qualifies
* as success or failure, based on the response HTTP status code, and
* fires the appropriate success or failure events.
*
* @method _handleResponse
* @private
* @static
* @param {object} o - Transaction object generated by _create().
* @param {object} c - Configuration object passed to io().
* @return void
*/
function _handleResponse(o, c) {
var status;
try{
if (o.c.status && o.c.status !== 0) {
status = o.c.status;
}
else {
status = 0;
}
}
catch(e1) {
status = 0;
Y.log('HTTP status unreadable. The transaction is: ' + o.id, 'warn', 'io');
}
// IE reports HTTP 204 as HTTP 1223.
// But, the response data are still available.
if (status >= 200 && status < 300 || status === 1223) {
_ioSuccess(o, c);
}
else {
_ioFailure(o, c);
}
}
function _destroy(o, isTransport) {
// IE, when using XMLHttpRequest as an ActiveX Object, will throw
// a "Type Mismatch" error if the event handler is set to "null".
if(w.XMLHttpRequest && !isTransport) {
if (o.c) {
o.c.onreadystatechange = null;
}
}
o.c = null;
o = null;
}
_io.start = _ioStart;
_io.complete = _ioComplete;
_io.success = _ioSuccess;
_io.failure = _ioFailure;
_io.isInProgress = _isInProgress;
_io._id = _id;
//--------------------------------------
// Begin public interface definition
//--------------------------------------
/**
* @description Method that stores default client headers for all transactions.
* If a label is passed with no value argument, the header will be deleted.
* This is the interface for _setHeader().
*
* @method header
* @public
* @static
* @param {string} l - HTTP header
* @param {string} v - HTTP header value
* @return int
*/
_io.header = _setHeader;
/**
* @description Method for requesting a transaction. This
* is the interface for _io().
*
* @method io
* @public
* @static
* @param {string} uri - qualified path to transaction resource.
* @param {object} c - configuration object for the transaction.
* @return object
*/
Y.io = _io;
Y.io.http = _io;
}, '3.0.0b1' );
YUI.add('io-form', function(Y) {
/**
* Extends the IO base class to enable HTML form data serialization, when specified
* in the transaction's configuration object.
* @module io
* @submodule io-form
*/
Y.mix(Y.io, {
/**
* @description Method to enumerate through an HTML form's elements collection
* and return a string comprised of key-value pairs.
*
* @method _serialize
* @private
* @static
* @param {object} o - YUI form node or HTML form id.
* @return string
*/
_serialize: function(o) {
var eUC = encodeURIComponent,
data = [],
useDf = o.useDisabled || false,
item = 0,
e, f, n, v, d, i, ilen, j, jlen, o,
id = (typeof o.id === 'string') ? o.id : o.id.getAttribute('id');
if (!id) {
id = Y.guid('io:');
o.id.setAttribute('id', id);
}
f = Y.config.doc.getElementById(id);
// Iterate over the form elements collection to construct the
// label-value pairs.
for (i = 0, ilen = f.elements.length; i < ilen; ++i) {
e = f.elements[i];
d = e.disabled;
n = e.name;
if ((useDf) ? n : (n && !d)) {
n = encodeURIComponent(n) + '=';
v = encodeURIComponent(e.value);
switch (e.type) {
// Safari, Opera, FF all default options.value from .text if
// value attribute not specified in markup
case 'select-one':
if (e.selectedIndex > -1) {
o = e.options[e.selectedIndex];
data[item++] = n + eUC((o.attributes.value && o.attributes.value.specified) ? o.value : o.text);
}
break;
case 'select-multiple':
if (e.selectedIndex > -1) {
for (j = e.selectedIndex, jlen = e.options.length; j < jlen; ++j) {
o = e.options[j];
if (o.selected) {
data[item++] = n + eUC((o.attributes.value && o.attributes.value.specified) ? o.value : o.text);
}
}
}
break;
case 'radio':
case 'checkbox':
if(e.checked){
data[item++] = n + v;
}
break;
case 'file':
// stub case as XMLHttpRequest will only send the file path as a string.
case undefined:
// stub case for fieldset element which returns undefined.
case 'reset':
// stub case for input type reset button.
case 'button':
// stub case for input type button elements.
break;
case 'submit':
default:
data[item++] = n + v;
}
}
}
Y.log('HTML form serialized. The value is: ' + data.join('&'), 'info', 'io');
return data.join('&');
}
}, true);
}, '3.0.0b1' ,{requires:['io-base']});
YUI.add('io-xdr', function(Y) {
/**
* Extends the IO base class to provide an alternate, Flash transport, for making
* cross-domain requests.
* @module io
* @submodule io-xdr
*/
/**
* @event io:xdrReady
* @description This event is fired by YUI.io when the specified transport is
* ready for use.
* @type Event Custom
*/
var E_XDR_READY = 'io:xdrReady';
/**
* @description Method that creates the Flash transport swf.
*
* @method _swf
* @private
* @static
* @param {string} uri - location of IO.swf.
* @param {string} yid - YUI instance id.
* @return void
*/
function _swf(uri, yid) {
var XDR_SWF = '<object id="yuiIoSwf" type="application/x-shockwave-flash" data="' +
uri + '" width="0" height="0">' +
'<param name="movie" value="' + uri + '">' +
'<param name="FlashVars" value="yid=' + yid + '">' +
'<param name="allowScriptAccess" value="sameDomain">' +
'</object>';
Y.get('body').appendChild(Y.Node.create(XDR_SWF));
}
Y.mix(Y.io, {
/**
* @description Map of IO transports.
*
* @property _transport
* @private
* @static
* @type object
*/
_transport: {},
/**
* @description Object that stores callback handlers for cross-domain requests
* when using Flash as the transport.
*
* @property _fn
* @private
* @static
* @type object
*/
_fn: {},
/**
* @description Method for accessing the transport's interface for making a
* cross-domain transaction.
*
* @method _xdr
* @private
* @static
* @param {string} uri - qualified path to transaction resource.
* @param {object} o - Transaction object generated by _create() in io-base.
* @param {object} c - configuration object for the transaction.
* @return object
*/
_xdr: function(uri, o, c) {
if (c.on) {
this._fn[o.id] = c.on;
}
o.c.send(uri, c, o.id);
return o;
},
/**
* @description Fires event "io:xdrReady"
*
* @method xdrReady
* @private
* @static
* @param {number} id - transaction id
* @param {object} c - configuration object for the transaction.
*
* @return void
*/
xdrReady: function(id) {
Y.fire(E_XDR_READY, id);
},
/**
* @description Method to initialize the desired transport.
*
* @method transport
* @public
* @static
* @param {object} o - object of transport configurations.
* @return void
*/
transport: function(o) {
switch (o.id) {
case 'flash':
_swf(o.src, o.yid);
this._transport.flash = Y.config.doc.getElementById('yuiIoSwf');
break;
}
}
});
}, '3.0.0b1' ,{requires:['io-base']});
YUI.add('io-upload-iframe', function(Y) {
/**
* Extends the IO base class to enable file uploads, with HTML forms,
* using an iframe as the transport medium.
* @module io
* @submodule io-upload-iframe
*/
var w = Y.config.win;
/**
* @description Parses the POST data object and creates hidden form elements
* for each key-value, and appends them to the HTML form object.
* @method appendData
* @private
* @static
* @param {object} d The key-value hash map.
* @return {array} e Array of created fields.
*/
function _addData(f, d) {
var e = [],
p, i;
for (p in d) {
if (d.hasOwnProperty(d, p)) {
e[i] = document.createElement('input');
e[i].type = 'hidden';
e[i].name = p;
e[i].value = d[p].
f.appendChild(e[i]);
}
}
return e;
}
function _removeData(f, e) {
var i, l;
if (e && e.length > 0) {
for(i = 0, l = e.length; i < l; i++){
f.removeChild(e[i]);
}
}
}
function _create(o, c) {
var i = Y.Node.create('<iframe id="ioupload' + o.id + '" name="ioupload' + o.id + '" />'),
cfg = {
position: 'absolute',
top: '-1000px',
left: '-1000px'
};
i.setStyles(cfg);
Y.get('body').appendChild(i);
// Bind the onload handler to the iframe to detect the file upload response.
Y.on("load", function() { _handle(o, c) }, '#ioupload' + o.id);
}
// Create the upload callback handler that fires when the iframe
// receives the load event. Subsequently, the event handler is detached
// and the iframe removed from the document.
function _handle(o, c) {
var p,
b = Y.get('#ioupload' + o.id).get('contentWindow.document.body');
if (c.timeout) {
_clearTimeout(o.id);
}
// When a response Content-Type of "text/plain" is used, Firefox and Safari
// will wrap the response string with <pre></pre>.
p = b.query('pre:first-child');
o.c.responseText = (p) ? p.get('innerHTML') : b.get('innerHTML');
Y.io.complete(o, c);
// The transaction is complete, so call _destroy to remove
// the event listener bound to the iframe transport, and then
// destroy the iframe.
setTimeout( function() { _destroy(o.id); }, 0);
}
/**
* @description Starts timeout count if the configuration object
* has a defined timeout property.
*
* @method _startTimeout
* @private
* @static
* @param {object} o Transaction object generated by _create().
* @param {object} c Configuration object passed to YUI.io().
* @return void
*/
function _startTimeout(o, c) {
Y.io._timeout[o.id] = w.setTimeout(function() { Y.io.abort(o, c); }, c.timeout);
}
/**
* @description Clears the timeout interval started by _startTimeout().
*
* @method _clearTimeout
* @private
* @static
* @param {number} id - Transaction id.
* @return void
*/
function _clearTimeout(id) {
w.clearTimeout(Y.io._timeout[id]);
delete Y.io._timeout[id];
}
function _destroy(id) {
Y.Event.purgeElement('#ioupload' + id, false);
Y.get('body').removeChild(Y.get('#ioupload' + id));
Y.log('The iframe transport for transaction ' + id + 'has been destroyed.', 'info', 'io');
}
Y.mix(Y.io, {
/**
* @description Uploads HTML form, inclusive of files/attachments, using the
* iframe created in createFrame to facilitate the transaction.
* @method _upload
* @private
* @static
* @param {o} o The transaction object
* @param {object} uri Qualified path to transaction resource.
* @param {object} c Configuration object for the transaction.
* @return {void}
*/
_upload: function(o, uri, c) {
var f = (typeof c.form.id === 'string') ? document.getElementById(c.form.id) : c.form.id,
e, fields, i, p, attr;
_create(o, c);
// Track original HTML form attribute values.
attr = {
action: f.getAttribute('action'),
target: f.getAttribute('target')
};
// Initialize the HTML form properties in case they are
// not defined in the HTML form.
f.setAttribute('action', uri);
f.setAttribute('method', 'POST');
f.setAttribute('target', 'ioupload' + o.id );
f.setAttribute((Y.UA.ie && !document.documentMode) ? 'encoding' : 'enctype', 'multipart/form-data');
if (c.data) {
fields = _addData(f, c.data);
}
// Start polling if a callback is present and the timeout
// property has been defined.
if (c.timeout) {
_startTimeout(o, c);
Y.log('Transaction timeout started for transaction ' + id + '.', 'info', 'io');
}
// Start file upload.
f.submit();
Y.io.start(o.id, c);
if (c.data) {
_removeData(f, fields);
}
// Restore HTML form attributes to their original
// values prior to file upload.
for (p in attr) {
if (attr.hasOwnProperty(attr, p)) {
if (attr[p]) {
f.setAttribute(p, f[prop]);
}
else {
f.removeAttribute(p);
}
}
}
}
});
}, '3.0.0b1' ,{requires:['io-base']});
YUI.add('io-queue', function(Y) {
/**
* Extends the IO base class to implement Queue for synchronous
* transaction processing.
* @module io
* @submodule io-queue
*/
/**
* @description Array of transactions queued for processing
*
* @property _yQ
* @private
* @static
* @type Object
*/
var _q = new Y.Queue(),
/**
* @description Reference to "io:complete" event handler.
*
* @property _e
* @private
* @static
* @type Object
*/
_e,
_activeId,
/**
* @description Property to determine whether the queue is set to
* 1 (active) or 0 (inactive). When inactive, transactions
* will be stored in the queue until the queue is set to active.
*
* @property _qState
* @private
* @static
* @type int
*/
_qState = 1;
/**
* @description Method for requesting a transaction, and queueing the
* request before it is sent to the resource.
*
* @method _queue
* @private
* @static
* @return Object
*/
function _queue(uri, c) {
var o = { uri: uri, id: Y.io._id(), cfg:c };
_q.add(o);
if (_qState === 1) {
_shift();
}
Y.log('Object queued. Transaction id is' + o.id, 'info', 'io');
return o;
}
/**
* @description Method Process the first transaction from the
* queue in FIFO order.
*
* @method _shift
* @private
* @static
* @return void
*/
function _shift() {
var o = _q.next();
_activeId = o.id;
_qState = 0;
Y.io(o.uri, o.cfg, o.id);
}
/**
* @description Method for promoting a transaction to the top of the queue.
*
* @method _unshift
* @private
* @static
* @return void
*/
function _unshift(o) {
_q.promote(o);
}
function _next(id) {
_qState = 1;
if (_activeId === id && _q.size() > 0) {
_shift();
}
}
/**
* @description Method for removing a specific, pending transaction from
* the queue.
*
* @method _remove
* @private
* @static
* @return void
*/
function _remove(o) {
_q.remove(o);
}
function _start() {
_qState = 1;
if (_q.size() > 0) {
_shift();
}
Y.log('Queue started.', 'info', 'io');
}
/**
* @description Method for setting queue processing to inactive.
* Transaction requests to YUI.io.queue() will be stored in the queue, but
* not processed until the queue is reset to "active".
*
* @method _stop
* @private
* @static
* @return void
*/
function _stop() {
_qState = 0;
Y.log('Queue stopped.', 'info', 'io');
};
/**
* @description Method to query the current size of the queue.
*
* @method _size
* @private
* @static
* @return int
*/
function _size() {
return _q.size();
};
_e = Y.on('io:complete', function(id) { _next(id); }, Y.io);
/**
* @description Method to query the current size of the queue, or to
* set a maximum queue size. This is the interface for _size().
*
* @method size
* @public
* @static
* @param {number} i - Specified maximum size of queue.
* @return number
*/
_queue.size = _size;
/**
* @description Method for setting the queue to active. If there are
* transactions pending in the queue, they will be processed from the
* queue in FIFO order. This is the interface for _start().
*
* @method start
* @public
* @static
* @return void
*/
_queue.start = _start;
/**
* @description Method for setting queue processing to inactive.
* Transaction requests to YUI.io.queue() will be stored in the queue, but
* not processed until the queue is restarted. This is the
* interface for _stop().
*
* @method stop
* @public
* @static
* @return void
*/
_queue.stop = _stop;
/**
* @description Method for promoting a transaction to the top of the queue.
* This is the interface for _unshift().
*
* @method promote
* @public
* @static
* @param {Object} o - Reference to queued transaction.
* @return void
*/
_queue.promote = _unshift;
/**
* @description Method for removing a specific, pending transaction from
* the queue. This is the interface for _purge().
*
* @method purge
* @public
* @static
* @param {Object} o - Reference to queued transaction.
* @return void
*/
_queue.remove = _remove;
Y.mix(Y.io, {
queue: _queue
}, true);
}, '3.0.0b1' ,{requires:['io-base']});
YUI.add('io', function(Y){}, '3.0.0b1' ,{use:['io-base', 'io-form', 'io-xdr', 'io-upload-iframe', 'io-queue']});