bfg-common 1.0.29 → 1.0.31

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

@@ -20,291 +20,350 @@
 //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_MJPEG,
-	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);
+  counter: 0,
+  ackWindow: 0,
+  connectionId: 0,
+  socketQ: null,
+  packetReassembler: null,
+  channel: 1,
+  codec: wdi.SpiceVideoCodecType.SPICE_VIDEO_CODEC_TYPE_MJPEG,
+  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)
+  // },
+
+  fireHandshakeTimeoutError: function () {
+    var err = new Error('Handshake timeout')
+    err.code = 4200
+    wdi.Debug.error('Handshake timeout reached, raising error')
+    this.fire('error', err)
+  },
+
+  // 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')
+        } else {
+			self.fireHandshakeTimeoutError()
 		}
-	},
-
-	// 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});
-		}
-	}
-});
+      },
+      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,
+      })
+    }
+  },
+})