Add HTTP config download option

Update vdiclient.py

README.md

@@ -8,9 +8,31 @@ This project's focus is to create a simple VDI client intended for mass deployme
 
 ![VDI View](screenshots/vdiview.png)
 
+## Command Line Usage
+
+No command line options are required for default behavior. The following command line options are available:
+
+    usage: vdiclient.py [-h] [--list_themes] [--config_type {file,http}] [--config_location CONFIG_LOCATION]
+                        [--config_username CONFIG_USERNAME] [--config_password CONFIG_PASSWORD] [--ignore_ssl]
+    
+    Proxmox VDI Client
+    
+    options:
+      -h, --help            show this help message and exit
+      --list_themes         List all available themes
+      --config_type {file,http}
+                            Select config type (default: file)
+      --config_location CONFIG_LOCATION
+                            Specify the config location (default: search for config file)
+      --config_username CONFIG_USERNAME
+                            HTTP basic authentication username (default: None)
+      --config_password CONFIG_PASSWORD
+                            HTTP basic authentication password (default: None)
+      --ignore_ssl          HTTPS ignore SSL certificate errors (default: False)
+
 ## 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.html) site.
 
 Please visit the [releases](https://github.com/joshpatten/PVE-VDIClient/releases) section to download a prebuilt MSI package
 
@@ -32,6 +54,20 @@ Run the following commands on a Debian/Ubuntu Linux system to install the approp
     cp vdiclient.py /usr/local/bin
     chmod +x /usr/local/bin/vdiclient.py
 
+## Build Debian/Ubuntu Linux Binary
+
+Run the following commands if you wish to build a binary on a Debian/Ubuntu Linux system
+
+    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
+    pip3 install pyinstaller
+    pyinstaller --onefile --noconsole --noconfirm --hidden-import proxmoxer.backends --hidden-import proxmoxer.backends.https --hidden-import proxmoxer.backends.https.AuthenticationError --hidden-import proxmoxer.core --hidden-import proxmoxer.core.ResourceException --hidden-import subprocess.TimeoutExpired --hidden-import subprocess.CalledProcessError --hidden-import requests.exceptions --hidden-import requests.exceptions.ReadTimeout --hidden-import requests.exceptions.ConnectTimeout --hidden-import requests.exceptions.ConnectionError vdiclient.py
+
+Once pyinstaller has finished your binary will be located in dist/vdiclient
+
 ## Configuration File
 
 PVE VDI Client **REQUIRES** a configuration file to function. The client searches for this file in the following locations unless **--config** is specified on the commmand line:

dist/vdiclient.json

@@ -1,6 +1,6 @@
 {
 	"upgrade_guid" : "46cbad92-353e-4b28-9bee-83950991dad8",
-	"version" : "1.1.03",
+	"version" : "1.3.01",
 	"product_name" : "VDI Client",
 	"manufacturer" : "Josh Patten",
 	"name" : "VDI Client",

vdiclient.ini.example

@@ -11,10 +11,17 @@ logo = vdiclient.png
 kiosk = False
 # Enable/Disable Fullscreen mode (not applicable in Kiosk mode)
 fullscreen = True
+# Disable viewer_kiosk mode if kiosk is set to true, this allows overriding remote_viewer kiosk mode
+#viewer_kiosk = False
 # 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
@@ -29,6 +36,10 @@ tls_verify = false
 #token_name = dvi
 # API Token Value
 #token_value = xxx-x-x-x-xxx
+# Password Reset Command Launch. Has to be full executable Command
+#pwresetcmd = start chrome --app=http://pwreset.example.com
+# Automatically connect to a VMID upon authentication
+#auto_vmid = 100
 
 [Hosts]
 # Hosts are entered as `IP/FQDN = Port`

vdiclient.py

@@ -1,13 +1,13 @@
-#!/usr/bin/python3
+#!/usr/bin/env python3
 import proxmoxer # pip install proxmoxer
 import PySimpleGUI as sg # pip install PySimpleGUI
 gui = 'TK'
 import requests
 from datetime import datetime
 from configparser import ConfigParser
+import argparse
 import random
 import sys
-import copy
 import os
 import subprocess
 from time import sleep
@@ -19,6 +19,7 @@ class G:
 	hostpool = []
 	spiceproxy_conv = {}
 	proxmox = None
+	icon = None
 	vvcmd = None
 	scaling = 1
 	#########
@@ -30,50 +31,65 @@ class G:
 	totp = False
 	imagefile = None
 	kiosk = False
+	viewer_kiosk = True
 	fullscreen = True
 	verify_ssl = True
-	icon = None
 	inidebug = False
+	show_reset = False
+	show_hibernate = False
 	addl_params = None
+	pwresetcmd = None
+	auto_vmid = None
 	theme = 'LightBlue'
 	guest_type = 'both'
+	width = None
+	height = None
 
-def loadconfig(config_location = None):
+
-	if config_location:
+def loadconfig(config_location = None, config_type='file', config_username = None, config_password = None, ssl_verify = True):
-		config = ConfigParser(delimiters='=')
+	config = ConfigParser(delimiters='=')
-		try:
+	if config_type == 'file':
-			config.read(config_location)
+		if config_location:
-		except Exception as e:
+			if not os.path.isfile(config_location):
-			win_popup_button(f'Unable to read supplied configuration:\n{e!r}', 'OK')
+				win_popup_button(f'Unable to read supplied configuration:\n{config_location} does not exist!', 'OK')
-			config_location = None
-	if not config_location:
-		if os.name == 'nt': # Windows
-			config_location = f'{os.getenv("APPDATA")}\\VDIClient\\vdiclient.ini'
-			if not os.path.exists(config_location):
-				config_location = f'{os.getenv("PROGRAMFILES")}\\VDIClient\\vdiclient.ini'
-			if not os.path.exists(config_location):
-				config_location = f'{os.getenv("PROGRAMFILES(x86)")}\\VDIClient\\vdiclient.ini'
-			if not os.path.exists(config_location):
-				# Last ditch effort
-				config_location = 'C:\\Program Files\\VDIClient\\vdiclient.ini'
-			if not os.path.exists(config_location):
-				win_popup_button(f'Unable to read supplied configuration from any location!', 'OK')
 				return False
-		elif os.name == 'posix': #Linux
+		else:
-			config_location = os.path.expanduser('~/.config/VDIClient/vdiclient.ini')
+			if os.name == 'nt': # Windows
-			if not os.path.exists(config_location):
+				config_list = [
-				config_location = '/etc/vdiclient/vdiclient.ini'
+					f'{os.getenv("APPDATA")}\\VDIClient\\vdiclient.ini',
-			if not os.path.exists(config_location):
+					f'{os.getenv("PROGRAMFILES")}\\VDIClient\\vdiclient.ini',
-				config_location = '/usr/local/etc/vdiclient/vdiclient.ini'
+					f'{os.getenv("PROGRAMFILES(x86)")}\\VDIClient\\vdiclient.ini',
-			if not os.path.exists(config_location):
+					'C:\\Program Files\\VDIClient\\vdiclient.ini'
-				win_popup_button(f'Unable to read supplied configuration from any location!', 'OK')
+				]
-				return False
+				
-		config = ConfigParser(delimiters='=')
+			elif os.name == 'posix': #Linux
+				config_list = [
+					os.path.expanduser('~/.config/VDIClient/vdiclient.ini'),
+					'/etc/vdiclient/vdiclient.ini',
+					'/usr/local/etc/vdiclient/vdiclient.ini'
+				]
+		for location in config_list:
+			if os.path.exists(location):
+				config_location = location
+				break
+		if not config_location:
+			win_popup_button(f'Unable to read supplied configuration from any location!', 'OK')
+			return False
 		try:
 			config.read(config_location)
 		except Exception as e:
 			win_popup_button(f'Unable to read configuration file:\n{e!r}', 'OK')
-			config_location = None
+			return False
+	elif config_type == 'http':
+		try:
+			if config_username and config_password:
+				r = requests.get(url=config_location, auth=(config_username, config_password), verify = ssl_verify)
+			else:
+				r = requests.get(url=config_location, verify = ssl_verify)
+			config.read_string(r.text)
+		except Exception as e:
+			win_popup_button(f"Unable to read configuration from URL!\n{e}", "OK")
+			return False
 	if not 'General' in config:
 		win_popup_button(f'Unable to read supplied configuration:\nNo `General` section defined!', 'OK')
 		return False
@@ -90,12 +106,20 @@ def loadconfig(config_location = None):
 				G.imagefile = config['General']['logo']
 		if 'kiosk' in config['General']:
 			G.kiosk = config['General'].getboolean('kiosk')
+		if 'viewer_kiosk' in config['General']:
+			G.viewer_kiosk = config['General'].getboolean('viewer_kiosk')
 		if 'fullscreen' in config['General']:
 			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
@@ -107,11 +131,17 @@ def loadconfig(config_location = None):
 		if 'tls_verify' in config['Authentication']:
 			G.verify_ssl = config['Authentication'].getboolean('tls_verify')
 		if 'user' in config['Authentication']:
-				G.user = config['Authentication']['user']
+			G.user = config['Authentication']['user']
 		if 'token_name' in config['Authentication']:
-				G.token_name = config['Authentication']['token_name']
+			G.token_name = config['Authentication']['token_name']
 		if 'token_value' in config['Authentication']:
-				G.token_value = config['Authentication']['token_value']
+			G.token_value = config['Authentication']['token_value']
+		if 'pwresetcmd' in config['Authentication']:
+			G.pwresetcmd = config['Authentication']['pwresetcmd']
+		if 'auto_vmid' in config['Authentication']:
+			G.auto_vmid = config['Authentication'].getint('auto_vmid')
+		if 'knock_ip' in config['Authentication']:
+			G.knock
 	if not 'Hosts' in config:
 		win_popup_button(f'Unable to read supplied configuration:\nNo `Hosts` section defined!', 'OK')
 		return False
@@ -132,11 +162,14 @@ def loadconfig(config_location = None):
 
 def win_popup(message):
 	layout = [
-		[sg.Text(message)]
+		[sg.Text(message, key='-TXT-')]
 	]
-	window = sg.Window('Message', layout, return_keyboard_events=True, no_titlebar=True, keep_on_top=True, finalize=True)
+	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):
@@ -167,6 +200,8 @@ def setmainlayout():
 		layout.append([sg.Button("Log In", font=["Helvetica", 14], bind_return_key=True)])
 	else:
 		layout.append([sg.Button("Log In", font=["Helvetica", 14], bind_return_key=True), sg.Button("Cancel", font=["Helvetica", 14])])
+	if G.pwresetcmd:
+		layout[-1].append(sg.Button('Password Reset', font=["Helvetica", 14]))
 	return layout
 
 def getvms(listonly = False):
@@ -197,6 +232,9 @@ def getvms(listonly = False):
 	except proxmoxer.core.ResourceException as e:
 		win_popup_button(f"Unable to display list of VMs:\n {e!r}", 'OK')
 		return False
+	except requests.exceptions.ConnectionError as e:
+		print(f"Encountered error when querying proxmox: {e!r}")
+		return False
 
 def setvmlayout(vms):
 	layout = []
@@ -208,11 +246,38 @@ def setvmlayout(vms):
 	layoutcolumn = []
 	for vm in vms:
 		if not vm["status"] == "unknown":
+			vmkeyname = f'-VM|{vm["vmid"]}-'
 			connkeyname = f'-CONN|{vm["vmid"]}-'
-			layoutcolumn.append([sg.Text(vm['name'], font=["Helvetica", 14], size=(22*G.scaling, 1*G.scaling)), 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] )])
+		layout.append([sg.Column(layoutcolumn, scrollable = True, size = [None, None] )])
 	else:
 		for row in layoutcolumn:
 			layout.append(row)
@@ -231,14 +296,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)
@@ -271,6 +378,8 @@ def vmaction(vmnode, vmid, vmtype):
 			if startpop:
 				startpop.close()
 			return status
+	if action == 'reload':
+		return
 	try:
 		if vmtype == 'qemu':
 			spiceconfig = G.proxmox.nodes(vmnode).qemu(str(vmid)).spiceproxy.post()
@@ -301,7 +410,7 @@ def vmaction(vmnode, vmid, vmtype):
 		closed = iniwin(inistring)
 	connpop = win_popup(f'Connecting to {vmstatus["name"]}...')
 	pcmd = [G.vvcmd]
-	if G.kiosk:
+	if G.kiosk and G.viewer_kiosk:
 		pcmd.append('--kiosk')
 		pcmd.append('--kiosk-quit')
 		pcmd.append('on-disconnect')
@@ -396,6 +505,11 @@ def loginwindow():
 			if event == 'Cancel' or event == sg.WIN_CLOSED:
 				window.close()
 				return False
+			elif event == 'Password Reset':
+				try:
+					subprocess.check_call(G.pwresetcmd, shell=True)
+				except Exception as e:
+					win_popup_button(f'Unable to open password reset command.\n\nError Info:\n{e}', 'OK')
 			else:
 				if event in ('Log In', '\r', 'special 16777220', 'special 16777221'):
 					popwin = win_popup("Please wait, authenticating...")
@@ -426,25 +540,48 @@ def showvms():
 		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, finalize=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, finalize=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:
-		if (datetime.now() - timer).total_seconds() > 10:
+		if (datetime.now() - timer).total_seconds() > 5:
 			timer = datetime.now()
 			newvmlist = getvms(listonly = True)
-			if vmlist != newvmlist:
+			if newvmlist:
-				vmlist = newvmlist.copy()
+				if vmlist != newvmlist:
-				layout = setvmlayout(getvms())
+					vmlist = newvmlist.copy()
-				window.close()
+					vms = getvms()
-				if G.icon:
+					if vms:
-					window = sg.Window(G.title, layout, return_keyboard_events=True, finalize=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
+						layout = setvmlayout(vms)
-				else:
+						window.close()
-					window = sg.Window(G.title, layout, return_keyboard_events=True,finalize=True, resizable=False, no_titlebar=G.kiosk)
+						if G.icon:
-				window.bring_to_front()
+							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()
+					if newvms:
+						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()
@@ -459,23 +596,33 @@ 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():
 	G.scaling = 1 # TKinter requires integers
-	config_location = None
+	parser = argparse.ArgumentParser(description='Proxmox VDI Client')
-	if len(sys.argv) > 1:
+	parser.add_argument('--list_themes', help='List all available themes', action='store_true')
-		if sys.argv[1] == '--list_themes':
+	parser.add_argument('--config_type', help='Select config type (default: file)', choices=['file', 'http'], default='file')
-			sg.preview_all_look_and_feel_themes()
+	parser.add_argument('--config_location', help='Specify the config location (default: search for config file)', default=None)
-			return
+	parser.add_argument('--config_username', help="HTTP basic authentication username (default: None)", default=None)
-		if sys.argv[1] == '--config':
+	parser.add_argument('--config_password', help="HTTP basic authentication password (default: None)", default=None)
-			if len(sys.argv) < 3:
+	parser.add_argument('--ignore_ssl', help="HTTPS ignore SSL certificate errors (default: False)", action='store_false', default=True)
-				win_popup_button('No config file provided with `--config` parameter.\nPlease provide location of config file!', 'OK')
+	args = parser.parse_args()
-				return
+	if args.list_themes:
-			else:
+		sg.preview_all_look_and_feel_themes()
-				config_location = sys.argv[2]
+		return
 	setcmd()
-	if not loadconfig(config_location):
+	if not loadconfig(config_location=args.config_location, config_type=args.config_type, config_username=args.config_username, config_password=args.config_password, ssl_verify=args.ignore_ssl):
 		return False
 	sg.theme(G.theme)
 	loggedin = False
@@ -487,6 +634,13 @@ def main():
 					return 1
 				break
 			else:
+				if G.auto_vmid:
+					vms = getvms()
+					for row in vms:
+						if row['vmid'] == G.auto_vmid:
+							vmaction(row['node'], row['vmid'], row['type'], action='connect')
+							return 0
+					win_popup_button(f'No VDI instance with ID {G.auto_vmid} found!', 'OK')
 				vmstat = showvms()
 				if not vmstat:
 					G.proxmox = None