Package tools (#11)

- Automatically download adb, fastboot and heimdall
- Enable packaging the tools in Linux to executable
- Update how configs are named and detected
- Add parts to README (improved install instructions, licence and used
tools)

Author: tsterbak

Makefile

@@ -1,12 +1,14 @@
 install:
-	sudo apt update && sudo apt install android-tools-adb android-tools-fastboot
+	curl -sSL https://install.python-poetry.org | python3 -
 	poetry install
+	poetry run python scripts/download-tools.py
 
 app:
 	poetry run python openandroidinstaller/openandroidinstaller.py
 
-build-app:
-	poetry run pyinstaller openandroidinstaller/openandroidinstaller.py --noconsole --noconfirm --onefile --icon "/assets/favicon.ico" --add-data "openandroidinstaller/assets:assets"
+build-app: install
+	poetry run pyinstaller openandroidinstaller/openandroidinstaller.py --noconsole --noconfirm --onefile --icon "/assets/favicon.ico" --add-data "openandroidinstaller/assets:assets" --add-binary "openandroidinstaller/bin/adb:bin" --add-binary "openandroidinstaller/bin/fastboot:bin" --add-binary "openandroidinstaller/bin/heimdall:bin"
+
 
 clean-build:
 	rm -rf build/ dist/

README.md

@@ -38,31 +38,28 @@ Sony | Xperia Z3 | z3 | | under development
 Sony | Xperia ZX | kagura | | under development
 Fairphone | Fairphone 2 | FP2 | | under development
 
-## Installation
+
+## Usage
+
 Currently, only linux is supported. 
 
 1. Download the AppImage, .exe or appropriate file for your OS. 
-2. Install `adb` and `fastboot` by running `sudo apt install android-tools-adb android-tools-fastboot`
-3. OPTIONAL: Install `heimdall` for Samsung Devices:
-    - download heimdall: https://androidfilehost.com/?w=files&flid=304516
-    - install heimdall: 
-        - `$ unzip /path/to/heimdall_ubuntu.zip -d /tmp`
-        - `$ cp /tmp/bin/heimdall* /usr/bin/`
-        - `$ rm -rf /tmp/bin`
-
-## Usage
+2. Download the lineageOS image and the custom recovery image. A source for files can be found here: https://lineageosroms.com
+3. Start the desktop app and follow the instructions.
 
-Download the lineageOS image and the custom recovery image. A source for files can be found here: https://lineageosroms.com
-Start the desktop app and follow the instructions.
 
 ## Run OpenAndroidInstaller for development
 
+Currently development is only supported on Ubunut Linux. MacOS should also work fine.
+
 1. Clone the main branch of this repository
-2. Follow the steps 2. and 3. from 'Installation' above.
-3. Run `make poetry` and `make install` to setup poetry and the relevant requirements
-4. Run `make app` to start the desktop app from the source.
+2. Run `make install` to install poetry to manage python and install the requirend dependencies like adb, fastboot and heimdall.
+3. Run `make app` to start the desktop app from the source.
+
+
+## Contributing
 
-## Contribute your own installation configurations
+### Contribute your own installation configurations
 
 If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs).
 
@@ -84,8 +81,22 @@ Every step in the config file corresponds to one view in the application. These
 After you created a config file, you can open a pull request to make the file available to other users. The file should be named after device name output by `adb shell dumpsys bluetooth_manager | grep 'name:' | cut -c9-` when the devices is connected to the computer. Please also add the device to the supported devices table above.
 
 
-## Contributing
+## Tools
+
+- The [Android SDK Platform Tools](https://developer.android.com/studio/releases/platform-tools) (such as adb and fastboot) are [Apache](https://android.googlesource.com/platform/system/adb/+/refs/heads/master/NOTICE)-licensed universal Android utilities
+- [Heimdall](https://gitlab.com/BenjaminDobell/Heimdall/) is an [MIT](https://gitlab.com/BenjaminDobell/Heimdall/-/blob/master/LICENSE)-licensed replacement for the leaked ODIN tool to flash Samsung devices.
+
 
 ## Acknowledgements
 
 * Funded from September 2022 until February 2023 by ![logos of the "Bundesministerium für Bildung und Forschung", Prodotype Fund and OKFN-Deutschland](resources/pf_funding_logos.svg)
+
+
+## License
+Original development by [Tobias Sterbak](https://tobiassterbak.com). Copyright (C) 2022.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).

…nstaller/assets/configs/Fairphone 2.yaml …androidinstaller/assets/configs/FP2.yamlopenandroidinstaller/assets/configs/Fairphone 2.yaml renamed to openandroidinstaller/assets/configs/FP2.yaml openandroidinstaller/assets/configs/Fairphone 2.yaml renamed to openandroidinstaller/assets/configs/FP2.yaml

@@ -1,5 +1,6 @@
 metadata:
-  - maintainer: Tobias Sterbak (tsterbak)
+  maintainer: Tobias Sterbak (tsterbak)
+  devicename: Fairphone 2
 requirements:
 steps:
   - title: "Flash a custom recovery"

…sets/configs/Samsung Galaxy A3 2017.yaml …idinstaller/assets/configs/a3y17lte.yamlopenandroidinstaller/assets/configs/Samsung Galaxy A3 2017.yaml renamed to openandroidinstaller/assets/configs/a3y17lte.yaml openandroidinstaller/assets/configs/Samsung Galaxy A3 2017.yaml renamed to openandroidinstaller/assets/configs/a3y17lte.yaml

@@ -1,5 +1,6 @@
 metadata:
-  - maintainer: Tobias Sterbak (tsterbak)
+  maintainer: Tobias Sterbak (tsterbak)
+  devicename: Samsung Galaxy A3 (2017)
 requirements:
   - heimdall
 steps:

…sets/configs/Samsung Galaxy A5 2016.yaml …oidinstaller/assets/configs/a5xelte.yamlopenandroidinstaller/assets/configs/Samsung Galaxy A5 2016.yaml renamed to openandroidinstaller/assets/configs/a5xelte.yaml openandroidinstaller/assets/configs/Samsung Galaxy A5 2016.yaml renamed to openandroidinstaller/assets/configs/a5xelte.yaml

@@ -1,5 +1,6 @@
 metadata:
-  - maintainer: Tobias Sterbak (tsterbak)
+  maintainer: Tobias Sterbak (tsterbak)
+  devicename: Samsung Galaxy A5 (2016)
 requirements:
   - heimdall
 steps:

…idinstaller/assets/configs/Pixel 3a.yaml …droidinstaller/assets/configs/sargo.yamlopenandroidinstaller/assets/configs/Pixel 3a.yaml renamed to openandroidinstaller/assets/configs/sargo.yaml openandroidinstaller/assets/configs/Pixel 3a.yaml renamed to openandroidinstaller/assets/configs/sargo.yaml

@@ -1,5 +1,6 @@
 metadata:
-  - maintainer: Tobias Sterbak (tsterbak)
+  maintainer: Tobias Sterbak (tsterbak)
+  devicename: Pixel 3a
 requirements:
 steps:
   - title: "Unlock the bootloader"

…idinstaller/assets/configs/Xperia Z.yaml …ndroidinstaller/assets/configs/yuga.yamlopenandroidinstaller/assets/configs/Xperia Z.yaml renamed to openandroidinstaller/assets/configs/yuga.yaml openandroidinstaller/assets/configs/Xperia Z.yaml renamed to openandroidinstaller/assets/configs/yuga.yaml

@@ -1,5 +1,6 @@
 metadata:
-  - maintainer: Tobias Sterbak (tsterbak)
+  maintainer: Tobias Sterbak (tsterbak)
+  devicename: Sony Xperia Z
 requirements:
 steps:
   - title: "Unlock the bootloader"

openandroidinstaller/installer_config.py

@@ -37,17 +37,20 @@ def __init__(
 
 
 class InstallerConfig:
-    def __init__(self, steps: List[Step]):
+    def __init__(self, steps: List[Step], metadata: dict):
         self.steps = steps
+        self.metadata = metadata
 
     @classmethod
     def from_file(cls, path):
         with open(path, "r") as stream:
             try:
-                raw_steps = yaml.safe_load(stream)
-                raw_steps = dict(raw_steps)["steps"]
+                raw_config = yaml.safe_load(stream)
+                config = dict(raw_config)
+                raw_steps = config["steps"]
+                metadata = config["metadata"]
             except yaml.YAMLError as exc:
                 print(exc)
 
         steps = [Step(**raw_step) for raw_step in raw_steps]
-        return cls(steps)
+        return cls(steps, metadata)

openandroidinstaller/openandroidinstaller.py

@@ -53,14 +53,15 @@
 
 # Toggle to True for development purposes
 DEVELOPMENT = False 
-DEVELOPMENT_CONFIG = "Xperia Z"  # "Pixel 3a"
+DEVELOPMENT_CONFIG = "a3y17lte"  # "sargo"
 
 
 PLATFORM = sys.platform
 logger.info(f"Running OpenAndroidInstaller on {PLATFORM}")
 # Define asset paths
 CONFIG_PATH = Path(__file__).parent.joinpath(Path("assets/configs")).resolve()
 IMAGE_PATH = Path(__file__).parent.joinpath(Path("assets/imgs")).resolve()
+BIN_PATH = Path(__file__).parent.joinpath(Path("bin")).resolve()
 
 
 class BaseView(UserControl):
@@ -177,60 +178,58 @@ def close_developer_options_dlg(self, e):
         self.page.update()
 
     def search_devices(self, e):
+        """Search the device when the button is clicked."""
+        logger.info("Search devices...")
         try:
             # read device properties
             # TODO: This is not windows ready...
-            if PLATFORM in ("linux", "MacOS"):
+            if PLATFORM in ("linux", "darwin"):
                 output = check_output(
                     [
-                        "adb",
+                        str(BIN_PATH.joinpath(Path("adb"))),
                         "shell",
-                        "dumpsys",
-                        "bluetooth_manager",
+                        "getprop",
                         "|",
                         "grep",
-                        "'name:'",
-                        "|",
-                        "cut",
-                        "-c9-",
+                        "ro.product.device"
                     ],
                     stderr=STDOUT,
                 ).decode()
             elif PLATFORM == "windows":
                 output = check_output(
                     [
-                        "adb",
+                        str(BIN_PATH.joinpath(Path("adb"))),
                         "shell",
-                        "dumpsys",
-                        "bluetooth_manager",
+                        "getprop",
                         "|",
                         "findstr",
-                        "'name:'",
-                        "|",
-                        "-split",
-                        "-c9-",
+                        "ro.product.device"
                     ],
                     stderr=STDOUT,
                 ).decode()
             else:
                 raise Exception(f"Unknown platform {PLATFORM}.")
 
+            output = output.split("[")[-1][:-2]
+            logger.info(f"Detected {output}")
+            # write the device code to the text shown in the box
             self.device_name.value = output.strip()
             # load config from file
-            # path = f"{CONFIG_PATH}/{output.strip()}.yaml"
             path = CONFIG_PATH.joinpath(Path(f"{output.strip()}.yaml"))
             load_config_success = self.load_config(path)
+            # display success in the application
             if load_config_success:
                 self.config_found_box.value = True
                 self.continue_button.disabled = False
+                # overwrite the text field with the real name from the config
+                self.device_name.value = f"{load_config_success} (code: {output.strip()})"
             else:
                 # show alternative configs here
                 # select a new path and load again
                 pass
         except CalledProcessError:
             if DEVELOPMENT:
                 path = CONFIG_PATH.joinpath(Path(f"{DEVELOPMENT_CONFIG}.yaml"))
-                # path = f"{CONFIG_PATH}/{DEVELOPMENT_CONFIG}.yaml"
                 load_config_success = self.load_config(path)
                 if load_config_success:
                     self.config_found_box.value = True
@@ -428,7 +427,7 @@ def load_config(self, path: str):
         try:
             self.config = InstallerConfig.from_file(path)
             self.num_total_steps = len(self.config.steps)
-            return True
+            return self.config.metadata.get("devicename", "No device name in config.")
         except FileNotFoundError:
             return False
 
@@ -501,6 +500,11 @@ def build(self):
         return self.view
 
     def call_to_phone(self, e, command: str):
+        # TODO: use proper windows paths
+        command = command.replace("adb", str(BIN_PATH.joinpath(Path("adb"))))
+        command = command.replace("fastboot", str(BIN_PATH.joinpath(Path("fastboot"))))
+        command = command.replace("heimdall", str(BIN_PATH.joinpath(Path("heimdall"))))
+
         command = command.replace("<recovery>", self.recovery_path)
         command = command.replace("<image>", self.image_path)
         command = command.replace("<inputtext>", self.inputtext.value)

openandroidinstaller/widgets.py

@@ -14,10 +14,9 @@
 # Author: Tobias Sterbak
 
 from functools import partial
-from os import path
 from typing import Callable
 
-from flet import Column, Container, ElevatedButton, Image, Row, Text, alignment, icons
+from flet import Column, Container, ElevatedButton, Row, Text, alignment, icons
 
 
 def get_title(title: str):