405 lines
10 KiB
JavaScript
405 lines
10 KiB
JavaScript
/*!
|
|
* ws: a node.js websocket client
|
|
* Copyright(c) 2011 Einar Otto Stangvik <einaros@gmail.com>
|
|
* MIT Licensed
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const safeBuffer = require('safe-buffer');
|
|
const crypto = require('crypto');
|
|
|
|
const PerMessageDeflate = require('./PerMessageDeflate');
|
|
const bufferUtil = require('./BufferUtil');
|
|
const ErrorCodes = require('./ErrorCodes');
|
|
|
|
const Buffer = safeBuffer.Buffer;
|
|
|
|
/**
|
|
* HyBi Sender implementation.
|
|
*/
|
|
class Sender {
|
|
/**
|
|
* Creates a Sender instance.
|
|
*
|
|
* @param {net.Socket} socket The connection socket
|
|
* @param {Object} extensions An object containing the negotiated extensions
|
|
*/
|
|
constructor (socket, extensions) {
|
|
this.perMessageDeflate = (extensions || {})[PerMessageDeflate.extensionName];
|
|
this._socket = socket;
|
|
|
|
this.firstFragment = true;
|
|
this.compress = false;
|
|
|
|
this.bufferedBytes = 0;
|
|
this.deflating = false;
|
|
this.queue = [];
|
|
|
|
this.onerror = null;
|
|
}
|
|
|
|
/**
|
|
* Frames a piece of data according to the HyBi WebSocket protocol.
|
|
*
|
|
* @param {Buffer} data The data to frame
|
|
* @param {Object} options Options object
|
|
* @param {Number} options.opcode The opcode
|
|
* @param {Boolean} options.readOnly Specifies whether `data` can be modified
|
|
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit
|
|
* @param {Boolean} options.mask Specifies whether or not to mask `data`
|
|
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit
|
|
* @return {Buffer[]} The framed data as a list of `Buffer` instances
|
|
* @public
|
|
*/
|
|
static frame (data, options) {
|
|
const merge = data.length < 1024 || (options.mask && options.readOnly);
|
|
var offset = options.mask ? 6 : 2;
|
|
var payloadLength = data.length;
|
|
|
|
if (data.length >= 65536) {
|
|
offset += 8;
|
|
payloadLength = 127;
|
|
} else if (data.length > 125) {
|
|
offset += 2;
|
|
payloadLength = 126;
|
|
}
|
|
|
|
const target = Buffer.allocUnsafe(merge ? data.length + offset : offset);
|
|
|
|
target[0] = options.fin ? options.opcode | 0x80 : options.opcode;
|
|
if (options.rsv1) target[0] |= 0x40;
|
|
|
|
if (payloadLength === 126) {
|
|
target.writeUInt16BE(data.length, 2, true);
|
|
} else if (payloadLength === 127) {
|
|
target.writeUInt32BE(0, 2, true);
|
|
target.writeUInt32BE(data.length, 6, true);
|
|
}
|
|
|
|
if (!options.mask) {
|
|
target[1] = payloadLength;
|
|
if (merge) {
|
|
data.copy(target, offset);
|
|
return [target];
|
|
}
|
|
|
|
return [target, data];
|
|
}
|
|
|
|
const mask = crypto.randomBytes(4);
|
|
|
|
target[1] = payloadLength | 0x80;
|
|
target[offset - 4] = mask[0];
|
|
target[offset - 3] = mask[1];
|
|
target[offset - 2] = mask[2];
|
|
target[offset - 1] = mask[3];
|
|
|
|
if (merge) {
|
|
bufferUtil.mask(data, mask, target, offset, data.length);
|
|
return [target];
|
|
}
|
|
|
|
bufferUtil.mask(data, mask, data, 0, data.length);
|
|
return [target, data];
|
|
}
|
|
|
|
/**
|
|
* Sends a close message to the other peer.
|
|
*
|
|
* @param {(Number|undefined)} code The status code component of the body
|
|
* @param {String} data The message component of the body
|
|
* @param {Boolean} mask Specifies whether or not to mask the message
|
|
* @param {Function} cb Callback
|
|
* @public
|
|
*/
|
|
close (code, data, mask, cb) {
|
|
if (code !== undefined && (typeof code !== 'number' || !ErrorCodes.isValidErrorCode(code))) {
|
|
throw new Error('first argument must be a valid error code number');
|
|
}
|
|
|
|
const buf = Buffer.allocUnsafe(2 + (data ? Buffer.byteLength(data) : 0));
|
|
|
|
buf.writeUInt16BE(code || 1000, 0, true);
|
|
if (buf.length > 2) buf.write(data, 2);
|
|
|
|
if (this.deflating) {
|
|
this.enqueue([this.doClose, buf, mask, cb]);
|
|
} else {
|
|
this.doClose(buf, mask, cb);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Frames and sends a close message.
|
|
*
|
|
* @param {Buffer} data The message to send
|
|
* @param {Boolean} mask Specifies whether or not to mask `data`
|
|
* @param {Function} cb Callback
|
|
* @private
|
|
*/
|
|
doClose (data, mask, cb) {
|
|
this.sendFrame(Sender.frame(data, {
|
|
readOnly: false,
|
|
opcode: 0x08,
|
|
rsv1: false,
|
|
fin: true,
|
|
mask
|
|
}), cb);
|
|
}
|
|
|
|
/**
|
|
* Sends a ping message to the other peer.
|
|
*
|
|
* @param {*} data The message to send
|
|
* @param {Boolean} mask Specifies whether or not to mask `data`
|
|
* @public
|
|
*/
|
|
ping (data, mask) {
|
|
var readOnly = true;
|
|
|
|
if (!Buffer.isBuffer(data)) {
|
|
if (data instanceof ArrayBuffer) {
|
|
data = Buffer.from(data);
|
|
} else if (ArrayBuffer.isView(data)) {
|
|
data = viewToBuffer(data);
|
|
} else {
|
|
data = Buffer.from(data);
|
|
readOnly = false;
|
|
}
|
|
}
|
|
|
|
if (this.deflating) {
|
|
this.enqueue([this.doPing, data, mask, readOnly]);
|
|
} else {
|
|
this.doPing(data, mask, readOnly);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Frames and sends a ping message.
|
|
*
|
|
* @param {*} data The message to send
|
|
* @param {Boolean} mask Specifies whether or not to mask `data`
|
|
* @param {Boolean} readOnly Specifies whether `data` can be modified
|
|
* @private
|
|
*/
|
|
doPing (data, mask, readOnly) {
|
|
this.sendFrame(Sender.frame(data, {
|
|
opcode: 0x09,
|
|
rsv1: false,
|
|
fin: true,
|
|
readOnly,
|
|
mask
|
|
}));
|
|
}
|
|
|
|
/**
|
|
* Sends a pong message to the other peer.
|
|
*
|
|
* @param {*} data The message to send
|
|
* @param {Boolean} mask Specifies whether or not to mask `data`
|
|
* @public
|
|
*/
|
|
pong (data, mask) {
|
|
var readOnly = true;
|
|
|
|
if (!Buffer.isBuffer(data)) {
|
|
if (data instanceof ArrayBuffer) {
|
|
data = Buffer.from(data);
|
|
} else if (ArrayBuffer.isView(data)) {
|
|
data = viewToBuffer(data);
|
|
} else {
|
|
data = Buffer.from(data);
|
|
readOnly = false;
|
|
}
|
|
}
|
|
|
|
if (this.deflating) {
|
|
this.enqueue([this.doPong, data, mask, readOnly]);
|
|
} else {
|
|
this.doPong(data, mask, readOnly);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Frames and sends a pong message.
|
|
*
|
|
* @param {*} data The message to send
|
|
* @param {Boolean} mask Specifies whether or not to mask `data`
|
|
* @param {Boolean} readOnly Specifies whether `data` can be modified
|
|
* @private
|
|
*/
|
|
doPong (data, mask, readOnly) {
|
|
this.sendFrame(Sender.frame(data, {
|
|
opcode: 0x0a,
|
|
rsv1: false,
|
|
fin: true,
|
|
readOnly,
|
|
mask
|
|
}));
|
|
}
|
|
|
|
/**
|
|
* Sends a data message to the other peer.
|
|
*
|
|
* @param {*} data The message to send
|
|
* @param {Object} options Options object
|
|
* @param {Boolean} options.compress Specifies whether or not to compress `data`
|
|
* @param {Boolean} options.binary Specifies whether `data` is binary or text
|
|
* @param {Boolean} options.fin Specifies whether the fragment is the last one
|
|
* @param {Boolean} options.mask Specifies whether or not to mask `data`
|
|
* @param {Function} cb Callback
|
|
* @public
|
|
*/
|
|
send (data, options, cb) {
|
|
var opcode = options.binary ? 2 : 1;
|
|
var rsv1 = options.compress;
|
|
var readOnly = true;
|
|
|
|
if (!Buffer.isBuffer(data)) {
|
|
if (data instanceof ArrayBuffer) {
|
|
data = Buffer.from(data);
|
|
} else if (ArrayBuffer.isView(data)) {
|
|
data = viewToBuffer(data);
|
|
} else {
|
|
data = Buffer.from(data);
|
|
readOnly = false;
|
|
}
|
|
}
|
|
|
|
if (this.firstFragment) {
|
|
this.firstFragment = false;
|
|
if (rsv1 && this.perMessageDeflate) {
|
|
rsv1 = data.length >= this.perMessageDeflate.threshold;
|
|
}
|
|
this.compress = rsv1;
|
|
} else {
|
|
rsv1 = false;
|
|
opcode = 0;
|
|
}
|
|
|
|
if (options.fin) this.firstFragment = true;
|
|
|
|
if (this.perMessageDeflate) {
|
|
const opts = {
|
|
compress: this.compress,
|
|
mask: options.mask,
|
|
fin: options.fin,
|
|
readOnly,
|
|
opcode,
|
|
rsv1
|
|
};
|
|
|
|
if (this.deflating) {
|
|
this.enqueue([this.dispatch, data, opts, cb]);
|
|
} else {
|
|
this.dispatch(data, opts, cb);
|
|
}
|
|
} else {
|
|
this.sendFrame(Sender.frame(data, {
|
|
mask: options.mask,
|
|
fin: options.fin,
|
|
rsv1: false,
|
|
readOnly,
|
|
opcode
|
|
}), cb);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Dispatches a data message.
|
|
*
|
|
* @param {Buffer} data The message to send
|
|
* @param {Object} options Options object
|
|
* @param {Number} options.opcode The opcode
|
|
* @param {Boolean} options.readOnly Specifies whether `data` can be modified
|
|
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit
|
|
* @param {Boolean} options.compress Specifies whether or not to compress `data`
|
|
* @param {Boolean} options.mask Specifies whether or not to mask `data`
|
|
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit
|
|
* @param {Function} cb Callback
|
|
* @private
|
|
*/
|
|
dispatch (data, options, cb) {
|
|
if (!options.compress) {
|
|
this.sendFrame(Sender.frame(data, options), cb);
|
|
return;
|
|
}
|
|
|
|
this.deflating = true;
|
|
this.perMessageDeflate.compress(data, options.fin, (err, buf) => {
|
|
if (err) {
|
|
if (cb) cb(err);
|
|
else this.onerror(err);
|
|
return;
|
|
}
|
|
|
|
options.readOnly = false;
|
|
this.sendFrame(Sender.frame(buf, options), cb);
|
|
this.deflating = false;
|
|
this.dequeue();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Executes queued send operations.
|
|
*
|
|
* @private
|
|
*/
|
|
dequeue () {
|
|
while (!this.deflating && this.queue.length) {
|
|
const params = this.queue.shift();
|
|
|
|
this.bufferedBytes -= params[1].length;
|
|
params[0].apply(this, params.slice(1));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enqueues a send operation.
|
|
*
|
|
* @param {Array} params Send operation parameters.
|
|
* @private
|
|
*/
|
|
enqueue (params) {
|
|
this.bufferedBytes += params[1].length;
|
|
this.queue.push(params);
|
|
}
|
|
|
|
/**
|
|
* Sends a frame.
|
|
*
|
|
* @param {Buffer[]} list The frame to send
|
|
* @param {Function} cb Callback
|
|
* @private
|
|
*/
|
|
sendFrame (list, cb) {
|
|
if (list.length === 2) {
|
|
this._socket.write(list[0]);
|
|
this._socket.write(list[1], cb);
|
|
} else {
|
|
this._socket.write(list[0], cb);
|
|
}
|
|
}
|
|
}
|
|
|
|
module.exports = Sender;
|
|
|
|
/**
|
|
* Converts an `ArrayBuffer` view into a buffer.
|
|
*
|
|
* @param {(DataView|TypedArray)} view The view to convert
|
|
* @return {Buffer} Converted view
|
|
* @private
|
|
*/
|
|
function viewToBuffer (view) {
|
|
const buf = Buffer.from(view.buffer);
|
|
|
|
if (view.byteLength !== view.buffer.byteLength) {
|
|
return buf.slice(view.byteOffset, view.byteOffset + view.byteLength);
|
|
}
|
|
|
|
return buf;
|
|
}
|