27 Commits

Author SHA1 Message Date
jpattWPC
3762af5d8c Bump Release 2023-10-10 09:49:20 -05:00
joshpatten
ed2b8220f1 Fully quality env path 2023-10-07 15:36:42 -05:00
jpattWPC
4a4f8df5f6 Merge pull request #72 from BrickMyPhone/main
Update vdiclient.py
2023-09-30 08:03:41 -05:00
BrickMyPhone
ff44f186c2 Update vdiclient.py
#Fixed Window sizing problem when having more than 5 VMs
2023-09-22 11:31:03 +02:00
joshpatten
e8bdbdf67c Merge pull request #54 from cinderblockgames/main
Fixing link to virt-manager.
2023-09-21 13:26:18 -05:00
joshpatten
c2fe33eda5 Merge branch 'main' into main 2023-09-21 13:26:08 -05:00
joshpatten
fb981b8a51 Merge pull request #63 from hsrzq/main
Change the python3 env path
2023-09-21 13:24:58 -05:00
jpattWPC
b32d38338b Add requests checking 2023-09-21 13:21:10 -05:00
jpattWPC
e848a938df Add window sizing option 2023-09-14 20:35:27 -05:00
jpattWPC
e8d936b297 Version Upgrade
- 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
2023-09-07 15:52:18 -05:00
TechQI
8dff999823 Change the python3 env path 2023-06-25 10:27:47 +08:00
joshpatten
a80805d69a Fixed virt-manager link 2023-04-19 17:12:16 -05:00
cinderblockgames
48c1e6f9d3 Fixing link to virt-manager. 2023-03-22 23:44:40 -04:00
jpattWPC
b382d69126 Fix #51 2023-03-10 09:22:10 -06:00
jpattWPC
715dfef72d Add python3-tk to apt install 2023-03-08 09:14:43 -06:00
jpattWPC
fbe00ec782 Bump release version 2023-02-15 08:54:29 -06:00
joshpatten
7bc5966cd6 Merge pull request #47 from bekema/main
Prevent exceptions when a node is offline
2023-02-15 08:50:14 -06:00
Hessel Bekema
9942361877 only list vms for nodes that are online; prevents KeyError crashes 2023-02-15 23:12:51 +11:00
Hessel Bekema
7148fc85ed bind enter to the log in button 2023-02-15 23:10:09 +11:00
jpattWPC
c2221da4c2 Fix typo 2023-02-03 15:57:12 -06:00
jpattWPC
de4088773b Update install instructions 2023-02-03 15:54:49 -06:00
jpattWPC
de3ab9ea68 Enhance auto-refresh logic 2023-02-03 15:47:10 -06:00
jpattWPC
57ffa48257 Add VM list refresh
- Add ability to query new VMs every 10 seconds, and redraw the window if a different list is found.
- Remove vestigial DPI checking code.
2023-02-03 15:13:27 -06:00
jpattWPC
a7f15ac8b9 Require 64 bit support 2023-02-01 11:10:50 -06:00
jpattWPC
696b8c7cd2 Remove PySimpleGuiQT support
- Remove PySimpleGUIQt support, as it requires breaking changes for Python 3.11
- Build MSI based off Python 3.11 (significantly smaller due to removing Qt requirement)
- Bump version to 1.1.0
2023-02-01 11:06:05 -06:00
jpattWPC
ef95a822c5 Merge pull request #36 from aacater/main
check if template key exists
2022-10-24 10:40:51 -05:00
Alex Cater
26c6ca6bc8 check if template key exists 2022-10-23 22:09:04 -08:00
6 changed files with 200 additions and 60 deletions

View File

@@ -10,7 +10,7 @@ This project's focus is to create a simple VDI client intended for mass deployme
## Windows Installation ## 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 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 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 chmod +x requirements.sh
./requirements.sh ./requirements.sh
cp vdiclient.py /usr/local/bin cp vdiclient.py /usr/local/bin

3
dist/vdiclient.json vendored
View File

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

View File

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

View File

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

View File

@@ -1,7 +1,7 @@
[General] [General]
# This is the title that is diplayed to the user # This is the title that is diplayed to the user
title = VDI Login 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 theme = LightBlue
# Program Icon # Program Icon
icon = vdiicon.ico icon = vdiicon.ico
@@ -15,6 +15,11 @@ fullscreen = True
inidebug = False inidebug = False
# Select which guest types to display. Acceptable values: both, lxc, qemu # Select which guest types to display. Acceptable values: both, lxc, qemu
guest_type = both 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] [Authentication]
# This is the authentication backend that will be used to authenticate # This is the authentication backend that will be used to authenticate

View File

@@ -1,15 +1,13 @@
#!/usr/bin/python3 #!/usr/bin/env python3
import proxmoxer # pip install proxmoxer import proxmoxer # pip install proxmoxer
try: import PySimpleGUI as sg # pip install PySimpleGUI
import PySimpleGUIQt as sg # pip install PySimpleGUIQt gui = 'TK'
gui = 'QT'
except ImportError:
import PySimpleGUI as sg # pip install PySimpleGUI
gui = 'TK'
import requests import requests
from datetime import datetime
from configparser import ConfigParser from configparser import ConfigParser
import random import random
import sys import sys
import copy
import os import os
import subprocess import subprocess
from time import sleep from time import sleep
@@ -36,27 +34,13 @@ class G:
verify_ssl = True verify_ssl = True
icon = None icon = None
inidebug = False inidebug = False
show_reset = False
show_hibernate = False
addl_params = None addl_params = None
theme = 'LightBlue' theme = 'LightBlue'
guest_type = 'both' guest_type = 'both'
width = None
def get_dpi(): height = None
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
def loadconfig(config_location = None): def loadconfig(config_location = None):
if config_location: if config_location:
@@ -116,6 +100,12 @@ def loadconfig(config_location = None):
G.inidebug = config['General'].getboolean('inidebug') G.inidebug = config['General'].getboolean('inidebug')
if 'guest_type' in config['General']: if 'guest_type' in config['General']:
G.guest_type = config['General']['guest_type'] 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: if not 'Authentication' in config:
win_popup_button(f'Unable to read supplied configuration:\nNo `Authentication` section defined!', 'OK') win_popup_button(f'Unable to read supplied configuration:\nNo `Authentication` section defined!', 'OK')
return False return False
@@ -151,9 +141,15 @@ def loadconfig(config_location = None):
return True return True
def win_popup(message): def win_popup(message):
layout = [[sg.Text(message)]] layout = [
window = sg.Window('Message', layout, no_titlebar=True, keep_on_top=True, finalize=True) [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.bring_to_front()
_, _ = window.read(timeout=10) # Fixes a black screen bug
window['-TXT-'].update(message)
sleep(.15)
window['-TXT-'].update(message)
return window return window
def win_popup_button(message, button): def win_popup_button(message, button):
@@ -181,25 +177,42 @@ def setmainlayout():
if G.totp: if G.totp:
layout.append([sg.Text("OTP Key", size =(12*G.scaling, 1), font=["Helvetica", 12]), sg.InputText(key='-totp-', font=["Helvetica", 12])]) layout.append([sg.Text("OTP Key", size =(12*G.scaling, 1), font=["Helvetica", 12]), sg.InputText(key='-totp-', font=["Helvetica", 12])])
if G.kiosk: 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: 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 return layout
def getvms(): def getvms(listonly = False):
vms = [] vms = []
try: 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'): for vm in G.proxmox.cluster.resources.get(type='vm'):
if vm['template']: if vm['node'] not in nodes:
continue continue
if G.guest_type == 'both': if 'template' in vm and vm['template']:
vms.append(vm) continue
elif G.guest_type == vm['type']: if G.guest_type == 'both' or G.guest_type == vm['type']:
vms.append(vm) if listonly:
vms.append(
{
'vmid': vm['vmid'],
'name': vm['name'],
'node': vm['node']
}
)
else:
vms.append(vm)
return vms return vms
except proxmoxer.core.ResourceException as e: except proxmoxer.core.ResourceException as e:
win_popup_button(f"Unable to display list of VMs:\n {e!r}", 'OK') win_popup_button(f"Unable to display list of VMs:\n {e!r}", 'OK')
return False return False
except requests.exceptions.ConnectionError as e:
print(f"Encountered error when querying proxmox: {e!r}")
return False
def setvmlayout(vms): def setvmlayout(vms):
layout = [] layout = []
@@ -211,11 +224,38 @@ def setvmlayout(vms):
layoutcolumn = [] layoutcolumn = []
for vm in vms: for vm in vms:
if not vm["status"] == "unknown": if not vm["status"] == "unknown":
vmkeyname = f'-VM|{vm["vmid"]}-'
connkeyname = f'-CONN|{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()]) layoutcolumn.append([sg.HorizontalSeparator()])
if len(vms) > 5: # We need a scrollbar 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: else:
for row in layoutcolumn: for row in layoutcolumn:
layout.append(row) layout.append(row)
@@ -234,14 +274,56 @@ def iniwin(inistring):
iniwindow.close() iniwindow.close()
return True return True
def vmaction(vmnode, vmid, vmtype): def vmaction(vmnode, vmid, vmtype, action='connect'):
status = False status = False
if vmtype == 'qemu': if vmtype == 'qemu':
vmstatus = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.get('current') vmstatus = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.get('current')
else: # Not sure this is even a thing, but here it is... else: # Not sure this is even a thing, but here it is...
vmstatus = G.proxmox.nodes(vmnode).lxc(str(vmid)).status.get('current') 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': if vmstatus['status'] != 'running':
startpop = win_popup(f'Starting {vmstatus["name"]}...') startpop = win_popup(f'Starting {vmstatus["name"]}...')
sleep(.1)
try: try:
if vmtype == 'qemu': if vmtype == 'qemu':
jobid = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.start.post(timeout=28) jobid = G.proxmox.nodes(vmnode).qemu(str(vmid)).status.start.post(timeout=28)
@@ -274,10 +356,16 @@ def vmaction(vmnode, vmid, vmtype):
if startpop: if startpop:
startpop.close() startpop.close()
return status return status
if vmtype == 'qemu': if action == 'reload':
spiceconfig = G.proxmox.nodes(vmnode).qemu(str(vmid)).spiceproxy.post() return
else: # Not sure this is even a thing, but here it is... try:
spiceconfig = G.proxmox.nodes(vmnode).lxc(str(vmid)).spiceproxy.post() 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 = ConfigParser()
confignode['virt-viewer'] = {} confignode['virt-viewer'] = {}
for key, value in spiceconfig.items(): for key, value in spiceconfig.items():
@@ -417,18 +505,58 @@ def loginwindow():
def showvms(): def showvms():
vms = getvms() vms = getvms()
vmlist = getvms(listonly=True)
newvmlist = vmlist.copy()
if vms == False: if vms == False:
return False return False
if len(vms) < 1: if len(vms) < 1:
win_popup_button('No desktop instances found, please consult with your system administrator', 'OK') win_popup_button('No desktop instances found, please consult with your system administrator', 'OK')
return False return False
layout = setvmlayout(vms) layout = setvmlayout(vms)
if G.icon: 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: 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: while True:
event, values = window.read() if (datetime.now() - timer).total_seconds() > 5:
timer = datetime.now()
newvmlist = getvms(listonly = True)
if newvmlist:
if vmlist != newvmlist:
vmlist = newvmlist.copy()
vms = getvms()
if vms:
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()
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): if event in ('Logout', None):
window.close() window.close()
return False return False
@@ -442,16 +570,20 @@ def showvms():
vmaction(vm['node'], vmid, vm['type']) vmaction(vm['node'], vmid, vm['type'])
if not found: if not found:
win_popup_button(f'VM {vm["name"]} no longer availble, please contact your system administrator', 'OK') 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 return True
def main(): def main():
if os.name == 'nt' and gui == 'QT': G.scaling = 1 # TKinter requires integers
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
config_location = None config_location = None
if len(sys.argv) > 1: if len(sys.argv) > 1:
if sys.argv[1] == '--list_themes': if sys.argv[1] == '--list_themes':
@@ -484,4 +616,6 @@ def main():
return 0 return 0
else: else:
return return
sys.exit(main())
if __name__ == '__main__':
sys.exit(main())