Compare commits
1 Commits
v0.3.1
...
feat/m6-re
| Author | SHA1 | Date | |
|---|---|---|---|
| 68da9da805 |
@@ -1,23 +1,37 @@
|
||||
# Automated release for the Runic Gateway Android app.
|
||||
# Automated build + 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.
|
||||
# Trigger: every push to `main` (i.e. every merged PR).
|
||||
#
|
||||
# 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.
|
||||
# Flow (two conceptual halves, kept separate on purpose) — mirrors link/'s engine:
|
||||
#
|
||||
# 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.
|
||||
# ┌── RELEASE ENGINE (language-agnostic) ─────────────────────────────┐
|
||||
# │ reads: latest v* git tag + conventional-commit subjects │
|
||||
# │ produces: next version, changelog, and (at the end) the release │
|
||||
# └───────────────────────────────────────────────────────────────────┘
|
||||
# ┌── ANDROID ADAPTER (the only Android-specific part) ───────────────┐
|
||||
# │ consumes: the version │
|
||||
# │ produces: the artifact (a signed release APK + SHA256SUMS) │
|
||||
# └───────────────────────────────────────────────────────────────────┘
|
||||
#
|
||||
# Version bump (conventional commits since the last v* tag):
|
||||
# feat!: / BREAKING CHANGE -> major feat: -> minor fix|perf: -> patch
|
||||
# nothing releasable -> no release is cut
|
||||
# (first ever run, no tag) -> releases the current build.gradle.kts version as-is
|
||||
# versionName is the semver; versionCode is derived major*10000+minor*100+patch so
|
||||
# it is deterministic + monotonic (PLAN.md §10). The bump is committed back to
|
||||
# app/build.gradle.kts, then tagged.
|
||||
#
|
||||
# Prerequisites (Settings -> Actions -> Secrets on RunicGateway/Android-app):
|
||||
# REGISTRY_TOKEN — Gitea access token with `write:repository` (create the release)
|
||||
# REGISTRY_USER — Gitea username the token below belongs to
|
||||
# REGISTRY_TOKEN — Gitea access token with `write:repository` (push the bump
|
||||
# commit + tag and 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)
|
||||
# Also: `main` must accept a direct push from the REGISTRY_USER account (disable
|
||||
# branch protection for it, or add it as an exception) — the bump commit lands on
|
||||
# main. The bump commit carries `[skip ci]`, so it does not re-trigger this workflow.
|
||||
#
|
||||
# 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
|
||||
@@ -28,16 +42,11 @@ name: Release APK
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'Existing v* tag to (re)build and release'
|
||||
required: true
|
||||
branches: [main]
|
||||
workflow_dispatch: {}
|
||||
|
||||
concurrency:
|
||||
group: release-apk-${{ github.event.inputs.tag || github.ref_name }}
|
||||
group: release-apk
|
||||
cancel-in-progress: false
|
||||
|
||||
env:
|
||||
@@ -48,10 +57,10 @@ env:
|
||||
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
|
||||
# Don't loop on our own bump commit (belt-and-suspenders with [skip ci]).
|
||||
# Quoted because the expression contains a colon (`chore(release):`), which an
|
||||
# unquoted YAML scalar would misparse as a mapping value.
|
||||
if: "${{ !contains(github.event.head_commit.message, 'chore(release): bump version') }}"
|
||||
steps:
|
||||
- name: Install base tools + JDK 17
|
||||
run: |
|
||||
@@ -59,46 +68,70 @@ jobs:
|
||||
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)
|
||||
- name: Check out full history (need tags + commit log for the bump)
|
||||
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)
|
||||
# ── RELEASE ENGINE: decide the next version + changelog ──────────────
|
||||
- name: Plan the release (version + changelog)
|
||||
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}"
|
||||
# Current committed version (the `?: "x.y.z"` default in build.gradle.kts).
|
||||
MANIFEST_VERSION="$(sed -nE 's/.*\?: "([0-9]+\.[0-9]+\.[0-9]+)".*/\1/p' "${GRADLE_MODULE}/build.gradle.kts" | head -1)"
|
||||
LAST_TAG="$(git describe --tags --match 'v*' --abbrev=0 2>/dev/null || true)"
|
||||
if [ -n "$LAST_TAG" ]; then RANGE="${LAST_TAG}..HEAD"; else RANGE="HEAD"; fi
|
||||
|
||||
# versionCode: deterministic + monotonic from the semver (PLAN.md §10).
|
||||
SUBJECTS="$(git log --no-merges --format='%s' $RANGE || true)"
|
||||
BODIES="$(git log --no-merges --format='%B' $RANGE || true)"
|
||||
|
||||
BUMP=none
|
||||
if echo "$BODIES" | grep -qE 'BREAKING[ -]CHANGE' ; then BUMP=major; fi
|
||||
if echo "$SUBJECTS" | grep -qE '^[a-z]+(\([^)]+\))?!:' ; then BUMP=major; fi
|
||||
if [ "$BUMP" = none ] && echo "$SUBJECTS" | grep -qE '^feat(\([^)]+\))?:' ; then BUMP=minor; fi
|
||||
if [ "$BUMP" = none ] && echo "$SUBJECTS" | grep -qE '^(fix|perf)(\([^)]+\))?:'; then BUMP=patch; fi
|
||||
|
||||
bump() { # <x.y.z> <major|minor|patch> -> bumped
|
||||
IFS=. read -r MA MI PA <<< "$1"
|
||||
case "$2" in
|
||||
major) echo "$((MA+1)).0.0" ;;
|
||||
minor) echo "${MA}.$((MI+1)).0" ;;
|
||||
patch) echo "${MA}.${MI}.$((PA+1))" ;;
|
||||
esac
|
||||
}
|
||||
|
||||
RELEASE=true
|
||||
if [ -z "$LAST_TAG" ]; then
|
||||
VERSION="$MANIFEST_VERSION" # first release: ship what's committed
|
||||
elif [ "$BUMP" = none ]; then
|
||||
RELEASE=false # no feat/fix/breaking since last tag
|
||||
VERSION="${LAST_TAG#v}"
|
||||
else
|
||||
VERSION="$(bump "${LAST_TAG#v}" "$BUMP")"
|
||||
fi
|
||||
|
||||
if git rev-parse -q --verify "refs/tags/v${VERSION}" >/dev/null; then
|
||||
echo "Tag v${VERSION} already exists — nothing to release."
|
||||
RELEASE=false
|
||||
fi
|
||||
|
||||
# Derive a deterministic, monotonic versionCode from the semver.
|
||||
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 "## Runic Gateway Android v${VERSION}"
|
||||
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
|
||||
if [ -n "$LAST_TAG" ]; then echo "Since ${LAST_TAG}:"; fi
|
||||
echo "$SUBJECTS" | sed 's/^/- /'
|
||||
echo
|
||||
echo "---"
|
||||
@@ -107,25 +140,35 @@ jobs:
|
||||
|
||||
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>}"
|
||||
echo "tag=v${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "release=${RELEASE}" >> "$GITHUB_OUTPUT"
|
||||
echo "bump=${BUMP}" >> "$GITHUB_OUTPUT"
|
||||
echo "==> release=${RELEASE} version=${VERSION} code=${VERSION_CODE} bump=${BUMP} last_tag=${LAST_TAG:-<none>}"
|
||||
|
||||
# ── SDK + signing keystore ───────────────────────────────────────────
|
||||
# ── ANDROID ADAPTER: SDK + signing keystore ──────────────────────────
|
||||
- name: Set up Android SDK
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
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
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
run: |
|
||||
set +o pipefail
|
||||
yes | sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
|
||||
|
||||
- name: Cache Gradle
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
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 }}-
|
||||
|
||||
- name: Decode signing keystore
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
env:
|
||||
ANDROID_KEYSTORE_BASE64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
|
||||
run: |
|
||||
@@ -137,8 +180,9 @@ jobs:
|
||||
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
|
||||
# ── ANDROID ADAPTER: set the version, gate, build the signed APK ─────
|
||||
- name: Set the app version to match the release
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
VERSION="${{ steps.plan.outputs.version }}"
|
||||
@@ -149,6 +193,7 @@ jobs:
|
||||
grep -nE "versionCode = |versionName = " "${GRADLE_MODULE}/build.gradle.kts"
|
||||
|
||||
- name: Unit tests + signed release APK
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
env:
|
||||
ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
|
||||
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
|
||||
@@ -159,6 +204,7 @@ jobs:
|
||||
./gradlew --no-daemon :${GRADLE_MODULE}:testDebugUnitTest :${GRADLE_MODULE}:assembleRelease
|
||||
|
||||
- name: Package APK + SHA256SUMS
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
SRC="${GRADLE_MODULE}/build/outputs/apk/release/app-release.apk"
|
||||
@@ -167,8 +213,37 @@ jobs:
|
||||
( 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) ───────
|
||||
# ── RELEASE ENGINE: commit the bump, tag, push ───────────────────────
|
||||
- name: Commit version bump and push tag
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
env:
|
||||
REGISTRY_USER: ${{ secrets.REGISTRY_USER }}
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
TAG="${{ steps.plan.outputs.tag }}"
|
||||
# Secrets can arrive with a trailing newline; a stray CR/LF corrupts the
|
||||
# remote URL / auth header. Strip line breaks before use.
|
||||
CI_USER="$(printf '%s' "${REGISTRY_USER}" | tr -d '\r\n')"
|
||||
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
||||
git config user.name "android-app-ci"
|
||||
git config user.email "ci@whitlocktech.com"
|
||||
git remote set-url origin \
|
||||
"https://${CI_USER}:${CI_TOKEN}@${GITEA_HOST}/${REPO}.git"
|
||||
|
||||
git add "${GRADLE_MODULE}/build.gradle.kts"
|
||||
if ! git diff --cached --quiet; then
|
||||
git commit -m "chore(release): bump version to ${TAG} [skip ci]"
|
||||
git push origin "HEAD:main"
|
||||
else
|
||||
echo "Version unchanged (first release) — no bump commit needed."
|
||||
fi
|
||||
git tag "${TAG}"
|
||||
git push origin "${TAG}"
|
||||
|
||||
# ── RELEASE ENGINE: create the Gitea release + upload assets ─────────
|
||||
- name: Create Gitea release and upload assets
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
env:
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
# 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 }}
|
||||
@@ -48,19 +48,6 @@ android {
|
||||
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 {
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
|
||||
<!--
|
||||
Debug-only override of the main network_security_config.xml. Keeps the secure
|
||||
base posture (no cleartext) but re-permits cleartext to loopback so debug builds
|
||||
can reach a local website backend at http://127.0.0.1:3000 / http://localhost:3000
|
||||
(ServerUrl allows plain HTTP only when allowInsecureHttp = BuildConfig.DEBUG).
|
||||
Because the platform default already blocks cleartext at targetSdk 28+, this
|
||||
domain-config is what actually makes the debug local-dev path work at runtime.
|
||||
|
||||
This file is compiled only into debug builds; release builds use the main
|
||||
source set's config and permit no cleartext at all.
|
||||
-->
|
||||
<network-security-config>
|
||||
<base-config cleartextTrafficPermitted="false" />
|
||||
<domain-config cleartextTrafficPermitted="true">
|
||||
<domain includeSubdomains="false">127.0.0.1</domain>
|
||||
<domain includeSubdomains="false">localhost</domain>
|
||||
</domain-config>
|
||||
</network-security-config>
|
||||
@@ -6,13 +6,6 @@
|
||||
<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"
|
||||
@@ -20,61 +13,19 @@
|
||||
android:fullBackupContent="@xml/backup_rules"
|
||||
android:icon="@mipmap/ic_launcher"
|
||||
android:label="@string/app_name"
|
||||
android:networkSecurityConfig="@xml/network_security_config"
|
||||
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>
|
||||
|
||||
@@ -3,25 +3,18 @@
|
||||
*/
|
||||
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
|
||||
@@ -33,8 +26,6 @@ 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
|
||||
@@ -44,23 +35,8 @@ import javax.inject.Inject
|
||||
*/
|
||||
@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)
|
||||
@@ -82,47 +58,11 @@ class MainActivity : ComponentActivity() {
|
||||
AppState.NeedsConnection ->
|
||||
ConnectScreen(onConnected = appViewModel::onConnected)
|
||||
is AppState.Ready ->
|
||||
RunicApp(
|
||||
brand = s.brand,
|
||||
onChangeServer = appViewModel::changeServer,
|
||||
deepLinkStream = pendingStream,
|
||||
onDeepLinkConsumed = { pendingStream = null },
|
||||
)
|
||||
RunicApp(brand = s.brand, onChangeServer = appViewModel::changeServer)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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) }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,15 +16,6 @@ data class SessionUser(
|
||||
val role: Role,
|
||||
) {
|
||||
val isPlayer: Boolean get() = role == Role.PLAYER
|
||||
|
||||
/** Any staff role (moderator/editor/admin) — the staff-operations surface (§1, M10). */
|
||||
val isStaff: Boolean get() = role.isStaff
|
||||
|
||||
/** Admin or moderator — moderation actions + the support queue (`modAccess`). */
|
||||
val isModerator: Boolean get() = role == Role.ADMIN || role == Role.MODERATOR
|
||||
|
||||
/** Admin only — site-mode and other `adminOnly` controls. */
|
||||
val isAdmin: Boolean get() = role == Role.ADMIN
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
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
|
||||
|
||||
/**
|
||||
* [PendingSsoStore] backed by Jetpack Security's [EncryptedSharedPreferences]
|
||||
* (Tink/AES-256-GCM), so the PKCE verifier is encrypted at rest for the brief
|
||||
* window a flow is in progress. Separate prefs file from the session token store —
|
||||
* this holds only the transient SSO handshake, cleared as soon as the callback is
|
||||
* consumed. Lazy, so a device that never signs in via SSO pays no keystore cost.
|
||||
*/
|
||||
@Singleton
|
||||
class EncryptedPendingSsoStore @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
) : PendingSsoStore {
|
||||
|
||||
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 save(state: String, verifier: String) {
|
||||
prefs.edit()
|
||||
.putString(KEY_STATE, state)
|
||||
.putString(KEY_VERIFIER, verifier)
|
||||
.apply()
|
||||
}
|
||||
|
||||
override fun load(): PendingSso? {
|
||||
val state = prefs.getString(KEY_STATE, null) ?: return null
|
||||
val verifier = prefs.getString(KEY_VERIFIER, null) ?: return null
|
||||
return PendingSso(state = state, verifier = verifier)
|
||||
}
|
||||
|
||||
override fun clear() {
|
||||
prefs.edit().clear().apply()
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val PREFS_NAME = "runic_sso_pending"
|
||||
const val KEY_STATE = "state"
|
||||
const val KEY_VERIFIER = "verifier"
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
/**
|
||||
* Persists the in-flight SSO `{state, verifier}` (PKCE Layer B + CSRF state) across
|
||||
* the Custom-Tab round trip so the exchange survives process death — a low-memory
|
||||
* device can evict the app while the Custom Tab is foreground, and the callback then
|
||||
* returns to a fresh process (PLAN.md §4.2). Kept behind an interface so
|
||||
* [SsoAuthManager] stays framework-free and unit-tests on the JVM with a fake.
|
||||
*
|
||||
* Exactly one flow is pending at a time; [save] overwrites any prior. The verifier
|
||||
* is a bearer-equivalent secret for the one-time code, so the production impl
|
||||
* ([EncryptedPendingSsoStore]) encrypts it at rest, mirroring the token store.
|
||||
*/
|
||||
interface PendingSsoStore {
|
||||
fun save(state: String, verifier: String)
|
||||
fun load(): PendingSso?
|
||||
fun clear()
|
||||
}
|
||||
|
||||
/** The stashed CSRF state + PKCE verifier for the current SSO attempt. */
|
||||
data class PendingSso(val state: String, val verifier: String)
|
||||
@@ -1,50 +0,0 @@
|
||||
/*
|
||||
* 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)
|
||||
}
|
||||
}
|
||||
@@ -1,236 +0,0 @@
|
||||
/*
|
||||
* 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 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}` is persisted via [PendingSsoStore] (encrypted at
|
||||
* rest), so the exchange survives the process being evicted while the Custom Tab is
|
||||
* foreground — the callback can land in a fresh process and still complete. It is
|
||||
* cleared the moment [complete] consumes it, so a lost/duplicate callback still
|
||||
* **fails closed** as [Failure.STATE_MISMATCH] rather than double-exchanging.
|
||||
*
|
||||
* Threading: [buildStartUrl] runs on the UI thread; [complete] runs on the
|
||||
* activity's coroutine scope after a deep link. [outcome] is 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,
|
||||
private val pendingStore: PendingSsoStore,
|
||||
) {
|
||||
|
||||
/** 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
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 (persisted so it survives process death). Returns
|
||||
* null when no shard site is configured yet. 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()
|
||||
pendingStore.save(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 = pendingStore.load()
|
||||
pendingStore.clear()
|
||||
|
||||
// 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"
|
||||
}
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
/*
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
/*
|
||||
* 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" }
|
||||
}
|
||||
@@ -1,156 +0,0 @@
|
||||
/*
|
||||
* 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"
|
||||
}
|
||||
}
|
||||
@@ -1,110 +0,0 @@
|
||||
/*
|
||||
* 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"
|
||||
}
|
||||
}
|
||||
@@ -1,91 +0,0 @@
|
||||
/*
|
||||
* 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")
|
||||
}
|
||||
}
|
||||
@@ -1,95 +0,0 @@
|
||||
/*
|
||||
* 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))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
/*
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
/*
|
||||
* 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
|
||||
}
|
||||
@@ -4,7 +4,6 @@
|
||||
package com.runicgateway.app.core.result
|
||||
|
||||
import kotlinx.coroutines.CancellationException
|
||||
import kotlinx.serialization.SerializationException
|
||||
import retrofit2.HttpException
|
||||
import java.io.IOException
|
||||
|
||||
@@ -38,16 +37,6 @@ inline fun <T, R> ApiResult<T>.map(transform: (T) -> R): ApiResult<R> = when (th
|
||||
* 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.
|
||||
*
|
||||
* A body the app can't decode (a field whose type/shape doesn't match its DTO, e.g.
|
||||
* a live-shaped `guild.update` snapshot carrying an unexpected value) throws a
|
||||
* [SerializationException] out of the Retrofit converter. That is a broken contract
|
||||
* with the backend, not a bug to crash on: the request completed but the response is
|
||||
* unusable — an invalid upstream response — so it is surfaced as a server-side error
|
||||
* (`502` → [ErrorKind.SERVER]) the screen renders as "something went wrong, retry",
|
||||
* exactly the graceful-degradation the layer promises (never throw for an expected
|
||||
* failure). Without this catch the exception escapes the collecting coroutine and
|
||||
* takes down the whole app.
|
||||
*/
|
||||
suspend fun <T> safeApiCall(block: suspend () -> T): ApiResult<T> = try {
|
||||
ApiResult.Ok(block())
|
||||
@@ -57,9 +46,4 @@ suspend fun <T> safeApiCall(block: suspend () -> T): ApiResult<T> = try {
|
||||
ApiResult.HttpError(e.code(), e.message())
|
||||
} catch (e: IOException) {
|
||||
ApiResult.NetworkError(e)
|
||||
} catch (e: SerializationException) {
|
||||
ApiResult.HttpError(MALFORMED_RESPONSE_STATUS, e.message)
|
||||
}
|
||||
|
||||
/** Synthetic status for a 2xx body the app couldn't decode — an invalid upstream response. */
|
||||
private const val MALFORMED_RESPONSE_STATUS = 502
|
||||
|
||||
@@ -26,8 +26,12 @@ class WebsiteUrls @Inject constructor(
|
||||
/** 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"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,97 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.AdminDashboardDto
|
||||
import com.runicgateway.app.data.api.dto.AdminPostDto
|
||||
import com.runicgateway.app.data.api.dto.BanRequest
|
||||
import com.runicgateway.app.data.api.dto.BroadcastRequest
|
||||
import com.runicgateway.app.data.api.dto.KickRequest
|
||||
import com.runicgateway.app.data.api.dto.PageRespondRequest
|
||||
import com.runicgateway.app.data.api.dto.PostCreateRequest
|
||||
import com.runicgateway.app.data.api.dto.PublishRequest
|
||||
import com.runicgateway.app.data.api.dto.SiteModeRequest
|
||||
import com.runicgateway.app.data.api.dto.SiteModeStateDto
|
||||
import com.runicgateway.app.data.api.dto.SupportPageDto
|
||||
import com.runicgateway.app.data.api.dto.UnbanRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiTagDto
|
||||
import retrofit2.Response
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.DELETE
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.PATCH
|
||||
import retrofit2.http.PUT
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.Path
|
||||
|
||||
/**
|
||||
* The M10 staff-operations surface over `/api/v1/admin/…` (PLAN.md §1, §6.4). On
|
||||
* the authed client — every call carries the bearer, and the backend re-checks the
|
||||
* caller's role on every request (`staffOnly` / `modAccess` / `adminOnly`), so a
|
||||
* demoted user is refused server-side even if a stale menu still showed the entry.
|
||||
*
|
||||
* Grows one group at a time (dashboard first); moderation, support, and content
|
||||
* endpoints are added with their screens.
|
||||
*/
|
||||
interface AdminApi {
|
||||
|
||||
/** `GET /admin/dashboard` — summary counts + site mode (any staff role). */
|
||||
@GET("api/v1/admin/dashboard")
|
||||
suspend fun dashboard(): AdminDashboardDto
|
||||
|
||||
/** `PUT /admin/site-mode` — switch live/maintenance (admin only; 403 otherwise). */
|
||||
@PUT("api/v1/admin/site-mode")
|
||||
suspend fun setSiteMode(@Body body: SiteModeRequest): SiteModeStateDto
|
||||
|
||||
// ── Content: news posts (any staff role) ──────────────────────────────
|
||||
@GET("api/v1/admin/posts")
|
||||
suspend fun posts(): List<AdminPostDto>
|
||||
|
||||
@POST("api/v1/admin/posts")
|
||||
suspend fun createPost(@Body body: PostCreateRequest): AdminPostDto
|
||||
|
||||
@PATCH("api/v1/admin/posts/{id}/publish")
|
||||
suspend fun publishPost(@Path("id") id: Long, @Body body: PublishRequest): AdminPostDto
|
||||
|
||||
@DELETE("api/v1/admin/posts/{id}")
|
||||
suspend fun deletePost(@Path("id") id: Long): Response<Unit>
|
||||
|
||||
// ── Content: wiki taxonomy (any staff role) ───────────────────────────
|
||||
@GET("api/v1/admin/wiki/categories")
|
||||
suspend fun wikiCategories(): List<AdminWikiCategoryDto>
|
||||
|
||||
@POST("api/v1/admin/wiki/categories")
|
||||
suspend fun createWikiCategory(@Body body: WikiCategoryRequest): AdminWikiCategoryDto
|
||||
|
||||
@DELETE("api/v1/admin/wiki/categories/{id}")
|
||||
suspend fun deleteWikiCategory(@Path("id") id: Long): Response<Unit>
|
||||
|
||||
@GET("api/v1/admin/wiki/tags")
|
||||
suspend fun wikiTags(): List<AdminWikiTagDto>
|
||||
|
||||
// ── Moderation: shard write plane (admin/moderator) ───────────────────
|
||||
@POST("api/v1/admin/shard/kick")
|
||||
suspend fun kick(@Body body: KickRequest): Response<Unit>
|
||||
|
||||
@POST("api/v1/admin/shard/ban")
|
||||
suspend fun ban(@Body body: BanRequest): Response<Unit>
|
||||
|
||||
@POST("api/v1/admin/shard/unban")
|
||||
suspend fun unban(@Body body: UnbanRequest): Response<Unit>
|
||||
|
||||
@POST("api/v1/admin/shard/broadcast")
|
||||
suspend fun broadcast(@Body body: BroadcastRequest): Response<Unit>
|
||||
|
||||
// ── Support queue: help pages (admin/moderator) ───────────────────────
|
||||
@GET("api/v1/admin/shard/pages")
|
||||
suspend fun supportPages(): List<SupportPageDto>
|
||||
|
||||
@POST("api/v1/admin/shard/pages/{id}/respond")
|
||||
suspend fun respondPage(@Path("id") id: String, @Body body: PageRespondRequest): Response<Unit>
|
||||
|
||||
@POST("api/v1/admin/shard/pages/{id}/close")
|
||||
suspend fun closePage(@Path("id") id: String): Response<Unit>
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
/*
|
||||
* 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
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
/*
|
||||
* 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>
|
||||
}
|
||||
@@ -1,179 +0,0 @@
|
||||
/*
|
||||
* 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.JsonElement
|
||||
|
||||
/**
|
||||
* Wire shapes for the M10 staff-operations surface over `/api/v1/admin/…` (PLAN.md
|
||||
* §1, §6.4). These are consumed only by the staff screens (dashboard, moderation,
|
||||
* support, content); every DTO ignores unknown keys (NetworkModule's lenient Json)
|
||||
* so additive backend fields stay safe. Nothing here is auto-provisioned or secret.
|
||||
*/
|
||||
|
||||
/** `GET /admin/dashboard` — the staff landing summary. */
|
||||
@Serializable
|
||||
data class AdminDashboardDto(
|
||||
@SerialName("site_mode") val siteMode: String = "live",
|
||||
@SerialName("last_change") val lastChange: SiteModeChangeDto = SiteModeChangeDto(),
|
||||
val counts: AdminCountsDto = AdminCountsDto(),
|
||||
@SerialName("recent_activity") val recentActivity: List<AdminActivityDto> = emptyList(),
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class SiteModeChangeDto(
|
||||
val at: String? = null,
|
||||
val by: String? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class AdminCountsDto(
|
||||
/** Post counts keyed by DB category (`news`, `five_on_friday`, …). */
|
||||
val posts: Map<String, Int> = emptyMap(),
|
||||
val users: Int = 0,
|
||||
)
|
||||
|
||||
/** One row of the recent admin-activity log. `detail` is provider-shaped JSON. */
|
||||
@Serializable
|
||||
data class AdminActivityDto(
|
||||
val id: Long = 0,
|
||||
val username: String? = null,
|
||||
val action: String = "",
|
||||
val detail: JsonElement? = null,
|
||||
@SerialName("created_at") val createdAt: String? = null,
|
||||
)
|
||||
|
||||
/** `PUT /admin/site-mode` request + response. */
|
||||
@Serializable
|
||||
data class SiteModeRequest(val mode: String)
|
||||
|
||||
@Serializable
|
||||
data class SiteModeStateDto(
|
||||
@SerialName("site_mode") val siteMode: String = "live",
|
||||
@SerialName("changed_at") val changedAt: String? = null,
|
||||
@SerialName("changed_by") val changedBy: String? = null,
|
||||
)
|
||||
|
||||
// ── Content: news posts ───────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* A post row from `GET /admin/posts` (all posts, incl. unpublished — unlike the
|
||||
* public feed). `published` is a 0/1 flag (MariaDB tinyint), exposed as [isPublished].
|
||||
*/
|
||||
@Serializable
|
||||
data class AdminPostDto(
|
||||
val id: Long,
|
||||
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,
|
||||
val published: Int = 0,
|
||||
@SerialName("published_at") val publishedAt: String? = null,
|
||||
@SerialName("created_at") val createdAt: String? = null,
|
||||
) {
|
||||
val isPublished: Boolean get() = published != 0
|
||||
}
|
||||
|
||||
/** `POST/PUT /admin/posts` body. `category` is a URL category the backend maps
|
||||
* (news | five-on-friday | newsletter | screenshots). */
|
||||
@Serializable
|
||||
data class PostCreateRequest(
|
||||
val category: String,
|
||||
val title: String,
|
||||
val excerpt: String? = null,
|
||||
val body: String? = null,
|
||||
@SerialName("image_url") val imageUrl: String? = null,
|
||||
val published: Boolean = false,
|
||||
)
|
||||
|
||||
/** `PATCH /admin/posts/:id/publish` body. */
|
||||
@Serializable
|
||||
data class PublishRequest(val published: Boolean)
|
||||
|
||||
// ── Content: wiki taxonomy ────────────────────────────────────────────────
|
||||
|
||||
/** A wiki category from `GET /admin/wiki/categories` (with page counts). */
|
||||
@Serializable
|
||||
data class AdminWikiCategoryDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val title: String = "",
|
||||
val description: String? = null,
|
||||
@SerialName("sort_order") val sortOrder: Int? = null,
|
||||
@SerialName("page_count") val pageCount: Int? = null,
|
||||
@SerialName("published_count") val publishedCount: Int? = null,
|
||||
)
|
||||
|
||||
/** `POST /admin/wiki/categories` body. */
|
||||
@Serializable
|
||||
data class WikiCategoryRequest(
|
||||
val slug: String,
|
||||
val title: String,
|
||||
val description: String? = null,
|
||||
@SerialName("sort_order") val sortOrder: Int? = null,
|
||||
)
|
||||
|
||||
/** A wiki tag from `GET /admin/wiki/tags` (tags derive from pages; read-only here). */
|
||||
@Serializable
|
||||
data class AdminWikiTagDto(
|
||||
val id: Long,
|
||||
val slug: String = "",
|
||||
val label: String = "",
|
||||
@SerialName("published_count") val publishedCount: Int? = null,
|
||||
)
|
||||
|
||||
// ── Moderation (admin/moderator; shard write plane) ───────────────────────
|
||||
|
||||
/** `POST /admin/shard/kick` — at least one of account/serial. */
|
||||
@Serializable
|
||||
data class KickRequest(val account: String? = null, val serial: String? = null)
|
||||
|
||||
/** `POST /admin/shard/ban` — account/serial + optional duration (0/absent = indefinite). */
|
||||
@Serializable
|
||||
data class BanRequest(
|
||||
val account: String? = null,
|
||||
val serial: String? = null,
|
||||
@SerialName("durationSec") val durationSec: Long? = null,
|
||||
val reason: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /admin/shard/unban`. */
|
||||
@Serializable
|
||||
data class UnbanRequest(val account: String)
|
||||
|
||||
/** `POST /admin/shard/broadcast` — a system message to everyone online. */
|
||||
@Serializable
|
||||
data class BroadcastRequest(val text: String, val hue: Int? = null)
|
||||
|
||||
// ── Support queue (admin/moderator; help pages) ───────────────────────────
|
||||
|
||||
/**
|
||||
* One open help page from `GET /admin/shard/pages` (INTEGRATION.md §4). `pageId`
|
||||
* is the sender's in-game serial (the `:id` for respond/close). Permissive — the
|
||||
* shard-state fields beyond these (coords, timing) are ignored.
|
||||
*/
|
||||
@Serializable
|
||||
data class SupportPageDto(
|
||||
@SerialName("pageId") val pageId: String = "",
|
||||
val type: String? = null,
|
||||
val message: String? = null,
|
||||
val handled: Boolean? = null,
|
||||
val handler: String? = null,
|
||||
val sender: SupportActorDto? = null,
|
||||
)
|
||||
|
||||
/** The page's sender (actor object); [account] present when the character is linked. */
|
||||
@Serializable
|
||||
data class SupportActorDto(
|
||||
val name: String? = null,
|
||||
val account: String? = null,
|
||||
)
|
||||
|
||||
/** `POST /admin/shard/pages/:id/respond` — reply, optionally closing the page. */
|
||||
@Serializable
|
||||
data class PageRespondRequest(val message: String, val close: Boolean = false)
|
||||
@@ -1,67 +0,0 @@
|
||||
/*
|
||||
* 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(),
|
||||
)
|
||||
@@ -14,8 +14,8 @@ import kotlinx.serialization.json.JsonObject
|
||||
* `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"), the same opaque-key form used on
|
||||
* the public boards (`ShardDto.ActorDto`/`ChampDto`/`HouseDto`) — never numbers.
|
||||
* 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 ─────────────────────────────────────────────────────
|
||||
|
||||
@@ -55,17 +55,6 @@ data class RegistrationFlagsDto(
|
||||
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.
|
||||
@@ -78,6 +67,4 @@ data class SettingsDto(
|
||||
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(),
|
||||
)
|
||||
|
||||
@@ -15,18 +15,13 @@ import kotlinx.serialization.json.JsonObject
|
||||
* `*.update` frames on `/public/shard/stream` decode into these same DTOs.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A game actor (player/leader/governor) as embedded in board payloads. Per the wire
|
||||
* spec (`docs/link/INTEGRATION.md` §1), in-game [serial]s are opaque hex-string keys
|
||||
* (e.g. `"0x1A2B"`), never numbers, and [webId] is the linked site-user id as a
|
||||
* string (e.g. `"9931"`) — both are decoded as strings, not parsed.
|
||||
*/
|
||||
/** A game actor (player/leader/governor) as embedded in board payloads. */
|
||||
@Serializable
|
||||
data class ActorDto(
|
||||
val serial: String? = null,
|
||||
val serial: Long? = null,
|
||||
val name: String? = null,
|
||||
val acct: String? = null,
|
||||
val webId: String? = null,
|
||||
val webId: Long? = null,
|
||||
) {
|
||||
/** Best display label for this actor. */
|
||||
val label: String get() = name ?: acct ?: "Someone"
|
||||
@@ -78,7 +73,7 @@ data class FeedEventDto(
|
||||
*/
|
||||
@Serializable
|
||||
data class OnlineStaffDto(
|
||||
val serial: String? = null,
|
||||
val serial: Long? = null,
|
||||
val name: String? = null,
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
@@ -92,7 +87,7 @@ data class OnlineStaffDto(
|
||||
*/
|
||||
@Serializable
|
||||
data class HouseDto(
|
||||
val serial: String = "",
|
||||
val serial: Long = 0,
|
||||
val name: String? = null,
|
||||
val region: String? = null,
|
||||
val map: String? = null,
|
||||
@@ -109,7 +104,7 @@ data class HouseDto(
|
||||
*/
|
||||
@Serializable
|
||||
data class ChampDto(
|
||||
val serial: String = "",
|
||||
val serial: Long = 0,
|
||||
val category: String? = null,
|
||||
val type: String? = null,
|
||||
val name: String? = null,
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
/*
|
||||
* 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,
|
||||
)
|
||||
@@ -1,94 +0,0 @@
|
||||
/*
|
||||
* 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.AdminApi
|
||||
import com.runicgateway.app.data.api.dto.AdminDashboardDto
|
||||
import com.runicgateway.app.data.api.dto.AdminPostDto
|
||||
import com.runicgateway.app.data.api.dto.BanRequest
|
||||
import com.runicgateway.app.data.api.dto.BroadcastRequest
|
||||
import com.runicgateway.app.data.api.dto.KickRequest
|
||||
import com.runicgateway.app.data.api.dto.PageRespondRequest
|
||||
import com.runicgateway.app.data.api.dto.PostCreateRequest
|
||||
import com.runicgateway.app.data.api.dto.PublishRequest
|
||||
import com.runicgateway.app.data.api.dto.SiteModeRequest
|
||||
import com.runicgateway.app.data.api.dto.SiteModeStateDto
|
||||
import com.runicgateway.app.data.api.dto.SupportPageDto
|
||||
import com.runicgateway.app.data.api.dto.UnbanRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiTagDto
|
||||
import retrofit2.HttpException
|
||||
import retrofit2.Response
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The M10 staff-operations data source over `/api/v1/admin/…` (PLAN.md §1, §6.4).
|
||||
* Every call returns a typed [ApiResult] so a screen renders a clean error/retry
|
||||
* rather than crashing — a `403` (role lost since the menu rendered) and a `503`
|
||||
* (shard/sidecar offline for the shard-write actions) are both expected outcomes
|
||||
* the UI handles, never thrown. Role is authoritative on the server.
|
||||
*/
|
||||
@Singleton
|
||||
class AdminRepository @Inject constructor(
|
||||
private val api: AdminApi,
|
||||
) {
|
||||
suspend fun dashboard(): ApiResult<AdminDashboardDto> = safeApiCall { api.dashboard() }
|
||||
|
||||
suspend fun setSiteMode(mode: String): ApiResult<SiteModeStateDto> =
|
||||
safeApiCall { api.setSiteMode(SiteModeRequest(mode)) }
|
||||
|
||||
// ── Content: news posts ───────────────────────────────────────────────
|
||||
suspend fun posts(): ApiResult<List<AdminPostDto>> = safeApiCall { api.posts() }
|
||||
|
||||
suspend fun createPost(body: PostCreateRequest): ApiResult<AdminPostDto> =
|
||||
safeApiCall { api.createPost(body) }
|
||||
|
||||
suspend fun setPostPublished(id: Long, published: Boolean): ApiResult<AdminPostDto> =
|
||||
safeApiCall { api.publishPost(id, PublishRequest(published)) }
|
||||
|
||||
suspend fun deletePost(id: Long): ApiResult<Unit> = safeApiCall { api.deletePost(id).requireOk() }
|
||||
|
||||
// ── Content: wiki taxonomy ────────────────────────────────────────────
|
||||
suspend fun wikiCategories(): ApiResult<List<AdminWikiCategoryDto>> = safeApiCall { api.wikiCategories() }
|
||||
|
||||
suspend fun createWikiCategory(body: WikiCategoryRequest): ApiResult<AdminWikiCategoryDto> =
|
||||
safeApiCall { api.createWikiCategory(body) }
|
||||
|
||||
suspend fun deleteWikiCategory(id: Long): ApiResult<Unit> =
|
||||
safeApiCall { api.deleteWikiCategory(id).requireOk() }
|
||||
|
||||
suspend fun wikiTags(): ApiResult<List<AdminWikiTagDto>> = safeApiCall { api.wikiTags() }
|
||||
|
||||
// ── Moderation: shard write plane ─────────────────────────────────────
|
||||
suspend fun kick(account: String?, serial: String?): ApiResult<Unit> =
|
||||
safeApiCall { api.kick(KickRequest(account, serial)).requireOk() }
|
||||
|
||||
suspend fun ban(account: String?, serial: String?, durationSec: Long?, reason: String?): ApiResult<Unit> =
|
||||
safeApiCall { api.ban(BanRequest(account, serial, durationSec, reason)).requireOk() }
|
||||
|
||||
suspend fun unban(account: String): ApiResult<Unit> =
|
||||
safeApiCall { api.unban(UnbanRequest(account)).requireOk() }
|
||||
|
||||
suspend fun broadcast(text: String, hue: Int?): ApiResult<Unit> =
|
||||
safeApiCall { api.broadcast(BroadcastRequest(text, hue)).requireOk() }
|
||||
|
||||
// ── Support queue: help pages ─────────────────────────────────────────
|
||||
suspend fun supportPages(): ApiResult<List<SupportPageDto>> = safeApiCall { api.supportPages() }
|
||||
|
||||
suspend fun respondPage(id: String, message: String, close: Boolean): ApiResult<Unit> =
|
||||
safeApiCall { api.respondPage(id, PageRespondRequest(message, close)).requireOk() }
|
||||
|
||||
suspend fun closePage(id: String): ApiResult<Unit> =
|
||||
safeApiCall { api.closePage(id).requireOk() }
|
||||
|
||||
/** Turn a bodyless [Response] into a thrown [HttpException] on a non-2xx, so
|
||||
* [safeApiCall] can fold it into an [ApiResult.HttpError] like every other call. */
|
||||
private fun Response<Unit>.requireOk() {
|
||||
if (!isSuccessful) throw HttpException(this)
|
||||
}
|
||||
}
|
||||
@@ -4,16 +4,12 @@
|
||||
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.coroutines.delay
|
||||
import kotlinx.serialization.json.Json
|
||||
import retrofit2.Response
|
||||
import java.io.IOException
|
||||
@@ -29,48 +25,10 @@ import javax.inject.Singleton
|
||||
@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 three outcomes of SSO provider discovery, so the login screen can tell a
|
||||
* shard that offers no SSO ([None]) apart from a discovery that failed
|
||||
* ([Unavailable], offer a retry) — the old "empty on any failure" conflation hid
|
||||
* a broken call behind a dead website hand-off (§4.2). */
|
||||
sealed interface SsoDiscovery {
|
||||
/** At least one enabled provider — render a native button per entry. */
|
||||
data class Available(val providers: List<SsoProviderDto>) : SsoDiscovery
|
||||
|
||||
/** Discovery succeeded but the shard has no SSO providers configured. */
|
||||
data object None : SsoDiscovery
|
||||
|
||||
/** The discovery call failed (offline / server error) — surface a retry. */
|
||||
data object Unavailable : SsoDiscovery
|
||||
}
|
||||
|
||||
/**
|
||||
* Discover the shard's enabled SSO providers for the native login buttons (§4.2).
|
||||
* Public discovery, never secrets. Retries once before reporting [Unavailable],
|
||||
* so a single transient blip doesn't strand the user.
|
||||
*/
|
||||
suspend fun ssoProviders(): SsoDiscovery {
|
||||
var lastFailed = false
|
||||
repeat(2) { attempt ->
|
||||
try {
|
||||
val providers = ssoApi.providers()
|
||||
return if (providers.isEmpty()) SsoDiscovery.None else SsoDiscovery.Available(providers)
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: Exception) {
|
||||
lastFailed = true
|
||||
if (attempt == 0) delay(DISCOVERY_RETRY_DELAY_MS)
|
||||
}
|
||||
}
|
||||
return if (lastFailed) SsoDiscovery.Unavailable else SsoDiscovery.None
|
||||
}
|
||||
|
||||
/** Outcome of a login attempt (§4.1). */
|
||||
sealed interface LoginResult {
|
||||
data object Success : LoginResult
|
||||
@@ -117,16 +75,6 @@ class AuthRepository @Inject constructor(
|
||||
* 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))
|
||||
@@ -164,8 +112,4 @@ class AuthRepository @Inject constructor(
|
||||
} catch (_: Exception) {
|
||||
false
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val DISCOVERY_RETRY_DELAY_MS = 400L
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,7 +26,6 @@ class ConnectionRepository @Inject constructor(
|
||||
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,
|
||||
) {
|
||||
|
||||
@@ -97,14 +96,6 @@ class ConnectionRepository @Inject constructor(
|
||||
* 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)
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
/*
|
||||
* 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)) }
|
||||
}
|
||||
@@ -14,11 +14,8 @@ 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.AdminApi
|
||||
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
|
||||
@@ -98,11 +95,6 @@ object NetworkModule {
|
||||
@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
|
||||
@@ -114,17 +106,6 @@ object NetworkModule {
|
||||
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)
|
||||
|
||||
/** Staff operations (§1, §6.4, M10) — bearer-authed; the server re-checks role every call. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideAdminApi(retrofit: Retrofit): AdminApi = retrofit.create(AdminApi::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
|
||||
|
||||
@@ -5,15 +5,13 @@ package com.runicgateway.app.di
|
||||
|
||||
import com.runicgateway.app.core.auth.EncryptedTokenStore
|
||||
import com.runicgateway.app.core.auth.TokenStore
|
||||
import com.runicgateway.app.core.auth.sso.EncryptedPendingSsoStore
|
||||
import com.runicgateway.app.core.auth.sso.PendingSsoStore
|
||||
import dagger.Binds
|
||||
import dagger.Module
|
||||
import dagger.hilt.InstallIn
|
||||
import dagger.hilt.components.SingletonComponent
|
||||
import javax.inject.Singleton
|
||||
|
||||
/** Binds the at-rest stores to their EncryptedSharedPreferences impls (§4.3). */
|
||||
/** Binds the at-rest token store to its EncryptedSharedPreferences impl (§4.3). */
|
||||
@Module
|
||||
@InstallIn(SingletonComponent::class)
|
||||
abstract class StorageModule {
|
||||
@@ -21,8 +19,4 @@ abstract class StorageModule {
|
||||
@Binds
|
||||
@Singleton
|
||||
abstract fun bindTokenStore(impl: EncryptedTokenStore): TokenStore
|
||||
|
||||
@Binds
|
||||
@Singleton
|
||||
abstract fun bindPendingSsoStore(impl: EncryptedPendingSsoStore): PendingSsoStore
|
||||
}
|
||||
|
||||
@@ -6,7 +6,6 @@ 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
|
||||
@@ -28,7 +27,6 @@ class AppViewModel @Inject constructor(
|
||||
private val connectionRepository: ConnectionRepository,
|
||||
private val settingsRepository: SettingsRepository,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val pushManager: PushManager,
|
||||
) : ViewModel() {
|
||||
|
||||
sealed interface AppState {
|
||||
@@ -68,16 +66,8 @@ class AppViewModel @Inject constructor(
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
private suspend fun loadBrand(): BrandDto? =
|
||||
(settingsRepository.getSettings() as? ApiResult.Ok)?.data?.brand
|
||||
|
||||
/**
|
||||
* Resolve a possibly site-relative asset path (branding logos, post images)
|
||||
|
||||
@@ -3,12 +3,9 @@
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
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.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Menu
|
||||
@@ -59,11 +56,6 @@ 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.admin.AdminContentScreen
|
||||
import com.runicgateway.app.ui.admin.AdminDashboardScreen
|
||||
import com.runicgateway.app.ui.admin.AdminModerationScreen
|
||||
import com.runicgateway.app.ui.admin.AdminSupportScreen
|
||||
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
|
||||
@@ -83,9 +75,7 @@ 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,
|
||||
Routes.ADMIN_DASHBOARD, Routes.ADMIN_CONTENT, Routes.ADMIN_MODERATION, Routes.ADMIN_SUPPORT,
|
||||
)
|
||||
|
||||
/**
|
||||
@@ -101,8 +91,6 @@ fun RunicApp(
|
||||
brand: BrandDto?,
|
||||
onChangeServer: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
deepLinkStream: String? = null,
|
||||
onDeepLinkConsumed: () -> Unit = {},
|
||||
sessionViewModel: SessionViewModel = hiltViewModel(),
|
||||
) {
|
||||
val navController = rememberNavController()
|
||||
@@ -117,16 +105,6 @@ fun RunicApp(
|
||||
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
|
||||
@@ -142,11 +120,6 @@ fun RunicApp(
|
||||
selectedTextColor = MaterialTheme.colorScheme.onSecondaryContainer,
|
||||
unselectedTextColor = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
// Scroll the drawer: a signed-in session adds Account, Notifications, and
|
||||
// the player groups, and the full list overflows a phone's drawer height —
|
||||
// without this the lower entries (Notifications included) are clipped and
|
||||
// unreachable. See RunicGateway M10.
|
||||
Column(Modifier.verticalScroll(rememberScrollState())) {
|
||||
Spacer(Modifier.height(12.dp))
|
||||
Text(
|
||||
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
|
||||
@@ -202,7 +175,6 @@ fun RunicApp(
|
||||
colors = drawerItemColors,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
}
|
||||
}
|
||||
},
|
||||
) {
|
||||
@@ -320,15 +292,7 @@ private fun RunicNavHost(
|
||||
ContactScreen()
|
||||
}
|
||||
composable(Routes.LOGIN) {
|
||||
// Leave the login screen as soon as the session is established — whether by
|
||||
// password or the SSO bridge. Keying off the shared session (not just the
|
||||
// login VM's local flag) makes this robust to the deep-link/recomposition
|
||||
// timing of the Custom-Tab return, which the LoginScreen callback alone can miss.
|
||||
if (session is Session.SignedIn) {
|
||||
LaunchedEffect(Unit) { navController.popBackStack(Routes.LOGIN, inclusive = true) }
|
||||
} else {
|
||||
LoginScreen(onSignedIn = { navController.popBackStack() })
|
||||
}
|
||||
LoginScreen(onSignedIn = { navController.popBackStack() })
|
||||
}
|
||||
composable(Routes.ACCOUNT) {
|
||||
// Only meaningful while signed in; a sign-out (here or from the drawer)
|
||||
@@ -345,14 +309,6 @@ private fun RunicNavHost(
|
||||
}
|
||||
}
|
||||
}
|
||||
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
|
||||
@@ -374,24 +330,6 @@ private fun RunicNavHost(
|
||||
composable(Routes.PLAYER_HOUSES) {
|
||||
PlayerGate(session, navController) { MyHousesScreen() }
|
||||
}
|
||||
|
||||
// ── Staff operations (§1, §6.4, M10) — reached from the staff menu section.
|
||||
// The backend re-checks role on every /admin/… call; these gates only mirror
|
||||
// the menu's visibility so a signed-out/demoted user isn't left on a stale screen.
|
||||
composable(Routes.ADMIN_DASHBOARD) {
|
||||
StaffGate(session, navController) {
|
||||
AdminDashboardScreen(isAdmin = (session as? Session.SignedIn)?.user?.isAdmin == true)
|
||||
}
|
||||
}
|
||||
composable(Routes.ADMIN_CONTENT) {
|
||||
StaffGate(session, navController) { AdminContentScreen() }
|
||||
}
|
||||
composable(Routes.ADMIN_MODERATION) {
|
||||
StaffGate(session, navController, require = { it.isModerator }) { AdminModerationScreen() }
|
||||
}
|
||||
composable(Routes.ADMIN_SUPPORT) {
|
||||
StaffGate(session, navController, require = { it.isModerator }) { AdminSupportScreen() }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -413,23 +351,6 @@ private fun PlayerGate(
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The staff-operations analogue of [PlayerGate] (§1, M10): render [content] only for
|
||||
* a signed-in staff account; a signed-out/demoted session (caught on resume, §4.3) is
|
||||
* sent home rather than left on a stale admin screen. The backend is the authority —
|
||||
* every `/admin/…` call re-checks role — so this only mirrors the menu's visibility.
|
||||
*/
|
||||
@Composable
|
||||
private fun StaffGate(
|
||||
session: Session,
|
||||
navController: NavHostController,
|
||||
require: (com.runicgateway.app.core.auth.SessionUser) -> Boolean = { it.isStaff },
|
||||
content: @Composable () -> Unit,
|
||||
) {
|
||||
val ok = (session as? Session.SignedIn)?.user?.let(require) == true
|
||||
if (ok) content() else 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) {
|
||||
|
||||
@@ -1,292 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
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.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.width
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.AlertDialog
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.FilterChip
|
||||
import androidx.compose.material3.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Switch
|
||||
import androidx.compose.material3.Tab
|
||||
import androidx.compose.material3.TabRow
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextButton
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableIntStateOf
|
||||
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.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.AdminPostDto
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiTagDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
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 staff content screen (PLAN.md §1, M10): news posts and wiki taxonomy, in two
|
||||
* tabs. Create/publish/delete over the existing `/admin/posts` + `/admin/wiki/…`
|
||||
* routes; the CMS block/hero editor stays out of scope. Any staff role; the server
|
||||
* re-checks on every call.
|
||||
*/
|
||||
@Composable
|
||||
fun AdminContentScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AdminContentViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
var tab by rememberSaveable { mutableIntStateOf(0) }
|
||||
var showNewPost by rememberSaveable { mutableStateOf(false) }
|
||||
var showNewCategory by rememberSaveable { mutableStateOf(false) }
|
||||
|
||||
Column(modifier.fillMaxSize()) {
|
||||
TabRow(selectedTabIndex = tab) {
|
||||
Tab(selected = tab == 0, onClick = { tab = 0 }, text = { Text(stringResource(R.string.admin_content_tab_posts)) })
|
||||
Tab(selected = tab == 1, onClick = { tab = 1 }, text = { Text(stringResource(R.string.admin_content_tab_wiki)) })
|
||||
}
|
||||
|
||||
state.feedback?.let {
|
||||
Text(
|
||||
text = stringResource(it.messageRes),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = if (it.ok) MaterialTheme.colorScheme.onSurfaceVariant else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.fillMaxWidth().padding(horizontal = 16.dp, vertical = 6.dp),
|
||||
)
|
||||
}
|
||||
|
||||
when (tab) {
|
||||
0 -> PostsTab(
|
||||
state = state.posts,
|
||||
busy = state.busy,
|
||||
onNew = { showNewPost = true },
|
||||
onToggle = viewModel::togglePublish,
|
||||
onDelete = viewModel::deletePost,
|
||||
onRetry = viewModel::loadPosts,
|
||||
)
|
||||
else -> WikiTab(
|
||||
state = state.categories,
|
||||
tags = state.tags,
|
||||
busy = state.busy,
|
||||
onNew = { showNewCategory = true },
|
||||
onDelete = viewModel::deleteCategory,
|
||||
onRetry = viewModel::loadWiki,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (showNewPost) {
|
||||
NewPostDialog(
|
||||
categories = viewModel.postCategories,
|
||||
onDismiss = { showNewPost = false },
|
||||
onCreate = { cat, title, excerpt, body, published ->
|
||||
viewModel.createPost(cat, title, excerpt, body, published)
|
||||
showNewPost = false
|
||||
},
|
||||
)
|
||||
}
|
||||
if (showNewCategory) {
|
||||
NewCategoryDialog(
|
||||
onDismiss = { showNewCategory = false },
|
||||
onCreate = { slug, title, desc, sort ->
|
||||
viewModel.createCategory(slug, title, desc, sort)
|
||||
showNewCategory = false
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PostsTab(
|
||||
state: UiState<List<AdminPostDto>>,
|
||||
busy: Boolean,
|
||||
onNew: () -> Unit,
|
||||
onToggle: (AdminPostDto) -> Unit,
|
||||
onDelete: (Long) -> Unit,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
when (state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(state.kind, onRetry = onRetry)
|
||||
is UiState.Success -> LazyColumn(Modifier.fillMaxSize().padding(16.dp)) {
|
||||
item {
|
||||
OutlinedButton(onClick = onNew, enabled = !busy, modifier = Modifier.fillMaxWidth().padding(bottom = 8.dp)) {
|
||||
Text(stringResource(R.string.admin_content_new_post))
|
||||
}
|
||||
}
|
||||
items(state.data, key = { it.id }) { post ->
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
Text(post.title, style = MaterialTheme.typography.bodyLarge)
|
||||
Spacer(Modifier.height(4.dp))
|
||||
Row(verticalAlignment = Alignment.CenterVertically) {
|
||||
StatusPill(
|
||||
text = if (post.isPublished) stringResource(R.string.admin_content_published)
|
||||
else stringResource(R.string.admin_content_draft),
|
||||
tone = if (post.isPublished) PillTone.Success else PillTone.Neutral,
|
||||
)
|
||||
Spacer(Modifier.width(8.dp))
|
||||
Text(post.category, style = MaterialTheme.typography.bodySmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
Row(Modifier.fillMaxWidth().padding(top = 8.dp), horizontalArrangement = Arrangement.End) {
|
||||
TextButton(onClick = { onToggle(post) }, enabled = !busy) {
|
||||
Text(
|
||||
stringResource(
|
||||
if (post.isPublished) R.string.admin_content_unpublish else R.string.admin_content_publish,
|
||||
),
|
||||
)
|
||||
}
|
||||
TextButton(onClick = { onDelete(post.id) }, enabled = !busy) {
|
||||
Text(stringResource(R.string.admin_content_delete), color = MaterialTheme.colorScheme.error)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun WikiTab(
|
||||
state: UiState<List<AdminWikiCategoryDto>>,
|
||||
tags: List<AdminWikiTagDto>,
|
||||
busy: Boolean,
|
||||
onNew: () -> Unit,
|
||||
onDelete: (Long) -> Unit,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
when (state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(state.kind, onRetry = onRetry)
|
||||
is UiState.Success -> LazyColumn(Modifier.fillMaxSize().padding(16.dp)) {
|
||||
item {
|
||||
OutlinedButton(onClick = onNew, enabled = !busy, modifier = Modifier.fillMaxWidth().padding(bottom = 8.dp)) {
|
||||
Text(stringResource(R.string.admin_content_new_category))
|
||||
}
|
||||
}
|
||||
items(state.data, key = { it.id }) { cat ->
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
Text(cat.title, style = MaterialTheme.typography.bodyLarge)
|
||||
Text(
|
||||
text = stringResource(R.string.admin_content_cat_meta, cat.slug, cat.pageCount ?: 0),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Row(Modifier.fillMaxWidth().padding(top = 8.dp), horizontalArrangement = Arrangement.End) {
|
||||
TextButton(onClick = { onDelete(cat.id) }, enabled = !busy) {
|
||||
Text(stringResource(R.string.admin_content_delete), color = MaterialTheme.colorScheme.error)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (tags.isNotEmpty()) {
|
||||
item {
|
||||
HorizontalDivider(Modifier.padding(vertical = 12.dp))
|
||||
Text(
|
||||
stringResource(R.string.admin_content_tags, tags.joinToString(", ") { it.label }),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun NewPostDialog(
|
||||
categories: List<String>,
|
||||
onDismiss: () -> Unit,
|
||||
onCreate: (category: String, title: String, excerpt: String, body: String, published: Boolean) -> Unit,
|
||||
) {
|
||||
var category by rememberSaveable { mutableStateOf(categories.first()) }
|
||||
var title by rememberSaveable { mutableStateOf("") }
|
||||
var excerpt by rememberSaveable { mutableStateOf("") }
|
||||
var body by rememberSaveable { mutableStateOf("") }
|
||||
var published by rememberSaveable { mutableStateOf(false) }
|
||||
|
||||
AlertDialog(
|
||||
onDismissRequest = onDismiss,
|
||||
confirmButton = {
|
||||
TextButton(onClick = { onCreate(category, title, excerpt, body, published) }) {
|
||||
Text(stringResource(R.string.admin_content_create))
|
||||
}
|
||||
},
|
||||
dismissButton = { TextButton(onClick = onDismiss) { Text(stringResource(R.string.action_cancel)) } },
|
||||
title = { Text(stringResource(R.string.admin_content_new_post)) },
|
||||
text = {
|
||||
Column {
|
||||
Row(horizontalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
categories.forEach { c ->
|
||||
FilterChip(selected = category == c, onClick = { category = c }, label = { Text(c) })
|
||||
}
|
||||
}
|
||||
OutlinedTextField(value = title, onValueChange = { title = it }, singleLine = true, label = { Text(stringResource(R.string.admin_content_field_title)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = excerpt, onValueChange = { excerpt = it }, label = { Text(stringResource(R.string.admin_content_field_excerpt)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = body, onValueChange = { body = it }, label = { Text(stringResource(R.string.admin_content_field_body)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
Row(Modifier.fillMaxWidth().padding(top = 8.dp), verticalAlignment = Alignment.CenterVertically) {
|
||||
Text(stringResource(R.string.admin_content_publish_now), modifier = Modifier.weight(1f))
|
||||
Switch(checked = published, onCheckedChange = { published = it })
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun NewCategoryDialog(
|
||||
onDismiss: () -> Unit,
|
||||
onCreate: (slug: String, title: String, description: String, sortOrder: Int?) -> Unit,
|
||||
) {
|
||||
var slug by rememberSaveable { mutableStateOf("") }
|
||||
var title by rememberSaveable { mutableStateOf("") }
|
||||
var description by rememberSaveable { mutableStateOf("") }
|
||||
var sort by rememberSaveable { mutableStateOf("") }
|
||||
|
||||
AlertDialog(
|
||||
onDismissRequest = onDismiss,
|
||||
confirmButton = {
|
||||
TextButton(onClick = { onCreate(slug, title, description, sort.toIntOrNull()) }) {
|
||||
Text(stringResource(R.string.admin_content_create))
|
||||
}
|
||||
},
|
||||
dismissButton = { TextButton(onClick = onDismiss) { Text(stringResource(R.string.action_cancel)) } },
|
||||
title = { Text(stringResource(R.string.admin_content_new_category)) },
|
||||
text = {
|
||||
Column {
|
||||
OutlinedTextField(value = slug, onValueChange = { slug = it }, singleLine = true, label = { Text(stringResource(R.string.admin_content_field_slug)) }, modifier = Modifier.fillMaxWidth())
|
||||
OutlinedTextField(value = title, onValueChange = { title = it }, singleLine = true, label = { Text(stringResource(R.string.admin_content_field_title)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = description, onValueChange = { description = it }, label = { Text(stringResource(R.string.admin_content_field_description)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = sort, onValueChange = { sort = it.filter(Char::isDigit) }, singleLine = true, label = { Text(stringResource(R.string.admin_content_field_sort)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
@@ -1,140 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
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.AdminPostDto
|
||||
import com.runicgateway.app.data.api.dto.PostCreateRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiCategoryDto
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryRequest
|
||||
import com.runicgateway.app.data.api.dto.AdminWikiTagDto
|
||||
import com.runicgateway.app.data.repository.AdminRepository
|
||||
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 staff content screen (PLAN.md §1, M10): news posts (list, create,
|
||||
* publish/unpublish, delete) and wiki taxonomy (list categories/tags, create/delete
|
||||
* category). Any staff role reaches these (`staffOnly`); the full CMS block/hero
|
||||
* editor stays out of scope. Reads go through the typed [AdminRepository] (§7).
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AdminContentViewModel @Inject constructor(
|
||||
private val admin: AdminRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
/** The valid URL categories the backend maps (posts.model CATEGORY_MAP keys). */
|
||||
val postCategories = listOf("news", "five-on-friday", "newsletter", "screenshots")
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val posts: UiState<List<AdminPostDto>> = UiState.Loading,
|
||||
val categories: UiState<List<AdminWikiCategoryDto>> = UiState.Loading,
|
||||
val tags: List<AdminWikiTagDto> = emptyList(),
|
||||
val busy: Boolean = false,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
loadPosts()
|
||||
loadWiki()
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
fun loadPosts() {
|
||||
_state.update { it.copy(posts = UiState.Loading) }
|
||||
viewModelScope.launch { _state.update { it.copy(posts = admin.posts().toUiState()) } }
|
||||
}
|
||||
|
||||
fun loadWiki() {
|
||||
_state.update { it.copy(categories = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
_state.update { it.copy(categories = admin.wikiCategories().toUiState()) }
|
||||
when (val tags = admin.wikiTags()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(tags = tags.data) }
|
||||
else -> Unit // tags are secondary; leave the last list on a failure
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun togglePublish(post: AdminPostDto) = mutate(onSuccess = ::loadPosts) {
|
||||
admin.setPostPublished(post.id, !post.isPublished).asFeedback(R.string.admin_content_post_updated)
|
||||
}
|
||||
|
||||
fun deletePost(id: Long) = mutate(onSuccess = ::loadPosts) {
|
||||
admin.deletePost(id).asFeedback(R.string.admin_content_post_deleted)
|
||||
}
|
||||
|
||||
fun createPost(category: String, title: String, excerpt: String, body: String, published: Boolean) {
|
||||
if (title.isBlank()) {
|
||||
_state.update { it.copy(feedback = Feedback(false, R.string.admin_content_title_required)) }
|
||||
return
|
||||
}
|
||||
mutate(onSuccess = ::loadPosts) {
|
||||
admin.createPost(
|
||||
PostCreateRequest(
|
||||
category = category,
|
||||
title = title.trim(),
|
||||
excerpt = excerpt.ifBlank { null },
|
||||
body = body.ifBlank { null },
|
||||
published = published,
|
||||
),
|
||||
).asFeedback(R.string.admin_content_post_created)
|
||||
}
|
||||
}
|
||||
|
||||
fun createCategory(slug: String, title: String, description: String, sortOrder: Int?) {
|
||||
if (slug.isBlank() || title.isBlank()) {
|
||||
_state.update { it.copy(feedback = Feedback(false, R.string.admin_content_cat_fields_required)) }
|
||||
return
|
||||
}
|
||||
mutate(onSuccess = ::loadWiki) {
|
||||
admin.createWikiCategory(
|
||||
WikiCategoryRequest(slug.trim(), title.trim(), description.ifBlank { null }, sortOrder),
|
||||
).asFeedback(R.string.admin_content_cat_created)
|
||||
}
|
||||
}
|
||||
|
||||
fun deleteCategory(id: Long) = mutate(onSuccess = ::loadWiki) {
|
||||
admin.deleteWikiCategory(id).asFeedback(R.string.admin_content_cat_deleted)
|
||||
}
|
||||
|
||||
// ── Shared mutation plumbing ──────────────────────────────────────────
|
||||
|
||||
/** Run a write: set busy + clear feedback, then on completion set the feedback
|
||||
* banner and, only if it succeeded, run [onSuccess] (a targeted reload). */
|
||||
private fun mutate(onSuccess: () -> Unit = {}, block: suspend () -> Feedback) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
val feedback = block()
|
||||
if (feedback.ok) onSuccess()
|
||||
_state.update { it.copy(busy = false, feedback = feedback) }
|
||||
}
|
||||
}
|
||||
|
||||
/** Map an [ApiResult] to a [Feedback], with role/permission-aware failure copy. */
|
||||
private fun ApiResult<*>.asFeedback(@StringRes okRes: Int): Feedback = when (this) {
|
||||
is ApiResult.Ok -> Feedback(true, okRes)
|
||||
is ApiResult.HttpError ->
|
||||
Feedback(false, if (status == 403) R.string.admin_forbidden else R.string.admin_action_failed)
|
||||
is ApiResult.NetworkError -> Feedback(false, R.string.error_network)
|
||||
}
|
||||
}
|
||||
@@ -1,169 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
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.fillMaxWidth
|
||||
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.Button
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
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.AdminDashboardDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
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.SectionLabel
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* The staff dashboard (PLAN.md §1, M10): site mode + a site-mode toggle (admins
|
||||
* only), summary counts, and recent admin activity. Read-only for moderators/editors;
|
||||
* only [isAdmin] callers see the maintenance switch, and the server enforces it too.
|
||||
*/
|
||||
@Composable
|
||||
fun AdminDashboardScreen(
|
||||
isAdmin: Boolean,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AdminDashboardViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
when (val ds = state.dashboard) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Error -> ErrorView(ds.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Success -> DashboardContent(
|
||||
data = ds.data,
|
||||
isAdmin = isAdmin,
|
||||
switching = state.switching,
|
||||
feedbackRes = state.feedback?.messageRes,
|
||||
onSetMode = viewModel::setSiteMode,
|
||||
modifier = modifier,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun DashboardContent(
|
||||
data: AdminDashboardDto,
|
||||
isAdmin: Boolean,
|
||||
switching: Boolean,
|
||||
feedbackRes: Int?,
|
||||
onSetMode: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
val live = data.siteMode.equals("live", ignoreCase = true)
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(20.dp),
|
||||
) {
|
||||
// ── Site status ──────────────────────────────────────────────
|
||||
SectionLabel(stringResource(R.string.admin_dashboard_site))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
Row(verticalAlignment = Alignment.CenterVertically) {
|
||||
StatusPill(
|
||||
text = if (live) stringResource(R.string.admin_site_live) else stringResource(R.string.admin_site_maintenance),
|
||||
tone = if (live) PillTone.Success else PillTone.Warning,
|
||||
)
|
||||
data.lastChange.by?.takeIf { it.isNotBlank() }?.let { by ->
|
||||
Spacer(Modifier.width(12.dp))
|
||||
Text(
|
||||
text = stringResource(R.string.admin_site_changed_by, by),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (isAdmin) {
|
||||
Spacer(Modifier.height(12.dp))
|
||||
Button(
|
||||
onClick = { onSetMode(if (live) "maintenance" else "live") },
|
||||
enabled = !switching,
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
) {
|
||||
if (switching) {
|
||||
CircularProgressIndicator(strokeWidth = 2.dp, modifier = Modifier.height(20.dp))
|
||||
} else {
|
||||
Text(
|
||||
stringResource(
|
||||
if (live) R.string.admin_site_switch_maintenance else R.string.admin_site_switch_live,
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
feedbackRes?.let {
|
||||
Spacer(Modifier.height(8.dp))
|
||||
Text(
|
||||
text = stringResource(it),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
|
||||
// ── Counts ───────────────────────────────────────────────────
|
||||
Spacer(Modifier.height(24.dp))
|
||||
SectionLabel(stringResource(R.string.admin_dashboard_counts))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
StatRow(stringResource(R.string.admin_count_users), data.counts.users.toString())
|
||||
val totalPosts = data.counts.posts.values.sum()
|
||||
StatRow(stringResource(R.string.admin_count_posts), totalPosts.toString())
|
||||
data.counts.posts.forEach { (category, count) ->
|
||||
StatRow("· $category", count.toString())
|
||||
}
|
||||
|
||||
// ── Recent activity ──────────────────────────────────────────
|
||||
if (data.recentActivity.isNotEmpty()) {
|
||||
Spacer(Modifier.height(24.dp))
|
||||
SectionLabel(stringResource(R.string.admin_dashboard_recent_activity))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
data.recentActivity.forEach { row ->
|
||||
Column(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Text(row.action, style = MaterialTheme.typography.bodyMedium)
|
||||
val meta = listOfNotNull(row.username, row.createdAt).joinToString(" · ")
|
||||
if (meta.isNotBlank()) {
|
||||
Text(
|
||||
text = meta,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StatRow(label: String, value: String) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(vertical = 4.dp),
|
||||
horizontalArrangement = Arrangement.SpaceBetween,
|
||||
) {
|
||||
Text(label, style = MaterialTheme.typography.bodyMedium)
|
||||
Text(value, style = MaterialTheme.typography.bodyMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
}
|
||||
@@ -1,91 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
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.AdminDashboardDto
|
||||
import com.runicgateway.app.data.repository.AdminRepository
|
||||
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 staff dashboard (PLAN.md §1, M10): summary counts + the site-mode
|
||||
* toggle. The mode switch is admin-only server-side (`adminOnly`); the screen only
|
||||
* offers it to admins, but a `403` is still handled cleanly if a moderator reaches
|
||||
* it. Everything is read through the typed [AdminRepository] (§7).
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AdminDashboardViewModel @Inject constructor(
|
||||
private val admin: AdminRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val dashboard: UiState<AdminDashboardDto> = UiState.Loading,
|
||||
/** True while a site-mode switch is in flight (disables the control). */
|
||||
val switching: Boolean = false,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(dashboard = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
_state.update { it.copy(dashboard = admin.dashboard().toUiState()) }
|
||||
}
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
/** Switch the site between "live" and "maintenance" (admin only). */
|
||||
fun setSiteMode(mode: String) {
|
||||
if (_state.value.switching) return
|
||||
_state.update { it.copy(switching = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = admin.setSiteMode(mode)) {
|
||||
is ApiResult.Ok -> {
|
||||
// Reflect the new mode locally, then refresh the full summary.
|
||||
val current = _state.value.dashboard
|
||||
if (current is UiState.Success) {
|
||||
_state.update {
|
||||
it.copy(dashboard = UiState.Success(current.data.copy(siteMode = result.data.siteMode)))
|
||||
}
|
||||
}
|
||||
_state.update { it.copy(switching = false, feedback = Feedback(true, R.string.admin_site_mode_updated)) }
|
||||
load()
|
||||
}
|
||||
is ApiResult.HttpError ->
|
||||
_state.update {
|
||||
it.copy(
|
||||
switching = false,
|
||||
feedback = Feedback(
|
||||
false,
|
||||
if (result.status == 403) R.string.admin_forbidden else R.string.admin_action_failed,
|
||||
),
|
||||
)
|
||||
}
|
||||
is ApiResult.NetworkError ->
|
||||
_state.update { it.copy(switching = false, feedback = Feedback(false, R.string.error_network)) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,92 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
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.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.Button
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.saveable.rememberSaveable
|
||||
import androidx.compose.runtime.setValue
|
||||
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.ui.components.SectionLabel
|
||||
|
||||
/**
|
||||
* The moderation screen (PLAN.md §1, M10): kick / ban / unban an account and
|
||||
* broadcast, over `/admin/shard/…` (admin/moderator). A live sidecar is required;
|
||||
* offline, actions return a clean "shard offline" message. Fields are entered here;
|
||||
* the [AdminModerationViewModel] performs the guarded action.
|
||||
*/
|
||||
@Composable
|
||||
fun AdminModerationScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AdminModerationViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
var account by rememberSaveable { mutableStateOf("") }
|
||||
var serial by rememberSaveable { mutableStateOf("") }
|
||||
var reason by rememberSaveable { mutableStateOf("") }
|
||||
var duration by rememberSaveable { mutableStateOf("") }
|
||||
var broadcast by rememberSaveable { mutableStateOf("") }
|
||||
val busy = state.busy
|
||||
|
||||
Column(
|
||||
modifier = modifier.fillMaxSize().verticalScroll(rememberScrollState()).padding(20.dp),
|
||||
) {
|
||||
state.feedback?.let {
|
||||
Text(
|
||||
text = stringResource(it.messageRes),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = if (it.ok) MaterialTheme.colorScheme.onSurfaceVariant else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.fillMaxWidth().padding(bottom = 8.dp),
|
||||
)
|
||||
}
|
||||
|
||||
// ── Account actions ──────────────────────────────────────────────
|
||||
SectionLabel(stringResource(R.string.admin_mod_account_action))
|
||||
OutlinedTextField(value = account, onValueChange = { account = it }, singleLine = true, label = { Text(stringResource(R.string.admin_mod_account)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = serial, onValueChange = { serial = it }, singleLine = true, label = { Text(stringResource(R.string.admin_mod_serial)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = reason, onValueChange = { reason = it }, label = { Text(stringResource(R.string.admin_mod_reason)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
OutlinedTextField(value = duration, onValueChange = { duration = it.filter(Char::isDigit) }, singleLine = true, label = { Text(stringResource(R.string.admin_mod_duration)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
|
||||
Row(Modifier.fillMaxWidth().padding(top = 12.dp), horizontalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
OutlinedButton(onClick = { viewModel.kick(account, serial) }, enabled = !busy, modifier = Modifier.weight(1f)) {
|
||||
Text(stringResource(R.string.admin_mod_kick))
|
||||
}
|
||||
Button(onClick = { viewModel.ban(account, serial, duration.toLongOrNull(), reason) }, enabled = !busy, modifier = Modifier.weight(1f)) {
|
||||
Text(stringResource(R.string.admin_mod_ban))
|
||||
}
|
||||
OutlinedButton(onClick = { viewModel.unban(account) }, enabled = !busy, modifier = Modifier.weight(1f)) {
|
||||
Text(stringResource(R.string.admin_mod_unban))
|
||||
}
|
||||
}
|
||||
|
||||
// ── Broadcast ────────────────────────────────────────────────────
|
||||
Spacer(Modifier.height(24.dp))
|
||||
SectionLabel(stringResource(R.string.admin_mod_broadcast_section))
|
||||
OutlinedTextField(value = broadcast, onValueChange = { broadcast = it }, label = { Text(stringResource(R.string.admin_mod_broadcast_text)) }, modifier = Modifier.fillMaxWidth().padding(top = 8.dp))
|
||||
Button(onClick = { viewModel.broadcast(broadcast, null) }, enabled = !busy, modifier = Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
Text(stringResource(R.string.admin_mod_broadcast))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,89 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
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.repository.AdminRepository
|
||||
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 moderation actions (PLAN.md §1, M10): kick / ban / unban an account
|
||||
* and broadcast a system message, over the shard write plane (`/admin/shard/…`,
|
||||
* admin/moderator). These need a live sidecar — when the shard is offline the call
|
||||
* fails and the screen shows a clean error, never a crash (§7). The form fields live
|
||||
* in the screen; this VM owns only the busy + feedback state and the actions.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AdminModerationViewModel @Inject constructor(
|
||||
private val admin: AdminRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(val busy: Boolean = false, val feedback: Feedback? = null)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
fun kick(account: String, serial: String) {
|
||||
if (account.isBlank() && serial.isBlank()) return badTarget()
|
||||
run(R.string.admin_mod_kicked) { admin.kick(account.ifBlank { null }, serial.ifBlank { null }) }
|
||||
}
|
||||
|
||||
fun ban(account: String, serial: String, durationSec: Long?, reason: String) {
|
||||
if (account.isBlank() && serial.isBlank()) return badTarget()
|
||||
run(R.string.admin_mod_banned) {
|
||||
admin.ban(account.ifBlank { null }, serial.ifBlank { null }, durationSec, reason.ifBlank { null })
|
||||
}
|
||||
}
|
||||
|
||||
fun unban(account: String) {
|
||||
if (account.isBlank()) return badTarget()
|
||||
run(R.string.admin_mod_unbanned) { admin.unban(account.trim()) }
|
||||
}
|
||||
|
||||
fun broadcast(text: String, hue: Int?) {
|
||||
if (text.isBlank()) {
|
||||
_state.update { it.copy(feedback = Feedback(false, R.string.admin_mod_text_required)) }
|
||||
return
|
||||
}
|
||||
run(R.string.admin_mod_broadcasted) { admin.broadcast(text.trim(), hue) }
|
||||
}
|
||||
|
||||
private fun badTarget() {
|
||||
_state.update { it.copy(feedback = Feedback(false, R.string.admin_mod_target_required)) }
|
||||
}
|
||||
|
||||
private fun run(@StringRes okRes: Int, block: suspend () -> ApiResult<Unit>) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
val feedback = when (val r = block()) {
|
||||
is ApiResult.Ok -> Feedback(true, okRes)
|
||||
is ApiResult.HttpError -> Feedback(
|
||||
false,
|
||||
when (r.status) {
|
||||
403 -> R.string.admin_forbidden
|
||||
503 -> R.string.admin_mod_shard_offline
|
||||
else -> R.string.admin_action_failed
|
||||
},
|
||||
)
|
||||
is ApiResult.NetworkError -> Feedback(false, R.string.error_network)
|
||||
}
|
||||
_state.update { it.copy(busy = false, feedback = feedback) }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,147 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
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.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.AlertDialog
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.Checkbox
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
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.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.SupportPageDto
|
||||
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
|
||||
|
||||
/**
|
||||
* The support (help-page) queue (PLAN.md §1, M10): open tickets with reply/close,
|
||||
* over `/admin/shard/pages…` (admin/moderator). Empty when there are no open pages
|
||||
* (or the shard is offline); every read/write degrades cleanly (§7).
|
||||
*/
|
||||
@Composable
|
||||
fun AdminSupportScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AdminSupportViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
var replyTo by remember { mutableStateOf<SupportPageDto?>(null) }
|
||||
|
||||
Column(modifier.fillMaxSize()) {
|
||||
state.feedback?.let {
|
||||
Text(
|
||||
text = stringResource(it.messageRes),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = if (it.ok) MaterialTheme.colorScheme.onSurfaceVariant else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.fillMaxWidth().padding(horizontal = 16.dp, vertical = 6.dp),
|
||||
)
|
||||
}
|
||||
when (val s = state.pages) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load)
|
||||
is UiState.Success ->
|
||||
if (s.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.admin_support_empty))
|
||||
} else {
|
||||
LazyColumn(Modifier.fillMaxSize().padding(16.dp)) {
|
||||
items(s.data, key = { it.pageId }) { page ->
|
||||
SupportPageCard(
|
||||
page = page,
|
||||
busy = state.busy,
|
||||
onReply = { replyTo = page },
|
||||
onClose = { viewModel.close(page.pageId) },
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
replyTo?.let { page ->
|
||||
RespondDialog(
|
||||
page = page,
|
||||
onDismiss = { replyTo = null },
|
||||
onSend = { message, close ->
|
||||
viewModel.respond(page.pageId, message, close)
|
||||
replyTo = null
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun SupportPageCard(
|
||||
page: SupportPageDto,
|
||||
busy: Boolean,
|
||||
onReply: () -> Unit,
|
||||
onClose: () -> Unit,
|
||||
) {
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
val who = page.sender?.name ?: page.sender?.account ?: page.pageId
|
||||
Text(
|
||||
text = listOfNotNull(page.type, who).joinToString(" · "),
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
)
|
||||
page.message?.takeIf { it.isNotBlank() }?.let {
|
||||
Spacer(Modifier.height(4.dp))
|
||||
Text(it, style = MaterialTheme.typography.bodyMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
Row(Modifier.fillMaxWidth().padding(top = 8.dp), horizontalArrangement = Arrangement.End) {
|
||||
TextButton(onClick = onReply, enabled = !busy) { Text(stringResource(R.string.admin_support_reply)) }
|
||||
TextButton(onClick = onClose, enabled = !busy) { Text(stringResource(R.string.admin_support_close)) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun RespondDialog(
|
||||
page: SupportPageDto,
|
||||
onDismiss: () -> Unit,
|
||||
onSend: (message: String, close: Boolean) -> Unit,
|
||||
) {
|
||||
var message by rememberSaveable { mutableStateOf("") }
|
||||
var alsoClose by rememberSaveable { mutableStateOf(true) }
|
||||
|
||||
AlertDialog(
|
||||
onDismissRequest = onDismiss,
|
||||
confirmButton = { TextButton(onClick = { onSend(message, alsoClose) }) { Text(stringResource(R.string.admin_support_send)) } },
|
||||
dismissButton = { TextButton(onClick = onDismiss) { Text(stringResource(R.string.action_cancel)) } },
|
||||
title = { Text(stringResource(R.string.admin_support_reply)) },
|
||||
text = {
|
||||
Column {
|
||||
OutlinedTextField(value = message, onValueChange = { message = it }, label = { Text(stringResource(R.string.admin_support_message)) }, modifier = Modifier.fillMaxWidth())
|
||||
Row(Modifier.fillMaxWidth().padding(top = 8.dp), verticalAlignment = Alignment.CenterVertically) {
|
||||
Checkbox(checked = alsoClose, onCheckedChange = { alsoClose = it })
|
||||
Text(stringResource(R.string.admin_support_close_after))
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
@@ -1,87 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.admin
|
||||
|
||||
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.SupportPageDto
|
||||
import com.runicgateway.app.data.repository.AdminRepository
|
||||
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 support (help-page) queue (PLAN.md §1, M10): list open pages, reply
|
||||
* (optionally closing), and close, over `/admin/shard/pages…` (admin/moderator).
|
||||
* The list is served from shard state — empty when no tickets (or the shard is
|
||||
* offline); writes need a live sidecar and fail cleanly otherwise (§7).
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AdminSupportViewModel @Inject constructor(
|
||||
private val admin: AdminRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val pages: UiState<List<SupportPageDto>> = UiState.Loading,
|
||||
val busy: Boolean = false,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(pages = UiState.Loading) }
|
||||
viewModelScope.launch { _state.update { it.copy(pages = admin.supportPages().toUiState()) } }
|
||||
}
|
||||
|
||||
fun respond(id: String, message: String, close: Boolean) {
|
||||
if (message.isBlank()) {
|
||||
_state.update { it.copy(feedback = Feedback(false, R.string.admin_support_message_required)) }
|
||||
return
|
||||
}
|
||||
mutate(R.string.admin_support_responded) { admin.respondPage(id, message.trim(), close) }
|
||||
}
|
||||
|
||||
fun close(id: String) = mutate(R.string.admin_support_closed) { admin.closePage(id) }
|
||||
|
||||
private fun mutate(@StringRes okRes: Int, block: suspend () -> ApiResult<Unit>) {
|
||||
if (_state.value.busy) return
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
val feedback = when (val r = block()) {
|
||||
is ApiResult.Ok -> Feedback(true, okRes)
|
||||
is ApiResult.HttpError -> Feedback(
|
||||
false,
|
||||
when (r.status) {
|
||||
403 -> R.string.admin_forbidden
|
||||
404 -> R.string.admin_support_unknown_page
|
||||
503 -> R.string.admin_mod_shard_offline
|
||||
else -> R.string.admin_action_failed
|
||||
},
|
||||
)
|
||||
is ApiResult.NetworkError -> Feedback(false, R.string.error_network)
|
||||
}
|
||||
if (feedback.ok) load()
|
||||
_state.update { it.copy(busy = false, feedback = feedback) }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -5,10 +5,8 @@ package com.runicgateway.app.ui.auth
|
||||
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
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
|
||||
@@ -17,20 +15,13 @@ 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.ExperimentalMaterial3Api
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ModalBottomSheet
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextButton
|
||||
import androidx.compose.material3.rememberModalBottomSheetState
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
@@ -65,13 +56,6 @@ fun LoginScreen(
|
||||
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()
|
||||
@@ -171,48 +155,6 @@ fun LoginScreen(
|
||||
}
|
||||
}
|
||||
|
||||
// ── Native SSO (§4.2, M9): a single "Sign in with SSO" button that opens the
|
||||
// Custom-Tab bridge. With one provider it launches straight through; with
|
||||
// several it presents a native picker (below). No website-login fallback —
|
||||
// that page can't deep-link the session back; a failed discovery offers a retry.
|
||||
var showSsoPicker by remember { mutableStateOf(false) }
|
||||
when {
|
||||
state.ssoProviders.isNotEmpty() -> {
|
||||
OutlinedButton(
|
||||
onClick = {
|
||||
val providers = state.ssoProviders
|
||||
if (providers.size == 1) viewModel.onSsoProviderClick(providers.first())
|
||||
else showSsoPicker = true
|
||||
},
|
||||
enabled = !state.submitting,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(top = 12.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.login_sso_button))
|
||||
}
|
||||
}
|
||||
|
||||
state.ssoDiscovering -> {
|
||||
Text(
|
||||
text = stringResource(R.string.login_sso_loading),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
state.ssoUnavailable -> {
|
||||
TextButton(
|
||||
onClick = { viewModel.discoverSsoProviders() },
|
||||
modifier = Modifier.padding(top = 4.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.login_sso_retry))
|
||||
}
|
||||
}
|
||||
// else: discovery succeeded with no providers — this shard offers no SSO.
|
||||
}
|
||||
|
||||
// ── Website hand-offs (§4.2): open the site's own pages in a Custom Tab ──
|
||||
viewModel.registerUrl?.let { url ->
|
||||
TextButton(
|
||||
@@ -225,53 +167,11 @@ fun LoginScreen(
|
||||
Text(stringResource(R.string.login_forgot))
|
||||
}
|
||||
}
|
||||
|
||||
if (showSsoPicker) {
|
||||
SsoProviderPicker(
|
||||
providers = state.ssoProviders,
|
||||
onDismiss = { showSsoPicker = false },
|
||||
onPick = { provider ->
|
||||
showSsoPicker = false
|
||||
viewModel.onSsoProviderClick(provider)
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The native provider picker (§4.2): a bottom sheet listing the shard's enabled SSO
|
||||
* providers so a single "Sign in with SSO" button can serve several IdPs without a
|
||||
* website chooser page. Each row opens the Custom-Tab bridge for that provider.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
private fun SsoProviderPicker(
|
||||
providers: List<com.runicgateway.app.data.api.dto.SsoProviderDto>,
|
||||
onDismiss: () -> Unit,
|
||||
onPick: (com.runicgateway.app.data.api.dto.SsoProviderDto) -> Unit,
|
||||
) {
|
||||
ModalBottomSheet(onDismissRequest = onDismiss, sheetState = rememberModalBottomSheetState()) {
|
||||
Text(
|
||||
text = stringResource(R.string.login_sso_pick_title),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
modifier = Modifier.padding(horizontal = 24.dp, vertical = 8.dp),
|
||||
)
|
||||
providers.forEach { provider ->
|
||||
TextButton(
|
||||
onClick = { onPick(provider) },
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(horizontal = 12.dp, vertical = 2.dp),
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(R.string.login_sso_provider, provider.name),
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
textAlign = TextAlign.Start,
|
||||
)
|
||||
viewModel.ssoLoginUrl?.let { url ->
|
||||
TextButton(onClick = { WebHandoff.open(context, url) }) {
|
||||
Text(stringResource(R.string.login_sso))
|
||||
}
|
||||
}
|
||||
Spacer(Modifier.height(24.dp)) // clears the gesture inset at the sheet's bottom
|
||||
}
|
||||
}
|
||||
|
||||
@@ -281,5 +181,4 @@ private fun loginErrorRes(error: LoginError): Int = when (error) {
|
||||
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
|
||||
}
|
||||
|
||||
@@ -5,12 +5,9 @@ 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 com.runicgateway.app.data.repository.AuthRepository.SsoDiscovery
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
@@ -28,12 +25,11 @@ import javax.inject.Inject
|
||||
@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 }
|
||||
enum class LoginError { INVALID_CREDENTIALS, BAD_CODE, RATE_LIMITED, SERVER, NETWORK }
|
||||
|
||||
data class UiState(
|
||||
val username: String = "",
|
||||
@@ -44,40 +40,11 @@ class LoginViewModel @Inject constructor(
|
||||
val submitting: Boolean = false,
|
||||
val error: LoginError? = null,
|
||||
val signedIn: Boolean = false,
|
||||
/** The shard's enabled SSO providers (§4.2); empty until discovery resolves. */
|
||||
val ssoProviders: List<SsoProviderDto> = emptyList(),
|
||||
/** True while discovery is in flight — the screen shows a spinner, not an empty gap. */
|
||||
val ssoDiscovering: Boolean = true,
|
||||
/** True when discovery failed (offline/server) — offer a retry rather than a dead end. */
|
||||
val ssoUnavailable: Boolean = false,
|
||||
/** 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 {
|
||||
discoverSsoProviders()
|
||||
// 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) =
|
||||
@@ -85,54 +52,7 @@ class LoginViewModel @Inject constructor(
|
||||
|
||||
val registerUrl: String? get() = websiteUrls.register()
|
||||
val forgotPasswordUrl: String? get() = websiteUrls.forgotPassword()
|
||||
|
||||
/**
|
||||
* Discover the shard's native SSO providers (§4.2). A failure surfaces a retry
|
||||
* affordance instead of the old dead website-login hand-off, which was never
|
||||
* mobile-formatted and could not deep-link the session back.
|
||||
*/
|
||||
fun discoverSsoProviders() {
|
||||
_state.update { it.copy(ssoDiscovering = true, ssoUnavailable = false) }
|
||||
viewModelScope.launch {
|
||||
when (val result = authRepository.ssoProviders()) {
|
||||
is SsoDiscovery.Available ->
|
||||
_state.update {
|
||||
it.copy(ssoProviders = result.providers, ssoDiscovering = false, ssoUnavailable = false)
|
||||
}
|
||||
SsoDiscovery.None ->
|
||||
_state.update {
|
||||
it.copy(ssoProviders = emptyList(), ssoDiscovering = false, ssoUnavailable = false)
|
||||
}
|
||||
SsoDiscovery.Unavailable ->
|
||||
_state.update {
|
||||
it.copy(ssoProviders = emptyList(), ssoDiscovering = false, ssoUnavailable = true)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
val ssoLoginUrl: String? get() = websiteUrls.login()
|
||||
|
||||
fun submit() {
|
||||
val s = _state.value
|
||||
|
||||
@@ -23,12 +23,6 @@ enum class MenuAccess {
|
||||
|
||||
/** Visible only to a player — the linked game-data groups (§6.3). */
|
||||
PLAYER,
|
||||
|
||||
/** Visible to any staff role (admin/editor/moderator) — the M10 staff surface (§1). */
|
||||
STAFF,
|
||||
|
||||
/** Visible to admin/moderator — moderation actions + the support queue (§1, M10). */
|
||||
MODERATOR,
|
||||
}
|
||||
|
||||
data class MenuEntry(
|
||||
@@ -50,15 +44,9 @@ val APP_MENU: List<MenuEntry> = listOf(
|
||||
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),
|
||||
// Staff operations (§1, M10) — revealed for staff roles; the backend re-checks every call.
|
||||
MenuEntry(Routes.ADMIN_DASHBOARD, R.string.menu_admin_dashboard, MenuAccess.STAFF),
|
||||
MenuEntry(Routes.ADMIN_CONTENT, R.string.menu_admin_content, MenuAccess.STAFF),
|
||||
MenuEntry(Routes.ADMIN_MODERATION, R.string.menu_admin_moderation, MenuAccess.MODERATOR),
|
||||
MenuEntry(Routes.ADMIN_SUPPORT, R.string.menu_admin_support, MenuAccess.MODERATOR),
|
||||
)
|
||||
|
||||
/**
|
||||
@@ -71,7 +59,5 @@ fun visibleEntries(entries: List<MenuEntry>, session: Session): List<MenuEntry>
|
||||
MenuAccess.PUBLIC -> true
|
||||
MenuAccess.SIGNED_IN -> session is Session.SignedIn
|
||||
MenuAccess.PLAYER -> session is Session.SignedIn && session.user.isPlayer
|
||||
MenuAccess.STAFF -> session is Session.SignedIn && session.user.isStaff
|
||||
MenuAccess.MODERATOR -> session is Session.SignedIn && session.user.isModerator
|
||||
}
|
||||
}
|
||||
|
||||
@@ -18,9 +18,6 @@ object Routes {
|
||||
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"
|
||||
|
||||
@@ -38,13 +35,6 @@ object Routes {
|
||||
/** A single character sheet by in-game (hex) serial. */
|
||||
const val PLAYER_CHAR = "player/char/{serial}"
|
||||
|
||||
/** Staff operations (§1, §6.4, M10). Gated to staff roles by the menu access level;
|
||||
* the backend re-checks role on every `/admin/…` call. */
|
||||
const val ADMIN_DASHBOARD = "admin/dashboard"
|
||||
const val ADMIN_MODERATION = "admin/moderation"
|
||||
const val ADMIN_SUPPORT = "admin/support"
|
||||
const val ADMIN_CONTENT = "admin/content"
|
||||
|
||||
/** CMS page by slug (e.g. the conventional "about" page, mirrored from the site nav). */
|
||||
const val PAGE = "page/{slug}"
|
||||
|
||||
@@ -67,23 +57,4 @@ object Routes {
|
||||
|
||||
/** 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
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,182 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import android.Manifest
|
||||
import android.os.Build
|
||||
import androidx.activity.compose.rememberLauncherForActivityResult
|
||||
import androidx.activity.result.contract.ActivityResultContracts
|
||||
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.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.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Switch
|
||||
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.platform.LocalContext
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.font.FontStyle
|
||||
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.NotificationStreamDto
|
||||
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
|
||||
import com.runicgateway.app.ui.components.SectionLabel
|
||||
|
||||
/**
|
||||
* The Notifications settings screen (PLAN.md §11, M7 Part 2 work item 6): the
|
||||
* subscribable catalog with per-stream toggles. Personal streams are greyed until a
|
||||
* game account is linked; turning a stream on requests the POST_NOTIFICATIONS
|
||||
* permission (API 33+) and registers the device, turning them all off unregisters it.
|
||||
*/
|
||||
@Composable
|
||||
fun NotificationsScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: NotificationsViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
val context = LocalContext.current
|
||||
|
||||
// Ask once for POST_NOTIFICATIONS when the user first enables a stream (API 33+).
|
||||
val permissionLauncher = rememberLauncherForActivityResult(
|
||||
ActivityResultContracts.RequestPermission(),
|
||||
) { /* granted or not, the subscription is already saved server-side */ }
|
||||
|
||||
fun ensureNotificationPermission() {
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
||||
permissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
|
||||
}
|
||||
}
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(16.dp),
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(R.string.notifications_title),
|
||||
style = MaterialTheme.typography.titleLarge,
|
||||
)
|
||||
Spacer(Modifier.height(4.dp))
|
||||
Text(
|
||||
text = stringResource(R.string.notifications_subtitle),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Spacer(Modifier.height(16.dp))
|
||||
|
||||
if (!state.supported) {
|
||||
EmptyView(message = stringResource(R.string.notifications_unsupported))
|
||||
return@Column
|
||||
}
|
||||
|
||||
state.feedback?.let { fb ->
|
||||
Text(
|
||||
text = stringResource(fb.messageRes),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = if (fb.ok) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.padding(bottom = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
when (val catalog = state.catalog) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(kind = catalog.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> StreamList(
|
||||
streams = catalog.data,
|
||||
subscribed = state.subscribed,
|
||||
hasLinkedAccount = state.hasLinkedAccount,
|
||||
busy = state.busy,
|
||||
onToggle = { stream, on ->
|
||||
if (on) ensureNotificationPermission()
|
||||
viewModel.setSubscribed(stream, on)
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StreamList(
|
||||
streams: List<NotificationStreamDto>,
|
||||
subscribed: Set<String>,
|
||||
hasLinkedAccount: Boolean,
|
||||
busy: Boolean,
|
||||
onToggle: (NotificationStreamDto, Boolean) -> Unit,
|
||||
) {
|
||||
if (streams.isEmpty()) {
|
||||
EmptyView(message = stringResource(R.string.notifications_empty))
|
||||
return
|
||||
}
|
||||
val (personal, general) = streams.partition { it.personal }
|
||||
|
||||
if (general.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_general))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
general.forEach { stream ->
|
||||
StreamRow(stream, subscribed.contains(stream.id), enabled = !busy, hint = null) { on ->
|
||||
onToggle(stream, on)
|
||||
}
|
||||
HorizontalDivider()
|
||||
}
|
||||
Spacer(Modifier.height(20.dp))
|
||||
}
|
||||
|
||||
if (personal.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_personal))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
personal.forEach { stream ->
|
||||
val selectable = streamSelectable(stream, hasLinkedAccount)
|
||||
val hint = if (!selectable) stringResource(R.string.notifications_requires_link) else null
|
||||
StreamRow(stream, subscribed.contains(stream.id) && selectable, enabled = !busy && selectable, hint = hint) { on ->
|
||||
onToggle(stream, on)
|
||||
}
|
||||
HorizontalDivider()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StreamRow(
|
||||
stream: NotificationStreamDto,
|
||||
checked: Boolean,
|
||||
enabled: Boolean,
|
||||
hint: String?,
|
||||
onToggle: (Boolean) -> Unit,
|
||||
) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(vertical = 12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Column(modifier = Modifier.weight(1f).padding(end = 12.dp)) {
|
||||
Text(
|
||||
text = stream.label,
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
color = if (enabled) MaterialTheme.colorScheme.onSurface else MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
text = hint ?: stream.description,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
fontStyle = if (hint != null) FontStyle.Italic else FontStyle.Normal,
|
||||
)
|
||||
}
|
||||
Switch(checked = checked, onCheckedChange = onToggle, enabled = enabled)
|
||||
}
|
||||
}
|
||||
@@ -1,135 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamDto
|
||||
import com.runicgateway.app.data.repository.NotificationsRepository
|
||||
import com.runicgateway.app.data.repository.PlayerShardRepository
|
||||
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 Notifications settings screen (PLAN.md §11, M7 Part 2 work item 6):
|
||||
* the stream catalog with per-stream toggles bound to
|
||||
* `GET/PUT /auth/me/notifications/subscriptions`. A **personal** stream is greyed
|
||||
* until the user has a linked game account (§11), and turning the opt-in set
|
||||
* non-empty/empty drives the [PushManager] to register/unregister the device.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class NotificationsViewModel @Inject constructor(
|
||||
private val notifications: NotificationsRepository,
|
||||
private val playerShard: PlayerShardRepository,
|
||||
private val pushManager: PushManager,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val catalog: UiState<List<NotificationStreamDto>> = UiState.Loading,
|
||||
val subscribed: Set<String> = emptySet(),
|
||||
/** Whether the user has ≥1 linked game account — personal streams need it. */
|
||||
val hasLinkedAccount: Boolean = false,
|
||||
/** Whether this shard advertises a push relay at all (else the screen says so). */
|
||||
val supported: Boolean = true,
|
||||
val busy: Boolean = false,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
pushManager.supported.collect { supported -> _state.update { it.copy(supported = supported) } }
|
||||
}
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(catalog = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
val catalog = notifications.streams().let { result ->
|
||||
when (result) {
|
||||
is ApiResult.Ok -> ApiResult.Ok(result.data.streams)
|
||||
is ApiResult.HttpError -> result
|
||||
is ApiResult.NetworkError -> result
|
||||
}
|
||||
}
|
||||
_state.update { it.copy(catalog = catalog.toUiState()) }
|
||||
|
||||
when (val subs = notifications.subscriptions()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(subscribed = subs.data.streams.toSet()) }
|
||||
else -> Unit
|
||||
}
|
||||
// A linked game account gates the personal streams; failure → treat as none.
|
||||
val linked = (playerShard.accounts() as? ApiResult.Ok)?.data?.isNotEmpty() == true
|
||||
_state.update { it.copy(hasLinkedAccount = linked) }
|
||||
}
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
/** Toggle [stream]; refuses a personal stream with no linked account. */
|
||||
fun setSubscribed(stream: NotificationStreamDto, on: Boolean) {
|
||||
val s = _state.value
|
||||
if (s.busy) return
|
||||
if (on && !streamSelectable(stream, s.hasLinkedAccount)) return
|
||||
val next = if (on) s.subscribed + stream.id else s.subscribed - stream.id
|
||||
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = notifications.setSubscriptions(next.toList())) {
|
||||
is ApiResult.Ok -> {
|
||||
val stored = result.data.streams.toSet()
|
||||
_state.update { it.copy(subscribed = stored) }
|
||||
reconcilePush(stored)
|
||||
}
|
||||
is ApiResult.NetworkError -> finish(false, R.string.error_network)
|
||||
is ApiResult.HttpError -> finish(false, R.string.notifications_save_error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register or unregister the device to match the opted-in set (PLAN.md §11:
|
||||
* register when signed-in + subscribed, unregister when the set empties).
|
||||
*/
|
||||
private suspend fun reconcilePush(subscribed: Set<String>) {
|
||||
if (subscribed.isEmpty()) {
|
||||
pushManager.disable()
|
||||
finish(true, R.string.notifications_all_off)
|
||||
return
|
||||
}
|
||||
when (val res = pushManager.enable()) {
|
||||
is PushManager.PushResult.Enabled -> finish(true, R.string.notifications_saved)
|
||||
is PushManager.PushResult.Unsupported -> finish(false, R.string.notifications_unsupported)
|
||||
is PushManager.PushResult.NotSignedIn -> finish(false, R.string.notifications_save_error)
|
||||
is PushManager.PushResult.Failed ->
|
||||
finish(false, if (res.status == 400) R.string.notifications_relay_error else R.string.notifications_save_error)
|
||||
}
|
||||
}
|
||||
|
||||
private fun finish(ok: Boolean, @StringRes messageRes: Int) =
|
||||
_state.update { it.copy(busy = false, feedback = Feedback(ok, messageRes)) }
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a stream's toggle is selectable for a user: a personal stream needs a
|
||||
* linked game account (PLAN.md §11). Pure so the gating is unit-tested without Compose.
|
||||
*/
|
||||
fun streamSelectable(stream: NotificationStreamDto, hasLinkedAccount: Boolean): Boolean =
|
||||
!stream.requiresLinkedAccount || hasLinkedAccount
|
||||
@@ -69,9 +69,7 @@ class ChampsViewModel @Inject constructor(
|
||||
private fun applyFrame(frame: ShardStreamEvent.Frame) {
|
||||
when (frame.kind) {
|
||||
"champ.update" -> repository.champFrame(frame.data)?.let { board.upsert(it) }
|
||||
// Serial is an opaque hex-string key ("0x…"), not a number — read as a
|
||||
// string (reading it as a Long silently dropped every champ.remove).
|
||||
"champ.remove" -> FrameFields.stringField(frame.data, "serial")?.let { board.remove(it) }
|
||||
"champ.remove" -> FrameFields.longField(frame.data, "serial")?.let { board.remove(it.toString()) }
|
||||
else -> return
|
||||
}
|
||||
// Only republish when the board actually changed (Success state only).
|
||||
|
||||
@@ -69,9 +69,7 @@ class HousesViewModel @Inject constructor(
|
||||
|
||||
private fun applyFrame(frame: ShardStreamEvent.Frame) {
|
||||
if (frame.kind != "house.decay") return
|
||||
// Serials are opaque hex-string keys ("0x…"), not numbers — read as a string
|
||||
// (reading it as a Long silently dropped every live IDOC update).
|
||||
val serial = FrameFields.stringField(frame.data, "serial") ?: return
|
||||
val serial = FrameFields.longField(frame.data, "serial") ?: return
|
||||
// `to` is the new decay stage; only IDOC belongs on the public board.
|
||||
val stage = FrameFields.stringField(frame.data, "to")
|
||||
?: FrameFields.stringField(frame.data, "stage")
|
||||
|
||||
@@ -46,92 +46,10 @@
|
||||
<string name="menu_my_characters">My characters</string>
|
||||
<string name="menu_my_vendors">My vendors</string>
|
||||
<string name="menu_my_houses">My houses</string>
|
||||
<string name="menu_admin_dashboard">Dashboard</string>
|
||||
<string name="menu_admin_content">Content</string>
|
||||
<string name="menu_admin_moderation">Moderation</string>
|
||||
<string name="menu_admin_support">Support queue</string>
|
||||
<string name="menu_sign_in">Sign in</string>
|
||||
<string name="menu_sign_out">Sign out</string>
|
||||
<string name="menu_change_server">Change server</string>
|
||||
|
||||
<!-- ── Staff operations (§1, M10) ──────────────────────────────────── -->
|
||||
<string name="admin_dashboard_site">Site</string>
|
||||
<string name="admin_dashboard_counts">Counts</string>
|
||||
<string name="admin_dashboard_recent_activity">Recent activity</string>
|
||||
<string name="admin_site_live">Live</string>
|
||||
<string name="admin_site_maintenance">Maintenance</string>
|
||||
<string name="admin_site_switch_maintenance">Switch to maintenance</string>
|
||||
<string name="admin_site_switch_live">Switch to live</string>
|
||||
<string name="admin_site_changed_by">by %1$s</string>
|
||||
<string name="admin_site_mode_updated">Site mode updated.</string>
|
||||
<string name="admin_count_users">Users</string>
|
||||
<string name="admin_count_posts">Posts</string>
|
||||
<string name="admin_forbidden">You don\'t have permission for that action.</string>
|
||||
<string name="admin_action_failed">That action couldn\'t be completed. Please try again.</string>
|
||||
<string name="action_cancel">Cancel</string>
|
||||
|
||||
<!-- Staff content (posts + wiki) -->
|
||||
<string name="admin_content_tab_posts">Posts</string>
|
||||
<string name="admin_content_tab_wiki">Wiki</string>
|
||||
<string name="admin_content_new_post">New post</string>
|
||||
<string name="admin_content_new_category">New category</string>
|
||||
<string name="admin_content_create">Create</string>
|
||||
<string name="admin_content_published">Published</string>
|
||||
<string name="admin_content_draft">Draft</string>
|
||||
<string name="admin_content_publish">Publish</string>
|
||||
<string name="admin_content_unpublish">Unpublish</string>
|
||||
<string name="admin_content_delete">Delete</string>
|
||||
<string name="admin_content_publish_now">Publish now</string>
|
||||
<string name="admin_content_field_title">Title</string>
|
||||
<string name="admin_content_field_excerpt">Excerpt</string>
|
||||
<string name="admin_content_field_body">Body</string>
|
||||
<string name="admin_content_field_slug">Slug</string>
|
||||
<string name="admin_content_field_description">Description</string>
|
||||
<string name="admin_content_field_sort">Sort order</string>
|
||||
<!-- %1$s slug, %2$d page count -->
|
||||
<string name="admin_content_cat_meta">%1$s · %2$d pages</string>
|
||||
<!-- %1$s comma-separated tag labels -->
|
||||
<string name="admin_content_tags">Tags: %1$s</string>
|
||||
<string name="admin_content_post_created">Post created.</string>
|
||||
<string name="admin_content_post_updated">Post updated.</string>
|
||||
<string name="admin_content_post_deleted">Post deleted.</string>
|
||||
<string name="admin_content_cat_created">Category created.</string>
|
||||
<string name="admin_content_cat_deleted">Category deleted.</string>
|
||||
<string name="admin_content_title_required">A title is required.</string>
|
||||
<string name="admin_content_cat_fields_required">Slug and title are required.</string>
|
||||
|
||||
<!-- Staff moderation (shard write plane) -->
|
||||
<string name="admin_mod_account_action">Account action</string>
|
||||
<string name="admin_mod_account">Account</string>
|
||||
<string name="admin_mod_serial">Serial (0x…)</string>
|
||||
<string name="admin_mod_reason">Reason (ban)</string>
|
||||
<string name="admin_mod_duration">Ban duration (seconds; blank = indefinite)</string>
|
||||
<string name="admin_mod_kick">Kick</string>
|
||||
<string name="admin_mod_ban">Ban</string>
|
||||
<string name="admin_mod_unban">Unban</string>
|
||||
<string name="admin_mod_broadcast_section">Broadcast</string>
|
||||
<string name="admin_mod_broadcast_text">Message to everyone online</string>
|
||||
<string name="admin_mod_broadcast">Broadcast</string>
|
||||
<string name="admin_mod_kicked">Account kicked.</string>
|
||||
<string name="admin_mod_banned">Account banned.</string>
|
||||
<string name="admin_mod_unbanned">Ban cleared.</string>
|
||||
<string name="admin_mod_broadcasted">Message broadcast.</string>
|
||||
<string name="admin_mod_target_required">Enter an account or serial.</string>
|
||||
<string name="admin_mod_text_required">Enter a message to broadcast.</string>
|
||||
<string name="admin_mod_shard_offline">The shard is offline — the action couldn\'t be delivered.</string>
|
||||
|
||||
<!-- Staff support queue -->
|
||||
<string name="admin_support_empty">No open help pages.</string>
|
||||
<string name="admin_support_reply">Reply</string>
|
||||
<string name="admin_support_close">Close</string>
|
||||
<string name="admin_support_send">Send</string>
|
||||
<string name="admin_support_message">Reply message</string>
|
||||
<string name="admin_support_close_after">Close the page after replying</string>
|
||||
<string name="admin_support_responded">Reply sent.</string>
|
||||
<string name="admin_support_closed">Page closed.</string>
|
||||
<string name="admin_support_message_required">Enter a reply message.</string>
|
||||
<string name="admin_support_unknown_page">That page is no longer in the queue.</string>
|
||||
|
||||
<!-- ── Auth: login (§4.1) ──────────────────────────────────────────── -->
|
||||
<string name="login_title">Sign in</string>
|
||||
<string name="login_subtitle">Sign in with your shard account.</string>
|
||||
@@ -142,19 +60,12 @@
|
||||
<string name="login_button">Sign in</string>
|
||||
<string name="login_register">Create an account</string>
|
||||
<string name="login_forgot">Forgot your password?</string>
|
||||
<!-- Single SSO entry point; the picker lists the shard's providers (native SSO, M9/M10). -->
|
||||
<string name="login_sso_button">Sign in with SSO</string>
|
||||
<string name="login_sso_pick_title">Choose a sign-in provider</string>
|
||||
<!-- %1$s is the provider name, e.g. "Google" or "Discord". -->
|
||||
<string name="login_sso_provider">Sign in with %1$s</string>
|
||||
<string name="login_sso_loading">Loading sign-in options…</string>
|
||||
<string name="login_sso_retry">Couldn\'t load sign-in options. Tap to retry.</string>
|
||||
<string name="login_sso">Sign in with Google or Discord (on the website)</string>
|
||||
<string name="login_error_credentials">Incorrect username or password.</string>
|
||||
<string name="login_error_code">That code didn\'t match. Try the current code.</string>
|
||||
<string name="login_error_rate_limited">Too many attempts. Please try again shortly.</string>
|
||||
<string name="login_error_server">Something went wrong. Please try again.</string>
|
||||
<string name="login_error_network">Can\'t reach the site. Check your connection and try again.</string>
|
||||
<string name="login_error_sso">Couldn\'t complete that sign-in. Please try again.</string>
|
||||
|
||||
<!-- ── Auth: account (§5, §6.3) ────────────────────────────────────── -->
|
||||
<string name="account_title">My account</string>
|
||||
@@ -346,37 +257,4 @@
|
||||
<string name="houses_empty">No houses are in danger right now.</string>
|
||||
<string name="houses_fallback_name">A house</string>
|
||||
<string name="houses_idoc_badge">IDOC</string>
|
||||
|
||||
<!-- ── Push notifications (§11, M7 Part 2) ─────────────────────────── -->
|
||||
<string name="menu_notifications">Notifications</string>
|
||||
<string name="notifications_title">Notifications</string>
|
||||
<string name="notifications_subtitle">Choose what this shard notifies you about. Nothing is sent unless you turn it on.</string>
|
||||
<string name="notifications_section_general">General</string>
|
||||
<string name="notifications_section_personal">Your game account</string>
|
||||
<string name="notifications_requires_link">Link a game account to enable this.</string>
|
||||
<string name="notifications_empty">This shard offers no notification streams yet.</string>
|
||||
<string name="notifications_unsupported">This shard hasn\'t set up push notifications yet.</string>
|
||||
<string name="notifications_saved">Notification settings saved.</string>
|
||||
<string name="notifications_all_off">Notifications turned off.</string>
|
||||
<string name="notifications_save_error">Couldn\'t save your notification settings. Try again.</string>
|
||||
<string name="notifications_relay_error">This shard\'s push relay isn\'t reachable right now.</string>
|
||||
|
||||
<!-- Notification channels + the ongoing foreground-service notification. -->
|
||||
<string name="push_channel_messages">Shard notifications</string>
|
||||
<string name="push_channel_messages_desc">Alerts you opted into from this shard.</string>
|
||||
<string name="push_channel_service">Background connection</string>
|
||||
<string name="push_channel_service_desc">Keeps the connection open to deliver notifications.</string>
|
||||
<string name="push_service_title">Notifications active</string>
|
||||
<string name="push_service_text">Listening for shard notifications.</string>
|
||||
|
||||
<!-- Per-stream notification titles (content-free tickle → generic title, §11). -->
|
||||
<string name="push_stream_news_post">New post</string>
|
||||
<string name="push_stream_server_status">Shard status changed</string>
|
||||
<string name="push_stream_idoc_warning">A house is falling (IDOC)</string>
|
||||
<string name="push_stream_champ_start">Champion spawn started</string>
|
||||
<string name="push_stream_governor_election">New governor elected</string>
|
||||
<string name="push_stream_vendor_sale">Your vendor made a sale</string>
|
||||
<string name="push_stream_house_idoc">Your house entered IDOC</string>
|
||||
<string name="push_stream_account_login">Login to your account</string>
|
||||
<string name="push_stream_generic">New notification</string>
|
||||
</resources>
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
|
||||
<!--
|
||||
The app is purely an HTTPS API client of a shard's website backend, so the base
|
||||
posture forbids all cleartext (HTTP) traffic. This makes explicit what minSdk 29 /
|
||||
targetSdk 35 already default to, satisfies the "usesCleartextTraffic implicitly
|
||||
enabled" scanner finding, and stops any merged library manifest from re-enabling
|
||||
cleartext. It also mirrors ServerUrl's release-build rule (HTTPS required) at the
|
||||
platform socket layer — defense in depth.
|
||||
|
||||
The debug variant overrides this file (app/src/debug/res/xml/) to re-permit
|
||||
cleartext to loopback only, for local dev against http://127.0.0.1:3000.
|
||||
-->
|
||||
<network-security-config>
|
||||
<base-config cleartextTrafficPermitted="false" />
|
||||
</network-security-config>
|
||||
@@ -1,49 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertNotEquals
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* PKCE Layer B primitives (PLAN.md §4.2). The challenge encoding must match the
|
||||
* backend byte-for-byte (`base64url(SHA-256(verifier))`, no padding) or `/exchange`
|
||||
* rejects every code — so it is pinned against the RFC 7636 test vector.
|
||||
*/
|
||||
class PkceTest {
|
||||
|
||||
// RFC 4648 §5 URL-safe base64 alphabet, no padding.
|
||||
private val base64UrlNoPad = Regex("^[A-Za-z0-9_-]+$")
|
||||
|
||||
@Test fun `challenge matches the RFC 7636 vector`() {
|
||||
// RFC 7636 Appendix B.
|
||||
val verifier = "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
|
||||
assertEquals("E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", Pkce.challengeOf(verifier))
|
||||
}
|
||||
|
||||
@Test fun `verifier is url-safe base64 without padding`() {
|
||||
val verifier = Pkce.newVerifier()
|
||||
assertTrue("verifier charset: $verifier", base64UrlNoPad.matches(verifier))
|
||||
// 32 random bytes → 43 base64 chars (no padding), inside RFC 7636's 43–128.
|
||||
assertEquals(43, verifier.length)
|
||||
}
|
||||
|
||||
@Test fun `challenge is url-safe base64 without padding`() {
|
||||
val challenge = Pkce.challengeOf(Pkce.newVerifier())
|
||||
assertTrue("challenge charset: $challenge", base64UrlNoPad.matches(challenge))
|
||||
// SHA-256 (32 bytes) → 43 base64 chars, no '=' padding.
|
||||
assertEquals(43, challenge.length)
|
||||
}
|
||||
|
||||
@Test fun `verifiers and states are unique per call`() {
|
||||
assertNotEquals(Pkce.newVerifier(), Pkce.newVerifier())
|
||||
assertNotEquals(Pkce.newState(), Pkce.newState())
|
||||
}
|
||||
|
||||
@Test fun `state is url-safe base64 without padding`() {
|
||||
assertTrue(base64UrlNoPad.matches(Pkce.newState()))
|
||||
}
|
||||
}
|
||||
@@ -1,251 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.auth.sso
|
||||
|
||||
import com.runicgateway.app.core.auth.Session
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.auth.StoredSession
|
||||
import com.runicgateway.app.core.auth.TokenStore
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
|
||||
import com.runicgateway.app.data.api.dto.MobileTokenResponse
|
||||
import com.runicgateway.app.data.api.dto.SafeUserDto
|
||||
import com.runicgateway.app.data.api.dto.SsoProviderDto
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import okhttp3.HttpUrl.Companion.toHttpUrl
|
||||
import okhttp3.MediaType.Companion.toMediaTypeOrNull
|
||||
import okhttp3.ResponseBody.Companion.toResponseBody
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertNull
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Test
|
||||
import retrofit2.Response
|
||||
|
||||
/**
|
||||
* The native SSO bridge orchestration (PLAN.md §4.2, M9): start-URL building, the
|
||||
* CSRF/state guard, the code→token exchange, and that a success drives the *same*
|
||||
* [SessionManager] the password login uses. Runs over a fake [SsoApi] + a real
|
||||
* [SessionManager] on a fake [TokenStore]; no Android framework types are touched.
|
||||
*/
|
||||
class SsoAuthManagerTest {
|
||||
|
||||
private class FakeTokenStore(var stored: StoredSession? = null) : TokenStore {
|
||||
override fun load(): StoredSession? = stored
|
||||
override fun save(session: StoredSession) { stored = session }
|
||||
override fun clear() { stored = null }
|
||||
}
|
||||
|
||||
/** In-memory stand-in for the encrypted pending-SSO store (survives across
|
||||
* manager instances the way the on-disk store survives process death). */
|
||||
private class FakePendingSsoStore(var pending: PendingSso? = null) : PendingSsoStore {
|
||||
override fun save(state: String, verifier: String) { pending = PendingSso(state, verifier) }
|
||||
override fun load(): PendingSso? = pending
|
||||
override fun clear() { pending = null }
|
||||
}
|
||||
|
||||
/** Records the exchange it was called with and returns a scripted response. */
|
||||
private class FakeSsoApi(
|
||||
private val exchangeResult: () -> Response<MobileTokenResponse>,
|
||||
) : SsoApi {
|
||||
var exchangeCalls = 0
|
||||
var lastRequest: MobileSsoExchangeRequest? = null
|
||||
|
||||
override suspend fun providers(): List<SsoProviderDto> = emptyList()
|
||||
|
||||
override suspend fun exchange(body: MobileSsoExchangeRequest): Response<MobileTokenResponse> {
|
||||
exchangeCalls++
|
||||
lastRequest = body
|
||||
return exchangeResult()
|
||||
}
|
||||
}
|
||||
|
||||
private fun tokenPair() = MobileTokenResponse(
|
||||
accessToken = "access-A",
|
||||
refreshToken = "refresh-A",
|
||||
expiresIn = "15m",
|
||||
user = SafeUserDto(id = 7, username = "alice", role = "player"),
|
||||
)
|
||||
|
||||
private fun error(code: Int): Response<MobileTokenResponse> =
|
||||
Response.error(code, "".toResponseBody("application/json".toMediaTypeOrNull()))
|
||||
|
||||
private fun managerWith(
|
||||
api: SsoApi,
|
||||
session: SessionManager,
|
||||
base: String? = "https://shard.example.com/",
|
||||
store: PendingSsoStore = FakePendingSsoStore(),
|
||||
): SsoAuthManager {
|
||||
val holder = BaseUrlHolder()
|
||||
if (base != null) holder.set(base.toHttpUrl())
|
||||
return SsoAuthManager(api, session, holder, store)
|
||||
}
|
||||
|
||||
/** Build a start URL and pull the generated `state` back out of it. */
|
||||
private fun startAndState(mgr: SsoAuthManager, provider: String = "google"): String {
|
||||
val url = mgr.buildStartUrl(SsoProviderDto(id = provider, name = "Google").id)!!
|
||||
return url.toHttpUrl().queryParameter("state")!!
|
||||
}
|
||||
|
||||
@Test fun `buildStartUrl carries provider, challenge, state and the fixed redirect`() {
|
||||
val mgr = managerWith(FakeSsoApi { tokenPair().let { Response.success(it) } }, SessionManager(FakeTokenStore()))
|
||||
val url = mgr.buildStartUrl("google")!!
|
||||
val http = url.toHttpUrl()
|
||||
|
||||
assertTrue(url.startsWith("https://shard.example.com/api/v1/auth/mobile/sso/start"))
|
||||
assertEquals("google", http.queryParameter("provider"))
|
||||
assertEquals(SsoAuthManager.REDIRECT_URI, http.queryParameter("redirect_uri"))
|
||||
assertTrue(!http.queryParameter("code_challenge").isNullOrBlank())
|
||||
assertTrue(!http.queryParameter("state").isNullOrBlank())
|
||||
}
|
||||
|
||||
@Test fun `buildStartUrl returns null when no base url is set`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()), base = null)
|
||||
assertNull(mgr.buildStartUrl("google"))
|
||||
}
|
||||
|
||||
@Test fun `successful callback exchanges and signs in`() = runTest {
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val session = SessionManager(FakeTokenStore())
|
||||
val mgr = managerWith(api, session)
|
||||
|
||||
val state = startAndState(mgr)
|
||||
mgr.complete(state = state, code = "auth-code-1", error = null)
|
||||
|
||||
assertEquals(1, api.exchangeCalls)
|
||||
assertEquals("auth-code-1", api.lastRequest?.code)
|
||||
assertTrue(session.state.value is Session.SignedIn)
|
||||
assertEquals("access-A", session.currentAccessToken())
|
||||
assertEquals(SsoAuthManager.Outcome.Success, mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `state mismatch fails without exchanging`() = runTest {
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val session = SessionManager(FakeTokenStore())
|
||||
val mgr = managerWith(api, session)
|
||||
|
||||
startAndState(mgr) // establishes a pending with a different state
|
||||
mgr.complete(state = "not-the-state", code = "auth-code-1", error = null)
|
||||
|
||||
assertEquals(0, api.exchangeCalls)
|
||||
assertTrue(session.state.value is Session.SignedOut)
|
||||
assertEquals(SsoAuthManager.Outcome.Failed(SsoAuthManager.Failure.STATE_MISMATCH), mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `missing pending flow (process death) fails closed`() = runTest {
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val mgr = managerWith(api, SessionManager(FakeTokenStore()))
|
||||
|
||||
// No buildStartUrl → nothing stashed; a callback can't be trusted.
|
||||
mgr.complete(state = "anything", code = "auth-code-1", error = null)
|
||||
|
||||
assertEquals(0, api.exchangeCalls)
|
||||
assertEquals(SsoAuthManager.Outcome.Failed(SsoAuthManager.Failure.STATE_MISMATCH), mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `pending survives process death — a fresh manager on the same store completes`() = runTest {
|
||||
// Persist the pending on one instance, then throw that instance away.
|
||||
val store = FakePendingSsoStore()
|
||||
val session = SessionManager(FakeTokenStore())
|
||||
val started = managerWith(FakeSsoApi { Response.success(tokenPair()) }, session, store = store)
|
||||
val state = startAndState(started)
|
||||
|
||||
// A brand-new manager (simulating the app relaunched after eviction) reads the
|
||||
// persisted pending and completes the exchange — the old in-memory holder would
|
||||
// have lost it and failed STATE_MISMATCH.
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val revived = managerWith(api, session, store = store)
|
||||
revived.complete(state = state, code = "auth-code-1", error = null)
|
||||
|
||||
assertEquals(1, api.exchangeCalls)
|
||||
assertTrue(session.state.value is Session.SignedIn)
|
||||
assertEquals(SsoAuthManager.Outcome.Success, revived.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `error callback maps to a declined sign-in and does not exchange`() = runTest {
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val mgr = managerWith(api, SessionManager(FakeTokenStore()))
|
||||
|
||||
val state = startAndState(mgr)
|
||||
mgr.complete(state = state, code = null, error = "access_denied")
|
||||
|
||||
assertEquals(0, api.exchangeCalls)
|
||||
assertEquals(SsoAuthManager.Outcome.Failed(SsoAuthManager.Failure.DENIED), mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `401 exchange maps to expired code`() = runTest {
|
||||
val api = FakeSsoApi { error(401) }
|
||||
val session = SessionManager(FakeTokenStore())
|
||||
val mgr = managerWith(api, session)
|
||||
|
||||
val state = startAndState(mgr)
|
||||
mgr.complete(state = state, code = "stale-code", error = null)
|
||||
|
||||
assertEquals(1, api.exchangeCalls)
|
||||
assertTrue(session.state.value is Session.SignedOut)
|
||||
assertEquals(SsoAuthManager.Outcome.Failed(SsoAuthManager.Failure.EXPIRED_CODE), mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `a second delivery of the same callback finds no pending`() = runTest {
|
||||
val api = FakeSsoApi { Response.success(tokenPair()) }
|
||||
val mgr = managerWith(api, SessionManager(FakeTokenStore()))
|
||||
|
||||
val state = startAndState(mgr)
|
||||
mgr.complete(state = state, code = "auth-code-1", error = null)
|
||||
mgr.complete(state = state, code = "auth-code-1", error = null) // replay
|
||||
|
||||
// Only the first delivery exchanged; the replay fails the state guard.
|
||||
assertEquals(1, api.exchangeCalls)
|
||||
assertEquals(SsoAuthManager.Outcome.Failed(SsoAuthManager.Failure.STATE_MISMATCH), mgr.outcome.value)
|
||||
}
|
||||
|
||||
@Test fun `matchesCallback only accepts the fixed scheme host and path`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()))
|
||||
assertTrue(mgr.matchesCallback("runicgateway", "auth", "/callback"))
|
||||
assertTrue(!mgr.matchesCallback("https", "auth", "/callback"))
|
||||
assertTrue(!mgr.matchesCallback("runicgateway", "auth", "/other"))
|
||||
assertTrue(!mgr.matchesCallback("runicgateway", "evil", "/callback"))
|
||||
}
|
||||
|
||||
// ── App Links (docs/android/APP_LINKS.md) ────────────────────────────────
|
||||
|
||||
@Test fun `matchesAppLinkCallback accepts only https, the app-link path, and the paired host`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()))
|
||||
// Paired to shard.example.com (managerWith default base).
|
||||
assertTrue(mgr.matchesAppLinkCallback("https", "shard.example.com", "/mobile/callback"))
|
||||
// Host-trust: a foreign host is refused even over https + right path.
|
||||
assertTrue(!mgr.matchesAppLinkCallback("https", "evil.example.com", "/mobile/callback"))
|
||||
// Wrong scheme / wrong path.
|
||||
assertTrue(!mgr.matchesAppLinkCallback("http", "shard.example.com", "/mobile/callback"))
|
||||
assertTrue(!mgr.matchesAppLinkCallback("https", "shard.example.com", "/callback"))
|
||||
// Host match is case-insensitive.
|
||||
assertTrue(mgr.matchesAppLinkCallback("https", "SHARD.EXAMPLE.COM", "/mobile/callback"))
|
||||
}
|
||||
|
||||
@Test fun `matchesAppLinkCallback is false before a shard is paired`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()), base = null)
|
||||
assertTrue(!mgr.matchesAppLinkCallback("https", "shard.example.com", "/mobile/callback"))
|
||||
}
|
||||
|
||||
@Test fun `buildStartUrl requests the custom scheme when no app-link host is baked`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()))
|
||||
// Generic build: appLinkHost defaults to BuildConfig.APP_LINK_HOST ("" in tests).
|
||||
val redirect = mgr.buildStartUrl("google")!!.toHttpUrl().queryParameter("redirect_uri")
|
||||
assertEquals(SsoAuthManager.REDIRECT_URI, redirect)
|
||||
}
|
||||
|
||||
@Test fun `buildStartUrl requests the https app-link callback when the baked host matches the paired host`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()))
|
||||
mgr.appLinkHost = "shard.example.com" // white-label build baked this shard's host
|
||||
val redirect = mgr.buildStartUrl("google")!!.toHttpUrl().queryParameter("redirect_uri")
|
||||
assertEquals("https://shard.example.com/mobile/callback", redirect)
|
||||
}
|
||||
|
||||
@Test fun `buildStartUrl falls back to the custom scheme when the baked host does not match the paired shard`() {
|
||||
val mgr = managerWith(FakeSsoApi { Response.success(tokenPair()) }, SessionManager(FakeTokenStore()))
|
||||
mgr.appLinkHost = "other-shard.example.com" // built for a different shard than the paired one
|
||||
val redirect = mgr.buildStartUrl("google")!!.toHttpUrl().queryParameter("redirect_uri")
|
||||
assertEquals(SsoAuthManager.REDIRECT_URI, redirect)
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertNotEquals
|
||||
import org.junit.Assert.assertNull
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* Tests for the app's own ntfy topic + endpoint URL building (PLAN.md §11, work
|
||||
* item 1) — the heart of the embedded-distributor design.
|
||||
*/
|
||||
class NtfyTopicTest {
|
||||
|
||||
@Test fun generatesUnguessableTopicsInTheAllowedCharset() {
|
||||
val a = NtfyTopic.generate()
|
||||
val b = NtfyTopic.generate()
|
||||
assertNotEquals(a, b)
|
||||
assertTrue("prefixed", a.startsWith("up"))
|
||||
assertTrue("length", a.length >= 24)
|
||||
assertTrue("charset", a.all { it.isLetterOrDigit() })
|
||||
}
|
||||
|
||||
@Test fun buildsEndpointAndSseUrls() {
|
||||
assertEquals("https://ntfy.tld/up7", NtfyTopic.endpointUrl("https://ntfy.tld", "up7"))
|
||||
assertEquals("https://ntfy.tld/up7/sse", NtfyTopic.sseUrl("https://ntfy.tld", "up7"))
|
||||
}
|
||||
|
||||
@Test fun toleratesTrailingSlashOnBase() {
|
||||
assertEquals("https://ntfy.tld/up7", NtfyTopic.endpointUrl("https://ntfy.tld/", "up7"))
|
||||
}
|
||||
|
||||
@Test fun nullOrBlankInputsYieldNull() {
|
||||
assertNull(NtfyTopic.endpointUrl(null, "up7"))
|
||||
assertNull(NtfyTopic.endpointUrl("", "up7"))
|
||||
assertNull(NtfyTopic.endpointUrl("https://ntfy.tld", " "))
|
||||
assertNull(NtfyTopic.sseUrl(null, "up7"))
|
||||
}
|
||||
}
|
||||
@@ -1,52 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.push
|
||||
|
||||
import kotlinx.serialization.json.Json
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertNull
|
||||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* Parsing tests for the content-free push tickle over ntfy's SSE envelope
|
||||
* (PLAN.md §11). A `message` frame yields `{ stream, ref }`; lifecycle frames and
|
||||
* malformed bodies are dropped (never thrown, §7).
|
||||
*/
|
||||
class PushTickleTest {
|
||||
|
||||
private val json = Json { ignoreUnknownKeys = true }
|
||||
|
||||
@Test fun parsesMessageFrame() {
|
||||
// ntfy wraps our POSTed body in { event:"message", message:"<our json>" }.
|
||||
val data = """{"id":"x","time":1,"event":"message","topic":"up1","message":"{\"stream\":\"vendor.sale\",\"ref\":\"0x40001\"}"}"""
|
||||
val tickle = parseNtfyTickle(json, data)
|
||||
assertEquals(PushTickle("vendor.sale", "0x40001"), tickle)
|
||||
}
|
||||
|
||||
@Test fun parsesMessageWithoutRef() {
|
||||
val data = """{"event":"message","message":"{\"stream\":\"server.status\"}"}"""
|
||||
val tickle = parseNtfyTickle(json, data)
|
||||
assertEquals("server.status", tickle?.stream)
|
||||
assertNull(tickle?.ref)
|
||||
}
|
||||
|
||||
@Test fun dropsOpenAndKeepaliveFrames() {
|
||||
assertNull(parseNtfyTickle(json, """{"event":"open","topic":"up1"}"""))
|
||||
assertNull(parseNtfyTickle(json, """{"event":"keepalive","topic":"up1"}"""))
|
||||
}
|
||||
|
||||
@Test fun dropsMalformedOrEmpty() {
|
||||
assertNull(parseNtfyTickle(json, ""))
|
||||
assertNull(parseNtfyTickle(json, ": keepalive comment"))
|
||||
assertNull(parseNtfyTickle(json, "not json"))
|
||||
// A message whose inner body isn't our shape → no stream → dropped.
|
||||
assertNull(parseNtfyTickle(json, """{"event":"message","message":"{}"}"""))
|
||||
assertNull(parseNtfyTickle(json, """{"event":"message","message":"garbage"}"""))
|
||||
}
|
||||
|
||||
@Test fun decodeTickleRejectsBlankStream() {
|
||||
assertNull(decodeTickle(json, """{"stream":"","ref":"x"}"""))
|
||||
assertEquals(PushTickle("news.post"), decodeTickle(json, """{"stream":"news.post"}"""))
|
||||
}
|
||||
}
|
||||
@@ -35,20 +35,6 @@ class ApiResultTest {
|
||||
assertTrue(result is ApiResult.NetworkError)
|
||||
}
|
||||
|
||||
/**
|
||||
* A body the app can't decode (a field whose type doesn't match its DTO) throws a
|
||||
* [SerializationException] out of the Retrofit converter. It must degrade to a
|
||||
* server-side error the UI renders, not escape and crash the app — the guild-board
|
||||
* crash this fixes. `502` folds to [ui.ErrorKind.SERVER] via `toUiState`.
|
||||
*/
|
||||
@Test fun serializationExceptionBecomesServerError() = runTest {
|
||||
val result = safeApiCall {
|
||||
throw kotlinx.serialization.SerializationException("Unexpected symbol 'm' at path: \$[0].members")
|
||||
}
|
||||
assertTrue(result is ApiResult.HttpError)
|
||||
assertEquals(502, (result as ApiResult.HttpError).status)
|
||||
}
|
||||
|
||||
@Test fun cancellationIsRethrown() = runTest {
|
||||
assertThrows(CancellationException::class.java) {
|
||||
kotlinx.coroutines.runBlocking {
|
||||
|
||||
@@ -1,75 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.json.Json
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertFalse
|
||||
import org.junit.Assert.assertNull
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* Decoding tests for the opt-in push DTOs (PLAN.md §11, M7 Part 2). Shapes come
|
||||
* from the merged backend (`notifications.controller` / `pushDevices.model`);
|
||||
* unknown keys are ignored (additive fields, §8).
|
||||
*/
|
||||
class NotificationsDtoTest {
|
||||
|
||||
private val json = Json {
|
||||
ignoreUnknownKeys = true
|
||||
explicitNulls = false
|
||||
coerceInputValues = true
|
||||
}
|
||||
|
||||
@Test fun pushDeviceDecodes() {
|
||||
val dto = json.decodeFromString<PushDeviceDto>(
|
||||
"""{"id":9,"transport":"unifiedpush","endpoint":"https://ntfy.example.com/up123",
|
||||
"platform":"android","createdAt":"2026-07-20T00:00:00Z","lastSeenAt":null}""",
|
||||
)
|
||||
assertEquals(9L, dto.id)
|
||||
assertEquals("unifiedpush", dto.transport)
|
||||
assertEquals("https://ntfy.example.com/up123", dto.endpoint)
|
||||
assertEquals("android", dto.platform)
|
||||
assertNull(dto.lastSeenAt)
|
||||
}
|
||||
|
||||
@Test fun streamCatalogDecodesPersonalFlags() {
|
||||
val dto = json.decodeFromString<NotificationStreamsDto>(
|
||||
"""{"streams":[
|
||||
{"id":"news.post","label":"News posts","description":"New posts.","personal":false,"requiresLinkedAccount":false},
|
||||
{"id":"vendor.sale","label":"Your vendor sold","description":"A sale.","personal":true,"requiresLinkedAccount":true}
|
||||
]}""",
|
||||
)
|
||||
assertEquals(2, dto.streams.size)
|
||||
val news = dto.streams.first { it.id == "news.post" }
|
||||
assertFalse(news.personal)
|
||||
assertFalse(news.requiresLinkedAccount)
|
||||
val vendor = dto.streams.first { it.id == "vendor.sale" }
|
||||
assertTrue(vendor.personal)
|
||||
assertTrue(vendor.requiresLinkedAccount)
|
||||
}
|
||||
|
||||
@Test fun subscriptionsDecode() {
|
||||
val dto = json.decodeFromString<NotificationSubscriptionsDto>(
|
||||
"""{"streams":["news.post","champ.start"]}""",
|
||||
)
|
||||
assertEquals(listOf("news.post", "champ.start"), dto.streams)
|
||||
}
|
||||
|
||||
@Test fun settingsPushBlockDecodes() {
|
||||
val dto = json.decodeFromString<SettingsDto>(
|
||||
"""{"site_title":"Shard","brand":{"name":"Shard"},"push":{"ntfyUrl":"https://ntfy.shard.tld"}}""",
|
||||
)
|
||||
assertEquals("https://ntfy.shard.tld", dto.push.ntfyUrl)
|
||||
}
|
||||
|
||||
@Test fun settingsPushDefaultsNullOnOlderBackend() {
|
||||
// A backend predating M7 omits `push` entirely — the app must still decode.
|
||||
val dto = json.decodeFromString<SettingsDto>(
|
||||
"""{"site_title":"Shard","brand":{"name":"Shard"}}""",
|
||||
)
|
||||
assertNull(dto.push.ntfyUrl)
|
||||
}
|
||||
}
|
||||
@@ -43,31 +43,25 @@ class ShardDtoTest {
|
||||
}
|
||||
|
||||
@Test fun champUpdateFrameDecodesWithKindAndExtras() {
|
||||
// A live champ.update frame: has `kind`, a hex-string `serial` (INTEGRATION.md
|
||||
// §1 — serials are opaque hex keys, never numbers), and category extras. The
|
||||
// `kind`/`rank`/`autoRestart` fields are ignored (not on the DTO); extras decode.
|
||||
// A live champ.update frame: has `kind`, `serial`, and category extras. The
|
||||
// `kind` field is ignored (not on the DTO) and the extras decode.
|
||||
val dto = json.decodeFromString<ChampDto>(
|
||||
"""{"kind":"champ.update","serial":"0x40012345","category":"champion","name":"Barracoon",
|
||||
"status":"active","active":true,"level":10,"rank":3,"maxKills":250,"kills":120,
|
||||
"autoRestart":true,"bossUp":false,"map":"Felucca","x":5571,"y":1379,"z":0,"t":1721426400000}""",
|
||||
"""{"kind":"champ.update","serial":12345,"category":"champion","name":"Barracoon",
|
||||
"status":"active","active":true,"level":10,"maxKills":250,"kills":120,
|
||||
"bossUp":false,"map":"Felucca","x":5571,"y":1379,"z":0,"t":1721426400000}""",
|
||||
)
|
||||
assertEquals("0x40012345", dto.serial)
|
||||
assertEquals(12345L, dto.serial)
|
||||
assertEquals("champion", dto.category)
|
||||
assertEquals(120, dto.kills)
|
||||
assertTrue(dto.active)
|
||||
}
|
||||
|
||||
@Test fun guildFrameDecodesLeaderActor() {
|
||||
// The leader actor carries a hex-string serial and a string webId (the linked
|
||||
// site-user id) — the exact wire shape from INTEGRATION.md §7.
|
||||
val dto = json.decodeFromString<GuildDto>(
|
||||
"""{"kind":"guild.update","id":7,"name":"Knights","abbr":"KNT","members":12,
|
||||
"online":3,"alliance":"Light",
|
||||
"leader":{"serial":"0x1A2B","name":"Arthur","acct":"art","webId":"9931","player":true}}""",
|
||||
"online":3,"alliance":"Light","leader":{"serial":1,"name":"Arthur","acct":"art"}}""",
|
||||
)
|
||||
assertEquals(7L, dto.id)
|
||||
assertEquals("0x1A2B", dto.leader?.serial)
|
||||
assertEquals("9931", dto.leader?.webId)
|
||||
assertEquals("Arthur", dto.leader?.label)
|
||||
assertEquals(12, dto.members)
|
||||
}
|
||||
@@ -92,21 +86,13 @@ class ShardDtoTest {
|
||||
|
||||
@Test fun houseDecodesPublicIdocShape() {
|
||||
val dto = json.decodeFromString<HouseDto>(
|
||||
"""{"serial":"0x40001234","name":"Tower","region":"Britain","map":"Felucca",
|
||||
"""{"serial":999,"name":"Tower","region":"Britain","map":"Felucca",
|
||||
"x":1,"y":2,"z":3,"isIdoc":true}""",
|
||||
)
|
||||
assertEquals("0x40001234", dto.serial)
|
||||
assertEquals(999L, dto.serial)
|
||||
assertTrue(dto.isIdoc)
|
||||
}
|
||||
|
||||
@Test fun onlineStaffDecodesHexSerial() {
|
||||
val dto = json.decodeFromString<OnlineStaffDto>(
|
||||
"""{"serial":"0x24C","name":"Darrow"}""",
|
||||
)
|
||||
assertEquals("0x24C", dto.serial)
|
||||
assertEquals("Darrow", dto.name)
|
||||
}
|
||||
|
||||
@Test fun actorLabelFallsBackToAcctThenSomeone() {
|
||||
assertEquals("bob", ActorDto(acct = "bob").label)
|
||||
assertEquals("Someone", ActorDto().label)
|
||||
|
||||
@@ -64,24 +64,4 @@ class MenuAccessTest {
|
||||
assertTrue(visibleEntries(entries, signedIn(Role.ADMIN)).isEmpty())
|
||||
assertTrue(visibleEntries(entries, Session.SignedOut).isEmpty())
|
||||
}
|
||||
|
||||
@Test fun staffSeeTheAdminDashboardButPlayersDoNot() {
|
||||
// STAFF entries (M10) show for every staff role, never for a player or anon.
|
||||
for (role in listOf(Role.ADMIN, Role.EDITOR, Role.MODERATOR)) {
|
||||
assertTrue("$role should see the dashboard", routes(signedIn(role)).contains(Routes.ADMIN_DASHBOARD))
|
||||
}
|
||||
assertFalse(routes(signedIn(Role.PLAYER)).contains(Routes.ADMIN_DASHBOARD))
|
||||
assertFalse(routes(Session.SignedOut).contains(Routes.ADMIN_DASHBOARD))
|
||||
}
|
||||
|
||||
@Test fun moderatorAccessIsAdminAndModeratorOnly() {
|
||||
// A synthetic MODERATOR-gated entry (moderation / support) is visible to
|
||||
// admin + moderator, but NOT editor, player, or anon.
|
||||
val entries = listOf(MenuEntry("mod", 0, MenuAccess.MODERATOR))
|
||||
assertTrue(visibleEntries(entries, signedIn(Role.ADMIN)).isNotEmpty())
|
||||
assertTrue(visibleEntries(entries, signedIn(Role.MODERATOR)).isNotEmpty())
|
||||
assertTrue(visibleEntries(entries, signedIn(Role.EDITOR)).isEmpty())
|
||||
assertTrue(visibleEntries(entries, signedIn(Role.PLAYER)).isEmpty())
|
||||
assertTrue(visibleEntries(entries, Session.SignedOut).isEmpty())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import com.runicgateway.app.core.push.PushStreams
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamDto
|
||||
import com.runicgateway.app.ui.navigation.Routes
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Assert.assertFalse
|
||||
import org.junit.Assert.assertTrue
|
||||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* Tests the pure push helpers: the stream → deep-link route map (PLAN.md §11 work
|
||||
* item 7) and the personal-stream gating (a personal stream needs a linked account).
|
||||
*/
|
||||
class NotificationRoutingTest {
|
||||
|
||||
@Test fun deepLinkRoutesMapEachStreamToItsScreen() {
|
||||
assertEquals(Routes.NEWS, Routes.forStream(PushStreams.NEWS_POST))
|
||||
assertEquals(Routes.SHARD, Routes.forStream(PushStreams.SERVER_STATUS))
|
||||
assertEquals(Routes.SHARD, Routes.forStream(PushStreams.CHAMP_START))
|
||||
assertEquals(Routes.SHARD, Routes.forStream(PushStreams.IDOC_WARNING))
|
||||
assertEquals(Routes.SHARD, Routes.forStream(PushStreams.GOVERNOR_ELECTION))
|
||||
assertEquals(Routes.PLAYER_VENDORS, Routes.forStream(PushStreams.VENDOR_SALE))
|
||||
assertEquals(Routes.PLAYER_HOUSES, Routes.forStream(PushStreams.HOUSE_IDOC))
|
||||
assertEquals(Routes.ACCOUNT, Routes.forStream(PushStreams.ACCOUNT_LOGIN))
|
||||
}
|
||||
|
||||
@Test fun unknownStreamFallsBackToHome() {
|
||||
assertEquals(Routes.HOME, Routes.forStream("something.new"))
|
||||
}
|
||||
|
||||
@Test fun personalStreamNeedsLinkedAccount() {
|
||||
val personal = NotificationStreamDto(id = "vendor.sale", personal = true, requiresLinkedAccount = true)
|
||||
assertFalse(streamSelectable(personal, hasLinkedAccount = false))
|
||||
assertTrue(streamSelectable(personal, hasLinkedAccount = true))
|
||||
}
|
||||
|
||||
@Test fun generalStreamIsAlwaysSelectable() {
|
||||
val general = NotificationStreamDto(id = "news.post", personal = false, requiresLinkedAccount = false)
|
||||
assertTrue(streamSelectable(general, hasLinkedAccount = false))
|
||||
}
|
||||
}
|
||||
@@ -1,32 +0,0 @@
|
||||
# SonarQube analysis config for the Android-app repo.
|
||||
# Consumed by the scanner in .gitea/workflows/sonarqube.yml on push to main.
|
||||
# The project key must match the one created in SonarQube (dashboard URL
|
||||
# ?id=Runic-Gateway-Android-app).
|
||||
|
||||
sonar.projectKey=Runic-Gateway-Android-app
|
||||
sonar.projectName=runic gateway android app
|
||||
|
||||
# Analysed application code. The single :app module's Kotlin sources.
|
||||
# SonarQube's Kotlin analyzer works on source directly, so no compiled classes
|
||||
# or Gradle build are required for the scan.
|
||||
sonar.sources=app/src/main
|
||||
|
||||
# Local unit tests (app/src/test). Instrumented tests (app/src/androidTest) can
|
||||
# be added here once that source set exists.
|
||||
sonar.tests=app/src/test
|
||||
|
||||
# Never analyse build output, Gradle internals, or generated code.
|
||||
sonar.exclusions=**/build/**,**/.gradle/**,**/generated/**
|
||||
|
||||
sonar.sourceEncoding=UTF-8
|
||||
|
||||
# ── Optional enrichment (enable once the reports are produced in CI) ──
|
||||
# For richer Kotlin/Android results, run the reporters in sonarqube.yml and point
|
||||
# SonarQube at their output:
|
||||
# • Android Lint: ./gradlew lintDebug → app/build/reports/lint-results-debug.xml
|
||||
# sonar.androidLint.reportPaths=app/build/reports/lint-results-debug.xml
|
||||
# • JaCoCo coverage (needs a coverage-enabled test run):
|
||||
# sonar.coverage.jacoco.xmlReportPaths=app/build/reports/jacoco/.../*.xml
|
||||
# The alternative to the CLI scanner used here is the SonarQube Gradle plugin
|
||||
# (org.sonarqube), which auto-discovers these reports; the CLI + properties file
|
||||
# is used instead to keep this repo's setup identical to website/ and link/.
|
||||
Reference in New Issue
Block a user