mirror of
https://github.com/revanced/revanced-api.git
synced 2025-04-30 06:34:36 +02:00
Compare commits
No commits in common. "main" and "v1.2.0-dev.2" have entirely different histories.
main
...
v1.2.0-dev
@ -13,6 +13,3 @@ AUTH_SHA256_DIGEST=
|
||||
JWT_SECRET=
|
||||
JWT_ISSUER=
|
||||
JWT_VALIDITY_IN_MIN=
|
||||
|
||||
# Logging level for the application
|
||||
LOG_LEVEL=INFO
|
||||
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
@ -12,7 +12,7 @@ jobs:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
@ -60,7 +60,7 @@ jobs:
|
||||
DOCKER_REGISTRY_USER: ${{ github.actor }}
|
||||
DOCKER_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITHUB_ACTOR: ${{ github.actor }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
|
||||
run: npm exec semantic-release
|
||||
|
||||
- name: Set Portainer stack webhook URL based on branch
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -41,6 +41,7 @@ persistence/
|
||||
configuration.toml
|
||||
docker-compose.yml
|
||||
patches-public-key.asc
|
||||
integrations-public-key.asc
|
||||
node_modules/
|
||||
static/
|
||||
about.json
|
||||
@ -21,10 +21,10 @@
|
||||
"@semantic-release/git",
|
||||
{
|
||||
"assets": [
|
||||
"README.md",
|
||||
"CHANGELOG.md",
|
||||
"gradle.properties"
|
||||
],
|
||||
"message": "chore: Release v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
||||
]
|
||||
}
|
||||
],
|
||||
[
|
||||
|
||||
236
CHANGELOG.md
236
CHANGELOG.md
@ -1,239 +1,3 @@
|
||||
# [1.6.0](https://github.com/ReVanced/revanced-api/compare/v1.5.0...v1.6.0) (2025-02-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add status page link to about ([8a957cd](https://github.com/ReVanced/revanced-api/commit/8a957cd797e7e42f43670baaed60ac0d3543342f))
|
||||
* Add support for prereleases ([c25bc8b](https://github.com/ReVanced/revanced-api/commit/c25bc8b4ba2bd4bf1708f19dc8bc228a7f54d548))
|
||||
* Allow setting `Announcement.createdAt` when creating an announcement ([7f6e29d](https://github.com/ReVanced/revanced-api/commit/7f6e29de5205f63ac4aaea490c844b58e14000c8))
|
||||
* Make some announcements schema fields nullable ([db22874](https://github.com/ReVanced/revanced-api/commit/db22874f063bae0c9e7f0c99a20cdf1b16addd89))
|
||||
|
||||
# [1.6.0-dev.3](https://github.com/ReVanced/revanced-api/compare/v1.6.0-dev.2...v1.6.0-dev.3) (2024-12-25)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add status page link to about ([8a957cd](https://github.com/ReVanced/revanced-api/commit/8a957cd797e7e42f43670baaed60ac0d3543342f))
|
||||
* Add support for prereleases ([c25bc8b](https://github.com/ReVanced/revanced-api/commit/c25bc8b4ba2bd4bf1708f19dc8bc228a7f54d548))
|
||||
|
||||
# [1.6.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.6.0-dev.1...v1.6.0-dev.2) (2024-12-20)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Make some announcements schema fields nullable ([db22874](https://github.com/ReVanced/revanced-api/commit/db22874f063bae0c9e7f0c99a20cdf1b16addd89))
|
||||
|
||||
# [1.6.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.5.0...v1.6.0-dev.1) (2024-11-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Allow setting `Announcement.createdAt` when creating an announcement ([7f6e29d](https://github.com/ReVanced/revanced-api/commit/7f6e29de5205f63ac4aaea490c844b58e14000c8))
|
||||
|
||||
# [1.5.0](https://github.com/ReVanced/revanced-api/compare/v1.4.0...v1.5.0) (2024-11-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Allow updating `createdAt` field for announcements ([58ba4cb](https://github.com/ReVanced/revanced-api/commit/58ba4cb11c789507826cd70ac548943a94da4223))
|
||||
* Move spec url to versioned path ([e871b23](https://github.com/ReVanced/revanced-api/commit/e871b23210798723c34bce93c7567d8fbcf4e060))
|
||||
* Simplify log pattern ([d5d9e04](https://github.com/ReVanced/revanced-api/commit/d5d9e04325fa93540be0438e7b51243e2aeeab3d))
|
||||
|
||||
# [1.5.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.5.0-dev.1...v1.5.0-dev.2) (2024-11-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Allow updating `createdAt` field for announcements ([58ba4cb](https://github.com/ReVanced/revanced-api/commit/58ba4cb11c789507826cd70ac548943a94da4223))
|
||||
* Simplify log pattern ([d5d9e04](https://github.com/ReVanced/revanced-api/commit/d5d9e04325fa93540be0438e7b51243e2aeeab3d))
|
||||
|
||||
# [1.5.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.4.0...v1.5.0-dev.1) (2024-11-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Move spec url to versioned path ([e871b23](https://github.com/ReVanced/revanced-api/commit/e871b23210798723c34bce93c7567d8fbcf4e060))
|
||||
* Simplify log pattern ([d5d9e04](https://github.com/ReVanced/revanced-api/commit/d5d9e04325fa93540be0438e7b51243e2aeeab3d))
|
||||
|
||||
# [1.5.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.4.0...v1.5.0-dev.1) (2024-11-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Move spec url to versioned path ([e871b23](https://github.com/ReVanced/revanced-api/commit/e871b23210798723c34bce93c7567d8fbcf4e060))
|
||||
|
||||
# [1.4.0](https://github.com/ReVanced/revanced-api/compare/v1.3.0...v1.4.0) (2024-11-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add missing logging level environment variable to .env.example ([3b62120](https://github.com/ReVanced/revanced-api/commit/3b6212065a5cfb95c303b6d0551747ba1eb317f6))
|
||||
* Use new patches file extension ([d42a3a3](https://github.com/ReVanced/revanced-api/commit/d42a3a393396a0f4e9085cda46e0af2c12b63cb1))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add URL and use friendly name for `APIContributable` ([a5498ab](https://github.com/ReVanced/revanced-api/commit/a5498aba2b99db89c28a65738cc58cc4c852c327))
|
||||
* Allow versioning by arbitrary path string ([814d3c9](https://github.com/ReVanced/revanced-api/commit/814d3c946e31068e12e3886aa8beb3238ef126ae))
|
||||
* Improve announcements API ([#192](https://github.com/ReVanced/revanced-api/issues/192)) ([56a00dd](https://github.com/ReVanced/revanced-api/commit/56a00ddb85f302d441f0b222a9902ea2c1c18897))
|
||||
* Make backend configurable ([f91f3a6](https://github.com/ReVanced/revanced-api/commit/f91f3a65c5e07b5b58ccbff1d4b0a5ba9b15fc50))
|
||||
* Remove "archived" query parameter ([8ad614e](https://github.com/ReVanced/revanced-api/commit/8ad614ef4fdaf45af87a3316ef4db7e7236fd64a))
|
||||
* Remove deprecated routes and old API ([eca40a6](https://github.com/ReVanced/revanced-api/commit/eca40a69799240f7803aa8851eb3ee961937e4d6))
|
||||
* Remove ReVanced Integrations ([f1c1092](https://github.com/ReVanced/revanced-api/commit/f1c10928ae3be1c6b1d675819755b3046fad70d8))
|
||||
* Use tag name directly instead of ID ([fc40427](https://github.com/ReVanced/revanced-api/commit/fc40427fbaafb523045eb6f5285d90949b206b8b))
|
||||
|
||||
# [1.4.0-dev.6](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.5...v1.4.0-dev.6) (2024-11-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Allow versioning by arbitrary path string ([814d3c9](https://github.com/ReVanced/revanced-api/commit/814d3c946e31068e12e3886aa8beb3238ef126ae))
|
||||
* Remove deprecated routes and old API ([eca40a6](https://github.com/ReVanced/revanced-api/commit/eca40a69799240f7803aa8851eb3ee961937e4d6))
|
||||
|
||||
# [1.4.0-dev.5](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.4...v1.4.0-dev.5) (2024-11-05)
|
||||
|
||||
# [1.4.0-dev.4](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.3...v1.4.0-dev.4) (2024-11-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Remove "archived" query parameter ([8ad614e](https://github.com/ReVanced/revanced-api/commit/8ad614ef4fdaf45af87a3316ef4db7e7236fd64a))
|
||||
* Use tag name directly instead of ID ([fc40427](https://github.com/ReVanced/revanced-api/commit/fc40427fbaafb523045eb6f5285d90949b206b8b))
|
||||
|
||||
# [1.4.0-dev.3](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.2...v1.4.0-dev.3) (2024-11-01)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Use new patches file extension ([d42a3a3](https://github.com/ReVanced/revanced-api/commit/d42a3a393396a0f4e9085cda46e0af2c12b63cb1))
|
||||
|
||||
# [1.4.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.4.0-dev.1...v1.4.0-dev.2) (2024-11-01)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add missing logging level environment variable to .env.example ([3b62120](https://github.com/ReVanced/revanced-api/commit/3b6212065a5cfb95c303b6d0551747ba1eb317f6))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add URL and use friendly name for `APIContributable` ([a5498ab](https://github.com/ReVanced/revanced-api/commit/a5498aba2b99db89c28a65738cc58cc4c852c327))
|
||||
* Make backend configurable ([f91f3a6](https://github.com/ReVanced/revanced-api/commit/f91f3a65c5e07b5b58ccbff1d4b0a5ba9b15fc50))
|
||||
* Remove ReVanced Integrations ([f1c1092](https://github.com/ReVanced/revanced-api/commit/f1c10928ae3be1c6b1d675819755b3046fad70d8))
|
||||
|
||||
# [1.4.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.3.0...v1.4.0-dev.1) (2024-11-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Improve announcements API ([#192](https://github.com/ReVanced/revanced-api/issues/192)) ([56a00dd](https://github.com/ReVanced/revanced-api/commit/56a00ddb85f302d441f0b222a9902ea2c1c18897))
|
||||
|
||||
# [1.3.0](https://github.com/ReVanced/revanced-api/compare/v1.2.0...v1.3.0) (2024-10-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add missing OK response to routes ([1181be1](https://github.com/ReVanced/revanced-api/commit/1181be12e2223b245019f64570bc8f7bef4e7dc2))
|
||||
* Allow more necessary HTTP methods for CORS ([080e2e5](https://github.com/ReVanced/revanced-api/commit/080e2e582cb8ea97421c402a4cb82414e11fb1cf))
|
||||
* Configure CORS properly to allow authorization and content-type header ([6442757](https://github.com/ReVanced/revanced-api/commit/6442757927c0307c01b2793858d25df7e3fca122))
|
||||
* Expire token relative to current date time instead of just time ([c26e129](https://github.com/ReVanced/revanced-api/commit/c26e129bda09345761f291917f026c13e89a2572))
|
||||
* Expose www-authenticate header to JS ([9ed724e](https://github.com/ReVanced/revanced-api/commit/9ed724e161f9029967f67e4c2066f2fdf7be0a27))
|
||||
* Respond with JSON when returning token ([1e3e46f](https://github.com/ReVanced/revanced-api/commit/1e3e46ff4f7c12569b88fcd1bc252aeb5a611b63))
|
||||
* Specify a validation function to fix authentication ([53c3600](https://github.com/ReVanced/revanced-api/commit/53c36002e9af89aa5fed71f831470b42d5d777c9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add missing parameter and response documentation ([491533d](https://github.com/ReVanced/revanced-api/commit/491533d3f44ccd716eee80123d0875a05eb9435b))
|
||||
* Customize logging level through environment variable ([8b17d88](https://github.com/ReVanced/revanced-api/commit/8b17d8894db8db4a168c30be50af91c04e173e14))
|
||||
* Improve response info description wording ([977d252](https://github.com/ReVanced/revanced-api/commit/977d25249738b24cb6a3530543349efe1d71a9ba))
|
||||
* Only allow requests from HTTPs ([a6d7da1](https://github.com/ReVanced/revanced-api/commit/a6d7da1205ef7bc23eba0b1fca2480a4327def19))
|
||||
|
||||
# [1.3.0-dev.6](https://github.com/ReVanced/revanced-api/compare/v1.3.0-dev.5...v1.3.0-dev.6) (2024-10-02)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Expose www-authenticate header to JS ([9ed724e](https://github.com/ReVanced/revanced-api/commit/9ed724e161f9029967f67e4c2066f2fdf7be0a27))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Only allow requests from HTTPs ([a6d7da1](https://github.com/ReVanced/revanced-api/commit/a6d7da1205ef7bc23eba0b1fca2480a4327def19))
|
||||
|
||||
# [1.3.0-dev.5](https://github.com/ReVanced/revanced-api/compare/v1.3.0-dev.4...v1.3.0-dev.5) (2024-09-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Allow more necessary HTTP methods for CORS ([080e2e5](https://github.com/ReVanced/revanced-api/commit/080e2e582cb8ea97421c402a4cb82414e11fb1cf))
|
||||
|
||||
# [1.3.0-dev.4](https://github.com/ReVanced/revanced-api/compare/v1.3.0-dev.3...v1.3.0-dev.4) (2024-09-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Configure CORS properly to allow authorization and content-type header ([6442757](https://github.com/ReVanced/revanced-api/commit/6442757927c0307c01b2793858d25df7e3fca122))
|
||||
|
||||
# [1.3.0-dev.3](https://github.com/ReVanced/revanced-api/compare/v1.3.0-dev.2...v1.3.0-dev.3) (2024-09-29)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add missing OK response to routes ([1181be1](https://github.com/ReVanced/revanced-api/commit/1181be12e2223b245019f64570bc8f7bef4e7dc2))
|
||||
* Respond with JSON when returning token ([1e3e46f](https://github.com/ReVanced/revanced-api/commit/1e3e46ff4f7c12569b88fcd1bc252aeb5a611b63))
|
||||
* Specify a validation function to fix authentication ([53c3600](https://github.com/ReVanced/revanced-api/commit/53c36002e9af89aa5fed71f831470b42d5d777c9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Customize logging level through environment variable ([8b17d88](https://github.com/ReVanced/revanced-api/commit/8b17d8894db8db4a168c30be50af91c04e173e14))
|
||||
* Improve response info description wording ([977d252](https://github.com/ReVanced/revanced-api/commit/977d25249738b24cb6a3530543349efe1d71a9ba))
|
||||
|
||||
# [1.3.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.3.0-dev.1...v1.3.0-dev.2) (2024-09-27)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Expire token relative to current date time instead of just time ([c26e129](https://github.com/ReVanced/revanced-api/commit/c26e129bda09345761f291917f026c13e89a2572))
|
||||
|
||||
# [1.3.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.2.0...v1.3.0-dev.1) (2024-09-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add missing parameter and response documentation ([491533d](https://github.com/ReVanced/revanced-api/commit/491533d3f44ccd716eee80123d0875a05eb9435b))
|
||||
|
||||
# [1.2.0](https://github.com/ReVanced/revanced-api/compare/v1.1.0...v1.2.0) (2024-09-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add back deprecated routes for backwards compatibility ([9f0eb5b](https://github.com/ReVanced/revanced-api/commit/9f0eb5bfe9d0436e76462b9c094f8b1158e04a44))
|
||||
* Make sure, expected paths in configuration exist ([32bedb7](https://github.com/ReVanced/revanced-api/commit/32bedb7fad3eef8116625964e5e1f0a2543ea2a4))
|
||||
* Return correct GPG keys url ([#187](https://github.com/ReVanced/revanced-api/issues/187)) ([74e5389](https://github.com/ReVanced/revanced-api/commit/74e53891a17bd3f76f358477e4228550e6f70149))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Move /latest routes to parent ([4e8e83d](https://github.com/ReVanced/revanced-api/commit/4e8e83db1a20c76a81967af4e7e3a8634649790a))
|
||||
* Respond to all ping request methods ([df116bd](https://github.com/ReVanced/revanced-api/commit/df116bd22134c8222c72b28e9387bc9871d3473e))
|
||||
|
||||
# [1.2.0-dev.4](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.3...v1.2.0-dev.4) (2024-09-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add back deprecated routes for backwards compatibility ([9f0eb5b](https://github.com/ReVanced/revanced-api/commit/9f0eb5bfe9d0436e76462b9c094f8b1158e04a44))
|
||||
* Make sure, expected paths in configuration exist ([32bedb7](https://github.com/ReVanced/revanced-api/commit/32bedb7fad3eef8116625964e5e1f0a2543ea2a4))
|
||||
|
||||
# [1.2.0-dev.3](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.2...v1.2.0-dev.3) (2024-09-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Return correct GPG keys url ([#187](https://github.com/ReVanced/revanced-api/issues/187)) ([74e5389](https://github.com/ReVanced/revanced-api/commit/74e53891a17bd3f76f358477e4228550e6f70149))
|
||||
|
||||
# [1.2.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.1...v1.2.0-dev.2) (2024-08-24)
|
||||
|
||||
|
||||
|
||||
32
README.md
32
README.md
@ -68,19 +68,19 @@ API server for ReVanced.
|
||||
## ❓ About
|
||||
|
||||
ReVanced API is a server that is used as the backend for ReVanced.
|
||||
ReVanced API acts as the data source for [ReVanced Website](https://github.com/ReVanced/revanced-website) and
|
||||
powers [ReVanced Manager](https://github.com/ReVanced/revanced-manager)
|
||||
ReVanced API acts as the data source for [ReVanced Website](https://github.com/ReVanced/revanced-website) and powers [ReVanced Manager](https://github.com/ReVanced/revanced-manager)
|
||||
with updates and ReVanced Patches.
|
||||
|
||||
## 💪 Features
|
||||
|
||||
Some of the features ReVanced API include:
|
||||
|
||||
- 📢 **Announcements**: Post and get announcements
|
||||
- 📢 **Announcements**: Post and get announcements grouped by channels
|
||||
- ℹ️ **About**: Get more information such as a description, ways to donate to,
|
||||
and links of the hoster of ReVanced API
|
||||
- 🧩 **Patches**: Get the latest updates of ReVanced Patches, directly from ReVanced API
|
||||
- 👥 **Contributors**: List all contributors involved in the project
|
||||
- 🔄 **Backwards compatibility**: Proxy an old API for migration purposes and backwards compatibility
|
||||
|
||||
## 🚀 How to get started
|
||||
|
||||
@ -90,35 +90,26 @@ ReVanced API can be deployed as a Docker container or used standalone.
|
||||
|
||||
To deploy ReVanced API as a Docker container, you can use Docker Compose or Docker CLI.
|
||||
The Docker image is published on GitHub Container registry,
|
||||
so before you can pull the image, you need
|
||||
to [authenticate to the Container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry).
|
||||
so before you can pull the image, you need to [authenticate to the Container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry).
|
||||
|
||||
### 🗄️ Docker Compose
|
||||
|
||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
||||
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||
4. Create a `docker-compose.yml` file using [docker-compose.example.yml](docker-compose.example.yml) as a template
|
||||
5. Run `docker-compose up -d` to start the server
|
||||
3. Create a `docker-compose.yml` file using [docker-compose.example.yml](docker-compose.example.yml) as a template
|
||||
4. Run `docker-compose up -d` to start the server
|
||||
|
||||
### 💻 Docker CLI
|
||||
|
||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
||||
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||
4. Start the container using the following command:
|
||||
3. Start the container using the following command:
|
||||
```shell
|
||||
docker run -d --name revanced-api \
|
||||
# Mount the .env file
|
||||
-v $(pwd)/.env:/app/.env \
|
||||
# Mount the configuration.toml file
|
||||
-v $(pwd)/configuration.toml:/app/configuration.toml \
|
||||
# Mount the patches public key
|
||||
-v $(pwd)/patches-public-key.asc:/app/patches-public-key.asc \
|
||||
# Mount the static folder
|
||||
-v $(pwd)/static:/app/static \
|
||||
# Mount the about.json file
|
||||
-v $(pwd)/about.json:/app/about.json \
|
||||
# Mount the persistence folder
|
||||
-v $(pwd)/persistence:/app/persistence \
|
||||
# Expose the port 8888
|
||||
@ -141,8 +132,7 @@ A Java Runtime Environment (JRE) must be installed.
|
||||
2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template
|
||||
3. In the same folder, create a `configuration.toml` file
|
||||
using [configuration.example.toml](configuration.example.toml) as a template
|
||||
4. In the same folder, create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||
5. Run `java -jar revanced-api.jar start` to start the server
|
||||
4. Run `java -jar revanced-api.jar start` to start the server
|
||||
|
||||
### 🛠️ From source
|
||||
|
||||
@ -151,15 +141,13 @@ A Java Development Kit (JDK) and Git must be installed.
|
||||
1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository
|
||||
2. Copy [.env.example](.env.example) to `.env` and fill in the required values
|
||||
3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values
|
||||
4. Copy [about.example.json](about.example.json) to `about.json` and fill in the required values
|
||||
5. Run `gradlew run --args=start` to start the server
|
||||
4. Run `gradlew run --args=start` to start the server
|
||||
|
||||
## 📚 Everything else
|
||||
|
||||
### 📙 Contributing
|
||||
|
||||
Thank you for considering contributing to ReVanced API. You can find the contribution
|
||||
guidelines [here](CONTRIBUTING.md).
|
||||
Thank you for considering contributing to ReVanced API. You can find the contribution guidelines [here](CONTRIBUTING.md).
|
||||
|
||||
### 🛠️ Building
|
||||
|
||||
|
||||
@ -5,7 +5,6 @@
|
||||
"branding": {
|
||||
"logo": "https://raw.githubusercontent.com/ReVanced/revanced-branding/main/assets/revanced-logo/revanced-logo.svg"
|
||||
},
|
||||
"status": "https://status.revanced.app",
|
||||
"contact": {
|
||||
"email": "contact@revanced.app"
|
||||
},
|
||||
|
||||
@ -48,12 +48,6 @@ kotlin {
|
||||
}
|
||||
}
|
||||
|
||||
tasks {
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
}
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
google()
|
||||
@ -104,8 +98,6 @@ dependencies {
|
||||
implementation(libs.caffeine)
|
||||
implementation(libs.bouncy.castle.provider)
|
||||
implementation(libs.bouncy.castle.pgp)
|
||||
|
||||
testImplementation(kotlin("test"))
|
||||
}
|
||||
|
||||
// The maven-publish plugin is necessary to make signing work.
|
||||
|
||||
@ -1,29 +1,22 @@
|
||||
api-version = "v1"
|
||||
organization = "revanced"
|
||||
patches = { repository = "revanced-patches", asset-regex = "jar$", signature-asset-regex = "asc$", public-key-file = "patches-public-key.asc", public-key-id = 0 }
|
||||
integrations = { repository = "revanced-integrations", asset-regex = "apk$", signature-asset-regex = "asc$", public-key-file = "integrations-public-key.asc", public-key-id = 0 }
|
||||
manager = { repository = "revanced-manager", asset-regex = "apk$" }
|
||||
contributors-repositories = [
|
||||
"revanced-patcher",
|
||||
"revanced-patches",
|
||||
"revanced-integrations",
|
||||
"revanced-website",
|
||||
"revanced-cli",
|
||||
"revanced-manager",
|
||||
]
|
||||
api-version = 1
|
||||
cors-allowed-hosts = [
|
||||
"revanced.app",
|
||||
"*.revanced.app"
|
||||
]
|
||||
endpoint = "https://api.revanced.app"
|
||||
old-api-endpoint = "https://old-api.revanced.app"
|
||||
static-files-path = "static/root"
|
||||
versioned-static-files-path = "static/versioned"
|
||||
backend-service-name = "GitHub"
|
||||
about-json-file-path = "about.json"
|
||||
organization = "revanced"
|
||||
|
||||
[patches]
|
||||
repository = "revanced-patches"
|
||||
asset-regex = "rvp$"
|
||||
signature-asset-regex = "asc$"
|
||||
public-key-file = "static/root/keys.asc"
|
||||
public-key-id = 3897925568445097277
|
||||
|
||||
[manager]
|
||||
repository = "revanced-manager"
|
||||
asset-regex = "apk$"
|
||||
|
||||
[contributors-repositories]
|
||||
revanced-patcher = "ReVanced Patcher"
|
||||
revanced-patches = "ReVanced Patches"
|
||||
revanced-website = "ReVanced Website"
|
||||
revanced-cli = "ReVanced CLI"
|
||||
revanced-manager = "ReVanced Manager"
|
||||
@ -7,10 +7,11 @@ services:
|
||||
- /data/revanced-api/.env:/app/.env
|
||||
- /data/revanced-api/configuration.toml:/app/configuration.toml
|
||||
- /data/revanced-api/patches-public-key.asc:/app/patches-public-key.asc
|
||||
- /data/revanced-api/integrations-public-key.asc:/app/integrations-public-key.asc
|
||||
- /data/revanced-api/static:/app/static
|
||||
- /data/revanced-api/about.json:/app/about.json
|
||||
environment:
|
||||
- COMMAND=start
|
||||
ports:
|
||||
- "8888:8888"
|
||||
- 8888:8888
|
||||
restart: unless-stopped
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
org.gradle.parallel = true
|
||||
org.gradle.caching = true
|
||||
kotlin.code.style = official
|
||||
version = 1.6.0
|
||||
version = 1.2.0-dev.2
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
[versions]
|
||||
kompendium-core = "3.14.4"
|
||||
kotlin = "2.0.20"
|
||||
kotlin = "2.0.0"
|
||||
logback = "1.5.6"
|
||||
exposed = "0.52.0"
|
||||
h2 = "2.2.224"
|
||||
@ -10,8 +10,8 @@ ktor = "2.3.7"
|
||||
ktoml = "0.5.2"
|
||||
picocli = "4.7.6"
|
||||
datetime = "0.6.0"
|
||||
revanced-patcher = "21.0.0"
|
||||
revanced-library = "3.0.2"
|
||||
revanced-patcher = "20.0.0"
|
||||
revanced-library = "3.0.1-dev.1"
|
||||
caffeine = "3.1.8"
|
||||
bouncy-castle = "1.78.1"
|
||||
|
||||
|
||||
3604
package-lock.json
generated
3604
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -4,7 +4,7 @@
|
||||
"@saithodev/semantic-release-backmerge": "^4.0.1",
|
||||
"@semantic-release/changelog": "^6.0.3",
|
||||
"@semantic-release/git": "^10.0.1",
|
||||
"gradle-semantic-release-plugin": "^1.10.1",
|
||||
"semantic-release": "^24.1.2"
|
||||
"gradle-semantic-release-plugin": "^1.9.2",
|
||||
"semantic-release": "^24.0.0"
|
||||
}
|
||||
}
|
||||
@ -1,7 +1,6 @@
|
||||
package app.revanced.api.command
|
||||
|
||||
import app.revanced.api.configuration.*
|
||||
import io.github.cdimascio.dotenv.Dotenv
|
||||
import io.ktor.server.engine.*
|
||||
import io.ktor.server.jetty.*
|
||||
import picocli.CommandLine
|
||||
@ -34,8 +33,6 @@ internal object StartAPICommand : Runnable {
|
||||
private var configFile = File("configuration.toml")
|
||||
|
||||
override fun run() {
|
||||
Dotenv.configure().systemProperties().load()
|
||||
|
||||
embeddedServer(Jetty, port, host) {
|
||||
configureDependencies(configFile)
|
||||
configureHTTP()
|
||||
|
||||
@ -5,51 +5,131 @@ import app.revanced.api.configuration.repository.BackendRepository
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import app.revanced.api.configuration.repository.GitHubBackendRepository
|
||||
import app.revanced.api.configuration.services.*
|
||||
import app.revanced.api.configuration.services.AnnouncementService
|
||||
import app.revanced.api.configuration.services.ApiService
|
||||
import app.revanced.api.configuration.services.AuthService
|
||||
import app.revanced.api.configuration.services.OldApiService
|
||||
import app.revanced.api.configuration.services.PatchesService
|
||||
import com.akuleshov7.ktoml.Toml
|
||||
import com.akuleshov7.ktoml.source.decodeFromStream
|
||||
import io.github.cdimascio.dotenv.Dotenv
|
||||
import io.ktor.client.*
|
||||
import io.ktor.client.engine.okhttp.*
|
||||
import io.ktor.client.plugins.*
|
||||
import io.ktor.client.plugins.auth.*
|
||||
import io.ktor.client.plugins.auth.providers.*
|
||||
import io.ktor.client.plugins.cache.*
|
||||
import io.ktor.client.plugins.contentnegotiation.*
|
||||
import io.ktor.client.plugins.resources.*
|
||||
import io.ktor.serialization.kotlinx.json.*
|
||||
import io.ktor.server.application.*
|
||||
import kotlinx.serialization.ExperimentalSerializationApi
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonNamingStrategy
|
||||
import org.jetbrains.exposed.sql.Database
|
||||
import org.jetbrains.exposed.sql.transactions.TransactionManager
|
||||
import org.koin.core.module.dsl.singleOf
|
||||
import org.koin.core.parameter.parameterArrayOf
|
||||
import org.koin.dsl.module
|
||||
import org.koin.ktor.plugin.Koin
|
||||
import java.io.File
|
||||
|
||||
@OptIn(ExperimentalSerializationApi::class)
|
||||
fun Application.configureDependencies(
|
||||
configFile: File,
|
||||
) {
|
||||
val repositoryModule = module {
|
||||
single<ConfigurationRepository> { Toml.decodeFromStream(configFile.inputStream()) }
|
||||
val globalModule = module {
|
||||
single {
|
||||
Database.connect(
|
||||
url = System.getProperty("DB_URL"),
|
||||
user = System.getProperty("DB_USER"),
|
||||
password = System.getProperty("DB_PASSWORD"),
|
||||
Dotenv.configure().load()
|
||||
}
|
||||
|
||||
factory { params ->
|
||||
val defaultRequestUri: String = params.get<String>()
|
||||
val configBlock = params.getOrNull<(HttpClientConfig<OkHttpConfig>.() -> Unit)>() ?: {}
|
||||
|
||||
HttpClient(OkHttp) {
|
||||
defaultRequest { url(defaultRequestUri) }
|
||||
|
||||
configBlock()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
val repositoryModule = module {
|
||||
single<BackendRepository> {
|
||||
GitHubBackendRepository(
|
||||
get {
|
||||
val defaultRequestUri = "https://api.github.com"
|
||||
val configBlock: HttpClientConfig<OkHttpConfig>.() -> Unit = {
|
||||
install(HttpCache)
|
||||
install(Resources)
|
||||
install(ContentNegotiation) {
|
||||
json(
|
||||
Json {
|
||||
ignoreUnknownKeys = true
|
||||
namingStrategy = JsonNamingStrategy.SnakeCase
|
||||
},
|
||||
)
|
||||
}
|
||||
singleOf(::AnnouncementRepository)
|
||||
singleOf(::GitHubBackendRepository)
|
||||
single<BackendRepository> {
|
||||
val backendServices = mapOf(
|
||||
GitHubBackendRepository.SERVICE_NAME to { get<GitHubBackendRepository>() },
|
||||
// Implement more backend services here.
|
||||
|
||||
get<Dotenv>()["BACKEND_API_TOKEN"]?.let {
|
||||
install(Auth) {
|
||||
bearer {
|
||||
loadTokens {
|
||||
BearerTokens(
|
||||
accessToken = it,
|
||||
refreshToken = "", // Required dummy value
|
||||
)
|
||||
}
|
||||
|
||||
sendWithoutRequest { true }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
parameterArrayOf(defaultRequestUri, configBlock)
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
single<ConfigurationRepository> {
|
||||
Toml.decodeFromStream(configFile.inputStream())
|
||||
}
|
||||
|
||||
single {
|
||||
val dotenv = get<Dotenv>()
|
||||
|
||||
TransactionManager.defaultDatabase = Database.connect(
|
||||
url = dotenv["DB_URL"],
|
||||
user = dotenv["DB_USER"],
|
||||
password = dotenv["DB_PASSWORD"],
|
||||
)
|
||||
|
||||
val configuration = get<ConfigurationRepository>()
|
||||
val backendFactory = backendServices[configuration.backendServiceName]!!
|
||||
|
||||
backendFactory()
|
||||
AnnouncementRepository()
|
||||
}
|
||||
}
|
||||
|
||||
val serviceModule = module {
|
||||
single {
|
||||
val jwtSecret = System.getProperty("JWT_SECRET")
|
||||
val issuer = System.getProperty("JWT_ISSUER")
|
||||
val validityInMin = System.getProperty("JWT_VALIDITY_IN_MIN").toLong()
|
||||
val dotenv = get<Dotenv>()
|
||||
|
||||
val authSHA256DigestString = System.getProperty("AUTH_SHA256_DIGEST")
|
||||
val jwtSecret = dotenv["JWT_SECRET"]
|
||||
val issuer = dotenv["JWT_ISSUER"]
|
||||
val validityInMin = dotenv["JWT_VALIDITY_IN_MIN"].toInt()
|
||||
|
||||
AuthenticationService(issuer, validityInMin, jwtSecret, authSHA256DigestString)
|
||||
val authSHA256DigestString = dotenv["AUTH_SHA256_DIGEST"]
|
||||
|
||||
AuthService(issuer, validityInMin, jwtSecret, authSHA256DigestString)
|
||||
}
|
||||
single {
|
||||
val configuration = get<ConfigurationRepository>()
|
||||
|
||||
OldApiService(
|
||||
get {
|
||||
parameterArrayOf(configuration.oldApiEndpoint)
|
||||
},
|
||||
)
|
||||
}
|
||||
singleOf(::AnnouncementService)
|
||||
singleOf(::SignatureService)
|
||||
@ -60,6 +140,7 @@ fun Application.configureDependencies(
|
||||
|
||||
install(Koin) {
|
||||
modules(
|
||||
globalModule,
|
||||
repositoryModule,
|
||||
serviceModule,
|
||||
)
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
package app.revanced.api.configuration
|
||||
|
||||
import io.bkbn.kompendium.core.metadata.MethodInfo
|
||||
import io.bkbn.kompendium.core.plugin.NotarizedRoute
|
||||
import io.ktor.http.*
|
||||
import io.ktor.http.content.*
|
||||
@ -41,11 +40,3 @@ internal fun Route.staticFiles(
|
||||
extensions("json")
|
||||
},
|
||||
) = staticFiles(remotePath, dir.toFile(), null, block)
|
||||
|
||||
internal fun MethodInfo.Builder<*>.canRespondUnauthorized() {
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.Unauthorized)
|
||||
description("Unauthorized")
|
||||
responseType<Unit>()
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
package app.revanced.api.configuration
|
||||
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.plugins.*
|
||||
import io.ktor.server.plugins.cors.routing.*
|
||||
@ -11,19 +10,14 @@ import org.koin.ktor.ext.get
|
||||
import kotlin.time.Duration.Companion.minutes
|
||||
|
||||
fun Application.configureHTTP() {
|
||||
val configuration = get<ConfigurationRepository>()
|
||||
val configurationRepository = get<ConfigurationRepository>()
|
||||
|
||||
install(CORS) {
|
||||
HttpMethod.DefaultMethods.minus(HttpMethod.Options).forEach(::allowMethod)
|
||||
|
||||
allowHeader(HttpHeaders.ContentType)
|
||||
allowHeader(HttpHeaders.Authorization)
|
||||
exposeHeader(HttpHeaders.WWWAuthenticate)
|
||||
|
||||
allowCredentials = true
|
||||
|
||||
configuration.corsAllowedHosts.forEach { host ->
|
||||
allowHost(host = host, schemes = listOf("https"))
|
||||
configurationRepository.corsAllowedHosts.forEach { host ->
|
||||
allowHost(
|
||||
host = host,
|
||||
schemes = listOf("http", "https")
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -2,7 +2,6 @@ package app.revanced.api.configuration
|
||||
|
||||
import app.revanced.api.command.applicationVersion
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import io.bkbn.kompendium.core.attribute.KompendiumAttributes
|
||||
import io.bkbn.kompendium.core.plugin.NotarizedApplication
|
||||
import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
|
||||
import io.bkbn.kompendium.oas.OpenApiSpec
|
||||
@ -13,22 +12,13 @@ import io.bkbn.kompendium.oas.info.License
|
||||
import io.bkbn.kompendium.oas.security.BearerAuth
|
||||
import io.bkbn.kompendium.oas.server.Server
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.response.*
|
||||
import io.ktor.server.routing.*
|
||||
import org.koin.ktor.ext.get
|
||||
import java.net.URI
|
||||
import org.koin.ktor.ext.get as koinGet
|
||||
|
||||
internal fun Application.configureOpenAPI() {
|
||||
val configuration = koinGet<ConfigurationRepository>()
|
||||
val configurationRepository = get<ConfigurationRepository>()
|
||||
|
||||
install(NotarizedApplication()) {
|
||||
openApiJson = {
|
||||
route("/${configuration.apiVersion}/openapi.json") {
|
||||
get {
|
||||
call.respond(application.attributes[KompendiumAttributes.openApiSpec])
|
||||
}
|
||||
}
|
||||
}
|
||||
spec = OpenApiSpec(
|
||||
info = Info(
|
||||
title = "ReVanced API",
|
||||
@ -51,7 +41,7 @@ internal fun Application.configureOpenAPI() {
|
||||
),
|
||||
).apply {
|
||||
servers += Server(
|
||||
url = URI(configuration.endpoint),
|
||||
url = URI(configurationRepository.endpoint),
|
||||
description = "ReVanced API server",
|
||||
)
|
||||
}
|
||||
|
||||
@ -4,6 +4,7 @@ import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import app.revanced.api.configuration.routes.*
|
||||
import app.revanced.api.configuration.routes.announcementsRoute
|
||||
import app.revanced.api.configuration.routes.apiRoute
|
||||
import app.revanced.api.configuration.routes.oldApiRoute
|
||||
import app.revanced.api.configuration.routes.patchesRoute
|
||||
import io.bkbn.kompendium.core.routes.redoc
|
||||
import io.bkbn.kompendium.core.routes.swagger
|
||||
@ -18,7 +19,7 @@ internal fun Application.configureRouting() = routing {
|
||||
|
||||
installCache(5.minutes)
|
||||
|
||||
route("/${configuration.apiVersion}") {
|
||||
route("/v${configuration.apiVersion}") {
|
||||
announcementsRoute()
|
||||
patchesRoute()
|
||||
managerRoute()
|
||||
@ -52,7 +53,9 @@ internal fun Application.configureRouting() = routing {
|
||||
extensions("json", "asc")
|
||||
}
|
||||
|
||||
val specUrl = "/${configuration.apiVersion}/openapi.json"
|
||||
swagger(pageTitle = "ReVanced API", path = "/", specUrl = specUrl)
|
||||
redoc(pageTitle = "ReVanced API", path = "/redoc", specUrl = specUrl)
|
||||
swagger(pageTitle = "ReVanced API", path = "/")
|
||||
redoc(pageTitle = "ReVanced API", path = "/redoc")
|
||||
|
||||
// TODO: Remove, once migration period from v2 API is over (In 1-2 years).
|
||||
oldApiRoute()
|
||||
}
|
||||
|
||||
@ -1,17 +1,9 @@
|
||||
package app.revanced.api.configuration
|
||||
|
||||
import app.revanced.api.configuration.services.AuthenticationService
|
||||
import app.revanced.api.configuration.services.AuthService
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.auth.*
|
||||
import org.koin.ktor.ext.get
|
||||
|
||||
fun Application.configureSecurity() {
|
||||
val authenticationService = get<AuthenticationService>()
|
||||
|
||||
install(Authentication) {
|
||||
with(authenticationService) {
|
||||
jwt()
|
||||
digest()
|
||||
}
|
||||
}
|
||||
get<AuthService>().configureSecurity(this)
|
||||
}
|
||||
|
||||
@ -1,11 +1,12 @@
|
||||
package app.revanced.api.configuration.repository
|
||||
|
||||
import app.revanced.api.configuration.ApiAnnouncement
|
||||
import app.revanced.api.configuration.ApiAnnouncementTag
|
||||
import app.revanced.api.configuration.ApiResponseAnnouncement
|
||||
import app.revanced.api.configuration.ApiResponseAnnouncementId
|
||||
import app.revanced.api.configuration.schema.APIAnnouncement
|
||||
import app.revanced.api.configuration.schema.APIResponseAnnouncement
|
||||
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.awaitAll
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import kotlinx.datetime.*
|
||||
import org.jetbrains.exposed.dao.IntEntity
|
||||
import org.jetbrains.exposed.dao.IntEntityClass
|
||||
import org.jetbrains.exposed.dao.id.EntityID
|
||||
@ -14,178 +15,136 @@ import org.jetbrains.exposed.sql.*
|
||||
import org.jetbrains.exposed.sql.kotlin.datetime.CurrentDateTime
|
||||
import org.jetbrains.exposed.sql.kotlin.datetime.datetime
|
||||
import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
|
||||
import org.jetbrains.exposed.sql.transactions.experimental.suspendedTransactionAsync
|
||||
|
||||
internal class AnnouncementRepository(private val database: Database) {
|
||||
// This is better than doing a maxByOrNull { it.id } on every request.
|
||||
internal class AnnouncementRepository {
|
||||
// This is better than doing a maxByOrNull { it.id }.
|
||||
private var latestAnnouncement: Announcement? = null
|
||||
private val latestAnnouncementByTag = mutableMapOf<String, Announcement>()
|
||||
private val latestAnnouncementByChannel = mutableMapOf<String, Announcement>()
|
||||
|
||||
private fun updateLatestAnnouncement(new: Announcement) {
|
||||
if (latestAnnouncement?.id?.value == new.id.value) {
|
||||
latestAnnouncement = new
|
||||
latestAnnouncementByChannel[new.channel ?: return] = new
|
||||
}
|
||||
}
|
||||
|
||||
init {
|
||||
runBlocking {
|
||||
transaction {
|
||||
SchemaUtils.create(
|
||||
Announcements,
|
||||
Attachments,
|
||||
Tags,
|
||||
AnnouncementTags,
|
||||
)
|
||||
SchemaUtils.create(Announcements, Attachments)
|
||||
|
||||
initializeLatestAnnouncements()
|
||||
// Initialize the latest announcement.
|
||||
latestAnnouncement = Announcement.all().onEach {
|
||||
latestAnnouncementByChannel[it.channel ?: return@onEach] = it
|
||||
}.maxByOrNull { it.id } ?: return@transaction
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun initializeLatestAnnouncements() {
|
||||
latestAnnouncement = Announcement.all().orderBy(Announcements.id to SortOrder.DESC).firstOrNull()
|
||||
|
||||
Tag.all().map { it.name }.forEach(::updateLatestAnnouncementForTag)
|
||||
suspend fun all() = transaction {
|
||||
Announcement.all().map { it.toApi() }
|
||||
}
|
||||
|
||||
private fun updateLatestAnnouncement(new: Announcement) {
|
||||
if (latestAnnouncement == null || latestAnnouncement!!.id.value <= new.id.value) {
|
||||
latestAnnouncement = new
|
||||
new.tags.forEach { tag -> latestAnnouncementByTag[tag.name] = new }
|
||||
}
|
||||
}
|
||||
|
||||
private fun updateLatestAnnouncementForTag(tag: String) {
|
||||
val latestAnnouncementForTag = Tags.innerJoin(AnnouncementTags)
|
||||
.select(AnnouncementTags.announcement)
|
||||
.where { Tags.name eq tag }
|
||||
.orderBy(AnnouncementTags.announcement to SortOrder.DESC)
|
||||
.limit(1)
|
||||
.firstNotNullOfOrNull { Announcement.findById(it[AnnouncementTags.announcement]) }
|
||||
|
||||
latestAnnouncementForTag?.let { latestAnnouncementByTag[tag] = it }
|
||||
}
|
||||
|
||||
suspend fun latest() = transaction {
|
||||
latestAnnouncement.toApiResponseAnnouncement()
|
||||
}
|
||||
|
||||
suspend fun latest(tags: Set<String>) = transaction {
|
||||
tags.mapNotNull { tag -> latestAnnouncementByTag[tag] }.toApiAnnouncement()
|
||||
}
|
||||
|
||||
fun latestId() = latestAnnouncement?.id?.value.toApiResponseAnnouncementId()
|
||||
|
||||
fun latestId(tags: Set<String>) = tags.map { tag -> latestAnnouncementByTag[tag]?.id?.value }.toApiResponseAnnouncementId()
|
||||
|
||||
suspend fun paged(cursor: Int, count: Int, tags: Set<String>?) = transaction {
|
||||
Announcement.find {
|
||||
fun idLessEq() = Announcements.id lessEq cursor
|
||||
|
||||
if (tags == null) {
|
||||
idLessEq()
|
||||
} else {
|
||||
fun hasTags() = Announcements.id inSubQuery (
|
||||
AnnouncementTags.innerJoin(Tags)
|
||||
.select(AnnouncementTags.announcement)
|
||||
.withDistinct()
|
||||
.where { Tags.name inList tags }
|
||||
)
|
||||
|
||||
idLessEq() and hasTags()
|
||||
}
|
||||
}.orderBy(Announcements.id to SortOrder.DESC).limit(count).toApiAnnouncement()
|
||||
}
|
||||
|
||||
suspend fun get(id: Int) = transaction {
|
||||
Announcement.findById(id).toApiResponseAnnouncement()
|
||||
}
|
||||
|
||||
suspend fun new(new: ApiAnnouncement) = transaction {
|
||||
Announcement.new {
|
||||
author = new.author
|
||||
title = new.title
|
||||
content = new.content
|
||||
createdAt = new.createdAt
|
||||
archivedAt = new.archivedAt
|
||||
level = new.level
|
||||
if (new.tags != null) {
|
||||
tags = SizedCollection(
|
||||
new.tags.map { tag -> Tag.find { Tags.name eq tag }.firstOrNull() ?: Tag.new { name = tag } },
|
||||
)
|
||||
}
|
||||
}.apply {
|
||||
new.attachments?.map { attachmentUrl ->
|
||||
Attachment.new {
|
||||
url = attachmentUrl
|
||||
announcement = this@apply
|
||||
}
|
||||
}
|
||||
}.let(::updateLatestAnnouncement)
|
||||
}
|
||||
|
||||
suspend fun update(id: Int, new: ApiAnnouncement) = transaction {
|
||||
Announcement.findByIdAndUpdate(id) {
|
||||
it.author = new.author
|
||||
it.title = new.title
|
||||
it.content = new.content
|
||||
it.createdAt = new.createdAt
|
||||
it.archivedAt = new.archivedAt
|
||||
it.level = new.level
|
||||
|
||||
if (new.tags != null) {
|
||||
// Get the old tags, create new tags if they don't exist,
|
||||
// and delete tags that are not in the new tags, after updating the announcement.
|
||||
val oldTags = it.tags.toList()
|
||||
val updatedTags = new.tags.map { name ->
|
||||
Tag.find { Tags.name eq name }.firstOrNull() ?: Tag.new { this.name = name }
|
||||
}
|
||||
it.tags = SizedCollection(updatedTags)
|
||||
oldTags.forEach { tag ->
|
||||
if (tag in updatedTags || !tag.announcements.empty()) return@forEach
|
||||
tag.delete()
|
||||
}
|
||||
}
|
||||
|
||||
// Delete old attachments and create new attachments.
|
||||
if (new.attachments != null) {
|
||||
it.attachments.forEach { attachment -> attachment.delete() }
|
||||
new.attachments.map { attachment ->
|
||||
Attachment.new {
|
||||
url = attachment
|
||||
announcement = it
|
||||
}
|
||||
}
|
||||
}
|
||||
}?.let(::updateLatestAnnouncement) ?: Unit
|
||||
suspend fun all(channel: String) = transaction {
|
||||
Announcement.find { Announcements.channel eq channel }.map { it.toApi() }
|
||||
}
|
||||
|
||||
suspend fun delete(id: Int) = transaction {
|
||||
val announcement = Announcement.findById(id) ?: return@transaction
|
||||
|
||||
// Delete the tag if no other announcements are referencing it.
|
||||
// One count means that the announcement is the only one referencing the tag.
|
||||
announcement.tags.filter { tag -> tag.announcements.count() == 1L }.forEach { tag ->
|
||||
latestAnnouncementByTag -= tag.name
|
||||
tag.delete()
|
||||
}
|
||||
|
||||
announcement.delete()
|
||||
|
||||
// If the deleted announcement is the latest announcement, set the new latest announcement.
|
||||
// In case the latest announcement was deleted, query the new latest announcement again.
|
||||
if (latestAnnouncement?.id?.value == id) {
|
||||
latestAnnouncement = Announcement.all().orderBy(Announcements.id to SortOrder.DESC).firstOrNull()
|
||||
}
|
||||
latestAnnouncement = Announcement.all().maxByOrNull { it.id }
|
||||
|
||||
// The new announcement may be the latest for a specific tag. Set the new latest announcement for that tag.
|
||||
latestAnnouncementByTag.keys.forEach { tag ->
|
||||
updateLatestAnnouncementForTag(tag)
|
||||
// If no latest announcement was found, remove it from the channel map.
|
||||
if (latestAnnouncement == null) {
|
||||
latestAnnouncementByChannel.remove(announcement.channel)
|
||||
} else {
|
||||
latestAnnouncementByChannel[latestAnnouncement!!.channel ?: return@transaction] = latestAnnouncement!!
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
suspend fun tags() = transaction {
|
||||
Tag.all().toList().toApiTag()
|
||||
fun latest() = latestAnnouncement?.toApi()
|
||||
|
||||
fun latest(channel: String) = latestAnnouncementByChannel[channel]?.toApi()
|
||||
|
||||
fun latestId() = latest()?.id?.toApi()
|
||||
|
||||
fun latestId(channel: String) = latest(channel)?.id?.toApi()
|
||||
|
||||
suspend fun archive(
|
||||
id: Int,
|
||||
archivedAt: LocalDateTime?,
|
||||
) = transaction {
|
||||
Announcement.findByIdAndUpdate(id) {
|
||||
it.archivedAt = archivedAt ?: java.time.LocalDateTime.now().toKotlinLocalDateTime()
|
||||
}?.also(::updateLatestAnnouncement)
|
||||
}
|
||||
|
||||
private suspend fun <T> transaction(statement: suspend Transaction.() -> T) = newSuspendedTransaction(Dispatchers.IO, database, statement = statement)
|
||||
suspend fun unarchive(id: Int) = transaction {
|
||||
Announcement.findByIdAndUpdate(id) {
|
||||
it.archivedAt = null
|
||||
}?.also(::updateLatestAnnouncement)
|
||||
}
|
||||
|
||||
suspend fun new(new: APIAnnouncement) = transaction {
|
||||
Announcement.new {
|
||||
author = new.author
|
||||
title = new.title
|
||||
content = new.content
|
||||
channel = new.channel
|
||||
archivedAt = new.archivedAt
|
||||
level = new.level
|
||||
}.also { newAnnouncement ->
|
||||
new.attachmentUrls.map { newUrl ->
|
||||
suspendedTransactionAsync {
|
||||
Attachment.new {
|
||||
url = newUrl
|
||||
announcement = newAnnouncement
|
||||
}
|
||||
}
|
||||
}.awaitAll()
|
||||
}.also(::updateLatestAnnouncement)
|
||||
}
|
||||
|
||||
suspend fun update(id: Int, new: APIAnnouncement) = transaction {
|
||||
Announcement.findByIdAndUpdate(id) {
|
||||
it.author = new.author
|
||||
it.title = new.title
|
||||
it.content = new.content
|
||||
it.channel = new.channel
|
||||
it.archivedAt = new.archivedAt
|
||||
it.level = new.level
|
||||
}?.also { newAnnouncement ->
|
||||
newAnnouncement.attachments.map {
|
||||
suspendedTransactionAsync {
|
||||
it.delete()
|
||||
}
|
||||
}.awaitAll()
|
||||
|
||||
new.attachmentUrls.map { newUrl ->
|
||||
suspendedTransactionAsync {
|
||||
Attachment.new {
|
||||
url = newUrl
|
||||
announcement = newAnnouncement
|
||||
}
|
||||
}
|
||||
}.awaitAll()
|
||||
}?.also(::updateLatestAnnouncement)
|
||||
}
|
||||
|
||||
private suspend fun <T> transaction(statement: suspend Transaction.() -> T) =
|
||||
newSuspendedTransaction(Dispatchers.IO, statement = statement)
|
||||
|
||||
private object Announcements : IntIdTable() {
|
||||
val author = varchar("author", 32).nullable()
|
||||
val title = varchar("title", 64)
|
||||
val content = text("content").nullable()
|
||||
val channel = varchar("channel", 16).nullable()
|
||||
val createdAt = datetime("createdAt").defaultExpression(CurrentDateTime)
|
||||
val archivedAt = datetime("archivedAt").nullable()
|
||||
val level = integer("level")
|
||||
@ -196,19 +155,6 @@ internal class AnnouncementRepository(private val database: Database) {
|
||||
val announcement = reference("announcement", Announcements, onDelete = ReferenceOption.CASCADE)
|
||||
}
|
||||
|
||||
private object Tags : IntIdTable() {
|
||||
val name = varchar("name", 16).uniqueIndex()
|
||||
}
|
||||
|
||||
private object AnnouncementTags : Table() {
|
||||
val tag = reference("tag", Tags, onDelete = ReferenceOption.CASCADE)
|
||||
val announcement = reference("announcement", Announcements, onDelete = ReferenceOption.CASCADE)
|
||||
|
||||
init {
|
||||
uniqueIndex(tag, announcement)
|
||||
}
|
||||
}
|
||||
|
||||
class Announcement(id: EntityID<Int>) : IntEntity(id) {
|
||||
companion object : IntEntityClass<Announcement>(Announcements)
|
||||
|
||||
@ -216,7 +162,7 @@ internal class AnnouncementRepository(private val database: Database) {
|
||||
var title by Announcements.title
|
||||
var content by Announcements.content
|
||||
val attachments by Attachment referrersOn Attachments.announcement
|
||||
var tags by Tag via AnnouncementTags
|
||||
var channel by Announcements.channel
|
||||
var createdAt by Announcements.createdAt
|
||||
var archivedAt by Announcements.archivedAt
|
||||
var level by Announcements.level
|
||||
@ -229,32 +175,17 @@ internal class AnnouncementRepository(private val database: Database) {
|
||||
var announcement by Announcement referencedOn Attachments.announcement
|
||||
}
|
||||
|
||||
class Tag(id: EntityID<Int>) : IntEntity(id) {
|
||||
companion object : IntEntityClass<Tag>(Tags)
|
||||
|
||||
var name by Tags.name
|
||||
var announcements by Announcement via AnnouncementTags
|
||||
}
|
||||
|
||||
private fun Announcement?.toApiResponseAnnouncement() = this?.let {
|
||||
ApiResponseAnnouncement(
|
||||
private fun Announcement.toApi() = APIResponseAnnouncement(
|
||||
id.value,
|
||||
author,
|
||||
title,
|
||||
content,
|
||||
attachments.map { it.url },
|
||||
tags.map { it.name },
|
||||
channel,
|
||||
createdAt,
|
||||
archivedAt,
|
||||
level,
|
||||
)
|
||||
}
|
||||
|
||||
private fun Iterable<Announcement>.toApiAnnouncement() = map { it.toApiResponseAnnouncement()!! }
|
||||
|
||||
private fun Iterable<Tag>.toApiTag() = map { ApiAnnouncementTag(it.name) }
|
||||
|
||||
private fun Int?.toApiResponseAnnouncementId() = this?.let { ApiResponseAnnouncementId(this) }
|
||||
|
||||
private fun Iterable<Int?>.toApiResponseAnnouncementId() = map { it.toApiResponseAnnouncementId() }
|
||||
|
||||
private fun Int.toApi() = APIResponseAnnouncementId(this)
|
||||
}
|
||||
|
||||
@ -1,59 +1,16 @@
|
||||
package app.revanced.api.configuration.repository
|
||||
|
||||
import io.ktor.client.*
|
||||
import io.ktor.client.engine.okhttp.*
|
||||
import io.ktor.client.plugins.*
|
||||
import io.ktor.client.plugins.auth.*
|
||||
import io.ktor.client.plugins.auth.providers.*
|
||||
import io.ktor.client.plugins.cache.*
|
||||
import io.ktor.client.plugins.contentnegotiation.*
|
||||
import io.ktor.client.plugins.resources.*
|
||||
import io.ktor.serialization.kotlinx.json.*
|
||||
import kotlinx.datetime.LocalDateTime
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonNamingStrategy
|
||||
|
||||
/**
|
||||
* The backend of the API used to get data.
|
||||
*
|
||||
* @param defaultRequestUri The URI to use for requests.
|
||||
* @param website The site of the backend users can visit.
|
||||
* @param client The HTTP client to use for requests.
|
||||
*/
|
||||
abstract class BackendRepository internal constructor(
|
||||
defaultRequestUri: String,
|
||||
internal val website: String,
|
||||
protected val client: HttpClient,
|
||||
) {
|
||||
protected val client: HttpClient = HttpClient(OkHttp) {
|
||||
defaultRequest { url(defaultRequestUri) }
|
||||
|
||||
install(HttpCache)
|
||||
install(Resources)
|
||||
install(ContentNegotiation) {
|
||||
json(
|
||||
Json {
|
||||
ignoreUnknownKeys = true
|
||||
@Suppress("OPT_IN_USAGE")
|
||||
namingStrategy = JsonNamingStrategy.SnakeCase
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
System.getProperty("BACKEND_API_TOKEN")?.let {
|
||||
install(Auth) {
|
||||
bearer {
|
||||
loadTokens {
|
||||
BearerTokens(
|
||||
accessToken = it,
|
||||
refreshToken = "", // Required dummy value
|
||||
)
|
||||
}
|
||||
|
||||
sendWithoutRequest { true }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A user.
|
||||
*
|
||||
@ -135,14 +92,12 @@ abstract class BackendRepository internal constructor(
|
||||
* @property tag The tag of the release.
|
||||
* @property assets The assets of the release.
|
||||
* @property createdAt The date and time the release was created.
|
||||
* @property prerelease Whether the release is a prerelease.
|
||||
* @property releaseNote The release note of the release.
|
||||
*/
|
||||
class BackendRelease(
|
||||
val tag: String,
|
||||
val releaseNote: String,
|
||||
val createdAt: LocalDateTime,
|
||||
val prerelease: Boolean,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val assets: List<BackendAsset>,
|
||||
) {
|
||||
@ -182,13 +137,13 @@ abstract class BackendRepository internal constructor(
|
||||
*
|
||||
* @param owner The owner of the repository.
|
||||
* @param repository The name of the repository.
|
||||
* @param prerelease Whether to get a prerelease.
|
||||
* @param tag The tag of the release. If null, the latest release is returned.
|
||||
* @return The release.
|
||||
*/
|
||||
abstract suspend fun release(
|
||||
owner: String,
|
||||
repository: String,
|
||||
prerelease: Boolean,
|
||||
tag: String? = null,
|
||||
): BackendOrganization.BackendRepository.BackendRelease
|
||||
|
||||
/**
|
||||
@ -198,10 +153,7 @@ abstract class BackendRepository internal constructor(
|
||||
* @param repository The name of the repository.
|
||||
* @return The contributors.
|
||||
*/
|
||||
abstract suspend fun contributors(
|
||||
owner: String,
|
||||
repository: String,
|
||||
): List<BackendOrganization.BackendRepository.BackendContributor>
|
||||
abstract suspend fun contributors(owner: String, repository: String): List<BackendOrganization.BackendRepository.BackendContributor>
|
||||
|
||||
/**
|
||||
* Get the members of an organization.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
package app.revanced.api.configuration.repository
|
||||
|
||||
import app.revanced.api.configuration.APIAbout
|
||||
import app.revanced.api.configuration.schema.APIAbout
|
||||
import app.revanced.api.configuration.services.ManagerService
|
||||
import app.revanced.api.configuration.services.PatchesService
|
||||
import kotlinx.serialization.ExperimentalSerializationApi
|
||||
@ -17,19 +17,19 @@ import kotlinx.serialization.json.JsonNamingStrategy
|
||||
import kotlinx.serialization.json.decodeFromStream
|
||||
import java.io.File
|
||||
import java.nio.file.Path
|
||||
import kotlin.io.path.createDirectories
|
||||
|
||||
/**
|
||||
* The repository storing the configuration for the API.
|
||||
*
|
||||
* @property organization The API backends organization name where the repositories are.
|
||||
* @property organization The API backends organization name where the repositories for the patches and integrations are.
|
||||
* @property patches The source of the patches.
|
||||
* @property integrations The source of the integrations.
|
||||
* @property manager The source of the manager.
|
||||
* @property contributorsRepositoryNames The friendly name of repos mapped to the repository names to get contributors from.
|
||||
* @property backendServiceName The name of the backend service to use for the repositories, contributors, etc.
|
||||
* @property contributorsRepositoryNames The names of the repositories to get contributors from.
|
||||
* @property apiVersion The version to use for the API.
|
||||
* @property corsAllowedHosts The hosts allowed to make requests to the API.
|
||||
* @property endpoint The endpoint of the API.
|
||||
* @property oldApiEndpoint The endpoint of the old API to proxy requests to.
|
||||
* @property staticFilesPath The path to the static files to be served under the root path.
|
||||
* @property versionedStaticFilesPath The path to the static files to be served under a versioned path.
|
||||
* @property about The path to the json file deserialized to [APIAbout]
|
||||
@ -39,16 +39,17 @@ import kotlin.io.path.createDirectories
|
||||
internal class ConfigurationRepository(
|
||||
val organization: String,
|
||||
val patches: SignedAssetConfiguration,
|
||||
val integrations: SignedAssetConfiguration,
|
||||
val manager: AssetConfiguration,
|
||||
@SerialName("contributors-repositories")
|
||||
val contributorsRepositoryNames: Map<String, String>,
|
||||
@SerialName("backend-service-name")
|
||||
val backendServiceName: String,
|
||||
val contributorsRepositoryNames: Set<String>,
|
||||
@SerialName("api-version")
|
||||
val apiVersion: String = "v1",
|
||||
val apiVersion: Int = 1,
|
||||
@SerialName("cors-allowed-hosts")
|
||||
val corsAllowedHosts: Set<String>,
|
||||
val endpoint: String,
|
||||
@SerialName("old-api-endpoint")
|
||||
val oldApiEndpoint: String,
|
||||
@Serializable(with = PathSerializer::class)
|
||||
@SerialName("static-files-path")
|
||||
val staticFilesPath: Path,
|
||||
@ -59,11 +60,6 @@ internal class ConfigurationRepository(
|
||||
@SerialName("about-json-file-path")
|
||||
val about: APIAbout,
|
||||
) {
|
||||
init {
|
||||
staticFilesPath.createDirectories()
|
||||
versionedStaticFilesPath.createDirectories()
|
||||
}
|
||||
|
||||
/**
|
||||
* Am asset configuration whose asset is signed.
|
||||
*
|
||||
|
||||
@ -8,26 +8,25 @@ import app.revanced.api.configuration.repository.GitHubOrganization.GitHubReposi
|
||||
import app.revanced.api.configuration.repository.GitHubOrganization.GitHubRepository.GitHubRelease
|
||||
import app.revanced.api.configuration.repository.Organization.Repository.Contributors
|
||||
import app.revanced.api.configuration.repository.Organization.Repository.Releases
|
||||
import io.ktor.client.*
|
||||
import io.ktor.client.call.*
|
||||
import io.ktor.client.plugins.resources.*
|
||||
import io.ktor.resources.*
|
||||
import kotlinx.coroutines.async
|
||||
import kotlinx.coroutines.awaitAll
|
||||
import kotlinx.coroutines.coroutineScope
|
||||
import kotlinx.coroutines.*
|
||||
import kotlinx.datetime.Instant
|
||||
import kotlinx.datetime.TimeZone
|
||||
import kotlinx.datetime.toLocalDateTime
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
class GitHubBackendRepository : BackendRepository("https://api.github.com", "https://github.com") {
|
||||
class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
||||
override suspend fun release(
|
||||
owner: String,
|
||||
repository: String,
|
||||
prerelease: Boolean,
|
||||
tag: String?,
|
||||
): BackendRelease {
|
||||
val release: GitHubRelease = if (prerelease) {
|
||||
client.get(Releases(owner, repository)).body<List<GitHubRelease>>().first { it.prerelease }
|
||||
val release: GitHubRelease = if (tag != null) {
|
||||
client.get(Releases.Tag(owner, repository, tag)).body()
|
||||
} else {
|
||||
client.get(Releases.Latest(owner, repository)).body()
|
||||
}
|
||||
@ -36,7 +35,6 @@ class GitHubBackendRepository : BackendRepository("https://api.github.com", "htt
|
||||
tag = release.tagName,
|
||||
releaseNote = release.body,
|
||||
createdAt = release.createdAt.toLocalDateTime(TimeZone.UTC),
|
||||
prerelease = release.prerelease,
|
||||
assets = release.assets.map {
|
||||
BackendAsset(
|
||||
name = it.name,
|
||||
@ -69,8 +67,7 @@ class GitHubBackendRepository : BackendRepository("https://api.github.com", "htt
|
||||
|
||||
override suspend fun members(organization: String): List<BackendMember> {
|
||||
// Get the list of members of the organization.
|
||||
val publicMembers: List<GitHubOrganization.GitHubMember> =
|
||||
client.get(Organization.PublicMembers(organization)).body()
|
||||
val publicMembers: List<GitHubOrganization.GitHubMember> = client.get(Organization.PublicMembers(organization)).body()
|
||||
|
||||
return coroutineScope {
|
||||
publicMembers.map { member ->
|
||||
@ -101,7 +98,7 @@ class GitHubBackendRepository : BackendRepository("https://api.github.com", "htt
|
||||
gpgKeys =
|
||||
BackendMember.GpgKeys(
|
||||
ids = gpgKeys.map { it.keyId },
|
||||
url = "https://github.com/${user.login}.gpg",
|
||||
url = "https://api.github.com/users/${user.login}.gpg",
|
||||
),
|
||||
)
|
||||
}
|
||||
@ -116,10 +113,6 @@ class GitHubBackendRepository : BackendRepository("https://api.github.com", "htt
|
||||
reset = Instant.fromEpochSeconds(rateLimit.rate.reset).toLocalDateTime(TimeZone.UTC),
|
||||
)
|
||||
}
|
||||
|
||||
companion object {
|
||||
const val SERVICE_NAME = "GitHub"
|
||||
}
|
||||
}
|
||||
|
||||
interface IGitHubUser {
|
||||
@ -164,7 +157,6 @@ class GitHubOrganization {
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val assets: List<GitHubAsset>,
|
||||
val createdAt: Instant,
|
||||
val prerelease: Boolean,
|
||||
val body: String,
|
||||
) {
|
||||
@Serializable
|
||||
@ -202,8 +194,10 @@ class Organization {
|
||||
@Resource("/repos/{owner}/{repo}/contributors")
|
||||
class Contributors(val owner: String, val repo: String, @SerialName("per_page") val perPage: Int = 100)
|
||||
|
||||
@Resource("/repos/{owner}/{repo}/releases")
|
||||
class Releases(val owner: String, val repo: String) {
|
||||
class Releases {
|
||||
@Resource("/repos/{owner}/{repo}/releases/tags/{tag}")
|
||||
class Tag(val owner: String, val repo: String, val tag: String)
|
||||
|
||||
@Resource("/repos/{owner}/{repo}/releases/latest")
|
||||
class Latest(val owner: String, val repo: String)
|
||||
}
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
package app.revanced.api.configuration.routes
|
||||
|
||||
import app.revanced.api.configuration.ApiAnnouncement
|
||||
import app.revanced.api.configuration.ApiResponseAnnouncement
|
||||
import app.revanced.api.configuration.ApiResponseAnnouncementId
|
||||
import app.revanced.api.configuration.canRespondUnauthorized
|
||||
import app.revanced.api.configuration.installCache
|
||||
import app.revanced.api.configuration.installNotarizedRoute
|
||||
import app.revanced.api.configuration.respondOrNotFound
|
||||
import app.revanced.api.configuration.schema.APIAnnouncement
|
||||
import app.revanced.api.configuration.schema.APIAnnouncementArchivedAt
|
||||
import app.revanced.api.configuration.schema.APIResponseAnnouncement
|
||||
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
||||
import app.revanced.api.configuration.services.AnnouncementService
|
||||
import io.bkbn.kompendium.core.metadata.DeleteInfo
|
||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
||||
@ -18,6 +18,7 @@ import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.auth.*
|
||||
import io.ktor.server.plugins.ratelimit.*
|
||||
import io.ktor.server.request.*
|
||||
import io.ktor.server.response.*
|
||||
import io.ktor.server.routing.*
|
||||
import io.ktor.server.util.*
|
||||
@ -33,177 +34,139 @@ internal fun Route.announcementsRoute() = route("announcements") {
|
||||
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
get {
|
||||
val cursor = call.parameters["cursor"]?.toInt() ?: Int.MAX_VALUE
|
||||
val count = call.parameters["count"]?.toInt() ?: 16
|
||||
val tags = call.parameters.getAll("tag")
|
||||
|
||||
call.respond(announcementService.paged(cursor, count, tags?.toSet()))
|
||||
call.respond(announcementService.all())
|
||||
}
|
||||
}
|
||||
|
||||
rateLimit(RateLimitName("weak")) {
|
||||
authenticate("jwt") {
|
||||
post<ApiAnnouncement> { announcement ->
|
||||
announcementService.new(announcement)
|
||||
|
||||
call.respond(HttpStatusCode.OK)
|
||||
}
|
||||
}
|
||||
|
||||
route("latest") {
|
||||
installAnnouncementsLatestRouteDocumentation()
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
route("{channel}/latest") {
|
||||
installLatestChannelAnnouncementRouteDocumentation()
|
||||
|
||||
get {
|
||||
val tags = call.parameters.getAll("tag")
|
||||
val channel: String by call.parameters
|
||||
|
||||
if (tags?.isNotEmpty() == true) {
|
||||
call.respond(announcementService.latest(tags.toSet()))
|
||||
} else {
|
||||
call.respondOrNotFound(announcementService.latest())
|
||||
}
|
||||
call.respondOrNotFound(announcementService.latest(channel))
|
||||
}
|
||||
|
||||
route("id") {
|
||||
installAnnouncementsLatestIdRouteDocumentation()
|
||||
installLatestChannelAnnouncementIdRouteDocumentation()
|
||||
|
||||
get {
|
||||
val tags = call.parameters.getAll("tag")
|
||||
val channel: String by call.parameters
|
||||
|
||||
if (tags?.isNotEmpty() == true) {
|
||||
call.respond(announcementService.latestId(tags.toSet()))
|
||||
} else {
|
||||
call.respondOrNotFound(announcementService.latestId(channel))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
route("{channel}") {
|
||||
installChannelAnnouncementsRouteDocumentation()
|
||||
|
||||
get {
|
||||
val channel: String by call.parameters
|
||||
|
||||
call.respond(announcementService.all(channel))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
route("latest") {
|
||||
installLatestAnnouncementRouteDocumentation()
|
||||
|
||||
get {
|
||||
call.respondOrNotFound(announcementService.latest())
|
||||
}
|
||||
|
||||
route("id") {
|
||||
installLatestAnnouncementIdRouteDocumentation()
|
||||
|
||||
get {
|
||||
call.respondOrNotFound(announcementService.latestId())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
route("{id}") {
|
||||
installAnnouncementsIdRouteDocumentation()
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
authenticate("jwt") {
|
||||
installAnnouncementRouteDocumentation()
|
||||
|
||||
get {
|
||||
val id: Int by call.parameters
|
||||
|
||||
call.respondOrNotFound(announcementService.get(id))
|
||||
post<APIAnnouncement> { announcement ->
|
||||
announcementService.new(announcement)
|
||||
}
|
||||
|
||||
authenticate("jwt") {
|
||||
patch<ApiAnnouncement> { announcement ->
|
||||
route("{id}") {
|
||||
installAnnouncementIdRouteDocumentation()
|
||||
|
||||
patch<APIAnnouncement> { announcement ->
|
||||
val id: Int by call.parameters
|
||||
|
||||
announcementService.update(id, announcement)
|
||||
|
||||
call.respond(HttpStatusCode.OK)
|
||||
}
|
||||
|
||||
delete {
|
||||
val id: Int by call.parameters
|
||||
|
||||
announcementService.delete(id)
|
||||
|
||||
call.respond(HttpStatusCode.OK)
|
||||
}
|
||||
|
||||
route("archive") {
|
||||
installAnnouncementArchiveRouteDocumentation()
|
||||
|
||||
post {
|
||||
val id: Int by call.parameters
|
||||
val archivedAt = call.receiveNullable<APIAnnouncementArchivedAt>()?.archivedAt
|
||||
|
||||
announcementService.archive(id, archivedAt)
|
||||
}
|
||||
}
|
||||
|
||||
route("tags") {
|
||||
installAnnouncementsTagsRouteDocumentation()
|
||||
route("unarchive") {
|
||||
installAnnouncementUnarchiveRouteDocumentation()
|
||||
|
||||
get {
|
||||
call.respond(announcementService.tags())
|
||||
post {
|
||||
val id: Int by call.parameters
|
||||
|
||||
announcementService.unarchive(id)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private val authHeaderParameter = Parameter(
|
||||
name = "Authorization",
|
||||
`in` = Parameter.Location.header,
|
||||
schema = TypeDefinition.STRING,
|
||||
required = true,
|
||||
examples = mapOf("Bearer authentication" to Parameter.Example("Bearer abc123")),
|
||||
)
|
||||
|
||||
private fun Route.installAnnouncementsRouteDocumentation() = installNotarizedRoute {
|
||||
private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get a page of announcements")
|
||||
summary("Get announcements")
|
||||
parameters(
|
||||
Parameter(
|
||||
name = "cursor",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.INT,
|
||||
description = "The offset of the announcements. Default is Int.MAX_VALUE (Newest first)",
|
||||
required = false,
|
||||
),
|
||||
Parameter(
|
||||
name = "count",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.INT,
|
||||
description = "The count of the announcements. Default is 16",
|
||||
required = false,
|
||||
),
|
||||
Parameter(
|
||||
name = "tag",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The tags to filter the announcements by. Default is all tags",
|
||||
required = false,
|
||||
),
|
||||
)
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The announcements")
|
||||
responseType<Set<ApiResponseAnnouncement>>()
|
||||
}
|
||||
}
|
||||
|
||||
post = PostInfo.builder {
|
||||
description("Create a new announcement")
|
||||
summary("Create announcement")
|
||||
parameters(authHeaderParameter)
|
||||
request {
|
||||
requestType<ApiAnnouncement>()
|
||||
requestType<APIAnnouncement>()
|
||||
description("The new announcement")
|
||||
}
|
||||
response {
|
||||
description("The announcement is created")
|
||||
description("When the announcement was created")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<Unit>()
|
||||
}
|
||||
canRespondUnauthorized()
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementsLatestRouteDocumentation() = installNotarizedRoute {
|
||||
private fun Route.installLatestAnnouncementRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the latest announcement")
|
||||
summary("Get latest announcement")
|
||||
parameters(
|
||||
Parameter(
|
||||
name = "tag",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The tags to filter the latest announcements by",
|
||||
required = false,
|
||||
),
|
||||
)
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The latest announcement")
|
||||
responseType<ApiResponseAnnouncement>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The latest announcements")
|
||||
responseType<Set<ApiResponseAnnouncement>>()
|
||||
responseType<APIResponseAnnouncement>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.NotFound)
|
||||
@ -213,32 +176,17 @@ private fun Route.installAnnouncementsLatestRouteDocumentation() = installNotari
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementsLatestIdRouteDocumentation() = installNotarizedRoute {
|
||||
private fun Route.installLatestAnnouncementIdRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the ID of the latest announcement")
|
||||
summary("Get ID of latest announcement")
|
||||
parameters(
|
||||
Parameter(
|
||||
name = "tag",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The tags to filter the latest announcements by",
|
||||
required = false,
|
||||
),
|
||||
)
|
||||
description("Get the id of the latest announcement")
|
||||
summary("Get id of latest announcement")
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The ID of the latest announcement")
|
||||
responseType<ApiResponseAnnouncementId>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The IDs of the latest announcements")
|
||||
responseType<Set<ApiResponseAnnouncement>>()
|
||||
description("The id of the latest announcement")
|
||||
responseType<APIResponseAnnouncementId>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.NotFound)
|
||||
@ -248,7 +196,32 @@ private fun Route.installAnnouncementsLatestIdRouteDocumentation() = installNota
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementsIdRouteDocumentation() = installNotarizedRoute {
|
||||
private fun Route.installChannelAnnouncementsRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
Parameter(
|
||||
name = "channel",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The channel to get the announcements from",
|
||||
required = true,
|
||||
),
|
||||
)
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the announcements from a channel")
|
||||
summary("Get announcements from channel")
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The announcements in the channel")
|
||||
responseType<Set<APIResponseAnnouncement>>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
@ -256,65 +229,162 @@ private fun Route.installAnnouncementsIdRouteDocumentation() = installNotarizedR
|
||||
name = "id",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.INT,
|
||||
description = "The ID of the announcement to update",
|
||||
description = "The id of the announcement to archive",
|
||||
required = true,
|
||||
),
|
||||
authHeaderParameter,
|
||||
Parameter(
|
||||
name = "archivedAt",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The date and time the announcement to be archived",
|
||||
required = false,
|
||||
),
|
||||
)
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get an announcement")
|
||||
summary("Get announcement")
|
||||
post = PostInfo.builder {
|
||||
description("Archive an announcement")
|
||||
summary("Archive announcement")
|
||||
response {
|
||||
description("The announcement")
|
||||
description("When the announcement was archived")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiResponseAnnouncement>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.NotFound)
|
||||
description("The announcement does not exist")
|
||||
responseType<Unit>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementUnarchiveRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
Parameter(
|
||||
name = "id",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.INT,
|
||||
description = "The id of the announcement to unarchive",
|
||||
required = true,
|
||||
),
|
||||
)
|
||||
|
||||
post = PostInfo.builder {
|
||||
description("Unarchive an announcement")
|
||||
summary("Unarchive announcement")
|
||||
response {
|
||||
description("When announcement was unarchived")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<Unit>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
Parameter(
|
||||
name = "id",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.INT,
|
||||
description = "The id of the announcement to update",
|
||||
required = true,
|
||||
),
|
||||
)
|
||||
|
||||
patch = PatchInfo.builder {
|
||||
description("Update an announcement")
|
||||
summary("Update announcement")
|
||||
request {
|
||||
requestType<ApiAnnouncement>()
|
||||
requestType<APIAnnouncement>()
|
||||
description("The new announcement")
|
||||
}
|
||||
response {
|
||||
description("The announcement is updated")
|
||||
description("When announcement was updated")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<Unit>()
|
||||
}
|
||||
canRespondUnauthorized()
|
||||
}
|
||||
|
||||
delete = DeleteInfo.builder {
|
||||
description("Delete an announcement")
|
||||
summary("Delete announcement")
|
||||
response {
|
||||
description("The announcement is deleted")
|
||||
description("When the announcement was deleted")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<Unit>()
|
||||
}
|
||||
canRespondUnauthorized()
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installAnnouncementsTagsRouteDocumentation() = installNotarizedRoute {
|
||||
private fun Route.installAnnouncementsRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get all announcement tags")
|
||||
summary("Get announcement tags")
|
||||
description("Get the announcements")
|
||||
summary("Get announcements")
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The announcement tags")
|
||||
responseType<Set<String>>()
|
||||
description("The announcements")
|
||||
responseType<Set<APIResponseAnnouncement>>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installLatestChannelAnnouncementRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
Parameter(
|
||||
name = "channel",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The channel to get the latest announcement from",
|
||||
required = true,
|
||||
),
|
||||
)
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the latest announcement from a channel")
|
||||
summary("Get latest channel announcement")
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The latest announcement in the channel")
|
||||
responseType<APIResponseAnnouncement>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.NotFound)
|
||||
description("The channel does not exist")
|
||||
responseType<Unit>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun Route.installLatestChannelAnnouncementIdRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Announcements")
|
||||
|
||||
parameters = listOf(
|
||||
Parameter(
|
||||
name = "channel",
|
||||
`in` = Parameter.Location.path,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "The channel to get the latest announcement id from",
|
||||
required = true,
|
||||
),
|
||||
)
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the id of the latest announcement from a channel")
|
||||
summary("Get id of latest announcement from channel")
|
||||
response {
|
||||
responseCode(HttpStatusCode.OK)
|
||||
mediaTypes("application/json")
|
||||
description("The id of the latest announcement from the channel")
|
||||
responseType<APIResponseAnnouncementId>()
|
||||
}
|
||||
canRespond {
|
||||
responseCode(HttpStatusCode.NotFound)
|
||||
description("The channel does not exist")
|
||||
responseType<Unit>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -4,13 +4,14 @@ import app.revanced.api.configuration.*
|
||||
import app.revanced.api.configuration.installCache
|
||||
import app.revanced.api.configuration.installNoCache
|
||||
import app.revanced.api.configuration.installNotarizedRoute
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import app.revanced.api.configuration.respondOrNotFound
|
||||
import app.revanced.api.configuration.schema.APIAbout
|
||||
import app.revanced.api.configuration.schema.APIContributable
|
||||
import app.revanced.api.configuration.schema.APIMember
|
||||
import app.revanced.api.configuration.schema.APIRateLimit
|
||||
import app.revanced.api.configuration.services.ApiService
|
||||
import app.revanced.api.configuration.services.AuthenticationService
|
||||
import app.revanced.api.configuration.services.AuthService
|
||||
import io.bkbn.kompendium.core.metadata.*
|
||||
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
||||
import io.bkbn.kompendium.oas.payload.Parameter
|
||||
import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.auth.*
|
||||
@ -22,7 +23,7 @@ import org.koin.ktor.ext.get as koinGet
|
||||
|
||||
internal fun Route.apiRoute() {
|
||||
val apiService = koinGet<ApiService>()
|
||||
val authenticationService = koinGet<AuthenticationService>()
|
||||
val authService = koinGet<AuthService>()
|
||||
|
||||
rateLimit(RateLimitName("strong")) {
|
||||
authenticate("auth-digest") {
|
||||
@ -30,7 +31,7 @@ internal fun Route.apiRoute() {
|
||||
installTokenRouteDocumentation()
|
||||
|
||||
get {
|
||||
call.respond(authenticationService.newToken())
|
||||
call.respond(authService.newToken())
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -114,7 +115,7 @@ private fun Route.installRateLimitRouteDocumentation() = installNotarizedRoute {
|
||||
description("The rate limit of the backend")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiRateLimit>()
|
||||
responseType<APIRateLimit>()
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -143,7 +144,7 @@ private fun Route.installTeamRouteDocumentation() = installNotarizedRoute {
|
||||
description("The list of team members")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<Set<ApiMember>>()
|
||||
responseType<Set<APIMember>>()
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -164,38 +165,16 @@ private fun Route.installContributorsRouteDocumentation() = installNotarizedRout
|
||||
}
|
||||
|
||||
private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
|
||||
val configuration = koinGet<ConfigurationRepository>()
|
||||
|
||||
tags = setOf("API")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get a new authorization token")
|
||||
summary("Get authorization token")
|
||||
parameters(
|
||||
Parameter(
|
||||
name = "Authorization",
|
||||
`in` = Parameter.Location.header,
|
||||
schema = TypeDefinition.STRING,
|
||||
required = true,
|
||||
examples = mapOf(
|
||||
"Digest access authentication" to Parameter.Example(
|
||||
value = "Digest " +
|
||||
"username=\"ReVanced\", " +
|
||||
"realm=\"ReVanced\", " +
|
||||
"nonce=\"abc123\", " +
|
||||
"uri=\"/${configuration.apiVersion}/token\", " +
|
||||
"algorithm=SHA-256, " +
|
||||
"response=\"yxz456\"",
|
||||
),
|
||||
), // Provide an example for the header
|
||||
),
|
||||
)
|
||||
response {
|
||||
description("The authorization token")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiToken>()
|
||||
}
|
||||
canRespondUnauthorized()
|
||||
responseType<String>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,12 +1,11 @@
|
||||
package app.revanced.api.configuration.routes
|
||||
|
||||
import app.revanced.api.configuration.ApiRelease
|
||||
import app.revanced.api.configuration.ApiReleaseVersion
|
||||
import app.revanced.api.configuration.installNotarizedRoute
|
||||
import app.revanced.api.configuration.schema.APIManagerAsset
|
||||
import app.revanced.api.configuration.schema.APIRelease
|
||||
import app.revanced.api.configuration.schema.APIReleaseVersion
|
||||
import app.revanced.api.configuration.services.ManagerService
|
||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
||||
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
||||
import io.bkbn.kompendium.oas.payload.Parameter
|
||||
import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.plugins.ratelimit.*
|
||||
@ -21,43 +20,30 @@ internal fun Route.managerRoute() = route("manager") {
|
||||
|
||||
rateLimit(RateLimitName("weak")) {
|
||||
get {
|
||||
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||
|
||||
call.respond(managerService.latestRelease(prerelease))
|
||||
call.respond(managerService.latestRelease())
|
||||
}
|
||||
|
||||
route("version") {
|
||||
installManagerVersionRouteDocumentation()
|
||||
|
||||
get {
|
||||
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||
|
||||
call.respond(managerService.latestVersion(prerelease))
|
||||
call.respond(managerService.latestVersion())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private val prereleaseParameter = Parameter(
|
||||
name = "prerelease",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "Whether to get the current manager prerelease",
|
||||
required = false,
|
||||
)
|
||||
|
||||
private fun Route.installManagerRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Manager")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the current manager release")
|
||||
summary("Get current manager release")
|
||||
parameters(prereleaseParameter)
|
||||
response {
|
||||
description("The latest manager release")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiRelease>()
|
||||
responseType<APIRelease<APIManagerAsset>>()
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -68,12 +54,11 @@ private fun Route.installManagerVersionRouteDocumentation() = installNotarizedRo
|
||||
get = GetInfo.builder {
|
||||
description("Get the current manager release version")
|
||||
summary("Get current manager release version")
|
||||
parameters(prereleaseParameter)
|
||||
response {
|
||||
description("The current manager release version")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiReleaseVersion>()
|
||||
responseType<APIReleaseVersion>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,19 @@
|
||||
package app.revanced.api.configuration.routes
|
||||
|
||||
import app.revanced.api.configuration.services.OldApiService
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.plugins.ratelimit.*
|
||||
import io.ktor.server.routing.*
|
||||
import org.koin.ktor.ext.get
|
||||
|
||||
internal fun Route.oldApiRoute() {
|
||||
val oldApiService = get<OldApiService>()
|
||||
|
||||
rateLimit(RateLimitName("weak")) {
|
||||
route(Regex("/(v2|tools|contributors).*")) {
|
||||
handle {
|
||||
oldApiService.proxy(call)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,14 +1,13 @@
|
||||
package app.revanced.api.configuration.routes
|
||||
|
||||
import app.revanced.api.configuration.ApiAssetPublicKey
|
||||
import app.revanced.api.configuration.ApiRelease
|
||||
import app.revanced.api.configuration.ApiReleaseVersion
|
||||
import app.revanced.api.configuration.installCache
|
||||
import app.revanced.api.configuration.installNotarizedRoute
|
||||
import app.revanced.api.configuration.schema.APIAssetPublicKeys
|
||||
import app.revanced.api.configuration.schema.APIPatchesAsset
|
||||
import app.revanced.api.configuration.schema.APIRelease
|
||||
import app.revanced.api.configuration.schema.APIReleaseVersion
|
||||
import app.revanced.api.configuration.services.PatchesService
|
||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
||||
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
||||
import io.bkbn.kompendium.oas.payload.Parameter
|
||||
import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.plugins.ratelimit.*
|
||||
@ -24,18 +23,14 @@ internal fun Route.patchesRoute() = route("patches") {
|
||||
|
||||
rateLimit(RateLimitName("weak")) {
|
||||
get {
|
||||
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||
|
||||
call.respond(patchesService.latestRelease(prerelease))
|
||||
call.respond(patchesService.latestRelease())
|
||||
}
|
||||
|
||||
route("version") {
|
||||
installPatchesVersionRouteDocumentation()
|
||||
|
||||
get {
|
||||
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||
|
||||
call.respond(patchesService.latestVersion(prerelease))
|
||||
call.respond(patchesService.latestVersion())
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -45,9 +40,7 @@ internal fun Route.patchesRoute() = route("patches") {
|
||||
installPatchesListRouteDocumentation()
|
||||
|
||||
get {
|
||||
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||
|
||||
call.respondBytes(ContentType.Application.Json) { patchesService.list(prerelease) }
|
||||
call.respondBytes(ContentType.Application.Json) { patchesService.list() }
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -59,32 +52,23 @@ internal fun Route.patchesRoute() = route("patches") {
|
||||
installPatchesPublicKeyRouteDocumentation()
|
||||
|
||||
get {
|
||||
call.respond(patchesService.publicKey())
|
||||
call.respond(patchesService.publicKeys())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private val prereleaseParameter = Parameter(
|
||||
name = "prerelease",
|
||||
`in` = Parameter.Location.query,
|
||||
schema = TypeDefinition.STRING,
|
||||
description = "Whether to get the current patches prerelease",
|
||||
required = false,
|
||||
)
|
||||
|
||||
private fun Route.installPatchesRouteDocumentation() = installNotarizedRoute {
|
||||
tags = setOf("Patches")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the current patches release")
|
||||
summary("Get current patches release")
|
||||
parameters(prereleaseParameter)
|
||||
response {
|
||||
description("The current patches release")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiRelease>()
|
||||
responseType<APIRelease<APIPatchesAsset>>()
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -95,12 +79,11 @@ private fun Route.installPatchesVersionRouteDocumentation() = installNotarizedRo
|
||||
get = GetInfo.builder {
|
||||
description("Get the current patches release version")
|
||||
summary("Get current patches release version")
|
||||
parameters(prereleaseParameter)
|
||||
response {
|
||||
description("The current patches release version")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiReleaseVersion>()
|
||||
responseType<APIReleaseVersion>()
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -111,7 +94,6 @@ private fun Route.installPatchesListRouteDocumentation() = installNotarizedRoute
|
||||
get = GetInfo.builder {
|
||||
description("Get the list of patches from the current patches release")
|
||||
summary("Get list of patches from current patches release")
|
||||
parameters(prereleaseParameter)
|
||||
response {
|
||||
description("The list of patches")
|
||||
mediaTypes("application/json")
|
||||
@ -125,13 +107,13 @@ private fun Route.installPatchesPublicKeyRouteDocumentation() = installNotarized
|
||||
tags = setOf("Patches")
|
||||
|
||||
get = GetInfo.builder {
|
||||
description("Get the public keys for verifying patches assets")
|
||||
summary("Get patches public keys")
|
||||
description("Get the public keys for verifying patches and integrations assets")
|
||||
summary("Get patches and integrations public keys")
|
||||
response {
|
||||
description("The public keys")
|
||||
mediaTypes("application/json")
|
||||
responseCode(HttpStatusCode.OK)
|
||||
responseType<ApiAssetPublicKey>()
|
||||
responseType<APIAssetPublicKeys>()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,116 +1,124 @@
|
||||
package app.revanced.api.configuration
|
||||
package app.revanced.api.configuration.schema
|
||||
|
||||
import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.LocalDateTime
|
||||
import kotlinx.datetime.TimeZone
|
||||
import kotlinx.datetime.toLocalDateTime
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
interface ApiUser {
|
||||
interface APIUser {
|
||||
val name: String
|
||||
val avatarUrl: String
|
||||
val url: String
|
||||
}
|
||||
|
||||
@Serializable
|
||||
class ApiMember(
|
||||
class APIMember(
|
||||
override val name: String,
|
||||
override val avatarUrl: String,
|
||||
override val url: String,
|
||||
val bio: String?,
|
||||
val gpgKey: ApiGpgKey?,
|
||||
) : ApiUser
|
||||
val gpgKey: APIGpgKey?,
|
||||
) : APIUser
|
||||
|
||||
@Serializable
|
||||
class ApiGpgKey(
|
||||
class APIGpgKey(
|
||||
val id: String,
|
||||
val url: String,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiContributor(
|
||||
class APIContributor(
|
||||
override val name: String,
|
||||
override val avatarUrl: String,
|
||||
override val url: String,
|
||||
val contributions: Int,
|
||||
) : ApiUser
|
||||
) : APIUser
|
||||
|
||||
@Serializable
|
||||
class APIContributable(
|
||||
val name: String,
|
||||
val url: String,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val contributors: List<ApiContributor>,
|
||||
val contributors: List<APIContributor>,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiRelease(
|
||||
class APIRelease<T>(
|
||||
val version: String,
|
||||
val createdAt: LocalDateTime,
|
||||
val description: String,
|
||||
val downloadUrl: String,
|
||||
val signatureDownloadUrl: String? = null,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val assets: List<T>,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiReleaseVersion(
|
||||
class APIManagerAsset(
|
||||
val downloadUrl: String,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class APIPatchesAsset(
|
||||
val downloadUrl: String,
|
||||
val signatureDownloadUrl: String,
|
||||
// TODO: Remove this eventually when integrations are merged into patches.
|
||||
val name: APIAssetName,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
enum class APIAssetName {
|
||||
PATCHES,
|
||||
INTEGRATION,
|
||||
}
|
||||
|
||||
@Serializable
|
||||
class APIReleaseVersion(
|
||||
val version: String,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiAnnouncement(
|
||||
class APIAnnouncement(
|
||||
val author: String? = null,
|
||||
val title: String,
|
||||
val content: String? = null,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val attachments: List<String>? = null,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val tags: List<String>? = null,
|
||||
val createdAt: LocalDateTime = Clock.System.now().toLocalDateTime(TimeZone.currentSystemDefault()),
|
||||
val attachmentUrls: List<String> = emptyList(),
|
||||
val channel: String? = null,
|
||||
val archivedAt: LocalDateTime? = null,
|
||||
val level: Int = 0,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiResponseAnnouncement(
|
||||
class APIResponseAnnouncement(
|
||||
val id: Int,
|
||||
val author: String? = null,
|
||||
val title: String,
|
||||
val content: String? = null,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val attachments: List<String>? = null,
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val tags: List<String>? = null,
|
||||
val attachmentUrls: List<String> = emptyList(),
|
||||
val channel: String? = null,
|
||||
val createdAt: LocalDateTime,
|
||||
val archivedAt: LocalDateTime? = null,
|
||||
val level: Int = 0,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiResponseAnnouncementId(
|
||||
class APIResponseAnnouncementId(
|
||||
val id: Int,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiAnnouncementArchivedAt(
|
||||
class APIAnnouncementArchivedAt(
|
||||
val archivedAt: LocalDateTime,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiAnnouncementTag(
|
||||
val name: String,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiRateLimit(
|
||||
class APIRateLimit(
|
||||
val limit: Int,
|
||||
val remaining: Int,
|
||||
val reset: LocalDateTime,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
class ApiAssetPublicKey(
|
||||
class APIAssetPublicKeys(
|
||||
val patchesPublicKey: String,
|
||||
val integrationsPublicKey: String,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
@ -123,7 +131,6 @@ class APIAbout(
|
||||
// Using a list instead of a set because set semantics are unnecessary here.
|
||||
val socials: List<Social>?,
|
||||
val donations: Donations?,
|
||||
val status: String,
|
||||
) {
|
||||
@Serializable
|
||||
class Branding(
|
||||
@ -165,6 +172,3 @@ class APIAbout(
|
||||
val links: List<Link>?,
|
||||
)
|
||||
}
|
||||
|
||||
@Serializable
|
||||
class ApiToken(val token: String)
|
||||
@ -1,29 +1,35 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.ApiAnnouncement
|
||||
import app.revanced.api.configuration.repository.AnnouncementRepository
|
||||
import app.revanced.api.configuration.schema.APIAnnouncement
|
||||
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
||||
import kotlinx.datetime.LocalDateTime
|
||||
|
||||
internal class AnnouncementService(
|
||||
private val announcementRepository: AnnouncementRepository,
|
||||
) {
|
||||
suspend fun latest(tags: Set<String>) = announcementRepository.latest(tags)
|
||||
fun latestId(channel: String): APIResponseAnnouncementId? = announcementRepository.latestId(channel)
|
||||
fun latestId(): APIResponseAnnouncementId? = announcementRepository.latestId()
|
||||
|
||||
suspend fun latest() = announcementRepository.latest()
|
||||
fun latest(channel: String) = announcementRepository.latest(channel)
|
||||
fun latest() = announcementRepository.latest()
|
||||
|
||||
fun latestId(tags: Set<String>) = announcementRepository.latestId(tags)
|
||||
suspend fun all(channel: String) = announcementRepository.all(channel)
|
||||
suspend fun all() = announcementRepository.all()
|
||||
|
||||
fun latestId() = announcementRepository.latestId()
|
||||
|
||||
suspend fun paged(cursor: Int, limit: Int, tags: Set<String>?) =
|
||||
announcementRepository.paged(cursor, limit, tags)
|
||||
|
||||
suspend fun get(id: Int) = announcementRepository.get(id)
|
||||
|
||||
suspend fun update(id: Int, new: ApiAnnouncement) = announcementRepository.update(id, new)
|
||||
|
||||
suspend fun delete(id: Int) = announcementRepository.delete(id)
|
||||
|
||||
suspend fun new(new: ApiAnnouncement) = announcementRepository.new(new)
|
||||
|
||||
suspend fun tags() = announcementRepository.tags()
|
||||
suspend fun new(new: APIAnnouncement) {
|
||||
announcementRepository.new(new)
|
||||
}
|
||||
suspend fun archive(id: Int, archivedAt: LocalDateTime?) {
|
||||
announcementRepository.archive(id, archivedAt)
|
||||
}
|
||||
suspend fun unarchive(id: Int) {
|
||||
announcementRepository.unarchive(id)
|
||||
}
|
||||
suspend fun update(id: Int, new: APIAnnouncement) {
|
||||
announcementRepository.update(id, new)
|
||||
}
|
||||
suspend fun delete(id: Int) {
|
||||
announcementRepository.delete(id)
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,9 +1,8 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.*
|
||||
import app.revanced.api.configuration.repository.BackendRepository
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import io.ktor.http.*
|
||||
import app.revanced.api.configuration.schema.*
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.async
|
||||
import kotlinx.coroutines.awaitAll
|
||||
@ -17,16 +16,12 @@ internal class ApiService(
|
||||
val about = configurationRepository.about
|
||||
|
||||
suspend fun contributors() = withContext(Dispatchers.IO) {
|
||||
configurationRepository.contributorsRepositoryNames.map { (repository, name) ->
|
||||
configurationRepository.contributorsRepositoryNames.map {
|
||||
async {
|
||||
APIContributable(
|
||||
name,
|
||||
URLBuilder().apply {
|
||||
takeFrom(backendRepository.website)
|
||||
path(configurationRepository.organization, repository)
|
||||
}.buildString(),
|
||||
backendRepository.contributors(configurationRepository.organization, repository).map {
|
||||
ApiContributor(it.name, it.avatarUrl, it.url, it.contributions)
|
||||
it,
|
||||
backendRepository.contributors(configurationRepository.organization, it).map {
|
||||
APIContributor(it.name, it.avatarUrl, it.url, it.contributions)
|
||||
},
|
||||
)
|
||||
}
|
||||
@ -34,13 +29,13 @@ internal class ApiService(
|
||||
}.awaitAll()
|
||||
|
||||
suspend fun team() = backendRepository.members(configurationRepository.organization).map { member ->
|
||||
ApiMember(
|
||||
APIMember(
|
||||
member.name,
|
||||
member.avatarUrl,
|
||||
member.url,
|
||||
member.bio,
|
||||
if (member.gpgKeys.ids.isNotEmpty()) {
|
||||
ApiGpgKey(
|
||||
APIGpgKey(
|
||||
// Must choose one of the GPG keys, because it does not make sense to have multiple GPG keys for the API.
|
||||
member.gpgKeys.ids.first(),
|
||||
member.gpgKeys.url,
|
||||
@ -52,6 +47,6 @@ internal class ApiService(
|
||||
}
|
||||
|
||||
suspend fun rateLimit() = backendRepository.rateLimit()?.let {
|
||||
ApiRateLimit(it.limit, it.remaining, it.reset)
|
||||
APIRateLimit(it.limit, it.remaining, it.reset)
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,49 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import com.auth0.jwt.JWT
|
||||
import com.auth0.jwt.algorithms.Algorithm
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.auth.*
|
||||
import io.ktor.server.auth.jwt.*
|
||||
import java.util.*
|
||||
import kotlin.text.HexFormat
|
||||
import kotlin.time.Duration.Companion.minutes
|
||||
|
||||
internal class AuthService private constructor(
|
||||
private val issuer: String,
|
||||
private val validityInMin: Int,
|
||||
private val jwtSecret: String,
|
||||
private val authSHA256Digest: ByteArray,
|
||||
) {
|
||||
@OptIn(ExperimentalStdlibApi::class)
|
||||
constructor(issuer: String, validityInMin: Int, jwtSecret: String, authSHA256DigestString: String) : this(
|
||||
issuer,
|
||||
validityInMin,
|
||||
jwtSecret,
|
||||
authSHA256DigestString.hexToByteArray(HexFormat.Default),
|
||||
)
|
||||
|
||||
val configureSecurity: Application.() -> Unit = {
|
||||
install(Authentication) {
|
||||
jwt("jwt") {
|
||||
realm = "ReVanced"
|
||||
|
||||
verifier(JWT.require(Algorithm.HMAC256(jwtSecret)).withIssuer(issuer).build())
|
||||
}
|
||||
|
||||
digest("auth-digest") {
|
||||
realm = "ReVanced"
|
||||
algorithmName = "SHA-256"
|
||||
|
||||
digestProvider { _, _ ->
|
||||
authSHA256Digest
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun newToken(): String = JWT.create()
|
||||
.withIssuer(issuer)
|
||||
.withExpiresAt(Date(System.currentTimeMillis() + validityInMin.minutes.inWholeMilliseconds))
|
||||
.sign(Algorithm.HMAC256(jwtSecret))
|
||||
}
|
||||
@ -1,52 +0,0 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.ApiToken
|
||||
import com.auth0.jwt.JWT
|
||||
import com.auth0.jwt.algorithms.Algorithm
|
||||
import io.ktor.server.auth.*
|
||||
import io.ktor.server.auth.jwt.*
|
||||
import java.time.Instant
|
||||
import java.time.temporal.ChronoUnit
|
||||
import kotlin.text.HexFormat
|
||||
|
||||
internal class AuthenticationService private constructor(
|
||||
private val issuer: String,
|
||||
private val validityInMin: Long,
|
||||
private val jwtSecret: String,
|
||||
private val authSHA256Digest: ByteArray,
|
||||
) {
|
||||
@OptIn(ExperimentalStdlibApi::class)
|
||||
constructor(issuer: String, validityInMin: Long, jwtSecret: String, authSHA256DigestString: String) : this(
|
||||
issuer,
|
||||
validityInMin,
|
||||
jwtSecret,
|
||||
authSHA256DigestString.hexToByteArray(HexFormat.Default),
|
||||
)
|
||||
|
||||
fun AuthenticationConfig.jwt() {
|
||||
jwt("jwt") {
|
||||
realm = "ReVanced"
|
||||
verifier(JWT.require(Algorithm.HMAC256(jwtSecret)).withIssuer(issuer).build())
|
||||
// This is required and not optional. Authentication will fail if this is not present.
|
||||
validate { JWTPrincipal(it.payload) }
|
||||
}
|
||||
}
|
||||
|
||||
fun AuthenticationConfig.digest() {
|
||||
digest("auth-digest") {
|
||||
realm = "ReVanced"
|
||||
algorithmName = "SHA-256"
|
||||
|
||||
digestProvider { _, _ ->
|
||||
authSHA256Digest
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun newToken() = ApiToken(
|
||||
JWT.create()
|
||||
.withIssuer(issuer)
|
||||
.withExpiresAt(Instant.now().plus(validityInMin, ChronoUnit.MINUTES))
|
||||
.sign(Algorithm.HMAC256(jwtSecret)),
|
||||
)
|
||||
}
|
||||
@ -1,37 +1,38 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.ApiRelease
|
||||
import app.revanced.api.configuration.ApiReleaseVersion
|
||||
import app.revanced.api.configuration.repository.BackendRepository
|
||||
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import app.revanced.api.configuration.schema.*
|
||||
|
||||
internal class ManagerService(
|
||||
private val backendRepository: BackendRepository,
|
||||
private val configurationRepository: ConfigurationRepository,
|
||||
) {
|
||||
suspend fun latestRelease(prerelease: Boolean): ApiRelease {
|
||||
suspend fun latestRelease(): APIRelease<APIManagerAsset> {
|
||||
val managerRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.manager.repository,
|
||||
prerelease,
|
||||
)
|
||||
|
||||
return ApiRelease(
|
||||
val managerAsset = APIManagerAsset(
|
||||
managerRelease.assets.first(configurationRepository.manager.assetRegex).downloadUrl,
|
||||
)
|
||||
|
||||
return APIRelease(
|
||||
managerRelease.tag,
|
||||
managerRelease.createdAt,
|
||||
managerRelease.releaseNote,
|
||||
managerRelease.assets.first(configurationRepository.manager.assetRegex).downloadUrl,
|
||||
listOf(managerAsset),
|
||||
)
|
||||
}
|
||||
|
||||
suspend fun latestVersion(prerelease: Boolean): ApiReleaseVersion {
|
||||
suspend fun latestVersion(): APIReleaseVersion {
|
||||
val managerRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.manager.repository,
|
||||
prerelease,
|
||||
)
|
||||
|
||||
return ApiReleaseVersion(managerRelease.tag)
|
||||
return APIReleaseVersion(managerRelease.tag)
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,69 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import io.ktor.client.*
|
||||
import io.ktor.client.request.*
|
||||
import io.ktor.client.statement.*
|
||||
import io.ktor.http.*
|
||||
import io.ktor.http.content.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.request.*
|
||||
import io.ktor.server.response.*
|
||||
import io.ktor.util.*
|
||||
import io.ktor.utils.io.*
|
||||
|
||||
internal class OldApiService(private val client: HttpClient) {
|
||||
@OptIn(InternalAPI::class)
|
||||
suspend fun proxy(call: ApplicationCall) {
|
||||
val channel = call.request.receiveChannel()
|
||||
val size = channel.availableForRead
|
||||
val byteArray = ByteArray(size)
|
||||
channel.readFully(byteArray)
|
||||
|
||||
val response: HttpResponse = client.request(call.request.uri) {
|
||||
method = call.request.httpMethod
|
||||
|
||||
headers {
|
||||
appendAll(
|
||||
call.request.headers.filter { key, _ ->
|
||||
!(
|
||||
key.equals(HttpHeaders.ContentType, ignoreCase = true) ||
|
||||
key.equals(HttpHeaders.ContentLength, ignoreCase = true) ||
|
||||
key.equals(HttpHeaders.Host, ignoreCase = true)
|
||||
)
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
when (call.request.httpMethod) {
|
||||
HttpMethod.Post,
|
||||
HttpMethod.Put,
|
||||
HttpMethod.Patch,
|
||||
HttpMethod.Delete,
|
||||
-> body = ByteArrayContent(byteArray, call.request.contentType())
|
||||
}
|
||||
}
|
||||
|
||||
val headers = response.headers
|
||||
|
||||
call.respond(object : OutgoingContent.WriteChannelContent() {
|
||||
override val contentLength: Long? = headers[HttpHeaders.ContentLength]?.toLong()
|
||||
override val contentType = headers[HttpHeaders.ContentType]?.let { ContentType.parse(it) }
|
||||
override val headers: Headers = Headers.build {
|
||||
appendAll(
|
||||
headers.filter { key, _ ->
|
||||
!key.equals(
|
||||
HttpHeaders.ContentType,
|
||||
ignoreCase = true,
|
||||
) &&
|
||||
!key.equals(HttpHeaders.ContentLength, ignoreCase = true)
|
||||
},
|
||||
)
|
||||
}
|
||||
override val status = response.status
|
||||
|
||||
override suspend fun writeTo(channel: ByteWriteChannel) {
|
||||
response.content.copyAndClose(channel)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@ -1,11 +1,9 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.ApiAssetPublicKey
|
||||
import app.revanced.api.configuration.ApiRelease
|
||||
import app.revanced.api.configuration.ApiReleaseVersion
|
||||
import app.revanced.api.configuration.repository.BackendRepository
|
||||
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||
import app.revanced.api.configuration.schema.*
|
||||
import app.revanced.library.serializeTo
|
||||
import app.revanced.patcher.patch.loadPatchesFromJar
|
||||
import com.github.benmanes.caffeine.cache.Caffeine
|
||||
@ -19,30 +17,50 @@ internal class PatchesService(
|
||||
private val backendRepository: BackendRepository,
|
||||
private val configurationRepository: ConfigurationRepository,
|
||||
) {
|
||||
suspend fun latestRelease(prerelease: Boolean): ApiRelease {
|
||||
suspend fun latestRelease(): APIRelease<APIPatchesAsset> {
|
||||
val patchesRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.patches.repository,
|
||||
prerelease,
|
||||
)
|
||||
|
||||
return ApiRelease(
|
||||
val integrationsRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.integrations.repository,
|
||||
)
|
||||
|
||||
fun ConfigurationRepository.SignedAssetConfiguration.asset(
|
||||
release: BackendRepository.BackendOrganization.BackendRepository.BackendRelease,
|
||||
assetName: APIAssetName,
|
||||
) = APIPatchesAsset(
|
||||
release.assets.first(assetRegex).downloadUrl,
|
||||
release.assets.first(signatureAssetRegex).downloadUrl,
|
||||
assetName,
|
||||
)
|
||||
|
||||
val patchesAsset = configurationRepository.patches.asset(
|
||||
patchesRelease,
|
||||
APIAssetName.PATCHES,
|
||||
)
|
||||
val integrationsAsset = configurationRepository.integrations.asset(
|
||||
integrationsRelease,
|
||||
APIAssetName.INTEGRATION,
|
||||
)
|
||||
|
||||
return APIRelease(
|
||||
patchesRelease.tag,
|
||||
patchesRelease.createdAt,
|
||||
patchesRelease.releaseNote,
|
||||
patchesRelease.assets.first(configurationRepository.patches.assetRegex).downloadUrl,
|
||||
patchesRelease.assets.first(configurationRepository.patches.signatureAssetRegex).downloadUrl,
|
||||
listOf(patchesAsset, integrationsAsset),
|
||||
)
|
||||
}
|
||||
|
||||
suspend fun latestVersion(prerelease: Boolean): ApiReleaseVersion {
|
||||
suspend fun latestVersion(): APIReleaseVersion {
|
||||
val patchesRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.patches.repository,
|
||||
prerelease,
|
||||
)
|
||||
|
||||
return ApiReleaseVersion(patchesRelease.tag)
|
||||
return APIReleaseVersion(patchesRelease.tag)
|
||||
}
|
||||
|
||||
private val patchesListCache = Caffeine
|
||||
@ -50,11 +68,10 @@ internal class PatchesService(
|
||||
.maximumSize(1)
|
||||
.build<String, ByteArray>()
|
||||
|
||||
suspend fun list(prerelease: Boolean): ByteArray {
|
||||
suspend fun list(): ByteArray {
|
||||
val patchesRelease = backendRepository.release(
|
||||
configurationRepository.organization,
|
||||
configurationRepository.patches.repository,
|
||||
prerelease,
|
||||
)
|
||||
|
||||
return withContext(Dispatchers.IO) {
|
||||
@ -94,5 +111,14 @@ internal class PatchesService(
|
||||
}
|
||||
}
|
||||
|
||||
fun publicKey() = ApiAssetPublicKey(configurationRepository.patches.publicKeyFile.readText())
|
||||
fun publicKeys(): APIAssetPublicKeys {
|
||||
fun readPublicKey(
|
||||
getSignedAssetConfiguration: ConfigurationRepository.() -> ConfigurationRepository.SignedAssetConfiguration,
|
||||
) = configurationRepository.getSignedAssetConfiguration().publicKeyFile.readText()
|
||||
|
||||
return APIAssetPublicKeys(
|
||||
readPublicKey { patches },
|
||||
readPublicKey { integrations },
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -12,7 +12,7 @@ import java.security.MessageDigest
|
||||
internal class SignatureService {
|
||||
private val signatureCache = Caffeine
|
||||
.newBuilder()
|
||||
.maximumSize(2) // 2 because currently only the latest release and prerelease patches are needed.
|
||||
.maximumSize(2) // Assuming this is enough for patches and integrations.
|
||||
.build<ByteArray, Boolean>() // Hash -> Verified.
|
||||
|
||||
fun verify(
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
<configuration>
|
||||
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||||
<encoder>
|
||||
<pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} %-5level %msg%n</pattern>
|
||||
<pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
||||
</encoder>
|
||||
</appender>
|
||||
<root level="\${LOG_LEVEL:-INFO}">
|
||||
<root level="info">
|
||||
<appender-ref ref="STDOUT"/>
|
||||
</root>
|
||||
</configuration>
|
||||
|
||||
@ -1,186 +0,0 @@
|
||||
package app.revanced.api.configuration.services
|
||||
|
||||
import app.revanced.api.configuration.ApiAnnouncement
|
||||
import app.revanced.api.configuration.repository.AnnouncementRepository
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import kotlinx.datetime.toKotlinLocalDateTime
|
||||
import org.jetbrains.exposed.sql.Database
|
||||
import org.junit.jupiter.api.Assertions.assertNull
|
||||
import org.junit.jupiter.api.BeforeAll
|
||||
import org.junit.jupiter.api.BeforeEach
|
||||
import org.junit.jupiter.api.Test
|
||||
import java.time.LocalDateTime
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertNotNull
|
||||
|
||||
private object AnnouncementServiceTest {
|
||||
private lateinit var announcementService: AnnouncementService
|
||||
|
||||
@JvmStatic
|
||||
@BeforeAll
|
||||
fun setUp() {
|
||||
val database = Database.connect("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DATABASE_TO_UPPER=false")
|
||||
|
||||
announcementService = AnnouncementService(AnnouncementRepository(database))
|
||||
}
|
||||
|
||||
@BeforeEach
|
||||
fun clear() {
|
||||
runBlocking {
|
||||
while (true) {
|
||||
val latestId = announcementService.latestId() ?: break
|
||||
announcementService.delete(latestId.id)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `can do basic crud`(): Unit = runBlocking {
|
||||
announcementService.new(ApiAnnouncement(title = "title"))
|
||||
|
||||
val latestId = announcementService.latestId()!!.id
|
||||
|
||||
announcementService.update(latestId, ApiAnnouncement(title = "new title"))
|
||||
assert(announcementService.get(latestId)?.title == "new title")
|
||||
|
||||
announcementService.delete(latestId)
|
||||
assertNull(announcementService.get(latestId))
|
||||
assertNull(announcementService.latestId())
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `archiving works properly`() = runBlocking {
|
||||
announcementService.new(ApiAnnouncement(title = "title"))
|
||||
|
||||
val latest = announcementService.latest()!!
|
||||
assertNull(announcementService.get(latest.id)?.archivedAt)
|
||||
|
||||
val updated = ApiAnnouncement(
|
||||
title = latest.title,
|
||||
archivedAt = LocalDateTime.now().toKotlinLocalDateTime(),
|
||||
)
|
||||
|
||||
announcementService.update(latest.id, updated)
|
||||
assertNotNull(announcementService.get(latest.id)?.archivedAt)
|
||||
|
||||
return@runBlocking
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `latest works properly`() = runBlocking {
|
||||
announcementService.new(ApiAnnouncement(title = "title"))
|
||||
announcementService.new(ApiAnnouncement(title = "title2"))
|
||||
|
||||
var latest = announcementService.latest()
|
||||
assert(latest?.title == "title2")
|
||||
|
||||
announcementService.delete(latest!!.id)
|
||||
|
||||
latest = announcementService.latest()
|
||||
assert(latest?.title == "title")
|
||||
|
||||
announcementService.delete(latest!!.id)
|
||||
assertNull(announcementService.latest())
|
||||
|
||||
announcementService.new(ApiAnnouncement(title = "1", tags = listOf("tag1", "tag2")))
|
||||
announcementService.new(ApiAnnouncement(title = "2", tags = listOf("tag1", "tag3")))
|
||||
announcementService.new(ApiAnnouncement(title = "3", tags = listOf("tag1", "tag4")))
|
||||
|
||||
assert(announcementService.latest(setOf("tag2")).first().title == "1")
|
||||
assert(announcementService.latest(setOf("tag3")).last().title == "2")
|
||||
|
||||
val announcement2and3 = announcementService.latest(setOf("tag1", "tag3"))
|
||||
assert(announcement2and3.size == 2)
|
||||
assert(announcement2and3.any { it.title == "2" })
|
||||
assert(announcement2and3.any { it.title == "3" })
|
||||
|
||||
announcementService.delete(announcementService.latestId()!!.id)
|
||||
assert(announcementService.latest(setOf("tag1", "tag3")).first().title == "2")
|
||||
|
||||
announcementService.delete(announcementService.latestId()!!.id)
|
||||
assert(announcementService.latest(setOf("tag1", "tag3")).first().title == "1")
|
||||
|
||||
announcementService.delete(announcementService.latestId()!!.id)
|
||||
assert(announcementService.latest(setOf("tag1", "tag3")).isEmpty())
|
||||
assert(announcementService.tags().isEmpty())
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `tags work properly`() = runBlocking {
|
||||
announcementService.new(ApiAnnouncement(title = "title", tags = listOf("tag1", "tag2")))
|
||||
announcementService.new(ApiAnnouncement(title = "title2", tags = listOf("tag1", "tag3")))
|
||||
|
||||
val tags = announcementService.tags()
|
||||
assertEquals(3, tags.size)
|
||||
assert(tags.any { it.name == "tag1" })
|
||||
assert(tags.any { it.name == "tag2" })
|
||||
assert(tags.any { it.name == "tag3" })
|
||||
|
||||
announcementService.delete(announcementService.latestId()!!.id)
|
||||
assertEquals(2, announcementService.tags().size)
|
||||
|
||||
announcementService.update(
|
||||
announcementService.latestId()!!.id,
|
||||
ApiAnnouncement(title = "title", tags = listOf("tag1", "tag3")),
|
||||
)
|
||||
|
||||
assertEquals(2, announcementService.tags().size)
|
||||
assert(announcementService.tags().any { it.name == "tag3" })
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `attachments work properly`() = runBlocking {
|
||||
announcementService.new(ApiAnnouncement(title = "title", attachments = listOf("attachment1", "attachment2")))
|
||||
|
||||
val latestAnnouncement = announcementService.latest()!!
|
||||
val latestId = latestAnnouncement.id
|
||||
|
||||
val attachments = latestAnnouncement.attachments!!
|
||||
assertEquals(2, attachments.size)
|
||||
assert(attachments.any { it == "attachment1" })
|
||||
assert(attachments.any { it == "attachment2" })
|
||||
|
||||
announcementService.update(
|
||||
latestId,
|
||||
ApiAnnouncement(title = "title", attachments = listOf("attachment1", "attachment3")),
|
||||
)
|
||||
assert(announcementService.get(latestId)!!.attachments!!.any { it == "attachment3" })
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `paging works correctly`() = runBlocking {
|
||||
repeat(10) {
|
||||
announcementService.new(ApiAnnouncement(title = "title$it"))
|
||||
}
|
||||
|
||||
val announcements = announcementService.paged(Int.MAX_VALUE, 5, null)
|
||||
assertEquals(5, announcements.size, "Returns correct number of announcements")
|
||||
assertEquals("title9", announcements.first().title, "Starts from the latest announcement")
|
||||
|
||||
val announcements2 = announcementService.paged(5, 5, null)
|
||||
assertEquals(5, announcements2.size, "Returns correct number of announcements when starting from the cursor")
|
||||
assertEquals("title4", announcements2.first().title, "Starts from the cursor")
|
||||
|
||||
(0..4).forEach { id ->
|
||||
announcementService.update(
|
||||
id,
|
||||
ApiAnnouncement(
|
||||
title = "title$id",
|
||||
tags = (0..id).map { "tag$it" },
|
||||
archivedAt = if (id % 2 == 0) {
|
||||
// Only two announcements will be archived.
|
||||
LocalDateTime.now().plusDays(2).minusDays(id.toLong()).toKotlinLocalDateTime()
|
||||
} else {
|
||||
null
|
||||
},
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
val tags = announcementService.tags()
|
||||
assertEquals(5, tags.size, "Returns correct number of newly created tags")
|
||||
|
||||
val announcements3 = announcementService.paged(5, 5, setOf(tags[1].name))
|
||||
assertEquals(4, announcements3.size, "Filters announcements by tag")
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user