Use specific functions to run commands; enable twrp scripting for twrp recoveries

Author: tsterbak

openandroidinstaller/assets/configs/a3y17lte.yaml

@@ -11,45 +11,25 @@ steps:
         As a first step, you need to boot into the bootloader. A bootloader is the piece of software,
         that tells your phone who to start and run an operating system (like Android). Your device should be turned on.
         Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done.
-      command: "adb reboot download"
+      command: adb_reboot_download
     - title: "Flash custom recovery"
       type: call_button
       content: >
         In this step, you need to flash a custom recovery on your device.
         Press 'Confirm and run' to start the process. Confirm afterwards to continue.
-      command: "heimdall flash --no-reboot --RECOVERY <recovery>"
+      command: heimdall_flash_recovery
     - title: "Boot into recovery"
       type: confirm_button
       img: samsung-buttons.png
       content: >
         Unplug the USB cable from your device. Then manually reboot into recovery by pressing the *Volume Down* + *Power buttons* for 
         8~10 seconds until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, 
-        hold *Volume Up* + *Home* + *Power*.
+        hold *Volume Up* + *Home* + *Power*. Confirm when the recovery screen appears.
   install_os:
     - title: "Flash LineageOS"
-      type: confirm_button
-      content: >
-        Now swipe right to allow modifications then tap 'Wipe' on your phone. Next tap 'Format Data' and follow 
-        the instructions on your phone to continue with the formatting process. This will remove encryption and delete all files stored 
-        in the internal storage. Confirm to continue once you are done.
-    - title: "Flash LineageOS"
-      type: confirm_button
+      type: call_button 
       content: >
-        Return to the previous menu on your phone by going back two times. 
-        Them tap 'Advanced Wipe', and select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'. 
-        Confirm to continue once you are done.
-    - title: "Flash LineageOS"
-      type: confirm_button
-      content: >
-        Now connect the phone to the computer again with the USB-cable. On the device, go back three times and select “Advanced”, 
-        then “ADB Sideload”. Select 'Wipe cache' and 'Wipe dalvik cache', then swipe to begin sideload. Then confirm here.
-    - title: "Flash LineageOS"
-      type: call_button
-      content: >
-        Now it's time to flash the LineageOS image. Don't remove the USB-Cable and press 'Confirm and run' to start! 
-        This might take a while. Confirm after it's done.
-      command: "adb sideload <image>"
-    - title: "Reboot into LineageOS"
-      type: call_button
-      content: As a final step, reboot into LineageOS to finish the installation by pressing the button.
-      command: "adb reboot"
+        Connect your device with your computer with the USB-Cable.
+        This step will format your phone and wipe all the data. It will also remove encryption and delete all files stored 
+        in the internal storage. Then the OS image will be installed. Confirm to run. This might take a while. At the end your phone will boot into the new OS.
+      command: adb_twrp_wipe_and_install

openandroidinstaller/installer_config.py

@@ -120,7 +120,7 @@ def validate_config(config: str) -> bool:
             r"text|confirm_button|call_button|call_button_with_input|link_button_with_confirm"
         ),
         "content": str,
-        schema.Optional("command"): Regex(r"^adb\s|^fastboot\s|^heimdall\s"),
+        schema.Optional("command"): Regex(r"adb_reboot|adb_reboot_bootloader|adb_reboot_download|adb_sideload|adb_twrp_wipe_and_install|fastboot_unlock_with_code|fastboot_unlock|fastboot_reboot|heimdall_flash_recovery"),
         schema.Optional("allow_skip"): bool,
         schema.Optional("img"): str,
         schema.Optional("link"): str,

openandroidinstaller/openandroidinstaller.py

@@ -51,7 +51,20 @@
 )
 from installer_config import Step, _load_config
 from loguru import logger
-from tool_utils import call_tool_with_command, search_device
+from tool_utils import (
+    call_tool_with_command,
+    search_device,
+    adb_reboot,
+    adb_reboot_bootloader,
+    adb_reboot_download,
+    adb_sideload,
+    adb_twrp_wipe_and_install,
+    fastboot_reboot,
+    fastboot_flash_recovery,
+    fastboot_unlock,
+    fastboot_unlock_with_code,
+    heimdall_flash_recovery
+)
 from utils import AppState, get_download_link, image_recovery_works_with_device
 from widgets import call_button, confirm_button, get_title, link_button
 
@@ -556,11 +569,10 @@ def build(self):
             Text(f"{self.step.content}"),
         ]
         # basic view depending on step.type
+        self.confirm_button = confirm_button(self.on_confirm)
         if self.step.type == "confirm_button":
-            self.confirm_button = confirm_button(self.on_confirm)
             self.right_view.controls.append(Row([self.confirm_button]))
         elif self.step.type == "call_button":
-            self.confirm_button = confirm_button(self.on_confirm)
             self.confirm_button.disabled = True
             self.call_button = call_button(
                 self.call_to_phone, command=self.step.command
@@ -569,7 +581,6 @@ def build(self):
                 Row([self.call_button, self.confirm_button])
             )
         elif self.step.type == "call_button_with_input":
-            self.confirm_button = confirm_button(self.on_confirm)
             self.confirm_button.disabled = True
             self.call_button = call_button(
                 self.call_to_phone, command=self.step.command
@@ -578,7 +589,6 @@ def build(self):
                 [self.inputtext, Row([self.call_button, self.confirm_button])]
             )
         elif self.step.type == "link_button_with_confirm":
-            self.confirm_button = confirm_button(self.on_confirm)
             self.right_view.controls.extend(
                 [Row([link_button(self.step.link, "Open Link"), self.confirm_button])]
             )
@@ -609,11 +619,6 @@ def call_to_phone(self, e, command: str):
 
         Some parts of the command are changed by placeholders.
         """
-        # replace placeholders by the required values
-        command = command.replace("<recovery>", self.recovery_path)
-        command = command.replace("<image>", self.image_path)
-        command = command.replace("<inputtext>", self.inputtext.value)
-
         # display a progress ring to show something is happening
         self.right_view.controls.append(
             Row(
@@ -622,8 +627,29 @@ def call_to_phone(self, e, command: str):
             )
         )
         self.right_view.update()
-        # run the command
-        success = call_tool_with_command(command=command, bin_path=BIN_PATH)
+
+        # run the right command
+        if command == "adb_reboot":
+            success = adb_reboot(bin_path=BIN_PATH)
+        elif command == "adb_reboot_bootloader":
+            success = adb_reboot_bootloader(bin_path=BIN_PATH)
+        elif command == "adb_reboot_download":
+            success = adb_reboot_download(bin_path=BIN_PATH)
+        elif command == "adb_sideload":
+            success = adb_sideload(bin_path=BIN_PATH, target=self.image_path)
+        elif command == "adb_twrp_wipe_and_install":
+            success = adb_twrp_wipe_and_install(bin_path=BIN_PATH, target=self.image_path)
+        elif command == "fastboot_unlock_with_code":
+            success = fastboot_unlock_with_code(bin_path=BIN_PATH, unlock_code=self.inputtext.value)
+        elif command == "fastboot_unlock":
+            success = fastboot_unlock(bin_path=BIN_PATH)
+        elif command == "fastboot_reboot":
+            success = fastboot_reboot(bin_path=BIN_PATH)
+        elif command == "heimdall_flash_recovery":
+            success = heimdall_flash_recovery(bin_path=BIN_PATH, recovery=self.recovery_path)
+        else:
+            raise Exception(f"Unknown command type: {command}. Stopping.")
+
         # update the view accordingly
         if not success:
             # pop the progress ring

openandroidinstaller/tool_utils.py

@@ -15,6 +15,7 @@
 
 import sys
 from pathlib import Path
+from time import sleep
 from subprocess import STDOUT, CalledProcessError, call, check_output, PIPE, run, CompletedProcess
 from typing import Optional, List
 
@@ -30,9 +31,9 @@ def run_command(tool: str, command: List[str], bin_path: Path) -> CompletedProce
     if tool not in ["adb", "fastboot", "heimdall"]:
         raise Exception(f"Unknown tool {tool}. Use adb, fastboot or heimdall.")
     if PLATFORM == "win32":
-        full_command = [str(bin_path + f"{tool}.exe")] + command
+        full_command = [str(bin_path.joinpath(Path(f"{tool}"))) + ".exe"] + command
     else:
-        full_command = [str(bin_path + f"{tool}")] + command
+        full_command = [str(bin_path.joinpath(Path(f"{tool}")))] + command
 
     logger.info(f"Run command: {full_command}")
     result = run(full_command, stdout=PIPE, stderr=PIPE, universal_newlines=True)
@@ -79,7 +80,6 @@ def adb_reboot_download(bin_path: Path) -> bool:
     return True
 
 
-
 def adb_sideload(bin_path: Path, target: str) -> bool:
     """Sideload the target to device and return success."""
     logger.info("Rebooting device into bootloader with adb.")
@@ -90,40 +90,102 @@ def adb_sideload(bin_path: Path, target: str) -> bool:
     return True
 
 
-def call_tool_with_command(command: str, bin_path: Path) -> bool:
-    """Call an executable with a specific command."""
-    if PLATFORM == "win32":
-        command = re.sub(
-            r"^adb", re.escape(str(bin_path.joinpath(Path("adb")))) + ".exe", command
-        )
-        command = re.sub(
-            r"^fastboot",
-            re.escape(str(bin_path.joinpath(Path("fastboot.exe")))) + ".exe",
-            command,
-        )
-        command = re.sub(
-            r"^heimdall",
-            re.escape(str(bin_path.joinpath(Path("heimdall.exe")))) + ".exe",
-            command,
-        )
-    else:
-        command = re.sub(
-            r"^adb", re.escape(str(bin_path.joinpath(Path("adb")))), command
-        )
-        command = re.sub(
-            r"^fastboot", re.escape(str(bin_path.joinpath(Path("fastboot")))), command
-        )
-        command = re.sub(
-            r"^heimdall", re.escape(str(bin_path.joinpath(Path("heimdall")))), command
-        )
-
-    logger.info(f"Run command: {command}")
-    res = call(f"{command}", shell=True)
-    if res == 0:
-        logger.info("Success.")
-        return True
-    logger.info(f"Command {command} failed.")
-    return False
+def adb_twrp_wipe_and_install(bin_path: Path, target: str) -> bool:
+    """Wipe and format data with twrp, then flash os image with adb.
+    
+    Only works for twrp recovery.
+    """
+    logger.info("Wipe and format data with twrp, then install os image.")
+    sleep(1)
+    result = run_command("adb", ["shell", "twrp", "format", "data"], bin_path)
+    if result.returncode != 0:
+        logger.info("Formatting data failed.")
+        return False
+    # wipe some partitions
+    for partition in ["cache", "system", "dalvik"]:
+        result = run_command("adb", ["shell", "twrp", "wipe", partition], bin_path)
+        if result.returncode != 0:
+            logger.info(f"Wiping {partition} failed.")
+            return False
+    # activate sideload
+    logger.info("Wiping is done, now activate sideload.")
+    result = run_command("adb", ["shell", "twrp", "sideload"], bin_path)
+    if result.returncode != 0:
+        logger.info("Activating sideload failed.")
+        return False
+    # now flash os image
+    sleep(1)
+    logger.info("Sideload and install os image.")
+    result = run_command("adb", ["sideload", f"{target}"], bin_path)
+    if result.returncode != 0:
+        logger.info(f"Sideloading {target} failed.")
+        return False
+    # wipe some cache partitions
+    sleep(1)
+    for partition in ["cache", "dalvik"]:
+        result = run_command("adb", ["shell", "twrp", "wipe", partition], bin_path)
+        if result.returncode != 0:
+            logger.info(f"Wiping {partition} failed.")
+            return False
+    # finally reboot into os
+    sleep(1)
+    logger.info("Reboot into OS.")
+    result = run_command("adb", ["shell", "twrp", "reboot"], bin_path)
+    if result.returncode != 0:
+        logger.info("Rebooting with twrp failed.")
+        return False
+
+    return True 
+
+
+def fastboot_unlock_with_code(bin_path: Path, unlock_code: str) -> bool:
+    """Unlock the device with fastboot and code given."""
+    logger.info(f"Unlock the device with fastboot and code: {unlock_code}.")
+    result = run_command("fastboot", ["oem", "unlock", f"{unlock_code}"], bin_path)
+    if result.returncode != 0:
+        logger.info(f"Unlocking with code {unlock_code} failed.")
+        return False
+    return True
+    
+
+def fastboot_unlock(bin_path: Path) -> bool:
+    """Unlock the device with fastboot and without code."""
+    logger.info(f"Unlock the device with fastboot.")
+    result = run_command("fastboot", ["flashing", "unlock"] , bin_path)
+    if result.returncode != 0:
+        logger.info(f"Unlocking failed.")
+        return False
+    return True
+    
+
+def fastboot_reboot(bin_path: Path) -> bool:
+    """Reboot with fastboot"""
+    logger.info(f"Rebooting device with fastboot.")
+    result = run_command("fastboot", ["reboot"] , bin_path)
+    if result.returncode != 0:
+        logger.info(f"Rebooting with fastboot failed.")
+        return False
+    return True
+    
+
+def fastboot_flash_recovery(bin_path: Path, recovery: str) -> bool:
+    """Temporarily, flash custom recovery with fastboot."""
+    logger.info(f"Flash custom recovery with fastboot.")
+    result = run_command("fastboot", ["flash", "boot", f"{recovery}"] , bin_path)
+    if result.returncode != 0:
+        logger.info(f"Flashing recovery failed.")
+        return False
+    return True
+    
+
+def heimdall_flash_recovery(bin_path: Path, recovery: str) -> bool:
+    """Temporarily, flash custom recovery with heimdall."""
+    logger.info(f"Flash custom recovery with heimdall.")
+    result = run_command("heimdall", ["flash", "--no-reboot", "--RECOVERY", f"{recovery}"] , bin_path)
+    if result.returncode != 0:
+        logger.info(f"Flashing recovery failed.")
+        return False
+    return True
 
 
 def search_device(platform: str, bin_path: Path) -> Optional[str]: