bfg-common 1.0.0

package/public/spice-console/process/displayprocess.js

@@ -0,0 +1,210 @@
+/*
+    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.DisplayProcess = $.spcExtend(wdi.EventObject.prototype, {
+	runQ: null,
+	packetFilter: null,
+	
+	init: function(c) {
+		this.runQ = c.runQ || wdi.ExecutionControl.runQ;
+		this.packetFilter = c.packetFilter || wdi.PacketFilter;
+		this.clientGui = c.clientGui;
+		this.displayRouter = c.displayRouter || new wdi.DisplayRouter({clientGui:this.clientGui});
+		this.started = false;
+		this.waitingMessages = [];
+		this.packetWorkerIdentifier = c.packetWorkerIdentifier || new wdi.PacketWorkerIdentifier();
+		this.disableMessageBuffering = c.disableMessageBuffering;
+	},
+
+	dispose: function () {
+		wdi.Debug.log("Disposing DisplayProcess");
+		clearInterval(this.timer);
+		this.timer = null;
+		this.runQ = null;
+		this.packetFilter.dispose();
+		this.packetFilter = null;
+		this.clientGui = null;
+		this.displayRouter.dispose();
+		this.displayRouter = null;
+		this.packetWorkerIdentifier.dispose();
+		this.packetWorkerIdentifier = null;
+		this.started = false;
+		this.waitingMessages = [];
+	},
+
+	process: function(spiceMessage) {
+		//if message buffering is disabled, skip queuing and looking for duplicates, just process the message ASAP
+		if(this.disableMessageBuffering) {
+			this._process(spiceMessage);
+			return;
+		}
+
+		var self = this;
+		this.waitingMessages.push(spiceMessage);
+
+		if(!this.started) {
+			this.timer = setInterval(function() {
+				self.flush();
+			}, 50);
+			this.started = true;
+		}
+
+	},
+
+	flush: function() {
+		if(this.waitingMessages.length === 0) {
+			return;
+		}
+
+		var i = 0;
+		var spiceMessage;
+
+		//remove redundant draws
+		this.removeRedundantDraws();
+
+		var size = this.waitingMessages.length;
+
+		while(i < size) {
+			spiceMessage = this.waitingMessages[i];
+			this._process(spiceMessage);
+			i++;
+		}
+
+		this.waitingMessages = [];
+	},
+
+	removeRedundantDraws: function() {
+		if(this.waitingMessages.length < 2) {
+			return;
+		}
+
+		var size = this.waitingMessages.length;
+		var message, body, imageProperties, rop, base;
+		var collision_boxes = {};
+		var to_delete = [];
+		var deleted = false;
+		var surface_id;
+		var packetBox;
+		var box;
+		var i;
+		var x;
+		while(size--) {
+			message = this.waitingMessages[size];
+			//should remove any packet from the past overwritten by this one
+			body = message.args;
+			base = body.base;
+
+			rop = body.rop_descriptor;
+			deleted = false;
+
+			//TODO TODO TODO: there is need for a special case for draw_copy_bits?!
+			//we need base to have a box
+			if(base) {
+				surface_id = base.surface_id;
+				packetBox = base.box;
+				surface_id = base.surface_id;
+				//check if this packet is occluded by another packet
+				imageProperties = this.packetWorkerIdentifier.getImageProperties(message);
+				//if there is no image properties, or there is but cache flags are 0
+				if(!collision_boxes[surface_id]) {
+					collision_boxes[surface_id] = [];
+				}
+
+				if((!imageProperties || (imageProperties && !(imageProperties.descriptor.flags & wdi.SpiceImageFlags.SPICE_IMAGE_FLAGS_CACHE_ME))) && surface_id === 0) {
+					for(i=0; i<collision_boxes[surface_id].length; i++) {
+						//check if base.box is inside one of the rectangles in collision_boxes
+						box = collision_boxes[surface_id][i];
+						if(box.bottom >= packetBox.bottom && box.top <= packetBox.top  && box.left <= packetBox.left
+							&& box.right >= packetBox.right ) {
+
+							deleted = true;
+							to_delete.push(size);
+
+							break;
+						}
+					}
+				}
+
+				//check if the message is still alive, and if it is, then put its box into collision_boxes if the message
+				//will overWrite its screen area when painted
+				//atm only drawcopy and drawfill have overwritescreenarea set
+				if(!deleted && message.messageType === wdi.SpiceVars.SPICE_MSG_DISPLAY_COPY_BITS) {
+					break;
+				}
+
+				if(!deleted && body.getMessageProperty('overWriteScreenArea', false) && base.clip.type == 0 && rop == wdi.SpiceRopd.SPICE_ROPD_OP_PUT) {
+					collision_boxes[surface_id].push(base.box);
+				}
+			}
+		}
+
+		//itareate over messages marked for deletion and remove it from the array
+		for(x = 0;x < to_delete.length;x++) {
+			this.waitingMessages.splice(to_delete[x], 1);
+		}
+	},
+		
+	_process: function(spiceMessage) {
+		if (wdi.logOperations) {
+			wdi.DataLogger.log(spiceMessage, 0, null, true, '', '_decode');
+		}
+		//append the message to the runqueue
+		//so the packet is not executed until the previous packets
+		//finished processing
+		this.runQ.add(function(proxy) {
+
+			//pass the message through the packet filter
+			//so the packet can be filtered, logged, etc
+			this.packetFilter.filter(spiceMessage, function(message) {
+				wdi.ExecutionControl.currentProxy = proxy;
+				//process the packet
+				this.displayRouter.processPacket(message);
+				//post process operations
+				this.postProcess();
+			}, this, this.clientGui);
+
+
+			//if the packet was synchronous, process next packet
+			if (wdi.ExecutionControl.sync) {
+				proxy.end();
+			}
+			//Now message could be asynchronous
+		}, this, function() {
+		   //this is executed when the message has finished processing
+		   //we use processEnd to notify packetFilter about the ending of processing
+		   //the current message
+		   this.processEnd(spiceMessage, this.clientGui);
+
+		});
+
+		//if this is the first message in the queue, execute it
+		//if not, this call will have no effect.
+		this.runQ.process();
+
+	},
+
+	processEnd: function(spiceMessage, clientGui) {
+		this.packetFilter.notifyEnd(spiceMessage, clientGui);
+	},
+
+	postProcess: function() {
+		//TEST METHOD DON'T DELETE
+	}
+});
+

package/public/spice-console/process/inputprocess.js

@@ -0,0 +1,204 @@
+/*
+    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.InputProcess = $.spcExtend(wdi.EventObject.prototype, {
+  clientGui: null,
+  spiceConnection: null,
+  capsLockPressed: false,
+  numLockPressed: false,
+  shiftPressed: false,
+
+  init: function (c) {
+    this.superInit()
+    this.clientGui = c.clientGui
+    this.spiceConnection = c.spiceConnection
+  },
+
+  dispose: function () {
+    this.clearEvents()
+    this.clientGui = null
+    this.spiceConnection = null
+  },
+
+  process: function (spiceMessage) {
+    switch (spiceMessage.messageType) {
+      case wdi.SpiceVars.SPICE_MSG_INPUTS_MOUSE_MOTION_ACK:
+        this.clientGui.motion_ack()
+        break
+    }
+  },
+
+  send: function (data, type) {
+    var packet, scanCodes, i
+
+    if (type == 'mousemove') {
+      packet = new wdi.SpiceMessage({
+        messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_MOUSE_POSITION,
+        channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+        args: new wdi.RedcMousePosition({
+          x: data[1][0] + wdi.VirtualMouse.hotspot.x,
+          y: data[1][1] + wdi.VirtualMouse.hotspot.y,
+          buttons_state: data[1][2],
+          display_id: 0,
+        }),
+      })
+      this.spiceConnection.send(packet)
+    } else if (type == 'mousedown') {
+      packet = new wdi.SpiceMessage({
+        messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_MOUSE_PRESS,
+        channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+        args: new wdi.RedcMousePress({
+          button_id: data[1] + 1,
+          buttons_state: 1 << data[1],
+        }),
+      })
+      this.spiceConnection.send(packet)
+    } else if (type == 'mouseup') {
+      packet = new wdi.SpiceMessage({
+        messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_MOUSE_RELEASE,
+        channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+        args: new wdi.RedcMousePress({
+          button_id: data[1] + 1,
+          buttons_state: 0,
+        }),
+      })
+      this.spiceConnection.send(packet)
+    } else if (type == 'keydown' || type == 'keypress') {
+		scanCodes = wdi.Keymap.getScanCodes(data[1][0])
+
+		const originalEvent = data[1][0].originalEvent
+
+		if (
+			type == 'keydown' &&
+			data[1][0].keyCode !== 20 &&
+			((!wdi.Keymap.isVirtualKeyboard &&
+					originalEvent &&
+					originalEvent.getModifierState &&
+					wdi.Keymap.capsLock !== originalEvent.getModifierState('CapsLock')) ||
+				(wdi.Keymap.isVirtualKeyboard &&
+					wdi.Keymap.isVirtualCapsLockOn !== wdi.Keymap.capsLock))
+		) {
+			const capsLockPacket = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_DOWN,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode([58, 0, 0]),
+			})
+			this.capsLockPressed = true
+			this.spiceConnection.send(capsLockPacket)
+		}
+
+		if (
+			type == 'keydown' &&
+			originalEvent &&
+			originalEvent.getModifierState &&
+			data[1][0].keyCode !== 144 &&
+			wdi.Keymap.numLock !== originalEvent.getModifierState('NumLock')
+		) {
+			const numLockPacket = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_DOWN,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode([69, 0, 0]),
+			})
+			this.numLockPressed = true
+			this.spiceConnection.send(numLockPacket)
+		}
+
+		console.log(1)
+		for (i = 0; i < scanCodes.length; i++) {
+			packet = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_DOWN,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode(scanCodes[i]),
+			})
+
+			if (scanCodes[0] && scanCodes[0][0] === 42) {
+				this.shiftPressed = true
+			}
+			this.spiceConnection.send(packet)
+		}
+	} else if (type == 'keyup') {
+		scanCodes = wdi.Keymap.getScanCodes(data[1][0])
+
+		if (
+			scanCodes &&
+			scanCodes[0] &&
+			scanCodes[0][0] === 199 &&
+			scanCodes[0][1] === 0 &&
+			scanCodes[0][2] === 0
+		) {
+			scanCodes = [[224, 199, 0, 0]]
+		}
+
+		if (this.capsLockPressed) {
+			const capsLockPacket = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_UP,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode([186, 0, 0]),
+			})
+			this.spiceConnection.send(capsLockPacket)
+			this.capsLockPressed = false
+		}
+
+		if (this.numLockPressed) {
+			const numLockPacket = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_UP,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode([197, 0, 0]),
+			})
+			this.spiceConnection.send(numLockPacket)
+			this.numLockPressed = false
+		}
+
+		if (scanCodes[0] && scanCodes[0][0] === 142) {
+			this.shiftPressed = false
+		}
+		console.log(3)
+		for (i = 0; i < scanCodes.length; i++) {
+			packet = new wdi.SpiceMessage({
+				messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_KEY_UP,
+				channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+				args: new wdi.SpiceScanCode(scanCodes[i]),
+			})
+
+			this.spiceConnection.send(packet)
+		}
+		this.clientGui.inputManager.input.val('_')
+	} else if (type == 'joystick') {
+      packet = new wdi.SpiceMessage({
+        messageType: wdi.SpiceVars.SPICE_MSGC_INPUTS_MOUSE_MOTION,
+        channel: wdi.SpiceVars.SPICE_CHANNEL_INPUTS,
+        args: new wdi.RedcMouseMotion({
+          x: data[1][0],
+          y: data[1][1],
+          buttons_state: 0,
+        }),
+      })
+      this.spiceConnection.send(packet)
+    }
+  },
+
+  isKeyboardShortcut: function (type, event) {
+    if (type === 'keydown') {
+      var keycode = event['keyCode']
+      wdi.Keymap.controlPressed(keycode, type, event)
+      var ctrlShortcut = wdi.Keymap.handledByCtrlKeyCode(type, keycode, true)
+      return ctrlShortcut
+    }
+  },
+})

package/public/spice-console/process/mainprocess.js

@@ -0,0 +1,78 @@
+/*
+    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.MainProcess = $.spcExtend(wdi.EventObject.prototype, {
+	init: function(c) {
+		this.superInit();
+		this.app = c.app;
+		this.spiceConnection = c.app.spiceConnection;
+		this.agent = c.app.agent;
+	},
+
+	dispose: function() {
+		this.clearEvents();
+		this.app = null;
+		this.spiceConnection = null;
+		this.agent = null;
+	},
+	
+	process: function(spiceMessage) {
+		var channel = this.spiceConnection.channels[wdi.SpiceVars.SPICE_CHANNEL_MAIN];
+
+		switch(spiceMessage.messageType) {
+			case wdi.SpiceVars.SPICE_MSG_MAIN_INIT:
+				channel.connectionId = spiceMessage.args.session_id;
+				channel.fire('connectionId', channel.connectionId);
+				if(spiceMessage.args.agent_connected == 1) {
+					channel.fire('initAgent', spiceMessage.args.agent_tokens);
+				}
+				if (spiceMessage.args.current_mouse_mode == 1) {
+					channel.fire('mouseMode', spiceMessage.args.current_mouse_mode);
+				}
+				// the mouse mode must be change both if we have agent or not
+				this.changeMouseMode();
+				break;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_AGENT_DATA:
+				var packet = spiceMessage.args;
+				this.agent.onAgentData(packet);
+			   	break;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_AGENT_CONNECTED:
+				channel.fire('initAgent', spiceMessage.args.agent_tokens);
+				this.changeMouseMode();
+				break;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_MULTI_MEDIA_TIME:
+				this.app.multimediaTime = spiceMessage.args.multimedia_time;
+				break;
+			case wdi.SpiceVars.SPICE_MSG_MAIN_CHANNELS_LIST:
+				channel.fire('channelListAvailable', spiceMessage.args.channels);
+				break;
+		}
+	},
+
+	changeMouseMode: function() {
+		var packet = new wdi.SpiceMessage({
+			messageType: wdi.SpiceVars.SPICE_MSGC_MAIN_MOUSE_MODE_REQUEST,
+			channel: wdi.SpiceVars.SPICE_CHANNEL_MAIN,
+			args: new wdi.SpiceMouseModeRequest({
+				request_mode: 2
+			})
+		});
+		this.spiceConnection.send(packet);
+	}
+});