Implement safer memory use, improve dev env, fixed GUI bugs (#7407)
* Improve dev script for daemon * Ignore `.user` files created by Qt * Add `FORCE_DESKTOP_PROCESS` option * Catch errors related to getting profile dir * Disable IPC entirely if forced desktop * Use in-class init for AppConfig members * Refactor config to use safer memory management * Improve launch config to make OS-specific debugger usage clearer * Re-enable MainWindowTests on Windows, further refactor for memory safety, fixed some include orders * Remove dead singleton code * Swap order of tests * Use HTTPs for URLs * Fixed compile errors for `SYNERGY_ENABLE_LICENSING` compile path * Restore exec function call * Remove extra link in cancel dialog * Fixed broken link on activation cancel UI * Close dialog if activated * Fixed macOS enum ref to kCurrentProcess * Improve wording on cancel activation dialog * WIP - Test timeout (compile error) * Finished timeout logic (with smart pointer) * Include string_view * Switch to thread from jthread (maybe not supported by macOS compiler?) * Improve comment * Disable test on Windows * Add TODO related to jthread on macOS * Refactor settings and paths on Windows * Launch in desktop mode on Windows * Remove arg quote wraps which break desktop mode * Fixed qFatal on Linux * Remove test value * Follow original `AppConfig` accessor convention * Disable service checkbox if not Windows * Simplify TLS control enable logic * Update command and Git ignore * Fixed code style * Fixed include consistency * Fixed includes in validator * Fixed lint errors * Update ChangeLog * Use smart pointer for core process * Remove unneccesary default operators * Don't halt on stderr
This commit is contained in:
Nick Bolton
192
scripts/daemon.py
Normal file
192
scripts/daemon.py
Normal file
@ -0,0 +1,192 @@
|
||||
import os, sys, time, subprocess, argparse
|
||||
import lib.windows as windows
|
||||
import lib.file_utils as file_utils
|
||||
import lib.env as env
|
||||
import lib.colors as colors
|
||||
import psutil
|
||||
|
||||
DEFAULT_BIN_NAME = "synergyd"
|
||||
DEFAULT_SOURCE_DIR = os.path.join("build", "temp", "bin")
|
||||
DEFAULT_TARGET_DIR = os.path.join("build", "bin")
|
||||
SERVICE_NOT_RUNNING_ERROR = 2
|
||||
ERROR_ACCESS_VIOLATION = 0xC0000005
|
||||
IGNORE_PROCESSES = ["synergy.exe"]
|
||||
|
||||
|
||||
class Context:
|
||||
def __init__(self, verbose):
|
||||
self.verbose = verbose
|
||||
|
||||
|
||||
def main():
|
||||
"""Entry point for the script."""
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("--reinstall", action="store_true")
|
||||
parser.add_argument("--stop", action="store_true")
|
||||
parser.add_argument("--restart", action="store_true")
|
||||
parser.add_argument("--pause-on-exit", action="store_true")
|
||||
parser.add_argument("--source-dir", default=DEFAULT_SOURCE_DIR)
|
||||
parser.add_argument("--target-dir", default=DEFAULT_TARGET_DIR)
|
||||
parser.add_argument("--bin-name", default=DEFAULT_BIN_NAME)
|
||||
parser.add_argument("--verbose", action="store_true")
|
||||
args = parser.parse_args()
|
||||
|
||||
if not env.is_windows():
|
||||
print(
|
||||
f"{colors.ERROR_TEXT} This script is only supported on Windows",
|
||||
file=sys.stderr,
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
context = Context(args.verbose)
|
||||
|
||||
try:
|
||||
if args.reinstall:
|
||||
reinstall(context, args.source_dir, args.target_dir, args.bin_name)
|
||||
elif args.stop:
|
||||
stop(context, args.target_dir)
|
||||
elif args.restart:
|
||||
restart(context, args.source_dir, args.target_dir)
|
||||
else:
|
||||
print("No action specified", file=sys.stderr)
|
||||
exit(1)
|
||||
except Exception as e:
|
||||
print(f"{colors.ERROR_TEXT} {e}", file=sys.stderr)
|
||||
|
||||
if args.pause_on_exit:
|
||||
input("Press enter to continue...")
|
||||
|
||||
|
||||
def print_verbose(context, message):
|
||||
if context.verbose:
|
||||
print(message)
|
||||
|
||||
|
||||
def ensure_admin():
|
||||
if not windows.is_admin():
|
||||
windows.relaunch_as_admin(__file__)
|
||||
sys.exit()
|
||||
|
||||
|
||||
def restart(context, source_dir, target_dir):
|
||||
"""Stops the daemon service, copies files, and restarts the daemon service."""
|
||||
|
||||
ensure_admin()
|
||||
stop(context, target_dir)
|
||||
copy_files(source_dir, target_dir)
|
||||
start()
|
||||
|
||||
|
||||
def reinstall(context, source_dir, target_dir, bin_name):
|
||||
"""Stops and uninstalls daemon service, copies files, and reinstalls the daemon service."""
|
||||
|
||||
ensure_admin()
|
||||
stop(context, target_dir)
|
||||
|
||||
source_bin_path = f"{os.path.join(source_dir, bin_name)}.exe"
|
||||
|
||||
copy_files(source_dir, target_dir)
|
||||
|
||||
print("Removing old daemon service")
|
||||
try:
|
||||
subprocess.run([source_bin_path, "/uninstall"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
check_access_violation(e.returncode, source_bin_path)
|
||||
if e.returncode != 0:
|
||||
print(
|
||||
f"{colors.WARNING_TEXT} Uninstall failed, return code: {e.returncode}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
target_bin_path = os.path.join(target_dir, bin_name + ".exe")
|
||||
|
||||
try:
|
||||
print("Installing daemon service")
|
||||
subprocess.run([target_bin_path, "/install"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
check_access_violation(e.returncode, target_bin_path)
|
||||
if e.returncode != 0:
|
||||
print(f"{colors.WARNING_TEXT} Install failed, return code: {e.returncode}")
|
||||
|
||||
|
||||
def copy_files(source_dir, target_dir):
|
||||
options = file_utils.CopyOptions(ignore_errors=True, verbose=False)
|
||||
print(f"Copying files from {source_dir} to {target_dir}")
|
||||
file_utils.copy(f"{source_dir}/*", target_dir, options)
|
||||
|
||||
|
||||
def stop(context, target_dir):
|
||||
ensure_admin()
|
||||
print("Stopping daemon service")
|
||||
try:
|
||||
subprocess.run(["net", "stop", "synergy"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
if e.returncode == SERVICE_NOT_RUNNING_ERROR:
|
||||
print_verbose(context, "Daemon service not running")
|
||||
else:
|
||||
raise e
|
||||
|
||||
# Wait for Windows to release the file handles after process termination.
|
||||
wait_for_stop(context, target_dir)
|
||||
|
||||
|
||||
def start():
|
||||
ensure_admin()
|
||||
print("Starting daemon service")
|
||||
subprocess.run(["net", "start", "synergy"], shell=True, check=True)
|
||||
|
||||
|
||||
def wait_for_stop(context, target_dir):
|
||||
if is_any_process_running(context, target_dir):
|
||||
print("Waiting for file handles to release...", end="", flush=True)
|
||||
while is_any_process_running(context, target_dir):
|
||||
if not context.verbose:
|
||||
print(".", end="", flush=True)
|
||||
time.sleep(1)
|
||||
if not context.verbose:
|
||||
print()
|
||||
|
||||
|
||||
def check_access_violation(return_code, bin_path):
|
||||
if return_code == ERROR_ACCESS_VIOLATION:
|
||||
print(
|
||||
f"{colors.WARNING_TEXT} Process crashed with memory access violation: {bin_path}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
|
||||
def is_ignored_process(exe):
|
||||
for ignore_process in IGNORE_PROCESSES:
|
||||
if exe.endswith(ignore_process):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def is_any_process_running(context, dir):
|
||||
"""Check if there is any running process that contains the given directory."""
|
||||
|
||||
print_verbose(context, f"Checking if any process is running in: {dir}")
|
||||
|
||||
for proc in psutil.process_iter(attrs=["name", "exe"]):
|
||||
exe = proc.info["exe"]
|
||||
|
||||
if not exe:
|
||||
print_verbose(context, f"Skipping process with no exe: {proc}")
|
||||
continue
|
||||
|
||||
if is_ignored_process(exe):
|
||||
print_verbose(context, f"Ignoring process: {exe}")
|
||||
continue
|
||||
|
||||
try:
|
||||
if dir.lower() in exe.lower():
|
||||
print_verbose(context, f"Process found: {exe}")
|
||||
return True
|
||||
except (psutil.NoSuchProcess, psutil.AccessDenied):
|
||||
pass
|
||||
|
||||
return False
|
||||
|
||||
|
||||
main()
|
||||
@ -3,6 +3,7 @@
|
||||
import argparse
|
||||
import lib.env as env
|
||||
import lib.file_utils as file_utils
|
||||
import lib.colors as colors
|
||||
|
||||
|
||||
def main():
|
||||
@ -34,7 +35,7 @@ def main():
|
||||
if not args.ignore_errors:
|
||||
raise e
|
||||
else:
|
||||
print(f"Error: {e}")
|
||||
print(f"{colors.ERROR_TEXT} {e}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
8
scripts/lib/colors.py
Normal file
8
scripts/lib/colors.py
Normal file
@ -0,0 +1,8 @@
|
||||
import colorama # type: ignore
|
||||
from colorama import Fore # type: ignore
|
||||
|
||||
colorama.init()
|
||||
|
||||
ERROR_TEXT = f"{Fore.RED}Error:{Fore.RESET}"
|
||||
WARNING_TEXT = f"{Fore.YELLOW}Warning:{Fore.RESET}"
|
||||
HINT_TEXT = f"{Fore.LIGHTBLUE_EX}Hint:{Fore.RESET}"
|
||||
@ -1,9 +1,6 @@
|
||||
import glob, os, shutil, sys
|
||||
|
||||
import colorama # type: ignore
|
||||
from colorama import Fore # type: ignore
|
||||
|
||||
colorama.init()
|
||||
import lib.env as env
|
||||
import lib.colors as colors
|
||||
|
||||
|
||||
class CopyOptions:
|
||||
@ -24,24 +21,24 @@ def copy(source, target, options):
|
||||
context = CopyContext()
|
||||
if options.verbose:
|
||||
print(f"Copying files from {source} to {target}")
|
||||
for match in glob.glob(source):
|
||||
|
||||
if os.path.isfile(match):
|
||||
copy_file(match, target, options, context)
|
||||
elif os.path.isdir(match):
|
||||
copy_dir(match, target, options, context)
|
||||
else:
|
||||
raise RuntimeError(f"Path {match} is not a file or directory")
|
||||
try:
|
||||
for match in glob.glob(source):
|
||||
|
||||
if context.errors and options.ignore_errors:
|
||||
print(
|
||||
f"{Fore.YELLOW}WARNING:{Fore.RESET} Ignored {context.errors} copy error(s)"
|
||||
)
|
||||
if os.path.isfile(match):
|
||||
copy_file(match, target, options, context)
|
||||
elif os.path.isdir(match):
|
||||
copy_dir(match, target, options, context)
|
||||
else:
|
||||
raise RuntimeError(f"Path {match} is not a file or directory")
|
||||
finally:
|
||||
if context.errors and options.ignore_errors:
|
||||
print(f"{colors.WARNING_TEXT} Ignored {context.errors} copy error(s)")
|
||||
|
||||
if context.permission_error:
|
||||
print(
|
||||
f"{Fore.BLUE}HINT:{Fore.RESET} A permission error may mean that the file is in use"
|
||||
)
|
||||
if context.permission_error and env.is_windows():
|
||||
print(
|
||||
f"{colors.HINT_TEXT} A Windows file permission error may mean that the file is in use"
|
||||
)
|
||||
|
||||
|
||||
def copy_dir(match, target, options, context):
|
||||
@ -50,12 +47,8 @@ def copy_dir(match, target, options, context):
|
||||
|
||||
try:
|
||||
shutil.copytree(match, target, dirs_exist_ok=True)
|
||||
|
||||
except PermissionError as e:
|
||||
context.permission_error = True
|
||||
handle_copy_error(e, options, context)
|
||||
except Exception as e:
|
||||
handle_copy_error(e, options, context)
|
||||
handle_all_copy_errors(e, options, context)
|
||||
|
||||
|
||||
def copy_file(match, target, options, context):
|
||||
@ -64,17 +57,33 @@ def copy_file(match, target, options, context):
|
||||
|
||||
try:
|
||||
shutil.copy(match, target)
|
||||
except PermissionError as e:
|
||||
context.permission_error = True
|
||||
handle_copy_error(e, options, context)
|
||||
except Exception as e:
|
||||
handle_copy_error(e, options, context)
|
||||
handle_all_copy_errors(e, options, context)
|
||||
|
||||
|
||||
def handle_copy_error(e, options, context):
|
||||
context.errors += 1
|
||||
def handle_all_copy_errors(error, options, context):
|
||||
|
||||
if isinstance(error, shutil.Error):
|
||||
for _, _, file_error in error.args[0]:
|
||||
handle_copy_error(file_error, options, context)
|
||||
else:
|
||||
handle_copy_error(error, options, context)
|
||||
|
||||
if not options.ignore_errors:
|
||||
raise e
|
||||
else:
|
||||
print(f"{Fore.YELLOW}WARNING:{Fore.RESET} Copy failed: {e}", file=sys.stderr)
|
||||
raise error
|
||||
|
||||
|
||||
def handle_copy_error(error, options, context):
|
||||
if isinstance(error, PermissionError):
|
||||
context.permission_error = True
|
||||
|
||||
if isinstance(error, str):
|
||||
context.permission_error = error.startswith("[Errno 13] Permission denied")
|
||||
|
||||
context.errors += 1
|
||||
|
||||
if options.ignore_errors:
|
||||
print(
|
||||
f"{colors.WARNING_TEXT} Copy failed: {error}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
@ -1,112 +0,0 @@
|
||||
import os, sys, time, subprocess, argparse, glob
|
||||
import lib.windows as windows
|
||||
import lib.file_utils as file_utils
|
||||
import psutil
|
||||
|
||||
DEFAULT_BIN_NAME = "synergyd"
|
||||
DEFAULT_SOURCE_DIR = os.path.join("build", "temp", "bin")
|
||||
DEFAULT_TARGET_DIR = os.path.join("build", "bin")
|
||||
SERVICE_NOT_RUNNING_ERROR = 2
|
||||
ERROR_ACCESS_VIOLATION = 0xC0000005
|
||||
|
||||
|
||||
def main():
|
||||
"""Entry point for the script."""
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("--pause-on-exit", action="store_true")
|
||||
parser.add_argument("--source-dir", default=DEFAULT_SOURCE_DIR)
|
||||
parser.add_argument("--target-dir", default=DEFAULT_TARGET_DIR)
|
||||
parser.add_argument("--bin-name", default=DEFAULT_BIN_NAME)
|
||||
args = parser.parse_args()
|
||||
|
||||
if not windows.is_admin():
|
||||
windows.relaunch_as_admin(__file__)
|
||||
sys.exit()
|
||||
|
||||
try:
|
||||
reinstall(
|
||||
args.source_dir,
|
||||
args.target_dir,
|
||||
args.bin_name,
|
||||
)
|
||||
except Exception as e:
|
||||
print(f"Error: {e}", file=sys.stderr)
|
||||
|
||||
if args.pause_on_exit:
|
||||
input("Press enter to continue...")
|
||||
|
||||
|
||||
def reinstall(source_dir, target_dir, bin_name):
|
||||
"""Stops the running daemon service, copies files, and reinstalls."""
|
||||
|
||||
print("Stopping daemon service")
|
||||
try:
|
||||
subprocess.run(["net", "stop", "synergy"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
if e.returncode == SERVICE_NOT_RUNNING_ERROR:
|
||||
print("Daemon service not running")
|
||||
else:
|
||||
raise e
|
||||
|
||||
source_bin_path = f"{os.path.join(source_dir, bin_name)}.exe"
|
||||
|
||||
# Wait for Windows to release the file handles after process termination.
|
||||
while is_any_process_running(target_dir):
|
||||
print("Waiting for file handles to release")
|
||||
time.sleep(1)
|
||||
|
||||
options = file_utils.CopyOptions(ignore_errors=True, verbose=False)
|
||||
print(f"Copying files from {source_dir} to {target_dir}")
|
||||
file_utils.copy(f"{source_dir}/*", target_dir, options)
|
||||
|
||||
print("Removing old daemon service")
|
||||
try:
|
||||
subprocess.run([source_bin_path, "/uninstall"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
check_access_violation(e.returncode, source_bin_path)
|
||||
if e.returncode != 0:
|
||||
print(
|
||||
f"Warning: Uninstall failed, return code: {e.returncode}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
target_bin_path = os.path.join(target_dir, bin_name + ".exe")
|
||||
|
||||
try:
|
||||
print("Installing daemon service")
|
||||
subprocess.run([target_bin_path, "/install"], shell=True, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
check_access_violation(e.returncode, target_bin_path)
|
||||
if e.returncode != 0:
|
||||
print(f"Warning: Install failed, return code: {e.returncode}")
|
||||
|
||||
|
||||
def check_access_violation(return_code, bin_path):
|
||||
if return_code == ERROR_ACCESS_VIOLATION:
|
||||
print(
|
||||
f"Warning: Process crashed with memory access violation: {bin_path}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
|
||||
|
||||
def is_any_process_running(dir):
|
||||
"""Check if there is any running process that contains the given directory."""
|
||||
|
||||
print(f"Checking if any process is running in: {dir}")
|
||||
for proc in psutil.process_iter(attrs=["name", "exe"]):
|
||||
exe = proc.info["exe"]
|
||||
|
||||
if not exe:
|
||||
continue
|
||||
|
||||
try:
|
||||
if dir.lower() in exe.lower():
|
||||
print(f"Process found: {exe}")
|
||||
return True
|
||||
except (psutil.NoSuchProcess, psutil.AccessDenied):
|
||||
pass
|
||||
return False
|
||||
|
||||
|
||||
main()
|
||||
Reference in New Issue
Block a user