|
|
/**
|
|
* Module requirements.
|
|
*/
|
|
|
|
var Transport = require('../transport')
|
|
, parser = require('engine.io-parser')
|
|
, debug = require('debug')('engine:polling');
|
|
|
|
/**
|
|
* Exports the constructor.
|
|
*/
|
|
|
|
module.exports = Polling;
|
|
|
|
/**
|
|
* HTTP polling constructor.
|
|
*
|
|
* @api public.
|
|
*/
|
|
|
|
function Polling (req) {
|
|
Transport.call(this, req);
|
|
}
|
|
|
|
/**
|
|
* Inherits from Transport.
|
|
*
|
|
* @api public.
|
|
*/
|
|
|
|
Polling.prototype.__proto__ = Transport.prototype;
|
|
|
|
/**
|
|
* Transport name
|
|
*
|
|
* @api public
|
|
*/
|
|
|
|
Polling.prototype.name = 'polling';
|
|
|
|
/**
|
|
* Overrides onRequest.
|
|
*
|
|
* @param {http.ServerRequest}
|
|
* @api private
|
|
*/
|
|
|
|
Polling.prototype.onRequest = function (req) {
|
|
var 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
|
|
*/
|
|
|
|
Polling.prototype.onPollRequest = function (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);
|
|
return;
|
|
}
|
|
|
|
debug('setting request');
|
|
|
|
this.req = req;
|
|
this.res = res;
|
|
|
|
var 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
|
|
*/
|
|
|
|
Polling.prototype.onDataRequest = function (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);
|
|
return;
|
|
}
|
|
|
|
var isBinary = 'application/octet-stream' == req.headers['content-type'];
|
|
|
|
this.dataReq = req;
|
|
this.dataRes = res;
|
|
|
|
var chunks = isBinary ? new Buffer(0) : '';
|
|
var self = this;
|
|
|
|
function cleanup () {
|
|
chunks = isBinary ? new Buffer(0) : '';
|
|
req.removeListener('data', onData);
|
|
req.removeListener('end', onEnd);
|
|
req.removeListener('close', onClose);
|
|
self.dataReq = self.dataRes = null;
|
|
}
|
|
|
|
function onClose () {
|
|
cleanup();
|
|
self.onError('data request connection closed prematurely');
|
|
}
|
|
|
|
function onData (data) {
|
|
var contentLength;
|
|
if (typeof data == 'string') {
|
|
chunks += data;
|
|
contentLength = Buffer.byteLength(chunks);
|
|
} else {
|
|
chunks = Buffer.concat([chunks, data]);
|
|
contentLength = chunks.length;
|
|
}
|
|
|
|
if (contentLength > self.maxHttpBufferSize) {
|
|
chunks = '';
|
|
req.connection.destroy();
|
|
}
|
|
}
|
|
|
|
function onEnd () {
|
|
self.onData(chunks);
|
|
|
|
var 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
|
|
};
|
|
|
|
// prevent XSS warnings on IE
|
|
// https://github.com/LearnBoost/socket.io/pull/1333
|
|
var ua = req.headers['user-agent'];
|
|
if (ua && (~ua.indexOf(';MSIE') || ~ua.indexOf('Trident/'))) {
|
|
headers['X-XSS-Protection'] = '0';
|
|
}
|
|
|
|
res.writeHead(200, self.headers(req, headers));
|
|
res.end('ok');
|
|
cleanup();
|
|
}
|
|
|
|
req.abort = cleanup;
|
|
req.on('close', onClose);
|
|
req.on('data', onData);
|
|
req.on('end', onEnd);
|
|
if (!isBinary) req.setEncoding('utf8');
|
|
};
|
|
|
|
/**
|
|
* Processes the incoming data payload.
|
|
*
|
|
* @param {String} encoded payload
|
|
* @api private
|
|
*/
|
|
|
|
Polling.prototype.onData = function (data) {
|
|
debug('received "%s"', data);
|
|
var self = this;
|
|
var callback = function(packet) {
|
|
if ('close' == packet.type) {
|
|
debug('got xhr close packet');
|
|
self.onClose();
|
|
return false;
|
|
}
|
|
|
|
self.onPacket(packet);
|
|
};
|
|
|
|
parser.decodePayload(data, callback);
|
|
};
|
|
|
|
/**
|
|
* Writes a packet payload.
|
|
*
|
|
* @param {Object} packet
|
|
* @api private
|
|
*/
|
|
|
|
Polling.prototype.send = function (packets) {
|
|
if (this.shouldClose) {
|
|
debug('appending close packet to payload');
|
|
packets.push({ type: 'close' });
|
|
this.shouldClose();
|
|
this.shouldClose = null;
|
|
}
|
|
|
|
var self = this;
|
|
parser.encodePayload(packets, this.supportsBinary, function(data) {
|
|
self.write(data);
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Writes data as response to poll request.
|
|
*
|
|
* @param {String} data
|
|
* @api private
|
|
*/
|
|
|
|
Polling.prototype.write = function (data) {
|
|
debug('writing "%s"', data);
|
|
this.doWrite(data);
|
|
this.req.cleanup();
|
|
this.writable = false;
|
|
};
|
|
|
|
/**
|
|
* Closes the transport.
|
|
*
|
|
* @api private
|
|
*/
|
|
|
|
Polling.prototype.doClose = function (fn) {
|
|
debug('closing');
|
|
|
|
if (this.dataReq) {
|
|
// FIXME: should we do this?
|
|
debug('aborting ongoing data request');
|
|
this.dataReq.abort();
|
|
}
|
|
|
|
if (this.writable) {
|
|
debug('transport writable - closing right away');
|
|
this.send([{ type: 'close' }]);
|
|
fn();
|
|
} else {
|
|
debug('transport not writable - buffering orderly close');
|
|
this.shouldClose = fn;
|
|
}
|
|
};
|