bfg-common 1.0.0

package/public/spice-console/network/sizedefiner.js

@@ -0,0 +1,86 @@
+/*
+    Copyright (c) 2016 eyeOS
+
+    This file is part of Open365.
+
+    Open365 is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+wdi.SizeDefiner = $.spcExtend(wdi.DomainObject, {
+	ERROR_CODE_SIZE: 4,
+	status: null,
+	STATUS_READY: 0,
+	STATUS_REPLY: 1,
+	STATUS_REPLY_BODY: 2,
+	STATUS_ERROR_CODE: 3,
+	STATUS_MESSAGE: 4,
+	STATUS_HEADER: 5,
+	STATUS_BODY: 6,
+	isHeader: false,
+
+	init: function(c) {
+		this.status = this.STATUS_READY;
+	},
+
+	getSize: function(arr) {
+		if (this.STATUS_READY === this.status) {
+			this.status++;
+			return wdi.SpiceLinkHeader.prototype.objectSize;
+		} else if (this.STATUS_REPLY === this.status) {
+			this.status++;
+			return this.getReplyBodySize(arr);
+		} else if (this.STATUS_REPLY_BODY === this.status) {
+			this.status++;
+			return this.ERROR_CODE_SIZE;
+		} else if (this.STATUS_ERROR_CODE === this.status) {
+			this.status++;
+			this.isHeader = true;
+			return 6; //wdi.SpiceDataHeader.prototype.objectSize access here is slow
+		} else {
+			if (this.isHeader) {
+				this.isHeader = false;
+				return this.getBodySizeFromArrayHeader(arr);
+			} else {
+				this.isHeader = true;
+				return 6;//wdi.SpiceDataHeader.prototype.objectSize; access here is slow
+			}
+		}
+	},
+
+	getReplyBodySize: function (arr) {
+		var queue = wdi.GlobalPool.create('ViewQueue');
+		queue.setData(arr);
+		var header = new wdi.SpiceLinkHeader().demarshall(queue);
+		wdi.GlobalPool.discard('ViewQueue', queue);
+		return header.size;
+	},
+
+	getBodySizeFromArrayHeader: function (arr) {
+		var queue = wdi.GlobalPool.create('ViewQueue');
+		queue.setData(arr);
+		var header = new wdi.SpiceDataHeader().demarshall(queue);
+		wdi.GlobalPool.discard('ViewQueue', queue);
+		return header.size;
+	},
+
+	getStatus: function() {
+		if (this.status === this.STATUS_MESSAGE && this.isHeader) {
+			return this.STATUS_HEADER;
+		} else if (this.status === this.STATUS_MESSAGE && !this.isHeader) {
+			return this.STATUS_BODY;
+		} else {
+			return this.status;
+		}
+	}
+});

package/public/spice-console/network/socket.js

@@ -0,0 +1,120 @@
+/*
+    Copyright (c) 2016 eyeOS
+
+    This file is part of Open365.
+
+    Open365 is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+wdi.socketStatus = {
+	'idle':0,
+	'prepared':1,
+	'connected':2,
+	'disconnected':3,
+	'failed':4
+};
+//Works only with arrays of bytes (this means each value is a number in 0 to 255)
+wdi.Socket = $.spcExtend(wdi.EventObject.prototype, {
+	websocket: null,
+	status: wdi.socketStatus.idle,
+	binary: false,
+	
+	connect: function(uri) {
+		var self = this;
+		var protocol = 'base64'; //default protocol
+		
+		if(Modernizr['websocketsbinary']) {
+			protocol = 'binary';
+			this.binary = true;
+		}
+
+		this.websocket = new WebSocket(uri, protocol);
+
+		wdi.Debug.log("Socket: using protocol: "+protocol);
+		
+		if(this.binary) {
+			this.websocket.binaryType = 'arraybuffer';
+		}
+		
+		this.status = wdi.socketStatus.prepared;
+		this.websocket.onopen = function() {
+			self.status = wdi.socketStatus.connected;
+			self.fire('open');
+		};
+		this.websocket.onmessage = function(e) {
+			self.fire('message', e.data);
+		};
+		this.websocket.onclose = function(e) {
+			self.status = wdi.socketStatus.disconnected;
+			console.warn('Spice Web Client: ', e.code, e.reason);
+			self.disconnect();
+			self.fire('close', e);
+		};
+		this.websocket.onerror = function(e) {
+			self.status = wdi.socketStatus.failed;
+			self.fire('error', e);
+		};
+	},
+
+	setOnMessageCallback: function(callback) {
+		this.websocket.onmessage = callback;
+	},
+	
+	send: function(message) {
+		try {
+			this.websocket.send(this.encode_message(message));
+		} catch (err) {
+			this.status = wdi.socketStatus.failed;
+			this.fire('error', err);
+		}
+	},
+	
+	disconnect: function() {
+		if (this.websocket) {
+			this.websocket.onopen = function() {};
+			this.websocket.onmessage = function() {};
+			this.websocket.onclose = function() {};
+			this.websocket.onerror = function() {};
+			this.websocket.close();
+			this.status = wdi.socketStatus.idle;
+			this.binary = false;
+			this.websocket = null;
+		}
+	},
+	
+	setStatus: function(status) {
+		this.status = status;
+		this.fire('status', status);
+	},
+	
+	getStatus: function() {
+		return this.status;
+	},
+	
+	encode_message: function(mess) {
+		if(!this.binary) {
+			var arr = Base64.encode(mess);
+			return arr;
+		} 
+		
+		var len = mess.length;
+		
+		var buffer = new ArrayBuffer(len);
+		var u8 = new Uint8Array(buffer);
+		
+		u8.set(mess);
+	
+		return u8;
+	}
+});

package/public/spice-console/network/socketqueue.js

@@ -0,0 +1,95 @@
+/*
+    Copyright (c) 2016 eyeOS
+
+    This file is part of Open365.
+
+    Open365 is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+wdi.SocketQueue = $.spcExtend(wdi.EventObject.prototype, {
+	rQ: null,
+	sQ: null,
+	socket: null,
+
+	init: function(c) {
+		this.superInit();
+		this.socket = c.socket || new wdi.Socket();
+		this.rQ = c.rQ || new wdi.FixedQueue();
+		this.sQ = c.sQ || new wdi.Queue();
+		this.setup();
+	},
+
+	setup: function() {
+		this.socket.addListener('open', function() {
+			this.fire('open');
+		}, this);
+		this.socket.addListener('message', function(data) {
+			this.rQ.push(new Uint8Array(data));
+			this.fire('message');
+		}, this);
+		this.socket.addListener('close', function(e) {
+			this.fire('close', e);
+		}, this);
+		this.socket.addListener('error', function(e) {
+			this.fire('error', e);
+		}, this);
+	},
+
+	getStatus: function() {
+		return this.socket.getStatus();
+	},
+
+	connect: function(uri) {
+		this.socket.connect(uri);
+	},
+
+	disconnect: function() {
+		wdi.Debug.log('socket Queue disconnect');
+		if (this.socket) {
+			this.socket.clearEvents();
+			this.socket.disconnect();
+		}
+		this.rQ = null;
+		this.sQ = null;
+		this.socket = null;
+	},
+
+	send: function(data, shouldFlush) {
+		//check for shouldFlush parameter, by default is true
+		if (shouldFlush === undefined) {
+			var flush = true;
+		} else {
+			var flush = shouldFlush;
+		}
+
+		//performance: avoid passing through the queue if there is no queue and
+		//we have flush!
+		if(this.sQ && this.sQ.getLength() === 0 && flush) {
+			this.socket.send(data);
+			return;
+		}
+
+		//normal operation, append to buffer and send if flush
+
+		if (this.sQ) {
+			this.sQ.push(data);
+			if (flush) this.flush();
+		}
+	},
+
+	flush: function() {
+		var data = this.sQ.shift();
+		this.socket.send(data);
+	}
+});

package/public/spice-console/network/spicechannel.js

@@ -0,0 +1,310 @@
+/*
+    Copyright (c) 2016 eyeOS
+
+    This file is part of Open365.
+
+    Open365 is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+//Must fire event types: connectionId and message
+
+wdi.SpiceChannel = $.spcExtend(wdi.EventObject.prototype, {
+	counter: 0,
+	ackWindow: 0,
+	connectionId: 0,
+	socketQ: null,
+	packetReassembler: null,
+	channel: 1,
+	codec: wdi.SpiceVideoCodecType.SPICE_VIDEO_CODEC_TYPE_H264,
+	proxy: null,
+	token: null,
+
+	init: function(c) {
+		this.superInit();
+		this.socketQ = c.socketQ || new wdi.SocketQueue();
+		this.packetReassembler = c.packetReassembler || wdi.ReassemblerFactory.getPacketReassembler(this.socketQ);
+		this.setListeners();
+		this.ackWindow = 0;
+	},
+
+	startHandshakeTimeout: function () {
+		var self = this;
+		this.handshakeTimeout = window.setTimeout(function () {
+			var err = new Error("Handshake timeout");
+			err.code = 4200;
+			wdi.Debug.error("Handshake timeout reached, raising error");
+			self.fire('error', err);
+		}, 5000);
+	},
+
+	cancelHandshakeTimeout: function () {
+		clearTimeout(this.handshakeTimeout);
+	},
+
+	setListeners: function() {
+		var date;
+		var self = this;
+		this.packetReassembler.addListener('packetComplete', function(e) {
+			var rawMessage = e;
+			if (rawMessage.status === 'spicePacket') {
+				wdi.Debug.log('packetComplete spicePacket');
+				self.cancelHandshakeTimeout();
+				if (wdi.logOperations) {
+					wdi.DataLogger.logNetworkTime();
+					date = Date.now();
+				}
+				var rsm = this.getRawSpiceMessage(rawMessage.data);
+				if (rsm) {
+					if (wdi.logOperations && rsm.channel === wdi.SpiceVars.SPICE_CHANNEL_DISPLAY) {
+						wdi.DataLogger.setStartTime(date);
+					}
+					this.fire('message', rsm);
+				}
+			} else if (rawMessage.status === 'reply') {
+				wdi.Debug.log('packetComplete reply');
+				var packet = this.getRedLinkReplyBytes(rawMessage.data);
+				this.send(packet);
+			} else if (rawMessage.status === 'errorCode') {
+				wdi.Debug.log('packetComplete errorCode');
+				var packet = this.getErrorCodeBytes(rawMessage.data);
+				if (packet) {
+					this.send(packet);
+					if (this.channel === wdi.SpiceVars.SPICE_CHANNEL_DISPLAY) {
+						// Custom code
+						// Set codec
+						this.changeCodec(this.codec)
+						// Custom code end
+					}
+				}
+				this.fire('channelConnected');
+			}
+		}, this);
+
+		this.socketQ.addListener('open', function() {
+			var packet = this.getRedLinkMessBytes();
+			this.send(packet);
+			this.proxy ? this.proxy.end() : false;
+		}, this);
+
+		this.socketQ.addListener('close', function(e) {
+			if (this.channel === 1) {
+				this.fire('error', e);
+			}
+			this.socketQ.disconnect();
+		}, this);
+
+		this.socketQ.addListener('error', function(e) {
+			this.fire('error', e);
+			this.socketQ.disconnect();
+		}, this);
+	},
+
+	changeCodec: function (codec) {
+
+		this.sendObject([
+			...wdi.SpiceObject.numberTo16(2),
+			...wdi.SpiceObject.numberTo16(codec),
+			...wdi.SpiceObject.numberTo16(3)
+		], wdi.SpiceVars.SPICE_MSGC_DISPLAY_PREFERRED_VIDEO_CODEC_TYPE)
+
+		wdi.currentCodec = codec
+
+		console.log(`codec changed: ${codec}`);
+	},
+
+	connect: function(connectionInfo, channel, connectionId, proxy) {
+		var url = wdi.Utils.generateWebSocketUrl(connectionInfo.protocol, connectionInfo.host, connectionInfo.port, connectionInfo.vmHost, connectionInfo.vmPort, 'spice', connectionInfo.vmInfoToken, connectionInfo.vmid);
+		this.channel = channel;
+		this.connectionId = connectionId || 0;
+		this.socketQ.connect(url);
+		this.startHandshakeTimeout();
+		this.proxy = proxy;
+		this.token = connectionInfo.token;
+		this.packetReassembler.start();
+	},
+
+	disconnect: function () {
+		wdi.Debug.log('spicechannel disconnect');
+		this.counter = 0;
+		this.ackWindow = 0;
+		this.connectionId = 0;
+		this.socketQ.disconnect();
+		this.socketQ = null;
+		this.packetReassembler.dispose();
+		this.packetReassembler = null;
+		this.channel = 1;
+		this.proxy = null;
+		this.token = null;
+	},
+
+	send: function(data, flush) {
+		this.socketQ.send(data, flush);
+	},
+
+	sendObject: function(data, type, flush) {
+
+		// TODO: Unhardcode this value
+		var bufSize = 2048;
+		for (var current = 0; current < data.length; current += bufSize) {
+			var part = data.slice(current, current + bufSize);
+			var packet = new wdi.SpiceDataHeader({
+				type: type,
+				size: part.length
+			}).marshall();
+
+			packet = packet.concat(part);
+
+			this.send(packet, flush);
+		}
+	},
+
+	// Custom code
+	arrayOfNumberToUint32: function (arrayOfNumber) {
+		let v = 0;
+		for (let n of arrayOfNumber) {
+			v |= 1 << n;
+		}
+		return v
+	},
+	// Custom code end
+
+	setAckWindow: function(window) {
+		this.ackWindow = window;
+		this.counter = 0;
+	},
+
+	getRawSpiceMessage: function (rawData) {
+		var headerQueue = wdi.GlobalPool.create('ViewQueue');
+		var body = wdi.GlobalPool.create('ViewQueue');
+
+		var header = new Uint8Array(rawData, 0, wdi.SpiceDataHeader.prototype.objectSize);
+		headerQueue.setData(header);
+		var headerObj = new wdi.SpiceDataHeader().demarshall(headerQueue);
+		wdi.GlobalPool.discard('ViewQueue', headerQueue);
+		var rawBody = rawData.subarray(wdi.SpiceDataHeader.prototype.objectSize);
+		body.setData(rawBody);
+
+		this.counter++;
+
+		if(this.ackWindow && this.counter === this.ackWindow) {
+			this.counter = 0;
+			var ack = new wdi.SpiceDataHeader({
+				type: wdi.SpiceVars.SPICE_MSGC_ACK,
+				size:0
+			}).marshall();
+			this.send(ack);
+		}
+
+		var packet = wdi.PacketLinkFactory.extract(headerObj, body) || false;
+		if (packet) {
+			wdi.PacketLinkProcess.process(headerObj, packet, this);
+			wdi.GlobalPool.discard('ViewQueue', body);
+			return false;
+		} else {
+			var rawSpiceMessage = wdi.GlobalPool.create('RawSpiceMessage');
+			rawSpiceMessage.set(headerObj, body, this.channel);
+			return rawSpiceMessage;
+		}
+	},
+
+
+	//This functions are to avoid hardcoded values on logic
+	getRedLinkReplyBytes: function(data) {
+		if (this.token) {
+			var newq = new wdi.ViewQueue();
+			newq.setData(data);
+			newq.eatBytes(wdi.SpiceLinkHeader.prototype.objectSize)
+			var myBody = new wdi.SpiceLinkReply().demarshall(newq);
+
+			//Returnnig void bytes or encrypted ticket
+			var key = wdi.SpiceObject.stringHexToBytes(RSA_public_encrypt(this.token, myBody.pub_key));
+			return key;
+		} else {
+			return wdi.SpiceObject.stringToBytesPadding('', 128);
+		}
+	},
+
+	getRedLinkMessBytes: function() {
+		// var header = new wdi.SpiceLinkHeader({magic:1363428690, major_version:2, minor_version:2, size:22}).marshall();
+		// var body = new wdi.SpiceLinkMess({
+		// 	connection_id:this.connectionId,
+		// 	channel_type:this.channel,
+		// 	caps_offset:18,
+		// 	num_common_caps: 1,
+		// 	num_channel_caps: 0,
+		// 	common_caps: (1 << wdi.SpiceVars.SPICE_COMMON_CAP_MINI_HEADER)
+		// }).marshall();
+
+		// Custom code
+		// TODO uncomment this code for send caps
+		var header = new wdi.SpiceLinkHeader({magic:1363428690, major_version:2, minor_version:2, size:26}).marshall();
+		var body = new wdi.SpiceLinkMess({
+			connection_id:this.connectionId,
+			channel_type:this.channel,
+			caps_offset:18,
+			num_common_caps: 1,
+			num_channel_caps: 1,
+			common_caps: (1 << wdi.SpiceVars.SPICE_COMMON_CAP_MINI_HEADER),
+			channel_caps: this.arrayOfNumberToUint32([
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_SIZED_STREAM,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_STREAM_REPORT,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_MONITORS_CONFIG,
+
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_MULTI_CODEC,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_PREF_VIDEO_CODEC_TYPE,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_CODEC_MJPEG,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_CODEC_VP8,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_CODEC_H264,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_CODEC_VP9,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_CODEC_H265,
+
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_LZ4_COMPRESSION,
+				wdi.SpiceDisplayCaps.SPICE_DISPLAY_CAP_PREF_COMPRESSION,
+			])
+		}).marshall();
+		// Custom code end
+
+		return header.concat(body);
+	},
+
+	getErrorCodeBytes: function (data) {
+		var errorQ = wdi.GlobalPool.create('ViewQueue');
+		errorQ.setData(data);
+		var errorCode = wdi.SpiceObject.bytesToInt32NoAllocate(errorQ);
+		wdi.GlobalPool.discard('ViewQueue', errorQ);
+		if (errorCode === 0) {
+			if (this.channel === wdi.SpiceVars.SPICE_CHANNEL_DISPLAY) {
+				var redDisplayInit = new wdi.SpiceDataHeader({type: wdi.SpiceVars.SPICE_MSGC_DISPLAY_INIT, size: 14}).marshall();
+				//TODO: ultrahardcoded value here, move to configuration
+
+				//DUE To high level storage the memory specified for cache
+				//is 2-3 times bigger than expected.
+				var cache_size = 1;
+
+				var body = new wdi.SpiceCDisplayInit({
+					pixmap_cache_id:1,
+					pixmap_cache_size: cache_size,
+					glz_dictionary_id: 0,
+					glz_dictionary_window_size: 0
+				}).marshall();
+
+				return redDisplayInit.concat(body);
+			} else if(this.channel == wdi.SpiceVars.SPICE_CHANNEL_MAIN) {
+				return new wdi.SpiceDataHeader({type: wdi.SpiceVars.SPICE_MSGC_MAIN_ATTACH_CHANNELS, size: 0}).marshall();
+			}
+		} else {
+			throw new wdi.Exception({message: "Server refused client", errorCode: 2});
+		}
+	}
+});

package/public/spice-console/network/websocketwrapper.js

@@ -0,0 +1,75 @@
+/*
+    Copyright (c) 2016 eyeOS
+
+    This file is part of Open365.
+
+    Open365 is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+wdi.WebSocketWrapper = $.spcExtend({}, {
+	ws: {},
+	onopen: null,
+	onmessage: null,
+	onclose: null,
+	onerror: null,
+
+	init: function() {
+
+	},
+
+	connect: function(url, protocol) {
+		this.ws = new WebSocket(url, protocol);
+	},
+
+	onOpen: function(callback) {
+		this.ws.onopen = callback;
+	},
+
+	onMessage: function(callback) {
+		this.ws.onmessage = callback;
+	},
+
+	onClose: function(callback) {
+		this.ws.onclose = callback;
+	},
+
+	onError: function(callback) {
+		this.ws.onerror = callback;
+	},
+
+	setBinaryType: function(type) {
+		this.ws.binaryType = type;
+	},
+
+	close: function() {
+		if (!this.ws || !this.ws.close) {
+			return;
+		}
+
+		this.ws.close();
+		this.ws.onopen = function () {};
+		this.ws.onmessage = function () {};
+		this.ws.onclose = function () {};
+		this.ws.onerror = function () {};
+		this.onopen = function() {};
+		this.onmessage = function() {};
+		this.onclose = function() {};
+		this.onerror = function() {};
+
+	},
+
+	send: function(message) {
+		this.ws.send(message);
+	}
+});