12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547 |
- /*
- Copyright (c) 2009, Yahoo! Inc. All rights reserved.
- Code licensed under the BSD License:
- http://developer.yahoo.net/yui/license.txt
- version: 2.8.0r4
- */
- /**
- * The Connection Manager provides a simplified interface to the XMLHttpRequest
- * object. It handles cross-browser instantiantion of XMLHttpRequest, negotiates the
- * interactive states and server response, returning the results to a pre-defined
- * callback you create.
- *
- * @namespace YAHOO.util
- * @module connection
- * @requires yahoo
- * @requires event
- */
- /**
- * The Connection Manager singleton provides methods for creating and managing
- * asynchronous transactions.
- *
- * @class Connect
- */
- YAHOO.util.Connect =
- {
- /**
- * @description Array of MSFT ActiveX ids for XMLHttpRequest.
- * @property _msxml_progid
- * @private
- * @static
- * @type array
- */
- _msxml_progid:[
- 'Microsoft.XMLHTTP',
- 'MSXML2.XMLHTTP.3.0',
- 'MSXML2.XMLHTTP'
- ],
- /**
- * @description Object literal of HTTP header(s)
- * @property _http_header
- * @private
- * @static
- * @type object
- */
- _http_headers:{},
- /**
- * @description Determines if HTTP headers are set.
- * @property _has_http_headers
- * @private
- * @static
- * @type boolean
- */
- _has_http_headers:false,
- /**
- * @description Determines if a default header of
- * Content-Type of 'application/x-www-form-urlencoded'
- * will be added to any client HTTP headers sent for POST
- * transactions.
- * @property _use_default_post_header
- * @private
- * @static
- * @type boolean
- */
- _use_default_post_header:true,
- /**
- * @description The default header used for POST transactions.
- * @property _default_post_header
- * @private
- * @static
- * @type boolean
- */
- _default_post_header:'application/x-www-form-urlencoded; charset=UTF-8',
- /**
- * @description The default header used for transactions involving the
- * use of HTML forms.
- * @property _default_form_header
- * @private
- * @static
- * @type boolean
- */
- _default_form_header:'application/x-www-form-urlencoded',
- /**
- * @description Determines if a default header of
- * 'X-Requested-With: XMLHttpRequest'
- * will be added to each transaction.
- * @property _use_default_xhr_header
- * @private
- * @static
- * @type boolean
- */
- _use_default_xhr_header:true,
- /**
- * @description The default header value for the label
- * "X-Requested-With". This is sent with each
- * transaction, by default, to identify the
- * request as being made by YUI Connection Manager.
- * @property _default_xhr_header
- * @private
- * @static
- * @type boolean
- */
- _default_xhr_header:'XMLHttpRequest',
- /**
- * @description Determines if custom, default headers
- * are set for each transaction.
- * @property _has_default_header
- * @private
- * @static
- * @type boolean
- */
- _has_default_headers:true,
- /**
- * @description Determines if custom, default headers
- * are set for each transaction.
- * @property _has_default_header
- * @private
- * @static
- * @type boolean
- */
- _default_headers:{},
- /**
- * @description Collection of polling references to the polling mechanism in handleReadyState.
- * @property _poll
- * @private
- * @static
- * @type object
- */
- _poll:{},
- /**
- * @description Queue of timeout values for each transaction callback with a defined timeout value.
- * @property _timeOut
- * @private
- * @static
- * @type object
- */
- _timeOut:{},
- /**
- * @description The polling frequency, in milliseconds, for HandleReadyState.
- * when attempting to determine a transaction's XHR readyState.
- * The default is 50 milliseconds.
- * @property _polling_interval
- * @private
- * @static
- * @type int
- */
- _polling_interval:50,
- /**
- * @description A transaction counter that increments the transaction id for each transaction.
- * @property _transaction_id
- * @private
- * @static
- * @type int
- */
- _transaction_id:0,
- /**
- * @description Custom event that fires at the start of a transaction
- * @property startEvent
- * @private
- * @static
- * @type CustomEvent
- */
- startEvent: new YAHOO.util.CustomEvent('start'),
- /**
- * @description Custom event that fires when a transaction response has completed.
- * @property completeEvent
- * @private
- * @static
- * @type CustomEvent
- */
- completeEvent: new YAHOO.util.CustomEvent('complete'),
- /**
- * @description Custom event that fires when handleTransactionResponse() determines a
- * response in the HTTP 2xx range.
- * @property successEvent
- * @private
- * @static
- * @type CustomEvent
- */
- successEvent: new YAHOO.util.CustomEvent('success'),
- /**
- * @description Custom event that fires when handleTransactionResponse() determines a
- * response in the HTTP 4xx/5xx range.
- * @property failureEvent
- * @private
- * @static
- * @type CustomEvent
- */
- failureEvent: new YAHOO.util.CustomEvent('failure'),
- /**
- * @description Custom event that fires when a transaction is successfully aborted.
- * @property abortEvent
- * @private
- * @static
- * @type CustomEvent
- */
- abortEvent: new YAHOO.util.CustomEvent('abort'),
- /**
- * @description A reference table that maps callback custom events members to its specific
- * event name.
- * @property _customEvents
- * @private
- * @static
- * @type object
- */
- _customEvents:
- {
- onStart:['startEvent', 'start'],
- onComplete:['completeEvent', 'complete'],
- onSuccess:['successEvent', 'success'],
- onFailure:['failureEvent', 'failure'],
- onUpload:['uploadEvent', 'upload'],
- onAbort:['abortEvent', 'abort']
- },
- /**
- * @description Member to add an ActiveX id to the existing xml_progid array.
- * In the event(unlikely) a new ActiveX id is introduced, it can be added
- * without internal code modifications.
- * @method setProgId
- * @public
- * @static
- * @param {string} id The ActiveX id to be added to initialize the XHR object.
- * @return void
- */
- setProgId:function(id)
- {
- this._msxml_progid.unshift(id);
- },
- /**
- * @description Member to override the default POST header.
- * @method setDefaultPostHeader
- * @public
- * @static
- * @param {boolean} b Set and use default header - true or false .
- * @return void
- */
- setDefaultPostHeader:function(b)
- {
- if(typeof b == 'string'){
- this._default_post_header = b;
- }
- else if(typeof b == 'boolean'){
- this._use_default_post_header = b;
- }
- },
- /**
- * @description Member to override the default transaction header..
- * @method setDefaultXhrHeader
- * @public
- * @static
- * @param {boolean} b Set and use default header - true or false .
- * @return void
- */
- setDefaultXhrHeader:function(b)
- {
- if(typeof b == 'string'){
- this._default_xhr_header = b;
- }
- else{
- this._use_default_xhr_header = b;
- }
- },
- /**
- * @description Member to modify the default polling interval.
- * @method setPollingInterval
- * @public
- * @static
- * @param {int} i The polling interval in milliseconds.
- * @return void
- */
- setPollingInterval:function(i)
- {
- if(typeof i == 'number' && isFinite(i)){
- this._polling_interval = i;
- }
- },
- /**
- * @description Instantiates a XMLHttpRequest object and returns an object with two properties:
- * the XMLHttpRequest instance and the transaction id.
- * @method createXhrObject
- * @private
- * @static
- * @param {int} transactionId Property containing the transaction id for this transaction.
- * @return object
- */
- createXhrObject:function(transactionId)
- {
- var obj,http,i;
- try
- {
- // Instantiates XMLHttpRequest in non-IE browsers and assigns to http.
- http = new XMLHttpRequest();
- // Object literal with http and tId properties
- obj = { conn:http, tId:transactionId, xhr: true };
- }
- catch(e)
- {
- for(i=0; i<this._msxml_progid.length; ++i){
- try
- {
- // Instantiates XMLHttpRequest for IE and assign to http
- http = new ActiveXObject(this._msxml_progid[i]);
- // Object literal with conn and tId properties
- obj = { conn:http, tId:transactionId, xhr: true };
- break;
- }
- catch(e1){}
- }
- }
- finally
- {
- return obj;
- }
- },
- /**
- * @description This method is called by asyncRequest to create a
- * valid connection object for the transaction. It also passes a
- * transaction id and increments the transaction id counter.
- * @method getConnectionObject
- * @private
- * @static
- * @return {object}
- */
- getConnectionObject:function(t)
- {
- var o, tId = this._transaction_id;
- try
- {
- if(!t){
- o = this.createXhrObject(tId);
- }
- else{
- o = {tId:tId};
- if(t==='xdr'){
- o.conn = this._transport;
- o.xdr = true;
- }
- else if(t==='upload'){
- o.upload = true;
- }
- }
- if(o){
- this._transaction_id++;
- }
- }
- catch(e){}
- return o;
- },
- /**
- * @description Method for initiating an asynchronous request via the XHR object.
- * @method asyncRequest
- * @public
- * @static
- * @param {string} method HTTP transaction method
- * @param {string} uri Fully qualified path of resource
- * @param {callback} callback User-defined callback function or object
- * @param {string} postData POST body
- * @return {object} Returns the connection object
- */
- asyncRequest:function(method, uri, callback, postData)
- {
- var o,t,args = (callback && callback.argument)?callback.argument:null;
- if(this._isFileUpload){
- t = 'upload';
- }
- else if(callback.xdr){
- t = 'xdr';
- }
- o = this.getConnectionObject(t);
- if(!o){
- return null;
- }
- else{
- // Intialize any transaction-specific custom events, if provided.
- if(callback && callback.customevents){
- this.initCustomEvents(o, callback);
- }
- if(this._isFormSubmit){
- if(this._isFileUpload){
- this.uploadFile(o, callback, uri, postData);
- return o;
- }
- // If the specified HTTP method is GET, setForm() will return an
- // encoded string that is concatenated to the uri to
- // create a querystring.
- if(method.toUpperCase() == 'GET'){
- if(this._sFormData.length !== 0){
- // If the URI already contains a querystring, append an ampersand
- // and then concatenate _sFormData to the URI.
- uri += ((uri.indexOf('?') == -1)?'?':'&') + this._sFormData;
- }
- }
- else if(method.toUpperCase() == 'POST'){
- // If POST data exist in addition to the HTML form data,
- // it will be concatenated to the form data.
- postData = postData?this._sFormData + "&" + postData:this._sFormData;
- }
- }
- if(method.toUpperCase() == 'GET' && (callback && callback.cache === false)){
- // If callback.cache is defined and set to false, a
- // timestamp value will be added to the querystring.
- uri += ((uri.indexOf('?') == -1)?'?':'&') + "rnd=" + new Date().valueOf().toString();
- }
- // Each transaction will automatically include a custom header of
- // "X-Requested-With: XMLHttpRequest" to identify the request as
- // having originated from Connection Manager.
- if(this._use_default_xhr_header){
- if(!this._default_headers['X-Requested-With']){
- this.initHeader('X-Requested-With', this._default_xhr_header, true);
- }
- }
- //If the transaction method is POST and the POST header value is set to true
- //or a custom value, initalize the Content-Type header to this value.
- if((method.toUpperCase() === 'POST' && this._use_default_post_header) && this._isFormSubmit === false){
- this.initHeader('Content-Type', this._default_post_header);
- }
- if(o.xdr){
- this.xdr(o, method, uri, callback, postData);
- return o;
- }
- o.conn.open(method, uri, true);
- //Initialize all default and custom HTTP headers,
- if(this._has_default_headers || this._has_http_headers){
- this.setHeader(o);
- }
- this.handleReadyState(o, callback);
- o.conn.send(postData || '');
- // Reset the HTML form data and state properties as
- // soon as the data are submitted.
- if(this._isFormSubmit === true){
- this.resetFormState();
- }
- // Fire global custom event -- startEvent
- this.startEvent.fire(o, args);
- if(o.startEvent){
- // Fire transaction custom event -- startEvent
- o.startEvent.fire(o, args);
- }
- return o;
- }
- },
- /**
- * @description This method creates and subscribes custom events,
- * specific to each transaction
- * @method initCustomEvents
- * @private
- * @static
- * @param {object} o The connection object
- * @param {callback} callback The user-defined callback object
- * @return {void}
- */
- initCustomEvents:function(o, callback)
- {
- var prop;
- // Enumerate through callback.customevents members and bind/subscribe
- // events that match in the _customEvents table.
- for(prop in callback.customevents){
- if(this._customEvents[prop][0]){
- // Create the custom event
- o[this._customEvents[prop][0]] = new YAHOO.util.CustomEvent(this._customEvents[prop][1], (callback.scope)?callback.scope:null);
- // Subscribe the custom event
- o[this._customEvents[prop][0]].subscribe(callback.customevents[prop]);
- }
- }
- },
- /**
- * @description This method serves as a timer that polls the XHR object's readyState
- * property during a transaction, instead of binding a callback to the
- * onreadystatechange event. Upon readyState 4, handleTransactionResponse
- * will process the response, and the timer will be cleared.
- * @method handleReadyState
- * @private
- * @static
- * @param {object} o The connection object
- * @param {callback} callback The user-defined callback object
- * @return {void}
- */
- handleReadyState:function(o, callback)
- {
- var oConn = this,
- args = (callback && callback.argument)?callback.argument:null;
- if(callback && callback.timeout){
- this._timeOut[o.tId] = window.setTimeout(function(){ oConn.abort(o, callback, true); }, callback.timeout);
- }
- this._poll[o.tId] = window.setInterval(
- function(){
- if(o.conn && o.conn.readyState === 4){
- // Clear the polling interval for the transaction
- // and remove the reference from _poll.
- window.clearInterval(oConn._poll[o.tId]);
- delete oConn._poll[o.tId];
- if(callback && callback.timeout){
- window.clearTimeout(oConn._timeOut[o.tId]);
- delete oConn._timeOut[o.tId];
- }
- // Fire global custom event -- completeEvent
- oConn.completeEvent.fire(o, args);
- if(o.completeEvent){
- // Fire transaction custom event -- completeEvent
- o.completeEvent.fire(o, args);
- }
- oConn.handleTransactionResponse(o, callback);
- }
- }
- ,this._polling_interval);
- },
- /**
- * @description This method attempts to interpret the server response and
- * determine whether the transaction was successful, or if an error or
- * exception was encountered.
- * @method handleTransactionResponse
- * @private
- * @static
- * @param {object} o The connection object
- * @param {object} callback The user-defined callback object
- * @param {boolean} isAbort Determines if the transaction was terminated via abort().
- * @return {void}
- */
- handleTransactionResponse:function(o, callback, isAbort)
- {
- var httpStatus, responseObject,
- args = (callback && callback.argument)?callback.argument:null,
- xdrS = (o.r && o.r.statusText === 'xdr:success')?true:false,
- xdrF = (o.r && o.r.statusText === 'xdr:failure')?true:false,
- xdrA = isAbort;
- try
- {
- if((o.conn.status !== undefined && o.conn.status !== 0) || xdrS){
- // XDR requests will not have HTTP status defined. The
- // statusText property will define the response status
- // set by the Flash transport.
- httpStatus = o.conn.status;
- }
- else if(xdrF && !xdrA){
- // Set XDR transaction failure to a status of 0, which
- // resolves as an HTTP failure, instead of an exception.
- httpStatus = 0;
- }
- else{
- httpStatus = 13030;
- }
- }
- catch(e){
- // 13030 is a custom code to indicate the condition -- in Mozilla/FF --
- // when the XHR object's status and statusText properties are
- // unavailable, and a query attempt throws an exception.
- httpStatus = 13030;
- }
- if((httpStatus >= 200 && httpStatus < 300) || httpStatus === 1223 || xdrS){
- responseObject = o.xdr ? o.r : this.createResponseObject(o, args);
- if(callback && callback.success){
- if(!callback.scope){
- callback.success(responseObject);
- }
- else{
- // If a scope property is defined, the callback will be fired from
- // the context of the object.
- callback.success.apply(callback.scope, [responseObject]);
- }
- }
- // Fire global custom event -- successEvent
- this.successEvent.fire(responseObject);
- if(o.successEvent){
- // Fire transaction custom event -- successEvent
- o.successEvent.fire(responseObject);
- }
- }
- else{
- switch(httpStatus){
- // The following cases are wininet.dll error codes that may be encountered.
- case 12002: // Server timeout
- case 12029: // 12029 to 12031 correspond to dropped connections.
- case 12030:
- case 12031:
- case 12152: // Connection closed by server.
- case 13030: // See above comments for variable status.
- // XDR transactions will not resolve to this case, since the
- // response object is already built in the xdr response.
- responseObject = this.createExceptionObject(o.tId, args, (isAbort?isAbort:false));
- if(callback && callback.failure){
- if(!callback.scope){
- callback.failure(responseObject);
- }
- else{
- callback.failure.apply(callback.scope, [responseObject]);
- }
- }
- break;
- default:
- responseObject = (o.xdr) ? o.response : this.createResponseObject(o, args);
- if(callback && callback.failure){
- if(!callback.scope){
- callback.failure(responseObject);
- }
- else{
- callback.failure.apply(callback.scope, [responseObject]);
- }
- }
- }
- // Fire global custom event -- failureEvent
- this.failureEvent.fire(responseObject);
- if(o.failureEvent){
- // Fire transaction custom event -- failureEvent
- o.failureEvent.fire(responseObject);
- }
- }
- this.releaseObject(o);
- responseObject = null;
- },
- /**
- * @description This method evaluates the server response, creates and returns the results via
- * its properties. Success and failure cases will differ in the response
- * object's property values.
- * @method createResponseObject
- * @private
- * @static
- * @param {object} o The connection object
- * @param {callbackArg} callbackArg The user-defined argument or arguments to be passed to the callback
- * @return {object}
- */
- createResponseObject:function(o, callbackArg)
- {
- var obj = {}, headerObj = {},
- i, headerStr, header, delimitPos;
- try
- {
- headerStr = o.conn.getAllResponseHeaders();
- header = headerStr.split('\n');
- for(i=0; i<header.length; i++){
- delimitPos = header[i].indexOf(':');
- if(delimitPos != -1){
- headerObj[header[i].substring(0,delimitPos)] = YAHOO.lang.trim(header[i].substring(delimitPos+2));
- }
- }
- }
- catch(e){}
- obj.tId = o.tId;
- // Normalize IE's response to HTTP 204 when Win error 1223.
- obj.status = (o.conn.status == 1223)?204:o.conn.status;
- // Normalize IE's statusText to "No Content" instead of "Unknown".
- obj.statusText = (o.conn.status == 1223)?"No Content":o.conn.statusText;
- obj.getResponseHeader = headerObj;
- obj.getAllResponseHeaders = headerStr;
- obj.responseText = o.conn.responseText;
- obj.responseXML = o.conn.responseXML;
- if(callbackArg){
- obj.argument = callbackArg;
- }
- return obj;
- },
- /**
- * @description If a transaction cannot be completed due to dropped or closed connections,
- * there may be not be enough information to build a full response object.
- * The failure callback will be fired and this specific condition can be identified
- * by a status property value of 0.
- *
- * If an abort was successful, the status property will report a value of -1.
- *
- * @method createExceptionObject
- * @private
- * @static
- * @param {int} tId The Transaction Id
- * @param {callbackArg} callbackArg The user-defined argument or arguments to be passed to the callback
- * @param {boolean} isAbort Determines if the exception case is caused by a transaction abort
- * @return {object}
- */
- createExceptionObject:function(tId, callbackArg, isAbort)
- {
- var COMM_CODE = 0,
- COMM_ERROR = 'communication failure',
- ABORT_CODE = -1,
- ABORT_ERROR = 'transaction aborted',
- obj = {};
- obj.tId = tId;
- if(isAbort){
- obj.status = ABORT_CODE;
- obj.statusText = ABORT_ERROR;
- }
- else{
- obj.status = COMM_CODE;
- obj.statusText = COMM_ERROR;
- }
- if(callbackArg){
- obj.argument = callbackArg;
- }
- return obj;
- },
- /**
- * @description Method that initializes the custom HTTP headers for the each transaction.
- * @method initHeader
- * @public
- * @static
- * @param {string} label The HTTP header label
- * @param {string} value The HTTP header value
- * @param {string} isDefault Determines if the specific header is a default header
- * automatically sent with each transaction.
- * @return {void}
- */
- initHeader:function(label, value, isDefault)
- {
- var headerObj = (isDefault)?this._default_headers:this._http_headers;
- headerObj[label] = value;
- if(isDefault){
- this._has_default_headers = true;
- }
- else{
- this._has_http_headers = true;
- }
- },
- /**
- * @description Accessor that sets the HTTP headers for each transaction.
- * @method setHeader
- * @private
- * @static
- * @param {object} o The connection object for the transaction.
- * @return {void}
- */
- setHeader:function(o)
- {
- var prop;
- if(this._has_default_headers){
- for(prop in this._default_headers){
- if(YAHOO.lang.hasOwnProperty(this._default_headers, prop)){
- o.conn.setRequestHeader(prop, this._default_headers[prop]);
- }
- }
- }
- if(this._has_http_headers){
- for(prop in this._http_headers){
- if(YAHOO.lang.hasOwnProperty(this._http_headers, prop)){
- o.conn.setRequestHeader(prop, this._http_headers[prop]);
- }
- }
- this._http_headers = {};
- this._has_http_headers = false;
- }
- },
- /**
- * @description Resets the default HTTP headers object
- * @method resetDefaultHeaders
- * @public
- * @static
- * @return {void}
- */
- resetDefaultHeaders:function(){
- this._default_headers = {};
- this._has_default_headers = false;
- },
- /**
- * @description Method to terminate a transaction, if it has not reached readyState 4.
- * @method abort
- * @public
- * @static
- * @param {object} o The connection object returned by asyncRequest.
- * @param {object} callback User-defined callback object.
- * @param {string} isTimeout boolean to indicate if abort resulted from a callback timeout.
- * @return {boolean}
- */
- abort:function(o, callback, isTimeout)
- {
- var abortStatus,
- args = (callback && callback.argument)?callback.argument:null;
- o = o || {};
- if(o.conn){
- if(o.xhr){
- if(this.isCallInProgress(o)){
- // Issue abort request
- o.conn.abort();
- window.clearInterval(this._poll[o.tId]);
- delete this._poll[o.tId];
- if(isTimeout){
- window.clearTimeout(this._timeOut[o.tId]);
- delete this._timeOut[o.tId];
- }
- abortStatus = true;
- }
- }
- else if(o.xdr){
- o.conn.abort(o.tId);
- abortStatus = true;
- }
- }
- else if(o.upload){
- var frameId = 'yuiIO' + o.tId;
- var io = document.getElementById(frameId);
- if(io){
- // Remove all listeners on the iframe prior to
- // its destruction.
- YAHOO.util.Event.removeListener(io, "load");
- // Destroy the iframe facilitating the transaction.
- document.body.removeChild(io);
- if(isTimeout){
- window.clearTimeout(this._timeOut[o.tId]);
- delete this._timeOut[o.tId];
- }
- abortStatus = true;
- }
- }
- else{
- abortStatus = false;
- }
- if(abortStatus === true){
- // Fire global custom event -- abortEvent
- this.abortEvent.fire(o, args);
- if(o.abortEvent){
- // Fire transaction custom event -- abortEvent
- o.abortEvent.fire(o, args);
- }
- this.handleTransactionResponse(o, callback, true);
- }
- return abortStatus;
- },
- /**
- * @description Determines if the transaction is still being processed.
- * @method isCallInProgress
- * @public
- * @static
- * @param {object} o The connection object returned by asyncRequest
- * @return {boolean}
- */
- isCallInProgress:function(o)
- {
- o = o || {};
- // if the XHR object assigned to the transaction has not been dereferenced,
- // then check its readyState status. Otherwise, return false.
- if(o.xhr && o.conn){
- return o.conn.readyState !== 4 && o.conn.readyState !== 0;
- }
- else if(o.xdr && o.conn){
- return o.conn.isCallInProgress(o.tId);
- }
- else if(o.upload === true){
- return document.getElementById('yuiIO' + o.tId)?true:false;
- }
- else{
- return false;
- }
- },
- /**
- * @description Dereference the XHR instance and the connection object after the transaction is completed.
- * @method releaseObject
- * @private
- * @static
- * @param {object} o The connection object
- * @return {void}
- */
- releaseObject:function(o)
- {
- if(o && o.conn){
- //dereference the XHR instance.
- o.conn = null;
- //dereference the connection object.
- o = null;
- }
- }
- };
- /**
- * @for Connect
- */
- (function() {
- var YCM = YAHOO.util.Connect, _fn = {};
- /**
- * @description This method creates and instantiates the Flash transport.
- * @method _swf
- * @private
- * @static
- * @param {string} URI to connection.swf.
- * @return {void}
- */
- function _swf(uri) {
- var o = '<object id="YUIConnectionSwf" type="application/x-shockwave-flash" data="' +
- uri + '" width="0" height="0">' +
- '<param name="movie" value="' + uri + '">' +
- '<param name="allowScriptAccess" value="always">' +
- '</object>',
- c = document.createElement('div');
- document.body.appendChild(c);
- c.innerHTML = o;
- }
- /**
- * @description This method calls the public method on the
- * Flash transport to start the XDR transaction. It is analogous
- * to Connection Manager's asyncRequest method.
- * @method xdr
- * @private
- * @static
- * @param {object} The transaction object.
- * @param {string} HTTP request method.
- * @param {string} URI for the transaction.
- * @param {object} The transaction's callback object.
- * @param {object} The JSON object used as HTTP POST data.
- * @return {void}
- */
- function _xdr(o, m, u, c, d) {
- _fn[parseInt(o.tId)] = { 'o':o, 'c':c };
- if (d) {
- c.method = m;
- c.data = d;
- }
- o.conn.send(u, c, o.tId);
- }
- /**
- * @description This method instantiates the Flash transport and
- * establishes a static reference to it, used for all XDR requests.
- * @method transport
- * @public
- * @static
- * @param {string} URI to connection.swf.
- * @return {void}
- */
- function _init(uri) {
- _swf(uri);
- YCM._transport = document.getElementById('YUIConnectionSwf');
- }
- function _xdrReady() {
- YCM.xdrReadyEvent.fire();
- }
- /**
- * @description This method fires the global and transaction start
- * events.
- * @method _xdrStart
- * @private
- * @static
- * @param {object} The transaction object.
- * @param {string} The transaction's callback object.
- * @return {void}
- */
- function _xdrStart(o, cb) {
- if (o) {
- // Fire global custom event -- startEvent
- YCM.startEvent.fire(o, cb.argument);
- if(o.startEvent){
- // Fire transaction custom event -- startEvent
- o.startEvent.fire(o, cb.argument);
- }
- }
- }
- /**
- * @description This method is the initial response handler
- * for XDR transactions. The Flash transport calls this
- * function and sends the response payload.
- * @method handleXdrResponse
- * @private
- * @static
- * @param {object} The response object sent from the Flash transport.
- * @return {void}
- */
- function _handleXdrResponse(r) {
- var o = _fn[r.tId].o,
- cb = _fn[r.tId].c;
- if (r.statusText === 'xdr:start') {
- _xdrStart(o, cb);
- return;
- }
- r.responseText = decodeURI(r.responseText);
- o.r = r;
- if (cb.argument) {
- o.r.argument = cb.argument;
- }
- this.handleTransactionResponse(o, cb, r.statusText === 'xdr:abort' ? true : false);
- delete _fn[r.tId];
- }
- // Bind the functions to Connection Manager as static fields.
- YCM.xdr = _xdr;
- YCM.swf = _swf;
- YCM.transport = _init;
- YCM.xdrReadyEvent = new YAHOO.util.CustomEvent('xdrReady');
- YCM.xdrReady = _xdrReady;
- YCM.handleXdrResponse = _handleXdrResponse;
- })();
- /**
- * @for Connect
- */
- (function(){
- var YCM = YAHOO.util.Connect,
- YE = YAHOO.util.Event;
- /**
- * @description Property modified by setForm() to determine if the data
- * should be submitted as an HTML form.
- * @property _isFormSubmit
- * @private
- * @static
- * @type boolean
- */
- YCM._isFormSubmit = false;
- /**
- * @description Property modified by setForm() to determine if a file(s)
- * upload is expected.
- * @property _isFileUpload
- * @private
- * @static
- * @type boolean
- */
- YCM._isFileUpload = false;
- /**
- * @description Property modified by setForm() to set a reference to the HTML
- * form node if the desired action is file upload.
- * @property _formNode
- * @private
- * @static
- * @type object
- */
- YCM._formNode = null;
- /**
- * @description Property modified by setForm() to set the HTML form data
- * for each transaction.
- * @property _sFormData
- * @private
- * @static
- * @type string
- */
- YCM._sFormData = null;
- /**
- * @description Tracks the name-value pair of the "clicked" submit button if multiple submit
- * buttons are present in an HTML form; and, if YAHOO.util.Event is available.
- * @property _submitElementValue
- * @private
- * @static
- * @type string
- */
- YCM._submitElementValue = null;
- /**
- * @description Custom event that fires when handleTransactionResponse() determines a
- * response in the HTTP 4xx/5xx range.
- * @property failureEvent
- * @private
- * @static
- * @type CustomEvent
- */
- YCM.uploadEvent = new YAHOO.util.CustomEvent('upload'),
- /**
- * @description Determines whether YAHOO.util.Event is available and returns true or false.
- * If true, an event listener is bound at the document level to trap click events that
- * resolve to a target type of "Submit". This listener will enable setForm() to determine
- * the clicked "Submit" value in a multi-Submit button, HTML form.
- * @property _hasSubmitListener
- * @private
- * @static
- */
- YCM._hasSubmitListener = function() {
- if(YE){
- YE.addListener(
- document,
- 'click',
- function(e){
- var obj = YE.getTarget(e),
- name = obj.nodeName.toLowerCase();
- if((name === 'input' || name === 'button') && (obj.type && obj.type.toLowerCase() == 'submit')){
- YCM._submitElementValue = encodeURIComponent(obj.name) + "=" + encodeURIComponent(obj.value);
- }
- });
- return true;
- }
- return false;
- }();
- /**
- * @description This method assembles the form label and value pairs and
- * constructs an encoded string.
- * asyncRequest() will automatically initialize the transaction with a
- * a HTTP header Content-Type of application/x-www-form-urlencoded.
- * @method setForm
- * @public
- * @static
- * @param {string || object} form id or name attribute, or form object.
- * @param {boolean} optional enable file upload.
- * @param {boolean} optional enable file upload over SSL in IE only.
- * @return {string} string of the HTML form field name and value pairs..
- */
- function _setForm(formId, isUpload, secureUri)
- {
- var oForm, oElement, oName, oValue, oDisabled,
- hasSubmit = false,
- data = [], item = 0,
- i,len,j,jlen,opt;
- this.resetFormState();
- if(typeof formId == 'string'){
- // Determine if the argument is a form id or a form name.
- // Note form name usage is deprecated by supported
- // here for legacy reasons.
- oForm = (document.getElementById(formId) || document.forms[formId]);
- }
- else if(typeof formId == 'object'){
- // Treat argument as an HTML form object.
- oForm = formId;
- }
- else{
- return;
- }
- // If the isUpload argument is true, setForm will call createFrame to initialize
- // an iframe as the form target.
- //
- // The argument secureURI is also required by IE in SSL environments
- // where the secureURI string is a fully qualified HTTP path, used to set the source
- // of the iframe, to a stub resource in the same domain.
- if(isUpload){
- // Create iframe in preparation for file upload.
- this.createFrame(secureUri?secureUri:null);
- // Set form reference and file upload properties to true.
- this._isFormSubmit = true;
- this._isFileUpload = true;
- this._formNode = oForm;
- return;
- }
- // Iterate over the form elements collection to construct the
- // label-value pairs.
- for (i=0,len=oForm.elements.length; i<len; ++i){
- oElement = oForm.elements[i];
- oDisabled = oElement.disabled;
- oName = oElement.name;
- // Do not submit fields that are disabled or
- // do not have a name attribute value.
- if(!oDisabled && oName)
- {
- oName = encodeURIComponent(oName)+'=';
- oValue = encodeURIComponent(oElement.value);
- switch(oElement.type)
- {
- // Safari, Opera, FF all default opt.value from .text if
- // value attribute not specified in markup
- case 'select-one':
- if (oElement.selectedIndex > -1) {
- opt = oElement.options[oElement.selectedIndex];
- data[item++] = oName + encodeURIComponent(
- (opt.attributes.value && opt.attributes.value.specified) ? opt.value : opt.text);
- }
- break;
- case 'select-multiple':
- if (oElement.selectedIndex > -1) {
- for(j=oElement.selectedIndex, jlen=oElement.options.length; j<jlen; ++j){
- opt = oElement.options[j];
- if (opt.selected) {
- data[item++] = oName + encodeURIComponent(
- (opt.attributes.value && opt.attributes.value.specified) ? opt.value : opt.text);
- }
- }
- }
- break;
- case 'radio':
- case 'checkbox':
- if(oElement.checked){
- data[item++] = oName + oValue;
- }
- 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':
- if(hasSubmit === false){
- if(this._hasSubmitListener && this._submitElementValue){
- data[item++] = this._submitElementValue;
- }
- hasSubmit = true;
- }
- break;
- default:
- data[item++] = oName + oValue;
- }
- }
- }
- this._isFormSubmit = true;
- this._sFormData = data.join('&');
- this.initHeader('Content-Type', this._default_form_header);
- return this._sFormData;
- }
- /**
- * @description Resets HTML form properties when an HTML form or HTML form
- * with file upload transaction is sent.
- * @method resetFormState
- * @private
- * @static
- * @return {void}
- */
- function _resetFormState(){
- this._isFormSubmit = false;
- this._isFileUpload = false;
- this._formNode = null;
- this._sFormData = "";
- }
- /**
- * @description Creates an iframe to be used for form file uploads. It is remove from the
- * document upon completion of the upload transaction.
- * @method createFrame
- * @private
- * @static
- * @param {string} optional qualified path of iframe resource for SSL in IE.
- * @return {void}
- */
- function _createFrame(secureUri){
- // IE does not allow the setting of id and name attributes as object
- // properties via createElement(). A different iframe creation
- // pattern is required for IE.
- var frameId = 'yuiIO' + this._transaction_id,
- io;
- if(YAHOO.env.ua.ie){
- io = document.createElement('<iframe id="' + frameId + '" name="' + frameId + '" />');
- // IE will throw a security exception in an SSL environment if the
- // iframe source is undefined.
- if(typeof secureUri == 'boolean'){
- io.src = 'javascript:false';
- }
- }
- else{
- io = document.createElement('iframe');
- io.id = frameId;
- io.name = frameId;
- }
- io.style.position = 'absolute';
- io.style.top = '-1000px';
- io.style.left = '-1000px';
- document.body.appendChild(io);
- }
- /**
- * @description Parses the POST data and creates hidden form elements
- * for each key-value, and appends them to the HTML form object.
- * @method appendPostData
- * @private
- * @static
- * @param {string} postData The HTTP POST data
- * @return {array} formElements Collection of hidden fields.
- */
- function _appendPostData(postData){
- var formElements = [],
- postMessage = postData.split('&'),
- i, delimitPos;
- for(i=0; i < postMessage.length; i++){
- delimitPos = postMessage[i].indexOf('=');
- if(delimitPos != -1){
- formElements[i] = document.createElement('input');
- formElements[i].type = 'hidden';
- formElements[i].name = decodeURIComponent(postMessage[i].substring(0,delimitPos));
- formElements[i].value = decodeURIComponent(postMessage[i].substring(delimitPos+1));
- this._formNode.appendChild(formElements[i]);
- }
- }
- return formElements;
- }
- /**
- * @description Uploads HTML form, inclusive of files/attachments, using the
- * iframe created in createFrame to facilitate the transaction.
- * @method uploadFile
- * @private
- * @static
- * @param {int} id The transaction id.
- * @param {object} callback User-defined callback object.
- * @param {string} uri Fully qualified path of resource.
- * @param {string} postData POST data to be submitted in addition to HTML form.
- * @return {void}
- */
- function _uploadFile(o, callback, uri, postData){
- // Each iframe has an id prefix of "yuiIO" followed
- // by the unique transaction id.
- var frameId = 'yuiIO' + o.tId,
- uploadEncoding = 'multipart/form-data',
- io = document.getElementById(frameId),
- ie8 = (document.documentMode && document.documentMode === 8) ? true : false,
- oConn = this,
- args = (callback && callback.argument)?callback.argument:null,
- oElements,i,prop,obj, rawFormAttributes, uploadCallback;
- // Track original HTML form attribute values.
- rawFormAttributes = {
- action:this._formNode.getAttribute('action'),
- method:this._formNode.getAttribute('method'),
- target:this._formNode.getAttribute('target')
- };
- // Initialize the HTML form properties in case they are
- // not defined in the HTML form.
- this._formNode.setAttribute('action', uri);
- this._formNode.setAttribute('method', 'POST');
- this._formNode.setAttribute('target', frameId);
- if(YAHOO.env.ua.ie && !ie8){
- // IE does not respect property enctype for HTML forms.
- // Instead it uses the property - "encoding".
- this._formNode.setAttribute('encoding', uploadEncoding);
- }
- else{
- this._formNode.setAttribute('enctype', uploadEncoding);
- }
- if(postData){
- oElements = this.appendPostData(postData);
- }
- // Start file upload.
- this._formNode.submit();
- // Fire global custom event -- startEvent
- this.startEvent.fire(o, args);
- if(o.startEvent){
- // Fire transaction custom event -- startEvent
- o.startEvent.fire(o, args);
- }
- // Start polling if a callback is present and the timeout
- // property has been defined.
- if(callback && callback.timeout){
- this._timeOut[o.tId] = window.setTimeout(function(){ oConn.abort(o, callback, true); }, callback.timeout);
- }
- // Remove HTML elements created by appendPostData
- if(oElements && oElements.length > 0){
- for(i=0; i < oElements.length; i++){
- this._formNode.removeChild(oElements[i]);
- }
- }
- // Restore HTML form attributes to their original
- // values prior to file upload.
- for(prop in rawFormAttributes){
- if(YAHOO.lang.hasOwnProperty(rawFormAttributes, prop)){
- if(rawFormAttributes[prop]){
- this._formNode.setAttribute(prop, rawFormAttributes[prop]);
- }
- else{
- this._formNode.removeAttribute(prop);
- }
- }
- }
- // Reset HTML form state properties.
- this.resetFormState();
- // 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.
- uploadCallback = function() {
- if(callback && callback.timeout){
- window.clearTimeout(oConn._timeOut[o.tId]);
- delete oConn._timeOut[o.tId];
- }
- // Fire global custom event -- completeEvent
- oConn.completeEvent.fire(o, args);
- if(o.completeEvent){
- // Fire transaction custom event -- completeEvent
- o.completeEvent.fire(o, args);
- }
- obj = {
- tId : o.tId,
- argument : callback.argument
- };
- try
- {
- // responseText and responseXML will be populated with the same data from the iframe.
- // Since the HTTP headers cannot be read from the iframe
- obj.responseText = io.contentWindow.document.body?io.contentWindow.document.body.innerHTML:io.contentWindow.document.documentElement.textContent;
- obj.responseXML = io.contentWindow.document.XMLDocument?io.contentWindow.document.XMLDocument:io.contentWindow.document;
- }
- catch(e){}
- if(callback && callback.upload){
- if(!callback.scope){
- callback.upload(obj);
- }
- else{
- callback.upload.apply(callback.scope, [obj]);
- }
- }
- // Fire global custom event -- uploadEvent
- oConn.uploadEvent.fire(obj);
- if(o.uploadEvent){
- // Fire transaction custom event -- uploadEvent
- o.uploadEvent.fire(obj);
- }
- YE.removeListener(io, "load", uploadCallback);
- setTimeout(
- function(){
- document.body.removeChild(io);
- oConn.releaseObject(o);
- }, 100);
- };
- // Bind the onload handler to the iframe to detect the file upload response.
- YE.addListener(io, "load", uploadCallback);
- }
- YCM.setForm = _setForm;
- YCM.resetFormState = _resetFormState;
- YCM.createFrame = _createFrame;
- YCM.appendPostData = _appendPostData;
- YCM.uploadFile = _uploadFile;
- })();
- YAHOO.register("connection", YAHOO.util.Connect, {version: "2.8.0r4", build: "2449"});
|