Add window sizing option

- Add current VM state to VM list
- Add option for reset button to be enabled in INI file
- Disable Connect button when VM is in a transition state

README.md

@@ -10,7 +10,7 @@ This project's focus is to create a simple VDI client intended for mass deployme
 
 ## Windows Installation
 
-You **MUST** install virt-viewer prior to using PVE VDI client, you may download it from the [official Virtual Machine Manager](https://virt-manager.org/download/) site.
+You **MUST** install virt-viewer prior to using PVE VDI client, you may download it from the [official Virtual Machine Manager](https://virt-manager.org/download) site.
 
 Please visit the [releases](https://github.com/joshpatten/PVE-VDIClient/releases) section to download a prebuilt MSI package
 
@@ -24,7 +24,9 @@ you will need to download the latest 3.10 python release, and run the following
 
 Run the following commands on a Debian/Ubuntu Linux system to install the appropriate prerequisites
 
-    apt install python3-pip virt-viewer
+    apt install python3-pip python3-tk virt-viewer git
+    git clone https://github.com/joshpatten/PVE-VDIClient.git
+    cd ./PVE-VDIClient/
     chmod +x requirements.sh
     ./requirements.sh
     cp vdiclient.py /usr/local/bin

dist/createmsi.py

@@ -304,7 +304,8 @@ class PackageGenerator:
 			})
 
 	def path_to_id(self, pathname):
-			return pathname.replace('\\', '_').replace('/', '_').replace('#', '_').replace('-', '_')																								   
+			return pathname.replace('\\', '_').replace('/', '_').replace('#', '_').replace('-', '_').replace("+", "__")
+	
 	def create_xml(self, nodes, current_dir, parent_xml_node, staging_dir):
 		cur_node = nodes[current_dir]
 		if cur_node.files:
@@ -327,7 +328,7 @@ class PackageGenerator:
 				})
 			self.component_num += 1
 			for f in cur_node.files:
-				file_id = self.path_to_id(os.path.join(current_dir, f)).replace("+", "__")
+				file_id = self.path_to_id(os.path.join(current_dir, f))
 				ET.SubElement(comp_xml_node, 'File', {
 					'Id': file_id,
 					'Name': f,
@@ -335,7 +336,7 @@ class PackageGenerator:
 				})
 
 		for dirname in cur_node.dirs:
-			dir_id = os.path.join(current_dir, dirname).replace('\\', '_').replace('/', '_')
+			dir_id = self.path_to_id(os.path.join(current_dir, dirname))
 			dir_node = ET.SubElement(parent_xml_node, 'Directory', {
 				'Id': dir_id,
 				'Name': dirname,

dist/vdiclient.json

@@ -1,10 +1,11 @@
 {
 	"upgrade_guid" : "46cbad92-353e-4b28-9bee-83950991dad8",
-	"version" : "1.0.7",
+	"version" : "1.2.02",
 	"product_name" : "VDI Client",
 	"manufacturer" : "Josh Patten",
 	"name" : "VDI Client",
 	"name_base" : "vdiclient",
+	"arch": 64,
 	"comments" : "This is the Proxmox VDI client. This client interfaces with Proxmox requires that virt-viewer be installed.",
 	"installdir" : "VDIClient",
 	"installscope" : "perMachine",

requirements.bat

@@ -1,6 +1,6 @@
 @echo off
 pip install pyinstaller
 pip install proxmoxer
-pip install PySimpleGUIQt
+pip install PySimpleGUI
 pip install requests
 pip install pywin32

requirements.sh

@@ -1,6 +1,4 @@
 #!/bin/bash
 pip3 install proxmoxer
-pip3 install PySimpleGUIQt
-# If PySimpleGUIQt fails, VDIClient will fall back to PySimpleGUI
 pip3 install PySimpleGUI
 pip3 install requests

vdiclient.ini.example

@@ -1,7 +1,7 @@
 [General]
 # This is the title that is diplayed to the user
 title = VDI Login
-# This is the PySimpleGui Theme that is used. Run pvevdi.py with flag `--list_themes` for a list of themes
+# This is the PySimpleGui Theme that is used. Run vdiclient.py with flag `--list_themes` for a list of themes
 theme = LightBlue
 # Program Icon
 icon = vdiicon.ico
@@ -13,7 +13,13 @@ kiosk = False
 fullscreen = True
 # Enable displaying SPICE ini file before opening virt-viewer
 inidebug = False
-
+# Select which guest types to display. Acceptable values: both, lxc, qemu
+guest_type = both
+# Show VM option for resetting VM
+#show_reset = True
+# Set Window Dimensions. Only use if window isn't sizing properly
+#window_width = 800
+#window_height = 600
 
 [Authentication]
 # This is the authentication backend that will be used to authenticate
@@ -22,11 +28,11 @@ auth_backend = pve
 auth_totp = false
 # If disabled, TLS certificate will not be checked
 tls_verify = false
-# User name
+# User name (if using token)
 #user = user
 # API Token Name
 #token_name = dvi
-#API Token Value
+# API Token Value
 #token_value = xxx-x-x-x-xxx
 
 [Hosts]

vdiclient.py

@@ -1,15 +1,13 @@
 #!/usr/bin/python3
 import proxmoxer # pip install proxmoxer
-try:
-	import PySimpleGUIQt as sg # pip install PySimpleGUIQt
-	gui = 'QT'
-except ImportError:
-	import PySimpleGUI as sg # pip install PySimpleGUI
-	gui = 'TK'
+import PySimpleGUI as sg # pip install PySimpleGUI
+gui = 'TK'
 import requests
+from datetime import datetime
 from configparser import ConfigParser
 import random
 import sys
+import copy
 import os
 import subprocess
 from time import sleep
@@ -36,26 +34,13 @@ class G:
 	verify_ssl = True
 	icon = None
 	inidebug = False
+	show_reset = False
+	show_hibernate = False
 	addl_params = None
 	theme = 'LightBlue'
-
-def get_dpi():
-	import ctypes
-	import win32api # pip install pywin32
-	shcore = ctypes.windll.shcore
-	monitors = win32api.EnumDisplayMonitors()
-	hresult = shcore.SetProcessDpiAwareness(2)
-	assert hresult == 0
-	dpiX = ctypes.c_uint()
-	dpiY = ctypes.c_uint()
-	for i, monitor in enumerate(monitors):
-		shcore.GetDpiForMonitor(
-			monitor[0].handle,
-			0,
-			ctypes.byref(dpiX),
-			ctypes.byref(dpiY)
-		)
-		return dpiX.value/96
+	guest_type = 'both'
+	width = None
+	height = None
 
 def loadconfig(config_location = None):
 	if config_location:
@@ -113,6 +98,14 @@ def loadconfig(config_location = None):
 			G.fullscreen = config['General'].getboolean('fullscreen')
 		if 'inidebug' in config['General']:
 			G.inidebug = config['General'].getboolean('inidebug')
+		if 'guest_type' in config['General']:
+			G.guest_type = config['General']['guest_type']
+		if 'show_reset' in config['General']:
+			G.show_reset = config['General'].getboolean('show_reset')
+		if 'window_width' in config['General']:
+			G.width = config['General'].getint('window_width')
+		if 'window_height' in config['General']:
+			G.height = config['General'].getint('window_height')
 	if not 'Authentication' in config:
 		win_popup_button(f'Unable to read supplied configuration:\nNo `Authentication` section defined!', 'OK')
 		return False
@@ -148,9 +141,15 @@ def loadconfig(config_location = None):
 	return True
 
 def win_popup(message):
-	layout = [[sg.Text(message)]]
-	window = sg.Window('Message', layout, no_titlebar=True, keep_on_top=True, finalize=True)
+	layout = [
+		[sg.Text(message, key='-TXT-')]
+	]
+	window = sg.Window('Message', layout, return_keyboard_events=True, no_titlebar=True, keep_on_top=True, finalize=True, )
 	window.bring_to_front()
+	_, _ = window.read(timeout=10) # Fixes a black screen bug
+	window['-TXT-'].update(message)
+	sleep(.15)
+	window['-TXT-'].update(message)
 	return window
 	
 def win_popup_button(message, button):
@@ -178,16 +177,39 @@ def setmainlayout():
 	if G.totp:
 		layout.append([sg.Text("OTP Key", size =(12*G.scaling, 1), font=["Helvetica", 12]), sg.InputText(key='-totp-', font=["Helvetica", 12])])
 	if G.kiosk:
-		layout.append([sg.Button("Log In", font=["Helvetica", 14])])
+		layout.append([sg.Button("Log In", font=["Helvetica", 14], bind_return_key=True)])
 	else:
-		layout.append([sg.Button("Log In", font=["Helvetica", 14]), sg.Button("Cancel", font=["Helvetica", 14])])
+		layout.append([sg.Button("Log In", font=["Helvetica", 14], bind_return_key=True), sg.Button("Cancel", font=["Helvetica", 14])])
 	return layout
 
-def getvms():
+def getvms(listonly = False):
 	vms = []
-	for vm in G.proxmox.cluster.resources.get(type='vm'):
-		vms.append(vm)
-	return vms
+	try:
+		nodes = []
+		for node in G.proxmox.cluster.resources.get(type='node'):
+			if node['status'] == 'online':
+				nodes.append(node['node'])
+
+		for vm in G.proxmox.cluster.resources.get(type='vm'):
+			if vm['node'] not in nodes:
+				continue
+			if 'template' in vm and vm['template']:
+				continue
+			if G.guest_type == 'both' or G.guest_type == vm['type']:
+				if listonly:
+					vms.append(
+						{
+							'vmid': vm['vmid'],
+							'name': vm['name'],
+							'node': vm['node']
+						}
+					)
+				else:
+					vms.append(vm)
+		return vms
+	except proxmoxer.core.ResourceException as e:
+		win_popup_button(f"Unable to display list of VMs:\n {e!r}", 'OK')
+		return False
 
 def setvmlayout(vms):
 	layout = []
@@ -199,8 +221,36 @@ def setvmlayout(vms):
 	layoutcolumn = []
 	for vm in vms:
 		if not vm["status"] == "unknown":
+			print(vm)
+			vmkeyname = f'-VM|{vm["vmid"]}-'
 			connkeyname = f'-CONN|{vm["vmid"]}-'
-			layoutcolumn.append([sg.Text(vm['name'], font=["Helvetica", 14]), sg.Button('Connect', font=["Helvetica", 14], key=connkeyname)])
+			resetkeyname = f'-RESET|{vm["vmid"]}-'
+			hiberkeyname = f'-HIBER|{vm["vmid"]}-'
+			state = 'stopped'
+			connbutton = sg.Button('Connect', font=["Helvetica", 14], key=connkeyname)
+			if vm['status'] == 'running':
+				if 'lock' in vm:
+					state = vm['lock']
+					if state in ('suspending', 'suspended'):
+						if state == 'suspended':
+							state = 'starting'
+						connbutton = sg.Button('Connect', font=["Helvetica", 14], key=connkeyname, disabled=True)
+				else:
+					state = vm['status']
+			tmplayout =	[
+				sg.Text(vm['name'], font=["Helvetica", 14], size=(22*G.scaling, 1*G.scaling)),
+				sg.Text(f"State: {state}", font=["Helvetica", 0], size=(22*G.scaling, 1*G.scaling), key=vmkeyname),
+				connbutton
+			]
+			if G.show_reset:
+				tmplayout.append(
+					sg.Button('Reset', font=["Helvetica", 14], key=resetkeyname)
+				)
+			if G.show_hibernate:
+				tmplayout.append(
+					sg.Button('Hibernate', font=["Helvetica", 14], key=hiberkeyname)
+				)
+			layoutcolumn.append(tmplayout)
 			layoutcolumn.append([sg.HorizontalSeparator()])
 	if len(vms) > 5: # We need a scrollbar
 		layout.append([sg.Column(layoutcolumn, scrollable = True, size = [450*G.scaling, None] )])
@@ -222,14 +272,56 @@ def iniwin(inistring):
 	iniwindow.close()
 	return True
 
-def vmaction(vmnode, vmid, vmtype):
+def vmaction(vmnode, vmid, vmtype, action='connect'):
 	status = False
 	if vmtype == 'qemu':
 		vmstatus = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.get('current')
 	else: # Not sure this is even a thing, but here it is...
 		vmstatus = G.proxmox.nodes(vmnode).lxc(str(vmid)).status.get('current')
+	if action == 'reload':
+		stoppop = win_popup(f'Stopping {vmstatus["name"]}...')
+		sleep(.1)
+		try:
+			if vmtype == 'qemu':
+				jobid = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.stop.post(timeout=28)
+			else: # Not sure this is even a thing, but here it is...
+				jobid = G.proxmox.nodes(vmnode).lxc(str(vmid)).status.stop.post(timeout=28)
+		except proxmoxer.core.ResourceException as e:
+			stoppop.close()
+			win_popup_button(f"Unable to stop VM, please provide your system administrator with the following error:\n {e!r}", 'OK')
+			return False
+		running = True
+		i = 0
+		while running and i < 30:
+			try:
+				jobstatus = G.proxmox.nodes(vmnode).tasks(jobid).status.get()
+			except Exception:
+				# We ran into a query issue here, going to skip this round and try again
+				jobstatus = {}
+			if 'exitstatus' in jobstatus:
+				stoppop.close()
+				stoppop = None
+				if jobstatus['exitstatus'] != 'OK':
+					win_popup_button('Unable to stop VM, please contact your system administrator for assistance', 'OK')
+					return False
+				else:
+					running = False
+					status = True
+			sleep(1)
+			i += 1
+		if not status:
+			if stoppop:
+				stoppop.close()
+			return status
+	status = False
+	if vmtype == 'qemu':
+		vmstatus = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.get('current')
+	else: # Not sure this is even a thing, but here it is...
+		vmstatus = G.proxmox.nodes(vmnode).lxc(str(vmid)).status.get('current')
+	sleep(.2)
 	if vmstatus['status'] != 'running':
 		startpop = win_popup(f'Starting {vmstatus["name"]}...')
+		sleep(.1)
 		try:
 			if vmtype == 'qemu':
 				jobid = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.start.post(timeout=28)
@@ -262,10 +354,16 @@ def vmaction(vmnode, vmid, vmtype):
 			if startpop:
 				startpop.close()
 			return status
-	if vmtype == 'qemu':
-		spiceconfig = G.proxmox.nodes(vmnode).qemu(str(vmid)).spiceproxy.post()
-	else: # Not sure this is even a thing, but here it is...
-		spiceconfig = G.proxmox.nodes(vmnode).lxc(str(vmid)).spiceproxy.post()
+	if action == 'reload':
+		return
+	try:
+		if vmtype == 'qemu':
+			spiceconfig = G.proxmox.nodes(vmnode).qemu(str(vmid)).spiceproxy.post()
+		else: # Not sure this is even a thing, but here it is...
+			spiceconfig = G.proxmox.nodes(vmnode).lxc(str(vmid)).spiceproxy.post()
+	except proxmoxer.core.ResourceException as e:
+		win_popup_button(f"Unable to connect to VM {vmid}:\n{e!r}\nIs SPICE display configured for your VM?", 'OK')
+		return False
 	confignode = ConfigParser()
 	confignode['virt-viewer'] = {}
 	for key, value in spiceconfig.items():
@@ -328,7 +426,7 @@ def setcmd():
 			win_popup_button('Installation of virt-viewer missing, please install using `apt install virt-viewer`', 'OK')
 		sys.exit()
 
-def pveauth(username, passwd, totp):
+def pveauth(username, passwd=None, totp=None):
 	random.shuffle(G.hostpool)
 	err = None
 	for hostinfo in G.hostpool:
@@ -361,47 +459,99 @@ def pveauth(username, passwd, totp):
 
 def loginwindow():
 	layout = setmainlayout()
-	if G.icon:
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
-	else:
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk)
-	while True:
-		event, values = window.read()
-		if event == 'Cancel' or event == sg.WIN_CLOSED:
-			window.close()
+	if G.user and G.token_name and G.token_value: # We need to skip the login
+		popwin = win_popup("Please wait, authenticating...")
+		connected, authenticated, error = pveauth(G.user)
+		popwin.close()
+		if not connected:
+			win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
 			return False
+		elif connected and not authenticated:
+			win_popup_button('Invalid username and/or password, please try again!', 'OK')
+			return False
+		elif connected and authenticated:
+			return True
+	else:
+		if G.icon:
+			window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
 		else:
-			if event in ('Log In', '\r', 'special 16777220', 'special 16777221'):
-				popwin = win_popup("Please wait, authenticating...")
-				user = values['-username-']
-				passwd = values['-password-']
-				totp = None
-				if '-totp-' in values:
-					if values['-totp-'] not in (None, ''):
-						totp = values['-totp-']
-				connected, authenticated, error = pveauth(user, passwd, totp)
-				popwin.close()
-				if not connected:
-					win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
-				elif connected and not authenticated:
-					win_popup_button('Invalid username and/or password, please try again!', 'OK')
-				elif connected and authenticated:
-					window.close()
-					return True
-				#break
+			window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk)
+		while True:
+			event, values = window.read()
+			if event == 'Cancel' or event == sg.WIN_CLOSED:
+				window.close()
+				return False
+			else:
+				if event in ('Log In', '\r', 'special 16777220', 'special 16777221'):
+					popwin = win_popup("Please wait, authenticating...")
+					user = values['-username-']
+					passwd = values['-password-']
+					totp = None
+					if '-totp-' in values:
+						if values['-totp-'] not in (None, ''):
+							totp = values['-totp-']
+					connected, authenticated, error = pveauth(user, passwd=passwd, totp=totp)
+					popwin.close()
+					if not connected:
+						win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
+					elif connected and not authenticated:
+						win_popup_button('Invalid username and/or password, please try again!', 'OK')
+					elif connected and authenticated:
+						window.close()
+						return True
+					#break
 
 def showvms():
 	vms = getvms()
+	vmlist = getvms(listonly=True)
+	newvmlist = vmlist.copy()
+	if vms == False:
+		return False
 	if len(vms) < 1:
 		win_popup_button('No desktop instances found, please consult with your system administrator', 'OK')
 		return False
 	layout = setvmlayout(vms)
+
 	if G.icon:
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
+		window = sg.Window(G.title, layout, return_keyboard_events=True, finalize=True, resizable=False, no_titlebar=G.kiosk, size=(G.width, G.height), icon=G.icon)
 	else:
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk)
+		window = sg.Window(G.title, layout, return_keyboard_events=True, finalize=True, resizable=False, size=(G.width, G.height), no_titlebar=G.kiosk)
+	timer = datetime.now()
 	while True:
-		event, values = window.read()
+		if (datetime.now() - timer).total_seconds() > 5:
+			timer = datetime.now()
+			newvmlist = getvms(listonly = True)
+			if vmlist != newvmlist:
+				vmlist = newvmlist.copy()
+				vms = getvms()
+				layout = setvmlayout(vms)
+				window.close()
+				if G.icon:
+					window = sg.Window(G.title, layout, return_keyboard_events=True, finalize=True, resizable=False, no_titlebar=G.kiosk, size=(G.width, G.height), icon=G.icon)
+				else:
+					window = sg.Window(G.title, layout, return_keyboard_events=True,finalize=True, resizable=False, no_titlebar=G.kiosk, size=(G.width, G.height))
+				window.bring_to_front()
+			else: # Refresh existing vm status
+				newvms = getvms()
+				for vm in newvms:
+					vmkeyname = f'-VM|{vm["vmid"]}-'
+					connkeyname = f'-CONN|{vm["vmid"]}-'
+					state = 'stopped'
+					if vm['status'] == 'running':
+						if 'lock' in vm:
+							state = vm['lock']
+							if state in ('suspending', 'suspended'):
+								window[connkeyname].update(disabled=True)
+								if state == 'suspended':
+									state = 'starting'
+						else:
+							state = vm['status']
+							window[connkeyname].update(disabled=False)
+					else:
+						window[connkeyname].update(disabled=False)
+					window[vmkeyname].update(f"State: {state}")
+
+		event, values = window.read(timeout = 1000)
 		if event in ('Logout', None):
 			window.close()
 			return False
@@ -415,16 +565,20 @@ def showvms():
 					vmaction(vm['node'], vmid, vm['type'])
 			if not found:
 				win_popup_button(f'VM {vm["name"]} no longer availble, please contact your system administrator', 'OK')
+		elif event.startswith('-RESET'):
+			eventparams = event.split('|')
+			vmid = eventparams[1][:-1]
+			found = False
+			for vm in vms:
+				if str(vm['vmid']) == vmid:
+					found = True
+					vmaction(vm['node'], vmid, vm['type'], action='reload')
+			if not found:
+				win_popup_button(f'VM {vm["name"]} no longer availble, please contact your system administrator', 'OK')
 	return True
 
 def main():
-	if os.name == 'nt' and gui == 'QT':
-		G.scaling = get_dpi()
-	else:
-		if gui == 'QT':
-			G.scaling = 1.0 #TODO FIXME: Figure out scaling on Linux
-		else:
-			G.scaling = 1 # TKinter requires integers
+	G.scaling = 1 # TKinter requires integers
 	config_location = None
 	if len(sys.argv) > 1:
 		if sys.argv[1] == '--list_themes':
@@ -445,12 +599,18 @@ def main():
 		if not loggedin:
 			loggedin = loginwindow()
 			if not loggedin:
+				if G.user and G.token_name and G.token_value: # This means if we don't exit we'll be in an infinite loop
+					return 1
 				break
 			else:
 				vmstat = showvms()
 				if not vmstat:
 					G.proxmox = None
 					loggedin = False
+					if G.user and G.token_name and G.token_value: # This means if we don't exit we'll be in an infinite loop
+						return 0
 				else:
 					return
-sys.exit(main())
+
+if __name__ == '__main__':
+	sys.exit(main())