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>params<dd>url パラメータを object で渡すことが出来る。\r
  35  * <dt>postdata<dd>string, object の場合は X.String.serialize される。\r
  36  * <dt>async<dd>boolean\r
  37  * <dt>username<dd>BASIC 認証\r
  38  * <dt>password<dd>BASIC 認証\r
  39  * <dt>headers<dd>object xhr.setRequestHeader する値\r
  40  * <dt>timeout<dd>タイムアウト ms\r
  41  * <dt>cache<dd>headers[ 'Pragma' ] = 'no-cache' 等を設定するか?\r
  42  * <dt>dataType<dd>'text', 'json', 'xml', 'blob', 'arraybuffer' 等。xhr.responseType に指定する値\r
  43  * <dt>mimeType<dd>'text/xml', 'audio/mpeg' 等。xhr.overrideMimeType する値\r
  44  * <dt>auth<dd>X.OAuth2 インスタンス(OAuth2 サービスの定義)\r
  45  * <dt>getFullHeaders<dd>getAllResponseHeaders() をパースしたハッシュを返す。値は配列になっている。XDR は Content-Type しか取得でいない。\r
  46  * <dt>canUse<dd>未実装。gadget proxy, YQL, <del>YPipes</del> 等のマッシュアップの許可。現在は test : 'gadget' としている\r
  47  * </dl>\r
  48  * \r
  49  * <h4>JSONP 用プロパティ</h4>\r
  50  * <dl>\r
  51  * <dt>params<dd>url パラメータを object で渡すことが出来る。\r
  52  * <dt>callbackName<dd>callback(json) コールバック名が固定されている際に指定。または &callback=hoge 以外の名前でコールバックを指定する場合に params と callbackName に書いておく。url パラメータに callback が無く、callbackName もない場合、フレームワーク内で自動で設定される\r
  53  * <dt>charset<dd>ページと異なるjsonpを読み込む場合に指定 'EUC-JP', 'Shift-JIS' 等 script タグの charset に入る。https://code.google.com/p/ajaxzip3/issues/detail?id=5\r
  54  * <dt>useFireWall<dd>異なるドメインに jsonp を読み込んだ後、xdomain iframe 通信を使ってデータを受け取る。不正なコードの実行を防ぐことが出来る、未実装\r
  55  * </dl>\r
  56  * \r
  57  * @alias X.Net\r
  58  * @class 各種ネットワーク機能をラップしインターフェイスを共通化する。\r
  59  * @constructs Net\r
  60  * @extends {EventDispatcher}\r
  61  * @example // XHR - GET\r
  62  * var net = X.Net( { xhr : urlString } )\r
  63  *              .listen( X.Event.PROGRESS )\r
  64  *              .listenOnce( [ X.Event.SUCCESS, X.Event.ERROR, X.Event.TIMEOUT, X.Event.CANCELED ] );\r
  65  * \r
  66  * // XHR - GET \r
  67  * var net = X.Net( urlString );\r
  68  * \r
  69  * // XHR - POST \r
  70  * var net = X.Net( { xhr : urlString, postdata : myData } );\r
  71  * \r
  72  * // JSONP\r
  73  * var net = X.Net( { jsonp : urlString, params : params, callbackName : callbackName, charset : charset, useFireWall : false } );\r
  74  * \r
  75  * // Form\r
  76  * var net = X.Net( { form : urlString, method : 'POST', target : '_self', params : {} } ); // _self, _parent, _top の場合、ページから離脱する\r
  77  * \r
  78  * // Image preload & getSize\r
  79  * var net = X.Net( { image : src, sizeDetection : true } );\r
  80  * \r
  81  * // load &lt;script&gt;, &lt;link&gt;\r
  82  */\r
  83 X[ 'Net' ] = X_EventDispatcher[ 'inherits' ](\r
  84                 'X.Net',\r
  85                 X_Class.NONE,\r
  86                 {\r
  87                         'netType'    : '',\r
  88                         'netName'    : '',\r
  89                         'netVersion' : 0,\r
  90                         \r
  91                         'Constructor' : function( urlOrObject, opt_options ){\r
  92                                 var opt, url, type, auth;\r
  93                                 \r
  94                                 if( X_Type_isObject( opt = urlOrObject ) ){\r
  95                                         //{+xhr\r
  96                                         if( X_Type_isString( url = opt[ 'xhr' ] ) ){\r
  97                                                 type = X_NET_TYPE_XHR;\r
  98                                         } else\r
  99                                         //}+xhr\r
 100                                         //{+jsonp\r
 101                                         if( X_Type_isString( url = opt[ 'jsonp' ] ) ){\r
 102                                                 type = X_NET_TYPE_JSONP;\r
 103                                         } else\r
 104                                         //}+jsonp\r
 105                                         //{+netimage\r
 106                                         if( X_Type_isString( url = opt[ 'img' ] || opt[ 'image' ] ) ){\r
 107                                                 type = X_NET_TYPE_IMAGE;\r
 108                                         } else\r
 109                                         //}+netimage\r
 110                                         //{+netform\r
 111                                         if( X_Type_isString( url = opt[ 'form' ] ) ){\r
 112                                                 type = X_NET_TYPE_FORM;\r
 113                                         } else\r
 114                                         //}+netform\r
 115                                         if( !( type = X_NET_NAME_TO_ID[ opt[ 'type' ] ] ) ){\r
 116                                                 //{+dev\r
 117                                                 alert( 'X.Net args error' );\r
 118                                                 //}+dev\r
 119                                                 return;\r
 120                                         } else {\r
 121                                                 url = opt[ 'url' ];\r
 122                                         };\r
 123                                         //{+dev\r
 124                                         if( !X_Type_isString( url ) ){\r
 125                                                 alert( 'X.Net args error' );\r
 126                                                 return;\r
 127                                         };\r
 128                                         //}+dev\r
 129                                 } else\r
 130                                 if( X_Type_isString( urlOrObject ) ){\r
 131                                         url = urlOrObject;\r
 132                                         \r
 133                                         if( X_Type_isObject( opt = opt_options ) ){\r
 134                                                 type = opt[ 'type' ] || X_NET_TYPE_XHR;\r
 135                                         } else {\r
 136                                                 type = X_NET_TYPE_XHR;\r
 137                                                 opt  = { 'url' : url, 'method' : 'GET' };\r
 138                                         };\r
 139                                 //{+dev \r
 140                                 } else {\r
 141                                         alert( 'X.Net args error' );\r
 142                                         return;\r
 143                                 //}+dev\r
 144                                 };\r
 145                                 \r
 146                                 // auth の退避\r
 147                                 if( auth = opt[ 'auth' ] ){\r
 148                                         delete opt[ 'auth' ];\r
 149                                 };\r
 150                                 opt = X_Object_deepCopy( opt );\r
 151                                 if( auth ){\r
 152                                         opt[ 'auth' ] = auth; // auth は deep copy されるとまずい\r
 153                                 };\r
 154                                 \r
 155                                 // params を url に追加\r
 156                                 if( opt[ 'params' ] ){\r
 157                                         url = X_URL_create( url, opt[ 'params' ] );\r
 158                                         delete opt[ 'params' ];\r
 159                                 };                              \r
 160                                 \r
 161                                 if( type === X_NET_TYPE_XHR ){\r
 162                                         opt[ 'method' ] = opt[ 'method' ] || ( opt[ 'postdata' ] ? 'POST' : 'GET' );\r
 163 \r
 164                                         // XDomain 不可 -> Flash, Gears, Silverlight, canUseGadget なら gadget に切替?\r
 165                                         // PUT DELETE UPDATE 不可 -> Flash, Gears, Silverlight, canUseGadget なら gadget に切替?\r
 166                                         // xプロトコル な binary のロード -> gadget 内で proxyURL による XHR\r
 167                                         //  or X_EVENT_ERROR\r
 168                                         \r
 169                                         opt[ 'dataType' ] = opt[ 'dataType' ] || X_URL_getEXT( url );\r
 170                                 };\r
 171                                 \r
 172                                 opt.netType   = type;\r
 173                                 opt[ 'url'  ] = url;                            \r
 174                                 \r
 175                                 X_Pair_create( this, opt );\r
 176                                 \r
 177                                 this[ 'listen' ]( [ X_EVENT_BEFORE_KILL_INSTANCE, X_EVENT_KILL_INSTANCE ], X_NET_proxyDispatch );\r
 178                                 \r
 179                                 X_NET_QUEUE_LIST[ X_NET_QUEUE_LIST.length ] = this;\r
 180                                 !X_NET_currentQueue && X_NET_shiftQueue();\r
 181                         },\r
 182                         \r
 183                 /**\r
 184                  * 現在通信中か？調べる。false の場合、通信の順番待ちか、通信が終了している。\r
 185                  * @alias Net.prototype.busy\r
 186                  */\r
 187                         'busy' : function(){\r
 188                                 return this === X_NET_currentQueue && X_NET_currentWrapper._busy;\r
 189                         }\r
 190                 }\r
 191         );\r
 192 /*\r
 193  * @interface\r
 194  */\r
 195 var X_NET_IWrapper = function(){};\r
 196         X_NET_IWrapper.prototype.load   = function(){};\r
 197         X_NET_IWrapper.prototype.cancel = function(){};\r
 198         X_NET_IWrapper.prototype.reset  = function(){};\r
 199 \r
 200 \r
 201 var X_NET_TYPE_XHR   = 1,\r
 202         X_NET_TYPE_JSONP = 2,\r
 203         X_NET_TYPE_FORM  = 3,\r
 204         X_NET_TYPE_IMAGE = 4,\r
 205 \r
 206         X_NET_NAME_TO_ID = {\r
 207                 'xhr'   : X_NET_TYPE_XHR,\r
 208                 'jsonp' : X_NET_TYPE_JSONP,\r
 209                 'form'  : X_NET_TYPE_FORM,\r
 210                 'img'   : X_NET_TYPE_IMAGE,\r
 211                 'image' : X_NET_TYPE_IMAGE\r
 212         },\r
 213 \r
 214         X_NET_QUEUE_LIST = [],\r
 215 \r
 216         X_NET_XHRWrapper,\r
 217         X_NET_JSONPWrapper,\r
 218         X_NET_FormWrapper,\r
 219         X_NET_ImageWrapper,\r
 220         X_NET_GIMRWrapper,\r
 221 \r
 222         X_NET_currentWrapper,\r
 223         X_NET_currentQueue,\r
 224         X_NET_currentData,\r
 225         X_NET_completePhase;\r
 226 \r
 227 function X_NET_proxyDispatch( e ){\r
 228         var i, flag, auth;\r
 229         \r
 230         switch( e.type ){\r
 231                 case X_EVENT_BEFORE_KILL_INSTANCE :\r
 232                         if( this === X_NET_currentQueue && X_NET_completePhase ) return X_Callback_PREVENT_DEFAULT;\r
 233                         break;\r
 234                 \r
 235                 case X_EVENT_KILL_INSTANCE :\r
 236                         i = X_NET_QUEUE_LIST.indexOf( this );\r
 237                         \r
 238                         if( i !== -1 ){\r
 239                                 X_NET_QUEUE_LIST.splice( i, 1 );\r
 240                                 flag = true;\r
 241                         } else\r
 242                         if( this === X_NET_currentQueue ){\r
 243                                 X_NET_currentWrapper.cancel();\r
 244                                 X_NET_shiftQueue();\r
 245                                 flag = true;\r
 246                         };\r
 247                         \r
 248                         if( flag ){ // flag が立つ場合、これは中断\r
 249                                 this[ 'dispatch' ]( X_EVENT_CANCELED );\r
 250                                 this[ 'dispatch' ]( { type : X_EVENT_COMPLETE, 'lastEventType' : X_EVENT_CANCELED } );\r
 251                                 X_Pair_release( this );\r
 252                         };\r
 253                         break;                  \r
 254                 case X_EVENT_PROGRESS :\r
 255                         this[ 'dispatch' ]( e );\r
 256                         break;\r
 257                 \r
 258                 case X_EVENT_ERROR :\r
 259                         if( e.status === 401 ){\r
 260                                 if( auth = X_Pair_get( this )[ 'auth' ] ){\r
 261                                         X_Pair_get( auth ).onAuthError( auth, e );\r
 262                                 };\r
 263                         };\r
 264                         \r
 265                 case X_EVENT_SUCCESS :\r
 266                 case X_EVENT_TIMEOUT :\r
 267                         X_NET_completePhase = true;\r
 268                         this\r
 269                                 [ 'listenOnce' ]( X_EVENT_COMPLETE, X_NET_proxyDispatch )\r
 270                                 [ 'unlisten' ]( [ X_EVENT_BEFORE_KILL_INSTANCE, X_EVENT_KILL_INSTANCE ], X_NET_proxyDispatch )\r
 271                                 [ 'asyncDispatch' ]( e );\r
 272                         this[ 'asyncDispatch' ]( 32, { type : X_EVENT_COMPLETE, 'lastEventType' : e.type } );\r
 273                         break;\r
 274                 case X_EVENT_COMPLETE :\r
 275                         X_Pair_release( this );\r
 276                         X_NET_shiftQueue();\r
 277                         X_NET_completePhase = false;\r
 278                         this[ 'kill' ]();\r
 279                         break;\r
 280         };\r
 281 };\r
 282 \r
 283 function X_NET_shiftQueue(){\r
 284         var auth, authSettings;\r
 285 \r
 286         if( X_NET_currentQueue ){\r
 287                 if( X_NET_currentWrapper._busy ) return;\r
 288                 X_NET_currentWrapper\r
 289                         [ 'unlisten' ]( [ X_EVENT_PROGRESS, X_EVENT_SUCCESS, X_EVENT_ERROR, X_EVENT_TIMEOUT ], X_NET_currentQueue, X_NET_proxyDispatch )\r
 290                         .reset();\r
 291                 X_NET_currentQueue = X_NET_currentWrapper = X_NET_currentData = null;\r
 292         };\r
 293         \r
 294         if( !X_NET_QUEUE_LIST.length ) return;\r
 295 \r
 296         X_NET_currentQueue = X_NET_QUEUE_LIST.shift();\r
 297         X_NET_currentData  = X_Pair_get( X_NET_currentQueue );\r
 298         \r
 299         switch( X_NET_currentData.netType ){\r
 300                 case X_NET_TYPE_XHR :\r
 301                         \r
 302                         // TODO (xProtocol |　method='update' | !cors) & canUse -> gadget.io.makeRequset, flash\r
 303                         // force 'gadget', 'flash'\r
 304                         switch( X_NET_currentData[ 'test' ] ){\r
 305                                 case 'gadget' :\r
 306                                         X_NET_currentWrapper = X_NET_GIMRWrapper || X_TEMP.X_Net_GIMR_init();\r
 307                                         break;\r
 308                                 case 'flash'  :\r
 309                                         break;\r
 310                                 \r
 311                                 default :\r
 312                                         X_NET_currentWrapper = X_NET_XHRWrapper || X_TEMP.X_Net_XHR_init();\r
 313                         };\r
 314                         \r
 315                         \r
 316                         // OAuth2\r
 317                         if( auth = X_NET_currentData[ 'auth' ] ){\r
 318                                 authSettings = X_Pair_get( auth );\r
 319                                 switch( auth[ 'state' ]() ){\r
 320                                         case 0 :\r
 321                                         case 1 :\r
 322                                         case 2 :\r
 323                                                 if( !( auth[ 'dispatch' ]( X_EVENT_NEED_AUTH ) & X_Callback_PREVENT_DEFAULT ) ){\r
 324                                                         authSettings.lazyReq = X_NET_currentQueue;\r
 325                                                 };\r
 326                                                 X_NET_currentQueue = null;\r
 327                                                 X_NET_shiftQueue();\r
 328                                                 break;\r
 329                                         case 3 : // refresh token\r
 330                                                 X_NET_QUEUE_LIST.push( X_NET_currentQueue );\r
 331                                                 X_NET_currentQueue = null;\r
 332                                                 X_NET_shiftQueue();\r
 333                                                 return;\r
 334                                 };\r
 335                                 authSettings.updateRequest( auth, X_NET_currentData );\r
 336                         };\r
 337                         break;\r
 338                 case X_NET_TYPE_JSONP :\r
 339                         X_NET_currentWrapper = X_NET_JSONPWrapper || X_TEMP.X_NET_JSONP_init();\r
 340                         break;\r
 341                 case X_NET_TYPE_FORM :\r
 342                         X_NET_currentWrapper = X_NET_FormWrapper  || X_TEMP.X_NET_Form_init();\r
 343                         break;\r
 344                 case X_NET_TYPE_IMAGE :\r
 345                         X_NET_currentWrapper = X_NET_ImageWrapper || X_TEMP.X_NET_Image_init();\r
 346                         break;\r
 347         };\r
 348         \r
 349         X_NET_currentWrapper[ 'listen' ]( [ X_EVENT_PROGRESS, X_EVENT_SUCCESS, X_EVENT_ERROR, X_EVENT_TIMEOUT ], X_NET_currentQueue, X_NET_proxyDispatch );\r
 350         \r
 351         X_NET_currentWrapper.load( X_NET_currentData );\r
 352 };\r
 353 \r