mirror of
https://github.com/miurahr/aqtinstall.git
synced 2025-12-16 20:27:05 +03:00
396 lines
16 KiB
Python
396 lines
16 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2025 Alexandre Poumaroux, Hiroshi Miura
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
# this software and associated documentation files (the "Software"), to deal in
|
|
# the Software without restriction, including without limitation the rights to
|
|
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
# the Software, and to permit persons to whom the Software is furnished to do so,
|
|
# subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
import json
|
|
import os
|
|
from dataclasses import dataclass
|
|
from logging import Logger, getLogger
|
|
from pathlib import Path
|
|
from typing import List, Optional
|
|
|
|
from defusedxml import ElementTree
|
|
|
|
from aqt.exceptions import DiskAccessNotPermitted
|
|
from aqt.helper import (
|
|
Settings,
|
|
download_installer,
|
|
extract_auth,
|
|
get_os_name,
|
|
get_qt_account_path,
|
|
get_qt_installer_name,
|
|
prepare_installer,
|
|
safely_run,
|
|
safely_run_save_output,
|
|
)
|
|
from aqt.metadata import Version
|
|
|
|
|
|
@dataclass
|
|
class QtPackageInfo:
|
|
name: str
|
|
displayname: str
|
|
version: str
|
|
|
|
|
|
class QtPackageManager:
|
|
def __init__(
|
|
self, arch: str, version: Version, target: str, username: Optional[str] = None, password: Optional[str] = None
|
|
):
|
|
self.arch = arch
|
|
self.version = version
|
|
self.target = target
|
|
self.cache_dir = self._get_cache_dir()
|
|
self.packages: List[QtPackageInfo] = []
|
|
self.username = username
|
|
self.password = password
|
|
self.logger = getLogger("aqt.commercial")
|
|
|
|
def _get_cache_dir(self) -> Path:
|
|
"""Create and return cache directory path."""
|
|
base_cache = Settings.qt_installer_cache_path
|
|
cache_path = os.path.join(base_cache, self.target, self.arch, str(self.version))
|
|
Path(cache_path).mkdir(parents=True, exist_ok=True)
|
|
return Path(cache_path)
|
|
|
|
def _get_cache_file(self) -> Path:
|
|
"""Get the cache file path."""
|
|
return self.cache_dir / "packages.json"
|
|
|
|
def _save_to_cache(self) -> None:
|
|
"""Save packages information to cache."""
|
|
cache_data = [{"name": pkg.name, "displayname": pkg.displayname, "version": pkg.version} for pkg in self.packages]
|
|
|
|
with open(self._get_cache_file(), "w") as f:
|
|
json.dump(cache_data, f, indent=2)
|
|
|
|
def _load_from_cache(self) -> bool:
|
|
"""Load packages information from cache if available."""
|
|
cache_file = self._get_cache_file()
|
|
if not cache_file.exists():
|
|
return False
|
|
|
|
try:
|
|
with open(cache_file, "r") as f:
|
|
cache_data = json.load(f)
|
|
self.packages = [
|
|
QtPackageInfo(name=pkg["name"], displayname=pkg["displayname"], version=pkg["version"])
|
|
for pkg in cache_data
|
|
]
|
|
return True
|
|
except (json.JSONDecodeError, KeyError):
|
|
return False
|
|
|
|
def _parse_packages_xml(self, xml_content: str) -> None:
|
|
"""Parse packages XML content and extract package information using defusedxml."""
|
|
try:
|
|
# Use defusedxml.ElementTree to safely parse the XML content
|
|
root = ElementTree.fromstring(xml_content)
|
|
self.packages = []
|
|
|
|
# Find all package elements using XPath-like expression
|
|
# Note: defusedxml supports a subset of XPath
|
|
for pkg in root.findall(".//package"):
|
|
name = pkg.get("name", "")
|
|
displayname = pkg.get("displayname", "")
|
|
version = pkg.get("version", "")
|
|
|
|
if all([name, displayname, version]): # Ensure all required attributes are present
|
|
self.packages.append(QtPackageInfo(name=name, displayname=displayname, version=version))
|
|
except ElementTree.ParseError as e:
|
|
raise RuntimeError(f"Failed to parse package XML: {e}")
|
|
|
|
def _get_version_string(self) -> str:
|
|
"""Get formatted version string for package names."""
|
|
return f"{self.version.major}{self.version.minor}{self.version.patch}"
|
|
|
|
def _get_base_package_name(self) -> str:
|
|
"""Get the base package name for the current configuration."""
|
|
version_str = self._get_version_string()
|
|
return f"qt.qt{self.version.major}.{version_str}"
|
|
|
|
def gather_packages(self, installer_path: str) -> None:
|
|
"""Gather package information using qt installer search command."""
|
|
if self._load_from_cache():
|
|
return
|
|
|
|
version_str = self._get_version_string()
|
|
base_package = f"qt.qt{self.version.major}.{version_str}"
|
|
|
|
cmd = [installer_path, "--accept-licenses", "--accept-obligations", "--confirm-command", "--default-answer"]
|
|
|
|
if self.username and self.password:
|
|
cmd.extend(["--email", self.username, "--pw", self.password])
|
|
|
|
cmd.append("search")
|
|
cmd.append(base_package)
|
|
|
|
try:
|
|
self.logger.info(f"Running: {cmd}")
|
|
output = safely_run_save_output(cmd, Settings.qt_installer_timeout)
|
|
|
|
# Handle both string and CompletedProcess outputs
|
|
output_text = output.stdout if hasattr(output, "stdout") else str(output)
|
|
|
|
# Extract the XML portion from the output
|
|
xml_start = output_text.find("<availablepackages>")
|
|
xml_end = output_text.find("</availablepackages>") + len("</availablepackages>")
|
|
|
|
if xml_start != -1 and xml_end != -1:
|
|
xml_content = output_text[xml_start:xml_end]
|
|
self._parse_packages_xml(xml_content)
|
|
self._save_to_cache()
|
|
else:
|
|
# Log the actual output for debugging
|
|
self.logger.debug(f"Installer output: {output_text}")
|
|
raise RuntimeError("Failed to find package information in installer output")
|
|
|
|
except Exception as e:
|
|
raise RuntimeError(f"Failed to get package information: {str(e)}")
|
|
|
|
def get_install_command(self, modules: Optional[List[str]], temp_dir: str) -> List[str]:
|
|
"""Generate installation command based on requested modules."""
|
|
package_name = f"{self._get_base_package_name()}.{self.arch}"
|
|
cmd = ["install", package_name]
|
|
|
|
# No modules requested, return base package only
|
|
if not modules:
|
|
return cmd
|
|
|
|
# Ensure package cache exists
|
|
self.gather_packages(temp_dir)
|
|
|
|
if "all" in modules:
|
|
# Find all addon and direct module packages
|
|
for pkg in self.packages:
|
|
if f"{self._get_base_package_name()}.addons." in pkg.name or pkg.name.startswith(
|
|
f"{self._get_base_package_name()}."
|
|
):
|
|
module_name = pkg.name.split(".")[-1]
|
|
if module_name != self.arch: # Skip the base package
|
|
cmd.append(pkg.name)
|
|
else:
|
|
# Add specifically requested modules that exist in either format
|
|
for module in modules:
|
|
addon_name = f"{self._get_base_package_name()}.addons.{module}"
|
|
direct_name = f"{self._get_base_package_name()}.{module}"
|
|
|
|
# Check if either package name exists
|
|
matching_pkg = next(
|
|
(pkg.name for pkg in self.packages if pkg.name == addon_name or pkg.name == direct_name), None
|
|
)
|
|
|
|
if matching_pkg:
|
|
cmd.append(matching_pkg)
|
|
|
|
return cmd
|
|
|
|
|
|
class CommercialInstaller:
|
|
"""Qt Commercial installer that handles module installation and package management."""
|
|
|
|
def __init__(
|
|
self,
|
|
target: str,
|
|
arch: Optional[str],
|
|
version: Optional[str],
|
|
username: Optional[str] = None,
|
|
password: Optional[str] = None,
|
|
output_dir: Optional[str] = None,
|
|
logger: Optional[Logger] = None,
|
|
base_url: str = "https://download.qt.io",
|
|
override: Optional[List[str]] = None,
|
|
modules: Optional[List[str]] = None,
|
|
no_unattended: bool = False,
|
|
dry_run: bool = False,
|
|
):
|
|
self.override = override
|
|
self.target = target
|
|
self.arch = arch or ""
|
|
self.version = Version(version) if version else Version("0.0.0")
|
|
self.output_dir = output_dir
|
|
self.logger = logger or getLogger(__name__)
|
|
self.base_url = base_url
|
|
self.modules = modules
|
|
self.no_unattended = no_unattended
|
|
self.dry_run = dry_run
|
|
|
|
# Extract credentials from override if present
|
|
if override:
|
|
extracted_username, extracted_password, self.override = extract_auth(override)
|
|
self.username = extracted_username or username
|
|
self.password = extracted_password or password
|
|
else:
|
|
self.username = username
|
|
self.password = password
|
|
|
|
# Set OS-specific properties
|
|
self.os_name = get_os_name()
|
|
self._installer_filename = get_qt_installer_name()
|
|
self.qt_account = get_qt_account_path()
|
|
self.package_manager = QtPackageManager(self.arch, self.version, self.target, self.username, self.password)
|
|
|
|
@staticmethod
|
|
def get_auto_answers() -> str:
|
|
"""Get auto-answer options from settings."""
|
|
settings_map = {
|
|
"OperationDoesNotExistError": Settings.qt_installer_operationdoesnotexisterror,
|
|
"OverwriteTargetDirectory": Settings.qt_installer_overwritetargetdirectory,
|
|
"stopProcessesForUpdates": Settings.qt_installer_stopprocessesforupdates,
|
|
"installationErrorWithCancel": Settings.qt_installer_installationerrorwithcancel,
|
|
"installationErrorWithIgnore": Settings.qt_installer_installationerrorwithignore,
|
|
"AssociateCommonFiletypes": Settings.qt_installer_associatecommonfiletypes,
|
|
"telemetry-question": Settings.qt_installer_telemetry,
|
|
}
|
|
|
|
answers = []
|
|
for key, value in settings_map.items():
|
|
answers.append(f"{key}={value}")
|
|
|
|
return ",".join(answers)
|
|
|
|
@staticmethod
|
|
def build_command(
|
|
installer_path: str,
|
|
override: Optional[List[str]] = None,
|
|
username: Optional[str] = None,
|
|
password: Optional[str] = None,
|
|
output_dir: Optional[str] = None,
|
|
no_unattended: bool = False,
|
|
) -> List[str]:
|
|
"""Build the installation command with proper safeguards."""
|
|
cmd = [installer_path]
|
|
|
|
# Add unattended flags unless explicitly disabled
|
|
if not no_unattended:
|
|
cmd.extend(["--accept-licenses", "--accept-obligations", "--confirm-command"])
|
|
|
|
# Add authentication if provided
|
|
if username and password:
|
|
cmd.extend(["--email", username, "--pw", password])
|
|
|
|
if override:
|
|
# When using override, still include unattended flags unless disabled
|
|
cmd.extend(override)
|
|
return cmd
|
|
|
|
# Add output directory if specified
|
|
if output_dir:
|
|
cmd.extend(["--root", str(Path(output_dir).resolve())])
|
|
|
|
# Add auto-answer options from settings
|
|
auto_answers = CommercialInstaller.get_auto_answers()
|
|
if auto_answers:
|
|
cmd.extend(["--auto-answer", auto_answers])
|
|
|
|
return cmd
|
|
|
|
def install(self) -> None:
|
|
"""Run the Qt installation process."""
|
|
if (
|
|
not self.qt_account.exists()
|
|
and (not self.username or not self.password)
|
|
and not os.environ.get("QT_INSTALLER_JWT_TOKEN")
|
|
):
|
|
raise RuntimeError(
|
|
"No Qt account credentials found. Provide username and password or ensure qtaccount.ini exists."
|
|
)
|
|
|
|
# Setup cache directory
|
|
cache_path = Path(Settings.qt_installer_cache_path)
|
|
cache_path.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Setup output directory and validate access
|
|
output_dir = Path(self.output_dir) if self.output_dir else Path(os.getcwd()) / "Qt"
|
|
version_dir = output_dir / str(self.version)
|
|
qt_base_dir = output_dir
|
|
|
|
if qt_base_dir.exists():
|
|
if Settings.qt_installer_overwritetargetdirectory.lower() == "yes":
|
|
self.logger.warning(f"Target directory {qt_base_dir} exists - removing as overwrite is enabled")
|
|
try:
|
|
import shutil
|
|
|
|
if version_dir.exists():
|
|
shutil.rmtree(version_dir)
|
|
except (OSError, PermissionError) as e:
|
|
raise DiskAccessNotPermitted(f"Failed to remove existing version directory {version_dir}: {str(e)}")
|
|
|
|
# Setup temp directory
|
|
temp_dir = Settings.qt_installer_temp_path
|
|
temp_path = Path(temp_dir)
|
|
if not temp_path.exists():
|
|
temp_path.mkdir(parents=True, exist_ok=True)
|
|
else:
|
|
Settings.qt_installer_cleanup()
|
|
installer_path = temp_path / self._installer_filename
|
|
|
|
self.logger.info(f"Downloading Qt installer to {installer_path}")
|
|
timeout = (Settings.connection_timeout, Settings.response_timeout)
|
|
download_installer(self.base_url, self._installer_filename, installer_path, timeout)
|
|
installer_path = prepare_installer(installer_path, self.os_name)
|
|
|
|
try:
|
|
if self.override:
|
|
if not self.username or not self.password:
|
|
self.username, self.password, self.override = extract_auth(self.override)
|
|
|
|
cmd: list[str] = self.build_command(
|
|
str(installer_path),
|
|
override=self.override,
|
|
no_unattended=self.no_unattended,
|
|
username=self.username,
|
|
password=self.password,
|
|
)
|
|
else:
|
|
# Initialize package manager and gather packages
|
|
self.package_manager.gather_packages(str(installer_path))
|
|
|
|
base_cmd = self.build_command(
|
|
str(installer_path.absolute()),
|
|
username=self.username,
|
|
password=self.password,
|
|
output_dir=str(qt_base_dir.absolute()),
|
|
no_unattended=self.no_unattended,
|
|
)
|
|
|
|
install_cmd = self.package_manager.get_install_command(self.modules, temp_dir)
|
|
cmd = [*base_cmd, *install_cmd]
|
|
|
|
log_cmd = cmd.copy()
|
|
for i in range(len(log_cmd) - 1):
|
|
if log_cmd[i] == "--email" or log_cmd[i] == "--pw":
|
|
log_cmd[i + 1] = "***"
|
|
|
|
if not self.dry_run:
|
|
self.logger.info(f"Running: {log_cmd}")
|
|
safely_run(cmd, Settings.qt_installer_timeout)
|
|
else:
|
|
self.logger.info(f"Would run: {log_cmd}")
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Installation failed: {str(e)}")
|
|
raise
|
|
finally:
|
|
self.logger.info("Qt installation completed successfully")
|
|
|
|
def _get_package_name(self) -> str:
|
|
qt_version = f"{self.version.major}{self.version.minor}{self.version.patch}"
|
|
return f"qt.qt{self.version.major}.{qt_version}.{self.arch}"
|