[SPLIT] OrangeFox support (#218)

Some modifications to the code, so OrangeFox recovery can be supported
(especially useful for Xiaomi devices)

Work started in #188 

It works, but I don't like the fix line 267 of `tooling.py`

Author: tsterbak

README.md

@@ -42,14 +42,18 @@ Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 L
 1. Download the [.exe or appropriate executable file for your OS](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) from the releases or get the [official flatpak from flathub](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller). You might need to change permissions to run the executable.
     - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
 2. Download the custom ROM image and the TWRP recovery image for your device and optionally some addons. A source for files can be found on the following websites:
-    - some custom ROMs:
+    - Some custom ROMs:
       - [LineageOS](https://wiki.lineageos.org/devices)
       - [/e/OS](https://doc.e.foundation/devices)
       - [LineageOS for microg](https://download.lineage.microg.org)
       - [BlissRoms](https://blissroms.org)
       - [PixelExperience](https://download.pixelexperience.org)
-    - TWRP Recovery:
+      - [crDroid](https://crdroid.net/)
+      - [ArrowOS](https://arrowos.net/)
+      - [DivestOS](https://divestos.org/)
+    - Recoveries:
       - [TWRP recovery](https://twrp.me/Devices)
+      - [OrangeFox](https://wiki.orangefox.tech)
     - Optional Addons:
       - There are different packages of *Google Apps* available.
         - [MindTheGapps](https://wiki.lineageos.org/gapps#downloads)
@@ -214,6 +218,7 @@ Every config file should have `metadata` with the following fields:
 - `is_ab_device`: bool; A boolean to determine if the device is a/b-partitioned or not.
 - `device_code`: str; The official device code.
 - `supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
+- `supported_recovery`: [OPTIONAL] List[str]; A list of supported recoveries. For the moment, can be twrp and/or orangefox (twrp by default)
 - `twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.
 
 In addition to these metadata, every config can have optional `requirements`. If these are set, the user is asked to check if they are meet.

openandroidinstaller/assets/imgs/ofox.png

@@ -64,6 +64,7 @@ def __init__(
         self.is_ab = metadata.get("is_ab_device", False)
         self.supported_device_codes = metadata.get("supported_device_codes")
         self.twrp_link = metadata.get("twrp-link")
+        self.supported_recovery = metadata.get("supported_recovery")
 
     @classmethod
     def from_file(cls, path):
@@ -124,6 +125,8 @@ def _load_config(device_code: str, config_path: Path) -> Optional[InstallerConfi
     if custom_path:
         config = InstallerConfig.from_file(custom_path)
         logger.info(f"Loaded custom device config from {custom_path}.")
+        if "supported_recovery" not in config.metadata:
+            config.metadata.update({"supported_recovery": "['twrp']"})
         logger.info(f"Config metadata: {config.metadata}.")
         return config
     else:
@@ -134,6 +137,8 @@ def _load_config(device_code: str, config_path: Path) -> Optional[InstallerConfi
             config = InstallerConfig.from_file(path)
             logger.info(f"Loaded device config from {path}.")
             if config:
+                if "supported_recovery" not in config.metadata:
+                    config.metadata.update({"supported_recovery": "['twrp']"})
                 logger.info(f"Config metadata: {config.metadata}.")
             return config
         else:
@@ -150,7 +155,7 @@ def validate_config(config: str) -> bool:
         ),
         "content": str,
         schema.Optional("command"): Regex(
-            r"adb_reboot|adb_reboot_bootloader|adb_reboot_download|adb_sideload|adb_twrp_wipe_and_install|adb_twrp_copy_partitions|fastboot_boot_recovery|fastboot_flash_boot|fastboot_unlock_with_code|fastboot_get_unlock_data|fastboot_unlock|fastboot_oem_unlock|fastboot_reboot|heimdall_flash_recovery"
+            r"adb_reboot|adb_reboot_bootloader|adb_reboot_download|adb_sideload|adb_twrp_wipe_and_install|adb_twrp_copy_partitions|fastboot_boot_recovery|fastboot_flash_recovery|fastboot_reboot_recovery|fastboot_flash_boot|fastboot_unlock_with_code|fastboot_get_unlock_data|fastboot_unlock|fastboot_oem_unlock|fastboot_reboot|heimdall_flash_recovery"
         ),
         schema.Optional("allow_skip"): bool,
         schema.Optional("img"): str,
@@ -166,6 +171,7 @@ def validate_config(config: str) -> bool:
                 "device_code": str,
                 "supported_device_codes": [str],
                 schema.Optional("twrp-link"): str,
+                schema.Optional("supported_recovery"): [str],
             },
             schema.Optional("requirements"): {
                 schema.Optional("android"): schema.Or(str, int),

openandroidinstaller/installer_config.py

@@ -140,6 +140,15 @@ def activate_sideload(bin_path: Path) -> TerminalResponse:
         yield line
 
 
+@add_logging("Activate sideloading in OranfeFox.", return_if_fail=True)
+def activate_sideload_ofox(bin_path: Path) -> TerminalResponse:
+    """Activate sideload with adb shell in OrangeFox."""
+    for line in run_command(
+        "adb shell twrp sideload help", bin_path
+    ):  # Why help ? Don't know, but it works
+        yield line
+
+
 @add_logging("Wait for device")
 def adb_wait_for_device(bin_path: Path) -> TerminalResponse:
     """Use adb to wait for the device to become available."""
@@ -216,12 +225,13 @@ def adb_twrp_wipe_and_install(
     target: str,
     config_path: Path,
     is_ab: bool,
+    chosen_recovery: str,
     install_addons=True,
     recovery: Optional[str] = None,
 ) -> TerminalResponse:
-    """Wipe and format data with twrp, then flash os image with adb.
+    """Wipe and format data with recovery, then flash os image with adb.
 
-    Only works for twrp recovery.
+    Only works for twrp and OrangeFox recovery.
     """
     logger.info("Wipe and format data with twrp, then install os image.")
     for line in adb_wait_for_recovery(bin_path):
@@ -233,38 +243,46 @@ def adb_twrp_wipe_and_install(
 
     sleep(1)
     # wipe some partitions
-    for partition in ["cache", "system"]:
+    for partition in ["cache", "dalvik", "system"]:
         for line in adb_twrp_wipe_partition(bin_path=bin_path, partition=partition):
             yield line
         sleep(1)
 
     # activate sideload
-    logger.info("Wiping is done, now activate sideload.")
-    for line in activate_sideload(bin_path=bin_path):
-        yield line
+    if chosen_recovery == "twrp":
+        logger.info("Wiping is done, now activate sideload.")
+        for line in activate_sideload(bin_path=bin_path):
+            yield line
+    else:
+        logger.info("Wiping is done, now activate sideload (ofox)")
+        for line in activate_sideload_ofox(bin_path=bin_path):
+            yield line
+        sleep(5)
     # now flash os image
     logger.info("Sideload and install os image.")
     for line in adb_sideload(bin_path=bin_path, target=target):
         yield line
-    # wipe some cache partitions
     sleep(7)
-    for partition in ["dalvik", "cache"]:
-        for line in run_command(f"adb shell twrp wipe {partition}", bin_path):
-            yield line
-        sleep(3)
-        if (type(line) == bool) and not line:
-            logger.error(f"Wiping {partition} failed.")
-            # TODO: if this fails, a fix can be to just sideload something and then adb reboot
-            for line in adb_sideload(
-                target=f"{config_path.parent.joinpath(Path('helper.txt'))}",
-                bin_path=bin_path,
-            ):
+    # wipe some cache partitions
+    if chosen_recovery == "twrp": # OrangeFox go in buggy sideload mode when wiping dalvik here (and already been wiped before)
+        logger.info("Wiping cache and dalvik...")
+        for partition in ["dalvik", "cache"]:
+            for line in run_command(f"adb shell twrp wipe {partition}", bin_path):
                 yield line
-            sleep(1)
+            sleep(3)
             if (type(line) == bool) and not line:
-                yield False
-            break
-        sleep(2)
+                logger.error(f"Wiping {partition} failed.")
+                # TODO: if this fails, a fix can be to just sideload something and then adb reboot
+                for line in adb_sideload(
+                    target=f"{config_path.parent.joinpath(Path('helper.txt'))}",
+                    bin_path=bin_path,
+                ):
+                    yield line
+                sleep(1)
+                if (type(line) == bool) and not line:
+                    yield False
+                break
+            sleep(2)
     # finally reboot into os or to fastboot for flashing addons
     for line in adb_wait_for_recovery(bin_path):
         yield line
@@ -288,7 +306,7 @@ def adb_twrp_wipe_and_install(
 
 
 def adb_twrp_install_addon(
-    bin_path: Path, addon_path: str, is_ab: bool
+    bin_path: Path, addon_path: str, chosen_recovery: str, is_ab: bool
 ) -> TerminalResponse:
     """Flash addon through adb and twrp.
 
@@ -300,8 +318,13 @@ def adb_twrp_install_addon(
         adb_wait_for_recovery(bin_path=bin_path)
     # activate sideload
     logger.info("Activate sideload.")
-    for line in activate_sideload(bin_path=bin_path):
-        yield line
+    if chosen_recovery == "twrp":
+        for line in activate_sideload(bin_path=bin_path):
+            yield line
+    else:
+        for line in activate_sideload_ofox(bin_path=bin_path):
+            yield  line
+        sleep(5)
     logger.info("Sideload and install addon.")
     # now flash the addon
     for line in adb_sideload(bin_path=bin_path, target=addon_path):
@@ -497,3 +520,30 @@ def search_device(platform: str, bin_path: Path) -> Optional[str]:
     except CalledProcessError:
         logger.error("Failed to detect a device.")
         return None
+
+
+@add_logging("Flash custom recovery with fastboot.")
+def fastboot_flash_recovery(
+    bin_path: Path, recovery: str, is_ab: bool = True
+) -> TerminalResponse:
+    """Flash custom recovery with fastboot."""
+    for line in run_command(
+        "fastboot flash recovery ", target=f"{recovery}", bin_path=bin_path
+    ):
+        yield line
+    if not is_ab:
+        if (type(line) == bool) and not line:
+            logger.error("Flashing recovery failed.")
+            yield False
+        else:
+            yield True
+
+
+@add_logging("Rebooting device to recovery.")
+def fastboot_reboot_recovery(bin_path: Path) -> TerminalResponse:
+    """
+    Reboot to recovery with fastboot
+    WARNING : On some devices, users should perform a key combo
+    """
+    for line in run_command("fastboot reboot recovery", bin_path):
+        yield line

openandroidinstaller/tooling.py

@@ -60,15 +60,43 @@ def image_works_with_device(supported_device_codes: List[str], image_path: str)
                 return False
 
 
-def recovery_works_with_device(device_code: str, recovery_path: str) -> bool:
+def recovery_works_with_device(
+    supported_device_codes: [str], supported_recovery: [str], recovery_path: str
+) -> bool:
     """Determine if a recovery works for the given device.
 
     BEWARE: THE RECOVERY PART IS STILL VERY BASIC!
     """
     recovery_file_name = recovery_path.split("/")[-1]
-    if (device_code in recovery_file_name) and ("twrp" in recovery_file_name):
-        logger.success("Device supported by the selected recovery.")
-        return True
-    else:
-        logger.error(f"Recovery file {recovery_file_name} is not supported.")
+    if recovery_file_name[-4:] != ".img":
+        logger.error(f"The file {recovery_file_name} is not a recovery file")
         return False
+    for codename in supported_device_codes:
+        if (
+            (codename in recovery_file_name)
+            and ("twrp" in recovery_file_name or "TWRP" in recovery_file_name)
+            and ("twrp" in supported_recovery or not supported_recovery)
+        ):
+            logger.success("Selected recovery supported for this device.")
+            return True
+        elif recovery_file_name == "recovery.img" and (
+            "orangefox" in supported_recovery
+        ):
+            logger.error("Cannot check recovery. Supposing it is OrangeFox.")
+            return True
+    logger.error(f"Recovery file {recovery_file_name} is not supported.")
+    return False
+
+
+def which_recovery(recovery_path: str) -> str:
+    """Determine which recovery was selected
+    This does not replace recovery_works_with_device.
+    BEWARE: THE RECOVERY PART IS STILL VERY BASIC!
+    """
+    recovery_file_name = recovery_path.split("/")[-1]
+    if "twrp" in recovery_file_name or "TWRP" in recovery_file_name:
+        return "twrp"
+    if recovery_file_name == "recovery.img":
+        return "orangefox"
+    logger.error("Unable to determine which recovery was selected !")
+    return None

openandroidinstaller/utils.py

@@ -172,6 +172,7 @@ def run_install_addons(self, e):
             for line in adb_twrp_install_addon(
                 addon_path=addon_path,
                 bin_path=self.state.bin_path,
+                chosen_recovery=self.state.chosen_recovery,
                 is_ab=self.state.config.is_ab,
             ):
                 # write the line to advanced output terminal

openandroidinstaller/views/install_addons_view.py

@@ -171,7 +171,7 @@ def check_addons_switch(e):
 
     def run_install(self, e):
         """
-        Run the installation process through twrp.
+        Run the installation process through recovery.
 
         Some parts of the command are changed by placeholders.
         """
@@ -193,6 +193,7 @@ def run_install(self, e):
             bin_path=self.state.bin_path,
             install_addons=self.state.install_addons,
             is_ab=self.state.config.is_ab,
+            chosen_recovery=self.state.chosen_recovery,
             recovery=self.state.recovery_path,
         ):
             # write the line to advanced output terminal