Added configuration options

README.md

@@ -1,5 +1,5 @@
 # Revanced Builder
-This repo will allow one to build [ReVanced](https://github.com/revanced/) apps automatically and post it to a telegram channel to access and possibly share the builds with friends. It uses [telegram.sh](https://github.com/fabianonline/telegram.sh) to send messages and [telegram-upload](https://github.com/Nekmo/telegram-upload) to upload files (optionally, commented out by default). Make sure that `Java >=17` is installed and selected as default.
+This repo will allow one to build [ReVanced](https://github.com/revanced/) apps automatically and post it to a telegram channel to access and possibly share the builds with friends. It uses [telegram.sh](https://github.com/fabianonline/telegram.sh) to send messages and [telegram-upload](https://github.com/Nekmo/telegram-upload) to upload files (optionally, disabled out by default). Make sure that `Java >=17` is installed and selected as default.
 
 ## How to use
 Just run `./build_revanced <working-directory> (force/clean/experimental/checkonly)`. Might be a good idea to set it up to run periodically using cron. I currently use the following in a user crontab to run it everyday at 6 AM:
@@ -8,9 +8,10 @@ Just run `./build_revanced <working-directory> (force/clean/experimental/checkon
 ```
 
 ## Notes
+- To enable build for a particular apk, copy the `build_settings` file to your working directory and modify it to suit your needs.
 - The script will download the **automatically selected compatible version** (using compatibility of patches as listed [here](https://github.com/revanced/revanced-patches#list-of-available-patches)) of Youtube on APKMirror, **NOT** latest official version on Google Play.
 - Under **NO CIRCUMSTANCES** any APKs will be uploaded to this repository to avoid DMCA.
-- The script assumes that the working directory has the `telegram.sh` script along with a working config file and optionally `telegram-upload` installed and working with the channel link saved in a file called `channel_address`. For their config, look at the links provided on top.
+- If you enable the telegram notifications or uploads, make sure to fill up the config options inside the `build_settings` file. For more information about the config, take at look at the repos of `telegram.sh` and `telegram-upload` provided above.
 - It can also run a post script (if exists) called `post_script.sh`. The `timestamp` would is passed as `$1`.
 - In the current configuration, the script only builds YouTube ReVanced and YouTube Music ReVanced (both nonroot), but it's easy to add support for any other ReVanced app. The code for root builds is included but commented out.
 - All the packages are pulled from [APKMirror](https://apkmirror.com) and GitHub (the `revanced/*` repos).

build_revanced.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Run only one instance of this script at one time
 [ "${BKLOCKER}" != "running" ] && exec env BKLOCKER="running" flock -en "/tmp/revanced-builder.lock" "$0" "$@" || :
@@ -19,7 +19,7 @@ else
 fi
 
 # File containing all patches
-patch_file="$WDIR./chosen_patches.txt"
+patch_file="$WDIR/chosen_patches.txt"
 
 # Returns if $1 is less than $2
 ver_less_than() {
@@ -33,6 +33,18 @@ ver_less_than() {
 SDIR="$(dirname -- "$(readlink -f -- "$0")")"
 cd "$SDIR"
 
+# Read the settings
+if [ -f "$WDIR/build_settings" ]; then
+    source "$WDIR/build_settings"
+else
+    if [ -f "./build_settings"]; then
+        cp ./build_settings "$WDIR/build_settings"
+        source ./build_settings
+    else
+        echo "Could not find the build_settings file!"
+    fi
+fi
+
 # Get line numbers where included & excluded patches start from.
 # We rely on the hardcoded messages to get the line numbers using grep
 excluded_start="$(grep -n -m1 'EXCLUDE PATCHES' "$patch_file" | cut -d':' -f1)"
@@ -48,28 +60,11 @@ included_patches="$(tail -n +$included_start $patch_file | grep '^[^#[:blank:]]'
 # Array for storing patches
 declare -a patches
 
-# # Artifacts associative array aka dictionary
-# declare -A artifacts
-
-# artifacts["revanced-cli.jar"]="revanced/revanced-cli revanced-cli .jar"
-# artifacts["revanced-integrations.apk"]="revanced/revanced-integrations app-release-unsigned .apk"
-# artifacts["revanced-patches.jar"]="revanced/revanced-patches revanced-patches .jar"
-# artifacts["apkeep"]="EFForg/apkeep apkeep-x86_64-unknown-linux-gnu"
-
 # Required artifacts in the format repository-name_filename
 artifacts="revanced/revanced-cli:revanced-cli.jar revanced/revanced-integrations:revanced-integrations.apk revanced/revanced-patches:revanced-patches.jar inotia00/VancedMicroG:microg.apk"
 
 ## Functions
 
-# get_artifact_download_url() {
-#     # Usage: get_download_url <repo_name> <artifact_name> <file_type>
-#     local api_url result
-#     api_url="https://api.github.com/repos/$1/releases/latest"
-#     # shellcheck disable=SC2086
-#     result=$(curl -s $api_url | jq ".assets[] | select(.name | contains(\"$2\") and contains(\"$3\") and (contains(\".sig\") | not)) | .browser_download_url")
-#     echo "${result:1:-1}"
-# }
-
 # Function for populating patches array, using a function here reduces redundancy & satisfies DRY principals
 populate_patches() {
     # Note: <<< defines a 'here-string'. Meaning, it allows reading from variables just like from a file
@@ -151,85 +146,115 @@ fi
 # Download required apk files
 "$SDIR/download_apkmirror.sh" "$WDIR" $2
 
-# # Fetch microG
-# chmod +x apkeep
-
-# if [ ! -f "vanced-microG.apk" ]; then
-#     # Vanced microG 0.2.24.220220
-#     VMG_VERSION="0.2.24.220220"
-
-#     echo "Downloading Vanced microG"
-#     ./apkeep -a com.mgoogle.android.gms@$VMG_VERSION .
-#     mv com.mgoogle.android.gms@$VMG_VERSION.apk vanced-microG.apk
-#     jq ".\"vanced-microG\" = \"$VMG_VERSION\"" versions.json > versions.json.tmp && mv versions.json.tmp versions.json
-# fi
-
 # If the variables are NOT empty, call populate_patches with proper arguments
 [[ ! -z "$excluded_patches" ]] && populate_patches "-e" "$excluded_patches"
 [[ ! -z "$included_patches" ]] && populate_patches "-i" "$included_patches"
 
-echo "************************************"
+# Functions for building the APKs
-echo "Building YouTube APK"
-echo "************************************"
 
-if [ -f "com.google.android.youtube.apk" ]; then
+build_yt_nonroot() {
-    #    echo "Building Root APK"
+    echo "************************************"
-    #    java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar --mount \
+    echo "Building YouTube APK"
-    #        -e microg-support ${patches[@]} \
+    echo "************************************"
-    #        $EXPERIMENTAL \
+    if [ -f "com.google.android.youtube.apk" ]; then
-    #        -a com.google.android.youtube.apk -o build/revanced-yt-root.apk
+        echo "Building Non-root APK"
-    echo "Building Non-root APK"
+        java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar \
-    java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar \
+            ${patches[@]} \
-        ${patches[@]} \
+            $EXPERIMENTAL \
-        $EXPERIMENTAL \
+            -a com.google.android.youtube.apk -o revanced-yt-nonroot.apk
-        -a com.google.android.youtube.apk -o revanced-yt-nonroot.apk
+    else
-else
+        echo "Cannot find YouTube APK, skipping build"
-    echo "Cannot find YouTube APK, skipping build"
+    fi
-fi
+    echo ""
-echo ""
+    echo "************************************"
-echo "************************************"
-echo "Building YouTube Music APK"
-echo "************************************"
-if [ -f "com.google.android.apps.youtube.music.apk" ]; then
-    #    echo "Building Root APK"
-    #    java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar --mount \
-    #        -e microg-support ${patches[@]} \
-    #        $EXPERIMENTAL \
-    #        -a com.google.android.apps.youtube.music.apk -o build/revanced-ytm-root.apk
-    echo "Building Non-root APK"
-    java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar \
-        ${patches[@]} \
-        $EXPERIMENTAL \
-        -a com.google.android.apps.youtube.music.apk -o revanced-ytm-nonroot.apk
-else
-    echo "Cannot find YouTube Music APK, skipping build"
-fi
 
-# Rename files
+    # Rename files
-mv revanced-yt-nonroot.apk YouTube_ReVanced_nonroot_$timestamp.apk
+    mv revanced-yt-nonroot.apk YouTube_ReVanced_nonroot_$timestamp.apk
-mv revanced-ytm-nonroot.apk YouTube_Music_ReVanced_nonroot_$timestamp.apk
+}
-# mv revanced-yt-root.apk YouTube_ReVanced_root_$timestamp.apk
+
-# mv revanced-ytm-root.apk YouTube_Music_ReVanced_root_$timestamp.apk
+build_yt_root() {
+    echo "************************************"
+    echo "Building YouTube APK"
+    echo "************************************"
+    if [ -f "com.google.android.youtube.apk" ]; then
+        echo "Building Root APK"
+        java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar --mount \
+            -e microg-support ${patches[@]} \
+            $EXPERIMENTAL \
+            -a com.google.android.youtube.apk -o revanced-yt-root.apk
+    else
+        echo "Cannot find YouTube APK, skipping build"
+    fi
+    echo ""
+    echo "************************************"
+
+    # Rename files
+    mv revanced-yt-root.apk YouTube_ReVanced_root_$timestamp.apk
+}
+
+build_ytm_nonroot() {
+    echo "Building YouTube Music APK"
+    echo "************************************"
+    if [ -f "com.google.android.apps.youtube.music.apk" ]; then
+        echo "Building Non-root APK"
+        java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar \
+            ${patches[@]} \
+            $EXPERIMENTAL \
+            -a com.google.android.apps.youtube.music.apk -o revanced-ytm-nonroot.apk
+    else
+        echo "Cannot find YouTube Music APK, skipping build"
+    fi
+
+    # Rename files
+    mv revanced-ytm-nonroot.apk YouTube_Music_ReVanced_nonroot_$timestamp.apk
+}
+
+build_ytm_root() {
+    echo "Building YouTube Music APK"
+    echo "************************************"
+    if [ -f "com.google.android.apps.youtube.music.apk" ]; then
+        echo "Building Root APK"
+        java -jar revanced-cli.jar -m revanced-integrations.apk -b revanced-patches.jar --mount \
+            -e microg-support ${patches[@]} \
+            $EXPERIMENTAL \
+            -a com.google.android.apps.youtube.music.apk -o revanced-ytm-root.apk
+    else
+        echo "Cannot find YouTube Music APK, skipping build"
+    fi
+
+    # Rename files
+    mv revanced-ytm-root.apk YouTube_Music_ReVanced_root_$timestamp.apk
+}
+
+# Check the config and build accordingly
+$YT_NONROOT && build_yt_nonroot
+$YT_ROOT && build_yt_root
+$YTM_NONROOT && build_ytm_nonroot
+$YTM_ROOT && build_ytm_root
 
 # Send telegram message about the new build
 echo "Sending messages to telegram"
 
-# telegram-upload uses personal account, hence bypassing 50 MB max upload limit of bots
+if $TG_UPLOAD; then
-# channel_address=$(cat channel_address | sed -z '$ s/\n$//')
+    # telegram-upload uses personal account, hence bypassing 50 MB max upload limit of bots
-# /home/sintan/.local/bin/telegram-upload YouTube_ReVanced_nonroot_$timestamp.apk YouTube_Music_ReVanced_nonroot_$timestamp.apk --to "$channel_address" --caption "" && sent=true
+    [ "$CHANNEL_ADDRESS" == "" ] && echo "Please provide valid channel address in the settings!"
+    /home/sintan/.local/bin/telegram-upload YouTube_ReVanced_nonroot_$timestamp.apk YouTube_Music_ReVanced_nonroot_$timestamp.apk --to "$CHANNEL_ADDRESS" --caption "" && sent=true
+fi
 
-# telegram.sh uses bot account, but it supports formatted messages
+if $TG_NOTIFICATIONS; then
-msg=$(cat versions.json | tail -n+2 | head -n-1 | cut -c3- | sed "s/\"//g" | sed "s/,//g" | sed "s/com.google.android.apps.youtube.music/YouTube Music/" |
+    # telegram.sh uses bot account, but it supports formatted messages
-    sed "s/com.google.android.youtube/YouTube/" | sed "s/VancedMicroG/Vanced microG/" | sed "s/revanced-/ReVanced /g" | sed "s/patches/Patches/" |
+    [[ "$TELEGRAM_TOKEN" == "" || "$TELEGRAM_CHAT" == "" ]] && echo "Please provide valid channel address in the settings!"
-    sed "s/cli/CLI/" | sed "s/integrations/Integrations/" | awk 1 ORS=$'\n') # I know, it's a hacky solution
+    msg=$(cat versions.json | tail -n+2 | head -n-1 | cut -c3- | sed "s/\"//g" | sed "s/,//g" | sed "s/com.google.android.apps.youtube.music/YouTube Music/" |
-# [ $sent ] &&
+        sed "s/com.google.android.youtube/YouTube/" | sed "s/VancedMicroG/Vanced microG/" | sed "s/revanced-/ReVanced /g" | sed "s/patches/Patches/" |
-./telegram.sh -T "⚙⚙⚙ Build Details ⚙⚙⚙" -M "$msg"$'\n'"Timestamp: $timestamp"$'\n'"⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯"
+        sed "s/cli/CLI/" | sed "s/integrations/Integrations/" | awk 1 ORS=$'\n') # I know, it's a hacky solution
-[ $microg_updated ] && ./telegram.sh -M "_An update of microg was published._"
+    # [ $sent ] &&
+    ./telegram.sh -T "⚙⚙⚙ Build Details ⚙⚙⚙" -M "$msg"$'\n'"Timestamp: $timestamp"$'\n'"⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯" -t "$TELEGRAM_TOKEN" -c "$TELEGRAM_CHAT"
+    [ $microg_updated ] && ./telegram.sh -M "_An update of microg was published._" -t "$TELEGRAM_TOKEN" -c "$TELEGRAM_CHAT"
+fi
 
 # Do some cleanup, keep only the last 3 build's worth of files and a week worth of logs
 mkdir -p archive
-mv YouTube_ReVanced_nonroot_$timestamp.apk archive/
+mv *ReVanced_*_$timestamp.apk archive/
-mv YouTube_Music_ReVanced_nonroot_$timestamp.apk archive/
 find ./archive -maxdepth 1 -type f -printf '%Ts\t%P\n' |
     sort -rn |
     tail -n +7 |

build_settings

@@ -0,0 +1,22 @@
+# These are the currently supported apps that can be built
+# Make a copy of this to your working directory
+# Then change the default values to enable/disable building them
+YT_NONROOT=true
+YTM_NONROOT=true
+YT_ROOT=false
+YTM_ROOT=false
+
+# Settings for sending Telegram notification using telegram.sh
+# In case you decide to use it, please put valid config in the
+# TOKEN and CHAT fields
+# Check out README for instructions
+TG_NOTIFICATIONS=false
+TELEGRAM_TOKEN=""
+TELEGRAM_CHAT=""
+
+# Settings for uploading the files through telegram-upload
+# In case you decide to use it, please put valid config in the
+# CHANNEL_ADDRESS field
+# Check out README for instructions
+TG_UPLOAD=false
+CHANNEL_ADDRESS=""

download_apkmirror.sh

@@ -7,6 +7,9 @@ apks["com.google.android.apps.youtube.music"]=dl_ytm
 
 flag=$2
 
+# Read the settings
+source "$1/build_settings"
+
 ## Functions
 
 # Wget user agent
@@ -29,9 +32,9 @@ req() { wget -nv -O "$2" --header="$WGET_HEADER" "$1"; }
 
 # Returns if $1 is less than $2
 ver_less_than() {
-    [ ${1:0:1} == "v" ] && var1=${1:1} || var1=$1
+	[ ${1:0:1} == "v" ] && var1=${1:1} || var1=$1
-    [ ${2:0:1} == "v" ] && var2=${2:1} || var2=$2
+	[ ${2:0:1} == "v" ] && var2=${2:1} || var2=$2
-    [ $(echo $var1$'\n'$var2 | sort -V | tail -n1) != $var1 ] && echo true || echo false
+	[ $(echo $var1$'\n'$var2 | sort -V | tail -n1) != $var1 ] && echo true || echo false
 }
 
 # Wget download apk
@@ -62,7 +65,7 @@ dl_yt() {
 		"$base_apk")
 	echo "YouTube version: ${last_ver}"
 	echo "downloaded from: [APKMirror - YouTube]($dl_url)"
-	jq ".\"$apk\" = \"$last_ver\"" versions.json > versions.json.tmp && mv versions.json.tmp versions.json
+	jq ".\"$apk\" = \"$last_ver\"" versions.json >versions.json.tmp && mv versions.json.tmp versions.json
 }
 
 # Architectures
@@ -93,30 +96,34 @@ dl_ytm() {
 		"$base_apk")
 	echo "\nYouTube Music (${arch}) version: ${last_ver}"
 	echo "downloaded from: [APKMirror - YouTube Music ${arch}]($dl_url)"
-	jq ".\"$apk\" = \"$last_ver\"" versions.json > versions.json.tmp && mv versions.json.tmp versions.json
+	jq ".\"$apk\" = \"$last_ver\"" versions.json >versions.json.tmp && mv versions.json.tmp versions.json
 }
 
 # Get into the build directory
 
 if [ -d "$1" ]; then
-    cd "$1"
+	cd "$1"
 else
-    echo "Working directory not provided"
+	echo "Working directory not provided"
-    exit -1
+	exit -1
 fi
 
 ## Main
 try=0
-while : ; do
+while :; do
-	try=$(($try+1))
+	try=$(($try + 1))
 	[ $try -gt 10 ] && echo "API error!" && exit 3
 	curl -X 'GET' 'https://releases.revanced.app/patches' -H 'accept: application/json' -o patches.json
 	cat patches.json | jq -e '.error' >/dev/null 2>&1 || break
-	echo "API failure, trying again. $((10-$try)) tries left..."
+	echo "API failure, trying again. $((10 - $try)) tries left..."
 	sleep 10
 done
 
 for apk in "${!apks[@]}"; do
+	# Skip if app not specified for build
+	[[ "$apk" == "com.google.android.youtube" && "$YT_NONROOT" == false && "$YT_ROOT" == false ]] && continue
+	[[ "$apk" == "com.google.android.apps.youtube.music" && "$YTM_NONROOT" == false && "$YTM_ROOT" == false ]] && continue
+
 	echo "Checking $apk"
 	supported_vers="$(jq -r '.[].compatiblePackages[] | select(.name == "'$apk'") | .versions | last' patches.json)"
 	version=0