0.6.x/js/06_net/00_XNet.js

   1 // TODO  onlineevent offlineevent, netspeed\r
   2 // local への通信に対しては、netspeed を更新しない\r
   3 \r
   4 // http://bugs.jquery.com/ticket/2709\r
   5 // <head><base> がある場合、<script>の追加に失敗する\r
   6 \r
   7 \r
   8 \r
   9 /**\r
  10  * <p>busy() メソッドだけを持つ。通信用のプロパティは X.Pair によって隠蔽される。\r
  11  * <h4>通信のキャンセル</h4>\r
  12  * <p>kill() で通信待ち中はキャンセル&破棄、通信中の場合は通信の中断&破棄を行う。SUCCESS, ERROR, TIMEOUT イベント以降は kill() は無視される。\r
  13  * <h4>イベント</h4>\r
  14  * <dl>\r
  15  * <dt>X.Event.PROGRESS<dd>通信進行状況\r
  16  * <dt>X.Event.SUCCESS<dd>通信成功\r
  17  * <dt>X.Event.ERROR<dd>通信エラー\r
  18  * <dt>X.Event.TIMEOUT<dd>通信タイムアウト\r
  19  * <dt>X.Event.CANCELED<dd>通信のユーザー、プログラムによるキャンセル\r
  20  * <dt>X.Event.COMPLETE<dd>通信完了。SUCCESS, ERROR, TIMEOUT, CANCELED 後に発生。\r
  21  * </dl>\r
  22  * <p>X.Net インスタンスは COMPLETE 後に自動で破棄される。\r
  23  * <h4>必須プロパティ</h4>\r
  24  * <dl>\r
  25  * <dt>url<dd>URL\r
  26  * <dt>type<dd>'xhr', 'jsonp', 'image', 'img'\r
  27  * <dt>xhr<dd>URL { url : 'hoge', type : 'xhr' } の省略形\r
  28  * <dt>jsonp<dd>URL { url : 'hoge', type : 'jsonp' } の省略形\r
  29  * <dt>image, img<dd>URL { url : 'hoge', type : 'image' } の省略形\r
  30  * </dl>\r
  31  * <h4>XHR 用プロパティ</h4>\r
  32  * <dl>\r
  33  * <dt>method<dd>'GET', 'POST' 未指定かつ postdata を設定している場合、'POST' になる。\r
  34  * <dt>postdata<dd>string, object の場合は X.String.serialize される。\r
  35  * <dt>async<dd>boolean\r
  36  * <dt>username<dd>BASIC 認証\r
  37  * <dt>password<dd>BASIC 認証\r
  38  * <dt>headers<dd>object xhr.setRequestHeader する値\r
  39  * <dt>timeout<dd>タイムアウト ms\r
  40  * <dt>cache<dd>headers[ 'Pragma' ] = 'no-cache' 等を設定するか?\r
  41  * <dt>dataType<dd>'text', 'json', 'xml', 'blob', 'arraybuffer' 等。xhr.responseType に指定する値\r
  42  * <dt>mimeType<dd>'text/xml', 'audio/mpeg' 等。xhr.overrideMimeType する値\r
  43  * <dt>auth<dd>X.OAuth2 インスタンス(OAuth2 サービスの定義)\r
  44  * </dl>\r
  45  * \r
  46  * @alias X.Net\r
  47  * @class 各種ネットワーク機能をラップしインターフェイスを共通化する。\r
  48  * @constructs Net\r
  49  * @extends {EventDispatcher}\r
  50  * @example // XHR - GET\r
  51  * var net = X.Net( { xhr : urlString } )\r
  52  *              .listen( X.Event.PROGRESS )\r
  53  *              .listenOnce( [ X.Event.SUCCESS, X.Event.ERROR, X.Event.TIMEOUT, X.Event.CANCELED ] );\r
  54  * \r
  55  * // XHR - POST \r
  56  * var net = X.Net( { xhr : urlString, postdata : myData } );\r
  57  * \r
  58  * // JSONP\r
  59  * var net = X.Net( { jsonp : urlString, staticCallbackName : callbackName, useXDomainWall : false } );\r
  60  * \r
  61  * // Image preload & getSize\r
  62  * var net = X.Net( { image : src, sizeDetection : true } );\r
  63  * \r
  64  * // load &lt;script&gt;, &lt;link&gt;\r
  65  */\r
  66 X[ 'Net' ] = X_EventDispatcher[ 'inherits' ](\r
  67                 'X.Net',\r
  68                 X_Class.NONE,\r
  69                 {\r
  70                         'netType'    : '',\r
  71                         'netName'    : '',\r
  72                         'netVersion' : 0,\r
  73                         \r
  74                         'Constructor' : function( urlOrObject, opt_options ){\r
  75                                 var v, opt, url, type, auth;\r
  76                                 \r
  77                                 if( X_Type_isObject( opt = urlOrObject ) ){\r
  78                                         if( v = opt[ 'xhr' ] ){\r
  79                                                 url  = v;\r
  80                                                 type = X_NET_TYPE_XHR;\r
  81                                         } else\r
  82                                         if( v = opt[ 'jsonp' ] ){\r
  83                                                 url  = v;\r
  84                                                 type = X_NET_TYPE_JSONP;\r
  85                                         } else\r
  86                                         if( v = opt[ 'img' ] || opt[ 'image' ] ){\r
  87                                                 url  = v;\r
  88                                                 type = X_NET_TYPE_IMAGE;\r
  89                                         } else\r
  90                                         if( v = opt[ 'form' ] ){\r
  91                                                 url  = v;\r
  92                                                 type = X_NET_TYPE_FORM;\r
  93                                         } else\r
  94                                         if( v = opt[ 'type' ] ){\r
  95 \r
  96                                                 switch( v ){\r
  97                                                         case 'xhr' :\r
  98                                                                 type = X_NET_TYPE_XHR;\r
  99                                                                 break;\r
 100                                                         case 'jsonp' :\r
 101                                                                 type = X_NET_TYPE_JSONP;\r
 102                                                                 break;\r
 103                                                         case 'img' :\r
 104                                                         case 'image' :\r
 105                                                                 type = X_NET_TYPE_IMAGE;\r
 106                                                                 break;\r
 107                                                         case 'from' :\r
 108                                                                 type = X_NET_TYPE_FORM;\r
 109                                                                 break;\r
 110                                                         default :\r
 111                                                                 alert( 'X.Net args error' );\r
 112                                                                 return; \r
 113                                                 };\r
 114                                                 url = opt[ 'url'  ];\r
 115                                         };\r
 116                                         \r
 117                                         if( !X_Type_isString( url ) ){\r
 118                                                 alert( 'X.Net args error' );\r
 119                                                 return;\r
 120                                         };\r
 121                                         \r
 122                                 } else\r
 123                                 if( X_Type_isString( urlOrObject ) ){\r
 124                                         url = urlOrObject;\r
 125                                         \r
 126                                         if( X_Type_isObject( opt = opt_options ) ){\r
 127                                                 type = opt[ 'type' ] || X_NET_TYPE_XHR;\r
 128                                         } else {\r
 129                                                 type = X_NET_TYPE_XHR;\r
 130                                                 opt  = { 'url' : url, 'method' : 'GET' };\r
 131                                         };\r
 132                                         \r
 133                                 } else {\r
 134                                         alert( 'X.Net args error' );\r
 135                                         return;\r
 136                                 };\r
 137                                 \r
 138                                 if( auth = opt[ 'auth' ] ){\r
 139                                         delete opt[ 'auth' ];\r
 140                                 };\r
 141                                 opt = X_Object_deepCopy( opt );\r
 142                                 if( auth ){\r
 143                                         opt[ 'auth' ] = auth; // auth は deep copy されるとまずい\r
 144                                 };\r
 145                                 opt.netType   = type;\r
 146                                 opt[ 'url'  ] = url;                            \r
 147                                 \r
 148                                 if( type === X_NET_TYPE_XHR ){\r
 149                                         opt[ 'method' ] = opt[ 'method' ] || ( opt[ 'postdata' ] ? 'POST' : 'GET' );\r
 150                                         \r
 151                                         // XDomain 不可 -> Flash, Gears, Silverlight, canUseGadget なら gadget に切替?\r
 152                                         // PUT DELETE UPDATE 不可 -> Flash, Gears, Silverlight, canUseGadget なら gadget に切替?\r
 153                                         // xプロトコル な binary のロード -> gadget 内で proxyURL による XHR\r
 154                                         //  or X_EVENT_ERROR\r
 155                                         \r
 156                                         opt[ 'dataType' ] = opt[ 'dataType' ] || X_URL_getEXT( url );\r
 157                                 };\r
 158                                 \r
 159                                 X_Pair_create( this, opt );\r
 160                                 \r
 161                                 this[ 'listen' ]( [ X_EVENT_BEFORE_KILL_INSTANCE, X_EVENT_KILL_INSTANCE ], X_NET_proxyDispatch );\r
 162                                 \r
 163                                 X_NET_QUEUE_LIST[ X_NET_QUEUE_LIST.length ] = this;\r
 164                                 !X_NET_currentQueue && X_NET_shiftQueue();\r
 165                         },\r
 166                         \r
 167                 /**\r
 168                  * 現在通信中か？調べる。false の場合、通信の順番待ちか、通信が終了している。\r
 169                  * @alias Net.prototype.busy\r
 170                  */\r
 171                         'busy' : function(){\r
 172                                 return this === X_NET_currentQueue && X_NET_currentWrapper._busy;\r
 173                         }\r
 174                 }\r
 175         );\r
 176 /*\r
 177  * @interface\r
 178  */\r
 179 var X_NET_IWrapper = function(){};\r
 180         X_NET_IWrapper.prototype.load   = function(){};\r
 181         X_NET_IWrapper.prototype.cancel = function(){};\r
 182         X_NET_IWrapper.prototype.reset  = function(){};\r
 183 \r
 184 \r
 185 var X_NET_TYPE_XHR   = 1,\r
 186         X_NET_TYPE_JSONP = 2,\r
 187         X_NET_TYPE_FORM  = 3,\r
 188         X_NET_TYPE_IMAGE = 4,\r
 189 \r
 190         X_NET_QUEUE_LIST = [],\r
 191 \r
 192         X_NET_XHRWrapper,\r
 193         X_NET_JSONPWrapper,\r
 194         X_NET_FormWrapper,\r
 195         X_NET_ImageWrapper,\r
 196         X_NET_GIMRWrapper,\r
 197 \r
 198         X_NET_currentWrapper,\r
 199         X_NET_currentQueue,\r
 200         X_NET_currentData,\r
 201         X_NET_completePhase;\r
 202 \r
 203 function X_NET_proxyDispatch( e ){\r
 204         var i, flag, auth;\r
 205         \r
 206         switch( e.type ){\r
 207                 case X_EVENT_BEFORE_KILL_INSTANCE :\r
 208                         if( this === X_NET_currentQueue && X_NET_completePhase ) return X_Callback_PREVENT_DEFAULT;\r
 209                         break;\r
 210                 \r
 211                 case X_EVENT_KILL_INSTANCE :\r
 212                         i = X_NET_QUEUE_LIST.indexOf( this );\r
 213                         \r
 214                         if( i !== -1 ){\r
 215                                 X_NET_QUEUE_LIST.splice( i, 1 );\r
 216                                 flag = true;\r
 217                         } else\r
 218                         if( this === X_NET_currentQueue ){\r
 219                                 X_NET_currentWrapper.cancel();\r
 220                                 X_NET_shiftQueue();\r
 221                                 flag = true;\r
 222                         };\r
 223                         \r
 224                         if( flag ){ // flag が立つ場合、これは中断\r
 225                                 this[ 'dispatch' ]( X_EVENT_CANCELED );\r
 226                                 this[ 'dispatch' ]( { type : X_EVENT_COMPLETE, 'lastEventType' : X_EVENT_CANCELED } );\r
 227                                 X_Pair_release( this );\r
 228                         };\r
 229                         break;                  \r
 230                 case X_EVENT_PROGRESS :\r
 231                         this[ 'dispatch' ]( e );\r
 232                         break;\r
 233                 \r
 234                 case X_EVENT_ERROR :\r
 235                         if( e.status === 401 ){\r
 236                                 if( auth = X_Pair_get( this )[ 'auth' ] ){\r
 237                                         X_Pair_get( auth ).onAuthError( auth );\r
 238                                 };\r
 239                         };\r
 240                         \r
 241                 case X_EVENT_SUCCESS :\r
 242                 case X_EVENT_TIMEOUT :\r
 243                         X_NET_completePhase = true;\r
 244                         this\r
 245                                 [ 'listenOnce' ]( X_EVENT_COMPLETE, X_NET_proxyDispatch )\r
 246                                 [ 'unlisten' ]( [ X_EVENT_BEFORE_KILL_INSTANCE, X_EVENT_KILL_INSTANCE ], X_NET_proxyDispatch )\r
 247                                 [ 'asyncDispatch' ]( e );\r
 248                         this[ 'asyncDispatch' ]( 32, { type : X_EVENT_COMPLETE, 'lastEventType' : e.type } );\r
 249                         break;\r
 250                 case X_EVENT_COMPLETE :\r
 251                         X_Pair_release( this );\r
 252                         X_NET_shiftQueue();\r
 253                         X_NET_completePhase = false;\r
 254                         this[ 'kill' ]();\r
 255                         break;\r
 256         };\r
 257 };\r
 258 \r
 259 function X_NET_shiftQueue(){\r
 260         var auth, authSettings;\r
 261 \r
 262         if( X_NET_currentQueue ){\r
 263                 if( X_NET_currentWrapper._busy ) return;\r
 264                 X_NET_currentWrapper\r
 265                         [ 'unlisten' ]( [ X_EVENT_PROGRESS, X_EVENT_SUCCESS, X_EVENT_ERROR, X_EVENT_TIMEOUT ], X_NET_currentQueue, X_NET_proxyDispatch )\r
 266                         .reset();\r
 267                 X_NET_currentQueue = X_NET_currentWrapper = X_NET_currentData = null;\r
 268         };\r
 269         \r
 270         if( !X_NET_QUEUE_LIST.length ) return;\r
 271 \r
 272         X_NET_currentQueue = X_NET_QUEUE_LIST.shift();\r
 273         X_NET_currentData  = X_Pair_get( X_NET_currentQueue );\r
 274         \r
 275         switch( X_NET_currentData.netType ){\r
 276                 case X_NET_TYPE_XHR :\r
 277                         \r
 278                         // TODO (xProtocol |　method='update' | !cors) & canUse -> gadget.io.makeRequset, flash\r
 279                         // force 'gadget', 'flash'\r
 280                         switch( X_NET_currentData[ 'test' ] ){\r
 281                                 case 'gadget' :\r
 282                                         X_NET_currentWrapper = X_NET_GIMRWrapper || X_TEMP.X_Net_GIMR_init();\r
 283                                         break;\r
 284                                 case 'flash'  :\r
 285                                         break;\r
 286                                 \r
 287                                 default :\r
 288                                         X_NET_currentWrapper = X_NET_XHRWrapper || X_TEMP.X_Net_XHR_init();\r
 289                         };\r
 290                         \r
 291                         \r
 292                         // OAuth2\r
 293                         if( auth = X_NET_currentData[ 'auth' ] ){\r
 294                                 authSettings = X_Pair_get( auth );\r
 295                                 switch( auth[ 'state' ]() ){\r
 296                                         case 0 :\r
 297                                         case 1 :\r
 298                                         case 2 :\r
 299                                                 if( !( auth[ 'dispatch' ]( X_EVENT_NEED_AUTH ) & X_Callback_PREVENT_DEFAULT ) ){\r
 300                                                         authSettings.lazyReq = X_NET_currentQueue;\r
 301                                                 };\r
 302                                                 X_NET_currentQueue = null;\r
 303                                                 X_NET_shiftQueue();\r
 304                                                 break;\r
 305                                         case 3 : // refresh token\r
 306                                                 X_NET_QUEUE_LIST.push( X_NET_currentQueue );\r
 307                                                 X_NET_currentQueue = null;\r
 308                                                 X_NET_shiftQueue();\r
 309                                                 return;\r
 310                                 };\r
 311                                 authSettings.updateRequest( auth, X_NET_currentData );\r
 312                         };\r
 313                         break;\r
 314                 case X_NET_TYPE_JSONP :\r
 315                         X_NET_currentWrapper = X_NET_JSONPWrapper || X_TEMP.X_NET_JSONP_init();\r
 316                         break;\r
 317                 case X_NET_TYPE_FORM :\r
 318                         X_NET_currentWrapper = X_NET_FormWrapper;\r
 319                         break;\r
 320                 case X_NET_TYPE_IMAGE :\r
 321                         X_NET_currentWrapper = X_NET_ImageWrapper || X_TEMP.X_NET_Image_init();\r
 322                         break;\r
 323         };\r
 324         \r
 325         X_NET_currentWrapper[ 'listen' ]( [ X_EVENT_PROGRESS, X_EVENT_SUCCESS, X_EVENT_ERROR, X_EVENT_TIMEOUT ], X_NET_currentQueue, X_NET_proxyDispatch );\r
 326         \r
 327         X_NET_currentWrapper.load( X_NET_currentData );\r
 328 };\r
 329 \r