25 Commits

Author SHA1 Message Date
f6deeb9624 ci(sonarqube): add non-blocking SonarQube analysis on push to main
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m48s
Mirrors the website repo's setup: a source-based scan of app/src/main
(Kotlin) that reports to the self-hosted SonarQube server after merge,
never gating PRs. Project key runic-gateway-android-app.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 23:13:39 -05:00
0ea6495d9e Merge pull request 'feat(sso): App Links autoVerify callback + paired-host trust check' (#17) from feat/app-links into main
All checks were successful
Release APK / release (push) Successful in 9m14s
Reviewed-on: #17
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-21 00:20:49 +00:00
3050443aac Merge branch 'main' into feat/app-links
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m39s
2026-07-20 23:43:59 +00:00
987ddb54f8 feat(sso): App Links autoVerify callback + paired-host trust check
All checks were successful
PR Checks / android-build (pull_request) Successful in 20m53s
Add the app side of Android App Links (M9 follow-up, docs/android/APP_LINKS.md),
layered on the M9 Part 2 native SSO callback:

- Build-time `appLinkHost` Gradle property -> BuildConfig.APP_LINK_HOST +
  manifestPlaceholders["appLinkHost"]. autoVerify needs a literal host, so the
  generic multi-tenant build leaves it empty (placeholder falls back to the
  reserved runic-gateway.invalid sentinel, making the filter inert); a
  white-label build bakes one host with -PappLinkHost=play.myshard.com.
- Manifest: an autoVerify https `/mobile/callback` intent-filter beside the
  unchanged custom-scheme one (the permanent fallback).
- SsoAuthManager: request the https App Link redirect_uri iff the baked host
  matches the paired shard host; matchesAppLinkCallback() enforces a paired-host
  trust check (host must equal the currently-paired base URL host) as
  defense-in-depth. Both matchers feed the same complete()/exchange path.
- MainActivity routes custom-scheme and App Link callbacks identically.

+5 JVM tests (SsoAuthManagerTest -> 14). Built green (JDK 21,
-Pksp.incremental=false); white-label host substitution verified in the merged
manifest.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
2026-07-20 18:37:32 -05:00
ab68fab382 Merge pull request 'feat(auth): M9 Part 2 — native in-app SSO via the mobile bridge' (#16) from feat/m9-native-sso into main
Reviewed-on: #16
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 23:14:45 +00:00
7665975d59 feat(auth): M9 Part 2 — native in-app SSO via the mobile bridge
All checks were successful
PR Checks / android-build (pull_request) Successful in 20m34s
Add the app client for the Mobile SSO Authorization Bridge (PLAN.md §4.2):
native "Sign in with <provider>" without shipping any OAuth secret.

- Pkce: pure-JVM RFC 7636 S256 verifier/challenge + CSRF state, encoded to
  match the backend's base64url(SHA-256) exactly.
- SsoAuthManager (Singleton): mints PKCE+state, builds the /auth/mobile/sso/start
  URL for a Custom Tab, verifies the returned state, exchanges the one-time code
  with the stashed verifier, and drives the existing SessionManager.onSignedIn —
  no new token-storage or refresh code. Pending flow is in-memory (fails closed on
  process death). Exposes an outcome StateFlow the login screen consumes.
- SsoApi + DTOs: GET /auth/providers discovery and POST /auth/mobile/sso/exchange
  (tagged NO_SESSION so a credential 401 isn't read as an expired session).
- MainActivity: runicgateway://auth/callback intent-filter + singleTop; parses the
  callback Uri (the Android edge) and hands raw params to SsoAuthManager.
- LoginScreen/ViewModel: render a button per discovered provider, opening the
  bridge in a Custom Tab; fall back to the website login hand-off when none.

Additive — no other screen's data flow changes; no backend work. Custom scheme
only for now (App Links deferred, APP_LINKS.md).

Tests (JVM, +14): Pkce vector/charset, start-URL building, and the full
complete() flow over a fake SsoApi + real SessionManager (success signs in;
state mismatch / missing pending fail without exchanging; error callback →
declined; 401 → expired-code; replay finds no pending).

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
2026-07-20 17:52:36 -05:00
d97c06d6e1 Merge pull request 'feat(push): M7 Part 2 — opt-in push notifications (embedded ntfy distributor)' (#15) from feat/m7-push-notifications into main
Reviewed-on: #15
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 21:18:27 +00:00
e2ced06a83 feat(push): M7 Part 2 — opt-in push notifications (embedded ntfy distributor)
All checks were successful
PR Checks / android-build (pull_request) Successful in 20m16s
Implements the app side of M7 push (docs/android/PLAN.md §11). The app EMBEDS
its own distributor — ntfy is only the relay server, no second app installed,
no Google Play Services. New feature slice; no existing screen's data flow
changes.

- core/push: NtfyTopic (random unguessable topic + endpoint/SSE URL builders),
  PushTickle (content-free { stream, ref } parser over ntfy's SSE envelope),
  NtfyStreamClient (bare-client OkHttp SSE to <ntfy>/<topic>/sse, reconnect/
  backoff cloned from ShardStreamClient), PushNotifier (channels + per-stream
  deep-link notification), PushService (foreground service holding the
  connection), PushManager (mint topic / register-unregister device / start-stop,
  keyed to the session), PushPreferences (DataStore state).
- data: NotificationsApi + DTOs + NotificationsRepository over the merged
  /auth/me/devices + /auth/me/notifications/* contract; push block on SettingsDto.
- ui/notifications: settings screen + VM — per-stream toggles, personal streams
  greyed until a game account is linked, POST_NOTIFICATIONS request on enable.
- Navigation: Routes.NOTIFICATIONS + stream→route deep-link map, menu entry,
  RunicApp + MainActivity intent handling; teardown wired into logout + server
  switch (deregister while bearer valid) and every sign-out (local, via session
  observer).
- Manifest: POST_NOTIFICATIONS + FOREGROUND_SERVICE(_DATA_SYNC) + the service.

Deviation (recorded in PLAN.md): direct-ntfy transport, no UnifiedPush library
— the plan's stated likely path; keeps the APK Google-free and dependency-light,
with a PushResult/transport seam for a future FCM Play flavor. Requires the small
companion push.ntfyUrl settings field (website#<pr>).

18 new JVM tests; :app:testDebugUnitTest + lintDebug + assembleDebug green.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 15:25:59 -05:00
d0fb6bbdfc Merge pull request 'ci(release): make the release tag-driven (stop pushing to protected main)' (#14) from ci/tag-driven-release into main
All checks were successful
Release APK / release (push) Successful in 8m44s
Reviewed-on: #14
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 19:11:40 +00:00
9268579c5f ci(release): make the release tag-driven (no push to protected main)
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m23s
The push-to-main release model kept failing: the job builds the signed APK
fine, but the final `git push origin HEAD:main` (version-bump commit) is
rejected by main's branch protection — "pre-receive hook declined / Internal
Server Error" — across runs #187, #194. main is deliberately protected
(allowlist push, required approvals, required status checks), which is
fundamentally incompatible with a CI job pushing a fresh commit to it.

Flip the trigger: the workflow now runs on pushing a `v*` tag (or via
workflow_dispatch with a tag input). The tag *is* the release input, so:

- version/versionCode are derived from the tag name (no version-planning engine);
- app/build.gradle.kts is set for the build only, never committed back;
- no `git push` to main, no tag creation, no REGISTRY_USER needed —
  only REGISTRY_TOKEN, to create the Gitea release + upload the APK/SHA256SUMS.

To cut a release now: `git tag v0.1.0 && git push origin v0.1.0`.

Keeps the speed fixes from #13 (trimmed setup-android, no Gradle cache,
timeout-minutes). Changelog is still generated from conventional-commit
subjects since the previous tag.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 19:00:04 +00:00
0c395b2527 Merge pull request 'ci(release): trim setup-android, drop broken Gradle cache, add job timeout' (#13) from ci/release-workflow-speedup into main
Some checks failed
Release APK / release (push) Failing after 9m23s
Reviewed-on: #13
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 17:50:25 +00:00
2d84a930e5 ci(release): fix workflow file mangled by prior base64 double-encode
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m19s
Restore proper YAML content (the previous commit on this branch accidentally
stored the base64 string as the literal file body).
2026-07-20 17:39:29 +00:00
b6a0fa1f5d ci(release): trim setup-android, drop broken Gradle cache, add job timeout
All checks were successful
PR Checks / android-build (pull_request) Successful in 20m43s
The release workflow was slow and sometimes appeared to hang mid-build:

- android-actions/setup-android@v3 pulled the entire Android emulator and the
  legacy `tools` package (hundreds of MB, network-bound on the self-hosted
  runner) that a headless APK build never uses. Pin `packages: ''` so it only
  puts cmdline-tools on PATH; the next step installs exactly what we need.
- The `actions/cache@v4` Gradle step timed out every run against the Gitea
  artifact-cache backend (`getCacheEntry failed: Request timeout`), adding
  latency with no benefit. Dropped it.
- The job had no timeout, and with `concurrency.cancel-in-progress: false` a
  genuinely wedged run would hang forever and block every later release behind
  it. Added `timeout-minutes: 30` so a hang fails fast.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 17:37:15 +00:00
bc09593550 Merge pull request 'ci(release): conventional-commit auto-release engine for the APK' (#12) from ci/android-release-engine into main
Some checks failed
Release APK / release (push) Has been cancelled
Reviewed-on: #12
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 09:35:19 +00:00
9514172b71 ci(release): auto-release engine (conventional commits) for the APK
Replace the tag-triggered release.yml with link/'s language-agnostic release
engine, adapted for Android. On every push to main it derives the next version
from conventional-commit subjects since the last v* tag (feat!/BREAKING -> major,
feat -> minor, fix|perf -> patch; nothing releasable -> no release), generates a
grouped changelog, bumps versionName in build.gradle.kts (versionCode derived
major*10000+minor*100+patch, monotonic), builds the SIGNED release APK, then
commits the bump [skip ci], tags vX.Y.Z, and creates the Gitea release with the
notes + APK + SHA256SUMS.

Uses REGISTRY_USER/REGISTRY_TOKEN (write:repository) to push the bump + create
the release, matching link/. main must allow that account to push (bump lands on
main; the [skip ci] + head-commit guard prevent a re-trigger loop). Signing
secrets (ANDROID_KEYSTORE_BASE64/_PASSWORD, ANDROID_KEY_ALIAS/_PASSWORD) unchanged.
Same self-hosted-runner handling as pr-checks.yml (apt JDK 17, sdkmanager, chmod).

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 04:31:05 -05:00
de79bf547c Merge pull request 'feat(release): m6 release mechanics — signed APK, R8, version guard, icons' (#11) from feat/m6-release into main
Reviewed-on: #11
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 09:17:23 +00:00
0df862a6af feat(release): m6 release mechanics — signed APK, R8, version guard, icons
All checks were successful
PR Checks / android-build (pull_request) Successful in 9m52s
Release-hardening pass (PLAN.md §9 M6, §10, §12). No architecture, data-flow,
or endpoint changes; the app remains a pure API client.

App icons (default brand assets):
- New gateway-medallion launcher icon set (all densities, adaptive fg/bg, round,
  Play Store icon) + an RG notification icon staged for M7 push.
- Replace the Image Asset wizard's default green-grid adaptive background with the
  deep-indigo brand fill (@color/ic_launcher_background #1B1033); recomposite the
  legacy square/round webps and the 512 Play icon over indigo so the whole set is
  coherent (the green never shipped). Restore the SPDX headers the wizard stripped;
  drop the orphaned placeholder foreground vector. No <monochrome> layer — the
  full-colour medallion has no clean silhouette, so themed mode falls back to the
  standard icon rather than a tinted blob.

Version-mismatch guard (§3):
- The connect probe now refuses a Runic Gateway backend whose API version this
  build can't speak (e.g. a future v2) with a clear "app out of date" message,
  instead of mis-rendering; lenient on a blank api (older backend). Decision logic
  extracted to a pure ConnectionRepository.evaluateVersion() with unit tests.

Release build hardening (§7, §12):
- Enable R8 full-mode minify + resource shrink for release (~31 MB debug -> 4.2 MB
  signed release). ProGuard keep-rules for kotlinx.serialization serializers + our
  wire DTOs, Retrofit service interfaces, and a -dontwarn for Tink's compile-only
  Error Prone annotations (EncryptedSharedPreferences).
- Release signingConfig reads keystore material from a gitignored keystore.properties
  or env vars; absent -> unsigned (debug + PR gate unaffected). Keystore never in repo.
- versionName/versionCode overridable via -P so the release tag + CI run number
  drive them (§10).

CI:
- release.yml: on a `v*` tag, build a SIGNED release APK (keystore from a base64
  Gitea secret) and attach it + SHA256SUMS to a Gitea release; workflow_dispatch is
  a signing dry run. Mirrors pr-checks.yml's self-hosted-runner handling (apt JDK 17,
  explicit sdkmanager, in-step chmod +x gradlew).

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-20 03:35:06 -05:00
e497e6c8a7 Merge pull request 'feat(ui): m5 shard-website design pass' (#10) from feat/m5-design-pass into main
Reviewed-on: #10
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 07:48:30 +00:00
52e06da8fc feat(ui): m5 shard-website design pass
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m6s
Restyle every Android screen with the shard-website theme from the
"Runic Gateway Screens" design (docs/android/PLAN.md §M5): deep blue-black
surfaces, a slate-blue accent, parchment serif body copy, and an engraved
Cinzel serif display face. The app is now dark-only, matching the design.

Theme layer (propagates to all token-based screens):
- Color.kt: replace the placeholder purple palette with named shard tokens.
- Theme.kt: one dark color scheme mapped onto the palette + 8/12/16dp shapes;
  drop the light branch; keep optional per-shard brand-accent seeding.
- Type.kt: full type scale — Cinzel display/headline/title, serif body,
  letter-spaced sans labels/buttons.
- Font.kt + res/font/cinzel_variable.ttf (SIL OFL, app/licenses/Cinzel-OFL.txt):
  the Cinzel display family, pinned to 500/600/700 via FontVariation.

Shared components (ui/components/ThemeComponents.kt): StatusPill (semantic
tones), OnlineDot, SectionLabel, FeatureCard (gradient), StatBar — adopted
across Home, Account, Shard hub, Champs, Characters, Houses, and the
character sheet (vitals/skills meters).

Shell: dark top-bar + drawer styling; dark launch theme and light system-bar
icons so the first frame matches (no white flash).

Build (assembleDebug) and unit tests green.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
2026-07-20 01:51:51 -05:00
2e1bea4220 Merge pull request 'feat(m4): player self-service & game data' (#9) from feat/m4-player-self-service into main
Reviewed-on: #9
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 03:45:13 +00:00
d4f7fcb241 feat(m4): player self-service & game data
All checks were successful
PR Checks / android-build (pull_request) Successful in 10m18s
Account self-service over the role-agnostic /auth/me/account* surface
(change username/password, TOTP enroll/disable, linked SSO identities),
game-account linking ([link one-time code + hybrid signup gated on the
public gameAccountSignup flag), and text-only own game data: per-account
character roster -> character sheet (attributes/vitals/resistances/skills/
equipment + guild/governor standing), player vendors + recent sales, and
own houses (decay/IDOC).

Adds three PLAYER-access menu groups (My Characters/Vendors/Houses)
revealed only when the session role is player, with a PlayerGate that
sends a signed-out or server-side-demoted user home. Each per-account
read carries its own load state, so a down shard (503) degrades that
account to offline/retry without blocking the rest (7).

Pure consumer of the existing bearer API -- no backend/protocol change.
17 new JVM unit tests cover the account + player-shard DTO decode (hex
serials, permissive objects, equipment mods) and the character-sheet
title/skill display helpers.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
2026-07-19 22:33:29 -05:00
ca704caaaf Merge pull request 'feat(m3): native auth — login+TOTP, token storage, refresh, access-level menu' (#8) from feat/m3-auth into main
Reviewed-on: #8
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-20 00:19:48 +00:00
1c56eda64b feat(m3): native auth — login+TOTP, token storage, refresh, access-level menu
All checks were successful
PR Checks / android-build (pull_request) Successful in 9m41s
Implements M3 (docs/android/PLAN.md §4): the functional Kotlin auth pass.

- Native username/password (+ single-request TOTP) login over the existing
  POST /auth/mobile/login; a 401 { totpRequired } reveals the code field, 429
  surfaces a backoff message (§4.1).
- Token pair in EncryptedSharedPreferences (TokenStore behind SessionManager,
  the single source of truth for the in-memory bearer + observable Session);
  base URL stays in plain DataStore (§4.3).
- OkHttp AuthInterceptor (bearer) + TokenAuthenticator: one-shot, mutex-
  serialized refresh-on-401 that replays the request, on its own bare client so
  it can never recurse; single-use rotation; dead refresh signs out, transient
  network keeps the session.
- Logout (POST /auth/mobile/logout, this session or all devices) tears down
  locally even on failure.
- GET /auth/me re-validates the role on every resume; a surviving 401 signs out
  (role stays advisory — backend is authority).
- Declarative access-level menu (visibleEntries: public/signed-in/player) with a
  Sign in / Sign out toggle + a My Account screen.
- Custom-Tab hand-offs (androidx.browser) to the website for register / forgot-
  password / SSO — no native screens (§4.2).
- Settings → Server switch now also clears the stored session (§3).

Biometric app-lock is deferred to M6 (tokens already encrypted at rest; it is
opt-in UX, not a v1 requirement — decided at M3).

JVM unit tests (18): auth-DTO decode (incl. totpRequired vs a plain credential
401), the SessionManager lifecycle over a fake store, and the menu access filter
+ role mapping. No backend/API change — a pure consumer of the existing mobile
bearer + /auth/me surface.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NgyHnrNa8WwG3doxvxjuCr
2026-07-19 19:08:00 -05:00
199df6cd64 Merge pull request 'feat(m2): public shard widgets + live SSE stream' (#7) from feat/m2-public-shard into main
Reviewed-on: #7
Reviewed-by: Colby Whitlock <whitlocktech@gmail.com>
2026-07-19 23:44:37 +00:00
c8f4e76370 feat(m2): public shard widgets + live SSE stream
All checks were successful
PR Checks / android-build (pull_request) Successful in 9m4s
Implements M2 of docs/android/PLAN.md §6.2 (functional pass): the public
shard surface over /api/v1/public/shard/*, plus the live SSE feed with
reconnect/backoff and graceful degradation (§7).

- Shard DTOs (status/economy/feed/online/presence/champs/guilds/governors/
  houses) mirroring public/shard.controller.js; ignoreUnknownKeys keeps
  additive backend fields safe, and the live *.update frames decode into the
  same board DTOs.
- PublicApi: the /public/shard/* GETs (status, feed, economy, online,
  presence, champs, guilds, governors + history, houses).
- ShardStreamClient: OkHttp SSE over /public/shard/stream. Unlike the browser
  EventSource it reconnects itself — a cold Flow<ShardStreamEvent> with
  growing backoff (reset on open), no read timeout for the idle keepalive,
  and clean teardown on cancel so a dropped feed degrades to "offline".
- ShardRepository: typed ApiResult snapshot reads + the shared live feed and
  frame decoders.
- Screens: a Shard hub (status/online count/economy/presence/staff + live
  activity feed with a live indicator) linking to live boards for champion
  spawns, guilds, governors (+ on-demand term history) and falling houses
  (IDOC). Boards seed from a snapshot then merge SSE deltas in place via a
  reusable LiveBoard, mirroring the website's merge semantics. Wired into the
  shared navigation drawer (§5); all strings externalized (§2).
- Tests (28): DTO/frame decode, LiveBoard merge, event-text formatting, and
  SSE frame parsing.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-19 18:34:14 -05:00
139 changed files with 9808 additions and 134 deletions

View File

@@ -0,0 +1,194 @@
# Automated release for the Runic Gateway Android app.
#
# Trigger: pushing a version tag `v*` (e.g. `v0.1.0`). Tag-driven on purpose — the
# build never has to push to protected `main`; the tag *is* the release input.
#
# To cut a release:
# git tag v0.1.0 && git push origin v0.1.0
# (or create the tag from the Gitea UI). Re-build/re-release an existing tag via
# the workflow_dispatch input below.
#
# versionName = the tag without its leading `v`; versionCode = major*10000 +
# minor*100 + patch (deterministic + monotonic, PLAN.md §10). Both are injected
# into app/build.gradle.kts for the build only — nothing is committed back to main.
#
# Prerequisites (Settings -> Actions -> Secrets on RunicGateway/Android-app):
# REGISTRY_TOKEN — Gitea access token with `write:repository` (create the release)
# ANDROID_KEYSTORE_BASE64 — base64 of the release .jks (single line)
# ANDROID_KEYSTORE_PASSWORD — keystore password
# ANDROID_KEY_ALIAS — key alias (e.g. runicgateway)
# ANDROID_KEY_PASSWORD — key password (== store password for a PKCS12 keystore)
#
# Runner handling matches pr-checks.yml (self-hosted `ubuntu-latest`): the container
# lacks git/curl/unzip and can't reach api.adoptium.net, so we apt-install the base
# tools + JDK 17 (not actions/setup-java), install the exact SDK packages, and
# `chmod +x ./gradlew` in-step (checkout drops the exec bit).
name: Release APK
on:
push:
tags:
- 'v*'
workflow_dispatch:
inputs:
tag:
description: 'Existing v* tag to (re)build and release'
required: true
concurrency:
group: release-apk-${{ github.event.inputs.tag || github.ref_name }}
cancel-in-progress: false
env:
GITEA_HOST: gitea.whitlocktech.com
REPO: RunicGateway/Android-app
GRADLE_MODULE: app
jobs:
release:
runs-on: ubuntu-latest
# Fail fast on a genuinely wedged run (e.g. a stalled SDK/network download on
# the self-hosted runner) instead of hanging forever and — because concurrency
# is `cancel-in-progress: false` — blocking every later release behind it.
timeout-minutes: 30
steps:
- name: Install base tools + JDK 17
run: |
apt-get update
apt-get install -y git curl unzip jq openjdk-17-jdk-headless
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64" >> "$GITHUB_ENV"
- name: Check out the release tag (full history for the changelog)
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.tag || github.ref_name }}
fetch-depth: 0
# ── Derive version + changelog straight from the tag ─────────────────
- name: Plan the release (version + changelog from the tag)
id: plan
run: |
set -euo pipefail
mkdir -p dist
git fetch --tags --force >/dev/null 2>&1 || true
TAG="${{ github.event.inputs.tag || github.ref_name }}"
case "$TAG" in
v[0-9]*) : ;;
*) echo "::error::expected a v* version tag, got '$TAG'"; exit 1 ;;
esac
VERSION="${TAG#v}"
# versionCode: deterministic + monotonic from the semver (PLAN.md §10).
IFS=. read -r MA MI PA <<< "$VERSION"
: "${MA:=0}"; : "${MI:=0}"; : "${PA:=0}"
VERSION_CODE=$(( MA*10000 + MI*100 + PA ))
# Changelog: conventional-commit subjects since the previous v* tag.
PREV_TAG="$(git describe --tags --match 'v*' --abbrev=0 "${TAG}^" 2>/dev/null || true)"
if [ -n "$PREV_TAG" ]; then RANGE="${PREV_TAG}..${TAG}"; else RANGE="${TAG}"; fi
SUBJECTS="$(git log --no-merges --format='%s' $RANGE || true)"
{
echo "## Runic Gateway Android ${TAG}"
echo
FEATS="$(echo "$SUBJECTS" | grep -E '^feat' || true)"
FIXES="$(echo "$SUBJECTS" | grep -E '^(fix|perf)' || true)"
[ -n "$FEATS" ] && { echo "### Features"; echo "$FEATS" | sed 's/^/- /'; echo; }
[ -n "$FIXES" ] && { echo "### Fixes"; echo "$FIXES" | sed 's/^/- /'; echo; }
echo "### All changes"
if [ -n "$PREV_TAG" ]; then echo "Since ${PREV_TAG}:"; fi
echo "$SUBJECTS" | sed 's/^/- /'
echo
echo "---"
echo "Signed APK — sideload on Android 10+ (§10). The app self-configures its shard site on first run."
} > dist/CHANGELOG.md
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
echo "versionCode=${VERSION_CODE}" >> "$GITHUB_OUTPUT"
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
echo "==> tag=${TAG} version=${VERSION} code=${VERSION_CODE} prev_tag=${PREV_TAG:-<none>}"
# ── SDK + signing keystore ───────────────────────────────────────────
- name: Set up Android SDK
uses: android-actions/setup-android@v3
with:
# Only put cmdline-tools on PATH. The action's default package set drags in
# the whole emulator + the legacy `tools` package (hundreds of MB, network-
# bound on this runner) that a headless APK build never uses. The next step
# installs exactly the packages we need.
packages: ''
- name: Install Android SDK packages
run: |
set +o pipefail
yes | sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
- name: Decode signing keystore
env:
ANDROID_KEYSTORE_BASE64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
run: |
set -euo pipefail
if [ -z "${ANDROID_KEYSTORE_BASE64:-}" ]; then
echo "::error::ANDROID_KEYSTORE_BASE64 secret is not set — cannot build a signed release."
exit 1
fi
printf '%s' "$ANDROID_KEYSTORE_BASE64" | base64 -d > "${RUNNER_TEMP}/release.jks"
echo "ANDROID_KEYSTORE_FILE=${RUNNER_TEMP}/release.jks" >> "$GITHUB_ENV"
# ── Set the version, build the signed APK ────────────────────────────
- name: Set the app version to match the tag
run: |
set -euo pipefail
VERSION="${{ steps.plan.outputs.version }}"
VERSION_CODE="${{ steps.plan.outputs.versionCode }}"
# Replace only the version defaults (the `?: "x.y.z"` / `?: N` fallbacks).
sed -i -E "s/(\?: )\"[0-9]+\.[0-9]+\.[0-9]+\"/\1\"${VERSION}\"/" "${GRADLE_MODULE}/build.gradle.kts"
sed -i -E "s/(toIntOrNull\(\) \?: )[0-9]+/\1${VERSION_CODE}/" "${GRADLE_MODULE}/build.gradle.kts"
grep -nE "versionCode = |versionName = " "${GRADLE_MODULE}/build.gradle.kts"
- name: Unit tests + signed release APK
env:
ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_KEY_PASSWORD }}
run: |
set -euo pipefail
chmod +x ./gradlew
./gradlew --no-daemon :${GRADLE_MODULE}:testDebugUnitTest :${GRADLE_MODULE}:assembleRelease
- name: Package APK + SHA256SUMS
run: |
set -euo pipefail
SRC="${GRADLE_MODULE}/build/outputs/apk/release/app-release.apk"
test -f "$SRC" || { echo "::error::release APK not found at $SRC"; exit 1; }
cp "$SRC" "dist/runic-gateway-${{ steps.plan.outputs.version }}.apk"
( cd dist && sha256sum "runic-gateway-${{ steps.plan.outputs.version }}.apk" > SHA256SUMS )
ls -l dist && cat dist/SHA256SUMS
# ── Create the Gitea release + upload assets (no push to main) ───────
- name: Create Gitea release and upload assets
env:
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
run: |
set -euo pipefail
TAG="${{ steps.plan.outputs.tag }}"
API="https://${GITEA_HOST}/api/v1/repos/${REPO}"
BODY="$(cat dist/CHANGELOG.md)"
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
REL_ID="$(curl -sSf -X POST "${API}/releases" \
-H "Authorization: token ${CI_TOKEN}" \
-H "Content-Type: application/json" \
-d "$(jq -n --arg tag "$TAG" --arg body "$BODY" \
'{tag_name:$tag, name:$tag, body:$body, draft:false, prerelease:false}')" \
| jq -r '.id')"
echo "Created release ${TAG} (id=${REL_ID})"
for f in "runic-gateway-${{ steps.plan.outputs.version }}.apk" SHA256SUMS; do
curl -sSf -X POST "${API}/releases/${REL_ID}/assets?name=${f}" \
-H "Authorization: token ${CI_TOKEN}" \
-F "attachment=@dist/${f}" >/dev/null
echo " uploaded ${f}"
done

View File

@@ -0,0 +1,54 @@
# Run SonarQube static analysis against the code that just landed on `main` and
# report the results to the self-hosted SonarQube server for review. This is
# intentionally NON-BLOCKING: it triggers on push to main (i.e. AFTER merge),
# not on pull_request, so it never gates a PR. It complements pr-checks.yml
# (which gates PRs) and release.yml (which ships the APK) — this one only feeds
# the dashboard.
#
# Prerequisites (one-time, in the Gitea UI — Repo → Settings → Actions):
# • Secret SONAR_TOKEN — a SonarQube "Analysis" token generated at
# My Account → Security in SonarQube for the
# runic-gateway-android-app project (or a global one).
# • Variable SONAR_HOST_URL — the SonarQube base URL on your LAN, e.g.
# http://192.168.0.56:9000
# (kept as a variable, not committed, so the internal address stays out of git.)
#
# The runner (self-hosted `ubuntu-latest`, same as the other workflows) must be
# able to reach SONAR_HOST_URL on your network. Nothing here waits on the
# SonarQube Quality Gate, so a failing gate does not fail this job — check the
# dashboard when you want to.
#
# Scope: this analyses the Kotlin source directly (the Sonar scanner reads
# sonar-project.properties). It does NOT run a Gradle build, so no Android SDK /
# JDK install is needed — the Kotlin analyzer is source-based. See the "Optional
# enrichment" note in sonar-project.properties for wiring in Android Lint /
# coverage reports later.
name: SonarQube
on:
push:
branches: [main]
# Allow re-running the analysis on demand from the Actions tab.
workflow_dispatch: {}
concurrency:
group: sonarqube-${{ github.ref }}
cancel-in-progress: true
jobs:
analysis:
runs-on: ubuntu-latest
steps:
- name: Check out (full history for accurate new-code + blame)
uses: actions/checkout@v4
with:
# SonarQube uses git history to attribute issues to authors and to
# compute "new code". A shallow clone degrades both.
fetch-depth: 0
- name: Run SonarQube scan
uses: sonarsource/sonarqube-scan-action@v4
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}

View File

@@ -1,5 +1,8 @@
// SPDX-License-Identifier: GPL-3.0-or-later
import java.io.FileInputStream
import java.util.Properties
plugins {
alias(libs.plugins.android.application)
alias(libs.plugins.kotlin.android)
@@ -9,6 +12,25 @@ plugins {
alias(libs.plugins.hilt)
}
// Release signing material (PLAN.md §12) is never committed. It is read from, in
// order of precedence: a local gitignored `keystore.properties` at the repo root,
// then environment variables (how CI injects the decoded keystore + secrets). When
// none is present, the release build is simply left unsigned — `assembleDebug` and
// the PR gate are unaffected, so contributors without the keystore can still build.
val keystorePropsFile = rootProject.file("keystore.properties")
val keystoreProps = Properties().apply {
if (keystorePropsFile.exists()) FileInputStream(keystorePropsFile).use { load(it) }
}
fun signingValue(propKey: String, envKey: String): String? =
keystoreProps.getProperty(propKey) ?: System.getenv(envKey)
val ksStoreFilePath = signingValue("storeFile", "ANDROID_KEYSTORE_FILE")
val ksStorePassword = signingValue("storePassword", "ANDROID_KEYSTORE_PASSWORD")
val ksKeyAlias = signingValue("keyAlias", "ANDROID_KEY_ALIAS")
val ksKeyPassword = signingValue("keyPassword", "ANDROID_KEY_PASSWORD")
val hasReleaseSigning = ksStoreFilePath != null && ksStorePassword != null &&
ksKeyAlias != null && ksKeyPassword != null
android {
namespace = "com.runicgateway.app"
compileSdk = 35
@@ -18,20 +40,59 @@ android {
applicationId = "com.runicgateway.app"
minSdk = 29
targetSdk = 35
versionCode = 1
versionName = "0.1.0"
// These committed defaults are the version source of truth (PLAN.md §10).
// release.yml's conventional-commit engine bumps versionName here and commits
// it on release; versionCode is derived from it (major*10000+minor*100+patch)
// so it stays monotonic. Both remain overridable via -P for local/manual builds.
versionCode = (project.findProperty("versionCode") as String?)?.toIntOrNull() ?: 1
versionName = (project.findProperty("versionName") as String?)?.takeIf { it.isNotBlank() } ?: "0.1.0"
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
// Android App Links host (docs/android/APP_LINKS.md). autoVerify needs a
// *literal* host at build time, so a single multi-tenant APK cannot verify
// open-ended shard domains: App Links are a build-time opt-in. Left empty for
// the generic build (custom scheme only); a white-label/first-party build
// bakes one host with `-PappLinkHost=play.myshard.com`.
// • BuildConfig.APP_LINK_HOST — SsoAuthManager reads it to pick the redirect.
// • manifestPlaceholder appLinkHost — substituted into the intent-filter host;
// empty falls back to the reserved `.invalid` sentinel so the autoVerify
// filter is inert (matches no real link, never verifies).
val appLinkHost = (project.findProperty("appLinkHost") as String?)?.trim().orEmpty()
buildConfigField("String", "APP_LINK_HOST", "\"$appLinkHost\"")
manifestPlaceholders["appLinkHost"] = appLinkHost.ifBlank { "runic-gateway.invalid" }
}
signingConfigs {
if (hasReleaseSigning) {
create("release") {
storeFile = file(ksStoreFilePath!!)
storePassword = ksStorePassword
keyAlias = ksKeyAlias
keyPassword = ksKeyPassword
// Sign with both v1 (JAR) and v2 (APK) schemes for broad compatibility.
enableV1Signing = true
enableV2Signing = true
}
}
}
buildTypes {
release {
// Signing/minification are wired at M6 (release hardening). Debug is auto-signed.
isMinifyEnabled = false
// R8 full-mode minify + resource shrink (§7: no offline cache, so a lean
// release APK). Keep rules live in proguard-rules.pro.
isMinifyEnabled = true
isShrinkResources = true
proguardFiles(
getDefaultProguardFile("proguard-android-optimize.txt"),
"proguard-rules.pro",
)
// Signed only when the keystore material is present (local or CI); an
// unsigned APK is produced otherwise. The direct-APK release (§10) runs
// through release.yml, which supplies the keystore from a Gitea secret.
if (hasReleaseSigning) {
signingConfig = signingConfigs.getByName("release")
}
}
}
@@ -93,6 +154,9 @@ dependencies {
implementation(libs.androidx.datastore.preferences)
implementation(libs.androidx.security.crypto)
// Web hand-off (Chrome Custom Tabs) for register / invite / reset / SSO (§4.2)
implementation(libs.androidx.browser)
// Images
implementation(libs.coil.compose)

View File

@@ -0,0 +1,93 @@
Copyright 2020 The Cinzel Project Authors (https://github.com/NDISCOVER/Cinzel)
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.

View File

@@ -1,3 +1,59 @@
# Runic Gateway Android app ProGuard/R8 rules.
# Minification is disabled until M6 (release hardening); real keep rules for
# kotlinx.serialization DTOs and Retrofit models are added there.
# Runic Gateway Android app ProGuard/R8 rules (release minify + resource shrink, M6).
#
# The dependency stack ships its own consumer rules that R8 applies automatically:
# Retrofit 2.11, OkHttp 4.12, kotlinx.serialization 1.7 (core), Hilt/Dagger, Coil 2.7.
# The rules below are defensive belt-and-suspenders for the areas full-mode R8 is
# most likely to over-strip in this app: the kotlinx.serialization generated
# serializers and our own @Serializable wire DTOs.
# ── kotlinx.serialization (canonical keep rules) ────────────────────────────
-keepattributes *Annotation*, InnerClasses
-dontnote kotlinx.serialization.**
# Keep the Companion of @Serializable classes so `.serializer()` resolves.
-if @kotlinx.serialization.Serializable class **
-keepclassmembers class <1> {
static <1>$Companion Companion;
}
-if @kotlinx.serialization.Serializable class ** {
static **$Companion Companion;
}
-keepclassmembers class <2>$Companion {
kotlinx.serialization.KSerializer serializer(...);
}
# Keep `INSTANCE.serializer()` of @Serializable objects.
-if @kotlinx.serialization.Serializable class ** {
public static ** INSTANCE;
}
-keepclassmembers class <1> {
public static <1> INSTANCE;
kotlinx.serialization.KSerializer serializer(...);
}
# Keep the synthesized $$serializer classes and their descriptor field.
-keepclassmembers class **$$serializer {
*** descriptor;
}
# ── Our wire DTOs ───────────────────────────────────────────────────────────
# All request/response models decoded by kotlinx.serialization. Keeping them
# (and their generated serializers) guarantees additive backend fields and
# @SerialName mappings survive minification. DTOs are small, so keeping them
# whole is cheap insurance against a full-mode strip.
-keep @kotlinx.serialization.Serializable class com.runicgateway.app.** { *; }
-keepclassmembers class com.runicgateway.app.data.api.dto.** { *; }
# ── Retrofit service interfaces ─────────────────────────────────────────────
# Retrofit reads method + parameter annotations reflectively; keep our API
# interfaces' generic signatures so return types (suspend .../Call<T>) resolve.
-keep,allowobfuscation interface com.runicgateway.app.data.api.*Api
-keepattributes Signature, Exceptions
# Kotlin metadata is needed for reflection over Kotlin types (serialization/Retrofit).
-keep class kotlin.Metadata { *; }
# ── Tink / EncryptedSharedPreferences (androidx.security-crypto) ─────────────
# Tink references Error Prone compile-only annotations that are absent at runtime;
# they are safe to ignore (they carry no runtime behaviour). Suppresses the R8
# "Missing class com.google.errorprone.annotations.*" errors.
-dontwarn com.google.errorprone.annotations.**

View File

@@ -6,6 +6,13 @@
<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"
@@ -17,15 +24,56 @@
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>

Binary file not shown.

After

Width:  |  Height:  |  Size: 160 KiB

View File

@@ -3,16 +3,25 @@
*/
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
@@ -24,6 +33,8 @@ 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
@@ -33,9 +44,27 @@ import dagger.hilt.android.AndroidEntryPoint
*/
@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)
enableEdgeToEdge()
pendingStream = intent?.getStringExtra(PushNotifier.EXTRA_STREAM)
handleSsoCallback(intent)
// Dark-only app (M5): force light system-bar icons over the transparent bars so
// they stay legible on the deep blue-black surfaces regardless of system theme.
val barStyle = SystemBarStyle.dark(Color.TRANSPARENT)
enableEdgeToEdge(statusBarStyle = barStyle, navigationBarStyle = barStyle)
setContent {
val appViewModel: AppViewModel = hiltViewModel()
val state by appViewModel.state.collectAsStateWithLifecycle()
@@ -53,11 +82,47 @@ class MainActivity : ComponentActivity() {
AppState.NeedsConnection ->
ConnectScreen(onConnected = appViewModel::onConnected)
is AppState.Ready ->
RunicApp(brand = s.brand, onChangeServer = appViewModel::changeServer)
RunicApp(
brand = s.brand,
onChangeServer = appViewModel::changeServer,
deepLinkStream = pendingStream,
onDeepLinkConsumed = { pendingStream = null },
)
}
}
}
}
}
}
/**
* A notification tap or an SSO callback arriving while the activity is already
* running (singleTop) — the common case, since the Custom Tab overlays the live
* app during sign-in.
*/
override fun onNewIntent(intent: Intent) {
super.onNewIntent(intent)
setIntent(intent)
intent.getStringExtra(PushNotifier.EXTRA_STREAM)?.let { pendingStream = it }
handleSsoCallback(intent)
}
/**
* Route an SSO callback VIEW intent into the bridge (M9, §4.2): either the
* custom-scheme `runicgateway://auth/callback` (always) or the verified https
* App Link `https://<paired-host>/mobile/callback` (opt-in hardening —
* docs/android/APP_LINKS.md). Both feed the *same* exchange; the result surfaces
* on `SsoAuthManager.outcome` (success signs the session in; failure shows on the
* login screen). Non-callback intents are ignored.
*/
private fun handleSsoCallback(intent: Intent?) {
val data: Uri = intent?.takeIf { it.action == Intent.ACTION_VIEW }?.data ?: return
val isCallback = ssoAuthManager.matchesCallback(data.scheme, data.host, data.path) ||
ssoAuthManager.matchesAppLinkCallback(data.scheme, data.host, data.path)
if (!isCallback) return
val state = data.getQueryParameter("state")
val code = data.getQueryParameter("code")
val error = data.getQueryParameter("error")
lifecycleScope.launch { ssoAuthManager.complete(state = state, code = code, error = error) }
}
}

View File

@@ -0,0 +1,73 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth
import android.content.Context
import android.content.SharedPreferences
import androidx.security.crypto.EncryptedSharedPreferences
import androidx.security.crypto.MasterKey
import dagger.hilt.android.qualifiers.ApplicationContext
import javax.inject.Inject
import javax.inject.Singleton
/**
* [TokenStore] backed by Jetpack Security's [EncryptedSharedPreferences]
* (Tink/AES-256-GCM), so the token pair is encrypted at rest (PLAN.md §2, §4.3).
* The base URL stays in plain DataStore ([com.runicgateway.app.core.prefs.ServerPreferences]);
* only tokens live here.
*
* The prefs handle is created lazily so a first-launch device (no session yet)
* pays the keystore cost only once a user actually signs in.
*/
@Singleton
class EncryptedTokenStore @Inject constructor(
@param:ApplicationContext private val context: Context,
) : TokenStore {
private val prefs: SharedPreferences by lazy {
val masterKey = MasterKey.Builder(context)
.setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
.build()
EncryptedSharedPreferences.create(
context,
PREFS_NAME,
masterKey,
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM,
)
}
override fun load(): StoredSession? {
val access = prefs.getString(KEY_ACCESS, null) ?: return null
val refresh = prefs.getString(KEY_REFRESH, null) ?: return null
val username = prefs.getString(KEY_USERNAME, null) ?: return null
val role = prefs.getString(KEY_ROLE, null) ?: return null
val id = prefs.getLong(KEY_USER_ID, -1L)
if (id < 0) return null
return StoredSession(access, refresh, id, username, role)
}
override fun save(session: StoredSession) {
prefs.edit()
.putString(KEY_ACCESS, session.accessToken)
.putString(KEY_REFRESH, session.refreshToken)
.putLong(KEY_USER_ID, session.userId)
.putString(KEY_USERNAME, session.username)
.putString(KEY_ROLE, session.role)
.apply()
}
override fun clear() {
prefs.edit().clear().apply()
}
private companion object {
const val PREFS_NAME = "runic_session"
const val KEY_ACCESS = "access_token"
const val KEY_REFRESH = "refresh_token"
const val KEY_USER_ID = "user_id"
const val KEY_USERNAME = "username"
const val KEY_ROLE = "role"
}
}

View File

@@ -0,0 +1,60 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth
import com.runicgateway.app.data.api.dto.SafeUserDto
/**
* The signed-in identity the app carries (PLAN.md §4.3, §5). Role is *advisory*
* for menu rendering only — the backend re-checks every gated call, so the app
* treats a 403 as authoritative and never assumes access from this value.
*/
data class SessionUser(
val id: Long,
val username: String,
val role: Role,
) {
val isPlayer: Boolean get() = role == Role.PLAYER
}
/**
* The account roles the backend issues. The three staff roles are gated by
* capability, not rank (PLAN.md §5); [UNKNOWN] absorbs any future role so an
* additive backend change never crashes the menu.
*/
enum class Role(val wire: String) {
PLAYER("player"),
MODERATOR("moderator"),
EDITOR("editor"),
ADMIN("admin"),
UNKNOWN("");
val isStaff: Boolean get() = this == MODERATOR || this == EDITOR || this == ADMIN
companion object {
fun fromWire(value: String?): Role =
entries.firstOrNull { it.wire.equals(value, ignoreCase = true) } ?: UNKNOWN
}
}
/** The two auth states the UI observes. */
sealed interface Session {
data object SignedOut : Session
data class SignedIn(val user: SessionUser) : Session
}
internal fun SafeUserDto.toSessionUser(): SessionUser =
SessionUser(id = id, username = username, role = Role.fromWire(role))
internal fun SafeUserDto.toStored(accessToken: String, refreshToken: String): StoredSession =
StoredSession(
accessToken = accessToken,
refreshToken = refreshToken,
userId = id,
username = username,
role = role,
)
internal fun StoredSession.toSessionUser(): SessionUser =
SessionUser(id = userId, username = username, role = Role.fromWire(role))

View File

@@ -0,0 +1,99 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth
import com.runicgateway.app.data.api.dto.SafeUserDto
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import java.util.concurrent.atomic.AtomicReference
import javax.inject.Inject
import javax.inject.Singleton
/**
* The single source of truth for the current session (PLAN.md §4.3). It holds the
* in-memory token pair the network layer reads on every call, mirrors the
* signed-in identity into an observable [state] the UI + menu react to, and keeps
* the encrypted [TokenStore] in sync.
*
* Threading: [state] and the token holders are read from the UI thread and
* written from both coroutines (login/logout) and the OkHttp
* [com.runicgateway.app.core.net.TokenAuthenticator] dispatcher thread (silent
* refresh), so tokens live in [AtomicReference]s and the mutators are
* `@Synchronized` to keep the token pair and [state] consistent with each other.
*/
@Singleton
class SessionManager @Inject constructor(
private val store: TokenStore,
) {
private val accessRef = AtomicReference<String?>(null)
private val refreshRef = AtomicReference<String?>(null)
private val _state: MutableStateFlow<Session>
val state: StateFlow<Session>
init {
val restored = store.load()
if (restored != null) {
accessRef.set(restored.accessToken)
refreshRef.set(restored.refreshToken)
_state = MutableStateFlow(Session.SignedIn(restored.toSessionUser()))
} else {
_state = MutableStateFlow(Session.SignedOut)
}
state = _state.asStateFlow()
}
/** The bearer for the current request, or null when signed out. */
fun currentAccessToken(): String? = accessRef.get()
/** The refresh token the authenticator rotates, or null when signed out. */
fun currentRefreshToken(): String? = refreshRef.get()
val isSignedIn: Boolean get() = _state.value is Session.SignedIn
/** Establish a session from a successful login (§4.1). */
@Synchronized
fun onSignedIn(accessToken: String, refreshToken: String, user: SafeUserDto) {
accessRef.set(accessToken)
refreshRef.set(refreshToken)
store.save(user.toStored(accessToken, refreshToken))
_state.value = Session.SignedIn(user.toSessionUser())
}
/**
* Store a rotated token pair after a silent refresh (§4.3). Keeps the current
* user; if somehow signed out already, it is a no-op (the refresh raced a
* logout and must not resurrect the session).
*/
@Synchronized
fun onRefreshed(accessToken: String, refreshToken: String, user: SafeUserDto) {
if (_state.value !is Session.SignedIn) return
accessRef.set(accessToken)
refreshRef.set(refreshToken)
store.save(user.toStored(accessToken, refreshToken))
// Refresh may carry an updated role — reflect it so the menu stays honest.
_state.value = Session.SignedIn(user.toSessionUser())
}
/** Refresh the cached identity from a `/auth/me` re-validation (§4.3). */
@Synchronized
fun onUserRefreshed(user: SafeUserDto) {
val current = _state.value
if (current !is Session.SignedIn) return
val access = accessRef.get() ?: return
val refresh = refreshRef.get() ?: return
store.save(user.toStored(access, refresh))
_state.value = Session.SignedIn(user.toSessionUser())
}
/** Tear the session down — user logout, dead refresh, or a server switch (§3). */
@Synchronized
fun onSignedOut() {
accessRef.set(null)
refreshRef.set(null)
store.clear()
_state.value = Session.SignedOut
}
}

View File

@@ -0,0 +1,31 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth
/**
* The at-rest home for a signed-in session (PLAN.md §4.3): the access + refresh
* tokens plus the cached safe-user. Tokens are sensitive, so the production
* implementation stores them in EncryptedSharedPreferences — never plain
* DataStore or logs. Kept behind an interface so [SessionManager] is unit-testable
* against an in-memory fake.
*/
interface TokenStore {
/** The persisted session restored on launch, or null when signed out. */
fun load(): StoredSession?
/** Persist (overwrite) the current session atomically. */
fun save(session: StoredSession)
/** Wipe every stored token — sign-out and the Settings → Server hard reset (§3). */
fun clear()
}
/** A persisted session: the token pair and the non-sensitive user it belongs to. */
data class StoredSession(
val accessToken: String,
val refreshToken: String,
val userId: Long,
val username: String,
val role: String,
)

View File

@@ -0,0 +1,50 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth.sso
import java.security.MessageDigest
import java.security.SecureRandom
import java.util.Base64
/**
* PKCE + CSRF-state primitives for the Mobile SSO Authorization Bridge — "Layer B"
* of the two PKCE layers (app ↔ website; PLAN.md §4.2, BACKEND_DESIGN "Two PKCE
* layers"). The app proves at `/exchange` that it holds the verifier for the
* challenge it registered at `/start`, so an intercepted callback code is useless
* to anyone but this app.
*
* Pure JVM (no Android framework types) so it unit-tests on the plain test runner.
* The encoding mirrors the backend exactly (RFC 7636 S256): the challenge is
* `base64url(SHA-256(verifier))` with no padding, matching Node's
* `crypto.createHash('sha256').update(verifier).digest('base64url')`.
*/
object Pkce {
private val random = SecureRandom()
// RFC 4648 §5 URL-safe base64 without padding — the base64url the backend uses.
private val encoder = Base64.getUrlEncoder().withoutPadding()
/**
* A fresh high-entropy `code_verifier`: 32 random bytes → 43 base64url chars,
* comfortably inside RFC 7636's 43128 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)
}
}

View File

@@ -0,0 +1,238 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.auth.sso
import com.runicgateway.app.BuildConfig
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.core.net.BaseUrlHolder
import com.runicgateway.app.data.api.SsoApi
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
import kotlinx.coroutines.CancellationException
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import java.io.IOException
import java.util.concurrent.atomic.AtomicReference
import javax.inject.Inject
import javax.inject.Singleton
/**
* Orchestrates the native "Sign in with Google/Discord" flow — the app half of the
* Mobile SSO Authorization Bridge (PLAN.md §4.2, BACKEND_DESIGN "Mobile SSO
* Authorization Bridge"). It never adds a parallel auth path: a successful exchange
* drives the *same* [SessionManager.onSignedIn] the password login uses, so the
* menu, push registration, and re-validation all react identically.
*
* The flow:
* 1. [buildStartUrl] mints PKCE (Layer B) + a CSRF `state`, stashes them, and
* returns the `/auth/mobile/sso/start` URL the caller opens in a Custom Tab.
* 2. The website bounces through the IdP and deep-links back to
* [REDIRECT_URI] with `?code&state` (success) or `?error&state` (failure).
* 3. [complete] verifies `state`, exchanges the `code` with the stashed verifier,
* and signs the user in — publishing the result on [outcome]. `MainActivity`
* parses the callback `Uri` (the Android edge) and hands the raw params here,
* so this class stays free of framework types and unit-tests on the JVM.
*
* The pending `{state, verifier}` lives only in memory: if the process is killed
* while the Custom Tab is foreground it is lost and the exchange **fails closed**
* (the user simply retries) — never a security downgrade.
*
* Threading: [buildStartUrl] runs on the UI thread; [complete] runs on the
* activity's coroutine scope after a deep link. The pending holder is an
* [AtomicReference] and [outcome] a [StateFlow], so a ViewModel/activity recreation
* while the Custom Tab is open cannot drop a result.
*/
@Singleton
class SsoAuthManager @Inject constructor(
private val ssoApi: SsoApi,
private val sessionManager: SessionManager,
private val baseUrlHolder: BaseUrlHolder,
) {
/** Why an SSO attempt ended, for a friendly inline message on the login screen. */
enum class Failure {
/** The user cancelled or the IdP/website refused (e.g. no linked account). */
DENIED,
/** The callback `state` didn't match — CSRF guard, or the pending flow was lost. */
STATE_MISMATCH,
/** The one-time code was unknown / expired / already used, or PKCE failed. */
EXPIRED_CODE,
/** Offline / DNS / TLS / timeout during the exchange. */
NETWORK,
/** Any other server failure, or a missing base URL / malformed callback. */
SERVER,
}
/** The observable result of the most recent flow; the login screen consumes it. */
sealed interface Outcome {
data object Idle : Outcome
data object Success : Outcome
data class Failed(val reason: Failure) : Outcome
}
private data class Pending(val state: String, val verifier: String)
private val pending = AtomicReference<Pending?>(null)
/**
* The host this build baked an App Link intent-filter for (`BuildConfig.APP_LINK_HOST`,
* empty on the generic multi-tenant build — see docs/android/APP_LINKS.md).
* `internal var` only so unit tests can exercise the App Link path without a build
* flavor; production never reassigns it.
*/
internal var appLinkHost: String = BuildConfig.APP_LINK_HOST
private val _outcome = MutableStateFlow<Outcome>(Outcome.Idle)
val outcome: StateFlow<Outcome> = _outcome.asStateFlow()
/** Ack a delivered [outcome] so it isn't re-handled after a recomposition. */
fun consumeOutcome() {
_outcome.value = Outcome.Idle
}
/**
* Build the `/auth/mobile/sso/start` URL for [providerId] and stash the pending
* PKCE verifier + CSRF state. Returns null when no shard site is configured yet
* (the caller then keeps the website hand-off fallback). Also resets [outcome]
* to [Outcome.Idle] so a stale prior result can't fire against the new attempt.
*/
fun buildStartUrl(providerId: String): String? {
val base = baseUrlHolder.current ?: return null
val verifier = Pkce.newVerifier()
val challenge = Pkce.challengeOf(verifier)
val state = Pkce.newState()
pending.set(Pending(state = state, verifier = verifier))
_outcome.value = Outcome.Idle
return base.newBuilder()
.addPathSegments("api/v1/auth/mobile/sso/start")
.addQueryParameter("provider", providerId)
.addQueryParameter("code_challenge", challenge)
.addQueryParameter("state", state)
.addQueryParameter("redirect_uri", redirectUriFor(base.host))
.build()
.toString()
}
/**
* The `redirect_uri` to request for a shard on [pairedHost]: the verified https
* App Link callback **iff** this build baked an App Link host that matches the
* paired host (a white-label/first-party build for exactly this shard — which is
* also responsible for enabling `mobile_app_links_enabled` server-side); otherwise
* the fixed custom-scheme callback, which every build/shard always supports.
*/
private fun redirectUriFor(pairedHost: String): String =
if (appLinkHost.isNotBlank() && appLinkHost.equals(pairedHost, ignoreCase = true)) {
"https://$pairedHost$APP_LINK_CALLBACK_PATH"
} else {
REDIRECT_URI
}
/** True if a deep link's scheme/host/path are our fixed custom-scheme SSO callback. */
fun matchesCallback(scheme: String?, host: String?, path: String?): Boolean =
scheme == CALLBACK_SCHEME && host == CALLBACK_HOST && path == CALLBACK_PATH
/**
* True if a deep link is a verified https App Link callback for the shard we are
* **currently paired to**. The `host == pairedHost` check is defense-in-depth:
* `autoVerify` already means only a real, opted-in shard domain can route here,
* but the app still refuses an https callback whose host isn't the paired shard.
* Returns false before a shard is configured (no paired host to trust).
*/
fun matchesAppLinkCallback(scheme: String?, host: String?, path: String?): Boolean {
val pairedHost = baseUrlHolder.current?.host ?: return false
return scheme == "https" && path == APP_LINK_CALLBACK_PATH &&
host != null && host.equals(pairedHost, ignoreCase = true)
}
/**
* Handle the parsed callback params from a returned [REDIRECT_URI] deep link:
* verify `state`, map an `error`, else exchange the `code` and sign in.
* Publishes the result on [outcome]. Idempotent-safe: the pending is cleared on
* entry, so a duplicate delivery of the same callback finds no pending and fails
* as [Failure.STATE_MISMATCH] rather than double-exchanging (the backend also
* single-uses the code).
*/
suspend fun complete(state: String?, code: String?, error: String?) {
val stashed = pending.getAndSet(null)
// CSRF: the callback must echo the exact state we generated at /start.
if (stashed == null || state.isNullOrEmpty() || state != stashed.state) {
_outcome.value = Outcome.Failed(Failure.STATE_MISMATCH)
return
}
// A website/IdP-side failure comes back as ?error=… (never with a code).
if (!error.isNullOrEmpty()) {
_outcome.value = Outcome.Failed(mapError(error))
return
}
if (code.isNullOrBlank()) {
_outcome.value = Outcome.Failed(Failure.SERVER)
return
}
val response = try {
ssoApi.exchange(MobileSsoExchangeRequest(code = code, codeVerifier = stashed.verifier))
} catch (e: CancellationException) {
throw e
} catch (_: IOException) {
_outcome.value = Outcome.Failed(Failure.NETWORK)
return
} catch (_: Exception) {
_outcome.value = Outcome.Failed(Failure.SERVER)
return
}
if (response.isSuccessful) {
val body = response.body()
if (body == null) {
_outcome.value = Outcome.Failed(Failure.SERVER)
return
}
sessionManager.onSignedIn(body.accessToken, body.refreshToken, body.user)
_outcome.value = Outcome.Success
return
}
_outcome.value = Outcome.Failed(if (response.code() == 401) Failure.EXPIRED_CODE else Failure.SERVER)
}
// The bridge's start + callback error codes → user-facing failure reasons.
// Start (mobileSso.controller): invalid_provider | provider_unavailable | server_error.
// Callback (sso.controller): not_linked | disabled | session_expired | error,
// plus a forwarded IdP access_denied.
private fun mapError(error: String): Failure = when (error) {
// Link-only policy refused, or the account is inactive, or the user declined.
"not_linked", "disabled", "access_denied" -> Failure.DENIED
// The bridge session aged out mid-flow — start over.
"session_expired" -> Failure.EXPIRED_CODE
// invalid_provider / provider_unavailable / server_error / error / anything else.
else -> Failure.SERVER
}
companion object {
const val CALLBACK_SCHEME = "runicgateway"
const val CALLBACK_HOST = "auth"
const val CALLBACK_PATH = "/callback"
/**
* The one fixed, application-owned callback the bridge redirects to. Must
* match the `MOBILE_AUTH_REDIRECT_URIS` allowlist entry on the backend and
* the intent-filter in `AndroidManifest.xml` exactly (PLAN.md §4.2).
*/
const val REDIRECT_URI = "$CALLBACK_SCHEME://$CALLBACK_HOST$CALLBACK_PATH"
/**
* Path of the verified https App Link callback (`https://<shard-host>/mobile/callback`).
* Must match the app's `autoVerify` intent-filter in `AndroidManifest.xml` and the
* backend's self-origin allowlist entry (docs/android/APP_LINKS.md §3.2/§4.2).
*/
const val APP_LINK_CALLBACK_PATH = "/mobile/callback"
}
}

View File

@@ -0,0 +1,39 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.net
import com.runicgateway.app.core.auth.SessionManager
import okhttp3.Interceptor
import okhttp3.Response
import javax.inject.Inject
import javax.inject.Singleton
/**
* Attaches the current bearer access token to outbound calls (PLAN.md §4.1).
* Public endpoints simply carry a token the backend ignores; the credential
* endpoints (login/refresh) tag themselves [Http.NO_SESSION_HEADER] and are left
* bare so a credential `401` is never mistaken for an expired session. A request
* that already set its own Authorization (the authenticator's retry) is untouched.
*/
@Singleton
class AuthInterceptor @Inject constructor(
private val sessionManager: SessionManager,
) : Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
val request = chain.request()
if (request.header(Http.NO_SESSION_HEADER) != null) {
return chain.proceed(request)
}
if (request.header(Http.AUTHORIZATION) != null) {
return chain.proceed(request)
}
val token = sessionManager.currentAccessToken()
?: return chain.proceed(request)
val authed = request.newBuilder()
.header(Http.AUTHORIZATION, Http.bearer(token))
.build()
return chain.proceed(authed)
}
}

View File

@@ -0,0 +1,19 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.net
/** Shared HTTP constants for the auth layer (PLAN.md §4). */
object Http {
/**
* Marks the credential endpoints (login, refresh) that must run *without* a
* bearer and must never trigger the refresh-on-401 [TokenAuthenticator].
* [AuthInterceptor] sees it and skips attaching a token; the authenticator
* sees it on the failed request and declines to refresh. It is a harmless
* unknown header to the backend.
*/
const val NO_SESSION_HEADER = "X-Runic-No-Session"
const val AUTHORIZATION = "Authorization"
fun bearer(token: String): String = "Bearer $token"
}

View File

@@ -0,0 +1,151 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.net
import kotlinx.coroutines.CompletableDeferred
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.channelFlow
import kotlinx.coroutines.isActive
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonNull
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response
import okhttp3.sse.EventSource
import okhttp3.sse.EventSourceListener
import okhttp3.sse.EventSources
import java.util.concurrent.TimeUnit
import java.util.concurrent.atomic.AtomicBoolean
import javax.inject.Inject
import javax.inject.Singleton
/**
* Consumes the public live-event SSE stream (`GET /public/shard/stream`, safe kinds
* only) and re-emits each frame as a [ShardStreamEvent] (PLAN.md §6.2, §7).
*
* Unlike the browser's `EventSource`, OkHttp's does **not** auto-reconnect, so the
* reconnect/backoff loop lives here: on any disconnect the connection is torn down
* and re-opened after a growing delay (reset once a connection opens), and while no
* shard site is configured yet the flow simply idles. The stream is exposed as a
* cold [Flow]; a `viewModelScope` collect opens it and cancellation closes it, so a
* dropped feed degrades to "offline" rather than crashing.
*/
@Singleton
class ShardStreamClient @Inject constructor(
baseClient: OkHttpClient,
private val baseUrlHolder: BaseUrlHolder,
private val json: Json,
) {
// SSE is a long-lived, mostly-idle connection (keepalive comments every ~25s),
// so the read timeout must be disabled or the idle stream would be killed.
private val sseClient: OkHttpClient = baseClient.newBuilder()
.readTimeout(0, TimeUnit.MILLISECONDS)
.retryOnConnectionFailure(true)
.build()
private val factory = EventSources.createFactory(sseClient)
/**
* A cold flow of stream lifecycle + frame events, reconnecting with backoff
* until the collector cancels. [ShardStreamEvent.Open] / [ShardStreamEvent.Closed]
* drive a live/offline indicator; [ShardStreamEvent.Frame] carries a decoded
* `{ kind, … }` payload the boards merge in place.
*/
fun events(): Flow<ShardStreamEvent> = channelFlow {
var backoffMs = INITIAL_BACKOFF_MS
while (isActive) {
val url = baseUrlHolder.current?.resolve(STREAM_PATH)
if (url == null) {
// No shard site configured (or an unresolvable base) — idle, don't spin.
trySend(ShardStreamEvent.Closed)
delay(backoffMs)
backoffMs = grow(backoffMs)
continue
}
val request = Request.Builder()
.url(url)
.header("Accept", "text/event-stream")
.build()
val opened = AtomicBoolean(false)
val ended = CompletableDeferred<Unit>()
val listener = object : EventSourceListener() {
override fun onOpen(eventSource: EventSource, response: Response) {
opened.set(true)
trySend(ShardStreamEvent.Open)
}
override fun onEvent(
eventSource: EventSource,
id: String?,
type: String?,
data: String,
) {
parseFrame(data)?.let { (kind, obj) ->
trySend(ShardStreamEvent.Frame(kind, obj))
}
}
override fun onClosed(eventSource: EventSource) {
trySend(ShardStreamEvent.Closed)
ended.complete(Unit)
}
override fun onFailure(
eventSource: EventSource,
t: Throwable?,
response: Response?,
) {
trySend(ShardStreamEvent.Closed)
ended.complete(Unit)
}
}
val source = factory.newEventSource(request, listener)
try {
// Park until this connection ends; collector cancellation propagates
// out of await() and is handled by the finally + the while guard.
ended.await()
} finally {
source.cancel()
}
// A connection that opened before dropping reconnects promptly; a run of
// failures that never opened backs off further to avoid hammering a down site.
backoffMs = if (opened.get()) INITIAL_BACKOFF_MS else grow(backoffMs)
delay(backoffMs)
}
}
/**
* Parse an SSE `data:` line into `(kind, object)`, dropping keepalive comments
* and any frame without a string `kind`. Kept internal + pure for unit testing.
*/
internal fun parseFrame(data: String): Pair<String, JsonObject>? {
val trimmed = data.trim()
if (trimmed.isEmpty() || trimmed.startsWith(":")) return null
return try {
val obj = json.parseToJsonElement(trimmed).jsonObject
val kindEl = obj["kind"] ?: return null
if (kindEl is JsonNull) return null
val kind = kindEl.jsonPrimitive.content
if (kind.isEmpty()) null else kind to obj
} catch (_: Exception) {
null
}
}
private fun grow(current: Long): Long = (current * 2).coerceAtMost(MAX_BACKOFF_MS)
private companion object {
const val STREAM_PATH = "api/v1/public/shard/stream"
const val INITIAL_BACKOFF_MS = 2_000L
const val MAX_BACKOFF_MS = 30_000L
}
}

View File

@@ -0,0 +1,21 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.net
import kotlinx.serialization.json.JsonObject
/**
* A lifecycle or data event from the public shard SSE stream (PLAN.md §6.2).
*
* - [Open] — a connection was established (drive the live indicator on).
* - [Closed] — the connection dropped or none is available (indicator off);
* [ShardStreamClient] will reconnect with backoff.
* - [Frame] — a live event: its `kind` plus the raw JSON object, which the
* boards decode into their DTO (`champ.update` → `ChampDto`, …).
*/
sealed interface ShardStreamEvent {
data object Open : ShardStreamEvent
data object Closed : ShardStreamEvent
data class Frame(val kind: String, val data: JsonObject) : ShardStreamEvent
}

View File

@@ -0,0 +1,86 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.net
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.data.api.AuthRefreshApi
import com.runicgateway.app.data.api.dto.MobileRefreshRequest
import okhttp3.Authenticator
import okhttp3.Request
import okhttp3.Response
import okhttp3.Route
import java.io.IOException
import javax.inject.Inject
import javax.inject.Singleton
/**
* Transparently refreshes an expired access token on a bearer `401` and replays
* the request (PLAN.md §4.1, §4.3). Refresh tokens are single-use and rotated, so
* this is serialized behind a mutex: concurrent 401s trigger exactly one refresh
* and the losers reuse its result. A refresh that comes back `401` means the
* session is truly dead → sign out; a network error leaves the session intact so
* a later call can retry.
*
* The refresh call runs on [AuthRefreshApi] (its own bare client with no
* authenticator), so it can never recurse back into here.
*/
@Singleton
class TokenAuthenticator @Inject constructor(
private val sessionManager: SessionManager,
private val refreshApi: AuthRefreshApi,
) : Authenticator {
private val lock = Any()
override fun authenticate(route: Route?, response: Response): Request? {
val failed = response.request
// Credential endpoints (login/refresh) must never be "refreshed".
if (failed.header(Http.NO_SESSION_HEADER) != null) return null
// Give up after a single refresh+replay to avoid an auth loop.
if (priorResponseCount(response) >= 2) return null
val attemptedAuth = failed.header(Http.AUTHORIZATION)
synchronized(lock) {
// Another thread may have already refreshed while we waited on the lock.
val current = sessionManager.currentAccessToken()
if (current != null && Http.bearer(current) != attemptedAuth) {
return failed.retryWith(current)
}
val refreshToken = sessionManager.currentRefreshToken()
?: return null // already signed out
val refreshed = try {
refreshApi.refresh(MobileRefreshRequest(refreshToken)).execute()
} catch (_: IOException) {
// Transient — surface the original 401 but keep the session.
return null
}
val body = refreshed.body()
if (!refreshed.isSuccessful || body == null) {
// The refresh token is dead (401/expired/revoked) → session is over.
sessionManager.onSignedOut()
return null
}
sessionManager.onRefreshed(body.accessToken, body.refreshToken, body.user)
return failed.retryWith(body.accessToken)
}
}
private fun Request.retryWith(accessToken: String): Request =
newBuilder().header(Http.AUTHORIZATION, Http.bearer(accessToken)).build()
private fun priorResponseCount(response: Response): Int {
var count = 1
var prior = response.priorResponse
while (prior != null) {
count++
prior = prior.priorResponse
}
return count
}
}

View File

@@ -0,0 +1,116 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import kotlinx.coroutines.CompletableDeferred
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.channelFlow
import kotlinx.coroutines.isActive
import kotlinx.serialization.json.Json
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response
import okhttp3.sse.EventSource
import okhttp3.sse.EventSourceListener
import okhttp3.sse.EventSources
import java.util.concurrent.TimeUnit
import java.util.concurrent.atomic.AtomicBoolean
import javax.inject.Inject
import javax.inject.Singleton
/**
* The embedded distributor's transport (PLAN.md §11, M7 Part 2 work item 1/3):
* a persistent connection to the shard's self-hosted ntfy that subscribes to the
* app's own topic and re-emits each content-free tickle. It reuses the same
* OkHttp-SSE + reconnect/backoff shape as [com.runicgateway.app.core.net.ShardStreamClient],
* but on a **bare** client — no host-retargeting or bearer interceptors — because it
* talks straight to ntfy (`<ntfy>/<topic>/sse`), not the website API. Held open by
* [PushService]'s foreground service so tickles arrive in the background without
* Google Play Services.
*/
@Singleton
class NtfyStreamClient @Inject constructor(
private val json: Json,
) {
// A dedicated client with the read timeout disabled for the mostly-idle stream
// (ntfy sends keepalive frames); no interceptors so nothing rewrites the host or
// attaches a bearer to the relay.
private val client: OkHttpClient = OkHttpClient.Builder()
.readTimeout(0, TimeUnit.MILLISECONDS)
.retryOnConnectionFailure(true)
.build()
private val factory = EventSources.createFactory(client)
/** Connection lifecycle + decoded tickles for a subscribed topic. */
sealed interface Event {
data object Open : Event
data object Closed : Event
data class Message(val tickle: PushTickle) : Event
}
/**
* A cold flow subscribing to `<ntfyBaseUrl>/<topic>/sse`, reconnecting with
* backoff until the collector cancels. A dropped relay simply reconnects; a bad
* config (null URL) idles rather than spinning.
*/
fun events(ntfyBaseUrl: String?, topic: String): Flow<Event> = channelFlow {
var backoffMs = INITIAL_BACKOFF_MS
while (isActive) {
val url = NtfyTopic.sseUrl(ntfyBaseUrl, topic)
if (url == null) {
trySend(Event.Closed)
delay(backoffMs)
backoffMs = grow(backoffMs)
continue
}
val request = Request.Builder()
.url(url)
.header("Accept", "text/event-stream")
.build()
val opened = AtomicBoolean(false)
val ended = CompletableDeferred<Unit>()
val listener = object : EventSourceListener() {
override fun onOpen(eventSource: EventSource, response: Response) {
opened.set(true)
trySend(Event.Open)
}
override fun onEvent(eventSource: EventSource, id: String?, type: String?, data: String) {
parseNtfyTickle(json, data)?.let { trySend(Event.Message(it)) }
}
override fun onClosed(eventSource: EventSource) {
trySend(Event.Closed)
ended.complete(Unit)
}
override fun onFailure(eventSource: EventSource, t: Throwable?, response: Response?) {
trySend(Event.Closed)
ended.complete(Unit)
}
}
val source = factory.newEventSource(request, listener)
try {
ended.await()
} finally {
source.cancel()
}
backoffMs = if (opened.get()) INITIAL_BACKOFF_MS else grow(backoffMs)
delay(backoffMs)
}
}
private fun grow(current: Long): Long = (current * 2).coerceAtMost(MAX_BACKOFF_MS)
private companion object {
const val INITIAL_BACKOFF_MS = 2_000L
const val MAX_BACKOFF_MS = 30_000L
}
}

View File

@@ -0,0 +1,48 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import java.security.SecureRandom
/**
* The app's own ntfy topic — the heart of the embedded-distributor design
* (PLAN.md §11, M7 Part 2 work item 1). The app mints a **random, unguessable**
* topic and registers its public URL (`https://<ntfy-host>/<topic>`) as the device
* endpoint the backend POSTs tickles to; the app subscribes to the same topic's SSE
* stream to receive them. Security rests on the topic being unguessable plus the
* content-free tickle — a leaked topic name reveals nothing.
*/
object NtfyTopic {
// ntfy topic names allow [A-Za-z0-9_-]; keep to that set. The "up" prefix mirrors
// the UnifiedPush convention and makes topics recognizable in logs/relay.
private const val ALPHABET = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
private const val TOPIC_LEN = 24
private const val PREFIX = "up"
private val secureRandom by lazy { SecureRandom() }
/** Mint a fresh unguessable topic, e.g. "up7Qk3…" (≈143 bits of entropy). */
fun generate(random: java.util.Random = secureRandom): String {
val sb = StringBuilder(PREFIX.length + TOPIC_LEN)
sb.append(PREFIX)
repeat(TOPIC_LEN) { sb.append(ALPHABET[random.nextInt(ALPHABET.length)]) }
return sb.toString()
}
/**
* The endpoint URL the backend publishes to: `<ntfyBaseUrl>/<topic>`. [ntfyBaseUrl]
* is the client-facing base from `/public/settings.push.ntfyUrl`; a trailing slash
* is tolerated. Returns null for a blank base or topic.
*/
fun endpointUrl(ntfyBaseUrl: String?, topic: String): String? {
val base = ntfyBaseUrl?.trim()?.trimEnd('/').orEmpty()
if (base.isEmpty() || topic.isBlank()) return null
return "$base/$topic"
}
/** The SSE subscribe URL the app connects to: `<ntfyBaseUrl>/<topic>/sse`. */
fun sseUrl(ntfyBaseUrl: String?, topic: String): String? =
endpointUrl(ntfyBaseUrl, topic)?.let { "$it/sse" }
}

View File

@@ -0,0 +1,156 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import android.content.Context
import com.runicgateway.app.core.auth.Session
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.repository.NotificationsRepository
import dagger.hilt.android.qualifiers.ApplicationContext
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.launch
import javax.inject.Inject
import javax.inject.Singleton
/**
* Orchestrates the app's opt-in push lifecycle (PLAN.md §11, M7 Part 2 work item 5):
* mint/keep the ntfy topic, register/unregister the device endpoint with the backend,
* and start/stop the foreground [PushService] — all keyed to the user's opt-in and
* the session. The endpoint the app registers is its own topic URL on the shard's
* ntfy (the embedded-distributor design, work item 1).
*
* Lifecycle rules:
* - register only when **signed in** and the shard advertises a relay (`ntfyUrl`);
* - a **sign-out** stops the service and forgets the ephemeral registration but keeps
* the opt-in intent, so push re-registers on the next sign-in (mirrors the M3 token
* teardown, and covers logout / dead-refresh / server switch uniformly via the
* session-state observer);
* - a **relay/base-URL change** re-registers on the new host with a fresh topic.
*/
@Singleton
class PushManager @Inject constructor(
@param:ApplicationContext private val context: Context,
private val prefs: PushPreferences,
private val notifications: NotificationsRepository,
private val sessionManager: SessionManager,
) {
private val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
/** Whether the user has push turned on (drives the Notifications screen). */
val enabled: Flow<Boolean> = prefs.enabled
/** Whether this shard advertises a push relay at all (null ntfyUrl → unsupported). */
val supported: Flow<Boolean> = prefs.ntfyUrl.map { !it.isNullOrBlank() }
init {
// Uniform teardown/resume across every auth transition: logout, dead-refresh
// sign-out, and server switch all land on SignedOut; a fresh login re-asserts.
scope.launch {
sessionManager.state.collect { s ->
when (s) {
is Session.SignedOut -> localTeardown()
is Session.SignedIn -> maybeResume()
}
}
}
}
/** Record the shard's client-facing ntfy base URL (from `/public/settings`). */
suspend fun setNtfyUrl(url: String?) {
val previous = prefs.snapshot().ntfyUrl
prefs.setNtfyUrl(url)
// The relay host arriving (or changing) is what unblocks a pending resume.
if (!url.isNullOrBlank() && url != previous) maybeResume()
}
/**
* Turn push on (idempotent): ensure a topic on the current relay, register its
* endpoint with the backend, persist, and start the foreground service. Called
* when the user opts into ≥1 stream.
*/
suspend fun enable(): PushResult = register(setIntent = true)
/** Turn push off (user opted out of every stream): clear intent + deregister. */
suspend fun disable() {
prefs.setEnabled(false)
deregisterDevice()
}
/**
* Deregister this device on an explicit sign-out / server switch, while the bearer
* is still valid, so no orphan device row is left behind. Keeps the opt-in intent
* (and ntfyUrl) so push re-registers on the next sign-in. Call this *before* the
* session is torn down.
*/
suspend fun deregisterDevice() {
val snap = prefs.snapshot()
snap.deviceId?.let { notifications.deleteDevice(it) } // best-effort
stopService()
prefs.clearRegistration()
}
/** Re-assert registration if the user is opted in and the shard supports push. */
private suspend fun maybeResume() {
val snap = prefs.snapshot()
if (snap.enabled && sessionManager.isSignedIn && !snap.ntfyUrl.isNullOrBlank()) {
register(setIntent = false)
}
}
private suspend fun register(setIntent: Boolean): PushResult {
if (!sessionManager.isSignedIn) return PushResult.NotSignedIn
val snap = prefs.snapshot()
val ntfyUrl = snap.ntfyUrl
if (ntfyUrl.isNullOrBlank()) return PushResult.Unsupported
// Reuse an existing topic only if its endpoint still sits on the current relay
// origin; otherwise (first run, or a server switch) mint a fresh unguessable one.
val base = ntfyUrl.trimEnd('/')
val topic = snap.topic?.takeIf { snap.endpoint?.startsWith("$base/") == true }
?: NtfyTopic.generate()
val endpoint = NtfyTopic.endpointUrl(ntfyUrl, topic) ?: return PushResult.Unsupported
return when (val res = notifications.registerDevice(endpoint, PLATFORM)) {
is ApiResult.Ok -> {
prefs.setRegistration(topic, endpoint, res.data.id)
if (setIntent) prefs.setEnabled(true)
startService()
PushResult.Enabled
}
// 400 = endpoint origin isn't on the shard's ntfy allow-set (misconfigured relay).
is ApiResult.HttpError -> PushResult.Failed(res.status)
is ApiResult.NetworkError -> PushResult.Failed(null)
}
}
/** Local-only teardown on sign-out — no backend DELETE (the bearer may be dead). */
private suspend fun localTeardown() {
stopService()
prefs.clearRegistration()
}
private fun startService() = runCatching { PushService.start(context) }
private fun stopService() = runCatching { PushService.stop(context) }
/** The outcome of enabling push, surfaced to the Notifications screen. */
sealed interface PushResult {
data object Enabled : PushResult
/** This shard advertises no push relay (`/public/settings.push.ntfyUrl` is null). */
data object Unsupported : PushResult
data object NotSignedIn : PushResult
/** Registration failed — [status] 400 = relay off the allow-set; null = network. */
data class Failed(val status: Int?) : PushResult
}
private companion object {
const val PLATFORM = "android"
}
}

View File

@@ -0,0 +1,110 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import android.app.Notification
import android.app.NotificationChannel
import android.app.NotificationManager
import android.app.PendingIntent
import android.content.Context
import android.content.Intent
import androidx.core.app.NotificationCompat
import androidx.core.app.NotificationManagerCompat
import com.runicgateway.app.MainActivity
import com.runicgateway.app.R
import dagger.hilt.android.qualifiers.ApplicationContext
import java.util.concurrent.atomic.AtomicInteger
import javax.inject.Inject
import javax.inject.Singleton
/**
* Builds the notification channels and posts a notification for a received tickle
* (PLAN.md §11, M7 Part 2 work items 2/3/7). v1 shows a **generic per-stream**
* notification titled from the fixed [PushStreams] catalog — the content-free tickle
* carries nothing to render, so nothing is fetched to display the notification; tapping
* deep-links into [MainActivity] (which fetches fresh over the authenticated API).
*/
@Singleton
class PushNotifier @Inject constructor(
@param:ApplicationContext private val context: Context,
) {
private val manager = NotificationManagerCompat.from(context)
private val nextId = AtomicInteger(1)
/** Create both channels; safe to call repeatedly (creation is idempotent). */
fun ensureChannels() {
val system = context.getSystemService(NotificationManager::class.java) ?: return
system.createNotificationChannel(
NotificationChannel(
CHANNEL_MESSAGES,
context.getString(R.string.push_channel_messages),
NotificationManager.IMPORTANCE_DEFAULT,
).apply { description = context.getString(R.string.push_channel_messages_desc) },
)
system.createNotificationChannel(
NotificationChannel(
CHANNEL_SERVICE,
context.getString(R.string.push_channel_service),
NotificationManager.IMPORTANCE_LOW,
).apply {
description = context.getString(R.string.push_channel_service_desc)
setShowBadge(false)
},
)
}
/** The persistent low-importance notification the foreground service runs under. */
fun serviceNotification(): Notification =
NotificationCompat.Builder(context, CHANNEL_SERVICE)
.setContentTitle(context.getString(R.string.push_service_title))
.setContentText(context.getString(R.string.push_service_text))
.setSmallIcon(R.drawable.ic_stat_name)
.setOngoing(true)
.setPriority(NotificationCompat.PRIORITY_LOW)
.setContentIntent(deepLinkIntent(stream = null, ref = null))
.build()
/** Post a notification for a tickle, deep-linking to the stream's screen on tap. */
fun notify(tickle: PushTickle) {
if (!manager.areNotificationsEnabled()) return // POST_NOTIFICATIONS not granted
val title = context.getString(PushStreams.titleRes(tickle.stream))
val notification = NotificationCompat.Builder(context, CHANNEL_MESSAGES)
.setContentTitle(title)
.setSmallIcon(R.drawable.ic_stat_name)
.setAutoCancel(true)
.setPriority(NotificationCompat.PRIORITY_DEFAULT)
.setContentIntent(deepLinkIntent(tickle.stream, tickle.ref))
.build()
try {
manager.notify(nextId.getAndIncrement(), notification)
} catch (_: SecurityException) {
// Racing a permission revoke — drop silently rather than crash.
}
}
private fun deepLinkIntent(stream: String?, ref: String?): PendingIntent {
val intent = Intent(context, MainActivity::class.java).apply {
flags = Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP
if (stream != null) putExtra(EXTRA_STREAM, stream)
if (ref != null) putExtra(EXTRA_REF, ref)
}
// A distinct request code per stream so PendingIntents don't collapse into one.
val requestCode = stream?.hashCode() ?: 0
return PendingIntent.getActivity(
context,
requestCode,
intent,
PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT,
)
}
companion object {
const val CHANNEL_MESSAGES = "push_messages"
const val CHANNEL_SERVICE = "push_service"
/** Intent extras a tapped notification carries into [MainActivity] (§7 deep-links). */
const val EXTRA_STREAM = "com.runicgateway.app.push.STREAM"
const val EXTRA_REF = "com.runicgateway.app.push.REF"
}
}

View File

@@ -0,0 +1,91 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import android.content.Context
import androidx.datastore.core.DataStore
import androidx.datastore.preferences.core.Preferences
import androidx.datastore.preferences.core.booleanPreferencesKey
import androidx.datastore.preferences.core.edit
import androidx.datastore.preferences.core.longPreferencesKey
import androidx.datastore.preferences.core.stringPreferencesKey
import androidx.datastore.preferences.preferencesDataStore
import dagger.hilt.android.qualifiers.ApplicationContext
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.map
import javax.inject.Inject
import javax.inject.Singleton
private val Context.pushDataStore: DataStore<Preferences> by preferencesDataStore(name = "push")
/**
* Persists the app's push state (PLAN.md §11, M7 Part 2 work item 5). None of it is
* secret — the ntfy topic/endpoint's protection is being unguessable plus the
* content-free tickle — so plain DataStore is fine (tokens stay in the encrypted
* store). Holds the shard's ntfy base URL (from `/public/settings`), the minted
* topic + its endpoint URL, the backend-assigned device id (to unregister), and the
* user's opt-in flag (the source of truth for "push should be running").
*/
@Singleton
class PushPreferences @Inject constructor(
@param:ApplicationContext private val context: Context,
) {
private val store = context.pushDataStore
val enabled: Flow<Boolean> = store.data.map { it[KEY_ENABLED] ?: false }
val ntfyUrl: Flow<String?> = store.data.map { it[KEY_NTFY_URL] }
suspend fun snapshot(): Snapshot {
val p = store.data.first()
return Snapshot(
enabled = p[KEY_ENABLED] ?: false,
ntfyUrl = p[KEY_NTFY_URL],
topic = p[KEY_TOPIC],
endpoint = p[KEY_ENDPOINT],
deviceId = p[KEY_DEVICE_ID],
)
}
suspend fun setNtfyUrl(url: String?) = store.edit {
if (url.isNullOrBlank()) it.remove(KEY_NTFY_URL) else it[KEY_NTFY_URL] = url
}
suspend fun setEnabled(value: Boolean) = store.edit { it[KEY_ENABLED] = value }
/** Record the minted topic + its endpoint URL and the assigned device id together. */
suspend fun setRegistration(topic: String, endpoint: String, deviceId: Long) = store.edit {
it[KEY_TOPIC] = topic
it[KEY_ENDPOINT] = endpoint
it[KEY_DEVICE_ID] = deviceId
}
/**
* Forget the ephemeral device registration (topic/endpoint/device id) — used on
* sign-out and on an explicit disable. Deliberately leaves [KEY_ENABLED] and
* [KEY_NTFY_URL] intact so the user's opt-in intent survives a sign-out and push
* re-registers on the next sign-in; an explicit disable also calls [setEnabled]`(false)`.
*/
suspend fun clearRegistration() = store.edit {
it.remove(KEY_TOPIC)
it.remove(KEY_ENDPOINT)
it.remove(KEY_DEVICE_ID)
}
data class Snapshot(
val enabled: Boolean,
val ntfyUrl: String?,
val topic: String?,
val endpoint: String?,
val deviceId: Long?,
)
private companion object {
val KEY_ENABLED = booleanPreferencesKey("enabled")
val KEY_NTFY_URL = stringPreferencesKey("ntfy_url")
val KEY_TOPIC = stringPreferencesKey("topic")
val KEY_ENDPOINT = stringPreferencesKey("endpoint")
val KEY_DEVICE_ID = longPreferencesKey("device_id")
}
}

View File

@@ -0,0 +1,95 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import android.app.Service
import android.content.Context
import android.content.Intent
import android.content.pm.ServiceInfo
import android.os.Build
import android.os.IBinder
import androidx.core.app.ServiceCompat
import dagger.hilt.android.AndroidEntryPoint
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.Job
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.cancel
import kotlinx.coroutines.flow.collectLatest
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The always-connected foreground service that IS the embedded distributor
* (PLAN.md §11, M7 Part 2 work item 1/3). It holds [NtfyStreamClient]'s persistent
* connection to the shard's ntfy open in the background — the price of Google-free,
* self-contained instant delivery — and posts a notification for each tickle. It runs
* under a low-importance ongoing notification and restarts sticky; [PushManager] starts
* and stops it as the user opts in/out or signs out.
*/
@AndroidEntryPoint
class PushService : Service() {
@Inject lateinit var streamClient: NtfyStreamClient
@Inject lateinit var notifier: PushNotifier
@Inject lateinit var prefs: PushPreferences
private val scope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
private var connectionJob: Job? = null
override fun onCreate() {
super.onCreate()
notifier.ensureChannels()
}
override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
startAsForeground()
if (connectionJob == null) connectionJob = scope.launch { run() }
return START_STICKY
}
private fun startAsForeground() {
val type = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
ServiceInfo.FOREGROUND_SERVICE_TYPE_DATA_SYNC
} else {
0
}
ServiceCompat.startForeground(this, NOTIFICATION_ID, notifier.serviceNotification(), type)
}
private suspend fun run() {
val snapshot = prefs.snapshot()
val topic = snapshot.topic
if (topic.isNullOrBlank() || snapshot.ntfyUrl.isNullOrBlank()) {
// Nothing to subscribe to (should not happen — PushManager starts us only
// once a topic exists) — stop rather than hold a dead connection open.
stopSelf()
return
}
streamClient.events(snapshot.ntfyUrl, topic).collectLatest { event ->
if (event is NtfyStreamClient.Event.Message) notifier.notify(event.tickle)
}
}
override fun onDestroy() {
connectionJob?.cancel()
scope.cancel()
super.onDestroy()
}
override fun onBind(intent: Intent?): IBinder? = null
companion object {
private const val NOTIFICATION_ID = 42
fun start(context: Context) {
val intent = Intent(context, PushService::class.java)
context.startForegroundService(intent)
}
fun stop(context: Context) {
context.stopService(Intent(context, PushService::class.java))
}
}
}

View File

@@ -0,0 +1,39 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import androidx.annotation.StringRes
import com.runicgateway.app.R
/**
* The known push stream ids (mirrors the backend catalog in
* `config/notificationStreams.js`) and their localized notification titles.
* The subscribable catalog itself is fetched from
* `GET /auth/me/notifications/streams`; this fixed set is only what the receiver
* needs to title a content-free tickle without a network round-trip (§11).
*/
object PushStreams {
const val NEWS_POST = "news.post"
const val SERVER_STATUS = "server.status"
const val IDOC_WARNING = "idoc.warning"
const val CHAMP_START = "champ.start"
const val GOVERNOR_ELECTION = "governor.election"
const val VENDOR_SALE = "vendor.sale"
const val HOUSE_IDOC = "house.idoc"
const val ACCOUNT_LOGIN = "account.login"
/** A short, localized notification title for [streamId]; a generic fallback otherwise. */
@StringRes
fun titleRes(streamId: String): Int = when (streamId) {
NEWS_POST -> R.string.push_stream_news_post
SERVER_STATUS -> R.string.push_stream_server_status
IDOC_WARNING -> R.string.push_stream_idoc_warning
CHAMP_START -> R.string.push_stream_champ_start
GOVERNOR_ELECTION -> R.string.push_stream_governor_election
VENDOR_SALE -> R.string.push_stream_vendor_sale
HOUSE_IDOC -> R.string.push_stream_house_idoc
ACCOUNT_LOGIN -> R.string.push_stream_account_login
else -> R.string.push_stream_generic
}
}

View File

@@ -0,0 +1,54 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.push
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonNull
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.jsonPrimitive
/**
* The content-free push tickle the backend publishes (PLAN.md §11): `{ stream, ref }`
* and nothing sensitive. [ref] is an opaque hint (a serial / city / timestamp) the
* app *could* use to pull real content over the authenticated API; v1 just deep-links
* to the stream's screen, so it is carried but not otherwise interpreted.
*/
@Serializable
data class PushTickle(
val stream: String,
val ref: String? = null,
)
/**
* Parse a tickle out of an ntfy SSE `data:` frame. ntfy wraps our published body in
* its own envelope — `{ event, topic, message, … }` — where `message` is the exact
* string we POSTed (our `{ stream, ref }` JSON). Only `event == "message"` frames
* carry a payload; `open` / `keepalive` frames return null, as does any malformed or
* unrecognized body (dropped, never thrown — §7). Pure + `internal` for unit testing.
*/
internal fun parseNtfyTickle(json: Json, data: String): PushTickle? {
val trimmed = data.trim()
if (trimmed.isEmpty() || trimmed.startsWith(":")) return null
return try {
val envelope = json.parseToJsonElement(trimmed) as? JsonObject ?: return null
val event = envelope["event"]?.jsonPrimitive?.content
// ntfy lifecycle frames ("open", "keepalive", "poll_request") carry no message.
if (event != null && event != "message") return null
val messageEl = envelope["message"] ?: return null
if (messageEl is JsonNull) return null
val message = messageEl.jsonPrimitive.content
decodeTickle(json, message)
} catch (_: Exception) {
null
}
}
/** Decode our own `{ stream, ref }` body; a blank/missing stream is not a tickle. */
internal fun decodeTickle(json: Json, body: String): PushTickle? = try {
val tickle = json.decodeFromString(PushTickle.serializer(), body.trim())
tickle.takeIf { it.stream.isNotBlank() }
} catch (_: Exception) {
null
}

View File

@@ -0,0 +1,32 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.web
import android.content.ActivityNotFoundException
import android.content.Context
import android.net.Uri
import androidx.browser.customtabs.CustomTabsIntent
/**
* Opens the website's own pages in a Chrome Custom Tab (PLAN.md §4.2):
* registration, invite acceptance, forgot/reset password, and SSO all stay
* website-handled, so the app hands off rather than rebuilding those flows. The
* user completes them in the browser and returns to sign in natively (§4.1).
*/
object WebHandoff {
/**
* Launch [url] in a Custom Tab. Returns false if no browser could handle it
* (extremely rare on Android) so the caller can surface a fallback.
*/
fun open(context: Context, url: String): Boolean = try {
CustomTabsIntent.Builder()
.setShowTitle(true)
.build()
.launchUrl(context, Uri.parse(url))
true
} catch (_: ActivityNotFoundException) {
false
}
}

View File

@@ -0,0 +1,37 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.core.web
import com.runicgateway.app.core.net.BaseUrlHolder
import javax.inject.Inject
import javax.inject.Singleton
/**
* Resolves the website's front-end page paths against the configured base URL,
* for the Custom-Tab hand-offs (PLAN.md §4.2). These are the React SPA routes
* (mirrored from `website/client` `App.jsx`), not API endpoints. Null before a
* shard site is configured.
*/
@Singleton
class WebsiteUrls @Inject constructor(
private val baseUrlHolder: BaseUrlHolder,
) {
private fun resolve(path: String): String? =
baseUrlHolder.current?.resolve(path)?.toString()
/** Create an account on the website. */
fun register(): String? = resolve(REGISTER)
/** Forgot / reset password (the flow built on the backend before app work, §8). */
fun forgotPassword(): String? = resolve(FORGOT)
/** The website login page — carries the SSO provider buttons (§4.2). */
fun login(): String? = resolve(LOGIN)
private companion object {
const val REGISTER = "account/register"
const val FORGOT = "account/forgot"
const val LOGIN = "account/login"
}
}

View File

@@ -0,0 +1,40 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.MeResponse
import com.runicgateway.app.data.api.dto.MobileLoginRequest
import com.runicgateway.app.data.api.dto.MobileLogoutRequest
import com.runicgateway.app.data.api.dto.MobileTokenResponse
import retrofit2.Response
import retrofit2.http.Body
import retrofit2.http.GET
import retrofit2.http.Headers
import retrofit2.http.POST
/**
* The native bearer-auth surface (PLAN.md §4.1). Login and logout run on the main
* OkHttp client; [com.runicgateway.app.core.net.AuthInterceptor] attaches the
* access token to logout + `/auth/me`, and [com.runicgateway.app.core.net.TokenAuthenticator]
* transparently refreshes on a `401`.
*
* Login is tagged [com.runicgateway.app.core.net.Http.NO_SESSION_HEADER] so it
* carries no bearer and a credential `401` (bad password / `totpRequired`) is not
* misread as an expired session. It returns a raw [Response] so the caller can
* inspect the status and parse the `{ totpRequired }` error body.
*/
interface AuthApi {
// Literal header value required by Retrofit @Headers; matches Http.NO_SESSION_HEADER.
@Headers("X-Runic-No-Session: 1")
@POST("api/v1/auth/mobile/login")
suspend fun login(@Body body: MobileLoginRequest): Response<MobileTokenResponse>
@POST("api/v1/auth/mobile/logout")
suspend fun logout(@Body body: MobileLogoutRequest): Response<Unit>
/** Current user — the app's authoritative role source, re-validated on resume (§4.3). */
@GET("api/v1/auth/me")
suspend fun me(): MeResponse
}

View File

@@ -0,0 +1,27 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.MobileRefreshRequest
import com.runicgateway.app.data.api.dto.MobileTokenResponse
import retrofit2.Call
import retrofit2.http.Body
import retrofit2.http.Headers
import retrofit2.http.POST
/**
* The token-rotation endpoint, isolated onto its own **bare** OkHttp client
* (no auth interceptor, no authenticator) so refreshing can never recurse
* through the very [com.runicgateway.app.core.net.TokenAuthenticator] that calls
* it (PLAN.md §4.3). It is a blocking [Call] because the authenticator runs on an
* OkHttp dispatcher thread, outside any coroutine, and executes it synchronously.
*
* Tagged `NO_SESSION` so it carries no stale bearer.
*/
interface AuthRefreshApi {
@Headers("X-Runic-No-Session: 1")
@POST("api/v1/auth/mobile/refresh")
fun refresh(@Body body: MobileRefreshRequest): Call<MobileTokenResponse>
}

View File

@@ -0,0 +1,55 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.ChangePasswordRequest
import com.runicgateway.app.data.api.dto.ChangeUsernameRequest
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
import com.runicgateway.app.data.api.dto.PlayerAccountDto
import com.runicgateway.app.data.api.dto.TotpCodeRequest
import com.runicgateway.app.data.api.dto.TotpSetupDto
import com.runicgateway.app.data.api.dto.TotpStateDto
import com.runicgateway.app.data.api.dto.UsernameResponse
import retrofit2.http.Body
import retrofit2.http.GET
import retrofit2.http.HTTP
import retrofit2.http.PATCH
import retrofit2.http.POST
import retrofit2.http.Path
/**
* The role-agnostic self-service surface (PLAN.md §6.3, §6.4): account, credential
* changes, TOTP enrollment, and linked SSO identities under `/auth/me/account*`.
* The app calls these regardless of role and never touches `/admin`. Every call
* rides the main client, so [com.runicgateway.app.core.net.AuthInterceptor] attaches
* the bearer and [com.runicgateway.app.core.net.TokenAuthenticator] refreshes on 401.
*/
interface MeApi {
@GET("api/v1/auth/me/account")
suspend fun getAccount(): PlayerAccountDto
@PATCH("api/v1/auth/me/account/username")
suspend fun changeUsername(@Body body: ChangeUsernameRequest): UsernameResponse
@PATCH("api/v1/auth/me/account/password")
suspend fun changePassword(@Body body: ChangePasswordRequest): Unit
@POST("api/v1/auth/me/account/totp/setup")
suspend fun totpSetup(): TotpSetupDto
@POST("api/v1/auth/me/account/totp/enable")
suspend fun totpEnable(@Body body: TotpCodeRequest): TotpStateDto
@POST("api/v1/auth/me/account/totp/disable")
suspend fun totpDisable(@Body body: TotpCodeRequest): TotpStateDto
@GET("api/v1/auth/me/account/identities")
suspend fun identities(): List<LinkedIdentityDto>
// DELETE with no body — a plain @DELETE would suffice, but @HTTP keeps the
// path template explicit alongside the provider argument.
@HTTP(method = "DELETE", path = "api/v1/auth/me/account/identities/{provider}")
suspend fun unlinkIdentity(@Path("provider") provider: String): Unit
}

View File

@@ -0,0 +1,43 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
import com.runicgateway.app.data.api.dto.PushDeviceDto
import com.runicgateway.app.data.api.dto.RegisterDeviceRequest
import retrofit2.http.Body
import retrofit2.http.DELETE
import retrofit2.http.GET
import retrofit2.http.POST
import retrofit2.http.PUT
import retrofit2.http.Path
/**
* The opt-in push surface under `/auth/me` (PLAN.md §11, M7 Part 2): device
* (endpoint) registration and per-user stream subscriptions. Every call rides the
* main client, so [com.runicgateway.app.core.net.AuthInterceptor] attaches the
* bearer and [com.runicgateway.app.core.net.TokenAuthenticator] refreshes on 401 —
* registration only ever succeeds while signed in.
*/
interface NotificationsApi {
@POST("api/v1/auth/me/devices")
suspend fun registerDevice(@Body body: RegisterDeviceRequest): PushDeviceDto
@GET("api/v1/auth/me/devices")
suspend fun listDevices(): List<PushDeviceDto>
@DELETE("api/v1/auth/me/devices/{id}")
suspend fun deleteDevice(@Path("id") id: Long): Unit
@GET("api/v1/auth/me/notifications/streams")
suspend fun streams(): NotificationStreamsDto
@GET("api/v1/auth/me/notifications/subscriptions")
suspend fun subscriptions(): NotificationSubscriptionsDto
@PUT("api/v1/auth/me/notifications/subscriptions")
suspend fun putSubscriptions(@Body body: NotificationSubscriptionsDto): NotificationSubscriptionsDto
}

View File

@@ -0,0 +1,59 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.CharProfileDto
import com.runicgateway.app.data.api.dto.CreateGameAccountRequest
import com.runicgateway.app.data.api.dto.PlayerHouseDto
import com.runicgateway.app.data.api.dto.RosterDto
import com.runicgateway.app.data.api.dto.ShardLinkDto
import com.runicgateway.app.data.api.dto.ShardLinkRequest
import com.runicgateway.app.data.api.dto.ShardLinkResultDto
import com.runicgateway.app.data.api.dto.VendorSaleDto
import com.runicgateway.app.data.api.dto.VendorSnapshotDto
import retrofit2.http.Body
import retrofit2.http.GET
import retrofit2.http.POST
import retrofit2.http.Path
/**
* A player's own game data + game-account linking (PLAN.md §6.3), over the
* bearer-gated `/player/shard/…` surface. Every read is ownership-checked
* server-side; a `503` means the shard/sidecar is down → the UI renders "offline,
* retry" (§7). All reads ride the main authed client (bearer + refresh-on-401).
*/
interface PlayerShardApi {
/** Confirm an in-game `[link` one-time code, tagging the game account to the user. */
@POST("api/v1/player/shard/link")
suspend fun link(@Body body: ShardLinkRequest): ShardLinkResultDto
/** Provision a game account (hybrid signup) and auto-link it to the caller. */
@POST("api/v1/player/shard/account")
suspend fun createAccount(@Body body: CreateGameAccountRequest): ShardLinkResultDto
/** The caller's linked game accounts. */
@GET("api/v1/player/shard/accounts")
suspend fun accounts(): List<ShardLinkDto>
/** Character roster for a linked account. */
@GET("api/v1/player/shard/roster/{account}")
suspend fun roster(@Path("account") account: String): RosterDto
/** A character sheet — only for a character on the caller's linked account. */
@GET("api/v1/player/shard/char/{serial}")
suspend fun char(@Path("serial") serial: String): CharProfileDto
/** Player vendors for a linked account. */
@GET("api/v1/player/shard/vendors/{account}")
suspend fun vendors(@Path("account") account: String): VendorSnapshotDto
/** Recent player-vendor sales across the caller's linked accounts. */
@GET("api/v1/player/shard/sales")
suspend fun sales(): List<VendorSaleDto>
/** The caller's own houses (home/decay status). */
@GET("api/v1/player/shard/houses")
suspend fun houses(): List<PlayerHouseDto>
}

View File

@@ -3,11 +3,21 @@
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.ChampDto
import com.runicgateway.app.data.api.dto.ContactRequest
import com.runicgateway.app.data.api.dto.ContactResponse
import com.runicgateway.app.data.api.dto.EconomySampleDto
import com.runicgateway.app.data.api.dto.FeedEventDto
import com.runicgateway.app.data.api.dto.GovernorDto
import com.runicgateway.app.data.api.dto.GovernorTermDto
import com.runicgateway.app.data.api.dto.GuildDto
import com.runicgateway.app.data.api.dto.HouseDto
import com.runicgateway.app.data.api.dto.OnlineStaffDto
import com.runicgateway.app.data.api.dto.PageDto
import com.runicgateway.app.data.api.dto.PostDto
import com.runicgateway.app.data.api.dto.PresenceDto
import com.runicgateway.app.data.api.dto.SettingsDto
import com.runicgateway.app.data.api.dto.ShardStatusDto
import com.runicgateway.app.data.api.dto.StatusDto
import com.runicgateway.app.data.api.dto.WikiCategoryDto
import com.runicgateway.app.data.api.dto.WikiPageDto
@@ -24,8 +34,10 @@ import retrofit2.http.Url
* The public (unauthenticated) surface consumed in M1: site status/settings,
* news posts, CMS pages, wiki, and the contact form (PLAN.md §6.1). Paths are
* relative to the sentinel base host; [com.runicgateway.app.core.net.HostSelectionInterceptor]
* retargets them onto the configured shard site. Auth (§4) and the shard widgets
* (§6.2) arrive in later milestones.
* retargets them onto the configured shard site. The public shard widgets (§6.2)
* are added in M2; auth (§4) and player game data (§6.3) arrive in later milestones.
* The live SSE stream (`/public/shard/stream`) is not a Retrofit call — it is
* consumed via OkHttp in [com.runicgateway.app.core.net.ShardStreamClient].
*/
interface PublicApi {
@@ -79,4 +91,41 @@ interface PublicApi {
// ── Contact ──────────────────────────────────────────────────────────
@POST("api/v1/public/contact")
suspend fun postContact(@Body body: ContactRequest): ContactResponse
// ── Public shard widgets (§6.2) ──────────────────────────────────────
@GET("api/v1/public/shard/status")
suspend fun getShardStatus(): ShardStatusDto
@GET("api/v1/public/shard/feed")
suspend fun getShardFeed(
@Query("kind") kind: String? = null,
@Query("limit") limit: Int? = null,
): List<FeedEventDto>
@GET("api/v1/public/shard/economy")
suspend fun getShardEconomy(@Query("limit") limit: Int? = null): List<EconomySampleDto>
@GET("api/v1/public/shard/online")
suspend fun getShardOnline(): List<OnlineStaffDto>
@GET("api/v1/public/shard/presence")
suspend fun getShardPresence(): PresenceDto
@GET("api/v1/public/shard/champs")
suspend fun getShardChamps(): List<ChampDto>
@GET("api/v1/public/shard/guilds")
suspend fun getShardGuilds(): List<GuildDto>
@GET("api/v1/public/shard/governors")
suspend fun getShardGovernors(): List<GovernorDto>
@GET("api/v1/public/shard/governors/{city}/history")
suspend fun getShardGovernorHistory(
@Path("city") city: String,
@Query("limit") limit: Int? = null,
): List<GovernorTermDto>
@GET("api/v1/public/shard/houses")
suspend fun getShardHouses(): List<HouseDto>
}

View File

@@ -0,0 +1,40 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
import com.runicgateway.app.data.api.dto.MobileTokenResponse
import com.runicgateway.app.data.api.dto.SsoProviderDto
import retrofit2.Response
import retrofit2.http.Body
import retrofit2.http.GET
import retrofit2.http.Headers
import retrofit2.http.POST
/**
* The native SSO bridge surface (PLAN.md §4.2, M9). Discovery lists the shard's
* enabled providers; exchange trades a callback authorization code (+ its PKCE
* verifier) for the same bearer pair as `/auth/mobile/login`.
*
* The redirect leg (`/auth/mobile/sso/start`) is **not** here — it is opened in a
* Custom Tab as a URL (the browser follows the 302 through the IdP), not called as
* an XHR. See [com.runicgateway.app.core.auth.sso.SsoAuthManager].
*
* Exchange is tagged [com.runicgateway.app.core.net.Http.NO_SESSION_HEADER]: it
* carries no bearer (the user isn't signed in yet) and a `401` (bad/expired code or
* PKCE mismatch) must never be misread as an expired session or trip the refresh
* [com.runicgateway.app.core.net.TokenAuthenticator]. It returns a raw [Response]
* so the caller can distinguish `401` from other failures.
*/
interface SsoApi {
/** Public discovery — the enabled providers to render login buttons for. */
@GET("api/v1/auth/providers")
suspend fun providers(): List<SsoProviderDto>
// Literal header value required by Retrofit @Headers; matches Http.NO_SESSION_HEADER.
@Headers("X-Runic-No-Session: 1")
@POST("api/v1/auth/mobile/sso/exchange")
suspend fun exchange(@Body body: MobileSsoExchangeRequest): Response<MobileTokenResponse>
}

View File

@@ -0,0 +1,68 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.Serializable
/**
* The role-agnostic self-service ("me") wire shapes (PLAN.md §6.3, §6.4). Field
* names match the backend's `account.controller` handlers exactly, surfaced for
* the app under `/auth/me/account*`. Every DTO ignores unknown keys (NetworkModule's
* lenient Json), so additive backend fields are safe (recorded for M1).
*/
/** `GET /auth/me/account` — the current account (any role). */
@Serializable
data class PlayerAccountDto(
val id: Long = 0,
val username: String = "",
val role: String = "",
val email: String? = null,
val status: String? = null,
val totp_enabled: Boolean = false,
/** False for an SSO-provisioned account that has not set a password yet. */
val has_password: Boolean = false,
)
/** `PATCH /auth/me/account/username` body. */
@Serializable
data class ChangeUsernameRequest(val username: String)
/** The `{ username }` returned by a successful username change. */
@Serializable
data class UsernameResponse(val username: String = "")
/**
* `PATCH /auth/me/account/password` body. [currentPassword] is omitted only for an
* SSO-provisioned account setting its initial password (has_password == false).
*/
@Serializable
data class ChangePasswordRequest(
val newPassword: String,
val currentPassword: String? = null,
)
/** Enrollment material from `POST /auth/me/account/totp/setup`. */
@Serializable
data class TotpSetupDto(
val otpauthUrl: String? = null,
/** QR code as a `data:image/png;base64,…` URL. */
val qr: String? = null,
)
/** `POST /auth/me/account/totp/enable|disable` body — a current authenticator code. */
@Serializable
data class TotpCodeRequest(val code: String)
/** Result of enabling/disabling 2FA. */
@Serializable
data class TotpStateDto(val totp_enabled: Boolean = false)
/** A linked external identity (`GET /auth/me/account/identities`). */
@Serializable
data class LinkedIdentityDto(
val provider: String = "",
val email: String? = null,
val linked_at: String? = null,
)

View File

@@ -0,0 +1,67 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.Serializable
/**
* The mobile bearer-auth wire shapes (PLAN.md §4.1). Field names match the
* backend's `auth/mobile` controller and `/auth/me` exactly; every DTO ignores
* unknown keys (NetworkModule's lenient Json), so additive backend fields are
* safe (§8, recorded for M1).
*/
/** `POST /auth/mobile/login` body. [code] is only sent on the 2FA retry. */
@Serializable
data class MobileLoginRequest(
val username: String,
val password: String,
val code: String? = null,
)
/** `POST /auth/mobile/refresh` body. */
@Serializable
data class MobileRefreshRequest(val refreshToken: String)
/** `POST /auth/mobile/logout` body — revoke this session or (with [all]) every session. */
@Serializable
data class MobileLogoutRequest(
val refreshToken: String? = null,
val all: Boolean? = null,
)
/**
* Success payload from login and refresh: the token pair, the access lifetime
* (a zeit/ms duration string, e.g. "15m"), and the safe (secret-stripped) user.
*/
@Serializable
data class MobileTokenResponse(
val accessToken: String,
val refreshToken: String,
val expiresIn: String? = null,
val user: SafeUserDto,
)
/** The minimal, non-sensitive user the app needs to render + gate the menu (§5). */
@Serializable
data class SafeUserDto(
val id: Long,
val username: String,
val role: String,
)
/** `GET /auth/me` envelope — the role source, re-validated on resume (§4.3). */
@Serializable
data class MeResponse(val user: SafeUserDto)
/**
* The `401 { totpRequired: true }` body the single-request 2FA flow returns when
* an account has TOTP on and no/invalid code accompanied the login (§4.1). Parsed
* from the error body since it is not a 2xx response.
*/
@Serializable
data class TotpRequiredError(
val totpRequired: Boolean = false,
val message: String? = null,
)

View File

@@ -0,0 +1,67 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.Serializable
/**
* Wire shapes for the opt-in push surface under `/auth/me` (PLAN.md §11, M7
* Part 2). Field names match the backend's `notifications.controller` /
* `pushDevices.model` exactly; every DTO ignores unknown keys (NetworkModule's
* lenient Json), so additive backend fields are safe (recorded for M1).
*/
/**
* `POST /auth/me/devices` body. [endpoint] is the ntfy topic URL the app's
* embedded distributor owns (`https://<ntfy-host>/<topic>`); the backend
* SSRF-validates it is HTTPS on the shard's allow-set before storing. [transport]
* is `unifiedpush` for the direct-ntfy relay (fcm reserved for a future flavor).
*/
@Serializable
data class RegisterDeviceRequest(
val endpoint: String,
val transport: String = "unifiedpush",
val platform: String? = null,
)
/** `POST/GET /auth/me/devices` — one registered device (endpoint) for this user. */
@Serializable
data class PushDeviceDto(
val id: Long = 0,
val transport: String = "",
val endpoint: String = "",
val platform: String? = null,
val createdAt: String? = null,
val lastSeenAt: String? = null,
)
/**
* One subscribable stream from `GET /auth/me/notifications/streams`. A [personal]
* stream is delivered only to the owning user and [requiresLinkedAccount] — the app
* greys its toggle until a game account is linked (§11).
*/
@Serializable
data class NotificationStreamDto(
val id: String = "",
val label: String = "",
val description: String = "",
val personal: Boolean = false,
val requiresLinkedAccount: Boolean = false,
)
/** `GET /auth/me/notifications/streams` — the catalog. */
@Serializable
data class NotificationStreamsDto(
val streams: List<NotificationStreamDto> = emptyList(),
)
/**
* `GET/PUT /auth/me/notifications/subscriptions` — the user's opted-in stream ids.
* PUT replaces the full set; unknown ids are dropped server-side and the stored set
* echoed back.
*/
@Serializable
data class NotificationSubscriptionsDto(
val streams: List<String> = emptyList(),
)

View File

@@ -0,0 +1,224 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonObject
/**
* DTOs for a player's OWN game data (PLAN.md §6.3), read over the bearer-gated
* `/player/shard/…` surface. The roster / char / vendor reads return the sidecar
* payload verbatim (a permissive object), so only the fields the app renders are
* modeled — unknown keys are ignored by the JSON parser (matching the website's
* `CharacterSheet.jsx` / `GameAccounts.jsx` and `docs/link/INTEGRATION.md` §5).
* Presentation is text-only for v1 (no item icons / paperdoll).
*
* In-game serials are hex strings (e.g. "0x24C"), unlike the numeric serials on
* the public boards — these are separate endpoints with separate shapes.
*/
// ── Game-account linking ─────────────────────────────────────────────────────
/** `GET /player/shard/accounts` — a linked in-game account. */
@Serializable
data class ShardLinkDto(
val account: String = "",
val userId: Long? = null,
val charName: String? = null,
val linkedAt: String? = null,
)
/** `POST /player/shard/link` body — the one-time code shown by `[link` in game. */
@Serializable
data class ShardLinkRequest(val code: String)
/** `POST /player/shard/link` result — the confirmed link. */
@Serializable
data class ShardLinkResultDto(
val linked: Boolean = false,
val account: String? = null,
)
/** `POST /player/shard/account` (hybrid signup) body. */
@Serializable
data class CreateGameAccountRequest(
val account: String,
val password: String,
)
// ── Character roster + sheet ─────────────────────────────────────────────────
/** `GET /player/shard/roster/:account` — the account's characters (incl. offline). */
@Serializable
data class RosterDto(
val acct: String? = null,
val chars: List<RosterCharDto> = emptyList(),
)
/** One character in a roster; the picker fetches the full sheet on demand. */
@Serializable
data class RosterCharDto(
val slot: Int? = null,
val serial: String = "",
val name: String? = null,
val body: Int? = null,
val online: Boolean = false,
)
/**
* `GET /player/shard/char/:serial` — a character sheet. `guild` / `governorOf` are
* best-effort cross-links the backend decorates in (never fail the sheet).
*/
@Serializable
data class CharProfileDto(
val serial: String? = null,
val name: String? = null,
val title: String? = null,
val online: Boolean = false,
val acct: String? = null,
val stats: CharStatsDto? = null,
val skills: List<SkillDto> = emptyList(),
val equipment: List<EquipmentDto> = emptyList(),
val titles: TitlesDto? = null,
val guild: GuildRefDto? = null,
val governorOf: List<String> = emptyList(),
)
@Serializable
data class CharStatsDto(
val str: Int? = null,
val dex: Int? = null,
val int: Int? = null,
val hits: Int? = null,
val hitsMax: Int? = null,
val mana: Int? = null,
val manaMax: Int? = null,
val stam: Int? = null,
val stamMax: Int? = null,
val resist: ResistDto? = null,
)
@Serializable
data class ResistDto(
val phys: Int? = null,
val fire: Int? = null,
val cold: Int? = null,
val pois: Int? = null,
val energy: Int? = null,
)
/**
* A skill line. `base` is the trained value, `value` includes item/temp bonuses,
* `cap` is the cap — do NOT assume base ≤ cap (GM chars exceed it). Doubles, as the
* shard reports tenths.
*/
@Serializable
data class SkillDto(
val n: String? = null,
val base: Double? = null,
val value: Double? = null,
val cap: Double? = null,
)
/**
* An equipped item. Names are usually clilocs (numeric), not strings, and the app
* ships no cliloc table, so the text-only sheet renders layer + id + hue + mods.
* [mods] is a flattened map of non-zero AOS attributes (empty for plain items);
* kept as a raw object since values may be numbers or strings.
*/
@Serializable
data class EquipmentDto(
val serial: String? = null,
val layer: String? = null,
val itemId: Int? = null,
val hue: Int? = null,
val mods: JsonObject? = null,
)
/**
* Display titles (Protocol 2.0). `selected` is the index into `reward` currently
* shown (-1 if none); `reward` entries may be a cliloc number-as-string or a
* literal — numeric ones are skipped without a cliloc table (as the website does).
*/
@Serializable
data class TitlesDto(
val selected: Int? = null,
val reward: List<String> = emptyList(),
val fameKarma: String? = null,
val skill: String? = null,
)
/** The guild a character leads (cross-linked from board data). */
@Serializable
data class GuildRefDto(
val name: String? = null,
val abbr: String? = null,
)
// ── Player vendors + sales ───────────────────────────────────────────────────
/** `GET /player/shard/vendors/:account` — every player vendor on the account. */
@Serializable
data class VendorSnapshotDto(
val acct: String? = null,
val vendors: List<VendorDto> = emptyList(),
)
@Serializable
data class VendorDto(
val serial: String? = null,
val shopName: String? = null,
val holdGold: Long? = null,
val ownerSerial: String? = null,
val map: String? = null,
val x: Int? = null,
val y: Int? = null,
val listings: List<VendorListingDto> = emptyList(),
)
/** A single vendor listing. Item names are clilocs (see [EquipmentDto]); text-only. */
@Serializable
data class VendorListingDto(
val serial: String? = null,
val itemId: Int? = null,
val amount: Int? = null,
val price: Long? = null,
val forSale: Boolean = false,
)
/** `GET /player/shard/sales` — a player-vendor sale, visible only to the owner. */
@Serializable
data class VendorSaleDto(
/** Sale time, epoch ms. */
val t: Long? = null,
val itemType: String? = null,
val amount: Int? = null,
val price: Long? = null,
val commission: Int? = null,
val ownerAcct: String? = null,
)
// ── Player houses ────────────────────────────────────────────────────────────
/**
* `GET /player/shard/houses` — the caller's OWN houses, with full decay/IDOC
* detail (their own property). Serial is a hex string here.
*/
@Serializable
data class PlayerHouseDto(
val serial: String = "",
val stage: String? = null,
val map: String? = null,
val x: Int? = null,
val y: Int? = null,
val z: Int? = null,
val region: String? = null,
val name: String? = null,
val ownerSerial: String? = null,
val ownerAcct: String? = null,
val builtOn: String? = null,
val lastRefreshed: String? = null,
val isIdoc: Boolean = false,
val updatedAt: String? = null,
)

View File

@@ -55,6 +55,17 @@ 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.
@@ -67,4 +78,6 @@ 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(),
)

View File

@@ -0,0 +1,169 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonObject
/**
* DTOs for the public shard widgets (PLAN.md §6.2). Shapes mirror the website's
* `public/shard.controller.js` responses and the live SSE frames emitted by
* `utils/shardBroadcast.js`. The champ/guild/governor board reads return the
* stored event payload verbatim (a permissive object), so only the fields the app
* renders are modeled; unknown keys are ignored by the JSON parser, and the live
* `*.update` frames on `/public/shard/stream` decode into these same DTOs.
*/
/** A game actor (player/leader/governor) as embedded in board payloads. */
@Serializable
data class ActorDto(
val serial: Long? = null,
val name: String? = null,
val acct: String? = null,
val webId: Long? = null,
) {
/** Best display label for this actor. */
val label: String get() = name ?: acct ?: "Someone"
}
/** A gold-supply sample (`economy.supply`), oldest → newest in the series. */
@Serializable
data class EconomySampleDto(
val accounts: Int? = null,
val gold: Double? = null,
val t: Long? = null,
)
/** `GET /public/shard/status` — connection state + online count + latest economy. */
@Serializable
data class ShardStatusDto(
val enabled: Boolean = false,
/** Sidecar link state: `connected` / `disconnected` / … */
val status: String? = null,
/** Whether the in-game plugin is currently connected to the sidecar. */
val pluginConnected: Boolean = false,
/** ISO timestamp of the last ingested event, or null. */
val lastEventAt: String? = null,
val onlineCount: Int = 0,
val economy: EconomySampleDto? = null,
) {
/** True when the shard is live (link enabled and the plugin is connected). */
val isOnline: Boolean get() = enabled && pluginConnected
}
/**
* `GET /public/shard/feed` — a stored notable event. The domain fields live under
* [payload]; the live SSE frames carry those same fields at the top level (see
* `ShardEventText`).
*/
@Serializable
data class FeedEventDto(
val id: Long = 0,
val kind: String = "",
val t: Long? = null,
val bootId: String? = null,
val payload: JsonObject? = null,
val createdAt: String? = null,
)
/**
* `GET /public/shard/online` — a staff member currently in-world. Location is only
* present for privileged viewers server-side; anonymous/app callers see name+serial.
*/
@Serializable
data class OnlineStaffDto(
val serial: Long? = null,
val name: String? = null,
val map: String? = null,
val x: Int? = null,
val y: Int? = null,
val z: Int? = null,
)
/**
* A house on the public IDOC board (`GET /public/shard/houses`) — location only.
* Owner/price/decay detail is staff-only and never reaches the app.
*/
@Serializable
data class HouseDto(
val serial: Long = 0,
val name: String? = null,
val region: String? = null,
val map: String? = null,
val x: Int? = null,
val y: Int? = null,
val z: Int? = null,
val isIdoc: Boolean = false,
)
/**
* A champion-spawn board entry (`GET /public/shard/champs` + live `champ.update`).
* Three families share the board (`category`: champion / mini / sea); the
* category-specific fields are all nullable.
*/
@Serializable
data class ChampDto(
val serial: Long = 0,
val category: String? = null,
val type: String? = null,
val name: String? = null,
val status: String? = null,
val active: Boolean = false,
val map: String? = null,
val x: Int? = null,
val y: Int? = null,
val z: Int? = null,
val bossUp: Boolean = false,
val boss: String? = null,
val level: Int? = null,
val maxLevel: Int? = null,
val kills: Int? = null,
val maxKills: Int? = null,
val hits: Long? = null,
val hitsMax: Long? = null,
val restartAt: String? = null,
val t: Long? = null,
)
/** A guild board entry (`GET /public/shard/guilds` + live `guild.update`). */
@Serializable
data class GuildDto(
val id: Long = 0,
val name: String? = null,
val abbr: String? = null,
val members: Int? = null,
val online: Int? = null,
val alliance: String? = null,
val leader: ActorDto? = null,
val t: Long? = null,
)
/** A town-governor board entry (`GET /public/shard/governors` + live `city.update`). */
@Serializable
data class GovernorDto(
val city: String = "",
val governor: ActorDto? = null,
val governorElect: ActorDto? = null,
val electionPhase: String? = null,
val t: Long? = null,
)
/** One term in a city's governor ledger (`GET /public/shard/governors/:city/history`). */
@Serializable
data class GovernorTermDto(
val city: String? = null,
val governor: ActorDto? = null,
val startedAt: Long? = null,
val endedAt: Long? = null,
val votes: Int? = null,
)
/** `GET /public/shard/presence` — the online-population aggregate (live `presence.online`). */
@Serializable
data class PresenceDto(
val count: Int = 0,
val byFacet: Map<String, Int> = emptyMap(),
val byRegion: Map<String, Int> = emptyMap(),
val t: Long? = null,
)

View File

@@ -0,0 +1,42 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.api.dto
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
/**
* Wire shapes for the Mobile SSO Authorization Bridge (PLAN.md §4.2, M9). The
* success payload of `/auth/mobile/sso/exchange` is the shared [MobileTokenResponse]
* (same pair as `/auth/mobile/login`) — this file only adds the two shapes unique
* to the bridge. Every DTO ignores unknown keys (NetworkModule's lenient Json), so
* additive backend fields stay safe (§8).
*/
/**
* One entry of `GET /auth/providers` — public discovery, never secrets. [icon] is
* the provider kind (`google` | `discord` | `oidc` | `oauth2`); the app renders a
* button per provider from this list rather than hardcoding a set. [loginUrl] is
* the *website* start path (unused by the app, which builds its own
* `/auth/mobile/sso/start` URL); kept so the shape matches the backend exactly.
*/
@Serializable
data class SsoProviderDto(
val id: String,
val name: String,
val icon: String? = null,
val loginUrl: String? = null,
val priority: Int? = null,
)
/**
* `POST /auth/mobile/sso/exchange` body — the one-time authorization code from the
* callback deep link plus the PKCE verifier stashed at `/start` (Layer B). Wire
* name is snake_case to match the backend's `{ code, code_verifier }`.
*/
@Serializable
data class MobileSsoExchangeRequest(
val code: String,
@SerialName("code_verifier") val codeVerifier: String,
)

View File

@@ -0,0 +1,51 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.core.result.safeApiCall
import com.runicgateway.app.data.api.MeApi
import com.runicgateway.app.data.api.dto.ChangePasswordRequest
import com.runicgateway.app.data.api.dto.ChangeUsernameRequest
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
import com.runicgateway.app.data.api.dto.PlayerAccountDto
import com.runicgateway.app.data.api.dto.TotpCodeRequest
import com.runicgateway.app.data.api.dto.TotpSetupDto
import com.runicgateway.app.data.api.dto.TotpStateDto
import com.runicgateway.app.data.api.dto.UsernameResponse
import javax.inject.Inject
import javax.inject.Singleton
/**
* Self-service account management over the role-agnostic `/auth/me/account*`
* surface (PLAN.md §6.3, §6.4). Every call returns a typed [ApiResult] so the
* screens can map known statuses (409 taken, 400 wrong password / invalid code,
* 429 rate-limited) to friendly copy without a repository ever throwing (§7).
*/
@Singleton
class AccountRepository @Inject constructor(
private val api: MeApi,
) {
suspend fun getAccount(): ApiResult<PlayerAccountDto> = safeApiCall { api.getAccount() }
suspend fun changeUsername(username: String): ApiResult<UsernameResponse> =
safeApiCall { api.changeUsername(ChangeUsernameRequest(username)) }
/** [currentPassword] is null only for an SSO account setting its first password. */
suspend fun changePassword(newPassword: String, currentPassword: String?): ApiResult<Unit> =
safeApiCall { api.changePassword(ChangePasswordRequest(newPassword, currentPassword)) }
suspend fun totpSetup(): ApiResult<TotpSetupDto> = safeApiCall { api.totpSetup() }
suspend fun totpEnable(code: String): ApiResult<TotpStateDto> =
safeApiCall { api.totpEnable(TotpCodeRequest(code)) }
suspend fun totpDisable(code: String): ApiResult<TotpStateDto> =
safeApiCall { api.totpDisable(TotpCodeRequest(code)) }
suspend fun identities(): ApiResult<List<LinkedIdentityDto>> = safeApiCall { api.identities() }
suspend fun unlinkIdentity(provider: String): ApiResult<Unit> =
safeApiCall { api.unlinkIdentity(provider) }
}

View File

@@ -0,0 +1,143 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.core.push.PushManager
import com.runicgateway.app.data.api.AuthApi
import com.runicgateway.app.data.api.SsoApi
import com.runicgateway.app.data.api.dto.MobileLoginRequest
import com.runicgateway.app.data.api.dto.MobileLogoutRequest
import com.runicgateway.app.data.api.dto.MobileTokenResponse
import com.runicgateway.app.data.api.dto.SsoProviderDto
import com.runicgateway.app.data.api.dto.TotpRequiredError
import kotlinx.coroutines.CancellationException
import kotlinx.serialization.json.Json
import retrofit2.Response
import java.io.IOException
import javax.inject.Inject
import javax.inject.Singleton
/**
* Native username/password (+TOTP) auth — the app's only native credential flow
* (PLAN.md §4.1). It drives the [SessionManager]: a successful login establishes
* the session; logout revokes it. Registration/invite/reset/SSO are website
* hand-offs (§4.2), not here.
*/
@Singleton
class AuthRepository @Inject constructor(
private val authApi: AuthApi,
private val ssoApi: SsoApi,
private val sessionManager: SessionManager,
private val pushManager: PushManager,
private val json: Json,
) {
/**
* The shard's enabled SSO providers for the native login buttons (§4.2). Public
* discovery, never secrets. Returns an empty list on any failure — the login
* screen then keeps the website hand-off fallback rather than showing nothing.
*/
suspend fun ssoProviders(): List<SsoProviderDto> = try {
ssoApi.providers()
} catch (e: CancellationException) {
throw e
} catch (_: Exception) {
emptyList()
}
/** Outcome of a login attempt (§4.1). */
sealed interface LoginResult {
data object Success : LoginResult
/** The account has 2FA on — reveal the code field and resubmit with a code. */
data object TotpRequired : LoginResult
data object InvalidCredentials : LoginResult
/** Guarded by per-IP backoff → slowdown → hard cap; back off and retry. */
data object RateLimited : LoginResult
/** Any other server failure (5xx / unexpected). */
data object ServerError : LoginResult
/** No answer — offline, DNS, TLS, timeout. */
data object NetworkError : LoginResult
}
suspend fun login(username: String, password: String, code: String? = null): LoginResult {
val response: Response<MobileTokenResponse> = try {
authApi.login(MobileLoginRequest(username = username, password = password, code = code))
} catch (e: CancellationException) {
throw e
} catch (_: IOException) {
return LoginResult.NetworkError
}
if (response.isSuccessful) {
val body = response.body() ?: return LoginResult.ServerError
sessionManager.onSignedIn(body.accessToken, body.refreshToken, body.user)
return LoginResult.Success
}
return when (response.code()) {
401 -> if (isTotpRequired(response)) LoginResult.TotpRequired else LoginResult.InvalidCredentials
429 -> LoginResult.RateLimited
else -> LoginResult.ServerError
}
}
/**
* Revoke this session (or, with [allDevices], every session) and clear local
* tokens (§4.3). Best-effort: the local session is torn down even if the
* network call fails, so the user is always signed out locally.
*/
suspend fun logout(allDevices: Boolean = false) {
// Deregister this device's push endpoint while the bearer is still valid, so
// no orphan device row is left behind (§11). Keeps the opt-in intent so push
// resumes on the next sign-in; best-effort, never blocks the logout.
try {
pushManager.deregisterDevice()
} catch (e: CancellationException) {
throw e
} catch (_: Exception) {
// Ignore — local session teardown proceeds regardless.
}
val refreshToken = sessionManager.currentRefreshToken()
try {
authApi.logout(MobileLogoutRequest(refreshToken = refreshToken, all = allDevices))
} catch (e: CancellationException) {
throw e
} catch (_: Exception) {
// Ignore — we still drop the local session below.
}
sessionManager.onSignedOut()
}
/**
* Re-validate the session against `GET /auth/me` on app resume (§4.3). A
* success refreshes the cached role (roles change server-side); a `401` that
* survives the silent refresh means the session is dead → sign out. Transient
* failures are ignored so a flaky network doesn't bounce the user.
*/
suspend fun revalidate() {
if (!sessionManager.isSignedIn) return
try {
val me = authApi.me()
sessionManager.onUserRefreshed(me.user)
} catch (e: CancellationException) {
throw e
} catch (e: retrofit2.HttpException) {
if (e.code() == 401) sessionManager.onSignedOut()
} catch (_: IOException) {
// Offline — keep the session; the next authed call will re-check.
}
}
private fun isTotpRequired(response: Response<*>): Boolean = try {
val raw = response.errorBody()?.string()
!raw.isNullOrBlank() && json.decodeFromString<TotpRequiredError>(raw).totpRequired
} catch (_: Exception) {
false
}
}

View File

@@ -3,6 +3,7 @@
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.core.net.BaseUrlHolder
import com.runicgateway.app.core.net.ServerUrl
import com.runicgateway.app.core.prefs.ServerPreferences
@@ -24,6 +25,8 @@ class ConnectionRepository @Inject constructor(
private val api: PublicApi,
private val prefs: ServerPreferences,
private val baseUrlHolder: BaseUrlHolder,
private val sessionManager: SessionManager,
private val pushManager: com.runicgateway.app.core.push.PushManager,
private val config: com.runicgateway.app.core.AppConfig,
) {
@@ -34,6 +37,13 @@ class ConnectionRepository @Inject constructor(
/** Reachable and 2xx, but not a Runic Gateway backend (wrong version identity). */
data object NotRunicGateway : ProbeResult
/**
* A Runic Gateway backend, but speaking an API version this app build does
* not support (§3 version guard) — refuse rather than mis-render. [serverApi]
* is what the site reported; [supportedApi] is what this app speaks.
*/
data class VersionMismatch(val serverApi: String, val supportedApi: String) : ProbeResult
data class ServerError(val status: Int) : ProbeResult
data class Unreachable(val cause: Throwable) : ProbeResult
}
@@ -66,14 +76,15 @@ class ConnectionRepository @Inject constructor(
?: return ProbeResult.InvalidUrl(ServerUrl.Reason.MALFORMED)
return when (val result = safeApiCall { api.probeStatus(statusUrl) }) {
is ApiResult.Ok -> {
if (!result.data.version.service.equals(RUNIC_SERVICE_ID, ignoreCase = true)) {
ProbeResult.NotRunicGateway
} else {
is ApiResult.Ok -> when (val verdict = evaluateVersion(result.data.version)) {
is VersionVerdict.Ok -> {
prefs.setBaseUrl(normalized.toString())
baseUrlHolder.set(normalized)
ProbeResult.Success(result.data)
}
is VersionVerdict.NotRunicGateway -> ProbeResult.NotRunicGateway
is VersionVerdict.Mismatch ->
ProbeResult.VersionMismatch(serverApi = verdict.serverApi, supportedApi = SUPPORTED_API)
}
is ApiResult.HttpError -> ProbeResult.ServerError(result.status)
is ApiResult.NetworkError -> ProbeResult.Unreachable(result.cause)
@@ -81,15 +92,56 @@ class ConnectionRepository @Inject constructor(
}
/**
* Hard reset for a Settings → Server switch (§3): clear the saved URL and
* deactivate it. Token/cache clearing joins here in M3 once sessions exist.
* Hard reset for a Settings → Server switch (§3): sign out (clear stored
* tokens), clear the saved URL, and deactivate it — the app returns to a
* signed-out state against the new host.
*/
suspend fun disconnect() {
// Deregister the push endpoint on the current (old) host while still authed,
// then clear the shard's ntfy URL — the new host advertises its own (§11).
try {
pushManager.deregisterDevice()
} catch (_: Exception) {
// Best-effort; the reset proceeds regardless.
}
pushManager.setNtfyUrl(null)
sessionManager.onSignedOut()
prefs.clear()
baseUrlHolder.set(null)
}
private companion object {
/** The pure outcome of inspecting a probed site's [VersionDto] (§3 version guard). */
internal sealed interface VersionVerdict {
data object Ok : VersionVerdict
data object NotRunicGateway : VersionVerdict
data class Mismatch(val serverApi: String) : VersionVerdict
}
internal companion object {
const val RUNIC_SERVICE_ID = "runic-gateway"
/** The backend API major version this app build speaks (matches `/public/version` `api`). */
const val SUPPORTED_API = "v1"
/**
* Decide whether a probed site is a Runic Gateway backend this app can talk
* to. Pure (no I/O) so it is unit-testable without a live site. Lenient on a
* blank `api` (an older backend that predates version surfacing); refuses only
* an API version we positively know we can't parse (e.g. a future `v2`).
*/
fun evaluateVersion(
version: com.runicgateway.app.data.api.dto.VersionDto,
supportedApi: String = SUPPORTED_API,
): VersionVerdict {
if (!version.service.trim().equals(RUNIC_SERVICE_ID, ignoreCase = true)) {
return VersionVerdict.NotRunicGateway
}
val serverApi = version.api.trim()
return when {
serverApi.isEmpty() -> VersionVerdict.Ok
serverApi.equals(supportedApi, ignoreCase = true) -> VersionVerdict.Ok
else -> VersionVerdict.Mismatch(serverApi)
}
}
}
}

View File

@@ -0,0 +1,40 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.core.result.safeApiCall
import com.runicgateway.app.data.api.NotificationsApi
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
import com.runicgateway.app.data.api.dto.PushDeviceDto
import com.runicgateway.app.data.api.dto.RegisterDeviceRequest
import javax.inject.Inject
import javax.inject.Singleton
/**
* Device registration + per-user stream subscriptions over the opt-in push surface
* (PLAN.md §11, M7 Part 2). Every call returns a typed [ApiResult] so the screen
* and the [com.runicgateway.app.core.push.PushManager] degrade gracefully — a `400`
* (endpoint off the shard's allow-set) or a down backend never throws (§7).
*/
@Singleton
class NotificationsRepository @Inject constructor(
private val api: NotificationsApi,
) {
suspend fun registerDevice(endpoint: String, platform: String?): ApiResult<PushDeviceDto> =
safeApiCall { api.registerDevice(RegisterDeviceRequest(endpoint = endpoint, platform = platform)) }
suspend fun listDevices(): ApiResult<List<PushDeviceDto>> = safeApiCall { api.listDevices() }
suspend fun deleteDevice(id: Long): ApiResult<Unit> = safeApiCall { api.deleteDevice(id) }
suspend fun streams(): ApiResult<NotificationStreamsDto> = safeApiCall { api.streams() }
suspend fun subscriptions(): ApiResult<NotificationSubscriptionsDto> =
safeApiCall { api.subscriptions() }
suspend fun setSubscriptions(streams: List<String>): ApiResult<NotificationSubscriptionsDto> =
safeApiCall { api.putSubscriptions(NotificationSubscriptionsDto(streams)) }
}

View File

@@ -0,0 +1,50 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.core.result.safeApiCall
import com.runicgateway.app.data.api.PlayerShardApi
import com.runicgateway.app.data.api.dto.CharProfileDto
import com.runicgateway.app.data.api.dto.CreateGameAccountRequest
import com.runicgateway.app.data.api.dto.PlayerHouseDto
import com.runicgateway.app.data.api.dto.RosterDto
import com.runicgateway.app.data.api.dto.ShardLinkDto
import com.runicgateway.app.data.api.dto.ShardLinkRequest
import com.runicgateway.app.data.api.dto.ShardLinkResultDto
import com.runicgateway.app.data.api.dto.VendorSaleDto
import com.runicgateway.app.data.api.dto.VendorSnapshotDto
import javax.inject.Inject
import javax.inject.Singleton
/**
* A player's own game data + game-account linking (PLAN.md §6.3), over the
* bearer-gated `/player/shard/…` surface. Every read returns a typed [ApiResult]
* so a down shard (`503`) renders as "offline, retry" and a not-linked account
* (`403`) is handled cleanly — the repository never throws for an expected
* failure (§7). Ownership is enforced server-side.
*/
@Singleton
class PlayerShardRepository @Inject constructor(
private val api: PlayerShardApi,
) {
suspend fun link(code: String): ApiResult<ShardLinkResultDto> =
safeApiCall { api.link(ShardLinkRequest(code)) }
suspend fun createAccount(account: String, password: String): ApiResult<ShardLinkResultDto> =
safeApiCall { api.createAccount(CreateGameAccountRequest(account, password)) }
suspend fun accounts(): ApiResult<List<ShardLinkDto>> = safeApiCall { api.accounts() }
suspend fun roster(account: String): ApiResult<RosterDto> = safeApiCall { api.roster(account) }
suspend fun char(serial: String): ApiResult<CharProfileDto> = safeApiCall { api.char(serial) }
suspend fun vendors(account: String): ApiResult<VendorSnapshotDto> =
safeApiCall { api.vendors(account) }
suspend fun sales(): ApiResult<List<VendorSaleDto>> = safeApiCall { api.sales() }
suspend fun houses(): ApiResult<List<PlayerHouseDto>> = safeApiCall { api.houses() }
}

View File

@@ -0,0 +1,81 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.data.repository
import com.runicgateway.app.core.net.ShardStreamClient
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.core.result.safeApiCall
import com.runicgateway.app.data.api.PublicApi
import com.runicgateway.app.data.api.dto.ChampDto
import com.runicgateway.app.data.api.dto.EconomySampleDto
import com.runicgateway.app.data.api.dto.FeedEventDto
import com.runicgateway.app.data.api.dto.GovernorDto
import com.runicgateway.app.data.api.dto.GovernorTermDto
import com.runicgateway.app.data.api.dto.GuildDto
import com.runicgateway.app.data.api.dto.HouseDto
import com.runicgateway.app.data.api.dto.OnlineStaffDto
import com.runicgateway.app.data.api.dto.PresenceDto
import com.runicgateway.app.data.api.dto.ShardStatusDto
import kotlinx.coroutines.flow.Flow
import kotlinx.serialization.KSerializer
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonObject
import javax.inject.Inject
import javax.inject.Singleton
/**
* The public shard widgets (PLAN.md §6.2): point-in-time board snapshots over
* the `/public/shard/…` GETs plus the live SSE stream. Every read returns a typed
* [ApiResult] so a down shard renders as offline (§7); [liveEvents] is the shared
* SSE feed the boards merge in place. Live `*.update` frames decode into the same
* DTOs as the snapshot reads via the `*Frame` decoders.
*/
@Singleton
class ShardRepository @Inject constructor(
private val api: PublicApi,
private val stream: ShardStreamClient,
private val json: Json,
) {
// ── Snapshots ────────────────────────────────────────────────────────
suspend fun status(): ApiResult<ShardStatusDto> = safeApiCall { api.getShardStatus() }
suspend fun feed(limit: Int = 40): ApiResult<List<FeedEventDto>> =
safeApiCall { api.getShardFeed(limit = limit) }
suspend fun economy(limit: Int = 100): ApiResult<List<EconomySampleDto>> =
safeApiCall { api.getShardEconomy(limit) }
suspend fun online(): ApiResult<List<OnlineStaffDto>> = safeApiCall { api.getShardOnline() }
suspend fun presence(): ApiResult<PresenceDto> = safeApiCall { api.getShardPresence() }
suspend fun champs(): ApiResult<List<ChampDto>> = safeApiCall { api.getShardChamps() }
suspend fun guilds(): ApiResult<List<GuildDto>> = safeApiCall { api.getShardGuilds() }
suspend fun governors(): ApiResult<List<GovernorDto>> = safeApiCall { api.getShardGovernors() }
suspend fun governorHistory(city: String, limit: Int = 25): ApiResult<List<GovernorTermDto>> =
safeApiCall { api.getShardGovernorHistory(city, limit) }
suspend fun houses(): ApiResult<List<HouseDto>> = safeApiCall { api.getShardHouses() }
// ── Live stream ──────────────────────────────────────────────────────
/** The shared public SSE feed (safe kinds only), reconnecting with backoff (§7). */
fun liveEvents(): Flow<ShardStreamEvent> = stream.events()
// Decode a live `*.update` frame into the board DTO it mirrors; null on shape
// mismatch so a malformed frame is skipped rather than crashing the board.
fun champFrame(obj: JsonObject): ChampDto? = decode(obj, ChampDto.serializer())
fun guildFrame(obj: JsonObject): GuildDto? = decode(obj, GuildDto.serializer())
fun governorFrame(obj: JsonObject): GovernorDto? = decode(obj, GovernorDto.serializer())
fun presenceFrame(obj: JsonObject): PresenceDto? = decode(obj, PresenceDto.serializer())
private fun <T> decode(obj: JsonObject, serializer: KSerializer<T>): T? = try {
json.decodeFromJsonElement(serializer, obj)
} catch (_: Exception) {
null
}
}

View File

@@ -6,10 +6,18 @@ package com.runicgateway.app.di
import android.os.Build
import com.jakewharton.retrofit2.converter.kotlinx.serialization.asConverterFactory
import com.runicgateway.app.BuildConfig
import com.runicgateway.app.core.net.AuthInterceptor
import com.runicgateway.app.core.net.BaseUrlHolder
import com.runicgateway.app.core.net.HostSelectionInterceptor
import com.runicgateway.app.core.net.TokenAuthenticator
import com.runicgateway.app.core.net.UserAgentInterceptor
import com.runicgateway.app.data.api.AuthApi
import com.runicgateway.app.data.api.AuthRefreshApi
import com.runicgateway.app.data.api.MeApi
import com.runicgateway.app.data.api.NotificationsApi
import com.runicgateway.app.data.api.PlayerShardApi
import com.runicgateway.app.data.api.PublicApi
import com.runicgateway.app.data.api.SsoApi
import dagger.Module
import dagger.Provides
import dagger.hilt.InstallIn
@@ -42,16 +50,25 @@ object NetworkModule {
return UserAgentInterceptor(ua)
}
/**
* The main client every API and the SSE stream ride on. Order: identify (UA),
* retarget onto the configured shard host, then attach the bearer; the
* [TokenAuthenticator] handles silent refresh-on-401 (§4.1). Logging sits last
* so it observes the final, authed request.
*/
@Provides
@Singleton
fun provideOkHttpClient(
hostSelectionInterceptor: HostSelectionInterceptor,
userAgentInterceptor: UserAgentInterceptor,
authInterceptor: AuthInterceptor,
tokenAuthenticator: TokenAuthenticator,
): OkHttpClient {
val builder = OkHttpClient.Builder()
// User-Agent first, then host retargeting, so both apply to every call.
.addInterceptor(userAgentInterceptor)
.addInterceptor(hostSelectionInterceptor)
.addInterceptor(authInterceptor)
.authenticator(tokenAuthenticator)
if (BuildConfig.DEBUG) {
builder.addInterceptor(
@@ -75,4 +92,55 @@ object NetworkModule {
@Provides
@Singleton
fun providePublicApi(retrofit: Retrofit): PublicApi = retrofit.create(PublicApi::class.java)
@Provides
@Singleton
fun provideAuthApi(retrofit: Retrofit): AuthApi = retrofit.create(AuthApi::class.java)
/** Native SSO discovery + code exchange (§4.2, M9) — on the main client. */
@Provides
@Singleton
fun provideSsoApi(retrofit: Retrofit): SsoApi = retrofit.create(SsoApi::class.java)
/** Role-agnostic self-service (§6.4) — bearer-authed on the main client. */
@Provides
@Singleton
fun provideMeApi(retrofit: Retrofit): MeApi = retrofit.create(MeApi::class.java)
/** A player's own game data + linking (§6.3) — bearer-authed on the main client. */
@Provides
@Singleton
fun providePlayerShardApi(retrofit: Retrofit): PlayerShardApi =
retrofit.create(PlayerShardApi::class.java)
/** Opt-in push devices + subscriptions (§11, M7) — bearer-authed on the main client. */
@Provides
@Singleton
fun provideNotificationsApi(retrofit: Retrofit): NotificationsApi =
retrofit.create(NotificationsApi::class.java)
/**
* Token refresh runs on its own **bare** client — UA + host retargeting only,
* no auth interceptor and no authenticator — so a refresh can never recurse
* back through [TokenAuthenticator] (§4.3). This throwaway client/Retrofit is
* not exposed as a bean, so there is no ambiguous [OkHttpClient] binding.
*/
@Provides
@Singleton
fun provideAuthRefreshApi(
hostSelectionInterceptor: HostSelectionInterceptor,
userAgentInterceptor: UserAgentInterceptor,
json: Json,
): AuthRefreshApi {
val bareClient = OkHttpClient.Builder()
.addInterceptor(userAgentInterceptor)
.addInterceptor(hostSelectionInterceptor)
.build()
val retrofit = Retrofit.Builder()
.baseUrl(BaseUrlHolder.PLACEHOLDER_BASE_URL)
.client(bareClient)
.addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
.build()
return retrofit.create(AuthRefreshApi::class.java)
}
}

View File

@@ -0,0 +1,22 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.di
import com.runicgateway.app.core.auth.EncryptedTokenStore
import com.runicgateway.app.core.auth.TokenStore
import dagger.Binds
import dagger.Module
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import javax.inject.Singleton
/** Binds the at-rest token store to its EncryptedSharedPreferences impl (§4.3). */
@Module
@InstallIn(SingletonComponent::class)
abstract class StorageModule {
@Binds
@Singleton
abstract fun bindTokenStore(impl: EncryptedTokenStore): TokenStore
}

View File

@@ -6,6 +6,7 @@ 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
@@ -27,6 +28,7 @@ class AppViewModel @Inject constructor(
private val connectionRepository: ConnectionRepository,
private val settingsRepository: SettingsRepository,
private val baseUrlHolder: BaseUrlHolder,
private val pushManager: PushManager,
) : ViewModel() {
sealed interface AppState {
@@ -66,8 +68,16 @@ class AppViewModel @Inject constructor(
}
}
private suspend fun loadBrand(): BrandDto? =
(settingsRepository.getSettings() as? ApiResult.Ok)?.data?.brand
/**
* Load public settings for branding and feed the shard's push relay URL into the
* [PushManager] (§11) — its arrival is what lets push re-register after a restart
* or sign-in. Returns the brand block (null if settings couldn't be loaded).
*/
private suspend fun loadBrand(): BrandDto? {
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data
pushManager.setNtfyUrl(settings?.push?.ntfyUrl)
return settings?.brand
}
/**
* Resolve a possibly site-relative asset path (branding logos, post images)

View File

@@ -4,7 +4,6 @@
package com.runicgateway.app.ui
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.material.icons.Icons
@@ -15,6 +14,7 @@ import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.HorizontalDivider
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.ModalDrawerSheet
import androidx.compose.material3.ModalNavigationDrawer
import androidx.compose.material3.NavigationDrawerItem
@@ -22,13 +22,20 @@ import androidx.compose.material3.NavigationDrawerItemDefaults
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.material3.TopAppBar
import androidx.compose.material3.TopAppBarDefaults
import androidx.compose.material3.rememberDrawerState
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.getValue
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.style.TextOverflow
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import androidx.hilt.navigation.compose.hiltViewModel
import androidx.lifecycle.compose.LifecycleResumeEffect
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import androidx.navigation.NavHostController
import androidx.navigation.NavType
import androidx.navigation.compose.NavHost
@@ -37,37 +44,48 @@ import androidx.navigation.compose.currentBackStackEntryAsState
import androidx.navigation.compose.rememberNavController
import androidx.navigation.navArgument
import com.runicgateway.app.R
import com.runicgateway.app.core.auth.Session
import com.runicgateway.app.data.api.dto.BrandDto
import com.runicgateway.app.ui.auth.AccountScreen
import com.runicgateway.app.ui.auth.LoginScreen
import com.runicgateway.app.ui.auth.roleLabelRes
import com.runicgateway.app.ui.contact.ContactScreen
import com.runicgateway.app.ui.home.HomeScreen
import com.runicgateway.app.ui.navigation.APP_MENU
import com.runicgateway.app.ui.navigation.Routes
import com.runicgateway.app.ui.navigation.visibleEntries
import com.runicgateway.app.ui.news.NewsScreen
import com.runicgateway.app.ui.news.PostScreen
import com.runicgateway.app.ui.notifications.NotificationsScreen
import com.runicgateway.app.ui.page.PageScreen
import com.runicgateway.app.ui.player.CharacterSheetScreen
import com.runicgateway.app.ui.player.CharactersScreen
import com.runicgateway.app.ui.player.MyHousesScreen
import com.runicgateway.app.ui.player.VendorsScreen
import com.runicgateway.app.ui.session.SessionViewModel
import com.runicgateway.app.ui.shard.ChampsScreen
import com.runicgateway.app.ui.shard.GovernorsScreen
import com.runicgateway.app.ui.shard.GuildsScreen
import com.runicgateway.app.ui.shard.HousesScreen
import com.runicgateway.app.ui.shard.ShardBoard
import com.runicgateway.app.ui.shard.ShardScreen
import com.runicgateway.app.ui.wiki.WikiPageScreen
import com.runicgateway.app.ui.wiki.WikiScreen
import kotlinx.coroutines.launch
/** A navigation menu entry (PLAN.md §5). For M1 every entry is public. */
private data class MenuEntry(val route: String, val labelRes: Int)
private val PUBLIC_MENU = listOf(
MenuEntry(Routes.HOME, R.string.menu_home),
MenuEntry(Routes.NEWS, R.string.menu_news),
MenuEntry(Routes.WIKI, R.string.menu_wiki),
MenuEntry(Routes.page("about"), R.string.menu_about),
MenuEntry(Routes.CONTACT, R.string.menu_contact),
)
/** Destinations that show the drawer (hamburger); others show a back arrow. */
private val TOP_LEVEL_ROUTES = setOf(
Routes.HOME, Routes.NEWS, Routes.WIKI, Routes.CONTACT, Routes.PAGE,
Routes.HOME, Routes.NEWS, Routes.WIKI, Routes.SHARD, Routes.CONTACT, Routes.PAGE, Routes.ACCOUNT,
Routes.NOTIFICATIONS,
Routes.PLAYER_CHARACTERS, Routes.PLAYER_VENDORS, Routes.PLAYER_HOUSES,
)
/**
* The main app shell once a shard site is configured (PLAN.md §5): one shared,
* declarative navigation drawer over the public content graph, plus the
* Settings → Server switch. The signed-in menu groups and auth toggle join in M3.
* declarative, access-level navigation drawer whose entries are filtered by the
* current session, plus the Sign in / Sign out toggle and the Settings → Server
* switch. The signed-in role is re-validated against the backend on every resume
* (§4.3), so a server-side demotion drops menu access promptly.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable
@@ -75,29 +93,57 @@ fun RunicApp(
brand: BrandDto?,
onChangeServer: () -> Unit,
modifier: Modifier = Modifier,
deepLinkStream: String? = null,
onDeepLinkConsumed: () -> Unit = {},
sessionViewModel: SessionViewModel = hiltViewModel(),
) {
val navController = rememberNavController()
val drawerState = rememberDrawerState(DrawerValue.Closed)
val scope = rememberCoroutineScope()
val session by sessionViewModel.session.collectAsStateWithLifecycle()
// Re-validate the cached role each time the app returns to the foreground (§4.3).
LifecycleResumeEffect(Unit) {
sessionViewModel.revalidate()
onPauseOrDispose { }
}
// A tapped push notification deep-links to its stream's screen (§11, item 7).
LaunchedEffect(deepLinkStream) {
val stream = deepLinkStream ?: return@LaunchedEffect
navController.navigate(Routes.forStream(stream)) {
popUpTo(Routes.HOME) { saveState = true }
launchSingleTop = true
}
onDeepLinkConsumed()
}
val backStackEntry by navController.currentBackStackEntryAsState()
val currentRoute = backStackEntry?.destination?.route
val isTopLevel = currentRoute in TOP_LEVEL_ROUTES
val entries = visibleEntries(APP_MENU, session)
ModalNavigationDrawer(
drawerState = drawerState,
gesturesEnabled = isTopLevel,
drawerContent = {
ModalDrawerSheet {
ModalDrawerSheet(drawerContainerColor = MaterialTheme.colorScheme.surfaceVariant) {
val drawerItemColors = NavigationDrawerItemDefaults.colors(
selectedContainerColor = MaterialTheme.colorScheme.secondaryContainer,
selectedTextColor = MaterialTheme.colorScheme.onSecondaryContainer,
unselectedTextColor = MaterialTheme.colorScheme.onSurface,
)
Spacer(Modifier.height(12.dp))
Text(
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
style = androidx.compose.material3.MaterialTheme.typography.titleLarge,
style = MaterialTheme.typography.titleLarge,
color = MaterialTheme.colorScheme.onSurface,
modifier = Modifier.padding(horizontal = 24.dp, vertical = 12.dp),
)
HorizontalDivider()
Spacer(Modifier.height(8.dp))
PUBLIC_MENU.forEach { entry ->
entries.forEach { entry ->
NavigationDrawerItem(
label = { Text(stringResource(entry.labelRes)) },
selected = currentRoute == entry.route,
@@ -105,10 +151,34 @@ fun RunicApp(
scope.launch { drawerState.close() }
navController.navigateTopLevel(entry.route)
},
colors = drawerItemColors,
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
)
}
HorizontalDivider(Modifier.padding(vertical = 8.dp))
// Sign in / Sign out toggles on the session (§5).
val signInLabel = if (session is Session.SignedIn) {
R.string.menu_sign_out
} else {
R.string.menu_sign_in
}
NavigationDrawerItem(
label = { Text(stringResource(signInLabel)) },
selected = false,
onClick = {
scope.launch { drawerState.close() }
if (session is Session.SignedIn) {
sessionViewModel.signOut()
navController.navigateTopLevel(Routes.HOME)
} else {
navController.navigate(Routes.LOGIN)
}
},
colors = drawerItemColors,
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
)
NavigationDrawerItem(
label = { Text(stringResource(R.string.menu_change_server)) },
selected = false,
@@ -116,6 +186,7 @@ fun RunicApp(
scope.launch { drawerState.close() }
onChangeServer()
},
colors = drawerItemColors,
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
)
}
@@ -125,10 +196,19 @@ fun RunicApp(
modifier = modifier,
topBar = {
TopAppBar(
colors = TopAppBarDefaults.topAppBarColors(
containerColor = MaterialTheme.colorScheme.surfaceVariant,
titleContentColor = MaterialTheme.colorScheme.onSurface,
navigationIconContentColor = MaterialTheme.colorScheme.onSurface,
actionIconContentColor = MaterialTheme.colorScheme.onSurface,
),
title = {
Text(
brand?.name?.takeIf { it.isNotBlank() }
?: stringResource(R.string.app_name),
text = (brand?.name?.takeIf { it.isNotBlank() }
?: stringResource(R.string.app_name)).uppercase(),
style = MaterialTheme.typography.titleSmall.copy(letterSpacing = 1.2.sp),
maxLines = 1,
overflow = TextOverflow.Ellipsis,
)
},
navigationIcon = {
@@ -151,6 +231,9 @@ fun RunicApp(
RunicNavHost(
navController = navController,
brand = brand,
session = session,
onSignOut = { sessionViewModel.signOut() },
onSignOutEverywhere = { sessionViewModel.signOut(allDevices = true) },
modifier = Modifier.padding(innerPadding),
)
}
@@ -161,6 +244,9 @@ fun RunicApp(
private fun RunicNavHost(
navController: NavHostController,
brand: BrandDto?,
session: Session,
onSignOut: () -> Unit,
onSignOutEverywhere: () -> Unit,
modifier: Modifier = Modifier,
) {
NavHost(
@@ -185,6 +271,22 @@ private fun RunicNavHost(
) {
PostScreen()
}
composable(Routes.SHARD) {
ShardScreen(onOpenBoard = { board ->
navController.navigate(
when (board) {
ShardBoard.CHAMPS -> Routes.SHARD_CHAMPS
ShardBoard.GUILDS -> Routes.SHARD_GUILDS
ShardBoard.GOVERNORS -> Routes.SHARD_GOVERNORS
ShardBoard.HOUSES -> Routes.SHARD_HOUSES
},
)
})
}
composable(Routes.SHARD_CHAMPS) { ChampsScreen() }
composable(Routes.SHARD_GUILDS) { GuildsScreen() }
composable(Routes.SHARD_GOVERNORS) { GovernorsScreen() }
composable(Routes.SHARD_HOUSES) { HousesScreen() }
composable(Routes.WIKI) {
WikiScreen(onOpenPage = { slug -> navController.navigate(Routes.wikiPage(slug)) })
}
@@ -203,6 +305,71 @@ private fun RunicNavHost(
composable(Routes.CONTACT) {
ContactScreen()
}
composable(Routes.LOGIN) {
LoginScreen(onSignedIn = { navController.popBackStack() })
}
composable(Routes.ACCOUNT) {
// Only meaningful while signed in; a sign-out (here or from the drawer)
// sends the user home rather than leaving a stale identity on screen.
when (val s = session) {
is Session.SignedIn -> AccountScreen(
username = s.user.username,
roleLabel = stringResource(roleLabelRes(s.user.role)),
onSignOut = onSignOut,
onSignOutEverywhere = onSignOutEverywhere,
)
Session.SignedOut -> LaunchedEffect(Unit) {
navController.navigateTopLevel(Routes.HOME)
}
}
}
composable(Routes.NOTIFICATIONS) {
// Signed-in only; a sign-out (or demotion) sends the user home rather than
// leaving stale settings up. The backend gates every call regardless (§5).
when (session) {
is Session.SignedIn -> NotificationsScreen()
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
}
}
// ── Player game data (§6.3) — reached from the player-only menu groups.
// The server enforces the player gate on every call; these screens simply
// render 401/403/503 as clean states (§7).
composable(Routes.PLAYER_CHARACTERS) {
PlayerGate(session, navController) {
CharactersScreen(onOpenChar = { serial -> navController.navigate(Routes.playerChar(serial)) })
}
}
composable(
route = Routes.PLAYER_CHAR,
arguments = listOf(navArgument(Routes.Args.SERIAL) { type = NavType.StringType }),
) {
CharacterSheetScreen()
}
composable(Routes.PLAYER_VENDORS) {
PlayerGate(session, navController) { VendorsScreen() }
}
composable(Routes.PLAYER_HOUSES) {
PlayerGate(session, navController) { MyHousesScreen() }
}
}
}
/**
* A UX guard for the player-only groups: while signed in, render [content]; if the
* session drops (sign-out, or a server-side demotion caught on resume, §4.3), send
* the user home instead of leaving a stale player screen up. The backend remains
* the authority — this only mirrors the menu's visibility rule.
*/
@Composable
private fun PlayerGate(
session: Session,
navController: NavHostController,
content: @Composable () -> Unit,
) {
when (session) {
is Session.SignedIn -> content()
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
}
}

View File

@@ -0,0 +1,362 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.auth
import android.graphics.BitmapFactory
import android.util.Base64
import androidx.annotation.StringRes
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material3.Button
import androidx.compose.material3.Card
import androidx.compose.material3.HorizontalDivider
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.OutlinedButton
import androidx.compose.material3.OutlinedTextField
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.asImageBitmap
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.input.KeyboardType
import androidx.compose.ui.text.input.PasswordVisualTransformation
import androidx.compose.ui.unit.dp
import androidx.compose.foundation.text.KeyboardOptions
import androidx.compose.ui.graphics.ImageBitmap
import androidx.hilt.navigation.compose.hiltViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import com.runicgateway.app.R
import com.runicgateway.app.core.auth.Role
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
import com.runicgateway.app.data.api.dto.PlayerAccountDto
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.auth.AccountViewModel.Feedback
import com.runicgateway.app.ui.auth.AccountViewModel.Section
import com.runicgateway.app.ui.components.ErrorView
import com.runicgateway.app.ui.components.LoadingView
import com.runicgateway.app.ui.components.PillTone
import com.runicgateway.app.ui.components.StatusPill
/**
* The signed-in account surface (PLAN.md §5, §6.3): identity + role, self-service
* over `/auth/me/account*` (change username/password, TOTP, linked identities),
* and the sign-out controls. Credential-provisioning flows (register / reset / SSO
* link) stay website hand-offs (§4.2) and are not rebuilt here.
*/
@Composable
fun AccountScreen(
username: String,
roleLabel: String,
onSignOut: () -> Unit,
onSignOutEverywhere: () -> Unit,
modifier: Modifier = Modifier,
viewModel: AccountViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
Column(
modifier = modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
.padding(16.dp),
) {
IdentityCard(username = username, roleLabel = roleLabel)
when (val account = state.account) {
is UiState.Loading -> LoadingView(Modifier.padding(top = 32.dp))
is UiState.Error -> ErrorView(account.kind, onRetry = viewModel::load, modifier = Modifier.padding(top = 32.dp))
is UiState.Success -> AccountSections(account.data, state, viewModel)
}
HorizontalDivider(Modifier.padding(vertical = 20.dp))
OutlinedButton(onClick = onSignOut, modifier = Modifier.fillMaxWidth()) {
Text(stringResource(R.string.account_sign_out))
}
TextButton(
onClick = onSignOutEverywhere,
modifier = Modifier.fillMaxWidth().padding(top = 4.dp),
) {
Text(stringResource(R.string.account_sign_out_all))
}
}
}
@Composable
private fun IdentityCard(username: String, roleLabel: String) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(20.dp)) {
Text(text = username, style = MaterialTheme.typography.titleLarge)
StatusPill(
text = roleLabel,
tone = PillTone.Info,
modifier = Modifier.padding(top = 8.dp),
)
}
}
}
@Composable
private fun AccountSections(
account: PlayerAccountDto,
state: AccountViewModel.State,
viewModel: AccountViewModel,
) {
UsernameSection(account, state, viewModel)
PasswordSection(account, state, viewModel)
TwoFactorSection(account, state, viewModel)
IdentitiesSection(state, viewModel)
}
@Composable
private fun SectionCard(@StringRes titleRes: Int, content: @Composable () -> Unit) {
Card(Modifier.fillMaxWidth().padding(top = 12.dp)) {
Column(Modifier.padding(16.dp)) {
Text(stringResource(titleRes), style = MaterialTheme.typography.titleMedium)
content()
}
}
}
@Composable
private fun UsernameSection(
account: PlayerAccountDto,
state: AccountViewModel.State,
viewModel: AccountViewModel,
) {
var username by rememberSaveable(account.username) { mutableStateOf(account.username) }
SectionCard(R.string.account_username_title) {
OutlinedTextField(
value = username,
onValueChange = { username = it },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.login_username)) },
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
Button(
onClick = { viewModel.changeUsername(username) },
enabled = !state.busy && username.trim() != account.username && username.trim().length >= 3,
modifier = Modifier.padding(top = 12.dp),
) { Text(stringResource(R.string.account_username_action)) }
SectionFeedback(state.feedback, Section.USERNAME)
}
}
@Composable
private fun PasswordSection(
account: PlayerAccountDto,
state: AccountViewModel.State,
viewModel: AccountViewModel,
) {
val hasPassword = account.has_password
var current by rememberSaveable { mutableStateOf("") }
var next by rememberSaveable { mutableStateOf("") }
SectionCard(if (hasPassword) R.string.account_password_title else R.string.account_password_set_title) {
if (!hasPassword) {
Text(
stringResource(R.string.account_password_set_hint),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
}
if (hasPassword) {
OutlinedTextField(
value = current,
onValueChange = { current = it },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.account_password_current)) },
visualTransformation = PasswordVisualTransformation(),
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password),
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
}
OutlinedTextField(
value = next,
onValueChange = { next = it },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.account_password_new)) },
visualTransformation = PasswordVisualTransformation(),
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password),
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
Button(
onClick = {
viewModel.changePassword(next, if (hasPassword) current else null)
current = ""
next = ""
},
enabled = !state.busy && next.length >= 8 && (!hasPassword || current.isNotBlank()),
modifier = Modifier.padding(top = 12.dp),
) {
Text(stringResource(if (hasPassword) R.string.account_password_action else R.string.account_password_set_action))
}
SectionFeedback(state.feedback, Section.PASSWORD)
}
}
@Composable
private fun TwoFactorSection(
account: PlayerAccountDto,
state: AccountViewModel.State,
viewModel: AccountViewModel,
) {
var code by rememberSaveable { mutableStateOf("") }
SectionCard(R.string.account_totp_title) {
StatusPill(
text = stringResource(if (account.totp_enabled) R.string.account_totp_on else R.string.account_totp_off),
tone = if (account.totp_enabled) PillTone.Success else PillTone.Neutral,
modifier = Modifier.padding(top = 8.dp),
)
when {
// Enabled → offer disable via a current code.
account.totp_enabled -> {
CodeField(code, { code = it }, !state.busy)
Button(
onClick = { viewModel.disableTotp(code); code = "" },
enabled = !state.busy && code.isNotBlank(),
modifier = Modifier.padding(top = 12.dp),
) { Text(stringResource(R.string.account_totp_disable)) }
}
// Mid-enrollment → show QR + confirm.
state.totpSetup != null -> {
Text(
stringResource(R.string.account_totp_scan),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 12.dp),
)
rememberQrBitmap(state.totpSetup.qr)?.let { bmp ->
Image(
bitmap = bmp,
contentDescription = stringResource(R.string.account_totp_qr_desc),
modifier = Modifier.padding(top = 12.dp).size(180.dp),
)
}
CodeField(code, { code = it }, !state.busy)
Row(Modifier.padding(top = 12.dp), horizontalArrangement = Arrangement.spacedBy(8.dp)) {
Button(
onClick = { viewModel.enableTotp(code); code = "" },
enabled = !state.busy && code.isNotBlank(),
) { Text(stringResource(R.string.account_totp_confirm)) }
OutlinedButton(onClick = { viewModel.cancelTotp(); code = "" }, enabled = !state.busy) {
Text(stringResource(R.string.account_totp_cancel))
}
}
}
// Not enabled, not enrolling → start.
else -> {
Button(
onClick = viewModel::beginTotp,
enabled = !state.busy,
modifier = Modifier.padding(top = 12.dp),
) { Text(stringResource(R.string.account_totp_setup)) }
}
}
SectionFeedback(state.feedback, Section.TOTP)
}
}
@Composable
private fun IdentitiesSection(state: AccountViewModel.State, viewModel: AccountViewModel) {
SectionCard(R.string.account_identities_title) {
if (state.identities.isEmpty()) {
Text(
stringResource(R.string.account_identities_empty),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
} else {
state.identities.forEach { identity -> IdentityRow(identity, state.busy, viewModel) }
}
SectionFeedback(state.feedback, Section.IDENTITY)
}
}
@Composable
private fun IdentityRow(identity: LinkedIdentityDto, busy: Boolean, viewModel: AccountViewModel) {
Row(
Modifier.fillMaxWidth().padding(top = 12.dp),
verticalAlignment = Alignment.CenterVertically,
) {
Column(Modifier.weight(1f)) {
Text(
identity.provider.replaceFirstChar { it.uppercase() },
style = MaterialTheme.typography.bodyLarge,
)
identity.email?.let {
Text(it, style = MaterialTheme.typography.bodySmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
}
TextButton(onClick = { viewModel.unlinkIdentity(identity.provider) }, enabled = !busy) {
Text(stringResource(R.string.account_identity_unlink))
}
}
}
@Composable
private fun CodeField(code: String, onChange: (String) -> Unit, enabled: Boolean) {
OutlinedTextField(
value = code,
onValueChange = { onChange(it.filter(Char::isDigit).take(8)) },
singleLine = true,
enabled = enabled,
label = { Text(stringResource(R.string.login_totp_code)) },
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.NumberPassword),
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
}
@Composable
private fun SectionFeedback(feedback: Feedback?, section: Section) {
if (feedback == null || feedback.section != section) return
Text(
text = stringResource(feedback.messageRes),
style = MaterialTheme.typography.bodySmall,
color = if (feedback.ok) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.error,
modifier = Modifier.padding(top = 10.dp),
)
}
/** Decode a `data:image/png;base64,…` URL (the TOTP QR) into an [ImageBitmap]. */
@Composable
private fun rememberQrBitmap(dataUrl: String?): ImageBitmap? = remember(dataUrl) {
if (dataUrl.isNullOrBlank()) return@remember null
val comma = dataUrl.indexOf(',')
if (comma < 0) return@remember null
runCatching {
val bytes = Base64.decode(dataUrl.substring(comma + 1), Base64.DEFAULT)
BitmapFactory.decodeByteArray(bytes, 0, bytes.size)?.asImageBitmap()
}.getOrNull()
}
/** Human label for a role (advisory display only — §4.3). */
@StringRes
fun roleLabelRes(role: Role): Int = when (role) {
Role.PLAYER -> R.string.role_player
Role.MODERATOR -> R.string.role_moderator
Role.EDITOR -> R.string.role_editor
Role.ADMIN -> R.string.role_admin
Role.UNKNOWN -> R.string.role_unknown
}

View File

@@ -0,0 +1,185 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.auth
import androidx.annotation.StringRes
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.R
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.LinkedIdentityDto
import com.runicgateway.app.data.api.dto.PlayerAccountDto
import com.runicgateway.app.data.api.dto.TotpSetupDto
import com.runicgateway.app.data.repository.AccountRepository
import com.runicgateway.app.data.repository.AuthRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* Drives the signed-in self-service surface (PLAN.md §6.3, §6.4) over
* `/auth/me/account*`: change username/password, enroll/disable TOTP, and manage
* linked SSO identities. Each mutation folds its [ApiResult] into a section-scoped
* [Feedback] so the screen shows friendly, localized copy inline (§7). A username
* change also re-validates the session so the shell reflects the new name at once.
*/
@HiltViewModel
class AccountViewModel @Inject constructor(
private val accountRepository: AccountRepository,
private val authRepository: AuthRepository,
) : ViewModel() {
/** Which section an action's [Feedback] belongs to, so it renders in place. */
enum class Section { USERNAME, PASSWORD, TOTP, IDENTITY }
/** A one-shot result banner under a section. */
data class Feedback(val section: Section, val ok: Boolean, @param:StringRes val messageRes: Int)
data class State(
val account: UiState<PlayerAccountDto> = UiState.Loading,
val identities: List<LinkedIdentityDto> = emptyList(),
/** True while any mutation is in flight (disables that section's controls). */
val busy: Boolean = false,
/** The pending TOTP enrollment (QR shown) between setup and enable. */
val totpSetup: TotpSetupDto? = null,
val feedback: Feedback? = null,
)
private val _state = MutableStateFlow(State())
val state: StateFlow<State> = _state.asStateFlow()
init {
load()
}
fun load() {
_state.update { it.copy(account = UiState.Loading) }
viewModelScope.launch {
val account = accountRepository.getAccount()
_state.update { it.copy(account = account.toUiState()) }
// Identities are non-critical — an empty list on failure is fine.
when (val ids = accountRepository.identities()) {
is ApiResult.Ok -> _state.update { it.copy(identities = ids.data) }
else -> Unit
}
}
}
fun clearFeedback() = _state.update { it.copy(feedback = null) }
// ── Username ─────────────────────────────────────────────────────────
fun changeUsername(username: String) {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (val result = accountRepository.changeUsername(username.trim())) {
is ApiResult.Ok -> {
finish(Section.USERNAME, true, R.string.account_username_changed)
// Reflect the new name in the shell + refresh the loaded account.
authRepository.revalidate()
reloadAccount()
}
else -> finish(Section.USERNAME, false, usernameErrorRes(result))
}
}
}
// ── Password ─────────────────────────────────────────────────────────
fun changePassword(newPassword: String, currentPassword: String?) {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (accountRepository.changePassword(newPassword, currentPassword?.takeIf { it.isNotBlank() })) {
is ApiResult.Ok -> finish(Section.PASSWORD, true, R.string.account_password_changed)
is ApiResult.HttpError -> finish(Section.PASSWORD, false, R.string.account_password_error)
is ApiResult.NetworkError -> finish(Section.PASSWORD, false, R.string.error_network)
}
}
}
// ── TOTP ─────────────────────────────────────────────────────────────
fun beginTotp() {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (val result = accountRepository.totpSetup()) {
is ApiResult.Ok -> _state.update { it.copy(busy = false, totpSetup = result.data) }
else -> finish(Section.TOTP, false, R.string.account_totp_setup_error)
}
}
}
fun cancelTotp() = _state.update { it.copy(totpSetup = null, feedback = null) }
fun enableTotp(code: String) {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (accountRepository.totpEnable(code.trim())) {
is ApiResult.Ok -> {
_state.update { it.copy(totpSetup = null) }
finish(Section.TOTP, true, R.string.account_totp_enabled)
reloadAccount()
}
is ApiResult.HttpError -> finish(Section.TOTP, false, R.string.account_totp_code_error)
is ApiResult.NetworkError -> finish(Section.TOTP, false, R.string.error_network)
}
}
}
fun disableTotp(code: String) {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (accountRepository.totpDisable(code.trim())) {
is ApiResult.Ok -> {
finish(Section.TOTP, true, R.string.account_totp_disabled)
reloadAccount()
}
is ApiResult.HttpError -> finish(Section.TOTP, false, R.string.account_totp_code_error)
is ApiResult.NetworkError -> finish(Section.TOTP, false, R.string.error_network)
}
}
}
// ── Identities ───────────────────────────────────────────────────────
fun unlinkIdentity(provider: String) {
if (_state.value.busy) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (accountRepository.unlinkIdentity(provider)) {
is ApiResult.Ok -> {
finish(Section.IDENTITY, true, R.string.account_identity_unlinked)
when (val ids = accountRepository.identities()) {
is ApiResult.Ok -> _state.update { it.copy(identities = ids.data) }
else -> Unit
}
}
else -> finish(Section.IDENTITY, false, R.string.account_identity_error)
}
}
}
private suspend fun reloadAccount() {
when (val account = accountRepository.getAccount()) {
is ApiResult.Ok -> _state.update { it.copy(account = UiState.Success(account.data)) }
else -> Unit
}
}
private fun finish(section: Section, ok: Boolean, @StringRes messageRes: Int) =
_state.update { it.copy(busy = false, feedback = Feedback(section, ok, messageRes)) }
private fun usernameErrorRes(result: ApiResult<*>): Int = when {
result is ApiResult.HttpError && result.status == 409 -> R.string.account_username_taken
result is ApiResult.NetworkError -> R.string.error_network
else -> R.string.account_username_error
}
}

View File

@@ -0,0 +1,211 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.auth
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.text.KeyboardActions
import androidx.compose.foundation.text.KeyboardOptions
import androidx.compose.foundation.verticalScroll
import androidx.compose.material3.Button
import androidx.compose.material3.CircularProgressIndicator
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.OutlinedButton
import androidx.compose.material3.OutlinedTextField
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.getValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.input.ImeAction
import androidx.compose.ui.text.input.KeyboardType
import androidx.compose.ui.text.input.PasswordVisualTransformation
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import androidx.hilt.navigation.compose.hiltViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import com.runicgateway.app.R
import com.runicgateway.app.core.web.WebHandoff
import com.runicgateway.app.ui.auth.LoginViewModel.LoginError
/**
* Native username/password (+TOTP) login (PLAN.md §4.1) — the app's only native
* credential screen. Registration, forgot-password, and SSO are website hand-offs
* opened in a Custom Tab (§4.2); the user completes them in the browser and
* returns here to sign in.
*/
@Composable
fun LoginScreen(
onSignedIn: () -> Unit,
modifier: Modifier = Modifier,
viewModel: LoginViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val context = LocalContext.current
LaunchedEffect(state.signedIn) {
if (state.signedIn) onSignedIn()
}
// Open a freshly-minted SSO /start URL in a Custom Tab, exactly once (§4.2).
LaunchedEffect(state.ssoLaunchUrl) {
val url = state.ssoLaunchUrl ?: return@LaunchedEffect
WebHandoff.open(context, url)
viewModel.onSsoLaunchConsumed()
}
Column(
modifier = modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
.padding(24.dp),
horizontalAlignment = Alignment.CenterHorizontally,
verticalArrangement = Arrangement.Center,
) {
Text(
text = stringResource(R.string.login_title),
style = MaterialTheme.typography.headlineSmall,
textAlign = TextAlign.Center,
)
Text(
text = stringResource(R.string.login_subtitle),
style = MaterialTheme.typography.bodyMedium,
textAlign = TextAlign.Center,
modifier = Modifier.padding(top = 8.dp, bottom = 24.dp),
)
OutlinedTextField(
value = state.username,
onValueChange = viewModel::onUsernameChange,
singleLine = true,
enabled = !state.submitting,
label = { Text(stringResource(R.string.login_username)) },
keyboardOptions = KeyboardOptions(
keyboardType = KeyboardType.Text,
imeAction = ImeAction.Next,
),
modifier = Modifier.fillMaxWidth(),
)
OutlinedTextField(
value = state.password,
onValueChange = viewModel::onPasswordChange,
singleLine = true,
enabled = !state.submitting,
label = { Text(stringResource(R.string.login_password)) },
visualTransformation = PasswordVisualTransformation(),
keyboardOptions = KeyboardOptions(
keyboardType = KeyboardType.Password,
imeAction = if (state.totpRequired) ImeAction.Next else ImeAction.Go,
),
keyboardActions = KeyboardActions(onGo = { viewModel.submit() }),
modifier = Modifier
.fillMaxWidth()
.padding(top = 12.dp),
)
if (state.totpRequired) {
OutlinedTextField(
value = state.code,
onValueChange = viewModel::onCodeChange,
singleLine = true,
enabled = !state.submitting,
label = { Text(stringResource(R.string.login_totp_code)) },
supportingText = { Text(stringResource(R.string.login_totp_hint)) },
keyboardOptions = KeyboardOptions(
keyboardType = KeyboardType.NumberPassword,
imeAction = ImeAction.Go,
),
keyboardActions = KeyboardActions(onGo = { viewModel.submit() }),
modifier = Modifier
.fillMaxWidth()
.padding(top = 12.dp),
)
}
state.error?.let { err ->
Text(
text = stringResource(loginErrorRes(err)),
color = MaterialTheme.colorScheme.error,
style = MaterialTheme.typography.bodyMedium,
textAlign = TextAlign.Center,
modifier = Modifier
.fillMaxWidth()
.padding(top = 12.dp),
)
}
Button(
onClick = viewModel::submit,
enabled = !state.submitting,
modifier = Modifier
.fillMaxWidth()
.padding(top = 20.dp),
) {
if (state.submitting) {
CircularProgressIndicator(
strokeWidth = 2.dp,
modifier = Modifier.size(20.dp),
color = MaterialTheme.colorScheme.onPrimary,
)
} else {
Text(stringResource(R.string.login_button))
}
}
// ── Native SSO (§4.2, M9): a button per enabled provider that opens the
// Custom-Tab bridge and returns the user signed in. Falls back to the
// website login hand-off when the shard exposes no providers.
if (state.ssoProviders.isNotEmpty()) {
state.ssoProviders.forEach { provider ->
OutlinedButton(
onClick = { viewModel.onSsoProviderClick(provider) },
enabled = !state.submitting,
modifier = Modifier
.fillMaxWidth()
.padding(top = 12.dp),
) {
Text(stringResource(R.string.login_sso_provider, provider.name))
}
}
} else {
viewModel.ssoLoginUrl?.let { url ->
TextButton(onClick = { WebHandoff.open(context, url) }) {
Text(stringResource(R.string.login_sso))
}
}
}
// ── Website hand-offs (§4.2): open the site's own pages in a Custom Tab ──
viewModel.registerUrl?.let { url ->
TextButton(
onClick = { WebHandoff.open(context, url) },
modifier = Modifier.padding(top = 16.dp),
) { Text(stringResource(R.string.login_register)) }
}
viewModel.forgotPasswordUrl?.let { url ->
TextButton(onClick = { WebHandoff.open(context, url) }) {
Text(stringResource(R.string.login_forgot))
}
}
}
}
private fun loginErrorRes(error: LoginError): Int = when (error) {
LoginError.INVALID_CREDENTIALS -> R.string.login_error_credentials
LoginError.BAD_CODE -> R.string.login_error_code
LoginError.RATE_LIMITED -> R.string.login_error_rate_limited
LoginError.SERVER -> R.string.login_error_server
LoginError.NETWORK -> R.string.login_error_network
LoginError.SSO -> R.string.login_error_sso
}

View File

@@ -0,0 +1,158 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.auth
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.auth.sso.SsoAuthManager
import com.runicgateway.app.core.web.WebsiteUrls
import com.runicgateway.app.data.api.dto.SsoProviderDto
import com.runicgateway.app.data.repository.AuthRepository
import com.runicgateway.app.data.repository.AuthRepository.LoginResult
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* Drives the native login screen (PLAN.md §4.1): username/password, single-request
* TOTP (the code field is revealed once the backend answers `totpRequired`), and
* friendly 429 backoff handling. Registration / forgot-password / SSO are website
* hand-offs whose URLs it exposes (§4.2).
*/
@HiltViewModel
class LoginViewModel @Inject constructor(
private val authRepository: AuthRepository,
private val ssoAuthManager: SsoAuthManager,
private val websiteUrls: WebsiteUrls,
) : ViewModel() {
/** The transient error surfaced under the form after a failed attempt. */
enum class LoginError { INVALID_CREDENTIALS, BAD_CODE, RATE_LIMITED, SERVER, NETWORK, SSO }
data class UiState(
val username: String = "",
val password: String = "",
val code: String = "",
/** True once the account is known to have 2FA on — reveal the code field. */
val totpRequired: Boolean = false,
val submitting: Boolean = false,
val error: LoginError? = null,
val signedIn: Boolean = false,
/** The shard's enabled SSO providers (§4.2); empty → website hand-off fallback. */
val ssoProviders: List<SsoProviderDto> = emptyList(),
/** A `/auth/mobile/sso/start` URL the screen should open in a Custom Tab, once. */
val ssoLaunchUrl: String? = null,
)
private val _state = MutableStateFlow(UiState())
val state: StateFlow<UiState> = _state.asStateFlow()
init {
// Discover the native SSO providers to render buttons for (§4.2).
viewModelScope.launch {
val providers = authRepository.ssoProviders()
if (providers.isNotEmpty()) _state.update { it.copy(ssoProviders = providers) }
}
// Consume the SSO bridge outcome: a returned callback completes here even if
// this ViewModel was recreated while the Custom Tab was foreground (§4.2).
viewModelScope.launch {
ssoAuthManager.outcome.collect { outcome ->
when (outcome) {
SsoAuthManager.Outcome.Success -> {
ssoAuthManager.consumeOutcome()
_state.update { it.copy(submitting = false, signedIn = true) }
}
is SsoAuthManager.Outcome.Failed -> {
ssoAuthManager.consumeOutcome()
_state.update { it.copy(submitting = false, error = mapSsoError(outcome.reason)) }
}
SsoAuthManager.Outcome.Idle -> Unit
}
}
}
}
fun onUsernameChange(value: String) = _state.update { it.copy(username = value, error = null) }
fun onPasswordChange(value: String) = _state.update { it.copy(password = value, error = null) }
fun onCodeChange(value: String) =
_state.update { it.copy(code = value.filter(Char::isDigit).take(8), error = null) }
val registerUrl: String? get() = websiteUrls.register()
val forgotPasswordUrl: String? get() = websiteUrls.forgotPassword()
/** Website login hand-off — the fallback when native SSO discovery is empty (§4.2). */
val ssoLoginUrl: String? get() = websiteUrls.login()
/**
* Begin a native SSO flow for [provider]: mint PKCE + state and surface the
* `/start` URL for the screen to open in a Custom Tab. No-op (leaves a SERVER
* error) if the base URL isn't set yet — the website fallback still shows.
*/
fun onSsoProviderClick(provider: SsoProviderDto) {
if (_state.value.submitting) return
val url = ssoAuthManager.buildStartUrl(provider.id)
if (url == null) {
_state.update { it.copy(error = LoginError.SSO) }
return
}
_state.update { it.copy(error = null, ssoLaunchUrl = url) }
}
/** The screen has opened the Custom Tab; clear so it isn't re-launched on recompose. */
fun onSsoLaunchConsumed() = _state.update { it.copy(ssoLaunchUrl = null) }
private fun mapSsoError(reason: SsoAuthManager.Failure): LoginError = when (reason) {
SsoAuthManager.Failure.NETWORK -> LoginError.NETWORK
else -> LoginError.SSO
}
fun submit() {
val s = _state.value
if (s.submitting) return
if (s.username.isBlank() || s.password.isBlank()) {
_state.update { it.copy(error = LoginError.INVALID_CREDENTIALS) }
return
}
// If 2FA is being requested, a code must accompany the resubmit.
if (s.totpRequired && s.code.isBlank()) {
_state.update { it.copy(error = LoginError.BAD_CODE) }
return
}
_state.update { it.copy(submitting = true, error = null) }
viewModelScope.launch {
val code = s.code.trim().takeIf { it.isNotBlank() }
when (authRepository.login(s.username.trim(), s.password, code)) {
LoginResult.Success ->
_state.update { it.copy(submitting = false, signedIn = true) }
LoginResult.TotpRequired ->
// Reveal the code field; a wrong code re-lands here as BAD_CODE.
_state.update {
it.copy(
submitting = false,
totpRequired = true,
error = if (it.code.isNotBlank()) LoginError.BAD_CODE else null,
)
}
LoginResult.InvalidCredentials ->
_state.update { it.copy(submitting = false, error = LoginError.INVALID_CREDENTIALS) }
LoginResult.RateLimited ->
_state.update { it.copy(submitting = false, error = LoginError.RATE_LIMITED) }
LoginResult.ServerError ->
_state.update { it.copy(submitting = false, error = LoginError.SERVER) }
LoginResult.NetworkError ->
_state.update { it.copy(submitting = false, error = LoginError.NETWORK) }
}
}
}
}

View File

@@ -0,0 +1,148 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.components
import androidx.compose.foundation.background
import androidx.compose.foundation.border
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.ColumnScope
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Brush
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import com.runicgateway.app.ui.theme.ShardCardBottom
import com.runicgateway.app.ui.theme.ShardCardTop
import com.runicgateway.app.ui.theme.ShardDanger
import com.runicgateway.app.ui.theme.ShardDangerBg
import com.runicgateway.app.ui.theme.ShardElevated
import com.runicgateway.app.ui.theme.ShardFaint
import com.runicgateway.app.ui.theme.ShardOutline
import com.runicgateway.app.ui.theme.ShardPillBg
import com.runicgateway.app.ui.theme.ShardPillFg
import com.runicgateway.app.ui.theme.ShardSuccess
import com.runicgateway.app.ui.theme.ShardSuccessBg
import com.runicgateway.app.ui.theme.ShardSuccessDot
import com.runicgateway.app.ui.theme.ShardWarning
import com.runicgateway.app.ui.theme.ShardWarningBg
/**
* Shared visual building blocks for the M5 shard-website design pass
* (docs/android/PLAN.md §M5): the recurring pill, section-label, feature-card,
* and stat-bar motifs the mockup repeats across screens. Pure presentation —
* no state, no data dependencies — so any screen can adopt them.
*/
/** Semantic tone for a [StatusPill] / [OnlineDot]. */
enum class PillTone { Success, Warning, Danger, Neutral, Info }
private data class PillColors(val fg: Color, val bg: Color)
private fun toneColors(tone: PillTone): PillColors = when (tone) {
PillTone.Success -> PillColors(ShardSuccess, ShardSuccessBg)
PillTone.Warning -> PillColors(ShardWarning, ShardWarningBg)
PillTone.Danger -> PillColors(ShardDanger, ShardDangerBg)
PillTone.Neutral, PillTone.Info -> PillColors(ShardPillFg, ShardPillBg)
}
/**
* A small uppercase status chip — "Live", "Up", "Enabled", "IDOC", a role — with a
* rounded filled background tinted by [tone]. Mirrors the mockup's pill badges.
*/
@Composable
fun StatusPill(text: String, tone: PillTone, modifier: Modifier = Modifier) {
val c = toneColors(tone)
Surface(color = c.bg, shape = CircleShape, modifier = modifier) {
Text(
text = text.uppercase(),
style = MaterialTheme.typography.labelSmall,
color = c.fg,
modifier = Modifier.padding(horizontal = 10.dp, vertical = 4.dp),
)
}
}
/** The small colored status dot (green when live), matched to a [PillTone]. */
@Composable
fun OnlineDot(tone: PillTone, modifier: Modifier = Modifier) {
val color = when (tone) {
PillTone.Success -> ShardSuccessDot
PillTone.Warning -> ShardWarning
PillTone.Danger -> ShardDanger
PillTone.Neutral, PillTone.Info -> ShardFaint
}
Box(modifier.size(8.dp).clip(CircleShape).background(color))
}
/**
* The muted, uppercase, letter-spaced section header the design uses above grouped
* content ("Attributes", "Vitals", "Password", "Linked accounts").
*/
@Composable
fun SectionLabel(text: String, modifier: Modifier = Modifier) {
Text(
text = text.uppercase(),
style = MaterialTheme.typography.labelSmall,
color = ShardFaint,
modifier = modifier,
)
}
/**
* The elevated "feature" card: a vertical blue gradient with a hairline outline and
* soft shadow, used for the home status card, the shard-online banner, and the
* vendor card. [content] is laid out in a padded [Column].
*/
@Composable
fun FeatureCard(
modifier: Modifier = Modifier,
contentPadding: Int = 18,
content: @Composable ColumnScope.() -> Unit,
) {
Box(
modifier = modifier
.fillMaxWidth()
.clip(RoundedCornerShape(12.dp))
.background(Brush.verticalGradient(listOf(ShardCardTop, ShardCardBottom)))
.border(1.dp, ShardOutline, RoundedCornerShape(12.dp)),
) {
Column(Modifier.padding(contentPadding.dp), content = content)
}
}
/**
* A slim rounded meter (vitals / skills). [fraction] is clamped to 0..1; the fill is
* the slate accent over a bordered dark track.
*/
@Composable
fun StatBar(fraction: Float, modifier: Modifier = Modifier) {
val pct = fraction.coerceIn(0f, 1f)
Box(
modifier = modifier
.fillMaxWidth()
.height(6.dp)
.clip(RoundedCornerShape(3.dp))
.background(ShardElevated)
.border(1.dp, ShardOutline, RoundedCornerShape(3.dp)),
) {
Box(
Modifier
.fillMaxWidth(pct)
.height(6.dp)
.clip(RoundedCornerShape(3.dp))
.background(MaterialTheme.colorScheme.secondary),
)
}
}

View File

@@ -107,6 +107,7 @@ private fun errorMessage(error: ConnectError): String = when (error) {
ConnectError.UnsupportedScheme -> stringResource(R.string.connect_error_scheme)
ConnectError.Insecure -> stringResource(R.string.connect_error_insecure)
ConnectError.NotRunicGateway -> stringResource(R.string.connect_error_not_runic)
is ConnectError.VersionMismatch -> stringResource(R.string.connect_error_version, error.serverApi)
ConnectError.Unreachable -> stringResource(R.string.connect_error_unreachable)
is ConnectError.Server -> stringResource(R.string.connect_error_server, error.status)
}

View File

@@ -32,6 +32,7 @@ class ConnectViewModel @Inject constructor(
data object UnsupportedScheme : ConnectError
data object Insecure : ConnectError
data object NotRunicGateway : ConnectError
data class VersionMismatch(val serverApi: String) : ConnectError
data object Unreachable : ConnectError
data class Server(val status: Int) : ConnectError
}
@@ -61,6 +62,7 @@ class ConnectViewModel @Inject constructor(
}
is ProbeResult.InvalidUrl -> fail(result.reason.toError())
ProbeResult.NotRunicGateway -> fail(ConnectError.NotRunicGateway)
is ProbeResult.VersionMismatch -> fail(ConnectError.VersionMismatch(result.serverApi))
is ProbeResult.Unreachable -> fail(ConnectError.Unreachable)
is ProbeResult.ServerError -> fail(ConnectError.Server(result.status))
}

View File

@@ -4,19 +4,19 @@
package com.runicgateway.app.ui.home
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.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.Card
import androidx.compose.material3.CardDefaults
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
@@ -27,7 +27,10 @@ import com.runicgateway.app.data.api.dto.BrandDto
import com.runicgateway.app.data.api.dto.StatusDto
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.components.ErrorView
import com.runicgateway.app.ui.components.FeatureCard
import com.runicgateway.app.ui.components.LoadingView
import com.runicgateway.app.ui.components.OnlineDot
import com.runicgateway.app.ui.components.PillTone
/**
* Home / status (PLAN.md §6.1): the shard's name + tagline from branding, and a
@@ -83,21 +86,19 @@ private fun HomeContent(brand: BrandDto?, status: StatusDto, modifier: Modifier
@Composable
private fun StatusCard(status: StatusDto) {
val online = !status.isMaintenance
val containerColor =
if (online) MaterialTheme.colorScheme.secondaryContainer
else MaterialTheme.colorScheme.errorContainer
Card(
modifier = Modifier.fillMaxWidth(),
colors = CardDefaults.cardColors(containerColor = containerColor),
) {
Column(Modifier.padding(16.dp)) {
FeatureCard {
Row(verticalAlignment = Alignment.CenterVertically) {
OnlineDot(if (online) PillTone.Success else PillTone.Danger)
Spacer(Modifier.width(10.dp))
Text(
text = stringResource(
if (online) R.string.home_status_live else R.string.home_status_maintenance,
),
style = MaterialTheme.typography.titleLarge,
style = MaterialTheme.typography.titleMedium,
color = MaterialTheme.colorScheme.onSurface,
)
}
if (status.isMaintenance && status.statusMessage.isNotBlank()) {
Text(
text = status.statusMessage,
@@ -119,4 +120,3 @@ private fun StatusCard(status: StatusDto) {
}
}
}
}

View File

@@ -0,0 +1,64 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.navigation
import androidx.annotation.StringRes
import com.runicgateway.app.R
import com.runicgateway.app.core.auth.Session
/**
* One shared, declarative, access-level navigation definition (PLAN.md §5): a
* single list where each entry declares the minimum access it needs, filtered by
* the current session — not a pile of `if role ==` checks. The server stays the
* source of truth; a hidden item is a UX convenience and every gated call still
* enforces on the backend.
*/
enum class MenuAccess {
/** Visible to everyone, signed in or not. */
PUBLIC,
/** Visible to any signed-in account (§5, "My Account"). */
SIGNED_IN,
/** Visible only to a player — the linked game-data groups (§6.3). */
PLAYER,
}
data class MenuEntry(
val route: String,
@param:StringRes val labelRes: Int,
val access: MenuAccess = MenuAccess.PUBLIC,
)
/**
* The full menu, in display order. Public content first, then the signed-in
* surfaces, then the player-only game-data groups (revealed once the session's
* role is `player`, §6.3).
*/
val APP_MENU: List<MenuEntry> = listOf(
MenuEntry(Routes.HOME, R.string.menu_home),
MenuEntry(Routes.NEWS, R.string.menu_news),
MenuEntry(Routes.WIKI, R.string.menu_wiki),
MenuEntry(Routes.SHARD, R.string.menu_shard),
MenuEntry(Routes.page("about"), R.string.menu_about),
MenuEntry(Routes.CONTACT, R.string.menu_contact),
MenuEntry(Routes.ACCOUNT, R.string.menu_account, MenuAccess.SIGNED_IN),
MenuEntry(Routes.NOTIFICATIONS, R.string.menu_notifications, MenuAccess.SIGNED_IN),
MenuEntry(Routes.PLAYER_CHARACTERS, R.string.menu_my_characters, MenuAccess.PLAYER),
MenuEntry(Routes.PLAYER_VENDORS, R.string.menu_my_vendors, MenuAccess.PLAYER),
MenuEntry(Routes.PLAYER_HOUSES, R.string.menu_my_houses, MenuAccess.PLAYER),
)
/**
* The entries the given [session] may see. Pure + side-effect-free so the access
* gating is unit-tested without Compose.
*/
fun visibleEntries(entries: List<MenuEntry>, session: Session): List<MenuEntry> =
entries.filter { entry ->
when (entry.access) {
MenuAccess.PUBLIC -> true
MenuAccess.SIGNED_IN -> session is Session.SignedIn
MenuAccess.PLAYER -> session is Session.SignedIn && session.user.isPlayer
}
}

View File

@@ -14,6 +14,30 @@ object Routes {
const val WIKI = "wiki"
const val CONTACT = "contact"
/** Native login (§4.1) and the signed-in account surface (§5). */
const val LOGIN = "login"
const val ACCOUNT = "account"
/** Opt-in push notification settings (§11, signed-in). */
const val NOTIFICATIONS = "notifications"
/** Public shard hub (§6.2). */
const val SHARD = "shard"
/** Shard boards, reachable from the hub. */
const val SHARD_CHAMPS = "shard/champs"
const val SHARD_GUILDS = "shard/guilds"
const val SHARD_GOVERNORS = "shard/governors"
const val SHARD_HOUSES = "shard/houses"
/** Player game-data groups (§6.3, player-only). Distinct from the public shard boards. */
const val PLAYER_CHARACTERS = "player/characters"
const val PLAYER_VENDORS = "player/vendors"
const val PLAYER_HOUSES = "player/houses"
/** A single character sheet by in-game (hex) serial. */
const val PLAYER_CHAR = "player/char/{serial}"
/** CMS page by slug (e.g. the conventional "about" page, mirrored from the site nav). */
const val PAGE = "page/{slug}"
@@ -27,9 +51,32 @@ object Routes {
const val SLUG = "slug"
const val CATEGORY = "category"
const val ID_OR_SLUG = "idOrSlug"
const val SERIAL = "serial"
}
fun page(slug: String) = "page/$slug"
fun post(categoryUrlSlug: String, idOrSlug: String) = "news/$categoryUrlSlug/$idOrSlug"
fun wikiPage(slug: String) = "wiki/$slug"
/** The character-sheet route for an in-game serial (e.g. "0x24C"). */
fun playerChar(serial: String) = "player/char/$serial"
/**
* The in-app destination a tapped push notification deep-links to (§11, M7
* Part 2 work item 7). Maps a stream id to the screen that shows its content;
* unknown streams land on Home. Personal streams route to the player groups
* (a signed-out/demoted tap is caught by [com.runicgateway.app.ui.PlayerGate]).
*/
fun forStream(streamId: String): String = when (streamId) {
com.runicgateway.app.core.push.PushStreams.NEWS_POST -> NEWS
com.runicgateway.app.core.push.PushStreams.SERVER_STATUS,
com.runicgateway.app.core.push.PushStreams.CHAMP_START,
com.runicgateway.app.core.push.PushStreams.IDOC_WARNING,
com.runicgateway.app.core.push.PushStreams.GOVERNOR_ELECTION,
-> SHARD
com.runicgateway.app.core.push.PushStreams.VENDOR_SALE -> PLAYER_VENDORS
com.runicgateway.app.core.push.PushStreams.HOUSE_IDOC -> PLAYER_HOUSES
com.runicgateway.app.core.push.PushStreams.ACCOUNT_LOGIN -> ACCOUNT
else -> HOME
}
}

View File

@@ -0,0 +1,182 @@
/*
* 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)
}
}

View File

@@ -0,0 +1,135 @@
/*
* 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

View File

@@ -0,0 +1,288 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.FlowRow
import androidx.compose.foundation.layout.ExperimentalLayoutApi
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material3.Card
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.font.FontWeight
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.CharProfileDto
import com.runicgateway.app.data.api.dto.CharStatsDto
import com.runicgateway.app.data.api.dto.EquipmentDto
import com.runicgateway.app.data.api.dto.ResistDto
import com.runicgateway.app.data.api.dto.SkillDto
import com.runicgateway.app.data.api.dto.TitlesDto
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.SectionLabel
import com.runicgateway.app.ui.components.StatBar
import kotlinx.serialization.json.jsonPrimitive
/**
* A text-only character sheet (PLAN.md §6.3): identity + standing, attributes and
* vitals, resistances, skills, and equipment. No item icons / paperdoll art — a
* richer view is a future enhancement pending the platform art work.
*/
@Composable
fun CharacterSheetScreen(
modifier: Modifier = Modifier,
viewModel: CharacterViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
when (val s = state) {
is UiState.Loading -> LoadingView(modifier)
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
is UiState.Success -> CharacterSheet(s.data, modifier)
}
}
@Composable
private fun CharacterSheet(char: CharProfileDto, modifier: Modifier = Modifier) {
Column(
modifier = modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
.padding(16.dp),
verticalArrangement = Arrangement.spacedBy(16.dp),
) {
IdentityBlock(char)
StandingChips(char)
char.stats?.let { AttributesBlock(it) }
char.stats?.resist?.let { ResistancesBlock(it) }
SkillsBlock(char.skills)
EquipmentBlock(char.equipment)
}
}
@Composable
private fun IdentityBlock(char: CharProfileDto) {
Column {
Text(
char.name ?: stringResource(R.string.player_char_unknown),
style = MaterialTheme.typography.headlineSmall,
)
char.title?.takeIf { it.isNotBlank() }?.let {
Text(it, style = MaterialTheme.typography.bodyMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
Row(Modifier.padding(top = 4.dp)) {
Text(
stringResource(if (char.online) R.string.player_char_online else R.string.player_char_offline),
style = MaterialTheme.typography.labelMedium,
color = if (char.online) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.onSurfaceVariant,
)
char.serial?.let {
Text(
" · $it",
style = MaterialTheme.typography.labelMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
}
}
}
}
@OptIn(ExperimentalLayoutApi::class)
@Composable
private fun StandingChips(char: CharProfileDto) {
val chips = buildList {
char.governorOf.forEach { add(stringResource(R.string.player_char_governor, it)) }
char.guild?.let { g ->
val abbr = g.abbr?.let { " [$it]" } ?: ""
add(stringResource(R.string.player_char_guildmaster, "${g.name.orEmpty()}$abbr"))
}
addAll(displayTitles(char.titles))
}
if (chips.isEmpty()) return
FlowRow(horizontalArrangement = Arrangement.spacedBy(8.dp)) {
chips.forEach { Chip(it) }
}
}
@Composable
private fun Chip(text: String) {
Surface(
color = MaterialTheme.colorScheme.secondaryContainer,
shape = MaterialTheme.shapes.small,
) {
Text(
text,
style = MaterialTheme.typography.labelMedium,
color = MaterialTheme.colorScheme.onSecondaryContainer,
modifier = Modifier.padding(horizontal = 10.dp, vertical = 4.dp),
)
}
}
@Composable
private fun AttributesBlock(stats: CharStatsDto) {
SheetCard(R.string.player_char_attributes) {
Row(Modifier.fillMaxWidth(), horizontalArrangement = Arrangement.SpaceBetween) {
Stat(stringResource(R.string.player_char_str), stats.str)
Stat(stringResource(R.string.player_char_dex), stats.dex)
Stat(stringResource(R.string.player_char_int), stats.int)
}
Column(Modifier.padding(top = 16.dp)) {
SectionLabel(stringResource(R.string.player_char_vitals))
Column(Modifier.padding(top = 8.dp)) {
Vital(stringResource(R.string.player_char_hits), stats.hits, stats.hitsMax)
Vital(stringResource(R.string.player_char_mana), stats.mana, stats.manaMax)
Vital(stringResource(R.string.player_char_stam), stats.stam, stats.stamMax)
}
}
}
}
@Composable
private fun Stat(label: String, value: Int?) {
Column {
Text("${value ?: "—"}", style = MaterialTheme.typography.titleLarge)
Text(label, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
}
@Composable
private fun Vital(label: String, cur: Int?, max: Int?) {
Column(Modifier.padding(vertical = 5.dp)) {
Row(Modifier.fillMaxWidth().padding(bottom = 4.dp), horizontalArrangement = Arrangement.SpaceBetween) {
Text(label, style = MaterialTheme.typography.labelMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
Text("${cur ?: "—"} / ${max ?: "—"}", style = MaterialTheme.typography.labelMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
val fraction = if (max != null && max > 0 && cur != null) cur.toFloat() / max else 0f
StatBar(fraction)
}
}
@Composable
private fun ResistancesBlock(resist: ResistDto) {
val rows = listOf(
stringResource(R.string.player_char_phys) to resist.phys,
stringResource(R.string.player_char_fire) to resist.fire,
stringResource(R.string.player_char_cold) to resist.cold,
stringResource(R.string.player_char_pois) to resist.pois,
stringResource(R.string.player_char_energy) to resist.energy,
)
if (rows.all { it.second == null }) return
SheetCard(R.string.player_char_resistances) {
Row(Modifier.fillMaxWidth().padding(top = 4.dp), horizontalArrangement = Arrangement.SpaceBetween) {
rows.forEach { (label, value) ->
Column {
Text("${value ?: 0}", style = MaterialTheme.typography.titleMedium)
Text(label, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
}
}
}
}
@Composable
private fun SkillsBlock(skills: List<SkillDto>) {
val shown = skills
.filter { (it.value ?: it.base ?: 0.0) > 0.0 }
.sortedByDescending { it.value ?: 0.0 }
if (shown.isEmpty()) return
SheetCard(R.string.player_char_skills) {
shown.forEach { skill ->
val value = skill.value ?: 0.0
Column(Modifier.padding(vertical = 5.dp)) {
Row(Modifier.fillMaxWidth().padding(bottom = 4.dp), horizontalArrangement = Arrangement.SpaceBetween) {
Text(skill.n ?: "", style = MaterialTheme.typography.labelMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
Text(formatSkill(value), style = MaterialTheme.typography.labelMedium, color = MaterialTheme.colorScheme.onSurfaceVariant, fontWeight = FontWeight.Medium)
}
StatBar((value / SKILL_CAP).toFloat())
}
}
}
}
@OptIn(ExperimentalLayoutApi::class)
@Composable
private fun EquipmentBlock(equipment: List<EquipmentDto>) {
if (equipment.isEmpty()) return
SheetCard(R.string.player_char_equipment) {
equipment.forEach { item ->
Column(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
Text(
item.layer ?: stringResource(R.string.player_char_item),
style = MaterialTheme.typography.bodyLarge,
)
val meta = listOfNotNull(
item.itemId?.let { stringResource(R.string.player_char_item_id, it) },
item.hue?.takeIf { it != 0 }?.let { stringResource(R.string.player_char_item_hue, it) },
).joinToString(" · ")
if (meta.isNotBlank()) {
Text(meta, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
val mods = item.mods.orEmpty()
if (mods.isNotEmpty()) {
FlowRow(Modifier.padding(top = 4.dp), horizontalArrangement = Arrangement.spacedBy(6.dp)) {
mods.forEach { (k, v) -> Chip("$k ${jsonText(v)}") }
}
}
}
}
}
}
@Composable
private fun SheetCard(titleRes: Int, content: @Composable () -> Unit) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Text(stringResource(titleRes), style = MaterialTheme.typography.titleMedium)
content()
}
}
}
// ── Pure helpers (unit-tested) ───────────────────────────────────────────────
/** ServUO's default skill cap; used to scale the skill meter fill (0..1). */
private const val SKILL_CAP = 120.0
/** Format a skill value: drop the ".0" on whole numbers, else one decimal. */
internal fun formatSkill(value: Double): String =
if (value % 1.0 == 0.0) value.toInt().toString() else "%.1f".format(value)
/**
* The human-readable title chips for a [TitlesDto] (parity with the website's
* `CharacterSheet.jsx#displayTitles`): fame/karma, skill title, and the selected
* reward title — but only if it is a literal string, not a bare cliloc number
* (the app ships no cliloc table). De-duplicated, blanks dropped.
*/
internal fun displayTitles(titles: TitlesDto?): List<String> {
if (titles == null) return emptyList()
val out = mutableListOf<String>()
titles.fameKarma?.let { out.add(it) }
titles.skill?.let { out.add(it) }
val reward = titles.reward
val sel = titles.selected ?: -1
val candidate = when {
sel in reward.indices -> reward[sel]
else -> reward.firstOrNull { it.isNotBlank() && !it.all(Char::isDigit) }
}
if (candidate != null && candidate.isNotBlank() && !candidate.all(Char::isDigit)) out.add(candidate)
return out.filter { it.isNotBlank() }.distinct()
}
private fun jsonText(element: kotlinx.serialization.json.JsonElement): String =
runCatching { element.jsonPrimitive.content }.getOrElse { element.toString() }

View File

@@ -0,0 +1,48 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.lifecycle.SavedStateHandle
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.data.api.dto.CharProfileDto
import com.runicgateway.app.data.repository.PlayerShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.navigation.Routes
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* A single character sheet (PLAN.md §6.3), read from `/player/shard/char/:serial`
* for a character on one of the caller's linked accounts (ownership-checked
* server-side). A `503` renders as offline/retry, a `403` as not-found (§7).
* Text-only presentation for v1.
*/
@HiltViewModel
class CharacterViewModel @Inject constructor(
private val repository: PlayerShardRepository,
savedStateHandle: SavedStateHandle,
) : ViewModel() {
private val serial: String = savedStateHandle.get<String>(Routes.Args.SERIAL).orEmpty()
private val _state = MutableStateFlow<UiState<CharProfileDto>>(UiState.Loading)
val state: StateFlow<UiState<CharProfileDto>> = _state.asStateFlow()
init {
load()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
_state.value = repository.char(serial).toUiState()
}
}
}

View File

@@ -0,0 +1,243 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material3.Button
import androidx.compose.material3.Card
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.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.text.input.KeyboardType
import androidx.compose.ui.text.input.PasswordVisualTransformation
import androidx.compose.ui.unit.dp
import androidx.compose.foundation.text.KeyboardOptions
import androidx.hilt.navigation.compose.hiltViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import com.runicgateway.app.R
import com.runicgateway.app.data.api.dto.RosterCharDto
import com.runicgateway.app.ui.ErrorKind
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 player's linked game accounts + character rosters (PLAN.md §6.3). Tapping a
* character opens its text-only sheet. Not-yet-linked players get the `[link` code
* prompt (and, when the shard offers it, a hybrid signup form).
*/
@Composable
fun CharactersScreen(
onOpenChar: (String) -> Unit,
modifier: Modifier = Modifier,
viewModel: CharactersViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
when (val accounts = state.accounts) {
is UiState.Loading -> LoadingView(modifier)
is UiState.Error -> ErrorView(accounts.kind, onRetry = viewModel::load, modifier = modifier)
is UiState.Success -> Column(
modifier = modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
.padding(16.dp),
verticalArrangement = Arrangement.spacedBy(12.dp),
) {
LinkCard(state, viewModel)
if (state.signupEnabled) CreateAccountCard(state, viewModel)
if (accounts.data.isEmpty()) {
Text(
stringResource(R.string.player_characters_empty),
style = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
} else {
accounts.data.forEach { account ->
AccountRoster(
account = account,
roster = state.rosters[account] ?: UiState.Loading,
onRetry = { viewModel.loadRoster(account) },
onOpenChar = onOpenChar,
)
}
}
}
}
}
@Composable
private fun LinkCard(state: CharactersViewModel.State, viewModel: CharactersViewModel) {
var code by rememberSaveable { mutableStateOf("") }
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Text(stringResource(R.string.player_link_title), style = MaterialTheme.typography.titleMedium)
Text(
stringResource(R.string.player_link_hint),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
OutlinedTextField(
value = code,
onValueChange = { code = it.uppercase() },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.player_link_code)) },
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
Button(
onClick = { viewModel.link(code); code = "" },
enabled = !state.busy && code.isNotBlank(),
modifier = Modifier.padding(top = 12.dp),
) { Text(stringResource(R.string.player_link_action)) }
FormFeedback(state.feedback)
}
}
}
@Composable
private fun CreateAccountCard(state: CharactersViewModel.State, viewModel: CharactersViewModel) {
var account by rememberSaveable { mutableStateOf("") }
var password by rememberSaveable { mutableStateOf("") }
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Text(stringResource(R.string.player_create_title), style = MaterialTheme.typography.titleMedium)
OutlinedTextField(
value = account,
onValueChange = { account = it },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.player_create_account)) },
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
OutlinedTextField(
value = password,
onValueChange = { password = it },
singleLine = true,
enabled = !state.busy,
label = { Text(stringResource(R.string.player_create_password)) },
visualTransformation = PasswordVisualTransformation(),
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Password),
modifier = Modifier.fillMaxWidth().padding(top = 12.dp),
)
Button(
onClick = { viewModel.createAccount(account, password); password = "" },
enabled = !state.busy && account.isNotBlank() && password.length >= 8,
modifier = Modifier.padding(top = 12.dp),
) { Text(stringResource(R.string.player_create_action)) }
}
}
}
@Composable
private fun AccountRoster(
account: String,
roster: UiState<List<RosterCharDto>>,
onRetry: () -> Unit,
onOpenChar: (String) -> Unit,
) {
Column {
Text(
account,
style = MaterialTheme.typography.titleSmall,
color = MaterialTheme.colorScheme.primary,
modifier = Modifier.padding(vertical = 8.dp),
)
when (roster) {
is UiState.Loading -> Text(
stringResource(R.string.player_roster_loading),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
is UiState.Error -> RosterError(roster.kind, onRetry)
is UiState.Success -> {
if (roster.data.isEmpty()) {
Text(
stringResource(R.string.player_roster_empty),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
} else {
roster.data.forEach { CharRow(it, onOpenChar) }
}
}
}
}
}
@Composable
private fun RosterError(kind: ErrorKind, onRetry: () -> Unit) {
Row(verticalAlignment = Alignment.CenterVertically) {
Text(
stringResource(
if (kind == ErrorKind.SHARD_OFFLINE) R.string.error_shard_offline else R.string.error_server,
),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.weight(1f),
)
TextButton(onClick = onRetry) { Text(stringResource(R.string.action_retry)) }
}
}
@Composable
private fun CharRow(char: RosterCharDto, onOpenChar: (String) -> Unit) {
Card(
Modifier
.fillMaxWidth()
.padding(vertical = 4.dp)
.clickable(enabled = char.serial.isNotBlank()) { onOpenChar(char.serial) },
) {
Row(
Modifier.fillMaxWidth().padding(14.dp),
verticalAlignment = Alignment.CenterVertically,
) {
Text(
char.name ?: stringResource(R.string.player_char_unknown),
style = MaterialTheme.typography.bodyLarge,
modifier = Modifier.weight(1f),
)
StatusPill(
text = stringResource(
if (char.online) R.string.player_char_online else R.string.player_char_offline,
),
tone = if (char.online) PillTone.Success else PillTone.Neutral,
modifier = Modifier.padding(end = 8.dp),
)
Text("", style = MaterialTheme.typography.titleMedium, color = MaterialTheme.colorScheme.onSurfaceVariant)
}
}
}
@Composable
private fun FormFeedback(feedback: CharactersViewModel.Feedback?) {
if (feedback == null) return
Text(
text = stringResource(feedback.messageRes),
style = MaterialTheme.typography.bodySmall,
color = if (feedback.ok) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.error,
modifier = Modifier.padding(top = 10.dp),
)
}

View File

@@ -0,0 +1,140 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
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.core.result.map
import com.runicgateway.app.data.api.dto.RosterCharDto
import com.runicgateway.app.data.repository.PlayerShardRepository
import com.runicgateway.app.data.repository.SettingsRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The player's linked game accounts + per-account character rosters (PLAN.md §6.3):
* link a game account with a `[link` one-time code (or, when the shard offers it,
* a hybrid signup), then browse characters and open a text-only sheet. A per-account
* roster carries its own load state so a down shard degrades that account to a
* retry without blocking the rest (§7).
*/
@HiltViewModel
class CharactersViewModel @Inject constructor(
private val repository: PlayerShardRepository,
private val settingsRepository: SettingsRepository,
) : ViewModel() {
/** A one-shot banner for the link / create-account forms. */
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
data class State(
val accounts: UiState<List<String>> = UiState.Loading,
val rosters: Map<String, UiState<List<RosterCharDto>>> = emptyMap(),
/** Whether the shard currently offers hybrid game-account signup. */
val signupEnabled: Boolean = false,
val busy: 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(accounts = UiState.Loading, rosters = emptyMap()) }
viewModelScope.launch {
when (val result = repository.accounts()) {
is ApiResult.Ok -> {
val names = result.data.map { it.account }
_state.update { it.copy(accounts = UiState.Success(names)) }
names.forEach { loadRoster(it) }
}
else -> _state.update { it.copy(accounts = result.map { emptyList<String>() }.toUiState()) }
}
}
// Non-critical: whether hybrid signup is offered right now.
viewModelScope.launch {
when (val settings = settingsRepository.getSettings()) {
is ApiResult.Ok -> _state.update { it.copy(signupEnabled = settings.data.gameAccountSignup) }
else -> Unit
}
}
}
fun loadRoster(account: String) {
_state.update { it.copy(rosters = it.rosters + (account to UiState.Loading)) }
viewModelScope.launch {
val roster = repository.roster(account).map { it.chars }.toUiState()
_state.update { it.copy(rosters = it.rosters + (account to roster)) }
}
}
fun clearFeedback() = _state.update { it.copy(feedback = null) }
fun link(code: String) {
if (_state.value.busy || code.isBlank()) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (val result = repository.link(code.trim())) {
is ApiResult.Ok -> {
_state.update { it.copy(busy = false, feedback = Feedback(true, R.string.player_link_ok)) }
load()
}
is ApiResult.HttpError -> _state.update {
it.copy(busy = false, feedback = Feedback(false, linkErrorRes(result.status)))
}
is ApiResult.NetworkError -> _state.update {
it.copy(busy = false, feedback = Feedback(false, R.string.error_network))
}
}
}
}
fun createAccount(account: String, password: String) {
if (_state.value.busy || account.isBlank() || password.length < 8) return
_state.update { it.copy(busy = true, feedback = null) }
viewModelScope.launch {
when (val result = repository.createAccount(account.trim(), password)) {
is ApiResult.Ok -> {
_state.update { it.copy(busy = false, feedback = Feedback(true, R.string.player_create_ok)) }
load()
}
is ApiResult.HttpError -> _state.update {
it.copy(busy = false, feedback = Feedback(false, createErrorRes(result.status)))
}
is ApiResult.NetworkError -> _state.update {
it.copy(busy = false, feedback = Feedback(false, R.string.error_network))
}
}
}
}
private fun linkErrorRes(status: Int): Int = when (status) {
400 -> R.string.player_link_bad_code
503 -> R.string.error_shard_offline
else -> R.string.player_link_error
}
private fun createErrorRes(status: Int): Int = when (status) {
409 -> R.string.player_create_taken
429 -> R.string.player_create_capped
403 -> R.string.player_create_unavailable
400 -> R.string.player_create_rejected
503 -> R.string.error_shard_offline
else -> R.string.player_create_error
}
}

View File

@@ -0,0 +1,106 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material3.Card
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.style.TextOverflow
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.PlayerHouseDto
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 player's own houses with home/decay status (PLAN.md §6.3), text-only. An
* IDOC house is flagged prominently. Only the caller's own property is ever shown.
*/
@Composable
fun MyHousesScreen(
modifier: Modifier = Modifier,
viewModel: MyHousesViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
when (val s = state) {
is UiState.Loading -> LoadingView(modifier)
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
is UiState.Success -> {
if (s.data.isEmpty()) {
EmptyView(stringResource(R.string.player_houses_empty), modifier)
} else {
LazyColumn(
modifier = modifier.fillMaxSize().padding(horizontal = 16.dp),
verticalArrangement = Arrangement.spacedBy(8.dp),
contentPadding = androidx.compose.foundation.layout.PaddingValues(vertical = 16.dp),
) {
items(s.data, key = { it.serial }) { house -> HouseCard(house) }
}
}
}
}
}
@Composable
private fun HouseCard(house: PlayerHouseDto) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Row(Modifier.fillMaxWidth()) {
Text(
text = house.name?.takeIf { it.isNotBlank() }
?: house.region
?: stringResource(R.string.player_house_fallback),
style = MaterialTheme.typography.titleMedium,
maxLines = 1,
overflow = TextOverflow.Ellipsis,
modifier = Modifier.weight(1f),
)
if (house.isIdoc) {
Text(
stringResource(R.string.houses_idoc_badge),
style = MaterialTheme.typography.labelMedium,
color = MaterialTheme.colorScheme.error,
)
}
}
house.stage?.takeIf { it.isNotBlank() }?.let {
Text(
stringResource(R.string.player_house_stage, it),
style = MaterialTheme.typography.bodySmall,
color = if (house.isIdoc) MaterialTheme.colorScheme.error else MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
}
val where = listOfNotNull(
house.region,
house.map,
house.x?.let { "(${house.x}, ${house.y})" },
).joinToString(" · ")
if (where.isNotBlank()) {
Text(
where,
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 4.dp),
)
}
}
}
}

View File

@@ -0,0 +1,41 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.data.api.dto.PlayerHouseDto
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.launch
import javax.inject.Inject
/**
* The player's OWN houses with decay/IDOC status (PLAN.md §6.3), read from
* `/player/shard/houses` — never anyone else's. A `503` renders as offline/retry (§7).
*/
@HiltViewModel
class MyHousesViewModel @Inject constructor(
private val repository: PlayerShardRepository,
) : ViewModel() {
private val _state = MutableStateFlow<UiState<List<PlayerHouseDto>>>(UiState.Loading)
val state: StateFlow<UiState<List<PlayerHouseDto>>> = _state.asStateFlow()
init {
load()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
_state.value = repository.houses().toUiState()
}
}
}

View File

@@ -0,0 +1,229 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.rememberScrollState
import androidx.compose.foundation.verticalScroll
import androidx.compose.material3.Card
import androidx.compose.material3.HorizontalDivider
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import androidx.hilt.navigation.compose.hiltViewModel
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import com.runicgateway.app.R
import com.runicgateway.app.data.api.dto.VendorDto
import com.runicgateway.app.data.api.dto.VendorListingDto
import com.runicgateway.app.data.api.dto.VendorSaleDto
import com.runicgateway.app.ui.ErrorKind
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.components.ErrorView
import com.runicgateway.app.ui.components.LoadingView
import java.text.DateFormat
import java.util.Date
/**
* The player's own player-vendors + recent sales (PLAN.md §6.3), text-only. Vendor
* shops group under their game account; recent sales list across all linked
* accounts. A down shard degrades to a per-account retry (§7).
*/
@Composable
fun VendorsScreen(
modifier: Modifier = Modifier,
viewModel: VendorsViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
when (val accounts = state.accounts) {
is UiState.Loading -> LoadingView(modifier)
is UiState.Error -> ErrorView(accounts.kind, onRetry = viewModel::load, modifier = modifier)
is UiState.Success -> Column(
modifier = modifier
.fillMaxSize()
.verticalScroll(rememberScrollState())
.padding(16.dp),
verticalArrangement = Arrangement.spacedBy(12.dp),
) {
SalesCard(state.sales)
if (accounts.data.isEmpty()) {
Text(
stringResource(R.string.player_vendors_no_accounts),
style = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
} else {
accounts.data.forEach { account ->
AccountVendors(
account = account,
vendors = state.vendors[account] ?: UiState.Loading,
onRetry = { viewModel.loadVendors(account) },
)
}
}
}
}
}
@Composable
private fun SalesCard(sales: UiState<List<VendorSaleDto>>) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Text(stringResource(R.string.player_sales_title), style = MaterialTheme.typography.titleMedium)
when (sales) {
is UiState.Loading -> Text(
stringResource(R.string.player_roster_loading),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
is UiState.Error -> Text(
stringResource(R.string.error_server),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
is UiState.Success -> {
if (sales.data.isEmpty()) {
Text(
stringResource(R.string.player_sales_empty),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
} else {
sales.data.forEach { SaleRow(it) }
}
}
}
}
}
}
@Composable
private fun SaleRow(sale: VendorSaleDto) {
Row(Modifier.fillMaxWidth().padding(top = 10.dp), horizontalArrangement = Arrangement.SpaceBetween) {
Column(Modifier.padding(end = 12.dp)) {
Text(
sale.itemType ?: stringResource(R.string.player_char_item),
style = MaterialTheme.typography.bodyMedium,
)
sale.t?.let {
Text(
DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT).format(Date(it)),
style = MaterialTheme.typography.labelSmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
}
}
Text(
stringResource(R.string.player_gold_amount, "%,d".format(sale.price ?: 0L)),
style = MaterialTheme.typography.bodyMedium,
)
}
}
@Composable
private fun AccountVendors(
account: String,
vendors: UiState<List<VendorDto>>,
onRetry: () -> Unit,
) {
Column {
Text(
account,
style = MaterialTheme.typography.titleSmall,
color = MaterialTheme.colorScheme.primary,
modifier = Modifier.padding(vertical = 8.dp),
)
when (vendors) {
is UiState.Loading -> Text(
stringResource(R.string.player_roster_loading),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
is UiState.Error -> VendorError(vendors.kind, onRetry)
is UiState.Success -> {
if (vendors.data.isEmpty()) {
Text(
stringResource(R.string.player_vendors_empty),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
} else {
vendors.data.forEach { VendorCard(it) }
}
}
}
}
}
@Composable
private fun VendorError(kind: ErrorKind, onRetry: () -> Unit) {
Row {
Text(
stringResource(if (kind == ErrorKind.SHARD_OFFLINE) R.string.error_shard_offline else R.string.error_server),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.weight(1f),
)
TextButton(onClick = onRetry) { Text(stringResource(R.string.action_retry)) }
}
}
@Composable
private fun VendorCard(vendor: VendorDto) {
Card(Modifier.fillMaxWidth().padding(vertical = 4.dp)) {
Column(Modifier.padding(16.dp)) {
Text(
vendor.shopName ?: stringResource(R.string.player_vendor_fallback),
style = MaterialTheme.typography.titleMedium,
)
val meta = listOfNotNull(
vendor.holdGold?.let { stringResource(R.string.player_vendor_hold, "%,d".format(it)) },
vendor.map,
).joinToString(" · ")
if (meta.isNotBlank()) {
Text(meta, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant, modifier = Modifier.padding(top = 2.dp))
}
if (vendor.listings.isNotEmpty()) {
HorizontalDivider(Modifier.padding(vertical = 8.dp))
vendor.listings.forEach { ListingRow(it) }
} else {
Text(
stringResource(R.string.player_vendor_no_listings),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 8.dp),
)
}
}
}
}
@Composable
private fun ListingRow(listing: VendorListingDto) {
Row(Modifier.fillMaxWidth().padding(vertical = 3.dp), horizontalArrangement = Arrangement.SpaceBetween) {
Text(
stringResource(R.string.player_listing_item, listing.itemId ?: 0, listing.amount ?: 1),
style = MaterialTheme.typography.bodySmall,
modifier = Modifier.weight(1f),
)
Text(
stringResource(R.string.player_gold_amount, "%,d".format(listing.price ?: 0L)),
style = MaterialTheme.typography.bodySmall,
)
}
}

View File

@@ -0,0 +1,72 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.player
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.core.result.map
import com.runicgateway.app.data.api.dto.VendorDto
import com.runicgateway.app.data.api.dto.VendorSaleDto
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
/**
* The player's own player-vendors and recent vendor sales (PLAN.md §6.3): a
* per-account vendor snapshot (shops + listings) over `/player/shard/vendors/:account`
* plus the recent-sales log over `/player/shard/sales`. Each account's snapshot
* carries its own load state so a down shard degrades one account to a retry (§7).
* Text-only listings — item names are clilocs the app has no table for.
*/
@HiltViewModel
class VendorsViewModel @Inject constructor(
private val repository: PlayerShardRepository,
) : ViewModel() {
data class State(
val accounts: UiState<List<String>> = UiState.Loading,
val vendors: Map<String, UiState<List<VendorDto>>> = emptyMap(),
val sales: UiState<List<VendorSaleDto>> = UiState.Loading,
)
private val _state = MutableStateFlow(State())
val state: StateFlow<State> = _state.asStateFlow()
init {
load()
}
fun load() {
_state.update { it.copy(accounts = UiState.Loading, vendors = emptyMap(), sales = UiState.Loading) }
viewModelScope.launch {
when (val result = repository.accounts()) {
is ApiResult.Ok -> {
val names = result.data.map { it.account }
_state.update { it.copy(accounts = UiState.Success(names)) }
names.forEach { loadVendors(it) }
}
else -> _state.update { it.copy(accounts = result.map { emptyList<String>() }.toUiState()) }
}
}
viewModelScope.launch {
_state.update { it.copy(sales = repository.sales().toUiState()) }
}
}
fun loadVendors(account: String) {
_state.update { it.copy(vendors = it.vendors + (account to UiState.Loading)) }
viewModelScope.launch {
val vendors = repository.vendors(account).map { it.vendors }.toUiState()
_state.update { it.copy(vendors = it.vendors + (account to vendors)) }
}
}
}

View File

@@ -0,0 +1,39 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.session
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.auth.Session
import com.runicgateway.app.core.auth.SessionManager
import com.runicgateway.app.data.repository.AuthRepository
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* Activity-scoped view of the current session for the app shell (PLAN.md §4.3,
* §5): the shared menu observes [session] to reveal signed-in groups + the
* sign-in/out toggle, and the shell drives resume re-validation and sign-out.
* Login itself lives in [com.runicgateway.app.ui.auth.LoginViewModel].
*/
@HiltViewModel
class SessionViewModel @Inject constructor(
sessionManager: SessionManager,
private val authRepository: AuthRepository,
) : ViewModel() {
val session: StateFlow<Session> = sessionManager.state
/** Re-validate the cached role against the backend on app resume. */
fun revalidate() {
viewModelScope.launch { authRepository.revalidate() }
}
/** Sign out of this session, or every session with [allDevices]. */
fun signOut(allDevices: Boolean = false) {
viewModelScope.launch { authRepository.logout(allDevices) }
}
}

View File

@@ -0,0 +1,108 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Card
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.style.TextOverflow
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.ChampDto
import com.runicgateway.app.ui.components.PillTone
import com.runicgateway.app.ui.components.StatusPill
/** The champion-spawn board (PLAN.md §6.2), live via SSE deltas. */
@Composable
fun ChampsScreen(
modifier: Modifier = Modifier,
viewModel: ChampsViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val connected by viewModel.connected.collectAsStateWithLifecycle()
LiveBoardScreen(
emptyMessage = stringResource(R.string.champs_empty),
state = state,
connected = connected,
onRetry = viewModel::load,
key = { it.serial },
modifier = modifier,
) { champ -> ChampCard(champ) }
}
@Composable
private fun ChampCard(champ: ChampDto) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Row(Modifier.fillMaxWidth()) {
Text(
text = champ.name ?: champ.type ?: stringResource(R.string.champs_fallback_name),
style = MaterialTheme.typography.titleMedium,
maxLines = 1,
overflow = TextOverflow.Ellipsis,
modifier = Modifier.weight(1f),
)
champ.status?.let {
StatusPill(text = it, tone = champStatusTone(it))
}
}
val detail = champDetail(champ)
if (detail.isNotBlank()) {
Text(
text = detail,
style = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
}
val where = listOfNotNull(champ.map, champ.x?.let { "(${champ.x}, ${champ.y})" }).joinToString(" ")
if (where.isNotBlank()) {
Text(
text = where,
style = MaterialTheme.typography.labelSmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 4.dp),
)
}
}
}
}
/** Map a champ status to a pill tone: live spawns read green, cooldowns amber. */
private fun champStatusTone(status: String): PillTone = when (status.lowercase()) {
"active", "up", "spawned" -> PillTone.Success
"cooldown", "restarting", "advancing" -> PillTone.Warning
else -> PillTone.Neutral
}
/** A short category-specific status line, mirroring the website's champ detail. */
@Composable
private fun champDetail(champ: ChampDto): String = when (champ.category) {
"sea" -> if (champ.hitsMax != null) {
"%,d / %,d hp".format(champ.hits ?: 0, champ.hitsMax)
} else {
champ.boss ?: champ.type ?: ""
}
"mini" -> stringResource(R.string.champ_level, champ.level ?: 0)
else -> when (champ.status) {
"active" -> if (champ.maxKills != null) {
"%,d / %,d kills".format(champ.kills ?: 0, champ.maxKills)
} else {
stringResource(R.string.champ_level, champ.level ?: 0)
}
"cooldown" -> stringResource(R.string.champ_cooldown)
else -> ""
}
}

View File

@@ -0,0 +1,85 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.ChampDto
import com.runicgateway.app.data.repository.ShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The champion-spawn board (PLAN.md §6.2): loaded once from `/public/shard/champs`,
* then kept live by merging `champ.update` / `champ.remove` frames in place. Rows
* are ordered by category then name for a stable display.
*/
@HiltViewModel
class ChampsViewModel @Inject constructor(
private val repository: ShardRepository,
) : ViewModel() {
private val board = LiveBoard<ChampDto> { it.serial.toString() }
private val _state = MutableStateFlow<UiState<List<ChampDto>>>(UiState.Loading)
val state: StateFlow<UiState<List<ChampDto>>> = _state.asStateFlow()
private val _connected = MutableStateFlow(false)
val connected: StateFlow<Boolean> = _connected.asStateFlow()
init {
load()
collectLive()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
when (val result = repository.champs()) {
is ApiResult.Ok -> {
board.seed(result.data)
publish()
}
else -> _state.value = result.toUiState()
}
}
}
private fun collectLive() {
viewModelScope.launch {
repository.liveEvents().collect { event ->
when (event) {
is ShardStreamEvent.Open -> _connected.value = true
is ShardStreamEvent.Closed -> _connected.value = false
is ShardStreamEvent.Frame -> applyFrame(event)
}
}
}
}
private fun applyFrame(frame: ShardStreamEvent.Frame) {
when (frame.kind) {
"champ.update" -> repository.champFrame(frame.data)?.let { board.upsert(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).
if (_state.value is UiState.Success) publish()
}
private fun publish() {
val rows = board.values().sortedWith(
compareBy({ it.category ?: "" }, { it.name ?: it.type ?: "" }),
)
_state.value = UiState.Success(rows)
}
}

View File

@@ -0,0 +1,28 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import kotlinx.serialization.json.JsonNull
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.JsonPrimitive
/**
* Minimal typed reads from a raw SSE frame [JsonObject] for the fields a board's
* `*.remove` / `*.decay` delta needs when the whole frame doesn't warrant decoding
* into a DTO (e.g. `champ.remove` carries only a `serial`). Returns null on a
* missing or ill-typed field so a malformed frame is skipped, not fatal.
*/
object FrameFields {
fun longField(obj: JsonObject, key: String): Long? {
val el = obj[key]
if (el !is JsonPrimitive || el is JsonNull) return null
return el.content.toLongOrNull()
}
fun stringField(obj: JsonObject, key: String): String? {
val el = obj[key]
if (el !is JsonPrimitive || el is JsonNull) return null
return el.content
}
}

View File

@@ -0,0 +1,147 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material3.Card
import androidx.compose.material3.HorizontalDivider
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
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.data.api.dto.GovernorDto
import com.runicgateway.app.data.api.dto.GovernorTermDto
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 town-governor board (PLAN.md §6.2), live via `city.update`, with per-city history. */
@Composable
fun GovernorsScreen(
modifier: Modifier = Modifier,
viewModel: GovernorsViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val connected by viewModel.connected.collectAsStateWithLifecycle()
val history by viewModel.history.collectAsStateWithLifecycle()
Column(modifier = modifier.fillMaxSize()) {
Row(
Modifier.fillMaxWidth().padding(horizontal = 16.dp, vertical = 10.dp),
horizontalArrangement = Arrangement.End,
) {
LiveChip(connected)
}
when (val s = state) {
is UiState.Loading -> LoadingView()
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load)
is UiState.Success -> {
if (s.data.isEmpty()) {
EmptyView(stringResource(R.string.governors_empty))
} else {
LazyColumn(
modifier = Modifier.fillMaxSize().padding(horizontal = 16.dp),
verticalArrangement = Arrangement.spacedBy(8.dp),
contentPadding = androidx.compose.foundation.layout.PaddingValues(bottom = 16.dp),
) {
items(s.data, key = { it.city }) { city ->
CityCard(
city = city,
terms = history[city.city],
onExpand = { viewModel.loadHistory(city.city) },
)
}
}
}
}
}
}
}
@Composable
private fun CityCard(
city: GovernorDto,
terms: List<GovernorTermDto>?,
onExpand: () -> Unit,
) {
var expanded by remember { mutableStateOf(false) }
Card(Modifier.fillMaxWidth()) {
Column {
Column(
Modifier
.fillMaxWidth()
.clickable {
expanded = !expanded
if (expanded) onExpand()
}
.padding(16.dp),
) {
Text(city.city, style = MaterialTheme.typography.titleMedium)
Text(
text = city.governor?.label?.let { stringResource(R.string.governor_current, it) }
?: stringResource(R.string.governor_none),
style = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 4.dp),
)
city.electionPhase?.takeIf { it.isNotBlank() && !it.equals("none", ignoreCase = true) }?.let {
Text(
text = stringResource(R.string.governor_election, it),
style = MaterialTheme.typography.labelSmall,
color = MaterialTheme.colorScheme.primary,
modifier = Modifier.padding(top = 2.dp),
)
}
}
if (expanded) {
HorizontalDivider()
Column(Modifier.padding(16.dp)) {
Text(
stringResource(R.string.governor_history),
style = MaterialTheme.typography.titleSmall,
)
when {
terms == null -> Text(
stringResource(R.string.governor_history_loading),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
terms.isEmpty() -> Text(
stringResource(R.string.governor_history_empty),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
else -> terms.forEach { term ->
Text(
text = term.governor?.label ?: stringResource(R.string.governor_none),
style = MaterialTheme.typography.bodySmall,
modifier = Modifier.padding(top = 6.dp),
)
}
}
}
}
}
}
}

View File

@@ -0,0 +1,96 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.GovernorDto
import com.runicgateway.app.data.api.dto.GovernorTermDto
import com.runicgateway.app.data.repository.ShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The town-governor board (PLAN.md §6.2): loaded from `/public/shard/governors`,
* kept live by `city.update` frames (keyed by city — cities are fixed, so there is
* no remove). Empty on shards without City Loyalty. A city's term ledger is fetched
* on demand via [loadHistory] for the look-back panel.
*/
@HiltViewModel
class GovernorsViewModel @Inject constructor(
private val repository: ShardRepository,
) : ViewModel() {
private val board = LiveBoard<GovernorDto> { it.city }
private val _state = MutableStateFlow<UiState<List<GovernorDto>>>(UiState.Loading)
val state: StateFlow<UiState<List<GovernorDto>>> = _state.asStateFlow()
private val _connected = MutableStateFlow(false)
val connected: StateFlow<Boolean> = _connected.asStateFlow()
/** Per-city expanded term history, loaded lazily; absent = not yet requested. */
private val _history = MutableStateFlow<Map<String, List<GovernorTermDto>>>(emptyMap())
val history: StateFlow<Map<String, List<GovernorTermDto>>> = _history.asStateFlow()
init {
load()
collectLive()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
when (val result = repository.governors()) {
is ApiResult.Ok -> {
board.seed(result.data)
publish()
}
else -> _state.value = result.toUiState()
}
}
}
/** Fetch (once) the term ledger for [city] for its expandable history panel. */
fun loadHistory(city: String) {
if (_history.value.containsKey(city)) return
viewModelScope.launch {
val terms = (repository.governorHistory(city) as? ApiResult.Ok)?.data ?: emptyList()
_history.value = _history.value + (city to terms)
}
}
private fun collectLive() {
viewModelScope.launch {
repository.liveEvents().collect { event ->
when (event) {
is ShardStreamEvent.Open -> _connected.value = true
is ShardStreamEvent.Closed -> _connected.value = false
is ShardStreamEvent.Frame -> applyFrame(event)
}
}
}
}
private fun applyFrame(frame: ShardStreamEvent.Frame) {
if (frame.kind != "city.update") return
val gov = repository.governorFrame(frame.data) ?: return
if (gov.city.isBlank()) return
board.upsert(gov)
if (_state.value is UiState.Success) publish()
}
private fun publish() {
val rows = board.values().sortedBy { it.city.lowercase() }
_state.value = UiState.Success(rows)
}
}

View File

@@ -0,0 +1,84 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Card
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.style.TextOverflow
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.GuildDto
/** The guild board (PLAN.md §6.2), live via SSE deltas. */
@Composable
fun GuildsScreen(
modifier: Modifier = Modifier,
viewModel: GuildsViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val connected by viewModel.connected.collectAsStateWithLifecycle()
LiveBoardScreen(
emptyMessage = stringResource(R.string.guilds_empty),
state = state,
connected = connected,
onRetry = viewModel::load,
key = { it.id },
modifier = modifier,
) { guild -> GuildCard(guild) }
}
@Composable
private fun GuildCard(guild: GuildDto) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Row(Modifier.fillMaxWidth()) {
Text(
text = buildString {
guild.abbr?.takeIf { it.isNotBlank() }?.let { append("[").append(it).append("] ") }
append(guild.name ?: stringResource(R.string.guilds_fallback_name))
},
style = MaterialTheme.typography.titleMedium,
maxLines = 1,
overflow = TextOverflow.Ellipsis,
modifier = Modifier.weight(1f),
)
guild.members?.let {
Text(
text = stringResource(R.string.guilds_members, it),
style = MaterialTheme.typography.labelMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
}
}
guild.leader?.let { leader ->
Text(
text = stringResource(R.string.guilds_leader, leader.label),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
}
guild.alliance?.takeIf { it.isNotBlank() }?.let { alliance ->
Text(
text = stringResource(R.string.guilds_alliance, alliance),
style = MaterialTheme.typography.labelSmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 2.dp),
)
}
}
}
}

View File

@@ -0,0 +1,83 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.GuildDto
import com.runicgateway.app.data.repository.ShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The guild board (PLAN.md §6.2): loaded from `/public/shard/guilds`, kept live by
* `guild.update` / `guild.remove` frames. `guild.join` is a membership tick that
* carries no board snapshot, so it is ignored here (the roster count refreshes on
* the next `guild.update`). Rows are ordered by name.
*/
@HiltViewModel
class GuildsViewModel @Inject constructor(
private val repository: ShardRepository,
) : ViewModel() {
private val board = LiveBoard<GuildDto> { it.id.toString() }
private val _state = MutableStateFlow<UiState<List<GuildDto>>>(UiState.Loading)
val state: StateFlow<UiState<List<GuildDto>>> = _state.asStateFlow()
private val _connected = MutableStateFlow(false)
val connected: StateFlow<Boolean> = _connected.asStateFlow()
init {
load()
collectLive()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
when (val result = repository.guilds()) {
is ApiResult.Ok -> {
board.seed(result.data)
publish()
}
else -> _state.value = result.toUiState()
}
}
}
private fun collectLive() {
viewModelScope.launch {
repository.liveEvents().collect { event ->
when (event) {
is ShardStreamEvent.Open -> _connected.value = true
is ShardStreamEvent.Closed -> _connected.value = false
is ShardStreamEvent.Frame -> applyFrame(event)
}
}
}
}
private fun applyFrame(frame: ShardStreamEvent.Frame) {
when (frame.kind) {
"guild.update" -> repository.guildFrame(frame.data)?.let { board.upsert(it) }
"guild.remove" -> FrameFields.longField(frame.data, "id")?.let { board.remove(it.toString()) }
else -> return
}
if (_state.value is UiState.Success) publish()
}
private fun publish() {
val rows = board.values().sortedBy { it.name?.lowercase() ?: "" }
_state.value = UiState.Success(rows)
}
}

View File

@@ -0,0 +1,79 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Card
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.text.style.TextOverflow
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.HouseDto
import com.runicgateway.app.ui.components.PillTone
import com.runicgateway.app.ui.components.StatusPill
/** The public "falling houses" (IDOC) board (PLAN.md §6.2), live via `house.decay`. */
@Composable
fun HousesScreen(
modifier: Modifier = Modifier,
viewModel: HousesViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val connected by viewModel.connected.collectAsStateWithLifecycle()
LiveBoardScreen(
emptyMessage = stringResource(R.string.houses_empty),
state = state,
connected = connected,
onRetry = viewModel::load,
key = { it.serial },
modifier = modifier,
) { house -> HouseCard(house) }
}
@Composable
private fun HouseCard(house: HouseDto) {
Card(Modifier.fillMaxWidth()) {
Column(Modifier.padding(16.dp)) {
Row(Modifier.fillMaxWidth()) {
Text(
text = house.name?.takeIf { it.isNotBlank() }
?: house.region
?: stringResource(R.string.houses_fallback_name),
style = MaterialTheme.typography.titleMedium,
maxLines = 1,
overflow = TextOverflow.Ellipsis,
modifier = Modifier.weight(1f),
)
StatusPill(
text = stringResource(R.string.houses_idoc_badge),
tone = PillTone.Danger,
)
}
val where = listOfNotNull(
house.region,
house.map,
house.x?.let { "(${house.x}, ${house.y})" },
).joinToString(" · ")
if (where.isNotBlank()) {
Text(
text = where,
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
}
}
}
}

View File

@@ -0,0 +1,99 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.HouseDto
import com.runicgateway.app.data.repository.ShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/**
* The public houses board (PLAN.md §6.2): the "where are the falling houses" view —
* loaded from `/public/shard/houses` (IDOC only, location only) and kept live by
* `house.decay` frames. A house entering IDOC adds/updates its row; any other decay
* transition (refreshed, collapsed) drops it. Rows are ordered by region.
*/
@HiltViewModel
class HousesViewModel @Inject constructor(
private val repository: ShardRepository,
) : ViewModel() {
private val board = LiveBoard<HouseDto> { it.serial.toString() }
private val _state = MutableStateFlow<UiState<List<HouseDto>>>(UiState.Loading)
val state: StateFlow<UiState<List<HouseDto>>> = _state.asStateFlow()
private val _connected = MutableStateFlow(false)
val connected: StateFlow<Boolean> = _connected.asStateFlow()
init {
load()
collectLive()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
when (val result = repository.houses()) {
is ApiResult.Ok -> {
board.seed(result.data)
publish()
}
else -> _state.value = result.toUiState()
}
}
}
private fun collectLive() {
viewModelScope.launch {
repository.liveEvents().collect { event ->
when (event) {
is ShardStreamEvent.Open -> _connected.value = true
is ShardStreamEvent.Closed -> _connected.value = false
is ShardStreamEvent.Frame -> applyFrame(event)
}
}
}
}
private fun applyFrame(frame: ShardStreamEvent.Frame) {
if (frame.kind != "house.decay") 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")
if (stage?.equals("IDOC", ignoreCase = true) == true) {
board.upsert(
HouseDto(
serial = serial,
name = FrameFields.stringField(frame.data, "name"),
region = FrameFields.stringField(frame.data, "region"),
map = FrameFields.stringField(frame.data, "map"),
x = FrameFields.longField(frame.data, "x")?.toInt(),
y = FrameFields.longField(frame.data, "y")?.toInt(),
z = FrameFields.longField(frame.data, "z")?.toInt(),
isIdoc = true,
),
)
} else {
board.remove(serial.toString())
}
if (_state.value is UiState.Success) publish()
}
private fun publish() {
val rows = board.values().sortedBy { it.region?.lowercase() ?: "" }
_state.value = UiState.Success(rows)
}
}

View File

@@ -0,0 +1,33 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
/**
* A live board keyed by a stable id: seeded from a snapshot read, then kept current
* by SSE `*.update` / `*.remove` deltas (PLAN.md §6.2). Insertion order is
* preserved (a [LinkedHashMap]) so re-seeding is deterministic; callers sort for
* display. Not thread-safe — mutate it only from the owning ViewModel coroutine.
*/
class LiveBoard<T>(private val idOf: (T) -> String) {
private val items = LinkedHashMap<String, T>()
/** Replace the whole board with a fresh snapshot. */
fun seed(snapshot: List<T>) {
items.clear()
for (item in snapshot) items[idOf(item)] = item
}
/** Insert or update one entry (a `*.update` frame). */
fun upsert(item: T) {
items[idOf(item)] = item
}
/** Drop one entry by id (a `*.remove` frame). No-op if absent. */
fun remove(id: String) {
items.remove(id)
}
/** The current board contents, in insertion order. */
fun values(): List<T> = items.values.toList()
}

View File

@@ -0,0 +1,98 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp
import com.runicgateway.app.R
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.theme.ShardSuccess
import com.runicgateway.app.ui.theme.ShardSuccessDot
/**
* A small "Live / Offline" indicator for the shard screens (PLAN.md §6.2): a dot +
* label reflecting the SSE connection state. Green when connected, muted otherwise.
*/
@Composable
fun LiveChip(connected: Boolean, modifier: Modifier = Modifier) {
val dotColor = if (connected) ShardSuccessDot else MaterialTheme.colorScheme.onSurfaceVariant
val textColor = if (connected) ShardSuccess else MaterialTheme.colorScheme.onSurfaceVariant
Row(modifier = modifier, verticalAlignment = Alignment.CenterVertically) {
androidx.compose.foundation.layout.Box(
Modifier
.size(8.dp)
.clip(CircleShape)
.background(dotColor),
)
Text(
text = stringResource(if (connected) R.string.shard_live else R.string.shard_offline),
style = MaterialTheme.typography.labelMedium,
color = textColor,
modifier = Modifier.padding(start = 6.dp),
)
}
}
/**
* The shared scaffold for a live shard board (champs/guilds/houses): a [LiveChip]
* header over the board list, folding [state] into loading/error/empty/content
* (§7). Each caller supplies the per-row composable. Governors use their own layout
* (expandable history), so they don't route through this.
*/
@Composable
fun <T> LiveBoardScreen(
emptyMessage: String,
state: UiState<List<T>>,
connected: Boolean,
onRetry: () -> Unit,
key: (T) -> Any,
modifier: Modifier = Modifier,
row: @Composable (T) -> Unit,
) {
Column(modifier = modifier.fillMaxSize()) {
Row(
Modifier.fillMaxWidth().padding(horizontal = 16.dp, vertical = 10.dp),
horizontalArrangement = Arrangement.End,
) {
LiveChip(connected)
}
when (state) {
is UiState.Loading -> LoadingView()
is UiState.Error -> ErrorView(state.kind, onRetry = onRetry)
is UiState.Success -> {
if (state.data.isEmpty()) {
EmptyView(emptyMessage)
} else {
LazyColumn(
modifier = Modifier.fillMaxSize().padding(horizontal = 16.dp),
verticalArrangement = Arrangement.spacedBy(8.dp),
contentPadding = androidx.compose.foundation.layout.PaddingValues(bottom = 16.dp),
) {
items(state.data, key = key) { item -> row(item) }
}
}
}
}
}
}

View File

@@ -0,0 +1,90 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.JsonNull
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.JsonPrimitive
import kotlinx.serialization.json.jsonObject
/**
* One-line human descriptions of shard events for the live activity feed
* (PLAN.md §6.2). Mirrors the website's `lib/shardEvents.js` `describe()` for the
* public-safe kinds, so the app reads the same as the site. Accepts the event
* fields as a [JsonObject] — the live SSE frame carries them at the top level;
* a stored feed row carries them under `payload` (unwrap before calling).
*/
object ShardEventText {
fun describe(kind: String, fields: JsonObject): String = when (kind) {
"player.death" ->
"${nameOf(fields["who"])} was slain" + fields["killer"].let { if (isPresent(it)) " by ${nameOf(it)}" else "" }
"player.murdered" ->
"${nameOf(fields["victim"])} was murdered" + fields["murderer"].let { if (isPresent(it)) " by ${nameOf(it)}" else "" }
"mob.killed" -> "${nameOf(fields["killer"])} killed ${nameOf(fields["killed"])}"
"skill.gain" -> "${nameOf(fields["who"])} gained ${str(fields["skill"])}".trim()
"fame.change" -> "${nameOf(fields["who"])}s fame changed to ${num(fields["new"])}"
"karma.change" -> "${nameOf(fields["who"])}s karma changed to ${num(fields["new"])}"
"quest.complete" -> "${nameOf(fields["who"])} completed “${str(fields["quest"])}"
"house.decay" -> {
val name = str(fields["name"]).ifBlank { "A house" }
val stage = str(fields["to"]).ifBlank { str(fields["stage"]) }
val region = str(fields["region"])
"$name is now $stage" + if (region.isNotBlank()) "$region" else ""
}
"mob.login" -> "${nameOf(fields["who"])} entered the world"
"mob.logout" -> "${nameOf(fields["who"])} left the world"
"economy.supply" -> "Gold supply: ${num(fields["gold"])} across ${num(fields["accounts"])} accounts"
"server.hello" -> "Shard online — ${num(fields["accounts"])} accounts, ${num(fields["mobiles"])} mobiles"
"server.shutdown" -> "Shard shut down"
"server.crashed" -> "Shard crashed" + str(fields["error"]).let { if (it.isNotBlank()) ": $it" else "" }
"champ.update" -> {
val where = str(fields["name"]).ifBlank { str(fields["type"]).ifBlank { "A champion spawn" } }
when {
str(fields["status"]) == "active" && bool(fields["bossUp"]) ->
"$where: boss is up" + str(fields["boss"]).let { if (it.isNotBlank()) " ($it)" else "" }
str(fields["status"]) == "active" -> "$where is active"
str(fields["status"]) == "cooldown" -> "$where is on cooldown"
else -> "$where is ${str(fields["status"]).ifBlank { "idle" }}"
}
}
"champ.remove" -> "A champion spawn ended"
"guild.update" -> "${str(fields["name"]).ifBlank { "A guild" }} updated"
"guild.remove" -> "A guild disbanded"
"guild.join" -> "${nameOf(fields["who"])} joined ${str(fields["guild"]).ifBlank { "a guild" }}".trim()
"city.update" -> {
val gov = fields["governor"]
if (isPresent(gov)) "${str(fields["city"])} is governed by ${nameOf(gov)}"
else "${str(fields["city"])} has no governor"
}
"presence.online" -> "${num(fields["count"])} players online"
"region.enter" -> "${nameOf(fields["who"])} entered ${str(fields["region"]).ifBlank { "a region" }}".trim()
else -> kind
}
// ── field helpers ─────────────────────────────────────────────────────
private fun isPresent(el: JsonElement?): Boolean = el != null && el !is JsonNull
/** Name of an actor that may be a bare string or a `{ name, acct }` object. */
private fun nameOf(el: JsonElement?): String {
if (!isPresent(el)) return "Someone"
if (el is JsonPrimitive) return el.content.ifBlank { "Someone" }
val obj = runCatching { el!!.jsonObject }.getOrNull() ?: return "Someone"
return str(obj["name"]).ifBlank { str(obj["acct"]).ifBlank { "Someone" } }
}
private fun str(el: JsonElement?): String =
if (el is JsonPrimitive && el !is JsonNull) el.content else ""
private fun bool(el: JsonElement?): Boolean =
el is JsonPrimitive && el.content.equals("true", ignoreCase = true)
/** Format a numeric field with thousands grouping; falls back to its raw text. */
private fun num(el: JsonElement?): String {
val raw = str(el)
val d = raw.toDoubleOrNull() ?: return raw
return if (d == d.toLong().toDouble()) "%,d".format(d.toLong()) else "%,.0f".format(d)
}
}

View File

@@ -0,0 +1,221 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material3.Card
import androidx.compose.material3.HorizontalDivider
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.text.style.TextOverflow
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.OnlineStaffDto
import com.runicgateway.app.data.api.dto.ShardStatusDto
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.components.ErrorView
import com.runicgateway.app.ui.components.FeatureCard
import com.runicgateway.app.ui.components.LoadingView
import com.runicgateway.app.ui.components.PillTone
import com.runicgateway.app.ui.components.SectionLabel
import com.runicgateway.app.ui.components.StatusPill
/** Board destinations reachable from the hub. */
enum class ShardBoard { CHAMPS, GUILDS, GOVERNORS, HOUSES }
/**
* The Shard hub (PLAN.md §6.2): live connection status, online count + latest
* economy, presence, staff online, links to the boards, and a live activity feed.
* The whole screen degrades gracefully — status drives loading/error, the feed
* simply shows "offline" when the SSE stream is down (§7).
*/
@Composable
fun ShardScreen(
onOpenBoard: (ShardBoard) -> Unit,
modifier: Modifier = Modifier,
viewModel: ShardViewModel = hiltViewModel(),
) {
val state by viewModel.state.collectAsStateWithLifecycle()
val feed by viewModel.feed.collectAsStateWithLifecycle()
val connected by viewModel.connected.collectAsStateWithLifecycle()
when (val s = state) {
is UiState.Loading -> LoadingView(modifier)
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
is UiState.Success -> HubContent(
hub = s.data,
feed = feed,
connected = connected,
onOpenBoard = onOpenBoard,
modifier = modifier,
)
}
}
@Composable
private fun HubContent(
hub: ShardHub,
feed: List<FeedLine>,
connected: Boolean,
onOpenBoard: (ShardBoard) -> Unit,
modifier: Modifier = Modifier,
) {
LazyColumn(
modifier = modifier.fillMaxSize().padding(horizontal = 16.dp),
verticalArrangement = Arrangement.spacedBy(12.dp),
contentPadding = androidx.compose.foundation.layout.PaddingValues(vertical = 16.dp),
) {
item { StatusCard(hub.status, hub.presence?.count) }
item { BoardsCard(onOpenBoard) }
if (hub.online.isNotEmpty()) {
item { SectionHeader(stringResource(R.string.shard_section_staff)) }
items(hub.online, key = { it.serial ?: it.name.hashCode().toLong() }) { staff ->
StaffRow(staff)
}
}
item {
Row(
Modifier.fillMaxWidth().padding(top = 4.dp),
horizontalArrangement = Arrangement.SpaceBetween,
verticalAlignment = Alignment.CenterVertically,
) {
SectionHeader(stringResource(R.string.shard_section_activity))
LiveChip(connected)
}
}
if (feed.isEmpty()) {
item {
Text(
stringResource(R.string.shard_feed_empty),
style = MaterialTheme.typography.bodyMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(vertical = 8.dp),
)
}
} else {
items(feed, key = { it.id }) { line -> FeedRow(line) }
}
}
}
@Composable
private fun StatusCard(status: ShardStatusDto, presenceCount: Int?) {
FeatureCard {
Row(
Modifier.fillMaxWidth(),
horizontalArrangement = Arrangement.SpaceBetween,
verticalAlignment = Alignment.CenterVertically,
) {
Column(Modifier.weight(1f)) {
Text(
text = stringResource(
if (status.isOnline) R.string.shard_status_online else R.string.shard_status_offline,
),
style = MaterialTheme.typography.titleMedium,
color = MaterialTheme.colorScheme.onSurface,
)
val online = presenceCount ?: status.onlineCount
Text(
text = stringResource(R.string.shard_online_count, online),
style = MaterialTheme.typography.labelMedium,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 6.dp),
)
status.economy?.gold?.let { gold ->
Text(
text = stringResource(R.string.shard_economy_gold, "%,.0f".format(gold)),
style = MaterialTheme.typography.bodySmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
modifier = Modifier.padding(top = 2.dp),
)
}
}
StatusPill(
text = stringResource(
if (status.isOnline) R.string.shard_live else R.string.shard_offline,
),
tone = if (status.isOnline) PillTone.Success else PillTone.Neutral,
)
}
}
}
@Composable
private fun BoardsCard(onOpenBoard: (ShardBoard) -> Unit) {
val boards = listOf(
ShardBoard.CHAMPS to R.string.shard_nav_champs,
ShardBoard.GUILDS to R.string.shard_nav_guilds,
ShardBoard.GOVERNORS to R.string.shard_nav_governors,
ShardBoard.HOUSES to R.string.shard_nav_houses,
)
Card(Modifier.fillMaxWidth()) {
Column {
boards.forEachIndexed { index, (board, labelRes) ->
Text(
text = stringResource(labelRes),
style = MaterialTheme.typography.bodyLarge,
modifier = Modifier
.fillMaxWidth()
.clickable { onOpenBoard(board) }
.padding(horizontal = 16.dp, vertical = 14.dp),
)
if (index < boards.lastIndex) HorizontalDivider()
}
}
}
}
@Composable
private fun SectionHeader(text: String) {
SectionLabel(text = text, modifier = Modifier.padding(top = 4.dp))
}
@Composable
private fun StaffRow(staff: OnlineStaffDto) {
Row(
Modifier.fillMaxWidth().padding(vertical = 6.dp),
verticalAlignment = Alignment.CenterVertically,
) {
Text(
text = staff.name ?: "",
style = MaterialTheme.typography.bodyMedium,
modifier = Modifier.weight(1f),
)
staff.map?.let {
Text(
text = it,
style = MaterialTheme.typography.labelSmall,
color = MaterialTheme.colorScheme.onSurfaceVariant,
)
}
}
}
@Composable
private fun FeedRow(line: FeedLine) {
Text(
text = line.text,
style = MaterialTheme.typography.bodyMedium,
maxLines = 2,
overflow = TextOverflow.Ellipsis,
modifier = Modifier.fillMaxWidth().padding(vertical = 6.dp),
)
}

View File

@@ -0,0 +1,124 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.shard
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.runicgateway.app.core.net.ShardStreamEvent
import com.runicgateway.app.core.result.ApiResult
import com.runicgateway.app.data.api.dto.OnlineStaffDto
import com.runicgateway.app.data.api.dto.PresenceDto
import com.runicgateway.app.data.api.dto.ShardStatusDto
import com.runicgateway.app.data.repository.ShardRepository
import com.runicgateway.app.ui.UiState
import com.runicgateway.app.ui.toUiState
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import javax.inject.Inject
/** One row in the live activity feed. */
data class FeedLine(val id: String, val kind: String, val text: String)
/** The hub's point-in-time data (status is the primary; the rest are best-effort). */
data class ShardHub(
val status: ShardStatusDto,
val presence: PresenceDto?,
val online: List<OnlineStaffDto>,
)
/**
* The Shard hub (PLAN.md §6.2): connection status + online count + latest economy
* + presence + online staff, over a live activity feed. Status drives the screen's
* load state; presence/online load best-effort (a partial outage still renders what
* it can). The SSE feed reconnects on its own (§7) and toggles the live indicator.
*/
@HiltViewModel
class ShardViewModel @Inject constructor(
private val repository: ShardRepository,
) : ViewModel() {
private val _state = MutableStateFlow<UiState<ShardHub>>(UiState.Loading)
val state: StateFlow<UiState<ShardHub>> = _state.asStateFlow()
private val _feed = MutableStateFlow<List<FeedLine>>(emptyList())
val feed: StateFlow<List<FeedLine>> = _feed.asStateFlow()
private val _connected = MutableStateFlow(false)
val connected: StateFlow<Boolean> = _connected.asStateFlow()
private var seq = 0L
init {
load()
collectLive()
}
fun load() {
_state.value = UiState.Loading
viewModelScope.launch {
when (val status = repository.status()) {
is ApiResult.Ok -> {
// Presence/online are secondary — a failure there shouldn't blank the hub.
val presence = (repository.presence() as? ApiResult.Ok)?.data
val online = (repository.online() as? ApiResult.Ok)?.data ?: emptyList()
_state.value = UiState.Success(ShardHub(status.data, presence, online))
seedFeed()
}
// Both error variants are ApiResult<Nothing>, so their UiState is Nothing-typed.
is ApiResult.HttpError -> _state.value = status.toUiState()
is ApiResult.NetworkError -> _state.value = status.toUiState()
}
}
}
private suspend fun seedFeed() {
val events = (repository.feed(limit = 40) as? ApiResult.Ok)?.data ?: return
_feed.value = events.map { ev ->
FeedLine(
id = "seed-${ev.id}",
kind = ev.kind,
text = ShardEventText.describe(ev.kind, ev.payload ?: kotlinx.serialization.json.JsonObject(emptyMap())),
)
}
}
private fun collectLive() {
viewModelScope.launch {
repository.liveEvents().collect { event ->
when (event) {
is ShardStreamEvent.Open -> _connected.value = true
is ShardStreamEvent.Closed -> _connected.value = false
is ShardStreamEvent.Frame -> {
if (event.kind == "presence.online") updatePresence(event)
prepend(event)
}
}
}
}
}
// Patch the live presence snapshot in place so the hub's online count tracks the
// stream between reloads (the `presence.online` frame decodes into PresenceDto).
private fun updatePresence(frame: ShardStreamEvent.Frame) {
val presence = repository.presenceFrame(frame.data) ?: return
val current = _state.value as? UiState.Success ?: return
_state.value = UiState.Success(current.data.copy(presence = presence))
}
private fun prepend(frame: ShardStreamEvent.Frame) {
val line = FeedLine(
id = "live-${seq++}",
kind = frame.kind,
text = ShardEventText.describe(frame.kind, frame.data),
)
_feed.value = (listOf(line) + _feed.value).take(MAX_FEED)
}
private companion object {
const val MAX_FEED = 40
}
}

View File

@@ -5,12 +5,44 @@ package com.runicgateway.app.ui.theme
import androidx.compose.ui.graphics.Color
// Placeholder palette for the M0 skeleton. The M5 design pass replaces this and
// derives Material 3 colors from each shard's per-install branding (PLAN.md §3, §5).
val Purple80 = Color(0xFFD0BCFF)
val PurpleGrey80 = Color(0xFFCCC2DC)
val Pink80 = Color(0xFFEFB8C8)
// ─────────────────────────────────────────────────────────────────────────────
// Shard-website palette (M5 design pass, docs/android/PLAN.md §M5). Deep blue-black
// surfaces, a slate-blue accent, parchment serif text, and a light CTA fill —
// mirrored from the "Runic Gateway Screens" design. Dark-only by design.
// ─────────────────────────────────────────────────────────────────────────────
val Purple40 = Color(0xFF6650A4)
val PurpleGrey40 = Color(0xFF625B71)
val Pink40 = Color(0xFF7D5260)
// Surfaces
val ShardPage = Color(0xFF0B0F14) // app/page background
val ShardSurface = Color(0xFF0E1318) // screen background
val ShardElevated = Color(0xFF11161D) // top bar, inputs, drawer, list tracks
val ShardCardTop = Color(0xFF192231) // feature-card gradient (top)
val ShardCardBottom = Color(0xFF141A21) // feature-card gradient (bottom)
// Lines
val ShardOutline = Color(0xFF2A3544) // borders / input outlines
val ShardDivider = Color(0xFF1D2733) // hairline row dividers
// Text
val ShardHeading = Color(0xFFEEF3F8) // brightest headings
val ShardHeadingDim = Color(0xFFE6EDF6) // heading on surface
val ShardBody = Color(0xFFC4CDD8) // body copy
val ShardMuted = Color(0xFFAEB8C4) // secondary text
val ShardFaint = Color(0xFF6F7D8E) // meta / faint labels
// Accent + CTA
val ShardAccent = Color(0xFF7F99BD) // links, secondary highlights
val ShardCta = Color(0xFFCDD9E8) // filled button surface
val ShardOnCta = Color(0xFF0B0F14) // text on the filled button
// Neutral / info pill
val ShardPillBg = Color(0xFF13243C)
val ShardPillFg = Color(0xFFCDD9E8)
// Semantic (status pills + dots)
val ShardSuccess = Color(0xFF7FD0A4)
val ShardSuccessBg = Color(0x295FB98A) // rgba(95,185,138,0.16)
val ShardSuccessDot = Color(0xFF5FB98A)
val ShardWarning = Color(0xFFE6C26A)
val ShardWarningBg = Color(0x2EE6C26A) // rgba(230,194,106,0.18)
val ShardDanger = Color(0xFFD98B84)
val ShardDangerBg = Color(0x29D98B84) // rgba(217,139,132,0.16)

View File

@@ -0,0 +1,40 @@
/*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package com.runicgateway.app.ui.theme
import androidx.compose.ui.text.ExperimentalTextApi
import androidx.compose.ui.text.font.Font
import androidx.compose.ui.text.font.FontFamily
import androidx.compose.ui.text.font.FontVariation
import androidx.compose.ui.text.font.FontWeight
import com.runicgateway.app.R
/**
* Type families for the M5 shard-website design pass (docs/android/PLAN.md §M5).
*
* - [Cinzel] — the engraved serif display face used for headings, screen titles,
* and the top-bar title. Shipped as a single weight-axis **variable** font
* (`res/font/cinzel_variable.ttf`, SIL OFL — see `app/licenses/Cinzel-OFL.txt`);
* the 500/600/700 instances the design uses are pinned via [FontVariation]
* (supported on API 26+, and our minSdk is 29).
* - [AppSerif] — the parchment body face. Android's platform serif is Noto Serif,
* which reads as the design's Georgia body copy without bundling another binary.
* - [AppSans] — the label/meta/button face (the design's "Helvetica Neue" runs).
*/
@OptIn(ExperimentalTextApi::class)
private fun cinzel(weight: FontWeight) =
Font(
R.font.cinzel_variable,
weight = weight,
variationSettings = FontVariation.Settings(FontVariation.weight(weight.weight)),
)
val Cinzel = FontFamily(
cinzel(FontWeight.Medium), // 500
cinzel(FontWeight.SemiBold), // 600
cinzel(FontWeight.Bold), // 700
)
val AppSerif = FontFamily.Serif
val AppSans = FontFamily.SansSerif

View File

@@ -3,54 +3,78 @@
*/
package com.runicgateway.app.ui.theme
import androidx.compose.foundation.isSystemInDarkTheme
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Shapes
import androidx.compose.material3.darkColorScheme
import androidx.compose.material3.lightColorScheme
import androidx.compose.runtime.Composable
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
private val DarkColorScheme = darkColorScheme(
primary = Purple80,
secondary = PurpleGrey80,
tertiary = Pink80,
/**
* The shard-website color scheme (M5 design pass). The app is **dark-only** — the
* design is a single deep blue-black theme, so there is no light variant and the
* system light/dark setting is intentionally ignored. Material roles are mapped
* onto the palette in [ui/theme/Color.kt] so the ~20 token-based screens take on
* the theme without per-screen color work.
*/
private val ShardColorScheme = darkColorScheme(
primary = ShardCta, // filled CTA buttons
onPrimary = ShardOnCta,
secondary = ShardAccent, // links / secondary highlights
onSecondary = ShardOnCta,
tertiary = ShardAccent,
onTertiary = ShardOnCta,
background = ShardPage,
onBackground = ShardBody,
surface = ShardSurface,
onSurface = ShardBody,
surfaceVariant = ShardElevated,
onSurfaceVariant = ShardMuted,
surfaceContainer = ShardElevated,
surfaceContainerHigh = ShardElevated,
surfaceContainerLow = ShardSurface,
outline = ShardOutline,
outlineVariant = ShardDivider,
secondaryContainer = ShardPillBg, // neutral chips / selected drawer item
onSecondaryContainer = ShardPillFg,
error = ShardDanger,
onError = ShardOnCta,
errorContainer = ShardDangerBg,
onErrorContainer = ShardDanger,
)
private val LightColorScheme = lightColorScheme(
primary = Purple40,
secondary = PurpleGrey40,
tertiary = Pink40,
/** 8dp inputs/chips, 12dp cards, 16dp large surfaces — matching the mockup radii. */
private val ShardShapes = Shapes(
extraSmall = RoundedCornerShape(8.dp),
small = RoundedCornerShape(8.dp),
medium = RoundedCornerShape(12.dp),
large = RoundedCornerShape(16.dp),
extraLarge = RoundedCornerShape(24.dp),
)
/**
* App theme for the functional pass. The color scheme is seeded from the
* per-shard brand accent (PLAN.md §3: the app themes itself from the site's
* branding) when one is available, so the app takes on each shard's color; it
* falls back to a neutral placeholder scheme before connect or when a site
* publishes no accent.
*
* This is deliberately a minimal seeding — a single-color override on the
* default Material 3 schemes. The M5 design pass replaces it with a full,
* designed color system (§2.1, §5); nothing here is meant to be the final look.
* App theme. The color scheme is the fixed shard-website dark palette; when a shard
* publishes a brand accent (PLAN.md §3), it seeds the [MaterialTheme]'s primary and
* secondary roles so buttons and highlights carry that shard's color while the rest
* of the deep blue-black system stays intact. With no accent, the slate default is
* used.
*/
@Composable
fun RunicGatewayTheme(
accent: Color? = null,
darkTheme: Boolean = isSystemInDarkTheme(),
content: @Composable () -> Unit,
) {
val base = if (darkTheme) DarkColorScheme else LightColorScheme
val colorScheme = if (accent != null) {
// Brand consistency across a shard wins over device dynamic color: seed
// the primary role from the accent so buttons/highlights carry the brand.
base.copy(primary = accent, secondary = accent)
ShardColorScheme.copy(primary = accent, secondary = accent, tertiary = accent)
} else {
base
ShardColorScheme
}
MaterialTheme(
colorScheme = colorScheme,
typography = Typography,
shapes = ShardShapes,
content = content,
)
}

View File

@@ -5,17 +5,77 @@ package com.runicgateway.app.ui.theme
import androidx.compose.material3.Typography
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.font.FontFamily
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.unit.sp
// Default Material 3 type scale for the skeleton; refined in the M5 design pass.
/**
* The M5 type scale. Three families carry the design (see [ui/theme/Font.kt]):
* [Cinzel] for the engraved display/headline/title roles, [AppSerif] (Noto Serif)
* for parchment body copy, and [AppSans] for the letter-spaced label/meta/button
* roles. Sizes and tracking mirror the "Runic Gateway Screens" mockup.
*/
val Typography = Typography(
// Display / headline / title — Cinzel engraved serif
displayLarge = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 40.sp, lineHeight = 46.sp, letterSpacing = 0.4.sp,
),
displayMedium = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 32.sp, lineHeight = 40.sp, letterSpacing = 0.3.sp,
),
displaySmall = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 28.sp, lineHeight = 36.sp, letterSpacing = 0.2.sp,
),
headlineLarge = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 26.sp, lineHeight = 34.sp, letterSpacing = 0.2.sp,
),
headlineMedium = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 24.sp, lineHeight = 32.sp, letterSpacing = 0.2.sp,
),
headlineSmall = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 22.sp, lineHeight = 28.sp, letterSpacing = 0.2.sp,
),
titleLarge = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 20.sp, lineHeight = 26.sp, letterSpacing = 0.2.sp,
),
titleMedium = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 17.sp, lineHeight = 24.sp, letterSpacing = 0.15.sp,
),
titleSmall = TextStyle(
fontFamily = Cinzel, fontWeight = FontWeight.SemiBold,
fontSize = 15.sp, lineHeight = 22.sp, letterSpacing = 0.1.sp,
),
// Body — parchment serif
bodyLarge = TextStyle(
fontFamily = FontFamily.Default,
fontWeight = FontWeight.Normal,
fontSize = 16.sp,
lineHeight = 24.sp,
letterSpacing = 0.5.sp,
fontFamily = AppSerif, fontWeight = FontWeight.Normal,
fontSize = 16.sp, lineHeight = 26.sp, letterSpacing = 0.15.sp,
),
bodyMedium = TextStyle(
fontFamily = AppSerif, fontWeight = FontWeight.Normal,
fontSize = 15.sp, lineHeight = 24.sp, letterSpacing = 0.15.sp,
),
bodySmall = TextStyle(
fontFamily = AppSerif, fontWeight = FontWeight.Normal,
fontSize = 13.sp, lineHeight = 20.sp, letterSpacing = 0.2.sp,
),
// Labels / meta / buttons — sans, letter-spaced
labelLarge = TextStyle(
fontFamily = AppSans, fontWeight = FontWeight.Bold,
fontSize = 14.sp, lineHeight = 18.sp, letterSpacing = 0.45.sp,
),
labelMedium = TextStyle(
fontFamily = AppSans, fontWeight = FontWeight.Medium,
fontSize = 12.sp, lineHeight = 16.sp, letterSpacing = 0.4.sp,
),
labelSmall = TextStyle(
fontFamily = AppSans, fontWeight = FontWeight.Medium,
fontSize = 11.sp, lineHeight = 15.sp, letterSpacing = 0.5.sp,
),
)

View File

@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
<vector xmlns:android="http://schemas.android.com/apk/res/android"
android:width="24dp"
android:height="24dp"
android:viewportWidth="172"
android:viewportHeight="218.95209"
android:tint="#FFFFFF">
<group android:scaleX="0.7227152"
android:scaleY="0.92"
android:translateX="23.846495"
android:translateY="8.758083">
<group android:translateY="154.51205">
<path android:pathData="M9.28125,-0L9.28125,-103.109375L42.265625,-103.109375Q53.140625,-103.109375,60.984375,-99.25Q68.828125,-95.40625,73.109375,-88.203125Q77.40625,-81,77.40625,-71.203125L77.40625,-70.0625Q77.40625,-60.1875,73.109375,-53.015625Q68.828125,-45.859375,60.9375,-41.96875Q53.0625,-38.09375,42.265625,-38.09375L20.296875,-38.09375L20.296875,-54.5L41.828125,-54.5Q49.46875,-54.5,53.75,-58.390625Q58.03125,-62.28125,58.03125,-69.125L58.03125,-70.984375Q58.03125,-77.828125,53.75,-81.71875Q49.46875,-85.609375,41.828125,-85.609375L28.4375,-85.609375L28.4375,-0L9.28125,-0ZM61.78125,-0L35.5625,-45.359375L56.65625,-45.359375L83.453125,-0L61.78125,-0Z"
android:fillColor="#000000"/>
<path android:pathData="M132.65625,2.375Q119.765625,2.375,110.40625,-3.921875Q101.046875,-10.21875,96.046875,-21.953125Q91.046875,-33.703125,91.046875,-49.96875L91.046875,-52.625Q91.046875,-69.046875,96.046875,-80.890625Q101.046875,-92.734375,110.296875,-99.109375Q119.546875,-105.484375,132.375,-105.484375Q145.25,-105.484375,153.96875,-99.109375Q162.6875,-92.734375,166.5625,-80.5L149.21875,-74.09375Q147.125,-81,143.04688,-84.234375Q138.98438,-87.484375,132.57812,-87.484375Q121.859375,-87.484375,116.125,-78.546875Q110.40625,-69.625,110.40625,-52.984375L110.40625,-49.609375Q110.40625,-32.96875,116.15625,-24.21875Q121.921875,-15.484375,132.79688,-15.484375Q141.57812,-15.484375,146.35938,-21.453125Q151.15625,-27.4375,151.15625,-38.453125L151.15625,-41.828125L129.84375,-41.828125L129.84375,-57.890625L169.09375,-57.890625L169.09375,-41.90625Q169.09375,-20.734375,159.57812,-9.171875Q150.07812,2.375,132.65625,2.375Z"
android:fillColor="#000000"/>
</group>
</group>
</vector>

Binary file not shown.

After

Width:  |  Height:  |  Size: 493 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 352 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 647 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 975 B

View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<!--
Adaptive-icon background layer (M6): a solid deep-indigo fill behind the
transparent gateway-medallion foreground. Replaces the Image Asset wizard's
default green grid. Sourced from @color/ic_launcher_background so the launcher
background stays a single source of truth.
-->
<vector xmlns:android="http://schemas.android.com/apk/res/android"
android:width="108dp"
android:height="108dp"
android:viewportWidth="108"
android:viewportHeight="108">
<path
android:fillColor="@color/ic_launcher_background"
android:pathData="M0,0h108v108h-108z" />
</vector>

View File

@@ -1,15 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<!-- Placeholder launcher glyph: a stylized gateway arch. Replaced in the M5 design pass. -->
<vector xmlns:android="http://schemas.android.com/apk/res/android"
android:width="108dp"
android:height="108dp"
android:viewportWidth="108"
android:viewportHeight="108">
<path
android:fillColor="#D0BCFF"
android:pathData="M38,74 L38,50 A16,16 0 0,1 70,50 L70,74 L62,74 L62,50 A8,8 0 0,0 46,50 L46,74 Z" />
<path
android:fillColor="#EFB8C8"
android:pathData="M52,34 L56,34 L56,40 L52,40 Z M50,40 L58,40 L58,44 L50,44 Z" />
</vector>

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More