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