const Transport = require("../transport"); const parser = require("engine.io-parser"); const zlib = require("zlib"); const accepts = require("accepts"); const debug = require("debug")("engine:polling"); const compressionMethods = { gzip: zlib.createGzip, deflate: zlib.createDeflate }; class Polling extends Transport { /** * HTTP polling constructor. * * @api public. */ constructor(req) { super(req); this.closeTimeout = 30 * 1000; this.maxHttpBufferSize = null; this.httpCompression = null; } /** * Transport name * * @api public */ get name() { return "polling"; } /** * Overrides onRequest. * * @param {http.IncomingMessage} * @api private */ onRequest(req) { const res = req.res; if ("GET" === req.method) { this.onPollRequest(req, res); } else if ("POST" === req.method) { this.onDataRequest(req, res); } else { res.writeHead(500); res.end(); } } /** * The client sends a request awaiting for us to send data. * * @api private */ onPollRequest(req, res) { if (this.req) { debug("request overlap"); // assert: this.res, '.req and .res should be (un)set together' this.onError("overlap from client"); res.writeHead(500); res.end(); return; } debug("setting request"); this.req = req; this.res = res; const self = this; function onClose() { self.onError("poll connection closed prematurely"); } function cleanup() { req.removeListener("close", onClose); self.req = self.res = null; } req.cleanup = cleanup; req.on("close", onClose); this.writable = true; this.emit("drain"); // if we're still writable but had a pending close, trigger an empty send if (this.writable && this.shouldClose) { debug("triggering empty send to append close packet"); this.send([{ type: "noop" }]); } } /** * The client sends a request with data. * * @api private */ onDataRequest(req, res) { if (this.dataReq) { // assert: this.dataRes, '.dataReq and .dataRes should be (un)set together' this.onError("data request overlap from client"); res.writeHead(500); res.end(); return; } this.dataReq = req; this.dataRes = res; let chunks = ""; const self = this; function cleanup() { req.removeListener("data", onData); req.removeListener("end", onEnd); req.removeListener("close", onClose); self.dataReq = self.dataRes = chunks = null; } function onClose() { cleanup(); self.onError("data request connection closed prematurely"); } function onData(data) { let contentLength; chunks += data; contentLength = Buffer.byteLength(chunks); if (contentLength > self.maxHttpBufferSize) { chunks = ""; req.connection.destroy(); } } function onEnd() { self.onData(chunks); const headers = { // text/html is required instead of text/plain to avoid an // unwanted download dialog on certain user-agents (GH-43) "Content-Type": "text/html", "Content-Length": 2 }; res.writeHead(200, self.headers(req, headers)); res.end("ok"); cleanup(); } req.on("close", onClose); req.setEncoding("utf8"); req.on("data", onData); req.on("end", onEnd); } /** * Processes the incoming data payload. * * @param {String} encoded payload * @api private */ onData(data) { debug('received "%s"', data); const self = this; const callback = function(packet) { if ("close" === packet.type) { debug("got xhr close packet"); self.onClose(); return false; } self.onPacket(packet); }; parser.decodePayload(data).forEach(callback); } /** * Overrides onClose. * * @api private */ onClose() { if (this.writable) { // close pending poll request this.send([{ type: "noop" }]); } super.onClose(); } /** * Writes a packet payload. * * @param {Object} packet * @api private */ send(packets) { this.writable = false; if (this.shouldClose) { debug("appending close packet to payload"); packets.push({ type: "close" }); this.shouldClose(); this.shouldClose = null; } const self = this; parser.encodePayload(packets, data => { const compress = packets.some(function(packet) { return packet.options && packet.options.compress; }); self.write(data, { compress: compress }); }); } /** * Writes data as response to poll request. * * @param {String} data * @param {Object} options * @api private */ write(data, options) { debug('writing "%s"', data); const self = this; this.doWrite(data, options, function() { self.req.cleanup(); }); } /** * Performs the write. * * @api private */ doWrite(data, options, callback) { const self = this; // explicit UTF-8 is required for pages not served under utf const isString = typeof data === "string"; const contentType = isString ? "text/plain; charset=UTF-8" : "application/octet-stream"; const headers = { "Content-Type": contentType }; if (!this.httpCompression || !options.compress) { respond(data); return; } const len = isString ? Buffer.byteLength(data) : data.length; if (len < this.httpCompression.threshold) { respond(data); return; } const encoding = accepts(this.req).encodings(["gzip", "deflate"]); if (!encoding) { respond(data); return; } this.compress(data, encoding, function(err, data) { if (err) { self.res.writeHead(500); self.res.end(); callback(err); return; } headers["Content-Encoding"] = encoding; respond(data); }); function respond(data) { headers["Content-Length"] = "string" === typeof data ? Buffer.byteLength(data) : data.length; self.res.writeHead(200, self.headers(self.req, headers)); self.res.end(data); callback(); } } /** * Compresses data. * * @api private */ compress(data, encoding, callback) { debug("compressing"); const buffers = []; let nread = 0; compressionMethods[encoding](this.httpCompression) .on("error", callback) .on("data", function(chunk) { buffers.push(chunk); nread += chunk.length; }) .on("end", function() { callback(null, Buffer.concat(buffers, nread)); }) .end(data); } /** * Closes the transport. * * @api private */ doClose(fn) { debug("closing"); const self = this; let closeTimeoutTimer; if (this.dataReq) { debug("aborting ongoing data request"); this.dataReq.destroy(); } if (this.writable) { debug("transport writable - closing right away"); this.send([{ type: "close" }]); onClose(); } else if (this.discarded) { debug("transport discarded - closing right away"); onClose(); } else { debug("transport not writable - buffering orderly close"); this.shouldClose = onClose; closeTimeoutTimer = setTimeout(onClose, this.closeTimeout); } function onClose() { clearTimeout(closeTimeoutTimer); fn(); self.onClose(); } } /** * Returns headers for a response. * * @param {http.IncomingMessage} request * @param {Object} extra headers * @api private */ headers(req, headers) { headers = headers || {}; // prevent XSS warnings on IE // https://github.com/LearnBoost/socket.io/pull/1333 const ua = req.headers["user-agent"]; if (ua && (~ua.indexOf(";MSIE") || ~ua.indexOf("Trident/"))) { headers["X-XSS-Protection"] = "0"; } this.emit("headers", headers); return headers; } } module.exports = Polling;