bfg-common 1.0.0

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

@@ -0,0 +1,195 @@
+/*
+    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.BusConnection = $.spcExtend(wdi.EventObject.prototype, {
+	ws: null,
+	subscriptions: [],
+	_busUser: null,
+	_busPass: null,
+	queue: '',
+	binary: false,
+
+	init: function(c) {
+		this.superInit();
+		this.ws = c.websocket || new wdi.WebSocketWrapper();
+		this.clusterNodeChooser = c.clusterNodeChooser || new wdi.ClusterNodeChooser();
+		this.binary = c.binary || false;
+	},
+
+	connect: function(c) {
+		if (!c['useBus']) {
+			wdi.Debug.warn("Not using the bus");
+			return;
+		}
+        this._vdiBusToken = c['vdiBusToken'];
+		if (!c['busHostList']) {
+			wdi.Debug.warn("Deprecated: using old busHost & busPort params");
+			c['busHostList'] = [{
+				host: c['busHost'],
+				port: c['busPort']
+			}];
+		}
+		this.clusterNodeChooser.setNodeList(c['busHostList']);
+		if (Modernizr['websocketsbinary']) {
+			this.binary = true;
+		}
+		this._busUser = c['busUser'];
+		this._busPass = c['busPass'];
+		this._websockifyProtocol = c['protocol'];
+		this._websockifyHost = c['host'];
+		this._websockifyPort = c['port'];
+		this.subscriptions = c['busSubscriptions'];
+
+		this._connectToNextHost();
+	},
+
+	_connectToNextHost: function () {
+		var busData = this.clusterNodeChooser.getAnother();
+
+		// c['protocol'] is the protocol we use to connect to websockify
+		// ie: ws, wss, https, ...
+		var url = wdi.Utils.generateWebSocketUrl(
+			this._websockifyProtocol,
+			this._websockifyHost,
+			this._websockifyPort,
+			busData.host,
+			busData.port,
+			'raw',
+            this._vdiBusToken
+		);
+		var websocketProtocol = 'base64';
+		if (this.binary) {
+			websocketProtocol = 'binary';
+		}
+		this.ws.connect(url, websocketProtocol);
+
+		wdi.Debug.log("BusConnection: using protocol: " + websocketProtocol);
+
+		if (this.binary) {
+			this.ws.setBinaryType('arraybuffer');
+		}
+		this.setListeners();
+	},
+
+	disconnect: function() {
+		this.ws.close();
+		this.queue = '';
+		this.subscriptions = [];
+	},
+
+	setListeners: function() {
+		var self = this;
+		this.ws.onOpen(function(e) {
+			self._send("CONNECT\nlogin:" + self._busUser + "\npasscode:" + self._busPass + "\n\n\x00");
+		});
+
+		this.ws.onMessage(function(e) {
+			var message;
+			var result;
+			if (!self.binary) {
+				message = Base64.decodeStr(e.data);
+			} else {
+				message = String.fromCharCode.apply(null, new Uint8Array(e.data));
+				// Fix accented chars
+				// [ http://stackoverflow.com/questions/5396560/how-do-i-convert-special-utf-8-chars-to-their-iso-8859-1-equivalent-using-javasc ]
+				message = decodeURIComponent(escape(message));
+			}
+			var subChunks = message.split("\0");
+			if (subChunks.length == 1) {
+				// there is no \0 in the full message, add it to the queue
+				self.queue += subChunks[0];
+			} else {
+				// at least one \0, process all but the last subchunk (that has no \0)
+				for (var i = 0; i < subChunks.length - 1; i++) {
+					message = self.queue + subChunks[i];
+					result = self.parseMessage(message);
+					self.fire('busMessage', result);
+					self.queue = '';
+				}
+				// last chunk is now the queue
+				self.queue = subChunks[subChunks.length - 1];
+			}
+		});
+
+		this.ws.onClose(function(e) {
+			wdi.Debug.log('BusConnection CLOSED! connecting again in 1 second');
+			self.fire('error', e);
+		});
+
+		this.ws.onError(function(e) {
+			wdi.Debug.error('BusConnection ERROR:',  e);
+		});
+	},
+
+	parseMessage: function(message) {
+		try {
+			var arr = message.split("\n\n");
+			var header = arr[0].trim();
+			var body = arr[1].replace(/\x00/, '').trim();
+			if (body.length != 0) {
+				// there is content, so convert to object
+				body = JSON.parse(body);
+			} else {
+				body = null;
+			}
+			arr = header.split("\n");
+			var verb = arr.shift();
+			header = "{";
+			var len = arr.length;
+			for (var i = 0;i < len;i++) {
+				var headerName = arr[i].split(':')[0];
+				header += '"' + headerName + '":"' + arr[i].replace(headerName + ':', '') + '"';
+				if (i != len-1) {
+					header += ",";
+				}
+			}
+			header += "}";
+
+			return {'verb':verb, 'header':JSON.parse(header), 'body':body};
+		} catch (e) {
+			wdi.Debug.error("Error parsing Bus Info: ", e);
+			return {"verb":"ERROR"};
+		}
+	},
+
+	setSubscriptions: function() {
+		var len = this.subscriptions.length;
+		for (var i = 0; i < len;i++) {
+			this.subscribe(this.subscriptions[i]);
+		}
+	},
+
+	send: function(message) {
+		var destination = this.subscriptions[0];
+		this._send("SEND\ndestination:" + destination + "\ncontent-type:text/plain\n\n" + JSON.stringify(message) + "\x00");
+	},
+
+	subscribe: function(destination) {
+		//header browser: true for queue's to multiple subscribers
+		this._send("SUBSCRIBE\ndestination:" + destination + "\n\n\x00");
+	},
+
+	_send: function(message) {
+		if (!this.binary) {
+			this.ws.send(Base64.encodeStr(message));
+		} else {
+			this.ws.send(message);
+		}
+	}
+});

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

@@ -0,0 +1,49 @@
+/*
+    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.ClusterNodeChooser = $.spcExtend(wdi.EventObject.prototype, {
+	init: function (c) {
+	},
+
+	setNodeList: function (nodeList) {
+		this._nodeList = this._shuffle(nodeList);
+		this._nodeListLength = this._nodeList.length;
+		this._currentIndex = 0;
+	},
+
+	getAnother: function () {
+		var toReturn = this._nodeList[this._currentIndex++ % this._nodeListLength];
+		return toReturn;
+	},
+
+	// recipe from: http://stackoverflow.com/a/6274398
+	_shuffle: function (list) {
+		var counter = list.length,
+			temp,
+			index;
+		while (counter > 0) {
+			index = Math.floor(Math.random() * counter);
+			counter--;
+			temp = list[counter];
+			list[counter] = list[index];
+			list[index] = temp;
+		}
+		return list;
+	}
+});

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

@@ -0,0 +1,60 @@
+/*
+    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.ConnectionControl = $.spcExtend(wdi.EventObject.prototype, {
+	socket: null,
+	pendingTimeToConnectionLost: null,
+	previousTimeOut: null,
+
+	init: function(c) {
+		this.superInit();
+		this.socket = c.socket || new wdi.Socket();
+	},
+
+	connect: function(c) {
+		var url = wdi.Utils.generateWebSocketUrl(c.protocol, c.host, c.port, null, null,'raw', c.heartbeatToken);
+		this.socket.connect(url);
+		this.pendingTimeToConnectionLost = c.heartbeatTimeout;
+		wdi.Debug.log('ConnectionControl: connected');
+		this.setListeners();
+	},
+
+	disconnect: function() {
+		wdi.Debug.log('Connection Control disconnect');
+		if(this.previousTimeOut){
+			clearTimeout(this.previousTimeOut);
+		}
+		this.socket.disconnect();
+		this.socket = null;
+		this.pendingTimeToConnectionLost = null;
+		this.previousTimeOut = null;
+	},
+
+	setListeners: function() {
+		var self = this;
+		this.socket.setOnMessageCallback(function(e) {
+			wdi.Debug.log('ConectionControl: beat');
+			clearTimeout(self.previousTimeOut);
+			self.previousTimeOut = setTimeout(function() {
+				wdi.Debug.log('ConnectionControl: firing connectionLost event');
+				self.fire('connectionLost', e);
+			}, self.pendingTimeToConnectionLost);
+		});
+	}
+});

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

@@ -0,0 +1,62 @@
+/*
+    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.PacketController = $.spcExtend(wdi.EventObject.prototype, {
+	sizeDefiner: null,
+	packetExtractor: null,
+	
+	init: function(c) {
+		this.superInit();
+		this.sizeDefiner = c.sizeDefiner;
+		this.packetExtractor = c.packetExtractor;
+	},
+
+	dispose: function() {
+		wdi.Debug.log('PacketTroller dispose');
+		this.clearEvents();
+		this.packetExtractor.dispose();
+		this.packetExtractor = null;
+		this.sizeDefiner = null;
+	},
+
+	getNextPacket: function(data) {
+		var self = this;
+		if (wdi.logOperations) {
+			wdi.DataLogger.setNetworkTimeStart();
+		}
+		var size = this.sizeDefiner.getSize(data);
+		this.packetExtractor.getBytes(size, function(bytes) {
+			var status = this.sizeDefiner.getStatus();
+
+			this.execute(new wdi.RawMessage({status: status, data: bytes}));
+
+			self.getNextPacket(bytes);
+
+
+		}, this);
+	},
+
+	execute: function(message) {
+		try {
+			this.fire('chunkComplete', message);
+		} catch (e) {
+			console.error('PacketTroller: ', e);
+		}
+	}
+});

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

@@ -0,0 +1,73 @@
+/*
+    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.PacketExtractor = $.spcExtend(wdi.EventObject.prototype, {
+	socketQ: null,
+	numBytes: null,
+	callback: null,
+	scope: null,
+
+	init: function(c) {
+		this.superInit();
+		this.socketQ = c.socketQ;
+		this.setListener();
+	},
+
+	dispose: function() {
+		this.clearEvents();
+		this.socketQ.disconnect();
+		this.socketQ = null;
+		this.numBytes = null;
+		this.callback = null;
+		this.scope = null;
+	},
+
+	setListener: function() {
+		this.socketQ.addListener('message', function() {
+			if (wdi.logOperations) {
+				wdi.DataLogger.setNetworkTimeStart();
+			}
+			this.getBytes(this.numBytes, this.callback, this.scope);
+		}, this);
+	},
+
+	getBytes: function(numBytes, callback, scope) {
+		var retLength = this.socketQ.rQ.getLength();
+		this.numBytes = numBytes;
+		this.callback = callback;
+		this.scope = scope;
+		
+		if (numBytes !== null && retLength >= numBytes) {
+			var ret;
+			if (numBytes) {
+				ret = this.socketQ.rQ.shift(numBytes);
+			} else {
+				ret = new Uint8Array(0);
+			}
+			this.numBytes = null;
+			this.callback = null;
+			this.scope = null;
+			callback.call(scope, ret);
+		} else {
+			if (wdi.logOperations) {
+				wdi.DataLogger.logNetworkTime();
+			}
+		}
+	}
+});

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

@@ -0,0 +1,64 @@
+/*
+    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.PacketLinkFactory = {
+	extract: function(header, queue) {
+		switch (header.type) {
+			case wdi.SpiceVars.SPICE_MSG_SET_ACK:
+				return new wdi.RedSetAck().demarshall(queue);
+			case wdi.SpiceVars.SPICE_MSG_PING:
+				return new wdi.RedPing().demarshall(queue, header.size);
+			case wdi.SpiceVars.SPICE_MSG_MIGRATE:
+				return new wdi.RedMigrate().demarshall(queue);
+			case wdi.SpiceVars.SPICE_MSG_MIGRATE_DATA:
+				return new wdi.RedMigrateData().demarshall(queue, header.size);
+			case wdi.SpiceVars.SPICE_MSG_WAIT_FOR_CHANNELS:
+				return new wdi.RedWaitForChannels().demarshall(queue);
+			case wdi.SpiceVars.SPICE_MSG_DISCONNECTING:
+				return new wdi.RedDisconnect().demarshall(queue);
+			case wdi.SpiceVars.SPICE_MSG_NOTIFY:
+				var packet = new wdi.RedNotify().demarshall(queue);
+				return packet;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_MOUSE_MODE:
+				return new wdi.SpiceMouseMode().demarshall(queue);
+		}
+	}
+};
+
+wdi.PacketLinkProcess = {
+	process: function(header, packet, channel) {
+		switch(header.type) {
+			case wdi.SpiceVars.SPICE_MSG_SET_ACK:
+				var body = wdi.SpiceObject.numberTo32(packet.generation);
+				channel.setAckWindow(packet.window)
+				channel.sendObject(body, wdi.SpiceVars.SPICE_MSGC_ACK_SYNC);
+				break;
+			case wdi.SpiceVars.SPICE_MSG_PING:
+				var body = new wdi.RedPing({id: packet.id, time: packet.time}).marshall();
+				channel.sendObject(body, wdi.SpiceVars.SPICE_MSGC_PONG);
+				break;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_MOUSE_MODE:
+				channel.fire('mouseMode', packet.current_mode);
+				break;
+			case wdi.SpiceVars.SPICE_MSG_NOTIFY:
+				channel.fire('notify');
+				break;
+		}
+	}
+};

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

@@ -0,0 +1,77 @@
+/*
+    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.PacketReassembler = $.spcExtend(wdi.EventObject.prototype, {
+	packetController: null,
+	currentHeader: null,
+	statusToString: null,
+	sizeDefinerConstant: null,
+
+	init: function(c) {
+		this.superInit();
+		this.packetController = c.packetController;
+		this.sizeDefinerConstant = wdi.SizeDefiner.prototype;
+		this.statusToString = [];
+		this.statusToString[this.sizeDefinerConstant.STATUS_REPLY_BODY] = 'reply';
+		this.statusToString[this.sizeDefinerConstant.STATUS_ERROR_CODE] = 'errorCode';
+		this.statusToString[this.sizeDefinerConstant.STATUS_BODY] = 'spicePacket';
+		this.setListeners();
+
+	},
+
+	dispose: function() {
+		wdi.Debug.log('packetReassembler dispose');
+		this.clearEvents();
+		this.packetController.dispose();
+		this.packetController = null;
+		this.currentHeader = null;
+		this.statusToString = null;
+		this.sizeDefinerConstant = null;
+	},
+
+	start: function () {
+		this.packetController.getNextPacket();
+	},
+
+	setListeners: function() {
+		this.packetController.addListener('chunkComplete', function(e) {
+			var rawMessage = e;
+			var status = rawMessage.status;
+			switch(status) {
+				case this.sizeDefinerConstant.STATUS_HEADER:
+				case this.sizeDefinerConstant.STATUS_REPLY:
+					this.currentHeader = rawMessage;
+					break;
+				case this.sizeDefinerConstant.STATUS_REPLY_BODY:
+				case this.sizeDefinerConstant.STATUS_BODY:
+					var tmpBuff = new Uint8Array(rawMessage.data.length + this.currentHeader.data.length);
+					tmpBuff.set(this.currentHeader.data);
+					tmpBuff.set(rawMessage.data, this.currentHeader.data.length);
+					rawMessage.data = tmpBuff;
+					rawMessage.status = this.statusToString[status];
+					this.fire('packetComplete', rawMessage);
+					break;
+				default:
+					rawMessage.status = this.statusToString[status];
+					this.fire('packetComplete', rawMessage);
+					break;
+			}
+		}, this);
+	}
+});

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

@@ -0,0 +1,39 @@
+/*
+    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.ReassemblerFactory = {
+	getPacketReassembler: function(socketQ) {
+		var pE = this.getPacketExtractor(socketQ);
+		var sD = this.getSizeDefiner();
+		var pC = this.getPacketController(pE, sD);
+		return new wdi.PacketReassembler({packetController: pC});
+	},
+
+	getPacketExtractor: function(socketQ) {
+		return new wdi.PacketExtractor({socketQ: socketQ});
+	},
+
+	getSizeDefiner: function() {
+		return new wdi.SizeDefiner();
+	},
+
+	getPacketController: function(packetExtractor, sizeDefiner) {
+		return new wdi.PacketController({packetExtractor: packetExtractor, sizeDefiner: sizeDefiner});
+	}
+};