BIOSUtilities v24.10.01

Complete repository overhaul into python project
Re-designed BIOSUtility base template class flow
Re-structured utilities as BIOSUtility inherited
Re-structured project for 3rd-party compatibility
Unified project requirements and package version
Code overhaul with type hints and linting support
Switched external executable dependencies via PATH
BIOSUtility enforces simple check and parse methods
Utilities now work with both path and buffer inputs
Adjusted class, method, function names and parameters
Improved Dell PFS Update Extractor sub-PFAT processing
Improved Award BIOS Module Extractor corruption handling
Improved Apple EFI Image Identifier to expose the EFI ID
Improved Insyde iFlash/iFdPacker Extractor with ISH & PDT
Re-written Apple EFI Package Extractor to support all PKG

biosutilities/common/compression.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python3 -B
+# coding=utf-8
+
+"""
+Copyright (C) 2022-2024 Plato Mavropoulos
+"""
+
+import os
+import subprocess
+
+from biosutilities.common.externals import szip_path, tiano_path
+from biosutilities.common.system import printer
+
+
+def szip_code_assert(exit_code: int) -> None:
+    """ Check 7-Zip bad exit codes (0 OK, 1 Warning) """
+
+    if exit_code not in (0, 1):
+        raise ValueError(f'Bad exit code: {exit_code}')
+
+
+def is_szip_supported(in_path: str, padding: int = 0, args: list | None = None, silent: bool = True) -> bool:
+    """ Check if file is 7-Zip supported """
+
+    try:
+        if args is None:
+            args = []
+
+        szip_c: list[str] = [szip_path(), 't', in_path, *args, '-bso0', '-bse0', '-bsp0']
+
+        szip_t: subprocess.CompletedProcess[bytes] = subprocess.run(args=szip_c, check=False)
+
+        szip_code_assert(exit_code=szip_t.returncode)
+    except Exception as error:  # pylint: disable=broad-except
+        if not silent:
+            printer(message=f'Error: 7-Zip could not check support for file {in_path}: {error}!', padding=padding)
+
+        return False
+
+    return True
+
+
+def szip_decompress(in_path: str, out_path: str, in_name: str | None, padding: int = 0, args: list | None = None,
+                    check: bool = False, silent: bool = False) -> int:
+    """ Archive decompression via 7-Zip """
+
+    if not in_name:
+        in_name = 'archive'
+
+    try:
+        if args is None:
+            args = []
+
+        szip_c: list[str] = [szip_path(), 'x', *args, '-aou', '-bso0', '-bse0', '-bsp0', f'-o{out_path}', in_path]
+
+        szip_x: subprocess.CompletedProcess[bytes] = subprocess.run(args=szip_c, check=False)
+
+        if check:
+            szip_code_assert(exit_code=szip_x.returncode)
+
+        if not os.path.isdir(out_path):
+            raise OSError(f'Extraction directory not found: {out_path}')
+    except Exception as error:  # pylint: disable=broad-except
+        if not silent:
+            printer(message=f'Error: 7-Zip could not extract {in_name} file {in_path}: {error}!', padding=padding)
+
+        return 1
+
+    if not silent:
+        printer(message=f'Successful {in_name} decompression via 7-Zip!', padding=padding)
+
+    return 0
+
+
+def efi_compress_sizes(data: bytes | bytearray) -> tuple[int, int]:
+    """ Get EFI compression sizes """
+
+    size_compress: int = int.from_bytes(bytes=data[0x0:0x4], byteorder='little')
+
+    size_original: int = int.from_bytes(bytes=data[0x4:0x8], byteorder='little')
+
+    return size_compress, size_original
+
+
+def is_efi_compressed(data: bytes | bytearray, strict: bool = True) -> bool:
+    """ Check if data is EFI compressed, controlling EOF padding """
+
+    size_comp, size_orig = efi_compress_sizes(data=data)
+
+    check_diff: bool = size_comp < size_orig
+
+    if strict:
+        check_size: bool = size_comp + 0x8 == len(data)
+    else:
+        check_size = size_comp + 0x8 <= len(data)
+
+    return check_diff and check_size
+
+
+def efi_decompress(in_path: str, out_path: str, padding: int = 0, silent: bool = False,
+                   comp_type: str = '--uefi') -> int:
+    """ EFI/Tiano Decompression via TianoCompress """
+
+    try:
+        subprocess.run(args=[tiano_path(), '-d', in_path, '-o', out_path, '-q', comp_type],
+                       check=True, stdout=subprocess.DEVNULL)
+
+        with open(file=in_path, mode='rb') as file:
+            _, size_orig = efi_compress_sizes(data=file.read())
+
+        if os.path.getsize(out_path) != size_orig:
+            raise OSError('EFI decompressed file & header size mismatch!')
+    except Exception as error:  # pylint: disable=broad-except
+        if not silent:
+            printer(message=f'Error: TianoCompress could not extract file {in_path}: {error}!', padding=padding)
+
+        return 1
+
+    if not silent:
+        printer(message='Successful EFI decompression via TianoCompress!', padding=padding)
+
+    return 0