Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 813ff52059 | |||
| ed8d24bb1d | |||
| 484bc33706 | |||
| fd9c9fd96a | |||
| 6f76a8d35f | |||
| 92374ba15c | |||
| e0445d3f94 | |||
| b858d526b8 | |||
| d47170581d | |||
| 2ed0b0bd00 | |||
| 808f6ab68b |
@@ -31,16 +31,18 @@ Missing or wrong token → **401** `{"error":"missing or invalid auth token"}`.
|
|||||||
|
|
||||||
The wire protocol is versioned so a mismatch is caught immediately instead of failing weirdly.
|
The wire protocol is versioned so a mismatch is caught immediately instead of failing weirdly.
|
||||||
|
|
||||||
- Every response carries an **`X-UOLink-Version: 1`** header.
|
- Every response carries an **`X-UOLink-Version: 2`** header.
|
||||||
- `GET /health` and the WebSocket `ws.hello` frame include `"protocol": 1`.
|
- `GET /health` and the WebSocket `ws.hello` frame include `"protocol": 2`.
|
||||||
- **Optionally**, send `X-UOLink-Version: 1` on your requests. If it disagrees with the sidecar, the request is rejected **409 Conflict**:
|
- **Optionally**, send `X-UOLink-Version: 2` on your requests. If it disagrees with the sidecar, the request is rejected **409 Conflict**:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "error": "protocol version mismatch", "sidecar_protocol": 1, "client_protocol": "2" }
|
{ "error": "protocol version mismatch", "sidecar_protocol": 2, "client_protocol": "1" }
|
||||||
```
|
```
|
||||||
|
|
||||||
Pin the version you built against and compare it to the header (or `/health.protocol`) at startup.
|
Pin the version you built against and compare it to the header (or `/health.protocol`) at startup.
|
||||||
|
|
||||||
|
**v2 (Protocol 2.0)** added the account-provisioning surface (§6.x: `POST /accounts/create`, `DELETE /link/{account}`) and the `account.*` events. Outbound event kinds are **additive** — a v1 client that ignores unknown kinds keeps working against the live feed — but the new *endpoints* require a v2 sidecar. If you send `X-UOLink-Version: 1`, calls to the new endpoints are refused with the 409 above.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3. Health
|
## 3. Health
|
||||||
@@ -180,10 +182,12 @@ Every event has `t` (epoch ms) and `kind`. A nested actor object looks like `{"s
|
|||||||
| `audit.command` | `staff`, `command`, `args` | A staff command was invoked. |
|
| `audit.command` | `staff`, `command`, `args` | A staff command was invoked. |
|
||||||
| `admin.audit` | `origin`, `action`, `actor`, `target`, `reason`, plus action-specific (`durationSec`, `sessions`, `hue`, `text`) | A moderation action was applied. `origin` is `"web"` (from the site, `actor:"web:<user>"`) or `"in-game"` (a staff member in the game client). Broadcast to every dashboard so your moderation log stays complete regardless of who acted. Emitted alongside the `admin.ok` reply for web actions; see §6. |
|
| `admin.audit` | `origin`, `action`, `actor`, `target`, `reason`, plus action-specific (`durationSec`, `sessions`, `hue`, `text`) | A moderation action was applied. `origin` is `"web"` (from the site, `actor:"web:<user>"`) or `"in-game"` (a staff member in the game client). Broadcast to every dashboard so your moderation log stays complete regardless of who acted. Emitted alongside the `admin.ok` reply for web actions; see §6. |
|
||||||
|
|
||||||
#### Account linking
|
#### Account linking & provisioning
|
||||||
| kind | fields | notes |
|
| kind | fields | notes |
|
||||||
|------|--------|-------|
|
|------|--------|-------|
|
||||||
| `link.request` | `code`, `account`, `char`, `ttlSec` | A player ran `[link` in game. Show them a prompt to enter `code` on the site; you then confirm it via `POST /link/confirm`. See §6. |
|
| `link.request` | `code`, `account`, `char`, `ttlSec` | A player ran `[link` in game. Show them a prompt to enter `code` on the site; you then confirm it via `POST /link/confirm`. See §6. |
|
||||||
|
| `account.audit` | `origin`, `action`, `actor`, `target`, `websiteUserId` | A provisioning action was applied from the site (`origin:"web"`, `actor:"web:<user>"`). `action` is `create` or `unlink`; `target` is the account. Broadcast to every dashboard. **Never carries the password.** Emitted alongside the `account.ok` reply; see §6. |
|
||||||
|
| `account.unlinked` | `origin`, `account`, `websiteUserId`, `char` | A player ran `[unlink` **in game** (`origin:"in-game"`), severing the tie themselves. Drop the link from any roster you cache and reconcile your own record. |
|
||||||
|
|
||||||
#### Help-page (support) queue
|
#### Help-page (support) queue
|
||||||
| kind | fields | notes |
|
| kind | fields | notes |
|
||||||
@@ -235,6 +239,82 @@ Category-specific fields on `champ.update`:
|
|||||||
|
|
||||||
The events are live deltas; for the current board of all spawns at once, use `GET /champs` (§6) — that's what you render on connect, then keep live with these events.
|
The events are live deltas; for the current board of all spawns at once, use `GET /champs` (§6) — that's what you render on connect, then keep live with these events.
|
||||||
|
|
||||||
|
#### Guilds (Protocol 2.0)
|
||||||
|
|
||||||
|
Guilds expose only one in-game event (a member joining), so the roster is polled (`GuildSweepSeconds`, default 60s) and diffed. Like champion spawns, `guild.update` is a **full-state upsert** emitted only on change — treat a guild id you've never seen as "newly created", and drop one on `guild.remove`. `guild.join` is the one real-time event, on top of the board.
|
||||||
|
|
||||||
|
| kind | fields | notes |
|
||||||
|
|------|--------|-------|
|
||||||
|
| `guild.update` | `id`, `name`, `abbr`, `members`, `online`, `alliance` (or null), `leader` (actor object or null) | A guild's roster/leader/alliance changed, or its first sight this connection. A **leave** shows up here as `members` dropping. |
|
||||||
|
| `guild.remove` | `id` | The guild disbanded (leader gone) or was removed. Drop the row. |
|
||||||
|
| `guild.join` | `id`, `name`, `abbr`, `who` (actor object) | Real-time: a player joined a guild (`EventSink.JoinGuild`). |
|
||||||
|
|
||||||
|
The `leader`/`who` **actor object** is `{serial, name, acct?, webId?, player}` — `acct`/`webId` present when the mobile has an account / a linked website user.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"kind":"guild.update","id":1042,"name":"The Silver Hand","abbr":"TSH","members":14,
|
||||||
|
"online":3,"alliance":"Britannian Pact",
|
||||||
|
"leader":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","webId":"9931","player":true},
|
||||||
|
"t":1752489280000}
|
||||||
|
{"kind":"guild.join","id":1042,"name":"The Silver Hand","abbr":"TSH",
|
||||||
|
"who":{"serial":"0x77","name":"Bran","acct":"bran","player":true},"t":1752489281000}
|
||||||
|
```
|
||||||
|
|
||||||
|
Render the current board from `GET /guilds` (§6) on connect, then keep it live with these events.
|
||||||
|
|
||||||
|
#### Town governors (Protocol 2.0)
|
||||||
|
|
||||||
|
In modern ServUO the "mayor" of a town is the **City Loyalty Governor**. The set of cities is polled (`CitySweepSeconds`, default 300s); each city emits `city.update` (full-state upsert) only when its governor, governor-elect, or election phase changes. **No events at all unless the shard runs the City Loyalty system.**
|
||||||
|
|
||||||
|
| kind | fields | notes |
|
||||||
|
|------|--------|-------|
|
||||||
|
| `city.update` | `city`, `governor` (actor or null), `governorElect` (actor or null), `electionPhase`, `candidates`, `autoPickAt` (ISO-8601 UTC, when an election is ongoing) | A city's governance changed. Derive "the governor changed" by comparing to your stored board. |
|
||||||
|
|
||||||
|
`electionPhase` is one of `none` / `nominate` / `vote` / `pending`. Cities: Moonglow, Britain, Jhelom, Yew, Minoc, Trinsic, SkaraBrae, NewMagincia.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"kind":"city.update","city":"Britain","electionPhase":"none","candidates":0,
|
||||||
|
"governor":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","webId":"9931","player":true},
|
||||||
|
"governorElect":null,"t":1752489280000}
|
||||||
|
```
|
||||||
|
|
||||||
|
Render the current board from `GET /governors` (§6) on connect, then keep it live with these events.
|
||||||
|
|
||||||
|
#### Presence (Protocol 2.0)
|
||||||
|
|
||||||
|
Who's online and where. A population snapshot is polled (`PresenceSweepSeconds`, default 30s) and emitted **only when it changes**; region transitions arrive in real time.
|
||||||
|
|
||||||
|
| kind | fields | notes |
|
||||||
|
|------|--------|-------|
|
||||||
|
| `presence.online` | `count`, `byFacet` `{map: n}`, `byRegion` `{region: n}` | The current online population. Emitted when the count or any breakdown changes. `GET /online` gives the latest; `GET /history?kind=presence.online` the time series. |
|
||||||
|
| `region.enter` | `from` (or null), `to` (or null), `map`, `who` (actor object) | A player crossed into a new named region. `from`/`to` are region names (`Wilderness` is unnamed). Cheap "who's where" feed. |
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"kind":"presence.online","count":42,"byFacet":{"Felucca":12,"Trammel":30},
|
||||||
|
"byRegion":{"Britain":18,"Wilderness":9,"Despise":2},"t":1752489280000}
|
||||||
|
{"kind":"region.enter","from":"Britain","to":"Despise","map":"Felucca",
|
||||||
|
"who":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","player":true},"t":...}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Houses (Protocol 2.0)
|
||||||
|
|
||||||
|
The house registry — one row per house, complementing the `house.decay` *transition* feed (§ above). Polled (`HousingSweepSeconds`, default 300s) and diffed like the other boards.
|
||||||
|
|
||||||
|
| kind | fields | notes |
|
||||||
|
|------|--------|-------|
|
||||||
|
| `house.update` | `serial`, `name`, `owner` (actor or null), `coOwners`, `friends`, `region`, `map`, `x`,`y`,`z`, `decay`, `price`, `builtOn`, `lastRefreshed` | A house's owner/region/decay/co-owners changed, or first sight this connection. `decay` is the level name (e.g. `LikeNew`). `price` is the placement value — **stock ServUO has no "for sale" flag**, so this is not a listing. |
|
||||||
|
| `house.remove` | `serial` | The house was demolished or no longer exists. Drop the row. |
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"kind":"house.update","serial":"0x40001234","name":"The Silver Anvil","decay":"LikeNew",
|
||||||
|
"price":432100,"map":"Felucca","x":1420,"y":1631,"z":0,"region":"Britain",
|
||||||
|
"owner":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","player":true},
|
||||||
|
"coOwners":2,"friends":5,"builtOn":"2026-01-02T00:00:00Z","lastRefreshed":"2026-07-10T00:00:00Z",
|
||||||
|
"t":1752489280000}
|
||||||
|
```
|
||||||
|
|
||||||
|
Render from `GET /houses` (§6) on connect, then keep live with these events.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5. REST — read queries
|
## 5. REST — read queries
|
||||||
@@ -265,7 +345,9 @@ Full character sheet: stats, all trained skills, worn equipment with flattened i
|
|||||||
{ "serial":"0x4002B3","layer":"OneHanded","itemId":5046,"hue":0,"cliloc":1023721,
|
{ "serial":"0x4002B3","layer":"OneHanded","itemId":5046,"hue":0,"cliloc":1023721,
|
||||||
"weapon":{"minDamage":16,"maxDamage":18},
|
"weapon":{"minDamage":16,"maxDamage":18},
|
||||||
"mods":{"WeaponDamage":50,"HitLightning":40} }
|
"mods":{"WeaponDamage":50,"HitLightning":40} }
|
||||||
]
|
],
|
||||||
|
"titles": { "selected": 0, "fameKarma": "Lord", "skill": "Grandmaster Swordsman",
|
||||||
|
"reward": ["1154060", "The Bold"] }
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -273,6 +355,7 @@ Field notes:
|
|||||||
- `skills[].base` is trained value, `value` includes item/temp bonuses, `cap` is the cap. **Do not assume `base <= cap`** — GM characters can exceed it.
|
- `skills[].base` is trained value, `value` includes item/temp bonuses, `cap` is the cap. **Do not assume `base <= cap`** — GM characters can exceed it.
|
||||||
- `equipment[].mods` is a flattened map of every non-zero AOS attribute on the item (weapon or armor). Empty `{}` for plain items.
|
- `equipment[].mods` is a flattened map of every non-zero AOS attribute on the item (weapon or armor). Empty `{}` for plain items.
|
||||||
- Item names are usually **clilocs**, not strings: use `name` when present, otherwise resolve `cliloc` against a UO cliloc table on the site.
|
- Item names are usually **clilocs**, not strings: use `name` when present, otherwise resolve `cliloc` against a UO cliloc table on the site.
|
||||||
|
- `titles` (Protocol 2.0): `selected` is the index into `reward` currently displayed (`-1` if none). `fameKarma`/`skill` are computed display titles, omitted when the character has none. `reward` entries may be a **cliloc number as a string** or a literal string — resolve numeric ones against your cliloc table, same as item names.
|
||||||
- Errors: unknown account → **404** `{"kind":"bridge.error","reason":"unknown account"}`; bad slot → **404**/**400** similarly.
|
- Errors: unknown account → **404** `{"kind":"bridge.error","reason":"unknown account"}`; bad slot → **404**/**400** similarly.
|
||||||
|
|
||||||
### Account roster
|
### Account roster
|
||||||
@@ -335,6 +418,48 @@ GET /link/{account}
|
|||||||
|
|
||||||
(This reads the sidecar's mirror of confirmed links — no shard round-trip.)
|
(This reads the sidecar's mirror of confirmed links — no shard round-trip.)
|
||||||
|
|
||||||
|
### Create a game account (Protocol 2.0)
|
||||||
|
|
||||||
|
Provision a game account from your signup form and link it to the website user in one step. Requires a **v2** sidecar. Whether this is honored depends on the shard's signup mode (`website`/`hybrid` accept it; `game` refuses).
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /accounts/create
|
||||||
|
{ "actor": "whitlocktech", "account": "bob", "password": "hunter2",
|
||||||
|
"websiteUserId": "9931", "ip": "203.0.113.7" }
|
||||||
|
```
|
||||||
|
|
||||||
|
- `actor` — the website user/staff id, recorded in the audit. Required.
|
||||||
|
- `account`, `password` — the game-client credentials the player chose. The password is hashed on the shard and **never** appears in any reply, event, or log.
|
||||||
|
- `websiteUserId` — the site user to auto-link.
|
||||||
|
- `ip` — **the end user's browser IP**, which you read from your own request context (remote-addr, or a trusted `X-Forwarded-For`). The shard enforces its per-IP account cap with this, exactly as it does for in-game signups. The sidecar cannot see the browser's IP (it only sees your server), so you must send it.
|
||||||
|
|
||||||
|
Responses:
|
||||||
|
|
||||||
|
- Success → **200** `{"kind":"account.ok","action":"create","account":"bob","websiteUserId":"9931"}`. The account exists and is linked; subsequent `mob.login` events carry `webId`.
|
||||||
|
- Name already taken → **409** `{"kind":"account.error","reason":"account already exists"}`.
|
||||||
|
- Per-IP cap hit → **429** `{"kind":"account.error","reason":"ip account limit reached"}`.
|
||||||
|
- Signups disabled for this mode → **403** `{"kind":"account.error","reason":"signups disabled for this mode"}`.
|
||||||
|
- Missing browser IP (when the shard requires it) → **400** `{"kind":"account.error","reason":"client ip required"}`.
|
||||||
|
- Bad username/password, or a missing field → **400**.
|
||||||
|
|
||||||
|
Abuse control beyond the per-IP cap (captcha, email verification, signup rate) is your site's responsibility.
|
||||||
|
|
||||||
|
### Unlink an account (Protocol 2.0)
|
||||||
|
|
||||||
|
Sever a game account's tie to its website user, from the site side. Requires a **v2** sidecar.
|
||||||
|
|
||||||
|
```
|
||||||
|
DELETE /link/{account}
|
||||||
|
{ "actor": "whitlocktech" }
|
||||||
|
```
|
||||||
|
|
||||||
|
- Success → **200** `{"kind":"account.ok","action":"unlink","account":"bob"}`. The `WebsiteUserId` tag is cleared on the shard and the sidecar's link mirror is dropped, so attribution stops immediately.
|
||||||
|
- Not linked → **404** `{"kind":"account.error","reason":"not linked"}`.
|
||||||
|
- Protected staff account → **403** `{"kind":"account.error","reason":"target is protected staff; refused"}`.
|
||||||
|
- Missing `actor` → **400**.
|
||||||
|
|
||||||
|
A player can also unlink themselves in game with `[unlink`; that emits an `account.unlinked` event (see §4) so you can reconcile your record.
|
||||||
|
|
||||||
### Publish / remove town-crier news
|
### Publish / remove town-crier news
|
||||||
|
|
||||||
Push a message that every in-game town crier announces until it expires.
|
Push a message that every in-game town crier announces until it expires.
|
||||||
@@ -352,6 +477,28 @@ DELETE /towncrier/{id}
|
|||||||
|
|
||||||
Caps apply (line count/length, active entries, duration); an over-cap post returns `towncrier.error`.
|
Caps apply (line count/length, active entries, duration); an over-cap post returns `towncrier.error`.
|
||||||
|
|
||||||
|
### Publish / remove Town Cryer **news** (Protocol 2.1)
|
||||||
|
|
||||||
|
Distinct from the scrolling-crier lines above: this puts a full article — title, HTML body, image, and a "more info" URL — into the in-game **Town Cryer News gump**, and (by default) has the criers proclaim the **title** in-world.
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /news
|
||||||
|
{ "id": "42", "title": "Double XP Weekend",
|
||||||
|
"body": "<CENTER>Double XP Weekend</CENTER><BR><BR>Starts Friday 7PM.",
|
||||||
|
"image": 1614, "url": "https://yoursite/news/42" }
|
||||||
|
```
|
||||||
|
→ **200** `{"kind":"news.ok","id":"42"}`. Re-posting the same `id` **replaces** the prior article in place.
|
||||||
|
|
||||||
|
- `id`, `title` required. `body` (HTML supported), `image` (a UO gump id; a neutral scroll if omitted), `url` (a browser button in the gump) optional.
|
||||||
|
- `announce` defaults to **true** — the criers proclaim the title. Send `"announce": false` to post silently (e.g. a correction).
|
||||||
|
|
||||||
|
```
|
||||||
|
DELETE /news/{id}
|
||||||
|
```
|
||||||
|
→ **200** `{"kind":"news.ok","id":"42"}`, or **404** `{"kind":"news.error","reason":"unknown id"}`.
|
||||||
|
|
||||||
|
Caps apply (title/body length, max active articles). The **website is the source of truth**: the shard rebuilds its news list on restart and does not persist yours, so the sidecar automatically re-pushes your articles (silently) whenever the shard reconnects. Stock ServUO news is left intact — your articles are tracked separately.
|
||||||
|
|
||||||
### Staff moderation — the write plane
|
### Staff moderation — the write plane
|
||||||
|
|
||||||
Account and session moderation against the live shard. **These are privileged.** The sidecar does
|
Account and session moderation against the live shard. **These are privileged.** The sidecar does
|
||||||
@@ -466,6 +613,51 @@ GET /champs
|
|||||||
|
|
||||||
A row survives a sidecar restart (it's in SQLite), so the board reflects the last-known state even during a shard outage. A `sea` boss appears when summoned and is removed when slain.
|
A row survives a sidecar restart (it's in SQLite), so the board reflects the last-known state even during a shard outage. A `sea` boss appears when summoned and is removed when slain.
|
||||||
|
|
||||||
|
### Guild board (Protocol 2.0)
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /guilds
|
||||||
|
→ { "guilds": [ {"kind":"guild.update","id":1042,"name":"The Silver Hand","abbr":"TSH",
|
||||||
|
"members":14,"online":3,"alliance":"Britannian Pact",
|
||||||
|
"leader":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","webId":"9931","player":true},
|
||||||
|
"t":1752489280000}, ... ] }
|
||||||
|
```
|
||||||
|
|
||||||
|
Every guild's latest roster snapshot at once — the live board. Served from the sidecar's projection (no shard round-trip), kept current by the `guild.*` stream (§4). Render on load, then subscribe. Each entry is exactly a `guild.update` payload; ordered by name. Survives a sidecar restart.
|
||||||
|
|
||||||
|
### Governor board (Protocol 2.0)
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /governors
|
||||||
|
→ { "cities": [ {"kind":"city.update","city":"Britain","electionPhase":"none","candidates":0,
|
||||||
|
"governor":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","player":true},
|
||||||
|
"governorElect":null,"t":1752489280000}, ... ] }
|
||||||
|
```
|
||||||
|
|
||||||
|
Every city's latest governance snapshot — the live board, kept current by the `city.update` stream (§4). Empty if the shard does not run the City Loyalty system. Ordered by city.
|
||||||
|
|
||||||
|
### Online population (Protocol 2.0)
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /online
|
||||||
|
→ {"kind":"presence.online","count":42,"byFacet":{"Felucca":12,"Trammel":30},
|
||||||
|
"byRegion":{"Britain":18,"Wilderness":9},"t":1752489280000}
|
||||||
|
```
|
||||||
|
|
||||||
|
The current online population — total plus per-facet and per-region breakdowns. The latest `presence.online` snapshot (from SQLite, so it survives a sidecar restart); keep it live with the `presence.online` stream (§4). `count: 0` with empty maps if the shard hasn't reported yet. For the population time series, `GET /history?kind=presence.online`.
|
||||||
|
|
||||||
|
### House registry (Protocol 2.0)
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /houses
|
||||||
|
→ { "houses": [ {"kind":"house.update","serial":"0x40001234","name":"The Silver Anvil",
|
||||||
|
"decay":"LikeNew","price":432100,"map":"Felucca","x":1420,"y":1631,"z":0,"region":"Britain",
|
||||||
|
"owner":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech","player":true},
|
||||||
|
"coOwners":2,"friends":5,"builtOn":"...","lastRefreshed":"...","t":...}, ... ] }
|
||||||
|
```
|
||||||
|
|
||||||
|
Every house's latest snapshot — owner→houses map. Served from the sidecar's projection, kept current by the `house.*` stream (§4). Ordered by name. Survives a sidecar restart.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7. Status codes
|
## 7. Status codes
|
||||||
@@ -475,8 +667,9 @@ A row survives a sidecar restart (it's in SQLite), so the board reflects the las
|
|||||||
| 200 | OK |
|
| 200 | OK |
|
||||||
| 400 | Bad request (malformed body, invalid parameter, or a shard `*.error` that isn't a not-found) |
|
| 400 | Bad request (malformed body, invalid parameter, or a shard `*.error` that isn't a not-found) |
|
||||||
| 401 | Missing or invalid auth token |
|
| 401 | Missing or invalid auth token |
|
||||||
| 404 | Not found (unknown account / character / id) |
|
| 404 | Not found (unknown account / character / id, or a not-linked account) |
|
||||||
| 409 | Protocol version mismatch (you sent `X-UOLink-Version` and it disagreed) |
|
| 409 | Conflict — protocol version mismatch, or an account name already taken on `POST /accounts/create` |
|
||||||
|
| 429 | Too many requests — the shard's per-IP account cap was hit on `POST /accounts/create` |
|
||||||
| 500 | Internal error (e.g. database) |
|
| 500 | Internal error (e.g. database) |
|
||||||
| 503 | Shard not connected — the query needs the live game and it's down |
|
| 503 | Shard not connected — the query needs the live game and it's down |
|
||||||
| 504 | Shard connected but didn't reply within 10s |
|
| 504 | Shard connected but didn't reply within 10s |
|
||||||
@@ -490,7 +683,7 @@ A row survives a sidecar restart (it's in SQLite), so the board reflects the las
|
|||||||
A typical character page:
|
A typical character page:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const H = { "Authorization": `Bearer ${TOKEN}`, "X-UOLink-Version": "1" };
|
const H = { "Authorization": `Bearer ${TOKEN}`, "X-UOLink-Version": "2" };
|
||||||
|
|
||||||
// 1. render the roster
|
// 1. render the roster
|
||||||
const roster = await fetch(`${BASE}/roster/${account}`, { headers: H }).then(r => r.json());
|
const roster = await fetch(`${BASE}/roster/${account}`, { headers: H }).then(r => r.json());
|
||||||
|
|||||||
548
docs/PROTOCOL_2.md
Normal file
548
docs/PROTOCOL_2.md
Normal file
@@ -0,0 +1,548 @@
|
|||||||
|
# Protocol 2.0 — Provisioning & World-State Streams
|
||||||
|
|
||||||
|
**Status:** Parts A + B (phases 1–4) **built and smoke-tested live** on branch `feat/protocol2-account-provisioning` (2026-07-17) — booted ServUO + the real sidecar and exercised every endpoint (see §15). Part B phase 5 (Factions/VvV) deferred by owner decision.
|
||||||
|
**Date:** 2026-07-17
|
||||||
|
**Codebase:** ServUO 57.4, `C:\Users\colby\Desktop\servuo`, net48 / x64, Expansion **EJ**.
|
||||||
|
**Companion to** [`PLAN.md`](PLAN.md) (read/event plane), [`ADMIN_CONTROLS.md`](ADMIN_CONTROLS.md) (staff write plane), and [`INTEGRATION.md`](INTEGRATION.md) (website API).
|
||||||
|
|
||||||
|
Protocol 1.0 shipped the read/event plane, the request/reply plane, `[link` account linking, town-crier, the player-vendor-sale core edit, the admin write plane, and the help-page queue.
|
||||||
|
|
||||||
|
2.0 has **two scope areas**:
|
||||||
|
|
||||||
|
- **A — Account provisioning & unlinking (§1–§9).** The website can **create** accounts, **unlink** them, and the shard runs in one of three **signup modes** that decide which side may mint accounts. (1.0 could only *link* an account that already existed, and a link could never be undone.)
|
||||||
|
- **B — Social & political world-state streams (§10–§11).** Guilds, town governors ("mayors"), factions/VvV, and player titles — the standings a website community page wants. §10 specs the requested streams; §11 is a menu of further integration points to pick from.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Part A — Account provisioning & unlinking
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. What exists today, and the gap
|
||||||
|
|
||||||
|
| Capability | 1.0 | 2.0 |
|
||||||
|
|------------|-----|-----|
|
||||||
|
| Create account in-game (first-login auto-create) | ✔ `AccountHandler.cs:281` | unchanged |
|
||||||
|
| Link an **existing** game account to a website user | ✔ `[link` → `link.confirm` | unchanged |
|
||||||
|
| **Create** a game account from the website | ✗ | **new** `account.create` |
|
||||||
|
| **Unlink** a game account from its website user | ✗ | **new** `account.unlink` + `[unlink` |
|
||||||
|
| Choose which side may create accounts | ✗ (always in-game) | **new** signup mode |
|
||||||
|
|
||||||
|
**The linking flow is not changing.** `[link`, the one-time code, `link.confirm`, and the `WebsiteUserId` tag all stay exactly as they are (`BridgeAccountLink.cs`). 2.0 only *adds* verbs alongside them.
|
||||||
|
|
||||||
|
### The account-creation facts that shape this
|
||||||
|
|
||||||
|
- `new Account(username, password)` self-registers — its constructor calls `Accounts.Add(this)` (`Account.cs:186`) and `SetPassword` hashes per the shard's `AccountHandler.ProtectPasswords` (`Account.cs:174`). So creating an account from the bridge is `new Account(un, pw)` plus the link tag — no extra persistence layer, same as the `[link` tag reaching disk on the next world save.
|
||||||
|
- ServUO's in-game auto-create is gated on the **core** config `Accounts.AutoCreateAccounts` (default `true`, read once in `AccountHandler`'s static init, `AccountHandler.cs:29`). The bridge cannot intercept that path without a core edit, so the signup mode governs the **bridge's** `account.create` verb; the in-game side is controlled by pairing it with the matching core config (see §3).
|
||||||
|
- The core `CreateAccount` path (`AccountHandler.cs:494`) validates the username/password character set (printable ASCII `0x20–0x7F`, no forbidden chars) and enforces `MaxAccountsPerIP` (`Accounts.AccountsPerIp`, default **1**). The website path has **no `NetState`**, so the browser IP must be **passed through explicitly** to enforce that same cap (§3.1); and it must reuse the **character-safety** validation before `new Account`, or it can mint an account no client can log into (or that corrupts serialization).
|
||||||
|
- There is **no `EventSink.AccountCreated`**. The create path is silent. This is why in-game→website creation sync is an open item, not committed scope (§7).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Signup modes — the model
|
||||||
|
|
||||||
|
A single shard-wide setting, `Bridge.SignupMode`, with three values. **Default `hybrid`.**
|
||||||
|
|
||||||
|
| Mode | `account.create` from website | In-game first-login auto-create | Who is the account authority |
|
||||||
|
|------|:-----------------------------:|:-------------------------------:|------------------------------|
|
||||||
|
| `website` | **accepted** | should be **off** | the website |
|
||||||
|
| `game` | **rejected** (`account.error`) | **on** | the game server |
|
||||||
|
| `hybrid` *(default)* | **accepted** | **on** | either side |
|
||||||
|
|
||||||
|
The bridge enforces exactly one half of this: whether it **honors `account.create`**. The other half — in-game auto-create — is the core `Accounts.AutoCreateAccounts` config, which the operator sets to match:
|
||||||
|
|
||||||
|
| `Bridge.SignupMode` | pair with `Accounts.AutoCreateAccounts` |
|
||||||
|
|---------------------|-----------------------------------------|
|
||||||
|
| `website` | `false` — otherwise any client that types a new name still mints an account, defeating website-only |
|
||||||
|
| `game` | `true` |
|
||||||
|
| `hybrid` | `true` |
|
||||||
|
|
||||||
|
On boot the bridge **reads `Accounts.AutoCreateAccounts` and warns** if it contradicts the selected mode (e.g. `SignupMode=website` while auto-create is still on), so a half-configured shard is loud, not silently permissive. The bridge does not try to flip the core setting — it only detects and reports the mismatch, the same defensive posture `BridgeConfig.ParseAccessLevel` already takes.
|
||||||
|
|
||||||
|
**Reconciliation in `hybrid`.** Both paths can race for the same username. `account.create` resolves it the only correct way: `Accounts.GetAccount(un) != null` → refuse with `account.error "account already exists"`. First writer wins; the loser gets a clean error, never a duplicate.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. `account.create` — website-driven provisioning
|
||||||
|
|
||||||
|
The website has already authenticated and authorized the user (its own signup form). It hands the shard a username, the password the player chose, and the website user id, and asks for an account that is created **and linked in one step** — no code exchange, because the website *is* the authority here (unlike `[link`, where the game side proves ownership with a code).
|
||||||
|
|
||||||
|
### Request (website → sidecar → shard)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "kind": "account.create", "reqId": "c1", "actor": "whitlocktech",
|
||||||
|
"account": "bob", "password": "hunter2", "websiteUserId": "9931",
|
||||||
|
"ip": "203.0.113.7" }
|
||||||
|
```
|
||||||
|
|
||||||
|
- `reqId` — correlation id, echoed on the reply (as everywhere else).
|
||||||
|
- `actor` — the website user/staff id, for the audit line. Required, non-empty (mirrors the admin plane).
|
||||||
|
- `account` — desired username.
|
||||||
|
- `password` — the game-client password the player chose on the site. Plaintext over the **loopback + token** socket, the same trust boundary every inbound verb already relies on; the shard hashes it via `SetPassword` immediately.
|
||||||
|
- `websiteUserId` — the site user to auto-link.
|
||||||
|
- `ip` — the **end user's browser IP**, so the shard can enforce `MaxAccountsPerIP` on website signups exactly as it does on in-game first-login. The website reads this from its own request context (remote-addr, or a trusted `X-Forwarded-For`); the **sidecar cannot derive it** — the sidecar only sees the website's connection IP, not the browser's, so this must be an explicit field. See §3.1.
|
||||||
|
|
||||||
|
### Shard behavior (Core thread, in `BridgeAccounts.cs`)
|
||||||
|
|
||||||
|
1. **Gate.** `SignupMode == game` → `account.error "signups disabled for this mode"`. Master switch `Bridge.AccountCreateEnabled` (default follows mode) must be on.
|
||||||
|
2. **Validate `actor`** present (as admin plane does).
|
||||||
|
3. **Validate username/password** with the same character-safety rules as `AccountHandler.CreateAccount` (printable ASCII, no leading/trailing space, no trailing dot, no forbidden chars). Enforce length caps from config.
|
||||||
|
4. **Collision check.** `Accounts.GetAccount(account) != null` → `account.error "account already exists"`.
|
||||||
|
5. **IP cap.** Parse `ip` → `IPAddress`. If `RequireIpForCreate` and it is missing/unparseable/loopback → `account.error "client ip required"` (**fail closed** — a missing IP must never silently bypass the cap; loopback is exempt in `IPLimiter`, so accepting it *is* a bypass). Then `AccountHandler.CanCreate(ip) == false` → `account.error "ip account limit reached"`. This is the same read-side check the in-game path runs at `AccountHandler.cs:510`.
|
||||||
|
6. **Create + link atomically.** `var a = new Account(account, password); a.LogAccess(ip); a.SetTag("WebsiteUserId", websiteUserId);` — `LogAccess` bumps `AccountHandler.IPTable[ip]` and records the IP into `LoginIPs` (`Account.cs:1251`), which is exactly what an in-game first-login does, so the per-IP count is both live-accurate and durable (it rebuilds from `LoginIPs[0]` on reboot). The `WebsiteUserId` tag persists to `accounts.xml` on the next world save, identical to the `[link` path.
|
||||||
|
7. **Reply** `account.ok` and **emit** an unsolicited `account.audit` (`origin:"web"`, `action:"create"`) to every dashboard, parallel to `admin.audit`.
|
||||||
|
|
||||||
|
### Reply
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "kind": "account.ok", "reqId": "c1", "action": "create",
|
||||||
|
"account": "bob", "websiteUserId": "9931" }
|
||||||
|
{ "kind": "account.error", "reqId": "c1", "reason": "account already exists" }
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.1 The IP flow — who sees what
|
||||||
|
|
||||||
|
```
|
||||||
|
browser ──HTTP signup──► website ──POST /accounts/create──► sidecar ──account.create──► shard
|
||||||
|
(real IP) (sees browser IP) (sees WEBSITE's IP, not browser's) (enforces cap)
|
||||||
|
```
|
||||||
|
|
||||||
|
The chain hops hosts, so the only party that sees the **end user's** IP is the website, at the edge. By the time the request reaches the sidecar, the socket's peer address is the *website*, not the player — which is why `ip` is a body field, not something the sidecar reads off the connection. The website populates it from its request context (remote-addr, or `X-Forwarded-For` from a proxy it trusts).
|
||||||
|
|
||||||
|
Two consequences to state plainly:
|
||||||
|
|
||||||
|
- **The IP is only as trustworthy as the website's proxy handling.** A compromised or misconfigured website could send a spoofed or wrong IP. That is already inside the 2.0 trust boundary (the website is trusted via loopback + token), but it means the per-IP cap is an *honesty* control against ordinary multi-account signups, not a hard security boundary against a hostile website.
|
||||||
|
- **IPv4/IPv6 skew.** A browser may present IPv6 while the UO client connects over IPv4; the two are different `IPAddress` keys, so a website account and a later in-game account from the "same" person may not share an `IPTable` bucket. Inherent to keying on raw IP — noted, not solved.
|
||||||
|
|
||||||
|
The sidecar itself does **not** validate or transform `ip`; it forwards the field and lets the shard (which owns `IPTable`) decide. If a shard wants the sidecar to reject obviously-bad input early, that is a later refinement, not required for correctness — the shard fails closed regardless.
|
||||||
|
|
||||||
|
### Sidecar route
|
||||||
|
|
||||||
|
`POST /accounts/create`, body `{actor, account, password, websiteUserId, ip}` → the inbound line, correlated on a fresh `reqId`. Status mapping (new `respond_account`, modeled on `respond_admin`):
|
||||||
|
|
||||||
|
| Reply / reason | HTTP |
|
||||||
|
|----------------|------|
|
||||||
|
| `account.ok` | 200 |
|
||||||
|
| `"account already exists"` | 409 Conflict |
|
||||||
|
| `"ip account limit reached"` | 429 Too Many Requests |
|
||||||
|
| `"signups disabled…"` | 403 |
|
||||||
|
| `"client ip required"`, `"invalid username/password"`, missing field | 400 |
|
||||||
|
| shard down / timeout | 503 / 504 |
|
||||||
|
|
||||||
|
> ⚠️ The password is a secret in a request body and a shard reply. Keep it off the WebSocket broadcast entirely: `account.audit`/`account.ok` **never carry the password**, and the console/audit log records only `account` + `actor`. This is the same discipline `BridgeEvents` already applies to the plaintext `AccountLoginEventArgs.Password` it deliberately never forwards (`PLAN.md` §12).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Unlinking
|
||||||
|
|
||||||
|
Symmetric with `[link`: either side can sever the tie. Both paths do the same one thing — remove the `WebsiteUserId` account tag (`acct.RemoveTag("WebsiteUserId")`) — and both persist on the next world save.
|
||||||
|
|
||||||
|
### 4.1 Website → `account.unlink`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "kind": "account.unlink", "reqId": "u1", "actor": "whitlocktech", "account": "bob" }
|
||||||
|
```
|
||||||
|
|
||||||
|
- Resolve by `account` (username) or `serial` (a player mobile's account), reusing `BridgeAdmin.ResolveTargetAccount`.
|
||||||
|
- Not linked → `account.error "not linked"` (a no-op is reported honestly, not faked as success).
|
||||||
|
- Apply the **Owner floor** (`BridgeAdmin.Protected`): refuse to unlink an account at/above `AdminAccessFloor`, same defense-in-depth as the admin verbs.
|
||||||
|
- Reply `account.ok action:"unlink"`; emit `account.audit action:"unlink"`.
|
||||||
|
|
||||||
|
Sidecar: `DELETE /link/{account}` (the existing `/link/:account` GET already looks a link up; this adds the delete verb next to it) → also clears the sidecar's mirrored link row (`store.record_unlink`), so event attribution stops immediately without waiting on the shard.
|
||||||
|
|
||||||
|
### 4.2 In-game → `[unlink`
|
||||||
|
|
||||||
|
`CommandSystem.Register("unlink", AccessLevel.Player, …)` in `BridgeAccountLink.cs`, next to `[link`:
|
||||||
|
|
||||||
|
- Reads the caller's own account, clears the tag, emits `account.unlinked` (so the site learns of a player-initiated unlink and can reconcile its own record).
|
||||||
|
- Player-scoped: a player can only unlink **their own** account (no target argument), so it needs no floor.
|
||||||
|
- Symmetric UX with `[link`: `"Your account is no longer linked."`
|
||||||
|
|
||||||
|
> **Note — `[link` behavior is unchanged.** `[link` still refuses when a tag already exists (`BridgeAccountLink.cs:96`). `[unlink` is what clears it; after unlinking, `[link` works again. That is the whole interaction, and it needs no change to the existing link code — only the new command beside it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Trust & attribution
|
||||||
|
|
||||||
|
Identical model to the admin write plane (`ADMIN_CONTROLS.md` §5), because these are the same shape of action (website-authorized, applied on the loopback socket):
|
||||||
|
|
||||||
|
- **Authorization lives on the website.** `account.create`/`unlink` are gated behind the site's own roles (self-service signup for create; admin/self for unlink). The shard trusts the loopback + token socket and the required `actor` field.
|
||||||
|
- **Owner floor** applies to `account.unlink` (never unlink a protected staff account from the web).
|
||||||
|
- **Attribution** is the `web:<actor>` string in the console line and the `account.audit` frame; the website keeps its own durable record, as it already does for `admin.audit`.
|
||||||
|
- **`account.create` now enforces `MaxAccountsPerIP`** using the browser IP the website forwards (§3.1), via the same `CanCreate` / `LogAccess` path as in-game first-login. But the cap is only as honest as the website's IP reporting, and it fails **closed** on a missing/loopback IP when `RequireIpForCreate` is on. Higher-order abuse control (captcha, email verification, per-account-per-day) remains the website's job — the shard cap is a floor, not the whole defense.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. Config keys (`Config/Bridge.cfg`)
|
||||||
|
|
||||||
|
```ini
|
||||||
|
SignupMode=hybrid # website | game | hybrid (default hybrid)
|
||||||
|
AccountCreateEnabled=true # master switch for account.create; auto-off when SignupMode=game
|
||||||
|
RequireIpForCreate=true # fail closed if account.create omits a usable browser IP
|
||||||
|
AccountNameMaxLength=16
|
||||||
|
AccountPasswordMaxLength=30
|
||||||
|
```
|
||||||
|
|
||||||
|
Read in `BridgeConfig.Load()`, re-readable via `[bridge reload`. `SignupMode` parses like `AdminAccessFloor` — unrecognized value falls back to the safest option (`game`, i.e. no website creation) with a console warning, so a typo can never accidentally open provisioning. `RequireIpForCreate` defaults **on**: the per-IP cap only means something if a missing IP is refused rather than waved through. Turn it off only for a deployment that deliberately does not cap website signups by IP (and then `MaxAccountsPerIP` still applies in-game as before).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. Open item (not committed) — in-game → website creation sync
|
||||||
|
|
||||||
|
Per the 2026-07-17 decision, **this is not in 2.0's committed scope.** When an account is created *in-game* (first-login auto-create, or staff `[AddAccount`), the website is **not** notified today, and 2.0 does not change that. Recorded here so the tradeoff is explicit, not forgotten:
|
||||||
|
|
||||||
|
- **Why it's hard cleanly:** there is no `EventSink.AccountCreated`. The only faithful tap is a core edit — an `Action<Account>` raised in the `Account(string, string)` ctor (safe: the load path is a *separate* ctor, `Account.cs:189`, so it won't fire during world load), shipped as a `patches/` diff exactly like `PlayerVendorSale` and the `CommandLogging` event.
|
||||||
|
- **Why it may not be needed:** in `website`-mode the website already knows every account (it created them). Sync only matters for `hybrid`/`game` modes where the website wants a roster of game-born accounts — and even then the sidecar can approximate "new account" from the `mob.login` `acct` field it already receives (first-seen = new), lossy but zero core edits.
|
||||||
|
- **If we do it later:** it becomes an `account.created` event stream (`origin:"in-game"`), the natural mirror of the `account.audit` (`origin:"web"`) that `account.create` emits — the same bidirectional-audit shape §5.5 of `ADMIN_CONTROLS.md` established. Revisit if a shard chooses `hybrid`/`game` and wants a complete website roster.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. Where the code goes
|
||||||
|
|
||||||
|
| File | Responsibility |
|
||||||
|
|------|----------------|
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeAccounts.cs` | **New.** Registers `account.create` and `account.unlink`; the create+link, char-safety validation, collision check, Owner floor on unlink, `account.audit` emission. Mirrors `BridgeAdmin.cs` structure. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeAccountLink.cs` | **Extend.** Add the `[unlink` player command beside `[link`. No change to existing link behavior. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeConfig.cs` | **Extend.** `SignupMode` (parsed, safe fallback), `AccountCreateEnabled`, `RequireIpForCreate`, name/password length caps; read `Accounts.AutoCreateAccounts` and warn on mode mismatch. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeBoot.cs` | **Extend.** Wire `BridgeAccounts.Initialize()` into `Initialize()` (one line, beside the other subsystems). |
|
||||||
|
| `overlay/Config/Bridge.cfg` + `.example` | **Extend.** The §6 keys, defaults documented. |
|
||||||
|
| `sidecar/src/web.rs` | **Extend.** `POST /accounts/create` (forwards `ip` from the body untouched), `DELETE /link/:account`; `respond_account` status mapping (409 on collision, 429 on IP cap, 400 on missing IP); scrub password from any logged/broadcast value. |
|
||||||
|
| `sidecar/src/store.rs` | **Extend.** `record_unlink` (clear the mirrored link row) beside the existing `record_link`. |
|
||||||
|
| `docs/INTEGRATION.md` | **Extend.** Document `POST /accounts/create`, `DELETE /link/{account}`, and the `account.audit` event. |
|
||||||
|
| *(website, separate repo)* | Signup form → `POST /accounts/create`; unlink control → `DELETE /link/{account}`; consume `account.audit`. |
|
||||||
|
|
||||||
|
No new core/stock edits in committed scope — `account.create`/`unlink` are all script-layer (`new Account`, `SetTag`/`RemoveTag`) called from the new overlay. The only core edit contemplated (the `AccountCreated` event, §7) is explicitly deferred.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. Phasing
|
||||||
|
|
||||||
|
1. ~~**Config + modes.**~~ **Done.** `BridgeConfig` gains `SignupMode` (parsed, unrecognized → `game`), `AccountCreateEnabled` (mode-following default), `RequireIpForCreate`, name/password caps, and the boot-time `Accounts.AutoCreateAccounts` mismatch warning. `[bridge status` shows `signup=…(create=…)`.
|
||||||
|
2. ~~**`account.create`.**~~ **Done.** `BridgeAccounts.cs` + `POST /accounts/create` + `respond_account`. Gate on mode, `actor` required, char-safety mirrored from `AccountHandler`, collision → 409, IP cap via `CanCreate`/`LogAccess` (fail-closed on missing/loopback IP when `RequireIpForCreate`), create + link, `account.audit`, password never logged/echoed. *Acceptance below is written for a live run — not yet exercised end-to-end.*
|
||||||
|
3. ~~**Unlink — both surfaces.**~~ **Done.** `account.unlink` + `DELETE /link/:account` + `store.record_unlink`, and the in-game `[unlink`. Owner floor reuses `BridgeAdmin.Protected`; `[unlink` emits `account.unlinked`.
|
||||||
|
4. ~~**Docs.**~~ **Done.** `INTEGRATION.md` §2 (protocol bumped to **2**), §4 (`account.audit`/`account.unlinked`), §6 (`POST /accounts/create`, `DELETE /link/{account}`), §7 (409/429).
|
||||||
|
|
||||||
|
**Build verification (2026-07-17):** sidecar `cargo check` clean; overlay compiled in the full ServUO Scripts tree — **0 errors, 0 warnings**. **Live end-to-end run still pending** (needs a booted shard + sidecar): create+link in website/hybrid, game-mode refusal, duplicate 409, the per-IP cap holding (second create same `ip` → 429, different IP succeeds, omitted IP → 400 while `RequireIpForCreate`), `LoginIPs[0]`/`IPTable` incremented, and unlink clearing tag+mirror with the Owner floor refusing a protected target.
|
||||||
|
|
||||||
|
Deferred (revisit only if a shard needs it): the §7 in-game→website `account.created` sync; the §12.3 `account.setpassword`/`account.exists` siblings; §12.5 credential-verb rate limiting.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Part B — Social & political world-state streams
|
||||||
|
|
||||||
|
These are **outbound** streams (shard → website), the natural extension of `PLAN.md`'s event/sweep plane. None needs a write plane; all reuse the transport, the bounded queue, and the sweep/emit-on-change discipline `BridgeSweeps` already established. Each entry below states its **grounded hook situation** so nothing rides an event that doesn't fire.
|
||||||
|
|
||||||
|
## 10. The requested streams
|
||||||
|
|
||||||
|
### 10.1 Guilds
|
||||||
|
|
||||||
|
**Hook reality (verified):**
|
||||||
|
|
||||||
|
- `EventSink.JoinGuild` is real — raised at `Scripts/Misc/Guild.cs:1597` when a mobile joins a guild. Usable as a live `guild.join`.
|
||||||
|
- `EventSink.CreateGuild` is **not** a creation notification. It is the load-time deserialization factory: raised only from `Server/World.cs:517` while reading the guild index at boot, where the handler's job is to *construct* the guild instance (`Guild.cs:775` → `new Guild(args.Id)`). Player guild creation (`new Guild(pm, name, abbrev)` at `Create Guild Gump.cs:83`, `GuildDeed.cs:127`) raises **no event**. **Do not use `CreateGuild` for "a guild was created"** — it would fire once per guild at every boot and never on an actual new guild.
|
||||||
|
- Leave, disband, leader change, alliance change, rename: **no events.**
|
||||||
|
|
||||||
|
**Delivery — a guild sweep + diff, exactly like house decay (`PLAN.md` §5.4).** `BaseGuild.List` is a `Dictionary<int, BaseGuild>` (`Server/Guild.cs:54`) — the whole registry, enumerable on the Core thread. Hold a `Dictionary<int, GuildSnapshot>` (name, abbreviation, leader serial, member count, alliance name, member-serial set hash). On each sweep, diff:
|
||||||
|
|
||||||
|
- id present now, absent before → `guild.created`
|
||||||
|
- id absent now, present before → `guild.disbanded`
|
||||||
|
- leader / alliance / name / abbreviation changed → `guild.updated`
|
||||||
|
- member set grew/shrank → `guild.join` / `guild.leave` (the sweep is the reliable source for leaves; `EventSink.JoinGuild` can *also* emit an immediate `guild.join` for joins, with the sweep as the backstop)
|
||||||
|
|
||||||
|
Take a **silent baseline** on `ServerStarted` (populate without emitting), same as decay, or every guild re-announces on every boot. Cost is trivial — a shard has tens to low-hundreds of guilds, and reading `Members.Count` + `Leader` is a handful of field reads each.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{"kind":"guild.created","id":1234,"name":"The Silver Hand","abbr":"TSH",
|
||||||
|
"leader":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech"},"members":14,"alliance":null}
|
||||||
|
{"kind":"guild.leave","id":1234,"who":{"serial":"0x77","name":"Bran"},"members":13}
|
||||||
|
{"kind":"guild.disbanded","id":1234,"name":"The Silver Hand"}
|
||||||
|
```
|
||||||
|
|
||||||
|
> If real-time (not next-sweep) leave/disband ever matters, the clean tap is a one-line `patches/` hook in `Scripts/Misc/Guild.cs` `RemoveMember`/`OnDelete` — the Phase-7 `patches/` precedent. Start with the sweep; add the patch only if latency is a real complaint. Guild membership does not move fast enough to justify it up front.
|
||||||
|
|
||||||
|
### 10.2 Town governors ("mayors")
|
||||||
|
|
||||||
|
In modern ServUO the "mayor of a town" is the **Governor** in the City Loyalty System (King Blackthorn's governance). Each `City` (enum, `CityLoyaltySystem.cs:15`) has a `CityLoyaltySystem` instance carrying `Governor` (Mobile), `GovernorElect`, an `Election`, a `Citizens` count, and a herald. The `Governor` setter already broadcasts a herald message on change (`CityLoyaltySystem.cs:193`), confirming a governor transition is a first-class in-game event — there just isn't an `EventSink` for it.
|
||||||
|
|
||||||
|
**Delivery — a city sweep, emit-on-change.** `CityLoyaltySystem.Cities` (static `List<CityLoyaltySystem>`, `CityLoyaltySystem.cs:680`) is the full set, one per city. Sweep, hold `Dictionary<City, governorSerial>`, emit on transition. Governors change on the order of weeks — a slow sweep (e.g. 5 min, or fold into the economy sweep cadence) is ample. Also emit election open/close and, optionally, the standing.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{"kind":"city.governor","city":"Britain","from":{"serial":"0x55","name":"Old Mayor"},
|
||||||
|
"to":{"serial":"0x1A2B","name":"Darrow","acct":"whitlocktech"}}
|
||||||
|
{"kind":"city.election","city":"Moonglow","phase":"nominate","candidates":3,"endsAt":"2026-07-24T…"}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Gate on `CityLoyaltySystem.Enabled`** (`CityLoyalty.Enabled`, default true). If a shard runs its own custom town-ownership system instead, this sweep should no-op — detect and log, don't assume.
|
||||||
|
|
||||||
|
### 10.3 Player titles
|
||||||
|
|
||||||
|
There is **no title-change event.** Titles are read-model state, best delivered two ways, not as a stream:
|
||||||
|
|
||||||
|
- **Enrich `char.profile`** (`BridgeProfile`) with a `titles` block. Sources on a `PlayerMobile`: the reward-title list `m_RewardTitles` (`List<object>`) + the selected index `m_SelectedTitle` (`PlayerMobile.cs:4194,4595`), the champion title `m_CurrentChampTitle`, plus the computed titles from `Titles.ComputeTitle` / `ComputeFameTitle` / `GetSkillTitle` / veteran titles (`Scripts/Misc/Titles.cs`). `char.profile` already carries all-skills, so titles slot in beside it at near-zero extra cost, and it is a *read* — no hook needed.
|
||||||
|
- **Optional `title.change`** only if the community page wants a live "so-and-so is now *Grandmaster Blacksmith*" feed — and then it comes from a **profile-diff in the sidecar**, not a shard event (the shard has nothing to subscribe to). Recommend starting with profile enrichment; add the diff feed only if there is demand.
|
||||||
|
|
||||||
|
City titles and faction/VvV merchant titles (`CityLoyaltySystem.ApplyCityTitle`, `MerchantTitles.cs`) fold into the same `titles` block.
|
||||||
|
|
||||||
|
### 10.4 Factions / Vice vs Virtue
|
||||||
|
|
||||||
|
**Which system is live is a shard decision — verify before building.** Two exist:
|
||||||
|
|
||||||
|
- **Old Factions** (`Scripts/Services/Factions`): `Faction.Commander` (leader, `Faction.cs:160`), `Faction.Election`, `Faction.Members` (`List<PlayerState>`), and faction-controlled **Towns** (`Town.cs` — each town has an owning faction, a sheriff, and finance). Config-gated and, on most modern shards, **off**.
|
||||||
|
- **Vice vs Virtue** (`Scripts/Services/ViceVsVirtue`): the modern replacement. `ViceVsVirtueSystem.Enabled` (`VvV.Enabled`, default **true**), a singleton `Instance`, an active `Battle`, and per-player `VvVPlayerEntry` (score, kills, assists). City control in VvV rides the same city-loyalty/governor rails as §10.2.
|
||||||
|
|
||||||
|
**Delivery — a sweep, gated on whichever is enabled.** Neither system raises membership/leadership `EventSink`s, so it is the same sweep+diff pattern:
|
||||||
|
|
||||||
|
- VvV (recommended default): standings per side, active-battle status (`Battle.OnGoing`, current city), and the top `VvVPlayerEntry` scores → a `vvv.standings` snapshot on change + a `vvv.battle` open/close event.
|
||||||
|
- Old Factions (only if a shard runs it): `faction.control` (town → owning faction on change), `faction.commander` (leader change from the `Election`).
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{"kind":"vvv.battle","phase":"start","city":"Britain","map":"Felucca","endsAt":"2026-07-17T…"}
|
||||||
|
{"kind":"vvv.standings","order":142000,"chaos":138500,"leaderSide":"Order"}
|
||||||
|
```
|
||||||
|
|
||||||
|
> Start by detecting which system is enabled at boot and streaming only that one; emit a one-time `world.systems` frame (what's on: cityLoyalty, vvv, factions) so the website renders the right panels instead of guessing.
|
||||||
|
|
||||||
|
## 11. Further integration points — a menu to pick from
|
||||||
|
|
||||||
|
Everything below is grounded in a hook or a cheap sweep in *this* server. Ranked roughly by value-to-effort. **Pick the ones you want and I'll fold them into the phasing.** (✔ = a real `EventSink` exists; ⟳ = sweep/diff; ⚑ = needs a small `patches/` core tap.)
|
||||||
|
|
||||||
|
| # | Stream | Source | Effort | Why it's worth it |
|
||||||
|
|---|--------|--------|:------:|-------------------|
|
||||||
|
| 1 | **Who's-online / population** | ⟳ online sweep over `NetState.Instances` | low | A live "N players online", per-facet population, and a history series. The single most-asked-for website widget. |
|
||||||
|
| 2 | **Region presence** | ✔ `EventSink.OnEnterRegion` (`Region.cs:1160`, player-filtered) | low | Cheap location stream → town population heatmap, "who's in Despise" — `PLAN.md` §5.6 already flags it as the right answer over `Movement`. |
|
||||||
|
| 3 | **Crafting feed** | ✔ `EventSink.CraftSuccess` | low | Who crafted what, exceptional/runic — a crafting economy + "notable crafts" feed. |
|
||||||
|
| 4 | **Taming feed** | ✔ `EventSink.TameCreature` | low | New tames, esp. rares/greaters — high community interest. |
|
||||||
|
| 5 | **Resource harvesting** | ✔ `EventSink.ResourceHarvestSuccess` | low-med | Mining/lumber/fishing volume → the raw-material side of the economy (pairs with the vendor/gold streams already shipped). |
|
||||||
|
| 6 | **Virtue progression** | ✔ `EventSink.VirtueLevelChange` | low | Knight/Seeker/etc. virtue ranks — a progression badge system. |
|
||||||
|
| 7 | **Bulk Order Deeds** | ✔ `EventSink.BODOffered` / `BODUsed` | low | BOD turn-ins and rewards — a crafting-endgame feed and reward-title source. |
|
||||||
|
| 8 | **Guild wars** | ⟳ from the §10.1 guild sweep (war state on `Guild`) | low | Declared/active/ended wars between guilds — a PvP politics board, nearly free once guilds sweep. |
|
||||||
|
| 9 | **Player housing registry** | ⟳ extend the existing decay sweep to a full house list | med | Owner → houses map, "houses for sale" (via vendor data already streamed), a housing map. Reuses `PLAN.md` §5.4 machinery. |
|
||||||
|
| 10 | **Peerless / boss / rare drops** | ⚑ virtual-override or drop-system tap (no `EventSink`) | med | An "epic loot" feed. Honest cost: no clean event (same gap as per-hit damage, `PLAN.md` §5.9) — needs a targeted `patches/` hook, so it is a deliberate pick, not a freebie. |
|
||||||
|
| 11 | **Secure player trades** | ⚑ `SecureTrade` completion has no `EventSink` | med | Player-to-player item/gold transfers → economy + fraud signal, complements the vendor-sale core edit. Needs a core tap. |
|
||||||
|
| 12 | **Champion spawn *board*** | already shipped (`BridgeChamps`) — extend, don't rebuild | — | Champs are done in 1.0. Listed so it is not re-proposed; any gap is an extension of the existing sweep. |
|
||||||
|
|
||||||
|
**Selected for Part B (owner pick, 2026-07-17):** guilds (§10.1) + governors (§10.2) + who's-online (#1) + region presence (#2) + **housing registry (#9)** + titles (§10.3, free as profile enrichment). All reuse the sweep pattern and need no core edit; together they give a website its "living world" page — population, guild politics, town leadership, and a housing map. Factions/VvV (§10.4) is deferred until you confirm which system your shard runs. The phasing is §13.
|
||||||
|
|
||||||
|
### Where the Part B code goes
|
||||||
|
|
||||||
|
| File | Responsibility |
|
||||||
|
|------|----------------|
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeSocial.cs` | **New.** The guild sweep+diff and the `EventSink.JoinGuild` subscription → `guild.*`. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeGovernance.cs` | **New.** The city sweep → `city.governor`/`city.election`; the VvV/faction standings sweep (gated on enabled) → `vvv.*` / `faction.*`; the one-time `world.systems` frame. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeProfile.cs` | **Extend.** Add the `titles` block to `char.profile`. |
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeSweeps.cs` | **Extend / mirror.** New sweep timers (guild, city, presence), re-armable via `[bridge reload`, one-shot via `[bridge sweepnow`, counters in `[bridge status` — same shape as the existing sweeps. |
|
||||||
|
| `overlay/Config/Bridge.cfg` | **Extend.** `GuildSweepSeconds`, `CitySweepSeconds`, `PresenceSweepSeconds` (+ enable flags). |
|
||||||
|
| `sidecar/src/store.rs` + `web.rs` | **Extend.** Persist the snapshots that back boards (guild roster, governors, population history); `GET /guilds`, `/governors`, `/online` served from the store so they survive a shard outage, exactly like `/champs` and `/economy` do today. |
|
||||||
|
| `docs/INTEGRATION.md` | **Extend.** New event catalog entries + the read endpoints. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 12. Cross-cutting additions (recommended)
|
||||||
|
|
||||||
|
Five things that are not new *streams* but make 2.0 correct and complete. The first two I consider **essential**; the rest are high-value companions to what's already specced.
|
||||||
|
|
||||||
|
### 12.1 Bump the protocol version to 2 — **essential**
|
||||||
|
|
||||||
|
The sidecar is `PROTOCOL_VERSION = 1` (`sidecar/src/main.rs:23`), and every response carries `X-UOLink-Version`; the gate 409s a client that declares a different one (`web.rs:146`). 2.0 adds inbound verbs (`account.create`, `account.unlink`, …) and event kinds, so it must bump to `2`.
|
||||||
|
|
||||||
|
The compatibility rule to write down: **new outbound event kinds are additive** — a 1.x website ignores unknown kinds and keeps working, so the live feed stays backward-compatible. What is *not* compatible is a client that calls a **new inbound verb** against an old sidecar, or a new sidecar that a strict old client rejects on the version header. So: bump to `2`, keep the feed additive, and document that the new *verbs/endpoints* require a v2 sidecar while the *event feed* degrades gracefully.
|
||||||
|
|
||||||
|
### 12.2 Every diff stream needs a REST snapshot companion — **essential**
|
||||||
|
|
||||||
|
The Part B streams are **diff-based**: `guild.created`/`disbanded`, `city.governor`, housing changes emit only on transition (like house decay). That means a website that connects fresh — or a **sidecar that restarts** — has seen *no* deltas yet and therefore has **no current state**. The live feed alone can never answer "what are the guilds *right now*."
|
||||||
|
|
||||||
|
So every board-backed stream ships with a REST snapshot served from the sidecar's store, exactly as `/champs` and `/economy` already are (`web.rs`): `GET /guilds`, `/governors`, `/online`, `/houses`. The shard emits deltas; the sidecar persists the latest snapshot; the website hydrates from REST on load and then live-updates from the feed. This is the single most important robustness rule for Part B — without it, a sidecar restart silently blanks the community page until the next guild happens to change.
|
||||||
|
|
||||||
|
> Concretely: the sidecar keeps a `guilds` / `governors` / `population` table updated from the stream (upsert on each delta, plus a periodic full snapshot the shard can push), and the REST route reads that table. The shard should also support an on-demand full re-emit (a `snapshot.request` inbound, or just re-run the sweep with baseline suppression off) so a sidecar that lost its store can rebuild.
|
||||||
|
|
||||||
|
### 12.3 Round out the provisioning surface — password reset, existence check
|
||||||
|
|
||||||
|
`account.create` sets the account's **initial** password (§3) — that part is done. What it does not cover is the rest of the credential lifecycle. Two small siblings close it, both trivially grounded:
|
||||||
|
|
||||||
|
- **`account.setpassword`** — the **later** password *change/reset* for an account that already exists (a player who forgot theirs), distinct from the initial password `account.create` sets. `acct.SetPassword(newpw)` (`Account.cs:676`) is public; the verb takes `{actor, account, password}`, applies the Owner floor, emits `account.audit action:"setpassword"`, and — like create — **never echoes the password**. `POST /accounts/{account}/password`. Only worth building if the site will offer a "forgot password" flow.
|
||||||
|
- **`account.exists`** — the signup form wants to say "that name is taken" before submit. A read: `Accounts.GetAccount(un) != null`. `GET /accounts/{account}` → `{exists: true|false, linked: bool}`. Cheap, and it prevents the worse UX of finding out via a 409 on submit.
|
||||||
|
|
||||||
|
Both reuse the `account.*` machinery from Part A verbatim. `account.setpassword` is the higher-value of the two.
|
||||||
|
|
||||||
|
### 12.4 Mirror hygiene — deletion & link teardown
|
||||||
|
|
||||||
|
If the website mirrors rosters/links (it does — `store.record_link`), it must learn when the game side removes things, or the mirror rots:
|
||||||
|
|
||||||
|
- **Character deletion.** `EventSink.DeleteRequest` (`EventSink.cs:1754`) fires when a player deletes a character at the select screen. Emit `char.deleted` so the website drops it from any roster it caches. (`PLAN.md` §5.1 already lists this hook as a roster-honesty signal — 2.0 is where it earns its place, now that the website keeps rosters.)
|
||||||
|
- **Account deletion.** `Account.Delete()` exists (`Account.cs:642`); an optional `account.delete` verb (Owner-floor-guarded, `origin:"web"` audit) closes the lifecycle. Lower priority — most shards ban rather than delete — but list it so the option is on record.
|
||||||
|
- On any unlink **or** account delete, the sidecar clears its link mirror (the `record_unlink` already specced in §4.1), so event attribution stops immediately.
|
||||||
|
|
||||||
|
### 12.5 Rate-limit the credential verbs
|
||||||
|
|
||||||
|
`account.create` and `account.setpassword` mint/change persistent credentials. The per-IP cap (§3.1) blocks multi-accounting from one IP, but a compromised or buggy website could still hammer distinct IPs. Add a **sidecar-side rate limit** on the credential verbs — a global create-per-minute ceiling and a per-`actor` cooldown — mirroring the caps philosophy town-crier and the admin plane already follow (`BridgeConfig.TownCrier*`, `Admin*`). Cheap insurance; the shard stays the last line of defense (collision + IP cap), the sidecar is the first.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 13. Part B phasing
|
||||||
|
|
||||||
|
1. ~~**Guilds + governors.**~~ **Built (2026-07-17), compiles clean both sides.** `BridgeSocial.cs` (guild sweep + `JoinGuild` → `guild.update`/`guild.remove`/`guild.join`) and `BridgeGovernance.cs` (city sweep → `city.update`, gated on `CityLoyaltySystem.Enabled`), `GuildSweepSeconds` (60s) / `CitySweepSeconds` (300s) config, both wired into `[bridge reload|sweepnow|status`. Sidecar `guilds`/`governors` board tables + `GET /guilds`, `/governors` served from the store (the §12.2 snapshot rule). Shared `BridgeJson.Actor` writer (serial/name/acct/webId/player). **Deviation from the §10 sketch:** the wire uses full-state `guild.update`/`city.update` upserts (website derives "created"/"governor changed" from the board) rather than discrete `guild.created`/`city.governor` events — this avoids a reconnect re-emit looking like a storm of creations, matching the proven `champ.update` model. *Live end-to-end run still pending.*
|
||||||
|
2. ~~**Presence.**~~ **Built (2026-07-17), compiles clean both sides.** `BridgePresence.cs`: a `presence.online` sweep (total + per-facet + per-region, emitted on change) and real-time `region.enter` (`EventSink.OnEnterRegion`, player-filtered). `PresenceSweepSeconds` (30s), wired into `[bridge`. `GET /online` serves the latest snapshot from the event store (population series via `/history?kind=presence.online`). *Live run pending.*
|
||||||
|
3. ~~**Housing registry.**~~ **Built (2026-07-17), compiles clean both sides.** `BridgeHousing.cs`: a house sweep over `BaseHouse.AllHouses` → `house.update`/`house.remove` (owner, region, location, decay, co-owners, friends, price), complementing the existing `house.decay` transition feed. `HousingSweepSeconds` (300s), wired into `[bridge`. Sidecar `houses` board + `GET /houses`. (Stock ServUO has no "for sale" flag, so this is owner→houses; `price` is the placement value, not a listing.) *Live run pending.*
|
||||||
|
4. ~~**Titles.**~~ **Built (2026-07-17), compiles clean.** `char.profile` gains a `titles` block (`selected`, `fameKarma`, `skill`, `reward[]`) from `PlayerMobile` accessors — no new stream, folds into `BridgeProfile`. *Live run pending.*
|
||||||
|
5. **Factions/VvV** — **deferred** (owner decision): only after confirming which system the shard runs; stream just the enabled one.
|
||||||
|
|
||||||
|
Cross-cutting, lands with Phase 1: the **protocol bump to 2** (§12.1) and the **snapshot-companion rule** (§12.2). The provisioning siblings (§12.3) and mirror-hygiene (§12.4) attach to Part A's phasing since they extend the `account.*` surface.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 14. Built-in reports — replace the FTP/HTML path with JSON over the sidecar
|
||||||
|
|
||||||
|
ServUO ships a **Reports engine** (`Server.Engines.Reports`, `Scripts/Services/Reports/`) that already compiles exactly the dashboard data a website wants — it just delivers it the way RunUO did in 2004: render static HTML and **FTP it to your website**. The bridge can tap the *compiled data* directly and ship JSON, retiring the file/FTP path entirely. **No core edit** — the compile methods are `public static`.
|
||||||
|
|
||||||
|
### 14.1 What the engine produces (verified)
|
||||||
|
|
||||||
|
`Reports.Generate()` runs hourly on the Core thread and builds a `Snapshot` from public static compile methods (`Reports.cs`):
|
||||||
|
|
||||||
|
| Method | Returns | Content |
|
||||||
|
|--------|---------|---------|
|
||||||
|
| `CompileGeneralStats()` | `Report` | NPCs, Players, Clients, Accounts, Items |
|
||||||
|
| `CompileStatChart()` | `Chart` | population over time |
|
||||||
|
| `CompileSkillReports()` | `PersistableObject[]` | **skill distribution — GM count per skill** |
|
||||||
|
| `CompileFactionReports()` | `PersistableObject[]` | faction membership / stats |
|
||||||
|
| `Reports.StaffHistory` | `StaffHistory` | staff activity per account (`StaffInfo`/`UserInfo` hashtables), **help-page-queue length over time** (`QueueStats`), page history |
|
||||||
|
|
||||||
|
Each `Report` is structured (`Columns` + `Items`), so it serializes to JSON cleanly with the hand-rolled `BridgeJson` writers — no reflection serializer. The engine also persists an hourly **`SnapshotHistory`** series to disk, so a backfill of historical points is available if wanted.
|
||||||
|
|
||||||
|
### 14.2 How it's delivered today (the file path you flagged)
|
||||||
|
|
||||||
|
- **HTML + FTP.** `UpdateOutput` (`Reports.cs:406`, on a ThreadPool thread) runs `HtmlRenderer` into `<BaseDir>/reports/stats/` and `reports/staff/` (`Reports.Path`, default `reports`), then `Upload()` writes an `upload.ftp` job to FTP the HTML to a website. Gated on `Reports.AutoGenerate` (**default off**).
|
||||||
|
- **WebStatus.** A *separate* mechanism (`Scripts/Misc/WebStatus.cs`): an in-process `HttpListener` on `:80/status/` serving a live status HTML page. Default `Enabled = false`.
|
||||||
|
|
||||||
|
Both are the "report goes to a file / gets pushed out-of-band" pattern. The sidecar already replaces the second one (`/health` + the live feed cover what `WebStatus` served); §14 replaces the first.
|
||||||
|
|
||||||
|
### 14.3 The tap — a report sweep, JSON out
|
||||||
|
|
||||||
|
`BridgeReports.cs` runs a **Core-thread timer** (`ReportSweepSeconds`, e.g. hourly to match stock, or faster) that calls the same public compile methods, serializes the `Report`/`Chart` objects to JSON, emits `report.*`, and hands the sidecar a snapshot to persist and serve over REST:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{"kind":"report.skills","t":1752…,"skills":[
|
||||||
|
{"skill":"Swordsmanship","gms":42},{"skill":"Magery","gms":88}, …]}
|
||||||
|
{"kind":"report.general","players":142,"npcs":42826,"clients":150,"accounts":51,"items":206467}
|
||||||
|
{"kind":"report.staff","window":"7d","staff":[
|
||||||
|
{"account":"GreyBeard","actions":318}],"pageQueue":[{"t":…,"open":4}, …]}
|
||||||
|
```
|
||||||
|
|
||||||
|
Served for hydration (the §12.2 snapshot rule): `GET /reports/skills`, `/reports/general`, `/reports/staff`.
|
||||||
|
|
||||||
|
Key points, all grounded:
|
||||||
|
|
||||||
|
- **No core edit, no HTML, no FTP.** Calling `Compile*` directly skips `HtmlRenderer`/`Upload` entirely. Leave `Reports.AutoGenerate` **off** (no HTML files written) and run the bridge tap instead. The FTP `upload.ftp` path and `Reports.Path` become dead weight for a bridge-connected shard.
|
||||||
|
- **Threading.** `Compile*` read `World.Mobiles`/`Skills`, so they must run on the Core thread — which the bridge's sweep timers already are (`PLAN.md` non-negotiables). Stock only offloaded the *HTML rendering* (slow string work) to a ThreadPool; the bridge skips that step, so there's nothing to offload. Skill distribution walks all mobiles once — treat it like the profile-bulk warning in `PLAN.md` §1: run it on a slow cadence (hourly is plenty), never in a fast sweep.
|
||||||
|
- **Dedupe against Part B.** `report.general` and the population chart overlap with who's-online (§11 #1); faction reports overlap with §10.4. The **unique** wins here are **skill distribution** (a GM-per-skill leaderboard available nowhere else in the bridge) and the **staff-activity + page-queue-length history** (aggregates that complement the per-action `admin.audit` we already stream). Prioritize those two; treat the rest as "already covered, don't double-emit."
|
||||||
|
- **Optional backfill.** On first connect the sidecar could ingest the engine's persisted `SnapshotHistory` (`Reports.StaffHistory`/stats history) to seed the historical series instead of starting empty. Nice-to-have, not required.
|
||||||
|
|
||||||
|
### 14.4 Where the code goes
|
||||||
|
|
||||||
|
| File | Responsibility |
|
||||||
|
|------|----------------|
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeReports.cs` | **New.** Core-thread report sweep calling `Reports.Compile*` + `Reports.StaffHistory`; serialize to `report.*`; re-armable via `[bridge reload`, one-shot via `[bridge sweepnow`. |
|
||||||
|
| `overlay/Config/Bridge.cfg` | **Extend.** `ReportSweepSeconds` (+ enable flag). |
|
||||||
|
| `sidecar/src/store.rs` + `web.rs` | **Extend.** Persist the report snapshots; `GET /reports/{skills,general,staff}` served from the store (survives shard outage, like `/champs`). |
|
||||||
|
| `docs/INTEGRATION.md` | **Extend.** `report.*` events + endpoints; note they supersede the stock FTP/HTML reports and `WebStatus`. |
|
||||||
|
|
||||||
|
> **Recommendation:** fold this in as **Part B, Phase 6** (after the world-state streams), scoped to skill distribution + staff/page-queue history first. It is low-effort (public methods, existing sweep pattern) and directly answers "get the admin reports onto the site instead of a file" — by tapping the data the engine already computes and never letting it become a file at all.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 15. Smoke test — live run (2026-07-17)
|
||||||
|
|
||||||
|
Deployed the overlay to the ServUO checkout, booted the shard and the real sidecar (protocol 2, `plugin_connected: true`), and exercised every new surface over REST against the live game. All green.
|
||||||
|
|
||||||
|
**Part A — provisioning (through the real shard):**
|
||||||
|
|
||||||
|
| Check | Result |
|
||||||
|
|-------|--------|
|
||||||
|
| `POST /accounts/create` (fresh IP) | **200** `account.ok`, account created + linked |
|
||||||
|
| duplicate name | **409** `account already exists` |
|
||||||
|
| per-IP cap | shard's real `AccountsPerIp=3` enforced: 3rd from one IP allowed, **4th → 429** `ip account limit reached` |
|
||||||
|
| loopback IP with `RequireIpForCreate` | **400** `client ip required` (fails closed) |
|
||||||
|
| `GET /link/{acct}` after create | **200**, linked to the website id |
|
||||||
|
| `DELETE /link/{acct}` | **200** `unlink`; lookup then **404** |
|
||||||
|
|
||||||
|
**Part B — world-state boards (through the real shard):**
|
||||||
|
|
||||||
|
| Endpoint | Result |
|
||||||
|
|----------|--------|
|
||||||
|
| `GET /houses` | **28 houses**, full owner/decay/co-owner/built-on data (shard → `house.update` → board → REST) |
|
||||||
|
| `GET /governors` | **9 cities**, `governor: null`/`electionPhase: none` on this unseeded world |
|
||||||
|
| `GET /guilds` | `[]` — no guilds on this world; the sweep ran without error |
|
||||||
|
| `GET /online` | `count: 0` — headless (no UO client), snapshot emitted and stored |
|
||||||
|
| `GET /char/{acct}/0` | full profile incl. the new `titles` block |
|
||||||
|
|
||||||
|
**Not exercised (needs a live UO client, not a headless boot):** `presence.online` with real players, `region.enter`, real-time `guild.join`, and `char.vitals`. And `guild.join`/guild board content needs a guild to exist. These are inherent to a clientless smoke test — the board *plumbing* is proven by `/houses`, which uses the identical path.
|
||||||
|
|
||||||
|
**One operational note surfaced:** the boot-time `Dynamic` script recompile **cannot replace `Scripts.dll` while the server is running**, because the Scripts build tries to copy the locked `ServUO.exe` and fails (the `PLAN.md §3` trap). The fix used here: build `Scripts/Scripts.csproj` once with the server **stopped**, then boot — the offline build produces a fresh `Scripts.dll` the boot then loads. Rely on this, not the in-process rebuild, when deploying new bridge code. The shard's world save was left untouched (hard-kill, no autosave), so the test accounts did not persist.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 16. Town Cryer news — website articles into the news gump (Protocol 2.1)
|
||||||
|
|
||||||
|
**Status:** **Built and smoke-tested live** (2026-07-17). `BridgeNews.cs` (pure overlay, no stock edit) + `POST /news` / `DELETE /news/{id}` + reconnect replay. Verified against a booted shard: `news.add` (full + title-only) → `news.ok`, missing title → 400, idempotent replace, `news.remove` → `news.ok`, unknown id → `news.error`, no shard exceptions, and the **reconnect replay** confirmed (after a shard restart the stored article was re-pushed with `announce:false` and re-accepted). The gump rendering itself is verified by source inspection (needs a UO client to view).
|
||||||
|
|
||||||
|
There are **two** distinct town-crier surfaces in ServUO, and 2.0 has so far touched only the first:
|
||||||
|
|
||||||
|
1. **The scrolling crier** (`GlobalTownCrierEntryList`) — the wandering Town Crier NPC that *says* short announcement lines. Protocol 1.0 phase 6 (`BridgeTownCrier.cs`, `towncrier.add`/`remove`) already drives this.
|
||||||
|
2. **The Town Cryer News gump** (`TownCryerSystem.NewsEntries`) — the paged news UI with title + body + image + a "more info" URL per article. **Nothing drives this yet.** This section adds it.
|
||||||
|
|
||||||
|
The ask: a website news article should land as a full article in the **news gump** (2), and the crier should also *say* just the **title** through the existing say feature (1) — so players get the audible "Hear ye!" proclamation while the full write-up lives in the gump.
|
||||||
|
|
||||||
|
### 16.1 The hook (verified in the shard's source)
|
||||||
|
|
||||||
|
- **`TownCryerSystem.NewsEntries`** (`TownCryerSystem.cs:40`) — `public static List<TownCryerNewsEntry>`. The setter is private, but the **list is public and mutable**, so it can be inserted into and removed from directly.
|
||||||
|
- **`TownCryerNewsEntry(TextDefinition title, TextDefinition body, int gumpImage, Type questType, string url)`** (`TownCryerNewsEntry.cs`) — public ctor. Pass `questType: null` for website news.
|
||||||
|
- **The display gumps already handle string content**, so no gump edits are needed:
|
||||||
|
- List view (`TownCryerGump.cs:97-103`): `if (entry.Title.Number > 0) AddHtmlLocalized(...) else AddLabelCropped(..., entry.Title)`.
|
||||||
|
- Detail view (`TownCryerNewsGump.cs:27-42`): `if (Entry.Body.Number > 0) AddHtmlLocalized(...) else AddHtml(..., Entry.Body.String, ..., true)` — a **string body renders as HTML** (so `<CENTER>…</CENTER><BR><BR>…` works), `AddImage(..., Entry.GumpImage)`, and `InfoUrl` becomes a `LaunchBrowser` button.
|
||||||
|
- **Stock news is live on this shard.** `TownCryerSystem.Initialize()` adds ~18 hardcoded `uo.com` entries whenever `TownCryerSystem.Enabled` (`TownCryerSystem.cs:93-120`) — *not* gated by `UsePreloadedMessages` (that only gates a reload command). So the list is not empty, and our sync must not clobber it (see §16.3).
|
||||||
|
|
||||||
|
### 16.2 Evaluating the pasted guidance
|
||||||
|
|
||||||
|
The pasted analysis is **substantially correct** and useful — it identifies the right hook (`NewsEntries`), the right constructor, the cliloc-vs-string branching the gump already does, the image/url fields, and the important instinct to keep stock news separate. Two adjustments for *this* architecture:
|
||||||
|
|
||||||
|
- **No stock patch is needed.** The pasted plan adds `AddNewsEntry` / `ClearExternalNews` methods to the stock `TownCryerSystem.cs`. That file is stock ServUO, so editing it would ship as a `patches/` diff (like `PlayerVendorSale`). We can avoid that entirely: because `NewsEntries` is a **public mutable list**, the bridge overlay inserts and removes directly — `TownCryerSystem.NewsEntries.Insert(0, entry)` / `.Remove(entry)` — and keeps the "which entries are ours" bookkeeping in an **overlay-side list**, not in a new field on the stock class. This is exactly how `BridgeTownCrier` already mutates `GlobalTownCrierEntryList` from the overlay. Pure overlay, zero stock edits.
|
||||||
|
- **Track our entries to keep stock intact.** Rather than the pasted `ExternalNewsEntries` field on the stock class, the overlay holds `List<TownCryerNewsEntry> _ours`. On a sync we `Remove` our previous entries from `NewsEntries` and insert the new set — the stock `uo.com` articles are never touched. `MaxNewsEntries` is 100 (`TownCryerSystem.cs:26`); the overlay caps its own contribution well under that.
|
||||||
|
|
||||||
|
Everything else in the pasted note stands, and the "this is one of the easier integrations — you're replacing the content provider" framing is right.
|
||||||
|
|
||||||
|
### 16.3 The two surfaces, tied together
|
||||||
|
|
||||||
|
On an inbound article the bridge does two things on the Core thread:
|
||||||
|
|
||||||
|
1. **News gump** — build `new TownCryerNewsEntry(new TextDefinition(title), new TextDefinition(body), image, null, url)` and `Insert(0, …)` at the top of `TownCryerSystem.NewsEntries`, tracking it in `_ours`; trim `_ours` past the cap by removing the oldest (from both `_ours` and `NewsEntries`).
|
||||||
|
2. **Say the title** — reuse the scrolling-crier path (`GlobalTownCrierEntryList`, as `BridgeTownCrier` does) to announce a single line, the **title only**, for a short duration, so the crier proclaims it in-world. **On by default**; set `announce: false` on an article to suppress it (e.g. a silent correction that should not re-proclaim).
|
||||||
|
|
||||||
|
### 16.4 Protocol
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
// website → sidecar → shard
|
||||||
|
{"kind":"news.add","id":"42","title":"Double XP Weekend",
|
||||||
|
"body":"<CENTER>Double XP Weekend</CENTER><BR><BR>Starts Friday 7PM.",
|
||||||
|
"image":1614,"url":"https://uomysticmoon.com/news/42"}
|
||||||
|
// announce defaults to true; add "announce":false to suppress the crier proclamation
|
||||||
|
{"kind":"news.remove","id":"42"}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Correlated by `id` (echoed on the reply), like town-crier. Re-adding an `id` **replaces** the prior entry (find-by-id in `_ours`, remove, re-insert) — idempotent.
|
||||||
|
- `title` required; `body`/`image`/`url` optional (a title-only blurb is valid). `image` defaults to a neutral scroll gump id when absent.
|
||||||
|
- Caps (defense in depth, mirroring `TownCrier*`): title/body length, max external entries. Replies `news.ok` / `news.error`.
|
||||||
|
- Sidecar: `POST /news` (add/replace), `DELETE /news/{id}`. Same `respond`-style status mapping as town-crier.
|
||||||
|
|
||||||
|
### 16.5 Restart & re-sync (the source-of-truth rule)
|
||||||
|
|
||||||
|
`NewsEntries` is **not persisted** by ServUO — it is rebuilt at every boot from stock `Initialize()` plus whatever we have inserted since. So our external articles vanish on a shard restart until re-pushed. The **website is the source of truth**: the sidecar re-sends the current external news set on every shard (re)connect, the same discipline §12.2 uses for the diff boards. (The sidecar persists the external set in its store so it can replay it without the website being up.)
|
||||||
|
|
||||||
|
### 16.6 Where the code goes
|
||||||
|
|
||||||
|
| File | Responsibility |
|
||||||
|
|------|----------------|
|
||||||
|
| `overlay/Scripts/Custom/Bridge/BridgeNews.cs` | **New.** `news.add` / `news.remove`: insert/remove `TownCryerNewsEntry` in the public `NewsEntries` list, track `_ours`, cap; optional title announcement via `GlobalTownCrierEntryList`; replies + caps. No stock edit. |
|
||||||
|
| `overlay/Config/Bridge.cfg` | **Extend.** `NewsMaxTitleLength`, `NewsMaxBodyLength`, `NewsMaxExternal`, default announce duration. |
|
||||||
|
| `sidecar/src/web.rs` + `store.rs` | **Extend.** `POST /news`, `DELETE /news/{id}`; persist the external-news set; replay it on shard (re)connect. |
|
||||||
|
| `docs/INTEGRATION.md` | **Extend.** The `news.*` verbs + endpoints. |
|
||||||
|
|
||||||
|
No core or stock ServUO change — the whole integration rides the public `TownCryerSystem.NewsEntries` list and the existing crier say path.
|
||||||
@@ -29,6 +29,25 @@ ChampSweepSeconds=10
|
|||||||
# support queue; the full open queue is also available on demand via pages.snapshot.
|
# support queue; the full open queue is also available on demand via pages.snapshot.
|
||||||
PageSweepSeconds=5
|
PageSweepSeconds=5
|
||||||
|
|
||||||
|
# Guild roster poll (docs/PROTOCOL_2.md Part B). Guilds expose only EventSink.JoinGuild, so
|
||||||
|
# create/disband/leave/leader/alliance changes are found by diffing BaseGuild.List on this
|
||||||
|
# interval (emit guild.update / guild.remove). Guild membership moves slowly; 60s is ample.
|
||||||
|
GuildSweepSeconds=60
|
||||||
|
|
||||||
|
# Town-governor poll. Each city's Governor / election is diffed on this interval to emit
|
||||||
|
# city.update on change. Governors turn over on the order of weeks, so a slow sweep is fine.
|
||||||
|
# Idle (emits nothing) unless the City Loyalty system is enabled (CityLoyalty.Enabled).
|
||||||
|
CitySweepSeconds=300
|
||||||
|
|
||||||
|
# Presence poll. Online population (total, per-facet, per-region) is snapshotted on this
|
||||||
|
# interval and emitted as presence.online only when it changes. Region transitions come
|
||||||
|
# through separately in real time as region.enter (EventSink.OnEnterRegion).
|
||||||
|
PresenceSweepSeconds=30
|
||||||
|
|
||||||
|
# Housing registry poll. Every house is diffed on this interval to emit house.update /
|
||||||
|
# house.remove (owner, region, location, decay). Houses change slowly; a few minutes is fine.
|
||||||
|
HousingSweepSeconds=300
|
||||||
|
|
||||||
# Shown to a player when they run [link. The website page where they enter the code.
|
# Shown to a player when they run [link. The website page where they enter the code.
|
||||||
LinkUrl=https://yoursite/link
|
LinkUrl=https://yoursite/link
|
||||||
|
|
||||||
@@ -39,6 +58,15 @@ TownCrierMaxLineLength=200
|
|||||||
TownCrierMaxActive=20
|
TownCrierMaxActive=20
|
||||||
TownCrierMaxDurationSec=86400
|
TownCrierMaxDurationSec=86400
|
||||||
|
|
||||||
|
# Town Cryer news gump. Website articles (news.add) become entries in the modern Town
|
||||||
|
# Cryer News gump (TownCryerSystem.NewsEntries), separate from the scrolling-crier lines
|
||||||
|
# above. The article title is also proclaimed by the criers (announce defaults on). Caps
|
||||||
|
# are defense in depth on top of the loopback trust boundary.
|
||||||
|
NewsMaxTitleLength=100
|
||||||
|
NewsMaxBodyLength=2000
|
||||||
|
NewsMaxExternal=20
|
||||||
|
NewsAnnounceDurationSec=300
|
||||||
|
|
||||||
# Admin write plane (staff moderation from the website). OFF by default: the whole
|
# Admin write plane (staff moderation from the website). OFF by default: the whole
|
||||||
# feature is opt-in per shard. When enabled, inbound admin.* commands (kick/ban/unban/
|
# feature is opt-in per shard. When enabled, inbound admin.* commands (kick/ban/unban/
|
||||||
# broadcast) are honored. Authorization is enforced on the website; the shard trusts the
|
# broadcast) are honored. Authorization is enforced on the website; the shard trusts the
|
||||||
@@ -57,6 +85,31 @@ AdminReasonMaxLength=400
|
|||||||
# Clamp on a timed ban's duration, seconds. A ban with no/zero duration is indefinite.
|
# Clamp on a timed ban's duration, seconds. A ban with no/zero duration is indefinite.
|
||||||
AdminBanMaxDurationSec=31536000
|
AdminBanMaxDurationSec=31536000
|
||||||
|
|
||||||
|
# Account provisioning (docs/PROTOCOL_2.md Part A). Which side may mint game accounts:
|
||||||
|
# website — the website is the authority; pair with Accounts.AutoCreateAccounts=false
|
||||||
|
# (else an in-game login of any new name still mints an account).
|
||||||
|
# game — the game server is the authority; website account.create is refused.
|
||||||
|
# hybrid — either side may create (the default).
|
||||||
|
# The bridge governs only the account.create verb; the in-game first-login auto-create is
|
||||||
|
# the core Accounts.AutoCreateAccounts setting, which you pair with the mode above. On boot
|
||||||
|
# the bridge warns if the two contradict. An unrecognized value here falls back to 'game'
|
||||||
|
# (the safest — no website creation).
|
||||||
|
SignupMode=hybrid
|
||||||
|
|
||||||
|
# Master switch for the account.create verb. Absent, it follows the mode (on unless
|
||||||
|
# SignupMode=game). Set explicitly to force it on or off regardless of mode.
|
||||||
|
AccountCreateEnabled=true
|
||||||
|
|
||||||
|
# Fail closed if account.create omits a usable browser IP. The per-IP cap
|
||||||
|
# (Accounts.AccountsPerIp) only means something if a missing/loopback IP is refused rather
|
||||||
|
# than waved through. Turn off only for a deployment that deliberately does not cap website
|
||||||
|
# signups by IP (MaxAccountsPerIP still applies in-game either way).
|
||||||
|
RequireIpForCreate=true
|
||||||
|
|
||||||
|
# Length caps on a website-supplied username / password, checked before the account is made.
|
||||||
|
AccountNameMaxLength=16
|
||||||
|
AccountPasswordMaxLength=30
|
||||||
|
|
||||||
# The test scaffolding in tools/scaffolding/ reads its own flags from this file
|
# The test scaffolding in tools/scaffolding/ reads its own flags from this file
|
||||||
# (SeedOnStart, CensusOnStart, ProbeOnStart). They are absent here on purpose:
|
# (SeedOnStart, CensusOnStart, ProbeOnStart). They are absent here on purpose:
|
||||||
# Config.Get returns the default of false when a key is missing, so a deployed
|
# Config.Get returns the default of false when a key is missing, so a deployed
|
||||||
|
|||||||
@@ -52,6 +52,7 @@ namespace Server.Custom.Bridge
|
|||||||
return;
|
return;
|
||||||
|
|
||||||
CommandSystem.Register("link", AccessLevel.Player, OnLinkCommand);
|
CommandSystem.Register("link", AccessLevel.Player, OnLinkCommand);
|
||||||
|
CommandSystem.Register("unlink", AccessLevel.Player, OnUnlinkCommand);
|
||||||
BridgeBoot.RegisterHandler("link.confirm", OnLinkConfirm);
|
BridgeBoot.RegisterHandler("link.confirm", OnLinkConfirm);
|
||||||
|
|
||||||
// Purge expired codes so an unconfirmed spam of [link cannot grow the table forever.
|
// Purge expired codes so an unconfirmed spam of [link cannot grow the table forever.
|
||||||
@@ -127,6 +128,53 @@ namespace Server.Custom.Bridge
|
|||||||
url, (int)CodeTtl.TotalMinutes);
|
url, (int)CodeTtl.TotalMinutes);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---- [unlink ----
|
||||||
|
|
||||||
|
[Usage("unlink")]
|
||||||
|
[Description("Unlinks this game account from your website account.")]
|
||||||
|
private static void OnUnlinkCommand(CommandEventArgs e)
|
||||||
|
{
|
||||||
|
Unlink(e.Mobile);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Clears the WebsiteUserId tie from the caller's own account and tells the sidecar, so
|
||||||
|
/// the website can reconcile a player-initiated unlink. Player-scoped (own account only),
|
||||||
|
/// so it needs no access floor. After unlinking, [link works again.
|
||||||
|
/// </summary>
|
||||||
|
public static void Unlink(Mobile m)
|
||||||
|
{
|
||||||
|
if (m == null)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var acct = m.Account as Account;
|
||||||
|
|
||||||
|
if (acct == null)
|
||||||
|
{
|
||||||
|
m.SendMessage("Bridge: no account on this character.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var existing = acct.GetTag(Tag);
|
||||||
|
if (existing == null)
|
||||||
|
{
|
||||||
|
m.SendMessage("Your account is not linked to a website account.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
acct.RemoveTag(Tag);
|
||||||
|
DropCodesFor(acct.Username); // drop any pending codes so nothing dangles
|
||||||
|
|
||||||
|
BridgeLink.Emit(BridgeJson.Begin("account.unlinked")
|
||||||
|
.Str("origin", "in-game")
|
||||||
|
.Str("account", acct.Username)
|
||||||
|
.Str("websiteUserId", existing)
|
||||||
|
.Str("char", m.Name)
|
||||||
|
.End());
|
||||||
|
|
||||||
|
m.SendMessage(0x40, "Your account is no longer linked to website user {0}.", existing);
|
||||||
|
}
|
||||||
|
|
||||||
// ---- inbound link.confirm ----
|
// ---- inbound link.confirm ----
|
||||||
|
|
||||||
private static void OnLinkConfirm(Dictionary<string, object> o)
|
private static void OnLinkConfirm(Dictionary<string, object> o)
|
||||||
|
|||||||
281
overlay/Scripts/Custom/Bridge/BridgeAccounts.cs
Normal file
281
overlay/Scripts/Custom/Bridge/BridgeAccounts.cs
Normal file
@@ -0,0 +1,281 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Net;
|
||||||
|
|
||||||
|
using Server.Accounting;
|
||||||
|
using Server.Misc;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The account provisioning plane (docs/PROTOCOL_2.md Part A): website-driven account
|
||||||
|
/// creation and unlinking. Companion to BridgeAccountLink (the in-game [link flow), which
|
||||||
|
/// is unchanged.
|
||||||
|
///
|
||||||
|
/// account.create — mint a game account and link it to a website user in one step.
|
||||||
|
/// account.unlink — sever the WebsiteUserId tie from the website side.
|
||||||
|
///
|
||||||
|
/// Both handlers run on the Core thread (BridgeBoot marshals inbound lines through
|
||||||
|
/// Timer.DelayCall first), so they touch accounts freely.
|
||||||
|
///
|
||||||
|
/// Trust model matches the admin plane (docs/ADMIN_CONTROLS.md §5): authorization lives on
|
||||||
|
/// the website; the shard trusts the loopback + token socket and a required "actor" field.
|
||||||
|
/// The one shard-side floor on unlink is BridgeAdmin.Protected — a protected staff account is
|
||||||
|
/// never unlinkable from the web. The whole create plane is opt-in via SignupMode /
|
||||||
|
/// AccountCreateEnabled.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgeAccounts
|
||||||
|
{
|
||||||
|
private const string Tag = "WebsiteUserId";
|
||||||
|
|
||||||
|
// Mirrors AccountHandler.m_ForbiddenChars so a website-created name behaves exactly like an
|
||||||
|
// in-game one (AccountHandler.cs). Kept local because that array is private.
|
||||||
|
private static readonly char[] ForbiddenChars =
|
||||||
|
{
|
||||||
|
'<', '>', ':', '"', '/', '\\', '|', '?', '*', ' '
|
||||||
|
};
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
BridgeBoot.RegisterHandler("account.create", OnCreate);
|
||||||
|
BridgeBoot.RegisterHandler("account.unlink", OnUnlink);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- account.create ----
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Creates a game account and links it to the given website user. Refused unless the
|
||||||
|
/// signup mode allows website creation. Enforces the same username/password character
|
||||||
|
/// safety and per-IP cap as ServUO's in-game create path; the password never leaves the
|
||||||
|
/// process in any reply, audit, or log.
|
||||||
|
/// </summary>
|
||||||
|
private static void OnCreate(Dictionary<string, object> o)
|
||||||
|
{
|
||||||
|
var reqId = BridgeJson.GetString(o, "reqId");
|
||||||
|
var actor = BridgeJson.GetString(o, "actor");
|
||||||
|
const string action = "create";
|
||||||
|
|
||||||
|
if (!BridgeConfig.AccountCreateEnabled || BridgeConfig.Signup == SignupMode.Game)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "signups disabled for this mode");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(actor) || actor.Trim().Length == 0)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "missing actor");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var account = BridgeJson.GetString(o, "account");
|
||||||
|
var password = BridgeJson.GetString(o, "password");
|
||||||
|
var webId = BridgeJson.GetString(o, "websiteUserId");
|
||||||
|
var ipStr = BridgeJson.GetString(o, "ip");
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(account))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "missing account");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(password))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "missing password");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(webId))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "missing websiteUserId");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (account.Length > BridgeConfig.AccountNameMaxLength ||
|
||||||
|
password.Length > BridgeConfig.AccountPasswordMaxLength)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "username or password too long");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!IsSafeUsername(account) || !IsSafePassword(password))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "invalid username/password");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collision: the only correct resolution of a website/in-game race for a name.
|
||||||
|
if (Accounts.GetAccount(account) != null)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "account already exists");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Per-IP cap. Fail closed on a missing/loopback IP when RequireIpForCreate — loopback is
|
||||||
|
// exempt in IPLimiter, so accepting it would silently bypass the cap.
|
||||||
|
IPAddress ip;
|
||||||
|
bool haveIp = TryParseIp(ipStr, out ip);
|
||||||
|
|
||||||
|
if (BridgeConfig.RequireIpForCreate && (!haveIp || IPAddress.IsLoopback(ip)))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "client ip required");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (haveIp && !AccountHandler.CanCreate(ip))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "ip account limit reached");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create + link. new Account self-registers (Accounts.Add) and hashes the password per
|
||||||
|
// the shard's ProtectPasswords; LogAccess records the IP and bumps IPTable exactly as an
|
||||||
|
// in-game first-login does; the tag persists on the next world save.
|
||||||
|
var acct = new Account(account, password);
|
||||||
|
|
||||||
|
if (haveIp)
|
||||||
|
acct.LogAccess(ip);
|
||||||
|
|
||||||
|
acct.SetTag(Tag, webId);
|
||||||
|
|
||||||
|
Console.WriteLine("[Bridge][account] web:{0} create {1} websiteUserId={2} ip={3}",
|
||||||
|
actor, account, webId, haveIp ? ip.ToString() : "-");
|
||||||
|
|
||||||
|
BridgeLink.Emit(AuditBegin(action, actor, account)
|
||||||
|
.Str("websiteUserId", webId)
|
||||||
|
.End());
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("account.ok");
|
||||||
|
if (reqId != null) sb.Str("reqId", reqId);
|
||||||
|
sb.Str("action", action).Str("account", account).Str("websiteUserId", webId);
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- account.unlink ----
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Removes the WebsiteUserId tie from an account. Symmetric with the in-game [unlink; the
|
||||||
|
/// Owner floor keeps a protected staff account unreachable from the web.
|
||||||
|
/// </summary>
|
||||||
|
private static void OnUnlink(Dictionary<string, object> o)
|
||||||
|
{
|
||||||
|
var reqId = BridgeJson.GetString(o, "reqId");
|
||||||
|
var actor = BridgeJson.GetString(o, "actor");
|
||||||
|
const string action = "unlink";
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(actor) || actor.Trim().Length == 0)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "missing actor");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var acct = BridgeAdmin.ResolveTargetAccount(o);
|
||||||
|
if (acct == null)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "unknown or accountless target");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (BridgeAdmin.Protected(acct))
|
||||||
|
{
|
||||||
|
Err(reqId, action, "target is protected staff; refused");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var existing = acct.GetTag(Tag);
|
||||||
|
if (existing == null)
|
||||||
|
{
|
||||||
|
Err(reqId, action, "not linked");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
acct.RemoveTag(Tag);
|
||||||
|
|
||||||
|
Console.WriteLine("[Bridge][account] web:{0} unlink {1} (was websiteUserId={2})",
|
||||||
|
actor, acct.Username, existing);
|
||||||
|
|
||||||
|
BridgeLink.Emit(AuditBegin(action, actor, acct.Username)
|
||||||
|
.Str("websiteUserId", existing)
|
||||||
|
.End());
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("account.ok");
|
||||||
|
if (reqId != null) sb.Str("reqId", reqId);
|
||||||
|
sb.Str("action", action).Str("account", acct.Username);
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- helpers ----
|
||||||
|
|
||||||
|
private static void Err(string reqId, string action, string reason)
|
||||||
|
{
|
||||||
|
var sb = BridgeJson.Begin("account.error");
|
||||||
|
if (reqId != null) sb.Str("reqId", reqId);
|
||||||
|
if (action != null) sb.Str("action", action);
|
||||||
|
sb.Str("reason", reason);
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Opens an account.audit frame (origin=web) broadcast to every dashboard, parallel to
|
||||||
|
/// admin.audit. Never carries the password.
|
||||||
|
/// </summary>
|
||||||
|
private static System.Text.StringBuilder AuditBegin(string action, string actor, string target)
|
||||||
|
{
|
||||||
|
return BridgeJson.Begin("account.audit")
|
||||||
|
.Str("origin", "web")
|
||||||
|
.Str("action", action)
|
||||||
|
.Str("actor", "web:" + actor)
|
||||||
|
.Str("target", target);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Mirrors the username safety rules in AccountHandler.CreateAccount.</summary>
|
||||||
|
private static bool IsSafeUsername(string un)
|
||||||
|
{
|
||||||
|
if (un.StartsWith(" ") || un.EndsWith(" ") || un.EndsWith("."))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
for (int i = 0; i < un.Length; i++)
|
||||||
|
{
|
||||||
|
char c = un[i];
|
||||||
|
if (c < 0x20 || c >= 0x7F || IsForbidden(c))
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Mirrors the password safety rules in AccountHandler.CreateAccount.</summary>
|
||||||
|
private static bool IsSafePassword(string pw)
|
||||||
|
{
|
||||||
|
for (int i = 0; i < pw.Length; i++)
|
||||||
|
{
|
||||||
|
char c = pw[i];
|
||||||
|
if (c < 0x20 || c >= 0x7F)
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static bool IsForbidden(char c)
|
||||||
|
{
|
||||||
|
for (int i = 0; i < ForbiddenChars.Length; i++)
|
||||||
|
if (c == ForbiddenChars[i])
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static bool TryParseIp(string s, out IPAddress ip)
|
||||||
|
{
|
||||||
|
ip = null;
|
||||||
|
|
||||||
|
if (String.IsNullOrEmpty(s))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return IPAddress.TryParse(s.Trim(), out ip);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -283,9 +283,10 @@ namespace Server.Custom.Bridge
|
|||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Resolves the command's target account, by "serial" (a player mobile's account) or by
|
/// Resolves the command's target account, by "serial" (a player mobile's account) or by
|
||||||
/// "account" (username). Returns null if neither resolves to a real account.
|
/// "account" (username). Returns null if neither resolves to a real account. Public so the
|
||||||
|
/// account plane (unlink) resolves targets the same way the moderation plane does.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static Account ResolveTargetAccount(Dictionary<string, object> o)
|
public static Account ResolveTargetAccount(Dictionary<string, object> o)
|
||||||
{
|
{
|
||||||
var serialStr = BridgeJson.GetString(o, "serial");
|
var serialStr = BridgeJson.GetString(o, "serial");
|
||||||
if (serialStr != null)
|
if (serialStr != null)
|
||||||
@@ -301,9 +302,10 @@ namespace Server.Custom.Bridge
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// The one shard-side safety floor. Protects any account whose effective access level —
|
/// The one shard-side safety floor. Protects any account whose effective access level —
|
||||||
/// the account's own or the highest of its characters' — is at or above the configured
|
/// the account's own or the highest of its characters' — is at or above the configured
|
||||||
/// floor. Even under CoOwner authority the Owner is never reachable from the web.
|
/// floor. Even under CoOwner authority the Owner is never reachable from the web. Public
|
||||||
|
/// so the account plane (unlink) enforces the identical floor.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static bool Protected(Account acct)
|
public static bool Protected(Account acct)
|
||||||
{
|
{
|
||||||
var lvl = acct.AccessLevel;
|
var lvl = acct.AccessLevel;
|
||||||
|
|
||||||
|
|||||||
@@ -161,6 +161,10 @@ namespace Server.Custom.Bridge
|
|||||||
BridgeSweeps.Rearm();
|
BridgeSweeps.Rearm();
|
||||||
BridgePages.Rearm();
|
BridgePages.Rearm();
|
||||||
BridgeChamps.Rearm();
|
BridgeChamps.Rearm();
|
||||||
|
BridgeSocial.Rearm();
|
||||||
|
BridgeGovernance.Rearm();
|
||||||
|
BridgePresence.Rearm();
|
||||||
|
BridgeHousing.Rearm();
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgeConfig.Describe());
|
e.Mobile.SendMessage("Bridge: {0}", BridgeConfig.Describe());
|
||||||
e.Mobile.SendMessage("Bridge: sweeps re-armed; endpoint changes take effect on reconnect.");
|
e.Mobile.SendMessage("Bridge: sweeps re-armed; endpoint changes take effect on reconnect.");
|
||||||
break;
|
break;
|
||||||
@@ -173,9 +177,17 @@ namespace Server.Custom.Bridge
|
|||||||
case "sweepnow":
|
case "sweepnow":
|
||||||
BridgeSweeps.SweepOnce();
|
BridgeSweeps.SweepOnce();
|
||||||
BridgeChamps.SweepOnce();
|
BridgeChamps.SweepOnce();
|
||||||
|
BridgeSocial.SweepOnce();
|
||||||
|
BridgeGovernance.SweepOnce();
|
||||||
|
BridgePresence.SweepOnce();
|
||||||
|
BridgeHousing.SweepOnce();
|
||||||
e.Mobile.SendMessage("Bridge: ran one sweep of each stream.");
|
e.Mobile.SendMessage("Bridge: ran one sweep of each stream.");
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgeSweeps.Status());
|
e.Mobile.SendMessage("Bridge: {0}", BridgeSweeps.Status());
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgeChamps.Status());
|
e.Mobile.SendMessage("Bridge: {0}", BridgeChamps.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeSocial.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeGovernance.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgePresence.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeHousing.Status());
|
||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -186,6 +198,10 @@ namespace Server.Custom.Bridge
|
|||||||
BridgeLink.Received, BridgeLink.Connects, BridgeLink.WriteErrors);
|
BridgeLink.Received, BridgeLink.Connects, BridgeLink.WriteErrors);
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgeSweeps.Status());
|
e.Mobile.SendMessage("Bridge: {0}", BridgeSweeps.Status());
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgeChamps.Status());
|
e.Mobile.SendMessage("Bridge: {0}", BridgeChamps.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeSocial.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeGovernance.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgePresence.Status());
|
||||||
|
e.Mobile.SendMessage("Bridge: {0}", BridgeHousing.Status());
|
||||||
e.Mobile.SendMessage("Bridge: {0}", BridgePages.Status());
|
e.Mobile.SendMessage("Bridge: {0}", BridgePages.Status());
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,18 @@ using System;
|
|||||||
|
|
||||||
namespace Server.Custom.Bridge
|
namespace Server.Custom.Bridge
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Which side may mint game accounts. Governs the bridge's inbound account.create verb;
|
||||||
|
/// the in-game first-login auto-create is a separate core setting (Accounts.AutoCreateAccounts)
|
||||||
|
/// the operator pairs with this (docs/PROTOCOL_2.md §2).
|
||||||
|
/// </summary>
|
||||||
|
public enum SignupMode
|
||||||
|
{
|
||||||
|
Website, // website is the account authority; in-game auto-create should be off
|
||||||
|
Game, // game server is the authority; account.create is refused
|
||||||
|
Hybrid // either side may create
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Tunables from Config/Bridge.cfg. Key scope is the filename, so `Port=7788` there
|
/// Tunables from Config/Bridge.cfg. Key scope is the filename, so `Port=7788` there
|
||||||
/// reads as "Bridge.Port" here.
|
/// reads as "Bridge.Port" here.
|
||||||
@@ -19,6 +31,10 @@ namespace Server.Custom.Bridge
|
|||||||
public static int EconomySweepSeconds { get; private set; }
|
public static int EconomySweepSeconds { get; private set; }
|
||||||
public static int PageSweepSeconds { get; private set; }
|
public static int PageSweepSeconds { get; private set; }
|
||||||
public static int ChampSweepSeconds { get; private set; }
|
public static int ChampSweepSeconds { get; private set; }
|
||||||
|
public static int GuildSweepSeconds { get; private set; }
|
||||||
|
public static int CitySweepSeconds { get; private set; }
|
||||||
|
public static int PresenceSweepSeconds { get; private set; }
|
||||||
|
public static int HousingSweepSeconds { get; private set; }
|
||||||
|
|
||||||
public static string LinkUrl { get; private set; }
|
public static string LinkUrl { get; private set; }
|
||||||
|
|
||||||
@@ -27,12 +43,25 @@ namespace Server.Custom.Bridge
|
|||||||
public static int TownCrierMaxActive { get; private set; }
|
public static int TownCrierMaxActive { get; private set; }
|
||||||
public static int TownCrierMaxDurationSec { get; private set; }
|
public static int TownCrierMaxDurationSec { get; private set; }
|
||||||
|
|
||||||
|
// Town Cryer news gump (docs/PROTOCOL_2.md §16).
|
||||||
|
public static int NewsMaxTitleLength { get; private set; }
|
||||||
|
public static int NewsMaxBodyLength { get; private set; }
|
||||||
|
public static int NewsMaxExternal { get; private set; }
|
||||||
|
public static int NewsAnnounceDurationSec { get; private set; }
|
||||||
|
|
||||||
public static bool AdminWriteEnabled { get; private set; }
|
public static bool AdminWriteEnabled { get; private set; }
|
||||||
public static AccessLevel AdminAccessFloor { get; private set; }
|
public static AccessLevel AdminAccessFloor { get; private set; }
|
||||||
public static int AdminBroadcastMaxLength { get; private set; }
|
public static int AdminBroadcastMaxLength { get; private set; }
|
||||||
public static int AdminReasonMaxLength { get; private set; }
|
public static int AdminReasonMaxLength { get; private set; }
|
||||||
public static int AdminBanMaxDurationSec { get; private set; }
|
public static int AdminBanMaxDurationSec { get; private set; }
|
||||||
|
|
||||||
|
// ---- account provisioning (docs/PROTOCOL_2.md Part A) ----
|
||||||
|
public static SignupMode Signup { get; private set; }
|
||||||
|
public static bool AccountCreateEnabled { get; private set; }
|
||||||
|
public static bool RequireIpForCreate { get; private set; }
|
||||||
|
public static int AccountNameMaxLength { get; private set; }
|
||||||
|
public static int AccountPasswordMaxLength { get; private set; }
|
||||||
|
|
||||||
public static bool Enabled { get; private set; }
|
public static bool Enabled { get; private set; }
|
||||||
|
|
||||||
public static void Configure()
|
public static void Configure()
|
||||||
@@ -60,6 +89,24 @@ namespace Server.Custom.Bridge
|
|||||||
if (ChampSweepSeconds < 1)
|
if (ChampSweepSeconds < 1)
|
||||||
ChampSweepSeconds = 1;
|
ChampSweepSeconds = 1;
|
||||||
|
|
||||||
|
// Social/political sweeps (docs/PROTOCOL_2.md Part B). Both change slowly, so the
|
||||||
|
// defaults are unhurried; the pass is a handful of field reads over a small set.
|
||||||
|
GuildSweepSeconds = Config.Get("Bridge.GuildSweepSeconds", 60);
|
||||||
|
if (GuildSweepSeconds < 1)
|
||||||
|
GuildSweepSeconds = 1;
|
||||||
|
|
||||||
|
CitySweepSeconds = Config.Get("Bridge.CitySweepSeconds", 300);
|
||||||
|
if (CitySweepSeconds < 1)
|
||||||
|
CitySweepSeconds = 1;
|
||||||
|
|
||||||
|
PresenceSweepSeconds = Config.Get("Bridge.PresenceSweepSeconds", 30);
|
||||||
|
if (PresenceSweepSeconds < 1)
|
||||||
|
PresenceSweepSeconds = 1;
|
||||||
|
|
||||||
|
HousingSweepSeconds = Config.Get("Bridge.HousingSweepSeconds", 300);
|
||||||
|
if (HousingSweepSeconds < 1)
|
||||||
|
HousingSweepSeconds = 1;
|
||||||
|
|
||||||
LinkUrl = Config.Get("Bridge.LinkUrl", "https://yoursite/link");
|
LinkUrl = Config.Get("Bridge.LinkUrl", "https://yoursite/link");
|
||||||
|
|
||||||
TownCrierMaxLines = Config.Get("Bridge.TownCrierMaxLines", 6);
|
TownCrierMaxLines = Config.Get("Bridge.TownCrierMaxLines", 6);
|
||||||
@@ -67,14 +114,77 @@ namespace Server.Custom.Bridge
|
|||||||
TownCrierMaxActive = Config.Get("Bridge.TownCrierMaxActive", 20);
|
TownCrierMaxActive = Config.Get("Bridge.TownCrierMaxActive", 20);
|
||||||
TownCrierMaxDurationSec = Config.Get("Bridge.TownCrierMaxDurationSec", 86400);
|
TownCrierMaxDurationSec = Config.Get("Bridge.TownCrierMaxDurationSec", 86400);
|
||||||
|
|
||||||
|
NewsMaxTitleLength = Config.Get("Bridge.NewsMaxTitleLength", 100);
|
||||||
|
NewsMaxBodyLength = Config.Get("Bridge.NewsMaxBodyLength", 2000);
|
||||||
|
NewsMaxExternal = Config.Get("Bridge.NewsMaxExternal", 20);
|
||||||
|
NewsAnnounceDurationSec = Config.Get("Bridge.NewsAnnounceDurationSec", 300);
|
||||||
|
if (NewsAnnounceDurationSec < 1)
|
||||||
|
NewsAnnounceDurationSec = 1;
|
||||||
|
|
||||||
AdminWriteEnabled = Config.Get("Bridge.AdminWriteEnabled", false);
|
AdminWriteEnabled = Config.Get("Bridge.AdminWriteEnabled", false);
|
||||||
AdminAccessFloor = ParseAccessLevel(Config.Get("Bridge.AdminAccessFloor", "CoOwner"), AccessLevel.CoOwner);
|
AdminAccessFloor = ParseAccessLevel(Config.Get("Bridge.AdminAccessFloor", "CoOwner"), AccessLevel.CoOwner);
|
||||||
AdminBroadcastMaxLength = Config.Get("Bridge.AdminBroadcastMaxLength", 300);
|
AdminBroadcastMaxLength = Config.Get("Bridge.AdminBroadcastMaxLength", 300);
|
||||||
AdminReasonMaxLength = Config.Get("Bridge.AdminReasonMaxLength", 400);
|
AdminReasonMaxLength = Config.Get("Bridge.AdminReasonMaxLength", 400);
|
||||||
AdminBanMaxDurationSec = Config.Get("Bridge.AdminBanMaxDurationSec", 31536000);
|
AdminBanMaxDurationSec = Config.Get("Bridge.AdminBanMaxDurationSec", 31536000);
|
||||||
|
|
||||||
|
// Account provisioning. An absent SignupMode defaults to Hybrid; a *present but
|
||||||
|
// unrecognized* value falls back to Game (the safest — no website creation), so a
|
||||||
|
// typo can never accidentally open provisioning.
|
||||||
|
Signup = ParseSignupMode(Config.Get("Bridge.SignupMode", "hybrid"), SignupMode.Game);
|
||||||
|
// Default follows the mode: creation is on unless the shard is game-authority.
|
||||||
|
AccountCreateEnabled = Config.Get("Bridge.AccountCreateEnabled", Signup != SignupMode.Game);
|
||||||
|
RequireIpForCreate = Config.Get("Bridge.RequireIpForCreate", true);
|
||||||
|
AccountNameMaxLength = Config.Get("Bridge.AccountNameMaxLength", 16);
|
||||||
|
AccountPasswordMaxLength = Config.Get("Bridge.AccountPasswordMaxLength", 30);
|
||||||
|
if (AccountNameMaxLength < 1)
|
||||||
|
AccountNameMaxLength = 1;
|
||||||
|
if (AccountPasswordMaxLength < 1)
|
||||||
|
AccountPasswordMaxLength = 1;
|
||||||
|
|
||||||
if (QueueCap < 16)
|
if (QueueCap < 16)
|
||||||
QueueCap = 16;
|
QueueCap = 16;
|
||||||
|
|
||||||
|
WarnOnSignupMismatch();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The bridge governs only the account.create verb; ServUO's in-game first-login
|
||||||
|
/// auto-create is the core Accounts.AutoCreateAccounts setting. A shard whose two halves
|
||||||
|
/// disagree is quietly broken (website-only that still auto-creates in game, or a mode
|
||||||
|
/// that expects in-game creation with it switched off), so surface the contradiction
|
||||||
|
/// loudly rather than silently doing the permissive thing.
|
||||||
|
/// </summary>
|
||||||
|
private static void WarnOnSignupMismatch()
|
||||||
|
{
|
||||||
|
var autoCreate = Config.Get("Accounts.AutoCreateAccounts", true);
|
||||||
|
|
||||||
|
if (Signup == SignupMode.Website && autoCreate)
|
||||||
|
Console.WriteLine(
|
||||||
|
"[Bridge] WARNING: SignupMode=website but Accounts.AutoCreateAccounts=true; "
|
||||||
|
+ "an in-game login of any new name still mints an account. Set it false for website-only.");
|
||||||
|
else if (Signup == SignupMode.Game && !autoCreate)
|
||||||
|
Console.WriteLine(
|
||||||
|
"[Bridge] WARNING: SignupMode=game but Accounts.AutoCreateAccounts=false; "
|
||||||
|
+ "in-game creation is off and account.create is refused, so no account can be created.");
|
||||||
|
else if (Signup == SignupMode.Hybrid && !autoCreate)
|
||||||
|
Console.WriteLine(
|
||||||
|
"[Bridge] WARNING: SignupMode=hybrid but Accounts.AutoCreateAccounts=false; "
|
||||||
|
+ "in-game first-login creation is off. Only website account.create will work.");
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Parses a SignupMode name, case-insensitively, falling back to <paramref name="fallback"/>
|
||||||
|
/// on anything unrecognized so a typo can never open provisioning wider than intended.
|
||||||
|
/// </summary>
|
||||||
|
private static SignupMode ParseSignupMode(string value, SignupMode fallback)
|
||||||
|
{
|
||||||
|
SignupMode parsed;
|
||||||
|
if (!String.IsNullOrEmpty(value) && Enum.TryParse(value.Trim(), true, out parsed) &&
|
||||||
|
Enum.IsDefined(typeof(SignupMode), parsed))
|
||||||
|
return parsed;
|
||||||
|
|
||||||
|
Console.WriteLine("[Bridge] unrecognized SignupMode '{0}', using {1}", value, fallback);
|
||||||
|
return fallback;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -95,9 +205,9 @@ namespace Server.Custom.Bridge
|
|||||||
public static string Describe()
|
public static string Describe()
|
||||||
{
|
{
|
||||||
return String.Format(
|
return String.Format(
|
||||||
"enabled={0} endpoint={1}:{2} queueCap={3} sweeps(stat={4}s decay={5}s econ={6}s champ={7}s) adminWrite={8}(floor={9})",
|
"enabled={0} endpoint={1}:{2} queueCap={3} sweeps(stat={4}s decay={5}s econ={6}s champ={7}s) adminWrite={8}(floor={9}) signup={10}(create={11})",
|
||||||
Enabled, Host, Port, QueueCap, StatSweepSeconds, DecaySweepSeconds, EconomySweepSeconds,
|
Enabled, Host, Port, QueueCap, StatSweepSeconds, DecaySweepSeconds, EconomySweepSeconds,
|
||||||
ChampSweepSeconds, AdminWriteEnabled, AdminAccessFloor);
|
ChampSweepSeconds, AdminWriteEnabled, AdminAccessFloor, Signup, AccountCreateEnabled);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
175
overlay/Scripts/Custom/Bridge/BridgeGovernance.cs
Normal file
175
overlay/Scripts/Custom/Bridge/BridgeGovernance.cs
Normal file
@@ -0,0 +1,175 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
using Server.Engines.CityLoyalty;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The town-governor stream (docs/PROTOCOL_2.md §10.2). In modern ServUO the "mayor of a
|
||||||
|
/// town" is the Governor in the City Loyalty System (King Blackthorn's governance): each of
|
||||||
|
/// the governed cities has a Governor, a GovernorElect, and an Election. None of these raises
|
||||||
|
/// an EventSink, so — like <see cref="BridgeChamps"/> and <see cref="BridgeSocial"/> — the set
|
||||||
|
/// is polled and each city emits `city.update` only when its signature changes. Governors turn
|
||||||
|
/// over on the order of weeks, so a slow sweep (default 5 min) is ample.
|
||||||
|
///
|
||||||
|
/// The wire model is uniform with the rest of Part B: a full-state `city.update` upsert, with
|
||||||
|
/// "the governor changed" derived sidecar-side by comparing to the stored board — rather than a
|
||||||
|
/// discrete from→to event, which a sidecar reconnect (cache cleared, full re-emit) would
|
||||||
|
/// otherwise fire spuriously for every city.
|
||||||
|
///
|
||||||
|
/// Gated on CityLoyaltySystem.Enabled: a shard running its own town system emits nothing here.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgeGovernance
|
||||||
|
{
|
||||||
|
private static Timer _timer;
|
||||||
|
|
||||||
|
// City enum value -> last-emitted signature.
|
||||||
|
private static readonly Dictionary<int, string> _last = new Dictionary<int, string>();
|
||||||
|
|
||||||
|
private static long _sweeps, _emitted;
|
||||||
|
private static bool _warnedDisabled;
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
EventSink.ServerStarted += OnServerStarted;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnServerStarted()
|
||||||
|
{
|
||||||
|
BridgeLink.Connected_Core += OnConnected;
|
||||||
|
Rearm();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnConnected()
|
||||||
|
{
|
||||||
|
_last.Clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Stops and recreates the timer from current config. Called by `[bridge reload`.</summary>
|
||||||
|
public static void Rearm()
|
||||||
|
{
|
||||||
|
Stop();
|
||||||
|
|
||||||
|
_timer = Timer.DelayCall(
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.CitySweepSeconds),
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.CitySweepSeconds),
|
||||||
|
CitySweep);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void Stop()
|
||||||
|
{
|
||||||
|
if (_timer != null) { _timer.Stop(); _timer = null; }
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string Status()
|
||||||
|
{
|
||||||
|
return String.Format("cities(enabled={0} sweeps={1} emitted={2} tracked={3})",
|
||||||
|
CityLoyaltySystem.Enabled, _sweeps, _emitted, _last.Count);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Runs one sweep now. Wired into `[bridge sweepnow`.</summary>
|
||||||
|
public static void SweepOnce()
|
||||||
|
{
|
||||||
|
CitySweep();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void CitySweep()
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
_sweeps++;
|
||||||
|
|
||||||
|
if (!CityLoyaltySystem.Enabled || CityLoyaltySystem.Cities == null)
|
||||||
|
{
|
||||||
|
if (!_warnedDisabled)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] city loyalty disabled; governor stream idle.");
|
||||||
|
_warnedDisabled = true;
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!BridgeLink.Connected)
|
||||||
|
return; // nothing is listening; do not fill the queue with perishable snapshots
|
||||||
|
|
||||||
|
foreach (var city in CityLoyaltySystem.Cities)
|
||||||
|
{
|
||||||
|
if (city == null)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
var sig = Signature(city);
|
||||||
|
|
||||||
|
int key = (int)city.City;
|
||||||
|
|
||||||
|
string prior;
|
||||||
|
if (_last.TryGetValue(key, out prior) && prior == sig)
|
||||||
|
continue; // unchanged since last emit
|
||||||
|
|
||||||
|
_last[key] = sig;
|
||||||
|
BridgeLink.Emit(WriteCity(city));
|
||||||
|
_emitted++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] city sweep threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The volatile fields: governor, governor-elect, and the election phase / candidate count.
|
||||||
|
private static string Signature(CityLoyaltySystem city)
|
||||||
|
{
|
||||||
|
var gov = city.Governor == null ? 0 : city.Governor.Serial.Value;
|
||||||
|
var elect = city.GovernorElect == null ? 0 : city.GovernorElect.Serial.Value;
|
||||||
|
|
||||||
|
var e = city.Election;
|
||||||
|
var phase = ElectionPhase(e);
|
||||||
|
var candidates = (e == null || e.Candidates == null) ? 0 : e.Candidates.Count;
|
||||||
|
|
||||||
|
return String.Concat(
|
||||||
|
gov.ToString(), "|", elect.ToString(), "|", phase, "|", candidates.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string WriteCity(CityLoyaltySystem city)
|
||||||
|
{
|
||||||
|
var e = city.Election;
|
||||||
|
var phase = ElectionPhase(e);
|
||||||
|
var candidates = (e == null || e.Candidates == null) ? 0 : e.Candidates.Count;
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("city.update")
|
||||||
|
.Str("city", city.City.ToString())
|
||||||
|
.Str("electionPhase", phase)
|
||||||
|
.Num("candidates", candidates);
|
||||||
|
|
||||||
|
sb.Actor("governor", city.Governor);
|
||||||
|
sb.Actor("governorElect", city.GovernorElect);
|
||||||
|
|
||||||
|
if (e != null && e.Ongoing)
|
||||||
|
sb.Str("autoPickAt", e.AutoPickGovernor.ToUniversalTime().ToString("o"));
|
||||||
|
|
||||||
|
return sb.End();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Folds the election state into one of: none / nominate / vote / pending.</summary>
|
||||||
|
private static string ElectionPhase(CityElection e)
|
||||||
|
{
|
||||||
|
if (e == null)
|
||||||
|
return "none";
|
||||||
|
|
||||||
|
if (e.CanNominate())
|
||||||
|
return "nominate";
|
||||||
|
|
||||||
|
if (e.CanVote())
|
||||||
|
return "vote";
|
||||||
|
|
||||||
|
if (e.Ongoing)
|
||||||
|
return "pending";
|
||||||
|
|
||||||
|
return "none";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
165
overlay/Scripts/Custom/Bridge/BridgeHousing.cs
Normal file
165
overlay/Scripts/Custom/Bridge/BridgeHousing.cs
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
|
||||||
|
using Server.Multis;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The housing registry (docs/PROTOCOL_2.md §11 #9). BridgeSweeps already emits house.decay
|
||||||
|
/// *transitions*; this is the complementary *board*: one row per house with owner, location,
|
||||||
|
/// region, co-owners, value, and current decay level, so the website can render an owner→houses
|
||||||
|
/// map. Like the other Part B boards it is a diff sweep over BaseHouse.AllHouses — emit
|
||||||
|
/// house.update only when a house's signature changes, and house.remove when a house is gone.
|
||||||
|
///
|
||||||
|
/// Note: stock ServUO has no "for sale" flag on a house (houses are traded, not listed), so the
|
||||||
|
/// registry is owner→houses; `price` is the house's placement value, not a sale listing.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgeHousing
|
||||||
|
{
|
||||||
|
private static Timer _timer;
|
||||||
|
|
||||||
|
// house serial -> last-emitted signature.
|
||||||
|
private static readonly Dictionary<Serial, string> _last = new Dictionary<Serial, string>();
|
||||||
|
|
||||||
|
private static long _sweeps, _emitted, _removed;
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
EventSink.ServerStarted += OnServerStarted;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnServerStarted()
|
||||||
|
{
|
||||||
|
BridgeLink.Connected_Core += OnConnected;
|
||||||
|
Rearm();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnConnected()
|
||||||
|
{
|
||||||
|
_last.Clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Stops and recreates the timer from current config. Called by `[bridge reload`.</summary>
|
||||||
|
public static void Rearm()
|
||||||
|
{
|
||||||
|
Stop();
|
||||||
|
|
||||||
|
_timer = Timer.DelayCall(
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.HousingSweepSeconds),
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.HousingSweepSeconds),
|
||||||
|
HouseSweep);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void Stop()
|
||||||
|
{
|
||||||
|
if (_timer != null) { _timer.Stop(); _timer = null; }
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string Status()
|
||||||
|
{
|
||||||
|
return String.Format("housing(sweeps={0} emitted={1} removed={2} tracked={3})",
|
||||||
|
_sweeps, _emitted, _removed, _last.Count);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Runs one sweep now. Wired into `[bridge sweepnow`.</summary>
|
||||||
|
public static void SweepOnce()
|
||||||
|
{
|
||||||
|
HouseSweep();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void HouseSweep()
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
_sweeps++;
|
||||||
|
|
||||||
|
if (!BridgeLink.Connected)
|
||||||
|
return; // nothing is listening; do not fill the queue with perishable snapshots
|
||||||
|
|
||||||
|
var seen = new HashSet<Serial>();
|
||||||
|
|
||||||
|
foreach (var house in BaseHouse.AllHouses)
|
||||||
|
{
|
||||||
|
if (house == null || house.Deleted)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
seen.Add(house.Serial);
|
||||||
|
|
||||||
|
var level = house.DecayLevel; // computed getter — read once
|
||||||
|
var sig = Signature(house, level);
|
||||||
|
|
||||||
|
string prior;
|
||||||
|
if (_last.TryGetValue(house.Serial, out prior) && prior == sig)
|
||||||
|
continue; // unchanged since last emit
|
||||||
|
|
||||||
|
_last[house.Serial] = sig;
|
||||||
|
BridgeLink.Emit(WriteHouse(house, level));
|
||||||
|
_emitted++;
|
||||||
|
}
|
||||||
|
|
||||||
|
var gone = _last.Keys.Where(k => !seen.Contains(k)).ToList();
|
||||||
|
foreach (var serial in gone)
|
||||||
|
{
|
||||||
|
_last.Remove(serial);
|
||||||
|
BridgeLink.Emit(BridgeJson.Begin("house.remove").Ser("serial", serial).End());
|
||||||
|
_removed++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] housing sweep threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string Signature(BaseHouse house, DecayLevel level)
|
||||||
|
{
|
||||||
|
var ownerSerial = house.Owner == null ? 0 : house.Owner.Serial.Value;
|
||||||
|
var region = house.Region;
|
||||||
|
var regionName = region == null ? "" : (region.Name ?? "");
|
||||||
|
var sign = house.Sign;
|
||||||
|
var name = sign == null ? "" : (sign.GetName() ?? "");
|
||||||
|
var coOwners = house.CoOwners == null ? 0 : house.CoOwners.Count;
|
||||||
|
|
||||||
|
return String.Concat(
|
||||||
|
ownerSerial.ToString(), "|",
|
||||||
|
level.ToString(), "|",
|
||||||
|
regionName, "|",
|
||||||
|
name, "|",
|
||||||
|
coOwners.ToString(), "|",
|
||||||
|
house.Price.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string WriteHouse(BaseHouse house, DecayLevel level)
|
||||||
|
{
|
||||||
|
var sb = BridgeJson.Begin("house.update")
|
||||||
|
.Ser("serial", house.Serial)
|
||||||
|
.Str("decay", level.ToString())
|
||||||
|
.Num("price", house.Price)
|
||||||
|
.Str("map", house.Map == null ? null : house.Map.Name)
|
||||||
|
.Num("x", house.X).Num("y", house.Y).Num("z", house.Z);
|
||||||
|
|
||||||
|
var sign = house.Sign;
|
||||||
|
if (sign != null)
|
||||||
|
sb.Str("name", sign.GetName());
|
||||||
|
|
||||||
|
var region = house.Region;
|
||||||
|
if (region != null)
|
||||||
|
sb.Str("region", region.Name);
|
||||||
|
|
||||||
|
sb.Actor("owner", house.Owner);
|
||||||
|
|
||||||
|
sb.Num("coOwners", house.CoOwners == null ? 0 : house.CoOwners.Count);
|
||||||
|
sb.Num("friends", house.Friends == null ? 0 : house.Friends.Count);
|
||||||
|
|
||||||
|
sb.Str("builtOn", house.BuiltOn.ToUniversalTime().ToString("o"));
|
||||||
|
sb.Str("lastRefreshed", house.LastRefreshed.ToUniversalTime().ToString("o"));
|
||||||
|
|
||||||
|
return sb.End();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -76,6 +76,46 @@ namespace Server.Custom.Bridge
|
|||||||
return sb;
|
return sb;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Writes a nested actor object: serial, name, account (when there is one), the linked
|
||||||
|
/// webId (when the account is linked), and the player flag. A `null` mobile writes null.
|
||||||
|
/// The richer counterpart to BridgeEvents' internal writer, used by the Part B streams so a
|
||||||
|
/// guild leader / joiner / governor can be attributed to a site user without a lookup.
|
||||||
|
/// </summary>
|
||||||
|
public static StringBuilder Actor(this StringBuilder sb, string name, Mobile m)
|
||||||
|
{
|
||||||
|
sb.Append(",\"").Append(name).Append("\":");
|
||||||
|
|
||||||
|
if (m == null)
|
||||||
|
{
|
||||||
|
sb.Append("null");
|
||||||
|
return sb;
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.Append("{\"serial\":\"0x").Append(m.Serial.Value.ToString("X")).Append('"');
|
||||||
|
|
||||||
|
sb.Append(",\"name\":");
|
||||||
|
Escape(sb, m.Name ?? "");
|
||||||
|
|
||||||
|
var acct = m.Account as Accounting.Account;
|
||||||
|
if (acct != null)
|
||||||
|
{
|
||||||
|
sb.Append(",\"acct\":");
|
||||||
|
Escape(sb, acct.Username);
|
||||||
|
|
||||||
|
var webId = BridgeAccountLink.WebIdFor(acct);
|
||||||
|
if (webId != null)
|
||||||
|
{
|
||||||
|
sb.Append(",\"webId\":");
|
||||||
|
Escape(sb, webId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.Append(",\"player\":").Append(m.Player ? "true" : "false");
|
||||||
|
sb.Append('}');
|
||||||
|
return sb;
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>Closes the object. The trailing newline is the frame delimiter.</summary>
|
/// <summary>Closes the object. The trailing newline is the frame delimiter.</summary>
|
||||||
public static string End(this StringBuilder sb)
|
public static string End(this StringBuilder sb)
|
||||||
{
|
{
|
||||||
|
|||||||
176
overlay/Scripts/Custom/Bridge/BridgeNews.cs
Normal file
176
overlay/Scripts/Custom/Bridge/BridgeNews.cs
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
using Server.Mobiles;
|
||||||
|
using Server.Services.TownCryer;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Website news articles pushed into the modern Town Cryer News gump
|
||||||
|
/// (docs/PROTOCOL_2.md §16). Distinct from BridgeTownCrier, which drives the scrolling-crier
|
||||||
|
/// announcement lines (GlobalTownCrierEntryList). Here the full article — title, body (HTML),
|
||||||
|
/// image, and a "more info" URL — becomes a TownCryerNewsEntry in TownCryerSystem.NewsEntries,
|
||||||
|
/// which the stock news gumps already render (they branch on TextDefinition.Number, so string
|
||||||
|
/// content needs no gump change).
|
||||||
|
///
|
||||||
|
/// No stock edit: NewsEntries is a public mutable list, so we insert/remove directly and keep
|
||||||
|
/// our own id -> entry map, leaving the stock entries untouched. On add we also proclaim just
|
||||||
|
/// the title through the existing crier say path (default on), so players hear it in-world.
|
||||||
|
///
|
||||||
|
/// Everything runs on the Core thread (inbound lines are marshaled through Timer.DelayCall),
|
||||||
|
/// which is required to touch the shared news list and to send crier packets.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgeNews
|
||||||
|
{
|
||||||
|
// A neutral scroll gump when the website supplies no image.
|
||||||
|
private const int DefaultImage = 0x64E;
|
||||||
|
|
||||||
|
// Website id -> the news entry we created for it, so a later remove/replace can find it.
|
||||||
|
private static readonly Dictionary<string, TownCryerNewsEntry> _ours =
|
||||||
|
new Dictionary<string, TownCryerNewsEntry>(StringComparer.Ordinal);
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
BridgeBoot.RegisterHandler("news.add", OnAdd);
|
||||||
|
BridgeBoot.RegisterHandler("news.remove", OnRemove);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnAdd(Dictionary<string, object> o)
|
||||||
|
{
|
||||||
|
var id = BridgeJson.GetString(o, "id");
|
||||||
|
|
||||||
|
if (id == null)
|
||||||
|
{
|
||||||
|
Reply("news.error", null, "missing id");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var list = TownCryerSystem.NewsEntries;
|
||||||
|
if (list == null)
|
||||||
|
{
|
||||||
|
Reply("news.error", id, "town cryer unavailable");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var title = BridgeJson.GetString(o, "title");
|
||||||
|
if (String.IsNullOrEmpty(title))
|
||||||
|
{
|
||||||
|
Reply("news.error", id, "missing title");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var body = BridgeJson.GetString(o, "body") ?? "";
|
||||||
|
var url = BridgeJson.GetString(o, "url");
|
||||||
|
int image = BridgeJson.GetInt(o, "image", DefaultImage);
|
||||||
|
|
||||||
|
// announce defaults to true (proclaim the title in-world); "announce":false suppresses it.
|
||||||
|
bool announce = true;
|
||||||
|
object rawAnnounce;
|
||||||
|
if (o.TryGetValue("announce", out rawAnnounce) && rawAnnounce is bool)
|
||||||
|
announce = (bool)rawAnnounce;
|
||||||
|
|
||||||
|
if (title.Length > BridgeConfig.NewsMaxTitleLength)
|
||||||
|
title = title.Substring(0, BridgeConfig.NewsMaxTitleLength);
|
||||||
|
if (body.Length > BridgeConfig.NewsMaxBodyLength)
|
||||||
|
body = body.Substring(0, BridgeConfig.NewsMaxBodyLength);
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// Replace an existing id in place: drop the old entry first.
|
||||||
|
TownCryerNewsEntry old;
|
||||||
|
if (_ours.TryGetValue(id, out old) && old != null)
|
||||||
|
{
|
||||||
|
list.Remove(old);
|
||||||
|
_ours.Remove(id);
|
||||||
|
}
|
||||||
|
else if (_ours.Count >= BridgeConfig.NewsMaxExternal)
|
||||||
|
{
|
||||||
|
Reply("news.error", id, "too many news entries");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var entry = new TownCryerNewsEntry(
|
||||||
|
new TextDefinition(title),
|
||||||
|
new TextDefinition(body),
|
||||||
|
image,
|
||||||
|
null,
|
||||||
|
url);
|
||||||
|
|
||||||
|
list.Insert(0, entry); // newest first, as the gump reads top-down
|
||||||
|
_ours[id] = entry;
|
||||||
|
|
||||||
|
if (announce)
|
||||||
|
Announce(title);
|
||||||
|
|
||||||
|
Reply("news.ok", id, null);
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] news.add threw: {0}", ex.Message);
|
||||||
|
Reply("news.error", id, "internal error");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnRemove(Dictionary<string, object> o)
|
||||||
|
{
|
||||||
|
var id = BridgeJson.GetString(o, "id");
|
||||||
|
|
||||||
|
if (id == null)
|
||||||
|
{
|
||||||
|
Reply("news.error", null, "missing id");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
TownCryerNewsEntry entry;
|
||||||
|
if (!_ours.TryGetValue(id, out entry))
|
||||||
|
{
|
||||||
|
Reply("news.error", id, "unknown id");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
_ours.Remove(id);
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
var list = TownCryerSystem.NewsEntries;
|
||||||
|
if (list != null && entry != null)
|
||||||
|
list.Remove(entry);
|
||||||
|
|
||||||
|
Reply("news.ok", id, null);
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] news.remove threw: {0}", ex.Message);
|
||||||
|
Reply("news.error", id, "internal error");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Proclaims a single line — the article title — through the town criers.</summary>
|
||||||
|
private static void Announce(string title)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
GlobalTownCrierEntryList.Instance.AddEntry(
|
||||||
|
new[] { title },
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.NewsAnnounceDurationSec));
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
// A failed proclamation must not fail the news add — the article is already posted.
|
||||||
|
Console.WriteLine("[Bridge] news announce threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void Reply(string kind, string id, string reason)
|
||||||
|
{
|
||||||
|
var sb = BridgeJson.Begin(kind);
|
||||||
|
if (id != null) sb.Str("id", id);
|
||||||
|
if (reason != null) sb.Str("reason", reason);
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
203
overlay/Scripts/Custom/Bridge/BridgePresence.cs
Normal file
203
overlay/Scripts/Custom/Bridge/BridgePresence.cs
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
using Server.Mobiles;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The presence stream (docs/PROTOCOL_2.md §11 #1/#2): who is online and where. Two parts:
|
||||||
|
///
|
||||||
|
/// presence.online - a periodic population snapshot (total, per-facet, per-region), emitted
|
||||||
|
/// on a sweep but only when it changes, so the site has a live "N online"
|
||||||
|
/// plus a change history without a firehose of identical frames.
|
||||||
|
/// region.enter - a real-time location transition from EventSink.OnEnterRegion, the cheap
|
||||||
|
/// per-player movement signal PLAN.md §5.6 recommends over Movement.
|
||||||
|
///
|
||||||
|
/// The snapshot is derived each sweep from the online PlayerMobiles (NetState != null), the
|
||||||
|
/// same population the vitals sweep already walks; counting them by map and region is a handful
|
||||||
|
/// of field reads. region.enter is filtered to players.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgePresence
|
||||||
|
{
|
||||||
|
private static Timer _timer;
|
||||||
|
|
||||||
|
// Signature of the last-emitted snapshot, so an unchanged population emits nothing.
|
||||||
|
private static string _lastSig;
|
||||||
|
|
||||||
|
private static long _sweeps, _emitted, _regionEnters;
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
EventSink.OnEnterRegion += OnEnterRegion;
|
||||||
|
EventSink.ServerStarted += OnServerStarted;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnServerStarted()
|
||||||
|
{
|
||||||
|
// Force the next sweep to emit after a (re)connect, so a sidecar that restarted gets the
|
||||||
|
// current population within one sweep.
|
||||||
|
BridgeLink.Connected_Core += OnConnected;
|
||||||
|
Rearm();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnConnected()
|
||||||
|
{
|
||||||
|
_lastSig = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Stops and recreates the timer from current config. Called by `[bridge reload`.</summary>
|
||||||
|
public static void Rearm()
|
||||||
|
{
|
||||||
|
Stop();
|
||||||
|
|
||||||
|
_timer = Timer.DelayCall(
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.PresenceSweepSeconds),
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.PresenceSweepSeconds),
|
||||||
|
PresenceSweep);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void Stop()
|
||||||
|
{
|
||||||
|
if (_timer != null) { _timer.Stop(); _timer = null; }
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string Status()
|
||||||
|
{
|
||||||
|
return String.Format("presence(sweeps={0} emitted={1} regionEnters={2})",
|
||||||
|
_sweeps, _emitted, _regionEnters);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Runs one sweep now. Wired into `[bridge sweepnow`.</summary>
|
||||||
|
public static void SweepOnce()
|
||||||
|
{
|
||||||
|
PresenceSweep();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void PresenceSweep()
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
_sweeps++;
|
||||||
|
|
||||||
|
if (!BridgeLink.Connected)
|
||||||
|
return; // nothing is listening; do not fill the queue with perishable snapshots
|
||||||
|
|
||||||
|
int total = 0;
|
||||||
|
var byFacet = new SortedDictionary<string, int>(StringComparer.Ordinal);
|
||||||
|
var byRegion = new SortedDictionary<string, int>(StringComparer.Ordinal);
|
||||||
|
|
||||||
|
foreach (var m in World.Mobiles.Values)
|
||||||
|
{
|
||||||
|
var pm = m as PlayerMobile;
|
||||||
|
|
||||||
|
if (pm == null || pm.NetState == null || pm.Deleted)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
total++;
|
||||||
|
|
||||||
|
var facet = pm.Map == null ? "Internal" : pm.Map.Name;
|
||||||
|
Bump(byFacet, facet);
|
||||||
|
|
||||||
|
var region = pm.Region;
|
||||||
|
var regionName = (region == null || String.IsNullOrEmpty(region.Name)) ? "Wilderness" : region.Name;
|
||||||
|
Bump(byRegion, regionName);
|
||||||
|
}
|
||||||
|
|
||||||
|
var sig = Signature(total, byFacet, byRegion);
|
||||||
|
if (sig == _lastSig)
|
||||||
|
return; // population unchanged since last emit
|
||||||
|
|
||||||
|
_lastSig = sig;
|
||||||
|
BridgeLink.Emit(WriteOnline(total, byFacet, byRegion));
|
||||||
|
_emitted++;
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] presence sweep threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void Bump(IDictionary<string, int> map, string key)
|
||||||
|
{
|
||||||
|
int n;
|
||||||
|
map[key] = map.TryGetValue(key, out n) ? n + 1 : 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string Signature(int total, SortedDictionary<string, int> byFacet, SortedDictionary<string, int> byRegion)
|
||||||
|
{
|
||||||
|
var sb = new System.Text.StringBuilder();
|
||||||
|
sb.Append(total);
|
||||||
|
foreach (var kv in byFacet) sb.Append('|').Append(kv.Key).Append(':').Append(kv.Value);
|
||||||
|
sb.Append('#');
|
||||||
|
foreach (var kv in byRegion) sb.Append('|').Append(kv.Key).Append(':').Append(kv.Value);
|
||||||
|
return sb.ToString();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string WriteOnline(int total, SortedDictionary<string, int> byFacet, SortedDictionary<string, int> byRegion)
|
||||||
|
{
|
||||||
|
var sb = BridgeJson.Begin("presence.online").Num("count", total);
|
||||||
|
|
||||||
|
WriteCounts(sb, "byFacet", byFacet);
|
||||||
|
WriteCounts(sb, "byRegion", byRegion);
|
||||||
|
|
||||||
|
return sb.End();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Writes a nested object of {name: count} pairs.</summary>
|
||||||
|
private static void WriteCounts(System.Text.StringBuilder sb, string field, SortedDictionary<string, int> counts)
|
||||||
|
{
|
||||||
|
sb.Append(",\"").Append(field).Append("\":{");
|
||||||
|
|
||||||
|
bool first = true;
|
||||||
|
foreach (var kv in counts)
|
||||||
|
{
|
||||||
|
if (!first)
|
||||||
|
sb.Append(',');
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
BridgeJson.Escape(sb, kv.Key);
|
||||||
|
sb.Append(':').Append(kv.Value);
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.Append('}');
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- real-time region transitions ----
|
||||||
|
|
||||||
|
private static void OnEnterRegion(OnEnterRegionEventArgs e)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
if (e == null || e.From == null || !e.From.Player)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var from = e.OldRegion;
|
||||||
|
var to = e.NewRegion;
|
||||||
|
|
||||||
|
// Only meaningful when the named region actually changed.
|
||||||
|
var fromName = from == null ? null : from.Name;
|
||||||
|
var toName = to == null ? null : to.Name;
|
||||||
|
if (String.Equals(fromName, toName, StringComparison.Ordinal))
|
||||||
|
return;
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("region.enter")
|
||||||
|
.Str("from", fromName)
|
||||||
|
.Str("to", toName)
|
||||||
|
.Str("map", e.From.Map == null ? null : e.From.Map.Name);
|
||||||
|
|
||||||
|
sb.Actor("who", e.From);
|
||||||
|
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
_regionEnters++;
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] region enter handler threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -98,9 +98,55 @@ namespace Server.Custom.Bridge
|
|||||||
}
|
}
|
||||||
sb.Append(']');
|
sb.Append(']');
|
||||||
|
|
||||||
|
WriteTitles(sb, m);
|
||||||
|
|
||||||
return sb.End();
|
return sb.End();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The titles a character holds (docs/PROTOCOL_2.md §10.3). `selected` is the index into
|
||||||
|
/// `reward` currently displayed (-1 if none). `fameKarma` and `skill` are the computed
|
||||||
|
/// display titles (may be absent). `reward` is the raw reward-title list — an entry may be
|
||||||
|
/// a cliloc number (as a string) or a literal string; resolve clilocs website-side.
|
||||||
|
/// </summary>
|
||||||
|
private static void WriteTitles(StringBuilder sb, PlayerMobile m)
|
||||||
|
{
|
||||||
|
sb.Append(",\"titles\":{\"selected\":").Append(m.SelectedTitle);
|
||||||
|
|
||||||
|
var fameKarma = m.FameKarmaTitle;
|
||||||
|
if (!String.IsNullOrEmpty(fameKarma))
|
||||||
|
{
|
||||||
|
sb.Append(",\"fameKarma\":");
|
||||||
|
BridgeJson.Escape(sb, fameKarma);
|
||||||
|
}
|
||||||
|
|
||||||
|
var skill = m.PaperdollSkillTitle;
|
||||||
|
if (!String.IsNullOrEmpty(skill))
|
||||||
|
{
|
||||||
|
sb.Append(",\"skill\":");
|
||||||
|
BridgeJson.Escape(sb, skill);
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.Append(",\"reward\":[");
|
||||||
|
var rewards = m.RewardTitles;
|
||||||
|
if (rewards != null)
|
||||||
|
{
|
||||||
|
bool first = true;
|
||||||
|
for (int i = 0; i < rewards.Count; i++)
|
||||||
|
{
|
||||||
|
var r = rewards[i];
|
||||||
|
if (r == null)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
if (!first) sb.Append(',');
|
||||||
|
first = false;
|
||||||
|
|
||||||
|
BridgeJson.Escape(sb, Convert.ToString(r, System.Globalization.CultureInfo.InvariantCulture));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sb.Append("]}");
|
||||||
|
}
|
||||||
|
|
||||||
private static bool IsGearLayer(Layer layer)
|
private static bool IsGearLayer(Layer layer)
|
||||||
{
|
{
|
||||||
switch (layer)
|
switch (layer)
|
||||||
|
|||||||
218
overlay/Scripts/Custom/Bridge/BridgeSocial.cs
Normal file
218
overlay/Scripts/Custom/Bridge/BridgeSocial.cs
Normal file
@@ -0,0 +1,218 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
|
||||||
|
using Server.Guilds;
|
||||||
|
|
||||||
|
namespace Server.Custom.Bridge
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// The guild stream (docs/PROTOCOL_2.md §10.1). Guilds have almost no useful EventSink:
|
||||||
|
/// EventSink.CreateGuild is only the load-time deserialization factory (Server/World.cs), and
|
||||||
|
/// leave/disband/leader/alliance changes raise nothing. Only EventSink.JoinGuild is real. So,
|
||||||
|
/// exactly like <see cref="BridgeChamps"/>, the roster is polled: enumerate BaseGuild.List each
|
||||||
|
/// tick, fold each guild to a small signature, and emit `guild.update` only when it changes.
|
||||||
|
/// A guild that vanishes (or disbands — Disbanded == leader gone) leaves via `guild.remove`.
|
||||||
|
///
|
||||||
|
/// On top of the board we emit a real-time `guild.join` from EventSink.JoinGuild, so a "so-and-
|
||||||
|
/// so joined" feed does not wait for the next sweep. A membership change also moves the board
|
||||||
|
/// signature (member count + serial sum), so a *leave* surfaces as the member count dropping in
|
||||||
|
/// the next `guild.update`; per-member leave events would need a core tap and are a later
|
||||||
|
/// refinement (§10.1).
|
||||||
|
///
|
||||||
|
/// "Created" is derived sidecar-side from a first-seen id (as champs derive it), rather than a
|
||||||
|
/// wire event — otherwise a sidecar reconnect, which clears the diff cache and re-emits every
|
||||||
|
/// guild, would look like every guild being created at once.
|
||||||
|
/// </summary>
|
||||||
|
public static class BridgeSocial
|
||||||
|
{
|
||||||
|
private static Timer _timer;
|
||||||
|
|
||||||
|
// guild id -> last-emitted signature. An id absent here has never been emitted (or the cache
|
||||||
|
// was cleared on reconnect), so its next sweep counts as a change.
|
||||||
|
private static readonly Dictionary<int, string> _last = new Dictionary<int, string>();
|
||||||
|
|
||||||
|
private static long _sweeps, _emitted, _removed, _joins;
|
||||||
|
|
||||||
|
public static void Initialize()
|
||||||
|
{
|
||||||
|
if (!BridgeConfig.Enabled)
|
||||||
|
return;
|
||||||
|
|
||||||
|
EventSink.JoinGuild += OnJoinGuild;
|
||||||
|
EventSink.ServerStarted += OnServerStarted;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnServerStarted()
|
||||||
|
{
|
||||||
|
BridgeLink.Connected_Core += OnConnected;
|
||||||
|
Rearm();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void OnConnected()
|
||||||
|
{
|
||||||
|
_last.Clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Stops and recreates the timer from current config. Called by `[bridge reload`.</summary>
|
||||||
|
public static void Rearm()
|
||||||
|
{
|
||||||
|
Stop();
|
||||||
|
|
||||||
|
_timer = Timer.DelayCall(
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.GuildSweepSeconds),
|
||||||
|
TimeSpan.FromSeconds(BridgeConfig.GuildSweepSeconds),
|
||||||
|
GuildSweep);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void Stop()
|
||||||
|
{
|
||||||
|
if (_timer != null) { _timer.Stop(); _timer = null; }
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string Status()
|
||||||
|
{
|
||||||
|
return String.Format("guilds(sweeps={0} emitted={1} removed={2} joins={3} tracked={4})",
|
||||||
|
_sweeps, _emitted, _removed, _joins, _last.Count);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>Runs one sweep now. Wired into `[bridge sweepnow`.</summary>
|
||||||
|
public static void SweepOnce()
|
||||||
|
{
|
||||||
|
GuildSweep();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void GuildSweep()
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
_sweeps++;
|
||||||
|
|
||||||
|
if (!BridgeLink.Connected)
|
||||||
|
return; // nothing is listening; do not fill the queue with perishable snapshots
|
||||||
|
|
||||||
|
var seen = new HashSet<int>();
|
||||||
|
|
||||||
|
foreach (var bg in BaseGuild.List.Values)
|
||||||
|
{
|
||||||
|
var g = bg as Guild;
|
||||||
|
|
||||||
|
// Skip disbanded guilds (leader gone): they linger in the list until cleaned up,
|
||||||
|
// and treating them as absent lets the "gone" pass below emit guild.remove.
|
||||||
|
if (g == null || g.Disbanded)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
seen.Add(g.Id);
|
||||||
|
|
||||||
|
var sig = Signature(g);
|
||||||
|
|
||||||
|
string prior;
|
||||||
|
if (_last.TryGetValue(g.Id, out prior) && prior == sig)
|
||||||
|
continue; // unchanged since last emit
|
||||||
|
|
||||||
|
_last[g.Id] = sig;
|
||||||
|
BridgeLink.Emit(WriteGuild(g));
|
||||||
|
_emitted++;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Anything tracked last sweep but not seen now has disbanded or been removed.
|
||||||
|
var gone = _last.Keys.Where(k => !seen.Contains(k)).ToList();
|
||||||
|
foreach (var id in gone)
|
||||||
|
{
|
||||||
|
_last.Remove(id);
|
||||||
|
BridgeLink.Emit(BridgeJson.Begin("guild.remove").Num("id", id).End());
|
||||||
|
_removed++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] guild sweep threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The volatile fields that define a meaningful change: name, abbreviation, leader, member
|
||||||
|
// count, the member set (order-independent serial sum), and alliance.
|
||||||
|
private static string Signature(Guild g)
|
||||||
|
{
|
||||||
|
long memberSum = 0;
|
||||||
|
int count = 0;
|
||||||
|
|
||||||
|
var members = g.Members;
|
||||||
|
if (members != null)
|
||||||
|
{
|
||||||
|
for (int i = 0; i < members.Count; i++)
|
||||||
|
{
|
||||||
|
var m = members[i];
|
||||||
|
if (m == null)
|
||||||
|
continue;
|
||||||
|
count++;
|
||||||
|
unchecked { memberSum += (uint)m.Serial.Value; }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var leaderSerial = g.Leader == null ? 0 : g.Leader.Serial.Value;
|
||||||
|
|
||||||
|
return String.Concat(
|
||||||
|
g.Name ?? "", "|",
|
||||||
|
g.Abbreviation ?? "", "|",
|
||||||
|
leaderSerial.ToString(), "|",
|
||||||
|
count.ToString(), "|",
|
||||||
|
memberSum.ToString(), "|",
|
||||||
|
g.Alliance == null ? "" : (g.AllianceName ?? ""));
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string WriteGuild(Guild g)
|
||||||
|
{
|
||||||
|
int online = 0, count = 0;
|
||||||
|
var members = g.Members;
|
||||||
|
if (members != null)
|
||||||
|
{
|
||||||
|
for (int i = 0; i < members.Count; i++)
|
||||||
|
{
|
||||||
|
var m = members[i];
|
||||||
|
if (m == null)
|
||||||
|
continue;
|
||||||
|
count++;
|
||||||
|
if (m.NetState != null)
|
||||||
|
online++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("guild.update")
|
||||||
|
.Num("id", g.Id)
|
||||||
|
.Str("name", g.Name)
|
||||||
|
.Str("abbr", g.Abbreviation)
|
||||||
|
.Num("members", count)
|
||||||
|
.Num("online", online)
|
||||||
|
.Str("alliance", g.Alliance == null ? null : g.AllianceName);
|
||||||
|
|
||||||
|
sb.Actor("leader", g.Leader);
|
||||||
|
|
||||||
|
return sb.End();
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- real-time join ----
|
||||||
|
|
||||||
|
private static void OnJoinGuild(JoinGuildEventArgs e)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
if (e == null || e.Mobile == null)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var g = e.Guild as Guild;
|
||||||
|
|
||||||
|
var sb = BridgeJson.Begin("guild.join");
|
||||||
|
if (g != null)
|
||||||
|
sb.Num("id", g.Id).Str("name", g.Name).Str("abbr", g.Abbreviation);
|
||||||
|
sb.Actor("who", e.Mobile);
|
||||||
|
BridgeLink.Emit(sb.End());
|
||||||
|
_joins++;
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
Console.WriteLine("[Bridge] guild join handler threw: {0}", ex.Message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -20,7 +20,11 @@ use tracing_subscriber::EnvFilter;
|
|||||||
/// Wire-protocol version between the website and the sidecar. Bump this whenever an event or
|
/// Wire-protocol version between the website and the sidecar. Bump this whenever an event or
|
||||||
/// endpoint's shape changes so a mismatched client is detected immediately (409 / health) instead
|
/// endpoint's shape changes so a mismatched client is detected immediately (409 / health) instead
|
||||||
/// of failing in confusing ways.
|
/// of failing in confusing ways.
|
||||||
pub const PROTOCOL_VERSION: u32 = 1;
|
///
|
||||||
|
/// v2 (Protocol 2.0): adds the account-provisioning verbs/endpoints (`POST /accounts/create`,
|
||||||
|
/// `DELETE /link/:account`) and their events. Outbound event kinds are additive, so a v1 website
|
||||||
|
/// keeps working against the live feed; the new *endpoints* require a v2 sidecar.
|
||||||
|
pub const PROTOCOL_VERSION: u32 = 2;
|
||||||
|
|
||||||
#[tokio::main]
|
#[tokio::main]
|
||||||
async fn main() -> anyhow::Result<()> {
|
async fn main() -> anyhow::Result<()> {
|
||||||
@@ -75,6 +79,7 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
let route_rpc = rpc.clone();
|
let route_rpc = rpc.clone();
|
||||||
let event_store = store.clone();
|
let event_store = store.clone();
|
||||||
let last_event_ts = last_event.clone();
|
let last_event_ts = last_event.clone();
|
||||||
|
let replay_handle = handle.clone(); // re-push external news to the shard on (re)connect
|
||||||
let mut total: u64 = 0;
|
let mut total: u64 = 0;
|
||||||
tokio::spawn(async move {
|
tokio::spawn(async move {
|
||||||
while let Some(ev) = event_rx.recv().await {
|
while let Some(ev) = event_rx.recv().await {
|
||||||
@@ -132,10 +137,87 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// Guild board (Protocol 2.0): guild.update folds in the latest roster (one row
|
||||||
|
// per guild id); guild.remove drops a disbanded guild.
|
||||||
|
"guild.update" => {
|
||||||
|
if let Some(id) = ev.value.get("id").and_then(|v| v.as_i64()) {
|
||||||
|
if let Err(e) = event_store
|
||||||
|
.upsert_guild(
|
||||||
|
id,
|
||||||
|
ev.value.get("name").and_then(|n| n.as_str()),
|
||||||
|
&text,
|
||||||
|
t,
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
tracing::warn!(error = %e, "failed to upsert guild board");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"guild.remove" => {
|
||||||
|
if let Some(id) = ev.value.get("id").and_then(|v| v.as_i64()) {
|
||||||
|
if let Err(e) = event_store.delete_guild(id).await {
|
||||||
|
tracing::warn!(error = %e, "failed to remove guild board row");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Governor board (Protocol 2.0): city.update folds in each city's latest
|
||||||
|
// governance state (one row per city).
|
||||||
|
"city.update" => {
|
||||||
|
if let Some(city) = ev.value.get("city").and_then(|c| c.as_str()) {
|
||||||
|
if let Err(e) = event_store.upsert_governor(city, &text, t).await {
|
||||||
|
tracing::warn!(error = %e, "failed to upsert governor board");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// House registry (Protocol 2.0): house.update folds in each house's latest state
|
||||||
|
// (one row per serial); house.remove drops a demolished/traded house.
|
||||||
|
"house.update" => {
|
||||||
|
if let Some(serial) = ev.value.get("serial").and_then(|s| s.as_str()) {
|
||||||
|
if let Err(e) = event_store
|
||||||
|
.upsert_house(
|
||||||
|
serial,
|
||||||
|
ev.value.get("name").and_then(|n| n.as_str()),
|
||||||
|
&text,
|
||||||
|
t,
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
tracing::warn!(error = %e, "failed to upsert house registry");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"house.remove" => {
|
||||||
|
if let Some(serial) = ev.value.get("serial").and_then(|s| s.as_str()) {
|
||||||
|
if let Err(e) = event_store.delete_house(serial).await {
|
||||||
|
tracing::warn!(error = %e, "failed to remove house registry row");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
_ => {}
|
_ => {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// On a shard (re)connect, re-push the stored external news: the shard rebuilds
|
||||||
|
// TownCryerSystem.NewsEntries from scratch each boot and does not persist ours. Replay
|
||||||
|
// with announce=false so a restart does not re-proclaim every article at once. news.add
|
||||||
|
// is idempotent by id, so replaying to a still-populated shard is harmless.
|
||||||
|
if ev.kind == "server.hello" {
|
||||||
|
match event_store.news_all().await {
|
||||||
|
Ok(items) => {
|
||||||
|
for mut item in items {
|
||||||
|
if let Some(obj) = item.as_object_mut() {
|
||||||
|
obj.insert("announce".to_string(), serde_json::json!(false));
|
||||||
|
}
|
||||||
|
if !replay_handle.send(item.to_string()).await {
|
||||||
|
break; // shard went away mid-replay
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(e) => tracing::warn!(error = %e, "news replay: could not read stored news"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let _ = feed_tx.send(ev.value.to_string());
|
let _ = feed_tx.send(ev.value.to_string());
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -104,6 +104,16 @@ impl Store {
|
|||||||
Ok(row.map(|r| r.get::<String, _>("website_user_id")))
|
Ok(row.map(|r| r.get::<String, _>("website_user_id")))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Drops the mirrored link row so event attribution stops immediately, without waiting on the
|
||||||
|
/// shard. Returns the number of rows removed (0 if the account was not linked here).
|
||||||
|
pub async fn record_unlink(&self, account: &str) -> anyhow::Result<u64> {
|
||||||
|
let res = sqlx::query("DELETE FROM links WHERE account = ?")
|
||||||
|
.bind(account)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(res.rows_affected())
|
||||||
|
}
|
||||||
|
|
||||||
pub async fn cache_profile(
|
pub async fn cache_profile(
|
||||||
&self,
|
&self,
|
||||||
serial: &str,
|
serial: &str,
|
||||||
@@ -177,6 +187,147 @@ impl Store {
|
|||||||
.await?;
|
.await?;
|
||||||
Ok(parse_json_column(rows))
|
Ok(parse_json_column(rows))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ---- guild board (Protocol 2.0) ----
|
||||||
|
|
||||||
|
/// Upserts one guild's latest state, keyed by guild id. Fed from `guild.update`; one row per
|
||||||
|
/// guild, always the most recent snapshot. This is the board the website reads on load.
|
||||||
|
pub async fn upsert_guild(
|
||||||
|
&self,
|
||||||
|
id: i64,
|
||||||
|
name: Option<&str>,
|
||||||
|
json: &str,
|
||||||
|
t: i64,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
sqlx::query(
|
||||||
|
"INSERT INTO guilds (id, name, json, updated_t) VALUES (?, ?, ?, ?)
|
||||||
|
ON CONFLICT(id) DO UPDATE SET name = excluded.name, json = excluded.json, updated_t = excluded.updated_t",
|
||||||
|
)
|
||||||
|
.bind(id)
|
||||||
|
.bind(name)
|
||||||
|
.bind(json)
|
||||||
|
.bind(t)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Drops one guild from the board. Fed from `guild.remove` (a disband or a removed guild).
|
||||||
|
pub async fn delete_guild(&self, id: i64) -> anyhow::Result<()> {
|
||||||
|
sqlx::query("DELETE FROM guilds WHERE id = ?")
|
||||||
|
.bind(id)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The full guild board: every guild's latest snapshot, ordered by name.
|
||||||
|
pub async fn guilds_all(&self) -> anyhow::Result<Vec<Value>> {
|
||||||
|
let rows = sqlx::query("SELECT json FROM guilds ORDER BY name, id")
|
||||||
|
.fetch_all(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(parse_json_column(rows))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- governor board (Protocol 2.0) ----
|
||||||
|
|
||||||
|
/// Upserts one city's latest governance state, keyed by city name. Fed from `city.update`.
|
||||||
|
pub async fn upsert_governor(&self, city: &str, json: &str, t: i64) -> anyhow::Result<()> {
|
||||||
|
sqlx::query(
|
||||||
|
"INSERT INTO governors (city, json, updated_t) VALUES (?, ?, ?)
|
||||||
|
ON CONFLICT(city) DO UPDATE SET json = excluded.json, updated_t = excluded.updated_t",
|
||||||
|
)
|
||||||
|
.bind(city)
|
||||||
|
.bind(json)
|
||||||
|
.bind(t)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The full governor board: every city's latest governance snapshot, ordered by city.
|
||||||
|
pub async fn governors_all(&self) -> anyhow::Result<Vec<Value>> {
|
||||||
|
let rows = sqlx::query("SELECT json FROM governors ORDER BY city")
|
||||||
|
.fetch_all(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(parse_json_column(rows))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- house registry (Protocol 2.0) ----
|
||||||
|
|
||||||
|
/// Upserts one house's latest state, keyed by serial. Fed from `house.update`.
|
||||||
|
pub async fn upsert_house(
|
||||||
|
&self,
|
||||||
|
serial: &str,
|
||||||
|
name: Option<&str>,
|
||||||
|
json: &str,
|
||||||
|
t: i64,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
sqlx::query(
|
||||||
|
"INSERT INTO houses (serial, name, json, updated_t) VALUES (?, ?, ?, ?)
|
||||||
|
ON CONFLICT(serial) DO UPDATE SET name = excluded.name, json = excluded.json, updated_t = excluded.updated_t",
|
||||||
|
)
|
||||||
|
.bind(serial)
|
||||||
|
.bind(name)
|
||||||
|
.bind(json)
|
||||||
|
.bind(t)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Drops one house from the registry. Fed from `house.remove` (demolished / traded away).
|
||||||
|
pub async fn delete_house(&self, serial: &str) -> anyhow::Result<()> {
|
||||||
|
sqlx::query("DELETE FROM houses WHERE serial = ?")
|
||||||
|
.bind(serial)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The full house registry: every house's latest snapshot, ordered by name then serial.
|
||||||
|
pub async fn houses_all(&self) -> anyhow::Result<Vec<Value>> {
|
||||||
|
let rows = sqlx::query("SELECT json FROM houses ORDER BY name, serial")
|
||||||
|
.fetch_all(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(parse_json_column(rows))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Town Cryer news (Protocol 2.1) ----
|
||||||
|
|
||||||
|
/// Stores/replaces one external news article (the `news.add` command json), keyed by id. The
|
||||||
|
/// website is the source of truth; this lets the sidecar replay the set to the shard on reconnect
|
||||||
|
/// (the shard does not persist NewsEntries across a reboot).
|
||||||
|
pub async fn upsert_news(&self, id: &str, json: &str, t: i64) -> anyhow::Result<()> {
|
||||||
|
sqlx::query(
|
||||||
|
"INSERT INTO news (id, json, updated_t) VALUES (?, ?, ?)
|
||||||
|
ON CONFLICT(id) DO UPDATE SET json = excluded.json, updated_t = excluded.updated_t",
|
||||||
|
)
|
||||||
|
.bind(id)
|
||||||
|
.bind(json)
|
||||||
|
.bind(t)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Removes one external news article.
|
||||||
|
pub async fn delete_news(&self, id: &str) -> anyhow::Result<()> {
|
||||||
|
sqlx::query("DELETE FROM news WHERE id = ?")
|
||||||
|
.bind(id)
|
||||||
|
.execute(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Every stored external news article (as its `news.add` command), oldest first so a replay
|
||||||
|
/// re-inserts them in the same order the website added them.
|
||||||
|
pub async fn news_all(&self) -> anyhow::Result<Vec<Value>> {
|
||||||
|
let rows = sqlx::query("SELECT json FROM news ORDER BY updated_t")
|
||||||
|
.fetch_all(&self.pool)
|
||||||
|
.await?;
|
||||||
|
Ok(parse_json_column(rows))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn parse_json_column(rows: Vec<sqlx::sqlite::SqliteRow>) -> Vec<Value> {
|
fn parse_json_column(rows: Vec<sqlx::sqlite::SqliteRow>) -> Vec<Value> {
|
||||||
@@ -215,4 +366,30 @@ CREATE TABLE IF NOT EXISTS champs (
|
|||||||
json TEXT NOT NULL,
|
json TEXT NOT NULL,
|
||||||
updated_t INTEGER NOT NULL
|
updated_t INTEGER NOT NULL
|
||||||
);
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS guilds (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
name TEXT,
|
||||||
|
json TEXT NOT NULL,
|
||||||
|
updated_t INTEGER NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS governors (
|
||||||
|
city TEXT PRIMARY KEY,
|
||||||
|
json TEXT NOT NULL,
|
||||||
|
updated_t INTEGER NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS houses (
|
||||||
|
serial TEXT PRIMARY KEY,
|
||||||
|
name TEXT,
|
||||||
|
json TEXT NOT NULL,
|
||||||
|
updated_t INTEGER NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS news (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
json TEXT NOT NULL,
|
||||||
|
updated_t INTEGER NOT NULL
|
||||||
|
);
|
||||||
"#;
|
"#;
|
||||||
|
|||||||
@@ -54,9 +54,14 @@ pub async fn serve(addr: &str, state: AppState) -> anyhow::Result<()> {
|
|||||||
.route("/vendors/:account", get(vendors))
|
.route("/vendors/:account", get(vendors))
|
||||||
// Inbound commands (correlated by code / id).
|
// Inbound commands (correlated by code / id).
|
||||||
.route("/link/confirm", post(link_confirm))
|
.route("/link/confirm", post(link_confirm))
|
||||||
.route("/link/:account", get(link_lookup))
|
// Account provisioning (Protocol 2.0). Create is correlated by reqId; the DELETE unlinks.
|
||||||
|
.route("/accounts/create", post(account_create))
|
||||||
|
.route("/link/:account", get(link_lookup).delete(link_delete))
|
||||||
.route("/towncrier", post(towncrier_add))
|
.route("/towncrier", post(towncrier_add))
|
||||||
.route("/towncrier/:id", axum::routing::delete(towncrier_remove))
|
.route("/towncrier/:id", axum::routing::delete(towncrier_remove))
|
||||||
|
// Town Cryer news gump (Protocol 2.1). Add/replace an article; delete one.
|
||||||
|
.route("/news", post(news_add))
|
||||||
|
.route("/news/:id", axum::routing::delete(news_remove))
|
||||||
// Staff write plane (correlated by reqId). The shard enforces the real authorization;
|
// Staff write plane (correlated by reqId). The shard enforces the real authorization;
|
||||||
// the website must gate these behind admin/moderator roles before calling.
|
// the website must gate these behind admin/moderator roles before calling.
|
||||||
.route("/admin/kick", post(admin_kick))
|
.route("/admin/kick", post(admin_kick))
|
||||||
@@ -71,6 +76,12 @@ pub async fn serve(addr: &str, state: AppState) -> anyhow::Result<()> {
|
|||||||
.route("/history", get(history))
|
.route("/history", get(history))
|
||||||
.route("/economy", get(economy))
|
.route("/economy", get(economy))
|
||||||
.route("/champs", get(champs))
|
.route("/champs", get(champs))
|
||||||
|
// World-state boards (Protocol 2.0), served from the store so they answer without the shard
|
||||||
|
// and survive an outage with the last-known snapshot (docs/PROTOCOL_2.md §12.2).
|
||||||
|
.route("/guilds", get(guilds))
|
||||||
|
.route("/governors", get(governors))
|
||||||
|
.route("/online", get(online))
|
||||||
|
.route("/houses", get(houses))
|
||||||
.route_layer(middleware::from_fn_with_state(state.clone(), gate));
|
.route_layer(middleware::from_fn_with_state(state.clone(), gate));
|
||||||
|
|
||||||
let app = Router::new()
|
let app = Router::new()
|
||||||
@@ -288,6 +299,138 @@ fn respond_admin(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Like `respond`, but for the account-provisioning plane. Maps an `account.error` reply to a
|
||||||
|
/// status by its reason: a name clash is a 409, the per-IP cap is a 429, a disabled/protected/
|
||||||
|
/// refused action is a 403, an unknown target or "not linked" is a 404, anything else a 400.
|
||||||
|
fn respond_account(result: Result<Value, RpcError>) -> (StatusCode, Json<Value>) {
|
||||||
|
match result {
|
||||||
|
Ok(value) => {
|
||||||
|
let kind = value.get("kind").and_then(|k| k.as_str()).unwrap_or("");
|
||||||
|
if kind == "account.error" {
|
||||||
|
let reason = value
|
||||||
|
.get("reason")
|
||||||
|
.and_then(|r| r.as_str())
|
||||||
|
.unwrap_or("request rejected");
|
||||||
|
let code = if reason.contains("already exists") {
|
||||||
|
StatusCode::CONFLICT
|
||||||
|
} else if reason.contains("ip account limit") {
|
||||||
|
StatusCode::TOO_MANY_REQUESTS
|
||||||
|
} else if reason.contains("disabled")
|
||||||
|
|| reason.contains("protected")
|
||||||
|
|| reason.contains("refused")
|
||||||
|
{
|
||||||
|
StatusCode::FORBIDDEN
|
||||||
|
} else if reason.contains("unknown") || reason.contains("not linked") {
|
||||||
|
StatusCode::NOT_FOUND
|
||||||
|
} else {
|
||||||
|
StatusCode::BAD_REQUEST
|
||||||
|
};
|
||||||
|
(code, Json(value))
|
||||||
|
} else {
|
||||||
|
(StatusCode::OK, Json(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(RpcError::NoShard) => (
|
||||||
|
StatusCode::SERVICE_UNAVAILABLE,
|
||||||
|
Json(json!({"error": "shard not connected"})),
|
||||||
|
),
|
||||||
|
Err(RpcError::Timeout) => (
|
||||||
|
StatusCode::GATEWAY_TIMEOUT,
|
||||||
|
Json(json!({"error": "shard did not reply in time"})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- account-provisioning handlers ----
|
||||||
|
|
||||||
|
/// Body: {"actor","account","password","websiteUserId","ip"}. Creates and links a game account.
|
||||||
|
/// Correlated on a fresh reqId. The password is forwarded to the shard (loopback) but never logged
|
||||||
|
/// here and never appears in the reply; a successful create mirrors the link into the store.
|
||||||
|
async fn account_create(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
let mut obj = match body {
|
||||||
|
Value::Object(m) => m,
|
||||||
|
_ => {
|
||||||
|
return (
|
||||||
|
StatusCode::BAD_REQUEST,
|
||||||
|
Json(json!({"error": "body must be a JSON object"})),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Required, non-empty. `ip` is validated on the shard (which owns the cap), not here.
|
||||||
|
for field in ["actor", "account", "password", "websiteUserId"] {
|
||||||
|
let present = obj
|
||||||
|
.get(field)
|
||||||
|
.and_then(|v| v.as_str())
|
||||||
|
.map(|s| !s.trim().is_empty())
|
||||||
|
.unwrap_or(false);
|
||||||
|
if !present {
|
||||||
|
return (
|
||||||
|
StatusCode::BAD_REQUEST,
|
||||||
|
Json(json!({ "error": format!("{field} is required") })),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let req_id = st.rpc.next_req_id();
|
||||||
|
obj.insert("kind".to_string(), json!("account.create"));
|
||||||
|
obj.insert("reqId".to_string(), json!(req_id));
|
||||||
|
|
||||||
|
let result = st.rpc.call(&st.shard, Value::Object(obj), &req_id).await;
|
||||||
|
|
||||||
|
// Mirror a successful create's link into the store, so events are attributable without the
|
||||||
|
// shard (same as link.confirm does).
|
||||||
|
if let Ok(value) = &result {
|
||||||
|
if value.get("kind").and_then(|k| k.as_str()) == Some("account.ok") {
|
||||||
|
if let (Some(account), Some(web_id)) = (
|
||||||
|
value.get("account").and_then(|a| a.as_str()),
|
||||||
|
value.get("websiteUserId").and_then(|w| w.as_str()),
|
||||||
|
) {
|
||||||
|
let t = value.get("t").and_then(|v| v.as_i64()).unwrap_or(0);
|
||||||
|
let _ = st.store.record_link(account, web_id, t).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
respond_account(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Unlinks a game account from its website user. Body: {"actor"}. Correlated on reqId; a success
|
||||||
|
/// also clears the sidecar's mirrored link row so attribution stops immediately.
|
||||||
|
async fn link_delete(
|
||||||
|
State(st): State<AppState>,
|
||||||
|
Path(account): Path<String>,
|
||||||
|
body: Option<Json<Value>>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
let actor = body
|
||||||
|
.as_ref()
|
||||||
|
.and_then(|Json(b)| b.get("actor").and_then(|a| a.as_str()))
|
||||||
|
.unwrap_or_default()
|
||||||
|
.trim()
|
||||||
|
.to_string();
|
||||||
|
|
||||||
|
if actor.is_empty() {
|
||||||
|
return (
|
||||||
|
StatusCode::BAD_REQUEST,
|
||||||
|
Json(json!({"error": "actor is required"})),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let req_id = st.rpc.next_req_id();
|
||||||
|
let cmd = json!({
|
||||||
|
"kind": "account.unlink", "reqId": req_id, "actor": actor, "account": account
|
||||||
|
});
|
||||||
|
let result = st.rpc.call(&st.shard, cmd, &req_id).await;
|
||||||
|
|
||||||
|
if let Ok(value) = &result {
|
||||||
|
if value.get("kind").and_then(|k| k.as_str()) == Some("account.ok") {
|
||||||
|
let _ = st.store.record_unlink(&account).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
respond_account(result)
|
||||||
|
}
|
||||||
|
|
||||||
// ---- admin write-plane handlers ----
|
// ---- admin write-plane handlers ----
|
||||||
|
|
||||||
/// Forwards a staff moderation command to the shard, correlated on a fresh reqId. Injects `kind`
|
/// Forwards a staff moderation command to the shard, correlated on a fresh reqId. Injects `kind`
|
||||||
@@ -521,6 +664,50 @@ async fn towncrier_remove(State(st): State<AppState>, Path(id): Path<String>) ->
|
|||||||
respond(st.rpc.call(&st.shard, cmd, &id).await)
|
respond(st.rpc.call(&st.shard, cmd, &id).await)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Body: {"id":"42","title":"...","body":"<html>","image":1614,"url":"...","announce":true}.
|
||||||
|
/// Adds/replaces a Town Cryer news article. Correlated on `id`. A success is stored so the sidecar
|
||||||
|
/// can replay the article to the shard on reconnect (NewsEntries is not persisted across a reboot).
|
||||||
|
async fn news_add(State(st): State<AppState>, Json(body): Json<Value>) -> impl IntoResponse {
|
||||||
|
let id = body.get("id").and_then(|i| i.as_str()).unwrap_or_default();
|
||||||
|
let title_ok = body
|
||||||
|
.get("title")
|
||||||
|
.and_then(|t| t.as_str())
|
||||||
|
.map(|s| !s.trim().is_empty())
|
||||||
|
.unwrap_or(false);
|
||||||
|
if id.is_empty() || !title_ok {
|
||||||
|
return (
|
||||||
|
StatusCode::BAD_REQUEST,
|
||||||
|
Json(json!({"error": "id and title are required"})),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut cmd = body.clone();
|
||||||
|
cmd["kind"] = json!("news.add");
|
||||||
|
let id = id.to_string();
|
||||||
|
let result = st.rpc.call(&st.shard, cmd.clone(), &id).await;
|
||||||
|
|
||||||
|
// Persist the article (as its news.add command) so it can be replayed on shard reconnect.
|
||||||
|
if let Ok(value) = &result {
|
||||||
|
if value.get("kind").and_then(|k| k.as_str()) == Some("news.ok") {
|
||||||
|
let t = value.get("t").and_then(|v| v.as_i64()).unwrap_or(0);
|
||||||
|
let _ = st.store.upsert_news(&id, &cmd.to_string(), t).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
respond(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn news_remove(State(st): State<AppState>, Path(id): Path<String>) -> impl IntoResponse {
|
||||||
|
let cmd = json!({"kind":"news.remove","id":id});
|
||||||
|
let result = st.rpc.call(&st.shard, cmd, &id).await;
|
||||||
|
|
||||||
|
if let Ok(value) = &result {
|
||||||
|
if value.get("kind").and_then(|k| k.as_str()) == Some("news.ok") {
|
||||||
|
let _ = st.store.delete_news(&id).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
respond(result)
|
||||||
|
}
|
||||||
|
|
||||||
// ---- history (from SQLite) ----
|
// ---- history (from SQLite) ----
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
@@ -566,6 +753,63 @@ async fn champs(State(st): State<AppState>) -> impl IntoResponse {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The guild board: every guild's latest roster snapshot (id/name/abbr/leader/members/alliance).
|
||||||
|
/// Served from the local board table, so it hydrates a fresh page or a restarted sidecar without a
|
||||||
|
/// shard round-trip. The live `guild.*` feed then keeps it current.
|
||||||
|
async fn guilds(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
match st.store.guilds_all().await {
|
||||||
|
Ok(guilds) => (StatusCode::OK, Json(json!({"guilds": guilds}))),
|
||||||
|
Err(e) => (
|
||||||
|
StatusCode::INTERNAL_SERVER_ERROR,
|
||||||
|
Json(json!({"error": e.to_string()})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The governor board: each city's latest governance snapshot (governor/elect/election phase).
|
||||||
|
/// Served from the local board table for the same reason as `/guilds`.
|
||||||
|
async fn governors(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
match st.store.governors_all().await {
|
||||||
|
Ok(cities) => (StatusCode::OK, Json(json!({"cities": cities}))),
|
||||||
|
Err(e) => (
|
||||||
|
StatusCode::INTERNAL_SERVER_ERROR,
|
||||||
|
Json(json!({"error": e.to_string()})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The house registry: every house's latest snapshot (owner/region/location/decay/value). Served
|
||||||
|
/// from the local board table, so it hydrates without the shard and survives an outage.
|
||||||
|
async fn houses(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
match st.store.houses_all().await {
|
||||||
|
Ok(houses) => (StatusCode::OK, Json(json!({"houses": houses}))),
|
||||||
|
Err(e) => (
|
||||||
|
StatusCode::INTERNAL_SERVER_ERROR,
|
||||||
|
Json(json!({"error": e.to_string()})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The current online population: total plus per-facet and per-region counts. This is the most
|
||||||
|
/// recent `presence.online` snapshot from the event store (so it survives a sidecar restart); the
|
||||||
|
/// live `presence.online` stream keeps it current, and `GET /history?kind=presence.online` gives the
|
||||||
|
/// population time series. Returns `count: 0` if the shard has not reported one yet.
|
||||||
|
async fn online(State(st): State<AppState>) -> impl IntoResponse {
|
||||||
|
match st.store.recent(Some("presence.online"), 1).await {
|
||||||
|
Ok(mut events) => match events.pop() {
|
||||||
|
Some(latest) => (StatusCode::OK, Json(latest)),
|
||||||
|
None => (
|
||||||
|
StatusCode::OK,
|
||||||
|
Json(json!({"kind": "presence.online", "count": 0, "byFacet": {}, "byRegion": {}})),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
Err(e) => (
|
||||||
|
StatusCode::INTERNAL_SERVER_ERROR,
|
||||||
|
Json(json!({"error": e.to_string()})),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ---- websocket ----
|
// ---- websocket ----
|
||||||
|
|
||||||
async fn ws_upgrade(ws: WebSocketUpgrade, State(state): State<AppState>) -> impl IntoResponse {
|
async fn ws_upgrade(ws: WebSocketUpgrade, State(state): State<AppState>) -> impl IntoResponse {
|
||||||
|
|||||||
Reference in New Issue
Block a user