web_socket.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. // Copyright: Hiroshi Ichikawa <http://gimite.net/en/>
  2. // License: New BSD License
  3. // Reference: http://dev.w3.org/html5/websockets/
  4. // Reference: http://tools.ietf.org/html/rfc6455
  5. (function() {
  6. if (window.WEB_SOCKET_FORCE_FLASH) {
  7. // Keeps going.
  8. } else if (window.WebSocket) {
  9. return;
  10. } else if (window.MozWebSocket) {
  11. // Firefox.
  12. window.WebSocket = MozWebSocket;
  13. return;
  14. }
  15. var logger;
  16. if (window.WEB_SOCKET_LOGGER) {
  17. logger = WEB_SOCKET_LOGGER;
  18. } else if (window.console && window.console.log && window.console.error) {
  19. // In some environment, console is defined but console.log or console.error is missing.
  20. logger = window.console;
  21. } else {
  22. logger = {log: function(){ }, error: function(){ }};
  23. }
  24. // swfobject.hasFlashPlayerVersion("10.0.0") doesn't work with Gnash.
  25. if (swfobject.getFlashPlayerVersion().major < 10) {
  26. logger.error("Flash Player >= 10.0.0 is required.");
  27. return;
  28. }
  29. if (location.protocol == "file:") {
  30. logger.error(
  31. "WARNING: web-socket-js doesn't work in file:///... URL " +
  32. "unless you set Flash Security Settings properly. " +
  33. "Open the page via Web server i.e. http://...");
  34. }
  35. /**
  36. * Our own implementation of WebSocket class using Flash.
  37. * @param {string} url
  38. * @param {array or string} protocols
  39. * @param {string} proxyHost
  40. * @param {int} proxyPort
  41. * @param {string} headers
  42. */
  43. window.WebSocket = function(url, protocols, proxyHost, proxyPort, headers) {
  44. var self = this;
  45. self.__id = WebSocket.__nextId++;
  46. WebSocket.__instances[self.__id] = self;
  47. self.readyState = WebSocket.CONNECTING;
  48. self.bufferedAmount = 0;
  49. self.__events = {};
  50. if (!protocols) {
  51. protocols = [];
  52. } else if (typeof protocols == "string") {
  53. protocols = [protocols];
  54. }
  55. // Uses setTimeout() to make sure __createFlash() runs after the caller sets ws.onopen etc.
  56. // Otherwise, when onopen fires immediately, onopen is called before it is set.
  57. self.__createTask = setTimeout(function() {
  58. WebSocket.__addTask(function() {
  59. self.__createTask = null;
  60. WebSocket.__flash.create(
  61. self.__id, url, protocols, proxyHost || null, proxyPort || 0, headers || null);
  62. });
  63. }, 0);
  64. };
  65. /**
  66. * Send data to the web socket.
  67. * @param {string} data The data to send to the socket.
  68. * @return {boolean} True for success, false for failure.
  69. */
  70. WebSocket.prototype.send = function(data) {
  71. if (this.readyState == WebSocket.CONNECTING) {
  72. throw "INVALID_STATE_ERR: Web Socket connection has not been established";
  73. }
  74. // We use encodeURIComponent() here, because FABridge doesn't work if
  75. // the argument includes some characters. We don't use escape() here
  76. // because of this:
  77. // https://developer.mozilla.org/en/Core_JavaScript_1.5_Guide/Functions#escape_and_unescape_Functions
  78. // But it looks decodeURIComponent(encodeURIComponent(s)) doesn't
  79. // preserve all Unicode characters either e.g. "\uffff" in Firefox.
  80. // Note by wtritch: Hopefully this will not be necessary using ExternalInterface. Will require
  81. // additional testing.
  82. var result = WebSocket.__flash.send(this.__id, encodeURIComponent(data));
  83. if (result < 0) { // success
  84. return true;
  85. } else {
  86. this.bufferedAmount += result;
  87. return false;
  88. }
  89. };
  90. /**
  91. * Close this web socket gracefully.
  92. */
  93. WebSocket.prototype.close = function() {
  94. if (this.__createTask) {
  95. clearTimeout(this.__createTask);
  96. this.__createTask = null;
  97. this.readyState = WebSocket.CLOSED;
  98. return;
  99. }
  100. if (this.readyState == WebSocket.CLOSED || this.readyState == WebSocket.CLOSING) {
  101. return;
  102. }
  103. this.readyState = WebSocket.CLOSING;
  104. WebSocket.__flash.close(this.__id);
  105. };
  106. /**
  107. * Implementation of {@link <a href="http://www.w3.org/TR/DOM-Level-2-Events/events.html#Events-registration">DOM 2 EventTarget Interface</a>}
  108. *
  109. * @param {string} type
  110. * @param {function} listener
  111. * @param {boolean} useCapture
  112. * @return void
  113. */
  114. WebSocket.prototype.addEventListener = function(type, listener, useCapture) {
  115. if (!(type in this.__events)) {
  116. this.__events[type] = [];
  117. }
  118. this.__events[type].push(listener);
  119. };
  120. /**
  121. * Implementation of {@link <a href="http://www.w3.org/TR/DOM-Level-2-Events/events.html#Events-registration">DOM 2 EventTarget Interface</a>}
  122. *
  123. * @param {string} type
  124. * @param {function} listener
  125. * @param {boolean} useCapture
  126. * @return void
  127. */
  128. WebSocket.prototype.removeEventListener = function(type, listener, useCapture) {
  129. if (!(type in this.__events)) return;
  130. var events = this.__events[type];
  131. for (var i = events.length - 1; i >= 0; --i) {
  132. if (events[i] === listener) {
  133. events.splice(i, 1);
  134. break;
  135. }
  136. }
  137. };
  138. /**
  139. * Implementation of {@link <a href="http://www.w3.org/TR/DOM-Level-2-Events/events.html#Events-registration">DOM 2 EventTarget Interface</a>}
  140. *
  141. * @param {Event} event
  142. * @return void
  143. */
  144. WebSocket.prototype.dispatchEvent = function(event) {
  145. var events = this.__events[event.type] || [];
  146. for (var i = 0; i < events.length; ++i) {
  147. events[i](event);
  148. }
  149. var handler = this["on" + event.type];
  150. if (handler) handler.apply(this, [event]);
  151. };
  152. /**
  153. * Handles an event from Flash.
  154. * @param {Object} flashEvent
  155. */
  156. WebSocket.prototype.__handleEvent = function(flashEvent) {
  157. if ("readyState" in flashEvent) {
  158. this.readyState = flashEvent.readyState;
  159. }
  160. if ("protocol" in flashEvent) {
  161. this.protocol = flashEvent.protocol;
  162. }
  163. var jsEvent;
  164. if (flashEvent.type == "open" || flashEvent.type == "error") {
  165. jsEvent = this.__createSimpleEvent(flashEvent.type);
  166. } else if (flashEvent.type == "close") {
  167. jsEvent = this.__createSimpleEvent("close");
  168. jsEvent.wasClean = flashEvent.wasClean ? true : false;
  169. jsEvent.code = flashEvent.code;
  170. jsEvent.reason = flashEvent.reason;
  171. } else if (flashEvent.type == "message") {
  172. var data = decodeURIComponent(flashEvent.message);
  173. jsEvent = this.__createMessageEvent("message", data);
  174. } else {
  175. throw "unknown event type: " + flashEvent.type;
  176. }
  177. this.dispatchEvent(jsEvent);
  178. };
  179. WebSocket.prototype.__createSimpleEvent = function(type) {
  180. if (document.createEvent && window.Event) {
  181. var event = document.createEvent("Event");
  182. event.initEvent(type, false, false);
  183. return event;
  184. } else {
  185. return {type: type, bubbles: false, cancelable: false};
  186. }
  187. };
  188. WebSocket.prototype.__createMessageEvent = function(type, data) {
  189. if (window.MessageEvent && typeof(MessageEvent) == "function" && !window.opera) {
  190. return new MessageEvent("message", {
  191. "view": window,
  192. "bubbles": false,
  193. "cancelable": false,
  194. "data": data
  195. });
  196. } else if (document.createEvent && window.MessageEvent && !window.opera) {
  197. var event = document.createEvent("MessageEvent");
  198. event.initMessageEvent("message", false, false, data, null, null, window, null);
  199. return event;
  200. } else {
  201. // Old IE and Opera, the latter one truncates the data parameter after any 0x00 bytes.
  202. return {type: type, data: data, bubbles: false, cancelable: false};
  203. }
  204. };
  205. /**
  206. * Define the WebSocket readyState enumeration.
  207. */
  208. WebSocket.CONNECTING = 0;
  209. WebSocket.OPEN = 1;
  210. WebSocket.CLOSING = 2;
  211. WebSocket.CLOSED = 3;
  212. // Field to check implementation of WebSocket.
  213. WebSocket.__isFlashImplementation = true;
  214. WebSocket.__initialized = false;
  215. WebSocket.__flash = null;
  216. WebSocket.__instances = {};
  217. WebSocket.__tasks = [];
  218. WebSocket.__nextId = 0;
  219. /**
  220. * Load a new flash security policy file.
  221. * @param {string} url
  222. */
  223. WebSocket.loadFlashPolicyFile = function(url){
  224. WebSocket.__addTask(function() {
  225. WebSocket.__flash.loadManualPolicyFile(url);
  226. });
  227. };
  228. /**
  229. * Loads WebSocketMain.swf and creates WebSocketMain object in Flash.
  230. */
  231. WebSocket.__initialize = function() {
  232. if (WebSocket.__initialized) return;
  233. WebSocket.__initialized = true;
  234. if (WebSocket.__swfLocation) {
  235. // For backword compatibility.
  236. window.WEB_SOCKET_SWF_LOCATION = WebSocket.__swfLocation;
  237. }
  238. if (!window.WEB_SOCKET_SWF_LOCATION) {
  239. logger.error("[WebSocket] set WEB_SOCKET_SWF_LOCATION to location of WebSocketMain.swf");
  240. return;
  241. }
  242. if (!window.WEB_SOCKET_SUPPRESS_CROSS_DOMAIN_SWF_ERROR &&
  243. !WEB_SOCKET_SWF_LOCATION.match(/(^|\/)WebSocketMainInsecure\.swf(\?.*)?$/) &&
  244. WEB_SOCKET_SWF_LOCATION.match(/^\w+:\/\/([^\/]+)/)) {
  245. var swfHost = RegExp.$1;
  246. if (location.host != swfHost) {
  247. logger.error(
  248. "[WebSocket] You must host HTML and WebSocketMain.swf in the same host " +
  249. "('" + location.host + "' != '" + swfHost + "'). " +
  250. "See also 'How to host HTML file and SWF file in different domains' section " +
  251. "in README.md. If you use WebSocketMainInsecure.swf, you can suppress this message " +
  252. "by WEB_SOCKET_SUPPRESS_CROSS_DOMAIN_SWF_ERROR = true;");
  253. }
  254. }
  255. var container = document.createElement("div");
  256. container.id = "webSocketContainer";
  257. // Hides Flash box. We cannot use display: none or visibility: hidden because it prevents
  258. // Flash from loading at least in IE. So we move it out of the screen at (-100, -100).
  259. // But this even doesn't work with Flash Lite (e.g. in Droid Incredible). So with Flash
  260. // Lite, we put it at (0, 0). This shows 1x1 box visible at left-top corner but this is
  261. // the best we can do as far as we know now.
  262. container.style.position = "absolute";
  263. if (WebSocket.__isFlashLite()) {
  264. container.style.left = "0px";
  265. container.style.top = "0px";
  266. } else {
  267. container.style.left = "-100px";
  268. container.style.top = "-100px";
  269. }
  270. var holder = document.createElement("div");
  271. holder.id = "webSocketFlash";
  272. container.appendChild(holder);
  273. document.body.appendChild(container);
  274. // See this article for hasPriority:
  275. // http://help.adobe.com/en_US/as3/mobile/WS4bebcd66a74275c36cfb8137124318eebc6-7ffd.html
  276. swfobject.embedSWF(
  277. WEB_SOCKET_SWF_LOCATION,
  278. "webSocketFlash",
  279. "1" /* width */,
  280. "1" /* height */,
  281. "10.0.0" /* SWF version */,
  282. null,
  283. null,
  284. {hasPriority: true, swliveconnect : true, allowScriptAccess: "always"},
  285. null,
  286. function(e) {
  287. if (!e.success) {
  288. logger.error("[WebSocket] swfobject.embedSWF failed");
  289. }
  290. }
  291. );
  292. };
  293. /**
  294. * Called by Flash to notify JS that it's fully loaded and ready
  295. * for communication.
  296. */
  297. WebSocket.__onFlashInitialized = function() {
  298. // We need to set a timeout here to avoid round-trip calls
  299. // to flash during the initialization process.
  300. setTimeout(function() {
  301. WebSocket.__flash = document.getElementById("webSocketFlash");
  302. WebSocket.__flash.setCallerUrl(location.href);
  303. WebSocket.__flash.setDebug(!!window.WEB_SOCKET_DEBUG);
  304. for (var i = 0; i < WebSocket.__tasks.length; ++i) {
  305. WebSocket.__tasks[i]();
  306. }
  307. WebSocket.__tasks = [];
  308. }, 0);
  309. };
  310. /**
  311. * Called by Flash to notify WebSockets events are fired.
  312. */
  313. WebSocket.__onFlashEvent = function() {
  314. setTimeout(function() {
  315. try {
  316. // Gets events using receiveEvents() instead of getting it from event object
  317. // of Flash event. This is to make sure to keep message order.
  318. // It seems sometimes Flash events don't arrive in the same order as they are sent.
  319. var events = WebSocket.__flash.receiveEvents();
  320. for (var i = 0; i < events.length; ++i) {
  321. WebSocket.__instances[events[i].webSocketId].__handleEvent(events[i]);
  322. }
  323. } catch (e) {
  324. logger.error(e);
  325. }
  326. }, 0);
  327. return true;
  328. };
  329. // Called by Flash.
  330. WebSocket.__log = function(message) {
  331. logger.log(decodeURIComponent(message));
  332. };
  333. // Called by Flash.
  334. WebSocket.__error = function(message) {
  335. logger.error(decodeURIComponent(message));
  336. };
  337. WebSocket.__addTask = function(task) {
  338. if (WebSocket.__flash) {
  339. task();
  340. } else {
  341. WebSocket.__tasks.push(task);
  342. }
  343. };
  344. /**
  345. * Test if the browser is running flash lite.
  346. * @return {boolean} True if flash lite is running, false otherwise.
  347. */
  348. WebSocket.__isFlashLite = function() {
  349. if (!window.navigator || !window.navigator.mimeTypes) {
  350. return false;
  351. }
  352. var mimeType = window.navigator.mimeTypes["application/x-shockwave-flash"];
  353. if (!mimeType || !mimeType.enabledPlugin || !mimeType.enabledPlugin.filename) {
  354. return false;
  355. }
  356. return mimeType.enabledPlugin.filename.match(/flashlite/i) ? true : false;
  357. };
  358. if (!window.WEB_SOCKET_DISABLE_AUTO_INITIALIZATION) {
  359. // NOTE:
  360. // This fires immediately if web_socket.js is dynamically loaded after
  361. // the document is loaded.
  362. swfobject.addDomLoadEvent(function() {
  363. WebSocket.__initialize();
  364. });
  365. }
  366. })();