Merge pull request #4 from openandroidinstaller-dev/gui

Gui

Author: tsterbak

Makefile

@@ -1,3 +1,9 @@
 install:
 	sudo apt update && sudo apt install android-tools-adb android-tools-fastboot
 	poetry install
+
+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"

README.md

@@ -1 +1,52 @@
-# openandroidinstaller
+<br />
+<div align="center">
+  <h1>OpenAndroidInstaller</h1>
+  <a href="https://github.com/openandroidinstaller-dev/openandroidinstaller">
+    <img src="openandroidinstaller/assets/logo-192x192.png" alt="OpenAndroidInstaller" height="80">
+  </a>
+
+  <p align="center">
+    <br />
+    Makes installing alternative Android distributions nice and easy.
+    <br />
+    The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.
+    <br />
+    <br />
+    <a href="https://github.com/openandroidinstaller-dev/openandroidinstaller/issues">Report Bug</a>
+    ·
+    <a href="https://openandroidinstaller.org">Website</a>
+    ·
+    <a href="mailto: [email protected]">Request Feature</a>
+    <br />
+  </p>
+</div>
+
+## Installation
+
+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
+
+Download the lineageOS image and the custom recovery image.
+Start the desktop app and follow the instructions.
+
+## Run OpenAndroidInstaller for development
+
+1. Clone the main branch of this repository
+2. Run `make poetry` and `make install` to setup poetry and the relevant requirements
+3. Clone this Run `make app` to start the desktop app from the source code.
+
+## Add your own installation configurations
+
+## Contributing
+
+## 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)

openandroidinstaller/__init__.py

@@ -0,0 +1,38 @@
+steps:
+  - title: "Unlock the bootloader"
+    type: confirm_button
+    content: "Turn on developer options and OEM Unlock on your phone."
+  - title: "Boot into recovery"
+    type: confirm_button
+    content: "Turn on your device and wait until its fully booted."
+  - title: "Boot into recovery"
+    type: call_button
+    content: "Reboot into bootloader"
+    command: "adb reboot download"
+  - title: "Boot into recovery"
+    type: call_button
+    content: "Flash custom recovery"
+    command: "heimdall flash --no-reboot --RECOVERY recovery"
+  - title: "Boot into recovery"
+    type: confirm_button
+    content: "Unplug the USB cable from your device. Manually reboot into recovery. Press 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."
+  - title: "Flash LineageOS"
+    type: confirm_button
+    content: "Now tap 'Wipe'. Then tap 'Format Data' and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage."
+  - title: "Flash LineageOS"
+    type: confirm_button
+    content: "Return to the previous menu and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'."
+  - title: "Flash LineageOS"
+    type: confirm_button
+    content: "On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here"
+  - title: "Flash LineageOS"
+    type: call_button
+    content: "Flash lineageOS image. Don't remove the USB-Cable!"
+    command: "adb sideload image"
+  - title: "Boot into recovery"
+    type: call_button
+    content: "Reboot into OS"
+    command: "adb reboot"
+  - title: "Successfully finished flashing"
+    type: text
+    content: "Have fun with LineageOS!"

openandroidinstaller/assets/configs/Samsung Galaxy A3 2017.yaml

@@ -0,0 +1,30 @@
+"""Class to load config files for the install procedure."""
+import yaml
+from typing import List
+
+
+class Step():
+
+    def __init__(self, title: str, type: str, content: str, command: str=None):
+        self.title = title
+        self.type = type
+        self.content = content
+        self.command = command
+
+
+class InstallerConfig():
+    
+    def __init__(self, steps: List[Step]):
+        self.steps = steps
+
+    @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"]
+            except yaml.YAMLError as exc:
+                print(exc)
+
+        steps = [Step(**raw_step) for raw_step in raw_steps]
+        return cls(steps)

openandroidinstaller/assets/favicon.ico

@@ -0,0 +1,171 @@
+import chunk
+from time import sleep
+import flet
+from flet import (AppBar, ElevatedButton, Page, Text, View, Row, ProgressRing, Column, FilePicker, FilePickerResultEvent, icons)
+from typing import List
+from subprocess import check_output, STDOUT, call, CalledProcessError
+from functools import partial
+
+from installer_config import InstallerConfig
+
+
+recovery_path = None
+image_path = None
+
+
+def main(page: Page):
+    page.title = "OpenAndroidInstaller"
+    views = []
+
+    # Click-event handlers
+
+    def confirm(e):
+        view_num = int(page.views[-1].route) + 1
+        page.views.clear()
+        page.views.append(views[view_num])
+        page.update()
+
+    def go_back(e):
+        view_num = int(page.views[-1].route) - 1
+        if view_num < 0:
+            view_num = 0
+        page.views.clear()
+        page.views.append(views[view_num])
+        page.update()
+
+    def search_devices(e):
+        config_path = "openandroidinstaller/assets/configs/"
+        try:
+            # read device properties
+            output = check_output(["adb", "shell", "dumpsys", "bluetooth_manager", "|", "grep", "\'name:\'", "|", "cut", "-c9-"], stderr=STDOUT).decode() 
+            page.views[-1].controls.append(Text(f"Detected: {output}"))
+            # load config from file
+            config = InstallerConfig.from_file(config_path + output.strip() + ".yaml")
+            page.views[-1].controls.append(Text(f"Installer configuration found."))
+            page.views[-1].controls.append(ElevatedButton("Confirm and continue", on_click=confirm))
+            new_views = views_from_config(config)
+            views.extend(new_views)
+        except CalledProcessError:
+            output = "No device detected!"
+            page.views[-1].controls.append(Text(f"{output}"))
+        page.update()
+
+
+    def views_from_config(config: InstallerConfig) -> List[View]:
+        new_views = []
+        for num_step, step in enumerate(config.steps):
+            if step.type == "confirm_button":
+                new_views.append(
+                    get_new_view(title=step.title, content=[confirm_button(step.content)], index=2+num_step)
+                )
+            elif step.type == "call_button":
+                new_views.append(
+                    get_new_view(title=step.title, content=[call_button(step.content, command=step.command)], index=2+num_step)
+                )
+            elif step.type == "text":
+                new_views.append(
+                    get_new_view(title=step.title, content=[Text(step.content)], index=2+num_step)
+                )
+            else:
+                raise Exception(f"Unknown step type: {step.type}")
+        return new_views
+    
+
+    def call_to_phone(e, command: str):
+        command = command.replace("recovery", recovery_path)
+        command = command.replace("image", image_path)
+        page.views[-1].controls.append(ProgressRing())
+        page.update()
+        res = call(f'{command}', shell=True)
+        if res != 0:
+            page.views[-1].controls.pop()
+            page.views[-1].controls.append(Text("Command {command} failed!"))
+        else:
+            sleep(5)
+            page.views[-1].controls.pop()
+            page.views[-1].controls.append(ElevatedButton("Confirm and continue", on_click=confirm))
+        page.update()
+
+    # file picker setup
+
+    def pick_image_result(e: FilePickerResultEvent):
+        selected_image.value = (
+            ", ".join(map(lambda f: f.name, e.files)) if e.files else "Cancelled!"
+        )
+        global image_path
+        image_path = e.files[0].path
+        selected_image.update()
+
+    def pick_recovery_result(e: FilePickerResultEvent):
+        selected_recovery.value = (
+            ", ".join(map(lambda f: f.name, e.files)) if e.files else "Cancelled!"
+        ) 
+        global recovery_path
+        recovery_path = e.files[0].path
+        selected_recovery.update()
+            
+    pick_image_dialog = FilePicker(on_result=pick_image_result)
+    pick_recovery_dialog = FilePicker(on_result=pick_recovery_result)
+    selected_image = Text()
+    selected_recovery = Text()
+    page.overlay.append(pick_image_dialog)
+    page.overlay.append(pick_recovery_dialog)
+
+    # Generate the Views for the different steps
+
+    def confirm_button(text: str, confirm_text: str = "Confirm and continue") -> Row:
+        words = text.split(" ")
+        chunk_size = 10
+        if len(words) > chunk_size:
+            n_chunks = len(words) // chunk_size
+            text_field = [Text(f"{' '.join(words[i*chunk_size:(i+1)*chunk_size])}") for i in range(n_chunks)]
+            return Column(text_field + [ElevatedButton(f"{confirm_text}", on_click=confirm)])
+        else:
+            text_field = Text(f"{text}")
+            return Row([text_field, ElevatedButton(f"{confirm_text}", on_click=confirm)])
+    
+    def call_button(text: str, command: str, confirm_text: str = "Confirm and run") -> Row:
+        return Row([
+            Text(f"{text}"),
+            ElevatedButton(f"{confirm_text}", on_click=partial(call_to_phone, command=command))
+        ])
+
+    def get_new_view(title: str, index: int, content: List = []) -> View:
+        return View(
+            f"{index}", [AppBar(title=Text(f"{title}"))] + content
+        )
+
+    # main part
+
+    views = [
+        get_new_view(title="Welcome to OpenAndroidInstaller!", content=[ElevatedButton("Search device", on_click=search_devices)], index=0),
+        get_new_view(title="Pick image and recovery", content=[Row(
+            [
+                ElevatedButton(
+                    "Pick image file",
+                    icon=icons.UPLOAD_FILE,
+                    on_click=lambda _: pick_image_dialog.pick_files(
+                        allow_multiple=False
+                    ),
+                ),
+                selected_image,
+            ]), Row(
+            [
+                ElevatedButton(
+                    "Pick recovery file",
+                    icon=icons.UPLOAD_FILE,
+                    on_click=lambda _: pick_recovery_dialog.pick_files(
+                        allow_multiple=False
+                    ),
+                ),
+                selected_recovery,
+            ]
+
+        ), confirm_button("Done?")], index=1),
+    ]
+
+    page.views.append(views[0])
+    page.update()
+
+
+flet.app(target=main, assets_dir="assets")