e9de913b47
* fix imports
remove unused imports
use full import path
sort import (1. Standard Library, 2. Third-Party, 3. Local) in alphabetic.
* - remove: Method 3 from src.core.ytsage_downlader:cleanup_subtitle_file
- it could delete the subtitle file of other movies if it present in same directory as it scane recursively.
- refactor: migrate from os.path to pathlib.Path for path handling
- Replaced os.path methods with pathlib.Path to improve readability,
- avoid repeatation.
- cross-platform compatibility, and maintain cleaner code.
- improve: enhance code readability
- Standardized string literals to use double quotes for consistency
- Removed unnecessary spaces to maintain cleaner formatting
- Applied code formatting for better readability and maintainability
* - add: ytsage_constants.py file for one place to store all constants.
- imporve: return type hint for function.
- remove: src/gui/ytsage_gui_dialogs.py file to avoid repetation
- src/gui/dialogs is renamed to src/gui/ytsage_gui_dialogs for same naming convection. (future import will remains same)
- use of src/gui/ytsage_gui_dialogs/__init__.py to import the dilogs modules.
- change: variable self.parent to self._parent so it does not overwrite the parent()
- add type hint checking.
* - refactor: QMetaObject.invokeMethod to Signal
- I encounter error with incokeMethod. Could not solve it.
- So, Changed it to Signal to match app code language.
- implement: the ytsage_constants.py to code
- remove: unnecessary logic
- remove: repetitive code logic.
- update: yt-dlp logic for src\gui\ytsage_gui_dialogs\ytsage_dialogs_update:_update_binary
- yt-dlp update logic will use `yt-dlp -U`
* refactor: remove unused imports and streamline code formatting across multiple files
* - **refactor: drop `pygame` in favor of built-in `PySide6` sound**
- Removed `pygame` dependency (too heavy just for notifications).
- Replaced with `QSoundEffect`, which is lightweight and built into `PySide6`.
- Dropped `pygame.mixer` + threading → Qt handles async playback.
- Implemented sound playback with `QUrl.fromLocalFile()` and `.play()`.
- Added `setVolume(0.9)` as a configurable example.
- Converted notification sound from `.mp3` to `.wav` (only format supported).
* **refactor(utils): simplify logger module**
- Moved `logger` to `src.utils`
- Removed unnecessary import checks (logger is always available)
- Replaced `raise` statements with error logging to prevent crashes
- Use `logger.exception()` in `except` blocks to capture traceback (logged as error)
**style: remove redundant str() in f-strings**
- Dropped explicit `str()` calls inside f-strings
- f-strings already call `str()` under the hood
**chore: add type hints for GUI mixins**
- Added type hints for `FormatTableMixin` (`src.gui.ytsage_gui_format_table`)
- Added type hints for `VideoInfoMixin` (`src.gui.ytsage_gui_video_info`)
- Improves autocomplete and type safety in IDEs
* - **introduce the `ytsage_config_manager.py` module to manage app setting.**
- Loads settings from a JSON config file (`APP_CONFIG_FILE`).
- Creates the config file with default values if missing or corrupt.
- Retrieves, sets, and deletes settings using simple dot-separated keys.
- Provides safe error handling with logging instead of raising exceptions.
- Persists updates back to disk automatically.
- **Usage**
```python
from src.utils.ytsage_config_manager import ConfigManager
download_path = ConfigManager.get("download_path")
ConfigManager.set("download_path", "D:/Downloads")
last_check = ConfigManager.get("cached_versions.ytdlp.last_check")
ConfigManager.delete("cached_versions.ffmpeg.path")
```
* **Refactore: pkg_resources with importlib.metadata.version**
- UserWarning: pkg_resources is deprecated as an API.
- See https://setuptools.pypa.io/en/latest/pkg_resources.html.
- The pkg_resources package is slated for removal as early as 2025-11-30.
* **refactore: notification sound**
- `QSoundEffect` is chnaged back to `pyglet` as per mainter `@oop7` choise.
- simplify the logic.
* remove: import check, it should always work.
* **fix: runtime error**
- yt_dlp moved from `--excludes` to `--packages` in `build-windows.yml`
- In frozen build, logger will not log to consol. insted will log to file.
- In frozen build, `app_dir` is next to `.exe` file.
* chang back to checking import for ytdlp
* Bump version to 4.8.1
Update version references from 4.8.0b to 4.8.1 in __init__.py, main app, and About dialog to reflect the new release.
* Update asset paths in build workflows
Changed asset inclusion and screenshot removal paths from 'assets' to 'lib/assets' in Linux, macOS, and Windows build workflows to reflect new directory structure and ensure screenshots are excluded from packaged builds.
* Bump version to 4.8.2
Update version references from 4.8.1 to 4.8.2 in source files and documentation to prepare for a new patch release.
* Fix asset include path in Windows build workflow
Corrects the syntax for including asset files in the build-windows.yml workflow by changing 'assets,lib/assets' to 'assets=lib/assets'. This ensures assets are properly mapped during the build process.
* Update release tag examples in CI/CD README
Changed the example git tag commands from v4.8.0 and v4.8.2 to v4.8.1 for consistency in the CI/CD documentation.
* Fix include-files mapping in Windows build workflow
Changed the cx_Freeze --include-files argument from '=' to ':' for source:destination mapping in build-windows.yml. This resolves an issue where '=' was treated as a literal path, ensuring assets are correctly copied to the destination directory.
* Remove redundant comments in build-windows workflow
Deleted comments explaining the colon usage for source:destination mapping in the cx_Freeze CLI, as the mapping is already clear from the context.
* Refactor Windows build to use cx_Freeze setup script
Replaces direct cx_Freeze CLI calls with dynamically generated setup scripts for both standard and FFmpeg builds. This improves maintainability and flexibility of build configuration in the GitHub Actions workflow.
* Bump version to 4.8.3
Updated version references from 4.8.2 to 4.8.3 in __init__.py, main app, and About dialog to reflect the new release.
* revert(build): move yt_dlp from --packages to --excludes in build-windows.yml
---------
Co-authored-by: Your Name <mohamed.mohamed112@ai.mnu.edu.eg>
362 lines
13 KiB
Python
362 lines
13 KiB
Python
import hashlib
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import tempfile
|
|
from pathlib import Path
|
|
|
|
import requests
|
|
|
|
from src.utils.ytsage_logger import logger
|
|
from src.utils.ytsage_constants import (
|
|
FFMPEG_7Z_DOWNLOAD_URL,
|
|
FFMPEG_7Z_SHA256_URL,
|
|
FFMPEG_ZIP_DOWNLOAD_URL,
|
|
OS_NAME,
|
|
SUBPROCESS_CREATIONFLAGS,
|
|
)
|
|
|
|
|
|
def check_7zip_installed() -> bool:
|
|
"""Check if 7-Zip is installed on Windows."""
|
|
try:
|
|
subprocess.run(["7z", "--help"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, creationflags=SUBPROCESS_CREATIONFLAGS)
|
|
return True
|
|
except (subprocess.SubprocessError, FileNotFoundError):
|
|
return False
|
|
|
|
|
|
def download_file(url, dest_path, progress_callback=None) -> bool:
|
|
"""Download a file from URL to destination path with progress indication."""
|
|
try:
|
|
response = requests.get(url, stream=True, timeout=30) # Added timeout
|
|
response.raise_for_status() # Check for HTTP errors
|
|
total_size = int(response.headers.get("content-length", 0))
|
|
|
|
with open(dest_path, "wb") as f:
|
|
if total_size == 0:
|
|
f.write(response.content)
|
|
else:
|
|
downloaded = 0
|
|
for data in response.iter_content(chunk_size=8192):
|
|
downloaded += len(data)
|
|
f.write(data)
|
|
if progress_callback:
|
|
progress = int((downloaded / total_size) * 100)
|
|
progress_callback(f"⚡ Downloading FFmpeg components... {progress}%")
|
|
return True
|
|
except requests.RequestException as e:
|
|
logger.info(f"Download error: {e}")
|
|
return False
|
|
|
|
|
|
def get_file_sha256(file_path) -> str:
|
|
"""Calculate SHA-256 hash of a file."""
|
|
sha256_hash = hashlib.sha256()
|
|
with open(file_path, "rb") as f:
|
|
for chunk in iter(lambda: f.read(4096), b""):
|
|
sha256_hash.update(chunk)
|
|
return sha256_hash.hexdigest()
|
|
|
|
|
|
def verify_sha256(file_path, expected_hash_url) -> bool:
|
|
"""Verify file SHA-256 hash against expected hash from URL."""
|
|
try:
|
|
# Download the SHA-256 hash
|
|
response = requests.get(expected_hash_url, timeout=10)
|
|
response.raise_for_status()
|
|
expected_hash = response.text.strip().split()[0] # Get just the hash part
|
|
|
|
# Calculate actual hash
|
|
actual_hash = get_file_sha256(file_path)
|
|
|
|
# Compare hashes
|
|
if actual_hash.lower() == expected_hash.lower():
|
|
logger.info("SHA-256 verification successful!")
|
|
return True
|
|
else:
|
|
logger.error(f"SHA-256 verification failed!")
|
|
logger.info(f"Expected: {expected_hash}")
|
|
logger.info(f"Actual: {actual_hash}")
|
|
return False
|
|
except Exception as e:
|
|
logger.info(f"⚠️ SHA-256 verification error: {e}")
|
|
return False
|
|
|
|
|
|
def get_ffmpeg_install_path() -> Path:
|
|
"""Get the FFmpeg installation path."""
|
|
if OS_NAME == "Windows":
|
|
return Path(os.getenv("LOCALAPPDATA")) / "ffmpeg" / "ffmpeg-7.1.1-full_build" / "bin" # type: ignore
|
|
|
|
elif OS_NAME == "Darwin":
|
|
paths = ["/usr/local/bin", "/opt/homebrew/bin", "/usr/bin"]
|
|
for path in paths:
|
|
if Path(path).joinpath("ffmpeg").exists():
|
|
return Path(path)
|
|
return Path("/usr/local/bin") # Default Homebrew path
|
|
else:
|
|
return Path("/usr/bin") # Standard Linux path
|
|
|
|
|
|
def get_ffmpeg_path() -> str | Path:
|
|
"""
|
|
Get the FFmpeg executable path, either from PATH or installation directory.
|
|
Returns:
|
|
str: Path to FFmpeg executable or 'ffmpeg' if found in PATH but path unknown
|
|
"""
|
|
try:
|
|
# First try to find ffmpeg in PATH using 'where' on Windows or 'which' on Unix
|
|
if OS_NAME == "Windows":
|
|
# On Windows, use 'where' command and hide console window
|
|
# Extra logic moved to src\utils\ytsage_constants.py
|
|
|
|
result = subprocess.run(
|
|
["where", "ffmpeg"],
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
creationflags=SUBPROCESS_CREATIONFLAGS,
|
|
)
|
|
if result.returncode == 0 and result.stdout.strip():
|
|
ffmpeg_path = result.stdout.strip().split("\n")[0]
|
|
return ffmpeg_path
|
|
else:
|
|
# On Unix systems, use 'which' command
|
|
result = subprocess.run(["which", "ffmpeg"], capture_output=True, text=True, check=False)
|
|
if result.returncode == 0 and result.stdout.strip():
|
|
ffmpeg_path = result.stdout.strip()
|
|
return ffmpeg_path
|
|
except Exception as e:
|
|
logger.exception(f"Error finding ffmpeg in PATH: {e}")
|
|
|
|
# If not found in PATH, check the installation directory
|
|
ffmpeg_install_path = get_ffmpeg_install_path()
|
|
if OS_NAME == "Windows":
|
|
ffmpeg_exe = Path(ffmpeg_install_path).joinpath("ffmpeg.exe")
|
|
else:
|
|
ffmpeg_exe = Path(ffmpeg_install_path).joinpath("ffmpeg")
|
|
|
|
if ffmpeg_exe.exists():
|
|
return ffmpeg_exe
|
|
|
|
# Return command name as fallback
|
|
return "ffmpeg"
|
|
|
|
|
|
def check_ffmpeg_installed() -> bool:
|
|
"""Check if FFmpeg is installed and accessible."""
|
|
try:
|
|
# First try the PATH
|
|
result = subprocess.run(
|
|
["ffmpeg", "-version"],
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
check=True,
|
|
creationflags=SUBPROCESS_CREATIONFLAGS,
|
|
timeout=5,
|
|
) # Added timeout
|
|
return True
|
|
except (subprocess.SubprocessError, FileNotFoundError):
|
|
# If not in PATH, check the installation directory
|
|
ffmpeg_path = get_ffmpeg_install_path()
|
|
if OS_NAME == "Windows":
|
|
ffmpeg_exe = Path(ffmpeg_path).joinpath("ffmpeg.exe")
|
|
else:
|
|
ffmpeg_exe = Path(ffmpeg_path).joinpath("ffmpeg")
|
|
|
|
if ffmpeg_exe.exists():
|
|
# Add to PATH if found
|
|
os.environ["PATH"] = f"{ffmpeg_path}{os.pathsep}{os.environ.get('PATH', '')}"
|
|
return True
|
|
return False
|
|
except Exception as e:
|
|
logger.info(f"FFmpeg check error: {e}")
|
|
return False
|
|
|
|
|
|
def install_ffmpeg_windows() -> bool:
|
|
"""Install FFmpeg on Windows using 7z method primarily, with zip as fallback."""
|
|
ffmpeg_path = get_ffmpeg_install_path()
|
|
|
|
# Check if already installed
|
|
if check_ffmpeg_installed():
|
|
logger.info("FFmpeg is already installed!")
|
|
return True
|
|
|
|
try:
|
|
# Define variables - prioritize 7z version
|
|
# ffmpeg variables moved to src\utils\ytsage_constants.py
|
|
extract_dir = Path(os.getenv("LOCALAPPDATA")) / "ffmpeg" # type: ignore
|
|
full_build_dir = extract_dir / "ffmpeg-7.1.1-full_build"
|
|
bin_dir = full_build_dir / "bin"
|
|
|
|
# Create extraction directory if it doesn't exist
|
|
extract_dir.mkdir(exist_ok=True)
|
|
|
|
# Try 7z method first (smaller size)
|
|
use_7zip = check_7zip_installed()
|
|
if use_7zip:
|
|
logger.info("Using 7-Zip method (smaller download size)...")
|
|
temp_file = tempfile.NamedTemporaryFile(delete=False, suffix=".7z").name
|
|
|
|
# Download 7z file
|
|
if not download_file(
|
|
FFMPEG_7Z_DOWNLOAD_URL,
|
|
temp_file,
|
|
progress_callback=lambda msg: logger.debug(msg),
|
|
):
|
|
logger.error("Failed to download 7z file, trying zip fallback...")
|
|
use_7zip = False
|
|
else:
|
|
# Verify SHA-256 hash for 7z file
|
|
if verify_sha256(temp_file, FFMPEG_7Z_SHA256_URL):
|
|
logger.info("Extracting FFmpeg components from 7z archive...")
|
|
try:
|
|
subprocess.run(
|
|
["7z", "x", temp_file, f"-o{extract_dir}", "-y"],
|
|
creationflags=SUBPROCESS_CREATIONFLAGS,
|
|
timeout=300,
|
|
) # 5-minute timeout
|
|
except Exception as e:
|
|
logger.exception(f"7z extraction failed: {e}, trying zip fallback...")
|
|
use_7zip = False
|
|
else:
|
|
logger.error("SHA-256 verification failed for 7z file, trying zip fallback...")
|
|
use_7zip = False
|
|
|
|
# Fallback to zip method if 7z failed or not available
|
|
if not use_7zip:
|
|
logger.info("Using ZIP method as fallback...")
|
|
temp_file = tempfile.NamedTemporaryFile(delete=False, suffix=".zip").name
|
|
|
|
# Download zip file
|
|
if not download_file(
|
|
FFMPEG_ZIP_DOWNLOAD_URL,
|
|
temp_file,
|
|
progress_callback=lambda msg: logger.debug(msg),
|
|
):
|
|
logger.exception("Failed to download FFmpeg (both 7z and zip methods failed)")
|
|
return False
|
|
|
|
logger.info("Extracting FFmpeg components from zip archive...")
|
|
try:
|
|
import zipfile
|
|
|
|
with zipfile.ZipFile(temp_file, "r") as zip_ref:
|
|
zip_ref.extractall(extract_dir)
|
|
except Exception as e:
|
|
logger.exception(f"Extraction failed: {e}")
|
|
return False
|
|
|
|
logger.info("Configuring system paths...")
|
|
# Add to System Path
|
|
user_path = os.environ.get("PATH", "")
|
|
if str(bin_dir) not in user_path.split(os.pathsep):
|
|
subprocess.run(
|
|
["setx", "PATH", f"{user_path};{bin_dir}"],
|
|
creationflags=SUBPROCESS_CREATIONFLAGS,
|
|
)
|
|
os.environ["PATH"] = f"{user_path};{bin_dir}"
|
|
|
|
# Clean up
|
|
try:
|
|
Path(temp_file).unlink(missing_ok=True)
|
|
except Exception:
|
|
pass # Ignore cleanup errors
|
|
|
|
# Verify installation
|
|
if not check_ffmpeg_installed():
|
|
logger.error("FFmpeg installation verification failed")
|
|
return False
|
|
|
|
logger.info("FFmpeg installation completed successfully!")
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.exception(f"Error installing FFmpeg: {e}")
|
|
return False
|
|
|
|
|
|
def install_ffmpeg_macos() -> bool:
|
|
"""Install FFmpeg on macOS using Homebrew."""
|
|
try:
|
|
# Check if Homebrew is installed
|
|
try:
|
|
subprocess.run(
|
|
["brew", "--version"],
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
check=True,
|
|
timeout=5,
|
|
)
|
|
except (subprocess.SubprocessError, FileNotFoundError):
|
|
logger.info("Installing Homebrew...")
|
|
brew_install_cmd = '/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"'
|
|
subprocess.run(brew_install_cmd, shell=True, check=True, timeout=300)
|
|
|
|
# Install FFmpeg
|
|
logger.info("Installing FFmpeg...")
|
|
subprocess.run(["brew", "install", "ffmpeg"], check=True, timeout=300)
|
|
|
|
# Verify installation
|
|
if not check_ffmpeg_installed():
|
|
logger.error("FFmpeg installation verification failed")
|
|
return False
|
|
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.exception(f"Error installing FFmpeg: {e}")
|
|
return False
|
|
|
|
|
|
def install_ffmpeg_linux() -> bool:
|
|
"""Install FFmpeg on Linux using appropriate package manager."""
|
|
try:
|
|
# Detect the package manager
|
|
if shutil.which("apt"):
|
|
# Debian/Ubuntu
|
|
subprocess.run(["sudo", "apt", "update"], check=True, timeout=60)
|
|
subprocess.run(["sudo", "apt", "install", "-y", "ffmpeg"], check=True, timeout=300)
|
|
elif shutil.which("dnf"):
|
|
# Fedora
|
|
subprocess.run(["sudo", "dnf", "install", "-y", "ffmpeg"], check=True, timeout=300)
|
|
elif shutil.which("pacman"):
|
|
# Arch Linux
|
|
subprocess.run(
|
|
["sudo", "pacman", "-S", "--noconfirm", "ffmpeg"],
|
|
check=True,
|
|
timeout=300,
|
|
)
|
|
elif shutil.which("snap"):
|
|
# Universal snap package
|
|
subprocess.run(["sudo", "snap", "install", "ffmpeg"], check=True, timeout=300)
|
|
else:
|
|
logger.error("No supported package manager found")
|
|
return False
|
|
|
|
# Verify installation
|
|
if not check_ffmpeg_installed():
|
|
logger.error("FFmpeg installation verification failed")
|
|
return False
|
|
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.exception(f"Error installing FFmpeg: {e}")
|
|
return False
|
|
|
|
|
|
def auto_install_ffmpeg() -> bool:
|
|
"""Automatically install FFmpeg based on the operating system."""
|
|
if OS_NAME == "Windows":
|
|
return install_ffmpeg_windows()
|
|
elif OS_NAME == "Darwin":
|
|
return install_ffmpeg_macos()
|
|
elif OS_NAME == "Linux":
|
|
return install_ffmpeg_linux()
|
|
else:
|
|
logger.info(f"Unsupported operating system: {OS_NAME}")
|
|
return False
|