server.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. /**
  2. * Module dependencies.
  3. */
  4. var qs = require('querystring')
  5. , parse = require('url').parse
  6. , readFileSync = require('fs').readFileSync
  7. , crypto = require('crypto')
  8. , base64id = require('base64id')
  9. , transports = require('./transports')
  10. , EventEmitter = require('events').EventEmitter
  11. , Socket = require('./socket')
  12. , WebSocketServer = require('ws').Server
  13. , debug = require('debug')('engine');
  14. /**
  15. * Module exports.
  16. */
  17. module.exports = Server;
  18. /**
  19. * Server constructor.
  20. *
  21. * @param {Object} options
  22. * @api public
  23. */
  24. function Server(opts){
  25. if (!(this instanceof Server)) {
  26. return new Server(opts);
  27. }
  28. this.clients = {};
  29. this.clientsCount = 0;
  30. opts = opts || {};
  31. this.pingTimeout = opts.pingTimeout || 60000;
  32. this.pingInterval = opts.pingInterval || 25000;
  33. this.upgradeTimeout = opts.upgradeTimeout || 10000;
  34. this.maxHttpBufferSize = opts.maxHttpBufferSize || 10E7;
  35. this.transports = opts.transports || Object.keys(transports);
  36. this.allowUpgrades = false !== opts.allowUpgrades;
  37. this.allowRequest = opts.allowRequest;
  38. this.cookie = false !== opts.cookie ? (opts.cookie || 'io') : false;
  39. this.cookiePath = false !== opts.cookiePath ? (opts.cookiePath || false) : false;
  40. this.perMessageDeflate = false !== opts.perMessageDeflate ? (opts.perMessageDeflate || true) : false;
  41. this.httpCompression = false !== opts.httpCompression ? (opts.httpCompression || {}) : false;
  42. var self = this;
  43. // turn off per message deflate for node 0.8
  44. // due to it not supporting DeflateRaw#close
  45. // and thus not working with ws 0.8.x
  46. if (/^v0\.8\./.test(process.version)) {
  47. debug('perMessageDeflate not supported by node 0.8');
  48. this.perMessageDeflate = false;
  49. }
  50. // initialize compression options
  51. ['perMessageDeflate', 'httpCompression'].forEach(function(type) {
  52. var compression = self[type];
  53. if (true === compression) self[type] = compression = {};
  54. if (compression && null == compression.threshold) {
  55. compression.threshold = 1024;
  56. }
  57. });
  58. // initialize websocket server
  59. if (~this.transports.indexOf('websocket')) {
  60. this.ws = new WebSocketServer({
  61. noServer: true,
  62. clientTracking: false,
  63. perMessageDeflate: this.perMessageDeflate
  64. });
  65. }
  66. }
  67. /**
  68. * Protocol errors mappings.
  69. */
  70. Server.errors = {
  71. UNKNOWN_TRANSPORT: 0,
  72. UNKNOWN_SID: 1,
  73. BAD_HANDSHAKE_METHOD: 2,
  74. BAD_REQUEST: 3
  75. };
  76. Server.errorMessages = {
  77. 0: 'Transport unknown',
  78. 1: 'Session ID unknown',
  79. 2: 'Bad handshake method',
  80. 3: 'Bad request'
  81. };
  82. /**
  83. * Inherits from EventEmitter.
  84. */
  85. Server.prototype.__proto__ = EventEmitter.prototype;
  86. /**
  87. * Hash of open clients.
  88. *
  89. * @api public
  90. */
  91. Server.prototype.clients;
  92. /**
  93. * Returns a list of available transports for upgrade given a certain transport.
  94. *
  95. * @return {Array}
  96. * @api public
  97. */
  98. Server.prototype.upgrades = function(transport){
  99. if (!this.allowUpgrades) return [];
  100. return transports[transport].upgradesTo || [];
  101. };
  102. /**
  103. * Verifies a request.
  104. *
  105. * @param {http.ServerRequest}
  106. * @return {Boolean} whether the request is valid
  107. * @api private
  108. */
  109. Server.prototype.verify = function(req, upgrade, fn){
  110. // transport check
  111. var transport = req._query.transport;
  112. if (!~this.transports.indexOf(transport)) {
  113. debug('unknown transport "%s"', transport);
  114. return fn(Server.errors.UNKNOWN_TRANSPORT, false);
  115. }
  116. // sid check
  117. var sid = req._query.sid;
  118. if (sid) {
  119. if (!this.clients.hasOwnProperty(sid))
  120. return fn(Server.errors.UNKNOWN_SID, false);
  121. if (!upgrade && this.clients[sid].transport.name !== transport) {
  122. debug('bad request: unexpected transport without upgrade');
  123. return fn(Server.errors.BAD_REQUEST, false);
  124. }
  125. } else {
  126. // handshake is GET only
  127. if ('GET' != req.method) return fn(Server.errors.BAD_HANDSHAKE_METHOD, false);
  128. if (!this.allowRequest) return fn(null, true);
  129. return this.allowRequest(req, fn);
  130. }
  131. fn(null, true);
  132. };
  133. /**
  134. * Prepares a request by processing the query string.
  135. *
  136. * @api private
  137. */
  138. Server.prototype.prepare = function(req){
  139. // try to leverage pre-existing `req._query` (e.g: from connect)
  140. if (!req._query) {
  141. req._query = ~req.url.indexOf('?') ? qs.parse(parse(req.url).query) : {};
  142. }
  143. };
  144. /**
  145. * Closes all clients.
  146. *
  147. * @api public
  148. */
  149. Server.prototype.close = function(){
  150. debug('closing all open clients');
  151. for (var i in this.clients) {
  152. if (this.clients.hasOwnProperty(i)) {
  153. this.clients[i].close(true);
  154. }
  155. }
  156. return this;
  157. };
  158. /**
  159. * Handles an Engine.IO HTTP request.
  160. *
  161. * @param {http.ServerRequest} request
  162. * @param {http.ServerResponse|http.OutgoingMessage} response
  163. * @api public
  164. */
  165. Server.prototype.handleRequest = function(req, res){
  166. debug('handling "%s" http request "%s"', req.method, req.url);
  167. this.prepare(req);
  168. req.res = res;
  169. var self = this;
  170. this.verify(req, false, function(err, success) {
  171. if (!success) {
  172. sendErrorMessage(req, res, err);
  173. return;
  174. }
  175. if (req._query.sid) {
  176. debug('setting new request for existing client');
  177. self.clients[req._query.sid].transport.onRequest(req);
  178. } else {
  179. self.handshake(req._query.transport, req);
  180. }
  181. });
  182. };
  183. /**
  184. * Sends an Engine.IO Error Message
  185. *
  186. * @param {http.ServerResponse} response
  187. * @param {code} error code
  188. * @api private
  189. */
  190. function sendErrorMessage(req, res, code) {
  191. var headers = { 'Content-Type': 'application/json' };
  192. if (req.headers.origin) {
  193. headers['Access-Control-Allow-Credentials'] = 'true';
  194. headers['Access-Control-Allow-Origin'] = req.headers.origin;
  195. } else {
  196. headers['Access-Control-Allow-Origin'] = '*';
  197. }
  198. res.writeHead(400, headers);
  199. res.end(JSON.stringify({
  200. code: code,
  201. message: Server.errorMessages[code]
  202. }));
  203. }
  204. /**
  205. * generate a socket id.
  206. * Overwrite this method to generate your custom socket id
  207. *
  208. * @param {Object} request object
  209. * @api public
  210. */
  211. Server.prototype.generateId = function(req){
  212. return base64id.generateId();
  213. };
  214. /**
  215. * Handshakes a new client.
  216. *
  217. * @param {String} transport name
  218. * @param {Object} request object
  219. * @api private
  220. */
  221. Server.prototype.handshake = function(transportName, req){
  222. var id = this.generateId(req);
  223. debug('handshaking client "%s"', id);
  224. try {
  225. var transport = new transports[transportName](req);
  226. if ('polling' == transportName) {
  227. transport.maxHttpBufferSize = this.maxHttpBufferSize;
  228. transport.httpCompression = this.httpCompression;
  229. } else if ('websocket' == transportName) {
  230. transport.perMessageDeflate = this.perMessageDeflate;
  231. }
  232. if (req._query && req._query.b64) {
  233. transport.supportsBinary = false;
  234. } else {
  235. transport.supportsBinary = true;
  236. }
  237. }
  238. catch (e) {
  239. sendErrorMessage(req, req.res, Server.errors.BAD_REQUEST);
  240. return;
  241. }
  242. var socket = new Socket(id, this, transport, req);
  243. var self = this;
  244. if (false !== this.cookie) {
  245. transport.on('headers', function(headers){
  246. var cookie = self.cookie + '=' + id;
  247. if(false !== self.cookiePath) {
  248. cookie += '; path=' + self.cookiePath;
  249. }
  250. headers['Set-Cookie'] = cookie;
  251. });
  252. }
  253. transport.onRequest(req);
  254. this.clients[id] = socket;
  255. this.clientsCount++;
  256. socket.once('close', function(){
  257. delete self.clients[id];
  258. self.clientsCount--;
  259. });
  260. this.emit('connection', socket);
  261. };
  262. /**
  263. * Handles an Engine.IO HTTP Upgrade.
  264. *
  265. * @api public
  266. */
  267. Server.prototype.handleUpgrade = function(req, socket, upgradeHead){
  268. this.prepare(req);
  269. var self = this;
  270. this.verify(req, true, function(err, success) {
  271. if (!success) {
  272. socket.end();
  273. return;
  274. }
  275. var head = new Buffer(upgradeHead.length);
  276. upgradeHead.copy(head);
  277. upgradeHead = null;
  278. // delegate to ws
  279. self.ws.handleUpgrade(req, socket, head, function(conn){
  280. self.onWebSocket(req, conn);
  281. });
  282. });
  283. };
  284. /**
  285. * Called upon a ws.io connection.
  286. *
  287. * @param {ws.Socket} websocket
  288. * @api private
  289. */
  290. Server.prototype.onWebSocket = function(req, socket){
  291. socket.on('error', onUpgradeError);
  292. if (!transports[req._query.transport].prototype.handlesUpgrades) {
  293. debug('transport doesnt handle upgraded requests');
  294. socket.close();
  295. return;
  296. }
  297. // get client id
  298. var id = req._query.sid;
  299. // keep a reference to the ws.Socket
  300. req.websocket = socket;
  301. if (id) {
  302. var client = this.clients[id];
  303. if (!client) {
  304. debug('upgrade attempt for closed client');
  305. socket.close();
  306. } else if (client.upgrading) {
  307. debug('transport has already been trying to upgrade');
  308. socket.close();
  309. } else if (client.upgraded) {
  310. debug('transport had already been upgraded');
  311. socket.close();
  312. } else {
  313. debug('upgrading existing transport');
  314. // transport error handling takes over
  315. socket.removeListener('error', onUpgradeError);
  316. var transport = new transports[req._query.transport](req);
  317. if (req._query && req._query.b64) {
  318. transport.supportsBinary = false;
  319. } else {
  320. transport.supportsBinary = true;
  321. }
  322. transport.perMessageDeflate = this.perMessageDeflate;
  323. client.maybeUpgrade(transport);
  324. }
  325. } else {
  326. // transport error handling takes over
  327. socket.removeListener('error', onUpgradeError);
  328. this.handshake(req._query.transport, req);
  329. }
  330. function onUpgradeError(){
  331. debug('websocket error before upgrade');
  332. // socket.close() not needed
  333. }
  334. };
  335. /**
  336. * Captures upgrade requests for a http.Server.
  337. *
  338. * @param {http.Server} server
  339. * @param {Object} options
  340. * @api public
  341. */
  342. Server.prototype.attach = function(server, options){
  343. var self = this;
  344. var options = options || {};
  345. var path = (options.path || '/engine.io').replace(/\/$/, '');
  346. var destroyUpgrade = (options.destroyUpgrade !== undefined) ? options.destroyUpgrade : true;
  347. var destroyUpgradeTimeout = options.destroyUpgradeTimeout || 1000;
  348. // normalize path
  349. path += '/';
  350. function check (req) {
  351. return path == req.url.substr(0, path.length);
  352. }
  353. // cache and clean up listeners
  354. var listeners = server.listeners('request').slice(0);
  355. server.removeAllListeners('request');
  356. server.on('close', self.close.bind(self));
  357. // add request handler
  358. server.on('request', function(req, res){
  359. if (check(req)) {
  360. debug('intercepting request for path "%s"', path);
  361. self.handleRequest(req, res);
  362. } else {
  363. for (var i = 0, l = listeners.length; i < l; i++) {
  364. listeners[i].call(server, req, res);
  365. }
  366. }
  367. });
  368. if(~self.transports.indexOf('websocket')) {
  369. server.on('upgrade', function (req, socket, head) {
  370. if (check(req)) {
  371. self.handleUpgrade(req, socket, head);
  372. } else if (false !== options.destroyUpgrade) {
  373. // default node behavior is to disconnect when no handlers
  374. // but by adding a handler, we prevent that
  375. // and if no eio thing handles the upgrade
  376. // then the socket needs to die!
  377. setTimeout(function() {
  378. if (socket.writable && socket.bytesWritten <= 0) {
  379. return socket.end();
  380. }
  381. }, options.destroyUpgradeTimeout);
  382. }
  383. });
  384. }
  385. };