mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
* refactor: move the protocol schema to protocol/schema.json (RL-09)
The WebSocket message-type schema is the one artifact in this repository that
neither component owns: `Server/ws/message_types.go` and
`Client/src/lib/protocolTypes.ts` are both generated from it, and neither may
be hand-edited. It nonetheless lived at `docs/protocol-schema.json` — filed
under the directory for prose, whose own README calls it "Reference" material
— and its generator lived at `Server/scripts/genprotocol/`, i.e. inside one of
the two consumers. Ownership was legible from neither location.
The obvious fix — move the generator to the repository root alongside the
schema, so the whole tool is at the cross-component boundary — is wrong here.
The generator is a Go `package main`, and Go modules are directory-rooted:
`Server/go.mod` roots at `Server/`, so a root-level Go program needs a second
module or a `go.work`. That second module would sit outside every path filter
this repository already has — `golangci-lint` runs with `working-directory:
Server/` (ci.yml), `go vet ./...` runs from `Server/` (scripts/run.mjs,
.githooks/pre-commit), `.githooks/pre-commit` selects Go files with
`^Server/.*\.go$`, `.githooks/pre-push` sets `server_changed` on `^Server/`,
setup-go caches on `Server/go.sum`, and dependabot has one gomod block for
`/Server`. Six gates would silently stop covering the generator, each failing
open. The schema is data and moves freely; the generator is Go and stays where
the Go toolchain already runs.
Done instead:
- `docs/protocol-schema.json` -> `protocol/schema.json`. A new top-level
`protocol/` is the cross-component boundary, with a `README.md` naming the
two generated consumers, the one command, and the four gates.
- `Server/scripts/genprotocol/` -> `Server/cmd/genprotocol/`, the module's
conventional home for an executable. This also empties `Server/scripts/` of
Go entry points except `seed.go`, which RL-10 moves next.
- `Server/cmd/` added to `Server/.dockerignore` and `Server/.air.toml`, which
both already excluded `Server/scripts/`. Without this the move would have
silently widened the Docker build context and the air watch set.
27 files, 115 insertions, 76 deletions. Two runtime path resolvers re-pointed
(`cmd/genprotocol/main.go:41` `-schema` default, `ws/protocol_contract_test.go:67`
`filepath.Join`); two git-hook grep patterns (`pre-commit:53`, `pre-push:57`);
eight generator call sites across five files (Makefile x2, scripts/run.mjs x2,
pre-commit x2, ci-check skill, bughunt-fix.js); two broken relative markdown
links (docs/README.md:47, docs/protocol.md:1497); two generated files
regenerated, header lines only, zero constants changed; two ledger prose hits
plus a `render-ledger.mjs` re-render. No new verify was written: the
regenerate-and-diff check is already enforced three times (CI `make
protocol-verify`, `.githooks/pre-commit`, `npm run check:server`) and
`ws/protocol_contract_test.go` independently checks the schema against the
constants a fourth time.
Verified: both directions, for both resolvers. With `protocol/schema.json`
removed, `go test ./ws/ -run TestProtocol` fails with `reading protocol schema
at /home/user/OwnCord/protocol/schema.json: no such file or directory` (two
tests) and `go run ./cmd/genprotocol` exits 1 with `read schema: open
../protocol/schema.json: no such file or directory`; with the file restored
both pass. So the new path is genuinely resolved, not merely spelled in a
comment. The hook patterns were exercised directly: the pre-commit pattern
matches `protocol/schema.json` and `Server/cmd/genprotocol/main.go` and no
longer matches `docs/protocol-schema.json`; the pre-push pattern matches
`protocol/schema.json`. `go run ./cmd/genprotocol` twice in a row leaves
`git diff --exit-code ws/message_types.go ../Client/src/lib/protocolTypes.ts`
clean, so the committed outputs are exactly what the generator emits.
`go build ./...` and `go vet ./...` pass; `npx prettier --check .`,
`npm run typecheck` and `npm run lint` pass; `node .superpowers/render-ledger.mjs
--check` reports 348 findings valid.
Not included: the four dated `docs/audit-*.md` files, the older
`docs/plans/*`, and `CHANGELOG.md` keep the old path — they are point-in-time
records, and `.prettierignore` and `scripts/check-doc-counts.mjs` already
treat them as deliberately unmaintained. The B1 plan itself keeps its own
wording, since it states intent rather than current state. `Server/scripts/`
is not deleted: it still holds `seed.go` (RL-10), `k6/`, `toxiproxy/` and two
shell scripts. `Server/telemetry/metrics.go:19` declares a scope for a
`Server/voice` package that does not exist — spotted here, unrelated to this
move, left for RL-13's sweep to carry forward verbatim rather than fixed
inside a relocation. No `seed:` Make target was added.
Refs RL-09, L-09
* refactor: move the seed tool under Server/cmd/seed (RL-10)
`Server/scripts/seed.go` was a `package main` sitting directly in
`Server/scripts/`, which made `Server/scripts` itself one of the module's
three main packages — a developer tool in the module's build graph under a
directory name that says "loose scripts". It also did filesystem work in
`func init()`: `os.MkdirAll("data", 0o750)` ran before `flag.Parse()`, so the
directory appeared even when the tool immediately refused to run.
The audit row (RL-10) claims that `init()` fires "during test discovery". It
does not, and the obvious fix aimed at that claim would be aimed at nothing:
`Server/scripts/` contains zero `_test.go` files, so Go never builds a test
binary there and `go test ./...` never runs the `init()`. The residual defect
is narrower and real — an untagged `package main` in the build graph, plus a
side effect on a path (`go run ./cmd/seed -h`) that has nothing to do with
tests.
Done:
- `Server/scripts/seed.go` -> `Server/cmd/seed/main.go`, joining
`cmd/genprotocol/` from RL-09. `Server/scripts/` now holds shell and JS
tooling only (docker-smoke.sh, k6/, toxiproxy/, voice-test.sh) and no Go
entry point at all.
- The `os.MkdirAll` moved out of `init()` to immediately before `db.Open` in
`main()` — the one call that needs the directory, since `db.Open` ->
`OpenWithMaxReaders` -> `openFile` creates no intermediate directories.
- The package doc comment's usage lines were wrong in two ways, not one: they
named `go run scripts/seed.go`, which no longer exists, and they omitted
the mandatory `-confirm-dev`, so neither documented command could ever have
run. Both corrected, and `seed.go is a standalone tool` became the
conventional `Command seed populates ...`.
- `Server/CLAUDE.md`'s Layout list now names `cmd/` and states that no Go
entry point lives in `scripts/`.
Two files, 20 insertions, 17 deletions. `go list` main packages go from
`{server, server/cmd/genprotocol, server/scripts}` to `{server,
server/cmd/genprotocol, server/cmd/seed}` — the count is unchanged at three,
which is the honest framing: this relocates a main package to a conventional
path, it does not remove one from the build graph.
Verified: both directions, by building the pre-change file and the
post-change file and running each in a fresh empty directory. Before, `seed`
with no flags exits 1 *and leaves a `data/` directory behind*; `seed -h`
exits 0 and also leaves `data/` behind. After, both exit the same way and
create nothing — `data/ exists=NO` in each case. The happy path is unchanged:
`seed -confirm-dev` in an empty directory creates `data/` at mode 0750,
writes `data/chatserver.db`, and reports 4 users / 5 channels / 31 messages;
a second run reports 0 new rows, so idempotence survives. The old documented
invocation now fails loudly (`go run scripts/seed.go` -> `stat
scripts/seed.go: no such file or directory`) and the new one is what the
comment says. All four build-tag variants compile, `go vet ./...` passes,
`gofmt -l` is clean outside `db/dbgen`, and `npx prettier --check .` passes.
Behaviour delta, called out rather than left silent: the two cases above
(`-h`, and a missing `-confirm-dev`) no longer create `./data`. That is a
change, not a pure relocation. It is the change RL-10 asks for — the remedy
text is "remove import/test-time filesystem side effects" — and the
alternative that preserves the old behaviour exactly, making the `MkdirAll`
the first statement of `main()` before `flag.Parse()`, would keep precisely
the side effect the item exists to remove.
Not included: `Server/scripts/genprotocol` was moved to `Server/cmd/` by the
RL-09 commit rather than here, so the "executable tooling under conventional
command ownership" class is closed across the two commits, not this one
alone. `filepath.Dir(*dbPath)` was evaluated for the `MkdirAll` and rejected:
it would fix a real gap (`-db /elsewhere/x.db` still creates a useless
`./data` and does not create `/elsewhere`) but it means creating an arbitrary
directory from CLI input, and that is a behaviour change past "shift it out
of `init()`" — worth its own item. No `make seed` target was added, and the
dated `docs/audit-*.md` rows naming `Server/scripts/seed.go` keep the old
path. The findings ledger has zero references to this file, so no re-render
was needed.
Refs RL-10, L-10
* test: give the cross-stack contracts a named tier (RL-11)
`Client/tests/unit/admin-static-channel-perms.test.ts` reads and executes
`Server/admin/static/index.html`. Filed under `tests/unit`, nothing about its
location or name said it locks a server-owned artifact, so a Go developer
editing the admin SPA got a red check called "Client Unit Tests" with no clue
why.
The register describes this as one file. It is not, and the measured set does
not match the description in either direction:
- Client -> Server: exactly ONE test crosses by filesystem read, not two.
`main-page.test.ts` was named in the plan but only carries a prose comment
citing `Server/admin/update_handlers.go:181` at line 1046 — no read, no
import, nothing to move.
- Server -> Client: the four tests the plan named do not cross.
`waf_test.go`/`waf_crs_test.go` set a `User-Agent: OwnCordClient/1.0`
literal that appears nowhere under `Client/`; `ws_integration_test.go:289`
and `sanitize_content_fuzz_test.go:46` are comments. The real crossing is
one the register never named: `Server/updater/updater_test.go:630` does
`os.ReadFile` on `Client/src-tauri/tauri.conf.json`.
The obvious fixes are both wrong. Moving the invariant "to the owning server
test" cannot work: `Server/go.mod` carries no JavaScript engine (no goja,
otto, v8go, quickjs, rogchap, duktape), so a Go port could only assert at the
text level like `admin/perm_grid_test.go` does — and that is not a
substitute. Flipping the guard at `admin/static/index.html:1182` to
`targetIsTouchedRole=false` reintroduces OC-0154 in full while leaving every
greppable identifier intact, so a text-level test passes on a broken file.
Relocating it to the e2e admin journey is worse: that job is
`continue-on-error: true` and deliberately unpinned ("requiring it is
theatre" — `docs/plans/b0-dev-branch-protection.sh`), so it would convert a
blocking, pinned gate into one that is green regardless. And the journey does
not cover the invariant today: `grep -Eic "perm|access|role|override|matrix"`
over its 142 lines returns 0, so the "if e2e already covers it, delete"
branch never fires.
Done — one tier, applied to the whole set, defined by artifact coupling and
placed by runtime capability:
- New `Client/tests/contract/`, holding
`server-admin-static-channel-perms.test.ts`. Same directory depth, so
`../../../Server/...` still resolves; the body is byte-identical apart from
a header naming the owner and the runner.
- `Server/updater/tauri_key_contract_test.go` splits the one cross-component
Go test out of `updater_test.go` verbatim, same `package updater`. It stays
in Go — placement follows capability, and Go parses JSON fine — so only the
file name has to declare the crossing. Without this the item would have
been "moved one file and declared the class closed".
- `npm run test:contract`, and the tier, the membership rule and a
blocking/non-blocking table in `docs/contributing.md#testing`, which
previously described no tiers at all.
- `Client/CLAUDE.md`'s tier list was missing `tests/e2e/admin` and
`tests/e2e/native` before this; it now lists all seven and states the rule.
`Server/CLAUDE.md` records why the SPA's execution-level invariant is
locked from the client tree, so nobody "fixes" it into a regex.
- Ledger `OC-0154.fix.test` re-pointed and `FINDINGS.md` re-rendered;
`.claude/workflows/bughunt.js` — the workflow that produced OC-0154 — no
longer describes the TS test surface as `tests/unit/*.test.ts` only.
- Three stale cross-stack pointers of exactly the class this item is about:
`tests/e2e/helpers.ts:348,351` and `tests/unit/types.test.ts:13` named
`docs/brain/06-Specs/PROTOCOL.md`, which does not exist (`docs/brain/` is a
gitignored path); all now name `docs/protocol.md`.
15 files, 125 insertions, 33 deletions. No CI job, workflow, vitest,
tsconfig, eslint, knip or stryker change, and no new pinned check —
`ci.yml`'s `npx vitest run --coverage` has no path filter and
`vitest.config.ts` includes `tests/**/*.test.ts`, so enforcement after the
move is bit-identical to enforcement before it. That is deliberate: `dev`
pins 11 contexts and a 12th is a branch-protection API write, not something a
PR can do, so any new job would be advisory until someone separately changed
repository settings — strictly less protection than today.
Verified: both directions, and the assertion was not weakened. Flipping
`admin/static/index.html:1182` to `const targetIsTouchedRole=false;` makes
the moved test fail (`AssertionError: expected 'DELETE' not to be 'DELETE'`);
`git checkout` of that file makes it pass again — so the invariant survived
the move intact rather than becoming a test that passes anywhere. The split
Go test's cross-boundary read is live too: with
`Client/src-tauri/tauri.conf.json` moved away, `go test ./updater/` fails
with `ReadFile(../../Client/src-tauri/tauri.conf.json): no such file or
directory` from `tauri_key_contract_test.go:20`, and passes once restored.
The full client suite is 192 files / 5257 tests passing, identical to the
count before the move; `npm run typecheck` passes, which proves
`tests/contract/` is inside the tsconfig graph and that `tests/types/jsdom.d.ts`
still resolves the moved test's `import { JSDOM }`. `npm run lint`,
`npx prettier --check .`, `go vet ./...` and `go test ./updater/` all pass.
`git grep "tests/unit/admin-static-channel-perms"` finds no survivor outside
the B1 plan itself.
Not included: nothing was deleted, because no e2e sibling covers OC-0154.
`Client/tests/types/jsdom.d.ts` was neither moved nor deleted — it is still
the only type source for the moved test's `jsdom` import. `capabilities-scope.test.ts`
and `tauri-conf-webview2-args.test.ts` read `src-tauri/` and stay in
`tests/unit`: `src-tauri` is inside the `Client` component, so they are not
contract tests, and the rule earns that rather than hand-waving it — moving
them would have forced repoints of ledger entry OC-0089 and
`docs/security.md:64` for no gain. Each gained a one-line header saying why.
`Server/admin/perm_grid_test.go` and `emoji_section_test.go` read their own
package's embedded asset and are unchanged; they are the text-level
complement to the execution-level test, not duplicates. No JS engine was
added to `go.mod`, no npm root was created under `Server/`, and no root-level
`tests/` tier was created — there is no runner for one and no way to make it
blocking from a PR. Separately noticed and NOT fixed here:
`docs/contributing.md:221` still says "All ten required checks" while
`docs/plans/b0-dev-branch-protection.sh` pins eleven since B1-3 added
`Repository Hygiene`, and `docs/plans/hp-0-scorecard-2026-08-25.md:109` is
stale the same way — that is the branch-protection item's to fix, not this
one's, and one register item per commit.
Refs RL-11, L-11
* refactor: rename the Go module to github.com/J3vb/OwnCord/Server (RL-13)
`Server/go.mod` declared `github.com/owncord/server` while the public
repository is `github.com/J3vb/OwnCord`. Nothing resolves that path — there is
no `owncord` GitHub org and no vanity-import host serving go-import metadata
for it — so every import line in the tree named a location that does not
exist. It compiles because a main module's own path is never fetched, which is
exactly why it went unnoticed.
The obvious fix — an AST-aware import rewriter (`gomvpkg`, `go mod edit`) —
is wrong here, and provably so. Six of the 722 occurrences are not imports at
all: `api/main_test.go:20` (a goleak `IgnoreTopFunction` pattern),
`telemetry/metrics.go:17-19` (three OTel instrumentation-scope names),
`invariants/syncutil_locks.go:73` (a diagnostic message), and
`invariants/syncutil_locks_test.go:56` (an import line inside a raw-string Go
fixture). An import rewriter touches none of them, and the compiler cannot
see any of them either.
Done as one scripted substitution over `git ls-files`, anchored on the full
`github.com/owncord/server` string. The anchor matters: `owncord-server` is a
different identifier — the OTel `service.name` (`config/config.go`,
`telemetry/telemetry_otel.go`) and the GHCR image name
(`.github/workflows/release.yml`, `docker-compose.yml`) — and a looser pattern
would have moved it. It is untouched: 10 occurrences across 9 files, before
and after.
350 files, 728 insertions, 728 deletions. 722 occurrences in 344 Go files,
plus `go.mod:1`, the `sed` at `Makefile:67`, `Server/CLAUDE.md:3`,
`docs/architecture/server.md:5`, and the ledger pair
(`findings-ledger.json:3758` plus a `render-ledger.mjs` re-render of
`FINDINGS.md`). Zero in any workflow, zero in the Dockerfile, zero in
`Server/.golangci.yml` (no `local-prefixes`, `gci`, `importas` or `depguard`
rule keys on the module path, so import grouping is not configured anywhere).
The plan's blast-radius estimate missed one thing, and it is the one that
would have gone red: **gofmt**. `J` (0x4A) sorts before every lowercase
letter, so in the 36 files where a module-local import shares a contiguous
group with a third-party one, the module's imports must move above
`github.com/go-chi/...`. `gofmt -l` was clean before the substitution and
listed exactly 36 files after it; `gofmt -w` on those 36 restores it to
clean. `gofmt` is an enforced gate — the `formatters` block in
`Server/.golangci.yml`, which is S-05 — so a substitution-only commit fails
Lint.
Verified: both directions, and the line accounting is exact. Every added line
in this diff contains the new module path (728) and every removed line
contains the old one (728); the count of changed lines containing neither is
**zero**, so the gofmt re-sort moved module-path lines only and touched no
third-party import. The residual check
(`git ls-files -z | xargs -0 grep -n 'github\.com/owncord/server'`) returns
exactly two hits, both deliberately out of scope: the RL-13 row in
`docs/audit-2026-08-23-repository-layout.md` and the measurement row in this
phase's own plan. The compiler-invisible half was proven by reverting *only*
`api/main_test.go:20` to the old path on the otherwise-renamed tree:
`go build ./...` and `go vet ./api/` both still pass — they see nothing wrong
— while `go test ./api/` FAILS, because the runtime function name now carries
the new path and goleak stops ignoring `ws.(*Hub).Run.func1`. Restoring the
line makes it pass. `go.sum` is byte-identical (no `go mod tidy` was run and
none was needed). All four build-tag variants compile; `go vet ./...`,
`go vet -tags otel,wazero ./...` and `go vet -tags deadlock ./...` pass;
`go test -race ./...` is 16/16 packages green; `go test -tags deadlock ./...`
passes; the tag-gated `./plugin/...` (wazero) and `./telemetry/...` (otel)
runs pass. `golangci-lint` v2.11.3 — the pinned CI version, rebuilt locally
against Go 1.26 because the packaged binary cannot load a 1.26 config —
reports **0 issues**. `go run ./cmd/genprotocol` leaves
`git diff --exit-code ws/message_types.go ../Client/src/lib/protocolTypes.ts`
clean, so the rename does not reach the generated protocol constants.
`npx prettier --check .` and `node .superpowers/render-ledger.mjs --check`
pass.
Not included: `docs/audit-2026-08-23-repository-layout.md` and
`docs/plans/b1-repository-foundation-2026-08-25.md` keep the old path — they
are the audit row and the measurement that motivated this change, and
rewriting them would erase the record of what was measured. They are why the
residual check needs a two-path allowance rather than being empty; that
allowance is stated above rather than hidden in a pathspec.
`telemetry/metrics.go:19` declares `scopeVoice` for a `Server/voice` package
that does not exist; the substitution carried the dead path forward verbatim
as `github.com/J3vb/OwnCord/Server/voice` rather than fixing it, because
correcting a real observability bug inside a mechanical rename would hide it
in a 350-file diff. It needs its own item. No `go.work`, no second module,
and no vanity-import host was set up — the new path resolves against the real
repository, but nothing imports this module as a library, so `go get`
reachability was not exercised either way.
Refs RL-13, L-12
---------
Co-authored-by: Claude <noreply@anthropic.com>
424 lines
15 KiB
Go
424 lines
15 KiB
Go
package api
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/binary"
|
|
"errors"
|
|
"fmt"
|
|
"image"
|
|
_ "image/gif" // register the GIF decoder for image.DecodeConfig
|
|
_ "image/jpeg" // register the JPEG decoder for image.DecodeConfig
|
|
_ "image/png" // register the PNG decoder for image.DecodeConfig
|
|
"io"
|
|
"log/slog"
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/J3vb/OwnCord/Server/auth"
|
|
"github.com/J3vb/OwnCord/Server/db"
|
|
"github.com/J3vb/OwnCord/Server/service"
|
|
"github.com/go-chi/chi/v5"
|
|
"github.com/google/uuid"
|
|
)
|
|
|
|
// EmojiBroadcaster is the slice of the hub the emoji routes need: after every
|
|
// mutation the full set is pushed to every connected client so pickers,
|
|
// message rendering and reaction pills converge without a reconnect.
|
|
type EmojiBroadcaster interface {
|
|
BroadcastEmojiUpdate(list []*db.Emoji)
|
|
}
|
|
|
|
// emojiResponse is the JSON shape of one emoji in GET/POST /api/v1/emoji.
|
|
// Deliberately not db.Emoji: the storage id and sniffed mime type are
|
|
// server-side details, and `url` is what a client actually needs.
|
|
type emojiResponse struct {
|
|
ID int64 `json:"id"`
|
|
Shortcode string `json:"shortcode"`
|
|
URL string `json:"url"`
|
|
}
|
|
|
|
func toEmojiResponse(e *db.Emoji) emojiResponse {
|
|
return emojiResponse{ID: e.ID, Shortcode: e.Shortcode, URL: service.EmojiImageURL(e.ID)}
|
|
}
|
|
|
|
func toEmojiResponses(list []*db.Emoji) []emojiResponse {
|
|
out := make([]emojiResponse, 0, len(list))
|
|
for _, e := range list {
|
|
if e == nil {
|
|
continue
|
|
}
|
|
out = append(out, toEmojiResponse(e))
|
|
}
|
|
return out
|
|
}
|
|
|
|
// allowedEmojiMIME is the set of image types an emoji may be, matched against
|
|
// the type sniffed from the file's own bytes. SVG is absent on purpose: it is
|
|
// markup with script and external-fetch capability, which is exactly what
|
|
// isUnsafeInlineMIME forces to a download on the attachment route -- an emoji
|
|
// is by definition rendered inline, so the format simply cannot be allowed.
|
|
var allowedEmojiMIME = map[string]bool{
|
|
"image/png": true,
|
|
"image/jpeg": true,
|
|
"image/gif": true,
|
|
"image/webp": true,
|
|
}
|
|
|
|
// MountEmojiRoutes registers the custom-emoji endpoints.
|
|
//
|
|
// Every route requires authentication: reading the set is ungated beyond that
|
|
// (emoji are server-wide and every member renders them), while POST and DELETE
|
|
// are gated on MANAGE_SERVER inside EmojiService. The image route is
|
|
// authenticated rather than public so an emoji cannot be used as an
|
|
// unauthenticated tracking pixel hosted on someone else's server.
|
|
func MountEmojiRoutes(r chi.Router, database *db.DB, svc *service.Services, store FileStore, limiter *auth.RateLimiter, broadcaster EmojiBroadcaster) {
|
|
r.Route("/api/v1/emoji", func(r chi.Router) {
|
|
r.Use(AuthMiddleware(database))
|
|
r.Get("/", handleListEmoji(svc))
|
|
r.Get("/{id}/image", handleServeEmojiImage(svc, store))
|
|
r.With(MaxBodySize(emojiMaxBodySize)).
|
|
Post("/", handleCreateEmoji(svc, store, limiter, broadcaster))
|
|
r.Delete("/{id}", handleDeleteEmoji(svc, store, broadcaster))
|
|
})
|
|
}
|
|
|
|
func handleListEmoji(svc *service.Services) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
list, err := svc.Emoji.List(r.Context())
|
|
if err != nil {
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
writeJSON(w, http.StatusOK, toEmojiResponses(list))
|
|
}
|
|
}
|
|
|
|
// handleCreateEmoji processes POST /api/v1/emoji (multipart: `file` + `shortcode`).
|
|
//
|
|
// Order matters here. The permission gate runs BEFORE the multipart parse, so a
|
|
// member without MANAGE_SERVER cannot make the server spool a body to disk; the
|
|
// shortcode is validated next, so a malformed name costs nothing either; only
|
|
// then are the bytes read, sniffed, measured and stored.
|
|
func handleCreateEmoji(svc *service.Services, store FileStore, limiter *auth.RateLimiter, broadcaster EmojiBroadcaster) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
user, ok := r.Context().Value(UserKey).(*db.User)
|
|
if !ok || user == nil {
|
|
writeJSON(w, http.StatusUnauthorized, errorResponse{
|
|
Error: "UNAUTHORIZED", Message: "not authenticated",
|
|
})
|
|
return
|
|
}
|
|
|
|
if err := svc.Emoji.RequireManage(r.Context(), user.ID); err != nil {
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
|
|
if limiter != nil && !limiter.Allow(auth.Key("emoji_upload", user.ID), emojiUploadRateLimitPerMinute, time.Minute) {
|
|
writeJSON(w, http.StatusTooManyRequests, errorResponse{
|
|
Error: "RATE_LIMITED", Message: "emoji upload rate limit exceeded, try again later",
|
|
})
|
|
return
|
|
}
|
|
|
|
// Bound the body before the multipart parser touches it. The route also
|
|
// carries MaxBodySize, but a handler that parses a form has to state
|
|
// its own limit — the parser is what turns an unbounded body into heap.
|
|
r.Body = http.MaxBytesReader(w, r.Body, emojiMaxBodySize)
|
|
|
|
if err := r.ParseMultipartForm(emojiMultipartMemoryLimit); err != nil {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST", Message: "invalid multipart form",
|
|
})
|
|
return
|
|
}
|
|
|
|
shortcode, err := service.ValidateShortcode(r.FormValue("shortcode"))
|
|
if err != nil {
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
|
|
raw, mimeType, readOK := readEmojiUpload(w, r)
|
|
if !readOK {
|
|
return
|
|
}
|
|
|
|
storedAs := uuid.New().String()
|
|
if _, saveErr := store.Save(storedAs, bytes.NewReader(raw)); saveErr != nil {
|
|
// writeStorageSaveError also stops echoing raw storage errors
|
|
// (which embed absolute paths) into the response body.
|
|
writeStorageSaveError(w, saveErr, "emoji upload")
|
|
return
|
|
}
|
|
|
|
created, err := svc.Emoji.Create(r.Context(), user.ID, shortcode, storedAs, mimeType)
|
|
if err != nil {
|
|
// The row never landed, so the file is an orphan — unlink it.
|
|
if delErr := store.Delete(storedAs); delErr != nil {
|
|
slog.Error("failed to clean up orphaned emoji file", "stored_as", storedAs, "error", delErr)
|
|
}
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
|
|
broadcastEmojiSet(r.Context(), svc, broadcaster)
|
|
writeJSON(w, http.StatusCreated, toEmojiResponse(created))
|
|
}
|
|
}
|
|
|
|
// readEmojiUpload pulls the uploaded file out of the already-parsed multipart
|
|
// form and enforces every property of the bytes themselves: the size cap, the
|
|
// sniffed MIME type and the sniffed pixel dimensions. It writes the refusal
|
|
// itself, so a false third result means the response is already complete.
|
|
func readEmojiUpload(w http.ResponseWriter, r *http.Request) ([]byte, string, bool) {
|
|
file, _, err := r.FormFile("file")
|
|
if err != nil {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST", Message: "missing file field",
|
|
})
|
|
return nil, "", false
|
|
}
|
|
defer file.Close() //nolint:errcheck
|
|
|
|
// Read at most one byte past the cap so "exactly at the limit" passes
|
|
// and "one byte over" is caught, without buffering an unbounded body.
|
|
raw, err := io.ReadAll(io.LimitReader(file, maxEmojiFileBytes+1))
|
|
if err != nil {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST", Message: "failed to read uploaded file",
|
|
})
|
|
return nil, "", false
|
|
}
|
|
if int64(len(raw)) > maxEmojiFileBytes {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST",
|
|
Message: fmt.Sprintf("emoji must be at most %d KB", maxEmojiFileBytes>>10),
|
|
})
|
|
return nil, "", false
|
|
}
|
|
|
|
mimeType := http.DetectContentType(raw)
|
|
if !allowedEmojiMIME[mimeType] {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST",
|
|
Message: "emoji must be a PNG, JPEG, GIF or WebP image",
|
|
})
|
|
return nil, "", false
|
|
}
|
|
|
|
width, height, err := imageDimensions(raw, mimeType)
|
|
if err != nil {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST", Message: "could not read image dimensions",
|
|
})
|
|
return nil, "", false
|
|
}
|
|
// Re-check the sniffed dimensions rather than trusting anything the
|
|
// client said about the image: the cap is what keeps an "emoji" from
|
|
// being a full-size picture inlined into every message that names it.
|
|
if width <= 0 || height <= 0 || width > maxEmojiDimension || height > maxEmojiDimension {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST",
|
|
Message: fmt.Sprintf("emoji must be at most %dx%d pixels (got %dx%d)", maxEmojiDimension, maxEmojiDimension, width, height),
|
|
})
|
|
return nil, "", false
|
|
}
|
|
|
|
return raw, mimeType, true
|
|
}
|
|
|
|
func handleDeleteEmoji(svc *service.Services, store FileStore, broadcaster EmojiBroadcaster) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
user, ok := r.Context().Value(UserKey).(*db.User)
|
|
if !ok || user == nil {
|
|
writeJSON(w, http.StatusUnauthorized, errorResponse{
|
|
Error: "UNAUTHORIZED", Message: "not authenticated",
|
|
})
|
|
return
|
|
}
|
|
id, err := strconv.ParseInt(chi.URLParam(r, "id"), 10, 64)
|
|
if err != nil || id <= 0 {
|
|
writeJSON(w, http.StatusBadRequest, errorResponse{
|
|
Error: "BAD_REQUEST", Message: "invalid emoji id",
|
|
})
|
|
return
|
|
}
|
|
|
|
removed, err := svc.Emoji.Delete(r.Context(), user.ID, id)
|
|
if err != nil {
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
// The row is already gone, so a failed unlink leaves an orphaned blob,
|
|
// not a broken emoji — log it rather than failing a successful delete.
|
|
if delErr := store.Delete(removed.StoredAs); delErr != nil {
|
|
slog.Warn("failed to remove emoji file", "stored_as", removed.StoredAs, "error", delErr)
|
|
}
|
|
|
|
broadcastEmojiSet(r.Context(), svc, broadcaster)
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
}
|
|
|
|
// broadcastEmojiSet re-reads the set and pushes it to every client. A failure
|
|
// here is logged and swallowed: the mutation itself already succeeded, and the
|
|
// caller's own response carries the change.
|
|
//
|
|
// Called after the mutation has already committed, so the caller's request
|
|
// context may be canceled by the time this runs (client aborted, deadline
|
|
// fired) -- context.WithoutCancel detaches the re-read from that, matching
|
|
// the pattern service/emoji.go already uses for its post-commit audit write.
|
|
func broadcastEmojiSet(ctx context.Context, svc *service.Services, broadcaster EmojiBroadcaster) {
|
|
if broadcaster == nil {
|
|
return
|
|
}
|
|
list, err := svc.Emoji.List(context.WithoutCancel(ctx))
|
|
if err != nil {
|
|
slog.Error("failed to load emoji for broadcast", "error", err)
|
|
return
|
|
}
|
|
broadcaster.BroadcastEmojiUpdate(list)
|
|
}
|
|
|
|
// handleServeEmojiImage serves the stored bytes of one emoji.
|
|
//
|
|
// Unlike /api/v1/files/{id} there is no per-channel ACL to apply: an emoji is
|
|
// server-wide by construction, so authentication is the whole check. The
|
|
// response is immutable for the id's lifetime (an emoji's bytes never change
|
|
// — a replacement is a new row), which is what lets it be cached hard.
|
|
func handleServeEmojiImage(svc *service.Services, store FileStore) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
id, err := strconv.ParseInt(chi.URLParam(r, "id"), 10, 64)
|
|
if err != nil || id <= 0 {
|
|
http.NotFound(w, r)
|
|
return
|
|
}
|
|
e, err := svc.Emoji.Get(r.Context(), id)
|
|
if err != nil {
|
|
if errors.Is(err, service.ErrNotFound) {
|
|
http.NotFound(w, r)
|
|
return
|
|
}
|
|
writeServiceError(r.Context(), w, err)
|
|
return
|
|
}
|
|
f, err := store.Open(e.StoredAs)
|
|
if err != nil {
|
|
http.NotFound(w, r)
|
|
return
|
|
}
|
|
defer f.Close() //nolint:errcheck
|
|
|
|
w.Header().Set("Content-Type", e.MimeType)
|
|
w.Header().Set("X-Content-Type-Options", "nosniff")
|
|
w.Header().Set("Content-Disposition", "inline")
|
|
// Private (it needed a session to fetch) but immutable, so a client may
|
|
// keep it for a day rather than re-fetching it for every message.
|
|
w.Header().Set("Cache-Control", "private, max-age=86400, immutable")
|
|
|
|
var modTime time.Time
|
|
if info, statErr := f.Stat(); statErr == nil {
|
|
modTime = info.ModTime()
|
|
}
|
|
http.ServeContent(w, r, e.Shortcode, modTime, f)
|
|
}
|
|
}
|
|
|
|
// ─── Dimension extraction ────────────────────────────────────────────────────
|
|
|
|
// imageDimensions returns the pixel size of an image already known to be one of
|
|
// the allowed types. PNG/JPEG/GIF go through image.DecodeConfig; WebP has no
|
|
// decoder in the standard library and none is vendored, so its header is read
|
|
// directly — which is all that is wanted here anyway, since decoding a whole
|
|
// frame just to learn its size is work the cap exists to avoid.
|
|
//
|
|
// Shared by the emoji and avatar upload routes: both refuse an image too big
|
|
// for the surface it renders on, and both have to answer the same question
|
|
// about the same four formats.
|
|
func imageDimensions(raw []byte, mimeType string) (width, height int, err error) {
|
|
if mimeType == "image/webp" {
|
|
width, height, err = webpDimensions(raw)
|
|
} else {
|
|
var cfg image.Config
|
|
cfg, _, err = image.DecodeConfig(bytes.NewReader(raw))
|
|
if err != nil {
|
|
return 0, 0, fmt.Errorf("decoding image config: %w", err)
|
|
}
|
|
width, height = cfg.Width, cfg.Height
|
|
}
|
|
if err != nil {
|
|
return 0, 0, err
|
|
}
|
|
// Both callers treat a non-error return as trustworthy enough to compare
|
|
// straight against their pixel cap. A width or height of zero is not a
|
|
// "small" image, it is a decoder -- Go's own GIF DecodeConfig happily
|
|
// reports height=0 for a malformed logical screen descriptor -- accepting
|
|
// a degenerate header as valid. Rejecting it here means the invariant
|
|
// holds even for a caller that forgets to re-check, instead of relying on
|
|
// every call site getting its own bounds check right.
|
|
if width <= 0 || height <= 0 {
|
|
return 0, 0, fmt.Errorf("decoding image config: non-positive dimensions %dx%d", width, height)
|
|
}
|
|
return width, height, nil
|
|
}
|
|
|
|
// errBadWebP is returned for any WebP whose header does not parse; the caller
|
|
// turns it into the same 400 a corrupt PNG gets.
|
|
var errBadWebP = errors.New("malformed WebP header")
|
|
|
|
// webpDimensions reads the canvas size out of a RIFF/WEBP container. All three
|
|
// chunk flavours are handled: VP8 (lossy), VP8L (lossless) and VP8X (extended,
|
|
// which is what an animated or alpha WebP uses).
|
|
func webpDimensions(raw []byte) (width, height int, err error) {
|
|
// 12-byte RIFF header + at least a 4-byte chunk fourcc.
|
|
if len(raw) < 16 || string(raw[0:4]) != "RIFF" || string(raw[8:12]) != "WEBP" {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
switch string(raw[12:16]) {
|
|
case "VP8 ":
|
|
// Chunk payload starts at 20; the keyframe start code sits 3 bytes in,
|
|
// followed by two 14-bit dimensions (the top 2 bits are a scale field).
|
|
if len(raw) < 30 {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
if raw[23] != 0x9d || raw[24] != 0x01 || raw[25] != 0x2a {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
w := int(binary.LittleEndian.Uint16(raw[26:28]) & 0x3FFF)
|
|
h := int(binary.LittleEndian.Uint16(raw[28:30]) & 0x3FFF)
|
|
// Unlike VP8L/VP8X (which store size-1, so they can never encode
|
|
// zero), the VP8 keyframe stores the size directly: an all-zero
|
|
// dimension field is a validly-shaped but degenerate header, not a
|
|
// real 0x0 canvas. Reject it here rather than reporting "success"
|
|
// with a size no image actually has.
|
|
if w == 0 || h == 0 {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
return w, h, nil
|
|
case "VP8L":
|
|
// Payload starts at 20 with a 0x2F signature byte, then a packed
|
|
// 14+14-bit (width-1, height-1) pair.
|
|
if len(raw) < 25 || raw[20] != 0x2F {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
bits := binary.LittleEndian.Uint32(raw[21:25])
|
|
w := int(bits&0x3FFF) + 1
|
|
h := int((bits>>14)&0x3FFF) + 1
|
|
return w, h, nil
|
|
case "VP8X":
|
|
// Payload starts at 20: flags byte, 3 reserved bytes, then canvas
|
|
// width-1 and height-1 as 24-bit little-endian values.
|
|
if len(raw) < 30 {
|
|
return 0, 0, errBadWebP
|
|
}
|
|
w := int(uint32(raw[24]) | uint32(raw[25])<<8 | uint32(raw[26])<<16)
|
|
h := int(uint32(raw[27]) | uint32(raw[28])<<8 | uint32(raw[29])<<16)
|
|
return w + 1, h + 1, nil
|
|
default:
|
|
return 0, 0, errBadWebP
|
|
}
|
|
}
|