Merge pull request #11 from arovlad/development

added magisk module

Author: arovlad

README.md

@@ -2,11 +2,13 @@
 
 In order for Bromite SystemWebView to be [installed](https://github.com/bromite/bromite/wiki/Installing-SystemWebView), it must be one of the supported webviews hardcoded in the framework package. Since ROMs typically don't include Bromite SystemWebView among them, the community has developed some methods that allow the framework to be patched in order to include it.
 
-This package makes use of a [resource overlay](https://source.android.com/docs/core/architecture/rros) to replace the list of hardcoded webviews with one that also includes the Bromite WebView. I personally find this method more straightforward and elegant, as it does not require root access nor the tedious process of installing Magisk modules or patching the system framework itself manually — if anything breaks the package can simply be removed. Moreover, the WebView itself does not need to be installed as a system app and has no potential risk of breaking SafetyNet.
+This package makes use of a [resource overlay](https://source.android.com/docs/core/architecture/rros) to replace the list of hardcoded webviews with one that also includes the Bromite WebView. This method is more straightforward and elegant, as it does not require a rooted device nor the tedious process of installing Magisk modules or patching the system framework itself manually — if anything breaks the package can simply be removed. Moreover, the WebView itself does not need to be installed as a system app and has no potential risk of breaking SafetyNet — e.g. you can install it directly from F-Droid.
+
+Some users have experienced issues with this installation process, so an overlay packaged as a [Magisk module](#magisk) is also provided. It is included for convenience only, and undergoes less frequent testing as the main developer does not endorse Magisk. The officially-endorsed and tested installation method still remains [installing via recovery](#installation).
 
 ![The WebView implementation settings with the Bromite SystemWebView Overlay installed](screenshot.png)
 
-Although this method should work on all Android versions that support Bromite and it's WebView, **currently testing has only been done on LineageOS 19.1 for MicroG based on Android 12.1**.
+Although this method should work on all Android versions that support Bromite and its WebView, **currently testing has only been done on LineageOS 19.1 for MicroG based on Android 12.1**.
 
 ## Prerequisites
 
@@ -59,6 +61,14 @@ To ensure that the package is installed for both profiles install the package vi
 * If everything is ok, you should see the following message:  
 `org.bromite.webview is NOT installed.`
 
+### Magisk
+
+`BromiteSystemWebViewMagisk.zip` can be installed directly as a Magisk module. Simply copy it on your device, then install it via the normal Magisk UI.
+
+Its main use case is for when you have Magisk already installed, where it works around an issue where some ROMs — in particular MicroG ROMs — do not have enough reserved partition space to install addons. This makes the previous installation options fail, sometimes in non-obvious ways. (Details in arovlad/bromite-webview-overlay#5 and lineageos4microg/docker-lineage-cicd#358)
+
+It performs steps similar to the above, i.e. installs `treble-overlay-bromite-webview.apk` into `/vendor/overlay`, but as a Magisk module. The overlay is performed dynamically by Magisk at boot time, instead of directly modifying the vendor partition (until the next system update overwrites these changes). The OTA survival script is therefore not needed, as Magisk modules are not overwritten by system updates.
+
 ## Building
 
 The following dependencies are required:
@@ -76,6 +86,3 @@ Alternatively, you can read a more in-depth guide [here](https://github.com/phhu
 ## Credits
 
 * [Pierre-Hugues Husson](https://github.com/phhusson) for the guide and toolkit
-
-
-

build.sh

@@ -1,22 +1,35 @@
 #!/bin/bash
+set -e
 
+if [ ! -f build/build.sh ]; then
 echo "Downloading toolkit"
-mv .git .git.bak &> /dev/null
-git init &> /dev/null
-git remote add origin https://github.com/phhusson/vendor_hardware_overlay.git &> /dev/null
-git fetch --depth=1 &> /dev/null
-git checkout origin/pie build &> /dev/null
-rm -f -r .git
-mv .git.bak .git &> /dev/null
-build/build.sh
-echo "Building flashable package"
+git clone --depth=1 https://github.com/phhusson/vendor_hardware_overlay.git
+( cd vendor_hardware_overlay && git checkout origin/pie build && mv build .. )
+fi
+
+echo "Building overlay APK"
+( cd build && ./build.sh ../BromiteWebView/Android.mk )
+
+echo "Building flashable package (zip)"
 mkdir build/.temp
 mkdir -p build/.temp/META-INF/com/google/android
 cp update-binary build/.temp/META-INF/com/google/android
-echo "# Dummy file; update-binary is a shell script." > build/.temp/META-INF/com/google/android/update-script
+echo "# Dummy file; update-binary is a shell script." > build/.temp/META-INF/com/google/android/updater-script
 mkdir -p build/.temp/system/addon.d
 cp 99-bromite-webview.sh build/.temp/system/addon.d
 mkdir -p build/.temp/vendor/overlay
 cp build/treble-overlay-bromite-webview.apk build/.temp/vendor/overlay
-( cd build/.temp && zip -r ../BromiteSystemWebViewOverlay.zip . ) &> /dev/null
+( cd build/.temp && zip -r - . > ../BromiteSystemWebViewOverlay.zip . ) &> /dev/null
+rm -r build/.temp
+
+echo "Building Magisk module (zip)"
+mkdir build/.temp
+mkdir -p build/.temp/META-INF/com/google/android
+curl -sL https://github.com/topjohnwu/Magisk/raw/master/scripts/module_installer.sh > build/.temp/META-INF/com/google/android/update-binary
+test -s build/.temp/META-INF/com/google/android/update-binary
+echo "#MAGISK" > build/.temp/META-INF/com/google/android/updater-script
+mkdir -p build/.temp/system/vendor/overlay
+cp build/treble-overlay-bromite-webview.apk build/.temp/system/vendor/overlay
+cp module.prop build/.temp/
+( cd build/.temp && zip -r - . > ../BromiteSystemWebViewMagisk.zip . ) &> /dev/null
 rm -r build/.temp

module.prop

@@ -0,0 +1,6 @@
+id=bromite-system-webview
+name=Bromite System WebView Overlay
+version=v0.3
+versionCode=00003
+author=arovlad
+description=Enable the use of Bromite as the system WebView