Compare commits
46 Commits
v0.3.4
...
37a828736e
| Author | SHA1 | Date | |
|---|---|---|---|
| 37a828736e | |||
| 4b22ab3756 | |||
| daf483f514 | |||
| a6677d5bf9 | |||
| a6b6c92c33 | |||
| ac2d75c3f9 | |||
| aa055469a8 | |||
| f3d90b189d | |||
| e10e1f1617 | |||
| 80441c3367 | |||
| d3bf4853de | |||
| 21b6ddc29b | |||
| d393cf022e | |||
| 21e235a07f | |||
| c55ee7f47e | |||
| 6cbfdb1e65 | |||
| b84a973559 | |||
| c14342aa51 | |||
| aeda919376 | |||
| 15a4d44c3f | |||
| fbe8b0bab6 | |||
| 94a5c26d6c | |||
| b95fc45548 | |||
| 3edd45d5f4 | |||
| 0051e97bc7 | |||
| a19fdd3582 | |||
| 7acbe54f46 | |||
| c7c49a9d6b | |||
| 1530c83fbc | |||
| c65913c62a | |||
| 17e9451494 | |||
| b0117acac1 | |||
| 5eaf5d22c6 | |||
| 12b2172731 | |||
| 4f85021be2 | |||
| 06b6b015c2 | |||
| aacef35def | |||
| 833e51de69 | |||
| 4fe7a7e2a3 | |||
| b10dd444b3 | |||
| f3da6ea618 | |||
| ae170670d9 | |||
| 7fc497a1a4 | |||
| 4e3bb914ff | |||
| efe14d3828 | |||
| 43215b49a0 |
3
.gitattributes
vendored
3
.gitattributes
vendored
@@ -17,3 +17,6 @@ gradlew text eol=lf
|
||||
*.png binary
|
||||
*.webp binary
|
||||
*.ico binary
|
||||
# Bundled type families (res/font). `text=auto` already detects these as binary,
|
||||
# but a font is too easy to corrupt silently to leave to a heuristic.
|
||||
*.ttf binary
|
||||
|
||||
54
.gitea/scripts/gen_tree.py
Normal file
54
.gitea/scripts/gen_tree.py
Normal file
@@ -0,0 +1,54 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Render an ASCII tree of tracked files, read from stdin (one path per line).
|
||||
|
||||
Used by the `sync-project-tree` workflow to regenerate this repo's PROJECT_TREE.md
|
||||
snapshot in the RunicGateway/docs repo. Feed it `git ls-files`:
|
||||
|
||||
git ls-files | python3 .gitea/scripts/gen_tree.py <root-label>
|
||||
|
||||
Deterministic ordering: directories before files, each group sorted
|
||||
case-insensitively with the raw name as a tiebreak. Output uses the classic
|
||||
`tree(1)` box-drawing style so the result is stable across runs and platforms.
|
||||
"""
|
||||
import sys
|
||||
|
||||
|
||||
def build(paths):
|
||||
root = {}
|
||||
for p in paths:
|
||||
p = p.strip().replace("\\", "/")
|
||||
if not p:
|
||||
continue
|
||||
node = root
|
||||
for part in p.split("/"):
|
||||
node = node.setdefault(part, {})
|
||||
return root
|
||||
|
||||
|
||||
def render(node, prefix, lines):
|
||||
entries = list(node.items())
|
||||
# directories (non-empty children dict) before files, then case-insensitive name
|
||||
entries.sort(key=lambda kv: (0 if kv[1] else 1, kv[0].lower(), kv[0]))
|
||||
for i, (name, child) in enumerate(entries):
|
||||
last = i == len(entries) - 1
|
||||
branch = "└── " if last else "├── "
|
||||
suffix = "/" if child else ""
|
||||
lines.append(f"{prefix}{branch}{name}{suffix}")
|
||||
if child:
|
||||
render(child, prefix + (" " if last else "│ "), lines)
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
sys.stdout.reconfigure(encoding="utf-8", newline="\n")
|
||||
except AttributeError:
|
||||
pass
|
||||
root_label = sys.argv[1] if len(sys.argv) > 1 else "."
|
||||
tree = build(sys.stdin.read().splitlines())
|
||||
lines = [f"{root_label}/"]
|
||||
render(tree, "", lines)
|
||||
sys.stdout.write("\n".join(lines) + "\n")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -1,5 +1,5 @@
|
||||
# Gate every pull request into `main` on lint + unit tests + a debug build, so a
|
||||
# broken build can't reach the deployable branch. Debug builds are auto-signed,
|
||||
# Gate every pull request into `main` or `edge` on lint + unit tests + a debug
|
||||
# build, so a broken build can't reach the deployable branch. Debug builds are auto-signed,
|
||||
# so this gate needs no secrets. The signed *release* APK + Gitea release come
|
||||
# later (release.yml, M6). See docs/android/PLAN.md §12.
|
||||
#
|
||||
@@ -18,9 +18,14 @@
|
||||
|
||||
name: PR Checks
|
||||
|
||||
# `edge` is here because a workstream that lands ten phase PRs onto it before one
|
||||
# cutover PR into `main` otherwise gets NO CI at all until the cutover — which is
|
||||
# exactly what happened to all nine M12 phase PRs, and would have happened again
|
||||
# to engagement Phase 8 (ENGAGEMENT.md §7.1 Q8). A phase should fail on its own
|
||||
# PR, not inside the cutover window with a whole workstream's diff to bisect.
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
branches: [main, edge]
|
||||
|
||||
concurrency:
|
||||
group: pr-checks-${{ github.ref }}
|
||||
@@ -40,8 +45,15 @@ jobs:
|
||||
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
# `packages: ''` is load-bearing, not tidying. The action's own default is
|
||||
# `tools` -- a package Google has REMOVED from the SDK repository -- so the
|
||||
# default makes `sdkmanager tools` exit 1 and the step fails before a line
|
||||
# of this repo is compiled. It is redundant here regardless: the next step
|
||||
# installs exactly what the build targets.
|
||||
- name: Set up Android SDK
|
||||
uses: android-actions/setup-android@v3
|
||||
with:
|
||||
packages: ''
|
||||
|
||||
# Install exactly what the build targets so it never depends on AGP's
|
||||
# build-time auto-download. `yes |` accepts any license prompts; `set
|
||||
|
||||
@@ -18,11 +18,12 @@
|
||||
# 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.
|
||||
# Scope: the Sonar scanner reads sonar-project.properties and analyses the Kotlin
|
||||
# source directly. Before the scan we run the JVM unit tests + JaCoCo so SonarQube
|
||||
# receives real coverage (sonar.coverage.jacoco.xmlReportPaths) — otherwise it
|
||||
# reports 0% and the coverage gate fails despite the test suite existing. That
|
||||
# Gradle step needs JDK 17 + the Android SDK (same toolchain as pr-checks.yml);
|
||||
# the runner container is bare, so base tools are apt-installed first.
|
||||
|
||||
name: SonarQube
|
||||
|
||||
@@ -40,6 +41,16 @@ jobs:
|
||||
analysis:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# The bare runner container lacks git/curl/unzip (checkout + sdkmanager need
|
||||
# them) and we install JDK 17 from the Ubuntu archive rather than
|
||||
# actions/setup-java (this runner can't reach api.adoptium.net). Mirrors
|
||||
# pr-checks.yml — see its header note.
|
||||
- name: Install base tools + JDK 17
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y git curl unzip openjdk-17-jdk-headless
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Check out (full history for accurate new-code + blame)
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
@@ -47,6 +58,31 @@ jobs:
|
||||
# compute "new code". A shallow clone degrades both.
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Android SDK
|
||||
uses: android-actions/setup-android@v3
|
||||
|
||||
- name: Install Android SDK packages
|
||||
run: |
|
||||
set +o pipefail
|
||||
yes | sdkmanager "platform-tools" "platforms;android-35" "build-tools;35.0.0"
|
||||
|
||||
- name: Cache Gradle
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.gradle/caches
|
||||
~/.gradle/wrapper
|
||||
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle.kts', 'gradle/libs.versions.toml', 'gradle/wrapper/gradle-wrapper.properties') }}
|
||||
restore-keys: |
|
||||
gradle-${{ runner.os }}-
|
||||
|
||||
# Produce the JaCoCo XML the scan reports as coverage. Scoped to the debug
|
||||
# variant (matches enableUnitTestCoverage) to keep peak memory down.
|
||||
- name: Unit tests + JaCoCo coverage
|
||||
run: |
|
||||
chmod +x ./gradlew
|
||||
./gradlew --no-daemon testDebugUnitTest jacocoTestReport
|
||||
|
||||
- name: Run SonarQube scan
|
||||
uses: sonarsource/sonarqube-scan-action@v4
|
||||
env:
|
||||
|
||||
111
.gitea/workflows/sync-project-tree.yml
Normal file
111
.gitea/workflows/sync-project-tree.yml
Normal file
@@ -0,0 +1,111 @@
|
||||
name: sync-project-tree
|
||||
|
||||
# Keeps this repo's file-layout snapshot (docs/android/PROJECT_TREE.md in the
|
||||
# RunicGateway/docs repo) current. On every push to `main` it regenerates the
|
||||
# tree from tracked files and, if it changed, opens (or force-updates) a pull
|
||||
# request against the docs repo. It never writes to the docs repo's `main`
|
||||
# directly. Auth reuses the same REGISTRY_USER / REGISTRY_TOKEN secrets the
|
||||
# other workflows use (the token needs repo read/write on RunicGateway/docs).
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch: {}
|
||||
|
||||
concurrency:
|
||||
group: sync-project-tree
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
GITEA_HOST: gitea.whitlocktech.com
|
||||
DOCS_REPO: RunicGateway/docs
|
||||
SELF_REPO: RunicGateway/Android-app
|
||||
DOCS_PATH: android/PROJECT_TREE.md
|
||||
TREE_TITLE: Android App
|
||||
ROOT_LABEL: android-app
|
||||
PR_BRANCH: chore/sync-android-tree
|
||||
|
||||
jobs:
|
||||
sync:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out this repo
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
- name: Ensure python3 is available
|
||||
run: |
|
||||
set -euo pipefail
|
||||
command -v python3 >/dev/null 2>&1 || { sudo apt-get update -qq && sudo apt-get install -y -qq python3; }
|
||||
|
||||
- name: Render PROJECT_TREE.md from tracked files
|
||||
run: |
|
||||
set -euo pipefail
|
||||
mkdir -p _sync
|
||||
{
|
||||
printf '# %s — Project Tree\n\n' "${TREE_TITLE}"
|
||||
printf '> **Auto-generated.** This file is maintained by the `sync-project-tree` CI workflow in\n'
|
||||
printf '> the [`%s`](https://%s/%s) repository, which\n' "${SELF_REPO}" "${GITEA_HOST}" "${SELF_REPO}"
|
||||
printf '> opens a pull request here whenever the tracked file layout on `main` changes. Do not edit\n'
|
||||
printf '> by hand — changes will be overwritten by the next sync.\n\n'
|
||||
printf 'A snapshot of the tracked files in the repository (build output, dependencies, and other\n'
|
||||
printf 'git-ignored paths are excluded).\n\n'
|
||||
printf '```text\n'
|
||||
git ls-files | python3 .gitea/scripts/gen_tree.py "${ROOT_LABEL}"
|
||||
printf '```\n'
|
||||
} > _sync/PROJECT_TREE.md
|
||||
echo "----- generated ${DOCS_PATH} -----"
|
||||
cat _sync/PROJECT_TREE.md
|
||||
|
||||
- name: Open or update the docs PR if the tree changed
|
||||
env:
|
||||
REGISTRY_USER: ${{ secrets.REGISTRY_USER }}
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Secrets can carry a trailing CR/LF depending on how they were pasted;
|
||||
# strip line breaks before they land in a URL or Authorization header.
|
||||
CI_USER="$(printf '%s' "${REGISTRY_USER}" | tr -d '\r\n')"
|
||||
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
||||
API="https://${GITEA_HOST}/api/v1/repos/${DOCS_REPO}"
|
||||
REMOTE="https://${CI_USER}:${CI_TOKEN}@${GITEA_HOST}/${DOCS_REPO}.git"
|
||||
|
||||
git clone --depth 1 "${REMOTE}" docs_repo
|
||||
cd docs_repo
|
||||
git config user.name "runic-docs-bot"
|
||||
git config user.email "ci@whitlocktech.com"
|
||||
|
||||
mkdir -p "$(dirname "${DOCS_PATH}")"
|
||||
cp ../_sync/PROJECT_TREE.md "${DOCS_PATH}"
|
||||
git add "${DOCS_PATH}"
|
||||
if git diff --cached --quiet; then
|
||||
echo "PROJECT_TREE.md already up to date — nothing to sync."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
SHORT_SHA="$(echo "${GITHUB_SHA:-local}" | cut -c1-7)"
|
||||
git checkout -B "${PR_BRANCH}"
|
||||
git commit -m "docs(tree): sync ${DOCS_PATH} from ${SELF_REPO}@${SHORT_SHA} [skip ci]"
|
||||
git push --force "${REMOTE}" "HEAD:${PR_BRANCH}"
|
||||
|
||||
# Open a PR only if one isn't already open for this branch (a force-push
|
||||
# to an existing open PR's head updates it in place).
|
||||
OPEN="$(curl -sSf -H "Authorization: token ${CI_TOKEN}" \
|
||||
"${API}/pulls?state=open&limit=50" \
|
||||
| jq --arg b "${PR_BRANCH}" '[.[] | select(.head.ref == $b)] | length')"
|
||||
if [ "${OPEN}" = "0" ]; then
|
||||
curl -sSf -X POST "${API}/pulls" \
|
||||
-H "Authorization: token ${CI_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$(jq -n \
|
||||
--arg head "${PR_BRANCH}" \
|
||||
--arg base "main" \
|
||||
--arg title "docs(tree): sync ${DOCS_PATH}" \
|
||||
--arg body "Automated project-tree sync from [\`${SELF_REPO}\`](https://${GITEA_HOST}/${SELF_REPO}), regenerated from tracked files on \`main\`. Merge once the layout looks right; the workflow will keep this branch current until then." \
|
||||
'{head: $head, base: $base, title: $title, body: $body}')" \
|
||||
>/dev/null
|
||||
echo "Opened a new docs PR for ${PR_BRANCH}."
|
||||
else
|
||||
echo "Existing open docs PR for ${PR_BRANCH} was updated via force-push."
|
||||
fi
|
||||
13
README.md
13
README.md
@@ -48,10 +48,15 @@ any shard's website — there is no compiled-in API host.
|
||||
|
||||
## CI
|
||||
|
||||
`.gitea/workflows/pr-checks.yml` gates PRs into `main` with `./gradlew lint test assembleDebug` on the
|
||||
org's self-hosted runner (JDK 17 + Android SDK). Debug builds are auto-signed, so the gate needs no
|
||||
secrets. **This pipeline is verified green end-to-end on the runner** (M0). A signed **release** APK
|
||||
attached to a Gitea release comes at M6.
|
||||
`.gitea/workflows/pr-checks.yml` gates PRs into `main` **and `edge`** with
|
||||
`./gradlew lint test assembleDebug` on the org's self-hosted runner (JDK 17 + Android SDK). Debug
|
||||
builds are auto-signed, so the gate needs no secrets. **This pipeline is verified green end-to-end on
|
||||
the runner** (M0). A signed **release** APK attached to a Gitea release comes at M6.
|
||||
|
||||
**`edge` is in the trigger deliberately**: a workstream that lands its phases on a working branch
|
||||
before one cutover PR into `main` otherwise gets no CI at all until the cutover — which is what
|
||||
happened to all nine M12 phase PRs (`docs/website/ENGAGEMENT.md` §7.1 Q8). `sonarqube.yml` is
|
||||
unaffected: it is a push-on-`main` analysis, not a PR gate.
|
||||
|
||||
The workflow carries a few runner-specific accommodations (each explained in comments in the file),
|
||||
because this self-hosted runner differs from a stock GitHub runner:
|
||||
|
||||
@@ -10,6 +10,11 @@ plugins {
|
||||
alias(libs.plugins.kotlin.serialization)
|
||||
alias(libs.plugins.ksp)
|
||||
alias(libs.plugins.hilt)
|
||||
jacoco
|
||||
}
|
||||
|
||||
jacoco {
|
||||
toolVersion = "0.8.12"
|
||||
}
|
||||
|
||||
// Release signing material (PLAN.md §12) is never committed. It is read from, in
|
||||
@@ -78,6 +83,11 @@ android {
|
||||
}
|
||||
|
||||
buildTypes {
|
||||
debug {
|
||||
// Produce a JaCoCo .exec from JVM unit tests so SonarQube receives real
|
||||
// coverage (§12.1). Debug-only: the scan analyses the debug variant.
|
||||
enableUnitTestCoverage = true
|
||||
}
|
||||
release {
|
||||
// R8 full-mode minify + resource shrink (§7: no offline cache, so a lean
|
||||
// release APK). Keep rules live in proguard-rules.pro.
|
||||
@@ -170,3 +180,35 @@ dependencies {
|
||||
androidTestImplementation(platform(libs.androidx.compose.bom))
|
||||
androidTestImplementation(libs.androidx.compose.ui.test.junit4)
|
||||
}
|
||||
|
||||
// JaCoCo XML coverage from the JVM unit tests, consumed by SonarQube (§12.1). Generated,
|
||||
// DI (Hilt), and Compose-scaffold classes are excluded so they don't dilute the number;
|
||||
// pure-@Composable UI is excluded on the Sonar side (sonar.coverage.exclusions) because
|
||||
// JVM unit tests can't execute composable bodies without Robolectric.
|
||||
tasks.register<JacocoReport>("jacocoTestReport") {
|
||||
dependsOn("testDebugUnitTest")
|
||||
group = "verification"
|
||||
description = "Generates JaCoCo XML/HTML coverage for the debug unit tests."
|
||||
|
||||
reports {
|
||||
xml.required.set(true)
|
||||
html.required.set(true)
|
||||
}
|
||||
|
||||
val coverageExcludes = listOf(
|
||||
"**/R.class", "**/R$*.class", "**/BuildConfig.*", "**/Manifest*.*",
|
||||
"**/*_Hilt*.*", "**/Hilt_*.*", "**/*_Factory*.*", "**/*_MembersInjector*.*",
|
||||
"**/*_Impl*.*", "**/di/**", "**/*Module.*", "**/*Module$*.*",
|
||||
"**/*ComposableSingletons*.*", "**/ComposableSingletons$*.*",
|
||||
)
|
||||
val buildDirFile = layout.buildDirectory.get().asFile
|
||||
classDirectories.setFrom(
|
||||
fileTree("$buildDirFile/tmp/kotlin-classes/debug") { exclude(coverageExcludes) },
|
||||
)
|
||||
sourceDirectories.setFrom(files("src/main/java", "src/main/kotlin"))
|
||||
executionData.setFrom(
|
||||
fileTree(buildDirFile) {
|
||||
include("outputs/unit_test_code_coverage/debugUnitTest/testDebugUnitTest.exec")
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
93
app/licenses/EBGaramond-OFL.txt
Normal file
93
app/licenses/EBGaramond-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2017 The EB Garamond Project Authors (https://github.com/octaviopardo/EBGaramond12)
|
||||
|
||||
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:
|
||||
https://openfontlicense.org
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
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.
|
||||
93
app/licenses/IMFellEnglish-OFL.txt
Normal file
93
app/licenses/IMFellEnglish-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright (c) 2010, Igino Marini (mail@iginomarini.com)
|
||||
|
||||
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.
|
||||
93
app/licenses/Inter-OFL.txt
Normal file
93
app/licenses/Inter-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter)
|
||||
|
||||
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:
|
||||
https://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.
|
||||
93
app/licenses/Merriweather-OFL.txt
Normal file
93
app/licenses/Merriweather-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2020 The Merriweather Project Authors (https://github.com/EbenSorkin/Merriweather4) with Reserved Font Name "Merriweather".
|
||||
|
||||
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:
|
||||
https://openfontlicense.org
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
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.
|
||||
93
app/licenses/PlayfairDisplay-OFL.txt
Normal file
93
app/licenses/PlayfairDisplay-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2017 The Playfair Display Project Authors (https://github.com/clauseggers/Playfair-Display), with Reserved Font Name "Playfair Display"
|
||||
|
||||
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.
|
||||
93
app/licenses/SourceSans3-OFL.txt
Normal file
93
app/licenses/SourceSans3-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2010-2020 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe in the United States and/or other countries.
|
||||
|
||||
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.
|
||||
93
app/licenses/WorkSans-OFL.txt
Normal file
93
app/licenses/WorkSans-OFL.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
Copyright 2019 The Work Sans Project Authors (https://github.com/weiweihuanghuang/Work-Sans)
|
||||
|
||||
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.
|
||||
@@ -23,6 +23,7 @@ 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.LifecycleResumeEffect
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.ui.AppViewModel
|
||||
import com.runicgateway.app.ui.AppViewModel.AppState
|
||||
@@ -30,8 +31,8 @@ import com.runicgateway.app.ui.LocalAssetResolver
|
||||
import com.runicgateway.app.ui.RunicApp
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.connect.ConnectScreen
|
||||
import com.runicgateway.app.data.appearance.SiteAppearance
|
||||
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
|
||||
@@ -39,8 +40,8 @@ import javax.inject.Inject
|
||||
/**
|
||||
* Single-activity host (PLAN.md §2). Gates on [AppViewModel]: the first-run
|
||||
* connect screen until a shard site is configured (§3), then the main app.
|
||||
* The Material theme is seeded from the per-shard brand accent, and asset-path
|
||||
* resolution is provided to the whole tree.
|
||||
* The Material theme is resolved from the shard's published appearance (M12),
|
||||
* and asset-path resolution is provided to the whole tree.
|
||||
*/
|
||||
@AndroidEntryPoint
|
||||
class MainActivity : ComponentActivity() {
|
||||
@@ -57,9 +58,16 @@ class MainActivity : ComponentActivity() {
|
||||
// consumed once by RunicApp which navigates to the stream's screen.
|
||||
private var pendingStream by mutableStateOf<String?>(null)
|
||||
|
||||
// The tickle's other half: an opaque ref, carried since M7 and read since
|
||||
// ENGAGEMENT.md phase 8, where a `notification:<id>` ref means the engine wrote
|
||||
// an inbox row and the tap should land there. Never rendered — it is a hint that
|
||||
// something exists, and the app pulls the real item over the authenticated API.
|
||||
private var pendingRef by mutableStateOf<String?>(null)
|
||||
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
pendingStream = intent?.getStringExtra(PushNotifier.EXTRA_STREAM)
|
||||
pendingRef = intent?.getStringExtra(PushNotifier.EXTRA_REF)
|
||||
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.
|
||||
@@ -69,9 +77,21 @@ class MainActivity : ComponentActivity() {
|
||||
val appViewModel: AppViewModel = hiltViewModel()
|
||||
val state by appViewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
val accent = (state as? AppState.Ready)?.brand?.let { parseBrandColor(it.accent) }
|
||||
// The whole theme, not just the accent (THEMING_AND_NAV.md §5.1): the
|
||||
// resolved token map is applied field by field over the shipped palette,
|
||||
// so NONE — before the site is connected, or when settings can't be
|
||||
// read — is the app exactly as it shipped.
|
||||
val appearance = (state as? AppState.Ready)?.appearance ?: SiteAppearance.NONE
|
||||
|
||||
RunicGatewayTheme(accent = accent) {
|
||||
// The admin's theme and nav can change while the app is backgrounded
|
||||
// (THEMING_AND_NAV.md §5.5). Re-read them on resume, beside the session
|
||||
// re-validation RunicApp already does. Best-effort and silent.
|
||||
LifecycleResumeEffect(Unit) {
|
||||
appViewModel.refreshAppearance()
|
||||
onPauseOrDispose { }
|
||||
}
|
||||
|
||||
RunicGatewayTheme(appearance = appearance) {
|
||||
CompositionLocalProvider(LocalAssetResolver provides appViewModel::resolveAsset) {
|
||||
Surface(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
@@ -83,10 +103,14 @@ class MainActivity : ComponentActivity() {
|
||||
ConnectScreen(onConnected = appViewModel::onConnected)
|
||||
is AppState.Ready ->
|
||||
RunicApp(
|
||||
brand = s.brand,
|
||||
appearance = s.appearance,
|
||||
onChangeServer = appViewModel::changeServer,
|
||||
deepLinkStream = pendingStream,
|
||||
onDeepLinkConsumed = { pendingStream = null },
|
||||
deepLinkRef = pendingRef,
|
||||
onDeepLinkConsumed = {
|
||||
pendingStream = null
|
||||
pendingRef = null
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -103,7 +127,13 @@ class MainActivity : ComponentActivity() {
|
||||
override fun onNewIntent(intent: Intent) {
|
||||
super.onNewIntent(intent)
|
||||
setIntent(intent)
|
||||
intent.getStringExtra(PushNotifier.EXTRA_STREAM)?.let { pendingStream = it }
|
||||
intent.getStringExtra(PushNotifier.EXTRA_STREAM)?.let {
|
||||
pendingStream = it
|
||||
// Cleared alongside, not conditionally: a tickle with no ref arriving
|
||||
// after one with a ref must not inherit the earlier ref and land on the
|
||||
// inbox instead of its own screen.
|
||||
pendingRef = intent.getStringExtra(PushNotifier.EXTRA_REF)
|
||||
}
|
||||
handleSsoCallback(intent)
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ package com.runicgateway.app.core.auth.sso
|
||||
|
||||
import com.runicgateway.app.BuildConfig
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.auth.TrustTokenStore
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import com.runicgateway.app.data.api.dto.MobileSsoExchangeRequest
|
||||
@@ -49,6 +50,7 @@ class SsoAuthManager @Inject constructor(
|
||||
private val sessionManager: SessionManager,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val pendingStore: PendingSsoStore,
|
||||
private val trustTokenStore: TrustTokenStore,
|
||||
) {
|
||||
|
||||
/** Why an SSO attempt ended, for a friendly inline message on the login screen. */
|
||||
@@ -193,6 +195,14 @@ class SsoAuthManager @Inject constructor(
|
||||
_outcome.value = Outcome.Failed(Failure.SERVER)
|
||||
return
|
||||
}
|
||||
// The user ticked "trust this device" on the TOTP form inside the Custom
|
||||
// Tab. That tab's cookie already covers future SSO sign-ins; persisting
|
||||
// the token the exchange handed back is what lets a native PASSWORD login
|
||||
// on this device skip the code too (TRUSTED_DEVICES_MFA.md). Scoped to the
|
||||
// username exactly like the password path, so it is never replayed for a
|
||||
// different account on a shared device. Saved BEFORE onSignedIn so a
|
||||
// process death mid-callback can't lose it.
|
||||
body.trustToken?.let { trustTokenStore.save(body.user.username, it) }
|
||||
sessionManager.onSignedIn(body.accessToken, body.refreshToken, body.user)
|
||||
_outcome.value = Outcome.Success
|
||||
return
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.inbox
|
||||
|
||||
import android.content.Context
|
||||
import androidx.datastore.core.DataStore
|
||||
import androidx.datastore.preferences.core.Preferences
|
||||
import androidx.datastore.preferences.core.edit
|
||||
import androidx.datastore.preferences.core.stringPreferencesKey
|
||||
import androidx.datastore.preferences.preferencesDataStore
|
||||
import com.runicgateway.app.data.api.dto.NotificationItemDto
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.Json
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
private val Context.inboxDataStore: DataStore<Preferences> by preferencesDataStore(name = "inbox")
|
||||
|
||||
/**
|
||||
* [InboxCache] over the same plain DataStore the push state uses. Not secret —
|
||||
* tokens stay in the encrypted store — but an inbox body is a person's own
|
||||
* notifications, which is why the snapshot is owner-scoped and cleared on
|
||||
* sign-out rather than left lying about.
|
||||
*/
|
||||
@Singleton
|
||||
class DataStoreInboxCache @Inject constructor(
|
||||
@param:ApplicationContext private val context: Context,
|
||||
private val json: Json,
|
||||
) : InboxCache {
|
||||
|
||||
private val store = context.inboxDataStore
|
||||
|
||||
override suspend fun read(owner: String): InboxCache.Snapshot? {
|
||||
val raw = store.data.first()[KEY_SNAPSHOT] ?: return null
|
||||
val stored = try {
|
||||
json.decodeFromString(Stored.serializer(), raw)
|
||||
} catch (_: Exception) {
|
||||
// A snapshot this build can't parse is a snapshot from an older one;
|
||||
// dropping it silently is right — it will be rewritten on the next pull.
|
||||
return null
|
||||
}
|
||||
if (stored.owner != owner) return null
|
||||
return InboxCache.Snapshot(items = stored.items, unread = stored.unread, savedAt = stored.savedAt)
|
||||
}
|
||||
|
||||
override suspend fun write(owner: String, items: List<NotificationItemDto>, unread: Int) {
|
||||
val payload = Stored(
|
||||
owner = owner,
|
||||
items = items.take(InboxCache.MAX_ITEMS),
|
||||
unread = unread,
|
||||
savedAt = System.currentTimeMillis(),
|
||||
)
|
||||
store.edit { it[KEY_SNAPSHOT] = json.encodeToString(Stored.serializer(), payload) }
|
||||
}
|
||||
|
||||
override suspend fun clear() {
|
||||
store.edit { it.remove(KEY_SNAPSHOT) }
|
||||
}
|
||||
|
||||
@Serializable
|
||||
private data class Stored(
|
||||
val owner: String,
|
||||
val items: List<NotificationItemDto>,
|
||||
val unread: Int,
|
||||
val savedAt: Long,
|
||||
)
|
||||
|
||||
private companion object {
|
||||
val KEY_SNAPSHOT = stringPreferencesKey("snapshot")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.inbox
|
||||
|
||||
import com.runicgateway.app.data.api.dto.NotificationItemDto
|
||||
|
||||
/**
|
||||
* The inbox's offline snapshot (ENGAGEMENT.md phase 8).
|
||||
*
|
||||
* **PLAN.md §7 decided the app ships no Room cache, and that decision stands** —
|
||||
* this is its one named exception, settled with the org lead 2026-08-31. The
|
||||
* inbox is a short, read-only, newest-first list with a server-side cursor and no
|
||||
* joins, so what "works offline" needs is the newest page and the badge, not a
|
||||
* database: one JSON blob in the DataStore the push code already uses. Nothing
|
||||
* here is a source of truth — a successful pull always replaces it, and the
|
||||
* screen says out loud when it is showing this instead.
|
||||
*
|
||||
* **The [owner] key is the security property, not a convenience.** A snapshot is
|
||||
* written under the base URL *and* the account id that produced it and is only
|
||||
* ever handed back to that exact pair, so a cache cannot survive into another
|
||||
* account or another shard — including the sign-out paths that never reach
|
||||
* [clear] at all (a dead refresh token, a server switch). Clearing on logout is
|
||||
* the tidy-up; this is what makes it safe.
|
||||
*
|
||||
* An interface for the same reason [com.runicgateway.app.core.auth.TokenStore] is
|
||||
* one: the storage needs a `Context` and the view models that use it should be
|
||||
* testable without one.
|
||||
*/
|
||||
interface InboxCache {
|
||||
|
||||
/**
|
||||
* What was cached for [owner], or null when nothing was — including when the
|
||||
* stored snapshot belongs to a different account or shard, which is the same
|
||||
* answer on purpose.
|
||||
*/
|
||||
suspend fun read(owner: String): Snapshot?
|
||||
|
||||
/**
|
||||
* Replace the snapshot with the newest page.
|
||||
*
|
||||
* Only the FIRST page is ever cached, capped at [MAX_ITEMS]: an offline inbox
|
||||
* is there so the last things you were told are still readable on a train, not
|
||||
* so the whole history is. Later pages come from the server or not at all.
|
||||
*/
|
||||
suspend fun write(owner: String, items: List<NotificationItemDto>, unread: Int)
|
||||
|
||||
/** Forget everything. Called on sign-out, alongside the push deregistration. */
|
||||
suspend fun clear()
|
||||
|
||||
/** What the screen renders from while offline, with the time it was captured. */
|
||||
data class Snapshot(
|
||||
val items: List<NotificationItemDto>,
|
||||
val unread: Int,
|
||||
val savedAt: Long,
|
||||
)
|
||||
|
||||
companion object {
|
||||
/** The server's own default page size — caching more than it sends is pointless. */
|
||||
const val MAX_ITEMS = 30
|
||||
|
||||
/** The (shard, account) a snapshot belongs to. */
|
||||
fun ownerKey(baseUrl: String?, userId: Long): String = "${baseUrl.orEmpty()}|$userId"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.net
|
||||
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
|
||||
/**
|
||||
* The live shard SSE feed as a cold flow of lifecycle + frame events (PLAN.md §6.2,
|
||||
* §7). Extracted as an interface so consumers (e.g. [com.runicgateway.app.data.repository.ShardRepository])
|
||||
* depend on the capability, not the OkHttp-backed [ShardStreamClient] — the boards
|
||||
* can then be unit-tested against a fake stream instead of a real network connection.
|
||||
*/
|
||||
interface ShardStream {
|
||||
fun events(): Flow<ShardStreamEvent>
|
||||
}
|
||||
@@ -40,7 +40,7 @@ class ShardStreamClient @Inject constructor(
|
||||
baseClient: OkHttpClient,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val json: Json,
|
||||
) {
|
||||
) : ShardStream {
|
||||
// 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()
|
||||
@@ -56,7 +56,7 @@ class ShardStreamClient @Inject constructor(
|
||||
* drive a live/offline indicator; [ShardStreamEvent.Frame] carries a decoded
|
||||
* `{ kind, … }` payload the boards merge in place.
|
||||
*/
|
||||
fun events(): Flow<ShardStreamEvent> = channelFlow {
|
||||
override fun events(): Flow<ShardStreamEvent> = channelFlow {
|
||||
var backoffMs = INITIAL_BACKOFF_MS
|
||||
while (isActive) {
|
||||
val url = baseUrlHolder.current?.resolve(STREAM_PATH)
|
||||
|
||||
41
app/src/main/java/com/runicgateway/app/core/time/Instants.kt
Normal file
41
app/src/main/java/com/runicgateway/app/core/time/Instants.kt
Normal file
@@ -0,0 +1,41 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.core.time
|
||||
|
||||
import java.time.Instant
|
||||
import java.time.LocalDateTime
|
||||
import java.time.ZoneId
|
||||
|
||||
/**
|
||||
* Parse a timestamp off the wire, in either shape the backend sends.
|
||||
*
|
||||
* **Which one arrives is not the app's to decide.** Express serializes a `Date`
|
||||
* to ISO-8601 with a `Z`, but these values start life as MariaDB `DATETIME`
|
||||
* columns, and one read back as a string reaches the wire as
|
||||
* `2026-08-31 07:13:50` with no zone at all. A zoneless stamp is read as **UTC**,
|
||||
* because that is what the server stores — reading it as local time would
|
||||
* silently shift every timestamp by the device's offset, which is a bug that
|
||||
* looks right on the machine it was written on.
|
||||
*
|
||||
* Anything unparseable answers null, and every caller is expected to render
|
||||
* *something* without it: a notification with an odd date is still worth reading,
|
||||
* and an event with one is still worth listing.
|
||||
*
|
||||
* Lives here rather than beside either caller because the trap is the wire's, not
|
||||
* one screen's — the inbox found it (ENGAGEMENT.md phase 8) and the event screens
|
||||
* inherit it (EVENTS.md §I).
|
||||
*/
|
||||
fun parseWireInstant(raw: String?): Instant? {
|
||||
val text = raw?.trim().orEmpty()
|
||||
if (text.isEmpty()) return null
|
||||
return try {
|
||||
Instant.parse(text)
|
||||
} catch (_: Exception) {
|
||||
try {
|
||||
LocalDateTime.parse(text.replace(' ', 'T')).atZone(ZoneId.of("UTC")).toInstant()
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
}
|
||||
84
app/src/main/java/com/runicgateway/app/data/api/EventsApi.kt
Normal file
84
app/src/main/java/com/runicgateway/app/data/api/EventsApi.kt
Normal file
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.EventCalendarDto
|
||||
import com.runicgateway.app.data.api.dto.EventHistoryDto
|
||||
import com.runicgateway.app.data.api.dto.EventSeriesResponse
|
||||
import com.runicgateway.app.data.api.dto.PublicEventResponse
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
|
||||
/**
|
||||
* The event surface (PLAN.md §9 M13, `docs/website/EVENTS.md` § API surface).
|
||||
*
|
||||
* **These are CORE routes, not a module's**, which is why they live here rather
|
||||
* than beside the shard reads in [PublicApi]: they exist on a backend
|
||||
* with no game module installed at all, and they are gated by core's own `events`
|
||||
* capability rather than by a module's. Nothing here is under `/shard`.
|
||||
*
|
||||
* The three public reads and the one player read share an interface for the same
|
||||
* reason the website mounts them in one feature: the history row's whole purpose
|
||||
* is to link back to the public page. The player call carries a bearer through
|
||||
* [com.runicgateway.app.core.net.AuthInterceptor] like every other authenticated
|
||||
* call; there is one Retrofit.
|
||||
*/
|
||||
interface EventsApi {
|
||||
|
||||
/**
|
||||
* The public calendar. Defaults to now through 31 days out when neither end
|
||||
* is named; the window may span at most 92 days and the server 400s past it.
|
||||
*
|
||||
* Rehearsals and unlisted events are absent — that filtering is in SQL, not
|
||||
* in the answer, so there is nothing here to re-check.
|
||||
*/
|
||||
@GET("api/v1/public/events")
|
||||
suspend fun getCalendar(
|
||||
@Query("from") from: String? = null,
|
||||
@Query("to") to: String? = null,
|
||||
@Query("seriesId") seriesId: Long? = null,
|
||||
): EventCalendarDto
|
||||
|
||||
/**
|
||||
* One event.
|
||||
*
|
||||
* **[run] selects which occurrence the results table is about**, and is what
|
||||
* an announcement's link carries: the page lives at the definition's slug, so
|
||||
* a weekly event has one address that survives a retitle, while every
|
||||
* `event.` trigger is about one occurrence. A run belonging to some other
|
||||
* event is ignored rather than refused, so a stale link in a months-old mail
|
||||
* still opens the page it was about.
|
||||
*
|
||||
* A draft, an archived definition and an unlisted one all answer 404,
|
||||
* indistinguishable from a slug that never existed.
|
||||
*/
|
||||
@GET("api/v1/public/events/{slug}")
|
||||
suspend fun getEvent(
|
||||
@Path("slug") slug: String,
|
||||
@Query("run") run: String? = null,
|
||||
): PublicEventResponse
|
||||
|
||||
/**
|
||||
* One arc. A series with no listed events answers 404 rather than an empty
|
||||
* page — an arc is a label on its definitions, so a page for an empty one
|
||||
* would publish that an operator has named something they have not announced.
|
||||
*/
|
||||
@GET("api/v1/public/events/series/{slug}")
|
||||
suspend fun getSeries(@Path("slug") slug: String): EventSeriesResponse
|
||||
|
||||
/**
|
||||
* The caller's own participation history. Self-scoped on the session's user
|
||||
* id server-side; there is deliberately no id parameter here, because there
|
||||
* is none on the route.
|
||||
*
|
||||
* [before] is a participation row id, not an offset — the list gains rows at
|
||||
* the top as the reader attends things.
|
||||
*/
|
||||
@GET("api/v1/player/events/history")
|
||||
suspend fun getHistory(
|
||||
@Query("limit") limit: Int? = null,
|
||||
@Query("before") before: Long? = null,
|
||||
): EventHistoryDto
|
||||
}
|
||||
@@ -3,8 +3,13 @@
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsUpdateDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationInboxDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationReadResultDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationUnreadDto
|
||||
import com.runicgateway.app.data.api.dto.PushDeviceDto
|
||||
import com.runicgateway.app.data.api.dto.RegisterDeviceRequest
|
||||
import retrofit2.http.Body
|
||||
@@ -13,10 +18,13 @@ import retrofit2.http.GET
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.PUT
|
||||
import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
|
||||
/**
|
||||
* 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
|
||||
* The notification surface under `/auth/me` (PLAN.md §11): device (endpoint)
|
||||
* registration, per-user stream subscriptions, the per-channel preferences that
|
||||
* supersede them (ENGAGEMENT.md phase 3), and the in-app **inbox** — the first
|
||||
* of these that carries content rather than a preference (phase 7/8). 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.
|
||||
@@ -40,4 +48,41 @@ interface NotificationsApi {
|
||||
|
||||
@PUT("api/v1/auth/me/notifications/subscriptions")
|
||||
suspend fun putSubscriptions(@Body body: NotificationSubscriptionsDto): NotificationSubscriptionsDto
|
||||
|
||||
// ── Per-channel preferences (ENGAGEMENT.md phase 3) ────────────────────
|
||||
//
|
||||
// The superset of the two calls above: `notification_subscriptions` is now
|
||||
// the push projection of this table and the server fans every write to
|
||||
// either one into the other, so the two cannot disagree.
|
||||
|
||||
@GET("api/v1/auth/me/notifications/channels")
|
||||
suspend fun channelPrefs(): NotificationChannelPrefsDto
|
||||
|
||||
/** SPARSE — send only the pairs that changed; everything unnamed is untouched. */
|
||||
@PUT("api/v1/auth/me/notifications/channels")
|
||||
suspend fun putChannelPrefs(
|
||||
@Body body: NotificationChannelPrefsUpdateDto,
|
||||
): NotificationChannelPrefsDto
|
||||
|
||||
// ── The inbox (ENGAGEMENT.md phase 7/8) ────────────────────────────────
|
||||
//
|
||||
// Keyset-paged on `before`, never an offset. There is no way to name another
|
||||
// user on any of these: the caller is the only account they can read or write.
|
||||
|
||||
@GET("api/v1/auth/me/notifications")
|
||||
suspend fun inbox(
|
||||
@Query("limit") limit: Int? = null,
|
||||
@Query("before") before: Long? = null,
|
||||
@Query("unread") unread: Boolean? = null,
|
||||
): NotificationInboxDto
|
||||
|
||||
@GET("api/v1/auth/me/notifications/unread-count")
|
||||
suspend fun unreadCount(): NotificationUnreadDto
|
||||
|
||||
/** Idempotent; 404 both for a missing item and for another account's. */
|
||||
@POST("api/v1/auth/me/notifications/{id}/read")
|
||||
suspend fun markRead(@Path("id") id: Long): NotificationReadResultDto
|
||||
|
||||
@POST("api/v1/auth/me/notifications/read-all")
|
||||
suspend fun markAllRead(): NotificationReadResultDto
|
||||
}
|
||||
|
||||
@@ -3,6 +3,9 @@
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.AtlasCreatureDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasCreaturePageDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasMetaDto
|
||||
import com.runicgateway.app.data.api.dto.ChampDto
|
||||
import com.runicgateway.app.data.api.dto.ContactRequest
|
||||
import com.runicgateway.app.data.api.dto.ContactResponse
|
||||
@@ -12,11 +15,18 @@ 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.MarketMetaDto
|
||||
import com.runicgateway.app.data.api.dto.MarketPageDto
|
||||
import com.runicgateway.app.data.api.dto.MarketVendorDto
|
||||
import com.runicgateway.app.data.api.dto.ModulesDto
|
||||
import com.runicgateway.app.data.api.dto.OnlineStaffDto
|
||||
import com.runicgateway.app.data.api.dto.PageDto
|
||||
import com.runicgateway.app.data.api.dto.PointsBoardDto
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.data.api.dto.PresenceDto
|
||||
import com.runicgateway.app.data.api.dto.RulesetDto
|
||||
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||
import com.runicgateway.app.data.api.dto.ShardFeaturesDto
|
||||
import com.runicgateway.app.data.api.dto.ShardStatusDto
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import com.runicgateway.app.data.api.dto.WikiCategoryDto
|
||||
@@ -58,6 +68,18 @@ interface PublicApi {
|
||||
@GET("api/v1/public/settings")
|
||||
suspend fun getSettings(): SettingsDto
|
||||
|
||||
/**
|
||||
* Which modules this backend is serving, and the capabilities each declares
|
||||
* (§5, M13). Read together with the `version` block's own `capabilities` —
|
||||
* core's list and a module's are separate lists on purpose.
|
||||
*
|
||||
* This is what lets the app tell a module that is **not installed** from a
|
||||
* lookup that failed: `/public/shard/features` 404s in both cases, and only
|
||||
* this call distinguishes them.
|
||||
*/
|
||||
@GET("api/v1/public/modules")
|
||||
suspend fun getModules(): ModulesDto
|
||||
|
||||
// ── News & content ───────────────────────────────────────────────────
|
||||
@GET("api/v1/public/posts/{category}")
|
||||
suspend fun getPosts(@Path("category") category: String): List<PostDto>
|
||||
@@ -93,6 +115,14 @@ interface PublicApi {
|
||||
suspend fun postContact(@Body body: ContactRequest): ContactResponse
|
||||
|
||||
// ── Public shard widgets (§6.2) ──────────────────────────────────────
|
||||
/**
|
||||
* Which shard features this caller may reach, so the menu hides entries instead
|
||||
* of rendering links that 404/403 (§5, M11). Answered per-viewer: an anonymous
|
||||
* call and a signed-in one can differ.
|
||||
*/
|
||||
@GET("api/v1/public/shard/features")
|
||||
suspend fun getShardFeatures(): ShardFeaturesDto
|
||||
|
||||
@GET("api/v1/public/shard/status")
|
||||
suspend fun getShardStatus(): ShardStatusDto
|
||||
|
||||
@@ -128,4 +158,65 @@ interface PublicApi {
|
||||
|
||||
@GET("api/v1/public/shard/houses")
|
||||
suspend fun getShardHouses(): List<HouseDto>
|
||||
|
||||
// ── Protocol 3.0 shard content (§9 M11) ──────────────────────────────
|
||||
//
|
||||
// Each of these sits behind the website's `requireFeature` gate: a 404 means the
|
||||
// shard doesn't publish it and a 403 means this viewer is below its audience rung,
|
||||
// which `toShardUiState()` folds into one "not available here" state.
|
||||
|
||||
/** The shard's configured ruleset. A `null` body means "not published yet". */
|
||||
@GET("api/v1/public/shard/ruleset")
|
||||
suspend fun getShardRuleset(): RulesetDto?
|
||||
|
||||
/** Every points/loyalty leaderboard the shard publishes. */
|
||||
@GET("api/v1/public/shard/points")
|
||||
suspend fun getShardPoints(): List<PointsBoardDto>
|
||||
|
||||
@GET("api/v1/public/shard/points/{system}")
|
||||
suspend fun getShardPointsBoard(@Path("system") system: String): PointsBoardDto
|
||||
|
||||
/**
|
||||
* Search the player-vendor index. **Rate-limited** — the first genuinely expensive
|
||||
* public endpoint on the site, so handle `429` (`ErrorKind.RATE_LIMITED`).
|
||||
*/
|
||||
@GET("api/v1/public/shard/market")
|
||||
suspend fun getShardMarket(
|
||||
@Query("q") query: String? = null,
|
||||
@Query("minPrice") minPrice: Long? = null,
|
||||
@Query("maxPrice") maxPrice: Long? = null,
|
||||
@Query("map") map: String? = null,
|
||||
@Query("region") region: String? = null,
|
||||
@Query("sort") sort: String? = null,
|
||||
@Query("limit") limit: Int? = null,
|
||||
@Query("offset") offset: Int? = null,
|
||||
): MarketPageDto
|
||||
|
||||
/** Index size, staleness, and which facets/regions actually hold vendors. */
|
||||
@GET("api/v1/public/shard/market/meta")
|
||||
suspend fun getShardMarketMeta(): MarketMetaDto
|
||||
|
||||
@GET("api/v1/public/shard/market/vendors/{serial}")
|
||||
suspend fun getShardMarketVendor(
|
||||
@Path("serial") serial: String,
|
||||
@Query("limit") limit: Int? = null,
|
||||
@Query("offset") offset: Int? = null,
|
||||
): MarketVendorDto
|
||||
|
||||
// The atlas lives under /public/atlas, NOT /public/shard: it is static shard
|
||||
// content parsed from the server's data files, so it stays readable while the
|
||||
// shard is down — but it IS site-mode gated, unlike the shard routes.
|
||||
@GET("api/v1/public/atlas/creatures")
|
||||
suspend fun getAtlasCreatures(
|
||||
@Query("q") query: String? = null,
|
||||
@Query("facet") facet: String? = null,
|
||||
@Query("limit") limit: Int? = null,
|
||||
@Query("offset") offset: Int? = null,
|
||||
): AtlasCreaturePageDto
|
||||
|
||||
@GET("api/v1/public/atlas/creatures/{slug}")
|
||||
suspend fun getAtlasCreature(@Path("slug") slug: String): AtlasCreatureDto
|
||||
|
||||
@GET("api/v1/public/atlas/meta")
|
||||
suspend fun getAtlasMeta(): AtlasMetaDto
|
||||
}
|
||||
|
||||
94
app/src/main/java/com/runicgateway/app/data/api/RustApi.kt
Normal file
94
app/src/main/java/com/runicgateway/app/data/api/RustApi.kt
Normal file
@@ -0,0 +1,94 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api
|
||||
|
||||
import com.runicgateway.app.data.api.dto.RustEventListDto
|
||||
import com.runicgateway.app.data.api.dto.RustLeaderboardDto
|
||||
import com.runicgateway.app.data.api.dto.RustOnlineDto
|
||||
import com.runicgateway.app.data.api.dto.RustServerListDto
|
||||
import com.runicgateway.app.data.api.dto.RustServerResponse
|
||||
import com.runicgateway.app.data.api.dto.RustWipeListDto
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
|
||||
/**
|
||||
* `module-rust`'s public read path (PLAN.md §9 M14; `docs/modules/rust/PLAN.md`
|
||||
* §17).
|
||||
*
|
||||
* **These paths are hardcoded, and that is the contract rather than a shortcut.**
|
||||
* `MODULE_API.md` §2.9 forbids a client inferring a route from a capability, so
|
||||
* the app cannot build `/<module id>/servers` from what `GET /public/modules`
|
||||
* reports. A capability answers one question — *is the module there* — and these
|
||||
* five addresses are knowledge the app has because someone read the module's
|
||||
* router, exactly as the nine `/uo/` paths in [NavPaths] are.
|
||||
*
|
||||
* Its own interface, not a section of [PublicApi], for the reason [EventsApi] is
|
||||
* its own: these exist only where the Rust module is installed, and a backend
|
||||
* running a different game answers none of them.
|
||||
*/
|
||||
interface RustApi {
|
||||
|
||||
/**
|
||||
* Every Rust server this site follows.
|
||||
*
|
||||
* Answers from the module's own tables and never from a live call to a game
|
||||
* host, so it succeeds while every server in the fleet is off — a server
|
||||
* nobody can reach comes back `online: false, stale: true` with everything it
|
||||
* last said still attached. There is no failure case here for the game being
|
||||
* down, only for the website being down.
|
||||
*/
|
||||
@GET("api/v1/public/rust/servers")
|
||||
suspend fun getServers(): RustServerListDto
|
||||
|
||||
/**
|
||||
* One server, or a **404**.
|
||||
*
|
||||
* The only route under `/servers/{id}` that can say a server is not there:
|
||||
* the four below answer an empty list for an id nobody configured, because an
|
||||
* unknown server genuinely has no events and nobody online. A server an
|
||||
* operator **disabled** answers the same 404 — switching one off is not
|
||||
* switching it into a refusal.
|
||||
*/
|
||||
@GET("api/v1/public/rust/servers/{id}")
|
||||
suspend fun getServer(@Path("id") id: String): RustServerResponse
|
||||
|
||||
/**
|
||||
* The feed, newest first.
|
||||
*
|
||||
* [kind] is comma-separated and [wipe] a wipe id; both are optional, and an
|
||||
* **absent one must be absent rather than empty** — `?wipe=` asks for a wipe
|
||||
* whose id is the empty string and answers nothing, with no error to notice.
|
||||
* Retrofit drops a null `@Query` entirely, which is why these are nullable
|
||||
* and never defaulted to `""`.
|
||||
*
|
||||
* The server serves a default-deny allowlist: moderation events, login
|
||||
* attempts and anything carrying an IP address are stored and never returned
|
||||
* here, whatever is asked for.
|
||||
*/
|
||||
@GET("api/v1/public/rust/servers/{id}/events")
|
||||
suspend fun getEvents(
|
||||
@Path("id") id: String,
|
||||
@Query("kind") kind: String? = null,
|
||||
@Query("wipe") wipe: String? = null,
|
||||
@Query("limit") limit: Int? = null,
|
||||
): RustEventListDto
|
||||
|
||||
/** Per wipe when [wipe] is given, all-time otherwise — the same rows summed. */
|
||||
@GET("api/v1/public/rust/servers/{id}/leaderboard")
|
||||
suspend fun getLeaderboard(
|
||||
@Path("id") id: String,
|
||||
@Query("wipe") wipe: String? = null,
|
||||
@Query("sort") sort: String? = null,
|
||||
@Query("limit") limit: Int? = null,
|
||||
): RustLeaderboardDto
|
||||
|
||||
/** Every wipe this server has had, newest first. */
|
||||
@GET("api/v1/public/rust/servers/{id}/wipes")
|
||||
suspend fun getWipes(@Path("id") id: String): RustWipeListDto
|
||||
|
||||
/** The presence board, which an unreachable server does not clear. */
|
||||
@GET("api/v1/public/rust/servers/{id}/online")
|
||||
suspend fun getOnline(@Path("id") id: String): RustOnlineDto
|
||||
}
|
||||
212
app/src/main/java/com/runicgateway/app/data/api/dto/EventsDto.kt
Normal file
212
app/src/main/java/com/runicgateway/app/data/api/dto/EventsDto.kt
Normal file
@@ -0,0 +1,212 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* Wire shapes for the public event surface (`docs/website/EVENTS.md` §I, events
|
||||
* Phase 14a; the app's half is M13). Field names match
|
||||
* `server/src/model/events/eventPublic.model.js` exactly.
|
||||
*
|
||||
* **That model is a PROJECTION, and these DTOs must not out-grow it.** Nothing on
|
||||
* the server side is spread into a public entry — a field reaches one because a
|
||||
* line put it there — so three things are absent from every shape below and each
|
||||
* absence is a decision core made: the **spec** (phases, steps, actions and their
|
||||
* params are the operator's plan for changing a live world; a visitor gets the
|
||||
* phase LABEL while a run is live and nothing else), **health, cleanup, claims
|
||||
* and errors** (facts about the deployment's plumbing, not about the event), and
|
||||
* **`member_key`** (module-opaque, so core cannot say what publishing one would
|
||||
* disclose). Adding a field here that the server does not send would decode to a
|
||||
* default and render as a fact.
|
||||
*
|
||||
* Every DTO ignores unknown keys (NetworkModule's lenient Json), so an additive
|
||||
* backend field is safe.
|
||||
*/
|
||||
|
||||
/**
|
||||
* One calendar entry. [kind] is `run` or `projected` and the two are drawn
|
||||
* differently on purpose.
|
||||
*
|
||||
* A **run** is a materialised occurrence: a row exists, it can be cancelled, and
|
||||
* what it says is committed to. A **projected** entry is arithmetic past the
|
||||
* materialisation horizon — a forecast with nothing behind it — so the screen
|
||||
* labels it rather than drawing it as a booking. [adjusted] and [shiftMinutes]
|
||||
* only ever arrive on a projection, and say a DST shift moved it.
|
||||
*
|
||||
* [scheduledFor] is a UTC instant and [timezone] is the EVENT's own zone, never
|
||||
* the reader's. See [com.runicgateway.app.ui.events.eventTime].
|
||||
*/
|
||||
@Serializable
|
||||
data class EventCalendarEntryDto(
|
||||
val kind: String = "run",
|
||||
val title: String = "",
|
||||
val slug: String = "",
|
||||
val seriesName: String? = null,
|
||||
val seriesSlug: String? = null,
|
||||
val scheduledFor: String = "",
|
||||
val timezone: String? = null,
|
||||
val status: String = "scheduled",
|
||||
val live: Boolean = false,
|
||||
val adjusted: Boolean = false,
|
||||
val shiftMinutes: Int = 0,
|
||||
) {
|
||||
/** True for a forecast the server has committed nothing to. */
|
||||
val isProjected: Boolean get() = kind == "projected"
|
||||
}
|
||||
|
||||
/** `GET /public/events` — the calendar for a window, ascending by instant. */
|
||||
@Serializable
|
||||
data class EventCalendarDto(
|
||||
val entries: List<EventCalendarEntryDto> = emptyList(),
|
||||
/** True when the server capped the answer; the screen says so rather than lying by omission. */
|
||||
val truncated: Boolean = false,
|
||||
)
|
||||
|
||||
/**
|
||||
* One occurrence on an event's page.
|
||||
*
|
||||
* [phase] is the label of the phase a live run is in, resolved from the version
|
||||
* that run PINNED — so an edit since does not relabel a run in flight. It is null
|
||||
* on anything that is not live, which is why the screen only ever shows it there.
|
||||
*/
|
||||
@Serializable
|
||||
data class EventOccurrenceDto(
|
||||
val runId: Long = 0,
|
||||
val scheduledFor: String = "",
|
||||
val timezone: String? = null,
|
||||
val startedAt: String? = null,
|
||||
val endedAt: String? = null,
|
||||
val status: String = "scheduled",
|
||||
val live: Boolean = false,
|
||||
val scope: String? = null,
|
||||
val phase: String? = null,
|
||||
val resultsPublishedAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One row of a published results table.
|
||||
*
|
||||
* [name] is whatever the module put in its participation `meta`, and there is
|
||||
* genuinely nothing else to render when it is absent: core has no name for a
|
||||
* character and the member key is not published, so the screen says "Unnamed"
|
||||
* rather than inventing one.
|
||||
*
|
||||
* **[score] is fractional, and it has to be.** `event_run_participants.score` is
|
||||
* `DECIMAL(18,4)`, and a module scoring by distance, time or a weighted tally
|
||||
* writes a fraction — the live walk found `318.5` in the first row it read.
|
||||
* Declaring it `Long` does not merely round: kotlinx REFUSES the body, the whole
|
||||
* response fails to decode, and the screen reports a server error for a `200`.
|
||||
* See [com.runicgateway.app.ui.events.scoreText] for how it is rendered.
|
||||
*/
|
||||
@Serializable
|
||||
data class EventParticipantDto(
|
||||
val name: String? = null,
|
||||
val score: Double = 0.0,
|
||||
val rank: Int? = null,
|
||||
)
|
||||
|
||||
/** The results table for ONE occurrence, present only once it has been published. */
|
||||
@Serializable
|
||||
data class EventResultsDto(
|
||||
val runId: Long = 0,
|
||||
val scheduledFor: String = "",
|
||||
val publishedAt: String? = null,
|
||||
val participants: List<EventParticipantDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** The arc an event belongs to, as its own page names it. */
|
||||
@Serializable
|
||||
data class EventSeriesRefDto(
|
||||
val name: String = "",
|
||||
val slug: String = "",
|
||||
)
|
||||
|
||||
/** `GET /public/events/:slug` — the event. */
|
||||
@Serializable
|
||||
data class PublicEventDto(
|
||||
val title: String = "",
|
||||
val slug: String = "",
|
||||
val summary: String? = null,
|
||||
/** Sanitized HTML, written the way a wiki page and a forum post are. */
|
||||
val body: String? = null,
|
||||
val imageUrl: String? = null,
|
||||
val timezone: String? = null,
|
||||
val series: EventSeriesRefDto? = null,
|
||||
val live: Boolean = false,
|
||||
val current: EventOccurrenceDto? = null,
|
||||
/**
|
||||
* The next occurrence — **narrower than the first of [upcoming]**, and the
|
||||
* server decides which. A cancelled occurrence still appears under what is
|
||||
* coming, because "next Friday is off" is what somebody checking a calendar
|
||||
* came to find out; it is not what "next" means.
|
||||
*/
|
||||
val next: EventOccurrenceDto? = null,
|
||||
val upcoming: List<EventOccurrenceDto> = emptyList(),
|
||||
val past: List<EventOccurrenceDto> = emptyList(),
|
||||
val results: EventResultsDto? = null,
|
||||
)
|
||||
|
||||
/** The envelope `GET /public/events/:slug` answers with. */
|
||||
@Serializable
|
||||
data class PublicEventResponse(val event: PublicEventDto = PublicEventDto())
|
||||
|
||||
/** One event as an arc lists it — the editor's order, so no dates. */
|
||||
@Serializable
|
||||
data class EventSeriesEntryDto(
|
||||
val title: String = "",
|
||||
val slug: String = "",
|
||||
val summary: String? = null,
|
||||
val imageUrl: String? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/events/series/:slug` — one arc and the listed events in it. */
|
||||
@Serializable
|
||||
data class EventSeriesDto(
|
||||
val name: String = "",
|
||||
val slug: String = "",
|
||||
val description: String? = null,
|
||||
val events: List<EventSeriesEntryDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** The envelope `GET /public/events/series/:slug` answers with. */
|
||||
@Serializable
|
||||
data class EventSeriesResponse(val series: EventSeriesDto = EventSeriesDto())
|
||||
|
||||
/**
|
||||
* One row of the caller's own participation history.
|
||||
*
|
||||
* [rank] is null until `core.results.publish` ran for that occurrence, and that
|
||||
* is a real state rather than an error — the screen says "not published" rather
|
||||
* than rendering a dash that reads as a bug.
|
||||
*
|
||||
* [id] is the participation row's own id and is what the keyset page walks back
|
||||
* on: the list gains a row every time the reader attends something, so an offset
|
||||
* would skip and repeat.
|
||||
*/
|
||||
@Serializable
|
||||
data class EventHistoryEntryDto(
|
||||
val id: Long = 0,
|
||||
val runId: Long = 0,
|
||||
val title: String = "",
|
||||
val slug: String = "",
|
||||
val seriesName: String? = null,
|
||||
val seriesSlug: String? = null,
|
||||
val scheduledFor: String = "",
|
||||
val startedAt: String? = null,
|
||||
val endedAt: String? = null,
|
||||
val timezone: String? = null,
|
||||
val status: String = "scheduled",
|
||||
val joinedAt: String? = null,
|
||||
// Fractional, for the reason [EventParticipantDto.score] gives.
|
||||
val score: Double = 0.0,
|
||||
val rank: Int? = null,
|
||||
val resultsPublishedAt: String? = null,
|
||||
)
|
||||
|
||||
/** `GET /player/events/history` — self-scoped, one page. */
|
||||
@Serializable
|
||||
data class EventHistoryDto(
|
||||
val entries: List<EventHistoryEntryDto> = emptyList(),
|
||||
)
|
||||
@@ -72,3 +72,139 @@ data class NotificationStreamsDto(
|
||||
data class NotificationSubscriptionsDto(
|
||||
val streams: List<String>,
|
||||
)
|
||||
|
||||
// ── The in-app channel (ENGAGEMENT.md phase 7/8) ───────────────────────────
|
||||
//
|
||||
// The inbox is the first notification surface that carries CONTENT. Everything
|
||||
// above is a preference or a content-free tickle; these four shapes are the
|
||||
// items themselves, pulled over the authenticated API after a tickle wakes the
|
||||
// app. The wire names come from `userNotifications.db.js`'s `toItem`.
|
||||
|
||||
/**
|
||||
* One inbox item. [read] is the flag and [readAt] the stamp, sent side by side so
|
||||
* a client renders one without parsing the other.
|
||||
*
|
||||
* [url] is where the item points on the site (rendered from the template's
|
||||
* `email.button` block) and is **null on most items** — an inbox row is complete
|
||||
* on its own. [triggerId] is the event that produced it, in §7.2's ONE namespace,
|
||||
* so it is the same vocabulary a push tickle's `stream` speaks.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationItemDto(
|
||||
val id: Long = 0,
|
||||
val triggerId: String = "",
|
||||
val title: String = "",
|
||||
val body: String? = null,
|
||||
val url: String? = null,
|
||||
val read: Boolean = false,
|
||||
val readAt: String? = null,
|
||||
val createdAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET /auth/me/notifications` — one page, newest first.
|
||||
*
|
||||
* Keyset-paged: the next page is `?before=<the last item's id>`, not an offset,
|
||||
* because the list gains rows at the top while it is being read. [hasMore] comes
|
||||
* from the server's take+1, so "is there another page" costs no second query.
|
||||
* [unread] counts the WHOLE inbox, not the page — it rides along so a screen
|
||||
* rendering both a badge and a list from one response cannot show the two
|
||||
* disagreeing.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationInboxDto(
|
||||
val items: List<NotificationItemDto> = emptyList(),
|
||||
val hasMore: Boolean = false,
|
||||
val unread: Int = 0,
|
||||
)
|
||||
|
||||
/** `GET /auth/me/notifications/unread-count` — the badge, on its own. */
|
||||
@Serializable
|
||||
data class NotificationUnreadDto(
|
||||
val unread: Int = 0,
|
||||
)
|
||||
|
||||
/**
|
||||
* What both mark-read routes answer with. [unread] is the count AFTER the write,
|
||||
* so the badge follows from the response rather than from a second call.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationReadResultDto(
|
||||
val ok: Boolean = false,
|
||||
val changed: Int = 0,
|
||||
val unread: Int = 0,
|
||||
)
|
||||
|
||||
// ── Per-channel preferences (ENGAGEMENT.md phase 3) ────────────────────────
|
||||
|
||||
/**
|
||||
* One delivery channel from the registry. [modes] is what this channel accepts —
|
||||
* `["off","instant"]` for push and in-app, `["off","instant","digest"]` for email
|
||||
* — and the UI renders its control from THIS, never from a hardcoded set, so a
|
||||
* channel added server-side arrives without an app release.
|
||||
*
|
||||
* [carriesContent] is the tickle invariant stated on the wire: push is `false`,
|
||||
* which is why a push item's title never leaves the server.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationChannelDto(
|
||||
val id: String = "",
|
||||
val label: String = "",
|
||||
val carriesContent: Boolean = false,
|
||||
val defaultMode: String = "off",
|
||||
val supportsDigest: Boolean = false,
|
||||
val modes: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One subscribable id, from `GET /auth/me/notifications/channels`. The list is the
|
||||
* UNION of push streams and event triggers in one namespace (§7.2), so an id may
|
||||
* be a stream, a trigger, or both.
|
||||
*
|
||||
* [channels] is which channels apply to THIS id — a trigger-only id carries no
|
||||
* `push` because nothing is registered to push it — and [modes] is the EFFECTIVE
|
||||
* mode per channel: where the user has expressed nothing the server has already
|
||||
* substituted that channel's default, and the client must not re-implement the
|
||||
* defaulting.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationChannelItemDto(
|
||||
val id: String = "",
|
||||
val label: String = "",
|
||||
val description: String = "",
|
||||
val personal: Boolean = false,
|
||||
val requiresLinkedAccount: Boolean = false,
|
||||
val ceiling: String? = null,
|
||||
val channels: List<String> = emptyList(),
|
||||
val modes: Map<String, String> = emptyMap(),
|
||||
)
|
||||
|
||||
/** `GET · PUT /auth/me/notifications/channels` — the whole stored truth. */
|
||||
@Serializable
|
||||
data class NotificationChannelPrefsDto(
|
||||
val channels: List<NotificationChannelDto> = emptyList(),
|
||||
val items: List<NotificationChannelItemDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** One (id, channel) → mode pair of a sparse update. */
|
||||
@Serializable
|
||||
data class NotificationChannelPrefDto(
|
||||
val id: String,
|
||||
val channel: String,
|
||||
val mode: String,
|
||||
)
|
||||
|
||||
/**
|
||||
* `PUT /auth/me/notifications/channels` body — a SPARSE update: only the pairs
|
||||
* named are written and every other pair is left alone, so one toggle saves
|
||||
* without the screen holding the whole table.
|
||||
*
|
||||
* [prefs] has no default for the same reason [NotificationSubscriptionsDto.streams]
|
||||
* has none — kotlinx omits a property equal to its default, and the validator
|
||||
* requires the field. Unlike that DTO there is no empty-set case to get wrong
|
||||
* here: `off` is a mode, never an omission.
|
||||
*/
|
||||
@Serializable
|
||||
data class NotificationChannelPrefsUpdateDto(
|
||||
val prefs: List<NotificationChannelPrefDto>,
|
||||
)
|
||||
|
||||
@@ -83,8 +83,47 @@ data class CharProfileDto(
|
||||
val titles: TitlesDto? = null,
|
||||
val guild: GuildRefDto? = null,
|
||||
val governorOf: List<String> = emptyList(),
|
||||
/**
|
||||
* Loyalty / points standings (Protocol 3.0 §7.3). Empty for a character that has
|
||||
* earned nothing anywhere — the shard omits systems the character has no entry in
|
||||
* — and empty on a shard whose plugin predates 3.0.
|
||||
*
|
||||
* Served **ungated**: a character's own standings are self-service data on
|
||||
* `/player/shard/char/:serial` and do not depend on the public `leaderboards`
|
||||
* feature being visible. Don't re-gate them app-side.
|
||||
*/
|
||||
val points: List<CharPointsDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One point system a character holds a score in (Protocol 3.0 §7.3).
|
||||
*
|
||||
* Three shapes here are counter-intuitive, and all three are what a REAL shard sends
|
||||
* (`docs/link/v3.md` §7.5 — a fake shard emits whatever the spec says it should):
|
||||
*
|
||||
* - **[maxPoints] `0` means UNCAPPED, and is the common case**, not an edge case.
|
||||
* ServUO's idiom for an uncapped system is `double.MaxValue`, which the plugin
|
||||
* normalises to `0` because the C# cast is unchecked and yielded `long.MinValue`.
|
||||
* Nothing may divide by it, and a full-width progress bar for an uncapped score
|
||||
* would imply a completion that doesn't exist.
|
||||
* - **[nameString] is usually `null`.** Most systems name themselves with a cliloc
|
||||
* rather than a literal, so humanising [system] (`QueensLoyalty` → "Queens
|
||||
* Loyalty") is the PRIMARY display path, not a defensive fallback.
|
||||
* - **[rank] is absent unless the shard runs `Bridge.cfg PointsProfileRank=true`.**
|
||||
* Absent and "unranked" are different answers, so it renders only when sent.
|
||||
*/
|
||||
@Serializable
|
||||
data class CharPointsDto(
|
||||
val system: String? = null,
|
||||
val nameString: String? = null,
|
||||
val points: Long? = null,
|
||||
val maxPoints: Long? = null,
|
||||
val rank: Int? = null,
|
||||
) {
|
||||
/** The cap, or null when the system is uncapped (see [maxPoints]). */
|
||||
val cap: Long? get() = maxPoints?.takeIf { it > 0 }
|
||||
}
|
||||
|
||||
@Serializable
|
||||
data class CharStatsDto(
|
||||
val str: Int? = null,
|
||||
@@ -134,17 +173,45 @@ data class EquipmentDto(
|
||||
val itemId: Int? = null,
|
||||
val hue: Int? = null,
|
||||
val mods: JsonObject? = null,
|
||||
)
|
||||
/**
|
||||
* A player-given name — set for the minority of items someone has renamed, null
|
||||
* for almost everything else. The shard sends the plain `Item.Name` field; it
|
||||
* never builds a display name (that call is a packet builder, not a field read).
|
||||
*/
|
||||
val name: String? = null,
|
||||
/**
|
||||
* The item's type name, resolved from its cliloc id **by the website** against
|
||||
* its own table (`docs/website/CLILOCS.md`). Null on a shard that has no cliloc
|
||||
* table configured, which is fully supported — the sheet then falls back to the
|
||||
* layer, exactly as it did before the table existed.
|
||||
*/
|
||||
val clilocName: String? = null,
|
||||
) {
|
||||
/**
|
||||
* What to call this item.
|
||||
*
|
||||
* A player-given [name] outranks the resolved type name — "Bob's lucky axe" must
|
||||
* not be relabelled "hatchet" — and the server applies the same precedence, so
|
||||
* this only re-states it for an item that arrived with both.
|
||||
*/
|
||||
val label: String? get() = name ?: clilocName ?: layer
|
||||
}
|
||||
|
||||
/**
|
||||
* 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).
|
||||
* 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.
|
||||
*
|
||||
* [rewardResolved] is the website's **parallel array** with the numeric entries turned
|
||||
* into words against its cliloc table — same length and order as [reward], with a null
|
||||
* where an id resolved to nothing. It is absent entirely when no entry was numeric or
|
||||
* the shard has no cliloc table, so read it positionally and tolerate it being short.
|
||||
* See `displayTitles` in the character sheet.
|
||||
*/
|
||||
@Serializable
|
||||
data class TitlesDto(
|
||||
val selected: Int? = null,
|
||||
val reward: List<String> = emptyList(),
|
||||
val rewardResolved: List<String?> = emptyList(),
|
||||
val fameKarma: String? = null,
|
||||
val skill: String? = null,
|
||||
)
|
||||
|
||||
@@ -5,6 +5,7 @@ package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.SerialName
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonElement
|
||||
|
||||
/**
|
||||
* DTOs for the public site/identity endpoints. Shapes mirror the backend
|
||||
@@ -19,6 +20,47 @@ data class VersionDto(
|
||||
val service: String = "",
|
||||
val api: String = "",
|
||||
val server: String = "",
|
||||
/**
|
||||
* What CORE serves beyond the baseline every backend has (events Phase 14a;
|
||||
* `MODULE_API.md` §2.9). Opaque strings, the same word a module uses on
|
||||
* `GET /public/modules` so a client feature-detects one way, and a **separate
|
||||
* list** because core is not a module.
|
||||
*
|
||||
* **The value is in what is absent**, which is why the default is empty
|
||||
* rather than something meaningful: a backend released before a capability
|
||||
* existed omits the key entirely, and that is how the app tells an older site
|
||||
* from one that simply has nothing to show. An unknown string is absent, and
|
||||
* no route may be inferred from one.
|
||||
*/
|
||||
val capabilities: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One installed, **started** module on `GET /public/modules`.
|
||||
*
|
||||
* A module that is disabled or failed to load is absent rather than listed with a
|
||||
* state — its routes and its nav are absent too, so a client renders a site
|
||||
* without that capability rather than one advertising a capability that 503s.
|
||||
*/
|
||||
@Serializable
|
||||
data class InstalledModuleDto(
|
||||
val id: String = "",
|
||||
val name: String = "",
|
||||
val version: String = "",
|
||||
val capabilities: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* `GET /public/modules` — what this backend is serving beyond core.
|
||||
*
|
||||
* Database-free and never gated by site mode, so the app can feature-detect
|
||||
* during maintenance. A **500** is the one answer that is not an answer: core
|
||||
* refuses to return `[]` for a list read before its loader ran, because a caller
|
||||
* cannot tell an empty list from a mis-ordered boot.
|
||||
*/
|
||||
@Serializable
|
||||
data class ModulesDto(
|
||||
val modules: List<InstalledModuleDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** `GET /public/status` — site mode + version for the first-run probe (§3). */
|
||||
@@ -80,4 +122,28 @@ data class SettingsDto(
|
||||
val brand: BrandDto = BrandDto(),
|
||||
/** Push relay config (M7); default (null ntfyUrl) on a backend that predates it. */
|
||||
val push: PushConfigDto = PushConfigDto(),
|
||||
/**
|
||||
* The admin's **resolved** theme tokens — the CSS custom properties the site
|
||||
* paints, already layered `:root ← preset ← custom` by the server
|
||||
* (THEMING_AND_NAV.md §3). Absent when no `theme_visual` row exists, which
|
||||
* means "the shipped defaults" and is the untouched-instance path.
|
||||
*
|
||||
* Held as a raw [JsonElement] rather than a `Map<String, String>` on
|
||||
* purpose: a single unexpected value must not fail the decode of the whole
|
||||
* settings payload and take `brand` and `push` down with it. It is coerced
|
||||
* field-by-field by `SiteAppearance.from`.
|
||||
*
|
||||
* The raw `theme_visual` / `brand_assets` rows ride along in this same
|
||||
* response and are deliberately **not** modeled — they are inputs, and
|
||||
* re-deriving a palette from them would be a second `resolveThemeTokens` in
|
||||
* Kotlin, guaranteed to drift (§3).
|
||||
*/
|
||||
val theme: JsonElement? = null,
|
||||
/**
|
||||
* The public nav overrides, as the raw JSON **string** stored in
|
||||
* `settings.value` (TEXT) — so it is parsed a second time, exactly as the web
|
||||
* client's `parseJsonSetting` does. Absent when the admin never edited the
|
||||
* nav.
|
||||
*/
|
||||
@SerialName("nav_public") val navPublic: String? = null,
|
||||
)
|
||||
|
||||
196
app/src/main/java/com/runicgateway/app/data/api/dto/RustDto.kt
Normal file
196
app/src/main/java/com/runicgateway/app/data/api/dto/RustDto.kt
Normal file
@@ -0,0 +1,196 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.json.JsonElement
|
||||
import kotlinx.serialization.json.JsonNull
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.JsonPrimitive
|
||||
|
||||
/**
|
||||
* DTOs for `module-rust`'s public read path (`docs/modules/rust/PLAN.md` §17,
|
||||
* §18; M14).
|
||||
*
|
||||
* **Every one of these renders while the game is off**, which is the module's own
|
||||
* promise and therefore this leg's: the website never calls a game server from a
|
||||
* page, it answers from its own tables, and a server nobody can reach answers
|
||||
* `online: false` with everything it last said still attached. Nothing here has
|
||||
* an "unavailable" shape, because there is no such answer on this wire.
|
||||
*/
|
||||
|
||||
/** `GET /public/rust/servers` — every server this site follows. */
|
||||
@Serializable
|
||||
data class RustServerListDto(
|
||||
val servers: List<RustServerDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** `GET /public/rust/servers/{id}` — one of them, or a 404. */
|
||||
@Serializable
|
||||
data class RustServerResponse(
|
||||
val server: RustServerDto = RustServerDto(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One Rust server and what it last reported.
|
||||
*
|
||||
* **[online] and [stale] are not the same fact and the screen needs both.**
|
||||
* `online` is what the last frame said; `stale` is whether anything has arrived
|
||||
* recently enough to believe it. The server computes `online` as *"the row says
|
||||
* up AND the row is fresh"*, so a stale row can never claim a server is up — but
|
||||
* `stale` still has to come through, because a fresh row saying "down" and a row
|
||||
* nobody has written in an hour are different things to say to a reader.
|
||||
*
|
||||
* **[lastSeenAt] is what a page means by "last reported", and [updatedAt] is
|
||||
* not.** The module shipped a defect on exactly this in phase 3 and fixed it in
|
||||
* phase 4: `updatedAt` moves on every poll including a FAILED one, so reading it
|
||||
* as "last reported" made an offline server claim it had just checked in, every
|
||||
* thirty seconds, for as long as it stayed down. Only a frame moves
|
||||
* `lastSeenAt`. The app must not repeat the mistake one tier along.
|
||||
*/
|
||||
@Serializable
|
||||
data class RustServerDto(
|
||||
val id: String = "",
|
||||
val name: String = "",
|
||||
val online: Boolean = false,
|
||||
val players: Int = 0,
|
||||
val maxPlayers: Int = 0,
|
||||
val hostname: String? = null,
|
||||
val level: String? = null,
|
||||
val worldSize: Int? = null,
|
||||
val seed: Long? = null,
|
||||
/** The CURRENT wipe, from the state row rather than the newest ingested wipe. */
|
||||
val wipeId: String? = null,
|
||||
val wipedAt: String? = null,
|
||||
/** When a frame last arrived. What "last reported" means. */
|
||||
val lastSeenAt: String? = null,
|
||||
/** When this module last wrote the row — a failed poll moves it too. */
|
||||
val updatedAt: String? = null,
|
||||
val stale: Boolean = false,
|
||||
)
|
||||
|
||||
/** `GET /public/rust/servers/{id}/events` — the killfeed and everything else public. */
|
||||
@Serializable
|
||||
data class RustEventListDto(
|
||||
val events: List<RustEventDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One stored frame.
|
||||
*
|
||||
* **[frame] is deliberately untyped.** The module stores the whole frame the
|
||||
* bridge plugin emitted and indexes only the columns it serves, so the fields
|
||||
* differ per [kind] and a later protocol adds more. A sealed hierarchy here would
|
||||
* have to be extended in this repo before a server running a newer plugin could
|
||||
* say anything new, and the module's own rule is the opposite: an unknown kind
|
||||
* renders as itself rather than being dropped. [RustFeed] is the one place that
|
||||
* knows the field names.
|
||||
*
|
||||
* [t] is epoch milliseconds — the stamp the plugin put on the frame, not a
|
||||
* database column, so it is a number here and an ISO string everywhere else on
|
||||
* this wire.
|
||||
*/
|
||||
@Serializable
|
||||
data class RustEventDto(
|
||||
val id: Long = 0,
|
||||
val kind: String = "",
|
||||
val t: Long = 0,
|
||||
val wipeId: String? = null,
|
||||
val steamId: String? = null,
|
||||
val frame: JsonObject = JsonObject(emptyMap()),
|
||||
) {
|
||||
/**
|
||||
* One frame field as text, or null.
|
||||
*
|
||||
* **A JSON `null` answers null, not the four letters.** The plugin writes
|
||||
* explicit nulls — `reason` on a clean disconnect, `weapon` on a fall — and a
|
||||
* primitive's `content` is the string `"null"` for every one of them, which
|
||||
* would put the word into a killfeed line. An empty string answers null too:
|
||||
* the callers here all mean "is there something to show".
|
||||
*/
|
||||
fun str(key: String): String? = primitive(key)?.content?.takeIf { it.isNotEmpty() }
|
||||
|
||||
/** One frame field as a number, or null when it is absent, null or not one. */
|
||||
fun num(key: String): Double? = primitive(key)?.content?.toDoubleOrNull()
|
||||
|
||||
/** One frame field as a flag. Absent, null and anything non-boolean are all false. */
|
||||
fun flag(key: String): Boolean = primitive(key)?.content == "true"
|
||||
|
||||
/** The raw element, for a caller that wants to decide for itself. */
|
||||
fun raw(key: String): JsonElement? = frame[key]
|
||||
|
||||
private fun primitive(key: String): JsonPrimitive? =
|
||||
(frame[key] as? JsonPrimitive)?.takeIf { it !is JsonNull }
|
||||
}
|
||||
|
||||
/** `GET /public/rust/servers/{id}/leaderboard` — per wipe, or all-time. */
|
||||
@Serializable
|
||||
data class RustLeaderboardDto(
|
||||
val leaderboard: List<RustLeaderboardRowDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One player's standing.
|
||||
*
|
||||
* All-time is these same per-wipe rows summed rather than a second set of
|
||||
* counters, so the two can never disagree — which is why a player who appears
|
||||
* only in an older wipe **drops out** of the current one rather than reading
|
||||
* zero. The screen must not fill that gap in with zeroes.
|
||||
*/
|
||||
@Serializable
|
||||
data class RustLeaderboardRowDto(
|
||||
val steamId: String = "",
|
||||
val name: String? = null,
|
||||
val kills: Int = 0,
|
||||
val deaths: Int = 0,
|
||||
val npcKills: Int = 0,
|
||||
val structures: Int = 0,
|
||||
val playtimeSec: Long = 0,
|
||||
val lastSeen: String? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/rust/servers/{id}/wipes` — every wipe this server has had, newest first. */
|
||||
@Serializable
|
||||
data class RustWipeListDto(
|
||||
val wipes: List<RustWipeDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One wipe.
|
||||
*
|
||||
* [wipeId] is derived by the bridge plugin from the save's creation time and
|
||||
* stamped on every frame, so it is the same id the feed and the leaderboard are
|
||||
* filtered by — which is what makes the per-wipe view navigable at all.
|
||||
*/
|
||||
@Serializable
|
||||
data class RustWipeDto(
|
||||
val wipeId: String = "",
|
||||
val saveCreatedAt: String? = null,
|
||||
val firstSeen: String? = null,
|
||||
val lastSeen: String? = null,
|
||||
)
|
||||
|
||||
/** `GET /public/rust/servers/{id}/online` — who is on right now. */
|
||||
@Serializable
|
||||
data class RustOnlineDto(
|
||||
val players: List<RustPresenceDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One row of the presence board.
|
||||
*
|
||||
* Read from the board the bridge re-sends on every connect and every minute,
|
||||
* rather than counted from connect and disconnect events — so it is right even
|
||||
* after the website has missed one. **An unreachable server does not clear it**,
|
||||
* deliberately: these rows are still the best answer anybody has. Presented bare
|
||||
* they read as *who is on right now*, which is the one thing an offline server
|
||||
* cannot be saying, so the screen has to say which it is.
|
||||
*/
|
||||
@Serializable
|
||||
data class RustPresenceDto(
|
||||
val steamId: String = "",
|
||||
val name: String? = null,
|
||||
val sleeping: Boolean = false,
|
||||
val connectedAt: String? = null,
|
||||
)
|
||||
@@ -0,0 +1,367 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.api.dto
|
||||
|
||||
import kotlinx.serialization.Serializable
|
||||
|
||||
/**
|
||||
* DTOs for the four shard-content surfaces Protocol 3.0 added (PLAN.md §9 M11):
|
||||
* the ruleset, the points leaderboards, the player-vendor marketplace, and the spawn
|
||||
* atlas. Shapes mirror the website's `public/shard.controller.js` + `public/atlas.
|
||||
* controller.js` responses; see `docs/link/v3.md` §5–§8.
|
||||
*
|
||||
* Every field is nullable-with-a-default, which is load-bearing rather than merely
|
||||
* defensive here: an admin can gate individual fields away per audience rung
|
||||
* (`ownerName`, `location`, a board's `name`), so a response legitimately arrives
|
||||
* with them missing and must still decode.
|
||||
*/
|
||||
|
||||
// ── Ruleset (§5) ────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* `GET /public/shard/ruleset` — what this shard's world is configured to do.
|
||||
*
|
||||
* Every block is optional and omitted when its system is off, so a null block means
|
||||
* "not applicable here", not "unknown". A `null` BODY (rather than an empty object)
|
||||
* means the shard has never published a ruleset — distinct from the feature being
|
||||
* switched off, which is a 404.
|
||||
*/
|
||||
@Serializable
|
||||
data class RulesetDto(
|
||||
val shard: String? = null,
|
||||
val expansion: String? = null,
|
||||
/**
|
||||
* The public connect address, published only when the operator set one. It is
|
||||
* also the ruleset's one admin-configurable field, so it can be present for a
|
||||
* signed-in viewer and absent for an anonymous one.
|
||||
*/
|
||||
val connect: String? = null,
|
||||
/** A flat bag of on/off flags — `cityLoyalty`, `vvv`, `siege`, `chat`, … */
|
||||
val systems: Map<String, Boolean> = emptyMap(),
|
||||
val caps: RulesetCapsDto? = null,
|
||||
val accounts: RulesetAccountsDto? = null,
|
||||
val housing: RulesetHousingDto? = null,
|
||||
val vetRewards: RulesetVetRewardsDto? = null,
|
||||
val vendors: RulesetVendorsDto? = null,
|
||||
val vvv: RulesetVvvDto? = null,
|
||||
val store: RulesetStoreDto? = null,
|
||||
val schedule: RulesetScheduleDto? = null,
|
||||
val updatedAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* Skill and stat caps.
|
||||
*
|
||||
* **[skill] and [totalSkill] are in TENTHS** — 1000 is 100.0 — the way ServUO stores
|
||||
* them, and the raw number is actively misleading rather than merely unhelpful (a
|
||||
* "1000 skill cap" reads as a shard with ten times the usual limit). Use [skillCap]
|
||||
* and [totalSkillCap]. The stat caps below them are plain values.
|
||||
*/
|
||||
@Serializable
|
||||
data class RulesetCapsDto(
|
||||
val skill: Int? = null,
|
||||
val totalSkill: Int? = null,
|
||||
val stat: Int? = null,
|
||||
val str: Int? = null,
|
||||
val dex: Int? = null,
|
||||
val int: Int? = null,
|
||||
val strMax: Int? = null,
|
||||
val dexMax: Int? = null,
|
||||
val intMax: Int? = null,
|
||||
) {
|
||||
val skillCap: Double? get() = skill?.let { it / 10.0 }
|
||||
val totalSkillCap: Double? get() = totalSkill?.let { it / 10.0 }
|
||||
}
|
||||
|
||||
@Serializable
|
||||
data class RulesetAccountsDto(
|
||||
val perIp: Int? = null,
|
||||
val charSlots: Int? = null,
|
||||
val autoCreate: Boolean? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class RulesetHousingDto(val accountHouseLimit: Int? = null)
|
||||
|
||||
@Serializable
|
||||
data class RulesetVetRewardsDto(
|
||||
val enabled: Boolean? = null,
|
||||
val rewardIntervalDays: Int? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class RulesetVendorsDto(
|
||||
val restockDelayMinutes: Int? = null,
|
||||
val maxSell: Int? = null,
|
||||
val economyStockAmount: Int? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class RulesetVvvDto(
|
||||
val enabled: Boolean? = null,
|
||||
val startSilver: Int? = null,
|
||||
val enhancedRules: Boolean? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class RulesetStoreDto(
|
||||
val enabled: Boolean? = null,
|
||||
val currencyName: String? = null,
|
||||
)
|
||||
|
||||
@Serializable
|
||||
data class RulesetScheduleDto(
|
||||
val autoSaveFrequencyMinutes: Int? = null,
|
||||
val autoRestartEnabled: Boolean? = null,
|
||||
val autoRestartHour: Int? = null,
|
||||
val autoRestartMinute: Int? = null,
|
||||
)
|
||||
|
||||
// ── Leaderboards (§7) ───────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* One point system's board (`GET /public/shard/points`, `/points/:system`).
|
||||
*
|
||||
* [maxPoints] `0` means **uncapped** and is the common case, and [nameString] is
|
||||
* usually null because most systems name themselves with a cliloc — the same two
|
||||
* traps as [CharPointsDto], documented in full there.
|
||||
*
|
||||
* [players] counts players actually *holding* points, not the entry count: ten of the
|
||||
* shard's systems auto-add a zero-point row for every character ever created, so the
|
||||
* raw count would report the whole census as one system's participants.
|
||||
*/
|
||||
@Serializable
|
||||
data class PointsBoardDto(
|
||||
val system: String? = null,
|
||||
val nameString: String? = null,
|
||||
val nameNumber: Int? = null,
|
||||
val maxPoints: Long? = null,
|
||||
val players: Int? = null,
|
||||
val showOnGump: Boolean = true,
|
||||
val top: List<PointsEntryDto> = emptyList(),
|
||||
val t: Long? = null,
|
||||
val updatedAt: String? = null,
|
||||
) {
|
||||
/** The cap, or null when the system is uncapped. */
|
||||
val cap: Long? get() = maxPoints?.takeIf { it > 0 }
|
||||
}
|
||||
|
||||
/**
|
||||
* A ranked character on a board. [name] is admin-configurable (the `leaderboards`
|
||||
* feature's one field rule), so a shard can publish standings without naming who
|
||||
* holds them — a rank with no name is a valid row, not a broken one.
|
||||
*/
|
||||
@Serializable
|
||||
data class PointsEntryDto(
|
||||
val rank: Int? = null,
|
||||
val serial: String? = null,
|
||||
val name: String? = null,
|
||||
val points: Long? = null,
|
||||
)
|
||||
|
||||
// ── Marketplace (§8) ────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Where a shop stands. **Nested, not flattened**, on the wire and in the read model
|
||||
* alike, so that ONE admin rule hides the facet, the coordinates, the region and the
|
||||
* house together — five flat keys would be five rules that drift apart (`v3.md` §8.8).
|
||||
* A null location means an admin gated it away; render that as an answer, not a blank.
|
||||
*/
|
||||
@Serializable
|
||||
data class MarketLocationDto(
|
||||
val map: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val z: Int? = null,
|
||||
val region: String? = null,
|
||||
val house: String? = null,
|
||||
)
|
||||
|
||||
/** The shop a listing belongs to, as embedded in a search result. */
|
||||
@Serializable
|
||||
data class MarketVendorRefDto(
|
||||
val serial: String? = null,
|
||||
val shopName: String? = null,
|
||||
val ownerName: String? = null,
|
||||
val location: MarketLocationDto? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One item for sale. [displayName] is resolved server-side against the site's cliloc
|
||||
* table, preferring a player-set [name]; a shard with no cliloc table configured sends
|
||||
* neither and the item renders by id.
|
||||
*
|
||||
* [child] marks an item priced by an enclosing container rather than itself, exactly
|
||||
* as the in-game Vendor Search reports it.
|
||||
*/
|
||||
@Serializable
|
||||
data class MarketListingDto(
|
||||
val serial: String? = null,
|
||||
val itemId: Int? = null,
|
||||
val hue: Int? = null,
|
||||
val amount: Int? = null,
|
||||
val price: Long? = null,
|
||||
val name: String? = null,
|
||||
val cliloc: Int? = null,
|
||||
val displayName: String? = null,
|
||||
val child: Boolean = false,
|
||||
val vendor: MarketVendorRefDto? = null,
|
||||
) {
|
||||
/** What to call this item; null when the shard publishes no name for it. */
|
||||
val label: String? get() = name ?: displayName
|
||||
}
|
||||
|
||||
/**
|
||||
* A page of search results (`GET /public/shard/market`).
|
||||
*
|
||||
* Returns **listings, not vendors**: "who sells a vanquishing kryss and for how much"
|
||||
* is the question, and a vendor-shaped result would make every caller flatten the
|
||||
* shops back out.
|
||||
*
|
||||
* [staleAt] is the oldest vendor timestamp in the index and **must be surfaced**. The
|
||||
* shard sweeps vendors round-robin, so a listing can legitimately be a full cycle old;
|
||||
* a page implying live prices sends someone to an item that sold twenty minutes ago.
|
||||
*/
|
||||
@Serializable
|
||||
data class MarketPageDto(
|
||||
val listings: List<MarketListingDto> = emptyList(),
|
||||
val total: Int = 0,
|
||||
val limit: Int? = null,
|
||||
val offset: Int? = null,
|
||||
val vendors: Int? = null,
|
||||
val staleAt: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One shop and its stock (`GET /public/shard/market/vendors/:serial`).
|
||||
*
|
||||
* [truncated] means the shard publishes only the first `MarketMaxListings` of a larger
|
||||
* inventory — [count] is what is published, [total] what the shop holds. Saying so is
|
||||
* the point of this screen: a search result list cannot express it.
|
||||
*/
|
||||
@Serializable
|
||||
data class MarketVendorDto(
|
||||
val serial: String? = null,
|
||||
val shopName: String? = null,
|
||||
val ownerSerial: String? = null,
|
||||
val ownerName: String? = null,
|
||||
val location: MarketLocationDto? = null,
|
||||
val count: Int? = null,
|
||||
val total: Int? = null,
|
||||
val truncated: Boolean = false,
|
||||
val updatedAt: String? = null,
|
||||
val items: List<MarketListingDto> = emptyList(),
|
||||
)
|
||||
|
||||
/** Index size, staleness and the filter options that actually hold vendors. */
|
||||
@Serializable
|
||||
data class MarketMetaDto(
|
||||
val vendors: Int = 0,
|
||||
val items: Int = 0,
|
||||
val staleAt: String? = null,
|
||||
val freshAt: String? = null,
|
||||
val maps: List<String> = emptyList(),
|
||||
val regions: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
// ── Spawn atlas (§6) ────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* A creature in the bestiary. Served from `/public/atlas`, **not** `/public/shard`:
|
||||
* the atlas is static shard *content* parsed from the server's own data files, not
|
||||
* live shard *state*, so it does not go offline with the sidecar — but unlike the
|
||||
* shard routes it IS site-mode gated, like posts and the wiki.
|
||||
*
|
||||
* [points] is a **count** of spawners; [spawners] is the list, and only the
|
||||
* single-creature route sends it. The two names are one letter apart in meaning and
|
||||
* were deliberately separated (`v3.md` §6.3) — do not reuse one for the other.
|
||||
*/
|
||||
@Serializable
|
||||
data class AtlasCreatureDto(
|
||||
val slug: String? = null,
|
||||
val name: String? = null,
|
||||
/** How many can be alive at once, summed across every spawner. */
|
||||
val total: Int? = null,
|
||||
/** How many spawners mention this creature. */
|
||||
val points: Int? = null,
|
||||
/** Spawner count per facet. */
|
||||
val facets: Map<String, Int> = emptyMap(),
|
||||
/**
|
||||
* Where it appears, aggregated per named place — the detail route only, and the
|
||||
* answer the whole screen exists to give. **Objects, not strings:** the server
|
||||
* sends `{facet, label, spawners, maxAlive}`, and typing this `List<String>`
|
||||
* made the detail route fail to decode entirely.
|
||||
*/
|
||||
val places: List<AtlasPlaceDto> = emptyList(),
|
||||
/**
|
||||
* Operator-supplied sprite file name under `/uploads/atlas/`, or null — which is
|
||||
* the normal state, since no artwork ships. Neither client renders it yet; the
|
||||
* field is carried so a decode never depends on that staying true.
|
||||
*/
|
||||
val art: String? = null,
|
||||
val spawners: List<AtlasSpawnerDto> = emptyList(),
|
||||
val spawnersTruncated: Boolean = false,
|
||||
/** Creatures sharing its spawners — the detail route only. */
|
||||
val alsoHere: List<AtlasCreatureDto> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* One named place a creature spawns in, already aggregated across its spawners.
|
||||
*
|
||||
* [label] is the server's point-in-rect resolution of raw coordinates ("Shrines",
|
||||
* "Isamu-Jima", "Yew"), falling back to the nearest landmark and finally
|
||||
* "Wilderness" — turning a list of coordinates into an answer.
|
||||
*/
|
||||
@Serializable
|
||||
data class AtlasPlaceDto(
|
||||
val facet: String? = null,
|
||||
val label: String? = null,
|
||||
/** Spawners in this place. */
|
||||
val spawners: Int? = null,
|
||||
/** How many can be alive at once here, summed across those spawners. */
|
||||
val maxAlive: Int? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
* One spawn point.
|
||||
*
|
||||
* **[minDelay] / [maxDelay] are SECONDS**, normalised by the server's parser.
|
||||
* XmlSpawner writes them in minutes *except* when a delay doesn't divide into whole
|
||||
* minutes, flagging that per record — so the raw file has `5` meaning five minutes on
|
||||
* one spawner and five seconds on the next, both plausible. The API and this client
|
||||
* carry seconds throughout.
|
||||
*/
|
||||
@Serializable
|
||||
data class AtlasSpawnerDto(
|
||||
val id: Long? = null,
|
||||
val facet: String? = null,
|
||||
val name: String? = null,
|
||||
val x: Int? = null,
|
||||
val y: Int? = null,
|
||||
val maxCount: Int? = null,
|
||||
val minDelay: Int? = null,
|
||||
val maxDelay: Int? = null,
|
||||
val region: String? = null,
|
||||
val landmark: String? = null,
|
||||
/** The server's own "Despise, Felucca" style placement label. */
|
||||
val label: String? = null,
|
||||
)
|
||||
|
||||
/** A page of creature search results (`GET /public/atlas/creatures`). */
|
||||
@Serializable
|
||||
data class AtlasCreaturePageDto(
|
||||
val creatures: List<AtlasCreatureDto> = emptyList(),
|
||||
val total: Int = 0,
|
||||
val limit: Int? = null,
|
||||
val offset: Int? = null,
|
||||
)
|
||||
|
||||
/** When the atlas was last derived from the shard's data files, and what it holds. */
|
||||
@Serializable
|
||||
data class AtlasMetaDto(
|
||||
val importedAt: String? = null,
|
||||
val generatedAt: String? = null,
|
||||
val counts: Map<String, Int> = emptyMap(),
|
||||
val facets: List<String> = emptyList(),
|
||||
)
|
||||
@@ -15,11 +15,36 @@ import kotlinx.serialization.json.JsonObject
|
||||
* `*.update` frames on `/public/shard/stream` decode into these same DTOs.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Which shard surfaces this caller may reach (`GET /public/shard/features`), plus
|
||||
* the audience rung they resolved to.
|
||||
*
|
||||
* Every shard-derived feature is admin-configurable — it can be switched off or
|
||||
* raised to a higher rung — so the menu cannot be a static list (PLAN.md §5, M11).
|
||||
* [level] is the SERVER's answer on the `anonymous → logged_in → player → staff →
|
||||
* admin` ladder and is authoritative: don't re-derive a rung from the session role,
|
||||
* since `player` means *a linked game account* and staff always satisfy it.
|
||||
*
|
||||
* The response reports only what the caller can see, so the list itself never
|
||||
* discloses a feature they're gated out of.
|
||||
*/
|
||||
@Serializable
|
||||
data class ShardFeaturesDto(
|
||||
val level: String? = null,
|
||||
val features: List<String> = emptyList(),
|
||||
)
|
||||
|
||||
/**
|
||||
* A game actor (player/leader/governor) as embedded in board payloads. Per the wire
|
||||
* spec (`docs/link/INTEGRATION.md` §1), in-game [serial]s are opaque hex-string keys
|
||||
* (e.g. `"0x1A2B"`), never numbers, and [webId] is the linked site-user id as a
|
||||
* string (e.g. `"9931"`) — both are decoded as strings, not parsed.
|
||||
* (e.g. `"0x1A2B"`), never numbers.
|
||||
*
|
||||
* [acct] and [webId] are **locked to the admin rung** by the visibility framework
|
||||
* (`docs/link/v3.md` §3.4 rule 1) — a game account name and a linked site-user id are
|
||||
* not in-game-visible the way a character name is, so they are stripped from every
|
||||
* response below `admin` and no admin setting can loosen that. The fields stay
|
||||
* declared because an admin session does receive them; nothing below one should
|
||||
* expect a value.
|
||||
*/
|
||||
@Serializable
|
||||
data class ActorDto(
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.appearance
|
||||
|
||||
import kotlinx.serialization.SerializationException
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
|
||||
/**
|
||||
* Parse a JSON-valued settings row, client side — the second stage of decoding
|
||||
* `nav_public` (THEMING_AND_NAV.md §3).
|
||||
*
|
||||
* The Kotlin counterpart to the web client's `lib/settingsJson.js`, and
|
||||
* deliberately the same three lines of judgement: `settings.value` is TEXT, so
|
||||
* the row arrives as a **string inside** the already-decoded settings object,
|
||||
* and a malformed or wrong-shaped one must read as **absent** — the surface
|
||||
* falls back to the coded default — never as an error and never as a
|
||||
* half-applied object.
|
||||
*/
|
||||
private val settingsJson = Json { ignoreUnknownKeys = true }
|
||||
|
||||
/**
|
||||
* @param raw the raw stored value, as it arrived in the settings payload
|
||||
* @return the parsed object, or null when absent/malformed
|
||||
*/
|
||||
fun parseJsonSetting(raw: String?): JsonObject? {
|
||||
if (raw.isNullOrEmpty()) return null
|
||||
val parsed = try {
|
||||
settingsJson.parseToJsonElement(raw)
|
||||
} catch (_: SerializationException) {
|
||||
return null
|
||||
}
|
||||
// Only plain objects. A stored `null`, `4`, `"x"` or array is as unusable to
|
||||
// every consumer of these keys as a syntax error is.
|
||||
return parsed as? JsonObject
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.appearance
|
||||
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.JsonPrimitive
|
||||
|
||||
/**
|
||||
* Everything the app renders itself with that the shard's admin controls
|
||||
* (THEMING_AND_NAV.md, M12): the brand block, the resolved theme tokens, and the
|
||||
* public navigation overrides. One value, held once in [com.runicgateway.app.ui.AppViewModel],
|
||||
* so the theme and the drawer can never disagree about which shard they are showing.
|
||||
*
|
||||
* **[NONE] is the shipped app.** An instance with no settings rows, a backend
|
||||
* that predates the feature, and a settings call that failed outright are all the
|
||||
* same state here, and all three must render exactly as the app did before this
|
||||
* milestone existed (§2). That is why nothing on this class is nullable except
|
||||
* [brand], which was already nullable and whose absence already meant "use the
|
||||
* bundled strings".
|
||||
*/
|
||||
data class SiteAppearance(
|
||||
/** The per-shard branding block; null when settings couldn't be loaded. */
|
||||
val brand: BrandDto? = null,
|
||||
/**
|
||||
* The resolved CSS custom properties, keyed by token (`"--accent"` → `"#7f99bd"`).
|
||||
* Empty means "the shipped defaults" — the server never emits an empty map,
|
||||
* but absent and empty are the same thing to the app and it must not depend
|
||||
* on that.
|
||||
*/
|
||||
val theme: Map<String, String> = emptyMap(),
|
||||
/**
|
||||
* The parsed `nav_public` row, or null when the admin never edited the nav.
|
||||
* Kept as the raw object here; reading `items` / `sections` / `links` out of
|
||||
* it is the job of the phases that render them.
|
||||
*/
|
||||
val navPublic: JsonObject? = null,
|
||||
) {
|
||||
companion object {
|
||||
/** The shipped app: no brand, no overrides. Also what a failed load means. */
|
||||
val NONE = SiteAppearance()
|
||||
|
||||
/**
|
||||
* Build the appearance from a `GET /public/settings` body. Forgiving
|
||||
* field by field (§2): a bad `--accent` must not discard a good `--bg`
|
||||
* beside it, and a malformed `nav_public` must not cost the theme.
|
||||
*/
|
||||
fun from(settings: SettingsDto?): SiteAppearance {
|
||||
if (settings == null) return NONE
|
||||
return SiteAppearance(
|
||||
brand = settings.brand,
|
||||
theme = themeTokens(settings.theme as? JsonObject),
|
||||
navPublic = parseJsonSetting(settings.navPublic),
|
||||
)
|
||||
}
|
||||
|
||||
// Every themable token is a string server-side (validated on write, and
|
||||
// resolveThemeTokens only ever copies a validated value). Anything else
|
||||
// is dropped rather than coerced, so an unexpected value costs exactly
|
||||
// its own token and the rest of the palette still applies.
|
||||
private fun themeTokens(raw: JsonObject?): Map<String, String> {
|
||||
if (raw.isNullOrEmpty()) return emptyMap()
|
||||
return buildMap {
|
||||
for ((token, value) in raw) {
|
||||
val text = (value as? JsonPrimitive)?.takeIf { it.isString }?.content
|
||||
if (!text.isNullOrBlank()) put(token, text)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@ package com.runicgateway.app.data.repository
|
||||
import com.runicgateway.app.core.auth.DeviceNameProvider
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.auth.TrustTokenStore
|
||||
import com.runicgateway.app.core.inbox.InboxCache
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.data.api.AuthApi
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
@@ -35,6 +36,7 @@ class AuthRepository @Inject constructor(
|
||||
private val ssoApi: SsoApi,
|
||||
private val sessionManager: SessionManager,
|
||||
private val pushManager: PushManager,
|
||||
private val inboxCache: InboxCache,
|
||||
private val trustTokenStore: TrustTokenStore,
|
||||
private val deviceNameProvider: DeviceNameProvider,
|
||||
private val json: Json,
|
||||
@@ -183,6 +185,18 @@ class AuthRepository @Inject constructor(
|
||||
} catch (_: Exception) {
|
||||
// Ignore — local session teardown proceeds regardless.
|
||||
}
|
||||
// Drop the cached inbox with it: those are one person's notifications, and
|
||||
// they have finished with this device. This is the tidy-up, not the
|
||||
// safeguard — InboxCache scopes every snapshot to (base URL, user id), so
|
||||
// the paths that never reach here (a dead refresh, a server switch) cannot
|
||||
// surface one account's items under another's session either.
|
||||
try {
|
||||
inboxCache.clear()
|
||||
} catch (e: CancellationException) {
|
||||
throw e
|
||||
} catch (_: Exception) {
|
||||
// Ignore — same reason.
|
||||
}
|
||||
val refreshToken = sessionManager.currentRefreshToken()
|
||||
try {
|
||||
authApi.logout(MobileLogoutRequest(refreshToken = refreshToken, all = allDevices))
|
||||
|
||||
@@ -28,6 +28,8 @@ class ConnectionRepository @Inject constructor(
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val sessionManager: SessionManager,
|
||||
private val trustTokenStore: TrustTokenStore,
|
||||
private val shardFeaturesRepository: ShardFeaturesRepository,
|
||||
private val siteCapabilitiesRepository: SiteCapabilitiesRepository,
|
||||
private val pushManager: com.runicgateway.app.core.push.PushManager,
|
||||
private val config: com.runicgateway.app.core.AppConfig,
|
||||
) {
|
||||
@@ -111,6 +113,14 @@ class ConnectionRepository @Inject constructor(
|
||||
// The trust token is bound to the old host — drop it so we don't replay it
|
||||
// against a different shard (it survives a plain logout, but not a host switch).
|
||||
trustTokenStore.clear()
|
||||
// Shard visibility is the OLD host's answer. Sign-out alone would not clear it:
|
||||
// a switch between two signed-out hosts changes no session, so nothing else
|
||||
// invalidates the cache and the new shard would inherit the old one's menu.
|
||||
shardFeaturesRepository.invalidate()
|
||||
// Same argument, one layer up: what the OLD host served says nothing about
|
||||
// the new one, and a stale "this backend has no game module" would hide the
|
||||
// new host's shard rows until its first successful read.
|
||||
siteCapabilitiesRepository.invalidate()
|
||||
prefs.clear()
|
||||
baseUrlHolder.set(null)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
/*
|
||||
* 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.map
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.EventsApi
|
||||
import com.runicgateway.app.data.api.dto.EventCalendarDto
|
||||
import com.runicgateway.app.data.api.dto.EventHistoryEntryDto
|
||||
import com.runicgateway.app.data.api.dto.EventSeriesDto
|
||||
import com.runicgateway.app.data.api.dto.PublicEventDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The event calendar, event pages, arcs and the caller's own participation
|
||||
* history (PLAN.md §6.1, §9 M13).
|
||||
*
|
||||
* The two single-object reads unwrap their envelope here rather than in a view
|
||||
* model, so a screen never holds a `…Response` whose only job was to carry one
|
||||
* field. The calendar and the history keep theirs: `truncated` is a fact about
|
||||
* the answer that the screen renders, and the history's page is a list the pager
|
||||
* appends to.
|
||||
*/
|
||||
@Singleton
|
||||
class EventsRepository @Inject constructor(
|
||||
private val api: EventsApi,
|
||||
) {
|
||||
/** The public calendar. Both ends optional; the server's default window is 31 days. */
|
||||
suspend fun calendar(
|
||||
from: String? = null,
|
||||
to: String? = null,
|
||||
seriesId: Long? = null,
|
||||
): ApiResult<EventCalendarDto> = safeApiCall { api.getCalendar(from, to, seriesId) }
|
||||
|
||||
/**
|
||||
* One event, optionally about one occurrence.
|
||||
*
|
||||
* [run] is passed through untouched — including a run that belongs to some
|
||||
* other event, which the server ignores rather than refusing. Filtering it
|
||||
* here would turn a stale link into a dead end instead of a page about the
|
||||
* thing the link was about.
|
||||
*/
|
||||
suspend fun event(slug: String, run: String? = null): ApiResult<PublicEventDto> =
|
||||
safeApiCall { api.getEvent(slug, run?.takeIf { it.isNotBlank() }) }.map { it.event }
|
||||
|
||||
/** One arc. A series with nothing listed in it answers 404, not an empty page. */
|
||||
suspend fun series(slug: String): ApiResult<EventSeriesDto> =
|
||||
safeApiCall { api.getSeries(slug) }.map { it.series }
|
||||
|
||||
/**
|
||||
* One page of the caller's own participation history, newest first.
|
||||
*
|
||||
* [before] is the id of the last row already shown — a keyset page, not an
|
||||
* offset, because the list gains rows at the top as the reader attends things.
|
||||
*/
|
||||
suspend fun history(limit: Int, before: Long? = null): ApiResult<List<EventHistoryEntryDto>> =
|
||||
safeApiCall { api.getHistory(limit, before) }.map { it.entries }
|
||||
}
|
||||
@@ -6,16 +6,23 @@ 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.NotificationChannelPrefDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsUpdateDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationInboxDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationReadResultDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationSubscriptionsDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationUnreadDto
|
||||
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
|
||||
* Device registration, stream subscriptions, per-channel preferences and the
|
||||
* in-app inbox — the whole `/auth/me` notification surface (PLAN.md §11,
|
||||
* ENGAGEMENT.md phases 3 and 7/8). 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).
|
||||
*/
|
||||
@@ -37,4 +44,33 @@ class NotificationsRepository @Inject constructor(
|
||||
|
||||
suspend fun setSubscriptions(streams: List<String>): ApiResult<NotificationSubscriptionsDto> =
|
||||
safeApiCall { api.putSubscriptions(NotificationSubscriptionsDto(streams)) }
|
||||
|
||||
// ── Per-channel preferences (phase 3) ──────────────────────────────────
|
||||
|
||||
suspend fun channelPrefs(): ApiResult<NotificationChannelPrefsDto> =
|
||||
safeApiCall { api.channelPrefs() }
|
||||
|
||||
/**
|
||||
* Write ONE (id, channel) → mode pair. The endpoint is sparse, so a screen
|
||||
* saving a single toggle sends a single row and cannot disturb the others —
|
||||
* including the ones it does not render.
|
||||
*/
|
||||
suspend fun setChannelMode(id: String, channel: String, mode: String): ApiResult<NotificationChannelPrefsDto> =
|
||||
safeApiCall {
|
||||
api.putChannelPrefs(
|
||||
NotificationChannelPrefsUpdateDto(listOf(NotificationChannelPrefDto(id, channel, mode))),
|
||||
)
|
||||
}
|
||||
|
||||
// ── The inbox (phase 7/8) ──────────────────────────────────────────────
|
||||
|
||||
/** One page, newest first. [before] is the previous page's last id, never an offset. */
|
||||
suspend fun inbox(before: Long? = null, unreadOnly: Boolean = false): ApiResult<NotificationInboxDto> =
|
||||
safeApiCall { api.inbox(before = before, unread = if (unreadOnly) true else null) }
|
||||
|
||||
suspend fun unreadCount(): ApiResult<NotificationUnreadDto> = safeApiCall { api.unreadCount() }
|
||||
|
||||
suspend fun markRead(id: Long): ApiResult<NotificationReadResultDto> = safeApiCall { api.markRead(id) }
|
||||
|
||||
suspend fun markAllRead(): ApiResult<NotificationReadResultDto> = safeApiCall { api.markAllRead() }
|
||||
}
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
* 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.map
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.RustApi
|
||||
import com.runicgateway.app.data.api.dto.RustEventDto
|
||||
import com.runicgateway.app.data.api.dto.RustLeaderboardRowDto
|
||||
import com.runicgateway.app.data.api.dto.RustPresenceDto
|
||||
import com.runicgateway.app.data.api.dto.RustServerDto
|
||||
import com.runicgateway.app.data.api.dto.RustWipeDto
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* The Rust module's public read path (PLAN.md §9 M14).
|
||||
*
|
||||
* Every read unwraps its envelope here rather than in a view model, so no screen
|
||||
* holds a `…Dto` whose only job was to carry one list. Nothing is cached and
|
||||
* nothing is merged: the module's tables are already the cache — the site's whole
|
||||
* premise is that it answers from what a server last said rather than from the
|
||||
* server — so a second copy in the app would only add a way for the two to
|
||||
* disagree.
|
||||
*/
|
||||
@Singleton
|
||||
class RustRepository @Inject constructor(
|
||||
private val api: RustApi,
|
||||
) {
|
||||
/** Every server this site follows, with what each last reported. */
|
||||
suspend fun servers(): ApiResult<List<RustServerDto>> =
|
||||
safeApiCall { api.getServers() }.map { it.servers }
|
||||
|
||||
/** One server. A 404 here means no such server, or one an operator disabled. */
|
||||
suspend fun server(id: String): ApiResult<RustServerDto> =
|
||||
safeApiCall { api.getServer(id) }.map { it.server }
|
||||
|
||||
/**
|
||||
* The feed.
|
||||
*
|
||||
* [kinds] is joined here rather than by a caller, so the query string this
|
||||
* app sends exists in one place — and an **empty** list is sent as no `kind`
|
||||
* parameter at all, which asks for the whole allowlist. Sending `kind=` would
|
||||
* ask for a kind named the empty string.
|
||||
*/
|
||||
suspend fun events(
|
||||
id: String,
|
||||
kinds: List<String> = emptyList(),
|
||||
wipe: String? = null,
|
||||
limit: Int? = null,
|
||||
): ApiResult<List<RustEventDto>> = safeApiCall {
|
||||
api.getEvents(
|
||||
id = id,
|
||||
kind = kinds.takeIf { it.isNotEmpty() }?.joinToString(","),
|
||||
wipe = wipe?.takeIf { it.isNotBlank() },
|
||||
limit = limit,
|
||||
)
|
||||
}.map { it.events }
|
||||
|
||||
/** The leaderboard: per wipe when [wipe] is given, all-time otherwise. */
|
||||
suspend fun leaderboard(
|
||||
id: String,
|
||||
wipe: String? = null,
|
||||
sort: String? = null,
|
||||
limit: Int? = null,
|
||||
): ApiResult<List<RustLeaderboardRowDto>> = safeApiCall {
|
||||
api.getLeaderboard(
|
||||
id = id,
|
||||
wipe = wipe?.takeIf { it.isNotBlank() },
|
||||
sort = sort?.takeIf { it.isNotBlank() },
|
||||
limit = limit,
|
||||
)
|
||||
}.map { it.leaderboard }
|
||||
|
||||
/** Every wipe this server has had, newest first. */
|
||||
suspend fun wipes(id: String): ApiResult<List<RustWipeDto>> =
|
||||
safeApiCall { api.getWipes(id) }.map { it.wipes }
|
||||
|
||||
/** The presence board. Rows survive an unreachable server, by design. */
|
||||
suspend fun online(id: String): ApiResult<List<RustPresenceDto>> =
|
||||
safeApiCall { api.getOnline(id) }.map { it.players }
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.sync.Mutex
|
||||
import kotlinx.coroutines.sync.withLock
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Which shard surfaces the current viewer may reach, from
|
||||
* `GET /public/shard/features` (PLAN.md §5, §9 M11).
|
||||
*
|
||||
* Every shard-derived feature is admin-configurable — it can be switched off, or its
|
||||
* audience raised above the caller's rung — so shard navigation can no longer be a
|
||||
* static list gated on the session role alone. [level] is the server's own answer on
|
||||
* the `anonymous → logged_in → player → staff → admin` ladder; the app does not
|
||||
* re-derive it.
|
||||
*
|
||||
* **This is presentation only.** The gate is server-side: a disabled feature `404`s
|
||||
* and an out-of-rung one `403`s whether or not the entry was rendered. That is why an
|
||||
* unknown answer deliberately **fails open** — see [ShardFeatures] and [canSee].
|
||||
*/
|
||||
@Singleton
|
||||
class ShardFeaturesRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
private val _features = MutableStateFlow<ShardFeatures?>(null)
|
||||
|
||||
/** The current answer, or `null` while it is unknown (in flight, or the lookup failed). */
|
||||
val features: StateFlow<ShardFeatures?> = _features.asStateFlow()
|
||||
|
||||
// Serializes concurrent refreshes: the shell refreshes on every session change,
|
||||
// and two overlapping loads would race to publish.
|
||||
private val mutex = Mutex()
|
||||
|
||||
/**
|
||||
* Re-resolve the visible set. Called on every session change (sign-in, sign-out,
|
||||
* a role revalidation that actually changed the user), because the answer is
|
||||
* per-viewer.
|
||||
*
|
||||
* A failed lookup clears the cache rather than keeping a stale one: falling back
|
||||
* to "show everything" is the safe direction here, since the server still gates
|
||||
* every call.
|
||||
*/
|
||||
suspend fun refresh() = mutex.withLock {
|
||||
_features.value = when (val result = safeApiCall { api.getShardFeatures() }) {
|
||||
is ApiResult.Ok -> ShardFeatures(
|
||||
level = result.data.level,
|
||||
visible = result.data.features.toSet(),
|
||||
)
|
||||
// Includes the 404 an older, pre-Protocol-3.0 website returns for this
|
||||
// route — that site has no visibility framework, so "unknown" is exactly
|
||||
// the right answer and the menu behaves as it did before M11.
|
||||
else -> null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Drop the cached answer. Called on a Settings → Server switch: the features
|
||||
* belong to the host that reported them, and a switch between two signed-out
|
||||
* hosts changes no session, so nothing else would invalidate them.
|
||||
*/
|
||||
fun invalidate() {
|
||||
_features.value = null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The resolved visibility answer for one viewer: the rung the server placed them on
|
||||
* and the shard features they may reach.
|
||||
*/
|
||||
data class ShardFeatures(
|
||||
val level: String?,
|
||||
val visible: Set<String>,
|
||||
)
|
||||
|
||||
/**
|
||||
* True when [feature] may be shown — **or when the answer isn't known yet**.
|
||||
*
|
||||
* The fail-open default is deliberate and matches the web client (`lib/useShardFeatures.js`):
|
||||
* the server gates every call regardless, so the cost of guessing wrong is a link that
|
||||
* briefly `403`s, while the cost of guessing the other way is a navigation drawer that
|
||||
* flickers its entries in on every cold start.
|
||||
*/
|
||||
fun canSee(features: ShardFeatures?, feature: String): Boolean =
|
||||
features == null || feature in features.visible
|
||||
|
||||
/** Feature names as the website's `shardVisibility.js` `FEATURES` map spells them. */
|
||||
object ShardFeature {
|
||||
const val STATUS = "status"
|
||||
const val ACTIVITY = "activity"
|
||||
const val CHAMPS = "champs"
|
||||
const val GUILDS = "guilds"
|
||||
const val GOVERNORS = "governors"
|
||||
const val HOUSES = "houses"
|
||||
const val PRESENCE = "presence"
|
||||
|
||||
// Added by Protocol 3.0.
|
||||
const val RULESET = "ruleset"
|
||||
const val ATLAS = "atlas"
|
||||
const val LEADERBOARDS = "leaderboards"
|
||||
const val MARKET = "market"
|
||||
}
|
||||
@@ -3,11 +3,13 @@
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.net.ShardStreamClient
|
||||
import com.runicgateway.app.core.net.ShardStream
|
||||
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.AtlasCreatureDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasCreaturePageDto
|
||||
import com.runicgateway.app.data.api.dto.ChampDto
|
||||
import com.runicgateway.app.data.api.dto.EconomySampleDto
|
||||
import com.runicgateway.app.data.api.dto.FeedEventDto
|
||||
@@ -15,8 +17,13 @@ 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.MarketMetaDto
|
||||
import com.runicgateway.app.data.api.dto.MarketPageDto
|
||||
import com.runicgateway.app.data.api.dto.MarketVendorDto
|
||||
import com.runicgateway.app.data.api.dto.OnlineStaffDto
|
||||
import com.runicgateway.app.data.api.dto.PointsBoardDto
|
||||
import com.runicgateway.app.data.api.dto.PresenceDto
|
||||
import com.runicgateway.app.data.api.dto.RulesetDto
|
||||
import com.runicgateway.app.data.api.dto.ShardStatusDto
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.serialization.KSerializer
|
||||
@@ -35,7 +42,7 @@ import javax.inject.Singleton
|
||||
@Singleton
|
||||
class ShardRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
private val stream: ShardStreamClient,
|
||||
private val stream: ShardStream,
|
||||
private val json: Json,
|
||||
) {
|
||||
// ── Snapshots ────────────────────────────────────────────────────────
|
||||
@@ -62,6 +69,59 @@ class ShardRepository @Inject constructor(
|
||||
|
||||
suspend fun houses(): ApiResult<List<HouseDto>> = safeApiCall { api.getShardHouses() }
|
||||
|
||||
// ── Protocol 3.0 shard content (§9 M11) ──────────────────────────────
|
||||
//
|
||||
// All four sit behind `requireFeature`, so a 404/403 here is "this shard doesn't
|
||||
// publish it" rather than a fault — see `toShardUiState()`.
|
||||
|
||||
/** The shard ruleset, or `Ok(null)` when the shard has never published one. */
|
||||
suspend fun ruleset(): ApiResult<RulesetDto?> = safeApiCall { api.getShardRuleset() }
|
||||
|
||||
suspend fun pointsBoards(): ApiResult<List<PointsBoardDto>> = safeApiCall { api.getShardPoints() }
|
||||
|
||||
suspend fun pointsBoard(system: String): ApiResult<PointsBoardDto> =
|
||||
safeApiCall { api.getShardPointsBoard(system) }
|
||||
|
||||
suspend fun market(
|
||||
query: String? = null,
|
||||
map: String? = null,
|
||||
region: String? = null,
|
||||
sort: String = SORT_PRICE_ASC,
|
||||
limit: Int = MARKET_PAGE,
|
||||
offset: Int = 0,
|
||||
): ApiResult<MarketPageDto> = safeApiCall {
|
||||
api.getShardMarket(
|
||||
query = query?.takeIf { it.isNotBlank() },
|
||||
map = map?.takeIf { it.isNotBlank() },
|
||||
region = region?.takeIf { it.isNotBlank() },
|
||||
sort = sort,
|
||||
limit = limit,
|
||||
offset = offset,
|
||||
)
|
||||
}
|
||||
|
||||
suspend fun marketMeta(): ApiResult<MarketMetaDto> = safeApiCall { api.getShardMarketMeta() }
|
||||
|
||||
suspend fun marketVendor(serial: String): ApiResult<MarketVendorDto> =
|
||||
safeApiCall { api.getShardMarketVendor(serial) }
|
||||
|
||||
suspend fun atlasCreatures(
|
||||
query: String? = null,
|
||||
facet: String? = null,
|
||||
limit: Int = ATLAS_PAGE,
|
||||
offset: Int = 0,
|
||||
): ApiResult<AtlasCreaturePageDto> = safeApiCall {
|
||||
api.getAtlasCreatures(
|
||||
query = query?.takeIf { it.isNotBlank() },
|
||||
facet = facet?.takeIf { it.isNotBlank() },
|
||||
limit = limit,
|
||||
offset = offset,
|
||||
)
|
||||
}
|
||||
|
||||
suspend fun atlasCreature(slug: String): ApiResult<AtlasCreatureDto> =
|
||||
safeApiCall { api.getAtlasCreature(slug) }
|
||||
|
||||
// ── Live stream ──────────────────────────────────────────────────────
|
||||
/** The shared public SSE feed (safe kinds only), reconnecting with backoff (§7). */
|
||||
fun liveEvents(): Flow<ShardStreamEvent> = stream.events()
|
||||
@@ -73,9 +133,27 @@ class ShardRepository @Inject constructor(
|
||||
fun governorFrame(obj: JsonObject): GovernorDto? = decode(obj, GovernorDto.serializer())
|
||||
fun presenceFrame(obj: JsonObject): PresenceDto? = decode(obj, PresenceDto.serializer())
|
||||
|
||||
// Protocol 3.0 frames. `world.ruleset` and `points.board` ride the public stream by
|
||||
// default; `vendor.listing` does NOT — the market feature ships with its SSE fan-out
|
||||
// disabled (a live firehose of vendor inventories would be the site's biggest
|
||||
// bandwidth consumer), so the market screen is a plain paginated read and must never
|
||||
// wait on a frame.
|
||||
fun rulesetFrame(obj: JsonObject): RulesetDto? = decode(obj, RulesetDto.serializer())
|
||||
fun pointsBoardFrame(obj: JsonObject): PointsBoardDto? = decode(obj, PointsBoardDto.serializer())
|
||||
|
||||
private fun <T> decode(obj: JsonObject, serializer: KSerializer<T>): T? = try {
|
||||
json.decodeFromJsonElement(serializer, obj)
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
|
||||
companion object {
|
||||
const val SORT_PRICE_ASC = "price_asc"
|
||||
const val SORT_PRICE_DESC = "price_desc"
|
||||
const val SORT_RECENT = "recent"
|
||||
|
||||
/** The server caps `limit` at 100; stay well under it on a phone. */
|
||||
const val MARKET_PAGE = 50
|
||||
const val ATLAS_PAGE = 50
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,182 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.data.repository
|
||||
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.safeApiCall
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.sync.Mutex
|
||||
import kotlinx.coroutines.sync.withLock
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* What this BACKEND serves — core's own capabilities and every started module's
|
||||
* (PLAN.md §5, §9 M13; `docs/website/MODULE_API.md` §2.9).
|
||||
*
|
||||
* ## Why this exists at all, and why it is not [ShardFeaturesRepository]
|
||||
*
|
||||
* The two answer different questions and neither can answer the other's:
|
||||
*
|
||||
* - **Capability — is this module installed at all?** Per HOST. It changes when
|
||||
* an operator installs or removes a module, so it is resolved beside the
|
||||
* appearance and invalidated on a server switch.
|
||||
* - **Feature — does this shard publish this surface to this viewer?** Per
|
||||
* VIEWER. It changes on sign-in, which is why it is resolved on every session
|
||||
* change.
|
||||
*
|
||||
* Without the first, the app cannot tell a module that is **not installed** from
|
||||
* a lookup that failed: `GET /public/shard/features` 404s in both cases, and
|
||||
* [ShardFeaturesRepository] maps every failure to "unknown", which [canSee]
|
||||
* treats as visible. On a site running a different game that renders every shard
|
||||
* row in the drawer and every one of them 404s when tapped.
|
||||
*
|
||||
* ## Absence of an answer is not an answer of absence
|
||||
*
|
||||
* The distinction this class exists to make, and the reason [SiteCapabilities]
|
||||
* carries no "unknown" member of its own — the *absence of the whole value* is
|
||||
* the unknown state:
|
||||
*
|
||||
* - a **successful** read that does not name a capability is an answer, and
|
||||
* [canUse] hides what needs it;
|
||||
* - a **failed** read keeps the last answer this host gave, because a moment
|
||||
* with no connectivity is not an uninstall;
|
||||
* - a host that has **never** answered leaves the value null, and [canUse]
|
||||
* passes — the drawer renders as it did before this existed rather than
|
||||
* flickering its rows in on every cold start.
|
||||
*
|
||||
* The last one is deliberately the same fail-open direction [canSee] takes, for
|
||||
* the same reason: the server gates every call regardless, so the cost of
|
||||
* guessing wrong is a link that briefly 404s.
|
||||
*/
|
||||
@Singleton
|
||||
class SiteCapabilitiesRepository @Inject constructor(
|
||||
private val api: PublicApi,
|
||||
) {
|
||||
private val _capabilities = MutableStateFlow<SiteCapabilities?>(null)
|
||||
|
||||
/** The current answer, or `null` while this host has never given one. */
|
||||
val capabilities: StateFlow<SiteCapabilities?> = _capabilities.asStateFlow()
|
||||
|
||||
// Serializes concurrent refreshes: the shell refreshes on resume and the
|
||||
// connect flow refreshes on first load, and two overlapping reads would race
|
||||
// to publish.
|
||||
private val mutex = Mutex()
|
||||
|
||||
/**
|
||||
* Re-resolve what this backend serves.
|
||||
*
|
||||
* **Two calls, and one failing is not the same as both failing.** Core's list
|
||||
* and a module's are separate lists (§2.9), so they are merged from separate
|
||||
* reads and each is kept only if it answered. A backend released before
|
||||
* events omits `capabilities` from its `version` block entirely, which is an
|
||||
* answer — the empty list — and not a failure.
|
||||
*/
|
||||
suspend fun refresh() = mutex.withLock {
|
||||
val status = safeApiCall { api.getStatus() }
|
||||
val modules = safeApiCall { api.getModules() }
|
||||
|
||||
// Neither call answered: keep whatever this host said last, which for a
|
||||
// host that has never answered is still null.
|
||||
if (status !is ApiResult.Ok && modules !is ApiResult.Ok) return@withLock
|
||||
|
||||
val previous = _capabilities.value
|
||||
val core = (status as? ApiResult.Ok)?.data?.version?.capabilities?.toSet()
|
||||
?: previous?.core
|
||||
?: emptySet()
|
||||
val installed = (modules as? ApiResult.Ok)?.data?.modules
|
||||
?.flatMap { it.capabilities }
|
||||
?.toSet()
|
||||
?: previous?.modules
|
||||
?: emptySet()
|
||||
|
||||
_capabilities.value = SiteCapabilities(core = core, modules = installed)
|
||||
}
|
||||
|
||||
/**
|
||||
* Drop the answer. Called on a Settings → Server switch: capabilities belong
|
||||
* to the host that reported them, and the new host must not inherit them —
|
||||
* a switch between two signed-out hosts changes no session, so nothing else
|
||||
* would invalidate this.
|
||||
*/
|
||||
fun invalidate() {
|
||||
_capabilities.value = null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* What one backend serves, as two lists rather than one.
|
||||
*
|
||||
* They are kept apart because core is not a module: merging them would leave the
|
||||
* app unable to tell *"this backend has events"* from *"a module called core
|
||||
* happens to be installed"*, which is exactly the distinction
|
||||
* `GET /public/modules` exists to make. [canUse] looks in both, because a menu
|
||||
* entry does not care which half serves it — but the halves stay separable, so a
|
||||
* future caller that does care still can.
|
||||
*/
|
||||
data class SiteCapabilities(
|
||||
/** Core's own, from the `version` block. Empty on a backend that predates them. */
|
||||
val core: Set<String>,
|
||||
/** Every started module's, flattened. Two modules may declare the same string. */
|
||||
val modules: Set<String>,
|
||||
) {
|
||||
/** True when either half names [capability]. */
|
||||
operator fun contains(capability: String): Boolean =
|
||||
capability in core || capability in modules
|
||||
}
|
||||
|
||||
/**
|
||||
* True when [capability] may be relied on — **or when this host has not answered
|
||||
* yet**.
|
||||
*
|
||||
* The null case is the fail-open one and it is not the same as the empty one: a
|
||||
* [SiteCapabilities] that names nothing is a backend that told us it serves
|
||||
* nothing extra, and that hides. See the class doc above.
|
||||
*
|
||||
* `null` [capability] means the caller declared none, which always passes.
|
||||
*/
|
||||
fun canUse(capabilities: SiteCapabilities?, capability: String?): Boolean =
|
||||
capability == null || capabilities == null || capability in capabilities
|
||||
|
||||
/**
|
||||
* The capability strings the app gates on.
|
||||
*
|
||||
* **Deliberately few.** `module-uo` declares eight, and gating each shard row on
|
||||
* its own would be a second, worse copy of what the per-viewer feature flags
|
||||
* already decide — and one that drifts, because a capability is opaque to core
|
||||
* and nothing checks the two agree. One string answers the only question a
|
||||
* capability can: is the module there.
|
||||
*/
|
||||
object Capability {
|
||||
/**
|
||||
* A game module serving a live shard. Declared by `module-uo`; a different
|
||||
* game's module that serves the same surfaces would declare it too, which is
|
||||
* the point of an opaque string.
|
||||
*/
|
||||
const val SHARD = "shard"
|
||||
|
||||
/**
|
||||
* The Rust module (`docs/modules/rust/PLAN.md` D16, phase 5).
|
||||
*
|
||||
* A second game module, and therefore a second string rather than a second
|
||||
* meaning for [SHARD]: a Rust site is a **fleet of servers** with a list
|
||||
* above them, where a shard is one place — the surfaces are not the same
|
||||
* shape and a client cannot render one as the other.
|
||||
*
|
||||
* `module-rust` also declares `servers`, `killfeed`, `leaderboard`,
|
||||
* `presence` and `wipes`, and this gates on none of them. Every one of those
|
||||
* names a SURFACE, and core flattens all modules' capabilities into one list
|
||||
* — so `servers` is a word another module could declare tomorrow, which would
|
||||
* silently reveal these rows on a site that does not run Rust. `rust` is the
|
||||
* string only that module can mean, which is the same job [SHARD] does for
|
||||
* `module-uo`.
|
||||
*/
|
||||
const val RUST = "rust"
|
||||
|
||||
/** Core's event system (events Phase 14a). Never a module's. */
|
||||
const val EVENTS = "events"
|
||||
}
|
||||
@@ -9,15 +9,19 @@ 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.ShardStream
|
||||
import com.runicgateway.app.core.net.ShardStreamClient
|
||||
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.EventsApi
|
||||
import com.runicgateway.app.data.api.MeApi
|
||||
import com.runicgateway.app.data.api.AdminApi
|
||||
import com.runicgateway.app.data.api.NotificationsApi
|
||||
import com.runicgateway.app.data.api.PlayerShardApi
|
||||
import com.runicgateway.app.data.api.PublicApi
|
||||
import com.runicgateway.app.data.api.RustApi
|
||||
import com.runicgateway.app.data.api.SsoApi
|
||||
import dagger.Module
|
||||
import dagger.Provides
|
||||
@@ -94,6 +98,12 @@ object NetworkModule {
|
||||
@Singleton
|
||||
fun providePublicApi(retrofit: Retrofit): PublicApi = retrofit.create(PublicApi::class.java)
|
||||
|
||||
/** Expose the live SSE feed as the [ShardStream] capability so repositories depend
|
||||
* on the interface (unit-testable against a fake), not the OkHttp-backed client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideShardStream(client: ShardStreamClient): ShardStream = client
|
||||
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideAuthApi(retrofit: Retrofit): AuthApi = retrofit.create(AuthApi::class.java)
|
||||
@@ -114,6 +124,28 @@ object NetworkModule {
|
||||
fun providePlayerShardApi(retrofit: Retrofit): PlayerShardApi =
|
||||
retrofit.create(PlayerShardApi::class.java)
|
||||
|
||||
/**
|
||||
* The event surface (§9 M13). Three public reads and one bearer-authed player
|
||||
* read on one interface — they are all CORE routes, so none of them is a
|
||||
* module path and none is under `/shard`.
|
||||
*/
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideEventsApi(retrofit: Retrofit): EventsApi = retrofit.create(EventsApi::class.java)
|
||||
|
||||
/**
|
||||
* `module-rust`'s public read path (§9 M14).
|
||||
*
|
||||
* A MODULE's routes, unlike [provideEventsApi] beside it — they exist only on
|
||||
* a backend where an operator installed the Rust module, and the drawer rows
|
||||
* that lead to them are gated on its `rust` capability. Provided
|
||||
* unconditionally all the same: a Retrofit interface costs nothing until
|
||||
* something calls it, and there is nowhere at injection time to ask.
|
||||
*/
|
||||
@Provides
|
||||
@Singleton
|
||||
fun provideRustApi(retrofit: Retrofit): RustApi = retrofit.create(RustApi::class.java)
|
||||
|
||||
/** Opt-in push devices + subscriptions (§11, M7) — bearer-authed on the main client. */
|
||||
@Provides
|
||||
@Singleton
|
||||
|
||||
@@ -11,13 +11,16 @@ import com.runicgateway.app.core.auth.TokenStore
|
||||
import com.runicgateway.app.core.auth.TrustTokenStore
|
||||
import com.runicgateway.app.core.auth.sso.EncryptedPendingSsoStore
|
||||
import com.runicgateway.app.core.auth.sso.PendingSsoStore
|
||||
import com.runicgateway.app.core.inbox.DataStoreInboxCache
|
||||
import com.runicgateway.app.core.inbox.InboxCache
|
||||
import dagger.Binds
|
||||
import dagger.Module
|
||||
import dagger.hilt.InstallIn
|
||||
import dagger.hilt.components.SingletonComponent
|
||||
import javax.inject.Singleton
|
||||
|
||||
/** Binds the at-rest stores to their EncryptedSharedPreferences impls (§4.3). */
|
||||
/** Binds the at-rest stores to their implementations — EncryptedSharedPreferences
|
||||
* for anything secret (§4.3), plain DataStore for the inbox snapshot. */
|
||||
@Module
|
||||
@InstallIn(SingletonComponent::class)
|
||||
abstract class StorageModule {
|
||||
@@ -38,4 +41,9 @@ abstract class StorageModule {
|
||||
@Binds
|
||||
@Singleton
|
||||
abstract fun bindDeviceNameProvider(impl: BuildDeviceNameProvider): DeviceNameProvider
|
||||
|
||||
/** The inbox's offline snapshot — plain DataStore, not encrypted (ENGAGEMENT.md phase 8). */
|
||||
@Binds
|
||||
@Singleton
|
||||
abstract fun bindInboxCache(impl: DataStoreInboxCache): InboxCache
|
||||
}
|
||||
|
||||
@@ -8,9 +8,10 @@ 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.appearance.SiteAppearance
|
||||
import com.runicgateway.app.data.repository.ConnectionRepository
|
||||
import com.runicgateway.app.data.repository.SettingsRepository
|
||||
import com.runicgateway.app.data.repository.SiteCapabilitiesRepository
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
@@ -20,8 +21,8 @@ import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Top-level app gate (PLAN.md §3): decides whether the first-run connect screen
|
||||
* or the main UI shows, and holds the per-shard branding the theme is seeded
|
||||
* from. Activity-scoped so the whole app observes one state.
|
||||
* or the main UI shows, and holds the per-shard [SiteAppearance] the theme and
|
||||
* the drawer are built from. Activity-scoped so the whole app observes one state.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AppViewModel @Inject constructor(
|
||||
@@ -29,6 +30,7 @@ class AppViewModel @Inject constructor(
|
||||
private val settingsRepository: SettingsRepository,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
private val pushManager: PushManager,
|
||||
private val siteCapabilitiesRepository: SiteCapabilitiesRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
sealed interface AppState {
|
||||
@@ -38,8 +40,11 @@ class AppViewModel @Inject constructor(
|
||||
/** No shard site configured yet — show the connect screen. */
|
||||
data object NeedsConnection : AppState
|
||||
|
||||
/** A site is configured; [brand] is null if branding couldn't be loaded (still usable). */
|
||||
data class Ready(val brand: BrandDto?) : AppState
|
||||
/**
|
||||
* A site is configured. [appearance] is [SiteAppearance.NONE] when settings
|
||||
* couldn't be loaded — the shipped app, still fully usable (§2).
|
||||
*/
|
||||
data class Ready(val appearance: SiteAppearance) : AppState
|
||||
}
|
||||
|
||||
private val _state = MutableStateFlow<AppState>(AppState.Loading)
|
||||
@@ -48,7 +53,7 @@ class AppViewModel @Inject constructor(
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
_state.value = if (connectionRepository.restore()) {
|
||||
AppState.Ready(loadBrand())
|
||||
AppState.Ready(loadAppearance())
|
||||
} else {
|
||||
AppState.NeedsConnection
|
||||
}
|
||||
@@ -57,7 +62,36 @@ class AppViewModel @Inject constructor(
|
||||
|
||||
/** Called by the connect screen once a site has been validated + saved. */
|
||||
fun onConnected() {
|
||||
viewModelScope.launch { _state.value = AppState.Ready(loadBrand()) }
|
||||
viewModelScope.launch { _state.value = AppState.Ready(loadAppearance()) }
|
||||
}
|
||||
|
||||
/**
|
||||
* Re-read the appearance while the app is already running — on resume, beside
|
||||
* the session's own re-validation (§5.5). An admin who re-skins the site from
|
||||
* a laptop and picks the phone up should see it.
|
||||
*
|
||||
* Best-effort, and silent either way: a failed refresh **keeps the last good
|
||||
* appearance** rather than dropping back to the shipped one, so a moment of
|
||||
* no connectivity does not repaint a themed shard. There is no loading state
|
||||
* and no error surface. Ignored unless a site is configured.
|
||||
*/
|
||||
fun refreshAppearance() {
|
||||
if (_state.value !is AppState.Ready) return
|
||||
viewModelScope.launch {
|
||||
// What the backend SERVES is a per-host fact and refreshes on the same
|
||||
// clock as the appearance: an operator who installs a module while the
|
||||
// app is backgrounded should see its rows on the next resume. Done
|
||||
// before the early return below, because a failed settings read is no
|
||||
// reason to skip it — they are separate calls to separate routes.
|
||||
siteCapabilitiesRepository.refresh()
|
||||
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data ?: return@launch
|
||||
pushManager.setNtfyUrl(settings.push.ntfyUrl)
|
||||
// changeServer() may have raced us back to the connect screen while the
|
||||
// call was in flight; don't resurrect Ready on top of it.
|
||||
if (_state.value is AppState.Ready) {
|
||||
_state.value = AppState.Ready(SiteAppearance.from(settings))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Settings → Server switch: hard reset back to the connect screen (§3). */
|
||||
@@ -69,14 +103,15 @@ class AppViewModel @Inject constructor(
|
||||
}
|
||||
|
||||
/**
|
||||
* Load public settings for branding and feed the shard's push relay URL into the
|
||||
* [PushManager] (§11) — its arrival is what lets push re-register after a restart
|
||||
* or sign-in. Returns the brand block (null if settings couldn't be loaded).
|
||||
* Load public settings for the appearance 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 [SiteAppearance.NONE] if settings couldn't be loaded.
|
||||
*/
|
||||
private suspend fun loadBrand(): BrandDto? {
|
||||
private suspend fun loadAppearance(): SiteAppearance {
|
||||
siteCapabilitiesRepository.refresh()
|
||||
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data
|
||||
pushManager.setNtfyUrl(settings?.push?.ntfyUrl)
|
||||
return settings?.brand
|
||||
return SiteAppearance.from(settings)
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
110
app/src/main/java/com/runicgateway/app/ui/Polling.kt
Normal file
110
app/src/main/java/com/runicgateway/app/ui/Polling.kt
Normal file
@@ -0,0 +1,110 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui
|
||||
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.rememberUpdatedState
|
||||
import androidx.lifecycle.Lifecycle
|
||||
import androidx.lifecycle.compose.LocalLifecycleOwner
|
||||
import androidx.lifecycle.repeatOnLifecycle
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import kotlinx.coroutines.delay
|
||||
|
||||
/**
|
||||
* Repeated reads of a surface that changes while somebody is looking at it
|
||||
* (`docs/modules/rust/PLAN.md` D14, and D17 for this leg).
|
||||
*
|
||||
* ## Why a refresh is not a load
|
||||
*
|
||||
* The app has had exactly one shape for a read until now: set [UiState.Loading],
|
||||
* ask, replace. That is right for opening a screen and wrong for a poll — a
|
||||
* twenty-second refresh built on it would clear the killfeed, put a spinner where
|
||||
* it was and re-fill it, three times a minute, for ever. The website hit the same
|
||||
* wall one tier along: core's `useAsync` blanks its data on every dependency
|
||||
* change, so `module-rust` bundles its own `usePolled`. This is that hook's other
|
||||
* half.
|
||||
*
|
||||
* The rule both ends keep: **a refresh is invisible when it succeeds, and keeps
|
||||
* the rows when it fails.** A site whose whole premise is "it renders while the
|
||||
* game is off" must not blank itself the first time a request does.
|
||||
*/
|
||||
|
||||
/** How often a live surface re-reads itself while somebody is looking at it (D17). */
|
||||
const val POLL_INTERVAL_MS = 20_000L
|
||||
|
||||
/**
|
||||
* What a poll produced: the state to render, and whether the last attempt failed.
|
||||
*
|
||||
* Two fields rather than a wider [UiState] because they are two facts and a
|
||||
* screen renders them in different places — the rows in the list, the failure as
|
||||
* a quiet line above it. Collapsing them would force the choice this exists to
|
||||
* avoid: show the error and lose the rows, or keep the rows and say nothing.
|
||||
*/
|
||||
data class Polled<out T>(
|
||||
val state: UiState<T> = UiState.Loading,
|
||||
/** True when the most recent refresh failed **and there were rows to keep**. */
|
||||
val refreshFailed: Boolean = false,
|
||||
)
|
||||
|
||||
/**
|
||||
* Fold a refresh into what is already on screen.
|
||||
*
|
||||
* Three cases, and the middle one is the whole point:
|
||||
*
|
||||
* - **It answered.** The new data replaces the old and any previous failure
|
||||
* clears. This is the ordinary path and it is silent.
|
||||
* - **It failed, and there are rows.** The rows stay exactly as they are and the
|
||||
* failure is reported beside them. Nothing is blanked and nothing is retried
|
||||
* on the reader's behalf — the next tick is twenty seconds away.
|
||||
* - **It failed, and there is nothing yet.** There is nothing to protect, so it
|
||||
* becomes an ordinary error with a retry — which is what the first load
|
||||
* failing means.
|
||||
*
|
||||
* Pure, and takes the current state rather than reading one, so the rule is
|
||||
* tested without a dispatcher, a view model or Compose.
|
||||
*/
|
||||
fun <T> refreshInto(current: UiState<T>, result: ApiResult<T>): Polled<T> = when {
|
||||
result is ApiResult.Ok -> Polled(UiState.Success(result.data), refreshFailed = false)
|
||||
current is UiState.Success -> Polled(current, refreshFailed = true)
|
||||
else -> Polled(result.toUiState(), refreshFailed = false)
|
||||
}
|
||||
|
||||
/**
|
||||
* Run [block] now and every [intervalMs] for as long as this screen is resumed.
|
||||
*
|
||||
* `repeatOnLifecycle` is what makes this the phone's version of D14's Page
|
||||
* Visibility gate, and it gets three behaviours from one line:
|
||||
*
|
||||
* - **Nothing runs while the app is away.** The coroutine is cancelled at
|
||||
* `onPause`, so a backgrounded app makes no requests at all — not a slower
|
||||
* poll, none.
|
||||
* - **Coming back refreshes immediately.** The block is restarted from the top
|
||||
* at `onResume`, which calls [block] before the first [delay] — so the first
|
||||
* thing a returning reader sees is current, not up to twenty seconds old.
|
||||
* - **A dialog or the recents switcher pauses it**, because that is what RESUMED
|
||||
* means. The alternative, STARTED, keeps polling behind a partially
|
||||
* obscured screen, which is precisely the reader who is not reading.
|
||||
*
|
||||
* **Keyed on the lifecycle owner alone, and [block] is held through
|
||||
* `rememberUpdatedState`.** Keying on the block would restart the loop on every
|
||||
* recomposition, because a lambda is a new object each time; capturing it without
|
||||
* `rememberUpdatedState` would freeze the *first* one, so a tab change or a
|
||||
* newly chosen wipe would keep refreshing the question the reader has stopped
|
||||
* asking. The loop is stable and what it calls is current.
|
||||
*/
|
||||
@Composable
|
||||
fun PollWhileResumed(intervalMs: Long = POLL_INTERVAL_MS, block: suspend () -> Unit) {
|
||||
val lifecycleOwner = LocalLifecycleOwner.current
|
||||
val current by rememberUpdatedState(block)
|
||||
LaunchedEffect(lifecycleOwner) {
|
||||
lifecycleOwner.lifecycle.repeatOnLifecycle(Lifecycle.State.RESUMED) {
|
||||
while (true) {
|
||||
current()
|
||||
delay(intervalMs)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -7,10 +7,12 @@ import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.size
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.automirrored.filled.ExitToApp
|
||||
import androidx.compose.material.icons.filled.Menu
|
||||
import androidx.compose.material3.DrawerValue
|
||||
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||
@@ -21,6 +23,7 @@ import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ModalDrawerSheet
|
||||
import androidx.compose.material3.ModalNavigationDrawer
|
||||
import androidx.compose.material3.NavigationDrawerItem
|
||||
import androidx.compose.material3.NavigationDrawerItemColors
|
||||
import androidx.compose.material3.NavigationDrawerItemDefaults
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
@@ -32,7 +35,10 @@ import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.rememberCoroutineScope
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.semantics.contentDescription
|
||||
import androidx.compose.ui.semantics.semantics
|
||||
import androidx.compose.ui.text.style.TextOverflow
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.compose.ui.unit.sp
|
||||
@@ -48,36 +54,59 @@ 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.core.web.WebHandoff
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.data.appearance.SiteAppearance
|
||||
import com.runicgateway.app.data.repository.Capability
|
||||
import com.runicgateway.app.ui.auth.AccountScreen
|
||||
import com.runicgateway.app.ui.auth.LoginScreen
|
||||
import com.runicgateway.app.ui.auth.RecoveryCodesScreen
|
||||
import com.runicgateway.app.ui.auth.TrustedDevicesScreen
|
||||
import com.runicgateway.app.ui.auth.roleLabelRes
|
||||
import com.runicgateway.app.ui.components.BrandLogo
|
||||
import com.runicgateway.app.ui.contact.ContactScreen
|
||||
import com.runicgateway.app.ui.events.EventScreen
|
||||
import com.runicgateway.app.ui.events.EventSeriesScreen
|
||||
import com.runicgateway.app.ui.events.EventsScreen
|
||||
import com.runicgateway.app.ui.events.MyEventsScreen
|
||||
import com.runicgateway.app.ui.home.HomeScreen
|
||||
import com.runicgateway.app.ui.navigation.APP_MENU
|
||||
import com.runicgateway.app.ui.navigation.NavNode
|
||||
import com.runicgateway.app.ui.navigation.Routes
|
||||
import com.runicgateway.app.ui.navigation.visibleEntries
|
||||
import com.runicgateway.app.ui.navigation.buildNavTree
|
||||
import com.runicgateway.app.ui.navigation.isEntryVisible
|
||||
import com.runicgateway.app.ui.navigation.pruneNav
|
||||
import com.runicgateway.app.ui.news.NewsScreen
|
||||
import com.runicgateway.app.ui.news.PostScreen
|
||||
import com.runicgateway.app.ui.admin.AdminContentScreen
|
||||
import com.runicgateway.app.ui.admin.AdminDashboardScreen
|
||||
import com.runicgateway.app.ui.admin.AdminModerationScreen
|
||||
import com.runicgateway.app.ui.admin.AdminSupportScreen
|
||||
import com.runicgateway.app.ui.notifications.NotificationsScreen
|
||||
import com.runicgateway.app.ui.notifications.InboxBadgeViewModel
|
||||
import com.runicgateway.app.ui.notifications.InboxScreen
|
||||
import com.runicgateway.app.ui.notifications.NotificationSettingsScreen
|
||||
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.AtlasCreatureScreen
|
||||
import com.runicgateway.app.ui.shard.AtlasScreen
|
||||
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.LeaderboardsScreen
|
||||
import com.runicgateway.app.ui.shard.MarketScreen
|
||||
import com.runicgateway.app.ui.shard.MarketVendorScreen
|
||||
import com.runicgateway.app.ui.shard.RulesScreen
|
||||
import com.runicgateway.app.ui.shard.ShardBoard
|
||||
import com.runicgateway.app.ui.rust.RustBadgeViewModel
|
||||
import com.runicgateway.app.ui.rust.RustServerScreen
|
||||
import com.runicgateway.app.ui.rust.RustServersScreen
|
||||
import com.runicgateway.app.ui.shard.ShardScreen
|
||||
import com.runicgateway.app.ui.theme.LocalShardStructure
|
||||
import com.runicgateway.app.ui.wiki.WikiPageScreen
|
||||
import com.runicgateway.app.ui.wiki.WikiScreen
|
||||
import kotlinx.coroutines.launch
|
||||
@@ -85,7 +114,17 @@ import kotlinx.coroutines.launch
|
||||
/** Destinations that show the drawer (hamburger); others show a back arrow. */
|
||||
private val TOP_LEVEL_ROUTES = setOf(
|
||||
Routes.HOME, Routes.NEWS, Routes.WIKI, Routes.SHARD, Routes.CONTACT, Routes.PAGE, Routes.ACCOUNT,
|
||||
// Protocol 3.0 content screens are drawer destinations, so the drawer gesture works
|
||||
// on them too (M11).
|
||||
Routes.SHARD_RULES, Routes.SHARD_LEADERBOARDS, Routes.SHARD_MARKET, Routes.ATLAS,
|
||||
Routes.NOTIFICATIONS,
|
||||
// Events (M13): the calendar and the history are drawer rows, so the drawer
|
||||
// gesture works on them. The event page and an arc are detail screens and are
|
||||
// deliberately absent — a back gesture there means "back", not "open the menu".
|
||||
Routes.EVENTS, Routes.MY_EVENTS,
|
||||
// The Rust server list is a drawer row (M14); one server's page is a detail
|
||||
// screen and is deliberately absent — a back gesture there means "back".
|
||||
Routes.RUST,
|
||||
Routes.PLAYER_CHARACTERS, Routes.PLAYER_VENDORS, Routes.PLAYER_HOUSES,
|
||||
Routes.ADMIN_DASHBOARD, Routes.ADMIN_CONTENT, Routes.ADMIN_MODERATION, Routes.ADMIN_SUPPORT,
|
||||
)
|
||||
@@ -100,29 +139,62 @@ private val TOP_LEVEL_ROUTES = setOf(
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun RunicApp(
|
||||
brand: BrandDto?,
|
||||
appearance: SiteAppearance,
|
||||
onChangeServer: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
deepLinkStream: String? = null,
|
||||
deepLinkRef: String? = null,
|
||||
onDeepLinkConsumed: () -> Unit = {},
|
||||
sessionViewModel: SessionViewModel = hiltViewModel(),
|
||||
inboxBadgeViewModel: InboxBadgeViewModel = hiltViewModel(),
|
||||
rustBadgeViewModel: RustBadgeViewModel = hiltViewModel(),
|
||||
) {
|
||||
val brand = appearance.brand
|
||||
val navController = rememberNavController()
|
||||
val drawerState = rememberDrawerState(DrawerValue.Closed)
|
||||
val scope = rememberCoroutineScope()
|
||||
|
||||
val session by sessionViewModel.session.collectAsStateWithLifecycle()
|
||||
// What this shard publishes, independently of who the caller is (§5, M11).
|
||||
val shardFeatures by sessionViewModel.shardFeatures.collectAsStateWithLifecycle()
|
||||
// What this BACKEND serves at all, independently of both (§5, M13). A different
|
||||
// question from the line above and gated separately — see `isEntryVisible`.
|
||||
val capabilities by sessionViewModel.capabilities.collectAsStateWithLifecycle()
|
||||
|
||||
// Re-validate the cached role each time the app returns to the foreground (§4.3).
|
||||
LifecycleResumeEffect(Unit) {
|
||||
// Re-validate the cached role each time the app returns to the foreground (§4.3),
|
||||
// and re-read the two drawer counts with it: a tickle that arrived while the app
|
||||
// was away is exactly what brings someone back to it, and a live player count is
|
||||
// only live if it is re-read when somebody looks.
|
||||
LifecycleResumeEffect(capabilities) {
|
||||
sessionViewModel.revalidate()
|
||||
inboxBadgeViewModel.refresh()
|
||||
// The Rust count is a LIVE number, so it is re-read on the same clock the
|
||||
// unread badge is: coming back to the app is exactly when a stale one
|
||||
// would be noticed. Keyed on the capability answer as well as on resume,
|
||||
// because the very first resume happens before this host has said whether
|
||||
// the module is there — and asking then would either make a request on a
|
||||
// site that has no Rust, or never make one at all.
|
||||
capabilities?.let { rustBadgeViewModel.refresh(Capability.RUST in it) }
|
||||
onPauseOrDispose { }
|
||||
}
|
||||
|
||||
val unread by inboxBadgeViewModel.unread.collectAsStateWithLifecycle()
|
||||
// How many people are on the Rust fleet, for the drawer row's badge — the
|
||||
// phone's answer to D15's footer count (M14). Refreshed on resume, never on a
|
||||
// timer: a badge is a glance, not a feed. Gated here rather than inside the
|
||||
// view model because this is the only place that knows whether the module is
|
||||
// installed at all, and a host that has not answered yet asks nothing.
|
||||
val rustOnline by rustBadgeViewModel.online.collectAsStateWithLifecycle()
|
||||
// The badge follows the session, so signing out clears it rather than leaving
|
||||
// the previous account's count on the drawer.
|
||||
LaunchedEffect(session) { inboxBadgeViewModel.refresh() }
|
||||
|
||||
// A tapped push notification deep-links to its stream's screen (§11, item 7).
|
||||
LaunchedEffect(deepLinkStream) {
|
||||
LaunchedEffect(deepLinkStream, deepLinkRef) {
|
||||
val stream = deepLinkStream ?: return@LaunchedEffect
|
||||
navController.navigate(Routes.forStream(stream)) {
|
||||
// Both halves of the tickle: a `notification:` ref means there is an inbox
|
||||
// row waiting, and that is where the tap goes (ENGAGEMENT.md phase 8).
|
||||
navController.navigate(Routes.forTickle(stream, deepLinkRef)) {
|
||||
popUpTo(Routes.HOME) { saveState = true }
|
||||
launchSingleTop = true
|
||||
}
|
||||
@@ -130,9 +202,37 @@ fun RunicApp(
|
||||
}
|
||||
|
||||
val backStackEntry by navController.currentBackStackEntryAsState()
|
||||
val currentRoute = backStackEntry?.destination?.route
|
||||
// A destination's route is its NavHost *pattern*, so News reports
|
||||
// "news?category={category}" (§6.2). Compare on the part before the query.
|
||||
val currentRoute = backStackEntry?.destination?.route?.substringBefore('?')
|
||||
val isTopLevel = currentRoute in TOP_LEVEL_ROUTES
|
||||
val entries = visibleEntries(APP_MENU, session)
|
||||
// The admin's nav overrides, then the gates — never the other way round. An
|
||||
// override is presentation only: it may relabel, reorder, group and hide, so
|
||||
// `pruneNav` still decides what this caller may see and remains the boundary
|
||||
// (§6.1, AC-3). With no stored row the merge returns APP_MENU itself.
|
||||
val nav = pruneNav(buildNavTree(APP_MENU, appearance.navPublic)) {
|
||||
isEntryVisible(it, session, shardFeatures, capabilities)
|
||||
}
|
||||
|
||||
val context = LocalContext.current
|
||||
// An added link's path is site-relative; a hand-off needs it absolute against
|
||||
// the configured base URL, which is exactly what the asset resolver does (§6.3).
|
||||
val resolveUrl = LocalAssetResolver.current
|
||||
val openNode: (NavNode) -> Unit = { node ->
|
||||
scope.launch { drawerState.close() }
|
||||
when (node) {
|
||||
is NavNode.Item -> navController.navigateTopLevel(node.entry.route)
|
||||
// A link the app resolved opens like any other drawer row, detail screen
|
||||
// or not: one rule, and back-press lands on Home as it does from every
|
||||
// row. One it could not resolve goes to the browser, absolute against
|
||||
// the site's base URL (§6.3).
|
||||
is NavNode.Link -> node.route
|
||||
?.let { navController.navigateTopLevel(it) }
|
||||
?: resolveUrl(node.path)?.let { WebHandoff.open(context, it) }
|
||||
// Section headers aren't clickable — the group is always open (§6.3).
|
||||
is NavNode.Section -> Unit
|
||||
}
|
||||
}
|
||||
|
||||
ModalNavigationDrawer(
|
||||
drawerState = drawerState,
|
||||
@@ -150,6 +250,14 @@ fun RunicApp(
|
||||
// unreachable. See RunicGateway M10.
|
||||
Column(Modifier.verticalScroll(rememberScrollState())) {
|
||||
Spacer(Modifier.height(12.dp))
|
||||
// The instance's logo above its name (§5.6). Decorative — the name
|
||||
// is the very next line — and absent on an instance that uploaded
|
||||
// none, in which case the header is exactly what it was before M12.
|
||||
BrandLogo(
|
||||
logo = brand?.logo,
|
||||
height = 32.dp,
|
||||
modifier = Modifier.padding(start = 24.dp, end = 24.dp, bottom = 4.dp),
|
||||
)
|
||||
Text(
|
||||
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
|
||||
style = MaterialTheme.typography.titleLarge,
|
||||
@@ -158,17 +266,41 @@ fun RunicApp(
|
||||
)
|
||||
HorizontalDivider()
|
||||
Spacer(Modifier.height(8.dp))
|
||||
entries.forEach { entry ->
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(entry.labelRes)) },
|
||||
selected = currentRoute == entry.route,
|
||||
onClick = {
|
||||
scope.launch { drawerState.close() }
|
||||
navController.navigateTopLevel(entry.route)
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
nav.forEach { node ->
|
||||
if (node is NavNode.Section) {
|
||||
// A group the admin created: its label as a header, its rows
|
||||
// beneath it. Always open — a drawer is already a vertical
|
||||
// list, so the website's dropdown does not translate (§6.3).
|
||||
Text(
|
||||
text = node.label,
|
||||
style = MaterialTheme.typography.labelLarge,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(
|
||||
start = 28.dp,
|
||||
end = 28.dp,
|
||||
top = 12.dp,
|
||||
bottom = 4.dp,
|
||||
),
|
||||
)
|
||||
node.items.forEach { child ->
|
||||
NavRow(
|
||||
node = child,
|
||||
currentRoute = currentRoute,
|
||||
colors = drawerItemColors,
|
||||
indented = true,
|
||||
unread = unread,
|
||||
rustOnline = rustOnline,
|
||||
) { openNode(child) }
|
||||
}
|
||||
} else {
|
||||
NavRow(
|
||||
node = node,
|
||||
currentRoute = currentRoute,
|
||||
colors = drawerItemColors,
|
||||
unread = unread,
|
||||
rustOnline = rustOnline,
|
||||
) { openNode(node) }
|
||||
}
|
||||
}
|
||||
|
||||
HorizontalDivider(Modifier.padding(vertical = 8.dp))
|
||||
@@ -192,6 +324,7 @@ fun RunicApp(
|
||||
}
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
shape = LocalShardStructure.current.pill,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
NavigationDrawerItem(
|
||||
@@ -202,6 +335,7 @@ fun RunicApp(
|
||||
onChangeServer()
|
||||
},
|
||||
colors = drawerItemColors,
|
||||
shape = LocalShardStructure.current.pill,
|
||||
modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
|
||||
)
|
||||
}
|
||||
@@ -219,13 +353,24 @@ fun RunicApp(
|
||||
actionIconContentColor = MaterialTheme.colorScheme.onSurface,
|
||||
),
|
||||
title = {
|
||||
Text(
|
||||
text = (brand?.name?.takeIf { it.isNotBlank() }
|
||||
?: stringResource(R.string.app_name)).uppercase(),
|
||||
style = MaterialTheme.typography.titleSmall.copy(letterSpacing = 1.2.sp),
|
||||
maxLines = 1,
|
||||
overflow = TextOverflow.Ellipsis,
|
||||
)
|
||||
val name = brand?.name?.takeIf { it.isNotBlank() }
|
||||
?: stringResource(R.string.app_name)
|
||||
// The logo stands in for the title here, so unlike the drawer's
|
||||
// it is named for a screen reader — and it falls back to the
|
||||
// text when the instance has no logo or the load fails (§5.6).
|
||||
BrandLogo(
|
||||
logo = brand?.logo,
|
||||
height = 24.dp,
|
||||
contentDescription = name,
|
||||
) {
|
||||
Text(
|
||||
text = name.uppercase(),
|
||||
style = MaterialTheme.typography.titleSmall
|
||||
.copy(letterSpacing = 1.2.sp),
|
||||
maxLines = 1,
|
||||
overflow = TextOverflow.Ellipsis,
|
||||
)
|
||||
}
|
||||
},
|
||||
navigationIcon = {
|
||||
if (isTopLevel) {
|
||||
@@ -256,6 +401,103 @@ fun RunicApp(
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* One drawer row: a coded entry, or an admin's added link (§6.3).
|
||||
*
|
||||
* A link that the app can open natively is deliberately indistinguishable from a
|
||||
* coded row — that is the point of resolving it. One that hands off to the browser
|
||||
* carries a trailing icon, so leaving the app is never a surprise.
|
||||
*/
|
||||
@Composable
|
||||
private fun NavRow(
|
||||
node: NavNode,
|
||||
currentRoute: String?,
|
||||
colors: NavigationDrawerItemColors,
|
||||
indented: Boolean = false,
|
||||
unread: Int = 0,
|
||||
rustOnline: Int = 0,
|
||||
onClick: () -> Unit,
|
||||
) {
|
||||
val route = when (node) {
|
||||
is NavNode.Item -> node.entry.route
|
||||
is NavNode.Link -> node.route
|
||||
is NavNode.Section -> null
|
||||
}
|
||||
val label = when (node) {
|
||||
// An admin's label wins over the bundled one, and is the same string in
|
||||
// every locale — see MenuEntry.label.
|
||||
is NavNode.Item -> node.entry.label ?: stringResource(node.entry.labelRes)
|
||||
is NavNode.Link -> node.label
|
||||
is NavNode.Section -> return
|
||||
}
|
||||
val handsOff = node is NavNode.Link && node.route == null
|
||||
// The unread count rides on whichever row leads to the inbox — including an
|
||||
// admin's own nav override pointing at it, since the badge belongs to the
|
||||
// destination, not to the bundled entry.
|
||||
val showsUnread = !handsOff && unread > 0 && route == Routes.NOTIFICATIONS
|
||||
// The live player count rides on whichever row leads to the Rust list, for the
|
||||
// same reason the unread count rides on whichever leads to the inbox — the
|
||||
// number belongs to the destination, not to the bundled entry, so an admin's
|
||||
// own nav override pointing there carries it too.
|
||||
//
|
||||
// **Zero renders nothing**, rather than a `0`: an empty fleet is not a
|
||||
// notification, and a badge that read `0` on a site whose servers are simply
|
||||
// quiet would be worse than no badge at all.
|
||||
val showsRustOnline = !handsOff && rustOnline > 0 && route == Routes.RUST
|
||||
|
||||
NavigationDrawerItem(
|
||||
label = { Text(label) },
|
||||
selected = route != null && currentRoute == route.substringBefore('?'),
|
||||
onClick = onClick,
|
||||
badge = when {
|
||||
handsOff -> {
|
||||
{
|
||||
Icon(
|
||||
Icons.AutoMirrored.Filled.ExitToApp,
|
||||
contentDescription = stringResource(R.string.nav_opens_in_browser),
|
||||
modifier = Modifier.size(18.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
showsUnread -> {
|
||||
{
|
||||
// Named for a screen reader: "7" beside "Notifications" reads as
|
||||
// a count to a sighted user and as a bare number to everyone else.
|
||||
val spoken = stringResource(R.string.inbox_unread_count, unread)
|
||||
Text(
|
||||
text = unread.toString(),
|
||||
style = MaterialTheme.typography.labelLarge,
|
||||
modifier = Modifier.semantics { contentDescription = spoken },
|
||||
)
|
||||
}
|
||||
}
|
||||
showsRustOnline -> {
|
||||
{
|
||||
// Named for a screen reader: "42" beside "Rust servers" reads
|
||||
// as a count to a sighted user and as a bare number to
|
||||
// everyone else.
|
||||
val spoken = stringResource(R.string.rust_online_badge, rustOnline)
|
||||
Text(
|
||||
text = rustOnline.toString(),
|
||||
style = MaterialTheme.typography.labelLarge,
|
||||
modifier = Modifier.semantics { contentDescription = spoken },
|
||||
)
|
||||
}
|
||||
}
|
||||
else -> null
|
||||
},
|
||||
colors = colors,
|
||||
// Like Card's elevation, NavigationDrawerItem takes its shape as a default
|
||||
// argument (CircleShape) rather than from the theme, so --radius-pill has to
|
||||
// be handed to it at every call site or the selected row stays fully round
|
||||
// while every other radius follows the shard (phase 8's AC-5 walk).
|
||||
shape = LocalShardStructure.current.pill,
|
||||
modifier = Modifier
|
||||
.padding(NavigationDrawerItemDefaults.ItemPadding)
|
||||
.padding(start = if (indented) 16.dp else 0.dp),
|
||||
)
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun RunicNavHost(
|
||||
navController: NavHostController,
|
||||
@@ -273,7 +515,19 @@ private fun RunicNavHost(
|
||||
composable(Routes.HOME) {
|
||||
HomeScreen(brand = brand)
|
||||
}
|
||||
composable(Routes.NEWS) {
|
||||
// The category is optional: navigating to plain Routes.NEWS matches this
|
||||
// pattern with no argument and opens the default tab, which is every route
|
||||
// into the screen except an admin's nav override or added link (§6.2).
|
||||
composable(
|
||||
route = Routes.NEWS_ROUTE,
|
||||
arguments = listOf(
|
||||
navArgument(Routes.Args.CATEGORY) {
|
||||
type = NavType.StringType
|
||||
nullable = true
|
||||
defaultValue = null
|
||||
},
|
||||
),
|
||||
) {
|
||||
NewsScreen(onOpenPost = { category, idOrSlug ->
|
||||
navController.navigate(Routes.post(category, idOrSlug))
|
||||
})
|
||||
@@ -287,6 +541,50 @@ private fun RunicNavHost(
|
||||
) {
|
||||
PostScreen()
|
||||
}
|
||||
// Events (M13). CORE's routes, so these screens are reachable on a backend
|
||||
// with no game module at all — which is why they sit above the shard block
|
||||
// rather than inside it.
|
||||
composable(Routes.EVENTS) {
|
||||
EventsScreen(onOpenEvent = { slug -> navController.navigate(Routes.event(slug)) })
|
||||
}
|
||||
// The app's one route with a query argument. `run` is optional and nullable:
|
||||
// navigating to Routes.event(slug) with no run matches this pattern with no
|
||||
// argument, which is every route in except an announcement's link.
|
||||
composable(
|
||||
route = Routes.EVENT_ROUTE,
|
||||
arguments = listOf(
|
||||
navArgument(Routes.Args.SLUG) { type = NavType.StringType },
|
||||
navArgument(Routes.Args.RUN) {
|
||||
type = NavType.StringType
|
||||
nullable = true
|
||||
defaultValue = null
|
||||
},
|
||||
),
|
||||
) {
|
||||
EventScreen(
|
||||
onOpenSeries = { slug -> navController.navigate(Routes.eventSeries(slug)) },
|
||||
onOpenRun = { slug, runId ->
|
||||
navController.navigate(Routes.event(slug, runId.toString()))
|
||||
},
|
||||
)
|
||||
}
|
||||
composable(
|
||||
route = Routes.EVENT_SERIES,
|
||||
arguments = listOf(navArgument(Routes.Args.SLUG) { type = NavType.StringType }),
|
||||
) {
|
||||
EventSeriesScreen(onOpenEvent = { slug -> navController.navigate(Routes.event(slug)) })
|
||||
}
|
||||
composable(Routes.MY_EVENTS) {
|
||||
// Signed out, this route is not in the drawer — but a saved back-stack
|
||||
// entry can still be restored onto it, so the shell says where to go
|
||||
// rather than letting the screen ask the server and render a 401.
|
||||
when (session) {
|
||||
is Session.SignedIn -> MyEventsScreen(onOpenRun = { slug, runId ->
|
||||
navController.navigate(Routes.event(slug, runId.toString()))
|
||||
})
|
||||
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
|
||||
}
|
||||
}
|
||||
composable(Routes.SHARD) {
|
||||
ShardScreen(onOpenBoard = { board ->
|
||||
navController.navigate(
|
||||
@@ -303,6 +601,41 @@ private fun RunicNavHost(
|
||||
composable(Routes.SHARD_GUILDS) { GuildsScreen() }
|
||||
composable(Routes.SHARD_GOVERNORS) { GovernorsScreen() }
|
||||
composable(Routes.SHARD_HOUSES) { HousesScreen() }
|
||||
|
||||
// Protocol 3.0 shard content (M11). Each screen self-reports "not published
|
||||
// here" from its own 404/403, so a deep link to a gated feature still lands on
|
||||
// an honest answer even though the menu hides the entry.
|
||||
composable(Routes.SHARD_RULES) { RulesScreen() }
|
||||
composable(Routes.SHARD_LEADERBOARDS) { LeaderboardsScreen(brand = brand) }
|
||||
composable(Routes.SHARD_MARKET) {
|
||||
MarketScreen(onOpenVendor = { serial -> navController.navigate(Routes.marketVendor(serial)) })
|
||||
}
|
||||
composable(
|
||||
route = Routes.SHARD_MARKET_VENDOR,
|
||||
arguments = listOf(navArgument(Routes.Args.SERIAL) { type = NavType.StringType }),
|
||||
) { entry ->
|
||||
MarketVendorScreen(serial = entry.arguments?.getString(Routes.Args.SERIAL).orEmpty())
|
||||
}
|
||||
composable(Routes.ATLAS) {
|
||||
AtlasScreen(onOpenCreature = { slug -> navController.navigate(Routes.atlasCreature(slug)) })
|
||||
}
|
||||
composable(
|
||||
route = Routes.ATLAS_CREATURE,
|
||||
arguments = listOf(navArgument(Routes.Args.SLUG) { type = NavType.StringType }),
|
||||
) { entry ->
|
||||
AtlasCreatureScreen(slug = entry.arguments?.getString(Routes.Args.SLUG).orEmpty())
|
||||
}
|
||||
// The Rust module's two screens (M14). Not under `shard/`: a different game,
|
||||
// a different shape — a fleet with a list above it rather than one place.
|
||||
composable(Routes.RUST) {
|
||||
RustServersScreen(onOpenServer = { id -> navController.navigate(Routes.rustServer(id)) })
|
||||
}
|
||||
composable(
|
||||
route = Routes.RUST_SERVER,
|
||||
arguments = listOf(navArgument(Routes.Args.SERVER_ID) { type = NavType.StringType }),
|
||||
) {
|
||||
RustServerScreen(onBack = { navController.navigateTopLevel(Routes.RUST) })
|
||||
}
|
||||
composable(Routes.WIKI) {
|
||||
WikiScreen(onOpenPage = { slug -> navController.navigate(Routes.wikiPage(slug)) })
|
||||
}
|
||||
@@ -364,9 +697,24 @@ private fun RunicNavHost(
|
||||
}
|
||||
composable(Routes.NOTIFICATIONS) {
|
||||
// Signed-in only; a sign-out (or demotion) sends the user home rather than
|
||||
// leaving stale settings up. The backend gates every call regardless (§5).
|
||||
// leaving another account's items up. The backend gates every call
|
||||
// regardless, and the inbox routes are role-agnostic (§5) — staff have an
|
||||
// inbox for the same reason players do, which on the web took a second
|
||||
// mount to be true.
|
||||
when (session) {
|
||||
is Session.SignedIn -> NotificationsScreen()
|
||||
is Session.SignedIn -> InboxScreen(
|
||||
onOpenSettings = { navController.navigate(Routes.NOTIFICATIONS_SETTINGS) },
|
||||
// A notification whose link the app can render opens in the app.
|
||||
// `navigate`, not `navigateTopLevel`: the inbox is where the
|
||||
// reader came from and back should return there.
|
||||
onOpenRoute = { route -> navController.navigate(route) },
|
||||
)
|
||||
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
|
||||
}
|
||||
}
|
||||
composable(Routes.NOTIFICATIONS_SETTINGS) {
|
||||
when (session) {
|
||||
is Session.SignedIn -> NotificationSettingsScreen()
|
||||
Session.SignedOut -> LaunchedEffect(Unit) { navController.navigateTopLevel(Routes.HOME) }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -34,6 +34,13 @@ enum class ErrorKind {
|
||||
/** Shard/sidecar down (503) — shard reads only; render as offline (§6.3). */
|
||||
SHARD_OFFLINE,
|
||||
|
||||
/**
|
||||
* This shard doesn't publish the surface, or doesn't publish it to this viewer
|
||||
* (M11). Distinct from [NOT_FOUND] and [SHARD_OFFLINE]: the site is up, the shard
|
||||
* may well be up, and retrying changes nothing — an admin decides this.
|
||||
*/
|
||||
FEATURE_UNAVAILABLE,
|
||||
|
||||
/** Any other non-2xx server response. */
|
||||
SERVER,
|
||||
}
|
||||
@@ -52,3 +59,27 @@ fun <T> ApiResult<T>.toUiState(): UiState<T> = when (this) {
|
||||
httpStatus = status,
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* [toUiState] for a **shard-derived** read, where `404` carries a second meaning.
|
||||
*
|
||||
* The website's `requireFeature` gate answers `404` when a feature is switched off —
|
||||
* deliberately, so the response doesn't disclose that the surface exists — and `403`
|
||||
* when it's on but the caller is below its audience rung (`docs/link/v3.md` §3.6).
|
||||
* On these routes a `404` therefore almost never means "no such thing"; it means this
|
||||
* shard doesn't publish it. Rendering "couldn't be found" with a retry button would
|
||||
* invite the user to retry something an admin controls.
|
||||
*
|
||||
* Kept as a separate mapper rather than folded into [toUiState] because both statuses
|
||||
* mean something else off the shard surface: `404` is a genuinely missing item (a
|
||||
* deleted post, an unknown wiki slug) and `403` is an ownership or role refusal on a
|
||||
* player or admin route, which is not an admin's visibility setting.
|
||||
*/
|
||||
fun <T> ApiResult<T>.toShardUiState(): UiState<T> = when (this) {
|
||||
is ApiResult.HttpError -> if (status == 403 || status == 404) {
|
||||
UiState.Error(ErrorKind.FEATURE_UNAVAILABLE, httpStatus = status)
|
||||
} else {
|
||||
toUiState()
|
||||
}
|
||||
else -> toUiState()
|
||||
}
|
||||
|
||||
@@ -15,7 +15,6 @@ import androidx.compose.foundation.layout.width
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.AlertDialog
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.FilterChip
|
||||
import androidx.compose.material3.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
@@ -30,7 +29,6 @@ import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableIntStateOf
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.compose.runtime.saveable.rememberSaveable
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.compose.ui.Alignment
|
||||
@@ -47,6 +45,7 @@ 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.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
@@ -140,7 +139,7 @@ private fun PostsTab(
|
||||
}
|
||||
}
|
||||
items(state.data, key = { it.id }) { post ->
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
Text(post.title, style = MaterialTheme.typography.bodyLarge)
|
||||
Spacer(Modifier.height(4.dp))
|
||||
@@ -191,7 +190,7 @@ private fun WikiTab(
|
||||
}
|
||||
}
|
||||
items(state.data, key = { it.id }) { cat ->
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
Text(cat.title, style = MaterialTheme.typography.bodyLarge)
|
||||
Text(
|
||||
|
||||
@@ -14,7 +14,6 @@ import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.AlertDialog
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.Checkbox
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
@@ -38,6 +37,7 @@ 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.ShardCard
|
||||
|
||||
/**
|
||||
* The support (help-page) queue (PLAN.md §1, M10): open tickets with reply/close,
|
||||
@@ -84,7 +84,6 @@ fun AdminSupportScreen(
|
||||
|
||||
replyTo?.let { page ->
|
||||
RespondDialog(
|
||||
page = page,
|
||||
onDismiss = { replyTo = null },
|
||||
onSend = { message, close ->
|
||||
viewModel.respond(page.pageId, message, close)
|
||||
@@ -101,7 +100,7 @@ private fun SupportPageCard(
|
||||
onReply: () -> Unit,
|
||||
onClose: () -> Unit,
|
||||
) {
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Column(Modifier.padding(12.dp)) {
|
||||
val who = page.sender?.name ?: page.sender?.account ?: page.pageId
|
||||
Text(
|
||||
@@ -122,7 +121,6 @@ private fun SupportPageCard(
|
||||
|
||||
@Composable
|
||||
private fun RespondDialog(
|
||||
page: SupportPageDto,
|
||||
onDismiss: () -> Unit,
|
||||
onSend: (message: String, close: Boolean) -> Unit,
|
||||
) {
|
||||
|
||||
@@ -17,7 +17,6 @@ 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
|
||||
@@ -51,6 +50,7 @@ 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.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
@@ -107,7 +107,7 @@ fun AccountScreen(
|
||||
|
||||
@Composable
|
||||
private fun IdentityCard(username: String, roleLabel: String) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(20.dp)) {
|
||||
Text(text = username, style = MaterialTheme.typography.titleLarge)
|
||||
StatusPill(
|
||||
@@ -154,7 +154,7 @@ private fun SecuritySection(onOpenTrustedDevices: () -> Unit, onOpenRecoveryCode
|
||||
|
||||
@Composable
|
||||
private fun SectionCard(@StringRes titleRes: Int, content: @Composable () -> Unit) {
|
||||
Card(Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(titleRes), style = MaterialTheme.typography.titleMedium)
|
||||
content()
|
||||
|
||||
@@ -153,18 +153,11 @@ class LoginViewModel @Inject constructor(
|
||||
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) }
|
||||
val validationError = validateForSubmit(s)
|
||||
if (validationError != null) {
|
||||
_state.update { it.copy(error = validationError) }
|
||||
return
|
||||
}
|
||||
// If 2FA is being requested, the chosen second factor must accompany the resubmit.
|
||||
if (s.totpRequired) {
|
||||
val factor = if (s.useRecoveryCode) s.recoveryCode else s.code
|
||||
if (factor.isBlank()) {
|
||||
_state.update { it.copy(error = LoginError.BAD_CODE) }
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
_state.update { it.copy(submitting = true, error = null) }
|
||||
viewModelScope.launch {
|
||||
@@ -178,36 +171,50 @@ class LoginViewModel @Inject constructor(
|
||||
recoveryCode = recoveryCode,
|
||||
trustDevice = s.trustDevice,
|
||||
)
|
||||
when (result) {
|
||||
is LoginResult.Success ->
|
||||
// The trusted-device cap (result.trustLimitReached) is an edge case:
|
||||
// login succeeded but the device wasn't remembered. It's surfaced +
|
||||
// managed on the Trusted Devices screen rather than blocking sign-in.
|
||||
_state.update { it.copy(submitting = false, signedIn = true) }
|
||||
|
||||
LoginResult.TotpRequired ->
|
||||
// Reveal the 2FA fields; a wrong code/recovery code re-lands here as BAD_CODE.
|
||||
_state.update {
|
||||
val hadFactor = if (it.useRecoveryCode) it.recoveryCode.isNotBlank() else it.code.isNotBlank()
|
||||
it.copy(
|
||||
submitting = false,
|
||||
totpRequired = true,
|
||||
error = if (hadFactor) 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) }
|
||||
}
|
||||
applyLoginResult(result)
|
||||
}
|
||||
}
|
||||
|
||||
/** Pre-flight form checks for [submit]; returns the error to surface, or null if ready to send. */
|
||||
private fun validateForSubmit(s: UiState): LoginError? {
|
||||
if (s.username.isBlank() || s.password.isBlank()) return LoginError.INVALID_CREDENTIALS
|
||||
// If 2FA is being requested, the chosen second factor must accompany the resubmit.
|
||||
if (s.totpRequired) {
|
||||
val factor = if (s.useRecoveryCode) s.recoveryCode else s.code
|
||||
if (factor.isBlank()) return LoginError.BAD_CODE
|
||||
}
|
||||
return null
|
||||
}
|
||||
|
||||
/** Folds a [LoginResult] back into the UI state (clears [UiState.submitting] on every path). */
|
||||
private fun applyLoginResult(result: LoginResult) = when (result) {
|
||||
is LoginResult.Success ->
|
||||
// The trusted-device cap (result.trustLimitReached) is an edge case:
|
||||
// login succeeded but the device wasn't remembered. It's surfaced +
|
||||
// managed on the Trusted Devices screen rather than blocking sign-in.
|
||||
_state.update { it.copy(submitting = false, signedIn = true) }
|
||||
|
||||
LoginResult.TotpRequired ->
|
||||
// Reveal the 2FA fields; a wrong code/recovery code re-lands here as BAD_CODE.
|
||||
_state.update {
|
||||
val hadFactor = if (it.useRecoveryCode) it.recoveryCode.isNotBlank() else it.code.isNotBlank()
|
||||
it.copy(
|
||||
submitting = false,
|
||||
totpRequired = true,
|
||||
error = if (hadFactor) 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) }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,7 +14,6 @@ import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.Button
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
@@ -38,6 +37,7 @@ import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
|
||||
/**
|
||||
* Account → Recovery Codes (TRUSTED_DEVICES_MFA.md): shows the remaining count and a
|
||||
@@ -117,7 +117,7 @@ fun RecoveryCodesShowOnceCard(codes: List<String>, onDismiss: () -> Unit) {
|
||||
val clipboard = LocalClipboardManager.current
|
||||
val joined = remember(codes) { codes.joinToString("\n") }
|
||||
|
||||
Card(Modifier.fillMaxWidth().padding(top = 16.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(top = 16.dp)) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(R.string.recovery_codes_new_title), style = MaterialTheme.typography.titleMedium)
|
||||
Text(
|
||||
|
||||
@@ -11,7 +11,6 @@ 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.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedButton
|
||||
@@ -30,6 +29,7 @@ import com.runicgateway.app.data.api.dto.TrustedDeviceDto
|
||||
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.ShardCard
|
||||
|
||||
/**
|
||||
* Account → Trusted Devices (TRUSTED_DEVICES_MFA.md): the devices allowed to skip
|
||||
@@ -108,7 +108,7 @@ fun TrustedDevicesScreen(
|
||||
|
||||
@Composable
|
||||
private fun TrustedDeviceRow(device: TrustedDeviceDto, busy: Boolean, onRevoke: () -> Unit) {
|
||||
Card(Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(top = 12.dp)) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
|
||||
@@ -0,0 +1,157 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.components
|
||||
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.widthIn
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
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.draw.clip
|
||||
import androidx.compose.ui.layout.ContentScale
|
||||
import androidx.compose.ui.unit.Dp
|
||||
import androidx.compose.ui.unit.dp
|
||||
import coil.compose.AsyncImage
|
||||
import com.runicgateway.app.ui.LocalAssetResolver
|
||||
|
||||
/**
|
||||
* The two brand assets an instance can upload — the logo and the hero
|
||||
* (THEMING_AND_NAV.md §5.6, M12 phase 4). Both have ridden in `BrandDto` since
|
||||
* M1 and neither has ever been drawn; the app has always spelled the instance
|
||||
* out in text wherever the website shows a mark.
|
||||
*
|
||||
* **The rule that governs this whole file: an empty slot renders nothing.** Not
|
||||
* a placeholder, not a reserved gap, not the app's own emblem — an instance
|
||||
* that has uploaded no logo must lay out exactly as it did before this phase
|
||||
* existed, which is §2 applied to assets. The website's `BrandLogo.jsx` opens
|
||||
* with the same `if (!brand.logo) return null`.
|
||||
*
|
||||
* **A failed load is an empty slot.** No broken-image icon and no retry: an
|
||||
* asset that 404s, or that can't be reached because the shard is down, must
|
||||
* degrade to the same layout as an instance that never uploaded one. That is
|
||||
* why nothing here reserves its space up front — every size modifier hangs off
|
||||
* the image itself, so when the image isn't composed neither is its padding.
|
||||
* A caller that wants space *below* a hero passes it as `Modifier.padding`
|
||||
* rather than a sibling `Spacer`, and gets both cases right for free.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Widest a logo may draw, as a multiple of its height. Mirrors the website's
|
||||
* `maxWidth: height * 6` — an operator who uploads a long wordmark gets it
|
||||
* scaled down rather than pushing the drawer header or the top bar's title out
|
||||
* of shape.
|
||||
*/
|
||||
private const val LOGO_MAX_ASPECT = 6f
|
||||
|
||||
/** The Home hero's band height (§5.6, phase 4). See [BrandHero] for why it's fixed. */
|
||||
private val HERO_HEIGHT = 180.dp
|
||||
|
||||
/**
|
||||
* The instance's uploaded logo at [height], or [fallback] when there is none.
|
||||
*
|
||||
* [fallback] defaults to drawing nothing, which is what the drawer header wants:
|
||||
* the instance name sits directly below it, so an instance with no logo simply
|
||||
* has the name where it has always been. The top bar passes the name itself,
|
||||
* because there the logo *replaces* the title — leaving that blank on a failed
|
||||
* load would strand the app in an unnamed shell until the next resume refresh,
|
||||
* and "a failed load is an empty slot" means the slot falls back to whatever
|
||||
* empty would have shown, which for the top bar is the text.
|
||||
*
|
||||
* There is deliberately no fallback while the load is still in flight. Drawing
|
||||
* the text first would flash text → logo on every navigation for the sake of
|
||||
* one frame, since Coil serves the second and later reads from its memory cache.
|
||||
*
|
||||
* Pass [contentDescription] only where the logo stands alone. Beside or above
|
||||
* the name in text it is decorative, and describing it would have a screen
|
||||
* reader say the instance's name twice — the same call the website's `alt=''`
|
||||
* makes.
|
||||
*/
|
||||
@Composable
|
||||
fun BrandLogo(
|
||||
logo: String?,
|
||||
height: Dp,
|
||||
modifier: Modifier = Modifier,
|
||||
contentDescription: String? = null,
|
||||
fallback: @Composable () -> Unit = {},
|
||||
) {
|
||||
val url = brandAssetUrl(logo, LocalAssetResolver.current)
|
||||
// Keyed on the url so a refreshed appearance that swaps the logo (§5.5) gets
|
||||
// a fresh attempt rather than inheriting the old one's failure.
|
||||
var failed by remember(url) { mutableStateOf(false) }
|
||||
|
||||
if (url == null || failed) {
|
||||
fallback()
|
||||
return
|
||||
}
|
||||
AsyncImage(
|
||||
model = url,
|
||||
contentDescription = contentDescription,
|
||||
contentScale = ContentScale.Fit,
|
||||
onError = { failed = true },
|
||||
modifier = modifier
|
||||
.height(height)
|
||||
.widthIn(max = height * LOGO_MAX_ASPECT),
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* The instance's hero image as a full-width band above Home's title block, or
|
||||
* nothing when there is none.
|
||||
*
|
||||
* **Fixed height and cropped**, rather than the intrinsic aspect ratio the app's
|
||||
* other images (`PostScreen`, `BlockRenderer`) draw at. The website's hero is a
|
||||
* CSS background driven by `hero_layout`, which the app does not port, so the
|
||||
* app needs its own rule — and the website's *default* hero is a square emblem,
|
||||
* so an uploaded square is a case to expect rather than an edge one. At the
|
||||
* intrinsic aspect that square would be a ~360dp block that pushes the status
|
||||
* card off the first screenful; cropped to a band, a wide banner and a square
|
||||
* both give the same frame above the title.
|
||||
*
|
||||
* Clipped to `shapes.medium`, so the hero follows the shard's `--radius-card`
|
||||
* like every other surface the admin can round off (§5.2).
|
||||
*
|
||||
* Decorative: Home spells the instance's name and tagline out in text directly
|
||||
* below, so the hero carries no content description.
|
||||
*/
|
||||
@Composable
|
||||
fun BrandHero(hero: String?, modifier: Modifier = Modifier) {
|
||||
val url = brandAssetUrl(hero, LocalAssetResolver.current)
|
||||
var failed by remember(url) { mutableStateOf(false) }
|
||||
|
||||
if (url == null || failed) return
|
||||
AsyncImage(
|
||||
model = url,
|
||||
contentDescription = null,
|
||||
contentScale = ContentScale.Crop,
|
||||
onError = { failed = true },
|
||||
modifier = modifier
|
||||
.fillMaxWidth()
|
||||
.height(HERO_HEIGHT)
|
||||
.clip(MaterialTheme.shapes.medium),
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve a brand asset slot to a loadable URL, or null when the slot is empty.
|
||||
*
|
||||
* The blank check has to happen on **both** sides of [resolve]: `BrandDto`
|
||||
* defaults every asset field to `""` rather than null (the server publishes the
|
||||
* empty string for "not set"), and a resolver given a path it cannot make
|
||||
* absolute may hand one straight back. Null out of here is the signal for "draw
|
||||
* nothing", so a blank slipping through would put a zero-size image request in
|
||||
* the layout instead of no image at all.
|
||||
*
|
||||
* Pulled out of the composables purely so it can be tested: the app has no
|
||||
* Robolectric, so a composable body cannot run in a JVM unit test, but this rule
|
||||
* is the whole of §5.6's "renders nothing when unset" and it is worth pinning.
|
||||
*/
|
||||
internal fun brandAssetUrl(path: String?, resolve: (String?) -> String?): String? =
|
||||
path?.takeIf { it.isNotBlank() }
|
||||
?.let(resolve)
|
||||
?.takeIf { it.isNotBlank() }
|
||||
@@ -36,6 +36,10 @@ fun LoadingView(modifier: Modifier = Modifier) {
|
||||
/**
|
||||
* Whole-screen error state with a friendly, kind-specific message and a Retry
|
||||
* button (§7). Copy is resolved from string resources so it stays localizable.
|
||||
*
|
||||
* [ErrorKind.FEATURE_UNAVAILABLE] renders **without** the button: an admin decides
|
||||
* whether the shard publishes that surface, so retrying cannot change the answer and
|
||||
* offering it would read as a transient failure the user could wait out (M11).
|
||||
*/
|
||||
@Composable
|
||||
fun ErrorView(
|
||||
@@ -53,15 +57,20 @@ fun ErrorView(
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
textAlign = TextAlign.Center,
|
||||
)
|
||||
Button(
|
||||
onClick = onRetry,
|
||||
modifier = Modifier.padding(top = 16.dp).width(160.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.action_retry))
|
||||
if (isRetryable(kind)) {
|
||||
Button(
|
||||
onClick = onRetry,
|
||||
modifier = Modifier.padding(top = 16.dp).width(160.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.action_retry))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Whether retrying this failure could plausibly succeed. Pure, so it is unit-tested. */
|
||||
fun isRetryable(kind: ErrorKind): Boolean = kind != ErrorKind.FEATURE_UNAVAILABLE
|
||||
|
||||
/** Centered informational message for an empty list (§7). */
|
||||
@Composable
|
||||
fun EmptyView(message: String, modifier: Modifier = Modifier) {
|
||||
@@ -83,5 +92,6 @@ private fun errorMessageRes(kind: ErrorKind): Int = when (kind) {
|
||||
ErrorKind.NOT_FOUND -> R.string.error_not_found
|
||||
ErrorKind.RATE_LIMITED -> R.string.error_rate_limited
|
||||
ErrorKind.SHARD_OFFLINE -> R.string.error_shard_offline
|
||||
ErrorKind.FEATURE_UNAVAILABLE -> R.string.error_feature_unavailable
|
||||
ErrorKind.SERVER -> R.string.error_server
|
||||
}
|
||||
|
||||
@@ -14,24 +14,22 @@ 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.Card
|
||||
import androidx.compose.material3.CardDefaults
|
||||
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.draw.shadow
|
||||
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.LocalShardPalette
|
||||
import com.runicgateway.app.ui.theme.LocalShardStructure
|
||||
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
|
||||
@@ -43,6 +41,14 @@ import com.runicgateway.app.ui.theme.ShardWarningBg
|
||||
* (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.
|
||||
*
|
||||
* This is the app's **only** file that reaches past `MaterialTheme` for a
|
||||
* themable value, so it is the one place M12 had to migrate: the surface, line
|
||||
* and accent tokens come from [LocalShardPalette] and the pill shape and card
|
||||
* depth from [LocalShardStructure], both following the shard's theme
|
||||
* (THEMING_AND_NAV.md §5.1, §5.2, §5.4). The success/warning/danger constants
|
||||
* stay imported directly — those are semantic and never themed, mirroring the
|
||||
* server's `FIXED_TOKENS`.
|
||||
*/
|
||||
|
||||
/** Semantic tone for a [StatusPill] / [OnlineDot]. */
|
||||
@@ -50,21 +56,26 @@ enum class PillTone { Success, Warning, Danger, Neutral, Info }
|
||||
|
||||
private data class PillColors(val fg: Color, val bg: Color)
|
||||
|
||||
@Composable
|
||||
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)
|
||||
PillTone.Neutral, PillTone.Info ->
|
||||
LocalShardPalette.current.let { PillColors(it.pillFg, it.pillBg) }
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* The one place `--radius-pill` lands: the app's other two [CircleShape] uses are
|
||||
* 8dp status dots, and a dot stays a dot however square the shard makes its site.
|
||||
*/
|
||||
@Composable
|
||||
fun StatusPill(text: String, tone: PillTone, modifier: Modifier = Modifier) {
|
||||
val c = toneColors(tone)
|
||||
Surface(color = c.bg, shape = CircleShape, modifier = modifier) {
|
||||
Surface(color = c.bg, shape = LocalShardStructure.current.pill, modifier = modifier) {
|
||||
Text(
|
||||
text = text.uppercase(),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
@@ -81,7 +92,7 @@ fun OnlineDot(tone: PillTone, modifier: Modifier = Modifier) {
|
||||
PillTone.Success -> ShardSuccessDot
|
||||
PillTone.Warning -> ShardWarning
|
||||
PillTone.Danger -> ShardDanger
|
||||
PillTone.Neutral, PillTone.Info -> ShardFaint
|
||||
PillTone.Neutral, PillTone.Info -> LocalShardPalette.current.faint
|
||||
}
|
||||
Box(modifier.size(8.dp).clip(CircleShape).background(color))
|
||||
}
|
||||
@@ -95,7 +106,7 @@ fun SectionLabel(text: String, modifier: Modifier = Modifier) {
|
||||
Text(
|
||||
text = text.uppercase(),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = ShardFaint,
|
||||
color = LocalShardPalette.current.faint,
|
||||
modifier = modifier,
|
||||
)
|
||||
}
|
||||
@@ -104,6 +115,11 @@ fun SectionLabel(text: String, modifier: 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].
|
||||
*
|
||||
* The radius is `MaterialTheme.shapes.medium` rather than the literal 12dp it was
|
||||
* built with — the same value, now following `--radius-card`'s ratio (§5.2). The
|
||||
* shadow this doc always claimed is finally drawn, at the depth `--shadow-card`
|
||||
* resolves to (§5.4).
|
||||
*/
|
||||
@Composable
|
||||
fun FeatureCard(
|
||||
@@ -111,17 +127,40 @@ fun FeatureCard(
|
||||
contentPadding: Int = 18,
|
||||
content: @Composable ColumnScope.() -> Unit,
|
||||
) {
|
||||
val palette = LocalShardPalette.current
|
||||
val shape = MaterialTheme.shapes.medium
|
||||
Box(
|
||||
modifier = modifier
|
||||
.fillMaxWidth()
|
||||
.clip(RoundedCornerShape(12.dp))
|
||||
.background(Brush.verticalGradient(listOf(ShardCardTop, ShardCardBottom)))
|
||||
.border(1.dp, ShardOutline, RoundedCornerShape(12.dp)),
|
||||
.shadow(LocalShardStructure.current.cardElevation, shape)
|
||||
.clip(shape)
|
||||
.background(Brush.verticalGradient(listOf(palette.cardTop, palette.cardBottom)))
|
||||
.border(1.dp, palette.outline, shape),
|
||||
) {
|
||||
Column(Modifier.padding(contentPadding.dp), content = content)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A Material [Card] at the shard's resolved depth — the app's standard card, and
|
||||
* the reason every screen's `Card(` became a `ShardCard(`.
|
||||
*
|
||||
* `Card` takes its elevation as a **default argument**, not from the theme, so
|
||||
* unlike the color scheme and the shape scale there is no way to make
|
||||
* `--shadow-card` reach ~24 call sites without a wrapper. Passing
|
||||
* [CardDefaults.cardElevation] at each site instead would have put the same line
|
||||
* in eighteen files and let one drift. A `Card(` outside this file is therefore a
|
||||
* card the shard cannot theme, which makes the invariant greppable.
|
||||
*/
|
||||
@Composable
|
||||
fun ShardCard(modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit) {
|
||||
Card(
|
||||
modifier = modifier,
|
||||
elevation = CardDefaults.cardElevation(defaultElevation = LocalShardStructure.current.cardElevation),
|
||||
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.
|
||||
@@ -129,13 +168,14 @@ fun FeatureCard(
|
||||
@Composable
|
||||
fun StatBar(fraction: Float, modifier: Modifier = Modifier) {
|
||||
val pct = fraction.coerceIn(0f, 1f)
|
||||
val palette = LocalShardPalette.current
|
||||
Box(
|
||||
modifier = modifier
|
||||
.fillMaxWidth()
|
||||
.height(6.dp)
|
||||
.clip(RoundedCornerShape(3.dp))
|
||||
.background(ShardElevated)
|
||||
.border(1.dp, ShardOutline, RoundedCornerShape(3.dp)),
|
||||
.background(palette.elevated)
|
||||
.border(1.dp, palette.outline, RoundedCornerShape(3.dp)),
|
||||
) {
|
||||
Box(
|
||||
Modifier
|
||||
|
||||
310
app/src/main/java/com/runicgateway/app/ui/events/EventScreen.kt
Normal file
310
app/src/main/java/com/runicgateway/app/ui/events/EventScreen.kt
Normal file
@@ -0,0 +1,310 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
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.width
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
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.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.data.api.dto.EventOccurrenceDto
|
||||
import com.runicgateway.app.data.api.dto.EventParticipantDto
|
||||
import com.runicgateway.app.data.api.dto.PublicEventDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.HtmlText
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.components.PillTone
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* One event's public page (EVENTS.md § API surface, M13).
|
||||
*
|
||||
* The storyline, its arc, what is live, what is next, what happened recently, and
|
||||
* a results table once an occurrence has published one.
|
||||
*
|
||||
* **The plan behind the event is never shown**, because the server never sends
|
||||
* it: a live run carries the LABEL of the phase it is in — resolved from the
|
||||
* version that run pinned, so an edit since does not relabel it — and nothing
|
||||
* else. Phases, steps and actions are the operator's.
|
||||
*/
|
||||
@Composable
|
||||
fun EventScreen(
|
||||
onOpenSeries: (String) -> Unit,
|
||||
onOpenRun: (String, Long) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: EventViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
// Error before content. Phase 13 found the inverse of this one tier along: a
|
||||
// `if (loading || !form)` spinner above the error branch left a failed load
|
||||
// spinning for ever with nothing on screen naming the problem.
|
||||
when (val s = state) {
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Success -> EventBody(s.data, onOpenSeries, onOpenRun, modifier)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun EventBody(
|
||||
event: PublicEventDto,
|
||||
onOpenSeries: (String) -> Unit,
|
||||
onOpenRun: (String, Long) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp),
|
||||
) {
|
||||
item(key = "head") {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
Text(
|
||||
text = event.title,
|
||||
style = MaterialTheme.typography.headlineSmall,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
event.summary?.takeIf { it.isNotBlank() }?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
event.series?.let { series ->
|
||||
Text(
|
||||
text = stringResource(R.string.events_part_of, series.name),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.primary,
|
||||
modifier = Modifier.clickable { onOpenSeries(series.slug) },
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The one fact a visitor came for, above the storyline rather than below
|
||||
// it: whether it is happening now, and if not, when it next is.
|
||||
item(key = "headline") { Headline(event) }
|
||||
|
||||
event.body?.takeIf { it.isNotBlank() }?.let { body ->
|
||||
item(key = "body") {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
// Sanitized on write, the treatment a wiki page and a forum
|
||||
// post already get.
|
||||
HtmlText(body, Modifier.padding(16.dp))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
event.results?.let { results ->
|
||||
item(key = "results-head") {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(2.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.events_results),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
Text(
|
||||
text = eventDateTime(results.scheduledFor, event.timezone),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
if (results.participants.isEmpty()) {
|
||||
item(key = "results-empty") {
|
||||
Text(
|
||||
text = stringResource(R.string.events_results_nobody),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
} else {
|
||||
items(results.participants.size, key = { "p$it" }) { index ->
|
||||
ParticipantRow(results.participants[index])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
occurrenceSection(
|
||||
key = "upcoming",
|
||||
titleRes = R.string.events_coming_up,
|
||||
list = event.upcoming,
|
||||
timezone = event.timezone,
|
||||
slug = event.slug,
|
||||
onOpenRun = onOpenRun,
|
||||
linkResults = false,
|
||||
)
|
||||
occurrenceSection(
|
||||
key = "past",
|
||||
titleRes = R.string.events_previously,
|
||||
list = event.past,
|
||||
timezone = event.timezone,
|
||||
slug = event.slug,
|
||||
onOpenRun = onOpenRun,
|
||||
linkResults = true,
|
||||
)
|
||||
|
||||
if (event.current == null && event.next == null && event.past.isEmpty()) {
|
||||
item(key = "unscheduled") {
|
||||
Text(
|
||||
text = stringResource(R.string.events_never_scheduled),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun Headline(event: PublicEventDto) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp), verticalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
val current = event.current
|
||||
when {
|
||||
event.live && current != null -> {
|
||||
StatusPill(
|
||||
text = stringResource(R.string.events_status_live),
|
||||
tone = PillTone.Success,
|
||||
)
|
||||
Text(
|
||||
// The phase LABEL, and only while it is live.
|
||||
text = current.phase?.takeIf { it.isNotBlank() }
|
||||
?: stringResource(R.string.events_under_way),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
}
|
||||
event.next != null -> {
|
||||
Text(
|
||||
text = stringResource(R.string.events_next),
|
||||
style = MaterialTheme.typography.labelMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
text = eventDateTime(event.next.scheduledFor, event.next.timezone ?: event.timezone),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
}
|
||||
else -> Text(
|
||||
text = stringResource(R.string.events_nothing_scheduled),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A titled list of occurrences, or nothing at all when there are none.
|
||||
*
|
||||
* `linkResults` is what separates the two calls: only a PAST occurrence that
|
||||
* actually published results gets its own tap target, because on any other one
|
||||
* `?run=` would change nothing a reader could see.
|
||||
*/
|
||||
private fun androidx.compose.foundation.lazy.LazyListScope.occurrenceSection(
|
||||
key: String,
|
||||
titleRes: Int,
|
||||
list: List<EventOccurrenceDto>,
|
||||
timezone: String?,
|
||||
slug: String,
|
||||
onOpenRun: (String, Long) -> Unit,
|
||||
linkResults: Boolean,
|
||||
) {
|
||||
if (list.isEmpty()) return
|
||||
item(key = "$key-title") {
|
||||
Text(
|
||||
text = stringResource(titleRes),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
}
|
||||
items(list.size, key = { "$key-${list[it].runId}" }) { index ->
|
||||
val occurrence = list[index]
|
||||
val tappable = linkResults && occurrence.resultsPublishedAt != null
|
||||
ShardCard(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.then(
|
||||
if (tappable) Modifier.clickable { onOpenRun(slug, occurrence.runId) }
|
||||
else Modifier,
|
||||
),
|
||||
) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = eventDateTime(occurrence.scheduledFor, occurrence.timezone ?: timezone),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
Text(
|
||||
text = stringResource(
|
||||
statusWordRes(occurrence.status, occurrence.scheduledFor),
|
||||
),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ParticipantRow(participant: EventParticipantDto) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth(),
|
||||
horizontalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = participant.rank?.toString() ?: "—",
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
textAlign = TextAlign.End,
|
||||
modifier = Modifier.width(32.dp),
|
||||
)
|
||||
Text(
|
||||
// A module supplies a display name in its participation meta or it does
|
||||
// not; the member key is never published, so there is genuinely nothing
|
||||
// else to render.
|
||||
text = participant.name?.takeIf { it.isNotBlank() }
|
||||
?: stringResource(R.string.events_participant_unnamed),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
Text(
|
||||
text = scoreText(participant.score),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
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.width
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
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.text.style.TextAlign
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
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.ShardCard
|
||||
|
||||
/**
|
||||
* One arc (EVENTS.md §I, M13).
|
||||
*
|
||||
* **The arc is the thing the tooling this replaces could not express at all.** A
|
||||
* calendar plugin has no series field, so "Royal Spy Mission → Risky Partner →
|
||||
* Message From the Void" existed only in a GM's head and in whatever the forum
|
||||
* post said. This screen is that continuity, in the order an editor arranged it —
|
||||
* which is why the events are numbered rather than dated: an arc has an order, and
|
||||
* its parts may be months apart or run out of sequence.
|
||||
*/
|
||||
@Composable
|
||||
fun EventSeriesScreen(
|
||||
onOpenEvent: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: EventSeriesViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
// Error first, then loading — the order Phase 13 had to fix one tier along.
|
||||
when (val s = state) {
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Success -> {
|
||||
val series = s.data
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp),
|
||||
) {
|
||||
item(key = "head") {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
Text(
|
||||
text = series.name,
|
||||
style = MaterialTheme.typography.headlineSmall,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
series.description?.takeIf { it.isNotBlank() }?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
items(series.events.size, key = { series.events[it].slug }) { index ->
|
||||
val entry = series.events[index]
|
||||
ShardCard(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable { onOpenEvent(entry.slug) },
|
||||
) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(14.dp),
|
||||
) {
|
||||
Text(
|
||||
text = (index + 1).toString(),
|
||||
style = MaterialTheme.typography.headlineSmall,
|
||||
color = MaterialTheme.colorScheme.primary,
|
||||
textAlign = TextAlign.End,
|
||||
modifier = Modifier.width(32.dp),
|
||||
)
|
||||
Column(verticalArrangement = Arrangement.spacedBy(4.dp)) {
|
||||
Text(
|
||||
text = entry.title,
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
entry.summary?.takeIf { it.isNotBlank() }?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.EventSeriesDto
|
||||
import com.runicgateway.app.data.repository.EventsRepository
|
||||
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
|
||||
|
||||
/**
|
||||
* One arc (PLAN.md §9 M13).
|
||||
*
|
||||
* A series with nothing listed in it answers 404 rather than an empty page, so
|
||||
* there is no "empty arc" state to render: the error branch is the whole of it,
|
||||
* and that is the server's decision rather than this screen's — an empty page
|
||||
* would publish that an operator has named something they have not announced.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class EventSeriesViewModel @Inject constructor(
|
||||
private val repository: EventsRepository,
|
||||
savedStateHandle: SavedStateHandle,
|
||||
) : ViewModel() {
|
||||
|
||||
private val slug: String = savedStateHandle.get<String>(Routes.Args.SLUG).orEmpty()
|
||||
|
||||
private val _state = MutableStateFlow<UiState<EventSeriesDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<EventSeriesDto>> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = repository.series(slug).toUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
166
app/src/main/java/com/runicgateway/app/ui/events/EventTimes.kt
Normal file
166
app/src/main/java/com/runicgateway/app/ui/events/EventTimes.kt
Normal file
@@ -0,0 +1,166 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.time.parseWireInstant
|
||||
import java.time.Instant
|
||||
import java.time.ZoneId
|
||||
import java.time.format.DateTimeFormatter
|
||||
import java.time.format.FormatStyle
|
||||
import java.util.Locale
|
||||
|
||||
/**
|
||||
* Rendering an event's instant and its status word (EVENTS.md §I).
|
||||
*
|
||||
* Everything here is pure and takes its clock, zone and locale as parameters, so
|
||||
* the rules below are unit-tested off-device rather than eyeballed on one.
|
||||
*
|
||||
* ## The split, which is the one thing about event times that is easy to get wrong
|
||||
*
|
||||
* The server returns UTC instants and never guesses the reader's zone. The client
|
||||
* places them, and it places the two halves differently:
|
||||
*
|
||||
* - the **day** an entry is filed under is the READER's own — "what is on this
|
||||
* month" is a question about the month the person holding the phone is living
|
||||
* in;
|
||||
* - the **time** beside it is always the EVENT's zone, carried on the entry —
|
||||
* because every listing this feature replaces is written in the shard's local
|
||||
* zone, and "8pm" means the shard's evening to everyone reading it.
|
||||
*
|
||||
* Rendering the time in the reader's zone instead is defensible and wrong here: a
|
||||
* player in Berlin told an American shard's event is at 02:00 has been told
|
||||
* something true and useless, and told it in a way that makes the shard's own
|
||||
* announcement look like a mistake.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A participation score, as a reader should see it.
|
||||
*
|
||||
* Scores are `DECIMAL(18,4)` on the wire because a module may score by distance,
|
||||
* time or a weighted tally — but most score by counting, and rendering a plain
|
||||
* tally of kills as `12.0` reads as a rounding artefact. So a whole number prints
|
||||
* whole and a fraction keeps its digits, with trailing zeros trimmed: `1420`,
|
||||
* `318.5`, `0.25`.
|
||||
*/
|
||||
fun scoreText(score: Double, locale: Locale = Locale.getDefault()): String {
|
||||
if (!score.isFinite()) return "0"
|
||||
if (score == Math.floor(score) && Math.abs(score) < 1e15) {
|
||||
return String.format(locale, "%d", score.toLong())
|
||||
}
|
||||
return String.format(locale, "%.4f", score).trimEnd('0').trimEnd('.', ',')
|
||||
}
|
||||
|
||||
/** The event's own wall clock, with the zone named so it misreads as nothing. */
|
||||
fun eventTime(
|
||||
instant: String?,
|
||||
timezone: String?,
|
||||
locale: Locale = Locale.getDefault(),
|
||||
): String {
|
||||
val at = parseWireInstant(instant) ?: return ""
|
||||
val zone = eventZone(timezone)
|
||||
val time = DateTimeFormatter.ofPattern("HH:mm", locale).withZone(zone).format(at)
|
||||
return "$time ${shortZone(timezone)}"
|
||||
}
|
||||
|
||||
/**
|
||||
* The event's own day and time together, for a screen showing one occurrence.
|
||||
*
|
||||
* Localized rather than patterned, because a full date's field order is the
|
||||
* locale's business; only the zone stays the event's.
|
||||
*/
|
||||
fun eventDateTime(
|
||||
instant: String?,
|
||||
timezone: String?,
|
||||
locale: Locale = Locale.getDefault(),
|
||||
): String {
|
||||
val at = parseWireInstant(instant) ?: return ""
|
||||
val zone = eventZone(timezone)
|
||||
val text = DateTimeFormatter
|
||||
.ofLocalizedDateTime(FormatStyle.MEDIUM, FormatStyle.SHORT)
|
||||
.withLocale(locale)
|
||||
.withZone(zone)
|
||||
.format(at)
|
||||
return "$text ${shortZone(timezone)}"
|
||||
}
|
||||
|
||||
/** The reader's own day, for the heading an entry is filed under. */
|
||||
fun readerDayLabel(
|
||||
instant: String?,
|
||||
zone: ZoneId = ZoneId.systemDefault(),
|
||||
locale: Locale = Locale.getDefault(),
|
||||
): String {
|
||||
val at = parseWireInstant(instant) ?: return ""
|
||||
return DateTimeFormatter
|
||||
.ofLocalizedDate(FormatStyle.FULL)
|
||||
.withLocale(locale)
|
||||
.withZone(zone)
|
||||
.format(at)
|
||||
}
|
||||
|
||||
/**
|
||||
* The zone as a reader recognises it: `America/New_York` → `New York`.
|
||||
*
|
||||
* Not the abbreviation (`EDT`), which is unstable across the year and unknown to
|
||||
* most readers of a shard in another country.
|
||||
*/
|
||||
fun shortZone(timezone: String?): String {
|
||||
if (timezone.isNullOrBlank()) return "UTC"
|
||||
return timezone.substringAfterLast('/').replace('_', ' ')
|
||||
}
|
||||
|
||||
/**
|
||||
* The event's zone, or UTC when its column holds something `java.time` will not
|
||||
* read.
|
||||
*
|
||||
* A typo in a definition's timezone must still render: UTC off the instant is the
|
||||
* honest answer when the zone cannot be honoured, and it is what the web client
|
||||
* falls back to for the same reason.
|
||||
*/
|
||||
private fun eventZone(timezone: String?): ZoneId = try {
|
||||
if (timezone.isNullOrBlank()) ZoneId.of("UTC") else ZoneId.of(timezone)
|
||||
} catch (_: Exception) {
|
||||
ZoneId.of("UTC")
|
||||
}
|
||||
|
||||
/**
|
||||
* The word beside an occurrence, for the four statuses the server publishes.
|
||||
*
|
||||
* **`cancelled` needs the instant, and that is the whole reason this takes one.**
|
||||
* The server publishes `failed` and `missed` as `cancelled` too — to a visitor the
|
||||
* three are one event, and the difference between them is about the deployment —
|
||||
* but the three do not share one English sentence. *Did not happen* is right for a
|
||||
* past occurrence and a plain falsehood for a future one, and a run four days out
|
||||
* that an operator has called off is exactly the common case: this is the defect
|
||||
* Phase 14a's own calendar shipped and the live walk caught, which is why it is
|
||||
* restated here rather than ported.
|
||||
*
|
||||
* So **the tense follows the clock, not the status**. A future call-off reads
|
||||
* *Cancelled*; a past one reads *Did not happen*, which is also the honest word
|
||||
* for the failed and missed runs folded in with it.
|
||||
*
|
||||
* An unrecognised status reads *Scheduled*, mirroring the server's own fallback:
|
||||
* `publicStatus()` folds anything it does not know to `scheduled`, so a word the
|
||||
* app has never seen is a contract break rather than a state, and rendering a raw
|
||||
* enum at a reader is not an improvement on it.
|
||||
*/
|
||||
@StringRes
|
||||
fun statusWordRes(status: String?, scheduledFor: String?, now: Instant = Instant.now()): Int =
|
||||
when (status) {
|
||||
"live" -> R.string.events_status_live
|
||||
"completed" -> R.string.events_status_completed
|
||||
"cancelled" -> {
|
||||
val at = parseWireInstant(scheduledFor)
|
||||
// An unreadable instant is treated as past, which is the safer of the
|
||||
// two: "did not happen" about something unplaceable in time is vague,
|
||||
// while "cancelled" about a past run implies it is still coming.
|
||||
if (at != null && at.isAfter(now)) {
|
||||
R.string.events_status_cancelled
|
||||
} else {
|
||||
R.string.events_status_did_not_happen
|
||||
}
|
||||
}
|
||||
else -> R.string.events_status_scheduled
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.PublicEventDto
|
||||
import com.runicgateway.app.data.repository.EventsRepository
|
||||
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
|
||||
|
||||
/**
|
||||
* One event's page (PLAN.md §9 M13, EVENTS.md § API surface).
|
||||
*
|
||||
* **`run` is read from the route and passed through untouched**, because that is
|
||||
* what an announcement's link carries. The page lives at the definition's slug —
|
||||
* one stable address, so a link posted in Discord survives a retitle — and the
|
||||
* occurrence has to be in the query or a mail about last Friday's invasion would
|
||||
* open next Friday's.
|
||||
*
|
||||
* A run that belongs to some other event is **not** filtered here. The server
|
||||
* ignores it and answers with this event anyway, which turns a stale link in a
|
||||
* months-old mail into the page it was about rather than a dead end; second-
|
||||
* guessing that would undo it.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class EventViewModel @Inject constructor(
|
||||
private val repository: EventsRepository,
|
||||
savedStateHandle: SavedStateHandle,
|
||||
) : ViewModel() {
|
||||
|
||||
private val slug: String = savedStateHandle.get<String>(Routes.Args.SLUG).orEmpty()
|
||||
|
||||
/** Null unless the route carried one; never an empty string forwarded to the server. */
|
||||
private val run: String? = savedStateHandle.get<String>(Routes.Args.RUN)?.takeIf { it.isNotBlank() }
|
||||
|
||||
private val _state = MutableStateFlow<UiState<PublicEventDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<PublicEventDto>> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = repository.event(slug, run).toUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
191
app/src/main/java/com/runicgateway/app/ui/events/EventsScreen.kt
Normal file
191
app/src/main/java/com/runicgateway/app/ui/events/EventsScreen.kt
Normal file
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
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.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.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.EventCalendarEntryDto
|
||||
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.PillTone
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* The public event calendar (EVENTS.md §I, M13).
|
||||
*
|
||||
* **A list, not a month grid**, which is the same call the web client makes and
|
||||
* for the same reason: an operator's question is "what does this month look
|
||||
* like" — coverage, clashes, the gap on the third weekend — and a grid answers
|
||||
* it. A visitor's question is "what is on, and when is the next one", which a
|
||||
* chronological list answers in one glance and a grid answers by making them
|
||||
* count squares. On a phone the grid is not even a close second.
|
||||
*
|
||||
* **A projection is drawn differently from a run**, one tier along from the
|
||||
* operator's own reason for the distinction: past the materialisation horizon
|
||||
* there is no row, nothing is committed to, and nothing can be cancelled. Drawing
|
||||
* a forecast identically to a booking would be the screen promising something the
|
||||
* server has not.
|
||||
*/
|
||||
@Composable
|
||||
fun EventsScreen(
|
||||
onOpenEvent: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: EventsViewModel = 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 -> {
|
||||
val entries = s.data.entries
|
||||
if (entries.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.events_empty), modifier)
|
||||
} else {
|
||||
Calendar(entries, s.data.truncated, onOpenEvent, modifier)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Group by the READER's day, preserving the server's order rather than re-sorting.
|
||||
*
|
||||
* Internal + pure so the grouping — and the fact that it never reorders — is
|
||||
* unit-tested without Compose.
|
||||
*/
|
||||
internal fun groupByReaderDay(entries: List<EventCalendarEntryDto>): List<CalendarDayGroup> {
|
||||
val days = mutableListOf<CalendarDayGroup>()
|
||||
for (entry in entries) {
|
||||
val label = readerDayLabel(entry.scheduledFor)
|
||||
val last = days.lastOrNull()
|
||||
if (last != null && last.label == label) {
|
||||
last.entries.add(entry)
|
||||
} else {
|
||||
days.add(CalendarDayGroup(label, mutableListOf(entry)))
|
||||
}
|
||||
}
|
||||
return days
|
||||
}
|
||||
|
||||
/** A mutable builder shape for [groupByReaderDay]; the screen only reads it. */
|
||||
internal data class CalendarDayGroup(
|
||||
val label: String,
|
||||
val entries: MutableList<EventCalendarEntryDto>,
|
||||
)
|
||||
|
||||
@Composable
|
||||
private fun Calendar(
|
||||
entries: List<EventCalendarEntryDto>,
|
||||
truncated: Boolean,
|
||||
onOpenEvent: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
val days = groupByReaderDay(entries)
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = androidx.compose.foundation.layout.PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp),
|
||||
) {
|
||||
days.forEach { day ->
|
||||
item(key = "day-${day.label}") {
|
||||
Text(
|
||||
text = day.label,
|
||||
style = MaterialTheme.typography.labelLarge,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
items(
|
||||
items = day.entries,
|
||||
key = { "${it.slug}-${it.scheduledFor}-${it.kind}" },
|
||||
) { entry ->
|
||||
EntryCard(entry, onOpenEvent)
|
||||
}
|
||||
}
|
||||
if (truncated) {
|
||||
item(key = "truncated") {
|
||||
Text(
|
||||
text = stringResource(R.string.events_truncated),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun EntryCard(entry: EventCalendarEntryDto, onOpenEvent: (String) -> Unit) {
|
||||
ShardCard(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
// A projection has a page too — the definition's — so it opens like any
|
||||
// other entry. What it does not have is an occurrence to link to.
|
||||
.clickable { onOpenEvent(entry.slug) },
|
||||
) {
|
||||
Column(Modifier.padding(16.dp), verticalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth(),
|
||||
horizontalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = entry.title,
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
StatusPill(
|
||||
text = stringResource(statusWordRes(entry.status, entry.scheduledFor)),
|
||||
tone = if (entry.live) PillTone.Success else PillTone.Neutral,
|
||||
)
|
||||
}
|
||||
Text(
|
||||
text = eventTime(entry.scheduledFor, entry.timezone),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
entry.seriesName?.takeIf { it.isNotBlank() }?.let { series ->
|
||||
Text(
|
||||
text = series,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
if (entry.isProjected) {
|
||||
// Said in words rather than drawn as a dashed border, because a
|
||||
// phone reader skimming a list will not decode a border and the
|
||||
// distinction is worth more than the pixel it would cost.
|
||||
Text(
|
||||
text = stringResource(R.string.events_projected),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
fontStyle = FontStyle.Italic,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.EventCalendarDto
|
||||
import com.runicgateway.app.data.repository.EventsRepository
|
||||
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 event calendar (PLAN.md §9 M13, EVENTS.md §I).
|
||||
*
|
||||
* **No window is asked for**, and that is the whole of this view model's design.
|
||||
* The server's default is now through 31 days out, so a client that computed a
|
||||
* window before it could ask anything would make every deep link carry two ISO
|
||||
* instants and would have to agree with the server about what "now" is. The
|
||||
* window bound and the entry cap are the server's defence on the one surface with
|
||||
* no login in front of it; there is nothing for the app to add.
|
||||
*
|
||||
* `toUiState`, not `toShardUiState`: these are CORE routes. A 404 here means the
|
||||
* backend has no events at all, not that an admin switched a shard surface off,
|
||||
* and offering "not published here" for it would name the wrong cause.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class EventsViewModel @Inject constructor(
|
||||
private val repository: EventsRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _state = MutableStateFlow<UiState<EventCalendarDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<EventCalendarDto>> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = repository.calendar().toUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
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.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.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.style.TextAlign
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.EventHistoryEntryDto
|
||||
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.ShardCard
|
||||
|
||||
/**
|
||||
* This account's event participation (EVENTS.md §J, M13).
|
||||
*
|
||||
* **The screen's one real design decision is what an unranked row says.** A run
|
||||
* whose participants were collected but whose results have not been published has
|
||||
* a score and no rank, and that is a real state rather than an error — it is the
|
||||
* same state the admin run console has shown since events Phase 10. Rendering a
|
||||
* dash with nothing explaining it would read as a bug; the row says the results
|
||||
* are not published, which is a fact about the event rather than about the reader.
|
||||
*
|
||||
* Reached by **one drawer row for every signed-in account**, players and staff
|
||||
* alike. The website mounts this twice only because its `RequirePlayer` guard sits
|
||||
* over `/account` and the route behind it is role-agnostic; the app has no such
|
||||
* wall, so it needs no second mount.
|
||||
*/
|
||||
@Composable
|
||||
fun MyEventsScreen(
|
||||
onOpenRun: (String, Long) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: MyEventsViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
when (val items = state.items) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Error -> ErrorView(items.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
is UiState.Success -> if (items.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.events_history_empty), modifier)
|
||||
} else {
|
||||
androidx.compose.foundation.lazy.LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp),
|
||||
) {
|
||||
items(items.data.size, key = { items.data[it].id }) { index ->
|
||||
HistoryRow(items.data[index], onOpenRun)
|
||||
}
|
||||
if (state.hasMore) {
|
||||
item(key = "more") {
|
||||
TextButton(
|
||||
onClick = viewModel::loadMore,
|
||||
enabled = !state.loadingMore,
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
) {
|
||||
Text(
|
||||
stringResource(
|
||||
if (state.loadingMore) R.string.events_loading
|
||||
else R.string.events_show_more,
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun HistoryRow(entry: EventHistoryEntryDto, onOpenRun: (String, Long) -> Unit) {
|
||||
ShardCard(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
// Straight to the occurrence the reader took part in, not to whatever
|
||||
// is next: `?run=` is what makes the event page answer about this one.
|
||||
.clickable { onOpenRun(entry.slug, entry.runId) },
|
||||
) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Column(Modifier.weight(1f), verticalArrangement = Arrangement.spacedBy(4.dp)) {
|
||||
Text(
|
||||
text = entry.title,
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
)
|
||||
Text(
|
||||
text = eventDateTime(entry.scheduledFor, entry.timezone),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
entry.seriesName?.takeIf { it.isNotBlank() }?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
Column(horizontalAlignment = Alignment.End) {
|
||||
Text(
|
||||
text = entry.rank
|
||||
?.let { stringResource(R.string.events_rank, it) }
|
||||
?: stringResource(R.string.events_results_unpublished),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurface,
|
||||
textAlign = TextAlign.End,
|
||||
)
|
||||
Text(
|
||||
text = stringResource(R.string.events_score, scoreText(entry.score)),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.events
|
||||
|
||||
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.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.EventHistoryEntryDto
|
||||
import com.runicgateway.app.data.repository.EventsRepository
|
||||
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.distinctUntilChanged
|
||||
import kotlinx.coroutines.flow.map
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* This account's event participation (PLAN.md §9 M13, EVENTS.md §J).
|
||||
*
|
||||
* **Self-scoped by the session and nothing else.** There is no id parameter on
|
||||
* the route and deliberately none here: one account never reads another's, and
|
||||
* there is no argument that could later grow into one.
|
||||
*
|
||||
* **Keyset-paged on the participation row's own id, never an offset** — the list
|
||||
* gains a row every time the reader attends something, so an offset page would
|
||||
* skip and repeat rows around the seam.
|
||||
*
|
||||
* ## Why this watches the session, when no other screen here does
|
||||
*
|
||||
* **A drawer route's view model outlives a sign-out.** `navigateTopLevel` saves
|
||||
* and restores back-stack state, so the `NavBackStackEntry` for this route keeps
|
||||
* its `ViewModelStore` across a sign-out and a sign-in as somebody else — and a
|
||||
* view model that loads only in `init` never runs again. The live walk found the
|
||||
* consequence: signing out of an admin account and back in as a player showed the
|
||||
* PLAYER the admin's participation history, with no request made at all.
|
||||
*
|
||||
* The public event screens have the same lifetime and do not care, because a
|
||||
* calendar is the same for everybody. This one is per-account, so the account is
|
||||
* what it keys on: the flow emits the current session immediately, which is also
|
||||
* the first load, and re-emits only when the signed-in id actually changes — a
|
||||
* resume revalidation returning the same user does not refetch.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class MyEventsViewModel @Inject constructor(
|
||||
private val repository: EventsRepository,
|
||||
sessionManager: SessionManager,
|
||||
) : ViewModel() {
|
||||
|
||||
data class State(
|
||||
val items: UiState<List<EventHistoryEntryDto>> = UiState.Loading,
|
||||
val hasMore: Boolean = false,
|
||||
val loadingMore: Boolean = false,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
sessionManager.state
|
||||
.map { (it as? Session.SignedIn)?.user?.id }
|
||||
.distinctUntilChanged()
|
||||
.collect { userId ->
|
||||
// Signed out: drop the rows rather than leave the last
|
||||
// account's on screen behind a shell that is about to
|
||||
// navigate away.
|
||||
if (userId == null) _state.value = State(items = UiState.Success(emptyList()))
|
||||
else load()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.value = State()
|
||||
viewModelScope.launch {
|
||||
val result = repository.history(PAGE)
|
||||
_state.value = State(
|
||||
items = result.toUiState(),
|
||||
// A full page means there is probably another; a short one is the
|
||||
// end. One request rather than a count the server does not send.
|
||||
hasMore = (result as? ApiResult.Ok)?.data?.size == PAGE,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
fun loadMore() {
|
||||
val current = _state.value
|
||||
val shown = (current.items as? UiState.Success)?.data ?: return
|
||||
val last = shown.lastOrNull() ?: return
|
||||
if (current.loadingMore || !current.hasMore) return
|
||||
|
||||
_state.value = current.copy(loadingMore = true)
|
||||
viewModelScope.launch {
|
||||
when (val result = repository.history(PAGE, before = last.id)) {
|
||||
is ApiResult.Ok -> _state.value = State(
|
||||
items = UiState.Success(shown + result.data),
|
||||
hasMore = result.data.size == PAGE,
|
||||
)
|
||||
// A failed NEXT page keeps the pages already read rather than
|
||||
// replacing a screenful of history with an error: the reader can
|
||||
// still see what loaded, and tapping again retries.
|
||||
else -> _state.value = current.copy(loadingMore = false)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private companion object {
|
||||
const val PAGE = 25
|
||||
}
|
||||
}
|
||||
@@ -26,6 +26,7 @@ import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.BrandDto
|
||||
import com.runicgateway.app.data.api.dto.StatusDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.BrandHero
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.FeatureCard
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
@@ -59,6 +60,12 @@ private fun HomeContent(brand: BrandDto?, status: StatusDto, modifier: Modifier
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(20.dp),
|
||||
) {
|
||||
// The instance's hero above the title block (§5.6) — Home is the one screen
|
||||
// with a hero-shaped space. Its bottom gap rides on the image's own modifier
|
||||
// rather than a Spacer, so an instance with no hero (or one whose hero fails
|
||||
// to load) opens on the title exactly where it has always been.
|
||||
BrandHero(hero = brand?.hero, modifier = Modifier.padding(bottom = 16.dp))
|
||||
|
||||
Text(
|
||||
text = brand?.name?.takeIf { it.isNotBlank() } ?: stringResource(R.string.app_name),
|
||||
style = MaterialTheme.typography.headlineMedium,
|
||||
|
||||
@@ -6,6 +6,12 @@ package com.runicgateway.app.ui.navigation
|
||||
import androidx.annotation.StringRes
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.auth.Session
|
||||
import com.runicgateway.app.data.repository.Capability
|
||||
import com.runicgateway.app.data.repository.ShardFeature
|
||||
import com.runicgateway.app.data.repository.ShardFeatures
|
||||
import com.runicgateway.app.data.repository.SiteCapabilities
|
||||
import com.runicgateway.app.data.repository.canSee
|
||||
import com.runicgateway.app.data.repository.canUse
|
||||
|
||||
/**
|
||||
* One shared, declarative, access-level navigation definition (PLAN.md §5): a
|
||||
@@ -40,6 +46,38 @@ data class MenuEntry(
|
||||
val route: String,
|
||||
@param:StringRes val labelRes: Int,
|
||||
val access: MenuAccess = MenuAccess.PUBLIC,
|
||||
/**
|
||||
* For a shard-derived surface, the visibility feature it belongs to (M11).
|
||||
*
|
||||
* Session role is not the only gate on these: an admin can switch a feature off
|
||||
* or raise its audience above the caller's rung, so the entry is filtered by
|
||||
* `GET /public/shard/features` as well as by [access]. `null` means the entry
|
||||
* isn't shard-derived and only [access] applies.
|
||||
*/
|
||||
val feature: String? = null,
|
||||
/**
|
||||
* The backend capability this row needs, or null when it needs none (M13).
|
||||
*
|
||||
* **A different question from [feature], which is why it is a second field
|
||||
* and not a wider one.** This asks whether the code behind the row is
|
||||
* *installed at all* — a per-HOST fact, from `GET /public/modules` and core's
|
||||
* own list — while [feature] asks whether this shard publishes that surface
|
||||
* to *this viewer*, which is per-viewer and admin-configurable. A site with no
|
||||
* game module has no `shard` capability and no shard rows, whoever is looking;
|
||||
* a site with one may still hide its market from anonymous visitors.
|
||||
*
|
||||
* The two also fail differently, and [canUse] is where that lives.
|
||||
*/
|
||||
val capability: String? = null,
|
||||
/**
|
||||
* An admin's own label for this row, from the shard's `nav_public` override
|
||||
* (THEMING_AND_NAV.md §6). Null — always, as coded — means [labelRes] stands.
|
||||
*
|
||||
* A label set this way is **not localized**: it is one string for every locale,
|
||||
* which is what an admin typing a label means, and it matches the website. It
|
||||
* only ever arrives via [applyNavOverrides]; nothing in [APP_MENU] sets it.
|
||||
*/
|
||||
val label: String? = null,
|
||||
)
|
||||
|
||||
/**
|
||||
@@ -50,15 +88,95 @@ data class MenuEntry(
|
||||
val APP_MENU: List<MenuEntry> = listOf(
|
||||
MenuEntry(Routes.HOME, R.string.menu_home),
|
||||
MenuEntry(Routes.NEWS, R.string.menu_news),
|
||||
// Events are CORE's, so this row is gated on core's own capability rather than
|
||||
// a module's: a site with no game module still has a calendar. Placed here to
|
||||
// match the website's own nav, where Events is the row after News.
|
||||
MenuEntry(Routes.EVENTS, R.string.menu_events, capability = Capability.EVENTS),
|
||||
MenuEntry(Routes.WIKI, R.string.menu_wiki),
|
||||
MenuEntry(Routes.SHARD, R.string.menu_shard),
|
||||
// The shard group. Every row needs the game module INSTALLED (one capability,
|
||||
// because that is the only question a capability can answer) and its own
|
||||
// feature published to this viewer (M11) — both, independently.
|
||||
MenuEntry(
|
||||
Routes.SHARD,
|
||||
R.string.menu_shard,
|
||||
feature = ShardFeature.STATUS,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
// Protocol 3.0 shard content (M11). Each hides when the shard doesn't publish it,
|
||||
// which for a brand-new install is every one of them until the plugin has swept.
|
||||
MenuEntry(
|
||||
Routes.SHARD_RULES,
|
||||
R.string.menu_rules,
|
||||
feature = ShardFeature.RULESET,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
MenuEntry(
|
||||
Routes.ATLAS,
|
||||
R.string.menu_atlas,
|
||||
feature = ShardFeature.ATLAS,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
MenuEntry(
|
||||
Routes.SHARD_LEADERBOARDS,
|
||||
R.string.menu_leaderboards,
|
||||
feature = ShardFeature.LEADERBOARDS,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
MenuEntry(
|
||||
Routes.SHARD_MARKET,
|
||||
R.string.menu_market,
|
||||
feature = ShardFeature.MARKET,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
// The Rust module (M14). ONE row, because the module's whole public surface is
|
||||
// one list and one page beneath it — `/rust` IS the server list, not a hub
|
||||
// above one.
|
||||
//
|
||||
// **No `feature`, and that is not an omission.** The visibility framework is
|
||||
// `module-uo`'s own (`shardVisibility`, six files under `module-uo/server/`
|
||||
// and none under core's), and §2.7 forbids a module importing another's — so
|
||||
// `module-rust` has no per-viewer visibility layer yet. Its phase 14 builds
|
||||
// one; until then these routes are public to everyone the site is public to,
|
||||
// and a `feature` here would be gating on a flag nothing publishes.
|
||||
MenuEntry(Routes.RUST, R.string.menu_rust, capability = Capability.RUST),
|
||||
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),
|
||||
// Participation history: SIGNED_IN, not PLAYER. The route is `requireAuth`
|
||||
// alone and self-scoped on the caller's own id, and the website needed two
|
||||
// mounts for it only because `RequirePlayer` guards `/account` there. Staff
|
||||
// attend events too, and event history is not game-linked data.
|
||||
MenuEntry(
|
||||
Routes.MY_EVENTS,
|
||||
R.string.menu_my_events,
|
||||
MenuAccess.SIGNED_IN,
|
||||
capability = Capability.EVENTS,
|
||||
),
|
||||
// These three read `/player/shard/*`, which is the SAME module's player mount —
|
||||
// so they need the capability for the same reason the public rows do. They
|
||||
// carry no `feature`, because the visibility framework covers the public
|
||||
// surfaces and these are self-service, gated by role and ownership instead.
|
||||
// That asymmetry is exactly why the live walk found them and the suite did
|
||||
// not: "a shard row" had been defined as "a row with a feature".
|
||||
MenuEntry(
|
||||
Routes.PLAYER_CHARACTERS,
|
||||
R.string.menu_my_characters,
|
||||
MenuAccess.PLAYER,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
MenuEntry(
|
||||
Routes.PLAYER_VENDORS,
|
||||
R.string.menu_my_vendors,
|
||||
MenuAccess.PLAYER,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
MenuEntry(
|
||||
Routes.PLAYER_HOUSES,
|
||||
R.string.menu_my_houses,
|
||||
MenuAccess.PLAYER,
|
||||
capability = Capability.SHARD,
|
||||
),
|
||||
// Staff operations (§1, M10) — revealed for staff roles; the backend re-checks every call.
|
||||
MenuEntry(Routes.ADMIN_DASHBOARD, R.string.menu_admin_dashboard, MenuAccess.STAFF),
|
||||
MenuEntry(Routes.ADMIN_CONTENT, R.string.menu_admin_content, MenuAccess.STAFF),
|
||||
@@ -67,16 +185,52 @@ val APP_MENU: List<MenuEntry> = listOf(
|
||||
)
|
||||
|
||||
/**
|
||||
* The entries the given [session] may see. Pure + side-effect-free so the access
|
||||
* gating is unit-tested without Compose.
|
||||
* The entries the given [session] may see, on a backend with these [capabilities]
|
||||
* and this shard's [features]. Pure + side-effect-free so the gating is unit-tested
|
||||
* without Compose.
|
||||
*
|
||||
* Three independent filters, and all three must pass:
|
||||
*
|
||||
* - [MenuEntry.access] against the session — who the caller is.
|
||||
* - [MenuEntry.capability] against what this backend serves — whether the code
|
||||
* behind the row is installed at all (M13). Per host.
|
||||
* - [MenuEntry.feature] against the shard's live visibility config — what this shard
|
||||
* publishes to this viewer (M11). Per viewer.
|
||||
*
|
||||
* **The last two both fail open on an unknown answer, but "unknown" means
|
||||
* different things to them.** A `null` [features] is unknown; so is a `null`
|
||||
* [capabilities] — but a *non-null* [capabilities] that does not name the string
|
||||
* is an ANSWER, and it hides. Without that, a site with no game module renders
|
||||
* five shard rows that each 404. See [canUse].
|
||||
*/
|
||||
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 || session.user.isStaff)
|
||||
MenuAccess.STAFF -> session is Session.SignedIn && session.user.isStaff
|
||||
MenuAccess.MODERATOR -> session is Session.SignedIn && session.user.isModerator
|
||||
}
|
||||
fun visibleEntries(
|
||||
entries: List<MenuEntry>,
|
||||
session: Session,
|
||||
features: ShardFeatures? = null,
|
||||
capabilities: SiteCapabilities? = null,
|
||||
): List<MenuEntry> = entries.filter { isEntryVisible(it, session, features, capabilities) }
|
||||
|
||||
/**
|
||||
* [visibleEntries] for a single entry — the same three filters, and the same
|
||||
* boundary. Split out because the drawer is a tree once an admin groups rows into
|
||||
* sections (§6.3): [pruneNav] applies this predicate inside a section as well, and
|
||||
* both callers must ask exactly one question or a sectioned row could be gated by
|
||||
* a rule its top-level twin is not.
|
||||
*/
|
||||
fun isEntryVisible(
|
||||
entry: MenuEntry,
|
||||
session: Session,
|
||||
features: ShardFeatures? = null,
|
||||
capabilities: SiteCapabilities? = null,
|
||||
): Boolean {
|
||||
val allowedByRole = when (entry.access) {
|
||||
MenuAccess.PUBLIC -> true
|
||||
MenuAccess.SIGNED_IN -> session is Session.SignedIn
|
||||
MenuAccess.PLAYER -> session is Session.SignedIn && (session.user.isPlayer || session.user.isStaff)
|
||||
MenuAccess.STAFF -> session is Session.SignedIn && session.user.isStaff
|
||||
MenuAccess.MODERATOR -> session is Session.SignedIn && session.user.isModerator
|
||||
}
|
||||
return allowedByRole &&
|
||||
canUse(capabilities, entry.capability) &&
|
||||
(entry.feature == null || canSee(features, entry.feature))
|
||||
}
|
||||
|
||||
@@ -0,0 +1,171 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
import kotlinx.serialization.json.JsonArray
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.JsonPrimitive
|
||||
import kotlinx.serialization.json.booleanOrNull
|
||||
import kotlinx.serialization.json.doubleOrNull
|
||||
|
||||
/**
|
||||
* Apply the admin's stored public-nav overrides to the app's coded menu
|
||||
* (THEMING_AND_NAV.md §6). The Kotlin counterpart of the website's
|
||||
* `client/src/lib/navOverrides.js`, narrowed to what a drawer can express.
|
||||
*
|
||||
* **This is presentation, never authorization.** An override carries `label`,
|
||||
* `order` and `hidden` and nothing else: it cannot introduce a route, cannot
|
||||
* touch [MenuEntry.access] or [MenuEntry.feature], and cannot un-hide anything —
|
||||
* `hidden: false` is simply the absence of hiding. [visibleEntries] therefore runs
|
||||
* **after** this merge, unchanged, and remains the actual boundary (§6.1, AC-3).
|
||||
*
|
||||
* Fail-safe throughout, matching the web: anything unrecognized — an unknown path,
|
||||
* a non-string label, a path the app doesn't surface in its menu — is ignored
|
||||
* rather than rejected, so a stale or hand-edited settings row degrades to the
|
||||
* coded menu instead of rendering a broken drawer.
|
||||
*/
|
||||
|
||||
/** A usable override for one menu row. Absent fields mean "as coded". */
|
||||
internal data class NavOverride(
|
||||
val label: String? = null,
|
||||
val order: Double? = null,
|
||||
val hidden: Boolean = false,
|
||||
/**
|
||||
* The id of the section this row was dropped into, or null for a top-level
|
||||
* row. Read here but honored only by the tree build (`NavTree.kt`) — the flat
|
||||
* [applyNavOverrides] has nowhere to put it. Not validated against the stored
|
||||
* sections here; that is the tree's job, since only it knows them.
|
||||
*/
|
||||
val section: String? = null,
|
||||
) {
|
||||
/**
|
||||
* Nothing a **flat** list can express. [section] is deliberately not part of
|
||||
* this: to [applyNavOverrides] a section-only override says nothing, so an
|
||||
* instance that only ever grouped rows still gets its coded list back by
|
||||
* identity. The tree build adds its own check.
|
||||
*/
|
||||
val isEmpty: Boolean get() = label == null && order == null && !hidden
|
||||
}
|
||||
|
||||
/**
|
||||
* The `items` map out of a stored `nav_public` value.
|
||||
*
|
||||
* Two shapes exist, because website phase 10 added sections and links without
|
||||
* migrating what phases 6-8 had already stored: `{items, sections, links}` and a
|
||||
* bare map of path → override. A bare map is unambiguous — every key is a path,
|
||||
* so a key can never be the string `items`.
|
||||
*
|
||||
* `sections` and `links` come out of the same wrapper, and only ever out of the
|
||||
* wrapped shape — see [sectionsOf] and [linksOf].
|
||||
*/
|
||||
internal fun itemsOf(navPublic: JsonObject?): Map<String, JsonObject> {
|
||||
if (navPublic == null) return emptyMap()
|
||||
val items = wrapperOf(navPublic)?.get("items") as? JsonObject ?: navPublic
|
||||
return items.entries
|
||||
.mapNotNull { (key, value) -> (value as? JsonObject)?.let { key to it } }
|
||||
.toMap()
|
||||
}
|
||||
|
||||
/**
|
||||
* The stored value as the wrapped `{items, sections, links}` shape, or null when
|
||||
* it is the bare items map phases 6-8 wrote. The discriminator is the web's: an
|
||||
* `items` **object**, which a bare map can never carry because every key in one is
|
||||
* a path.
|
||||
*/
|
||||
private fun wrapperOf(navPublic: JsonObject?): JsonObject? =
|
||||
navPublic?.takeIf { it["items"] is JsonObject }
|
||||
|
||||
internal fun sectionsOf(navPublic: JsonObject?): List<JsonObject> = jsonObjectsAt(navPublic,"sections")
|
||||
|
||||
internal fun linksOf(navPublic: JsonObject?): List<JsonObject> = jsonObjectsAt(navPublic,"links")
|
||||
|
||||
private fun jsonObjectsAt(navPublic: JsonObject?, key: String): List<JsonObject> =
|
||||
(wrapperOf(navPublic)?.get(key) as? JsonArray)
|
||||
?.mapNotNull { it as? JsonObject }
|
||||
.orEmpty()
|
||||
|
||||
// Field by field, like every other read in M12: a bad `label` must not discard a
|
||||
// good `order` beside it.
|
||||
//
|
||||
// `group` is ignored — it names a section of the *admin sidebar*, a nav the app
|
||||
// never renders, and a value it cannot honor is better dropped than half-applied.
|
||||
internal fun cleanOverride(raw: JsonObject): NavOverride {
|
||||
val label = (raw["label"] as? JsonPrimitive)
|
||||
?.takeIf { it.isString }
|
||||
?.content
|
||||
?.trim()
|
||||
?.takeIf { it.isNotEmpty() }
|
||||
val order = (raw["order"] as? JsonPrimitive)
|
||||
?.takeIf { !it.isString }
|
||||
?.doubleOrNull
|
||||
?.takeIf { it.isFinite() }
|
||||
val hidden = (raw["hidden"] as? JsonPrimitive)
|
||||
?.takeIf { !it.isString }
|
||||
?.booleanOrNull == true
|
||||
val section = (raw["section"] as? JsonPrimitive)
|
||||
?.takeIf { it.isString }
|
||||
?.content
|
||||
?.takeIf { it.isNotEmpty() }
|
||||
return NavOverride(label = label, order = order, hidden = hidden, section = section)
|
||||
}
|
||||
|
||||
/**
|
||||
* [base] with the admin's overrides applied: rows relabeled, reordered and
|
||||
* dropped as the stored row asks.
|
||||
*
|
||||
* @param base the coded menu — the only source of `route`, `access` and `feature`
|
||||
* @param navPublic the parsed `nav_public` row, or null when the admin never
|
||||
* edited the nav. Null, malformed, and "nothing usable in it" all return [base]
|
||||
* itself, which is what makes an untouched instance's drawer provably today's
|
||||
* (§2, AC-1).
|
||||
*/
|
||||
fun applyNavOverrides(base: List<MenuEntry>, navPublic: JsonObject?): List<MenuEntry> {
|
||||
val items = itemsOf(navPublic)
|
||||
if (items.isEmpty()) return base
|
||||
|
||||
val coded = base.map { it.route }.toSet()
|
||||
// Keyed by app route, and only for a route the coded menu actually declares.
|
||||
// This is where an override for a path the app doesn't surface in its drawer —
|
||||
// a news category tab, a Shard hub board — is dropped (§6.2). The web does the
|
||||
// same with an unknown `to`.
|
||||
val overrides = buildMap {
|
||||
for ((path, raw) in items) {
|
||||
val route = appRouteForWebPath(path) ?: continue
|
||||
if (route !in coded) continue
|
||||
val override = cleanOverride(raw)
|
||||
if (!override.isEmpty) put(route, override)
|
||||
}
|
||||
}
|
||||
if (overrides.isEmpty()) return base
|
||||
|
||||
// Rows the website's nav knows about are the ones an override can move; the
|
||||
// app's own surfaces (Contact, Account, the player groups, the staff rows)
|
||||
// have no counterpart to be reordered against and keep their coded order,
|
||||
// appended after the public block — which is exactly where they sit today, so
|
||||
// this partition is the current layout rather than a new one (§6.2).
|
||||
val (mapped, appOnly) = base.partition { it.route in WEB_ROUTE_ORDER }
|
||||
|
||||
val sorted = mapped
|
||||
// An untouched row's sort key is its index in the WEBSITE's nav, not the
|
||||
// app's: a stored `order` is a position in that list, so both keys have to
|
||||
// sit on one number line to be comparable at all.
|
||||
//
|
||||
// Two tie-breaks, the web's: an explicit order beats a coincidental index
|
||||
// (the admin said "first", so first), and two explicit orders keep code
|
||||
// order, because the sort is stable.
|
||||
.sortedWith(
|
||||
compareBy<MenuEntry> { entry ->
|
||||
overrides[entry.route]?.order ?: WEB_ROUTE_ORDER.getValue(entry.route).toDouble()
|
||||
}.thenByDescending { overrides[it.route]?.order != null },
|
||||
)
|
||||
|
||||
return (sorted + appOnly).mapNotNull { entry ->
|
||||
val override = overrides[entry.route] ?: return@mapNotNull entry
|
||||
when {
|
||||
override.hidden -> null
|
||||
override.label != null -> entry.copy(label = override.label)
|
||||
else -> entry
|
||||
}
|
||||
}
|
||||
}
|
||||
358
app/src/main/java/com/runicgateway/app/ui/navigation/NavPaths.kt
Normal file
358
app/src/main/java/com/runicgateway/app/ui/navigation/NavPaths.kt
Normal file
@@ -0,0 +1,358 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
import com.runicgateway.app.data.repository.ContentRepository.PostCategory
|
||||
|
||||
/**
|
||||
* The website path → app route table (THEMING_AND_NAV.md §6.2).
|
||||
*
|
||||
* The public nav an admin edits is keyed by **website** paths, so honoring it in
|
||||
* the app needs a translation. This is the one new piece of cross-repo coupling
|
||||
* the milestone introduces, which is why it lives in a single file with the
|
||||
* website's own arrays quoted right beside it — the coupling is visible and
|
||||
* reviewable in one place rather than spread across the drawer's call sites.
|
||||
*
|
||||
* ## The nav is TWO arrays now, and that is what M13 had to correct
|
||||
*
|
||||
* This file was written when the website's public nav was one sixteen-row array.
|
||||
* Since the module-system cutover on 2026-08-12 it is **core's eight rows plus
|
||||
* every installed module's**, interleaved at render time by `withModuleNav`, and
|
||||
* a module's pages are mounted by core at `/<module id>/<path>` — so the nine
|
||||
* shard rows moved from `/site/champs` to `/uo/champs` and this table stopped
|
||||
* resolving any of them. Three things followed, all of them true of the shipped
|
||||
* app until M13: a nav override on a shard row was ignored, an added link to a
|
||||
* shard page handed off to a browser instead of opening natively, and the sort
|
||||
* key line below was a sixteen-row line against a nav numbered differently.
|
||||
*
|
||||
* **The nine `/uo/` paths are hardcoded, and they are ONE module's.** The alternative
|
||||
* — reading the installed module's id from `GET /public/modules` and building
|
||||
* `/<id>/shard` — is forbidden by `MODULE_API.md` §2.9 (*"a client must not infer
|
||||
* a route from a capability"*) and would hardcode the same path shape less
|
||||
* visibly. A site running a different game module matches none of these nine, its
|
||||
* links hand off to a Custom Tab, and that is the correct answer rather than a
|
||||
* gap: core cannot tell the app what another module calls its pages.
|
||||
*
|
||||
* Verbatim from `website/client/src/components/SiteHeader.jsx`, which is the
|
||||
* exported owner of core's list (`export const NAV`, and Admin → Navigation edits
|
||||
* exactly it):
|
||||
*
|
||||
* ```js
|
||||
* export const NAV = [
|
||||
* { label: 'Home', to: '/', end: true },
|
||||
* { label: 'News', to: '/site/news' },
|
||||
* { label: 'Events', to: '/site/events' },
|
||||
* { label: 'Screenshots', to: '/site/screenshots' },
|
||||
* { label: 'Five on Friday', to: '/site/five-on-friday' },
|
||||
* { label: 'Newsletter', to: '/site/newsletter' },
|
||||
* { label: 'Wiki', to: '/wiki' },
|
||||
* { label: 'About', to: '/site/about' },
|
||||
* ]
|
||||
* ```
|
||||
*
|
||||
* and from `module-uo/client/src/entry.jsx`, which registers the rest:
|
||||
*
|
||||
* ```jsx
|
||||
* registry.registerNav(ID, {
|
||||
* area: 'public',
|
||||
* items: [
|
||||
* { label: 'Shard', to: '/uo/shard', feature: 'status' },
|
||||
* { label: 'Champions', to: '/uo/champs', feature: 'champs' },
|
||||
* { label: 'Guilds', to: '/uo/guilds', feature: 'guilds' },
|
||||
* { label: 'Governors', to: '/uo/governors', feature: 'governors' },
|
||||
* { label: 'Houses', to: '/uo/houses', feature: 'houses' },
|
||||
* { label: 'Rules', to: '/uo/rules', feature: 'ruleset' },
|
||||
* { label: 'Atlas', to: '/uo/atlas', feature: 'atlas' },
|
||||
* { label: 'Leaderboards', to: '/uo/leaderboards', feature: 'leaderboards' },
|
||||
* { label: 'Market', to: '/uo/market', feature: 'market' },
|
||||
* ],
|
||||
* })
|
||||
* ```
|
||||
*
|
||||
* and from `module-rust/client/src/entry.jsx`, which registers one (M14):
|
||||
*
|
||||
* ```jsx
|
||||
* registry.registerNav(ID, {
|
||||
* area: 'public',
|
||||
* items: [{ label: 'Servers', to: '/rust' }],
|
||||
* })
|
||||
* ```
|
||||
*
|
||||
* None of those nine declares an `order`, so `mergeFlat` appends them after core's
|
||||
* rows in registration order — which is the order they are listed in below.
|
||||
*
|
||||
* The `feature` values are **not** mirrored here on purpose. [APP_MENU] is the
|
||||
* app's own source of truth for gating, and a second copy of a security-relevant
|
||||
* value that drifts silently is worth more than it costs. This table carries the
|
||||
* mapping and nothing else.
|
||||
*
|
||||
* Not every row maps to something the app shows in its drawer, and that is the
|
||||
* design rather than an omission — see [WEB_PATH_TO_ROUTE].
|
||||
*/
|
||||
|
||||
/** One row of the website's public nav: its path, and the app route it opens. */
|
||||
data class WebNavPath(val path: String, val route: String)
|
||||
|
||||
/**
|
||||
* The website's public nav in **its** order, mapped to app routes.
|
||||
*
|
||||
* The order is load-bearing, not decorative: a stored `order` is an index into
|
||||
* *this* list (the admin's editor writes the position a row holds on the web), so
|
||||
* a row the admin never moved has to take its key from the same number line or
|
||||
* explicit and implicit keys would be incomparable. See `NavOverrides.kt`.
|
||||
*
|
||||
* Core's eight first, then the module's nine, because that is what `withModuleNav`
|
||||
* renders and therefore what the admin's editor numbered.
|
||||
*/
|
||||
val WEBSITE_PUBLIC_NAV: List<WebNavPath> = listOf(
|
||||
WebNavPath("/", Routes.HOME),
|
||||
WebNavPath("/site/news", Routes.NEWS),
|
||||
WebNavPath("/site/events", Routes.EVENTS),
|
||||
// The app's News screen carries all four categories as tabs, so these three
|
||||
// have a route but no drawer row of their own — see the note below.
|
||||
WebNavPath("/site/screenshots", Routes.news(PostCategory.SCREENSHOTS)),
|
||||
WebNavPath("/site/five-on-friday", Routes.news(PostCategory.FIVE_ON_FRIDAY)),
|
||||
WebNavPath("/site/newsletter", Routes.news(PostCategory.NEWSLETTER)),
|
||||
WebNavPath("/wiki", Routes.WIKI),
|
||||
WebNavPath("/site/about", Routes.page("about")),
|
||||
// module-uo's rows. Mounted by core at `/<module id>/<path>`, which is why
|
||||
// every one of these is `/uo/` and not `/site/`.
|
||||
WebNavPath("/uo/shard", Routes.SHARD),
|
||||
// Behind the Shard hub in the app, deliberately — no drawer row either.
|
||||
WebNavPath("/uo/champs", Routes.SHARD_CHAMPS),
|
||||
WebNavPath("/uo/guilds", Routes.SHARD_GUILDS),
|
||||
WebNavPath("/uo/governors", Routes.SHARD_GOVERNORS),
|
||||
WebNavPath("/uo/houses", Routes.SHARD_HOUSES),
|
||||
WebNavPath("/uo/rules", Routes.SHARD_RULES),
|
||||
WebNavPath("/uo/atlas", Routes.ATLAS),
|
||||
WebNavPath("/uo/leaderboards", Routes.SHARD_LEADERBOARDS),
|
||||
WebNavPath("/uo/market", Routes.SHARD_MARKET),
|
||||
// module-rust's one row (M14). It registers `{ label: 'Servers', to: '/rust' }`
|
||||
// and nothing else — `/rust` IS the server list, because core strips the
|
||||
// trailing separator from a module route registered with `path: ''`.
|
||||
//
|
||||
// **Both modules can be installed on one backend**, and then the nav is core's
|
||||
// eight plus ten. This table is a superset by design: a path here for a module
|
||||
// an operator has NOT installed never appears in that backend's nav and so is
|
||||
// never looked up, while a path missing from it makes a link that exists hand
|
||||
// off to a browser.
|
||||
WebNavPath("/rust", Routes.RUST),
|
||||
)
|
||||
|
||||
/**
|
||||
* The same table as a lookup.
|
||||
*
|
||||
* **A mapped route is not the same thing as a drawer row.** Seven of these paths
|
||||
* resolve to a screen the app reaches some other way: the three news categories
|
||||
* are tabs on one News screen, and champs / guilds / governors / houses sit behind
|
||||
* the Shard hub because that is the better shape on a phone. An override for one
|
||||
* of them is **ignored** — §6.1's rule is that a nav override may never introduce
|
||||
* navigation, and the hub is a design decision, not an accident to correct. The
|
||||
* merge enforces that by intersecting with [APP_MENU]; nothing here needs to know
|
||||
* which rows those are.
|
||||
*
|
||||
* The mapping still exists for all sixteen because phase 6's added links resolve
|
||||
* an admin-authored path against the same table, and *there* a category tab or a
|
||||
* hub board is a perfectly good destination — the admin asked for it by path.
|
||||
*/
|
||||
val WEB_PATH_TO_ROUTE: Map<String, String> =
|
||||
WEBSITE_PUBLIC_NAV.associate { it.path to it.route }
|
||||
|
||||
/**
|
||||
* Each app route's index in the website's own nav order — the sort key a row the
|
||||
* admin never moved takes, so it lands on the same number line as a stored
|
||||
* `order`. All sixteen routes are distinct, so this loses nothing.
|
||||
*/
|
||||
internal val WEB_ROUTE_ORDER: Map<String, Int> =
|
||||
WEBSITE_PUBLIC_NAV.withIndex().associate { (index, row) -> row.route to index }
|
||||
|
||||
/**
|
||||
* The app route a website nav path opens, or null when the app has no screen for
|
||||
* it. A trailing slash is tolerated (`/wiki/` is `/wiki`) since a hand-edited
|
||||
* settings row may carry one; the root path is left alone.
|
||||
*/
|
||||
fun appRouteForWebPath(path: String?): String? = WEB_PATH_TO_ROUTE[normalizeWebPath(path)]
|
||||
|
||||
/** `/wiki/` → `/wiki`, blank → null, and `/` left alone. */
|
||||
private fun normalizeWebPath(path: String?): String? {
|
||||
val trimmed = path?.trim().orEmpty()
|
||||
if (trimmed.isEmpty()) return null
|
||||
val normalized = if (trimmed.length > 1) trimmed.trimEnd('/') else trimmed
|
||||
return normalized.ifEmpty { "/" }
|
||||
}
|
||||
|
||||
/**
|
||||
* The website's top-level paths that are **not** CMS pages.
|
||||
*
|
||||
* The site serves its CMS pages from a top-level `/<slug>` (React Router ranks its
|
||||
* static routes above that dynamic one), which is what lets [resolveWebPath]'s
|
||||
* last rule open an admin-authored page natively. These are the segments that rule
|
||||
* must not swallow: the SPA's own sections, and the two server mounts. A link to
|
||||
* one of them hands off to the browser, which is where they actually live.
|
||||
*/
|
||||
private val RESERVED_TOP_LEVEL = setOf(
|
||||
"admin", "account", "player", "site", "wiki", "invite", "preview", "api", "uploads",
|
||||
// An installed module's pages are mounted at `/<id>/…` and are not CMS pages.
|
||||
// Only ids the app knows about need listing: an unknown module's `/<id>` would
|
||||
// resolve to a CMS page that 404s, which is the same answer the browser gives
|
||||
// it, and core cannot enumerate them for us here anyway.
|
||||
//
|
||||
// `rust` is here for the opposite reason to the rest: `/rust` DOES resolve, to
|
||||
// the server list, and it does so through the nav table above — this set only
|
||||
// stops the CMS-page fallback claiming it. Without the entry a site with the
|
||||
// module absent would open a page-not-found screen instead of the browser.
|
||||
"uo", "rust",
|
||||
)
|
||||
|
||||
/**
|
||||
* The app route an **arbitrary** website path opens, or null when the app has no
|
||||
* screen for it and the link must hand off to a Custom Tab (§6.3).
|
||||
*
|
||||
* [appRouteForWebPath] answers for the sixteen paths the *nav* is built from; this
|
||||
* answers for a path an admin typed into an added link, which may name any page on
|
||||
* the site. It is the app's read of the site's own route table, and like the table
|
||||
* above it is cross-repo coupling kept in one file — quoted here for the same
|
||||
* reason, from `website/client/src/App.jsx`:
|
||||
*
|
||||
* ```jsx
|
||||
* <Route path="/" element={<Portal />} />
|
||||
* <Route path="/site/news" element={<News />} />
|
||||
* <Route path="/site/screenshots" element={<Screenshots />} />
|
||||
* <Route path="/site/five-on-friday" element={<FiveOnFriday />} />
|
||||
* <Route path="/site/newsletter" element={<Newsletter />} />
|
||||
* <Route path="/site/newsletter/:id" element={<NewsletterIssue />} />
|
||||
* <Route path="/site/events" element={<Events />} />
|
||||
* <Route path="/site/events/series/:slug" element={<EventSeries />} />
|
||||
* <Route path="/site/events/:slug" element={<EventPage />} />
|
||||
* <Route path="/site/about" element={<About />} />
|
||||
* <Route path="/site/status" element={<Status />} />
|
||||
* <Route path="/wiki" element={<Wiki />} />
|
||||
* <Route path="/wiki/:slug" element={<WikiArticle />} />
|
||||
* // Installed modules' pages, mounted at `/<module id>/<path>`:
|
||||
* // /uo/shard, /uo/shard/activity, /uo/champs, /uo/guilds, /uo/guilds/:id,
|
||||
* // /uo/governors, /uo/houses, /uo/rules, /uo/leaderboards, /uo/market,
|
||||
* // /uo/market/vendors/:serial, /uo/atlas, /uo/atlas/:slug
|
||||
* // /rust, /rust/servers/:id
|
||||
* // CMS pages: top-level /:slug, matched only after the named routes above
|
||||
* <Route path="/:slug" element={<CmsPage />} />
|
||||
* ```
|
||||
*
|
||||
* Note what is *not* in it: no `/site/news/<id>` (a news item renders on its
|
||||
* category page; the newsletter's is the site's one post-detail route), no
|
||||
* `/page/<slug>`, and no `/contact` — the app's contact form is app-only (§6.2).
|
||||
*
|
||||
* ```
|
||||
* / → HOME
|
||||
* /site/news → NEWS
|
||||
* /site/{screenshots,five-on-friday,newsletter}
|
||||
* → NEWS, that category's tab
|
||||
* /site/newsletter/<id> → POST (the site's one post-detail route)
|
||||
* /site/events → EVENTS
|
||||
* /site/events/series/<slug> → EVENT_SERIES
|
||||
* /site/events/<slug>[?run=<id>] → EVENT (the one route that takes a query)
|
||||
* /wiki → WIKI
|
||||
* /wiki/<slug> → WIKI_PAGE
|
||||
* /uo/<shard surface> → the mapped shard route (§6.2)
|
||||
* /uo/atlas/<slug> → ATLAS_CREATURE
|
||||
* /uo/market/vendors/<serial> → SHARD_MARKET_VENDOR
|
||||
* /rust → RUST (module-rust's server list)
|
||||
* /rust/servers/<id> → RUST_SERVER
|
||||
* /site/about → PAGE("about")
|
||||
* /<slug> → PAGE(slug), unless <slug> is reserved
|
||||
* anything else → null, i.e. the Custom Tab
|
||||
* ```
|
||||
*
|
||||
* **A path carrying a query or a fragment hands off — with exactly one
|
||||
* exception.** The rule exists because no app route took either, so a native
|
||||
* match would quietly drop what the admin wrote while the browser honors it. The
|
||||
* event page (M13) is the first route that takes a query, and it takes one key:
|
||||
* `run`, which is what every `event.` announcement's `eventUrl` carries. So a
|
||||
* `?run=` on an event path resolves natively and **anything else in a query
|
||||
* string, any second parameter, and any fragment still hand off** — the carve-out
|
||||
* is one key on one path, not a general "parse the query".
|
||||
*
|
||||
* That narrowness is the point: an admin who writes `/site/events/x?utm=mail` gets
|
||||
* the browser, which honors `utm`, rather than an app screen that silently ignored
|
||||
* it.
|
||||
*
|
||||
* Resolving a path is not the same as being allowed to see the screen behind it.
|
||||
* A link to `/site/market` on a shard that does not publish the market lands on
|
||||
* the Market screen's honest "not published here" state, which is what typing the
|
||||
* URL on the web does too (§6.3).
|
||||
*/
|
||||
fun resolveWebPath(path: String?): String? {
|
||||
val raw = path?.trim().orEmpty()
|
||||
// A fragment is never honored natively: no app route has one to put it in.
|
||||
if (raw.isEmpty() || '#' in raw) return null
|
||||
|
||||
val queryAt = raw.indexOf('?')
|
||||
val query = if (queryAt >= 0) raw.substring(queryAt + 1) else ""
|
||||
val normalized = normalizeWebPath(if (queryAt >= 0) raw.substring(0, queryAt) else raw)
|
||||
?: return null
|
||||
|
||||
if (query.isEmpty()) WEB_PATH_TO_ROUTE[normalized]?.let { return it }
|
||||
if (!normalized.startsWith("/")) return null
|
||||
|
||||
// Blank segments ("/site//news") mean a malformed path, not a slug.
|
||||
val segments = normalized.removePrefix("/").split('/')
|
||||
if (segments.any { it.isBlank() }) return null
|
||||
|
||||
// The one path that may carry a query, and the one key it may carry. Checked
|
||||
// before the general "a query hands off" rule below, and nowhere else.
|
||||
if (segments.size == 3 && segments[0] == "site" && segments[1] == "events" &&
|
||||
segments[2] != "series"
|
||||
) {
|
||||
// No query is the ordinary case — a link to the event rather than to one
|
||||
// of its occurrences. A query is honored only when it is exactly the run.
|
||||
if (query.isEmpty()) return Routes.event(segments[2])
|
||||
val run = runParam(query) ?: return null
|
||||
return Routes.event(segments[2], run)
|
||||
}
|
||||
if (query.isNotEmpty()) return null
|
||||
|
||||
return when {
|
||||
segments.size == 1 -> segments[0].takeIf { it !in RESERVED_TOP_LEVEL }?.let(Routes::page)
|
||||
segments[0] == "wiki" && segments.size == 2 -> Routes.wikiPage(segments[1])
|
||||
segments[0] == "site" && segments.size == 3 && segments[1] == "newsletter" ->
|
||||
Routes.post(PostCategory.NEWSLETTER.urlSlug, segments[2])
|
||||
segments[0] == "site" && segments.size == 4 && segments[1] == "events" &&
|
||||
segments[2] == "series" -> Routes.eventSeries(segments[3])
|
||||
segments[0] == MODULE_UO && segments.size == 3 && segments[1] == "atlas" ->
|
||||
Routes.atlasCreature(segments[2])
|
||||
segments[0] == MODULE_UO && segments.size == 4 && segments[1] == "market" &&
|
||||
segments[2] == "vendors" -> Routes.marketVendor(segments[3])
|
||||
// module-rust's one page below the list. `/rust` itself is already
|
||||
// answered by the nav table above, before this fallback is reached.
|
||||
segments[0] == MODULE_RUST && segments.size == 3 && segments[1] == "servers" ->
|
||||
Routes.rustServer(segments[2])
|
||||
else -> null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The `run` value of a query that consists of **exactly** `run=<something>`, or
|
||||
* null for every other query — including one that merely contains a `run` among
|
||||
* others.
|
||||
*
|
||||
* Deliberately not a query parser. A second parameter means the writer meant
|
||||
* something the app cannot honor, and the honest answer to that is the browser.
|
||||
* An empty value (`?run=`) is null too: it would reach the screen as a blank
|
||||
* string and be forwarded to the server as one.
|
||||
*/
|
||||
private fun runParam(query: String): String? {
|
||||
val value = query.removePrefix("run=")
|
||||
if (value.length == query.length || value.isEmpty()) return null
|
||||
return value.takeIf { '&' !in it && '=' !in it }
|
||||
}
|
||||
|
||||
/**
|
||||
* The module id whose public pages this table maps.
|
||||
*
|
||||
* Named once rather than spelled into four branches, so what is coupled to one
|
||||
* module is countable. It is a literal on purpose — see the file header.
|
||||
*/
|
||||
private const val MODULE_UO = "uo"
|
||||
|
||||
/** The second game module's id (M14). A literal for the same reason. */
|
||||
private const val MODULE_RUST = "rust"
|
||||
239
app/src/main/java/com/runicgateway/app/ui/navigation/NavTree.kt
Normal file
239
app/src/main/java/com/runicgateway/app/ui/navigation/NavTree.kt
Normal file
@@ -0,0 +1,239 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.json.JsonPrimitive
|
||||
import kotlinx.serialization.json.doubleOrNull
|
||||
|
||||
/**
|
||||
* The drawer as a one-level tree: the coded menu, plus the **sections** an admin
|
||||
* grouped rows into and the **links** they added of their own (THEMING_AND_NAV.md
|
||||
* §6.3). The Kotlin counterpart of the website's `buildPublicNav` + `pruneNav`.
|
||||
*
|
||||
* The public nav is the one nav an admin can restructure rather than only reorder,
|
||||
* and §6.1's invariant survives that structurally rather than by vigilance: a
|
||||
* coded row is still keyed by a website path the app's own table declares, so an
|
||||
* override still cannot invent a destination or touch a gate, while everything
|
||||
* that *can* name an arbitrary path lives in [NavNode.Link], where the path rule
|
||||
* is applied and the result is resolved through [resolveWebPath].
|
||||
*
|
||||
* An added link carries no gate and needs none — the screen behind it enforces its
|
||||
* own access, so a link to somewhere this caller cannot reach lands on that
|
||||
* screen's own honest state, exactly as typing the URL on the web does.
|
||||
*/
|
||||
sealed interface NavNode {
|
||||
|
||||
/** A coded [MenuEntry], relabeled/reordered by the merge but never re-gated. */
|
||||
data class Item(val entry: MenuEntry) : NavNode
|
||||
|
||||
/**
|
||||
* An admin-authored link to a page on this site.
|
||||
*
|
||||
* @param path the stored website path, already validated — this is what a
|
||||
* Custom Tab opens, resolved against the site's base URL
|
||||
* @param route the app route [path] maps to, or null when the app has no
|
||||
* screen for it and the link must hand off (§6.3)
|
||||
*/
|
||||
data class Link(
|
||||
val id: String,
|
||||
val label: String,
|
||||
val path: String,
|
||||
val route: String?,
|
||||
) : NavNode
|
||||
|
||||
/**
|
||||
* A drawer group: its [label] as a header, its [items] beneath it.
|
||||
*
|
||||
* The website renders these as click-to-open dropdowns; a drawer is already a
|
||||
* vertical list, so the app renders the group open (§6.3). Never empty — see
|
||||
* [pruneNav].
|
||||
*/
|
||||
data class Section(
|
||||
val id: String,
|
||||
val label: String,
|
||||
val items: List<NavNode>,
|
||||
) : NavNode
|
||||
}
|
||||
|
||||
/** A usable `sections` entry. */
|
||||
private data class SectionSpec(val id: String, val label: String, val order: Double?)
|
||||
|
||||
/** A usable `links` entry, with its section already checked against the stored ones. */
|
||||
private data class LinkSpec(
|
||||
val id: String,
|
||||
val label: String,
|
||||
val to: String,
|
||||
val order: Double?,
|
||||
val section: String?,
|
||||
)
|
||||
|
||||
/** One node waiting to be placed: its sort key, and whether that key was stored. */
|
||||
private data class Placed(val node: NavNode, val section: String?, val key: Double, val explicit: Boolean)
|
||||
|
||||
/**
|
||||
* Characters that must never appear in a stored link path. The same rule the
|
||||
* website applies on read: a value that would leave the origin, or carry markup
|
||||
* into a link, is dropped rather than rendered.
|
||||
*/
|
||||
private val FORBIDDEN_IN_PATH = Regex("""[\s<>"'\\]""")
|
||||
|
||||
// Forgiving, like every other read in M12: an entry that is not usable is dropped
|
||||
// and its neighbours kept. A repeated id is dropped too — the first wins, since
|
||||
// the id is what a link's identity in the drawer is.
|
||||
private fun readSections(raw: List<JsonObject>): List<SectionSpec> {
|
||||
val seen = mutableSetOf<String>()
|
||||
return raw.mapNotNull { section ->
|
||||
val id = section.stringOrNull("id") ?: return@mapNotNull null
|
||||
val label = section.stringOrNull("label")?.trim()?.takeIf { it.isNotEmpty() } ?: return@mapNotNull null
|
||||
if (!seen.add(id)) return@mapNotNull null
|
||||
SectionSpec(id = id, label = label, order = section.orderOrNull())
|
||||
}
|
||||
}
|
||||
|
||||
private fun readLinks(raw: List<JsonObject>, knownSections: Set<String>): List<LinkSpec> {
|
||||
val seen = mutableSetOf<String>()
|
||||
return raw.mapNotNull { link ->
|
||||
val id = link.stringOrNull("id") ?: return@mapNotNull null
|
||||
val label = link.stringOrNull("label")?.trim()?.takeIf { it.isNotEmpty() } ?: return@mapNotNull null
|
||||
val to = link.stringOrNull("to") ?: return@mapNotNull null
|
||||
if (!to.startsWith("/") || to.startsWith("//") || FORBIDDEN_IN_PATH.containsMatchIn(to)) {
|
||||
return@mapNotNull null
|
||||
}
|
||||
if (!seen.add(id)) return@mapNotNull null
|
||||
LinkSpec(
|
||||
id = id,
|
||||
label = label,
|
||||
to = to,
|
||||
order = link.orderOrNull(),
|
||||
// A link naming a section that does not exist is a top-level link, not
|
||||
// a dropped one: the admin's destination is still good.
|
||||
section = link.stringOrNull("section")?.takeIf { it in knownSections },
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
private fun JsonObject.stringOrNull(key: String): String? =
|
||||
(this[key] as? JsonPrimitive)?.takeIf { it.isString }?.content
|
||||
|
||||
private fun JsonObject.orderOrNull(): Double? =
|
||||
(this["order"] as? JsonPrimitive)?.takeIf { !it.isString }?.doubleOrNull?.takeIf { it.isFinite() }
|
||||
|
||||
// Two tie-breaks, the web's and phase 5's: an explicit order beats a coincidental
|
||||
// index (the admin said "first", so first), and two explicit orders keep
|
||||
// declaration order, because the sort is stable.
|
||||
private fun List<Placed>.place(): List<NavNode> =
|
||||
sortedWith(compareBy<Placed> { it.key }.thenByDescending { it.explicit }).map { it.node }
|
||||
|
||||
/**
|
||||
* The coded menu with the admin's `nav_public` applied in full: relabeled,
|
||||
* reordered and hidden as phase 5 already did, plus grouped into sections and
|
||||
* joined by added links.
|
||||
*
|
||||
* With no sections and no links this **is** phase 5 — [applyNavOverrides] answers,
|
||||
* so an untouched instance still gets [APP_MENU] back by identity and AC-1's proof
|
||||
* is unchanged (§2). The tree build only runs when the admin actually created
|
||||
* structure.
|
||||
*
|
||||
* @param base the coded menu — the only source of `route`, `access` and `feature`
|
||||
* @param navPublic the parsed `nav_public` row, or null when the admin never
|
||||
* edited the nav
|
||||
*/
|
||||
fun buildNavTree(base: List<MenuEntry>, navPublic: JsonObject?): List<NavNode> {
|
||||
val sections = readSections(sectionsOf(navPublic))
|
||||
val links = readLinks(linksOf(navPublic), sections.map { it.id }.toSet())
|
||||
if (sections.isEmpty() && links.isEmpty()) {
|
||||
return applyNavOverrides(base, navPublic).map { NavNode.Item(it) }
|
||||
}
|
||||
|
||||
val knownSections = sections.map { it.id }.toSet()
|
||||
val coded = base.map { it.route }.toSet()
|
||||
// Keyed by app route, and only for a route the coded menu declares — the same
|
||||
// narrowing as the flat merge, so an override for a path the app maps but does
|
||||
// not surface (a news category tab, a Shard hub board) is dropped here too.
|
||||
val overrides = buildMap {
|
||||
for ((path, raw) in itemsOf(navPublic)) {
|
||||
val route = appRouteForWebPath(path) ?: continue
|
||||
if (route !in coded) continue
|
||||
val override = cleanOverride(raw)
|
||||
// A section the stored value never declares is no section at all.
|
||||
val section = override.section?.takeIf { it in knownSections }
|
||||
if (!override.isEmpty || section != null) put(route, override.copy(section = section))
|
||||
}
|
||||
}
|
||||
|
||||
// The app's own surfaces (Contact, Account, the player groups, the staff rows)
|
||||
// have no website counterpart to be reordered against or grouped under, so they
|
||||
// keep their coded order after the public block — where they already sit (§6.2).
|
||||
val (mapped, appOnly) = base.partition { it.route in WEB_ROUTE_ORDER }
|
||||
|
||||
val placed = mutableListOf<Placed>()
|
||||
for (entry in mapped) {
|
||||
val override = overrides[entry.route]
|
||||
if (override?.hidden == true) continue
|
||||
placed += Placed(
|
||||
node = NavNode.Item(override?.label?.let { entry.copy(label = it) } ?: entry),
|
||||
section = override?.section,
|
||||
// An untouched row's key is its index in the WEBSITE's nav, so stored
|
||||
// and implicit keys sit on one number line (phase 5).
|
||||
key = override?.order ?: WEB_ROUTE_ORDER.getValue(entry.route).toDouble(),
|
||||
explicit = override?.order != null,
|
||||
)
|
||||
}
|
||||
// An admin-created entity with no stored order appends after the coded rows, in
|
||||
// creation order, rather than jumping to the front on a 0 default.
|
||||
var next = WEBSITE_PUBLIC_NAV.size
|
||||
for (section in sections) {
|
||||
placed += Placed(
|
||||
node = NavNode.Section(section.id, section.label, emptyList()),
|
||||
section = null,
|
||||
key = section.order ?: (next++).toDouble(),
|
||||
explicit = section.order != null,
|
||||
)
|
||||
}
|
||||
for (link in links) {
|
||||
placed += Placed(
|
||||
node = NavNode.Link(link.id, link.label, link.to, resolveWebPath(link.to)),
|
||||
section = link.section,
|
||||
key = link.order ?: (next++).toDouble(),
|
||||
explicit = link.order != null,
|
||||
)
|
||||
}
|
||||
|
||||
val top = placed.filter { it.node is NavNode.Section || it.section == null }.place()
|
||||
return top.map { node ->
|
||||
if (node !is NavNode.Section) {
|
||||
node
|
||||
} else {
|
||||
node.copy(items = placed.filter { it.section == node.id }.place())
|
||||
}
|
||||
} + appOnly.map { NavNode.Item(it) }
|
||||
}
|
||||
|
||||
/**
|
||||
* The tree with this caller's gates applied — and a section they empty dropped.
|
||||
*
|
||||
* This is the boundary, and it runs **after** [buildNavTree], never before: an
|
||||
* override is presentation, so a row it relabels, moves or marks `hidden: false`
|
||||
* is still shown only if [isVisible] says so (§6.1, AC-3).
|
||||
*
|
||||
* The empty-section case is the one with real correctness risk and the reason the
|
||||
* rule is ported rather than left to the drawer: a group whose every member is
|
||||
* withheld by the caller's role or by the shard's visibility config must not draw
|
||||
* as a header with nothing under it.
|
||||
*
|
||||
* Links are not gated — see [NavNode].
|
||||
*
|
||||
* @param isVisible the caller's own predicate, applied to coded items only, so
|
||||
* this file stays ignorant of sessions and shard features
|
||||
*/
|
||||
fun pruneNav(tree: List<NavNode>, isVisible: (MenuEntry) -> Boolean): List<NavNode> {
|
||||
fun keep(node: NavNode) = node !is NavNode.Item || isVisible(node.entry)
|
||||
return tree.mapNotNull { node ->
|
||||
when (node) {
|
||||
is NavNode.Section -> node.copy(items = node.items.filter(::keep)).takeIf { it.items.isNotEmpty() }
|
||||
else -> node.takeIf { keep(it) }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,6 +3,8 @@
|
||||
*/
|
||||
package com.runicgateway.app.ui.navigation
|
||||
|
||||
import com.runicgateway.app.data.repository.ContentRepository
|
||||
|
||||
/**
|
||||
* Navigation destinations for the M1 public surface (PLAN.md §5). Routes are
|
||||
* plain strings for Navigation-Compose; argument-bearing routes expose a
|
||||
@@ -14,6 +16,19 @@ object Routes {
|
||||
const val WIKI = "wiki"
|
||||
const val CONTACT = "contact"
|
||||
|
||||
/**
|
||||
* The News hub's NavHost pattern: [NEWS] plus an optional category, so a link
|
||||
* to one of the website's three category pages can land on the matching tab
|
||||
* (THEMING_AND_NAV.md §6.2). Navigating to plain [NEWS] matches this pattern
|
||||
* with no argument and opens the default tab, so every existing call site —
|
||||
* the drawer, [forStream] — is unaffected.
|
||||
*
|
||||
* Declared beside [NEWS] rather than replacing it because the two are used for
|
||||
* different things: this is what `composable()` and `destination.route` speak,
|
||||
* [NEWS] is what callers navigate to.
|
||||
*/
|
||||
const val NEWS_ROUTE = "news?category={category}"
|
||||
|
||||
/** Native login (§4.1) and the signed-in account surface (§5). */
|
||||
const val LOGIN = "login"
|
||||
const val ACCOUNT = "account"
|
||||
@@ -22,8 +37,54 @@ object Routes {
|
||||
const val ACCOUNT_TRUSTED_DEVICES = "account/trusted-devices"
|
||||
const val ACCOUNT_RECOVERY_CODES = "account/recovery-codes"
|
||||
|
||||
/** Opt-in push notification settings (§11, signed-in). */
|
||||
/**
|
||||
* The in-app inbox (ENGAGEMENT.md phase 8, signed-in) and its settings.
|
||||
*
|
||||
* The bare route is the CONTENT and the named sub-route the preferences, which
|
||||
* is exactly how the web surface is laid out (`/account/notifications` and
|
||||
* `…/settings`) — and what a person means when they tap "Notifications".
|
||||
*/
|
||||
const val NOTIFICATIONS = "notifications"
|
||||
const val NOTIFICATIONS_SETTINGS = "notifications/settings"
|
||||
|
||||
/**
|
||||
* Events (§9 M13) — CORE's, not a module's: these screens exist on a backend
|
||||
* with no game module at all, which is why they are not under `shard/`.
|
||||
*
|
||||
* **[EVENT_ROUTE] is the app's first route that takes a query**, and it takes
|
||||
* exactly one: `run`, naming which occurrence a results table is about. The
|
||||
* page lives at the definition's slug so a weekly event has one address that
|
||||
* survives a retitle, and the occurrence has to live somewhere else. See
|
||||
* [resolveWebPath], whose "a query hands off" rule this is the one exception
|
||||
* to.
|
||||
*
|
||||
* **[MY_EVENTS] is `account/events` and not `events/mine`**, which is not
|
||||
* cosmetic: `events/mine` and `events/{slug}` are both two segments, and a
|
||||
* static-versus-argument race between two NavHost patterns is exactly the bug
|
||||
* events Phase 13 shipped one tier along, where a static `events/new` outranked
|
||||
* `events/:id` in React Router and made creating an event impossible for seven
|
||||
* phases. Under `account/` there is no dynamic sibling and no race to lose.
|
||||
*/
|
||||
const val EVENTS = "events"
|
||||
const val EVENT_ROUTE = "events/{slug}?run={run}"
|
||||
const val EVENT_SERIES = "events/series/{slug}"
|
||||
const val MY_EVENTS = "account/events"
|
||||
|
||||
/**
|
||||
* The Rust module's surface (§9 M14, `docs/modules/rust/PLAN.md` D12, D13).
|
||||
*
|
||||
* **[RUST] is the server list, not a hub above one.** The module registers its
|
||||
* pages with `path: ''` and core strips the trailing separator, so `/rust` on
|
||||
* the website *is* the list — there is no landing page between the drawer row
|
||||
* and the servers, and adding one here would invent a screen the website does
|
||||
* not have.
|
||||
*
|
||||
* **A different game, so a different route tree.** These are deliberately not
|
||||
* folded into [SHARD]: one shard is a place, and a Rust site is a fleet. The
|
||||
* two can be installed on the same backend, and then both trees exist at once.
|
||||
*/
|
||||
const val RUST = "rust"
|
||||
const val RUST_SERVER = "rust/servers/{serverId}"
|
||||
|
||||
/** Public shard hub (§6.2). */
|
||||
const val SHARD = "shard"
|
||||
@@ -34,6 +95,18 @@ object Routes {
|
||||
const val SHARD_GOVERNORS = "shard/governors"
|
||||
const val SHARD_HOUSES = "shard/houses"
|
||||
|
||||
/**
|
||||
* Protocol 3.0 shard content (M11), each gated by its own visibility feature. The
|
||||
* atlas is not under `shard/` on the wire (`/public/atlas`) because it is static
|
||||
* content rather than live state, but it is a peer of these in the app's nav.
|
||||
*/
|
||||
const val SHARD_RULES = "shard/rules"
|
||||
const val SHARD_LEADERBOARDS = "shard/leaderboards"
|
||||
const val SHARD_MARKET = "shard/market"
|
||||
const val SHARD_MARKET_VENDOR = "shard/market/{serial}"
|
||||
const val ATLAS = "atlas"
|
||||
const val ATLAS_CREATURE = "atlas/{slug}"
|
||||
|
||||
/** 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"
|
||||
@@ -63,15 +136,81 @@ object Routes {
|
||||
const val CATEGORY = "category"
|
||||
const val ID_OR_SLUG = "idOrSlug"
|
||||
const val SERIAL = "serial"
|
||||
const val RUN = "run"
|
||||
const val SERVER_ID = "serverId"
|
||||
}
|
||||
|
||||
fun page(slug: String) = "page/$slug"
|
||||
fun post(categoryUrlSlug: String, idOrSlug: String) = "news/$categoryUrlSlug/$idOrSlug"
|
||||
|
||||
/**
|
||||
* The News hub with [category] preselected. Takes the enum rather than a slug
|
||||
* so an unmapped category cannot reach the NavHost — the screen's tabs are the
|
||||
* enum's entries, and a slug it doesn't know would select nothing.
|
||||
*/
|
||||
fun news(category: ContentRepository.PostCategory) = "news?category=${category.urlSlug}"
|
||||
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"
|
||||
|
||||
/** One player vendor's shop, by in-game (hex) serial. */
|
||||
fun marketVendor(serial: String) = "shard/market/$serial"
|
||||
|
||||
/**
|
||||
* One Rust server's page.
|
||||
*
|
||||
* The id is a slug an operator chose, so it is encoded: nothing stops one
|
||||
* carrying a character a path would otherwise eat, and a server nobody can
|
||||
* open is a worse failure than a name nobody can read.
|
||||
*
|
||||
* **Encoded here rather than with `android.net.Uri`**, which is a stub in a
|
||||
* JVM unit test and throws "not mocked" — this object is pure and every test
|
||||
* that builds a route would have to become an instrumented one to keep it
|
||||
* that way.
|
||||
*/
|
||||
fun rustServer(id: String) = "rust/servers/${encodePathSegment(id)}"
|
||||
|
||||
/**
|
||||
* Percent-encode one path segment, allowing only the unreserved set.
|
||||
*
|
||||
* Deliberately stricter than it needs to be: encoding a character that did
|
||||
* not need it still round-trips, where missing one that did produces a route
|
||||
* NavHost matches differently from the one that was built. UTF-8 first, so a
|
||||
* non-ASCII name is encoded per byte rather than per character.
|
||||
*/
|
||||
private fun encodePathSegment(value: String): String = buildString {
|
||||
for (byte in value.toByteArray(Charsets.UTF_8)) {
|
||||
val code = byte.toInt() and 0xFF
|
||||
val char = code.toChar()
|
||||
if (code < 128 && (char.isLetterOrDigit() || char in UNRESERVED)) {
|
||||
append(char)
|
||||
} else {
|
||||
append('%').append(code.toString(16).uppercase().padStart(2, '0'))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private const val UNRESERVED = "-._~"
|
||||
|
||||
/** One creature's atlas page, by slug. */
|
||||
fun atlasCreature(slug: String) = "atlas/$slug"
|
||||
|
||||
/**
|
||||
* One event's page, optionally about one occurrence.
|
||||
*
|
||||
* [runId] is what an announcement's link carries, and it is dropped when
|
||||
* absent rather than sent as an empty argument — `events/x?run=` would reach
|
||||
* the screen as a blank string and be forwarded to the server as one.
|
||||
*/
|
||||
fun event(slug: String, runId: String? = null): String {
|
||||
val base = "events/$slug"
|
||||
return if (runId.isNullOrBlank()) base else "$base?run=$runId"
|
||||
}
|
||||
|
||||
/** One arc, by slug. */
|
||||
fun eventSeries(slug: String) = "events/series/$slug"
|
||||
|
||||
/**
|
||||
* 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;
|
||||
@@ -88,6 +227,35 @@ object Routes {
|
||||
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
|
||||
// An engagement rule's tickle carries the TRIGGER id as its stream
|
||||
// (ENGAGEMENT.md §7.2's one namespace), and `event.run.started` is the only
|
||||
// event trigger that is also a push stream. The calendar is the honest
|
||||
// destination when there is no inbox row to send it to — the tickle names
|
||||
// no occurrence, so there is no page to open. A row, when there is one,
|
||||
// wins via [forTickle] and carries the link that does.
|
||||
else -> if (streamId.startsWith(EVENT_STREAM_PREFIX)) EVENTS else HOME
|
||||
}
|
||||
|
||||
/** What every core `event.` trigger id begins with (EVENTS.md §J). */
|
||||
private const val EVENT_STREAM_PREFIX = "event."
|
||||
|
||||
|
||||
/**
|
||||
* Where a tapped tickle lands, given both halves of `{ stream, ref }`.
|
||||
*
|
||||
* **A `notification:<id>` ref means the engine wrote this user an inbox row**
|
||||
* (`pushChannel.js` builds it), so the tap goes to the inbox whatever the
|
||||
* stream is — an engagement rule's stream id is a TRIGGER id in §7.2's one
|
||||
* namespace, and [forStream]'s fixed map would send most of them to Home.
|
||||
* Every other tickle keeps the route it has always had, so no shipped stream
|
||||
* changes where it lands.
|
||||
*
|
||||
* The ref is not decoded beyond that prefix and is never rendered: it is a
|
||||
* hint that a row exists, and the app's contract is wake-and-pull.
|
||||
*/
|
||||
fun forTickle(streamId: String, ref: String?): String =
|
||||
if (ref != null && ref.startsWith(INBOX_REF_PREFIX)) NOTIFICATIONS else forStream(streamId)
|
||||
|
||||
/** What `pushChannel.js` prefixes an inbox row's id with. */
|
||||
const val INBOX_REF_PREFIX = "notification:"
|
||||
}
|
||||
|
||||
@@ -10,7 +10,6 @@ import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ScrollableTabRow
|
||||
import androidx.compose.material3.Tab
|
||||
@@ -29,6 +28,7 @@ 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.ShardCard
|
||||
|
||||
/** News hub with category tabs and a post list (PLAN.md §6.1). */
|
||||
@Composable
|
||||
@@ -82,7 +82,7 @@ private fun PostList(
|
||||
|
||||
@Composable
|
||||
private fun PostRow(post: PostDto, onClick: () -> Unit) {
|
||||
Card(
|
||||
ShardCard(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(vertical = 6.dp)
|
||||
|
||||
@@ -3,12 +3,14 @@
|
||||
*/
|
||||
package com.runicgateway.app.ui.news
|
||||
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.PostDto
|
||||
import com.runicgateway.app.data.repository.ContentRepository
|
||||
import com.runicgateway.app.data.repository.ContentRepository.PostCategory
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.navigation.Routes
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
@@ -21,9 +23,15 @@ import javax.inject.Inject
|
||||
@HiltViewModel
|
||||
class NewsViewModel @Inject constructor(
|
||||
private val contentRepository: ContentRepository,
|
||||
savedStateHandle: SavedStateHandle,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _category = MutableStateFlow(PostCategory.NEWS)
|
||||
// Which tab to open on. Absent — every route into this screen except an
|
||||
// admin's nav override or added link (THEMING_AND_NAV.md §6.2) — is the
|
||||
// default feed, and so is a slug the app doesn't know.
|
||||
private val _category = MutableStateFlow(
|
||||
PostCategory.fromUrlSlug(savedStateHandle[Routes.Args.CATEGORY]) ?: PostCategory.NEWS,
|
||||
)
|
||||
val category: StateFlow<PostCategory> = _category.asStateFlow()
|
||||
|
||||
private val _state = MutableStateFlow<UiState<List<PostDto>>>(UiState.Loading)
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
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.core.inbox.InboxCache
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.repository.NotificationsRepository
|
||||
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 drawer's unread badge (ENGAGEMENT.md phase 8).
|
||||
*
|
||||
* Its own view model, and its own endpoint: `/notifications/unread-count` exists
|
||||
* precisely because this is the question asked most often and it should not make
|
||||
* the server assemble a page of bodies to answer with one integer. Refreshed when
|
||||
* the app resumes rather than on a timer — the tickle is what says "something
|
||||
* happened", so polling would be a second, worse copy of push.
|
||||
*
|
||||
* Falls back to the cached count while offline, for the same reason the inbox
|
||||
* does: a badge that dropped to zero because the train went into a tunnel would
|
||||
* be telling the user they have read something they have not.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class InboxBadgeViewModel @Inject constructor(
|
||||
private val notifications: NotificationsRepository,
|
||||
private val cache: InboxCache,
|
||||
private val sessionManager: SessionManager,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _unread = MutableStateFlow(0)
|
||||
val unread: StateFlow<Int> = _unread.asStateFlow()
|
||||
|
||||
/** Ask the server, falling back to the snapshot. A signed-out session is zero. */
|
||||
fun refresh() = viewModelScope.launch {
|
||||
val user = (sessionManager.state.value as? Session.SignedIn)?.user
|
||||
if (user == null) {
|
||||
_unread.value = 0
|
||||
return@launch
|
||||
}
|
||||
when (val result = notifications.unreadCount()) {
|
||||
is ApiResult.Ok -> _unread.value = result.data.unread
|
||||
else -> {
|
||||
val owner = InboxCache.ownerKey(baseUrlHolder.current?.toString(), user.id)
|
||||
cache.read(owner)?.let { _unread.value = it.unread }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import com.runicgateway.app.core.time.parseWireInstant
|
||||
import java.time.ZoneId
|
||||
import java.time.format.DateTimeFormatter
|
||||
import java.time.format.FormatStyle
|
||||
|
||||
/**
|
||||
* Render an inbox item's `createdAt` for display, in the device's own zone and
|
||||
* locale (ENGAGEMENT.md phase 8). Pure, so it is unit-testable off-device.
|
||||
*
|
||||
* **Two shapes have to be accepted, and which one arrives is not the app's to
|
||||
* decide** — see [parseWireInstant], which owns that trap for every screen that
|
||||
* reads a timestamp, this one and the event screens (M13).
|
||||
*
|
||||
* Anything unparseable returns null and the row simply shows no stamp: a
|
||||
* notification with an odd date is still worth reading.
|
||||
*/
|
||||
fun inboxTimestamp(
|
||||
raw: String,
|
||||
zone: ZoneId = ZoneId.systemDefault(),
|
||||
formatter: DateTimeFormatter =
|
||||
DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM, FormatStyle.SHORT),
|
||||
): String? {
|
||||
val instant = parseWireInstant(raw) ?: return null
|
||||
return try {
|
||||
formatter.withZone(zone).format(instant)
|
||||
} catch (_: Exception) {
|
||||
null
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,215 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
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.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.Settings
|
||||
import androidx.compose.material3.Icon
|
||||
import androidx.compose.material3.IconButton
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
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.draw.clip
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
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.core.web.WebHandoff
|
||||
import com.runicgateway.app.data.api.dto.NotificationItemDto
|
||||
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.ShardCard
|
||||
|
||||
/**
|
||||
* The in-app inbox (ENGAGEMENT.md phase 8): what the engine's `inapp` channel
|
||||
* wrote for this user, newest first.
|
||||
*
|
||||
* This is the drawer's "Notifications" — the settings that used to live there are
|
||||
* one tap away behind the gear, mirroring exactly what phase 7 shipped on the web
|
||||
* (the bare path is the inbox, `…/settings` is the preferences). It is what a
|
||||
* tapped push tickle deep-links to, and the pull that follows the wake.
|
||||
*
|
||||
* **The list carries content, so it is deliberately plain text.** An item's body
|
||||
* is the server's `toText` render, never the email HTML — that markup is table
|
||||
* rows and inline hex with a light-only `color-scheme`, which in a themed app
|
||||
* would be a pale card in a dark one. It also means there is no operator markup
|
||||
* on this surface to sanitize.
|
||||
*/
|
||||
@Composable
|
||||
fun InboxScreen(
|
||||
onOpenSettings: () -> Unit,
|
||||
onOpenRoute: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: InboxViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
val context = LocalContext.current
|
||||
|
||||
Column(modifier.fillMaxSize()) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(start = 16.dp, end = 4.dp, top = 8.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = if (state.unread > 0) {
|
||||
stringResource(R.string.inbox_unread_count, state.unread)
|
||||
} else {
|
||||
stringResource(R.string.inbox_all_read)
|
||||
},
|
||||
style = MaterialTheme.typography.labelLarge,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
if (state.unread > 0) {
|
||||
TextButton(onClick = viewModel::markAllRead) {
|
||||
Text(stringResource(R.string.inbox_mark_all_read))
|
||||
}
|
||||
}
|
||||
IconButton(onClick = onOpenSettings) {
|
||||
Icon(Icons.Filled.Settings, stringResource(R.string.inbox_open_settings))
|
||||
}
|
||||
}
|
||||
|
||||
// Showing the snapshot rather than the server's answer is said out loud: a
|
||||
// notification surface that quietly showed a stale list would be lying
|
||||
// about the one thing it exists to be — current.
|
||||
if (state.fromCache) {
|
||||
Text(
|
||||
text = stringResource(R.string.inbox_offline_cached),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(horizontal = 16.dp, vertical = 4.dp),
|
||||
)
|
||||
}
|
||||
|
||||
when (val items = state.items) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(items.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> if (items.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.inbox_empty))
|
||||
} else {
|
||||
InboxList(
|
||||
items = items.data,
|
||||
hasMore = state.hasMore && !state.fromCache,
|
||||
onEndReached = viewModel::loadMore,
|
||||
onOpen = { item ->
|
||||
viewModel.markRead(item.id)
|
||||
// Most items have no url at all — an inbox row is complete on
|
||||
// its own — and the ones that do carry a SITE-RELATIVE path.
|
||||
//
|
||||
// A path the app has a screen for opens natively (M13): an
|
||||
// event announcement's link is the case that made this worth
|
||||
// doing. Everything else resolves against the configured
|
||||
// shard and goes to the browser, exactly as before.
|
||||
val route = viewModel.routeFor(item)
|
||||
if (route != null) {
|
||||
onOpenRoute(route)
|
||||
} else {
|
||||
viewModel.linkFor(item)?.let { WebHandoff.open(context, it) }
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun InboxList(
|
||||
items: List<NotificationItemDto>,
|
||||
hasMore: Boolean,
|
||||
onEndReached: () -> Unit,
|
||||
onOpen: (NotificationItemDto) -> Unit,
|
||||
) {
|
||||
LazyColumn(
|
||||
modifier = Modifier.fillMaxSize().padding(horizontal = 16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
contentPadding = PaddingValues(vertical = 12.dp),
|
||||
) {
|
||||
items(items, key = { it.id }) { item -> InboxCard(item, onOpen) }
|
||||
if (hasMore) {
|
||||
item {
|
||||
// Paging by "the last row came into view" rather than a button: the
|
||||
// cursor is the last id on screen, so reaching the end IS the request.
|
||||
LaunchedEffect(items.lastOrNull()?.id) { onEndReached() }
|
||||
Box(Modifier.fillMaxWidth().padding(16.dp), contentAlignment = Alignment.Center) {
|
||||
Text(
|
||||
stringResource(R.string.inbox_loading_more),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun InboxCard(item: NotificationItemDto, onOpen: (NotificationItemDto) -> Unit) {
|
||||
ShardCard(Modifier.fillMaxWidth().clickable { onOpen(item) }) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Row(verticalAlignment = Alignment.CenterVertically) {
|
||||
if (!item.read) {
|
||||
// The unread mark is a dot beside the title AND a heavier weight
|
||||
// on it: colour alone would carry the whole signal, which is not
|
||||
// a distinction everyone can see.
|
||||
Box(
|
||||
Modifier
|
||||
.padding(end = 8.dp)
|
||||
.size(8.dp)
|
||||
.clip(CircleShape)
|
||||
.background(MaterialTheme.colorScheme.primary),
|
||||
)
|
||||
}
|
||||
Text(
|
||||
text = item.title,
|
||||
style = MaterialTheme.typography.titleSmall,
|
||||
fontWeight = if (item.read) FontWeight.Normal else FontWeight.Bold,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
}
|
||||
item.body?.takeIf { it.isNotBlank() }?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 6.dp),
|
||||
)
|
||||
}
|
||||
val stamp = item.createdAt?.let { inboxTimestamp(it) }
|
||||
if (stamp != null) {
|
||||
Text(
|
||||
text = stamp,
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 8.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,307 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
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.core.inbox.InboxCache
|
||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.core.result.map
|
||||
import com.runicgateway.app.data.api.dto.NotificationItemDto
|
||||
import com.runicgateway.app.data.repository.NotificationsRepository
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.navigation.resolveWebPath
|
||||
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.distinctUntilChanged
|
||||
import kotlinx.coroutines.flow.map
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Drives the in-app inbox (ENGAGEMENT.md phase 8): the items the engine's `inapp`
|
||||
* channel wrote for this user, newest first, with the unread badge and the two
|
||||
* mark-read writes.
|
||||
*
|
||||
* **The tickle contract is wake-and-pull, and this is the pull.** A push tickle
|
||||
* carries `{ stream, ref }` and nothing else by design; `ref` is a HINT that an
|
||||
* inbox row exists, never content, and `pushChannel.js` says so in as many words —
|
||||
* the two rows are independent and either can be retried, so a client that
|
||||
* rendered the ref would show nothing the first time a retry reordered them. So a
|
||||
* tap deep-links here and this refreshes; the ref is not read.
|
||||
*
|
||||
* **Paging is keyset, not offset.** The next page is `before = the last id on
|
||||
* screen`, because the list gains rows at the top while it is being read and an
|
||||
* offset would show the same item twice or skip one.
|
||||
*
|
||||
* **It reloads when the ACCOUNT changes, not merely when it is created.** A
|
||||
* drawer route's view model outlives a sign-out: `navigateTopLevel` saves and
|
||||
* restores back-stack state, so the `NavBackStackEntry` keeps its
|
||||
* `ViewModelStore` and a view model that loaded only in `init` never runs again.
|
||||
* Signing out and back in as somebody else showed the second account the FIRST
|
||||
* account's inbox — titles and body text written for another person — with no
|
||||
* request made at all, while the badge beside it showed the new account's real
|
||||
* count, because the shell refreshes that one on every session change.
|
||||
*
|
||||
* [InboxCache] was never the hole: it is keyed by `(base URL, user id)` and a
|
||||
* snapshot has never crossed an account. The hole was the in-memory state, which
|
||||
* nothing invalidated.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class InboxViewModel @Inject constructor(
|
||||
private val notifications: NotificationsRepository,
|
||||
private val cache: InboxCache,
|
||||
private val sessionManager: SessionManager,
|
||||
private val baseUrlHolder: BaseUrlHolder,
|
||||
) : ViewModel() {
|
||||
|
||||
data class State(
|
||||
val items: UiState<List<NotificationItemDto>> = UiState.Loading,
|
||||
val unread: Int = 0,
|
||||
val hasMore: Boolean = false,
|
||||
val loadingMore: Boolean = false,
|
||||
val refreshing: Boolean = false,
|
||||
/**
|
||||
* True while what is on screen came from [InboxCache] rather than the
|
||||
* server. The screen says so — an inbox that quietly showed a stale list
|
||||
* would be a notification surface that lies about being current.
|
||||
*/
|
||||
val fromCache: Boolean = false,
|
||||
/** When that snapshot was captured; only meaningful with [fromCache]. */
|
||||
val cachedAt: Long? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
sessionManager.state
|
||||
.map { (it as? Session.SignedIn)?.user?.id }
|
||||
.distinctUntilChanged()
|
||||
.collect { userId ->
|
||||
if (userId == null) {
|
||||
// Signed out. The shell is already navigating away; drop the
|
||||
// rows rather than leave them addressable behind it.
|
||||
_state.value = State(items = UiState.Success(emptyList()))
|
||||
} else {
|
||||
// Reset BEFORE loading, not after: `load()` paints the cache
|
||||
// only when there is no `Success` on screen, so the previous
|
||||
// account's rows would otherwise stay up — and stay up for
|
||||
// the whole round trip.
|
||||
_state.value = State()
|
||||
load()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the cached page immediately, then refresh from the server.
|
||||
*
|
||||
* The cache is painted first rather than after a failure so a cold open on a
|
||||
* slow connection shows the last known inbox instead of a spinner; a
|
||||
* successful pull replaces it, and a network failure leaves it up with
|
||||
* [State.fromCache] set. A *server* error is a different thing from being
|
||||
* offline and is not papered over with stale rows — unless there is nothing
|
||||
* else to show, in which case the error is still what the screen reports.
|
||||
*/
|
||||
fun load() = viewModelScope.launch {
|
||||
val owner = ownerKey()
|
||||
if (owner != null && _state.value.items !is UiState.Success) {
|
||||
cache.read(owner)?.let { snapshot ->
|
||||
_state.update {
|
||||
it.copy(
|
||||
items = UiState.Success(snapshot.items),
|
||||
unread = snapshot.unread,
|
||||
fromCache = true,
|
||||
cachedAt = snapshot.savedAt,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
refresh()
|
||||
}
|
||||
|
||||
/** Pull the newest page. Keeps whatever is on screen until it succeeds. */
|
||||
fun refresh() = viewModelScope.launch {
|
||||
_state.update { it.copy(refreshing = true) }
|
||||
when (val result = notifications.inbox()) {
|
||||
is ApiResult.Ok -> {
|
||||
val page = result.data
|
||||
_state.update {
|
||||
it.copy(
|
||||
items = UiState.Success(page.items),
|
||||
unread = page.unread,
|
||||
hasMore = page.hasMore,
|
||||
refreshing = false,
|
||||
fromCache = false,
|
||||
cachedAt = null,
|
||||
)
|
||||
}
|
||||
ownerKey()?.let { cache.write(it, page.items, page.unread) }
|
||||
}
|
||||
else -> {
|
||||
// Nothing cached to fall back on → the error IS the screen. Something
|
||||
// cached → keep it up and label it, which is the whole point of §7's
|
||||
// "the app degrades, it does not fail".
|
||||
val holdCache = _state.value.items is UiState.Success && _state.value.fromCache
|
||||
_state.update {
|
||||
it.copy(
|
||||
items = if (holdCache) it.items else result.map { page -> page.items }.toUiState(),
|
||||
refreshing = false,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Append the next page.
|
||||
*
|
||||
* A no-op while one is in flight, when the server said there is no next page,
|
||||
* or while the list is the cached snapshot — paging a cache we know to be one
|
||||
* page long would ask the server for `before` an id it may no longer have.
|
||||
*/
|
||||
fun loadMore() = viewModelScope.launch {
|
||||
val current = _state.value
|
||||
val shown = (current.items as? UiState.Success)?.data ?: return@launch
|
||||
if (current.loadingMore || !current.hasMore || current.fromCache) return@launch
|
||||
val cursor = shown.lastOrNull()?.id ?: return@launch
|
||||
|
||||
_state.update { it.copy(loadingMore = true) }
|
||||
when (val result = notifications.inbox(before = cursor)) {
|
||||
is ApiResult.Ok -> {
|
||||
// Guard the same id arriving twice: a keyset window can shift under
|
||||
// a concurrent write, and a duplicate id in a LazyColumn key crashes.
|
||||
val seen = shown.mapTo(mutableSetOf()) { it.id }
|
||||
val appended = result.data.items.filterNot { it.id in seen }
|
||||
_state.update {
|
||||
it.copy(
|
||||
items = UiState.Success(shown + appended),
|
||||
unread = result.data.unread,
|
||||
hasMore = result.data.hasMore,
|
||||
loadingMore = false,
|
||||
)
|
||||
}
|
||||
}
|
||||
// A failed "more" leaves the pages already read alone — losing them
|
||||
// because the fourth page timed out would be worse than stopping.
|
||||
else -> _state.update { it.copy(loadingMore = false, hasMore = false) }
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark one item read, optimistically.
|
||||
*
|
||||
* The row flips locally before the call so the tap feels immediate, and the
|
||||
* server's post-write `unread` replaces the local guess when it lands. A
|
||||
* failure is not rolled back: read-ness is the least consequential thing in
|
||||
* the app to get briefly wrong, and un-reading a row under the user's finger
|
||||
* looks like a bug. The next refresh corrects it.
|
||||
*/
|
||||
fun markRead(id: Long) = viewModelScope.launch {
|
||||
val shown = (_state.value.items as? UiState.Success)?.data ?: return@launch
|
||||
if (shown.firstOrNull { it.id == id }?.read != false) return@launch
|
||||
|
||||
_state.update { current ->
|
||||
current.copy(
|
||||
items = UiState.Success(shown.map { if (it.id == id) it.copy(read = true) else it }),
|
||||
unread = (current.unread - 1).coerceAtLeast(0),
|
||||
)
|
||||
}
|
||||
when (val result = notifications.markRead(id)) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(unread = result.data.unread) }
|
||||
else -> Unit
|
||||
}
|
||||
cacheCurrent()
|
||||
}
|
||||
|
||||
/** Mark the whole inbox read. Same optimism, and the same reason for it. */
|
||||
fun markAllRead() = viewModelScope.launch {
|
||||
val shown = (_state.value.items as? UiState.Success)?.data ?: return@launch
|
||||
_state.update {
|
||||
it.copy(items = UiState.Success(shown.map { item -> item.copy(read = true) }), unread = 0)
|
||||
}
|
||||
notifications.markAllRead()
|
||||
cacheCurrent()
|
||||
}
|
||||
|
||||
/**
|
||||
* The absolute link for an item, or null when it has none this app can open.
|
||||
*
|
||||
* **An item's `url` is SITE-RELATIVE** — `/guilds/the-silver-anvil/forum/403`
|
||||
* is what the server writes, because it is rendered from the template's button
|
||||
* block for a browser that is already on the site. A phone is not, so it has to
|
||||
* be resolved against the configured base or every link in the inbox is dead;
|
||||
* the live rig is what caught that.
|
||||
*
|
||||
* `HttpUrl.resolve` does both jobs: it absolutises a relative path and it
|
||||
* returns null for anything that would not end up as http(s) — a `javascript:`
|
||||
* or `intent:` url in a notification body opens nothing at all.
|
||||
*/
|
||||
fun linkFor(item: NotificationItemDto): String? {
|
||||
val raw = item.url?.trim().orEmpty()
|
||||
if (raw.isEmpty()) return null
|
||||
return baseUrlHolder.current?.resolve(raw)?.toString()
|
||||
}
|
||||
|
||||
/**
|
||||
* The app route this item opens natively, or null when it has none and
|
||||
* [linkFor] should hand it to a browser (M13).
|
||||
*
|
||||
* **Why this exists at all:** events Phase 14a gave the six public `event.`
|
||||
* triggers an `eventUrl` of the form `/site/events/<slug>?run=<id>`, so an
|
||||
* inbox row about an event now has a native destination — and opening a
|
||||
* Custom Tab onto a page the app itself renders is a worse answer than it was
|
||||
* when there was no such page.
|
||||
*
|
||||
* **It reuses `resolveWebPath` rather than adding a second link-routing
|
||||
* mechanism.** That function is already the app's read of the site's own route
|
||||
* table, it already answers null for everything it does not recognise, and
|
||||
* every path it does not recognise still hands off exactly as before. Adding a
|
||||
* parser here would put the decision in two places.
|
||||
*
|
||||
* The item's url is site-relative by contract, but an absolute one on this
|
||||
* host is accepted too: the shape is the server's to change, and a link that
|
||||
* opened the browser only because it arrived fully qualified would be a
|
||||
* puzzle. An absolute url on ANOTHER host is not ours to route — the app has
|
||||
* no screen for somebody else's site — so it falls through to the browser.
|
||||
*/
|
||||
fun routeFor(item: NotificationItemDto): String? {
|
||||
val raw = item.url?.trim().orEmpty()
|
||||
if (raw.isEmpty()) return null
|
||||
val base = baseUrlHolder.current ?: return null
|
||||
val resolved = base.resolve(raw) ?: return null
|
||||
if (resolved.host != base.host) return null
|
||||
val query = resolved.query
|
||||
return resolveWebPath(resolved.encodedPath + if (query.isNullOrEmpty()) "" else "?$query")
|
||||
}
|
||||
|
||||
/**
|
||||
* Keep the snapshot in step with a local read.
|
||||
*
|
||||
* Without this, going offline right after reading everything would bring the
|
||||
* badge back on the next cold open. Only ever written for the account that
|
||||
* owns it — [InboxCache] scopes by (base URL, user id).
|
||||
*/
|
||||
private suspend fun cacheCurrent() {
|
||||
val owner = ownerKey() ?: return
|
||||
val current = _state.value
|
||||
val shown = (current.items as? UiState.Success)?.data ?: return
|
||||
cache.write(owner, shown, current.unread)
|
||||
}
|
||||
|
||||
private fun ownerKey(): String? {
|
||||
val user = (sessionManager.state.value as? Session.SignedIn)?.user ?: return null
|
||||
return InboxCache.ownerKey(baseUrlHolder.current?.toString(), user.id)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,271 @@
|
||||
/*
|
||||
* 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.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.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.FilterChip
|
||||
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.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.NotificationChannelDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelItemDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsDto
|
||||
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 notification **settings** screen (PLAN.md §11, ENGAGEMENT.md phase 8): every
|
||||
* subscribable id with a control per channel that applies to it.
|
||||
*
|
||||
* It used to be the drawer's "Notifications"; that entry is the inbox now and this
|
||||
* is behind its gear, which is the arrangement phase 7 shipped on the web. What
|
||||
* changed underneath is bigger than the move: the screen asks
|
||||
* `/notifications/channels` and so can express email and on-site preferences, not
|
||||
* just whether a stream pushes.
|
||||
*
|
||||
* **A channel with two modes gets a switch and one with three gets chips**, and
|
||||
* which is which comes off the wire — `email` is the one that supports `digest`
|
||||
* today, and a fourth channel with its own modes would render correctly here
|
||||
* without an app release.
|
||||
*/
|
||||
@Composable
|
||||
fun NotificationSettingsScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: NotificationSettingsViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
// Ask once for POST_NOTIFICATIONS when the user first switches a push mode on
|
||||
// (API 33+). Email and in-app need no permission — only push posts anything.
|
||||
val permissionLauncher = rememberLauncherForActivityResult(
|
||||
ActivityResultContracts.RequestPermission(),
|
||||
) { /* granted or not, the preference 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))
|
||||
|
||||
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),
|
||||
)
|
||||
}
|
||||
|
||||
// A shard with no push relay still has email and on-site preferences worth
|
||||
// setting, so this is a note beside the list now rather than the whole
|
||||
// screen — which is what it had to be when push was all there was.
|
||||
if (!state.supported) {
|
||||
Text(
|
||||
text = stringResource(R.string.notifications_unsupported),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
fontStyle = FontStyle.Italic,
|
||||
modifier = Modifier.padding(bottom = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
when (val prefs = state.prefs) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(kind = prefs.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> ChannelPrefsList(
|
||||
prefs = prefs.data,
|
||||
hasLinkedAccount = state.hasLinkedAccount,
|
||||
pushSupported = state.supported,
|
||||
busy = state.busy,
|
||||
onSetMode = { item, channel, mode ->
|
||||
if (channel == CHANNEL_PUSH && mode != MODE_OFF) ensureNotificationPermission()
|
||||
viewModel.setMode(item, channel, mode)
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ChannelPrefsList(
|
||||
prefs: NotificationChannelPrefsDto,
|
||||
hasLinkedAccount: Boolean,
|
||||
pushSupported: Boolean,
|
||||
busy: Boolean,
|
||||
onSetMode: (NotificationChannelItemDto, String, String) -> Unit,
|
||||
) {
|
||||
if (prefs.items.isEmpty()) {
|
||||
EmptyView(message = stringResource(R.string.notifications_empty))
|
||||
return
|
||||
}
|
||||
val channelsById = prefs.channels.associateBy { it.id }
|
||||
val (personal, general) = prefs.items.partition { it.personal }
|
||||
|
||||
if (general.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_general))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
general.forEach { item ->
|
||||
ItemRow(item, channelsById, hint = null, enabled = !busy, pushSupported = pushSupported, onSetMode = onSetMode)
|
||||
HorizontalDivider()
|
||||
}
|
||||
Spacer(Modifier.height(20.dp))
|
||||
}
|
||||
|
||||
if (personal.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_personal))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
personal.forEach { item ->
|
||||
val selectable = itemSelectable(item, hasLinkedAccount)
|
||||
ItemRow(
|
||||
item = item,
|
||||
channelsById = channelsById,
|
||||
hint = if (!selectable) stringResource(R.string.notifications_requires_link) else null,
|
||||
enabled = !busy && selectable,
|
||||
pushSupported = pushSupported,
|
||||
onSetMode = onSetMode,
|
||||
)
|
||||
HorizontalDivider()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ItemRow(
|
||||
item: NotificationChannelItemDto,
|
||||
channelsById: Map<String, NotificationChannelDto>,
|
||||
hint: String?,
|
||||
enabled: Boolean,
|
||||
pushSupported: Boolean,
|
||||
onSetMode: (NotificationChannelItemDto, String, String) -> Unit,
|
||||
) {
|
||||
Column(Modifier.fillMaxWidth().padding(vertical = 12.dp)) {
|
||||
Text(
|
||||
text = item.label,
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
color = if (enabled) MaterialTheme.colorScheme.onSurface else MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
text = hint ?: item.description,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
fontStyle = if (hint != null) FontStyle.Italic else FontStyle.Normal,
|
||||
)
|
||||
// The item's OWN channel list, in the registry's order. An id nothing can
|
||||
// push carries no push control at all, rather than a dead switch.
|
||||
item.channels.forEach { channelId ->
|
||||
val channel = channelsById[channelId] ?: return@forEach
|
||||
if (channelId == CHANNEL_PUSH && !pushSupported) return@forEach
|
||||
ChannelControl(
|
||||
channel = channel,
|
||||
mode = item.modes[channelId] ?: channel.defaultMode,
|
||||
enabled = enabled,
|
||||
onSetMode = { mode -> onSetMode(item, channelId, mode) },
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
private fun ChannelControl(
|
||||
channel: NotificationChannelDto,
|
||||
mode: String,
|
||||
enabled: Boolean,
|
||||
onSetMode: (String) -> Unit,
|
||||
) {
|
||||
val modes = channel.modes.ifEmpty { listOf(MODE_OFF) }
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 8.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = channel.label,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.weight(1f).padding(end = 12.dp),
|
||||
)
|
||||
// Two modes is a yes/no question and reads best as a switch; three is a
|
||||
// choice and needs its options named — `digest` means nothing as an
|
||||
// unlabelled third state.
|
||||
if (modes.size == 2 && modes.contains(MODE_OFF)) {
|
||||
val on = modes.first { it != MODE_OFF }
|
||||
Switch(
|
||||
checked = mode != MODE_OFF,
|
||||
onCheckedChange = { checked -> onSetMode(if (checked) on else MODE_OFF) },
|
||||
enabled = enabled,
|
||||
)
|
||||
} else {
|
||||
FlowRow(horizontalArrangement = Arrangement.spacedBy(6.dp)) {
|
||||
modes.forEach { candidate ->
|
||||
FilterChip(
|
||||
selected = candidate == mode,
|
||||
onClick = { if (candidate != mode) onSetMode(candidate) },
|
||||
enabled = enabled,
|
||||
label = { Text(modeLabel(candidate)) },
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy for a delivery mode. A mode this build has never heard of is labelled with
|
||||
* its own wire name rather than hidden — the server accepts it, so a chip reading
|
||||
* `weekly` is more use to the person in front of it than a control that vanished.
|
||||
*/
|
||||
@Composable
|
||||
private fun modeLabel(mode: String): String = when (mode) {
|
||||
MODE_OFF -> stringResource(R.string.notifications_mode_off)
|
||||
"instant" -> stringResource(R.string.notifications_mode_instant)
|
||||
"digest" -> stringResource(R.string.notifications_mode_digest)
|
||||
else -> mode
|
||||
}
|
||||
@@ -0,0 +1,167 @@
|
||||
/*
|
||||
* 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.auth.Session
|
||||
import com.runicgateway.app.core.auth.SessionManager
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelItemDto
|
||||
import com.runicgateway.app.data.api.dto.NotificationChannelPrefsDto
|
||||
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.distinctUntilChanged
|
||||
import kotlinx.coroutines.flow.map
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/** The push channel's id — the one channel that also drives a device registration. */
|
||||
const val CHANNEL_PUSH = "push"
|
||||
|
||||
/** The mode every channel accepts, and the one that means "do not deliver". */
|
||||
const val MODE_OFF = "off"
|
||||
|
||||
/**
|
||||
* Drives the notification **settings** screen (PLAN.md §11, ENGAGEMENT.md phase 8).
|
||||
*
|
||||
* **This screen moved off `/notifications/subscriptions` onto
|
||||
* `/notifications/channels`.** The old endpoint asked one question — is push on
|
||||
* for this stream — and there are now three channels to ask it of. The server
|
||||
* keeps `notification_subscriptions` as the push projection of the new table and
|
||||
* fans every write to either into the other, so the shipped APK's screen went on
|
||||
* working the whole time and this one is not a migration anybody has to run.
|
||||
*
|
||||
* **The controls are rendered from the wire, never from a hardcoded three.** Each
|
||||
* item names the channels that apply to it — a trigger-only id carries no `push`
|
||||
* because nothing is registered to push it — and each channel names the modes it
|
||||
* accepts, which is how `email`'s `digest` reaches the app without an app release.
|
||||
* The modes the server sends are the EFFECTIVE ones (it has already substituted
|
||||
* each channel's default), so this class never re-implements the defaulting.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class NotificationSettingsViewModel @Inject constructor(
|
||||
private val notifications: NotificationsRepository,
|
||||
private val playerShard: PlayerShardRepository,
|
||||
private val pushManager: PushManager,
|
||||
sessionManager: SessionManager,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val prefs: UiState<NotificationChannelPrefsDto> = UiState.Loading,
|
||||
/** 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) } }
|
||||
}
|
||||
// Reloaded on an account change for the reason the inbox is, and one
|
||||
// reason more: these controls are WRITTEN from. A screen still rendering
|
||||
// the previous account's preferences would send this account's PUT built
|
||||
// out of them, so a stale render here corrupts rather than merely
|
||||
// discloses.
|
||||
viewModelScope.launch {
|
||||
sessionManager.state
|
||||
.map { (it as? Session.SignedIn)?.user?.id }
|
||||
.distinctUntilChanged()
|
||||
.collect { userId -> if (userId != null) load() }
|
||||
}
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(prefs = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
_state.update { it.copy(prefs = notifications.channelPrefs().toUiState()) }
|
||||
// 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) }
|
||||
|
||||
/**
|
||||
* Set one (item, channel) pair.
|
||||
*
|
||||
* One pair, one sparse PUT: the endpoint writes only what it is given, so a
|
||||
* toggle cannot disturb a channel this screen is not showing — and the
|
||||
* response is the full stored truth, which is what the screen re-renders
|
||||
* from. An entry the server drops (an unknown id, an inapplicable channel)
|
||||
* therefore shows up as the control springing back, not as a silent lie.
|
||||
*/
|
||||
fun setMode(item: NotificationChannelItemDto, channel: String, mode: String) {
|
||||
val current = _state.value
|
||||
if (current.busy) return
|
||||
if (channel == CHANNEL_PUSH && !itemSelectable(item, current.hasLinkedAccount)) return
|
||||
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = notifications.setChannelMode(item.id, channel, mode)) {
|
||||
is ApiResult.Ok -> {
|
||||
_state.update { it.copy(prefs = UiState.Success(result.data)) }
|
||||
if (channel == CHANNEL_PUSH) reconcilePush(result.data) else finish(true, R.string.notifications_saved)
|
||||
}
|
||||
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 stored push set (PLAN.md §11).
|
||||
*
|
||||
* Read from the RESPONSE rather than from what was just sent, because the
|
||||
* server may have dropped the entry — and because "is any push mode on" is a
|
||||
* question about the whole table, not about the row that changed.
|
||||
*/
|
||||
private suspend fun reconcilePush(prefs: NotificationChannelPrefsDto) {
|
||||
val anyPushOn = prefs.items.any { item ->
|
||||
val mode = item.modes[CHANNEL_PUSH]
|
||||
mode != null && mode != MODE_OFF
|
||||
}
|
||||
if (!anyPushOn) {
|
||||
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 an item's controls are 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 itemSelectable(item: NotificationChannelItemDto, hasLinkedAccount: Boolean): Boolean =
|
||||
!item.requiresLinkedAccount || hasLinkedAccount
|
||||
@@ -1,182 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import android.Manifest
|
||||
import android.os.Build
|
||||
import androidx.activity.compose.rememberLauncherForActivityResult
|
||||
import androidx.activity.result.contract.ActivityResultContracts
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Row
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material3.HorizontalDivider
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Switch
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.font.FontStyle
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamDto
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.components.EmptyView
|
||||
import com.runicgateway.app.ui.components.ErrorView
|
||||
import com.runicgateway.app.ui.components.LoadingView
|
||||
import com.runicgateway.app.ui.components.SectionLabel
|
||||
|
||||
/**
|
||||
* The Notifications settings screen (PLAN.md §11, M7 Part 2 work item 6): the
|
||||
* subscribable catalog with per-stream toggles. Personal streams are greyed until a
|
||||
* game account is linked; turning a stream on requests the POST_NOTIFICATIONS
|
||||
* permission (API 33+) and registers the device, turning them all off unregisters it.
|
||||
*/
|
||||
@Composable
|
||||
fun NotificationsScreen(
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: NotificationsViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
val context = LocalContext.current
|
||||
|
||||
// Ask once for POST_NOTIFICATIONS when the user first enables a stream (API 33+).
|
||||
val permissionLauncher = rememberLauncherForActivityResult(
|
||||
ActivityResultContracts.RequestPermission(),
|
||||
) { /* granted or not, the subscription is already saved server-side */ }
|
||||
|
||||
fun ensureNotificationPermission() {
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
||||
permissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
|
||||
}
|
||||
}
|
||||
|
||||
Column(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(16.dp),
|
||||
) {
|
||||
Text(
|
||||
text = stringResource(R.string.notifications_title),
|
||||
style = MaterialTheme.typography.titleLarge,
|
||||
)
|
||||
Spacer(Modifier.height(4.dp))
|
||||
Text(
|
||||
text = stringResource(R.string.notifications_subtitle),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Spacer(Modifier.height(16.dp))
|
||||
|
||||
if (!state.supported) {
|
||||
EmptyView(message = stringResource(R.string.notifications_unsupported))
|
||||
return@Column
|
||||
}
|
||||
|
||||
state.feedback?.let { fb ->
|
||||
Text(
|
||||
text = stringResource(fb.messageRes),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = if (fb.ok) MaterialTheme.colorScheme.primary else MaterialTheme.colorScheme.error,
|
||||
modifier = Modifier.padding(bottom = 12.dp),
|
||||
)
|
||||
}
|
||||
|
||||
when (val catalog = state.catalog) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(kind = catalog.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> StreamList(
|
||||
streams = catalog.data,
|
||||
subscribed = state.subscribed,
|
||||
hasLinkedAccount = state.hasLinkedAccount,
|
||||
busy = state.busy,
|
||||
onToggle = { stream, on ->
|
||||
if (on) ensureNotificationPermission()
|
||||
viewModel.setSubscribed(stream, on)
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StreamList(
|
||||
streams: List<NotificationStreamDto>,
|
||||
subscribed: Set<String>,
|
||||
hasLinkedAccount: Boolean,
|
||||
busy: Boolean,
|
||||
onToggle: (NotificationStreamDto, Boolean) -> Unit,
|
||||
) {
|
||||
if (streams.isEmpty()) {
|
||||
EmptyView(message = stringResource(R.string.notifications_empty))
|
||||
return
|
||||
}
|
||||
val (personal, general) = streams.partition { it.personal }
|
||||
|
||||
if (general.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_general))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
general.forEach { stream ->
|
||||
StreamRow(stream, subscribed.contains(stream.id), enabled = !busy, hint = null) { on ->
|
||||
onToggle(stream, on)
|
||||
}
|
||||
HorizontalDivider()
|
||||
}
|
||||
Spacer(Modifier.height(20.dp))
|
||||
}
|
||||
|
||||
if (personal.isNotEmpty()) {
|
||||
SectionLabel(stringResource(R.string.notifications_section_personal))
|
||||
Spacer(Modifier.height(8.dp))
|
||||
personal.forEach { stream ->
|
||||
val selectable = streamSelectable(stream, hasLinkedAccount)
|
||||
val hint = if (!selectable) stringResource(R.string.notifications_requires_link) else null
|
||||
StreamRow(stream, subscribed.contains(stream.id) && selectable, enabled = !busy && selectable, hint = hint) { on ->
|
||||
onToggle(stream, on)
|
||||
}
|
||||
HorizontalDivider()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun StreamRow(
|
||||
stream: NotificationStreamDto,
|
||||
checked: Boolean,
|
||||
enabled: Boolean,
|
||||
hint: String?,
|
||||
onToggle: (Boolean) -> Unit,
|
||||
) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(vertical = 12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Column(modifier = Modifier.weight(1f).padding(end = 12.dp)) {
|
||||
Text(
|
||||
text = stream.label,
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
color = if (enabled) MaterialTheme.colorScheme.onSurface else MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
text = hint ?: stream.description,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
fontStyle = if (hint != null) FontStyle.Italic else FontStyle.Normal,
|
||||
)
|
||||
}
|
||||
Switch(checked = checked, onCheckedChange = onToggle, enabled = enabled)
|
||||
}
|
||||
}
|
||||
@@ -1,135 +0,0 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.notifications
|
||||
|
||||
import androidx.annotation.StringRes
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.core.push.PushManager
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.NotificationStreamDto
|
||||
import com.runicgateway.app.data.repository.NotificationsRepository
|
||||
import com.runicgateway.app.data.repository.PlayerShardRepository
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.toUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
|
||||
/**
|
||||
* Drives the Notifications settings screen (PLAN.md §11, M7 Part 2 work item 6):
|
||||
* the stream catalog with per-stream toggles bound to
|
||||
* `GET/PUT /auth/me/notifications/subscriptions`. A **personal** stream is greyed
|
||||
* until the user has a linked game account (§11), and turning the opt-in set
|
||||
* non-empty/empty drives the [PushManager] to register/unregister the device.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class NotificationsViewModel @Inject constructor(
|
||||
private val notifications: NotificationsRepository,
|
||||
private val playerShard: PlayerShardRepository,
|
||||
private val pushManager: PushManager,
|
||||
) : ViewModel() {
|
||||
|
||||
data class Feedback(val ok: Boolean, @param:StringRes val messageRes: Int)
|
||||
|
||||
data class State(
|
||||
val catalog: UiState<List<NotificationStreamDto>> = UiState.Loading,
|
||||
val subscribed: Set<String> = emptySet(),
|
||||
/** Whether the user has ≥1 linked game account — personal streams need it. */
|
||||
val hasLinkedAccount: Boolean = false,
|
||||
/** Whether this shard advertises a push relay at all (else the screen says so). */
|
||||
val supported: Boolean = true,
|
||||
val busy: Boolean = false,
|
||||
val feedback: Feedback? = null,
|
||||
)
|
||||
|
||||
private val _state = MutableStateFlow(State())
|
||||
val state: StateFlow<State> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
viewModelScope.launch {
|
||||
pushManager.supported.collect { supported -> _state.update { it.copy(supported = supported) } }
|
||||
}
|
||||
load()
|
||||
}
|
||||
|
||||
fun load() {
|
||||
_state.update { it.copy(catalog = UiState.Loading) }
|
||||
viewModelScope.launch {
|
||||
val catalog = notifications.streams().let { result ->
|
||||
when (result) {
|
||||
is ApiResult.Ok -> ApiResult.Ok(result.data.streams)
|
||||
is ApiResult.HttpError -> result
|
||||
is ApiResult.NetworkError -> result
|
||||
}
|
||||
}
|
||||
_state.update { it.copy(catalog = catalog.toUiState()) }
|
||||
|
||||
when (val subs = notifications.subscriptions()) {
|
||||
is ApiResult.Ok -> _state.update { it.copy(subscribed = subs.data.streams.toSet()) }
|
||||
else -> Unit
|
||||
}
|
||||
// A linked game account gates the personal streams; failure → treat as none.
|
||||
val linked = (playerShard.accounts() as? ApiResult.Ok)?.data?.isNotEmpty() == true
|
||||
_state.update { it.copy(hasLinkedAccount = linked) }
|
||||
}
|
||||
}
|
||||
|
||||
fun clearFeedback() = _state.update { it.copy(feedback = null) }
|
||||
|
||||
/** Toggle [stream]; refuses a personal stream with no linked account. */
|
||||
fun setSubscribed(stream: NotificationStreamDto, on: Boolean) {
|
||||
val s = _state.value
|
||||
if (s.busy) return
|
||||
if (on && !streamSelectable(stream, s.hasLinkedAccount)) return
|
||||
val next = if (on) s.subscribed + stream.id else s.subscribed - stream.id
|
||||
|
||||
_state.update { it.copy(busy = true, feedback = null) }
|
||||
viewModelScope.launch {
|
||||
when (val result = notifications.setSubscriptions(next.toList())) {
|
||||
is ApiResult.Ok -> {
|
||||
val stored = result.data.streams.toSet()
|
||||
_state.update { it.copy(subscribed = stored) }
|
||||
reconcilePush(stored)
|
||||
}
|
||||
is ApiResult.NetworkError -> finish(false, R.string.error_network)
|
||||
is ApiResult.HttpError -> finish(false, R.string.notifications_save_error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register or unregister the device to match the opted-in set (PLAN.md §11:
|
||||
* register when signed-in + subscribed, unregister when the set empties).
|
||||
*/
|
||||
private suspend fun reconcilePush(subscribed: Set<String>) {
|
||||
if (subscribed.isEmpty()) {
|
||||
pushManager.disable()
|
||||
finish(true, R.string.notifications_all_off)
|
||||
return
|
||||
}
|
||||
when (val res = pushManager.enable()) {
|
||||
is PushManager.PushResult.Enabled -> finish(true, R.string.notifications_saved)
|
||||
is PushManager.PushResult.Unsupported -> finish(false, R.string.notifications_unsupported)
|
||||
is PushManager.PushResult.NotSignedIn -> finish(false, R.string.notifications_save_error)
|
||||
is PushManager.PushResult.Failed ->
|
||||
finish(false, if (res.status == 400) R.string.notifications_relay_error else R.string.notifications_save_error)
|
||||
}
|
||||
}
|
||||
|
||||
private fun finish(ok: Boolean, @StringRes messageRes: Int) =
|
||||
_state.update { it.copy(busy = false, feedback = Feedback(ok, messageRes)) }
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a stream's toggle is selectable for a user: a personal stream needs a
|
||||
* linked game account (PLAN.md §11). Pure so the gating is unit-tested without Compose.
|
||||
*/
|
||||
fun streamSelectable(stream: NotificationStreamDto, hasLinkedAccount: Boolean): Boolean =
|
||||
!stream.requiresLinkedAccount || hasLinkedAccount
|
||||
@@ -13,7 +13,6 @@ 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
|
||||
@@ -26,6 +25,7 @@ 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.CharPointsDto
|
||||
import com.runicgateway.app.data.api.dto.CharProfileDto
|
||||
import com.runicgateway.app.data.api.dto.CharStatsDto
|
||||
import com.runicgateway.app.data.api.dto.EquipmentDto
|
||||
@@ -36,6 +36,7 @@ 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.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatBar
|
||||
import kotlinx.serialization.json.jsonPrimitive
|
||||
|
||||
@@ -71,6 +72,7 @@ private fun CharacterSheet(char: CharProfileDto, modifier: Modifier = Modifier)
|
||||
char.stats?.let { AttributesBlock(it) }
|
||||
char.stats?.resist?.let { ResistancesBlock(it) }
|
||||
SkillsBlock(char.skills)
|
||||
PointsBlock(displayPoints(char))
|
||||
EquipmentBlock(char.equipment)
|
||||
}
|
||||
}
|
||||
@@ -215,6 +217,47 @@ private fun SkillsBlock(skills: List<SkillDto>) {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Loyalty & points standings (Protocol 3.0 §7.3). Renders nothing at all for a
|
||||
* character that has earned nothing anywhere, which is a normal state.
|
||||
*
|
||||
* Only a system with a real cap gets a meter: an uncapped score
|
||||
* ([CharPointsDto.maxPoints] `0`, the common case on a real shard) has nothing to be
|
||||
* a fraction of, and a full-width bar would imply a completion that doesn't exist.
|
||||
*/
|
||||
@Composable
|
||||
private fun PointsBlock(points: List<CharPointsDto>) {
|
||||
if (points.isEmpty()) return
|
||||
SheetCard(R.string.player_char_points) {
|
||||
points.forEach { entry ->
|
||||
val cap = entry.cap
|
||||
val score = entry.points ?: 0L
|
||||
Column(Modifier.padding(vertical = 5.dp)) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(bottom = 4.dp),
|
||||
horizontalArrangement = Arrangement.SpaceBetween,
|
||||
) {
|
||||
Text(
|
||||
// `rank` is absent unless the shard opts in; absent and
|
||||
// "unranked" are different, so the suffix only appears when sent.
|
||||
entry.rank?.let { stringResource(R.string.player_char_points_ranked, pointsLabel(entry), it) }
|
||||
?: pointsLabel(entry),
|
||||
style = MaterialTheme.typography.labelMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
cap?.let { stringResource(R.string.player_char_points_of, score, it) } ?: score.toString(),
|
||||
style = MaterialTheme.typography.labelMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
fontWeight = FontWeight.Medium,
|
||||
)
|
||||
}
|
||||
if (cap != null) StatBar((score.toDouble() / cap).coerceIn(0.0, 1.0).toFloat())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
private fun EquipmentBlock(equipment: List<EquipmentDto>) {
|
||||
@@ -223,7 +266,7 @@ private fun EquipmentBlock(equipment: List<EquipmentDto>) {
|
||||
equipment.forEach { item ->
|
||||
Column(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
|
||||
Text(
|
||||
item.layer ?: stringResource(R.string.player_char_item),
|
||||
item.label ?: stringResource(R.string.player_char_item),
|
||||
style = MaterialTheme.typography.bodyLarge,
|
||||
)
|
||||
val meta = listOfNotNull(
|
||||
@@ -246,7 +289,7 @@ private fun EquipmentBlock(equipment: List<EquipmentDto>) {
|
||||
|
||||
@Composable
|
||||
private fun SheetCard(titleRes: Int, content: @Composable () -> Unit) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(titleRes), style = MaterialTheme.typography.titleMedium)
|
||||
content()
|
||||
@@ -266,23 +309,58 @@ internal fun formatSkill(value: Double): String =
|
||||
/**
|
||||
* 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.
|
||||
* reward title.
|
||||
*
|
||||
* Reward entries arrive as either a literal or a cliloc number in string form. The
|
||||
* server now resolves the numeric ones into `rewardResolved`, a **parallel** array
|
||||
* (see `docs/website/CLILOCS.md`), so the mapping below is index-preserving: an entry
|
||||
* that didn't resolve becomes null and is skipped, but must not shift the `selected`
|
||||
* index onto its neighbour. A number with no resolution is still skipped rather than
|
||||
* rendered as a raw id, which is also the whole behavior on a shard that configures
|
||||
* no cliloc table.
|
||||
*
|
||||
* Falling back to the first title that resolved (rather than showing nothing) matters
|
||||
* when the *selected* one is the unresolved entry. 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) }
|
||||
val reward = titles.reward.mapIndexed { i, raw ->
|
||||
titles.rewardResolved.getOrNull(i)
|
||||
?: raw.takeUnless { it.isBlank() || it.all(Char::isDigit) }
|
||||
}
|
||||
if (candidate != null && candidate.isNotBlank() && !candidate.all(Char::isDigit)) out.add(candidate)
|
||||
val candidate = reward.getOrNull(titles.selected ?: -1) ?: reward.firstNotNullOfOrNull { it }
|
||||
if (!candidate.isNullOrBlank()) out.add(candidate)
|
||||
return out.filter { it.isNotBlank() }.distinct()
|
||||
}
|
||||
|
||||
/**
|
||||
* A point system's display name: the shard's own [CharPointsDto.nameString] when it
|
||||
* has one, else the humanised `PointsType` key.
|
||||
*
|
||||
* The fallback is the PRIMARY path, not a defensive nicety — most systems name
|
||||
* themselves with a cliloc, so `nameString` comes back null for four of five boards
|
||||
* on a real shard (`docs/link/v3.md` §7.5). Parity with the website's
|
||||
* `humanisePoints`.
|
||||
*/
|
||||
internal fun pointsLabel(entry: CharPointsDto): String {
|
||||
entry.nameString?.takeIf { it.isNotBlank() }?.let { return it }
|
||||
val key = entry.system.orEmpty()
|
||||
return key
|
||||
.replace(Regex("([a-z0-9])([A-Z])"), "$1 $2")
|
||||
.replaceFirstChar { it.uppercaseChar() }
|
||||
}
|
||||
|
||||
/**
|
||||
* The points block, best standing first, dropping systems the character has no score
|
||||
* in. Guarded for an older shard plugin that sends no `points` block at all.
|
||||
*/
|
||||
internal fun displayPoints(char: CharProfileDto): List<CharPointsDto> =
|
||||
char.points
|
||||
.filter { (it.points ?: 0L) > 0L }
|
||||
.sortedByDescending { it.points ?: 0L }
|
||||
|
||||
private fun jsonText(element: kotlinx.serialization.json.JsonElement): String =
|
||||
runCatching { element.jsonPrimitive.content }.getOrElse { element.toString() }
|
||||
|
||||
@@ -13,7 +13,6 @@ 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
|
||||
@@ -39,6 +38,7 @@ 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.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
@@ -90,7 +90,7 @@ fun CharactersScreen(
|
||||
@Composable
|
||||
private fun LinkCard(state: CharactersViewModel.State, viewModel: CharactersViewModel) {
|
||||
var code by rememberSaveable { mutableStateOf("") }
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(R.string.player_link_title), style = MaterialTheme.typography.titleMedium)
|
||||
Text(
|
||||
@@ -121,7 +121,7 @@ private fun LinkCard(state: CharactersViewModel.State, viewModel: CharactersView
|
||||
private fun CreateAccountCard(state: CharactersViewModel.State, viewModel: CharactersViewModel) {
|
||||
var account by rememberSaveable { mutableStateOf("") }
|
||||
var password by rememberSaveable { mutableStateOf("") }
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(R.string.player_create_title), style = MaterialTheme.typography.titleMedium)
|
||||
OutlinedTextField(
|
||||
@@ -204,7 +204,7 @@ private fun RosterError(kind: ErrorKind, onRetry: () -> Unit) {
|
||||
|
||||
@Composable
|
||||
private fun CharRow(char: RosterCharDto, onOpenChar: (String) -> Unit) {
|
||||
Card(
|
||||
ShardCard(
|
||||
Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(vertical = 4.dp)
|
||||
|
||||
@@ -11,7 +11,6 @@ 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
|
||||
@@ -28,6 +27,7 @@ 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.ShardCard
|
||||
|
||||
/**
|
||||
* The player's own houses with home/decay status (PLAN.md §6.3), text-only. An
|
||||
@@ -60,7 +60,7 @@ fun MyHousesScreen(
|
||||
|
||||
@Composable
|
||||
private fun HouseCard(house: PlayerHouseDto) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Row(Modifier.fillMaxWidth()) {
|
||||
Text(
|
||||
|
||||
@@ -11,7 +11,6 @@ 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
|
||||
@@ -31,6 +30,7 @@ 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.ShardCard
|
||||
import java.text.DateFormat
|
||||
import java.util.Date
|
||||
|
||||
@@ -79,7 +79,7 @@ fun VendorsScreen(
|
||||
|
||||
@Composable
|
||||
private fun SalesCard(sales: UiState<List<VendorSaleDto>>) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(stringResource(R.string.player_sales_title), style = MaterialTheme.typography.titleMedium)
|
||||
when (sales) {
|
||||
@@ -185,7 +185,7 @@ private fun VendorError(kind: ErrorKind, onRetry: () -> Unit) {
|
||||
|
||||
@Composable
|
||||
private fun VendorCard(vendor: VendorDto) {
|
||||
Card(Modifier.fillMaxWidth().padding(vertical = 4.dp)) {
|
||||
ShardCard(Modifier.fillMaxWidth().padding(vertical = 4.dp)) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
vendor.shopName ?: stringResource(R.string.player_vendor_fallback),
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.core.result.ApiResult
|
||||
import com.runicgateway.app.data.repository.RustRepository
|
||||
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 live player count on the drawer's Rust row — the phone's answer to D15
|
||||
* (`docs/modules/rust/PLAN.md` §17.4).
|
||||
*
|
||||
* ## Why the drawer and not a footer
|
||||
*
|
||||
* D15 put "2 servers · 42 online" in core's `site.footer.status` slot, which
|
||||
* exists because every page of the website renders the same footer. The app has
|
||||
* no footer and no slot; what it has is a drawer row per surface and, already, a
|
||||
* precedent for a number beside one — the inbox's unread badge, in the same
|
||||
* `NavigationDrawerItem` badge slot, with the same screen-reader treatment. So
|
||||
* the count rides there.
|
||||
*
|
||||
* **The number is players, not servers.** A badge is one integer, and of the two
|
||||
* halves of D15's line the live one is how many people are on: a server count
|
||||
* changes when an operator edits configuration, which is not news, and is visible
|
||||
* on the page the row opens anyway.
|
||||
*
|
||||
* ## What keeps it honest
|
||||
*
|
||||
* The website's version renders nothing until it has an answer, nothing at all if
|
||||
* the request fails, and never polls — because one request per page view is a
|
||||
* cost and a timer in a footer on every page is a different kind of thing. All
|
||||
* three rules hold here:
|
||||
*
|
||||
* - **Zero renders nothing.** No badge, rather than a `0` — an empty server is
|
||||
* not a notification.
|
||||
* - **A failure leaves the last count** rather than dropping to zero. A moment
|
||||
* with no connectivity is not everybody logging off.
|
||||
* - **It refreshes on resume, with the unread badge**, and never on a timer. The
|
||||
* count is a glance, not a feed.
|
||||
*
|
||||
* It is asked for **only when the module is installed** — the caller gates on the
|
||||
* `rust` capability — so a site running a different game makes no request at all.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class RustBadgeViewModel @Inject constructor(
|
||||
private val repository: RustRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _online = MutableStateFlow(0)
|
||||
|
||||
/** How many people are on across every server, or 0 when there is nothing to say. */
|
||||
val online: StateFlow<Int> = _online.asStateFlow()
|
||||
|
||||
/**
|
||||
* Ask, if the Rust module is there.
|
||||
*
|
||||
* [installed] is passed in rather than read here so this holds no opinion
|
||||
* about capabilities: the drawer already knows, and a view model that
|
||||
* re-derived it would be a second copy of a rule that lives in one place.
|
||||
* Absent — the host has not answered yet — makes no request and keeps
|
||||
* whatever is showing.
|
||||
*/
|
||||
fun refresh(installed: Boolean) {
|
||||
if (!installed) {
|
||||
_online.value = 0
|
||||
return
|
||||
}
|
||||
|
||||
viewModelScope.launch {
|
||||
when (val result = repository.servers()) {
|
||||
// A server that is stale or unreachable already answers `online:
|
||||
// false` with `players: 0`, so summing the whole list needs no
|
||||
// second staleness rule here.
|
||||
is ApiResult.Ok -> _online.value = result.data.sumOf { it.players }
|
||||
// Keep the last number. See the class doc.
|
||||
else -> Unit
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
199
app/src/main/java/com/runicgateway/app/ui/rust/RustFeed.kt
Normal file
199
app/src/main/java/com/runicgateway/app/ui/rust/RustFeed.kt
Normal file
@@ -0,0 +1,199 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import com.runicgateway.app.data.api.dto.RustEventDto
|
||||
|
||||
/**
|
||||
* One stored frame as one line of a feed — the Kotlin half of `module-rust`'s
|
||||
* `client/src/lib/feed.js` (PLAN.md §9 M14).
|
||||
*
|
||||
* `GET /public/rust/servers/{id}/events` answers rows shaped
|
||||
* `{ id, kind, t, wipeId, steamId, frame }`, where `frame` is the whole frame the
|
||||
* bridge plugin emitted. Everything a killfeed line needs is in there, under the
|
||||
* names the plugin wrote, and **this file is the one place in the app that knows
|
||||
* them**.
|
||||
*
|
||||
* ## It returns parts, not a sentence
|
||||
*
|
||||
* A row wants the names emphasised and the detail muted, and a function returning
|
||||
* `"Alice killed Bob"` would force the screen to re-parse its own output to style
|
||||
* it. Parts also make this testable without Compose, which is the only way this
|
||||
* leg has real coverage of what a feed row says.
|
||||
*
|
||||
* ## The rule for an unknown kind
|
||||
*
|
||||
* **It renders as itself.** A later protocol adds kinds and an operator's module
|
||||
* may be older than their game host, so a feed that dropped what it did not
|
||||
* recognise would be a screen quietly saying less than the truth. The server's
|
||||
* allowlist has already decided the row may be seen; what is left here is
|
||||
* presentation, and the honest presentation of a kind we have no words for is its
|
||||
* own name.
|
||||
*/
|
||||
|
||||
/** The row's category, for the small colour a screen gives it — never for meaning. */
|
||||
enum class FeedTone { KILL, DEATH, JOIN, LEAVE, CHAT, SERVER, OTHER }
|
||||
|
||||
/**
|
||||
* One row, ready to render.
|
||||
*
|
||||
* [actor] and [subject] are names and are emphasised; [verb] and [detail] are
|
||||
* prose. Any of them may be null or empty.
|
||||
*
|
||||
* [join] is what goes between the actor and the verb, and it exists for exactly
|
||||
* one case: chat. "Brannock see you in september" is not a sentence anybody
|
||||
* writes, and putting the colon in the message would put presentation inside text
|
||||
* a player typed.
|
||||
*/
|
||||
data class FeedLine(
|
||||
val tone: FeedTone,
|
||||
val actor: String? = null,
|
||||
val join: String = " ",
|
||||
val verb: String = "",
|
||||
val subject: String? = null,
|
||||
val detail: String = "",
|
||||
)
|
||||
|
||||
/** One filter the feed offers, and the kinds it asks the API for. */
|
||||
data class FeedFilter(val id: String, val label: String, val kinds: List<String>)
|
||||
|
||||
/**
|
||||
* Kinds this feed asks for.
|
||||
*
|
||||
* `player.tally` is public and deliberately **not** here: it is an aggregate the
|
||||
* plugin flushes every sixty seconds per active player, so a feed including it
|
||||
* would be mostly wood counts. It is the leaderboard's input, and the leaderboard
|
||||
* is where it shows up.
|
||||
*/
|
||||
val FEED_KINDS: List<String> = listOf(
|
||||
"player.death",
|
||||
"player.connected",
|
||||
"player.disconnected",
|
||||
"player.respawned",
|
||||
"player.chat",
|
||||
"server.wipe",
|
||||
"server.initialized",
|
||||
"server.shutdown",
|
||||
)
|
||||
|
||||
/** The filters the feed offers. The first is the default and asks for everything. */
|
||||
val FEED_FILTERS: List<FeedFilter> = listOf(
|
||||
FeedFilter("all", "Everything", FEED_KINDS),
|
||||
FeedFilter("kills", "Kills", listOf("player.death")),
|
||||
FeedFilter("chat", "Chat", listOf("player.chat")),
|
||||
FeedFilter(
|
||||
"sessions",
|
||||
"Comings and goings",
|
||||
listOf("player.connected", "player.disconnected", "player.respawned"),
|
||||
),
|
||||
FeedFilter("server", "Server", listOf("server.wipe", "server.initialized", "server.shutdown")),
|
||||
)
|
||||
|
||||
/** The kinds a filter id asks for; an id nobody offers falls back to everything. */
|
||||
fun kindsFor(filterId: String): List<String> =
|
||||
(FEED_FILTERS.firstOrNull { it.id == filterId } ?: FEED_FILTERS.first()).kinds
|
||||
|
||||
/** One row as the parts a screen renders. */
|
||||
fun describe(row: RustEventDto): FeedLine {
|
||||
val name = row.str("name")
|
||||
|
||||
return when (row.kind) {
|
||||
"player.death" -> death(row, name)
|
||||
|
||||
"player.connected" ->
|
||||
FeedLine(FeedTone.JOIN, actor = name, verb = "connected")
|
||||
|
||||
"player.disconnected" -> FeedLine(
|
||||
tone = FeedTone.LEAVE,
|
||||
actor = name,
|
||||
verb = "disconnected",
|
||||
// Two optional halves, and the session is the interesting one. The
|
||||
// plugin OMITS `sessionSec` for a player who was already on when it
|
||||
// loaded, so an absent value means "unknown" and never zero — which is
|
||||
// why this reads the parsed number rather than trusting a default.
|
||||
detail = listOfNotNull(
|
||||
row.str("reason"),
|
||||
row.num("sessionSec")?.takeIf { it > 0 }?.let { "after ${playtime(it.toLong())}" },
|
||||
).joinToString(" · "),
|
||||
)
|
||||
|
||||
"player.respawned" ->
|
||||
FeedLine(FeedTone.JOIN, actor = name, verb = "respawned")
|
||||
|
||||
"player.chat" -> FeedLine(
|
||||
tone = FeedTone.CHAT,
|
||||
actor = name,
|
||||
join = ": ",
|
||||
// The message is the row, so it goes in `verb` where a screen renders
|
||||
// it unemphasised — and it is the one field on this wire whose bytes a
|
||||
// player chooses. Compose renders it as text and never as markup;
|
||||
// nothing here may ever stop doing that.
|
||||
verb = row.str("message").orEmpty(),
|
||||
detail = row.str("channel")?.takeIf { it != "Global" }.orEmpty(),
|
||||
)
|
||||
|
||||
"server.wipe" -> FeedLine(
|
||||
tone = FeedTone.SERVER,
|
||||
verb = "The map was wiped",
|
||||
detail = row.str("wipeId")?.let { "new wipe $it" }.orEmpty(),
|
||||
)
|
||||
|
||||
"server.initialized" -> FeedLine(FeedTone.SERVER, verb = "The server came up")
|
||||
|
||||
"server.shutdown" -> FeedLine(FeedTone.SERVER, verb = "The server went down")
|
||||
|
||||
else -> FeedLine(
|
||||
tone = FeedTone.OTHER,
|
||||
actor = name,
|
||||
verb = row.kind.takeIf { it.isNotBlank() } ?: "unknown",
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A death, which is four different sentences.
|
||||
*
|
||||
* The plugin distinguishes `player`, `self`, `npc` and `environment` precisely so
|
||||
* a reader does not have to guess from an absent field, and collapsing any two of
|
||||
* them loses something. A killfeed reporting a fall as a kill by nobody is the
|
||||
* failure this avoids.
|
||||
*/
|
||||
private fun death(row: RustEventDto, name: String?): FeedLine {
|
||||
val where = listOfNotNull(
|
||||
row.str("weapon")?.let { "with ${prefabName(it)}" },
|
||||
row.num("distance")?.let { "${Math.round(it)}m" },
|
||||
row.str("grid"),
|
||||
if (row.flag("sleeping")) "while sleeping" else null,
|
||||
).joinToString(" · ")
|
||||
|
||||
return when (row.str("attackerType")) {
|
||||
"player" -> FeedLine(
|
||||
tone = FeedTone.KILL,
|
||||
actor = row.str("attackerName"),
|
||||
verb = "killed",
|
||||
subject = name,
|
||||
detail = where,
|
||||
)
|
||||
|
||||
"self" -> FeedLine(
|
||||
tone = FeedTone.DEATH,
|
||||
actor = name,
|
||||
verb = "died by their own hand",
|
||||
detail = where,
|
||||
)
|
||||
|
||||
"npc" -> FeedLine(
|
||||
tone = FeedTone.DEATH,
|
||||
actor = prefabName(row.str("attackerName")).ifBlank { "Something" },
|
||||
verb = "killed",
|
||||
subject = name,
|
||||
detail = where,
|
||||
)
|
||||
|
||||
// `environment` and anything else: falling, drowning, the world. The
|
||||
// plugin legitimately has no attacker on this path, so an ABSENT type is
|
||||
// this case rather than a missing field to complain about.
|
||||
else -> FeedLine(tone = FeedTone.DEATH, actor = name, verb = "died", detail = where)
|
||||
}
|
||||
}
|
||||
154
app/src/main/java/com/runicgateway/app/ui/rust/RustFormat.kt
Normal file
154
app/src/main/java/com/runicgateway/app/ui/rust/RustFormat.kt
Normal file
@@ -0,0 +1,154 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import com.runicgateway.app.core.time.parseWireInstant
|
||||
import java.time.Instant
|
||||
import java.time.ZoneId
|
||||
import java.time.format.DateTimeFormatter
|
||||
import java.time.format.FormatStyle
|
||||
import java.util.Locale
|
||||
|
||||
/**
|
||||
* Formatting for the Rust screens — pure, no Compose, no Android (PLAN.md §9
|
||||
* M14).
|
||||
*
|
||||
* The Kotlin half of `module-rust`'s `client/src/lib/format.js`, and it is a
|
||||
* deliberate second implementation rather than something shared: the two clients
|
||||
* have different formatting libraries under them (`Intl` there, `java.time`
|
||||
* here), and the thing worth keeping identical is the **rules**, not the code.
|
||||
* Those rules are restated here beside each function so a reader can check them
|
||||
* against the website without opening it.
|
||||
*
|
||||
* Everything takes `now` as a parameter, so a boundary is testable rather than a
|
||||
* property of the machine the test runs on.
|
||||
*/
|
||||
|
||||
/**
|
||||
* The stamp on a feed row.
|
||||
*
|
||||
* **Today's rows get a time; everything older gets a date as well.** The feed can
|
||||
* be filtered to a past wipe, and a row from six weeks ago rendered as `14:03`
|
||||
* reads as this afternoon — which is exactly what the website's own page walk
|
||||
* found, three events from August all apparently a few minutes old. The boundary
|
||||
* is the **calendar day**, not a duration, because that is what a reader means by
|
||||
* "what time was that".
|
||||
*/
|
||||
fun feedClock(
|
||||
value: String?,
|
||||
epochMillis: Long? = null,
|
||||
now: Instant = Instant.now(),
|
||||
zone: ZoneId = ZoneId.systemDefault(),
|
||||
locale: Locale = Locale.getDefault(),
|
||||
): String {
|
||||
val at = epochMillis?.takeIf { it > 0 }?.let(Instant::ofEpochMilli) ?: parseWireInstant(value) ?: return ""
|
||||
|
||||
val time = DateTimeFormatter.ofLocalizedTime(FormatStyle.SHORT)
|
||||
.withLocale(locale)
|
||||
.format(at.atZone(zone))
|
||||
|
||||
val sameDay = at.atZone(zone).toLocalDate() == now.atZone(zone).toLocalDate()
|
||||
if (sameDay) return time
|
||||
|
||||
val date = DateTimeFormatter.ofPattern("d MMM", locale).format(at.atZone(zone))
|
||||
return "$date $time"
|
||||
}
|
||||
|
||||
/** A date, for a wipe: the thing people actually compare wipes by. */
|
||||
fun wipeDay(
|
||||
value: String?,
|
||||
zone: ZoneId = ZoneId.systemDefault(),
|
||||
locale: Locale = Locale.getDefault(),
|
||||
): String? {
|
||||
val at = parseWireInstant(value) ?: return null
|
||||
return DateTimeFormatter.ofLocalizedDate(FormatStyle.MEDIUM)
|
||||
.withLocale(locale)
|
||||
.format(at.atZone(zone))
|
||||
}
|
||||
|
||||
/**
|
||||
* "3 minutes ago", for a "last reported" line.
|
||||
*
|
||||
* Returns null rather than a word for an absent stamp, so the caller decides what
|
||||
* "never" looks like in its own layout — on this surface a server that has never
|
||||
* reported is a real and ordinary state, not a missing value to apologise for.
|
||||
*/
|
||||
fun rustAgo(value: String?, now: Instant = Instant.now()): String? {
|
||||
val at = parseWireInstant(value) ?: return null
|
||||
val seconds = java.time.Duration.between(at, now).seconds
|
||||
|
||||
// Under a minute in either direction, say the thing rather than "in 0 seconds".
|
||||
if (kotlin.math.abs(seconds) < 45) return "just now"
|
||||
|
||||
val future = seconds < 0
|
||||
val magnitude = kotlin.math.abs(seconds)
|
||||
val (unit, size) = AGO_UNITS.first { magnitude >= it.second }
|
||||
val amount = Math.round(magnitude.toDouble() / size)
|
||||
val plural = if (amount == 1L) unit else "${unit}s"
|
||||
|
||||
return if (future) "in $amount $plural" else "$amount $plural ago"
|
||||
}
|
||||
|
||||
private val AGO_UNITS = listOf(
|
||||
"year" to 31_536_000L,
|
||||
"month" to 2_592_000L,
|
||||
"week" to 604_800L,
|
||||
"day" to 86_400L,
|
||||
"hour" to 3_600L,
|
||||
"minute" to 60L,
|
||||
"second" to 1L,
|
||||
)
|
||||
|
||||
/**
|
||||
* A session or a playtime, as `4h 12m`.
|
||||
*
|
||||
* Seconds are dropped above a minute and kept below it: a two-hour session
|
||||
* reported to the second is noise, and a forty-second one reported as "0m" is
|
||||
* wrong.
|
||||
*/
|
||||
fun playtime(seconds: Long?): String {
|
||||
val total = seconds ?: return "—"
|
||||
if (total <= 0) return "—"
|
||||
if (total < 60) return "${total}s"
|
||||
|
||||
val hours = total / 3600
|
||||
val minutes = Math.round((total % 3600) / 60.0)
|
||||
|
||||
return when {
|
||||
hours == 0L -> "${minutes}m"
|
||||
minutes == 0L -> "${hours}h"
|
||||
else -> "${hours}h ${minutes}m"
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A prefab short name as something readable — `patrolhelicopter` stays itself,
|
||||
* `rifle.ak` becomes `rifle ak`.
|
||||
*
|
||||
* Deliberately a light touch rather than a lookup table: a table mapping every
|
||||
* Rust prefab to a pretty name is a second copy of the game's item list that goes
|
||||
* stale every wipe, and the short name is what a Rust player reads on their own
|
||||
* server console anyway.
|
||||
*/
|
||||
fun prefabName(name: String?): String {
|
||||
if (name.isNullOrBlank()) return ""
|
||||
return name.replace(Regex("[_.]+"), " ").trim()
|
||||
}
|
||||
|
||||
/** A steam id, shortened for a table cell, without pretending it is a name. */
|
||||
fun shortSteamId(steamId: String?): String {
|
||||
val id = steamId.orEmpty()
|
||||
return if (id.length > 10) "…${id.takeLast(6)}" else id
|
||||
}
|
||||
|
||||
/**
|
||||
* What to call a player who has no name yet.
|
||||
*
|
||||
* The presence board and the leaderboard both carry a nullable `name`: the plugin
|
||||
* knows a steam id before it knows anything else. Showing a shortened id is
|
||||
* honest — it is not a name and does not look like one — where "Unknown" would
|
||||
* lose the only identifier there is.
|
||||
*/
|
||||
fun playerLabel(name: String?, steamId: String?): String =
|
||||
name?.takeIf { it.isNotBlank() } ?: shortSteamId(steamId)
|
||||
@@ -0,0 +1,566 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.horizontalScroll
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
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.foundation.rememberScrollState
|
||||
import androidx.compose.material3.FilterChip
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.ScrollableTabRow
|
||||
import androidx.compose.material3.Tab
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.draw.alpha
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.font.FontWeight
|
||||
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.RustEventDto
|
||||
import com.runicgateway.app.data.api.dto.RustLeaderboardRowDto
|
||||
import com.runicgateway.app.data.api.dto.RustPresenceDto
|
||||
import com.runicgateway.app.data.api.dto.RustServerDto
|
||||
import com.runicgateway.app.data.api.dto.RustWipeDto
|
||||
import com.runicgateway.app.ui.ErrorKind
|
||||
import com.runicgateway.app.ui.PollWhileResumed
|
||||
import com.runicgateway.app.ui.Polled
|
||||
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.PillTone
|
||||
import com.runicgateway.app.ui.components.SectionLabel
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* One Rust server: the feed, the leaderboard, who is on, and the wipes (D13).
|
||||
*
|
||||
* **One screen with tabs, not four destinations** — the same call the website
|
||||
* makes, and more obviously right on a phone: the four panels are four questions
|
||||
* about one thing, and a reader moving between them is not navigating.
|
||||
*
|
||||
* The phase criterion lives here. With the server unreachable this still renders
|
||||
* its map, size, seed, wipe date, killfeed, leaderboards, last known presence
|
||||
* board and wipe history, because every one of those is read from the website's
|
||||
* own tables rather than from the game.
|
||||
*/
|
||||
@Composable
|
||||
fun RustServerScreen(
|
||||
onBack: () -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: RustServerViewModel = hiltViewModel(),
|
||||
) {
|
||||
val ui by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
PollWhileResumed { viewModel.refresh() }
|
||||
|
||||
when (val s = ui.server.state) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
|
||||
// **A mistyped address is not a fault and must not be dressed as one.**
|
||||
// The website's first version put its generic error panel under this
|
||||
// heading, so an unknown id read "No such server / Something went wrong"
|
||||
// and sent a reader looking for an outage. A 404 is its own answer; the
|
||||
// error panel is kept for a request that failed for a reason nobody can
|
||||
// see. A server an operator disabled answers the same 404 — switching one
|
||||
// off is not switching it into a refusal.
|
||||
is UiState.Error -> if (s.kind == ErrorKind.NOT_FOUND) {
|
||||
MissingServer(onBack, modifier)
|
||||
} else {
|
||||
ErrorView(s.kind, onRetry = viewModel::load, modifier = modifier)
|
||||
}
|
||||
|
||||
is UiState.Success -> ServerDetail(s.data, ui, viewModel, modifier)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun MissingServer(onBack: () -> Unit, modifier: Modifier = Modifier) {
|
||||
Column(
|
||||
modifier = modifier.fillMaxSize().padding(24.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
Text(stringResource(R.string.rust_no_such_server), style = MaterialTheme.typography.titleLarge)
|
||||
Text(
|
||||
text = stringResource(R.string.rust_no_such_server_detail),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
Text(
|
||||
text = stringResource(R.string.rust_back_to_servers),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.primary,
|
||||
modifier = Modifier.clickable(onClick = onBack).padding(top = 8.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ServerDetail(
|
||||
server: RustServerDto,
|
||||
ui: RustServerUi,
|
||||
viewModel: RustServerViewModel,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
Column(modifier.fillMaxSize()) {
|
||||
ServerHeader(server, ui.selectedWipe, viewModel::selectWipe, ui.wipes)
|
||||
|
||||
val tabs = RustTab.entries
|
||||
ScrollableTabRow(selectedTabIndex = tabs.indexOf(ui.tab), edgePadding = 16.dp) {
|
||||
tabs.forEach { tab ->
|
||||
Tab(
|
||||
selected = tab == ui.tab,
|
||||
onClick = { viewModel.selectTab(tab) },
|
||||
text = { Text(stringResource(tabLabel(tab))) },
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
when (ui.tab) {
|
||||
RustTab.FEED -> FeedPanel(ui.feed, ui.filterId, viewModel::selectFilter, viewModel::retryFeed)
|
||||
RustTab.LEADERBOARD -> LeaderboardPanel(
|
||||
ui.leaderboard,
|
||||
ui.sort,
|
||||
viewModel::selectSort,
|
||||
viewModel::retryLeaderboard,
|
||||
)
|
||||
RustTab.ONLINE -> OnlinePanel(ui.online, server.online, viewModel::retryOnline)
|
||||
RustTab.WIPES -> WipesPanel(
|
||||
ui.wipes,
|
||||
server.wipeId,
|
||||
ui.selectedWipe,
|
||||
viewModel::openWipe,
|
||||
viewModel::retryWipes,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun tabLabel(tab: RustTab): Int = when (tab) {
|
||||
RustTab.FEED -> R.string.rust_tab_feed
|
||||
RustTab.LEADERBOARD -> R.string.rust_tab_leaderboard
|
||||
RustTab.ONLINE -> R.string.rust_tab_online
|
||||
RustTab.WIPES -> R.string.rust_tab_wipes
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ServerHeader(
|
||||
server: RustServerDto,
|
||||
selectedWipe: String?,
|
||||
onSelectWipe: (String?) -> Unit,
|
||||
wipes: UiState<List<RustWipeDto>>,
|
||||
) {
|
||||
Column(Modifier.padding(horizontal = 16.dp, vertical = 12.dp)) {
|
||||
Text(server.name.ifBlank { server.id }, style = MaterialTheme.typography.headlineSmall)
|
||||
|
||||
describeWorld(server)?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 4.dp),
|
||||
)
|
||||
}
|
||||
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().padding(top = 8.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
if (server.online) {
|
||||
StatusPill(
|
||||
text = stringResource(R.string.rust_online_count, server.players, server.maxPlayers),
|
||||
tone = PillTone.Success,
|
||||
)
|
||||
} else {
|
||||
StatusPill(text = stringResource(R.string.rust_offline), tone = PillTone.Neutral)
|
||||
}
|
||||
Text(
|
||||
text = lastReported(server),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
|
||||
// The wipe picker sits above the tabs because it filters two of them. It
|
||||
// is absent until the wipe list has loaded — offering a filter with one
|
||||
// option would look like a server that has only ever had one wipe.
|
||||
val available = (wipes as? UiState.Success)?.data.orEmpty()
|
||||
if (available.isNotEmpty()) {
|
||||
WipeFilter(available, server.wipeId, selectedWipe, onSelectWipe)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun WipeFilter(
|
||||
wipes: List<RustWipeDto>,
|
||||
currentWipeId: String?,
|
||||
selected: String?,
|
||||
onSelect: (String?) -> Unit,
|
||||
) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().horizontalScroll(rememberScrollState()).padding(top = 10.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
// **Null is all time, and it is the default.** It is a real choice rather
|
||||
// than an absent filter: all-time is the per-wipe rows summed, which is
|
||||
// the answer to "who plays here", where a wipe is the answer to "who is
|
||||
// winning now".
|
||||
FilterChip(
|
||||
selected = selected == null,
|
||||
onClick = { onSelect(null) },
|
||||
label = { Text(stringResource(R.string.rust_all_time)) },
|
||||
)
|
||||
wipes.forEach { wipe ->
|
||||
val label = wipeDay(wipe.saveCreatedAt ?: wipe.firstSeen) ?: wipe.wipeId
|
||||
FilterChip(
|
||||
selected = selected == wipe.wipeId,
|
||||
onClick = { onSelect(wipe.wipeId) },
|
||||
label = {
|
||||
Text(
|
||||
if (wipe.wipeId == currentWipeId) {
|
||||
stringResource(R.string.rust_wipe_current, label)
|
||||
} else {
|
||||
label
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Feed ──────────────────────────────────────────────────────────────────
|
||||
|
||||
@Composable
|
||||
private fun FeedPanel(
|
||||
feed: Polled<List<RustEventDto>>,
|
||||
filterId: String,
|
||||
onFilter: (String) -> Unit,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
Column(Modifier.fillMaxSize()) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth().horizontalScroll(rememberScrollState())
|
||||
.padding(horizontal = 16.dp, vertical = 8.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
FEED_FILTERS.forEach { filter ->
|
||||
FilterChip(
|
||||
selected = filter.id == filterId,
|
||||
onClick = { onFilter(filter.id) },
|
||||
label = { Text(filter.label) },
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
when (val s = feed.state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = onRetry)
|
||||
is UiState.Success -> if (s.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.rust_feed_empty))
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(horizontal = 16.dp, vertical = 8.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(10.dp),
|
||||
) {
|
||||
if (feed.refreshFailed) {
|
||||
item { RefreshFailedLine() }
|
||||
}
|
||||
items(s.data, key = { it.id }) { FeedRow(it) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun FeedRow(row: RustEventDto) {
|
||||
val line = describe(row)
|
||||
|
||||
Row(verticalAlignment = Alignment.Top) {
|
||||
// The stamp carries a date for anything not from today — a row from six
|
||||
// weeks ago rendered as a bare time reads as this afternoon, which is
|
||||
// exactly what happens the moment the feed is filtered to a past wipe.
|
||||
Text(
|
||||
text = feedClock(value = null, epochMillis = row.t),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(end = 10.dp, top = 2.dp),
|
||||
)
|
||||
Column {
|
||||
Row {
|
||||
line.actor?.let {
|
||||
Text(it, style = MaterialTheme.typography.bodyMedium, fontWeight = FontWeight.SemiBold)
|
||||
Text(line.join, style = MaterialTheme.typography.bodyMedium)
|
||||
}
|
||||
// The chat message lands here, and it is the one field on this
|
||||
// wire whose bytes a player chooses. Compose renders it as text
|
||||
// and never as markup; nothing here may ever stop doing that.
|
||||
Text(line.verb, style = MaterialTheme.typography.bodyMedium)
|
||||
line.subject?.let {
|
||||
Text(" ", style = MaterialTheme.typography.bodyMedium)
|
||||
Text(it, style = MaterialTheme.typography.bodyMedium, fontWeight = FontWeight.SemiBold)
|
||||
}
|
||||
}
|
||||
if (line.detail.isNotBlank()) {
|
||||
Text(
|
||||
text = line.detail,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Leaderboard ───────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* The columns, and which of them the API can sort by.
|
||||
*
|
||||
* `structures` has no sort on the wire and therefore no tap here — a header that
|
||||
* sorts by something other than what it says is worse than one that does not
|
||||
* sort.
|
||||
*/
|
||||
private data class RustColumn(val labelRes: Int, val sort: String?, val value: (RustLeaderboardRowDto) -> String)
|
||||
|
||||
/** The name's share of the row against one numeric column's. */
|
||||
private const val NAME_WEIGHT = 1.7f
|
||||
|
||||
/** How far a header that is not the current sort is faded. */
|
||||
private const val SORTED_AWAY = 0.55f
|
||||
|
||||
private val RUST_COLUMNS = listOf(
|
||||
RustColumn(R.string.rust_col_kills, RustSort.KILLS) { it.kills.toString() },
|
||||
RustColumn(R.string.rust_col_deaths, RustSort.DEATHS) { it.deaths.toString() },
|
||||
RustColumn(R.string.rust_col_npc_kills, RustSort.NPC_KILLS) { it.npcKills.toString() },
|
||||
RustColumn(R.string.rust_col_structures, null) { it.structures.toString() },
|
||||
RustColumn(R.string.rust_col_played, RustSort.PLAYTIME) { playtime(it.playtimeSec) },
|
||||
)
|
||||
|
||||
@Composable
|
||||
private fun LeaderboardPanel(
|
||||
state: UiState<List<RustLeaderboardRowDto>>,
|
||||
sort: String,
|
||||
onSort: (String) -> Unit,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
when (state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(state.kind, onRetry = onRetry)
|
||||
is UiState.Success -> if (state.data.isEmpty()) {
|
||||
// **Empty is a real answer here and is not "no data".** All-time is
|
||||
// the per-wipe rows summed, so a player who appears only in an older
|
||||
// wipe drops out of the current one rather than reading zero — an
|
||||
// empty board for a wipe means nobody scored on that map.
|
||||
EmptyView(stringResource(R.string.rust_leaderboard_empty))
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
item {
|
||||
Row(Modifier.fillMaxWidth()) {
|
||||
SectionLabel(
|
||||
text = stringResource(R.string.rust_col_player),
|
||||
modifier = Modifier.weight(NAME_WEIGHT),
|
||||
)
|
||||
RUST_COLUMNS.forEach { column ->
|
||||
// The ACTIVE sort is marked on the header, not on the
|
||||
// values: the header is the control, and tinting a
|
||||
// column of numbers instead says "these are special"
|
||||
// rather than "this is what the table is ordered by".
|
||||
SectionLabel(
|
||||
text = stringResource(column.labelRes),
|
||||
modifier = Modifier
|
||||
.weight(1f)
|
||||
.then(
|
||||
if (column.sort != null) {
|
||||
Modifier.clickable { onSort(column.sort) }
|
||||
} else {
|
||||
Modifier
|
||||
},
|
||||
)
|
||||
.then(
|
||||
if (column.sort == sort) {
|
||||
Modifier.alpha(1f)
|
||||
} else {
|
||||
Modifier.alpha(SORTED_AWAY)
|
||||
},
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
items(state.data, key = { it.steamId }) { row ->
|
||||
Row(Modifier.fillMaxWidth(), verticalAlignment = Alignment.CenterVertically) {
|
||||
// A wider share for the name, and one line with an ellipsis.
|
||||
// Five numeric columns beside an equal-weight name column
|
||||
// left "Brannock" touching its own kill count, which the
|
||||
// walk read as one field.
|
||||
Text(
|
||||
text = playerLabel(row.name, row.steamId),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
maxLines = 1,
|
||||
overflow = TextOverflow.Ellipsis,
|
||||
modifier = Modifier.weight(NAME_WEIGHT).padding(end = 8.dp),
|
||||
)
|
||||
RUST_COLUMNS.forEach { column ->
|
||||
Text(
|
||||
text = column.value(row),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
maxLines = 1,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Online ────────────────────────────────────────────────────────────────
|
||||
|
||||
@Composable
|
||||
private fun OnlinePanel(
|
||||
online: Polled<List<RustPresenceDto>>,
|
||||
serverOnline: Boolean,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
when (val s = online.state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = onRetry)
|
||||
is UiState.Success -> if (s.data.isEmpty()) {
|
||||
EmptyView(
|
||||
stringResource(
|
||||
if (serverOnline) R.string.rust_nobody_on else R.string.rust_presence_offline,
|
||||
),
|
||||
)
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
// **The board is the last one that ARRIVED, and an unreachable
|
||||
// server does not clear it** — deliberately, because these rows
|
||||
// are still the best answer anybody has. Presented bare they read
|
||||
// as "these people are on right now", which is the one thing an
|
||||
// offline server cannot be saying. So the panel says which it is.
|
||||
item {
|
||||
Text(
|
||||
text = stringResource(
|
||||
if (serverOnline) R.string.rust_presence_live else R.string.rust_presence_last_known,
|
||||
),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
if (online.refreshFailed) {
|
||||
item { RefreshFailedLine() }
|
||||
}
|
||||
items(s.data, key = { it.steamId }) { player ->
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = playerLabel(player.name, player.steamId),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
if (player.sleeping) {
|
||||
StatusPill(
|
||||
text = stringResource(R.string.rust_sleeping),
|
||||
tone = PillTone.Neutral,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Wipes ─────────────────────────────────────────────────────────────────
|
||||
|
||||
@Composable
|
||||
private fun WipesPanel(
|
||||
state: UiState<List<RustWipeDto>>,
|
||||
currentWipeId: String?,
|
||||
selected: String?,
|
||||
onOpenWipe: (String) -> Unit,
|
||||
onRetry: () -> Unit,
|
||||
) {
|
||||
when (state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(state.kind, onRetry = onRetry)
|
||||
is UiState.Success -> if (state.data.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.rust_wipes_empty))
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
items(state.data, key = { it.wipeId }) { wipe ->
|
||||
ShardCard(
|
||||
Modifier.fillMaxWidth().clickable { onOpenWipe(wipe.wipeId) },
|
||||
) {
|
||||
Row(
|
||||
Modifier.fillMaxWidth().padding(16.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = wipeDay(wipe.saveCreatedAt ?: wipe.firstSeen) ?: wipe.wipeId,
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
if (wipe.wipeId == currentWipeId) {
|
||||
StatusPill(
|
||||
text = stringResource(R.string.rust_wipe_this_one),
|
||||
tone = PillTone.Success,
|
||||
)
|
||||
} else if (wipe.wipeId == selected) {
|
||||
StatusPill(
|
||||
text = stringResource(R.string.rust_wipe_selected),
|
||||
tone = PillTone.Info,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun RefreshFailedLine() {
|
||||
Text(
|
||||
text = stringResource(R.string.rust_refresh_failed),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,268 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.RustEventDto
|
||||
import com.runicgateway.app.data.api.dto.RustLeaderboardRowDto
|
||||
import com.runicgateway.app.data.api.dto.RustPresenceDto
|
||||
import com.runicgateway.app.data.api.dto.RustServerDto
|
||||
import com.runicgateway.app.data.api.dto.RustWipeDto
|
||||
import com.runicgateway.app.data.repository.RustRepository
|
||||
import com.runicgateway.app.ui.Polled
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.navigation.Routes
|
||||
import com.runicgateway.app.ui.refreshInto
|
||||
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 four sections of a server's page (D13). */
|
||||
enum class RustTab { FEED, LEADERBOARD, ONLINE, WIPES }
|
||||
|
||||
/** What a leaderboard column sorts by — the API's own vocabulary, not the app's. */
|
||||
object RustSort {
|
||||
const val KILLS = "kills"
|
||||
const val DEATHS = "deaths"
|
||||
const val NPC_KILLS = "npcKills"
|
||||
const val PLAYTIME = "playtime"
|
||||
}
|
||||
|
||||
/**
|
||||
* Everything one server's page is showing.
|
||||
*
|
||||
* One state object rather than eight flows: every panel on the page is about the
|
||||
* same server and the same selected wipe, and a screen that collected them
|
||||
* separately could render a leaderboard for one wipe beside a feed for another
|
||||
* for a frame.
|
||||
*/
|
||||
data class RustServerUi(
|
||||
val serverId: String = "",
|
||||
val server: Polled<RustServerDto> = Polled(),
|
||||
val tab: RustTab = RustTab.FEED,
|
||||
val filterId: String = "all",
|
||||
val sort: String = RustSort.KILLS,
|
||||
/** The wipe every panel is filtered to. **Null is all time**, not "unknown". */
|
||||
val selectedWipe: String? = null,
|
||||
val feed: Polled<List<RustEventDto>> = Polled(),
|
||||
val online: Polled<List<RustPresenceDto>> = Polled(),
|
||||
val leaderboard: UiState<List<RustLeaderboardRowDto>> = UiState.Loading,
|
||||
val wipes: UiState<List<RustWipeDto>> = UiState.Loading,
|
||||
)
|
||||
|
||||
/**
|
||||
* One Rust server (PLAN.md §9 M14; `docs/modules/rust/PLAN.md` D13, D14).
|
||||
*
|
||||
* ## What polls and what does not
|
||||
*
|
||||
* D14, and it is a statement about the questions rather than about cost: the
|
||||
* **feed**, **who is on** and the **server's own line** change while somebody is
|
||||
* looking at the page, and the **leaderboard** and the **wipe list** do not in
|
||||
* any way a reader would want to watch. A leaderboard that re-sorted itself under
|
||||
* a finger every twenty seconds would be worse than a stale one.
|
||||
*
|
||||
* Only the **visible** live panel is polled. The website can afford to mount the
|
||||
* one tab it is showing; here the tabs are one screen, so the refresh asks what
|
||||
* the reader is actually looking at.
|
||||
*
|
||||
* ## Changing the question versus asking it again
|
||||
*
|
||||
* A poll is the same question asked again, so it keeps what is on screen
|
||||
* ([refreshInto]). Changing the filter, the sort or the wipe is a **different
|
||||
* question**, so the panel blanks and loads — what is there is an answer to
|
||||
* something the reader has stopped asking, and leaving it up while the new one
|
||||
* arrives would show a killfeed for last wipe under a heading naming this one.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class RustServerViewModel @Inject constructor(
|
||||
private val repository: RustRepository,
|
||||
savedStateHandle: SavedStateHandle,
|
||||
) : ViewModel() {
|
||||
|
||||
private val serverId: String = savedStateHandle[Routes.Args.SERVER_ID] ?: ""
|
||||
|
||||
private val _state = MutableStateFlow(RustServerUi(serverId = serverId))
|
||||
val state: StateFlow<RustServerUi> = _state.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
/** A first load or a retry of the whole page. */
|
||||
fun load() {
|
||||
_state.update { it.copy(server = Polled(UiState.Loading), feed = Polled(UiState.Loading)) }
|
||||
viewModelScope.launch {
|
||||
askServer()
|
||||
askFeed()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The poll tick.
|
||||
*
|
||||
* The server line always, and then whichever live panel is on screen. A tab
|
||||
* showing the leaderboard or the wipes does no extra work — the reader is
|
||||
* looking at something that does not move.
|
||||
*/
|
||||
fun refresh() {
|
||||
viewModelScope.launch {
|
||||
askServer()
|
||||
when (_state.value.tab) {
|
||||
RustTab.FEED -> askFeed()
|
||||
RustTab.ONLINE -> askOnline()
|
||||
RustTab.LEADERBOARD, RustTab.WIPES -> Unit
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a tab, loading its panel the first time it is opened.
|
||||
*
|
||||
* The two that do not poll are loaded exactly once per question: re-asking on
|
||||
* every tab switch would put a spinner over a leaderboard the reader has
|
||||
* already read, for an answer that cannot have changed while they were three
|
||||
* taps away.
|
||||
*/
|
||||
fun selectTab(tab: RustTab) {
|
||||
val already = _state.value
|
||||
_state.update { it.copy(tab = tab) }
|
||||
|
||||
viewModelScope.launch {
|
||||
when (tab) {
|
||||
RustTab.FEED -> if (already.feed.state !is UiState.Success) askFeed()
|
||||
RustTab.ONLINE -> if (already.online.state !is UiState.Success) askOnline()
|
||||
RustTab.LEADERBOARD -> if (already.leaderboard !is UiState.Success) askLeaderboard()
|
||||
RustTab.WIPES -> if (already.wipes !is UiState.Success) askWipes()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** A different question for the feed: blank it and ask. */
|
||||
fun selectFilter(filterId: String) {
|
||||
if (filterId == _state.value.filterId) return
|
||||
_state.update { it.copy(filterId = filterId, feed = Polled(UiState.Loading)) }
|
||||
viewModelScope.launch { askFeed() }
|
||||
}
|
||||
|
||||
/** A different question for the leaderboard: blank it and ask. */
|
||||
fun selectSort(sort: String) {
|
||||
if (sort == _state.value.sort) return
|
||||
_state.update { it.copy(sort = sort, leaderboard = UiState.Loading) }
|
||||
viewModelScope.launch { askLeaderboard() }
|
||||
}
|
||||
|
||||
/**
|
||||
* Pick a wipe, or all time with null.
|
||||
*
|
||||
* It is the one selection that changes **two** panels, so both are blanked —
|
||||
* and only the loaded ones are re-asked, so choosing a wipe from the Wipes tab
|
||||
* does not fetch a leaderboard nobody has opened.
|
||||
*/
|
||||
fun selectWipe(wipeId: String?) {
|
||||
if (wipeId == _state.value.selectedWipe) return
|
||||
|
||||
val hadLeaderboard = _state.value.leaderboard is UiState.Success
|
||||
_state.update {
|
||||
it.copy(
|
||||
selectedWipe = wipeId,
|
||||
feed = Polled(UiState.Loading),
|
||||
leaderboard = if (hadLeaderboard) UiState.Loading else it.leaderboard,
|
||||
)
|
||||
}
|
||||
|
||||
viewModelScope.launch {
|
||||
askFeed()
|
||||
if (hadLeaderboard) askLeaderboard()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Pick a wipe from the Wipes tab, which is a navigation as much as a filter.
|
||||
*
|
||||
* The question it asks is "what happened during that map", and the answer is
|
||||
* the feed — so it lands there rather than leaving the reader on a list of
|
||||
* dates with nothing visibly changed.
|
||||
*/
|
||||
fun openWipe(wipeId: String) {
|
||||
selectWipe(wipeId)
|
||||
selectTab(RustTab.FEED)
|
||||
}
|
||||
|
||||
/**
|
||||
* Retry one panel after its own load failed.
|
||||
*
|
||||
* Four entry points rather than one, because a failed leaderboard is not a
|
||||
* reason to re-read the feed the reader can already see — and [load] is the
|
||||
* whole page, which is right for a failed *server* read and heavy-handed for
|
||||
* anything else.
|
||||
*/
|
||||
fun retryFeed() {
|
||||
_state.update { it.copy(feed = Polled(UiState.Loading)) }
|
||||
viewModelScope.launch { askFeed() }
|
||||
}
|
||||
|
||||
fun retryLeaderboard() {
|
||||
_state.update { it.copy(leaderboard = UiState.Loading) }
|
||||
viewModelScope.launch { askLeaderboard() }
|
||||
}
|
||||
|
||||
fun retryOnline() {
|
||||
_state.update { it.copy(online = Polled(UiState.Loading)) }
|
||||
viewModelScope.launch { askOnline() }
|
||||
}
|
||||
|
||||
fun retryWipes() {
|
||||
_state.update { it.copy(wipes = UiState.Loading) }
|
||||
viewModelScope.launch { askWipes() }
|
||||
}
|
||||
|
||||
private suspend fun askServer() {
|
||||
val result = repository.server(serverId)
|
||||
_state.update { it.copy(server = refreshInto(it.server.state, result)) }
|
||||
}
|
||||
|
||||
private suspend fun askFeed() {
|
||||
val current = _state.value
|
||||
val result = repository.events(
|
||||
id = serverId,
|
||||
kinds = kindsFor(current.filterId),
|
||||
wipe = current.selectedWipe,
|
||||
limit = FEED_LIMIT,
|
||||
)
|
||||
_state.update { it.copy(feed = refreshInto(it.feed.state, result)) }
|
||||
}
|
||||
|
||||
private suspend fun askOnline() {
|
||||
val result = repository.online(serverId)
|
||||
_state.update { it.copy(online = refreshInto(it.online.state, result)) }
|
||||
}
|
||||
|
||||
private suspend fun askLeaderboard() {
|
||||
val current = _state.value
|
||||
val result = repository.leaderboard(
|
||||
id = serverId,
|
||||
wipe = current.selectedWipe,
|
||||
sort = current.sort,
|
||||
limit = LEADERBOARD_LIMIT,
|
||||
)
|
||||
_state.update { it.copy(leaderboard = result.toUiState()) }
|
||||
}
|
||||
|
||||
private suspend fun askWipes() {
|
||||
_state.update { it.copy(wipes = repository.wipes(serverId).toUiState()) }
|
||||
}
|
||||
|
||||
private companion object {
|
||||
/** Matches the website's feed page size; the server caps at 200 regardless. */
|
||||
const val FEED_LIMIT = 100
|
||||
const val LEADERBOARD_LIMIT = 50
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
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.PaddingValues
|
||||
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.MaterialTheme
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.runicgateway.app.R
|
||||
import com.runicgateway.app.data.api.dto.RustServerDto
|
||||
import com.runicgateway.app.ui.PollWhileResumed
|
||||
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.PillTone
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* Every Rust server this site follows — the module's landing page (D8, D12).
|
||||
*
|
||||
* **The phase criterion is this screen with every server off.** Nothing here is a
|
||||
* live call to a game host: the website answers from its own tables, so a fleet
|
||||
* that has been down for a week renders a week of last-known state rather than an
|
||||
* error. The one thing that can fail is the website itself.
|
||||
*/
|
||||
@Composable
|
||||
fun RustServersScreen(
|
||||
onOpenServer: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: RustServersViewModel = hiltViewModel(),
|
||||
) {
|
||||
val polled by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
PollWhileResumed { viewModel.refresh() }
|
||||
|
||||
when (val s = polled.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.rust_servers_empty), modifier)
|
||||
} else {
|
||||
ServerList(s.data, polled.refreshFailed, onOpenServer, modifier)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ServerList(
|
||||
servers: List<RustServerDto>,
|
||||
refreshFailed: Boolean,
|
||||
onOpenServer: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp),
|
||||
) {
|
||||
// A failed refresh says so and changes nothing else. The rows below it are
|
||||
// the last good answer and stay exactly as they were — blanking them is
|
||||
// the one thing a site whose premise is "it renders while the game is off"
|
||||
// must not do when a request fails.
|
||||
if (refreshFailed) {
|
||||
item {
|
||||
Text(
|
||||
text = stringResource(R.string.rust_refresh_failed),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
items(servers, key = { it.id }) { server ->
|
||||
ServerRow(server) { onOpenServer(server.id) }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun ServerRow(server: RustServerDto, onOpen: () -> Unit) {
|
||||
ShardCard(modifier = Modifier.fillMaxWidth().clickable(onClick = onOpen)) {
|
||||
// `ShardCard` is the themed Card and nothing more — it carries no padding
|
||||
// of its own, so every caller pads its own content. Without this the text
|
||||
// sits flush against the card's edge and the first glyph of each line
|
||||
// reads as clipped, which is what the walk saw.
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
horizontalArrangement = Arrangement.SpaceBetween,
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
) {
|
||||
Text(
|
||||
text = server.name.ifBlank { server.id },
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
// `online` already has staleness folded into it server-side — a row
|
||||
// nobody has written recently cannot claim a server is up — so this
|
||||
// renders the field rather than second-guessing it.
|
||||
if (server.online) {
|
||||
StatusPill(
|
||||
text = stringResource(
|
||||
R.string.rust_online_count,
|
||||
server.players,
|
||||
server.maxPlayers,
|
||||
),
|
||||
tone = PillTone.Success,
|
||||
)
|
||||
} else {
|
||||
StatusPill(text = stringResource(R.string.rust_offline), tone = PillTone.Neutral)
|
||||
}
|
||||
}
|
||||
|
||||
val world = describeWorld(server)
|
||||
if (world != null) {
|
||||
Text(
|
||||
text = world,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 4.dp),
|
||||
)
|
||||
}
|
||||
|
||||
Text(
|
||||
text = lastReported(server),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
modifier = Modifier.padding(top = 2.dp),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The world line — the things a Rust player asks first.
|
||||
*
|
||||
* Null when the server has never described itself, so the caller leaves the line
|
||||
* out rather than printing an empty one. A server configured this morning that
|
||||
* has not connected yet is in exactly that state, and it is not an error.
|
||||
*/
|
||||
@Composable
|
||||
internal fun describeWorld(server: RustServerDto): String? {
|
||||
val parts = listOfNotNull(
|
||||
server.level,
|
||||
server.worldSize?.let { stringResource(R.string.rust_world_size, it) },
|
||||
server.seed?.let { stringResource(R.string.rust_world_seed, it) },
|
||||
wipeDay(server.wipedAt)?.let { stringResource(R.string.rust_wiped_on, it) },
|
||||
)
|
||||
return parts.takeIf { it.isNotEmpty() }?.joinToString(" · ")
|
||||
}
|
||||
|
||||
/**
|
||||
* "last reported 3 minutes ago".
|
||||
*
|
||||
* **Reads `lastSeenAt` and never `updatedAt`.** The module shipped that exact
|
||||
* confusion and fixed it in phase 4: `updatedAt` moves on every poll including a
|
||||
* failed one, so an offline server claimed it had just checked in, every thirty
|
||||
* seconds, for as long as it stayed down. Only a frame moves `lastSeenAt`.
|
||||
*/
|
||||
@Composable
|
||||
internal fun lastReported(server: RustServerDto): String {
|
||||
val ago = rustAgo(server.lastSeenAt)
|
||||
?: return stringResource(R.string.rust_never_reported)
|
||||
|
||||
return if (server.stale) {
|
||||
stringResource(R.string.rust_last_reported_stale, ago)
|
||||
} else {
|
||||
stringResource(R.string.rust_last_reported, ago)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
package com.runicgateway.app.ui.rust
|
||||
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.runicgateway.app.data.api.dto.RustServerDto
|
||||
import com.runicgateway.app.data.repository.RustRepository
|
||||
import com.runicgateway.app.ui.Polled
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.refreshInto
|
||||
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 Rust server list — the module's landing page, one tier along (PLAN.md §9
|
||||
* M14; `docs/modules/rust/PLAN.md` D12).
|
||||
*
|
||||
* **`toUiState`, not `toShardUiState`.** These routes carry no `requireFeature`
|
||||
* gate, so a `404` here is a genuinely missing thing and never an admin's
|
||||
* visibility switch. Offering "this shard doesn't publish it" for one would name
|
||||
* a cause that does not exist on this surface.
|
||||
*
|
||||
* [refresh] is what the screen's poll calls and [load] is what a retry calls, and
|
||||
* the difference is the whole of [refreshInto]: a refresh keeps the rows when it
|
||||
* fails, a load is allowed to blank them because there is nothing on screen to
|
||||
* protect.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class RustServersViewModel @Inject constructor(
|
||||
private val repository: RustRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _state = MutableStateFlow(Polled<List<RustServerDto>>())
|
||||
val state: StateFlow<Polled<List<RustServerDto>>> = _state.asStateFlow()
|
||||
|
||||
/** A first load or a retry: show the spinner, then replace whatever comes back. */
|
||||
fun load() {
|
||||
_state.value = Polled(UiState.Loading)
|
||||
viewModelScope.launch { ask() }
|
||||
}
|
||||
|
||||
/** A poll: silent on success, and it keeps the rows on failure. */
|
||||
fun refresh() {
|
||||
viewModelScope.launch { ask() }
|
||||
}
|
||||
|
||||
private suspend fun ask() {
|
||||
_state.value = refreshInto(_state.value.state, repository.servers())
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,10 @@ 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 com.runicgateway.app.data.repository.ShardFeatures
|
||||
import com.runicgateway.app.data.repository.ShardFeaturesRepository
|
||||
import com.runicgateway.app.data.repository.SiteCapabilities
|
||||
import com.runicgateway.app.data.repository.SiteCapabilitiesRepository
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
@@ -23,10 +27,42 @@ import javax.inject.Inject
|
||||
class SessionViewModel @Inject constructor(
|
||||
sessionManager: SessionManager,
|
||||
private val authRepository: AuthRepository,
|
||||
shardFeaturesRepository: ShardFeaturesRepository,
|
||||
siteCapabilitiesRepository: SiteCapabilitiesRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
val session: StateFlow<Session> = sessionManager.state
|
||||
|
||||
/**
|
||||
* Which shard features this viewer may reach (M11). Held here beside [session]
|
||||
* because it answers the same question for the same consumer: what the shared
|
||||
* menu reveals. Role and feature config are independent gates — see
|
||||
* [com.runicgateway.app.ui.navigation.visibleEntries].
|
||||
*/
|
||||
val shardFeatures: StateFlow<ShardFeatures?> = shardFeaturesRepository.features
|
||||
|
||||
/**
|
||||
* What this BACKEND serves — core's capabilities and every installed module's
|
||||
* (M13). Exposed here for the reason [shardFeatures] is: the shared menu is
|
||||
* the consumer, and a row is filtered by both.
|
||||
*
|
||||
* **Read-only here, and deliberately not refreshed here.** This answer is per
|
||||
* HOST, not per viewer: signing in does not install a module. It is resolved
|
||||
* beside the appearance in [com.runicgateway.app.ui.AppViewModel], which is
|
||||
* what owns the host's lifecycle — first load, resume, and the Settings →
|
||||
* Server switch that invalidates it.
|
||||
*/
|
||||
val capabilities: StateFlow<SiteCapabilities?> = siteCapabilitiesRepository.capabilities
|
||||
|
||||
init {
|
||||
// The answer is per-viewer, so it is re-resolved on every session change.
|
||||
// A StateFlow conflates equal values, so a resume revalidation that returns
|
||||
// the same user does not refetch — only a real sign-in/out/role change does.
|
||||
viewModelScope.launch {
|
||||
session.collect { shardFeaturesRepository.refresh() }
|
||||
}
|
||||
}
|
||||
|
||||
/** Re-validate the cached role against the backend on app resume. */
|
||||
fun revalidate() {
|
||||
viewModelScope.launch { authRepository.revalidate() }
|
||||
|
||||
301
app/src/main/java/com/runicgateway/app/ui/shard/AtlasScreen.kt
Normal file
301
app/src/main/java/com/runicgateway/app/ui/shard/AtlasScreen.kt
Normal file
@@ -0,0 +1,301 @@
|
||||
/*
|
||||
* 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.ExperimentalLayoutApi
|
||||
import androidx.compose.foundation.layout.FlowRow
|
||||
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.foundation.text.KeyboardActions
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.pluralStringResource
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.ImeAction
|
||||
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.AtlasCreatureDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasPlaceDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasSpawnerDto
|
||||
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.PillTone
|
||||
import com.runicgateway.app.ui.components.SectionLabel
|
||||
import com.runicgateway.app.ui.components.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/**
|
||||
* The spawn atlas / bestiary (PLAN.md §9 M11): "where do I find X".
|
||||
*
|
||||
* The whole point of the feature is the placement transform the server does — a spawn
|
||||
* at 5411,1234 becomes *"Despise, Felucca"* — so a row leads with where a creature is
|
||||
* found, not with coordinates.
|
||||
*/
|
||||
@Composable
|
||||
fun AtlasScreen(
|
||||
onOpenCreature: (String) -> Unit,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AtlasViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
val query by viewModel.query.collectAsStateWithLifecycle()
|
||||
|
||||
Column(modifier.fillMaxSize()) {
|
||||
OutlinedTextField(
|
||||
value = query,
|
||||
onValueChange = viewModel::onQueryChange,
|
||||
label = { Text(stringResource(R.string.atlas_search_label)) },
|
||||
singleLine = true,
|
||||
keyboardOptions = KeyboardOptions(imeAction = ImeAction.Search),
|
||||
keyboardActions = KeyboardActions(onSearch = { viewModel.search() }),
|
||||
modifier = Modifier.fillMaxWidth().padding(horizontal = 16.dp, vertical = 8.dp),
|
||||
)
|
||||
|
||||
when (val s = state) {
|
||||
is UiState.Loading -> LoadingView()
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::load)
|
||||
is UiState.Success -> {
|
||||
if (s.data.creatures.isEmpty()) {
|
||||
EmptyView(stringResource(R.string.atlas_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.creatures, key = { it.slug.orEmpty() }) { creature ->
|
||||
CreatureCard(creature, onOpenCreature)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun CreatureCard(creature: AtlasCreatureDto, onOpenCreature: (String) -> Unit) {
|
||||
val slug = creature.slug
|
||||
ShardCard(
|
||||
Modifier
|
||||
.fillMaxWidth()
|
||||
.then(if (slug != null) Modifier.clickable { onOpenCreature(slug) } else Modifier),
|
||||
) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Row(Modifier.fillMaxWidth(), horizontalArrangement = Arrangement.SpaceBetween) {
|
||||
Text(
|
||||
text = creature.name ?: slug.orEmpty(),
|
||||
style = MaterialTheme.typography.titleSmall,
|
||||
maxLines = 1,
|
||||
overflow = TextOverflow.Ellipsis,
|
||||
modifier = Modifier.weight(1f),
|
||||
)
|
||||
// `points` is a COUNT of spawners on this route; `spawners` is the list,
|
||||
// and only the detail route sends it.
|
||||
creature.points?.let {
|
||||
Text(
|
||||
text = pluralStringResource(R.plurals.atlas_spawner_count, it, it),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
facetSummary(creature)?.let {
|
||||
Text(
|
||||
text = it,
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** One creature: every spawner, where it stands, and what shares its spawns. */
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
fun AtlasCreatureScreen(
|
||||
slug: String,
|
||||
modifier: Modifier = Modifier,
|
||||
viewModel: AtlasCreatureViewModel = hiltViewModel(),
|
||||
) {
|
||||
LaunchedEffect(slug) { viewModel.load(slug) }
|
||||
val state by viewModel.state.collectAsStateWithLifecycle()
|
||||
|
||||
when (val s = state) {
|
||||
is UiState.Loading -> LoadingView(modifier)
|
||||
is UiState.Error -> ErrorView(s.kind, onRetry = viewModel::retry, modifier = modifier)
|
||||
is UiState.Success -> {
|
||||
val creature = s.data
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize().padding(horizontal = 16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp),
|
||||
contentPadding = androidx.compose.foundation.layout.PaddingValues(vertical = 16.dp),
|
||||
) {
|
||||
item {
|
||||
Column {
|
||||
Text(
|
||||
creature.name ?: creature.slug.orEmpty(),
|
||||
style = MaterialTheme.typography.titleLarge,
|
||||
)
|
||||
creature.total?.let {
|
||||
Text(
|
||||
stringResource(R.string.atlas_total_alive, it),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
if (creature.facets.isNotEmpty()) {
|
||||
FlowRow(
|
||||
Modifier.padding(top = 8.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(6.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(6.dp),
|
||||
) {
|
||||
creature.facets.entries.sortedBy { it.key }.forEach { (facet, count) ->
|
||||
StatusPill(
|
||||
text = stringResource(R.string.atlas_facet_count, facet, count),
|
||||
tone = PillTone.Neutral,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// The aggregate comes first: "where is it" is the question, and the
|
||||
// individual coordinates below are the follow-up. Same ordering as web.
|
||||
if (creature.places.isNotEmpty()) {
|
||||
item { SectionLabel(stringResource(R.string.atlas_section_places)) }
|
||||
items(
|
||||
creature.places,
|
||||
key = { "${it.facet.orEmpty()}:${it.label.orEmpty()}" },
|
||||
) { place ->
|
||||
PlaceRow(place)
|
||||
}
|
||||
}
|
||||
if (creature.spawners.isNotEmpty()) {
|
||||
item { SectionLabel(stringResource(R.string.atlas_section_spawners)) }
|
||||
items(creature.spawners, key = { it.id ?: it.hashCode().toLong() }) { spawner ->
|
||||
SpawnerRow(spawner)
|
||||
}
|
||||
if (creature.spawnersTruncated) {
|
||||
item {
|
||||
Text(
|
||||
stringResource(R.string.atlas_spawners_truncated),
|
||||
style = MaterialTheme.typography.labelSmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
if (creature.alsoHere.isNotEmpty()) {
|
||||
item { SectionLabel(stringResource(R.string.atlas_section_also_here)) }
|
||||
item {
|
||||
Text(
|
||||
creature.alsoHere.mapNotNull { it.name ?: it.slug }.joinToString(", "),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
color = MaterialTheme.colorScheme.onSurfaceVariant,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun PlaceRow(place: AtlasPlaceDto) {
|
||||
Column(Modifier.fillMaxWidth().padding(vertical = 4.dp)) {
|
||||
Text(
|
||||
text = placeLabel(place),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
)
|
||||
val meta = listOfNotNull(
|
||||
place.facet,
|
||||
place.spawners?.let { pluralStringResource(R.plurals.atlas_spawner_count, it, it) },
|
||||
place.maxAlive?.let { stringResource(R.string.atlas_place_max_alive, it) },
|
||||
).joinToString(" · ")
|
||||
if (meta.isNotBlank()) {
|
||||
Text(meta, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Composable
|
||||
private fun SpawnerRow(spawner: AtlasSpawnerDto) {
|
||||
Column(Modifier.fillMaxWidth().padding(vertical = 4.dp)) {
|
||||
Text(
|
||||
text = spawnerPlace(spawner),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
)
|
||||
val meta = listOfNotNull(
|
||||
spawner.maxCount?.let { stringResource(R.string.atlas_max_count, it) },
|
||||
// Seconds, normalised server-side — the raw XmlSpawner values are minutes
|
||||
// OR seconds per record.
|
||||
formatRespawn(spawner.minDelay, spawner.maxDelay)
|
||||
?.let { stringResource(R.string.atlas_respawn, it) },
|
||||
).joinToString(" · ")
|
||||
if (meta.isNotBlank()) {
|
||||
Text(meta, style = MaterialTheme.typography.labelSmall, color = MaterialTheme.colorScheme.onSurfaceVariant)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Pure helpers (unit-tested) ───────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Where a spawner stands, preferring the server's own placement label — the
|
||||
* point-in-rect transform is what turns a coordinate into "Despise, Felucca" and is
|
||||
* the reason this feature exists. Falls back through region, landmark, and finally the
|
||||
* raw coordinates, which is honest rather than useless for the ~17% of spawns that
|
||||
* resolve to no named place.
|
||||
*/
|
||||
internal fun spawnerPlace(spawner: AtlasSpawnerDto): String {
|
||||
spawner.label?.takeIf { it.isNotBlank() }?.let { return it }
|
||||
val place = spawner.region ?: spawner.landmark
|
||||
val facet = spawner.facet
|
||||
return when {
|
||||
place != null && facet != null -> "$place, $facet"
|
||||
place != null -> place
|
||||
spawner.x != null && spawner.y != null ->
|
||||
listOfNotNull(facet, "${spawner.x}, ${spawner.y}").joinToString(" ")
|
||||
else -> facet.orEmpty()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The name of an aggregated place. [AtlasPlaceDto.label] is already the server's
|
||||
* resolved answer and falls back to "Wilderness" there, so the only case left here is
|
||||
* a place that carried no label at all — then the facet is better than nothing.
|
||||
*/
|
||||
internal fun placeLabel(place: AtlasPlaceDto): String =
|
||||
place.label?.takeIf { it.isNotBlank() } ?: place.facet.orEmpty()
|
||||
|
||||
/**
|
||||
* A creature's facets as one line, most spawners first — "where is it *mostly*" is the
|
||||
* question a search result answers.
|
||||
*/
|
||||
internal fun facetSummary(creature: AtlasCreatureDto): String? {
|
||||
if (creature.facets.isEmpty()) return null
|
||||
return creature.facets.entries
|
||||
.sortedByDescending { it.value }
|
||||
.joinToString(", ") { it.key }
|
||||
}
|
||||
@@ -0,0 +1,125 @@
|
||||
/*
|
||||
* 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.result.ApiResult
|
||||
import com.runicgateway.app.data.api.dto.AtlasCreatureDto
|
||||
import com.runicgateway.app.data.api.dto.AtlasCreaturePageDto
|
||||
import com.runicgateway.app.data.repository.ShardRepository
|
||||
import com.runicgateway.app.ui.UiState
|
||||
import com.runicgateway.app.ui.toShardUiState
|
||||
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 spawn atlas / bestiary (PLAN.md §9 M11, `docs/link/v3.md` §6): where each
|
||||
* creature spawns, derived server-side from the shard's own data files.
|
||||
*
|
||||
* Static shard **content**, not live state — it does not go offline with the sidecar,
|
||||
* and it lives under `/public/atlas`, not `/public/shard`. Unlike the shard routes it
|
||||
* IS site-mode gated, so a site in maintenance withholds it independently.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class AtlasViewModel @Inject constructor(
|
||||
private val repository: ShardRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _state = MutableStateFlow<UiState<AtlasCreaturePageDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<AtlasCreaturePageDto>> = _state.asStateFlow()
|
||||
|
||||
private val _query = MutableStateFlow("")
|
||||
val query: StateFlow<String> = _query.asStateFlow()
|
||||
|
||||
private val _facet = MutableStateFlow<String?>(null)
|
||||
val facet: StateFlow<String?> = _facet.asStateFlow()
|
||||
|
||||
/**
|
||||
* The facets this shard actually has. Discovered from the atlas itself — a shard
|
||||
* may add, replace or rename facets when its maps change, so nothing here may name
|
||||
* one (`v3.md` §6.1 R2).
|
||||
*/
|
||||
private val _facets = MutableStateFlow<List<String>>(emptyList())
|
||||
val facets: StateFlow<List<String>> = _facets.asStateFlow()
|
||||
|
||||
init {
|
||||
load()
|
||||
}
|
||||
|
||||
fun onQueryChange(value: String) {
|
||||
_query.value = value
|
||||
}
|
||||
|
||||
fun onFacetChange(value: String?) {
|
||||
if (value == _facet.value) return
|
||||
_facet.value = value
|
||||
search()
|
||||
}
|
||||
|
||||
fun search() = load()
|
||||
|
||||
fun load() {
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
val page = repository.atlasCreatures(query = _query.value, facet = _facet.value)
|
||||
if (page is ApiResult.Ok && _facets.value.isEmpty()) {
|
||||
// Only the first successful page needs to establish the filter options;
|
||||
// a filtered page would otherwise narrow them to its own results.
|
||||
_facets.value = page.data.creatures
|
||||
.flatMap { it.facets.keys }
|
||||
.distinct()
|
||||
.sorted()
|
||||
}
|
||||
_state.value = page.toShardUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** One creature's detail page: every spawner, and what else shares them. */
|
||||
@HiltViewModel
|
||||
class AtlasCreatureViewModel @Inject constructor(
|
||||
private val repository: ShardRepository,
|
||||
) : ViewModel() {
|
||||
|
||||
private val _state = MutableStateFlow<UiState<AtlasCreatureDto>>(UiState.Loading)
|
||||
val state: StateFlow<UiState<AtlasCreatureDto>> = _state.asStateFlow()
|
||||
|
||||
private var slug: String? = null
|
||||
|
||||
fun load(slug: String) {
|
||||
this.slug = slug
|
||||
_state.value = UiState.Loading
|
||||
viewModelScope.launch {
|
||||
_state.value = repository.atlasCreature(slug).toShardUiState()
|
||||
}
|
||||
}
|
||||
|
||||
fun retry() {
|
||||
slug?.let { load(it) }
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A respawn delay as text. **The API carries SECONDS** — XmlSpawner stores minutes
|
||||
* except when a delay doesn't divide into whole minutes, and the server's parser
|
||||
* normalises the two spellings so a `5` is never ambiguous here (`v3.md` §6.3).
|
||||
*
|
||||
* Pure, so the unit conversion is unit-tested rather than eyeballed on a page.
|
||||
*/
|
||||
internal fun formatRespawn(minSeconds: Int?, maxSeconds: Int?): String? {
|
||||
val lo = minSeconds ?: maxSeconds ?: return null
|
||||
val hi = maxSeconds ?: minSeconds ?: return null
|
||||
return if (lo == hi) humaniseSeconds(lo) else "${humaniseSeconds(lo)}–${humaniseSeconds(hi)}"
|
||||
}
|
||||
|
||||
private fun humaniseSeconds(seconds: Int): String = when {
|
||||
seconds < 60 -> "${seconds}s"
|
||||
seconds % 60 == 0 -> "${seconds / 60}m"
|
||||
else -> "${seconds / 60}m ${seconds % 60}s"
|
||||
}
|
||||
@@ -7,7 +7,6 @@ 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
|
||||
@@ -21,6 +20,7 @@ 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.ShardCard
|
||||
import com.runicgateway.app.ui.components.StatusPill
|
||||
|
||||
/** The champion-spawn board (PLAN.md §6.2), live via SSE deltas. */
|
||||
@@ -44,7 +44,7 @@ fun ChampsScreen(
|
||||
|
||||
@Composable
|
||||
private fun ChampCard(champ: ChampDto) {
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column(Modifier.padding(16.dp)) {
|
||||
Row(Modifier.fillMaxWidth()) {
|
||||
Text(
|
||||
|
||||
@@ -10,7 +10,7 @@ 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 com.runicgateway.app.ui.toShardUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
@@ -49,7 +49,7 @@ class ChampsViewModel @Inject constructor(
|
||||
board.seed(result.data)
|
||||
publish()
|
||||
}
|
||||
else -> _state.value = result.toUiState()
|
||||
else -> _state.value = result.toShardUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,7 +12,6 @@ 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
|
||||
@@ -33,6 +32,7 @@ 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.ShardCard
|
||||
|
||||
/** The town-governor board (PLAN.md §6.2), live via `city.update`, with per-city history. */
|
||||
@Composable
|
||||
@@ -84,7 +84,7 @@ private fun CityCard(
|
||||
onExpand: () -> Unit,
|
||||
) {
|
||||
var expanded by remember { mutableStateOf(false) }
|
||||
Card(Modifier.fillMaxWidth()) {
|
||||
ShardCard(Modifier.fillMaxWidth()) {
|
||||
Column {
|
||||
Column(
|
||||
Modifier
|
||||
|
||||
@@ -11,7 +11,7 @@ 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 com.runicgateway.app.ui.toShardUiState
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
@@ -55,7 +55,7 @@ class GovernorsViewModel @Inject constructor(
|
||||
board.seed(result.data)
|
||||
publish()
|
||||
}
|
||||
else -> _state.value = result.toUiState()
|
||||
else -> _state.value = result.toShardUiState()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user