stouputils 1.14.0__py3-none-any.whl

stouputils/installer/linux.py

@@ -0,0 +1,144 @@
+""" Installer module for Linux/macOS specific functions.
+
+Provides Linux/macOS specific implementations for checking admin privileges,
+determining appropriate installation paths (global/local), and suggesting
+how to add directories to the system's PATH environment variable.
+"""
+# Imports
+import os
+
+from ..decorators import LogLevels, handle_error
+from ..io import clean_path
+from ..print import debug, info, warning
+from .common import ask_install_type, prompt_for_path
+
+
+# Functions
+@handle_error(message="Failed to suggest how to add to PATH (Linux)", error_log=LogLevels.WARNING_TRACEBACK)
+def add_to_path_linux(install_path: str) -> bool:
+	""" Suggest how to add install_path to PATH on Linux.
+
+	Checks the current shell and provides instructions for adding the path
+	to the appropriate configuration file (e.g., .bashrc, .zshrc, config.fish).
+
+	Args:
+		install_path (str): The path to add to the PATH environment variable.
+
+	Returns:
+		bool: True if instructions were provided, False otherwise (e.g., unknown shell).
+	"""
+	shell_config_files: dict[str, str] = {
+		"bash": "~/.bashrc",
+		"zsh": "~/.zshrc",
+		"fish": "~/.config/fish/config.fish"
+	}
+	current_shell: str = os.environ.get("SHELL", "").split('/')[-1]
+	config_file: str | None = shell_config_files.get(current_shell)
+
+	if config_file:
+		export_cmd: str = ""
+		if current_shell == "fish":
+			export_cmd = f"set -gx PATH $PATH {install_path}"
+		else:
+			export_cmd = f"export PATH=\"$PATH:{install_path}\"" # Escape quotes for print
+
+		debug(
+			f"To add the installation directory to your PATH, add the following line to your '{config_file}':\n"
+			f"  {export_cmd}\n"
+			f"Then restart your shell or run 'source {config_file}'."
+		)
+		return True
+	else:
+		warning(f"Could not determine your shell configuration file. Please add '{install_path}' to your PATH manually.")
+		return False
+
+
+def check_admin_linux() -> bool:
+	""" Check if the script is running with root privileges on Linux/macOS.
+
+	Returns:
+		bool: True if the effective user ID is 0 (root), False otherwise.
+	"""
+	try:
+		return os.geteuid() == 0 # type: ignore
+	except AttributeError as e:
+		# os.geteuid() is not available on all platforms (e.g., Windows)
+		# This function should ideally only be called on Linux/macOS.
+		warning(f"Could not determine user privileges on this platform: {e}")
+		return False
+	except Exception as e:
+		warning(f"Error checking admin privileges: {e}")
+		return False
+
+
+@handle_error(message="Failed to get installation path (Linux)", error_log=LogLevels.ERROR_TRACEBACK)
+def get_install_path_linux(
+	program_name: str,
+	ask_global: int = 0,
+	add_path: bool = True,
+	append_to_path: str = "",
+	default_global: str = "/usr/local/bin",
+	) -> str:
+	""" Get the installation path for the program on Linux/macOS.
+
+	Args:
+		program_name   (str):   The name of the program to install.
+		ask_global     (int):   0 = ask for anything, 1 = install globally, 2 = install locally
+		add_path       (bool):  Whether to add the program to the PATH environment variable. (Only if installed globally)
+		append_to_path (str):   String to append to the installation path when adding to PATH.
+			(ex: "bin" if executables are in the bin folder)
+		default_global (str):   The default global installation path.
+			(Default is "/usr/local/bin" which is the most common location for executables on Linux/macOS,
+			could be "/opt" or any other directory)
+
+	Returns:
+		str: The chosen installation path, or an empty string if installation is cancelled.
+	"""
+	# Default paths
+	default_local_path: str = clean_path(os.path.join(os.getcwd(), program_name))
+
+	# Common global locations: /usr/local/bin for executables, /opt/ for self-contained apps
+	# We assume 'program_name' might be an executable or a directory, /usr/local/ is safer
+	default_global_path: str = clean_path(f"{default_global}/{program_name}") # Or potentially /opt/{program_name}
+
+	# Ask user for installation type (global/local)
+	install_type: str = ask_install_type(ask_global, default_local_path, default_global_path)
+
+	# Handle global installation choice
+	if install_type == 'g':
+		if not check_admin_linux():
+			warning(
+				f"Global installation typically requires sudo privileges to write to "
+				f"'{os.path.dirname(default_global_path)}'.\n"
+				f"You may need to re-run the script with 'sudo'.\n"
+				f"Install locally instead to '{default_local_path}'? (Y/n): "
+			)
+			if input().lower() == 'n':
+				info("Installation cancelled.")
+				return ""
+			else:
+				# Fallback to local path if user agrees
+				return prompt_for_path(
+					f"Falling back to local installation path: {default_local_path}.",
+					default_local_path
+				)
+		else:
+			# User is admin or proceeding with global install anyway
+			install_path: str = prompt_for_path(
+				f"Default global installation path is {default_global_path}.",
+				default_global_path
+			)
+			if add_path:
+				# Suggest adding the *directory* containing the program to PATH,
+				# or the path itself if it seems like a directory install
+				path_to_add: str = os.path.dirname(install_path) if os.path.isfile(install_path) else install_path
+				add_to_path_linux(os.path.join(path_to_add, append_to_path))
+			return install_path
+
+	# Handle local installation choice
+	else: # install_type == 'l'
+		return prompt_for_path(
+			f"Default local installation path is {default_local_path}.",
+			default_local_path
+		)
+

stouputils/installer/main.py

@@ -0,0 +1,223 @@
+""" Main module of the installer subpackage for stouputils.
+
+Provides functions for installing programs from local zip files or URLs.
+It handles downloading, extracting, and setting up programs in a platform-agnostic way.
+
+This module contains the core installation functions that are used by both the Windows
+and Linux/macOS specific modules.
+"""
+# ruff: noqa: F403
+# ruff: noqa: F405
+
+# Imports
+import os
+import platform
+import shutil
+import tarfile
+import zipfile
+from collections.abc import Callable
+from tempfile import TemporaryDirectory
+
+import requests
+
+from ..decorators import LogLevels, handle_error
+from ..print import info, warning
+from .common import *
+from .linux import *
+from .windows import *
+
+
+# Helper functions
+def extract_archive(
+	extraction_path: str,
+	temp_dir: str,
+	extract_func: Callable[[str], None],
+	get_file_list_func: Callable[[], list[str]]
+) -> None:
+	""" Helper function to extract archive files with consistent handling.
+
+	Args:
+		extraction_path     (str): Path where files should be extracted
+		temp_dir            (str): Temporary directory for intermediate extraction
+		extract_func        (Callable[[str], None]): Function to extract the archive
+		get_file_list_func  (Callable[[], list[str]]): Function to get the list of files in the archive
+	"""
+	os.makedirs(extraction_path, exist_ok=True)
+
+	# Check if the archive contains a single folder
+	file_list: list[str] = get_file_list_func()
+	root_dirs: set[str] = {item.split('/')[0] + '/' for item in file_list if '/' in item}
+
+	# If all files are in a single root directory
+	if len(root_dirs) == 1 and all(item.startswith(next(iter(root_dirs))) for item in file_list):
+		# Extract to a temporary location first
+		temp_extract_path: str = os.path.join(temp_dir, "extracted")
+		os.makedirs(temp_extract_path, exist_ok=True)
+		extract_func(temp_extract_path)
+
+		# Move contents from the single folder to the final path
+		single_folder_path: str = os.path.join(temp_extract_path, next(iter(root_dirs)).rstrip('/'))
+		for item in os.listdir(single_folder_path):
+			src_path: str = os.path.join(single_folder_path, item)
+			dst_path: str = os.path.join(extraction_path, item)
+			if os.path.isdir(src_path):
+				shutil.copytree(src_path, dst_path, dirs_exist_ok=True)
+			else:
+				shutil.copy2(src_path, dst_path)
+		debug(f"Extracted program contents from single folder to '{extraction_path}'")
+	else:
+		# Normal extraction if not a single folder
+		extract_func(extraction_path)
+		debug(f"Extracted program to '{extraction_path}'")
+
+
+# Functions
+def get_install_path(
+	program_name: str,
+	platform_str: str = platform.system(),
+	ask_global: int = 0,
+	add_path: bool = True,
+	append_to_path: str = "",
+	) -> str:
+	""" Get the installation path for the program on the current platform.
+
+	Args:
+		program_name  (str):  The name of the program to install.
+		platform_str  (str):  The platform to get the installation path for.
+		ask_global    (int):  Whether to ask the user for a path, 0 = ask, 1 = install globally, 2 = install locally.
+		add_path      (bool): Whether to add the program to the PATH environment variable.
+		append_to_path (str):  String to append to the installation path when adding to PATH.
+			(ex: "bin" if executables are in the bin folder)
+
+	Returns:
+		str: The installation path for the program.
+	"""
+	platform_str = str(platform_str).lower()
+	if platform_str == "windows":
+		return get_install_path_windows(program_name, ask_global, add_path=add_path, append_to_path=append_to_path)
+	elif platform_str == "linux":
+		return get_install_path_linux(program_name, ask_global, add_path=add_path, append_to_path=append_to_path)
+	else:
+		warning(f"Unsupported platform for automatic install path: {platform_str}")
+		return ""
+
+def add_to_path(install_path: str, platform_str: str = platform.system()) -> bool:
+	""" Add the program to the PATH environment variable.
+
+	Args:
+		install_path  (str):  The path to the program to add to the PATH environment variable.
+		platform_str  (str):  The platform you are running on (ex: "Windows", "Linux", "Darwin", ...),
+			we use this to determine the installation path if not provided.
+
+	Returns:
+		bool: True if add to PATH was successful, False otherwise.
+	"""
+	platform_str = str(platform_str).lower()
+	if platform_str == "windows":
+		return add_to_path_windows(install_path) is True
+	elif platform_str == "linux":
+		return add_to_path_linux(install_path) is True
+	else:
+		warning(f"Unsupported platform for automatic add to PATH: {platform_str}")
+		return False
+
+@handle_error(message="Failed during program installation", error_log=LogLevels.WARNING_TRACEBACK)
+def install_program(
+	input_path: str,
+	install_path: str = "",
+	platform_str: str = platform.system(),
+	program_name: str = "",
+	add_path: bool = True,
+	append_to_path: str = "",
+	) -> bool:
+	""" Install a program to a specific path from a local zip file or URL.
+
+	Args:
+		input_path     (str):  Path to a zip file or a download URL.
+		install_path   (str):  The directory to extract the program into, we ask user for a path if not provided.
+		platform_str   (str):  The platform you are running on (ex: "Windows", "Linux", "Darwin", ...),
+			we use this to determine the installation path if not provided.
+		add_path       (bool): Whether to add the program to the PATH environment variable.
+		program_name   (str):  Override the program name, we get it from the input path if not provided.
+		append_to_path (str):  String to append to the installation path when adding to PATH.
+			(ex: "bin" if executables are in the bin folder)
+
+	Returns:
+		bool: True if installation was successful, False otherwise.
+	"""
+	# Get program name from input path if not provided
+	# (ex: "https://example.com/program.zip" -> "program", "/var/www/program.exe" -> "program")
+	if not program_name:
+		program_name = os.path.splitext(os.path.basename(input_path))[0]
+
+	# If no install path is provided, ask the user for one
+	final_install_path: str = install_path
+	if not install_path:
+		final_install_path = get_install_path(program_name, platform_str, add_path=add_path, append_to_path=append_to_path)
+		if not final_install_path:
+			warning("Failed to get installation path, please provide a path to install the program to.")
+			return False
+
+	# Create a temporary directory
+	with TemporaryDirectory() as temp_dir:
+		temp_dir: str
+		program_path: str = ""
+
+		# Download the program if it's a URL
+		if input_path.startswith("http"):
+			info(f"Downloading program from '{input_path}'")
+			response: requests.Response = requests.get(input_path)
+			if response.status_code != 200:
+				warning(f"Failed to download program from '{input_path}', reason: {response.reason}")
+				return False
+
+			# Save the program to a temporary directory
+			temp_file: str = os.path.join(temp_dir, "program.zip")
+			with open(temp_file, "wb") as f:
+				f.write(response.content)
+			program_path = temp_file
+			debug(f"Downloaded program to '{program_path}'")
+		else:
+			program_path = input_path
+			debug(f"Using local program path '{program_path}'")
+
+		# Extract the program if it's a zip file
+		if program_path.endswith(".zip"):
+			with zipfile.ZipFile(program_path, "r") as zip_ref:
+				extract_archive(
+					final_install_path,
+					temp_dir,
+					lambda path: zip_ref.extractall(path),
+					lambda: zip_ref.namelist()
+				)
+
+		# Extract the program if it's a tar.xz file
+		elif program_path.endswith(".tar.xz"):
+			with tarfile.open(program_path, "r:xz") as tar_ref:
+				extract_archive(
+					final_install_path,
+					temp_dir,
+					lambda path: tar_ref.extractall(path),
+					lambda: tar_ref.getnames()
+				)
+
+		# Else, it's a directory so we just need to copy it
+		elif os.path.isdir(program_path):
+			shutil.copytree(program_path, final_install_path)
+
+		else:
+			warning(f"Failed to install program, input path is not a zip, tar.xz file or directory: '{program_path}'")
+			return False
+
+	# If add_path is True, and the installation path was provided, we add it to the PATH environment variable
+	if add_path and install_path:
+		if not add_to_path(os.path.join(final_install_path, append_to_path), platform_str):
+			warning(
+				f"Failed to add program to PATH, please add it manually to your PATH environment variable:\n"
+				f"{final_install_path}"
+			)
+			return False
+
+	# If we get here, the program was installed successfully
+	return True
+

stouputils/installer/windows.py

@@ -0,0 +1,136 @@
+""" Installer module for Windows specific functions.
+
+Provides Windows specific implementations for checking administrator privileges,
+determining appropriate installation paths (global/local), and modifying
+the user's PATH environment variable.
+"""
+# Imports
+import os
+
+from ..decorators import LogLevels, handle_error
+from ..io import clean_path
+from ..print import debug, info, warning
+from .common import ask_install_type, prompt_for_path
+
+
+# Functions
+@handle_error(message="Failed to add to PATH (Windows)", error_log=LogLevels.WARNING_TRACEBACK)
+def add_to_path_windows(install_path: str) -> bool | None:
+	""" Add install_path to the User PATH environment variable on Windows.
+
+	Args:
+		install_path (str): The path to add to the User PATH environment variable.
+
+	Returns:
+		bool | None: True if the path was added to the User PATH environment variable, None otherwise.
+	"""
+	# Convert install_path to a Windows path if it's not already
+	install_path = install_path.replace("/", "\\")
+	os.makedirs(install_path, exist_ok=True)
+
+	# Get current user PATH
+	import winreg
+	with winreg.OpenKey(winreg.HKEY_CURRENT_USER, "Environment", 0, winreg.KEY_READ | winreg.KEY_WRITE) as key:
+
+		# Get the number of values in the registry key
+		num_values = winreg.QueryInfoKey(key)[1]
+
+		# Find the index of the 'Path' value
+		path_index = -1
+		for i in range(num_values):
+			if winreg.EnumValue(key, i)[0] == 'Path':
+				path_index = i
+				break
+
+		# Get the current path value
+		current_path: str = winreg.EnumValue(key, path_index)[1]
+
+		# Check if path is already present
+		if install_path not in current_path.split(';'):
+			new_path: str = f"{current_path};{install_path}"
+			winreg.SetValueEx(key, "Path", 0, winreg.REG_EXPAND_SZ, new_path)
+			debug(f"Added '{install_path}' to user PATH. Please restart your terminal for changes to take effect.")
+		else:
+			debug(f"'{install_path}' is already in user PATH.")
+	return True
+
+
+def check_admin_windows() -> bool:
+	""" Check if the script is running with administrator privileges on Windows. """
+	try:
+		import ctypes
+		return ctypes.windll.shell32.IsUserAnAdmin() != 0
+	except Exception:
+		return False
+
+
+@handle_error(message="Failed to get installation path (Windows)", error_log=LogLevels.ERROR_TRACEBACK)
+def get_install_path_windows(
+	program_name: str,
+	ask_global: int = 0,
+	add_path: bool = True,
+	append_to_path: str = "",
+	default_global: str = os.environ.get("ProgramFiles", "C:\\Program Files")
+) -> str:
+	""" Get the installation path for the program
+
+	Args:
+		program_name  (str):   The name of the program to install.
+		ask_global    (int):   0 = ask for anything, 1 = install globally, 2 = install locally
+		add_path      (bool):  Whether to add the program to the PATH environment variable. (Only if installed globally)
+		append_to_path (str):  String to append to the installation path when adding to PATH.
+			(ex: "bin" if executables are in the bin folder)
+		default_global (str):  The default global installation path.
+			(Default is "C:\\Program Files" which is the most common location for executables on Windows)
+
+	Returns:
+		str: The installation path.
+	"""
+	# Default path is located in the current working directory
+	default_local_path: str = clean_path(os.path.join(os.getcwd(), program_name))
+
+	# Define default global path (used in prompt even if not chosen initially)
+	default_global_path: str = clean_path(os.path.join(default_global, program_name))
+
+	# Ask user for installation type (global/local)
+	install_type: str = ask_install_type(ask_global, default_local_path, default_global_path)
+
+	# If the user wants to install globally,
+	if install_type == 'g':
+
+		# Check if the user has admin privileges,
+		if not check_admin_windows():
+
+			# If the user doesn't have admin privileges, fallback to local
+			warning(
+				f"Global installation requires administrator privileges. Please re-run as administrator.\n"
+				f"Install locally instead to '{default_local_path}'? (Y/n): "
+			)
+			if input().lower() == 'n':
+				info("Installation cancelled.")
+				return ""
+			else:
+				# Fallback to local path if user agrees
+				return prompt_for_path(
+					f"Falling back to local installation path: {default_local_path}.",
+					default_local_path
+				)
+
+		# If the user has admin privileges,
+		else:
+			# Ask it user wants to override the default global install path
+			install_path: str = prompt_for_path(
+				f"Default global installation path is {default_global_path}.",
+				default_global_path
+			)
+			if add_path:
+				add_to_path_windows(os.path.join(install_path, append_to_path))
+			return install_path
+
+	# Local install
+	else: # install_type == 'l'
+		return prompt_for_path(
+			f"Default local installation path is {default_local_path}.",
+			default_local_path
+		)
+