├── .github ├── ISSUE_TEMPLATE │ ├── bug-issue.yml │ ├── config.yml │ └── feature-issue.yml ├── config.yml └── workflows │ └── discord_ping_on_release.yml ├── .gitignore ├── .releaserc ├── CHANGELOG.md ├── LICENSE ├── README.md ├── build.gradle.kts ├── docs ├── 0_prerequisites.md ├── 1_usage.md └── README.md ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── package-lock.json ├── package.json ├── settings.gradle.kts └── src ├── main └── kotlin │ └── app │ └── revanced │ ├── cli │ ├── command │ │ └── MainCommand.kt │ ├── logging │ │ ├── CliLogger.kt │ │ └── impl │ │ │ ├── DefaultCliLogger.kt │ │ │ └── FlushingStreamHandler.kt │ ├── main │ │ └── Main.kt │ ├── patcher │ │ └── logging │ │ │ └── impl │ │ │ └── PatcherLogger.kt │ └── signing │ │ └── SigningOptions.kt │ └── utils │ ├── Options.kt │ ├── adb │ ├── Adb.kt │ ├── Commands.kt │ └── Constants.kt │ └── apk │ └── ApkSigner.kt └── test └── kotlin └── app └── revanced └── patcher └── options └── PatchOptionOptionsTest.kt /.github/ISSUE_TEMPLATE/bug-issue.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug report 2 | description: Report a very clearly broken issue. 3 | title: 'bug: ' 4 | labels: [bug] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | # ReVanced bug report 10 | 11 | Important to note that your issue may have already been reported before. Please check for existing issues [here](https://github.com/revanced/revanced-cli/labels/bug). 12 | 13 | - type: dropdown 14 | attributes: 15 | label: Type 16 | options: 17 | - Error while running the CLI 18 | - Error at runtime 19 | - Cosmetic 20 | - Other 21 | validations: 22 | required: true 23 | - type: textarea 24 | attributes: 25 | label: Bug description 26 | description: How did you find the bug? Any additional details that might help? 27 | validations: 28 | required: true 29 | - type: textarea 30 | attributes: 31 | label: Steps to reproduce 32 | description: Add the steps to reproduce this bug including your environment. 33 | placeholder: Step 1. Download some files. Step 2. ... 34 | validations: 35 | required: true 36 | - type: textarea 37 | attributes: 38 | label: Relevant log output 39 | description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. 40 | render: shell 41 | validations: 42 | required: true 43 | - type: textarea 44 | attributes: 45 | label: Screenshots or videos 46 | description: Add screenshots or videos that show the bug here. 47 | placeholder: Drag and drop the screenshots/videos into this box. 48 | validations: 49 | required: false 50 | - type: textarea 51 | attributes: 52 | label: Solution 53 | description: If applicable, add a possible solution. 54 | validations: 55 | required: false 56 | - type: textarea 57 | attributes: 58 | label: Additional context 59 | description: Add additional context here. 60 | validations: 61 | required: false 62 | - type: checkboxes 63 | id: acknowledgements 64 | attributes: 65 | label: Acknowledgements 66 | description: Your issue will be closed if you haven't done these steps. 67 | options: 68 | - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue. 69 | required: true 70 | - label: I have written a short but informative title. 71 | required: true 72 | - label: I filled out all of the requested information in this issue properly. 73 | required: true -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: 📃 Documentation 4 | url: https://github.com/revanced/revanced-documentation/ 5 | about: Don't know how or where to start? Check out our documentation! 6 | - name: 🗨 Discussions 7 | url: https://github.com/revanced/revanced-suggestions/discussions 8 | about: Got something you think should change or be added? Search for or start a new discussion! -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-issue.yml: -------------------------------------------------------------------------------- 1 | name: ⭐ Feature request 2 | description: Create a detailed feature request. 3 | title: 'feat: <title>' 4 | labels: [feature-request] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | # ReVanced feature request 10 | 11 | Do not submit requests for patches here. Please submit them [here](https://github.com/orgs/revanced/discussions/categories/patches) instead. 12 | Important to note that your feature request may have already been made before. Please check for existing feature requests [here](https://github.com/revanced/revanced-cli/labels/feature-request). 13 | 14 | - type: dropdown 15 | attributes: 16 | label: Type 17 | options: 18 | - Functionality 19 | - Cosmetic 20 | - Other 21 | validations: 22 | required: true 23 | - type: textarea 24 | attributes: 25 | label: Issue 26 | description: What is the current problem. Why does it require a feature request? 27 | validations: 28 | required: true 29 | - type: textarea 30 | attributes: 31 | label: Feature 32 | description: Describe your feature in detail. How does it solve the issue? 33 | validations: 34 | required: true 35 | - type: textarea 36 | attributes: 37 | label: Motivation 38 | description: Why should your feature should be considered? 39 | validations: 40 | required: true 41 | - type: textarea 42 | attributes: 43 | label: Additional context 44 | description: Add additional context here. 45 | validations: 46 | required: false 47 | - type: checkboxes 48 | id: acknowledgements 49 | attributes: 50 | label: Acknowledgements 51 | description: Your issue will be closed if you haven't done these steps. 52 | options: 53 | - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue. 54 | required: true 55 | - label: I have written a short but informative title. 56 | required: true 57 | - label: I filled out all of the requested information in this issue properly. 58 | required: true -------------------------------------------------------------------------------- /.github/config.yml: -------------------------------------------------------------------------------- 1 | firstPRMergeComment: > 2 | Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role. 3 | -------------------------------------------------------------------------------- /.github/workflows/discord_ping_on_release.yml: -------------------------------------------------------------------------------- 1 | name: Ping Discord on release 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | notify-discord: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: sarisia/actions-status-discord@v1 12 | if: always() 13 | with: 14 | webhook: ${{ secrets.DISCORD_WEBHOOK_URL }} 15 | username: ReVanced Extended 16 | color: 0xff5252 17 | nodetail: true 18 | notimestamp: true 19 | content: "<@&1271215152246689904>" 20 | title: "ARSClib CLI `${{ github.event.release.tag_name }}` has been released!" 21 | description: | 22 | Click [here](${{ github.event.release.html_url }}) to download it and read the changelog. 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Java template 2 | # Compiled class file 3 | *.class 4 | 5 | # Log file 6 | *.log 7 | 8 | # BlueJ files 9 | *.ctxt 10 | 11 | # Mobile Tools for Java (J2ME) 12 | .mtj.tmp/ 13 | 14 | # Package Files # 15 | *.jar 16 | *.war 17 | *.nar 18 | *.ear 19 | *.zip 20 | *.tar.gz 21 | *.rar 22 | 23 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 24 | hs_err_pid* 25 | 26 | ### JetBrains template 27 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 28 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 29 | 30 | # User-specific stuff 31 | .idea/**/workspace.xml 32 | .idea/**/tasks.xml 33 | .idea/**/usage.statistics.xml 34 | .idea/**/dictionaries 35 | .idea/**/shelf 36 | 37 | # Generated files 38 | .idea/**/contentModel.xml 39 | 40 | # Sensitive or high-churn files 41 | .idea/**/dataSources/ 42 | .idea/**/dataSources.ids 43 | .idea/**/dataSources.local.xml 44 | .idea/**/sqlDataSources.xml 45 | .idea/**/dynamic.xml 46 | .idea/**/uiDesigner.xml 47 | .idea/**/dbnavigator.xml 48 | 49 | # Gradle 50 | .idea/**/gradle.xml 51 | .idea/**/libraries 52 | 53 | # Gradle and Maven with auto-import 54 | # When using Gradle or Maven with auto-import, you should exclude module files, 55 | # since they will be recreated, and may cause churn. Uncomment if using 56 | # auto-import. 57 | .idea/artifacts 58 | .idea/compiler.xml 59 | .idea/jarRepositories.xml 60 | .idea/modules.xml 61 | .idea/*.iml 62 | .idea/modules 63 | *.iml 64 | *.ipr 65 | 66 | # CMake 67 | cmake-build-*/ 68 | 69 | # Mongo Explorer plugin 70 | .idea/**/mongoSettings.xml 71 | 72 | # File-based project format 73 | *.iws 74 | 75 | # IntelliJ 76 | out/ 77 | .idea 78 | 79 | # mpeltonen/sbt-idea plugin 80 | .idea_modules/ 81 | 82 | # JIRA plugin 83 | atlassian-ide-plugin.xml 84 | 85 | # Cursive Clojure plugin 86 | .idea/replstate.xml 87 | 88 | # Crashlytics plugin (for Android Studio and IntelliJ) 89 | com_crashlytics_export_strings.xml 90 | crashlytics.properties 91 | crashlytics-build.properties 92 | fabric.properties 93 | 94 | # Editor-based Rest Client 95 | .idea/httpRequests 96 | 97 | # Android studio 3.1+ serialized cache file 98 | .idea/caches/build_file_checksums.ser 99 | 100 | ### Gradle template 101 | .gradle 102 | **/build/ 103 | !src/**/build/ 104 | 105 | # Ignore Gradle GUI config 106 | gradle-app.setting 107 | 108 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 109 | !gradle-wrapper.jar 110 | 111 | # Cache of project 112 | .gradletasknamecache 113 | 114 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 115 | # gradle/wrapper/gradle-wrapper.properties 116 | 117 | # Dependency directories 118 | node_modules/ 119 | 120 | # ReVanced CLI 121 | revanced-cache/ 122 | options.toml -------------------------------------------------------------------------------- /.releaserc: -------------------------------------------------------------------------------- 1 | { 2 | "branches": [ 3 | "main", 4 | { 5 | "name": "dev", 6 | "prerelease": true 7 | } 8 | ], 9 | "plugins": [ 10 | [ 11 | "@semantic-release/commit-analyzer", { 12 | "releaseRules": [ 13 | { "type": "build", "scope": "revanced-patcher", "release": "patch" } 14 | ] 15 | } 16 | ], 17 | "@semantic-release/release-notes-generator", 18 | "@semantic-release/changelog", 19 | "gradle-semantic-release-plugin", 20 | [ 21 | "@semantic-release/git", 22 | { 23 | "assets": [ 24 | "CHANGELOG.md", 25 | "gradle.properties" 26 | ] 27 | } 28 | ], 29 | [ 30 | "@semantic-release/github", 31 | { 32 | "assets": [ 33 | { 34 | "path": "build/libs/*all.jar" 35 | } 36 | ], 37 | successComment: false 38 | } 39 | ], 40 | [ 41 | "@saithodev/semantic-release-backmerge", 42 | { 43 | backmergeBranches: [{"from": "main", "to": "dev"}], 44 | clearWorkspace: true 45 | } 46 | ] 47 | ] 48 | } 49 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## [2.21.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.1...v2.21.2-dev.1) (2023-05-07) 2 | 3 | ## [2.21.1](https://github.com/revanced/revanced-cli/compare/v2.21.0...v2.21.1) (2023-05-06) 4 | 5 | ## [2.21.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.21.0...v2.21.1-dev.1) (2023-05-06) 6 | 7 | # [2.21.0](https://github.com/revanced/revanced-cli/compare/v2.20.2...v2.21.0) (2023-05-04) 8 | 9 | 10 | ### Bug Fixes 11 | 12 | * **tests:** set order of tests ([2ef48af](https://github.com/revanced/revanced-cli/commit/2ef48af1b339ab729a05d69cb0c8c1ee1e3ab486)) 13 | * use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([da2c918](https://github.com/revanced/revanced-cli/commit/da2c91874d5623402febfcc0677ada3d648565e1)) 14 | 15 | 16 | ### Features 17 | 18 | * add appreciation message for new contributors ([6962fc2](https://github.com/revanced/revanced-cli/commit/6962fc2f4c0f0c96e88a823be64f8ebd1312ee17)) 19 | 20 | # [2.21.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.2...v2.21.0-dev.1) (2023-05-04) 21 | 22 | 23 | ### Bug Fixes 24 | 25 | * **tests:** set order of tests ([2ef48af](https://github.com/revanced/revanced-cli/commit/2ef48af1b339ab729a05d69cb0c8c1ee1e3ab486)) 26 | * use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([da2c918](https://github.com/revanced/revanced-cli/commit/da2c91874d5623402febfcc0677ada3d648565e1)) 27 | 28 | 29 | ### Features 30 | 31 | * add appreciation message for new contributors ([6962fc2](https://github.com/revanced/revanced-cli/commit/6962fc2f4c0f0c96e88a823be64f8ebd1312ee17)) 32 | 33 | ## [2.20.2](https://github.com/revanced/revanced-cli/compare/v2.20.1...v2.20.2) (2023-04-30) 34 | 35 | 36 | ### Bug Fixes 37 | 38 | * correct spelling mistake ([31fb316](https://github.com/revanced/revanced-cli/commit/31fb3166d922ae1f568f52e44cbe726dd1c891a4)) 39 | 40 | ## [2.20.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.1...v2.20.2-dev.1) (2023-04-03) 41 | 42 | 43 | ### Bug Fixes 44 | 45 | * correct spelling mistake ([31fb316](https://github.com/revanced/revanced-cli/commit/31fb3166d922ae1f568f52e44cbe726dd1c891a4)) 46 | 47 | ## [2.20.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1) (2023-03-14) 48 | 49 | 50 | ### Bug Fixes 51 | 52 | * correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51)) 53 | 54 | ## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-05) 55 | 56 | 57 | ### Bug Fixes 58 | 59 | * correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51)) 60 | 61 | ## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-03) 62 | 63 | 64 | ### Bug Fixes 65 | 66 | * correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51)) 67 | 68 | ## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-02) 69 | 70 | 71 | ### Bug Fixes 72 | 73 | * correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51)) 74 | 75 | # [2.20.0](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0) (2023-01-18) 76 | 77 | 78 | ### Bug Fixes 79 | 80 | * bump patcher dependency version ([51c04b7](https://github.com/revanced/revanced-cli/commit/51c04b7b162ad2876bbeb248b7ccddd105b5076d)) 81 | * do not list compatible packages if patches do not define them ([31e4a41](https://github.com/revanced/revanced-cli/commit/31e4a41dd20f5fa62f840cd8e3b92fe0814eda87)) 82 | 83 | 84 | ### Features 85 | 86 | * connect to first device if given device was not found ([6485e47](https://github.com/revanced/revanced-cli/commit/6485e477a10bb89dfb2e40f3596d72b20bf23cc8)) 87 | * remove option `--with-descriptions` ([07a423b](https://github.com/revanced/revanced-cli/commit/07a423b19ec72e9f020aeb0222f4ced571036dbe)) 88 | 89 | # [2.20.0](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0) (2023-01-17) 90 | 91 | 92 | ### Bug Fixes 93 | 94 | * bump patcher dependency version ([51c04b7](https://github.com/revanced/revanced-cli/commit/51c04b7b162ad2876bbeb248b7ccddd105b5076d)) 95 | * do not list compatible packages if patches do not define them ([31e4a41](https://github.com/revanced/revanced-cli/commit/31e4a41dd20f5fa62f840cd8e3b92fe0814eda87)) 96 | 97 | 98 | ### Features 99 | 100 | * connect to first device if given device was not found ([6485e47](https://github.com/revanced/revanced-cli/commit/6485e477a10bb89dfb2e40f3596d72b20bf23cc8)) 101 | * remove option `--with-descriptions` ([07a423b](https://github.com/revanced/revanced-cli/commit/07a423b19ec72e9f020aeb0222f4ced571036dbe)) 102 | 103 | # [2.20.0-dev.3](https://github.com/revanced/revanced-cli/compare/v2.20.0-dev.2...v2.20.0-dev.3) (2023-01-15) 104 | 105 | 106 | ### Bug Fixes 107 | 108 | * bump patcher dependency version ([51c04b7](https://github.com/revanced/revanced-cli/commit/51c04b7b162ad2876bbeb248b7ccddd105b5076d)) 109 | 110 | # [2.20.0-dev.2](https://github.com/revanced/revanced-cli/compare/v2.20.0-dev.1...v2.20.0-dev.2) (2023-01-15) 111 | 112 | 113 | ### Features 114 | 115 | * connect to first device if given device was not found ([6485e47](https://github.com/revanced/revanced-cli/commit/6485e477a10bb89dfb2e40f3596d72b20bf23cc8)) 116 | 117 | # [2.20.0](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0) (2023-01-02) 118 | 119 | 120 | ### Bug Fixes 121 | 122 | * do not list compatible packages if patches do not define them ([31e4a41](https://github.com/revanced/revanced-cli/commit/31e4a41dd20f5fa62f840cd8e3b92fe0814eda87)) 123 | 124 | 125 | ### Features 126 | 127 | * remove option `--with-descriptions` ([07a423b](https://github.com/revanced/revanced-cli/commit/07a423b19ec72e9f020aeb0222f4ced571036dbe)) 128 | 129 | # [2.20.0](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0) (2023-01-01) 130 | 131 | 132 | ### Bug Fixes 133 | 134 | * do not list compatible packages if patches do not define them ([31e4a41](https://github.com/revanced/revanced-cli/commit/31e4a41dd20f5fa62f840cd8e3b92fe0814eda87)) 135 | 136 | 137 | ### Features 138 | 139 | * remove option `--with-descriptions` ([07a423b](https://github.com/revanced/revanced-cli/commit/07a423b19ec72e9f020aeb0222f4ced571036dbe)) 140 | 141 | # [2.20.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0-dev.1) (2023-01-01) 142 | 143 | 144 | ### Bug Fixes 145 | 146 | * do not list compatible packages if patches do not define them ([31e4a41](https://github.com/revanced/revanced-cli/commit/31e4a41dd20f5fa62f840cd8e3b92fe0814eda87)) 147 | 148 | 149 | ### Features 150 | 151 | * remove option `--with-descriptions` ([07a423b](https://github.com/revanced/revanced-cli/commit/07a423b19ec72e9f020aeb0222f4ced571036dbe)) 152 | 153 | # [2.19.0](https://github.com/revanced/revanced-cli/compare/v2.18.2...v2.19.0) (2022-12-31) 154 | 155 | 156 | ### Features 157 | 158 | * improve description of options ([#185](https://github.com/revanced/revanced-cli/issues/185)) ([b69e784](https://github.com/revanced/revanced-cli/commit/b69e784785f7f262f83b35c4f241c90036169fc7)) 159 | 160 | # [2.19.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.18.2...v2.19.0-dev.1) (2022-12-31) 161 | 162 | 163 | ### Features 164 | 165 | * improve description of options ([#185](https://github.com/revanced/revanced-cli/issues/185)) ([b69e784](https://github.com/revanced/revanced-cli/commit/b69e784785f7f262f83b35c4f241c90036169fc7)) 166 | 167 | ## [2.18.2](https://github.com/revanced/revanced-cli/compare/v2.18.1...v2.18.2) (2022-12-16) 168 | 169 | 170 | ### Bug Fixes 171 | 172 | * exclude patcher dependency from minimizing ([d5794b9](https://github.com/revanced/revanced-cli/commit/d5794b94ca19c9287190a3b863c97a089893cc07)) 173 | 174 | ## [2.18.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.18.1...v2.18.2-dev.1) (2022-12-16) 175 | 176 | 177 | ### Bug Fixes 178 | 179 | * exclude patcher dependency from minimizing ([d5794b9](https://github.com/revanced/revanced-cli/commit/d5794b94ca19c9287190a3b863c97a089893cc07)) 180 | 181 | ## [2.18.1](https://github.com/revanced/revanced-cli/compare/v2.18.0...v2.18.1) (2022-12-15) 182 | 183 | 184 | ### Bug Fixes 185 | 186 | * don't log when package is incompatible and `exclusive` option is used ([ad81a1b](https://github.com/revanced/revanced-cli/commit/ad81a1b656586226f8b7b8d1123c52b0f3f2e6f7)) 187 | 188 | ## [2.18.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.18.0...v2.18.1-dev.1) (2022-12-15) 189 | 190 | 191 | ### Bug Fixes 192 | 193 | * don't log when package is incompatible and `exclusive` option is used ([ad81a1b](https://github.com/revanced/revanced-cli/commit/ad81a1b656586226f8b7b8d1123c52b0f3f2e6f7)) 194 | 195 | # [2.18.0](https://github.com/revanced/revanced-cli/compare/v2.17.0...v2.18.0) (2022-12-15) 196 | 197 | 198 | ### Bug Fixes 199 | 200 | * start with uppercase in log message ([ae91b0d](https://github.com/revanced/revanced-cli/commit/ae91b0d597b107a152e1b630b8c16a795a7ca3b3)) 201 | * use correct prefix in log message ([1a67cd8](https://github.com/revanced/revanced-cli/commit/1a67cd81da5ed7f259b6dbaeb66a7eef4a113034)) 202 | 203 | 204 | ### Features 205 | 206 | * simplify log message ([74d73ca](https://github.com/revanced/revanced-cli/commit/74d73ca3a7ba2f5da872fe9a241629e1c143cd4e)) 207 | 208 | # [2.18.0](https://github.com/revanced/revanced-cli/compare/v2.17.0...v2.18.0) (2022-12-15) 209 | 210 | 211 | ### Bug Fixes 212 | 213 | * start with uppercase in log message ([ae91b0d](https://github.com/revanced/revanced-cli/commit/ae91b0d597b107a152e1b630b8c16a795a7ca3b3)) 214 | * use correct prefix in log message ([1a67cd8](https://github.com/revanced/revanced-cli/commit/1a67cd81da5ed7f259b6dbaeb66a7eef4a113034)) 215 | 216 | 217 | ### Features 218 | 219 | * simplify log message ([74d73ca](https://github.com/revanced/revanced-cli/commit/74d73ca3a7ba2f5da872fe9a241629e1c143cd4e)) 220 | 221 | # [2.18.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.17.1-dev.2...v2.18.0-dev.1) (2022-12-15) 222 | 223 | 224 | ### Bug Fixes 225 | 226 | * start with uppercase in log message ([ae91b0d](https://github.com/revanced/revanced-cli/commit/ae91b0d597b107a152e1b630b8c16a795a7ca3b3)) 227 | * use correct prefix in log message ([1a67cd8](https://github.com/revanced/revanced-cli/commit/1a67cd81da5ed7f259b6dbaeb66a7eef4a113034)) 228 | 229 | 230 | ### Features 231 | 232 | * simplify log message ([74d73ca](https://github.com/revanced/revanced-cli/commit/74d73ca3a7ba2f5da872fe9a241629e1c143cd4e)) 233 | 234 | ## [2.17.1-dev.2](https://github.com/revanced/revanced-cli/compare/v2.17.1-dev.1...v2.17.1-dev.2) (2022-12-15) 235 | 236 | ## [2.17.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.17.0...v2.17.1-dev.1) (2022-12-15) 237 | 238 | # [2.17.0](https://github.com/revanced/revanced-cli/compare/v2.16.1...v2.17.0) (2022-12-14) 239 | 240 | 241 | ### Bug Fixes 242 | 243 | * invalid header when writing a `ZipFile` ([#169](https://github.com/revanced/revanced-cli/issues/169)) ([6e703eb](https://github.com/revanced/revanced-cli/commit/6e703eb8e8d7da0e52266c4965f37bc8aafb409c)) 244 | 245 | 246 | ### Features 247 | 248 | * improve missing compatibility annotation tracing log ([2c7eb72](https://github.com/revanced/revanced-cli/commit/2c7eb7274c713dfbcb53c5f3b6a9205c751914fa)) 249 | * trace logs when compatibility annotation is missing ([#166](https://github.com/revanced/revanced-cli/issues/166)) ([c590bf5](https://github.com/revanced/revanced-cli/commit/c590bf559c4d2d2667c2af0c0da23d4706fcd4b7)) 250 | 251 | # [2.17.0-dev.3](https://github.com/revanced/revanced-cli/compare/v2.17.0-dev.2...v2.17.0-dev.3) (2022-12-14) 252 | 253 | 254 | ### Features 255 | 256 | * improve missing compatibility annotation tracing log ([2c7eb72](https://github.com/revanced/revanced-cli/commit/2c7eb7274c713dfbcb53c5f3b6a9205c751914fa)) 257 | 258 | # [2.17.0-dev.2](https://github.com/revanced/revanced-cli/compare/v2.17.0-dev.1...v2.17.0-dev.2) (2022-12-14) 259 | 260 | 261 | ### Bug Fixes 262 | 263 | * invalid header when writing a `ZipFile` ([#169](https://github.com/revanced/revanced-cli/issues/169)) ([6e703eb](https://github.com/revanced/revanced-cli/commit/6e703eb8e8d7da0e52266c4965f37bc8aafb409c)) 264 | 265 | # [2.17.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.16.1...v2.17.0-dev.1) (2022-12-11) 266 | 267 | 268 | ### Features 269 | 270 | * trace logs when compatibility annotation is missing ([#166](https://github.com/revanced/revanced-cli/issues/166)) ([c590bf5](https://github.com/revanced/revanced-cli/commit/c590bf559c4d2d2667c2af0c0da23d4706fcd4b7)) 271 | 272 | ## [2.16.1](https://github.com/revanced/revanced-cli/compare/v2.16.0...v2.16.1) (2022-11-22) 273 | 274 | # [2.16.0](https://github.com/revanced/revanced-cli/compare/v2.15.1...v2.16.0) (2022-11-20) 275 | 276 | 277 | ### Features 278 | 279 | * do not warn on incompatible packages ([39e377b](https://github.com/revanced/revanced-cli/commit/39e377bc485e2892422e9712d30e6ff665856ac1)) 280 | 281 | ## [2.15.1](https://github.com/revanced/revanced-cli/compare/v2.15.0...v2.15.1) (2022-11-18) 282 | 283 | # [2.15.0](https://github.com/revanced/revanced-cli/compare/v2.14.0...v2.15.0) (2022-10-31) 284 | 285 | 286 | ### Bug Fixes 287 | 288 | * **gitignore:** ignore `options.toml` ([#158](https://github.com/revanced/revanced-cli/issues/158)) ([7be9af0](https://github.com/revanced/revanced-cli/commit/7be9af0942de2a834b9e57403d46263b65f1a422)) 289 | 290 | 291 | ### Features 292 | 293 | * use `am` instead of `monkey` to launch the app ([#159](https://github.com/revanced/revanced-cli/issues/159)) ([6a35cf7](https://github.com/revanced/revanced-cli/commit/6a35cf7ea46a4474120626ce03d28490cc96bf07)) 294 | 295 | # [2.14.0](https://github.com/revanced/revanced-cli/compare/v2.13.0...v2.14.0) (2022-10-05) 296 | 297 | 298 | ### Bug Fixes 299 | 300 | * escape quotation mark in string ([6e21d81](https://github.com/revanced/revanced-cli/commit/6e21d81964e8160e06ffda7051dd484e4aaaa432)) 301 | 302 | 303 | ### Features 304 | 305 | * handle unmounting deleted files ([#148](https://github.com/revanced/revanced-cli/issues/148)) ([3a733e5](https://github.com/revanced/revanced-cli/commit/3a733e513717799ca0e32327e5b8be043680c556)) 306 | * unmount all occurrences in `/proc/mounts` ([#131](https://github.com/revanced/revanced-cli/issues/131)) ([4f4e1f9](https://github.com/revanced/revanced-cli/commit/4f4e1f9834bf28d9be2efd4fd7bae19951b85258)) 307 | 308 | # [2.13.0](https://github.com/revanced/revanced-cli/compare/v2.12.0...v2.13.0) (2022-10-01) 309 | 310 | 311 | ### Features 312 | 313 | * check, if input file exists ([b6dff6d](https://github.com/revanced/revanced-cli/commit/b6dff6d832de4a513a6d86b0a59b2458eddd23c2)) 314 | 315 | # [2.12.0](https://github.com/revanced/revanced-cli/compare/v2.11.2...v2.12.0) (2022-09-26) 316 | 317 | 318 | ### Features 319 | 320 | * remove unused option `-r` ([467d838](https://github.com/revanced/revanced-cli/commit/467d8387e646c88d24a30406a5b2e84065ef4d54)) 321 | 322 | ## [2.11.2](https://github.com/revanced/revanced-cli/compare/v2.11.1...v2.11.2) (2022-09-23) 323 | 324 | ## [2.11.1](https://github.com/revanced/revanced-cli/compare/v2.11.0...v2.11.1) (2022-09-21) 325 | 326 | # [2.11.0](https://github.com/revanced/revanced-cli/compare/v2.10.2...v2.11.0) (2022-09-20) 327 | 328 | 329 | ### Features 330 | 331 | * section `acknowledgements` for issue templates ([0e3ecc3](https://github.com/revanced/revanced-cli/commit/0e3ecc3a51540b71072ae0be0eb94d115a5b1f92)) 332 | 333 | ## [2.10.2](https://github.com/revanced/revanced-cli/compare/v2.10.1...v2.10.2) (2022-09-18) 334 | 335 | ## [2.10.1](https://github.com/revanced/revanced-cli/compare/v2.10.0...v2.10.1) (2022-09-09) 336 | 337 | # [2.10.0](https://github.com/revanced/revanced-cli/compare/v2.9.10...v2.10.0) (2022-09-08) 338 | 339 | 340 | ### Features 341 | 342 | * Patch Options CLI implementation ([#132](https://github.com/revanced/revanced-cli/issues/132)) ([3f5345a](https://github.com/revanced/revanced-cli/commit/3f5345af6e45bfb6c91d52fc089ab18d81fdc998)) 343 | 344 | ## [2.9.10](https://github.com/revanced/revanced-cli/compare/v2.9.9...v2.9.10) (2022-09-08) 345 | 346 | 347 | ### Bug Fixes 348 | 349 | * don't print same patch multiple times ([f4b0469](https://github.com/revanced/revanced-cli/commit/f4b04698d8c1717824e86f91da5e01c5021612da)) 350 | 351 | ## [2.9.9](https://github.com/revanced/revanced-cli/compare/v2.9.8...v2.9.9) (2022-09-08) 352 | 353 | ## [2.9.8](https://github.com/revanced/revanced-cli/compare/v2.9.7...v2.9.8) (2022-09-08) 354 | 355 | 356 | ### Bug Fixes 357 | 358 | * broken deprecation message ([e3e74ac](https://github.com/revanced/revanced-cli/commit/e3e74ac0e9a844f9d717a499bca09e575dd90435)) 359 | 360 | ## [2.9.7](https://github.com/revanced/revanced-cli/compare/v2.9.6...v2.9.7) (2022-09-08) 361 | 362 | ## [2.9.6](https://github.com/revanced/revanced-cli/compare/v2.9.5...v2.9.6) (2022-09-07) 363 | 364 | ## [2.9.5](https://github.com/revanced/revanced-cli/compare/v2.9.4...v2.9.5) (2022-09-01) 365 | 366 | 367 | ### Bug Fixes 368 | 369 | * mount bind revanced.apk from magisk's mirror ([372470c](https://github.com/revanced/revanced-cli/commit/372470c77b82e8601ca523e87a2cfd44f79d0e31)) 370 | 371 | ## [2.9.4](https://github.com/revanced/revanced-cli/compare/v2.9.3...v2.9.4) (2022-08-31) 372 | 373 | ## [2.9.3](https://github.com/revanced/revanced-cli/compare/v2.9.2...v2.9.3) (2022-08-14) 374 | 375 | ## [2.9.2](https://github.com/revanced/revanced-cli/compare/v2.9.1...v2.9.2) (2022-08-07) 376 | 377 | ## [2.9.1](https://github.com/revanced/revanced-cli/compare/v2.9.0...v2.9.1) (2022-08-04) 378 | 379 | 380 | ### Reverts 381 | 382 | * feat: remove extra zipalign step ([c3d8fec](https://github.com/revanced/revanced-cli/commit/c3d8fecad0ed9d583b9f1f79bc271e0535d87be2)) 383 | 384 | # [2.9.0](https://github.com/revanced/revanced-cli/compare/v2.8.3...v2.9.0) (2022-08-03) 385 | 386 | 387 | ### Features 388 | 389 | * remove extra zipalign step ([#106](https://github.com/revanced/revanced-cli/issues/106)) ([c8e793e](https://github.com/revanced/revanced-cli/commit/c8e793efab8eed39b2cb564bee80ef6e0b2a7d03)) 390 | 391 | ## [2.8.3](https://github.com/revanced/revanced-cli/compare/v2.8.2...v2.8.3) (2022-08-03) 392 | 393 | ## [2.8.2](https://github.com/revanced/revanced-cli/compare/v2.8.1...v2.8.2) (2022-08-02) 394 | 395 | ## [2.8.1](https://github.com/revanced/revanced-cli/compare/v2.8.0...v2.8.1) (2022-08-02) 396 | 397 | 398 | ### Bug Fixes 399 | 400 | * remove requirement for solution [skip ci] ([#108](https://github.com/revanced/revanced-cli/issues/108)) ([0ce680a](https://github.com/revanced/revanced-cli/commit/0ce680a6f1de139434edd80876a168ff695c2d79)) 401 | 402 | # [2.8.0](https://github.com/revanced/revanced-cli/compare/v2.7.1...v2.8.0) (2022-07-31) 403 | 404 | 405 | ### Features 406 | 407 | * `frameworkFolderLocation` patcher option ([bc17298](https://github.com/revanced/revanced-cli/commit/bc17298a807ce035b8baa1f7c30e1392ca4ee43b)) 408 | 409 | ## [2.7.1](https://github.com/revanced/revanced-cli/compare/v2.7.0...v2.7.1) (2022-07-21) 410 | 411 | 412 | ### Bug Fixes 413 | 414 | * align every file ([96ec6a0](https://github.com/revanced/revanced-cli/commit/96ec6a0384e4c710c36b99ccf88bb14c5addc7af)) 415 | 416 | # [2.7.0](https://github.com/revanced/revanced-cli/compare/v2.6.0...v2.7.0) (2022-07-21) 417 | 418 | 419 | ### Features 420 | 421 | * `--custom-aapt2-binary` option ([#104](https://github.com/revanced/revanced-cli/issues/104)) ([d8dbffd](https://github.com/revanced/revanced-cli/commit/d8dbffd7a7ebc583476d368d2ae78853cbb40382)) 422 | 423 | # [2.6.0](https://github.com/revanced/revanced-cli/compare/v2.5.3...v2.6.0) (2022-07-18) 424 | 425 | 426 | ### Features 427 | 428 | * more efficient zipalign ([a942a57](https://github.com/revanced/revanced-cli/commit/a942a57364777d6ab6fcb11e6171cc4b496c8540)) 429 | 430 | ## [2.5.3](https://github.com/revanced/revanced-cli/compare/v2.5.2...v2.5.3) (2022-07-11) 431 | 432 | 433 | ### Bug Fixes 434 | 435 | * Log not showing in CLI ([#80](https://github.com/revanced/revanced-cli/issues/80)) ([d9c5a17](https://github.com/revanced/revanced-cli/commit/d9c5a179c529c386f66df4fa63cd321d396836b5)), closes [#79](https://github.com/revanced/revanced-cli/issues/79) 436 | 437 | ## [2.5.2](https://github.com/revanced/revanced-cli/compare/v2.5.1...v2.5.2) (2022-07-10) 438 | 439 | 440 | ### Bug Fixes 441 | 442 | * `defaultExclude` unused ([2015c2a](https://github.com/revanced/revanced-cli/commit/2015c2a1dcc0290af237e2eb1ab4aaf5fc84d382)) 443 | 444 | ## [2.5.1](https://github.com/revanced/revanced-cli/compare/v2.5.0...v2.5.1) (2022-07-10) 445 | 446 | 447 | ### Bug Fixes 448 | 449 | * Make clear what the --exclusive command actually does ([a26b0ea](https://github.com/revanced/revanced-cli/commit/a26b0ea64dcd0757b5b49c09137959751874d955)) 450 | 451 | # [2.5.0](https://github.com/revanced/revanced-cli/compare/v2.4.0...v2.5.0) (2022-07-10) 452 | 453 | 454 | ### Bug Fixes 455 | 456 | * null exception when resource patching is disabled ([#85](https://github.com/revanced/revanced-cli/issues/85)) ([125fa06](https://github.com/revanced/revanced-cli/commit/125fa06ca6bac66f790e4aba66887464189b3a63)) 457 | * remove `excludePatches` check ([eb83cab](https://github.com/revanced/revanced-cli/commit/eb83cabfff6fbc28dd892f15b8e28278e284caa9)) 458 | 459 | 460 | ### Features 461 | 462 | * `--exclusive` switch ([#78](https://github.com/revanced/revanced-cli/issues/78)) ([8e91c12](https://github.com/revanced/revanced-cli/commit/8e91c12c5e3864c369005ef9fe7d9db668e86701)) 463 | * `--uninstall` switch ([#84](https://github.com/revanced/revanced-cli/issues/84)) ([131100e](https://github.com/revanced/revanced-cli/commit/131100ef0043924a9c11eb9886b4f6b0373690d9)) 464 | 465 | # [2.4.0](https://github.com/revanced/revanced-cli/compare/v2.3.3...v2.4.0) (2022-07-10) 466 | 467 | 468 | ### Bug Fixes 469 | 470 | * wrong label in additional items [skip ci] ([cd3ded1](https://github.com/revanced/revanced-cli/commit/cd3ded1fbdb0c8eb7485912d5cbd6a2dd7455658)) 471 | 472 | 473 | ### Features 474 | 475 | * better output for excluded patches ([#77](https://github.com/revanced/revanced-cli/issues/77)) ([ac7c7a9](https://github.com/revanced/revanced-cli/commit/ac7c7a9a1a5c08322e3b206780d4f31104d8b570)) 476 | * issue templates [skip ci] ([bac8c67](https://github.com/revanced/revanced-cli/commit/bac8c67d6f7bc10a38bb98a2f6e3f5cf6fa2e3e1)) 477 | 478 | ## [2.3.3](https://github.com/revanced/revanced-cli/compare/v2.3.2...v2.3.3) (2022-07-09) 479 | 480 | ## [2.3.2](https://github.com/revanced/revanced-cli/compare/v2.3.1...v2.3.2) (2022-07-05) 481 | 482 | 483 | ### Bug Fixes 484 | 485 | * fix noSuchMethodError ([00fec25](https://github.com/revanced/revanced-cli/commit/00fec2508a3421b7b5a246254e0cb08850eab6ea)) 486 | 487 | ## [2.3.1](https://github.com/revanced/revanced-cli/compare/v2.3.0...v2.3.1) (2022-07-04) 488 | 489 | # [2.3.0](https://github.com/revanced/revanced-cli/compare/v2.2.0...v2.3.0) (2022-07-03) 490 | 491 | 492 | ### Features 493 | 494 | * separate logger to stdout & stderr ([#63](https://github.com/revanced/revanced-cli/issues/63)) ([0ddc2b5](https://github.com/revanced/revanced-cli/commit/0ddc2b54b739dae3e8ccc983bab73fc84e72be0a)) 495 | 496 | # [2.2.0](https://github.com/revanced/revanced-cli/compare/v2.1.0...v2.2.0) (2022-07-03) 497 | 498 | 499 | ### Features 500 | 501 | * separate options for `--list` ([#60](https://github.com/revanced/revanced-cli/issues/60)) ([52b3161](https://github.com/revanced/revanced-cli/commit/52b316150de397ebdee979caf51d4cb20961cf70)) 502 | 503 | # [2.1.0](https://github.com/revanced/revanced-cli/compare/v2.0.5...v2.1.0) (2022-07-03) 504 | 505 | 506 | ### Features 507 | 508 | * `--include` option ([#76](https://github.com/revanced/revanced-cli/issues/76)) ([57a1e7c](https://github.com/revanced/revanced-cli/commit/57a1e7c27fb0c4292e08332b88ccd57d69fa02c6)) 509 | 510 | ## [2.0.5](https://github.com/revanced/revanced-cli/compare/v2.0.4...v2.0.5) (2022-06-29) 511 | 512 | ## [2.0.4](https://github.com/revanced/revanced-cli/compare/v2.0.3...v2.0.4) (2022-06-28) 513 | 514 | ## [2.0.3](https://github.com/revanced/revanced-cli/compare/v2.0.2...v2.0.3) (2022-06-27) 515 | 516 | 517 | ### Bug Fixes 518 | 519 | * wrong keystore output path ([20fa179](https://github.com/revanced/revanced-cli/commit/20fa17957e3e454b9755bc7b9b473b6c578cc593)) 520 | 521 | ## [2.0.2](https://github.com/revanced/revanced-cli/compare/v2.0.1...v2.0.2) (2022-06-27) 522 | 523 | 524 | ### Bug Fixes 525 | 526 | * wrong separator when using `ZipFileSystemUtils` ([20e15de](https://github.com/revanced/revanced-cli/commit/20e15defc2b90aa5e79bad41c097bd0db8d5e12a)) 527 | 528 | ## [2.0.1](https://github.com/revanced/revanced-cli/compare/v2.0.0...v2.0.1) (2022-06-26) 529 | 530 | # [2.0.0](https://github.com/revanced/revanced-cli/compare/v1.11.1...v2.0.0) (2022-06-26) 531 | 532 | 533 | ### Code Refactoring 534 | 535 | * migrate from `Signature` to `Fingerprint` ([88852a4](https://github.com/revanced/revanced-cli/commit/88852a45ac90ad9419c18f0cb3395745e62eadbf)) 536 | 537 | 538 | ### BREAKING CHANGES 539 | 540 | * Not backwards compatible, since a lot of classes where renamed. 541 | 542 | ## [1.11.1](https://github.com/revanced/revanced-cli/compare/v1.11.0...v1.11.1) (2022-06-25) 543 | 544 | 545 | ### Bug Fixes 546 | 547 | * update patcher version ([499ce0a](https://github.com/revanced/revanced-cli/commit/499ce0a6fb1993ad48ffdd9c9e8307e8d0c179c6)) 548 | 549 | # [1.11.0](https://github.com/revanced/revanced-cli/compare/v1.10.2...v1.11.0) (2022-06-23) 550 | 551 | 552 | ### Features 553 | 554 | * improve logging ([df85fa3](https://github.com/revanced/revanced-cli/commit/df85fa37ef067681a027e6fe9212c8a065d4981b)) 555 | 556 | ## [1.10.2](https://github.com/revanced/revanced-cli/compare/v1.10.1...v1.10.2) (2022-06-22) 557 | 558 | 559 | ### Bug Fixes 560 | 561 | * keystore file not found exception ([#57](https://github.com/revanced/revanced-cli/issues/57)) ([5b8537e](https://github.com/revanced/revanced-cli/commit/5b8537e6b7922f1b44058c3a4fc2f56cb4e15e89)) 562 | 563 | ## [1.10.1](https://github.com/revanced/revanced-cli/compare/v1.10.0...v1.10.1) (2022-06-22) 564 | 565 | 566 | ### Bug Fixes 567 | 568 | * show actual version in CLI ([1dcdbc9](https://github.com/revanced/revanced-cli/commit/1dcdbc9fe9e3ad2fe232ad3baa76d186817532a4)) 569 | 570 | # [1.10.0](https://github.com/revanced/revanced-cli/compare/v1.9.3...v1.10.0) (2022-06-22) 571 | 572 | 573 | ### Bug Fixes 574 | 575 | * add callback for addFiles ([87ffaa4](https://github.com/revanced/revanced-cli/commit/87ffaa4bdb25cb85c6ba7195f5d3b13b09a5f912)) 576 | 577 | 578 | ### Features 579 | 580 | * add logging back ([4a23cb6](https://github.com/revanced/revanced-cli/commit/4a23cb69bc385158d47b6ea8d3da54b0566a242c)) 581 | 582 | ## [1.9.3](https://github.com/revanced/revanced-cli/compare/v1.9.2...v1.9.3) (2022-06-22) 583 | 584 | 585 | ### Bug Fixes 586 | 587 | * use absolute file path for key store ([d335846](https://github.com/revanced/revanced-cli/commit/d335846202b991e130882e9ce0ab268deb2e27ab)) 588 | 589 | ## [1.9.2](https://github.com/revanced/revanced-cli/compare/v1.9.1...v1.9.2) (2022-06-22) 590 | 591 | 592 | ### Bug Fixes 593 | 594 | * update patcher version ([0df936e](https://github.com/revanced/revanced-cli/commit/0df936e99b01358a88a628af63eebb5ac92cae76)) 595 | 596 | ## [1.9.1](https://github.com/revanced/revanced-cli/compare/v1.9.0...v1.9.1) (2022-06-22) 597 | 598 | 599 | ### Bug Fixes 600 | 601 | * add back in: option to specify keystore file path ([c94471f](https://github.com/revanced/revanced-cli/commit/c94471f4643e44b2b472ff0d826db0d2743bdc86)) 602 | * remove logger from Signer.kt ([51e091c](https://github.com/revanced/revanced-cli/commit/51e091ce4021418508044029aa5af6aa7d5162a3)) 603 | 604 | 605 | ### Reverts 606 | 607 | * "feat: use of `java.util.logging.Logger`" ([2c8a106](https://github.com/revanced/revanced-cli/commit/2c8a10615192635202ddc137fc02f175c5914d8f)) 608 | 609 | # [1.9.0](https://github.com/revanced/revanced-cli/compare/v1.8.0...v1.9.0) (2022-06-22) 610 | 611 | 612 | ### Features 613 | 614 | * migrate logger to `slf4j` ([6c4c192](https://github.com/revanced/revanced-cli/commit/6c4c1924ee9ae75af3449749a6a82b7ae5572129)) 615 | 616 | # [1.8.0](https://github.com/revanced/revanced-cli/compare/v1.7.1...v1.8.0) (2022-06-22) 617 | 618 | 619 | ### Features 620 | 621 | * add option to specify keystore file path ([9331594](https://github.com/revanced/revanced-cli/commit/9331594706404df871d170110da753cde5058d02)) 622 | * use of `java.util.logging.Logger` ([07f6bdf](https://github.com/revanced/revanced-cli/commit/07f6bdf33069da4e11fc40090feb726433de703e)) 623 | 624 | ## [1.7.1](https://github.com/revanced/revanced-cli/compare/v1.7.0...v1.7.1) (2022-06-22) 625 | 626 | 627 | ### Bug Fixes 628 | 629 | * migrate to changes of patcher ([b30c737](https://github.com/revanced/revanced-cli/commit/b30c7375a7ea61184be5dca19062ee74d1f97692)) 630 | * wrong variable inverted ([f694542](https://github.com/revanced/revanced-cli/commit/f694542d64ccb06bfa4d042f26b6b7192d1e912e)) 631 | 632 | # [1.7.0](https://github.com/revanced/revanced-cli/compare/v1.6.3...v1.7.0) (2022-06-21) 633 | 634 | 635 | ### Features 636 | 637 | * show description when listing patches ([af32572](https://github.com/revanced/revanced-cli/commit/af32572f29d0f0a45ee5c3e01ba4cf1f91fe2f10)) 638 | 639 | ## [1.6.3](https://github.com/revanced/revanced-cli/compare/v1.6.2...v1.6.3) (2022-06-21) 640 | 641 | 642 | ### Bug Fixes 643 | 644 | * update patcher version ([80c11fe](https://github.com/revanced/revanced-cli/commit/80c11fef734bdba9026e91f95ee0a4a522cbefab)) 645 | 646 | ## [1.6.2](https://github.com/revanced/revanced-cli/compare/v1.6.1...v1.6.2) (2022-06-21) 647 | 648 | 649 | ### Bug Fixes 650 | 651 | * CLI not working ([29105ba](https://github.com/revanced/revanced-cli/commit/29105bab3dabd9d16af6b511caef9727f98afd1a)) 652 | * improper use of mount variable ([31853fe](https://github.com/revanced/revanced-cli/commit/31853fe5393af04805857b78a54434e1c51e4c8e)) 653 | 654 | ## [1.6.1](https://github.com/revanced/revanced-cli/compare/v1.6.0...v1.6.1) (2022-06-21) 655 | 656 | 657 | ### Bug Fixes 658 | 659 | * remove `-e` from `experimental` option ([3829136](https://github.com/revanced/revanced-cli/commit/3829136c49ddce1dc6b01eda04ce013540b213c2)) 660 | 661 | # [1.6.0](https://github.com/revanced/revanced-cli/compare/v1.5.1...v1.6.0) (2022-06-21) 662 | 663 | 664 | ### Features 665 | 666 | * rename `debugging` option to `experimental` ([98bd6f3](https://github.com/revanced/revanced-cli/commit/98bd6f3f4b3eb34c445cbd5e3a3196f399f8bb3b)) 667 | * use `install` mode by default ([1a3db77](https://github.com/revanced/revanced-cli/commit/1a3db77c21b5795220fbac1ec36827fc521fface)) 668 | 669 | ## [1.5.1](https://github.com/revanced/revanced-cli/compare/v1.5.0...v1.5.1) (2022-06-21) 670 | 671 | 672 | ### Bug Fixes 673 | 674 | * update patcher version ([09b9027](https://github.com/revanced/revanced-cli/commit/09b9027e5e28f0483e74b711cf65a7876267a339)), closes [#45](https://github.com/revanced/revanced-cli/issues/45) 675 | 676 | # [1.5.0](https://github.com/revanced/revanced-cli/compare/v1.4.5...v1.5.0) (2022-06-20) 677 | 678 | 679 | ### Features 680 | 681 | * allow listing patches without other parameters ([#42](https://github.com/revanced/revanced-cli/issues/42)) ([b977d70](https://github.com/revanced/revanced-cli/commit/b977d7039f877be242823a4eef0fb8df6550dd05)) 682 | 683 | ## [1.4.5](https://github.com/revanced/revanced-cli/compare/v1.4.4...v1.4.5) (2022-06-20) 684 | 685 | 686 | ### Bug Fixes 687 | 688 | * update patcher version (fix apktool) ([496f821](https://github.com/revanced/revanced-cli/commit/496f82121879443609667a792cc1e16441ef5c2f)) 689 | 690 | ## [1.4.4](https://github.com/revanced/revanced-cli/compare/v1.4.3...v1.4.4) (2022-06-18) 691 | 692 | 693 | ### Bug Fixes 694 | 695 | * add execute permission to `./gradlew` file ([#36](https://github.com/revanced/revanced-cli/issues/36)) ([072d9e1](https://github.com/revanced/revanced-cli/commit/072d9e15d7e44b1080923f3afeb194eeb4fe4682)) 696 | 697 | ## [1.4.3](https://github.com/revanced/revanced-cli/compare/v1.4.2...v1.4.3) (2022-06-18) 698 | 699 | 700 | ### Bug Fixes 701 | 702 | * update patcher to 1.2.5 ([055c282](https://github.com/revanced/revanced-cli/commit/055c282dd3d147e3600bdfdf4fd6b4bd72cbf379)) 703 | 704 | ## [1.4.2](https://github.com/revanced/revanced-cli/compare/v1.4.1...v1.4.2) (2022-06-16) 705 | 706 | 707 | ### Bug Fixes 708 | 709 | * dummy publish task (1/2) [skip ci] ([afff4c8](https://github.com/revanced/revanced-cli/commit/afff4c8418bd33959440a3ac9e6c46816b3153ad)) 710 | * releases (2/2) ([227d8d9](https://github.com/revanced/revanced-cli/commit/227d8d94c89ec24051bd5bc20808049164d92492)) 711 | 712 | ## [1.4.1](https://github.com/revanced/revanced-cli/compare/v1.4.0...v1.4.1) (2022-06-14) 713 | 714 | 715 | ### Bug Fixes 716 | 717 | * move the keystore to the output directory ([6ceb449](https://github.com/revanced/revanced-cli/commit/6ceb449cf8539a92d89eeba8136fdc686319e2ef)) 718 | 719 | # [1.4.0](https://github.com/revanced/revanced-cli/compare/v1.3.3...v1.4.0) (2022-06-14) 720 | 721 | 722 | ### Features 723 | 724 | * chcon on mount ([e1c7d10](https://github.com/revanced/revanced-cli/commit/e1c7d1082a6946d1082c8744a1d0118c1a2263ea)) 725 | 726 | ## [1.3.3](https://github.com/revanced/revanced-cli/compare/v1.3.2...v1.3.3) (2022-06-13) 727 | 728 | 729 | ### Bug Fixes 730 | 731 | * missing implementation ([48102c6](https://github.com/revanced/revanced-cli/commit/48102c66077c4ae17e3de1076e9da72de5f00366)) 732 | 733 | ## [1.3.2](https://github.com/revanced/revanced-cli/compare/v1.3.1...v1.3.2) (2022-06-13) 734 | 735 | 736 | ### Bug Fixes 737 | 738 | * only upload `-all.jar` asset ([ca8e1ba](https://github.com/revanced/revanced-cli/commit/ca8e1ba6af00e275c6981476f773b13b103799d1)) 739 | 740 | ## [1.3.1](https://github.com/revanced/revanced-cli/compare/v1.3.0...v1.3.1) (2022-06-13) 741 | 742 | 743 | ### Bug Fixes 744 | 745 | * check if `packageVersion` is compatible with any from `compatiblePackages` ([32589c8](https://github.com/revanced/revanced-cli/commit/32589c88e438e0a1375c256e9bb8a93f5a4d319b)) 746 | 747 | # [1.3.0](https://github.com/revanced/revanced-cli/compare/v1.2.0...v1.3.0) (2022-06-11) 748 | 749 | 750 | ### Bug Fixes 751 | 752 | * `Main-Class` attribute pointing to wrong method ([6e82418](https://github.com/revanced/revanced-cli/commit/6e824189586bfa4f8aaac4a5f33aed8d59261115)) 753 | * `ZipAligner` not correctly calculating the file offset ([2975a47](https://github.com/revanced/revanced-cli/commit/2975a47d0f682a92da7b3ed455f5078298b0cbaa)) 754 | * broken control flow of `includeFilter` ([a0644c7](https://github.com/revanced/revanced-cli/commit/a0644c7045344e6a6c324392cb8f507a6d9dbfad)) 755 | * check for root even though when not needed ([0d7581a](https://github.com/revanced/revanced-cli/commit/0d7581ad750525e59bd6c019d987c640588ead62)) 756 | * overwrite output file ([2bfbbc2](https://github.com/revanced/revanced-cli/commit/2bfbbc2eb9057e66a362d37973a108baf44edf7a)) 757 | * resource patcher ([9da4f70](https://github.com/revanced/revanced-cli/commit/9da4f707ac62d11993021871ef39f4f1709ba89d)) 758 | * sign the aligned file instead of the input file ([22d2535](https://github.com/revanced/revanced-cli/commit/22d2535af8b3ea8fa58b6beb2938d240afa0a17d)) 759 | 760 | 761 | ### Features 762 | 763 | * support for `--install` ([d1ceab4](https://github.com/revanced/revanced-cli/commit/d1ceab45c89901f79d46c62f03186502021afb26)) 764 | 765 | # [1.2.0](https://github.com/revanced/revanced-cli/compare/v1.1.5...v1.2.0) (2022-06-05) 766 | 767 | 768 | ### Bug Fixes 769 | 770 | * migrate to latest patcher api changes ([ace70e4](https://github.com/revanced/revanced-cli/commit/ace70e417fdf280c7630a5a89a773879fd240e96)) 771 | 772 | 773 | ### Features 774 | 775 | * add path for `cacheDirectory` and enable resource patching by default ([54c0a03](https://github.com/revanced/revanced-cli/commit/54c0a03d44c8d1b586bc487ee1ca71859d6f0b57)) 776 | * debugging option ([1b645c6](https://github.com/revanced/revanced-cli/commit/1b645c67db58eb4d49b5290fd247507c9b43a9c6)) 777 | 778 | # [1.2.0-dev.2](https://github.com/revanced/revanced-cli/compare/v1.2.0-dev.1...v1.2.0-dev.2) (2022-06-05) 779 | 780 | 781 | ### Features 782 | 783 | * debugging option ([1b645c6](https://github.com/revanced/revanced-cli/commit/1b645c67db58eb4d49b5290fd247507c9b43a9c6)) 784 | 785 | # [1.2.0-dev.1](https://github.com/revanced/revanced-cli/compare/v1.1.6-dev.1...v1.2.0-dev.1) (2022-06-04) 786 | 787 | 788 | ### Features 789 | 790 | * add path for `cacheDirectory` and enable resource patching by default ([54c0a03](https://github.com/revanced/revanced-cli/commit/54c0a03d44c8d1b586bc487ee1ca71859d6f0b57)) 791 | 792 | ## [1.1.6-dev.1](https://github.com/revanced/revanced-cli/compare/v1.1.5...v1.1.6-dev.1) (2022-05-31) 793 | 794 | 795 | ### Bug Fixes 796 | 797 | * migrate to latest patcher api changes ([ace70e4](https://github.com/revanced/revanced-cli/commit/ace70e417fdf280c7630a5a89a773879fd240e96)) 798 | 799 | ## [1.1.5](https://github.com/revanced/revanced-cli/compare/v1.1.4...v1.1.5) (2022-05-27) 800 | 801 | 802 | ### Bug Fixes 803 | 804 | * invalid code flow when adding patches ([206f202](https://github.com/revanced/revanced-cli/commit/206f2029d7498b6474c16a47cbe451c170fdd31f)) 805 | 806 | ## [1.1.4](https://github.com/revanced/revanced-cli/compare/v1.1.3...v1.1.4) (2022-05-26) 807 | 808 | 809 | ### Bug Fixes 810 | 811 | * migrate from `PatchLoader.load(...)` to `JarPatchBundle(...).loadPatches()` ([cabd32f](https://github.com/revanced/revanced-cli/commit/cabd32fda41d32616a61ae450c60e1ee7c35bc59)) 812 | 813 | ## [1.1.3](https://github.com/revanced/revanced-cli/compare/v1.1.2...v1.1.3) (2022-05-25) 814 | 815 | 816 | ### Bug Fixes 817 | 818 | * only accept directories when looking for files in resource patch ([c76da7e](https://github.com/revanced/revanced-cli/commit/c76da7e5ffa208860eea008dad358e4e3bb3d735)) 819 | 820 | ## [1.1.2](https://github.com/revanced/revanced-cli/compare/v1.1.1...v1.1.2) (2022-05-22) 821 | 822 | 823 | ### Bug Fixes 824 | 825 | * delete `outputFile` after deploying ([329f8a3](https://github.com/revanced/revanced-cli/commit/329f8a383fe52f4c2a66075d893c6599d3550bee)) 826 | 827 | ## [1.1.1](https://github.com/revanced/revanced-cli/compare/v1.1.0...v1.1.1) (2022-05-22) 828 | 829 | 830 | ### Bug Fixes 831 | 832 | * breaking changes by `revanced-patcher` dependency ([51d2504](https://github.com/revanced/revanced-cli/commit/51d250491f390695aedc64e7ee71a9dcf99d695c)) 833 | * wrong use of dependency to `revanced-patches` ([351de6c](https://github.com/revanced/revanced-cli/commit/351de6cb90aa0f2ec93e8b8f6c10d7d312082079)) 834 | * wrong use of variable substitution / typo ([81d53b5](https://github.com/revanced/revanced-cli/commit/81d53b5518454e479b7a8f2e9be934bee30702af)), closes [revanced/revanced-cli#12](https://github.com/revanced/revanced-cli/issues/12) 835 | 836 | # [1.1.0-dev.3](https://github.com/revanced/revanced-cli/compare/v1.1.0-dev.2...v1.1.0-dev.3) (2022-05-15) 837 | 838 | 839 | ### Bug Fixes 840 | 841 | * wrong use of variable substitution / typo ([81d53b5](https://github.com/revanced/revanced-cli/commit/81d53b5518454e479b7a8f2e9be934bee30702af)), closes [revanced/revanced-cli#12](https://github.com/revanced/revanced-cli/issues/12) 842 | 843 | # [1.1.0-dev.2](https://github.com/revanced/revanced-cli/compare/v1.1.0-dev.1...v1.1.0-dev.2) (2022-05-07) 844 | 845 | 846 | ### Bug Fixes 847 | 848 | * wrong use of dependency to `revanced-patches` ([351de6c](https://github.com/revanced/revanced-cli/commit/351de6cb90aa0f2ec93e8b8f6c10d7d312082079)) 849 | 850 | # [1.1.0-dev.1](https://github.com/revanced/revanced-cli/compare/v1.0.1...v1.1.0-dev.1) (2022-05-07) 851 | 852 | 853 | ### Bug Fixes 854 | 855 | * ClassLoader not working with Java 9+ ([3a11e11](https://github.com/revanced/revanced-cli/commit/3a11e1135bd1e8958dd21247622d549440725ead)) 856 | * leftover TODOs ([5b1139c](https://github.com/revanced/revanced-cli/commit/5b1139ce43df1f5c2c848a8209a9e618857031ce)) 857 | 858 | 859 | ### Features 860 | 861 | * run `release.yml` workflow on branch `dev` ([9a64730](https://github.com/revanced/revanced-cli/commit/9a6473056b940c6df4860dd09c09d7ac61545f7d)) 862 | 863 | ## [1.0.1](https://github.com/revanced/revanced-cli/compare/v1.0.0...v1.0.1) (2022-05-07) 864 | 865 | 866 | ### Bug Fixes 867 | 868 | * broken script `CONTENT_UNMOUNT_SCRIPT` ([be53e64](https://github.com/revanced/revanced-cli/commit/be53e649a7a43de70ba2a7227c49b085001066a6)) 869 | * use latest version of patches dependency ([029f1ad](https://github.com/revanced/revanced-cli/commit/029f1ad72223e5be6664c2c8810ac35e5807d9a8)) 870 | 871 | # 1.0.0 (2022-05-07) 872 | 873 | 874 | ### Bug Fixes 875 | 876 | * deploy to `adb` ([f9b987e](https://github.com/revanced/revanced-cli/commit/f9b987e858292332a4b99e4e4280647425b8c0b8)) 877 | * gradle build script ([6ffba3e](https://github.com/revanced/revanced-cli/commit/6ffba3ef0a089c01fd31b667a37a27e77186bbbd)) 878 | * gradle sync dependencies ([407efdc](https://github.com/revanced/revanced-cli/commit/407efdc8df1bd15710a9617462bfb123cfe739fe)) 879 | * make cli compatible with breaking changes of the patcher ([555b38f](https://github.com/revanced/revanced-cli/commit/555b38f386363661a1433d82b9825dc345855f65)) 880 | * make integrations optional ([bea8b82](https://github.com/revanced/revanced-cli/commit/bea8b829c701eee3c5b0bd6fe41c2f3f7df48d9b)) 881 | * resolve signatures before applying patches ([c9941fe](https://github.com/revanced/revanced-cli/commit/c9941fe182e11066c34c3d390352862bb0f95ca2)) 882 | * this tiny thing has caused me the worst headache ever in my life ([a37304e](https://github.com/revanced/revanced-cli/commit/a37304e032c9bb7d8b76f48c7eeaededb8a32a1e)) 883 | * uncomment merging integrations ([f2d9da4](https://github.com/revanced/revanced-cli/commit/f2d9da4dca890241f6fc52bc2049b5655bc2b8ae)) 884 | * unfinished todo message ([fb068ef](https://github.com/revanced/revanced-cli/commit/fb068ef7532fc236086205b41756c26f53489645)) 885 | * unmount script `CONTENT_UMOUNT_SCRIPT` ([3a2fa30](https://github.com/revanced/revanced-cli/commit/3a2fa30676338518ab4a320e16c4c1fab78e0615)) 886 | * update cli for new patcher version ([9fc2f96](https://github.com/revanced/revanced-cli/commit/9fc2f9602aa2f134106fa400daf388176957dd57)) 887 | 888 | 889 | ### Features 890 | 891 | * Add CLI ([6664f49](https://github.com/revanced/revanced-cli/commit/6664f49a11d655fe0723ad4846673b39b08fcadd)) 892 | * Add progress bar ([8d96ec8](https://github.com/revanced/revanced-cli/commit/8d96ec83cb11ac9323ef268884912961a2405435)) 893 | * add semantic-release ([78d7aa3](https://github.com/revanced/revanced-cli/commit/78d7aa361e4079b979fbf31d4fca2a7eec445618)) 894 | * Added root-only adb runner (tested on emulator) ([37ecc5e](https://github.com/revanced/revanced-cli/commit/37ecc5eaa6f9b6640061400270d192959e3d69b2)) 895 | * integrations merge ([919b34e](https://github.com/revanced/revanced-cli/commit/919b34e174e95ee9b6adef50e405b9bbe117803a)) 896 | * load patches dynamically & use kotlinx.cli ([4624384](https://github.com/revanced/revanced-cli/commit/4624384f28378efeb5cae54365169905a0ed4de7)) 897 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | <one line to give the program's name and a brief idea of what it does.> 635 | Copyright (C) <year> <name of author> 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see <https://www.gnu.org/licenses/>. 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | <program> Copyright (C) <year> <name of author> 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | <https://www.gnu.org/licenses/>. 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | <https://www.gnu.org/licenses/why-not-lgpl.html>. 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 💻 ReVanced CLI 2 | 3 | Command line application as an alternative to the ReVanced Manager. 4 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") version "2.0.20" 3 | id("com.github.johnrengelman.shadow") version "8.1.1" 4 | } 5 | 6 | group = "app.revanced" 7 | 8 | val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR") 9 | val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN") 10 | 11 | repositories { 12 | google() 13 | mavenCentral() 14 | mavenLocal() 15 | maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots") } 16 | maven { url = uri("https://jitpack.io") } 17 | maven { url = uri("https://plugins.gradle.org/m2/") } 18 | maven { 19 | url = uri("https://maven.pkg.github.com/revanced/smali") 20 | credentials { 21 | username = githubUsername 22 | password = githubPassword 23 | } 24 | } 25 | } 26 | 27 | dependencies { 28 | implementation("org.jetbrains.kotlin:kotlin-reflect:2.0.20") 29 | testImplementation("org.jetbrains.kotlin:kotlin-test:2.0.20") 30 | implementation("app.revanced:smali:2.5.3-a3836654") 31 | 32 | implementation("io.github.inotia00:revanced-patcher:8.0.2-arsclib-SNAPSHOT") 33 | implementation("info.picocli:picocli:4.7.6") 34 | implementation("com.github.revanced:jadb:2531a28109") // updated fork 35 | implementation("com.android.tools.build:apksig:8.7.0") 36 | implementation("org.bouncycastle:bcpkix-jdk15on:1.70") 37 | implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.18.0") 38 | testImplementation("org.jetbrains.kotlin:kotlin-test:2.0.20") 39 | } 40 | 41 | kotlin { 42 | jvmToolchain(17) 43 | } 44 | 45 | tasks { 46 | test { 47 | useJUnitPlatform() 48 | testLogging { 49 | events("PASSED", "SKIPPED", "FAILED") 50 | } 51 | } 52 | build { 53 | dependsOn(shadowJar) 54 | } 55 | shadowJar { 56 | manifest { 57 | attributes("Main-Class" to "app.revanced.cli.main.MainKt") 58 | } 59 | minimize { 60 | exclude(dependency("org.jetbrains.kotlin:.*")) 61 | exclude(dependency("org.bouncycastle:.*")) 62 | exclude(dependency("app.revanced:.*")) 63 | } 64 | } 65 | // Dummy task to fix the Gradle semantic-release plugin. 66 | // Remove this if you forked it to support building only. 67 | // Tracking issue: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435 68 | register<DefaultTask>("publish") { 69 | group = "publish" 70 | description = "Dummy task" 71 | dependsOn(build) 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /docs/0_prerequisites.md: -------------------------------------------------------------------------------- 1 | # 💼 Prerequisites 2 | 3 | To use ReVanced CLI, you will need to fulfill certain requirements. 4 | 5 | ## 🤝 Requirements 6 | 7 | - [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device 8 | - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7) 9 | - Java SDK 17 or higher (Azul JDK or OpenJDK) 10 | 11 | ## ⏭️ Whats next 12 | 13 | The next section will show, how to use [ReVanced CLI](https://github.com/revanced/revanced-cli). 14 | 15 | Continue: [🛠️ Using ReVanced CLI](1_usage.md) -------------------------------------------------------------------------------- /docs/1_usage.md: -------------------------------------------------------------------------------- 1 | # 🛠️ Using ReVanced CLI 2 | 3 | Learn how to ReVanced CLI. 4 | 5 | ## ⚡ Setup (optional) 6 | 7 | 1. Make sure your device is connected 8 | 9 | ```bash 10 | adb shell exit 11 | ``` 12 | 13 | If you plan to use the root variant, check if you have root access 14 | 15 | ```bash 16 | adb shell su -c exit 17 | ``` 18 | 19 | 2. Copy the ADB device name 20 | 21 | ```bash 22 | adb devices 23 | ``` 24 | 25 | ## 🔨 ReVanced CLI Usage 26 | 27 | - ### Show all available options for ReVanced CLI 28 | 29 | ```bash 30 | java -jar revanced-cli.jar -h 31 | ``` 32 | 33 | - ### List all available patches from supplied patch bundles 34 | 35 | ```bash 36 | java -jar revanced-cli.jar \ 37 | -b revanced-patches.jar \ 38 | -l 39 | ``` 40 | 41 | - ### Use ReVanced CLI without root permissions 42 | 43 | ```bash 44 | java -jar revanced-cli.jar \ 45 | -a input.apk \ 46 | -o patched-output.apk \ 47 | -b revanced-patches.jar 48 | ``` 49 | 50 | - ### Mount the patched application with root permissions over the installed application 51 | 52 | ```bash 53 | adb install input.apk # make sure the same version is installed 54 | java -jar revanced-cli.jar \ 55 | -a input.apk \ 56 | -d device-name \ 57 | -o patched-output.apk \ 58 | -b revanced-patches.jar \ 59 | -e vanced-microg-support \ 60 | --mount 61 | ``` 62 | 63 | > **Note**: 64 | > 65 | > - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you can exclude 66 | the `vanced-microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the 67 | option `-e vanced-microg-support` when mounting for example. 68 | > 69 | > - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require 70 | [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. 71 | > The integrations will be merged, if necessary automatically, if supplied. 72 | > 73 | > - If you supplied a device with the option `-d`, the patched application will be automatically installed on the 74 | device. 75 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # 💻 Documentation and guides of ReVanced CLI 2 | 3 | This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli). 4 | 5 | ## 📖 Table of contents 6 | 7 | 1. [💼 Prerequisites](0_prerequisites.md) 8 | 2. [🛠️ Using ReVanced CLI](1_usage.md) 9 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style = official 2 | version = 2.21.7 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/inotia00/revanced-cli-arsclib/433e43db0a4332fb5cffd5d42194a843b5edc92e/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionSha256Sum=31c55713e40233a8303827ceb42ca48a47267a0ad4bab9177123121e71524c26 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip 5 | networkTimeout=10000 6 | validateDistributionUrl=true 7 | zipStoreBase=GRADLE_USER_HOME 8 | zipStorePath=wrapper/dists 9 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s 90 | ' "$PWD" ) || exit 91 | 92 | # Use the maximum available, or set MAX_FD != -1 to use that value. 93 | MAX_FD=maximum 94 | 95 | warn () { 96 | echo "$*" 97 | } >&2 98 | 99 | die () { 100 | echo 101 | echo "$*" 102 | echo 103 | exit 1 104 | } >&2 105 | 106 | # OS specific support (must be 'true' or 'false'). 107 | cygwin=false 108 | msys=false 109 | darwin=false 110 | nonstop=false 111 | case "$( uname )" in #( 112 | CYGWIN* ) cygwin=true ;; #( 113 | Darwin* ) darwin=true ;; #( 114 | MSYS* | MINGW* ) msys=true ;; #( 115 | NONSTOP* ) nonstop=true ;; 116 | esac 117 | 118 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 119 | 120 | 121 | # Determine the Java command to use to start the JVM. 122 | if [ -n "$JAVA_HOME" ] ; then 123 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 124 | # IBM's JDK on AIX uses strange locations for the executables 125 | JAVACMD=$JAVA_HOME/jre/sh/java 126 | else 127 | JAVACMD=$JAVA_HOME/bin/java 128 | fi 129 | if [ ! -x "$JAVACMD" ] ; then 130 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 131 | 132 | Please set the JAVA_HOME variable in your environment to match the 133 | location of your Java installation." 134 | fi 135 | else 136 | JAVACMD=java 137 | if ! command -v java >/dev/null 2>&1 138 | then 139 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 140 | 141 | Please set the JAVA_HOME variable in your environment to match the 142 | location of your Java installation." 143 | fi 144 | fi 145 | 146 | # Increase the maximum file descriptors if we can. 147 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 148 | case $MAX_FD in #( 149 | max*) 150 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 151 | # shellcheck disable=SC2039,SC3045 152 | MAX_FD=$( ulimit -H -n ) || 153 | warn "Could not query maximum file descriptor limit" 154 | esac 155 | case $MAX_FD in #( 156 | '' | soft) :;; #( 157 | *) 158 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 159 | # shellcheck disable=SC2039,SC3045 160 | ulimit -n "$MAX_FD" || 161 | warn "Could not set maximum file descriptor limit to $MAX_FD" 162 | esac 163 | fi 164 | 165 | # Collect all arguments for the java command, stacking in reverse order: 166 | # * args from the command line 167 | # * the main class name 168 | # * -classpath 169 | # * -D...appname settings 170 | # * --module-path (only if needed) 171 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 172 | 173 | # For Cygwin or MSYS, switch paths to Windows format before running java 174 | if "$cygwin" || "$msys" ; then 175 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 176 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 177 | 178 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 179 | 180 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 181 | for arg do 182 | if 183 | case $arg in #( 184 | -*) false ;; # don't mess with options #( 185 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 186 | [ -e "$t" ] ;; #( 187 | *) false ;; 188 | esac 189 | then 190 | arg=$( cygpath --path --ignore --mixed "$arg" ) 191 | fi 192 | # Roll the args list around exactly as many times as the number of 193 | # args, so each arg winds up back in the position where it started, but 194 | # possibly modified. 195 | # 196 | # NB: a `for` loop captures its iteration list before it begins, so 197 | # changing the positional parameters here affects neither the number of 198 | # iterations, nor the values presented in `arg`. 199 | shift # remove old arg 200 | set -- "$@" "$arg" # push replacement arg 201 | done 202 | fi 203 | 204 | 205 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 206 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 207 | 208 | # Collect all arguments for the java command: 209 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 210 | # and any embedded shellness will be escaped. 211 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 212 | # treated as '${Hostname}' itself on the command line. 213 | 214 | set -- \ 215 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 216 | -classpath "$CLASSPATH" \ 217 | org.gradle.wrapper.GradleWrapperMain \ 218 | "$@" 219 | 220 | # Stop when "xargs" is not available. 221 | if ! command -v xargs >/dev/null 2>&1 222 | then 223 | die "xargs is not available" 224 | fi 225 | 226 | # Use "xargs" to parse quoted args. 227 | # 228 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 229 | # 230 | # In Bash we could simply go: 231 | # 232 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 233 | # set -- "${ARGS[@]}" "$@" 234 | # 235 | # but POSIX shell has neither arrays nor command substitution, so instead we 236 | # post-process each arg (as a line of input to sed) to backslash-escape any 237 | # character that might be a shell metacharacter, then use eval to reverse 238 | # that process (while maintaining the separation between arguments), and wrap 239 | # the whole thing up as a single "set" statement. 240 | # 241 | # This will of course break if any of these variables contains a newline or 242 | # an unmatched quote. 243 | # 244 | 245 | eval "set -- $( 246 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 247 | xargs -n1 | 248 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 249 | tr '\n' ' ' 250 | )" '"$@"' 251 | 252 | exec "$JAVACMD" "$@" 253 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 74 | 75 | 76 | @rem Execute Gradle 77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 78 | 79 | :end 80 | @rem End local scope for the variables with windows NT shell 81 | if %ERRORLEVEL% equ 0 goto mainEnd 82 | 83 | :fail 84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 85 | rem the _cmd.exe /c_ return code! 86 | set EXIT_CODE=%ERRORLEVEL% 87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 89 | exit /b %EXIT_CODE% 90 | 91 | :mainEnd 92 | if "%OS%"=="Windows_NT" endlocal 93 | 94 | :omega 95 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "devDependencies": { 3 | "@saithodev/semantic-release-backmerge": "^3.1.0", 4 | "@semantic-release/changelog": "^6.0.2", 5 | "@semantic-release/git": "^10.0.1", 6 | "gradle-semantic-release-plugin": "^1.7.6", 7 | "semantic-release": "^20.1.0" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "revanced-cli" -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/command/MainCommand.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.command 2 | 3 | import app.revanced.cli.logging.impl.DefaultCliLogger 4 | import app.revanced.cli.patcher.logging.impl.PatcherLogger 5 | import app.revanced.cli.signing.SigningOptions 6 | import app.revanced.patcher.Patcher 7 | import app.revanced.patcher.PatcherOptions 8 | import app.revanced.patcher.PatcherResult 9 | import app.revanced.patcher.apk.Apk 10 | import app.revanced.patcher.apk.ApkBundle 11 | import app.revanced.patcher.Context 12 | import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages 13 | import app.revanced.patcher.extensions.PatchExtensions.include 14 | import app.revanced.patcher.extensions.PatchExtensions.patchName 15 | import app.revanced.patcher.patch.Patch 16 | import app.revanced.patcher.patch.PatchClass 17 | import app.revanced.patcher.util.patch.PatchBundle 18 | import app.revanced.utils.Options 19 | import app.revanced.utils.Options.setOptions 20 | import app.revanced.utils.adb.Adb 21 | import app.revanced.utils.apk.ApkSigner 22 | import picocli.CommandLine.* 23 | import java.io.File 24 | import java.nio.file.Files 25 | import java.nio.file.StandardCopyOption 26 | 27 | /** 28 | * Alias for a list of patches. 29 | */ 30 | internal typealias PatchList = List<PatchClass> 31 | 32 | private class CLIVersionProvider : IVersionProvider { 33 | override fun getVersion() = arrayOf( 34 | MainCommand::class.java.`package`.implementationVersion ?: "unknown" 35 | ) 36 | } 37 | 38 | @Command( 39 | name = "ReVanced-CLI", 40 | mixinStandardHelpOptions = true, 41 | versionProvider = CLIVersionProvider::class 42 | ) 43 | internal object MainCommand : Runnable { 44 | val logger = DefaultCliLogger() 45 | 46 | @ArgGroup(exclusive = false, multiplicity = "1") 47 | lateinit var args: Args 48 | 49 | /** 50 | * Arguments for the CLI 51 | */ 52 | class Args { 53 | @Option(names = ["--uninstall"], description = ["Uninstall the mounted apk by its package name"]) 54 | var uninstall: String? = null 55 | 56 | @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"]) 57 | var deploy: String? = null 58 | 59 | @Option(names = ["--mount"], description = ["If specified, instead of installing, mount"]) 60 | var mount: Boolean = false 61 | 62 | @ArgGroup(exclusive = false) 63 | var patchArgs: PatchArgs? = null 64 | 65 | /** 66 | * Arguments for patches. 67 | */ 68 | class PatchArgs { 69 | @Option(names = ["-b", "--bundle"], description = ["One or more bundles of patches"], required = true) 70 | var patchBundles = arrayOf<String>() 71 | 72 | @ArgGroup(exclusive = false) 73 | var listingArgs: ListingArgs? = null 74 | 75 | @ArgGroup(exclusive = false) 76 | var patchingArgs: PatchingArgs? = null 77 | 78 | /** 79 | * Arguments for patching. 80 | */ 81 | class PatchingArgs { 82 | @ArgGroup(exclusive = true, multiplicity = "1") 83 | val apkArgs: ApkArgs? = null 84 | 85 | @Option(names = ["-o", "--out"], description = ["Output folder path"], required = true) 86 | var outputPath: File = File("revanced") 87 | 88 | @Option(names = ["--options"], description = ["Path to patch options JSON file"]) 89 | var optionsFile: File = File("options.json") 90 | 91 | @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"]) 92 | var excludedPatches = arrayOf<String>() 93 | 94 | @Option( 95 | names = ["--exclusive"], 96 | description = ["Only installs the patches you include, excluding patches by default"] 97 | ) 98 | var exclusive = false 99 | 100 | @Option(names = ["-i", "--include"], description = ["Include patches"]) 101 | var includedPatches = arrayOf<String>() 102 | 103 | @Option(names = ["--experimental"], description = ["Disable patch version compatibility patch"]) 104 | var experimental: Boolean = false 105 | 106 | @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"]) 107 | var mergeFiles = listOf<File>() 108 | 109 | @Option(names = ["--alias"], description = ["The alias of the keystore entry to sign the patched APK file with"]) 110 | var alias = "ReVanced Key" 111 | 112 | @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"]) 113 | var cn = "ReVanced" 114 | 115 | @Option(names = ["--keystore"], description = ["File path to your keystore"]) 116 | var keystorePath: String? = null 117 | 118 | @Option( 119 | names = ["-p", "--password"], 120 | description = ["Overwrite the default password for the signed file"] 121 | ) 122 | var password = "" // Empty password by default 123 | 124 | @Option(names = ["-t", "--temp-dir"], description = ["Temporary work directory"]) 125 | var workDirectory = File("revanced-cache") 126 | 127 | @Option( 128 | names = ["-c", "--clean"], 129 | description = ["Clean the temporary work directory. This will always be done before running the patcher"] 130 | ) 131 | var clean: Boolean = false 132 | 133 | /** 134 | * Arguments for [Apk] files. 135 | */ 136 | class ApkArgs { 137 | @Option( 138 | names = ["-a", "--apk"], 139 | description = ["Load the specified apk file. Can be specified multiple times"], 140 | required = true 141 | ) 142 | var apks = listOf<File>() 143 | 144 | @Option( 145 | names = ["-A", "--apk-dir"], 146 | description = ["Load all files with the .apk file extension in the directory"], 147 | required = true 148 | ) 149 | var apkDir: File? = null 150 | } 151 | } 152 | 153 | /** 154 | * Arguments for printing patches. 155 | */ 156 | class ListingArgs { 157 | @Option(names = ["-l", "--list"], description = ["List patches only"], required = true) 158 | var listOnly: Boolean = false 159 | 160 | @Option(names = ["--with-versions"], description = ["List patches with compatible versions"]) 161 | var withVersions: Boolean = false 162 | 163 | @Option(names = ["--with-packages"], description = ["List patches with compatible packages"]) 164 | var withPackages: Boolean = false 165 | } 166 | } 167 | } 168 | 169 | override fun run() { 170 | // other types of commands 171 | // TODO: convert this code to picocli subcommands 172 | if (args.patchArgs?.listingArgs?.listOnly == true) return printListOfPatches() 173 | if (args.uninstall != null) return uninstall() 174 | 175 | // patching commands require these arguments 176 | val patchArgs = this.args.patchArgs ?: return 177 | val patchingArgs = patchArgs.patchingArgs ?: return 178 | 179 | // prepare the work directory, delete it if it already exists 180 | val workDirectory = patchingArgs.workDirectory.also { 181 | if (!it.deleteRecursively()) 182 | return logger.error("Failed to delete work directory") 183 | } 184 | 185 | // prepare apks 186 | val apkArgs = patchingArgs.apkArgs!! 187 | 188 | val apkBundle = ApkBundle( 189 | if (apkArgs.apkDir != null) (apkArgs.apkDir?.listFiles() ?: throw Error("Folder does not exist")) 190 | .filter { it.extension == "apk" } else apkArgs.apks) 191 | 192 | // prepare the patches 193 | val allPatches = patchArgs.patchBundles.flatMap { bundle -> PatchBundle.Jar(bundle).toList() } 194 | 195 | patchingArgs.optionsFile.let { 196 | if (it.exists()) allPatches.setOptions(it, logger) 197 | else Options.serialize(allPatches, prettyPrint = true).let(it::writeText) 198 | } 199 | 200 | // prepare the patcher 201 | val patcher = Patcher( // constructor decodes base 202 | PatcherOptions( 203 | apkBundle, 204 | PatcherLogger 205 | ) 206 | ) 207 | 208 | // prepare adb 209 | val adb: Adb? = args.deploy?.let { device -> 210 | if (args.mount) { 211 | Adb.RootAdb(device, logger) 212 | } else { 213 | Adb.UserAdb(device, logger) 214 | } 215 | } 216 | 217 | with(workDirectory.resolve("cli")) { 218 | val unsignedDirectory = resolve("unsigned").also(File::mkdirs) 219 | val signedDirectory = resolve("signed").also(File::mkdirs) 220 | 221 | /** 222 | * Sign a list of [Apk] files. 223 | * 224 | * @param unsignedApks The list of [Apk] files to sign. 225 | * @return The list of signed [Apk] files. 226 | */ 227 | fun signApks(unsignedApks: List<Pair<File, Apk>>) = if (!args.mount) { 228 | with( 229 | try { 230 | ApkSigner( 231 | SigningOptions( 232 | patchingArgs.alias, 233 | patchingArgs.cn, 234 | patchingArgs.password, 235 | patchingArgs.keystorePath 236 | ?: patchingArgs.outputPath.absoluteFile.resolve("revanced.keystore").canonicalPath 237 | ) 238 | ) 239 | } catch (ignored: Exception) { 240 | logger.info("Try signing with a legacy password") 241 | ApkSigner( 242 | SigningOptions( 243 | "alias", 244 | "ReVanced", 245 | "ReVanced", 246 | patchingArgs.keystorePath 247 | ?: patchingArgs.outputPath.absoluteFile.resolve("revanced.keystore").canonicalPath 248 | ) 249 | ) 250 | } 251 | ) { 252 | unsignedApks.map { (unsignedFile, apk) -> // sign the unsigned apk 253 | logger.info("Signing ${unsignedFile.name}") 254 | signedDirectory.resolve(unsignedFile.name) 255 | .also { signedApk -> 256 | signApk( 257 | unsignedFile, signedApk 258 | ) 259 | } to apk 260 | } 261 | } 262 | } else { 263 | unsignedApks 264 | } 265 | 266 | /** 267 | * Move an [Apk] file to the output directory. 268 | * 269 | * @param pair The [Apk] file to copy. 270 | * @return The moved [Apk] file. 271 | */ 272 | fun moveToOutput(pair: Pair<File, Apk>) = pair.first.let { apk -> 273 | patchingArgs.outputPath.resolve(apk.name).also { 274 | logger.info("Moving ${apk.name} to ${it.absolutePath}") 275 | 276 | Files.move(apk.toPath(), it.toPath(), StandardCopyOption.REPLACE_EXISTING) 277 | } 278 | } to pair.second 279 | 280 | 281 | /** 282 | * Install an [Apk] file to the device. 283 | * 284 | * @param apkFiles The [Apk] files to install. 285 | * @return The input [Apk] file. 286 | */ 287 | fun install(apkFiles: List<Pair<File, Apk>> /* pair of the apk file and the apk */) = 288 | apkFiles.also { 289 | adb?.apply { 290 | fun Pair<File, Apk>.intoAdbApk() = Adb.Apk(this.first.path) 291 | 292 | val base = it.find { (_, apk) -> apk is Apk.Base }!!.let(Pair<File, Apk>::intoAdbApk) 293 | val splits = it.filter { (_, apk) -> apk is Apk.Split }.map(Pair<File, Apk>::intoAdbApk) 294 | 295 | install(base, splits) 296 | } 297 | }.map { (outputApk, _) -> outputApk } 298 | 299 | /** 300 | * Clean up the work directory and output files. 301 | * 302 | * @param outputApks The list of output [Apk] files. 303 | */ 304 | fun cleanUp(outputApks: List<File>) { 305 | // clean up the work directory if needed 306 | if (patchingArgs.clean) { 307 | patchingArgs.workDirectory.let { 308 | if (!it.deleteRecursively()) 309 | return logger.error("Failed to delete directory $it") 310 | } 311 | if (args.deploy?.let { outputApks.any { !it.delete() } } == true) 312 | logger.error("Failed to delete some output files") 313 | } 314 | } 315 | 316 | /** 317 | * Run the patcher and save the patched resources. 318 | * 319 | * @return The resulting patched [Apk] files. 320 | */ 321 | fun Patcher.run() = also { 322 | addIntegrations(patchingArgs.mergeFiles) 323 | 324 | val (packageName, packageVersion) = apkBundle.base.packageMetadata 325 | 326 | sequence { 327 | allPatches.forEach patch@{ patch -> 328 | val patchName = patch.patchName 329 | 330 | val prefix = "Skipping $patchName" 331 | 332 | /** 333 | * Check if the patch is explicitly excluded. 334 | * 335 | * Cases: 336 | * 1. -e patch.name 337 | * 2. -i patch.name -e patch.name 338 | */ 339 | 340 | val excluded = patchingArgs.excludedPatches.contains(patchName) 341 | if (excluded) return@patch logger.info("$prefix: Explicitly excluded") 342 | 343 | /** 344 | * Check if the patch is constrained to packages. 345 | */ 346 | 347 | patch.compatiblePackages?.let { packages -> 348 | packages.singleOrNull { it.name == packageName }?.let { `package` -> 349 | /** 350 | * Check if the package version matches. 351 | * If experimental is true, version matching will be skipped. 352 | */ 353 | 354 | val matchesVersion = patchingArgs.experimental || `package`.versions.let { 355 | it.isEmpty() || it.any { version -> version == packageVersion } 356 | } 357 | 358 | if (!matchesVersion) return@patch logger.warn( 359 | "$prefix: Incompatible with version $packageVersion. " + 360 | "This patch is only compatible with version " + 361 | packages.joinToString(";") { `package` -> 362 | "${`package`.name}: ${`package`.versions.joinToString(", ")}" 363 | } 364 | ) 365 | 366 | } ?: return@patch logger.trace( 367 | "$prefix: Incompatible with $packageName. " + 368 | "This patch is only compatible with " + 369 | packages.joinToString(", ") { `package` -> `package`.name } 370 | ) 371 | 372 | return@let 373 | } ?: logger.trace("$patchName: No constraint on packages.") 374 | 375 | /** 376 | * Check if the patch is explicitly included. 377 | * 378 | * Cases: 379 | * 1. --exclusive 380 | * 2. --exclusive -i patch.name 381 | */ 382 | 383 | val exclusive = patchingArgs.exclusive 384 | val explicitlyIncluded = patchingArgs.includedPatches.contains(patchName) 385 | 386 | val implicitlyIncluded = !exclusive && patch.include // Case 3. 387 | val exclusivelyIncluded = exclusive && explicitlyIncluded // Case 2. 388 | 389 | val included = implicitlyIncluded || exclusivelyIncluded 390 | if (!included) return@patch logger.info("$prefix: Implicitly excluded") // Case 1. 391 | 392 | logger.trace("Adding $patchName") 393 | yield(patch) 394 | } 395 | }.asIterable().let(this::addPatches) 396 | 397 | execute().forEach { (patch, exception) -> 398 | if (exception != null) logger.error("Executing $patch failed:\n${exception.stackTraceToString()}") 399 | else logger.info("Executing $patch succeeded") 400 | } 401 | }.write(unsignedDirectory).apkFiles 402 | 403 | with(patcher.run()) { 404 | also { patchingArgs.outputPath.mkdirs() } 405 | .map { it.file to it.apk } 406 | .let(::signApks) 407 | .map(::moveToOutput) 408 | .let(::install) 409 | .let(::cleanUp) 410 | } 411 | 412 | logger.info("Finished") 413 | } 414 | } 415 | 416 | private fun uninstall() { 417 | args.uninstall?.let { packageName -> 418 | args.deploy?.let { device -> 419 | Adb.UserAdb(device, logger).uninstall(packageName) 420 | } ?: return logger.error("You must specify a device to uninstall from") 421 | } 422 | } 423 | 424 | private fun printListOfPatches() { 425 | val logged = mutableListOf<String>() 426 | for (patchBundlePath in args.patchArgs?.patchBundles!!) for (patch in PatchBundle.Jar(patchBundlePath)) { 427 | if (patch.patchName in logged) continue 428 | for (compatiblePackage in patch.compatiblePackages ?: continue) { 429 | val packageEntryStr = buildString { 430 | // Add package if flag is set. 431 | if (args.patchArgs?.listingArgs?.withPackages == true) { 432 | val packageName = compatiblePackage.name.substringAfterLast(".").padStart(10) 433 | append(packageName) 434 | append("\t") 435 | } 436 | // Add patch name. 437 | val patchName = patch.patchName.padStart(25) 438 | append(patchName) 439 | // Add compatible versions, if flag is set. 440 | if (args.patchArgs?.listingArgs?.withVersions == true) { 441 | val compatibleVersions = compatiblePackage.versions.joinToString(separator = ", ") 442 | append("\t") 443 | append(compatibleVersions) 444 | } 445 | } 446 | 447 | logged.add(patch.patchName) 448 | logger.info(packageEntryStr) 449 | } 450 | } 451 | } 452 | } 453 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/logging/CliLogger.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.logging 2 | 3 | internal interface CliLogger { 4 | fun error(msg: String) 5 | fun info(msg: String) 6 | fun trace(msg: String) 7 | fun warn(msg: String) 8 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/logging/impl/DefaultCliLogger.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.logging.impl 2 | 3 | import app.revanced.cli.command.MainCommand 4 | import app.revanced.cli.logging.CliLogger 5 | import java.util.logging.Logger 6 | import java.util.logging.SimpleFormatter 7 | 8 | internal class DefaultCliLogger( 9 | private val logger: Logger = Logger.getLogger(MainCommand::class.java.name), 10 | private val errorLogger: Logger = Logger.getLogger(logger.name + "Err") 11 | ) : CliLogger { 12 | 13 | init { 14 | logger.useParentHandlers = false 15 | if (logger.handlers.isEmpty()) { 16 | logger.addHandler(FlushingStreamHandler(System.out, SimpleFormatter())) 17 | } 18 | } 19 | 20 | companion object { 21 | init { 22 | System.setProperty("java.util.logging.SimpleFormatter.format", "%4\$s: %5\$s %n") 23 | } 24 | } 25 | 26 | override fun error(msg: String) = errorLogger.severe(msg) 27 | override fun info(msg: String) = logger.info(msg) 28 | override fun trace(msg: String) = logger.finest(msg) 29 | override fun warn(msg: String) = errorLogger.warning(msg) 30 | } 31 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/logging/impl/FlushingStreamHandler.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.logging.impl 2 | 3 | import java.io.OutputStream 4 | import java.util.logging.Formatter 5 | import java.util.logging.LogRecord 6 | import java.util.logging.StreamHandler 7 | 8 | internal class FlushingStreamHandler(out: OutputStream, format: Formatter) : StreamHandler(out, format) { 9 | override fun publish(record: LogRecord) { 10 | super.publish(record) 11 | flush() 12 | } 13 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/main/Main.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.main 2 | 3 | import app.revanced.cli.command.MainCommand 4 | import picocli.CommandLine 5 | 6 | internal fun main(args: Array<String>) { 7 | CommandLine(MainCommand).execute(*args) 8 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/patcher/logging/impl/PatcherLogger.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.patcher.logging.impl 2 | 3 | import app.revanced.cli.logging.impl.DefaultCliLogger 4 | import java.util.logging.Logger 5 | 6 | internal object PatcherLogger : app.revanced.patcher.logging.Logger{ 7 | private val logger = DefaultCliLogger(Logger.getLogger(app.revanced.patcher.Patcher::class.java.name)) 8 | 9 | override fun error(msg: String) = logger.error(msg) 10 | override fun info(msg: String) = logger.info(msg) 11 | override fun warn(msg: String)= logger.warn(msg) 12 | override fun trace(msg: String)= logger.trace(msg) 13 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/cli/signing/SigningOptions.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.cli.signing 2 | 3 | data class SigningOptions( 4 | val alias: String, 5 | val cn: String, 6 | val password: String, 7 | val keyStoreFilePath: String 8 | ) -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/utils/Options.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.utils 2 | 3 | import app.revanced.cli.command.PatchList 4 | import app.revanced.cli.logging.CliLogger 5 | import app.revanced.patcher.extensions.PatchExtensions.options 6 | import app.revanced.patcher.extensions.PatchExtensions.patchName 7 | import app.revanced.patcher.patch.NoSuchOptionException 8 | import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper 9 | import java.io.File 10 | 11 | 12 | internal object Options { 13 | private var mapper = jacksonObjectMapper() 14 | 15 | /** 16 | * Serializes the options for the patches in the list. 17 | * 18 | * @param patches The list of patches to serialize. 19 | * @param prettyPrint Whether to pretty print the JSON. 20 | * @return The JSON string containing the options. 21 | * @see PatchList 22 | */ 23 | fun serialize(patches: PatchList, prettyPrint: Boolean = false): String = patches 24 | .filter { it.options?.any() == true } 25 | .map { patch -> 26 | PatchOption( 27 | patch.patchName, 28 | patch.options!!.map { option -> PatchOption.Option(option.key, option.value) } 29 | ) 30 | }.let { 31 | if (prettyPrint) 32 | mapper.writerWithDefaultPrettyPrinter().writeValueAsString(it) 33 | else 34 | mapper.writeValueAsString(it) 35 | } 36 | 37 | /** 38 | * Deserializes the options for the patches in the list. 39 | * 40 | * @param json The JSON string containing the options. 41 | * @return The list of [PatchOption]s. 42 | * @see PatchOption 43 | * @see PatchList 44 | */ 45 | @Suppress("MemberVisibilityCanBePrivate") 46 | fun deserialize(json: String): Array<PatchOption> = mapper.readValue(json, Array<PatchOption>::class.java) 47 | 48 | /** 49 | * Sets the options for the patches in the list. 50 | * 51 | * @param json The JSON string containing the options. 52 | * @param logger The logger to use for logging. 53 | */ 54 | fun PatchList.setOptions(json: String, logger: CliLogger? = null) { 55 | filter { it.options?.any() == true }.let { patches -> 56 | if (patches.isEmpty()) return 57 | 58 | val patchOptions = deserialize(json) 59 | 60 | patches.forEach { patch -> 61 | patchOptions.find { option -> option.patchName == patch.patchName }?.let { 62 | it.options.forEach { option -> 63 | try { 64 | patch.options?.set(option.key, option.value) 65 | ?: logger?.warn("${patch.patchName} has no options") 66 | } catch (e: NoSuchOptionException) { 67 | logger?.error(e.message ?: "Unknown error") 68 | } 69 | } 70 | } 71 | } 72 | } 73 | } 74 | 75 | /** 76 | * Sets the options for the patches in the list. 77 | * 78 | * @param file The file containing the JSON string containing the options. 79 | * @param logger The logger to use for logging. 80 | * @see setOptions 81 | */ 82 | fun PatchList.setOptions(file: File, logger: CliLogger? = null) = setOptions(file.readText(), logger) 83 | 84 | /** 85 | * Data class for a patch and its [Option]s. 86 | * 87 | * @property patchName The name of the patch. 88 | * @property options The [Option]s for the patch. 89 | */ 90 | internal data class PatchOption( 91 | val patchName: String, 92 | val options: List<Option> 93 | ) { 94 | 95 | /** 96 | * Data class for patch option. 97 | * 98 | * @property key The name of the option. 99 | * @property value The value of the option. 100 | */ 101 | internal data class Option(val key: String, val value: Any?) 102 | } 103 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/utils/adb/Adb.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.utils.adb 2 | 3 | import app.revanced.cli.logging.CliLogger 4 | import se.vidstige.jadb.JadbConnection 5 | import se.vidstige.jadb.JadbDevice 6 | import se.vidstige.jadb.managers.Package 7 | import se.vidstige.jadb.managers.PackageManager 8 | import java.io.Closeable 9 | import java.io.File 10 | import java.nio.file.Files 11 | 12 | internal sealed class Adb(deviceSerial: String) : Closeable { 13 | protected val device: JadbDevice = JadbConnection().devices.find { it.serial == deviceSerial } 14 | ?: throw IllegalArgumentException("The device with the serial $deviceSerial can not be found.") 15 | 16 | protected val packageManager = PackageManager(device) 17 | 18 | open val logger: CliLogger? = null 19 | 20 | abstract fun install(base: Apk, splits: List<Apk>) 21 | 22 | abstract fun uninstall(packageName: String) 23 | 24 | override fun close() { 25 | logger?.trace("Closed") 26 | } 27 | 28 | class RootAdb(deviceSerial: String, override val logger: CliLogger? = null) : Adb(deviceSerial) { 29 | init { 30 | if (!device.hasSu()) throw IllegalArgumentException("Root required on $deviceSerial. Task failed") 31 | } 32 | 33 | override fun install(base: Apk, splits: List<Apk>) { 34 | TODO("Install with root") 35 | } 36 | 37 | override fun uninstall(packageName: String) { 38 | TODO("Uninstall with root") 39 | } 40 | } 41 | 42 | class UserAdb(deviceSerial: String, override val logger: CliLogger? = null) : Adb(deviceSerial) { 43 | private val replaceRegex = Regex("\\D+") // all non-digits 44 | override fun install(base: Apk, splits: List<Apk>) { 45 | /** 46 | * Class storing the information required for the installation of an apk. 47 | * 48 | * @param apk The apk. 49 | * @param size The size of the apk file. Inferred by default from [apk]. 50 | */ 51 | data class ApkInfo(val apk: Apk, val size: Long = Files.size(apk.file.toPath())) 52 | 53 | val sizes = buildList { 54 | val add = { apk: Apk -> add(ApkInfo(apk, Files.size(apk.file.toPath()))) } 55 | 56 | add(base) 57 | for (split in splits) add(split) 58 | } 59 | 60 | val installTargetPath = "/data/local/tmp/" 61 | 62 | device.run("pm install-create -S ${sizes.sumOf { it.size }}") 63 | .replace(replaceRegex, "") 64 | .also { sid -> 65 | logger?.info("Created session $sid") 66 | 67 | sizes.onEachIndexed { index, (apk, size) -> 68 | val installTargetFilePath = "$installTargetPath${apk.file.name}" 69 | 70 | with(device) { 71 | copyFile(apk.file, installTargetFilePath) 72 | 73 | logger?.info("Staging $installTargetFilePath") 74 | run("pm install-write -S $size $sid $index $installTargetFilePath") 75 | } 76 | }.also { 77 | logger?.info("Committing session $sid: ${device.run("pm install-commit $sid")}") 78 | }.forEach { (apk, _) -> 79 | device.run("rm $installTargetPath${apk.file.name}") 80 | } 81 | } 82 | } 83 | 84 | override fun uninstall(packageName: String) { 85 | logger?.info("Uninstalling $packageName") 86 | 87 | packageManager.uninstall(Package(packageName)) 88 | } 89 | } 90 | 91 | /** 92 | * Apk file for [Adb]. 93 | * 94 | * @param filePath The path to the [Apk] file. 95 | */ 96 | internal class Apk(filePath: String) { 97 | val file = File(filePath) 98 | } 99 | } -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/utils/adb/Commands.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.utils.adb 2 | 3 | import se.vidstige.jadb.JadbDevice 4 | import se.vidstige.jadb.RemoteFile 5 | import java.io.File 6 | import java.util.concurrent.Callable 7 | import java.util.concurrent.Executors 8 | 9 | // return the input or output stream, depending on which first returns a value 10 | internal fun JadbDevice.run(command: String, su: Boolean = false) = with(this.startCommand(command, su)) { 11 | Executors.newFixedThreadPool(2).let { service -> 12 | arrayOf(inputStream, errorStream).map { stream -> 13 | Callable { stream.bufferedReader().use { it.readLine() } } 14 | }.let { tasks -> service.invokeAny(tasks).also { service.shutdown() } } 15 | } 16 | } 17 | 18 | internal fun JadbDevice.hasSu() = 19 | this.startCommand("su -h", false).waitFor() == 0 20 | 21 | internal fun JadbDevice.copyFile(file: File, targetFile: String) = 22 | push(file, RemoteFile(targetFile)) 23 | 24 | internal fun JadbDevice.createFile(targetFile: String, content: String) = 25 | push(content.byteInputStream(), System.currentTimeMillis(), 644, RemoteFile(targetFile)) 26 | 27 | 28 | private fun JadbDevice.startCommand(command: String, su: Boolean) = 29 | shellProcessBuilder(if (su) "su -c '$command'" else command).start() -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/utils/adb/Constants.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.utils.adb 2 | 3 | internal object Constants { 4 | fun String.replacePlaceholder(with: String): String { 5 | return this.replace(PLACEHOLDER, with) 6 | } 7 | // template placeholder to replace a string in commands 8 | internal const val PLACEHOLDER = "TEMPLATE_PACKAGE_NAME" 9 | 10 | // utility commands 11 | private const val COMMAND_CHMOD_MOUNT = "chmod +x" 12 | internal const val COMMAND_PID_OF = "pidof -s" 13 | internal const val COMMAND_CREATE_DIR = "mkdir -p" 14 | internal const val COMMAND_LOGCAT = "logcat -c && logcat | grep AndroidRuntime" 15 | internal const val COMMAND_RESTART = "pm resolve-activity --brief $PLACEHOLDER | tail -n 1 | xargs am start -n && kill ${'$'}($COMMAND_PID_OF $PLACEHOLDER)" 16 | 17 | // default mount file name 18 | private const val NAME_MOUNT_SCRIPT = "mount_revanced_$PLACEHOLDER.sh" 19 | 20 | // initial directory to push files to via adb push 21 | internal const val PATH_INIT_PUSH = "/data/local/tmp/revanced.delete" 22 | 23 | // revanced path 24 | internal const val PATH_REVANCED = "/data/adb/revanced/" 25 | 26 | // revanced apk path 27 | internal const val PATH_REVANCED_APP = "$PATH_REVANCED$PLACEHOLDER.apk" 28 | 29 | // delete command 30 | internal const val COMMAND_DELETE = "rm -rf $PLACEHOLDER" 31 | 32 | // mount script path 33 | internal const val PATH_MOUNT = "/data/adb/service.d/$NAME_MOUNT_SCRIPT" 34 | 35 | // move to revanced apk path & set permissions 36 | internal const val COMMAND_PREPARE_MOUNT_APK = 37 | "base_path=\"$PATH_REVANCED_APP\" && mv $PATH_INIT_PUSH ${'$'}base_path && chmod 644 ${'$'}base_path && chown system:system ${'$'}base_path && chcon u:object_r:apk_data_file:s0 ${'$'}base_path" 38 | 39 | // unmount command 40 | internal const val COMMAND_UMOUNT = 41 | "grep $PLACEHOLDER /proc/mounts | while read -r line; do echo ${'$'}line | cut -d \" \" -f 2 | sed 's/apk.*/apk/' | xargs -r umount -l; done" 42 | 43 | // install mount script & set permissions 44 | internal const val COMMAND_INSTALL_MOUNT = "mv $PATH_INIT_PUSH $PATH_MOUNT && $COMMAND_CHMOD_MOUNT $PATH_MOUNT" 45 | 46 | // mount script 47 | internal val CONTENT_MOUNT_SCRIPT = 48 | """ 49 | #!/system/bin/sh 50 | MAGISKTMP="${'$'}(magisk --path)" || MAGISKTMP=/sbin 51 | MIRROR="${'$'}MAGISKTMP/.magisk/mirror" 52 | while [ "${'$'}(getprop sys.boot_completed | tr -d '\r')" != "1" ]; do sleep 1; done 53 | 54 | base_path="$PATH_REVANCED_APP" 55 | stock_path=${'$'}( pm path $PLACEHOLDER | grep base | sed 's/package://g' ) 56 | 57 | chcon u:object_r:apk_data_file:s0 ${'$'}base_path 58 | mount -o bind ${'$'}MIRROR${'$'}base_path ${'$'}stock_path 59 | """.trimIndent() 60 | } 61 | -------------------------------------------------------------------------------- /src/main/kotlin/app/revanced/utils/apk/ApkSigner.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.utils.apk 2 | 3 | import app.revanced.cli.command.MainCommand.logger 4 | import app.revanced.cli.signing.SigningOptions 5 | import com.android.apksig.ApkSigner 6 | import org.bouncycastle.asn1.x500.X500Name 7 | import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo 8 | import org.bouncycastle.cert.X509v3CertificateBuilder 9 | import org.bouncycastle.cert.jcajce.JcaX509CertificateConverter 10 | import org.bouncycastle.jce.provider.BouncyCastleProvider 11 | import org.bouncycastle.operator.ContentSigner 12 | import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder 13 | import java.io.File 14 | import java.io.FileInputStream 15 | import java.io.FileOutputStream 16 | import java.math.BigInteger 17 | import java.security.* 18 | import java.security.cert.X509Certificate 19 | import java.util.* 20 | 21 | internal class ApkSigner( 22 | private val signingOptions: SigningOptions 23 | ) { 24 | private val signer: ApkSigner.Builder 25 | private val passwordCharArray = signingOptions.password.toCharArray() 26 | 27 | init { 28 | Security.addProvider(BouncyCastleProvider()) 29 | 30 | val keyStore = KeyStore.getInstance("BKS", "BC") 31 | val alias = keyStore.let { store -> 32 | FileInputStream(File(signingOptions.keyStoreFilePath).also { 33 | if (!it.exists()) { 34 | logger.info("Creating keystore at ${it.absolutePath}") 35 | newKeystore(it) 36 | } else { 37 | logger.info("Using keystore at ${it.absolutePath}") 38 | } 39 | }).use { fis -> store.load(fis, null) } 40 | store.aliases().nextElement() 41 | } 42 | 43 | with( 44 | ApkSigner.SignerConfig.Builder( 45 | signingOptions.cn, 46 | keyStore.getKey(alias, passwordCharArray) as PrivateKey, 47 | listOf(keyStore.getCertificate(alias) as X509Certificate) 48 | ).build() 49 | ) { 50 | this@ApkSigner.signer = ApkSigner.Builder(listOf(this)) 51 | signer.setCreatedBy(signingOptions.cn) 52 | } 53 | } 54 | 55 | private fun newKeystore(out: File) { 56 | val (publicKey, privateKey) = createKey() 57 | val privateKS = KeyStore.getInstance("BKS", "BC") 58 | privateKS.load(null, passwordCharArray) 59 | privateKS.setKeyEntry(signingOptions.alias, privateKey, passwordCharArray, arrayOf(publicKey)) 60 | privateKS.store(FileOutputStream(out), passwordCharArray) 61 | } 62 | 63 | private fun createKey(): Pair<X509Certificate, PrivateKey> { 64 | val gen = KeyPairGenerator.getInstance("RSA") 65 | gen.initialize(2048) 66 | val pair = gen.generateKeyPair() 67 | var serialNumber: BigInteger 68 | do serialNumber = BigInteger.valueOf(SecureRandom().nextLong()) while (serialNumber < BigInteger.ZERO) 69 | val x500Name = X500Name("CN=${signingOptions.cn}") 70 | val builder = X509v3CertificateBuilder( 71 | x500Name, 72 | serialNumber, 73 | Date(System.currentTimeMillis() - 1000L * 60L * 60L * 24L * 30L), 74 | Date(System.currentTimeMillis() + 1000L * 60L * 60L * 24L * 366L * 30L), 75 | Locale.ENGLISH, 76 | x500Name, 77 | SubjectPublicKeyInfo.getInstance(pair.public.encoded) 78 | ) 79 | val signer: ContentSigner = JcaContentSignerBuilder("SHA256withRSA").build(pair.private) 80 | return JcaX509CertificateConverter().getCertificate(builder.build(signer)) to pair.private 81 | } 82 | 83 | fun signApk(input: File, output: File) { 84 | signer.setInputApk(input) 85 | signer.setOutputApk(output) 86 | 87 | signer.build().sign() 88 | } 89 | } -------------------------------------------------------------------------------- /src/test/kotlin/app/revanced/patcher/options/PatchOptionOptionsTest.kt: -------------------------------------------------------------------------------- 1 | package app.revanced.patcher.options 2 | 3 | import app.revanced.patcher.BytecodeContext 4 | import app.revanced.patcher.Context 5 | import app.revanced.patcher.patch.* 6 | import app.revanced.utils.Options 7 | import app.revanced.utils.Options.setOptions 8 | import org.junit.jupiter.api.MethodOrderer 9 | import org.junit.jupiter.api.Order 10 | import org.junit.jupiter.api.Test 11 | import org.junit.jupiter.api.TestMethodOrder 12 | 13 | class PatchOptionsTestPatch : BytecodePatch() { 14 | override fun execute(context: BytecodeContext) {} 15 | 16 | companion object : OptionsContainer() { 17 | var key1 by option( 18 | PatchOption.StringOption( 19 | "key1", null, "title1", "description1" 20 | ) 21 | ) 22 | 23 | var key2 by option( 24 | PatchOption.BooleanOption( 25 | "key2", true, "title2", "description2" 26 | ) 27 | ) 28 | } 29 | } 30 | 31 | @TestMethodOrder(MethodOrderer.OrderAnnotation::class) 32 | internal object PatchOptionOptionsTest { 33 | private var patches = listOf(PatchOptionsTestPatch::class.java as Class<out Patch<Context>>) 34 | 35 | @Test 36 | @Order(1) 37 | fun serializeTest() { 38 | assert(SERIALIZED_JSON == Options.serialize(patches)) 39 | } 40 | 41 | @Test 42 | @Order(2) 43 | fun loadOptionsTest() { 44 | patches.setOptions(CHANGED_JSON) 45 | 46 | assert(PatchOptionsTestPatch.key1 == "test") 47 | assert(PatchOptionsTestPatch.key2 == false) 48 | } 49 | 50 | private const val SERIALIZED_JSON = 51 | "[{\"patchName\":\"PatchOptionsTestPatch\",\"options\":[{\"key\":\"key1\",\"value\":null},{\"key\":\"key2\",\"value\":true}]}]" 52 | 53 | private const val CHANGED_JSON = 54 | "[{\"patchName\":\"PatchOptionsTestPatch\",\"options\":[{\"key\":\"key1\",\"value\":\"test\"},{\"key\":\"key2\",\"value\":false}]}]" 55 | } --------------------------------------------------------------------------------