Added: Init repo

Author: agnostic-apollo

.github/workflows/attach_apk_to_release.yml

@@ -0,0 +1,74 @@
+name: Attach APK To Release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  attach-apk:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ env.GITHUB_REF }}
+
+      - name: Generate keystore properties
+        run: |
+          if [ ! -z "${{ secrets.KEYSTORE }}" ]; then
+            echo storeFile='keystore.jks' > keystore.properties
+            echo storePassword='${{ secrets.STORE_PASSWORD }}' >> keystore.properties
+            echo keyAlias='${{ secrets.KEY_ALIAS }}' >> keystore.properties
+            echo keyPassword='${{ secrets.KEY_PASSWORD }}' >> keystore.properties
+            echo ${{ secrets.KEYSTORE }} | base64 --decode > keystore.jks # Generated with `base64 -w 0 keystore.jks > keystore.base64`
+          fi
+
+      - name: Build and attach APK to release
+        shell: bash {0}
+        run: |
+          exit_on_error() {
+              echo "$1"
+              echo "Deleting '$RELEASE_VERSION_NAME' release and '$GITHUB_REF' tag"
+              hub release delete "$RELEASE_VERSION_NAME"
+              git push --delete origin "$GITHUB_REF"
+              exit 1
+          }
+
+          echo "Setting vars"
+          RELEASE_VERSION_NAME="${GITHUB_REF/refs\/tags\//}"
+          if ! printf "%s" "${RELEASE_VERSION_NAME/v/}" | grep -qP '^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$'; then
+            exit_on_error "The versionName '${RELEASE_VERSION_NAME/v/}' is not a valid version as per semantic version '2.0.0' spec in the format 'major.minor.patch(-prerelease)(+buildmetadata)'. https://semver.org/spec/v2.0.0.html."
+          fi
+
+          APK_DIR_PATH="./app/build/outputs/apk/release"
+          APK_VERSION_TAG="$RELEASE_VERSION_NAME+github-release"
+          APK_BASENAME_PREFIX="XLogcatManager_$APK_VERSION_TAG"
+
+          echo "Building APK for '$RELEASE_VERSION_NAME' release"
+          export XLOGCATMANAGER_APK_VERSION_TAG="$APK_VERSION_TAG" # Used by app/build.gradle
+          if ! ./gradlew assembleRelease; then
+            exit_on_error "Build failed for '$RELEASE_VERSION_NAME' release."
+          fi
+
+          echo "Validating APK"
+          if ! test -f "$APK_DIR_PATH/${APK_BASENAME_PREFIX}.apk"; then
+            files_found="$(ls "$APK_DIR_PATH")"
+            exit_on_error "Failed to find built APK at '$APK_DIR_PATH/${APK_BASENAME_PREFIX}.apk'. Files found: "$'\n'"$files_found"
+          fi
+
+          echo "Generating sha25sums file"
+          if ! (cd "$APK_DIR_PATH"; sha256sum "${APK_BASENAME_PREFIX}.apk" > sha256sums); then
+            exit_on_error "Generate sha25sums failed for '$RELEASE_VERSION_NAME' release."
+          fi
+
+          echo "Attaching APK to github release"
+          if ! hub release edit \
+          -m "" \
+          -a "$APK_DIR_PATH/${APK_BASENAME_PREFIX}.apk" \
+          -a "$APK_DIR_PATH/sha256sums" \
+          "$RELEASE_VERSION_NAME"; then
+            exit_on_error "Attach APK to release failed for '$RELEASE_VERSION_NAME' release."
+          fi

.github/workflows/debug_build.yml

@@ -0,0 +1,66 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Build APK
+        shell: bash {0}
+        run: |
+          exit_on_error() { echo "$1"; exit 1; }
+
+          echo "Setting vars"
+          # Set RELEASE_VERSION_NAME to "<CURRENT_VERSION_NAME>+<last_commit_hash>"
+          CURRENT_VERSION_NAME_REGEX='\s+versionName "([^"]+)"$'
+          CURRENT_VERSION_NAME="$(grep -m 1 -E "$CURRENT_VERSION_NAME_REGEX" ./app/build.gradle | sed -r "s/$CURRENT_VERSION_NAME_REGEX/\1/")"
+          RELEASE_VERSION_NAME="v$CURRENT_VERSION_NAME+${GITHUB_SHA:0:7}" # The "+" is necessary so that versioning precedence is not affected
+          if ! printf "%s" "${RELEASE_VERSION_NAME/v/}" | grep -qP '^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$'; then
+            exit_on_error "The versionName '${RELEASE_VERSION_NAME/v/}' is not a valid version as per semantic version '2.0.0' spec in the format 'major.minor.patch(-prerelease)(+buildmetadata)'. https://semver.org/spec/v2.0.0.html."
+          fi
+
+          APK_DIR_PATH="./app/build/outputs/apk/debug"
+          APK_VERSION_TAG="$RELEASE_VERSION_NAME-github-debug" # Note the "-", GITHUB_SHA will already have "+" before it
+          APK_BASENAME_PREFIX="XLogcatManager_$APK_VERSION_TAG"
+
+          # Used by attachment steps later
+          echo "APK_DIR_PATH=$APK_DIR_PATH" >> $GITHUB_ENV
+          echo "APK_VERSION_TAG=$APK_VERSION_TAG" >> $GITHUB_ENV
+          echo "APK_BASENAME_PREFIX=$APK_BASENAME_PREFIX" >> $GITHUB_ENV
+
+          echo "Building APK for '$RELEASE_VERSION_NAME' build"
+          export XLOGCATMANAGER_APP_VERSION_NAME="${RELEASE_VERSION_NAME/v/}" # Used by app/build.gradle
+          export XLOGCATMANAGER_APK_VERSION_TAG="$APK_VERSION_TAG" # Used by app/build.gradle
+          if ! ./gradlew assembleDebug; then
+            exit_on_error "Build failed for '$RELEASE_VERSION_NAME' build."
+          fi
+
+          echo "Validating APK"
+          if ! test -f "$APK_DIR_PATH/${APK_BASENAME_PREFIX}.apk"; then
+            files_found="$(ls "$APK_DIR_PATH")"
+            exit_on_error "Failed to find built APK at '$APK_DIR_PATH/${APK_BASENAME_PREFIX}.apk'. Files found: "$'\n'"$files_found"
+          fi
+
+          echo "Generating sha25sums file"
+          if ! (cd "$APK_DIR_PATH"; sha256sum "${APK_BASENAME_PREFIX}.apk" > sha256sums); then
+            exit_on_error "Generate sha25sums failed for '$RELEASE_VERSION_NAME' release."
+          fi
+
+      - name: Attach files
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ env.APK_BASENAME_PREFIX }}
+          path: |
+            ${{ env.APK_DIR_PATH }}/${{ env.APK_BASENAME_PREFIX }}.apk
+            ${{ env.APK_DIR_PATH }}/sha256sums
+            ${{ env.APK_DIR_PATH }}/output-metadata.json

.gitignore

@@ -0,0 +1,17 @@
+*.iml
+.idea/
+
+.gradle/
+
+build/
+captures/
+.externalNativeBuild/
+.cxx/
+
+/local.properties
+
+/keystore.properties
+/keystore.jks
+/keystore.base64
+
+.DS_Store

README.md

@@ -0,0 +1,83 @@
+# XLogcatManager
+
+[![Build status](https://github.com/agnostic-apollo/XLogcatManager/workflows/Build/badge.svg)](https://github.com/agnostic-apollo/XLogcatManager/actions)
+
+XLogcatManager is an Android app to improve [`LogcatManager`](https://cs.android.com/android/platform/superproject/+/android-13.0.0_r3:frameworks/base/services/core/java/com/android/server/logcat) added in Android 13 using Xposed hooks. The app requires a **rooted device** to work.
+
+Android `13` added [`LogcatManager`](https://cs.android.com/android/platform/superproject/+/android-13.0.0_r3:frameworks/base/services/core/java/com/android/server/logcat) which shows a dialog when an app runs `logcat` command that has `READ_LOGS` permission before it is allowed to read system wide logs and access is only allowed for the next `60s`, after which approval is required again. Access dialog will only be shown if the app is on the top, even if it has a foreground service, and access will be denied for all other background apps automatically. On previous android versions, the app only needed to be granted `READ_LOGS` permission once with `adb` or `root` and then could read logs whenever it wanted.
+
+This affects automation apps like [Tasker](https://tasker.joaoapps.com) and terminal apps like [Termux](https://github.com/termux/termux-app) which won't be able to run `logcat` commands with ease anymore, unless granted `adb` or `root` access to run `logcat` commands, which doesn't show the dialog and access is automatically granted. The tasker app in its [recent beta `v6.1.3-beta`](https://www.reddit.com/r/tasker/comments/wqvt5b/dev_tasker_613beta_progress_bar_dialog_change/) has added support to use `adb` or `root` for `logcat` commands, like run for `Logcat Entry` event, because of issues with current design.
+
+The `XLogcatManager` xposed module was created to allow rooted users to not have to grant `adb` or `root` access to apps that shouldn't require it just to read logs by solving `LogcatManager` design issues and some bugs.
+
+**Check the issuetracker at https://issuetracker.google.com/issues/243904932 for more details of the `LogcatManager` design and current bugs.**
+
+Other related links are
+
+- https://issuetracker.google.com/issues/232206670
+
+- https://www.reddit.com/r/tasker/comments/wpt39b/dev_warning_if_you_update_to_android_13_the
+
+- https://twitter.com/MishaalRahman/status/1559930174598270976
+
+The module is based on currently latest Android 13 avd and pixel builds for `July/Aug 2022` and may break depending on changes or fixups made in future builds, **so use at your own risk** and keep checking the github repo for updates. If you get into a bootloop, check [magisk guide](https://topjohnwu.github.io/Magisk/faq.html#q-i-installed-a-module-and-it-bootlooped-my-device-help) for how to disable modules.
+##
+
+
+
+### Contents
+- [Installation](#installation)
+- [Usage](#Usage)
+- [Features](#features)
+##
+
+
+
+### Installation
+
+Latest version is `v0.0.0`.
+
+The APK files of different sources are signed with different signature keys. Do not attempt to mix them together, i.e do not try to install the app from `Github Releases` and then from a different source like `Github Actions`. Android Package Manager will also normally not allow installation of APKs with different signatures and you will get errors on installation like `App not installed`, `Failed to install due to an unknown error`, `INSTALL_FAILED_UPDATE_INCOMPATIBLE`, `INSTALL_FAILED_SHARED_USER_INCOMPATIBLE`, `signatures do not match previously installed version`, etc. This restriction can be bypassed with root or with custom roms.
+
+If you wish to install from a different source, then you must **uninstall the existing XLogcatManager APK** from your device first, then install APK from the new source.
+
+### Github Releases
+
+`XLogcatManager` application official releases can be obtained from [`Github Releases`](https://github.com/agnostic-apollo/XLogcatManager/releases).
+
+The APKs for `Github Releases` will be listed under `Assets` drop-down of a release. These are automatically attached when a new version is released.
+
+### Github Actions
+
+`XLogcatManager` application beta releases can be obtained from [`Github Build`](https://github.com/agnostic-apollo/XLogcatManager/actions/workflows/debug_build.yml) action workflows.
+
+The APKs for `Github Build` action workflows will be listed under `Artifacts` section of a workflow run. These are created for each commit/push done to the repository and can be used by users who don't want to wait for releases and want to try out the latest features immediately or want to test their pull requests. Note that for action workflows, you need to be [**logged into a `Github` account**](https://github.com/login) for the `Artifacts` links to be enabled/clickable. If you are using the [`Github` app](https://github.com/mobile), then make sure to open workflow link in a browser like Chrome or Firefox that has your Github account logged in since the in-app browser may not be logged in.
+
+The APKs are [`debuggable`](https://developer.android.com/studio/debug).
+##
+
+
+### Usage
+
+- Root device with [`Magisk`](https://github.com/topjohnwu/Magisk). Optionally enable [zygisk](https://topjohnwu.github.io/Magisk/guides.html#zygisk) in its settings.
+
+- Install [`LSPosed`](https://github.com/LSPosed/LSPosed#install). [`EdXposed`](https://github.com/ElderDrivers/EdXposed#install) is untested. `EdXposed` and other implementations will not work if they don't have `XposedBridge.deoptimizeMethod()` method implemented, check [`LSPosed/LSPosed#1123`](https://github.com/LSPosed/LSPosed/issues/1123) and [`XposedModule.deoptimizeMethod()`](https://github.com/agnostic-apollo/XLogcatManager/blob/v0.1.0/app/src/main/java/dev/agnosticapollo/xlogcatmanager/xposed/XposedModule.java#L71) for details.
+
+- [Install `XLogcatManager`](#installation) apk and enable it in `LSPosed` modules list. Only Android `System Framework` needs to enabled for module scope. For running on Android `avd`, check [`XposedModule` class javadocs](https://github.com/agnostic-apollo/XLogcatManager/blob/v0.1.0/app/src/main/java/dev/agnosticapollo/xlogcatmanager/xposed/XposedModule.java#L30).
+
+- Reboot device. Rebooting will be required whenever module is installed/updated for changes to take effect.
+
+- If module does not work or to debug issues, check [`logcat`](https://developer.android.com/studio/command-line/logcat). Take `logcat` dump by running `adb logcat -d > logcat.txt` from a PC over `ADB` or `su -c 'logcat -d > /sdcard/logcat.txt'` in an app granted `root` access, like [`Termux`](https://github.com/termux/termux-app). Hooking is done during boot time, so run `logcat` right after boot completes to get related log entries.
+##
+
+
+
+### Features
+
+Current features are listed below. Further configuration options can be added in future when I get time.
+
+- Allows access till next reboot to the app if users selects allow button in the allow access dialog instead of just for the next `60s`.
+- No `60s` timeout to reshow dialog if access was (accidentally) denied by user.
+- The dialog will also show for apps with foreground service instead of just top apps.
+- Fixes the bugs mentioned in the [issuetracker issue](https://issuetracker.google.com/issues/243904932) based on the solutions provided, but implementation is slightly different in some cases due to method hooking limitations. The main classes that do the hooking are [`XLogcatManagerService.java`](https://github.com/agnostic-apollo/XLogcatManager/blob/master/app/src/main/java/dev/agnosticapollo/xlogcatmanager/xposed/logcat/XLogcatManagerService.java) and [`XLogAccessDialogActivity.java`](https://github.com/agnostic-apollo/XLogcatManager/blob/master/app/src/main/java/dev/agnosticapollo/xlogcatmanager/xposed/logcat/XLogAccessDialogActivity.java).
+##

app/build.gradle

@@ -0,0 +1,122 @@
+apply plugin: 'com.android.application'
+
+android {
+    compileSdkVersion project.properties.compileSdkVersion.toInteger()
+
+    def appApkLabel = "XLogcatManager"
+    def appVersionName = System.getenv("XLOGCATMANAGER_APP_VERSION_NAME") ?: ""
+    def apkVersionTag = System.getenv("XLOGCATMANAGER_APK_VERSION_TAG") ?: ""
+
+    // Load keystore.properties file that contains info of the signing key for release build apks
+    // The keystore.properties file should exist in the root directory of the project (not app directory)
+    // It must have the following 4 values in the format:
+    // storeFile=<path to store keystore.jks>
+    // storePassword=<store password>
+    // keyAlias=<key alias>
+    // keyPassword=<key password>
+    def keystorePropertiesFile = rootProject.file("keystore.properties")
+    def keystoreProperties = new Properties()
+    if (keystorePropertiesFile.exists()) {
+        keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
+    }
+
+    defaultConfig {
+        applicationId "dev.agnosticapollo.xlogcatmanager"
+        minSdkVersion project.properties.minSdkVersion.toInteger()
+        targetSdkVersion project.properties.targetSdkVersion.toInteger()
+        versionCode 0
+        versionName "0.0.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+
+        if (appVersionName) versionName = appVersionName
+        validateVersionName(versionName)
+
+        manifestPlaceholders.APP_PACKAGE_NAME = applicationId
+    }
+
+    signingConfigs {
+        release {
+            if (!keystoreProperties.isEmpty()) {
+                storeFile rootProject.file(keystoreProperties['storeFile'])
+                storePassword keystoreProperties['storePassword']
+                keyAlias keystoreProperties['keyAlias']
+                keyPassword keystoreProperties['keyPassword']
+            }
+        }
+
+        debug {
+            storeFile file('dev_keystore.jks')
+            storePassword 'android'
+            keyAlias 'debug'
+            keyPassword 'android'
+        }
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled true
+            shrinkResources false // Reproducible builds
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+            signingConfig signingConfigs.release
+        }
+
+        debug {
+            signingConfig signingConfigs.debug
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    packagingOptions {
+        // Remove terminal-emulator and termux-shared JNI libs added via termux-shared dependency
+        exclude 'lib/*/libtermux.so'
+        exclude 'lib/*/liblocal-socket.so'
+    }
+
+    applicationVariants.all { variant ->
+        variant.outputs.all { output ->
+            if (variant.buildType.name == "debug") {
+                outputFileName = new File(appApkLabel + "_" + (apkVersionTag ? apkVersionTag : "debug") + ".apk")
+            } else if (variant.buildType.name == "release") {
+                outputFileName = new File(appApkLabel + "_" + (apkVersionTag ? apkVersionTag : "release") + ".apk")
+            }
+        }
+    }
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+
+    testImplementation "junit:junit:4.13.2"
+    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+
+    implementation 'com.google.android.material:material:1.6.1'
+    implementation 'androidx.appcompat:appcompat:1.5.0'
+    compileOnly 'de.robv.android.xposed:api:82'
+    //compileOnly 'de.robv.android.xposed:api:82:sources'
+
+    implementation 'com.github.termux.termux-app:termux-shared:211340781b'
+    // Use if below libraries are published locally by termux-app with `./gradlew publishReleasePublicationToMavenLocal` and used with `mavenLocal()`.
+    // If updates are done, republish there and sync project with gradle files here
+    // https://github.com/termux/termux-app/wiki/Termux-Libraries
+    // implementation 'com.termux:termux-shared:0.118.0'
+
+    implementation 'com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava'
+}
+
+task versionName {
+    doLast {
+        print android.defaultConfig.versionName
+    }
+}
+
+static def validateVersionName(String versionName) {
+    // https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+    // ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
+    if (!java.util.regex.Pattern.matches("^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?\$", versionName))
+        throw new IllegalArgumentException("The versionName '" + versionName + "' is not a valid version as per semantic version '2.0.0' spec in the format 'major.minor.patch(-prerelease)(+buildmetadata)'. https://semver.org/spec/v2.0.0.html.")
+}