import os
import subprocess
import textwrap
from pathlib import Path
from scripts.utils.console import Console
class GresourceBackupNotFoundError(FileNotFoundError):
def __init__(self, location: str = None):
if location:
super().__init__(f"Gresource backup file not found: {location}")
else:
super().__init__("Gresource backup file not found.")
class Gresource:
"""Handles the extraction and compilation of gresource files for GNOME Shell themes."""
def __init__(self, gresource_file: str, temp_folder: str, destination: str):
"""
:param gresource_file: The name of the gresource file to be processed.
:param temp_folder: The temporary folder where resources will be extracted.
:param destination: The destination folder where the compiled gresource file will be saved.
"""
self.gresource_file = gresource_file
self.temp_folder = temp_folder
self.destination = destination
self.__temp_gresource = os.path.join(temp_folder, gresource_file)
self.__destination_gresource = os.path.join(destination, gresource_file)
self.__active_source_gresource = self.__destination_gresource
self.__backup_gresource = os.path.join(destination, f"{gresource_file}.backup")
self.__gresource_xml = os.path.join(temp_folder, f"{gresource_file}.xml")
def use_backup_gresource(self):
if not os.path.exists(self.__backup_gresource):
raise GresourceBackupNotFoundError(self.__backup_gresource)
self.__active_source_gresource = self.__backup_gresource
def extract(self):
extract_line = Console.Line()
extract_line.update("Extracting gresource files...")
resources = self.__get_resources_list()
self.__extract_resources(resources)
extract_line.success("Extracted gresource files.")
def __get_resources_list(self):
resources_list_response = subprocess.run(
["gresource", "list", self.__active_source_gresource],
capture_output=True, text=True, check=False
)
if resources_list_response.stderr:
raise Exception(f"gresource could not process the theme file: {self.__active_source_gresource}")
return resources_list_response.stdout.strip().split("\n")
def __extract_resources(self, resources: list[str]):
prefix = "/org/gnome/shell/theme/"
try:
for resource in resources:
resource_path = resource.replace(prefix, "")
output_path = os.path.join(self.temp_folder, resource_path)
os.makedirs(os.path.dirname(output_path), exist_ok=True)
with open(output_path, 'wb') as f:
subprocess.run(
["gresource", "extract", self.__active_source_gresource, resource],
stdout=f, check=True
)
except FileNotFoundError as e:
if "gresource" in str(e):
self.__raise_gresource_error(e)
raise
@staticmethod
def __raise_gresource_error(e: Exception):
print("Error: 'gresource' command not found.")
print("Please install the glib2-devel package:")
print(" - For Fedora/RHEL: sudo dnf install glib2-devel")
print(" - For Ubuntu/Debian: sudo apt install libglib2.0-dev")
print(" - For Arch: sudo pacman -S glib2-devel")
raise Exception("Missing required dependency: glib2-devel") from e
def compile(self):
compile_line = Console.Line()
compile_line.update("Compiling gnome-shell theme...")
self.__create_gresource_xml()
self.__compile_resources()
compile_line.success("Theme compiled.")
def __create_gresource_xml(self):
with open(self.__gresource_xml, 'w') as gresource_xml:
gresource_xml.write(self.__generate_gresource_xml())
def __generate_gresource_xml(self):
files_to_include = self.__get_files_to_include()
nl = "\n" # fstring doesn't support newline character
return textwrap.dedent(f"""
{nl.join(files_to_include)}
""")
def __get_files_to_include(self):
temp_path = Path(self.temp_folder)
return [
f"{file.relative_to(temp_path)}"
for file in temp_path.glob('**/*')
if file.is_file()
]
def __compile_resources(self):
try:
subprocess.run(["glib-compile-resources",
"--sourcedir", self.temp_folder,
"--target", self.__temp_gresource,
self.__gresource_xml
],
cwd=self.temp_folder, check=True)
except FileNotFoundError as e:
if "glib-compile-resources" in str(e):
self.__raise_gresource_error(e)
raise
def backup(self):
backup_line = Console.Line()
backup_line.update("Backing up gresource files...")
subprocess.run(["cp", "-aT",
self.__destination_gresource,
self.__backup_gresource],
check=True)
backup_line.success("Backed up gresource files.")
def restore(self):
if not os.path.exists(self.__backup_gresource):
raise GresourceBackupNotFoundError(self.__backup_gresource)
subprocess.run(["sudo", "mv", "-f",
self.__backup_gresource,
self.__destination_gresource],
check=True)
def move(self):
move_line = Console.Line()
move_line.update("Moving gresource files...")
subprocess.run(["sudo", "cp", "-f",
self.__temp_gresource,
self.__destination_gresource],
check=True)
move_line.success("Moved gresource files.")