Compare commits
37 Commits
3576d13dca
...
ci/sonarqu
| Author | SHA1 | Date | |
|---|---|---|---|
| f6deeb9624 | |||
| 0ea6495d9e | |||
| 3050443aac | |||
| 987ddb54f8 | |||
| ab68fab382 | |||
| 7665975d59 | |||
| d97c06d6e1 | |||
| e2ced06a83 | |||
| d0fb6bbdfc | |||
| 9268579c5f | |||
| 0c395b2527 | |||
| 2d84a930e5 | |||
| b6a0fa1f5d | |||
| bc09593550 | |||
| 9514172b71 | |||
| de79bf547c | |||
| 0df862a6af | |||
| e497e6c8a7 | |||
| 52e06da8fc | |||
| 2e1bea4220 | |||
| d4f7fcb241 | |||
| ca704caaaf | |||
| 1c56eda64b | |||
| 199df6cd64 | |||
| c8f4e76370 | |||
| 81f10fbca4 | |||
| 01481ef2d5 | |||
| 9019ded556 | |||
| 91cd4585c0 | |||
| 9ea66c500e | |||
| 6f243b0af9 | |||
| e714980600 | |||
| 3647d25be2 | |||
| 7c13476f29 | |||
| c920e8805b | |||
| 95c4c38bd3 | |||
| cb8a458514 |
19
.gitattributes
vendored
Normal file
19
.gitattributes
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# Deterministic line endings across contributor platforms.
|
||||
|
||||
# Default: normalize to LF in the repo.
|
||||
* text=auto eol=lf
|
||||
|
||||
# The Gradle wrapper POSIX script MUST stay LF (runs on the Linux CI runner).
|
||||
gradlew text eol=lf
|
||||
|
||||
# Windows batch files must be CRLF.
|
||||
*.bat text eol=crlf
|
||||
|
||||
# Binary assets — never touch line endings.
|
||||
*.jar binary
|
||||
*.keystore binary
|
||||
*.jks binary
|
||||
*.png binary
|
||||
*.webp binary
|
||||
*.ico binary
|
||||
75
.gitea/workflows/pr-checks.yml
Normal file
75
.gitea/workflows/pr-checks.yml
Normal file
@@ -0,0 +1,75 @@
|
||||
# Gate every pull request into `main` on lint + unit tests + a debug build, so a
|
||||
# broken build can't reach the deployable branch. Debug builds are auto-signed,
|
||||
# so this gate needs no secrets. The signed *release* APK + Gitea release come
|
||||
# later (release.yml, M6). See docs/android/PLAN.md §12.
|
||||
#
|
||||
# Enforcement (one-time, in the Gitea UI):
|
||||
# Repository Settings -> Branches -> Branch Protection (rule for `main`)
|
||||
# * Enable Status Check
|
||||
# * Status check patterns: PR Checks / *
|
||||
#
|
||||
# Runner: the org's self-hosted `ubuntu-latest`. The container lacks
|
||||
# git/curl/unzip (needed by checkout + sdkmanager), so the first step installs
|
||||
# them. It also installs JDK 17 from the Ubuntu archive rather than using
|
||||
# actions/setup-java, because this runner can't resolve api.adoptium.net (that
|
||||
# download fails with EAI_AGAIN) while the Ubuntu mirrors are reachable.
|
||||
# (Faster later: switch to a prebuilt Android-SDK+JDK container image so nothing
|
||||
# installs per-run.)
|
||||
|
||||
name: PR Checks
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
concurrency:
|
||||
group: pr-checks-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
android-build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Install the tools checkout + the SDK installer need, plus JDK 17 (see the
|
||||
# header note on why we avoid actions/setup-java on this runner).
|
||||
- name: Install base tools + JDK 17
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y git curl unzip openjdk-17-jdk-headless
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64" >> "$GITHUB_ENV"
|
||||
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Android SDK
|
||||
uses: android-actions/setup-android@v3
|
||||
|
||||
# Install exactly what the build targets so it never depends on AGP's
|
||||
# build-time auto-download. `yes |` accepts any license prompts; `set
|
||||
# +o pipefail` so `yes` dying with SIGPIPE (exit 141) once sdkmanager
|
||||
# closes the pipe doesn't fail the step -- sdkmanager's own exit, last in
|
||||
# the pipeline, still gates success.
|
||||
- name: Install Android SDK packages
|
||||
run: |
|
||||
set +o pipefail
|
||||
yes | sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
|
||||
|
||||
- name: Cache Gradle
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.gradle/caches
|
||||
~/.gradle/wrapper
|
||||
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle.kts', 'gradle/libs.versions.toml', 'gradle/wrapper/gradle-wrapper.properties') }}
|
||||
restore-keys: |
|
||||
gradle-${{ runner.os }}-
|
||||
|
||||
# chmod defensively: this runner's checkout doesn't preserve the git
|
||||
# executable bit, so `./gradlew` alone fails with "Permission denied".
|
||||
# Debug-variant-only gate: unit tests, lint, and the debug APK. Scoping to
|
||||
# the debug variant (vs. the aggregate `test`/`lint`) avoids compiling and
|
||||
# linting the release variant in parallel, which halves peak memory on the
|
||||
# runner and keeps lint's report phase from GC-thrashing (see gradle.properties).
|
||||
- name: Lint, test, assemble debug
|
||||
run: |
|
||||
chmod +x ./gradlew
|
||||
./gradlew --no-daemon testDebugUnitTest lintDebug assembleDebug
|
||||
194
.gitea/workflows/release.yml
Normal file
194
.gitea/workflows/release.yml
Normal file
@@ -0,0 +1,194 @@
|
||||
# Automated release for the Runic Gateway Android app.
|
||||
#
|
||||
# Trigger: pushing a version tag `v*` (e.g. `v0.1.0`). Tag-driven on purpose — the
|
||||
# build never has to push to protected `main`; the tag *is* the release input.
|
||||
#
|
||||
# To cut a release:
|
||||
# git tag v0.1.0 && git push origin v0.1.0
|
||||
# (or create the tag from the Gitea UI). Re-build/re-release an existing tag via
|
||||
# the workflow_dispatch input below.
|
||||
#
|
||||
# versionName = the tag without its leading `v`; versionCode = major*10000 +
|
||||
# minor*100 + patch (deterministic + monotonic, PLAN.md §10). Both are injected
|
||||
# into app/build.gradle.kts for the build only — nothing is committed back to main.
|
||||
#
|
||||
# Prerequisites (Settings -> Actions -> Secrets on RunicGateway/Android-app):
|
||||
# REGISTRY_TOKEN — Gitea access token with `write:repository` (create the release)
|
||||
# ANDROID_KEYSTORE_BASE64 — base64 of the release .jks (single line)
|
||||
# ANDROID_KEYSTORE_PASSWORD — keystore password
|
||||
# ANDROID_KEY_ALIAS — key alias (e.g. runicgateway)
|
||||
# ANDROID_KEY_PASSWORD — key password (== store password for a PKCS12 keystore)
|
||||
#
|
||||
# Runner handling matches pr-checks.yml (self-hosted `ubuntu-latest`): the container
|
||||
# lacks git/curl/unzip and can't reach api.adoptium.net, so we apt-install the base
|
||||
# tools + JDK 17 (not actions/setup-java), install the exact SDK packages, and
|
||||
# `chmod +x ./gradlew` in-step (checkout drops the exec bit).
|
||||
|
||||
name: Release APK
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'Existing v* tag to (re)build and release'
|
||||
required: true
|
||||
|
||||
concurrency:
|
||||
group: release-apk-${{ github.event.inputs.tag || github.ref_name }}
|
||||
cancel-in-progress: false
|
||||
|
||||
env:
|
||||
GITEA_HOST: gitea.whitlocktech.com
|
||||
REPO: RunicGateway/Android-app
|
||||
GRADLE_MODULE: app
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
# Fail fast on a genuinely wedged run (e.g. a stalled SDK/network download on
|
||||
# the self-hosted runner) instead of hanging forever and — because concurrency
|
||||
# is `cancel-in-progress: false` — blocking every later release behind it.
|
||||
timeout-minutes: 30
|
||||
steps:
|
||||
- name: Install base tools + JDK 17
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y git curl unzip jq openjdk-17-jdk-headless
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Check out the release tag (full history for the changelog)
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.inputs.tag || github.ref_name }}
|
||||
fetch-depth: 0
|
||||
|
||||
# ── Derive version + changelog straight from the tag ─────────────────
|
||||
- name: Plan the release (version + changelog from the tag)
|
||||
id: plan
|
||||
run: |
|
||||
set -euo pipefail
|
||||
mkdir -p dist
|
||||
git fetch --tags --force >/dev/null 2>&1 || true
|
||||
|
||||
TAG="${{ github.event.inputs.tag || github.ref_name }}"
|
||||
case "$TAG" in
|
||||
v[0-9]*) : ;;
|
||||
*) echo "::error::expected a v* version tag, got '$TAG'"; exit 1 ;;
|
||||
esac
|
||||
VERSION="${TAG#v}"
|
||||
|
||||
# versionCode: deterministic + monotonic from the semver (PLAN.md §10).
|
||||
IFS=. read -r MA MI PA <<< "$VERSION"
|
||||
: "${MA:=0}"; : "${MI:=0}"; : "${PA:=0}"
|
||||
VERSION_CODE=$(( MA*10000 + MI*100 + PA ))
|
||||
|
||||
# Changelog: conventional-commit subjects since the previous v* tag.
|
||||
PREV_TAG="$(git describe --tags --match 'v*' --abbrev=0 "${TAG}^" 2>/dev/null || true)"
|
||||
if [ -n "$PREV_TAG" ]; then RANGE="${PREV_TAG}..${TAG}"; else RANGE="${TAG}"; fi
|
||||
SUBJECTS="$(git log --no-merges --format='%s' $RANGE || true)"
|
||||
|
||||
{
|
||||
echo "## Runic Gateway Android ${TAG}"
|
||||
echo
|
||||
FEATS="$(echo "$SUBJECTS" | grep -E '^feat' || true)"
|
||||
FIXES="$(echo "$SUBJECTS" | grep -E '^(fix|perf)' || true)"
|
||||
[ -n "$FEATS" ] && { echo "### Features"; echo "$FEATS" | sed 's/^/- /'; echo; }
|
||||
[ -n "$FIXES" ] && { echo "### Fixes"; echo "$FIXES" | sed 's/^/- /'; echo; }
|
||||
echo "### All changes"
|
||||
if [ -n "$PREV_TAG" ]; then echo "Since ${PREV_TAG}:"; fi
|
||||
echo "$SUBJECTS" | sed 's/^/- /'
|
||||
echo
|
||||
echo "---"
|
||||
echo "Signed APK — sideload on Android 10+ (§10). The app self-configures its shard site on first run."
|
||||
} > dist/CHANGELOG.md
|
||||
|
||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "versionCode=${VERSION_CODE}" >> "$GITHUB_OUTPUT"
|
||||
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||
echo "==> tag=${TAG} version=${VERSION} code=${VERSION_CODE} prev_tag=${PREV_TAG:-<none>}"
|
||||
|
||||
# ── SDK + signing keystore ───────────────────────────────────────────
|
||||
- name: Set up Android SDK
|
||||
uses: android-actions/setup-android@v3
|
||||
with:
|
||||
# Only put cmdline-tools on PATH. The action's default package set drags in
|
||||
# the whole emulator + the legacy `tools` package (hundreds of MB, network-
|
||||
# bound on this runner) that a headless APK build never uses. The next step
|
||||
# installs exactly the packages we need.
|
||||
packages: ''
|
||||
|
||||
- name: Install Android SDK packages
|
||||
run: |
|
||||
set +o pipefail
|
||||
yes | sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
|
||||
|
||||
- name: Decode signing keystore
|
||||
env:
|
||||
ANDROID_KEYSTORE_BASE64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [ -z "${ANDROID_KEYSTORE_BASE64:-}" ]; then
|
||||
echo "::error::ANDROID_KEYSTORE_BASE64 secret is not set — cannot build a signed release."
|
||||
exit 1
|
||||
fi
|
||||
printf '%s' "$ANDROID_KEYSTORE_BASE64" | base64 -d > "${RUNNER_TEMP}/release.jks"
|
||||
echo "ANDROID_KEYSTORE_FILE=${RUNNER_TEMP}/release.jks" >> "$GITHUB_ENV"
|
||||
|
||||
# ── Set the version, build the signed APK ────────────────────────────
|
||||
- name: Set the app version to match the tag
|
||||
run: |
|
||||
set -euo pipefail
|
||||
VERSION="${{ steps.plan.outputs.version }}"
|
||||
VERSION_CODE="${{ steps.plan.outputs.versionCode }}"
|
||||
# Replace only the version defaults (the `?: "x.y.z"` / `?: N` fallbacks).
|
||||
sed -i -E "s/(\?: )\"[0-9]+\.[0-9]+\.[0-9]+\"/\1\"${VERSION}\"/" "${GRADLE_MODULE}/build.gradle.kts"
|
||||
sed -i -E "s/(toIntOrNull\(\) \?: )[0-9]+/\1${VERSION_CODE}/" "${GRADLE_MODULE}/build.gradle.kts"
|
||||
grep -nE "versionCode = |versionName = " "${GRADLE_MODULE}/build.gradle.kts"
|
||||
|
||||
- name: Unit tests + signed release APK
|
||||
env:
|
||||
ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
|
||||
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
|
||||
ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_KEY_PASSWORD }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
chmod +x ./gradlew
|
||||
./gradlew --no-daemon :${GRADLE_MODULE}:testDebugUnitTest :${GRADLE_MODULE}:assembleRelease
|
||||
|
||||
- name: Package APK + SHA256SUMS
|
||||
run: |
|
||||
set -euo pipefail
|
||||
SRC="${GRADLE_MODULE}/build/outputs/apk/release/app-release.apk"
|
||||
test -f "$SRC" || { echo "::error::release APK not found at $SRC"; exit 1; }
|
||||
cp "$SRC" "dist/runic-gateway-${{ steps.plan.outputs.version }}.apk"
|
||||
( cd dist && sha256sum "runic-gateway-${{ steps.plan.outputs.version }}.apk" > SHA256SUMS )
|
||||
ls -l dist && cat dist/SHA256SUMS
|
||||
|
||||
# ── Create the Gitea release + upload assets (no push to main) ───────
|
||||
- name: Create Gitea release and upload assets
|
||||
env:
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
TAG="${{ steps.plan.outputs.tag }}"
|
||||
API="https://${GITEA_HOST}/api/v1/repos/${REPO}"
|
||||
BODY="$(cat dist/CHANGELOG.md)"
|
||||
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
||||
|
||||
REL_ID="$(curl -sSf -X POST "${API}/releases" \
|
||||
-H "Authorization: token ${CI_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$(jq -n --arg tag "$TAG" --arg body "$BODY" \
|
||||
'{tag_name:$tag, name:$tag, body:$body, draft:false, prerelease:false}')" \
|
||||
| jq -r '.id')"
|
||||
echo "Created release ${TAG} (id=${REL_ID})"
|
||||
|
||||
for f in "runic-gateway-${{ steps.plan.outputs.version }}.apk" SHA256SUMS; do
|
||||
curl -sSf -X POST "${API}/releases/${REL_ID}/assets?name=${f}" \
|
||||
-H "Authorization: token ${CI_TOKEN}" \
|
||||
-F "attachment=@dist/${f}" >/dev/null
|
||||
echo " uploaded ${f}"
|
||||
done
|
||||
54
.gitea/workflows/sonarqube.yml
Normal file
54
.gitea/workflows/sonarqube.yml
Normal file
@@ -0,0 +1,54 @@
|
||||
# Run SonarQube static analysis against the code that just landed on `main` and
|
||||
# report the results to the self-hosted SonarQube server for review. This is
|
||||
# intentionally NON-BLOCKING: it triggers on push to main (i.e. AFTER merge),
|
||||
# not on pull_request, so it never gates a PR. It complements pr-checks.yml
|
||||
# (which gates PRs) and release.yml (which ships the APK) — this one only feeds
|
||||
# the dashboard.
|
||||
#
|
||||
# Prerequisites (one-time, in the Gitea UI — Repo → Settings → Actions):
|
||||
# • Secret SONAR_TOKEN — a SonarQube "Analysis" token generated at
|
||||
# My Account → Security in SonarQube for the
|
||||
# runic-gateway-android-app project (or a global one).
|
||||
# • Variable SONAR_HOST_URL — the SonarQube base URL on your LAN, e.g.
|
||||
# http://192.168.0.56:9000
|
||||
# (kept as a variable, not committed, so the internal address stays out of git.)
|
||||
#
|
||||
# The runner (self-hosted `ubuntu-latest`, same as the other workflows) must be
|
||||
# able to reach SONAR_HOST_URL on your network. Nothing here waits on the
|
||||
# SonarQube Quality Gate, so a failing gate does not fail this job — check the
|
||||
# dashboard when you want to.
|
||||
#
|
||||
# Scope: this analyses the Kotlin source directly (the Sonar scanner reads
|
||||
# sonar-project.properties). It does NOT run a Gradle build, so no Android SDK /
|
||||
# JDK install is needed — the Kotlin analyzer is source-based. See the "Optional
|
||||
# enrichment" note in sonar-project.properties for wiring in Android Lint /
|
||||
# coverage reports later.
|
||||
|
||||
name: SonarQube
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
# Allow re-running the analysis on demand from the Actions tab.
|
||||
workflow_dispatch: {}
|
||||
|
||||
concurrency:
|
||||
group: sonarqube-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
analysis:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out (full history for accurate new-code + blame)
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
# SonarQube uses git history to attribute issues to authors and to
|
||||
# compute "new code". A shallow clone degrades both.
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Run SonarQube scan
|
||||
uses: sonarsource/sonarqube-scan-action@v4
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}
|
||||
30
.gitignore
vendored
Normal file
30
.gitignore
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# Android / Gradle / IDE ignores.
|
||||
|
||||
# Built output
|
||||
/build/
|
||||
/app/build/
|
||||
*.apk
|
||||
*.aab
|
||||
*.ap_
|
||||
*.dex
|
||||
|
||||
# Gradle
|
||||
.gradle/
|
||||
local.properties
|
||||
|
||||
# Keystores / signing material — never commit (release keystore is a CI secret, PLAN.md §12)
|
||||
*.jks
|
||||
*.keystore
|
||||
keystore.properties
|
||||
|
||||
# Android Studio / IntelliJ
|
||||
.idea/
|
||||
*.iml
|
||||
.DS_Store
|
||||
captures/
|
||||
.externalNativeBuild/
|
||||
.cxx/
|
||||
|
||||
# Kotlin
|
||||
.kotlin/
|
||||
133
CODE_OF_CONDUCT.md
Normal file
133
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,133 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||
identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall
|
||||
community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official email address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
**whitlocktech@gmail.com**.
|
||||
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of
|
||||
actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or permanent
|
||||
ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.1, available at
|
||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
||||
[https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
73
CONTRIBUTING.md
Normal file
73
CONTRIBUTING.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Contributing to Runic Gateway — Documentation
|
||||
|
||||
Thanks for your interest in contributing! This repo is the **central
|
||||
documentation** for the Runic Gateway platform — design docs, the protocol spec,
|
||||
integration guides, and research, extracted from the code repos so they live in
|
||||
one place.
|
||||
|
||||
By participating you agree to abide by our
|
||||
[Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
- **Report an error** (something wrong, outdated, or unclear) or **request new
|
||||
documentation** through the
|
||||
[issue tracker](https://gitea.whitlocktech.com/RunicGateway/docs/issues)
|
||||
(issue templates are provided).
|
||||
- **Fix or expand the docs** by opening a pull request (see below).
|
||||
- **Never** report a security vulnerability in a public issue — see
|
||||
[SECURITY.md](SECURITY.md).
|
||||
|
||||
## Working on the docs
|
||||
|
||||
Everything here is Markdown — no build step. Just edit the relevant file and
|
||||
preview it in any Markdown viewer (or on Gitea).
|
||||
|
||||
```
|
||||
website/ docs for the shard website (Node/Express + MariaDB + React/Vite)
|
||||
link/ docs for the ServUO bridge (C# plugin + Rust sidecar)
|
||||
```
|
||||
|
||||
Guidelines:
|
||||
|
||||
- Keep documents in the folder matching their subsystem (`website/` or `link/`).
|
||||
- These docs are the **authoritative** copy of the protocol and design; when you
|
||||
change behavior in a code repo, update the matching doc here in the same or a
|
||||
follow-up PR so the spec and implementation stay in sync.
|
||||
- Use relative links between docs, and check that any links you add resolve.
|
||||
- Prefer clear prose and tables over screenshots where possible.
|
||||
|
||||
## Branch & PR workflow
|
||||
|
||||
1. Branch from `main` with a descriptive name (`docs/…`, `fix/…`, `chore/…`).
|
||||
2. Keep changes focused; small PRs are easier to review.
|
||||
3. Push and open a pull request against `main`. Fill out the PR template,
|
||||
including the **AI-assisted contributions** disclosure.
|
||||
4. A maintainer will review; address feedback with follow-up commits.
|
||||
|
||||
### Commit messages
|
||||
|
||||
We use [Conventional Commits](https://www.conventionalcommits.org/) —
|
||||
`type(scope): summary` (e.g. `docs(link): clarify town-crier caps`).
|
||||
|
||||
## AI-assisted contributions (disclosure required)
|
||||
|
||||
This project is developed openly with AI assistance, and we ask the same
|
||||
transparency of everyone. **If you used an AI tool** (Claude, Copilot, ChatGPT,
|
||||
Cursor, etc.) to help produce a contribution, you must disclose it:
|
||||
|
||||
- Tick the AI-usage box in the pull-request template and name the tool(s).
|
||||
- Mark AI-authored commits with a trailer, e.g.
|
||||
`Co-Authored-By: Claude <noreply@anthropic.com>` or `Assisted-By: <tool>`.
|
||||
- You remain responsible for every line you submit: review it, understand it,
|
||||
and make sure it is accurate and that you have the right to contribute it.
|
||||
|
||||
Disclosed AI assistance is welcome. Undisclosed AI-generated contributions are
|
||||
not, and may be closed.
|
||||
|
||||
## License
|
||||
|
||||
Runic Gateway is licensed under the **GNU General Public License v3.0 or later**
|
||||
(see [LICENSE.md](LICENSE.md)). By submitting a contribution you agree that it is
|
||||
licensed under the same terms (inbound = outbound) and that you have the right to
|
||||
contribute it.
|
||||
31
CONTRIBUTORS.md
Normal file
31
CONTRIBUTORS.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Contributors
|
||||
|
||||
Runic Gateway is built and maintained by the people and tools listed here.
|
||||
Thank you to everyone who has contributed.
|
||||
|
||||
## Maintainers
|
||||
|
||||
- **whitlocktech** <whitlocktech@gmail.com> — project lead and maintainer
|
||||
|
||||
## Contributors
|
||||
|
||||
<!--
|
||||
Add yourself here when your contribution is merged — alphabetical by name or
|
||||
handle. One line each:
|
||||
|
||||
- **Name or handle** (optional link) — what you contributed
|
||||
-->
|
||||
|
||||
- _Your name could be here — see [CONTRIBUTING.md](CONTRIBUTING.md)._
|
||||
|
||||
## AI-assisted development
|
||||
|
||||
Parts of Runic Gateway were developed with the assistance of AI coding tools,
|
||||
including **Claude** (Anthropic) via Claude Code. AI-assisted commits are
|
||||
attributed in their commit trailers (e.g. `Co-Authored-By: Claude ...`).
|
||||
|
||||
In keeping with this project's transparency policy, **all contributors must
|
||||
disclose their use of AI tools** on any contribution — see the
|
||||
"AI-assisted contributions" section of [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
Disclosed AI assistance is welcome; undisclosed AI-generated contributions are
|
||||
not.
|
||||
232
LICENSE
232
LICENSE
@@ -1,232 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
||||
|
||||
Android-app
|
||||
Copyright (C) 2026 RunicGateway
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
||||
|
||||
Android-app Copyright (C) 2026 RunicGateway
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
674
LICENSE.md
Normal file
674
LICENSE.md
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
70
README.md
70
README.md
@@ -1,2 +1,70 @@
|
||||
# Android-app
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
|
||||
# Runic Gateway — Android app
|
||||
|
||||
A native Android client for a Runic Gateway shard's **public site + player self-service**. It is
|
||||
**purely an API client of the website backend** — it never talks to the `link/` sidecar or the game
|
||||
shard directly, and it ships none of the shard/sidecar wiring. It surfaces the same content and
|
||||
player features as the website's browser client, **minus every administrative/management console**.
|
||||
|
||||
The authoritative design contract is [`docs/android/PLAN.md`](https://gitea.whitlocktech.com/RunicGateway/docs)
|
||||
in the `RunicGateway/docs` repo. The authoritative API reference is the committed OpenAPI spec at
|
||||
`website/server/swagger/swagger-output.json`.
|
||||
|
||||
## Status
|
||||
|
||||
**M0 — repo scaffold.** Gradle + Compose + Hilt skeleton with CI (lint + unit test + debug build).
|
||||
The functional Kotlin pass (M1–M4) and the design pass (M5) follow — see the plan's milestones (§9).
|
||||
|
||||
## Stack
|
||||
|
||||
| Concern | Choice |
|
||||
|---|---|
|
||||
| Language / UI | Kotlin + Jetpack Compose (Material 3) |
|
||||
| Navigation | Navigation-Compose, single-activity |
|
||||
| HTTP | Retrofit + OkHttp, `kotlinx.serialization` |
|
||||
| Async | Coroutines + Flow |
|
||||
| DI | Hilt |
|
||||
| Prefs / base URL | Jetpack DataStore |
|
||||
| Tokens at rest | EncryptedSharedPreferences |
|
||||
| Images | Coil |
|
||||
| Min SDK | Android 10 (API 29) |
|
||||
| Target / compile SDK | 35 |
|
||||
|
||||
Dependency and plugin versions are pinned in [`gradle/libs.versions.toml`](gradle/libs.versions.toml).
|
||||
|
||||
## Build
|
||||
|
||||
Requires **JDK 17** and the Android SDK (`ANDROID_HOME` / `local.properties`).
|
||||
|
||||
```bash
|
||||
./gradlew assembleDebug # build a debug APK -> app/build/outputs/apk/debug/
|
||||
./gradlew test # JVM unit tests
|
||||
./gradlew lint # Android lint
|
||||
./gradlew installDebug # install on a connected device/emulator
|
||||
```
|
||||
|
||||
The app self-configures its server URL on first run (PLAN.md §3), so a single build works against
|
||||
any shard's website — there is no compiled-in API host.
|
||||
|
||||
## CI
|
||||
|
||||
`.gitea/workflows/pr-checks.yml` gates PRs into `main` with `./gradlew lint test assembleDebug` on the
|
||||
org's self-hosted runner (JDK 17 + Android SDK). Debug builds are auto-signed, so the gate needs no
|
||||
secrets. **This pipeline is verified green end-to-end on the runner** (M0). A signed **release** APK
|
||||
attached to a Gitea release comes at M6.
|
||||
|
||||
The workflow carries a few runner-specific accommodations (each explained in comments in the file),
|
||||
because this self-hosted runner differs from a stock GitHub runner:
|
||||
|
||||
- **JDK 17 is installed via `apt`** (not `actions/setup-java`) — the runner can't resolve
|
||||
`api.adoptium.net`, while the Ubuntu mirrors are reachable.
|
||||
- **SDK packages are installed explicitly** via `sdkmanager`, with `set +o pipefail` so `yes` dying of
|
||||
`SIGPIPE` doesn't fail the step.
|
||||
- **`gradlew` is `chmod +x`'d in the run step** — the runner's checkout does not preserve the git
|
||||
executable bit, so `./gradlew` alone fails with "Permission denied".
|
||||
|
||||
## Contributing
|
||||
|
||||
See [`CONTRIBUTING.md`](CONTRIBUTING.md). **AI-assisted contributions must be disclosed** (org
|
||||
policy): tick the PR box naming the tool and add a `Co-Authored-By` trailer to AI-authored commits.
|
||||
Licensed **GPL-3.0-or-later**.
|
||||
|
||||
50
SECURITY.md
Normal file
50
SECURITY.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Security Policy
|
||||
|
||||
Thank you for helping keep Runic Gateway and its users safe.
|
||||
|
||||
## Reporting a vulnerability
|
||||
|
||||
**Please do not report security vulnerabilities through public issues, pull
|
||||
requests, or the wiki.** A public report tips off attackers before a fix is
|
||||
available.
|
||||
|
||||
Instead, report privately by email to:
|
||||
|
||||
**whitlocktech@gmail.com**
|
||||
|
||||
Please include as much of the following as you can:
|
||||
|
||||
- The repository and component affected.
|
||||
- The type of issue (e.g. authentication bypass, injection, secret exposure,
|
||||
remote code execution, denial of service).
|
||||
- Step-by-step instructions to reproduce, and a proof-of-concept if you have one.
|
||||
- The impact — what an attacker could do with it.
|
||||
- Any suggested remediation.
|
||||
|
||||
You will receive an acknowledgement of your report, typically within a few days.
|
||||
We will keep you informed as we investigate and work toward a fix, and we are
|
||||
happy to credit you in the release notes once the issue is resolved (let us know
|
||||
if you would prefer to remain anonymous).
|
||||
|
||||
## Scope
|
||||
|
||||
Runic Gateway is a self-hosted platform made up of several components:
|
||||
|
||||
| Component | Repo | Network exposure |
|
||||
|---|---|---|
|
||||
| Website (site + admin + API) | `RunicGateway/website` | Internet-facing (behind a reverse proxy) |
|
||||
| uo-link sidecar | `RunicGateway/link` | The only network-facing part of the game bridge |
|
||||
| ServUO plugin | `RunicGateway/servuo-plugins` | Loopback only — dials the sidecar on `127.0.0.1` |
|
||||
| Documentation | `RunicGateway/docs` | Content only |
|
||||
|
||||
Because instances are self-hosted, the security of any given deployment also
|
||||
depends on how it is configured and operated — strong secrets (`JWT_SECRET`,
|
||||
`SECRET_ENC_KEY`, database and admin passwords), a correctly configured reverse
|
||||
proxy and `TRUST_PROXY`, and keeping the shard itself unreachable from the
|
||||
internet (only the sidecar should be exposed). See each repo's README for the
|
||||
security model.
|
||||
|
||||
## Supported versions
|
||||
|
||||
This project is developed continuously and does not maintain long-term release
|
||||
branches. Security fixes land on `main`; please run a recent build.
|
||||
172
app/build.gradle.kts
Normal file
172
app/build.gradle.kts
Normal file
@@ -0,0 +1,172 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
import java.io.FileInputStream
|
||||
import java.util.Properties
|
||||
|
||||
plugins {
|
||||
alias(libs.plugins.android.application)
|
||||
alias(libs.plugins.kotlin.android)
|
||||
alias(libs.plugins.kotlin.compose)
|
||||
alias(libs.plugins.kotlin.serialization)
|
||||
alias(libs.plugins.ksp)
|
||||
alias(libs.plugins.hilt)
|
||||
}
|
||||
|
||||
// Release signing material (PLAN.md §12) is never committed. It is read from, in
|
||||
// order of precedence: a local gitignored `keystore.properties` at the repo root,
|
||||
// then environment variables (how CI injects the decoded keystore + secrets). When
|
||||
// none is present, the release build is simply left unsigned — `assembleDebug` and
|
||||
// the PR gate are unaffected, so contributors without the keystore can still build.
|
||||
val keystorePropsFile = rootProject.file("keystore.properties")
|
||||
val keystoreProps = Properties().apply {
|
||||
if (keystorePropsFile.exists()) FileInputStream(keystorePropsFile).use { load(it) }
|
||||
}
|
||||
fun signingValue(propKey: String, envKey: String): String? =
|
||||
keystoreProps.getProperty(propKey) ?: System.getenv(envKey)
|
||||
|
||||
val ksStoreFilePath = signingValue("storeFile", "ANDROID_KEYSTORE_FILE")
|
||||
val ksStorePassword = signingValue("storePassword", "ANDROID_KEYSTORE_PASSWORD")
|
||||
val ksKeyAlias = signingValue("keyAlias", "ANDROID_KEY_ALIAS")
|
||||
val ksKeyPassword = signingValue("keyPassword", "ANDROID_KEY_PASSWORD")
|
||||
val hasReleaseSigning = ksStoreFilePath != null && ksStorePassword != null &&
|
||||
ksKeyAlias != null && ksKeyPassword != null
|
||||
|
||||
android {
|
||||
namespace = "com.runicgateway.app"
|
||||
compileSdk = 35
|
||||
|
||||
defaultConfig {
|
||||
// Target application id per docs/android/PLAN.md §13 (pending runicgateway.app domain).
|
||||
applicationId = "com.runicgateway.app"
|
||||
minSdk = 29
|
||||
targetSdk = 35
|
||||
// These committed defaults are the version source of truth (PLAN.md §10).
|
||||
// release.yml's conventional-commit engine bumps versionName here and commits
|
||||
// it on release; versionCode is derived from it (major*10000+minor*100+patch)
|
||||
// so it stays monotonic. Both remain overridable via -P for local/manual builds.
|
||||
versionCode = (project.findProperty("versionCode") as String?)?.toIntOrNull() ?: 1
|
||||
versionName = (project.findProperty("versionName") as String?)?.takeIf { it.isNotBlank() } ?: "0.1.0"
|
||||
|
||||
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
||||
|
||||
// Android App Links host (docs/android/APP_LINKS.md). autoVerify needs a
|
||||
// *literal* host at build time, so a single multi-tenant APK cannot verify
|
||||
// open-ended shard domains: App Links are a build-time opt-in. Left empty for
|
||||
// the generic build (custom scheme only); a white-label/first-party build
|
||||
// bakes one host with `-PappLinkHost=play.myshard.com`.
|
||||
// • BuildConfig.APP_LINK_HOST — SsoAuthManager reads it to pick the redirect.
|
||||
// • manifestPlaceholder appLinkHost — substituted into the intent-filter host;
|
||||
// empty falls back to the reserved `.invalid` sentinel so the autoVerify
|
||||
// filter is inert (matches no real link, never verifies).
|
||||
val appLinkHost = (project.findProperty("appLinkHost") as String?)?.trim().orEmpty()
|
||||
buildConfigField("String", "APP_LINK_HOST", "\"$appLinkHost\"")
|
||||
manifestPlaceholders["appLinkHost"] = appLinkHost.ifBlank { "runic-gateway.invalid" }
|
||||
}
|
||||
|
||||
signingConfigs {
|
||||
if (hasReleaseSigning) {
|
||||
create("release") {
|
||||
storeFile = file(ksStoreFilePath!!)
|
||||
storePassword = ksStorePassword
|
||||
keyAlias = ksKeyAlias
|
||||
keyPassword = ksKeyPassword
|
||||
// Sign with both v1 (JAR) and v2 (APK) schemes for broad compatibility.
|
||||
enableV1Signing = true
|
||||
enableV2Signing = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
buildTypes {
|
||||
release {
|
||||
// R8 full-mode minify + resource shrink (§7: no offline cache, so a lean
|
||||
// release APK). Keep rules live in proguard-rules.pro.
|
||||
isMinifyEnabled = true
|
||||
isShrinkResources = true
|
||||
proguardFiles(
|
||||
getDefaultProguardFile("proguard-android-optimize.txt"),
|
||||
"proguard-rules.pro",
|
||||
)
|
||||
// Signed only when the keystore material is present (local or CI); an
|
||||
// unsigned APK is produced otherwise. The direct-APK release (§10) runs
|
||||
// through release.yml, which supplies the keystore from a Gitea secret.
|
||||
if (hasReleaseSigning) {
|
||||
signingConfig = signingConfigs.getByName("release")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_17
|
||||
targetCompatibility = JavaVersion.VERSION_17
|
||||
}
|
||||
|
||||
kotlinOptions {
|
||||
jvmTarget = "17"
|
||||
}
|
||||
|
||||
buildFeatures {
|
||||
compose = true
|
||||
buildConfig = true
|
||||
}
|
||||
|
||||
packaging {
|
||||
resources {
|
||||
excludes += "/META-INF/{AL2.0,LGPL2.1}"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// Core / lifecycle / activity
|
||||
implementation(libs.androidx.core.ktx)
|
||||
implementation(libs.androidx.lifecycle.runtime.ktx)
|
||||
implementation(libs.androidx.lifecycle.runtime.compose)
|
||||
implementation(libs.androidx.lifecycle.viewmodel.compose)
|
||||
implementation(libs.androidx.activity.compose)
|
||||
|
||||
// Compose (BOM-managed versions)
|
||||
implementation(platform(libs.androidx.compose.bom))
|
||||
implementation(libs.androidx.compose.ui)
|
||||
implementation(libs.androidx.compose.ui.graphics)
|
||||
implementation(libs.androidx.compose.ui.tooling.preview)
|
||||
implementation(libs.androidx.compose.material3)
|
||||
implementation(libs.androidx.compose.material.icons.core)
|
||||
implementation(libs.androidx.navigation.compose)
|
||||
debugImplementation(libs.androidx.compose.ui.tooling)
|
||||
debugImplementation(libs.androidx.compose.ui.test.manifest)
|
||||
|
||||
// DI
|
||||
implementation(libs.hilt.android)
|
||||
ksp(libs.hilt.compiler)
|
||||
implementation(libs.androidx.hilt.navigation.compose)
|
||||
|
||||
// Networking (wired for M1+; declared now so the stack resolves)
|
||||
implementation(libs.retrofit)
|
||||
implementation(platform(libs.okhttp.bom))
|
||||
implementation(libs.okhttp)
|
||||
implementation(libs.okhttp.logging.interceptor)
|
||||
implementation(libs.okhttp.sse)
|
||||
implementation(libs.kotlinx.serialization.json)
|
||||
implementation(libs.retrofit.kotlinx.serialization.converter)
|
||||
|
||||
// Storage
|
||||
implementation(libs.androidx.datastore.preferences)
|
||||
implementation(libs.androidx.security.crypto)
|
||||
|
||||
// Web hand-off (Chrome Custom Tabs) for register / invite / reset / SSO (§4.2)
|
||||
implementation(libs.androidx.browser)
|
||||
|
||||
// Images
|
||||
implementation(libs.coil.compose)
|
||||
|
||||
// Unit tests
|
||||
testImplementation(libs.junit)
|
||||
testImplementation(libs.kotlinx.coroutines.test)
|
||||
|
||||
// Instrumented tests
|
||||
androidTestImplementation(libs.androidx.test.ext.junit)
|
||||
androidTestImplementation(libs.androidx.espresso.core)
|
||||
androidTestImplementation(platform(libs.androidx.compose.bom))
|
||||
androidTestImplementation(libs.androidx.compose.ui.test.junit4)
|
||||
}
|
||||
93
app/licenses/Cinzel-OFL.txt
Normal file
93
app/licenses/Cinzel-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2020 The Cinzel Project Authors (https://github.com/NDISCOVER/Cinzel)
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
59
app/proguard-rules.pro
vendored
Normal file
59
app/proguard-rules.pro
vendored
Normal file
@@ -0,0 +1,59 @@
|
||||
# Runic Gateway Android app — ProGuard/R8 rules (release minify + resource shrink, M6).
|
||||
#
|
||||
# The dependency stack ships its own consumer rules that R8 applies automatically:
|
||||
# Retrofit 2.11, OkHttp 4.12, kotlinx.serialization 1.7 (core), Hilt/Dagger, Coil 2.7.
|
||||
# The rules below are defensive belt-and-suspenders for the areas full-mode R8 is
|
||||
# most likely to over-strip in this app: the kotlinx.serialization generated
|
||||
# serializers and our own @Serializable wire DTOs.
|
||||
|
||||
# ── kotlinx.serialization (canonical keep rules) ────────────────────────────
|
||||
-keepattributes *Annotation*, InnerClasses
|
||||
-dontnote kotlinx.serialization.**
|
||||
|
||||
# Keep the Companion of @Serializable classes so `.serializer()` resolves.
|
||||
-if @kotlinx.serialization.Serializable class **
|
||||
-keepclassmembers class <1> {
|
||||
static <1>$Companion Companion;
|
||||
}
|
||||
-if @kotlinx.serialization.Serializable class ** {
|
||||
static **$Companion Companion;
|
||||
}
|
||||
-keepclassmembers class <2>$Companion {
|
||||
kotlinx.serialization.KSerializer serializer(...);
|
||||
}
|
||||
# Keep `INSTANCE.serializer()` of @Serializable objects.
|
||||
-if @kotlinx.serialization.Serializable class ** {
|
||||
public static ** INSTANCE;
|
||||
}
|
||||
-keepclassmembers class <1> {
|
||||
public static <1> INSTANCE;
|
||||
kotlinx.serialization.KSerializer serializer(...);
|
||||
}
|
||||
# Keep the synthesized $$serializer classes and their descriptor field.
|
||||
-keepclassmembers class **$$serializer {
|
||||
*** descriptor;
|
||||
}
|
||||
|
||||
# ── Our wire DTOs ───────────────────────────────────────────────────────────
|
||||
# All request/response models decoded by kotlinx.serialization. Keeping them
|
||||
# (and their generated serializers) guarantees additive backend fields and
|
||||
# @SerialName mappings survive minification. DTOs are small, so keeping them
|
||||
# whole is cheap insurance against a full-mode strip.
|
||||
-keep @kotlinx.serialization.Serializable class com.runicgateway.app.** { *; }
|
||||
-keepclassmembers class com.runicgateway.app.data.api.dto.** { *; }
|
||||
|
||||
# ── Retrofit service interfaces ─────────────────────────────────────────────
|
||||
# Retrofit reads method + parameter annotations reflectively; keep our API
|
||||
# interfaces' generic signatures so return types (suspend .../Call<T>) resolve.
|
||||
-keep,allowobfuscation interface com.runicgateway.app.data.api.*Api
|
||||
-keepattributes Signature, Exceptions
|
||||
|
||||
# Kotlin metadata is needed for reflection over Kotlin types (serialization/Retrofit).
|
||||
-keep class kotlin.Metadata { *; }
|
||||
|
||||
# ── Tink / EncryptedSharedPreferences (androidx.security-crypto) ─────────────
|
||||
# Tink references Error Prone compile-only annotations that are absent at runtime;
|
||||
# they are safe to ignore (they carry no runtime behaviour). Suppresses the R8
|
||||
# "Missing class com.google.errorprone.annotations.*" errors.
|
||||
-dontwarn com.google.errorprone.annotations.**
|
||||
|
||||
79
app/src/main/AndroidManifest.xml
Normal file
79
app/src/main/AndroidManifest.xml
Normal file
@@ -0,0 +1,79 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
|
||||
<!-- The app is purely an HTTPS API client of a shard's website backend. -->
|
||||
<uses-permission android:name="android.permission.INTERNET" />
|
||||
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
|
||||
|
||||
<!-- Opt-in push notifications (M7): the runtime notification permission (API 33+)
|
||||
and a foreground service that holds the persistent ntfy connection open — the
|
||||
embedded UnifiedPush distributor, so no separate app is needed (PLAN.md §11). -->
|
||||
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
|
||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
|
||||
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
|
||||
|
||||
<application
|
||||
android:name=".RunicGatewayApp"
|
||||
android:allowBackup="true"
|
||||
android:dataExtractionRules="@xml/data_extraction_rules"
|
||||
android:fullBackupContent="@xml/backup_rules"
|
||||
android:icon="@mipmap/ic_launcher"
|
||||
android:label="@string/app_name"
|
||||
android:roundIcon="@mipmap/ic_launcher_round"
|
||||
android:supportsRtl="true"
|
||||
android:theme="@style/Theme.RunicGateway">
|
||||
|
||||
<!-- singleTop so the SSO Custom Tab returning via the deep link reuses the
|
||||
running task (onNewIntent) instead of stacking a second activity. -->
|
||||
<activity
|
||||
android:name=".MainActivity"
|
||||
android:exported="true"
|
||||
android:launchMode="singleTop"
|
||||
android:theme="@style/Theme.RunicGateway">
|
||||
<intent-filter>
|
||||
<action android:name="android.intent.action.MAIN" />
|
||||
<category android:name="android.intent.category.LAUNCHER" />
|
||||
</intent-filter>
|
||||
|
||||
<!-- Native SSO callback (M9, PLAN.md §4.2). The bridge deep-links the
|
||||
one-time authorization code back to this fixed, app-owned custom
|
||||
scheme; it must match SsoAuthManager.REDIRECT_URI and the backend's
|
||||
MOBILE_AUTH_REDIRECT_URIS allowlist exactly. This is the permanent
|
||||
fallback on every build (docs/android/APP_LINKS.md). -->
|
||||
<intent-filter>
|
||||
<action android:name="android.intent.action.VIEW" />
|
||||
<category android:name="android.intent.category.DEFAULT" />
|
||||
<category android:name="android.intent.category.BROWSABLE" />
|
||||
<data
|
||||
android:scheme="runicgateway"
|
||||
android:host="auth"
|
||||
android:path="/callback" />
|
||||
</intent-filter>
|
||||
|
||||
<!-- App Links hardening (docs/android/APP_LINKS.md): a verified https
|
||||
callback that only the domain's real owner can claim. autoVerify
|
||||
needs a literal host, so ${appLinkHost} is baked at build time
|
||||
(build.gradle.kts). The generic build leaves it as the reserved
|
||||
runic-gateway.invalid sentinel — the filter then matches no real
|
||||
link and never verifies. A white-label build sets -PappLinkHost. -->
|
||||
<intent-filter android:autoVerify="true">
|
||||
<action android:name="android.intent.action.VIEW" />
|
||||
<category android:name="android.intent.category.DEFAULT" />
|
||||
<category android:name="android.intent.category.BROWSABLE" />
|
||||
<data
|
||||
android:scheme="https"
|
||||
android:host="${appLinkHost}"
|
||||
android:path="/mobile/callback" />
|
||||
</intent-filter>
|
||||
</activity>
|
||||
|
||||
<!-- The embedded distributor's persistent ntfy connection (M7, PLAN.md §11).
|
||||
dataSync foreground type; not exported — started only by PushManager. -->
|
||||
<service
|
||||
android:name=".core.push.PushService"
|
||||
android:exported="false"
|
||||
android:foregroundServiceType="dataSync" />
|
||||
</application>
|
||||
|
||||
</manifest>
|
||||
BIN
app/src/main/ic_launcher-playstore.png
Normal file
BIN
app/src/main/ic_launcher-playstore.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
128
app/src/main/java/com/runicgateway/app/MainActivity.kt
Normal file
128
app/src/main/java/com/runicgateway/app/MainActivity.kt
Normal file
@@ -0,0 +1,128 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app
|
||||
|
||||
import android.content.Intent
|
||||
import android.graphics.Color
|
||||
import android.net.Uri
|
||||
import android.os.Bundle
|
||||
import androidx.activity.ComponentActivity
|
||||
import androidx.activity.SystemBarStyle
|
||||
import androidx.activity.compose.setContent
|
||||
import androidx.activity.enableEdgeToEdge
|
||||
import androidx.lifecycle.lifecycleScope
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Surface
|
||||
import androidx.compose.runtime.CompositionLocalProvider
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.compose.ui.Modifier
|
||||
import com.runicgateway.app.core.auth.sso.SsoAuthManager
|
||||
import com.runicgateway.app.core.push.PushNotifier
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.ui.AppViewModel
|
||||
import com.runicgateway.app.ui.AppViewModel.AppState
|
||||
import com.runicgateway.app.ui.LocalAssetResolver
|
||||
import com.runicgateway.app.ui.RunicApp
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.connect.ConnectScreen
|
||||
import com.runicgateway.app.ui.theme.RunicGatewayTheme
|
||||
import com.runicgateway.app.ui.theme.parseBrandColor
|
||||
import dagger.hilt.android.AndroidEntryPoint
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Single-activity host (PLAN.md §2). Gates on [AppViewModel]: the first-run
|
||||
* connect screen until a shard site is configured (§3), then the main app.
|
||||
* The Material theme is seeded from the per-shard brand accent, and asset-path
|
||||
* resolution is provided to the whole tree.
|
||||
*/
|
||||
@AndroidEntryPoint
|
||||
class MainActivity : ComponentActivity() {
|
||||
|
||||
// Native SSO bridge — handles the runicgateway://auth/callback deep link (M9,
|
||||
// §4.2). Field-injected because the callback can arrive independent of any
|
||||
// ViewModel; a successful exchange flips the SessionManager the whole app
|
||||
// observes, and the login screen consumes SsoAuthManager.outcome.
|
||||
@Inject
|
||||
lateinit var ssoAuthManager: SsoAuthManager
|
||||
|
||||
// The stream a tapped push notification wants to open (§11, M7 Part 2 item 7).
|
||||
// Set from the launching intent and from onNewIntent (the activity is singleTop),
|
||||
// consumed once by RunicApp which navigates to the stream's screen.
|
||||
private var pendingStream by mutableStateOf<String?>(null)
|
||||
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
pendingStream = intent?.getStringExtra(PushNotifier.EXTRA_STREAM)
|
||||
handleSsoCallback(intent)
|
||||
// Dark-only app (M5): force light system-bar icons over the transparent bars so
|
||||
// they stay legible on the deep blue-black surfaces regardless of system theme.
|
||||
val barStyle = SystemBarStyle.dark(Color.TRANSPARENT)
|
||||
enableEdgeToEdge(statusBarStyle = barStyle, navigationBarStyle = barStyle)
|
||||
setContent {
|
||||
val appViewModel: AppViewModel = hiltViewModel()
|
||||
val state by appViewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
val accent = (state as? AppState.Ready)?.brand?.let { parseBrandColor(it.accent) }
|
||||
|
||||
RunicGatewayTheme(accent = accent) {
|
||||
CompositionLocalProvider(LocalAssetResolver provides appViewModel::resolveAsset) {
|
||||
Surface(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
color = MaterialTheme.colorScheme.background,
|
||||
) {
|
||||
when (val s = state) {
|
||||
AppState.Loading -> LoadingView()
|
||||
AppState.NeedsConnection ->
|
||||
ConnectScreen(onConnected = appViewModel::onConnected)
|
||||
is AppState.Ready ->
|
||||
RunicApp(
|
||||
brand = s.brand,
|
||||
onChangeServer = appViewModel::changeServer,
|
||||
deepLinkStream = pendingStream,
|
||||
onDeepLinkConsumed = { pendingStream = null },
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A notification tap or an SSO callback arriving while the activity is already
|
||||
* running (singleTop) — the common case, since the Custom Tab overlays the live
|
||||
* app during sign-in.
|
||||
*/
|
||||
override fun onNewIntent(intent: Intent) {
|
||||
super.onNewIntent(intent)
|
||||
setIntent(intent)
|
||||
intent.getStringExtra(PushNotifier.EXTRA_STREAM)?.let { pendingStream = it }
|
||||
handleSsoCallback(intent)
|
||||
}
|
||||
|
||||
/**
|
||||
* Route an SSO callback VIEW intent into the bridge (M9, §4.2): either the
|
||||
* custom-scheme `runicgateway://auth/callback` (always) or the verified https
|
||||
* App Link `https://<paired-host>/mobile/callback` (opt-in hardening —
|
||||
* docs/android/APP_LINKS.md). Both feed the *same* exchange; the result surfaces
|
||||
* on `SsoAuthManager.outcome` (success signs the session in; failure shows on the
|
||||
* login screen). Non-callback intents are ignored.
|
||||
*/
|
||||
private fun handleSsoCallback(intent: Intent?) {
|
||||
val data: Uri = intent?.takeIf { it.action == Intent.ACTION_VIEW }?.data ?: return
|
||||
val isCallback = ssoAuthManager.matchesCallback(data.scheme, data.host, data.path) ||
|
||||
ssoAuthManager.matchesAppLinkCallback(data.scheme, data.host, data.path)
|
||||
if (!isCallback) return
|
||||
val state = data.getQueryParameter("state")
|
||||
val code = data.getQueryParameter("code")
|
||||
val error = data.getQueryParameter("error")
|
||||
lifecycleScope.launch { ssoAuthManager.complete(state = state, code = code, error = error) }
|
||||
}
|
||||
}
|
||||
15
app/src/main/java/com/runicgateway/app/RunicGatewayApp.kt
Normal file
15
app/src/main/java/com/runicgateway/app/RunicGatewayApp.kt
Normal file
@@ -0,0 +1,15 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
* Runic Gateway — native Android client of a shard's website API.
|
||||
*/
|
||||
package com.runicgateway.app
|
||||
|
||||
import android.app.Application
|
||||
import dagger.hilt.android.HiltAndroidApp
|
||||
|
||||
/**
|
||||
* Application entry point. Annotated for Hilt so the DI graph is available
|
||||
* to activities, view models, and (from M1) repositories / API services.
|
||||
*/
|
||||
@HiltAndroidApp
|
||||
class RunicGatewayApp : Application()
|
||||
14
app/src/main/java/com/runicgateway/app/core/AppConfig.kt
Normal file
14
app/src/main/java/com/runicgateway/app/core/AppConfig.kt
Normal file
@@ -0,0 +1,14 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core
|
||||
|
||||
/**
|
||||
* Build-derived flags, injected rather than read from `BuildConfig` directly so
|
||||
* the logic that consumes them (URL validation, etc.) stays plain and unit-testable.
|
||||
*/
|
||||
data class AppConfig(
|
||||
/** Allow plain HTTP base URLs. Debug-only (local dev); release requires HTTPS (§3). */
|
||||
val allowInsecureHttp: Boolean,
|
||||
val versionName: String,
|
||||
)
|
||||
@@ -0,0 +1,73 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth
|
||||
|
||||
import android.content.Context
|
||||
import android.content.SharedPreferences
|
||||
import androidx.security.crypto.EncryptedSharedPreferences
|
||||
import androidx.security.crypto.MasterKey
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* [TokenStore] backed by Jetpack Security's [EncryptedSharedPreferences]
|
||||
* (Tink/AES-256-GCM), so the token pair is encrypted at rest (PLAN.md §2, §4.3).
|
||||
* The base URL stays in plain DataStore ([com.runicgateway.app.core.prefs.ServerPreferences]);
|
||||
* only tokens live here.
|
||||
*
|
||||
* The prefs handle is created lazily so a first-launch device (no session yet)
|
||||
* pays the keystore cost only once a user actually signs in.
|
||||
*/
|
||||
@Singleton
|
||||
class EncryptedTokenStore @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
) : TokenStore {
|
||||
|
||||
private val prefs: SharedPreferences by lazy {
|
||||
val masterKey = MasterKey.Builder(context)
|
||||
.setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
|
||||
.build()
|
||||
EncryptedSharedPreferences.create(
|
||||
context,
|
||||
PREFS_NAME,
|
||||
masterKey,
|
||||
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
|
||||
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM,
|
||||
)
|
||||
}
|
||||
|
||||
override fun load(): StoredSession? {
|
||||
val access = prefs.getString(KEY_ACCESS, null) ?: return null
|
||||
val refresh = prefs.getString(KEY_REFRESH, null) ?: return null
|
||||
val username = prefs.getString(KEY_USERNAME, null) ?: return null
|
||||
val role = prefs.getString(KEY_ROLE, null) ?: return null
|
||||
val id = prefs.getLong(KEY_USER_ID, -1L)
|
||||
if (id < 0) return null
|
||||
return StoredSession(access, refresh, id, username, role)
|
||||
}
|
||||
|
||||
override fun save(session: StoredSession) {
|
||||
prefs.edit()
|
||||
.putString(KEY_ACCESS, session.accessToken)
|
||||
.putString(KEY_REFRESH, session.refreshToken)
|
||||
.putLong(KEY_USER_ID, session.userId)
|
||||
.putString(KEY_USERNAME, session.username)
|
||||
.putString(KEY_ROLE, session.role)
|
||||
.apply()
|
||||
}
|
||||
|
||||
override fun clear() {
|
||||
prefs.edit().clear().apply()
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val PREFS_NAME = "runic_session"
|
||||
const val KEY_ACCESS = "access_token"
|
||||
const val KEY_REFRESH = "refresh_token"
|
||||
const val KEY_USER_ID = "user_id"
|
||||
const val KEY_USERNAME = "username"
|
||||
const val KEY_ROLE = "role"
|
||||
}
|
||||
}
|
||||
60
app/src/main/java/com/runicgateway/app/core/auth/Session.kt
Normal file
60
app/src/main/java/com/runicgateway/app/core/auth/Session.kt
Normal file
@@ -0,0 +1,60 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth
|
||||
|
||||
import com.runicgateway.app.data.api.dto.SafeUserDto
|
||||
|
||||
/**
|
||||
* The signed-in identity the app carries (PLAN.md §4.3, §5). Role is *advisory*
|
||||
* for menu rendering only — the backend re-checks every gated call, so the app
|
||||
* treats a 403 as authoritative and never assumes access from this value.
|
||||
*/
|
||||
data class SessionUser(
|
||||
val id: Long,
|
||||
val username: String,
|
||||
val role: Role,
|
||||
) {
|
||||
val isPlayer: Boolean get() = role == Role.PLAYER
|
||||
}
|
||||
|
||||
/**
|
||||
* The account roles the backend issues. The three staff roles are gated by
|
||||
* capability, not rank (PLAN.md §5); [UNKNOWN] absorbs any future role so an
|
||||
* additive backend change never crashes the menu.
|
||||
*/
|
||||
enum class Role(val wire: String) {
|
||||
PLAYER("player"),
|
||||
MODERATOR("moderator"),
|
||||
EDITOR("editor"),
|
||||
ADMIN("admin"),
|
||||
UNKNOWN("");
|
||||
|
||||
val isStaff: Boolean get() = this == MODERATOR || this == EDITOR || this == ADMIN
|
||||
|
||||
companion object {
|
||||
fun fromWire(value: String?): Role =
|
||||
entries.firstOrNull { it.wire.equals(value, ignoreCase = true) } ?: UNKNOWN
|
||||
}
|
||||
}
|
||||
|
||||
/** The two auth states the UI observes. */
|
||||
sealed interface Session {
|
||||
data object SignedOut : Session
|
||||
data class SignedIn(val user: SessionUser) : Session
|
||||
}
|
||||
|
||||
internal fun SafeUserDto.toSessionUser(): SessionUser =
|
||||
SessionUser(id = id, username = username, role = Role.fromWire(role))
|
||||
|
||||
internal fun SafeUserDto.toStored(accessToken: String, refreshToken: String): StoredSession =
|
||||
StoredSession(
|
||||
accessToken = accessToken,
|
||||
refreshToken = refreshToken,
|
||||
userId = id,
|
||||
username = username,
|
||||
role = role,
|
||||
)
|
||||
|
||||
internal fun StoredSession.toSessionUser(): SessionUser =
|
||||
SessionUser(id = userId, username = username, role = Role.fromWire(role))
|
||||
@@ -0,0 +1,99 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth
|
||||
|
||||
import com.runicgateway.app.data.api.dto.SafeUserDto
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import java.util.concurrent.atomic.AtomicReference
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The single source of truth for the current session (PLAN.md §4.3). It holds the
|
||||
* in-memory token pair the network layer reads on every call, mirrors the
|
||||
* signed-in identity into an observable [state] the UI + menu react to, and keeps
|
||||
* the encrypted [TokenStore] in sync.
|
||||
*
|
||||
* Threading: [state] and the token holders are read from the UI thread and
|
||||
* written from both coroutines (login/logout) and the OkHttp
|
||||
* [com.runicgateway.app.core.net.TokenAuthenticator] dispatcher thread (silent
|
||||
* refresh), so tokens live in [AtomicReference]s and the mutators are
|
||||
* `@Synchronized` to keep the token pair and [state] consistent with each other.
|
||||
*/
|
||||
@Singleton
|
||||
class SessionManager @Inject constructor(
|
||||
private val store: TokenStore,
|
||||
) {
|
||||
private val accessRef = AtomicReference<String?>(null)
|
||||
private val refreshRef = AtomicReference<String?>(null)
|
||||
|
||||
private val _state: MutableStateFlow<Session>
|
||||
val state: StateFlow<Session>
|
||||
|
||||
init {
|
||||
val restored = store.load()
|
||||
if (restored != null) {
|
||||
accessRef.set(restored.accessToken)
|
||||
refreshRef.set(restored.refreshToken)
|
||||
_state = MutableStateFlow(Session.SignedIn(restored.toSessionUser()))
|
||||
} else {
|
||||
_state = MutableStateFlow(Session.SignedOut)
|
||||
}
|
||||
state = _state.asStateFlow()
|
||||
}
|
||||
|
||||
/** The bearer for the current request, or null when signed out. */
|
||||
fun currentAccessToken(): String? = accessRef.get()
|
||||
|
||||
/** The refresh token the authenticator rotates, or null when signed out. */
|
||||
fun currentRefreshToken(): String? = refreshRef.get()
|
||||
|
||||
val isSignedIn: Boolean get() = _state.value is Session.SignedIn
|
||||
|
||||
/** Establish a session from a successful login (§4.1). */
|
||||
@Synchronized
|
||||
fun onSignedIn(accessToken: String, refreshToken: String, user: SafeUserDto) {
|
||||
accessRef.set(accessToken)
|
||||
refreshRef.set(refreshToken)
|
||||
store.save(user.toStored(accessToken, refreshToken))
|
||||
_state.value = Session.SignedIn(user.toSessionUser())
|
||||
}
|
||||
|
||||
/**
|
||||
* Store a rotated token pair after a silent refresh (§4.3). Keeps the current
|
||||
* user; if somehow signed out already, it is a no-op (the refresh raced a
|
||||
* logout and must not resurrect the session).
|
||||
*/
|
||||
@Synchronized
|
||||
fun onRefreshed(accessToken: String, refreshToken: String, user: SafeUserDto) {
|
||||
if (_state.value !is Session.SignedIn) return
|
||||
accessRef.set(accessToken)
|
||||
refreshRef.set(refreshToken)
|
||||
store.save(user.toStored(accessToken, refreshToken))
|
||||
// Refresh may carry an updated role — reflect it so the menu stays honest.
|
||||
_state.value = Session.SignedIn(user.toSessionUser())
|
||||
}
|
||||
|
||||
/** Refresh the cached identity from a `/auth/me` re-validation (§4.3). */
|
||||
@Synchronized
|
||||
fun onUserRefreshed(user: SafeUserDto) {
|
||||
val current = _state.value
|
||||
if (current !is Session.SignedIn) return
|
||||
val access = accessRef.get() ?: return
|
||||
val refresh = refreshRef.get() ?: return
|
||||
store.save(user.toStored(access, refresh))
|
||||
_state.value = Session.SignedIn(user.toSessionUser())
|
||||
}
|
||||
|
||||
/** Tear the session down — user logout, dead refresh, or a server switch (§3). */
|
||||
@Synchronized
|
||||
fun onSignedOut() {
|
||||
accessRef.set(null)
|
||||
refreshRef.set(null)
|
||||
store.clear()
|
||||
_state.value = Session.SignedOut
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth
|
||||
|
||||
/**
|
||||
* The at-rest home for a signed-in session (PLAN.md §4.3): the access + refresh
|
||||
* tokens plus the cached safe-user. Tokens are sensitive, so the production
|
||||
* implementation stores them in EncryptedSharedPreferences — never plain
|
||||
* DataStore or logs. Kept behind an interface so [SessionManager] is unit-testable
|
||||
* against an in-memory fake.
|
||||
*/
|
||||
interface TokenStore {
|
||||
/** The persisted session restored on launch, or null when signed out. */
|
||||
fun load(): StoredSession?
|
||||
|
||||
/** Persist (overwrite) the current session atomically. */
|
||||
fun save(session: StoredSession)
|
||||
|
||||
/** Wipe every stored token — sign-out and the Settings → Server hard reset (§3). */
|
||||
fun clear()
|
||||
}
|
||||
|
||||
/** A persisted session: the token pair and the non-sensitive user it belongs to. */
|
||||
data class StoredSession(
|
||||
val accessToken: String,
|
||||
val refreshToken: String,
|
||||
val userId: Long,
|
||||
val username: String,
|
||||
val role: String,
|
||||
)
|
||||
50
app/src/main/java/com/runicgateway/app/core/auth/sso/Pkce.kt
Normal file
50
app/src/main/java/com/runicgateway/app/core/auth/sso/Pkce.kt
Normal file
@@ -0,0 +1,50 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
import java.security.MessageDigest
|
||||
import java.security.SecureRandom
|
||||
import java.util.Base64
|
||||
|
||||
/**
|
||||
* PKCE + CSRF-state primitives for the Mobile SSO Authorization Bridge — "Layer B"
|
||||
* of the two PKCE layers (app ↔ website; PLAN.md §4.2, BACKEND_DESIGN "Two PKCE
|
||||
* layers"). The app proves at `/exchange` that it holds the verifier for the
|
||||
* challenge it registered at `/start`, so an intercepted callback code is useless
|
||||
* to anyone but this app.
|
||||
*
|
||||
* Pure JVM (no Android framework types) so it unit-tests on the plain test runner.
|
||||
* The encoding mirrors the backend exactly (RFC 7636 S256): the challenge is
|
||||
* `base64url(SHA-256(verifier))` with no padding, matching Node's
|
||||
* `crypto.createHash('sha256').update(verifier).digest('base64url')`.
|
||||
*/
|
||||
object Pkce {
|
||||
|
||||
private val random = SecureRandom()
|
||||
|
||||
// RFC 4648 §5 URL-safe base64 without padding — the base64url the backend uses.
|
||||
private val encoder = Base64.getUrlEncoder().withoutPadding()
|
||||
|
||||
/**
|
||||
* A fresh high-entropy `code_verifier`: 32 random bytes → 43 base64url chars,
|
||||
* comfortably inside RFC 7636's 43–128 range and identical in form to the
|
||||
* verifier the website generates for its own IdP layer.
|
||||
*/
|
||||
fun newVerifier(): String = randomToken()
|
||||
|
||||
/** A fresh opaque CSRF `state` (same entropy/shape as a verifier). */
|
||||
fun newState(): String = randomToken()
|
||||
|
||||
/** `code_challenge` for [verifier] using the S256 method. */
|
||||
fun challengeOf(verifier: String): String {
|
||||
val digest = MessageDigest.getInstance("SHA-256").digest(verifier.toByteArray(Charsets.US_ASCII))
|
||||
return encoder.encodeToString(digest)
|
||||
}
|
||||
|
||||
private fun randomToken(): String {
|
||||
val bytes = ByteArray(32)
|
||||
random.nextBytes(bytes)
|
||||
return encoder.encodeToString(bytes)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,238 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
import com.runicgateway.app.BuildConfig
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
|
||||
import kotlinx.coroutines.CancellationException
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import java.io.IOException
|
||||
import java.util.concurrent.atomic.AtomicReference
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Orchestrates the native "Sign in with Google/Discord" flow — the app half of the
|
||||
* Mobile SSO Authorization Bridge (PLAN.md §4.2, BACKEND_DESIGN "Mobile SSO
|
||||
* Authorization Bridge"). It never adds a parallel auth path: a successful exchange
|
||||
* drives the *same* [SessionManager.onSignedIn] the password login uses, so the
|
||||
* menu, push registration, and re-validation all react identically.
|
||||
*
|
||||
* The flow:
|
||||
* 1. [buildStartUrl] mints PKCE (Layer B) + a CSRF `state`, stashes them, and
|
||||
* returns the `/auth/mobile/sso/start` URL the caller opens in a Custom Tab.
|
||||
* 2. The website bounces through the IdP and deep-links back to
|
||||
* [REDIRECT_URI] with `?code&state` (success) or `?error&state` (failure).
|
||||
* 3. [complete] verifies `state`, exchanges the `code` with the stashed verifier,
|
||||
* and signs the user in — publishing the result on [outcome]. `MainActivity`
|
||||
* parses the callback `Uri` (the Android edge) and hands the raw params here,
|
||||
* so this class stays free of framework types and unit-tests on the JVM.
|
||||
*
|
||||
* The pending `{state, verifier}` lives only in memory: if the process is killed
|
||||
* while the Custom Tab is foreground it is lost and the exchange **fails closed**
|
||||
* (the user simply retries) — never a security downgrade.
|
||||
*
|
||||
* Threading: [buildStartUrl] runs on the UI thread; [complete] runs on the
|
||||
* activity's coroutine scope after a deep link. The pending holder is an
|
||||
* [AtomicReference] and [outcome] a [StateFlow], so a ViewModel/activity recreation
|
||||
* while the Custom Tab is open cannot drop a result.
|
||||
*/
|
||||
@Singleton
|
||||
class SsoAuthManager @Inject constructor(
|
||||
private val ssoApi: SsoApi,
|
||||
private val sessionManager: SessionManager,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
) {
|
||||
|
||||
/** Why an SSO attempt ended, for a friendly inline message on the login screen. */
|
||||
enum class Failure {
|
||||
/** The user cancelled or the IdP/website refused (e.g. no linked account). */
|
||||
DENIED,
|
||||
|
||||
/** The callback `state` didn't match — CSRF guard, or the pending flow was lost. */
|
||||
STATE_MISMATCH,
|
||||
|
||||
/** The one-time code was unknown / expired / already used, or PKCE failed. */
|
||||
EXPIRED_CODE,
|
||||
|
||||
/** Offline / DNS / TLS / timeout during the exchange. */
|
||||
NETWORK,
|
||||
|
||||
/** Any other server failure, or a missing base URL / malformed callback. */
|
||||
SERVER,
|
||||
}
|
||||
|
||||
/** The observable result of the most recent flow; the login screen consumes it. */
|
||||
sealed interface Outcome {
|
||||
data object Idle : Outcome
|
||||
data object Success : Outcome
|
||||
data class Failed(val reason: Failure) : Outcome
|
||||
}
|
||||
|
||||
private data class Pending(val state: String, val verifier: String)
|
||||
|
||||
private val pending = AtomicReference<Pending?>(null)
|
||||
|
||||
/**
|
||||
* The host this build baked an App Link intent-filter for (`BuildConfig.APP_LINK_HOST`,
|
||||
* empty on the generic multi-tenant build — see docs/android/APP_LINKS.md).
|
||||
* `internal var` only so unit tests can exercise the App Link path without a build
|
||||
* flavor; production never reassigns it.
|
||||
*/
|
||||
internal var appLinkHost: String = BuildConfig.APP_LINK_HOST
|
||||
|
||||
private val _outcome = MutableStateFlow<Outcome>(Outcome.Idle)
|
||||
val outcome: StateFlow<Outcome> = _outcome.asStateFlow()
|
||||
|
||||
/** Ack a delivered [outcome] so it isn't re-handled after a recomposition. */
|
||||
fun consumeOutcome() {
|
||||
_outcome.value = Outcome.Idle
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the `/auth/mobile/sso/start` URL for [providerId] and stash the pending
|
||||
* PKCE verifier + CSRF state. Returns null when no shard site is configured yet
|
||||
* (the caller then keeps the website hand-off fallback). Also resets [outcome]
|
||||
* to [Outcome.Idle] so a stale prior result can't fire against the new attempt.
|
||||
*/
|
||||
fun buildStartUrl(providerId: String): String? {
|
||||
val base = baseUrlHolder.current ?: return null
|
||||
val verifier = Pkce.newVerifier()
|
||||
val challenge = Pkce.challengeOf(verifier)
|
||||
val state = Pkce.newState()
|
||||
pending.set(Pending(state = state, verifier = verifier))
|
||||
_outcome.value = Outcome.Idle
|
||||
return base.newBuilder()
|
||||
.addPathSegments("api/v1/auth/mobile/sso/start")
|
||||
.addQueryParameter("provider", providerId)
|
||||
.addQueryParameter("code_challenge", challenge)
|
||||
.addQueryParameter("state", state)
|
||||
.addQueryParameter("redirect_uri", redirectUriFor(base.host))
|
||||
.build()
|
||||
.toString()
|
||||
}
|
||||
|
||||
/**
|
||||
* The `redirect_uri` to request for a shard on [pairedHost]: the verified https
|
||||
* App Link callback **iff** this build baked an App Link host that matches the
|
||||
* paired host (a white-label/first-party build for exactly this shard — which is
|
||||
* also responsible for enabling `mobile_app_links_enabled` server-side); otherwise
|
||||
* the fixed custom-scheme callback, which every build/shard always supports.
|
||||
*/
|
||||
private fun redirectUriFor(pairedHost: String): String =
|
||||
if (appLinkHost.isNotBlank() && appLinkHost.equals(pairedHost, ignoreCase = true)) {
|
||||
"https://$pairedHost$APP_LINK_CALLBACK_PATH"
|
||||
} else {
|
||||
REDIRECT_URI
|
||||
}
|
||||
|
||||
/** True if a deep link's scheme/host/path are our fixed custom-scheme SSO callback. */
|
||||
fun matchesCallback(scheme: String?, host: String?, path: String?): Boolean =
|
||||
scheme == CALLBACK_SCHEME && host == CALLBACK_HOST && path == CALLBACK_PATH
|
||||
|
||||
/**
|
||||
* True if a deep link is a verified https App Link callback for the shard we are
|
||||
* **currently paired to**. The `host == pairedHost` check is defense-in-depth:
|
||||
* `autoVerify` already means only a real, opted-in shard domain can route here,
|
||||
* but the app still refuses an https callback whose host isn't the paired shard.
|
||||
* Returns false before a shard is configured (no paired host to trust).
|
||||
*/
|
||||
fun matchesAppLinkCallback(scheme: String?, host: String?, path: String?): Boolean {
|
||||
val pairedHost = baseUrlHolder.current?.host ?: return false
|
||||
return scheme == "https" && path == APP_LINK_CALLBACK_PATH &&
|
||||
host != null && host.equals(pairedHost, ignoreCase = true)
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle the parsed callback params from a returned [REDIRECT_URI] deep link:
|
||||
* verify `state`, map an `error`, else exchange the `code` and sign in.
|
||||
* Publishes the result on [outcome]. Idempotent-safe: the pending is cleared on
|
||||
* entry, so a duplicate delivery of the same callback finds no pending and fails
|
||||
* as [Failure.STATE_MISMATCH] rather than double-exchanging (the backend also
|
||||
* single-uses the code).
|
||||
*/
|
||||
suspend fun complete(state: String?, code: String?, error: String?) {
|
||||
val stashed = pending.getAndSet(null)
|
||||
|
||||
// CSRF: the callback must echo the exact state we generated at /start.
|
||||
if (stashed == null || state.isNullOrEmpty() || state != stashed.state) {
|
||||
_outcome.value = Outcome.Failed(Failure.STATE_MISMATCH)
|
||||
return
|
||||
}
|
||||
|
||||
// A website/IdP-side failure comes back as ?error=… (never with a code).
|
||||
if (!error.isNullOrEmpty()) {
|
||||
_outcome.value = Outcome.Failed(mapError(error))
|
||||
return
|
||||
}
|
||||
|
||||
if (code.isNullOrBlank()) {
|
||||
_outcome.value = Outcome.Failed(Failure.SERVER)
|
||||
return
|
||||
}
|
||||
|
||||
val response = try {
|
||||
ssoApi.exchange(MobileSsoExchangeRequest(code = code, codeVerifier = stashed.verifier))
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: IOException) {
|
||||
_outcome.value = Outcome.Failed(Failure.NETWORK)
|
||||
return
|
||||
} catch (_: Exception) {
|
||||
_outcome.value = Outcome.Failed(Failure.SERVER)
|
||||
return
|
||||
}
|
||||
|
||||
if (response.isSuccessful) {
|
||||
val body = response.body()
|
||||
if (body == null) {
|
||||
_outcome.value = Outcome.Failed(Failure.SERVER)
|
||||
return
|
||||
}
|
||||
sessionManager.onSignedIn(body.accessToken, body.refreshToken, body.user)
|
||||
_outcome.value = Outcome.Success
|
||||
return
|
||||
}
|
||||
|
||||
_outcome.value = Outcome.Failed(if (response.code() == 401) Failure.EXPIRED_CODE else Failure.SERVER)
|
||||
}
|
||||
|
||||
// The bridge's start + callback error codes → user-facing failure reasons.
|
||||
// Start (mobileSso.controller): invalid_provider | provider_unavailable | server_error.
|
||||
// Callback (sso.controller): not_linked | disabled | session_expired | error,
|
||||
// plus a forwarded IdP access_denied.
|
||||
private fun mapError(error: String): Failure = when (error) {
|
||||
// Link-only policy refused, or the account is inactive, or the user declined.
|
||||
"not_linked", "disabled", "access_denied" -> Failure.DENIED
|
||||
// The bridge session aged out mid-flow — start over.
|
||||
"session_expired" -> Failure.EXPIRED_CODE
|
||||
// invalid_provider / provider_unavailable / server_error / error / anything else.
|
||||
else -> Failure.SERVER
|
||||
}
|
||||
|
||||
companion object {
|
||||
const val CALLBACK_SCHEME = "runicgateway"
|
||||
const val CALLBACK_HOST = "auth"
|
||||
const val CALLBACK_PATH = "/callback"
|
||||
|
||||
/**
|
||||
* The one fixed, application-owned callback the bridge redirects to. Must
|
||||
* match the `MOBILE_AUTH_REDIRECT_URIS` allowlist entry on the backend and
|
||||
* the intent-filter in `AndroidManifest.xml` exactly (PLAN.md §4.2).
|
||||
*/
|
||||
const val REDIRECT_URI = "$CALLBACK_SCHEME://$CALLBACK_HOST$CALLBACK_PATH"
|
||||
|
||||
/**
|
||||
* Path of the verified https App Link callback (`https://<shard-host>/mobile/callback`).
|
||||
* Must match the app's `autoVerify` intent-filter in `AndroidManifest.xml` and the
|
||||
* backend's self-origin allowlist entry (docs/android/APP_LINKS.md §3.2/§4.2).
|
||||
*/
|
||||
const val APP_LINK_CALLBACK_PATH = "/mobile/callback"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import okhttp3.Interceptor
|
||||
import okhttp3.Response
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Attaches the current bearer access token to outbound calls (PLAN.md §4.1).
|
||||
* Public endpoints simply carry a token the backend ignores; the credential
|
||||
* endpoints (login/refresh) tag themselves [Http.NO_SESSION_HEADER] and are left
|
||||
* bare so a credential `401` is never mistaken for an expired session. A request
|
||||
* that already set its own Authorization (the authenticator's retry) is untouched.
|
||||
*/
|
||||
@Singleton
|
||||
class AuthInterceptor @Inject constructor(
|
||||
private val sessionManager: SessionManager,
|
||||
) : Interceptor {
|
||||
|
||||
override fun intercept(chain: Interceptor.Chain): Response {
|
||||
val request = chain.request()
|
||||
if (request.header(Http.NO_SESSION_HEADER) != null) {
|
||||
return chain.proceed(request)
|
||||
}
|
||||
if (request.header(Http.AUTHORIZATION) != null) {
|
||||
return chain.proceed(request)
|
||||
}
|
||||
val token = sessionManager.currentAccessToken()
|
||||
?: return chain.proceed(request)
|
||||
val authed = request.newBuilder()
|
||||
.header(Http.AUTHORIZATION, Http.bearer(token))
|
||||
.build()
|
||||
return chain.proceed(authed)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import okhttp3.HttpUrl
|
||||
import java.util.concurrent.atomic.AtomicReference
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Holds the currently-selected shard website base URL (PLAN.md §3). The API host
|
||||
* is not compiled in: it is chosen on first run, may be changed later under
|
||||
* Settings → Server, and every outbound API request is retargeted onto it by
|
||||
* [HostSelectionInterceptor].
|
||||
*
|
||||
* Threading: the value is read on every network call and written from the
|
||||
* connect/settings flows, so it lives in an [AtomicReference].
|
||||
*/
|
||||
@Singleton
|
||||
class BaseUrlHolder @Inject constructor() {
|
||||
private val ref = AtomicReference<HttpUrl?>(null)
|
||||
|
||||
/** The configured base, or null before first-run connect completes. */
|
||||
val current: HttpUrl? get() = ref.get()
|
||||
|
||||
fun set(url: HttpUrl?) = ref.set(url)
|
||||
|
||||
companion object {
|
||||
/**
|
||||
* Sentinel host used as Retrofit's compile-time `baseUrl`. Relative
|
||||
* endpoint paths resolve against it; [HostSelectionInterceptor] rewrites
|
||||
* exactly these requests onto [current]. Absolute-URL probe requests use
|
||||
* a real host and are left untouched. `.invalid` is reserved (RFC 6761)
|
||||
* so it can never accidentally resolve on a network.
|
||||
*/
|
||||
const val PLACEHOLDER_HOST = "runic-gateway.invalid"
|
||||
const val PLACEHOLDER_BASE_URL = "https://$PLACEHOLDER_HOST/"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import okhttp3.HttpUrl
|
||||
import okhttp3.Interceptor
|
||||
import okhttp3.Response
|
||||
import java.io.IOException
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Retargets each relative API request onto the runtime-selected base URL
|
||||
* (PLAN.md §3). Retrofit is built with a sentinel base host
|
||||
* ([BaseUrlHolder.PLACEHOLDER_HOST]); this interceptor swaps the scheme/host/port
|
||||
* for the configured shard site and prefixes any base path the user included
|
||||
* (`https://host/base`). Absolute-URL requests (the connect probe via `@Url`)
|
||||
* carry a real host and pass through untouched.
|
||||
*/
|
||||
@Singleton
|
||||
class HostSelectionInterceptor @Inject constructor(
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
) : Interceptor {
|
||||
|
||||
override fun intercept(chain: Interceptor.Chain): Response {
|
||||
val request = chain.request()
|
||||
if (request.url.host != BaseUrlHolder.PLACEHOLDER_HOST) {
|
||||
return chain.proceed(request)
|
||||
}
|
||||
|
||||
val base = baseUrlHolder.current
|
||||
?: throw IOException("No shard website is configured yet.")
|
||||
|
||||
val rewritten = rewriteOntoBase(base, request.url)
|
||||
return chain.proceed(request.newBuilder().url(rewritten).build())
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the sentinel-hosted [requestUrl] against [base] the way a browser
|
||||
* resolves a relative link. [base] is guaranteed to end in "/"
|
||||
* (ServerUrl.normalize), so `https://host/base/` + `api/v1/x` yields
|
||||
* `https://host/base/api/v1/x` — the base path prefix is preserved and no double
|
||||
* slash appears. Extracted as a pure function for unit testing.
|
||||
*/
|
||||
fun rewriteOntoBase(base: HttpUrl, requestUrl: HttpUrl): HttpUrl {
|
||||
val relative = buildString {
|
||||
append(requestUrl.encodedPath.removePrefix("/"))
|
||||
requestUrl.encodedQuery?.let { append('?').append(it) }
|
||||
}
|
||||
return base.resolve(relative) ?: base
|
||||
}
|
||||
19
app/src/main/java/com/runicgateway/app/core/net/Http.kt
Normal file
19
app/src/main/java/com/runicgateway/app/core/net/Http.kt
Normal file
@@ -0,0 +1,19 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
/** Shared HTTP constants for the auth layer (PLAN.md §4). */
|
||||
object Http {
|
||||
/**
|
||||
* Marks the credential endpoints (login, refresh) that must run *without* a
|
||||
* bearer and must never trigger the refresh-on-401 [TokenAuthenticator].
|
||||
* [AuthInterceptor] sees it and skips attaching a token; the authenticator
|
||||
* sees it on the failed request and declines to refresh. It is a harmless
|
||||
* unknown header to the backend.
|
||||
*/
|
||||
const val NO_SESSION_HEADER = "X-Runic-No-Session"
|
||||
const val AUTHORIZATION = "Authorization"
|
||||
|
||||
fun bearer(token: String): String = "Bearer $token"
|
||||
}
|
||||
78
app/src/main/java/com/runicgateway/app/core/net/ServerUrl.kt
Normal file
78
app/src/main/java/com/runicgateway/app/core/net/ServerUrl.kt
Normal file
@@ -0,0 +1,78 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import okhttp3.HttpUrl
|
||||
import okhttp3.HttpUrl.Companion.toHttpUrlOrNull
|
||||
|
||||
/**
|
||||
* Parses and normalizes the base URL a user types on the first-run "Connect to
|
||||
* your shard's website" screen (PLAN.md §3). Pure, dependency-light logic so it
|
||||
* is exercised directly in JVM unit tests.
|
||||
*
|
||||
* Rules:
|
||||
* - accept `https://host[/base]`; a bare `host[/base]` gets an implicit scheme
|
||||
* (`https` normally, so users needn't type it);
|
||||
* - trim surrounding whitespace;
|
||||
* - require HTTPS unless [allowInsecureHttp] (release builds forbid HTTP; debug
|
||||
* allows it for local dev against `127.0.0.1:3000`);
|
||||
* - drop any query/fragment and guarantee a trailing slash on the path so the
|
||||
* stored value composes cleanly with relative endpoint paths.
|
||||
*/
|
||||
object ServerUrl {
|
||||
|
||||
sealed interface Result {
|
||||
data class Valid(val url: HttpUrl) : Result
|
||||
data class Invalid(val reason: Reason) : Result
|
||||
}
|
||||
|
||||
enum class Reason {
|
||||
/** Empty or whitespace-only input. */
|
||||
BLANK,
|
||||
|
||||
/** Not a parseable http(s) URL (bad host, illegal characters, …). */
|
||||
MALFORMED,
|
||||
|
||||
/** A scheme other than http/https (e.g. ftp://, ws://). */
|
||||
UNSUPPORTED_SCHEME,
|
||||
|
||||
/** Plain HTTP where the build requires HTTPS. */
|
||||
INSECURE,
|
||||
}
|
||||
|
||||
fun normalize(raw: String, allowInsecureHttp: Boolean): Result {
|
||||
val trimmed = raw.trim()
|
||||
if (trimmed.isEmpty()) return Result.Invalid(Reason.BLANK)
|
||||
|
||||
// Give a scheme-less entry an implicit, secure default so users can type
|
||||
// just "shard.example.com". An explicit but unsupported scheme is rejected.
|
||||
val hasScheme = SCHEME_RE.containsMatchIn(trimmed)
|
||||
val candidate = if (hasScheme) trimmed else "https://$trimmed"
|
||||
|
||||
val lowerScheme = candidate.substringBefore("://", "").lowercase()
|
||||
if (hasScheme && lowerScheme != "http" && lowerScheme != "https") {
|
||||
return Result.Invalid(Reason.UNSUPPORTED_SCHEME)
|
||||
}
|
||||
|
||||
val parsed = candidate.toHttpUrlOrNull() ?: return Result.Invalid(Reason.MALFORMED)
|
||||
if (parsed.host.isBlank()) return Result.Invalid(Reason.MALFORMED)
|
||||
|
||||
if (parsed.scheme == "http" && !allowInsecureHttp) {
|
||||
return Result.Invalid(Reason.INSECURE)
|
||||
}
|
||||
|
||||
// Rebuild without query/fragment and force a trailing slash so
|
||||
// HttpUrl.resolve()/addPathSegments compose predictably later.
|
||||
val path = parsed.encodedPath.trimEnd('/')
|
||||
val normalized = parsed.newBuilder()
|
||||
.encodedPath(if (path.isEmpty()) "/" else "$path/")
|
||||
.query(null)
|
||||
.fragment(null)
|
||||
.build()
|
||||
|
||||
return Result.Valid(normalized)
|
||||
}
|
||||
|
||||
private val SCHEME_RE = Regex("^[a-zA-Z][a-zA-Z0-9+.-]*://")
|
||||
}
|
||||
@@ -0,0 +1,151 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import kotlinx.coroutines.CompletableDeferred
|
||||
import kotlinx.coroutines.delay
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.channelFlow
|
||||
import kotlinx.coroutines.isActive
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonNull
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.jsonObject
|
||||
import kotlinx.serialization.json.jsonPrimitive
|
||||
import okhttp3.OkHttpClient
|
||||
import okhttp3.Request
|
||||
import okhttp3.Response
|
||||
import okhttp3.sse.EventSource
|
||||
import okhttp3.sse.EventSourceListener
|
||||
import okhttp3.sse.EventSources
|
||||
import java.util.concurrent.TimeUnit
|
||||
import java.util.concurrent.atomic.AtomicBoolean
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Consumes the public live-event SSE stream (`GET /public/shard/stream`, safe kinds
|
||||
* only) and re-emits each frame as a [ShardStreamEvent] (PLAN.md §6.2, §7).
|
||||
*
|
||||
* Unlike the browser's `EventSource`, OkHttp's does **not** auto-reconnect, so the
|
||||
* reconnect/backoff loop lives here: on any disconnect the connection is torn down
|
||||
* and re-opened after a growing delay (reset once a connection opens), and while no
|
||||
* shard site is configured yet the flow simply idles. The stream is exposed as a
|
||||
* cold [Flow]; a `viewModelScope` collect opens it and cancellation closes it, so a
|
||||
* dropped feed degrades to "offline" rather than crashing.
|
||||
*/
|
||||
@Singleton
|
||||
class ShardStreamClient @Inject constructor(
|
||||
baseClient: OkHttpClient,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val json: Json,
|
||||
) {
|
||||
// SSE is a long-lived, mostly-idle connection (keepalive comments every ~25s),
|
||||
// so the read timeout must be disabled or the idle stream would be killed.
|
||||
private val sseClient: OkHttpClient = baseClient.newBuilder()
|
||||
.readTimeout(0, TimeUnit.MILLISECONDS)
|
||||
.retryOnConnectionFailure(true)
|
||||
.build()
|
||||
|
||||
private val factory = EventSources.createFactory(sseClient)
|
||||
|
||||
/**
|
||||
* A cold flow of stream lifecycle + frame events, reconnecting with backoff
|
||||
* until the collector cancels. [ShardStreamEvent.Open] / [ShardStreamEvent.Closed]
|
||||
* drive a live/offline indicator; [ShardStreamEvent.Frame] carries a decoded
|
||||
* `{ kind, … }` payload the boards merge in place.
|
||||
*/
|
||||
fun events(): Flow<ShardStreamEvent> = channelFlow {
|
||||
var backoffMs = INITIAL_BACKOFF_MS
|
||||
while (isActive) {
|
||||
val url = baseUrlHolder.current?.resolve(STREAM_PATH)
|
||||
if (url == null) {
|
||||
// No shard site configured (or an unresolvable base) — idle, don't spin.
|
||||
trySend(ShardStreamEvent.Closed)
|
||||
delay(backoffMs)
|
||||
backoffMs = grow(backoffMs)
|
||||
continue
|
||||
}
|
||||
|
||||
val request = Request.Builder()
|
||||
.url(url)
|
||||
.header("Accept", "text/event-stream")
|
||||
.build()
|
||||
|
||||
val opened = AtomicBoolean(false)
|
||||
val ended = CompletableDeferred<Unit>()
|
||||
val listener = object : EventSourceListener() {
|
||||
override fun onOpen(eventSource: EventSource, response: Response) {
|
||||
opened.set(true)
|
||||
trySend(ShardStreamEvent.Open)
|
||||
}
|
||||
|
||||
override fun onEvent(
|
||||
eventSource: EventSource,
|
||||
id: String?,
|
||||
type: String?,
|
||||
data: String,
|
||||
) {
|
||||
parseFrame(data)?.let { (kind, obj) ->
|
||||
trySend(ShardStreamEvent.Frame(kind, obj))
|
||||
}
|
||||
}
|
||||
|
||||
override fun onClosed(eventSource: EventSource) {
|
||||
trySend(ShardStreamEvent.Closed)
|
||||
ended.complete(Unit)
|
||||
}
|
||||
|
||||
override fun onFailure(
|
||||
eventSource: EventSource,
|
||||
t: Throwable?,
|
||||
response: Response?,
|
||||
) {
|
||||
trySend(ShardStreamEvent.Closed)
|
||||
ended.complete(Unit)
|
||||
}
|
||||
}
|
||||
|
||||
val source = factory.newEventSource(request, listener)
|
||||
try {
|
||||
// Park until this connection ends; collector cancellation propagates
|
||||
// out of await() and is handled by the finally + the while guard.
|
||||
ended.await()
|
||||
} finally {
|
||||
source.cancel()
|
||||
}
|
||||
|
||||
// A connection that opened before dropping reconnects promptly; a run of
|
||||
// failures that never opened backs off further to avoid hammering a down site.
|
||||
backoffMs = if (opened.get()) INITIAL_BACKOFF_MS else grow(backoffMs)
|
||||
delay(backoffMs)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse an SSE `data:` line into `(kind, object)`, dropping keepalive comments
|
||||
* and any frame without a string `kind`. Kept internal + pure for unit testing.
|
||||
*/
|
||||
internal fun parseFrame(data: String): Pair<String, JsonObject>? {
|
||||
val trimmed = data.trim()
|
||||
if (trimmed.isEmpty() || trimmed.startsWith(":")) return null
|
||||
return try {
|
||||
val obj = json.parseToJsonElement(trimmed).jsonObject
|
||||
val kindEl = obj["kind"] ?: return null
|
||||
if (kindEl is JsonNull) return null
|
||||
val kind = kindEl.jsonPrimitive.content
|
||||
if (kind.isEmpty()) null else kind to obj
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
|
||||
private fun grow(current: Long): Long = (current * 2).coerceAtMost(MAX_BACKOFF_MS)
|
||||
|
||||
private companion object {
|
||||
const val STREAM_PATH = "api/v1/public/shard/stream"
|
||||
const val INITIAL_BACKOFF_MS = 2_000L
|
||||
const val MAX_BACKOFF_MS = 30_000L
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* A lifecycle or data event from the public shard SSE stream (PLAN.md §6.2).
|
||||
*
|
||||
* - [Open] — a connection was established (drive the live indicator on).
|
||||
* - [Closed] — the connection dropped or none is available (indicator off);
|
||||
* [ShardStreamClient] will reconnect with backoff.
|
||||
* - [Frame] — a live event: its `kind` plus the raw JSON object, which the
|
||||
* boards decode into their DTO (`champ.update` → `ChampDto`, …).
|
||||
*/
|
||||
sealed interface ShardStreamEvent {
|
||||
data object Open : ShardStreamEvent
|
||||
data object Closed : ShardStreamEvent
|
||||
data class Frame(val kind: String, val data: JsonObject) : ShardStreamEvent
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.data.api.AuthRefreshApi
|
||||
import com.runicgateway.app.data.api.dto.MobileRefreshRequest
|
||||
import okhttp3.Authenticator
|
||||
import okhttp3.Request
|
||||
import okhttp3.Response
|
||||
import okhttp3.Route
|
||||
import java.io.IOException
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Transparently refreshes an expired access token on a bearer `401` and replays
|
||||
* the request (PLAN.md §4.1, §4.3). Refresh tokens are single-use and rotated, so
|
||||
* this is serialized behind a mutex: concurrent 401s trigger exactly one refresh
|
||||
* and the losers reuse its result. A refresh that comes back `401` means the
|
||||
* session is truly dead → sign out; a network error leaves the session intact so
|
||||
* a later call can retry.
|
||||
*
|
||||
* The refresh call runs on [AuthRefreshApi] (its own bare client with no
|
||||
* authenticator), so it can never recurse back into here.
|
||||
*/
|
||||
@Singleton
|
||||
class TokenAuthenticator @Inject constructor(
|
||||
private val sessionManager: SessionManager,
|
||||
private val refreshApi: AuthRefreshApi,
|
||||
) : Authenticator {
|
||||
|
||||
private val lock = Any()
|
||||
|
||||
override fun authenticate(route: Route?, response: Response): Request? {
|
||||
val failed = response.request
|
||||
// Credential endpoints (login/refresh) must never be "refreshed".
|
||||
if (failed.header(Http.NO_SESSION_HEADER) != null) return null
|
||||
// Give up after a single refresh+replay to avoid an auth loop.
|
||||
if (priorResponseCount(response) >= 2) return null
|
||||
|
||||
val attemptedAuth = failed.header(Http.AUTHORIZATION)
|
||||
|
||||
synchronized(lock) {
|
||||
// Another thread may have already refreshed while we waited on the lock.
|
||||
val current = sessionManager.currentAccessToken()
|
||||
if (current != null && Http.bearer(current) != attemptedAuth) {
|
||||
return failed.retryWith(current)
|
||||
}
|
||||
|
||||
val refreshToken = sessionManager.currentRefreshToken()
|
||||
?: return null // already signed out
|
||||
|
||||
val refreshed = try {
|
||||
refreshApi.refresh(MobileRefreshRequest(refreshToken)).execute()
|
||||
} catch (_: IOException) {
|
||||
// Transient — surface the original 401 but keep the session.
|
||||
return null
|
||||
}
|
||||
|
||||
val body = refreshed.body()
|
||||
if (!refreshed.isSuccessful || body == null) {
|
||||
// The refresh token is dead (401/expired/revoked) → session is over.
|
||||
sessionManager.onSignedOut()
|
||||
return null
|
||||
}
|
||||
|
||||
sessionManager.onRefreshed(body.accessToken, body.refreshToken, body.user)
|
||||
return failed.retryWith(body.accessToken)
|
||||
}
|
||||
}
|
||||
|
||||
private fun Request.retryWith(accessToken: String): Request =
|
||||
newBuilder().header(Http.AUTHORIZATION, Http.bearer(accessToken)).build()
|
||||
|
||||
private fun priorResponseCount(response: Response): Int {
|
||||
var count = 1
|
||||
var prior = response.priorResponse
|
||||
while (prior != null) {
|
||||
count++
|
||||
prior = prior.priorResponse
|
||||
}
|
||||
return count
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import okhttp3.Interceptor
|
||||
import okhttp3.Response
|
||||
|
||||
/**
|
||||
* Sets a stable, identifiable User-Agent on every request. The website mounts a
|
||||
* bot/scanner guard ahead of routing (PLAN.md §8); a native client must present
|
||||
* a sane UA so it is not caught by the scanner heuristics that reject blank or
|
||||
* default agents. Constructed with the app's UA string in the network module.
|
||||
*/
|
||||
class UserAgentInterceptor(
|
||||
private val userAgent: String,
|
||||
) : Interceptor {
|
||||
override fun intercept(chain: Interceptor.Chain): Response {
|
||||
val request = chain.request().newBuilder()
|
||||
.header("User-Agent", userAgent)
|
||||
.build()
|
||||
return chain.proceed(request)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.prefs
|
||||
|
||||
import android.content.Context
|
||||
import androidx.datastore.core.DataStore
|
||||
import androidx.datastore.preferences.core.Preferences
|
||||
import androidx.datastore.preferences.core.edit
|
||||
import androidx.datastore.preferences.core.stringPreferencesKey
|
||||
import androidx.datastore.preferences.preferencesDataStore
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.flow.map
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
private val Context.serverDataStore: DataStore<Preferences> by preferencesDataStore(name = "server")
|
||||
|
||||
/**
|
||||
* Persists the selected shard website base URL (PLAN.md §3). The base URL is
|
||||
* non-sensitive, so it lives in plain DataStore; tokens (M3) will use
|
||||
* EncryptedSharedPreferences instead, never this store.
|
||||
*/
|
||||
@Singleton
|
||||
class ServerPreferences @Inject constructor(
|
||||
@param:dagger.hilt.android.qualifiers.ApplicationContext private val context: Context,
|
||||
) {
|
||||
private val store = context.serverDataStore
|
||||
|
||||
/** Emits the saved base URL, or null before first-run connect completes. */
|
||||
val baseUrl: Flow<String?> = store.data.map { it[KEY_BASE_URL] }
|
||||
|
||||
suspend fun currentBaseUrl(): String? = baseUrl.first()
|
||||
|
||||
suspend fun setBaseUrl(url: String) {
|
||||
store.edit { it[KEY_BASE_URL] = url }
|
||||
}
|
||||
|
||||
/** Clears the base URL — used by a Settings → Server switch (hard reset, §3). */
|
||||
suspend fun clear() {
|
||||
store.edit { it.remove(KEY_BASE_URL) }
|
||||
}
|
||||
|
||||
private companion object {
|
||||
val KEY_BASE_URL = stringPreferencesKey("base_url")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import kotlinx.coroutines.CompletableDeferred
|
||||
import kotlinx.coroutines.delay
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.channelFlow
|
||||
import kotlinx.coroutines.isActive
|
||||
import kotlinx.serialization.json.Json
|
||||
import okhttp3.OkHttpClient
|
||||
import okhttp3.Request
|
||||
import okhttp3.Response
|
||||
import okhttp3.sse.EventSource
|
||||
import okhttp3.sse.EventSourceListener
|
||||
import okhttp3.sse.EventSources
|
||||
import java.util.concurrent.TimeUnit
|
||||
import java.util.concurrent.atomic.AtomicBoolean
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The embedded distributor's transport (PLAN.md §11, M7 Part 2 work item 1/3):
|
||||
* a persistent connection to the shard's self-hosted ntfy that subscribes to the
|
||||
* app's own topic and re-emits each content-free tickle. It reuses the same
|
||||
* OkHttp-SSE + reconnect/backoff shape as [com.runicgateway.app.core.net.ShardStreamClient],
|
||||
* but on a **bare** client — no host-retargeting or bearer interceptors — because it
|
||||
* talks straight to ntfy (`<ntfy>/<topic>/sse`), not the website API. Held open by
|
||||
* [PushService]'s foreground service so tickles arrive in the background without
|
||||
* Google Play Services.
|
||||
*/
|
||||
@Singleton
|
||||
class NtfyStreamClient @Inject constructor(
|
||||
private val json: Json,
|
||||
) {
|
||||
// A dedicated client with the read timeout disabled for the mostly-idle stream
|
||||
// (ntfy sends keepalive frames); no interceptors so nothing rewrites the host or
|
||||
// attaches a bearer to the relay.
|
||||
private val client: OkHttpClient = OkHttpClient.Builder()
|
||||
.readTimeout(0, TimeUnit.MILLISECONDS)
|
||||
.retryOnConnectionFailure(true)
|
||||
.build()
|
||||
|
||||
private val factory = EventSources.createFactory(client)
|
||||
|
||||
/** Connection lifecycle + decoded tickles for a subscribed topic. */
|
||||
sealed interface Event {
|
||||
data object Open : Event
|
||||
data object Closed : Event
|
||||
data class Message(val tickle: PushTickle) : Event
|
||||
}
|
||||
|
||||
/**
|
||||
* A cold flow subscribing to `<ntfyBaseUrl>/<topic>/sse`, reconnecting with
|
||||
* backoff until the collector cancels. A dropped relay simply reconnects; a bad
|
||||
* config (null URL) idles rather than spinning.
|
||||
*/
|
||||
fun events(ntfyBaseUrl: String?, topic: String): Flow<Event> = channelFlow {
|
||||
var backoffMs = INITIAL_BACKOFF_MS
|
||||
while (isActive) {
|
||||
val url = NtfyTopic.sseUrl(ntfyBaseUrl, topic)
|
||||
if (url == null) {
|
||||
trySend(Event.Closed)
|
||||
delay(backoffMs)
|
||||
backoffMs = grow(backoffMs)
|
||||
continue
|
||||
}
|
||||
|
||||
val request = Request.Builder()
|
||||
.url(url)
|
||||
.header("Accept", "text/event-stream")
|
||||
.build()
|
||||
|
||||
val opened = AtomicBoolean(false)
|
||||
val ended = CompletableDeferred<Unit>()
|
||||
val listener = object : EventSourceListener() {
|
||||
override fun onOpen(eventSource: EventSource, response: Response) {
|
||||
opened.set(true)
|
||||
trySend(Event.Open)
|
||||
}
|
||||
|
||||
override fun onEvent(eventSource: EventSource, id: String?, type: String?, data: String) {
|
||||
parseNtfyTickle(json, data)?.let { trySend(Event.Message(it)) }
|
||||
}
|
||||
|
||||
override fun onClosed(eventSource: EventSource) {
|
||||
trySend(Event.Closed)
|
||||
ended.complete(Unit)
|
||||
}
|
||||
|
||||
override fun onFailure(eventSource: EventSource, t: Throwable?, response: Response?) {
|
||||
trySend(Event.Closed)
|
||||
ended.complete(Unit)
|
||||
}
|
||||
}
|
||||
|
||||
val source = factory.newEventSource(request, listener)
|
||||
try {
|
||||
ended.await()
|
||||
} finally {
|
||||
source.cancel()
|
||||
}
|
||||
|
||||
backoffMs = if (opened.get()) INITIAL_BACKOFF_MS else grow(backoffMs)
|
||||
delay(backoffMs)
|
||||
}
|
||||
}
|
||||
|
||||
private fun grow(current: Long): Long = (current * 2).coerceAtMost(MAX_BACKOFF_MS)
|
||||
|
||||
private companion object {
|
||||
const val INITIAL_BACKOFF_MS = 2_000L
|
||||
const val MAX_BACKOFF_MS = 30_000L
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import java.security.SecureRandom
|
||||
|
||||
/**
|
||||
* The app's own ntfy topic — the heart of the embedded-distributor design
|
||||
* (PLAN.md §11, M7 Part 2 work item 1). The app mints a **random, unguessable**
|
||||
* topic and registers its public URL (`https://<ntfy-host>/<topic>`) as the device
|
||||
* endpoint the backend POSTs tickles to; the app subscribes to the same topic's SSE
|
||||
* stream to receive them. Security rests on the topic being unguessable plus the
|
||||
* content-free tickle — a leaked topic name reveals nothing.
|
||||
*/
|
||||
object NtfyTopic {
|
||||
|
||||
// ntfy topic names allow [A-Za-z0-9_-]; keep to that set. The "up" prefix mirrors
|
||||
// the UnifiedPush convention and makes topics recognizable in logs/relay.
|
||||
private const val ALPHABET = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
|
||||
private const val TOPIC_LEN = 24
|
||||
private const val PREFIX = "up"
|
||||
|
||||
private val secureRandom by lazy { SecureRandom() }
|
||||
|
||||
/** Mint a fresh unguessable topic, e.g. "up7Qk3…" (≈143 bits of entropy). */
|
||||
fun generate(random: java.util.Random = secureRandom): String {
|
||||
val sb = StringBuilder(PREFIX.length + TOPIC_LEN)
|
||||
sb.append(PREFIX)
|
||||
repeat(TOPIC_LEN) { sb.append(ALPHABET[random.nextInt(ALPHABET.length)]) }
|
||||
return sb.toString()
|
||||
}
|
||||
|
||||
/**
|
||||
* The endpoint URL the backend publishes to: `<ntfyBaseUrl>/<topic>`. [ntfyBaseUrl]
|
||||
* is the client-facing base from `/public/settings.push.ntfyUrl`; a trailing slash
|
||||
* is tolerated. Returns null for a blank base or topic.
|
||||
*/
|
||||
fun endpointUrl(ntfyBaseUrl: String?, topic: String): String? {
|
||||
val base = ntfyBaseUrl?.trim()?.trimEnd('/').orEmpty()
|
||||
if (base.isEmpty() || topic.isBlank()) return null
|
||||
return "$base/$topic"
|
||||
}
|
||||
|
||||
/** The SSE subscribe URL the app connects to: `<ntfyBaseUrl>/<topic>/sse`. */
|
||||
fun sseUrl(ntfyBaseUrl: String?, topic: String): String? =
|
||||
endpointUrl(ntfyBaseUrl, topic)?.let { "$it/sse" }
|
||||
}
|
||||
156
app/src/main/java/com/runicgateway/app/core/push/PushManager.kt
Normal file
156
app/src/main/java/com/runicgateway/app/core/push/PushManager.kt
Normal file
@@ -0,0 +1,156 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import android.content.Context
|
||||
import com.runicgateway.app.core.auth.Session
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.repository.NotificationsRepository
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.SupervisorJob
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.map
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Orchestrates the app's opt-in push lifecycle (PLAN.md §11, M7 Part 2 work item 5):
|
||||
* mint/keep the ntfy topic, register/unregister the device endpoint with the backend,
|
||||
* and start/stop the foreground [PushService] — all keyed to the user's opt-in and
|
||||
* the session. The endpoint the app registers is its own topic URL on the shard's
|
||||
* ntfy (the embedded-distributor design, work item 1).
|
||||
*
|
||||
* Lifecycle rules:
|
||||
* - register only when **signed in** and the shard advertises a relay (`ntfyUrl`);
|
||||
* - a **sign-out** stops the service and forgets the ephemeral registration but keeps
|
||||
* the opt-in intent, so push re-registers on the next sign-in (mirrors the M3 token
|
||||
* teardown, and covers logout / dead-refresh / server switch uniformly via the
|
||||
* session-state observer);
|
||||
* - a **relay/base-URL change** re-registers on the new host with a fresh topic.
|
||||
*/
|
||||
@Singleton
|
||||
class PushManager @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
private val prefs: PushPreferences,
|
||||
private val notifications: NotificationsRepository,
|
||||
private val sessionManager: SessionManager,
|
||||
) {
|
||||
private val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
|
||||
|
||||
/** Whether the user has push turned on (drives the Notifications screen). */
|
||||
val enabled: Flow<Boolean> = prefs.enabled
|
||||
|
||||
/** Whether this shard advertises a push relay at all (null ntfyUrl → unsupported). */
|
||||
val supported: Flow<Boolean> = prefs.ntfyUrl.map { !it.isNullOrBlank() }
|
||||
|
||||
init {
|
||||
// Uniform teardown/resume across every auth transition: logout, dead-refresh
|
||||
// sign-out, and server switch all land on SignedOut; a fresh login re-asserts.
|
||||
scope.launch {
|
||||
sessionManager.state.collect { s ->
|
||||
when (s) {
|
||||
is Session.SignedOut -> localTeardown()
|
||||
is Session.SignedIn -> maybeResume()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Record the shard's client-facing ntfy base URL (from `/public/settings`). */
|
||||
suspend fun setNtfyUrl(url: String?) {
|
||||
val previous = prefs.snapshot().ntfyUrl
|
||||
prefs.setNtfyUrl(url)
|
||||
// The relay host arriving (or changing) is what unblocks a pending resume.
|
||||
if (!url.isNullOrBlank() && url != previous) maybeResume()
|
||||
}
|
||||
|
||||
/**
|
||||
* Turn push on (idempotent): ensure a topic on the current relay, register its
|
||||
* endpoint with the backend, persist, and start the foreground service. Called
|
||||
* when the user opts into ≥1 stream.
|
||||
*/
|
||||
suspend fun enable(): PushResult = register(setIntent = true)
|
||||
|
||||
/** Turn push off (user opted out of every stream): clear intent + deregister. */
|
||||
suspend fun disable() {
|
||||
prefs.setEnabled(false)
|
||||
deregisterDevice()
|
||||
}
|
||||
|
||||
/**
|
||||
* Deregister this device on an explicit sign-out / server switch, while the bearer
|
||||
* is still valid, so no orphan device row is left behind. Keeps the opt-in intent
|
||||
* (and ntfyUrl) so push re-registers on the next sign-in. Call this *before* the
|
||||
* session is torn down.
|
||||
*/
|
||||
suspend fun deregisterDevice() {
|
||||
val snap = prefs.snapshot()
|
||||
snap.deviceId?.let { notifications.deleteDevice(it) } // best-effort
|
||||
stopService()
|
||||
prefs.clearRegistration()
|
||||
}
|
||||
|
||||
/** Re-assert registration if the user is opted in and the shard supports push. */
|
||||
private suspend fun maybeResume() {
|
||||
val snap = prefs.snapshot()
|
||||
if (snap.enabled && sessionManager.isSignedIn && !snap.ntfyUrl.isNullOrBlank()) {
|
||||
register(setIntent = false)
|
||||
}
|
||||
}
|
||||
|
||||
private suspend fun register(setIntent: Boolean): PushResult {
|
||||
if (!sessionManager.isSignedIn) return PushResult.NotSignedIn
|
||||
val snap = prefs.snapshot()
|
||||
val ntfyUrl = snap.ntfyUrl
|
||||
if (ntfyUrl.isNullOrBlank()) return PushResult.Unsupported
|
||||
|
||||
// Reuse an existing topic only if its endpoint still sits on the current relay
|
||||
// origin; otherwise (first run, or a server switch) mint a fresh unguessable one.
|
||||
val base = ntfyUrl.trimEnd('/')
|
||||
val topic = snap.topic?.takeIf { snap.endpoint?.startsWith("$base/") == true }
|
||||
?: NtfyTopic.generate()
|
||||
val endpoint = NtfyTopic.endpointUrl(ntfyUrl, topic) ?: return PushResult.Unsupported
|
||||
|
||||
return when (val res = notifications.registerDevice(endpoint, PLATFORM)) {
|
||||
is ApiResult.Ok -> {
|
||||
prefs.setRegistration(topic, endpoint, res.data.id)
|
||||
if (setIntent) prefs.setEnabled(true)
|
||||
startService()
|
||||
PushResult.Enabled
|
||||
}
|
||||
// 400 = endpoint origin isn't on the shard's ntfy allow-set (misconfigured relay).
|
||||
is ApiResult.HttpError -> PushResult.Failed(res.status)
|
||||
is ApiResult.NetworkError -> PushResult.Failed(null)
|
||||
}
|
||||
}
|
||||
|
||||
/** Local-only teardown on sign-out — no backend DELETE (the bearer may be dead). */
|
||||
private suspend fun localTeardown() {
|
||||
stopService()
|
||||
prefs.clearRegistration()
|
||||
}
|
||||
|
||||
private fun startService() = runCatching { PushService.start(context) }
|
||||
private fun stopService() = runCatching { PushService.stop(context) }
|
||||
|
||||
/** The outcome of enabling push, surfaced to the Notifications screen. */
|
||||
sealed interface PushResult {
|
||||
data object Enabled : PushResult
|
||||
|
||||
/** This shard advertises no push relay (`/public/settings.push.ntfyUrl` is null). */
|
||||
data object Unsupported : PushResult
|
||||
data object NotSignedIn : PushResult
|
||||
|
||||
/** Registration failed — [status] 400 = relay off the allow-set; null = network. */
|
||||
data class Failed(val status: Int?) : PushResult
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val PLATFORM = "android"
|
||||
}
|
||||
}
|
||||
110
app/src/main/java/com/runicgateway/app/core/push/PushNotifier.kt
Normal file
110
app/src/main/java/com/runicgateway/app/core/push/PushNotifier.kt
Normal file
@@ -0,0 +1,110 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import android.app.Notification
|
||||
import android.app.NotificationChannel
|
||||
import android.app.NotificationManager
|
||||
import android.app.PendingIntent
|
||||
import android.content.Context
|
||||
import android.content.Intent
|
||||
import androidx.core.app.NotificationCompat
|
||||
import androidx.core.app.NotificationManagerCompat
|
||||
import com.runicgateway.app.MainActivity
|
||||
import com.runicgateway.app.R
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import java.util.concurrent.atomic.AtomicInteger
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Builds the notification channels and posts a notification for a received tickle
|
||||
* (PLAN.md §11, M7 Part 2 work items 2/3/7). v1 shows a **generic per-stream**
|
||||
* notification titled from the fixed [PushStreams] catalog — the content-free tickle
|
||||
* carries nothing to render, so nothing is fetched to display the notification; tapping
|
||||
* deep-links into [MainActivity] (which fetches fresh over the authenticated API).
|
||||
*/
|
||||
@Singleton
|
||||
class PushNotifier @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
) {
|
||||
private val manager = NotificationManagerCompat.from(context)
|
||||
private val nextId = AtomicInteger(1)
|
||||
|
||||
/** Create both channels; safe to call repeatedly (creation is idempotent). */
|
||||
fun ensureChannels() {
|
||||
val system = context.getSystemService(NotificationManager::class.java) ?: return
|
||||
system.createNotificationChannel(
|
||||
NotificationChannel(
|
||||
CHANNEL_MESSAGES,
|
||||
context.getString(R.string.push_channel_messages),
|
||||
NotificationManager.IMPORTANCE_DEFAULT,
|
||||
).apply { description = context.getString(R.string.push_channel_messages_desc) },
|
||||
)
|
||||
system.createNotificationChannel(
|
||||
NotificationChannel(
|
||||
CHANNEL_SERVICE,
|
||||
context.getString(R.string.push_channel_service),
|
||||
NotificationManager.IMPORTANCE_LOW,
|
||||
).apply {
|
||||
description = context.getString(R.string.push_channel_service_desc)
|
||||
setShowBadge(false)
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
/** The persistent low-importance notification the foreground service runs under. */
|
||||
fun serviceNotification(): Notification =
|
||||
NotificationCompat.Builder(context, CHANNEL_SERVICE)
|
||||
.setContentTitle(context.getString(R.string.push_service_title))
|
||||
.setContentText(context.getString(R.string.push_service_text))
|
||||
.setSmallIcon(R.drawable.ic_stat_name)
|
||||
.setOngoing(true)
|
||||
.setPriority(NotificationCompat.PRIORITY_LOW)
|
||||
.setContentIntent(deepLinkIntent(stream = null, ref = null))
|
||||
.build()
|
||||
|
||||
/** Post a notification for a tickle, deep-linking to the stream's screen on tap. */
|
||||
fun notify(tickle: PushTickle) {
|
||||
if (!manager.areNotificationsEnabled()) return // POST_NOTIFICATIONS not granted
|
||||
val title = context.getString(PushStreams.titleRes(tickle.stream))
|
||||
val notification = NotificationCompat.Builder(context, CHANNEL_MESSAGES)
|
||||
.setContentTitle(title)
|
||||
.setSmallIcon(R.drawable.ic_stat_name)
|
||||
.setAutoCancel(true)
|
||||
.setPriority(NotificationCompat.PRIORITY_DEFAULT)
|
||||
.setContentIntent(deepLinkIntent(tickle.stream, tickle.ref))
|
||||
.build()
|
||||
try {
|
||||
manager.notify(nextId.getAndIncrement(), notification)
|
||||
} catch (_: SecurityException) {
|
||||
// Racing a permission revoke — drop silently rather than crash.
|
||||
}
|
||||
}
|
||||
|
||||
private fun deepLinkIntent(stream: String?, ref: String?): PendingIntent {
|
||||
val intent = Intent(context, MainActivity::class.java).apply {
|
||||
flags = Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP
|
||||
if (stream != null) putExtra(EXTRA_STREAM, stream)
|
||||
if (ref != null) putExtra(EXTRA_REF, ref)
|
||||
}
|
||||
// A distinct request code per stream so PendingIntents don't collapse into one.
|
||||
val requestCode = stream?.hashCode() ?: 0
|
||||
return PendingIntent.getActivity(
|
||||
context,
|
||||
requestCode,
|
||||
intent,
|
||||
PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT,
|
||||
)
|
||||
}
|
||||
|
||||
companion object {
|
||||
const val CHANNEL_MESSAGES = "push_messages"
|
||||
const val CHANNEL_SERVICE = "push_service"
|
||||
|
||||
/** Intent extras a tapped notification carries into [MainActivity] (§7 deep-links). */
|
||||
const val EXTRA_STREAM = "com.runicgateway.app.push.STREAM"
|
||||
const val EXTRA_REF = "com.runicgateway.app.push.REF"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import android.content.Context
|
||||
import androidx.datastore.core.DataStore
|
||||
import androidx.datastore.preferences.core.Preferences
|
||||
import androidx.datastore.preferences.core.booleanPreferencesKey
|
||||
import androidx.datastore.preferences.core.edit
|
||||
import androidx.datastore.preferences.core.longPreferencesKey
|
||||
import androidx.datastore.preferences.core.stringPreferencesKey
|
||||
import androidx.datastore.preferences.preferencesDataStore
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.flow.map
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
private val Context.pushDataStore: DataStore<Preferences> by preferencesDataStore(name = "push")
|
||||
|
||||
/**
|
||||
* Persists the app's push state (PLAN.md §11, M7 Part 2 work item 5). None of it is
|
||||
* secret — the ntfy topic/endpoint's protection is being unguessable plus the
|
||||
* content-free tickle — so plain DataStore is fine (tokens stay in the encrypted
|
||||
* store). Holds the shard's ntfy base URL (from `/public/settings`), the minted
|
||||
* topic + its endpoint URL, the backend-assigned device id (to unregister), and the
|
||||
* user's opt-in flag (the source of truth for "push should be running").
|
||||
*/
|
||||
@Singleton
|
||||
class PushPreferences @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
) {
|
||||
private val store = context.pushDataStore
|
||||
|
||||
val enabled: Flow<Boolean> = store.data.map { it[KEY_ENABLED] ?: false }
|
||||
val ntfyUrl: Flow<String?> = store.data.map { it[KEY_NTFY_URL] }
|
||||
|
||||
suspend fun snapshot(): Snapshot {
|
||||
val p = store.data.first()
|
||||
return Snapshot(
|
||||
enabled = p[KEY_ENABLED] ?: false,
|
||||
ntfyUrl = p[KEY_NTFY_URL],
|
||||
topic = p[KEY_TOPIC],
|
||||
endpoint = p[KEY_ENDPOINT],
|
||||
deviceId = p[KEY_DEVICE_ID],
|
||||
)
|
||||
}
|
||||
|
||||
suspend fun setNtfyUrl(url: String?) = store.edit {
|
||||
if (url.isNullOrBlank()) it.remove(KEY_NTFY_URL) else it[KEY_NTFY_URL] = url
|
||||
}
|
||||
|
||||
suspend fun setEnabled(value: Boolean) = store.edit { it[KEY_ENABLED] = value }
|
||||
|
||||
/** Record the minted topic + its endpoint URL and the assigned device id together. */
|
||||
suspend fun setRegistration(topic: String, endpoint: String, deviceId: Long) = store.edit {
|
||||
it[KEY_TOPIC] = topic
|
||||
it[KEY_ENDPOINT] = endpoint
|
||||
it[KEY_DEVICE_ID] = deviceId
|
||||
}
|
||||
|
||||
/**
|
||||
* Forget the ephemeral device registration (topic/endpoint/device id) — used on
|
||||
* sign-out and on an explicit disable. Deliberately leaves [KEY_ENABLED] and
|
||||
* [KEY_NTFY_URL] intact so the user's opt-in intent survives a sign-out and push
|
||||
* re-registers on the next sign-in; an explicit disable also calls [setEnabled]`(false)`.
|
||||
*/
|
||||
suspend fun clearRegistration() = store.edit {
|
||||
it.remove(KEY_TOPIC)
|
||||
it.remove(KEY_ENDPOINT)
|
||||
it.remove(KEY_DEVICE_ID)
|
||||
}
|
||||
|
||||
data class Snapshot(
|
||||
val enabled: Boolean,
|
||||
val ntfyUrl: String?,
|
||||
val topic: String?,
|
||||
val endpoint: String?,
|
||||
val deviceId: Long?,
|
||||
)
|
||||
|
||||
private companion object {
|
||||
val KEY_ENABLED = booleanPreferencesKey("enabled")
|
||||
val KEY_NTFY_URL = stringPreferencesKey("ntfy_url")
|
||||
val KEY_TOPIC = stringPreferencesKey("topic")
|
||||
val KEY_ENDPOINT = stringPreferencesKey("endpoint")
|
||||
val KEY_DEVICE_ID = longPreferencesKey("device_id")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,95 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import android.app.Service
|
||||
import android.content.Context
|
||||
import android.content.Intent
|
||||
import android.content.pm.ServiceInfo
|
||||
import android.os.Build
|
||||
import android.os.IBinder
|
||||
import androidx.core.app.ServiceCompat
|
||||
import dagger.hilt.android.AndroidEntryPoint
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.Job
|
||||
import kotlinx.coroutines.SupervisorJob
|
||||
import kotlinx.coroutines.cancel
|
||||
import kotlinx.coroutines.flow.collectLatest
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* The always-connected foreground service that IS the embedded distributor
|
||||
* (PLAN.md §11, M7 Part 2 work item 1/3). It holds [NtfyStreamClient]'s persistent
|
||||
* connection to the shard's ntfy open in the background — the price of Google-free,
|
||||
* self-contained instant delivery — and posts a notification for each tickle. It runs
|
||||
* under a low-importance ongoing notification and restarts sticky; [PushManager] starts
|
||||
* and stops it as the user opts in/out or signs out.
|
||||
*/
|
||||
@AndroidEntryPoint
|
||||
class PushService : Service() {
|
||||
|
||||
@Inject lateinit var streamClient: NtfyStreamClient
|
||||
@Inject lateinit var notifier: PushNotifier
|
||||
@Inject lateinit var prefs: PushPreferences
|
||||
|
||||
private val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
|
||||
private var connectionJob: Job? = null
|
||||
|
||||
override fun onCreate() {
|
||||
super.onCreate()
|
||||
notifier.ensureChannels()
|
||||
}
|
||||
|
||||
override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
|
||||
startAsForeground()
|
||||
if (connectionJob == null) connectionJob = scope.launch { run() }
|
||||
return START_STICKY
|
||||
}
|
||||
|
||||
private fun startAsForeground() {
|
||||
val type = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
|
||||
ServiceInfo.FOREGROUND_SERVICE_TYPE_DATA_SYNC
|
||||
} else {
|
||||
0
|
||||
}
|
||||
ServiceCompat.startForeground(this, NOTIFICATION_ID, notifier.serviceNotification(), type)
|
||||
}
|
||||
|
||||
private suspend fun run() {
|
||||
val snapshot = prefs.snapshot()
|
||||
val topic = snapshot.topic
|
||||
if (topic.isNullOrBlank() || snapshot.ntfyUrl.isNullOrBlank()) {
|
||||
// Nothing to subscribe to (should not happen — PushManager starts us only
|
||||
// once a topic exists) — stop rather than hold a dead connection open.
|
||||
stopSelf()
|
||||
return
|
||||
}
|
||||
streamClient.events(snapshot.ntfyUrl, topic).collectLatest { event ->
|
||||
if (event is NtfyStreamClient.Event.Message) notifier.notify(event.tickle)
|
||||
}
|
||||
}
|
||||
|
||||
override fun onDestroy() {
|
||||
connectionJob?.cancel()
|
||||
scope.cancel()
|
||||
super.onDestroy()
|
||||
}
|
||||
|
||||
override fun onBind(intent: Intent?): IBinder? = null
|
||||
|
||||
companion object {
|
||||
private const val NOTIFICATION_ID = 42
|
||||
|
||||
fun start(context: Context) {
|
||||
val intent = Intent(context, PushService::class.java)
|
||||
context.startForegroundService(intent)
|
||||
}
|
||||
|
||||
fun stop(context: Context) {
|
||||
context.stopService(Intent(context, PushService::class.java))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import com.runicgateway.app.R
|
||||
|
||||
/**
|
||||
* The known push stream ids (mirrors the backend catalog in
|
||||
* `config/notificationStreams.js`) and their localized notification titles.
|
||||
* The subscribable catalog itself is fetched from
|
||||
* `GET /auth/me/notifications/streams`; this fixed set is only what the receiver
|
||||
* needs to title a content-free tickle without a network round-trip (§11).
|
||||
*/
|
||||
object PushStreams {
|
||||
const val NEWS_POST = "news.post"
|
||||
const val SERVER_STATUS = "server.status"
|
||||
const val IDOC_WARNING = "idoc.warning"
|
||||
const val CHAMP_START = "champ.start"
|
||||
const val GOVERNOR_ELECTION = "governor.election"
|
||||
const val VENDOR_SALE = "vendor.sale"
|
||||
const val HOUSE_IDOC = "house.idoc"
|
||||
const val ACCOUNT_LOGIN = "account.login"
|
||||
|
||||
/** A short, localized notification title for [streamId]; a generic fallback otherwise. */
|
||||
@StringRes
|
||||
fun titleRes(streamId: String): Int = when (streamId) {
|
||||
NEWS_POST -> R.string.push_stream_news_post
|
||||
SERVER_STATUS -> R.string.push_stream_server_status
|
||||
IDOC_WARNING -> R.string.push_stream_idoc_warning
|
||||
CHAMP_START -> R.string.push_stream_champ_start
|
||||
GOVERNOR_ELECTION -> R.string.push_stream_governor_election
|
||||
VENDOR_SALE -> R.string.push_stream_vendor_sale
|
||||
HOUSE_IDOC -> R.string.push_stream_house_idoc
|
||||
ACCOUNT_LOGIN -> R.string.push_stream_account_login
|
||||
else -> R.string.push_stream_generic
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonNull
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.jsonPrimitive
|
||||
|
||||
/**
|
||||
* The content-free push tickle the backend publishes (PLAN.md §11): `{ stream, ref }`
|
||||
* and nothing sensitive. [ref] is an opaque hint (a serial / city / timestamp) the
|
||||
* app *could* use to pull real content over the authenticated API; v1 just deep-links
|
||||
* to the stream's screen, so it is carried but not otherwise interpreted.
|
||||
*/
|
||||
@Serializable
|
||||
data class PushTickle(
|
||||
val stream: String,
|
||||
val ref: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* Parse a tickle out of an ntfy SSE `data:` frame. ntfy wraps our published body in
|
||||
* its own envelope — `{ event, topic, message, … }` — where `message` is the exact
|
||||
* string we POSTed (our `{ stream, ref }` JSON). Only `event == "message"` frames
|
||||
* carry a payload; `open` / `keepalive` frames return null, as does any malformed or
|
||||
* unrecognized body (dropped, never thrown — §7). Pure + `internal` for unit testing.
|
||||
*/
|
||||
internal fun parseNtfyTickle(json: Json, data: String): PushTickle? {
|
||||
val trimmed = data.trim()
|
||||
if (trimmed.isEmpty() || trimmed.startsWith(":")) return null
|
||||
return try {
|
||||
val envelope = json.parseToJsonElement(trimmed) as? JsonObject ?: return null
|
||||
val event = envelope["event"]?.jsonPrimitive?.content
|
||||
// ntfy lifecycle frames ("open", "keepalive", "poll_request") carry no message.
|
||||
if (event != null && event != "message") return null
|
||||
val messageEl = envelope["message"] ?: return null
|
||||
if (messageEl is JsonNull) return null
|
||||
val message = messageEl.jsonPrimitive.content
|
||||
decodeTickle(json, message)
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
|
||||
/** Decode our own `{ stream, ref }` body; a blank/missing stream is not a tickle. */
|
||||
internal fun decodeTickle(json: Json, body: String): PushTickle? = try {
|
||||
val tickle = json.decodeFromString(PushTickle.serializer(), body.trim())
|
||||
tickle.takeIf { it.stream.isNotBlank() }
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.result
|
||||
|
||||
import kotlinx.coroutines.CancellationException
|
||||
import retrofit2.HttpException
|
||||
import java.io.IOException
|
||||
|
||||
/**
|
||||
* The single result type every repository call returns (PLAN.md §7). The UI
|
||||
* degrades gracefully on a down backend or shard: a repository never throws for
|
||||
* an expected failure, it returns a typed variant the screen can render.
|
||||
*
|
||||
* - [Ok] — a 2xx response with a decoded body.
|
||||
* - [HttpError] — the server answered with a non-2xx status.
|
||||
* - [NetworkError] — the request never got an answer (offline, DNS, TLS, timeout).
|
||||
*/
|
||||
sealed interface ApiResult<out T> {
|
||||
data class Ok<T>(val data: T) : ApiResult<T>
|
||||
data class HttpError(val status: Int, val message: String? = null) : ApiResult<Nothing>
|
||||
data class NetworkError(val cause: Throwable) : ApiResult<Nothing>
|
||||
}
|
||||
|
||||
/** True for the "shard/sidecar down" signal the player screens treat as offline (§6.3, §7). */
|
||||
fun ApiResult<*>.isShardUnavailable(): Boolean =
|
||||
this is ApiResult.HttpError && status == 503
|
||||
|
||||
/** Map an [ApiResult.Ok] body while preserving the failure variants unchanged. */
|
||||
inline fun <T, R> ApiResult<T>.map(transform: (T) -> R): ApiResult<R> = when (this) {
|
||||
is ApiResult.Ok -> ApiResult.Ok(transform(data))
|
||||
is ApiResult.HttpError -> this
|
||||
is ApiResult.NetworkError -> this
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a suspending Retrofit call and normalize every outcome into an [ApiResult].
|
||||
* Coroutine cancellation is rethrown so structured concurrency still works — it
|
||||
* is control flow, not a network failure.
|
||||
*/
|
||||
suspend fun <T> safeApiCall(block: suspend () -> T): ApiResult<T> = try {
|
||||
ApiResult.Ok(block())
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (e: HttpException) {
|
||||
ApiResult.HttpError(e.code(), e.message())
|
||||
} catch (e: IOException) {
|
||||
ApiResult.NetworkError(e)
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.web
|
||||
|
||||
import android.content.ActivityNotFoundException
|
||||
import android.content.Context
|
||||
import android.net.Uri
|
||||
import androidx.browser.customtabs.CustomTabsIntent
|
||||
|
||||
/**
|
||||
* Opens the website's own pages in a Chrome Custom Tab (PLAN.md §4.2):
|
||||
* registration, invite acceptance, forgot/reset password, and SSO all stay
|
||||
* website-handled, so the app hands off rather than rebuilding those flows. The
|
||||
* user completes them in the browser and returns to sign in natively (§4.1).
|
||||
*/
|
||||
object WebHandoff {
|
||||
|
||||
/**
|
||||
* Launch [url] in a Custom Tab. Returns false if no browser could handle it
|
||||
* (extremely rare on Android) so the caller can surface a fallback.
|
||||
*/
|
||||
fun open(context: Context, url: String): Boolean = try {
|
||||
CustomTabsIntent.Builder()
|
||||
.setShowTitle(true)
|
||||
.build()
|
||||
.launchUrl(context, Uri.parse(url))
|
||||
true
|
||||
} catch (_: ActivityNotFoundException) {
|
||||
false
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.web
|
||||
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Resolves the website's front-end page paths against the configured base URL,
|
||||
* for the Custom-Tab hand-offs (PLAN.md §4.2). These are the React SPA routes
|
||||
* (mirrored from `website/client` `App.jsx`), not API endpoints. Null before a
|
||||
* shard site is configured.
|
||||
*/
|
||||
@Singleton
|
||||
class WebsiteUrls @Inject constructor(
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
) {
|
||||
private fun resolve(path: String): String? =
|
||||
baseUrlHolder.current?.resolve(path)?.toString()
|
||||
|
||||
/** Create an account on the website. */
|
||||
fun register(): String? = resolve(REGISTER)
|
||||
|
||||
/** Forgot / reset password (the flow built on the backend before app work, §8). */
|
||||
fun forgotPassword(): String? = resolve(FORGOT)
|
||||
|
||||
/** The website login page — carries the SSO provider buttons (§4.2). */
|
||||
fun login(): String? = resolve(LOGIN)
|
||||
|
||||
private companion object {
|
||||
const val REGISTER = "account/register"
|
||||
const val FORGOT = "account/forgot"
|
||||
const val LOGIN = "account/login"
|
||||
}
|
||||
}
|
||||
40
app/src/main/java/com/runicgateway/app/data/api/AuthApi.kt
Normal file
40
app/src/main/java/com/runicgateway/app/data/api/AuthApi.kt
Normal file
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.MeResponse
|
||||
import com.runicgateway.app.data.api.dto.MobileLoginRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileLogoutRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileTokenResponse
|
||||
import retrofit2.Response
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Headers
|
||||
import retrofit2.http.POST
|
||||
|
||||
/**
|
||||
* The native bearer-auth surface (PLAN.md §4.1). Login and logout run on the main
|
||||
* OkHttp client; [com.runicgateway.app.core.net.AuthInterceptor] attaches the
|
||||
* access token to logout + `/auth/me`, and [com.runicgateway.app.core.net.TokenAuthenticator]
|
||||
* transparently refreshes on a `401`.
|
||||
*
|
||||
* Login is tagged [com.runicgateway.app.core.net.Http.NO_SESSION_HEADER] so it
|
||||
* carries no bearer and a credential `401` (bad password / `totpRequired`) is not
|
||||
* misread as an expired session. It returns a raw [Response] so the caller can
|
||||
* inspect the status and parse the `{ totpRequired }` error body.
|
||||
*/
|
||||
interface AuthApi {
|
||||
|
||||
// Literal header value required by Retrofit @Headers; matches Http.NO_SESSION_HEADER.
|
||||
@Headers("X-Runic-No-Session: 1")
|
||||
@POST("api/v1/auth/mobile/login")
|
||||
suspend fun login(@Body body: MobileLoginRequest): Response<MobileTokenResponse>
|
||||
|
||||
@POST("api/v1/auth/mobile/logout")
|
||||
suspend fun logout(@Body body: MobileLogoutRequest): Response<Unit>
|
||||
|
||||
/** Current user — the app's authoritative role source, re-validated on resume (§4.3). */
|
||||
@GET("api/v1/auth/me")
|
||||
suspend fun me(): MeResponse
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.MobileRefreshRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileTokenResponse
|
||||
import retrofit2.Call
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.Headers
|
||||
import retrofit2.http.POST
|
||||
|
||||
/**
|
||||
* The token-rotation endpoint, isolated onto its own **bare** OkHttp client
|
||||
* (no auth interceptor, no authenticator) so refreshing can never recurse
|
||||
* through the very [com.runicgateway.app.core.net.TokenAuthenticator] that calls
|
||||
* it (PLAN.md §4.3). It is a blocking [Call] because the authenticator runs on an
|
||||
* OkHttp dispatcher thread, outside any coroutine, and executes it synchronously.
|
||||
*
|
||||
* Tagged `NO_SESSION` so it carries no stale bearer.
|
||||
*/
|
||||
interface AuthRefreshApi {
|
||||
|
||||
@Headers("X-Runic-No-Session: 1")
|
||||
@POST("api/v1/auth/mobile/refresh")
|
||||
fun refresh(@Body body: MobileRefreshRequest): Call<MobileTokenResponse>
|
||||
}
|
||||
55
app/src/main/java/com/runicgateway/app/data/api/MeApi.kt
Normal file
55
app/src/main/java/com/runicgateway/app/data/api/MeApi.kt
Normal file
@@ -0,0 +1,55 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.ChangePasswordRequest
|
||||
import com.runicgateway.app.data.api.dto.ChangeUsernameRequest
|
||||
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
|
||||
import com.runicgateway.app.data.api.dto.PlayerAccountDto
|
||||
import com.runicgateway.app.data.api.dto.TotpCodeRequest
|
||||
import com.runicgateway.app.data.api.dto.TotpSetupDto
|
||||
import com.runicgateway.app.data.api.dto.TotpStateDto
|
||||
import com.runicgateway.app.data.api.dto.UsernameResponse
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.HTTP
|
||||
import retrofit2.http.PATCH
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.Path
|
||||
|
||||
/**
|
||||
* The role-agnostic self-service surface (PLAN.md §6.3, §6.4): account, credential
|
||||
* changes, TOTP enrollment, and linked SSO identities under `/auth/me/account*`.
|
||||
* The app calls these regardless of role and never touches `/admin`. Every call
|
||||
* rides the main client, so [com.runicgateway.app.core.net.AuthInterceptor] attaches
|
||||
* the bearer and [com.runicgateway.app.core.net.TokenAuthenticator] refreshes on 401.
|
||||
*/
|
||||
interface MeApi {
|
||||
|
||||
@GET("api/v1/auth/me/account")
|
||||
suspend fun getAccount(): PlayerAccountDto
|
||||
|
||||
@PATCH("api/v1/auth/me/account/username")
|
||||
suspend fun changeUsername(@Body body: ChangeUsernameRequest): UsernameResponse
|
||||
|
||||
@PATCH("api/v1/auth/me/account/password")
|
||||
suspend fun changePassword(@Body body: ChangePasswordRequest): Unit
|
||||
|
||||
@POST("api/v1/auth/me/account/totp/setup")
|
||||
suspend fun totpSetup(): TotpSetupDto
|
||||
|
||||
@POST("api/v1/auth/me/account/totp/enable")
|
||||
suspend fun totpEnable(@Body body: TotpCodeRequest): TotpStateDto
|
||||
|
||||
@POST("api/v1/auth/me/account/totp/disable")
|
||||
suspend fun totpDisable(@Body body: TotpCodeRequest): TotpStateDto
|
||||
|
||||
@GET("api/v1/auth/me/account/identities")
|
||||
suspend fun identities(): List<LinkedIdentityDto>
|
||||
|
||||
// DELETE with no body — a plain @DELETE would suffice, but @HTTP keeps the
|
||||
// path template explicit alongside the provider argument.
|
||||
@HTTP(method = "DELETE", path = "api/v1/auth/me/account/identities/{provider}")
|
||||
suspend fun unlinkIdentity(@Path("provider") provider: String): Unit
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
|
||||
import com.runicgateway.app.data.api.dto.PushDeviceDto
|
||||
import com.runicgateway.app.data.api.dto.RegisterDeviceRequest
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.DELETE
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.PUT
|
||||
import retrofit2.http.Path
|
||||
|
||||
/**
|
||||
* The opt-in push surface under `/auth/me` (PLAN.md §11, M7 Part 2): device
|
||||
* (endpoint) registration and per-user stream subscriptions. Every call rides the
|
||||
* main client, so [com.runicgateway.app.core.net.AuthInterceptor] attaches the
|
||||
* bearer and [com.runicgateway.app.core.net.TokenAuthenticator] refreshes on 401 —
|
||||
* registration only ever succeeds while signed in.
|
||||
*/
|
||||
interface NotificationsApi {
|
||||
|
||||
@POST("api/v1/auth/me/devices")
|
||||
suspend fun registerDevice(@Body body: RegisterDeviceRequest): PushDeviceDto
|
||||
|
||||
@GET("api/v1/auth/me/devices")
|
||||
suspend fun listDevices(): List<PushDeviceDto>
|
||||
|
||||
@DELETE("api/v1/auth/me/devices/{id}")
|
||||
suspend fun deleteDevice(@Path("id") id: Long): Unit
|
||||
|
||||
@GET("api/v1/auth/me/notifications/streams")
|
||||
suspend fun streams(): NotificationStreamsDto
|
||||
|
||||
@GET("api/v1/auth/me/notifications/subscriptions")
|
||||
suspend fun subscriptions(): NotificationSubscriptionsDto
|
||||
|
||||
@PUT("api/v1/auth/me/notifications/subscriptions")
|
||||
suspend fun putSubscriptions(@Body body: NotificationSubscriptionsDto): NotificationSubscriptionsDto
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.CharProfileDto
|
||||
import com.runicgateway.app.data.api.dto.CreateGameAccountRequest
|
||||
import com.runicgateway.app.data.api.dto.PlayerHouseDto
|
||||
import com.runicgateway.app.data.api.dto.RosterDto
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkDto
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkRequest
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkResultDto
|
||||
import com.runicgateway.app.data.api.dto.VendorSaleDto
|
||||
import com.runicgateway.app.data.api.dto.VendorSnapshotDto
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.Path
|
||||
|
||||
/**
|
||||
* A player's own game data + game-account linking (PLAN.md §6.3), over the
|
||||
* bearer-gated `/player/shard/…` surface. Every read is ownership-checked
|
||||
* server-side; a `503` means the shard/sidecar is down → the UI renders "offline,
|
||||
* retry" (§7). All reads ride the main authed client (bearer + refresh-on-401).
|
||||
*/
|
||||
interface PlayerShardApi {
|
||||
|
||||
/** Confirm an in-game `[link` one-time code, tagging the game account to the user. */
|
||||
@POST("api/v1/player/shard/link")
|
||||
suspend fun link(@Body body: ShardLinkRequest): ShardLinkResultDto
|
||||
|
||||
/** Provision a game account (hybrid signup) and auto-link it to the caller. */
|
||||
@POST("api/v1/player/shard/account")
|
||||
suspend fun createAccount(@Body body: CreateGameAccountRequest): ShardLinkResultDto
|
||||
|
||||
/** The caller's linked game accounts. */
|
||||
@GET("api/v1/player/shard/accounts")
|
||||
suspend fun accounts(): List<ShardLinkDto>
|
||||
|
||||
/** Character roster for a linked account. */
|
||||
@GET("api/v1/player/shard/roster/{account}")
|
||||
suspend fun roster(@Path("account") account: String): RosterDto
|
||||
|
||||
/** A character sheet — only for a character on the caller's linked account. */
|
||||
@GET("api/v1/player/shard/char/{serial}")
|
||||
suspend fun char(@Path("serial") serial: String): CharProfileDto
|
||||
|
||||
/** Player vendors for a linked account. */
|
||||
@GET("api/v1/player/shard/vendors/{account}")
|
||||
suspend fun vendors(@Path("account") account: String): VendorSnapshotDto
|
||||
|
||||
/** Recent player-vendor sales across the caller's linked accounts. */
|
||||
@GET("api/v1/player/shard/sales")
|
||||
suspend fun sales(): List<VendorSaleDto>
|
||||
|
||||
/** The caller's own houses (home/decay status). */
|
||||
@GET("api/v1/player/shard/houses")
|
||||
suspend fun houses(): List<PlayerHouseDto>
|
||||
}
|
||||
131
app/src/main/java/com/runicgateway/app/data/api/PublicApi.kt
Normal file
131
app/src/main/java/com/runicgateway/app/data/api/PublicApi.kt
Normal file
@@ -0,0 +1,131 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.ChampDto
|
||||
import com.runicgateway.app.data.api.dto.ContactRequest
|
||||
import com.runicgateway.app.data.api.dto.ContactResponse
|
||||
import com.runicgateway.app.data.api.dto.EconomySampleDto
|
||||
import com.runicgateway.app.data.api.dto.FeedEventDto
|
||||
import com.runicgateway.app.data.api.dto.GovernorDto
|
||||
import com.runicgateway.app.data.api.dto.GovernorTermDto
|
||||
import com.runicgateway.app.data.api.dto.GuildDto
|
||||
import com.runicgateway.app.data.api.dto.HouseDto
|
||||
import com.runicgateway.app.data.api.dto.OnlineStaffDto
|
||||
import com.runicgateway.app.data.api.dto.PageDto
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.data.api.dto.PresenceDto
|
||||
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||
import com.runicgateway.app.data.api.dto.ShardStatusDto
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiPageDto
|
||||
import com.runicgateway.app.data.api.dto.WikiSummaryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiTagDto
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
import retrofit2.http.Url
|
||||
|
||||
/**
|
||||
* The public (unauthenticated) surface consumed in M1: site status/settings,
|
||||
* news posts, CMS pages, wiki, and the contact form (PLAN.md §6.1). Paths are
|
||||
* relative to the sentinel base host; [com.runicgateway.app.core.net.HostSelectionInterceptor]
|
||||
* retargets them onto the configured shard site. The public shard widgets (§6.2)
|
||||
* are added in M2; auth (§4) and player game data (§6.3) arrive in later milestones.
|
||||
* The live SSE stream (`/public/shard/stream`) is not a Retrofit call — it is
|
||||
* consumed via OkHttp in [com.runicgateway.app.core.net.ShardStreamClient].
|
||||
*/
|
||||
interface PublicApi {
|
||||
|
||||
// ── First-run probe (absolute URL; bypasses host rewriting) ──────────
|
||||
/**
|
||||
* Validates a candidate site during the first-run connect flow (§3). Takes a
|
||||
* fully-qualified URL so the request carries a real host and is left
|
||||
* untouched by the host interceptor — the probe targets the URL the user
|
||||
* just typed, not the (not-yet-configured) base.
|
||||
*/
|
||||
@GET
|
||||
suspend fun probeStatus(@Url absoluteStatusUrl: String): StatusDto
|
||||
|
||||
// ── Site status / settings ───────────────────────────────────────────
|
||||
@GET("api/v1/public/status")
|
||||
suspend fun getStatus(): StatusDto
|
||||
|
||||
@GET("api/v1/public/settings")
|
||||
suspend fun getSettings(): SettingsDto
|
||||
|
||||
// ── News & content ───────────────────────────────────────────────────
|
||||
@GET("api/v1/public/posts/{category}")
|
||||
suspend fun getPosts(@Path("category") category: String): List<PostDto>
|
||||
|
||||
@GET("api/v1/public/posts/{category}/{idOrSlug}")
|
||||
suspend fun getPost(
|
||||
@Path("category") category: String,
|
||||
@Path("idOrSlug") idOrSlug: String,
|
||||
): PostDto
|
||||
|
||||
@GET("api/v1/public/pages/{slug}")
|
||||
suspend fun getPage(@Path("slug") slug: String): PageDto
|
||||
|
||||
// ── Wiki ─────────────────────────────────────────────────────────────
|
||||
@GET("api/v1/public/wiki")
|
||||
suspend fun getWikiPages(
|
||||
@Query("q") query: String? = null,
|
||||
@Query("category") category: String? = null,
|
||||
@Query("tag") tag: String? = null,
|
||||
): List<WikiSummaryDto>
|
||||
|
||||
@GET("api/v1/public/wiki/categories")
|
||||
suspend fun getWikiCategories(): List<WikiCategoryDto>
|
||||
|
||||
@GET("api/v1/public/wiki/tags")
|
||||
suspend fun getWikiTags(): List<WikiTagDto>
|
||||
|
||||
@GET("api/v1/public/wiki/{slug}")
|
||||
suspend fun getWikiPage(@Path("slug") slug: String): WikiPageDto
|
||||
|
||||
// ── Contact ──────────────────────────────────────────────────────────
|
||||
@POST("api/v1/public/contact")
|
||||
suspend fun postContact(@Body body: ContactRequest): ContactResponse
|
||||
|
||||
// ── Public shard widgets (§6.2) ──────────────────────────────────────
|
||||
@GET("api/v1/public/shard/status")
|
||||
suspend fun getShardStatus(): ShardStatusDto
|
||||
|
||||
@GET("api/v1/public/shard/feed")
|
||||
suspend fun getShardFeed(
|
||||
@Query("kind") kind: String? = null,
|
||||
@Query("limit") limit: Int? = null,
|
||||
): List<FeedEventDto>
|
||||
|
||||
@GET("api/v1/public/shard/economy")
|
||||
suspend fun getShardEconomy(@Query("limit") limit: Int? = null): List<EconomySampleDto>
|
||||
|
||||
@GET("api/v1/public/shard/online")
|
||||
suspend fun getShardOnline(): List<OnlineStaffDto>
|
||||
|
||||
@GET("api/v1/public/shard/presence")
|
||||
suspend fun getShardPresence(): PresenceDto
|
||||
|
||||
@GET("api/v1/public/shard/champs")
|
||||
suspend fun getShardChamps(): List<ChampDto>
|
||||
|
||||
@GET("api/v1/public/shard/guilds")
|
||||
suspend fun getShardGuilds(): List<GuildDto>
|
||||
|
||||
@GET("api/v1/public/shard/governors")
|
||||
suspend fun getShardGovernors(): List<GovernorDto>
|
||||
|
||||
@GET("api/v1/public/shard/governors/{city}/history")
|
||||
suspend fun getShardGovernorHistory(
|
||||
@Path("city") city: String,
|
||||
@Query("limit") limit: Int? = null,
|
||||
): List<GovernorTermDto>
|
||||
|
||||
@GET("api/v1/public/shard/houses")
|
||||
suspend fun getShardHouses(): List<HouseDto>
|
||||
}
|
||||
40
app/src/main/java/com/runicgateway/app/data/api/SsoApi.kt
Normal file
40
app/src/main/java/com/runicgateway/app/data/api/SsoApi.kt
Normal file
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileTokenResponse
|
||||
import com.runicgateway.app.data.api.dto.SsoProviderDto
|
||||
import retrofit2.Response
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Headers
|
||||
import retrofit2.http.POST
|
||||
|
||||
/**
|
||||
* The native SSO bridge surface (PLAN.md §4.2, M9). Discovery lists the shard's
|
||||
* enabled providers; exchange trades a callback authorization code (+ its PKCE
|
||||
* verifier) for the same bearer pair as `/auth/mobile/login`.
|
||||
*
|
||||
* The redirect leg (`/auth/mobile/sso/start`) is **not** here — it is opened in a
|
||||
* Custom Tab as a URL (the browser follows the 302 through the IdP), not called as
|
||||
* an XHR. See [com.runicgateway.app.core.auth.sso.SsoAuthManager].
|
||||
*
|
||||
* Exchange is tagged [com.runicgateway.app.core.net.Http.NO_SESSION_HEADER]: it
|
||||
* carries no bearer (the user isn't signed in yet) and a `401` (bad/expired code or
|
||||
* PKCE mismatch) must never be misread as an expired session or trip the refresh
|
||||
* [com.runicgateway.app.core.net.TokenAuthenticator]. It returns a raw [Response]
|
||||
* so the caller can distinguish `401` from other failures.
|
||||
*/
|
||||
interface SsoApi {
|
||||
|
||||
/** Public discovery — the enabled providers to render login buttons for. */
|
||||
@GET("api/v1/auth/providers")
|
||||
suspend fun providers(): List<SsoProviderDto>
|
||||
|
||||
// Literal header value required by Retrofit @Headers; matches Http.NO_SESSION_HEADER.
|
||||
@Headers("X-Runic-No-Session: 1")
|
||||
@POST("api/v1/auth/mobile/sso/exchange")
|
||||
suspend fun exchange(@Body body: MobileSsoExchangeRequest): Response<MobileTokenResponse>
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* The role-agnostic self-service ("me") wire shapes (PLAN.md §6.3, §6.4). Field
|
||||
* names match the backend's `account.controller` handlers exactly, surfaced for
|
||||
* the app under `/auth/me/account*`. Every DTO ignores unknown keys (NetworkModule's
|
||||
* lenient Json), so additive backend fields are safe (recorded for M1).
|
||||
*/
|
||||
|
||||
/** `GET /auth/me/account` — the current account (any role). */
|
||||
@Serializable
|
||||
data class PlayerAccountDto(
|
||||
val id: Long = 0,
|
||||
val username: String = "",
|
||||
val role: String = "",
|
||||
val email: String? = null,
|
||||
val status: String? = null,
|
||||
val totp_enabled: Boolean = false,
|
||||
/** False for an SSO-provisioned account that has not set a password yet. */
|
||||
val has_password: Boolean = false,
|
||||
)
|
||||
|
||||
/** `PATCH /auth/me/account/username` body. */
|
||||
@Serializable
|
||||
data class ChangeUsernameRequest(val username: String)
|
||||
|
||||
/** The `{ username }` returned by a successful username change. */
|
||||
@Serializable
|
||||
data class UsernameResponse(val username: String = "")
|
||||
|
||||
/**
|
||||
* `PATCH /auth/me/account/password` body. [currentPassword] is omitted only for an
|
||||
* SSO-provisioned account setting its initial password (has_password == false).
|
||||
*/
|
||||
@Serializable
|
||||
data class ChangePasswordRequest(
|
||||
val newPassword: String,
|
||||
val currentPassword: String? = null,
|
||||
)
|
||||
|
||||
/** Enrollment material from `POST /auth/me/account/totp/setup`. */
|
||||
@Serializable
|
||||
data class TotpSetupDto(
|
||||
val otpauthUrl: String? = null,
|
||||
/** QR code as a `data:image/png;base64,…` URL. */
|
||||
val qr: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /auth/me/account/totp/enable|disable` body — a current authenticator code. */
|
||||
@Serializable
|
||||
data class TotpCodeRequest(val code: String)
|
||||
|
||||
/** Result of enabling/disabling 2FA. */
|
||||
@Serializable
|
||||
data class TotpStateDto(val totp_enabled: Boolean = false)
|
||||
|
||||
/** A linked external identity (`GET /auth/me/account/identities`). */
|
||||
@Serializable
|
||||
data class LinkedIdentityDto(
|
||||
val provider: String = "",
|
||||
val email: String? = null,
|
||||
val linked_at: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* The mobile bearer-auth wire shapes (PLAN.md §4.1). Field names match the
|
||||
* backend's `auth/mobile` controller and `/auth/me` exactly; every DTO ignores
|
||||
* unknown keys (NetworkModule's lenient Json), so additive backend fields are
|
||||
* safe (§8, recorded for M1).
|
||||
*/
|
||||
|
||||
/** `POST /auth/mobile/login` body. [code] is only sent on the 2FA retry. */
|
||||
@Serializable
|
||||
data class MobileLoginRequest(
|
||||
val username: String,
|
||||
val password: String,
|
||||
val code: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /auth/mobile/refresh` body. */
|
||||
@Serializable
|
||||
data class MobileRefreshRequest(val refreshToken: String)
|
||||
|
||||
/** `POST /auth/mobile/logout` body — revoke this session or (with [all]) every session. */
|
||||
@Serializable
|
||||
data class MobileLogoutRequest(
|
||||
val refreshToken: String? = null,
|
||||
val all: Boolean? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* Success payload from login and refresh: the token pair, the access lifetime
|
||||
* (a zeit/ms duration string, e.g. "15m"), and the safe (secret-stripped) user.
|
||||
*/
|
||||
@Serializable
|
||||
data class MobileTokenResponse(
|
||||
val accessToken: String,
|
||||
val refreshToken: String,
|
||||
val expiresIn: String? = null,
|
||||
val user: SafeUserDto,
|
||||
)
|
||||
|
||||
/** The minimal, non-sensitive user the app needs to render + gate the menu (§5). */
|
||||
@Serializable
|
||||
data class SafeUserDto(
|
||||
val id: Long,
|
||||
val username: String,
|
||||
val role: String,
|
||||
)
|
||||
|
||||
/** `GET /auth/me` envelope — the role source, re-validated on resume (§4.3). */
|
||||
@Serializable
|
||||
data class MeResponse(val user: SafeUserDto)
|
||||
|
||||
/**
|
||||
* The `401 { totpRequired: true }` body the single-request 2FA flow returns when
|
||||
* an account has TOTP on and no/invalid code accompanied the login (§4.1). Parsed
|
||||
* from the error body since it is not a 2xx response.
|
||||
*/
|
||||
@Serializable
|
||||
data class TotpRequiredError(
|
||||
val totpRequired: Boolean = false,
|
||||
val message: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,26 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/** `POST /public/contact` request body. */
|
||||
@Serializable
|
||||
data class ContactRequest(
|
||||
val name: String,
|
||||
val email: String,
|
||||
val message: String,
|
||||
)
|
||||
|
||||
/**
|
||||
* `POST /public/contact` response (website `mailer.sendContactMessage`). Either
|
||||
* `{ sent: true }`, or `{ sent: false, fallback: "mailto", email }` when the
|
||||
* site has no mailer configured and the user should email directly instead.
|
||||
*/
|
||||
@Serializable
|
||||
data class ContactResponse(
|
||||
val sent: Boolean = false,
|
||||
val fallback: String? = null,
|
||||
val email: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* Wire shapes for the opt-in push surface under `/auth/me` (PLAN.md §11, M7
|
||||
* Part 2). Field names match the backend's `notifications.controller` /
|
||||
* `pushDevices.model` exactly; every DTO ignores unknown keys (NetworkModule's
|
||||
* lenient Json), so additive backend fields are safe (recorded for M1).
|
||||
*/
|
||||
|
||||
/**
|
||||
* `POST /auth/me/devices` body. [endpoint] is the ntfy topic URL the app's
|
||||
* embedded distributor owns (`https://<ntfy-host>/<topic>`); the backend
|
||||
* SSRF-validates it is HTTPS on the shard's allow-set before storing. [transport]
|
||||
* is `unifiedpush` for the direct-ntfy relay (fcm reserved for a future flavor).
|
||||
*/
|
||||
@Serializable
|
||||
data class RegisterDeviceRequest(
|
||||
val endpoint: String,
|
||||
val transport: String = "unifiedpush",
|
||||
val platform: String? = null,
|
||||
)
|
||||
|
||||
/** `POST/GET /auth/me/devices` — one registered device (endpoint) for this user. */
|
||||
@Serializable
|
||||
data class PushDeviceDto(
|
||||
val id: Long = 0,
|
||||
val transport: String = "",
|
||||
val endpoint: String = "",
|
||||
val platform: String? = null,
|
||||
val createdAt: String? = null,
|
||||
val lastSeenAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One subscribable stream from `GET /auth/me/notifications/streams`. A [personal]
|
||||
* stream is delivered only to the owning user and [requiresLinkedAccount] — the app
|
||||
* greys its toggle until a game account is linked (§11).
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationStreamDto(
|
||||
val id: String = "",
|
||||
val label: String = "",
|
||||
val description: String = "",
|
||||
val personal: Boolean = false,
|
||||
val requiresLinkedAccount: Boolean = false,
|
||||
)
|
||||
|
||||
/** `GET /auth/me/notifications/streams` — the catalog. */
|
||||
@Serializable
|
||||
data class NotificationStreamsDto(
|
||||
val streams: List<NotificationStreamDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET/PUT /auth/me/notifications/subscriptions` — the user's opted-in stream ids.
|
||||
* PUT replaces the full set; unknown ids are dropped server-side and the stored set
|
||||
* echoed back.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationSubscriptionsDto(
|
||||
val streams: List<String> = emptyList(),
|
||||
)
|
||||
@@ -0,0 +1,38 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* `GET /public/pages/:slug` — a block-based CMS page (website `pages.model.js`
|
||||
* `serialize`). Everything block-specific lives inside `props`; the renderer
|
||||
* dispatches on `type`. `props` is left as a raw JSON object so new block types
|
||||
* or props never break decoding — the renderer reads the keys it knows and
|
||||
* ignores the rest.
|
||||
*/
|
||||
@Serializable
|
||||
data class PageDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
val status: String = "",
|
||||
val blocks: List<BlockDto> = emptyList(),
|
||||
@SerialName("publishedAt") val publishedAt: String? = null,
|
||||
@SerialName("updatedAt") val updatedAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One CMS block. Known types (website `src/blocks/types`): `heading`,
|
||||
* `rich_text`, `image`, `quote`, `cta`, `divider`, `two_column`. Container
|
||||
* blocks (`two_column`) hold sub-block arrays inside their props.
|
||||
*/
|
||||
@Serializable
|
||||
data class BlockDto(
|
||||
val type: String = "",
|
||||
val props: JsonObject = JsonObject(emptyMap()),
|
||||
val visible: Boolean = true,
|
||||
)
|
||||
@@ -0,0 +1,224 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* DTOs for a player's OWN game data (PLAN.md §6.3), read over the bearer-gated
|
||||
* `/player/shard/…` surface. The roster / char / vendor reads return the sidecar
|
||||
* payload verbatim (a permissive object), so only the fields the app renders are
|
||||
* modeled — unknown keys are ignored by the JSON parser (matching the website's
|
||||
* `CharacterSheet.jsx` / `GameAccounts.jsx` and `docs/link/INTEGRATION.md` §5).
|
||||
* Presentation is text-only for v1 (no item icons / paperdoll).
|
||||
*
|
||||
* In-game serials are hex strings (e.g. "0x24C"), unlike the numeric serials on
|
||||
* the public boards — these are separate endpoints with separate shapes.
|
||||
*/
|
||||
|
||||
// ── Game-account linking ─────────────────────────────────────────────────────
|
||||
|
||||
/** `GET /player/shard/accounts` — a linked in-game account. */
|
||||
@Serializable
|
||||
data class ShardLinkDto(
|
||||
val account: String = "",
|
||||
val userId: Long? = null,
|
||||
val charName: String? = null,
|
||||
val linkedAt: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /player/shard/link` body — the one-time code shown by `[link` in game. */
|
||||
@Serializable
|
||||
data class ShardLinkRequest(val code: String)
|
||||
|
||||
/** `POST /player/shard/link` result — the confirmed link. */
|
||||
@Serializable
|
||||
data class ShardLinkResultDto(
|
||||
val linked: Boolean = false,
|
||||
val account: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /player/shard/account` (hybrid signup) body. */
|
||||
@Serializable
|
||||
data class CreateGameAccountRequest(
|
||||
val account: String,
|
||||
val password: String,
|
||||
)
|
||||
|
||||
// ── Character roster + sheet ─────────────────────────────────────────────────
|
||||
|
||||
/** `GET /player/shard/roster/:account` — the account's characters (incl. offline). */
|
||||
@Serializable
|
||||
data class RosterDto(
|
||||
val acct: String? = null,
|
||||
val chars: List<RosterCharDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** One character in a roster; the picker fetches the full sheet on demand. */
|
||||
@Serializable
|
||||
data class RosterCharDto(
|
||||
val slot: Int? = null,
|
||||
val serial: String = "",
|
||||
val name: String? = null,
|
||||
val body: Int? = null,
|
||||
val online: Boolean = false,
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET /player/shard/char/:serial` — a character sheet. `guild` / `governorOf` are
|
||||
* best-effort cross-links the backend decorates in (never fail the sheet).
|
||||
*/
|
||||
@Serializable
|
||||
data class CharProfileDto(
|
||||
val serial: String? = null,
|
||||
val name: String? = null,
|
||||
val title: String? = null,
|
||||
val online: Boolean = false,
|
||||
val acct: String? = null,
|
||||
val stats: CharStatsDto? = null,
|
||||
val skills: List<SkillDto> = emptyList(),
|
||||
val equipment: List<EquipmentDto> = emptyList(),
|
||||
val titles: TitlesDto? = null,
|
||||
val guild: GuildRefDto? = null,
|
||||
val governorOf: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class CharStatsDto(
|
||||
val str: Int? = null,
|
||||
val dex: Int? = null,
|
||||
val int: Int? = null,
|
||||
val hits: Int? = null,
|
||||
val hitsMax: Int? = null,
|
||||
val mana: Int? = null,
|
||||
val manaMax: Int? = null,
|
||||
val stam: Int? = null,
|
||||
val stamMax: Int? = null,
|
||||
val resist: ResistDto? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class ResistDto(
|
||||
val phys: Int? = null,
|
||||
val fire: Int? = null,
|
||||
val cold: Int? = null,
|
||||
val pois: Int? = null,
|
||||
val energy: Int? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* A skill line. `base` is the trained value, `value` includes item/temp bonuses,
|
||||
* `cap` is the cap — do NOT assume base ≤ cap (GM chars exceed it). Doubles, as the
|
||||
* shard reports tenths.
|
||||
*/
|
||||
@Serializable
|
||||
data class SkillDto(
|
||||
val n: String? = null,
|
||||
val base: Double? = null,
|
||||
val value: Double? = null,
|
||||
val cap: Double? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* An equipped item. Names are usually clilocs (numeric), not strings, and the app
|
||||
* ships no cliloc table, so the text-only sheet renders layer + id + hue + mods.
|
||||
* [mods] is a flattened map of non-zero AOS attributes (empty for plain items);
|
||||
* kept as a raw object since values may be numbers or strings.
|
||||
*/
|
||||
@Serializable
|
||||
data class EquipmentDto(
|
||||
val serial: String? = null,
|
||||
val layer: String? = null,
|
||||
val itemId: Int? = null,
|
||||
val hue: Int? = null,
|
||||
val mods: JsonObject? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* Display titles (Protocol 2.0). `selected` is the index into `reward` currently
|
||||
* shown (-1 if none); `reward` entries may be a cliloc number-as-string or a
|
||||
* literal — numeric ones are skipped without a cliloc table (as the website does).
|
||||
*/
|
||||
@Serializable
|
||||
data class TitlesDto(
|
||||
val selected: Int? = null,
|
||||
val reward: List<String> = emptyList(),
|
||||
val fameKarma: String? = null,
|
||||
val skill: String? = null,
|
||||
)
|
||||
|
||||
/** The guild a character leads (cross-linked from board data). */
|
||||
@Serializable
|
||||
data class GuildRefDto(
|
||||
val name: String? = null,
|
||||
val abbr: String? = null,
|
||||
)
|
||||
|
||||
// ── Player vendors + sales ───────────────────────────────────────────────────
|
||||
|
||||
/** `GET /player/shard/vendors/:account` — every player vendor on the account. */
|
||||
@Serializable
|
||||
data class VendorSnapshotDto(
|
||||
val acct: String? = null,
|
||||
val vendors: List<VendorDto> = emptyList(),
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class VendorDto(
|
||||
val serial: String? = null,
|
||||
val shopName: String? = null,
|
||||
val holdGold: Long? = null,
|
||||
val ownerSerial: String? = null,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val listings: List<VendorListingDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** A single vendor listing. Item names are clilocs (see [EquipmentDto]); text-only. */
|
||||
@Serializable
|
||||
data class VendorListingDto(
|
||||
val serial: String? = null,
|
||||
val itemId: Int? = null,
|
||||
val amount: Int? = null,
|
||||
val price: Long? = null,
|
||||
val forSale: Boolean = false,
|
||||
)
|
||||
|
||||
/** `GET /player/shard/sales` — a player-vendor sale, visible only to the owner. */
|
||||
@Serializable
|
||||
data class VendorSaleDto(
|
||||
/** Sale time, epoch ms. */
|
||||
val t: Long? = null,
|
||||
val itemType: String? = null,
|
||||
val amount: Int? = null,
|
||||
val price: Long? = null,
|
||||
val commission: Int? = null,
|
||||
val ownerAcct: String? = null,
|
||||
)
|
||||
|
||||
// ── Player houses ────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* `GET /player/shard/houses` — the caller's OWN houses, with full decay/IDOC
|
||||
* detail (their own property). Serial is a hex string here.
|
||||
*/
|
||||
@Serializable
|
||||
data class PlayerHouseDto(
|
||||
val serial: String = "",
|
||||
val stage: String? = null,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val z: Int? = null,
|
||||
val region: String? = null,
|
||||
val name: String? = null,
|
||||
val ownerSerial: String? = null,
|
||||
val ownerAcct: String? = null,
|
||||
val builtOn: String? = null,
|
||||
val lastRefreshed: String? = null,
|
||||
val isIdoc: Boolean = false,
|
||||
val updatedAt: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,26 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* `GET /public/posts/:category` (list) and `/public/posts/:category/:idOrSlug`
|
||||
* (detail). One shape serves both; the list omits nothing the app renders. The
|
||||
* `body` (HTML) is present on the detail response and rendered there.
|
||||
*/
|
||||
@Serializable
|
||||
data class PostDto(
|
||||
val id: Long,
|
||||
/** Stored DB category (`news | five_on_friday | newsletter | screenshot`). */
|
||||
val category: String = "",
|
||||
val title: String = "",
|
||||
val slug: String? = null,
|
||||
val excerpt: String? = null,
|
||||
val body: String? = null,
|
||||
@SerialName("image_url") val imageUrl: String? = null,
|
||||
@SerialName("published_at") val publishedAt: String? = null,
|
||||
@SerialName("created_at") val createdAt: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,83 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* DTOs for the public site/identity endpoints. Shapes mirror the backend
|
||||
* responses (website `public.controller.js` + `settings.model.js`); unknown
|
||||
* keys are ignored by the JSON parser so additive backend fields never break
|
||||
* decoding (PLAN.md §8 "additive, v1").
|
||||
*/
|
||||
|
||||
/** `GET /public/version` and the `version` block embedded in `/public/status`. */
|
||||
@Serializable
|
||||
data class VersionDto(
|
||||
val service: String = "",
|
||||
val api: String = "",
|
||||
val server: String = "",
|
||||
)
|
||||
|
||||
/** `GET /public/status` — site mode + version for the first-run probe (§3). */
|
||||
@Serializable
|
||||
data class StatusDto(
|
||||
val mode: String = "live",
|
||||
@SerialName("status_message") val statusMessage: String = "",
|
||||
val version: VersionDto = VersionDto(),
|
||||
) {
|
||||
val isMaintenance: Boolean get() = mode.equals("maintenance", ignoreCase = true)
|
||||
}
|
||||
|
||||
/** Per-shard branding block the app themes itself from (§3, §6.1). */
|
||||
@Serializable
|
||||
data class BrandDto(
|
||||
val name: String = "",
|
||||
val shortName: String = "",
|
||||
val tagline: String = "",
|
||||
val description: String? = null,
|
||||
val contactEmail: String = "",
|
||||
val url: String = "",
|
||||
/** Seed/accent color as a hex string, e.g. "#7f99bd". */
|
||||
val accent: String = "",
|
||||
/** Asset URL or site-relative path; empty = none. Resolve against the base URL. */
|
||||
val logo: String = "",
|
||||
val hero: String = "",
|
||||
val favicon: String = "",
|
||||
)
|
||||
|
||||
/** Derived, public-safe registration availability flags. */
|
||||
@Serializable
|
||||
data class RegistrationFlagsDto(
|
||||
val password: Boolean = false,
|
||||
val sso: Boolean = false,
|
||||
)
|
||||
|
||||
/**
|
||||
* Push-notification relay config (M7). [ntfyUrl] is the client-facing ntfy base
|
||||
* URL the app's embedded distributor registers its device topic against; null (or
|
||||
* absent, on an older backend) means push isn't configured for this shard and the
|
||||
* Notifications screen shows it as unavailable.
|
||||
*/
|
||||
@Serializable
|
||||
data class PushConfigDto(
|
||||
val ntfyUrl: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET /public/settings` — whitelisted settings + branding. Only the keys the
|
||||
* app consumes are modeled; other whitelisted keys are ignored.
|
||||
*/
|
||||
@Serializable
|
||||
data class SettingsDto(
|
||||
@SerialName("site_title") val siteTitle: String? = null,
|
||||
@SerialName("status_message") val statusMessage: String? = null,
|
||||
@SerialName("maintenance_message") val maintenanceMessage: String? = null,
|
||||
val registration: RegistrationFlagsDto = RegistrationFlagsDto(),
|
||||
val gameAccountSignup: Boolean = false,
|
||||
val brand: BrandDto = BrandDto(),
|
||||
/** Push relay config (M7); default (null ntfyUrl) on a backend that predates it. */
|
||||
val push: PushConfigDto = PushConfigDto(),
|
||||
)
|
||||
169
app/src/main/java/com/runicgateway/app/data/api/dto/ShardDto.kt
Normal file
169
app/src/main/java/com/runicgateway/app/data/api/dto/ShardDto.kt
Normal file
@@ -0,0 +1,169 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* DTOs for the public shard widgets (PLAN.md §6.2). Shapes mirror the website's
|
||||
* `public/shard.controller.js` responses and the live SSE frames emitted by
|
||||
* `utils/shardBroadcast.js`. The champ/guild/governor board reads return the
|
||||
* stored event payload verbatim (a permissive object), so only the fields the app
|
||||
* renders are modeled; unknown keys are ignored by the JSON parser, and the live
|
||||
* `*.update` frames on `/public/shard/stream` decode into these same DTOs.
|
||||
*/
|
||||
|
||||
/** A game actor (player/leader/governor) as embedded in board payloads. */
|
||||
@Serializable
|
||||
data class ActorDto(
|
||||
val serial: Long? = null,
|
||||
val name: String? = null,
|
||||
val acct: String? = null,
|
||||
val webId: Long? = null,
|
||||
) {
|
||||
/** Best display label for this actor. */
|
||||
val label: String get() = name ?: acct ?: "Someone"
|
||||
}
|
||||
|
||||
/** A gold-supply sample (`economy.supply`), oldest → newest in the series. */
|
||||
@Serializable
|
||||
data class EconomySampleDto(
|
||||
val accounts: Int? = null,
|
||||
val gold: Double? = null,
|
||||
val t: Long? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/shard/status` — connection state + online count + latest economy. */
|
||||
@Serializable
|
||||
data class ShardStatusDto(
|
||||
val enabled: Boolean = false,
|
||||
/** Sidecar link state: `connected` / `disconnected` / … */
|
||||
val status: String? = null,
|
||||
/** Whether the in-game plugin is currently connected to the sidecar. */
|
||||
val pluginConnected: Boolean = false,
|
||||
/** ISO timestamp of the last ingested event, or null. */
|
||||
val lastEventAt: String? = null,
|
||||
val onlineCount: Int = 0,
|
||||
val economy: EconomySampleDto? = null,
|
||||
) {
|
||||
/** True when the shard is live (link enabled and the plugin is connected). */
|
||||
val isOnline: Boolean get() = enabled && pluginConnected
|
||||
}
|
||||
|
||||
/**
|
||||
* `GET /public/shard/feed` — a stored notable event. The domain fields live under
|
||||
* [payload]; the live SSE frames carry those same fields at the top level (see
|
||||
* `ShardEventText`).
|
||||
*/
|
||||
@Serializable
|
||||
data class FeedEventDto(
|
||||
val id: Long = 0,
|
||||
val kind: String = "",
|
||||
val t: Long? = null,
|
||||
val bootId: String? = null,
|
||||
val payload: JsonObject? = null,
|
||||
val createdAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET /public/shard/online` — a staff member currently in-world. Location is only
|
||||
* present for privileged viewers server-side; anonymous/app callers see name+serial.
|
||||
*/
|
||||
@Serializable
|
||||
data class OnlineStaffDto(
|
||||
val serial: Long? = null,
|
||||
val name: String? = null,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val z: Int? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* A house on the public IDOC board (`GET /public/shard/houses`) — location only.
|
||||
* Owner/price/decay detail is staff-only and never reaches the app.
|
||||
*/
|
||||
@Serializable
|
||||
data class HouseDto(
|
||||
val serial: Long = 0,
|
||||
val name: String? = null,
|
||||
val region: String? = null,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val z: Int? = null,
|
||||
val isIdoc: Boolean = false,
|
||||
)
|
||||
|
||||
/**
|
||||
* A champion-spawn board entry (`GET /public/shard/champs` + live `champ.update`).
|
||||
* Three families share the board (`category`: champion / mini / sea); the
|
||||
* category-specific fields are all nullable.
|
||||
*/
|
||||
@Serializable
|
||||
data class ChampDto(
|
||||
val serial: Long = 0,
|
||||
val category: String? = null,
|
||||
val type: String? = null,
|
||||
val name: String? = null,
|
||||
val status: String? = null,
|
||||
val active: Boolean = false,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val z: Int? = null,
|
||||
val bossUp: Boolean = false,
|
||||
val boss: String? = null,
|
||||
val level: Int? = null,
|
||||
val maxLevel: Int? = null,
|
||||
val kills: Int? = null,
|
||||
val maxKills: Int? = null,
|
||||
val hits: Long? = null,
|
||||
val hitsMax: Long? = null,
|
||||
val restartAt: String? = null,
|
||||
val t: Long? = null,
|
||||
)
|
||||
|
||||
/** A guild board entry (`GET /public/shard/guilds` + live `guild.update`). */
|
||||
@Serializable
|
||||
data class GuildDto(
|
||||
val id: Long = 0,
|
||||
val name: String? = null,
|
||||
val abbr: String? = null,
|
||||
val members: Int? = null,
|
||||
val online: Int? = null,
|
||||
val alliance: String? = null,
|
||||
val leader: ActorDto? = null,
|
||||
val t: Long? = null,
|
||||
)
|
||||
|
||||
/** A town-governor board entry (`GET /public/shard/governors` + live `city.update`). */
|
||||
@Serializable
|
||||
data class GovernorDto(
|
||||
val city: String = "",
|
||||
val governor: ActorDto? = null,
|
||||
val governorElect: ActorDto? = null,
|
||||
val electionPhase: String? = null,
|
||||
val t: Long? = null,
|
||||
)
|
||||
|
||||
/** One term in a city's governor ledger (`GET /public/shard/governors/:city/history`). */
|
||||
@Serializable
|
||||
data class GovernorTermDto(
|
||||
val city: String? = null,
|
||||
val governor: ActorDto? = null,
|
||||
val startedAt: Long? = null,
|
||||
val endedAt: Long? = null,
|
||||
val votes: Int? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/shard/presence` — the online-population aggregate (live `presence.online`). */
|
||||
@Serializable
|
||||
data class PresenceDto(
|
||||
val count: Int = 0,
|
||||
val byFacet: Map<String, Int> = emptyMap(),
|
||||
val byRegion: Map<String, Int> = emptyMap(),
|
||||
val t: Long? = null,
|
||||
)
|
||||
@@ -0,0 +1,42 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* Wire shapes for the Mobile SSO Authorization Bridge (PLAN.md §4.2, M9). The
|
||||
* success payload of `/auth/mobile/sso/exchange` is the shared [MobileTokenResponse]
|
||||
* (same pair as `/auth/mobile/login`) — this file only adds the two shapes unique
|
||||
* to the bridge. Every DTO ignores unknown keys (NetworkModule's lenient Json), so
|
||||
* additive backend fields stay safe (§8).
|
||||
*/
|
||||
|
||||
/**
|
||||
* One entry of `GET /auth/providers` — public discovery, never secrets. [icon] is
|
||||
* the provider kind (`google` | `discord` | `oidc` | `oauth2`); the app renders a
|
||||
* button per provider from this list rather than hardcoding a set. [loginUrl] is
|
||||
* the *website* start path (unused by the app, which builds its own
|
||||
* `/auth/mobile/sso/start` URL); kept so the shape matches the backend exactly.
|
||||
*/
|
||||
@Serializable
|
||||
data class SsoProviderDto(
|
||||
val id: String,
|
||||
val name: String,
|
||||
val icon: String? = null,
|
||||
val loginUrl: String? = null,
|
||||
val priority: Int? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* `POST /auth/mobile/sso/exchange` body — the one-time authorization code from the
|
||||
* callback deep link plus the PKCE verifier stashed at `/start` (Layer B). Wire
|
||||
* name is snake_case to match the backend's `{ code, code_verifier }`.
|
||||
*/
|
||||
@Serializable
|
||||
data class MobileSsoExchangeRequest(
|
||||
val code: String,
|
||||
@SerialName("code_verifier") val codeVerifier: String,
|
||||
)
|
||||
@@ -0,0 +1,76 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* Wiki DTOs (website `wiki.model.js` / `wiki.db.js`). The list route returns
|
||||
* lighter summary rows (no body); the detail route returns the full page plus
|
||||
* its tags, backlinks, and unresolved ("red") link targets.
|
||||
*/
|
||||
|
||||
/** `GET /public/wiki` — a summary row (body omitted). */
|
||||
@Serializable
|
||||
data class WikiSummaryDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
val excerpt: String? = null,
|
||||
@SerialName("category_slug") val categorySlug: String? = null,
|
||||
@SerialName("category_title") val categoryTitle: String? = null,
|
||||
@SerialName("updated_at") val updatedAt: String? = null,
|
||||
@SerialName("published_at") val publishedAt: String? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/wiki/:slug` — full page + tags/backlinks. */
|
||||
@Serializable
|
||||
data class WikiPageDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
val body: String? = null,
|
||||
val excerpt: String? = null,
|
||||
@SerialName("category_slug") val categorySlug: String? = null,
|
||||
@SerialName("category_title") val categoryTitle: String? = null,
|
||||
@SerialName("updated_at") val updatedAt: String? = null,
|
||||
@SerialName("published_at") val publishedAt: String? = null,
|
||||
val tags: List<WikiTagRefDto> = emptyList(),
|
||||
val backlinks: List<WikiBacklinkDto> = emptyList(),
|
||||
@SerialName("missing_links") val missingLinks: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
/** A tag as attached to a page (slug + label only). */
|
||||
@Serializable
|
||||
data class WikiTagRefDto(
|
||||
val slug: String = "",
|
||||
val label: String = "",
|
||||
)
|
||||
|
||||
/** A page that links to the current page. */
|
||||
@Serializable
|
||||
data class WikiBacklinkDto(
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
)
|
||||
|
||||
/** `GET /public/wiki/categories`. */
|
||||
@Serializable
|
||||
data class WikiCategoryDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
val description: String? = null,
|
||||
@SerialName("published_count") val publishedCount: Long = 0,
|
||||
)
|
||||
|
||||
/** `GET /public/wiki/tags`. */
|
||||
@Serializable
|
||||
data class WikiTagDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val label: String = "",
|
||||
@SerialName("published_count") val publishedCount: Long = 0,
|
||||
)
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.MeApi
|
||||
import com.runicgateway.app.data.api.dto.ChangePasswordRequest
|
||||
import com.runicgateway.app.data.api.dto.ChangeUsernameRequest
|
||||
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
|
||||
import com.runicgateway.app.data.api.dto.PlayerAccountDto
|
||||
import com.runicgateway.app.data.api.dto.TotpCodeRequest
|
||||
import com.runicgateway.app.data.api.dto.TotpSetupDto
|
||||
import com.runicgateway.app.data.api.dto.TotpStateDto
|
||||
import com.runicgateway.app.data.api.dto.UsernameResponse
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Self-service account management over the role-agnostic `/auth/me/account*`
|
||||
* surface (PLAN.md §6.3, §6.4). Every call returns a typed [ApiResult] so the
|
||||
* screens can map known statuses (409 taken, 400 wrong password / invalid code,
|
||||
* 429 rate-limited) to friendly copy without a repository ever throwing (§7).
|
||||
*/
|
||||
@Singleton
|
||||
class AccountRepository @Inject constructor(
|
||||
private val api: MeApi,
|
||||
) {
|
||||
suspend fun getAccount(): ApiResult<PlayerAccountDto> = safeApiCall { api.getAccount() }
|
||||
|
||||
suspend fun changeUsername(username: String): ApiResult<UsernameResponse> =
|
||||
safeApiCall { api.changeUsername(ChangeUsernameRequest(username)) }
|
||||
|
||||
/** [currentPassword] is null only for an SSO account setting its first password. */
|
||||
suspend fun changePassword(newPassword: String, currentPassword: String?): ApiResult<Unit> =
|
||||
safeApiCall { api.changePassword(ChangePasswordRequest(newPassword, currentPassword)) }
|
||||
|
||||
suspend fun totpSetup(): ApiResult<TotpSetupDto> = safeApiCall { api.totpSetup() }
|
||||
|
||||
suspend fun totpEnable(code: String): ApiResult<TotpStateDto> =
|
||||
safeApiCall { api.totpEnable(TotpCodeRequest(code)) }
|
||||
|
||||
suspend fun totpDisable(code: String): ApiResult<TotpStateDto> =
|
||||
safeApiCall { api.totpDisable(TotpCodeRequest(code)) }
|
||||
|
||||
suspend fun identities(): ApiResult<List<LinkedIdentityDto>> = safeApiCall { api.identities() }
|
||||
|
||||
suspend fun unlinkIdentity(provider: String): ApiResult<Unit> =
|
||||
safeApiCall { api.unlinkIdentity(provider) }
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.data.api.AuthApi
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import com.runicgateway.app.data.api.dto.MobileLoginRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileLogoutRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileTokenResponse
|
||||
import com.runicgateway.app.data.api.dto.SsoProviderDto
|
||||
import com.runicgateway.app.data.api.dto.TotpRequiredError
|
||||
import kotlinx.coroutines.CancellationException
|
||||
import kotlinx.serialization.json.Json
|
||||
import retrofit2.Response
|
||||
import java.io.IOException
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Native username/password (+TOTP) auth — the app's only native credential flow
|
||||
* (PLAN.md §4.1). It drives the [SessionManager]: a successful login establishes
|
||||
* the session; logout revokes it. Registration/invite/reset/SSO are website
|
||||
* hand-offs (§4.2), not here.
|
||||
*/
|
||||
@Singleton
|
||||
class AuthRepository @Inject constructor(
|
||||
private val authApi: AuthApi,
|
||||
private val ssoApi: SsoApi,
|
||||
private val sessionManager: SessionManager,
|
||||
private val pushManager: PushManager,
|
||||
private val json: Json,
|
||||
) {
|
||||
|
||||
/**
|
||||
* The shard's enabled SSO providers for the native login buttons (§4.2). Public
|
||||
* discovery, never secrets. Returns an empty list on any failure — the login
|
||||
* screen then keeps the website hand-off fallback rather than showing nothing.
|
||||
*/
|
||||
suspend fun ssoProviders(): List<SsoProviderDto> = try {
|
||||
ssoApi.providers()
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: Exception) {
|
||||
emptyList()
|
||||
}
|
||||
|
||||
/** Outcome of a login attempt (§4.1). */
|
||||
sealed interface LoginResult {
|
||||
data object Success : LoginResult
|
||||
|
||||
/** The account has 2FA on — reveal the code field and resubmit with a code. */
|
||||
data object TotpRequired : LoginResult
|
||||
data object InvalidCredentials : LoginResult
|
||||
|
||||
/** Guarded by per-IP backoff → slowdown → hard cap; back off and retry. */
|
||||
data object RateLimited : LoginResult
|
||||
|
||||
/** Any other server failure (5xx / unexpected). */
|
||||
data object ServerError : LoginResult
|
||||
|
||||
/** No answer — offline, DNS, TLS, timeout. */
|
||||
data object NetworkError : LoginResult
|
||||
}
|
||||
|
||||
suspend fun login(username: String, password: String, code: String? = null): LoginResult {
|
||||
val response: Response<MobileTokenResponse> = try {
|
||||
authApi.login(MobileLoginRequest(username = username, password = password, code = code))
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: IOException) {
|
||||
return LoginResult.NetworkError
|
||||
}
|
||||
|
||||
if (response.isSuccessful) {
|
||||
val body = response.body() ?: return LoginResult.ServerError
|
||||
sessionManager.onSignedIn(body.accessToken, body.refreshToken, body.user)
|
||||
return LoginResult.Success
|
||||
}
|
||||
|
||||
return when (response.code()) {
|
||||
401 -> if (isTotpRequired(response)) LoginResult.TotpRequired else LoginResult.InvalidCredentials
|
||||
429 -> LoginResult.RateLimited
|
||||
else -> LoginResult.ServerError
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke this session (or, with [allDevices], every session) and clear local
|
||||
* tokens (§4.3). Best-effort: the local session is torn down even if the
|
||||
* network call fails, so the user is always signed out locally.
|
||||
*/
|
||||
suspend fun logout(allDevices: Boolean = false) {
|
||||
// Deregister this device's push endpoint while the bearer is still valid, so
|
||||
// no orphan device row is left behind (§11). Keeps the opt-in intent so push
|
||||
// resumes on the next sign-in; best-effort, never blocks the logout.
|
||||
try {
|
||||
pushManager.deregisterDevice()
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: Exception) {
|
||||
// Ignore — local session teardown proceeds regardless.
|
||||
}
|
||||
val refreshToken = sessionManager.currentRefreshToken()
|
||||
try {
|
||||
authApi.logout(MobileLogoutRequest(refreshToken = refreshToken, all = allDevices))
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: Exception) {
|
||||
// Ignore — we still drop the local session below.
|
||||
}
|
||||
sessionManager.onSignedOut()
|
||||
}
|
||||
|
||||
/**
|
||||
* Re-validate the session against `GET /auth/me` on app resume (§4.3). A
|
||||
* success refreshes the cached role (roles change server-side); a `401` that
|
||||
* survives the silent refresh means the session is dead → sign out. Transient
|
||||
* failures are ignored so a flaky network doesn't bounce the user.
|
||||
*/
|
||||
suspend fun revalidate() {
|
||||
if (!sessionManager.isSignedIn) return
|
||||
try {
|
||||
val me = authApi.me()
|
||||
sessionManager.onUserRefreshed(me.user)
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (e: retrofit2.HttpException) {
|
||||
if (e.code() == 401) sessionManager.onSignedOut()
|
||||
} catch (_: IOException) {
|
||||
// Offline — keep the session; the next authed call will re-check.
|
||||
}
|
||||
}
|
||||
|
||||
private fun isTotpRequired(response: Response<*>): Boolean = try {
|
||||
val raw = response.errorBody()?.string()
|
||||
!raw.isNullOrBlank() && json.decodeFromString<TotpRequiredError>(raw).totpRequired
|
||||
} catch (_: Exception) {
|
||||
false
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,147 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.core.net.ServerUrl
|
||||
import com.runicgateway.app.core.prefs.ServerPreferences
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import okhttp3.HttpUrl.Companion.toHttpUrlOrNull
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Owns the shard website base-URL lifecycle (PLAN.md §3): restoring a saved URL
|
||||
* on launch, validating + persisting a candidate on the first-run connect
|
||||
* screen, and the hard reset performed by a Settings → Server switch.
|
||||
*/
|
||||
@Singleton
|
||||
class ConnectionRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
private val prefs: ServerPreferences,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val sessionManager: SessionManager,
|
||||
private val pushManager: com.runicgateway.app.core.push.PushManager,
|
||||
private val config: com.runicgateway.app.core.AppConfig,
|
||||
) {
|
||||
|
||||
/** Outcome of validating a candidate base URL against a live site. */
|
||||
sealed interface ProbeResult {
|
||||
data class Success(val status: StatusDto) : ProbeResult
|
||||
data class InvalidUrl(val reason: ServerUrl.Reason) : ProbeResult
|
||||
|
||||
/** Reachable and 2xx, but not a Runic Gateway backend (wrong version identity). */
|
||||
data object NotRunicGateway : ProbeResult
|
||||
|
||||
/**
|
||||
* A Runic Gateway backend, but speaking an API version this app build does
|
||||
* not support (§3 version guard) — refuse rather than mis-render. [serverApi]
|
||||
* is what the site reported; [supportedApi] is what this app speaks.
|
||||
*/
|
||||
data class VersionMismatch(val serverApi: String, val supportedApi: String) : ProbeResult
|
||||
data class ServerError(val status: Int) : ProbeResult
|
||||
data class Unreachable(val cause: Throwable) : ProbeResult
|
||||
}
|
||||
|
||||
/** True once a saved base URL has been loaded into the holder. */
|
||||
val isConnected: Boolean get() = baseUrlHolder.current != null
|
||||
|
||||
/**
|
||||
* Restore any saved base URL into the holder on launch. Returns true if the
|
||||
* app already has a configured shard site (skip the connect screen).
|
||||
*/
|
||||
suspend fun restore(): Boolean {
|
||||
val saved = prefs.currentBaseUrl()?.toHttpUrlOrNull()
|
||||
baseUrlHolder.set(saved)
|
||||
return saved != null
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate [rawUrl], and on success persist it and activate it for all
|
||||
* subsequent API calls. Insecure HTTP is allowed only in debug builds
|
||||
* (local dev against 127.0.0.1); release builds require HTTPS.
|
||||
*/
|
||||
suspend fun probeAndConnect(rawUrl: String): ProbeResult {
|
||||
val normalized = when (val r = ServerUrl.normalize(rawUrl, allowInsecureHttp = config.allowInsecureHttp)) {
|
||||
is ServerUrl.Result.Invalid -> return ProbeResult.InvalidUrl(r.reason)
|
||||
is ServerUrl.Result.Valid -> r.url
|
||||
}
|
||||
|
||||
val statusUrl = normalized.resolve("api/v1/public/status")?.toString()
|
||||
?: return ProbeResult.InvalidUrl(ServerUrl.Reason.MALFORMED)
|
||||
|
||||
return when (val result = safeApiCall { api.probeStatus(statusUrl) }) {
|
||||
is ApiResult.Ok -> when (val verdict = evaluateVersion(result.data.version)) {
|
||||
is VersionVerdict.Ok -> {
|
||||
prefs.setBaseUrl(normalized.toString())
|
||||
baseUrlHolder.set(normalized)
|
||||
ProbeResult.Success(result.data)
|
||||
}
|
||||
is VersionVerdict.NotRunicGateway -> ProbeResult.NotRunicGateway
|
||||
is VersionVerdict.Mismatch ->
|
||||
ProbeResult.VersionMismatch(serverApi = verdict.serverApi, supportedApi = SUPPORTED_API)
|
||||
}
|
||||
is ApiResult.HttpError -> ProbeResult.ServerError(result.status)
|
||||
is ApiResult.NetworkError -> ProbeResult.Unreachable(result.cause)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Hard reset for a Settings → Server switch (§3): sign out (clear stored
|
||||
* tokens), clear the saved URL, and deactivate it — the app returns to a
|
||||
* signed-out state against the new host.
|
||||
*/
|
||||
suspend fun disconnect() {
|
||||
// Deregister the push endpoint on the current (old) host while still authed,
|
||||
// then clear the shard's ntfy URL — the new host advertises its own (§11).
|
||||
try {
|
||||
pushManager.deregisterDevice()
|
||||
} catch (_: Exception) {
|
||||
// Best-effort; the reset proceeds regardless.
|
||||
}
|
||||
pushManager.setNtfyUrl(null)
|
||||
sessionManager.onSignedOut()
|
||||
prefs.clear()
|
||||
baseUrlHolder.set(null)
|
||||
}
|
||||
|
||||
/** The pure outcome of inspecting a probed site's [VersionDto] (§3 version guard). */
|
||||
internal sealed interface VersionVerdict {
|
||||
data object Ok : VersionVerdict
|
||||
data object NotRunicGateway : VersionVerdict
|
||||
data class Mismatch(val serverApi: String) : VersionVerdict
|
||||
}
|
||||
|
||||
internal companion object {
|
||||
const val RUNIC_SERVICE_ID = "runic-gateway"
|
||||
|
||||
/** The backend API major version this app build speaks (matches `/public/version` `api`). */
|
||||
const val SUPPORTED_API = "v1"
|
||||
|
||||
/**
|
||||
* Decide whether a probed site is a Runic Gateway backend this app can talk
|
||||
* to. Pure (no I/O) so it is unit-testable without a live site. Lenient on a
|
||||
* blank `api` (an older backend that predates version surfacing); refuses only
|
||||
* an API version we positively know we can't parse (e.g. a future `v2`).
|
||||
*/
|
||||
fun evaluateVersion(
|
||||
version: com.runicgateway.app.data.api.dto.VersionDto,
|
||||
supportedApi: String = SUPPORTED_API,
|
||||
): VersionVerdict {
|
||||
if (!version.service.trim().equals(RUNIC_SERVICE_ID, ignoreCase = true)) {
|
||||
return VersionVerdict.NotRunicGateway
|
||||
}
|
||||
val serverApi = version.api.trim()
|
||||
return when {
|
||||
serverApi.isEmpty() -> VersionVerdict.Ok
|
||||
serverApi.equals(supportedApi, ignoreCase = true) -> VersionVerdict.Ok
|
||||
else -> VersionVerdict.Mismatch(serverApi)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.ContactRequest
|
||||
import com.runicgateway.app.data.api.dto.ContactResponse
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Contact form submission (PLAN.md §6.1). The endpoint is rate-limited; the
|
||||
* caller handles `429` (too many) and `502` (mailer down) via [ApiResult.HttpError].
|
||||
*/
|
||||
@Singleton
|
||||
class ContactRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
suspend fun send(name: String, email: String, message: String): ApiResult<ContactResponse> =
|
||||
safeApiCall { api.postContact(ContactRequest(name = name, email = email, message = message)) }
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.PageDto
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* News posts and CMS pages (PLAN.md §6.1). URL post categories map 1:1 to the
|
||||
* backend's route segments (`news | five-on-friday | newsletter | screenshots`).
|
||||
*/
|
||||
@Singleton
|
||||
class ContentRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
/** Known URL categories, in display order. */
|
||||
enum class PostCategory(val urlSlug: String) {
|
||||
NEWS("news"),
|
||||
FIVE_ON_FRIDAY("five-on-friday"),
|
||||
NEWSLETTER("newsletter"),
|
||||
SCREENSHOTS("screenshots"),
|
||||
;
|
||||
|
||||
companion object {
|
||||
fun fromUrlSlug(slug: String?): PostCategory? = entries.firstOrNull { it.urlSlug == slug }
|
||||
}
|
||||
}
|
||||
|
||||
suspend fun getPosts(category: PostCategory): ApiResult<List<PostDto>> =
|
||||
safeApiCall { api.getPosts(category.urlSlug) }
|
||||
|
||||
suspend fun getPost(category: PostCategory, idOrSlug: String): ApiResult<PostDto> =
|
||||
safeApiCall { api.getPost(category.urlSlug, idOrSlug) }
|
||||
|
||||
suspend fun getPage(slug: String): ApiResult<PageDto> =
|
||||
safeApiCall { api.getPage(slug) }
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.NotificationsApi
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
|
||||
import com.runicgateway.app.data.api.dto.PushDeviceDto
|
||||
import com.runicgateway.app.data.api.dto.RegisterDeviceRequest
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Device registration + per-user stream subscriptions over the opt-in push surface
|
||||
* (PLAN.md §11, M7 Part 2). Every call returns a typed [ApiResult] so the screen
|
||||
* and the [com.runicgateway.app.core.push.PushManager] degrade gracefully — a `400`
|
||||
* (endpoint off the shard's allow-set) or a down backend never throws (§7).
|
||||
*/
|
||||
@Singleton
|
||||
class NotificationsRepository @Inject constructor(
|
||||
private val api: NotificationsApi,
|
||||
) {
|
||||
suspend fun registerDevice(endpoint: String, platform: String?): ApiResult<PushDeviceDto> =
|
||||
safeApiCall { api.registerDevice(RegisterDeviceRequest(endpoint = endpoint, platform = platform)) }
|
||||
|
||||
suspend fun listDevices(): ApiResult<List<PushDeviceDto>> = safeApiCall { api.listDevices() }
|
||||
|
||||
suspend fun deleteDevice(id: Long): ApiResult<Unit> = safeApiCall { api.deleteDevice(id) }
|
||||
|
||||
suspend fun streams(): ApiResult<NotificationStreamsDto> = safeApiCall { api.streams() }
|
||||
|
||||
suspend fun subscriptions(): ApiResult<NotificationSubscriptionsDto> =
|
||||
safeApiCall { api.subscriptions() }
|
||||
|
||||
suspend fun setSubscriptions(streams: List<String>): ApiResult<NotificationSubscriptionsDto> =
|
||||
safeApiCall { api.putSubscriptions(NotificationSubscriptionsDto(streams)) }
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PlayerShardApi
|
||||
import com.runicgateway.app.data.api.dto.CharProfileDto
|
||||
import com.runicgateway.app.data.api.dto.CreateGameAccountRequest
|
||||
import com.runicgateway.app.data.api.dto.PlayerHouseDto
|
||||
import com.runicgateway.app.data.api.dto.RosterDto
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkDto
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkRequest
|
||||
import com.runicgateway.app.data.api.dto.ShardLinkResultDto
|
||||
import com.runicgateway.app.data.api.dto.VendorSaleDto
|
||||
import com.runicgateway.app.data.api.dto.VendorSnapshotDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* A player's own game data + game-account linking (PLAN.md §6.3), over the
|
||||
* bearer-gated `/player/shard/…` surface. Every read returns a typed [ApiResult]
|
||||
* so a down shard (`503`) renders as "offline, retry" and a not-linked account
|
||||
* (`403`) is handled cleanly — the repository never throws for an expected
|
||||
* failure (§7). Ownership is enforced server-side.
|
||||
*/
|
||||
@Singleton
|
||||
class PlayerShardRepository @Inject constructor(
|
||||
private val api: PlayerShardApi,
|
||||
) {
|
||||
suspend fun link(code: String): ApiResult<ShardLinkResultDto> =
|
||||
safeApiCall { api.link(ShardLinkRequest(code)) }
|
||||
|
||||
suspend fun createAccount(account: String, password: String): ApiResult<ShardLinkResultDto> =
|
||||
safeApiCall { api.createAccount(CreateGameAccountRequest(account, password)) }
|
||||
|
||||
suspend fun accounts(): ApiResult<List<ShardLinkDto>> = safeApiCall { api.accounts() }
|
||||
|
||||
suspend fun roster(account: String): ApiResult<RosterDto> = safeApiCall { api.roster(account) }
|
||||
|
||||
suspend fun char(serial: String): ApiResult<CharProfileDto> = safeApiCall { api.char(serial) }
|
||||
|
||||
suspend fun vendors(account: String): ApiResult<VendorSnapshotDto> =
|
||||
safeApiCall { api.vendors(account) }
|
||||
|
||||
suspend fun sales(): ApiResult<List<VendorSaleDto>> = safeApiCall { api.sales() }
|
||||
|
||||
suspend fun houses(): ApiResult<List<PlayerHouseDto>> = safeApiCall { api.houses() }
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/** Site status (mode/maintenance) and settings/branding (PLAN.md §6.1). */
|
||||
@Singleton
|
||||
class SettingsRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
suspend fun getStatus(): ApiResult<StatusDto> = safeApiCall { api.getStatus() }
|
||||
|
||||
suspend fun getSettings(): ApiResult<SettingsDto> = safeApiCall { api.getSettings() }
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.net.ShardStreamClient
|
||||
import com.runicgateway.app.core.net.ShardStreamEvent
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.ChampDto
|
||||
import com.runicgateway.app.data.api.dto.EconomySampleDto
|
||||
import com.runicgateway.app.data.api.dto.FeedEventDto
|
||||
import com.runicgateway.app.data.api.dto.GovernorDto
|
||||
import com.runicgateway.app.data.api.dto.GovernorTermDto
|
||||
import com.runicgateway.app.data.api.dto.GuildDto
|
||||
import com.runicgateway.app.data.api.dto.HouseDto
|
||||
import com.runicgateway.app.data.api.dto.OnlineStaffDto
|
||||
import com.runicgateway.app.data.api.dto.PresenceDto
|
||||
import com.runicgateway.app.data.api.dto.ShardStatusDto
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.serialization.KSerializer
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The public shard widgets (PLAN.md §6.2): point-in-time board snapshots over
|
||||
* the `/public/shard/…` GETs plus the live SSE stream. Every read returns a typed
|
||||
* [ApiResult] so a down shard renders as offline (§7); [liveEvents] is the shared
|
||||
* SSE feed the boards merge in place. Live `*.update` frames decode into the same
|
||||
* DTOs as the snapshot reads via the `*Frame` decoders.
|
||||
*/
|
||||
@Singleton
|
||||
class ShardRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
private val stream: ShardStreamClient,
|
||||
private val json: Json,
|
||||
) {
|
||||
// ── Snapshots ────────────────────────────────────────────────────────
|
||||
suspend fun status(): ApiResult<ShardStatusDto> = safeApiCall { api.getShardStatus() }
|
||||
|
||||
suspend fun feed(limit: Int = 40): ApiResult<List<FeedEventDto>> =
|
||||
safeApiCall { api.getShardFeed(limit = limit) }
|
||||
|
||||
suspend fun economy(limit: Int = 100): ApiResult<List<EconomySampleDto>> =
|
||||
safeApiCall { api.getShardEconomy(limit) }
|
||||
|
||||
suspend fun online(): ApiResult<List<OnlineStaffDto>> = safeApiCall { api.getShardOnline() }
|
||||
|
||||
suspend fun presence(): ApiResult<PresenceDto> = safeApiCall { api.getShardPresence() }
|
||||
|
||||
suspend fun champs(): ApiResult<List<ChampDto>> = safeApiCall { api.getShardChamps() }
|
||||
|
||||
suspend fun guilds(): ApiResult<List<GuildDto>> = safeApiCall { api.getShardGuilds() }
|
||||
|
||||
suspend fun governors(): ApiResult<List<GovernorDto>> = safeApiCall { api.getShardGovernors() }
|
||||
|
||||
suspend fun governorHistory(city: String, limit: Int = 25): ApiResult<List<GovernorTermDto>> =
|
||||
safeApiCall { api.getShardGovernorHistory(city, limit) }
|
||||
|
||||
suspend fun houses(): ApiResult<List<HouseDto>> = safeApiCall { api.getShardHouses() }
|
||||
|
||||
// ── Live stream ──────────────────────────────────────────────────────
|
||||
/** The shared public SSE feed (safe kinds only), reconnecting with backoff (§7). */
|
||||
fun liveEvents(): Flow<ShardStreamEvent> = stream.events()
|
||||
|
||||
// Decode a live `*.update` frame into the board DTO it mirrors; null on shape
|
||||
// mismatch so a malformed frame is skipped rather than crashing the board.
|
||||
fun champFrame(obj: JsonObject): ChampDto? = decode(obj, ChampDto.serializer())
|
||||
fun guildFrame(obj: JsonObject): GuildDto? = decode(obj, GuildDto.serializer())
|
||||
fun governorFrame(obj: JsonObject): GovernorDto? = decode(obj, GovernorDto.serializer())
|
||||
fun presenceFrame(obj: JsonObject): PresenceDto? = decode(obj, PresenceDto.serializer())
|
||||
|
||||
private fun <T> decode(obj: JsonObject, serializer: KSerializer<T>): T? = try {
|
||||
json.decodeFromJsonElement(serializer, obj)
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiPageDto
|
||||
import com.runicgateway.app.data.api.dto.WikiSummaryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiTagDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/** Wiki listing/filtering, categories, tags, and detail (PLAN.md §6.1). */
|
||||
@Singleton
|
||||
class WikiRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
/** Full-text [query] takes precedence over [category]/[tag] on the backend. */
|
||||
suspend fun getPages(
|
||||
query: String? = null,
|
||||
category: String? = null,
|
||||
tag: String? = null,
|
||||
): ApiResult<List<WikiSummaryDto>> =
|
||||
safeApiCall { api.getWikiPages(query?.takeIf { it.isNotBlank() }, category, tag) }
|
||||
|
||||
suspend fun getCategories(): ApiResult<List<WikiCategoryDto>> =
|
||||
safeApiCall { api.getWikiCategories() }
|
||||
|
||||
suspend fun getTags(): ApiResult<List<WikiTagDto>> =
|
||||
safeApiCall { api.getWikiTags() }
|
||||
|
||||
suspend fun getPage(slug: String): ApiResult<WikiPageDto> =
|
||||
safeApiCall { api.getWikiPage(slug) }
|
||||
}
|
||||
24
app/src/main/java/com/runicgateway/app/di/AppModule.kt
Normal file
24
app/src/main/java/com/runicgateway/app/di/AppModule.kt
Normal file
@@ -0,0 +1,24 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.di
|
||||
|
||||
import com.runicgateway.app.BuildConfig
|
||||
import com.runicgateway.app.core.AppConfig
|
||||
import dagger.Module
|
||||
import dagger.Provides
|
||||
import dagger.hilt.InstallIn
|
||||
import dagger.hilt.components.SingletonComponent
|
||||
import javax.inject.Singleton
|
||||
|
||||
@Module
|
||||
@InstallIn(SingletonComponent::class)
|
||||
object AppModule {
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideAppConfig(): AppConfig = AppConfig(
|
||||
allowInsecureHttp = BuildConfig.DEBUG,
|
||||
versionName = BuildConfig.VERSION_NAME,
|
||||
)
|
||||
}
|
||||
146
app/src/main/java/com/runicgateway/app/di/NetworkModule.kt
Normal file
146
app/src/main/java/com/runicgateway/app/di/NetworkModule.kt
Normal file
@@ -0,0 +1,146 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.di
|
||||
|
||||
import android.os.Build
|
||||
import com.jakewharton.retrofit2.converter.kotlinx.serialization.asConverterFactory
|
||||
import com.runicgateway.app.BuildConfig
|
||||
import com.runicgateway.app.core.net.AuthInterceptor
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.core.net.HostSelectionInterceptor
|
||||
import com.runicgateway.app.core.net.TokenAuthenticator
|
||||
import com.runicgateway.app.core.net.UserAgentInterceptor
|
||||
import com.runicgateway.app.data.api.AuthApi
|
||||
import com.runicgateway.app.data.api.AuthRefreshApi
|
||||
import com.runicgateway.app.data.api.MeApi
|
||||
import com.runicgateway.app.data.api.NotificationsApi
|
||||
import com.runicgateway.app.data.api.PlayerShardApi
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import dagger.Module
|
||||
import dagger.Provides
|
||||
import dagger.hilt.InstallIn
|
||||
import dagger.hilt.components.SingletonComponent
|
||||
import kotlinx.serialization.json.Json
|
||||
import okhttp3.MediaType.Companion.toMediaType
|
||||
import okhttp3.OkHttpClient
|
||||
import okhttp3.logging.HttpLoggingInterceptor
|
||||
import retrofit2.Retrofit
|
||||
import javax.inject.Singleton
|
||||
|
||||
@Module
|
||||
@InstallIn(SingletonComponent::class)
|
||||
object NetworkModule {
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideJson(): Json = Json {
|
||||
// Additive backend fields (§8) must never break decoding; be lenient.
|
||||
ignoreUnknownKeys = true
|
||||
explicitNulls = false
|
||||
coerceInputValues = true
|
||||
}
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideUserAgentInterceptor(): UserAgentInterceptor {
|
||||
// Identifiable UA so the site's scanner guard (§8) doesn't reject the app.
|
||||
val ua = "RunicGatewayApp/${BuildConfig.VERSION_NAME} (Android ${Build.VERSION.RELEASE})"
|
||||
return UserAgentInterceptor(ua)
|
||||
}
|
||||
|
||||
/**
|
||||
* The main client every API and the SSE stream ride on. Order: identify (UA),
|
||||
* retarget onto the configured shard host, then attach the bearer; the
|
||||
* [TokenAuthenticator] handles silent refresh-on-401 (§4.1). Logging sits last
|
||||
* so it observes the final, authed request.
|
||||
*/
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideOkHttpClient(
|
||||
hostSelectionInterceptor: HostSelectionInterceptor,
|
||||
userAgentInterceptor: UserAgentInterceptor,
|
||||
authInterceptor: AuthInterceptor,
|
||||
tokenAuthenticator: TokenAuthenticator,
|
||||
): OkHttpClient {
|
||||
val builder = OkHttpClient.Builder()
|
||||
.addInterceptor(userAgentInterceptor)
|
||||
.addInterceptor(hostSelectionInterceptor)
|
||||
.addInterceptor(authInterceptor)
|
||||
.authenticator(tokenAuthenticator)
|
||||
|
||||
if (BuildConfig.DEBUG) {
|
||||
builder.addInterceptor(
|
||||
HttpLoggingInterceptor().apply { level = HttpLoggingInterceptor.Level.BASIC },
|
||||
)
|
||||
}
|
||||
return builder.build()
|
||||
}
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideRetrofit(client: OkHttpClient, json: Json): Retrofit =
|
||||
Retrofit.Builder()
|
||||
// Compile-time sentinel; every relative call is rewritten onto the
|
||||
// runtime-selected shard site by HostSelectionInterceptor (§3).
|
||||
.baseUrl(BaseUrlHolder.PLACEHOLDER_BASE_URL)
|
||||
.client(client)
|
||||
.addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
|
||||
.build()
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun providePublicApi(retrofit: Retrofit): PublicApi = retrofit.create(PublicApi::class.java)
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideAuthApi(retrofit: Retrofit): AuthApi = retrofit.create(AuthApi::class.java)
|
||||
|
||||
/** Native SSO discovery + code exchange (§4.2, M9) — on the main client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideSsoApi(retrofit: Retrofit): SsoApi = retrofit.create(SsoApi::class.java)
|
||||
|
||||
/** Role-agnostic self-service (§6.4) — bearer-authed on the main client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideMeApi(retrofit: Retrofit): MeApi = retrofit.create(MeApi::class.java)
|
||||
|
||||
/** A player's own game data + linking (§6.3) — bearer-authed on the main client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun providePlayerShardApi(retrofit: Retrofit): PlayerShardApi =
|
||||
retrofit.create(PlayerShardApi::class.java)
|
||||
|
||||
/** Opt-in push devices + subscriptions (§11, M7) — bearer-authed on the main client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideNotificationsApi(retrofit: Retrofit): NotificationsApi =
|
||||
retrofit.create(NotificationsApi::class.java)
|
||||
|
||||
/**
|
||||
* Token refresh runs on its own **bare** client — UA + host retargeting only,
|
||||
* no auth interceptor and no authenticator — so a refresh can never recurse
|
||||
* back through [TokenAuthenticator] (§4.3). This throwaway client/Retrofit is
|
||||
* not exposed as a bean, so there is no ambiguous [OkHttpClient] binding.
|
||||
*/
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideAuthRefreshApi(
|
||||
hostSelectionInterceptor: HostSelectionInterceptor,
|
||||
userAgentInterceptor: UserAgentInterceptor,
|
||||
json: Json,
|
||||
): AuthRefreshApi {
|
||||
val bareClient = OkHttpClient.Builder()
|
||||
.addInterceptor(userAgentInterceptor)
|
||||
.addInterceptor(hostSelectionInterceptor)
|
||||
.build()
|
||||
val retrofit = Retrofit.Builder()
|
||||
.baseUrl(BaseUrlHolder.PLACEHOLDER_BASE_URL)
|
||||
.client(bareClient)
|
||||
.addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
|
||||
.build()
|
||||
return retrofit.create(AuthRefreshApi::class.java)
|
||||
}
|
||||
}
|
||||
22
app/src/main/java/com/runicgateway/app/di/StorageModule.kt
Normal file
22
app/src/main/java/com/runicgateway/app/di/StorageModule.kt
Normal file
@@ -0,0 +1,22 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.di
|
||||
|
||||
import com.runicgateway.app.core.auth.EncryptedTokenStore
|
||||
import com.runicgateway.app.core.auth.TokenStore
|
||||
import dagger.Binds
|
||||
import dagger.Module
|
||||
import dagger.hilt.InstallIn
|
||||
import dagger.hilt.components.SingletonComponent
|
||||
import javax.inject.Singleton
|
||||
|
||||
/** Binds the at-rest token store to its EncryptedSharedPreferences impl (§4.3). */
|
||||
@Module
|
||||
@InstallIn(SingletonComponent::class)
|
||||
abstract class StorageModule {
|
||||
|
||||
@Binds
|
||||
@Singleton
|
||||
abstract fun bindTokenStore(impl: EncryptedTokenStore): TokenStore
|
||||
}
|
||||
93
app/src/main/java/com/runicgateway/app/ui/AppViewModel.kt
Normal file
93
app/src/main/java/com/runicgateway/app/ui/AppViewModel.kt
Normal file
@@ -0,0 +1,93 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.data.repository.ConnectionRepository
|
||||
import com.runicgateway.app.data.repository.SettingsRepository
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Top-level app gate (PLAN.md §3): decides whether the first-run connect screen
|
||||
* or the main UI shows, and holds the per-shard branding the theme is seeded
|
||||
* from. Activity-scoped so the whole app observes one state.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AppViewModel @Inject constructor(
|
||||
private val connectionRepository: ConnectionRepository,
|
||||
private val settingsRepository: SettingsRepository,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val pushManager: PushManager,
|
||||
) : ViewModel() {
|
||||
|
||||
sealed interface AppState {
|
||||
/** Restoring the saved base URL / loading branding. */
|
||||
data object Loading : AppState
|
||||
|
||||
/** No shard site configured yet — show the connect screen. */
|
||||
data object NeedsConnection : AppState
|
||||
|
||||
/** A site is configured; [brand] is null if branding couldn't be loaded (still usable). */
|
||||
data class Ready(val brand: BrandDto?) : AppState
|
||||
}
|
||||
|
||||
private val _state = MutableStateFlow<AppState>(AppState.Loading)
|
||||
val state: StateFlow<AppState> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
_state.value = if (connectionRepository.restore()) {
|
||||
AppState.Ready(loadBrand())
|
||||
} else {
|
||||
AppState.NeedsConnection
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Called by the connect screen once a site has been validated + saved. */
|
||||
fun onConnected() {
|
||||
viewModelScope.launch { _state.value = AppState.Ready(loadBrand()) }
|
||||
}
|
||||
|
||||
/** Settings → Server switch: hard reset back to the connect screen (§3). */
|
||||
fun changeServer() {
|
||||
viewModelScope.launch {
|
||||
connectionRepository.disconnect()
|
||||
_state.value = AppState.NeedsConnection
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load public settings for branding and feed the shard's push relay URL into the
|
||||
* [PushManager] (§11) — its arrival is what lets push re-register after a restart
|
||||
* or sign-in. Returns the brand block (null if settings couldn't be loaded).
|
||||
*/
|
||||
private suspend fun loadBrand(): BrandDto? {
|
||||
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data
|
||||
pushManager.setNtfyUrl(settings?.push?.ntfyUrl)
|
||||
return settings?.brand
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve a possibly site-relative asset path (branding logos, post images)
|
||||
* to an absolute URL against the configured base (§8: asset fields may be
|
||||
* site-relative). Absolute URLs pass through unchanged; null/blank stays null.
|
||||
*/
|
||||
fun resolveAsset(path: String?): String? {
|
||||
if (path.isNullOrBlank()) return null
|
||||
val base = baseUrlHolder.current ?: return path
|
||||
return base.resolve(path)?.toString() ?: path
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import androidx.compose.runtime.staticCompositionLocalOf
|
||||
|
||||
/**
|
||||
* Resolves possibly site-relative asset paths (post images, branding) to
|
||||
* absolute URLs against the configured base URL. Provided at the app root from
|
||||
* [AppViewModel.resolveAsset] so any screen or CMS block can turn a stored path
|
||||
* into a loadable URL without reaching into the network layer.
|
||||
*/
|
||||
val LocalAssetResolver = staticCompositionLocalOf<(String?) -> String?> {
|
||||
// Default: identity. Overridden at the app root; this fallback keeps previews
|
||||
// and tests from crashing if the provider is missing.
|
||||
{ it }
|
||||
}
|
||||
383
app/src/main/java/com/runicgateway/app/ui/RunicApp.kt
Normal file
383
app/src/main/java/com/runicgateway/app/ui/RunicApp.kt
Normal file
@@ -0,0 +1,383 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Menu
|
||||
import androidx.compose.material3.DrawerValue
|
||||
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||
import androidx.compose.material3.HorizontalDivider
|
||||
import androidx.compose.material3.Icon
|
||||
import androidx.compose.material3.IconButton
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ModalDrawerSheet
|
||||
import androidx.compose.material3.ModalNavigationDrawer
|
||||
import androidx.compose.material3.NavigationDrawerItem
|
||||
import androidx.compose.material3.NavigationDrawerItemDefaults
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.material3.TopAppBarDefaults
|
||||
import androidx.compose.material3.rememberDrawerState
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.rememberCoroutineScope
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.style.TextOverflow
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.compose.ui.unit.sp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.LifecycleResumeEffect
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import androidx.navigation.NavHostController
|
||||
import androidx.navigation.NavType
|
||||
import androidx.navigation.compose.NavHost
|
||||
import androidx.navigation.compose.composable
|
||||
import androidx.navigation.compose.currentBackStackEntryAsState
|
||||
import androidx.navigation.compose.rememberNavController
|
||||
import androidx.navigation.navArgument
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.auth.Session
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.ui.auth.AccountScreen
|
||||
import com.runicgateway.app.ui.auth.LoginScreen
|
||||
import com.runicgateway.app.ui.auth.roleLabelRes
|
||||
import com.runicgateway.app.ui.contact.ContactScreen
|
||||
import com.runicgateway.app.ui.home.HomeScreen
|
||||
import com.runicgateway.app.ui.navigation.APP_MENU
|
||||
import com.runicgateway.app.ui.navigation.Routes
|
||||
import com.runicgateway.app.ui.navigation.visibleEntries
|
||||
import com.runicgateway.app.ui.news.NewsScreen
|
||||
import com.runicgateway.app.ui.news.PostScreen
|
||||
import com.runicgateway.app.ui.notifications.NotificationsScreen
|
||||
import com.runicgateway.app.ui.page.PageScreen
|
||||
import com.runicgateway.app.ui.player.CharacterSheetScreen
|
||||
import com.runicgateway.app.ui.player.CharactersScreen
|
||||
import com.runicgateway.app.ui.player.MyHousesScreen
|
||||
import com.runicgateway.app.ui.player.VendorsScreen
|
||||
import com.runicgateway.app.ui.session.SessionViewModel
|
||||
import com.runicgateway.app.ui.shard.ChampsScreen
|
||||
import com.runicgateway.app.ui.shard.GovernorsScreen
|
||||
import com.runicgateway.app.ui.shard.GuildsScreen
|
||||
import com.runicgateway.app.ui.shard.HousesScreen
|
||||
import com.runicgateway.app.ui.shard.ShardBoard
|
||||
import com.runicgateway.app.ui.shard.ShardScreen
|
||||
import com.runicgateway.app.ui.wiki.WikiPageScreen
|
||||
import com.runicgateway.app.ui.wiki.WikiScreen
|
||||
import kotlinx.coroutines.launch
|
||||
|
||||
/** Destinations that show the drawer (hamburger); others show a back arrow. */
|
||||
private val TOP_LEVEL_ROUTES = setOf(
|
||||
Routes.HOME, Routes.NEWS, Routes.WIKI, Routes.SHARD, Routes.CONTACT, Routes.PAGE, Routes.ACCOUNT,
|
||||
Routes.NOTIFICATIONS,
|
||||
Routes.PLAYER_CHARACTERS, Routes.PLAYER_VENDORS, Routes.PLAYER_HOUSES,
|
||||
)
|
||||
|
||||
/**
|
||||
* The main app shell once a shard site is configured (PLAN.md §5): one shared,
|
||||
* declarative, access-level navigation drawer whose entries are filtered by the
|
||||
* current session, plus the Sign in / Sign out toggle and the Settings → Server
|
||||
* switch. The signed-in role is re-validated against the backend on every resume
|
||||
* (§4.3), so a server-side demotion drops menu access promptly.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun RunicApp(
|
||||
brand: BrandDto?,
|
||||
onChangeServer: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
deepLinkStream: String? = null,
|
||||
onDeepLinkConsumed: () -> Unit = {},
|
||||
sessionViewModel: SessionViewModel = hiltViewModel(),
|
||||
) {
|
||||
val navController = rememberNavController()
|
||||
val drawerState = rememberDrawerState(DrawerValue.Closed)
|
||||
val scope = rememberCoroutineScope()
|
||||
|
||||
val session by sessionViewModel.session.collectAsStateWithLifecycle()
|
||||
|
||||
// Re-validate the cached role each time the app returns to the foreground (§4.3).
|
||||
LifecycleResumeEffect(Unit) {
|
||||
sessionViewModel.revalidate()
|
||||
onPauseOrDispose { }
|
||||
}
|
||||
|
||||
// A tapped push notification deep-links to its stream's screen (§11, item 7).
|
||||
LaunchedEffect(deepLinkStream) {
|
||||
val stream = deepLinkStream ?: return@LaunchedEffect
|
||||
navController.navigate(Routes.forStream(stream)) {
|
||||
popUpTo(Routes.HOME) { saveState = true }
|
||||
launchSingleTop = true
|
||||
}
|
||||
onDeepLinkConsumed()
|
||||
}
|
||||
|
||||
val backStackEntry by navController.currentBackStackEntryAsState()
|
||||
val currentRoute = backStackEntry?.destination?.route
|
||||
val isTopLevel = currentRoute in TOP_LEVEL_ROUTES
|
||||
val entries = visibleEntries(APP_MENU, session)
|
||||
|
||||
ModalNavigationDrawer(
|
||||
drawerState = drawerState,
|
||||
gesturesEnabled = isTopLevel,
|
||||
drawerContent = {
|
||||
ModalDrawerSheet(drawerContainerColor = MaterialTheme.colorScheme.surfaceVariant) {
|
||||
val drawerItemColors = NavigationDrawerItemDefaults.colors(
|
||||
selectedContainerColor = MaterialTheme.colorScheme.secondaryContainer,
|
||||
selectedTextColor = MaterialTheme.colorScheme.onSecondaryContainer,
|
||||
unselectedTextColor = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
Spacer(Modifier.height(12.dp))
|
||||
Text(
|
||||
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
|
||||
style = MaterialTheme.typography.titleLarge,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
modifier = Modifier.padding(horizontal = 24.dp, vertical = 12.dp),
|
||||
)
|
||||
HorizontalDivider()
|
||||
Spacer(Modifier.height(8.dp))
|
||||
entries.forEach { entry ->
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(entry.labelRes)) },
|
||||
selected = currentRoute == entry.route,
|
||||
onClick = {
|
||||
scope.launch { drawerState.close() }
|
||||
navController.navigateTopLevel(entry.route)
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
}
|
||||
|
||||
HorizontalDivider(Modifier.padding(vertical = 8.dp))
|
||||
|
||||
// Sign in / Sign out toggles on the session (§5).
|
||||
val signInLabel = if (session is Session.SignedIn) {
|
||||
R.string.menu_sign_out
|
||||
} else {
|
||||
R.string.menu_sign_in
|
||||
}
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(signInLabel)) },
|
||||
selected = false,
|
||||
onClick = {
|
||||
scope.launch { drawerState.close() }
|
||||
if (session is Session.SignedIn) {
|
||||
sessionViewModel.signOut()
|
||||
navController.navigateTopLevel(Routes.HOME)
|
||||
} else {
|
||||
navController.navigate(Routes.LOGIN)
|
||||
}
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(R.string.menu_change_server)) },
|
||||
selected = false,
|
||||
onClick = {
|
||||
scope.launch { drawerState.close() }
|
||||
onChangeServer()
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
}
|
||||
},
|
||||
) {
|
||||
Scaffold(
|
||||
modifier = modifier,
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
colors = TopAppBarDefaults.topAppBarColors(
|
||||
containerColor = MaterialTheme.colorScheme.surfaceVariant,
|
||||
titleContentColor = MaterialTheme.colorScheme.onSurface,
|
||||
navigationIconContentColor = MaterialTheme.colorScheme.onSurface,
|
||||
actionIconContentColor = MaterialTheme.colorScheme.onSurface,
|
||||
),
|
||||
title = {
|
||||
Text(
|
||||
text = (brand?.name?.takeIf { it.isNotBlank() }
|
||||
?: stringResource(R.string.app_name)).uppercase(),
|
||||
style = MaterialTheme.typography.titleSmall.copy(letterSpacing = 1.2.sp),
|
||||
maxLines = 1,
|
||||
overflow = TextOverflow.Ellipsis,
|
||||
)
|
||||
},
|
||||
navigationIcon = {
|
||||
if (isTopLevel) {
|
||||
IconButton(onClick = { scope.launch { drawerState.open() } }) {
|
||||
Icon(Icons.Filled.Menu, stringResource(R.string.nav_open_menu))
|
||||
}
|
||||
} else {
|
||||
IconButton(onClick = { navController.popBackStack() }) {
|
||||
Icon(
|
||||
Icons.AutoMirrored.Filled.ArrowBack,
|
||||
stringResource(R.string.action_back),
|
||||
)
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
},
|
||||
) { innerPadding ->
|
||||
RunicNavHost(
|
||||
navController = navController,
|
||||
brand = brand,
|
||||
session = session,
|
||||
onSignOut = { sessionViewModel.signOut() },
|
||||
onSignOutEverywhere = { sessionViewModel.signOut(allDevices = true) },
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun RunicNavHost(
|
||||
navController: NavHostController,
|
||||
brand: BrandDto?,
|
||||
session: Session,
|
||||
onSignOut: () -> Unit,
|
||||
onSignOutEverywhere: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
NavHost(
|
||||
navController = navController,
|
||||
startDestination = Routes.HOME,
|
||||
modifier = modifier,
|
||||
) {
|
||||
composable(Routes.HOME) {
|
||||
HomeScreen(brand = brand)
|
||||
}
|
||||
composable(Routes.NEWS) {
|
||||
NewsScreen(onOpenPost = { category, idOrSlug ->
|
||||
navController.navigate(Routes.post(category, idOrSlug))
|
||||
})
|
||||
}
|
||||
composable(
|
||||
route = Routes.POST,
|
||||
arguments = listOf(
|
||||
navArgument(Routes.Args.CATEGORY) { type = NavType.StringType },
|
||||
navArgument(Routes.Args.ID_OR_SLUG) { type = NavType.StringType },
|
||||
),
|
||||
) {
|
||||
PostScreen()
|
||||
}
|
||||
composable(Routes.SHARD) {
|
||||
ShardScreen(onOpenBoard = { board ->
|
||||
navController.navigate(
|
||||
when (board) {
|
||||
ShardBoard.CHAMPS -> Routes.SHARD_CHAMPS
|
||||
ShardBoard.GUILDS -> Routes.SHARD_GUILDS
|
||||
ShardBoard.GOVERNORS -> Routes.SHARD_GOVERNORS
|
||||
ShardBoard.HOUSES -> Routes.SHARD_HOUSES
|
||||
},
|
||||
)
|
||||
})
|
||||
}
|
||||
composable(Routes.SHARD_CHAMPS) { ChampsScreen() }
|
||||
composable(Routes.SHARD_GUILDS) { GuildsScreen() }
|
||||
composable(Routes.SHARD_GOVERNORS) { GovernorsScreen() }
|
||||
composable(Routes.SHARD_HOUSES) { HousesScreen() }
|
||||
composable(Routes.WIKI) {
|
||||
WikiScreen(onOpenPage = { slug -> navController.navigate(Routes.wikiPage(slug)) })
|
||||
}
|
||||
composable(
|
||||
route = Routes.WIKI_PAGE,
|
||||
arguments = listOf(navArgument(Routes.Args.SLUG) { type = NavType.StringType }),
|
||||
) {
|
||||
WikiPageScreen(onOpenPage = { slug -> navController.navigate(Routes.wikiPage(slug)) })
|
||||
}
|
||||
composable(
|
||||
route = Routes.PAGE,
|
||||
arguments = listOf(navArgument(Routes.Args.SLUG) { type = NavType.StringType }),
|
||||
) {
|
||||
PageScreen()
|
||||
}
|
||||
composable(Routes.CONTACT) {
|
||||
ContactScreen()
|
||||
}
|
||||
composable(Routes.LOGIN) {
|
||||
LoginScreen(onSignedIn = { navController.popBackStack() })
|
||||
}
|
||||
composable(Routes.ACCOUNT) {
|
||||
// Only meaningful while signed in; a sign-out (here or from the drawer)
|
||||
// sends the user home rather than leaving a stale identity on screen.
|
||||
when (val s = session) {
|
||||
is Session.SignedIn -> AccountScreen(
|
||||
username = s.user.username,
|
||||
roleLabel = stringResource(roleLabelRes(s.user.role)),
|
||||
onSignOut = onSignOut,
|
||||
onSignOutEverywhere = onSignOutEverywhere,
|
||||
)
|
||||
Session.SignedOut -> LaunchedEffect(Unit) {
|
||||
navController.navigateTopLevel(Routes.HOME)
|
||||
}
|
||||
}
|
||||
}
|
||||
composable(Routes.NOTIFICATIONS) {
|
||||
// Signed-in only; a sign-out (or demotion) sends the user home rather than
|
||||
// leaving stale settings up. The backend gates every call regardless (§5).
|
||||
when (session) {
|
||||
is Session.SignedIn -> NotificationsScreen()
|
||||
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
|
||||
}
|
||||
}
|
||||
|
||||
// ── Player game data (§6.3) — reached from the player-only menu groups.
|
||||
// The server enforces the player gate on every call; these screens simply
|
||||
// render 401/403/503 as clean states (§7).
|
||||
composable(Routes.PLAYER_CHARACTERS) {
|
||||
PlayerGate(session, navController) {
|
||||
CharactersScreen(onOpenChar = { serial -> navController.navigate(Routes.playerChar(serial)) })
|
||||
}
|
||||
}
|
||||
composable(
|
||||
route = Routes.PLAYER_CHAR,
|
||||
arguments = listOf(navArgument(Routes.Args.SERIAL) { type = NavType.StringType }),
|
||||
) {
|
||||
CharacterSheetScreen()
|
||||
}
|
||||
composable(Routes.PLAYER_VENDORS) {
|
||||
PlayerGate(session, navController) { VendorsScreen() }
|
||||
}
|
||||
composable(Routes.PLAYER_HOUSES) {
|
||||
PlayerGate(session, navController) { MyHousesScreen() }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A UX guard for the player-only groups: while signed in, render [content]; if the
|
||||
* session drops (sign-out, or a server-side demotion caught on resume, §4.3), send
|
||||
* the user home instead of leaving a stale player screen up. The backend remains
|
||||
* the authority — this only mirrors the menu's visibility rule.
|
||||
*/
|
||||
@Composable
|
||||
private fun PlayerGate(
|
||||
session: Session,
|
||||
navController: NavHostController,
|
||||
content: @Composable () -> Unit,
|
||||
) {
|
||||
when (session) {
|
||||
is Session.SignedIn -> content()
|
||||
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
|
||||
}
|
||||
}
|
||||
|
||||
/** Navigate to a top-level menu destination: single instance, reset to it. */
|
||||
private fun NavHostController.navigateTopLevel(route: String) {
|
||||
navigate(route) {
|
||||
popUpTo(Routes.HOME) { saveState = true }
|
||||
launchSingleTop = true
|
||||
restoreState = true
|
||||
}
|
||||
}
|
||||
54
app/src/main/java/com/runicgateway/app/ui/UiState.kt
Normal file
54
app/src/main/java/com/runicgateway/app/ui/UiState.kt
Normal file
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
|
||||
/**
|
||||
* The load state a screen renders. View models expose a `StateFlow<UiState<T>>`;
|
||||
* the Compose layer renders loading / content / error+retry from it (PLAN.md §7:
|
||||
* clean loading/error/retry states, no crash on a down backend).
|
||||
*/
|
||||
sealed interface UiState<out T> {
|
||||
data object Loading : UiState<Nothing>
|
||||
data class Success<T>(val data: T) : UiState<T>
|
||||
data class Error(val kind: ErrorKind, val httpStatus: Int? = null) : UiState<Nothing>
|
||||
}
|
||||
|
||||
/**
|
||||
* Coarse failure buckets the UI turns into a friendly message + retry. Kept
|
||||
* transport-agnostic so a screen picks the right copy without inspecting raw
|
||||
* exceptions or status codes.
|
||||
*/
|
||||
enum class ErrorKind {
|
||||
/** No answer from the backend — offline, DNS, TLS, timeout. */
|
||||
NETWORK,
|
||||
|
||||
/** Requested item doesn't exist (404). */
|
||||
NOT_FOUND,
|
||||
|
||||
/** Too many requests (429) — back off and retry shortly. */
|
||||
RATE_LIMITED,
|
||||
|
||||
/** Shard/sidecar down (503) — shard reads only; render as offline (§6.3). */
|
||||
SHARD_OFFLINE,
|
||||
|
||||
/** Any other non-2xx server response. */
|
||||
SERVER,
|
||||
}
|
||||
|
||||
/** Fold an [ApiResult] into a [UiState], mapping known statuses to [ErrorKind]s. */
|
||||
fun <T> ApiResult<T>.toUiState(): UiState<T> = when (this) {
|
||||
is ApiResult.Ok -> UiState.Success(data)
|
||||
is ApiResult.NetworkError -> UiState.Error(ErrorKind.NETWORK)
|
||||
is ApiResult.HttpError -> UiState.Error(
|
||||
kind = when (status) {
|
||||
404 -> ErrorKind.NOT_FOUND
|
||||
429 -> ErrorKind.RATE_LIMITED
|
||||
503 -> ErrorKind.SHARD_OFFLINE
|
||||
else -> ErrorKind.SERVER
|
||||
},
|
||||
httpStatus = status,
|
||||
)
|
||||
}
|
||||
362
app/src/main/java/com/runicgateway/app/ui/auth/AccountScreen.kt
Normal file
362
app/src/main/java/com/runicgateway/app/ui/auth/AccountScreen.kt
Normal file
@@ -0,0 +1,362 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.auth
|
||||
|
||||
import android.graphics.BitmapFactory
|
||||
import android.util.Base64
|
||||
import androidx.annotation.StringRes
|
||||
import androidx.compose.foundation.Image
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Row
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextButton
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.compose.runtime.saveable.rememberSaveable
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.asImageBitmap
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.text.input.PasswordVisualTransformation
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.ui.graphics.ImageBitmap
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.auth.Role
|
||||
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
|
||||
import com.runicgateway.app.data.api.dto.PlayerAccountDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.auth.AccountViewModel.Feedback
|
||||
import com.runicgateway.app.ui.auth.AccountViewModel.Section
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.components.PillTone
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* The signed-in account surface (PLAN.md §5, §6.3): identity + role, self-service
|
||||
* over `/auth/me/account*` (change username/password, TOTP, linked identities),
|
||||
* and the sign-out controls. Credential-provisioning flows (register / reset / SSO
|
||||
* link) stay website hand-offs (§4.2) and are not rebuilt here.
|
||||
*/
|
||||
@Composable
|
||||
fun AccountScreen(
|
||||
username: String,
|
||||
roleLabel: String,
|
||||
onSignOut: () -> Unit,
|
||||
onSignOutEverywhere: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AccountViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(16.dp),
|
||||
) {
|
||||
IdentityCard(username = username, roleLabel = roleLabel)
|
||||
|
||||
when (val account = state.account) {
|
||||
is UiState.Loading -> LoadingView(Modifier.padding(top = 32.dp))
|
||||
is UiState.Error -> ErrorView(account.kind, onRetry = viewModel::load, modifier = Modifier.padding(top = 32.dp))
|
||||
is UiState.Success -> AccountSections(account.data, state, viewModel)
|
||||
}
|
||||
|
||||
HorizontalDivider(Modifier.padding(vertical = 20.dp))
|
||||
|
||||
OutlinedButton(onClick = onSignOut, modifier = Modifier.fillMaxWidth()) {
|
||||
Text(stringResource(R.string.account_sign_out))
|
||||
}
|
||||
TextButton(
|
||||
onClick = onSignOutEverywhere,
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 4.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.account_sign_out_all))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun IdentityCard(username: String, roleLabel: String) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(20.dp)) {
|
||||
Text(text = username, style = MaterialTheme.typography.titleLarge)
|
||||
StatusPill(
|
||||
text = roleLabel,
|
||||
tone = PillTone.Info,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun AccountSections(
|
||||
account: PlayerAccountDto,
|
||||
state: AccountViewModel.State,
|
||||
viewModel: AccountViewModel,
|
||||
) {
|
||||
UsernameSection(account, state, viewModel)
|
||||
PasswordSection(account, state, viewModel)
|
||||
TwoFactorSection(account, state, viewModel)
|
||||
IdentitiesSection(state, viewModel)
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun SectionCard(@StringRes titleRes: Int, content: @Composable () -> Unit) {
|
||||
Card(Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(titleRes), style = MaterialTheme.typography.titleMedium)
|
||||
content()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun UsernameSection(
|
||||
account: PlayerAccountDto,
|
||||
state: AccountViewModel.State,
|
||||
viewModel: AccountViewModel,
|
||||
) {
|
||||
var username by rememberSaveable(account.username) { mutableStateOf(account.username) }
|
||||
SectionCard(R.string.account_username_title) {
|
||||
OutlinedTextField(
|
||||
value = username,
|
||||
onValueChange = { username = it },
|
||||
singleLine = true,
|
||||
enabled = !state.busy,
|
||||
label = { Text(stringResource(R.string.login_username)) },
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
|
||||
)
|
||||
Button(
|
||||
onClick = { viewModel.changeUsername(username) },
|
||||
enabled = !state.busy && username.trim() != account.username && username.trim().length >= 3,
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
) { Text(stringResource(R.string.account_username_action)) }
|
||||
SectionFeedback(state.feedback, Section.USERNAME)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PasswordSection(
|
||||
account: PlayerAccountDto,
|
||||
state: AccountViewModel.State,
|
||||
viewModel: AccountViewModel,
|
||||
) {
|
||||
val hasPassword = account.has_password
|
||||
var current by rememberSaveable { mutableStateOf("") }
|
||||
var next by rememberSaveable { mutableStateOf("") }
|
||||
SectionCard(if (hasPassword) R.string.account_password_title else R.string.account_password_set_title) {
|
||||
if (!hasPassword) {
|
||||
Text(
|
||||
stringResource(R.string.account_password_set_hint),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
}
|
||||
if (hasPassword) {
|
||||
OutlinedTextField(
|
||||
value = current,
|
||||
onValueChange = { current = it },
|
||||
singleLine = true,
|
||||
enabled = !state.busy,
|
||||
label = { Text(stringResource(R.string.account_password_current)) },
|
||||
visualTransformation = PasswordVisualTransformation(),
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password),
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
OutlinedTextField(
|
||||
value = next,
|
||||
onValueChange = { next = it },
|
||||
singleLine = true,
|
||||
enabled = !state.busy,
|
||||
label = { Text(stringResource(R.string.account_password_new)) },
|
||||
visualTransformation = PasswordVisualTransformation(),
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password),
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
|
||||
)
|
||||
Button(
|
||||
onClick = {
|
||||
viewModel.changePassword(next, if (hasPassword) current else null)
|
||||
current = ""
|
||||
next = ""
|
||||
},
|
||||
enabled = !state.busy && next.length >= 8 && (!hasPassword || current.isNotBlank()),
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
) {
|
||||
Text(stringResource(if (hasPassword) R.string.account_password_action else R.string.account_password_set_action))
|
||||
}
|
||||
SectionFeedback(state.feedback, Section.PASSWORD)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun TwoFactorSection(
|
||||
account: PlayerAccountDto,
|
||||
state: AccountViewModel.State,
|
||||
viewModel: AccountViewModel,
|
||||
) {
|
||||
var code by rememberSaveable { mutableStateOf("") }
|
||||
SectionCard(R.string.account_totp_title) {
|
||||
StatusPill(
|
||||
text = stringResource(if (account.totp_enabled) R.string.account_totp_on else R.string.account_totp_off),
|
||||
tone = if (account.totp_enabled) PillTone.Success else PillTone.Neutral,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
|
||||
when {
|
||||
// Enabled → offer disable via a current code.
|
||||
account.totp_enabled -> {
|
||||
CodeField(code, { code = it }, !state.busy)
|
||||
Button(
|
||||
onClick = { viewModel.disableTotp(code); code = "" },
|
||||
enabled = !state.busy && code.isNotBlank(),
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
) { Text(stringResource(R.string.account_totp_disable)) }
|
||||
}
|
||||
// Mid-enrollment → show QR + confirm.
|
||||
state.totpSetup != null -> {
|
||||
Text(
|
||||
stringResource(R.string.account_totp_scan),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
)
|
||||
rememberQrBitmap(state.totpSetup.qr)?.let { bmp ->
|
||||
Image(
|
||||
bitmap = bmp,
|
||||
contentDescription = stringResource(R.string.account_totp_qr_desc),
|
||||
modifier = Modifier.padding(top = 12.dp).size(180.dp),
|
||||
)
|
||||
}
|
||||
CodeField(code, { code = it }, !state.busy)
|
||||
Row(Modifier.padding(top = 12.dp), horizontalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Button(
|
||||
onClick = { viewModel.enableTotp(code); code = "" },
|
||||
enabled = !state.busy && code.isNotBlank(),
|
||||
) { Text(stringResource(R.string.account_totp_confirm)) }
|
||||
OutlinedButton(onClick = { viewModel.cancelTotp(); code = "" }, enabled = !state.busy) {
|
||||
Text(stringResource(R.string.account_totp_cancel))
|
||||
}
|
||||
}
|
||||
}
|
||||
// Not enabled, not enrolling → start.
|
||||
else -> {
|
||||
Button(
|
||||
onClick = viewModel::beginTotp,
|
||||
enabled = !state.busy,
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
) { Text(stringResource(R.string.account_totp_setup)) }
|
||||
}
|
||||
}
|
||||
SectionFeedback(state.feedback, Section.TOTP)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun IdentitiesSection(state: AccountViewModel.State, viewModel: AccountViewModel) {
|
||||
SectionCard(R.string.account_identities_title) {
|
||||
if (state.identities.isEmpty()) {
|
||||
Text(
|
||||
stringResource(R.string.account_identities_empty),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
} else {
|
||||
state.identities.forEach { identity -> IdentityRow(identity, state.busy, viewModel) }
|
||||
}
|
||||
SectionFeedback(state.feedback, Section.IDENTITY)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun IdentityRow(identity: LinkedIdentityDto, busy: Boolean, viewModel: AccountViewModel) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(top = 12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Column(Modifier.weight(1f)) {
|
||||
Text(
|
||||
identity.provider.replaceFirstChar { it.uppercase() },
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
)
|
||||
identity.email?.let {
|
||||
Text(it, style = MaterialTheme.typography.bodySmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
}
|
||||
TextButton(onClick = { viewModel.unlinkIdentity(identity.provider) }, enabled = !busy) {
|
||||
Text(stringResource(R.string.account_identity_unlink))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun CodeField(code: String, onChange: (String) -> Unit, enabled: Boolean) {
|
||||
OutlinedTextField(
|
||||
value = code,
|
||||
onValueChange = { onChange(it.filter(Char::isDigit).take(8)) },
|
||||
singleLine = true,
|
||||
enabled = enabled,
|
||||
label = { Text(stringResource(R.string.login_totp_code)) },
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.NumberPassword),
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun SectionFeedback(feedback: Feedback?, section: Section) {
|
||||
if (feedback == null || feedback.section != section) return
|
||||
Text(
|
||||
text = stringResource(feedback.messageRes),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = if (feedback.ok) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.padding(top = 10.dp),
|
||||
)
|
||||
}
|
||||
|
||||
/** Decode a `data:image/png;base64,…` URL (the TOTP QR) into an [ImageBitmap]. */
|
||||
@Composable
|
||||
private fun rememberQrBitmap(dataUrl: String?): ImageBitmap? = remember(dataUrl) {
|
||||
if (dataUrl.isNullOrBlank()) return@remember null
|
||||
val comma = dataUrl.indexOf(',')
|
||||
if (comma < 0) return@remember null
|
||||
runCatching {
|
||||
val bytes = Base64.decode(dataUrl.substring(comma + 1), Base64.DEFAULT)
|
||||
BitmapFactory.decodeByteArray(bytes, 0, bytes.size)?.asImageBitmap()
|
||||
}.getOrNull()
|
||||
}
|
||||
|
||||
/** Human label for a role (advisory display only — §4.3). */
|
||||
@StringRes
|
||||
fun roleLabelRes(role: Role): Int = when (role) {
|
||||
Role.PLAYER -> R.string.role_player
|
||||
Role.MODERATOR -> R.string.role_moderator
|
||||
Role.EDITOR -> R.string.role_editor
|
||||
Role.ADMIN -> R.string.role_admin
|
||||
Role.UNKNOWN -> R.string.role_unknown
|
||||
}
|
||||
@@ -0,0 +1,185 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.auth
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
|
||||
import com.runicgateway.app.data.api.dto.PlayerAccountDto
|
||||
import com.runicgateway.app.data.api.dto.TotpSetupDto
|
||||
import com.runicgateway.app.data.repository.AccountRepository
|
||||
import com.runicgateway.app.data.repository.AuthRepository
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Drives the signed-in self-service surface (PLAN.md §6.3, §6.4) over
|
||||
* `/auth/me/account*`: change username/password, enroll/disable TOTP, and manage
|
||||
* linked SSO identities. Each mutation folds its [ApiResult] into a section-scoped
|
||||
* [Feedback] so the screen shows friendly, localized copy inline (§7). A username
|
||||
* change also re-validates the session so the shell reflects the new name at once.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AccountViewModel @Inject constructor(
|
||||
private val accountRepository: AccountRepository,
|
||||
private val authRepository: AuthRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
/** Which section an action's [Feedback] belongs to, so it renders in place. */
|
||||
enum class Section { USERNAME, PASSWORD, TOTP, IDENTITY }
|
||||
|
||||
/** A one-shot result banner under a section. */
|
||||
data class Feedback(val section: Section, val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val account: UiState<PlayerAccountDto> = UiState.Loading,
|
||||
val identities: List<LinkedIdentityDto> = emptyList(),
|
||||
/** True while any mutation is in flight (disables that section's controls). */
|
||||
val busy: Boolean = false,
|
||||
/** The pending TOTP enrollment (QR shown) between setup and enable. */
|
||||
val totpSetup: TotpSetupDto? = null,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(account = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
val account = accountRepository.getAccount()
|
||||
_state.update { it.copy(account = account.toUiState()) }
|
||||
// Identities are non-critical — an empty list on failure is fine.
|
||||
when (val ids = accountRepository.identities()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(identities = ids.data) }
|
||||
else -> Unit
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
// ── Username ─────────────────────────────────────────────────────────
|
||||
fun changeUsername(username: String) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = accountRepository.changeUsername(username.trim())) {
|
||||
is ApiResult.Ok -> {
|
||||
finish(Section.USERNAME, true, R.string.account_username_changed)
|
||||
// Reflect the new name in the shell + refresh the loaded account.
|
||||
authRepository.revalidate()
|
||||
reloadAccount()
|
||||
}
|
||||
else -> finish(Section.USERNAME, false, usernameErrorRes(result))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Password ─────────────────────────────────────────────────────────
|
||||
fun changePassword(newPassword: String, currentPassword: String?) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (accountRepository.changePassword(newPassword, currentPassword?.takeIf { it.isNotBlank() })) {
|
||||
is ApiResult.Ok -> finish(Section.PASSWORD, true, R.string.account_password_changed)
|
||||
is ApiResult.HttpError -> finish(Section.PASSWORD, false, R.string.account_password_error)
|
||||
is ApiResult.NetworkError -> finish(Section.PASSWORD, false, R.string.error_network)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── TOTP ─────────────────────────────────────────────────────────────
|
||||
fun beginTotp() {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = accountRepository.totpSetup()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(busy = false, totpSetup = result.data) }
|
||||
else -> finish(Section.TOTP, false, R.string.account_totp_setup_error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun cancelTotp() = _state.update { it.copy(totpSetup = null, feedback = null) }
|
||||
|
||||
fun enableTotp(code: String) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (accountRepository.totpEnable(code.trim())) {
|
||||
is ApiResult.Ok -> {
|
||||
_state.update { it.copy(totpSetup = null) }
|
||||
finish(Section.TOTP, true, R.string.account_totp_enabled)
|
||||
reloadAccount()
|
||||
}
|
||||
is ApiResult.HttpError -> finish(Section.TOTP, false, R.string.account_totp_code_error)
|
||||
is ApiResult.NetworkError -> finish(Section.TOTP, false, R.string.error_network)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun disableTotp(code: String) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (accountRepository.totpDisable(code.trim())) {
|
||||
is ApiResult.Ok -> {
|
||||
finish(Section.TOTP, true, R.string.account_totp_disabled)
|
||||
reloadAccount()
|
||||
}
|
||||
is ApiResult.HttpError -> finish(Section.TOTP, false, R.string.account_totp_code_error)
|
||||
is ApiResult.NetworkError -> finish(Section.TOTP, false, R.string.error_network)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Identities ───────────────────────────────────────────────────────
|
||||
fun unlinkIdentity(provider: String) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (accountRepository.unlinkIdentity(provider)) {
|
||||
is ApiResult.Ok -> {
|
||||
finish(Section.IDENTITY, true, R.string.account_identity_unlinked)
|
||||
when (val ids = accountRepository.identities()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(identities = ids.data) }
|
||||
else -> Unit
|
||||
}
|
||||
}
|
||||
else -> finish(Section.IDENTITY, false, R.string.account_identity_error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private suspend fun reloadAccount() {
|
||||
when (val account = accountRepository.getAccount()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(account = UiState.Success(account.data)) }
|
||||
else -> Unit
|
||||
}
|
||||
}
|
||||
|
||||
private fun finish(section: Section, ok: Boolean, @StringRes messageRes: Int) =
|
||||
_state.update { it.copy(busy = false, feedback = Feedback(section, ok, messageRes)) }
|
||||
|
||||
private fun usernameErrorRes(result: ApiResult<*>): Int = when {
|
||||
result is ApiResult.HttpError && result.status == 409 -> R.string.account_username_taken
|
||||
result is ApiResult.NetworkError -> R.string.error_network
|
||||
else -> R.string.account_username_error
|
||||
}
|
||||
}
|
||||
211
app/src/main/java/com/runicgateway/app/ui/auth/LoginScreen.kt
Normal file
211
app/src/main/java/com/runicgateway/app/ui/auth/LoginScreen.kt
Normal file
@@ -0,0 +1,211 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.auth
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.text.KeyboardActions
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextButton
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.ImeAction
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.text.input.PasswordVisualTransformation
|
||||
import androidx.compose.ui.text.style.TextAlign
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.web.WebHandoff
|
||||
import com.runicgateway.app.ui.auth.LoginViewModel.LoginError
|
||||
|
||||
/**
|
||||
* Native username/password (+TOTP) login (PLAN.md §4.1) — the app's only native
|
||||
* credential screen. Registration, forgot-password, and SSO are website hand-offs
|
||||
* opened in a Custom Tab (§4.2); the user completes them in the browser and
|
||||
* returns here to sign in.
|
||||
*/
|
||||
@Composable
|
||||
fun LoginScreen(
|
||||
onSignedIn: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: LoginViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
val context = LocalContext.current
|
||||
|
||||
LaunchedEffect(state.signedIn) {
|
||||
if (state.signedIn) onSignedIn()
|
||||
}
|
||||
|
||||
// Open a freshly-minted SSO /start URL in a Custom Tab, exactly once (§4.2).
|
||||
LaunchedEffect(state.ssoLaunchUrl) {
|
||||
val url = state.ssoLaunchUrl ?: return@LaunchedEffect
|
||||
WebHandoff.open(context, url)
|
||||
viewModel.onSsoLaunchConsumed()
|
||||
}
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(24.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.Center,
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(R.string.login_title),
|
||||
style = MaterialTheme.typography.headlineSmall,
|
||||
textAlign = TextAlign.Center,
|
||||
)
|
||||
Text(
|
||||
text = stringResource(R.string.login_subtitle),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
textAlign = TextAlign.Center,
|
||||
modifier = Modifier.padding(top = 8.dp, bottom = 24.dp),
|
||||
)
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.username,
|
||||
onValueChange = viewModel::onUsernameChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
label = { Text(stringResource(R.string.login_username)) },
|
||||
keyboardOptions = KeyboardOptions(
|
||||
keyboardType = KeyboardType.Text,
|
||||
imeAction = ImeAction.Next,
|
||||
),
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.password,
|
||||
onValueChange = viewModel::onPasswordChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
label = { Text(stringResource(R.string.login_password)) },
|
||||
visualTransformation = PasswordVisualTransformation(),
|
||||
keyboardOptions = KeyboardOptions(
|
||||
keyboardType = KeyboardType.Password,
|
||||
imeAction = if (state.totpRequired) ImeAction.Next else ImeAction.Go,
|
||||
),
|
||||
keyboardActions = KeyboardActions(onGo = { viewModel.submit() }),
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 12.dp),
|
||||
)
|
||||
|
||||
if (state.totpRequired) {
|
||||
OutlinedTextField(
|
||||
value = state.code,
|
||||
onValueChange = viewModel::onCodeChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
label = { Text(stringResource(R.string.login_totp_code)) },
|
||||
supportingText = { Text(stringResource(R.string.login_totp_hint)) },
|
||||
keyboardOptions = KeyboardOptions(
|
||||
keyboardType = KeyboardType.NumberPassword,
|
||||
imeAction = ImeAction.Go,
|
||||
),
|
||||
keyboardActions = KeyboardActions(onGo = { viewModel.submit() }),
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
state.error?.let { err ->
|
||||
Text(
|
||||
text = stringResource(loginErrorRes(err)),
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
textAlign = TextAlign.Center,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
Button(
|
||||
onClick = viewModel::submit,
|
||||
enabled = !state.submitting,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 20.dp),
|
||||
) {
|
||||
if (state.submitting) {
|
||||
CircularProgressIndicator(
|
||||
strokeWidth = 2.dp,
|
||||
modifier = Modifier.size(20.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary,
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(R.string.login_button))
|
||||
}
|
||||
}
|
||||
|
||||
// ── Native SSO (§4.2, M9): a button per enabled provider that opens the
|
||||
// Custom-Tab bridge and returns the user signed in. Falls back to the
|
||||
// website login hand-off when the shard exposes no providers.
|
||||
if (state.ssoProviders.isNotEmpty()) {
|
||||
state.ssoProviders.forEach { provider ->
|
||||
OutlinedButton(
|
||||
onClick = { viewModel.onSsoProviderClick(provider) },
|
||||
enabled = !state.submitting,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 12.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.login_sso_provider, provider.name))
|
||||
}
|
||||
}
|
||||
} else {
|
||||
viewModel.ssoLoginUrl?.let { url ->
|
||||
TextButton(onClick = { WebHandoff.open(context, url) }) {
|
||||
Text(stringResource(R.string.login_sso))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Website hand-offs (§4.2): open the site's own pages in a Custom Tab ──
|
||||
viewModel.registerUrl?.let { url ->
|
||||
TextButton(
|
||||
onClick = { WebHandoff.open(context, url) },
|
||||
modifier = Modifier.padding(top = 16.dp),
|
||||
) { Text(stringResource(R.string.login_register)) }
|
||||
}
|
||||
viewModel.forgotPasswordUrl?.let { url ->
|
||||
TextButton(onClick = { WebHandoff.open(context, url) }) {
|
||||
Text(stringResource(R.string.login_forgot))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun loginErrorRes(error: LoginError): Int = when (error) {
|
||||
LoginError.INVALID_CREDENTIALS -> R.string.login_error_credentials
|
||||
LoginError.BAD_CODE -> R.string.login_error_code
|
||||
LoginError.RATE_LIMITED -> R.string.login_error_rate_limited
|
||||
LoginError.SERVER -> R.string.login_error_server
|
||||
LoginError.NETWORK -> R.string.login_error_network
|
||||
LoginError.SSO -> R.string.login_error_sso
|
||||
}
|
||||
158
app/src/main/java/com/runicgateway/app/ui/auth/LoginViewModel.kt
Normal file
158
app/src/main/java/com/runicgateway/app/ui/auth/LoginViewModel.kt
Normal file
@@ -0,0 +1,158 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.auth
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.core.auth.sso.SsoAuthManager
|
||||
import com.runicgateway.app.core.web.WebsiteUrls
|
||||
import com.runicgateway.app.data.api.dto.SsoProviderDto
|
||||
import com.runicgateway.app.data.repository.AuthRepository
|
||||
import com.runicgateway.app.data.repository.AuthRepository.LoginResult
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Drives the native login screen (PLAN.md §4.1): username/password, single-request
|
||||
* TOTP (the code field is revealed once the backend answers `totpRequired`), and
|
||||
* friendly 429 backoff handling. Registration / forgot-password / SSO are website
|
||||
* hand-offs whose URLs it exposes (§4.2).
|
||||
*/
|
||||
@HiltViewModel
|
||||
class LoginViewModel @Inject constructor(
|
||||
private val authRepository: AuthRepository,
|
||||
private val ssoAuthManager: SsoAuthManager,
|
||||
private val websiteUrls: WebsiteUrls,
|
||||
) : ViewModel() {
|
||||
|
||||
/** The transient error surfaced under the form after a failed attempt. */
|
||||
enum class LoginError { INVALID_CREDENTIALS, BAD_CODE, RATE_LIMITED, SERVER, NETWORK, SSO }
|
||||
|
||||
data class UiState(
|
||||
val username: String = "",
|
||||
val password: String = "",
|
||||
val code: String = "",
|
||||
/** True once the account is known to have 2FA on — reveal the code field. */
|
||||
val totpRequired: Boolean = false,
|
||||
val submitting: Boolean = false,
|
||||
val error: LoginError? = null,
|
||||
val signedIn: Boolean = false,
|
||||
/** The shard's enabled SSO providers (§4.2); empty → website hand-off fallback. */
|
||||
val ssoProviders: List<SsoProviderDto> = emptyList(),
|
||||
/** A `/auth/mobile/sso/start` URL the screen should open in a Custom Tab, once. */
|
||||
val ssoLaunchUrl: String? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(UiState())
|
||||
val state: StateFlow<UiState> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
// Discover the native SSO providers to render buttons for (§4.2).
|
||||
viewModelScope.launch {
|
||||
val providers = authRepository.ssoProviders()
|
||||
if (providers.isNotEmpty()) _state.update { it.copy(ssoProviders = providers) }
|
||||
}
|
||||
// Consume the SSO bridge outcome: a returned callback completes here even if
|
||||
// this ViewModel was recreated while the Custom Tab was foreground (§4.2).
|
||||
viewModelScope.launch {
|
||||
ssoAuthManager.outcome.collect { outcome ->
|
||||
when (outcome) {
|
||||
SsoAuthManager.Outcome.Success -> {
|
||||
ssoAuthManager.consumeOutcome()
|
||||
_state.update { it.copy(submitting = false, signedIn = true) }
|
||||
}
|
||||
is SsoAuthManager.Outcome.Failed -> {
|
||||
ssoAuthManager.consumeOutcome()
|
||||
_state.update { it.copy(submitting = false, error = mapSsoError(outcome.reason)) }
|
||||
}
|
||||
SsoAuthManager.Outcome.Idle -> Unit
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun onUsernameChange(value: String) = _state.update { it.copy(username = value, error = null) }
|
||||
fun onPasswordChange(value: String) = _state.update { it.copy(password = value, error = null) }
|
||||
fun onCodeChange(value: String) =
|
||||
_state.update { it.copy(code = value.filter(Char::isDigit).take(8), error = null) }
|
||||
|
||||
val registerUrl: String? get() = websiteUrls.register()
|
||||
val forgotPasswordUrl: String? get() = websiteUrls.forgotPassword()
|
||||
|
||||
/** Website login hand-off — the fallback when native SSO discovery is empty (§4.2). */
|
||||
val ssoLoginUrl: String? get() = websiteUrls.login()
|
||||
|
||||
/**
|
||||
* Begin a native SSO flow for [provider]: mint PKCE + state and surface the
|
||||
* `/start` URL for the screen to open in a Custom Tab. No-op (leaves a SERVER
|
||||
* error) if the base URL isn't set yet — the website fallback still shows.
|
||||
*/
|
||||
fun onSsoProviderClick(provider: SsoProviderDto) {
|
||||
if (_state.value.submitting) return
|
||||
val url = ssoAuthManager.buildStartUrl(provider.id)
|
||||
if (url == null) {
|
||||
_state.update { it.copy(error = LoginError.SSO) }
|
||||
return
|
||||
}
|
||||
_state.update { it.copy(error = null, ssoLaunchUrl = url) }
|
||||
}
|
||||
|
||||
/** The screen has opened the Custom Tab; clear so it isn't re-launched on recompose. */
|
||||
fun onSsoLaunchConsumed() = _state.update { it.copy(ssoLaunchUrl = null) }
|
||||
|
||||
private fun mapSsoError(reason: SsoAuthManager.Failure): LoginError = when (reason) {
|
||||
SsoAuthManager.Failure.NETWORK -> LoginError.NETWORK
|
||||
else -> LoginError.SSO
|
||||
}
|
||||
|
||||
fun submit() {
|
||||
val s = _state.value
|
||||
if (s.submitting) return
|
||||
if (s.username.isBlank() || s.password.isBlank()) {
|
||||
_state.update { it.copy(error = LoginError.INVALID_CREDENTIALS) }
|
||||
return
|
||||
}
|
||||
// If 2FA is being requested, a code must accompany the resubmit.
|
||||
if (s.totpRequired && s.code.isBlank()) {
|
||||
_state.update { it.copy(error = LoginError.BAD_CODE) }
|
||||
return
|
||||
}
|
||||
|
||||
_state.update { it.copy(submitting = true, error = null) }
|
||||
viewModelScope.launch {
|
||||
val code = s.code.trim().takeIf { it.isNotBlank() }
|
||||
when (authRepository.login(s.username.trim(), s.password, code)) {
|
||||
LoginResult.Success ->
|
||||
_state.update { it.copy(submitting = false, signedIn = true) }
|
||||
|
||||
LoginResult.TotpRequired ->
|
||||
// Reveal the code field; a wrong code re-lands here as BAD_CODE.
|
||||
_state.update {
|
||||
it.copy(
|
||||
submitting = false,
|
||||
totpRequired = true,
|
||||
error = if (it.code.isNotBlank()) LoginError.BAD_CODE else null,
|
||||
)
|
||||
}
|
||||
|
||||
LoginResult.InvalidCredentials ->
|
||||
_state.update { it.copy(submitting = false, error = LoginError.INVALID_CREDENTIALS) }
|
||||
|
||||
LoginResult.RateLimited ->
|
||||
_state.update { it.copy(submitting = false, error = LoginError.RATE_LIMITED) }
|
||||
|
||||
LoginResult.ServerError ->
|
||||
_state.update { it.copy(submitting = false, error = LoginError.SERVER) }
|
||||
|
||||
LoginResult.NetworkError ->
|
||||
_state.update { it.copy(submitting = false, error = LoginError.NETWORK) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.components
|
||||
|
||||
import android.text.method.LinkMovementMethod
|
||||
import android.widget.TextView
|
||||
import androidx.compose.material3.LocalContentColor
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.toArgb
|
||||
import androidx.compose.ui.viewinterop.AndroidView
|
||||
import androidx.core.text.HtmlCompat
|
||||
|
||||
/**
|
||||
* Renders server-authored HTML (post/wiki bodies, `rich_text` blocks) via a
|
||||
* native [TextView] + [HtmlCompat]. Compose has no HTML renderer; for the
|
||||
* functional pass this is the pragmatic path and handles links, lists, and
|
||||
* basic markup. The body is already sanitized server-side (website `cleanBody`).
|
||||
* The M5 design pass can revisit richer/native rendering.
|
||||
*/
|
||||
@Composable
|
||||
fun HtmlText(html: String, modifier: Modifier = Modifier) {
|
||||
val textColor = LocalContentColor.current.toArgb()
|
||||
val linkColor = MaterialTheme.colorScheme.primary.toArgb()
|
||||
AndroidView(
|
||||
modifier = modifier,
|
||||
factory = { context ->
|
||||
TextView(context).apply {
|
||||
movementMethod = LinkMovementMethod.getInstance()
|
||||
}
|
||||
},
|
||||
update = { view ->
|
||||
view.setTextColor(textColor)
|
||||
view.setLinkTextColor(linkColor)
|
||||
view.text = HtmlCompat.fromHtml(html, HtmlCompat.FROM_HTML_MODE_COMPACT)
|
||||
},
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.components
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.width
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.style.TextAlign
|
||||
import androidx.compose.ui.unit.dp
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.ui.ErrorKind
|
||||
|
||||
/** Centered progress indicator for a whole-screen loading state (§7). */
|
||||
@Composable
|
||||
fun LoadingView(modifier: Modifier = Modifier) {
|
||||
Column(
|
||||
modifier = modifier.fillMaxSize().padding(24.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.Center,
|
||||
) {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Whole-screen error state with a friendly, kind-specific message and a Retry
|
||||
* button (§7). Copy is resolved from string resources so it stays localizable.
|
||||
*/
|
||||
@Composable
|
||||
fun ErrorView(
|
||||
kind: ErrorKind,
|
||||
onRetry: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
Column(
|
||||
modifier = modifier.fillMaxSize().padding(24.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.Center,
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(errorMessageRes(kind)),
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
textAlign = TextAlign.Center,
|
||||
)
|
||||
Button(
|
||||
onClick = onRetry,
|
||||
modifier = Modifier.padding(top = 16.dp).width(160.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.action_retry))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Centered informational message for an empty list (§7). */
|
||||
@Composable
|
||||
fun EmptyView(message: String, modifier: Modifier = Modifier) {
|
||||
Column(
|
||||
modifier = modifier.fillMaxSize().padding(24.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.Center,
|
||||
) {
|
||||
Text(
|
||||
text = message,
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
textAlign = TextAlign.Center,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
private fun errorMessageRes(kind: ErrorKind): Int = when (kind) {
|
||||
ErrorKind.NETWORK -> R.string.error_network
|
||||
ErrorKind.NOT_FOUND -> R.string.error_not_found
|
||||
ErrorKind.RATE_LIMITED -> R.string.error_rate_limited
|
||||
ErrorKind.SHARD_OFFLINE -> R.string.error_shard_offline
|
||||
ErrorKind.SERVER -> R.string.error_server
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.components
|
||||
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.border
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.ColumnScope
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.shape.CircleShape
|
||||
import androidx.compose.foundation.shape.RoundedCornerShape
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Surface
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.draw.clip
|
||||
import androidx.compose.ui.graphics.Brush
|
||||
import androidx.compose.ui.graphics.Color
|
||||
import androidx.compose.ui.unit.dp
|
||||
import com.runicgateway.app.ui.theme.ShardCardBottom
|
||||
import com.runicgateway.app.ui.theme.ShardCardTop
|
||||
import com.runicgateway.app.ui.theme.ShardDanger
|
||||
import com.runicgateway.app.ui.theme.ShardDangerBg
|
||||
import com.runicgateway.app.ui.theme.ShardElevated
|
||||
import com.runicgateway.app.ui.theme.ShardFaint
|
||||
import com.runicgateway.app.ui.theme.ShardOutline
|
||||
import com.runicgateway.app.ui.theme.ShardPillBg
|
||||
import com.runicgateway.app.ui.theme.ShardPillFg
|
||||
import com.runicgateway.app.ui.theme.ShardSuccess
|
||||
import com.runicgateway.app.ui.theme.ShardSuccessBg
|
||||
import com.runicgateway.app.ui.theme.ShardSuccessDot
|
||||
import com.runicgateway.app.ui.theme.ShardWarning
|
||||
import com.runicgateway.app.ui.theme.ShardWarningBg
|
||||
|
||||
/**
|
||||
* Shared visual building blocks for the M5 shard-website design pass
|
||||
* (docs/android/PLAN.md §M5): the recurring pill, section-label, feature-card,
|
||||
* and stat-bar motifs the mockup repeats across screens. Pure presentation —
|
||||
* no state, no data dependencies — so any screen can adopt them.
|
||||
*/
|
||||
|
||||
/** Semantic tone for a [StatusPill] / [OnlineDot]. */
|
||||
enum class PillTone { Success, Warning, Danger, Neutral, Info }
|
||||
|
||||
private data class PillColors(val fg: Color, val bg: Color)
|
||||
|
||||
private fun toneColors(tone: PillTone): PillColors = when (tone) {
|
||||
PillTone.Success -> PillColors(ShardSuccess, ShardSuccessBg)
|
||||
PillTone.Warning -> PillColors(ShardWarning, ShardWarningBg)
|
||||
PillTone.Danger -> PillColors(ShardDanger, ShardDangerBg)
|
||||
PillTone.Neutral, PillTone.Info -> PillColors(ShardPillFg, ShardPillBg)
|
||||
}
|
||||
|
||||
/**
|
||||
* A small uppercase status chip — "Live", "Up", "Enabled", "IDOC", a role — with a
|
||||
* rounded filled background tinted by [tone]. Mirrors the mockup's pill badges.
|
||||
*/
|
||||
@Composable
|
||||
fun StatusPill(text: String, tone: PillTone, modifier: Modifier = Modifier) {
|
||||
val c = toneColors(tone)
|
||||
Surface(color = c.bg, shape = CircleShape, modifier = modifier) {
|
||||
Text(
|
||||
text = text.uppercase(),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = c.fg,
|
||||
modifier = Modifier.padding(horizontal = 10.dp, vertical = 4.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/** The small colored status dot (green when live), matched to a [PillTone]. */
|
||||
@Composable
|
||||
fun OnlineDot(tone: PillTone, modifier: Modifier = Modifier) {
|
||||
val color = when (tone) {
|
||||
PillTone.Success -> ShardSuccessDot
|
||||
PillTone.Warning -> ShardWarning
|
||||
PillTone.Danger -> ShardDanger
|
||||
PillTone.Neutral, PillTone.Info -> ShardFaint
|
||||
}
|
||||
Box(modifier.size(8.dp).clip(CircleShape).background(color))
|
||||
}
|
||||
|
||||
/**
|
||||
* The muted, uppercase, letter-spaced section header the design uses above grouped
|
||||
* content ("Attributes", "Vitals", "Password", "Linked accounts").
|
||||
*/
|
||||
@Composable
|
||||
fun SectionLabel(text: String, modifier: Modifier = Modifier) {
|
||||
Text(
|
||||
text = text.uppercase(),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = ShardFaint,
|
||||
modifier = modifier,
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* The elevated "feature" card: a vertical blue gradient with a hairline outline and
|
||||
* soft shadow, used for the home status card, the shard-online banner, and the
|
||||
* vendor card. [content] is laid out in a padded [Column].
|
||||
*/
|
||||
@Composable
|
||||
fun FeatureCard(
|
||||
modifier: Modifier = Modifier,
|
||||
contentPadding: Int = 18,
|
||||
content: @Composable ColumnScope.() -> Unit,
|
||||
) {
|
||||
Box(
|
||||
modifier = modifier
|
||||
.fillMaxWidth()
|
||||
.clip(RoundedCornerShape(12.dp))
|
||||
.background(Brush.verticalGradient(listOf(ShardCardTop, ShardCardBottom)))
|
||||
.border(1.dp, ShardOutline, RoundedCornerShape(12.dp)),
|
||||
) {
|
||||
Column(Modifier.padding(contentPadding.dp), content = content)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A slim rounded meter (vitals / skills). [fraction] is clamped to 0..1; the fill is
|
||||
* the slate accent over a bordered dark track.
|
||||
*/
|
||||
@Composable
|
||||
fun StatBar(fraction: Float, modifier: Modifier = Modifier) {
|
||||
val pct = fraction.coerceIn(0f, 1f)
|
||||
Box(
|
||||
modifier = modifier
|
||||
.fillMaxWidth()
|
||||
.height(6.dp)
|
||||
.clip(RoundedCornerShape(3.dp))
|
||||
.background(ShardElevated)
|
||||
.border(1.dp, ShardOutline, RoundedCornerShape(3.dp)),
|
||||
) {
|
||||
Box(
|
||||
Modifier
|
||||
.fillMaxWidth(pct)
|
||||
.height(6.dp)
|
||||
.clip(RoundedCornerShape(3.dp))
|
||||
.background(MaterialTheme.colorScheme.secondary),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.connect
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.text.KeyboardActions
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.ImeAction
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.text.style.TextAlign
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.ui.connect.ConnectViewModel.ConnectError
|
||||
|
||||
/**
|
||||
* First-run "Connect to your shard's website" screen (PLAN.md §3). Nothing else
|
||||
* in the app runs until a valid Runic Gateway site is entered and validated.
|
||||
*/
|
||||
@Composable
|
||||
fun ConnectScreen(
|
||||
onConnected: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: ConnectViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.padding(24.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.Center,
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(R.string.connect_title),
|
||||
style = MaterialTheme.typography.headlineSmall,
|
||||
textAlign = TextAlign.Center,
|
||||
)
|
||||
Text(
|
||||
text = stringResource(R.string.connect_subtitle),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
textAlign = TextAlign.Center,
|
||||
modifier = Modifier.padding(top = 8.dp, bottom = 24.dp),
|
||||
)
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.input,
|
||||
onValueChange = viewModel::onInputChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
isError = state.error != null,
|
||||
label = { Text(stringResource(R.string.connect_url_label)) },
|
||||
placeholder = { Text(stringResource(R.string.connect_url_hint)) },
|
||||
keyboardOptions = KeyboardOptions(
|
||||
keyboardType = KeyboardType.Uri,
|
||||
imeAction = ImeAction.Go,
|
||||
),
|
||||
keyboardActions = KeyboardActions(onGo = { viewModel.connect(onConnected) }),
|
||||
supportingText = state.error?.let { err ->
|
||||
{ Text(errorMessage(err), color = MaterialTheme.colorScheme.error) }
|
||||
},
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
|
||||
Button(
|
||||
onClick = { viewModel.connect(onConnected) },
|
||||
enabled = !state.submitting,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 20.dp),
|
||||
) {
|
||||
if (state.submitting) {
|
||||
CircularProgressIndicator(
|
||||
strokeWidth = 2.dp,
|
||||
modifier = Modifier.size(20.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary,
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(R.string.connect_button))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun errorMessage(error: ConnectError): String = when (error) {
|
||||
ConnectError.Blank -> stringResource(R.string.connect_error_blank)
|
||||
ConnectError.Malformed -> stringResource(R.string.connect_error_malformed)
|
||||
ConnectError.UnsupportedScheme -> stringResource(R.string.connect_error_scheme)
|
||||
ConnectError.Insecure -> stringResource(R.string.connect_error_insecure)
|
||||
ConnectError.NotRunicGateway -> stringResource(R.string.connect_error_not_runic)
|
||||
is ConnectError.VersionMismatch -> stringResource(R.string.connect_error_version, error.serverApi)
|
||||
ConnectError.Unreachable -> stringResource(R.string.connect_error_unreachable)
|
||||
is ConnectError.Server -> stringResource(R.string.connect_error_server, error.status)
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.connect
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.core.net.ServerUrl
|
||||
import com.runicgateway.app.data.repository.ConnectionRepository
|
||||
import com.runicgateway.app.data.repository.ConnectionRepository.ProbeResult
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Drives the first-run connect screen (PLAN.md §3): validates + probes the
|
||||
* entered base URL, and on success activates it for the whole app. The error is
|
||||
* exposed as a resource-free [ConnectError] the screen maps to localized copy.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class ConnectViewModel @Inject constructor(
|
||||
private val connectionRepository: ConnectionRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
sealed interface ConnectError {
|
||||
data object Blank : ConnectError
|
||||
data object Malformed : ConnectError
|
||||
data object UnsupportedScheme : ConnectError
|
||||
data object Insecure : ConnectError
|
||||
data object NotRunicGateway : ConnectError
|
||||
data class VersionMismatch(val serverApi: String) : ConnectError
|
||||
data object Unreachable : ConnectError
|
||||
data class Server(val status: Int) : ConnectError
|
||||
}
|
||||
|
||||
data class UiState(
|
||||
val input: String = "",
|
||||
val submitting: Boolean = false,
|
||||
val error: ConnectError? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(UiState())
|
||||
val state: StateFlow<UiState> = _state.asStateFlow()
|
||||
|
||||
fun onInputChange(value: String) {
|
||||
_state.update { it.copy(input = value, error = null) }
|
||||
}
|
||||
|
||||
fun connect(onSuccess: () -> Unit) {
|
||||
if (_state.value.submitting) return
|
||||
_state.update { it.copy(submitting = true, error = null) }
|
||||
viewModelScope.launch {
|
||||
val result = connectionRepository.probeAndConnect(_state.value.input)
|
||||
when (result) {
|
||||
is ProbeResult.Success -> {
|
||||
_state.update { it.copy(submitting = false) }
|
||||
onSuccess()
|
||||
}
|
||||
is ProbeResult.InvalidUrl -> fail(result.reason.toError())
|
||||
ProbeResult.NotRunicGateway -> fail(ConnectError.NotRunicGateway)
|
||||
is ProbeResult.VersionMismatch -> fail(ConnectError.VersionMismatch(result.serverApi))
|
||||
is ProbeResult.Unreachable -> fail(ConnectError.Unreachable)
|
||||
is ProbeResult.ServerError -> fail(ConnectError.Server(result.status))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun fail(error: ConnectError) {
|
||||
_state.update { it.copy(submitting = false, error = error) }
|
||||
}
|
||||
|
||||
private fun ServerUrl.Reason.toError(): ConnectError = when (this) {
|
||||
ServerUrl.Reason.BLANK -> ConnectError.Blank
|
||||
ServerUrl.Reason.MALFORMED -> ConnectError.Malformed
|
||||
ServerUrl.Reason.UNSUPPORTED_SCHEME -> ConnectError.UnsupportedScheme
|
||||
ServerUrl.Reason.INSECURE -> ConnectError.Insecure
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,121 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.contact
|
||||
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.ui.ErrorKind
|
||||
import com.runicgateway.app.ui.contact.ContactViewModel.Result
|
||||
|
||||
/** Contact form (PLAN.md §6.1). Handles validation, send, mailto-fallback, errors. */
|
||||
@Composable
|
||||
fun ContactScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: ContactViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(20.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.contact_title), style = MaterialTheme.typography.headlineSmall)
|
||||
Spacer(Modifier.height(16.dp))
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.name,
|
||||
onValueChange = viewModel::onNameChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
label = { Text(stringResource(R.string.contact_name)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
Spacer(Modifier.height(12.dp))
|
||||
OutlinedTextField(
|
||||
value = state.email,
|
||||
onValueChange = viewModel::onEmailChange,
|
||||
singleLine = true,
|
||||
enabled = !state.submitting,
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Email),
|
||||
label = { Text(stringResource(R.string.contact_email)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
Spacer(Modifier.height(12.dp))
|
||||
OutlinedTextField(
|
||||
value = state.message,
|
||||
onValueChange = viewModel::onMessageChange,
|
||||
enabled = !state.submitting,
|
||||
minLines = 4,
|
||||
label = { Text(stringResource(R.string.contact_message)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
|
||||
state.result?.let { ResultMessage(it) }
|
||||
|
||||
Button(
|
||||
onClick = viewModel::send,
|
||||
enabled = !state.submitting,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 20.dp),
|
||||
) {
|
||||
if (state.submitting) {
|
||||
CircularProgressIndicator(
|
||||
strokeWidth = 2.dp,
|
||||
modifier = Modifier.size(20.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary,
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(R.string.contact_send))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ResultMessage(result: Result) {
|
||||
val (text, isError) = when (result) {
|
||||
Result.Sent -> stringResource(R.string.contact_sent) to false
|
||||
is Result.Fallback -> stringResource(R.string.contact_fallback, result.email ?: "") to false
|
||||
Result.ValidationError -> stringResource(R.string.contact_validation) to true
|
||||
is Result.Failed -> errorText(result.kind) to true
|
||||
}
|
||||
Text(
|
||||
text = text,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = if (isError) MaterialTheme.colorScheme.error else MaterialTheme.colorScheme.primary,
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun errorText(kind: ErrorKind): String = when (kind) {
|
||||
ErrorKind.NETWORK -> stringResource(R.string.error_network)
|
||||
ErrorKind.RATE_LIMITED -> stringResource(R.string.error_rate_limited)
|
||||
else -> stringResource(R.string.contact_error)
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.contact
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.repository.ContactRepository
|
||||
import com.runicgateway.app.ui.ErrorKind
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import com.runicgateway.app.ui.UiState as LoadUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/** Contact form submission with client-side validation (PLAN.md §6.1). */
|
||||
@HiltViewModel
|
||||
class ContactViewModel @Inject constructor(
|
||||
private val contactRepository: ContactRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
sealed interface Result {
|
||||
data object Sent : Result
|
||||
|
||||
/** Site has no mailer; email directly at [email] instead. */
|
||||
data class Fallback(val email: String?) : Result
|
||||
data object ValidationError : Result
|
||||
data class Failed(val kind: ErrorKind) : Result
|
||||
}
|
||||
|
||||
data class UiState(
|
||||
val name: String = "",
|
||||
val email: String = "",
|
||||
val message: String = "",
|
||||
val submitting: Boolean = false,
|
||||
val result: Result? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(UiState())
|
||||
val state: StateFlow<UiState> = _state.asStateFlow()
|
||||
|
||||
fun onNameChange(value: String) = _state.update { it.copy(name = value, result = null) }
|
||||
fun onEmailChange(value: String) = _state.update { it.copy(email = value, result = null) }
|
||||
fun onMessageChange(value: String) = _state.update { it.copy(message = value, result = null) }
|
||||
|
||||
fun send() {
|
||||
val s = _state.value
|
||||
if (s.submitting) return
|
||||
if (s.name.isBlank() || s.email.isBlank() || s.message.isBlank()) {
|
||||
_state.update { it.copy(result = Result.ValidationError) }
|
||||
return
|
||||
}
|
||||
_state.update { it.copy(submitting = true, result = null) }
|
||||
viewModelScope.launch {
|
||||
val result = when (val r = contactRepository.send(s.name.trim(), s.email.trim(), s.message.trim())) {
|
||||
is ApiResult.Ok ->
|
||||
if (r.data.sent) Result.Sent else Result.Fallback(r.data.email)
|
||||
else -> {
|
||||
val kind = (r.toUiState() as? LoadUiState.Error)?.kind ?: ErrorKind.SERVER
|
||||
Result.Failed(kind)
|
||||
}
|
||||
}
|
||||
_state.update {
|
||||
// Clear the fields on a successful send; keep them on failure so the
|
||||
// user can retry without retyping.
|
||||
if (result is Result.Sent) {
|
||||
UiState(result = result)
|
||||
} else {
|
||||
it.copy(submitting = false, result = result)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
122
app/src/main/java/com/runicgateway/app/ui/home/HomeScreen.kt
Normal file
122
app/src/main/java/com/runicgateway/app/ui/home/HomeScreen.kt
Normal file
@@ -0,0 +1,122 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.home
|
||||
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Row
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.width
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.FeatureCard
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.components.OnlineDot
|
||||
import com.runicgateway.app.ui.components.PillTone
|
||||
|
||||
/**
|
||||
* Home / status (PLAN.md §6.1): the shard's name + tagline from branding, and a
|
||||
* live site-status card (online vs maintenance) with the backend version.
|
||||
*/
|
||||
@Composable
|
||||
fun HomeScreen(
|
||||
brand: BrandDto?,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: HomeViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
when (val s = state) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Success -> HomeContent(brand, s.data, modifier)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun HomeContent(brand: BrandDto?, status: StatusDto, modifier: Modifier = Modifier) {
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(20.dp),
|
||||
) {
|
||||
Text(
|
||||
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
|
||||
style = MaterialTheme.typography.headlineMedium,
|
||||
)
|
||||
brand?.tagline?.takeIf { it.isNotBlank() }?.let { tagline ->
|
||||
Text(
|
||||
text = tagline,
|
||||
style = MaterialTheme.typography.titleSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 4.dp),
|
||||
)
|
||||
}
|
||||
|
||||
Spacer(Modifier.height(20.dp))
|
||||
|
||||
StatusCard(status)
|
||||
|
||||
brand?.description?.takeIf { it.isNotBlank() }?.let { desc ->
|
||||
Spacer(Modifier.height(16.dp))
|
||||
Text(text = desc, style = MaterialTheme.typography.bodyMedium)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StatusCard(status: StatusDto) {
|
||||
val online = !status.isMaintenance
|
||||
|
||||
FeatureCard {
|
||||
Row(verticalAlignment = Alignment.CenterVertically) {
|
||||
OnlineDot(if (online) PillTone.Success else PillTone.Danger)
|
||||
Spacer(Modifier.width(10.dp))
|
||||
Text(
|
||||
text = stringResource(
|
||||
if (online) R.string.home_status_live else R.string.home_status_maintenance,
|
||||
),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
}
|
||||
if (status.isMaintenance && status.statusMessage.isNotBlank()) {
|
||||
Text(
|
||||
text = status.statusMessage,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier = Modifier.padding(top = 6.dp),
|
||||
)
|
||||
}
|
||||
if (status.version.server.isNotBlank()) {
|
||||
Text(
|
||||
text = stringResource(
|
||||
R.string.home_server_version,
|
||||
status.version.server,
|
||||
status.version.api,
|
||||
),
|
||||
style = MaterialTheme.typography.labelMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 10.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.home
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import com.runicgateway.app.data.repository.SettingsRepository
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/** Loads site status (mode + version) for the Home screen (PLAN.md §6.1). */
|
||||
@HiltViewModel
|
||||
class HomeViewModel @Inject constructor(
|
||||
private val settingsRepository: SettingsRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _state = MutableStateFlow<UiState<StatusDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<StatusDto>> = _state.asStateFlow()
|
||||
|
||||
init { load() }
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = settingsRepository.getStatus().toUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
64
app/src/main/java/com/runicgateway/app/ui/navigation/Menu.kt
Normal file
64
app/src/main/java/com/runicgateway/app/ui/navigation/Menu.kt
Normal file
@@ -0,0 +1,64 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.auth.Session
|
||||
|
||||
/**
|
||||
* One shared, declarative, access-level navigation definition (PLAN.md §5): a
|
||||
* single list where each entry declares the minimum access it needs, filtered by
|
||||
* the current session — not a pile of `if role ==` checks. The server stays the
|
||||
* source of truth; a hidden item is a UX convenience and every gated call still
|
||||
* enforces on the backend.
|
||||
*/
|
||||
enum class MenuAccess {
|
||||
/** Visible to everyone, signed in or not. */
|
||||
PUBLIC,
|
||||
|
||||
/** Visible to any signed-in account (§5, "My Account"). */
|
||||
SIGNED_IN,
|
||||
|
||||
/** Visible only to a player — the linked game-data groups (§6.3). */
|
||||
PLAYER,
|
||||
}
|
||||
|
||||
data class MenuEntry(
|
||||
val route: String,
|
||||
@param:StringRes val labelRes: Int,
|
||||
val access: MenuAccess = MenuAccess.PUBLIC,
|
||||
)
|
||||
|
||||
/**
|
||||
* The full menu, in display order. Public content first, then the signed-in
|
||||
* surfaces, then the player-only game-data groups (revealed once the session's
|
||||
* role is `player`, §6.3).
|
||||
*/
|
||||
val APP_MENU: List<MenuEntry> = listOf(
|
||||
MenuEntry(Routes.HOME, R.string.menu_home),
|
||||
MenuEntry(Routes.NEWS, R.string.menu_news),
|
||||
MenuEntry(Routes.WIKI, R.string.menu_wiki),
|
||||
MenuEntry(Routes.SHARD, R.string.menu_shard),
|
||||
MenuEntry(Routes.page("about"), R.string.menu_about),
|
||||
MenuEntry(Routes.CONTACT, R.string.menu_contact),
|
||||
MenuEntry(Routes.ACCOUNT, R.string.menu_account, MenuAccess.SIGNED_IN),
|
||||
MenuEntry(Routes.NOTIFICATIONS, R.string.menu_notifications, MenuAccess.SIGNED_IN),
|
||||
MenuEntry(Routes.PLAYER_CHARACTERS, R.string.menu_my_characters, MenuAccess.PLAYER),
|
||||
MenuEntry(Routes.PLAYER_VENDORS, R.string.menu_my_vendors, MenuAccess.PLAYER),
|
||||
MenuEntry(Routes.PLAYER_HOUSES, R.string.menu_my_houses, MenuAccess.PLAYER),
|
||||
)
|
||||
|
||||
/**
|
||||
* The entries the given [session] may see. Pure + side-effect-free so the access
|
||||
* gating is unit-tested without Compose.
|
||||
*/
|
||||
fun visibleEntries(entries: List<MenuEntry>, session: Session): List<MenuEntry> =
|
||||
entries.filter { entry ->
|
||||
when (entry.access) {
|
||||
MenuAccess.PUBLIC -> true
|
||||
MenuAccess.SIGNED_IN -> session is Session.SignedIn
|
||||
MenuAccess.PLAYER -> session is Session.SignedIn && session.user.isPlayer
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
/**
|
||||
* Navigation destinations for the M1 public surface (PLAN.md §5). Routes are
|
||||
* plain strings for Navigation-Compose; argument-bearing routes expose a
|
||||
* `build(...)` helper so call sites never hand-format paths.
|
||||
*/
|
||||
object Routes {
|
||||
const val HOME = "home"
|
||||
const val NEWS = "news"
|
||||
const val WIKI = "wiki"
|
||||
const val CONTACT = "contact"
|
||||
|
||||
/** Native login (§4.1) and the signed-in account surface (§5). */
|
||||
const val LOGIN = "login"
|
||||
const val ACCOUNT = "account"
|
||||
|
||||
/** Opt-in push notification settings (§11, signed-in). */
|
||||
const val NOTIFICATIONS = "notifications"
|
||||
|
||||
/** Public shard hub (§6.2). */
|
||||
const val SHARD = "shard"
|
||||
|
||||
/** Shard boards, reachable from the hub. */
|
||||
const val SHARD_CHAMPS = "shard/champs"
|
||||
const val SHARD_GUILDS = "shard/guilds"
|
||||
const val SHARD_GOVERNORS = "shard/governors"
|
||||
const val SHARD_HOUSES = "shard/houses"
|
||||
|
||||
/** Player game-data groups (§6.3, player-only). Distinct from the public shard boards. */
|
||||
const val PLAYER_CHARACTERS = "player/characters"
|
||||
const val PLAYER_VENDORS = "player/vendors"
|
||||
const val PLAYER_HOUSES = "player/houses"
|
||||
|
||||
/** A single character sheet by in-game (hex) serial. */
|
||||
const val PLAYER_CHAR = "player/char/{serial}"
|
||||
|
||||
/** CMS page by slug (e.g. the conventional "about" page, mirrored from the site nav). */
|
||||
const val PAGE = "page/{slug}"
|
||||
|
||||
/** News post detail by category + id-or-slug. */
|
||||
const val POST = "news/{category}/{idOrSlug}"
|
||||
|
||||
/** Wiki page detail by slug. */
|
||||
const val WIKI_PAGE = "wiki/{slug}"
|
||||
|
||||
object Args {
|
||||
const val SLUG = "slug"
|
||||
const val CATEGORY = "category"
|
||||
const val ID_OR_SLUG = "idOrSlug"
|
||||
const val SERIAL = "serial"
|
||||
}
|
||||
|
||||
fun page(slug: String) = "page/$slug"
|
||||
fun post(categoryUrlSlug: String, idOrSlug: String) = "news/$categoryUrlSlug/$idOrSlug"
|
||||
fun wikiPage(slug: String) = "wiki/$slug"
|
||||
|
||||
/** The character-sheet route for an in-game serial (e.g. "0x24C"). */
|
||||
fun playerChar(serial: String) = "player/char/$serial"
|
||||
|
||||
/**
|
||||
* The in-app destination a tapped push notification deep-links to (§11, M7
|
||||
* Part 2 work item 7). Maps a stream id to the screen that shows its content;
|
||||
* unknown streams land on Home. Personal streams route to the player groups
|
||||
* (a signed-out/demoted tap is caught by [com.runicgateway.app.ui.PlayerGate]).
|
||||
*/
|
||||
fun forStream(streamId: String): String = when (streamId) {
|
||||
com.runicgateway.app.core.push.PushStreams.NEWS_POST -> NEWS
|
||||
com.runicgateway.app.core.push.PushStreams.SERVER_STATUS,
|
||||
com.runicgateway.app.core.push.PushStreams.CHAMP_START,
|
||||
com.runicgateway.app.core.push.PushStreams.IDOC_WARNING,
|
||||
com.runicgateway.app.core.push.PushStreams.GOVERNOR_ELECTION,
|
||||
-> SHARD
|
||||
com.runicgateway.app.core.push.PushStreams.VENDOR_SALE -> PLAYER_VENDORS
|
||||
com.runicgateway.app.core.push.PushStreams.HOUSE_IDOC -> PLAYER_HOUSES
|
||||
com.runicgateway.app.core.push.PushStreams.ACCOUNT_LOGIN -> ACCOUNT
|
||||
else -> HOME
|
||||
}
|
||||
}
|
||||
117
app/src/main/java/com/runicgateway/app/ui/news/NewsScreen.kt
Normal file
117
app/src/main/java/com/runicgateway/app/ui/news/NewsScreen.kt
Normal file
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.news
|
||||
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ScrollableTabRow
|
||||
import androidx.compose.material3.Tab
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.data.repository.ContentRepository.PostCategory
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.EmptyView
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
|
||||
/** News hub with category tabs and a post list (PLAN.md §6.1). */
|
||||
@Composable
|
||||
fun NewsScreen(
|
||||
onOpenPost: (categoryUrlSlug: String, idOrSlug: String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: NewsViewModel = hiltViewModel(),
|
||||
) {
|
||||
val category by viewModel.category.collectAsStateWithLifecycle()
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
Column(modifier = modifier.fillMaxSize()) {
|
||||
ScrollableTabRow(selectedTabIndex = PostCategory.entries.indexOf(category)) {
|
||||
PostCategory.entries.forEach { cat ->
|
||||
Tab(
|
||||
selected = cat == category,
|
||||
onClick = { viewModel.selectCategory(cat) },
|
||||
text = { Text(stringResource(categoryLabel(cat))) },
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
when (val s = state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> {
|
||||
if (s.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.news_empty))
|
||||
} else {
|
||||
PostList(s.data, category.urlSlug, onOpenPost)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PostList(
|
||||
posts: List<PostDto>,
|
||||
categoryUrlSlug: String,
|
||||
onOpenPost: (String, String) -> Unit,
|
||||
) {
|
||||
LazyColumn(
|
||||
modifier = Modifier.fillMaxSize().padding(horizontal = 16.dp),
|
||||
) {
|
||||
items(posts, key = { it.id }) { post ->
|
||||
PostRow(post) { onOpenPost(categoryUrlSlug, post.slug ?: post.id.toString()) }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PostRow(post: PostDto, onClick: () -> Unit) {
|
||||
Card(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(vertical = 6.dp)
|
||||
.clickable(onClick = onClick),
|
||||
) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(post.title, style = MaterialTheme.typography.titleMedium)
|
||||
post.publishedAt?.let { date ->
|
||||
Text(
|
||||
text = date,
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 2.dp),
|
||||
)
|
||||
}
|
||||
post.excerpt?.takeIf { it.isNotBlank() }?.let { excerpt ->
|
||||
Text(
|
||||
text = excerpt,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun categoryLabel(category: PostCategory): Int = when (category) {
|
||||
PostCategory.NEWS -> R.string.news_cat_news
|
||||
PostCategory.FIVE_ON_FRIDAY -> R.string.news_cat_five_on_friday
|
||||
PostCategory.NEWSLETTER -> R.string.news_cat_newsletter
|
||||
PostCategory.SCREENSHOTS -> R.string.news_cat_screenshots
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.news
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.data.repository.ContentRepository
|
||||
import com.runicgateway.app.data.repository.ContentRepository.PostCategory
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/** News hub: a category selector over the four post feeds (PLAN.md §6.1). */
|
||||
@HiltViewModel
|
||||
class NewsViewModel @Inject constructor(
|
||||
private val contentRepository: ContentRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _category = MutableStateFlow(PostCategory.NEWS)
|
||||
val category: StateFlow<PostCategory> = _category.asStateFlow()
|
||||
|
||||
private val _state = MutableStateFlow<UiState<List<PostDto>>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<List<PostDto>>> = _state.asStateFlow()
|
||||
|
||||
init { load() }
|
||||
|
||||
fun selectCategory(category: PostCategory) {
|
||||
if (category == _category.value) return
|
||||
_category.value = category
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = contentRepository.getPosts(_category.value).toUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
80
app/src/main/java/com/runicgateway/app/ui/news/PostScreen.kt
Normal file
80
app/src/main/java/com/runicgateway/app/ui/news/PostScreen.kt
Normal file
@@ -0,0 +1,80 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.news
|
||||
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.layout.ContentScale
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import coil.compose.AsyncImage
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.ui.LocalAssetResolver
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.HtmlText
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
|
||||
/** Post detail: title, date, hero image, and HTML body (PLAN.md §6.1). */
|
||||
@Composable
|
||||
fun PostScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: PostViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
when (val s = state) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Success -> PostContent(s.data, modifier)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PostContent(post: PostDto, modifier: Modifier = Modifier) {
|
||||
val resolveAsset = LocalAssetResolver.current
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(20.dp),
|
||||
) {
|
||||
Text(post.title, style = MaterialTheme.typography.headlineSmall)
|
||||
post.publishedAt?.let { date ->
|
||||
Text(
|
||||
text = date,
|
||||
style = MaterialTheme.typography.labelMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 4.dp),
|
||||
)
|
||||
}
|
||||
|
||||
resolveAsset(post.imageUrl)?.let { url ->
|
||||
Spacer(Modifier.height(16.dp))
|
||||
AsyncImage(
|
||||
model = url,
|
||||
contentDescription = null,
|
||||
contentScale = ContentScale.FillWidth,
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
)
|
||||
}
|
||||
|
||||
post.body?.takeIf { it.isNotBlank() }?.let { body ->
|
||||
Spacer(Modifier.height(16.dp))
|
||||
HtmlText(body, modifier = Modifier.fillMaxWidth())
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user