mirror of
https://github.com/revanced/revanced-api.git
synced 2025-04-30 06:34:36 +02:00
Compare commits
71 Commits
v1.2.0-dev
...
main
Author | SHA1 | Date | |
---|---|---|---|
![]() |
01d86ebba8 | ||
![]() |
989094309f | ||
![]() |
5b447aa62d | ||
![]() |
c25bc8b4ba | ||
![]() |
8a957cd797 | ||
![]() |
712ab3be8c | ||
![]() |
db22874f06 | ||
![]() |
5d5533a920 | ||
![]() |
7f6e29de52 | ||
![]() |
48469d32c2 | ||
![]() |
7f9159fef1 | ||
![]() |
b063b4daf2 | ||
![]() |
58ba4cb11c | ||
![]() |
55e3774f07 | ||
![]() |
d5d9e04325 | ||
![]() |
6c8153ba98 | ||
![]() |
e871b23210 | ||
![]() |
e22ec16e40 | ||
![]() |
440fbbc6c2 | ||
![]() |
f74012993e | ||
![]() |
814d3c946e | ||
![]() |
eca40a6979 | ||
![]() |
0b66fc2bca | ||
![]() |
1a09b028b7 | ||
![]() |
0ddbf5beda | ||
![]() |
bf41fa1596 | ||
![]() |
8ad614ef4f | ||
![]() |
fc40427fba | ||
![]() |
e8dfefe6ae | ||
![]() |
d42a3a3933 | ||
![]() |
bb7aa5b0b4 | ||
![]() |
3b6212065a | ||
![]() |
3d3b7a7af8 | ||
![]() |
f1c10928ae | ||
![]() |
a5498aba2b | ||
![]() |
f91f3a65c5 | ||
![]() |
65ee2700e7 | ||
![]() |
56a00ddb85 | ||
![]() |
50b81fd337 | ||
![]() |
c51db8da72 | ||
![]() |
06098415f1 | ||
![]() |
9ed724e161 | ||
![]() |
a6d7da1205 | ||
![]() |
87174eadd6 | ||
![]() |
fde2857915 | ||
![]() |
fae8cb6b23 | ||
![]() |
a754159800 | ||
![]() |
080e2e582c | ||
![]() |
8ff1bbd41f | ||
![]() |
6442757927 | ||
![]() |
710416ff36 | ||
![]() |
1181be12e2 | ||
![]() |
53c36002e9 | ||
![]() |
8b17d8894d | ||
![]() |
1e3e46ff4f | ||
![]() |
977d252497 | ||
![]() |
96bcd7719a | ||
![]() |
2d85ce17f6 | ||
![]() |
c26e129bda | ||
![]() |
84ea5e4a41 | ||
![]() |
491533d3f4 | ||
![]() |
ef5f0b5ddd | ||
![]() |
c0dc763f99 | ||
![]() |
11327af879 | ||
![]() |
9f0eb5bfe9 | ||
![]() |
d2575d5191 | ||
![]() |
32bedb7fad | ||
![]() |
d605efd54a | ||
![]() |
74e53891a1 | ||
![]() |
27b18c62f5 | ||
![]() |
df116bd221 |
@ -13,3 +13,6 @@ AUTH_SHA256_DIGEST=
|
|||||||
JWT_SECRET=
|
JWT_SECRET=
|
||||||
JWT_ISSUER=
|
JWT_ISSUER=
|
||||||
JWT_VALIDITY_IN_MIN=
|
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
|
name: Release
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: write
|
||||||
packages: write
|
packages: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
@ -60,7 +60,7 @@ jobs:
|
|||||||
DOCKER_REGISTRY_USER: ${{ github.actor }}
|
DOCKER_REGISTRY_USER: ${{ github.actor }}
|
||||||
DOCKER_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
|
DOCKER_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
|
||||||
GITHUB_ACTOR: ${{ github.actor }}
|
GITHUB_ACTOR: ${{ github.actor }}
|
||||||
GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: npm exec semantic-release
|
run: npm exec semantic-release
|
||||||
|
|
||||||
- name: Set Portainer stack webhook URL based on branch
|
- name: Set Portainer stack webhook URL based on branch
|
||||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -41,7 +41,6 @@ persistence/
|
|||||||
configuration.toml
|
configuration.toml
|
||||||
docker-compose.yml
|
docker-compose.yml
|
||||||
patches-public-key.asc
|
patches-public-key.asc
|
||||||
integrations-public-key.asc
|
|
||||||
node_modules/
|
node_modules/
|
||||||
static/
|
static/
|
||||||
about.json
|
about.json
|
@ -21,10 +21,10 @@
|
|||||||
"@semantic-release/git",
|
"@semantic-release/git",
|
||||||
{
|
{
|
||||||
"assets": [
|
"assets": [
|
||||||
"README.md",
|
|
||||||
"CHANGELOG.md",
|
"CHANGELOG.md",
|
||||||
"gradle.properties"
|
"gradle.properties"
|
||||||
]
|
],
|
||||||
|
"message": "chore: Release v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
|
243
CHANGELOG.md
243
CHANGELOG.md
@ -1,3 +1,246 @@
|
|||||||
|
# [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)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Respond to all ping request methods ([df116bd](https://github.com/ReVanced/revanced-api/commit/df116bd22134c8222c72b28e9387bc9871d3473e))
|
||||||
|
|
||||||
# [1.2.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.1.0...v1.2.0-dev.1) (2024-08-16)
|
# [1.2.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.1.0...v1.2.0-dev.1) (2024-08-16)
|
||||||
|
|
||||||
|
|
||||||
|
36
README.md
36
README.md
@ -68,19 +68,19 @@ API server for ReVanced.
|
|||||||
## ❓ About
|
## ❓ About
|
||||||
|
|
||||||
ReVanced API is a server that is used as the backend for ReVanced.
|
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.
|
with updates and ReVanced Patches.
|
||||||
|
|
||||||
## 💪 Features
|
## 💪 Features
|
||||||
|
|
||||||
Some of the features ReVanced API include:
|
Some of the features ReVanced API include:
|
||||||
|
|
||||||
- 📢 **Announcements**: Post and get announcements grouped by channels
|
- 📢 **Announcements**: Post and get announcements
|
||||||
- ℹ️ **About**: Get more information such as a description, ways to donate to,
|
- ℹ️ **About**: Get more information such as a description, ways to donate to,
|
||||||
and links of the hoster of ReVanced API
|
and links of the hoster of ReVanced API
|
||||||
- 🧩 **Patches**: Get the latest updates of ReVanced Patches, directly from ReVanced API
|
- 🧩 **Patches**: Get the latest updates of ReVanced Patches, directly from ReVanced API
|
||||||
- 👥 **Contributors**: List all contributors involved in the project
|
- 👥 **Contributors**: List all contributors involved in the project
|
||||||
- 🔄 **Backwards compatibility**: Proxy an old API for migration purposes and backwards compatibility
|
|
||||||
|
|
||||||
## 🚀 How to get started
|
## 🚀 How to get started
|
||||||
|
|
||||||
@ -90,26 +90,35 @@ 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.
|
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,
|
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
|
### 🗄️ Docker Compose
|
||||||
|
|
||||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
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
|
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
3. Create a `docker-compose.yml` file using [docker-compose.example.yml](docker-compose.example.yml) as a template
|
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||||
4. Run `docker-compose up -d` to start the server
|
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
|
||||||
|
|
||||||
### 💻 Docker CLI
|
### 💻 Docker CLI
|
||||||
|
|
||||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
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
|
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
3. Start the container using the following command:
|
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||||
|
4. Start the container using the following command:
|
||||||
```shell
|
```shell
|
||||||
docker run -d --name revanced-api \
|
docker run -d --name revanced-api \
|
||||||
# Mount the .env file
|
# Mount the .env file
|
||||||
-v $(pwd)/.env:/app/.env \
|
-v $(pwd)/.env:/app/.env \
|
||||||
# Mount the configuration.toml file
|
# Mount the configuration.toml file
|
||||||
-v $(pwd)/configuration.toml:/app/configuration.toml \
|
-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
|
# Mount the persistence folder
|
||||||
-v $(pwd)/persistence:/app/persistence \
|
-v $(pwd)/persistence:/app/persistence \
|
||||||
# Expose the port 8888
|
# Expose the port 8888
|
||||||
@ -131,8 +140,9 @@ A Java Runtime Environment (JRE) must be installed.
|
|||||||
1. [Download](https://github.com/ReVanced/revanced-api/releases/latest) ReVanced API to a folder
|
1. [Download](https://github.com/ReVanced/revanced-api/releases/latest) ReVanced API to a folder
|
||||||
2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template
|
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
|
3. In the same folder, create a `configuration.toml` file
|
||||||
using [configuration.example.toml](configuration.example.toml) as a template
|
using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
4. Run `java -jar revanced-api.jar start` to start the server
|
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
|
||||||
|
|
||||||
### 🛠️ From source
|
### 🛠️ From source
|
||||||
|
|
||||||
@ -141,13 +151,15 @@ 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
|
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
|
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
|
3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values
|
||||||
4. Run `gradlew run --args=start` to start the server
|
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
|
||||||
|
|
||||||
## 📚 Everything else
|
## 📚 Everything else
|
||||||
|
|
||||||
### 📙 Contributing
|
### 📙 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
|
### 🛠️ Building
|
||||||
|
|
||||||
|
@ -5,6 +5,7 @@
|
|||||||
"branding": {
|
"branding": {
|
||||||
"logo": "https://raw.githubusercontent.com/ReVanced/revanced-branding/main/assets/revanced-logo/revanced-logo.svg"
|
"logo": "https://raw.githubusercontent.com/ReVanced/revanced-branding/main/assets/revanced-logo/revanced-logo.svg"
|
||||||
},
|
},
|
||||||
|
"status": "https://status.revanced.app",
|
||||||
"contact": {
|
"contact": {
|
||||||
"email": "contact@revanced.app"
|
"email": "contact@revanced.app"
|
||||||
},
|
},
|
||||||
|
@ -48,6 +48,12 @@ kotlin {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
tasks {
|
||||||
|
test {
|
||||||
|
useJUnitPlatform()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
repositories {
|
repositories {
|
||||||
mavenCentral()
|
mavenCentral()
|
||||||
google()
|
google()
|
||||||
@ -98,6 +104,8 @@ dependencies {
|
|||||||
implementation(libs.caffeine)
|
implementation(libs.caffeine)
|
||||||
implementation(libs.bouncy.castle.provider)
|
implementation(libs.bouncy.castle.provider)
|
||||||
implementation(libs.bouncy.castle.pgp)
|
implementation(libs.bouncy.castle.pgp)
|
||||||
|
|
||||||
|
testImplementation(kotlin("test"))
|
||||||
}
|
}
|
||||||
|
|
||||||
// The maven-publish plugin is necessary to make signing work.
|
// The maven-publish plugin is necessary to make signing work.
|
||||||
|
@ -1,22 +1,29 @@
|
|||||||
organization = "revanced"
|
api-version = "v1"
|
||||||
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 = [
|
cors-allowed-hosts = [
|
||||||
"revanced.app",
|
"revanced.app",
|
||||||
"*.revanced.app"
|
"*.revanced.app"
|
||||||
]
|
]
|
||||||
endpoint = "https://api.revanced.app"
|
endpoint = "https://api.revanced.app"
|
||||||
old-api-endpoint = "https://old-api.revanced.app"
|
|
||||||
static-files-path = "static/root"
|
static-files-path = "static/root"
|
||||||
versioned-static-files-path = "static/versioned"
|
versioned-static-files-path = "static/versioned"
|
||||||
|
backend-service-name = "GitHub"
|
||||||
about-json-file-path = "about.json"
|
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,11 +7,10 @@ services:
|
|||||||
- /data/revanced-api/.env:/app/.env
|
- /data/revanced-api/.env:/app/.env
|
||||||
- /data/revanced-api/configuration.toml:/app/configuration.toml
|
- /data/revanced-api/configuration.toml:/app/configuration.toml
|
||||||
- /data/revanced-api/patches-public-key.asc:/app/patches-public-key.asc
|
- /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/static:/app/static
|
||||||
- /data/revanced-api/about.json:/app/about.json
|
- /data/revanced-api/about.json:/app/about.json
|
||||||
environment:
|
environment:
|
||||||
- COMMAND=start
|
- COMMAND=start
|
||||||
ports:
|
ports:
|
||||||
- 8888:8888
|
- "8888:8888"
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
org.gradle.parallel = true
|
org.gradle.parallel = true
|
||||||
org.gradle.caching = true
|
org.gradle.caching = true
|
||||||
kotlin.code.style = official
|
kotlin.code.style = official
|
||||||
version = 1.2.0-dev.1
|
version = 1.6.0
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[versions]
|
[versions]
|
||||||
kompendium-core = "3.14.4"
|
kompendium-core = "3.14.4"
|
||||||
kotlin = "2.0.0"
|
kotlin = "2.0.20"
|
||||||
logback = "1.5.6"
|
logback = "1.5.6"
|
||||||
exposed = "0.52.0"
|
exposed = "0.52.0"
|
||||||
h2 = "2.2.224"
|
h2 = "2.2.224"
|
||||||
@ -10,8 +10,8 @@ ktor = "2.3.7"
|
|||||||
ktoml = "0.5.2"
|
ktoml = "0.5.2"
|
||||||
picocli = "4.7.6"
|
picocli = "4.7.6"
|
||||||
datetime = "0.6.0"
|
datetime = "0.6.0"
|
||||||
revanced-patcher = "20.0.0"
|
revanced-patcher = "21.0.0"
|
||||||
revanced-library = "3.0.1-dev.1"
|
revanced-library = "3.0.2"
|
||||||
caffeine = "3.1.8"
|
caffeine = "3.1.8"
|
||||||
bouncy-castle = "1.78.1"
|
bouncy-castle = "1.78.1"
|
||||||
|
|
||||||
|
3648
package-lock.json
generated
3648
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",
|
"@saithodev/semantic-release-backmerge": "^4.0.1",
|
||||||
"@semantic-release/changelog": "^6.0.3",
|
"@semantic-release/changelog": "^6.0.3",
|
||||||
"@semantic-release/git": "^10.0.1",
|
"@semantic-release/git": "^10.0.1",
|
||||||
"gradle-semantic-release-plugin": "^1.9.2",
|
"gradle-semantic-release-plugin": "^1.10.1",
|
||||||
"semantic-release": "^24.0.0"
|
"semantic-release": "^24.1.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
@ -1,6 +1,7 @@
|
|||||||
package app.revanced.api.command
|
package app.revanced.api.command
|
||||||
|
|
||||||
import app.revanced.api.configuration.*
|
import app.revanced.api.configuration.*
|
||||||
|
import io.github.cdimascio.dotenv.Dotenv
|
||||||
import io.ktor.server.engine.*
|
import io.ktor.server.engine.*
|
||||||
import io.ktor.server.jetty.*
|
import io.ktor.server.jetty.*
|
||||||
import picocli.CommandLine
|
import picocli.CommandLine
|
||||||
@ -33,6 +34,8 @@ internal object StartAPICommand : Runnable {
|
|||||||
private var configFile = File("configuration.toml")
|
private var configFile = File("configuration.toml")
|
||||||
|
|
||||||
override fun run() {
|
override fun run() {
|
||||||
|
Dotenv.configure().systemProperties().load()
|
||||||
|
|
||||||
embeddedServer(Jetty, port, host) {
|
embeddedServer(Jetty, port, host) {
|
||||||
configureDependencies(configFile)
|
configureDependencies(configFile)
|
||||||
configureHTTP()
|
configureHTTP()
|
||||||
|
@ -1,124 +1,116 @@
|
|||||||
package app.revanced.api.configuration.schema
|
package app.revanced.api.configuration
|
||||||
|
|
||||||
|
import kotlinx.datetime.Clock
|
||||||
import kotlinx.datetime.LocalDateTime
|
import kotlinx.datetime.LocalDateTime
|
||||||
|
import kotlinx.datetime.TimeZone
|
||||||
|
import kotlinx.datetime.toLocalDateTime
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
|
|
||||||
interface APIUser {
|
interface ApiUser {
|
||||||
val name: String
|
val name: String
|
||||||
val avatarUrl: String
|
val avatarUrl: String
|
||||||
val url: String
|
val url: String
|
||||||
}
|
}
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIMember(
|
class ApiMember(
|
||||||
override val name: String,
|
override val name: String,
|
||||||
override val avatarUrl: String,
|
override val avatarUrl: String,
|
||||||
override val url: String,
|
override val url: String,
|
||||||
val bio: String?,
|
val bio: String?,
|
||||||
val gpgKey: APIGpgKey?,
|
val gpgKey: ApiGpgKey?,
|
||||||
) : APIUser
|
) : ApiUser
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIGpgKey(
|
class ApiGpgKey(
|
||||||
val id: String,
|
val id: String,
|
||||||
val url: String,
|
val url: String,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIContributor(
|
class ApiContributor(
|
||||||
override val name: String,
|
override val name: String,
|
||||||
override val avatarUrl: String,
|
override val avatarUrl: String,
|
||||||
override val url: String,
|
override val url: String,
|
||||||
val contributions: Int,
|
val contributions: Int,
|
||||||
) : APIUser
|
) : ApiUser
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIContributable(
|
class APIContributable(
|
||||||
val name: String,
|
val name: String,
|
||||||
|
val url: String,
|
||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val contributors: List<APIContributor>,
|
val contributors: List<ApiContributor>,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIRelease<T>(
|
class ApiRelease(
|
||||||
val version: String,
|
val version: String,
|
||||||
val createdAt: LocalDateTime,
|
val createdAt: LocalDateTime,
|
||||||
val description: String,
|
val description: String,
|
||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
|
||||||
val assets: List<T>,
|
|
||||||
)
|
|
||||||
|
|
||||||
@Serializable
|
|
||||||
class APIManagerAsset(
|
|
||||||
val downloadUrl: String,
|
val downloadUrl: String,
|
||||||
|
val signatureDownloadUrl: String? = null,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIPatchesAsset(
|
class ApiReleaseVersion(
|
||||||
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,
|
val version: String,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIAnnouncement(
|
class ApiAnnouncement(
|
||||||
val author: String? = null,
|
val author: String? = null,
|
||||||
val title: String,
|
val title: String,
|
||||||
val content: String? = null,
|
val content: String? = null,
|
||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val attachmentUrls: List<String> = emptyList(),
|
val attachments: List<String>? = null,
|
||||||
val channel: 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 archivedAt: LocalDateTime? = null,
|
val archivedAt: LocalDateTime? = null,
|
||||||
val level: Int = 0,
|
val level: Int = 0,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIResponseAnnouncement(
|
class ApiResponseAnnouncement(
|
||||||
val id: Int,
|
val id: Int,
|
||||||
val author: String? = null,
|
val author: String? = null,
|
||||||
val title: String,
|
val title: String,
|
||||||
val content: String? = null,
|
val content: String? = null,
|
||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val attachmentUrls: List<String> = emptyList(),
|
val attachments: List<String>? = null,
|
||||||
val channel: String? = null,
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
|
val tags: List<String>? = null,
|
||||||
val createdAt: LocalDateTime,
|
val createdAt: LocalDateTime,
|
||||||
val archivedAt: LocalDateTime? = null,
|
val archivedAt: LocalDateTime? = null,
|
||||||
val level: Int = 0,
|
val level: Int = 0,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIResponseAnnouncementId(
|
class ApiResponseAnnouncementId(
|
||||||
val id: Int,
|
val id: Int,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIAnnouncementArchivedAt(
|
class ApiAnnouncementArchivedAt(
|
||||||
val archivedAt: LocalDateTime,
|
val archivedAt: LocalDateTime,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIRateLimit(
|
class ApiAnnouncementTag(
|
||||||
|
val name: String,
|
||||||
|
)
|
||||||
|
|
||||||
|
@Serializable
|
||||||
|
class ApiRateLimit(
|
||||||
val limit: Int,
|
val limit: Int,
|
||||||
val remaining: Int,
|
val remaining: Int,
|
||||||
val reset: LocalDateTime,
|
val reset: LocalDateTime,
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
class APIAssetPublicKeys(
|
class ApiAssetPublicKey(
|
||||||
val patchesPublicKey: String,
|
val patchesPublicKey: String,
|
||||||
val integrationsPublicKey: String,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
@Serializable
|
@Serializable
|
||||||
@ -131,6 +123,7 @@ class APIAbout(
|
|||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val socials: List<Social>?,
|
val socials: List<Social>?,
|
||||||
val donations: Donations?,
|
val donations: Donations?,
|
||||||
|
val status: String,
|
||||||
) {
|
) {
|
||||||
@Serializable
|
@Serializable
|
||||||
class Branding(
|
class Branding(
|
||||||
@ -172,3 +165,6 @@ class APIAbout(
|
|||||||
val links: List<Link>?,
|
val links: List<Link>?,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Serializable
|
||||||
|
class ApiToken(val token: String)
|
@ -5,131 +5,51 @@ import app.revanced.api.configuration.repository.BackendRepository
|
|||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.repository.GitHubBackendRepository
|
import app.revanced.api.configuration.repository.GitHubBackendRepository
|
||||||
import app.revanced.api.configuration.services.*
|
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.Toml
|
||||||
import com.akuleshov7.ktoml.source.decodeFromStream
|
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 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.Database
|
||||||
import org.jetbrains.exposed.sql.transactions.TransactionManager
|
|
||||||
import org.koin.core.module.dsl.singleOf
|
import org.koin.core.module.dsl.singleOf
|
||||||
import org.koin.core.parameter.parameterArrayOf
|
|
||||||
import org.koin.dsl.module
|
import org.koin.dsl.module
|
||||||
import org.koin.ktor.plugin.Koin
|
import org.koin.ktor.plugin.Koin
|
||||||
import java.io.File
|
import java.io.File
|
||||||
|
|
||||||
@OptIn(ExperimentalSerializationApi::class)
|
|
||||||
fun Application.configureDependencies(
|
fun Application.configureDependencies(
|
||||||
configFile: File,
|
configFile: File,
|
||||||
) {
|
) {
|
||||||
val globalModule = module {
|
|
||||||
single {
|
|
||||||
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 {
|
val repositoryModule = module {
|
||||||
single<BackendRepository> {
|
single<ConfigurationRepository> { Toml.decodeFromStream(configFile.inputStream()) }
|
||||||
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
|
|
||||||
},
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
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 {
|
single {
|
||||||
val dotenv = get<Dotenv>()
|
Database.connect(
|
||||||
|
url = System.getProperty("DB_URL"),
|
||||||
TransactionManager.defaultDatabase = Database.connect(
|
user = System.getProperty("DB_USER"),
|
||||||
url = dotenv["DB_URL"],
|
password = System.getProperty("DB_PASSWORD"),
|
||||||
user = dotenv["DB_USER"],
|
)
|
||||||
password = dotenv["DB_PASSWORD"],
|
}
|
||||||
|
singleOf(::AnnouncementRepository)
|
||||||
|
singleOf(::GitHubBackendRepository)
|
||||||
|
single<BackendRepository> {
|
||||||
|
val backendServices = mapOf(
|
||||||
|
GitHubBackendRepository.SERVICE_NAME to { get<GitHubBackendRepository>() },
|
||||||
|
// Implement more backend services here.
|
||||||
)
|
)
|
||||||
|
|
||||||
AnnouncementRepository()
|
val configuration = get<ConfigurationRepository>()
|
||||||
|
val backendFactory = backendServices[configuration.backendServiceName]!!
|
||||||
|
|
||||||
|
backendFactory()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
val serviceModule = module {
|
val serviceModule = module {
|
||||||
single {
|
single {
|
||||||
val dotenv = get<Dotenv>()
|
val jwtSecret = System.getProperty("JWT_SECRET")
|
||||||
|
val issuer = System.getProperty("JWT_ISSUER")
|
||||||
|
val validityInMin = System.getProperty("JWT_VALIDITY_IN_MIN").toLong()
|
||||||
|
|
||||||
val jwtSecret = dotenv["JWT_SECRET"]
|
val authSHA256DigestString = System.getProperty("AUTH_SHA256_DIGEST")
|
||||||
val issuer = dotenv["JWT_ISSUER"]
|
|
||||||
val validityInMin = dotenv["JWT_VALIDITY_IN_MIN"].toInt()
|
|
||||||
|
|
||||||
val authSHA256DigestString = dotenv["AUTH_SHA256_DIGEST"]
|
AuthenticationService(issuer, validityInMin, jwtSecret, authSHA256DigestString)
|
||||||
|
|
||||||
AuthService(issuer, validityInMin, jwtSecret, authSHA256DigestString)
|
|
||||||
}
|
|
||||||
single {
|
|
||||||
val configuration = get<ConfigurationRepository>()
|
|
||||||
|
|
||||||
OldApiService(
|
|
||||||
get {
|
|
||||||
parameterArrayOf(configuration.oldApiEndpoint)
|
|
||||||
},
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
singleOf(::AnnouncementService)
|
singleOf(::AnnouncementService)
|
||||||
singleOf(::SignatureService)
|
singleOf(::SignatureService)
|
||||||
@ -140,7 +60,6 @@ fun Application.configureDependencies(
|
|||||||
|
|
||||||
install(Koin) {
|
install(Koin) {
|
||||||
modules(
|
modules(
|
||||||
globalModule,
|
|
||||||
repositoryModule,
|
repositoryModule,
|
||||||
serviceModule,
|
serviceModule,
|
||||||
)
|
)
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
package app.revanced.api.configuration
|
package app.revanced.api.configuration
|
||||||
|
|
||||||
|
import io.bkbn.kompendium.core.metadata.MethodInfo
|
||||||
import io.bkbn.kompendium.core.plugin.NotarizedRoute
|
import io.bkbn.kompendium.core.plugin.NotarizedRoute
|
||||||
import io.ktor.http.*
|
import io.ktor.http.*
|
||||||
import io.ktor.http.content.*
|
import io.ktor.http.content.*
|
||||||
@ -40,3 +41,11 @@ internal fun Route.staticFiles(
|
|||||||
extensions("json")
|
extensions("json")
|
||||||
},
|
},
|
||||||
) = staticFiles(remotePath, dir.toFile(), null, block)
|
) = staticFiles(remotePath, dir.toFile(), null, block)
|
||||||
|
|
||||||
|
internal fun MethodInfo.Builder<*>.canRespondUnauthorized() {
|
||||||
|
canRespond {
|
||||||
|
responseCode(HttpStatusCode.Unauthorized)
|
||||||
|
description("Unauthorized")
|
||||||
|
responseType<Unit>()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
package app.revanced.api.configuration
|
package app.revanced.api.configuration
|
||||||
|
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
|
import io.ktor.http.*
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.plugins.*
|
import io.ktor.server.plugins.*
|
||||||
import io.ktor.server.plugins.cors.routing.*
|
import io.ktor.server.plugins.cors.routing.*
|
||||||
@ -10,14 +11,19 @@ import org.koin.ktor.ext.get
|
|||||||
import kotlin.time.Duration.Companion.minutes
|
import kotlin.time.Duration.Companion.minutes
|
||||||
|
|
||||||
fun Application.configureHTTP() {
|
fun Application.configureHTTP() {
|
||||||
val configurationRepository = get<ConfigurationRepository>()
|
val configuration = get<ConfigurationRepository>()
|
||||||
|
|
||||||
install(CORS) {
|
install(CORS) {
|
||||||
configurationRepository.corsAllowedHosts.forEach { host ->
|
HttpMethod.DefaultMethods.minus(HttpMethod.Options).forEach(::allowMethod)
|
||||||
allowHost(
|
|
||||||
host = host,
|
allowHeader(HttpHeaders.ContentType)
|
||||||
schemes = listOf("http", "https")
|
allowHeader(HttpHeaders.Authorization)
|
||||||
)
|
exposeHeader(HttpHeaders.WWWAuthenticate)
|
||||||
|
|
||||||
|
allowCredentials = true
|
||||||
|
|
||||||
|
configuration.corsAllowedHosts.forEach { host ->
|
||||||
|
allowHost(host = host, schemes = listOf("https"))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2,6 +2,7 @@ package app.revanced.api.configuration
|
|||||||
|
|
||||||
import app.revanced.api.command.applicationVersion
|
import app.revanced.api.command.applicationVersion
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
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.core.plugin.NotarizedApplication
|
||||||
import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
|
import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
|
||||||
import io.bkbn.kompendium.oas.OpenApiSpec
|
import io.bkbn.kompendium.oas.OpenApiSpec
|
||||||
@ -12,13 +13,22 @@ import io.bkbn.kompendium.oas.info.License
|
|||||||
import io.bkbn.kompendium.oas.security.BearerAuth
|
import io.bkbn.kompendium.oas.security.BearerAuth
|
||||||
import io.bkbn.kompendium.oas.server.Server
|
import io.bkbn.kompendium.oas.server.Server
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import org.koin.ktor.ext.get
|
import io.ktor.server.response.*
|
||||||
|
import io.ktor.server.routing.*
|
||||||
import java.net.URI
|
import java.net.URI
|
||||||
|
import org.koin.ktor.ext.get as koinGet
|
||||||
|
|
||||||
internal fun Application.configureOpenAPI() {
|
internal fun Application.configureOpenAPI() {
|
||||||
val configurationRepository = get<ConfigurationRepository>()
|
val configuration = koinGet<ConfigurationRepository>()
|
||||||
|
|
||||||
install(NotarizedApplication()) {
|
install(NotarizedApplication()) {
|
||||||
|
openApiJson = {
|
||||||
|
route("/${configuration.apiVersion}/openapi.json") {
|
||||||
|
get {
|
||||||
|
call.respond(application.attributes[KompendiumAttributes.openApiSpec])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
spec = OpenApiSpec(
|
spec = OpenApiSpec(
|
||||||
info = Info(
|
info = Info(
|
||||||
title = "ReVanced API",
|
title = "ReVanced API",
|
||||||
@ -41,7 +51,7 @@ internal fun Application.configureOpenAPI() {
|
|||||||
),
|
),
|
||||||
).apply {
|
).apply {
|
||||||
servers += Server(
|
servers += Server(
|
||||||
url = URI(configurationRepository.endpoint),
|
url = URI(configuration.endpoint),
|
||||||
description = "ReVanced API server",
|
description = "ReVanced API server",
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
@ -4,7 +4,6 @@ import app.revanced.api.configuration.repository.ConfigurationRepository
|
|||||||
import app.revanced.api.configuration.routes.*
|
import app.revanced.api.configuration.routes.*
|
||||||
import app.revanced.api.configuration.routes.announcementsRoute
|
import app.revanced.api.configuration.routes.announcementsRoute
|
||||||
import app.revanced.api.configuration.routes.apiRoute
|
import app.revanced.api.configuration.routes.apiRoute
|
||||||
import app.revanced.api.configuration.routes.oldApiRoute
|
|
||||||
import app.revanced.api.configuration.routes.patchesRoute
|
import app.revanced.api.configuration.routes.patchesRoute
|
||||||
import io.bkbn.kompendium.core.routes.redoc
|
import io.bkbn.kompendium.core.routes.redoc
|
||||||
import io.bkbn.kompendium.core.routes.swagger
|
import io.bkbn.kompendium.core.routes.swagger
|
||||||
@ -19,7 +18,7 @@ internal fun Application.configureRouting() = routing {
|
|||||||
|
|
||||||
installCache(5.minutes)
|
installCache(5.minutes)
|
||||||
|
|
||||||
route("/v${configuration.apiVersion}") {
|
route("/${configuration.apiVersion}") {
|
||||||
announcementsRoute()
|
announcementsRoute()
|
||||||
patchesRoute()
|
patchesRoute()
|
||||||
managerRoute()
|
managerRoute()
|
||||||
@ -53,9 +52,7 @@ internal fun Application.configureRouting() = routing {
|
|||||||
extensions("json", "asc")
|
extensions("json", "asc")
|
||||||
}
|
}
|
||||||
|
|
||||||
swagger(pageTitle = "ReVanced API", path = "/")
|
val specUrl = "/${configuration.apiVersion}/openapi.json"
|
||||||
redoc(pageTitle = "ReVanced API", path = "/redoc")
|
swagger(pageTitle = "ReVanced API", path = "/", specUrl = specUrl)
|
||||||
|
redoc(pageTitle = "ReVanced API", path = "/redoc", specUrl = specUrl)
|
||||||
// TODO: Remove, once migration period from v2 API is over (In 1-2 years).
|
|
||||||
oldApiRoute()
|
|
||||||
}
|
}
|
||||||
|
@ -1,9 +1,17 @@
|
|||||||
package app.revanced.api.configuration
|
package app.revanced.api.configuration
|
||||||
|
|
||||||
import app.revanced.api.configuration.services.AuthService
|
import app.revanced.api.configuration.services.AuthenticationService
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
|
import io.ktor.server.auth.*
|
||||||
import org.koin.ktor.ext.get
|
import org.koin.ktor.ext.get
|
||||||
|
|
||||||
fun Application.configureSecurity() {
|
fun Application.configureSecurity() {
|
||||||
get<AuthService>().configureSecurity(this)
|
val authenticationService = get<AuthenticationService>()
|
||||||
|
|
||||||
|
install(Authentication) {
|
||||||
|
with(authenticationService) {
|
||||||
|
jwt()
|
||||||
|
digest()
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,12 +1,11 @@
|
|||||||
package app.revanced.api.configuration.repository
|
package app.revanced.api.configuration.repository
|
||||||
|
|
||||||
import app.revanced.api.configuration.schema.APIAnnouncement
|
import app.revanced.api.configuration.ApiAnnouncement
|
||||||
import app.revanced.api.configuration.schema.APIResponseAnnouncement
|
import app.revanced.api.configuration.ApiAnnouncementTag
|
||||||
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
import app.revanced.api.configuration.ApiResponseAnnouncement
|
||||||
|
import app.revanced.api.configuration.ApiResponseAnnouncementId
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
import kotlinx.coroutines.awaitAll
|
|
||||||
import kotlinx.coroutines.runBlocking
|
import kotlinx.coroutines.runBlocking
|
||||||
import kotlinx.datetime.*
|
|
||||||
import org.jetbrains.exposed.dao.IntEntity
|
import org.jetbrains.exposed.dao.IntEntity
|
||||||
import org.jetbrains.exposed.dao.IntEntityClass
|
import org.jetbrains.exposed.dao.IntEntityClass
|
||||||
import org.jetbrains.exposed.dao.id.EntityID
|
import org.jetbrains.exposed.dao.id.EntityID
|
||||||
@ -15,136 +14,178 @@ import org.jetbrains.exposed.sql.*
|
|||||||
import org.jetbrains.exposed.sql.kotlin.datetime.CurrentDateTime
|
import org.jetbrains.exposed.sql.kotlin.datetime.CurrentDateTime
|
||||||
import org.jetbrains.exposed.sql.kotlin.datetime.datetime
|
import org.jetbrains.exposed.sql.kotlin.datetime.datetime
|
||||||
import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
|
import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
|
||||||
import org.jetbrains.exposed.sql.transactions.experimental.suspendedTransactionAsync
|
|
||||||
|
|
||||||
internal class AnnouncementRepository {
|
internal class AnnouncementRepository(private val database: Database) {
|
||||||
// This is better than doing a maxByOrNull { it.id }.
|
// This is better than doing a maxByOrNull { it.id } on every request.
|
||||||
private var latestAnnouncement: Announcement? = null
|
private var latestAnnouncement: Announcement? = null
|
||||||
private val latestAnnouncementByChannel = mutableMapOf<String, Announcement>()
|
private val latestAnnouncementByTag = mutableMapOf<String, Announcement>()
|
||||||
|
|
||||||
private fun updateLatestAnnouncement(new: Announcement) {
|
|
||||||
if (latestAnnouncement?.id?.value == new.id.value) {
|
|
||||||
latestAnnouncement = new
|
|
||||||
latestAnnouncementByChannel[new.channel ?: return] = new
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
init {
|
init {
|
||||||
runBlocking {
|
runBlocking {
|
||||||
transaction {
|
transaction {
|
||||||
SchemaUtils.create(Announcements, Attachments)
|
SchemaUtils.create(
|
||||||
|
Announcements,
|
||||||
|
Attachments,
|
||||||
|
Tags,
|
||||||
|
AnnouncementTags,
|
||||||
|
)
|
||||||
|
|
||||||
// Initialize the latest announcement.
|
initializeLatestAnnouncements()
|
||||||
latestAnnouncement = Announcement.all().onEach {
|
|
||||||
latestAnnouncementByChannel[it.channel ?: return@onEach] = it
|
|
||||||
}.maxByOrNull { it.id } ?: return@transaction
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun all() = transaction {
|
private fun initializeLatestAnnouncements() {
|
||||||
Announcement.all().map { it.toApi() }
|
latestAnnouncement = Announcement.all().orderBy(Announcements.id to SortOrder.DESC).firstOrNull()
|
||||||
|
|
||||||
|
Tag.all().map { it.name }.forEach(::updateLatestAnnouncementForTag)
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun all(channel: String) = transaction {
|
private fun updateLatestAnnouncement(new: Announcement) {
|
||||||
Announcement.find { Announcements.channel eq channel }.map { it.toApi() }
|
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 delete(id: Int) = transaction {
|
suspend fun delete(id: Int) = transaction {
|
||||||
val announcement = Announcement.findById(id) ?: return@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()
|
announcement.delete()
|
||||||
|
|
||||||
// In case the latest announcement was deleted, query the new latest announcement again.
|
// If the deleted announcement is the latest announcement, set the new latest announcement.
|
||||||
if (latestAnnouncement?.id?.value == id) {
|
if (latestAnnouncement?.id?.value == id) {
|
||||||
latestAnnouncement = Announcement.all().maxByOrNull { it.id }
|
latestAnnouncement = Announcement.all().orderBy(Announcements.id to SortOrder.DESC).firstOrNull()
|
||||||
|
}
|
||||||
|
|
||||||
// If no latest announcement was found, remove it from the channel map.
|
// The new announcement may be the latest for a specific tag. Set the new latest announcement for that tag.
|
||||||
if (latestAnnouncement == null) {
|
latestAnnouncementByTag.keys.forEach { tag ->
|
||||||
latestAnnouncementByChannel.remove(announcement.channel)
|
updateLatestAnnouncementForTag(tag)
|
||||||
} else {
|
|
||||||
latestAnnouncementByChannel[latestAnnouncement!!.channel ?: return@transaction] = latestAnnouncement!!
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fun latest() = latestAnnouncement?.toApi()
|
suspend fun tags() = transaction {
|
||||||
|
Tag.all().toList().toApiTag()
|
||||||
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)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun unarchive(id: Int) = transaction {
|
private suspend fun <T> transaction(statement: suspend Transaction.() -> T) = newSuspendedTransaction(Dispatchers.IO, database, statement = statement)
|
||||||
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() {
|
private object Announcements : IntIdTable() {
|
||||||
val author = varchar("author", 32).nullable()
|
val author = varchar("author", 32).nullable()
|
||||||
val title = varchar("title", 64)
|
val title = varchar("title", 64)
|
||||||
val content = text("content").nullable()
|
val content = text("content").nullable()
|
||||||
val channel = varchar("channel", 16).nullable()
|
|
||||||
val createdAt = datetime("createdAt").defaultExpression(CurrentDateTime)
|
val createdAt = datetime("createdAt").defaultExpression(CurrentDateTime)
|
||||||
val archivedAt = datetime("archivedAt").nullable()
|
val archivedAt = datetime("archivedAt").nullable()
|
||||||
val level = integer("level")
|
val level = integer("level")
|
||||||
@ -155,6 +196,19 @@ internal class AnnouncementRepository {
|
|||||||
val announcement = reference("announcement", Announcements, onDelete = ReferenceOption.CASCADE)
|
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) {
|
class Announcement(id: EntityID<Int>) : IntEntity(id) {
|
||||||
companion object : IntEntityClass<Announcement>(Announcements)
|
companion object : IntEntityClass<Announcement>(Announcements)
|
||||||
|
|
||||||
@ -162,7 +216,7 @@ internal class AnnouncementRepository {
|
|||||||
var title by Announcements.title
|
var title by Announcements.title
|
||||||
var content by Announcements.content
|
var content by Announcements.content
|
||||||
val attachments by Attachment referrersOn Attachments.announcement
|
val attachments by Attachment referrersOn Attachments.announcement
|
||||||
var channel by Announcements.channel
|
var tags by Tag via AnnouncementTags
|
||||||
var createdAt by Announcements.createdAt
|
var createdAt by Announcements.createdAt
|
||||||
var archivedAt by Announcements.archivedAt
|
var archivedAt by Announcements.archivedAt
|
||||||
var level by Announcements.level
|
var level by Announcements.level
|
||||||
@ -175,17 +229,32 @@ internal class AnnouncementRepository {
|
|||||||
var announcement by Announcement referencedOn Attachments.announcement
|
var announcement by Announcement referencedOn Attachments.announcement
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Announcement.toApi() = APIResponseAnnouncement(
|
class Tag(id: EntityID<Int>) : IntEntity(id) {
|
||||||
id.value,
|
companion object : IntEntityClass<Tag>(Tags)
|
||||||
author,
|
|
||||||
title,
|
|
||||||
content,
|
|
||||||
attachments.map { it.url },
|
|
||||||
channel,
|
|
||||||
createdAt,
|
|
||||||
archivedAt,
|
|
||||||
level,
|
|
||||||
)
|
|
||||||
|
|
||||||
private fun Int.toApi() = APIResponseAnnouncementId(this)
|
var name by Tags.name
|
||||||
|
var announcements by Announcement via AnnouncementTags
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Announcement?.toApiResponseAnnouncement() = this?.let {
|
||||||
|
ApiResponseAnnouncement(
|
||||||
|
id.value,
|
||||||
|
author,
|
||||||
|
title,
|
||||||
|
content,
|
||||||
|
attachments.map { it.url },
|
||||||
|
tags.map { it.name },
|
||||||
|
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() }
|
||||||
}
|
}
|
||||||
|
@ -1,16 +1,59 @@
|
|||||||
package app.revanced.api.configuration.repository
|
package app.revanced.api.configuration.repository
|
||||||
|
|
||||||
import io.ktor.client.*
|
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.datetime.LocalDateTime
|
||||||
|
import kotlinx.serialization.json.Json
|
||||||
|
import kotlinx.serialization.json.JsonNamingStrategy
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The backend of the API used to get data.
|
* The backend of the API used to get data.
|
||||||
*
|
*
|
||||||
* @param client The HTTP client to use for requests.
|
* @param defaultRequestUri The URI to use for requests.
|
||||||
|
* @param website The site of the backend users can visit.
|
||||||
*/
|
*/
|
||||||
abstract class BackendRepository internal constructor(
|
abstract class BackendRepository internal constructor(
|
||||||
protected val client: HttpClient,
|
defaultRequestUri: String,
|
||||||
|
internal val website: String,
|
||||||
) {
|
) {
|
||||||
|
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.
|
* A user.
|
||||||
*
|
*
|
||||||
@ -92,12 +135,14 @@ abstract class BackendRepository internal constructor(
|
|||||||
* @property tag The tag of the release.
|
* @property tag The tag of the release.
|
||||||
* @property assets The assets of the release.
|
* @property assets The assets of the release.
|
||||||
* @property createdAt The date and time the release was created.
|
* @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.
|
* @property releaseNote The release note of the release.
|
||||||
*/
|
*/
|
||||||
class BackendRelease(
|
class BackendRelease(
|
||||||
val tag: String,
|
val tag: String,
|
||||||
val releaseNote: String,
|
val releaseNote: String,
|
||||||
val createdAt: LocalDateTime,
|
val createdAt: LocalDateTime,
|
||||||
|
val prerelease: Boolean,
|
||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val assets: List<BackendAsset>,
|
val assets: List<BackendAsset>,
|
||||||
) {
|
) {
|
||||||
@ -137,13 +182,13 @@ abstract class BackendRepository internal constructor(
|
|||||||
*
|
*
|
||||||
* @param owner The owner of the repository.
|
* @param owner The owner of the repository.
|
||||||
* @param repository The name of the repository.
|
* @param repository The name of the repository.
|
||||||
* @param tag The tag of the release. If null, the latest release is returned.
|
* @param prerelease Whether to get a prerelease.
|
||||||
* @return The release.
|
* @return The release.
|
||||||
*/
|
*/
|
||||||
abstract suspend fun release(
|
abstract suspend fun release(
|
||||||
owner: String,
|
owner: String,
|
||||||
repository: String,
|
repository: String,
|
||||||
tag: String? = null,
|
prerelease: Boolean,
|
||||||
): BackendOrganization.BackendRepository.BackendRelease
|
): BackendOrganization.BackendRepository.BackendRelease
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -153,7 +198,10 @@ abstract class BackendRepository internal constructor(
|
|||||||
* @param repository The name of the repository.
|
* @param repository The name of the repository.
|
||||||
* @return The contributors.
|
* @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.
|
* Get the members of an organization.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
package app.revanced.api.configuration.repository
|
package app.revanced.api.configuration.repository
|
||||||
|
|
||||||
import app.revanced.api.configuration.schema.APIAbout
|
import app.revanced.api.configuration.APIAbout
|
||||||
import app.revanced.api.configuration.services.ManagerService
|
import app.revanced.api.configuration.services.ManagerService
|
||||||
import app.revanced.api.configuration.services.PatchesService
|
import app.revanced.api.configuration.services.PatchesService
|
||||||
import kotlinx.serialization.ExperimentalSerializationApi
|
import kotlinx.serialization.ExperimentalSerializationApi
|
||||||
@ -17,19 +17,19 @@ import kotlinx.serialization.json.JsonNamingStrategy
|
|||||||
import kotlinx.serialization.json.decodeFromStream
|
import kotlinx.serialization.json.decodeFromStream
|
||||||
import java.io.File
|
import java.io.File
|
||||||
import java.nio.file.Path
|
import java.nio.file.Path
|
||||||
|
import kotlin.io.path.createDirectories
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The repository storing the configuration for the API.
|
* The repository storing the configuration for the API.
|
||||||
*
|
*
|
||||||
* @property organization The API backends organization name where the repositories for the patches and integrations are.
|
* @property organization The API backends organization name where the repositories are.
|
||||||
* @property patches The source of the patches.
|
* @property patches The source of the patches.
|
||||||
* @property integrations The source of the integrations.
|
|
||||||
* @property manager The source of the manager.
|
* @property manager The source of the manager.
|
||||||
* @property contributorsRepositoryNames The names of the repositories to get contributors from.
|
* @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 apiVersion The version to use for the API.
|
* @property apiVersion The version to use for the API.
|
||||||
* @property corsAllowedHosts The hosts allowed to make requests to the API.
|
* @property corsAllowedHosts The hosts allowed to make requests to the API.
|
||||||
* @property endpoint The endpoint of 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 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 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]
|
* @property about The path to the json file deserialized to [APIAbout]
|
||||||
@ -39,17 +39,16 @@ import java.nio.file.Path
|
|||||||
internal class ConfigurationRepository(
|
internal class ConfigurationRepository(
|
||||||
val organization: String,
|
val organization: String,
|
||||||
val patches: SignedAssetConfiguration,
|
val patches: SignedAssetConfiguration,
|
||||||
val integrations: SignedAssetConfiguration,
|
|
||||||
val manager: AssetConfiguration,
|
val manager: AssetConfiguration,
|
||||||
@SerialName("contributors-repositories")
|
@SerialName("contributors-repositories")
|
||||||
val contributorsRepositoryNames: Set<String>,
|
val contributorsRepositoryNames: Map<String, String>,
|
||||||
|
@SerialName("backend-service-name")
|
||||||
|
val backendServiceName: String,
|
||||||
@SerialName("api-version")
|
@SerialName("api-version")
|
||||||
val apiVersion: Int = 1,
|
val apiVersion: String = "v1",
|
||||||
@SerialName("cors-allowed-hosts")
|
@SerialName("cors-allowed-hosts")
|
||||||
val corsAllowedHosts: Set<String>,
|
val corsAllowedHosts: Set<String>,
|
||||||
val endpoint: String,
|
val endpoint: String,
|
||||||
@SerialName("old-api-endpoint")
|
|
||||||
val oldApiEndpoint: String,
|
|
||||||
@Serializable(with = PathSerializer::class)
|
@Serializable(with = PathSerializer::class)
|
||||||
@SerialName("static-files-path")
|
@SerialName("static-files-path")
|
||||||
val staticFilesPath: Path,
|
val staticFilesPath: Path,
|
||||||
@ -60,6 +59,11 @@ internal class ConfigurationRepository(
|
|||||||
@SerialName("about-json-file-path")
|
@SerialName("about-json-file-path")
|
||||||
val about: APIAbout,
|
val about: APIAbout,
|
||||||
) {
|
) {
|
||||||
|
init {
|
||||||
|
staticFilesPath.createDirectories()
|
||||||
|
versionedStaticFilesPath.createDirectories()
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Am asset configuration whose asset is signed.
|
* Am asset configuration whose asset is signed.
|
||||||
*
|
*
|
||||||
|
@ -8,25 +8,26 @@ import app.revanced.api.configuration.repository.GitHubOrganization.GitHubReposi
|
|||||||
import app.revanced.api.configuration.repository.GitHubOrganization.GitHubRepository.GitHubRelease
|
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.Contributors
|
||||||
import app.revanced.api.configuration.repository.Organization.Repository.Releases
|
import app.revanced.api.configuration.repository.Organization.Repository.Releases
|
||||||
import io.ktor.client.*
|
|
||||||
import io.ktor.client.call.*
|
import io.ktor.client.call.*
|
||||||
import io.ktor.client.plugins.resources.*
|
import io.ktor.client.plugins.resources.*
|
||||||
import io.ktor.resources.*
|
import io.ktor.resources.*
|
||||||
import kotlinx.coroutines.*
|
import kotlinx.coroutines.async
|
||||||
|
import kotlinx.coroutines.awaitAll
|
||||||
|
import kotlinx.coroutines.coroutineScope
|
||||||
import kotlinx.datetime.Instant
|
import kotlinx.datetime.Instant
|
||||||
import kotlinx.datetime.TimeZone
|
import kotlinx.datetime.TimeZone
|
||||||
import kotlinx.datetime.toLocalDateTime
|
import kotlinx.datetime.toLocalDateTime
|
||||||
import kotlinx.serialization.SerialName
|
import kotlinx.serialization.SerialName
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
|
|
||||||
class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
class GitHubBackendRepository : BackendRepository("https://api.github.com", "https://github.com") {
|
||||||
override suspend fun release(
|
override suspend fun release(
|
||||||
owner: String,
|
owner: String,
|
||||||
repository: String,
|
repository: String,
|
||||||
tag: String?,
|
prerelease: Boolean,
|
||||||
): BackendRelease {
|
): BackendRelease {
|
||||||
val release: GitHubRelease = if (tag != null) {
|
val release: GitHubRelease = if (prerelease) {
|
||||||
client.get(Releases.Tag(owner, repository, tag)).body()
|
client.get(Releases(owner, repository)).body<List<GitHubRelease>>().first { it.prerelease }
|
||||||
} else {
|
} else {
|
||||||
client.get(Releases.Latest(owner, repository)).body()
|
client.get(Releases.Latest(owner, repository)).body()
|
||||||
}
|
}
|
||||||
@ -35,6 +36,7 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
|||||||
tag = release.tagName,
|
tag = release.tagName,
|
||||||
releaseNote = release.body,
|
releaseNote = release.body,
|
||||||
createdAt = release.createdAt.toLocalDateTime(TimeZone.UTC),
|
createdAt = release.createdAt.toLocalDateTime(TimeZone.UTC),
|
||||||
|
prerelease = release.prerelease,
|
||||||
assets = release.assets.map {
|
assets = release.assets.map {
|
||||||
BackendAsset(
|
BackendAsset(
|
||||||
name = it.name,
|
name = it.name,
|
||||||
@ -67,7 +69,8 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
|||||||
|
|
||||||
override suspend fun members(organization: String): List<BackendMember> {
|
override suspend fun members(organization: String): List<BackendMember> {
|
||||||
// Get the list of members of the organization.
|
// 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 {
|
return coroutineScope {
|
||||||
publicMembers.map { member ->
|
publicMembers.map { member ->
|
||||||
@ -98,7 +101,7 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
|||||||
gpgKeys =
|
gpgKeys =
|
||||||
BackendMember.GpgKeys(
|
BackendMember.GpgKeys(
|
||||||
ids = gpgKeys.map { it.keyId },
|
ids = gpgKeys.map { it.keyId },
|
||||||
url = "https://api.github.com/users/${user.login}.gpg",
|
url = "https://github.com/${user.login}.gpg",
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@ -113,6 +116,10 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
|||||||
reset = Instant.fromEpochSeconds(rateLimit.rate.reset).toLocalDateTime(TimeZone.UTC),
|
reset = Instant.fromEpochSeconds(rateLimit.rate.reset).toLocalDateTime(TimeZone.UTC),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
const val SERVICE_NAME = "GitHub"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
interface IGitHubUser {
|
interface IGitHubUser {
|
||||||
@ -157,6 +164,7 @@ class GitHubOrganization {
|
|||||||
// Using a list instead of a set because set semantics are unnecessary here.
|
// Using a list instead of a set because set semantics are unnecessary here.
|
||||||
val assets: List<GitHubAsset>,
|
val assets: List<GitHubAsset>,
|
||||||
val createdAt: Instant,
|
val createdAt: Instant,
|
||||||
|
val prerelease: Boolean,
|
||||||
val body: String,
|
val body: String,
|
||||||
) {
|
) {
|
||||||
@Serializable
|
@Serializable
|
||||||
@ -194,10 +202,8 @@ class Organization {
|
|||||||
@Resource("/repos/{owner}/{repo}/contributors")
|
@Resource("/repos/{owner}/{repo}/contributors")
|
||||||
class Contributors(val owner: String, val repo: String, @SerialName("per_page") val perPage: Int = 100)
|
class Contributors(val owner: String, val repo: String, @SerialName("per_page") val perPage: Int = 100)
|
||||||
|
|
||||||
class Releases {
|
@Resource("/repos/{owner}/{repo}/releases")
|
||||||
@Resource("/repos/{owner}/{repo}/releases/tags/{tag}")
|
class Releases(val owner: String, val repo: String) {
|
||||||
class Tag(val owner: String, val repo: String, val tag: String)
|
|
||||||
|
|
||||||
@Resource("/repos/{owner}/{repo}/releases/latest")
|
@Resource("/repos/{owner}/{repo}/releases/latest")
|
||||||
class Latest(val owner: String, val repo: String)
|
class Latest(val owner: String, val repo: String)
|
||||||
}
|
}
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
package app.revanced.api.configuration.routes
|
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.installCache
|
||||||
import app.revanced.api.configuration.installNotarizedRoute
|
import app.revanced.api.configuration.installNotarizedRoute
|
||||||
import app.revanced.api.configuration.respondOrNotFound
|
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 app.revanced.api.configuration.services.AnnouncementService
|
||||||
import io.bkbn.kompendium.core.metadata.DeleteInfo
|
import io.bkbn.kompendium.core.metadata.DeleteInfo
|
||||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
import io.bkbn.kompendium.core.metadata.GetInfo
|
||||||
@ -18,7 +18,6 @@ import io.ktor.http.*
|
|||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.auth.*
|
import io.ktor.server.auth.*
|
||||||
import io.ktor.server.plugins.ratelimit.*
|
import io.ktor.server.plugins.ratelimit.*
|
||||||
import io.ktor.server.request.*
|
|
||||||
import io.ktor.server.response.*
|
import io.ktor.server.response.*
|
||||||
import io.ktor.server.routing.*
|
import io.ktor.server.routing.*
|
||||||
import io.ktor.server.util.*
|
import io.ktor.server.util.*
|
||||||
@ -34,139 +33,177 @@ internal fun Route.announcementsRoute() = route("announcements") {
|
|||||||
|
|
||||||
rateLimit(RateLimitName("strong")) {
|
rateLimit(RateLimitName("strong")) {
|
||||||
get {
|
get {
|
||||||
call.respond(announcementService.all())
|
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()))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
rateLimit(RateLimitName("strong")) {
|
rateLimit(RateLimitName("weak")) {
|
||||||
route("{channel}/latest") {
|
|
||||||
installLatestChannelAnnouncementRouteDocumentation()
|
|
||||||
|
|
||||||
get {
|
|
||||||
val channel: String by call.parameters
|
|
||||||
|
|
||||||
call.respondOrNotFound(announcementService.latest(channel))
|
|
||||||
}
|
|
||||||
|
|
||||||
route("id") {
|
|
||||||
installLatestChannelAnnouncementIdRouteDocumentation()
|
|
||||||
|
|
||||||
get {
|
|
||||||
val channel: String by call.parameters
|
|
||||||
|
|
||||||
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())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
rateLimit(RateLimitName("strong")) {
|
|
||||||
authenticate("jwt") {
|
authenticate("jwt") {
|
||||||
installAnnouncementRouteDocumentation()
|
post<ApiAnnouncement> { announcement ->
|
||||||
|
|
||||||
post<APIAnnouncement> { announcement ->
|
|
||||||
announcementService.new(announcement)
|
announcementService.new(announcement)
|
||||||
|
|
||||||
|
call.respond(HttpStatusCode.OK)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
route("latest") {
|
||||||
|
installAnnouncementsLatestRouteDocumentation()
|
||||||
|
|
||||||
|
get {
|
||||||
|
val tags = call.parameters.getAll("tag")
|
||||||
|
|
||||||
|
if (tags?.isNotEmpty() == true) {
|
||||||
|
call.respond(announcementService.latest(tags.toSet()))
|
||||||
|
} else {
|
||||||
|
call.respondOrNotFound(announcementService.latest())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
route("{id}") {
|
route("id") {
|
||||||
installAnnouncementIdRouteDocumentation()
|
installAnnouncementsLatestIdRouteDocumentation()
|
||||||
|
|
||||||
patch<APIAnnouncement> { announcement ->
|
get {
|
||||||
|
val tags = call.parameters.getAll("tag")
|
||||||
|
|
||||||
|
if (tags?.isNotEmpty() == true) {
|
||||||
|
call.respond(announcementService.latestId(tags.toSet()))
|
||||||
|
} else {
|
||||||
|
call.respondOrNotFound(announcementService.latestId())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
route("{id}") {
|
||||||
|
installAnnouncementsIdRouteDocumentation()
|
||||||
|
|
||||||
|
get {
|
||||||
|
val id: Int by call.parameters
|
||||||
|
|
||||||
|
call.respondOrNotFound(announcementService.get(id))
|
||||||
|
}
|
||||||
|
|
||||||
|
authenticate("jwt") {
|
||||||
|
patch<ApiAnnouncement> { announcement ->
|
||||||
val id: Int by call.parameters
|
val id: Int by call.parameters
|
||||||
|
|
||||||
announcementService.update(id, announcement)
|
announcementService.update(id, announcement)
|
||||||
|
|
||||||
|
call.respond(HttpStatusCode.OK)
|
||||||
}
|
}
|
||||||
|
|
||||||
delete {
|
delete {
|
||||||
val id: Int by call.parameters
|
val id: Int by call.parameters
|
||||||
|
|
||||||
announcementService.delete(id)
|
announcementService.delete(id)
|
||||||
|
|
||||||
|
call.respond(HttpStatusCode.OK)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
route("archive") {
|
route("tags") {
|
||||||
installAnnouncementArchiveRouteDocumentation()
|
installAnnouncementsTagsRouteDocumentation()
|
||||||
|
|
||||||
post {
|
get {
|
||||||
val id: Int by call.parameters
|
call.respond(announcementService.tags())
|
||||||
val archivedAt = call.receiveNullable<APIAnnouncementArchivedAt>()?.archivedAt
|
|
||||||
|
|
||||||
announcementService.archive(id, archivedAt)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
route("unarchive") {
|
|
||||||
installAnnouncementUnarchiveRouteDocumentation()
|
|
||||||
|
|
||||||
post {
|
|
||||||
val id: Int by call.parameters
|
|
||||||
|
|
||||||
announcementService.unarchive(id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRoute {
|
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 {
|
||||||
tags = setOf("Announcements")
|
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 {
|
post = PostInfo.builder {
|
||||||
description("Create a new announcement")
|
description("Create a new announcement")
|
||||||
summary("Create announcement")
|
summary("Create announcement")
|
||||||
|
parameters(authHeaderParameter)
|
||||||
request {
|
request {
|
||||||
requestType<APIAnnouncement>()
|
requestType<ApiAnnouncement>()
|
||||||
description("The new announcement")
|
description("The new announcement")
|
||||||
}
|
}
|
||||||
response {
|
response {
|
||||||
description("When the announcement was created")
|
description("The announcement is created")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestAnnouncementRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installAnnouncementsLatestRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Announcements")
|
tags = setOf("Announcements")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the latest announcement")
|
description("Get the latest announcement")
|
||||||
summary("Get 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 {
|
response {
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
description("The latest announcement")
|
description("The latest announcement")
|
||||||
responseType<APIResponseAnnouncement>()
|
responseType<ApiResponseAnnouncement>()
|
||||||
|
}
|
||||||
|
canRespond {
|
||||||
|
responseCode(HttpStatusCode.OK)
|
||||||
|
mediaTypes("application/json")
|
||||||
|
description("The latest announcements")
|
||||||
|
responseType<Set<ApiResponseAnnouncement>>()
|
||||||
}
|
}
|
||||||
canRespond {
|
canRespond {
|
||||||
responseCode(HttpStatusCode.NotFound)
|
responseCode(HttpStatusCode.NotFound)
|
||||||
@ -176,17 +213,32 @@ private fun Route.installLatestAnnouncementRouteDocumentation() = installNotariz
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestAnnouncementIdRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installAnnouncementsLatestIdRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Announcements")
|
tags = setOf("Announcements")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the id of the latest announcement")
|
description("Get the ID of the latest announcement")
|
||||||
summary("Get id of 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,
|
||||||
|
),
|
||||||
|
)
|
||||||
response {
|
response {
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
description("The id of the latest announcement")
|
description("The ID of the latest announcement")
|
||||||
responseType<APIResponseAnnouncementId>()
|
responseType<ApiResponseAnnouncementId>()
|
||||||
|
}
|
||||||
|
canRespond {
|
||||||
|
responseCode(HttpStatusCode.OK)
|
||||||
|
mediaTypes("application/json")
|
||||||
|
description("The IDs of the latest announcements")
|
||||||
|
responseType<Set<ApiResponseAnnouncement>>()
|
||||||
}
|
}
|
||||||
canRespond {
|
canRespond {
|
||||||
responseCode(HttpStatusCode.NotFound)
|
responseCode(HttpStatusCode.NotFound)
|
||||||
@ -196,195 +248,73 @@ private fun Route.installLatestAnnouncementIdRouteDocumentation() = installNotar
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installChannelAnnouncementsRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installAnnouncementsIdRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Announcements")
|
tags = setOf("Announcements")
|
||||||
|
|
||||||
parameters = listOf(
|
parameters = listOf(
|
||||||
Parameter(
|
Parameter(
|
||||||
name = "channel",
|
name = "id",
|
||||||
`in` = Parameter.Location.path,
|
`in` = Parameter.Location.path,
|
||||||
schema = TypeDefinition.STRING,
|
schema = TypeDefinition.INT,
|
||||||
description = "The channel to get the announcements from",
|
description = "The ID of the announcement to update",
|
||||||
required = true,
|
required = true,
|
||||||
),
|
),
|
||||||
|
authHeaderParameter,
|
||||||
)
|
)
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the announcements from a channel")
|
description("Get an announcement")
|
||||||
summary("Get announcements from channel")
|
summary("Get announcement")
|
||||||
response {
|
response {
|
||||||
|
description("The announcement")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
mediaTypes("application/json")
|
responseType<ApiResponseAnnouncement>()
|
||||||
description("The announcements in the channel")
|
|
||||||
responseType<Set<APIResponseAnnouncement>>()
|
|
||||||
}
|
}
|
||||||
}
|
canRespond {
|
||||||
}
|
responseCode(HttpStatusCode.NotFound)
|
||||||
|
description("The announcement does not exist")
|
||||||
private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotarizedRoute {
|
|
||||||
tags = setOf("Announcements")
|
|
||||||
|
|
||||||
parameters = listOf(
|
|
||||||
Parameter(
|
|
||||||
name = "id",
|
|
||||||
`in` = Parameter.Location.path,
|
|
||||||
schema = TypeDefinition.INT,
|
|
||||||
description = "The id of the announcement to archive",
|
|
||||||
required = true,
|
|
||||||
),
|
|
||||||
Parameter(
|
|
||||||
name = "archivedAt",
|
|
||||||
`in` = Parameter.Location.query,
|
|
||||||
schema = TypeDefinition.STRING,
|
|
||||||
description = "The date and time the announcement to be archived",
|
|
||||||
required = false,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
post = PostInfo.builder {
|
|
||||||
description("Archive an announcement")
|
|
||||||
summary("Archive announcement")
|
|
||||||
response {
|
|
||||||
description("When the announcement was archived")
|
|
||||||
responseCode(HttpStatusCode.OK)
|
|
||||||
responseType<Unit>()
|
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 {
|
patch = PatchInfo.builder {
|
||||||
description("Update an announcement")
|
description("Update an announcement")
|
||||||
summary("Update announcement")
|
summary("Update announcement")
|
||||||
request {
|
request {
|
||||||
requestType<APIAnnouncement>()
|
requestType<ApiAnnouncement>()
|
||||||
description("The new announcement")
|
description("The new announcement")
|
||||||
}
|
}
|
||||||
response {
|
response {
|
||||||
description("When announcement was updated")
|
description("The announcement is updated")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
|
|
||||||
delete = DeleteInfo.builder {
|
delete = DeleteInfo.builder {
|
||||||
description("Delete an announcement")
|
description("Delete an announcement")
|
||||||
summary("Delete announcement")
|
summary("Delete announcement")
|
||||||
response {
|
response {
|
||||||
description("When the announcement was deleted")
|
description("The announcement is deleted")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installAnnouncementsRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installAnnouncementsTagsRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Announcements")
|
tags = setOf("Announcements")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the announcements")
|
description("Get all announcement tags")
|
||||||
summary("Get announcements")
|
summary("Get announcement tags")
|
||||||
response {
|
response {
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
description("The announcements")
|
description("The announcement tags")
|
||||||
responseType<Set<APIResponseAnnouncement>>()
|
responseType<Set<String>>()
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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,14 +4,13 @@ import app.revanced.api.configuration.*
|
|||||||
import app.revanced.api.configuration.installCache
|
import app.revanced.api.configuration.installCache
|
||||||
import app.revanced.api.configuration.installNoCache
|
import app.revanced.api.configuration.installNoCache
|
||||||
import app.revanced.api.configuration.installNotarizedRoute
|
import app.revanced.api.configuration.installNotarizedRoute
|
||||||
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.respondOrNotFound
|
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.ApiService
|
||||||
import app.revanced.api.configuration.services.AuthService
|
import app.revanced.api.configuration.services.AuthenticationService
|
||||||
import io.bkbn.kompendium.core.metadata.*
|
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.http.*
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.auth.*
|
import io.ktor.server.auth.*
|
||||||
@ -23,7 +22,7 @@ import org.koin.ktor.ext.get as koinGet
|
|||||||
|
|
||||||
internal fun Route.apiRoute() {
|
internal fun Route.apiRoute() {
|
||||||
val apiService = koinGet<ApiService>()
|
val apiService = koinGet<ApiService>()
|
||||||
val authService = koinGet<AuthService>()
|
val authenticationService = koinGet<AuthenticationService>()
|
||||||
|
|
||||||
rateLimit(RateLimitName("strong")) {
|
rateLimit(RateLimitName("strong")) {
|
||||||
authenticate("auth-digest") {
|
authenticate("auth-digest") {
|
||||||
@ -31,7 +30,7 @@ internal fun Route.apiRoute() {
|
|||||||
installTokenRouteDocumentation()
|
installTokenRouteDocumentation()
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respond(authService.newToken())
|
call.respond(authenticationService.newToken())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -72,7 +71,7 @@ internal fun Route.apiRoute() {
|
|||||||
|
|
||||||
installPingRouteDocumentation()
|
installPingRouteDocumentation()
|
||||||
|
|
||||||
head {
|
handle {
|
||||||
call.respond(HttpStatusCode.NoContent)
|
call.respond(HttpStatusCode.NoContent)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -115,7 +114,7 @@ private fun Route.installRateLimitRouteDocumentation() = installNotarizedRoute {
|
|||||||
description("The rate limit of the backend")
|
description("The rate limit of the backend")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIRateLimit>()
|
responseType<ApiRateLimit>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -144,7 +143,7 @@ private fun Route.installTeamRouteDocumentation() = installNotarizedRoute {
|
|||||||
description("The list of team members")
|
description("The list of team members")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Set<APIMember>>()
|
responseType<Set<ApiMember>>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -165,16 +164,38 @@ private fun Route.installContributorsRouteDocumentation() = installNotarizedRout
|
|||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
|
||||||
|
val configuration = koinGet<ConfigurationRepository>()
|
||||||
|
|
||||||
tags = setOf("API")
|
tags = setOf("API")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get a new authorization token")
|
description("Get a new authorization token")
|
||||||
summary("Get 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 {
|
response {
|
||||||
description("The authorization token")
|
description("The authorization token")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<String>()
|
responseType<ApiToken>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,11 +1,12 @@
|
|||||||
package app.revanced.api.configuration.routes
|
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.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 app.revanced.api.configuration.services.ManagerService
|
||||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
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.http.*
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.plugins.ratelimit.*
|
import io.ktor.server.plugins.ratelimit.*
|
||||||
@ -20,30 +21,43 @@ internal fun Route.managerRoute() = route("manager") {
|
|||||||
|
|
||||||
rateLimit(RateLimitName("weak")) {
|
rateLimit(RateLimitName("weak")) {
|
||||||
get {
|
get {
|
||||||
call.respond(managerService.latestRelease())
|
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||||
|
|
||||||
|
call.respond(managerService.latestRelease(prerelease))
|
||||||
}
|
}
|
||||||
|
|
||||||
route("version") {
|
route("version") {
|
||||||
installManagerVersionRouteDocumentation()
|
installManagerVersionRouteDocumentation()
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respond(managerService.latestVersion())
|
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||||
|
|
||||||
|
call.respond(managerService.latestVersion(prerelease))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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 {
|
private fun Route.installManagerRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Manager")
|
tags = setOf("Manager")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the current manager release")
|
description("Get the current manager release")
|
||||||
summary("Get current manager release")
|
summary("Get current manager release")
|
||||||
|
parameters(prereleaseParameter)
|
||||||
response {
|
response {
|
||||||
description("The latest manager release")
|
description("The latest manager release")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIRelease<APIManagerAsset>>()
|
responseType<ApiRelease>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -54,11 +68,12 @@ private fun Route.installManagerVersionRouteDocumentation() = installNotarizedRo
|
|||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the current manager release version")
|
description("Get the current manager release version")
|
||||||
summary("Get current manager release version")
|
summary("Get current manager release version")
|
||||||
|
parameters(prereleaseParameter)
|
||||||
response {
|
response {
|
||||||
description("The current manager release version")
|
description("The current manager release version")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIReleaseVersion>()
|
responseType<ApiReleaseVersion>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,19 +0,0 @@
|
|||||||
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,13 +1,14 @@
|
|||||||
package app.revanced.api.configuration.routes
|
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.installCache
|
||||||
import app.revanced.api.configuration.installNotarizedRoute
|
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 app.revanced.api.configuration.services.PatchesService
|
||||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
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.http.*
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.plugins.ratelimit.*
|
import io.ktor.server.plugins.ratelimit.*
|
||||||
@ -23,14 +24,18 @@ internal fun Route.patchesRoute() = route("patches") {
|
|||||||
|
|
||||||
rateLimit(RateLimitName("weak")) {
|
rateLimit(RateLimitName("weak")) {
|
||||||
get {
|
get {
|
||||||
call.respond(patchesService.latestRelease())
|
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||||
|
|
||||||
|
call.respond(patchesService.latestRelease(prerelease))
|
||||||
}
|
}
|
||||||
|
|
||||||
route("version") {
|
route("version") {
|
||||||
installPatchesVersionRouteDocumentation()
|
installPatchesVersionRouteDocumentation()
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respond(patchesService.latestVersion())
|
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||||
|
|
||||||
|
call.respond(patchesService.latestVersion(prerelease))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -40,7 +45,9 @@ internal fun Route.patchesRoute() = route("patches") {
|
|||||||
installPatchesListRouteDocumentation()
|
installPatchesListRouteDocumentation()
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respondBytes(ContentType.Application.Json) { patchesService.list() }
|
val prerelease = call.parameters["prerelease"]?.toBoolean() ?: false
|
||||||
|
|
||||||
|
call.respondBytes(ContentType.Application.Json) { patchesService.list(prerelease) }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -52,23 +59,32 @@ internal fun Route.patchesRoute() = route("patches") {
|
|||||||
installPatchesPublicKeyRouteDocumentation()
|
installPatchesPublicKeyRouteDocumentation()
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respond(patchesService.publicKeys())
|
call.respond(patchesService.publicKey())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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 {
|
private fun Route.installPatchesRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the current patches release")
|
description("Get the current patches release")
|
||||||
summary("Get current patches release")
|
summary("Get current patches release")
|
||||||
|
parameters(prereleaseParameter)
|
||||||
response {
|
response {
|
||||||
description("The current patches release")
|
description("The current patches release")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIRelease<APIPatchesAsset>>()
|
responseType<ApiRelease>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -79,11 +95,12 @@ private fun Route.installPatchesVersionRouteDocumentation() = installNotarizedRo
|
|||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the current patches release version")
|
description("Get the current patches release version")
|
||||||
summary("Get current patches release version")
|
summary("Get current patches release version")
|
||||||
|
parameters(prereleaseParameter)
|
||||||
response {
|
response {
|
||||||
description("The current patches release version")
|
description("The current patches release version")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIReleaseVersion>()
|
responseType<ApiReleaseVersion>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -94,6 +111,7 @@ private fun Route.installPatchesListRouteDocumentation() = installNotarizedRoute
|
|||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the list of patches from the current patches release")
|
description("Get the list of patches from the current patches release")
|
||||||
summary("Get list of patches from current patches release")
|
summary("Get list of patches from current patches release")
|
||||||
|
parameters(prereleaseParameter)
|
||||||
response {
|
response {
|
||||||
description("The list of patches")
|
description("The list of patches")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
@ -107,13 +125,13 @@ private fun Route.installPatchesPublicKeyRouteDocumentation() = installNotarized
|
|||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the public keys for verifying patches and integrations assets")
|
description("Get the public keys for verifying patches assets")
|
||||||
summary("Get patches and integrations public keys")
|
summary("Get patches public keys")
|
||||||
response {
|
response {
|
||||||
description("The public keys")
|
description("The public keys")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIAssetPublicKeys>()
|
responseType<ApiAssetPublicKey>()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,35 +1,29 @@
|
|||||||
package app.revanced.api.configuration.services
|
package app.revanced.api.configuration.services
|
||||||
|
|
||||||
|
import app.revanced.api.configuration.ApiAnnouncement
|
||||||
import app.revanced.api.configuration.repository.AnnouncementRepository
|
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(
|
internal class AnnouncementService(
|
||||||
private val announcementRepository: AnnouncementRepository,
|
private val announcementRepository: AnnouncementRepository,
|
||||||
) {
|
) {
|
||||||
fun latestId(channel: String): APIResponseAnnouncementId? = announcementRepository.latestId(channel)
|
suspend fun latest(tags: Set<String>) = announcementRepository.latest(tags)
|
||||||
fun latestId(): APIResponseAnnouncementId? = announcementRepository.latestId()
|
|
||||||
|
|
||||||
fun latest(channel: String) = announcementRepository.latest(channel)
|
suspend fun latest() = announcementRepository.latest()
|
||||||
fun latest() = announcementRepository.latest()
|
|
||||||
|
|
||||||
suspend fun all(channel: String) = announcementRepository.all(channel)
|
fun latestId(tags: Set<String>) = announcementRepository.latestId(tags)
|
||||||
suspend fun all() = announcementRepository.all()
|
|
||||||
|
|
||||||
suspend fun new(new: APIAnnouncement) {
|
fun latestId() = announcementRepository.latestId()
|
||||||
announcementRepository.new(new)
|
|
||||||
}
|
suspend fun paged(cursor: Int, limit: Int, tags: Set<String>?) =
|
||||||
suspend fun archive(id: Int, archivedAt: LocalDateTime?) {
|
announcementRepository.paged(cursor, limit, tags)
|
||||||
announcementRepository.archive(id, archivedAt)
|
|
||||||
}
|
suspend fun get(id: Int) = announcementRepository.get(id)
|
||||||
suspend fun unarchive(id: Int) {
|
|
||||||
announcementRepository.unarchive(id)
|
suspend fun update(id: Int, new: ApiAnnouncement) = announcementRepository.update(id, new)
|
||||||
}
|
|
||||||
suspend fun update(id: Int, new: APIAnnouncement) {
|
suspend fun delete(id: Int) = announcementRepository.delete(id)
|
||||||
announcementRepository.update(id, new)
|
|
||||||
}
|
suspend fun new(new: ApiAnnouncement) = announcementRepository.new(new)
|
||||||
suspend fun delete(id: Int) {
|
|
||||||
announcementRepository.delete(id)
|
suspend fun tags() = announcementRepository.tags()
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -1,8 +1,9 @@
|
|||||||
package app.revanced.api.configuration.services
|
package app.revanced.api.configuration.services
|
||||||
|
|
||||||
|
import app.revanced.api.configuration.*
|
||||||
import app.revanced.api.configuration.repository.BackendRepository
|
import app.revanced.api.configuration.repository.BackendRepository
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.schema.*
|
import io.ktor.http.*
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
import kotlinx.coroutines.async
|
import kotlinx.coroutines.async
|
||||||
import kotlinx.coroutines.awaitAll
|
import kotlinx.coroutines.awaitAll
|
||||||
@ -16,12 +17,16 @@ internal class ApiService(
|
|||||||
val about = configurationRepository.about
|
val about = configurationRepository.about
|
||||||
|
|
||||||
suspend fun contributors() = withContext(Dispatchers.IO) {
|
suspend fun contributors() = withContext(Dispatchers.IO) {
|
||||||
configurationRepository.contributorsRepositoryNames.map {
|
configurationRepository.contributorsRepositoryNames.map { (repository, name) ->
|
||||||
async {
|
async {
|
||||||
APIContributable(
|
APIContributable(
|
||||||
it,
|
name,
|
||||||
backendRepository.contributors(configurationRepository.organization, it).map {
|
URLBuilder().apply {
|
||||||
APIContributor(it.name, it.avatarUrl, it.url, it.contributions)
|
takeFrom(backendRepository.website)
|
||||||
|
path(configurationRepository.organization, repository)
|
||||||
|
}.buildString(),
|
||||||
|
backendRepository.contributors(configurationRepository.organization, repository).map {
|
||||||
|
ApiContributor(it.name, it.avatarUrl, it.url, it.contributions)
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@ -29,13 +34,13 @@ internal class ApiService(
|
|||||||
}.awaitAll()
|
}.awaitAll()
|
||||||
|
|
||||||
suspend fun team() = backendRepository.members(configurationRepository.organization).map { member ->
|
suspend fun team() = backendRepository.members(configurationRepository.organization).map { member ->
|
||||||
APIMember(
|
ApiMember(
|
||||||
member.name,
|
member.name,
|
||||||
member.avatarUrl,
|
member.avatarUrl,
|
||||||
member.url,
|
member.url,
|
||||||
member.bio,
|
member.bio,
|
||||||
if (member.gpgKeys.ids.isNotEmpty()) {
|
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.
|
// 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.ids.first(),
|
||||||
member.gpgKeys.url,
|
member.gpgKeys.url,
|
||||||
@ -47,6 +52,6 @@ internal class ApiService(
|
|||||||
}
|
}
|
||||||
|
|
||||||
suspend fun rateLimit() = backendRepository.rateLimit()?.let {
|
suspend fun rateLimit() = backendRepository.rateLimit()?.let {
|
||||||
APIRateLimit(it.limit, it.remaining, it.reset)
|
ApiRateLimit(it.limit, it.remaining, it.reset)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,49 +0,0 @@
|
|||||||
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))
|
|
||||||
}
|
|
@ -0,0 +1,52 @@
|
|||||||
|
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,38 +1,37 @@
|
|||||||
package app.revanced.api.configuration.services
|
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
|
||||||
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.schema.*
|
|
||||||
|
|
||||||
internal class ManagerService(
|
internal class ManagerService(
|
||||||
private val backendRepository: BackendRepository,
|
private val backendRepository: BackendRepository,
|
||||||
private val configurationRepository: ConfigurationRepository,
|
private val configurationRepository: ConfigurationRepository,
|
||||||
) {
|
) {
|
||||||
suspend fun latestRelease(): APIRelease<APIManagerAsset> {
|
suspend fun latestRelease(prerelease: Boolean): ApiRelease {
|
||||||
val managerRelease = backendRepository.release(
|
val managerRelease = backendRepository.release(
|
||||||
configurationRepository.organization,
|
configurationRepository.organization,
|
||||||
configurationRepository.manager.repository,
|
configurationRepository.manager.repository,
|
||||||
|
prerelease,
|
||||||
)
|
)
|
||||||
|
|
||||||
val managerAsset = APIManagerAsset(
|
return ApiRelease(
|
||||||
managerRelease.assets.first(configurationRepository.manager.assetRegex).downloadUrl,
|
|
||||||
)
|
|
||||||
|
|
||||||
return APIRelease(
|
|
||||||
managerRelease.tag,
|
managerRelease.tag,
|
||||||
managerRelease.createdAt,
|
managerRelease.createdAt,
|
||||||
managerRelease.releaseNote,
|
managerRelease.releaseNote,
|
||||||
listOf(managerAsset),
|
managerRelease.assets.first(configurationRepository.manager.assetRegex).downloadUrl,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun latestVersion(): APIReleaseVersion {
|
suspend fun latestVersion(prerelease: Boolean): ApiReleaseVersion {
|
||||||
val managerRelease = backendRepository.release(
|
val managerRelease = backendRepository.release(
|
||||||
configurationRepository.organization,
|
configurationRepository.organization,
|
||||||
configurationRepository.manager.repository,
|
configurationRepository.manager.repository,
|
||||||
|
prerelease,
|
||||||
)
|
)
|
||||||
|
|
||||||
return APIReleaseVersion(managerRelease.tag)
|
return ApiReleaseVersion(managerRelease.tag)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,69 +0,0 @@
|
|||||||
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,9 +1,11 @@
|
|||||||
package app.revanced.api.configuration.services
|
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
|
||||||
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.schema.*
|
|
||||||
import app.revanced.library.serializeTo
|
import app.revanced.library.serializeTo
|
||||||
import app.revanced.patcher.patch.loadPatchesFromJar
|
import app.revanced.patcher.patch.loadPatchesFromJar
|
||||||
import com.github.benmanes.caffeine.cache.Caffeine
|
import com.github.benmanes.caffeine.cache.Caffeine
|
||||||
@ -17,50 +19,30 @@ internal class PatchesService(
|
|||||||
private val backendRepository: BackendRepository,
|
private val backendRepository: BackendRepository,
|
||||||
private val configurationRepository: ConfigurationRepository,
|
private val configurationRepository: ConfigurationRepository,
|
||||||
) {
|
) {
|
||||||
suspend fun latestRelease(): APIRelease<APIPatchesAsset> {
|
suspend fun latestRelease(prerelease: Boolean): ApiRelease {
|
||||||
val patchesRelease = backendRepository.release(
|
val patchesRelease = backendRepository.release(
|
||||||
configurationRepository.organization,
|
configurationRepository.organization,
|
||||||
configurationRepository.patches.repository,
|
configurationRepository.patches.repository,
|
||||||
|
prerelease,
|
||||||
)
|
)
|
||||||
|
|
||||||
val integrationsRelease = backendRepository.release(
|
return ApiRelease(
|
||||||
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.tag,
|
||||||
patchesRelease.createdAt,
|
patchesRelease.createdAt,
|
||||||
patchesRelease.releaseNote,
|
patchesRelease.releaseNote,
|
||||||
listOf(patchesAsset, integrationsAsset),
|
patchesRelease.assets.first(configurationRepository.patches.assetRegex).downloadUrl,
|
||||||
|
patchesRelease.assets.first(configurationRepository.patches.signatureAssetRegex).downloadUrl,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
suspend fun latestVersion(): APIReleaseVersion {
|
suspend fun latestVersion(prerelease: Boolean): ApiReleaseVersion {
|
||||||
val patchesRelease = backendRepository.release(
|
val patchesRelease = backendRepository.release(
|
||||||
configurationRepository.organization,
|
configurationRepository.organization,
|
||||||
configurationRepository.patches.repository,
|
configurationRepository.patches.repository,
|
||||||
|
prerelease,
|
||||||
)
|
)
|
||||||
|
|
||||||
return APIReleaseVersion(patchesRelease.tag)
|
return ApiReleaseVersion(patchesRelease.tag)
|
||||||
}
|
}
|
||||||
|
|
||||||
private val patchesListCache = Caffeine
|
private val patchesListCache = Caffeine
|
||||||
@ -68,10 +50,11 @@ internal class PatchesService(
|
|||||||
.maximumSize(1)
|
.maximumSize(1)
|
||||||
.build<String, ByteArray>()
|
.build<String, ByteArray>()
|
||||||
|
|
||||||
suspend fun list(): ByteArray {
|
suspend fun list(prerelease: Boolean): ByteArray {
|
||||||
val patchesRelease = backendRepository.release(
|
val patchesRelease = backendRepository.release(
|
||||||
configurationRepository.organization,
|
configurationRepository.organization,
|
||||||
configurationRepository.patches.repository,
|
configurationRepository.patches.repository,
|
||||||
|
prerelease,
|
||||||
)
|
)
|
||||||
|
|
||||||
return withContext(Dispatchers.IO) {
|
return withContext(Dispatchers.IO) {
|
||||||
@ -111,14 +94,5 @@ internal class PatchesService(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fun publicKeys(): APIAssetPublicKeys {
|
fun publicKey() = ApiAssetPublicKey(configurationRepository.patches.publicKeyFile.readText())
|
||||||
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 {
|
internal class SignatureService {
|
||||||
private val signatureCache = Caffeine
|
private val signatureCache = Caffeine
|
||||||
.newBuilder()
|
.newBuilder()
|
||||||
.maximumSize(2) // Assuming this is enough for patches and integrations.
|
.maximumSize(2) // 2 because currently only the latest release and prerelease patches are needed.
|
||||||
.build<ByteArray, Boolean>() // Hash -> Verified.
|
.build<ByteArray, Boolean>() // Hash -> Verified.
|
||||||
|
|
||||||
fun verify(
|
fun verify(
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
<configuration>
|
<configuration>
|
||||||
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||||||
<encoder>
|
<encoder>
|
||||||
<pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
<pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} %-5level %msg%n</pattern>
|
||||||
</encoder>
|
</encoder>
|
||||||
</appender>
|
</appender>
|
||||||
<root level="info">
|
<root level="\${LOG_LEVEL:-INFO}">
|
||||||
<appender-ref ref="STDOUT"/>
|
<appender-ref ref="STDOUT"/>
|
||||||
</root>
|
</root>
|
||||||
</configuration>
|
</configuration>
|
||||||
|
@ -0,0 +1,186 @@
|
|||||||
|
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