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/toshiba_com_extract.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3 -B
+# coding=utf-8
+
+"""
+Toshiba COM Extract
+Toshiba BIOS COM Extractor
+Copyright (C) 2018-2024 Plato Mavropoulos
+"""
+
+import os
+import subprocess
+
+from biosutilities.common.externals import comextract_path
+from biosutilities.common.paths import make_dirs, path_stem, safe_name
+from biosutilities.common.patterns import PAT_TOSHIBA_COM
+from biosutilities.common.system import printer
+from biosutilities.common.templates import BIOSUtility
+from biosutilities.common.texts import file_to_bytes
+
+
+class ToshibaComExtract(BIOSUtility):
+    """ Toshiba BIOS COM Extractor """
+
+    TITLE: str = 'Toshiba BIOS COM Extractor'
+
+    def check_format(self, input_object: str | bytes | bytearray) -> bool:
+        """ Check if input is Toshiba BIOS COM image """
+
+        input_buffer: bytes = file_to_bytes(in_object=input_object)
+
+        return bool(PAT_TOSHIBA_COM.search(string=input_buffer, endpos=0x100))
+
+    def parse_format(self, input_object: str | bytes | bytearray, extract_path: str, padding: int = 0) -> int:
+        """ Parse & Extract Toshiba BIOS COM image """
+
+        make_dirs(in_path=extract_path, delete=True)
+
+        if isinstance(input_object, str) and os.path.isfile(path=input_object):
+            input_path: str = input_object
+        else:
+            input_path = os.path.join(extract_path, 'toshiba_bios.com')
+
+            with open(file=input_path, mode='wb') as input_buffer:
+                input_buffer.write(file_to_bytes(in_object=input_object))
+
+        output_name: str = f'{safe_name(in_name=path_stem(in_path=input_path))}_extracted.bin'
+
+        output_path: str = os.path.join(extract_path, output_name)
+
+        try:
+            subprocess.run([comextract_path(), input_path, output_path], check=True, stdout=subprocess.DEVNULL)
+
+            if not os.path.isfile(path=output_path):
+                raise FileNotFoundError('EXTRACTED_FILE_MISSING')
+        except Exception as error:  # pylint: disable=broad-except
+            printer(message=f'Error: ToshibaComExtractor could not extract {input_path}: {error}!', padding=padding)
+
+            return 1
+
+        if input_path != input_object:
+            os.remove(path=input_path)
+
+        printer(message='Successful extraction via ToshibaComExtractor!', padding=padding)
+
+        return 0
+
+
+if __name__ == '__main__':
+    ToshibaComExtract().run_utility()